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