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 #if defined(__GNUC__) && (__GNUC__ < 3)
   8 #define FLEX_ARRAY 0
   9 #else
  10 #define FLEX_ARRAY /* empty */
  11 #endif
  12 #endif
  13
  14 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
  15
  16 #ifdef __GNUC__
  17 #define TYPEOF(x) (__typeof__(x))
  18 #else
  19 #define TYPEOF(x)
  20 #endif
  21
  22 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
  23
  24 /* Approximation of the length of the decimal representation of this type. */
  25 #define decimal_length(x)       ((int)(sizeof(x) * 2.56 + 0.5) + 1)
  26
  27 #if !defined(__APPLE__) && !defined(__FreeBSD__)
  28 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
  29 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
  30 #endif
  31 #define _ALL_SOURCE 1
  32 #define _GNU_SOURCE 1
  33 #define _BSD_SOURCE 1
  34
  35 #include <unistd.h>
  36 #include <stdio.h>
  37 #include <sys/stat.h>
  38 #include <fcntl.h>
  39 #include <stddef.h>
  40 #include <stdlib.h>
  41 #include <stdarg.h>
  42 #include <string.h>
  43 #include <errno.h>
  44 #include <limits.h>
  45 #include <sys/param.h>
  46 #include <sys/types.h>
  47 #include <dirent.h>
  48 #include <sys/time.h>
  49 #include <time.h>
  50 #include <signal.h>
  51 #include <fnmatch.h>
  52 #ifndef __MINGW32__
  53 #include <sys/wait.h>
  54 #include <sys/poll.h>
  55 #include <sys/socket.h>
  56 #include <sys/select.h>
  57 #endif
  58 #include <assert.h>
  59 #include <regex.h>
  60 #ifndef __MINGW32__
  61 #include <netinet/in.h>
  62 #include <netinet/tcp.h>
  63 #include <arpa/inet.h>
  64 #endif
  65 #ifndef NO_ETC_PASSWD
  66 #include <netdb.h>
  67 #include <pwd.h>
  68 #include <inttypes.h>
  69 #if defined(__CYGWIN__)
  70 #undef _XOPEN_SOURCE
  71 #include <grp.h>
  72 #define _XOPEN_SOURCE 600
  73 #else
  74 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
  75 #include <grp.h>
  76 #define _ALL_SOURCE 1
  77 #endif
  78 #endif
  79
  80 #ifndef NO_ICONV
  81 #include <iconv.h>
  82 #endif
  83
  84 /* On most systems <limits.h> would have given us this, but
  85  * not on some systems (e.g. GNU/Hurd).
  86  */
  87 #ifndef PATH_MAX
  88 #define PATH_MAX 4096
  89 #endif
  90
  91 #ifndef PRIuMAX
  92 #ifndef __MINGW32__
  93 #define PRIuMAX "llu"
  94 #else
  95 #define PRIuMAX "I64u"
  96 #endif
  97 #endif
  98
  99 #ifdef __GNUC__
 100 #define NORETURN __attribute__((__noreturn__))
 101 #else
 102 #define NORETURN
 103 #ifndef __attribute__
 104 #define __attribute__(x)
 105 #endif
 106 #endif
 107
 108 /* General helper functions */
 109 extern void usage(const char *err) NORETURN;
 110 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
 111 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 112 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 113
 114 extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
 115 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
 116 extern void set_error_routine(void (*routine)(const char *err, va_list params));
 117 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
 118
 119 #ifdef NO_MMAP
 120
 121 #ifndef PROT_READ
 122 #define PROT_READ 1
 123 #define PROT_WRITE 2
 124 #define MAP_PRIVATE 1
 125 #define MAP_FAILED ((void*)-1)
 126 #endif
 127
 128 #define mmap git_mmap
 129 #define munmap git_munmap
 130 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 131 extern int git_munmap(void *start, size_t length);
 132
 133 /* This value must be multiple of (pagesize * 2) */
 134 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 135
 136 #else /* NO_MMAP */
 137
 138 #include <sys/mman.h>
 139
 140 /* This value must be multiple of (pagesize * 2) */
 141 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 142         (sizeof(void*) >= 8 \
 143                 ?  1 * 1024 * 1024 * 1024 \
 144                 : 32 * 1024 * 1024)
 145
 146 #endif /* NO_MMAP */
 147
 148 #define DEFAULT_PACKED_GIT_LIMIT \
 149         ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
 150
 151 #ifdef NO_PREAD
 152 #define pread git_pread
 153 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 154 #endif
 155
 156 #ifdef NO_SETENV
 157 #define setenv gitsetenv
 158 extern int gitsetenv(const char *, const char *, int);
 159 #endif
 160
 161 #ifdef NO_UNSETENV
 162 #define unsetenv gitunsetenv
 163 extern void gitunsetenv(const char *);
 164 #endif
 165
 166 #ifdef NO_STRCASESTR
 167 #define strcasestr gitstrcasestr
 168 extern char *gitstrcasestr(const char *haystack, const char *needle);
 169 #endif
 170
 171 #ifdef NO_STRLCPY
 172 #define strlcpy gitstrlcpy
 173 extern size_t gitstrlcpy(char *, const char *, size_t);
 174 #endif
 175
 176 #ifdef NO_STRTOUMAX
 177 #define strtoumax gitstrtoumax
 178 extern uintmax_t gitstrtoumax(const char *, char **, int);
 179 #endif
 180
 181 #ifdef NO_HSTRERROR
 182 #define hstrerror githstrerror
 183 extern const char *githstrerror(int herror);
 184 #endif
 185
 186 extern void release_pack_memory(size_t, int);
 187
 188 static inline char* xstrdup(const char *str)
 189 {
 190         char *ret = strdup(str);
 191         if (!ret) {
 192                 release_pack_memory(strlen(str) + 1, -1);
 193                 ret = strdup(str);
 194                 if (!ret)
 195                         die("Out of memory, strdup failed");
 196         }
 197         return ret;
 198 }
 199
 200 static inline void *xmalloc(size_t size)
 201 {
 202         void *ret = malloc(size);
 203         if (!ret && !size)
 204                 ret = malloc(1);
 205         if (!ret) {
 206                 release_pack_memory(size, -1);
 207                 ret = malloc(size);
 208                 if (!ret && !size)
 209                         ret = malloc(1);
 210                 if (!ret)
 211                         die("Out of memory, malloc failed");
 212         }
 213 #ifdef XMALLOC_POISON
 214         memset(ret, 0xA5, size);
 215 #endif
 216         return ret;
 217 }
 218
 219 static inline char *xstrndup(const char *str, size_t len)
 220 {
 221         char *p;
 222
 223         p = memchr(str, '\0', len);
 224         if (p)
 225                 len = p - str;
 226         p = xmalloc(len + 1);
 227         memcpy(p, str, len);
 228         p[len] = '\0';
 229         return p;
 230 }
 231
 232 static inline void *xrealloc(void *ptr, size_t size)
 233 {
 234         void *ret = realloc(ptr, size);
 235         if (!ret && !size)
 236                 ret = realloc(ptr, 1);
 237         if (!ret) {
 238                 release_pack_memory(size, -1);
 239                 ret = realloc(ptr, size);
 240                 if (!ret && !size)
 241                         ret = realloc(ptr, 1);
 242                 if (!ret)
 243                         die("Out of memory, realloc failed");
 244         }
 245         return ret;
 246 }
 247
 248 static inline void *xcalloc(size_t nmemb, size_t size)
 249 {
 250         void *ret = calloc(nmemb, size);
 251         if (!ret && (!nmemb || !size))
 252                 ret = calloc(1, 1);
 253         if (!ret) {
 254                 release_pack_memory(nmemb * size, -1);
 255                 ret = calloc(nmemb, size);
 256                 if (!ret && (!nmemb || !size))
 257                         ret = calloc(1, 1);
 258                 if (!ret)
 259                         die("Out of memory, calloc failed");
 260         }
 261         return ret;
 262 }
 263
 264 static inline void *xmmap(void *start, size_t length,
 265         int prot, int flags, int fd, off_t offset)
 266 {
 267         void *ret = mmap(start, length, prot, flags, fd, offset);
 268         if (ret == MAP_FAILED) {
 269                 if (!length)
 270                         return NULL;
 271                 release_pack_memory(length, fd);
 272                 ret = mmap(start, length, prot, flags, fd, offset);
 273                 if (ret == MAP_FAILED)
 274                         die("Out of memory? mmap failed: %s", strerror(errno));
 275         }
 276         return ret;
 277 }
 278
 279 static inline ssize_t xread(int fd, void *buf, size_t len)
 280 {
 281         ssize_t nr;
 282         while (1) {
 283                 nr = read(fd, buf, len);
 284                 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
 285                         continue;
 286                 return nr;
 287         }
 288 }
 289
 290 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
 291 {
 292         ssize_t nr;
 293         while (1) {
 294                 nr = write(fd, buf, len);
 295                 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
 296                         continue;
 297                 return nr;
 298         }
 299 }
 300
 301 static inline int xdup(int fd)
 302 {
 303         int ret = dup(fd);
 304         if (ret < 0)
 305                 die("dup failed: %s", strerror(errno));
 306         return ret;
 307 }
 308
 309 static inline FILE *xfdopen(int fd, const char *mode)
 310 {
 311         FILE *stream = fdopen(fd, mode);
 312         if (stream == NULL)
 313                 die("Out of memory? fdopen failed: %s", strerror(errno));
 314         return stream;
 315 }
 316
 317 static inline size_t xsize_t(off_t len)
 318 {
 319         return (size_t)len;
 320 }
 321
 322 static inline int has_extension(const char *filename, const char *ext)
 323 {
 324         size_t len = strlen(filename);
 325         size_t extlen = strlen(ext);
 326         return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
 327 }
 328
 329 /* Sane ctype - no locale, and works with signed chars */
 330 #undef isspace
 331 #undef isdigit
 332 #undef isalpha
 333 #undef isalnum
 334 #undef tolower
 335 #undef toupper
 336 extern unsigned char sane_ctype[256];
 337 #define GIT_SPACE 0x01
 338 #define GIT_DIGIT 0x02
 339 #define GIT_ALPHA 0x04
 340 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 341 #define isspace(x) sane_istest(x,GIT_SPACE)
 342 #define isdigit(x) sane_istest(x,GIT_DIGIT)
 343 #define isalpha(x) sane_istest(x,GIT_ALPHA)
 344 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 345 #define tolower(x) sane_case((unsigned char)(x), 0x20)
 346 #define toupper(x) sane_case((unsigned char)(x), 0)
 347
 348 static inline int sane_case(int x, int high)
 349 {
 350         if (sane_istest(x, GIT_ALPHA))
 351                 x = (x & ~0x20) | high;
 352         return x;
 353 }
 354
 355 static inline int prefixcmp(const char *str, const char *prefix)
 356 {
 357         return strncmp(str, prefix, strlen(prefix));
 358 }
 359
 360 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 361 {
 362         unsigned long ul;
 363         char *p;
 364
 365         errno = 0;
 366         ul = strtoul(s, &p, base);
 367         if (errno || *p || p == s || (unsigned int) ul != ul)
 368                 return -1;
 369         *result = ul;
 370         return 0;
 371 }
 372
 373 #ifdef __MINGW32__
 374
 375 #ifndef S_ISLNK
 376 #define S_IFLNK    0120000 /* Symbolic link */
 377 #define S_ISLNK(x) (((x) & S_IFMT) == S_IFLNK)
 378 #define S_ISSOCK(x) 0
 379 #endif
 380
 381 #ifndef S_ISGRP
 382 #define S_ISGRP(x) 0
 383 #define S_IRGRP 0
 384 #define S_IWGRP 0
 385 #define S_IXGRP 0
 386 #define S_ISGID 0
 387 #define S_IROTH 0
 388 #define S_IXOTH 0
 389 #endif
 390
 391 #define S_IFSOCK 0
 392 #define S_ISUID 0
 393 #define S_ISVTX 0
 394 #define S_IRWXG 0
 395 #define S_IRWXO 0
 396 #define S_IWOTH 0
 397
 398 typedef int gid_t;
 399 typedef int uid_t;
 400
 401 int readlink(const char *path, char *buf, size_t bufsiz);
 402 int symlink(const char *oldpath, const char *newpath);
 403 #define link symlink
 404 int fchmod(int fildes, mode_t mode);
 405 int lstat(const char *file_name, struct stat *buf);
 406 char *strsep(char **stringp, const char *delim);
 407
 408 /* missing: link, mkstemp, fchmod, getuid (?), gettimeofday */
 409 int socketpair(int d, int type, int protocol, int sv[2]);
 410 int syslog(int type, char *bufp, ...);
 411 #define LOG_ERR 1
 412 #define LOG_INFO 2
 413 #define LOG_DAEMON 4
 414 unsigned int alarm(unsigned int seconds);
 415 #include <winsock2.h>
 416 void mingw_execve(const char *cmd, const char **argv, const char **env);
 417 #define execve mingw_execve
 418 int fork();
 419 typedef int pid_t;
 420 #define waitpid(pid, status, options) \
 421         ((options == 0) ? _cwait((status), (pid), 0) \
 422                 : (errno = EINVAL, -1))
 423 #define WIFEXITED(x) ((unsigned)(x) < 259)      /* STILL_ACTIVE */
 424 #define WEXITSTATUS(x) ((x) & 0xff)
 425 #define WIFSIGNALED(x) ((unsigned)(x) > 259)
 426 #define WTERMSIG(x) (x)
 427 #define WNOHANG 1
 428 #define ECONNABORTED 0
 429
 430 int kill(pid_t pid, int sig);
 431 unsigned int sleep (unsigned int __seconds);
 432 const char *inet_ntop(int af, const void *src,
 433                              char *dst, size_t cnt);
 434 int mkstemp (char *__template);
 435 int gettimeofday(struct timeval *tv, void *tz);
 436 int pipe(int filedes[2]);
 437
 438 struct pollfd {
 439         int fd;           /* file descriptor */
 440         short events;     /* requested events */
 441         short revents;    /* returned events */
 442 };
 443 int poll(struct pollfd *ufds, unsigned int nfds, int timeout);
 444 #define POLLIN 1
 445 #define POLLHUP 2
 446
 447 static inline int git_mkdir(const char *path, int mode)
 448 {
 449         return mkdir(path);
 450 }
 451 #define mkdir git_mkdir
 452
 453 static inline int git_unlink(const char *pathname) {
 454         /* read-only files cannot be removed */
 455         chmod(pathname, 0666);
 456         return unlink(pathname);
 457 }
 458 #define unlink git_unlink
 459
 460 static inline int git_rename(const char *oldname, const char *newname)
 461 {
 462         int result;
 463         struct stat st;
 464         if (stat(oldname, &st) < 0) {
 465                 errno = ENOENT;
 466                 return -1;
 467         }
 468         if (S_ISDIR(st.st_mode))
 469                 result = MoveFileEx(oldname, newname, MOVEFILE_COPY_ALLOWED | MOVEFILE_WRITE_THROUGH);
 470         else
 471                 result = MoveFileEx(oldname, newname, MOVEFILE_COPY_ALLOWED | MOVEFILE_REPLACE_EXISTING | MOVEFILE_WRITE_THROUGH);
 472         result = result ? 0 : -1;
 473         if (result) /* copied from wine, should be a separate function */
 474                 switch(GetLastError()) {
 475                         case ERROR_ACCESS_DENIED:
 476                         case ERROR_NETWORK_ACCESS_DENIED:
 477                         case ERROR_CANNOT_MAKE:
 478                         case ERROR_SEEK_ON_DEVICE:
 479                         case ERROR_LOCK_FAILED:
 480                         case ERROR_FAIL_I24:
 481                         case ERROR_CURRENT_DIRECTORY:
 482                         case ERROR_DRIVE_LOCKED:
 483                         case ERROR_NOT_LOCKED:
 484                         case ERROR_INVALID_ACCESS:
 485                         case ERROR_LOCK_VIOLATION:
 486                                 errno = EACCES;
 487                                 break;
 488                         case ERROR_FILE_NOT_FOUND:
 489                         case ERROR_NO_MORE_FILES:
 490                         case ERROR_BAD_PATHNAME:
 491                         case ERROR_BAD_NETPATH:
 492                         case ERROR_INVALID_DRIVE:
 493                         case ERROR_BAD_NET_NAME:
 494                         case ERROR_FILENAME_EXCED_RANGE:
 495                         case ERROR_PATH_NOT_FOUND:
 496                                 errno = ENOENT;
 497                                 break;
 498                         case ERROR_IO_DEVICE:
 499                                 errno = EIO;
 500                                 break;
 501                         case ERROR_BAD_FORMAT:
 502                                 errno = ENOEXEC;
 503                                 break;
 504                         case ERROR_INVALID_HANDLE:
 505                                 errno = EBADF;
 506                                 break;
 507                         case ERROR_OUTOFMEMORY:
 508                         case ERROR_INVALID_BLOCK:
 509                         case ERROR_NOT_ENOUGH_QUOTA:
 510                         case ERROR_ARENA_TRASHED:
 511                                 errno = ENOMEM;
 512                                 break;
 513                         case ERROR_BUSY:
 514                                 errno = EBUSY;
 515                                 break;
 516                         case ERROR_ALREADY_EXISTS:
 517                         case ERROR_FILE_EXISTS:
 518                                 errno = EEXIST;
 519                                 break;
 520                         case ERROR_BAD_DEVICE:
 521                                 errno = ENODEV;
 522                                 break;
 523                         case ERROR_TOO_MANY_OPEN_FILES:
 524                                 errno = EMFILE;
 525                                 break;
 526                         case ERROR_DISK_FULL:
 527                                 errno = ENOSPC;
 528                                 break;
 529                         case ERROR_BROKEN_PIPE:
 530                                 errno = EPIPE;
 531                                 break;
 532                         case ERROR_POSSIBLE_DEADLOCK:
 533                                 errno = EDEADLK;
 534                                 break;
 535                         case ERROR_DIR_NOT_EMPTY:
 536                                 errno = ENOTEMPTY;
 537                                 break;
 538                         case ERROR_BAD_ENVIRONMENT:
 539                                 errno = E2BIG;
 540                                 break;
 541                         case ERROR_WAIT_NO_CHILDREN:
 542                         case ERROR_CHILD_NOT_COMPLETE:
 543                                 errno = ECHILD;
 544                                 break;
 545                         case ERROR_NO_PROC_SLOTS:
 546                         case ERROR_MAX_THRDS_REACHED:
 547                         case ERROR_NESTING_NOT_ALLOWED:
 548                                 errno = EAGAIN;
 549                                 break;
 550                         default:
 551                                 /*  Remaining cases map to EINVAL */
 552                                 /* FIXME: may be missing some errors above */
 553                                 errno = EINVAL;
 554                 }
 555         return result;
 556 }
 557 #define rename(a,b) git_rename(a,b)
 558
 559 #define open(P, F, M...) \
 560         (__builtin_constant_p(*(P)) && !strcmp(P, "/dev/null") ? \
 561                 open("nul", F, ## M) : open(P, F, ## M))
 562
 563 #define fopen(P, M) \
 564         (!strcmp(P, "/dev/null") ? fopen("nul", M) : fopen(P, M))
 565
 566 #include <time.h>
 567 struct tm *gmtime_r(const time_t *timep, struct tm *result);
 568 struct tm *localtime_r(const time_t *timep, struct tm *result);
 569 #define hstrerror strerror
 570
 571 char *mingw_getcwd(char *pointer, int len);
 572 #define getcwd mingw_getcwd
 573
 574 int mingw_socket(int domain, int type, int protocol);
 575 #define socket mingw_socket
 576
 577 #define setlinebuf(x)
 578 #define fsync(x) 0
 579
 580 extern void quote_argv(const char **dst, const char **src);
 581 extern const char *parse_interpreter(const char *cmd);
 582
 583 #endif /* __MINGW32__ */
 584
 585 #endif