git-compat-util.hon commit provide a facility for "delayed" progress reporting (180a9f2)
   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#if defined(__GNUC__) && (__GNUC__ < 3)
   8#define FLEX_ARRAY 0
   9#else
  10#define FLEX_ARRAY /* empty */
  11#endif
  12#endif
  13
  14#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
  15
  16#ifdef __GNUC__
  17#define TYPEOF(x) (__typeof__(x))
  18#else
  19#define TYPEOF(x)
  20#endif
  21
  22#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
  23
  24#if !defined(__APPLE__) && !defined(__FreeBSD__)
  25#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
  26#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
  27#endif
  28#define _ALL_SOURCE 1
  29#define _GNU_SOURCE 1
  30#define _BSD_SOURCE 1
  31
  32#include <unistd.h>
  33#include <stdio.h>
  34#include <sys/stat.h>
  35#include <fcntl.h>
  36#include <stddef.h>
  37#include <stdlib.h>
  38#include <stdarg.h>
  39#include <string.h>
  40#include <errno.h>
  41#include <limits.h>
  42#include <sys/param.h>
  43#include <sys/types.h>
  44#include <dirent.h>
  45#include <sys/time.h>
  46#include <time.h>
  47#include <signal.h>
  48#include <sys/wait.h>
  49#include <fnmatch.h>
  50#include <sys/poll.h>
  51#include <sys/socket.h>
  52#include <assert.h>
  53#include <regex.h>
  54#include <netinet/in.h>
  55#include <netinet/tcp.h>
  56#include <arpa/inet.h>
  57#include <netdb.h>
  58#include <pwd.h>
  59#include <inttypes.h>
  60#if defined(__CYGWIN__)
  61#undef _XOPEN_SOURCE
  62#include <grp.h>
  63#define _XOPEN_SOURCE 600
  64#else
  65#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
  66#include <grp.h>
  67#define _ALL_SOURCE 1
  68#endif
  69
  70#ifndef NO_ICONV
  71#include <iconv.h>
  72#endif
  73
  74/* On most systems <limits.h> would have given us this, but
  75 * not on some systems (e.g. GNU/Hurd).
  76 */
  77#ifndef PATH_MAX
  78#define PATH_MAX 4096
  79#endif
  80
  81#ifndef PRIuMAX
  82#define PRIuMAX "llu"
  83#endif
  84
  85#ifdef __GNUC__
  86#define NORETURN __attribute__((__noreturn__))
  87#else
  88#define NORETURN
  89#ifndef __attribute__
  90#define __attribute__(x)
  91#endif
  92#endif
  93
  94/* General helper functions */
  95extern void usage(const char *err) NORETURN;
  96extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
  97extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
  98extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
  99
 100extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
 101extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
 102extern void set_error_routine(void (*routine)(const char *err, va_list params));
 103extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
 104
 105#ifdef NO_MMAP
 106
 107#ifndef PROT_READ
 108#define PROT_READ 1
 109#define PROT_WRITE 2
 110#define MAP_PRIVATE 1
 111#define MAP_FAILED ((void*)-1)
 112#endif
 113
 114#define mmap git_mmap
 115#define munmap git_munmap
 116extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 117extern int git_munmap(void *start, size_t length);
 118
 119/* This value must be multiple of (pagesize * 2) */
 120#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 121
 122#else /* NO_MMAP */
 123
 124#include <sys/mman.h>
 125
 126/* This value must be multiple of (pagesize * 2) */
 127#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 128        (sizeof(void*) >= 8 \
 129                ?  1 * 1024 * 1024 * 1024 \
 130                : 32 * 1024 * 1024)
 131
 132#endif /* NO_MMAP */
 133
 134#define DEFAULT_PACKED_GIT_LIMIT \
 135        ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
 136
 137#ifdef NO_PREAD
 138#define pread git_pread
 139extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 140#endif
 141
 142#ifdef NO_SETENV
 143#define setenv gitsetenv
 144extern int gitsetenv(const char *, const char *, int);
 145#endif
 146
 147#ifdef NO_UNSETENV
 148#define unsetenv gitunsetenv
 149extern void gitunsetenv(const char *);
 150#endif
 151
 152#ifdef NO_STRCASESTR
 153#define strcasestr gitstrcasestr
 154extern char *gitstrcasestr(const char *haystack, const char *needle);
 155#endif
 156
 157#ifdef NO_STRLCPY
 158#define strlcpy gitstrlcpy
 159extern size_t gitstrlcpy(char *, const char *, size_t);
 160#endif
 161
 162#ifdef NO_STRTOUMAX
 163#define strtoumax gitstrtoumax
 164extern uintmax_t gitstrtoumax(const char *, char **, int);
 165#endif
 166
 167extern void release_pack_memory(size_t);
 168
 169static inline char* xstrdup(const char *str)
 170{
 171        char *ret = strdup(str);
 172        if (!ret) {
 173                release_pack_memory(strlen(str) + 1);
 174                ret = strdup(str);
 175                if (!ret)
 176                        die("Out of memory, strdup failed");
 177        }
 178        return ret;
 179}
 180
 181static inline void *xmalloc(size_t size)
 182{
 183        void *ret = malloc(size);
 184        if (!ret && !size)
 185                ret = malloc(1);
 186        if (!ret) {
 187                release_pack_memory(size);
 188                ret = malloc(size);
 189                if (!ret && !size)
 190                        ret = malloc(1);
 191                if (!ret)
 192                        die("Out of memory, malloc failed");
 193        }
 194#ifdef XMALLOC_POISON
 195        memset(ret, 0xA5, size);
 196#endif
 197        return ret;
 198}
 199
 200static inline void *xrealloc(void *ptr, size_t size)
 201{
 202        void *ret = realloc(ptr, size);
 203        if (!ret && !size)
 204                ret = realloc(ptr, 1);
 205        if (!ret) {
 206                release_pack_memory(size);
 207                ret = realloc(ptr, size);
 208                if (!ret && !size)
 209                        ret = realloc(ptr, 1);
 210                if (!ret)
 211                        die("Out of memory, realloc failed");
 212        }
 213        return ret;
 214}
 215
 216static inline void *xcalloc(size_t nmemb, size_t size)
 217{
 218        void *ret = calloc(nmemb, size);
 219        if (!ret && (!nmemb || !size))
 220                ret = calloc(1, 1);
 221        if (!ret) {
 222                release_pack_memory(nmemb * size);
 223                ret = calloc(nmemb, size);
 224                if (!ret && (!nmemb || !size))
 225                        ret = calloc(1, 1);
 226                if (!ret)
 227                        die("Out of memory, calloc failed");
 228        }
 229        return ret;
 230}
 231
 232static inline void *xmmap(void *start, size_t length,
 233        int prot, int flags, int fd, off_t offset)
 234{
 235        void *ret = mmap(start, length, prot, flags, fd, offset);
 236        if (ret == MAP_FAILED) {
 237                if (!length)
 238                        return NULL;
 239                release_pack_memory(length);
 240                ret = mmap(start, length, prot, flags, fd, offset);
 241                if (ret == MAP_FAILED)
 242                        die("Out of memory? mmap failed: %s", strerror(errno));
 243        }
 244        return ret;
 245}
 246
 247static inline ssize_t xread(int fd, void *buf, size_t len)
 248{
 249        ssize_t nr;
 250        while (1) {
 251                nr = read(fd, buf, len);
 252                if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
 253                        continue;
 254                return nr;
 255        }
 256}
 257
 258static inline ssize_t xwrite(int fd, const void *buf, size_t len)
 259{
 260        ssize_t nr;
 261        while (1) {
 262                nr = write(fd, buf, len);
 263                if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
 264                        continue;
 265                return nr;
 266        }
 267}
 268
 269static inline size_t xsize_t(off_t len)
 270{
 271        return (size_t)len;
 272}
 273
 274static inline int has_extension(const char *filename, const char *ext)
 275{
 276        size_t len = strlen(filename);
 277        size_t extlen = strlen(ext);
 278        return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 279}
 280
 281/* Sane ctype - no locale, and works with signed chars */
 282#undef isspace
 283#undef isdigit
 284#undef isalpha
 285#undef isalnum
 286#undef tolower
 287#undef toupper
 288extern unsigned char sane_ctype[256];
 289#define GIT_SPACE 0x01
 290#define GIT_DIGIT 0x02
 291#define GIT_ALPHA 0x04
 292#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 293#define isspace(x) sane_istest(x,GIT_SPACE)
 294#define isdigit(x) sane_istest(x,GIT_DIGIT)
 295#define isalpha(x) sane_istest(x,GIT_ALPHA)
 296#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 297#define tolower(x) sane_case((unsigned char)(x), 0x20)
 298#define toupper(x) sane_case((unsigned char)(x), 0)
 299
 300static inline int sane_case(int x, int high)
 301{
 302        if (sane_istest(x, GIT_ALPHA))
 303                x = (x & ~0x20) | high;
 304        return x;
 305}
 306
 307static inline int prefixcmp(const char *str, const char *prefix)
 308{
 309        return strncmp(str, prefix, strlen(prefix));
 310}
 311
 312static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 313{
 314        unsigned long ul;
 315        char *p;
 316
 317        errno = 0;
 318        ul = strtoul(s, &p, base);
 319        if (errno || *p || p == s || (unsigned int) ul != ul)
 320                return -1;
 321        *result = ul;
 322        return 0;
 323}
 324
 325#endif