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