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