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