.gitignore: "git-verify-commit" is a generated file
[git.git] / compat / mingw.h
blob8dac6f9d6bc91c7949533d5d6d987530d6993b01
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 #define SHUT_WR SD_SEND
40 #define SIGHUP 1
41 #define SIGQUIT 3
42 #define SIGKILL 9
43 #define SIGPIPE 13
44 #define SIGALRM 14
45 #define SIGCHLD 17
47 #define F_GETFD 1
48 #define F_SETFD 2
49 #define FD_CLOEXEC 0x1
51 #ifndef EAFNOSUPPORT
52 #define EAFNOSUPPORT WSAEAFNOSUPPORT
53 #endif
54 #ifndef ECONNABORTED
55 #define ECONNABORTED WSAECONNABORTED
56 #endif
58 struct passwd {
59 char *pw_name;
60 char *pw_gecos;
61 char *pw_dir;
64 typedef void (__cdecl *sig_handler_t)(int);
65 struct sigaction {
66 sig_handler_t sa_handler;
67 unsigned sa_flags;
69 #define sigemptyset(x) (void)0
70 #define SA_RESTART 0
72 struct itimerval {
73 struct timeval it_value, it_interval;
75 #define ITIMER_REAL 0
78 * sanitize preprocessor namespace polluted by Windows headers defining
79 * macros which collide with git local versions
81 #undef HELP_COMMAND /* from winuser.h */
84 * trivial stubs
87 static inline int readlink(const char *path, char *buf, size_t bufsiz)
88 { errno = ENOSYS; return -1; }
89 static inline int symlink(const char *oldpath, const char *newpath)
90 { errno = ENOSYS; return -1; }
91 static inline int fchmod(int fildes, mode_t mode)
92 { errno = ENOSYS; return -1; }
93 static inline pid_t fork(void)
94 { errno = ENOSYS; return -1; }
95 static inline unsigned int alarm(unsigned int seconds)
96 { return 0; }
97 static inline int fsync(int fd)
98 { return _commit(fd); }
99 static inline pid_t getppid(void)
100 { return 1; }
101 static inline void sync(void)
103 static inline uid_t getuid(void)
104 { return 1; }
105 static inline struct passwd *getpwnam(const char *name)
106 { return NULL; }
107 static inline int fcntl(int fd, int cmd, ...)
109 if (cmd == F_GETFD || cmd == F_SETFD)
110 return 0;
111 errno = EINVAL;
112 return -1;
114 /* bash cannot reliably detect negative return codes as failure */
115 #define exit(code) exit((code) & 0xff)
118 * simple adaptors
121 static inline int mingw_mkdir(const char *path, int mode)
123 return mkdir(path);
125 #define mkdir mingw_mkdir
127 #define WNOHANG 1
128 pid_t waitpid(pid_t pid, int *status, int options);
130 #define kill mingw_kill
131 int mingw_kill(pid_t pid, int sig);
133 #ifndef NO_OPENSSL
134 #include <openssl/ssl.h>
135 static inline int mingw_SSL_set_fd(SSL *ssl, int fd)
137 return SSL_set_fd(ssl, _get_osfhandle(fd));
139 #define SSL_set_fd mingw_SSL_set_fd
141 static inline int mingw_SSL_set_rfd(SSL *ssl, int fd)
143 return SSL_set_rfd(ssl, _get_osfhandle(fd));
145 #define SSL_set_rfd mingw_SSL_set_rfd
147 static inline int mingw_SSL_set_wfd(SSL *ssl, int fd)
149 return SSL_set_wfd(ssl, _get_osfhandle(fd));
151 #define SSL_set_wfd mingw_SSL_set_wfd
152 #endif
155 * implementations of missing functions
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);
171 * replacements of existing functions
174 int mingw_unlink(const char *pathname);
175 #define unlink mingw_unlink
177 int mingw_rmdir(const char *path);
178 #define rmdir mingw_rmdir
180 int mingw_open (const char *filename, int oflags, ...);
181 #define open mingw_open
183 int mingw_fgetc(FILE *stream);
184 #define fgetc mingw_fgetc
186 FILE *mingw_fopen (const char *filename, const char *otype);
187 #define fopen mingw_fopen
189 FILE *mingw_freopen (const char *filename, const char *otype, FILE *stream);
190 #define freopen mingw_freopen
192 int mingw_fflush(FILE *stream);
193 #define fflush mingw_fflush
195 char *mingw_getcwd(char *pointer, int len);
196 #define getcwd mingw_getcwd
198 char *mingw_getenv(const char *name);
199 #define getenv mingw_getenv
201 int mingw_gethostname(char *host, int namelen);
202 #define gethostname mingw_gethostname
204 struct hostent *mingw_gethostbyname(const char *host);
205 #define gethostbyname mingw_gethostbyname
207 void mingw_freeaddrinfo(struct addrinfo *res);
208 #define freeaddrinfo mingw_freeaddrinfo
210 int mingw_getaddrinfo(const char *node, const char *service,
211 const struct addrinfo *hints, struct addrinfo **res);
212 #define getaddrinfo mingw_getaddrinfo
214 int mingw_getnameinfo(const struct sockaddr *sa, socklen_t salen,
215 char *host, DWORD hostlen, char *serv, DWORD servlen,
216 int flags);
217 #define getnameinfo mingw_getnameinfo
219 int mingw_socket(int domain, int type, int protocol);
220 #define socket mingw_socket
222 int mingw_connect(int sockfd, struct sockaddr *sa, size_t sz);
223 #define connect mingw_connect
225 int mingw_bind(int sockfd, struct sockaddr *sa, size_t sz);
226 #define bind mingw_bind
228 int mingw_setsockopt(int sockfd, int lvl, int optname, void *optval, int optlen);
229 #define setsockopt mingw_setsockopt
231 int mingw_shutdown(int sockfd, int how);
232 #define shutdown mingw_shutdown
234 int mingw_listen(int sockfd, int backlog);
235 #define listen mingw_listen
237 int mingw_accept(int sockfd, struct sockaddr *sa, socklen_t *sz);
238 #define accept mingw_accept
240 int mingw_rename(const char*, const char*);
241 #define rename mingw_rename
243 #if defined(USE_WIN32_MMAP) || defined(_MSC_VER)
244 int mingw_getpagesize(void);
245 #define getpagesize mingw_getpagesize
246 #endif
248 struct rlimit {
249 unsigned int rlim_cur;
251 #define RLIMIT_NOFILE 0
253 static inline int getrlimit(int resource, struct rlimit *rlp)
255 if (resource != RLIMIT_NOFILE) {
256 errno = EINVAL;
257 return -1;
260 rlp->rlim_cur = 2048;
261 return 0;
265 * Use mingw specific stat()/lstat()/fstat() implementations on Windows.
267 #define off_t off64_t
268 #define lseek _lseeki64
270 /* use struct stat with 64 bit st_size */
271 #ifdef stat
272 #undef stat
273 #endif
274 #define stat _stati64
275 int mingw_lstat(const char *file_name, struct stat *buf);
276 int mingw_stat(const char *file_name, struct stat *buf);
277 int mingw_fstat(int fd, struct stat *buf);
278 #ifdef fstat
279 #undef fstat
280 #endif
281 #define fstat mingw_fstat
282 #ifdef lstat
283 #undef lstat
284 #endif
285 #define lstat mingw_lstat
287 #ifndef _stati64
288 # define _stati64(x,y) mingw_stat(x,y)
289 #elif defined (_USE_32BIT_TIME_T)
290 # define _stat32i64(x,y) mingw_stat(x,y)
291 #else
292 # define _stat64(x,y) mingw_stat(x,y)
293 #endif
295 int mingw_utime(const char *file_name, const struct utimbuf *times);
296 #define utime mingw_utime
298 pid_t mingw_spawnvpe(const char *cmd, const char **argv, char **env,
299 const char *dir,
300 int fhin, int fhout, int fherr);
301 int mingw_execvp(const char *cmd, char *const *argv);
302 #define execvp mingw_execvp
303 int mingw_execv(const char *cmd, char *const *argv);
304 #define execv mingw_execv
306 static inline unsigned int git_ntohl(unsigned int x)
307 { return (unsigned int)ntohl(x); }
308 #define ntohl git_ntohl
310 sig_handler_t mingw_signal(int sig, sig_handler_t handler);
311 #define signal mingw_signal
313 int mingw_raise(int sig);
314 #define raise mingw_raise
317 * ANSI emulation wrappers
320 void winansi_init(void);
321 HANDLE winansi_get_osfhandle(int fd);
324 * git specific compatibility
327 #define has_dos_drive_prefix(path) (isalpha(*(path)) && (path)[1] == ':')
328 #define is_dir_sep(c) ((c) == '/' || (c) == '\\')
329 static inline char *mingw_find_last_dir_sep(const char *path)
331 char *ret = NULL;
332 for (; *path; ++path)
333 if (is_dir_sep(*path))
334 ret = (char *)path;
335 return ret;
337 #define find_last_dir_sep mingw_find_last_dir_sep
338 int mingw_offset_1st_component(const char *path);
339 #define offset_1st_component mingw_offset_1st_component
340 #define PATH_SEP ';'
341 #define PRIuMAX "I64u"
342 #define PRId64 "I64d"
344 void mingw_open_html(const char *path);
345 #define open_html mingw_open_html
348 * helpers
351 char **make_augmented_environ(const char *const *vars);
352 void free_environ(char **env);
355 * Converts UTF-8 encoded string to UTF-16LE.
357 * To support repositories with legacy-encoded file names, invalid UTF-8 bytes
358 * 0xa0 - 0xff are converted to corresponding printable Unicode chars \u00a0 -
359 * \u00ff, and invalid UTF-8 bytes 0x80 - 0x9f (which would make non-printable
360 * Unicode) are converted to hex-code.
362 * Lead-bytes not followed by an appropriate number of trail-bytes, over-long
363 * encodings and 4-byte encodings > \u10ffff are detected as invalid UTF-8.
365 * Maximum space requirement for the target buffer is two wide chars per UTF-8
366 * char (((strlen(utf) * 2) + 1) [* sizeof(wchar_t)]).
368 * The maximum space is needed only if the entire input string consists of
369 * invalid UTF-8 bytes in range 0x80-0x9f, as per the following table:
371 * | | UTF-8 | UTF-16 |
372 * Code point | UTF-8 sequence | bytes | words | ratio
373 * --------------+-------------------+-------+--------+-------
374 * 000000-00007f | 0-7f | 1 | 1 | 1
375 * 000080-0007ff | c2-df + 80-bf | 2 | 1 | 0.5
376 * 000800-00ffff | e0-ef + 2 * 80-bf | 3 | 1 | 0.33
377 * 010000-10ffff | f0-f4 + 3 * 80-bf | 4 | 2 (a) | 0.5
378 * invalid | 80-9f | 1 | 2 (b) | 2
379 * invalid | a0-ff | 1 | 1 | 1
381 * (a) encoded as UTF-16 surrogate pair
382 * (b) encoded as two hex digits
384 * Note that, while the UTF-8 encoding scheme can be extended to 5-byte, 6-byte
385 * or even indefinite-byte sequences, the largest valid code point \u10ffff
386 * encodes as only 4 UTF-8 bytes.
388 * Parameters:
389 * wcs: wide char target buffer
390 * utf: string to convert
391 * wcslen: size of target buffer (in wchar_t's)
392 * utflen: size of string to convert, or -1 if 0-terminated
394 * Returns:
395 * length of converted string (_wcslen(wcs)), or -1 on failure
397 * Errors:
398 * EINVAL: one of the input parameters is invalid (e.g. NULL)
399 * ERANGE: the output buffer is too small
401 int xutftowcsn(wchar_t *wcs, const char *utf, size_t wcslen, int utflen);
404 * Simplified variant of xutftowcsn, assumes input string is \0-terminated.
406 static inline int xutftowcs(wchar_t *wcs, const char *utf, size_t wcslen)
408 return xutftowcsn(wcs, utf, wcslen, -1);
412 * Simplified file system specific variant of xutftowcsn, assumes output
413 * buffer size is MAX_PATH wide chars and input string is \0-terminated,
414 * fails with ENAMETOOLONG if input string is too long.
416 static inline int xutftowcs_path(wchar_t *wcs, const char *utf)
418 int result = xutftowcsn(wcs, utf, MAX_PATH, -1);
419 if (result < 0 && errno == ERANGE)
420 errno = ENAMETOOLONG;
421 return result;
425 * Converts UTF-16LE encoded string to UTF-8.
427 * Maximum space requirement for the target buffer is three UTF-8 chars per
428 * wide char ((_wcslen(wcs) * 3) + 1).
430 * The maximum space is needed only if the entire input string consists of
431 * UTF-16 words in range 0x0800-0xd7ff or 0xe000-0xffff (i.e. \u0800-\uffff
432 * modulo surrogate pairs), as per the following table:
434 * | | UTF-16 | UTF-8 |
435 * Code point | UTF-16 sequence | words | bytes | ratio
436 * --------------+-----------------------+--------+-------+-------
437 * 000000-00007f | 0000-007f | 1 | 1 | 1
438 * 000080-0007ff | 0080-07ff | 1 | 2 | 2
439 * 000800-00ffff | 0800-d7ff / e000-ffff | 1 | 3 | 3
440 * 010000-10ffff | d800-dbff + dc00-dfff | 2 | 4 | 2
442 * Note that invalid code points > 10ffff cannot be represented in UTF-16.
444 * Parameters:
445 * utf: target buffer
446 * wcs: wide string to convert
447 * utflen: size of target buffer
449 * Returns:
450 * length of converted string, or -1 on failure
452 * Errors:
453 * EINVAL: one of the input parameters is invalid (e.g. NULL)
454 * ERANGE: the output buffer is too small
456 int xwcstoutf(char *utf, const wchar_t *wcs, size_t utflen);
459 * A critical section used in the implementation of the spawn
460 * functions (mingw_spawnv[p]e()) and waitpid(). Intialised in
461 * the replacement main() macro below.
463 extern CRITICAL_SECTION pinfo_cs;
466 * A replacement of main() that adds win32 specific initialization.
469 void mingw_startup();
470 #define main(c,v) dummy_decl_mingw_main(); \
471 static int mingw_main(c,v); \
472 int main(int argc, char **argv) \
474 mingw_startup(); \
475 return mingw_main(__argc, (void *)__argv); \
477 static int mingw_main(c,v)
480 * Used by Pthread API implementation for Windows
482 extern int err_win_to_posix(DWORD winerr);