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#define maximum_signed_value_of_type(a) \
32 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
33
34#define maximum_unsigned_value_of_type(a) \
35 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
36
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
46#define unsigned_add_overflows(a, b) \
47 ((b) > maximum_unsigned_value_of_type(a) - (a))
48
49#ifdef __GNUC__
50#define TYPEOF(x) (__typeof__(x))
51#else
52#define TYPEOF(x)
53#endif
54
55#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
56#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
57
58#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
59
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
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
76#elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
77 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
78 !defined(__TANDEM)
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 */
81#endif
82#define _ALL_SOURCE 1
83#define _GNU_SOURCE 1
84#define _BSD_SOURCE 1
85#define _NETBSD_SOURCE 1
86#define _SGI_SOURCE 1
87
88#ifdef WIN32 /* Both MinGW and MSVC */
89#define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
90#include <winsock2.h>
91#include <windows.h>
92#endif
93
94#include <unistd.h>
95#include <stdio.h>
96#include <sys/stat.h>
97#include <fcntl.h>
98#include <stddef.h>
99#include <stdlib.h>
100#include <stdarg.h>
101#include <string.h>
102#ifdef __TANDEM /* or HAVE_STRINGS_H or !NO_STRINGS_H? */
103#include <strings.h> /* for strcasecmp() */
104#endif
105#include <errno.h>
106#include <limits.h>
107#include <sys/param.h>
108#include <sys/types.h>
109#include <dirent.h>
110#include <sys/time.h>
111#include <time.h>
112#include <signal.h>
113#include <fnmatch.h>
114#include <assert.h>
115#include <regex.h>
116#include <utime.h>
117#include <syslog.h>
118#ifndef NO_SYS_POLL_H
119#include <sys/poll.h>
120#else
121#include <poll.h>
122#endif
123#if defined(__MINGW32__)
124/* pull in Windows compatibility stuff */
125#include "compat/mingw.h"
126#elif defined(_MSC_VER)
127#include "compat/msvc.h"
128#else
129#include <sys/wait.h>
130#include <sys/resource.h>
131#include <sys/socket.h>
132#include <sys/ioctl.h>
133#include <termios.h>
134#ifndef NO_SYS_SELECT_H
135#include <sys/select.h>
136#endif
137#include <netinet/in.h>
138#include <netinet/tcp.h>
139#include <arpa/inet.h>
140#include <netdb.h>
141#include <pwd.h>
142#include <sys/un.h>
143#ifndef NO_INTTYPES_H
144#include <inttypes.h>
145#else
146#include <stdint.h>
147#endif
148#ifdef NO_INTPTR_T
149/*
150 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
151 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
152 * while on IP16 and IP16L32 it is "int" (resp. "short")
153 * Size needs to match (or exceed) 'sizeof(void *)'.
154 * We can't take "long long" here as not everybody has it.
155 */
156typedef long intptr_t;
157typedef unsigned long uintptr_t;
158#endif
159#if defined(__CYGWIN__)
160#undef _XOPEN_SOURCE
161#include <grp.h>
162#define _XOPEN_SOURCE 600
163#include "compat/cygwin.h"
164#else
165#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
166#include <grp.h>
167#define _ALL_SOURCE 1
168#endif
169#endif
170
171/* used on Mac OS X */
172#ifdef PRECOMPOSE_UNICODE
173#include "compat/precompose_utf8.h"
174#else
175#define precompose_str(in,i_nfd2nfc)
176#define precompose_argv(c,v)
177#define probe_utf8_pathname_composition(a,b)
178#endif
179
180#ifdef MKDIR_WO_TRAILING_SLASH
181#define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
182extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
183#endif
184
185#ifdef NO_STRUCT_ITIMERVAL
186struct itimerval {
187 struct timeval it_interval;
188 struct timeval it_value;
189}
190#endif
191
192#ifdef NO_SETITIMER
193#define setitimer(which,value,ovalue)
194#endif
195
196#ifndef NO_LIBGEN_H
197#include <libgen.h>
198#else
199#define basename gitbasename
200extern char *gitbasename(char *);
201#endif
202
203#ifndef NO_ICONV
204#include <iconv.h>
205#endif
206
207#ifndef NO_OPENSSL
208#include <openssl/ssl.h>
209#include <openssl/err.h>
210#endif
211
212/* On most systems <netdb.h> would have given us this, but
213 * not on some systems (e.g. z/OS).
214 */
215#ifndef NI_MAXHOST
216#define NI_MAXHOST 1025
217#endif
218
219#ifndef NI_MAXSERV
220#define NI_MAXSERV 32
221#endif
222
223/* On most systems <limits.h> would have given us this, but
224 * not on some systems (e.g. GNU/Hurd).
225 */
226#ifndef PATH_MAX
227#define PATH_MAX 4096
228#endif
229
230#ifndef PRIuMAX
231#define PRIuMAX "llu"
232#endif
233
234#ifndef PRIu32
235#define PRIu32 "u"
236#endif
237
238#ifndef PRIx32
239#define PRIx32 "x"
240#endif
241
242#ifndef PRIo32
243#define PRIo32 "o"
244#endif
245
246#ifndef PATH_SEP
247#define PATH_SEP ':'
248#endif
249
250#ifdef HAVE_PATHS_H
251#include <paths.h>
252#endif
253#ifndef _PATH_DEFPATH
254#define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
255#endif
256
257#ifndef STRIP_EXTENSION
258#define STRIP_EXTENSION ""
259#endif
260
261#ifndef has_dos_drive_prefix
262#define has_dos_drive_prefix(path) 0
263#endif
264
265#ifndef is_dir_sep
266#define is_dir_sep(c) ((c) == '/')
267#endif
268
269#ifndef find_last_dir_sep
270#define find_last_dir_sep(path) strrchr(path, '/')
271#endif
272
273#if defined(__HP_cc) && (__HP_cc >= 61000)
274#define NORETURN __attribute__((noreturn))
275#define NORETURN_PTR
276#elif defined(__GNUC__) && !defined(NO_NORETURN)
277#define NORETURN __attribute__((__noreturn__))
278#define NORETURN_PTR __attribute__((__noreturn__))
279#elif defined(_MSC_VER)
280#define NORETURN __declspec(noreturn)
281#define NORETURN_PTR
282#else
283#define NORETURN
284#define NORETURN_PTR
285#ifndef __attribute__
286#define __attribute__(x)
287#endif
288#endif
289
290#include "compat/bswap.h"
291
292/* General helper functions */
293extern void vreportf(const char *prefix, const char *err, va_list params);
294extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
295extern NORETURN void usage(const char *err);
296extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
297extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
298extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
299extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
300extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
301
302extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
303extern void set_error_routine(void (*routine)(const char *err, va_list params));
304extern void set_die_is_recursing_routine(int (*routine)(void));
305
306extern int prefixcmp(const char *str, const char *prefix);
307extern int suffixcmp(const char *str, const char *suffix);
308
309static inline const char *skip_prefix(const char *str, const char *prefix)
310{
311 size_t len = strlen(prefix);
312 return strncmp(str, prefix, len) ? NULL : str + len;
313}
314
315#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
316
317#ifndef PROT_READ
318#define PROT_READ 1
319#define PROT_WRITE 2
320#define MAP_PRIVATE 1
321#endif
322
323#define mmap git_mmap
324#define munmap git_munmap
325extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
326extern int git_munmap(void *start, size_t length);
327
328#else /* NO_MMAP || USE_WIN32_MMAP */
329
330#include <sys/mman.h>
331
332#endif /* NO_MMAP || USE_WIN32_MMAP */
333
334#ifdef NO_MMAP
335
336/* This value must be multiple of (pagesize * 2) */
337#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
338
339#else /* NO_MMAP */
340
341/* This value must be multiple of (pagesize * 2) */
342#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
343 (sizeof(void*) >= 8 \
344 ? 1 * 1024 * 1024 * 1024 \
345 : 32 * 1024 * 1024)
346
347#endif /* NO_MMAP */
348
349#ifndef MAP_FAILED
350#define MAP_FAILED ((void *)-1)
351#endif
352
353#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
354#define on_disk_bytes(st) ((st).st_size)
355#else
356#define on_disk_bytes(st) ((st).st_blocks * 512)
357#endif
358
359#define DEFAULT_PACKED_GIT_LIMIT \
360 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
361
362#ifdef NO_PREAD
363#define pread git_pread
364extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
365#endif
366/*
367 * Forward decl that will remind us if its twin in cache.h changes.
368 * This function is used in compat/pread.c. But we can't include
369 * cache.h there.
370 */
371extern ssize_t read_in_full(int fd, void *buf, size_t count);
372
373#ifdef NO_SETENV
374#define setenv gitsetenv
375extern int gitsetenv(const char *, const char *, int);
376#endif
377
378#ifdef NO_MKDTEMP
379#define mkdtemp gitmkdtemp
380extern char *gitmkdtemp(char *);
381#endif
382
383#ifdef NO_MKSTEMPS
384#define mkstemps gitmkstemps
385extern int gitmkstemps(char *, int);
386#endif
387
388#ifdef NO_UNSETENV
389#define unsetenv gitunsetenv
390extern void gitunsetenv(const char *);
391#endif
392
393#ifdef NO_STRCASESTR
394#define strcasestr gitstrcasestr
395extern char *gitstrcasestr(const char *haystack, const char *needle);
396#endif
397
398#ifdef NO_STRLCPY
399#define strlcpy gitstrlcpy
400extern size_t gitstrlcpy(char *, const char *, size_t);
401#endif
402
403#ifdef NO_STRTOUMAX
404#define strtoumax gitstrtoumax
405extern uintmax_t gitstrtoumax(const char *, char **, int);
406#define strtoimax gitstrtoimax
407extern intmax_t gitstrtoimax(const char *, char **, int);
408#endif
409
410#ifdef NO_STRTOK_R
411#define strtok_r gitstrtok_r
412extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr);
413#endif
414
415#ifdef NO_HSTRERROR
416#define hstrerror githstrerror
417extern const char *githstrerror(int herror);
418#endif
419
420#ifdef NO_MEMMEM
421#define memmem gitmemmem
422void *gitmemmem(const void *haystack, size_t haystacklen,
423 const void *needle, size_t needlelen);
424#endif
425
426#ifdef FREAD_READS_DIRECTORIES
427#ifdef fopen
428#undef fopen
429#endif
430#define fopen(a,b) git_fopen(a,b)
431extern FILE *git_fopen(const char*, const char*);
432#endif
433
434#ifdef SNPRINTF_RETURNS_BOGUS
435#define snprintf git_snprintf
436extern int git_snprintf(char *str, size_t maxsize,
437 const char *format, ...);
438#define vsnprintf git_vsnprintf
439extern int git_vsnprintf(char *str, size_t maxsize,
440 const char *format, va_list ap);
441#endif
442
443#ifdef __GLIBC_PREREQ
444#if __GLIBC_PREREQ(2, 1)
445#define HAVE_STRCHRNUL
446#define HAVE_MEMPCPY
447#endif
448#endif
449
450#ifndef HAVE_STRCHRNUL
451#define strchrnul gitstrchrnul
452static inline char *gitstrchrnul(const char *s, int c)
453{
454 while (*s && *s != c)
455 s++;
456 return (char *)s;
457}
458#endif
459
460#ifndef HAVE_MEMPCPY
461#define mempcpy gitmempcpy
462static inline void *gitmempcpy(void *dest, const void *src, size_t n)
463{
464 return (char *)memcpy(dest, src, n) + n;
465}
466#endif
467
468#ifdef NO_INET_PTON
469int inet_pton(int af, const char *src, void *dst);
470#endif
471
472#ifdef NO_INET_NTOP
473const char *inet_ntop(int af, const void *src, char *dst, size_t size);
474#endif
475
476extern void release_pack_memory(size_t, int);
477
478typedef void (*try_to_free_t)(size_t);
479extern try_to_free_t set_try_to_free_routine(try_to_free_t);
480
481extern char *xstrdup(const char *str);
482extern void *xmalloc(size_t size);
483extern void *xmallocz(size_t size);
484extern void *xmemdupz(const void *data, size_t len);
485extern char *xstrndup(const char *str, size_t len);
486extern void *xrealloc(void *ptr, size_t size);
487extern void *xcalloc(size_t nmemb, size_t size);
488extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
489extern ssize_t xread(int fd, void *buf, size_t len);
490extern ssize_t xwrite(int fd, const void *buf, size_t len);
491extern int xdup(int fd);
492extern FILE *xfdopen(int fd, const char *mode);
493extern int xmkstemp(char *template);
494extern int xmkstemp_mode(char *template, int mode);
495extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
496extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
497
498static inline size_t xsize_t(off_t len)
499{
500 if (len > (size_t) len)
501 die("Cannot handle files this big");
502 return (size_t)len;
503}
504
505static inline int has_extension(const char *filename, const char *ext)
506{
507 size_t len = strlen(filename);
508 size_t extlen = strlen(ext);
509 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
510}
511
512/* in ctype.c, for kwset users */
513extern const char tolower_trans_tbl[256];
514
515/* Sane ctype - no locale, and works with signed chars */
516#undef isascii
517#undef isspace
518#undef isdigit
519#undef isalpha
520#undef isalnum
521#undef isprint
522#undef islower
523#undef isupper
524#undef tolower
525#undef toupper
526extern unsigned char sane_ctype[256];
527#define GIT_SPACE 0x01
528#define GIT_DIGIT 0x02
529#define GIT_ALPHA 0x04
530#define GIT_GLOB_SPECIAL 0x08
531#define GIT_REGEX_SPECIAL 0x10
532#define GIT_PATHSPEC_MAGIC 0x20
533#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
534#define isascii(x) (((x) & ~0x7f) == 0)
535#define isspace(x) sane_istest(x,GIT_SPACE)
536#define isdigit(x) sane_istest(x,GIT_DIGIT)
537#define isalpha(x) sane_istest(x,GIT_ALPHA)
538#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
539#define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
540#define islower(x) sane_iscase(x, 1)
541#define isupper(x) sane_iscase(x, 0)
542#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
543#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
544#define tolower(x) sane_case((unsigned char)(x), 0x20)
545#define toupper(x) sane_case((unsigned char)(x), 0)
546#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
547
548static inline int sane_case(int x, int high)
549{
550 if (sane_istest(x, GIT_ALPHA))
551 x = (x & ~0x20) | high;
552 return x;
553}
554
555static inline int sane_iscase(int x, int is_lower)
556{
557 if (!sane_istest(x, GIT_ALPHA))
558 return 0;
559
560 if (is_lower)
561 return (x & 0x20) != 0;
562 else
563 return (x & 0x20) == 0;
564}
565
566static inline int strtoul_ui(char const *s, int base, unsigned int *result)
567{
568 unsigned long ul;
569 char *p;
570
571 errno = 0;
572 ul = strtoul(s, &p, base);
573 if (errno || *p || p == s || (unsigned int) ul != ul)
574 return -1;
575 *result = ul;
576 return 0;
577}
578
579static inline int strtol_i(char const *s, int base, int *result)
580{
581 long ul;
582 char *p;
583
584 errno = 0;
585 ul = strtol(s, &p, base);
586 if (errno || *p || p == s || (int) ul != ul)
587 return -1;
588 *result = ul;
589 return 0;
590}
591
592#ifdef INTERNAL_QSORT
593void git_qsort(void *base, size_t nmemb, size_t size,
594 int(*compar)(const void *, const void *));
595#define qsort git_qsort
596#endif
597
598#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
599# define FORCE_DIR_SET_GID S_ISGID
600#else
601# define FORCE_DIR_SET_GID 0
602#endif
603
604#ifdef NO_NSEC
605#undef USE_NSEC
606#define ST_CTIME_NSEC(st) 0
607#define ST_MTIME_NSEC(st) 0
608#else
609#ifdef USE_ST_TIMESPEC
610#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
611#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
612#else
613#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
614#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
615#endif
616#endif
617
618#ifdef UNRELIABLE_FSTAT
619#define fstat_is_reliable() 0
620#else
621#define fstat_is_reliable() 1
622#endif
623
624#ifndef va_copy
625/*
626 * Since an obvious implementation of va_list would be to make it a
627 * pointer into the stack frame, a simple assignment will work on
628 * many systems. But let's try to be more portable.
629 */
630#ifdef __va_copy
631#define va_copy(dst, src) __va_copy(dst, src)
632#else
633#define va_copy(dst, src) ((dst) = (src))
634#endif
635#endif
636
637/*
638 * Preserves errno, prints a message, but gives no warning for ENOENT.
639 * Always returns the return value of unlink(2).
640 */
641int unlink_or_warn(const char *path);
642/*
643 * Likewise for rmdir(2).
644 */
645int rmdir_or_warn(const char *path);
646/*
647 * Calls the correct function out of {unlink,rmdir}_or_warn based on
648 * the supplied file mode.
649 */
650int remove_or_warn(unsigned int mode, const char *path);
651
652/*
653 * Call access(2), but warn for any error except "missing file"
654 * (ENOENT or ENOTDIR).
655 */
656int access_or_warn(const char *path, int mode);
657int access_or_die(const char *path, int mode);
658
659/* Warn on an inaccessible file that ought to be accessible */
660void warn_on_inaccessible(const char *path);
661
662/* Get the passwd entry for the UID of the current process. */
663struct passwd *xgetpwuid_self(void);
664
665#endif