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) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
  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 #define bitsizeof(x)  (CHAR_BIT * sizeof(x))
  30
  31 #ifdef __GNUC__
  32 #define TYPEOF(x) (__typeof__(x))
  33 #else
  34 #define TYPEOF(x)
  35 #endif
  36
  37 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
  38 #define HAS_MULTI_BITS(i)  ((i) & ((i) - 1))  /* checks if an integer has more than 1 bit set */
  39
  40 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
  41
  42 /* Approximation of the length of the decimal representation of this type. */
  43 #define decimal_length(x)       ((int)(sizeof(x) * 2.56 + 0.5) + 1)
  44
  45 #if defined(__sun__)
  46  /*
  47   * On Solaris, when _XOPEN_EXTENDED is set, its header file
  48   * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
  49   * setting to say we are XPG5 or XPG6.  Also on Solaris,
  50   * XPG6 programs must be compiled with a c99 compiler, while
  51   * non XPG6 programs must be compiled with a pre-c99 compiler.
  52   */
  53 # if __STDC_VERSION__ - 0 >= 199901L
  54 # define _XOPEN_SOURCE 600
  55 # else
  56 # define _XOPEN_SOURCE 500
  57 # endif
  58 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
  59       !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__)
  60 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
  61 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
  62 #endif
  63 #define _ALL_SOURCE 1
  64 #define _GNU_SOURCE 1
  65 #define _BSD_SOURCE 1
  66 #define _NETBSD_SOURCE 1
  67 #define _SGI_SOURCE 1
  68
  69 #ifdef WIN32 /* Both MinGW and MSVC */
  70 #define WIN32_LEAN_AND_MEAN  /* stops windows.h including winsock.h */
  71 #include <winsock2.h>
  72 #include <windows.h>
  73 #endif
  74
  75 #include <unistd.h>
  76 #include <stdio.h>
  77 #include <sys/stat.h>
  78 #include <fcntl.h>
  79 #include <stddef.h>
  80 #include <stdlib.h>
  81 #include <stdarg.h>
  82 #include <string.h>
  83 #include <errno.h>
  84 #include <limits.h>
  85 #include <sys/param.h>
  86 #include <sys/types.h>
  87 #include <dirent.h>
  88 #include <sys/time.h>
  89 #include <time.h>
  90 #include <signal.h>
  91 #include <fnmatch.h>
  92 #include <assert.h>
  93 #include <regex.h>
  94 #include <utime.h>
  95 #ifndef __MINGW32__
  96 #include <sys/wait.h>
  97 #include <sys/poll.h>
  98 #include <sys/socket.h>
  99 #include <sys/ioctl.h>
 100 #include <termios.h>
 101 #ifndef NO_SYS_SELECT_H
 102 #include <sys/select.h>
 103 #endif
 104 #include <netinet/in.h>
 105 #include <netinet/tcp.h>
 106 #include <arpa/inet.h>
 107 #include <netdb.h>
 108 #include <pwd.h>
 109 #include <inttypes.h>
 110 #if defined(__CYGWIN__)
 111 #undef _XOPEN_SOURCE
 112 #include <grp.h>
 113 #define _XOPEN_SOURCE 600
 114 #include "compat/cygwin.h"
 115 #else
 116 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
 117 #include <grp.h>
 118 #define _ALL_SOURCE 1
 119 #endif
 120 #else   /* __MINGW32__ */
 121 /* pull in Windows compatibility stuff */
 122 #include "compat/mingw.h"
 123 #endif  /* __MINGW32__ */
 124 #ifdef _MSC_VER
 125 #include "compat/msvc.h"
 126 #endif
 127
 128 #ifndef NO_LIBGEN_H
 129 #include <libgen.h>
 130 #else
 131 #define basename gitbasename
 132 extern char *gitbasename(char *);
 133 #endif
 134
 135 #ifndef NO_ICONV
 136 #include <iconv.h>
 137 #endif
 138
 139 #ifndef NO_OPENSSL
 140 #include <openssl/ssl.h>
 141 #include <openssl/err.h>
 142 #endif
 143
 144 /* On most systems <limits.h> would have given us this, but
 145  * not on some systems (e.g. GNU/Hurd).
 146  */
 147 #ifndef PATH_MAX
 148 #define PATH_MAX 4096
 149 #endif
 150
 151 #ifndef PRIuMAX
 152 #define PRIuMAX "llu"
 153 #endif
 154
 155 #ifndef PRIu32
 156 #define PRIu32 "u"
 157 #endif
 158
 159 #ifndef PRIx32
 160 #define PRIx32 "x"
 161 #endif
 162
 163 #ifndef PATH_SEP
 164 #define PATH_SEP ':'
 165 #endif
 166
 167 #ifdef HAVE_PATHS_H
 168 #include <paths.h>
 169 #endif
 170 #ifndef _PATH_DEFPATH
 171 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
 172 #endif
 173
 174 #ifndef STRIP_EXTENSION
 175 #define STRIP_EXTENSION ""
 176 #endif
 177
 178 #ifndef has_dos_drive_prefix
 179 #define has_dos_drive_prefix(path) 0
 180 #endif
 181
 182 #ifndef offset_1st_component
 183 #define offset_1st_component(path) (is_dir_sep((path)[0]))
 184 #endif
 185
 186 #ifndef is_dir_sep
 187 #define is_dir_sep(c) ((c) == '/')
 188 #endif
 189
 190 #ifdef __GNUC__
 191 #define NORETURN __attribute__((__noreturn__))
 192 #define NORETURN_PTR __attribute__((__noreturn__))
 193 #elif defined(_MSC_VER)
 194 #define NORETURN __declspec(noreturn)
 195 #define NORETURN_PTR
 196 #else
 197 #define NORETURN
 198 #define NORETURN_PTR
 199 #ifndef __attribute__
 200 #define __attribute__(x)
 201 #endif
 202 #endif
 203
 204 #include "compat/bswap.h"
 205
 206 /* General helper functions */
 207 extern void vreportf(const char *prefix, const char *err, va_list params);
 208 extern NORETURN void usage(const char *err);
 209 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
 210 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
 211 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 212 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 213 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 214
 215 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
 216
 217 extern int prefixcmp(const char *str, const char *prefix);
 218 extern int suffixcmp(const char *str, const char *suffix);
 219
 220 static inline const char *skip_prefix(const char *str, const char *prefix)
 221 {
 222         size_t len = strlen(prefix);
 223         return strncmp(str, prefix, len) ? NULL : str + len;
 224 }
 225
 226 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
 227
 228 #ifndef PROT_READ
 229 #define PROT_READ 1
 230 #define PROT_WRITE 2
 231 #define MAP_PRIVATE 1
 232 #endif
 233
 234 #define mmap git_mmap
 235 #define munmap git_munmap
 236 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 237 extern int git_munmap(void *start, size_t length);
 238
 239 #else /* NO_MMAP || USE_WIN32_MMAP */
 240
 241 #include <sys/mman.h>
 242
 243 #endif /* NO_MMAP || USE_WIN32_MMAP */
 244
 245 #ifdef NO_MMAP
 246
 247 /* This value must be multiple of (pagesize * 2) */
 248 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 249
 250 #else /* NO_MMAP */
 251
 252 /* This value must be multiple of (pagesize * 2) */
 253 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 254         (sizeof(void*) >= 8 \
 255                 ?  1 * 1024 * 1024 * 1024 \
 256                 : 32 * 1024 * 1024)
 257
 258 #endif /* NO_MMAP */
 259
 260 #ifndef MAP_FAILED
 261 #define MAP_FAILED ((void *)-1)
 262 #endif
 263
 264 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
 265 #define on_disk_bytes(st) ((st).st_size)
 266 #else
 267 #define on_disk_bytes(st) ((st).st_blocks * 512)
 268 #endif
 269
 270 #define DEFAULT_PACKED_GIT_LIMIT \
 271         ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
 272
 273 #ifdef NO_PREAD
 274 #define pread git_pread
 275 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 276 #endif
 277 /*
 278  * Forward decl that will remind us if its twin in cache.h changes.
 279  * This function is used in compat/pread.c.  But we can't include
 280  * cache.h there.
 281  */
 282 extern ssize_t read_in_full(int fd, void *buf, size_t count);
 283
 284 #ifdef NO_SETENV
 285 #define setenv gitsetenv
 286 extern int gitsetenv(const char *, const char *, int);
 287 #endif
 288
 289 #ifdef NO_MKDTEMP
 290 #define mkdtemp gitmkdtemp
 291 extern char *gitmkdtemp(char *);
 292 #endif
 293
 294 #ifdef NO_MKSTEMPS
 295 #define mkstemps gitmkstemps
 296 extern int gitmkstemps(char *, int);
 297 #endif
 298
 299 #ifdef NO_UNSETENV
 300 #define unsetenv gitunsetenv
 301 extern void gitunsetenv(const char *);
 302 #endif
 303
 304 #ifdef NO_STRCASESTR
 305 #define strcasestr gitstrcasestr
 306 extern char *gitstrcasestr(const char *haystack, const char *needle);
 307 #endif
 308
 309 #ifdef NO_STRLCPY
 310 #define strlcpy gitstrlcpy
 311 extern size_t gitstrlcpy(char *, const char *, size_t);
 312 #endif
 313
 314 #ifdef NO_STRTOUMAX
 315 #define strtoumax gitstrtoumax
 316 extern uintmax_t gitstrtoumax(const char *, char **, int);
 317 #endif
 318
 319 #ifdef NO_HSTRERROR
 320 #define hstrerror githstrerror
 321 extern const char *githstrerror(int herror);
 322 #endif
 323
 324 #ifdef NO_MEMMEM
 325 #define memmem gitmemmem
 326 void *gitmemmem(const void *haystack, size_t haystacklen,
 327                 const void *needle, size_t needlelen);
 328 #endif
 329
 330 #ifdef FREAD_READS_DIRECTORIES
 331 #ifdef fopen
 332 #undef fopen
 333 #endif
 334 #define fopen(a,b) git_fopen(a,b)
 335 extern FILE *git_fopen(const char*, const char*);
 336 #endif
 337
 338 #ifdef SNPRINTF_RETURNS_BOGUS
 339 #define snprintf git_snprintf
 340 extern int git_snprintf(char *str, size_t maxsize,
 341                         const char *format, ...);
 342 #define vsnprintf git_vsnprintf
 343 extern int git_vsnprintf(char *str, size_t maxsize,
 344                          const char *format, va_list ap);
 345 #endif
 346
 347 #ifdef __GLIBC_PREREQ
 348 #if __GLIBC_PREREQ(2, 1)
 349 #define HAVE_STRCHRNUL
 350 #define HAVE_MEMPCPY
 351 #endif
 352 #endif
 353
 354 #ifndef HAVE_STRCHRNUL
 355 #define strchrnul gitstrchrnul
 356 static inline char *gitstrchrnul(const char *s, int c)
 357 {
 358         while (*s && *s != c)
 359                 s++;
 360         return (char *)s;
 361 }
 362 #endif
 363
 364 #ifndef HAVE_MEMPCPY
 365 #define mempcpy gitmempcpy
 366 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
 367 {
 368         return (char *)memcpy(dest, src, n) + n;
 369 }
 370 #endif
 371
 372 extern void release_pack_memory(size_t, int);
 373
 374 typedef void (*try_to_free_t)(size_t);
 375 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
 376
 377 extern char *xstrdup(const char *str);
 378 extern void *xmalloc(size_t size);
 379 extern void *xmallocz(size_t size);
 380 extern void *xmemdupz(const void *data, size_t len);
 381 extern char *xstrndup(const char *str, size_t len);
 382 extern void *xrealloc(void *ptr, size_t size);
 383 extern void *xcalloc(size_t nmemb, size_t size);
 384 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 385 extern ssize_t xread(int fd, void *buf, size_t len);
 386 extern ssize_t xwrite(int fd, const void *buf, size_t len);
 387 extern int xdup(int fd);
 388 extern FILE *xfdopen(int fd, const char *mode);
 389 extern int xmkstemp(char *template);
 390 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
 391 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
 392
 393 static inline size_t xsize_t(off_t len)
 394 {
 395         return (size_t)len;
 396 }
 397
 398 static inline int has_extension(const char *filename, const char *ext)
 399 {
 400         size_t len = strlen(filename);
 401         size_t extlen = strlen(ext);
 402         return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 403 }
 404
 405 /* Sane ctype - no locale, and works with signed chars */
 406 #undef isascii
 407 #undef isspace
 408 #undef isdigit
 409 #undef isalpha
 410 #undef isalnum
 411 #undef tolower
 412 #undef toupper
 413 extern unsigned char sane_ctype[256];
 414 #define GIT_SPACE 0x01
 415 #define GIT_DIGIT 0x02
 416 #define GIT_ALPHA 0x04
 417 #define GIT_GLOB_SPECIAL 0x08
 418 #define GIT_REGEX_SPECIAL 0x10
 419 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 420 #define isascii(x) (((x) & ~0x7f) == 0)
 421 #define isspace(x) sane_istest(x,GIT_SPACE)
 422 #define isdigit(x) sane_istest(x,GIT_DIGIT)
 423 #define isalpha(x) sane_istest(x,GIT_ALPHA)
 424 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 425 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
 426 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
 427 #define tolower(x) sane_case((unsigned char)(x), 0x20)
 428 #define toupper(x) sane_case((unsigned char)(x), 0)
 429
 430 static inline int sane_case(int x, int high)
 431 {
 432         if (sane_istest(x, GIT_ALPHA))
 433                 x = (x & ~0x20) | high;
 434         return x;
 435 }
 436
 437 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 438 {
 439         unsigned long ul;
 440         char *p;
 441
 442         errno = 0;
 443         ul = strtoul(s, &p, base);
 444         if (errno || *p || p == s || (unsigned int) ul != ul)
 445                 return -1;
 446         *result = ul;
 447         return 0;
 448 }
 449
 450 static inline int strtol_i(char const *s, int base, int *result)
 451 {
 452         long ul;
 453         char *p;
 454
 455         errno = 0;
 456         ul = strtol(s, &p, base);
 457         if (errno || *p || p == s || (int) ul != ul)
 458                 return -1;
 459         *result = ul;
 460         return 0;
 461 }
 462
 463 #ifdef INTERNAL_QSORT
 464 void git_qsort(void *base, size_t nmemb, size_t size,
 465                int(*compar)(const void *, const void *));
 466 #define qsort git_qsort
 467 #endif
 468
 469 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
 470 # define FORCE_DIR_SET_GID S_ISGID
 471 #else
 472 # define FORCE_DIR_SET_GID 0
 473 #endif
 474
 475 #ifdef NO_NSEC
 476 #undef USE_NSEC
 477 #define ST_CTIME_NSEC(st) 0
 478 #define ST_MTIME_NSEC(st) 0
 479 #else
 480 #ifdef USE_ST_TIMESPEC
 481 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
 482 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
 483 #else
 484 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
 485 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
 486 #endif
 487 #endif
 488
 489 #ifdef UNRELIABLE_FSTAT
 490 #define fstat_is_reliable() 0
 491 #else
 492 #define fstat_is_reliable() 1
 493 #endif
 494
 495 /*
 496  * Preserves errno, prints a message, but gives no warning for ENOENT.
 497  * Always returns the return value of unlink(2).
 498  */
 499 int unlink_or_warn(const char *path);
 500 /*
 501  * Likewise for rmdir(2).
 502  */
 503 int rmdir_or_warn(const char *path);
 504 /*
 505  * Calls the correct function out of {unlink,rmdir}_or_warn based on
 506  * the supplied file mode.
 507  */
 508 int remove_or_warn(unsigned int mode, const char *path);
 509
 510 #ifndef mark_as_git_dir
 511 #define mark_as_git_dir(x) /* noop */
 512 #endif
 513
 514 #ifndef get_home_directory
 515 #define get_home_directory() getenv("HOME")
 516 #endif
 517
 518 #endif