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