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