2 * win32_replacements.c - Replacements for various functions not available on
3 * Windows, such as fsync().
7 * Copyright (C) 2013 Eric Biggers
9 * This file is part of wimlib, a library for working with WIM files.
11 * wimlib is free software; you can redistribute it and/or modify it under the
12 * terms of the GNU General Public License as published by the Free
13 * Software Foundation; either version 3 of the License, or (at your option)
16 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
17 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
18 * A PARTICULAR PURPOSE. See the GNU General Public License for more
21 * You should have received a copy of the GNU General Public License
22 * along with wimlib; if not, see http://www.gnu.org/licenses/.
33 #include <shlwapi.h> /* for PathMatchSpecW() */
34 #include "wimlib/win32_common.h"
36 #include "wimlib/assert.h"
37 #include "wimlib/file_io.h"
38 #include "wimlib/glob.h"
39 #include "wimlib/error.h"
40 #include "wimlib/util.h"
42 /* Replacement for POSIX fsync() */
48 h = (HANDLE)_get_osfhandle(fd);
49 if (h == INVALID_HANDLE_VALUE)
51 if (!FlushFileBuffers(h))
55 set_errno_from_GetLastError();
60 /* Use the Win32 API to get the number of processors */
62 win32_get_number_of_processors(void)
65 GetSystemInfo(&sysinfo);
66 return sysinfo.dwNumberOfProcessors;
69 /* Replacement for POSIX-2008 realpath(). Warning: partial functionality only
70 * (resolved_path must be NULL). Also I highly doubt that GetFullPathName
71 * really does the right thing under all circumstances. */
73 realpath(const wchar_t *path, wchar_t *resolved_path)
77 wimlib_assert(resolved_path == NULL);
79 ret = GetFullPathNameW(path, 0, NULL, NULL);
85 resolved_path = MALLOC(ret * sizeof(wchar_t));
88 ret = GetFullPathNameW(path, ret, resolved_path, NULL);
97 set_errno_from_win32_error(err);
102 /* A quick hack to get reasonable rename() semantics on Windows, in particular
103 * deleting the destination file instead of failing with ERROR_FILE_EXISTS and
104 * working around any processes that may have the destination file open.
106 * Note: This is intended to be called when overwriting a regular file with an
107 * updated copy and is *not* a fully POSIX compliant rename(). For that you may
108 * wish to take a look at Cygwin's implementation, but be prepared...
110 * Return 0 on success, -1 on regular error, or 1 if the destination file was
111 * deleted but the source could not be renamed and therefore should not be
115 win32_rename_replacement(const wchar_t *srcpath, const wchar_t *dstpath)
119 /* Normally, MoveFileExW() with the MOVEFILE_REPLACE_EXISTING flag does
122 if (MoveFileExW(srcpath, dstpath, MOVEFILE_REPLACE_EXISTING))
125 /* MoveFileExW() failed. One way this can happen is if any process has
126 * the destination file open, in which case ERROR_ACCESS_DENIED is
127 * produced. This can commonly happen if there is a backup or antivirus
128 * program monitoring or scanning the files. This behavior is very
129 * different from the behavior of POSIX rename(), which simply unlinks
130 * the destination file and allows other processes to keep it open! */
132 if (GetLastError() != ERROR_ACCESS_DENIED)
135 /* We can work around the above-mentioned problem by renaming the
136 * destination file to yet another temporary file, then "deleting" it,
137 * which on Windows will in fact not actually delete it immediately but
138 * rather mark it for deletion when the last handle to it is closed. */
140 static const wchar_t orig_suffix[5] = L".orig";
141 const size_t num_rand_chars = 9;
144 size_t dstlen = wcslen(dstpath);
146 tmpname = alloca(sizeof(wchar_t) *
147 (dstlen + ARRAY_LEN(orig_suffix) + num_rand_chars + 1));
149 p = wmempcpy(p, dstpath, dstlen);
150 p = wmempcpy(p, orig_suffix, ARRAY_LEN(orig_suffix));
151 randomize_char_array_with_alnum(p, num_rand_chars);
156 if (!MoveFile(dstpath, tmpname))
159 if (!DeleteFile(tmpname)) {
160 set_errno_from_GetLastError();
161 WARNING_WITH_ERRNO("Failed to delete original file "
162 "(moved to \"%ls\")", tmpname);
165 if (!MoveFile(srcpath, dstpath)) {
166 set_errno_from_GetLastError();
167 WARNING_WITH_ERRNO("Atomic semantics not respected in "
168 "failed rename() (new file is at \"%ls\")",
176 set_errno_from_GetLastError();
180 /* Replacement for POSIX fnmatch() (partial functionality only) */
182 fnmatch(const wchar_t *pattern, const wchar_t *string, int flags)
184 if (PathMatchSpecW(string, pattern))
190 /* truncate() replacement */
192 win32_truncate_replacement(const wchar_t *path, off_t size)
194 DWORD err = NO_ERROR;
195 LARGE_INTEGER liOffset;
197 HANDLE h = win32_open_existing_file(path, GENERIC_WRITE);
198 if (h == INVALID_HANDLE_VALUE)
201 liOffset.QuadPart = size;
202 if (!SetFilePointerEx(h, liOffset, NULL, FILE_BEGIN))
203 goto fail_close_handle;
205 if (!SetEndOfFile(h))
206 goto fail_close_handle;
211 err = GetLastError();
215 err = GetLastError();
216 set_errno_from_win32_error(err);
221 /* This really could be replaced with _wcserror_s, but this doesn't seem to
222 * actually be available in MSVCRT.DLL on Windows XP (perhaps it's statically
223 * linked in by Visual Studio...?). */
225 win32_strerror_r_replacement(int errnum, wchar_t *buf, size_t buflen)
227 static pthread_mutex_t strerror_lock = PTHREAD_MUTEX_INITIALIZER;
229 pthread_mutex_lock(&strerror_lock);
230 mbstowcs(buf, strerror(errnum), buflen);
231 buf[buflen - 1] = '\0';
232 pthread_mutex_unlock(&strerror_lock);
237 do_pread_or_pwrite(int fd, void *buf, size_t count, off_t offset,
241 LARGE_INTEGER orig_offset;
242 DWORD bytes_read_or_written;
243 LARGE_INTEGER relative_offset;
244 OVERLAPPED overlapped;
247 h = (HANDLE)_get_osfhandle(fd);
248 if (h == INVALID_HANDLE_VALUE)
251 if (GetFileType(h) == FILE_TYPE_PIPE) {
256 /* Get original position */
257 relative_offset.QuadPart = 0;
258 if (!SetFilePointerEx(h, relative_offset, &orig_offset, FILE_CURRENT))
261 memset(&overlapped, 0, sizeof(overlapped));
262 overlapped.Offset = offset;
263 overlapped.OffsetHigh = offset >> 32;
265 /* Do the read or write at the specified offset */
267 bret = WriteFile(h, buf, count, &bytes_read_or_written, &overlapped);
269 bret = ReadFile(h, buf, count, &bytes_read_or_written, &overlapped);
273 /* Restore the original position */
274 if (!SetFilePointerEx(h, orig_offset, NULL, FILE_BEGIN))
277 return bytes_read_or_written;
279 set_errno_from_GetLastError();
284 /* Dumb Windows implementation of pread(). It temporarily changes the file
285 * offset, so it is not safe to use with readers/writers on the same file
288 pread(int fd, void *buf, size_t count, off_t offset)
290 return do_pread_or_pwrite(fd, buf, count, offset, false);
293 /* Dumb Windows implementation of pwrite(). It temporarily changes the file
294 * offset, so it is not safe to use with readers/writers on the same file
297 pwrite(int fd, const void *buf, size_t count, off_t offset)
299 return do_pread_or_pwrite(fd, (void*)buf, count, offset, true);
302 /* Dumb Windows implementation of writev(). It writes the vectors one at a
304 ssize_t writev(int fd, const struct iovec *iov, int iovcnt)
306 ssize_t total_bytes_written = 0;
312 for (int i = 0; i < iovcnt; i++) {
313 ssize_t bytes_written;
315 bytes_written = write(fd, iov[i].iov_base, iov[i].iov_len);
316 if (bytes_written >= 0)
317 total_bytes_written += bytes_written;
318 if (bytes_written != iov[i].iov_len) {
319 if (total_bytes_written == 0)
320 total_bytes_written = -1;
324 return total_bytes_written;
328 win32_get_file_and_vol_ids(const wchar_t *path, u64 *ino_ret, u64 *dev_ret)
331 BY_HANDLE_FILE_INFORMATION file_info;
335 h = win32_open_existing_file(path, FILE_READ_ATTRIBUTES);
336 if (h == INVALID_HANDLE_VALUE) {
337 ret = WIMLIB_ERR_OPEN;
341 if (!GetFileInformationByHandle(h, &file_info)) {
342 ret = WIMLIB_ERR_STAT;
344 *ino_ret = ((u64)file_info.nFileIndexHigh << 32) |
345 (u64)file_info.nFileIndexLow;
346 *dev_ret = file_info.dwVolumeSerialNumber;
349 err = GetLastError();
353 set_errno_from_GetLastError();
357 /* Replacement for glob() in Windows native builds that operates on wide
360 win32_wglob(const wchar_t *pattern, int flags,
361 int (*errfunc)(const wchar_t *epath, int eerrno),
364 WIN32_FIND_DATAW dat;
370 const wchar_t *backslash, *end_slash;
373 backslash = wcsrchr(pattern, L'\\');
374 end_slash = wcsrchr(pattern, L'/');
376 if (backslash > end_slash)
377 end_slash = backslash;
380 prefix_len = end_slash - pattern + 1;
384 /* This function does not support all functionality of the POSIX glob(),
385 * so make sure the parameters are consistent with supported
387 wimlib_assert(errfunc == NULL);
388 wimlib_assert((flags & GLOB_ERR) == GLOB_ERR);
389 wimlib_assert((flags & ~(GLOB_NOSORT | GLOB_ERR)) == 0);
391 hFind = FindFirstFileW(pattern, &dat);
392 if (hFind == INVALID_HANDLE_VALUE) {
393 err = GetLastError();
394 if (err == ERROR_FILE_NOT_FOUND) {
398 /* The other possible error codes for FindFirstFile()
399 * are undocumented. */
405 pglob->gl_pathv = NULL;
409 if (pglob->gl_pathc == nspaces) {
413 new_nspaces = nspaces * 2 + 1;
414 pathv = REALLOC(pglob->gl_pathv,
415 new_nspaces * sizeof(pglob->gl_pathv[0]));
418 pglob->gl_pathv = pathv;
419 nspaces = new_nspaces;
421 size_t filename_len = wcslen(dat.cFileName);
422 size_t len_needed = prefix_len + filename_len;
424 path = MALLOC((len_needed + 1) * sizeof(wchar_t));
428 wmemcpy(path, pattern, prefix_len);
429 wmemcpy(path + prefix_len, dat.cFileName, filename_len + 1);
430 pglob->gl_pathv[pglob->gl_pathc++] = path;
431 } while (FindNextFileW(hFind, &dat));
432 err = GetLastError();
434 if (err == ERROR_NO_MORE_FILES) {
438 /* Other possible error codes for FindNextFile() are
454 globfree(glob_t *pglob)
457 for (i = 0; i < pglob->gl_pathc; i++)
458 free(pglob->gl_pathv[i]);
459 free(pglob->gl_pathv);
462 #endif /* __WIN32__ */