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