Git 2.2.2
[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__) && \
6c109904 77 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
92164af9 78 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__)
85023577
JH
79#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
80#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
c902c9a6 81#endif
fb952206
JR
82#define _ALL_SOURCE 1
83#define _GNU_SOURCE 1
84#define _BSD_SOURCE 1
f978a99f 85#define _DEFAULT_SOURCE 1
9a695fbf 86#define _NETBSD_SOURCE 1
9398b859 87#define _SGI_SOURCE 1
85023577 88
380395d0 89#if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
8453c125 90# if defined (_MSC_VER) && !defined(_WIN32_WINNT)
41f29991
RJ
91# define _WIN32_WINNT 0x0502
92# endif
435bdf8c
MSO
93#define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
94#include <winsock2.h>
95#include <windows.h>
380395d0 96#define GIT_WINDOWS_NATIVE
435bdf8c
MSO
97#endif
98
4050c0df
JH
99#include <unistd.h>
100#include <stdio.h>
101#include <sys/stat.h>
102#include <fcntl.h>
103#include <stddef.h>
104#include <stdlib.h>
105#include <stdarg.h>
106#include <string.h>
b3e103da 107#ifdef HAVE_STRINGS_H
6c109904
JS
108#include <strings.h> /* for strcasecmp() */
109#endif
4050c0df
JH
110#include <errno.h>
111#include <limits.h>
b2d05e06 112#ifdef NEEDS_SYS_PARAM_H
4050c0df 113#include <sys/param.h>
6ede7205 114#endif
4050c0df
JH
115#include <sys/types.h>
116#include <dirent.h>
85023577
JH
117#include <sys/time.h>
118#include <time.h>
119#include <signal.h>
f4626df5
JS
120#include <assert.h>
121#include <regex.h>
122#include <utime.h>
088d8802 123#include <syslog.h>
2844923d 124#ifndef NO_SYS_POLL_H
fdc12114 125#include <sys/poll.h>
2844923d
MD
126#else
127#include <poll.h>
128#endif
2f0aaaf9 129
cfc755d3
VR
130#if defined(__MINGW32__)
131/* pull in Windows compatibility stuff */
132#include "compat/mingw.h"
133#elif defined(_MSC_VER)
134#include "compat/msvc.h"
135#else
f4626df5 136#include <sys/wait.h>
ebae9ff9 137#include <sys/resource.h>
85023577 138#include <sys/socket.h>
80bbe72b 139#include <sys/ioctl.h>
eb80042c 140#include <termios.h>
2600973f 141#ifndef NO_SYS_SELECT_H
80bbe72b 142#include <sys/select.h>
2600973f 143#endif
85023577
JH
144#include <netinet/in.h>
145#include <netinet/tcp.h>
146#include <arpa/inet.h>
147#include <netdb.h>
148#include <pwd.h>
e2770979 149#include <sys/un.h>
2844923d 150#ifndef NO_INTTYPES_H
007e2ba6 151#include <inttypes.h>
2844923d
MD
152#else
153#include <stdint.h>
154#endif
6c109904
JS
155#ifdef NO_INTPTR_T
156/*
157 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
158 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
159 * while on IP16 and IP16L32 it is "int" (resp. "short")
160 * Size needs to match (or exceed) 'sizeof(void *)'.
161 * We can't take "long long" here as not everybody has it.
162 */
163typedef long intptr_t;
164typedef unsigned long uintptr_t;
165#endif
41b20017
RJ
166#if defined(__CYGWIN__)
167#undef _XOPEN_SOURCE
168#include <grp.h>
169#define _XOPEN_SOURCE 600
170#else
fb952206 171#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577 172#include <grp.h>
fb952206 173#define _ALL_SOURCE 1
41b20017 174#endif
d75f8e61 175#endif
85023577 176
76759c7d
TB
177/* used on Mac OS X */
178#ifdef PRECOMPOSE_UNICODE
179#include "compat/precompose_utf8.h"
180#else
181#define precompose_str(in,i_nfd2nfc)
182#define precompose_argv(c,v)
183#define probe_utf8_pathname_composition(a,b)
184#endif
185
0539ecfd
JS
186#ifdef MKDIR_WO_TRAILING_SLASH
187#define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
188extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
189#endif
190
7f9e848c
JS
191#ifdef NO_STRUCT_ITIMERVAL
192struct itimerval {
193 struct timeval it_interval;
194 struct timeval it_value;
981ff520 195};
7f9e848c
JS
196#endif
197
198#ifdef NO_SETITIMER
199#define setitimer(which,value,ovalue)
200#endif
201
e1c06886
DA
202#ifndef NO_LIBGEN_H
203#include <libgen.h>
204#else
205#define basename gitbasename
206extern char *gitbasename(char *);
207#endif
208
85023577
JH
209#ifndef NO_ICONV
210#include <iconv.h>
211#endif
4050c0df 212
684ec6c6
RS
213#ifndef NO_OPENSSL
214#include <openssl/ssl.h>
215#include <openssl/err.h>
216#endif
217
3b130ade
DM
218/* On most systems <netdb.h> would have given us this, but
219 * not on some systems (e.g. z/OS).
220 */
221#ifndef NI_MAXHOST
222#define NI_MAXHOST 1025
223#endif
224
225#ifndef NI_MAXSERV
226#define NI_MAXSERV 32
227#endif
228
d0c2449f
JH
229/* On most systems <limits.h> would have given us this, but
230 * not on some systems (e.g. GNU/Hurd).
231 */
232#ifndef PATH_MAX
233#define PATH_MAX 4096
234#endif
235
c4001d92
SP
236#ifndef PRIuMAX
237#define PRIuMAX "llu"
238#endif
239
607bb3ff
JS
240#ifndef PRIu32
241#define PRIu32 "u"
242#endif
243
244#ifndef PRIx32
245#define PRIx32 "x"
246#endif
247
5418d96d
RJ
248#ifndef PRIo32
249#define PRIo32 "o"
250#endif
251
80ba074f
JS
252#ifndef PATH_SEP
253#define PATH_SEP ':'
254#endif
255
cb6a22c0
CW
256#ifdef HAVE_PATHS_H
257#include <paths.h>
258#endif
259#ifndef _PATH_DEFPATH
260#define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
261#endif
262
23326d14
JS
263#ifndef STRIP_EXTENSION
264#define STRIP_EXTENSION ""
265#endif
266
25fe217b 267#ifndef has_dos_drive_prefix
bf728346
RS
268static inline int git_has_dos_drive_prefix(const char *path)
269{
270 return 0;
271}
272#define has_dos_drive_prefix git_has_dos_drive_prefix
25fe217b
JS
273#endif
274
bf728346
RS
275#ifndef is_dir_sep
276static inline int git_is_dir_sep(int c)
277{
278 return c == '/';
279}
280#define is_dir_sep git_is_dir_sep
c2369bdf
CZ
281#endif
282
bf728346
RS
283#ifndef offset_1st_component
284static inline int git_offset_1st_component(const char *path)
285{
286 return is_dir_sep(path[0]);
287}
288#define offset_1st_component git_offset_1st_component
25fe217b
JS
289#endif
290
d1c69255 291#ifndef find_last_dir_sep
bf728346
RS
292static inline char *git_find_last_dir_sep(const char *path)
293{
294 return strrchr(path, '/');
295}
296#define find_last_dir_sep git_find_last_dir_sep
d1c69255
TN
297#endif
298
e4ac953b 299#if defined(__HP_cc) && (__HP_cc >= 61000)
b6ab349b
MR
300#define NORETURN __attribute__((noreturn))
301#define NORETURN_PTR
6520c846 302#elif defined(__GNUC__) && !defined(NO_NORETURN)
4050c0df 303#define NORETURN __attribute__((__noreturn__))
18660bc9 304#define NORETURN_PTR __attribute__((__noreturn__))
aba7dea8
RJ
305#elif defined(_MSC_VER)
306#define NORETURN __declspec(noreturn)
307#define NORETURN_PTR
4050c0df
JH
308#else
309#define NORETURN
18660bc9 310#define NORETURN_PTR
8cd7ebc8 311#ifndef __GNUC__
4050c0df
JH
312#ifndef __attribute__
313#define __attribute__(x)
314#endif
315#endif
8cd7ebc8 316#endif
4050c0df 317
9fe3edc4
RJ
318/* The sentinel attribute is valid from gcc version 4.0 */
319#if defined(__GNUC__) && (__GNUC__ >= 4)
320#define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
321#else
322#define LAST_ARG_MUST_BE_NULL
323#endif
324
51ea5519
NP
325#include "compat/bswap.h"
326
cebcab18 327#include "wildmatch.h"
cebcab18 328
9ccc0c08
RS
329struct strbuf;
330
4050c0df 331/* General helper functions */
ebaa79f4 332extern void vreportf(const char *prefix, const char *err, va_list params);
3bc4181f 333extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
a4f3131c 334extern NORETURN void usage(const char *err);
64b1cb74 335extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
a4f3131c
EFL
336extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
337extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 338extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9 339extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 340
f2be034c
BG
341#ifndef NO_OPENSSL
342#ifdef APPLE_COMMON_CRYPTO
343#include "compat/apple-common-crypto.h"
344#else
345#include <openssl/evp.h>
346#include <openssl/hmac.h>
347#endif /* APPLE_COMMON_CRYPTO */
348#include <openssl/x509v3.h>
349#endif /* NO_OPENSSL */
350
e208f9cc
JK
351/*
352 * Let callers be aware of the constant return value; this can help
9798f7e5
MK
353 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
354 * because some compilers may not support variadic macros. Since we're only
355 * trying to help gcc, anyway, it's OK; other compilers will fall back to
356 * using the function as usual.
e208f9cc 357 */
ff0a80af 358#if defined(__GNUC__)
87fe5df3
JK
359static inline int const_error(void)
360{
361 return -1;
362}
363#define error(...) (error(__VA_ARGS__), const_error())
e208f9cc
JK
364#endif
365
18660bc9 366extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
3bc4181f 367extern void set_error_routine(void (*routine)(const char *err, va_list params));
c19a490e 368extern void set_die_is_recursing_routine(int (*routine)(void));
39a3f5ea 369
95662315 370extern int starts_with(const char *str, const char *prefix);
698a68be 371
cf4fff57
JK
372/*
373 * If the string "str" begins with the string found in "prefix", return 1.
374 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
375 * the string right after the prefix).
376 *
377 * Otherwise, return 0 and leave "out" untouched.
378 *
379 * Examples:
380 *
381 * [extract branch name, fail if not a branch]
382 * if (!skip_prefix(ref, "refs/heads/", &branch)
383 * return -1;
384 *
385 * [skip prefix if present, otherwise use whole string]
386 * skip_prefix(name, "refs/heads/", &name);
387 */
388static inline int skip_prefix(const char *str, const char *prefix,
389 const char **out)
fbca5837 390{
ba399c46 391 do {
cf4fff57
JK
392 if (!*prefix) {
393 *out = str;
394 return 1;
395 }
ba399c46 396 } while (*str++ == *prefix++);
cf4fff57 397 return 0;
fbca5837
MV
398}
399
35480f0b
JK
400/*
401 * If buf ends with suffix, return 1 and subtract the length of the suffix
402 * from *len. Otherwise, return 0 and leave *len untouched.
403 */
404static inline int strip_suffix_mem(const char *buf, size_t *len,
405 const char *suffix)
406{
407 size_t suflen = strlen(suffix);
408 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
409 return 0;
410 *len -= suflen;
411 return 1;
412}
413
414/*
415 * If str ends with suffix, return 1 and set *len to the size of the string
416 * without the suffix. Otherwise, return 0 and set *len to the size of the
417 * string.
418 *
419 * Note that we do _not_ NUL-terminate str to the new length.
420 */
421static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
422{
423 *len = strlen(str);
424 return strip_suffix_mem(str, len, suffix);
425}
426
f52a35fd
JK
427static inline int ends_with(const char *str, const char *suffix)
428{
429 size_t len;
430 return strip_suffix(str, suffix, &len);
431}
432
b130a72b 433#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
4050c0df
JH
434
435#ifndef PROT_READ
436#define PROT_READ 1
437#define PROT_WRITE 2
438#define MAP_PRIVATE 1
4050c0df
JH
439#endif
440
d6779124
SP
441#define mmap git_mmap
442#define munmap git_munmap
443extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
444extern int git_munmap(void *start, size_t length);
4050c0df 445
b130a72b
JL
446#else /* NO_MMAP || USE_WIN32_MMAP */
447
448#include <sys/mman.h>
449
450#endif /* NO_MMAP || USE_WIN32_MMAP */
451
452#ifdef NO_MMAP
453
5faaf246 454/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
455#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
456
4050c0df
JH
457#else /* NO_MMAP */
458
5faaf246 459/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
460#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
461 (sizeof(void*) >= 8 \
462 ? 1 * 1024 * 1024 * 1024 \
463 : 32 * 1024 * 1024)
4050c0df
JH
464
465#endif /* NO_MMAP */
466
fcf3a21a
GV
467#ifndef MAP_FAILED
468#define MAP_FAILED ((void *)-1)
469#endif
470
fdb2a2a6
JH
471#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
472#define on_disk_bytes(st) ((st).st_size)
473#else
474#define on_disk_bytes(st) ((st).st_blocks * 512)
475#endif
476
22bac0ea 477#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a 478 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 479
6900679c
SH
480#ifdef NO_PREAD
481#define pread git_pread
482extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
483#endif
14086b0a
SP
484/*
485 * Forward decl that will remind us if its twin in cache.h changes.
486 * This function is used in compat/pread.c. But we can't include
487 * cache.h there.
488 */
489extern ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c 490
4050c0df
JH
491#ifdef NO_SETENV
492#define setenv gitsetenv
493extern int gitsetenv(const char *, const char *, int);
494#endif
495
ca5bb5d5
SP
496#ifdef NO_MKDTEMP
497#define mkdtemp gitmkdtemp
498extern char *gitmkdtemp(char *);
499#endif
500
0620b39b
DA
501#ifdef NO_MKSTEMPS
502#define mkstemps gitmkstemps
503extern int gitmkstemps(char *, int);
504#endif
505
731043fd
JR
506#ifdef NO_UNSETENV
507#define unsetenv gitunsetenv
508extern void gitunsetenv(const char *);
509#endif
510
4050c0df
JH
511#ifdef NO_STRCASESTR
512#define strcasestr gitstrcasestr
513extern char *gitstrcasestr(const char *haystack, const char *needle);
514#endif
515
817151e6
PE
516#ifdef NO_STRLCPY
517#define strlcpy gitstrlcpy
518extern size_t gitstrlcpy(char *, const char *, size_t);
519#endif
520
bc6b4f52
JR
521#ifdef NO_STRTOUMAX
522#define strtoumax gitstrtoumax
523extern uintmax_t gitstrtoumax(const char *, char **, int);
97000ba6
JS
524#define strtoimax gitstrtoimax
525extern intmax_t gitstrtoimax(const char *, char **, int);
bc6b4f52
JR
526#endif
527
fa0c87c3
AR
528#ifdef NO_HSTRERROR
529#define hstrerror githstrerror
530extern const char *githstrerror(int herror);
531#endif
532
b21b9f1d
RS
533#ifdef NO_MEMMEM
534#define memmem gitmemmem
535void *gitmemmem(const void *haystack, size_t haystacklen,
536 const void *needle, size_t needlelen);
537#endif
538
40036bed
MK
539#ifdef NO_GETPAGESIZE
540#define getpagesize() sysconf(_SC_PAGESIZE)
541#endif
542
cba22528 543#ifdef FREAD_READS_DIRECTORIES
c5445fe0
JS
544#ifdef fopen
545#undef fopen
546#endif
cba22528
BC
547#define fopen(a,b) git_fopen(a,b)
548extern FILE *git_fopen(const char*, const char*);
549#endif
550
c4582f93 551#ifdef SNPRINTF_RETURNS_BOGUS
ab03803c
BS
552#ifdef snprintf
553#undef snprintf
554#endif
c4582f93
MR
555#define snprintf git_snprintf
556extern int git_snprintf(char *str, size_t maxsize,
557 const char *format, ...);
ab03803c
BS
558#ifdef vsnprintf
559#undef vsnprintf
560#endif
c4582f93
MR
561#define vsnprintf git_vsnprintf
562extern int git_vsnprintf(char *str, size_t maxsize,
563 const char *format, va_list ap);
564#endif
565
726c8ef5
JS
566#ifdef __GLIBC_PREREQ
567#if __GLIBC_PREREQ(2, 1)
568#define HAVE_STRCHRNUL
137c6eaa 569#define HAVE_MEMPCPY
726c8ef5
JS
570#endif
571#endif
572
573#ifndef HAVE_STRCHRNUL
659c69cf 574#define strchrnul gitstrchrnul
9e79f00f
AE
575static inline char *gitstrchrnul(const char *s, int c)
576{
577 while (*s && *s != c)
578 s++;
579 return (char *)s;
580}
659c69cf
RS
581#endif
582
137c6eaa
JN
583#ifndef HAVE_MEMPCPY
584#define mempcpy gitmempcpy
585static inline void *gitmempcpy(void *dest, const void *src, size_t n)
586{
587 return (char *)memcpy(dest, src, n) + n;
588}
589#endif
590
da523cc5
MP
591#ifdef NO_INET_PTON
592int inet_pton(int af, const char *src, void *dst);
593#endif
594
595#ifdef NO_INET_NTOP
596const char *inet_ntop(int af, const void *src, char *dst, size_t size);
597#endif
598
0f4b6db3
EB
599#ifdef NO_PTHREADS
600#define atexit git_atexit
601extern int git_atexit(void (*handler)(void));
602#endif
603
7c3ecb32 604extern void release_pack_memory(size_t);
97bfeb34 605
851c34b0
JS
606typedef void (*try_to_free_t)(size_t);
607extern try_to_free_t set_try_to_free_routine(try_to_free_t);
a9a74636 608
61f76a36
KS
609#ifdef HAVE_ALLOCA_H
610# include <alloca.h>
611# define xalloca(size) (alloca(size))
612# define xalloca_free(p) do {} while (0)
613#else
614# define xalloca(size) (xmalloc(size))
615# define xalloca_free(p) (free(p))
616#endif
112db553
LT
617extern char *xstrdup(const char *str);
618extern void *xmalloc(size_t size);
5bf9219d 619extern void *xmallocz(size_t size);
f8bb1d94 620extern void *xmallocz_gently(size_t size);
112db553
LT
621extern void *xmemdupz(const void *data, size_t len);
622extern char *xstrndup(const char *str, size_t len);
623extern void *xrealloc(void *ptr, size_t size);
624extern void *xcalloc(size_t nmemb, size_t size);
625extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
626extern ssize_t xread(int fd, void *buf, size_t len);
627extern ssize_t xwrite(int fd, const void *buf, size_t len);
9aa91af0 628extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
112db553
LT
629extern int xdup(int fd);
630extern FILE *xfdopen(int fd, const char *mode);
631extern int xmkstemp(char *template);
463db9b1 632extern int xmkstemp_mode(char *template, int mode);
6e180cdc 633extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
8640d496 634extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
aa14e980 635extern char *xgetcwd(void);
f21a47b2 636
3ac22f82
RS
637#define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
638
dc49cd76
SP
639static inline size_t xsize_t(off_t len)
640{
46be82df
TR
641 if (len > (size_t) len)
642 die("Cannot handle files this big");
dc49cd76
SP
643 return (size_t)len;
644}
645
f1589d10
RJ
646/* in ctype.c, for kwset users */
647extern const char tolower_trans_tbl[256];
648
4050c0df 649/* Sane ctype - no locale, and works with signed chars */
c2e9364a 650#undef isascii
4050c0df
JH
651#undef isspace
652#undef isdigit
653#undef isalpha
654#undef isalnum
0fcec2ce 655#undef isprint
43ccdf56
NK
656#undef islower
657#undef isupper
4050c0df
JH
658#undef tolower
659#undef toupper
1c149ab2
NTND
660#undef iscntrl
661#undef ispunct
662#undef isxdigit
2adf7247 663
ca5ab7d1 664extern const unsigned char sane_ctype[256];
4050c0df
JH
665#define GIT_SPACE 0x01
666#define GIT_DIGIT 0x02
667#define GIT_ALPHA 0x04
8cc32992 668#define GIT_GLOB_SPECIAL 0x08
f9b7cce6 669#define GIT_REGEX_SPECIAL 0x10
2f6c9760 670#define GIT_PATHSPEC_MAGIC 0x20
1c149ab2
NTND
671#define GIT_CNTRL 0x40
672#define GIT_PUNCT 0x80
4050c0df 673#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
c2e9364a 674#define isascii(x) (((x) & ~0x7f) == 0)
4050c0df
JH
675#define isspace(x) sane_istest(x,GIT_SPACE)
676#define isdigit(x) sane_istest(x,GIT_DIGIT)
677#define isalpha(x) sane_istest(x,GIT_ALPHA)
678#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
0fcec2ce 679#define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
43ccdf56
NK
680#define islower(x) sane_iscase(x, 1)
681#define isupper(x) sane_iscase(x, 0)
8cc32992 682#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
f9b7cce6 683#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1c149ab2
NTND
684#define iscntrl(x) (sane_istest(x,GIT_CNTRL))
685#define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
686 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
50a71776 687#define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
4050c0df
JH
688#define tolower(x) sane_case((unsigned char)(x), 0x20)
689#define toupper(x) sane_case((unsigned char)(x), 0)
2f6c9760 690#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
4050c0df
JH
691
692static inline int sane_case(int x, int high)
693{
694 if (sane_istest(x, GIT_ALPHA))
695 x = (x & ~0x20) | high;
696 return x;
697}
698
43ccdf56
NK
699static inline int sane_iscase(int x, int is_lower)
700{
701 if (!sane_istest(x, GIT_ALPHA))
702 return 0;
703
704 if (is_lower)
705 return (x & 0x20) != 0;
706 else
707 return (x & 0x20) == 0;
708}
709
6aead43d
JM
710static inline int strtoul_ui(char const *s, int base, unsigned int *result)
711{
712 unsigned long ul;
713 char *p;
714
715 errno = 0;
716 ul = strtoul(s, &p, base);
717 if (errno || *p || p == s || (unsigned int) ul != ul)
718 return -1;
719 *result = ul;
720 return 0;
721}
722
7791ecbc
JH
723static inline int strtol_i(char const *s, int base, int *result)
724{
725 long ul;
726 char *p;
727
728 errno = 0;
729 ul = strtol(s, &p, base);
730 if (errno || *p || p == s || (int) ul != ul)
731 return -1;
732 *result = ul;
733 return 0;
734}
735
43fe901b
BD
736#ifdef INTERNAL_QSORT
737void git_qsort(void *base, size_t nmemb, size_t size,
738 int(*compar)(const void *, const void *));
739#define qsort git_qsort
740#endif
741
81a24b52
AR
742#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
743# define FORCE_DIR_SET_GID S_ISGID
744#else
745# define FORCE_DIR_SET_GID 0
746#endif
747
c06ff490
KB
748#ifdef NO_NSEC
749#undef USE_NSEC
750#define ST_CTIME_NSEC(st) 0
751#define ST_MTIME_NSEC(st) 0
752#else
c567383b
BG
753#ifdef USE_ST_TIMESPEC
754#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
755#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
756#else
c06ff490
KB
757#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
758#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
759#endif
c567383b 760#endif
c06ff490 761
34779c53
JS
762#ifdef UNRELIABLE_FSTAT
763#define fstat_is_reliable() 0
764#else
765#define fstat_is_reliable() 1
766#endif
767
ab8632ae 768#ifndef va_copy
26db0f2e
JN
769/*
770 * Since an obvious implementation of va_list would be to make it a
771 * pointer into the stack frame, a simple assignment will work on
772 * many systems. But let's try to be more portable.
773 */
774#ifdef __va_copy
775#define va_copy(dst, src) __va_copy(dst, src)
776#else
777#define va_copy(dst, src) ((dst) = (src))
778#endif
ab8632ae
JK
779#endif
780
f51140c2 781#if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
e05bed96
KB
782#define HAVE_VARIADIC_MACROS 1
783#endif
784
fc71db39
AR
785/*
786 * Preserves errno, prints a message, but gives no warning for ENOENT.
1054af7d
RS
787 * Returns 0 on success, which includes trying to unlink an object that does
788 * not exist.
fc71db39
AR
789 */
790int unlink_or_warn(const char *path);
9ccc0c08
RS
791 /*
792 * Tries to unlink file. Returns 0 if unlink succeeded
793 * or the file already didn't exist. Returns -1 and
794 * appends a message to err suitable for
795 * 'error("%s", err->buf)' on error.
796 */
797int unlink_or_msg(const char *file, struct strbuf *err);
d1723296 798/*
1054af7d
RS
799 * Preserves errno, prints a message, but gives no warning for ENOENT.
800 * Returns 0 on success, which includes trying to remove a directory that does
801 * not exist.
d1723296
PC
802 */
803int rmdir_or_warn(const char *path);
80d706af
PC
804/*
805 * Calls the correct function out of {unlink,rmdir}_or_warn based on
806 * the supplied file mode.
807 */
808int remove_or_warn(unsigned int mode, const char *path);
fc71db39 809
e5c52c98
JN
810/*
811 * Call access(2), but warn for any error except "missing file"
812 * (ENOENT or ENOTDIR).
813 */
4698c8fe
JN
814#define ACCESS_EACCES_OK (1U << 0)
815int access_or_warn(const char *path, int mode, unsigned flag);
816int access_or_die(const char *path, int mode, unsigned flag);
ba8bd830 817
55b38a48
JH
818/* Warn on an inaccessible file that ought to be accessible */
819void warn_on_inaccessible(const char *path);
820
2f705875
JK
821/* Get the passwd entry for the UID of the current process. */
822struct passwd *xgetpwuid_self(void);
823
66547547
JK
824#ifdef GMTIME_UNRELIABLE_ERRORS
825struct tm *git_gmtime(const time_t *);
826struct tm *git_gmtime_r(const time_t *, struct tm *);
827#define gmtime git_gmtime
828#define gmtime_r git_gmtime_r
829#endif
830
4050c0df 831#endif