Andrew's git - gitweb.git/blob

5c596875c2e78a92031915948444971126d91a78
   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 time_t tm_to_time_t(const struct tm *tm);
 202
 203static inline const char *skip_prefix(const char *str, const char *prefix)
 204{
 205        size_t len = strlen(prefix);
 206        return strncmp(str, prefix, len) ? NULL : str + len;
 207}
 208
 209#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
 210
 211#ifndef PROT_READ
 212#define PROT_READ 1
 213#define PROT_WRITE 2
 214#define MAP_PRIVATE 1
 215#define MAP_FAILED ((void*)-1)
 216#endif
 217
 218#define mmap git_mmap
 219#define munmap git_munmap
 220extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 221extern int git_munmap(void *start, size_t length);
 222
 223#else /* NO_MMAP || USE_WIN32_MMAP */
 224
 225#include <sys/mman.h>
 226
 227#endif /* NO_MMAP || USE_WIN32_MMAP */
 228
 229#ifdef NO_MMAP
 230
 231/* This value must be multiple of (pagesize * 2) */
 232#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 233
 234#else /* NO_MMAP */
 235
 236/* This value must be multiple of (pagesize * 2) */
 237#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 238        (sizeof(void*) >= 8 \
 239                ?  1 * 1024 * 1024 * 1024 \
 240                : 32 * 1024 * 1024)
 241
 242#endif /* NO_MMAP */
 243
 244#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
 245#define on_disk_bytes(st) ((st).st_size)
 246#else
 247#define on_disk_bytes(st) ((st).st_blocks * 512)
 248#endif
 249
 250#define DEFAULT_PACKED_GIT_LIMIT \
 251        ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
 252
 253#ifdef NO_PREAD
 254#define pread git_pread
 255extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 256#endif
 257/*
 258 * Forward decl that will remind us if its twin in cache.h changes.
 259 * This function is used in compat/pread.c.  But we can't include
 260 * cache.h there.
 261 */
 262extern ssize_t read_in_full(int fd, void *buf, size_t count);
 263
 264#ifdef NO_SETENV
 265#define setenv gitsetenv
 266extern int gitsetenv(const char *, const char *, int);
 267#endif
 268
 269#ifdef NO_MKDTEMP
 270#define mkdtemp gitmkdtemp
 271extern char *gitmkdtemp(char *);
 272#endif
 273
 274#ifdef NO_MKSTEMPS
 275#define mkstemps gitmkstemps
 276extern int gitmkstemps(char *, int);
 277#endif
 278
 279#ifdef NO_UNSETENV
 280#define unsetenv gitunsetenv
 281extern void gitunsetenv(const char *);
 282#endif
 283
 284#ifdef NO_STRCASESTR
 285#define strcasestr gitstrcasestr
 286extern char *gitstrcasestr(const char *haystack, const char *needle);
 287#endif
 288
 289#ifdef NO_STRLCPY
 290#define strlcpy gitstrlcpy
 291extern size_t gitstrlcpy(char *, const char *, size_t);
 292#endif
 293
 294#ifdef NO_STRTOUMAX
 295#define strtoumax gitstrtoumax
 296extern uintmax_t gitstrtoumax(const char *, char **, int);
 297#endif
 298
 299#ifdef NO_HSTRERROR
 300#define hstrerror githstrerror
 301extern const char *githstrerror(int herror);
 302#endif
 303
 304#ifdef NO_MEMMEM
 305#define memmem gitmemmem
 306void *gitmemmem(const void *haystack, size_t haystacklen,
 307                const void *needle, size_t needlelen);
 308#endif
 309
 310#ifdef FREAD_READS_DIRECTORIES
 311#ifdef fopen
 312#undef fopen
 313#endif
 314#define fopen(a,b) git_fopen(a,b)
 315extern FILE *git_fopen(const char*, const char*);
 316#endif
 317
 318#ifdef SNPRINTF_RETURNS_BOGUS
 319#define snprintf git_snprintf
 320extern int git_snprintf(char *str, size_t maxsize,
 321                        const char *format, ...);
 322#define vsnprintf git_vsnprintf
 323extern int git_vsnprintf(char *str, size_t maxsize,
 324                         const char *format, va_list ap);
 325#endif
 326
 327#ifdef __GLIBC_PREREQ
 328#if __GLIBC_PREREQ(2, 1)
 329#define HAVE_STRCHRNUL
 330#endif
 331#endif
 332
 333#ifndef HAVE_STRCHRNUL
 334#define strchrnul gitstrchrnul
 335static inline char *gitstrchrnul(const char *s, int c)
 336{
 337        while (*s && *s != c)
 338                s++;
 339        return (char *)s;
 340}
 341#endif
 342
 343extern void release_pack_memory(size_t, int);
 344
 345extern char *xstrdup(const char *str);
 346extern void *xmalloc(size_t size);
 347extern void *xmemdupz(const void *data, size_t len);
 348extern char *xstrndup(const char *str, size_t len);
 349extern void *xrealloc(void *ptr, size_t size);
 350extern void *xcalloc(size_t nmemb, size_t size);
 351extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 352extern ssize_t xread(int fd, void *buf, size_t len);
 353extern ssize_t xwrite(int fd, const void *buf, size_t len);
 354extern int xdup(int fd);
 355extern FILE *xfdopen(int fd, const char *mode);
 356extern int xmkstemp(char *template);
 357extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
 358extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
 359
 360static inline size_t xsize_t(off_t len)
 361{
 362        return (size_t)len;
 363}
 364
 365static inline int has_extension(const char *filename, const char *ext)
 366{
 367        size_t len = strlen(filename);
 368        size_t extlen = strlen(ext);
 369        return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 370}
 371
 372/* Sane ctype - no locale, and works with signed chars */
 373#undef isascii
 374#undef isspace
 375#undef isdigit
 376#undef isalpha
 377#undef isalnum
 378#undef tolower
 379#undef toupper
 380extern unsigned char sane_ctype[256];
 381#define GIT_SPACE 0x01
 382#define GIT_DIGIT 0x02
 383#define GIT_ALPHA 0x04
 384#define GIT_GLOB_SPECIAL 0x08
 385#define GIT_REGEX_SPECIAL 0x10
 386#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 387#define isascii(x) (((x) & ~0x7f) == 0)
 388#define isspace(x) sane_istest(x,GIT_SPACE)
 389#define isdigit(x) sane_istest(x,GIT_DIGIT)
 390#define isalpha(x) sane_istest(x,GIT_ALPHA)
 391#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 392#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
 393#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
 394#define tolower(x) sane_case((unsigned char)(x), 0x20)
 395#define toupper(x) sane_case((unsigned char)(x), 0)
 396
 397static inline int sane_case(int x, int high)
 398{
 399        if (sane_istest(x, GIT_ALPHA))
 400                x = (x & ~0x20) | high;
 401        return x;
 402}
 403
 404static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 405{
 406        unsigned long ul;
 407        char *p;
 408
 409        errno = 0;
 410        ul = strtoul(s, &p, base);
 411        if (errno || *p || p == s || (unsigned int) ul != ul)
 412                return -1;
 413        *result = ul;
 414        return 0;
 415}
 416
 417static inline int strtol_i(char const *s, int base, int *result)
 418{
 419        long ul;
 420        char *p;
 421
 422        errno = 0;
 423        ul = strtol(s, &p, base);
 424        if (errno || *p || p == s || (int) ul != ul)
 425                return -1;
 426        *result = ul;
 427        return 0;
 428}
 429
 430#ifdef INTERNAL_QSORT
 431void git_qsort(void *base, size_t nmemb, size_t size,
 432               int(*compar)(const void *, const void *));
 433#define qsort git_qsort
 434#endif
 435
 436#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
 437# define FORCE_DIR_SET_GID S_ISGID
 438#else
 439# define FORCE_DIR_SET_GID 0
 440#endif
 441
 442#ifdef NO_NSEC
 443#undef USE_NSEC
 444#define ST_CTIME_NSEC(st) 0
 445#define ST_MTIME_NSEC(st) 0
 446#else
 447#ifdef USE_ST_TIMESPEC
 448#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
 449#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
 450#else
 451#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
 452#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
 453#endif
 454#endif
 455
 456#ifdef UNRELIABLE_FSTAT
 457#define fstat_is_reliable() 0
 458#else
 459#define fstat_is_reliable() 1
 460#endif
 461
 462/*
 463 * Preserves errno, prints a message, but gives no warning for ENOENT.
 464 * Always returns the return value of unlink(2).
 465 */
 466int unlink_or_warn(const char *path);
 467
 468#endif