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 #define bitsizeof(x)  (CHAR_BIT * sizeof(x))
  30
  31 #define maximum_signed_value_of_type(a) \
  32     (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
  33
  34 #define maximum_unsigned_value_of_type(a) \
  35     (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
  36
  37 /*
  38  * Signed integer overflow is undefined in C, so here's a helper macro
  39  * to detect if the sum of two integers will overflow.
  40  *
  41  * Requires: a >= 0, typeof(a) equals typeof(b)
  42  */
  43 #define signed_add_overflows(a, b) \
  44     ((b) > maximum_signed_value_of_type(a) - (a))
  45
  46 #define unsigned_add_overflows(a, b) \
  47     ((b) > maximum_unsigned_value_of_type(a) - (a))
  48
  49 #ifdef __GNUC__
  50 #define TYPEOF(x) (__typeof__(x))
  51 #else
  52 #define TYPEOF(x)
  53 #endif
  54
  55 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
  56 #define HAS_MULTI_BITS(i)  ((i) & ((i) - 1))  /* checks if an integer has more than 1 bit set */
  57
  58 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
  59
  60 /* Approximation of the length of the decimal representation of this type. */
  61 #define decimal_length(x)       ((int)(sizeof(x) * 2.56 + 0.5) + 1)
  62
  63 #if defined(__sun__)
  64  /*
  65   * On Solaris, when _XOPEN_EXTENDED is set, its header file
  66   * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
  67   * setting to say we are XPG5 or XPG6.  Also on Solaris,
  68   * XPG6 programs must be compiled with a c99 compiler, while
  69   * non XPG6 programs must be compiled with a pre-c99 compiler.
  70   */
  71 # if __STDC_VERSION__ - 0 >= 199901L
  72 # define _XOPEN_SOURCE 600
  73 # else
  74 # define _XOPEN_SOURCE 500
  75 # endif
  76 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
  77       !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__)
  78 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
  79 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
  80 #endif
  81 #define _ALL_SOURCE 1
  82 #define _GNU_SOURCE 1
  83 #define _BSD_SOURCE 1
  84 #define _NETBSD_SOURCE 1
  85 #define _SGI_SOURCE 1
  86
  87 #ifdef WIN32 /* Both MinGW and MSVC */
  88 #define WIN32_LEAN_AND_MEAN  /* stops windows.h including winsock.h */
  89 #include <winsock2.h>
  90 #include <windows.h>
  91 #endif
  92
  93 #include <unistd.h>
  94 #include <stdio.h>
  95 #include <sys/stat.h>
  96 #include <fcntl.h>
  97 #include <stddef.h>
  98 #include <stdlib.h>
  99 #include <stdarg.h>
 100 #include <string.h>
 101 #include <errno.h>
 102 #include <limits.h>
 103 #include <sys/param.h>
 104 #include <sys/types.h>
 105 #include <dirent.h>
 106 #include <sys/time.h>
 107 #include <time.h>
 108 #include <signal.h>
 109 #include <fnmatch.h>
 110 #include <assert.h>
 111 #include <regex.h>
 112 #include <utime.h>
 113 #include <syslog.h>
 114 #ifndef NO_SYS_POLL_H
 115 #include <sys/poll.h>
 116 #else
 117 #include <poll.h>
 118 #endif
 119 #if defined(__MINGW32__)
 120 /* pull in Windows compatibility stuff */
 121 #include "compat/mingw.h"
 122 #elif defined(_MSC_VER)
 123 #include "compat/msvc.h"
 124 #else
 125 #include <sys/wait.h>
 126 #include <sys/resource.h>
 127 #include <sys/socket.h>
 128 #include <sys/ioctl.h>
 129 #include <termios.h>
 130 #ifndef NO_SYS_SELECT_H
 131 #include <sys/select.h>
 132 #endif
 133 #include <netinet/in.h>
 134 #include <netinet/tcp.h>
 135 #include <arpa/inet.h>
 136 #include <netdb.h>
 137 #include <pwd.h>
 138 #include <sys/un.h>
 139 #ifndef NO_INTTYPES_H
 140 #include <inttypes.h>
 141 #else
 142 #include <stdint.h>
 143 #endif
 144 #if defined(__CYGWIN__)
 145 #undef _XOPEN_SOURCE
 146 #include <grp.h>
 147 #define _XOPEN_SOURCE 600
 148 #include "compat/cygwin.h"
 149 #else
 150 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
 151 #include <grp.h>
 152 #define _ALL_SOURCE 1
 153 #endif
 154 #endif
 155
 156 #ifndef NO_LIBGEN_H
 157 #include <libgen.h>
 158 #else
 159 #define basename gitbasename
 160 extern char *gitbasename(char *);
 161 #endif
 162
 163 #ifndef NO_ICONV
 164 #include <iconv.h>
 165 #endif
 166
 167 #ifndef NO_OPENSSL
 168 #include <openssl/ssl.h>
 169 #include <openssl/err.h>
 170 #endif
 171
 172 /* On most systems <limits.h> would have given us this, but
 173  * not on some systems (e.g. GNU/Hurd).
 174  */
 175 #ifndef PATH_MAX
 176 #define PATH_MAX 4096
 177 #endif
 178
 179 #ifndef PRIuMAX
 180 #define PRIuMAX "llu"
 181 #endif
 182
 183 #ifndef PRIu32
 184 #define PRIu32 "u"
 185 #endif
 186
 187 #ifndef PRIx32
 188 #define PRIx32 "x"
 189 #endif
 190
 191 #ifndef PRIo32
 192 #define PRIo32 "o"
 193 #endif
 194
 195 #ifndef PATH_SEP
 196 #define PATH_SEP ':'
 197 #endif
 198
 199 #ifdef HAVE_PATHS_H
 200 #include <paths.h>
 201 #endif
 202 #ifndef _PATH_DEFPATH
 203 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
 204 #endif
 205
 206 #ifndef STRIP_EXTENSION
 207 #define STRIP_EXTENSION ""
 208 #endif
 209
 210 #ifndef has_dos_drive_prefix
 211 #define has_dos_drive_prefix(path) 0
 212 #endif
 213
 214 #ifndef offset_1st_component
 215 #define offset_1st_component(path) (is_dir_sep((path)[0]))
 216 #endif
 217
 218 #ifndef is_dir_sep
 219 #define is_dir_sep(c) ((c) == '/')
 220 #endif
 221
 222 #ifndef find_last_dir_sep
 223 #define find_last_dir_sep(path) strrchr(path, '/')
 224 #endif
 225
 226 #if defined(__HP_cc) && (__HP_cc >= 61000)
 227 #define NORETURN __attribute__((noreturn))
 228 #define NORETURN_PTR
 229 #elif defined(__GNUC__) && !defined(NO_NORETURN)
 230 #define NORETURN __attribute__((__noreturn__))
 231 #define NORETURN_PTR __attribute__((__noreturn__))
 232 #elif defined(_MSC_VER)
 233 #define NORETURN __declspec(noreturn)
 234 #define NORETURN_PTR
 235 #else
 236 #define NORETURN
 237 #define NORETURN_PTR
 238 #ifndef __attribute__
 239 #define __attribute__(x)
 240 #endif
 241 #endif
 242
 243 #include "compat/bswap.h"
 244
 245 /* General helper functions */
 246 extern void vreportf(const char *prefix, const char *err, va_list params);
 247 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
 248 extern NORETURN void usage(const char *err);
 249 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
 250 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
 251 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 252 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 253 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 254
 255 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
 256 extern void set_error_routine(void (*routine)(const char *err, va_list params));
 257
 258 extern int prefixcmp(const char *str, const char *prefix);
 259 extern int suffixcmp(const char *str, const char *suffix);
 260
 261 static inline const char *skip_prefix(const char *str, const char *prefix)
 262 {
 263         size_t len = strlen(prefix);
 264         return strncmp(str, prefix, len) ? NULL : str + len;
 265 }
 266
 267 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
 268
 269 #ifndef PROT_READ
 270 #define PROT_READ 1
 271 #define PROT_WRITE 2
 272 #define MAP_PRIVATE 1
 273 #endif
 274
 275 #define mmap git_mmap
 276 #define munmap git_munmap
 277 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 278 extern int git_munmap(void *start, size_t length);
 279
 280 #else /* NO_MMAP || USE_WIN32_MMAP */
 281
 282 #include <sys/mman.h>
 283
 284 #endif /* NO_MMAP || USE_WIN32_MMAP */
 285
 286 #ifdef NO_MMAP
 287
 288 /* This value must be multiple of (pagesize * 2) */
 289 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 290
 291 #else /* NO_MMAP */
 292
 293 /* This value must be multiple of (pagesize * 2) */
 294 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 295         (sizeof(void*) >= 8 \
 296                 ?  1 * 1024 * 1024 * 1024 \
 297                 : 32 * 1024 * 1024)
 298
 299 #endif /* NO_MMAP */
 300
 301 #ifndef MAP_FAILED
 302 #define MAP_FAILED ((void *)-1)
 303 #endif
 304
 305 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
 306 #define on_disk_bytes(st) ((st).st_size)
 307 #else
 308 #define on_disk_bytes(st) ((st).st_blocks * 512)
 309 #endif
 310
 311 #define DEFAULT_PACKED_GIT_LIMIT \
 312         ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
 313
 314 #ifdef NO_PREAD
 315 #define pread git_pread
 316 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 317 #endif
 318 /*
 319  * Forward decl that will remind us if its twin in cache.h changes.
 320  * This function is used in compat/pread.c.  But we can't include
 321  * cache.h there.
 322  */
 323 extern ssize_t read_in_full(int fd, void *buf, size_t count);
 324
 325 #ifdef NO_SETENV
 326 #define setenv gitsetenv
 327 extern int gitsetenv(const char *, const char *, int);
 328 #endif
 329
 330 #ifdef NO_MKDTEMP
 331 #define mkdtemp gitmkdtemp
 332 extern char *gitmkdtemp(char *);
 333 #endif
 334
 335 #ifdef NO_MKSTEMPS
 336 #define mkstemps gitmkstemps
 337 extern int gitmkstemps(char *, int);
 338 #endif
 339
 340 #ifdef NO_UNSETENV
 341 #define unsetenv gitunsetenv
 342 extern void gitunsetenv(const char *);
 343 #endif
 344
 345 #ifdef NO_STRCASESTR
 346 #define strcasestr gitstrcasestr
 347 extern char *gitstrcasestr(const char *haystack, const char *needle);
 348 #endif
 349
 350 #ifdef NO_STRLCPY
 351 #define strlcpy gitstrlcpy
 352 extern size_t gitstrlcpy(char *, const char *, size_t);
 353 #endif
 354
 355 #ifdef NO_STRTOUMAX
 356 #define strtoumax gitstrtoumax
 357 extern uintmax_t gitstrtoumax(const char *, char **, int);
 358 #define strtoimax gitstrtoimax
 359 extern intmax_t gitstrtoimax(const char *, char **, int);
 360 #endif
 361
 362 #ifdef NO_STRTOK_R
 363 #define strtok_r gitstrtok_r
 364 extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr);
 365 #endif
 366
 367 #ifdef NO_HSTRERROR
 368 #define hstrerror githstrerror
 369 extern const char *githstrerror(int herror);
 370 #endif
 371
 372 #ifdef NO_MEMMEM
 373 #define memmem gitmemmem
 374 void *gitmemmem(const void *haystack, size_t haystacklen,
 375                 const void *needle, size_t needlelen);
 376 #endif
 377
 378 #ifdef FREAD_READS_DIRECTORIES
 379 #ifdef fopen
 380 #undef fopen
 381 #endif
 382 #define fopen(a,b) git_fopen(a,b)
 383 extern FILE *git_fopen(const char*, const char*);
 384 #endif
 385
 386 #ifdef SNPRINTF_RETURNS_BOGUS
 387 #define snprintf git_snprintf
 388 extern int git_snprintf(char *str, size_t maxsize,
 389                         const char *format, ...);
 390 #define vsnprintf git_vsnprintf
 391 extern int git_vsnprintf(char *str, size_t maxsize,
 392                          const char *format, va_list ap);
 393 #endif
 394
 395 #ifdef __GLIBC_PREREQ
 396 #if __GLIBC_PREREQ(2, 1)
 397 #define HAVE_STRCHRNUL
 398 #define HAVE_MEMPCPY
 399 #endif
 400 #endif
 401
 402 #ifndef HAVE_STRCHRNUL
 403 #define strchrnul gitstrchrnul
 404 static inline char *gitstrchrnul(const char *s, int c)
 405 {
 406         while (*s && *s != c)
 407                 s++;
 408         return (char *)s;
 409 }
 410 #endif
 411
 412 #ifndef HAVE_MEMPCPY
 413 #define mempcpy gitmempcpy
 414 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
 415 {
 416         return (char *)memcpy(dest, src, n) + n;
 417 }
 418 #endif
 419
 420 #ifdef NO_INET_PTON
 421 int inet_pton(int af, const char *src, void *dst);
 422 #endif
 423
 424 #ifdef NO_INET_NTOP
 425 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
 426 #endif
 427
 428 extern void release_pack_memory(size_t, int);
 429
 430 typedef void (*try_to_free_t)(size_t);
 431 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
 432
 433 extern char *xstrdup(const char *str);
 434 extern void *xmalloc(size_t size);
 435 extern void *xmallocz(size_t size);
 436 extern void *xmemdupz(const void *data, size_t len);
 437 extern char *xstrndup(const char *str, size_t len);
 438 extern void *xrealloc(void *ptr, size_t size);
 439 extern void *xcalloc(size_t nmemb, size_t size);
 440 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 441 extern ssize_t xread(int fd, void *buf, size_t len);
 442 extern ssize_t xwrite(int fd, const void *buf, size_t len);
 443 extern int xdup(int fd);
 444 extern FILE *xfdopen(int fd, const char *mode);
 445 extern int xmkstemp(char *template);
 446 extern int xmkstemp_mode(char *template, int mode);
 447 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
 448 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
 449
 450 static inline size_t xsize_t(off_t len)
 451 {
 452         if (len > (size_t) len)
 453                 die("Cannot handle files this big");
 454         return (size_t)len;
 455 }
 456
 457 static inline int has_extension(const char *filename, const char *ext)
 458 {
 459         size_t len = strlen(filename);
 460         size_t extlen = strlen(ext);
 461         return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 462 }
 463
 464 /* Sane ctype - no locale, and works with signed chars */
 465 #undef isascii
 466 #undef isspace
 467 #undef isdigit
 468 #undef isalpha
 469 #undef isalnum
 470 #undef tolower
 471 #undef toupper
 472 extern unsigned char sane_ctype[256];
 473 #define GIT_SPACE 0x01
 474 #define GIT_DIGIT 0x02
 475 #define GIT_ALPHA 0x04
 476 #define GIT_GLOB_SPECIAL 0x08
 477 #define GIT_REGEX_SPECIAL 0x10
 478 #define GIT_PATHSPEC_MAGIC 0x20
 479 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 480 #define isascii(x) (((x) & ~0x7f) == 0)
 481 #define isspace(x) sane_istest(x,GIT_SPACE)
 482 #define isdigit(x) sane_istest(x,GIT_DIGIT)
 483 #define isalpha(x) sane_istest(x,GIT_ALPHA)
 484 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 485 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
 486 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
 487 #define tolower(x) sane_case((unsigned char)(x), 0x20)
 488 #define toupper(x) sane_case((unsigned char)(x), 0)
 489 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
 490
 491 static inline int sane_case(int x, int high)
 492 {
 493         if (sane_istest(x, GIT_ALPHA))
 494                 x = (x & ~0x20) | high;
 495         return x;
 496 }
 497
 498 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 499 {
 500         unsigned long ul;
 501         char *p;
 502
 503         errno = 0;
 504         ul = strtoul(s, &p, base);
 505         if (errno || *p || p == s || (unsigned int) ul != ul)
 506                 return -1;
 507         *result = ul;
 508         return 0;
 509 }
 510
 511 static inline int strtol_i(char const *s, int base, int *result)
 512 {
 513         long ul;
 514         char *p;
 515
 516         errno = 0;
 517         ul = strtol(s, &p, base);
 518         if (errno || *p || p == s || (int) ul != ul)
 519                 return -1;
 520         *result = ul;
 521         return 0;
 522 }
 523
 524 #ifdef INTERNAL_QSORT
 525 void git_qsort(void *base, size_t nmemb, size_t size,
 526                int(*compar)(const void *, const void *));
 527 #define qsort git_qsort
 528 #endif
 529
 530 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
 531 # define FORCE_DIR_SET_GID S_ISGID
 532 #else
 533 # define FORCE_DIR_SET_GID 0
 534 #endif
 535
 536 #ifdef NO_NSEC
 537 #undef USE_NSEC
 538 #define ST_CTIME_NSEC(st) 0
 539 #define ST_MTIME_NSEC(st) 0
 540 #else
 541 #ifdef USE_ST_TIMESPEC
 542 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
 543 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
 544 #else
 545 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
 546 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
 547 #endif
 548 #endif
 549
 550 #ifdef UNRELIABLE_FSTAT
 551 #define fstat_is_reliable() 0
 552 #else
 553 #define fstat_is_reliable() 1
 554 #endif
 555
 556 #ifndef va_copy
 557 /*
 558  * Since an obvious implementation of va_list would be to make it a
 559  * pointer into the stack frame, a simple assignment will work on
 560  * many systems.  But let's try to be more portable.
 561  */
 562 #ifdef __va_copy
 563 #define va_copy(dst, src) __va_copy(dst, src)
 564 #else
 565 #define va_copy(dst, src) ((dst) = (src))
 566 #endif
 567 #endif
 568
 569 /*
 570  * Preserves errno, prints a message, but gives no warning for ENOENT.
 571  * Always returns the return value of unlink(2).
 572  */
 573 int unlink_or_warn(const char *path);
 574 /*
 575  * Likewise for rmdir(2).
 576  */
 577 int rmdir_or_warn(const char *path);
 578 /*
 579  * Calls the correct function out of {unlink,rmdir}_or_warn based on
 580  * the supplied file mode.
 581  */
 582 int remove_or_warn(unsigned int mode, const char *path);
 583
 584 #ifndef mark_as_git_dir
 585 #define mark_as_git_dir(x) /* noop */
 586 #endif
 587
 588 #ifndef get_home_directory
 589 #define get_home_directory() getenv("HOME")
 590 #endif
 591
 592 #endif