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