Win32: add a cache below mingw's lstat and dirent implementations
[git/mingw/4msysgit.git] / git-compat-util.h
blob2dfab4b7b70d28669ecb7073ee0fcf3537b44d2d
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__)
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 prefixcmp(const char *str, const char *prefix);
360 extern int suffixcmp(const char *str, const char *suffix);
362 static inline const char *skip_prefix(const char *str, const char *prefix)
364 size_t len = strlen(prefix);
365 return strncmp(str, prefix, len) ? NULL : str + len;
368 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
370 #ifndef PROT_READ
371 #define PROT_READ 1
372 #define PROT_WRITE 2
373 #define MAP_PRIVATE 1
374 #endif
376 #define mmap git_mmap
377 #define munmap git_munmap
378 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
379 extern int git_munmap(void *start, size_t length);
381 #else /* NO_MMAP || USE_WIN32_MMAP */
383 #include <sys/mman.h>
385 #endif /* NO_MMAP || USE_WIN32_MMAP */
387 #ifdef NO_MMAP
389 /* This value must be multiple of (pagesize * 2) */
390 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
392 #else /* NO_MMAP */
394 /* This value must be multiple of (pagesize * 2) */
395 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
396 (sizeof(void*) >= 8 \
397 ? 1 * 1024 * 1024 * 1024 \
398 : 32 * 1024 * 1024)
400 #endif /* NO_MMAP */
402 #ifndef MAP_FAILED
403 #define MAP_FAILED ((void *)-1)
404 #endif
406 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
407 #define on_disk_bytes(st) ((st).st_size)
408 #else
409 #define on_disk_bytes(st) ((st).st_blocks * 512)
410 #endif
412 #define DEFAULT_PACKED_GIT_LIMIT \
413 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
415 #ifdef NO_PREAD
416 #define pread git_pread
417 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
418 #endif
420 * Forward decl that will remind us if its twin in cache.h changes.
421 * This function is used in compat/pread.c. But we can't include
422 * cache.h there.
424 extern ssize_t read_in_full(int fd, void *buf, size_t count);
426 #ifdef NO_SETENV
427 #define setenv gitsetenv
428 extern int gitsetenv(const char *, const char *, int);
429 #endif
431 #ifdef NO_MKDTEMP
432 #define mkdtemp gitmkdtemp
433 extern char *gitmkdtemp(char *);
434 #endif
436 #ifdef NO_MKSTEMPS
437 #define mkstemps gitmkstemps
438 extern int gitmkstemps(char *, int);
439 #endif
441 #ifdef NO_UNSETENV
442 #define unsetenv gitunsetenv
443 extern void gitunsetenv(const char *);
444 #endif
446 #ifdef NO_STRCASESTR
447 #define strcasestr gitstrcasestr
448 extern char *gitstrcasestr(const char *haystack, const char *needle);
449 #endif
451 #ifdef NO_STRLCPY
452 #define strlcpy gitstrlcpy
453 extern size_t gitstrlcpy(char *, const char *, size_t);
454 #endif
456 #ifdef NO_STRTOUMAX
457 #define strtoumax gitstrtoumax
458 extern uintmax_t gitstrtoumax(const char *, char **, int);
459 #define strtoimax gitstrtoimax
460 extern intmax_t gitstrtoimax(const char *, char **, int);
461 #endif
463 #ifdef NO_HSTRERROR
464 #define hstrerror githstrerror
465 extern const char *githstrerror(int herror);
466 #endif
468 #ifdef NO_MEMMEM
469 #define memmem gitmemmem
470 void *gitmemmem(const void *haystack, size_t haystacklen,
471 const void *needle, size_t needlelen);
472 #endif
474 #ifdef NO_GETPAGESIZE
475 #define getpagesize() sysconf(_SC_PAGESIZE)
476 #endif
478 #ifdef FREAD_READS_DIRECTORIES
479 #ifdef fopen
480 #undef fopen
481 #endif
482 #define fopen(a,b) git_fopen(a,b)
483 extern FILE *git_fopen(const char*, const char*);
484 #endif
486 #ifdef SNPRINTF_RETURNS_BOGUS
487 #define snprintf git_snprintf
488 extern int git_snprintf(char *str, size_t maxsize,
489 const char *format, ...);
490 #define vsnprintf git_vsnprintf
491 extern int git_vsnprintf(char *str, size_t maxsize,
492 const char *format, va_list ap);
493 #endif
495 #ifdef __GLIBC_PREREQ
496 #if __GLIBC_PREREQ(2, 1)
497 #define HAVE_STRCHRNUL
498 #define HAVE_MEMPCPY
499 #endif
500 #endif
502 #ifndef HAVE_STRCHRNUL
503 #define strchrnul gitstrchrnul
504 static inline char *gitstrchrnul(const char *s, int c)
506 while (*s && *s != c)
507 s++;
508 return (char *)s;
510 #endif
512 #ifndef HAVE_MEMPCPY
513 #define mempcpy gitmempcpy
514 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
516 return (char *)memcpy(dest, src, n) + n;
518 #endif
520 #ifdef NO_INET_PTON
521 int inet_pton(int af, const char *src, void *dst);
522 #endif
524 #ifdef NO_INET_NTOP
525 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
526 #endif
528 extern void release_pack_memory(size_t);
530 typedef void (*try_to_free_t)(size_t);
531 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
533 extern char *xstrdup(const char *str);
534 extern void *xmalloc(size_t size);
535 extern void *xmallocz(size_t size);
536 extern void *xmemdupz(const void *data, size_t len);
537 extern char *xstrndup(const char *str, size_t len);
538 extern void *xrealloc(void *ptr, size_t size);
539 extern void *xcalloc(size_t nmemb, size_t size);
540 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
541 extern ssize_t xread(int fd, void *buf, size_t len);
542 extern ssize_t xwrite(int fd, const void *buf, size_t len);
543 extern int xdup(int fd);
544 extern FILE *xfdopen(int fd, const char *mode);
545 extern int xmkstemp(char *template);
546 extern int xmkstemp_mode(char *template, int mode);
547 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
548 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
550 static inline size_t xsize_t(off_t len)
552 if (len > (size_t) len)
553 die("Cannot handle files this big");
554 return (size_t)len;
557 static inline int has_extension(const char *filename, const char *ext)
559 size_t len = strlen(filename);
560 size_t extlen = strlen(ext);
561 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
564 /* in ctype.c, for kwset users */
565 extern const char tolower_trans_tbl[256];
567 /* Sane ctype - no locale, and works with signed chars */
568 #undef isascii
569 #undef isspace
570 #undef isdigit
571 #undef isalpha
572 #undef isalnum
573 #undef isprint
574 #undef islower
575 #undef isupper
576 #undef tolower
577 #undef toupper
578 #undef iscntrl
579 #undef ispunct
580 #undef isxdigit
582 extern const unsigned char sane_ctype[256];
583 #define GIT_SPACE 0x01
584 #define GIT_DIGIT 0x02
585 #define GIT_ALPHA 0x04
586 #define GIT_GLOB_SPECIAL 0x08
587 #define GIT_REGEX_SPECIAL 0x10
588 #define GIT_PATHSPEC_MAGIC 0x20
589 #define GIT_CNTRL 0x40
590 #define GIT_PUNCT 0x80
591 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
592 #define isascii(x) (((x) & ~0x7f) == 0)
593 #define isspace(x) sane_istest(x,GIT_SPACE)
594 #define isdigit(x) sane_istest(x,GIT_DIGIT)
595 #define isalpha(x) sane_istest(x,GIT_ALPHA)
596 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
597 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
598 #define islower(x) sane_iscase(x, 1)
599 #define isupper(x) sane_iscase(x, 0)
600 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
601 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
602 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
603 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
604 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
605 #define isxdigit(x) (hexval_table[x] != -1)
606 #define tolower(x) sane_case((unsigned char)(x), 0x20)
607 #define toupper(x) sane_case((unsigned char)(x), 0)
608 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
610 static inline int sane_case(int x, int high)
612 if (sane_istest(x, GIT_ALPHA))
613 x = (x & ~0x20) | high;
614 return x;
617 static inline int sane_iscase(int x, int is_lower)
619 if (!sane_istest(x, GIT_ALPHA))
620 return 0;
622 if (is_lower)
623 return (x & 0x20) != 0;
624 else
625 return (x & 0x20) == 0;
628 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
630 unsigned long ul;
631 char *p;
633 errno = 0;
634 ul = strtoul(s, &p, base);
635 if (errno || *p || p == s || (unsigned int) ul != ul)
636 return -1;
637 *result = ul;
638 return 0;
641 static inline int strtol_i(char const *s, int base, int *result)
643 long ul;
644 char *p;
646 errno = 0;
647 ul = strtol(s, &p, base);
648 if (errno || *p || p == s || (int) ul != ul)
649 return -1;
650 *result = ul;
651 return 0;
654 #ifdef INTERNAL_QSORT
655 void git_qsort(void *base, size_t nmemb, size_t size,
656 int(*compar)(const void *, const void *));
657 #define qsort git_qsort
658 #endif
660 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
661 # define FORCE_DIR_SET_GID S_ISGID
662 #else
663 # define FORCE_DIR_SET_GID 0
664 #endif
666 #ifdef NO_NSEC
667 #undef USE_NSEC
668 #define ST_CTIME_NSEC(st) 0
669 #define ST_MTIME_NSEC(st) 0
670 #else
671 #ifdef USE_ST_TIMESPEC
672 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
673 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
674 #else
675 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
676 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
677 #endif
678 #endif
680 #ifdef UNRELIABLE_FSTAT
681 #define fstat_is_reliable() 0
682 #else
683 #define fstat_is_reliable() 1
684 #endif
686 #ifndef va_copy
688 * Since an obvious implementation of va_list would be to make it a
689 * pointer into the stack frame, a simple assignment will work on
690 * many systems. But let's try to be more portable.
692 #ifdef __va_copy
693 #define va_copy(dst, src) __va_copy(dst, src)
694 #else
695 #define va_copy(dst, src) ((dst) = (src))
696 #endif
697 #endif
700 * Preserves errno, prints a message, but gives no warning for ENOENT.
701 * Always returns the return value of unlink(2).
703 int unlink_or_warn(const char *path);
705 * Likewise for rmdir(2).
707 int rmdir_or_warn(const char *path);
709 * Calls the correct function out of {unlink,rmdir}_or_warn based on
710 * the supplied file mode.
712 int remove_or_warn(unsigned int mode, const char *path);
715 * Call access(2), but warn for any error except "missing file"
716 * (ENOENT or ENOTDIR).
718 #define ACCESS_EACCES_OK (1U << 0)
719 int access_or_warn(const char *path, int mode, unsigned flag);
720 int access_or_die(const char *path, int mode, unsigned flag);
722 /* Warn on an inaccessible file that ought to be accessible */
723 void warn_on_inaccessible(const char *path);
725 /* Get the passwd entry for the UID of the current process. */
726 struct passwd *xgetpwuid_self(void);
728 #ifndef mark_as_git_dir
729 #define mark_as_git_dir(x) /* noop */
730 #endif
732 #ifndef get_home_directory
733 #define get_home_directory() getenv("HOME")
734 #endif
737 * Enable/disable a read-only cache for file system data on platforms that
738 * support it.
740 * Implementing a live-cache is complicated and requires special platform
741 * support (inotify, ReadDirectoryChangesW...). enable_fscache shall be used
742 * to mark sections of git code that extensively read from the file system
743 * without modifying anything. Implementations can use this to cache e.g. stat
744 * data or even file content without the need to synchronize with the file
745 * system.
747 #ifndef enable_fscache
748 #define enable_fscache(x) /* noop */
749 #endif
751 #endif