]> git.ipfire.org Git - thirdparty/git.git/blame - git-compat-util.h
Correct output of git-count-objects.
[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 */
10#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
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
JH
28#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
29
8723f216
NP
30#ifdef __GNUC__
31#define TYPEOF(x) (__typeof__(x))
32#else
33#define TYPEOF(x)
34#endif
35
36#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
db7244bd 37#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
8723f216 38
cf606e3d
AW
39/* Approximation of the length of the decimal representation of this type. */
40#define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
41
457bb452 42#if !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && !defined(_M_UNIX)
85023577
JH
43#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
44#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
c902c9a6 45#endif
fb952206
JR
46#define _ALL_SOURCE 1
47#define _GNU_SOURCE 1
48#define _BSD_SOURCE 1
85023577 49
4050c0df
JH
50#include <unistd.h>
51#include <stdio.h>
52#include <sys/stat.h>
53#include <fcntl.h>
54#include <stddef.h>
55#include <stdlib.h>
56#include <stdarg.h>
57#include <string.h>
58#include <errno.h>
59#include <limits.h>
60#include <sys/param.h>
4050c0df
JH
61#include <sys/types.h>
62#include <dirent.h>
85023577
JH
63#include <sys/time.h>
64#include <time.h>
65#include <signal.h>
85023577 66#include <fnmatch.h>
f4626df5
JS
67#include <assert.h>
68#include <regex.h>
69#include <utime.h>
70#ifndef __MINGW32__
71#include <sys/wait.h>
85023577
JH
72#include <sys/poll.h>
73#include <sys/socket.h>
80bbe72b 74#include <sys/ioctl.h>
2600973f 75#ifndef NO_SYS_SELECT_H
80bbe72b 76#include <sys/select.h>
2600973f 77#endif
85023577
JH
78#include <netinet/in.h>
79#include <netinet/tcp.h>
80#include <arpa/inet.h>
81#include <netdb.h>
82#include <pwd.h>
007e2ba6 83#include <inttypes.h>
41b20017
RJ
84#if defined(__CYGWIN__)
85#undef _XOPEN_SOURCE
86#include <grp.h>
87#define _XOPEN_SOURCE 600
88#else
fb952206 89#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577 90#include <grp.h>
fb952206 91#define _ALL_SOURCE 1
41b20017 92#endif
f4626df5
JS
93#else /* __MINGW32__ */
94/* pull in Windows compatibility stuff */
95#include "compat/mingw.h"
96#endif /* __MINGW32__ */
85023577
JH
97
98#ifndef NO_ICONV
99#include <iconv.h>
100#endif
4050c0df 101
684ec6c6
RS
102#ifndef NO_OPENSSL
103#include <openssl/ssl.h>
104#include <openssl/err.h>
105#endif
106
d0c2449f
JH
107/* On most systems <limits.h> would have given us this, but
108 * not on some systems (e.g. GNU/Hurd).
109 */
110#ifndef PATH_MAX
111#define PATH_MAX 4096
112#endif
113
c4001d92
SP
114#ifndef PRIuMAX
115#define PRIuMAX "llu"
116#endif
117
607bb3ff
JS
118#ifndef PRIu32
119#define PRIu32 "u"
120#endif
121
122#ifndef PRIx32
123#define PRIx32 "x"
124#endif
125
80ba074f
JS
126#ifndef PATH_SEP
127#define PATH_SEP ':'
128#endif
129
23326d14
JS
130#ifndef STRIP_EXTENSION
131#define STRIP_EXTENSION ""
132#endif
133
25fe217b
JS
134#ifndef has_dos_drive_prefix
135#define has_dos_drive_prefix(path) 0
136#endif
137
138#ifndef is_dir_sep
139#define is_dir_sep(c) ((c) == '/')
140#endif
141
4050c0df
JH
142#ifdef __GNUC__
143#define NORETURN __attribute__((__noreturn__))
144#else
145#define NORETURN
146#ifndef __attribute__
147#define __attribute__(x)
148#endif
149#endif
150
151/* General helper functions */
152extern void usage(const char *err) NORETURN;
153extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
154extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9 155extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 156
39a3f5ea
PB
157extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
158extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
159extern void set_error_routine(void (*routine)(const char *err, va_list params));
fa39b6b5 160extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
39a3f5ea 161
698a68be 162extern int prefixcmp(const char *str, const char *prefix);
bb5799d6 163extern time_t tm_to_time_t(const struct tm *tm);
698a68be 164
fbca5837
MV
165static inline const char *skip_prefix(const char *str, const char *prefix)
166{
167 size_t len = strlen(prefix);
168 return strncmp(str, prefix, len) ? NULL : str + len;
169}
170
4050c0df
JH
171#ifdef NO_MMAP
172
173#ifndef PROT_READ
174#define PROT_READ 1
175#define PROT_WRITE 2
176#define MAP_PRIVATE 1
177#define MAP_FAILED ((void*)-1)
178#endif
179
d6779124
SP
180#define mmap git_mmap
181#define munmap git_munmap
182extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
183extern int git_munmap(void *start, size_t length);
4050c0df 184
5faaf246 185/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
186#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
187
4050c0df
JH
188#else /* NO_MMAP */
189
190#include <sys/mman.h>
5faaf246
JH
191
192/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
193#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
194 (sizeof(void*) >= 8 \
195 ? 1 * 1024 * 1024 * 1024 \
196 : 32 * 1024 * 1024)
4050c0df
JH
197
198#endif /* NO_MMAP */
199
fdb2a2a6
JH
200#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
201#define on_disk_bytes(st) ((st).st_size)
202#else
203#define on_disk_bytes(st) ((st).st_blocks * 512)
204#endif
205
22bac0ea 206#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a 207 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 208
6900679c
SH
209#ifdef NO_PREAD
210#define pread git_pread
211extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
212#endif
14086b0a
SP
213/*
214 * Forward decl that will remind us if its twin in cache.h changes.
215 * This function is used in compat/pread.c. But we can't include
216 * cache.h there.
217 */
218extern ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c 219
4050c0df
JH
220#ifdef NO_SETENV
221#define setenv gitsetenv
222extern int gitsetenv(const char *, const char *, int);
223#endif
224
ca5bb5d5
SP
225#ifdef NO_MKDTEMP
226#define mkdtemp gitmkdtemp
227extern char *gitmkdtemp(char *);
228#endif
229
731043fd
JR
230#ifdef NO_UNSETENV
231#define unsetenv gitunsetenv
232extern void gitunsetenv(const char *);
233#endif
234
4050c0df
JH
235#ifdef NO_STRCASESTR
236#define strcasestr gitstrcasestr
237extern char *gitstrcasestr(const char *haystack, const char *needle);
238#endif
239
817151e6
PE
240#ifdef NO_STRLCPY
241#define strlcpy gitstrlcpy
242extern size_t gitstrlcpy(char *, const char *, size_t);
243#endif
244
bc6b4f52
JR
245#ifdef NO_STRTOUMAX
246#define strtoumax gitstrtoumax
247extern uintmax_t gitstrtoumax(const char *, char **, int);
248#endif
249
fa0c87c3
AR
250#ifdef NO_HSTRERROR
251#define hstrerror githstrerror
252extern const char *githstrerror(int herror);
253#endif
254
b21b9f1d
RS
255#ifdef NO_MEMMEM
256#define memmem gitmemmem
257void *gitmemmem(const void *haystack, size_t haystacklen,
258 const void *needle, size_t needlelen);
259#endif
260
cba22528 261#ifdef FREAD_READS_DIRECTORIES
c5445fe0
JS
262#ifdef fopen
263#undef fopen
264#endif
cba22528
BC
265#define fopen(a,b) git_fopen(a,b)
266extern FILE *git_fopen(const char*, const char*);
267#endif
268
c4582f93
MR
269#ifdef SNPRINTF_RETURNS_BOGUS
270#define snprintf git_snprintf
271extern int git_snprintf(char *str, size_t maxsize,
272 const char *format, ...);
273#define vsnprintf git_vsnprintf
274extern int git_vsnprintf(char *str, size_t maxsize,
275 const char *format, va_list ap);
276#endif
277
726c8ef5
JS
278#ifdef __GLIBC_PREREQ
279#if __GLIBC_PREREQ(2, 1)
280#define HAVE_STRCHRNUL
281#endif
282#endif
283
284#ifndef HAVE_STRCHRNUL
659c69cf 285#define strchrnul gitstrchrnul
9e79f00f
AE
286static inline char *gitstrchrnul(const char *s, int c)
287{
288 while (*s && *s != c)
289 s++;
290 return (char *)s;
291}
659c69cf
RS
292#endif
293
d1efefa4 294extern void release_pack_memory(size_t, int);
97bfeb34 295
112db553
LT
296extern char *xstrdup(const char *str);
297extern void *xmalloc(size_t size);
298extern void *xmemdupz(const void *data, size_t len);
299extern char *xstrndup(const char *str, size_t len);
300extern void *xrealloc(void *ptr, size_t size);
301extern void *xcalloc(size_t nmemb, size_t size);
302extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
303extern ssize_t xread(int fd, void *buf, size_t len);
304extern ssize_t xwrite(int fd, const void *buf, size_t len);
305extern int xdup(int fd);
306extern FILE *xfdopen(int fd, const char *mode);
307extern int xmkstemp(char *template);
f21a47b2 308
dc49cd76
SP
309static inline size_t xsize_t(off_t len)
310{
311 return (size_t)len;
312}
313
5bb1cda5 314static inline int has_extension(const char *filename, const char *ext)
83a2b841 315{
5bb1cda5
RS
316 size_t len = strlen(filename);
317 size_t extlen = strlen(ext);
83a2b841
RS
318 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
319}
320
4050c0df
JH
321/* Sane ctype - no locale, and works with signed chars */
322#undef isspace
323#undef isdigit
324#undef isalpha
325#undef isalnum
326#undef tolower
327#undef toupper
328extern unsigned char sane_ctype[256];
329#define GIT_SPACE 0x01
330#define GIT_DIGIT 0x02
331#define GIT_ALPHA 0x04
63e8aea7 332#define GIT_SPECIAL 0x08
4050c0df
JH
333#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
334#define isspace(x) sane_istest(x,GIT_SPACE)
335#define isdigit(x) sane_istest(x,GIT_DIGIT)
336#define isalpha(x) sane_istest(x,GIT_ALPHA)
337#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
63e8aea7 338#define isspecial(x) sane_istest(x,GIT_SPECIAL)
4050c0df
JH
339#define tolower(x) sane_case((unsigned char)(x), 0x20)
340#define toupper(x) sane_case((unsigned char)(x), 0)
341
342static inline int sane_case(int x, int high)
343{
344 if (sane_istest(x, GIT_ALPHA))
345 x = (x & ~0x20) | high;
346 return x;
347}
348
6aead43d
JM
349static inline int strtoul_ui(char const *s, int base, unsigned int *result)
350{
351 unsigned long ul;
352 char *p;
353
354 errno = 0;
355 ul = strtoul(s, &p, base);
356 if (errno || *p || p == s || (unsigned int) ul != ul)
357 return -1;
358 *result = ul;
359 return 0;
360}
361
7791ecbc
JH
362static inline int strtol_i(char const *s, int base, int *result)
363{
364 long ul;
365 char *p;
366
367 errno = 0;
368 ul = strtol(s, &p, base);
369 if (errno || *p || p == s || (int) ul != ul)
370 return -1;
371 *result = ul;
372 return 0;
373}
374
43fe901b
BD
375#ifdef INTERNAL_QSORT
376void git_qsort(void *base, size_t nmemb, size_t size,
377 int(*compar)(const void *, const void *));
378#define qsort git_qsort
379#endif
380
81a24b52
AR
381#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
382# define FORCE_DIR_SET_GID S_ISGID
383#else
384# define FORCE_DIR_SET_GID 0
385#endif
386
4050c0df 387#endif