Merge pull request #122 from kblees/kb/long-paths-v2
[git/mingw/4msysgit.git] / compat / mingw.h
blob08b83fe1ded98853d4e39ac567807c310aff237a
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 int mingw_mkdir(const char *path, int mode);
122 #define mkdir mingw_mkdir
124 #define WNOHANG 1
125 pid_t waitpid(pid_t pid, int *status, int options);
127 #define kill mingw_kill
128 int mingw_kill(pid_t pid, int sig);
130 #ifndef NO_OPENSSL
131 #include <openssl/ssl.h>
132 static inline int mingw_SSL_set_fd(SSL *ssl, int fd)
134 return SSL_set_fd(ssl, _get_osfhandle(fd));
136 #define SSL_set_fd mingw_SSL_set_fd
138 static inline int mingw_SSL_set_rfd(SSL *ssl, int fd)
140 return SSL_set_rfd(ssl, _get_osfhandle(fd));
142 #define SSL_set_rfd mingw_SSL_set_rfd
144 static inline int mingw_SSL_set_wfd(SSL *ssl, int fd)
146 return SSL_set_wfd(ssl, _get_osfhandle(fd));
148 #define SSL_set_wfd mingw_SSL_set_wfd
149 #endif
152 * implementations of missing functions
155 int pipe(int filedes[2]);
156 unsigned int sleep (unsigned int seconds);
157 int mkstemp(char *template);
158 int gettimeofday(struct timeval *tv, void *tz);
159 struct tm *gmtime_r(const time_t *timep, struct tm *result);
160 struct tm *localtime_r(const time_t *timep, struct tm *result);
161 int getpagesize(void); /* defined in MinGW's libgcc.a */
162 struct passwd *getpwuid(uid_t uid);
163 int setitimer(int type, struct itimerval *in, struct itimerval *out);
164 int sigaction(int sig, struct sigaction *in, struct sigaction *out);
165 int link(const char *oldpath, const char *newpath);
168 * replacements of existing functions
171 int mingw_unlink(const char *pathname);
172 #define unlink mingw_unlink
174 int mingw_rmdir(const char *path);
175 #define rmdir mingw_rmdir
177 int mingw_open (const char *filename, int oflags, ...);
178 #define open mingw_open
180 int mingw_fgetc(FILE *stream);
181 #define fgetc mingw_fgetc
183 FILE *mingw_fopen (const char *filename, const char *otype);
184 #define fopen mingw_fopen
186 FILE *mingw_freopen (const char *filename, const char *otype, FILE *stream);
187 #define freopen mingw_freopen
189 int mingw_fflush(FILE *stream);
190 #define fflush mingw_fflush
192 int mingw_access(const char *filename, int mode);
193 #undef access
194 #define access mingw_access
196 int mingw_chdir(const char *dirname);
197 #define chdir mingw_chdir
199 int mingw_chmod(const char *filename, int mode);
200 #define chmod mingw_chmod
202 char *mingw_mktemp(char *template);
203 #define mktemp mingw_mktemp
205 char *mingw_getcwd(char *pointer, int len);
206 #define getcwd mingw_getcwd
208 char *mingw_getenv(const char *name);
209 #define getenv mingw_getenv
210 int mingw_putenv(const char *namevalue);
211 #define putenv mingw_putenv
212 #define unsetenv mingw_putenv
214 int mingw_gethostname(char *host, int namelen);
215 #define gethostname mingw_gethostname
217 struct hostent *mingw_gethostbyname(const char *host);
218 #define gethostbyname mingw_gethostbyname
220 void mingw_freeaddrinfo(struct addrinfo *res);
221 #define freeaddrinfo mingw_freeaddrinfo
223 int mingw_getaddrinfo(const char *node, const char *service,
224 const struct addrinfo *hints, struct addrinfo **res);
225 #define getaddrinfo mingw_getaddrinfo
227 int mingw_getnameinfo(const struct sockaddr *sa, socklen_t salen,
228 char *host, DWORD hostlen, char *serv, DWORD servlen,
229 int flags);
230 #define getnameinfo mingw_getnameinfo
232 int mingw_socket(int domain, int type, int protocol);
233 #define socket mingw_socket
235 int mingw_connect(int sockfd, struct sockaddr *sa, size_t sz);
236 #define connect mingw_connect
238 int mingw_bind(int sockfd, struct sockaddr *sa, size_t sz);
239 #define bind mingw_bind
241 int mingw_setsockopt(int sockfd, int lvl, int optname, void *optval, int optlen);
242 #define setsockopt mingw_setsockopt
244 int mingw_shutdown(int sockfd, int how);
245 #define shutdown mingw_shutdown
247 int mingw_listen(int sockfd, int backlog);
248 #define listen mingw_listen
250 int mingw_accept(int sockfd, struct sockaddr *sa, socklen_t *sz);
251 #define accept mingw_accept
253 int mingw_rename(const char*, const char*);
254 #define rename mingw_rename
256 #if defined(USE_WIN32_MMAP) || defined(_MSC_VER)
257 int mingw_getpagesize(void);
258 #define getpagesize mingw_getpagesize
259 #endif
261 struct rlimit {
262 unsigned int rlim_cur;
264 #define RLIMIT_NOFILE 0
266 static inline int getrlimit(int resource, struct rlimit *rlp)
268 if (resource != RLIMIT_NOFILE) {
269 errno = EINVAL;
270 return -1;
273 rlp->rlim_cur = 2048;
274 return 0;
278 * The unit of FILETIME is 100-nanoseconds since January 1, 1601, UTC.
279 * Returns the 100-nanoseconds ("hekto nanoseconds") since the epoch.
281 static inline long long filetime_to_hnsec(const FILETIME *ft)
283 long long winTime = ((long long)ft->dwHighDateTime << 32) + ft->dwLowDateTime;
284 /* Windows to Unix Epoch conversion */
285 return winTime - 116444736000000000LL;
288 static inline time_t filetime_to_time_t(const FILETIME *ft)
290 return (time_t)(filetime_to_hnsec(ft) / 10000000);
294 * Use mingw specific stat()/lstat()/fstat() implementations on Windows.
296 #define off_t off64_t
297 #define lseek _lseeki64
299 /* use struct stat with 64 bit st_size */
300 #ifdef stat
301 #undef stat
302 #endif
303 #define stat _stati64
304 int mingw_lstat(const char *file_name, struct stat *buf);
305 int mingw_stat(const char *file_name, struct stat *buf);
306 int mingw_fstat(int fd, struct stat *buf);
307 #ifdef fstat
308 #undef fstat
309 #endif
310 #define fstat mingw_fstat
311 #ifdef lstat
312 #undef lstat
313 #endif
314 extern int (*lstat)(const char *file_name, struct stat *buf);
316 #ifndef _stati64
317 # define _stati64(x,y) mingw_stat(x,y)
318 #elif defined (_USE_32BIT_TIME_T)
319 # define _stat32i64(x,y) mingw_stat(x,y)
320 #else
321 # define _stat64(x,y) mingw_stat(x,y)
322 #endif
324 int mingw_utime(const char *file_name, const struct utimbuf *times);
325 #define utime mingw_utime
327 pid_t mingw_spawnvpe(const char *cmd, const char **argv, char **env,
328 const char *dir,
329 int fhin, int fhout, int fherr);
330 int mingw_execvp(const char *cmd, char *const *argv);
331 #define execvp mingw_execvp
332 int mingw_execv(const char *cmd, char *const *argv);
333 #define execv mingw_execv
335 static inline unsigned int git_ntohl(unsigned int x)
336 { return (unsigned int)ntohl(x); }
337 #define ntohl git_ntohl
339 sig_handler_t mingw_signal(int sig, sig_handler_t handler);
340 #define signal mingw_signal
342 int mingw_raise(int sig);
343 #define raise mingw_raise
346 * ANSI emulation wrappers
349 void winansi_init(void);
350 HANDLE winansi_get_osfhandle(int fd);
353 * git specific compatibility
356 #define has_dos_drive_prefix(path) (isalpha(*(path)) && (path)[1] == ':')
357 #define is_dir_sep(c) ((c) == '/' || (c) == '\\')
358 static inline char *mingw_find_last_dir_sep(const char *path)
360 char *ret = NULL;
361 for (; *path; ++path)
362 if (is_dir_sep(*path))
363 ret = (char *)path;
364 return ret;
366 #define find_last_dir_sep mingw_find_last_dir_sep
367 int mingw_offset_1st_component(const char *path);
368 #define offset_1st_component mingw_offset_1st_component
369 #define PATH_SEP ';'
370 #define PRIuMAX "I64u"
371 #define PRId64 "I64d"
373 void mingw_open_html(const char *path);
374 #define open_html mingw_open_html
376 void mingw_mark_as_git_dir(const char *dir);
377 #define mark_as_git_dir mingw_mark_as_git_dir
380 * Max length of long paths (exceeding MAX_PATH). The actual maximum supported
381 * by NTFS is 32,767 (* sizeof(wchar_t)), but we choose an arbitrary smaller
382 * value to limit required stack memory.
384 #define MAX_LONG_PATH 4096
387 * Handles paths that would exceed the MAX_PATH limit of Windows Unicode APIs.
389 * With expand == false, the function checks for over-long paths and fails
390 * with ENAMETOOLONG. The path parameter is not modified, except if cwd + path
391 * exceeds max_path, but the resulting absolute path doesn't (e.g. due to
392 * eliminating '..' components). The path parameter must point to a buffer
393 * of max_path wide characters.
395 * With expand == true, an over-long path is automatically converted in place
396 * to an absolute path prefixed with '\\?\', and the new length is returned.
397 * The path parameter must point to a buffer of MAX_LONG_PATH wide characters.
399 * Parameters:
400 * path: path to check and / or convert
401 * len: size of path on input (number of wide chars without \0)
402 * max_path: max short path length to check (usually MAX_PATH = 260, but just
403 * 248 for CreateDirectoryW)
404 * expand: false to only check the length, true to expand the path to a
405 * '\\?\'-prefixed absolute path
407 * Return:
408 * length of the resulting path, or -1 on failure
410 * Errors:
411 * ENAMETOOLONG if path is too long
413 int handle_long_path(wchar_t *path, int len, int max_path, int expand);
416 * Converts UTF-8 encoded string to UTF-16LE.
418 * To support repositories with legacy-encoded file names, invalid UTF-8 bytes
419 * 0xa0 - 0xff are converted to corresponding printable Unicode chars \u00a0 -
420 * \u00ff, and invalid UTF-8 bytes 0x80 - 0x9f (which would make non-printable
421 * Unicode) are converted to hex-code.
423 * Lead-bytes not followed by an appropriate number of trail-bytes, over-long
424 * encodings and 4-byte encodings > \u10ffff are detected as invalid UTF-8.
426 * Maximum space requirement for the target buffer is two wide chars per UTF-8
427 * char (((strlen(utf) * 2) + 1) [* sizeof(wchar_t)]).
429 * The maximum space is needed only if the entire input string consists of
430 * invalid UTF-8 bytes in range 0x80-0x9f, as per the following table:
432 * | | UTF-8 | UTF-16 |
433 * Code point | UTF-8 sequence | bytes | words | ratio
434 * --------------+-------------------+-------+--------+-------
435 * 000000-00007f | 0-7f | 1 | 1 | 1
436 * 000080-0007ff | c2-df + 80-bf | 2 | 1 | 0.5
437 * 000800-00ffff | e0-ef + 2 * 80-bf | 3 | 1 | 0.33
438 * 010000-10ffff | f0-f4 + 3 * 80-bf | 4 | 2 (a) | 0.5
439 * invalid | 80-9f | 1 | 2 (b) | 2
440 * invalid | a0-ff | 1 | 1 | 1
442 * (a) encoded as UTF-16 surrogate pair
443 * (b) encoded as two hex digits
445 * Note that, while the UTF-8 encoding scheme can be extended to 5-byte, 6-byte
446 * or even indefinite-byte sequences, the largest valid code point \u10ffff
447 * encodes as only 4 UTF-8 bytes.
449 * Parameters:
450 * wcs: wide char target buffer
451 * utf: string to convert
452 * wcslen: size of target buffer (in wchar_t's)
453 * utflen: size of string to convert, or -1 if 0-terminated
455 * Returns:
456 * length of converted string (_wcslen(wcs)), or -1 on failure
458 * Errors:
459 * EINVAL: one of the input parameters is invalid (e.g. NULL)
460 * ERANGE: the output buffer is too small
462 int xutftowcsn(wchar_t *wcs, const char *utf, size_t wcslen, int utflen);
465 * Simplified variant of xutftowcsn, assumes input string is \0-terminated.
467 static inline int xutftowcs(wchar_t *wcs, const char *utf, size_t wcslen)
469 return xutftowcsn(wcs, utf, wcslen, -1);
473 * Simplified file system specific wrapper of xutftowcsn and handle_long_path.
474 * Converts ERANGE to ENAMETOOLONG. If expand is true, wcs must be at least
475 * MAX_LONG_PATH wide chars (see handle_long_path).
477 static inline int xutftowcs_path_ex(wchar_t *wcs, const char *utf,
478 size_t wcslen, int utflen, int max_path, int expand)
480 int result = xutftowcsn(wcs, utf, wcslen, utflen);
481 if (result < 0 && errno == ERANGE)
482 errno = ENAMETOOLONG;
483 if (result >= 0)
484 result = handle_long_path(wcs, result, max_path, expand);
485 return result;
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. Typically used for
492 * Windows APIs that don't support long paths, e.g. SetCurrentDirectory,
493 * LoadLibrary, CreateProcess...
495 static inline int xutftowcs_path(wchar_t *wcs, const char *utf)
497 return xutftowcs_path_ex(wcs, utf, MAX_PATH, -1, MAX_PATH, 0);
500 /* need to re-declare that here as mingw.h is included before cache.h */
501 extern int core_long_paths;
504 * Simplified file system specific variant of xutftowcsn for Windows APIs
505 * that support long paths via '\\?\'-prefix, assumes output buffer size is
506 * MAX_LONG_PATH wide chars, fails with ENAMETOOLONG if input string is too
507 * long. The 'core.longpaths' git-config option controls whether the path
508 * is only checked or expanded to a long path.
510 static inline int xutftowcs_long_path(wchar_t *wcs, const char *utf)
512 return xutftowcs_path_ex(wcs, utf, MAX_LONG_PATH, -1, MAX_PATH,
513 core_long_paths);
517 * Converts UTF-16LE encoded string to UTF-8.
519 * Maximum space requirement for the target buffer is three UTF-8 chars per
520 * wide char ((_wcslen(wcs) * 3) + 1).
522 * The maximum space is needed only if the entire input string consists of
523 * UTF-16 words in range 0x0800-0xd7ff or 0xe000-0xffff (i.e. \u0800-\uffff
524 * modulo surrogate pairs), as per the following table:
526 * | | UTF-16 | UTF-8 |
527 * Code point | UTF-16 sequence | words | bytes | ratio
528 * --------------+-----------------------+--------+-------+-------
529 * 000000-00007f | 0000-007f | 1 | 1 | 1
530 * 000080-0007ff | 0080-07ff | 1 | 2 | 2
531 * 000800-00ffff | 0800-d7ff / e000-ffff | 1 | 3 | 3
532 * 010000-10ffff | d800-dbff + dc00-dfff | 2 | 4 | 2
534 * Note that invalid code points > 10ffff cannot be represented in UTF-16.
536 * Parameters:
537 * utf: target buffer
538 * wcs: wide string to convert
539 * utflen: size of target buffer
541 * Returns:
542 * length of converted string, or -1 on failure
544 * Errors:
545 * EINVAL: one of the input parameters is invalid (e.g. NULL)
546 * ERANGE: the output buffer is too small
548 int xwcstoutf(char *utf, const wchar_t *wcs, size_t utflen);
551 * A critical section used in the implementation of the spawn
552 * functions (mingw_spawnv[p]e()) and waitpid(). Intialised in
553 * the replacement main() macro below.
555 extern CRITICAL_SECTION pinfo_cs;
558 * A replacement of main() that adds win32 specific initialization.
561 void mingw_startup();
562 #define main(c,v) dummy_decl_mingw_main(); \
563 static int mingw_main(c,v); \
564 int main(c,v) \
566 mingw_startup(); \
567 return mingw_main(__argc, __argv); \
569 static int mingw_main(c,v)
572 * Used by Pthread API implementation for Windows
574 extern int err_win_to_posix(DWORD winerr);
576 extern const char *get_windows_home_directory();
577 #define get_home_directory() get_windows_home_directory()