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