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
30#ifdef __GNUC__
31#define TYPEOF(x) (__typeof__(x))
32#else
33#define TYPEOF(x)
34#endif
35
36#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
37#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
38
39/* Approximation of the length of the decimal representation of this type. */
40#define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
41
42#if defined(__sun__)
43 /*
44 * On Solaris, when _XOPEN_EXTENDED is set, its header file
45 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
46 * setting to say we are XPG5 or XPG6. Also on Solaris,
47 * XPG6 programs must be compiled with a c99 compiler, while
48 * non XPG6 programs must be compiled with a pre-c99 compiler.
49 */
50# if __STDC_VERSION__ - 0 >= 199901L
51# define _XOPEN_SOURCE 600
52# else
53# define _XOPEN_SOURCE 500
54# endif
55#elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && !defined(_M_UNIX)
56#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
57#ifndef __sun__
58#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
59#endif
60#endif
61#define _ALL_SOURCE 1
62#define _GNU_SOURCE 1
63#define _BSD_SOURCE 1
64#define _NETBSD_SOURCE 1
65
66#include <unistd.h>
67#include <stdio.h>
68#include <sys/stat.h>
69#include <fcntl.h>
70#include <stddef.h>
71#include <stdlib.h>
72#include <stdarg.h>
73#include <string.h>
74#include <errno.h>
75#include <limits.h>
76#include <sys/param.h>
77#include <sys/types.h>
78#include <dirent.h>
79#include <sys/time.h>
80#include <time.h>
81#include <signal.h>
82#include <fnmatch.h>
83#include <assert.h>
84#include <regex.h>
85#include <utime.h>
86#ifndef __MINGW32__
87#include <sys/wait.h>
88#include <sys/poll.h>
89#include <sys/socket.h>
90#include <sys/ioctl.h>
91#ifndef NO_SYS_SELECT_H
92#include <sys/select.h>
93#endif
94#include <netinet/in.h>
95#include <netinet/tcp.h>
96#include <arpa/inet.h>
97#include <netdb.h>
98#include <pwd.h>
99#include <inttypes.h>
100#if defined(__CYGWIN__)
101#undef _XOPEN_SOURCE
102#include <grp.h>
103#define _XOPEN_SOURCE 600
104#include "compat/cygwin.h"
105#else
106#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
107#include <grp.h>
108#define _ALL_SOURCE 1
109#endif
110#else /* __MINGW32__ */
111/* pull in Windows compatibility stuff */
112#include "compat/mingw.h"
113#endif /* __MINGW32__ */
114
115#ifndef NO_LIBGEN_H
116#include <libgen.h>
117#else
118#define basename gitbasename
119extern char *gitbasename(char *);
120#endif
121
122#ifndef NO_ICONV
123#include <iconv.h>
124#endif
125
126#ifndef NO_OPENSSL
127#include <openssl/ssl.h>
128#include <openssl/err.h>
129#endif
130
131/* On most systems <limits.h> would have given us this, but
132 * not on some systems (e.g. GNU/Hurd).
133 */
134#ifndef PATH_MAX
135#define PATH_MAX 4096
136#endif
137
138#ifndef PRIuMAX
139#define PRIuMAX "llu"
140#endif
141
142#ifndef PRIu32
143#define PRIu32 "u"
144#endif
145
146#ifndef PRIx32
147#define PRIx32 "x"
148#endif
149
150#ifndef PATH_SEP
151#define PATH_SEP ':'
152#endif
153
154#ifndef STRIP_EXTENSION
155#define STRIP_EXTENSION ""
156#endif
157
158#ifndef has_dos_drive_prefix
159#define has_dos_drive_prefix(path) 0
160#endif
161
162#ifndef is_dir_sep
163#define is_dir_sep(c) ((c) == '/')
164#endif
165
166#ifdef __GNUC__
167#define NORETURN __attribute__((__noreturn__))
168#else
169#define NORETURN
170#ifndef __attribute__
171#define __attribute__(x)
172#endif
173#endif
174
175/* General helper functions */
176extern void usage(const char *err) NORETURN;
177extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
178extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
179extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
180
181extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
182
183extern int prefixcmp(const char *str, const char *prefix);
184extern time_t tm_to_time_t(const struct tm *tm);
185
186static inline const char *skip_prefix(const char *str, const char *prefix)
187{
188 size_t len = strlen(prefix);
189 return strncmp(str, prefix, len) ? NULL : str + len;
190}
191
192#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
193
194#ifndef PROT_READ
195#define PROT_READ 1
196#define PROT_WRITE 2
197#define MAP_PRIVATE 1
198#define MAP_FAILED ((void*)-1)
199#endif
200
201#define mmap git_mmap
202#define munmap git_munmap
203extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
204extern int git_munmap(void *start, size_t length);
205
206#else /* NO_MMAP || USE_WIN32_MMAP */
207
208#include <sys/mman.h>
209
210#endif /* NO_MMAP || USE_WIN32_MMAP */
211
212#ifdef NO_MMAP
213
214/* This value must be multiple of (pagesize * 2) */
215#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
216
217#else /* NO_MMAP */
218
219/* This value must be multiple of (pagesize * 2) */
220#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
221 (sizeof(void*) >= 8 \
222 ? 1 * 1024 * 1024 * 1024 \
223 : 32 * 1024 * 1024)
224
225#endif /* NO_MMAP */
226
227#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
228#define on_disk_bytes(st) ((st).st_size)
229#else
230#define on_disk_bytes(st) ((st).st_blocks * 512)
231#endif
232
233#define DEFAULT_PACKED_GIT_LIMIT \
234 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
235
236#ifdef NO_PREAD
237#define pread git_pread
238extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
239#endif
240/*
241 * Forward decl that will remind us if its twin in cache.h changes.
242 * This function is used in compat/pread.c. But we can't include
243 * cache.h there.
244 */
245extern ssize_t read_in_full(int fd, void *buf, size_t count);
246
247#ifdef NO_SETENV
248#define setenv gitsetenv
249extern int gitsetenv(const char *, const char *, int);
250#endif
251
252#ifdef NO_MKDTEMP
253#define mkdtemp gitmkdtemp
254extern char *gitmkdtemp(char *);
255#endif
256
257#ifdef NO_MKSTEMPS
258#define mkstemps gitmkstemps
259extern int gitmkstemps(char *, int);
260#endif
261
262#ifdef NO_UNSETENV
263#define unsetenv gitunsetenv
264extern void gitunsetenv(const char *);
265#endif
266
267#ifdef NO_STRCASESTR
268#define strcasestr gitstrcasestr
269extern char *gitstrcasestr(const char *haystack, const char *needle);
270#endif
271
272#ifdef NO_STRLCPY
273#define strlcpy gitstrlcpy
274extern size_t gitstrlcpy(char *, const char *, size_t);
275#endif
276
277#ifdef NO_STRTOUMAX
278#define strtoumax gitstrtoumax
279extern uintmax_t gitstrtoumax(const char *, char **, int);
280#endif
281
282#ifdef NO_HSTRERROR
283#define hstrerror githstrerror
284extern const char *githstrerror(int herror);
285#endif
286
287#ifdef NO_MEMMEM
288#define memmem gitmemmem
289void *gitmemmem(const void *haystack, size_t haystacklen,
290 const void *needle, size_t needlelen);
291#endif
292
293#ifdef FREAD_READS_DIRECTORIES
294#ifdef fopen
295#undef fopen
296#endif
297#define fopen(a,b) git_fopen(a,b)
298extern FILE *git_fopen(const char*, const char*);
299#endif
300
301#ifdef SNPRINTF_RETURNS_BOGUS
302#define snprintf git_snprintf
303extern int git_snprintf(char *str, size_t maxsize,
304 const char *format, ...);
305#define vsnprintf git_vsnprintf
306extern int git_vsnprintf(char *str, size_t maxsize,
307 const char *format, va_list ap);
308#endif
309
310#ifdef __GLIBC_PREREQ
311#if __GLIBC_PREREQ(2, 1)
312#define HAVE_STRCHRNUL
313#endif
314#endif
315
316#ifndef HAVE_STRCHRNUL
317#define strchrnul gitstrchrnul
318static inline char *gitstrchrnul(const char *s, int c)
319{
320 while (*s && *s != c)
321 s++;
322 return (char *)s;
323}
324#endif
325
326extern void release_pack_memory(size_t, int);
327
328extern char *xstrdup(const char *str);
329extern void *xmalloc(size_t size);
330extern void *xmemdupz(const void *data, size_t len);
331extern char *xstrndup(const char *str, size_t len);
332extern void *xrealloc(void *ptr, size_t size);
333extern void *xcalloc(size_t nmemb, size_t size);
334extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
335extern ssize_t xread(int fd, void *buf, size_t len);
336extern ssize_t xwrite(int fd, const void *buf, size_t len);
337extern int xdup(int fd);
338extern FILE *xfdopen(int fd, const char *mode);
339extern int xmkstemp(char *template);
340extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
341extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
342
343static inline size_t xsize_t(off_t len)
344{
345 return (size_t)len;
346}
347
348static inline int has_extension(const char *filename, const char *ext)
349{
350 size_t len = strlen(filename);
351 size_t extlen = strlen(ext);
352 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
353}
354
355/* Sane ctype - no locale, and works with signed chars */
356#undef isascii
357#undef isspace
358#undef isdigit
359#undef isalpha
360#undef isalnum
361#undef tolower
362#undef toupper
363extern unsigned char sane_ctype[256];
364#define GIT_SPACE 0x01
365#define GIT_DIGIT 0x02
366#define GIT_ALPHA 0x04
367#define GIT_GLOB_SPECIAL 0x08
368#define GIT_REGEX_SPECIAL 0x10
369#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
370#define isascii(x) (((x) & ~0x7f) == 0)
371#define isspace(x) sane_istest(x,GIT_SPACE)
372#define isdigit(x) sane_istest(x,GIT_DIGIT)
373#define isalpha(x) sane_istest(x,GIT_ALPHA)
374#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
375#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
376#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
377#define tolower(x) sane_case((unsigned char)(x), 0x20)
378#define toupper(x) sane_case((unsigned char)(x), 0)
379
380static inline int sane_case(int x, int high)
381{
382 if (sane_istest(x, GIT_ALPHA))
383 x = (x & ~0x20) | high;
384 return x;
385}
386
387static inline int strtoul_ui(char const *s, int base, unsigned int *result)
388{
389 unsigned long ul;
390 char *p;
391
392 errno = 0;
393 ul = strtoul(s, &p, base);
394 if (errno || *p || p == s || (unsigned int) ul != ul)
395 return -1;
396 *result = ul;
397 return 0;
398}
399
400static inline int strtol_i(char const *s, int base, int *result)
401{
402 long ul;
403 char *p;
404
405 errno = 0;
406 ul = strtol(s, &p, base);
407 if (errno || *p || p == s || (int) ul != ul)
408 return -1;
409 *result = ul;
410 return 0;
411}
412
413#ifdef INTERNAL_QSORT
414void git_qsort(void *base, size_t nmemb, size_t size,
415 int(*compar)(const void *, const void *));
416#define qsort git_qsort
417#endif
418
419#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
420# define FORCE_DIR_SET_GID S_ISGID
421#else
422# define FORCE_DIR_SET_GID 0
423#endif
424
425#ifdef NO_NSEC
426#undef USE_NSEC
427#define ST_CTIME_NSEC(st) 0
428#define ST_MTIME_NSEC(st) 0
429#else
430#ifdef USE_ST_TIMESPEC
431#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
432#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
433#else
434#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
435#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
436#endif
437#endif
438
439#ifdef UNRELIABLE_FSTAT
440#define fstat_is_reliable() 0
441#else
442#define fstat_is_reliable() 1
443#endif
444
445/*
446 * Preserves errno, prints a message, but gives no warning for ENOENT.
447 * Always returns the return value of unlink(2).
448 */
449int unlink_or_warn(const char *path);
450
451#endif