1#ifndef GIT_COMPAT_UTIL_H
2#define GIT_COMPAT_UTIL_H
3#define _FILE_OFFSET_BITS 64
5/* 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#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/*
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/*
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#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#define bitsizeof(x) (CHAR_BIT * sizeof(x))
80#define maximum_signed_value_of_type(a) \
82 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
83#define maximum_unsigned_value_of_type(a) \
85 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
86/*
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#define unsigned_add_overflows(a, b) \
97 ((b) > maximum_unsigned_value_of_type(a) - (a))
98/*
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#ifdef __GNUC__
108#define TYPEOF(x) (__typeof__(x))
109#else
110#define TYPEOF(x)
111#endif
112#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#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
117/* 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#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#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#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#if defined(__CYGWIN__)
193#include "compat/cygwin.h"
194#endif
195#if defined(__MINGW32__)
196/* pull in Windows compatibility stuff */
197#include "compat/mingw.h"
198#elif defined(_MSC_VER)
199#include "compat/msvc.h"
200#else
201#include <sys/utsname.h>
202#include <sys/wait.h>
203#include <sys/resource.h>
204#include <sys/socket.h>
205#include <sys/ioctl.h>
206#include <termios.h>
207#ifndef NO_SYS_SELECT_H
208#include <sys/select.h>
209#endif
210#include <netinet/in.h>
211#include <netinet/tcp.h>
212#include <arpa/inet.h>
213#include <netdb.h>
214#include <pwd.h>
215#include <sys/un.h>
216#ifndef NO_INTTYPES_H
217#include <inttypes.h>
218#else
219#include <stdint.h>
220#endif
221#ifdef NO_INTPTR_T
222/*
223 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
224 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
225 * while on IP16 and IP16L32 it is "int" (resp. "short")
226 * Size needs to match (or exceed) 'sizeof(void *)'.
227 * We can't take "long long" here as not everybody has it.
228 */
229typedef long intptr_t;
230typedef unsigned long uintptr_t;
231#endif
232#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
233#include <grp.h>
234#define _ALL_SOURCE 1
235#endif
236/* used on Mac OS X */
238#ifdef PRECOMPOSE_UNICODE
239#include "compat/precompose_utf8.h"
240#else
241#define precompose_str(in,i_nfd2nfc)
242#define precompose_argv(c,v)
243#define probe_utf8_pathname_composition()
244#endif
245#ifdef MKDIR_WO_TRAILING_SLASH
247#define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
248extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
249#endif
250#ifdef NO_STRUCT_ITIMERVAL
252struct itimerval {
253 struct timeval it_interval;
254 struct timeval it_value;
255};
256#endif
257#ifdef NO_SETITIMER
259#define setitimer(which,value,ovalue)
260#endif
261#ifndef NO_LIBGEN_H
263#include <libgen.h>
264#else
265#define basename gitbasename
266extern char *gitbasename(char *);
267#define dirname gitdirname
268extern char *gitdirname(char *);
269#endif
270#ifndef NO_ICONV
272#include <iconv.h>
273#endif
274#ifndef NO_OPENSSL
276#ifdef __APPLE__
277#define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
278#include <AvailabilityMacros.h>
279#undef DEPRECATED_ATTRIBUTE
280#define DEPRECATED_ATTRIBUTE
281#undef __AVAILABILITY_MACROS_USES_AVAILABILITY
282#endif
283#include <openssl/ssl.h>
284#include <openssl/err.h>
285#endif
286/* On most systems <netdb.h> would have given us this, but
288 * not on some systems (e.g. z/OS).
289 */
290#ifndef NI_MAXHOST
291#define NI_MAXHOST 1025
292#endif
293#ifndef NI_MAXSERV
295#define NI_MAXSERV 32
296#endif
297/* On most systems <limits.h> would have given us this, but
299 * not on some systems (e.g. GNU/Hurd).
300 */
301#ifndef PATH_MAX
302#define PATH_MAX 4096
303#endif
304#ifndef PRIuMAX
306#define PRIuMAX "llu"
307#endif
308#ifndef SCNuMAX
310#define SCNuMAX PRIuMAX
311#endif
312#ifndef PRIu32
314#define PRIu32 "u"
315#endif
316#ifndef PRIx32
318#define PRIx32 "x"
319#endif
320#ifndef PRIo32
322#define PRIo32 "o"
323#endif
324typedef uintmax_t timestamp_t;
326#define PRItime PRIuMAX
327#define parse_timestamp strtoumax
328#define TIME_MAX UINTMAX_MAX
329#ifndef PATH_SEP
331#define PATH_SEP ':'
332#endif
333#ifdef HAVE_PATHS_H
335#include <paths.h>
336#endif
337#ifndef _PATH_DEFPATH
338#define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
339#endif
340#ifndef has_dos_drive_prefix
342static inline int git_has_dos_drive_prefix(const char *path)
343{
344 return 0;
345}
346#define has_dos_drive_prefix git_has_dos_drive_prefix
347#endif
348#ifndef skip_dos_drive_prefix
350static inline int git_skip_dos_drive_prefix(char **path)
351{
352 return 0;
353}
354#define skip_dos_drive_prefix git_skip_dos_drive_prefix
355#endif
356#ifndef is_dir_sep
358static inline int git_is_dir_sep(int c)
359{
360 return c == '/';
361}
362#define is_dir_sep git_is_dir_sep
363#endif
364#ifndef offset_1st_component
366static inline int git_offset_1st_component(const char *path)
367{
368 return is_dir_sep(path[0]);
369}
370#define offset_1st_component git_offset_1st_component
371#endif
372#ifndef find_last_dir_sep
374static inline char *git_find_last_dir_sep(const char *path)
375{
376 return strrchr(path, '/');
377}
378#define find_last_dir_sep git_find_last_dir_sep
379#endif
380#if defined(__HP_cc) && (__HP_cc >= 61000)
382#define NORETURN __attribute__((noreturn))
383#define NORETURN_PTR
384#elif defined(__GNUC__) && !defined(NO_NORETURN)
385#define NORETURN __attribute__((__noreturn__))
386#define NORETURN_PTR __attribute__((__noreturn__))
387#elif defined(_MSC_VER)
388#define NORETURN __declspec(noreturn)
389#define NORETURN_PTR
390#else
391#define NORETURN
392#define NORETURN_PTR
393#ifndef __GNUC__
394#ifndef __attribute__
395#define __attribute__(x)
396#endif
397#endif
398#endif
399/* The sentinel attribute is valid from gcc version 4.0 */
401#if defined(__GNUC__) && (__GNUC__ >= 4)
402#define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
403#else
404#define LAST_ARG_MUST_BE_NULL
405#endif
406#include "compat/bswap.h"
408#include "wildmatch.h"
410struct strbuf;
412/* General helper functions */
414extern void vreportf(const char *prefix, const char *err, va_list params);
415extern NORETURN void usage(const char *err);
416extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
417extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
418extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
419extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
420extern int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
421extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
422extern void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
423#ifndef NO_OPENSSL
425#ifdef APPLE_COMMON_CRYPTO
426#include "compat/apple-common-crypto.h"
427#else
428#include <openssl/evp.h>
429#include <openssl/hmac.h>
430#endif /* APPLE_COMMON_CRYPTO */
431#include <openssl/x509v3.h>
432#endif /* NO_OPENSSL */
433/*
435 * Let callers be aware of the constant return value; this can help
436 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
437 * because some compilers may not support variadic macros. Since we're only
438 * trying to help gcc, anyway, it's OK; other compilers will fall back to
439 * using the function as usual.
440 */
441#if defined(__GNUC__)
442static inline int const_error(void)
443{
444 return -1;
445}
446#define error(...) (error(__VA_ARGS__), const_error())
447#define error_errno(...) (error_errno(__VA_ARGS__), const_error())
448#endif
449extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
451extern void set_error_routine(void (*routine)(const char *err, va_list params));
452extern void (*get_error_routine(void))(const char *err, va_list params);
453extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
454extern void (*get_warn_routine(void))(const char *warn, va_list params);
455extern void set_die_is_recursing_routine(int (*routine)(void));
456extern int starts_with(const char *str, const char *prefix);
458extern int istarts_with(const char *str, const char *prefix);
459/*
461 * If the string "str" begins with the string found in "prefix", return 1.
462 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
463 * the string right after the prefix).
464 *
465 * Otherwise, return 0 and leave "out" untouched.
466 *
467 * Examples:
468 *
469 * [extract branch name, fail if not a branch]
470 * if (!skip_prefix(ref, "refs/heads/", &branch)
471 * return -1;
472 *
473 * [skip prefix if present, otherwise use whole string]
474 * skip_prefix(name, "refs/heads/", &name);
475 */
476static inline int skip_prefix(const char *str, const char *prefix,
477 const char **out)
478{
479 do {
480 if (!*prefix) {
481 *out = str;
482 return 1;
483 }
484 } while (*str++ == *prefix++);
485 return 0;
486}
487/*
489 * If the string "str" is the same as the string in "prefix", then the "arg"
490 * parameter is set to the "def" parameter and 1 is returned.
491 * If the string "str" begins with the string found in "prefix" and then a
492 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
493 * (i.e., to the point in the string right after the prefix and the "=" sign),
494 * and 1 is returned.
495 *
496 * Otherwise, return 0 and leave "arg" untouched.
497 *
498 * When we accept both a "--key" and a "--key=<val>" option, this function
499 * can be used instead of !strcmp(arg, "--key") and then
500 * skip_prefix(arg, "--key=", &arg) to parse such an option.
501 */
502int skip_to_optional_arg_default(const char *str, const char *prefix,
503 const char **arg, const char *def);
504static inline int skip_to_optional_arg(const char *str, const char *prefix,
506 const char **arg)
507{
508 return skip_to_optional_arg_default(str, prefix, arg, "");
509}
510/*
512 * Like skip_prefix, but promises never to read past "len" bytes of the input
513 * buffer, and returns the remaining number of bytes in "out" via "outlen".
514 */
515static inline int skip_prefix_mem(const char *buf, size_t len,
516 const char *prefix,
517 const char **out, size_t *outlen)
518{
519 size_t prefix_len = strlen(prefix);
520 if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) {
521 *out = buf + prefix_len;
522 *outlen = len - prefix_len;
523 return 1;
524 }
525 return 0;
526}
527/*
529 * If buf ends with suffix, return 1 and subtract the length of the suffix
530 * from *len. Otherwise, return 0 and leave *len untouched.
531 */
532static inline int strip_suffix_mem(const char *buf, size_t *len,
533 const char *suffix)
534{
535 size_t suflen = strlen(suffix);
536 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
537 return 0;
538 *len -= suflen;
539 return 1;
540}
541/*
543 * If str ends with suffix, return 1 and set *len to the size of the string
544 * without the suffix. Otherwise, return 0 and set *len to the size of the
545 * string.
546 *
547 * Note that we do _not_ NUL-terminate str to the new length.
548 */
549static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
550{
551 *len = strlen(str);
552 return strip_suffix_mem(str, len, suffix);
553}
554static inline int ends_with(const char *str, const char *suffix)
556{
557 size_t len;
558 return strip_suffix(str, suffix, &len);
559}
560#define SWAP(a, b) do { \
562 void *_swap_a_ptr = &(a); \
563 void *_swap_b_ptr = &(b); \
564 unsigned char _swap_buffer[sizeof(a)]; \
565 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
566 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
567 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
568 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
569} while (0)
570#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
572#ifndef PROT_READ
574#define PROT_READ 1
575#define PROT_WRITE 2
576#define MAP_PRIVATE 1
577#endif
578#define mmap git_mmap
580#define munmap git_munmap
581extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
582extern int git_munmap(void *start, size_t length);
583#else /* NO_MMAP || USE_WIN32_MMAP */
585#include <sys/mman.h>
587#endif /* NO_MMAP || USE_WIN32_MMAP */
589#ifdef NO_MMAP
591/* This value must be multiple of (pagesize * 2) */
593#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
594#else /* NO_MMAP */
596/* This value must be multiple of (pagesize * 2) */
598#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
599 (sizeof(void*) >= 8 \
600 ? 1 * 1024 * 1024 * 1024 \
601 : 32 * 1024 * 1024)
602#endif /* NO_MMAP */
604#ifndef MAP_FAILED
606#define MAP_FAILED ((void *)-1)
607#endif
608#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
610#define on_disk_bytes(st) ((st).st_size)
611#else
612#define on_disk_bytes(st) ((st).st_blocks * 512)
613#endif
614#ifdef NEEDS_MODE_TRANSLATION
616#undef S_IFMT
617#undef S_IFREG
618#undef S_IFDIR
619#undef S_IFLNK
620#undef S_IFBLK
621#undef S_IFCHR
622#undef S_IFIFO
623#undef S_IFSOCK
624#define S_IFMT 0170000
625#define S_IFREG 0100000
626#define S_IFDIR 0040000
627#define S_IFLNK 0120000
628#define S_IFBLK 0060000
629#define S_IFCHR 0020000
630#define S_IFIFO 0010000
631#define S_IFSOCK 0140000
632#ifdef stat
633#undef stat
634#endif
635#define stat(path, buf) git_stat(path, buf)
636extern int git_stat(const char *, struct stat *);
637#ifdef fstat
638#undef fstat
639#endif
640#define fstat(fd, buf) git_fstat(fd, buf)
641extern int git_fstat(int, struct stat *);
642#ifdef lstat
643#undef lstat
644#endif
645#define lstat(path, buf) git_lstat(path, buf)
646extern int git_lstat(const char *, struct stat *);
647#endif
648#define DEFAULT_PACKED_GIT_LIMIT \
650 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
651#ifdef NO_PREAD
653#define pread git_pread
654extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
655#endif
656/*
657 * Forward decl that will remind us if its twin in cache.h changes.
658 * This function is used in compat/pread.c. But we can't include
659 * cache.h there.
660 */
661extern ssize_t read_in_full(int fd, void *buf, size_t count);
662#ifdef NO_SETENV
664#define setenv gitsetenv
665extern int gitsetenv(const char *, const char *, int);
666#endif
667#ifdef NO_MKDTEMP
669#define mkdtemp gitmkdtemp
670extern char *gitmkdtemp(char *);
671#endif
672#ifdef NO_UNSETENV
674#define unsetenv gitunsetenv
675extern void gitunsetenv(const char *);
676#endif
677#ifdef NO_STRCASESTR
679#define strcasestr gitstrcasestr
680extern char *gitstrcasestr(const char *haystack, const char *needle);
681#endif
682#ifdef NO_STRLCPY
684#define strlcpy gitstrlcpy
685extern size_t gitstrlcpy(char *, const char *, size_t);
686#endif
687#ifdef NO_STRTOUMAX
689#define strtoumax gitstrtoumax
690extern uintmax_t gitstrtoumax(const char *, char **, int);
691#define strtoimax gitstrtoimax
692extern intmax_t gitstrtoimax(const char *, char **, int);
693#endif
694#ifdef NO_HSTRERROR
696#define hstrerror githstrerror
697extern const char *githstrerror(int herror);
698#endif
699#ifdef NO_MEMMEM
701#define memmem gitmemmem
702void *gitmemmem(const void *haystack, size_t haystacklen,
703 const void *needle, size_t needlelen);
704#endif
705#ifdef OVERRIDE_STRDUP
707#ifdef strdup
708#undef strdup
709#endif
710#define strdup gitstrdup
711char *gitstrdup(const char *s);
712#endif
713#ifdef NO_GETPAGESIZE
715#define getpagesize() sysconf(_SC_PAGESIZE)
716#endif
717#ifndef O_CLOEXEC
719#define O_CLOEXEC 0
720#endif
721#ifdef FREAD_READS_DIRECTORIES
723# if !defined(SUPPRESS_FOPEN_REDEFINITION)
724# ifdef fopen
725# undef fopen
726# endif
727# define fopen(a,b) git_fopen(a,b)
728# endif
729extern FILE *git_fopen(const char*, const char*);
730#endif
731#ifdef SNPRINTF_RETURNS_BOGUS
733#ifdef snprintf
734#undef snprintf
735#endif
736#define snprintf git_snprintf
737extern int git_snprintf(char *str, size_t maxsize,
738 const char *format, ...);
739#ifdef vsnprintf
740#undef vsnprintf
741#endif
742#define vsnprintf git_vsnprintf
743extern int git_vsnprintf(char *str, size_t maxsize,
744 const char *format, va_list ap);
745#endif
746#ifdef __GLIBC_PREREQ
748#if __GLIBC_PREREQ(2, 1)
749#define HAVE_STRCHRNUL
750#endif
751#endif
752#ifndef HAVE_STRCHRNUL
754#define strchrnul gitstrchrnul
755static inline char *gitstrchrnul(const char *s, int c)
756{
757 while (*s && *s != c)
758 s++;
759 return (char *)s;
760}
761#endif
762#ifdef NO_INET_PTON
764int inet_pton(int af, const char *src, void *dst);
765#endif
766#ifdef NO_INET_NTOP
768const char *inet_ntop(int af, const void *src, char *dst, size_t size);
769#endif
770#ifdef NO_PTHREADS
772#define atexit git_atexit
773extern int git_atexit(void (*handler)(void));
774#endif
775typedef void (*try_to_free_t)(size_t);
777extern try_to_free_t set_try_to_free_routine(try_to_free_t);
778static inline size_t st_add(size_t a, size_t b)
780{
781 if (unsigned_add_overflows(a, b))
782 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
783 (uintmax_t)a, (uintmax_t)b);
784 return a + b;
785}
786#define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
787#define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
788static inline size_t st_mult(size_t a, size_t b)
790{
791 if (unsigned_mult_overflows(a, b))
792 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
793 (uintmax_t)a, (uintmax_t)b);
794 return a * b;
795}
796static inline size_t st_sub(size_t a, size_t b)
798{
799 if (a < b)
800 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
801 (uintmax_t)a, (uintmax_t)b);
802 return a - b;
803}
804#ifdef HAVE_ALLOCA_H
806# include <alloca.h>
807# define xalloca(size) (alloca(size))
808# define xalloca_free(p) do {} while (0)
809#else
810# define xalloca(size) (xmalloc(size))
811# define xalloca_free(p) (free(p))
812#endif
813extern char *xstrdup(const char *str);
814extern void *xmalloc(size_t size);
815extern void *xmallocz(size_t size);
816extern void *xmallocz_gently(size_t size);
817extern void *xmemdupz(const void *data, size_t len);
818extern char *xstrndup(const char *str, size_t len);
819extern void *xrealloc(void *ptr, size_t size);
820extern void *xcalloc(size_t nmemb, size_t size);
821extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
822extern void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
823extern int xopen(const char *path, int flags, ...);
824extern ssize_t xread(int fd, void *buf, size_t len);
825extern ssize_t xwrite(int fd, const void *buf, size_t len);
826extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
827extern int xdup(int fd);
828extern FILE *xfopen(const char *path, const char *mode);
829extern FILE *xfdopen(int fd, const char *mode);
830extern int xmkstemp(char *template);
831extern int xmkstemp_mode(char *template, int mode);
832extern char *xgetcwd(void);
833extern FILE *fopen_for_writing(const char *path);
834extern FILE *fopen_or_warn(const char *path, const char *mode);
835/*
837 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
838 * that ptr is used twice, so don't pass e.g. ptr++.
839 */
840#define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
841#define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
843#define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
844#define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
846 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
847static inline void copy_array(void *dst, const void *src, size_t n, size_t size)
848{
849 if (n)
850 memcpy(dst, src, st_mult(size, n));
851}
852#define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
854 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
855static inline void move_array(void *dst, const void *src, size_t n, size_t size)
856{
857 if (n)
858 memmove(dst, src, st_mult(size, n));
859}
860/*
862 * These functions help you allocate structs with flex arrays, and copy
863 * the data directly into the array. For example, if you had:
864 *
865 * struct foo {
866 * int bar;
867 * char name[FLEX_ARRAY];
868 * };
869 *
870 * you can do:
871 *
872 * struct foo *f;
873 * FLEX_ALLOC_MEM(f, name, src, len);
874 *
875 * to allocate a "foo" with the contents of "src" in the "name" field.
876 * The resulting struct is automatically zero'd, and the flex-array field
877 * is NUL-terminated (whether the incoming src buffer was or not).
878 *
879 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
880 * but do want to store a pointer to some extra data in the same allocated
881 * block. For example, if you have:
882 *
883 * struct foo {
884 * char *name;
885 * int bar;
886 * };
887 *
888 * you can do:
889 *
890 * struct foo *f;
891 * FLEXPTR_ALLOC_STR(f, name, src);
892 *
893 * and "name" will point to a block of memory after the struct, which will be
894 * freed along with the struct (but the pointer can be repointed anywhere).
895 *
896 * The *_STR variants accept a string parameter rather than a ptr/len
897 * combination.
898 *
899 * Note that these macros will evaluate the first parameter multiple
900 * times, and it must be assignable as an lvalue.
901 */
902#define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
903 size_t flex_array_len_ = (len); \
904 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
905 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
906} while (0)
907#define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
908 size_t flex_array_len_ = (len); \
909 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
910 memcpy((x) + 1, (buf), flex_array_len_); \
911 (x)->ptrname = (void *)((x)+1); \
912} while(0)
913#define FLEX_ALLOC_STR(x, flexname, str) \
914 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
915#define FLEXPTR_ALLOC_STR(x, ptrname, str) \
916 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
917static inline char *xstrdup_or_null(const char *str)
919{
920 return str ? xstrdup(str) : NULL;
921}
922static inline size_t xsize_t(off_t len)
924{
925 size_t size = (size_t) len;
926 if (len != (off_t) size)
928 die("Cannot handle files this big");
929 return size;
930}
931__attribute__((format (printf, 3, 4)))
933extern int xsnprintf(char *dst, size_t max, const char *fmt, ...);
934#ifndef HOST_NAME_MAX
936#define HOST_NAME_MAX 256
937#endif
938extern int xgethostname(char *buf, size_t len);
940/* in ctype.c, for kwset users */
942extern const unsigned char tolower_trans_tbl[256];
943/* Sane ctype - no locale, and works with signed chars */
945#undef isascii
946#undef isspace
947#undef isdigit
948#undef isalpha
949#undef isalnum
950#undef isprint
951#undef islower
952#undef isupper
953#undef tolower
954#undef toupper
955#undef iscntrl
956#undef ispunct
957#undef isxdigit
958extern const unsigned char sane_ctype[256];
960#define GIT_SPACE 0x01
961#define GIT_DIGIT 0x02
962#define GIT_ALPHA 0x04
963#define GIT_GLOB_SPECIAL 0x08
964#define GIT_REGEX_SPECIAL 0x10
965#define GIT_PATHSPEC_MAGIC 0x20
966#define GIT_CNTRL 0x40
967#define GIT_PUNCT 0x80
968#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
969#define isascii(x) (((x) & ~0x7f) == 0)
970#define isspace(x) sane_istest(x,GIT_SPACE)
971#define isdigit(x) sane_istest(x,GIT_DIGIT)
972#define isalpha(x) sane_istest(x,GIT_ALPHA)
973#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
974#define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
975#define islower(x) sane_iscase(x, 1)
976#define isupper(x) sane_iscase(x, 0)
977#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
978#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
979#define iscntrl(x) (sane_istest(x,GIT_CNTRL))
980#define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
981 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
982#define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
983#define tolower(x) sane_case((unsigned char)(x), 0x20)
984#define toupper(x) sane_case((unsigned char)(x), 0)
985#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
986static inline int sane_case(int x, int high)
988{
989 if (sane_istest(x, GIT_ALPHA))
990 x = (x & ~0x20) | high;
991 return x;
992}
993static inline int sane_iscase(int x, int is_lower)
995{
996 if (!sane_istest(x, GIT_ALPHA))
997 return 0;
998 if (is_lower)
1000 return (x & 0x20) != 0;
1001 else
1002 return (x & 0x20) == 0;
1003}
1004static inline int strtoul_ui(char const *s, int base, unsigned int *result)
1006{
1007 unsigned long ul;
1008 char *p;
1009 errno = 0;
1011 /* negative values would be accepted by strtoul */
1012 if (strchr(s, '-'))
1013 return -1;
1014 ul = strtoul(s, &p, base);
1015 if (errno || *p || p == s || (unsigned int) ul != ul)
1016 return -1;
1017 *result = ul;
1018 return 0;
1019}
1020static inline int strtol_i(char const *s, int base, int *result)
1022{
1023 long ul;
1024 char *p;
1025 errno = 0;
1027 ul = strtol(s, &p, base);
1028 if (errno || *p || p == s || (int) ul != ul)
1029 return -1;
1030 *result = ul;
1031 return 0;
1032}
1033#ifdef INTERNAL_QSORT
1035void git_qsort(void *base, size_t nmemb, size_t size,
1036 int(*compar)(const void *, const void *));
1037#define qsort git_qsort
1038#endif
1039#define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1041static inline void sane_qsort(void *base, size_t nmemb, size_t size,
1042 int(*compar)(const void *, const void *))
1043{
1044 if (nmemb > 1)
1045 qsort(base, nmemb, size, compar);
1046}
1047#ifndef HAVE_ISO_QSORT_S
1049int git_qsort_s(void *base, size_t nmemb, size_t size,
1050 int (*compar)(const void *, const void *, void *), void *ctx);
1051#define qsort_s git_qsort_s
1052#endif
1053#define QSORT_S(base, n, compar, ctx) do { \
1055 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1056 die("BUG: qsort_s() failed"); \
1057} while (0)
1058#ifndef REG_STARTEND
1060#error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1061#endif
1062static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size,
1064 size_t nmatch, regmatch_t pmatch[], int eflags)
1065{
1066 assert(nmatch > 0 && pmatch);
1067 pmatch[0].rm_so = 0;
1068 pmatch[0].rm_eo = size;
1069 return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND);
1070}
1071#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1073# define FORCE_DIR_SET_GID S_ISGID
1074#else
1075# define FORCE_DIR_SET_GID 0
1076#endif
1077#ifdef NO_NSEC
1079#undef USE_NSEC
1080#define ST_CTIME_NSEC(st) 0
1081#define ST_MTIME_NSEC(st) 0
1082#else
1083#ifdef USE_ST_TIMESPEC
1084#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1085#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1086#else
1087#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1088#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1089#endif
1090#endif
1091#ifdef UNRELIABLE_FSTAT
1093#define fstat_is_reliable() 0
1094#else
1095#define fstat_is_reliable() 1
1096#endif
1097#ifndef va_copy
1099/*
1100 * Since an obvious implementation of va_list would be to make it a
1101 * pointer into the stack frame, a simple assignment will work on
1102 * many systems. But let's try to be more portable.
1103 */
1104#ifdef __va_copy
1105#define va_copy(dst, src) __va_copy(dst, src)
1106#else
1107#define va_copy(dst, src) ((dst) = (src))
1108#endif
1109#endif
1110#if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
1112#define HAVE_VARIADIC_MACROS 1
1113#endif
1114#ifdef HAVE_VARIADIC_MACROS
1116__attribute__((format (printf, 3, 4))) NORETURN
1117void BUG_fl(const char *file, int line, const char *fmt, ...);
1118#define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1119#else
1120__attribute__((format (printf, 1, 2))) NORETURN
1121void BUG(const char *fmt, ...);
1122#endif
1123/*
1125 * Preserves errno, prints a message, but gives no warning for ENOENT.
1126 * Returns 0 on success, which includes trying to unlink an object that does
1127 * not exist.
1128 */
1129int unlink_or_warn(const char *path);
1130 /*
1131 * Tries to unlink file. Returns 0 if unlink succeeded
1132 * or the file already didn't exist. Returns -1 and
1133 * appends a message to err suitable for
1134 * 'error("%s", err->buf)' on error.
1135 */
1136int unlink_or_msg(const char *file, struct strbuf *err);
1137/*
1138 * Preserves errno, prints a message, but gives no warning for ENOENT.
1139 * Returns 0 on success, which includes trying to remove a directory that does
1140 * not exist.
1141 */
1142int rmdir_or_warn(const char *path);
1143/*
1144 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1145 * the supplied file mode.
1146 */
1147int remove_or_warn(unsigned int mode, const char *path);
1148/*
1150 * Call access(2), but warn for any error except "missing file"
1151 * (ENOENT or ENOTDIR).
1152 */
1153#define ACCESS_EACCES_OK (1U << 0)
1154int access_or_warn(const char *path, int mode, unsigned flag);
1155int access_or_die(const char *path, int mode, unsigned flag);
1156/* Warn on an inaccessible file if errno indicates this is an error */
1158int warn_on_fopen_errors(const char *path);
1159#ifdef GMTIME_UNRELIABLE_ERRORS
1161struct tm *git_gmtime(const time_t *);
1162struct tm *git_gmtime_r(const time_t *, struct tm *);
1163#define gmtime git_gmtime
1164#define gmtime_r git_gmtime_r
1165#endif
1166#if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
1168#define USE_PARENS_AROUND_GETTEXT_N 1
1169#endif
1170#ifndef SHELL_PATH
1172# define SHELL_PATH "/bin/sh"
1173#endif
1174#ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1176#define flockfile(fh)
1177#define funlockfile(fh)
1178#define getc_unlocked(fh) getc(fh)
1179#endif
1180/*
1182 * Our code often opens a path to an optional file, to work on its
1183 * contents when we can successfully open it. We can ignore a failure
1184 * to open if such an optional file does not exist, but we do want to
1185 * report a failure in opening for other reasons (e.g. we got an I/O
1186 * error, or the file is there, but we lack the permission to open).
1187 *
1188 * Call this function after seeing an error from open() or fopen() to
1189 * see if the errno indicates a missing file that we can safely ignore.
1190 */
1191static inline int is_missing_file_error(int errno_)
1192{
1193 return (errno_ == ENOENT || errno_ == ENOTDIR);
1194}
1195extern int cmd_main(int, const char **);
1197/*
1199 * You can mark a stack variable with UNLEAK(var) to avoid it being
1200 * reported as a leak by tools like LSAN or valgrind. The argument
1201 * should generally be the variable itself (not its address and not what
1202 * it points to). It's safe to use this on pointers which may already
1203 * have been freed, or on pointers which may still be in use.
1204 *
1205 * Use this _only_ for a variable that leaks by going out of scope at
1206 * program exit (so only from cmd_* functions or their direct helpers).
1207 * Normal functions, especially those which may be called multiple
1208 * times, should actually free their memory. This is only meant as
1209 * an annotation, and does nothing in non-leak-checking builds.
1210 */
1211#ifdef SUPPRESS_ANNOTATED_LEAKS
1212extern void unleak_memory(const void *ptr, size_t len);
1213#define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1214#else
1215#define UNLEAK(var) do {} while (0)
1216#endif
1217#endif