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 #ifndef NO_OPENSSL
 179 #include <openssl/ssl.h>
 180 static inline int mingw_SSL_set_fd(SSL *ssl, int fd)
 181 {
 182         return SSL_set_fd(ssl, _get_osfhandle(fd));
 183 }
 184 #define SSL_set_fd mingw_SSL_set_fd
 185
 186 static inline int mingw_SSL_set_rfd(SSL *ssl, int fd)
 187 {
 188         return SSL_set_rfd(ssl, _get_osfhandle(fd));
 189 }
 190 #define SSL_set_rfd mingw_SSL_set_rfd
 191
 192 static inline int mingw_SSL_set_wfd(SSL *ssl, int fd)
 193 {
 194         return SSL_set_wfd(ssl, _get_osfhandle(fd));
 195 }
 196 #define SSL_set_wfd mingw_SSL_set_wfd
 197 #endif
 198
 199 /*
 200  * implementations of missing functions
 201  */
 202
 203 int pipe(int filedes[2]);
 204 unsigned int sleep (unsigned int seconds);
 205 int mkstemp(char *template);
 206 int gettimeofday(struct timeval *tv, void *tz);
 207 #ifndef __MINGW64_VERSION_MAJOR
 208 struct tm *gmtime_r(const time_t *timep, struct tm *result);
 209 struct tm *localtime_r(const time_t *timep, struct tm *result);
 210 #endif
 211 int getpagesize(void);  /* defined in MinGW's libgcc.a */
 212 struct passwd *getpwuid(uid_t uid);
 213 int setitimer(int type, struct itimerval *in, struct itimerval *out);
 214 int sigaction(int sig, struct sigaction *in, struct sigaction *out);
 215 int link(const char *oldpath, const char *newpath);
 216 int uname(struct utsname *buf);
 217
 218 /*
 219  * replacements of existing functions
 220  */
 221
 222 int mingw_unlink(const char *pathname);
 223 #define unlink mingw_unlink
 224
 225 int mingw_rmdir(const char *path);
 226 #define rmdir mingw_rmdir
 227
 228 int mingw_open (const char *filename, int oflags, ...);
 229 #define open mingw_open
 230 #undef OPEN_RETURNS_EINTR
 231
 232 int mingw_fgetc(FILE *stream);
 233 #define fgetc mingw_fgetc
 234
 235 FILE *mingw_fopen (const char *filename, const char *otype);
 236 #define fopen mingw_fopen
 237
 238 FILE *mingw_freopen (const char *filename, const char *otype, FILE *stream);
 239 #define freopen mingw_freopen
 240
 241 int mingw_fflush(FILE *stream);
 242 #define fflush mingw_fflush
 243
 244 ssize_t mingw_write(int fd, const void *buf, size_t len);
 245 #define write mingw_write
 246
 247 int mingw_access(const char *filename, int mode);
 248 #undef access
 249 #define access mingw_access
 250
 251 int mingw_chdir(const char *dirname);
 252 #define chdir mingw_chdir
 253
 254 int mingw_chmod(const char *filename, int mode);
 255 #define chmod mingw_chmod
 256
 257 char *mingw_mktemp(char *template);
 258 #define mktemp mingw_mktemp
 259
 260 char *mingw_getcwd(char *pointer, int len);
 261 #define getcwd mingw_getcwd
 262
 263 #ifdef NO_UNSETENV
 264 #error "NO_UNSETENV is incompatible with the Windows-specific startup code!"
 265 #endif
 266
 267 /*
 268  * We bind *env() routines (even the mingw_ ones) to private mingw_ versions.
 269  * These talk to the CRT using UNICODE/wchar_t, but maintain the original
 270  * narrow-char API.
 271  *
 272  * Note that the MSCRT maintains both ANSI (getenv()) and UNICODE (_wgetenv())
 273  * routines and stores both versions of each environment variable in parallel
 274  * (and secretly updates both when you set one or the other), but it uses CP_ACP
 275  * to do the conversion rather than CP_UTF8.
 276  *
 277  * Since everything in the git code base is UTF8, we define the mingw_ routines
 278  * to access the CRT using the UNICODE routines and manually convert them to
 279  * UTF8.  This also avoids round-trip problems.
 280  *
 281  * This also helps with our linkage, since "_wenviron" is publicly exported
 282  * from the CRT.  But to access "_environ" we would have to statically link
 283  * to the CRT (/MT).
 284  *
 285  * We require NO_SETENV (and let gitsetenv() call our mingw_putenv).
 286  */
 287 #define getenv       mingw_getenv
 288 #define putenv       mingw_putenv
 289 #define unsetenv     mingw_putenv
 290 char *mingw_getenv(const char *name);
 291 int   mingw_putenv(const char *name);
 292
 293 int mingw_gethostname(char *host, int namelen);
 294 #define gethostname mingw_gethostname
 295
 296 struct hostent *mingw_gethostbyname(const char *host);
 297 #define gethostbyname mingw_gethostbyname
 298
 299 int mingw_getaddrinfo(const char *node, const char *service,
 300                       const struct addrinfo *hints, struct addrinfo **res);
 301 #define getaddrinfo mingw_getaddrinfo
 302
 303 int mingw_socket(int domain, int type, int protocol);
 304 #define socket mingw_socket
 305
 306 int mingw_connect(int sockfd, struct sockaddr *sa, size_t sz);
 307 #define connect mingw_connect
 308
 309 int mingw_bind(int sockfd, struct sockaddr *sa, size_t sz);
 310 #define bind mingw_bind
 311
 312 int mingw_setsockopt(int sockfd, int lvl, int optname, void *optval, int optlen);
 313 #define setsockopt mingw_setsockopt
 314
 315 int mingw_shutdown(int sockfd, int how);
 316 #define shutdown mingw_shutdown
 317
 318 int mingw_listen(int sockfd, int backlog);
 319 #define listen mingw_listen
 320
 321 int mingw_accept(int sockfd, struct sockaddr *sa, socklen_t *sz);
 322 #define accept mingw_accept
 323
 324 int mingw_rename(const char*, const char*);
 325 #define rename mingw_rename
 326
 327 #if defined(USE_WIN32_MMAP) || defined(_MSC_VER)
 328 int mingw_getpagesize(void);
 329 #define getpagesize mingw_getpagesize
 330 #endif
 331
 332 int win32_fsync_no_flush(int fd);
 333 #define fsync_no_flush win32_fsync_no_flush
 334
 335 #define FSYNC_COMPONENTS_PLATFORM_DEFAULT (FSYNC_COMPONENTS_DEFAULT | FSYNC_COMPONENT_LOOSE_OBJECT)
 336 #define FSYNC_METHOD_DEFAULT (FSYNC_METHOD_BATCH)
 337
 338 struct rlimit {
 339         unsigned int rlim_cur;
 340 };
 341 #define RLIMIT_NOFILE 0
 342
 343 static inline int getrlimit(int resource, struct rlimit *rlp)
 344 {
 345         if (resource != RLIMIT_NOFILE) {
 346                 errno = EINVAL;
 347                 return -1;
 348         }
 349
 350         rlp->rlim_cur = 2048;
 351         return 0;
 352 }
 353
 354 /*
 355  * Use mingw specific stat()/lstat()/fstat() implementations on Windows,
 356  * including our own struct stat with 64 bit st_size and nanosecond-precision
 357  * file times.
 358  */
 359 #ifndef __MINGW64_VERSION_MAJOR
 360 #define off_t off64_t
 361 #define lseek _lseeki64
 362 #ifndef _MSC_VER
 363 struct timespec {
 364         time_t tv_sec;
 365         long tv_nsec;
 366 };
 367 #endif
 368 #endif
 369
 370 struct mingw_stat {
 371     _dev_t st_dev;
 372     _ino_t st_ino;
 373     _mode_t st_mode;
 374     short st_nlink;
 375     short st_uid;
 376     short st_gid;
 377     _dev_t st_rdev;
 378     off64_t st_size;
 379     struct timespec st_atim;
 380     struct timespec st_mtim;
 381     struct timespec st_ctim;
 382 };
 383
 384 #define st_atime st_atim.tv_sec
 385 #define st_mtime st_mtim.tv_sec
 386 #define st_ctime st_ctim.tv_sec
 387
 388 #ifdef stat
 389 #undef stat
 390 #endif
 391 #define stat mingw_stat
 392 int mingw_lstat(const char *file_name, struct stat *buf);
 393 int mingw_stat(const char *file_name, struct stat *buf);
 394 int mingw_fstat(int fd, struct stat *buf);
 395 #ifdef fstat
 396 #undef fstat
 397 #endif
 398 #define fstat mingw_fstat
 399 #ifdef lstat
 400 #undef lstat
 401 #endif
 402 #define lstat mingw_lstat
 403
 404
 405 int mingw_utime(const char *file_name, const struct utimbuf *times);
 406 #define utime mingw_utime
 407 size_t mingw_strftime(char *s, size_t max,
 408                    const char *format, const struct tm *tm);
 409 #define strftime mingw_strftime
 410
 411 pid_t mingw_spawnvpe(const char *cmd, const char **argv, char **env,
 412                      const char *dir,
 413                      int fhin, int fhout, int fherr);
 414 int mingw_execvp(const char *cmd, char *const *argv);
 415 #define execvp mingw_execvp
 416 int mingw_execv(const char *cmd, char *const *argv);
 417 #define execv mingw_execv
 418
 419 static inline unsigned int git_ntohl(unsigned int x)
 420 { return (unsigned int)ntohl(x); }
 421 #define ntohl git_ntohl
 422
 423 sig_handler_t mingw_signal(int sig, sig_handler_t handler);
 424 #define signal mingw_signal
 425
 426 int mingw_raise(int sig);
 427 #define raise mingw_raise
 428
 429 /*
 430  * ANSI emulation wrappers
 431  */
 432
 433 int winansi_isatty(int fd);
 434 #define isatty winansi_isatty
 435
 436 int winansi_dup2(int oldfd, int newfd);
 437 #define dup2 winansi_dup2
 438
 439 void winansi_init(void);
 440 HANDLE winansi_get_osfhandle(int fd);
 441
 442 /*
 443  * git specific compatibility
 444  */
 445
 446 static inline void convert_slashes(char *path)
 447 {
 448         for (; *path; path++)
 449                 if (*path == '\\')
 450                         *path = '/';
 451 }
 452 #define PATH_SEP ';'
 453 char *mingw_query_user_email(void);
 454 #define query_user_email mingw_query_user_email
 455 #if !defined(__MINGW64_VERSION_MAJOR) && (!defined(_MSC_VER) || _MSC_VER < 1800)
 456 #define PRIuMAX "I64u"
 457 #define PRId64 "I64d"
 458 #else
 459 #include <inttypes.h>
 460 #endif
 461
 462 /**
 463  * Verifies that the specified path is owned by the user running the
 464  * current process.
 465  */
 466 int is_path_owned_by_current_sid(const char *path, struct strbuf *report);
 467 #define is_path_owned_by_current_user is_path_owned_by_current_sid
 468
 469 /**
 470  * Verifies that the given path is a valid one on Windows.
 471  *
 472  * In particular, path segments are disallowed which
 473  *
 474  * - end in a period or a space (except the special directories `.` and `..`).
 475  *
 476  * - contain any of the reserved characters, e.g. `:`, `;`, `*`, etc
 477  *
 478  * - correspond to reserved names (such as `AUX`, `PRN`, etc)
 479  *
 480  * The `allow_literal_nul` parameter controls whether the path `NUL` should
 481  * be considered valid (this makes sense e.g. before opening files, as it is
 482  * perfectly legitimate to open `NUL` on Windows, just as it is to open
 483  * `/dev/null` on Unix/Linux).
 484  *
 485  * Returns 1 upon success, otherwise 0.
 486  */
 487 int is_valid_win32_path(const char *path, int allow_literal_nul);
 488 #define is_valid_path(path) is_valid_win32_path(path, 0)
 489
 490 /**
 491  * Converts UTF-8 encoded string to UTF-16LE.
 492  *
 493  * To support repositories with legacy-encoded file names, invalid UTF-8 bytes
 494  * 0xa0 - 0xff are converted to corresponding printable Unicode chars \u00a0 -
 495  * \u00ff, and invalid UTF-8 bytes 0x80 - 0x9f (which would make non-printable
 496  * Unicode) are converted to hex-code.
 497  *
 498  * Lead-bytes not followed by an appropriate number of trail-bytes, over-long
 499  * encodings and 4-byte encodings > \u10ffff are detected as invalid UTF-8.
 500  *
 501  * Maximum space requirement for the target buffer is two wide chars per UTF-8
 502  * char (((strlen(utf) * 2) + 1) [* sizeof(wchar_t)]).
 503  *
 504  * The maximum space is needed only if the entire input string consists of
 505  * invalid UTF-8 bytes in range 0x80-0x9f, as per the following table:
 506  *
 507  *               |                   | UTF-8 | UTF-16 |
 508  *   Code point  |  UTF-8 sequence   | bytes | words  | ratio
 509  * --------------+-------------------+-------+--------+-------
 510  * 000000-00007f | 0-7f              |   1   |   1    |  1
 511  * 000080-0007ff | c2-df + 80-bf     |   2   |   1    |  0.5
 512  * 000800-00ffff | e0-ef + 2 * 80-bf |   3   |   1    |  0.33
 513  * 010000-10ffff | f0-f4 + 3 * 80-bf |   4   |  2 (a) |  0.5
 514  * invalid       | 80-9f             |   1   |  2 (b) |  2
 515  * invalid       | a0-ff             |   1   |   1    |  1
 516  *
 517  * (a) encoded as UTF-16 surrogate pair
 518  * (b) encoded as two hex digits
 519  *
 520  * Note that, while the UTF-8 encoding scheme can be extended to 5-byte, 6-byte
 521  * or even indefinite-byte sequences, the largest valid code point \u10ffff
 522  * encodes as only 4 UTF-8 bytes.
 523  *
 524  * Parameters:
 525  * wcs: wide char target buffer
 526  * utf: string to convert
 527  * wcslen: size of target buffer (in wchar_t's)
 528  * utflen: size of string to convert, or -1 if 0-terminated
 529  *
 530  * Returns:
 531  * length of converted string (_wcslen(wcs)), or -1 on failure
 532  *
 533  * Errors:
 534  * EINVAL: one of the input parameters is invalid (e.g. NULL)
 535  * ERANGE: the output buffer is too small
 536  */
 537 int xutftowcsn(wchar_t *wcs, const char *utf, size_t wcslen, int utflen);
 538
 539 /**
 540  * Simplified variant of xutftowcsn, assumes input string is \0-terminated.
 541  */
 542 static inline int xutftowcs(wchar_t *wcs, const char *utf, size_t wcslen)
 543 {
 544         return xutftowcsn(wcs, utf, wcslen, -1);
 545 }
 546
 547 /**
 548  * Simplified file system specific variant of xutftowcsn, assumes output
 549  * buffer size is MAX_PATH wide chars and input string is \0-terminated,
 550  * fails with ENAMETOOLONG if input string is too long.
 551  */
 552 static inline int xutftowcs_path(wchar_t *wcs, const char *utf)
 553 {
 554         int result = xutftowcsn(wcs, utf, MAX_PATH, -1);
 555         if (result < 0 && errno == ERANGE)
 556                 errno = ENAMETOOLONG;
 557         return result;
 558 }
 559
 560 /**
 561  * Converts UTF-16LE encoded string to UTF-8.
 562  *
 563  * Maximum space requirement for the target buffer is three UTF-8 chars per
 564  * wide char ((_wcslen(wcs) * 3) + 1).
 565  *
 566  * The maximum space is needed only if the entire input string consists of
 567  * UTF-16 words in range 0x0800-0xd7ff or 0xe000-0xffff (i.e. \u0800-\uffff
 568  * modulo surrogate pairs), as per the following table:
 569  *
 570  *               |                       | UTF-16 | UTF-8 |
 571  *   Code point  |  UTF-16 sequence      | words  | bytes | ratio
 572  * --------------+-----------------------+--------+-------+-------
 573  * 000000-00007f | 0000-007f             |   1    |   1   |  1
 574  * 000080-0007ff | 0080-07ff             |   1    |   2   |  2
 575  * 000800-00ffff | 0800-d7ff / e000-ffff |   1    |   3   |  3
 576  * 010000-10ffff | d800-dbff + dc00-dfff |   2    |   4   |  2
 577  *
 578  * Note that invalid code points > 10ffff cannot be represented in UTF-16.
 579  *
 580  * Parameters:
 581  * utf: target buffer
 582  * wcs: wide string to convert
 583  * utflen: size of target buffer
 584  *
 585  * Returns:
 586  * length of converted string, or -1 on failure
 587  *
 588  * Errors:
 589  * EINVAL: one of the input parameters is invalid (e.g. NULL)
 590  * ERANGE: the output buffer is too small
 591  */
 592 int xwcstoutf(char *utf, const wchar_t *wcs, size_t utflen);
 593
 594 /*
 595  * A critical section used in the implementation of the spawn
 596  * functions (mingw_spawnv[p]e()) and waitpid(). Initialised in
 597  * the replacement main() macro below.
 598  */
 599 extern CRITICAL_SECTION pinfo_cs;
 600
 601 /*
 602  * Git, like most portable C applications, implements a main() function. On
 603  * Windows, this main() function would receive parameters encoded in the
 604  * current locale, but Git for Windows would prefer UTF-8 encoded  parameters.
 605  *
 606  * To make that happen, we still declare main() here, and then declare and
 607  * implement wmain() (which is the Unicode variant of main()) and compile with
 608  * -municode. This wmain() function reencodes the parameters from UTF-16 to
 609  * UTF-8 format, sets up a couple of other things as required on Windows, and
 610  * then hands off to the main() function.
 611  */
 612 int wmain(int argc, const wchar_t **w_argv);
 613 int main(int argc, const char **argv);
 614
 615 /*
 616  * For debugging: if a problem occurs, say, in a Git process that is spawned
 617  * from another Git process which in turn is spawned from yet another Git
 618  * process, it can be quite daunting to figure out what is going on.
 619  *
 620  * Call this function to open a new MinTTY (this assumes you are in Git for
 621  * Windows' SDK) with a GDB that attaches to the current process right away.
 622  */
 623 void open_in_gdb(void);
 624
 625 /*
 626  * Used by Pthread API implementation for Windows
 627  */
 628 int err_win_to_posix(DWORD winerr);