Git 1.7.8-rc0
[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
d1c69255
TN
218#ifndef find_last_dir_sep
219#define find_last_dir_sep(path) strrchr(path, '/')
220#endif
221
b6ab349b
MR
222#if __HP_cc >= 61000
223#define NORETURN __attribute__((noreturn))
224#define NORETURN_PTR
6520c846 225#elif defined(__GNUC__) && !defined(NO_NORETURN)
4050c0df 226#define NORETURN __attribute__((__noreturn__))
18660bc9 227#define NORETURN_PTR __attribute__((__noreturn__))
aba7dea8
RJ
228#elif defined(_MSC_VER)
229#define NORETURN __declspec(noreturn)
230#define NORETURN_PTR
4050c0df
JH
231#else
232#define NORETURN
18660bc9 233#define NORETURN_PTR
4050c0df
JH
234#ifndef __attribute__
235#define __attribute__(x)
236#endif
237#endif
238
51ea5519
NP
239#include "compat/bswap.h"
240
4050c0df 241/* General helper functions */
ebaa79f4 242extern void vreportf(const char *prefix, const char *err, va_list params);
3bc4181f 243extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
a4f3131c 244extern NORETURN void usage(const char *err);
64b1cb74 245extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
a4f3131c
EFL
246extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
247extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 248extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9 249extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 250
18660bc9 251extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
3bc4181f 252extern void set_error_routine(void (*routine)(const char *err, va_list params));
39a3f5ea 253
698a68be 254extern int prefixcmp(const char *str, const char *prefix);
8cc5b290 255extern int suffixcmp(const char *str, const char *suffix);
698a68be 256
fbca5837
MV
257static inline const char *skip_prefix(const char *str, const char *prefix)
258{
259 size_t len = strlen(prefix);
260 return strncmp(str, prefix, len) ? NULL : str + len;
261}
262
b130a72b 263#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
4050c0df
JH
264
265#ifndef PROT_READ
266#define PROT_READ 1
267#define PROT_WRITE 2
268#define MAP_PRIVATE 1
4050c0df
JH
269#endif
270
d6779124
SP
271#define mmap git_mmap
272#define munmap git_munmap
273extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
274extern int git_munmap(void *start, size_t length);
4050c0df 275
b130a72b
JL
276#else /* NO_MMAP || USE_WIN32_MMAP */
277
278#include <sys/mman.h>
279
280#endif /* NO_MMAP || USE_WIN32_MMAP */
281
282#ifdef NO_MMAP
283
5faaf246 284/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
285#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
286
4050c0df
JH
287#else /* NO_MMAP */
288
5faaf246 289/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
290#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
291 (sizeof(void*) >= 8 \
292 ? 1 * 1024 * 1024 * 1024 \
293 : 32 * 1024 * 1024)
4050c0df
JH
294
295#endif /* NO_MMAP */
296
fcf3a21a
GV
297#ifndef MAP_FAILED
298#define MAP_FAILED ((void *)-1)
299#endif
300
fdb2a2a6
JH
301#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
302#define on_disk_bytes(st) ((st).st_size)
303#else
304#define on_disk_bytes(st) ((st).st_blocks * 512)
305#endif
306
22bac0ea 307#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a 308 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 309
6900679c
SH
310#ifdef NO_PREAD
311#define pread git_pread
312extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
313#endif
14086b0a
SP
314/*
315 * Forward decl that will remind us if its twin in cache.h changes.
316 * This function is used in compat/pread.c. But we can't include
317 * cache.h there.
318 */
319extern ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c 320
4050c0df
JH
321#ifdef NO_SETENV
322#define setenv gitsetenv
323extern int gitsetenv(const char *, const char *, int);
324#endif
325
ca5bb5d5
SP
326#ifdef NO_MKDTEMP
327#define mkdtemp gitmkdtemp
328extern char *gitmkdtemp(char *);
329#endif
330
0620b39b
DA
331#ifdef NO_MKSTEMPS
332#define mkstemps gitmkstemps
333extern int gitmkstemps(char *, int);
334#endif
335
731043fd
JR
336#ifdef NO_UNSETENV
337#define unsetenv gitunsetenv
338extern void gitunsetenv(const char *);
339#endif
340
4050c0df
JH
341#ifdef NO_STRCASESTR
342#define strcasestr gitstrcasestr
343extern char *gitstrcasestr(const char *haystack, const char *needle);
344#endif
345
817151e6
PE
346#ifdef NO_STRLCPY
347#define strlcpy gitstrlcpy
348extern size_t gitstrlcpy(char *, const char *, size_t);
349#endif
350
bc6b4f52
JR
351#ifdef NO_STRTOUMAX
352#define strtoumax gitstrtoumax
353extern uintmax_t gitstrtoumax(const char *, char **, int);
354#endif
355
78457bc0
JN
356#ifdef NO_STRTOK_R
357#define strtok_r gitstrtok_r
358extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr);
359#endif
360
fa0c87c3
AR
361#ifdef NO_HSTRERROR
362#define hstrerror githstrerror
363extern const char *githstrerror(int herror);
364#endif
365
b21b9f1d
RS
366#ifdef NO_MEMMEM
367#define memmem gitmemmem
368void *gitmemmem(const void *haystack, size_t haystacklen,
369 const void *needle, size_t needlelen);
370#endif
371
cba22528 372#ifdef FREAD_READS_DIRECTORIES
c5445fe0
JS
373#ifdef fopen
374#undef fopen
375#endif
cba22528
BC
376#define fopen(a,b) git_fopen(a,b)
377extern FILE *git_fopen(const char*, const char*);
378#endif
379
c4582f93
MR
380#ifdef SNPRINTF_RETURNS_BOGUS
381#define snprintf git_snprintf
382extern int git_snprintf(char *str, size_t maxsize,
383 const char *format, ...);
384#define vsnprintf git_vsnprintf
385extern int git_vsnprintf(char *str, size_t maxsize,
386 const char *format, va_list ap);
387#endif
388
726c8ef5
JS
389#ifdef __GLIBC_PREREQ
390#if __GLIBC_PREREQ(2, 1)
391#define HAVE_STRCHRNUL
137c6eaa 392#define HAVE_MEMPCPY
726c8ef5
JS
393#endif
394#endif
395
396#ifndef HAVE_STRCHRNUL
659c69cf 397#define strchrnul gitstrchrnul
9e79f00f
AE
398static inline char *gitstrchrnul(const char *s, int c)
399{
400 while (*s && *s != c)
401 s++;
402 return (char *)s;
403}
659c69cf
RS
404#endif
405
137c6eaa
JN
406#ifndef HAVE_MEMPCPY
407#define mempcpy gitmempcpy
408static inline void *gitmempcpy(void *dest, const void *src, size_t n)
409{
410 return (char *)memcpy(dest, src, n) + n;
411}
412#endif
413
da523cc5
MP
414#ifdef NO_INET_PTON
415int inet_pton(int af, const char *src, void *dst);
416#endif
417
418#ifdef NO_INET_NTOP
419const char *inet_ntop(int af, const void *src, char *dst, size_t size);
420#endif
421
d1efefa4 422extern void release_pack_memory(size_t, int);
97bfeb34 423
851c34b0
JS
424typedef void (*try_to_free_t)(size_t);
425extern try_to_free_t set_try_to_free_routine(try_to_free_t);
a9a74636 426
112db553
LT
427extern char *xstrdup(const char *str);
428extern void *xmalloc(size_t size);
5bf9219d 429extern void *xmallocz(size_t size);
112db553
LT
430extern void *xmemdupz(const void *data, size_t len);
431extern char *xstrndup(const char *str, size_t len);
432extern void *xrealloc(void *ptr, size_t size);
433extern void *xcalloc(size_t nmemb, size_t size);
434extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
435extern ssize_t xread(int fd, void *buf, size_t len);
436extern ssize_t xwrite(int fd, const void *buf, size_t len);
437extern int xdup(int fd);
438extern FILE *xfdopen(int fd, const char *mode);
439extern int xmkstemp(char *template);
463db9b1 440extern int xmkstemp_mode(char *template, int mode);
6e180cdc
JH
441extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
442extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
f21a47b2 443
dc49cd76
SP
444static inline size_t xsize_t(off_t len)
445{
46be82df
TR
446 if (len > (size_t) len)
447 die("Cannot handle files this big");
dc49cd76
SP
448 return (size_t)len;
449}
450
5bb1cda5 451static inline int has_extension(const char *filename, const char *ext)
83a2b841 452{
5bb1cda5
RS
453 size_t len = strlen(filename);
454 size_t extlen = strlen(ext);
83a2b841
RS
455 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
456}
457
4050c0df 458/* Sane ctype - no locale, and works with signed chars */
c2e9364a 459#undef isascii
4050c0df
JH
460#undef isspace
461#undef isdigit
462#undef isalpha
463#undef isalnum
464#undef tolower
465#undef toupper
466extern unsigned char sane_ctype[256];
467#define GIT_SPACE 0x01
468#define GIT_DIGIT 0x02
469#define GIT_ALPHA 0x04
8cc32992 470#define GIT_GLOB_SPECIAL 0x08
f9b7cce6 471#define GIT_REGEX_SPECIAL 0x10
2f6c9760 472#define GIT_PATHSPEC_MAGIC 0x20
4050c0df 473#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
c2e9364a 474#define isascii(x) (((x) & ~0x7f) == 0)
4050c0df
JH
475#define isspace(x) sane_istest(x,GIT_SPACE)
476#define isdigit(x) sane_istest(x,GIT_DIGIT)
477#define isalpha(x) sane_istest(x,GIT_ALPHA)
478#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
8cc32992 479#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
f9b7cce6 480#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
4050c0df
JH
481#define tolower(x) sane_case((unsigned char)(x), 0x20)
482#define toupper(x) sane_case((unsigned char)(x), 0)
2f6c9760 483#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
4050c0df
JH
484
485static inline int sane_case(int x, int high)
486{
487 if (sane_istest(x, GIT_ALPHA))
488 x = (x & ~0x20) | high;
489 return x;
490}
491
6aead43d
JM
492static inline int strtoul_ui(char const *s, int base, unsigned int *result)
493{
494 unsigned long ul;
495 char *p;
496
497 errno = 0;
498 ul = strtoul(s, &p, base);
499 if (errno || *p || p == s || (unsigned int) ul != ul)
500 return -1;
501 *result = ul;
502 return 0;
503}
504
7791ecbc
JH
505static inline int strtol_i(char const *s, int base, int *result)
506{
507 long ul;
508 char *p;
509
510 errno = 0;
511 ul = strtol(s, &p, base);
512 if (errno || *p || p == s || (int) ul != ul)
513 return -1;
514 *result = ul;
515 return 0;
516}
517
43fe901b
BD
518#ifdef INTERNAL_QSORT
519void git_qsort(void *base, size_t nmemb, size_t size,
520 int(*compar)(const void *, const void *));
521#define qsort git_qsort
522#endif
523
81a24b52
AR
524#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
525# define FORCE_DIR_SET_GID S_ISGID
526#else
527# define FORCE_DIR_SET_GID 0
528#endif
529
c06ff490
KB
530#ifdef NO_NSEC
531#undef USE_NSEC
532#define ST_CTIME_NSEC(st) 0
533#define ST_MTIME_NSEC(st) 0
534#else
c567383b
BG
535#ifdef USE_ST_TIMESPEC
536#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
537#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
538#else
c06ff490
KB
539#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
540#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
541#endif
c567383b 542#endif
c06ff490 543
34779c53
JS
544#ifdef UNRELIABLE_FSTAT
545#define fstat_is_reliable() 0
546#else
547#define fstat_is_reliable() 1
548#endif
549
ab8632ae 550#ifndef va_copy
26db0f2e
JN
551/*
552 * Since an obvious implementation of va_list would be to make it a
553 * pointer into the stack frame, a simple assignment will work on
554 * many systems. But let's try to be more portable.
555 */
556#ifdef __va_copy
557#define va_copy(dst, src) __va_copy(dst, src)
558#else
559#define va_copy(dst, src) ((dst) = (src))
560#endif
ab8632ae
JK
561#endif
562
fc71db39
AR
563/*
564 * Preserves errno, prints a message, but gives no warning for ENOENT.
565 * Always returns the return value of unlink(2).
566 */
567int unlink_or_warn(const char *path);
d1723296
PC
568/*
569 * Likewise for rmdir(2).
570 */
571int rmdir_or_warn(const char *path);
80d706af
PC
572/*
573 * Calls the correct function out of {unlink,rmdir}_or_warn based on
574 * the supplied file mode.
575 */
576int remove_or_warn(unsigned int mode, const char *path);
fc71db39 577
4050c0df 578#endif