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