Various portability fixes
[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 NOINLINE __attribute__((noinline))
14 #       define ALWAYS_INLINE inline __attribute__((always_inline))
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 #               define HOT      __attribute__((hot))
20 #       else
21 #               define COLD
22 #               define HOT
23 #       endif
24 #else
25 #       define WIMLIBAPI
26 #       define NOINLINE
27 #       define ALWAYS_INLINE inline
28 #       define FORMAT(type, format_str, args_start)
29 #       define COLD
30 #       define HOT
31 #endif /* __GNUC__ */
32
33
34 #if 0
35 #ifdef WITH_FUSE
36 #define atomic_inc(ptr) \
37         __sync_fetch_and_add(ptr, 1)
38
39 #define atomic_dec(ptr) \
40         __sync_sub_and_fetch(ptr, 1)
41 #endif
42 #endif
43
44 #ifndef _NTFS_TYPES_H
45 typedef uint8_t  u8;
46 typedef uint16_t u16;
47 typedef uint32_t u32;
48 typedef uint64_t u64;
49 #endif
50 typedef unsigned uint;
51
52 #ifndef min
53 #define min(a, b) ({ typeof(a) __a = (a); typeof(b) __b = (b); \
54                                         (__a < __b) ? __a : __b; })
55 #endif
56
57 #ifndef max
58 #define max(a, b) ({ typeof(a) __a = (a); typeof(b) __b = (b); \
59                                         (__a > __b) ? __a : __b; })
60 #endif
61
62 #ifndef swap
63 #define swap(a, b) ({typeof(a) _a = a; (a) = (b); (b) = _a;})
64 #endif
65
66 /**
67  * container_of - cast a member of a structure out to the containing structure
68  * @ptr:        the pointer to the member.
69  * @type:       the type of the container struct this is embedded in.
70  * @member:     the name of the member within the struct.
71  *
72  */
73 #ifndef container_of
74 #define container_of(ptr, type, member) ({                      \
75         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
76         (type *)( (char *)__mptr - offsetof(type,member) );})
77 #endif
78
79 #define ARRAY_LEN(array) (sizeof(array) / sizeof((array)[0]))
80
81 #define ZERO_ARRAY(array) memset(array, 0, sizeof(array))
82
83 /* Used for buffering FILE IO in a few places */
84 #define BUFFER_SIZE 4096
85
86 #ifdef ENABLE_ERROR_MESSAGES
87 extern bool __wimlib_print_errors;
88 extern void wimlib_error(const char *format, ...)
89                 FORMAT(printf, 1, 2) COLD;
90 extern void wimlib_error_with_errno(const char *format, ...)
91                 FORMAT(printf, 1, 2) COLD;
92 extern void wimlib_warning(const char *format, ...)
93                 FORMAT(printf, 1, 2) COLD;
94 #       define ERROR            wimlib_error
95 #       define ERROR_WITH_ERRNO wimlib_error_with_errno
96 #       define WARNING          wimlib_warning
97 #else
98 #       define ERROR(format, ...)
99 #       define ERROR_WITH_ERRNO(format, ...)
100 #       define WARNING(format, ...)
101 #endif /* ENABLE_ERROR_MESSAGES */
102
103 #if defined(ENABLE_DEBUG) || defined(ENABLE_MORE_DEBUG)
104 #       include <errno.h>
105 #       define DEBUG(format, ...)                                       \
106         ({                                                              \
107                 int __errno_save = errno;                               \
108                 fprintf(stdout, "[%s %d] %s(): " format,                \
109                         __FILE__, __LINE__, __func__, ## __VA_ARGS__);  \
110                 putchar('\n');                                          \
111                 fflush(stdout);                                         \
112                 errno = __errno_save;                                   \
113         })
114
115 #else
116 #       define DEBUG(format, ...)
117 #endif /* ENABLE_DEBUG || ENABLE_MORE_DEBUG */
118
119 #ifdef ENABLE_MORE_DEBUG
120 #       define DEBUG2(format, ...) DEBUG(format, ## __VA_ARGS__)
121 #else
122 #       define DEBUG2(format, ...)
123 #endif /* ENABLE_DEBUG */
124
125 #ifdef ENABLE_ASSERTIONS
126 #include <assert.h>
127 #       define wimlib_assert(expr) assert(expr)
128 #else
129 #       define wimlib_assert(expr)
130 #endif
131
132
133 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
134 extern void *(*wimlib_malloc_func)(size_t);
135 extern void (*wimlib_free_func)(void *);
136 extern void *(*wimlib_realloc_func)(void *, size_t);
137 extern void *wimlib_calloc(size_t nmemb, size_t size);
138 extern char *wimlib_strdup(const char *str);
139 #       define  MALLOC  wimlib_malloc_func
140 #       define  FREE    wimlib_free_func
141 #       define  REALLOC wimlib_realloc_func
142 #       define  CALLOC  wimlib_calloc
143 #       define  STRDUP  wimlib_strdup
144 #else
145 #       include <stdlib.h>
146 #       include <string.h>
147 #       define  MALLOC  malloc
148 #       define  FREE    free
149 #       define  REALLOC realloc
150 #       define  CALLOC  calloc
151 #       define  STRDUP  strdup
152 #endif /* ENABLE_CUSTOM_MEMORY_ALLOCATOR */
153
154
155 extern char *utf16_to_utf8(const char *utf16_str, size_t utf16_len,
156                            size_t *utf8_len_ret);
157
158 extern char *utf8_to_utf16(const char *utf8_str, size_t utf8_len,
159                            size_t *utf16_len_ret);
160
161 extern void randomize_byte_array(u8 *p, size_t n);
162
163 extern void randomize_char_array_with_alnum(char p[], size_t n);
164
165 extern const char *path_next_part(const char *path,
166                                   size_t *first_part_len_ret);
167
168 extern const char *path_basename(const char *path);
169
170 extern const char *path_stream_name(const char *path);
171
172 extern void to_parent_name(char buf[], size_t len);
173
174 extern void print_string(const void *string, size_t len);
175
176 extern int get_num_path_components(const char *path);
177
178 extern ssize_t full_write(int fd, const void *buf, size_t n);
179
180 static inline void print_byte_field(const u8 field[], size_t len)
181 {
182         while (len--)
183                 printf("%02hhx", *field++);
184 }
185
186
187 #endif /* _WIMLIB_UTIL_H */