git-compat-util.h

   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 #include "compat/cygwin.h"
  89 #else
  90 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
  91 #include <grp.h>
  92 #define _ALL_SOURCE 1
  93 #endif
  94 #else   /* __MINGW32__ */
  95 /* pull in Windows compatibility stuff */
  96 #include "compat/mingw.h"
  97 #endif  /* __MINGW32__ */
  98
  99 #ifndef NO_ICONV
 100 #include <iconv.h>
 101 #endif
 102
 103 #ifndef NO_OPENSSL
 104 #include <openssl/ssl.h>
 105 #include <openssl/err.h>
 106 #endif
 107
 108 /* On most systems <limits.h> would have given us this, but
 109  * not on some systems (e.g. GNU/Hurd).
 110  */
 111 #ifndef PATH_MAX
 112 #define PATH_MAX 4096
 113 #endif
 114
 115 #ifndef PRIuMAX
 116 #define PRIuMAX "llu"
 117 #endif
 118
 119 #ifndef PRIu32
 120 #define PRIu32 "u"
 121 #endif
 122
 123 #ifndef PRIx32
 124 #define PRIx32 "x"
 125 #endif
 126
 127 #ifndef PATH_SEP
 128 #define PATH_SEP ':'
 129 #endif
 130
 131 #ifndef STRIP_EXTENSION
 132 #define STRIP_EXTENSION ""
 133 #endif
 134
 135 #ifndef has_dos_drive_prefix
 136 #define has_dos_drive_prefix(path) 0
 137 #endif
 138
 139 #ifndef is_dir_sep
 140 #define is_dir_sep(c) ((c) == '/')
 141 #endif
 142
 143 #ifdef __GNUC__
 144 #define NORETURN __attribute__((__noreturn__))
 145 #else
 146 #define NORETURN
 147 #ifndef __attribute__
 148 #define __attribute__(x)
 149 #endif
 150 #endif
 151
 152 /* General helper functions */
 153 extern void usage(const char *err) NORETURN;
 154 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
 155 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 156 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 157
 158 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
 159
 160 extern int prefixcmp(const char *str, const char *prefix);
 161 extern time_t tm_to_time_t(const struct tm *tm);
 162
 163 static inline const char *skip_prefix(const char *str, const char *prefix)
 164 {
 165         size_t len = strlen(prefix);
 166         return strncmp(str, prefix, len) ? NULL : str + len;
 167 }
 168
 169 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
 170
 171 #ifndef PROT_READ
 172 #define PROT_READ 1
 173 #define PROT_WRITE 2
 174 #define MAP_PRIVATE 1
 175 #define MAP_FAILED ((void*)-1)
 176 #endif
 177
 178 #define mmap git_mmap
 179 #define munmap git_munmap
 180 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 181 extern int git_munmap(void *start, size_t length);
 182
 183 #else /* NO_MMAP || USE_WIN32_MMAP */
 184
 185 #include <sys/mman.h>
 186
 187 #endif /* NO_MMAP || USE_WIN32_MMAP */
 188
 189 #ifdef NO_MMAP
 190
 191 /* This value must be multiple of (pagesize * 2) */
 192 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 193
 194 #else /* NO_MMAP */
 195
 196 /* This value must be multiple of (pagesize * 2) */
 197 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 198         (sizeof(void*) >= 8 \
 199                 ?  1 * 1024 * 1024 * 1024 \
 200                 : 32 * 1024 * 1024)
 201
 202 #endif /* NO_MMAP */
 203
 204 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
 205 #define on_disk_bytes(st) ((st).st_size)
 206 #else
 207 #define on_disk_bytes(st) ((st).st_blocks * 512)
 208 #endif
 209
 210 #define DEFAULT_PACKED_GIT_LIMIT \
 211         ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
 212
 213 #ifdef NO_PREAD
 214 #define pread git_pread
 215 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 216 #endif
 217 /*
 218  * Forward decl that will remind us if its twin in cache.h changes.
 219  * This function is used in compat/pread.c.  But we can't include
 220  * cache.h there.
 221  */
 222 extern ssize_t read_in_full(int fd, void *buf, size_t count);
 223
 224 #ifdef NO_SETENV
 225 #define setenv gitsetenv
 226 extern int gitsetenv(const char *, const char *, int);
 227 #endif
 228
 229 #ifdef NO_MKDTEMP
 230 #define mkdtemp gitmkdtemp
 231 extern char *gitmkdtemp(char *);
 232 #endif
 233
 234 #ifdef NO_UNSETENV
 235 #define unsetenv gitunsetenv
 236 extern void gitunsetenv(const char *);
 237 #endif
 238
 239 #ifdef NO_STRCASESTR
 240 #define strcasestr gitstrcasestr
 241 extern char *gitstrcasestr(const char *haystack, const char *needle);
 242 #endif
 243
 244 #ifdef NO_STRLCPY
 245 #define strlcpy gitstrlcpy
 246 extern size_t gitstrlcpy(char *, const char *, size_t);
 247 #endif
 248
 249 #ifdef NO_STRTOUMAX
 250 #define strtoumax gitstrtoumax
 251 extern uintmax_t gitstrtoumax(const char *, char **, int);
 252 #endif
 253
 254 #ifdef NO_HSTRERROR
 255 #define hstrerror githstrerror
 256 extern const char *githstrerror(int herror);
 257 #endif
 258
 259 #ifdef NO_MEMMEM
 260 #define memmem gitmemmem
 261 void *gitmemmem(const void *haystack, size_t haystacklen,
 262                 const void *needle, size_t needlelen);
 263 #endif
 264
 265 #ifdef FREAD_READS_DIRECTORIES
 266 #ifdef fopen
 267 #undef fopen
 268 #endif
 269 #define fopen(a,b) git_fopen(a,b)
 270 extern FILE *git_fopen(const char*, const char*);
 271 #endif
 272
 273 #ifdef SNPRINTF_RETURNS_BOGUS
 274 #define snprintf git_snprintf
 275 extern int git_snprintf(char *str, size_t maxsize,
 276                         const char *format, ...);
 277 #define vsnprintf git_vsnprintf
 278 extern int git_vsnprintf(char *str, size_t maxsize,
 279                          const char *format, va_list ap);
 280 #endif
 281
 282 #ifdef __GLIBC_PREREQ
 283 #if __GLIBC_PREREQ(2, 1)
 284 #define HAVE_STRCHRNUL
 285 #endif
 286 #endif
 287
 288 #ifndef HAVE_STRCHRNUL
 289 #define strchrnul gitstrchrnul
 290 static inline char *gitstrchrnul(const char *s, int c)
 291 {
 292         while (*s && *s != c)
 293                 s++;
 294         return (char *)s;
 295 }
 296 #endif
 297
 298 extern void release_pack_memory(size_t, int);
 299
 300 extern char *xstrdup(const char *str);
 301 extern void *xmalloc(size_t size);
 302 extern void *xmemdupz(const void *data, size_t len);
 303 extern char *xstrndup(const char *str, size_t len);
 304 extern void *xrealloc(void *ptr, size_t size);
 305 extern void *xcalloc(size_t nmemb, size_t size);
 306 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 307 extern ssize_t xread(int fd, void *buf, size_t len);
 308 extern ssize_t xwrite(int fd, const void *buf, size_t len);
 309 extern int xdup(int fd);
 310 extern FILE *xfdopen(int fd, const char *mode);
 311 extern int xmkstemp(char *template);
 312 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
 313 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
 314
 315 static inline size_t xsize_t(off_t len)
 316 {
 317         return (size_t)len;
 318 }
 319
 320 static inline int has_extension(const char *filename, const char *ext)
 321 {
 322         size_t len = strlen(filename);
 323         size_t extlen = strlen(ext);
 324         return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 325 }
 326
 327 /* Sane ctype - no locale, and works with signed chars */
 328 #undef isascii
 329 #undef isspace
 330 #undef isdigit
 331 #undef isalpha
 332 #undef isalnum
 333 #undef tolower
 334 #undef toupper
 335 extern unsigned char sane_ctype[256];
 336 #define GIT_SPACE 0x01
 337 #define GIT_DIGIT 0x02
 338 #define GIT_ALPHA 0x04
 339 #define GIT_GLOB_SPECIAL 0x08
 340 #define GIT_REGEX_SPECIAL 0x10
 341 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 342 #define isascii(x) (((x) & ~0x7f) == 0)
 343 #define isspace(x) sane_istest(x,GIT_SPACE)
 344 #define isdigit(x) sane_istest(x,GIT_DIGIT)
 345 #define isalpha(x) sane_istest(x,GIT_ALPHA)
 346 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 347 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
 348 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
 349 #define tolower(x) sane_case((unsigned char)(x), 0x20)
 350 #define toupper(x) sane_case((unsigned char)(x), 0)
 351
 352 static inline int sane_case(int x, int high)
 353 {
 354         if (sane_istest(x, GIT_ALPHA))
 355                 x = (x & ~0x20) | high;
 356         return x;
 357 }
 358
 359 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 360 {
 361         unsigned long ul;
 362         char *p;
 363
 364         errno = 0;
 365         ul = strtoul(s, &p, base);
 366         if (errno || *p || p == s || (unsigned int) ul != ul)
 367                 return -1;
 368         *result = ul;
 369         return 0;
 370 }
 371
 372 static inline int strtol_i(char const *s, int base, int *result)
 373 {
 374         long ul;
 375         char *p;
 376
 377         errno = 0;
 378         ul = strtol(s, &p, base);
 379         if (errno || *p || p == s || (int) ul != ul)
 380                 return -1;
 381         *result = ul;
 382         return 0;
 383 }
 384
 385 #ifdef INTERNAL_QSORT
 386 void git_qsort(void *base, size_t nmemb, size_t size,
 387                int(*compar)(const void *, const void *));
 388 #define qsort git_qsort
 389 #endif
 390
 391 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
 392 # define FORCE_DIR_SET_GID S_ISGID
 393 #else
 394 # define FORCE_DIR_SET_GID 0
 395 #endif
 396
 397 #ifdef NO_NSEC
 398 #undef USE_NSEC
 399 #define ST_CTIME_NSEC(st) 0
 400 #define ST_MTIME_NSEC(st) 0
 401 #else
 402 #ifdef USE_ST_TIMESPEC
 403 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
 404 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
 405 #else
 406 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
 407 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
 408 #endif
 409 #endif
 410
 411 #endif