Andrew's git / gitweb.git / git-compat-util.h
?
git-compat-util.hon commit git-submodule - register submodule URL if adding in place (c2f9391)
   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)
  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(__APPLE__) && !defined(__FreeBSD__)  && !defined(__USLC__) && !defined(_M_UNIX)
  43#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
  44#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
  45#endif
  46#define _ALL_SOURCE 1
  47#define _GNU_SOURCE 1
  48#define _BSD_SOURCE 1
  49
  50#include <unistd.h>
  51#include <stdio.h>
  52#include <sys/stat.h>
  53#include <fcntl.h>
  54#include <stddef.h>
  55#include <stdlib.h>
  56#include <stdarg.h>
  57#include <string.h>
  58#include <errno.h>
  59#include <limits.h>
  60#include <sys/param.h>
  61#include <sys/types.h>
  62#include <dirent.h>
  63#include <sys/time.h>
  64#include <time.h>
  65#include <signal.h>
  66#include <fnmatch.h>
  67#include <assert.h>
  68#include <regex.h>
  69#include <utime.h>
  70#ifndef __MINGW32__
  71#include <sys/wait.h>
  72#include <sys/poll.h>
  73#include <sys/socket.h>
  74#include <sys/ioctl.h>
  75#ifndef NO_SYS_SELECT_H
  76#include <sys/select.h>
  77#endif
  78#include <netinet/in.h>
  79#include <netinet/tcp.h>
  80#include <arpa/inet.h>
  81#include <netdb.h>
  82#include <pwd.h>
  83#include <inttypes.h>
  84#if defined(__CYGWIN__)
  85#undef _XOPEN_SOURCE
  86#include <grp.h>
  87#define _XOPEN_SOURCE 600
  88#else
  89#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
  90#include <grp.h>
  91#define _ALL_SOURCE 1
  92#endif
  93#else   /* __MINGW32__ */
  94/* pull in Windows compatibility stuff */
  95#include "compat/mingw.h"
  96#endif  /* __MINGW32__ */
  97
  98#ifndef NO_ICONV
  99#include <iconv.h>
 100#endif
 101
 102/* On most systems <limits.h> would have given us this, but
 103 * not on some systems (e.g. GNU/Hurd).
 104 */
 105#ifndef PATH_MAX
 106#define PATH_MAX 4096
 107#endif
 108
 109#ifndef PRIuMAX
 110#define PRIuMAX "llu"
 111#endif
 112
 113#ifndef PRIu32
 114#define PRIu32 "u"
 115#endif
 116
 117#ifndef PRIx32
 118#define PRIx32 "x"
 119#endif
 120
 121#ifndef PATH_SEP
 122#define PATH_SEP ':'
 123#endif
 124
 125#ifndef STRIP_EXTENSION
 126#define STRIP_EXTENSION ""
 127#endif
 128
 129#ifndef has_dos_drive_prefix
 130#define has_dos_drive_prefix(path) 0
 131#endif
 132
 133#ifndef is_dir_sep
 134#define is_dir_sep(c) ((c) == '/')
 135#endif
 136
 137#ifdef __GNUC__
 138#define NORETURN __attribute__((__noreturn__))
 139#else
 140#define NORETURN
 141#ifndef __attribute__
 142#define __attribute__(x)
 143#endif
 144#endif
 145
 146/* General helper functions */
 147extern void usage(const char *err) NORETURN;
 148extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
 149extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 150extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 151
 152extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
 153extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
 154extern void set_error_routine(void (*routine)(const char *err, va_list params));
 155extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
 156
 157extern int prefixcmp(const char *str, const char *prefix);
 158extern time_t tm_to_time_t(const struct tm *tm);
 159
 160#ifdef NO_MMAP
 161
 162#ifndef PROT_READ
 163#define PROT_READ 1
 164#define PROT_WRITE 2
 165#define MAP_PRIVATE 1
 166#define MAP_FAILED ((void*)-1)
 167#endif
 168
 169#define mmap git_mmap
 170#define munmap git_munmap
 171extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 172extern int git_munmap(void *start, size_t length);
 173
 174/* This value must be multiple of (pagesize * 2) */
 175#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 176
 177#else /* NO_MMAP */
 178
 179#include <sys/mman.h>
 180
 181/* This value must be multiple of (pagesize * 2) */
 182#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 183        (sizeof(void*) >= 8 \
 184                ?  1 * 1024 * 1024 * 1024 \
 185                : 32 * 1024 * 1024)
 186
 187#endif /* NO_MMAP */
 188
 189#define DEFAULT_PACKED_GIT_LIMIT \
 190        ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
 191
 192#ifdef NO_PREAD
 193#define pread git_pread
 194extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 195#endif
 196/*
 197 * Forward decl that will remind us if its twin in cache.h changes.
 198 * This function is used in compat/pread.c.  But we can't include
 199 * cache.h there.
 200 */
 201extern ssize_t read_in_full(int fd, void *buf, size_t count);
 202
 203#ifdef NO_SETENV
 204#define setenv gitsetenv
 205extern int gitsetenv(const char *, const char *, int);
 206#endif
 207
 208#ifdef NO_MKDTEMP
 209#define mkdtemp gitmkdtemp
 210extern char *gitmkdtemp(char *);
 211#endif
 212
 213#ifdef NO_UNSETENV
 214#define unsetenv gitunsetenv
 215extern void gitunsetenv(const char *);
 216#endif
 217
 218#ifdef NO_STRCASESTR
 219#define strcasestr gitstrcasestr
 220extern char *gitstrcasestr(const char *haystack, const char *needle);
 221#endif
 222
 223#ifdef NO_STRLCPY
 224#define strlcpy gitstrlcpy
 225extern size_t gitstrlcpy(char *, const char *, size_t);
 226#endif
 227
 228#ifdef NO_STRTOUMAX
 229#define strtoumax gitstrtoumax
 230extern uintmax_t gitstrtoumax(const char *, char **, int);
 231#endif
 232
 233#ifdef NO_HSTRERROR
 234#define hstrerror githstrerror
 235extern const char *githstrerror(int herror);
 236#endif
 237
 238#ifdef NO_MEMMEM
 239#define memmem gitmemmem
 240void *gitmemmem(const void *haystack, size_t haystacklen,
 241                const void *needle, size_t needlelen);
 242#endif
 243
 244#ifdef FREAD_READS_DIRECTORIES
 245#ifdef fopen
 246#undef fopen
 247#endif
 248#define fopen(a,b) git_fopen(a,b)
 249extern FILE *git_fopen(const char*, const char*);
 250#endif
 251
 252#ifdef SNPRINTF_RETURNS_BOGUS
 253#define snprintf git_snprintf
 254extern int git_snprintf(char *str, size_t maxsize,
 255                        const char *format, ...);
 256#define vsnprintf git_vsnprintf
 257extern int git_vsnprintf(char *str, size_t maxsize,
 258                         const char *format, va_list ap);
 259#endif
 260
 261#ifdef __GLIBC_PREREQ
 262#if __GLIBC_PREREQ(2, 1)
 263#define HAVE_STRCHRNUL
 264#endif
 265#endif
 266
 267#ifndef HAVE_STRCHRNUL
 268#define strchrnul gitstrchrnul
 269static inline char *gitstrchrnul(const char *s, int c)
 270{
 271        while (*s && *s != c)
 272                s++;
 273        return (char *)s;
 274}
 275#endif
 276
 277extern void release_pack_memory(size_t, int);
 278
 279extern char *xstrdup(const char *str);
 280extern void *xmalloc(size_t size);
 281extern void *xmemdupz(const void *data, size_t len);
 282extern char *xstrndup(const char *str, size_t len);
 283extern void *xrealloc(void *ptr, size_t size);
 284extern void *xcalloc(size_t nmemb, size_t size);
 285extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 286extern ssize_t xread(int fd, void *buf, size_t len);
 287extern ssize_t xwrite(int fd, const void *buf, size_t len);
 288extern int xdup(int fd);
 289extern FILE *xfdopen(int fd, const char *mode);
 290extern int xmkstemp(char *template);
 291
 292static inline size_t xsize_t(off_t len)
 293{
 294        return (size_t)len;
 295}
 296
 297static inline int has_extension(const char *filename, const char *ext)
 298{
 299        size_t len = strlen(filename);
 300        size_t extlen = strlen(ext);
 301        return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 302}
 303
 304/* Sane ctype - no locale, and works with signed chars */
 305#undef isspace
 306#undef isdigit
 307#undef isalpha
 308#undef isalnum
 309#undef tolower
 310#undef toupper
 311extern unsigned char sane_ctype[256];
 312#define GIT_SPACE 0x01
 313#define GIT_DIGIT 0x02
 314#define GIT_ALPHA 0x04
 315#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 316#define isspace(x) sane_istest(x,GIT_SPACE)
 317#define isdigit(x) sane_istest(x,GIT_DIGIT)
 318#define isalpha(x) sane_istest(x,GIT_ALPHA)
 319#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 320#define tolower(x) sane_case((unsigned char)(x), 0x20)
 321#define toupper(x) sane_case((unsigned char)(x), 0)
 322
 323static inline int sane_case(int x, int high)
 324{
 325        if (sane_istest(x, GIT_ALPHA))
 326                x = (x & ~0x20) | high;
 327        return x;
 328}
 329
 330static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 331{
 332        unsigned long ul;
 333        char *p;
 334
 335        errno = 0;
 336        ul = strtoul(s, &p, base);
 337        if (errno || *p || p == s || (unsigned int) ul != ul)
 338                return -1;
 339        *result = ul;
 340        return 0;
 341}
 342
 343static inline int strtol_i(char const *s, int base, int *result)
 344{
 345        long ul;
 346        char *p;
 347
 348        errno = 0;
 349        ul = strtol(s, &p, base);
 350        if (errno || *p || p == s || (int) ul != ul)
 351                return -1;
 352        *result = ul;
 353        return 0;
 354}
 355
 356#ifdef INTERNAL_QSORT
 357void git_qsort(void *base, size_t nmemb, size_t size,
 358               int(*compar)(const void *, const void *));
 359#define qsort git_qsort
 360#endif
 361
 362#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
 363# define FORCE_DIR_SET_GID S_ISGID
 364#else
 365# define FORCE_DIR_SET_GID 0
 366#endif
 367
 368#endif