Merge branch 'tb/complete-diff-ignore-blank-lines'
[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 int mingw_putenv(const char *namevalue);
214 #define putenv mingw_putenv
215 #define unsetenv mingw_putenv
216
217 int mingw_gethostname(char *host, int namelen);
218 #define gethostname mingw_gethostname
219
220 struct hostent *mingw_gethostbyname(const char *host);
221 #define gethostbyname mingw_gethostbyname
222
223 void mingw_freeaddrinfo(struct addrinfo *res);
224 #define freeaddrinfo mingw_freeaddrinfo
225
226 int mingw_getaddrinfo(const char *node, const char *service,
227                       const struct addrinfo *hints, struct addrinfo **res);
228 #define getaddrinfo mingw_getaddrinfo
229
230 int mingw_getnameinfo(const struct sockaddr *sa, socklen_t salen,
231                       char *host, DWORD hostlen, char *serv, DWORD servlen,
232                       int flags);
233 #define getnameinfo mingw_getnameinfo
234
235 int mingw_socket(int domain, int type, int protocol);
236 #define socket mingw_socket
237
238 int mingw_connect(int sockfd, struct sockaddr *sa, size_t sz);
239 #define connect mingw_connect
240
241 int mingw_bind(int sockfd, struct sockaddr *sa, size_t sz);
242 #define bind mingw_bind
243
244 int mingw_setsockopt(int sockfd, int lvl, int optname, void *optval, int optlen);
245 #define setsockopt mingw_setsockopt
246
247 int mingw_shutdown(int sockfd, int how);
248 #define shutdown mingw_shutdown
249
250 int mingw_listen(int sockfd, int backlog);
251 #define listen mingw_listen
252
253 int mingw_accept(int sockfd, struct sockaddr *sa, socklen_t *sz);
254 #define accept mingw_accept
255
256 int mingw_rename(const char*, const char*);
257 #define rename mingw_rename
258
259 #if defined(USE_WIN32_MMAP) || defined(_MSC_VER)
260 int mingw_getpagesize(void);
261 #define getpagesize mingw_getpagesize
262 #endif
263
264 struct rlimit {
265         unsigned int rlim_cur;
266 };
267 #define RLIMIT_NOFILE 0
268
269 static inline int getrlimit(int resource, struct rlimit *rlp)
270 {
271         if (resource != RLIMIT_NOFILE) {
272                 errno = EINVAL;
273                 return -1;
274         }
275
276         rlp->rlim_cur = 2048;
277         return 0;
278 }
279
280 /*
281  * Use mingw specific stat()/lstat()/fstat() implementations on Windows.
282  */
283 #define off_t off64_t
284 #define lseek _lseeki64
285
286 /* use struct stat with 64 bit st_size */
287 #ifdef stat
288 #undef stat
289 #endif
290 #define stat _stati64
291 int mingw_lstat(const char *file_name, struct stat *buf);
292 int mingw_stat(const char *file_name, struct stat *buf);
293 int mingw_fstat(int fd, struct stat *buf);
294 #ifdef fstat
295 #undef fstat
296 #endif
297 #define fstat mingw_fstat
298 #ifdef lstat
299 #undef lstat
300 #endif
301 #define lstat mingw_lstat
302
303 #ifndef _stati64
304 # define _stati64(x,y) mingw_stat(x,y)
305 #elif defined (_USE_32BIT_TIME_T)
306 # define _stat32i64(x,y) mingw_stat(x,y)
307 #else
308 # define _stat64(x,y) mingw_stat(x,y)
309 #endif
310
311 int mingw_utime(const char *file_name, const struct utimbuf *times);
312 #define utime mingw_utime
313
314 pid_t mingw_spawnvpe(const char *cmd, const char **argv, char **env,
315                      const char *dir,
316                      int fhin, int fhout, int fherr);
317 int mingw_execvp(const char *cmd, char *const *argv);
318 #define execvp mingw_execvp
319 int mingw_execv(const char *cmd, char *const *argv);
320 #define execv mingw_execv
321
322 static inline unsigned int git_ntohl(unsigned int x)
323 { return (unsigned int)ntohl(x); }
324 #define ntohl git_ntohl
325
326 sig_handler_t mingw_signal(int sig, sig_handler_t handler);
327 #define signal mingw_signal
328
329 int mingw_raise(int sig);
330 #define raise mingw_raise
331
332 /*
333  * ANSI emulation wrappers
334  */
335
336 void winansi_init(void);
337 HANDLE winansi_get_osfhandle(int fd);
338
339 /*
340  * git specific compatibility
341  */
342
343 #define has_dos_drive_prefix(path) (isalpha(*(path)) && (path)[1] == ':')
344 #define is_dir_sep(c) ((c) == '/' || (c) == '\\')
345 static inline char *mingw_find_last_dir_sep(const char *path)
346 {
347         char *ret = NULL;
348         for (; *path; ++path)
349                 if (is_dir_sep(*path))
350                         ret = (char *)path;
351         return ret;
352 }
353 #define find_last_dir_sep mingw_find_last_dir_sep
354 int mingw_offset_1st_component(const char *path);
355 #define offset_1st_component mingw_offset_1st_component
356 #define PATH_SEP ';'
357 #define PRIuMAX "I64u"
358 #define PRId64 "I64d"
359
360 void mingw_open_html(const char *path);
361 #define open_html mingw_open_html
362
363 void mingw_mark_as_git_dir(const char *dir);
364 #define mark_as_git_dir mingw_mark_as_git_dir
365
366 /**
367  * Converts UTF-8 encoded string to UTF-16LE.
368  *
369  * To support repositories with legacy-encoded file names, invalid UTF-8 bytes
370  * 0xa0 - 0xff are converted to corresponding printable Unicode chars \u00a0 -
371  * \u00ff, and invalid UTF-8 bytes 0x80 - 0x9f (which would make non-printable
372  * Unicode) are converted to hex-code.
373  *
374  * Lead-bytes not followed by an appropriate number of trail-bytes, over-long
375  * encodings and 4-byte encodings > \u10ffff are detected as invalid UTF-8.
376  *
377  * Maximum space requirement for the target buffer is two wide chars per UTF-8
378  * char (((strlen(utf) * 2) + 1) [* sizeof(wchar_t)]).
379  *
380  * The maximum space is needed only if the entire input string consists of
381  * invalid UTF-8 bytes in range 0x80-0x9f, as per the following table:
382  *
383  *               |                   | UTF-8 | UTF-16 |
384  *   Code point  |  UTF-8 sequence   | bytes | words  | ratio
385  * --------------+-------------------+-------+--------+-------
386  * 000000-00007f | 0-7f              |   1   |   1    |  1
387  * 000080-0007ff | c2-df + 80-bf     |   2   |   1    |  0.5
388  * 000800-00ffff | e0-ef + 2 * 80-bf |   3   |   1    |  0.33
389  * 010000-10ffff | f0-f4 + 3 * 80-bf |   4   |  2 (a) |  0.5
390  * invalid       | 80-9f             |   1   |  2 (b) |  2
391  * invalid       | a0-ff             |   1   |   1    |  1
392  *
393  * (a) encoded as UTF-16 surrogate pair
394  * (b) encoded as two hex digits
395  *
396  * Note that, while the UTF-8 encoding scheme can be extended to 5-byte, 6-byte
397  * or even indefinite-byte sequences, the largest valid code point \u10ffff
398  * encodes as only 4 UTF-8 bytes.
399  *
400  * Parameters:
401  * wcs: wide char target buffer
402  * utf: string to convert
403  * wcslen: size of target buffer (in wchar_t's)
404  * utflen: size of string to convert, or -1 if 0-terminated
405  *
406  * Returns:
407  * length of converted string (_wcslen(wcs)), or -1 on failure
408  *
409  * Errors:
410  * EINVAL: one of the input parameters is invalid (e.g. NULL)
411  * ERANGE: the output buffer is too small
412  */
413 int xutftowcsn(wchar_t *wcs, const char *utf, size_t wcslen, int utflen);
414
415 /**
416  * Simplified variant of xutftowcsn, assumes input string is \0-terminated.
417  */
418 static inline int xutftowcs(wchar_t *wcs, const char *utf, size_t wcslen)
419 {
420         return xutftowcsn(wcs, utf, wcslen, -1);
421 }
422
423 /**
424  * Simplified file system specific variant of xutftowcsn, assumes output
425  * buffer size is MAX_PATH wide chars and input string is \0-terminated,
426  * fails with ENAMETOOLONG if input string is too long.
427  */
428 static inline int xutftowcs_path(wchar_t *wcs, const char *utf)
429 {
430         int result = xutftowcsn(wcs, utf, MAX_PATH, -1);
431         if (result < 0 && errno == ERANGE)
432                 errno = ENAMETOOLONG;
433         return result;
434 }
435
436 /**
437  * Converts UTF-16LE encoded string to UTF-8.
438  *
439  * Maximum space requirement for the target buffer is three UTF-8 chars per
440  * wide char ((_wcslen(wcs) * 3) + 1).
441  *
442  * The maximum space is needed only if the entire input string consists of
443  * UTF-16 words in range 0x0800-0xd7ff or 0xe000-0xffff (i.e. \u0800-\uffff
444  * modulo surrogate pairs), as per the following table:
445  *
446  *               |                       | UTF-16 | UTF-8 |
447  *   Code point  |  UTF-16 sequence      | words  | bytes | ratio
448  * --------------+-----------------------+--------+-------+-------
449  * 000000-00007f | 0000-007f             |   1    |   1   |  1
450  * 000080-0007ff | 0080-07ff             |   1    |   2   |  2
451  * 000800-00ffff | 0800-d7ff / e000-ffff |   1    |   3   |  3
452  * 010000-10ffff | d800-dbff + dc00-dfff |   2    |   4   |  2
453  *
454  * Note that invalid code points > 10ffff cannot be represented in UTF-16.
455  *
456  * Parameters:
457  * utf: target buffer
458  * wcs: wide string to convert
459  * utflen: size of target buffer
460  *
461  * Returns:
462  * length of converted string, or -1 on failure
463  *
464  * Errors:
465  * EINVAL: one of the input parameters is invalid (e.g. NULL)
466  * ERANGE: the output buffer is too small
467  */
468 int xwcstoutf(char *utf, const wchar_t *wcs, size_t utflen);
469
470 /*
471  * A critical section used in the implementation of the spawn
472  * functions (mingw_spawnv[p]e()) and waitpid(). Intialised in
473  * the replacement main() macro below.
474  */
475 extern CRITICAL_SECTION pinfo_cs;
476
477 /*
478  * A replacement of main() that adds win32 specific initialization.
479  */
480
481 void mingw_startup();
482 #define main(c,v) dummy_decl_mingw_main(); \
483 static int mingw_main(c,v); \
484 int main(int argc, char **argv) \
485 { \
486         mingw_startup(); \
487         return mingw_main(__argc, (void *)__argv); \
488 } \
489 static int mingw_main(c,v)
490
491 /*
492  * Used by Pthread API implementation for Windows
493  */
494 extern int err_win_to_posix(DWORD winerr);