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