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(_WIN32_WINNT)
150# define _WIN32_WINNT 0x0600
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 safe 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#ifdef HAVE_SYSINFO
288# include <sys/sysinfo.h>
289#endif
290/* On most systems <netdb.h> would have given us this, but
292 * not on some systems (e.g. z/OS).
293 */
294#ifndef NI_MAXHOST
295#define NI_MAXHOST 1025
296#endif
297#ifndef NI_MAXSERV
299#define NI_MAXSERV 32
300#endif
301/* On most systems <limits.h> would have given us this, but
303 * not on some systems (e.g. GNU/Hurd).
304 */
305#ifndef PATH_MAX
306#define PATH_MAX 4096
307#endif
308#ifndef PRIuMAX
310#define PRIuMAX "llu"
311#endif
312#ifndef SCNuMAX
314#define SCNuMAX PRIuMAX
315#endif
316#ifndef PRIu32
318#define PRIu32 "u"
319#endif
320#ifndef PRIx32
322#define PRIx32 "x"
323#endif
324#ifndef PRIo32
326#define PRIo32 "o"
327#endif
328typedef uintmax_t timestamp_t;
330#define PRItime PRIuMAX
331#define parse_timestamp strtoumax
332#define TIME_MAX UINTMAX_MAX
333#ifndef PATH_SEP
335#define PATH_SEP ':'
336#endif
337#ifdef HAVE_PATHS_H
339#include <paths.h>
340#endif
341#ifndef _PATH_DEFPATH
342#define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
343#endif
344#ifndef has_dos_drive_prefix
346static inline int git_has_dos_drive_prefix(const char *path)
347{
348 return 0;
349}
350#define has_dos_drive_prefix git_has_dos_drive_prefix
351#endif
352#ifndef skip_dos_drive_prefix
354static inline int git_skip_dos_drive_prefix(char **path)
355{
356 return 0;
357}
358#define skip_dos_drive_prefix git_skip_dos_drive_prefix
359#endif
360#ifndef is_dir_sep
362static inline int git_is_dir_sep(int c)
363{
364 return c == '/';
365}
366#define is_dir_sep git_is_dir_sep
367#endif
368#ifndef offset_1st_component
370static inline int git_offset_1st_component(const char *path)
371{
372 return is_dir_sep(path[0]);
373}
374#define offset_1st_component git_offset_1st_component
375#endif
376#ifndef find_last_dir_sep
378static inline char *git_find_last_dir_sep(const char *path)
379{
380 return strrchr(path, '/');
381}
382#define find_last_dir_sep git_find_last_dir_sep
383#endif
384#ifndef query_user_email
386#define query_user_email() NULL
387#endif
388#if defined(__HP_cc) && (__HP_cc >= 61000)
390#define NORETURN __attribute__((noreturn))
391#define NORETURN_PTR
392#elif defined(__GNUC__) && !defined(NO_NORETURN)
393#define NORETURN __attribute__((__noreturn__))
394#define NORETURN_PTR __attribute__((__noreturn__))
395#elif defined(_MSC_VER)
396#define NORETURN __declspec(noreturn)
397#define NORETURN_PTR
398#else
399#define NORETURN
400#define NORETURN_PTR
401#ifndef __GNUC__
402#ifndef __attribute__
403#define __attribute__(x)
404#endif
405#endif
406#endif
407/* The sentinel attribute is valid from gcc version 4.0 */
409#if defined(__GNUC__) && (__GNUC__ >= 4)
410#define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
411#else
412#define LAST_ARG_MUST_BE_NULL
413#endif
414#include "compat/bswap.h"
416#include "wildmatch.h"
418struct strbuf;
420/* General helper functions */
422extern void vreportf(const char *prefix, const char *err, va_list params);
423extern NORETURN void usage(const char *err);
424extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
425extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
426extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
427extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
428extern int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
429extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
430extern void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
431#ifndef NO_OPENSSL
433#ifdef APPLE_COMMON_CRYPTO
434#include "compat/apple-common-crypto.h"
435#else
436#include <openssl/evp.h>
437#include <openssl/hmac.h>
438#endif /* APPLE_COMMON_CRYPTO */
439#include <openssl/x509v3.h>
440#endif /* NO_OPENSSL */
441/*
443 * Let callers be aware of the constant return value; this can help
444 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
445 * because some compilers may not support variadic macros. Since we're only
446 * trying to help gcc, anyway, it's OK; other compilers will fall back to
447 * using the function as usual.
448 */
449#if defined(__GNUC__)
450static inline int const_error(void)
451{
452 return -1;
453}
454#define error(...) (error(__VA_ARGS__), const_error())
455#define error_errno(...) (error_errno(__VA_ARGS__), const_error())
456#endif
457extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
459extern void set_error_routine(void (*routine)(const char *err, va_list params));
460extern void (*get_error_routine(void))(const char *err, va_list params);
461extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
462extern void (*get_warn_routine(void))(const char *warn, va_list params);
463extern void set_die_is_recursing_routine(int (*routine)(void));
464extern int starts_with(const char *str, const char *prefix);
466extern int istarts_with(const char *str, const char *prefix);
467/*
469 * If the string "str" begins with the string found in "prefix", return 1.
470 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
471 * the string right after the prefix).
472 *
473 * Otherwise, return 0 and leave "out" untouched.
474 *
475 * Examples:
476 *
477 * [extract branch name, fail if not a branch]
478 * if (!skip_prefix(ref, "refs/heads/", &branch)
479 * return -1;
480 *
481 * [skip prefix if present, otherwise use whole string]
482 * skip_prefix(name, "refs/heads/", &name);
483 */
484static inline int skip_prefix(const char *str, const char *prefix,
485 const char **out)
486{
487 do {
488 if (!*prefix) {
489 *out = str;
490 return 1;
491 }
492 } while (*str++ == *prefix++);
493 return 0;
494}
495/*
497 * If the string "str" is the same as the string in "prefix", then the "arg"
498 * parameter is set to the "def" parameter and 1 is returned.
499 * If the string "str" begins with the string found in "prefix" and then a
500 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
501 * (i.e., to the point in the string right after the prefix and the "=" sign),
502 * and 1 is returned.
503 *
504 * Otherwise, return 0 and leave "arg" untouched.
505 *
506 * When we accept both a "--key" and a "--key=<val>" option, this function
507 * can be used instead of !strcmp(arg, "--key") and then
508 * skip_prefix(arg, "--key=", &arg) to parse such an option.
509 */
510int skip_to_optional_arg_default(const char *str, const char *prefix,
511 const char **arg, const char *def);
512static inline int skip_to_optional_arg(const char *str, const char *prefix,
514 const char **arg)
515{
516 return skip_to_optional_arg_default(str, prefix, arg, "");
517}
518/*
520 * Like skip_prefix, but promises never to read past "len" bytes of the input
521 * buffer, and returns the remaining number of bytes in "out" via "outlen".
522 */
523static inline int skip_prefix_mem(const char *buf, size_t len,
524 const char *prefix,
525 const char **out, size_t *outlen)
526{
527 size_t prefix_len = strlen(prefix);
528 if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) {
529 *out = buf + prefix_len;
530 *outlen = len - prefix_len;
531 return 1;
532 }
533 return 0;
534}
535/*
537 * If buf ends with suffix, return 1 and subtract the length of the suffix
538 * from *len. Otherwise, return 0 and leave *len untouched.
539 */
540static inline int strip_suffix_mem(const char *buf, size_t *len,
541 const char *suffix)
542{
543 size_t suflen = strlen(suffix);
544 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
545 return 0;
546 *len -= suflen;
547 return 1;
548}
549/*
551 * If str ends with suffix, return 1 and set *len to the size of the string
552 * without the suffix. Otherwise, return 0 and set *len to the size of the
553 * string.
554 *
555 * Note that we do _not_ NUL-terminate str to the new length.
556 */
557static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
558{
559 *len = strlen(str);
560 return strip_suffix_mem(str, len, suffix);
561}
562static inline int ends_with(const char *str, const char *suffix)
564{
565 size_t len;
566 return strip_suffix(str, suffix, &len);
567}
568#define SWAP(a, b) do { \
570 void *_swap_a_ptr = &(a); \
571 void *_swap_b_ptr = &(b); \
572 unsigned char _swap_buffer[sizeof(a)]; \
573 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
574 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
575 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
576 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
577} while (0)
578#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
580#ifndef PROT_READ
582#define PROT_READ 1
583#define PROT_WRITE 2
584#define MAP_PRIVATE 1
585#endif
586#define mmap git_mmap
588#define munmap git_munmap
589extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
590extern int git_munmap(void *start, size_t length);
591#else /* NO_MMAP || USE_WIN32_MMAP */
593#include <sys/mman.h>
595#endif /* NO_MMAP || USE_WIN32_MMAP */
597#ifdef NO_MMAP
599/* This value must be multiple of (pagesize * 2) */
601#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
602#else /* NO_MMAP */
604/* This value must be multiple of (pagesize * 2) */
606#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
607 (sizeof(void*) >= 8 \
608 ? 1 * 1024 * 1024 * 1024 \
609 : 32 * 1024 * 1024)
610#endif /* NO_MMAP */
612#ifndef MAP_FAILED
614#define MAP_FAILED ((void *)-1)
615#endif
616#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
618#define on_disk_bytes(st) ((st).st_size)
619#else
620#define on_disk_bytes(st) ((st).st_blocks * 512)
621#endif
622#ifdef NEEDS_MODE_TRANSLATION
624#undef S_IFMT
625#undef S_IFREG
626#undef S_IFDIR
627#undef S_IFLNK
628#undef S_IFBLK
629#undef S_IFCHR
630#undef S_IFIFO
631#undef S_IFSOCK
632#define S_IFMT 0170000
633#define S_IFREG 0100000
634#define S_IFDIR 0040000
635#define S_IFLNK 0120000
636#define S_IFBLK 0060000
637#define S_IFCHR 0020000
638#define S_IFIFO 0010000
639#define S_IFSOCK 0140000
640#ifdef stat
641#undef stat
642#endif
643#define stat(path, buf) git_stat(path, buf)
644extern int git_stat(const char *, struct stat *);
645#ifdef fstat
646#undef fstat
647#endif
648#define fstat(fd, buf) git_fstat(fd, buf)
649extern int git_fstat(int, struct stat *);
650#ifdef lstat
651#undef lstat
652#endif
653#define lstat(path, buf) git_lstat(path, buf)
654extern int git_lstat(const char *, struct stat *);
655#endif
656#define DEFAULT_PACKED_GIT_LIMIT \
658 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
659#ifdef NO_PREAD
661#define pread git_pread
662extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
663#endif
664/*
665 * Forward decl that will remind us if its twin in cache.h changes.
666 * This function is used in compat/pread.c. But we can't include
667 * cache.h there.
668 */
669extern ssize_t read_in_full(int fd, void *buf, size_t count);
670#ifdef NO_SETENV
672#define setenv gitsetenv
673extern int gitsetenv(const char *, const char *, int);
674#endif
675#ifdef NO_MKDTEMP
677#define mkdtemp gitmkdtemp
678extern char *gitmkdtemp(char *);
679#endif
680#ifdef NO_UNSETENV
682#define unsetenv gitunsetenv
683extern void gitunsetenv(const char *);
684#endif
685#ifdef NO_STRCASESTR
687#define strcasestr gitstrcasestr
688extern char *gitstrcasestr(const char *haystack, const char *needle);
689#endif
690#ifdef NO_STRLCPY
692#define strlcpy gitstrlcpy
693extern size_t gitstrlcpy(char *, const char *, size_t);
694#endif
695#ifdef NO_STRTOUMAX
697#define strtoumax gitstrtoumax
698extern uintmax_t gitstrtoumax(const char *, char **, int);
699#define strtoimax gitstrtoimax
700extern intmax_t gitstrtoimax(const char *, char **, int);
701#endif
702#ifdef NO_HSTRERROR
704#define hstrerror githstrerror
705extern const char *githstrerror(int herror);
706#endif
707#ifdef NO_MEMMEM
709#define memmem gitmemmem
710void *gitmemmem(const void *haystack, size_t haystacklen,
711 const void *needle, size_t needlelen);
712#endif
713#ifdef OVERRIDE_STRDUP
715#ifdef strdup
716#undef strdup
717#endif
718#define strdup gitstrdup
719char *gitstrdup(const char *s);
720#endif
721#ifdef NO_GETPAGESIZE
723#define getpagesize() sysconf(_SC_PAGESIZE)
724#endif
725#ifndef O_CLOEXEC
727#define O_CLOEXEC 0
728#endif
729#ifdef FREAD_READS_DIRECTORIES
731# if !defined(SUPPRESS_FOPEN_REDEFINITION)
732# ifdef fopen
733# undef fopen
734# endif
735# define fopen(a,b) git_fopen(a,b)
736# endif
737extern FILE *git_fopen(const char*, const char*);
738#endif
739#ifdef SNPRINTF_RETURNS_BOGUS
741#ifdef snprintf
742#undef snprintf
743#endif
744#define snprintf git_snprintf
745extern int git_snprintf(char *str, size_t maxsize,
746 const char *format, ...);
747#ifdef vsnprintf
748#undef vsnprintf
749#endif
750#define vsnprintf git_vsnprintf
751extern int git_vsnprintf(char *str, size_t maxsize,
752 const char *format, va_list ap);
753#endif
754#ifdef __GLIBC_PREREQ
756#if __GLIBC_PREREQ(2, 1)
757#define HAVE_STRCHRNUL
758#endif
759#endif
760#ifndef HAVE_STRCHRNUL
762#define strchrnul gitstrchrnul
763static inline char *gitstrchrnul(const char *s, int c)
764{
765 while (*s && *s != c)
766 s++;
767 return (char *)s;
768}
769#endif
770#ifdef NO_INET_PTON
772int inet_pton(int af, const char *src, void *dst);
773#endif
774#ifdef NO_INET_NTOP
776const char *inet_ntop(int af, const void *src, char *dst, size_t size);
777#endif
778#ifdef NO_PTHREADS
780#define atexit git_atexit
781extern int git_atexit(void (*handler)(void));
782#endif
783typedef void (*try_to_free_t)(size_t);
785extern try_to_free_t set_try_to_free_routine(try_to_free_t);
786static inline size_t st_add(size_t a, size_t b)
788{
789 if (unsigned_add_overflows(a, b))
790 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
791 (uintmax_t)a, (uintmax_t)b);
792 return a + b;
793}
794#define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
795#define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
796static inline size_t st_mult(size_t a, size_t b)
798{
799 if (unsigned_mult_overflows(a, b))
800 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
801 (uintmax_t)a, (uintmax_t)b);
802 return a * b;
803}
804static inline size_t st_sub(size_t a, size_t b)
806{
807 if (a < b)
808 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
809 (uintmax_t)a, (uintmax_t)b);
810 return a - b;
811}
812#ifdef HAVE_ALLOCA_H
814# include <alloca.h>
815# define xalloca(size) (alloca(size))
816# define xalloca_free(p) do {} while (0)
817#else
818# define xalloca(size) (xmalloc(size))
819# define xalloca_free(p) (free(p))
820#endif
821extern char *xstrdup(const char *str);
822extern void *xmalloc(size_t size);
823extern void *xmallocz(size_t size);
824extern void *xmallocz_gently(size_t size);
825extern void *xmemdupz(const void *data, size_t len);
826extern char *xstrndup(const char *str, size_t len);
827extern void *xrealloc(void *ptr, size_t size);
828extern void *xcalloc(size_t nmemb, size_t size);
829extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
830extern void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
831extern int xopen(const char *path, int flags, ...);
832extern ssize_t xread(int fd, void *buf, size_t len);
833extern ssize_t xwrite(int fd, const void *buf, size_t len);
834extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
835extern int xdup(int fd);
836extern FILE *xfopen(const char *path, const char *mode);
837extern FILE *xfdopen(int fd, const char *mode);
838extern int xmkstemp(char *temp_filename);
839extern int xmkstemp_mode(char *temp_filename, int mode);
840extern char *xgetcwd(void);
841extern FILE *fopen_for_writing(const char *path);
842extern FILE *fopen_or_warn(const char *path, const char *mode);
843/*
845 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
846 * that ptr is used twice, so don't pass e.g. ptr++.
847 */
848#define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
849#define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
851#define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
852#define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
854 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
855static inline void copy_array(void *dst, const void *src, size_t n, size_t size)
856{
857 if (n)
858 memcpy(dst, src, st_mult(size, n));
859}
860#define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
862 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
863static inline void move_array(void *dst, const void *src, size_t n, size_t size)
864{
865 if (n)
866 memmove(dst, src, st_mult(size, n));
867}
868/*
870 * These functions help you allocate structs with flex arrays, and copy
871 * the data directly into the array. For example, if you had:
872 *
873 * struct foo {
874 * int bar;
875 * char name[FLEX_ARRAY];
876 * };
877 *
878 * you can do:
879 *
880 * struct foo *f;
881 * FLEX_ALLOC_MEM(f, name, src, len);
882 *
883 * to allocate a "foo" with the contents of "src" in the "name" field.
884 * The resulting struct is automatically zero'd, and the flex-array field
885 * is NUL-terminated (whether the incoming src buffer was or not).
886 *
887 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
888 * but do want to store a pointer to some extra data in the same allocated
889 * block. For example, if you have:
890 *
891 * struct foo {
892 * char *name;
893 * int bar;
894 * };
895 *
896 * you can do:
897 *
898 * struct foo *f;
899 * FLEXPTR_ALLOC_STR(f, name, src);
900 *
901 * and "name" will point to a block of memory after the struct, which will be
902 * freed along with the struct (but the pointer can be repointed anywhere).
903 *
904 * The *_STR variants accept a string parameter rather than a ptr/len
905 * combination.
906 *
907 * Note that these macros will evaluate the first parameter multiple
908 * times, and it must be assignable as an lvalue.
909 */
910#define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
911 size_t flex_array_len_ = (len); \
912 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
913 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
914} while (0)
915#define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
916 size_t flex_array_len_ = (len); \
917 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
918 memcpy((x) + 1, (buf), flex_array_len_); \
919 (x)->ptrname = (void *)((x)+1); \
920} while(0)
921#define FLEX_ALLOC_STR(x, flexname, str) \
922 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
923#define FLEXPTR_ALLOC_STR(x, ptrname, str) \
924 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
925static inline char *xstrdup_or_null(const char *str)
927{
928 return str ? xstrdup(str) : NULL;
929}
930static inline size_t xsize_t(off_t len)
932{
933 size_t size = (size_t) len;
934 if (len != (off_t) size)
936 die("Cannot handle files this big");
937 return size;
938}
939__attribute__((format (printf, 3, 4)))
941extern int xsnprintf(char *dst, size_t max, const char *fmt, ...);
942#ifndef HOST_NAME_MAX
944#define HOST_NAME_MAX 256
945#endif
946extern int xgethostname(char *buf, size_t len);
948/* in ctype.c, for kwset users */
950extern const unsigned char tolower_trans_tbl[256];
951/* Sane ctype - no locale, and works with signed chars */
953#undef isascii
954#undef isspace
955#undef isdigit
956#undef isalpha
957#undef isalnum
958#undef isprint
959#undef islower
960#undef isupper
961#undef tolower
962#undef toupper
963#undef iscntrl
964#undef ispunct
965#undef isxdigit
966extern const unsigned char sane_ctype[256];
968#define GIT_SPACE 0x01
969#define GIT_DIGIT 0x02
970#define GIT_ALPHA 0x04
971#define GIT_GLOB_SPECIAL 0x08
972#define GIT_REGEX_SPECIAL 0x10
973#define GIT_PATHSPEC_MAGIC 0x20
974#define GIT_CNTRL 0x40
975#define GIT_PUNCT 0x80
976#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
977#define isascii(x) (((x) & ~0x7f) == 0)
978#define isspace(x) sane_istest(x,GIT_SPACE)
979#define isdigit(x) sane_istest(x,GIT_DIGIT)
980#define isalpha(x) sane_istest(x,GIT_ALPHA)
981#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
982#define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
983#define islower(x) sane_iscase(x, 1)
984#define isupper(x) sane_iscase(x, 0)
985#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
986#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
987#define iscntrl(x) (sane_istest(x,GIT_CNTRL))
988#define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
989 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
990#define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
991#define tolower(x) sane_case((unsigned char)(x), 0x20)
992#define toupper(x) sane_case((unsigned char)(x), 0)
993#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
994static inline int sane_case(int x, int high)
996{
997 if (sane_istest(x, GIT_ALPHA))
998 x = (x & ~0x20) | high;
999 return x;
1000}
1001static inline int sane_iscase(int x, int is_lower)
1003{
1004 if (!sane_istest(x, GIT_ALPHA))
1005 return 0;
1006 if (is_lower)
1008 return (x & 0x20) != 0;
1009 else
1010 return (x & 0x20) == 0;
1011}
1012/*
1014 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1015 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1016 * locale-specific conversions).
1017 */
1018static inline int skip_iprefix(const char *str, const char *prefix,
1019 const char **out)
1020{
1021 do {
1022 if (!*prefix) {
1023 *out = str;
1024 return 1;
1025 }
1026 } while (tolower(*str++) == tolower(*prefix++));
1027 return 0;
1028}
1029static inline int strtoul_ui(char const *s, int base, unsigned int *result)
1031{
1032 unsigned long ul;
1033 char *p;
1034 errno = 0;
1036 /* negative values would be accepted by strtoul */
1037 if (strchr(s, '-'))
1038 return -1;
1039 ul = strtoul(s, &p, base);
1040 if (errno || *p || p == s || (unsigned int) ul != ul)
1041 return -1;
1042 *result = ul;
1043 return 0;
1044}
1045static inline int strtol_i(char const *s, int base, int *result)
1047{
1048 long ul;
1049 char *p;
1050 errno = 0;
1052 ul = strtol(s, &p, base);
1053 if (errno || *p || p == s || (int) ul != ul)
1054 return -1;
1055 *result = ul;
1056 return 0;
1057}
1058#ifdef INTERNAL_QSORT
1060void git_qsort(void *base, size_t nmemb, size_t size,
1061 int(*compar)(const void *, const void *));
1062#define qsort git_qsort
1063#endif
1064#define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1066static inline void sane_qsort(void *base, size_t nmemb, size_t size,
1067 int(*compar)(const void *, const void *))
1068{
1069 if (nmemb > 1)
1070 qsort(base, nmemb, size, compar);
1071}
1072#ifndef HAVE_ISO_QSORT_S
1074int git_qsort_s(void *base, size_t nmemb, size_t size,
1075 int (*compar)(const void *, const void *, void *), void *ctx);
1076#define qsort_s git_qsort_s
1077#endif
1078#define QSORT_S(base, n, compar, ctx) do { \
1080 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1081 BUG("qsort_s() failed"); \
1082} while (0)
1083#ifndef REG_STARTEND
1085#error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1086#endif
1087static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size,
1089 size_t nmatch, regmatch_t pmatch[], int eflags)
1090{
1091 assert(nmatch > 0 && pmatch);
1092 pmatch[0].rm_so = 0;
1093 pmatch[0].rm_eo = size;
1094 return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND);
1095}
1096#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1098# define FORCE_DIR_SET_GID S_ISGID
1099#else
1100# define FORCE_DIR_SET_GID 0
1101#endif
1102#ifdef NO_NSEC
1104#undef USE_NSEC
1105#define ST_CTIME_NSEC(st) 0
1106#define ST_MTIME_NSEC(st) 0
1107#else
1108#ifdef USE_ST_TIMESPEC
1109#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1110#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1111#else
1112#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1113#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1114#endif
1115#endif
1116#ifdef UNRELIABLE_FSTAT
1118#define fstat_is_reliable() 0
1119#else
1120#define fstat_is_reliable() 1
1121#endif
1122#ifndef va_copy
1124/*
1125 * Since an obvious implementation of va_list would be to make it a
1126 * pointer into the stack frame, a simple assignment will work on
1127 * many systems. But let's try to be more portable.
1128 */
1129#ifdef __va_copy
1130#define va_copy(dst, src) __va_copy(dst, src)
1131#else
1132#define va_copy(dst, src) ((dst) = (src))
1133#endif
1134#endif
1135#if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
1137#define HAVE_VARIADIC_MACROS 1
1138#endif
1139/* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1141extern int BUG_exit_code;
1142#ifdef HAVE_VARIADIC_MACROS
1144__attribute__((format (printf, 3, 4))) NORETURN
1145void BUG_fl(const char *file, int line, const char *fmt, ...);
1146#define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1147#else
1148__attribute__((format (printf, 1, 2))) NORETURN
1149void BUG(const char *fmt, ...);
1150#endif
1151/*
1153 * Preserves errno, prints a message, but gives no warning for ENOENT.
1154 * Returns 0 on success, which includes trying to unlink an object that does
1155 * not exist.
1156 */
1157int unlink_or_warn(const char *path);
1158 /*
1159 * Tries to unlink file. Returns 0 if unlink succeeded
1160 * or the file already didn't exist. Returns -1 and
1161 * appends a message to err suitable for
1162 * 'error("%s", err->buf)' on error.
1163 */
1164int unlink_or_msg(const char *file, struct strbuf *err);
1165/*
1166 * Preserves errno, prints a message, but gives no warning for ENOENT.
1167 * Returns 0 on success, which includes trying to remove a directory that does
1168 * not exist.
1169 */
1170int rmdir_or_warn(const char *path);
1171/*
1172 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1173 * the supplied file mode.
1174 */
1175int remove_or_warn(unsigned int mode, const char *path);
1176/*
1178 * Call access(2), but warn for any error except "missing file"
1179 * (ENOENT or ENOTDIR).
1180 */
1181#define ACCESS_EACCES_OK (1U << 0)
1182int access_or_warn(const char *path, int mode, unsigned flag);
1183int access_or_die(const char *path, int mode, unsigned flag);
1184/* Warn on an inaccessible file if errno indicates this is an error */
1186int warn_on_fopen_errors(const char *path);
1187#ifdef GMTIME_UNRELIABLE_ERRORS
1189struct tm *git_gmtime(const time_t *);
1190struct tm *git_gmtime_r(const time_t *, struct tm *);
1191#define gmtime git_gmtime
1192#define gmtime_r git_gmtime_r
1193#endif
1194#if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
1196#define USE_PARENS_AROUND_GETTEXT_N 1
1197#endif
1198#ifndef SHELL_PATH
1200# define SHELL_PATH "/bin/sh"
1201#endif
1202#ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1204#define flockfile(fh)
1205#define funlockfile(fh)
1206#define getc_unlocked(fh) getc(fh)
1207#endif
1208/*
1210 * Our code often opens a path to an optional file, to work on its
1211 * contents when we can successfully open it. We can ignore a failure
1212 * to open if such an optional file does not exist, but we do want to
1213 * report a failure in opening for other reasons (e.g. we got an I/O
1214 * error, or the file is there, but we lack the permission to open).
1215 *
1216 * Call this function after seeing an error from open() or fopen() to
1217 * see if the errno indicates a missing file that we can safely ignore.
1218 */
1219static inline int is_missing_file_error(int errno_)
1220{
1221 return (errno_ == ENOENT || errno_ == ENOTDIR);
1222}
1223extern int cmd_main(int, const char **);
1225/*
1227 * You can mark a stack variable with UNLEAK(var) to avoid it being
1228 * reported as a leak by tools like LSAN or valgrind. The argument
1229 * should generally be the variable itself (not its address and not what
1230 * it points to). It's safe to use this on pointers which may already
1231 * have been freed, or on pointers which may still be in use.
1232 *
1233 * Use this _only_ for a variable that leaks by going out of scope at
1234 * program exit (so only from cmd_* functions or their direct helpers).
1235 * Normal functions, especially those which may be called multiple
1236 * times, should actually free their memory. This is only meant as
1237 * an annotation, and does nothing in non-leak-checking builds.
1238 */
1239#ifdef SUPPRESS_ANNOTATED_LEAKS
1240extern void unleak_memory(const void *ptr, size_t len);
1241#define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1242#else
1243#define UNLEAK(var) do {} while (0)
1244#endif
1245/*
1247 * This include must come after system headers, since it introduces macros that
1248 * replace system names.
1249 */
1250#include "banned.h"
1251#endif