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