Git 1.7.6.6
[git/git.git] / git-compat-util.h
CommitLineData
4050c0df
JH
1#ifndef GIT_COMPAT_UTIL_H
2#define GIT_COMPAT_UTIL_H
3
b97e9116
MW
4#define _FILE_OFFSET_BITS 64
5
8f1d2e6f 6#ifndef FLEX_ARRAY
8e973991
JH
7/*
8 * See if our compiler is known to support flexible array members.
9 */
203ee91f 10#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
8e973991
JH
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
8f1d2e6f
JH
25#endif
26#endif
27
b4f2a6ac 28#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
f630cfda 29#define bitsizeof(x) (CHAR_BIT * sizeof(x))
b4f2a6ac 30
c03c8315
EFL
31#define maximum_signed_value_of_type(a) \
32 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
33
1368f650
JN
34#define maximum_unsigned_value_of_type(a) \
35 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
36
c03c8315
EFL
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
1368f650
JN
46#define unsigned_add_overflows(a, b) \
47 ((b) > maximum_unsigned_value_of_type(a) - (a))
48
8723f216
NP
49#ifdef __GNUC__
50#define TYPEOF(x) (__typeof__(x))
51#else
52#define TYPEOF(x)
53#endif
54
f630cfda 55#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
db7244bd 56#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
8723f216 57
98cb6f30
PH
58#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
59
cf606e3d
AW
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
4cb18a49
BC
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
6555b196 76#elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
761a889a 77 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__)
85023577
JH
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 */
c902c9a6 80#endif
fb952206
JR
81#define _ALL_SOURCE 1
82#define _GNU_SOURCE 1
83#define _BSD_SOURCE 1
9a695fbf 84#define _NETBSD_SOURCE 1
9398b859 85#define _SGI_SOURCE 1
85023577 86
435bdf8c
MSO
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
4050c0df
JH
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>
4050c0df
JH
104#include <sys/types.h>
105#include <dirent.h>
85023577
JH
106#include <sys/time.h>
107#include <time.h>
108#include <signal.h>
85023577 109#include <fnmatch.h>
f4626df5
JS
110#include <assert.h>
111#include <regex.h>
112#include <utime.h>
088d8802 113#include <syslog.h>
2844923d 114#ifndef NO_SYS_POLL_H
fdc12114 115#include <sys/poll.h>
2844923d
MD
116#else
117#include <poll.h>
118#endif
f4626df5
JS
119#ifndef __MINGW32__
120#include <sys/wait.h>
ebae9ff9 121#include <sys/resource.h>
85023577 122#include <sys/socket.h>
80bbe72b 123#include <sys/ioctl.h>
eb80042c 124#include <termios.h>
2600973f 125#ifndef NO_SYS_SELECT_H
80bbe72b 126#include <sys/select.h>
2600973f 127#endif
85023577
JH
128#include <netinet/in.h>
129#include <netinet/tcp.h>
130#include <arpa/inet.h>
131#include <netdb.h>
132#include <pwd.h>
2844923d 133#ifndef NO_INTTYPES_H
007e2ba6 134#include <inttypes.h>
2844923d
MD
135#else
136#include <stdint.h>
137#endif
41b20017
RJ
138#if defined(__CYGWIN__)
139#undef _XOPEN_SOURCE
140#include <grp.h>
141#define _XOPEN_SOURCE 600
adbc0b6b 142#include "compat/cygwin.h"
41b20017 143#else
fb952206 144#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577 145#include <grp.h>
fb952206 146#define _ALL_SOURCE 1
41b20017 147#endif
f4626df5
JS
148#else /* __MINGW32__ */
149/* pull in Windows compatibility stuff */
150#include "compat/mingw.h"
151#endif /* __MINGW32__ */
d75f8e61
FL
152#ifdef _MSC_VER
153#include "compat/msvc.h"
154#endif
85023577 155
e1c06886
DA
156#ifndef NO_LIBGEN_H
157#include <libgen.h>
158#else
159#define basename gitbasename
160extern char *gitbasename(char *);
161#endif
162
85023577
JH
163#ifndef NO_ICONV
164#include <iconv.h>
165#endif
4050c0df 166
684ec6c6
RS
167#ifndef NO_OPENSSL
168#include <openssl/ssl.h>
169#include <openssl/err.h>
170#endif
171
d0c2449f
JH
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
c4001d92
SP
179#ifndef PRIuMAX
180#define PRIuMAX "llu"
181#endif
182
607bb3ff
JS
183#ifndef PRIu32
184#define PRIu32 "u"
185#endif
186
187#ifndef PRIx32
188#define PRIx32 "x"
189#endif
190
5418d96d
RJ
191#ifndef PRIo32
192#define PRIo32 "o"
193#endif
194
80ba074f
JS
195#ifndef PATH_SEP
196#define PATH_SEP ':'
197#endif
198
cb6a22c0
CW
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
23326d14
JS
206#ifndef STRIP_EXTENSION
207#define STRIP_EXTENSION ""
208#endif
209
25fe217b
JS
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
b6ab349b
MR
218#if __HP_cc >= 61000
219#define NORETURN __attribute__((noreturn))
220#define NORETURN_PTR
221#elif defined(__GNUC__)
4050c0df 222#define NORETURN __attribute__((__noreturn__))
18660bc9 223#define NORETURN_PTR __attribute__((__noreturn__))
aba7dea8
RJ
224#elif defined(_MSC_VER)
225#define NORETURN __declspec(noreturn)
226#define NORETURN_PTR
4050c0df
JH
227#else
228#define NORETURN
18660bc9 229#define NORETURN_PTR
4050c0df
JH
230#ifndef __attribute__
231#define __attribute__(x)
232#endif
233#endif
234
51ea5519
NP
235#include "compat/bswap.h"
236
4050c0df 237/* General helper functions */
ebaa79f4 238extern void vreportf(const char *prefix, const char *err, va_list params);
3bc4181f 239extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
a4f3131c 240extern NORETURN void usage(const char *err);
64b1cb74 241extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
a4f3131c
EFL
242extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
243extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 244extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9 245extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 246
18660bc9 247extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
3bc4181f 248extern void set_error_routine(void (*routine)(const char *err, va_list params));
39a3f5ea 249
698a68be 250extern int prefixcmp(const char *str, const char *prefix);
8cc5b290 251extern int suffixcmp(const char *str, const char *suffix);
698a68be 252
fbca5837
MV
253static inline const char *skip_prefix(const char *str, const char *prefix)
254{
255 size_t len = strlen(prefix);
256 return strncmp(str, prefix, len) ? NULL : str + len;
257}
258
b130a72b 259#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
4050c0df
JH
260
261#ifndef PROT_READ
262#define PROT_READ 1
263#define PROT_WRITE 2
264#define MAP_PRIVATE 1
4050c0df
JH
265#endif
266
d6779124
SP
267#define mmap git_mmap
268#define munmap git_munmap
269extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
270extern int git_munmap(void *start, size_t length);
4050c0df 271
b130a72b
JL
272#else /* NO_MMAP || USE_WIN32_MMAP */
273
274#include <sys/mman.h>
275
276#endif /* NO_MMAP || USE_WIN32_MMAP */
277
278#ifdef NO_MMAP
279
5faaf246 280/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
281#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
282
4050c0df
JH
283#else /* NO_MMAP */
284
5faaf246 285/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
286#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
287 (sizeof(void*) >= 8 \
288 ? 1 * 1024 * 1024 * 1024 \
289 : 32 * 1024 * 1024)
4050c0df
JH
290
291#endif /* NO_MMAP */
292
fcf3a21a
GV
293#ifndef MAP_FAILED
294#define MAP_FAILED ((void *)-1)
295#endif
296
fdb2a2a6
JH
297#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
298#define on_disk_bytes(st) ((st).st_size)
299#else
300#define on_disk_bytes(st) ((st).st_blocks * 512)
301#endif
302
22bac0ea 303#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a 304 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 305
6900679c
SH
306#ifdef NO_PREAD
307#define pread git_pread
308extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
309#endif
14086b0a
SP
310/*
311 * Forward decl that will remind us if its twin in cache.h changes.
312 * This function is used in compat/pread.c. But we can't include
313 * cache.h there.
314 */
315extern ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c 316
4050c0df
JH
317#ifdef NO_SETENV
318#define setenv gitsetenv
319extern int gitsetenv(const char *, const char *, int);
320#endif
321
ca5bb5d5
SP
322#ifdef NO_MKDTEMP
323#define mkdtemp gitmkdtemp
324extern char *gitmkdtemp(char *);
325#endif
326
0620b39b
DA
327#ifdef NO_MKSTEMPS
328#define mkstemps gitmkstemps
329extern int gitmkstemps(char *, int);
330#endif
331
731043fd
JR
332#ifdef NO_UNSETENV
333#define unsetenv gitunsetenv
334extern void gitunsetenv(const char *);
335#endif
336
4050c0df
JH
337#ifdef NO_STRCASESTR
338#define strcasestr gitstrcasestr
339extern char *gitstrcasestr(const char *haystack, const char *needle);
340#endif
341
817151e6
PE
342#ifdef NO_STRLCPY
343#define strlcpy gitstrlcpy
344extern size_t gitstrlcpy(char *, const char *, size_t);
345#endif
346
bc6b4f52
JR
347#ifdef NO_STRTOUMAX
348#define strtoumax gitstrtoumax
349extern uintmax_t gitstrtoumax(const char *, char **, int);
350#endif
351
78457bc0
JN
352#ifdef NO_STRTOK_R
353#define strtok_r gitstrtok_r
354extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr);
355#endif
356
fa0c87c3
AR
357#ifdef NO_HSTRERROR
358#define hstrerror githstrerror
359extern const char *githstrerror(int herror);
360#endif
361
b21b9f1d
RS
362#ifdef NO_MEMMEM
363#define memmem gitmemmem
364void *gitmemmem(const void *haystack, size_t haystacklen,
365 const void *needle, size_t needlelen);
366#endif
367
cba22528 368#ifdef FREAD_READS_DIRECTORIES
c5445fe0
JS
369#ifdef fopen
370#undef fopen
371#endif
cba22528
BC
372#define fopen(a,b) git_fopen(a,b)
373extern FILE *git_fopen(const char*, const char*);
374#endif
375
c4582f93
MR
376#ifdef SNPRINTF_RETURNS_BOGUS
377#define snprintf git_snprintf
378extern int git_snprintf(char *str, size_t maxsize,
379 const char *format, ...);
380#define vsnprintf git_vsnprintf
381extern int git_vsnprintf(char *str, size_t maxsize,
382 const char *format, va_list ap);
383#endif
384
726c8ef5
JS
385#ifdef __GLIBC_PREREQ
386#if __GLIBC_PREREQ(2, 1)
387#define HAVE_STRCHRNUL
137c6eaa 388#define HAVE_MEMPCPY
726c8ef5
JS
389#endif
390#endif
391
392#ifndef HAVE_STRCHRNUL
659c69cf 393#define strchrnul gitstrchrnul
9e79f00f
AE
394static inline char *gitstrchrnul(const char *s, int c)
395{
396 while (*s && *s != c)
397 s++;
398 return (char *)s;
399}
659c69cf
RS
400#endif
401
137c6eaa
JN
402#ifndef HAVE_MEMPCPY
403#define mempcpy gitmempcpy
404static inline void *gitmempcpy(void *dest, const void *src, size_t n)
405{
406 return (char *)memcpy(dest, src, n) + n;
407}
408#endif
409
da523cc5
MP
410#ifdef NO_INET_PTON
411int inet_pton(int af, const char *src, void *dst);
412#endif
413
414#ifdef NO_INET_NTOP
415const char *inet_ntop(int af, const void *src, char *dst, size_t size);
416#endif
417
d1efefa4 418extern void release_pack_memory(size_t, int);
97bfeb34 419
851c34b0
JS
420typedef void (*try_to_free_t)(size_t);
421extern try_to_free_t set_try_to_free_routine(try_to_free_t);
a9a74636 422
112db553
LT
423extern char *xstrdup(const char *str);
424extern void *xmalloc(size_t size);
5bf9219d 425extern void *xmallocz(size_t size);
112db553
LT
426extern void *xmemdupz(const void *data, size_t len);
427extern char *xstrndup(const char *str, size_t len);
428extern void *xrealloc(void *ptr, size_t size);
429extern void *xcalloc(size_t nmemb, size_t size);
430extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
431extern ssize_t xread(int fd, void *buf, size_t len);
432extern ssize_t xwrite(int fd, const void *buf, size_t len);
433extern int xdup(int fd);
434extern FILE *xfdopen(int fd, const char *mode);
435extern int xmkstemp(char *template);
463db9b1 436extern int xmkstemp_mode(char *template, int mode);
6e180cdc
JH
437extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
438extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
f21a47b2 439
dc49cd76
SP
440static inline size_t xsize_t(off_t len)
441{
46be82df
TR
442 if (len > (size_t) len)
443 die("Cannot handle files this big");
dc49cd76
SP
444 return (size_t)len;
445}
446
5bb1cda5 447static inline int has_extension(const char *filename, const char *ext)
83a2b841 448{
5bb1cda5
RS
449 size_t len = strlen(filename);
450 size_t extlen = strlen(ext);
83a2b841
RS
451 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
452}
453
4050c0df 454/* Sane ctype - no locale, and works with signed chars */
c2e9364a 455#undef isascii
4050c0df
JH
456#undef isspace
457#undef isdigit
458#undef isalpha
459#undef isalnum
460#undef tolower
461#undef toupper
462extern unsigned char sane_ctype[256];
463#define GIT_SPACE 0x01
464#define GIT_DIGIT 0x02
465#define GIT_ALPHA 0x04
8cc32992 466#define GIT_GLOB_SPECIAL 0x08
f9b7cce6 467#define GIT_REGEX_SPECIAL 0x10
2f6c9760 468#define GIT_PATHSPEC_MAGIC 0x20
4050c0df 469#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
c2e9364a 470#define isascii(x) (((x) & ~0x7f) == 0)
4050c0df
JH
471#define isspace(x) sane_istest(x,GIT_SPACE)
472#define isdigit(x) sane_istest(x,GIT_DIGIT)
473#define isalpha(x) sane_istest(x,GIT_ALPHA)
474#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
8cc32992 475#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
f9b7cce6 476#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
4050c0df
JH
477#define tolower(x) sane_case((unsigned char)(x), 0x20)
478#define toupper(x) sane_case((unsigned char)(x), 0)
2f6c9760 479#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
4050c0df
JH
480
481static inline int sane_case(int x, int high)
482{
483 if (sane_istest(x, GIT_ALPHA))
484 x = (x & ~0x20) | high;
485 return x;
486}
487
6aead43d
JM
488static inline int strtoul_ui(char const *s, int base, unsigned int *result)
489{
490 unsigned long ul;
491 char *p;
492
493 errno = 0;
494 ul = strtoul(s, &p, base);
495 if (errno || *p || p == s || (unsigned int) ul != ul)
496 return -1;
497 *result = ul;
498 return 0;
499}
500
7791ecbc
JH
501static inline int strtol_i(char const *s, int base, int *result)
502{
503 long ul;
504 char *p;
505
506 errno = 0;
507 ul = strtol(s, &p, base);
508 if (errno || *p || p == s || (int) ul != ul)
509 return -1;
510 *result = ul;
511 return 0;
512}
513
43fe901b
BD
514#ifdef INTERNAL_QSORT
515void git_qsort(void *base, size_t nmemb, size_t size,
516 int(*compar)(const void *, const void *));
517#define qsort git_qsort
518#endif
519
81a24b52
AR
520#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
521# define FORCE_DIR_SET_GID S_ISGID
522#else
523# define FORCE_DIR_SET_GID 0
524#endif
525
c06ff490
KB
526#ifdef NO_NSEC
527#undef USE_NSEC
528#define ST_CTIME_NSEC(st) 0
529#define ST_MTIME_NSEC(st) 0
530#else
c567383b
BG
531#ifdef USE_ST_TIMESPEC
532#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
533#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
534#else
c06ff490
KB
535#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
536#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
537#endif
c567383b 538#endif
c06ff490 539
34779c53
JS
540#ifdef UNRELIABLE_FSTAT
541#define fstat_is_reliable() 0
542#else
543#define fstat_is_reliable() 1
544#endif
545
ab8632ae 546#ifndef va_copy
26db0f2e
JN
547/*
548 * Since an obvious implementation of va_list would be to make it a
549 * pointer into the stack frame, a simple assignment will work on
550 * many systems. But let's try to be more portable.
551 */
552#ifdef __va_copy
553#define va_copy(dst, src) __va_copy(dst, src)
554#else
555#define va_copy(dst, src) ((dst) = (src))
556#endif
ab8632ae
JK
557#endif
558
fc71db39
AR
559/*
560 * Preserves errno, prints a message, but gives no warning for ENOENT.
561 * Always returns the return value of unlink(2).
562 */
563int unlink_or_warn(const char *path);
d1723296
PC
564/*
565 * Likewise for rmdir(2).
566 */
567int rmdir_or_warn(const char *path);
80d706af
PC
568/*
569 * Calls the correct function out of {unlink,rmdir}_or_warn based on
570 * the supplied file mode.
571 */
572int remove_or_warn(unsigned int mode, const char *path);
fc71db39 573
4050c0df 574#endif