X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Futil.c;h=3053fd9e6d2bccbd76e1b15459ee30c0fd33ddf3;hp=709ba46537d766894607a61cfbaadf5e95e44119;hb=ccdd5a74123ebf14353a9569bf014fb2e7774d1e;hpb=161e7cdd2c0d3b3c1025da452a3192d381297465 diff --git a/src/util.c b/src/util.c index 709ba465..3053fd9e 100644 --- a/src/util.c +++ b/src/util.c @@ -21,36 +21,39 @@ * along with wimlib; if not, see http://www.gnu.org/licenses/. */ -#include "config.h" - +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif -#undef _GNU_SOURCE +#ifdef _GNU_SOURCE +# define _GNU_SOURCE_DEFINED 1 +# undef _GNU_SOURCE +#endif /* Make sure the POSIX-compatible strerror_r() is declared, rather than the GNU * version, which has a different return type. */ #include +#ifdef _GNU_SOURCE_DEFINED +# define _GNU_SOURCE +#endif -#define _GNU_SOURCE +#include "wimlib.h" +#include "wimlib/compiler.h" +#include "wimlib/encoding.h" +#include "wimlib/error.h" +#include "wimlib/types.h" +#include "wimlib/util.h" +#include "wimlib/xml.h" -#include "endianness.h" -#include "timestamp.h" -#include "wimlib_internal.h" +#ifdef __WIN32__ +# include "wimlib/win32.h" /* win32_strerror_r_replacement */ +#endif -#include #include #include #include +#include #include - -#ifdef __WIN32__ -# include "win32.h" -# define pread win32_pread -# define pwrite win32_pwrite -# define writev win32_writev -#else -# include /* for writev() and `struct iovec' */ -#endif - static size_t utf16le_strlen(const utf16lechar *s) { @@ -138,6 +141,11 @@ wimlib_fprintf(FILE *fp, const tchar *format, ...) va_end(va); return ret; } + +#endif /* __WIN32__ */ + +#ifdef ENABLE_ERROR_MESSAGES +bool wimlib_print_errors = false; #endif #if defined(ENABLE_ERROR_MESSAGES) || defined(ENABLE_DEBUG) @@ -145,39 +153,39 @@ static void wimlib_vmsg(const tchar *tag, const tchar *format, va_list va, bool perror) { -#ifndef DEBUG - if (wimlib_print_errors) { +#if !defined(ENABLE_DEBUG) + if (wimlib_print_errors) #endif + { int errno_save = errno; fflush(stdout); tfputs(tag, stderr); wimlib_vfprintf(stderr, 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)"), errno_save); } + #ifdef WIN32 + if (errno_save == EBUSY) + tstrcpy(buf, T("Resource busy")); + #endif tfprintf(stderr, T(": %"TS), buf); } tputc(T('\n'), stderr); fflush(stderr); errno = errno_save; -#ifndef DEBUG } -#endif } #endif /* True if wimlib is to print an informational message when an error occurs. * This can be turned off by calling wimlib_set_print_errors(false). */ #ifdef ENABLE_ERROR_MESSAGES -static bool wimlib_print_errors = false; - - void wimlib_error(const tchar *format, ...) { @@ -227,6 +235,15 @@ void wimlib_debug(const tchar *file, int line, const char *func, va_list va; tchar buf[tstrlen(file) + strlen(func) + 30]; + static bool debug_enabled = false; + if (!debug_enabled) { + char *value = getenv("WIMLIB_DEBUG"); + if (!value || strcmp(value, "0")) + debug_enabled = true; + else + return; + } + tsprintf(buf, T("[%"TS" %d] %s(): "), file, line, func); va_start(va, format); @@ -235,6 +252,7 @@ void wimlib_debug(const tchar *file, int line, const char *func, } #endif +/* API function documented in wimlib.h */ WIMLIBAPI int wimlib_set_print_errors(bool show_error_messages) { @@ -254,8 +272,6 @@ static const tchar *error_strings[] = { = T("Success"), [WIMLIB_ERR_ALREADY_LOCKED] = T("The WIM is already locked for writing"), - [WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE] - = T("Lookup table is compressed"), [WIMLIB_ERR_DECOMPRESSION] = T("Failed to decompress compressed data"), [WIMLIB_ERR_DELETE_STAGING_DIR] @@ -269,30 +285,28 @@ static const tchar *error_strings[] = { [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] = T("The iconv() function does not seem to work. " "Maybe check to make sure the directory /usr/lib/gconv exists"), [WIMLIB_ERR_IMAGE_COUNT] = T("Inconsistent image count among the metadata " "resources, the WIM header, and/or the XML data"), - [WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT] - = T("User does not have sufficient privileges to correctly extract the data"), [WIMLIB_ERR_IMAGE_NAME_COLLISION] = T("Tried to add an image with a name that is already in use"), + [WIMLIB_ERR_INSUFFICIENT_PRIVILEGES] + = T("The user does not have sufficient privileges"), [WIMLIB_ERR_INTEGRITY] = T("The WIM failed an integrity check"), [WIMLIB_ERR_INVALID_CAPTURE_CONFIG] = T("The capture configuration string was invalid"), [WIMLIB_ERR_INVALID_CHUNK_SIZE] - = T("The WIM is compressed but does not have a chunk " - "size of 32768"), + = T("The WIM chunk size was invalid"), [WIMLIB_ERR_INVALID_COMPRESSION_TYPE] - = T("The WIM is compressed, but is not marked as having LZX or " - "XPRESS compression"), - [WIMLIB_ERR_INVALID_DENTRY] - = T("A directory entry in the WIM was invalid"), - [WIMLIB_ERR_INVALID_HEADER_SIZE] - = T("The WIM header was not 208 bytes"), + = T("The WIM compression type was invalid"), + [WIMLIB_ERR_INVALID_HEADER] + = T("The WIM header was invalid"), [WIMLIB_ERR_INVALID_IMAGE] = T("Tried to select an image that does not exist in the WIM"), [WIMLIB_ERR_INVALID_INTEGRITY_TABLE] @@ -307,14 +321,14 @@ static const tchar *error_strings[] = { = T("An invalid parameter was given"), [WIMLIB_ERR_INVALID_PART_NUMBER] = T("The part number or total parts of the WIM is invalid"), + [WIMLIB_ERR_INVALID_PIPABLE_WIM] + = T("The pipable WIM is invalid"), [WIMLIB_ERR_INVALID_REPARSE_DATA] = 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_RESOURCE_SIZE] - = T("A resource entry in the WIM has an invalid size"), - [WIMLIB_ERR_INVALID_SECURITY_DATA] - = T("The table of security descriptors in the WIM is invalid"), + [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"), @@ -322,12 +336,18 @@ static const tchar *error_strings[] = { = T("A string provided as input by the user was not a valid UTF-8 string"), [WIMLIB_ERR_INVALID_UTF16_STRING] = T("A string in a WIM dentry is not a valid UTF-16LE string"), + [WIMLIB_ERR_IS_DIRECTORY] + = T("One of the specified paths to delete was a directory"), + [WIMLIB_ERR_IS_SPLIT_WIM] + = T("The WIM is part of a split WIM, which is not supported for this operation"), [WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE] = T("libxml2 was unable to find a character encoding conversion handler " "for UTF-16LE"), [WIMLIB_ERR_LINK] = T("Failed to create a hard or symbolic link when extracting " "a file from the WIM"), + [WIMLIB_ERR_METADATA_NOT_FOUND] + = T("A required metadata resource could not be located"), [WIMLIB_ERR_MKDIR] = T("Failed to create a directory"), [WIMLIB_ERR_MQUEUE] @@ -336,17 +356,27 @@ static const tchar *error_strings[] = { = T("Ran out of memory"), [WIMLIB_ERR_NOTDIR] = 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_NO_FILENAME] = T("The WIM is not identified with a filename"), + [WIMLIB_ERR_NOT_PIPABLE] + = T("The WIM was not captured such that it can be " + "applied from a pipe"), [WIMLIB_ERR_NTFS_3G] = T("NTFS-3g encountered an error (check errno)"), [WIMLIB_ERR_OPEN] = T("Failed to open a file"), [WIMLIB_ERR_OPENDIR] = T("Failed to open a directory"), + [WIMLIB_ERR_PATH_DOES_NOT_EXIST] + = T("The path does not exist in the WIM image"), [WIMLIB_ERR_READ] = T("Could not read data from a file"), [WIMLIB_ERR_READLINK] @@ -355,36 +385,55 @@ static const tchar *error_strings[] = { = T("Could not rename a file"), [WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED] = T("Unable to complete reparse point fixup"), + [WIMLIB_ERR_RESOURCE_NOT_FOUND] + = T("A file resource needed to complete the operation was missing from the WIM"), [WIMLIB_ERR_RESOURCE_ORDER] = T("The components of the WIM were arranged in an unexpected order"), - [WIMLIB_ERR_SPECIAL_FILE] - = T("Encountered a special file that cannot be archived"), + [WIMLIB_ERR_SET_ATTRIBUTES] + = T("Failed to set attributes on extracted file"), + [WIMLIB_ERR_SET_REPARSE_DATA] + = T("Failed to set reparse data on extracted file"), + [WIMLIB_ERR_SET_SECURITY] + = T("Failed to set file owner, group, or other permissions on extracted file"), + [WIMLIB_ERR_SET_SHORT_NAME] + = T("Failed to set short name on extracted file"), + [WIMLIB_ERR_SET_TIMESTAMPS] + = T("Failed to set timestamps on extracted file"), [WIMLIB_ERR_SPLIT_INVALID] = T("The WIM is part of an invalid split WIM"), - [WIMLIB_ERR_SPLIT_UNSUPPORTED] - = T("The WIM is part of a split WIM, which is not supported for this operation"), [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("A Unicode string could not be represented in the current locale's encoding"), [WIMLIB_ERR_UNKNOWN_VERSION] = T("The WIM file is marked with an unknown version number"), [WIMLIB_ERR_UNSUPPORTED] = 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"), }; +/* API function documented in wimlib.h */ WIMLIBAPI const tchar * wimlib_get_error_string(enum wimlib_error_code code) { - if (code < 0 || code >= ARRAY_LEN(error_strings)) + if ((int)code < 0 || code >= ARRAY_LEN(error_strings)) return NULL; else return error_strings[code]; @@ -392,10 +441,37 @@ wimlib_get_error_string(enum wimlib_error_code code) -#ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR -void *(*wimlib_malloc_func) (size_t) = malloc; -void (*wimlib_free_func) (void *) = free; -void *(*wimlib_realloc_func)(void *, size_t) = realloc; +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"); + return ptr; +} + +void +wimlib_free_memory(void *ptr) +{ + (*wimlib_free_func)(ptr); +} + +void * +wimlib_realloc(void *ptr, size_t size) +{ + if (size == 0) + size = 1; + ptr = (*wimlib_realloc_func)(ptr, size); + if (ptr == NULL) + ERROR("memory exhausted"); + return ptr; +} void * wimlib_calloc(size_t nmemb, size_t size) @@ -403,7 +479,7 @@ wimlib_calloc(size_t nmemb, size_t size) size_t total_size = nmemb * size; void *p = MALLOC(total_size); if (p) - memset(p, 0, total_size); + p = memset(p, 0, total_size); return p; } @@ -416,7 +492,7 @@ wimlib_strdup(const char *str) size = strlen(str); p = MALLOC(size + 1); if (p) - memcpy(p, str, size + 1); + p = memcpy(p, str, size + 1); return p; } @@ -430,23 +506,26 @@ wimlib_wcsdup(const wchar_t *str) size = wcslen(str); p = MALLOC((size + 1) * sizeof(wchar_t)); if (p) - memcpy(p, str, (size + 1) * sizeof(wchar_t)); + p = wmemcpy(p, str, size + 1); return p; } #endif -extern void -xml_set_memory_allocator(void *(*malloc_func)(size_t), - void (*free_func)(void *), - void *(*realloc_func)(void *, size_t)); -#endif +void * +memdup(const void *mem, size_t size) +{ + void *ptr = MALLOC(size); + if (ptr) + ptr = memcpy(ptr, mem, size); + return ptr; +} +/* API function documented in wimlib.h */ WIMLIBAPI int wimlib_set_memory_allocator(void *(*malloc_func)(size_t), 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; @@ -454,18 +533,12 @@ wimlib_set_memory_allocator(void *(*malloc_func)(size_t), 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; static void -seed_random() +seed_random(void) { srand(time(NULL) * getpid()); seeded = true; @@ -498,205 +571,16 @@ randomize_byte_array(u8 *p, size_t n) *p++ = rand(); } -const tchar * -path_basename_with_len(const tchar *path, size_t len) -{ - const tchar *p = &path[len] - 1; - - /* Trailing slashes. */ - while (1) { - if (p == path - 1) - return T(""); - if (*p != T('/')) - break; - p--; - } - - while ((p != path - 1) && *p != T('/')) - p--; - - return p + 1; -} -/* Like the basename() function, but does not modify @path; it just returns a - * pointer to it. */ -const tchar * -path_basename(const tchar *path) +void print_byte_field(const u8 field[], size_t len, FILE *out) { - return path_basename_with_len(path, tstrlen(path)); + while (len--) + tfprintf(out, T("%02hhx"), *field++); } -/* - * Returns a pointer to the part of @path following the first colon in the last - * path component, or NULL if the last path component does not contain a colon. - */ -const tchar * -path_stream_name(const tchar *path) +#ifndef HAVE_MEMPCPY +void *mempcpy(void *dst, const void *src, size_t n) { - const tchar *base = path_basename(path); - const tchar *stream_name = tstrchr(base, T(':')); - if (!stream_name) - return NULL; - else - return stream_name + 1; -} - -u64 -get_wim_timestamp() -{ - struct timeval tv; - gettimeofday(&tv, NULL); - return timeval_to_wim_timestamp(tv); -} - -void -wim_timestamp_to_str(u64 timestamp, tchar *buf, size_t len) -{ - struct tm tm; - time_t t = wim_timestamp_to_unix(timestamp); - gmtime_r(&t, &tm); - tstrftime(buf, len, T("%a %b %d %H:%M:%S %Y UTC"), &tm); -} - -void -zap_backslashes(tchar *s) -{ - if (s) { - while (*s != T('\0')) { - if (*s == T('\\')) - *s = T('/'); - s++; - } - } -} - -/* Like read(), but keep trying until everything has been written or we know for - * sure that there was an error (or end-of-file). */ -size_t -full_read(int fd, void *buf, size_t count) -{ - ssize_t bytes_read; - size_t bytes_remaining; - - for (bytes_remaining = count; - bytes_remaining != 0; - bytes_remaining -= bytes_read, buf += bytes_read) - { - bytes_read = read(fd, buf, bytes_remaining); - if (bytes_read <= 0) { - if (bytes_read == 0) - errno = EIO; - else if (errno == EINTR) - continue; - break; - } - } - return count - bytes_remaining; -} - -/* Like write(), but keep trying until everything has been written or we know - * for sure that there was an error. */ -size_t -full_write(int fd, const void *buf, size_t count) -{ - ssize_t bytes_written; - size_t bytes_remaining; - - for (bytes_remaining = count; - bytes_remaining != 0; - bytes_remaining -= bytes_written, buf += bytes_written) - { - bytes_written = write(fd, buf, bytes_remaining); - if (bytes_written < 0) { - if (errno == EINTR) - continue; - break; - } - } - return count - bytes_remaining; -} - -/* Like pread(), but keep trying until everything has been read or we know for - * sure that there was an error (or end-of-file) */ -size_t -full_pread(int fd, void *buf, size_t count, off_t offset) -{ - ssize_t bytes_read; - size_t bytes_remaining; - - for (bytes_remaining = count; - bytes_remaining != 0; - bytes_remaining -= bytes_read, buf += bytes_read, - offset += bytes_read) - { - bytes_read = pread(fd, buf, bytes_remaining, offset); - if (bytes_read <= 0) { - if (bytes_read == 0) - errno = EIO; - else if (errno == EINTR) - continue; - break; - } - } - return count - bytes_remaining; -} - -/* Like pwrite(), but keep trying until everything has been written or we know - * for sure that there was an error. */ -size_t -full_pwrite(int fd, const void *buf, size_t count, off_t offset) -{ - ssize_t bytes_written; - size_t bytes_remaining; - - for (bytes_remaining = count; - bytes_remaining != 0; - bytes_remaining -= bytes_written, buf += bytes_written, - offset += bytes_written) - { - bytes_written = pwrite(fd, buf, bytes_remaining, offset); - if (bytes_written < 0) { - if (errno == EINTR) - continue; - break; - } - } - return count - bytes_remaining; -} - -/* Like writev(), but keep trying until everything has been written or we know - * for sure that there was an error. */ -size_t -full_writev(int fd, struct iovec *iov, int iovcnt) -{ - size_t total_bytes_written = 0; - while (iovcnt > 0) { - ssize_t bytes_written; - - bytes_written = writev(fd, iov, iovcnt); - if (bytes_written < 0) { - if (errno == EINTR) - continue; - break; - } - total_bytes_written += bytes_written; - while (bytes_written) { - if (bytes_written >= iov[0].iov_len) { - bytes_written -= iov[0].iov_len; - iov++; - iovcnt--; - } else { - iov[0].iov_base += bytes_written; - iov[0].iov_len -= bytes_written; - bytes_written = 0; - } - } - } - return total_bytes_written; -} - -off_t -filedes_offset(filedes_t fd) -{ - return lseek(fd, 0, SEEK_CUR); + return memcpy(dst, src, n) + n; } +#endif