Merge branch 'kb/hashmap-v5-minimal' into kb/fscache-v4-t1.8.5
[git/mingw/4msysgit.git] / git-compat-util.h
blob16bc9e9636f3842756a8e0af76425b016db2b7d6
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 #elif defined(_MSC_VER)
136 #include "compat/msvc.h"
137 #else
138 #include <sys/wait.h>
139 #include <sys/resource.h>
140 #include <sys/socket.h>
141 #include <sys/ioctl.h>
142 #include <termios.h>
143 #ifndef NO_SYS_SELECT_H
144 #include <sys/select.h>
145 #endif
146 #include <netinet/in.h>
147 #include <netinet/tcp.h>
148 #include <arpa/inet.h>
149 #include <netdb.h>
150 #include <pwd.h>
151 #include <sys/un.h>
152 #ifndef NO_INTTYPES_H
153 #include <inttypes.h>
154 #else
155 #include <stdint.h>
156 #endif
157 #ifdef NO_INTPTR_T
159 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
160 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
161 * while on IP16 and IP16L32 it is "int" (resp. "short")
162 * Size needs to match (or exceed) 'sizeof(void *)'.
163 * We can't take "long long" here as not everybody has it.
165 typedef long intptr_t;
166 typedef unsigned long uintptr_t;
167 #endif
168 #if defined(__CYGWIN__)
169 #undef _XOPEN_SOURCE
170 #include <grp.h>
171 #define _XOPEN_SOURCE 600
172 #else
173 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
174 #include <grp.h>
175 #define _ALL_SOURCE 1
176 #endif
177 #endif
179 /* used on Mac OS X */
180 #ifdef PRECOMPOSE_UNICODE
181 #include "compat/precompose_utf8.h"
182 #else
183 #define precompose_str(in,i_nfd2nfc)
184 #define precompose_argv(c,v)
185 #define probe_utf8_pathname_composition(a,b)
186 #endif
188 #ifdef MKDIR_WO_TRAILING_SLASH
189 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
190 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
191 #endif
193 #ifdef NO_STRUCT_ITIMERVAL
194 struct itimerval {
195 struct timeval it_interval;
196 struct timeval it_value;
198 #endif
200 #ifdef NO_SETITIMER
201 #define setitimer(which,value,ovalue)
202 #endif
204 #ifndef NO_LIBGEN_H
205 #include <libgen.h>
206 #else
207 #define basename gitbasename
208 extern char *gitbasename(char *);
209 #endif
211 #ifndef NO_ICONV
212 #include <iconv.h>
213 #endif
215 #ifndef NO_OPENSSL
216 #include <openssl/ssl.h>
217 #include <openssl/err.h>
218 #endif
220 /* On most systems <netdb.h> would have given us this, but
221 * not on some systems (e.g. z/OS).
223 #ifndef NI_MAXHOST
224 #define NI_MAXHOST 1025
225 #endif
227 #ifndef NI_MAXSERV
228 #define NI_MAXSERV 32
229 #endif
231 /* On most systems <limits.h> would have given us this, but
232 * not on some systems (e.g. GNU/Hurd).
234 #ifndef PATH_MAX
235 #define PATH_MAX 4096
236 #endif
238 #ifndef PRIuMAX
239 #define PRIuMAX "llu"
240 #endif
242 #ifndef PRIu32
243 #define PRIu32 "u"
244 #endif
246 #ifndef PRIx32
247 #define PRIx32 "x"
248 #endif
250 #ifndef PRIo32
251 #define PRIo32 "o"
252 #endif
254 #ifndef PATH_SEP
255 #define PATH_SEP ':'
256 #endif
258 #ifdef HAVE_PATHS_H
259 #include <paths.h>
260 #endif
261 #ifndef _PATH_DEFPATH
262 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
263 #endif
265 #ifndef STRIP_EXTENSION
266 #define STRIP_EXTENSION ""
267 #endif
269 #ifndef has_dos_drive_prefix
270 #define has_dos_drive_prefix(path) 0
271 #endif
273 #ifndef offset_1st_component
274 #define offset_1st_component(path) (is_dir_sep((path)[0]))
275 #endif
277 #ifndef is_dir_sep
278 #define is_dir_sep(c) ((c) == '/')
279 #endif
281 #ifndef find_last_dir_sep
282 #define find_last_dir_sep(path) strrchr(path, '/')
283 #endif
285 #if defined(__HP_cc) && (__HP_cc >= 61000)
286 #define NORETURN __attribute__((noreturn))
287 #define NORETURN_PTR
288 #elif defined(__GNUC__) && !defined(NO_NORETURN)
289 #define NORETURN __attribute__((__noreturn__))
290 #define NORETURN_PTR __attribute__((__noreturn__))
291 #elif defined(_MSC_VER)
292 #define NORETURN __declspec(noreturn)
293 #define NORETURN_PTR
294 #else
295 #define NORETURN
296 #define NORETURN_PTR
297 #ifndef __attribute__
298 #define __attribute__(x)
299 #endif
300 #endif
302 /* The sentinel attribute is valid from gcc version 4.0 */
303 #if defined(__GNUC__) && (__GNUC__ >= 4)
304 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
305 #else
306 #define LAST_ARG_MUST_BE_NULL
307 #endif
309 #include "compat/bswap.h"
311 #ifdef USE_WILDMATCH
312 #include "wildmatch.h"
313 #define FNM_PATHNAME WM_PATHNAME
314 #define FNM_CASEFOLD WM_CASEFOLD
315 #define FNM_NOMATCH WM_NOMATCH
316 static inline int fnmatch(const char *pattern, const char *string, int flags)
318 return wildmatch(pattern, string, flags, NULL);
320 #endif
322 /* General helper functions */
323 extern void vreportf(const char *prefix, const char *err, va_list params);
324 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
325 extern NORETURN void usage(const char *err);
326 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
327 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
328 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
329 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
330 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
332 #ifndef NO_OPENSSL
333 #ifdef APPLE_COMMON_CRYPTO
334 #include "compat/apple-common-crypto.h"
335 #else
336 #include <openssl/evp.h>
337 #include <openssl/hmac.h>
338 #endif /* APPLE_COMMON_CRYPTO */
339 #include <openssl/x509v3.h>
340 #endif /* NO_OPENSSL */
343 * Let callers be aware of the constant return value; this can help
344 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
345 * because some compilers may not support variadic macros. Since we're only
346 * trying to help gcc, anyway, it's OK; other compilers will fall back to
347 * using the function as usual.
349 #if defined(__GNUC__) && ! defined(__clang__)
350 #define error(...) (error(__VA_ARGS__), -1)
351 #endif
353 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
354 extern void set_error_routine(void (*routine)(const char *err, va_list params));
355 extern void set_die_is_recursing_routine(int (*routine)(void));
357 extern int prefixcmp(const char *str, const char *prefix);
358 extern int suffixcmp(const char *str, const char *suffix);
360 static inline const char *skip_prefix(const char *str, const char *prefix)
362 size_t len = strlen(prefix);
363 return strncmp(str, prefix, len) ? NULL : str + len;
366 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
368 #ifndef PROT_READ
369 #define PROT_READ 1
370 #define PROT_WRITE 2
371 #define MAP_PRIVATE 1
372 #endif
374 #define mmap git_mmap
375 #define munmap git_munmap
376 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
377 extern int git_munmap(void *start, size_t length);
379 #else /* NO_MMAP || USE_WIN32_MMAP */
381 #include <sys/mman.h>
383 #endif /* NO_MMAP || USE_WIN32_MMAP */
385 #ifdef NO_MMAP
387 /* This value must be multiple of (pagesize * 2) */
388 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
390 #else /* NO_MMAP */
392 /* This value must be multiple of (pagesize * 2) */
393 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
394 (sizeof(void*) >= 8 \
395 ? 1 * 1024 * 1024 * 1024 \
396 : 32 * 1024 * 1024)
398 #endif /* NO_MMAP */
400 #ifndef MAP_FAILED
401 #define MAP_FAILED ((void *)-1)
402 #endif
404 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
405 #define on_disk_bytes(st) ((st).st_size)
406 #else
407 #define on_disk_bytes(st) ((st).st_blocks * 512)
408 #endif
410 #define DEFAULT_PACKED_GIT_LIMIT \
411 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
413 #ifdef NO_PREAD
414 #define pread git_pread
415 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
416 #endif
418 * Forward decl that will remind us if its twin in cache.h changes.
419 * This function is used in compat/pread.c. But we can't include
420 * cache.h there.
422 extern ssize_t read_in_full(int fd, void *buf, size_t count);
424 #ifdef NO_SETENV
425 #define setenv gitsetenv
426 extern int gitsetenv(const char *, const char *, int);
427 #endif
429 #ifdef NO_MKDTEMP
430 #define mkdtemp gitmkdtemp
431 extern char *gitmkdtemp(char *);
432 #endif
434 #ifdef NO_MKSTEMPS
435 #define mkstemps gitmkstemps
436 extern int gitmkstemps(char *, int);
437 #endif
439 #ifdef NO_UNSETENV
440 #define unsetenv gitunsetenv
441 extern void gitunsetenv(const char *);
442 #endif
444 #ifdef NO_STRCASESTR
445 #define strcasestr gitstrcasestr
446 extern char *gitstrcasestr(const char *haystack, const char *needle);
447 #endif
449 #ifdef NO_STRLCPY
450 #define strlcpy gitstrlcpy
451 extern size_t gitstrlcpy(char *, const char *, size_t);
452 #endif
454 #ifdef NO_STRTOUMAX
455 #define strtoumax gitstrtoumax
456 extern uintmax_t gitstrtoumax(const char *, char **, int);
457 #define strtoimax gitstrtoimax
458 extern intmax_t gitstrtoimax(const char *, char **, int);
459 #endif
461 #ifdef NO_HSTRERROR
462 #define hstrerror githstrerror
463 extern const char *githstrerror(int herror);
464 #endif
466 #ifdef NO_MEMMEM
467 #define memmem gitmemmem
468 void *gitmemmem(const void *haystack, size_t haystacklen,
469 const void *needle, size_t needlelen);
470 #endif
472 #ifdef NO_GETPAGESIZE
473 #define getpagesize() sysconf(_SC_PAGESIZE)
474 #endif
476 #ifdef FREAD_READS_DIRECTORIES
477 #ifdef fopen
478 #undef fopen
479 #endif
480 #define fopen(a,b) git_fopen(a,b)
481 extern FILE *git_fopen(const char*, const char*);
482 #endif
484 #ifdef SNPRINTF_RETURNS_BOGUS
485 #define snprintf git_snprintf
486 extern int git_snprintf(char *str, size_t maxsize,
487 const char *format, ...);
488 #define vsnprintf git_vsnprintf
489 extern int git_vsnprintf(char *str, size_t maxsize,
490 const char *format, va_list ap);
491 #endif
493 #ifdef __GLIBC_PREREQ
494 #if __GLIBC_PREREQ(2, 1)
495 #define HAVE_STRCHRNUL
496 #define HAVE_MEMPCPY
497 #endif
498 #endif
500 #ifndef HAVE_STRCHRNUL
501 #define strchrnul gitstrchrnul
502 static inline char *gitstrchrnul(const char *s, int c)
504 while (*s && *s != c)
505 s++;
506 return (char *)s;
508 #endif
510 #ifndef HAVE_MEMPCPY
511 #define mempcpy gitmempcpy
512 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
514 return (char *)memcpy(dest, src, n) + n;
516 #endif
518 #ifdef NO_INET_PTON
519 int inet_pton(int af, const char *src, void *dst);
520 #endif
522 #ifdef NO_INET_NTOP
523 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
524 #endif
526 extern void release_pack_memory(size_t);
528 typedef void (*try_to_free_t)(size_t);
529 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
531 extern char *xstrdup(const char *str);
532 extern void *xmalloc(size_t size);
533 extern void *xmallocz(size_t size);
534 extern void *xmemdupz(const void *data, size_t len);
535 extern char *xstrndup(const char *str, size_t len);
536 extern void *xrealloc(void *ptr, size_t size);
537 extern void *xcalloc(size_t nmemb, size_t size);
538 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
539 extern ssize_t xread(int fd, void *buf, size_t len);
540 extern ssize_t xwrite(int fd, const void *buf, size_t len);
541 extern int xdup(int fd);
542 extern FILE *xfdopen(int fd, const char *mode);
543 extern int xmkstemp(char *template);
544 extern int xmkstemp_mode(char *template, int mode);
545 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
546 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
548 static inline size_t xsize_t(off_t len)
550 if (len > (size_t) len)
551 die("Cannot handle files this big");
552 return (size_t)len;
555 static inline int has_extension(const char *filename, const char *ext)
557 size_t len = strlen(filename);
558 size_t extlen = strlen(ext);
559 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
562 /* in ctype.c, for kwset users */
563 extern const char tolower_trans_tbl[256];
565 /* Sane ctype - no locale, and works with signed chars */
566 #undef isascii
567 #undef isspace
568 #undef isdigit
569 #undef isalpha
570 #undef isalnum
571 #undef isprint
572 #undef islower
573 #undef isupper
574 #undef tolower
575 #undef toupper
576 #undef iscntrl
577 #undef ispunct
578 #undef isxdigit
580 extern const unsigned char sane_ctype[256];
581 #define GIT_SPACE 0x01
582 #define GIT_DIGIT 0x02
583 #define GIT_ALPHA 0x04
584 #define GIT_GLOB_SPECIAL 0x08
585 #define GIT_REGEX_SPECIAL 0x10
586 #define GIT_PATHSPEC_MAGIC 0x20
587 #define GIT_CNTRL 0x40
588 #define GIT_PUNCT 0x80
589 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
590 #define isascii(x) (((x) & ~0x7f) == 0)
591 #define isspace(x) sane_istest(x,GIT_SPACE)
592 #define isdigit(x) sane_istest(x,GIT_DIGIT)
593 #define isalpha(x) sane_istest(x,GIT_ALPHA)
594 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
595 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
596 #define islower(x) sane_iscase(x, 1)
597 #define isupper(x) sane_iscase(x, 0)
598 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
599 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
600 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
601 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
602 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
603 #define isxdigit(x) (hexval_table[x] != -1)
604 #define tolower(x) sane_case((unsigned char)(x), 0x20)
605 #define toupper(x) sane_case((unsigned char)(x), 0)
606 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
608 static inline int sane_case(int x, int high)
610 if (sane_istest(x, GIT_ALPHA))
611 x = (x & ~0x20) | high;
612 return x;
615 static inline int sane_iscase(int x, int is_lower)
617 if (!sane_istest(x, GIT_ALPHA))
618 return 0;
620 if (is_lower)
621 return (x & 0x20) != 0;
622 else
623 return (x & 0x20) == 0;
626 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
628 unsigned long ul;
629 char *p;
631 errno = 0;
632 ul = strtoul(s, &p, base);
633 if (errno || *p || p == s || (unsigned int) ul != ul)
634 return -1;
635 *result = ul;
636 return 0;
639 static inline int strtol_i(char const *s, int base, int *result)
641 long ul;
642 char *p;
644 errno = 0;
645 ul = strtol(s, &p, base);
646 if (errno || *p || p == s || (int) ul != ul)
647 return -1;
648 *result = ul;
649 return 0;
652 #ifdef INTERNAL_QSORT
653 void git_qsort(void *base, size_t nmemb, size_t size,
654 int(*compar)(const void *, const void *));
655 #define qsort git_qsort
656 #endif
658 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
659 # define FORCE_DIR_SET_GID S_ISGID
660 #else
661 # define FORCE_DIR_SET_GID 0
662 #endif
664 #ifdef NO_NSEC
665 #undef USE_NSEC
666 #define ST_CTIME_NSEC(st) 0
667 #define ST_MTIME_NSEC(st) 0
668 #else
669 #ifdef USE_ST_TIMESPEC
670 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
671 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
672 #else
673 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
674 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
675 #endif
676 #endif
678 #ifdef UNRELIABLE_FSTAT
679 #define fstat_is_reliable() 0
680 #else
681 #define fstat_is_reliable() 1
682 #endif
684 #ifndef va_copy
686 * Since an obvious implementation of va_list would be to make it a
687 * pointer into the stack frame, a simple assignment will work on
688 * many systems. But let's try to be more portable.
690 #ifdef __va_copy
691 #define va_copy(dst, src) __va_copy(dst, src)
692 #else
693 #define va_copy(dst, src) ((dst) = (src))
694 #endif
695 #endif
698 * Preserves errno, prints a message, but gives no warning for ENOENT.
699 * Always returns the return value of unlink(2).
701 int unlink_or_warn(const char *path);
703 * Likewise for rmdir(2).
705 int rmdir_or_warn(const char *path);
707 * Calls the correct function out of {unlink,rmdir}_or_warn based on
708 * the supplied file mode.
710 int remove_or_warn(unsigned int mode, const char *path);
713 * Call access(2), but warn for any error except "missing file"
714 * (ENOENT or ENOTDIR).
716 #define ACCESS_EACCES_OK (1U << 0)
717 int access_or_warn(const char *path, int mode, unsigned flag);
718 int access_or_die(const char *path, int mode, unsigned flag);
720 /* Warn on an inaccessible file that ought to be accessible */
721 void warn_on_inaccessible(const char *path);
723 /* Get the passwd entry for the UID of the current process. */
724 struct passwd *xgetpwuid_self(void);
726 #ifndef mark_as_git_dir
727 #define mark_as_git_dir(x) /* noop */
728 #endif
730 #ifndef get_home_directory
731 #define get_home_directory() getenv("HOME")
732 #endif
734 #endif