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