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