7b3e724a68ce677859eaa44ddf552cdf3ca1c6c0
[wimlib] / include / wimlib / util.h
1 #ifndef _WIMLIB_UTIL_H
2 #define _WIMLIB_UTIL_H
3
4 #include "wimlib/types.h"
5 #include "wimlib/compiler.h"
6
7 #include <stdio.h>
8 #include <stddef.h>
9
10 #ifndef min
11 #define min(a, b) ({ typeof(a) __a = (a); typeof(b) __b = (b); \
12                                         (__a < __b) ? __a : __b; })
13 #endif
14
15 #ifndef max
16 #define max(a, b) ({ typeof(a) __a = (a); typeof(b) __b = (b); \
17                                         (__a > __b) ? __a : __b; })
18 #endif
19
20 #ifndef swap
21 #define swap(a, b) ({typeof(a) _a = a; (a) = (b); (b) = _a;})
22 #endif
23
24 /**
25  * container_of - cast a member of a structure out to the containing structure
26  * @ptr:        the pointer to the member.
27  * @type:       the type of the container struct this is embedded in.
28  * @member:     the name of the member within the struct.
29  *
30  */
31 #ifndef container_of
32 #define container_of(ptr, type, member) ({                      \
33         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
34         (type *)( (char *)__mptr - offsetof(type,member) );})
35 #endif
36
37 #define DIV_ROUND_UP(numerator, denominator) \
38         (((numerator) + (denominator) - 1) / (denominator))
39
40 #define MODULO_NONZERO(numerator, denominator) \
41         (((numerator) % (denominator)) ? ((numerator) % (denominator)) : (denominator))
42
43 #define ARRAY_LEN(array) (sizeof(array) / sizeof((array)[0]))
44
45 #define ZERO_ARRAY(array) memset(array, 0, sizeof(array))
46
47 /* Used for buffering FILE IO in a few places */
48 #define BUFFER_SIZE 32768
49
50 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
51
52 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
53 extern void *
54 wimlib_malloc(size_t) _malloc_attribute;
55
56 extern void
57 wimlib_free_memory(void *p);
58
59 extern void *
60 wimlib_realloc(void *, size_t) _warn_unused_result_attribute;
61
62 extern void *
63 wimlib_calloc(size_t nmemb, size_t size) _malloc_attribute;
64
65 #ifdef __WIN32__
66 extern wchar_t *
67 wimlib_wcsdup(const wchar_t *str) _malloc_attribute;
68
69 #endif
70 extern char *
71 wimlib_strdup(const char *str) _malloc_attribute;
72
73 #  define       MALLOC  wimlib_malloc
74 #  define       FREE    wimlib_free_memory
75 #  define       REALLOC wimlib_realloc
76 #  define       CALLOC  wimlib_calloc
77 #  define       STRDUP  wimlib_strdup
78 #  define       WCSDUP  wimlib_wcsdup
79 #else /* ENABLE_CUSTOM_MEMORY_ALLOCATOR */
80 #  include <stdlib.h>
81 #  include <string.h>
82 #  define       MALLOC  malloc
83 #  define       FREE    free
84 #  define       REALLOC realloc
85 #  define       CALLOC  calloc
86 #  define       STRDUP  strdup
87 #  define       WCSDUP  wcsdup
88 #endif /* !ENABLE_CUSTOM_MEMORY_ALLOCATOR */
89
90 extern void *
91 memdup(const void *mem, size_t size) _malloc_attribute;
92
93 /* util.c */
94 extern void
95 randomize_byte_array(u8 *p, size_t n);
96
97 extern void
98 randomize_char_array_with_alnum(tchar p[], size_t n);
99
100 extern void
101 print_byte_field(const u8 field[], size_t len, FILE *out);
102
103 static inline u32
104 bsr32(u32 n)
105 {
106 #if defined(__x86__) || defined(__x86_64__)
107         asm("bsrl %0, %0;"
108                         : "=r"(n)
109                         : "0" (n));
110         return n;
111 #else
112         u32 pow = 0;
113         while ((n >>= 1) != 0)
114                 pow++;
115         return pow;
116 #endif
117 }
118
119 static inline u64
120 hash_u64(u64 n)
121 {
122         return n * 0x9e37fffffffc0001ULL;
123 }
124
125 /* is_any_path_separator() - characters treated as path separators in WIM path
126  * specifications and capture configuration files (the former will be translated
127  * to WIM_PATH_SEPARATOR; the latter will be translated to
128  * OS_PREFERRED_PATH_SEPARATOR)
129  *
130  * OS_PREFERRED_PATH_SEPARATOR - preferred (or only) path separator on the
131  * operating system.  Used when constructing filesystem paths to extract or
132  * archive.
133  *
134  * WIM_PATH_SEPARATOR - character treated as path separator for WIM paths.
135  * Currently needs to be '/' on UNIX for the WIM mounting code to work properly.
136  */
137
138 #ifdef __WIN32__
139 #  define OS_PREFERRED_PATH_SEPARATOR L'\\'
140 #  define is_any_path_separator(c) ((c) == L'/' || (c) == L'\\')
141 #else
142 #  define OS_PREFERRED_PATH_SEPARATOR '/'
143 #  define is_any_path_separator(c) ((c) == '/' || (c) == '\\')
144 #endif
145
146 #define WIM_PATH_SEPARATOR WIMLIB_WIM_PATH_SEPARATOR
147
148 #endif /* _WIMLIB_UTIL_H */