compat: add a basename() compatibility function
[git/git.git] / git-compat-util.h
CommitLineData
4050c0df
JH
1#ifndef GIT_COMPAT_UTIL_H
2#define GIT_COMPAT_UTIL_H
3
b97e9116
MW
4#define _FILE_OFFSET_BITS 64
5
8f1d2e6f 6#ifndef FLEX_ARRAY
8e973991
JH
7/*
8 * See if our compiler is known to support flexible array members.
9 */
10#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
11# define FLEX_ARRAY /* empty */
12#elif defined(__GNUC__)
13# if (__GNUC__ >= 3)
14# define FLEX_ARRAY /* empty */
15# else
16# define FLEX_ARRAY 0 /* older GNU extension */
17# endif
18#endif
19
20/*
21 * Otherwise, default to safer but a bit wasteful traditional style
22 */
23#ifndef FLEX_ARRAY
24# define FLEX_ARRAY 1
8f1d2e6f
JH
25#endif
26#endif
27
b4f2a6ac
JH
28#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
29
8723f216
NP
30#ifdef __GNUC__
31#define TYPEOF(x) (__typeof__(x))
32#else
33#define TYPEOF(x)
34#endif
35
36#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
db7244bd 37#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
8723f216 38
cf606e3d
AW
39/* Approximation of the length of the decimal representation of this type. */
40#define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
41
457bb452 42#if !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && !defined(_M_UNIX)
85023577
JH
43#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
44#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
c902c9a6 45#endif
fb952206
JR
46#define _ALL_SOURCE 1
47#define _GNU_SOURCE 1
48#define _BSD_SOURCE 1
9a695fbf 49#define _NETBSD_SOURCE 1
85023577 50
4050c0df
JH
51#include <unistd.h>
52#include <stdio.h>
53#include <sys/stat.h>
54#include <fcntl.h>
55#include <stddef.h>
56#include <stdlib.h>
57#include <stdarg.h>
58#include <string.h>
59#include <errno.h>
60#include <limits.h>
61#include <sys/param.h>
4050c0df
JH
62#include <sys/types.h>
63#include <dirent.h>
85023577
JH
64#include <sys/time.h>
65#include <time.h>
66#include <signal.h>
85023577 67#include <fnmatch.h>
f4626df5
JS
68#include <assert.h>
69#include <regex.h>
70#include <utime.h>
71#ifndef __MINGW32__
72#include <sys/wait.h>
85023577
JH
73#include <sys/poll.h>
74#include <sys/socket.h>
80bbe72b 75#include <sys/ioctl.h>
2600973f 76#ifndef NO_SYS_SELECT_H
80bbe72b 77#include <sys/select.h>
2600973f 78#endif
85023577
JH
79#include <netinet/in.h>
80#include <netinet/tcp.h>
81#include <arpa/inet.h>
82#include <netdb.h>
83#include <pwd.h>
007e2ba6 84#include <inttypes.h>
41b20017
RJ
85#if defined(__CYGWIN__)
86#undef _XOPEN_SOURCE
87#include <grp.h>
88#define _XOPEN_SOURCE 600
adbc0b6b 89#include "compat/cygwin.h"
41b20017 90#else
fb952206 91#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577 92#include <grp.h>
fb952206 93#define _ALL_SOURCE 1
41b20017 94#endif
f4626df5
JS
95#else /* __MINGW32__ */
96/* pull in Windows compatibility stuff */
97#include "compat/mingw.h"
98#endif /* __MINGW32__ */
85023577 99
e1c06886
DA
100#ifndef NO_LIBGEN_H
101#include <libgen.h>
102#else
103#define basename gitbasename
104extern char *gitbasename(char *);
105#endif
106
85023577
JH
107#ifndef NO_ICONV
108#include <iconv.h>
109#endif
4050c0df 110
684ec6c6
RS
111#ifndef NO_OPENSSL
112#include <openssl/ssl.h>
113#include <openssl/err.h>
114#endif
115
d0c2449f
JH
116/* On most systems <limits.h> would have given us this, but
117 * not on some systems (e.g. GNU/Hurd).
118 */
119#ifndef PATH_MAX
120#define PATH_MAX 4096
121#endif
122
c4001d92
SP
123#ifndef PRIuMAX
124#define PRIuMAX "llu"
125#endif
126
607bb3ff
JS
127#ifndef PRIu32
128#define PRIu32 "u"
129#endif
130
131#ifndef PRIx32
132#define PRIx32 "x"
133#endif
134
80ba074f
JS
135#ifndef PATH_SEP
136#define PATH_SEP ':'
137#endif
138
23326d14
JS
139#ifndef STRIP_EXTENSION
140#define STRIP_EXTENSION ""
141#endif
142
25fe217b
JS
143#ifndef has_dos_drive_prefix
144#define has_dos_drive_prefix(path) 0
145#endif
146
147#ifndef is_dir_sep
148#define is_dir_sep(c) ((c) == '/')
149#endif
150
4050c0df
JH
151#ifdef __GNUC__
152#define NORETURN __attribute__((__noreturn__))
153#else
154#define NORETURN
155#ifndef __attribute__
156#define __attribute__(x)
157#endif
158#endif
159
160/* General helper functions */
161extern void usage(const char *err) NORETURN;
162extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
163extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9 164extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 165
39a3f5ea 166extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
39a3f5ea 167
698a68be 168extern int prefixcmp(const char *str, const char *prefix);
bb5799d6 169extern time_t tm_to_time_t(const struct tm *tm);
698a68be 170
fbca5837
MV
171static inline const char *skip_prefix(const char *str, const char *prefix)
172{
173 size_t len = strlen(prefix);
174 return strncmp(str, prefix, len) ? NULL : str + len;
175}
176
b130a72b 177#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
4050c0df
JH
178
179#ifndef PROT_READ
180#define PROT_READ 1
181#define PROT_WRITE 2
182#define MAP_PRIVATE 1
183#define MAP_FAILED ((void*)-1)
184#endif
185
d6779124
SP
186#define mmap git_mmap
187#define munmap git_munmap
188extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
189extern int git_munmap(void *start, size_t length);
4050c0df 190
b130a72b
JL
191#else /* NO_MMAP || USE_WIN32_MMAP */
192
193#include <sys/mman.h>
194
195#endif /* NO_MMAP || USE_WIN32_MMAP */
196
197#ifdef NO_MMAP
198
5faaf246 199/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
200#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
201
4050c0df
JH
202#else /* NO_MMAP */
203
5faaf246 204/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
205#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
206 (sizeof(void*) >= 8 \
207 ? 1 * 1024 * 1024 * 1024 \
208 : 32 * 1024 * 1024)
4050c0df
JH
209
210#endif /* NO_MMAP */
211
fdb2a2a6
JH
212#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
213#define on_disk_bytes(st) ((st).st_size)
214#else
215#define on_disk_bytes(st) ((st).st_blocks * 512)
216#endif
217
22bac0ea 218#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a 219 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 220
6900679c
SH
221#ifdef NO_PREAD
222#define pread git_pread
223extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
224#endif
14086b0a
SP
225/*
226 * Forward decl that will remind us if its twin in cache.h changes.
227 * This function is used in compat/pread.c. But we can't include
228 * cache.h there.
229 */
230extern ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c 231
4050c0df
JH
232#ifdef NO_SETENV
233#define setenv gitsetenv
234extern int gitsetenv(const char *, const char *, int);
235#endif
236
ca5bb5d5
SP
237#ifdef NO_MKDTEMP
238#define mkdtemp gitmkdtemp
239extern char *gitmkdtemp(char *);
240#endif
241
0620b39b
DA
242#ifdef NO_MKSTEMPS
243#define mkstemps gitmkstemps
244extern int gitmkstemps(char *, int);
245#endif
246
731043fd
JR
247#ifdef NO_UNSETENV
248#define unsetenv gitunsetenv
249extern void gitunsetenv(const char *);
250#endif
251
4050c0df
JH
252#ifdef NO_STRCASESTR
253#define strcasestr gitstrcasestr
254extern char *gitstrcasestr(const char *haystack, const char *needle);
255#endif
256
817151e6
PE
257#ifdef NO_STRLCPY
258#define strlcpy gitstrlcpy
259extern size_t gitstrlcpy(char *, const char *, size_t);
260#endif
261
bc6b4f52
JR
262#ifdef NO_STRTOUMAX
263#define strtoumax gitstrtoumax
264extern uintmax_t gitstrtoumax(const char *, char **, int);
265#endif
266
fa0c87c3
AR
267#ifdef NO_HSTRERROR
268#define hstrerror githstrerror
269extern const char *githstrerror(int herror);
270#endif
271
b21b9f1d
RS
272#ifdef NO_MEMMEM
273#define memmem gitmemmem
274void *gitmemmem(const void *haystack, size_t haystacklen,
275 const void *needle, size_t needlelen);
276#endif
277
cba22528 278#ifdef FREAD_READS_DIRECTORIES
c5445fe0
JS
279#ifdef fopen
280#undef fopen
281#endif
cba22528
BC
282#define fopen(a,b) git_fopen(a,b)
283extern FILE *git_fopen(const char*, const char*);
284#endif
285
c4582f93
MR
286#ifdef SNPRINTF_RETURNS_BOGUS
287#define snprintf git_snprintf
288extern int git_snprintf(char *str, size_t maxsize,
289 const char *format, ...);
290#define vsnprintf git_vsnprintf
291extern int git_vsnprintf(char *str, size_t maxsize,
292 const char *format, va_list ap);
293#endif
294
726c8ef5
JS
295#ifdef __GLIBC_PREREQ
296#if __GLIBC_PREREQ(2, 1)
297#define HAVE_STRCHRNUL
298#endif
299#endif
300
301#ifndef HAVE_STRCHRNUL
659c69cf 302#define strchrnul gitstrchrnul
9e79f00f
AE
303static inline char *gitstrchrnul(const char *s, int c)
304{
305 while (*s && *s != c)
306 s++;
307 return (char *)s;
308}
659c69cf
RS
309#endif
310
d1efefa4 311extern void release_pack_memory(size_t, int);
97bfeb34 312
112db553
LT
313extern char *xstrdup(const char *str);
314extern void *xmalloc(size_t size);
315extern void *xmemdupz(const void *data, size_t len);
316extern char *xstrndup(const char *str, size_t len);
317extern void *xrealloc(void *ptr, size_t size);
318extern void *xcalloc(size_t nmemb, size_t size);
319extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
320extern ssize_t xread(int fd, void *buf, size_t len);
321extern ssize_t xwrite(int fd, const void *buf, size_t len);
322extern int xdup(int fd);
323extern FILE *xfdopen(int fd, const char *mode);
324extern int xmkstemp(char *template);
6e180cdc
JH
325extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
326extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
f21a47b2 327
dc49cd76
SP
328static inline size_t xsize_t(off_t len)
329{
330 return (size_t)len;
331}
332
5bb1cda5 333static inline int has_extension(const char *filename, const char *ext)
83a2b841 334{
5bb1cda5
RS
335 size_t len = strlen(filename);
336 size_t extlen = strlen(ext);
83a2b841
RS
337 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
338}
339
4050c0df 340/* Sane ctype - no locale, and works with signed chars */
c2e9364a 341#undef isascii
4050c0df
JH
342#undef isspace
343#undef isdigit
344#undef isalpha
345#undef isalnum
346#undef tolower
347#undef toupper
348extern unsigned char sane_ctype[256];
349#define GIT_SPACE 0x01
350#define GIT_DIGIT 0x02
351#define GIT_ALPHA 0x04
8cc32992 352#define GIT_GLOB_SPECIAL 0x08
f9b7cce6 353#define GIT_REGEX_SPECIAL 0x10
4050c0df 354#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
c2e9364a 355#define isascii(x) (((x) & ~0x7f) == 0)
4050c0df
JH
356#define isspace(x) sane_istest(x,GIT_SPACE)
357#define isdigit(x) sane_istest(x,GIT_DIGIT)
358#define isalpha(x) sane_istest(x,GIT_ALPHA)
359#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
8cc32992 360#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
f9b7cce6 361#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
4050c0df
JH
362#define tolower(x) sane_case((unsigned char)(x), 0x20)
363#define toupper(x) sane_case((unsigned char)(x), 0)
364
365static inline int sane_case(int x, int high)
366{
367 if (sane_istest(x, GIT_ALPHA))
368 x = (x & ~0x20) | high;
369 return x;
370}
371
6aead43d
JM
372static inline int strtoul_ui(char const *s, int base, unsigned int *result)
373{
374 unsigned long ul;
375 char *p;
376
377 errno = 0;
378 ul = strtoul(s, &p, base);
379 if (errno || *p || p == s || (unsigned int) ul != ul)
380 return -1;
381 *result = ul;
382 return 0;
383}
384
7791ecbc
JH
385static inline int strtol_i(char const *s, int base, int *result)
386{
387 long ul;
388 char *p;
389
390 errno = 0;
391 ul = strtol(s, &p, base);
392 if (errno || *p || p == s || (int) ul != ul)
393 return -1;
394 *result = ul;
395 return 0;
396}
397
43fe901b
BD
398#ifdef INTERNAL_QSORT
399void git_qsort(void *base, size_t nmemb, size_t size,
400 int(*compar)(const void *, const void *));
401#define qsort git_qsort
402#endif
403
81a24b52
AR
404#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
405# define FORCE_DIR_SET_GID S_ISGID
406#else
407# define FORCE_DIR_SET_GID 0
408#endif
409
c06ff490
KB
410#ifdef NO_NSEC
411#undef USE_NSEC
412#define ST_CTIME_NSEC(st) 0
413#define ST_MTIME_NSEC(st) 0
414#else
c567383b
BG
415#ifdef USE_ST_TIMESPEC
416#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
417#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
418#else
c06ff490
KB
419#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
420#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
421#endif
c567383b 422#endif
c06ff490 423
34779c53
JS
424#ifdef UNRELIABLE_FSTAT
425#define fstat_is_reliable() 0
426#else
427#define fstat_is_reliable() 1
428#endif
429
fc71db39
AR
430/*
431 * Preserves errno, prints a message, but gives no warning for ENOENT.
432 * Always returns the return value of unlink(2).
433 */
434int unlink_or_warn(const char *path);
435
4050c0df 436#endif