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