git-compat-util.hon commit Merge branch 'maint' (fe61935)
   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 */
  98extern void usage(const char *err) NORETURN;
  99extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
 100extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 101extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 102
 103extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
 104extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
 105extern void set_error_routine(void (*routine)(const char *err, va_list params));
 106extern 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
 119extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 120extern 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
 142extern 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
 147extern int gitsetenv(const char *, const char *, int);
 148#endif
 149
 150#ifdef NO_MKDTEMP
 151#define mkdtemp gitmkdtemp
 152extern char *gitmkdtemp(char *);
 153#endif
 154
 155#ifdef NO_UNSETENV
 156#define unsetenv gitunsetenv
 157extern void gitunsetenv(const char *);
 158#endif
 159
 160#ifdef NO_STRCASESTR
 161#define strcasestr gitstrcasestr
 162extern char *gitstrcasestr(const char *haystack, const char *needle);
 163#endif
 164
 165#ifdef NO_STRLCPY
 166#define strlcpy gitstrlcpy
 167extern size_t gitstrlcpy(char *, const char *, size_t);
 168#endif
 169
 170#ifdef NO_STRTOUMAX
 171#define strtoumax gitstrtoumax
 172extern uintmax_t gitstrtoumax(const char *, char **, int);
 173#endif
 174
 175#ifdef NO_HSTRERROR
 176#define hstrerror githstrerror
 177extern const char *githstrerror(int herror);
 178#endif
 179
 180#ifdef NO_MEMMEM
 181#define memmem gitmemmem
 182void *gitmemmem(const void *haystack, size_t haystacklen,
 183                const void *needle, size_t needlelen);
 184#endif
 185
 186extern void release_pack_memory(size_t, int);
 187
 188static inline char* xstrdup(const char *str)
 189{
 190        char *ret = strdup(str);
 191        if (!ret) {
 192                release_pack_memory(strlen(str) + 1, -1);
 193                ret = strdup(str);
 194                if (!ret)
 195                        die("Out of memory, strdup failed");
 196        }
 197        return ret;
 198}
 199
 200static inline void *xmalloc(size_t size)
 201{
 202        void *ret = malloc(size);
 203        if (!ret && !size)
 204                ret = malloc(1);
 205        if (!ret) {
 206                release_pack_memory(size, -1);
 207                ret = malloc(size);
 208                if (!ret && !size)
 209                        ret = malloc(1);
 210                if (!ret)
 211                        die("Out of memory, malloc failed");
 212        }
 213#ifdef XMALLOC_POISON
 214        memset(ret, 0xA5, size);
 215#endif
 216        return ret;
 217}
 218
 219static inline void *xmemdupz(const void *data, size_t len)
 220{
 221        char *p = xmalloc(len + 1);
 222        memcpy(p, data, len);
 223        p[len] = '\0';
 224        return p;
 225}
 226
 227static inline char *xstrndup(const char *str, size_t len)
 228{
 229        char *p = memchr(str, '\0', len);
 230        return xmemdupz(str, p ? p - str : len);
 231}
 232
 233static inline void *xrealloc(void *ptr, size_t size)
 234{
 235        void *ret = realloc(ptr, size);
 236        if (!ret && !size)
 237                ret = realloc(ptr, 1);
 238        if (!ret) {
 239                release_pack_memory(size, -1);
 240                ret = realloc(ptr, size);
 241                if (!ret && !size)
 242                        ret = realloc(ptr, 1);
 243                if (!ret)
 244                        die("Out of memory, realloc failed");
 245        }
 246        return ret;
 247}
 248
 249static inline void *xcalloc(size_t nmemb, size_t size)
 250{
 251        void *ret = calloc(nmemb, size);
 252        if (!ret && (!nmemb || !size))
 253                ret = calloc(1, 1);
 254        if (!ret) {
 255                release_pack_memory(nmemb * size, -1);
 256                ret = calloc(nmemb, size);
 257                if (!ret && (!nmemb || !size))
 258                        ret = calloc(1, 1);
 259                if (!ret)
 260                        die("Out of memory, calloc failed");
 261        }
 262        return ret;
 263}
 264
 265static inline void *xmmap(void *start, size_t length,
 266        int prot, int flags, int fd, off_t offset)
 267{
 268        void *ret = mmap(start, length, prot, flags, fd, offset);
 269        if (ret == MAP_FAILED) {
 270                if (!length)
 271                        return NULL;
 272                release_pack_memory(length, fd);
 273                ret = mmap(start, length, prot, flags, fd, offset);
 274                if (ret == MAP_FAILED)
 275                        die("Out of memory? mmap failed: %s", strerror(errno));
 276        }
 277        return ret;
 278}
 279
 280static inline ssize_t xread(int fd, void *buf, size_t len)
 281{
 282        ssize_t nr;
 283        while (1) {
 284                nr = read(fd, buf, len);
 285                if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
 286                        continue;
 287                return nr;
 288        }
 289}
 290
 291static inline ssize_t xwrite(int fd, const void *buf, size_t len)
 292{
 293        ssize_t nr;
 294        while (1) {
 295                nr = write(fd, buf, len);
 296                if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
 297                        continue;
 298                return nr;
 299        }
 300}
 301
 302static inline int xdup(int fd)
 303{
 304        int ret = dup(fd);
 305        if (ret < 0)
 306                die("dup failed: %s", strerror(errno));
 307        return ret;
 308}
 309
 310static inline FILE *xfdopen(int fd, const char *mode)
 311{
 312        FILE *stream = fdopen(fd, mode);
 313        if (stream == NULL)
 314                die("Out of memory? fdopen failed: %s", strerror(errno));
 315        return stream;
 316}
 317
 318static inline int xmkstemp(char *template)
 319{
 320        int fd;
 321
 322        fd = mkstemp(template);
 323        if (fd < 0)
 324                die("Unable to create temporary file: %s", strerror(errno));
 325        return fd;
 326}
 327
 328static inline size_t xsize_t(off_t len)
 329{
 330        return (size_t)len;
 331}
 332
 333static inline int has_extension(const char *filename, const char *ext)
 334{
 335        size_t len = strlen(filename);
 336        size_t extlen = strlen(ext);
 337        return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 338}
 339
 340/* Sane ctype - no locale, and works with signed chars */
 341#undef isspace
 342#undef isdigit
 343#undef isalpha
 344#undef isalnum
 345#undef tolower
 346#undef toupper
 347extern unsigned char sane_ctype[256];
 348#define GIT_SPACE 0x01
 349#define GIT_DIGIT 0x02
 350#define GIT_ALPHA 0x04
 351#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 352#define isspace(x) sane_istest(x,GIT_SPACE)
 353#define isdigit(x) sane_istest(x,GIT_DIGIT)
 354#define isalpha(x) sane_istest(x,GIT_ALPHA)
 355#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 356#define tolower(x) sane_case((unsigned char)(x), 0x20)
 357#define toupper(x) sane_case((unsigned char)(x), 0)
 358
 359static inline int sane_case(int x, int high)
 360{
 361        if (sane_istest(x, GIT_ALPHA))
 362                x = (x & ~0x20) | high;
 363        return x;
 364}
 365
 366static inline int prefixcmp(const char *str, const char *prefix)
 367{
 368        return strncmp(str, prefix, strlen(prefix));
 369}
 370
 371static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 372{
 373        unsigned long ul;
 374        char *p;
 375
 376        errno = 0;
 377        ul = strtoul(s, &p, base);
 378        if (errno || *p || p == s || (unsigned int) ul != ul)
 379                return -1;
 380        *result = ul;
 381        return 0;
 382}
 383
 384static inline int strtol_i(char const *s, int base, int *result)
 385{
 386        long ul;
 387        char *p;
 388
 389        errno = 0;
 390        ul = strtol(s, &p, base);
 391        if (errno || *p || p == s || (int) ul != ul)
 392                return -1;
 393        *result = ul;
 394        return 0;
 395}
 396
 397#endif