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