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