ls-remote: document --refs option
[git.git] / compat / mingw.h
blob57ca477d1f100a7ddb1cc9cb693d050e32ae0eb0
1 #include <winsock2.h>
2 #include <ws2tcpip.h>
4 /*
5 * things that are not available in header files
6 */
8 typedef int pid_t;
9 typedef int uid_t;
10 typedef int socklen_t;
11 #define hstrerror strerror
13 #define S_IFLNK 0120000 /* Symbolic link */
14 #define S_ISLNK(x) (((x) & S_IFMT) == S_IFLNK)
15 #define S_ISSOCK(x) 0
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)
26 #define S_ISUID 0004000
27 #define S_ISGID 0002000
28 #define S_ISVTX 0001000
30 #define WIFEXITED(x) 1
31 #define WIFSIGNALED(x) 0
32 #define WEXITSTATUS(x) ((x) & 0xff)
33 #define WTERMSIG(x) SIGTERM
35 #ifndef EWOULDBLOCK
36 #define EWOULDBLOCK EAGAIN
37 #endif
38 #ifndef ELOOP
39 #define ELOOP EMLINK
40 #endif
41 #define SHUT_WR SD_SEND
43 #define SIGHUP 1
44 #define SIGQUIT 3
45 #define SIGKILL 9
46 #define SIGPIPE 13
47 #define SIGALRM 14
48 #define SIGCHLD 17
50 #define F_GETFD 1
51 #define F_SETFD 2
52 #define FD_CLOEXEC 0x1
54 #ifndef EAFNOSUPPORT
55 #define EAFNOSUPPORT WSAEAFNOSUPPORT
56 #endif
57 #ifndef ECONNABORTED
58 #define ECONNABORTED WSAECONNABORTED
59 #endif
61 struct passwd {
62 char *pw_name;
63 char *pw_gecos;
64 char *pw_dir;
67 typedef void (__cdecl *sig_handler_t)(int);
68 struct sigaction {
69 sig_handler_t sa_handler;
70 unsigned sa_flags;
72 #define SA_RESTART 0
74 struct itimerval {
75 struct timeval it_value, it_interval;
77 #define ITIMER_REAL 0
79 struct utsname {
80 char sysname[16];
81 char nodename[1];
82 char release[16];
83 char version[16];
84 char machine[1];
88 * sanitize preprocessor namespace polluted by Windows headers defining
89 * macros which collide with git local versions
91 #undef HELP_COMMAND /* from winuser.h */
94 * trivial stubs
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)
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, ...)
117 if (cmd == F_GETFD || cmd == F_SETFD)
118 return 0;
119 errno = EINVAL;
120 return -1;
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(); }
138 * simple adaptors
141 int mingw_mkdir(const char *path, int mode);
142 #define mkdir mingw_mkdir
144 #define WNOHANG 1
145 pid_t waitpid(pid_t pid, int *status, int options);
147 #define kill mingw_kill
148 int mingw_kill(pid_t pid, int sig);
150 #ifndef NO_OPENSSL
151 #include <openssl/ssl.h>
152 static inline int mingw_SSL_set_fd(SSL *ssl, int fd)
154 return SSL_set_fd(ssl, _get_osfhandle(fd));
156 #define SSL_set_fd mingw_SSL_set_fd
158 static inline int mingw_SSL_set_rfd(SSL *ssl, int fd)
160 return SSL_set_rfd(ssl, _get_osfhandle(fd));
162 #define SSL_set_rfd mingw_SSL_set_rfd
164 static inline int mingw_SSL_set_wfd(SSL *ssl, int fd)
166 return SSL_set_wfd(ssl, _get_osfhandle(fd));
168 #define SSL_set_wfd mingw_SSL_set_wfd
169 #endif
172 * implementations of missing functions
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);
189 * replacements of existing functions
192 int mingw_unlink(const char *pathname);
193 #define unlink mingw_unlink
195 int mingw_rmdir(const char *path);
196 #define rmdir mingw_rmdir
198 int mingw_open (const char *filename, int oflags, ...);
199 #define open mingw_open
201 int mingw_fgetc(FILE *stream);
202 #define fgetc mingw_fgetc
204 FILE *mingw_fopen (const char *filename, const char *otype);
205 #define fopen mingw_fopen
207 FILE *mingw_freopen (const char *filename, const char *otype, FILE *stream);
208 #define freopen mingw_freopen
210 int mingw_fflush(FILE *stream);
211 #define fflush mingw_fflush
213 ssize_t mingw_write(int fd, const void *buf, size_t len);
214 #define write mingw_write
216 int mingw_access(const char *filename, int mode);
217 #undef access
218 #define access mingw_access
220 int mingw_chdir(const char *dirname);
221 #define chdir mingw_chdir
223 int mingw_chmod(const char *filename, int mode);
224 #define chmod mingw_chmod
226 char *mingw_mktemp(char *template);
227 #define mktemp mingw_mktemp
229 char *mingw_getcwd(char *pointer, int len);
230 #define getcwd mingw_getcwd
232 char *mingw_getenv(const char *name);
233 #define getenv mingw_getenv
234 int mingw_putenv(const char *namevalue);
235 #define putenv mingw_putenv
236 #define unsetenv mingw_putenv
238 int mingw_gethostname(char *host, int namelen);
239 #define gethostname mingw_gethostname
241 struct hostent *mingw_gethostbyname(const char *host);
242 #define gethostbyname mingw_gethostbyname
244 void mingw_freeaddrinfo(struct addrinfo *res);
245 #define freeaddrinfo mingw_freeaddrinfo
247 int mingw_getaddrinfo(const char *node, const char *service,
248 const struct addrinfo *hints, struct addrinfo **res);
249 #define getaddrinfo mingw_getaddrinfo
251 int mingw_getnameinfo(const struct sockaddr *sa, socklen_t salen,
252 char *host, DWORD hostlen, char *serv, DWORD servlen,
253 int flags);
254 #define getnameinfo mingw_getnameinfo
256 int mingw_socket(int domain, int type, int protocol);
257 #define socket mingw_socket
259 int mingw_connect(int sockfd, struct sockaddr *sa, size_t sz);
260 #define connect mingw_connect
262 int mingw_bind(int sockfd, struct sockaddr *sa, size_t sz);
263 #define bind mingw_bind
265 int mingw_setsockopt(int sockfd, int lvl, int optname, void *optval, int optlen);
266 #define setsockopt mingw_setsockopt
268 int mingw_shutdown(int sockfd, int how);
269 #define shutdown mingw_shutdown
271 int mingw_listen(int sockfd, int backlog);
272 #define listen mingw_listen
274 int mingw_accept(int sockfd, struct sockaddr *sa, socklen_t *sz);
275 #define accept mingw_accept
277 int mingw_rename(const char*, const char*);
278 #define rename mingw_rename
280 #if defined(USE_WIN32_MMAP) || defined(_MSC_VER)
281 int mingw_getpagesize(void);
282 #define getpagesize mingw_getpagesize
283 #endif
285 struct rlimit {
286 unsigned int rlim_cur;
288 #define RLIMIT_NOFILE 0
290 static inline int getrlimit(int resource, struct rlimit *rlp)
292 if (resource != RLIMIT_NOFILE) {
293 errno = EINVAL;
294 return -1;
297 rlp->rlim_cur = 2048;
298 return 0;
302 * Use mingw specific stat()/lstat()/fstat() implementations on Windows.
304 #define off_t off64_t
305 #define lseek _lseeki64
307 /* use struct stat with 64 bit st_size */
308 #ifdef stat
309 #undef stat
310 #endif
311 #define stat _stati64
312 int mingw_lstat(const char *file_name, struct stat *buf);
313 int mingw_stat(const char *file_name, struct stat *buf);
314 int mingw_fstat(int fd, struct stat *buf);
315 #ifdef fstat
316 #undef fstat
317 #endif
318 #define fstat mingw_fstat
319 #ifdef lstat
320 #undef lstat
321 #endif
322 #define lstat mingw_lstat
324 #ifndef _stati64
325 # define _stati64(x,y) mingw_stat(x,y)
326 #elif defined (_USE_32BIT_TIME_T)
327 # define _stat32i64(x,y) mingw_stat(x,y)
328 #else
329 # define _stat64(x,y) mingw_stat(x,y)
330 #endif
332 int mingw_utime(const char *file_name, const struct utimbuf *times);
333 #define utime mingw_utime
335 pid_t mingw_spawnvpe(const char *cmd, const char **argv, char **env,
336 const char *dir,
337 int fhin, int fhout, int fherr);
338 int mingw_execvp(const char *cmd, char *const *argv);
339 #define execvp mingw_execvp
340 int mingw_execv(const char *cmd, char *const *argv);
341 #define execv mingw_execv
343 static inline unsigned int git_ntohl(unsigned int x)
344 { return (unsigned int)ntohl(x); }
345 #define ntohl git_ntohl
347 sig_handler_t mingw_signal(int sig, sig_handler_t handler);
348 #define signal mingw_signal
350 int mingw_raise(int sig);
351 #define raise mingw_raise
354 * ANSI emulation wrappers
357 void winansi_init(void);
358 HANDLE winansi_get_osfhandle(int fd);
361 * git specific compatibility
364 #define has_dos_drive_prefix(path) (isalpha(*(path)) && (path)[1] == ':')
365 #define is_dir_sep(c) ((c) == '/' || (c) == '\\')
366 static inline char *mingw_find_last_dir_sep(const char *path)
368 char *ret = NULL;
369 for (; *path; ++path)
370 if (is_dir_sep(*path))
371 ret = (char *)path;
372 return ret;
374 #define find_last_dir_sep mingw_find_last_dir_sep
375 int mingw_offset_1st_component(const char *path);
376 #define offset_1st_component mingw_offset_1st_component
377 #define PATH_SEP ';'
378 #define PRIuMAX "I64u"
379 #define PRId64 "I64d"
381 void mingw_open_html(const char *path);
382 #define open_html mingw_open_html
384 void mingw_mark_as_git_dir(const char *dir);
385 #define mark_as_git_dir mingw_mark_as_git_dir
388 * Converts UTF-8 encoded string to UTF-16LE.
390 * To support repositories with legacy-encoded file names, invalid UTF-8 bytes
391 * 0xa0 - 0xff are converted to corresponding printable Unicode chars \u00a0 -
392 * \u00ff, and invalid UTF-8 bytes 0x80 - 0x9f (which would make non-printable
393 * Unicode) are converted to hex-code.
395 * Lead-bytes not followed by an appropriate number of trail-bytes, over-long
396 * encodings and 4-byte encodings > \u10ffff are detected as invalid UTF-8.
398 * Maximum space requirement for the target buffer is two wide chars per UTF-8
399 * char (((strlen(utf) * 2) + 1) [* sizeof(wchar_t)]).
401 * The maximum space is needed only if the entire input string consists of
402 * invalid UTF-8 bytes in range 0x80-0x9f, as per the following table:
404 * | | UTF-8 | UTF-16 |
405 * Code point | UTF-8 sequence | bytes | words | ratio
406 * --------------+-------------------+-------+--------+-------
407 * 000000-00007f | 0-7f | 1 | 1 | 1
408 * 000080-0007ff | c2-df + 80-bf | 2 | 1 | 0.5
409 * 000800-00ffff | e0-ef + 2 * 80-bf | 3 | 1 | 0.33
410 * 010000-10ffff | f0-f4 + 3 * 80-bf | 4 | 2 (a) | 0.5
411 * invalid | 80-9f | 1 | 2 (b) | 2
412 * invalid | a0-ff | 1 | 1 | 1
414 * (a) encoded as UTF-16 surrogate pair
415 * (b) encoded as two hex digits
417 * Note that, while the UTF-8 encoding scheme can be extended to 5-byte, 6-byte
418 * or even indefinite-byte sequences, the largest valid code point \u10ffff
419 * encodes as only 4 UTF-8 bytes.
421 * Parameters:
422 * wcs: wide char target buffer
423 * utf: string to convert
424 * wcslen: size of target buffer (in wchar_t's)
425 * utflen: size of string to convert, or -1 if 0-terminated
427 * Returns:
428 * length of converted string (_wcslen(wcs)), or -1 on failure
430 * Errors:
431 * EINVAL: one of the input parameters is invalid (e.g. NULL)
432 * ERANGE: the output buffer is too small
434 int xutftowcsn(wchar_t *wcs, const char *utf, size_t wcslen, int utflen);
437 * Simplified variant of xutftowcsn, assumes input string is \0-terminated.
439 static inline int xutftowcs(wchar_t *wcs, const char *utf, size_t wcslen)
441 return xutftowcsn(wcs, utf, wcslen, -1);
445 * Simplified file system specific variant of xutftowcsn, assumes output
446 * buffer size is MAX_PATH wide chars and input string is \0-terminated,
447 * fails with ENAMETOOLONG if input string is too long.
449 static inline int xutftowcs_path(wchar_t *wcs, const char *utf)
451 int result = xutftowcsn(wcs, utf, MAX_PATH, -1);
452 if (result < 0 && errno == ERANGE)
453 errno = ENAMETOOLONG;
454 return result;
458 * Converts UTF-16LE encoded string to UTF-8.
460 * Maximum space requirement for the target buffer is three UTF-8 chars per
461 * wide char ((_wcslen(wcs) * 3) + 1).
463 * The maximum space is needed only if the entire input string consists of
464 * UTF-16 words in range 0x0800-0xd7ff or 0xe000-0xffff (i.e. \u0800-\uffff
465 * modulo surrogate pairs), as per the following table:
467 * | | UTF-16 | UTF-8 |
468 * Code point | UTF-16 sequence | words | bytes | ratio
469 * --------------+-----------------------+--------+-------+-------
470 * 000000-00007f | 0000-007f | 1 | 1 | 1
471 * 000080-0007ff | 0080-07ff | 1 | 2 | 2
472 * 000800-00ffff | 0800-d7ff / e000-ffff | 1 | 3 | 3
473 * 010000-10ffff | d800-dbff + dc00-dfff | 2 | 4 | 2
475 * Note that invalid code points > 10ffff cannot be represented in UTF-16.
477 * Parameters:
478 * utf: target buffer
479 * wcs: wide string to convert
480 * utflen: size of target buffer
482 * Returns:
483 * length of converted string, or -1 on failure
485 * Errors:
486 * EINVAL: one of the input parameters is invalid (e.g. NULL)
487 * ERANGE: the output buffer is too small
489 int xwcstoutf(char *utf, const wchar_t *wcs, size_t utflen);
492 * A critical section used in the implementation of the spawn
493 * functions (mingw_spawnv[p]e()) and waitpid(). Intialised in
494 * the replacement main() macro below.
496 extern CRITICAL_SECTION pinfo_cs;
499 * A replacement of main() that adds win32 specific initialization.
502 void mingw_startup();
503 #define main(c,v) dummy_decl_mingw_main(); \
504 static int mingw_main(c,v); \
505 int main(int argc, char **argv) \
507 mingw_startup(); \
508 return mingw_main(__argc, (void *)__argv); \
510 static int mingw_main(c,v)
513 * Used by Pthread API implementation for Windows
515 extern int err_win_to_posix(DWORD winerr);