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