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