/*
* Copyright (C) 2012, 2013 Eric Biggers
*
- * This file is part of wimlib, a library for working with WIM files.
+ * This file is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License as published by the Free
+ * Software Foundation; either version 3 of the License, or (at your option) any
+ * later version.
*
- * wimlib is free software; you can redistribute it and/or modify it under the
- * terms of the GNU General Public License as published by the Free
- * Software Foundation; either version 3 of the License, or (at your option)
- * any later version.
- *
- * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * This file is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*
- * You should have received a copy of the GNU General Public License
- * along with wimlib; if not, see http://www.gnu.org/licenses/.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this file; if not, see http://www.gnu.org/licenses/.
*/
#ifdef HAVE_CONFIG_H
#endif
#include "wimlib.h"
+#include "wimlib/assert.h"
#include "wimlib/compiler.h"
#include "wimlib/encoding.h"
#include "wimlib/error.h"
#include <time.h>
#include <unistd.h>
-static size_t
+size_t
utf16le_strlen(const utf16lechar *s)
{
const utf16lechar *p = s;
return (p - s) * sizeof(utf16lechar);
}
-#ifdef __WIN32__
-# define wimlib_vfprintf vfwprintf
-#else
-/* Handle %W for UTF16-LE printing.
- *
- * TODO: this is not yet done properly--- it's assumed that if the format string
- * contains %W, then it contains no other format specifiers.
- */
-static int
-wimlib_vfprintf(FILE *fp, const tchar *format, va_list va)
-{
- const tchar *p;
- int n;
-
- for (p = format; *p; p++)
- if (*p == T('%') && *(p + 1) == T('W'))
- goto special;
- return tvfprintf(fp, format, va);
-special:
- n = 0;
- for (p = format; *p; p++) {
- if (*p == T('%') && (*(p + 1) == T('W'))) {
- int ret;
- tchar *tstr;
- size_t tstr_nbytes;
- utf16lechar *ucs = va_arg(va, utf16lechar*);
-
- if (ucs) {
- size_t ucs_nbytes = utf16le_strlen(ucs);
-
- ret = utf16le_to_tstr(ucs, ucs_nbytes,
- &tstr, &tstr_nbytes);
- if (ret) {
- ret = tfprintf(fp, T("??????"));
- } else {
- ret = tfprintf(fp, T("%"TS), tstr);
- FREE(tstr);
- }
- if (ret < 0)
- return -1;
- else
- n += ret;
- } else {
- n += tfprintf(fp, T("(null)"));
- }
- p++;
- } else {
- if (tputc(*p, fp) == EOF)
- return -1;
- n++;
- }
- }
- return n;
-}
-
-int
-wimlib_printf(const tchar *format, ...)
-{
- int ret;
- va_list va;
-
- va_start(va, format);
- ret = wimlib_vfprintf(stdout, format, va);
- va_end(va);
- return ret;
-}
-
-int
-wimlib_fprintf(FILE *fp, const tchar *format, ...)
-{
- int ret;
- va_list va;
-
- va_start(va, format);
- ret = wimlib_vfprintf(fp, format, va);
- va_end(va);
- return ret;
-}
-
-#endif /* __WIN32__ */
-
#ifdef ENABLE_ERROR_MESSAGES
bool wimlib_print_errors = false;
+FILE *wimlib_error_file = NULL; /* Set in wimlib_global_init() */
+static bool wimlib_owns_error_file = false;
#endif
#if defined(ENABLE_ERROR_MESSAGES) || defined(ENABLE_DEBUG)
{
int errno_save = errno;
fflush(stdout);
- tfputs(tag, stderr);
- wimlib_vfprintf(stderr, format, va);
+ tfputs(tag, wimlib_error_file);
+ tvfprintf(wimlib_error_file, format, va);
if (perror && errno_save != 0) {
- tchar buf[50];
+ tchar buf[64];
int res;
- res = tstrerror_r(errno_save, buf, sizeof(buf));
+ res = tstrerror_r(errno_save, buf, ARRAY_LEN(buf));
if (res) {
tsprintf(buf,
T("unknown error (errno=%d)"),
if (errno_save == EBUSY)
tstrcpy(buf, T("Resource busy"));
#endif
- tfprintf(stderr, T(": %"TS), buf);
+ tfprintf(wimlib_error_file, T(": %"TS), buf);
}
- tputc(T('\n'), stderr);
- fflush(stderr);
+ tputc(T('\n'), wimlib_error_file);
+ fflush(wimlib_error_file);
errno = errno_save;
}
}
#endif
}
+WIMLIBAPI int
+wimlib_set_error_file(FILE *fp)
+{
+#ifdef ENABLE_ERROR_MESSAGES
+ if (wimlib_owns_error_file)
+ fclose(wimlib_error_file);
+ wimlib_error_file = fp;
+ wimlib_print_errors = (fp != NULL);
+ wimlib_owns_error_file = false;
+ return 0;
+#else
+ return WIMLIB_ERR_UNSUPPORTED;
+#endif
+}
+
+WIMLIBAPI int
+wimlib_set_error_file_by_name(const tchar *path)
+{
+#ifdef ENABLE_ERROR_MESSAGES
+ FILE *fp;
+
+#ifdef __WIN32__
+ fp = win32_open_logfile(path);
+#else
+ fp = fopen(path, "a");
+#endif
+ if (!fp)
+ return WIMLIB_ERR_OPEN;
+ wimlib_set_error_file(fp);
+ wimlib_owns_error_file = true;
+ return 0;
+#else
+ return WIMLIB_ERR_UNSUPPORTED;
+#endif
+}
+
static const tchar *error_strings[] = {
[WIMLIB_ERR_SUCCESS]
= T("Success"),
= T("The WIM is already locked for writing"),
[WIMLIB_ERR_DECOMPRESSION]
= T("Failed to decompress compressed data"),
- [WIMLIB_ERR_DELETE_STAGING_DIR]
- = T("Failed to delete staging directory"),
- [WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED]
- = T("The process servicing the mounted WIM has crashed"),
- [WIMLIB_ERR_FORK]
- = T("Failed to fork another process"),
[WIMLIB_ERR_FUSE]
= T("An error was returned by fuse_main()"),
- [WIMLIB_ERR_FUSERMOUNT]
- = T("Could not execute the `fusermount' program, or it exited "
- "with a failure status"),
[WIMLIB_ERR_GLOB_HAD_NO_MATCHES]
= T("The provided file glob did not match any files"),
[WIMLIB_ERR_ICONV_NOT_AVAILABLE]
[WIMLIB_ERR_INSUFFICIENT_PRIVILEGES]
= T("The user does not have sufficient privileges"),
[WIMLIB_ERR_INTEGRITY]
- = T("The WIM failed an integrity check"),
+ = T("The WIM file is corrupted (failed integrity check)"),
[WIMLIB_ERR_INVALID_CAPTURE_CONFIG]
= T("The capture configuration string was invalid"),
[WIMLIB_ERR_INVALID_CHUNK_SIZE]
- = T("The WIM chunk size was invalid"),
+ = T("The compression chunk size was unrecognized"),
[WIMLIB_ERR_INVALID_COMPRESSION_TYPE]
- = T("The WIM is compressed, but is not marked as having LZX or "
- "XPRESS compression"),
+ = T("The compression type was unrecognized"),
[WIMLIB_ERR_INVALID_HEADER]
= T("The WIM header was invalid"),
[WIMLIB_ERR_INVALID_IMAGE]
= T("The WIM's integrity table is invalid"),
[WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY]
= T("An entry in the WIM's lookup table is invalid"),
+ [WIMLIB_ERR_INVALID_METADATA_RESOURCE]
+ = T("The metadata resource is invalid"),
[WIMLIB_ERR_INVALID_MULTIBYTE_STRING]
= T("A string was not valid in the current locale's character encoding"),
[WIMLIB_ERR_INVALID_OVERLAY]
= T("The reparse data of a reparse point was invalid"),
[WIMLIB_ERR_INVALID_RESOURCE_HASH]
= T("The SHA1 message digest of a WIM resource did not match the expected value"),
- [WIMLIB_ERR_INVALID_METADATA_RESOURCE]
- = T("The metadata resource is invalid"),
- [WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE]
- = T("The version of wimlib that has mounted a WIM image is incompatible with the "
- "version being used to unmount it"),
[WIMLIB_ERR_INVALID_UTF8_STRING]
= T("A string provided as input by the user was not a valid UTF-8 string"),
[WIMLIB_ERR_INVALID_UTF16_STRING]
= T("Expected a directory"),
[WIMLIB_ERR_NOTEMPTY]
= T("Directory was not empty"),
- [WIMLIB_ERR_NOT_A_WIM_FILE]
- = T("The file did not begin with the magic characters that "
- "identify a WIM file"),
[WIMLIB_ERR_NOT_A_REGULAR_FILE]
= T("One of the specified paths to extract did not "
"correspond to a regular file"),
+ [WIMLIB_ERR_NOT_A_WIM_FILE]
+ = T("The file did not begin with the magic characters that "
+ "identify a WIM file"),
[WIMLIB_ERR_NO_FILENAME]
= T("The WIM is not identified with a filename"),
[WIMLIB_ERR_NOT_PIPABLE]
= T("The WIM is part of an invalid split WIM"),
[WIMLIB_ERR_STAT]
= T("Could not read the metadata for a file or directory"),
- [WIMLIB_ERR_TIMEOUT]
- = T("Timed out while waiting for a message to arrive from another process"),
[WIMLIB_ERR_UNEXPECTED_END_OF_FILE]
= T("Unexpectedly reached the end of the file"),
[WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE]
= T("The requested operation is unsupported"),
[WIMLIB_ERR_UNSUPPORTED_FILE]
= T("A file in the directory tree to archive was not of a supported type"),
- [WIMLIB_ERR_VOLUME_LACKS_FEATURES]
- = T("The volume did not support a feature necessary to complete the operation"),
[WIMLIB_ERR_WIM_IS_READONLY]
= T("The WIM is read-only (file permissions, header flag, or split WIM)"),
[WIMLIB_ERR_WRITE]
= T("Failed to write data to a file"),
[WIMLIB_ERR_XML]
= T("The XML data of the WIM is invalid"),
+ [WIMLIB_ERR_WIM_IS_ENCRYPTED]
+ = T("The WIM file (or parts of it) is encrypted"),
+ [WIMLIB_ERR_WIMBOOT]
+ = T("Failed to set WIMBoot pointer data"),
+ [WIMLIB_ERR_ABORTED_BY_PROGRESS]
+ = T("The operation was aborted by the library user"),
+ [WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS]
+ = T("The user-provided progress function returned an unrecognized value"),
+ [WIMLIB_ERR_MKNOD]
+ = T("Unable to create a special file (e.g. device node or socket)"),
+ [WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY]
+ = T("There are still files open on the mounted WIM image"),
+ [WIMLIB_ERR_NOT_A_MOUNTPOINT]
+ = T("There is not a WIM image mounted on the directory"),
+ [WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT]
+ = T("The current user does not have permission to unmount the WIM image"),
+ [WIMLIB_ERR_FVE_LOCKED_VOLUME]
+ = T("The volume must be unlocked before it can be used"),
};
/* API function documented in wimlib.h */
WIMLIBAPI const tchar *
-wimlib_get_error_string(enum wimlib_error_code code)
+wimlib_get_error_string(enum wimlib_error_code _code)
{
- if ((int)code < 0 || code >= ARRAY_LEN(error_strings))
- return NULL;
- else
- return error_strings[code];
+ unsigned int code = (unsigned int)_code;
+
+ if (code >= ARRAY_LEN(error_strings) || error_strings[code] == NULL)
+ return T("Unknown error");
+
+ return error_strings[code];
}
-#ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
-static void *(*wimlib_malloc_func) (size_t) = malloc;
-static void (*wimlib_free_func) (void *) = free;
+static void *(*wimlib_malloc_func) (size_t) = malloc;
+static void (*wimlib_free_func) (void *) = free;
static void *(*wimlib_realloc_func)(void *, size_t) = realloc;
void *
wimlib_malloc(size_t size)
{
- if (size == 0)
- size = 1;
- void *ptr = (*wimlib_malloc_func)(size);
- if (ptr == NULL)
- ERROR("memory exhausted");
+ void *ptr;
+
+retry:
+ ptr = (*wimlib_malloc_func)(size);
+ if (unlikely(!ptr)) {
+ if (!size) {
+ size++;
+ goto retry;
+ }
+ }
return ptr;
}
{
if (size == 0)
size = 1;
- ptr = (*wimlib_realloc_func)(ptr, size);
- if (ptr == NULL)
- ERROR("memory exhausted");
- return ptr;
+ return (*wimlib_realloc_func)(ptr, size);
}
void *
}
#endif
-#endif /* ENABLE_CUSTOM_MEMORY_ALLOCATOR */
+void *
+wimlib_aligned_malloc(size_t size, size_t alignment)
+{
+ u8 *raw_ptr;
+ u8 *ptr;
+ uintptr_t mask;
+
+ wimlib_assert(alignment != 0 && is_power_of_2(alignment) &&
+ alignment <= 4096);
+ mask = alignment - 1;
+
+ raw_ptr = MALLOC(size + alignment - 1 + sizeof(size_t));
+ if (!raw_ptr)
+ return NULL;
+
+ ptr = (u8 *)raw_ptr + sizeof(size_t);
+ while ((uintptr_t)ptr & mask)
+ ptr++;
+ *((size_t *)ptr - 1) = (ptr - raw_ptr);
+
+ return ptr;
+}
+
+void
+wimlib_aligned_free(void *ptr)
+{
+ if (ptr)
+ FREE((u8 *)ptr - *((size_t *)ptr - 1));
+}
void *
memdup(const void *mem, size_t size)
void (*free_func)(void *),
void *(*realloc_func)(void *, size_t))
{
-#ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
wimlib_malloc_func = malloc_func ? malloc_func : malloc;
wimlib_free_func = free_func ? free_func : free;
wimlib_realloc_func = realloc_func ? realloc_func : realloc;
xml_set_memory_allocator(wimlib_malloc_func, wimlib_free_func,
wimlib_realloc_func);
return 0;
-#else
- ERROR("Cannot set custom memory allocator functions:");
- ERROR("wimlib was compiled with the --without-custom-memory-allocator "
- "flag");
- return WIMLIB_ERR_UNSUPPORTED;
-#endif
}
static bool seeded = false;