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