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