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#include <termios.h>
 100#ifndef NO_SYS_SELECT_H
 101#include <sys/select.h>
 102#endif
 103#include <netinet/in.h>
 104#include <netinet/tcp.h>
 105#include <arpa/inet.h>
 106#include <netdb.h>
 107#include <pwd.h>
 108#include <inttypes.h>
 109#if defined(__CYGWIN__)
 110#undef _XOPEN_SOURCE
 111#include <grp.h>
 112#define _XOPEN_SOURCE 600
 113#include "compat/cygwin.h"
 114#else
 115#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
 116#include <grp.h>
 117#define _ALL_SOURCE 1
 118#endif
 119#else   /* __MINGW32__ */
 120/* pull in Windows compatibility stuff */
 121#include "compat/mingw.h"
 122#endif  /* __MINGW32__ */
 123#ifdef _MSC_VER
 124#include "compat/msvc.h"
 125#endif
 126
 127#ifndef NO_LIBGEN_H
 128#include <libgen.h>
 129#else
 130#define basename gitbasename
 131extern char *gitbasename(char *);
 132#endif
 133
 134#ifndef NO_ICONV
 135#include <iconv.h>
 136#endif
 137
 138#ifndef NO_OPENSSL
 139#include <openssl/ssl.h>
 140#include <openssl/err.h>
 141#endif
 142
 143/* On most systems <limits.h> would have given us this, but
 144 * not on some systems (e.g. GNU/Hurd).
 145 */
 146#ifndef PATH_MAX
 147#define PATH_MAX 4096
 148#endif
 149
 150#ifndef PRIuMAX
 151#define PRIuMAX "llu"
 152#endif
 153
 154#ifndef PRIu32
 155#define PRIu32 "u"
 156#endif
 157
 158#ifndef PRIx32
 159#define PRIx32 "x"
 160#endif
 161
 162#ifndef PATH_SEP
 163#define PATH_SEP ':'
 164#endif
 165
 166#ifdef HAVE_PATHS_H
 167#include <paths.h>
 168#endif
 169#ifndef _PATH_DEFPATH
 170#define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
 171#endif
 172
 173#ifndef STRIP_EXTENSION
 174#define STRIP_EXTENSION ""
 175#endif
 176
 177#ifndef has_dos_drive_prefix
 178#define has_dos_drive_prefix(path) 0
 179#endif
 180
 181#ifndef is_dir_sep
 182#define is_dir_sep(c) ((c) == '/')
 183#endif
 184
 185#ifdef __GNUC__
 186#define NORETURN __attribute__((__noreturn__))
 187#define NORETURN_PTR __attribute__((__noreturn__))
 188#elif defined(_MSC_VER)
 189#define NORETURN __declspec(noreturn)
 190#define NORETURN_PTR
 191#else
 192#define NORETURN
 193#define NORETURN_PTR
 194#ifndef __attribute__
 195#define __attribute__(x)
 196#endif
 197#endif
 198
 199#include "compat/bswap.h"
 200
 201/* General helper functions */
 202extern NORETURN void usage(const char *err);
 203extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
 204extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
 205extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 206extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 207extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 208
 209extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
 210
 211extern int prefixcmp(const char *str, const char *prefix);
 212extern int suffixcmp(const char *str, const char *suffix);
 213
 214static inline const char *skip_prefix(const char *str, const char *prefix)
 215{
 216        size_t len = strlen(prefix);
 217        return strncmp(str, prefix, len) ? NULL : str + len;
 218}
 219
 220#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
 221
 222#ifndef PROT_READ
 223#define PROT_READ 1
 224#define PROT_WRITE 2
 225#define MAP_PRIVATE 1
 226#define MAP_FAILED ((void*)-1)
 227#endif
 228
 229#define mmap git_mmap
 230#define munmap git_munmap
 231extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 232extern int git_munmap(void *start, size_t length);
 233
 234#else /* NO_MMAP || USE_WIN32_MMAP */
 235
 236#include <sys/mman.h>
 237
 238#endif /* NO_MMAP || USE_WIN32_MMAP */
 239
 240#ifdef NO_MMAP
 241
 242/* This value must be multiple of (pagesize * 2) */
 243#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 244
 245#else /* NO_MMAP */
 246
 247/* This value must be multiple of (pagesize * 2) */
 248#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 249        (sizeof(void*) >= 8 \
 250                ?  1 * 1024 * 1024 * 1024 \
 251                : 32 * 1024 * 1024)
 252
 253#endif /* NO_MMAP */
 254
 255#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
 256#define on_disk_bytes(st) ((st).st_size)
 257#else
 258#define on_disk_bytes(st) ((st).st_blocks * 512)
 259#endif
 260
 261#define DEFAULT_PACKED_GIT_LIMIT \
 262        ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
 263
 264#ifdef NO_PREAD
 265#define pread git_pread
 266extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 267#endif
 268/*
 269 * Forward decl that will remind us if its twin in cache.h changes.
 270 * This function is used in compat/pread.c.  But we can't include
 271 * cache.h there.
 272 */
 273extern ssize_t read_in_full(int fd, void *buf, size_t count);
 274
 275#ifdef NO_SETENV
 276#define setenv gitsetenv
 277extern int gitsetenv(const char *, const char *, int);
 278#endif
 279
 280#ifdef NO_MKDTEMP
 281#define mkdtemp gitmkdtemp
 282extern char *gitmkdtemp(char *);
 283#endif
 284
 285#ifdef NO_MKSTEMPS
 286#define mkstemps gitmkstemps
 287extern int gitmkstemps(char *, int);
 288#endif
 289
 290#ifdef NO_UNSETENV
 291#define unsetenv gitunsetenv
 292extern void gitunsetenv(const char *);
 293#endif
 294
 295#ifdef NO_STRCASESTR
 296#define strcasestr gitstrcasestr
 297extern char *gitstrcasestr(const char *haystack, const char *needle);
 298#endif
 299
 300#ifdef NO_STRLCPY
 301#define strlcpy gitstrlcpy
 302extern size_t gitstrlcpy(char *, const char *, size_t);
 303#endif
 304
 305#ifdef NO_STRTOUMAX
 306#define strtoumax gitstrtoumax
 307extern uintmax_t gitstrtoumax(const char *, char **, int);
 308#endif
 309
 310#ifdef NO_HSTRERROR
 311#define hstrerror githstrerror
 312extern const char *githstrerror(int herror);
 313#endif
 314
 315#ifdef NO_MEMMEM
 316#define memmem gitmemmem
 317void *gitmemmem(const void *haystack, size_t haystacklen,
 318                const void *needle, size_t needlelen);
 319#endif
 320
 321#ifdef FREAD_READS_DIRECTORIES
 322#ifdef fopen
 323#undef fopen
 324#endif
 325#define fopen(a,b) git_fopen(a,b)
 326extern FILE *git_fopen(const char*, const char*);
 327#endif
 328
 329#ifdef SNPRINTF_RETURNS_BOGUS
 330#define snprintf git_snprintf
 331extern int git_snprintf(char *str, size_t maxsize,
 332                        const char *format, ...);
 333#define vsnprintf git_vsnprintf
 334extern int git_vsnprintf(char *str, size_t maxsize,
 335                         const char *format, va_list ap);
 336#endif
 337
 338#ifdef __GLIBC_PREREQ
 339#if __GLIBC_PREREQ(2, 1)
 340#define HAVE_STRCHRNUL
 341#endif
 342#endif
 343
 344#ifndef HAVE_STRCHRNUL
 345#define strchrnul gitstrchrnul
 346static inline char *gitstrchrnul(const char *s, int c)
 347{
 348        while (*s && *s != c)
 349                s++;
 350        return (char *)s;
 351}
 352#endif
 353
 354extern void release_pack_memory(size_t, int);
 355
 356extern char *xstrdup(const char *str);
 357extern void *xmalloc(size_t size);
 358extern void *xmallocz(size_t size);
 359extern void *xmemdupz(const void *data, size_t len);
 360extern char *xstrndup(const char *str, size_t len);
 361extern void *xrealloc(void *ptr, size_t size);
 362extern void *xcalloc(size_t nmemb, size_t size);
 363extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 364extern ssize_t xread(int fd, void *buf, size_t len);
 365extern ssize_t xwrite(int fd, const void *buf, size_t len);
 366extern int xdup(int fd);
 367extern FILE *xfdopen(int fd, const char *mode);
 368extern int xmkstemp(char *template);
 369extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
 370extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
 371
 372static inline size_t xsize_t(off_t len)
 373{
 374        return (size_t)len;
 375}
 376
 377static inline int has_extension(const char *filename, const char *ext)
 378{
 379        size_t len = strlen(filename);
 380        size_t extlen = strlen(ext);
 381        return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 382}
 383
 384/* Sane ctype - no locale, and works with signed chars */
 385#undef isascii
 386#undef isspace
 387#undef isdigit
 388#undef isalpha
 389#undef isalnum
 390#undef tolower
 391#undef toupper
 392extern unsigned char sane_ctype[256];
 393#define GIT_SPACE 0x01
 394#define GIT_DIGIT 0x02
 395#define GIT_ALPHA 0x04
 396#define GIT_GLOB_SPECIAL 0x08
 397#define GIT_REGEX_SPECIAL 0x10
 398#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 399#define isascii(x) (((x) & ~0x7f) == 0)
 400#define isspace(x) sane_istest(x,GIT_SPACE)
 401#define isdigit(x) sane_istest(x,GIT_DIGIT)
 402#define isalpha(x) sane_istest(x,GIT_ALPHA)
 403#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 404#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
 405#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
 406#define tolower(x) sane_case((unsigned char)(x), 0x20)
 407#define toupper(x) sane_case((unsigned char)(x), 0)
 408
 409static inline int sane_case(int x, int high)
 410{
 411        if (sane_istest(x, GIT_ALPHA))
 412                x = (x & ~0x20) | high;
 413        return x;
 414}
 415
 416static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 417{
 418        unsigned long ul;
 419        char *p;
 420
 421        errno = 0;
 422        ul = strtoul(s, &p, base);
 423        if (errno || *p || p == s || (unsigned int) ul != ul)
 424                return -1;
 425        *result = ul;
 426        return 0;
 427}
 428
 429static inline int strtol_i(char const *s, int base, int *result)
 430{
 431        long ul;
 432        char *p;
 433
 434        errno = 0;
 435        ul = strtol(s, &p, base);
 436        if (errno || *p || p == s || (int) ul != ul)
 437                return -1;
 438        *result = ul;
 439        return 0;
 440}
 441
 442#ifdef INTERNAL_QSORT
 443void git_qsort(void *base, size_t nmemb, size_t size,
 444               int(*compar)(const void *, const void *));
 445#define qsort git_qsort
 446#endif
 447
 448#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
 449# define FORCE_DIR_SET_GID S_ISGID
 450#else
 451# define FORCE_DIR_SET_GID 0
 452#endif
 453
 454#ifdef NO_NSEC
 455#undef USE_NSEC
 456#define ST_CTIME_NSEC(st) 0
 457#define ST_MTIME_NSEC(st) 0
 458#else
 459#ifdef USE_ST_TIMESPEC
 460#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
 461#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
 462#else
 463#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
 464#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
 465#endif
 466#endif
 467
 468#ifdef UNRELIABLE_FSTAT
 469#define fstat_is_reliable() 0
 470#else
 471#define fstat_is_reliable() 1
 472#endif
 473
 474/*
 475 * Preserves errno, prints a message, but gives no warning for ENOENT.
 476 * Always returns the return value of unlink(2).
 477 */
 478int unlink_or_warn(const char *path);
 479
 480#endif