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