Merge branch 'jc/add-u-A-default-to-top' into maint
[git] / compat / mingw.h
1 #include <winsock2.h>
2 #include <ws2tcpip.h>
3
4 /*
5  * things that are not available in header files
6  */
7
8 typedef int pid_t;
9 typedef int uid_t;
10 typedef int socklen_t;
11 #define hstrerror strerror
12
13 #define S_IFLNK    0120000 /* Symbolic link */
14 #define S_ISLNK(x) (((x) & S_IFMT) == S_IFLNK)
15 #define S_ISSOCK(x) 0
16
17 #define S_IRGRP 0
18 #define S_IWGRP 0
19 #define S_IXGRP 0
20 #define S_IRWXG (S_IRGRP | S_IWGRP | S_IXGRP)
21 #define S_IROTH 0
22 #define S_IWOTH 0
23 #define S_IXOTH 0
24 #define S_IRWXO (S_IROTH | S_IWOTH | S_IXOTH)
25
26 #define S_ISUID 0004000
27 #define S_ISGID 0002000
28 #define S_ISVTX 0001000
29
30 #define WIFEXITED(x) 1
31 #define WIFSIGNALED(x) 0
32 #define WEXITSTATUS(x) ((x) & 0xff)
33 #define WTERMSIG(x) SIGTERM
34
35 #ifndef EWOULDBLOCK
36 #define EWOULDBLOCK EAGAIN
37 #endif
38 #ifndef ELOOP
39 #define ELOOP EMLINK
40 #endif
41 #define SHUT_WR SD_SEND
42
43 #define SIGHUP 1
44 #define SIGQUIT 3
45 #define SIGKILL 9
46 #define SIGPIPE 13
47 #define SIGALRM 14
48 #define SIGCHLD 17
49
50 #define F_GETFD 1
51 #define F_SETFD 2
52 #define FD_CLOEXEC 0x1
53
54 #ifndef EAFNOSUPPORT
55 #define EAFNOSUPPORT WSAEAFNOSUPPORT
56 #endif
57 #ifndef ECONNABORTED
58 #define ECONNABORTED WSAECONNABORTED
59 #endif
60
61 struct passwd {
62         char *pw_name;
63         char *pw_gecos;
64         char *pw_dir;
65 };
66
67 typedef void (__cdecl *sig_handler_t)(int);
68 struct sigaction {
69         sig_handler_t sa_handler;
70         unsigned sa_flags;
71 };
72 #define SA_RESTART 0
73
74 struct itimerval {
75         struct timeval it_value, it_interval;
76 };
77 #define ITIMER_REAL 0
78
79 struct utsname {
80         char sysname[16];
81         char nodename[1];
82         char release[16];
83         char version[16];
84         char machine[1];
85 };
86
87 /*
88  * sanitize preprocessor namespace polluted by Windows headers defining
89  * macros which collide with git local versions
90  */
91 #undef HELP_COMMAND /* from winuser.h */
92
93 /*
94  * trivial stubs
95  */
96
97 static inline int readlink(const char *path, char *buf, size_t bufsiz)
98 { errno = ENOSYS; return -1; }
99 static inline int symlink(const char *oldpath, const char *newpath)
100 { errno = ENOSYS; return -1; }
101 static inline int fchmod(int fildes, mode_t mode)
102 { errno = ENOSYS; return -1; }
103 static inline pid_t fork(void)
104 { errno = ENOSYS; return -1; }
105 static inline unsigned int alarm(unsigned int seconds)
106 { return 0; }
107 static inline int fsync(int fd)
108 { return _commit(fd); }
109 static inline void sync(void)
110 {}
111 static inline uid_t getuid(void)
112 { return 1; }
113 static inline struct passwd *getpwnam(const char *name)
114 { return NULL; }
115 static inline int fcntl(int fd, int cmd, ...)
116 {
117         if (cmd == F_GETFD || cmd == F_SETFD)
118                 return 0;
119         errno = EINVAL;
120         return -1;
121 }
122 /* bash cannot reliably detect negative return codes as failure */
123 #define exit(code) exit((code) & 0xff)
124 #define sigemptyset(x) (void)0
125 static inline int sigaddset(sigset_t *set, int signum)
126 { return 0; }
127 #define SIG_UNBLOCK 0
128 static inline int sigprocmask(int how, const sigset_t *set, sigset_t *oldset)
129 { return 0; }
130 static inline pid_t getppid(void)
131 { return 1; }
132 static inline pid_t getpgid(pid_t pid)
133 { return pid == 0 ? getpid() : pid; }
134 static inline pid_t tcgetpgrp(int fd)
135 { return getpid(); }
136
137 /*
138  * simple adaptors
139  */
140
141 int mingw_mkdir(const char *path, int mode);
142 #define mkdir mingw_mkdir
143
144 #define WNOHANG 1
145 pid_t waitpid(pid_t pid, int *status, int options);
146
147 #define kill mingw_kill
148 int mingw_kill(pid_t pid, int sig);
149
150 #ifndef NO_OPENSSL
151 #include <openssl/ssl.h>
152 static inline int mingw_SSL_set_fd(SSL *ssl, int fd)
153 {
154         return SSL_set_fd(ssl, _get_osfhandle(fd));
155 }
156 #define SSL_set_fd mingw_SSL_set_fd
157
158 static inline int mingw_SSL_set_rfd(SSL *ssl, int fd)
159 {
160         return SSL_set_rfd(ssl, _get_osfhandle(fd));
161 }
162 #define SSL_set_rfd mingw_SSL_set_rfd
163
164 static inline int mingw_SSL_set_wfd(SSL *ssl, int fd)
165 {
166         return SSL_set_wfd(ssl, _get_osfhandle(fd));
167 }
168 #define SSL_set_wfd mingw_SSL_set_wfd
169 #endif
170
171 /*
172  * implementations of missing functions
173  */
174
175 int pipe(int filedes[2]);
176 unsigned int sleep (unsigned int seconds);
177 int mkstemp(char *template);
178 int gettimeofday(struct timeval *tv, void *tz);
179 struct tm *gmtime_r(const time_t *timep, struct tm *result);
180 struct tm *localtime_r(const time_t *timep, struct tm *result);
181 int getpagesize(void);  /* defined in MinGW's libgcc.a */
182 struct passwd *getpwuid(uid_t uid);
183 int setitimer(int type, struct itimerval *in, struct itimerval *out);
184 int sigaction(int sig, struct sigaction *in, struct sigaction *out);
185 int link(const char *oldpath, const char *newpath);
186 int uname(struct utsname *buf);
187
188 /*
189  * replacements of existing functions
190  */
191
192 int mingw_unlink(const char *pathname);
193 #define unlink mingw_unlink
194
195 int mingw_rmdir(const char *path);
196 #define rmdir mingw_rmdir
197
198 int mingw_open (const char *filename, int oflags, ...);
199 #define open mingw_open
200
201 int mingw_fgetc(FILE *stream);
202 #define fgetc mingw_fgetc
203
204 FILE *mingw_fopen (const char *filename, const char *otype);
205 #define fopen mingw_fopen
206
207 FILE *mingw_freopen (const char *filename, const char *otype, FILE *stream);
208 #define freopen mingw_freopen
209
210 int mingw_fflush(FILE *stream);
211 #define fflush mingw_fflush
212
213 int mingw_access(const char *filename, int mode);
214 #undef access
215 #define access mingw_access
216
217 int mingw_chdir(const char *dirname);
218 #define chdir mingw_chdir
219
220 int mingw_chmod(const char *filename, int mode);
221 #define chmod mingw_chmod
222
223 char *mingw_mktemp(char *template);
224 #define mktemp mingw_mktemp
225
226 char *mingw_getcwd(char *pointer, int len);
227 #define getcwd mingw_getcwd
228
229 char *mingw_getenv(const char *name);
230 #define getenv mingw_getenv
231 int mingw_putenv(const char *namevalue);
232 #define putenv mingw_putenv
233 #define unsetenv mingw_putenv
234
235 int mingw_gethostname(char *host, int namelen);
236 #define gethostname mingw_gethostname
237
238 struct hostent *mingw_gethostbyname(const char *host);
239 #define gethostbyname mingw_gethostbyname
240
241 void mingw_freeaddrinfo(struct addrinfo *res);
242 #define freeaddrinfo mingw_freeaddrinfo
243
244 int mingw_getaddrinfo(const char *node, const char *service,
245                       const struct addrinfo *hints, struct addrinfo **res);
246 #define getaddrinfo mingw_getaddrinfo
247
248 int mingw_getnameinfo(const struct sockaddr *sa, socklen_t salen,
249                       char *host, DWORD hostlen, char *serv, DWORD servlen,
250                       int flags);
251 #define getnameinfo mingw_getnameinfo
252
253 int mingw_socket(int domain, int type, int protocol);
254 #define socket mingw_socket
255
256 int mingw_connect(int sockfd, struct sockaddr *sa, size_t sz);
257 #define connect mingw_connect
258
259 int mingw_bind(int sockfd, struct sockaddr *sa, size_t sz);
260 #define bind mingw_bind
261
262 int mingw_setsockopt(int sockfd, int lvl, int optname, void *optval, int optlen);
263 #define setsockopt mingw_setsockopt
264
265 int mingw_shutdown(int sockfd, int how);
266 #define shutdown mingw_shutdown
267
268 int mingw_listen(int sockfd, int backlog);
269 #define listen mingw_listen
270
271 int mingw_accept(int sockfd, struct sockaddr *sa, socklen_t *sz);
272 #define accept mingw_accept
273
274 int mingw_rename(const char*, const char*);
275 #define rename mingw_rename
276
277 #if defined(USE_WIN32_MMAP) || defined(_MSC_VER)
278 int mingw_getpagesize(void);
279 #define getpagesize mingw_getpagesize
280 #endif
281
282 struct rlimit {
283         unsigned int rlim_cur;
284 };
285 #define RLIMIT_NOFILE 0
286
287 static inline int getrlimit(int resource, struct rlimit *rlp)
288 {
289         if (resource != RLIMIT_NOFILE) {
290                 errno = EINVAL;
291                 return -1;
292         }
293
294         rlp->rlim_cur = 2048;
295         return 0;
296 }
297
298 /*
299  * Use mingw specific stat()/lstat()/fstat() implementations on Windows.
300  */
301 #define off_t off64_t
302 #define lseek _lseeki64
303
304 /* use struct stat with 64 bit st_size */
305 #ifdef stat
306 #undef stat
307 #endif
308 #define stat _stati64
309 int mingw_lstat(const char *file_name, struct stat *buf);
310 int mingw_stat(const char *file_name, struct stat *buf);
311 int mingw_fstat(int fd, struct stat *buf);
312 #ifdef fstat
313 #undef fstat
314 #endif
315 #define fstat mingw_fstat
316 #ifdef lstat
317 #undef lstat
318 #endif
319 #define lstat mingw_lstat
320
321 #ifndef _stati64
322 # define _stati64(x,y) mingw_stat(x,y)
323 #elif defined (_USE_32BIT_TIME_T)
324 # define _stat32i64(x,y) mingw_stat(x,y)
325 #else
326 # define _stat64(x,y) mingw_stat(x,y)
327 #endif
328
329 int mingw_utime(const char *file_name, const struct utimbuf *times);
330 #define utime mingw_utime
331
332 pid_t mingw_spawnvpe(const char *cmd, const char **argv, char **env,
333                      const char *dir,
334                      int fhin, int fhout, int fherr);
335 int mingw_execvp(const char *cmd, char *const *argv);
336 #define execvp mingw_execvp
337 int mingw_execv(const char *cmd, char *const *argv);
338 #define execv mingw_execv
339
340 static inline unsigned int git_ntohl(unsigned int x)
341 { return (unsigned int)ntohl(x); }
342 #define ntohl git_ntohl
343
344 sig_handler_t mingw_signal(int sig, sig_handler_t handler);
345 #define signal mingw_signal
346
347 int mingw_raise(int sig);
348 #define raise mingw_raise
349
350 /*
351  * ANSI emulation wrappers
352  */
353
354 void winansi_init(void);
355 HANDLE winansi_get_osfhandle(int fd);
356
357 /*
358  * git specific compatibility
359  */
360
361 #define has_dos_drive_prefix(path) (isalpha(*(path)) && (path)[1] == ':')
362 #define is_dir_sep(c) ((c) == '/' || (c) == '\\')
363 static inline char *mingw_find_last_dir_sep(const char *path)
364 {
365         char *ret = NULL;
366         for (; *path; ++path)
367                 if (is_dir_sep(*path))
368                         ret = (char *)path;
369         return ret;
370 }
371 #define find_last_dir_sep mingw_find_last_dir_sep
372 int mingw_offset_1st_component(const char *path);
373 #define offset_1st_component mingw_offset_1st_component
374 #define PATH_SEP ';'
375 #define PRIuMAX "I64u"
376 #define PRId64 "I64d"
377
378 void mingw_open_html(const char *path);
379 #define open_html mingw_open_html
380
381 void mingw_mark_as_git_dir(const char *dir);
382 #define mark_as_git_dir mingw_mark_as_git_dir
383
384 /**
385  * Converts UTF-8 encoded string to UTF-16LE.
386  *
387  * To support repositories with legacy-encoded file names, invalid UTF-8 bytes
388  * 0xa0 - 0xff are converted to corresponding printable Unicode chars \u00a0 -
389  * \u00ff, and invalid UTF-8 bytes 0x80 - 0x9f (which would make non-printable
390  * Unicode) are converted to hex-code.
391  *
392  * Lead-bytes not followed by an appropriate number of trail-bytes, over-long
393  * encodings and 4-byte encodings > \u10ffff are detected as invalid UTF-8.
394  *
395  * Maximum space requirement for the target buffer is two wide chars per UTF-8
396  * char (((strlen(utf) * 2) + 1) [* sizeof(wchar_t)]).
397  *
398  * The maximum space is needed only if the entire input string consists of
399  * invalid UTF-8 bytes in range 0x80-0x9f, as per the following table:
400  *
401  *               |                   | UTF-8 | UTF-16 |
402  *   Code point  |  UTF-8 sequence   | bytes | words  | ratio
403  * --------------+-------------------+-------+--------+-------
404  * 000000-00007f | 0-7f              |   1   |   1    |  1
405  * 000080-0007ff | c2-df + 80-bf     |   2   |   1    |  0.5
406  * 000800-00ffff | e0-ef + 2 * 80-bf |   3   |   1    |  0.33
407  * 010000-10ffff | f0-f4 + 3 * 80-bf |   4   |  2 (a) |  0.5
408  * invalid       | 80-9f             |   1   |  2 (b) |  2
409  * invalid       | a0-ff             |   1   |   1    |  1
410  *
411  * (a) encoded as UTF-16 surrogate pair
412  * (b) encoded as two hex digits
413  *
414  * Note that, while the UTF-8 encoding scheme can be extended to 5-byte, 6-byte
415  * or even indefinite-byte sequences, the largest valid code point \u10ffff
416  * encodes as only 4 UTF-8 bytes.
417  *
418  * Parameters:
419  * wcs: wide char target buffer
420  * utf: string to convert
421  * wcslen: size of target buffer (in wchar_t's)
422  * utflen: size of string to convert, or -1 if 0-terminated
423  *
424  * Returns:
425  * length of converted string (_wcslen(wcs)), or -1 on failure
426  *
427  * Errors:
428  * EINVAL: one of the input parameters is invalid (e.g. NULL)
429  * ERANGE: the output buffer is too small
430  */
431 int xutftowcsn(wchar_t *wcs, const char *utf, size_t wcslen, int utflen);
432
433 /**
434  * Simplified variant of xutftowcsn, assumes input string is \0-terminated.
435  */
436 static inline int xutftowcs(wchar_t *wcs, const char *utf, size_t wcslen)
437 {
438         return xutftowcsn(wcs, utf, wcslen, -1);
439 }
440
441 /**
442  * Simplified file system specific variant of xutftowcsn, assumes output
443  * buffer size is MAX_PATH wide chars and input string is \0-terminated,
444  * fails with ENAMETOOLONG if input string is too long.
445  */
446 static inline int xutftowcs_path(wchar_t *wcs, const char *utf)
447 {
448         int result = xutftowcsn(wcs, utf, MAX_PATH, -1);
449         if (result < 0 && errno == ERANGE)
450                 errno = ENAMETOOLONG;
451         return result;
452 }
453
454 /**
455  * Converts UTF-16LE encoded string to UTF-8.
456  *
457  * Maximum space requirement for the target buffer is three UTF-8 chars per
458  * wide char ((_wcslen(wcs) * 3) + 1).
459  *
460  * The maximum space is needed only if the entire input string consists of
461  * UTF-16 words in range 0x0800-0xd7ff or 0xe000-0xffff (i.e. \u0800-\uffff
462  * modulo surrogate pairs), as per the following table:
463  *
464  *               |                       | UTF-16 | UTF-8 |
465  *   Code point  |  UTF-16 sequence      | words  | bytes | ratio
466  * --------------+-----------------------+--------+-------+-------
467  * 000000-00007f | 0000-007f             |   1    |   1   |  1
468  * 000080-0007ff | 0080-07ff             |   1    |   2   |  2
469  * 000800-00ffff | 0800-d7ff / e000-ffff |   1    |   3   |  3
470  * 010000-10ffff | d800-dbff + dc00-dfff |   2    |   4   |  2
471  *
472  * Note that invalid code points > 10ffff cannot be represented in UTF-16.
473  *
474  * Parameters:
475  * utf: target buffer
476  * wcs: wide string to convert
477  * utflen: size of target buffer
478  *
479  * Returns:
480  * length of converted string, or -1 on failure
481  *
482  * Errors:
483  * EINVAL: one of the input parameters is invalid (e.g. NULL)
484  * ERANGE: the output buffer is too small
485  */
486 int xwcstoutf(char *utf, const wchar_t *wcs, size_t utflen);
487
488 /*
489  * A critical section used in the implementation of the spawn
490  * functions (mingw_spawnv[p]e()) and waitpid(). Intialised in
491  * the replacement main() macro below.
492  */
493 extern CRITICAL_SECTION pinfo_cs;
494
495 /*
496  * A replacement of main() that adds win32 specific initialization.
497  */
498
499 void mingw_startup();
500 #define main(c,v) dummy_decl_mingw_main(); \
501 static int mingw_main(c,v); \
502 int main(int argc, char **argv) \
503 { \
504         mingw_startup(); \
505         return mingw_main(__argc, (void *)__argv); \
506 } \
507 static int mingw_main(c,v)
508
509 /*
510  * Used by Pthread API implementation for Windows
511  */
512 extern int err_win_to_posix(DWORD winerr);