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