]>
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 | ||
4050c0df JH |
221 | #include <unistd.h> |
222 | #include <stdio.h> | |
223 | #include <sys/stat.h> | |
224 | #include <fcntl.h> | |
225 | #include <stddef.h> | |
226 | #include <stdlib.h> | |
227 | #include <stdarg.h> | |
228 | #include <string.h> | |
b3e103da | 229 | #ifdef HAVE_STRINGS_H |
6c109904 JS |
230 | #include <strings.h> /* for strcasecmp() */ |
231 | #endif | |
4050c0df JH |
232 | #include <errno.h> |
233 | #include <limits.h> | |
1819ad32 | 234 | #include <locale.h> |
b2d05e06 | 235 | #ifdef NEEDS_SYS_PARAM_H |
4050c0df | 236 | #include <sys/param.h> |
6ede7205 | 237 | #endif |
4050c0df JH |
238 | #include <sys/types.h> |
239 | #include <dirent.h> | |
85023577 JH |
240 | #include <sys/time.h> |
241 | #include <time.h> | |
242 | #include <signal.h> | |
f4626df5 JS |
243 | #include <assert.h> |
244 | #include <regex.h> | |
245 | #include <utime.h> | |
088d8802 | 246 | #include <syslog.h> |
2648ccc2 ĐTCD |
247 | #if !defined(NO_POLL_H) |
248 | #include <poll.h> | |
249 | #elif !defined(NO_SYS_POLL_H) | |
fdc12114 | 250 | #include <sys/poll.h> |
2844923d | 251 | #else |
2648ccc2 | 252 | /* Pull the compat stuff */ |
2844923d MD |
253 | #include <poll.h> |
254 | #endif | |
9529080d KM |
255 | #ifdef HAVE_BSD_SYSCTL |
256 | #include <sys/sysctl.h> | |
257 | #endif | |
2f0aaaf9 | 258 | |
9fd512c8 ÆAB |
259 | /* Used by compat/win32/path-utils.h, and more */ |
260 | static inline int is_xplatform_dir_sep(int c) | |
261 | { | |
262 | return c == '/' || c == '\\'; | |
263 | } | |
264 | ||
496f2569 | 265 | #if defined(__CYGWIN__) |
1cadad6f | 266 | #include "compat/win32/path-utils.h" |
496f2569 | 267 | #endif |
cfc755d3 VR |
268 | #if defined(__MINGW32__) |
269 | /* pull in Windows compatibility stuff */ | |
1cadad6f | 270 | #include "compat/win32/path-utils.h" |
cfc755d3 VR |
271 | #include "compat/mingw.h" |
272 | #elif defined(_MSC_VER) | |
22c3634c | 273 | #include "compat/win32/path-utils.h" |
cfc755d3 VR |
274 | #include "compat/msvc.h" |
275 | #else | |
1e8fef60 | 276 | #include <sys/utsname.h> |
f4626df5 | 277 | #include <sys/wait.h> |
ebae9ff9 | 278 | #include <sys/resource.h> |
85023577 | 279 | #include <sys/socket.h> |
80bbe72b | 280 | #include <sys/ioctl.h> |
435a2535 | 281 | #include <sys/statvfs.h> |
eb80042c | 282 | #include <termios.h> |
2600973f | 283 | #ifndef NO_SYS_SELECT_H |
80bbe72b | 284 | #include <sys/select.h> |
2600973f | 285 | #endif |
85023577 JH |
286 | #include <netinet/in.h> |
287 | #include <netinet/tcp.h> | |
288 | #include <arpa/inet.h> | |
289 | #include <netdb.h> | |
290 | #include <pwd.h> | |
e2770979 | 291 | #include <sys/un.h> |
2844923d | 292 | #ifndef NO_INTTYPES_H |
007e2ba6 | 293 | #include <inttypes.h> |
2844923d MD |
294 | #else |
295 | #include <stdint.h> | |
296 | #endif | |
05cd988d | 297 | #ifdef HAVE_ARC4RANDOM_LIBBSD |
298 | #include <bsd/stdlib.h> | |
299 | #endif | |
300 | #ifdef HAVE_GETRANDOM | |
301 | #include <sys/random.h> | |
302 | #endif | |
6c109904 JS |
303 | #ifdef NO_INTPTR_T |
304 | /* | |
c70e1b04 | 305 | * On I16LP32, ILP32 and LP64 "long" is the safe bet, however |
6c109904 JS |
306 | * on LLP86, IL33LLP64 and P64 it needs to be "long long", |
307 | * while on IP16 and IP16L32 it is "int" (resp. "short") | |
308 | * Size needs to match (or exceed) 'sizeof(void *)'. | |
309 | * We can't take "long long" here as not everybody has it. | |
310 | */ | |
311 | typedef long intptr_t; | |
312 | typedef unsigned long uintptr_t; | |
313 | #endif | |
fb952206 | 314 | #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */ |
85023577 | 315 | #include <grp.h> |
fb952206 | 316 | #define _ALL_SOURCE 1 |
41b20017 | 317 | #endif |
85023577 | 318 | |
76759c7d TB |
319 | /* used on Mac OS X */ |
320 | #ifdef PRECOMPOSE_UNICODE | |
321 | #include "compat/precompose_utf8.h" | |
322 | #else | |
808e9195 JK |
323 | static inline const char *precompose_argv_prefix(int argc UNUSED, |
324 | const char **argv UNUSED, | |
325 | const char *prefix) | |
15b52a44 | 326 | { |
5c327502 | 327 | return prefix; |
15b52a44 | 328 | } |
5020774a TB |
329 | static inline const char *precompose_string_if_needed(const char *in) |
330 | { | |
331 | return in; | |
332 | } | |
333 | ||
fdf72966 | 334 | #define probe_utf8_pathname_composition() |
76759c7d TB |
335 | #endif |
336 | ||
0539ecfd JS |
337 | #ifdef MKDIR_WO_TRAILING_SLASH |
338 | #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b)) | |
55454427 | 339 | int compat_mkdir_wo_trailing_slash(const char*, mode_t); |
0539ecfd JS |
340 | #endif |
341 | ||
370ddcbc PE |
342 | #ifdef time |
343 | #undef time | |
344 | #endif | |
345 | static inline time_t git_time(time_t *tloc) | |
346 | { | |
347 | struct timeval tv; | |
348 | ||
349 | /* | |
350 | * Avoid time(NULL), which can disagree with gettimeofday(2) | |
351 | * and filesystem timestamps. | |
352 | */ | |
353 | gettimeofday(&tv, NULL); | |
354 | ||
355 | if (tloc) | |
356 | *tloc = tv.tv_sec; | |
357 | return tv.tv_sec; | |
358 | } | |
359 | #define time git_time | |
360 | ||
7f9e848c JS |
361 | #ifdef NO_STRUCT_ITIMERVAL |
362 | struct itimerval { | |
363 | struct timeval it_interval; | |
364 | struct timeval it_value; | |
981ff520 | 365 | }; |
7f9e848c JS |
366 | #endif |
367 | ||
368 | #ifdef NO_SETITIMER | |
efcc48ef JH |
369 | static inline int git_setitimer(int which UNUSED, |
370 | const struct itimerval *value UNUSED, | |
371 | struct itimerval *newvalue UNUSED) { | |
14639a47 | 372 | return 0; /* pretend success */ |
15b52a44 | 373 | } |
e1a95b78 | 374 | #undef setitimer |
e0c08a4f | 375 | #define setitimer(which,value,ovalue) git_setitimer(which,value,ovalue) |
7f9e848c JS |
376 | #endif |
377 | ||
e1c06886 DA |
378 | #ifndef NO_LIBGEN_H |
379 | #include <libgen.h> | |
380 | #else | |
381 | #define basename gitbasename | |
55454427 | 382 | char *gitbasename(char *); |
824682ab | 383 | #define dirname gitdirname |
55454427 | 384 | char *gitdirname(char *); |
e1c06886 DA |
385 | #endif |
386 | ||
85023577 JH |
387 | #ifndef NO_ICONV |
388 | #include <iconv.h> | |
389 | #endif | |
4050c0df | 390 | |
684ec6c6 | 391 | #ifndef NO_OPENSSL |
88c03eb5 | 392 | #ifdef __APPLE__ |
b195aa00 | 393 | #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0 |
88c03eb5 KM |
394 | #include <AvailabilityMacros.h> |
395 | #undef DEPRECATED_ATTRIBUTE | |
396 | #define DEPRECATED_ATTRIBUTE | |
397 | #undef __AVAILABILITY_MACROS_USES_AVAILABILITY | |
398 | #endif | |
684ec6c6 RS |
399 | #include <openssl/ssl.h> |
400 | #include <openssl/err.h> | |
401 | #endif | |
402 | ||
9806f5a7 NTND |
403 | #ifdef HAVE_SYSINFO |
404 | # include <sys/sysinfo.h> | |
405 | #endif | |
406 | ||
3b130ade DM |
407 | /* On most systems <netdb.h> would have given us this, but |
408 | * not on some systems (e.g. z/OS). | |
409 | */ | |
410 | #ifndef NI_MAXHOST | |
411 | #define NI_MAXHOST 1025 | |
412 | #endif | |
413 | ||
414 | #ifndef NI_MAXSERV | |
415 | #define NI_MAXSERV 32 | |
416 | #endif | |
417 | ||
d0c2449f JH |
418 | /* On most systems <limits.h> would have given us this, but |
419 | * not on some systems (e.g. GNU/Hurd). | |
420 | */ | |
421 | #ifndef PATH_MAX | |
422 | #define PATH_MAX 4096 | |
423 | #endif | |
424 | ||
28f4aee3 JS |
425 | typedef uintmax_t timestamp_t; |
426 | #define PRItime PRIuMAX | |
427 | #define parse_timestamp strtoumax | |
428 | #define TIME_MAX UINTMAX_MAX | |
2e09c012 | 429 | #define TIME_MIN 0 |
1aeb7e75 | 430 | |
80ba074f JS |
431 | #ifndef PATH_SEP |
432 | #define PATH_SEP ':' | |
433 | #endif | |
434 | ||
cb6a22c0 CW |
435 | #ifdef HAVE_PATHS_H |
436 | #include <paths.h> | |
437 | #endif | |
438 | #ifndef _PATH_DEFPATH | |
439 | #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin" | |
440 | #endif | |
441 | ||
70fc5793 | 442 | #ifndef platform_core_config |
5cf88fd8 ÆAB |
443 | static inline int noop_core_config(const char *var UNUSED, |
444 | const char *value UNUSED, | |
445 | void *cb UNUSED) | |
70fc5793 JS |
446 | { |
447 | return 0; | |
448 | } | |
449 | #define platform_core_config noop_core_config | |
450 | #endif | |
451 | ||
684dd4c2 MT |
452 | int lstat_cache_aware_rmdir(const char *path); |
453 | #if !defined(__MINGW32__) && !defined(_MSC_VER) | |
454 | #define rmdir lstat_cache_aware_rmdir | |
455 | #endif | |
456 | ||
25fe217b | 457 | #ifndef has_dos_drive_prefix |
808e9195 | 458 | static inline int git_has_dos_drive_prefix(const char *path UNUSED) |
bf728346 RS |
459 | { |
460 | return 0; | |
461 | } | |
462 | #define has_dos_drive_prefix git_has_dos_drive_prefix | |
25fe217b JS |
463 | #endif |
464 | ||
2f36eed9 | 465 | #ifndef skip_dos_drive_prefix |
808e9195 | 466 | static inline int git_skip_dos_drive_prefix(char **path UNUSED) |
2f36eed9 JS |
467 | { |
468 | return 0; | |
469 | } | |
470 | #define skip_dos_drive_prefix git_skip_dos_drive_prefix | |
471 | #endif | |
472 | ||
bf728346 RS |
473 | static inline int git_is_dir_sep(int c) |
474 | { | |
475 | return c == '/'; | |
476 | } | |
9fd512c8 | 477 | #ifndef is_dir_sep |
bf728346 | 478 | #define is_dir_sep git_is_dir_sep |
c2369bdf CZ |
479 | #endif |
480 | ||
bf728346 RS |
481 | #ifndef offset_1st_component |
482 | static inline int git_offset_1st_component(const char *path) | |
483 | { | |
484 | return is_dir_sep(path[0]); | |
485 | } | |
486 | #define offset_1st_component git_offset_1st_component | |
25fe217b JS |
487 | #endif |
488 | ||
d2c84dad JS |
489 | #ifndef is_valid_path |
490 | #define is_valid_path(path) 1 | |
491 | #endif | |
492 | ||
bdc77d1d | 493 | #ifndef is_path_owned_by_current_user |
ae9abbb6 CMAB |
494 | |
495 | #ifdef __TANDEM | |
496 | #define ROOT_UID 65535 | |
497 | #else | |
498 | #define ROOT_UID 0 | |
499 | #endif | |
500 | ||
501 | /* | |
502 | * Do not use this function when | |
503 | * (1) geteuid() did not say we are running as 'root', or | |
504 | * (2) using this function will compromise the system. | |
505 | * | |
506 | * PORTABILITY WARNING: | |
507 | * This code assumes uid_t is unsigned because that is what sudo does. | |
508 | * If your uid_t type is signed and all your ids are positive then it | |
509 | * should all work fine. | |
510 | * If your version of sudo uses negative values for uid_t or it is | |
511 | * buggy and return an overflowed value in SUDO_UID, then git might | |
512 | * fail to grant access to your repository properly or even mistakenly | |
513 | * grant access to someone else. | |
514 | * In the unlikely scenario this happened to you, and that is how you | |
515 | * got to this message, we would like to know about it; so sent us an | |
516 | * email to git@vger.kernel.org indicating which platform you are | |
517 | * using and which version of sudo, so we can improve this logic and | |
518 | * maybe provide you with a patch that would prevent this issue again | |
519 | * in the future. | |
520 | */ | |
521 | static inline void extract_id_from_env(const char *env, uid_t *id) | |
522 | { | |
523 | const char *real_uid = getenv(env); | |
524 | ||
525 | /* discard anything empty to avoid a more complex check below */ | |
526 | if (real_uid && *real_uid) { | |
527 | char *endptr = NULL; | |
528 | unsigned long env_id; | |
529 | ||
530 | errno = 0; | |
531 | /* silent overflow errors could trigger a bug here */ | |
532 | env_id = strtoul(real_uid, &endptr, 10); | |
533 | if (!*endptr && !errno) | |
534 | *id = env_id; | |
535 | } | |
536 | } | |
537 | ||
776515ef | 538 | static inline int is_path_owned_by_current_uid(const char *path, |
5cf88fd8 | 539 | struct strbuf *report UNUSED) |
bdc77d1d JS |
540 | { |
541 | struct stat st; | |
ae9abbb6 CMAB |
542 | uid_t euid; |
543 | ||
bdc77d1d JS |
544 | if (lstat(path, &st)) |
545 | return 0; | |
ae9abbb6 CMAB |
546 | |
547 | euid = geteuid(); | |
548 | if (euid == ROOT_UID) | |
6b11e3d5 CMAB |
549 | { |
550 | if (st.st_uid == ROOT_UID) | |
551 | return 1; | |
552 | else | |
553 | extract_id_from_env("SUDO_UID", &euid); | |
554 | } | |
ae9abbb6 CMAB |
555 | |
556 | return st.st_uid == euid; | |
bdc77d1d JS |
557 | } |
558 | ||
559 | #define is_path_owned_by_current_user is_path_owned_by_current_uid | |
560 | #endif | |
561 | ||
d1c69255 | 562 | #ifndef find_last_dir_sep |
bf728346 RS |
563 | static inline char *git_find_last_dir_sep(const char *path) |
564 | { | |
565 | return strrchr(path, '/'); | |
566 | } | |
567 | #define find_last_dir_sep git_find_last_dir_sep | |
d1c69255 TN |
568 | #endif |
569 | ||
05ac8582 AK |
570 | #ifndef has_dir_sep |
571 | static inline int git_has_dir_sep(const char *path) | |
572 | { | |
573 | return !!strchr(path, '/'); | |
574 | } | |
575 | #define has_dir_sep(path) git_has_dir_sep(path) | |
576 | #endif | |
577 | ||
501afcb8 JS |
578 | #ifndef query_user_email |
579 | #define query_user_email() NULL | |
580 | #endif | |
581 | ||
1305ef37 RB |
582 | #ifdef __TANDEM |
583 | #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)> | |
584 | #include <floss.h(floss_getpwuid)> | |
585 | #ifndef NSIG | |
586 | /* | |
587 | * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest | |
588 | * known, by detective work using kill -l as a list is all signals | |
589 | * instead of signal.h where it should be. | |
590 | */ | |
591 | # define NSIG 100 | |
592 | #endif | |
593 | #endif | |
594 | ||
e4ac953b | 595 | #if defined(__HP_cc) && (__HP_cc >= 61000) |
b6ab349b MR |
596 | #define NORETURN __attribute__((noreturn)) |
597 | #define NORETURN_PTR | |
6520c846 | 598 | #elif defined(__GNUC__) && !defined(NO_NORETURN) |
4050c0df | 599 | #define NORETURN __attribute__((__noreturn__)) |
18660bc9 | 600 | #define NORETURN_PTR __attribute__((__noreturn__)) |
aba7dea8 RJ |
601 | #elif defined(_MSC_VER) |
602 | #define NORETURN __declspec(noreturn) | |
603 | #define NORETURN_PTR | |
4050c0df JH |
604 | #else |
605 | #define NORETURN | |
18660bc9 | 606 | #define NORETURN_PTR |
8cd7ebc8 | 607 | #ifndef __GNUC__ |
4050c0df JH |
608 | #ifndef __attribute__ |
609 | #define __attribute__(x) | |
610 | #endif | |
611 | #endif | |
8cd7ebc8 | 612 | #endif |
4050c0df | 613 | |
9fe3edc4 RJ |
614 | /* The sentinel attribute is valid from gcc version 4.0 */ |
615 | #if defined(__GNUC__) && (__GNUC__ >= 4) | |
616 | #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel)) | |
1e8697b5 ÆAB |
617 | /* warn_unused_result exists as of gcc 3.4.0, but be lazy and check 4.0 */ |
618 | #define RESULT_MUST_BE_USED __attribute__ ((warn_unused_result)) | |
9fe3edc4 RJ |
619 | #else |
620 | #define LAST_ARG_MUST_BE_NULL | |
1e8697b5 | 621 | #define RESULT_MUST_BE_USED |
9fe3edc4 RJ |
622 | #endif |
623 | ||
bbd8eb3e CMAB |
624 | #define MAYBE_UNUSED __attribute__((__unused__)) |
625 | ||
51ea5519 NP |
626 | #include "compat/bswap.h" |
627 | ||
9ccc0c08 RS |
628 | struct strbuf; |
629 | ||
4050c0df | 630 | /* General helper functions */ |
55454427 | 631 | NORETURN void usage(const char *err); |
b199d714 DL |
632 | NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2))); |
633 | NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
634 | NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
18568ee8 | 635 | int die_message(const char *err, ...) __attribute__((format (printf, 1, 2))); |
24f6e6d6 | 636 | int die_message_errno(const char *err, ...) __attribute__((format (printf, 1, 2))); |
b199d714 DL |
637 | int error(const char *err, ...) __attribute__((format (printf, 1, 2))); |
638 | int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
639 | void warning(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
640 | void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
4050c0df | 641 | |
f2be034c BG |
642 | #ifndef NO_OPENSSL |
643 | #ifdef APPLE_COMMON_CRYPTO | |
644 | #include "compat/apple-common-crypto.h" | |
645 | #else | |
646 | #include <openssl/evp.h> | |
647 | #include <openssl/hmac.h> | |
648 | #endif /* APPLE_COMMON_CRYPTO */ | |
649 | #include <openssl/x509v3.h> | |
650 | #endif /* NO_OPENSSL */ | |
651 | ||
5b52d9f1 CMAB |
652 | #ifdef HAVE_OPENSSL_CSPRNG |
653 | #include <openssl/rand.h> | |
654 | #endif | |
655 | ||
e208f9cc JK |
656 | /* |
657 | * Let callers be aware of the constant return value; this can help | |
9798f7e5 | 658 | * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though, |
b7ba8587 | 659 | * because other compilers may be confused by this. |
e208f9cc | 660 | */ |
ff0a80af | 661 | #if defined(__GNUC__) |
87fe5df3 JK |
662 | static inline int const_error(void) |
663 | { | |
664 | return -1; | |
665 | } | |
666 | #define error(...) (error(__VA_ARGS__), const_error()) | |
4df5e918 | 667 | #define error_errno(...) (error_errno(__VA_ARGS__), const_error()) |
e208f9cc JK |
668 | #endif |
669 | ||
5710dcce JK |
670 | typedef void (*report_fn)(const char *, va_list params); |
671 | ||
672 | void set_die_routine(NORETURN_PTR report_fn routine); | |
18568ee8 | 673 | report_fn get_die_message_routine(void); |
5710dcce JK |
674 | void set_error_routine(report_fn routine); |
675 | report_fn get_error_routine(void); | |
676 | void set_warn_routine(report_fn routine); | |
677 | report_fn get_warn_routine(void); | |
55454427 | 678 | void set_die_is_recursing_routine(int (*routine)(void)); |
39a3f5ea | 679 | |
55454427 DL |
680 | int starts_with(const char *str, const char *prefix); |
681 | int istarts_with(const char *str, const char *prefix); | |
698a68be | 682 | |
cf4fff57 JK |
683 | /* |
684 | * If the string "str" begins with the string found in "prefix", return 1. | |
685 | * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in | |
686 | * the string right after the prefix). | |
687 | * | |
688 | * Otherwise, return 0 and leave "out" untouched. | |
689 | * | |
690 | * Examples: | |
691 | * | |
692 | * [extract branch name, fail if not a branch] | |
693 | * if (!skip_prefix(ref, "refs/heads/", &branch) | |
694 | * return -1; | |
695 | * | |
696 | * [skip prefix if present, otherwise use whole string] | |
697 | * skip_prefix(name, "refs/heads/", &name); | |
698 | */ | |
699 | static inline int skip_prefix(const char *str, const char *prefix, | |
700 | const char **out) | |
fbca5837 | 701 | { |
ba399c46 | 702 | do { |
cf4fff57 JK |
703 | if (!*prefix) { |
704 | *out = str; | |
705 | return 1; | |
706 | } | |
ba399c46 | 707 | } while (*str++ == *prefix++); |
cf4fff57 | 708 | return 0; |
fbca5837 MV |
709 | } |
710 | ||
afaef55e CC |
711 | /* |
712 | * If the string "str" is the same as the string in "prefix", then the "arg" | |
713 | * parameter is set to the "def" parameter and 1 is returned. | |
714 | * If the string "str" begins with the string found in "prefix" and then a | |
715 | * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1" | |
716 | * (i.e., to the point in the string right after the prefix and the "=" sign), | |
717 | * and 1 is returned. | |
718 | * | |
719 | * Otherwise, return 0 and leave "arg" untouched. | |
720 | * | |
721 | * When we accept both a "--key" and a "--key=<val>" option, this function | |
722 | * can be used instead of !strcmp(arg, "--key") and then | |
723 | * skip_prefix(arg, "--key=", &arg) to parse such an option. | |
724 | */ | |
725 | int skip_to_optional_arg_default(const char *str, const char *prefix, | |
726 | const char **arg, const char *def); | |
727 | ||
728 | static inline int skip_to_optional_arg(const char *str, const char *prefix, | |
729 | const char **arg) | |
730 | { | |
731 | return skip_to_optional_arg_default(str, prefix, arg, ""); | |
732 | } | |
733 | ||
ae989a61 JK |
734 | /* |
735 | * Like skip_prefix, but promises never to read past "len" bytes of the input | |
736 | * buffer, and returns the remaining number of bytes in "out" via "outlen". | |
737 | */ | |
738 | static inline int skip_prefix_mem(const char *buf, size_t len, | |
739 | const char *prefix, | |
740 | const char **out, size_t *outlen) | |
741 | { | |
742 | size_t prefix_len = strlen(prefix); | |
743 | if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) { | |
744 | *out = buf + prefix_len; | |
745 | *outlen = len - prefix_len; | |
746 | return 1; | |
747 | } | |
748 | return 0; | |
749 | } | |
750 | ||
35480f0b JK |
751 | /* |
752 | * If buf ends with suffix, return 1 and subtract the length of the suffix | |
753 | * from *len. Otherwise, return 0 and leave *len untouched. | |
754 | */ | |
755 | static inline int strip_suffix_mem(const char *buf, size_t *len, | |
756 | const char *suffix) | |
757 | { | |
758 | size_t suflen = strlen(suffix); | |
759 | if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen)) | |
760 | return 0; | |
761 | *len -= suflen; | |
762 | return 1; | |
763 | } | |
764 | ||
765 | /* | |
766 | * If str ends with suffix, return 1 and set *len to the size of the string | |
767 | * without the suffix. Otherwise, return 0 and set *len to the size of the | |
768 | * string. | |
769 | * | |
770 | * Note that we do _not_ NUL-terminate str to the new length. | |
771 | */ | |
772 | static inline int strip_suffix(const char *str, const char *suffix, size_t *len) | |
773 | { | |
774 | *len = strlen(str); | |
775 | return strip_suffix_mem(str, len, suffix); | |
776 | } | |
777 | ||
f52a35fd JK |
778 | static inline int ends_with(const char *str, const char *suffix) |
779 | { | |
780 | size_t len; | |
781 | return strip_suffix(str, suffix, &len); | |
782 | } | |
783 | ||
568edcb9 RS |
784 | #define SWAP(a, b) do { \ |
785 | void *_swap_a_ptr = &(a); \ | |
786 | void *_swap_b_ptr = &(b); \ | |
787 | unsigned char _swap_buffer[sizeof(a)]; \ | |
788 | memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \ | |
789 | memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \ | |
790 | BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \ | |
791 | memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \ | |
792 | } while (0) | |
793 | ||
b130a72b | 794 | #if defined(NO_MMAP) || defined(USE_WIN32_MMAP) |
4050c0df JH |
795 | |
796 | #ifndef PROT_READ | |
797 | #define PROT_READ 1 | |
798 | #define PROT_WRITE 2 | |
799 | #define MAP_PRIVATE 1 | |
4050c0df JH |
800 | #endif |
801 | ||
d6779124 SP |
802 | #define mmap git_mmap |
803 | #define munmap git_munmap | |
55454427 DL |
804 | void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset); |
805 | int git_munmap(void *start, size_t length); | |
4050c0df | 806 | |
b130a72b JL |
807 | #else /* NO_MMAP || USE_WIN32_MMAP */ |
808 | ||
809 | #include <sys/mman.h> | |
810 | ||
811 | #endif /* NO_MMAP || USE_WIN32_MMAP */ | |
812 | ||
813 | #ifdef NO_MMAP | |
814 | ||
5faaf246 | 815 | /* This value must be multiple of (pagesize * 2) */ |
8c82534d SP |
816 | #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024) |
817 | ||
4050c0df JH |
818 | #else /* NO_MMAP */ |
819 | ||
5faaf246 | 820 | /* This value must be multiple of (pagesize * 2) */ |
22bac0ea SP |
821 | #define DEFAULT_PACKED_GIT_WINDOW_SIZE \ |
822 | (sizeof(void*) >= 8 \ | |
823 | ? 1 * 1024 * 1024 * 1024 \ | |
824 | : 32 * 1024 * 1024) | |
4050c0df JH |
825 | |
826 | #endif /* NO_MMAP */ | |
827 | ||
fcf3a21a GV |
828 | #ifndef MAP_FAILED |
829 | #define MAP_FAILED ((void *)-1) | |
830 | #endif | |
831 | ||
fdb2a2a6 JH |
832 | #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT |
833 | #define on_disk_bytes(st) ((st).st_size) | |
834 | #else | |
835 | #define on_disk_bytes(st) ((st).st_blocks * 512) | |
836 | #endif | |
837 | ||
d543d9c0 DM |
838 | #ifdef NEEDS_MODE_TRANSLATION |
839 | #undef S_IFMT | |
840 | #undef S_IFREG | |
841 | #undef S_IFDIR | |
842 | #undef S_IFLNK | |
843 | #undef S_IFBLK | |
844 | #undef S_IFCHR | |
845 | #undef S_IFIFO | |
846 | #undef S_IFSOCK | |
847 | #define S_IFMT 0170000 | |
848 | #define S_IFREG 0100000 | |
849 | #define S_IFDIR 0040000 | |
850 | #define S_IFLNK 0120000 | |
851 | #define S_IFBLK 0060000 | |
852 | #define S_IFCHR 0020000 | |
853 | #define S_IFIFO 0010000 | |
854 | #define S_IFSOCK 0140000 | |
855 | #ifdef stat | |
856 | #undef stat | |
857 | #endif | |
858 | #define stat(path, buf) git_stat(path, buf) | |
55454427 | 859 | int git_stat(const char *, struct stat *); |
d543d9c0 DM |
860 | #ifdef fstat |
861 | #undef fstat | |
862 | #endif | |
863 | #define fstat(fd, buf) git_fstat(fd, buf) | |
55454427 | 864 | int git_fstat(int, struct stat *); |
d543d9c0 DM |
865 | #ifdef lstat |
866 | #undef lstat | |
867 | #endif | |
868 | #define lstat(path, buf) git_lstat(path, buf) | |
55454427 | 869 | int git_lstat(const char *, struct stat *); |
d543d9c0 DM |
870 | #endif |
871 | ||
22bac0ea | 872 | #define DEFAULT_PACKED_GIT_LIMIT \ |
be4ca290 | 873 | ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256)) |
8c82534d | 874 | |
6900679c SH |
875 | #ifdef NO_PREAD |
876 | #define pread git_pread | |
55454427 | 877 | ssize_t git_pread(int fd, void *buf, size_t count, off_t offset); |
6900679c SH |
878 | #endif |
879 | ||
4050c0df JH |
880 | #ifdef NO_SETENV |
881 | #define setenv gitsetenv | |
55454427 | 882 | int gitsetenv(const char *, const char *, int); |
4050c0df JH |
883 | #endif |
884 | ||
ca5bb5d5 SP |
885 | #ifdef NO_MKDTEMP |
886 | #define mkdtemp gitmkdtemp | |
55454427 | 887 | char *gitmkdtemp(char *); |
ca5bb5d5 | 888 | #endif |
0620b39b | 889 | |
731043fd JR |
890 | #ifdef NO_UNSETENV |
891 | #define unsetenv gitunsetenv | |
a38989bd | 892 | int gitunsetenv(const char *); |
731043fd JR |
893 | #endif |
894 | ||
4050c0df JH |
895 | #ifdef NO_STRCASESTR |
896 | #define strcasestr gitstrcasestr | |
55454427 | 897 | char *gitstrcasestr(const char *haystack, const char *needle); |
4050c0df JH |
898 | #endif |
899 | ||
817151e6 PE |
900 | #ifdef NO_STRLCPY |
901 | #define strlcpy gitstrlcpy | |
55454427 | 902 | size_t gitstrlcpy(char *, const char *, size_t); |
817151e6 PE |
903 | #endif |
904 | ||
bc6b4f52 JR |
905 | #ifdef NO_STRTOUMAX |
906 | #define strtoumax gitstrtoumax | |
55454427 | 907 | uintmax_t gitstrtoumax(const char *, char **, int); |
97000ba6 | 908 | #define strtoimax gitstrtoimax |
55454427 | 909 | intmax_t gitstrtoimax(const char *, char **, int); |
bc6b4f52 JR |
910 | #endif |
911 | ||
fa0c87c3 AR |
912 | #ifdef NO_HSTRERROR |
913 | #define hstrerror githstrerror | |
55454427 | 914 | const char *githstrerror(int herror); |
fa0c87c3 AR |
915 | #endif |
916 | ||
b21b9f1d RS |
917 | #ifdef NO_MEMMEM |
918 | #define memmem gitmemmem | |
919 | void *gitmemmem(const void *haystack, size_t haystacklen, | |
ec36c42a | 920 | const void *needle, size_t needlelen); |
b21b9f1d RS |
921 | #endif |
922 | ||
ca2baa3f RS |
923 | #ifdef OVERRIDE_STRDUP |
924 | #ifdef strdup | |
925 | #undef strdup | |
926 | #endif | |
927 | #define strdup gitstrdup | |
928 | char *gitstrdup(const char *s); | |
929 | #endif | |
b21b9f1d | 930 | |
40036bed MK |
931 | #ifdef NO_GETPAGESIZE |
932 | #define getpagesize() sysconf(_SC_PAGESIZE) | |
933 | #endif | |
934 | ||
05d1ed61 BW |
935 | #ifndef O_CLOEXEC |
936 | #define O_CLOEXEC 0 | |
937 | #endif | |
938 | ||
cba22528 | 939 | #ifdef FREAD_READS_DIRECTORIES |
b0a642ac RJ |
940 | # if !defined(SUPPRESS_FOPEN_REDEFINITION) |
941 | # ifdef fopen | |
942 | # undef fopen | |
943 | # endif | |
944 | # define fopen(a,b) git_fopen(a,b) | |
945 | # endif | |
55454427 | 946 | FILE *git_fopen(const char*, const char*); |
cba22528 BC |
947 | #endif |
948 | ||
c4582f93 | 949 | #ifdef SNPRINTF_RETURNS_BOGUS |
ab03803c BS |
950 | #ifdef snprintf |
951 | #undef snprintf | |
952 | #endif | |
c4582f93 | 953 | #define snprintf git_snprintf |
b199d714 | 954 | int git_snprintf(char *str, size_t maxsize, |
ad6dad09 | 955 | const char *format, ...); |
ab03803c BS |
956 | #ifdef vsnprintf |
957 | #undef vsnprintf | |
958 | #endif | |
c4582f93 | 959 | #define vsnprintf git_vsnprintf |
55454427 | 960 | int git_vsnprintf(char *str, size_t maxsize, |
ad6dad09 | 961 | const char *format, va_list ap); |
c4582f93 MR |
962 | #endif |
963 | ||
2b081012 JK |
964 | #ifdef OPEN_RETURNS_EINTR |
965 | #undef open | |
966 | #define open git_open_with_retry | |
967 | int git_open_with_retry(const char *path, int flag, ...); | |
968 | #endif | |
969 | ||
726c8ef5 JS |
970 | #ifdef __GLIBC_PREREQ |
971 | #if __GLIBC_PREREQ(2, 1) | |
972 | #define HAVE_STRCHRNUL | |
973 | #endif | |
974 | #endif | |
975 | ||
976 | #ifndef HAVE_STRCHRNUL | |
659c69cf | 977 | #define strchrnul gitstrchrnul |
9e79f00f AE |
978 | static inline char *gitstrchrnul(const char *s, int c) |
979 | { | |
980 | while (*s && *s != c) | |
981 | s++; | |
982 | return (char *)s; | |
983 | } | |
659c69cf RS |
984 | #endif |
985 | ||
da523cc5 MP |
986 | #ifdef NO_INET_PTON |
987 | int inet_pton(int af, const char *src, void *dst); | |
988 | #endif | |
989 | ||
990 | #ifdef NO_INET_NTOP | |
991 | const char *inet_ntop(int af, const void *src, char *dst, size_t size); | |
992 | #endif | |
993 | ||
0f4b6db3 EB |
994 | #ifdef NO_PTHREADS |
995 | #define atexit git_atexit | |
55454427 | 996 | int git_atexit(void (*handler)(void)); |
0f4b6db3 EB |
997 | #endif |
998 | ||
320d0b49 JK |
999 | static inline size_t st_add(size_t a, size_t b) |
1000 | { | |
1001 | if (unsigned_add_overflows(a, b)) | |
1002 | die("size_t overflow: %"PRIuMAX" + %"PRIuMAX, | |
1003 | (uintmax_t)a, (uintmax_t)b); | |
1004 | return a + b; | |
1005 | } | |
d616fbf2 ES |
1006 | #define st_add3(a,b,c) st_add(st_add((a),(b)),(c)) |
1007 | #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d)) | |
320d0b49 JK |
1008 | |
1009 | static inline size_t st_mult(size_t a, size_t b) | |
1010 | { | |
1011 | if (unsigned_mult_overflows(a, b)) | |
1012 | die("size_t overflow: %"PRIuMAX" * %"PRIuMAX, | |
1013 | (uintmax_t)a, (uintmax_t)b); | |
1014 | return a * b; | |
1015 | } | |
1016 | ||
1017 | static inline size_t st_sub(size_t a, size_t b) | |
1018 | { | |
1019 | if (a < b) | |
1020 | die("size_t underflow: %"PRIuMAX" - %"PRIuMAX, | |
1021 | (uintmax_t)a, (uintmax_t)b); | |
1022 | return a - b; | |
1023 | } | |
a9a74636 | 1024 | |
e2ffeae3 JS |
1025 | static inline size_t st_left_shift(size_t a, unsigned shift) |
1026 | { | |
1027 | if (unsigned_left_shift_overflows(a, shift)) | |
1028 | die("size_t overflow: %"PRIuMAX" << %u", | |
1029 | (uintmax_t)a, shift); | |
1030 | return a << shift; | |
1031 | } | |
1032 | ||
1033 | static inline unsigned long cast_size_t_to_ulong(size_t a) | |
1034 | { | |
1035 | if (a != (unsigned long)a) | |
1036 | die("object too large to read on this platform: %" | |
1037 | PRIuMAX" is cut off to %lu", | |
1038 | (uintmax_t)a, (unsigned long)a); | |
1039 | return (unsigned long)a; | |
1040 | } | |
1041 | ||
48050c42 PS |
1042 | static inline int cast_size_t_to_int(size_t a) |
1043 | { | |
1044 | if (a > INT_MAX) | |
1045 | die("number too large to represent as int on this platform: %"PRIuMAX, | |
1046 | (uintmax_t)a); | |
1047 | return (int)a; | |
1048 | } | |
1049 | ||
ec4f39b2 JK |
1050 | /* |
1051 | * Limit size of IO chunks, because huge chunks only cause pain. OS X | |
1052 | * 64-bit is buggy, returning EINVAL if len >= INT_MAX; and even in | |
1053 | * the absence of bugs, large chunks can result in bad latencies when | |
1054 | * you decide to kill the process. | |
1055 | * | |
1056 | * We pick 8 MiB as our default, but if the platform defines SSIZE_MAX | |
1057 | * that is smaller than that, clip it to SSIZE_MAX, as a call to | |
1058 | * read(2) or write(2) larger than that is allowed to fail. As the last | |
1059 | * resort, we allow a port to pass via CFLAGS e.g. "-DMAX_IO_SIZE=value" | |
1060 | * to override this, if the definition of SSIZE_MAX given by the platform | |
1061 | * is broken. | |
1062 | */ | |
1063 | #ifndef MAX_IO_SIZE | |
1064 | # define MAX_IO_SIZE_DEFAULT (8*1024*1024) | |
1065 | # if defined(SSIZE_MAX) && (SSIZE_MAX < MAX_IO_SIZE_DEFAULT) | |
1066 | # define MAX_IO_SIZE SSIZE_MAX | |
1067 | # else | |
1068 | # define MAX_IO_SIZE MAX_IO_SIZE_DEFAULT | |
1069 | # endif | |
1070 | #endif | |
1071 | ||
61f76a36 KS |
1072 | #ifdef HAVE_ALLOCA_H |
1073 | # include <alloca.h> | |
1074 | # define xalloca(size) (alloca(size)) | |
1075 | # define xalloca_free(p) do {} while (0) | |
1076 | #else | |
1077 | # define xalloca(size) (xmalloc(size)) | |
1078 | # define xalloca_free(p) (free(p)) | |
1079 | #endif | |
55454427 DL |
1080 | char *xstrdup(const char *str); |
1081 | void *xmalloc(size_t size); | |
1082 | void *xmallocz(size_t size); | |
1083 | void *xmallocz_gently(size_t size); | |
1084 | void *xmemdupz(const void *data, size_t len); | |
1085 | char *xstrndup(const char *str, size_t len); | |
1086 | void *xrealloc(void *ptr, size_t size); | |
1087 | void *xcalloc(size_t nmemb, size_t size); | |
3540c71e | 1088 | void xsetenv(const char *name, const char *value, int overwrite); |
55454427 | 1089 | void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset); |
dc059294 | 1090 | const char *mmap_os_err(void); |
55454427 | 1091 | void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset); |
b199d714 | 1092 | int xopen(const char *path, int flags, ...); |
55454427 DL |
1093 | ssize_t xread(int fd, void *buf, size_t len); |
1094 | ssize_t xwrite(int fd, const void *buf, size_t len); | |
1095 | ssize_t xpread(int fd, void *buf, size_t len, off_t offset); | |
1096 | int xdup(int fd); | |
1097 | FILE *xfopen(const char *path, const char *mode); | |
1098 | FILE *xfdopen(int fd, const char *mode); | |
1099 | int xmkstemp(char *temp_filename); | |
1100 | int xmkstemp_mode(char *temp_filename, int mode); | |
1101 | char *xgetcwd(void); | |
1102 | FILE *fopen_for_writing(const char *path); | |
1103 | FILE *fopen_or_warn(const char *path, const char *mode); | |
f21a47b2 | 1104 | |
14570dc6 | 1105 | /* |
1106 | * Like strncmp, but only return zero if s is NUL-terminated and exactly len | |
1107 | * characters long. If it is not, consider it greater than t. | |
1108 | */ | |
1109 | int xstrncmpz(const char *s, const char *t, size_t len); | |
1110 | ||
481df65f ÆAB |
1111 | /* |
1112 | * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note | |
1113 | * that ptr is used twice, so don't pass e.g. ptr++. | |
1114 | */ | |
1115 | #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0) | |
1116 | ||
e7792a74 | 1117 | #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc))) |
f1121499 | 1118 | #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x))) |
e7792a74 | 1119 | #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc))) |
3ac22f82 | 1120 | |
60566cbb | 1121 | #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \ |
1891846f | 1122 | BARF_UNLESS_COPYABLE((dst), (src))) |
60566cbb RS |
1123 | static inline void copy_array(void *dst, const void *src, size_t n, size_t size) |
1124 | { | |
1125 | if (n) | |
1126 | memcpy(dst, src, st_mult(size, n)); | |
1127 | } | |
1128 | ||
57839807 | 1129 | #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \ |
1891846f | 1130 | BARF_UNLESS_COPYABLE((dst), (src))) |
57839807 RS |
1131 | static inline void move_array(void *dst, const void *src, size_t n, size_t size) |
1132 | { | |
1133 | if (n) | |
1134 | memmove(dst, src, st_mult(size, n)); | |
1135 | } | |
1136 | ||
d2ec87a6 RS |
1137 | #define DUP_ARRAY(dst, src, n) do { \ |
1138 | size_t dup_array_n_ = (n); \ | |
1139 | COPY_ARRAY(ALLOC_ARRAY((dst), dup_array_n_), (src), dup_array_n_); \ | |
1140 | } while (0) | |
1141 | ||
36895391 JK |
1142 | /* |
1143 | * These functions help you allocate structs with flex arrays, and copy | |
1144 | * the data directly into the array. For example, if you had: | |
1145 | * | |
1146 | * struct foo { | |
1147 | * int bar; | |
1148 | * char name[FLEX_ARRAY]; | |
1149 | * }; | |
1150 | * | |
1151 | * you can do: | |
1152 | * | |
1153 | * struct foo *f; | |
1154 | * FLEX_ALLOC_MEM(f, name, src, len); | |
1155 | * | |
1156 | * to allocate a "foo" with the contents of "src" in the "name" field. | |
1157 | * The resulting struct is automatically zero'd, and the flex-array field | |
1158 | * is NUL-terminated (whether the incoming src buffer was or not). | |
1159 | * | |
1160 | * The FLEXPTR_* variants operate on structs that don't use flex-arrays, | |
1161 | * but do want to store a pointer to some extra data in the same allocated | |
1162 | * block. For example, if you have: | |
1163 | * | |
1164 | * struct foo { | |
1165 | * char *name; | |
1166 | * int bar; | |
1167 | * }; | |
1168 | * | |
1169 | * you can do: | |
1170 | * | |
1171 | * struct foo *f; | |
0bb1519f | 1172 | * FLEXPTR_ALLOC_STR(f, name, src); |
36895391 JK |
1173 | * |
1174 | * and "name" will point to a block of memory after the struct, which will be | |
1175 | * freed along with the struct (but the pointer can be repointed anywhere). | |
1176 | * | |
1177 | * The *_STR variants accept a string parameter rather than a ptr/len | |
1178 | * combination. | |
1179 | * | |
1180 | * Note that these macros will evaluate the first parameter multiple | |
1181 | * times, and it must be assignable as an lvalue. | |
1182 | */ | |
1183 | #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \ | |
e9451782 RS |
1184 | size_t flex_array_len_ = (len); \ |
1185 | (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \ | |
1186 | memcpy((void *)(x)->flexname, (buf), flex_array_len_); \ | |
36895391 JK |
1187 | } while (0) |
1188 | #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \ | |
0ac52a38 RS |
1189 | size_t flex_array_len_ = (len); \ |
1190 | (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \ | |
1191 | memcpy((x) + 1, (buf), flex_array_len_); \ | |
36895391 JK |
1192 | (x)->ptrname = (void *)((x)+1); \ |
1193 | } while(0) | |
1194 | #define FLEX_ALLOC_STR(x, flexname, str) \ | |
1195 | FLEX_ALLOC_MEM((x), flexname, (str), strlen(str)) | |
1196 | #define FLEXPTR_ALLOC_STR(x, ptrname, str) \ | |
1197 | FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str)) | |
1198 | ||
d64ea0f8 JK |
1199 | static inline char *xstrdup_or_null(const char *str) |
1200 | { | |
1201 | return str ? xstrdup(str) : NULL; | |
1202 | } | |
1203 | ||
dc49cd76 SP |
1204 | static inline size_t xsize_t(off_t len) |
1205 | { | |
aafa5df0 | 1206 | if (len < 0 || (uintmax_t) len > SIZE_MAX) |
46be82df | 1207 | die("Cannot handle files this big"); |
aafa5df0 | 1208 | return (size_t) len; |
dc49cd76 SP |
1209 | } |
1210 | ||
7b03c89e | 1211 | __attribute__((format (printf, 3, 4))) |
b199d714 | 1212 | int xsnprintf(char *dst, size_t max, const char *fmt, ...); |
7b03c89e | 1213 | |
da25bdb7 RS |
1214 | #ifndef HOST_NAME_MAX |
1215 | #define HOST_NAME_MAX 256 | |
1216 | #endif | |
1217 | ||
55454427 | 1218 | int xgethostname(char *buf, size_t len); |
5781a9a2 | 1219 | |
f1589d10 | 1220 | /* in ctype.c, for kwset users */ |
189c860c | 1221 | extern const unsigned char tolower_trans_tbl[256]; |
f1589d10 | 1222 | |
4050c0df | 1223 | /* Sane ctype - no locale, and works with signed chars */ |
c2e9364a | 1224 | #undef isascii |
4050c0df JH |
1225 | #undef isspace |
1226 | #undef isdigit | |
1227 | #undef isalpha | |
1228 | #undef isalnum | |
0fcec2ce | 1229 | #undef isprint |
43ccdf56 NK |
1230 | #undef islower |
1231 | #undef isupper | |
4050c0df JH |
1232 | #undef tolower |
1233 | #undef toupper | |
1c149ab2 NTND |
1234 | #undef iscntrl |
1235 | #undef ispunct | |
1236 | #undef isxdigit | |
2adf7247 | 1237 | |
ca5ab7d1 | 1238 | extern const unsigned char sane_ctype[256]; |
b73ecb48 | 1239 | extern const signed char hexval_table[256]; |
4050c0df JH |
1240 | #define GIT_SPACE 0x01 |
1241 | #define GIT_DIGIT 0x02 | |
1242 | #define GIT_ALPHA 0x04 | |
8cc32992 | 1243 | #define GIT_GLOB_SPECIAL 0x08 |
f9b7cce6 | 1244 | #define GIT_REGEX_SPECIAL 0x10 |
2f6c9760 | 1245 | #define GIT_PATHSPEC_MAGIC 0x20 |
1c149ab2 NTND |
1246 | #define GIT_CNTRL 0x40 |
1247 | #define GIT_PUNCT 0x80 | |
4050c0df | 1248 | #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0) |
c2e9364a | 1249 | #define isascii(x) (((x) & ~0x7f) == 0) |
4050c0df JH |
1250 | #define isspace(x) sane_istest(x,GIT_SPACE) |
1251 | #define isdigit(x) sane_istest(x,GIT_DIGIT) | |
1252 | #define isalpha(x) sane_istest(x,GIT_ALPHA) | |
1253 | #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT) | |
0fcec2ce | 1254 | #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e) |
43ccdf56 NK |
1255 | #define islower(x) sane_iscase(x, 1) |
1256 | #define isupper(x) sane_iscase(x, 0) | |
8cc32992 | 1257 | #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL) |
f9b7cce6 | 1258 | #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL) |
1c149ab2 NTND |
1259 | #define iscntrl(x) (sane_istest(x,GIT_CNTRL)) |
1260 | #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \ | |
1261 | GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC) | |
50a71776 | 1262 | #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1) |
4050c0df JH |
1263 | #define tolower(x) sane_case((unsigned char)(x), 0x20) |
1264 | #define toupper(x) sane_case((unsigned char)(x), 0) | |
2f6c9760 | 1265 | #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC) |
4050c0df JH |
1266 | |
1267 | static inline int sane_case(int x, int high) | |
1268 | { | |
1269 | if (sane_istest(x, GIT_ALPHA)) | |
1270 | x = (x & ~0x20) | high; | |
1271 | return x; | |
1272 | } | |
1273 | ||
43ccdf56 NK |
1274 | static inline int sane_iscase(int x, int is_lower) |
1275 | { | |
1276 | if (!sane_istest(x, GIT_ALPHA)) | |
1277 | return 0; | |
1278 | ||
1279 | if (is_lower) | |
1280 | return (x & 0x20) != 0; | |
1281 | else | |
1282 | return (x & 0x20) == 0; | |
1283 | } | |
1284 | ||
41a80924 JK |
1285 | /* |
1286 | * Like skip_prefix, but compare case-insensitively. Note that the comparison | |
1287 | * is done via tolower(), so it is strictly ASCII (no multi-byte characters or | |
1288 | * locale-specific conversions). | |
1289 | */ | |
1290 | static inline int skip_iprefix(const char *str, const char *prefix, | |
1291 | const char **out) | |
1292 | { | |
1293 | do { | |
1294 | if (!*prefix) { | |
1295 | *out = str; | |
1296 | return 1; | |
1297 | } | |
1298 | } while (tolower(*str++) == tolower(*prefix++)); | |
1299 | return 0; | |
1300 | } | |
1301 | ||
6b8dda9a MJC |
1302 | /* |
1303 | * Like skip_prefix_mem, but compare case-insensitively. Note that the | |
1304 | * comparison is done via tolower(), so it is strictly ASCII (no multi-byte | |
1305 | * characters or locale-specific conversions). | |
1306 | */ | |
1307 | static inline int skip_iprefix_mem(const char *buf, size_t len, | |
1308 | const char *prefix, | |
1309 | const char **out, size_t *outlen) | |
1310 | { | |
1311 | do { | |
1312 | if (!*prefix) { | |
1313 | *out = buf; | |
1314 | *outlen = len; | |
1315 | return 1; | |
1316 | } | |
1317 | } while (len-- > 0 && tolower(*buf++) == tolower(*prefix++)); | |
1318 | return 0; | |
1319 | } | |
1320 | ||
6aead43d JM |
1321 | static inline int strtoul_ui(char const *s, int base, unsigned int *result) |
1322 | { | |
1323 | unsigned long ul; | |
1324 | char *p; | |
1325 | ||
1326 | errno = 0; | |
e6f2599c MM |
1327 | /* negative values would be accepted by strtoul */ |
1328 | if (strchr(s, '-')) | |
1329 | return -1; | |
6aead43d JM |
1330 | ul = strtoul(s, &p, base); |
1331 | if (errno || *p || p == s || (unsigned int) ul != ul) | |
1332 | return -1; | |
1333 | *result = ul; | |
1334 | return 0; | |
1335 | } | |
1336 | ||
7791ecbc JH |
1337 | static inline int strtol_i(char const *s, int base, int *result) |
1338 | { | |
1339 | long ul; | |
1340 | char *p; | |
1341 | ||
1342 | errno = 0; | |
1343 | ul = strtol(s, &p, base); | |
1344 | if (errno || *p || p == s || (int) ul != ul) | |
1345 | return -1; | |
1346 | *result = ul; | |
1347 | return 0; | |
1348 | } | |
1349 | ||
97fff610 JS |
1350 | void git_stable_qsort(void *base, size_t nmemb, size_t size, |
1351 | int(*compar)(const void *, const void *)); | |
43fe901b | 1352 | #ifdef INTERNAL_QSORT |
97fff610 | 1353 | #define qsort git_stable_qsort |
43fe901b BD |
1354 | #endif |
1355 | ||
dbc540c7 RS |
1356 | #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar) |
1357 | static inline void sane_qsort(void *base, size_t nmemb, size_t size, | |
1358 | int(*compar)(const void *, const void *)) | |
1359 | { | |
1360 | if (nmemb > 1) | |
1361 | qsort(base, nmemb, size, compar); | |
1362 | } | |
1363 | ||
97fff610 JS |
1364 | #define STABLE_QSORT(base, n, compar) \ |
1365 | git_stable_qsort((base), (n), sizeof(*(base)), compar) | |
1366 | ||
04ee8b87 RS |
1367 | #ifndef HAVE_ISO_QSORT_S |
1368 | int git_qsort_s(void *base, size_t nmemb, size_t size, | |
1369 | int (*compar)(const void *, const void *, void *), void *ctx); | |
1370 | #define qsort_s git_qsort_s | |
1371 | #endif | |
1372 | ||
3ca86994 RS |
1373 | #define QSORT_S(base, n, compar, ctx) do { \ |
1374 | if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \ | |
c3c3486b | 1375 | BUG("qsort_s() failed"); \ |
3ca86994 RS |
1376 | } while (0) |
1377 | ||
2f895225 JS |
1378 | #ifndef REG_STARTEND |
1379 | #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd" | |
1380 | #endif | |
1381 | ||
1382 | static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size, | |
1383 | size_t nmatch, regmatch_t pmatch[], int eflags) | |
1384 | { | |
1385 | assert(nmatch > 0 && pmatch); | |
1386 | pmatch[0].rm_so = 0; | |
1387 | pmatch[0].rm_eo = size; | |
1388 | return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND); | |
1389 | } | |
1390 | ||
54463d32 RS |
1391 | #ifdef USE_ENHANCED_BASIC_REGULAR_EXPRESSIONS |
1392 | int git_regcomp(regex_t *preg, const char *pattern, int cflags); | |
1393 | #define regcomp git_regcomp | |
1394 | #endif | |
1395 | ||
81a24b52 AR |
1396 | #ifndef DIR_HAS_BSD_GROUP_SEMANTICS |
1397 | # define FORCE_DIR_SET_GID S_ISGID | |
1398 | #else | |
1399 | # define FORCE_DIR_SET_GID 0 | |
1400 | #endif | |
1401 | ||
c06ff490 KB |
1402 | #ifdef NO_NSEC |
1403 | #undef USE_NSEC | |
1404 | #define ST_CTIME_NSEC(st) 0 | |
1405 | #define ST_MTIME_NSEC(st) 0 | |
1406 | #else | |
c567383b BG |
1407 | #ifdef USE_ST_TIMESPEC |
1408 | #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec)) | |
1409 | #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec)) | |
1410 | #else | |
c06ff490 KB |
1411 | #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec)) |
1412 | #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec)) | |
1413 | #endif | |
c567383b | 1414 | #endif |
c06ff490 | 1415 | |
34779c53 JS |
1416 | #ifdef UNRELIABLE_FSTAT |
1417 | #define fstat_is_reliable() 0 | |
1418 | #else | |
1419 | #define fstat_is_reliable() 1 | |
1420 | #endif | |
1421 | ||
ab8632ae | 1422 | #ifndef va_copy |
26db0f2e JN |
1423 | /* |
1424 | * Since an obvious implementation of va_list would be to make it a | |
1425 | * pointer into the stack frame, a simple assignment will work on | |
1426 | * many systems. But let's try to be more portable. | |
1427 | */ | |
1428 | #ifdef __va_copy | |
1429 | #define va_copy(dst, src) __va_copy(dst, src) | |
1430 | #else | |
1431 | #define va_copy(dst, src) ((dst) = (src)) | |
1432 | #endif | |
ab8632ae JK |
1433 | #endif |
1434 | ||
746ea4ad RJ |
1435 | /* usage.c: only to be used for testing BUG() implementation (see test-tool) */ |
1436 | extern int BUG_exit_code; | |
1437 | ||
0cc05b04 ÆAB |
1438 | /* usage.c: if bug() is called we should have a BUG_if_bug() afterwards */ |
1439 | extern int bug_called_must_BUG; | |
1440 | ||
d8193743 JK |
1441 | __attribute__((format (printf, 3, 4))) NORETURN |
1442 | void BUG_fl(const char *file, int line, const char *fmt, ...); | |
1443 | #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__) | |
0cc05b04 ÆAB |
1444 | __attribute__((format (printf, 3, 4))) |
1445 | void bug_fl(const char *file, int line, const char *fmt, ...); | |
1446 | #define bug(...) bug_fl(__FILE__, __LINE__, __VA_ARGS__) | |
1447 | #define BUG_if_bug(...) do { \ | |
1448 | if (bug_called_must_BUG) \ | |
1449 | BUG_fl(__FILE__, __LINE__, __VA_ARGS__); \ | |
1450 | } while (0) | |
d8193743 | 1451 | |
8a94d833 | 1452 | #ifndef FSYNC_METHOD_DEFAULT |
abf38abe NS |
1453 | #ifdef __APPLE__ |
1454 | #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_WRITEOUT_ONLY | |
1455 | #else | |
1456 | #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_FSYNC | |
1457 | #endif | |
8a94d833 | 1458 | #endif |
abf38abe NS |
1459 | |
1460 | enum fsync_action { | |
1461 | FSYNC_WRITEOUT_ONLY, | |
1462 | FSYNC_HARDWARE_FLUSH | |
1463 | }; | |
1464 | ||
1465 | /* | |
1466 | * Issues an fsync against the specified file according to the specified mode. | |
1467 | * | |
1468 | * FSYNC_WRITEOUT_ONLY attempts to use interfaces available on some operating | |
1469 | * systems to flush the OS cache without issuing a flush command to the storage | |
1470 | * controller. If those interfaces are unavailable, the function fails with | |
1471 | * ENOSYS. | |
1472 | * | |
1473 | * FSYNC_HARDWARE_FLUSH does an OS writeout and hardware flush to ensure that | |
1474 | * changes are durable. It is not expected to fail. | |
1475 | */ | |
1476 | int git_fsync(int fd, enum fsync_action action); | |
1477 | ||
9a498767 NS |
1478 | /* |
1479 | * Writes out trace statistics for fsync using the trace2 API. | |
1480 | */ | |
1481 | void trace_git_fsync_stats(void); | |
1482 | ||
fc71db39 AR |
1483 | /* |
1484 | * Preserves errno, prints a message, but gives no warning for ENOENT. | |
1054af7d RS |
1485 | * Returns 0 on success, which includes trying to unlink an object that does |
1486 | * not exist. | |
fc71db39 AR |
1487 | */ |
1488 | int unlink_or_warn(const char *path); | |
9ccc0c08 RS |
1489 | /* |
1490 | * Tries to unlink file. Returns 0 if unlink succeeded | |
1491 | * or the file already didn't exist. Returns -1 and | |
1492 | * appends a message to err suitable for | |
1493 | * 'error("%s", err->buf)' on error. | |
1494 | */ | |
1495 | int unlink_or_msg(const char *file, struct strbuf *err); | |
d1723296 | 1496 | /* |
1054af7d RS |
1497 | * Preserves errno, prints a message, but gives no warning for ENOENT. |
1498 | * Returns 0 on success, which includes trying to remove a directory that does | |
1499 | * not exist. | |
d1723296 PC |
1500 | */ |
1501 | int rmdir_or_warn(const char *path); | |
80d706af PC |
1502 | /* |
1503 | * Calls the correct function out of {unlink,rmdir}_or_warn based on | |
1504 | * the supplied file mode. | |
1505 | */ | |
1506 | int remove_or_warn(unsigned int mode, const char *path); | |
fc71db39 | 1507 | |
e5c52c98 JN |
1508 | /* |
1509 | * Call access(2), but warn for any error except "missing file" | |
1510 | * (ENOENT or ENOTDIR). | |
1511 | */ | |
4698c8fe JN |
1512 | #define ACCESS_EACCES_OK (1U << 0) |
1513 | int access_or_warn(const char *path, int mode, unsigned flag); | |
1514 | int access_or_die(const char *path, int mode, unsigned flag); | |
ba8bd830 | 1515 | |
11dc1fcb NTND |
1516 | /* Warn on an inaccessible file if errno indicates this is an error */ |
1517 | int warn_on_fopen_errors(const char *path); | |
55b38a48 | 1518 | |
00611d84 JK |
1519 | /* |
1520 | * Open with O_NOFOLLOW, or equivalent. Note that the fallback equivalent | |
1521 | * may be racy. Do not use this as protection against an attacker who can | |
1522 | * simultaneously create paths. | |
1523 | */ | |
1524 | int open_nofollow(const char *path, int flags); | |
1525 | ||
1b56cdf9 KM |
1526 | #ifndef SHELL_PATH |
1527 | # define SHELL_PATH "/bin/sh" | |
1528 | #endif | |
1529 | ||
f43cce23 | 1530 | #ifndef _POSIX_THREAD_SAFE_FUNCTIONS |
efcc48ef | 1531 | static inline void git_flockfile(FILE *fh UNUSED) |
15b52a44 JH |
1532 | { |
1533 | ; /* nothing */ | |
1534 | } | |
efcc48ef | 1535 | static inline void git_funlockfile(FILE *fh UNUSED) |
15b52a44 JH |
1536 | { |
1537 | ; /* nothing */ | |
1538 | } | |
e1a95b78 JK |
1539 | #undef flockfile |
1540 | #undef funlockfile | |
1541 | #undef getc_unlocked | |
e0c08a4f JK |
1542 | #define flockfile(fh) git_flockfile(fh) |
1543 | #define funlockfile(fh) git_funlockfile(fh) | |
f43cce23 JK |
1544 | #define getc_unlocked(fh) getc(fh) |
1545 | #endif | |
1546 | ||
18a4f6be NTND |
1547 | #ifdef FILENO_IS_A_MACRO |
1548 | int git_fileno(FILE *stream); | |
400caafb | 1549 | # ifndef COMPAT_CODE_FILENO |
18a4f6be NTND |
1550 | # undef fileno |
1551 | # define fileno(p) git_fileno(p) | |
1552 | # endif | |
1553 | #endif | |
1554 | ||
400caafb CC |
1555 | #ifdef NEED_ACCESS_ROOT_HANDLER |
1556 | int git_access(const char *path, int mode); | |
1557 | # ifndef COMPAT_CODE_ACCESS | |
1558 | # ifdef access | |
1559 | # undef access | |
1560 | # endif | |
1561 | # define access(path, mode) git_access(path, mode) | |
1562 | # endif | |
1563 | #endif | |
1564 | ||
dc5a18b3 JH |
1565 | /* |
1566 | * Our code often opens a path to an optional file, to work on its | |
1567 | * contents when we can successfully open it. We can ignore a failure | |
1568 | * to open if such an optional file does not exist, but we do want to | |
1569 | * report a failure in opening for other reasons (e.g. we got an I/O | |
1570 | * error, or the file is there, but we lack the permission to open). | |
1571 | * | |
1572 | * Call this function after seeing an error from open() or fopen() to | |
1573 | * see if the errno indicates a missing file that we can safely ignore. | |
1574 | */ | |
1575 | static inline int is_missing_file_error(int errno_) | |
1576 | { | |
1577 | return (errno_ == ENOENT || errno_ == ENOTDIR); | |
1578 | } | |
1579 | ||
55454427 | 1580 | int cmd_main(int, const char **); |
5c238e29 | 1581 | |
ee4512ed JH |
1582 | /* |
1583 | * Intercept all calls to exit() and route them to trace2 to | |
1584 | * optionally emit a message before calling the real exit(). | |
1585 | */ | |
19d75948 ÆAB |
1586 | int common_exit(const char *file, int line, int code); |
1587 | #define exit(code) exit(common_exit(__FILE__, __LINE__, (code))) | |
ee4512ed | 1588 | |
0e5bba53 JK |
1589 | /* |
1590 | * You can mark a stack variable with UNLEAK(var) to avoid it being | |
1591 | * reported as a leak by tools like LSAN or valgrind. The argument | |
1592 | * should generally be the variable itself (not its address and not what | |
1593 | * it points to). It's safe to use this on pointers which may already | |
1594 | * have been freed, or on pointers which may still be in use. | |
1595 | * | |
1596 | * Use this _only_ for a variable that leaks by going out of scope at | |
1597 | * program exit (so only from cmd_* functions or their direct helpers). | |
1598 | * Normal functions, especially those which may be called multiple | |
1599 | * times, should actually free their memory. This is only meant as | |
1600 | * an annotation, and does nothing in non-leak-checking builds. | |
1601 | */ | |
1602 | #ifdef SUPPRESS_ANNOTATED_LEAKS | |
55454427 | 1603 | void unleak_memory(const void *ptr, size_t len); |
5de3de32 | 1604 | #define UNLEAK(var) unleak_memory(&(var), sizeof(var)) |
0e5bba53 | 1605 | #else |
5de3de32 | 1606 | #define UNLEAK(var) do {} while (0) |
0e5bba53 JK |
1607 | #endif |
1608 | ||
07564773 ÆAB |
1609 | #define z_const |
1610 | #include <zlib.h> | |
1611 | ||
1612 | #if ZLIB_VERNUM < 0x1290 | |
1613 | /* | |
1614 | * This is uncompress2, which is only available in zlib >= 1.2.9 | |
1615 | * (released as of early 2017). See compat/zlib-uncompress2.c. | |
1616 | */ | |
1617 | int uncompress2(Bytef *dest, uLongf *destLen, const Bytef *source, | |
1618 | uLong *sourceLen); | |
1619 | #endif | |
1620 | ||
c8af66ab JK |
1621 | /* |
1622 | * This include must come after system headers, since it introduces macros that | |
1623 | * replace system names. | |
1624 | */ | |
1625 | #include "banned.h" | |
1626 | ||
973d5eea EW |
1627 | /* |
1628 | * container_of - Get the address of an object containing a field. | |
1629 | * | |
1630 | * @ptr: pointer to the field. | |
1631 | * @type: type of the object. | |
1632 | * @member: name of the field within the object. | |
1633 | */ | |
1634 | #define container_of(ptr, type, member) \ | |
1635 | ((type *) ((char *)(ptr) - offsetof(type, member))) | |
1636 | ||
f0e63c41 EW |
1637 | /* |
1638 | * helper function for `container_of_or_null' to avoid multiple | |
1639 | * evaluation of @ptr | |
1640 | */ | |
1641 | static inline void *container_of_or_null_offset(void *ptr, size_t offset) | |
1642 | { | |
1643 | return ptr ? (char *)ptr - offset : NULL; | |
1644 | } | |
1645 | ||
1646 | /* | |
1647 | * like `container_of', but allows returned value to be NULL | |
1648 | */ | |
1649 | #define container_of_or_null(ptr, type, member) \ | |
1650 | (type *)container_of_or_null_offset(ptr, offsetof(type, member)) | |
1651 | ||
23dee69f | 1652 | /* |
abcb66c6 | 1653 | * like offsetof(), but takes a pointer to a variable of type which |
23dee69f EW |
1654 | * contains @member, instead of a specified type. |
1655 | * @ptr is subject to multiple evaluation since we can't rely on __typeof__ | |
1656 | * everywhere. | |
1657 | */ | |
1658 | #if defined(__GNUC__) /* clang sets this, too */ | |
1659 | #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member) | |
1660 | #else /* !__GNUC__ */ | |
1661 | #define OFFSETOF_VAR(ptr, member) \ | |
1662 | ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr)) | |
1663 | #endif /* !__GNUC__ */ | |
1664 | ||
a76b138d HWN |
1665 | void sleep_millisec(int millisec); |
1666 | ||
05cd988d | 1667 | /* |
1668 | * Generate len bytes from the system cryptographically secure PRNG. | |
1669 | * Returns 0 on success and -1 on error, setting errno. The inability to | |
1670 | * satisfy the full request is an error. | |
1671 | */ | |
1672 | int csprng_bytes(void *buf, size_t len); | |
1673 | ||
5c238e29 | 1674 | #endif |