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