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/.
29 # define _GNU_SOURCE_DEFINED 1
32 /* Make sure the POSIX-compatible strerror_r() is declared, rather than the GNU
33 * version, which has a different return type. */
35 #ifdef _GNU_SOURCE_DEFINED
40 #include "wimlib/compiler.h"
41 #include "wimlib/encoding.h"
42 #include "wimlib/error.h"
43 #include "wimlib/types.h"
44 #include "wimlib/util.h"
45 #include "wimlib/xml.h"
48 # include "wimlib/win32.h" /* win32_strerror_r_replacement */
58 utf16le_strlen(const utf16lechar *s)
60 const utf16lechar *p = s;
63 return (p - s) * sizeof(utf16lechar);
66 #ifdef ENABLE_ERROR_MESSAGES
67 bool wimlib_print_errors = false;
70 #if defined(ENABLE_ERROR_MESSAGES) || defined(ENABLE_DEBUG)
72 wimlib_vmsg(const tchar *tag, const tchar *format,
73 va_list va, bool perror)
75 #if !defined(ENABLE_DEBUG)
76 if (wimlib_print_errors)
79 int errno_save = errno;
82 tvfprintf(stderr, format, va);
83 if (perror && errno_save != 0) {
86 res = tstrerror_r(errno_save, buf, ARRAY_LEN(buf));
89 T("unknown error (errno=%d)"),
93 if (errno_save == EBUSY)
94 tstrcpy(buf, T("Resource busy"));
96 tfprintf(stderr, T(": %"TS), buf);
98 tputc(T('\n'), stderr);
105 /* True if wimlib is to print an informational message when an error occurs.
106 * This can be turned off by calling wimlib_set_print_errors(false). */
107 #ifdef ENABLE_ERROR_MESSAGES
109 wimlib_error(const tchar *format, ...)
113 va_start(va, format);
114 wimlib_vmsg(T("\r[ERROR] "), format, va, false);
119 wimlib_error_with_errno(const tchar *format, ...)
123 va_start(va, format);
124 wimlib_vmsg(T("\r[ERROR] "), format, va, true);
129 wimlib_warning(const tchar *format, ...)
133 va_start(va, format);
134 wimlib_vmsg(T("\r[WARNING] "), format, va, false);
139 wimlib_warning_with_errno(const tchar *format, ...)
143 va_start(va, format);
144 wimlib_vmsg(T("\r[WARNING] "), format, va, true);
150 #if defined(ENABLE_DEBUG) || defined(ENABLE_MORE_DEBUG)
151 void wimlib_debug(const tchar *file, int line, const char *func,
152 const tchar *format, ...)
155 tchar buf[tstrlen(file) + strlen(func) + 30];
157 static bool debug_enabled = false;
158 if (!debug_enabled) {
159 char *value = getenv("WIMLIB_DEBUG");
160 if (!value || strcmp(value, "0"))
161 debug_enabled = true;
166 tsprintf(buf, T("[%"TS" %d] %s(): "), file, line, func);
168 va_start(va, format);
169 wimlib_vmsg(buf, format, va, false);
174 /* API function documented in wimlib.h */
176 wimlib_set_print_errors(bool show_error_messages)
178 #ifdef ENABLE_ERROR_MESSAGES
179 wimlib_print_errors = show_error_messages;
182 if (show_error_messages)
183 return WIMLIB_ERR_UNSUPPORTED;
189 static const tchar *error_strings[] = {
192 [WIMLIB_ERR_ALREADY_LOCKED]
193 = T("The WIM is already locked for writing"),
194 [WIMLIB_ERR_DECOMPRESSION]
195 = T("Failed to decompress compressed data"),
196 [WIMLIB_ERR_DELETE_STAGING_DIR]
197 = T("Failed to delete staging directory"),
198 [WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED]
199 = T("The process servicing the mounted WIM has crashed"),
201 = T("Failed to fork another process"),
203 = T("An error was returned by fuse_main()"),
204 [WIMLIB_ERR_FUSERMOUNT]
205 = T("Could not execute the `fusermount' program, or it exited "
206 "with a failure status"),
207 [WIMLIB_ERR_GLOB_HAD_NO_MATCHES]
208 = T("The provided file glob did not match any files"),
209 [WIMLIB_ERR_ICONV_NOT_AVAILABLE]
210 = T("The iconv() function does not seem to work. "
211 "Maybe check to make sure the directory /usr/lib/gconv exists"),
212 [WIMLIB_ERR_IMAGE_COUNT]
213 = T("Inconsistent image count among the metadata "
214 "resources, the WIM header, and/or the XML data"),
215 [WIMLIB_ERR_IMAGE_NAME_COLLISION]
216 = T("Tried to add an image with a name that is already in use"),
217 [WIMLIB_ERR_INSUFFICIENT_PRIVILEGES]
218 = T("The user does not have sufficient privileges"),
219 [WIMLIB_ERR_INTEGRITY]
220 = T("The WIM failed an integrity check"),
221 [WIMLIB_ERR_INVALID_CAPTURE_CONFIG]
222 = T("The capture configuration string was invalid"),
223 [WIMLIB_ERR_INVALID_CHUNK_SIZE]
224 = T("The WIM chunk size was invalid"),
225 [WIMLIB_ERR_INVALID_COMPRESSION_TYPE]
226 = T("The WIM compression type was invalid"),
227 [WIMLIB_ERR_INVALID_HEADER]
228 = T("The WIM header was invalid"),
229 [WIMLIB_ERR_INVALID_IMAGE]
230 = T("Tried to select an image that does not exist in the WIM"),
231 [WIMLIB_ERR_INVALID_INTEGRITY_TABLE]
232 = T("The WIM's integrity table is invalid"),
233 [WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY]
234 = T("An entry in the WIM's lookup table is invalid"),
235 [WIMLIB_ERR_INVALID_MULTIBYTE_STRING]
236 = T("A string was not valid in the current locale's character encoding"),
237 [WIMLIB_ERR_INVALID_OVERLAY]
238 = T("Conflicting files in overlay when creating a WIM image"),
239 [WIMLIB_ERR_INVALID_PARAM]
240 = T("An invalid parameter was given"),
241 [WIMLIB_ERR_INVALID_PART_NUMBER]
242 = T("The part number or total parts of the WIM is invalid"),
243 [WIMLIB_ERR_INVALID_PIPABLE_WIM]
244 = T("The pipable WIM is invalid"),
245 [WIMLIB_ERR_INVALID_REPARSE_DATA]
246 = T("The reparse data of a reparse point was invalid"),
247 [WIMLIB_ERR_INVALID_RESOURCE_HASH]
248 = T("The SHA1 message digest of a WIM resource did not match the expected value"),
249 [WIMLIB_ERR_INVALID_METADATA_RESOURCE]
250 = T("The metadata resource is invalid"),
251 [WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE]
252 = T("The version of wimlib that has mounted a WIM image is incompatible with the "
253 "version being used to unmount it"),
254 [WIMLIB_ERR_INVALID_UTF8_STRING]
255 = T("A string provided as input by the user was not a valid UTF-8 string"),
256 [WIMLIB_ERR_INVALID_UTF16_STRING]
257 = T("A string in a WIM dentry is not a valid UTF-16LE string"),
258 [WIMLIB_ERR_IS_DIRECTORY]
259 = T("One of the specified paths to delete was a directory"),
260 [WIMLIB_ERR_IS_SPLIT_WIM]
261 = T("The WIM is part of a split WIM, which is not supported for this operation"),
262 [WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE]
263 = T("libxml2 was unable to find a character encoding conversion handler "
266 = T("Failed to create a hard or symbolic link when extracting "
267 "a file from the WIM"),
268 [WIMLIB_ERR_METADATA_NOT_FOUND]
269 = T("A required metadata resource could not be located"),
271 = T("Failed to create a directory"),
273 = T("Failed to create or use a POSIX message queue"),
275 = T("Ran out of memory"),
277 = T("Expected a directory"),
278 [WIMLIB_ERR_NOTEMPTY]
279 = T("Directory was not empty"),
280 [WIMLIB_ERR_NOT_A_WIM_FILE]
281 = T("The file did not begin with the magic characters that "
282 "identify a WIM file"),
283 [WIMLIB_ERR_NOT_A_REGULAR_FILE]
284 = T("One of the specified paths to extract did not "
285 "correspond to a regular file"),
286 [WIMLIB_ERR_NO_FILENAME]
287 = T("The WIM is not identified with a filename"),
288 [WIMLIB_ERR_NOT_PIPABLE]
289 = T("The WIM was not captured such that it can be "
290 "applied from a pipe"),
292 = T("NTFS-3g encountered an error (check errno)"),
294 = T("Failed to open a file"),
296 = T("Failed to open a directory"),
297 [WIMLIB_ERR_PATH_DOES_NOT_EXIST]
298 = T("The path does not exist in the WIM image"),
300 = T("Could not read data from a file"),
301 [WIMLIB_ERR_READLINK]
302 = T("Could not read the target of a symbolic link"),
304 = T("Could not rename a file"),
305 [WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED]
306 = T("Unable to complete reparse point fixup"),
307 [WIMLIB_ERR_RESOURCE_NOT_FOUND]
308 = T("A file resource needed to complete the operation was missing from the WIM"),
309 [WIMLIB_ERR_RESOURCE_ORDER]
310 = T("The components of the WIM were arranged in an unexpected order"),
311 [WIMLIB_ERR_SET_ATTRIBUTES]
312 = T("Failed to set attributes on extracted file"),
313 [WIMLIB_ERR_SET_REPARSE_DATA]
314 = T("Failed to set reparse data on extracted file"),
315 [WIMLIB_ERR_SET_SECURITY]
316 = T("Failed to set file owner, group, or other permissions on extracted file"),
317 [WIMLIB_ERR_SET_SHORT_NAME]
318 = T("Failed to set short name on extracted file"),
319 [WIMLIB_ERR_SET_TIMESTAMPS]
320 = T("Failed to set timestamps on extracted file"),
321 [WIMLIB_ERR_SPLIT_INVALID]
322 = T("The WIM is part of an invalid split WIM"),
324 = T("Could not read the metadata for a file or directory"),
326 = T("Timed out while waiting for a message to arrive from another process"),
327 [WIMLIB_ERR_UNEXPECTED_END_OF_FILE]
328 = T("Unexpectedly reached the end of the file"),
329 [WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE]
330 = T("A Unicode string could not be represented in the current locale's encoding"),
331 [WIMLIB_ERR_UNKNOWN_VERSION]
332 = T("The WIM file is marked with an unknown version number"),
333 [WIMLIB_ERR_UNSUPPORTED]
334 = T("The requested operation is unsupported"),
335 [WIMLIB_ERR_UNSUPPORTED_FILE]
336 = T("A file in the directory tree to archive was not of a supported type"),
337 [WIMLIB_ERR_VOLUME_LACKS_FEATURES]
338 = T("The volume did not support a feature necessary to complete the operation"),
339 [WIMLIB_ERR_WIM_IS_READONLY]
340 = T("The WIM is read-only (file permissions, header flag, or split WIM)"),
342 = T("Failed to write data to a file"),
344 = T("The XML data of the WIM is invalid"),
345 [WIMLIB_ERR_WIM_IS_ENCRYPTED]
346 = T("The WIM file (or parts of it) is encrypted"),
348 = T("Failed to set WIMBoot pointer data"),
349 [WIMLIB_ERR_ABORTED_BY_PROGRESS]
350 = T("The operation was aborted by the library user"),
351 [WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS]
352 = T("The user-provided progress function returned an unrecognized value"),
355 /* API function documented in wimlib.h */
356 WIMLIBAPI const tchar *
357 wimlib_get_error_string(enum wimlib_error_code code)
359 if ((int)code < 0 || code >= ARRAY_LEN(error_strings))
362 return error_strings[code];
367 static void *(*wimlib_malloc_func) (size_t) = malloc;
368 static void (*wimlib_free_func) (void *) = free;
369 static void *(*wimlib_realloc_func)(void *, size_t) = realloc;
372 wimlib_malloc(size_t size)
377 ptr = (*wimlib_malloc_func)(size);
378 if (unlikely(!ptr)) {
383 ERROR("memory exhausted");
389 wimlib_free_memory(void *ptr)
391 (*wimlib_free_func)(ptr);
395 wimlib_realloc(void *ptr, size_t size)
399 ptr = (*wimlib_realloc_func)(ptr, size);
401 ERROR("memory exhausted");
406 wimlib_calloc(size_t nmemb, size_t size)
408 size_t total_size = nmemb * size;
409 void *p = MALLOC(total_size);
411 p = memset(p, 0, total_size);
416 wimlib_strdup(const char *str)
422 p = MALLOC(size + 1);
424 p = memcpy(p, str, size + 1);
430 wimlib_wcsdup(const wchar_t *str)
436 p = MALLOC((size + 1) * sizeof(wchar_t));
438 p = wmemcpy(p, str, size + 1);
444 memdup(const void *mem, size_t size)
446 void *ptr = MALLOC(size);
448 ptr = memcpy(ptr, mem, size);
452 /* API function documented in wimlib.h */
454 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
455 void (*free_func)(void *),
456 void *(*realloc_func)(void *, size_t))
458 wimlib_malloc_func = malloc_func ? malloc_func : malloc;
459 wimlib_free_func = free_func ? free_func : free;
460 wimlib_realloc_func = realloc_func ? realloc_func : realloc;
462 xml_set_memory_allocator(wimlib_malloc_func, wimlib_free_func,
463 wimlib_realloc_func);
467 static bool seeded = false;
472 srand(time(NULL) * getpid());
476 /* Fills @n characters pointed to by @p with random alphanumeric characters. */
478 randomize_char_array_with_alnum(tchar p[], size_t n)
493 /* Fills @n bytes pointer to by @p with random numbers. */
495 randomize_byte_array(u8 *p, size_t n)
504 void print_byte_field(const u8 field[], size_t len, FILE *out)
507 tfprintf(out, T("%02hhx"), *field++);
511 void *mempcpy(void *dst, const void *src, size_t n)
513 return memcpy(dst, src, n) + n;