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