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