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