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