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