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