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) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
  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#define bitsizeof(x)  (CHAR_BIT * sizeof(x))
  30
  31#define maximum_signed_value_of_type(a) \
  32    (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
  33
  34#define maximum_unsigned_value_of_type(a) \
  35    (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
  36
  37/*
  38 * Signed integer overflow is undefined in C, so here's a helper macro
  39 * to detect if the sum of two integers will overflow.
  40 *
  41 * Requires: a >= 0, typeof(a) equals typeof(b)
  42 */
  43#define signed_add_overflows(a, b) \
  44    ((b) > maximum_signed_value_of_type(a) - (a))
  45
  46#define unsigned_add_overflows(a, b) \
  47    ((b) > maximum_unsigned_value_of_type(a) - (a))
  48
  49#ifdef __GNUC__
  50#define TYPEOF(x) (__typeof__(x))
  51#else
  52#define TYPEOF(x)
  53#endif
  54
  55#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
  56#define HAS_MULTI_BITS(i)  ((i) & ((i) - 1))  /* checks if an integer has more than 1 bit set */
  57
  58#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
  59
  60/* Approximation of the length of the decimal representation of this type. */
  61#define decimal_length(x)       ((int)(sizeof(x) * 2.56 + 0.5) + 1)
  62
  63#if defined(__sun__)
  64 /*
  65  * On Solaris, when _XOPEN_EXTENDED is set, its header file
  66  * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
  67  * setting to say we are XPG5 or XPG6.  Also on Solaris,
  68  * XPG6 programs must be compiled with a c99 compiler, while
  69  * non XPG6 programs must be compiled with a pre-c99 compiler.
  70  */
  71# if __STDC_VERSION__ - 0 >= 199901L
  72# define _XOPEN_SOURCE 600
  73# else
  74# define _XOPEN_SOURCE 500
  75# endif
  76#elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
  77      !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__)
  78#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
  79#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
  80#endif
  81#define _ALL_SOURCE 1
  82#define _GNU_SOURCE 1
  83#define _BSD_SOURCE 1
  84#define _NETBSD_SOURCE 1
  85#define _SGI_SOURCE 1
  86
  87#ifdef WIN32 /* Both MinGW and MSVC */
  88#define WIN32_LEAN_AND_MEAN  /* stops windows.h including winsock.h */
  89#include <winsock2.h>
  90#include <windows.h>
  91#endif
  92
  93#include <unistd.h>
  94#include <stdio.h>
  95#include <sys/stat.h>
  96#include <fcntl.h>
  97#include <stddef.h>
  98#include <stdlib.h>
  99#include <stdarg.h>
 100#include <string.h>
 101#include <errno.h>
 102#include <limits.h>
 103#include <sys/param.h>
 104#include <sys/types.h>
 105#include <dirent.h>
 106#include <sys/time.h>
 107#include <time.h>
 108#include <signal.h>
 109#include <fnmatch.h>
 110#include <assert.h>
 111#include <regex.h>
 112#include <utime.h>
 113#include <syslog.h>
 114#ifndef NO_SYS_POLL_H
 115#include <sys/poll.h>
 116#else
 117#include <poll.h>
 118#endif
 119#ifndef __MINGW32__
 120#include <sys/wait.h>
 121#include <sys/resource.h>
 122#include <sys/socket.h>
 123#include <sys/ioctl.h>
 124#include <termios.h>
 125#ifndef NO_SYS_SELECT_H
 126#include <sys/select.h>
 127#endif
 128#include <netinet/in.h>
 129#include <netinet/tcp.h>
 130#include <arpa/inet.h>
 131#include <netdb.h>
 132#include <pwd.h>
 133#include <sys/un.h>
 134#ifndef NO_INTTYPES_H
 135#include <inttypes.h>
 136#else
 137#include <stdint.h>
 138#endif
 139#if defined(__CYGWIN__)
 140#undef _XOPEN_SOURCE
 141#include <grp.h>
 142#define _XOPEN_SOURCE 600
 143#include "compat/cygwin.h"
 144#else
 145#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
 146#include <grp.h>
 147#define _ALL_SOURCE 1
 148#endif
 149#else   /* __MINGW32__ */
 150/* pull in Windows compatibility stuff */
 151#include "compat/mingw.h"
 152#endif  /* __MINGW32__ */
 153#ifdef _MSC_VER
 154#include "compat/msvc.h"
 155#endif
 156
 157#ifndef NO_LIBGEN_H
 158#include <libgen.h>
 159#else
 160#define basename gitbasename
 161extern char *gitbasename(char *);
 162#endif
 163
 164#ifndef NO_ICONV
 165#include <iconv.h>
 166#endif
 167
 168#ifndef NO_OPENSSL
 169#include <openssl/ssl.h>
 170#include <openssl/err.h>
 171#endif
 172
 173/* On most systems <limits.h> would have given us this, but
 174 * not on some systems (e.g. GNU/Hurd).
 175 */
 176#ifndef PATH_MAX
 177#define PATH_MAX 4096
 178#endif
 179
 180#ifndef PRIuMAX
 181#define PRIuMAX "llu"
 182#endif
 183
 184#ifndef PRIu32
 185#define PRIu32 "u"
 186#endif
 187
 188#ifndef PRIx32
 189#define PRIx32 "x"
 190#endif
 191
 192#ifndef PRIo32
 193#define PRIo32 "o"
 194#endif
 195
 196#ifndef PATH_SEP
 197#define PATH_SEP ':'
 198#endif
 199
 200#ifdef HAVE_PATHS_H
 201#include <paths.h>
 202#endif
 203#ifndef _PATH_DEFPATH
 204#define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
 205#endif
 206
 207#ifndef STRIP_EXTENSION
 208#define STRIP_EXTENSION ""
 209#endif
 210
 211#ifndef has_dos_drive_prefix
 212#define has_dos_drive_prefix(path) 0
 213#endif
 214
 215#ifndef is_dir_sep
 216#define is_dir_sep(c) ((c) == '/')
 217#endif
 218
 219#ifndef find_last_dir_sep
 220#define find_last_dir_sep(path) strrchr(path, '/')
 221#endif
 222
 223#if defined(__HP_cc) && (__HP_cc >= 61000)
 224#define NORETURN __attribute__((noreturn))
 225#define NORETURN_PTR
 226#elif defined(__GNUC__) && !defined(NO_NORETURN)
 227#define NORETURN __attribute__((__noreturn__))
 228#define NORETURN_PTR __attribute__((__noreturn__))
 229#elif defined(_MSC_VER)
 230#define NORETURN __declspec(noreturn)
 231#define NORETURN_PTR
 232#else
 233#define NORETURN
 234#define NORETURN_PTR
 235#ifndef __attribute__
 236#define __attribute__(x)
 237#endif
 238#endif
 239
 240#include "compat/bswap.h"
 241
 242/* General helper functions */
 243extern void vreportf(const char *prefix, const char *err, va_list params);
 244extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
 245extern NORETURN void usage(const char *err);
 246extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
 247extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
 248extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 249extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 250extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 251
 252extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
 253extern void set_error_routine(void (*routine)(const char *err, va_list params));
 254
 255extern int prefixcmp(const char *str, const char *prefix);
 256extern int suffixcmp(const char *str, const char *suffix);
 257
 258static inline const char *skip_prefix(const char *str, const char *prefix)
 259{
 260        size_t len = strlen(prefix);
 261        return strncmp(str, prefix, len) ? NULL : str + len;
 262}
 263
 264#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
 265
 266#ifndef PROT_READ
 267#define PROT_READ 1
 268#define PROT_WRITE 2
 269#define MAP_PRIVATE 1
 270#endif
 271
 272#define mmap git_mmap
 273#define munmap git_munmap
 274extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 275extern int git_munmap(void *start, size_t length);
 276
 277#else /* NO_MMAP || USE_WIN32_MMAP */
 278
 279#include <sys/mman.h>
 280
 281#endif /* NO_MMAP || USE_WIN32_MMAP */
 282
 283#ifdef NO_MMAP
 284
 285/* This value must be multiple of (pagesize * 2) */
 286#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 287
 288#else /* NO_MMAP */
 289
 290/* This value must be multiple of (pagesize * 2) */
 291#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 292        (sizeof(void*) >= 8 \
 293                ?  1 * 1024 * 1024 * 1024 \
 294                : 32 * 1024 * 1024)
 295
 296#endif /* NO_MMAP */
 297
 298#ifndef MAP_FAILED
 299#define MAP_FAILED ((void *)-1)
 300#endif
 301
 302#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
 303#define on_disk_bytes(st) ((st).st_size)
 304#else
 305#define on_disk_bytes(st) ((st).st_blocks * 512)
 306#endif
 307
 308#define DEFAULT_PACKED_GIT_LIMIT \
 309        ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
 310
 311#ifdef NO_PREAD
 312#define pread git_pread
 313extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 314#endif
 315/*
 316 * Forward decl that will remind us if its twin in cache.h changes.
 317 * This function is used in compat/pread.c.  But we can't include
 318 * cache.h there.
 319 */
 320extern ssize_t read_in_full(int fd, void *buf, size_t count);
 321
 322#ifdef NO_SETENV
 323#define setenv gitsetenv
 324extern int gitsetenv(const char *, const char *, int);
 325#endif
 326
 327#ifdef NO_MKDTEMP
 328#define mkdtemp gitmkdtemp
 329extern char *gitmkdtemp(char *);
 330#endif
 331
 332#ifdef NO_MKSTEMPS
 333#define mkstemps gitmkstemps
 334extern int gitmkstemps(char *, int);
 335#endif
 336
 337#ifdef NO_UNSETENV
 338#define unsetenv gitunsetenv
 339extern void gitunsetenv(const char *);
 340#endif
 341
 342#ifdef NO_STRCASESTR
 343#define strcasestr gitstrcasestr
 344extern char *gitstrcasestr(const char *haystack, const char *needle);
 345#endif
 346
 347#ifdef NO_STRLCPY
 348#define strlcpy gitstrlcpy
 349extern size_t gitstrlcpy(char *, const char *, size_t);
 350#endif
 351
 352#ifdef NO_STRTOUMAX
 353#define strtoumax gitstrtoumax
 354extern uintmax_t gitstrtoumax(const char *, char **, int);
 355#endif
 356
 357#ifdef NO_STRTOK_R
 358#define strtok_r gitstrtok_r
 359extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr);
 360#endif
 361
 362#ifdef NO_HSTRERROR
 363#define hstrerror githstrerror
 364extern const char *githstrerror(int herror);
 365#endif
 366
 367#ifdef NO_MEMMEM
 368#define memmem gitmemmem
 369void *gitmemmem(const void *haystack, size_t haystacklen,
 370                const void *needle, size_t needlelen);
 371#endif
 372
 373#ifdef FREAD_READS_DIRECTORIES
 374#ifdef fopen
 375#undef fopen
 376#endif
 377#define fopen(a,b) git_fopen(a,b)
 378extern FILE *git_fopen(const char*, const char*);
 379#endif
 380
 381#ifdef SNPRINTF_RETURNS_BOGUS
 382#define snprintf git_snprintf
 383extern int git_snprintf(char *str, size_t maxsize,
 384                        const char *format, ...);
 385#define vsnprintf git_vsnprintf
 386extern int git_vsnprintf(char *str, size_t maxsize,
 387                         const char *format, va_list ap);
 388#endif
 389
 390#ifdef __GLIBC_PREREQ
 391#if __GLIBC_PREREQ(2, 1)
 392#define HAVE_STRCHRNUL
 393#define HAVE_MEMPCPY
 394#endif
 395#endif
 396
 397#ifndef HAVE_STRCHRNUL
 398#define strchrnul gitstrchrnul
 399static inline char *gitstrchrnul(const char *s, int c)
 400{
 401        while (*s && *s != c)
 402                s++;
 403        return (char *)s;
 404}
 405#endif
 406
 407#ifndef HAVE_MEMPCPY
 408#define mempcpy gitmempcpy
 409static inline void *gitmempcpy(void *dest, const void *src, size_t n)
 410{
 411        return (char *)memcpy(dest, src, n) + n;
 412}
 413#endif
 414
 415#ifdef NO_INET_PTON
 416int inet_pton(int af, const char *src, void *dst);
 417#endif
 418
 419#ifdef NO_INET_NTOP
 420const char *inet_ntop(int af, const void *src, char *dst, size_t size);
 421#endif
 422
 423extern void release_pack_memory(size_t, int);
 424
 425typedef void (*try_to_free_t)(size_t);
 426extern try_to_free_t set_try_to_free_routine(try_to_free_t);
 427
 428extern char *xstrdup(const char *str);
 429extern void *xmalloc(size_t size);
 430extern void *xmallocz(size_t size);
 431extern void *xmemdupz(const void *data, size_t len);
 432extern char *xstrndup(const char *str, size_t len);
 433extern void *xrealloc(void *ptr, size_t size);
 434extern void *xcalloc(size_t nmemb, size_t size);
 435extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 436extern ssize_t xread(int fd, void *buf, size_t len);
 437extern ssize_t xwrite(int fd, const void *buf, size_t len);
 438extern int xdup(int fd);
 439extern FILE *xfdopen(int fd, const char *mode);
 440extern int xmkstemp(char *template);
 441extern int xmkstemp_mode(char *template, int mode);
 442extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
 443extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
 444
 445static inline size_t xsize_t(off_t len)
 446{
 447        if (len > (size_t) len)
 448                die("Cannot handle files this big");
 449        return (size_t)len;
 450}
 451
 452static inline int has_extension(const char *filename, const char *ext)
 453{
 454        size_t len = strlen(filename);
 455        size_t extlen = strlen(ext);
 456        return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 457}
 458
 459/* Sane ctype - no locale, and works with signed chars */
 460#undef isascii
 461#undef isspace
 462#undef isdigit
 463#undef isalpha
 464#undef isalnum
 465#undef tolower
 466#undef toupper
 467extern unsigned char sane_ctype[256];
 468#define GIT_SPACE 0x01
 469#define GIT_DIGIT 0x02
 470#define GIT_ALPHA 0x04
 471#define GIT_GLOB_SPECIAL 0x08
 472#define GIT_REGEX_SPECIAL 0x10
 473#define GIT_PATHSPEC_MAGIC 0x20
 474#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 475#define isascii(x) (((x) & ~0x7f) == 0)
 476#define isspace(x) sane_istest(x,GIT_SPACE)
 477#define isdigit(x) sane_istest(x,GIT_DIGIT)
 478#define isalpha(x) sane_istest(x,GIT_ALPHA)
 479#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 480#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
 481#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
 482#define tolower(x) sane_case((unsigned char)(x), 0x20)
 483#define toupper(x) sane_case((unsigned char)(x), 0)
 484#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
 485
 486static inline int sane_case(int x, int high)
 487{
 488        if (sane_istest(x, GIT_ALPHA))
 489                x = (x & ~0x20) | high;
 490        return x;
 491}
 492
 493static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 494{
 495        unsigned long ul;
 496        char *p;
 497
 498        errno = 0;
 499        ul = strtoul(s, &p, base);
 500        if (errno || *p || p == s || (unsigned int) ul != ul)
 501                return -1;
 502        *result = ul;
 503        return 0;
 504}
 505
 506static inline int strtol_i(char const *s, int base, int *result)
 507{
 508        long ul;
 509        char *p;
 510
 511        errno = 0;
 512        ul = strtol(s, &p, base);
 513        if (errno || *p || p == s || (int) ul != ul)
 514                return -1;
 515        *result = ul;
 516        return 0;
 517}
 518
 519#ifdef INTERNAL_QSORT
 520void git_qsort(void *base, size_t nmemb, size_t size,
 521               int(*compar)(const void *, const void *));
 522#define qsort git_qsort
 523#endif
 524
 525#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
 526# define FORCE_DIR_SET_GID S_ISGID
 527#else
 528# define FORCE_DIR_SET_GID 0
 529#endif
 530
 531#ifdef NO_NSEC
 532#undef USE_NSEC
 533#define ST_CTIME_NSEC(st) 0
 534#define ST_MTIME_NSEC(st) 0
 535#else
 536#ifdef USE_ST_TIMESPEC
 537#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
 538#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
 539#else
 540#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
 541#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
 542#endif
 543#endif
 544
 545#ifdef UNRELIABLE_FSTAT
 546#define fstat_is_reliable() 0
 547#else
 548#define fstat_is_reliable() 1
 549#endif
 550
 551#ifndef va_copy
 552/*
 553 * Since an obvious implementation of va_list would be to make it a
 554 * pointer into the stack frame, a simple assignment will work on
 555 * many systems.  But let's try to be more portable.
 556 */
 557#ifdef __va_copy
 558#define va_copy(dst, src) __va_copy(dst, src)
 559#else
 560#define va_copy(dst, src) ((dst) = (src))
 561#endif
 562#endif
 563
 564/*
 565 * Preserves errno, prints a message, but gives no warning for ENOENT.
 566 * Always returns the return value of unlink(2).
 567 */
 568int unlink_or_warn(const char *path);
 569/*
 570 * Likewise for rmdir(2).
 571 */
 572int rmdir_or_warn(const char *path);
 573/*
 574 * Calls the correct function out of {unlink,rmdir}_or_warn based on
 575 * the supplied file mode.
 576 */
 577int remove_or_warn(unsigned int mode, const char *path);
 578
 579#endif