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