Add wimlib_global_{init,cleanup}()
[wimlib] / src / util.h
1 #ifndef _WIMLIB_UTIL_H
2 #define _WIMLIB_UTIL_H
3
4 #include <stdio.h>
5 #include <stdbool.h>
6 #include <stddef.h>
7 #include <inttypes.h>
8 #include <sys/types.h>
9 #include "config.h"
10
11 #ifdef __GNUC__
12 #       define WIMLIBAPI __attribute__((visibility("default")))
13 #       define ALWAYS_INLINE inline __attribute__((always_inline))
14 #       define PACKED __attribute__((packed))
15 #       define FORMAT(type, format_str, args_start) \
16                         __attribute__((format(type, format_str, args_start)))
17 #       if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4)
18 #               define COLD     __attribute__((cold))
19 #       else
20 #               define COLD
21 #       endif
22 #else
23 #       define WIMLIBAPI
24 #       define ALWAYS_INLINE inline
25 #       define FORMAT(type, format_str, args_start)
26 #       define COLD
27 #       define PACKED
28 #endif /* __GNUC__ */
29
30
31 #if 0
32 #ifdef WITH_FUSE
33 #define atomic_inc(ptr) \
34         __sync_fetch_and_add(ptr, 1)
35
36 #define atomic_dec(ptr) \
37         __sync_sub_and_fetch(ptr, 1)
38 #endif
39 #endif
40
41 #ifndef _NTFS_TYPES_H
42 typedef uint8_t  u8;
43 typedef uint16_t u16;
44 typedef uint32_t u32;
45 typedef uint64_t u64;
46 #endif
47
48 #ifndef min
49 #define min(a, b) ({ typeof(a) __a = (a); typeof(b) __b = (b); \
50                                         (__a < __b) ? __a : __b; })
51 #endif
52
53 #ifndef max
54 #define max(a, b) ({ typeof(a) __a = (a); typeof(b) __b = (b); \
55                                         (__a > __b) ? __a : __b; })
56 #endif
57
58 #ifndef swap
59 #define swap(a, b) ({typeof(a) _a = a; (a) = (b); (b) = _a;})
60 #endif
61
62 /**
63  * container_of - cast a member of a structure out to the containing structure
64  * @ptr:        the pointer to the member.
65  * @type:       the type of the container struct this is embedded in.
66  * @member:     the name of the member within the struct.
67  *
68  */
69 #ifndef container_of
70 #define container_of(ptr, type, member) ({                      \
71         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
72         (type *)( (char *)__mptr - offsetof(type,member) );})
73 #endif
74
75 #define DIV_ROUND_UP(numerator, denominator) \
76         (((numerator) + (denominator) - 1) / (denominator))
77
78 #define MODULO_NONZERO(numerator, denominator) \
79         (((numerator) % (denominator)) ? ((numerator) % (denominator)) : (denominator))
80
81 #define ARRAY_LEN(array) (sizeof(array) / sizeof((array)[0]))
82
83 #define ZERO_ARRAY(array) memset(array, 0, sizeof(array))
84
85 /* Used for buffering FILE IO in a few places */
86 #define BUFFER_SIZE 4096
87
88 #ifdef ENABLE_ERROR_MESSAGES
89 extern bool __wimlib_print_errors;
90 extern void wimlib_error(const char *format, ...)
91                 FORMAT(printf, 1, 2) COLD;
92 extern void wimlib_error_with_errno(const char *format, ...)
93                 FORMAT(printf, 1, 2) COLD;
94 extern void wimlib_warning(const char *format, ...)
95                 FORMAT(printf, 1, 2) COLD;
96 #       define ERROR            wimlib_error
97 #       define ERROR_WITH_ERRNO wimlib_error_with_errno
98 #       define WARNING          wimlib_warning
99 #else
100 #       define ERROR(format, ...)
101 #       define ERROR_WITH_ERRNO(format, ...)
102 #       define WARNING(format, ...)
103 #endif /* ENABLE_ERROR_MESSAGES */
104
105 #if defined(ENABLE_DEBUG) || defined(ENABLE_MORE_DEBUG)
106 #       include <errno.h>
107 #       define DEBUG(format, ...)                                       \
108         ({                                                              \
109                 int __errno_save = errno;                               \
110                 fprintf(stdout, "[%s %d] %s(): " format,                \
111                         __FILE__, __LINE__, __func__, ## __VA_ARGS__);  \
112                 putchar('\n');                                          \
113                 fflush(stdout);                                         \
114                 errno = __errno_save;                                   \
115         })
116
117 #else
118 #       define DEBUG(format, ...)
119 #endif /* ENABLE_DEBUG || ENABLE_MORE_DEBUG */
120
121 #ifdef ENABLE_MORE_DEBUG
122 #       define DEBUG2(format, ...) DEBUG(format, ## __VA_ARGS__)
123 #else
124 #       define DEBUG2(format, ...)
125 #endif /* ENABLE_DEBUG */
126
127 #ifdef ENABLE_ASSERTIONS
128 #include <assert.h>
129 #       define wimlib_assert(expr) assert(expr)
130 #else
131 #       define wimlib_assert(expr)
132 #endif
133
134 #ifdef ENABLE_MORE_ASSERTIONS
135 #define wimlib_assert2(expr) wimlib_assert(expr)
136 #else
137 #define wimlib_assert2(expr)
138 #endif
139
140 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
141
142 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
143 extern void *(*wimlib_malloc_func)(size_t);
144 extern void (*wimlib_free_func)(void *);
145 extern void *(*wimlib_realloc_func)(void *, size_t);
146 extern void *wimlib_calloc(size_t nmemb, size_t size);
147 extern char *wimlib_strdup(const char *str);
148 #       define  MALLOC  wimlib_malloc_func
149 #       define  FREE    wimlib_free_func
150 #       define  REALLOC wimlib_realloc_func
151 #       define  CALLOC  wimlib_calloc
152 #       define  STRDUP  wimlib_strdup
153 #else
154 #       include <stdlib.h>
155 #       include <string.h>
156 #       define  MALLOC  malloc
157 #       define  FREE    free
158 #       define  REALLOC realloc
159 #       define  CALLOC  calloc
160 #       define  STRDUP  strdup
161 #endif /* ENABLE_CUSTOM_MEMORY_ALLOCATOR */
162
163
164 /* encoding.c */
165
166 #ifdef WITH_NTFS_3G
167 static inline int iconv_global_init()
168 {
169         return 0;
170 }
171
172 static inline void iconv_global_cleanup() { }
173 #else
174 extern int iconv_global_init();
175 extern void iconv_global_cleanup();
176 #endif
177
178 extern int utf16_to_utf8(const char *utf16_str, size_t utf16_nbytes,
179                          char **utf8_str_ret, size_t *utf8_nbytes_ret);
180
181 extern int utf8_to_utf16(const char *utf8_str, size_t utf8_nbytes,
182                          char **utf16_str_ret, size_t *utf16_nbytes_ret);
183
184 /* util.c */
185 extern void randomize_byte_array(u8 *p, size_t n);
186
187 extern void randomize_char_array_with_alnum(char p[], size_t n);
188
189 extern const char *path_next_part(const char *path,
190                                   size_t *first_part_len_ret);
191
192 extern const char *path_basename(const char *path);
193
194 extern const char *path_stream_name(const char *path);
195
196 extern void to_parent_name(char buf[], size_t len);
197
198 extern void print_string(const void *string, size_t len);
199
200 extern int get_num_path_components(const char *path);
201
202 static inline void print_byte_field(const u8 field[], size_t len)
203 {
204         while (len--)
205                 printf("%02hhx", *field++);
206 }
207
208 static inline u32 bsr32(u32 n)
209 {
210 #if defined(__x86__) || defined(__x86_64__)
211         asm("bsrl %0, %0;"
212                         : "=r"(n)
213                         : "0" (n));
214         return n;
215 #else
216         u32 pow = 0;
217         while ((n >>= 1) != 0)
218                 pow++;
219         return pow;
220 #endif
221 }
222
223 #endif /* _WIMLIB_UTIL_H */