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 #ifndef STRIP_EXTENSION
 168 #define STRIP_EXTENSION ""
 169 #endif
 170
 171 #ifndef has_dos_drive_prefix
 172 #define has_dos_drive_prefix(path) 0
 173 #endif
 174
 175 #ifndef is_dir_sep
 176 #define is_dir_sep(c) ((c) == '/')
 177 #endif
 178
 179 #ifdef __GNUC__
 180 #define NORETURN __attribute__((__noreturn__))
 181 #define NORETURN_PTR __attribute__((__noreturn__))
 182 #elif defined(_MSC_VER)
 183 #define NORETURN __declspec(noreturn)
 184 #define NORETURN_PTR
 185 #else
 186 #define NORETURN
 187 #define NORETURN_PTR
 188 #ifndef __attribute__
 189 #define __attribute__(x)
 190 #endif
 191 #endif
 192
 193 #include "compat/bswap.h"
 194
 195 /* General helper functions */
 196 extern void vreportf(const char *prefix, const char *err, va_list params);
 197 extern NORETURN void usage(const char *err);
 198 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
 199 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
 200 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 201 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 202 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 203
 204 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
 205
 206 extern int prefixcmp(const char *str, const char *prefix);
 207 extern int suffixcmp(const char *str, const char *suffix);
 208
 209 static inline const char *skip_prefix(const char *str, const char *prefix)
 210 {
 211         size_t len = strlen(prefix);
 212         return strncmp(str, prefix, len) ? NULL : str + len;
 213 }
 214
 215 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
 216
 217 #ifndef PROT_READ
 218 #define PROT_READ 1
 219 #define PROT_WRITE 2
 220 #define MAP_PRIVATE 1
 221 #define MAP_FAILED ((void*)-1)
 222 #endif
 223
 224 #define mmap git_mmap
 225 #define munmap git_munmap
 226 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 227 extern int git_munmap(void *start, size_t length);
 228
 229 #else /* NO_MMAP || USE_WIN32_MMAP */
 230
 231 #include <sys/mman.h>
 232
 233 #endif /* NO_MMAP || USE_WIN32_MMAP */
 234
 235 #ifdef NO_MMAP
 236
 237 /* This value must be multiple of (pagesize * 2) */
 238 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 239
 240 #else /* NO_MMAP */
 241
 242 /* This value must be multiple of (pagesize * 2) */
 243 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 244         (sizeof(void*) >= 8 \
 245                 ?  1 * 1024 * 1024 * 1024 \
 246                 : 32 * 1024 * 1024)
 247
 248 #endif /* NO_MMAP */
 249
 250 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
 251 #define on_disk_bytes(st) ((st).st_size)
 252 #else
 253 #define on_disk_bytes(st) ((st).st_blocks * 512)
 254 #endif
 255
 256 #define DEFAULT_PACKED_GIT_LIMIT \
 257         ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
 258
 259 #ifdef NO_PREAD
 260 #define pread git_pread
 261 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 262 #endif
 263 /*
 264  * Forward decl that will remind us if its twin in cache.h changes.
 265  * This function is used in compat/pread.c.  But we can't include
 266  * cache.h there.
 267  */
 268 extern ssize_t read_in_full(int fd, void *buf, size_t count);
 269
 270 #ifdef NO_SETENV
 271 #define setenv gitsetenv
 272 extern int gitsetenv(const char *, const char *, int);
 273 #endif
 274
 275 #ifdef NO_MKDTEMP
 276 #define mkdtemp gitmkdtemp
 277 extern char *gitmkdtemp(char *);
 278 #endif
 279
 280 #ifdef NO_MKSTEMPS
 281 #define mkstemps gitmkstemps
 282 extern int gitmkstemps(char *, int);
 283 #endif
 284
 285 #ifdef NO_UNSETENV
 286 #define unsetenv gitunsetenv
 287 extern void gitunsetenv(const char *);
 288 #endif
 289
 290 #ifdef NO_STRCASESTR
 291 #define strcasestr gitstrcasestr
 292 extern char *gitstrcasestr(const char *haystack, const char *needle);
 293 #endif
 294
 295 #ifdef NO_STRLCPY
 296 #define strlcpy gitstrlcpy
 297 extern size_t gitstrlcpy(char *, const char *, size_t);
 298 #endif
 299
 300 #ifdef NO_STRTOUMAX
 301 #define strtoumax gitstrtoumax
 302 extern uintmax_t gitstrtoumax(const char *, char **, int);
 303 #endif
 304
 305 #ifdef NO_HSTRERROR
 306 #define hstrerror githstrerror
 307 extern const char *githstrerror(int herror);
 308 #endif
 309
 310 #ifdef NO_MEMMEM
 311 #define memmem gitmemmem
 312 void *gitmemmem(const void *haystack, size_t haystacklen,
 313                 const void *needle, size_t needlelen);
 314 #endif
 315
 316 #ifdef FREAD_READS_DIRECTORIES
 317 #ifdef fopen
 318 #undef fopen
 319 #endif
 320 #define fopen(a,b) git_fopen(a,b)
 321 extern FILE *git_fopen(const char*, const char*);
 322 #endif
 323
 324 #ifdef SNPRINTF_RETURNS_BOGUS
 325 #define snprintf git_snprintf
 326 extern int git_snprintf(char *str, size_t maxsize,
 327                         const char *format, ...);
 328 #define vsnprintf git_vsnprintf
 329 extern int git_vsnprintf(char *str, size_t maxsize,
 330                          const char *format, va_list ap);
 331 #endif
 332
 333 #ifdef __GLIBC_PREREQ
 334 #if __GLIBC_PREREQ(2, 1)
 335 #define HAVE_STRCHRNUL
 336 #define HAVE_MEMPCPY
 337 #endif
 338 #endif
 339
 340 #ifndef HAVE_STRCHRNUL
 341 #define strchrnul gitstrchrnul
 342 static inline char *gitstrchrnul(const char *s, int c)
 343 {
 344         while (*s && *s != c)
 345                 s++;
 346         return (char *)s;
 347 }
 348 #endif
 349
 350 #ifndef HAVE_MEMPCPY
 351 #define mempcpy gitmempcpy
 352 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
 353 {
 354         return (char *)memcpy(dest, src, n) + n;
 355 }
 356 #endif
 357
 358 extern void release_pack_memory(size_t, int);
 359
 360 extern char *xstrdup(const char *str);
 361 extern void *xmalloc(size_t size);
 362 extern void *xmallocz(size_t size);
 363 extern void *xmemdupz(const void *data, size_t len);
 364 extern char *xstrndup(const char *str, size_t len);
 365 extern void *xrealloc(void *ptr, size_t size);
 366 extern void *xcalloc(size_t nmemb, size_t size);
 367 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 368 extern ssize_t xread(int fd, void *buf, size_t len);
 369 extern ssize_t xwrite(int fd, const void *buf, size_t len);
 370 extern int xdup(int fd);
 371 extern FILE *xfdopen(int fd, const char *mode);
 372 extern int xmkstemp(char *template);
 373 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
 374 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
 375
 376 static inline size_t xsize_t(off_t len)
 377 {
 378         return (size_t)len;
 379 }
 380
 381 static inline int has_extension(const char *filename, const char *ext)
 382 {
 383         size_t len = strlen(filename);
 384         size_t extlen = strlen(ext);
 385         return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 386 }
 387
 388 /* Sane ctype - no locale, and works with signed chars */
 389 #undef isascii
 390 #undef isspace
 391 #undef isdigit
 392 #undef isalpha
 393 #undef isalnum
 394 #undef tolower
 395 #undef toupper
 396 extern unsigned char sane_ctype[256];
 397 #define GIT_SPACE 0x01
 398 #define GIT_DIGIT 0x02
 399 #define GIT_ALPHA 0x04
 400 #define GIT_GLOB_SPECIAL 0x08
 401 #define GIT_REGEX_SPECIAL 0x10
 402 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 403 #define isascii(x) (((x) & ~0x7f) == 0)
 404 #define isspace(x) sane_istest(x,GIT_SPACE)
 405 #define isdigit(x) sane_istest(x,GIT_DIGIT)
 406 #define isalpha(x) sane_istest(x,GIT_ALPHA)
 407 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 408 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
 409 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
 410 #define tolower(x) sane_case((unsigned char)(x), 0x20)
 411 #define toupper(x) sane_case((unsigned char)(x), 0)
 412
 413 static inline int sane_case(int x, int high)
 414 {
 415         if (sane_istest(x, GIT_ALPHA))
 416                 x = (x & ~0x20) | high;
 417         return x;
 418 }
 419
 420 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 421 {
 422         unsigned long ul;
 423         char *p;
 424
 425         errno = 0;
 426         ul = strtoul(s, &p, base);
 427         if (errno || *p || p == s || (unsigned int) ul != ul)
 428                 return -1;
 429         *result = ul;
 430         return 0;
 431 }
 432
 433 static inline int strtol_i(char const *s, int base, int *result)
 434 {
 435         long ul;
 436         char *p;
 437
 438         errno = 0;
 439         ul = strtol(s, &p, base);
 440         if (errno || *p || p == s || (int) ul != ul)
 441                 return -1;
 442         *result = ul;
 443         return 0;
 444 }
 445
 446 #ifdef INTERNAL_QSORT
 447 void git_qsort(void *base, size_t nmemb, size_t size,
 448                int(*compar)(const void *, const void *));
 449 #define qsort git_qsort
 450 #endif
 451
 452 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
 453 # define FORCE_DIR_SET_GID S_ISGID
 454 #else
 455 # define FORCE_DIR_SET_GID 0
 456 #endif
 457
 458 #ifdef NO_NSEC
 459 #undef USE_NSEC
 460 #define ST_CTIME_NSEC(st) 0
 461 #define ST_MTIME_NSEC(st) 0
 462 #else
 463 #ifdef USE_ST_TIMESPEC
 464 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
 465 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
 466 #else
 467 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
 468 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
 469 #endif
 470 #endif
 471
 472 #ifdef UNRELIABLE_FSTAT
 473 #define fstat_is_reliable() 0
 474 #else
 475 #define fstat_is_reliable() 1
 476 #endif
 477
 478 /*
 479  * Preserves errno, prints a message, but gives no warning for ENOENT.
 480  * Always returns the return value of unlink(2).
 481  */
 482 int unlink_or_warn(const char *path);
 483 /*
 484  * Likewise for rmdir(2).
 485  */
 486 int rmdir_or_warn(const char *path);
 487 /*
 488  * Calls the correct function out of {unlink,rmdir}_or_warn based on
 489  * the supplied file mode.
 490  */
 491 int remove_or_warn(unsigned int mode, const char *path);
 492
 493 #ifndef mark_as_git_dir
 494 #define mark_as_git_dir(x) /* noop */
 495 #endif
 496
 497 #endif