]>
Commit | Line | Data |
---|---|---|
4050c0df JH |
1 | #ifndef GIT_COMPAT_UTIL_H |
2 | #define GIT_COMPAT_UTIL_H | |
3 | ||
7bc341e2 | 4 | #if __STDC_VERSION__ - 0 < 199901L |
5 | /* | |
6 | * Git is in a testing period for mandatory C99 support in the compiler. If | |
7 | * your compiler is reasonably recent, you can try to enable C99 support (or, | |
8 | * for MSVC, C11 support). If you encounter a problem and can't enable C99 | |
9 | * support with your compiler (such as with "-std=gnu99") and don't have access | |
10 | * to one with this support, such as GCC or Clang, you can remove this #if | |
11 | * directive, but please report the details of your system to | |
12 | * git@vger.kernel.org. | |
13 | */ | |
14 | #error "Required C99 support is in a test phase. Please see git-compat-util.h for more details." | |
15 | #endif | |
16 | ||
556702f8 JH |
17 | #ifdef USE_MSVC_CRTDBG |
18 | /* | |
19 | * For these to work they must appear very early in each | |
20 | * file -- before most of the standard header files. | |
21 | */ | |
22 | #include <stdlib.h> | |
23 | #include <crtdbg.h> | |
24 | #endif | |
25 | ||
17d3883f JS |
26 | struct strbuf; |
27 | ||
28 | ||
b97e9116 MW |
29 | #define _FILE_OFFSET_BITS 64 |
30 | ||
89c855ed EP |
31 | |
32 | /* Derived from Linux "Features Test Macro" header | |
33 | * Convenience macros to test the versions of gcc (or | |
34 | * a compatible compiler). | |
35 | * Use them like this: | |
36 | * #if GIT_GNUC_PREREQ (2,8) | |
37 | * ... code requiring gcc 2.8 or later ... | |
38 | * #endif | |
39 | */ | |
40 | #if defined(__GNUC__) && defined(__GNUC_MINOR__) | |
41 | # define GIT_GNUC_PREREQ(maj, min) \ | |
42 | ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min)) | |
43 | #else | |
44 | #define GIT_GNUC_PREREQ(maj, min) 0 | |
45 | #endif | |
46 | ||
47 | ||
8f1d2e6f | 48 | #ifndef FLEX_ARRAY |
8e973991 JH |
49 | /* |
50 | * See if our compiler is known to support flexible array members. | |
51 | */ | |
deefc2d9 JH |
52 | |
53 | /* | |
54 | * Check vendor specific quirks first, before checking the | |
55 | * __STDC_VERSION__, as vendor compilers can lie and we need to be | |
56 | * able to work them around. Note that by not defining FLEX_ARRAY | |
57 | * here, we can fall back to use the "safer but a bit wasteful" one | |
58 | * later. | |
59 | */ | |
60 | #if defined(__SUNPRO_C) && (__SUNPRO_C <= 0x580) | |
8e973991 JH |
61 | #elif defined(__GNUC__) |
62 | # if (__GNUC__ >= 3) | |
63 | # define FLEX_ARRAY /* empty */ | |
64 | # else | |
65 | # define FLEX_ARRAY 0 /* older GNU extension */ | |
66 | # endif | |
deefc2d9 JH |
67 | #elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) |
68 | # define FLEX_ARRAY /* empty */ | |
8e973991 JH |
69 | #endif |
70 | ||
71 | /* | |
72 | * Otherwise, default to safer but a bit wasteful traditional style | |
73 | */ | |
74 | #ifndef FLEX_ARRAY | |
75 | # define FLEX_ARRAY 1 | |
8f1d2e6f JH |
76 | #endif |
77 | #endif | |
78 | ||
89c855ed EP |
79 | |
80 | /* | |
81 | * BUILD_ASSERT_OR_ZERO - assert a build-time dependency, as an expression. | |
82 | * @cond: the compile-time condition which must be true. | |
83 | * | |
84 | * Your compile will fail if the condition isn't true, or can't be evaluated | |
85 | * by the compiler. This can be used in an expression: its value is "0". | |
86 | * | |
87 | * Example: | |
88 | * #define foo_to_char(foo) \ | |
89 | * ((char *)(foo) \ | |
90 | * + BUILD_ASSERT_OR_ZERO(offsetof(struct foo, string) == 0)) | |
91 | */ | |
92 | #define BUILD_ASSERT_OR_ZERO(cond) \ | |
93 | (sizeof(char [1 - 2*!(cond)]) - 1) | |
94 | ||
e2c6f7cd | 95 | #if GIT_GNUC_PREREQ(3, 1) |
89c855ed EP |
96 | /* &arr[0] degrades to a pointer: a different type from an array */ |
97 | # define BARF_UNLESS_AN_ARRAY(arr) \ | |
98 | BUILD_ASSERT_OR_ZERO(!__builtin_types_compatible_p(__typeof__(arr), \ | |
99 | __typeof__(&(arr)[0]))) | |
08e8c266 RS |
100 | # define BARF_UNLESS_COPYABLE(dst, src) \ |
101 | BUILD_ASSERT_OR_ZERO(__builtin_types_compatible_p(__typeof__(*(dst)), \ | |
102 | __typeof__(*(src)))) | |
e2c6f7cd CB |
103 | #else |
104 | # define BARF_UNLESS_AN_ARRAY(arr) 0 | |
08e8c266 RS |
105 | # define BARF_UNLESS_COPYABLE(dst, src) \ |
106 | BUILD_ASSERT_OR_ZERO(0 ? ((*(dst) = *(src)), 0) : \ | |
107 | sizeof(*(dst)) == sizeof(*(src))) | |
89c855ed EP |
108 | #endif |
109 | /* | |
110 | * ARRAY_SIZE - get the number of elements in a visible array | |
68b69211 | 111 | * @x: the array whose size you want. |
89c855ed EP |
112 | * |
113 | * This does not work on pointers, or arrays declared as [], or | |
114 | * function parameters. With correct compiler support, such usage | |
115 | * will cause a build error (see the build_assert_or_zero macro). | |
116 | */ | |
117 | #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x)) | |
118 | ||
f630cfda | 119 | #define bitsizeof(x) (CHAR_BIT * sizeof(x)) |
b4f2a6ac | 120 | |
c03c8315 EFL |
121 | #define maximum_signed_value_of_type(a) \ |
122 | (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a))) | |
123 | ||
1368f650 JN |
124 | #define maximum_unsigned_value_of_type(a) \ |
125 | (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a))) | |
126 | ||
c03c8315 EFL |
127 | /* |
128 | * Signed integer overflow is undefined in C, so here's a helper macro | |
129 | * to detect if the sum of two integers will overflow. | |
130 | * | |
131 | * Requires: a >= 0, typeof(a) equals typeof(b) | |
132 | */ | |
133 | #define signed_add_overflows(a, b) \ | |
134 | ((b) > maximum_signed_value_of_type(a) - (a)) | |
135 | ||
1368f650 JN |
136 | #define unsigned_add_overflows(a, b) \ |
137 | ((b) > maximum_unsigned_value_of_type(a) - (a)) | |
138 | ||
320d0b49 JK |
139 | /* |
140 | * Returns true if the multiplication of "a" and "b" will | |
141 | * overflow. The types of "a" and "b" must match and must be unsigned. | |
142 | * Note that this macro evaluates "a" twice! | |
143 | */ | |
144 | #define unsigned_mult_overflows(a, b) \ | |
145 | ((a) && (b) > maximum_unsigned_value_of_type(a) / (a)) | |
146 | ||
e2ffeae3 JS |
147 | /* |
148 | * Returns true if the left shift of "a" by "shift" bits will | |
149 | * overflow. The type of "a" must be unsigned. | |
150 | */ | |
151 | #define unsigned_left_shift_overflows(a, shift) \ | |
152 | ((shift) < bitsizeof(a) && \ | |
153 | (a) > maximum_unsigned_value_of_type(a) >> (shift)) | |
154 | ||
8723f216 NP |
155 | #ifdef __GNUC__ |
156 | #define TYPEOF(x) (__typeof__(x)) | |
157 | #else | |
158 | #define TYPEOF(x) | |
159 | #endif | |
160 | ||
f630cfda | 161 | #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits)))) |
db7244bd | 162 | #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */ |
8723f216 | 163 | |
98cb6f30 PH |
164 | #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d)) |
165 | ||
cf606e3d AW |
166 | /* Approximation of the length of the decimal representation of this type. */ |
167 | #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1) | |
168 | ||
9e12400d CMAB |
169 | #ifdef __MINGW64__ |
170 | #define _POSIX_C_SOURCE 1 | |
171 | #elif defined(__sun__) | |
4cb18a49 BC |
172 | /* |
173 | * On Solaris, when _XOPEN_EXTENDED is set, its header file | |
174 | * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE | |
175 | * setting to say we are XPG5 or XPG6. Also on Solaris, | |
176 | * XPG6 programs must be compiled with a c99 compiler, while | |
177 | * non XPG6 programs must be compiled with a pre-c99 compiler. | |
178 | */ | |
179 | # if __STDC_VERSION__ - 0 >= 199901L | |
180 | # define _XOPEN_SOURCE 600 | |
181 | # else | |
182 | # define _XOPEN_SOURCE 500 | |
183 | # endif | |
6555b196 | 184 | #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \ |
6c109904 | 185 | !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \ |
3a0a3a89 RJ |
186 | !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \ |
187 | !defined(__CYGWIN__) | |
85023577 JH |
188 | #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */ |
189 | #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */ | |
c902c9a6 | 190 | #endif |
fb952206 JR |
191 | #define _ALL_SOURCE 1 |
192 | #define _GNU_SOURCE 1 | |
193 | #define _BSD_SOURCE 1 | |
f978a99f | 194 | #define _DEFAULT_SOURCE 1 |
9a695fbf | 195 | #define _NETBSD_SOURCE 1 |
9398b859 | 196 | #define _SGI_SOURCE 1 |
85023577 | 197 | |
7c07f36a | 198 | #if GIT_GNUC_PREREQ(4, 5) |
9ff7eb8c ÆAB |
199 | #define UNUSED __attribute__((unused)) \ |
200 | __attribute__((deprecated ("parameter declared as UNUSED"))) | |
7c07f36a AS |
201 | #elif defined(__GNUC__) |
202 | #define UNUSED __attribute__((unused)) \ | |
203 | __attribute__((deprecated)) | |
9b240347 | 204 | #else |
5cf88fd8 | 205 | #define UNUSED |
9b240347 JK |
206 | #endif |
207 | ||
380395d0 | 208 | #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */ |
3571e78a | 209 | # if !defined(_WIN32_WINNT) |
2939a1f7 | 210 | # define _WIN32_WINNT 0x0600 |
41f29991 | 211 | # endif |
435bdf8c MSO |
212 | #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */ |
213 | #include <winsock2.h> | |
bb390b1f CMAB |
214 | #ifndef NO_UNIX_SOCKETS |
215 | #include <afunix.h> | |
216 | #endif | |
435bdf8c | 217 | #include <windows.h> |
380395d0 | 218 | #define GIT_WINDOWS_NATIVE |
435bdf8c MSO |
219 | #endif |
220 | ||
2406bf5f MA |
221 | #if defined(NO_UNIX_SOCKETS) || !defined(GIT_WINDOWS_NATIVE) |
222 | static inline int _have_unix_sockets(void) | |
223 | { | |
224 | #if defined(NO_UNIX_SOCKETS) | |
225 | return 0; | |
226 | #else | |
227 | return 1; | |
228 | #endif | |
229 | } | |
230 | #define have_unix_sockets _have_unix_sockets | |
231 | #endif | |
232 | ||
4050c0df JH |
233 | #include <unistd.h> |
234 | #include <stdio.h> | |
235 | #include <sys/stat.h> | |
236 | #include <fcntl.h> | |
237 | #include <stddef.h> | |
238 | #include <stdlib.h> | |
239 | #include <stdarg.h> | |
8277dbe9 | 240 | #include <stdbool.h> |
4050c0df | 241 | #include <string.h> |
b3e103da | 242 | #ifdef HAVE_STRINGS_H |
6c109904 JS |
243 | #include <strings.h> /* for strcasecmp() */ |
244 | #endif | |
4050c0df JH |
245 | #include <errno.h> |
246 | #include <limits.h> | |
1819ad32 | 247 | #include <locale.h> |
b2d05e06 | 248 | #ifdef NEEDS_SYS_PARAM_H |
4050c0df | 249 | #include <sys/param.h> |
6ede7205 | 250 | #endif |
4050c0df JH |
251 | #include <sys/types.h> |
252 | #include <dirent.h> | |
85023577 JH |
253 | #include <sys/time.h> |
254 | #include <time.h> | |
255 | #include <signal.h> | |
f4626df5 JS |
256 | #include <assert.h> |
257 | #include <regex.h> | |
258 | #include <utime.h> | |
088d8802 | 259 | #include <syslog.h> |
2648ccc2 ĐTCD |
260 | #if !defined(NO_POLL_H) |
261 | #include <poll.h> | |
262 | #elif !defined(NO_SYS_POLL_H) | |
fdc12114 | 263 | #include <sys/poll.h> |
2844923d | 264 | #else |
2648ccc2 | 265 | /* Pull the compat stuff */ |
2844923d MD |
266 | #include <poll.h> |
267 | #endif | |
9529080d KM |
268 | #ifdef HAVE_BSD_SYSCTL |
269 | #include <sys/sysctl.h> | |
270 | #endif | |
2f0aaaf9 | 271 | |
9fd512c8 ÆAB |
272 | /* Used by compat/win32/path-utils.h, and more */ |
273 | static inline int is_xplatform_dir_sep(int c) | |
274 | { | |
275 | return c == '/' || c == '\\'; | |
276 | } | |
277 | ||
496f2569 | 278 | #if defined(__CYGWIN__) |
1cadad6f | 279 | #include "compat/win32/path-utils.h" |
496f2569 | 280 | #endif |
cfc755d3 VR |
281 | #if defined(__MINGW32__) |
282 | /* pull in Windows compatibility stuff */ | |
1cadad6f | 283 | #include "compat/win32/path-utils.h" |
cfc755d3 VR |
284 | #include "compat/mingw.h" |
285 | #elif defined(_MSC_VER) | |
22c3634c | 286 | #include "compat/win32/path-utils.h" |
cfc755d3 VR |
287 | #include "compat/msvc.h" |
288 | #else | |
1e8fef60 | 289 | #include <sys/utsname.h> |
f4626df5 | 290 | #include <sys/wait.h> |
ebae9ff9 | 291 | #include <sys/resource.h> |
85023577 | 292 | #include <sys/socket.h> |
80bbe72b | 293 | #include <sys/ioctl.h> |
435a2535 | 294 | #include <sys/statvfs.h> |
eb80042c | 295 | #include <termios.h> |
2600973f | 296 | #ifndef NO_SYS_SELECT_H |
80bbe72b | 297 | #include <sys/select.h> |
2600973f | 298 | #endif |
85023577 JH |
299 | #include <netinet/in.h> |
300 | #include <netinet/tcp.h> | |
301 | #include <arpa/inet.h> | |
302 | #include <netdb.h> | |
303 | #include <pwd.h> | |
e2770979 | 304 | #include <sys/un.h> |
2844923d | 305 | #ifndef NO_INTTYPES_H |
007e2ba6 | 306 | #include <inttypes.h> |
2844923d MD |
307 | #else |
308 | #include <stdint.h> | |
309 | #endif | |
05cd988d | 310 | #ifdef HAVE_ARC4RANDOM_LIBBSD |
311 | #include <bsd/stdlib.h> | |
312 | #endif | |
313 | #ifdef HAVE_GETRANDOM | |
314 | #include <sys/random.h> | |
315 | #endif | |
6c109904 JS |
316 | #ifdef NO_INTPTR_T |
317 | /* | |
c70e1b04 | 318 | * On I16LP32, ILP32 and LP64 "long" is the safe bet, however |
6c109904 JS |
319 | * on LLP86, IL33LLP64 and P64 it needs to be "long long", |
320 | * while on IP16 and IP16L32 it is "int" (resp. "short") | |
321 | * Size needs to match (or exceed) 'sizeof(void *)'. | |
322 | * We can't take "long long" here as not everybody has it. | |
323 | */ | |
324 | typedef long intptr_t; | |
325 | typedef unsigned long uintptr_t; | |
326 | #endif | |
fb952206 | 327 | #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */ |
85023577 | 328 | #include <grp.h> |
fb952206 | 329 | #define _ALL_SOURCE 1 |
41b20017 | 330 | #endif |
85023577 | 331 | |
76759c7d TB |
332 | /* used on Mac OS X */ |
333 | #ifdef PRECOMPOSE_UNICODE | |
334 | #include "compat/precompose_utf8.h" | |
335 | #else | |
808e9195 JK |
336 | static inline const char *precompose_argv_prefix(int argc UNUSED, |
337 | const char **argv UNUSED, | |
338 | const char *prefix) | |
15b52a44 | 339 | { |
5c327502 | 340 | return prefix; |
15b52a44 | 341 | } |
5020774a TB |
342 | static inline const char *precompose_string_if_needed(const char *in) |
343 | { | |
344 | return in; | |
345 | } | |
346 | ||
fdf72966 | 347 | #define probe_utf8_pathname_composition() |
76759c7d TB |
348 | #endif |
349 | ||
0539ecfd JS |
350 | #ifdef MKDIR_WO_TRAILING_SLASH |
351 | #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b)) | |
55454427 | 352 | int compat_mkdir_wo_trailing_slash(const char*, mode_t); |
0539ecfd JS |
353 | #endif |
354 | ||
370ddcbc PE |
355 | #ifdef time |
356 | #undef time | |
357 | #endif | |
358 | static inline time_t git_time(time_t *tloc) | |
359 | { | |
360 | struct timeval tv; | |
361 | ||
362 | /* | |
363 | * Avoid time(NULL), which can disagree with gettimeofday(2) | |
364 | * and filesystem timestamps. | |
365 | */ | |
366 | gettimeofday(&tv, NULL); | |
367 | ||
368 | if (tloc) | |
369 | *tloc = tv.tv_sec; | |
370 | return tv.tv_sec; | |
371 | } | |
372 | #define time git_time | |
373 | ||
7f9e848c JS |
374 | #ifdef NO_STRUCT_ITIMERVAL |
375 | struct itimerval { | |
376 | struct timeval it_interval; | |
377 | struct timeval it_value; | |
981ff520 | 378 | }; |
7f9e848c JS |
379 | #endif |
380 | ||
381 | #ifdef NO_SETITIMER | |
efcc48ef JH |
382 | static inline int git_setitimer(int which UNUSED, |
383 | const struct itimerval *value UNUSED, | |
384 | struct itimerval *newvalue UNUSED) { | |
14639a47 | 385 | return 0; /* pretend success */ |
15b52a44 | 386 | } |
e1a95b78 | 387 | #undef setitimer |
e0c08a4f | 388 | #define setitimer(which,value,ovalue) git_setitimer(which,value,ovalue) |
7f9e848c JS |
389 | #endif |
390 | ||
e1c06886 DA |
391 | #ifndef NO_LIBGEN_H |
392 | #include <libgen.h> | |
393 | #else | |
394 | #define basename gitbasename | |
55454427 | 395 | char *gitbasename(char *); |
824682ab | 396 | #define dirname gitdirname |
55454427 | 397 | char *gitdirname(char *); |
e1c06886 DA |
398 | #endif |
399 | ||
85023577 JH |
400 | #ifndef NO_ICONV |
401 | #include <iconv.h> | |
402 | #endif | |
4050c0df | 403 | |
684ec6c6 | 404 | #ifndef NO_OPENSSL |
88c03eb5 | 405 | #ifdef __APPLE__ |
b195aa00 | 406 | #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0 |
88c03eb5 KM |
407 | #include <AvailabilityMacros.h> |
408 | #undef DEPRECATED_ATTRIBUTE | |
409 | #define DEPRECATED_ATTRIBUTE | |
410 | #undef __AVAILABILITY_MACROS_USES_AVAILABILITY | |
411 | #endif | |
684ec6c6 RS |
412 | #include <openssl/ssl.h> |
413 | #include <openssl/err.h> | |
414 | #endif | |
415 | ||
9806f5a7 NTND |
416 | #ifdef HAVE_SYSINFO |
417 | # include <sys/sysinfo.h> | |
418 | #endif | |
419 | ||
3b130ade DM |
420 | /* On most systems <netdb.h> would have given us this, but |
421 | * not on some systems (e.g. z/OS). | |
422 | */ | |
423 | #ifndef NI_MAXHOST | |
424 | #define NI_MAXHOST 1025 | |
425 | #endif | |
426 | ||
427 | #ifndef NI_MAXSERV | |
428 | #define NI_MAXSERV 32 | |
429 | #endif | |
430 | ||
d0c2449f JH |
431 | /* On most systems <limits.h> would have given us this, but |
432 | * not on some systems (e.g. GNU/Hurd). | |
433 | */ | |
434 | #ifndef PATH_MAX | |
435 | #define PATH_MAX 4096 | |
436 | #endif | |
437 | ||
7481d2bf MRP |
438 | #ifndef NAME_MAX |
439 | #define NAME_MAX 255 | |
440 | #endif | |
441 | ||
28f4aee3 JS |
442 | typedef uintmax_t timestamp_t; |
443 | #define PRItime PRIuMAX | |
444 | #define parse_timestamp strtoumax | |
445 | #define TIME_MAX UINTMAX_MAX | |
2e09c012 | 446 | #define TIME_MIN 0 |
1aeb7e75 | 447 | |
80ba074f JS |
448 | #ifndef PATH_SEP |
449 | #define PATH_SEP ':' | |
450 | #endif | |
451 | ||
cb6a22c0 CW |
452 | #ifdef HAVE_PATHS_H |
453 | #include <paths.h> | |
454 | #endif | |
455 | #ifndef _PATH_DEFPATH | |
456 | #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin" | |
457 | #endif | |
458 | ||
70fc5793 | 459 | #ifndef platform_core_config |
a4e7e317 | 460 | struct config_context; |
5cf88fd8 ÆAB |
461 | static inline int noop_core_config(const char *var UNUSED, |
462 | const char *value UNUSED, | |
a4e7e317 | 463 | const struct config_context *ctx UNUSED, |
5cf88fd8 | 464 | void *cb UNUSED) |
70fc5793 JS |
465 | { |
466 | return 0; | |
467 | } | |
468 | #define platform_core_config noop_core_config | |
469 | #endif | |
470 | ||
684dd4c2 MT |
471 | int lstat_cache_aware_rmdir(const char *path); |
472 | #if !defined(__MINGW32__) && !defined(_MSC_VER) | |
473 | #define rmdir lstat_cache_aware_rmdir | |
474 | #endif | |
475 | ||
25fe217b | 476 | #ifndef has_dos_drive_prefix |
808e9195 | 477 | static inline int git_has_dos_drive_prefix(const char *path UNUSED) |
bf728346 RS |
478 | { |
479 | return 0; | |
480 | } | |
481 | #define has_dos_drive_prefix git_has_dos_drive_prefix | |
25fe217b JS |
482 | #endif |
483 | ||
2f36eed9 | 484 | #ifndef skip_dos_drive_prefix |
808e9195 | 485 | static inline int git_skip_dos_drive_prefix(char **path UNUSED) |
2f36eed9 JS |
486 | { |
487 | return 0; | |
488 | } | |
489 | #define skip_dos_drive_prefix git_skip_dos_drive_prefix | |
490 | #endif | |
491 | ||
bf728346 RS |
492 | static inline int git_is_dir_sep(int c) |
493 | { | |
494 | return c == '/'; | |
495 | } | |
9fd512c8 | 496 | #ifndef is_dir_sep |
bf728346 | 497 | #define is_dir_sep git_is_dir_sep |
c2369bdf CZ |
498 | #endif |
499 | ||
bf728346 RS |
500 | #ifndef offset_1st_component |
501 | static inline int git_offset_1st_component(const char *path) | |
502 | { | |
503 | return is_dir_sep(path[0]); | |
504 | } | |
505 | #define offset_1st_component git_offset_1st_component | |
25fe217b JS |
506 | #endif |
507 | ||
d2c84dad JS |
508 | #ifndef is_valid_path |
509 | #define is_valid_path(path) 1 | |
510 | #endif | |
511 | ||
bdc77d1d | 512 | #ifndef is_path_owned_by_current_user |
ae9abbb6 CMAB |
513 | |
514 | #ifdef __TANDEM | |
515 | #define ROOT_UID 65535 | |
516 | #else | |
517 | #define ROOT_UID 0 | |
518 | #endif | |
519 | ||
520 | /* | |
521 | * Do not use this function when | |
522 | * (1) geteuid() did not say we are running as 'root', or | |
523 | * (2) using this function will compromise the system. | |
524 | * | |
525 | * PORTABILITY WARNING: | |
526 | * This code assumes uid_t is unsigned because that is what sudo does. | |
527 | * If your uid_t type is signed and all your ids are positive then it | |
528 | * should all work fine. | |
529 | * If your version of sudo uses negative values for uid_t or it is | |
530 | * buggy and return an overflowed value in SUDO_UID, then git might | |
531 | * fail to grant access to your repository properly or even mistakenly | |
532 | * grant access to someone else. | |
533 | * In the unlikely scenario this happened to you, and that is how you | |
534 | * got to this message, we would like to know about it; so sent us an | |
535 | * email to git@vger.kernel.org indicating which platform you are | |
536 | * using and which version of sudo, so we can improve this logic and | |
537 | * maybe provide you with a patch that would prevent this issue again | |
538 | * in the future. | |
539 | */ | |
540 | static inline void extract_id_from_env(const char *env, uid_t *id) | |
541 | { | |
542 | const char *real_uid = getenv(env); | |
543 | ||
544 | /* discard anything empty to avoid a more complex check below */ | |
545 | if (real_uid && *real_uid) { | |
546 | char *endptr = NULL; | |
547 | unsigned long env_id; | |
548 | ||
549 | errno = 0; | |
550 | /* silent overflow errors could trigger a bug here */ | |
551 | env_id = strtoul(real_uid, &endptr, 10); | |
552 | if (!*endptr && !errno) | |
553 | *id = env_id; | |
554 | } | |
555 | } | |
556 | ||
776515ef | 557 | static inline int is_path_owned_by_current_uid(const char *path, |
5cf88fd8 | 558 | struct strbuf *report UNUSED) |
bdc77d1d JS |
559 | { |
560 | struct stat st; | |
ae9abbb6 CMAB |
561 | uid_t euid; |
562 | ||
bdc77d1d JS |
563 | if (lstat(path, &st)) |
564 | return 0; | |
ae9abbb6 CMAB |
565 | |
566 | euid = geteuid(); | |
567 | if (euid == ROOT_UID) | |
6b11e3d5 CMAB |
568 | { |
569 | if (st.st_uid == ROOT_UID) | |
570 | return 1; | |
571 | else | |
572 | extract_id_from_env("SUDO_UID", &euid); | |
573 | } | |
ae9abbb6 CMAB |
574 | |
575 | return st.st_uid == euid; | |
bdc77d1d JS |
576 | } |
577 | ||
578 | #define is_path_owned_by_current_user is_path_owned_by_current_uid | |
579 | #endif | |
580 | ||
d1c69255 | 581 | #ifndef find_last_dir_sep |
bf728346 RS |
582 | static inline char *git_find_last_dir_sep(const char *path) |
583 | { | |
584 | return strrchr(path, '/'); | |
585 | } | |
586 | #define find_last_dir_sep git_find_last_dir_sep | |
d1c69255 TN |
587 | #endif |
588 | ||
05ac8582 AK |
589 | #ifndef has_dir_sep |
590 | static inline int git_has_dir_sep(const char *path) | |
591 | { | |
592 | return !!strchr(path, '/'); | |
593 | } | |
594 | #define has_dir_sep(path) git_has_dir_sep(path) | |
595 | #endif | |
596 | ||
501afcb8 JS |
597 | #ifndef query_user_email |
598 | #define query_user_email() NULL | |
599 | #endif | |
600 | ||
1305ef37 RB |
601 | #ifdef __TANDEM |
602 | #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)> | |
603 | #include <floss.h(floss_getpwuid)> | |
604 | #ifndef NSIG | |
605 | /* | |
606 | * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest | |
607 | * known, by detective work using kill -l as a list is all signals | |
608 | * instead of signal.h where it should be. | |
609 | */ | |
610 | # define NSIG 100 | |
611 | #endif | |
612 | #endif | |
613 | ||
e4ac953b | 614 | #if defined(__HP_cc) && (__HP_cc >= 61000) |
b6ab349b MR |
615 | #define NORETURN __attribute__((noreturn)) |
616 | #define NORETURN_PTR | |
6520c846 | 617 | #elif defined(__GNUC__) && !defined(NO_NORETURN) |
4050c0df | 618 | #define NORETURN __attribute__((__noreturn__)) |
18660bc9 | 619 | #define NORETURN_PTR __attribute__((__noreturn__)) |
aba7dea8 RJ |
620 | #elif defined(_MSC_VER) |
621 | #define NORETURN __declspec(noreturn) | |
622 | #define NORETURN_PTR | |
4050c0df JH |
623 | #else |
624 | #define NORETURN | |
18660bc9 | 625 | #define NORETURN_PTR |
8cd7ebc8 | 626 | #ifndef __GNUC__ |
4050c0df JH |
627 | #ifndef __attribute__ |
628 | #define __attribute__(x) | |
629 | #endif | |
630 | #endif | |
8cd7ebc8 | 631 | #endif |
4050c0df | 632 | |
9fe3edc4 RJ |
633 | /* The sentinel attribute is valid from gcc version 4.0 */ |
634 | #if defined(__GNUC__) && (__GNUC__ >= 4) | |
635 | #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel)) | |
1e8697b5 ÆAB |
636 | /* warn_unused_result exists as of gcc 3.4.0, but be lazy and check 4.0 */ |
637 | #define RESULT_MUST_BE_USED __attribute__ ((warn_unused_result)) | |
9fe3edc4 RJ |
638 | #else |
639 | #define LAST_ARG_MUST_BE_NULL | |
1e8697b5 | 640 | #define RESULT_MUST_BE_USED |
9fe3edc4 RJ |
641 | #endif |
642 | ||
bbd8eb3e CMAB |
643 | #define MAYBE_UNUSED __attribute__((__unused__)) |
644 | ||
51ea5519 NP |
645 | #include "compat/bswap.h" |
646 | ||
382f6940 | 647 | #include "wrapper.h" |
9ccc0c08 | 648 | |
4050c0df | 649 | /* General helper functions */ |
55454427 | 650 | NORETURN void usage(const char *err); |
b199d714 DL |
651 | NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2))); |
652 | NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
653 | NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
18568ee8 | 654 | int die_message(const char *err, ...) __attribute__((format (printf, 1, 2))); |
24f6e6d6 | 655 | int die_message_errno(const char *err, ...) __attribute__((format (printf, 1, 2))); |
b199d714 DL |
656 | int error(const char *err, ...) __attribute__((format (printf, 1, 2))); |
657 | int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
658 | void warning(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
659 | void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
4050c0df | 660 | |
f2be034c BG |
661 | #ifndef NO_OPENSSL |
662 | #ifdef APPLE_COMMON_CRYPTO | |
663 | #include "compat/apple-common-crypto.h" | |
664 | #else | |
665 | #include <openssl/evp.h> | |
666 | #include <openssl/hmac.h> | |
667 | #endif /* APPLE_COMMON_CRYPTO */ | |
668 | #include <openssl/x509v3.h> | |
669 | #endif /* NO_OPENSSL */ | |
670 | ||
5b52d9f1 CMAB |
671 | #ifdef HAVE_OPENSSL_CSPRNG |
672 | #include <openssl/rand.h> | |
673 | #endif | |
674 | ||
e208f9cc JK |
675 | /* |
676 | * Let callers be aware of the constant return value; this can help | |
9798f7e5 | 677 | * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though, |
b7ba8587 | 678 | * because other compilers may be confused by this. |
e208f9cc | 679 | */ |
ff0a80af | 680 | #if defined(__GNUC__) |
87fe5df3 JK |
681 | static inline int const_error(void) |
682 | { | |
683 | return -1; | |
684 | } | |
685 | #define error(...) (error(__VA_ARGS__), const_error()) | |
4df5e918 | 686 | #define error_errno(...) (error_errno(__VA_ARGS__), const_error()) |
e208f9cc JK |
687 | #endif |
688 | ||
5710dcce JK |
689 | typedef void (*report_fn)(const char *, va_list params); |
690 | ||
691 | void set_die_routine(NORETURN_PTR report_fn routine); | |
18568ee8 | 692 | report_fn get_die_message_routine(void); |
5710dcce JK |
693 | void set_error_routine(report_fn routine); |
694 | report_fn get_error_routine(void); | |
695 | void set_warn_routine(report_fn routine); | |
696 | report_fn get_warn_routine(void); | |
55454427 | 697 | void set_die_is_recursing_routine(int (*routine)(void)); |
39a3f5ea | 698 | |
cf4fff57 | 699 | /* |
8277dbe9 | 700 | * If the string "str" begins with the string found in "prefix", return true. |
cf4fff57 JK |
701 | * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in |
702 | * the string right after the prefix). | |
703 | * | |
8277dbe9 | 704 | * Otherwise, return false and leave "out" untouched. |
cf4fff57 JK |
705 | * |
706 | * Examples: | |
707 | * | |
708 | * [extract branch name, fail if not a branch] | |
709 | * if (!skip_prefix(ref, "refs/heads/", &branch) | |
710 | * return -1; | |
711 | * | |
712 | * [skip prefix if present, otherwise use whole string] | |
713 | * skip_prefix(name, "refs/heads/", &name); | |
714 | */ | |
8277dbe9 RS |
715 | static inline bool skip_prefix(const char *str, const char *prefix, |
716 | const char **out) | |
fbca5837 | 717 | { |
ba399c46 | 718 | do { |
cf4fff57 JK |
719 | if (!*prefix) { |
720 | *out = str; | |
8277dbe9 | 721 | return true; |
cf4fff57 | 722 | } |
ba399c46 | 723 | } while (*str++ == *prefix++); |
8277dbe9 | 724 | return false; |
fbca5837 MV |
725 | } |
726 | ||
ae989a61 JK |
727 | /* |
728 | * Like skip_prefix, but promises never to read past "len" bytes of the input | |
729 | * buffer, and returns the remaining number of bytes in "out" via "outlen". | |
730 | */ | |
8277dbe9 RS |
731 | static inline bool skip_prefix_mem(const char *buf, size_t len, |
732 | const char *prefix, | |
733 | const char **out, size_t *outlen) | |
ae989a61 JK |
734 | { |
735 | size_t prefix_len = strlen(prefix); | |
736 | if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) { | |
737 | *out = buf + prefix_len; | |
738 | *outlen = len - prefix_len; | |
8277dbe9 | 739 | return true; |
ae989a61 | 740 | } |
8277dbe9 | 741 | return false; |
ae989a61 JK |
742 | } |
743 | ||
35480f0b | 744 | /* |
8277dbe9 RS |
745 | * If buf ends with suffix, return true and subtract the length of the suffix |
746 | * from *len. Otherwise, return false and leave *len untouched. | |
35480f0b | 747 | */ |
8277dbe9 RS |
748 | static inline bool strip_suffix_mem(const char *buf, size_t *len, |
749 | const char *suffix) | |
35480f0b JK |
750 | { |
751 | size_t suflen = strlen(suffix); | |
752 | if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen)) | |
8277dbe9 | 753 | return false; |
35480f0b | 754 | *len -= suflen; |
8277dbe9 | 755 | return true; |
35480f0b JK |
756 | } |
757 | ||
758 | /* | |
8277dbe9 RS |
759 | * If str ends with suffix, return true and set *len to the size of the string |
760 | * without the suffix. Otherwise, return false and set *len to the size of the | |
35480f0b JK |
761 | * string. |
762 | * | |
763 | * Note that we do _not_ NUL-terminate str to the new length. | |
764 | */ | |
8277dbe9 RS |
765 | static inline bool strip_suffix(const char *str, const char *suffix, |
766 | size_t *len) | |
35480f0b JK |
767 | { |
768 | *len = strlen(str); | |
769 | return strip_suffix_mem(str, len, suffix); | |
770 | } | |
771 | ||
568edcb9 RS |
772 | #define SWAP(a, b) do { \ |
773 | void *_swap_a_ptr = &(a); \ | |
774 | void *_swap_b_ptr = &(b); \ | |
775 | unsigned char _swap_buffer[sizeof(a)]; \ | |
776 | memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \ | |
777 | memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \ | |
778 | BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \ | |
779 | memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \ | |
780 | } while (0) | |
781 | ||
b130a72b | 782 | #if defined(NO_MMAP) || defined(USE_WIN32_MMAP) |
4050c0df JH |
783 | |
784 | #ifndef PROT_READ | |
785 | #define PROT_READ 1 | |
786 | #define PROT_WRITE 2 | |
787 | #define MAP_PRIVATE 1 | |
4050c0df JH |
788 | #endif |
789 | ||
d6779124 SP |
790 | #define mmap git_mmap |
791 | #define munmap git_munmap | |
55454427 DL |
792 | void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset); |
793 | int git_munmap(void *start, size_t length); | |
4050c0df | 794 | |
b130a72b JL |
795 | #else /* NO_MMAP || USE_WIN32_MMAP */ |
796 | ||
797 | #include <sys/mman.h> | |
798 | ||
799 | #endif /* NO_MMAP || USE_WIN32_MMAP */ | |
800 | ||
801 | #ifdef NO_MMAP | |
802 | ||
5faaf246 | 803 | /* This value must be multiple of (pagesize * 2) */ |
8c82534d SP |
804 | #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024) |
805 | ||
4050c0df JH |
806 | #else /* NO_MMAP */ |
807 | ||
5faaf246 | 808 | /* This value must be multiple of (pagesize * 2) */ |
22bac0ea SP |
809 | #define DEFAULT_PACKED_GIT_WINDOW_SIZE \ |
810 | (sizeof(void*) >= 8 \ | |
811 | ? 1 * 1024 * 1024 * 1024 \ | |
812 | : 32 * 1024 * 1024) | |
4050c0df JH |
813 | |
814 | #endif /* NO_MMAP */ | |
815 | ||
fcf3a21a GV |
816 | #ifndef MAP_FAILED |
817 | #define MAP_FAILED ((void *)-1) | |
818 | #endif | |
819 | ||
fdb2a2a6 JH |
820 | #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT |
821 | #define on_disk_bytes(st) ((st).st_size) | |
822 | #else | |
823 | #define on_disk_bytes(st) ((st).st_blocks * 512) | |
824 | #endif | |
825 | ||
d543d9c0 DM |
826 | #ifdef NEEDS_MODE_TRANSLATION |
827 | #undef S_IFMT | |
828 | #undef S_IFREG | |
829 | #undef S_IFDIR | |
830 | #undef S_IFLNK | |
831 | #undef S_IFBLK | |
832 | #undef S_IFCHR | |
833 | #undef S_IFIFO | |
834 | #undef S_IFSOCK | |
835 | #define S_IFMT 0170000 | |
836 | #define S_IFREG 0100000 | |
837 | #define S_IFDIR 0040000 | |
838 | #define S_IFLNK 0120000 | |
839 | #define S_IFBLK 0060000 | |
840 | #define S_IFCHR 0020000 | |
841 | #define S_IFIFO 0010000 | |
842 | #define S_IFSOCK 0140000 | |
843 | #ifdef stat | |
844 | #undef stat | |
845 | #endif | |
846 | #define stat(path, buf) git_stat(path, buf) | |
55454427 | 847 | int git_stat(const char *, struct stat *); |
d543d9c0 DM |
848 | #ifdef fstat |
849 | #undef fstat | |
850 | #endif | |
851 | #define fstat(fd, buf) git_fstat(fd, buf) | |
55454427 | 852 | int git_fstat(int, struct stat *); |
d543d9c0 DM |
853 | #ifdef lstat |
854 | #undef lstat | |
855 | #endif | |
856 | #define lstat(path, buf) git_lstat(path, buf) | |
55454427 | 857 | int git_lstat(const char *, struct stat *); |
d543d9c0 DM |
858 | #endif |
859 | ||
22bac0ea | 860 | #define DEFAULT_PACKED_GIT_LIMIT \ |
be4ca290 | 861 | ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256)) |
8c82534d | 862 | |
6900679c SH |
863 | #ifdef NO_PREAD |
864 | #define pread git_pread | |
55454427 | 865 | ssize_t git_pread(int fd, void *buf, size_t count, off_t offset); |
6900679c SH |
866 | #endif |
867 | ||
4050c0df JH |
868 | #ifdef NO_SETENV |
869 | #define setenv gitsetenv | |
55454427 | 870 | int gitsetenv(const char *, const char *, int); |
4050c0df JH |
871 | #endif |
872 | ||
ca5bb5d5 SP |
873 | #ifdef NO_MKDTEMP |
874 | #define mkdtemp gitmkdtemp | |
55454427 | 875 | char *gitmkdtemp(char *); |
ca5bb5d5 | 876 | #endif |
0620b39b | 877 | |
731043fd JR |
878 | #ifdef NO_UNSETENV |
879 | #define unsetenv gitunsetenv | |
a38989bd | 880 | int gitunsetenv(const char *); |
731043fd JR |
881 | #endif |
882 | ||
4050c0df JH |
883 | #ifdef NO_STRCASESTR |
884 | #define strcasestr gitstrcasestr | |
55454427 | 885 | char *gitstrcasestr(const char *haystack, const char *needle); |
4050c0df JH |
886 | #endif |
887 | ||
817151e6 PE |
888 | #ifdef NO_STRLCPY |
889 | #define strlcpy gitstrlcpy | |
55454427 | 890 | size_t gitstrlcpy(char *, const char *, size_t); |
817151e6 PE |
891 | #endif |
892 | ||
bc6b4f52 JR |
893 | #ifdef NO_STRTOUMAX |
894 | #define strtoumax gitstrtoumax | |
55454427 | 895 | uintmax_t gitstrtoumax(const char *, char **, int); |
97000ba6 | 896 | #define strtoimax gitstrtoimax |
55454427 | 897 | intmax_t gitstrtoimax(const char *, char **, int); |
bc6b4f52 JR |
898 | #endif |
899 | ||
fa0c87c3 AR |
900 | #ifdef NO_HSTRERROR |
901 | #define hstrerror githstrerror | |
55454427 | 902 | const char *githstrerror(int herror); |
fa0c87c3 AR |
903 | #endif |
904 | ||
b21b9f1d RS |
905 | #ifdef NO_MEMMEM |
906 | #define memmem gitmemmem | |
907 | void *gitmemmem(const void *haystack, size_t haystacklen, | |
ec36c42a | 908 | const void *needle, size_t needlelen); |
b21b9f1d RS |
909 | #endif |
910 | ||
ca2baa3f RS |
911 | #ifdef OVERRIDE_STRDUP |
912 | #ifdef strdup | |
913 | #undef strdup | |
914 | #endif | |
915 | #define strdup gitstrdup | |
916 | char *gitstrdup(const char *s); | |
917 | #endif | |
b21b9f1d | 918 | |
40036bed MK |
919 | #ifdef NO_GETPAGESIZE |
920 | #define getpagesize() sysconf(_SC_PAGESIZE) | |
921 | #endif | |
922 | ||
05d1ed61 BW |
923 | #ifndef O_CLOEXEC |
924 | #define O_CLOEXEC 0 | |
925 | #endif | |
926 | ||
cba22528 | 927 | #ifdef FREAD_READS_DIRECTORIES |
b0a642ac RJ |
928 | # if !defined(SUPPRESS_FOPEN_REDEFINITION) |
929 | # ifdef fopen | |
930 | # undef fopen | |
931 | # endif | |
932 | # define fopen(a,b) git_fopen(a,b) | |
933 | # endif | |
55454427 | 934 | FILE *git_fopen(const char*, const char*); |
cba22528 BC |
935 | #endif |
936 | ||
c4582f93 | 937 | #ifdef SNPRINTF_RETURNS_BOGUS |
ab03803c BS |
938 | #ifdef snprintf |
939 | #undef snprintf | |
940 | #endif | |
c4582f93 | 941 | #define snprintf git_snprintf |
b199d714 | 942 | int git_snprintf(char *str, size_t maxsize, |
ad6dad09 | 943 | const char *format, ...); |
ab03803c BS |
944 | #ifdef vsnprintf |
945 | #undef vsnprintf | |
946 | #endif | |
c4582f93 | 947 | #define vsnprintf git_vsnprintf |
55454427 | 948 | int git_vsnprintf(char *str, size_t maxsize, |
ad6dad09 | 949 | const char *format, va_list ap); |
c4582f93 MR |
950 | #endif |
951 | ||
2b081012 JK |
952 | #ifdef OPEN_RETURNS_EINTR |
953 | #undef open | |
954 | #define open git_open_with_retry | |
955 | int git_open_with_retry(const char *path, int flag, ...); | |
956 | #endif | |
957 | ||
726c8ef5 JS |
958 | #ifdef __GLIBC_PREREQ |
959 | #if __GLIBC_PREREQ(2, 1) | |
960 | #define HAVE_STRCHRNUL | |
961 | #endif | |
962 | #endif | |
963 | ||
964 | #ifndef HAVE_STRCHRNUL | |
659c69cf | 965 | #define strchrnul gitstrchrnul |
9e79f00f AE |
966 | static inline char *gitstrchrnul(const char *s, int c) |
967 | { | |
968 | while (*s && *s != c) | |
969 | s++; | |
970 | return (char *)s; | |
971 | } | |
659c69cf RS |
972 | #endif |
973 | ||
da523cc5 MP |
974 | #ifdef NO_INET_PTON |
975 | int inet_pton(int af, const char *src, void *dst); | |
976 | #endif | |
977 | ||
978 | #ifdef NO_INET_NTOP | |
979 | const char *inet_ntop(int af, const void *src, char *dst, size_t size); | |
980 | #endif | |
981 | ||
0f4b6db3 EB |
982 | #ifdef NO_PTHREADS |
983 | #define atexit git_atexit | |
55454427 | 984 | int git_atexit(void (*handler)(void)); |
0f4b6db3 EB |
985 | #endif |
986 | ||
320d0b49 JK |
987 | static inline size_t st_add(size_t a, size_t b) |
988 | { | |
989 | if (unsigned_add_overflows(a, b)) | |
990 | die("size_t overflow: %"PRIuMAX" + %"PRIuMAX, | |
991 | (uintmax_t)a, (uintmax_t)b); | |
992 | return a + b; | |
993 | } | |
d616fbf2 ES |
994 | #define st_add3(a,b,c) st_add(st_add((a),(b)),(c)) |
995 | #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d)) | |
320d0b49 JK |
996 | |
997 | static inline size_t st_mult(size_t a, size_t b) | |
998 | { | |
999 | if (unsigned_mult_overflows(a, b)) | |
1000 | die("size_t overflow: %"PRIuMAX" * %"PRIuMAX, | |
1001 | (uintmax_t)a, (uintmax_t)b); | |
1002 | return a * b; | |
1003 | } | |
1004 | ||
1005 | static inline size_t st_sub(size_t a, size_t b) | |
1006 | { | |
1007 | if (a < b) | |
1008 | die("size_t underflow: %"PRIuMAX" - %"PRIuMAX, | |
1009 | (uintmax_t)a, (uintmax_t)b); | |
1010 | return a - b; | |
1011 | } | |
a9a74636 | 1012 | |
e2ffeae3 JS |
1013 | static inline size_t st_left_shift(size_t a, unsigned shift) |
1014 | { | |
1015 | if (unsigned_left_shift_overflows(a, shift)) | |
1016 | die("size_t overflow: %"PRIuMAX" << %u", | |
1017 | (uintmax_t)a, shift); | |
1018 | return a << shift; | |
1019 | } | |
1020 | ||
1021 | static inline unsigned long cast_size_t_to_ulong(size_t a) | |
1022 | { | |
1023 | if (a != (unsigned long)a) | |
1024 | die("object too large to read on this platform: %" | |
1025 | PRIuMAX" is cut off to %lu", | |
1026 | (uintmax_t)a, (unsigned long)a); | |
1027 | return (unsigned long)a; | |
1028 | } | |
1029 | ||
ed9f4148 TB |
1030 | static inline uint32_t cast_size_t_to_uint32_t(size_t a) |
1031 | { | |
1032 | if (a != (uint32_t)a) | |
1033 | die("object too large to read on this platform: %" | |
1034 | PRIuMAX" is cut off to %u", | |
1035 | (uintmax_t)a, (uint32_t)a); | |
1036 | return (uint32_t)a; | |
1037 | } | |
1038 | ||
48050c42 PS |
1039 | static inline int cast_size_t_to_int(size_t a) |
1040 | { | |
1041 | if (a > INT_MAX) | |
1042 | die("number too large to represent as int on this platform: %"PRIuMAX, | |
1043 | (uintmax_t)a); | |
1044 | return (int)a; | |
1045 | } | |
1046 | ||
ec4f39b2 JK |
1047 | /* |
1048 | * Limit size of IO chunks, because huge chunks only cause pain. OS X | |
1049 | * 64-bit is buggy, returning EINVAL if len >= INT_MAX; and even in | |
1050 | * the absence of bugs, large chunks can result in bad latencies when | |
1051 | * you decide to kill the process. | |
1052 | * | |
1053 | * We pick 8 MiB as our default, but if the platform defines SSIZE_MAX | |
1054 | * that is smaller than that, clip it to SSIZE_MAX, as a call to | |
1055 | * read(2) or write(2) larger than that is allowed to fail. As the last | |
1056 | * resort, we allow a port to pass via CFLAGS e.g. "-DMAX_IO_SIZE=value" | |
1057 | * to override this, if the definition of SSIZE_MAX given by the platform | |
1058 | * is broken. | |
1059 | */ | |
1060 | #ifndef MAX_IO_SIZE | |
1061 | # define MAX_IO_SIZE_DEFAULT (8*1024*1024) | |
1062 | # if defined(SSIZE_MAX) && (SSIZE_MAX < MAX_IO_SIZE_DEFAULT) | |
1063 | # define MAX_IO_SIZE SSIZE_MAX | |
1064 | # else | |
1065 | # define MAX_IO_SIZE MAX_IO_SIZE_DEFAULT | |
1066 | # endif | |
1067 | #endif | |
1068 | ||
61f76a36 KS |
1069 | #ifdef HAVE_ALLOCA_H |
1070 | # include <alloca.h> | |
1071 | # define xalloca(size) (alloca(size)) | |
1072 | # define xalloca_free(p) do {} while (0) | |
1073 | #else | |
1074 | # define xalloca(size) (xmalloc(size)) | |
1075 | # define xalloca_free(p) (free(p)) | |
1076 | #endif | |
14570dc6 | 1077 | |
481df65f ÆAB |
1078 | /* |
1079 | * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note | |
1080 | * that ptr is used twice, so don't pass e.g. ptr++. | |
1081 | */ | |
1082 | #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0) | |
1083 | ||
e7792a74 | 1084 | #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc))) |
f1121499 | 1085 | #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x))) |
e7792a74 | 1086 | #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc))) |
3ac22f82 | 1087 | |
60566cbb | 1088 | #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \ |
1891846f | 1089 | BARF_UNLESS_COPYABLE((dst), (src))) |
60566cbb RS |
1090 | static inline void copy_array(void *dst, const void *src, size_t n, size_t size) |
1091 | { | |
1092 | if (n) | |
1093 | memcpy(dst, src, st_mult(size, n)); | |
1094 | } | |
1095 | ||
57839807 | 1096 | #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \ |
1891846f | 1097 | BARF_UNLESS_COPYABLE((dst), (src))) |
57839807 RS |
1098 | static inline void move_array(void *dst, const void *src, size_t n, size_t size) |
1099 | { | |
1100 | if (n) | |
1101 | memmove(dst, src, st_mult(size, n)); | |
1102 | } | |
1103 | ||
d2ec87a6 RS |
1104 | #define DUP_ARRAY(dst, src, n) do { \ |
1105 | size_t dup_array_n_ = (n); \ | |
1106 | COPY_ARRAY(ALLOC_ARRAY((dst), dup_array_n_), (src), dup_array_n_); \ | |
1107 | } while (0) | |
1108 | ||
36895391 JK |
1109 | /* |
1110 | * These functions help you allocate structs with flex arrays, and copy | |
1111 | * the data directly into the array. For example, if you had: | |
1112 | * | |
1113 | * struct foo { | |
1114 | * int bar; | |
1115 | * char name[FLEX_ARRAY]; | |
1116 | * }; | |
1117 | * | |
1118 | * you can do: | |
1119 | * | |
1120 | * struct foo *f; | |
1121 | * FLEX_ALLOC_MEM(f, name, src, len); | |
1122 | * | |
1123 | * to allocate a "foo" with the contents of "src" in the "name" field. | |
1124 | * The resulting struct is automatically zero'd, and the flex-array field | |
1125 | * is NUL-terminated (whether the incoming src buffer was or not). | |
1126 | * | |
1127 | * The FLEXPTR_* variants operate on structs that don't use flex-arrays, | |
1128 | * but do want to store a pointer to some extra data in the same allocated | |
1129 | * block. For example, if you have: | |
1130 | * | |
1131 | * struct foo { | |
1132 | * char *name; | |
1133 | * int bar; | |
1134 | * }; | |
1135 | * | |
1136 | * you can do: | |
1137 | * | |
1138 | * struct foo *f; | |
0bb1519f | 1139 | * FLEXPTR_ALLOC_STR(f, name, src); |
36895391 JK |
1140 | * |
1141 | * and "name" will point to a block of memory after the struct, which will be | |
1142 | * freed along with the struct (but the pointer can be repointed anywhere). | |
1143 | * | |
1144 | * The *_STR variants accept a string parameter rather than a ptr/len | |
1145 | * combination. | |
1146 | * | |
1147 | * Note that these macros will evaluate the first parameter multiple | |
1148 | * times, and it must be assignable as an lvalue. | |
1149 | */ | |
1150 | #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \ | |
e9451782 RS |
1151 | size_t flex_array_len_ = (len); \ |
1152 | (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \ | |
1153 | memcpy((void *)(x)->flexname, (buf), flex_array_len_); \ | |
36895391 JK |
1154 | } while (0) |
1155 | #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \ | |
0ac52a38 RS |
1156 | size_t flex_array_len_ = (len); \ |
1157 | (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \ | |
1158 | memcpy((x) + 1, (buf), flex_array_len_); \ | |
36895391 JK |
1159 | (x)->ptrname = (void *)((x)+1); \ |
1160 | } while(0) | |
1161 | #define FLEX_ALLOC_STR(x, flexname, str) \ | |
1162 | FLEX_ALLOC_MEM((x), flexname, (str), strlen(str)) | |
1163 | #define FLEXPTR_ALLOC_STR(x, ptrname, str) \ | |
1164 | FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str)) | |
1165 | ||
91c080df CW |
1166 | #define alloc_nr(x) (((x)+16)*3/2) |
1167 | ||
1168 | /** | |
1169 | * Dynamically growing an array using realloc() is error prone and boring. | |
1170 | * | |
1171 | * Define your array with: | |
1172 | * | |
1173 | * - a pointer (`item`) that points at the array, initialized to `NULL` | |
1174 | * (although please name the variable based on its contents, not on its | |
1175 | * type); | |
1176 | * | |
1177 | * - an integer variable (`alloc`) that keeps track of how big the current | |
1178 | * allocation is, initialized to `0`; | |
1179 | * | |
1180 | * - another integer variable (`nr`) to keep track of how many elements the | |
1181 | * array currently has, initialized to `0`. | |
1182 | * | |
1183 | * Then before adding `n`th element to the item, call `ALLOC_GROW(item, n, | |
1184 | * alloc)`. This ensures that the array can hold at least `n` elements by | |
1185 | * calling `realloc(3)` and adjusting `alloc` variable. | |
1186 | * | |
1187 | * ------------ | |
1188 | * sometype *item; | |
1189 | * size_t nr; | |
1190 | * size_t alloc | |
1191 | * | |
1192 | * for (i = 0; i < nr; i++) | |
1193 | * if (we like item[i] already) | |
1194 | * return; | |
1195 | * | |
1196 | * // we did not like any existing one, so add one | |
1197 | * ALLOC_GROW(item, nr + 1, alloc); | |
1198 | * item[nr++] = value you like; | |
1199 | * ------------ | |
1200 | * | |
1201 | * You are responsible for updating the `nr` variable. | |
1202 | * | |
1203 | * If you need to specify the number of elements to allocate explicitly | |
1204 | * then use the macro `REALLOC_ARRAY(item, alloc)` instead of `ALLOC_GROW`. | |
1205 | * | |
1206 | * Consider using ALLOC_GROW_BY instead of ALLOC_GROW as it has some | |
1207 | * added niceties. | |
1208 | * | |
1209 | * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. | |
1210 | */ | |
1211 | #define ALLOC_GROW(x, nr, alloc) \ | |
1212 | do { \ | |
1213 | if ((nr) > alloc) { \ | |
1214 | if (alloc_nr(alloc) < (nr)) \ | |
1215 | alloc = (nr); \ | |
1216 | else \ | |
1217 | alloc = alloc_nr(alloc); \ | |
1218 | REALLOC_ARRAY(x, alloc); \ | |
1219 | } \ | |
1220 | } while (0) | |
1221 | ||
1222 | /* | |
1223 | * Similar to ALLOC_GROW but handles updating of the nr value and | |
1224 | * zeroing the bytes of the newly-grown array elements. | |
1225 | * | |
1226 | * DO NOT USE any expression with side-effect for any of the | |
1227 | * arguments. | |
1228 | */ | |
1229 | #define ALLOC_GROW_BY(x, nr, increase, alloc) \ | |
1230 | do { \ | |
1231 | if (increase) { \ | |
1232 | size_t new_nr = nr + (increase); \ | |
1233 | if (new_nr < nr) \ | |
1234 | BUG("negative growth in ALLOC_GROW_BY"); \ | |
1235 | ALLOC_GROW(x, new_nr, alloc); \ | |
1236 | memset((x) + nr, 0, sizeof(*(x)) * (increase)); \ | |
1237 | nr = new_nr; \ | |
1238 | } \ | |
1239 | } while (0) | |
1240 | ||
d64ea0f8 JK |
1241 | static inline char *xstrdup_or_null(const char *str) |
1242 | { | |
1243 | return str ? xstrdup(str) : NULL; | |
1244 | } | |
1245 | ||
dc49cd76 SP |
1246 | static inline size_t xsize_t(off_t len) |
1247 | { | |
aafa5df0 | 1248 | if (len < 0 || (uintmax_t) len > SIZE_MAX) |
46be82df | 1249 | die("Cannot handle files this big"); |
aafa5df0 | 1250 | return (size_t) len; |
dc49cd76 SP |
1251 | } |
1252 | ||
da25bdb7 RS |
1253 | #ifndef HOST_NAME_MAX |
1254 | #define HOST_NAME_MAX 256 | |
1255 | #endif | |
1256 | ||
1890ce84 | 1257 | #include "sane-ctype.h" |
43ccdf56 | 1258 | |
41a80924 JK |
1259 | /* |
1260 | * Like skip_prefix, but compare case-insensitively. Note that the comparison | |
1261 | * is done via tolower(), so it is strictly ASCII (no multi-byte characters or | |
1262 | * locale-specific conversions). | |
1263 | */ | |
1264 | static inline int skip_iprefix(const char *str, const char *prefix, | |
1265 | const char **out) | |
1266 | { | |
1267 | do { | |
1268 | if (!*prefix) { | |
1269 | *out = str; | |
1270 | return 1; | |
1271 | } | |
1272 | } while (tolower(*str++) == tolower(*prefix++)); | |
1273 | return 0; | |
1274 | } | |
1275 | ||
6b8dda9a MJC |
1276 | /* |
1277 | * Like skip_prefix_mem, but compare case-insensitively. Note that the | |
1278 | * comparison is done via tolower(), so it is strictly ASCII (no multi-byte | |
1279 | * characters or locale-specific conversions). | |
1280 | */ | |
1281 | static inline int skip_iprefix_mem(const char *buf, size_t len, | |
1282 | const char *prefix, | |
1283 | const char **out, size_t *outlen) | |
1284 | { | |
1285 | do { | |
1286 | if (!*prefix) { | |
1287 | *out = buf; | |
1288 | *outlen = len; | |
1289 | return 1; | |
1290 | } | |
1291 | } while (len-- > 0 && tolower(*buf++) == tolower(*prefix++)); | |
1292 | return 0; | |
1293 | } | |
1294 | ||
6aead43d JM |
1295 | static inline int strtoul_ui(char const *s, int base, unsigned int *result) |
1296 | { | |
1297 | unsigned long ul; | |
1298 | char *p; | |
1299 | ||
1300 | errno = 0; | |
e6f2599c MM |
1301 | /* negative values would be accepted by strtoul */ |
1302 | if (strchr(s, '-')) | |
1303 | return -1; | |
6aead43d JM |
1304 | ul = strtoul(s, &p, base); |
1305 | if (errno || *p || p == s || (unsigned int) ul != ul) | |
1306 | return -1; | |
1307 | *result = ul; | |
1308 | return 0; | |
1309 | } | |
1310 | ||
7791ecbc JH |
1311 | static inline int strtol_i(char const *s, int base, int *result) |
1312 | { | |
1313 | long ul; | |
1314 | char *p; | |
1315 | ||
1316 | errno = 0; | |
1317 | ul = strtol(s, &p, base); | |
1318 | if (errno || *p || p == s || (int) ul != ul) | |
1319 | return -1; | |
1320 | *result = ul; | |
1321 | return 0; | |
1322 | } | |
1323 | ||
97fff610 JS |
1324 | void git_stable_qsort(void *base, size_t nmemb, size_t size, |
1325 | int(*compar)(const void *, const void *)); | |
43fe901b | 1326 | #ifdef INTERNAL_QSORT |
97fff610 | 1327 | #define qsort git_stable_qsort |
43fe901b BD |
1328 | #endif |
1329 | ||
dbc540c7 RS |
1330 | #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar) |
1331 | static inline void sane_qsort(void *base, size_t nmemb, size_t size, | |
1332 | int(*compar)(const void *, const void *)) | |
1333 | { | |
1334 | if (nmemb > 1) | |
1335 | qsort(base, nmemb, size, compar); | |
1336 | } | |
1337 | ||
97fff610 JS |
1338 | #define STABLE_QSORT(base, n, compar) \ |
1339 | git_stable_qsort((base), (n), sizeof(*(base)), compar) | |
1340 | ||
04ee8b87 RS |
1341 | #ifndef HAVE_ISO_QSORT_S |
1342 | int git_qsort_s(void *base, size_t nmemb, size_t size, | |
1343 | int (*compar)(const void *, const void *, void *), void *ctx); | |
1344 | #define qsort_s git_qsort_s | |
1345 | #endif | |
1346 | ||
3ca86994 RS |
1347 | #define QSORT_S(base, n, compar, ctx) do { \ |
1348 | if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \ | |
c3c3486b | 1349 | BUG("qsort_s() failed"); \ |
3ca86994 RS |
1350 | } while (0) |
1351 | ||
2f895225 JS |
1352 | #ifndef REG_STARTEND |
1353 | #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd" | |
1354 | #endif | |
1355 | ||
1356 | static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size, | |
1357 | size_t nmatch, regmatch_t pmatch[], int eflags) | |
1358 | { | |
1359 | assert(nmatch > 0 && pmatch); | |
1360 | pmatch[0].rm_so = 0; | |
1361 | pmatch[0].rm_eo = size; | |
1362 | return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND); | |
1363 | } | |
1364 | ||
54463d32 RS |
1365 | #ifdef USE_ENHANCED_BASIC_REGULAR_EXPRESSIONS |
1366 | int git_regcomp(regex_t *preg, const char *pattern, int cflags); | |
1367 | #define regcomp git_regcomp | |
1368 | #endif | |
1369 | ||
81a24b52 AR |
1370 | #ifndef DIR_HAS_BSD_GROUP_SEMANTICS |
1371 | # define FORCE_DIR_SET_GID S_ISGID | |
1372 | #else | |
1373 | # define FORCE_DIR_SET_GID 0 | |
1374 | #endif | |
1375 | ||
c06ff490 KB |
1376 | #ifdef NO_NSEC |
1377 | #undef USE_NSEC | |
1378 | #define ST_CTIME_NSEC(st) 0 | |
1379 | #define ST_MTIME_NSEC(st) 0 | |
1380 | #else | |
c567383b BG |
1381 | #ifdef USE_ST_TIMESPEC |
1382 | #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec)) | |
1383 | #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec)) | |
1384 | #else | |
c06ff490 KB |
1385 | #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec)) |
1386 | #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec)) | |
1387 | #endif | |
c567383b | 1388 | #endif |
c06ff490 | 1389 | |
34779c53 JS |
1390 | #ifdef UNRELIABLE_FSTAT |
1391 | #define fstat_is_reliable() 0 | |
1392 | #else | |
1393 | #define fstat_is_reliable() 1 | |
1394 | #endif | |
1395 | ||
ab8632ae | 1396 | #ifndef va_copy |
26db0f2e JN |
1397 | /* |
1398 | * Since an obvious implementation of va_list would be to make it a | |
1399 | * pointer into the stack frame, a simple assignment will work on | |
1400 | * many systems. But let's try to be more portable. | |
1401 | */ | |
1402 | #ifdef __va_copy | |
1403 | #define va_copy(dst, src) __va_copy(dst, src) | |
1404 | #else | |
1405 | #define va_copy(dst, src) ((dst) = (src)) | |
1406 | #endif | |
ab8632ae JK |
1407 | #endif |
1408 | ||
746ea4ad RJ |
1409 | /* usage.c: only to be used for testing BUG() implementation (see test-tool) */ |
1410 | extern int BUG_exit_code; | |
1411 | ||
0cc05b04 ÆAB |
1412 | /* usage.c: if bug() is called we should have a BUG_if_bug() afterwards */ |
1413 | extern int bug_called_must_BUG; | |
1414 | ||
d8193743 JK |
1415 | __attribute__((format (printf, 3, 4))) NORETURN |
1416 | void BUG_fl(const char *file, int line, const char *fmt, ...); | |
1417 | #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__) | |
0cc05b04 ÆAB |
1418 | __attribute__((format (printf, 3, 4))) |
1419 | void bug_fl(const char *file, int line, const char *fmt, ...); | |
1420 | #define bug(...) bug_fl(__FILE__, __LINE__, __VA_ARGS__) | |
1421 | #define BUG_if_bug(...) do { \ | |
1422 | if (bug_called_must_BUG) \ | |
1423 | BUG_fl(__FILE__, __LINE__, __VA_ARGS__); \ | |
1424 | } while (0) | |
d8193743 | 1425 | |
8a94d833 | 1426 | #ifndef FSYNC_METHOD_DEFAULT |
abf38abe NS |
1427 | #ifdef __APPLE__ |
1428 | #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_WRITEOUT_ONLY | |
1429 | #else | |
1430 | #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_FSYNC | |
1431 | #endif | |
8a94d833 | 1432 | #endif |
abf38abe | 1433 | |
1b56cdf9 KM |
1434 | #ifndef SHELL_PATH |
1435 | # define SHELL_PATH "/bin/sh" | |
1436 | #endif | |
1437 | ||
f43cce23 | 1438 | #ifndef _POSIX_THREAD_SAFE_FUNCTIONS |
efcc48ef | 1439 | static inline void git_flockfile(FILE *fh UNUSED) |
15b52a44 JH |
1440 | { |
1441 | ; /* nothing */ | |
1442 | } | |
efcc48ef | 1443 | static inline void git_funlockfile(FILE *fh UNUSED) |
15b52a44 JH |
1444 | { |
1445 | ; /* nothing */ | |
1446 | } | |
e1a95b78 JK |
1447 | #undef flockfile |
1448 | #undef funlockfile | |
1449 | #undef getc_unlocked | |
e0c08a4f JK |
1450 | #define flockfile(fh) git_flockfile(fh) |
1451 | #define funlockfile(fh) git_funlockfile(fh) | |
f43cce23 JK |
1452 | #define getc_unlocked(fh) getc(fh) |
1453 | #endif | |
1454 | ||
18a4f6be NTND |
1455 | #ifdef FILENO_IS_A_MACRO |
1456 | int git_fileno(FILE *stream); | |
400caafb | 1457 | # ifndef COMPAT_CODE_FILENO |
18a4f6be NTND |
1458 | # undef fileno |
1459 | # define fileno(p) git_fileno(p) | |
1460 | # endif | |
1461 | #endif | |
1462 | ||
400caafb CC |
1463 | #ifdef NEED_ACCESS_ROOT_HANDLER |
1464 | int git_access(const char *path, int mode); | |
1465 | # ifndef COMPAT_CODE_ACCESS | |
1466 | # ifdef access | |
1467 | # undef access | |
1468 | # endif | |
1469 | # define access(path, mode) git_access(path, mode) | |
1470 | # endif | |
1471 | #endif | |
1472 | ||
dc5a18b3 JH |
1473 | /* |
1474 | * Our code often opens a path to an optional file, to work on its | |
1475 | * contents when we can successfully open it. We can ignore a failure | |
1476 | * to open if such an optional file does not exist, but we do want to | |
1477 | * report a failure in opening for other reasons (e.g. we got an I/O | |
1478 | * error, or the file is there, but we lack the permission to open). | |
1479 | * | |
1480 | * Call this function after seeing an error from open() or fopen() to | |
1481 | * see if the errno indicates a missing file that we can safely ignore. | |
1482 | */ | |
1483 | static inline int is_missing_file_error(int errno_) | |
1484 | { | |
1485 | return (errno_ == ENOENT || errno_ == ENOTDIR); | |
1486 | } | |
1487 | ||
55454427 | 1488 | int cmd_main(int, const char **); |
5c238e29 | 1489 | |
ee4512ed JH |
1490 | /* |
1491 | * Intercept all calls to exit() and route them to trace2 to | |
1492 | * optionally emit a message before calling the real exit(). | |
1493 | */ | |
19d75948 ÆAB |
1494 | int common_exit(const char *file, int line, int code); |
1495 | #define exit(code) exit(common_exit(__FILE__, __LINE__, (code))) | |
ee4512ed | 1496 | |
0e5bba53 JK |
1497 | /* |
1498 | * You can mark a stack variable with UNLEAK(var) to avoid it being | |
1499 | * reported as a leak by tools like LSAN or valgrind. The argument | |
1500 | * should generally be the variable itself (not its address and not what | |
1501 | * it points to). It's safe to use this on pointers which may already | |
1502 | * have been freed, or on pointers which may still be in use. | |
1503 | * | |
1504 | * Use this _only_ for a variable that leaks by going out of scope at | |
1505 | * program exit (so only from cmd_* functions or their direct helpers). | |
1506 | * Normal functions, especially those which may be called multiple | |
1507 | * times, should actually free their memory. This is only meant as | |
1508 | * an annotation, and does nothing in non-leak-checking builds. | |
1509 | */ | |
1510 | #ifdef SUPPRESS_ANNOTATED_LEAKS | |
55454427 | 1511 | void unleak_memory(const void *ptr, size_t len); |
5de3de32 | 1512 | #define UNLEAK(var) unleak_memory(&(var), sizeof(var)) |
0e5bba53 | 1513 | #else |
5de3de32 | 1514 | #define UNLEAK(var) do {} while (0) |
0e5bba53 JK |
1515 | #endif |
1516 | ||
07564773 ÆAB |
1517 | #define z_const |
1518 | #include <zlib.h> | |
1519 | ||
1520 | #if ZLIB_VERNUM < 0x1290 | |
1521 | /* | |
1522 | * This is uncompress2, which is only available in zlib >= 1.2.9 | |
1523 | * (released as of early 2017). See compat/zlib-uncompress2.c. | |
1524 | */ | |
1525 | int uncompress2(Bytef *dest, uLongf *destLen, const Bytef *source, | |
1526 | uLong *sourceLen); | |
1527 | #endif | |
1528 | ||
c8af66ab JK |
1529 | /* |
1530 | * This include must come after system headers, since it introduces macros that | |
1531 | * replace system names. | |
1532 | */ | |
1533 | #include "banned.h" | |
1534 | ||
973d5eea EW |
1535 | /* |
1536 | * container_of - Get the address of an object containing a field. | |
1537 | * | |
1538 | * @ptr: pointer to the field. | |
1539 | * @type: type of the object. | |
1540 | * @member: name of the field within the object. | |
1541 | */ | |
1542 | #define container_of(ptr, type, member) \ | |
1543 | ((type *) ((char *)(ptr) - offsetof(type, member))) | |
1544 | ||
f0e63c41 EW |
1545 | /* |
1546 | * helper function for `container_of_or_null' to avoid multiple | |
1547 | * evaluation of @ptr | |
1548 | */ | |
1549 | static inline void *container_of_or_null_offset(void *ptr, size_t offset) | |
1550 | { | |
1551 | return ptr ? (char *)ptr - offset : NULL; | |
1552 | } | |
1553 | ||
1554 | /* | |
1555 | * like `container_of', but allows returned value to be NULL | |
1556 | */ | |
1557 | #define container_of_or_null(ptr, type, member) \ | |
1558 | (type *)container_of_or_null_offset(ptr, offsetof(type, member)) | |
1559 | ||
23dee69f | 1560 | /* |
abcb66c6 | 1561 | * like offsetof(), but takes a pointer to a variable of type which |
23dee69f EW |
1562 | * contains @member, instead of a specified type. |
1563 | * @ptr is subject to multiple evaluation since we can't rely on __typeof__ | |
1564 | * everywhere. | |
1565 | */ | |
1566 | #if defined(__GNUC__) /* clang sets this, too */ | |
1567 | #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member) | |
1568 | #else /* !__GNUC__ */ | |
1569 | #define OFFSETOF_VAR(ptr, member) \ | |
1570 | ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr)) | |
1571 | #endif /* !__GNUC__ */ | |
1572 | ||
5c238e29 | 1573 | #endif |