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