compat/mingw.h

   1 #ifdef __MINGW64_VERSION_MAJOR
   2 #include <stdint.h>
   3 #include <wchar.h>
   4 typedef _sigset_t sigset_t;
   5 #endif
   6 #include <winsock2.h>
   7 #include <ws2tcpip.h>
   8
   9 /* MinGW-w64 reports to have flockfile, but it does not actually have it. */
  10 #ifdef __MINGW64_VERSION_MAJOR
  11 #undef _POSIX_THREAD_SAFE_FUNCTIONS
  12 #endif
  13
  14 int mingw_core_config(const char *var, const char *value, void *cb);
  15 #define platform_core_config mingw_core_config
  16
  17 /*
  18  * things that are not available in header files
  19  */
  20
  21 typedef int uid_t;
  22 typedef int socklen_t;
  23 #ifndef __MINGW64_VERSION_MAJOR
  24 typedef int pid_t;
  25 #define hstrerror strerror
  26 #endif
  27
  28 #define S_IFLNK    0120000 /* Symbolic link */
  29 #define S_ISLNK(x) (((x) & S_IFMT) == S_IFLNK)
  30 #define S_ISSOCK(x) 0
  31
  32 #ifndef S_IRWXG
  33 #define S_IRGRP 0
  34 #define S_IWGRP 0
  35 #define S_IXGRP 0
  36 #define S_IRWXG (S_IRGRP | S_IWGRP | S_IXGRP)
  37 #endif
  38 #ifndef S_IRWXO
  39 #define S_IROTH 0
  40 #define S_IWOTH 0
  41 #define S_IXOTH 0
  42 #define S_IRWXO (S_IROTH | S_IWOTH | S_IXOTH)
  43 #endif
  44
  45 #define S_ISUID 0004000
  46 #define S_ISGID 0002000
  47 #define S_ISVTX 0001000
  48
  49 #define WIFEXITED(x) 1
  50 #define WIFSIGNALED(x) 0
  51 #define WEXITSTATUS(x) ((x) & 0xff)
  52 #define WTERMSIG(x) SIGTERM
  53
  54 #ifndef EWOULDBLOCK
  55 #define EWOULDBLOCK EAGAIN
  56 #endif
  57 #ifndef ELOOP
  58 #define ELOOP EMLINK
  59 #endif
  60 #define SHUT_WR SD_SEND
  61
  62 #define SIGHUP 1
  63 #define SIGQUIT 3
  64 #define SIGKILL 9
  65 #define SIGPIPE 13
  66 #define SIGALRM 14
  67 #define SIGCHLD 17
  68
  69 #define F_GETFD 1
  70 #define F_SETFD 2
  71 #define FD_CLOEXEC 0x1
  72
  73 #if !defined O_CLOEXEC && defined O_NOINHERIT
  74 #define O_CLOEXEC       O_NOINHERIT
  75 #endif
  76
  77 #ifndef EAFNOSUPPORT
  78 #define EAFNOSUPPORT WSAEAFNOSUPPORT
  79 #endif
  80 #ifndef ECONNABORTED
  81 #define ECONNABORTED WSAECONNABORTED
  82 #endif
  83 #ifndef ENOTSOCK
  84 #define ENOTSOCK WSAENOTSOCK
  85 #endif
  86
  87 struct passwd {
  88         char *pw_name;
  89         char *pw_gecos;
  90         char *pw_dir;
  91 };
  92
  93 typedef void (__cdecl *sig_handler_t)(int);
  94 struct sigaction {
  95         sig_handler_t sa_handler;
  96         unsigned sa_flags;
  97 };
  98 #define SA_RESTART 0
  99
 100 struct itimerval {
 101         struct timeval it_value, it_interval;
 102 };
 103 #define ITIMER_REAL 0
 104
 105 struct utsname {
 106         char sysname[16];
 107         char nodename[1];
 108         char release[16];
 109         char version[16];
 110         char machine[1];
 111 };
 112
 113 /*
 114  * sanitize preprocessor namespace polluted by Windows headers defining
 115  * macros which collide with git local versions
 116  */
 117 #undef HELP_COMMAND /* from winuser.h */
 118
 119 /*
 120  * trivial stubs
 121  */
 122
 123 static inline int readlink(const char *path, char *buf, size_t bufsiz)
 124 { errno = ENOSYS; return -1; }
 125 static inline int symlink(const char *oldpath, const char *newpath)
 126 { errno = ENOSYS; return -1; }
 127 static inline int fchmod(int fildes, mode_t mode)
 128 { errno = ENOSYS; return -1; }
 129 #ifndef __MINGW64_VERSION_MAJOR
 130 static inline pid_t fork(void)
 131 { errno = ENOSYS; return -1; }
 132 #endif
 133 static inline unsigned int alarm(unsigned int seconds)
 134 { return 0; }
 135 static inline int fsync(int fd)
 136 { return _commit(fd); }
 137 static inline void sync(void)
 138 {}
 139 static inline uid_t getuid(void)
 140 { return 1; }
 141 static inline struct passwd *getpwnam(const char *name)
 142 { return NULL; }
 143 static inline int fcntl(int fd, int cmd, ...)
 144 {
 145         if (cmd == F_GETFD || cmd == F_SETFD)
 146                 return 0;
 147         errno = EINVAL;
 148         return -1;
 149 }
 150
 151 #define sigemptyset(x) (void)0
 152 static inline int sigaddset(sigset_t *set, int signum)
 153 { return 0; }
 154 #define SIG_BLOCK 0
 155 #define SIG_UNBLOCK 0
 156 static inline int sigprocmask(int how, const sigset_t *set, sigset_t *oldset)
 157 { return 0; }
 158 static inline pid_t getppid(void)
 159 { return 1; }
 160 static inline pid_t getpgid(pid_t pid)
 161 { return pid == 0 ? getpid() : pid; }
 162 static inline pid_t tcgetpgrp(int fd)
 163 { return getpid(); }
 164
 165 /*
 166  * simple adaptors
 167  */
 168
 169 int mingw_mkdir(const char *path, int mode);
 170 #define mkdir mingw_mkdir
 171
 172 #define WNOHANG 1
 173 pid_t waitpid(pid_t pid, int *status, int options);
 174
 175 #define kill mingw_kill
 176 int mingw_kill(pid_t pid, int sig);
 177
 178 #define locate_in_PATH mingw_locate_in_PATH
 179 char *mingw_locate_in_PATH(const char *cmd);
 180
 181 #ifndef NO_OPENSSL
 182 #include <openssl/ssl.h>
 183 static inline int mingw_SSL_set_fd(SSL *ssl, int fd)
 184 {
 185         return SSL_set_fd(ssl, _get_osfhandle(fd));
 186 }
 187 #define SSL_set_fd mingw_SSL_set_fd
 188
 189 static inline int mingw_SSL_set_rfd(SSL *ssl, int fd)
 190 {
 191         return SSL_set_rfd(ssl, _get_osfhandle(fd));
 192 }
 193 #define SSL_set_rfd mingw_SSL_set_rfd
 194
 195 static inline int mingw_SSL_set_wfd(SSL *ssl, int fd)
 196 {
 197         return SSL_set_wfd(ssl, _get_osfhandle(fd));
 198 }
 199 #define SSL_set_wfd mingw_SSL_set_wfd
 200 #endif
 201
 202 /*
 203  * implementations of missing functions
 204  */
 205
 206 int pipe(int filedes[2]);
 207 unsigned int sleep (unsigned int seconds);
 208 int mkstemp(char *template);
 209 int gettimeofday(struct timeval *tv, void *tz);
 210 #ifndef __MINGW64_VERSION_MAJOR
 211 struct tm *gmtime_r(const time_t *timep, struct tm *result);
 212 struct tm *localtime_r(const time_t *timep, struct tm *result);
 213 #endif
 214 int getpagesize(void);  /* defined in MinGW's libgcc.a */
 215 struct passwd *getpwuid(uid_t uid);
 216 int setitimer(int type, struct itimerval *in, struct itimerval *out);
 217 int sigaction(int sig, struct sigaction *in, struct sigaction *out);
 218 int link(const char *oldpath, const char *newpath);
 219 int uname(struct utsname *buf);
 220
 221 /*
 222  * replacements of existing functions
 223  */
 224
 225 int mingw_unlink(const char *pathname);
 226 #define unlink mingw_unlink
 227
 228 int mingw_rmdir(const char *path);
 229 #define rmdir mingw_rmdir
 230
 231 int mingw_open (const char *filename, int oflags, ...);
 232 #define open mingw_open
 233 #undef OPEN_RETURNS_EINTR
 234
 235 int mingw_fgetc(FILE *stream);
 236 #define fgetc mingw_fgetc
 237
 238 FILE *mingw_fopen (const char *filename, const char *otype);
 239 #define fopen mingw_fopen
 240
 241 FILE *mingw_freopen (const char *filename, const char *otype, FILE *stream);
 242 #define freopen mingw_freopen
 243
 244 int mingw_fflush(FILE *stream);
 245 #define fflush mingw_fflush
 246
 247 ssize_t mingw_write(int fd, const void *buf, size_t len);
 248 #define write mingw_write
 249
 250 int mingw_access(const char *filename, int mode);
 251 #undef access
 252 #define access mingw_access
 253
 254 int mingw_chdir(const char *dirname);
 255 #define chdir mingw_chdir
 256
 257 int mingw_chmod(const char *filename, int mode);
 258 #define chmod mingw_chmod
 259
 260 char *mingw_mktemp(char *template);
 261 #define mktemp mingw_mktemp
 262
 263 char *mingw_getcwd(char *pointer, int len);
 264 #define getcwd mingw_getcwd
 265
 266 #ifdef NO_UNSETENV
 267 #error "NO_UNSETENV is incompatible with the Windows-specific startup code!"
 268 #endif
 269
 270 /*
 271  * We bind *env() routines (even the mingw_ ones) to private mingw_ versions.
 272  * These talk to the CRT using UNICODE/wchar_t, but maintain the original
 273  * narrow-char API.
 274  *
 275  * Note that the MSCRT maintains both ANSI (getenv()) and UNICODE (_wgetenv())
 276  * routines and stores both versions of each environment variable in parallel
 277  * (and secretly updates both when you set one or the other), but it uses CP_ACP
 278  * to do the conversion rather than CP_UTF8.
 279  *
 280  * Since everything in the git code base is UTF8, we define the mingw_ routines
 281  * to access the CRT using the UNICODE routines and manually convert them to
 282  * UTF8.  This also avoids round-trip problems.
 283  *
 284  * This also helps with our linkage, since "_wenviron" is publicly exported
 285  * from the CRT.  But to access "_environ" we would have to statically link
 286  * to the CRT (/MT).
 287  *
 288  * We require NO_SETENV (and let gitsetenv() call our mingw_putenv).
 289  */
 290 #define getenv       mingw_getenv
 291 #define putenv       mingw_putenv
 292 #define unsetenv     mingw_putenv
 293 char *mingw_getenv(const char *name);
 294 int   mingw_putenv(const char *name);
 295
 296 int mingw_gethostname(char *host, int namelen);
 297 #define gethostname mingw_gethostname
 298
 299 struct hostent *mingw_gethostbyname(const char *host);
 300 #define gethostbyname mingw_gethostbyname
 301
 302 int mingw_getaddrinfo(const char *node, const char *service,
 303                       const struct addrinfo *hints, struct addrinfo **res);
 304 #define getaddrinfo mingw_getaddrinfo
 305
 306 int mingw_socket(int domain, int type, int protocol);
 307 #define socket mingw_socket
 308
 309 int mingw_connect(int sockfd, struct sockaddr *sa, size_t sz);
 310 #define connect mingw_connect
 311
 312 int mingw_bind(int sockfd, struct sockaddr *sa, size_t sz);
 313 #define bind mingw_bind
 314
 315 int mingw_setsockopt(int sockfd, int lvl, int optname, void *optval, int optlen);
 316 #define setsockopt mingw_setsockopt
 317
 318 int mingw_shutdown(int sockfd, int how);
 319 #define shutdown mingw_shutdown
 320
 321 int mingw_listen(int sockfd, int backlog);
 322 #define listen mingw_listen
 323
 324 int mingw_accept(int sockfd, struct sockaddr *sa, socklen_t *sz);
 325 #define accept mingw_accept
 326
 327 int mingw_rename(const char*, const char*);
 328 #define rename mingw_rename
 329
 330 #if defined(USE_WIN32_MMAP) || defined(_MSC_VER)
 331 int mingw_getpagesize(void);
 332 #define getpagesize mingw_getpagesize
 333 #endif
 334
 335 int win32_fsync_no_flush(int fd);
 336 #define fsync_no_flush win32_fsync_no_flush
 337
 338 #define FSYNC_COMPONENTS_PLATFORM_DEFAULT (FSYNC_COMPONENTS_DEFAULT | FSYNC_COMPONENT_LOOSE_OBJECT)
 339 #define FSYNC_METHOD_DEFAULT (FSYNC_METHOD_BATCH)
 340
 341 struct rlimit {
 342         unsigned int rlim_cur;
 343 };
 344 #define RLIMIT_NOFILE 0
 345
 346 static inline int getrlimit(int resource, struct rlimit *rlp)
 347 {
 348         if (resource != RLIMIT_NOFILE) {
 349                 errno = EINVAL;
 350                 return -1;
 351         }
 352
 353         rlp->rlim_cur = 2048;
 354         return 0;
 355 }
 356
 357 /*
 358  * Use mingw specific stat()/lstat()/fstat() implementations on Windows,
 359  * including our own struct stat with 64 bit st_size and nanosecond-precision
 360  * file times.
 361  */
 362 #ifndef __MINGW64_VERSION_MAJOR
 363 #define off_t off64_t
 364 #define lseek _lseeki64
 365 #ifndef _MSC_VER
 366 struct timespec {
 367         time_t tv_sec;
 368         long tv_nsec;
 369 };
 370 #endif
 371 #endif
 372
 373 struct mingw_stat {
 374     _dev_t st_dev;
 375     _ino_t st_ino;
 376     _mode_t st_mode;
 377     short st_nlink;
 378     short st_uid;
 379     short st_gid;
 380     _dev_t st_rdev;
 381     off64_t st_size;
 382     struct timespec st_atim;
 383     struct timespec st_mtim;
 384     struct timespec st_ctim;
 385 };
 386
 387 #define st_atime st_atim.tv_sec
 388 #define st_mtime st_mtim.tv_sec
 389 #define st_ctime st_ctim.tv_sec
 390
 391 #ifdef stat
 392 #undef stat
 393 #endif
 394 #define stat mingw_stat
 395 int mingw_lstat(const char *file_name, struct stat *buf);
 396 int mingw_stat(const char *file_name, struct stat *buf);
 397 int mingw_fstat(int fd, struct stat *buf);
 398 #ifdef fstat
 399 #undef fstat
 400 #endif
 401 #define fstat mingw_fstat
 402 #ifdef lstat
 403 #undef lstat
 404 #endif
 405 #define lstat mingw_lstat
 406
 407
 408 int mingw_utime(const char *file_name, const struct utimbuf *times);
 409 #define utime mingw_utime
 410 size_t mingw_strftime(char *s, size_t max,
 411                    const char *format, const struct tm *tm);
 412 #define strftime mingw_strftime
 413
 414 pid_t mingw_spawnvpe(const char *cmd, const char **argv, char **env,
 415                      const char *dir,
 416                      int fhin, int fhout, int fherr);
 417 int mingw_execvp(const char *cmd, char *const *argv);
 418 #define execvp mingw_execvp
 419 int mingw_execv(const char *cmd, char *const *argv);
 420 #define execv mingw_execv
 421
 422 static inline unsigned int git_ntohl(unsigned int x)
 423 { return (unsigned int)ntohl(x); }
 424 #define ntohl git_ntohl
 425
 426 sig_handler_t mingw_signal(int sig, sig_handler_t handler);
 427 #define signal mingw_signal
 428
 429 int mingw_raise(int sig);
 430 #define raise mingw_raise
 431
 432 /*
 433  * ANSI emulation wrappers
 434  */
 435
 436 int winansi_isatty(int fd);
 437 #define isatty winansi_isatty
 438
 439 int winansi_dup2(int oldfd, int newfd);
 440 #define dup2 winansi_dup2
 441
 442 void winansi_init(void);
 443 HANDLE winansi_get_osfhandle(int fd);
 444
 445 /*
 446  * git specific compatibility
 447  */
 448
 449 static inline void convert_slashes(char *path)
 450 {
 451         for (; *path; path++)
 452                 if (*path == '\\')
 453                         *path = '/';
 454 }
 455 #define PATH_SEP ';'
 456 char *mingw_query_user_email(void);
 457 #define query_user_email mingw_query_user_email
 458 #if !defined(__MINGW64_VERSION_MAJOR) && (!defined(_MSC_VER) || _MSC_VER < 1800)
 459 #define PRIuMAX "I64u"
 460 #define PRId64 "I64d"
 461 #else
 462 #include <inttypes.h>
 463 #endif
 464
 465 /**
 466  * Verifies that the specified path is owned by the user running the
 467  * current process.
 468  */
 469 int is_path_owned_by_current_sid(const char *path, struct strbuf *report);
 470 #define is_path_owned_by_current_user is_path_owned_by_current_sid
 471
 472 /**
 473  * Verifies that the given path is a valid one on Windows.
 474  *
 475  * In particular, path segments are disallowed which
 476  *
 477  * - end in a period or a space (except the special directories `.` and `..`).
 478  *
 479  * - contain any of the reserved characters, e.g. `:`, `;`, `*`, etc
 480  *
 481  * - correspond to reserved names (such as `AUX`, `PRN`, etc)
 482  *
 483  * The `allow_literal_nul` parameter controls whether the path `NUL` should
 484  * be considered valid (this makes sense e.g. before opening files, as it is
 485  * perfectly legitimate to open `NUL` on Windows, just as it is to open
 486  * `/dev/null` on Unix/Linux).
 487  *
 488  * Returns 1 upon success, otherwise 0.
 489  */
 490 int is_valid_win32_path(const char *path, int allow_literal_nul);
 491 #define is_valid_path(path) is_valid_win32_path(path, 0)
 492
 493 /**
 494  * Converts UTF-8 encoded string to UTF-16LE.
 495  *
 496  * To support repositories with legacy-encoded file names, invalid UTF-8 bytes
 497  * 0xa0 - 0xff are converted to corresponding printable Unicode chars \u00a0 -
 498  * \u00ff, and invalid UTF-8 bytes 0x80 - 0x9f (which would make non-printable
 499  * Unicode) are converted to hex-code.
 500  *
 501  * Lead-bytes not followed by an appropriate number of trail-bytes, over-long
 502  * encodings and 4-byte encodings > \u10ffff are detected as invalid UTF-8.
 503  *
 504  * Maximum space requirement for the target buffer is two wide chars per UTF-8
 505  * char (((strlen(utf) * 2) + 1) [* sizeof(wchar_t)]).
 506  *
 507  * The maximum space is needed only if the entire input string consists of
 508  * invalid UTF-8 bytes in range 0x80-0x9f, as per the following table:
 509  *
 510  *               |                   | UTF-8 | UTF-16 |
 511  *   Code point  |  UTF-8 sequence   | bytes | words  | ratio
 512  * --------------+-------------------+-------+--------+-------
 513  * 000000-00007f | 0-7f              |   1   |   1    |  1
 514  * 000080-0007ff | c2-df + 80-bf     |   2   |   1    |  0.5
 515  * 000800-00ffff | e0-ef + 2 * 80-bf |   3   |   1    |  0.33
 516  * 010000-10ffff | f0-f4 + 3 * 80-bf |   4   |  2 (a) |  0.5
 517  * invalid       | 80-9f             |   1   |  2 (b) |  2
 518  * invalid       | a0-ff             |   1   |   1    |  1
 519  *
 520  * (a) encoded as UTF-16 surrogate pair
 521  * (b) encoded as two hex digits
 522  *
 523  * Note that, while the UTF-8 encoding scheme can be extended to 5-byte, 6-byte
 524  * or even indefinite-byte sequences, the largest valid code point \u10ffff
 525  * encodes as only 4 UTF-8 bytes.
 526  *
 527  * Parameters:
 528  * wcs: wide char target buffer
 529  * utf: string to convert
 530  * wcslen: size of target buffer (in wchar_t's)
 531  * utflen: size of string to convert, or -1 if 0-terminated
 532  *
 533  * Returns:
 534  * length of converted string (_wcslen(wcs)), or -1 on failure
 535  *
 536  * Errors:
 537  * EINVAL: one of the input parameters is invalid (e.g. NULL)
 538  * ERANGE: the output buffer is too small
 539  */
 540 int xutftowcsn(wchar_t *wcs, const char *utf, size_t wcslen, int utflen);
 541
 542 /**
 543  * Simplified variant of xutftowcsn, assumes input string is \0-terminated.
 544  */
 545 static inline int xutftowcs(wchar_t *wcs, const char *utf, size_t wcslen)
 546 {
 547         return xutftowcsn(wcs, utf, wcslen, -1);
 548 }
 549
 550 /**
 551  * Simplified file system specific variant of xutftowcsn, assumes output
 552  * buffer size is MAX_PATH wide chars and input string is \0-terminated,
 553  * fails with ENAMETOOLONG if input string is too long.
 554  */
 555 static inline int xutftowcs_path(wchar_t *wcs, const char *utf)
 556 {
 557         int result = xutftowcsn(wcs, utf, MAX_PATH, -1);
 558         if (result < 0 && errno == ERANGE)
 559                 errno = ENAMETOOLONG;
 560         return result;
 561 }
 562
 563 /**
 564  * Converts UTF-16LE encoded string to UTF-8.
 565  *
 566  * Maximum space requirement for the target buffer is three UTF-8 chars per
 567  * wide char ((_wcslen(wcs) * 3) + 1).
 568  *
 569  * The maximum space is needed only if the entire input string consists of
 570  * UTF-16 words in range 0x0800-0xd7ff or 0xe000-0xffff (i.e. \u0800-\uffff
 571  * modulo surrogate pairs), as per the following table:
 572  *
 573  *               |                       | UTF-16 | UTF-8 |
 574  *   Code point  |  UTF-16 sequence      | words  | bytes | ratio
 575  * --------------+-----------------------+--------+-------+-------
 576  * 000000-00007f | 0000-007f             |   1    |   1   |  1
 577  * 000080-0007ff | 0080-07ff             |   1    |   2   |  2
 578  * 000800-00ffff | 0800-d7ff / e000-ffff |   1    |   3   |  3
 579  * 010000-10ffff | d800-dbff + dc00-dfff |   2    |   4   |  2
 580  *
 581  * Note that invalid code points > 10ffff cannot be represented in UTF-16.
 582  *
 583  * Parameters:
 584  * utf: target buffer
 585  * wcs: wide string to convert
 586  * utflen: size of target buffer
 587  *
 588  * Returns:
 589  * length of converted string, or -1 on failure
 590  *
 591  * Errors:
 592  * EINVAL: one of the input parameters is invalid (e.g. NULL)
 593  * ERANGE: the output buffer is too small
 594  */
 595 int xwcstoutf(char *utf, const wchar_t *wcs, size_t utflen);
 596
 597 /*
 598  * A critical section used in the implementation of the spawn
 599  * functions (mingw_spawnv[p]e()) and waitpid(). Initialised in
 600  * the replacement main() macro below.
 601  */
 602 extern CRITICAL_SECTION pinfo_cs;
 603
 604 /*
 605  * Git, like most portable C applications, implements a main() function. On
 606  * Windows, this main() function would receive parameters encoded in the
 607  * current locale, but Git for Windows would prefer UTF-8 encoded  parameters.
 608  *
 609  * To make that happen, we still declare main() here, and then declare and
 610  * implement wmain() (which is the Unicode variant of main()) and compile with
 611  * -municode. This wmain() function reencodes the parameters from UTF-16 to
 612  * UTF-8 format, sets up a couple of other things as required on Windows, and
 613  * then hands off to the main() function.
 614  */
 615 int wmain(int argc, const wchar_t **w_argv);
 616 int main(int argc, const char **argv);
 617
 618 /*
 619  * For debugging: if a problem occurs, say, in a Git process that is spawned
 620  * from another Git process which in turn is spawned from yet another Git
 621  * process, it can be quite daunting to figure out what is going on.
 622  *
 623  * Call this function to open a new MinTTY (this assumes you are in Git for
 624  * Windows' SDK) with a GDB that attaches to the current process right away.
 625  */
 626 void open_in_gdb(void);
 627
 628 /*
 629  * Used by Pthread API implementation for Windows
 630  */
 631 int err_win_to_posix(DWORD winerr);