Merge branch 'nd/split-index'
[git/mingw.git] / compat / mingw.h
blob7ff2376335dea7a092c626f74f52413be1c81e74
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 sigemptyset(x) (void)0
73 #define SA_RESTART 0
75 struct itimerval {
76 struct timeval it_value, it_interval;
78 #define ITIMER_REAL 0
81 * sanitize preprocessor namespace polluted by Windows headers defining
82 * macros which collide with git local versions
84 #undef HELP_COMMAND /* from winuser.h */
87 * trivial stubs
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)
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, ...)
112 if (cmd == F_GETFD || cmd == F_SETFD)
113 return 0;
114 errno = EINVAL;
115 return -1;
117 /* bash cannot reliably detect negative return codes as failure */
118 #define exit(code) exit((code) & 0xff)
121 * simple adaptors
124 static inline int mingw_mkdir(const char *path, int mode)
126 return mkdir(path);
128 #define mkdir mingw_mkdir
130 #define WNOHANG 1
131 pid_t waitpid(pid_t pid, int *status, int options);
133 #define kill mingw_kill
134 int mingw_kill(pid_t pid, int sig);
136 #ifndef NO_OPENSSL
137 #include <openssl/ssl.h>
138 static inline int mingw_SSL_set_fd(SSL *ssl, int fd)
140 return SSL_set_fd(ssl, _get_osfhandle(fd));
142 #define SSL_set_fd mingw_SSL_set_fd
144 static inline int mingw_SSL_set_rfd(SSL *ssl, int fd)
146 return SSL_set_rfd(ssl, _get_osfhandle(fd));
148 #define SSL_set_rfd mingw_SSL_set_rfd
150 static inline int mingw_SSL_set_wfd(SSL *ssl, int fd)
152 return SSL_set_wfd(ssl, _get_osfhandle(fd));
154 #define SSL_set_wfd mingw_SSL_set_wfd
155 #endif
158 * implementations of missing functions
161 int pipe(int filedes[2]);
162 unsigned int sleep (unsigned int seconds);
163 int mkstemp(char *template);
164 int gettimeofday(struct timeval *tv, void *tz);
165 struct tm *gmtime_r(const time_t *timep, struct tm *result);
166 struct tm *localtime_r(const time_t *timep, struct tm *result);
167 int getpagesize(void); /* defined in MinGW's libgcc.a */
168 struct passwd *getpwuid(uid_t uid);
169 int setitimer(int type, struct itimerval *in, struct itimerval *out);
170 int sigaction(int sig, struct sigaction *in, struct sigaction *out);
171 int link(const char *oldpath, const char *newpath);
174 * replacements of existing functions
177 int mingw_unlink(const char *pathname);
178 #define unlink mingw_unlink
180 int mingw_rmdir(const char *path);
181 #define rmdir mingw_rmdir
183 int mingw_open (const char *filename, int oflags, ...);
184 #define open mingw_open
186 int mingw_fgetc(FILE *stream);
187 #define fgetc mingw_fgetc
189 FILE *mingw_fopen (const char *filename, const char *otype);
190 #define fopen mingw_fopen
192 FILE *mingw_freopen (const char *filename, const char *otype, FILE *stream);
193 #define freopen mingw_freopen
195 int mingw_fflush(FILE *stream);
196 #define fflush mingw_fflush
198 char *mingw_getcwd(char *pointer, int len);
199 #define getcwd mingw_getcwd
201 char *mingw_getenv(const char *name);
202 #define getenv mingw_getenv
204 int mingw_gethostname(char *host, int namelen);
205 #define gethostname mingw_gethostname
207 struct hostent *mingw_gethostbyname(const char *host);
208 #define gethostbyname mingw_gethostbyname
210 void mingw_freeaddrinfo(struct addrinfo *res);
211 #define freeaddrinfo mingw_freeaddrinfo
213 int mingw_getaddrinfo(const char *node, const char *service,
214 const struct addrinfo *hints, struct addrinfo **res);
215 #define getaddrinfo mingw_getaddrinfo
217 int mingw_getnameinfo(const struct sockaddr *sa, socklen_t salen,
218 char *host, DWORD hostlen, char *serv, DWORD servlen,
219 int flags);
220 #define getnameinfo mingw_getnameinfo
222 int mingw_socket(int domain, int type, int protocol);
223 #define socket mingw_socket
225 int mingw_connect(int sockfd, struct sockaddr *sa, size_t sz);
226 #define connect mingw_connect
228 int mingw_bind(int sockfd, struct sockaddr *sa, size_t sz);
229 #define bind mingw_bind
231 int mingw_setsockopt(int sockfd, int lvl, int optname, void *optval, int optlen);
232 #define setsockopt mingw_setsockopt
234 int mingw_shutdown(int sockfd, int how);
235 #define shutdown mingw_shutdown
237 int mingw_listen(int sockfd, int backlog);
238 #define listen mingw_listen
240 int mingw_accept(int sockfd, struct sockaddr *sa, socklen_t *sz);
241 #define accept mingw_accept
243 int mingw_rename(const char*, const char*);
244 #define rename mingw_rename
246 #if defined(USE_WIN32_MMAP) || defined(_MSC_VER)
247 int mingw_getpagesize(void);
248 #define getpagesize mingw_getpagesize
249 #endif
251 struct rlimit {
252 unsigned int rlim_cur;
254 #define RLIMIT_NOFILE 0
256 static inline int getrlimit(int resource, struct rlimit *rlp)
258 if (resource != RLIMIT_NOFILE) {
259 errno = EINVAL;
260 return -1;
263 rlp->rlim_cur = 2048;
264 return 0;
268 * Use mingw specific stat()/lstat()/fstat() implementations on Windows.
270 #define off_t off64_t
271 #define lseek _lseeki64
273 /* use struct stat with 64 bit st_size */
274 #ifdef stat
275 #undef stat
276 #endif
277 #define stat _stati64
278 int mingw_lstat(const char *file_name, struct stat *buf);
279 int mingw_stat(const char *file_name, struct stat *buf);
280 int mingw_fstat(int fd, struct stat *buf);
281 #ifdef fstat
282 #undef fstat
283 #endif
284 #define fstat mingw_fstat
285 #ifdef lstat
286 #undef lstat
287 #endif
288 #define lstat mingw_lstat
290 #ifndef _stati64
291 # define _stati64(x,y) mingw_stat(x,y)
292 #elif defined (_USE_32BIT_TIME_T)
293 # define _stat32i64(x,y) mingw_stat(x,y)
294 #else
295 # define _stat64(x,y) mingw_stat(x,y)
296 #endif
298 int mingw_utime(const char *file_name, const struct utimbuf *times);
299 #define utime mingw_utime
301 pid_t mingw_spawnvpe(const char *cmd, const char **argv, char **env,
302 const char *dir,
303 int fhin, int fhout, int fherr);
304 int mingw_execvp(const char *cmd, char *const *argv);
305 #define execvp mingw_execvp
306 int mingw_execv(const char *cmd, char *const *argv);
307 #define execv mingw_execv
309 static inline unsigned int git_ntohl(unsigned int x)
310 { return (unsigned int)ntohl(x); }
311 #define ntohl git_ntohl
313 sig_handler_t mingw_signal(int sig, sig_handler_t handler);
314 #define signal mingw_signal
316 int mingw_raise(int sig);
317 #define raise mingw_raise
320 * ANSI emulation wrappers
323 void winansi_init(void);
324 HANDLE winansi_get_osfhandle(int fd);
327 * git specific compatibility
330 #define has_dos_drive_prefix(path) (isalpha(*(path)) && (path)[1] == ':')
331 #define is_dir_sep(c) ((c) == '/' || (c) == '\\')
332 static inline char *mingw_find_last_dir_sep(const char *path)
334 char *ret = NULL;
335 for (; *path; ++path)
336 if (is_dir_sep(*path))
337 ret = (char *)path;
338 return ret;
340 #define find_last_dir_sep mingw_find_last_dir_sep
341 int mingw_offset_1st_component(const char *path);
342 #define offset_1st_component mingw_offset_1st_component
343 #define PATH_SEP ';'
344 #define PRIuMAX "I64u"
345 #define PRId64 "I64d"
347 void mingw_open_html(const char *path);
348 #define open_html mingw_open_html
351 * helpers
354 char **make_augmented_environ(const char *const *vars);
355 void free_environ(char **env);
358 * Converts UTF-8 encoded string to UTF-16LE.
360 * To support repositories with legacy-encoded file names, invalid UTF-8 bytes
361 * 0xa0 - 0xff are converted to corresponding printable Unicode chars \u00a0 -
362 * \u00ff, and invalid UTF-8 bytes 0x80 - 0x9f (which would make non-printable
363 * Unicode) are converted to hex-code.
365 * Lead-bytes not followed by an appropriate number of trail-bytes, over-long
366 * encodings and 4-byte encodings > \u10ffff are detected as invalid UTF-8.
368 * Maximum space requirement for the target buffer is two wide chars per UTF-8
369 * char (((strlen(utf) * 2) + 1) [* sizeof(wchar_t)]).
371 * The maximum space is needed only if the entire input string consists of
372 * invalid UTF-8 bytes in range 0x80-0x9f, as per the following table:
374 * | | UTF-8 | UTF-16 |
375 * Code point | UTF-8 sequence | bytes | words | ratio
376 * --------------+-------------------+-------+--------+-------
377 * 000000-00007f | 0-7f | 1 | 1 | 1
378 * 000080-0007ff | c2-df + 80-bf | 2 | 1 | 0.5
379 * 000800-00ffff | e0-ef + 2 * 80-bf | 3 | 1 | 0.33
380 * 010000-10ffff | f0-f4 + 3 * 80-bf | 4 | 2 (a) | 0.5
381 * invalid | 80-9f | 1 | 2 (b) | 2
382 * invalid | a0-ff | 1 | 1 | 1
384 * (a) encoded as UTF-16 surrogate pair
385 * (b) encoded as two hex digits
387 * Note that, while the UTF-8 encoding scheme can be extended to 5-byte, 6-byte
388 * or even indefinite-byte sequences, the largest valid code point \u10ffff
389 * encodes as only 4 UTF-8 bytes.
391 * Parameters:
392 * wcs: wide char target buffer
393 * utf: string to convert
394 * wcslen: size of target buffer (in wchar_t's)
395 * utflen: size of string to convert, or -1 if 0-terminated
397 * Returns:
398 * length of converted string (_wcslen(wcs)), or -1 on failure
400 * Errors:
401 * EINVAL: one of the input parameters is invalid (e.g. NULL)
402 * ERANGE: the output buffer is too small
404 int xutftowcsn(wchar_t *wcs, const char *utf, size_t wcslen, int utflen);
407 * Simplified variant of xutftowcsn, assumes input string is \0-terminated.
409 static inline int xutftowcs(wchar_t *wcs, const char *utf, size_t wcslen)
411 return xutftowcsn(wcs, utf, wcslen, -1);
415 * Simplified file system specific variant of xutftowcsn, assumes output
416 * buffer size is MAX_PATH wide chars and input string is \0-terminated,
417 * fails with ENAMETOOLONG if input string is too long.
419 static inline int xutftowcs_path(wchar_t *wcs, const char *utf)
421 int result = xutftowcsn(wcs, utf, MAX_PATH, -1);
422 if (result < 0 && errno == ERANGE)
423 errno = ENAMETOOLONG;
424 return result;
428 * Converts UTF-16LE encoded string to UTF-8.
430 * Maximum space requirement for the target buffer is three UTF-8 chars per
431 * wide char ((_wcslen(wcs) * 3) + 1).
433 * The maximum space is needed only if the entire input string consists of
434 * UTF-16 words in range 0x0800-0xd7ff or 0xe000-0xffff (i.e. \u0800-\uffff
435 * modulo surrogate pairs), as per the following table:
437 * | | UTF-16 | UTF-8 |
438 * Code point | UTF-16 sequence | words | bytes | ratio
439 * --------------+-----------------------+--------+-------+-------
440 * 000000-00007f | 0000-007f | 1 | 1 | 1
441 * 000080-0007ff | 0080-07ff | 1 | 2 | 2
442 * 000800-00ffff | 0800-d7ff / e000-ffff | 1 | 3 | 3
443 * 010000-10ffff | d800-dbff + dc00-dfff | 2 | 4 | 2
445 * Note that invalid code points > 10ffff cannot be represented in UTF-16.
447 * Parameters:
448 * utf: target buffer
449 * wcs: wide string to convert
450 * utflen: size of target buffer
452 * Returns:
453 * length of converted string, or -1 on failure
455 * Errors:
456 * EINVAL: one of the input parameters is invalid (e.g. NULL)
457 * ERANGE: the output buffer is too small
459 int xwcstoutf(char *utf, const wchar_t *wcs, size_t utflen);
462 * A critical section used in the implementation of the spawn
463 * functions (mingw_spawnv[p]e()) and waitpid(). Intialised in
464 * the replacement main() macro below.
466 extern CRITICAL_SECTION pinfo_cs;
469 * A replacement of main() that adds win32 specific initialization.
472 void mingw_startup();
473 #define main(c,v) dummy_decl_mingw_main(); \
474 static int mingw_main(c,v); \
475 int main(int argc, char **argv) \
477 mingw_startup(); \
478 return mingw_main(__argc, (void *)__argv); \
480 static int mingw_main(c,v)
483 * Used by Pthread API implementation for Windows
485 extern int err_win_to_posix(DWORD winerr);