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