/*
- * util.c
+ * util.c - utility functions
*/
/*
- * Copyright (C) 2012, 2013 Eric Biggers
+ * Copyright (C) 2012, 2013, 2014 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
# include "config.h"
#endif
-#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 <limits.h>
+#include <stdio.h>
+#include <stdlib.h>
#include <string.h>
-#ifdef _GNU_SOURCE_DEFINED
-# define _GNU_SOURCE
+#ifdef HAVE_SYS_SYSCTL_H
+# include <sys/types.h>
+# include <sys/sysctl.h>
#endif
+#include <unistd.h>
#include "wimlib.h"
#include "wimlib/assert.h"
-#include "wimlib/compiler.h"
-#include "wimlib/encoding.h"
#include "wimlib/error.h"
-#include "wimlib/types.h"
+#include "wimlib/timestamp.h"
#include "wimlib/util.h"
#include "wimlib/xml.h"
-#ifdef __WIN32__
-# include "wimlib/win32.h" /* win32_strerror_r_replacement */
-#endif
-
-#include <errno.h>
-#include <stdarg.h>
-#include <stdlib.h>
-#include <time.h>
-#include <unistd.h>
-
-size_t
-utf16le_strlen(const utf16lechar *s)
-{
- const utf16lechar *p = s;
- while (*p)
- p++;
- return (p - s) * sizeof(utf16lechar);
-}
-
-#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)
-static void
-wimlib_vmsg(const tchar *tag, const tchar *format,
- va_list va, bool perror)
-{
-#if !defined(ENABLE_DEBUG)
- if (wimlib_print_errors)
-#endif
- {
- int errno_save = errno;
- fflush(stdout);
- tfputs(tag, wimlib_error_file);
- tvfprintf(wimlib_error_file, format, va);
- if (perror && errno_save != 0) {
- tchar buf[64];
- int res;
- 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(wimlib_error_file, T(": %"TS), buf);
- }
- tputc(T('\n'), wimlib_error_file);
- fflush(wimlib_error_file);
- errno = errno_save;
- }
-}
-#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
-void
-wimlib_error(const tchar *format, ...)
-{
- va_list va;
-
- va_start(va, format);
- wimlib_vmsg(T("\r[ERROR] "), format, va, false);
- va_end(va);
-}
-
-void
-wimlib_error_with_errno(const tchar *format, ...)
-{
- va_list va;
-
- va_start(va, format);
- wimlib_vmsg(T("\r[ERROR] "), format, va, true);
- va_end(va);
-}
-
-void
-wimlib_warning(const tchar *format, ...)
-{
- va_list va;
-
- va_start(va, format);
- wimlib_vmsg(T("\r[WARNING] "), format, va, false);
- va_end(va);
-}
-
-void
-wimlib_warning_with_errno(const tchar *format, ...)
-{
- va_list va;
-
- va_start(va, format);
- wimlib_vmsg(T("\r[WARNING] "), format, va, true);
- va_end(va);
-}
-
-#endif
-
-#if defined(ENABLE_DEBUG) || defined(ENABLE_MORE_DEBUG)
-void wimlib_debug(const tchar *file, int line, const char *func,
- const tchar *format, ...)
-{
- 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);
- wimlib_vmsg(buf, format, va, false);
- va_end(va);
-}
-#endif
-
-/* API function documented in wimlib.h */
-WIMLIBAPI int
-wimlib_set_print_errors(bool show_error_messages)
-{
-#ifdef ENABLE_ERROR_MESSAGES
- wimlib_print_errors = show_error_messages;
- return 0;
-#else
- if (show_error_messages)
- return WIMLIB_ERR_UNSUPPORTED;
- else
- return 0;
-#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"),
- [WIMLIB_ERR_ALREADY_LOCKED]
- = T("The WIM is already locked for writing"),
- [WIMLIB_ERR_DECOMPRESSION]
- = T("Failed to decompress compressed data"),
- [WIMLIB_ERR_FUSE]
- = T("An error was returned by fuse_main()"),
- [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_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 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 compression chunk size was unrecognized"),
- [WIMLIB_ERR_INVALID_COMPRESSION_TYPE]
- = T("The compression type was unrecognized"),
- [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]
- = 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("Conflicting files in overlay when creating a WIM image"),
- [WIMLIB_ERR_INVALID_PARAM]
- = 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_UTF8_STRING]
- = 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]
- = T("Failed to create or use a POSIX message queue"),
- [WIMLIB_ERR_NOMEM]
- = T("Ran out of memory"),
- [WIMLIB_ERR_NOTDIR]
- = T("Expected a directory"),
- [WIMLIB_ERR_NOTEMPTY]
- = T("Directory was not empty"),
- [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 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]
- = T("Could not read the target of a symbolic link"),
- [WIMLIB_ERR_RENAME]
- = 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_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_STAT]
- = T("Could not read the metadata for a file or directory"),
- [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_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"),
-};
-
-/* API function documented in wimlib.h */
-WIMLIBAPI const tchar *
-wimlib_get_error_string(enum wimlib_error_code _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];
-}
-
-
+/*******************
+ * Memory allocation
+ *******************/
static void *(*wimlib_malloc_func) (size_t) = malloc;
static void (*wimlib_free_func) (void *) = free;
retry:
ptr = (*wimlib_malloc_func)(size);
if (unlikely(!ptr)) {
- if (!size) {
- size++;
+ if (size == 0) {
+ size = 1;
goto retry;
}
- ERROR("memory exhausted");
}
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 *
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);
+ const uintptr_t mask = alignment - 1;
+ char *ptr = NULL;
+ char *raw_ptr;
+ raw_ptr = MALLOC(mask + sizeof(size_t) + size);
+ if (raw_ptr) {
+ ptr = (char *)raw_ptr + sizeof(size_t);
+ ptr = (void *)(((uintptr_t)ptr + mask) & ~mask);
+ *((size_t *)ptr - 1) = ptr - raw_ptr;
+ }
return ptr;
}
wimlib_aligned_free(void *ptr)
{
if (ptr)
- FREE((u8 *)ptr - *((size_t *)ptr - 1));
+ FREE((char *)ptr - *((size_t *)ptr - 1));
}
void *
return 0;
}
+/*******************
+ * String utilities
+ *******************/
+
+#ifndef HAVE_MEMPCPY
+void *mempcpy(void *dst, const void *src, size_t n)
+{
+ return memcpy(dst, src, n) + n;
+}
+#endif
+
static bool seeded = false;
static void
seed_random(void)
{
- srand(time(NULL) * getpid());
+ srand(now_as_wim_timestamp());
seeded = true;
}
/* Fills @n characters pointed to by @p with random alphanumeric characters. */
void
-randomize_char_array_with_alnum(tchar p[], size_t n)
+randomize_char_array_with_alnum(tchar *p, size_t n)
{
if (!seeded)
seed_random();
*p++ = rand();
}
-
-void print_byte_field(const u8 field[], size_t len, FILE *out)
+#ifndef __WIN32__
+unsigned
+get_available_cpus(void)
{
- while (len--)
- tfprintf(out, T("%02hhx"), *field++);
+ 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 HAVE_MEMPCPY
-void *mempcpy(void *dst, const void *src, size_t n)
+#ifndef __WIN32__
+u64
+get_available_memory(void)
{
- return memcpy(dst, src, n) + n;
-}
+#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__ */
git://wimlib.net / wimlib / blobdiff