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