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