X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Futil.c;h=0fe3d4e4582026b3ea9aaae6f375fdb7f8a73578;hp=1df757fa165f1ba42928f862e215524434d82072;hb=HEAD;hpb=60b8f54df8fed44136bdc8ec615ee62703d87b69 diff --git a/src/util.c b/src/util.c index 1df757fa..52af147d 100644 --- a/src/util.c +++ b/src/util.c @@ -1,528 +1,310 @@ /* - * util.c + * util.c - utility functions */ /* - * Copyright (C) 2012 Eric Biggers + * Copyright 2012-2023 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 https://www.gnu.org/licenses/. */ -#include "wimlib_internal.h" -#include "endianness.h" -#include "sha1.h" -#include "timestamp.h" -#include - +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif -#include -#include -#include +#include +#include +#include +#include #include -#include +#include +#ifdef HAVE_SYS_SYSCTL_H +# include +# include +#endif +#ifdef HAVE_SYS_SYSCALL_H +# include +#endif #include -#include -/* 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 -#include -bool __wimlib_print_errors = false; +#include "wimlib.h" +#include "wimlib/assert.h" +#include "wimlib/error.h" +#include "wimlib/timestamp.h" +#include "wimlib/util.h" -void wimlib_error(const char *format, ...) -{ - if (__wimlib_print_errors) { - va_list va; - int errno_save; - - va_start(va, format); - errno_save = errno; - fputs("[ERROR] ", stderr); - vfprintf(stderr, format, va); - putc('\n', stderr); - errno = errno_save; - va_end(va); - } -} +/******************* + * Memory allocation + *******************/ -void wimlib_error_with_errno(const char *format, ...) -{ - if (__wimlib_print_errors) { - va_list va; - int errno_save; - - va_start(va, format); - errno_save = errno; - fflush(stdout); - fputs("[ERROR] ", stderr); - vfprintf(stderr, format, va); - fprintf(stderr, ": %s\n", strerror(errno_save)); - errno = errno_save; - va_end(va); - } -} +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_warning(const char *format, ...) +void * +wimlib_malloc(size_t size) { - if (__wimlib_print_errors) { - va_list va; - int errno_save; - - va_start(va, format); - errno_save = errno; - fflush(stdout); - fputs("[WARNING] ", stderr); - vfprintf(stderr, format, va); - putc('\n', stderr); - errno = errno_save; - va_end(va); + void *ptr; + +retry: + ptr = (*wimlib_malloc_func)(size); + if (unlikely(!ptr)) { + if (size == 0) { + size = 1; + goto retry; + } } + return ptr; } -#endif - -WIMLIBAPI int wimlib_set_print_errors(bool show_error_messages) +void +wimlib_free_memory(void *ptr) { -#ifdef ENABLE_ERROR_MESSAGES - __wimlib_print_errors = show_error_messages; - return 0; -#else - if (show_error_messages) - return WIMLIB_ERR_UNSUPPORTED; -#endif + (*wimlib_free_func)(ptr); } -static const char *error_strings[] = { - [WIMLIB_ERR_SUCCESS] - = "Success", - [WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE] - = "Lookup table is compressed", - [WIMLIB_ERR_DECOMPRESSION] - = "Failed to decompress compressed data", - [WIMLIB_ERR_DELETE_STAGING_DIR] - = "Failed to delete staging directory", - [WIMLIB_ERR_FORK] - = "Failed to fork another process", - [WIMLIB_ERR_FUSE] - = "An error was returned by fuse_main()", - [WIMLIB_ERR_FUSERMOUNT] - = "Could not execute the `fusermount' program, or it exited " - "with a failure status", - [WIMLIB_ERR_IMAGE_COUNT] - = "Inconsistent image count among the metadata " - "resources, the WIM header, and/or the XML data", - [WIMLIB_ERR_IMAGE_NAME_COLLISION] - = "Tried to add an image with a name that is already in use", - [WIMLIB_ERR_INTEGRITY] - = "The WIM failed an integrity check", - [WIMLIB_ERR_INVALID_CAPTURE_CONFIG] - = "The capture configuration string was invalid", - [WIMLIB_ERR_INVALID_CHUNK_SIZE] - = "The WIM is compressed but does not have a chunk " - "size of 32768", - [WIMLIB_ERR_INVALID_COMPRESSION_TYPE] - = "The WIM is compressed, but is not marked as having LZX or " - "XPRESS compression", - [WIMLIB_ERR_INVALID_DENTRY] - = "A directory entry in the WIM was invalid", - [WIMLIB_ERR_INVALID_HEADER_SIZE] - = "The WIM header was not 208 bytes", - [WIMLIB_ERR_INVALID_IMAGE] - = "Tried to select an image that does not exist in the WIM", - [WIMLIB_ERR_INVALID_INTEGRITY_TABLE] - = "The WIM's integrity table is invalid", - [WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY] - = "An entry in the WIM's lookup table is invalid", - [WIMLIB_ERR_INVALID_PARAM] - = "An invalid parameter was given", - [WIMLIB_ERR_INVALID_RESOURCE_HASH] - = "The SHA1 message digest of a WIM resource did not match the expected value", - [WIMLIB_ERR_INVALID_RESOURCE_SIZE] - = "A resource entry in the WIM is invalid", - [WIMLIB_ERR_LINK] - = "Failed to create a hard or symbolic link when extracting " - "a file from the WIM", - [WIMLIB_ERR_MKDIR] - = "Failed to create a directory", - [WIMLIB_ERR_MQUEUE] - = "Failed to create or use a POSIX message queue", - [WIMLIB_ERR_NOMEM] - = "Ran out of memory", - [WIMLIB_ERR_NOTDIR] - = "Expected a directory", - [WIMLIB_ERR_NOT_A_WIM_FILE] - = "The file did not begin with the magic characters that " - "identify a WIM file", - [WIMLIB_ERR_NO_FILENAME] - = "The WIM is not identified with a filename", - [WIMLIB_ERR_NTFS_3G] - = "NTFS-3g encountered an error (check errno)", - [WIMLIB_ERR_OPEN] - = "Failed to open a file", - [WIMLIB_ERR_OPENDIR] - = "Failed to open a directory", - [WIMLIB_ERR_READ] - = "Could not read data from a file", - [WIMLIB_ERR_READLINK] - = "Could not read the target of a symbolic link", - [WIMLIB_ERR_RENAME] - = "Could not rename a file", - [WIMLIB_ERR_SPECIAL_FILE] - = "Encountered a special file that cannot be archived", - [WIMLIB_ERR_SPLIT_INVALID] - = "The WIM is part of an invalid split WIM", - [WIMLIB_ERR_SPLIT_UNSUPPORTED] - = "The WIM is part of a split WIM, which is not supported for this operation", - [WIMLIB_ERR_STAT] - = "Could not read the metadata for a file or directory", - [WIMLIB_ERR_TIMEOUT] - = "Timed out", - [WIMLIB_ERR_UNKNOWN_VERSION] - = "The WIM file is marked with an unknown version number", - [WIMLIB_ERR_UNSUPPORTED] - = "The requested operation is unsupported", - [WIMLIB_ERR_WRITE] - = "Failed to write data to a file", - [WIMLIB_ERR_XML] - = "The XML data of the WIM is invalid", -}; - -WIMLIBAPI const char *wimlib_get_error_string(enum wimlib_error_code code) +void * +wimlib_realloc(void *ptr, size_t size) { - if (code < WIMLIB_ERR_SUCCESS || code > WIMLIB_ERR_XML) - return NULL; - else - return error_strings[code]; + if (size == 0) + size = 1; + return (*wimlib_realloc_func)(ptr, size); } - - -#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; - -void *wimlib_calloc(size_t nmemb, size_t size) +void * +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); - return p; -} + void *p; -char *wimlib_strdup(const char *str) -{ - size_t size; - char *p; - - size = strlen(str); - p = MALLOC(size + 1); + if (size != 0 && nmemb > SIZE_MAX / size) { + errno = ENOMEM; + return NULL; + } + + p = MALLOC(total_size); if (p) - memcpy(p, str, size + 1); + p = memset(p, 0, total_size); return p; } -extern void xml_set_memory_allocator(void *(*malloc_func)(size_t), - void (*free_func)(void *), - void *(*realloc_func)(void *, size_t)); -#endif - -WIMLIBAPI int wimlib_set_memory_allocator(void *(*malloc_func)(size_t), - void (*free_func)(void *), - void *(*realloc_func)(void *, size_t)) +char * +wimlib_strdup(const char *str) { -#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 + return memdup(str, strlen(str) + 1); } - - -static iconv_t cd_utf16_to_utf8 = (iconv_t)(-1); - -/* Converts a string in the UTF-16 encoding to a newly allocated string in the - * UTF-8 encoding. */ -char *utf16_to_utf8(const char *utf16_str, size_t utf16_len, - size_t *utf8_len_ret) +#ifdef _WIN32 +wchar_t * +wimlib_wcsdup(const wchar_t *str) { - if (cd_utf16_to_utf8 == (iconv_t)(-1)) { - cd_utf16_to_utf8 = iconv_open("UTF-8", "UTF-16LE"); - if (cd_utf16_to_utf8 == (iconv_t)-1) { - ERROR_WITH_ERRNO("Failed to get conversion descriptor " - "for converting UTF-16LE to UTF-8"); - return NULL; - } - } - size_t utf16_bytes_left = utf16_len; - size_t utf8_bytes_left = utf16_len; - - char *utf8_str = MALLOC(utf8_bytes_left); - if (!utf8_str) - return NULL; - - char *orig_utf8_str = utf8_str; - - size_t num_chars_converted = iconv(cd_utf16_to_utf8, (char**)&utf16_str, - &utf16_bytes_left, &utf8_str, &utf8_bytes_left); - - if (num_chars_converted == (size_t)(-1)) { - ERROR_WITH_ERRNO("Failed to convert UTF-16LE string to UTF-8 " - "string"); - FREE(orig_utf8_str); - return NULL; - } - - size_t utf8_len = utf16_len - utf8_bytes_left; - - *utf8_len_ret = utf8_len; - orig_utf8_str[utf8_len] = '\0'; - return orig_utf8_str; + return memdup(str, (wcslen(str) + 1) * sizeof(wchar_t)); } +#endif -static iconv_t cd_utf8_to_utf16 = (iconv_t)(-1); - -/* Converts a string in the UTF-8 encoding to a newly allocated string in the - * UTF-16 encoding. */ -char *utf8_to_utf16(const char *utf8_str, size_t utf8_len, - size_t *utf16_len_ret) +void * +wimlib_aligned_malloc(size_t size, size_t alignment) { - if (cd_utf8_to_utf16 == (iconv_t)(-1)) { - cd_utf8_to_utf16 = iconv_open("UTF-16LE", "UTF-8"); - if (cd_utf8_to_utf16 == (iconv_t)-1) { - ERROR_WITH_ERRNO("Failed to get conversion descriptor " - "for converting UTF-8 to UTF-16LE"); - return NULL; - } - } - - size_t utf8_bytes_left = utf8_len; - size_t utf16_capacity = utf8_len * 4; - size_t utf16_bytes_left = utf16_capacity; - - char *utf16_str = MALLOC(utf16_capacity + 2); - if (!utf16_str) - return NULL; + wimlib_assert(is_power_of_2(alignment)); - char *orig_utf16_str = utf16_str; - - size_t num_chars_converted = iconv(cd_utf8_to_utf16, (char**)&utf8_str, - &utf8_bytes_left, &utf16_str, &utf16_bytes_left); - - if (num_chars_converted == (size_t)(-1)) { - ERROR_WITH_ERRNO("Failed to convert UTF-8 string to UTF-16LE " - "string"); - FREE(orig_utf16_str); - return NULL; + void *ptr = MALLOC(sizeof(void *) + alignment - 1 + size); + if (ptr) { + void *orig_ptr = ptr; + ptr = (void *)ALIGN((uintptr_t)ptr + sizeof(void *), alignment); + ((void **)ptr)[-1] = orig_ptr; } - - size_t utf16_len = utf16_capacity - utf16_bytes_left; - - *utf16_len_ret = utf16_len; - orig_utf16_str[utf16_len] = '\0'; - orig_utf16_str[utf16_len + 1] = '\0'; - return orig_utf16_str; + return ptr; } -/* Write @n bytes from @buf to the file descriptor @fd, retrying on interupt and - * on short writes. - * - * Returns short count and set errno on failure. */ -ssize_t full_write(int fd, const void *buf, size_t n) +void +wimlib_aligned_free(void *ptr) { - const char *p = buf; - ssize_t ret; - ssize_t total = 0; - - while (total != n) { - ret = write(fd, p, n); - if (ret < 0) { - if (errno == EINTR) - continue; - else - break; - } - total += ret; - p += ret; - } - return total; + if (ptr) + FREE(((void **)ptr)[-1]); } - -static bool seeded = false; - -/* Fills @n bytes pointed to by @p with random alphanumeric characters. */ -void randomize_char_array_with_alnum(char p[], size_t n) +void * +memdup(const void *mem, size_t size) { - int r; - - if (!seeded) { - srand(time(NULL)); - seeded = true; - } - while (n--) { - r = rand() % 62; - if (r < 26) - *p++ = r + 'a'; - else if (r < 52) - *p++ = r - 26 + 'A'; - else - *p++ = r - 52 + '0'; - } + void *ptr = MALLOC(size); + if (ptr) + ptr = memcpy(ptr, mem, size); + return ptr; } -/* Fills @n bytes pointer to by @p with random numbers. */ -void randomize_byte_array(u8 *p, size_t n) +/* 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)) { - if (!seeded) { - srand(time(NULL)); - seeded = true; - } - while (n--) - *p++ = rand(); + wimlib_malloc_func = malloc_func ? malloc_func : malloc; + wimlib_free_func = free_func ? free_func : free; + wimlib_realloc_func = realloc_func ? realloc_func : realloc; + return 0; } -/* Takes in a path of length @len in @buf, and transforms it into a string for - * the path of its parent directory. */ -void to_parent_name(char buf[], size_t len) -{ - ssize_t i = (ssize_t)len - 1; - while (i >= 0 && buf[i] == '/') - i--; - while (i >= 0 && buf[i] != '/') - i--; - while (i >= 0 && buf[i] == '/') - i--; - buf[i + 1] = '\0'; -} +/******************* + * String utilities + *******************/ -/* Like the basename() function, but does not modify @path; it just returns a - * pointer to it. */ -const char *path_basename(const char *path) +#ifndef HAVE_MEMPCPY +void *mempcpy(void *dst, const void *src, size_t n) { - const char *p = path; - while (*p) - p++; - p--; - - /* Trailing slashes. */ - while (1) { - if (p == path - 1) - return ""; - if (*p != '/') - break; - p--; - } - - while ((p != path - 1) && *p != '/') - p--; - - return p + 1; + return memcpy(dst, src, n) + n; } +#endif + +/************************** + * Random number generation + **************************/ -/* - * 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. +#ifndef _WIN32 +/* + * Generate @n cryptographically secure random bytes (thread-safe) + * + * This is the UNIX version. It uses the Linux getrandom() system call if + * available; otherwise, it falls back to reading from /dev/urandom. */ -const char *path_stream_name(const char *path) +void +get_random_bytes(void *p, size_t n) { - const char *base = path_basename(path); - const char *stream_name = strchr(base, ':'); - if (!stream_name) - return NULL; - else - return stream_name + 1; + if (n == 0) + return; +#ifdef __NR_getrandom + static bool getrandom_unavailable; + + if (getrandom_unavailable) + goto try_dev_urandom; + do { + int res = syscall(__NR_getrandom, p, n, 0); + if (unlikely(res < 0)) { + if (errno == ENOSYS) { + getrandom_unavailable = true; + goto try_dev_urandom; + } + if (errno == EINTR) + continue; + ERROR_WITH_ERRNO("getrandom() failed"); + wimlib_assert(0); + res = 0; + } + p += res; + n -= res; + } while (n != 0); + return; + +try_dev_urandom: + ; +#endif /* __NR_getrandom */ + int fd = open("/dev/urandom", O_RDONLY); + if (fd < 0) { + ERROR_WITH_ERRNO("Unable to open /dev/urandom"); + wimlib_assert(0); + } + do { + int res = read(fd, p, min(n, INT_MAX)); + if (unlikely(res < 0)) { + if (errno == EINTR) + continue; + ERROR_WITH_ERRNO("Error reading from /dev/urandom"); + wimlib_assert(0); + res = 0; + } + p += res; + n -= res; + } while (n != 0); + close(fd); } +#endif /* !_WIN32 */ -/* - * Splits a file path into the part before the first '/', or the entire name if - * there is no '/', and the part after the first sequence of '/' characters. +/* + * Generate @n cryptographically secure random alphanumeric characters + * (thread-safe) * - * @path: The file path to split. - * @first_part_len_ret: A pointer to a `size_t' into which the length of the - * first part of the path will be returned. - * @return: A pointer to the next part of the path, after the first - * sequence of '/', or a pointer to the terminating - * null byte in the case of a path without any '/'. + * This is implemented on top of get_random_bytes(). For efficiency the calls + * to get_random_bytes() are batched. */ -const char *path_next_part(const char *path, size_t *first_part_len_ret) +void +get_random_alnum_chars(tchar *p, size_t n) { - size_t i; - const char *next_part; - - i = 0; - while (path[i] != '/' && path[i] != '\0') - i++; - if (first_part_len_ret) - *first_part_len_ret = i; - next_part = &path[i]; - while (*next_part == '/') - next_part++; - return next_part; -} + u32 r[64]; + int r_idx = 0; + int r_end = 0; -/* Returns the number of components of @path. */ -int get_num_path_components(const char *path) -{ - int num_components = 0; - while (*path) { - while (*path == '/') - path++; - if (*path) - num_components++; - while (*path && *path != '/') - path++; - } - return num_components; -} + for (; n != 0; p++, n--) { + tchar x; + if (r_idx >= r_end) { + r_idx = 0; + r_end = min(n, ARRAY_LEN(r)); + get_random_bytes(r, r_end * sizeof(r[0])); + } -/* - * Prints a string. Printable characters are printed as-is, while unprintable - * characters are printed as their octal escape codes. - */ -void print_string(const void *string, size_t len) -{ - const u8 *p = string; + STATIC_ASSERT(sizeof(r[0]) == sizeof(u32)); + while (unlikely(r[r_idx] >= UINT32_MAX - (UINT32_MAX % 62))) + get_random_bytes(&r[r_idx], sizeof(r[0])); - while (len--) { - if (isprint(*p)) - putchar(*p); + x = r[r_idx++] % 62; + + if (x < 26) + *p = 'a' + x; + else if (x < 52) + *p = 'A' + x - 26; else - printf("\\%03hho", *p); - p++; + *p = '0' + x - 52; } } -u64 get_wim_timestamp() +/************************ + * System information + ************************/ + +#ifndef _WIN32 +unsigned +get_available_cpus(void) { - struct timeval tv; - gettimeofday(&tv, NULL); - return timeval_to_wim_timestamp(&tv); + long n = sysconf(_SC_NPROCESSORS_ONLN); + if (n < 1 || n >= UINT_MAX) { + WARNING("Failed to determine number of processors; assuming 1."); + return 1; + } + return n; } +#endif /* !_WIN32 */ +#ifndef _WIN32 +u64 +get_available_memory(void) +{ +#if defined(_SC_PAGESIZE) && defined(_SC_PHYS_PAGES) + long page_size = sysconf(_SC_PAGESIZE); + long num_pages = sysconf(_SC_PHYS_PAGES); + if (page_size <= 0 || num_pages <= 0) + goto default_size; + return ((u64)page_size * (u64)num_pages); +#else + int mib[2] = {CTL_HW, HW_MEMSIZE}; + u64 memsize; + size_t len = sizeof(memsize); + if (sysctl(mib, ARRAY_LEN(mib), &memsize, &len, NULL, 0) < 0 || len != 8) + goto default_size; + return memsize; +#endif +default_size: + WARNING("Failed to determine available memory; assuming 1 GiB"); + return (u64)1 << 30; +} +#endif /* !_WIN32 */