Merge branch 'jc/maint-add-p-coalesce-fix' into maint
[git/git.git] / git-compat-util.h
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
3
4 #define _FILE_OFFSET_BITS 64
5
6 #ifndef FLEX_ARRAY
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
25 #endif
26 #endif
27
28 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
29
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))))
37 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
38
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
42 #if !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && !defined(_M_UNIX)
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 */
45 #endif
46 #define _ALL_SOURCE 1
47 #define _GNU_SOURCE 1
48 #define _BSD_SOURCE 1
49 #define _NETBSD_SOURCE 1
50
51 #include <unistd.h>
52 #include <stdio.h>
53 #include <sys/stat.h>
54 #include <fcntl.h>
55 #include <stddef.h>
56 #include <stdlib.h>
57 #include <stdarg.h>
58 #include <string.h>
59 #include <errno.h>
60 #include <limits.h>
61 #include <sys/param.h>
62 #include <sys/types.h>
63 #include <dirent.h>
64 #include <sys/time.h>
65 #include <time.h>
66 #include <signal.h>
67 #include <fnmatch.h>
68 #include <assert.h>
69 #include <regex.h>
70 #include <utime.h>
71 #ifndef __MINGW32__
72 #include <sys/wait.h>
73 #include <sys/poll.h>
74 #include <sys/socket.h>
75 #include <sys/ioctl.h>
76 #ifndef NO_SYS_SELECT_H
77 #include <sys/select.h>
78 #endif
79 #include <netinet/in.h>
80 #include <netinet/tcp.h>
81 #include <arpa/inet.h>
82 #include <netdb.h>
83 #include <pwd.h>
84 #include <inttypes.h>
85 #if defined(__CYGWIN__)
86 #undef _XOPEN_SOURCE
87 #include <grp.h>
88 #define _XOPEN_SOURCE 600
89 #include "compat/cygwin.h"
90 #else
91 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
92 #include <grp.h>
93 #define _ALL_SOURCE 1
94 #endif
95 #else /* __MINGW32__ */
96 /* pull in Windows compatibility stuff */
97 #include "compat/mingw.h"
98 #endif /* __MINGW32__ */
99
100 #ifndef NO_ICONV
101 #include <iconv.h>
102 #endif
103
104 #ifndef NO_OPENSSL
105 #include <openssl/ssl.h>
106 #include <openssl/err.h>
107 #endif
108
109 /* On most systems <limits.h> would have given us this, but
110 * not on some systems (e.g. GNU/Hurd).
111 */
112 #ifndef PATH_MAX
113 #define PATH_MAX 4096
114 #endif
115
116 #ifndef PRIuMAX
117 #define PRIuMAX "llu"
118 #endif
119
120 #ifndef PRIu32
121 #define PRIu32 "u"
122 #endif
123
124 #ifndef PRIx32
125 #define PRIx32 "x"
126 #endif
127
128 #ifndef PATH_SEP
129 #define PATH_SEP ':'
130 #endif
131
132 #ifndef STRIP_EXTENSION
133 #define STRIP_EXTENSION ""
134 #endif
135
136 #ifndef has_dos_drive_prefix
137 #define has_dos_drive_prefix(path) 0
138 #endif
139
140 #ifndef is_dir_sep
141 #define is_dir_sep(c) ((c) == '/')
142 #endif
143
144 #ifdef __GNUC__
145 #define NORETURN __attribute__((__noreturn__))
146 #else
147 #define NORETURN
148 #ifndef __attribute__
149 #define __attribute__(x)
150 #endif
151 #endif
152
153 /* General helper functions */
154 extern void usage(const char *err) NORETURN;
155 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
156 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
157 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
158
159 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
160
161 extern int prefixcmp(const char *str, const char *prefix);
162 extern time_t tm_to_time_t(const struct tm *tm);
163
164 static inline const char *skip_prefix(const char *str, const char *prefix)
165 {
166 size_t len = strlen(prefix);
167 return strncmp(str, prefix, len) ? NULL : str + len;
168 }
169
170 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
171
172 #ifndef PROT_READ
173 #define PROT_READ 1
174 #define PROT_WRITE 2
175 #define MAP_PRIVATE 1
176 #define MAP_FAILED ((void*)-1)
177 #endif
178
179 #define mmap git_mmap
180 #define munmap git_munmap
181 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
182 extern int git_munmap(void *start, size_t length);
183
184 #else /* NO_MMAP || USE_WIN32_MMAP */
185
186 #include <sys/mman.h>
187
188 #endif /* NO_MMAP || USE_WIN32_MMAP */
189
190 #ifdef NO_MMAP
191
192 /* This value must be multiple of (pagesize * 2) */
193 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
194
195 #else /* NO_MMAP */
196
197 /* This value must be multiple of (pagesize * 2) */
198 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
199 (sizeof(void*) >= 8 \
200 ? 1 * 1024 * 1024 * 1024 \
201 : 32 * 1024 * 1024)
202
203 #endif /* NO_MMAP */
204
205 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
206 #define on_disk_bytes(st) ((st).st_size)
207 #else
208 #define on_disk_bytes(st) ((st).st_blocks * 512)
209 #endif
210
211 #define DEFAULT_PACKED_GIT_LIMIT \
212 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
213
214 #ifdef NO_PREAD
215 #define pread git_pread
216 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
217 #endif
218 /*
219 * Forward decl that will remind us if its twin in cache.h changes.
220 * This function is used in compat/pread.c. But we can't include
221 * cache.h there.
222 */
223 extern ssize_t read_in_full(int fd, void *buf, size_t count);
224
225 #ifdef NO_SETENV
226 #define setenv gitsetenv
227 extern int gitsetenv(const char *, const char *, int);
228 #endif
229
230 #ifdef NO_MKDTEMP
231 #define mkdtemp gitmkdtemp
232 extern char *gitmkdtemp(char *);
233 #endif
234
235 #ifdef NO_UNSETENV
236 #define unsetenv gitunsetenv
237 extern void gitunsetenv(const char *);
238 #endif
239
240 #ifdef NO_STRCASESTR
241 #define strcasestr gitstrcasestr
242 extern char *gitstrcasestr(const char *haystack, const char *needle);
243 #endif
244
245 #ifdef NO_STRLCPY
246 #define strlcpy gitstrlcpy
247 extern size_t gitstrlcpy(char *, const char *, size_t);
248 #endif
249
250 #ifdef NO_STRTOUMAX
251 #define strtoumax gitstrtoumax
252 extern uintmax_t gitstrtoumax(const char *, char **, int);
253 #endif
254
255 #ifdef NO_HSTRERROR
256 #define hstrerror githstrerror
257 extern const char *githstrerror(int herror);
258 #endif
259
260 #ifdef NO_MEMMEM
261 #define memmem gitmemmem
262 void *gitmemmem(const void *haystack, size_t haystacklen,
263 const void *needle, size_t needlelen);
264 #endif
265
266 #ifdef FREAD_READS_DIRECTORIES
267 #ifdef fopen
268 #undef fopen
269 #endif
270 #define fopen(a,b) git_fopen(a,b)
271 extern FILE *git_fopen(const char*, const char*);
272 #endif
273
274 #ifdef SNPRINTF_RETURNS_BOGUS
275 #define snprintf git_snprintf
276 extern int git_snprintf(char *str, size_t maxsize,
277 const char *format, ...);
278 #define vsnprintf git_vsnprintf
279 extern int git_vsnprintf(char *str, size_t maxsize,
280 const char *format, va_list ap);
281 #endif
282
283 #ifdef __GLIBC_PREREQ
284 #if __GLIBC_PREREQ(2, 1)
285 #define HAVE_STRCHRNUL
286 #endif
287 #endif
288
289 #ifndef HAVE_STRCHRNUL
290 #define strchrnul gitstrchrnul
291 static inline char *gitstrchrnul(const char *s, int c)
292 {
293 while (*s && *s != c)
294 s++;
295 return (char *)s;
296 }
297 #endif
298
299 extern void release_pack_memory(size_t, int);
300
301 extern char *xstrdup(const char *str);
302 extern void *xmalloc(size_t size);
303 extern void *xmemdupz(const void *data, size_t len);
304 extern char *xstrndup(const char *str, size_t len);
305 extern void *xrealloc(void *ptr, size_t size);
306 extern void *xcalloc(size_t nmemb, size_t size);
307 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
308 extern ssize_t xread(int fd, void *buf, size_t len);
309 extern ssize_t xwrite(int fd, const void *buf, size_t len);
310 extern int xdup(int fd);
311 extern FILE *xfdopen(int fd, const char *mode);
312 extern int xmkstemp(char *template);
313 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
314 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
315
316 static inline size_t xsize_t(off_t len)
317 {
318 return (size_t)len;
319 }
320
321 static inline int has_extension(const char *filename, const char *ext)
322 {
323 size_t len = strlen(filename);
324 size_t extlen = strlen(ext);
325 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
326 }
327
328 /* Sane ctype - no locale, and works with signed chars */
329 #undef isascii
330 #undef isspace
331 #undef isdigit
332 #undef isalpha
333 #undef isalnum
334 #undef tolower
335 #undef toupper
336 extern unsigned char sane_ctype[256];
337 #define GIT_SPACE 0x01
338 #define GIT_DIGIT 0x02
339 #define GIT_ALPHA 0x04
340 #define GIT_GLOB_SPECIAL 0x08
341 #define GIT_REGEX_SPECIAL 0x10
342 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
343 #define isascii(x) (((x) & ~0x7f) == 0)
344 #define isspace(x) sane_istest(x,GIT_SPACE)
345 #define isdigit(x) sane_istest(x,GIT_DIGIT)
346 #define isalpha(x) sane_istest(x,GIT_ALPHA)
347 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
348 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
349 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
350 #define tolower(x) sane_case((unsigned char)(x), 0x20)
351 #define toupper(x) sane_case((unsigned char)(x), 0)
352
353 static inline int sane_case(int x, int high)
354 {
355 if (sane_istest(x, GIT_ALPHA))
356 x = (x & ~0x20) | high;
357 return x;
358 }
359
360 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
361 {
362 unsigned long ul;
363 char *p;
364
365 errno = 0;
366 ul = strtoul(s, &p, base);
367 if (errno || *p || p == s || (unsigned int) ul != ul)
368 return -1;
369 *result = ul;
370 return 0;
371 }
372
373 static inline int strtol_i(char const *s, int base, int *result)
374 {
375 long ul;
376 char *p;
377
378 errno = 0;
379 ul = strtol(s, &p, base);
380 if (errno || *p || p == s || (int) ul != ul)
381 return -1;
382 *result = ul;
383 return 0;
384 }
385
386 #ifdef INTERNAL_QSORT
387 void git_qsort(void *base, size_t nmemb, size_t size,
388 int(*compar)(const void *, const void *));
389 #define qsort git_qsort
390 #endif
391
392 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
393 # define FORCE_DIR_SET_GID S_ISGID
394 #else
395 # define FORCE_DIR_SET_GID 0
396 #endif
397
398 #ifdef NO_NSEC
399 #undef USE_NSEC
400 #define ST_CTIME_NSEC(st) 0
401 #define ST_MTIME_NSEC(st) 0
402 #else
403 #ifdef USE_ST_TIMESPEC
404 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
405 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
406 #else
407 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
408 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
409 #endif
410 #endif
411
412 #ifdef UNRELIABLE_FSTAT
413 #define fstat_is_reliable() 0
414 #else
415 #define fstat_is_reliable() 1
416 #endif
417
418 /*
419 * Preserves errno, prints a message, but gives no warning for ENOENT.
420 * Always returns the return value of unlink(2).
421 */
422 int unlink_or_warn(const char *path);
423
424 #endif