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)
  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
  30 #ifdef __GNUC__
  31 #define TYPEOF(x) (__typeof__(x))
  32 #else
  33 #define TYPEOF(x)
  34 #endif
  35
  36 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
  37 #define HAS_MULTI_BITS(i)  ((i) & ((i) - 1))  /* checks if an integer has more than 1 bit set */
  38
  39 /* Approximation of the length of the decimal representation of this type. */
  40 #define decimal_length(x)       ((int)(sizeof(x) * 2.56 + 0.5) + 1)
  41
  42 #if !defined(__APPLE__) && !defined(__FreeBSD__)  && !defined(__USLC__) && !defined(_M_UNIX)
  43 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
  44 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
  45 #endif
  46 #define _ALL_SOURCE 1
  47 #define _GNU_SOURCE 1
  48 #define _BSD_SOURCE 1
  49
  50 #include <unistd.h>
  51 #include <stdio.h>
  52 #include <sys/stat.h>
  53 #include <fcntl.h>
  54 #include <stddef.h>
  55 #include <stdlib.h>
  56 #include <stdarg.h>
  57 #include <string.h>
  58 #include <errno.h>
  59 #include <limits.h>
  60 #include <sys/param.h>
  61 #include <sys/types.h>
  62 #include <dirent.h>
  63 #include <sys/time.h>
  64 #include <time.h>
  65 #include <signal.h>
  66 #include <fnmatch.h>
  67 #include <assert.h>
  68 #include <regex.h>
  69 #include <utime.h>
  70 #ifndef __MINGW32__
  71 #include <sys/wait.h>
  72 #include <sys/poll.h>
  73 #include <sys/socket.h>
  74 #include <sys/ioctl.h>
  75 #ifndef NO_SYS_SELECT_H
  76 #include <sys/select.h>
  77 #endif
  78 #include <netinet/in.h>
  79 #include <netinet/tcp.h>
  80 #include <arpa/inet.h>
  81 #include <netdb.h>
  82 #include <pwd.h>
  83 #include <inttypes.h>
  84 #if defined(__CYGWIN__)
  85 #undef _XOPEN_SOURCE
  86 #include <grp.h>
  87 #define _XOPEN_SOURCE 600
  88 #else
  89 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
  90 #include <grp.h>
  91 #define _ALL_SOURCE 1
  92 #endif
  93 #else   /* __MINGW32__ */
  94 /* pull in Windows compatibility stuff */
  95 #include "compat/mingw.h"
  96 #endif  /* __MINGW32__ */
  97
  98 #ifndef NO_ICONV
  99 #include <iconv.h>
 100 #endif
 101
 102 /* On most systems <limits.h> would have given us this, but
 103  * not on some systems (e.g. GNU/Hurd).
 104  */
 105 #ifndef PATH_MAX
 106 #define PATH_MAX 4096
 107 #endif
 108
 109 #ifndef PRIuMAX
 110 #define PRIuMAX "llu"
 111 #endif
 112
 113 #ifndef PATH_SEP
 114 #define PATH_SEP ':'
 115 #endif
 116
 117 #ifndef has_dos_drive_prefix
 118 #define has_dos_drive_prefix(path) 0
 119 #endif
 120
 121 #ifndef is_dir_sep
 122 #define is_dir_sep(c) ((c) == '/')
 123 #endif
 124
 125 #ifdef __GNUC__
 126 #define NORETURN __attribute__((__noreturn__))
 127 #else
 128 #define NORETURN
 129 #ifndef __attribute__
 130 #define __attribute__(x)
 131 #endif
 132 #endif
 133
 134 /* General helper functions */
 135 extern void usage(const char *err) NORETURN;
 136 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
 137 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 138 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 139
 140 extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
 141 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
 142 extern void set_error_routine(void (*routine)(const char *err, va_list params));
 143 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
 144
 145 extern int prefixcmp(const char *str, const char *prefix);
 146
 147 #ifdef NO_MMAP
 148
 149 #ifndef PROT_READ
 150 #define PROT_READ 1
 151 #define PROT_WRITE 2
 152 #define MAP_PRIVATE 1
 153 #define MAP_FAILED ((void*)-1)
 154 #endif
 155
 156 #define mmap git_mmap
 157 #define munmap git_munmap
 158 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 159 extern int git_munmap(void *start, size_t length);
 160
 161 /* This value must be multiple of (pagesize * 2) */
 162 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 163
 164 #else /* NO_MMAP */
 165
 166 #include <sys/mman.h>
 167
 168 /* This value must be multiple of (pagesize * 2) */
 169 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 170         (sizeof(void*) >= 8 \
 171                 ?  1 * 1024 * 1024 * 1024 \
 172                 : 32 * 1024 * 1024)
 173
 174 #endif /* NO_MMAP */
 175
 176 #define DEFAULT_PACKED_GIT_LIMIT \
 177         ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
 178
 179 #ifdef NO_PREAD
 180 #define pread git_pread
 181 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 182 #endif
 183 /*
 184  * Forward decl that will remind us if its twin in cache.h changes.
 185  * This function is used in compat/pread.c.  But we can't include
 186  * cache.h there.
 187  */
 188 extern ssize_t read_in_full(int fd, void *buf, size_t count);
 189
 190 #ifdef NO_SETENV
 191 #define setenv gitsetenv
 192 extern int gitsetenv(const char *, const char *, int);
 193 #endif
 194
 195 #ifdef NO_MKDTEMP
 196 #define mkdtemp gitmkdtemp
 197 extern char *gitmkdtemp(char *);
 198 #endif
 199
 200 #ifdef NO_UNSETENV
 201 #define unsetenv gitunsetenv
 202 extern void gitunsetenv(const char *);
 203 #endif
 204
 205 #ifdef NO_STRCASESTR
 206 #define strcasestr gitstrcasestr
 207 extern char *gitstrcasestr(const char *haystack, const char *needle);
 208 #endif
 209
 210 #ifdef NO_STRLCPY
 211 #define strlcpy gitstrlcpy
 212 extern size_t gitstrlcpy(char *, const char *, size_t);
 213 #endif
 214
 215 #ifdef NO_STRTOUMAX
 216 #define strtoumax gitstrtoumax
 217 extern uintmax_t gitstrtoumax(const char *, char **, int);
 218 #endif
 219
 220 #ifdef NO_HSTRERROR
 221 #define hstrerror githstrerror
 222 extern const char *githstrerror(int herror);
 223 #endif
 224
 225 #ifdef NO_MEMMEM
 226 #define memmem gitmemmem
 227 void *gitmemmem(const void *haystack, size_t haystacklen,
 228                 const void *needle, size_t needlelen);
 229 #endif
 230
 231 #ifdef FREAD_READS_DIRECTORIES
 232 #ifdef fopen
 233 #undef fopen
 234 #endif
 235 #define fopen(a,b) git_fopen(a,b)
 236 extern FILE *git_fopen(const char*, const char*);
 237 #endif
 238
 239 #ifdef SNPRINTF_RETURNS_BOGUS
 240 #define snprintf git_snprintf
 241 extern int git_snprintf(char *str, size_t maxsize,
 242                         const char *format, ...);
 243 #define vsnprintf git_vsnprintf
 244 extern int git_vsnprintf(char *str, size_t maxsize,
 245                          const char *format, va_list ap);
 246 #endif
 247
 248 #ifdef __GLIBC_PREREQ
 249 #if __GLIBC_PREREQ(2, 1)
 250 #define HAVE_STRCHRNUL
 251 #endif
 252 #endif
 253
 254 #ifndef HAVE_STRCHRNUL
 255 #define strchrnul gitstrchrnul
 256 static inline char *gitstrchrnul(const char *s, int c)
 257 {
 258         while (*s && *s != c)
 259                 s++;
 260         return (char *)s;
 261 }
 262 #endif
 263
 264 extern void release_pack_memory(size_t, int);
 265
 266 static inline char* xstrdup(const char *str)
 267 {
 268         char *ret = strdup(str);
 269         if (!ret) {
 270                 release_pack_memory(strlen(str) + 1, -1);
 271                 ret = strdup(str);
 272                 if (!ret)
 273                         die("Out of memory, strdup failed");
 274         }
 275         return ret;
 276 }
 277
 278 static inline void *xmalloc(size_t size)
 279 {
 280         void *ret = malloc(size);
 281         if (!ret && !size)
 282                 ret = malloc(1);
 283         if (!ret) {
 284                 release_pack_memory(size, -1);
 285                 ret = malloc(size);
 286                 if (!ret && !size)
 287                         ret = malloc(1);
 288                 if (!ret)
 289                         die("Out of memory, malloc failed");
 290         }
 291 #ifdef XMALLOC_POISON
 292         memset(ret, 0xA5, size);
 293 #endif
 294         return ret;
 295 }
 296
 297 /*
 298  * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
 299  * "data" to the allocated memory, zero terminates the allocated memory,
 300  * and returns a pointer to the allocated memory. If the allocation fails,
 301  * the program dies.
 302  */
 303 static inline void *xmemdupz(const void *data, size_t len)
 304 {
 305         char *p = xmalloc(len + 1);
 306         memcpy(p, data, len);
 307         p[len] = '\0';
 308         return p;
 309 }
 310
 311 static inline char *xstrndup(const char *str, size_t len)
 312 {
 313         char *p = memchr(str, '\0', len);
 314         return xmemdupz(str, p ? p - str : len);
 315 }
 316
 317 static inline void *xrealloc(void *ptr, size_t size)
 318 {
 319         void *ret = realloc(ptr, size);
 320         if (!ret && !size)
 321                 ret = realloc(ptr, 1);
 322         if (!ret) {
 323                 release_pack_memory(size, -1);
 324                 ret = realloc(ptr, size);
 325                 if (!ret && !size)
 326                         ret = realloc(ptr, 1);
 327                 if (!ret)
 328                         die("Out of memory, realloc failed");
 329         }
 330         return ret;
 331 }
 332
 333 static inline void *xcalloc(size_t nmemb, size_t size)
 334 {
 335         void *ret = calloc(nmemb, size);
 336         if (!ret && (!nmemb || !size))
 337                 ret = calloc(1, 1);
 338         if (!ret) {
 339                 release_pack_memory(nmemb * size, -1);
 340                 ret = calloc(nmemb, size);
 341                 if (!ret && (!nmemb || !size))
 342                         ret = calloc(1, 1);
 343                 if (!ret)
 344                         die("Out of memory, calloc failed");
 345         }
 346         return ret;
 347 }
 348
 349 static inline void *xmmap(void *start, size_t length,
 350         int prot, int flags, int fd, off_t offset)
 351 {
 352         void *ret = mmap(start, length, prot, flags, fd, offset);
 353         if (ret == MAP_FAILED) {
 354                 if (!length)
 355                         return NULL;
 356                 release_pack_memory(length, fd);
 357                 ret = mmap(start, length, prot, flags, fd, offset);
 358                 if (ret == MAP_FAILED)
 359                         die("Out of memory? mmap failed: %s", strerror(errno));
 360         }
 361         return ret;
 362 }
 363
 364 /*
 365  * xread() is the same a read(), but it automatically restarts read()
 366  * operations with a recoverable error (EAGAIN and EINTR). xread()
 367  * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
 368  */
 369 static inline ssize_t xread(int fd, void *buf, size_t len)
 370 {
 371         ssize_t nr;
 372         while (1) {
 373                 nr = read(fd, buf, len);
 374                 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
 375                         continue;
 376                 return nr;
 377         }
 378 }
 379
 380 /*
 381  * xwrite() is the same a write(), but it automatically restarts write()
 382  * operations with a recoverable error (EAGAIN and EINTR). xwrite() DOES NOT
 383  * GUARANTEE that "len" bytes is written even if the operation is successful.
 384  */
 385 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
 386 {
 387         ssize_t nr;
 388         while (1) {
 389                 nr = write(fd, buf, len);
 390                 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
 391                         continue;
 392                 return nr;
 393         }
 394 }
 395
 396 static inline int xdup(int fd)
 397 {
 398         int ret = dup(fd);
 399         if (ret < 0)
 400                 die("dup failed: %s", strerror(errno));
 401         return ret;
 402 }
 403
 404 static inline FILE *xfdopen(int fd, const char *mode)
 405 {
 406         FILE *stream = fdopen(fd, mode);
 407         if (stream == NULL)
 408                 die("Out of memory? fdopen failed: %s", strerror(errno));
 409         return stream;
 410 }
 411
 412 static inline int xmkstemp(char *template)
 413 {
 414         int fd;
 415
 416         fd = mkstemp(template);
 417         if (fd < 0)
 418                 die("Unable to create temporary file: %s", strerror(errno));
 419         return fd;
 420 }
 421
 422 static inline size_t xsize_t(off_t len)
 423 {
 424         return (size_t)len;
 425 }
 426
 427 static inline int has_extension(const char *filename, const char *ext)
 428 {
 429         size_t len = strlen(filename);
 430         size_t extlen = strlen(ext);
 431         return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 432 }
 433
 434 /* Sane ctype - no locale, and works with signed chars */
 435 #undef isspace
 436 #undef isdigit
 437 #undef isalpha
 438 #undef isalnum
 439 #undef tolower
 440 #undef toupper
 441 extern unsigned char sane_ctype[256];
 442 #define GIT_SPACE 0x01
 443 #define GIT_DIGIT 0x02
 444 #define GIT_ALPHA 0x04
 445 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 446 #define isspace(x) sane_istest(x,GIT_SPACE)
 447 #define isdigit(x) sane_istest(x,GIT_DIGIT)
 448 #define isalpha(x) sane_istest(x,GIT_ALPHA)
 449 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 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 #endif