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