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