5b3017a33af07437d178b1215dadef2c94b52241
[wimlib] / src / win32_replacements.c
1 /*
2  * win32_replacements.c - Replacements for various functions not available on
3  * Windows, such as fsync().
4  */
5
6 /*
7  * Copyright (C) 2013 Eric Biggers
8  *
9  * This file is part of wimlib, a library for working with WIM files.
10  *
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)
14  * any later version.
15  *
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
19  * details.
20  *
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/.
23  */
24
25 #ifdef __WIN32__
26
27 #ifdef HAVE_CONFIG_H
28 #  include "config.h"
29 #endif
30
31 #include <errno.h>
32 #include <pthread.h>
33 #include <io.h> /* for _get_osfhandle()  */
34
35 #include "wimlib/win32_common.h"
36
37 #include "wimlib/assert.h"
38 #include "wimlib/glob.h"
39 #include "wimlib/error.h"
40 #include "wimlib/util.h"
41
42 /* Replacement for POSIX fsync() */
43 int
44 fsync(int fd)
45 {
46         HANDLE h;
47
48         h = (HANDLE)_get_osfhandle(fd);
49         if (h == INVALID_HANDLE_VALUE)
50                 goto err;
51         if (!FlushFileBuffers(h))
52                 goto err_set_errno;
53         return 0;
54 err_set_errno:
55         set_errno_from_GetLastError();
56 err:
57         return -1;
58 }
59
60 /* Use the Win32 API to get the number of processors.  */
61 unsigned
62 win32_get_number_of_processors(void)
63 {
64         SYSTEM_INFO sysinfo;
65         GetSystemInfo(&sysinfo);
66         return sysinfo.dwNumberOfProcessors;
67 }
68
69 /* Use the Win32 API to get the amount of available memory.  */
70 u64
71 win32_get_avail_memory(void)
72 {
73         MEMORYSTATUSEX status = {
74                 .dwLength = sizeof(status),
75         };
76         GlobalMemoryStatusEx(&status);
77         return status.ullTotalPhys;
78 }
79
80 /* Replacement for POSIX-2008 realpath().  Warning: partial functionality only
81  * (resolved_path must be NULL).   Also I highly doubt that GetFullPathName
82  * really does the right thing under all circumstances. */
83 wchar_t *
84 realpath(const wchar_t *path, wchar_t *resolved_path)
85 {
86         DWORD ret;
87         DWORD err;
88         wimlib_assert(resolved_path == NULL);
89
90         ret = GetFullPathNameW(path, 0, NULL, NULL);
91         if (!ret) {
92                 err = GetLastError();
93                 goto fail_win32;
94         }
95
96         resolved_path = MALLOC(ret * sizeof(wchar_t));
97         if (!resolved_path)
98                 goto out;
99         ret = GetFullPathNameW(path, ret, resolved_path, NULL);
100         if (!ret) {
101                 err = GetLastError();
102                 FREE(resolved_path);
103                 resolved_path = NULL;
104                 goto fail_win32;
105         }
106         goto out;
107 fail_win32:
108         set_errno_from_win32_error(err);
109 out:
110         return resolved_path;
111 }
112
113 /* A quick hack to get reasonable rename() semantics on Windows, in particular
114  * deleting the destination file instead of failing with ERROR_FILE_EXISTS and
115  * working around any processes that may have the destination file open.
116  *
117  * Note: This is intended to be called when overwriting a regular file with an
118  * updated copy and is *not* a fully POSIX compliant rename().  For that you may
119  * wish to take a look at Cygwin's implementation, but be prepared...
120  *
121  * Return 0 on success, -1 on regular error, or 1 if the destination file was
122  * deleted but the source could not be renamed and therefore should not be
123  * deleted.
124  */
125 int
126 win32_rename_replacement(const wchar_t *srcpath, const wchar_t *dstpath)
127 {
128         wchar_t *tmpname;
129
130         /* Normally, MoveFileExW() with the MOVEFILE_REPLACE_EXISTING flag does
131          * what we want.  */
132
133         if (MoveFileExW(srcpath, dstpath, MOVEFILE_REPLACE_EXISTING))
134                 return 0;
135
136         /* MoveFileExW() failed.  One way this can happen is if any process has
137          * the destination file open, in which case ERROR_ACCESS_DENIED is
138          * produced.  This can commonly happen if there is a backup or antivirus
139          * program monitoring or scanning the files.  This behavior is very
140          * different from the behavior of POSIX rename(), which simply unlinks
141          * the destination file and allows other processes to keep it open!  */
142
143         if (GetLastError() != ERROR_ACCESS_DENIED)
144                 goto err_set_errno;
145
146         /* We can work around the above-mentioned problem by renaming the
147          * destination file to yet another temporary file, then "deleting" it,
148          * which on Windows will in fact not actually delete it immediately but
149          * rather mark it for deletion when the last handle to it is closed.  */
150         {
151                 static const wchar_t orig_suffix[5] = L".orig";
152                 const size_t num_rand_chars = 9;
153                 wchar_t *p;
154
155                 size_t dstlen = wcslen(dstpath);
156
157                 tmpname = alloca(sizeof(wchar_t) *
158                                  (dstlen + ARRAY_LEN(orig_suffix) + num_rand_chars + 1));
159                 p = tmpname;
160                 p = wmempcpy(p, dstpath, dstlen);
161                 p = wmempcpy(p, orig_suffix, ARRAY_LEN(orig_suffix));
162                 randomize_char_array_with_alnum(p, num_rand_chars);
163                 p += num_rand_chars;
164                 *p = L'\0';
165         }
166
167         if (!MoveFile(dstpath, tmpname))
168                 goto err_set_errno;
169
170         if (!DeleteFile(tmpname)) {
171                 set_errno_from_GetLastError();
172                 WARNING_WITH_ERRNO("Failed to delete original file "
173                                    "(moved to \"%ls\")", tmpname);
174         }
175
176         if (!MoveFile(srcpath, dstpath)) {
177                 set_errno_from_GetLastError();
178                 WARNING_WITH_ERRNO("Atomic semantics not respected in "
179                                    "failed rename() (new file is at \"%ls\")",
180                                    srcpath);
181                 return 1;
182         }
183
184         return 0;
185
186 err_set_errno:
187         set_errno_from_GetLastError();
188         return -1;
189 }
190
191 /* This really could be replaced with _wcserror_s, but this doesn't seem to
192  * actually be available in MSVCRT.DLL on Windows XP (perhaps it's statically
193  * linked in by Visual Studio...?). */
194 int
195 win32_strerror_r_replacement(int errnum, wchar_t *buf, size_t buflen)
196 {
197         static pthread_mutex_t strerror_lock = PTHREAD_MUTEX_INITIALIZER;
198
199         pthread_mutex_lock(&strerror_lock);
200         mbstowcs(buf, strerror(errnum), buflen);
201         buf[buflen - 1] = '\0';
202         pthread_mutex_unlock(&strerror_lock);
203         return 0;
204 }
205
206 static int
207 do_pread_or_pwrite(int fd, void *buf, size_t count, off_t offset,
208                    bool is_pwrite)
209 {
210         HANDLE h;
211         LARGE_INTEGER orig_offset;
212         DWORD bytes_read_or_written;
213         LARGE_INTEGER relative_offset;
214         OVERLAPPED overlapped;
215         BOOL bret;
216
217         h = (HANDLE)_get_osfhandle(fd);
218         if (h == INVALID_HANDLE_VALUE)
219                 goto err;
220
221         if (GetFileType(h) == FILE_TYPE_PIPE) {
222                 errno = ESPIPE;
223                 goto err;
224         }
225
226         /* Get original position */
227         relative_offset.QuadPart = 0;
228         if (!SetFilePointerEx(h, relative_offset, &orig_offset, FILE_CURRENT))
229                 goto err_set_errno;
230
231         memset(&overlapped, 0, sizeof(overlapped));
232         overlapped.Offset = offset;
233         overlapped.OffsetHigh = offset >> 32;
234
235         /* Do the read or write at the specified offset */
236         if (is_pwrite)
237                 bret = WriteFile(h, buf, count, &bytes_read_or_written, &overlapped);
238         else
239                 bret = ReadFile(h, buf, count, &bytes_read_or_written, &overlapped);
240         if (!bret)
241                 goto err_set_errno;
242
243         /* Restore the original position */
244         if (!SetFilePointerEx(h, orig_offset, NULL, FILE_BEGIN))
245                 goto err_set_errno;
246
247         return bytes_read_or_written;
248 err_set_errno:
249         set_errno_from_GetLastError();
250 err:
251         return -1;
252 }
253
254 /* Dumb Windows implementation of pread().  It temporarily changes the file
255  * offset, so it is not safe to use with readers/writers on the same file
256  * descriptor.  */
257 ssize_t
258 pread(int fd, void *buf, size_t count, off_t offset)
259 {
260         return do_pread_or_pwrite(fd, buf, count, offset, false);
261 }
262
263 /* Dumb Windows implementation of pwrite().  It temporarily changes the file
264  * offset, so it is not safe to use with readers/writers on the same file
265  * descriptor. */
266 ssize_t
267 pwrite(int fd, const void *buf, size_t count, off_t offset)
268 {
269         return do_pread_or_pwrite(fd, (void*)buf, count, offset, true);
270 }
271
272 /* Replacement for glob() in Windows native builds that operates on wide
273  * characters.  */
274 int
275 win32_wglob(const wchar_t *pattern, int flags,
276             int (*errfunc)(const wchar_t *epath, int eerrno),
277             glob_t *pglob)
278 {
279         WIN32_FIND_DATAW dat;
280         DWORD err;
281         HANDLE hFind;
282         int ret;
283         size_t nspaces;
284         int errno_save;
285
286         const wchar_t *backslash, *end_slash;
287         size_t prefix_len;
288
289         backslash = wcsrchr(pattern, L'\\');
290         end_slash = wcsrchr(pattern, L'/');
291
292         if (backslash > end_slash)
293                 end_slash = backslash;
294
295         if (end_slash)
296                 prefix_len = end_slash - pattern + 1;
297         else
298                 prefix_len = 0;
299
300         /* This function does not support all functionality of the POSIX glob(),
301          * so make sure the parameters are consistent with supported
302          * functionality. */
303         wimlib_assert(errfunc == NULL);
304         wimlib_assert((flags & GLOB_ERR) == GLOB_ERR);
305         wimlib_assert((flags & ~(GLOB_NOSORT | GLOB_ERR)) == 0);
306
307         hFind = FindFirstFileW(pattern, &dat);
308         if (hFind == INVALID_HANDLE_VALUE) {
309                 err = GetLastError();
310                 if (err == ERROR_FILE_NOT_FOUND) {
311                         errno = 0;
312                         return GLOB_NOMATCH;
313                 } else {
314                         set_errno_from_win32_error(err);
315                         return GLOB_ABORTED;
316                 }
317         }
318         pglob->gl_pathc = 0;
319         pglob->gl_pathv = NULL;
320         nspaces = 0;
321         do {
322                 wchar_t *path;
323                 if (pglob->gl_pathc == nspaces) {
324                         size_t new_nspaces;
325                         wchar_t **pathv;
326
327                         new_nspaces = nspaces * 2 + 1;
328                         pathv = REALLOC(pglob->gl_pathv,
329                                         new_nspaces * sizeof(pglob->gl_pathv[0]));
330                         if (!pathv)
331                                 goto oom;
332                         pglob->gl_pathv = pathv;
333                         nspaces = new_nspaces;
334                 }
335                 size_t filename_len = wcslen(dat.cFileName);
336                 size_t len_needed = prefix_len + filename_len;
337
338                 path = MALLOC((len_needed + 1) * sizeof(wchar_t));
339                 if (!path)
340                         goto oom;
341
342                 wmemcpy(path, pattern, prefix_len);
343                 wmemcpy(path + prefix_len, dat.cFileName, filename_len + 1);
344                 pglob->gl_pathv[pglob->gl_pathc++] = path;
345         } while (FindNextFileW(hFind, &dat));
346         err = GetLastError();
347         CloseHandle(hFind);
348         if (err != ERROR_NO_MORE_FILES) {
349                 set_errno_from_win32_error(err);
350                 ret = GLOB_ABORTED;
351                 goto fail_globfree;
352         }
353         return 0;
354
355 oom:
356         CloseHandle(hFind);
357         errno = ENOMEM;
358         ret = GLOB_NOSPACE;
359 fail_globfree:
360         errno_save = errno;
361         globfree(pglob);
362         errno = errno_save;
363         return ret;
364 }
365
366 void
367 globfree(glob_t *pglob)
368 {
369         size_t i;
370         for (i = 0; i < pglob->gl_pathc; i++)
371                 FREE(pglob->gl_pathv[i]);
372         FREE(pglob->gl_pathv);
373 }
374
375 #endif /* __WIN32__ */