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