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