da7249ac1cc5d3ccc69230face67ff43ee23101b
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)
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#else
89#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
90#include <grp.h>
91#define _ALL_SOURCE 1
92#endif
93#else /* __MINGW32__ */
94/* pull in Windows compatibility stuff */
95#include "compat/mingw.h"
96#endif /* __MINGW32__ */
97
98#ifndef NO_ICONV
99#include <iconv.h>
100#endif
101
102/* On most systems <limits.h> would have given us this, but
103 * not on some systems (e.g. GNU/Hurd).
104 */
105#ifndef PATH_MAX
106#define PATH_MAX 4096
107#endif
108
109#ifndef PRIuMAX
110#define PRIuMAX "llu"
111#endif
112
113#ifdef __GNUC__
114#define NORETURN __attribute__((__noreturn__))
115#else
116#define NORETURN
117#ifndef __attribute__
118#define __attribute__(x)
119#endif
120#endif
121
122/* General helper functions */
123extern void usage(const char *err) NORETURN;
124extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
125extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
126extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
127
128extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
129extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
130extern void set_error_routine(void (*routine)(const char *err, va_list params));
131extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
132
133extern int prefixcmp(const char *str, const char *prefix);
134
135#ifdef NO_MMAP
136
137#ifndef PROT_READ
138#define PROT_READ 1
139#define PROT_WRITE 2
140#define MAP_PRIVATE 1
141#define MAP_FAILED ((void*)-1)
142#endif
143
144#define mmap git_mmap
145#define munmap git_munmap
146extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
147extern int git_munmap(void *start, size_t length);
148
149/* This value must be multiple of (pagesize * 2) */
150#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
151
152#else /* NO_MMAP */
153
154#include <sys/mman.h>
155
156/* This value must be multiple of (pagesize * 2) */
157#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
158 (sizeof(void*) >= 8 \
159 ? 1 * 1024 * 1024 * 1024 \
160 : 32 * 1024 * 1024)
161
162#endif /* NO_MMAP */
163
164#define DEFAULT_PACKED_GIT_LIMIT \
165 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
166
167#ifdef NO_PREAD
168#define pread git_pread
169extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
170#endif
171
172#ifdef NO_SETENV
173#define setenv gitsetenv
174extern int gitsetenv(const char *, const char *, int);
175#endif
176
177#ifdef NO_MKDTEMP
178#define mkdtemp gitmkdtemp
179extern char *gitmkdtemp(char *);
180#endif
181
182#ifdef NO_UNSETENV
183#define unsetenv gitunsetenv
184extern void gitunsetenv(const char *);
185#endif
186
187#ifdef NO_STRCASESTR
188#define strcasestr gitstrcasestr
189extern char *gitstrcasestr(const char *haystack, const char *needle);
190#endif
191
192#ifdef NO_STRLCPY
193#define strlcpy gitstrlcpy
194extern size_t gitstrlcpy(char *, const char *, size_t);
195#endif
196
197#ifdef NO_STRTOUMAX
198#define strtoumax gitstrtoumax
199extern uintmax_t gitstrtoumax(const char *, char **, int);
200#endif
201
202#ifdef NO_HSTRERROR
203#define hstrerror githstrerror
204extern const char *githstrerror(int herror);
205#endif
206
207#ifdef NO_MEMMEM
208#define memmem gitmemmem
209void *gitmemmem(const void *haystack, size_t haystacklen,
210 const void *needle, size_t needlelen);
211#endif
212
213#ifdef FREAD_READS_DIRECTORIES
214#ifdef fopen
215#undef fopen
216#endif
217#define fopen(a,b) git_fopen(a,b)
218extern FILE *git_fopen(const char*, const char*);
219#endif
220
221#ifdef SNPRINTF_RETURNS_BOGUS
222#define snprintf git_snprintf
223extern int git_snprintf(char *str, size_t maxsize,
224 const char *format, ...);
225#define vsnprintf git_vsnprintf
226extern int git_vsnprintf(char *str, size_t maxsize,
227 const char *format, va_list ap);
228#endif
229
230#ifdef __GLIBC_PREREQ
231#if __GLIBC_PREREQ(2, 1)
232#define HAVE_STRCHRNUL
233#endif
234#endif
235
236#ifndef HAVE_STRCHRNUL
237#define strchrnul gitstrchrnul
238static inline char *gitstrchrnul(const char *s, int c)
239{
240 while (*s && *s != c)
241 s++;
242 return (char *)s;
243}
244#endif
245
246extern void release_pack_memory(size_t, int);
247
248static inline char* xstrdup(const char *str)
249{
250 char *ret = strdup(str);
251 if (!ret) {
252 release_pack_memory(strlen(str) + 1, -1);
253 ret = strdup(str);
254 if (!ret)
255 die("Out of memory, strdup failed");
256 }
257 return ret;
258}
259
260static inline void *xmalloc(size_t size)
261{
262 void *ret = malloc(size);
263 if (!ret && !size)
264 ret = malloc(1);
265 if (!ret) {
266 release_pack_memory(size, -1);
267 ret = malloc(size);
268 if (!ret && !size)
269 ret = malloc(1);
270 if (!ret)
271 die("Out of memory, malloc failed");
272 }
273#ifdef XMALLOC_POISON
274 memset(ret, 0xA5, size);
275#endif
276 return ret;
277}
278
279/*
280 * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
281 * "data" to the allocated memory, zero terminates the allocated memory,
282 * and returns a pointer to the allocated memory. If the allocation fails,
283 * the program dies.
284 */
285static inline void *xmemdupz(const void *data, size_t len)
286{
287 char *p = xmalloc(len + 1);
288 memcpy(p, data, len);
289 p[len] = '\0';
290 return p;
291}
292
293static inline char *xstrndup(const char *str, size_t len)
294{
295 char *p = memchr(str, '\0', len);
296 return xmemdupz(str, p ? p - str : len);
297}
298
299static inline void *xrealloc(void *ptr, size_t size)
300{
301 void *ret = realloc(ptr, size);
302 if (!ret && !size)
303 ret = realloc(ptr, 1);
304 if (!ret) {
305 release_pack_memory(size, -1);
306 ret = realloc(ptr, size);
307 if (!ret && !size)
308 ret = realloc(ptr, 1);
309 if (!ret)
310 die("Out of memory, realloc failed");
311 }
312 return ret;
313}
314
315static inline void *xcalloc(size_t nmemb, size_t size)
316{
317 void *ret = calloc(nmemb, size);
318 if (!ret && (!nmemb || !size))
319 ret = calloc(1, 1);
320 if (!ret) {
321 release_pack_memory(nmemb * size, -1);
322 ret = calloc(nmemb, size);
323 if (!ret && (!nmemb || !size))
324 ret = calloc(1, 1);
325 if (!ret)
326 die("Out of memory, calloc failed");
327 }
328 return ret;
329}
330
331static inline void *xmmap(void *start, size_t length,
332 int prot, int flags, int fd, off_t offset)
333{
334 void *ret = mmap(start, length, prot, flags, fd, offset);
335 if (ret == MAP_FAILED) {
336 if (!length)
337 return NULL;
338 release_pack_memory(length, fd);
339 ret = mmap(start, length, prot, flags, fd, offset);
340 if (ret == MAP_FAILED)
341 die("Out of memory? mmap failed: %s", strerror(errno));
342 }
343 return ret;
344}
345
346/*
347 * xread() is the same a read(), but it automatically restarts read()
348 * operations with a recoverable error (EAGAIN and EINTR). xread()
349 * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
350 */
351static inline ssize_t xread(int fd, void *buf, size_t len)
352{
353 ssize_t nr;
354 while (1) {
355 nr = read(fd, buf, len);
356 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
357 continue;
358 return nr;
359 }
360}
361
362/*
363 * xwrite() is the same a write(), but it automatically restarts write()
364 * operations with a recoverable error (EAGAIN and EINTR). xwrite() DOES NOT
365 * GUARANTEE that "len" bytes is written even if the operation is successful.
366 */
367static inline ssize_t xwrite(int fd, const void *buf, size_t len)
368{
369 ssize_t nr;
370 while (1) {
371 nr = write(fd, buf, len);
372 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
373 continue;
374 return nr;
375 }
376}
377
378static inline int xdup(int fd)
379{
380 int ret = dup(fd);
381 if (ret < 0)
382 die("dup failed: %s", strerror(errno));
383 return ret;
384}
385
386static inline FILE *xfdopen(int fd, const char *mode)
387{
388 FILE *stream = fdopen(fd, mode);
389 if (stream == NULL)
390 die("Out of memory? fdopen failed: %s", strerror(errno));
391 return stream;
392}
393
394static inline int xmkstemp(char *template)
395{
396 int fd;
397
398 fd = mkstemp(template);
399 if (fd < 0)
400 die("Unable to create temporary file: %s", strerror(errno));
401 return fd;
402}
403
404static inline size_t xsize_t(off_t len)
405{
406 return (size_t)len;
407}
408
409static inline int has_extension(const char *filename, const char *ext)
410{
411 size_t len = strlen(filename);
412 size_t extlen = strlen(ext);
413 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
414}
415
416/* Sane ctype - no locale, and works with signed chars */
417#undef isspace
418#undef isdigit
419#undef isalpha
420#undef isalnum
421#undef tolower
422#undef toupper
423extern unsigned char sane_ctype[256];
424#define GIT_SPACE 0x01
425#define GIT_DIGIT 0x02
426#define GIT_ALPHA 0x04
427#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
428#define isspace(x) sane_istest(x,GIT_SPACE)
429#define isdigit(x) sane_istest(x,GIT_DIGIT)
430#define isalpha(x) sane_istest(x,GIT_ALPHA)
431#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
432#define tolower(x) sane_case((unsigned char)(x), 0x20)
433#define toupper(x) sane_case((unsigned char)(x), 0)
434
435static inline int sane_case(int x, int high)
436{
437 if (sane_istest(x, GIT_ALPHA))
438 x = (x & ~0x20) | high;
439 return x;
440}
441
442static inline int strtoul_ui(char const *s, int base, unsigned int *result)
443{
444 unsigned long ul;
445 char *p;
446
447 errno = 0;
448 ul = strtoul(s, &p, base);
449 if (errno || *p || p == s || (unsigned int) ul != ul)
450 return -1;
451 *result = ul;
452 return 0;
453}
454
455static inline int strtol_i(char const *s, int base, int *result)
456{
457 long ul;
458 char *p;
459
460 errno = 0;
461 ul = strtol(s, &p, base);
462 if (errno || *p || p == s || (int) ul != ul)
463 return -1;
464 *result = ul;
465 return 0;
466}
467
468#ifdef INTERNAL_QSORT
469void git_qsort(void *base, size_t nmemb, size_t size,
470 int(*compar)(const void *, const void *));
471#define qsort git_qsort
472#endif
473
474#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
475# define FORCE_DIR_SET_GID S_ISGID
476#else
477# define FORCE_DIR_SET_GID 0
478#endif
479
480#endif