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 * Forward decl that will remind us if its twin in cache.h changes.
 190 * This function is used in compat/pread.c.  But we can't include
 191 * cache.h there.
 192 */
 193extern ssize_t read_in_full(int fd, void *buf, size_t count);
 194
 195#ifdef NO_SETENV
 196#define setenv gitsetenv
 197extern int gitsetenv(const char *, const char *, int);
 198#endif
 199
 200#ifdef NO_MKDTEMP
 201#define mkdtemp gitmkdtemp
 202extern char *gitmkdtemp(char *);
 203#endif
 204
 205#ifdef NO_UNSETENV
 206#define unsetenv gitunsetenv
 207extern void gitunsetenv(const char *);
 208#endif
 209
 210#ifdef NO_STRCASESTR
 211#define strcasestr gitstrcasestr
 212extern char *gitstrcasestr(const char *haystack, const char *needle);
 213#endif
 214
 215#ifdef NO_STRLCPY
 216#define strlcpy gitstrlcpy
 217extern size_t gitstrlcpy(char *, const char *, size_t);
 218#endif
 219
 220#ifdef NO_STRTOUMAX
 221#define strtoumax gitstrtoumax
 222extern uintmax_t gitstrtoumax(const char *, char **, int);
 223#endif
 224
 225#ifdef NO_HSTRERROR
 226#define hstrerror githstrerror
 227extern const char *githstrerror(int herror);
 228#endif
 229
 230#ifdef NO_MEMMEM
 231#define memmem gitmemmem
 232void *gitmemmem(const void *haystack, size_t haystacklen,
 233                const void *needle, size_t needlelen);
 234#endif
 235
 236#ifdef FREAD_READS_DIRECTORIES
 237#ifdef fopen
 238#undef fopen
 239#endif
 240#define fopen(a,b) git_fopen(a,b)
 241extern FILE *git_fopen(const char*, const char*);
 242#endif
 243
 244#ifdef SNPRINTF_RETURNS_BOGUS
 245#define snprintf git_snprintf
 246extern int git_snprintf(char *str, size_t maxsize,
 247                        const char *format, ...);
 248#define vsnprintf git_vsnprintf
 249extern int git_vsnprintf(char *str, size_t maxsize,
 250                         const char *format, va_list ap);
 251#endif
 252
 253#ifdef __GLIBC_PREREQ
 254#if __GLIBC_PREREQ(2, 1)
 255#define HAVE_STRCHRNUL
 256#endif
 257#endif
 258
 259#ifndef HAVE_STRCHRNUL
 260#define strchrnul gitstrchrnul
 261static inline char *gitstrchrnul(const char *s, int c)
 262{
 263        while (*s && *s != c)
 264                s++;
 265        return (char *)s;
 266}
 267#endif
 268
 269extern void release_pack_memory(size_t, int);
 270
 271static inline char* xstrdup(const char *str)
 272{
 273        char *ret = strdup(str);
 274        if (!ret) {
 275                release_pack_memory(strlen(str) + 1, -1);
 276                ret = strdup(str);
 277                if (!ret)
 278                        die("Out of memory, strdup failed");
 279        }
 280        return ret;
 281}
 282
 283static inline void *xmalloc(size_t size)
 284{
 285        void *ret = malloc(size);
 286        if (!ret && !size)
 287                ret = malloc(1);
 288        if (!ret) {
 289                release_pack_memory(size, -1);
 290                ret = malloc(size);
 291                if (!ret && !size)
 292                        ret = malloc(1);
 293                if (!ret)
 294                        die("Out of memory, malloc failed");
 295        }
 296#ifdef XMALLOC_POISON
 297        memset(ret, 0xA5, size);
 298#endif
 299        return ret;
 300}
 301
 302/*
 303 * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
 304 * "data" to the allocated memory, zero terminates the allocated memory,
 305 * and returns a pointer to the allocated memory. If the allocation fails,
 306 * the program dies.
 307 */
 308static inline void *xmemdupz(const void *data, size_t len)
 309{
 310        char *p = xmalloc(len + 1);
 311        memcpy(p, data, len);
 312        p[len] = '\0';
 313        return p;
 314}
 315
 316static inline char *xstrndup(const char *str, size_t len)
 317{
 318        char *p = memchr(str, '\0', len);
 319        return xmemdupz(str, p ? p - str : len);
 320}
 321
 322static inline void *xrealloc(void *ptr, size_t size)
 323{
 324        void *ret = realloc(ptr, size);
 325        if (!ret && !size)
 326                ret = realloc(ptr, 1);
 327        if (!ret) {
 328                release_pack_memory(size, -1);
 329                ret = realloc(ptr, size);
 330                if (!ret && !size)
 331                        ret = realloc(ptr, 1);
 332                if (!ret)
 333                        die("Out of memory, realloc failed");
 334        }
 335        return ret;
 336}
 337
 338static inline void *xcalloc(size_t nmemb, size_t size)
 339{
 340        void *ret = calloc(nmemb, size);
 341        if (!ret && (!nmemb || !size))
 342                ret = calloc(1, 1);
 343        if (!ret) {
 344                release_pack_memory(nmemb * size, -1);
 345                ret = calloc(nmemb, size);
 346                if (!ret && (!nmemb || !size))
 347                        ret = calloc(1, 1);
 348                if (!ret)
 349                        die("Out of memory, calloc failed");
 350        }
 351        return ret;
 352}
 353
 354static inline void *xmmap(void *start, size_t length,
 355        int prot, int flags, int fd, off_t offset)
 356{
 357        void *ret = mmap(start, length, prot, flags, fd, offset);
 358        if (ret == MAP_FAILED) {
 359                if (!length)
 360                        return NULL;
 361                release_pack_memory(length, fd);
 362                ret = mmap(start, length, prot, flags, fd, offset);
 363                if (ret == MAP_FAILED)
 364                        die("Out of memory? mmap failed: %s", strerror(errno));
 365        }
 366        return ret;
 367}
 368
 369/*
 370 * xread() is the same a read(), but it automatically restarts read()
 371 * operations with a recoverable error (EAGAIN and EINTR). xread()
 372 * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
 373 */
 374static inline ssize_t xread(int fd, void *buf, size_t len)
 375{
 376        ssize_t nr;
 377        while (1) {
 378                nr = read(fd, buf, len);
 379                if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
 380                        continue;
 381                return nr;
 382        }
 383}
 384
 385/*
 386 * xwrite() is the same a write(), but it automatically restarts write()
 387 * operations with a recoverable error (EAGAIN and EINTR). xwrite() DOES NOT
 388 * GUARANTEE that "len" bytes is written even if the operation is successful.
 389 */
 390static inline ssize_t xwrite(int fd, const void *buf, size_t len)
 391{
 392        ssize_t nr;
 393        while (1) {
 394                nr = write(fd, buf, len);
 395                if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
 396                        continue;
 397                return nr;
 398        }
 399}
 400
 401static inline int xdup(int fd)
 402{
 403        int ret = dup(fd);
 404        if (ret < 0)
 405                die("dup failed: %s", strerror(errno));
 406        return ret;
 407}
 408
 409static inline FILE *xfdopen(int fd, const char *mode)
 410{
 411        FILE *stream = fdopen(fd, mode);
 412        if (stream == NULL)
 413                die("Out of memory? fdopen failed: %s", strerror(errno));
 414        return stream;
 415}
 416
 417static inline int xmkstemp(char *template)
 418{
 419        int fd;
 420
 421        fd = mkstemp(template);
 422        if (fd < 0)
 423                die("Unable to create temporary file: %s", strerror(errno));
 424        return fd;
 425}
 426
 427static inline size_t xsize_t(off_t len)
 428{
 429        return (size_t)len;
 430}
 431
 432static inline int has_extension(const char *filename, const char *ext)
 433{
 434        size_t len = strlen(filename);
 435        size_t extlen = strlen(ext);
 436        return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 437}
 438
 439/* Sane ctype - no locale, and works with signed chars */
 440#undef isspace
 441#undef isdigit
 442#undef isalpha
 443#undef isalnum
 444#undef tolower
 445#undef toupper
 446extern unsigned char sane_ctype[256];
 447#define GIT_SPACE 0x01
 448#define GIT_DIGIT 0x02
 449#define GIT_ALPHA 0x04
 450#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 451#define isspace(x) sane_istest(x,GIT_SPACE)
 452#define isdigit(x) sane_istest(x,GIT_DIGIT)
 453#define isalpha(x) sane_istest(x,GIT_ALPHA)
 454#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 455#define tolower(x) sane_case((unsigned char)(x), 0x20)
 456#define toupper(x) sane_case((unsigned char)(x), 0)
 457
 458static inline int sane_case(int x, int high)
 459{
 460        if (sane_istest(x, GIT_ALPHA))
 461                x = (x & ~0x20) | high;
 462        return x;
 463}
 464
 465static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 466{
 467        unsigned long ul;
 468        char *p;
 469
 470        errno = 0;
 471        ul = strtoul(s, &p, base);
 472        if (errno || *p || p == s || (unsigned int) ul != ul)
 473                return -1;
 474        *result = ul;
 475        return 0;
 476}
 477
 478static inline int strtol_i(char const *s, int base, int *result)
 479{
 480        long ul;
 481        char *p;
 482
 483        errno = 0;
 484        ul = strtol(s, &p, base);
 485        if (errno || *p || p == s || (int) ul != ul)
 486                return -1;
 487        *result = ul;
 488        return 0;
 489}
 490
 491#ifdef INTERNAL_QSORT
 492void git_qsort(void *base, size_t nmemb, size_t size,
 493               int(*compar)(const void *, const void *));
 494#define qsort git_qsort
 495#endif
 496
 497#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
 498# define FORCE_DIR_SET_GID S_ISGID
 499#else
 500# define FORCE_DIR_SET_GID 0
 501#endif
 502
 503#endif