git-compat-util.hon commit git-p4: Clean up git-p4 submit's log message handling. (edae1e2)
   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__)
  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 <sys/wait.h>
  67#include <fnmatch.h>
  68#include <sys/poll.h>
  69#include <sys/socket.h>
  70#include <sys/ioctl.h>
  71#ifndef NO_SYS_SELECT_H
  72#include <sys/select.h>
  73#endif
  74#include <assert.h>
  75#include <regex.h>
  76#include <netinet/in.h>
  77#include <netinet/tcp.h>
  78#include <arpa/inet.h>
  79#include <netdb.h>
  80#include <pwd.h>
  81#include <inttypes.h>
  82#if defined(__CYGWIN__)
  83#undef _XOPEN_SOURCE
  84#include <grp.h>
  85#define _XOPEN_SOURCE 600
  86#else
  87#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
  88#include <grp.h>
  89#define _ALL_SOURCE 1
  90#endif
  91
  92#ifndef NO_ICONV
  93#include <iconv.h>
  94#endif
  95
  96/* On most systems <limits.h> would have given us this, but
  97 * not on some systems (e.g. GNU/Hurd).
  98 */
  99#ifndef PATH_MAX
 100#define PATH_MAX 4096
 101#endif
 102
 103#ifndef PRIuMAX
 104#define PRIuMAX "llu"
 105#endif
 106
 107#ifdef __GNUC__
 108#define NORETURN __attribute__((__noreturn__))
 109#else
 110#define NORETURN
 111#ifndef __attribute__
 112#define __attribute__(x)
 113#endif
 114#endif
 115
 116/* General helper functions */
 117extern void usage(const char *err) NORETURN;
 118extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
 119extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 120extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 121
 122extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
 123extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
 124extern void set_error_routine(void (*routine)(const char *err, va_list params));
 125extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
 126
 127extern int prefixcmp(const char *str, const char *prefix);
 128
 129#ifdef NO_MMAP
 130
 131#ifndef PROT_READ
 132#define PROT_READ 1
 133#define PROT_WRITE 2
 134#define MAP_PRIVATE 1
 135#define MAP_FAILED ((void*)-1)
 136#endif
 137
 138#define mmap git_mmap
 139#define munmap git_munmap
 140extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 141extern int git_munmap(void *start, size_t length);
 142
 143/* This value must be multiple of (pagesize * 2) */
 144#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 145
 146#else /* NO_MMAP */
 147
 148#include <sys/mman.h>
 149
 150/* This value must be multiple of (pagesize * 2) */
 151#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 152        (sizeof(void*) >= 8 \
 153                ?  1 * 1024 * 1024 * 1024 \
 154                : 32 * 1024 * 1024)
 155
 156#endif /* NO_MMAP */
 157
 158#define DEFAULT_PACKED_GIT_LIMIT \
 159        ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
 160
 161#ifdef NO_PREAD
 162#define pread git_pread
 163extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 164#endif
 165
 166#ifdef NO_SETENV
 167#define setenv gitsetenv
 168extern int gitsetenv(const char *, const char *, int);
 169#endif
 170
 171#ifdef NO_MKDTEMP
 172#define mkdtemp gitmkdtemp
 173extern char *gitmkdtemp(char *);
 174#endif
 175
 176#ifdef NO_UNSETENV
 177#define unsetenv gitunsetenv
 178extern void gitunsetenv(const char *);
 179#endif
 180
 181#ifdef NO_STRCASESTR
 182#define strcasestr gitstrcasestr
 183extern char *gitstrcasestr(const char *haystack, const char *needle);
 184#endif
 185
 186#ifdef NO_STRLCPY
 187#define strlcpy gitstrlcpy
 188extern size_t gitstrlcpy(char *, const char *, size_t);
 189#endif
 190
 191#ifdef NO_STRTOUMAX
 192#define strtoumax gitstrtoumax
 193extern uintmax_t gitstrtoumax(const char *, char **, int);
 194#endif
 195
 196#ifdef NO_HSTRERROR
 197#define hstrerror githstrerror
 198extern const char *githstrerror(int herror);
 199#endif
 200
 201#ifdef NO_MEMMEM
 202#define memmem gitmemmem
 203void *gitmemmem(const void *haystack, size_t haystacklen,
 204                const void *needle, size_t needlelen);
 205#endif
 206
 207#ifdef FREAD_READS_DIRECTORIES
 208#define fopen(a,b) git_fopen(a,b)
 209extern FILE *git_fopen(const char*, const char*);
 210#endif
 211
 212#ifdef __GLIBC_PREREQ
 213#if __GLIBC_PREREQ(2, 1)
 214#define HAVE_STRCHRNUL
 215#endif
 216#endif
 217
 218#ifndef HAVE_STRCHRNUL
 219#define strchrnul gitstrchrnul
 220static inline char *gitstrchrnul(const char *s, int c)
 221{
 222        while (*s && *s != c)
 223                s++;
 224        return (char *)s;
 225}
 226#endif
 227
 228extern void release_pack_memory(size_t, int);
 229
 230static inline char* xstrdup(const char *str)
 231{
 232        char *ret = strdup(str);
 233        if (!ret) {
 234                release_pack_memory(strlen(str) + 1, -1);
 235                ret = strdup(str);
 236                if (!ret)
 237                        die("Out of memory, strdup failed");
 238        }
 239        return ret;
 240}
 241
 242static inline void *xmalloc(size_t size)
 243{
 244        void *ret = malloc(size);
 245        if (!ret && !size)
 246                ret = malloc(1);
 247        if (!ret) {
 248                release_pack_memory(size, -1);
 249                ret = malloc(size);
 250                if (!ret && !size)
 251                        ret = malloc(1);
 252                if (!ret)
 253                        die("Out of memory, malloc failed");
 254        }
 255#ifdef XMALLOC_POISON
 256        memset(ret, 0xA5, size);
 257#endif
 258        return ret;
 259}
 260
 261static inline void *xmemdupz(const void *data, size_t len)
 262{
 263        char *p = xmalloc(len + 1);
 264        memcpy(p, data, len);
 265        p[len] = '\0';
 266        return p;
 267}
 268
 269static inline char *xstrndup(const char *str, size_t len)
 270{
 271        char *p = memchr(str, '\0', len);
 272        return xmemdupz(str, p ? p - str : len);
 273}
 274
 275static inline void *xrealloc(void *ptr, size_t size)
 276{
 277        void *ret = realloc(ptr, size);
 278        if (!ret && !size)
 279                ret = realloc(ptr, 1);
 280        if (!ret) {
 281                release_pack_memory(size, -1);
 282                ret = realloc(ptr, size);
 283                if (!ret && !size)
 284                        ret = realloc(ptr, 1);
 285                if (!ret)
 286                        die("Out of memory, realloc failed");
 287        }
 288        return ret;
 289}
 290
 291static inline void *xcalloc(size_t nmemb, size_t size)
 292{
 293        void *ret = calloc(nmemb, size);
 294        if (!ret && (!nmemb || !size))
 295                ret = calloc(1, 1);
 296        if (!ret) {
 297                release_pack_memory(nmemb * size, -1);
 298                ret = calloc(nmemb, size);
 299                if (!ret && (!nmemb || !size))
 300                        ret = calloc(1, 1);
 301                if (!ret)
 302                        die("Out of memory, calloc failed");
 303        }
 304        return ret;
 305}
 306
 307static inline void *xmmap(void *start, size_t length,
 308        int prot, int flags, int fd, off_t offset)
 309{
 310        void *ret = mmap(start, length, prot, flags, fd, offset);
 311        if (ret == MAP_FAILED) {
 312                if (!length)
 313                        return NULL;
 314                release_pack_memory(length, fd);
 315                ret = mmap(start, length, prot, flags, fd, offset);
 316                if (ret == MAP_FAILED)
 317                        die("Out of memory? mmap failed: %s", strerror(errno));
 318        }
 319        return ret;
 320}
 321
 322static inline ssize_t xread(int fd, void *buf, size_t len)
 323{
 324        ssize_t nr;
 325        while (1) {
 326                nr = read(fd, buf, len);
 327                if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
 328                        continue;
 329                return nr;
 330        }
 331}
 332
 333static inline ssize_t xwrite(int fd, const void *buf, size_t len)
 334{
 335        ssize_t nr;
 336        while (1) {
 337                nr = write(fd, buf, len);
 338                if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
 339                        continue;
 340                return nr;
 341        }
 342}
 343
 344static inline int xdup(int fd)
 345{
 346        int ret = dup(fd);
 347        if (ret < 0)
 348                die("dup failed: %s", strerror(errno));
 349        return ret;
 350}
 351
 352static inline FILE *xfdopen(int fd, const char *mode)
 353{
 354        FILE *stream = fdopen(fd, mode);
 355        if (stream == NULL)
 356                die("Out of memory? fdopen failed: %s", strerror(errno));
 357        return stream;
 358}
 359
 360static inline int xmkstemp(char *template)
 361{
 362        int fd;
 363
 364        fd = mkstemp(template);
 365        if (fd < 0)
 366                die("Unable to create temporary file: %s", strerror(errno));
 367        return fd;
 368}
 369
 370static inline size_t xsize_t(off_t len)
 371{
 372        return (size_t)len;
 373}
 374
 375static inline int has_extension(const char *filename, const char *ext)
 376{
 377        size_t len = strlen(filename);
 378        size_t extlen = strlen(ext);
 379        return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 380}
 381
 382/* Sane ctype - no locale, and works with signed chars */
 383#undef isspace
 384#undef isdigit
 385#undef isalpha
 386#undef isalnum
 387#undef tolower
 388#undef toupper
 389extern unsigned char sane_ctype[256];
 390#define GIT_SPACE 0x01
 391#define GIT_DIGIT 0x02
 392#define GIT_ALPHA 0x04
 393#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 394#define isspace(x) sane_istest(x,GIT_SPACE)
 395#define isdigit(x) sane_istest(x,GIT_DIGIT)
 396#define isalpha(x) sane_istest(x,GIT_ALPHA)
 397#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 398#define tolower(x) sane_case((unsigned char)(x), 0x20)
 399#define toupper(x) sane_case((unsigned char)(x), 0)
 400
 401static inline int sane_case(int x, int high)
 402{
 403        if (sane_istest(x, GIT_ALPHA))
 404                x = (x & ~0x20) | high;
 405        return x;
 406}
 407
 408static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 409{
 410        unsigned long ul;
 411        char *p;
 412
 413        errno = 0;
 414        ul = strtoul(s, &p, base);
 415        if (errno || *p || p == s || (unsigned int) ul != ul)
 416                return -1;
 417        *result = ul;
 418        return 0;
 419}
 420
 421static inline int strtol_i(char const *s, int base, int *result)
 422{
 423        long ul;
 424        char *p;
 425
 426        errno = 0;
 427        ul = strtol(s, &p, base);
 428        if (errno || *p || p == s || (int) ul != ul)
 429                return -1;
 430        *result = ul;
 431        return 0;
 432}
 433
 434#ifdef INTERNAL_QSORT
 435void git_qsort(void *base, size_t nmemb, size_t size,
 436               int(*compar)(const void *, const void *));
 437#define qsort git_qsort
 438#endif
 439
 440#endif