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