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