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