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