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