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"
167 #ifndef STRIP_EXTENSION
168 #define STRIP_EXTENSION ""
171 #ifndef has_dos_drive_prefix
172 #define has_dos_drive_prefix(path) 0
176 #define is_dir_sep(c) ((c) == '/')
180 #define NORETURN __attribute__((__noreturn__))
181 #define NORETURN_PTR __attribute__((__noreturn__))
182 #elif defined(_MSC_VER)
183 #define NORETURN __declspec(noreturn)
188 #ifndef __attribute__
189 #define __attribute__(x)
193 #include "compat/bswap.h"
195 /* General helper functions */
196 extern void vreportf(const char *prefix
, const char *err
, va_list params
);
197 extern NORETURN
void usage(const char *err
);
198 extern NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
199 extern NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
200 extern NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
201 extern int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
202 extern void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
204 extern void set_die_routine(NORETURN_PTR
void (*routine
)(const char *err
, va_list params
));
206 extern int prefixcmp(const char *str
, const char *prefix
);
207 extern int suffixcmp(const char *str
, const char *suffix
);
209 static inline const char *skip_prefix(const char *str
, const char *prefix
)
211 size_t len
= strlen(prefix
);
212 return strncmp(str
, prefix
, len
) ? NULL
: str
+ len
;
215 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
220 #define MAP_PRIVATE 1
221 #define MAP_FAILED ((void*)-1)
224 #define mmap git_mmap
225 #define munmap git_munmap
226 extern void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
227 extern int git_munmap(void *start
, size_t length
);
229 #else /* NO_MMAP || USE_WIN32_MMAP */
231 #include <sys/mman.h>
233 #endif /* NO_MMAP || USE_WIN32_MMAP */
237 /* This value must be multiple of (pagesize * 2) */
238 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
242 /* This value must be multiple of (pagesize * 2) */
243 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
244 (sizeof(void*) >= 8 \
245 ? 1 * 1024 * 1024 * 1024 \
250 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
251 #define on_disk_bytes(st) ((st).st_size)
253 #define on_disk_bytes(st) ((st).st_blocks * 512)
256 #define DEFAULT_PACKED_GIT_LIMIT \
257 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
260 #define pread git_pread
261 extern ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
264 * Forward decl that will remind us if its twin in cache.h changes.
265 * This function is used in compat/pread.c. But we can't include
268 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
271 #define setenv gitsetenv
272 extern int gitsetenv(const char *, const char *, int);
276 #define mkdtemp gitmkdtemp
277 extern char *gitmkdtemp(char *);
281 #define mkstemps gitmkstemps
282 extern int gitmkstemps(char *, int);
286 #define unsetenv gitunsetenv
287 extern void gitunsetenv(const char *);
291 #define strcasestr gitstrcasestr
292 extern char *gitstrcasestr(const char *haystack
, const char *needle
);
296 #define strlcpy gitstrlcpy
297 extern size_t gitstrlcpy(char *, const char *, size_t);
301 #define strtoumax gitstrtoumax
302 extern uintmax_t gitstrtoumax(const char *, char **, int);
306 #define hstrerror githstrerror
307 extern const char *githstrerror(int herror
);
311 #define memmem gitmemmem
312 void *gitmemmem(const void *haystack
, size_t haystacklen
,
313 const void *needle
, size_t needlelen
);
316 #ifdef FREAD_READS_DIRECTORIES
320 #define fopen(a,b) git_fopen(a,b)
321 extern FILE *git_fopen(const char*, const char*);
324 #ifdef SNPRINTF_RETURNS_BOGUS
325 #define snprintf git_snprintf
326 extern int git_snprintf(char *str
, size_t maxsize
,
327 const char *format
, ...);
328 #define vsnprintf git_vsnprintf
329 extern int git_vsnprintf(char *str
, size_t maxsize
,
330 const char *format
, va_list ap
);
333 #ifdef __GLIBC_PREREQ
334 #if __GLIBC_PREREQ(2, 1)
335 #define HAVE_STRCHRNUL
340 #ifndef HAVE_STRCHRNUL
341 #define strchrnul gitstrchrnul
342 static inline char *gitstrchrnul(const char *s
, int c
)
344 while (*s
&& *s
!= c
)
351 #define mempcpy gitmempcpy
352 static inline void *gitmempcpy(void *dest
, const void *src
, size_t n
)
354 return (char *)memcpy(dest
, src
, n
) + n
;
358 extern void release_pack_memory(size_t, int);
360 extern void set_try_to_free_routine(void (*routine
)(size_t));
362 extern char *xstrdup(const char *str
);
363 extern void *xmalloc(size_t size
);
364 extern void *xmallocz(size_t size
);
365 extern void *xmemdupz(const void *data
, size_t len
);
366 extern char *xstrndup(const char *str
, size_t len
);
367 extern void *xrealloc(void *ptr
, size_t size
);
368 extern void *xcalloc(size_t nmemb
, size_t size
);
369 extern void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
370 extern ssize_t
xread(int fd
, void *buf
, size_t len
);
371 extern ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
372 extern int xdup(int fd
);
373 extern FILE *xfdopen(int fd
, const char *mode
);
374 extern int xmkstemp(char *template);
375 extern int odb_mkstemp(char *template, size_t limit
, const char *pattern
);
376 extern int odb_pack_keep(char *name
, size_t namesz
, unsigned char *sha1
);
378 static inline size_t xsize_t(off_t len
)
383 static inline int has_extension(const char *filename
, const char *ext
)
385 size_t len
= strlen(filename
);
386 size_t extlen
= strlen(ext
);
387 return len
> extlen
&& !memcmp(filename
+ len
- extlen
, ext
, extlen
);
390 /* Sane ctype - no locale, and works with signed chars */
398 extern unsigned char sane_ctype
[256];
399 #define GIT_SPACE 0x01
400 #define GIT_DIGIT 0x02
401 #define GIT_ALPHA 0x04
402 #define GIT_GLOB_SPECIAL 0x08
403 #define GIT_REGEX_SPECIAL 0x10
404 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
405 #define isascii(x) (((x) & ~0x7f) == 0)
406 #define isspace(x) sane_istest(x,GIT_SPACE)
407 #define isdigit(x) sane_istest(x,GIT_DIGIT)
408 #define isalpha(x) sane_istest(x,GIT_ALPHA)
409 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
410 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
411 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
412 #define tolower(x) sane_case((unsigned char)(x), 0x20)
413 #define toupper(x) sane_case((unsigned char)(x), 0)
415 static inline int sane_case(int x
, int high
)
417 if (sane_istest(x
, GIT_ALPHA
))
418 x
= (x
& ~0x20) | high
;
422 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
428 ul
= strtoul(s
, &p
, base
);
429 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
435 static inline int strtol_i(char const *s
, int base
, int *result
)
441 ul
= strtol(s
, &p
, base
);
442 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
448 #ifdef INTERNAL_QSORT
449 void git_qsort(void *base
, size_t nmemb
, size_t size
,
450 int(*compar
)(const void *, const void *));
451 #define qsort git_qsort
454 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
455 # define FORCE_DIR_SET_GID S_ISGID
457 # define FORCE_DIR_SET_GID 0
462 #define ST_CTIME_NSEC(st) 0
463 #define ST_MTIME_NSEC(st) 0
465 #ifdef USE_ST_TIMESPEC
466 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
467 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
469 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
470 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
474 #ifdef UNRELIABLE_FSTAT
475 #define fstat_is_reliable() 0
477 #define fstat_is_reliable() 1
481 * Preserves errno, prints a message, but gives no warning for ENOENT.
482 * Always returns the return value of unlink(2).
484 int unlink_or_warn(const char *path
);
486 * Likewise for rmdir(2).
488 int rmdir_or_warn(const char *path
);
490 * Calls the correct function out of {unlink,rmdir}_or_warn based on
491 * the supplied file mode.
493 int remove_or_warn(unsigned int mode
, const char *path
);
495 #ifndef mark_as_git_dir
496 #define mark_as_git_dir(x) /* noop */