27e15acf3b3c20fcb492e935aaf7d45398021f6e
[wimlib] / src / util.c
1 /*
2  * util.c
3  */
4
5 /*
6  * Copyright (C) 2012, 2013 Eric Biggers
7  *
8  * This file is part of wimlib, a library for working with WIM files.
9  *
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)
13  * any later version.
14  *
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
18  * details.
19  *
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/.
22  */
23
24 #ifdef HAVE_CONFIG_H
25 #  include "config.h"
26 #endif
27
28 #ifdef _GNU_SOURCE
29 #  define _GNU_SOURCE_DEFINED 1
30 #  undef _GNU_SOURCE
31 #endif
32 /* Make sure the POSIX-compatible strerror_r() is declared, rather than the GNU
33  * version, which has a different return type. */
34 #include <string.h>
35 #ifdef _GNU_SOURCE_DEFINED
36 #  define _GNU_SOURCE
37 #endif
38
39 #include "wimlib.h"
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"
46
47 #ifdef __WIN32__
48 #  include "wimlib/win32.h" /* win32_strerror_r_replacement */
49 #endif
50
51 #include <errno.h>
52 #include <stdarg.h>
53 #include <stdlib.h>
54 #include <time.h>
55 #include <unistd.h>
56
57 static size_t
58 utf16le_strlen(const utf16lechar *s)
59 {
60         const utf16lechar *p = s;
61         while (*p)
62                 p++;
63         return (p - s) * sizeof(utf16lechar);
64 }
65
66 #ifdef __WIN32__
67 #  define wimlib_vfprintf vfwprintf
68 #else
69 /* Handle %W for UTF16-LE printing.
70  *
71  * TODO: this is not yet done properly--- it's assumed that if the format string
72  * contains %W, then it contains no other format specifiers.
73  */
74 static int
75 wimlib_vfprintf(FILE *fp, const tchar *format, va_list va)
76 {
77         const tchar *p;
78         int n;
79
80         for (p = format; *p; p++)
81                 if (*p == T('%') && *(p + 1) == T('W'))
82                         goto special;
83         return tvfprintf(fp, format, va);
84 special:
85         n = 0;
86         for (p = format; *p; p++) {
87                 if (*p == T('%') && (*(p + 1) == T('W'))) {
88                         int ret;
89                         tchar *tstr;
90                         size_t tstr_nbytes;
91                         utf16lechar *ucs = va_arg(va, utf16lechar*);
92
93                         if (ucs) {
94                                 size_t ucs_nbytes = utf16le_strlen(ucs);
95
96                                 ret = utf16le_to_tstr(ucs, ucs_nbytes,
97                                                       &tstr, &tstr_nbytes);
98                                 if (ret) {
99                                         ret = tfprintf(fp, T("??????"));
100                                 } else {
101                                         ret = tfprintf(fp, T("%"TS), tstr);
102                                         FREE(tstr);
103                                 }
104                                 if (ret < 0)
105                                         return -1;
106                                 else
107                                         n += ret;
108                         } else {
109                                 n += tfprintf(fp, T("(null)"));
110                         }
111                         p++;
112                 } else {
113                         if (tputc(*p, fp) == EOF)
114                                 return -1;
115                         n++;
116                 }
117         }
118         return n;
119 }
120
121 int
122 wimlib_printf(const tchar *format, ...)
123 {
124         int ret;
125         va_list va;
126
127         va_start(va, format);
128         ret = wimlib_vfprintf(stdout, format, va);
129         va_end(va);
130         return ret;
131 }
132
133 int
134 wimlib_fprintf(FILE *fp, const tchar *format, ...)
135 {
136         int ret;
137         va_list va;
138
139         va_start(va, format);
140         ret = wimlib_vfprintf(fp, format, va);
141         va_end(va);
142         return ret;
143 }
144
145 #endif /* __WIN32__ */
146
147 #ifdef ENABLE_ERROR_MESSAGES
148 bool wimlib_print_errors = false;
149 #endif
150
151 #if defined(ENABLE_ERROR_MESSAGES) || defined(ENABLE_DEBUG)
152 static void
153 wimlib_vmsg(const tchar *tag, const tchar *format,
154             va_list va, bool perror)
155 {
156 #ifndef DEBUG
157         if (wimlib_print_errors) {
158 #endif
159                 int errno_save = errno;
160                 fflush(stdout);
161                 tfputs(tag, stderr);
162                 wimlib_vfprintf(stderr, format, va);
163                 if (perror && errno_save != 0) {
164                         tchar buf[50];
165                         int res;
166                         res = tstrerror_r(errno_save, buf, sizeof(buf));
167                         if (res) {
168                                 tsprintf(buf,
169                                          T("unknown error (errno=%d)"),
170                                          errno_save);
171                         }
172                         tfprintf(stderr, T(": %"TS), buf);
173                 }
174                 tputc(T('\n'), stderr);
175                 fflush(stderr);
176                 errno = errno_save;
177 #ifndef DEBUG
178         }
179 #endif
180 }
181 #endif
182
183 /* True if wimlib is to print an informational message when an error occurs.
184  * This can be turned off by calling wimlib_set_print_errors(false). */
185 #ifdef ENABLE_ERROR_MESSAGES
186 void
187 wimlib_error(const tchar *format, ...)
188 {
189         va_list va;
190
191         va_start(va, format);
192         wimlib_vmsg(T("\r[ERROR] "), format, va, false);
193         va_end(va);
194 }
195
196 void
197 wimlib_error_with_errno(const tchar *format, ...)
198 {
199         va_list va;
200
201         va_start(va, format);
202         wimlib_vmsg(T("\r[ERROR] "), format, va, true);
203         va_end(va);
204 }
205
206 void
207 wimlib_warning(const tchar *format, ...)
208 {
209         va_list va;
210
211         va_start(va, format);
212         wimlib_vmsg(T("\r[WARNING] "), format, va, false);
213         va_end(va);
214 }
215
216 void
217 wimlib_warning_with_errno(const tchar *format, ...)
218 {
219         va_list va;
220
221         va_start(va, format);
222         wimlib_vmsg(T("\r[WARNING] "), format, va, true);
223         va_end(va);
224 }
225
226 #endif
227
228 #if defined(ENABLE_DEBUG) || defined(ENABLE_MORE_DEBUG)
229 void wimlib_debug(const tchar *file, int line, const char *func,
230                   const tchar *format, ...)
231 {
232         va_list va;
233         tchar buf[tstrlen(file) + strlen(func) + 30];
234
235         static bool debug_enabled = false;
236         if (!debug_enabled) {
237                 char *value = getenv("WIMLIB_DEBUG");
238                 if (!value || strcmp(value, "0"))
239                         debug_enabled = true;
240                 else
241                         return;
242         }
243
244         tsprintf(buf, T("[%"TS" %d] %s(): "), file, line, func);
245
246         va_start(va, format);
247         wimlib_vmsg(buf, format, va, false);
248         va_end(va);
249 }
250 #endif
251
252 /* API function documented in wimlib.h  */
253 WIMLIBAPI int
254 wimlib_set_print_errors(bool show_error_messages)
255 {
256 #ifdef ENABLE_ERROR_MESSAGES
257         wimlib_print_errors = show_error_messages;
258         return 0;
259 #else
260         if (show_error_messages)
261                 return WIMLIB_ERR_UNSUPPORTED;
262         else
263                 return 0;
264 #endif
265 }
266
267 static const tchar *error_strings[] = {
268         [WIMLIB_ERR_SUCCESS]
269                 = T("Success"),
270         [WIMLIB_ERR_ALREADY_LOCKED]
271                 = T("The WIM is already locked for writing"),
272         [WIMLIB_ERR_DECOMPRESSION]
273                 = T("Failed to decompress compressed data"),
274         [WIMLIB_ERR_DELETE_STAGING_DIR]
275                 = T("Failed to delete staging directory"),
276         [WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED]
277                 = T("The process servicing the mounted WIM has crashed"),
278         [WIMLIB_ERR_FORK]
279                 = T("Failed to fork another process"),
280         [WIMLIB_ERR_FUSE]
281                 = T("An error was returned by fuse_main()"),
282         [WIMLIB_ERR_FUSERMOUNT]
283                 = T("Could not execute the `fusermount' program, or it exited "
284                         "with a failure status"),
285         [WIMLIB_ERR_ICONV_NOT_AVAILABLE]
286                 = T("The iconv() function does not seem to work. "
287                   "Maybe check to make sure the directory /usr/lib/gconv exists"),
288         [WIMLIB_ERR_IMAGE_COUNT]
289                 = T("Inconsistent image count among the metadata "
290                         "resources, the WIM header, and/or the XML data"),
291         [WIMLIB_ERR_IMAGE_NAME_COLLISION]
292                 = T("Tried to add an image with a name that is already in use"),
293         [WIMLIB_ERR_INTEGRITY]
294                 = T("The WIM failed an integrity check"),
295         [WIMLIB_ERR_INVALID_CAPTURE_CONFIG]
296                 = T("The capture configuration string was invalid"),
297         [WIMLIB_ERR_INVALID_CHUNK_SIZE]
298                 = T("The WIM is compressed but does not have a chunk "
299                         "size of 32768"),
300         [WIMLIB_ERR_INVALID_COMPRESSION_TYPE]
301                 = T("The WIM is compressed, but is not marked as having LZX or "
302                         "XPRESS compression"),
303         [WIMLIB_ERR_INVALID_HEADER]
304                 = T("The WIM header was invalid"),
305         [WIMLIB_ERR_INVALID_IMAGE]
306                 = T("Tried to select an image that does not exist in the WIM"),
307         [WIMLIB_ERR_INVALID_INTEGRITY_TABLE]
308                 = T("The WIM's integrity table is invalid"),
309         [WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY]
310                 = T("An entry in the WIM's lookup table is invalid"),
311         [WIMLIB_ERR_INVALID_MULTIBYTE_STRING]
312                 = T("A string was not valid in the current locale's character encoding"),
313         [WIMLIB_ERR_INVALID_OVERLAY]
314                 = T("Conflicting files in overlay when creating a WIM image"),
315         [WIMLIB_ERR_INVALID_PARAM]
316                 = T("An invalid parameter was given"),
317         [WIMLIB_ERR_INVALID_PART_NUMBER]
318                 = T("The part number or total parts of the WIM is invalid"),
319         [WIMLIB_ERR_INVALID_PIPABLE_WIM]
320                 = T("The pipable WIM is invalid"),
321         [WIMLIB_ERR_INVALID_REPARSE_DATA]
322                 = T("The reparse data of a reparse point was invalid"),
323         [WIMLIB_ERR_INVALID_RESOURCE_HASH]
324                 = T("The SHA1 message digest of a WIM resource did not match the expected value"),
325         [WIMLIB_ERR_INVALID_METADATA_RESOURCE]
326                 = T("The metadata resource is invalid"),
327         [WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE]
328                 = T("The version of wimlib that has mounted a WIM image is incompatible with the "
329                   "version being used to unmount it"),
330         [WIMLIB_ERR_INVALID_UTF8_STRING]
331                 = T("A string provided as input by the user was not a valid UTF-8 string"),
332         [WIMLIB_ERR_INVALID_UTF16_STRING]
333                 = T("A string in a WIM dentry is not a valid UTF-16LE string"),
334         [WIMLIB_ERR_IS_DIRECTORY]
335                 = T("One of the specified paths to delete was a directory"),
336         [WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE]
337                 = T("libxml2 was unable to find a character encoding conversion handler "
338                   "for UTF-16LE"),
339         [WIMLIB_ERR_LINK]
340                 = T("Failed to create a hard or symbolic link when extracting "
341                         "a file from the WIM"),
342         [WIMLIB_ERR_MKDIR]
343                 = T("Failed to create a directory"),
344         [WIMLIB_ERR_MQUEUE]
345                 = T("Failed to create or use a POSIX message queue"),
346         [WIMLIB_ERR_NOMEM]
347                 = T("Ran out of memory"),
348         [WIMLIB_ERR_NOTDIR]
349                 = T("Expected a directory"),
350         [WIMLIB_ERR_NOTEMPTY]
351                 = T("Directory was not empty"),
352         [WIMLIB_ERR_NOT_A_WIM_FILE]
353                 = T("The file did not begin with the magic characters that "
354                         "identify a WIM file"),
355         [WIMLIB_ERR_NOT_A_REGULAR_FILE]
356                 = T("One of the specified paths to extract did not "
357                     "correspond to a regular file"),
358         [WIMLIB_ERR_NO_FILENAME]
359                 = T("The WIM is not identified with a filename"),
360         [WIMLIB_ERR_NOT_PIPABLE]
361                 = T("The WIM was not captured such that it can be "
362                     "applied from a pipe"),
363         [WIMLIB_ERR_NTFS_3G]
364                 = T("NTFS-3g encountered an error (check errno)"),
365         [WIMLIB_ERR_OPEN]
366                 = T("Failed to open a file"),
367         [WIMLIB_ERR_OPENDIR]
368                 = T("Failed to open a directory"),
369         [WIMLIB_ERR_PATH_DOES_NOT_EXIST]
370                 = T("The path does not exist in the WIM image"),
371         [WIMLIB_ERR_READ]
372                 = T("Could not read data from a file"),
373         [WIMLIB_ERR_READLINK]
374                 = T("Could not read the target of a symbolic link"),
375         [WIMLIB_ERR_RENAME]
376                 = T("Could not rename a file"),
377         [WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED]
378                 = T("Unable to complete reparse point fixup"),
379         [WIMLIB_ERR_RESOURCE_NOT_FOUND]
380                 = T("A file resource needed to complete the operation was missing from the WIM"),
381         [WIMLIB_ERR_RESOURCE_ORDER]
382                 = T("The components of the WIM were arranged in an unexpected order"),
383         [WIMLIB_ERR_SET_ATTRIBUTES]
384                 = T("Failed to set attributes on extracted file"),
385         [WIMLIB_ERR_SET_REPARSE_DATA]
386                 = T("Failed to set reparse data on extracted file"),
387         [WIMLIB_ERR_SET_SECURITY]
388                 = T("Failed to set file owner, group, or other permissions on extracted file"),
389         [WIMLIB_ERR_SET_SHORT_NAME]
390                 = T("Failed to set short name on extracted file"),
391         [WIMLIB_ERR_SET_TIMESTAMPS]
392                 = T("Failed to set timestamps on extracted file"),
393         [WIMLIB_ERR_SPECIAL_FILE]
394                 = T("Encountered a special file that cannot be archived"),
395         [WIMLIB_ERR_SPLIT_INVALID]
396                 = T("The WIM is part of an invalid split WIM"),
397         [WIMLIB_ERR_SPLIT_UNSUPPORTED]
398                 = T("The WIM is part of a split WIM, which is not supported for this operation"),
399         [WIMLIB_ERR_STAT]
400                 = T("Could not read the metadata for a file or directory"),
401         [WIMLIB_ERR_TIMEOUT]
402                 = T("Timed out while waiting for a message to arrive from another process"),
403         [WIMLIB_ERR_UNEXPECTED_END_OF_FILE]
404                 = T("Unexpectedly reached the end of the file"),
405         [WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE]
406                 = T("A Unicode string could not be represented in the current locale's encoding"),
407         [WIMLIB_ERR_UNKNOWN_VERSION]
408                 = T("The WIM file is marked with an unknown version number"),
409         [WIMLIB_ERR_UNSUPPORTED]
410                 = T("The requested operation is unsupported"),
411         [WIMLIB_ERR_VOLUME_LACKS_FEATURES]
412                 = T("The volume did not support a feature necessary to complete the operation"),
413         [WIMLIB_ERR_WIM_IS_READONLY]
414                 = T("The WIM is read-only (file permissions, header flag, or split WIM)"),
415         [WIMLIB_ERR_WRITE]
416                 = T("Failed to write data to a file"),
417         [WIMLIB_ERR_XML]
418                 = T("The XML data of the WIM is invalid"),
419 };
420
421 /* API function documented in wimlib.h  */
422 WIMLIBAPI const tchar *
423 wimlib_get_error_string(enum wimlib_error_code code)
424 {
425         if ((int)code < 0 || code >= ARRAY_LEN(error_strings))
426                 return NULL;
427         else
428                 return error_strings[code];
429 }
430
431
432
433 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
434 static void *(*wimlib_malloc_func) (size_t)          = malloc;
435 static void  (*wimlib_free_func)   (void *)          = free;
436 static void *(*wimlib_realloc_func)(void *, size_t) = realloc;
437
438 void *
439 wimlib_malloc(size_t size)
440 {
441         if (size == 0)
442                 size = 1;
443         void *ptr = (*wimlib_malloc_func)(size);
444         if (ptr == NULL)
445                 ERROR("memory exhausted");
446         return ptr;
447 }
448
449 void
450 wimlib_free_memory(void *ptr)
451 {
452         (*wimlib_free_func)(ptr);
453 }
454
455 void *
456 wimlib_realloc(void *ptr, size_t size)
457 {
458         if (size == 0)
459                 size = 1;
460         ptr = (*wimlib_realloc_func)(ptr, size);
461         if (ptr == NULL)
462                 ERROR("memory exhausted");
463         return ptr;
464 }
465
466 void *
467 wimlib_calloc(size_t nmemb, size_t size)
468 {
469         size_t total_size = nmemb * size;
470         void *p = MALLOC(total_size);
471         if (p)
472                 p = memset(p, 0, total_size);
473         return p;
474 }
475
476 char *
477 wimlib_strdup(const char *str)
478 {
479         size_t size;
480         char *p;
481
482         size = strlen(str);
483         p = MALLOC(size + 1);
484         if (p)
485                 p = memcpy(p, str, size + 1);
486         return p;
487 }
488
489 #ifdef __WIN32__
490 wchar_t *
491 wimlib_wcsdup(const wchar_t *str)
492 {
493         size_t size;
494         wchar_t *p;
495
496         size = wcslen(str);
497         p = MALLOC((size + 1) * sizeof(wchar_t));
498         if (p)
499                 p = wmemcpy(p, str, size + 1);
500         return p;
501 }
502 #endif
503
504 #endif /* ENABLE_CUSTOM_MEMORY_ALLOCATOR */
505
506 void *
507 memdup(const void *mem, size_t size)
508 {
509         void *ptr = MALLOC(size);
510         if (ptr)
511                 ptr = memcpy(ptr, mem, size);
512         return ptr;
513 }
514
515 /* API function documented in wimlib.h  */
516 WIMLIBAPI int
517 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
518                             void (*free_func)(void *),
519                             void *(*realloc_func)(void *, size_t))
520 {
521 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
522         wimlib_malloc_func  = malloc_func  ? malloc_func  : malloc;
523         wimlib_free_func    = free_func    ? free_func    : free;
524         wimlib_realloc_func = realloc_func ? realloc_func : realloc;
525
526         xml_set_memory_allocator(wimlib_malloc_func, wimlib_free_func,
527                                  wimlib_realloc_func);
528         return 0;
529 #else
530         ERROR("Cannot set custom memory allocator functions:");
531         ERROR("wimlib was compiled with the --without-custom-memory-allocator "
532               "flag");
533         return WIMLIB_ERR_UNSUPPORTED;
534 #endif
535 }
536
537 static bool seeded = false;
538
539 static void
540 seed_random(void)
541 {
542         srand(time(NULL) * getpid());
543         seeded = true;
544 }
545
546 /* Fills @n characters pointed to by @p with random alphanumeric characters. */
547 void
548 randomize_char_array_with_alnum(tchar p[], size_t n)
549 {
550         if (!seeded)
551                 seed_random();
552         while (n--) {
553                 int r = rand() % 62;
554                 if (r < 26)
555                         *p++ = r + 'a';
556                 else if (r < 52)
557                         *p++ = r - 26 + 'A';
558                 else
559                         *p++ = r - 52 + '0';
560         }
561 }
562
563 /* Fills @n bytes pointer to by @p with random numbers. */
564 void
565 randomize_byte_array(u8 *p, size_t n)
566 {
567         if (!seeded)
568                 seed_random();
569         while (n--)
570                 *p++ = rand();
571 }
572
573
574 void print_byte_field(const u8 field[], size_t len, FILE *out)
575 {
576         while (len--)
577                 tfprintf(out, T("%02hhx"), *field++);
578 }