git-compat-util.h

   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) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
  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(__sun__)
  43  /*
  44   * On Solaris, when _XOPEN_EXTENDED is set, its header file
  45   * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
  46   * setting to say we are XPG5 or XPG6.  Also on Solaris,
  47   * XPG6 programs must be compiled with a c99 compiler, while
  48   * non XPG6 programs must be compiled with a pre-c99 compiler.
  49   */
  50 # if __STDC_VERSION__ - 0 >= 199901L
  51 # define _XOPEN_SOURCE 600
  52 # else
  53 # define _XOPEN_SOURCE 500
  54 # endif
  55 #elif !defined(__APPLE__) && !defined(__FreeBSD__)  && !defined(__USLC__) && !defined(_M_UNIX) && !defined(sgi)
  56 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
  57 #ifndef __sun__
  58 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
  59 #endif
  60 #endif
  61 #define _ALL_SOURCE 1
  62 #define _GNU_SOURCE 1
  63 #define _BSD_SOURCE 1
  64 #define _NETBSD_SOURCE 1
  65 #define _SGI_SOURCE 1
  66
  67 #include <unistd.h>
  68 #include <stdio.h>
  69 #include <sys/stat.h>
  70 #include <fcntl.h>
  71 #include <stddef.h>
  72 #include <stdlib.h>
  73 #include <stdarg.h>
  74 #include <string.h>
  75 #include <errno.h>
  76 #include <limits.h>
  77 #include <sys/param.h>
  78 #include <sys/types.h>
  79 #include <dirent.h>
  80 #include <sys/time.h>
  81 #include <time.h>
  82 #include <signal.h>
  83 #include <fnmatch.h>
  84 #include <assert.h>
  85 #include <regex.h>
  86 #include <utime.h>
  87 #ifndef __MINGW32__
  88 #include <sys/wait.h>
  89 #include <sys/poll.h>
  90 #include <sys/socket.h>
  91 #include <sys/ioctl.h>
  92 #ifndef NO_SYS_SELECT_H
  93 #include <sys/select.h>
  94 #endif
  95 #include <netinet/in.h>
  96 #include <netinet/tcp.h>
  97 #include <arpa/inet.h>
  98 #include <netdb.h>
  99 #include <pwd.h>
 100 #include <inttypes.h>
 101 #if defined(__CYGWIN__)
 102 #undef _XOPEN_SOURCE
 103 #include <grp.h>
 104 #define _XOPEN_SOURCE 600
 105 #include "compat/cygwin.h"
 106 #else
 107 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
 108 #include <grp.h>
 109 #define _ALL_SOURCE 1
 110 #endif
 111 #else   /* __MINGW32__ */
 112 /* pull in Windows compatibility stuff */
 113 #include "compat/mingw.h"
 114 #endif  /* __MINGW32__ */
 115
 116 #ifndef NO_LIBGEN_H
 117 #include <libgen.h>
 118 #else
 119 #define basename gitbasename
 120 extern char *gitbasename(char *);
 121 #endif
 122
 123 #ifndef NO_ICONV
 124 #include <iconv.h>
 125 #endif
 126
 127 #ifndef NO_OPENSSL
 128 #include <openssl/ssl.h>
 129 #include <openssl/err.h>
 130 #endif
 131
 132 /* On most systems <limits.h> would have given us this, but
 133  * not on some systems (e.g. GNU/Hurd).
 134  */
 135 #ifndef PATH_MAX
 136 #define PATH_MAX 4096
 137 #endif
 138
 139 #ifndef PRIuMAX
 140 #define PRIuMAX "llu"
 141 #endif
 142
 143 #ifndef PRIu32
 144 #define PRIu32 "u"
 145 #endif
 146
 147 #ifndef PRIx32
 148 #define PRIx32 "x"
 149 #endif
 150
 151 #ifndef PATH_SEP
 152 #define PATH_SEP ':'
 153 #endif
 154
 155 #ifndef STRIP_EXTENSION
 156 #define STRIP_EXTENSION ""
 157 #endif
 158
 159 #ifndef has_dos_drive_prefix
 160 #define has_dos_drive_prefix(path) 0
 161 #endif
 162
 163 #ifndef is_dir_sep
 164 #define is_dir_sep(c) ((c) == '/')
 165 #endif
 166
 167 #ifdef __GNUC__
 168 #define NORETURN __attribute__((__noreturn__))
 169 #else
 170 #define NORETURN
 171 #ifndef __attribute__
 172 #define __attribute__(x)
 173 #endif
 174 #endif
 175
 176 /* General helper functions */
 177 extern void usage(const char *err) NORETURN;
 178 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
 179 extern void die_errno(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
 180 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 181 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 182
 183 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
 184
 185 extern int prefixcmp(const char *str, const char *prefix);
 186 extern time_t tm_to_time_t(const struct tm *tm);
 187
 188 static inline const char *skip_prefix(const char *str, const char *prefix)
 189 {
 190         size_t len = strlen(prefix);
 191         return strncmp(str, prefix, len) ? NULL : str + len;
 192 }
 193
 194 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
 195
 196 #ifndef PROT_READ
 197 #define PROT_READ 1
 198 #define PROT_WRITE 2
 199 #define MAP_PRIVATE 1
 200 #define MAP_FAILED ((void*)-1)
 201 #endif
 202
 203 #define mmap git_mmap
 204 #define munmap git_munmap
 205 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 206 extern int git_munmap(void *start, size_t length);
 207
 208 #else /* NO_MMAP || USE_WIN32_MMAP */
 209
 210 #include <sys/mman.h>
 211
 212 #endif /* NO_MMAP || USE_WIN32_MMAP */
 213
 214 #ifdef NO_MMAP
 215
 216 /* This value must be multiple of (pagesize * 2) */
 217 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 218
 219 #else /* NO_MMAP */
 220
 221 /* This value must be multiple of (pagesize * 2) */
 222 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 223         (sizeof(void*) >= 8 \
 224                 ?  1 * 1024 * 1024 * 1024 \
 225                 : 32 * 1024 * 1024)
 226
 227 #endif /* NO_MMAP */
 228
 229 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
 230 #define on_disk_bytes(st) ((st).st_size)
 231 #else
 232 #define on_disk_bytes(st) ((st).st_blocks * 512)
 233 #endif
 234
 235 #define DEFAULT_PACKED_GIT_LIMIT \
 236         ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
 237
 238 #ifdef NO_PREAD
 239 #define pread git_pread
 240 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 241 #endif
 242 /*
 243  * Forward decl that will remind us if its twin in cache.h changes.
 244  * This function is used in compat/pread.c.  But we can't include
 245  * cache.h there.
 246  */
 247 extern ssize_t read_in_full(int fd, void *buf, size_t count);
 248
 249 #ifdef NO_SETENV
 250 #define setenv gitsetenv
 251 extern int gitsetenv(const char *, const char *, int);
 252 #endif
 253
 254 #ifdef NO_MKDTEMP
 255 #define mkdtemp gitmkdtemp
 256 extern char *gitmkdtemp(char *);
 257 #endif
 258
 259 #ifdef NO_MKSTEMPS
 260 #define mkstemps gitmkstemps
 261 extern int gitmkstemps(char *, int);
 262 #endif
 263
 264 #ifdef NO_UNSETENV
 265 #define unsetenv gitunsetenv
 266 extern void gitunsetenv(const char *);
 267 #endif
 268
 269 #ifdef NO_STRCASESTR
 270 #define strcasestr gitstrcasestr
 271 extern char *gitstrcasestr(const char *haystack, const char *needle);
 272 #endif
 273
 274 #ifdef NO_STRLCPY
 275 #define strlcpy gitstrlcpy
 276 extern size_t gitstrlcpy(char *, const char *, size_t);
 277 #endif
 278
 279 #ifdef NO_STRTOUMAX
 280 #define strtoumax gitstrtoumax
 281 extern uintmax_t gitstrtoumax(const char *, char **, int);
 282 #endif
 283
 284 #ifdef NO_HSTRERROR
 285 #define hstrerror githstrerror
 286 extern const char *githstrerror(int herror);
 287 #endif
 288
 289 #ifdef NO_MEMMEM
 290 #define memmem gitmemmem
 291 void *gitmemmem(const void *haystack, size_t haystacklen,
 292                 const void *needle, size_t needlelen);
 293 #endif
 294
 295 #ifdef FREAD_READS_DIRECTORIES
 296 #ifdef fopen
 297 #undef fopen
 298 #endif
 299 #define fopen(a,b) git_fopen(a,b)
 300 extern FILE *git_fopen(const char*, const char*);
 301 #endif
 302
 303 #ifdef SNPRINTF_RETURNS_BOGUS
 304 #define snprintf git_snprintf
 305 extern int git_snprintf(char *str, size_t maxsize,
 306                         const char *format, ...);
 307 #define vsnprintf git_vsnprintf
 308 extern int git_vsnprintf(char *str, size_t maxsize,
 309                          const char *format, va_list ap);
 310 #endif
 311
 312 #ifdef __GLIBC_PREREQ
 313 #if __GLIBC_PREREQ(2, 1)
 314 #define HAVE_STRCHRNUL
 315 #endif
 316 #endif
 317
 318 #ifndef HAVE_STRCHRNUL
 319 #define strchrnul gitstrchrnul
 320 static inline char *gitstrchrnul(const char *s, int c)
 321 {
 322         while (*s && *s != c)
 323                 s++;
 324         return (char *)s;
 325 }
 326 #endif
 327
 328 extern void release_pack_memory(size_t, int);
 329
 330 extern char *xstrdup(const char *str);
 331 extern void *xmalloc(size_t size);
 332 extern void *xmemdupz(const void *data, size_t len);
 333 extern char *xstrndup(const char *str, size_t len);
 334 extern void *xrealloc(void *ptr, size_t size);
 335 extern void *xcalloc(size_t nmemb, size_t size);
 336 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 337 extern ssize_t xread(int fd, void *buf, size_t len);
 338 extern ssize_t xwrite(int fd, const void *buf, size_t len);
 339 extern int xdup(int fd);
 340 extern FILE *xfdopen(int fd, const char *mode);
 341 extern int xmkstemp(char *template);
 342 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
 343 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
 344
 345 static inline size_t xsize_t(off_t len)
 346 {
 347         return (size_t)len;
 348 }
 349
 350 static inline int has_extension(const char *filename, const char *ext)
 351 {
 352         size_t len = strlen(filename);
 353         size_t extlen = strlen(ext);
 354         return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 355 }
 356
 357 /* Sane ctype - no locale, and works with signed chars */
 358 #undef isascii
 359 #undef isspace
 360 #undef isdigit
 361 #undef isalpha
 362 #undef isalnum
 363 #undef tolower
 364 #undef toupper
 365 extern unsigned char sane_ctype[256];
 366 #define GIT_SPACE 0x01
 367 #define GIT_DIGIT 0x02
 368 #define GIT_ALPHA 0x04
 369 #define GIT_GLOB_SPECIAL 0x08
 370 #define GIT_REGEX_SPECIAL 0x10
 371 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 372 #define isascii(x) (((x) & ~0x7f) == 0)
 373 #define isspace(x) sane_istest(x,GIT_SPACE)
 374 #define isdigit(x) sane_istest(x,GIT_DIGIT)
 375 #define isalpha(x) sane_istest(x,GIT_ALPHA)
 376 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 377 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
 378 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
 379 #define tolower(x) sane_case((unsigned char)(x), 0x20)
 380 #define toupper(x) sane_case((unsigned char)(x), 0)
 381
 382 static inline int sane_case(int x, int high)
 383 {
 384         if (sane_istest(x, GIT_ALPHA))
 385                 x = (x & ~0x20) | high;
 386         return x;
 387 }
 388
 389 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 390 {
 391         unsigned long ul;
 392         char *p;
 393
 394         errno = 0;
 395         ul = strtoul(s, &p, base);
 396         if (errno || *p || p == s || (unsigned int) ul != ul)
 397                 return -1;
 398         *result = ul;
 399         return 0;
 400 }
 401
 402 static inline int strtol_i(char const *s, int base, int *result)
 403 {
 404         long ul;
 405         char *p;
 406
 407         errno = 0;
 408         ul = strtol(s, &p, base);
 409         if (errno || *p || p == s || (int) ul != ul)
 410                 return -1;
 411         *result = ul;
 412         return 0;
 413 }
 414
 415 #ifdef INTERNAL_QSORT
 416 void git_qsort(void *base, size_t nmemb, size_t size,
 417                int(*compar)(const void *, const void *));
 418 #define qsort git_qsort
 419 #endif
 420
 421 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
 422 # define FORCE_DIR_SET_GID S_ISGID
 423 #else
 424 # define FORCE_DIR_SET_GID 0
 425 #endif
 426
 427 #ifdef NO_NSEC
 428 #undef USE_NSEC
 429 #define ST_CTIME_NSEC(st) 0
 430 #define ST_MTIME_NSEC(st) 0
 431 #else
 432 #ifdef USE_ST_TIMESPEC
 433 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
 434 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
 435 #else
 436 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
 437 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
 438 #endif
 439 #endif
 440
 441 #ifdef UNRELIABLE_FSTAT
 442 #define fstat_is_reliable() 0
 443 #else
 444 #define fstat_is_reliable() 1
 445 #endif
 446
 447 /*
 448  * Preserves errno, prints a message, but gives no warning for ENOENT.
 449  * Always returns the return value of unlink(2).
 450  */
 451 int unlink_or_warn(const char *path);
 452
 453 #endif