6cc8cf441fc0abb74d810f7eec1b384939a9f5bc
[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 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 #if !defined(ENABLE_DEBUG)
157         if (wimlib_print_errors)
158 #endif
159         {
160                 int errno_save = errno;
161                 fflush(stdout);
162                 tfputs(tag, stderr);
163                 wimlib_vfprintf(stderr, format, va);
164                 if (perror && errno_save != 0) {
165                         tchar buf[64];
166                         int res;
167                         res = tstrerror_r(errno_save, buf, ARRAY_LEN(buf));
168                         if (res) {
169                                 tsprintf(buf,
170                                          T("unknown error (errno=%d)"),
171                                          errno_save);
172                         }
173                 #ifdef WIN32
174                         if (errno_save == EBUSY)
175                                 tstrcpy(buf, T("Resource busy"));
176                 #endif
177                         tfprintf(stderr, T(": %"TS), buf);
178                 }
179                 tputc(T('\n'), stderr);
180                 fflush(stderr);
181                 errno = errno_save;
182         }
183 }
184 #endif
185
186 /* True if wimlib is to print an informational message when an error occurs.
187  * This can be turned off by calling wimlib_set_print_errors(false). */
188 #ifdef ENABLE_ERROR_MESSAGES
189 void
190 wimlib_error(const tchar *format, ...)
191 {
192         va_list va;
193
194         va_start(va, format);
195         wimlib_vmsg(T("\r[ERROR] "), format, va, false);
196         va_end(va);
197 }
198
199 void
200 wimlib_error_with_errno(const tchar *format, ...)
201 {
202         va_list va;
203
204         va_start(va, format);
205         wimlib_vmsg(T("\r[ERROR] "), format, va, true);
206         va_end(va);
207 }
208
209 void
210 wimlib_warning(const tchar *format, ...)
211 {
212         va_list va;
213
214         va_start(va, format);
215         wimlib_vmsg(T("\r[WARNING] "), format, va, false);
216         va_end(va);
217 }
218
219 void
220 wimlib_warning_with_errno(const tchar *format, ...)
221 {
222         va_list va;
223
224         va_start(va, format);
225         wimlib_vmsg(T("\r[WARNING] "), format, va, true);
226         va_end(va);
227 }
228
229 #endif
230
231 #if defined(ENABLE_DEBUG) || defined(ENABLE_MORE_DEBUG)
232 void wimlib_debug(const tchar *file, int line, const char *func,
233                   const tchar *format, ...)
234 {
235         va_list va;
236         tchar buf[tstrlen(file) + strlen(func) + 30];
237
238         static bool debug_enabled = false;
239         if (!debug_enabled) {
240                 char *value = getenv("WIMLIB_DEBUG");
241                 if (!value || strcmp(value, "0"))
242                         debug_enabled = true;
243                 else
244                         return;
245         }
246
247         tsprintf(buf, T("[%"TS" %d] %s(): "), file, line, func);
248
249         va_start(va, format);
250         wimlib_vmsg(buf, format, va, false);
251         va_end(va);
252 }
253 #endif
254
255 /* API function documented in wimlib.h  */
256 WIMLIBAPI int
257 wimlib_set_print_errors(bool show_error_messages)
258 {
259 #ifdef ENABLE_ERROR_MESSAGES
260         wimlib_print_errors = show_error_messages;
261         return 0;
262 #else
263         if (show_error_messages)
264                 return WIMLIB_ERR_UNSUPPORTED;
265         else
266                 return 0;
267 #endif
268 }
269
270 static const tchar *error_strings[] = {
271         [WIMLIB_ERR_SUCCESS]
272                 = T("Success"),
273         [WIMLIB_ERR_ALREADY_LOCKED]
274                 = T("The WIM is already locked for writing"),
275         [WIMLIB_ERR_DECOMPRESSION]
276                 = T("Failed to decompress compressed data"),
277         [WIMLIB_ERR_DELETE_STAGING_DIR]
278                 = T("Failed to delete staging directory"),
279         [WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED]
280                 = T("The process servicing the mounted WIM has crashed"),
281         [WIMLIB_ERR_FORK]
282                 = T("Failed to fork another process"),
283         [WIMLIB_ERR_FUSE]
284                 = T("An error was returned by fuse_main()"),
285         [WIMLIB_ERR_FUSERMOUNT]
286                 = T("Could not execute the `fusermount' program, or it exited "
287                         "with a failure status"),
288         [WIMLIB_ERR_GLOB_HAD_NO_MATCHES]
289                 = T("The provided file glob did not match any files"),
290         [WIMLIB_ERR_ICONV_NOT_AVAILABLE]
291                 = T("The iconv() function does not seem to work. "
292                   "Maybe check to make sure the directory /usr/lib/gconv exists"),
293         [WIMLIB_ERR_IMAGE_COUNT]
294                 = T("Inconsistent image count among the metadata "
295                         "resources, the WIM header, and/or the XML data"),
296         [WIMLIB_ERR_IMAGE_NAME_COLLISION]
297                 = T("Tried to add an image with a name that is already in use"),
298         [WIMLIB_ERR_INSUFFICIENT_PRIVILEGES]
299                 = T("The user does not have sufficient privileges"),
300         [WIMLIB_ERR_INTEGRITY]
301                 = T("The WIM failed an integrity check"),
302         [WIMLIB_ERR_INVALID_CAPTURE_CONFIG]
303                 = T("The capture configuration string was invalid"),
304         [WIMLIB_ERR_INVALID_CHUNK_SIZE]
305                 = T("The WIM chunk size was invalid"),
306         [WIMLIB_ERR_INVALID_COMPRESSION_TYPE]
307                 = T("The WIM compression type was invalid"),
308         [WIMLIB_ERR_INVALID_HEADER]
309                 = T("The WIM header was invalid"),
310         [WIMLIB_ERR_INVALID_IMAGE]
311                 = T("Tried to select an image that does not exist in the WIM"),
312         [WIMLIB_ERR_INVALID_INTEGRITY_TABLE]
313                 = T("The WIM's integrity table is invalid"),
314         [WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY]
315                 = T("An entry in the WIM's lookup table is invalid"),
316         [WIMLIB_ERR_INVALID_MULTIBYTE_STRING]
317                 = T("A string was not valid in the current locale's character encoding"),
318         [WIMLIB_ERR_INVALID_OVERLAY]
319                 = T("Conflicting files in overlay when creating a WIM image"),
320         [WIMLIB_ERR_INVALID_PARAM]
321                 = T("An invalid parameter was given"),
322         [WIMLIB_ERR_INVALID_PART_NUMBER]
323                 = T("The part number or total parts of the WIM is invalid"),
324         [WIMLIB_ERR_INVALID_PIPABLE_WIM]
325                 = T("The pipable WIM is invalid"),
326         [WIMLIB_ERR_INVALID_REPARSE_DATA]
327                 = T("The reparse data of a reparse point was invalid"),
328         [WIMLIB_ERR_INVALID_RESOURCE_HASH]
329                 = T("The SHA1 message digest of a WIM resource did not match the expected value"),
330         [WIMLIB_ERR_INVALID_METADATA_RESOURCE]
331                 = T("The metadata resource is invalid"),
332         [WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE]
333                 = T("The version of wimlib that has mounted a WIM image is incompatible with the "
334                   "version being used to unmount it"),
335         [WIMLIB_ERR_INVALID_UTF8_STRING]
336                 = T("A string provided as input by the user was not a valid UTF-8 string"),
337         [WIMLIB_ERR_INVALID_UTF16_STRING]
338                 = T("A string in a WIM dentry is not a valid UTF-16LE string"),
339         [WIMLIB_ERR_IS_DIRECTORY]
340                 = T("One of the specified paths to delete was a directory"),
341         [WIMLIB_ERR_IS_SPLIT_WIM]
342                 = T("The WIM is part of a split WIM, which is not supported for this operation"),
343         [WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE]
344                 = T("libxml2 was unable to find a character encoding conversion handler "
345                   "for UTF-16LE"),
346         [WIMLIB_ERR_LINK]
347                 = T("Failed to create a hard or symbolic link when extracting "
348                         "a file from the WIM"),
349         [WIMLIB_ERR_METADATA_NOT_FOUND]
350                 = T("A required metadata resource could not be located"),
351         [WIMLIB_ERR_MKDIR]
352                 = T("Failed to create a directory"),
353         [WIMLIB_ERR_MQUEUE]
354                 = T("Failed to create or use a POSIX message queue"),
355         [WIMLIB_ERR_NOMEM]
356                 = T("Ran out of memory"),
357         [WIMLIB_ERR_NOTDIR]
358                 = T("Expected a directory"),
359         [WIMLIB_ERR_NOTEMPTY]
360                 = T("Directory was not empty"),
361         [WIMLIB_ERR_NOT_A_WIM_FILE]
362                 = T("The file did not begin with the magic characters that "
363                         "identify a WIM file"),
364         [WIMLIB_ERR_NOT_A_REGULAR_FILE]
365                 = T("One of the specified paths to extract did not "
366                     "correspond to a regular file"),
367         [WIMLIB_ERR_NO_FILENAME]
368                 = T("The WIM is not identified with a filename"),
369         [WIMLIB_ERR_NOT_PIPABLE]
370                 = T("The WIM was not captured such that it can be "
371                     "applied from a pipe"),
372         [WIMLIB_ERR_NTFS_3G]
373                 = T("NTFS-3g encountered an error (check errno)"),
374         [WIMLIB_ERR_OPEN]
375                 = T("Failed to open a file"),
376         [WIMLIB_ERR_OPENDIR]
377                 = T("Failed to open a directory"),
378         [WIMLIB_ERR_PATH_DOES_NOT_EXIST]
379                 = T("The path does not exist in the WIM image"),
380         [WIMLIB_ERR_READ]
381                 = T("Could not read data from a file"),
382         [WIMLIB_ERR_READLINK]
383                 = T("Could not read the target of a symbolic link"),
384         [WIMLIB_ERR_RENAME]
385                 = T("Could not rename a file"),
386         [WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED]
387                 = T("Unable to complete reparse point fixup"),
388         [WIMLIB_ERR_RESOURCE_NOT_FOUND]
389                 = T("A file resource needed to complete the operation was missing from the WIM"),
390         [WIMLIB_ERR_RESOURCE_ORDER]
391                 = T("The components of the WIM were arranged in an unexpected order"),
392         [WIMLIB_ERR_SET_ATTRIBUTES]
393                 = T("Failed to set attributes on extracted file"),
394         [WIMLIB_ERR_SET_REPARSE_DATA]
395                 = T("Failed to set reparse data on extracted file"),
396         [WIMLIB_ERR_SET_SECURITY]
397                 = T("Failed to set file owner, group, or other permissions on extracted file"),
398         [WIMLIB_ERR_SET_SHORT_NAME]
399                 = T("Failed to set short name on extracted file"),
400         [WIMLIB_ERR_SET_TIMESTAMPS]
401                 = T("Failed to set timestamps on extracted file"),
402         [WIMLIB_ERR_SPLIT_INVALID]
403                 = T("The WIM is part of an invalid split WIM"),
404         [WIMLIB_ERR_STAT]
405                 = T("Could not read the metadata for a file or directory"),
406         [WIMLIB_ERR_TIMEOUT]
407                 = T("Timed out while waiting for a message to arrive from another process"),
408         [WIMLIB_ERR_UNEXPECTED_END_OF_FILE]
409                 = T("Unexpectedly reached the end of the file"),
410         [WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE]
411                 = T("A Unicode string could not be represented in the current locale's encoding"),
412         [WIMLIB_ERR_UNKNOWN_VERSION]
413                 = T("The WIM file is marked with an unknown version number"),
414         [WIMLIB_ERR_UNSUPPORTED]
415                 = T("The requested operation is unsupported"),
416         [WIMLIB_ERR_UNSUPPORTED_FILE]
417                 = T("A file in the directory tree to archive was not of a supported type"),
418         [WIMLIB_ERR_VOLUME_LACKS_FEATURES]
419                 = T("The volume did not support a feature necessary to complete the operation"),
420         [WIMLIB_ERR_WIM_IS_READONLY]
421                 = T("The WIM is read-only (file permissions, header flag, or split WIM)"),
422         [WIMLIB_ERR_WRITE]
423                 = T("Failed to write data to a file"),
424         [WIMLIB_ERR_XML]
425                 = T("The XML data of the WIM is invalid"),
426         [WIMLIB_ERR_WIM_IS_ENCRYPTED]
427                 = T("The WIM file (or parts of it) is encrypted"),
428         [WIMLIB_ERR_WIMBOOT]
429                 = T("Failed to set WIMBoot pointer data"),
430 };
431
432 /* API function documented in wimlib.h  */
433 WIMLIBAPI const tchar *
434 wimlib_get_error_string(enum wimlib_error_code code)
435 {
436         if ((int)code < 0 || code >= ARRAY_LEN(error_strings))
437                 return NULL;
438         else
439                 return error_strings[code];
440 }
441
442
443
444 static void *(*wimlib_malloc_func) (size_t)          = malloc;
445 static void  (*wimlib_free_func)   (void *)          = free;
446 static void *(*wimlib_realloc_func)(void *, size_t) = realloc;
447
448 void *
449 wimlib_malloc(size_t size)
450 {
451         void *ptr;
452
453 retry:
454         ptr = (*wimlib_malloc_func)(size);
455         if (unlikely(!ptr)) {
456                 if (!size) {
457                         size++;
458                         goto retry;
459                 }
460                 ERROR("memory exhausted");
461         }
462         return ptr;
463 }
464
465 void
466 wimlib_free_memory(void *ptr)
467 {
468         (*wimlib_free_func)(ptr);
469 }
470
471 void *
472 wimlib_realloc(void *ptr, size_t size)
473 {
474         if (size == 0)
475                 size = 1;
476         ptr = (*wimlib_realloc_func)(ptr, size);
477         if (ptr == NULL)
478                 ERROR("memory exhausted");
479         return ptr;
480 }
481
482 void *
483 wimlib_calloc(size_t nmemb, size_t size)
484 {
485         size_t total_size = nmemb * size;
486         void *p = MALLOC(total_size);
487         if (p)
488                 p = memset(p, 0, total_size);
489         return p;
490 }
491
492 char *
493 wimlib_strdup(const char *str)
494 {
495         size_t size;
496         char *p;
497
498         size = strlen(str);
499         p = MALLOC(size + 1);
500         if (p)
501                 p = memcpy(p, str, size + 1);
502         return p;
503 }
504
505 #ifdef __WIN32__
506 wchar_t *
507 wimlib_wcsdup(const wchar_t *str)
508 {
509         size_t size;
510         wchar_t *p;
511
512         size = wcslen(str);
513         p = MALLOC((size + 1) * sizeof(wchar_t));
514         if (p)
515                 p = wmemcpy(p, str, size + 1);
516         return p;
517 }
518 #endif
519
520 void *
521 memdup(const void *mem, size_t size)
522 {
523         void *ptr = MALLOC(size);
524         if (ptr)
525                 ptr = memcpy(ptr, mem, size);
526         return ptr;
527 }
528
529 /* API function documented in wimlib.h  */
530 WIMLIBAPI int
531 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
532                             void (*free_func)(void *),
533                             void *(*realloc_func)(void *, size_t))
534 {
535         wimlib_malloc_func  = malloc_func  ? malloc_func  : malloc;
536         wimlib_free_func    = free_func    ? free_func    : free;
537         wimlib_realloc_func = realloc_func ? realloc_func : realloc;
538
539         xml_set_memory_allocator(wimlib_malloc_func, wimlib_free_func,
540                                  wimlib_realloc_func);
541         return 0;
542 }
543
544 static bool seeded = false;
545
546 static void
547 seed_random(void)
548 {
549         srand(time(NULL) * getpid());
550         seeded = true;
551 }
552
553 /* Fills @n characters pointed to by @p with random alphanumeric characters. */
554 void
555 randomize_char_array_with_alnum(tchar p[], size_t n)
556 {
557         if (!seeded)
558                 seed_random();
559         while (n--) {
560                 int r = rand() % 62;
561                 if (r < 26)
562                         *p++ = r + 'a';
563                 else if (r < 52)
564                         *p++ = r - 26 + 'A';
565                 else
566                         *p++ = r - 52 + '0';
567         }
568 }
569
570 /* Fills @n bytes pointer to by @p with random numbers. */
571 void
572 randomize_byte_array(u8 *p, size_t n)
573 {
574         if (!seeded)
575                 seed_random();
576         while (n--)
577                 *p++ = rand();
578 }
579
580
581 void print_byte_field(const u8 field[], size_t len, FILE *out)
582 {
583         while (len--)
584                 tfprintf(out, T("%02hhx"), *field++);
585 }
586
587 #ifndef HAVE_MEMPCPY
588 void *mempcpy(void *dst, const void *src, size_t n)
589 {
590         return memcpy(dst, src, n) + n;
591 }
592 #endif