]>
Commit | Line | Data |
---|---|---|
1 | #ifndef GIT_COMPAT_UTIL_H | |
2 | #define GIT_COMPAT_UTIL_H | |
3 | ||
4 | #define _FILE_OFFSET_BITS 64 | |
5 | ||
6 | #ifndef FLEX_ARRAY | |
7 | /* | |
8 | * See if our compiler is known to support flexible array members. | |
9 | */ | |
10 | #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580)) | |
11 | # define FLEX_ARRAY /* empty */ | |
12 | #elif defined(__GNUC__) | |
13 | # if (__GNUC__ >= 3) | |
14 | # define FLEX_ARRAY /* empty */ | |
15 | # else | |
16 | # define FLEX_ARRAY 0 /* older GNU extension */ | |
17 | # endif | |
18 | #endif | |
19 | ||
20 | /* | |
21 | * Otherwise, default to safer but a bit wasteful traditional style | |
22 | */ | |
23 | #ifndef FLEX_ARRAY | |
24 | # define FLEX_ARRAY 1 | |
25 | #endif | |
26 | #endif | |
27 | ||
28 | #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0])) | |
29 | #define bitsizeof(x) (CHAR_BIT * sizeof(x)) | |
30 | ||
31 | #define maximum_signed_value_of_type(a) \ | |
32 | (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a))) | |
33 | ||
34 | #define maximum_unsigned_value_of_type(a) \ | |
35 | (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a))) | |
36 | ||
37 | /* | |
38 | * Signed integer overflow is undefined in C, so here's a helper macro | |
39 | * to detect if the sum of two integers will overflow. | |
40 | * | |
41 | * Requires: a >= 0, typeof(a) equals typeof(b) | |
42 | */ | |
43 | #define signed_add_overflows(a, b) \ | |
44 | ((b) > maximum_signed_value_of_type(a) - (a)) | |
45 | ||
46 | #define unsigned_add_overflows(a, b) \ | |
47 | ((b) > maximum_unsigned_value_of_type(a) - (a)) | |
48 | ||
49 | #ifdef __GNUC__ | |
50 | #define TYPEOF(x) (__typeof__(x)) | |
51 | #else | |
52 | #define TYPEOF(x) | |
53 | #endif | |
54 | ||
55 | #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits)))) | |
56 | #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */ | |
57 | ||
58 | #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d)) | |
59 | ||
60 | /* Approximation of the length of the decimal representation of this type. */ | |
61 | #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1) | |
62 | ||
63 | #if defined(__sun__) | |
64 | /* | |
65 | * On Solaris, when _XOPEN_EXTENDED is set, its header file | |
66 | * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE | |
67 | * setting to say we are XPG5 or XPG6. Also on Solaris, | |
68 | * XPG6 programs must be compiled with a c99 compiler, while | |
69 | * non XPG6 programs must be compiled with a pre-c99 compiler. | |
70 | */ | |
71 | # if __STDC_VERSION__ - 0 >= 199901L | |
72 | # define _XOPEN_SOURCE 600 | |
73 | # else | |
74 | # define _XOPEN_SOURCE 500 | |
75 | # endif | |
76 | #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \ | |
77 | !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) | |
78 | #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */ | |
79 | #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */ | |
80 | #endif | |
81 | #define _ALL_SOURCE 1 | |
82 | #define _GNU_SOURCE 1 | |
83 | #define _BSD_SOURCE 1 | |
84 | #define _NETBSD_SOURCE 1 | |
85 | #define _SGI_SOURCE 1 | |
86 | ||
87 | #ifdef WIN32 /* Both MinGW and MSVC */ | |
88 | #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */ | |
89 | #include <winsock2.h> | |
90 | #include <windows.h> | |
91 | #endif | |
92 | ||
93 | #include <unistd.h> | |
94 | #include <stdio.h> | |
95 | #include <sys/stat.h> | |
96 | #include <fcntl.h> | |
97 | #include <stddef.h> | |
98 | #include <stdlib.h> | |
99 | #include <stdarg.h> | |
100 | #include <string.h> | |
101 | #include <errno.h> | |
102 | #include <limits.h> | |
103 | #include <sys/param.h> | |
104 | #include <sys/types.h> | |
105 | #include <dirent.h> | |
106 | #include <sys/time.h> | |
107 | #include <time.h> | |
108 | #include <signal.h> | |
109 | #include <fnmatch.h> | |
110 | #include <assert.h> | |
111 | #include <regex.h> | |
112 | #include <utime.h> | |
113 | #include <syslog.h> | |
114 | #ifndef NO_SYS_POLL_H | |
115 | #include <sys/poll.h> | |
116 | #else | |
117 | #include <poll.h> | |
118 | #endif | |
119 | #ifndef __MINGW32__ | |
120 | #include <sys/wait.h> | |
121 | #include <sys/resource.h> | |
122 | #include <sys/socket.h> | |
123 | #include <sys/ioctl.h> | |
124 | #include <termios.h> | |
125 | #ifndef NO_SYS_SELECT_H | |
126 | #include <sys/select.h> | |
127 | #endif | |
128 | #include <netinet/in.h> | |
129 | #include <netinet/tcp.h> | |
130 | #include <arpa/inet.h> | |
131 | #include <netdb.h> | |
132 | #include <pwd.h> | |
133 | #ifndef NO_INTTYPES_H | |
134 | #include <inttypes.h> | |
135 | #else | |
136 | #include <stdint.h> | |
137 | #endif | |
138 | #if defined(__CYGWIN__) | |
139 | #undef _XOPEN_SOURCE | |
140 | #include <grp.h> | |
141 | #define _XOPEN_SOURCE 600 | |
142 | #include "compat/cygwin.h" | |
143 | #else | |
144 | #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */ | |
145 | #include <grp.h> | |
146 | #define _ALL_SOURCE 1 | |
147 | #endif | |
148 | #else /* __MINGW32__ */ | |
149 | /* pull in Windows compatibility stuff */ | |
150 | #include "compat/mingw.h" | |
151 | #endif /* __MINGW32__ */ | |
152 | #ifdef _MSC_VER | |
153 | #include "compat/msvc.h" | |
154 | #endif | |
155 | ||
156 | #ifndef NO_LIBGEN_H | |
157 | #include <libgen.h> | |
158 | #else | |
159 | #define basename gitbasename | |
160 | extern char *gitbasename(char *); | |
161 | #endif | |
162 | ||
163 | #ifndef NO_ICONV | |
164 | #include <iconv.h> | |
165 | #endif | |
166 | ||
167 | #ifndef NO_OPENSSL | |
168 | #include <openssl/ssl.h> | |
169 | #include <openssl/err.h> | |
170 | #endif | |
171 | ||
172 | /* On most systems <limits.h> would have given us this, but | |
173 | * not on some systems (e.g. GNU/Hurd). | |
174 | */ | |
175 | #ifndef PATH_MAX | |
176 | #define PATH_MAX 4096 | |
177 | #endif | |
178 | ||
179 | #ifndef PRIuMAX | |
180 | #define PRIuMAX "llu" | |
181 | #endif | |
182 | ||
183 | #ifndef PRIu32 | |
184 | #define PRIu32 "u" | |
185 | #endif | |
186 | ||
187 | #ifndef PRIx32 | |
188 | #define PRIx32 "x" | |
189 | #endif | |
190 | ||
191 | #ifndef PRIo32 | |
192 | #define PRIo32 "o" | |
193 | #endif | |
194 | ||
195 | #ifndef PATH_SEP | |
196 | #define PATH_SEP ':' | |
197 | #endif | |
198 | ||
199 | #ifdef HAVE_PATHS_H | |
200 | #include <paths.h> | |
201 | #endif | |
202 | #ifndef _PATH_DEFPATH | |
203 | #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin" | |
204 | #endif | |
205 | ||
206 | #ifndef STRIP_EXTENSION | |
207 | #define STRIP_EXTENSION "" | |
208 | #endif | |
209 | ||
210 | #ifndef has_dos_drive_prefix | |
211 | #define has_dos_drive_prefix(path) 0 | |
212 | #endif | |
213 | ||
214 | #ifndef is_dir_sep | |
215 | #define is_dir_sep(c) ((c) == '/') | |
216 | #endif | |
217 | ||
218 | #if __HP_cc >= 61000 | |
219 | #define NORETURN __attribute__((noreturn)) | |
220 | #define NORETURN_PTR | |
221 | #elif defined(__GNUC__) | |
222 | #define NORETURN __attribute__((__noreturn__)) | |
223 | #define NORETURN_PTR __attribute__((__noreturn__)) | |
224 | #elif defined(_MSC_VER) | |
225 | #define NORETURN __declspec(noreturn) | |
226 | #define NORETURN_PTR | |
227 | #else | |
228 | #define NORETURN | |
229 | #define NORETURN_PTR | |
230 | #ifndef __attribute__ | |
231 | #define __attribute__(x) | |
232 | #endif | |
233 | #endif | |
234 | ||
235 | #include "compat/bswap.h" | |
236 | ||
237 | /* General helper functions */ | |
238 | extern void vreportf(const char *prefix, const char *err, va_list params); | |
239 | extern NORETURN void usage(const char *err); | |
240 | extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
241 | extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
242 | extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
243 | extern int error(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
244 | extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2))); | |
245 | ||
246 | extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params)); | |
247 | ||
248 | extern int prefixcmp(const char *str, const char *prefix); | |
249 | extern int suffixcmp(const char *str, const char *suffix); | |
250 | ||
251 | static inline const char *skip_prefix(const char *str, const char *prefix) | |
252 | { | |
253 | size_t len = strlen(prefix); | |
254 | return strncmp(str, prefix, len) ? NULL : str + len; | |
255 | } | |
256 | ||
257 | #if defined(NO_MMAP) || defined(USE_WIN32_MMAP) | |
258 | ||
259 | #ifndef PROT_READ | |
260 | #define PROT_READ 1 | |
261 | #define PROT_WRITE 2 | |
262 | #define MAP_PRIVATE 1 | |
263 | #endif | |
264 | ||
265 | #define mmap git_mmap | |
266 | #define munmap git_munmap | |
267 | extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset); | |
268 | extern int git_munmap(void *start, size_t length); | |
269 | ||
270 | #else /* NO_MMAP || USE_WIN32_MMAP */ | |
271 | ||
272 | #include <sys/mman.h> | |
273 | ||
274 | #endif /* NO_MMAP || USE_WIN32_MMAP */ | |
275 | ||
276 | #ifdef NO_MMAP | |
277 | ||
278 | /* This value must be multiple of (pagesize * 2) */ | |
279 | #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024) | |
280 | ||
281 | #else /* NO_MMAP */ | |
282 | ||
283 | /* This value must be multiple of (pagesize * 2) */ | |
284 | #define DEFAULT_PACKED_GIT_WINDOW_SIZE \ | |
285 | (sizeof(void*) >= 8 \ | |
286 | ? 1 * 1024 * 1024 * 1024 \ | |
287 | : 32 * 1024 * 1024) | |
288 | ||
289 | #endif /* NO_MMAP */ | |
290 | ||
291 | #ifndef MAP_FAILED | |
292 | #define MAP_FAILED ((void *)-1) | |
293 | #endif | |
294 | ||
295 | #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT | |
296 | #define on_disk_bytes(st) ((st).st_size) | |
297 | #else | |
298 | #define on_disk_bytes(st) ((st).st_blocks * 512) | |
299 | #endif | |
300 | ||
301 | #define DEFAULT_PACKED_GIT_LIMIT \ | |
302 | ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256)) | |
303 | ||
304 | #ifdef NO_PREAD | |
305 | #define pread git_pread | |
306 | extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset); | |
307 | #endif | |
308 | /* | |
309 | * Forward decl that will remind us if its twin in cache.h changes. | |
310 | * This function is used in compat/pread.c. But we can't include | |
311 | * cache.h there. | |
312 | */ | |
313 | extern ssize_t read_in_full(int fd, void *buf, size_t count); | |
314 | ||
315 | #ifdef NO_SETENV | |
316 | #define setenv gitsetenv | |
317 | extern int gitsetenv(const char *, const char *, int); | |
318 | #endif | |
319 | ||
320 | #ifdef NO_MKDTEMP | |
321 | #define mkdtemp gitmkdtemp | |
322 | extern char *gitmkdtemp(char *); | |
323 | #endif | |
324 | ||
325 | #ifdef NO_MKSTEMPS | |
326 | #define mkstemps gitmkstemps | |
327 | extern int gitmkstemps(char *, int); | |
328 | #endif | |
329 | ||
330 | #ifdef NO_UNSETENV | |
331 | #define unsetenv gitunsetenv | |
332 | extern void gitunsetenv(const char *); | |
333 | #endif | |
334 | ||
335 | #ifdef NO_STRCASESTR | |
336 | #define strcasestr gitstrcasestr | |
337 | extern char *gitstrcasestr(const char *haystack, const char *needle); | |
338 | #endif | |
339 | ||
340 | #ifdef NO_STRLCPY | |
341 | #define strlcpy gitstrlcpy | |
342 | extern size_t gitstrlcpy(char *, const char *, size_t); | |
343 | #endif | |
344 | ||
345 | #ifdef NO_STRTOUMAX | |
346 | #define strtoumax gitstrtoumax | |
347 | extern uintmax_t gitstrtoumax(const char *, char **, int); | |
348 | #endif | |
349 | ||
350 | #ifdef NO_STRTOK_R | |
351 | #define strtok_r gitstrtok_r | |
352 | extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr); | |
353 | #endif | |
354 | ||
355 | #ifdef NO_HSTRERROR | |
356 | #define hstrerror githstrerror | |
357 | extern const char *githstrerror(int herror); | |
358 | #endif | |
359 | ||
360 | #ifdef NO_MEMMEM | |
361 | #define memmem gitmemmem | |
362 | void *gitmemmem(const void *haystack, size_t haystacklen, | |
363 | const void *needle, size_t needlelen); | |
364 | #endif | |
365 | ||
366 | #ifdef FREAD_READS_DIRECTORIES | |
367 | #ifdef fopen | |
368 | #undef fopen | |
369 | #endif | |
370 | #define fopen(a,b) git_fopen(a,b) | |
371 | extern FILE *git_fopen(const char*, const char*); | |
372 | #endif | |
373 | ||
374 | #ifdef SNPRINTF_RETURNS_BOGUS | |
375 | #define snprintf git_snprintf | |
376 | extern int git_snprintf(char *str, size_t maxsize, | |
377 | const char *format, ...); | |
378 | #define vsnprintf git_vsnprintf | |
379 | extern int git_vsnprintf(char *str, size_t maxsize, | |
380 | const char *format, va_list ap); | |
381 | #endif | |
382 | ||
383 | #ifdef __GLIBC_PREREQ | |
384 | #if __GLIBC_PREREQ(2, 1) | |
385 | #define HAVE_STRCHRNUL | |
386 | #define HAVE_MEMPCPY | |
387 | #endif | |
388 | #endif | |
389 | ||
390 | #ifndef HAVE_STRCHRNUL | |
391 | #define strchrnul gitstrchrnul | |
392 | static inline char *gitstrchrnul(const char *s, int c) | |
393 | { | |
394 | while (*s && *s != c) | |
395 | s++; | |
396 | return (char *)s; | |
397 | } | |
398 | #endif | |
399 | ||
400 | #ifndef HAVE_MEMPCPY | |
401 | #define mempcpy gitmempcpy | |
402 | static inline void *gitmempcpy(void *dest, const void *src, size_t n) | |
403 | { | |
404 | return (char *)memcpy(dest, src, n) + n; | |
405 | } | |
406 | #endif | |
407 | ||
408 | #ifdef NO_INET_PTON | |
409 | int inet_pton(int af, const char *src, void *dst); | |
410 | #endif | |
411 | ||
412 | #ifdef NO_INET_NTOP | |
413 | const char *inet_ntop(int af, const void *src, char *dst, size_t size); | |
414 | #endif | |
415 | ||
416 | extern void release_pack_memory(size_t, int); | |
417 | ||
418 | typedef void (*try_to_free_t)(size_t); | |
419 | extern try_to_free_t set_try_to_free_routine(try_to_free_t); | |
420 | ||
421 | extern char *xstrdup(const char *str); | |
422 | extern void *xmalloc(size_t size); | |
423 | extern void *xmallocz(size_t size); | |
424 | extern void *xmemdupz(const void *data, size_t len); | |
425 | extern char *xstrndup(const char *str, size_t len); | |
426 | extern void *xrealloc(void *ptr, size_t size); | |
427 | extern void *xcalloc(size_t nmemb, size_t size); | |
428 | extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset); | |
429 | extern ssize_t xread(int fd, void *buf, size_t len); | |
430 | extern ssize_t xwrite(int fd, const void *buf, size_t len); | |
431 | extern int xdup(int fd); | |
432 | extern FILE *xfdopen(int fd, const char *mode); | |
433 | extern int xmkstemp(char *template); | |
434 | extern int xmkstemp_mode(char *template, int mode); | |
435 | extern int odb_mkstemp(char *template, size_t limit, const char *pattern); | |
436 | extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1); | |
437 | ||
438 | static inline size_t xsize_t(off_t len) | |
439 | { | |
440 | if (len > (size_t) len) | |
441 | die("Cannot handle files this big"); | |
442 | return (size_t)len; | |
443 | } | |
444 | ||
445 | static inline int has_extension(const char *filename, const char *ext) | |
446 | { | |
447 | size_t len = strlen(filename); | |
448 | size_t extlen = strlen(ext); | |
449 | return len > extlen && !memcmp(filename + len - extlen, ext, extlen); | |
450 | } | |
451 | ||
452 | /* Sane ctype - no locale, and works with signed chars */ | |
453 | #undef isascii | |
454 | #undef isspace | |
455 | #undef isdigit | |
456 | #undef isalpha | |
457 | #undef isalnum | |
458 | #undef tolower | |
459 | #undef toupper | |
460 | extern unsigned char sane_ctype[256]; | |
461 | #define GIT_SPACE 0x01 | |
462 | #define GIT_DIGIT 0x02 | |
463 | #define GIT_ALPHA 0x04 | |
464 | #define GIT_GLOB_SPECIAL 0x08 | |
465 | #define GIT_REGEX_SPECIAL 0x10 | |
466 | #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0) | |
467 | #define isascii(x) (((x) & ~0x7f) == 0) | |
468 | #define isspace(x) sane_istest(x,GIT_SPACE) | |
469 | #define isdigit(x) sane_istest(x,GIT_DIGIT) | |
470 | #define isalpha(x) sane_istest(x,GIT_ALPHA) | |
471 | #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT) | |
472 | #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL) | |
473 | #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL) | |
474 | #define tolower(x) sane_case((unsigned char)(x), 0x20) | |
475 | #define toupper(x) sane_case((unsigned char)(x), 0) | |
476 | ||
477 | static inline int sane_case(int x, int high) | |
478 | { | |
479 | if (sane_istest(x, GIT_ALPHA)) | |
480 | x = (x & ~0x20) | high; | |
481 | return x; | |
482 | } | |
483 | ||
484 | static inline int strtoul_ui(char const *s, int base, unsigned int *result) | |
485 | { | |
486 | unsigned long ul; | |
487 | char *p; | |
488 | ||
489 | errno = 0; | |
490 | ul = strtoul(s, &p, base); | |
491 | if (errno || *p || p == s || (unsigned int) ul != ul) | |
492 | return -1; | |
493 | *result = ul; | |
494 | return 0; | |
495 | } | |
496 | ||
497 | static inline int strtol_i(char const *s, int base, int *result) | |
498 | { | |
499 | long ul; | |
500 | char *p; | |
501 | ||
502 | errno = 0; | |
503 | ul = strtol(s, &p, base); | |
504 | if (errno || *p || p == s || (int) ul != ul) | |
505 | return -1; | |
506 | *result = ul; | |
507 | return 0; | |
508 | } | |
509 | ||
510 | #ifdef INTERNAL_QSORT | |
511 | void git_qsort(void *base, size_t nmemb, size_t size, | |
512 | int(*compar)(const void *, const void *)); | |
513 | #define qsort git_qsort | |
514 | #endif | |
515 | ||
516 | #ifndef DIR_HAS_BSD_GROUP_SEMANTICS | |
517 | # define FORCE_DIR_SET_GID S_ISGID | |
518 | #else | |
519 | # define FORCE_DIR_SET_GID 0 | |
520 | #endif | |
521 | ||
522 | #ifdef NO_NSEC | |
523 | #undef USE_NSEC | |
524 | #define ST_CTIME_NSEC(st) 0 | |
525 | #define ST_MTIME_NSEC(st) 0 | |
526 | #else | |
527 | #ifdef USE_ST_TIMESPEC | |
528 | #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec)) | |
529 | #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec)) | |
530 | #else | |
531 | #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec)) | |
532 | #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec)) | |
533 | #endif | |
534 | #endif | |
535 | ||
536 | #ifdef UNRELIABLE_FSTAT | |
537 | #define fstat_is_reliable() 0 | |
538 | #else | |
539 | #define fstat_is_reliable() 1 | |
540 | #endif | |
541 | ||
542 | /* | |
543 | * Preserves errno, prints a message, but gives no warning for ENOENT. | |
544 | * Always returns the return value of unlink(2). | |
545 | */ | |
546 | int unlink_or_warn(const char *path); | |
547 | /* | |
548 | * Likewise for rmdir(2). | |
549 | */ | |
550 | int rmdir_or_warn(const char *path); | |
551 | /* | |
552 | * Calls the correct function out of {unlink,rmdir}_or_warn based on | |
553 | * the supplied file mode. | |
554 | */ | |
555 | int remove_or_warn(unsigned int mode, const char *path); | |
556 | ||
557 | #endif |