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