-/*
- * util.h
- *
- * Header for util.c.
- *
- * Copyright (C) 2012 Eric Biggers
- *
- * wimlib - Library for working with WIM files
- *
- * This library 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 2.1 of the License, or (at your option) any
- * later version.
- *
- * This library 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 Lesser General Public License along
- * with this library; if not, write to the Free Software Foundation, Inc., 59
- * Temple Place, Suite 330, Boston, MA 02111-1307 USA
- */
-
#ifndef _WIMLIB_UTIL_H
#define _WIMLIB_UTIL_H
#include <sys/types.h>
#include "config.h"
+#ifdef __GNUC__
+# if defined(__CYGWIN__) || defined(__WIN32__)
+# define WIMLIBAPI __declspec(dllexport)
+# else
+# define WIMLIBAPI __attribute__((visibility("default")))
+# endif
+# define ALWAYS_INLINE inline __attribute__((always_inline))
+# define PACKED __attribute__((packed))
+# define FORMAT(type, format_str, args_start) \
+ __attribute__((format(type, format_str, args_start)))
+# if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4)
+# define COLD __attribute__((cold))
+# else
+# define COLD
+# endif
+#else
+# define WIMLIBAPI
+# define ALWAYS_INLINE inline
+# define FORMAT(type, format_str, args_start)
+# define COLD
+# define PACKED
+#endif /* __GNUC__ */
+
+#if 0
+#ifdef WITH_FUSE
+#define atomic_inc(ptr) \
+ __sync_fetch_and_add(ptr, 1)
+
+#define atomic_dec(ptr) \
+ __sync_sub_and_fetch(ptr, 1)
+#endif
+#endif
+
+#ifndef _NTFS_TYPES_H
typedef uint8_t u8;
typedef uint16_t u16;
typedef uint32_t u32;
typedef uint64_t u64;
-typedef unsigned uint;
+#endif
+
+/* A pointer to 'mbchar' indicates a string of "multibyte characters" provided
+ * in the default encoding of the user's locale, which may be "UTF-8",
+ * "ISO-8859-1", "C", or any other ASCII-compatible encoding.
+ * "ASCII-compatible" here means any encoding where all ASCII characters have
+ * the same representation, and any non-ASCII character is represented as a
+ * sequence of one or more bytes not already used by any ASCII character. */
+typedef char mbchar;
+
+/* A pointer to 'utf8char' indicates a UTF-8 encoded string */
+typedef char utf8char;
+
+/* Note: in some places in the code, strings of plain old 'char' are still used.
+ * This means that the string is being operated on in an ASCII-compatible way,
+ * and may be either a multibyte or UTF-8 string. */
+
+/* A pointer to 'utf16lechar' indicates a UTF-16LE encoded string */
+typedef u16 utf16lechar;
+#ifndef min
#define min(a, b) ({ typeof(a) __a = (a); typeof(b) __b = (b); \
(__a < __b) ? __a : __b; })
+#endif
+
+#ifndef max
#define max(a, b) ({ typeof(a) __a = (a); typeof(b) __b = (b); \
(__a > __b) ? __a : __b; })
+#endif
+
+#ifndef swap
#define swap(a, b) ({typeof(a) _a = a; (a) = (b); (b) = _a;})
+#endif
+
+/**
+ * container_of - cast a member of a structure out to the containing structure
+ * @ptr: the pointer to the member.
+ * @type: the type of the container struct this is embedded in.
+ * @member: the name of the member within the struct.
+ *
+ */
+#ifndef container_of
+#define container_of(ptr, type, member) ({ \
+ const typeof( ((type *)0)->member ) *__mptr = (ptr); \
+ (type *)( (char *)__mptr - offsetof(type,member) );})
+#endif
+
+#define DIV_ROUND_UP(numerator, denominator) \
+ (((numerator) + (denominator) - 1) / (denominator))
+
+#define MODULO_NONZERO(numerator, denominator) \
+ (((numerator) % (denominator)) ? ((numerator) % (denominator)) : (denominator))
#define ARRAY_LEN(array) (sizeof(array) / sizeof((array)[0]))
#define ZERO_ARRAY(array) memset(array, 0, sizeof(array))
+/* Used for buffering FILE IO in a few places */
+#define BUFFER_SIZE 4096
+
+static inline void FORMAT(printf, 1, 2)
+dummy_printf(const char *format, ...)
+{
+}
+
#ifdef ENABLE_ERROR_MESSAGES
-extern bool __wimlib_print_errors;
-extern void wimlib_error(const char *format, ...);
-# define ERROR wimlib_error
+extern void
+wimlib_error(const char *format, ...) FORMAT(printf, 1, 2) COLD;
+
+extern void
+wimlib_error_with_errno(const char *format, ...) FORMAT(printf, 1, 2) COLD;
+
+extern void
+wimlib_warning(const char *format, ...) FORMAT(printf, 1, 2) COLD;
+
+extern void
+wimlib_warning_with_errno(const char *format, ...) FORMAT(printf, 1, 2) COLD;
+# define ERROR wimlib_error
+# define ERROR_WITH_ERRNO wimlib_error_with_errno
+# define WARNING wimlib_warning
+# define WARNING_WITH_ERRNO wimlib_warning
#else
-# define ERROR(format, ...)
+# define ERROR(format, ...) dummy_printf(format, ## __VA_ARGS__)
+# define ERROR_WITH_ERRNO(format, ...) dummy_printf(format, ## __VA_ARGS__)
+# define WARNING(format, ...) dummy_printf(format, ## __VA_ARGS__)
+# define WARNING_WITH_ERRNO(format, ...) dummy_printf(format, ## __VA_ARGS__)
#endif /* ENABLE_ERROR_MESSAGES */
#if defined(ENABLE_DEBUG) || defined(ENABLE_MORE_DEBUG)
-#include <errno.h>
-# define DEBUG(format, ...) \
-({ \
- int __errno_save = errno; \
- fprintf(stdout, "[%s %d] %s(): " format, \
- __FILE__, __LINE__, __func__, ## __VA_ARGS__); \
- fflush(stdout); \
- errno = __errno_save; \
+# include <errno.h>
+# define DEBUG(format, ...) \
+ ({ \
+ int __errno_save = errno; \
+ wimlib_fprintf(stdout, "[%s %d] %s(): " format, \
+ __FILE__, __LINE__, __func__, ## __VA_ARGS__); \
+ putchar('\n'); \
+ fflush(stdout); \
+ errno = __errno_save; \
})
#else
-# define DEBUG(format, ...)
+# define DEBUG(format, ...) dummy_printf(format, ## __VA_ARGS__)
#endif /* ENABLE_DEBUG || ENABLE_MORE_DEBUG */
#ifdef ENABLE_MORE_DEBUG
-# define DEBUG2(format, ...) DEBUG(format, ## __VA_ARGS__)
+# define DEBUG2(format, ...) DEBUG(format, ## __VA_ARGS__)
#else
-# define DEBUG2(format, ...)
+# define DEBUG2(format, ...) dummy_printf(format, ## __VA_ARGS__)
#endif /* ENABLE_DEBUG */
#ifdef ENABLE_ASSERTIONS
# define wimlib_assert(expr)
#endif
-#ifdef __GNUC__
-# define WIMLIBAPI __attribute__((visibility("default")))
-# define NOINLINE __attribute__((noinline))
-# define ALWAYS_INLINE inline __attribute__((always_inline))
-# define COLD __attribute__((cold))
-# define HOT __attribute__((hot))
+#ifdef ENABLE_MORE_ASSERTIONS
+#define wimlib_assert2(expr) wimlib_assert(expr)
#else
-# define WIMLIBAPI
-# define NOINLINE
-# define ALWAYS_INLINE inline
-# define COLD
-# define HOT
-#endif /* __GNUC__ */
+#define wimlib_assert2(expr)
+#endif
+
+#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
#ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
extern void *(*wimlib_malloc_func)(size_t);
extern void (*wimlib_free_func)(void *);
-extern void *(*wimlib_realloc)(void *, size_t);
+extern void *(*wimlib_realloc_func)(void *, size_t);
extern void *wimlib_calloc(size_t nmemb, size_t size);
extern char *wimlib_strdup(const char *str);
-# define MALLOC wimlib_malloc_func
-# define FREE wimlib_free_func
-# define REALLOC wimlib_realloc_func
-# define CALLOC wimlib_calloc
-# define STRDUP wimlib_strdup
+# define MALLOC wimlib_malloc_func
+# define FREE wimlib_free_func
+# define REALLOC wimlib_realloc_func
+# define CALLOC wimlib_calloc
+# define STRDUP wimlib_strdup
#else
-#include <stdlib.h>
-#include <string.h>
-# define MALLOC malloc
-# define FREE free
-# define REALLOC realloc
-# define CALLOC calloc
-# define STRDUP strdup
+# include <stdlib.h>
+# include <string.h>
+# define MALLOC malloc
+# define FREE free
+# define REALLOC realloc
+# define CALLOC calloc
+# define STRDUP strdup
#endif /* ENABLE_CUSTOM_MEMORY_ALLOCATOR */
-extern char *utf16_to_utf8(const char *utf16_str, size_t utf16_len,
- size_t *utf8_len_ret);
-
-extern char *utf8_to_utf16(const char *utf8_str, size_t utf8_len,
- size_t *utf16_len_ret);
-
-extern void randomize_byte_array(void *p, size_t n);
-
-extern void randomize_char_array_with_alnum(char p[], size_t n);
-
-extern int sha1sum(const char *filename, void *buf);
+/* util.c */
+extern void
+randomize_byte_array(u8 *p, size_t n);
-extern const char *path_next_part(const char *path,
- size_t *first_part_len_ret);
+extern void
+randomize_char_array_with_alnum(char p[], size_t n);
-extern const char *path_basename(const char *path);
+extern const char *
+path_next_part(const char *path, size_t *first_part_len_ret);
-extern void to_parent_name(char buf[], size_t len);
+extern const char *
+path_basename(const char *path);
-extern void print_string(const void *string, size_t len);
+extern const char *
+path_stream_name(const char *path);
-extern int get_num_path_components(const char *path);
+extern void
+to_parent_name(char buf[], size_t len);
-extern ssize_t full_write(int fd, const void *buf, size_t n);
+extern void
+print_string(const void *string, size_t len);
+extern int
+get_num_path_components(const char *path);
-static inline void print_byte_field(const u8 field[], size_t len)
+static inline void
+print_byte_field(const u8 field[], size_t len)
{
while (len--)
printf("%02hhx", *field++);
}
+static inline u32
+bsr32(u32 n)
+{
+#if defined(__x86__) || defined(__x86_64__)
+ asm("bsrl %0, %0;"
+ : "=r"(n)
+ : "0" (n));
+ return n;
+#else
+ u32 pow = 0;
+ while ((n >>= 1) != 0)
+ pow++;
+ return pow;
+#endif
+}
+
+extern int
+wimlib_fprintf(FILE *fp, const char *format, ...) FORMAT(printf, 2, 3);
+
+extern int
+wimlib_printf(const char *format, ...) FORMAT(printf, 1, 2);
#endif /* _WIMLIB_UTIL_H */
git://wimlib.net / wimlib / blobdiff