1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
4 #define _FILE_OFFSET_BITS 64
8 * See if our compiler is known to support flexible array members.
10 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
11 # define FLEX_ARRAY /* empty */
12 #elif defined(__GNUC__)
14 # define FLEX_ARRAY /* empty */
16 # define FLEX_ARRAY 0 /* older GNU extension */
21 * Otherwise, default to safer but a bit wasteful traditional style
28 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
29 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
32 #define TYPEOF(x) (__typeof__(x))
37 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
38 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
40 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
42 /* Approximation of the length of the decimal representation of this type. */
43 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
47 * On Solaris, when _XOPEN_EXTENDED is set, its header file
48 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
49 * setting to say we are XPG5 or XPG6. Also on Solaris,
50 * XPG6 programs must be compiled with a c99 compiler, while
51 * non XPG6 programs must be compiled with a pre-c99 compiler.
53 # if __STDC_VERSION__ - 0 >= 199901L
54 # define _XOPEN_SOURCE 600
56 # define _XOPEN_SOURCE 500
58 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
59 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__)
60 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
61 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
66 #define _NETBSD_SOURCE 1
69 #ifdef WIN32 /* Both MinGW and MSVC */
70 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
85 #include <sys/param.h>
86 #include <sys/types.h>
98 #include <sys/socket.h>
99 #include <sys/ioctl.h>
101 #ifndef NO_SYS_SELECT_H
102 #include <sys/select.h>
104 #include <netinet/in.h>
105 #include <netinet/tcp.h>
106 #include <arpa/inet.h>
109 #include <inttypes.h>
110 #if defined(__CYGWIN__)
113 #define _XOPEN_SOURCE 600
114 #include "compat/cygwin.h"
116 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
118 #define _ALL_SOURCE 1
120 #else /* __MINGW32__ */
121 /* pull in Windows compatibility stuff */
122 #include "compat/mingw.h"
123 #endif /* __MINGW32__ */
125 #include "compat/msvc.h"
131 #define basename gitbasename
132 extern char *gitbasename(char *);
140 #include <openssl/ssl.h>
141 #include <openssl/err.h>
144 /* On most systems <limits.h> would have given us this, but
145 * not on some systems (e.g. GNU/Hurd).
148 #define PATH_MAX 4096
152 #define PRIuMAX "llu"
174 #ifndef _PATH_DEFPATH
175 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
178 #ifndef STRIP_EXTENSION
179 #define STRIP_EXTENSION ""
182 #ifndef has_dos_drive_prefix
183 #define has_dos_drive_prefix(path) 0
186 #ifndef offset_1st_component
187 #define offset_1st_component(path) (is_dir_sep((path)[0]))
191 #define is_dir_sep(c) ((c) == '/')
195 #define NORETURN __attribute__((__noreturn__))
196 #define NORETURN_PTR __attribute__((__noreturn__))
197 #elif defined(_MSC_VER)
198 #define NORETURN __declspec(noreturn)
203 #ifndef __attribute__
204 #define __attribute__(x)
208 #include "compat/bswap.h"
210 /* General helper functions */
211 extern void vreportf(const char *prefix
, const char *err
, va_list params
);
212 extern NORETURN
void usage(const char *err
);
213 extern NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
214 extern NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
215 extern NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
216 extern int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
217 extern void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
219 extern void set_die_routine(NORETURN_PTR
void (*routine
)(const char *err
, va_list params
));
221 extern int prefixcmp(const char *str
, const char *prefix
);
222 extern int suffixcmp(const char *str
, const char *suffix
);
224 static inline const char *skip_prefix(const char *str
, const char *prefix
)
226 size_t len
= strlen(prefix
);
227 return strncmp(str
, prefix
, len
) ? NULL
: str
+ len
;
230 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
235 #define MAP_PRIVATE 1
238 #define mmap git_mmap
239 #define munmap git_munmap
240 extern void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
241 extern int git_munmap(void *start
, size_t length
);
243 #else /* NO_MMAP || USE_WIN32_MMAP */
245 #include <sys/mman.h>
247 #endif /* NO_MMAP || USE_WIN32_MMAP */
251 /* This value must be multiple of (pagesize * 2) */
252 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
256 /* This value must be multiple of (pagesize * 2) */
257 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
258 (sizeof(void*) >= 8 \
259 ? 1 * 1024 * 1024 * 1024 \
265 #define MAP_FAILED ((void *)-1)
268 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
269 #define on_disk_bytes(st) ((st).st_size)
271 #define on_disk_bytes(st) ((st).st_blocks * 512)
274 #define DEFAULT_PACKED_GIT_LIMIT \
275 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
278 #define pread git_pread
279 extern ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
282 * Forward decl that will remind us if its twin in cache.h changes.
283 * This function is used in compat/pread.c. But we can't include
286 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
289 #define setenv gitsetenv
290 extern int gitsetenv(const char *, const char *, int);
294 #define mkdtemp gitmkdtemp
295 extern char *gitmkdtemp(char *);
299 #define mkstemps gitmkstemps
300 extern int gitmkstemps(char *, int);
304 #define unsetenv gitunsetenv
305 extern void gitunsetenv(const char *);
309 #define strcasestr gitstrcasestr
310 extern char *gitstrcasestr(const char *haystack
, const char *needle
);
314 #define strlcpy gitstrlcpy
315 extern size_t gitstrlcpy(char *, const char *, size_t);
319 #define strtoumax gitstrtoumax
320 extern uintmax_t gitstrtoumax(const char *, char **, int);
324 #define strtok_r gitstrtok_r
325 extern char *gitstrtok_r(char *s
, const char *delim
, char **save_ptr
);
329 #define hstrerror githstrerror
330 extern const char *githstrerror(int herror
);
334 #define memmem gitmemmem
335 void *gitmemmem(const void *haystack
, size_t haystacklen
,
336 const void *needle
, size_t needlelen
);
339 #ifdef FREAD_READS_DIRECTORIES
343 #define fopen(a,b) git_fopen(a,b)
344 extern FILE *git_fopen(const char*, const char*);
347 #ifdef SNPRINTF_RETURNS_BOGUS
348 #define snprintf git_snprintf
349 extern int git_snprintf(char *str
, size_t maxsize
,
350 const char *format
, ...);
351 #define vsnprintf git_vsnprintf
352 extern int git_vsnprintf(char *str
, size_t maxsize
,
353 const char *format
, va_list ap
);
356 #ifdef __GLIBC_PREREQ
357 #if __GLIBC_PREREQ(2, 1)
358 #define HAVE_STRCHRNUL
363 #ifndef HAVE_STRCHRNUL
364 #define strchrnul gitstrchrnul
365 static inline char *gitstrchrnul(const char *s
, int c
)
367 while (*s
&& *s
!= c
)
374 #define mempcpy gitmempcpy
375 static inline void *gitmempcpy(void *dest
, const void *src
, size_t n
)
377 return (char *)memcpy(dest
, src
, n
) + n
;
381 extern void release_pack_memory(size_t, int);
383 typedef void (*try_to_free_t
)(size_t);
384 extern try_to_free_t
set_try_to_free_routine(try_to_free_t
);
386 extern char *xstrdup(const char *str
);
387 extern void *xmalloc(size_t size
);
388 extern void *xmallocz(size_t size
);
389 extern void *xmemdupz(const void *data
, size_t len
);
390 extern char *xstrndup(const char *str
, size_t len
);
391 extern void *xrealloc(void *ptr
, size_t size
);
392 extern void *xcalloc(size_t nmemb
, size_t size
);
393 extern void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
394 extern ssize_t
xread(int fd
, void *buf
, size_t len
);
395 extern ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
396 extern int xdup(int fd
);
397 extern FILE *xfdopen(int fd
, const char *mode
);
398 extern int xmkstemp(char *template);
399 extern int odb_mkstemp(char *template, size_t limit
, const char *pattern
);
400 extern int odb_pack_keep(char *name
, size_t namesz
, unsigned char *sha1
);
402 static inline size_t xsize_t(off_t len
)
404 if (len
> (size_t) len
)
405 die("Cannot handle files this big");
409 static inline int has_extension(const char *filename
, const char *ext
)
411 size_t len
= strlen(filename
);
412 size_t extlen
= strlen(ext
);
413 return len
> extlen
&& !memcmp(filename
+ len
- extlen
, ext
, extlen
);
416 /* Sane ctype - no locale, and works with signed chars */
424 extern unsigned char sane_ctype
[256];
425 #define GIT_SPACE 0x01
426 #define GIT_DIGIT 0x02
427 #define GIT_ALPHA 0x04
428 #define GIT_GLOB_SPECIAL 0x08
429 #define GIT_REGEX_SPECIAL 0x10
430 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
431 #define isascii(x) (((x) & ~0x7f) == 0)
432 #define isspace(x) sane_istest(x,GIT_SPACE)
433 #define isdigit(x) sane_istest(x,GIT_DIGIT)
434 #define isalpha(x) sane_istest(x,GIT_ALPHA)
435 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
436 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
437 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
438 #define tolower(x) sane_case((unsigned char)(x), 0x20)
439 #define toupper(x) sane_case((unsigned char)(x), 0)
441 static inline int sane_case(int x
, int high
)
443 if (sane_istest(x
, GIT_ALPHA
))
444 x
= (x
& ~0x20) | high
;
448 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
454 ul
= strtoul(s
, &p
, base
);
455 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
461 static inline int strtol_i(char const *s
, int base
, int *result
)
467 ul
= strtol(s
, &p
, base
);
468 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
474 #ifdef INTERNAL_QSORT
475 void git_qsort(void *base
, size_t nmemb
, size_t size
,
476 int(*compar
)(const void *, const void *));
477 #define qsort git_qsort
480 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
481 # define FORCE_DIR_SET_GID S_ISGID
483 # define FORCE_DIR_SET_GID 0
488 #define ST_CTIME_NSEC(st) 0
489 #define ST_MTIME_NSEC(st) 0
491 #ifdef USE_ST_TIMESPEC
492 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
493 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
495 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
496 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
500 #ifdef UNRELIABLE_FSTAT
501 #define fstat_is_reliable() 0
503 #define fstat_is_reliable() 1
507 * Preserves errno, prints a message, but gives no warning for ENOENT.
508 * Always returns the return value of unlink(2).
510 int unlink_or_warn(const char *path
);
512 * Likewise for rmdir(2).
514 int rmdir_or_warn(const char *path
);
516 * Calls the correct function out of {unlink,rmdir}_or_warn based on
517 * the supplied file mode.
519 int remove_or_warn(unsigned int mode
, const char *path
);
521 #ifndef mark_as_git_dir
522 #define mark_as_git_dir(x) /* noop */
525 #ifndef get_home_directory
526 #define get_home_directory() getenv("HOME")