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