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__)
  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 #define fopen(a,b) git_fopen(a,b)
 233 extern FILE *git_fopen(const char*, const char*);
 234 #endif
 235
 236 #ifdef SNPRINTF_RETURNS_BOGUS
 237 #define snprintf git_snprintf
 238 extern int git_snprintf(char *str, size_t maxsize,
 239                         const char *format, ...);
 240 #define vsnprintf git_vsnprintf
 241 extern int git_vsnprintf(char *str, size_t maxsize,
 242                          const char *format, va_list ap);
 243 #endif
 244
 245 #ifdef __GLIBC_PREREQ
 246 #if __GLIBC_PREREQ(2, 1)
 247 #define HAVE_STRCHRNUL
 248 #endif
 249 #endif
 250
 251 #ifndef HAVE_STRCHRNUL
 252 #define strchrnul gitstrchrnul
 253 static inline char *gitstrchrnul(const char *s, int c)
 254 {
 255         while (*s && *s != c)
 256                 s++;
 257         return (char *)s;
 258 }
 259 #endif
 260
 261 extern void release_pack_memory(size_t, int);
 262
 263 static inline char* xstrdup(const char *str)
 264 {
 265         char *ret = strdup(str);
 266         if (!ret) {
 267                 release_pack_memory(strlen(str) + 1, -1);
 268                 ret = strdup(str);
 269                 if (!ret)
 270                         die("Out of memory, strdup failed");
 271         }
 272         return ret;
 273 }
 274
 275 static inline void *xmalloc(size_t size)
 276 {
 277         void *ret = malloc(size);
 278         if (!ret && !size)
 279                 ret = malloc(1);
 280         if (!ret) {
 281                 release_pack_memory(size, -1);
 282                 ret = malloc(size);
 283                 if (!ret && !size)
 284                         ret = malloc(1);
 285                 if (!ret)
 286                         die("Out of memory, malloc failed");
 287         }
 288 #ifdef XMALLOC_POISON
 289         memset(ret, 0xA5, size);
 290 #endif
 291         return ret;
 292 }
 293
 294 /*
 295  * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
 296  * "data" to the allocated memory, zero terminates the allocated memory,
 297  * and returns a pointer to the allocated memory. If the allocation fails,
 298  * the program dies.
 299  */
 300 static inline void *xmemdupz(const void *data, size_t len)
 301 {
 302         char *p = xmalloc(len + 1);
 303         memcpy(p, data, len);
 304         p[len] = '\0';
 305         return p;
 306 }
 307
 308 static inline char *xstrndup(const char *str, size_t len)
 309 {
 310         char *p = memchr(str, '\0', len);
 311         return xmemdupz(str, p ? p - str : len);
 312 }
 313
 314 static inline void *xrealloc(void *ptr, size_t size)
 315 {
 316         void *ret = realloc(ptr, size);
 317         if (!ret && !size)
 318                 ret = realloc(ptr, 1);
 319         if (!ret) {
 320                 release_pack_memory(size, -1);
 321                 ret = realloc(ptr, size);
 322                 if (!ret && !size)
 323                         ret = realloc(ptr, 1);
 324                 if (!ret)
 325                         die("Out of memory, realloc failed");
 326         }
 327         return ret;
 328 }
 329
 330 static inline void *xcalloc(size_t nmemb, size_t size)
 331 {
 332         void *ret = calloc(nmemb, size);
 333         if (!ret && (!nmemb || !size))
 334                 ret = calloc(1, 1);
 335         if (!ret) {
 336                 release_pack_memory(nmemb * size, -1);
 337                 ret = calloc(nmemb, size);
 338                 if (!ret && (!nmemb || !size))
 339                         ret = calloc(1, 1);
 340                 if (!ret)
 341                         die("Out of memory, calloc failed");
 342         }
 343         return ret;
 344 }
 345
 346 static inline void *xmmap(void *start, size_t length,
 347         int prot, int flags, int fd, off_t offset)
 348 {
 349         void *ret = mmap(start, length, prot, flags, fd, offset);
 350         if (ret == MAP_FAILED) {
 351                 if (!length)
 352                         return NULL;
 353                 release_pack_memory(length, fd);
 354                 ret = mmap(start, length, prot, flags, fd, offset);
 355                 if (ret == MAP_FAILED)
 356                         die("Out of memory? mmap failed: %s", strerror(errno));
 357         }
 358         return ret;
 359 }
 360
 361 /*
 362  * xread() is the same a read(), but it automatically restarts read()
 363  * operations with a recoverable error (EAGAIN and EINTR). xread()
 364  * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
 365  */
 366 static inline ssize_t xread(int fd, void *buf, size_t len)
 367 {
 368         ssize_t nr;
 369         while (1) {
 370                 nr = read(fd, buf, len);
 371                 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
 372                         continue;
 373                 return nr;
 374         }
 375 }
 376
 377 /*
 378  * xwrite() is the same a write(), but it automatically restarts write()
 379  * operations with a recoverable error (EAGAIN and EINTR). xwrite() DOES NOT
 380  * GUARANTEE that "len" bytes is written even if the operation is successful.
 381  */
 382 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
 383 {
 384         ssize_t nr;
 385         while (1) {
 386                 nr = write(fd, buf, len);
 387                 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
 388                         continue;
 389                 return nr;
 390         }
 391 }
 392
 393 static inline int xdup(int fd)
 394 {
 395         int ret = dup(fd);
 396         if (ret < 0)
 397                 die("dup failed: %s", strerror(errno));
 398         return ret;
 399 }
 400
 401 static inline FILE *xfdopen(int fd, const char *mode)
 402 {
 403         FILE *stream = fdopen(fd, mode);
 404         if (stream == NULL)
 405                 die("Out of memory? fdopen failed: %s", strerror(errno));
 406         return stream;
 407 }
 408
 409 static inline int xmkstemp(char *template)
 410 {
 411         int fd;
 412
 413         fd = mkstemp(template);
 414         if (fd < 0)
 415                 die("Unable to create temporary file: %s", strerror(errno));
 416         return fd;
 417 }
 418
 419 static inline size_t xsize_t(off_t len)
 420 {
 421         return (size_t)len;
 422 }
 423
 424 static inline int has_extension(const char *filename, const char *ext)
 425 {
 426         size_t len = strlen(filename);
 427         size_t extlen = strlen(ext);
 428         return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 429 }
 430
 431 /* Sane ctype - no locale, and works with signed chars */
 432 #undef isspace
 433 #undef isdigit
 434 #undef isalpha
 435 #undef isalnum
 436 #undef tolower
 437 #undef toupper
 438 extern unsigned char sane_ctype[256];
 439 #define GIT_SPACE 0x01
 440 #define GIT_DIGIT 0x02
 441 #define GIT_ALPHA 0x04
 442 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 443 #define isspace(x) sane_istest(x,GIT_SPACE)
 444 #define isdigit(x) sane_istest(x,GIT_DIGIT)
 445 #define isalpha(x) sane_istest(x,GIT_ALPHA)
 446 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 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 #endif