Merge branch 'jk/perf-no-dups'
[git/git.git] / 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 extern 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
231 int mingw_fgetc(FILE *stream);
232 #define fgetc mingw_fgetc
233
234 FILE *mingw_fopen (const char *filename, const char *otype);
235 #define fopen mingw_fopen
236
237 FILE *mingw_freopen (const char *filename, const char *otype, FILE *stream);
238 #define freopen mingw_freopen
239
240 int mingw_fflush(FILE *stream);
241 #define fflush mingw_fflush
242
243 ssize_t mingw_write(int fd, const void *buf, size_t len);
244 #define write mingw_write
245
246 int mingw_access(const char *filename, int mode);
247 #undef access
248 #define access mingw_access
249
250 int mingw_chdir(const char *dirname);
251 #define chdir mingw_chdir
252
253 int mingw_chmod(const char *filename, int mode);
254 #define chmod mingw_chmod
255
256 char *mingw_mktemp(char *template);
257 #define mktemp mingw_mktemp
258
259 char *mingw_getcwd(char *pointer, int len);
260 #define getcwd mingw_getcwd
261
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
289 char *mingw_getenv(const char *name);
290 int mingw_putenv(const char *name);
291
292 int mingw_gethostname(char *host, int namelen);
293 #define gethostname mingw_gethostname
294
295 struct hostent *mingw_gethostbyname(const char *host);
296 #define gethostbyname mingw_gethostbyname
297
298 int mingw_getaddrinfo(const char *node, const char *service,
299 const struct addrinfo *hints, struct addrinfo **res);
300 #define getaddrinfo mingw_getaddrinfo
301
302 int mingw_socket(int domain, int type, int protocol);
303 #define socket mingw_socket
304
305 int mingw_connect(int sockfd, struct sockaddr *sa, size_t sz);
306 #define connect mingw_connect
307
308 int mingw_bind(int sockfd, struct sockaddr *sa, size_t sz);
309 #define bind mingw_bind
310
311 int mingw_setsockopt(int sockfd, int lvl, int optname, void *optval, int optlen);
312 #define setsockopt mingw_setsockopt
313
314 int mingw_shutdown(int sockfd, int how);
315 #define shutdown mingw_shutdown
316
317 int mingw_listen(int sockfd, int backlog);
318 #define listen mingw_listen
319
320 int mingw_accept(int sockfd, struct sockaddr *sa, socklen_t *sz);
321 #define accept mingw_accept
322
323 int mingw_rename(const char*, const char*);
324 #define rename mingw_rename
325
326 #if defined(USE_WIN32_MMAP) || defined(_MSC_VER)
327 int mingw_getpagesize(void);
328 #define getpagesize mingw_getpagesize
329 #endif
330
331 struct rlimit {
332 unsigned int rlim_cur;
333 };
334 #define RLIMIT_NOFILE 0
335
336 static 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
347 /*
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.
351 */
352 #ifndef __MINGW64_VERSION_MAJOR
353 #define off_t off64_t
354 #define lseek _lseeki64
355 #ifndef _MSC_VER
356 struct timespec {
357 time_t tv_sec;
358 long tv_nsec;
359 };
360 #endif
361 #endif
362
363 struct 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
381 #ifdef stat
382 #undef stat
383 #endif
384 #define stat mingw_stat
385 int mingw_lstat(const char *file_name, struct stat *buf);
386 int mingw_stat(const char *file_name, struct stat *buf);
387 int mingw_fstat(int fd, struct stat *buf);
388 #ifdef fstat
389 #undef fstat
390 #endif
391 #define fstat mingw_fstat
392 #ifdef lstat
393 #undef lstat
394 #endif
395 #define lstat mingw_lstat
396
397
398 int mingw_utime(const char *file_name, const struct utimbuf *times);
399 #define utime mingw_utime
400 size_t mingw_strftime(char *s, size_t max,
401 const char *format, const struct tm *tm);
402 #define strftime mingw_strftime
403
404 pid_t mingw_spawnvpe(const char *cmd, const char **argv, char **env,
405 const char *dir,
406 int fhin, int fhout, int fherr);
407 int mingw_execvp(const char *cmd, char *const *argv);
408 #define execvp mingw_execvp
409 int mingw_execv(const char *cmd, char *const *argv);
410 #define execv mingw_execv
411
412 static inline unsigned int git_ntohl(unsigned int x)
413 { return (unsigned int)ntohl(x); }
414 #define ntohl git_ntohl
415
416 sig_handler_t mingw_signal(int sig, sig_handler_t handler);
417 #define signal mingw_signal
418
419 int mingw_raise(int sig);
420 #define raise mingw_raise
421
422 /*
423 * ANSI emulation wrappers
424 */
425
426 int winansi_isatty(int fd);
427 #define isatty winansi_isatty
428
429 int winansi_dup2(int oldfd, int newfd);
430 #define dup2 winansi_dup2
431
432 void winansi_init(void);
433 HANDLE winansi_get_osfhandle(int fd);
434
435 /*
436 * git specific compatibility
437 */
438
439 static inline void convert_slashes(char *path)
440 {
441 for (; *path; path++)
442 if (*path == '\\')
443 *path = '/';
444 }
445 #define PATH_SEP ';'
446 extern char *mingw_query_user_email(void);
447 #define query_user_email mingw_query_user_email
448 #if !defined(__MINGW64_VERSION_MAJOR) && (!defined(_MSC_VER) || _MSC_VER < 1800)
449 #define PRIuMAX "I64u"
450 #define PRId64 "I64d"
451 #else
452 #include <inttypes.h>
453 #endif
454
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 */
502 int 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 */
507 static 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 */
517 static 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 */
557 int xwcstoutf(char *utf, const wchar_t *wcs, size_t utflen);
558
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 */
564 extern CRITICAL_SECTION pinfo_cs;
565
566 /*
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.
576 */
577 int wmain(int argc, const wchar_t **w_argv);
578 int main(int argc, const char **argv);
579
580 /*
581 * Used by Pthread API implementation for Windows
582 */
583 extern int err_win_to_posix(DWORD winerr);