Merge branch 'cc/shared-index-permbits'
[git/git-svn.git] / compat / mingw.h
blob8c24ddaa3efc20e4454ebc87c51fa30316f64a22
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 extern int mingw_core_config(const char *var, const char *value, void *cb);
15 #define platform_core_config mingw_core_config
18 * things that are not available in header files
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
28 #define S_IFLNK 0120000 /* Symbolic link */
29 #define S_ISLNK(x) (((x) & S_IFMT) == S_IFLNK)
30 #define S_ISSOCK(x) 0
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
45 #define S_ISUID 0004000
46 #define S_ISGID 0002000
47 #define S_ISVTX 0001000
49 #define WIFEXITED(x) 1
50 #define WIFSIGNALED(x) 0
51 #define WEXITSTATUS(x) ((x) & 0xff)
52 #define WTERMSIG(x) SIGTERM
54 #ifndef EWOULDBLOCK
55 #define EWOULDBLOCK EAGAIN
56 #endif
57 #ifndef ELOOP
58 #define ELOOP EMLINK
59 #endif
60 #define SHUT_WR SD_SEND
62 #define SIGHUP 1
63 #define SIGQUIT 3
64 #define SIGKILL 9
65 #define SIGPIPE 13
66 #define SIGALRM 14
67 #define SIGCHLD 17
69 #define F_GETFD 1
70 #define F_SETFD 2
71 #define FD_CLOEXEC 0x1
73 #if !defined O_CLOEXEC && defined O_NOINHERIT
74 #define O_CLOEXEC O_NOINHERIT
75 #endif
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
87 struct passwd {
88 char *pw_name;
89 char *pw_gecos;
90 char *pw_dir;
93 typedef void (__cdecl *sig_handler_t)(int);
94 struct sigaction {
95 sig_handler_t sa_handler;
96 unsigned sa_flags;
98 #define SA_RESTART 0
100 struct itimerval {
101 struct timeval it_value, it_interval;
103 #define ITIMER_REAL 0
105 struct utsname {
106 char sysname[16];
107 char nodename[1];
108 char release[16];
109 char version[16];
110 char machine[1];
114 * sanitize preprocessor namespace polluted by Windows headers defining
115 * macros which collide with git local versions
117 #undef HELP_COMMAND /* from winuser.h */
120 * trivial stubs
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)
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, ...)
145 if (cmd == F_GETFD || cmd == F_SETFD)
146 return 0;
147 errno = EINVAL;
148 return -1;
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(); }
167 * simple adaptors
170 int mingw_mkdir(const char *path, int mode);
171 #define mkdir mingw_mkdir
173 #define WNOHANG 1
174 pid_t waitpid(pid_t pid, int *status, int options);
176 #define kill mingw_kill
177 int mingw_kill(pid_t pid, int sig);
179 #ifndef NO_OPENSSL
180 #include <openssl/ssl.h>
181 static inline int mingw_SSL_set_fd(SSL *ssl, int fd)
183 return SSL_set_fd(ssl, _get_osfhandle(fd));
185 #define SSL_set_fd mingw_SSL_set_fd
187 static inline int mingw_SSL_set_rfd(SSL *ssl, int fd)
189 return SSL_set_rfd(ssl, _get_osfhandle(fd));
191 #define SSL_set_rfd mingw_SSL_set_rfd
193 static inline int mingw_SSL_set_wfd(SSL *ssl, int fd)
195 return SSL_set_wfd(ssl, _get_osfhandle(fd));
197 #define SSL_set_wfd mingw_SSL_set_wfd
198 #endif
201 * implementations of missing functions
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);
220 * replacements of existing functions
223 int mingw_unlink(const char *pathname);
224 #define unlink mingw_unlink
226 int mingw_rmdir(const char *path);
227 #define rmdir mingw_rmdir
229 int mingw_open (const char *filename, int oflags, ...);
230 #define open mingw_open
232 int mingw_fgetc(FILE *stream);
233 #define fgetc mingw_fgetc
235 FILE *mingw_fopen (const char *filename, const char *otype);
236 #define fopen mingw_fopen
238 FILE *mingw_freopen (const char *filename, const char *otype, FILE *stream);
239 #define freopen mingw_freopen
241 int mingw_fflush(FILE *stream);
242 #define fflush mingw_fflush
244 ssize_t mingw_write(int fd, const void *buf, size_t len);
245 #define write mingw_write
247 int mingw_access(const char *filename, int mode);
248 #undef access
249 #define access mingw_access
251 int mingw_chdir(const char *dirname);
252 #define chdir mingw_chdir
254 int mingw_chmod(const char *filename, int mode);
255 #define chmod mingw_chmod
257 char *mingw_mktemp(char *template);
258 #define mktemp mingw_mktemp
260 char *mingw_getcwd(char *pointer, int len);
261 #define getcwd mingw_getcwd
263 #ifdef NO_UNSETENV
264 #error "NO_UNSETENV is incompatible with the Windows-specific startup code!"
265 #endif
268 * We bind *env() routines (even the mingw_ ones) to private mingw_ versions.
269 * These talk to the CRT using UNICODE/wchar_t, but maintain the original
270 * narrow-char API.
272 * Note that the MSCRT maintains both ANSI (getenv()) and UNICODE (_wgetenv())
273 * routines and stores both versions of each environment variable in parallel
274 * (and secretly updates both when you set one or the other), but it uses CP_ACP
275 * to do the conversion rather than CP_UTF8.
277 * Since everything in the git code base is UTF8, we define the mingw_ routines
278 * to access the CRT using the UNICODE routines and manually convert them to
279 * UTF8. This also avoids round-trip problems.
281 * This also helps with our linkage, since "_wenviron" is publicly exported
282 * from the CRT. But to access "_environ" we would have to statically link
283 * to the CRT (/MT).
285 * We require NO_SETENV (and let gitsetenv() call our mingw_putenv).
287 #define getenv mingw_getenv
288 #define putenv mingw_putenv
289 #define unsetenv mingw_putenv
290 char *mingw_getenv(const char *name);
291 int mingw_putenv(const char *name);
293 int mingw_gethostname(char *host, int namelen);
294 #define gethostname mingw_gethostname
296 struct hostent *mingw_gethostbyname(const char *host);
297 #define gethostbyname mingw_gethostbyname
299 void mingw_freeaddrinfo(struct addrinfo *res);
300 #define freeaddrinfo mingw_freeaddrinfo
302 int mingw_getaddrinfo(const char *node, const char *service,
303 const struct addrinfo *hints, struct addrinfo **res);
304 #define getaddrinfo mingw_getaddrinfo
306 int mingw_getnameinfo(const struct sockaddr *sa, socklen_t salen,
307 char *host, DWORD hostlen, char *serv, DWORD servlen,
308 int flags);
309 #define getnameinfo mingw_getnameinfo
311 int mingw_socket(int domain, int type, int protocol);
312 #define socket mingw_socket
314 int mingw_connect(int sockfd, struct sockaddr *sa, size_t sz);
315 #define connect mingw_connect
317 int mingw_bind(int sockfd, struct sockaddr *sa, size_t sz);
318 #define bind mingw_bind
320 int mingw_setsockopt(int sockfd, int lvl, int optname, void *optval, int optlen);
321 #define setsockopt mingw_setsockopt
323 int mingw_shutdown(int sockfd, int how);
324 #define shutdown mingw_shutdown
326 int mingw_listen(int sockfd, int backlog);
327 #define listen mingw_listen
329 int mingw_accept(int sockfd, struct sockaddr *sa, socklen_t *sz);
330 #define accept mingw_accept
332 int mingw_rename(const char*, const char*);
333 #define rename mingw_rename
335 #if defined(USE_WIN32_MMAP) || defined(_MSC_VER)
336 int mingw_getpagesize(void);
337 #define getpagesize mingw_getpagesize
338 #endif
340 struct rlimit {
341 unsigned int rlim_cur;
343 #define RLIMIT_NOFILE 0
345 static inline int getrlimit(int resource, struct rlimit *rlp)
347 if (resource != RLIMIT_NOFILE) {
348 errno = EINVAL;
349 return -1;
352 rlp->rlim_cur = 2048;
353 return 0;
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.
361 #ifndef __MINGW64_VERSION_MAJOR
362 #define off_t off64_t
363 #define lseek _lseeki64
364 struct timespec {
365 time_t tv_sec;
366 long tv_nsec;
368 #endif
370 struct mingw_stat {
371 _dev_t st_dev;
372 _ino_t st_ino;
373 _mode_t st_mode;
374 short st_nlink;
375 short st_uid;
376 short st_gid;
377 _dev_t st_rdev;
378 off64_t st_size;
379 struct timespec st_atim;
380 struct timespec st_mtim;
381 struct timespec st_ctim;
384 #define st_atime st_atim.tv_sec
385 #define st_mtime st_mtim.tv_sec
386 #define st_ctime st_ctim.tv_sec
388 #ifdef stat
389 #undef stat
390 #endif
391 #define stat mingw_stat
392 int mingw_lstat(const char *file_name, struct stat *buf);
393 int mingw_stat(const char *file_name, struct stat *buf);
394 int mingw_fstat(int fd, struct stat *buf);
395 #ifdef fstat
396 #undef fstat
397 #endif
398 #define fstat mingw_fstat
399 #ifdef lstat
400 #undef lstat
401 #endif
402 #define lstat mingw_lstat
405 int mingw_utime(const char *file_name, const struct utimbuf *times);
406 #define utime mingw_utime
407 size_t mingw_strftime(char *s, size_t max,
408 const char *format, const struct tm *tm);
409 #define strftime mingw_strftime
411 pid_t mingw_spawnvpe(const char *cmd, const char **argv, char **env,
412 const char *dir,
413 int fhin, int fhout, int fherr);
414 int mingw_execvp(const char *cmd, char *const *argv);
415 #define execvp mingw_execvp
416 int mingw_execv(const char *cmd, char *const *argv);
417 #define execv mingw_execv
419 static inline unsigned int git_ntohl(unsigned int x)
420 { return (unsigned int)ntohl(x); }
421 #define ntohl git_ntohl
423 sig_handler_t mingw_signal(int sig, sig_handler_t handler);
424 #define signal mingw_signal
426 int mingw_raise(int sig);
427 #define raise mingw_raise
430 * ANSI emulation wrappers
433 int winansi_isatty(int fd);
434 #define isatty winansi_isatty
436 int winansi_dup2(int oldfd, int newfd);
437 #define dup2 winansi_dup2
439 void winansi_init(void);
440 HANDLE winansi_get_osfhandle(int fd);
443 * git specific compatibility
446 #define has_dos_drive_prefix(path) \
447 (isalpha(*(path)) && (path)[1] == ':' ? 2 : 0)
448 int mingw_skip_dos_drive_prefix(char **path);
449 #define skip_dos_drive_prefix mingw_skip_dos_drive_prefix
450 static inline int mingw_is_dir_sep(int c)
452 return c == '/' || c == '\\';
454 #define is_dir_sep mingw_is_dir_sep
455 static inline char *mingw_find_last_dir_sep(const char *path)
457 char *ret = NULL;
458 for (; *path; ++path)
459 if (is_dir_sep(*path))
460 ret = (char *)path;
461 return ret;
463 static inline void convert_slashes(char *path)
465 for (; *path; path++)
466 if (*path == '\\')
467 *path = '/';
469 #define find_last_dir_sep mingw_find_last_dir_sep
470 int mingw_offset_1st_component(const char *path);
471 #define offset_1st_component mingw_offset_1st_component
472 #define PATH_SEP ';'
473 extern char *mingw_query_user_email(void);
474 #define query_user_email mingw_query_user_email
475 #if !defined(__MINGW64_VERSION_MAJOR) && (!defined(_MSC_VER) || _MSC_VER < 1800)
476 #define PRIuMAX "I64u"
477 #define PRId64 "I64d"
478 #else
479 #include <inttypes.h>
480 #endif
483 * Converts UTF-8 encoded string to UTF-16LE.
485 * To support repositories with legacy-encoded file names, invalid UTF-8 bytes
486 * 0xa0 - 0xff are converted to corresponding printable Unicode chars \u00a0 -
487 * \u00ff, and invalid UTF-8 bytes 0x80 - 0x9f (which would make non-printable
488 * Unicode) are converted to hex-code.
490 * Lead-bytes not followed by an appropriate number of trail-bytes, over-long
491 * encodings and 4-byte encodings > \u10ffff are detected as invalid UTF-8.
493 * Maximum space requirement for the target buffer is two wide chars per UTF-8
494 * char (((strlen(utf) * 2) + 1) [* sizeof(wchar_t)]).
496 * The maximum space is needed only if the entire input string consists of
497 * invalid UTF-8 bytes in range 0x80-0x9f, as per the following table:
499 * | | UTF-8 | UTF-16 |
500 * Code point | UTF-8 sequence | bytes | words | ratio
501 * --------------+-------------------+-------+--------+-------
502 * 000000-00007f | 0-7f | 1 | 1 | 1
503 * 000080-0007ff | c2-df + 80-bf | 2 | 1 | 0.5
504 * 000800-00ffff | e0-ef + 2 * 80-bf | 3 | 1 | 0.33
505 * 010000-10ffff | f0-f4 + 3 * 80-bf | 4 | 2 (a) | 0.5
506 * invalid | 80-9f | 1 | 2 (b) | 2
507 * invalid | a0-ff | 1 | 1 | 1
509 * (a) encoded as UTF-16 surrogate pair
510 * (b) encoded as two hex digits
512 * Note that, while the UTF-8 encoding scheme can be extended to 5-byte, 6-byte
513 * or even indefinite-byte sequences, the largest valid code point \u10ffff
514 * encodes as only 4 UTF-8 bytes.
516 * Parameters:
517 * wcs: wide char target buffer
518 * utf: string to convert
519 * wcslen: size of target buffer (in wchar_t's)
520 * utflen: size of string to convert, or -1 if 0-terminated
522 * Returns:
523 * length of converted string (_wcslen(wcs)), or -1 on failure
525 * Errors:
526 * EINVAL: one of the input parameters is invalid (e.g. NULL)
527 * ERANGE: the output buffer is too small
529 int xutftowcsn(wchar_t *wcs, const char *utf, size_t wcslen, int utflen);
532 * Simplified variant of xutftowcsn, assumes input string is \0-terminated.
534 static inline int xutftowcs(wchar_t *wcs, const char *utf, size_t wcslen)
536 return xutftowcsn(wcs, utf, wcslen, -1);
540 * Simplified file system specific variant of xutftowcsn, assumes output
541 * buffer size is MAX_PATH wide chars and input string is \0-terminated,
542 * fails with ENAMETOOLONG if input string is too long.
544 static inline int xutftowcs_path(wchar_t *wcs, const char *utf)
546 int result = xutftowcsn(wcs, utf, MAX_PATH, -1);
547 if (result < 0 && errno == ERANGE)
548 errno = ENAMETOOLONG;
549 return result;
553 * Converts UTF-16LE encoded string to UTF-8.
555 * Maximum space requirement for the target buffer is three UTF-8 chars per
556 * wide char ((_wcslen(wcs) * 3) + 1).
558 * The maximum space is needed only if the entire input string consists of
559 * UTF-16 words in range 0x0800-0xd7ff or 0xe000-0xffff (i.e. \u0800-\uffff
560 * modulo surrogate pairs), as per the following table:
562 * | | UTF-16 | UTF-8 |
563 * Code point | UTF-16 sequence | words | bytes | ratio
564 * --------------+-----------------------+--------+-------+-------
565 * 000000-00007f | 0000-007f | 1 | 1 | 1
566 * 000080-0007ff | 0080-07ff | 1 | 2 | 2
567 * 000800-00ffff | 0800-d7ff / e000-ffff | 1 | 3 | 3
568 * 010000-10ffff | d800-dbff + dc00-dfff | 2 | 4 | 2
570 * Note that invalid code points > 10ffff cannot be represented in UTF-16.
572 * Parameters:
573 * utf: target buffer
574 * wcs: wide string to convert
575 * utflen: size of target buffer
577 * Returns:
578 * length of converted string, or -1 on failure
580 * Errors:
581 * EINVAL: one of the input parameters is invalid (e.g. NULL)
582 * ERANGE: the output buffer is too small
584 int xwcstoutf(char *utf, const wchar_t *wcs, size_t utflen);
587 * A critical section used in the implementation of the spawn
588 * functions (mingw_spawnv[p]e()) and waitpid(). Intialised in
589 * the replacement main() macro below.
591 extern CRITICAL_SECTION pinfo_cs;
594 * A replacement of main() that adds win32 specific initialization.
597 void mingw_startup(void);
598 #define main(c,v) dummy_decl_mingw_main(void); \
599 static int mingw_main(c,v); \
600 int main(int argc, const char **argv) \
602 mingw_startup(); \
603 return mingw_main(__argc, (void *)__argv); \
605 static int mingw_main(c,v)
608 * Used by Pthread API implementation for Windows
610 extern int err_win_to_posix(DWORD winerr);