6 * Copyright (C) 2012, 2013 Eric Biggers
8 * This file is part of wimlib, a library for working with WIM files.
10 * wimlib is free software; you can redistribute it and/or modify it under the
11 * terms of the GNU General Public License as published by the Free
12 * Software Foundation; either version 3 of the License, or (at your option)
15 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
16 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17 * A PARTICULAR PURPOSE. See the GNU General Public License for more
20 * You should have received a copy of the GNU General Public License
21 * along with wimlib; if not, see http://www.gnu.org/licenses/.
28 /* Make sure the POSIX-compatible strerror_r() is declared, rather than the GNU
29 * version, which has a different return type. */
34 #include "endianness.h"
35 #include "timestamp.h"
36 #include "wimlib_internal.h"
47 # define pread win32_pread
48 # define pwrite win32_pwrite
49 # define writev win32_writev
51 # include <sys/uio.h> /* for writev() and `struct iovec' */
55 utf16le_strlen(const utf16lechar *s)
57 const utf16lechar *p = s;
60 return (p - s) * sizeof(utf16lechar);
64 # define wimlib_vfprintf vfwprintf
66 /* Handle %W for UTF16-LE printing.
68 * TODO: this is not yet done properly--- it's assumed that if the format string
69 * contains %W, then it contains no other format specifiers.
72 wimlib_vfprintf(FILE *fp, const tchar *format, va_list va)
77 for (p = format; *p; p++)
78 if (*p == T('%') && *(p + 1) == T('W'))
80 return tvfprintf(fp, format, va);
83 for (p = format; *p; p++) {
84 if (*p == T('%') && (*(p + 1) == T('W'))) {
88 utf16lechar *ucs = va_arg(va, utf16lechar*);
91 size_t ucs_nbytes = utf16le_strlen(ucs);
93 ret = utf16le_to_tstr(ucs, ucs_nbytes,
96 ret = tfprintf(fp, T("??????"));
98 ret = tfprintf(fp, T("%"TS), tstr);
106 n += tfprintf(fp, T("(null)"));
110 if (tputc(*p, fp) == EOF)
119 wimlib_printf(const tchar *format, ...)
124 va_start(va, format);
125 ret = wimlib_vfprintf(stdout, format, va);
131 wimlib_fprintf(FILE *fp, const tchar *format, ...)
136 va_start(va, format);
137 ret = wimlib_vfprintf(fp, format, va);
143 #if defined(ENABLE_ERROR_MESSAGES) || defined(ENABLE_DEBUG)
145 wimlib_vmsg(const tchar *tag, const tchar *format,
146 va_list va, bool perror)
149 if (wimlib_print_errors) {
151 int errno_save = errno;
154 wimlib_vfprintf(stderr, format, va);
155 if (perror && errno_save != 0) {
158 res = tstrerror_r(errno_save, buf, sizeof(buf));
161 T("unknown error (errno=%d)"),
164 tfprintf(stderr, T(": %"TS), buf);
166 tputc(T('\n'), stderr);
175 /* True if wimlib is to print an informational message when an error occurs.
176 * This can be turned off by calling wimlib_set_print_errors(false). */
177 #ifdef ENABLE_ERROR_MESSAGES
178 static bool wimlib_print_errors = false;
182 wimlib_error(const tchar *format, ...)
186 va_start(va, format);
187 wimlib_vmsg(T("\r[ERROR] "), format, va, false);
192 wimlib_error_with_errno(const tchar *format, ...)
196 va_start(va, format);
197 wimlib_vmsg(T("\r[ERROR] "), format, va, true);
202 wimlib_warning(const tchar *format, ...)
206 va_start(va, format);
207 wimlib_vmsg(T("\r[WARNING] "), format, va, false);
212 wimlib_warning_with_errno(const tchar *format, ...)
216 va_start(va, format);
217 wimlib_vmsg(T("\r[WARNING] "), format, va, true);
223 #if defined(ENABLE_DEBUG) || defined(ENABLE_MORE_DEBUG)
224 void wimlib_debug(const tchar *file, int line, const char *func,
225 const tchar *format, ...)
228 tchar buf[tstrlen(file) + strlen(func) + 30];
230 tsprintf(buf, T("[%"TS" %d] %s(): "), file, line, func);
232 va_start(va, format);
233 wimlib_vmsg(buf, format, va, false);
239 wimlib_set_print_errors(bool show_error_messages)
241 #ifdef ENABLE_ERROR_MESSAGES
242 wimlib_print_errors = show_error_messages;
245 if (show_error_messages)
246 return WIMLIB_ERR_UNSUPPORTED;
252 static const tchar *error_strings[] = {
255 [WIMLIB_ERR_ALREADY_LOCKED]
256 = T("The WIM is already locked for writing"),
257 [WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE]
258 = T("Lookup table is compressed"),
259 [WIMLIB_ERR_DECOMPRESSION]
260 = T("Failed to decompress compressed data"),
261 [WIMLIB_ERR_DELETE_STAGING_DIR]
262 = T("Failed to delete staging directory"),
263 [WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED]
264 = T("The process servicing the mounted WIM has crashed"),
266 = T("Failed to fork another process"),
268 = T("An error was returned by fuse_main()"),
269 [WIMLIB_ERR_FUSERMOUNT]
270 = T("Could not execute the `fusermount' program, or it exited "
271 "with a failure status"),
272 [WIMLIB_ERR_ICONV_NOT_AVAILABLE]
273 = T("The iconv() function does not seem to work. "
274 "Maybe check to make sure the directory /usr/lib/gconv exists"),
275 [WIMLIB_ERR_IMAGE_COUNT]
276 = T("Inconsistent image count among the metadata "
277 "resources, the WIM header, and/or the XML data"),
278 [WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT]
279 = T("User does not have sufficient privileges to correctly extract the data"),
280 [WIMLIB_ERR_IMAGE_NAME_COLLISION]
281 = T("Tried to add an image with a name that is already in use"),
282 [WIMLIB_ERR_INTEGRITY]
283 = T("The WIM failed an integrity check"),
284 [WIMLIB_ERR_INVALID_CAPTURE_CONFIG]
285 = T("The capture configuration string was invalid"),
286 [WIMLIB_ERR_INVALID_CHUNK_SIZE]
287 = T("The WIM is compressed but does not have a chunk "
289 [WIMLIB_ERR_INVALID_COMPRESSION_TYPE]
290 = T("The WIM is compressed, but is not marked as having LZX or "
291 "XPRESS compression"),
292 [WIMLIB_ERR_INVALID_DENTRY]
293 = T("A directory entry in the WIM was invalid"),
294 [WIMLIB_ERR_INVALID_HEADER_SIZE]
295 = T("The WIM header was not 208 bytes"),
296 [WIMLIB_ERR_INVALID_IMAGE]
297 = T("Tried to select an image that does not exist in the WIM"),
298 [WIMLIB_ERR_INVALID_INTEGRITY_TABLE]
299 = T("The WIM's integrity table is invalid"),
300 [WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY]
301 = T("An entry in the WIM's lookup table is invalid"),
302 [WIMLIB_ERR_INVALID_MULTIBYTE_STRING]
303 = T("A string was not valid in the current locale's character encoding"),
304 [WIMLIB_ERR_INVALID_OVERLAY]
305 = T("Conflicting files in overlay when creating a WIM image"),
306 [WIMLIB_ERR_INVALID_PARAM]
307 = T("An invalid parameter was given"),
308 [WIMLIB_ERR_INVALID_PART_NUMBER]
309 = T("The part number or total parts of the WIM is invalid"),
310 [WIMLIB_ERR_INVALID_REPARSE_DATA]
311 = T("The reparse data of a reparse point was invalid"),
312 [WIMLIB_ERR_INVALID_RESOURCE_HASH]
313 = T("The SHA1 message digest of a WIM resource did not match the expected value"),
314 [WIMLIB_ERR_INVALID_RESOURCE_SIZE]
315 = T("A resource entry in the WIM has an invalid size"),
316 [WIMLIB_ERR_INVALID_SECURITY_DATA]
317 = T("The table of security descriptors in the WIM is invalid"),
318 [WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE]
319 = T("The version of wimlib that has mounted a WIM image is incompatible with the "
320 "version being used to unmount it"),
321 [WIMLIB_ERR_INVALID_UTF8_STRING]
322 = T("A string provided as input by the user was not a valid UTF-8 string"),
323 [WIMLIB_ERR_INVALID_UTF16_STRING]
324 = T("A string in a WIM dentry is not a valid UTF-16LE string"),
325 [WIMLIB_ERR_IS_DIRECTORY]
326 = T("One of the specified paths to delete was a directory"),
327 [WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE]
328 = T("libxml2 was unable to find a character encoding conversion handler "
331 = T("Failed to create a hard or symbolic link when extracting "
332 "a file from the WIM"),
334 = T("Failed to create a directory"),
336 = T("Failed to create or use a POSIX message queue"),
338 = T("Ran out of memory"),
340 = T("Expected a directory"),
341 [WIMLIB_ERR_NOT_A_WIM_FILE]
342 = T("The file did not begin with the magic characters that "
343 "identify a WIM file"),
344 [WIMLIB_ERR_NOT_A_REGULAR_FILE]
345 = T("One of the specified paths to extract did not "
346 "correspond to a regular file"),
347 [WIMLIB_ERR_NO_FILENAME]
348 = T("The WIM is not identified with a filename"),
350 = T("NTFS-3g encountered an error (check errno)"),
352 = T("Failed to open a file"),
354 = T("Failed to open a directory"),
355 [WIMLIB_ERR_PATH_DOES_NOT_EXIST]
356 = T("The path does not exist in the WIM image"),
358 = T("Could not read data from a file"),
359 [WIMLIB_ERR_READLINK]
360 = T("Could not read the target of a symbolic link"),
362 = T("Could not rename a file"),
363 [WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED]
364 = T("Unable to complete reparse point fixup"),
365 [WIMLIB_ERR_RESOURCE_ORDER]
366 = T("The components of the WIM were arranged in an unexpected order"),
367 [WIMLIB_ERR_SPECIAL_FILE]
368 = T("Encountered a special file that cannot be archived"),
369 [WIMLIB_ERR_SPLIT_INVALID]
370 = T("The WIM is part of an invalid split WIM"),
371 [WIMLIB_ERR_SPLIT_UNSUPPORTED]
372 = T("The WIM is part of a split WIM, which is not supported for this operation"),
374 = T("Could not read the metadata for a file or directory"),
376 = T("Timed out while waiting for a message to arrive from another process"),
377 [WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE]
378 = T("A Unicode string could not be represented in the current locale's encoding"),
379 [WIMLIB_ERR_UNKNOWN_VERSION]
380 = T("The WIM file is marked with an unknown version number"),
381 [WIMLIB_ERR_UNSUPPORTED]
382 = T("The requested operation is unsupported"),
383 [WIMLIB_ERR_VOLUME_LACKS_FEATURES]
384 = T("The volume did not support a feature necessary to complete the operation"),
386 = T("Failed to write data to a file"),
388 = T("The XML data of the WIM is invalid"),
391 WIMLIBAPI const tchar *
392 wimlib_get_error_string(enum wimlib_error_code code)
394 if (code < 0 || code >= ARRAY_LEN(error_strings))
397 return error_strings[code];
402 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
403 void *(*wimlib_malloc_func) (size_t) = malloc;
404 void (*wimlib_free_func) (void *) = free;
405 void *(*wimlib_realloc_func)(void *, size_t) = realloc;
408 wimlib_calloc(size_t nmemb, size_t size)
410 size_t total_size = nmemb * size;
411 void *p = MALLOC(total_size);
413 memset(p, 0, total_size);
418 wimlib_strdup(const char *str)
424 p = MALLOC(size + 1);
426 memcpy(p, str, size + 1);
432 wimlib_wcsdup(const wchar_t *str)
438 p = MALLOC((size + 1) * sizeof(wchar_t));
440 memcpy(p, str, (size + 1) * sizeof(wchar_t));
446 xml_set_memory_allocator(void *(*malloc_func)(size_t),
447 void (*free_func)(void *),
448 void *(*realloc_func)(void *, size_t));
452 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
453 void (*free_func)(void *),
454 void *(*realloc_func)(void *, size_t))
456 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
457 wimlib_malloc_func = malloc_func ? malloc_func : malloc;
458 wimlib_free_func = free_func ? free_func : free;
459 wimlib_realloc_func = realloc_func ? realloc_func : realloc;
461 xml_set_memory_allocator(wimlib_malloc_func, wimlib_free_func,
462 wimlib_realloc_func);
465 ERROR("Cannot set custom memory allocator functions:");
466 ERROR("wimlib was compiled with the --without-custom-memory-allocator "
468 return WIMLIB_ERR_UNSUPPORTED;
472 static bool seeded = false;
477 srand(time(NULL) * getpid());
481 /* Fills @n characters pointed to by @p with random alphanumeric characters. */
483 randomize_char_array_with_alnum(tchar p[], size_t n)
498 /* Fills @n bytes pointer to by @p with random numbers. */
500 randomize_byte_array(u8 *p, size_t n)
509 path_basename_with_len(const tchar *path, size_t len)
511 const tchar *p = &path[len] - 1;
513 /* Trailing slashes. */
522 while ((p != path - 1) && *p != T('/'))
528 /* Like the basename() function, but does not modify @path; it just returns a
531 path_basename(const tchar *path)
533 return path_basename_with_len(path, tstrlen(path));
537 * Returns a pointer to the part of @path following the first colon in the last
538 * path component, or NULL if the last path component does not contain a colon.
541 path_stream_name(const tchar *path)
543 const tchar *base = path_basename(path);
544 const tchar *stream_name = tstrchr(base, T(':'));
548 return stream_name + 1;
555 gettimeofday(&tv, NULL);
556 return timeval_to_wim_timestamp(tv);
560 wim_timestamp_to_str(u64 timestamp, tchar *buf, size_t len)
563 time_t t = wim_timestamp_to_unix(timestamp);
565 tstrftime(buf, len, T("%a %b %d %H:%M:%S %Y UTC"), &tm);
569 zap_backslashes(tchar *s)
572 while (*s != T('\0')) {
581 canonicalize_fs_path(const tchar *fs_path)
583 tchar *canonical_path;
587 canonical_path = TSTRDUP(fs_path);
588 zap_backslashes(canonical_path);
589 return canonical_path;
592 /* Strip leading and trailing slashes from a string. Also translates
593 * backslashes into forward slashes. */
595 canonicalize_wim_path(const tchar *wim_path)
598 tchar *canonical_path;
600 if (wim_path == NULL) {
603 while (*wim_path == T('/') || *wim_path == T('\\'))
606 canonical_path = TSTRDUP(wim_path);
607 if (canonical_path) {
608 zap_backslashes(canonical_path);
609 for (p = tstrchr(canonical_path, T('\0')) - 1;
610 p >= canonical_path && *p == T('/');
616 return canonical_path;
619 /* Like read(), but keep trying until everything has been written or we know for
620 * sure that there was an error (or end-of-file). */
622 full_read(int fd, void *buf, size_t count)
625 size_t bytes_remaining;
627 for (bytes_remaining = count;
628 bytes_remaining != 0;
629 bytes_remaining -= bytes_read, buf += bytes_read)
631 bytes_read = read(fd, buf, bytes_remaining);
632 if (bytes_read <= 0) {
635 else if (errno == EINTR)
640 return count - bytes_remaining;
643 /* Like write(), but keep trying until everything has been written or we know
644 * for sure that there was an error. */
646 full_write(int fd, const void *buf, size_t count)
648 ssize_t bytes_written;
649 size_t bytes_remaining;
651 for (bytes_remaining = count;
652 bytes_remaining != 0;
653 bytes_remaining -= bytes_written, buf += bytes_written)
655 bytes_written = write(fd, buf, bytes_remaining);
656 if (bytes_written < 0) {
662 return count - bytes_remaining;
665 /* Like pread(), but keep trying until everything has been read or we know for
666 * sure that there was an error (or end-of-file) */
668 full_pread(int fd, void *buf, size_t count, off_t offset)
671 size_t bytes_remaining;
673 for (bytes_remaining = count;
674 bytes_remaining != 0;
675 bytes_remaining -= bytes_read, buf += bytes_read,
676 offset += bytes_read)
678 bytes_read = pread(fd, buf, bytes_remaining, offset);
679 if (bytes_read <= 0) {
682 else if (errno == EINTR)
687 return count - bytes_remaining;
690 /* Like pwrite(), but keep trying until everything has been written or we know
691 * for sure that there was an error. */
693 full_pwrite(int fd, const void *buf, size_t count, off_t offset)
695 ssize_t bytes_written;
696 size_t bytes_remaining;
698 for (bytes_remaining = count;
699 bytes_remaining != 0;
700 bytes_remaining -= bytes_written, buf += bytes_written,
701 offset += bytes_written)
703 bytes_written = pwrite(fd, buf, bytes_remaining, offset);
704 if (bytes_written < 0) {
710 return count - bytes_remaining;
713 /* Like writev(), but keep trying until everything has been written or we know
714 * for sure that there was an error. */
716 full_writev(int fd, struct iovec *iov, int iovcnt)
718 size_t total_bytes_written = 0;
720 ssize_t bytes_written;
722 bytes_written = writev(fd, iov, iovcnt);
723 if (bytes_written < 0) {
728 total_bytes_written += bytes_written;
729 while (bytes_written) {
730 if (bytes_written >= iov[0].iov_len) {
731 bytes_written -= iov[0].iov_len;
735 iov[0].iov_base += bytes_written;
736 iov[0].iov_len -= bytes_written;
741 return total_bytes_written;
745 filedes_offset(int fd)
747 return lseek(fd, 0, SEEK_CUR);