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