Andrew's git - gitweb.git/blob

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