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