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