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