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