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