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