core.hidedotfiles: hide '.git' dir by default
[git/dscho.git] / git-compat-util.h
blob405033f40e709fdb26a1285f1f1e46dfd1924681
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 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
79 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
80 #endif
81 #define _ALL_SOURCE 1
82 #define _GNU_SOURCE 1
83 #define _BSD_SOURCE 1
84 #define _NETBSD_SOURCE 1
85 #define _SGI_SOURCE 1
87 #ifdef WIN32 /* Both MinGW and MSVC */
88 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
89 #include <winsock2.h>
90 #include <windows.h>
91 #endif
93 #include <unistd.h>
94 #include <stdio.h>
95 #include <sys/stat.h>
96 #include <fcntl.h>
97 #include <stddef.h>
98 #include <stdlib.h>
99 #include <stdarg.h>
100 #include <string.h>
101 #include <errno.h>
102 #include <limits.h>
103 #include <sys/param.h>
104 #include <sys/types.h>
105 #include <dirent.h>
106 #include <sys/time.h>
107 #include <time.h>
108 #include <signal.h>
109 #include <fnmatch.h>
110 #include <assert.h>
111 #include <regex.h>
112 #include <utime.h>
113 #include <syslog.h>
114 #ifndef NO_SYS_POLL_H
115 #include <sys/poll.h>
116 #else
117 #include <poll.h>
118 #endif
119 #if defined(__MINGW32__)
120 /* pull in Windows compatibility stuff */
121 #include "compat/mingw.h"
122 #elif defined(_MSC_VER)
123 #include "compat/msvc.h"
124 #else
125 #include <sys/wait.h>
126 #include <sys/resource.h>
127 #include <sys/socket.h>
128 #include <sys/ioctl.h>
129 #include <termios.h>
130 #ifndef NO_SYS_SELECT_H
131 #include <sys/select.h>
132 #endif
133 #include <netinet/in.h>
134 #include <netinet/tcp.h>
135 #include <arpa/inet.h>
136 #include <netdb.h>
137 #include <pwd.h>
138 #include <sys/un.h>
139 #ifndef NO_INTTYPES_H
140 #include <inttypes.h>
141 #else
142 #include <stdint.h>
143 #endif
144 #if defined(__CYGWIN__)
145 #undef _XOPEN_SOURCE
146 #include <grp.h>
147 #define _XOPEN_SOURCE 600
148 #include "compat/cygwin.h"
149 #else
150 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
151 #include <grp.h>
152 #define _ALL_SOURCE 1
153 #endif
154 #endif
156 #ifndef NO_LIBGEN_H
157 #include <libgen.h>
158 #else
159 #define basename gitbasename
160 extern char *gitbasename(char *);
161 #endif
163 #ifndef NO_ICONV
164 #include <iconv.h>
165 #endif
167 #ifndef NO_OPENSSL
168 #include <openssl/ssl.h>
169 #include <openssl/err.h>
170 #endif
172 /* On most systems <limits.h> would have given us this, but
173 * not on some systems (e.g. GNU/Hurd).
175 #ifndef PATH_MAX
176 #define PATH_MAX 4096
177 #endif
179 #ifndef PRIuMAX
180 #define PRIuMAX "llu"
181 #endif
183 #ifndef PRIu32
184 #define PRIu32 "u"
185 #endif
187 #ifndef PRIx32
188 #define PRIx32 "x"
189 #endif
191 #ifndef PRIo32
192 #define PRIo32 "o"
193 #endif
195 #ifndef PATH_SEP
196 #define PATH_SEP ':'
197 #endif
199 #ifdef HAVE_PATHS_H
200 #include <paths.h>
201 #endif
202 #ifndef _PATH_DEFPATH
203 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
204 #endif
206 #ifndef STRIP_EXTENSION
207 #define STRIP_EXTENSION ""
208 #endif
210 #ifndef has_dos_drive_prefix
211 #define has_dos_drive_prefix(path) 0
212 #endif
214 #ifndef is_dir_sep
215 #define is_dir_sep(c) ((c) == '/')
216 #endif
218 #ifndef find_last_dir_sep
219 #define find_last_dir_sep(path) strrchr(path, '/')
220 #endif
222 #if defined(__HP_cc) && (__HP_cc >= 61000)
223 #define NORETURN __attribute__((noreturn))
224 #define NORETURN_PTR
225 #elif defined(__GNUC__) && !defined(NO_NORETURN)
226 #define NORETURN __attribute__((__noreturn__))
227 #define NORETURN_PTR __attribute__((__noreturn__))
228 #elif defined(_MSC_VER)
229 #define NORETURN __declspec(noreturn)
230 #define NORETURN_PTR
231 #else
232 #define NORETURN
233 #define NORETURN_PTR
234 #ifndef __attribute__
235 #define __attribute__(x)
236 #endif
237 #endif
239 #include "compat/bswap.h"
241 /* General helper functions */
242 extern void vreportf(const char *prefix, const char *err, va_list params);
243 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
244 extern NORETURN void usage(const char *err);
245 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
246 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
247 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
248 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
249 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
251 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
252 extern void set_error_routine(void (*routine)(const char *err, va_list params));
254 extern int prefixcmp(const char *str, const char *prefix);
255 extern int suffixcmp(const char *str, const char *suffix);
257 static inline const char *skip_prefix(const char *str, const char *prefix)
259 size_t len = strlen(prefix);
260 return strncmp(str, prefix, len) ? NULL : str + len;
263 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
265 #ifndef PROT_READ
266 #define PROT_READ 1
267 #define PROT_WRITE 2
268 #define MAP_PRIVATE 1
269 #endif
271 #define mmap git_mmap
272 #define munmap git_munmap
273 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
274 extern int git_munmap(void *start, size_t length);
276 #else /* NO_MMAP || USE_WIN32_MMAP */
278 #include <sys/mman.h>
280 #endif /* NO_MMAP || USE_WIN32_MMAP */
282 #ifdef NO_MMAP
284 /* This value must be multiple of (pagesize * 2) */
285 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
287 #else /* NO_MMAP */
289 /* This value must be multiple of (pagesize * 2) */
290 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
291 (sizeof(void*) >= 8 \
292 ? 1 * 1024 * 1024 * 1024 \
293 : 32 * 1024 * 1024)
295 #endif /* NO_MMAP */
297 #ifndef MAP_FAILED
298 #define MAP_FAILED ((void *)-1)
299 #endif
301 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
302 #define on_disk_bytes(st) ((st).st_size)
303 #else
304 #define on_disk_bytes(st) ((st).st_blocks * 512)
305 #endif
307 #define DEFAULT_PACKED_GIT_LIMIT \
308 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
310 #ifdef NO_PREAD
311 #define pread git_pread
312 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
313 #endif
315 * Forward decl that will remind us if its twin in cache.h changes.
316 * This function is used in compat/pread.c. But we can't include
317 * cache.h there.
319 extern ssize_t read_in_full(int fd, void *buf, size_t count);
321 #ifdef NO_SETENV
322 #define setenv gitsetenv
323 extern int gitsetenv(const char *, const char *, int);
324 #endif
326 #ifdef NO_MKDTEMP
327 #define mkdtemp gitmkdtemp
328 extern char *gitmkdtemp(char *);
329 #endif
331 #ifdef NO_MKSTEMPS
332 #define mkstemps gitmkstemps
333 extern int gitmkstemps(char *, int);
334 #endif
336 #ifdef NO_UNSETENV
337 #define unsetenv gitunsetenv
338 extern void gitunsetenv(const char *);
339 #endif
341 #ifdef NO_STRCASESTR
342 #define strcasestr gitstrcasestr
343 extern char *gitstrcasestr(const char *haystack, const char *needle);
344 #endif
346 #ifdef NO_STRLCPY
347 #define strlcpy gitstrlcpy
348 extern size_t gitstrlcpy(char *, const char *, size_t);
349 #endif
351 #ifdef NO_STRTOUMAX
352 #define strtoumax gitstrtoumax
353 extern uintmax_t gitstrtoumax(const char *, char **, int);
354 #define strtoimax gitstrtoimax
355 extern intmax_t gitstrtoimax(const char *, char **, int);
356 #endif
358 #ifdef NO_STRTOK_R
359 #define strtok_r gitstrtok_r
360 extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr);
361 #endif
363 #ifdef NO_HSTRERROR
364 #define hstrerror githstrerror
365 extern const char *githstrerror(int herror);
366 #endif
368 #ifdef NO_MEMMEM
369 #define memmem gitmemmem
370 void *gitmemmem(const void *haystack, size_t haystacklen,
371 const void *needle, size_t needlelen);
372 #endif
374 #ifdef FREAD_READS_DIRECTORIES
375 #ifdef fopen
376 #undef fopen
377 #endif
378 #define fopen(a,b) git_fopen(a,b)
379 extern FILE *git_fopen(const char*, const char*);
380 #endif
382 #ifdef SNPRINTF_RETURNS_BOGUS
383 #define snprintf git_snprintf
384 extern int git_snprintf(char *str, size_t maxsize,
385 const char *format, ...);
386 #define vsnprintf git_vsnprintf
387 extern int git_vsnprintf(char *str, size_t maxsize,
388 const char *format, va_list ap);
389 #endif
391 #ifdef __GLIBC_PREREQ
392 #if __GLIBC_PREREQ(2, 1)
393 #define HAVE_STRCHRNUL
394 #define HAVE_MEMPCPY
395 #endif
396 #endif
398 #ifndef HAVE_STRCHRNUL
399 #define strchrnul gitstrchrnul
400 static inline char *gitstrchrnul(const char *s, int c)
402 while (*s && *s != c)
403 s++;
404 return (char *)s;
406 #endif
408 #ifndef HAVE_MEMPCPY
409 #define mempcpy gitmempcpy
410 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
412 return (char *)memcpy(dest, src, n) + n;
414 #endif
416 #ifdef NO_INET_PTON
417 int inet_pton(int af, const char *src, void *dst);
418 #endif
420 #ifdef NO_INET_NTOP
421 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
422 #endif
424 extern void release_pack_memory(size_t, int);
426 typedef void (*try_to_free_t)(size_t);
427 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
429 extern char *xstrdup(const char *str);
430 extern void *xmalloc(size_t size);
431 extern void *xmallocz(size_t size);
432 extern void *xmemdupz(const void *data, size_t len);
433 extern char *xstrndup(const char *str, size_t len);
434 extern void *xrealloc(void *ptr, size_t size);
435 extern void *xcalloc(size_t nmemb, size_t size);
436 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
437 extern ssize_t xread(int fd, void *buf, size_t len);
438 extern ssize_t xwrite(int fd, const void *buf, size_t len);
439 extern int xdup(int fd);
440 extern FILE *xfdopen(int fd, const char *mode);
441 extern int xmkstemp(char *template);
442 extern int xmkstemp_mode(char *template, int mode);
443 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
444 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
446 static inline size_t xsize_t(off_t len)
448 if (len > (size_t) len)
449 die("Cannot handle files this big");
450 return (size_t)len;
453 static inline int has_extension(const char *filename, const char *ext)
455 size_t len = strlen(filename);
456 size_t extlen = strlen(ext);
457 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
460 /* in ctype.c, for kwset users */
461 extern const char tolower_trans_tbl[256];
463 /* Sane ctype - no locale, and works with signed chars */
464 #undef isascii
465 #undef isspace
466 #undef isdigit
467 #undef isalpha
468 #undef isalnum
469 #undef islower
470 #undef isupper
471 #undef tolower
472 #undef toupper
473 extern unsigned char sane_ctype[256];
474 #define GIT_SPACE 0x01
475 #define GIT_DIGIT 0x02
476 #define GIT_ALPHA 0x04
477 #define GIT_GLOB_SPECIAL 0x08
478 #define GIT_REGEX_SPECIAL 0x10
479 #define GIT_PATHSPEC_MAGIC 0x20
480 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
481 #define isascii(x) (((x) & ~0x7f) == 0)
482 #define isspace(x) sane_istest(x,GIT_SPACE)
483 #define isdigit(x) sane_istest(x,GIT_DIGIT)
484 #define isalpha(x) sane_istest(x,GIT_ALPHA)
485 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
486 #define islower(x) sane_iscase(x, 1)
487 #define isupper(x) sane_iscase(x, 0)
488 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
489 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
490 #define tolower(x) sane_case((unsigned char)(x), 0x20)
491 #define toupper(x) sane_case((unsigned char)(x), 0)
492 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
494 static inline int sane_case(int x, int high)
496 if (sane_istest(x, GIT_ALPHA))
497 x = (x & ~0x20) | high;
498 return x;
501 static inline int sane_iscase(int x, int is_lower)
503 if (!sane_istest(x, GIT_ALPHA))
504 return 0;
506 if (is_lower)
507 return (x & 0x20) != 0;
508 else
509 return (x & 0x20) == 0;
512 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
514 unsigned long ul;
515 char *p;
517 errno = 0;
518 ul = strtoul(s, &p, base);
519 if (errno || *p || p == s || (unsigned int) ul != ul)
520 return -1;
521 *result = ul;
522 return 0;
525 static inline int strtol_i(char const *s, int base, int *result)
527 long ul;
528 char *p;
530 errno = 0;
531 ul = strtol(s, &p, base);
532 if (errno || *p || p == s || (int) ul != ul)
533 return -1;
534 *result = ul;
535 return 0;
538 #ifdef INTERNAL_QSORT
539 void git_qsort(void *base, size_t nmemb, size_t size,
540 int(*compar)(const void *, const void *));
541 #define qsort git_qsort
542 #endif
544 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
545 # define FORCE_DIR_SET_GID S_ISGID
546 #else
547 # define FORCE_DIR_SET_GID 0
548 #endif
550 #ifdef NO_NSEC
551 #undef USE_NSEC
552 #define ST_CTIME_NSEC(st) 0
553 #define ST_MTIME_NSEC(st) 0
554 #else
555 #ifdef USE_ST_TIMESPEC
556 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
557 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
558 #else
559 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
560 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
561 #endif
562 #endif
564 #ifdef UNRELIABLE_FSTAT
565 #define fstat_is_reliable() 0
566 #else
567 #define fstat_is_reliable() 1
568 #endif
570 #ifndef va_copy
572 * Since an obvious implementation of va_list would be to make it a
573 * pointer into the stack frame, a simple assignment will work on
574 * many systems. But let's try to be more portable.
576 #ifdef __va_copy
577 #define va_copy(dst, src) __va_copy(dst, src)
578 #else
579 #define va_copy(dst, src) ((dst) = (src))
580 #endif
581 #endif
584 * Preserves errno, prints a message, but gives no warning for ENOENT.
585 * Always returns the return value of unlink(2).
587 int unlink_or_warn(const char *path);
589 * Likewise for rmdir(2).
591 int rmdir_or_warn(const char *path);
593 * Calls the correct function out of {unlink,rmdir}_or_warn based on
594 * the supplied file mode.
596 int remove_or_warn(unsigned int mode, const char *path);
598 /* Get the passwd entry for the UID of the current process. */
599 struct passwd *xgetpwuid_self(void);
601 #ifndef mark_as_git_dir
602 #define mark_as_git_dir(x) /* noop */
603 #endif
605 #endif