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