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