]>
Commit | Line | Data |
---|---|---|
1 | #ifndef GIT_COMPAT_UTIL_H | |
2 | #define GIT_COMPAT_UTIL_H | |
3 | ||
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 | ||
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 | ||
26 | struct strbuf; | |
27 | ||
28 | ||
29 | #define _FILE_OFFSET_BITS 64 | |
30 | ||
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 | ||
48 | #ifndef FLEX_ARRAY | |
49 | /* | |
50 | * See if our compiler is known to support flexible array members. | |
51 | */ | |
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) | |
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 | |
67 | #elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) | |
68 | # define FLEX_ARRAY /* empty */ | |
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 | |
76 | #endif | |
77 | #endif | |
78 | ||
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 | ||
95 | #if GIT_GNUC_PREREQ(3, 1) | |
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]))) | |
100 | # define BARF_UNLESS_COPYABLE(dst, src) \ | |
101 | BUILD_ASSERT_OR_ZERO(__builtin_types_compatible_p(__typeof__(*(dst)), \ | |
102 | __typeof__(*(src)))) | |
103 | #else | |
104 | # define BARF_UNLESS_AN_ARRAY(arr) 0 | |
105 | # define BARF_UNLESS_COPYABLE(dst, src) \ | |
106 | BUILD_ASSERT_OR_ZERO(0 ? ((*(dst) = *(src)), 0) : \ | |
107 | sizeof(*(dst)) == sizeof(*(src))) | |
108 | #endif | |
109 | /* | |
110 | * ARRAY_SIZE - get the number of elements in a visible array | |
111 | * @x: the array whose size you want. | |
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 | ||
119 | #define bitsizeof(x) (CHAR_BIT * sizeof(x)) | |
120 | ||
121 | #define maximum_signed_value_of_type(a) \ | |
122 | (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a))) | |
123 | ||
124 | #define maximum_unsigned_value_of_type(a) \ | |
125 | (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a))) | |
126 | ||
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 | ||
136 | #define unsigned_add_overflows(a, b) \ | |
137 | ((b) > maximum_unsigned_value_of_type(a) - (a)) | |
138 | ||
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 | ||
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 | ||
155 | #ifdef __GNUC__ | |
156 | #define TYPEOF(x) (__typeof__(x)) | |
157 | #else | |
158 | #define TYPEOF(x) | |
159 | #endif | |
160 | ||
161 | #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits)))) | |
162 | #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */ | |
163 | ||
164 | #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d)) | |
165 | ||
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 | ||
169 | #ifdef __MINGW64__ | |
170 | #define _POSIX_C_SOURCE 1 | |
171 | #elif defined(__sun__) | |
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 | |
184 | #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \ | |
185 | !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \ | |
186 | !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \ | |
187 | !defined(__CYGWIN__) | |
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 */ | |
190 | #endif | |
191 | #define _ALL_SOURCE 1 | |
192 | #define _GNU_SOURCE 1 | |
193 | #define _BSD_SOURCE 1 | |
194 | #define _DEFAULT_SOURCE 1 | |
195 | #define _NETBSD_SOURCE 1 | |
196 | #define _SGI_SOURCE 1 | |
197 | ||
198 | #if GIT_GNUC_PREREQ(4, 5) | |
199 | #define UNUSED __attribute__((unused)) \ | |
200 | __attribute__((deprecated ("parameter declared as UNUSED"))) | |
201 | #elif defined(__GNUC__) | |
202 | #define UNUSED __attribute__((unused)) \ | |
203 | __attribute__((deprecated)) | |
204 | #else | |
205 | #define UNUSED | |
206 | #endif | |
207 | ||
208 | #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */ | |
209 | # if !defined(_WIN32_WINNT) | |
210 | # define _WIN32_WINNT 0x0600 | |
211 | # endif | |
212 | #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */ | |
213 | #include <winsock2.h> | |
214 | #ifndef NO_UNIX_SOCKETS | |
215 | #include <afunix.h> | |
216 | #endif | |
217 | #include <windows.h> | |
218 | #define GIT_WINDOWS_NATIVE | |
219 | #endif | |
220 | ||
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> | |
229 | #ifdef HAVE_STRINGS_H | |
230 | #include <strings.h> /* for strcasecmp() */ | |
231 | #endif | |
232 | #include <errno.h> | |
233 | #include <limits.h> | |
234 | #include <locale.h> | |
235 | #ifdef NEEDS_SYS_PARAM_H | |
236 | #include <sys/param.h> | |
237 | #endif | |
238 | #include <sys/types.h> | |
239 | #include <dirent.h> | |
240 | #include <sys/time.h> | |
241 | #include <time.h> | |
242 | #include <signal.h> | |
243 | #include <assert.h> | |
244 | #include <regex.h> | |
245 | #include <utime.h> | |
246 | #include <syslog.h> | |
247 | #if !defined(NO_POLL_H) | |
248 | #include <poll.h> | |
249 | #elif !defined(NO_SYS_POLL_H) | |
250 | #include <sys/poll.h> | |
251 | #else | |
252 | /* Pull the compat stuff */ | |
253 | #include <poll.h> | |
254 | #endif | |
255 | #ifdef HAVE_BSD_SYSCTL | |
256 | #include <sys/sysctl.h> | |
257 | #endif | |
258 | ||
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 | ||
265 | #if defined(__CYGWIN__) | |
266 | #include "compat/win32/path-utils.h" | |
267 | #endif | |
268 | #if defined(__MINGW32__) | |
269 | /* pull in Windows compatibility stuff */ | |
270 | #include "compat/win32/path-utils.h" | |
271 | #include "compat/mingw.h" | |
272 | #elif defined(_MSC_VER) | |
273 | #include "compat/win32/path-utils.h" | |
274 | #include "compat/msvc.h" | |
275 | #else | |
276 | #include <sys/utsname.h> | |
277 | #include <sys/wait.h> | |
278 | #include <sys/resource.h> | |
279 | #include <sys/socket.h> | |
280 | #include <sys/ioctl.h> | |
281 | #include <sys/statvfs.h> | |
282 | #include <termios.h> | |
283 | #ifndef NO_SYS_SELECT_H | |
284 | #include <sys/select.h> | |
285 | #endif | |
286 | #include <netinet/in.h> | |
287 | #include <netinet/tcp.h> | |
288 | #include <arpa/inet.h> | |
289 | #include <netdb.h> | |
290 | #include <pwd.h> | |
291 | #include <sys/un.h> | |
292 | #ifndef NO_INTTYPES_H | |
293 | #include <inttypes.h> | |
294 | #else | |
295 | #include <stdint.h> | |
296 | #endif | |
297 | #ifdef HAVE_ARC4RANDOM_LIBBSD | |
298 | #include <bsd/stdlib.h> | |
299 | #endif | |
300 | #ifdef HAVE_GETRANDOM | |
301 | #include <sys/random.h> | |
302 | #endif | |
303 | #ifdef NO_INTPTR_T | |
304 | /* | |
305 | * On I16LP32, ILP32 and LP64 "long" is the safe bet, however | |
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 | |
314 | #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */ | |
315 | #include <grp.h> | |
316 | #define _ALL_SOURCE 1 | |
317 | #endif | |
318 | ||
319 | /* used on Mac OS X */ | |
320 | #ifdef PRECOMPOSE_UNICODE | |
321 | #include "compat/precompose_utf8.h" | |
322 | #else | |
323 | static inline const char *precompose_argv_prefix(int argc UNUSED, | |
324 | const char **argv UNUSED, | |
325 | const char *prefix) | |
326 | { | |
327 | return prefix; | |
328 | } | |
329 | static inline const char *precompose_string_if_needed(const char *in) | |
330 | { | |
331 | return in; | |
332 | } | |
333 | ||
334 | #define probe_utf8_pathname_composition() | |
335 | #endif | |
336 | ||
337 | #ifdef MKDIR_WO_TRAILING_SLASH | |
338 | #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b)) | |
339 | int compat_mkdir_wo_trailing_slash(const char*, mode_t); | |
340 | #endif | |
341 | ||
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 | ||
361 | #ifdef NO_STRUCT_ITIMERVAL | |
362 | struct itimerval { | |
363 | struct timeval it_interval; | |
364 | struct timeval it_value; | |
365 | }; | |
366 | #endif | |
367 | ||
368 | #ifdef NO_SETITIMER | |
369 | static inline int git_setitimer(int which UNUSED, | |
370 | const struct itimerval *value UNUSED, | |
371 | struct itimerval *newvalue UNUSED) { | |
372 | return 0; /* pretend success */ | |
373 | } | |
374 | #undef setitimer | |
375 | #define setitimer(which,value,ovalue) git_setitimer(which,value,ovalue) | |
376 | #endif | |
377 | ||
378 | #ifndef NO_LIBGEN_H | |
379 | #include <libgen.h> | |
380 | #else | |
381 | #define basename gitbasename | |
382 | char *gitbasename(char *); | |
383 | #define dirname gitdirname | |
384 | char *gitdirname(char *); | |
385 | #endif | |
386 | ||
387 | #ifndef NO_ICONV | |
388 | #include <iconv.h> | |
389 | #endif | |
390 | ||
391 | #ifndef NO_OPENSSL | |
392 | #ifdef __APPLE__ | |
393 | #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0 | |
394 | #include <AvailabilityMacros.h> | |
395 | #undef DEPRECATED_ATTRIBUTE | |
396 | #define DEPRECATED_ATTRIBUTE | |
397 | #undef __AVAILABILITY_MACROS_USES_AVAILABILITY | |
398 | #endif | |
399 | #include <openssl/ssl.h> | |
400 | #include <openssl/err.h> | |
401 | #endif | |
402 | ||
403 | #ifdef HAVE_SYSINFO | |
404 | # include <sys/sysinfo.h> | |
405 | #endif | |
406 | ||
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 | ||
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 | ||
425 | typedef uintmax_t timestamp_t; | |
426 | #define PRItime PRIuMAX | |
427 | #define parse_timestamp strtoumax | |
428 | #define TIME_MAX UINTMAX_MAX | |
429 | #define TIME_MIN 0 | |
430 | ||
431 | #ifndef PATH_SEP | |
432 | #define PATH_SEP ':' | |
433 | #endif | |
434 | ||
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 | ||
442 | #ifndef platform_core_config | |
443 | static inline int noop_core_config(const char *var UNUSED, | |
444 | const char *value UNUSED, | |
445 | void *cb UNUSED) | |
446 | { | |
447 | return 0; | |
448 | } | |
449 | #define platform_core_config noop_core_config | |
450 | #endif | |
451 | ||
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 | ||
457 | #ifndef has_dos_drive_prefix | |
458 | static inline int git_has_dos_drive_prefix(const char *path UNUSED) | |
459 | { | |
460 | return 0; | |
461 | } | |
462 | #define has_dos_drive_prefix git_has_dos_drive_prefix | |
463 | #endif | |
464 | ||
465 | #ifndef skip_dos_drive_prefix | |
466 | static inline int git_skip_dos_drive_prefix(char **path UNUSED) | |
467 | { | |
468 | return 0; | |
469 | } | |
470 | #define skip_dos_drive_prefix git_skip_dos_drive_prefix | |
471 | #endif | |
472 | ||
473 | static inline int git_is_dir_sep(int c) | |
474 | { | |
475 | return c == '/'; | |
476 | } | |
477 | #ifndef is_dir_sep | |
478 | #define is_dir_sep git_is_dir_sep | |
479 | #endif | |
480 | ||
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 | |
487 | #endif | |
488 | ||
489 | #ifndef is_valid_path | |
490 | #define is_valid_path(path) 1 | |
491 | #endif | |
492 | ||
493 | #ifndef is_path_owned_by_current_user | |
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 | ||
538 | static inline int is_path_owned_by_current_uid(const char *path, | |
539 | struct strbuf *report UNUSED) | |
540 | { | |
541 | struct stat st; | |
542 | uid_t euid; | |
543 | ||
544 | if (lstat(path, &st)) | |
545 | return 0; | |
546 | ||
547 | euid = geteuid(); | |
548 | if (euid == ROOT_UID) | |
549 | { | |
550 | if (st.st_uid == ROOT_UID) | |
551 | return 1; | |
552 | else | |
553 | extract_id_from_env("SUDO_UID", &euid); | |
554 | } | |
555 | ||
556 | return st.st_uid == euid; | |
557 | } | |
558 | ||
559 | #define is_path_owned_by_current_user is_path_owned_by_current_uid | |
560 | #endif | |
561 | ||
562 | #ifndef find_last_dir_sep | |
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 | |
568 | #endif | |
569 | ||
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 | ||
578 | #ifndef query_user_email | |
579 | #define query_user_email() NULL | |
580 | #endif | |
581 | ||
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 | ||
595 | #if defined(__HP_cc) && (__HP_cc >= 61000) | |
596 | #define NORETURN __attribute__((noreturn)) | |
597 | #define NORETURN_PTR | |
598 | #elif defined(__GNUC__) && !defined(NO_NORETURN) | |
599 | #define NORETURN __attribute__((__noreturn__)) | |
600 | #define NORETURN_PTR __attribute__((__noreturn__)) | |
601 | #elif defined(_MSC_VER) | |
602 | #define NORETURN __declspec(noreturn) | |
603 | #define NORETURN_PTR | |
604 | #else | |
605 | #define NORETURN | |
606 | #define NORETURN_PTR | |
607 | #ifndef __GNUC__ | |
608 | #ifndef __attribute__ | |
609 | #define __attribute__(x) | |
610 | #endif | |
611 | #endif | |
612 | #endif | |
613 | ||
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)) | |
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)) | |
619 | #else | |
620 | #define LAST_ARG_MUST_BE_NULL | |
621 | #define RESULT_MUST_BE_USED | |
622 | #endif | |
623 | ||
624 | #define MAYBE_UNUSED __attribute__((__unused__)) | |
625 | ||
626 | #include "compat/bswap.h" | |
627 | ||
628 | #include "wildmatch.h" | |
629 | ||
630 | struct strbuf; | |
631 | ||
632 | /* General helper functions */ | |
633 | NORETURN void usage(const char *err); | |
634 | NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
635 | NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
636 | NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
637 | int die_message(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
638 | int die_message_errno(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
639 | int error(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
640 | int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
641 | void warning(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
642 | void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
643 | ||
644 | #ifndef NO_OPENSSL | |
645 | #ifdef APPLE_COMMON_CRYPTO | |
646 | #include "compat/apple-common-crypto.h" | |
647 | #else | |
648 | #include <openssl/evp.h> | |
649 | #include <openssl/hmac.h> | |
650 | #endif /* APPLE_COMMON_CRYPTO */ | |
651 | #include <openssl/x509v3.h> | |
652 | #endif /* NO_OPENSSL */ | |
653 | ||
654 | #ifdef HAVE_OPENSSL_CSPRNG | |
655 | #include <openssl/rand.h> | |
656 | #endif | |
657 | ||
658 | /* | |
659 | * Let callers be aware of the constant return value; this can help | |
660 | * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though, | |
661 | * because other compilers may be confused by this. | |
662 | */ | |
663 | #if defined(__GNUC__) | |
664 | static inline int const_error(void) | |
665 | { | |
666 | return -1; | |
667 | } | |
668 | #define error(...) (error(__VA_ARGS__), const_error()) | |
669 | #define error_errno(...) (error_errno(__VA_ARGS__), const_error()) | |
670 | #endif | |
671 | ||
672 | typedef void (*report_fn)(const char *, va_list params); | |
673 | ||
674 | void set_die_routine(NORETURN_PTR report_fn routine); | |
675 | report_fn get_die_message_routine(void); | |
676 | void set_error_routine(report_fn routine); | |
677 | report_fn get_error_routine(void); | |
678 | void set_warn_routine(report_fn routine); | |
679 | report_fn get_warn_routine(void); | |
680 | void set_die_is_recursing_routine(int (*routine)(void)); | |
681 | ||
682 | int starts_with(const char *str, const char *prefix); | |
683 | int istarts_with(const char *str, const char *prefix); | |
684 | ||
685 | /* | |
686 | * If the string "str" begins with the string found in "prefix", return 1. | |
687 | * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in | |
688 | * the string right after the prefix). | |
689 | * | |
690 | * Otherwise, return 0 and leave "out" untouched. | |
691 | * | |
692 | * Examples: | |
693 | * | |
694 | * [extract branch name, fail if not a branch] | |
695 | * if (!skip_prefix(ref, "refs/heads/", &branch) | |
696 | * return -1; | |
697 | * | |
698 | * [skip prefix if present, otherwise use whole string] | |
699 | * skip_prefix(name, "refs/heads/", &name); | |
700 | */ | |
701 | static inline int skip_prefix(const char *str, const char *prefix, | |
702 | const char **out) | |
703 | { | |
704 | do { | |
705 | if (!*prefix) { | |
706 | *out = str; | |
707 | return 1; | |
708 | } | |
709 | } while (*str++ == *prefix++); | |
710 | return 0; | |
711 | } | |
712 | ||
713 | /* | |
714 | * If the string "str" is the same as the string in "prefix", then the "arg" | |
715 | * parameter is set to the "def" parameter and 1 is returned. | |
716 | * If the string "str" begins with the string found in "prefix" and then a | |
717 | * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1" | |
718 | * (i.e., to the point in the string right after the prefix and the "=" sign), | |
719 | * and 1 is returned. | |
720 | * | |
721 | * Otherwise, return 0 and leave "arg" untouched. | |
722 | * | |
723 | * When we accept both a "--key" and a "--key=<val>" option, this function | |
724 | * can be used instead of !strcmp(arg, "--key") and then | |
725 | * skip_prefix(arg, "--key=", &arg) to parse such an option. | |
726 | */ | |
727 | int skip_to_optional_arg_default(const char *str, const char *prefix, | |
728 | const char **arg, const char *def); | |
729 | ||
730 | static inline int skip_to_optional_arg(const char *str, const char *prefix, | |
731 | const char **arg) | |
732 | { | |
733 | return skip_to_optional_arg_default(str, prefix, arg, ""); | |
734 | } | |
735 | ||
736 | /* | |
737 | * Like skip_prefix, but promises never to read past "len" bytes of the input | |
738 | * buffer, and returns the remaining number of bytes in "out" via "outlen". | |
739 | */ | |
740 | static inline int skip_prefix_mem(const char *buf, size_t len, | |
741 | const char *prefix, | |
742 | const char **out, size_t *outlen) | |
743 | { | |
744 | size_t prefix_len = strlen(prefix); | |
745 | if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) { | |
746 | *out = buf + prefix_len; | |
747 | *outlen = len - prefix_len; | |
748 | return 1; | |
749 | } | |
750 | return 0; | |
751 | } | |
752 | ||
753 | /* | |
754 | * If buf ends with suffix, return 1 and subtract the length of the suffix | |
755 | * from *len. Otherwise, return 0 and leave *len untouched. | |
756 | */ | |
757 | static inline int strip_suffix_mem(const char *buf, size_t *len, | |
758 | const char *suffix) | |
759 | { | |
760 | size_t suflen = strlen(suffix); | |
761 | if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen)) | |
762 | return 0; | |
763 | *len -= suflen; | |
764 | return 1; | |
765 | } | |
766 | ||
767 | /* | |
768 | * If str ends with suffix, return 1 and set *len to the size of the string | |
769 | * without the suffix. Otherwise, return 0 and set *len to the size of the | |
770 | * string. | |
771 | * | |
772 | * Note that we do _not_ NUL-terminate str to the new length. | |
773 | */ | |
774 | static inline int strip_suffix(const char *str, const char *suffix, size_t *len) | |
775 | { | |
776 | *len = strlen(str); | |
777 | return strip_suffix_mem(str, len, suffix); | |
778 | } | |
779 | ||
780 | static inline int ends_with(const char *str, const char *suffix) | |
781 | { | |
782 | size_t len; | |
783 | return strip_suffix(str, suffix, &len); | |
784 | } | |
785 | ||
786 | #define SWAP(a, b) do { \ | |
787 | void *_swap_a_ptr = &(a); \ | |
788 | void *_swap_b_ptr = &(b); \ | |
789 | unsigned char _swap_buffer[sizeof(a)]; \ | |
790 | memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \ | |
791 | memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \ | |
792 | BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \ | |
793 | memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \ | |
794 | } while (0) | |
795 | ||
796 | #if defined(NO_MMAP) || defined(USE_WIN32_MMAP) | |
797 | ||
798 | #ifndef PROT_READ | |
799 | #define PROT_READ 1 | |
800 | #define PROT_WRITE 2 | |
801 | #define MAP_PRIVATE 1 | |
802 | #endif | |
803 | ||
804 | #define mmap git_mmap | |
805 | #define munmap git_munmap | |
806 | void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset); | |
807 | int git_munmap(void *start, size_t length); | |
808 | ||
809 | #else /* NO_MMAP || USE_WIN32_MMAP */ | |
810 | ||
811 | #include <sys/mman.h> | |
812 | ||
813 | #endif /* NO_MMAP || USE_WIN32_MMAP */ | |
814 | ||
815 | #ifdef NO_MMAP | |
816 | ||
817 | /* This value must be multiple of (pagesize * 2) */ | |
818 | #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024) | |
819 | ||
820 | #else /* NO_MMAP */ | |
821 | ||
822 | /* This value must be multiple of (pagesize * 2) */ | |
823 | #define DEFAULT_PACKED_GIT_WINDOW_SIZE \ | |
824 | (sizeof(void*) >= 8 \ | |
825 | ? 1 * 1024 * 1024 * 1024 \ | |
826 | : 32 * 1024 * 1024) | |
827 | ||
828 | #endif /* NO_MMAP */ | |
829 | ||
830 | #ifndef MAP_FAILED | |
831 | #define MAP_FAILED ((void *)-1) | |
832 | #endif | |
833 | ||
834 | #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT | |
835 | #define on_disk_bytes(st) ((st).st_size) | |
836 | #else | |
837 | #define on_disk_bytes(st) ((st).st_blocks * 512) | |
838 | #endif | |
839 | ||
840 | #ifdef NEEDS_MODE_TRANSLATION | |
841 | #undef S_IFMT | |
842 | #undef S_IFREG | |
843 | #undef S_IFDIR | |
844 | #undef S_IFLNK | |
845 | #undef S_IFBLK | |
846 | #undef S_IFCHR | |
847 | #undef S_IFIFO | |
848 | #undef S_IFSOCK | |
849 | #define S_IFMT 0170000 | |
850 | #define S_IFREG 0100000 | |
851 | #define S_IFDIR 0040000 | |
852 | #define S_IFLNK 0120000 | |
853 | #define S_IFBLK 0060000 | |
854 | #define S_IFCHR 0020000 | |
855 | #define S_IFIFO 0010000 | |
856 | #define S_IFSOCK 0140000 | |
857 | #ifdef stat | |
858 | #undef stat | |
859 | #endif | |
860 | #define stat(path, buf) git_stat(path, buf) | |
861 | int git_stat(const char *, struct stat *); | |
862 | #ifdef fstat | |
863 | #undef fstat | |
864 | #endif | |
865 | #define fstat(fd, buf) git_fstat(fd, buf) | |
866 | int git_fstat(int, struct stat *); | |
867 | #ifdef lstat | |
868 | #undef lstat | |
869 | #endif | |
870 | #define lstat(path, buf) git_lstat(path, buf) | |
871 | int git_lstat(const char *, struct stat *); | |
872 | #endif | |
873 | ||
874 | #define DEFAULT_PACKED_GIT_LIMIT \ | |
875 | ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256)) | |
876 | ||
877 | #ifdef NO_PREAD | |
878 | #define pread git_pread | |
879 | ssize_t git_pread(int fd, void *buf, size_t count, off_t offset); | |
880 | #endif | |
881 | ||
882 | #ifdef NO_SETENV | |
883 | #define setenv gitsetenv | |
884 | int gitsetenv(const char *, const char *, int); | |
885 | #endif | |
886 | ||
887 | #ifdef NO_MKDTEMP | |
888 | #define mkdtemp gitmkdtemp | |
889 | char *gitmkdtemp(char *); | |
890 | #endif | |
891 | ||
892 | #ifdef NO_UNSETENV | |
893 | #define unsetenv gitunsetenv | |
894 | int gitunsetenv(const char *); | |
895 | #endif | |
896 | ||
897 | #ifdef NO_STRCASESTR | |
898 | #define strcasestr gitstrcasestr | |
899 | char *gitstrcasestr(const char *haystack, const char *needle); | |
900 | #endif | |
901 | ||
902 | #ifdef NO_STRLCPY | |
903 | #define strlcpy gitstrlcpy | |
904 | size_t gitstrlcpy(char *, const char *, size_t); | |
905 | #endif | |
906 | ||
907 | #ifdef NO_STRTOUMAX | |
908 | #define strtoumax gitstrtoumax | |
909 | uintmax_t gitstrtoumax(const char *, char **, int); | |
910 | #define strtoimax gitstrtoimax | |
911 | intmax_t gitstrtoimax(const char *, char **, int); | |
912 | #endif | |
913 | ||
914 | #ifdef NO_HSTRERROR | |
915 | #define hstrerror githstrerror | |
916 | const char *githstrerror(int herror); | |
917 | #endif | |
918 | ||
919 | #ifdef NO_MEMMEM | |
920 | #define memmem gitmemmem | |
921 | void *gitmemmem(const void *haystack, size_t haystacklen, | |
922 | const void *needle, size_t needlelen); | |
923 | #endif | |
924 | ||
925 | #ifdef OVERRIDE_STRDUP | |
926 | #ifdef strdup | |
927 | #undef strdup | |
928 | #endif | |
929 | #define strdup gitstrdup | |
930 | char *gitstrdup(const char *s); | |
931 | #endif | |
932 | ||
933 | #ifdef NO_GETPAGESIZE | |
934 | #define getpagesize() sysconf(_SC_PAGESIZE) | |
935 | #endif | |
936 | ||
937 | #ifndef O_CLOEXEC | |
938 | #define O_CLOEXEC 0 | |
939 | #endif | |
940 | ||
941 | #ifdef FREAD_READS_DIRECTORIES | |
942 | # if !defined(SUPPRESS_FOPEN_REDEFINITION) | |
943 | # ifdef fopen | |
944 | # undef fopen | |
945 | # endif | |
946 | # define fopen(a,b) git_fopen(a,b) | |
947 | # endif | |
948 | FILE *git_fopen(const char*, const char*); | |
949 | #endif | |
950 | ||
951 | #ifdef SNPRINTF_RETURNS_BOGUS | |
952 | #ifdef snprintf | |
953 | #undef snprintf | |
954 | #endif | |
955 | #define snprintf git_snprintf | |
956 | int git_snprintf(char *str, size_t maxsize, | |
957 | const char *format, ...); | |
958 | #ifdef vsnprintf | |
959 | #undef vsnprintf | |
960 | #endif | |
961 | #define vsnprintf git_vsnprintf | |
962 | int git_vsnprintf(char *str, size_t maxsize, | |
963 | const char *format, va_list ap); | |
964 | #endif | |
965 | ||
966 | #ifdef OPEN_RETURNS_EINTR | |
967 | #undef open | |
968 | #define open git_open_with_retry | |
969 | int git_open_with_retry(const char *path, int flag, ...); | |
970 | #endif | |
971 | ||
972 | #ifdef __GLIBC_PREREQ | |
973 | #if __GLIBC_PREREQ(2, 1) | |
974 | #define HAVE_STRCHRNUL | |
975 | #endif | |
976 | #endif | |
977 | ||
978 | #ifndef HAVE_STRCHRNUL | |
979 | #define strchrnul gitstrchrnul | |
980 | static inline char *gitstrchrnul(const char *s, int c) | |
981 | { | |
982 | while (*s && *s != c) | |
983 | s++; | |
984 | return (char *)s; | |
985 | } | |
986 | #endif | |
987 | ||
988 | #ifdef NO_INET_PTON | |
989 | int inet_pton(int af, const char *src, void *dst); | |
990 | #endif | |
991 | ||
992 | #ifdef NO_INET_NTOP | |
993 | const char *inet_ntop(int af, const void *src, char *dst, size_t size); | |
994 | #endif | |
995 | ||
996 | #ifdef NO_PTHREADS | |
997 | #define atexit git_atexit | |
998 | int git_atexit(void (*handler)(void)); | |
999 | #endif | |
1000 | ||
1001 | static inline size_t st_add(size_t a, size_t b) | |
1002 | { | |
1003 | if (unsigned_add_overflows(a, b)) | |
1004 | die("size_t overflow: %"PRIuMAX" + %"PRIuMAX, | |
1005 | (uintmax_t)a, (uintmax_t)b); | |
1006 | return a + b; | |
1007 | } | |
1008 | #define st_add3(a,b,c) st_add(st_add((a),(b)),(c)) | |
1009 | #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d)) | |
1010 | ||
1011 | static inline size_t st_mult(size_t a, size_t b) | |
1012 | { | |
1013 | if (unsigned_mult_overflows(a, b)) | |
1014 | die("size_t overflow: %"PRIuMAX" * %"PRIuMAX, | |
1015 | (uintmax_t)a, (uintmax_t)b); | |
1016 | return a * b; | |
1017 | } | |
1018 | ||
1019 | static inline size_t st_sub(size_t a, size_t b) | |
1020 | { | |
1021 | if (a < b) | |
1022 | die("size_t underflow: %"PRIuMAX" - %"PRIuMAX, | |
1023 | (uintmax_t)a, (uintmax_t)b); | |
1024 | return a - b; | |
1025 | } | |
1026 | ||
1027 | static inline size_t st_left_shift(size_t a, unsigned shift) | |
1028 | { | |
1029 | if (unsigned_left_shift_overflows(a, shift)) | |
1030 | die("size_t overflow: %"PRIuMAX" << %u", | |
1031 | (uintmax_t)a, shift); | |
1032 | return a << shift; | |
1033 | } | |
1034 | ||
1035 | static inline unsigned long cast_size_t_to_ulong(size_t a) | |
1036 | { | |
1037 | if (a != (unsigned long)a) | |
1038 | die("object too large to read on this platform: %" | |
1039 | PRIuMAX" is cut off to %lu", | |
1040 | (uintmax_t)a, (unsigned long)a); | |
1041 | return (unsigned long)a; | |
1042 | } | |
1043 | ||
1044 | static inline int cast_size_t_to_int(size_t a) | |
1045 | { | |
1046 | if (a > INT_MAX) | |
1047 | die("number too large to represent as int on this platform: %"PRIuMAX, | |
1048 | (uintmax_t)a); | |
1049 | return (int)a; | |
1050 | } | |
1051 | ||
1052 | /* | |
1053 | * Limit size of IO chunks, because huge chunks only cause pain. OS X | |
1054 | * 64-bit is buggy, returning EINVAL if len >= INT_MAX; and even in | |
1055 | * the absence of bugs, large chunks can result in bad latencies when | |
1056 | * you decide to kill the process. | |
1057 | * | |
1058 | * We pick 8 MiB as our default, but if the platform defines SSIZE_MAX | |
1059 | * that is smaller than that, clip it to SSIZE_MAX, as a call to | |
1060 | * read(2) or write(2) larger than that is allowed to fail. As the last | |
1061 | * resort, we allow a port to pass via CFLAGS e.g. "-DMAX_IO_SIZE=value" | |
1062 | * to override this, if the definition of SSIZE_MAX given by the platform | |
1063 | * is broken. | |
1064 | */ | |
1065 | #ifndef MAX_IO_SIZE | |
1066 | # define MAX_IO_SIZE_DEFAULT (8*1024*1024) | |
1067 | # if defined(SSIZE_MAX) && (SSIZE_MAX < MAX_IO_SIZE_DEFAULT) | |
1068 | # define MAX_IO_SIZE SSIZE_MAX | |
1069 | # else | |
1070 | # define MAX_IO_SIZE MAX_IO_SIZE_DEFAULT | |
1071 | # endif | |
1072 | #endif | |
1073 | ||
1074 | #ifdef HAVE_ALLOCA_H | |
1075 | # include <alloca.h> | |
1076 | # define xalloca(size) (alloca(size)) | |
1077 | # define xalloca_free(p) do {} while (0) | |
1078 | #else | |
1079 | # define xalloca(size) (xmalloc(size)) | |
1080 | # define xalloca_free(p) (free(p)) | |
1081 | #endif | |
1082 | char *xstrdup(const char *str); | |
1083 | void *xmalloc(size_t size); | |
1084 | void *xmallocz(size_t size); | |
1085 | void *xmallocz_gently(size_t size); | |
1086 | void *xmemdupz(const void *data, size_t len); | |
1087 | char *xstrndup(const char *str, size_t len); | |
1088 | void *xrealloc(void *ptr, size_t size); | |
1089 | void *xcalloc(size_t nmemb, size_t size); | |
1090 | void xsetenv(const char *name, const char *value, int overwrite); | |
1091 | void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset); | |
1092 | const char *mmap_os_err(void); | |
1093 | void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset); | |
1094 | int xopen(const char *path, int flags, ...); | |
1095 | ssize_t xread(int fd, void *buf, size_t len); | |
1096 | ssize_t xwrite(int fd, const void *buf, size_t len); | |
1097 | ssize_t xpread(int fd, void *buf, size_t len, off_t offset); | |
1098 | int xdup(int fd); | |
1099 | FILE *xfopen(const char *path, const char *mode); | |
1100 | FILE *xfdopen(int fd, const char *mode); | |
1101 | int xmkstemp(char *temp_filename); | |
1102 | int xmkstemp_mode(char *temp_filename, int mode); | |
1103 | char *xgetcwd(void); | |
1104 | FILE *fopen_for_writing(const char *path); | |
1105 | FILE *fopen_or_warn(const char *path, const char *mode); | |
1106 | ||
1107 | /* | |
1108 | * Like strncmp, but only return zero if s is NUL-terminated and exactly len | |
1109 | * characters long. If it is not, consider it greater than t. | |
1110 | */ | |
1111 | int xstrncmpz(const char *s, const char *t, size_t len); | |
1112 | ||
1113 | /* | |
1114 | * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note | |
1115 | * that ptr is used twice, so don't pass e.g. ptr++. | |
1116 | */ | |
1117 | #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0) | |
1118 | ||
1119 | #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc))) | |
1120 | #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x))) | |
1121 | #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc))) | |
1122 | ||
1123 | #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \ | |
1124 | BARF_UNLESS_COPYABLE((dst), (src))) | |
1125 | static inline void copy_array(void *dst, const void *src, size_t n, size_t size) | |
1126 | { | |
1127 | if (n) | |
1128 | memcpy(dst, src, st_mult(size, n)); | |
1129 | } | |
1130 | ||
1131 | #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \ | |
1132 | BARF_UNLESS_COPYABLE((dst), (src))) | |
1133 | static inline void move_array(void *dst, const void *src, size_t n, size_t size) | |
1134 | { | |
1135 | if (n) | |
1136 | memmove(dst, src, st_mult(size, n)); | |
1137 | } | |
1138 | ||
1139 | #define DUP_ARRAY(dst, src, n) do { \ | |
1140 | size_t dup_array_n_ = (n); \ | |
1141 | COPY_ARRAY(ALLOC_ARRAY((dst), dup_array_n_), (src), dup_array_n_); \ | |
1142 | } while (0) | |
1143 | ||
1144 | /* | |
1145 | * These functions help you allocate structs with flex arrays, and copy | |
1146 | * the data directly into the array. For example, if you had: | |
1147 | * | |
1148 | * struct foo { | |
1149 | * int bar; | |
1150 | * char name[FLEX_ARRAY]; | |
1151 | * }; | |
1152 | * | |
1153 | * you can do: | |
1154 | * | |
1155 | * struct foo *f; | |
1156 | * FLEX_ALLOC_MEM(f, name, src, len); | |
1157 | * | |
1158 | * to allocate a "foo" with the contents of "src" in the "name" field. | |
1159 | * The resulting struct is automatically zero'd, and the flex-array field | |
1160 | * is NUL-terminated (whether the incoming src buffer was or not). | |
1161 | * | |
1162 | * The FLEXPTR_* variants operate on structs that don't use flex-arrays, | |
1163 | * but do want to store a pointer to some extra data in the same allocated | |
1164 | * block. For example, if you have: | |
1165 | * | |
1166 | * struct foo { | |
1167 | * char *name; | |
1168 | * int bar; | |
1169 | * }; | |
1170 | * | |
1171 | * you can do: | |
1172 | * | |
1173 | * struct foo *f; | |
1174 | * FLEXPTR_ALLOC_STR(f, name, src); | |
1175 | * | |
1176 | * and "name" will point to a block of memory after the struct, which will be | |
1177 | * freed along with the struct (but the pointer can be repointed anywhere). | |
1178 | * | |
1179 | * The *_STR variants accept a string parameter rather than a ptr/len | |
1180 | * combination. | |
1181 | * | |
1182 | * Note that these macros will evaluate the first parameter multiple | |
1183 | * times, and it must be assignable as an lvalue. | |
1184 | */ | |
1185 | #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \ | |
1186 | size_t flex_array_len_ = (len); \ | |
1187 | (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \ | |
1188 | memcpy((void *)(x)->flexname, (buf), flex_array_len_); \ | |
1189 | } while (0) | |
1190 | #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \ | |
1191 | size_t flex_array_len_ = (len); \ | |
1192 | (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \ | |
1193 | memcpy((x) + 1, (buf), flex_array_len_); \ | |
1194 | (x)->ptrname = (void *)((x)+1); \ | |
1195 | } while(0) | |
1196 | #define FLEX_ALLOC_STR(x, flexname, str) \ | |
1197 | FLEX_ALLOC_MEM((x), flexname, (str), strlen(str)) | |
1198 | #define FLEXPTR_ALLOC_STR(x, ptrname, str) \ | |
1199 | FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str)) | |
1200 | ||
1201 | static inline char *xstrdup_or_null(const char *str) | |
1202 | { | |
1203 | return str ? xstrdup(str) : NULL; | |
1204 | } | |
1205 | ||
1206 | static inline size_t xsize_t(off_t len) | |
1207 | { | |
1208 | if (len < 0 || (uintmax_t) len > SIZE_MAX) | |
1209 | die("Cannot handle files this big"); | |
1210 | return (size_t) len; | |
1211 | } | |
1212 | ||
1213 | __attribute__((format (printf, 3, 4))) | |
1214 | int xsnprintf(char *dst, size_t max, const char *fmt, ...); | |
1215 | ||
1216 | #ifndef HOST_NAME_MAX | |
1217 | #define HOST_NAME_MAX 256 | |
1218 | #endif | |
1219 | ||
1220 | int xgethostname(char *buf, size_t len); | |
1221 | ||
1222 | /* in ctype.c, for kwset users */ | |
1223 | extern const unsigned char tolower_trans_tbl[256]; | |
1224 | ||
1225 | /* Sane ctype - no locale, and works with signed chars */ | |
1226 | #undef isascii | |
1227 | #undef isspace | |
1228 | #undef isdigit | |
1229 | #undef isalpha | |
1230 | #undef isalnum | |
1231 | #undef isprint | |
1232 | #undef islower | |
1233 | #undef isupper | |
1234 | #undef tolower | |
1235 | #undef toupper | |
1236 | #undef iscntrl | |
1237 | #undef ispunct | |
1238 | #undef isxdigit | |
1239 | ||
1240 | extern const unsigned char sane_ctype[256]; | |
1241 | extern const signed char hexval_table[256]; | |
1242 | #define GIT_SPACE 0x01 | |
1243 | #define GIT_DIGIT 0x02 | |
1244 | #define GIT_ALPHA 0x04 | |
1245 | #define GIT_GLOB_SPECIAL 0x08 | |
1246 | #define GIT_REGEX_SPECIAL 0x10 | |
1247 | #define GIT_PATHSPEC_MAGIC 0x20 | |
1248 | #define GIT_CNTRL 0x40 | |
1249 | #define GIT_PUNCT 0x80 | |
1250 | #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0) | |
1251 | #define isascii(x) (((x) & ~0x7f) == 0) | |
1252 | #define isspace(x) sane_istest(x,GIT_SPACE) | |
1253 | #define isdigit(x) sane_istest(x,GIT_DIGIT) | |
1254 | #define isalpha(x) sane_istest(x,GIT_ALPHA) | |
1255 | #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT) | |
1256 | #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e) | |
1257 | #define islower(x) sane_iscase(x, 1) | |
1258 | #define isupper(x) sane_iscase(x, 0) | |
1259 | #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL) | |
1260 | #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL) | |
1261 | #define iscntrl(x) (sane_istest(x,GIT_CNTRL)) | |
1262 | #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \ | |
1263 | GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC) | |
1264 | #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1) | |
1265 | #define tolower(x) sane_case((unsigned char)(x), 0x20) | |
1266 | #define toupper(x) sane_case((unsigned char)(x), 0) | |
1267 | #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC) | |
1268 | ||
1269 | static inline int sane_case(int x, int high) | |
1270 | { | |
1271 | if (sane_istest(x, GIT_ALPHA)) | |
1272 | x = (x & ~0x20) | high; | |
1273 | return x; | |
1274 | } | |
1275 | ||
1276 | static inline int sane_iscase(int x, int is_lower) | |
1277 | { | |
1278 | if (!sane_istest(x, GIT_ALPHA)) | |
1279 | return 0; | |
1280 | ||
1281 | if (is_lower) | |
1282 | return (x & 0x20) != 0; | |
1283 | else | |
1284 | return (x & 0x20) == 0; | |
1285 | } | |
1286 | ||
1287 | /* | |
1288 | * Like skip_prefix, but compare case-insensitively. Note that the comparison | |
1289 | * is done via tolower(), so it is strictly ASCII (no multi-byte characters or | |
1290 | * locale-specific conversions). | |
1291 | */ | |
1292 | static inline int skip_iprefix(const char *str, const char *prefix, | |
1293 | const char **out) | |
1294 | { | |
1295 | do { | |
1296 | if (!*prefix) { | |
1297 | *out = str; | |
1298 | return 1; | |
1299 | } | |
1300 | } while (tolower(*str++) == tolower(*prefix++)); | |
1301 | return 0; | |
1302 | } | |
1303 | ||
1304 | /* | |
1305 | * Like skip_prefix_mem, but compare case-insensitively. Note that the | |
1306 | * comparison is done via tolower(), so it is strictly ASCII (no multi-byte | |
1307 | * characters or locale-specific conversions). | |
1308 | */ | |
1309 | static inline int skip_iprefix_mem(const char *buf, size_t len, | |
1310 | const char *prefix, | |
1311 | const char **out, size_t *outlen) | |
1312 | { | |
1313 | do { | |
1314 | if (!*prefix) { | |
1315 | *out = buf; | |
1316 | *outlen = len; | |
1317 | return 1; | |
1318 | } | |
1319 | } while (len-- > 0 && tolower(*buf++) == tolower(*prefix++)); | |
1320 | return 0; | |
1321 | } | |
1322 | ||
1323 | static inline int strtoul_ui(char const *s, int base, unsigned int *result) | |
1324 | { | |
1325 | unsigned long ul; | |
1326 | char *p; | |
1327 | ||
1328 | errno = 0; | |
1329 | /* negative values would be accepted by strtoul */ | |
1330 | if (strchr(s, '-')) | |
1331 | return -1; | |
1332 | ul = strtoul(s, &p, base); | |
1333 | if (errno || *p || p == s || (unsigned int) ul != ul) | |
1334 | return -1; | |
1335 | *result = ul; | |
1336 | return 0; | |
1337 | } | |
1338 | ||
1339 | static inline int strtol_i(char const *s, int base, int *result) | |
1340 | { | |
1341 | long ul; | |
1342 | char *p; | |
1343 | ||
1344 | errno = 0; | |
1345 | ul = strtol(s, &p, base); | |
1346 | if (errno || *p || p == s || (int) ul != ul) | |
1347 | return -1; | |
1348 | *result = ul; | |
1349 | return 0; | |
1350 | } | |
1351 | ||
1352 | void git_stable_qsort(void *base, size_t nmemb, size_t size, | |
1353 | int(*compar)(const void *, const void *)); | |
1354 | #ifdef INTERNAL_QSORT | |
1355 | #define qsort git_stable_qsort | |
1356 | #endif | |
1357 | ||
1358 | #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar) | |
1359 | static inline void sane_qsort(void *base, size_t nmemb, size_t size, | |
1360 | int(*compar)(const void *, const void *)) | |
1361 | { | |
1362 | if (nmemb > 1) | |
1363 | qsort(base, nmemb, size, compar); | |
1364 | } | |
1365 | ||
1366 | #define STABLE_QSORT(base, n, compar) \ | |
1367 | git_stable_qsort((base), (n), sizeof(*(base)), compar) | |
1368 | ||
1369 | #ifndef HAVE_ISO_QSORT_S | |
1370 | int git_qsort_s(void *base, size_t nmemb, size_t size, | |
1371 | int (*compar)(const void *, const void *, void *), void *ctx); | |
1372 | #define qsort_s git_qsort_s | |
1373 | #endif | |
1374 | ||
1375 | #define QSORT_S(base, n, compar, ctx) do { \ | |
1376 | if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \ | |
1377 | BUG("qsort_s() failed"); \ | |
1378 | } while (0) | |
1379 | ||
1380 | #ifndef REG_STARTEND | |
1381 | #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd" | |
1382 | #endif | |
1383 | ||
1384 | static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size, | |
1385 | size_t nmatch, regmatch_t pmatch[], int eflags) | |
1386 | { | |
1387 | assert(nmatch > 0 && pmatch); | |
1388 | pmatch[0].rm_so = 0; | |
1389 | pmatch[0].rm_eo = size; | |
1390 | return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND); | |
1391 | } | |
1392 | ||
1393 | #ifdef USE_ENHANCED_BASIC_REGULAR_EXPRESSIONS | |
1394 | int git_regcomp(regex_t *preg, const char *pattern, int cflags); | |
1395 | #define regcomp git_regcomp | |
1396 | #endif | |
1397 | ||
1398 | #ifndef DIR_HAS_BSD_GROUP_SEMANTICS | |
1399 | # define FORCE_DIR_SET_GID S_ISGID | |
1400 | #else | |
1401 | # define FORCE_DIR_SET_GID 0 | |
1402 | #endif | |
1403 | ||
1404 | #ifdef NO_NSEC | |
1405 | #undef USE_NSEC | |
1406 | #define ST_CTIME_NSEC(st) 0 | |
1407 | #define ST_MTIME_NSEC(st) 0 | |
1408 | #else | |
1409 | #ifdef USE_ST_TIMESPEC | |
1410 | #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec)) | |
1411 | #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec)) | |
1412 | #else | |
1413 | #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec)) | |
1414 | #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec)) | |
1415 | #endif | |
1416 | #endif | |
1417 | ||
1418 | #ifdef UNRELIABLE_FSTAT | |
1419 | #define fstat_is_reliable() 0 | |
1420 | #else | |
1421 | #define fstat_is_reliable() 1 | |
1422 | #endif | |
1423 | ||
1424 | #ifndef va_copy | |
1425 | /* | |
1426 | * Since an obvious implementation of va_list would be to make it a | |
1427 | * pointer into the stack frame, a simple assignment will work on | |
1428 | * many systems. But let's try to be more portable. | |
1429 | */ | |
1430 | #ifdef __va_copy | |
1431 | #define va_copy(dst, src) __va_copy(dst, src) | |
1432 | #else | |
1433 | #define va_copy(dst, src) ((dst) = (src)) | |
1434 | #endif | |
1435 | #endif | |
1436 | ||
1437 | /* usage.c: only to be used for testing BUG() implementation (see test-tool) */ | |
1438 | extern int BUG_exit_code; | |
1439 | ||
1440 | /* usage.c: if bug() is called we should have a BUG_if_bug() afterwards */ | |
1441 | extern int bug_called_must_BUG; | |
1442 | ||
1443 | __attribute__((format (printf, 3, 4))) NORETURN | |
1444 | void BUG_fl(const char *file, int line, const char *fmt, ...); | |
1445 | #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__) | |
1446 | __attribute__((format (printf, 3, 4))) | |
1447 | void bug_fl(const char *file, int line, const char *fmt, ...); | |
1448 | #define bug(...) bug_fl(__FILE__, __LINE__, __VA_ARGS__) | |
1449 | #define BUG_if_bug(...) do { \ | |
1450 | if (bug_called_must_BUG) \ | |
1451 | BUG_fl(__FILE__, __LINE__, __VA_ARGS__); \ | |
1452 | } while (0) | |
1453 | ||
1454 | #ifndef FSYNC_METHOD_DEFAULT | |
1455 | #ifdef __APPLE__ | |
1456 | #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_WRITEOUT_ONLY | |
1457 | #else | |
1458 | #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_FSYNC | |
1459 | #endif | |
1460 | #endif | |
1461 | ||
1462 | enum fsync_action { | |
1463 | FSYNC_WRITEOUT_ONLY, | |
1464 | FSYNC_HARDWARE_FLUSH | |
1465 | }; | |
1466 | ||
1467 | /* | |
1468 | * Issues an fsync against the specified file according to the specified mode. | |
1469 | * | |
1470 | * FSYNC_WRITEOUT_ONLY attempts to use interfaces available on some operating | |
1471 | * systems to flush the OS cache without issuing a flush command to the storage | |
1472 | * controller. If those interfaces are unavailable, the function fails with | |
1473 | * ENOSYS. | |
1474 | * | |
1475 | * FSYNC_HARDWARE_FLUSH does an OS writeout and hardware flush to ensure that | |
1476 | * changes are durable. It is not expected to fail. | |
1477 | */ | |
1478 | int git_fsync(int fd, enum fsync_action action); | |
1479 | ||
1480 | /* | |
1481 | * Writes out trace statistics for fsync using the trace2 API. | |
1482 | */ | |
1483 | void trace_git_fsync_stats(void); | |
1484 | ||
1485 | /* | |
1486 | * Preserves errno, prints a message, but gives no warning for ENOENT. | |
1487 | * Returns 0 on success, which includes trying to unlink an object that does | |
1488 | * not exist. | |
1489 | */ | |
1490 | int unlink_or_warn(const char *path); | |
1491 | /* | |
1492 | * Tries to unlink file. Returns 0 if unlink succeeded | |
1493 | * or the file already didn't exist. Returns -1 and | |
1494 | * appends a message to err suitable for | |
1495 | * 'error("%s", err->buf)' on error. | |
1496 | */ | |
1497 | int unlink_or_msg(const char *file, struct strbuf *err); | |
1498 | /* | |
1499 | * Preserves errno, prints a message, but gives no warning for ENOENT. | |
1500 | * Returns 0 on success, which includes trying to remove a directory that does | |
1501 | * not exist. | |
1502 | */ | |
1503 | int rmdir_or_warn(const char *path); | |
1504 | /* | |
1505 | * Calls the correct function out of {unlink,rmdir}_or_warn based on | |
1506 | * the supplied file mode. | |
1507 | */ | |
1508 | int remove_or_warn(unsigned int mode, const char *path); | |
1509 | ||
1510 | /* | |
1511 | * Call access(2), but warn for any error except "missing file" | |
1512 | * (ENOENT or ENOTDIR). | |
1513 | */ | |
1514 | #define ACCESS_EACCES_OK (1U << 0) | |
1515 | int access_or_warn(const char *path, int mode, unsigned flag); | |
1516 | int access_or_die(const char *path, int mode, unsigned flag); | |
1517 | ||
1518 | /* Warn on an inaccessible file if errno indicates this is an error */ | |
1519 | int warn_on_fopen_errors(const char *path); | |
1520 | ||
1521 | /* | |
1522 | * Open with O_NOFOLLOW, or equivalent. Note that the fallback equivalent | |
1523 | * may be racy. Do not use this as protection against an attacker who can | |
1524 | * simultaneously create paths. | |
1525 | */ | |
1526 | int open_nofollow(const char *path, int flags); | |
1527 | ||
1528 | #ifndef SHELL_PATH | |
1529 | # define SHELL_PATH "/bin/sh" | |
1530 | #endif | |
1531 | ||
1532 | #ifndef _POSIX_THREAD_SAFE_FUNCTIONS | |
1533 | static inline void git_flockfile(FILE *fh UNUSED) | |
1534 | { | |
1535 | ; /* nothing */ | |
1536 | } | |
1537 | static inline void git_funlockfile(FILE *fh UNUSED) | |
1538 | { | |
1539 | ; /* nothing */ | |
1540 | } | |
1541 | #undef flockfile | |
1542 | #undef funlockfile | |
1543 | #undef getc_unlocked | |
1544 | #define flockfile(fh) git_flockfile(fh) | |
1545 | #define funlockfile(fh) git_funlockfile(fh) | |
1546 | #define getc_unlocked(fh) getc(fh) | |
1547 | #endif | |
1548 | ||
1549 | #ifdef FILENO_IS_A_MACRO | |
1550 | int git_fileno(FILE *stream); | |
1551 | # ifndef COMPAT_CODE_FILENO | |
1552 | # undef fileno | |
1553 | # define fileno(p) git_fileno(p) | |
1554 | # endif | |
1555 | #endif | |
1556 | ||
1557 | #ifdef NEED_ACCESS_ROOT_HANDLER | |
1558 | int git_access(const char *path, int mode); | |
1559 | # ifndef COMPAT_CODE_ACCESS | |
1560 | # ifdef access | |
1561 | # undef access | |
1562 | # endif | |
1563 | # define access(path, mode) git_access(path, mode) | |
1564 | # endif | |
1565 | #endif | |
1566 | ||
1567 | /* | |
1568 | * Our code often opens a path to an optional file, to work on its | |
1569 | * contents when we can successfully open it. We can ignore a failure | |
1570 | * to open if such an optional file does not exist, but we do want to | |
1571 | * report a failure in opening for other reasons (e.g. we got an I/O | |
1572 | * error, or the file is there, but we lack the permission to open). | |
1573 | * | |
1574 | * Call this function after seeing an error from open() or fopen() to | |
1575 | * see if the errno indicates a missing file that we can safely ignore. | |
1576 | */ | |
1577 | static inline int is_missing_file_error(int errno_) | |
1578 | { | |
1579 | return (errno_ == ENOENT || errno_ == ENOTDIR); | |
1580 | } | |
1581 | ||
1582 | int cmd_main(int, const char **); | |
1583 | ||
1584 | /* | |
1585 | * Intercept all calls to exit() and route them to trace2 to | |
1586 | * optionally emit a message before calling the real exit(). | |
1587 | */ | |
1588 | int common_exit(const char *file, int line, int code); | |
1589 | #define exit(code) exit(common_exit(__FILE__, __LINE__, (code))) | |
1590 | ||
1591 | /* | |
1592 | * You can mark a stack variable with UNLEAK(var) to avoid it being | |
1593 | * reported as a leak by tools like LSAN or valgrind. The argument | |
1594 | * should generally be the variable itself (not its address and not what | |
1595 | * it points to). It's safe to use this on pointers which may already | |
1596 | * have been freed, or on pointers which may still be in use. | |
1597 | * | |
1598 | * Use this _only_ for a variable that leaks by going out of scope at | |
1599 | * program exit (so only from cmd_* functions or their direct helpers). | |
1600 | * Normal functions, especially those which may be called multiple | |
1601 | * times, should actually free their memory. This is only meant as | |
1602 | * an annotation, and does nothing in non-leak-checking builds. | |
1603 | */ | |
1604 | #ifdef SUPPRESS_ANNOTATED_LEAKS | |
1605 | void unleak_memory(const void *ptr, size_t len); | |
1606 | #define UNLEAK(var) unleak_memory(&(var), sizeof(var)) | |
1607 | #else | |
1608 | #define UNLEAK(var) do {} while (0) | |
1609 | #endif | |
1610 | ||
1611 | #define z_const | |
1612 | #include <zlib.h> | |
1613 | ||
1614 | #if ZLIB_VERNUM < 0x1290 | |
1615 | /* | |
1616 | * This is uncompress2, which is only available in zlib >= 1.2.9 | |
1617 | * (released as of early 2017). See compat/zlib-uncompress2.c. | |
1618 | */ | |
1619 | int uncompress2(Bytef *dest, uLongf *destLen, const Bytef *source, | |
1620 | uLong *sourceLen); | |
1621 | #endif | |
1622 | ||
1623 | /* | |
1624 | * This include must come after system headers, since it introduces macros that | |
1625 | * replace system names. | |
1626 | */ | |
1627 | #include "banned.h" | |
1628 | ||
1629 | /* | |
1630 | * container_of - Get the address of an object containing a field. | |
1631 | * | |
1632 | * @ptr: pointer to the field. | |
1633 | * @type: type of the object. | |
1634 | * @member: name of the field within the object. | |
1635 | */ | |
1636 | #define container_of(ptr, type, member) \ | |
1637 | ((type *) ((char *)(ptr) - offsetof(type, member))) | |
1638 | ||
1639 | /* | |
1640 | * helper function for `container_of_or_null' to avoid multiple | |
1641 | * evaluation of @ptr | |
1642 | */ | |
1643 | static inline void *container_of_or_null_offset(void *ptr, size_t offset) | |
1644 | { | |
1645 | return ptr ? (char *)ptr - offset : NULL; | |
1646 | } | |
1647 | ||
1648 | /* | |
1649 | * like `container_of', but allows returned value to be NULL | |
1650 | */ | |
1651 | #define container_of_or_null(ptr, type, member) \ | |
1652 | (type *)container_of_or_null_offset(ptr, offsetof(type, member)) | |
1653 | ||
1654 | /* | |
1655 | * like offsetof(), but takes a pointer to a variable of type which | |
1656 | * contains @member, instead of a specified type. | |
1657 | * @ptr is subject to multiple evaluation since we can't rely on __typeof__ | |
1658 | * everywhere. | |
1659 | */ | |
1660 | #if defined(__GNUC__) /* clang sets this, too */ | |
1661 | #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member) | |
1662 | #else /* !__GNUC__ */ | |
1663 | #define OFFSETOF_VAR(ptr, member) \ | |
1664 | ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr)) | |
1665 | #endif /* !__GNUC__ */ | |
1666 | ||
1667 | void sleep_millisec(int millisec); | |
1668 | ||
1669 | /* | |
1670 | * Generate len bytes from the system cryptographically secure PRNG. | |
1671 | * Returns 0 on success and -1 on error, setting errno. The inability to | |
1672 | * satisfy the full request is an error. | |
1673 | */ | |
1674 | int csprng_bytes(void *buf, size_t len); | |
1675 | ||
1676 | #endif |