wimlib.net Git - wimlib/blob - 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 #       if defined(__CYGWIN__) || defined(__WIN32__)
  13 #               define WIMLIBAPI __declspec(dllexport)
  14 #       else
  15 #               define WIMLIBAPI __attribute__((visibility("default")))
  16 #       endif
  17 #       define ALWAYS_INLINE inline __attribute__((always_inline))
  18 #       define PACKED __attribute__((packed))
  19 #       define FORMAT(type, format_str, args_start) \
  20                         __attribute__((format(type, format_str, args_start)))
  21 #       if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4)
  22 #               define COLD     __attribute__((cold))
  23 #       else
  24 #               define COLD
  25 #       endif
  26 #else
  27 #       define WIMLIBAPI
  28 #       define ALWAYS_INLINE inline
  29 #       define FORMAT(type, format_str, args_start)
  30 #       define COLD
  31 #       define PACKED
  32 #endif /* __GNUC__ */
  33
  34
  35 #if 0
  36 #ifdef WITH_FUSE
  37 #define atomic_inc(ptr) \
  38         __sync_fetch_and_add(ptr, 1)
  39
  40 #define atomic_dec(ptr) \
  41         __sync_sub_and_fetch(ptr, 1)
  42 #endif
  43 #endif
  44
  45 #ifndef _NTFS_TYPES_H
  46 typedef uint8_t  u8;
  47 typedef uint16_t u16;
  48 typedef uint32_t u32;
  49 typedef uint64_t u64;
  50 #endif
  51
  52 /* A pointer to 'mbchar' indicates a string of "multibyte characters" provided
  53  * in the default encoding of the user's locale, which may be "UTF-8",
  54  * "ISO-8859-1", "C", or any other ASCII-compatible encoding.
  55  * "ASCII-compatible" here means any encoding where all ASCII-representable
  56  * characters have the same representation as in ASCII itself, and any non-ASCII
  57  * character is represented as a sequence of one or more bytes not already used
  58  * by any ASCII character. */
  59 typedef char mbchar;
  60
  61 /* A pointer to 'utf8char' indicates a UTF-8 encoded string */
  62 typedef char utf8char;
  63
  64 /* Note: in some places in the code, strings of plain old 'char' are still used.
  65  * This means that the string is being operated on in an ASCII-compatible way,
  66  * and may be either a multibyte or UTF-8 string.  */
  67
  68 /* A pointer to 'utf16lechar' indicates a UTF-16LE encoded string */
  69 typedef u16 utf16lechar;
  70
  71 extern size_t
  72 utf16le_strlen(const utf16lechar *s);
  73
  74 /* encoding.c */
  75 extern void
  76 iconv_global_cleanup();
  77
  78 extern bool wimlib_mbs_is_utf8;
  79
  80 #define DECLARE_CHAR_CONVERSION_FUNCTIONS(varname1, varname2,           \
  81                                           chartype1, chartype2)         \
  82                                                                         \
  83 extern int                                                              \
  84 varname1##_to_##varname2##_nbytes(const chartype1 *in, size_t in_nbytes,\
  85                                   size_t *out_nbytes_ret);              \
  86                                                                         \
  87 extern int                                                              \
  88 varname1##_to_##varname2##_buf(const chartype1 *in, size_t in_nbytes,   \
  89                                chartype2 *out);                         \
  90                                                                         \
  91 extern int                                                              \
  92 varname1##_to_##varname2(const chartype1 *in, size_t in_nbytes,         \
  93                          chartype2 **out_ret,                           \
  94                          size_t *out_nbytes_ret);                       \
  95
  96 /* multi-byte string to UTF16-LE string */
  97 DECLARE_CHAR_CONVERSION_FUNCTIONS(mbs, utf16le, mbchar, utf16lechar);
  98
  99 /* UTF16-LE string to multi-byte string */
 100 DECLARE_CHAR_CONVERSION_FUNCTIONS(utf16le, mbs, utf16lechar, mbchar);
 101
 102 /* UTF-8 string to multi-byte string */
 103 DECLARE_CHAR_CONVERSION_FUNCTIONS(utf8, mbs, utf8char, mbchar);
 104
 105 extern bool
 106 utf8_str_contains_nonascii_chars(const utf8char *utf8_str);
 107
 108 #ifndef min
 109 #define min(a, b) ({ typeof(a) __a = (a); typeof(b) __b = (b); \
 110                                         (__a < __b) ? __a : __b; })
 111 #endif
 112
 113 #ifndef max
 114 #define max(a, b) ({ typeof(a) __a = (a); typeof(b) __b = (b); \
 115                                         (__a > __b) ? __a : __b; })
 116 #endif
 117
 118 #ifndef swap
 119 #define swap(a, b) ({typeof(a) _a = a; (a) = (b); (b) = _a;})
 120 #endif
 121
 122 /**
 123  * container_of - cast a member of a structure out to the containing structure
 124  * @ptr:        the pointer to the member.
 125  * @type:       the type of the container struct this is embedded in.
 126  * @member:     the name of the member within the struct.
 127  *
 128  */
 129 #ifndef container_of
 130 #define container_of(ptr, type, member) ({                      \
 131         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
 132         (type *)( (char *)__mptr - offsetof(type,member) );})
 133 #endif
 134
 135 #define DIV_ROUND_UP(numerator, denominator) \
 136         (((numerator) + (denominator) - 1) / (denominator))
 137
 138 #define MODULO_NONZERO(numerator, denominator) \
 139         (((numerator) % (denominator)) ? ((numerator) % (denominator)) : (denominator))
 140
 141 #define ARRAY_LEN(array) (sizeof(array) / sizeof((array)[0]))
 142
 143 #define ZERO_ARRAY(array) memset(array, 0, sizeof(array))
 144
 145 /* Used for buffering FILE IO in a few places */
 146 #define BUFFER_SIZE 4096
 147
 148 static inline void FORMAT(printf, 1, 2)
 149 dummy_printf(const char *format, ...)
 150 {
 151 }
 152
 153 #ifdef ENABLE_ERROR_MESSAGES
 154 extern void
 155 wimlib_error(const char *format, ...) FORMAT(printf, 1, 2) COLD;
 156
 157 extern void
 158 wimlib_error_with_errno(const char *format, ...) FORMAT(printf, 1, 2) COLD;
 159
 160 extern void
 161 wimlib_warning(const char *format, ...) FORMAT(printf, 1, 2) COLD;
 162
 163 extern void
 164 wimlib_warning_with_errno(const char *format, ...) FORMAT(printf, 1, 2) COLD;
 165 #  define ERROR                 wimlib_error
 166 #  define ERROR_WITH_ERRNO      wimlib_error_with_errno
 167 #  define WARNING               wimlib_warning
 168 #  define WARNING_WITH_ERRNO    wimlib_warning
 169 #else /* ENABLE_ERROR_MESSAGES */
 170 #  define ERROR(format, ...)                    dummy_printf(format, ## __VA_ARGS__)
 171 #  define ERROR_WITH_ERRNO(format, ...)         dummy_printf(format, ## __VA_ARGS__)
 172 #  define WARNING(format, ...)                  dummy_printf(format, ## __VA_ARGS__)
 173 #  define WARNING_WITH_ERRNO(format, ...)       dummy_printf(format, ## __VA_ARGS__)
 174 #endif /* !ENABLE_ERROR_MESSAGES */
 175
 176 #if defined(ENABLE_DEBUG) || defined(ENABLE_MORE_DEBUG)
 177 extern void
 178 wimlib_debug(const char *file, int line, const char *func,
 179              const char *format, ...);
 180 #  define DEBUG(format, ...) \
 181                 wimlib_debug(__FILE__, __LINE__, __func__, format, ## __VA_ARGS__);
 182
 183 #else
 184 #  define DEBUG(format, ...) dummy_printf(format, ## __VA_ARGS__)
 185 #endif /* ENABLE_DEBUG || ENABLE_MORE_DEBUG */
 186
 187 #ifdef ENABLE_MORE_DEBUG
 188 #  define DEBUG2(format, ...) DEBUG(format, ## __VA_ARGS__)
 189 #else
 190 #  define DEBUG2(format, ...) dummy_printf(format, ## __VA_ARGS__)
 191 #endif /* ENABLE_DEBUG */
 192
 193 #ifdef ENABLE_ASSERTIONS
 194 #include <assert.h>
 195 #  define wimlib_assert(expr) assert(expr)
 196 #else
 197 #  define wimlib_assert(expr)
 198 #endif
 199
 200 #ifdef ENABLE_MORE_ASSERTIONS
 201 #  define wimlib_assert2(expr) wimlib_assert(expr)
 202 #else
 203 #  define wimlib_assert2(expr)
 204 #endif
 205
 206 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
 207
 208 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
 209 extern void *(*wimlib_malloc_func)(size_t);
 210 extern void (*wimlib_free_func)(void *);
 211 extern void *(*wimlib_realloc_func)(void *, size_t);
 212 extern void *wimlib_calloc(size_t nmemb, size_t size);
 213 extern char *wimlib_strdup(const char *str);
 214 #  define       MALLOC  wimlib_malloc_func
 215 #  define       FREE    wimlib_free_func
 216 #  define       REALLOC wimlib_realloc_func
 217 #  define       CALLOC  wimlib_calloc
 218 #  define       STRDUP  wimlib_strdup
 219 #else /* ENABLE_CUSTOM_MEMORY_ALLOCATOR */
 220 #  include <stdlib.h>
 221 #  include <string.h>
 222 #  define       MALLOC  malloc
 223 #  define       FREE    free
 224 #  define       REALLOC realloc
 225 #  define       CALLOC  calloc
 226 #  define       STRDUP  strdup
 227 #endif /* !ENABLE_CUSTOM_MEMORY_ALLOCATOR */
 228
 229
 230 /* util.c */
 231 extern void
 232 randomize_byte_array(u8 *p, size_t n);
 233
 234 extern void
 235 randomize_char_array_with_alnum(char p[], size_t n);
 236
 237 extern const char *
 238 path_next_part(const char *path, size_t *first_part_len_ret);
 239
 240 extern const char *
 241 path_basename(const char *path);
 242
 243 extern const char *
 244 path_stream_name(const char *path);
 245
 246 extern void
 247 to_parent_name(char buf[], size_t len);
 248
 249 extern void
 250 print_string(const void *string, size_t len);
 251
 252 extern int
 253 get_num_path_components(const char *path);
 254
 255 static inline void
 256 print_byte_field(const u8 field[], size_t len)
 257 {
 258         while (len--)
 259                 printf("%02hhx", *field++);
 260 }
 261
 262 static inline u32
 263 bsr32(u32 n)
 264 {
 265 #if defined(__x86__) || defined(__x86_64__)
 266         asm("bsrl %0, %0;"
 267                         : "=r"(n)
 268                         : "0" (n));
 269         return n;
 270 #else
 271         u32 pow = 0;
 272         while ((n >>= 1) != 0)
 273                 pow++;
 274         return pow;
 275 #endif
 276 }
 277
 278 extern int
 279 wimlib_fprintf(FILE *fp, const char *format, ...)
 280         //FORMAT(printf, 2, 3)
 281         ;
 282
 283 extern int
 284 wimlib_printf(const char *format, ...)
 285         //FORMAT(printf, 1, 2)
 286         ;
 287
 288 #endif /* _WIMLIB_UTIL_H */