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