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