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