Merge branch 'pc/remove-warn' 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) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
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 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
30
31 #ifdef __GNUC__
32 #define TYPEOF(x) (__typeof__(x))
33 #else
34 #define TYPEOF(x)
35 #endif
36
37 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
38 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
39
40 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
41
42 /* Approximation of the length of the decimal representation of this type. */
43 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
44
45 #if defined(__sun__)
46 /*
47 * On Solaris, when _XOPEN_EXTENDED is set, its header file
48 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
49 * setting to say we are XPG5 or XPG6. Also on Solaris,
50 * XPG6 programs must be compiled with a c99 compiler, while
51 * non XPG6 programs must be compiled with a pre-c99 compiler.
52 */
53 # if __STDC_VERSION__ - 0 >= 199901L
54 # define _XOPEN_SOURCE 600
55 # else
56 # define _XOPEN_SOURCE 500
57 # endif
58 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
59 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__)
60 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
61 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
62 #endif
63 #define _ALL_SOURCE 1
64 #define _GNU_SOURCE 1
65 #define _BSD_SOURCE 1
66 #define _NETBSD_SOURCE 1
67 #define _SGI_SOURCE 1
68
69 #ifdef WIN32 /* Both MinGW and MSVC */
70 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
71 #include <winsock2.h>
72 #include <windows.h>
73 #endif
74
75 #include <unistd.h>
76 #include <stdio.h>
77 #include <sys/stat.h>
78 #include <fcntl.h>
79 #include <stddef.h>
80 #include <stdlib.h>
81 #include <stdarg.h>
82 #include <string.h>
83 #include <errno.h>
84 #include <limits.h>
85 #include <sys/param.h>
86 #include <sys/types.h>
87 #include <dirent.h>
88 #include <sys/time.h>
89 #include <time.h>
90 #include <signal.h>
91 #include <fnmatch.h>
92 #include <assert.h>
93 #include <regex.h>
94 #include <utime.h>
95 #ifndef __MINGW32__
96 #include <sys/wait.h>
97 #include <sys/poll.h>
98 #include <sys/socket.h>
99 #include <sys/ioctl.h>
100 #include <termios.h>
101 #ifndef NO_SYS_SELECT_H
102 #include <sys/select.h>
103 #endif
104 #include <netinet/in.h>
105 #include <netinet/tcp.h>
106 #include <arpa/inet.h>
107 #include <netdb.h>
108 #include <pwd.h>
109 #include <inttypes.h>
110 #if defined(__CYGWIN__)
111 #undef _XOPEN_SOURCE
112 #include <grp.h>
113 #define _XOPEN_SOURCE 600
114 #include "compat/cygwin.h"
115 #else
116 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
117 #include <grp.h>
118 #define _ALL_SOURCE 1
119 #endif
120 #else /* __MINGW32__ */
121 /* pull in Windows compatibility stuff */
122 #include "compat/mingw.h"
123 #endif /* __MINGW32__ */
124 #ifdef _MSC_VER
125 #include "compat/msvc.h"
126 #endif
127
128 #ifndef NO_LIBGEN_H
129 #include <libgen.h>
130 #else
131 #define basename gitbasename
132 extern char *gitbasename(char *);
133 #endif
134
135 #ifndef NO_ICONV
136 #include <iconv.h>
137 #endif
138
139 #ifndef NO_OPENSSL
140 #include <openssl/ssl.h>
141 #include <openssl/err.h>
142 #endif
143
144 /* On most systems <limits.h> would have given us this, but
145 * not on some systems (e.g. GNU/Hurd).
146 */
147 #ifndef PATH_MAX
148 #define PATH_MAX 4096
149 #endif
150
151 #ifndef PRIuMAX
152 #define PRIuMAX "llu"
153 #endif
154
155 #ifndef PRIu32
156 #define PRIu32 "u"
157 #endif
158
159 #ifndef PRIx32
160 #define PRIx32 "x"
161 #endif
162
163 #ifndef PATH_SEP
164 #define PATH_SEP ':'
165 #endif
166
167 #ifdef HAVE_PATHS_H
168 #include <paths.h>
169 #endif
170 #ifndef _PATH_DEFPATH
171 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
172 #endif
173
174 #ifndef STRIP_EXTENSION
175 #define STRIP_EXTENSION ""
176 #endif
177
178 #ifndef has_dos_drive_prefix
179 #define has_dos_drive_prefix(path) 0
180 #endif
181
182 #ifndef is_dir_sep
183 #define is_dir_sep(c) ((c) == '/')
184 #endif
185
186 #ifdef __GNUC__
187 #define NORETURN __attribute__((__noreturn__))
188 #define NORETURN_PTR __attribute__((__noreturn__))
189 #elif defined(_MSC_VER)
190 #define NORETURN __declspec(noreturn)
191 #define NORETURN_PTR
192 #else
193 #define NORETURN
194 #define NORETURN_PTR
195 #ifndef __attribute__
196 #define __attribute__(x)
197 #endif
198 #endif
199
200 #include "compat/bswap.h"
201
202 /* General helper functions */
203 extern NORETURN void usage(const char *err);
204 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
205 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
206 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
207 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
208 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
209
210 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
211
212 extern int prefixcmp(const char *str, const char *prefix);
213 extern int suffixcmp(const char *str, const char *suffix);
214
215 static inline const char *skip_prefix(const char *str, const char *prefix)
216 {
217 size_t len = strlen(prefix);
218 return strncmp(str, prefix, len) ? NULL : str + len;
219 }
220
221 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
222
223 #ifndef PROT_READ
224 #define PROT_READ 1
225 #define PROT_WRITE 2
226 #define MAP_PRIVATE 1
227 #define MAP_FAILED ((void*)-1)
228 #endif
229
230 #define mmap git_mmap
231 #define munmap git_munmap
232 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
233 extern int git_munmap(void *start, size_t length);
234
235 #else /* NO_MMAP || USE_WIN32_MMAP */
236
237 #include <sys/mman.h>
238
239 #endif /* NO_MMAP || USE_WIN32_MMAP */
240
241 #ifdef NO_MMAP
242
243 /* This value must be multiple of (pagesize * 2) */
244 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
245
246 #else /* NO_MMAP */
247
248 /* This value must be multiple of (pagesize * 2) */
249 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
250 (sizeof(void*) >= 8 \
251 ? 1 * 1024 * 1024 * 1024 \
252 : 32 * 1024 * 1024)
253
254 #endif /* NO_MMAP */
255
256 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
257 #define on_disk_bytes(st) ((st).st_size)
258 #else
259 #define on_disk_bytes(st) ((st).st_blocks * 512)
260 #endif
261
262 #define DEFAULT_PACKED_GIT_LIMIT \
263 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
264
265 #ifdef NO_PREAD
266 #define pread git_pread
267 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
268 #endif
269 /*
270 * Forward decl that will remind us if its twin in cache.h changes.
271 * This function is used in compat/pread.c. But we can't include
272 * cache.h there.
273 */
274 extern ssize_t read_in_full(int fd, void *buf, size_t count);
275
276 #ifdef NO_SETENV
277 #define setenv gitsetenv
278 extern int gitsetenv(const char *, const char *, int);
279 #endif
280
281 #ifdef NO_MKDTEMP
282 #define mkdtemp gitmkdtemp
283 extern char *gitmkdtemp(char *);
284 #endif
285
286 #ifdef NO_MKSTEMPS
287 #define mkstemps gitmkstemps
288 extern int gitmkstemps(char *, int);
289 #endif
290
291 #ifdef NO_UNSETENV
292 #define unsetenv gitunsetenv
293 extern void gitunsetenv(const char *);
294 #endif
295
296 #ifdef NO_STRCASESTR
297 #define strcasestr gitstrcasestr
298 extern char *gitstrcasestr(const char *haystack, const char *needle);
299 #endif
300
301 #ifdef NO_STRLCPY
302 #define strlcpy gitstrlcpy
303 extern size_t gitstrlcpy(char *, const char *, size_t);
304 #endif
305
306 #ifdef NO_STRTOUMAX
307 #define strtoumax gitstrtoumax
308 extern uintmax_t gitstrtoumax(const char *, char **, int);
309 #endif
310
311 #ifdef NO_HSTRERROR
312 #define hstrerror githstrerror
313 extern const char *githstrerror(int herror);
314 #endif
315
316 #ifdef NO_MEMMEM
317 #define memmem gitmemmem
318 void *gitmemmem(const void *haystack, size_t haystacklen,
319 const void *needle, size_t needlelen);
320 #endif
321
322 #ifdef FREAD_READS_DIRECTORIES
323 #ifdef fopen
324 #undef fopen
325 #endif
326 #define fopen(a,b) git_fopen(a,b)
327 extern FILE *git_fopen(const char*, const char*);
328 #endif
329
330 #ifdef SNPRINTF_RETURNS_BOGUS
331 #define snprintf git_snprintf
332 extern int git_snprintf(char *str, size_t maxsize,
333 const char *format, ...);
334 #define vsnprintf git_vsnprintf
335 extern int git_vsnprintf(char *str, size_t maxsize,
336 const char *format, va_list ap);
337 #endif
338
339 #ifdef __GLIBC_PREREQ
340 #if __GLIBC_PREREQ(2, 1)
341 #define HAVE_STRCHRNUL
342 #define HAVE_MEMPCPY
343 #endif
344 #endif
345
346 #ifndef HAVE_STRCHRNUL
347 #define strchrnul gitstrchrnul
348 static inline char *gitstrchrnul(const char *s, int c)
349 {
350 while (*s && *s != c)
351 s++;
352 return (char *)s;
353 }
354 #endif
355
356 #ifndef HAVE_MEMPCPY
357 #define mempcpy gitmempcpy
358 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
359 {
360 return (char *)memcpy(dest, src, n) + n;
361 }
362 #endif
363
364 extern void release_pack_memory(size_t, int);
365
366 extern void set_try_to_free_routine(void (*routine)(size_t));
367
368 extern char *xstrdup(const char *str);
369 extern void *xmalloc(size_t size);
370 extern void *xmallocz(size_t size);
371 extern void *xmemdupz(const void *data, size_t len);
372 extern char *xstrndup(const char *str, size_t len);
373 extern void *xrealloc(void *ptr, size_t size);
374 extern void *xcalloc(size_t nmemb, size_t size);
375 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
376 extern ssize_t xread(int fd, void *buf, size_t len);
377 extern ssize_t xwrite(int fd, const void *buf, size_t len);
378 extern int xdup(int fd);
379 extern FILE *xfdopen(int fd, const char *mode);
380 extern int xmkstemp(char *template);
381 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
382 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
383
384 static inline size_t xsize_t(off_t len)
385 {
386 return (size_t)len;
387 }
388
389 static inline int has_extension(const char *filename, const char *ext)
390 {
391 size_t len = strlen(filename);
392 size_t extlen = strlen(ext);
393 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
394 }
395
396 /* Sane ctype - no locale, and works with signed chars */
397 #undef isascii
398 #undef isspace
399 #undef isdigit
400 #undef isalpha
401 #undef isalnum
402 #undef tolower
403 #undef toupper
404 extern unsigned char sane_ctype[256];
405 #define GIT_SPACE 0x01
406 #define GIT_DIGIT 0x02
407 #define GIT_ALPHA 0x04
408 #define GIT_GLOB_SPECIAL 0x08
409 #define GIT_REGEX_SPECIAL 0x10
410 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
411 #define isascii(x) (((x) & ~0x7f) == 0)
412 #define isspace(x) sane_istest(x,GIT_SPACE)
413 #define isdigit(x) sane_istest(x,GIT_DIGIT)
414 #define isalpha(x) sane_istest(x,GIT_ALPHA)
415 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
416 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
417 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
418 #define tolower(x) sane_case((unsigned char)(x), 0x20)
419 #define toupper(x) sane_case((unsigned char)(x), 0)
420
421 static inline int sane_case(int x, int high)
422 {
423 if (sane_istest(x, GIT_ALPHA))
424 x = (x & ~0x20) | high;
425 return x;
426 }
427
428 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
429 {
430 unsigned long ul;
431 char *p;
432
433 errno = 0;
434 ul = strtoul(s, &p, base);
435 if (errno || *p || p == s || (unsigned int) ul != ul)
436 return -1;
437 *result = ul;
438 return 0;
439 }
440
441 static inline int strtol_i(char const *s, int base, int *result)
442 {
443 long ul;
444 char *p;
445
446 errno = 0;
447 ul = strtol(s, &p, base);
448 if (errno || *p || p == s || (int) ul != ul)
449 return -1;
450 *result = ul;
451 return 0;
452 }
453
454 #ifdef INTERNAL_QSORT
455 void git_qsort(void *base, size_t nmemb, size_t size,
456 int(*compar)(const void *, const void *));
457 #define qsort git_qsort
458 #endif
459
460 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
461 # define FORCE_DIR_SET_GID S_ISGID
462 #else
463 # define FORCE_DIR_SET_GID 0
464 #endif
465
466 #ifdef NO_NSEC
467 #undef USE_NSEC
468 #define ST_CTIME_NSEC(st) 0
469 #define ST_MTIME_NSEC(st) 0
470 #else
471 #ifdef USE_ST_TIMESPEC
472 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
473 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
474 #else
475 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
476 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
477 #endif
478 #endif
479
480 #ifdef UNRELIABLE_FSTAT
481 #define fstat_is_reliable() 0
482 #else
483 #define fstat_is_reliable() 1
484 #endif
485
486 /*
487 * Preserves errno, prints a message, but gives no warning for ENOENT.
488 * Always returns the return value of unlink(2).
489 */
490 int unlink_or_warn(const char *path);
491 /*
492 * Likewise for rmdir(2).
493 */
494 int rmdir_or_warn(const char *path);
495 /*
496 * Calls the correct function out of {unlink,rmdir}_or_warn based on
497 * the supplied file mode.
498 */
499 int remove_or_warn(unsigned int mode, const char *path);
500
501 #endif