unpack-trees: do not capitalize "working"
[git] / git-compat-util.h
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
3
4 #define _FILE_OFFSET_BITS 64
5
6
7 /* Derived from Linux "Features Test Macro" header
8  * Convenience macros to test the versions of gcc (or
9  * a compatible compiler).
10  * Use them like this:
11  *  #if GIT_GNUC_PREREQ (2,8)
12  *   ... code requiring gcc 2.8 or later ...
13  *  #endif
14 */
15 #if defined(__GNUC__) && defined(__GNUC_MINOR__)
16 # define GIT_GNUC_PREREQ(maj, min) \
17         ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
18 #else
19  #define GIT_GNUC_PREREQ(maj, min) 0
20 #endif
21
22
23 #ifndef FLEX_ARRAY
24 /*
25  * See if our compiler is known to support flexible array members.
26  */
27 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
28 # define FLEX_ARRAY /* empty */
29 #elif defined(__GNUC__)
30 # if (__GNUC__ >= 3)
31 #  define FLEX_ARRAY /* empty */
32 # else
33 #  define FLEX_ARRAY 0 /* older GNU extension */
34 # endif
35 #endif
36
37 /*
38  * Otherwise, default to safer but a bit wasteful traditional style
39  */
40 #ifndef FLEX_ARRAY
41 # define FLEX_ARRAY 1
42 #endif
43 #endif
44
45
46 /*
47  * BUILD_ASSERT_OR_ZERO - assert a build-time dependency, as an expression.
48  * @cond: the compile-time condition which must be true.
49  *
50  * Your compile will fail if the condition isn't true, or can't be evaluated
51  * by the compiler.  This can be used in an expression: its value is "0".
52  *
53  * Example:
54  *      #define foo_to_char(foo)                                        \
55  *               ((char *)(foo)                                         \
56  *                + BUILD_ASSERT_OR_ZERO(offsetof(struct foo, string) == 0))
57  */
58 #define BUILD_ASSERT_OR_ZERO(cond) \
59         (sizeof(char [1 - 2*!(cond)]) - 1)
60
61 #if GIT_GNUC_PREREQ(3, 1)
62  /* &arr[0] degrades to a pointer: a different type from an array */
63 # define BARF_UNLESS_AN_ARRAY(arr)                                              \
64         BUILD_ASSERT_OR_ZERO(!__builtin_types_compatible_p(__typeof__(arr), \
65                                                            __typeof__(&(arr)[0])))
66 #else
67 # define BARF_UNLESS_AN_ARRAY(arr) 0
68 #endif
69 /*
70  * ARRAY_SIZE - get the number of elements in a visible array
71  *  <at> x: the array whose size you want.
72  *
73  * This does not work on pointers, or arrays declared as [], or
74  * function parameters.  With correct compiler support, such usage
75  * will cause a build error (see the build_assert_or_zero macro).
76  */
77 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x))
78
79 #define bitsizeof(x)  (CHAR_BIT * sizeof(x))
80
81 #define maximum_signed_value_of_type(a) \
82     (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
83
84 #define maximum_unsigned_value_of_type(a) \
85     (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
86
87 /*
88  * Signed integer overflow is undefined in C, so here's a helper macro
89  * to detect if the sum of two integers will overflow.
90  *
91  * Requires: a >= 0, typeof(a) equals typeof(b)
92  */
93 #define signed_add_overflows(a, b) \
94     ((b) > maximum_signed_value_of_type(a) - (a))
95
96 #define unsigned_add_overflows(a, b) \
97     ((b) > maximum_unsigned_value_of_type(a) - (a))
98
99 /*
100  * Returns true if the multiplication of "a" and "b" will
101  * overflow. The types of "a" and "b" must match and must be unsigned.
102  * Note that this macro evaluates "a" twice!
103  */
104 #define unsigned_mult_overflows(a, b) \
105     ((a) && (b) > maximum_unsigned_value_of_type(a) / (a))
106
107 #ifdef __GNUC__
108 #define TYPEOF(x) (__typeof__(x))
109 #else
110 #define TYPEOF(x)
111 #endif
112
113 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
114 #define HAS_MULTI_BITS(i)  ((i) & ((i) - 1))  /* checks if an integer has more than 1 bit set */
115
116 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
117
118 /* Approximation of the length of the decimal representation of this type. */
119 #define decimal_length(x)       ((int)(sizeof(x) * 2.56 + 0.5) + 1)
120
121 #if defined(__sun__)
122  /*
123   * On Solaris, when _XOPEN_EXTENDED is set, its header file
124   * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
125   * setting to say we are XPG5 or XPG6.  Also on Solaris,
126   * XPG6 programs must be compiled with a c99 compiler, while
127   * non XPG6 programs must be compiled with a pre-c99 compiler.
128   */
129 # if __STDC_VERSION__ - 0 >= 199901L
130 # define _XOPEN_SOURCE 600
131 # else
132 # define _XOPEN_SOURCE 500
133 # endif
134 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
135       !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
136       !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
137       !defined(__CYGWIN__)
138 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
139 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
140 #endif
141 #define _ALL_SOURCE 1
142 #define _GNU_SOURCE 1
143 #define _BSD_SOURCE 1
144 #define _DEFAULT_SOURCE 1
145 #define _NETBSD_SOURCE 1
146 #define _SGI_SOURCE 1
147
148 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
149 # if defined (_MSC_VER) && !defined(_WIN32_WINNT)
150 #  define _WIN32_WINNT 0x0502
151 # endif
152 #define WIN32_LEAN_AND_MEAN  /* stops windows.h including winsock.h */
153 #include <winsock2.h>
154 #include <windows.h>
155 #define GIT_WINDOWS_NATIVE
156 #endif
157
158 #include <unistd.h>
159 #include <stdio.h>
160 #include <sys/stat.h>
161 #include <fcntl.h>
162 #include <stddef.h>
163 #include <stdlib.h>
164 #include <stdarg.h>
165 #include <string.h>
166 #ifdef HAVE_STRINGS_H
167 #include <strings.h> /* for strcasecmp() */
168 #endif
169 #include <errno.h>
170 #include <limits.h>
171 #ifdef NEEDS_SYS_PARAM_H
172 #include <sys/param.h>
173 #endif
174 #include <sys/types.h>
175 #include <dirent.h>
176 #include <sys/time.h>
177 #include <time.h>
178 #include <signal.h>
179 #include <assert.h>
180 #include <regex.h>
181 #include <utime.h>
182 #include <syslog.h>
183 #ifndef NO_SYS_POLL_H
184 #include <sys/poll.h>
185 #else
186 #include <poll.h>
187 #endif
188 #ifdef HAVE_BSD_SYSCTL
189 #include <sys/sysctl.h>
190 #endif
191
192 #if defined(__MINGW32__)
193 /* pull in Windows compatibility stuff */
194 #include "compat/mingw.h"
195 #elif defined(_MSC_VER)
196 #include "compat/msvc.h"
197 #else
198 #include <sys/utsname.h>
199 #include <sys/wait.h>
200 #include <sys/resource.h>
201 #include <sys/socket.h>
202 #include <sys/ioctl.h>
203 #include <termios.h>
204 #ifndef NO_SYS_SELECT_H
205 #include <sys/select.h>
206 #endif
207 #include <netinet/in.h>
208 #include <netinet/tcp.h>
209 #include <arpa/inet.h>
210 #include <netdb.h>
211 #include <pwd.h>
212 #include <sys/un.h>
213 #ifndef NO_INTTYPES_H
214 #include <inttypes.h>
215 #else
216 #include <stdint.h>
217 #endif
218 #ifdef NO_INTPTR_T
219 /*
220  * On I16LP32, ILP32 and LP64 "long" is the save bet, however
221  * on LLP86, IL33LLP64 and P64 it needs to be "long long",
222  * while on IP16 and IP16L32 it is "int" (resp. "short")
223  * Size needs to match (or exceed) 'sizeof(void *)'.
224  * We can't take "long long" here as not everybody has it.
225  */
226 typedef long intptr_t;
227 typedef unsigned long uintptr_t;
228 #endif
229 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
230 #include <grp.h>
231 #define _ALL_SOURCE 1
232 #endif
233
234 /* used on Mac OS X */
235 #ifdef PRECOMPOSE_UNICODE
236 #include "compat/precompose_utf8.h"
237 #else
238 #define precompose_str(in,i_nfd2nfc)
239 #define precompose_argv(c,v)
240 #define probe_utf8_pathname_composition()
241 #endif
242
243 #ifdef MKDIR_WO_TRAILING_SLASH
244 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
245 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
246 #endif
247
248 #ifdef NO_STRUCT_ITIMERVAL
249 struct itimerval {
250         struct timeval it_interval;
251         struct timeval it_value;
252 };
253 #endif
254
255 #ifdef NO_SETITIMER
256 #define setitimer(which,value,ovalue)
257 #endif
258
259 #ifndef NO_LIBGEN_H
260 #include <libgen.h>
261 #else
262 #define basename gitbasename
263 extern char *gitbasename(char *);
264 #define dirname gitdirname
265 extern char *gitdirname(char *);
266 #endif
267
268 #ifndef NO_ICONV
269 #include <iconv.h>
270 #endif
271
272 #ifndef NO_OPENSSL
273 #ifdef __APPLE__
274 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
275 #include <AvailabilityMacros.h>
276 #undef DEPRECATED_ATTRIBUTE
277 #define DEPRECATED_ATTRIBUTE
278 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
279 #endif
280 #include <openssl/ssl.h>
281 #include <openssl/err.h>
282 #endif
283
284 /* On most systems <netdb.h> would have given us this, but
285  * not on some systems (e.g. z/OS).
286  */
287 #ifndef NI_MAXHOST
288 #define NI_MAXHOST 1025
289 #endif
290
291 #ifndef NI_MAXSERV
292 #define NI_MAXSERV 32
293 #endif
294
295 /* On most systems <limits.h> would have given us this, but
296  * not on some systems (e.g. GNU/Hurd).
297  */
298 #ifndef PATH_MAX
299 #define PATH_MAX 4096
300 #endif
301
302 #ifndef PRIuMAX
303 #define PRIuMAX "llu"
304 #endif
305
306 #ifndef SCNuMAX
307 #define SCNuMAX PRIuMAX
308 #endif
309
310 #ifndef PRIu32
311 #define PRIu32 "u"
312 #endif
313
314 #ifndef PRIx32
315 #define PRIx32 "x"
316 #endif
317
318 #ifndef PRIo32
319 #define PRIo32 "o"
320 #endif
321
322 #ifndef PATH_SEP
323 #define PATH_SEP ':'
324 #endif
325
326 #ifdef HAVE_PATHS_H
327 #include <paths.h>
328 #endif
329 #ifndef _PATH_DEFPATH
330 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
331 #endif
332
333 #ifndef has_dos_drive_prefix
334 static inline int git_has_dos_drive_prefix(const char *path)
335 {
336         return 0;
337 }
338 #define has_dos_drive_prefix git_has_dos_drive_prefix
339 #endif
340
341 #ifndef skip_dos_drive_prefix
342 static inline int git_skip_dos_drive_prefix(char **path)
343 {
344         return 0;
345 }
346 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
347 #endif
348
349 #ifndef is_dir_sep
350 static inline int git_is_dir_sep(int c)
351 {
352         return c == '/';
353 }
354 #define is_dir_sep git_is_dir_sep
355 #endif
356
357 #ifndef offset_1st_component
358 static inline int git_offset_1st_component(const char *path)
359 {
360         return is_dir_sep(path[0]);
361 }
362 #define offset_1st_component git_offset_1st_component
363 #endif
364
365 #ifndef find_last_dir_sep
366 static inline char *git_find_last_dir_sep(const char *path)
367 {
368         return strrchr(path, '/');
369 }
370 #define find_last_dir_sep git_find_last_dir_sep
371 #endif
372
373 #if defined(__HP_cc) && (__HP_cc >= 61000)
374 #define NORETURN __attribute__((noreturn))
375 #define NORETURN_PTR
376 #elif defined(__GNUC__) && !defined(NO_NORETURN)
377 #define NORETURN __attribute__((__noreturn__))
378 #define NORETURN_PTR __attribute__((__noreturn__))
379 #elif defined(_MSC_VER)
380 #define NORETURN __declspec(noreturn)
381 #define NORETURN_PTR
382 #else
383 #define NORETURN
384 #define NORETURN_PTR
385 #ifndef __GNUC__
386 #ifndef __attribute__
387 #define __attribute__(x)
388 #endif
389 #endif
390 #endif
391
392 /* The sentinel attribute is valid from gcc version 4.0 */
393 #if defined(__GNUC__) && (__GNUC__ >= 4)
394 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
395 #else
396 #define LAST_ARG_MUST_BE_NULL
397 #endif
398
399 #include "compat/bswap.h"
400
401 #include "wildmatch.h"
402
403 struct strbuf;
404
405 /* General helper functions */
406 extern void vreportf(const char *prefix, const char *err, va_list params);
407 extern NORETURN void usage(const char *err);
408 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
409 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
410 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
411 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
412 extern int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
413 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
414 extern void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
415
416 #ifndef NO_OPENSSL
417 #ifdef APPLE_COMMON_CRYPTO
418 #include "compat/apple-common-crypto.h"
419 #else
420 #include <openssl/evp.h>
421 #include <openssl/hmac.h>
422 #endif /* APPLE_COMMON_CRYPTO */
423 #include <openssl/x509v3.h>
424 #endif /* NO_OPENSSL */
425
426 /*
427  * Let callers be aware of the constant return value; this can help
428  * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
429  * because some compilers may not support variadic macros. Since we're only
430  * trying to help gcc, anyway, it's OK; other compilers will fall back to
431  * using the function as usual.
432  */
433 #if defined(__GNUC__)
434 static inline int const_error(void)
435 {
436         return -1;
437 }
438 #define error(...) (error(__VA_ARGS__), const_error())
439 #endif
440
441 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
442 extern void set_error_routine(void (*routine)(const char *err, va_list params));
443 extern void set_die_is_recursing_routine(int (*routine)(void));
444 extern void set_error_handle(FILE *);
445
446 extern int starts_with(const char *str, const char *prefix);
447
448 /*
449  * If the string "str" begins with the string found in "prefix", return 1.
450  * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
451  * the string right after the prefix).
452  *
453  * Otherwise, return 0 and leave "out" untouched.
454  *
455  * Examples:
456  *
457  *   [extract branch name, fail if not a branch]
458  *   if (!skip_prefix(ref, "refs/heads/", &branch)
459  *      return -1;
460  *
461  *   [skip prefix if present, otherwise use whole string]
462  *   skip_prefix(name, "refs/heads/", &name);
463  */
464 static inline int skip_prefix(const char *str, const char *prefix,
465                               const char **out)
466 {
467         do {
468                 if (!*prefix) {
469                         *out = str;
470                         return 1;
471                 }
472         } while (*str++ == *prefix++);
473         return 0;
474 }
475
476 /*
477  * Like skip_prefix, but promises never to read past "len" bytes of the input
478  * buffer, and returns the remaining number of bytes in "out" via "outlen".
479  */
480 static inline int skip_prefix_mem(const char *buf, size_t len,
481                                   const char *prefix,
482                                   const char **out, size_t *outlen)
483 {
484         size_t prefix_len = strlen(prefix);
485         if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) {
486                 *out = buf + prefix_len;
487                 *outlen = len - prefix_len;
488                 return 1;
489         }
490         return 0;
491 }
492
493 /*
494  * If buf ends with suffix, return 1 and subtract the length of the suffix
495  * from *len. Otherwise, return 0 and leave *len untouched.
496  */
497 static inline int strip_suffix_mem(const char *buf, size_t *len,
498                                    const char *suffix)
499 {
500         size_t suflen = strlen(suffix);
501         if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
502                 return 0;
503         *len -= suflen;
504         return 1;
505 }
506
507 /*
508  * If str ends with suffix, return 1 and set *len to the size of the string
509  * without the suffix. Otherwise, return 0 and set *len to the size of the
510  * string.
511  *
512  * Note that we do _not_ NUL-terminate str to the new length.
513  */
514 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
515 {
516         *len = strlen(str);
517         return strip_suffix_mem(str, len, suffix);
518 }
519
520 static inline int ends_with(const char *str, const char *suffix)
521 {
522         size_t len;
523         return strip_suffix(str, suffix, &len);
524 }
525
526 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
527
528 #ifndef PROT_READ
529 #define PROT_READ 1
530 #define PROT_WRITE 2
531 #define MAP_PRIVATE 1
532 #endif
533
534 #define mmap git_mmap
535 #define munmap git_munmap
536 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
537 extern int git_munmap(void *start, size_t length);
538
539 #else /* NO_MMAP || USE_WIN32_MMAP */
540
541 #include <sys/mman.h>
542
543 #endif /* NO_MMAP || USE_WIN32_MMAP */
544
545 #ifdef NO_MMAP
546
547 /* This value must be multiple of (pagesize * 2) */
548 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
549
550 #else /* NO_MMAP */
551
552 /* This value must be multiple of (pagesize * 2) */
553 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
554         (sizeof(void*) >= 8 \
555                 ?  1 * 1024 * 1024 * 1024 \
556                 : 32 * 1024 * 1024)
557
558 #endif /* NO_MMAP */
559
560 #ifndef MAP_FAILED
561 #define MAP_FAILED ((void *)-1)
562 #endif
563
564 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
565 #define on_disk_bytes(st) ((st).st_size)
566 #else
567 #define on_disk_bytes(st) ((st).st_blocks * 512)
568 #endif
569
570 #ifdef NEEDS_MODE_TRANSLATION
571 #undef S_IFMT
572 #undef S_IFREG
573 #undef S_IFDIR
574 #undef S_IFLNK
575 #undef S_IFBLK
576 #undef S_IFCHR
577 #undef S_IFIFO
578 #undef S_IFSOCK
579 #define S_IFMT   0170000
580 #define S_IFREG  0100000
581 #define S_IFDIR  0040000
582 #define S_IFLNK  0120000
583 #define S_IFBLK  0060000
584 #define S_IFCHR  0020000
585 #define S_IFIFO  0010000
586 #define S_IFSOCK 0140000
587 #ifdef stat
588 #undef stat
589 #endif
590 #define stat(path, buf) git_stat(path, buf)
591 extern int git_stat(const char *, struct stat *);
592 #ifdef fstat
593 #undef fstat
594 #endif
595 #define fstat(fd, buf) git_fstat(fd, buf)
596 extern int git_fstat(int, struct stat *);
597 #ifdef lstat
598 #undef lstat
599 #endif
600 #define lstat(path, buf) git_lstat(path, buf)
601 extern int git_lstat(const char *, struct stat *);
602 #endif
603
604 #define DEFAULT_PACKED_GIT_LIMIT \
605         ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? 8192 : 256))
606
607 #ifdef NO_PREAD
608 #define pread git_pread
609 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
610 #endif
611 /*
612  * Forward decl that will remind us if its twin in cache.h changes.
613  * This function is used in compat/pread.c.  But we can't include
614  * cache.h there.
615  */
616 extern ssize_t read_in_full(int fd, void *buf, size_t count);
617
618 #ifdef NO_SETENV
619 #define setenv gitsetenv
620 extern int gitsetenv(const char *, const char *, int);
621 #endif
622
623 #ifdef NO_MKDTEMP
624 #define mkdtemp gitmkdtemp
625 extern char *gitmkdtemp(char *);
626 #endif
627
628 #ifdef NO_MKSTEMPS
629 #define mkstemps gitmkstemps
630 extern int gitmkstemps(char *, int);
631 #endif
632
633 #ifdef NO_UNSETENV
634 #define unsetenv gitunsetenv
635 extern void gitunsetenv(const char *);
636 #endif
637
638 #ifdef NO_STRCASESTR
639 #define strcasestr gitstrcasestr
640 extern char *gitstrcasestr(const char *haystack, const char *needle);
641 #endif
642
643 #ifdef NO_STRLCPY
644 #define strlcpy gitstrlcpy
645 extern size_t gitstrlcpy(char *, const char *, size_t);
646 #endif
647
648 #ifdef NO_STRTOUMAX
649 #define strtoumax gitstrtoumax
650 extern uintmax_t gitstrtoumax(const char *, char **, int);
651 #define strtoimax gitstrtoimax
652 extern intmax_t gitstrtoimax(const char *, char **, int);
653 #endif
654
655 #ifdef NO_HSTRERROR
656 #define hstrerror githstrerror
657 extern const char *githstrerror(int herror);
658 #endif
659
660 #ifdef NO_MEMMEM
661 #define memmem gitmemmem
662 void *gitmemmem(const void *haystack, size_t haystacklen,
663                 const void *needle, size_t needlelen);
664 #endif
665
666 #ifdef NO_GETPAGESIZE
667 #define getpagesize() sysconf(_SC_PAGESIZE)
668 #endif
669
670 #ifndef O_CLOEXEC
671 #define O_CLOEXEC 0
672 #endif
673
674 #ifdef FREAD_READS_DIRECTORIES
675 #ifdef fopen
676 #undef fopen
677 #endif
678 #define fopen(a,b) git_fopen(a,b)
679 extern FILE *git_fopen(const char*, const char*);
680 #endif
681
682 #ifdef SNPRINTF_RETURNS_BOGUS
683 #ifdef snprintf
684 #undef snprintf
685 #endif
686 #define snprintf git_snprintf
687 extern int git_snprintf(char *str, size_t maxsize,
688                         const char *format, ...);
689 #ifdef vsnprintf
690 #undef vsnprintf
691 #endif
692 #define vsnprintf git_vsnprintf
693 extern int git_vsnprintf(char *str, size_t maxsize,
694                          const char *format, va_list ap);
695 #endif
696
697 #ifdef __GLIBC_PREREQ
698 #if __GLIBC_PREREQ(2, 1)
699 #define HAVE_STRCHRNUL
700 #endif
701 #endif
702
703 #ifndef HAVE_STRCHRNUL
704 #define strchrnul gitstrchrnul
705 static inline char *gitstrchrnul(const char *s, int c)
706 {
707         while (*s && *s != c)
708                 s++;
709         return (char *)s;
710 }
711 #endif
712
713 #ifdef NO_INET_PTON
714 int inet_pton(int af, const char *src, void *dst);
715 #endif
716
717 #ifdef NO_INET_NTOP
718 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
719 #endif
720
721 #ifdef NO_PTHREADS
722 #define atexit git_atexit
723 extern int git_atexit(void (*handler)(void));
724 #endif
725
726 extern void release_pack_memory(size_t);
727
728 typedef void (*try_to_free_t)(size_t);
729 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
730
731 static inline size_t st_add(size_t a, size_t b)
732 {
733         if (unsigned_add_overflows(a, b))
734                 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
735                     (uintmax_t)a, (uintmax_t)b);
736         return a + b;
737 }
738 #define st_add3(a,b,c)   st_add(st_add((a),(b)),(c))
739 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
740
741 static inline size_t st_mult(size_t a, size_t b)
742 {
743         if (unsigned_mult_overflows(a, b))
744                 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
745                     (uintmax_t)a, (uintmax_t)b);
746         return a * b;
747 }
748
749 static inline size_t st_sub(size_t a, size_t b)
750 {
751         if (a < b)
752                 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
753                     (uintmax_t)a, (uintmax_t)b);
754         return a - b;
755 }
756
757 #ifdef HAVE_ALLOCA_H
758 # include <alloca.h>
759 # define xalloca(size)      (alloca(size))
760 # define xalloca_free(p)    do {} while (0)
761 #else
762 # define xalloca(size)      (xmalloc(size))
763 # define xalloca_free(p)    (free(p))
764 #endif
765 extern char *xstrdup(const char *str);
766 extern void *xmalloc(size_t size);
767 extern void *xmallocz(size_t size);
768 extern void *xmallocz_gently(size_t size);
769 extern void *xmemdupz(const void *data, size_t len);
770 extern char *xstrndup(const char *str, size_t len);
771 extern void *xrealloc(void *ptr, size_t size);
772 extern void *xcalloc(size_t nmemb, size_t size);
773 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
774 extern void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
775 extern int xopen(const char *path, int flags, ...);
776 extern ssize_t xread(int fd, void *buf, size_t len);
777 extern ssize_t xwrite(int fd, const void *buf, size_t len);
778 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
779 extern int xdup(int fd);
780 extern FILE *xfopen(const char *path, const char *mode);
781 extern FILE *xfdopen(int fd, const char *mode);
782 extern int xmkstemp(char *template);
783 extern int xmkstemp_mode(char *template, int mode);
784 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
785 extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
786 extern char *xgetcwd(void);
787 extern FILE *fopen_for_writing(const char *path);
788
789 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
790 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
791
792 /*
793  * These functions help you allocate structs with flex arrays, and copy
794  * the data directly into the array. For example, if you had:
795  *
796  *   struct foo {
797  *     int bar;
798  *     char name[FLEX_ARRAY];
799  *   };
800  *
801  * you can do:
802  *
803  *   struct foo *f;
804  *   FLEX_ALLOC_MEM(f, name, src, len);
805  *
806  * to allocate a "foo" with the contents of "src" in the "name" field.
807  * The resulting struct is automatically zero'd, and the flex-array field
808  * is NUL-terminated (whether the incoming src buffer was or not).
809  *
810  * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
811  * but do want to store a pointer to some extra data in the same allocated
812  * block. For example, if you have:
813  *
814  *   struct foo {
815  *     char *name;
816  *     int bar;
817  *   };
818  *
819  * you can do:
820  *
821  *   struct foo *f;
822  *   FLEXPTR_ALLOC_STR(f, name, src);
823  *
824  * and "name" will point to a block of memory after the struct, which will be
825  * freed along with the struct (but the pointer can be repointed anywhere).
826  *
827  * The *_STR variants accept a string parameter rather than a ptr/len
828  * combination.
829  *
830  * Note that these macros will evaluate the first parameter multiple
831  * times, and it must be assignable as an lvalue.
832  */
833 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
834         (x) = NULL; /* silence -Wuninitialized for offset calculation */ \
835         (x) = xalloc_flex(sizeof(*(x)), (char *)(&((x)->flexname)) - (char *)(x), (buf), (len)); \
836 } while (0)
837 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
838         (x) = xalloc_flex(sizeof(*(x)), sizeof(*(x)), (buf), (len)); \
839         (x)->ptrname = (void *)((x)+1); \
840 } while(0)
841 #define FLEX_ALLOC_STR(x, flexname, str) \
842         FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
843 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
844         FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
845
846 static inline void *xalloc_flex(size_t base_len, size_t offset,
847                                 const void *src, size_t src_len)
848 {
849         unsigned char *ret = xcalloc(1, st_add3(base_len, src_len, 1));
850         memcpy(ret + offset, src, src_len);
851         return ret;
852 }
853
854 static inline char *xstrdup_or_null(const char *str)
855 {
856         return str ? xstrdup(str) : NULL;
857 }
858
859 static inline size_t xsize_t(off_t len)
860 {
861         if (len > (size_t) len)
862                 die("Cannot handle files this big");
863         return (size_t)len;
864 }
865
866 __attribute__((format (printf, 3, 4)))
867 extern int xsnprintf(char *dst, size_t max, const char *fmt, ...);
868
869 /* in ctype.c, for kwset users */
870 extern const unsigned char tolower_trans_tbl[256];
871
872 /* Sane ctype - no locale, and works with signed chars */
873 #undef isascii
874 #undef isspace
875 #undef isdigit
876 #undef isalpha
877 #undef isalnum
878 #undef isprint
879 #undef islower
880 #undef isupper
881 #undef tolower
882 #undef toupper
883 #undef iscntrl
884 #undef ispunct
885 #undef isxdigit
886
887 extern const unsigned char sane_ctype[256];
888 #define GIT_SPACE 0x01
889 #define GIT_DIGIT 0x02
890 #define GIT_ALPHA 0x04
891 #define GIT_GLOB_SPECIAL 0x08
892 #define GIT_REGEX_SPECIAL 0x10
893 #define GIT_PATHSPEC_MAGIC 0x20
894 #define GIT_CNTRL 0x40
895 #define GIT_PUNCT 0x80
896 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
897 #define isascii(x) (((x) & ~0x7f) == 0)
898 #define isspace(x) sane_istest(x,GIT_SPACE)
899 #define isdigit(x) sane_istest(x,GIT_DIGIT)
900 #define isalpha(x) sane_istest(x,GIT_ALPHA)
901 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
902 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
903 #define islower(x) sane_iscase(x, 1)
904 #define isupper(x) sane_iscase(x, 0)
905 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
906 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
907 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
908 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
909                 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
910 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
911 #define tolower(x) sane_case((unsigned char)(x), 0x20)
912 #define toupper(x) sane_case((unsigned char)(x), 0)
913 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
914
915 static inline int sane_case(int x, int high)
916 {
917         if (sane_istest(x, GIT_ALPHA))
918                 x = (x & ~0x20) | high;
919         return x;
920 }
921
922 static inline int sane_iscase(int x, int is_lower)
923 {
924         if (!sane_istest(x, GIT_ALPHA))
925                 return 0;
926
927         if (is_lower)
928                 return (x & 0x20) != 0;
929         else
930                 return (x & 0x20) == 0;
931 }
932
933 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
934 {
935         unsigned long ul;
936         char *p;
937
938         errno = 0;
939         /* negative values would be accepted by strtoul */
940         if (strchr(s, '-'))
941                 return -1;
942         ul = strtoul(s, &p, base);
943         if (errno || *p || p == s || (unsigned int) ul != ul)
944                 return -1;
945         *result = ul;
946         return 0;
947 }
948
949 static inline int strtol_i(char const *s, int base, int *result)
950 {
951         long ul;
952         char *p;
953
954         errno = 0;
955         ul = strtol(s, &p, base);
956         if (errno || *p || p == s || (int) ul != ul)
957                 return -1;
958         *result = ul;
959         return 0;
960 }
961
962 #ifdef INTERNAL_QSORT
963 void git_qsort(void *base, size_t nmemb, size_t size,
964                int(*compar)(const void *, const void *));
965 #define qsort git_qsort
966 #endif
967
968 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
969 # define FORCE_DIR_SET_GID S_ISGID
970 #else
971 # define FORCE_DIR_SET_GID 0
972 #endif
973
974 #ifdef NO_NSEC
975 #undef USE_NSEC
976 #define ST_CTIME_NSEC(st) 0
977 #define ST_MTIME_NSEC(st) 0
978 #else
979 #ifdef USE_ST_TIMESPEC
980 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
981 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
982 #else
983 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
984 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
985 #endif
986 #endif
987
988 #ifdef UNRELIABLE_FSTAT
989 #define fstat_is_reliable() 0
990 #else
991 #define fstat_is_reliable() 1
992 #endif
993
994 #ifndef va_copy
995 /*
996  * Since an obvious implementation of va_list would be to make it a
997  * pointer into the stack frame, a simple assignment will work on
998  * many systems.  But let's try to be more portable.
999  */
1000 #ifdef __va_copy
1001 #define va_copy(dst, src) __va_copy(dst, src)
1002 #else
1003 #define va_copy(dst, src) ((dst) = (src))
1004 #endif
1005 #endif
1006
1007 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
1008 #define HAVE_VARIADIC_MACROS 1
1009 #endif
1010
1011 /*
1012  * Preserves errno, prints a message, but gives no warning for ENOENT.
1013  * Returns 0 on success, which includes trying to unlink an object that does
1014  * not exist.
1015  */
1016 int unlink_or_warn(const char *path);
1017  /*
1018   * Tries to unlink file.  Returns 0 if unlink succeeded
1019   * or the file already didn't exist.  Returns -1 and
1020   * appends a message to err suitable for
1021   * 'error("%s", err->buf)' on error.
1022   */
1023 int unlink_or_msg(const char *file, struct strbuf *err);
1024 /*
1025  * Preserves errno, prints a message, but gives no warning for ENOENT.
1026  * Returns 0 on success, which includes trying to remove a directory that does
1027  * not exist.
1028  */
1029 int rmdir_or_warn(const char *path);
1030 /*
1031  * Calls the correct function out of {unlink,rmdir}_or_warn based on
1032  * the supplied file mode.
1033  */
1034 int remove_or_warn(unsigned int mode, const char *path);
1035
1036 /*
1037  * Call access(2), but warn for any error except "missing file"
1038  * (ENOENT or ENOTDIR).
1039  */
1040 #define ACCESS_EACCES_OK (1U << 0)
1041 int access_or_warn(const char *path, int mode, unsigned flag);
1042 int access_or_die(const char *path, int mode, unsigned flag);
1043
1044 /* Warn on an inaccessible file that ought to be accessible */
1045 void warn_on_inaccessible(const char *path);
1046
1047 #ifdef GMTIME_UNRELIABLE_ERRORS
1048 struct tm *git_gmtime(const time_t *);
1049 struct tm *git_gmtime_r(const time_t *, struct tm *);
1050 #define gmtime git_gmtime
1051 #define gmtime_r git_gmtime_r
1052 #endif
1053
1054 #if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
1055 #define USE_PARENS_AROUND_GETTEXT_N 1
1056 #endif
1057
1058 #ifndef SHELL_PATH
1059 # define SHELL_PATH "/bin/sh"
1060 #endif
1061
1062 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1063 #define flockfile(fh)
1064 #define funlockfile(fh)
1065 #define getc_unlocked(fh) getc(fh)
1066 #endif
1067
1068 #endif
1069
1070 extern int cmd_main(int, const char **);