git-compat-util.hon commit Merge branch 'js/parallel-test' (6da9d5b)
   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)
  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
  30#ifdef __GNUC__
  31#define TYPEOF(x) (__typeof__(x))
  32#else
  33#define TYPEOF(x)
  34#endif
  35
  36#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
  37#define HAS_MULTI_BITS(i)  ((i) & ((i) - 1))  /* checks if an integer has more than 1 bit set */
  38
  39/* Approximation of the length of the decimal representation of this type. */
  40#define decimal_length(x)       ((int)(sizeof(x) * 2.56 + 0.5) + 1)
  41
  42#if !defined(__APPLE__) && !defined(__FreeBSD__)  && !defined(__USLC__) && !defined(_M_UNIX)
  43#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
  44#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
  45#endif
  46#define _ALL_SOURCE 1
  47#define _GNU_SOURCE 1
  48#define _BSD_SOURCE 1
  49
  50#include <unistd.h>
  51#include <stdio.h>
  52#include <sys/stat.h>
  53#include <fcntl.h>
  54#include <stddef.h>
  55#include <stdlib.h>
  56#include <stdarg.h>
  57#include <string.h>
  58#include <errno.h>
  59#include <limits.h>
  60#include <sys/param.h>
  61#include <sys/types.h>
  62#include <dirent.h>
  63#include <sys/time.h>
  64#include <time.h>
  65#include <signal.h>
  66#include <fnmatch.h>
  67#include <assert.h>
  68#include <regex.h>
  69#include <utime.h>
  70#ifndef __MINGW32__
  71#include <sys/wait.h>
  72#include <sys/poll.h>
  73#include <sys/socket.h>
  74#include <sys/ioctl.h>
  75#ifndef NO_SYS_SELECT_H
  76#include <sys/select.h>
  77#endif
  78#include <netinet/in.h>
  79#include <netinet/tcp.h>
  80#include <arpa/inet.h>
  81#include <netdb.h>
  82#include <pwd.h>
  83#include <inttypes.h>
  84#if defined(__CYGWIN__)
  85#undef _XOPEN_SOURCE
  86#include <grp.h>
  87#define _XOPEN_SOURCE 600
  88#else
  89#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
  90#include <grp.h>
  91#define _ALL_SOURCE 1
  92#endif
  93#else   /* __MINGW32__ */
  94/* pull in Windows compatibility stuff */
  95#include "compat/mingw.h"
  96#endif  /* __MINGW32__ */
  97
  98#ifndef NO_ICONV
  99#include <iconv.h>
 100#endif
 101
 102#ifndef NO_OPENSSL
 103#include <openssl/ssl.h>
 104#include <openssl/err.h>
 105#endif
 106
 107/* On most systems <limits.h> would have given us this, but
 108 * not on some systems (e.g. GNU/Hurd).
 109 */
 110#ifndef PATH_MAX
 111#define PATH_MAX 4096
 112#endif
 113
 114#ifndef PRIuMAX
 115#define PRIuMAX "llu"
 116#endif
 117
 118#ifndef PRIu32
 119#define PRIu32 "u"
 120#endif
 121
 122#ifndef PRIx32
 123#define PRIx32 "x"
 124#endif
 125
 126#ifndef PATH_SEP
 127#define PATH_SEP ':'
 128#endif
 129
 130#ifndef STRIP_EXTENSION
 131#define STRIP_EXTENSION ""
 132#endif
 133
 134#ifndef has_dos_drive_prefix
 135#define has_dos_drive_prefix(path) 0
 136#endif
 137
 138#ifndef is_dir_sep
 139#define is_dir_sep(c) ((c) == '/')
 140#endif
 141
 142#ifdef __GNUC__
 143#define NORETURN __attribute__((__noreturn__))
 144#else
 145#define NORETURN
 146#ifndef __attribute__
 147#define __attribute__(x)
 148#endif
 149#endif
 150
 151/* General helper functions */
 152extern void usage(const char *err) NORETURN;
 153extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
 154extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 155extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 156
 157extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
 158extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
 159extern void set_error_routine(void (*routine)(const char *err, va_list params));
 160extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
 161
 162extern int prefixcmp(const char *str, const char *prefix);
 163extern time_t tm_to_time_t(const struct tm *tm);
 164
 165static inline const char *skip_prefix(const char *str, const char *prefix)
 166{
 167        size_t len = strlen(prefix);
 168        return strncmp(str, prefix, len) ? NULL : str + len;
 169}
 170
 171#ifdef NO_MMAP
 172
 173#ifndef PROT_READ
 174#define PROT_READ 1
 175#define PROT_WRITE 2
 176#define MAP_PRIVATE 1
 177#define MAP_FAILED ((void*)-1)
 178#endif
 179
 180#define mmap git_mmap
 181#define munmap git_munmap
 182extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 183extern int git_munmap(void *start, size_t length);
 184
 185/* This value must be multiple of (pagesize * 2) */
 186#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 187
 188#else /* NO_MMAP */
 189
 190#include <sys/mman.h>
 191
 192/* This value must be multiple of (pagesize * 2) */
 193#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 194        (sizeof(void*) >= 8 \
 195                ?  1 * 1024 * 1024 * 1024 \
 196                : 32 * 1024 * 1024)
 197
 198#endif /* NO_MMAP */
 199
 200#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
 201#define on_disk_bytes(st) ((st).st_size)
 202#else
 203#define on_disk_bytes(st) ((st).st_blocks * 512)
 204#endif
 205
 206#define DEFAULT_PACKED_GIT_LIMIT \
 207        ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
 208
 209#ifdef NO_PREAD
 210#define pread git_pread
 211extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 212#endif
 213/*
 214 * Forward decl that will remind us if its twin in cache.h changes.
 215 * This function is used in compat/pread.c.  But we can't include
 216 * cache.h there.
 217 */
 218extern ssize_t read_in_full(int fd, void *buf, size_t count);
 219
 220#ifdef NO_SETENV
 221#define setenv gitsetenv
 222extern int gitsetenv(const char *, const char *, int);
 223#endif
 224
 225#ifdef NO_MKDTEMP
 226#define mkdtemp gitmkdtemp
 227extern char *gitmkdtemp(char *);
 228#endif
 229
 230#ifdef NO_UNSETENV
 231#define unsetenv gitunsetenv
 232extern void gitunsetenv(const char *);
 233#endif
 234
 235#ifdef NO_STRCASESTR
 236#define strcasestr gitstrcasestr
 237extern char *gitstrcasestr(const char *haystack, const char *needle);
 238#endif
 239
 240#ifdef NO_STRLCPY
 241#define strlcpy gitstrlcpy
 242extern size_t gitstrlcpy(char *, const char *, size_t);
 243#endif
 244
 245#ifdef NO_STRTOUMAX
 246#define strtoumax gitstrtoumax
 247extern uintmax_t gitstrtoumax(const char *, char **, int);
 248#endif
 249
 250#ifdef NO_HSTRERROR
 251#define hstrerror githstrerror
 252extern const char *githstrerror(int herror);
 253#endif
 254
 255#ifdef NO_MEMMEM
 256#define memmem gitmemmem
 257void *gitmemmem(const void *haystack, size_t haystacklen,
 258                const void *needle, size_t needlelen);
 259#endif
 260
 261#ifdef FREAD_READS_DIRECTORIES
 262#ifdef fopen
 263#undef fopen
 264#endif
 265#define fopen(a,b) git_fopen(a,b)
 266extern FILE *git_fopen(const char*, const char*);
 267#endif
 268
 269#ifdef SNPRINTF_RETURNS_BOGUS
 270#define snprintf git_snprintf
 271extern int git_snprintf(char *str, size_t maxsize,
 272                        const char *format, ...);
 273#define vsnprintf git_vsnprintf
 274extern int git_vsnprintf(char *str, size_t maxsize,
 275                         const char *format, va_list ap);
 276#endif
 277
 278#ifdef __GLIBC_PREREQ
 279#if __GLIBC_PREREQ(2, 1)
 280#define HAVE_STRCHRNUL
 281#endif
 282#endif
 283
 284#ifndef HAVE_STRCHRNUL
 285#define strchrnul gitstrchrnul
 286static inline char *gitstrchrnul(const char *s, int c)
 287{
 288        while (*s && *s != c)
 289                s++;
 290        return (char *)s;
 291}
 292#endif
 293
 294extern void release_pack_memory(size_t, int);
 295
 296extern char *xstrdup(const char *str);
 297extern void *xmalloc(size_t size);
 298extern void *xmemdupz(const void *data, size_t len);
 299extern char *xstrndup(const char *str, size_t len);
 300extern void *xrealloc(void *ptr, size_t size);
 301extern void *xcalloc(size_t nmemb, size_t size);
 302extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 303extern ssize_t xread(int fd, void *buf, size_t len);
 304extern ssize_t xwrite(int fd, const void *buf, size_t len);
 305extern int xdup(int fd);
 306extern FILE *xfdopen(int fd, const char *mode);
 307extern int xmkstemp(char *template);
 308
 309static inline size_t xsize_t(off_t len)
 310{
 311        return (size_t)len;
 312}
 313
 314static inline int has_extension(const char *filename, const char *ext)
 315{
 316        size_t len = strlen(filename);
 317        size_t extlen = strlen(ext);
 318        return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 319}
 320
 321/* Sane ctype - no locale, and works with signed chars */
 322#undef isspace
 323#undef isdigit
 324#undef isalpha
 325#undef isalnum
 326#undef tolower
 327#undef toupper
 328extern unsigned char sane_ctype[256];
 329#define GIT_SPACE 0x01
 330#define GIT_DIGIT 0x02
 331#define GIT_ALPHA 0x04
 332#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 333#define isspace(x) sane_istest(x,GIT_SPACE)
 334#define isdigit(x) sane_istest(x,GIT_DIGIT)
 335#define isalpha(x) sane_istest(x,GIT_ALPHA)
 336#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 337#define tolower(x) sane_case((unsigned char)(x), 0x20)
 338#define toupper(x) sane_case((unsigned char)(x), 0)
 339
 340static inline int sane_case(int x, int high)
 341{
 342        if (sane_istest(x, GIT_ALPHA))
 343                x = (x & ~0x20) | high;
 344        return x;
 345}
 346
 347static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 348{
 349        unsigned long ul;
 350        char *p;
 351
 352        errno = 0;
 353        ul = strtoul(s, &p, base);
 354        if (errno || *p || p == s || (unsigned int) ul != ul)
 355                return -1;
 356        *result = ul;
 357        return 0;
 358}
 359
 360static inline int strtol_i(char const *s, int base, int *result)
 361{
 362        long ul;
 363        char *p;
 364
 365        errno = 0;
 366        ul = strtol(s, &p, base);
 367        if (errno || *p || p == s || (int) ul != ul)
 368                return -1;
 369        *result = ul;
 370        return 0;
 371}
 372
 373#ifdef INTERNAL_QSORT
 374void git_qsort(void *base, size_t nmemb, size_t size,
 375               int(*compar)(const void *, const void *));
 376#define qsort git_qsort
 377#endif
 378
 379#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
 380# define FORCE_DIR_SET_GID S_ISGID
 381#else
 382# define FORCE_DIR_SET_GID 0
 383#endif
 384
 385#endif