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