Andrew's git - gitweb.git/blob

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