fixup! git tag --contains : avoid stack overflow
[git/mingw/4msysgit.git] / git-compat-util.h
blobe6de32c4e875d8e072e258ddbb587092e625ff3f
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
4 #define _FILE_OFFSET_BITS 64
6 #ifndef FLEX_ARRAY
7 /*
8 * See if our compiler is known to support flexible array members.
9 */
10 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
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
21 * Otherwise, default to safer but a bit wasteful traditional style
23 #ifndef FLEX_ARRAY
24 # define FLEX_ARRAY 1
25 #endif
26 #endif
28 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
29 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
31 #define maximum_signed_value_of_type(a) \
32 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
34 #define maximum_unsigned_value_of_type(a) \
35 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
38 * Signed integer overflow is undefined in C, so here's a helper macro
39 * to detect if the sum of two integers will overflow.
41 * Requires: a >= 0, typeof(a) equals typeof(b)
43 #define signed_add_overflows(a, b) \
44 ((b) > maximum_signed_value_of_type(a) - (a))
46 #define unsigned_add_overflows(a, b) \
47 ((b) > maximum_unsigned_value_of_type(a) - (a))
49 #ifdef __GNUC__
50 #define TYPEOF(x) (__typeof__(x))
51 #else
52 #define TYPEOF(x)
53 #endif
55 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
56 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
58 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
60 /* Approximation of the length of the decimal representation of this type. */
61 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
63 #if defined(__sun__)
65 * On Solaris, when _XOPEN_EXTENDED is set, its header file
66 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
67 * setting to say we are XPG5 or XPG6. Also on Solaris,
68 * XPG6 programs must be compiled with a c99 compiler, while
69 * non XPG6 programs must be compiled with a pre-c99 compiler.
71 # if __STDC_VERSION__ - 0 >= 199901L
72 # define _XOPEN_SOURCE 600
73 # else
74 # define _XOPEN_SOURCE 500
75 # endif
76 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
77 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
78 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__)
79 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
80 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
81 #endif
82 #define _ALL_SOURCE 1
83 #define _GNU_SOURCE 1
84 #define _BSD_SOURCE 1
85 #define _NETBSD_SOURCE 1
86 #define _SGI_SOURCE 1
88 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
89 # if defined (_MSC_VER) && !defined(_WIN32_WINNT)
90 # define _WIN32_WINNT 0x0502
91 # endif
92 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
93 #include <winsock2.h>
94 #include <windows.h>
95 #define GIT_WINDOWS_NATIVE
96 #endif
98 #include <unistd.h>
99 #include <stdio.h>
100 #include <sys/stat.h>
101 #include <fcntl.h>
102 #include <stddef.h>
103 #include <stdlib.h>
104 #include <stdarg.h>
105 #include <string.h>
106 #ifdef HAVE_STRINGS_H
107 #include <strings.h> /* for strcasecmp() */
108 #endif
109 #include <errno.h>
110 #include <limits.h>
111 #ifdef NEEDS_SYS_PARAM_H
112 #include <sys/param.h>
113 #endif
114 #include <sys/types.h>
115 #include <dirent.h>
116 #include <sys/time.h>
117 #include <time.h>
118 #include <signal.h>
119 #ifndef USE_WILDMATCH
120 #include <fnmatch.h>
121 #endif
122 #include <assert.h>
123 #include <regex.h>
124 #include <utime.h>
125 #include <syslog.h>
126 #ifndef NO_SYS_POLL_H
127 #include <sys/poll.h>
128 #else
129 #include <poll.h>
130 #endif
132 #if defined(__MINGW32__)
133 /* pull in Windows compatibility stuff */
134 #include "compat/mingw.h"
135 #include "compat/win32/fscache.h"
136 #elif defined(_MSC_VER)
137 #include "compat/msvc.h"
138 #include "compat/win32/fscache.h"
139 #else
140 #include <sys/wait.h>
141 #include <sys/resource.h>
142 #include <sys/socket.h>
143 #include <sys/ioctl.h>
144 #include <termios.h>
145 #ifndef NO_SYS_SELECT_H
146 #include <sys/select.h>
147 #endif
148 #include <netinet/in.h>
149 #include <netinet/tcp.h>
150 #include <arpa/inet.h>
151 #include <netdb.h>
152 #include <pwd.h>
153 #include <sys/un.h>
154 #ifndef NO_INTTYPES_H
155 #include <inttypes.h>
156 #else
157 #include <stdint.h>
158 #endif
159 #ifdef NO_INTPTR_T
161 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
162 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
163 * while on IP16 and IP16L32 it is "int" (resp. "short")
164 * Size needs to match (or exceed) 'sizeof(void *)'.
165 * We can't take "long long" here as not everybody has it.
167 typedef long intptr_t;
168 typedef unsigned long uintptr_t;
169 #endif
170 #if defined(__CYGWIN__)
171 #undef _XOPEN_SOURCE
172 #include <grp.h>
173 #define _XOPEN_SOURCE 600
174 #else
175 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
176 #include <grp.h>
177 #define _ALL_SOURCE 1
178 #endif
179 #endif
181 /* used on Mac OS X */
182 #ifdef PRECOMPOSE_UNICODE
183 #include "compat/precompose_utf8.h"
184 #else
185 #define precompose_str(in,i_nfd2nfc)
186 #define precompose_argv(c,v)
187 #define probe_utf8_pathname_composition(a,b)
188 #endif
190 #ifdef MKDIR_WO_TRAILING_SLASH
191 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
192 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
193 #endif
195 #ifdef NO_STRUCT_ITIMERVAL
196 struct itimerval {
197 struct timeval it_interval;
198 struct timeval it_value;
200 #endif
202 #ifdef NO_SETITIMER
203 #define setitimer(which,value,ovalue)
204 #endif
206 #ifndef NO_LIBGEN_H
207 #include <libgen.h>
208 #else
209 #define basename gitbasename
210 extern char *gitbasename(char *);
211 #endif
213 #ifndef NO_ICONV
214 #include <iconv.h>
215 #endif
217 #ifndef NO_OPENSSL
218 #include <openssl/ssl.h>
219 #include <openssl/err.h>
220 #endif
222 /* On most systems <netdb.h> would have given us this, but
223 * not on some systems (e.g. z/OS).
225 #ifndef NI_MAXHOST
226 #define NI_MAXHOST 1025
227 #endif
229 #ifndef NI_MAXSERV
230 #define NI_MAXSERV 32
231 #endif
233 /* On most systems <limits.h> would have given us this, but
234 * not on some systems (e.g. GNU/Hurd).
236 #ifndef PATH_MAX
237 #define PATH_MAX 4096
238 #endif
240 #ifndef PRIuMAX
241 #define PRIuMAX "llu"
242 #endif
244 #ifndef PRIu32
245 #define PRIu32 "u"
246 #endif
248 #ifndef PRIx32
249 #define PRIx32 "x"
250 #endif
252 #ifndef PRIo32
253 #define PRIo32 "o"
254 #endif
256 #ifndef PATH_SEP
257 #define PATH_SEP ':'
258 #endif
260 #ifdef HAVE_PATHS_H
261 #include <paths.h>
262 #endif
263 #ifndef _PATH_DEFPATH
264 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
265 #endif
267 #ifndef STRIP_EXTENSION
268 #define STRIP_EXTENSION ""
269 #endif
271 #ifndef has_dos_drive_prefix
272 #define has_dos_drive_prefix(path) 0
273 #endif
275 #ifndef offset_1st_component
276 #define offset_1st_component(path) (is_dir_sep((path)[0]))
277 #endif
279 #ifndef is_dir_sep
280 #define is_dir_sep(c) ((c) == '/')
281 #endif
283 #ifndef find_last_dir_sep
284 #define find_last_dir_sep(path) strrchr(path, '/')
285 #endif
287 #if defined(__HP_cc) && (__HP_cc >= 61000)
288 #define NORETURN __attribute__((noreturn))
289 #define NORETURN_PTR
290 #elif defined(__GNUC__) && !defined(NO_NORETURN)
291 #define NORETURN __attribute__((__noreturn__))
292 #define NORETURN_PTR __attribute__((__noreturn__))
293 #elif defined(_MSC_VER)
294 #define NORETURN __declspec(noreturn)
295 #define NORETURN_PTR
296 #else
297 #define NORETURN
298 #define NORETURN_PTR
299 #ifndef __attribute__
300 #define __attribute__(x)
301 #endif
302 #endif
304 /* The sentinel attribute is valid from gcc version 4.0 */
305 #if defined(__GNUC__) && (__GNUC__ >= 4)
306 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
307 #else
308 #define LAST_ARG_MUST_BE_NULL
309 #endif
311 #include "compat/bswap.h"
313 #ifdef USE_WILDMATCH
314 #include "wildmatch.h"
315 #define FNM_PATHNAME WM_PATHNAME
316 #define FNM_CASEFOLD WM_CASEFOLD
317 #define FNM_NOMATCH WM_NOMATCH
318 static inline int fnmatch(const char *pattern, const char *string, int flags)
320 return wildmatch(pattern, string, flags, NULL);
322 #endif
324 /* General helper functions */
325 extern void vreportf(const char *prefix, const char *err, va_list params);
326 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
327 extern NORETURN void usage(const char *err);
328 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
329 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
330 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
331 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
332 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
334 #ifndef NO_OPENSSL
335 #ifdef APPLE_COMMON_CRYPTO
336 #include "compat/apple-common-crypto.h"
337 #else
338 #include <openssl/evp.h>
339 #include <openssl/hmac.h>
340 #endif /* APPLE_COMMON_CRYPTO */
341 #include <openssl/x509v3.h>
342 #endif /* NO_OPENSSL */
345 * Let callers be aware of the constant return value; this can help
346 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
347 * because some compilers may not support variadic macros. Since we're only
348 * trying to help gcc, anyway, it's OK; other compilers will fall back to
349 * using the function as usual.
351 #if defined(__GNUC__) && ! defined(__clang__)
352 #define error(...) (error(__VA_ARGS__), -1)
353 #endif
355 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
356 extern void set_error_routine(void (*routine)(const char *err, va_list params));
357 extern void set_die_is_recursing_routine(int (*routine)(void));
359 extern int starts_with(const char *str, const char *prefix);
360 extern int prefixcmp(const char *str, const char *prefix);
361 extern int ends_with(const char *str, const char *suffix);
362 extern int suffixcmp(const char *str, const char *suffix);
364 static inline const char *skip_prefix(const char *str, const char *prefix)
366 size_t len = strlen(prefix);
367 return strncmp(str, prefix, len) ? NULL : str + len;
370 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
372 #ifndef PROT_READ
373 #define PROT_READ 1
374 #define PROT_WRITE 2
375 #define MAP_PRIVATE 1
376 #endif
378 #define mmap git_mmap
379 #define munmap git_munmap
380 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
381 extern int git_munmap(void *start, size_t length);
383 #else /* NO_MMAP || USE_WIN32_MMAP */
385 #include <sys/mman.h>
387 #endif /* NO_MMAP || USE_WIN32_MMAP */
389 #ifdef NO_MMAP
391 /* This value must be multiple of (pagesize * 2) */
392 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
394 #else /* NO_MMAP */
396 /* This value must be multiple of (pagesize * 2) */
397 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
398 (sizeof(void*) >= 8 \
399 ? 1 * 1024 * 1024 * 1024 \
400 : 32 * 1024 * 1024)
402 #endif /* NO_MMAP */
404 #ifndef MAP_FAILED
405 #define MAP_FAILED ((void *)-1)
406 #endif
408 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
409 #define on_disk_bytes(st) ((st).st_size)
410 #else
411 #define on_disk_bytes(st) ((st).st_blocks * 512)
412 #endif
414 #define DEFAULT_PACKED_GIT_LIMIT \
415 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
417 #ifdef NO_PREAD
418 #define pread git_pread
419 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
420 #endif
422 * Forward decl that will remind us if its twin in cache.h changes.
423 * This function is used in compat/pread.c. But we can't include
424 * cache.h there.
426 extern ssize_t read_in_full(int fd, void *buf, size_t count);
428 #ifdef NO_SETENV
429 #define setenv gitsetenv
430 extern int gitsetenv(const char *, const char *, int);
431 #endif
433 #ifdef NO_MKDTEMP
434 #define mkdtemp gitmkdtemp
435 extern char *gitmkdtemp(char *);
436 #endif
438 #ifdef NO_MKSTEMPS
439 #define mkstemps gitmkstemps
440 extern int gitmkstemps(char *, int);
441 #endif
443 #ifdef NO_UNSETENV
444 #define unsetenv gitunsetenv
445 extern void gitunsetenv(const char *);
446 #endif
448 #ifdef NO_STRCASESTR
449 #define strcasestr gitstrcasestr
450 extern char *gitstrcasestr(const char *haystack, const char *needle);
451 #endif
453 #ifdef NO_STRLCPY
454 #define strlcpy gitstrlcpy
455 extern size_t gitstrlcpy(char *, const char *, size_t);
456 #endif
458 #ifdef NO_STRTOUMAX
459 #define strtoumax gitstrtoumax
460 extern uintmax_t gitstrtoumax(const char *, char **, int);
461 #define strtoimax gitstrtoimax
462 extern intmax_t gitstrtoimax(const char *, char **, int);
463 #endif
465 #ifdef NO_HSTRERROR
466 #define hstrerror githstrerror
467 extern const char *githstrerror(int herror);
468 #endif
470 #ifdef NO_MEMMEM
471 #define memmem gitmemmem
472 void *gitmemmem(const void *haystack, size_t haystacklen,
473 const void *needle, size_t needlelen);
474 #endif
476 #ifdef NO_GETPAGESIZE
477 #define getpagesize() sysconf(_SC_PAGESIZE)
478 #endif
480 #ifdef FREAD_READS_DIRECTORIES
481 #ifdef fopen
482 #undef fopen
483 #endif
484 #define fopen(a,b) git_fopen(a,b)
485 extern FILE *git_fopen(const char*, const char*);
486 #endif
488 #ifdef SNPRINTF_RETURNS_BOGUS
489 #define snprintf git_snprintf
490 extern int git_snprintf(char *str, size_t maxsize,
491 const char *format, ...);
492 #define vsnprintf git_vsnprintf
493 extern int git_vsnprintf(char *str, size_t maxsize,
494 const char *format, va_list ap);
495 #endif
497 #ifdef __GLIBC_PREREQ
498 #if __GLIBC_PREREQ(2, 1)
499 #define HAVE_STRCHRNUL
500 #define HAVE_MEMPCPY
501 #endif
502 #endif
504 #ifndef HAVE_STRCHRNUL
505 #define strchrnul gitstrchrnul
506 static inline char *gitstrchrnul(const char *s, int c)
508 while (*s && *s != c)
509 s++;
510 return (char *)s;
512 #endif
514 #ifndef HAVE_MEMPCPY
515 #define mempcpy gitmempcpy
516 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
518 return (char *)memcpy(dest, src, n) + n;
520 #endif
522 #ifdef NO_INET_PTON
523 int inet_pton(int af, const char *src, void *dst);
524 #endif
526 #ifdef NO_INET_NTOP
527 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
528 #endif
530 extern void release_pack_memory(size_t);
532 typedef void (*try_to_free_t)(size_t);
533 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
535 extern char *xstrdup(const char *str);
536 extern void *xmalloc(size_t size);
537 extern void *xmallocz(size_t size);
538 extern void *xmemdupz(const void *data, size_t len);
539 extern char *xstrndup(const char *str, size_t len);
540 extern void *xrealloc(void *ptr, size_t size);
541 extern void *xcalloc(size_t nmemb, size_t size);
542 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
543 extern ssize_t xread(int fd, void *buf, size_t len);
544 extern ssize_t xwrite(int fd, const void *buf, size_t len);
545 extern int xdup(int fd);
546 extern FILE *xfdopen(int fd, const char *mode);
547 extern int xmkstemp(char *template);
548 extern int xmkstemp_mode(char *template, int mode);
549 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
550 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
552 static inline size_t xsize_t(off_t len)
554 if (len > (size_t) len)
555 die("Cannot handle files this big");
556 return (size_t)len;
559 static inline int has_extension(const char *filename, const char *ext)
561 size_t len = strlen(filename);
562 size_t extlen = strlen(ext);
563 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
566 /* in ctype.c, for kwset users */
567 extern const char tolower_trans_tbl[256];
569 /* Sane ctype - no locale, and works with signed chars */
570 #undef isascii
571 #undef isspace
572 #undef isdigit
573 #undef isalpha
574 #undef isalnum
575 #undef isprint
576 #undef islower
577 #undef isupper
578 #undef tolower
579 #undef toupper
580 #undef iscntrl
581 #undef ispunct
582 #undef isxdigit
584 extern const unsigned char sane_ctype[256];
585 #define GIT_SPACE 0x01
586 #define GIT_DIGIT 0x02
587 #define GIT_ALPHA 0x04
588 #define GIT_GLOB_SPECIAL 0x08
589 #define GIT_REGEX_SPECIAL 0x10
590 #define GIT_PATHSPEC_MAGIC 0x20
591 #define GIT_CNTRL 0x40
592 #define GIT_PUNCT 0x80
593 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
594 #define isascii(x) (((x) & ~0x7f) == 0)
595 #define isspace(x) sane_istest(x,GIT_SPACE)
596 #define isdigit(x) sane_istest(x,GIT_DIGIT)
597 #define isalpha(x) sane_istest(x,GIT_ALPHA)
598 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
599 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
600 #define islower(x) sane_iscase(x, 1)
601 #define isupper(x) sane_iscase(x, 0)
602 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
603 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
604 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
605 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
606 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
607 #define isxdigit(x) (hexval_table[x] != -1)
608 #define tolower(x) sane_case((unsigned char)(x), 0x20)
609 #define toupper(x) sane_case((unsigned char)(x), 0)
610 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
612 static inline int sane_case(int x, int high)
614 if (sane_istest(x, GIT_ALPHA))
615 x = (x & ~0x20) | high;
616 return x;
619 static inline int sane_iscase(int x, int is_lower)
621 if (!sane_istest(x, GIT_ALPHA))
622 return 0;
624 if (is_lower)
625 return (x & 0x20) != 0;
626 else
627 return (x & 0x20) == 0;
630 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
632 unsigned long ul;
633 char *p;
635 errno = 0;
636 ul = strtoul(s, &p, base);
637 if (errno || *p || p == s || (unsigned int) ul != ul)
638 return -1;
639 *result = ul;
640 return 0;
643 static inline int strtol_i(char const *s, int base, int *result)
645 long ul;
646 char *p;
648 errno = 0;
649 ul = strtol(s, &p, base);
650 if (errno || *p || p == s || (int) ul != ul)
651 return -1;
652 *result = ul;
653 return 0;
656 #ifdef INTERNAL_QSORT
657 void git_qsort(void *base, size_t nmemb, size_t size,
658 int(*compar)(const void *, const void *));
659 #define qsort git_qsort
660 #endif
662 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
663 # define FORCE_DIR_SET_GID S_ISGID
664 #else
665 # define FORCE_DIR_SET_GID 0
666 #endif
668 #ifdef NO_NSEC
669 #undef USE_NSEC
670 #define ST_CTIME_NSEC(st) 0
671 #define ST_MTIME_NSEC(st) 0
672 #else
673 #ifdef USE_ST_TIMESPEC
674 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
675 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
676 #else
677 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
678 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
679 #endif
680 #endif
682 #ifdef UNRELIABLE_FSTAT
683 #define fstat_is_reliable() 0
684 #else
685 #define fstat_is_reliable() 1
686 #endif
688 #ifndef va_copy
690 * Since an obvious implementation of va_list would be to make it a
691 * pointer into the stack frame, a simple assignment will work on
692 * many systems. But let's try to be more portable.
694 #ifdef __va_copy
695 #define va_copy(dst, src) __va_copy(dst, src)
696 #else
697 #define va_copy(dst, src) ((dst) = (src))
698 #endif
699 #endif
702 * Preserves errno, prints a message, but gives no warning for ENOENT.
703 * Always returns the return value of unlink(2).
705 int unlink_or_warn(const char *path);
707 * Likewise for rmdir(2).
709 int rmdir_or_warn(const char *path);
711 * Calls the correct function out of {unlink,rmdir}_or_warn based on
712 * the supplied file mode.
714 int remove_or_warn(unsigned int mode, const char *path);
717 * Call access(2), but warn for any error except "missing file"
718 * (ENOENT or ENOTDIR).
720 #define ACCESS_EACCES_OK (1U << 0)
721 int access_or_warn(const char *path, int mode, unsigned flag);
722 int access_or_die(const char *path, int mode, unsigned flag);
724 /* Warn on an inaccessible file that ought to be accessible */
725 void warn_on_inaccessible(const char *path);
727 /* Get the passwd entry for the UID of the current process. */
728 struct passwd *xgetpwuid_self(void);
730 #ifdef GMTIME_UNRELIABLE_ERRORS
731 struct tm *git_gmtime(const time_t *);
732 struct tm *git_gmtime_r(const time_t *, struct tm *);
733 #define gmtime git_gmtime
734 #define gmtime_r git_gmtime_r
735 #endif
737 #ifndef mark_as_git_dir
738 #define mark_as_git_dir(x) /* noop */
739 #endif
741 #ifndef get_home_directory
742 #define get_home_directory() getenv("HOME")
743 #endif
746 * Enable/disable a read-only cache for file system data on platforms that
747 * support it.
749 * Implementing a live-cache is complicated and requires special platform
750 * support (inotify, ReadDirectoryChangesW...). enable_fscache shall be used
751 * to mark sections of git code that extensively read from the file system
752 * without modifying anything. Implementations can use this to cache e.g. stat
753 * data or even file content without the need to synchronize with the file
754 * system.
756 #ifndef enable_fscache
757 #define enable_fscache(x) /* noop */
758 #endif
760 #endif