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