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