Merge branch 'js/mingw-perl5lib'
[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 /* bash cannot reliably detect negative return codes as failure */
151 #define exit(code) exit((code) & 0xff)
152 #define sigemptyset(x) (void)0
153 static inline int sigaddset(sigset_t *set, int signum)
154 { return 0; }
155 #define SIG_BLOCK 0
156 #define SIG_UNBLOCK 0
157 static inline int sigprocmask(int how, const sigset_t *set, sigset_t *oldset)
158 { return 0; }
159 static inline pid_t getppid(void)
160 { return 1; }
161 static inline pid_t getpgid(pid_t pid)
162 { return pid == 0 ? getpid() : pid; }
163 static inline pid_t tcgetpgrp(int fd)
164 { return getpid(); }
165
166 /*
167 * simple adaptors
168 */
169
170 int mingw_mkdir(const char *path, int mode);
171 #define mkdir mingw_mkdir
172
173 #define WNOHANG 1
174 pid_t waitpid(pid_t pid, int *status, int options);
175
176 #define kill mingw_kill
177 int mingw_kill(pid_t pid, int sig);
178
179 #ifndef NO_OPENSSL
180 #include <openssl/ssl.h>
181 static inline int mingw_SSL_set_fd(SSL *ssl, int fd)
182 {
183 return SSL_set_fd(ssl, _get_osfhandle(fd));
184 }
185 #define SSL_set_fd mingw_SSL_set_fd
186
187 static inline int mingw_SSL_set_rfd(SSL *ssl, int fd)
188 {
189 return SSL_set_rfd(ssl, _get_osfhandle(fd));
190 }
191 #define SSL_set_rfd mingw_SSL_set_rfd
192
193 static inline int mingw_SSL_set_wfd(SSL *ssl, int fd)
194 {
195 return SSL_set_wfd(ssl, _get_osfhandle(fd));
196 }
197 #define SSL_set_wfd mingw_SSL_set_wfd
198 #endif
199
200 /*
201 * implementations of missing functions
202 */
203
204 int pipe(int filedes[2]);
205 unsigned int sleep (unsigned int seconds);
206 int mkstemp(char *template);
207 int gettimeofday(struct timeval *tv, void *tz);
208 #ifndef __MINGW64_VERSION_MAJOR
209 struct tm *gmtime_r(const time_t *timep, struct tm *result);
210 struct tm *localtime_r(const time_t *timep, struct tm *result);
211 #endif
212 int getpagesize(void); /* defined in MinGW's libgcc.a */
213 struct passwd *getpwuid(uid_t uid);
214 int setitimer(int type, struct itimerval *in, struct itimerval *out);
215 int sigaction(int sig, struct sigaction *in, struct sigaction *out);
216 int link(const char *oldpath, const char *newpath);
217 int uname(struct utsname *buf);
218
219 /*
220 * replacements of existing functions
221 */
222
223 int mingw_unlink(const char *pathname);
224 #define unlink mingw_unlink
225
226 int mingw_rmdir(const char *path);
227 #define rmdir mingw_rmdir
228
229 int mingw_open (const char *filename, int oflags, ...);
230 #define open mingw_open
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 char *mingw_getenv(const char *name);
264 #define getenv mingw_getenv
265 int mingw_putenv(const char *namevalue);
266 #define putenv mingw_putenv
267 #define unsetenv mingw_putenv
268
269 int mingw_gethostname(char *host, int namelen);
270 #define gethostname mingw_gethostname
271
272 struct hostent *mingw_gethostbyname(const char *host);
273 #define gethostbyname mingw_gethostbyname
274
275 void mingw_freeaddrinfo(struct addrinfo *res);
276 #define freeaddrinfo mingw_freeaddrinfo
277
278 int mingw_getaddrinfo(const char *node, const char *service,
279 const struct addrinfo *hints, struct addrinfo **res);
280 #define getaddrinfo mingw_getaddrinfo
281
282 int mingw_getnameinfo(const struct sockaddr *sa, socklen_t salen,
283 char *host, DWORD hostlen, char *serv, DWORD servlen,
284 int flags);
285 #define getnameinfo mingw_getnameinfo
286
287 int mingw_socket(int domain, int type, int protocol);
288 #define socket mingw_socket
289
290 int mingw_connect(int sockfd, struct sockaddr *sa, size_t sz);
291 #define connect mingw_connect
292
293 int mingw_bind(int sockfd, struct sockaddr *sa, size_t sz);
294 #define bind mingw_bind
295
296 int mingw_setsockopt(int sockfd, int lvl, int optname, void *optval, int optlen);
297 #define setsockopt mingw_setsockopt
298
299 int mingw_shutdown(int sockfd, int how);
300 #define shutdown mingw_shutdown
301
302 int mingw_listen(int sockfd, int backlog);
303 #define listen mingw_listen
304
305 int mingw_accept(int sockfd, struct sockaddr *sa, socklen_t *sz);
306 #define accept mingw_accept
307
308 int mingw_rename(const char*, const char*);
309 #define rename mingw_rename
310
311 #if defined(USE_WIN32_MMAP) || defined(_MSC_VER)
312 int mingw_getpagesize(void);
313 #define getpagesize mingw_getpagesize
314 #endif
315
316 struct rlimit {
317 unsigned int rlim_cur;
318 };
319 #define RLIMIT_NOFILE 0
320
321 static inline int getrlimit(int resource, struct rlimit *rlp)
322 {
323 if (resource != RLIMIT_NOFILE) {
324 errno = EINVAL;
325 return -1;
326 }
327
328 rlp->rlim_cur = 2048;
329 return 0;
330 }
331
332 /*
333 * Use mingw specific stat()/lstat()/fstat() implementations on Windows,
334 * including our own struct stat with 64 bit st_size and nanosecond-precision
335 * file times.
336 */
337 #ifndef __MINGW64_VERSION_MAJOR
338 #define off_t off64_t
339 #define lseek _lseeki64
340 struct timespec {
341 time_t tv_sec;
342 long tv_nsec;
343 };
344 #endif
345
346 struct mingw_stat {
347 _dev_t st_dev;
348 _ino_t st_ino;
349 _mode_t st_mode;
350 short st_nlink;
351 short st_uid;
352 short st_gid;
353 _dev_t st_rdev;
354 off64_t st_size;
355 struct timespec st_atim;
356 struct timespec st_mtim;
357 struct timespec st_ctim;
358 };
359
360 #define st_atime st_atim.tv_sec
361 #define st_mtime st_mtim.tv_sec
362 #define st_ctime st_ctim.tv_sec
363
364 #ifdef stat
365 #undef stat
366 #endif
367 #define stat mingw_stat
368 int mingw_lstat(const char *file_name, struct stat *buf);
369 int mingw_stat(const char *file_name, struct stat *buf);
370 int mingw_fstat(int fd, struct stat *buf);
371 #ifdef fstat
372 #undef fstat
373 #endif
374 #define fstat mingw_fstat
375 #ifdef lstat
376 #undef lstat
377 #endif
378 #define lstat mingw_lstat
379
380
381 int mingw_utime(const char *file_name, const struct utimbuf *times);
382 #define utime mingw_utime
383 size_t mingw_strftime(char *s, size_t max,
384 const char *format, const struct tm *tm);
385 #define strftime mingw_strftime
386
387 pid_t mingw_spawnvpe(const char *cmd, const char **argv, char **env,
388 const char *dir,
389 int fhin, int fhout, int fherr);
390 int mingw_execvp(const char *cmd, char *const *argv);
391 #define execvp mingw_execvp
392 int mingw_execv(const char *cmd, char *const *argv);
393 #define execv mingw_execv
394
395 static inline unsigned int git_ntohl(unsigned int x)
396 { return (unsigned int)ntohl(x); }
397 #define ntohl git_ntohl
398
399 sig_handler_t mingw_signal(int sig, sig_handler_t handler);
400 #define signal mingw_signal
401
402 int mingw_raise(int sig);
403 #define raise mingw_raise
404
405 /*
406 * ANSI emulation wrappers
407 */
408
409 int winansi_isatty(int fd);
410 #define isatty winansi_isatty
411
412 int winansi_dup2(int oldfd, int newfd);
413 #define dup2 winansi_dup2
414
415 void winansi_init(void);
416 HANDLE winansi_get_osfhandle(int fd);
417
418 /*
419 * git specific compatibility
420 */
421
422 #define has_dos_drive_prefix(path) \
423 (isalpha(*(path)) && (path)[1] == ':' ? 2 : 0)
424 int mingw_skip_dos_drive_prefix(char **path);
425 #define skip_dos_drive_prefix mingw_skip_dos_drive_prefix
426 static inline int mingw_is_dir_sep(int c)
427 {
428 return c == '/' || c == '\\';
429 }
430 #define is_dir_sep mingw_is_dir_sep
431 static inline char *mingw_find_last_dir_sep(const char *path)
432 {
433 char *ret = NULL;
434 for (; *path; ++path)
435 if (is_dir_sep(*path))
436 ret = (char *)path;
437 return ret;
438 }
439 static inline void convert_slashes(char *path)
440 {
441 for (; *path; path++)
442 if (*path == '\\')
443 *path = '/';
444 }
445 #define find_last_dir_sep mingw_find_last_dir_sep
446 int mingw_offset_1st_component(const char *path);
447 #define offset_1st_component mingw_offset_1st_component
448 #define PATH_SEP ';'
449 extern char *mingw_query_user_email(void);
450 #define query_user_email mingw_query_user_email
451 #if !defined(__MINGW64_VERSION_MAJOR) && (!defined(_MSC_VER) || _MSC_VER < 1800)
452 #define PRIuMAX "I64u"
453 #define PRId64 "I64d"
454 #else
455 #include <inttypes.h>
456 #endif
457
458 /**
459 * Converts UTF-8 encoded string to UTF-16LE.
460 *
461 * To support repositories with legacy-encoded file names, invalid UTF-8 bytes
462 * 0xa0 - 0xff are converted to corresponding printable Unicode chars \u00a0 -
463 * \u00ff, and invalid UTF-8 bytes 0x80 - 0x9f (which would make non-printable
464 * Unicode) are converted to hex-code.
465 *
466 * Lead-bytes not followed by an appropriate number of trail-bytes, over-long
467 * encodings and 4-byte encodings > \u10ffff are detected as invalid UTF-8.
468 *
469 * Maximum space requirement for the target buffer is two wide chars per UTF-8
470 * char (((strlen(utf) * 2) + 1) [* sizeof(wchar_t)]).
471 *
472 * The maximum space is needed only if the entire input string consists of
473 * invalid UTF-8 bytes in range 0x80-0x9f, as per the following table:
474 *
475 * | | UTF-8 | UTF-16 |
476 * Code point | UTF-8 sequence | bytes | words | ratio
477 * --------------+-------------------+-------+--------+-------
478 * 000000-00007f | 0-7f | 1 | 1 | 1
479 * 000080-0007ff | c2-df + 80-bf | 2 | 1 | 0.5
480 * 000800-00ffff | e0-ef + 2 * 80-bf | 3 | 1 | 0.33
481 * 010000-10ffff | f0-f4 + 3 * 80-bf | 4 | 2 (a) | 0.5
482 * invalid | 80-9f | 1 | 2 (b) | 2
483 * invalid | a0-ff | 1 | 1 | 1
484 *
485 * (a) encoded as UTF-16 surrogate pair
486 * (b) encoded as two hex digits
487 *
488 * Note that, while the UTF-8 encoding scheme can be extended to 5-byte, 6-byte
489 * or even indefinite-byte sequences, the largest valid code point \u10ffff
490 * encodes as only 4 UTF-8 bytes.
491 *
492 * Parameters:
493 * wcs: wide char target buffer
494 * utf: string to convert
495 * wcslen: size of target buffer (in wchar_t's)
496 * utflen: size of string to convert, or -1 if 0-terminated
497 *
498 * Returns:
499 * length of converted string (_wcslen(wcs)), or -1 on failure
500 *
501 * Errors:
502 * EINVAL: one of the input parameters is invalid (e.g. NULL)
503 * ERANGE: the output buffer is too small
504 */
505 int xutftowcsn(wchar_t *wcs, const char *utf, size_t wcslen, int utflen);
506
507 /**
508 * Simplified variant of xutftowcsn, assumes input string is \0-terminated.
509 */
510 static inline int xutftowcs(wchar_t *wcs, const char *utf, size_t wcslen)
511 {
512 return xutftowcsn(wcs, utf, wcslen, -1);
513 }
514
515 /**
516 * Simplified file system specific variant of xutftowcsn, assumes output
517 * buffer size is MAX_PATH wide chars and input string is \0-terminated,
518 * fails with ENAMETOOLONG if input string is too long.
519 */
520 static inline int xutftowcs_path(wchar_t *wcs, const char *utf)
521 {
522 int result = xutftowcsn(wcs, utf, MAX_PATH, -1);
523 if (result < 0 && errno == ERANGE)
524 errno = ENAMETOOLONG;
525 return result;
526 }
527
528 /**
529 * Converts UTF-16LE encoded string to UTF-8.
530 *
531 * Maximum space requirement for the target buffer is three UTF-8 chars per
532 * wide char ((_wcslen(wcs) * 3) + 1).
533 *
534 * The maximum space is needed only if the entire input string consists of
535 * UTF-16 words in range 0x0800-0xd7ff or 0xe000-0xffff (i.e. \u0800-\uffff
536 * modulo surrogate pairs), as per the following table:
537 *
538 * | | UTF-16 | UTF-8 |
539 * Code point | UTF-16 sequence | words | bytes | ratio
540 * --------------+-----------------------+--------+-------+-------
541 * 000000-00007f | 0000-007f | 1 | 1 | 1
542 * 000080-0007ff | 0080-07ff | 1 | 2 | 2
543 * 000800-00ffff | 0800-d7ff / e000-ffff | 1 | 3 | 3
544 * 010000-10ffff | d800-dbff + dc00-dfff | 2 | 4 | 2
545 *
546 * Note that invalid code points > 10ffff cannot be represented in UTF-16.
547 *
548 * Parameters:
549 * utf: target buffer
550 * wcs: wide string to convert
551 * utflen: size of target buffer
552 *
553 * Returns:
554 * length of converted string, or -1 on failure
555 *
556 * Errors:
557 * EINVAL: one of the input parameters is invalid (e.g. NULL)
558 * ERANGE: the output buffer is too small
559 */
560 int xwcstoutf(char *utf, const wchar_t *wcs, size_t utflen);
561
562 /*
563 * A critical section used in the implementation of the spawn
564 * functions (mingw_spawnv[p]e()) and waitpid(). Intialised in
565 * the replacement main() macro below.
566 */
567 extern CRITICAL_SECTION pinfo_cs;
568
569 /*
570 * A replacement of main() that adds win32 specific initialization.
571 */
572
573 void mingw_startup(void);
574 #define main(c,v) dummy_decl_mingw_main(void); \
575 static int mingw_main(c,v); \
576 int main(int argc, const char **argv) \
577 { \
578 mingw_startup(); \
579 return mingw_main(__argc, (void *)__argv); \
580 } \
581 static int mingw_main(c,v)
582
583 /*
584 * Used by Pthread API implementation for Windows
585 */
586 extern int err_win_to_posix(DWORD winerr);