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 #define ARRAY_LEN(array) (sizeof(array) / sizeof((array)[0]))
  56
  57 #define ZERO_ARRAY(array) memset(array, 0, sizeof(array))
  58
  59 /* Used for buffering FILE IO in a few places */
  60 #define BUFFER_SIZE 4096
  61
  62 #ifdef ENABLE_ERROR_MESSAGES
  63 extern bool __wimlib_print_errors;
  64 extern void wimlib_error(const char *format, ...)
  65                 FORMAT(printf, 1, 2) COLD;
  66 extern void wimlib_error_with_errno(const char *format, ...)
  67                 FORMAT(printf, 1, 2) COLD;
  68 extern void wimlib_warning(const char *format, ...)
  69                 FORMAT(printf, 1, 2) COLD;
  70 #       define ERROR            wimlib_error
  71 #       define ERROR_WITH_ERRNO wimlib_error_with_errno
  72 #       define WARNING          wimlib_warning
  73 #else
  74 #       define ERROR(format, ...)
  75 #       define ERROR_WITH_ERRNO(format, ...)
  76 #       define WARNING(format, ...)
  77 #endif /* ENABLE_ERROR_MESSAGES */
  78
  79 #if defined(ENABLE_DEBUG) || defined(ENABLE_MORE_DEBUG)
  80 #       include <errno.h>
  81 #       define DEBUG(format, ...)                                       \
  82         ({                                                              \
  83                 int __errno_save = errno;                               \
  84                 fprintf(stdout, "[%s %d] %s(): " format,                \
  85                         __FILE__, __LINE__, __func__, ## __VA_ARGS__);  \
  86                 putchar('\n');                                          \
  87                 fflush(stdout);                                         \
  88                 errno = __errno_save;                                   \
  89         })
  90
  91 #else
  92 #       define DEBUG(format, ...)
  93 #endif /* ENABLE_DEBUG || ENABLE_MORE_DEBUG */
  94
  95 #ifdef ENABLE_MORE_DEBUG
  96 #       define DEBUG2(format, ...) DEBUG(format, ## __VA_ARGS__)
  97 #else
  98 #       define DEBUG2(format, ...)
  99 #endif /* ENABLE_DEBUG */
 100
 101 #ifdef ENABLE_ASSERTIONS
 102 #include <assert.h>
 103 #       define wimlib_assert(expr) assert(expr)
 104 #else
 105 #       define wimlib_assert(expr)
 106 #endif
 107
 108
 109 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
 110 extern void *(*wimlib_malloc_func)(size_t);
 111 extern void (*wimlib_free_func)(void *);
 112 extern void *(*wimlib_realloc_func)(void *, size_t);
 113 extern void *wimlib_calloc(size_t nmemb, size_t size);
 114 extern char *wimlib_strdup(const char *str);
 115 #       define  MALLOC  wimlib_malloc_func
 116 #       define  FREE    wimlib_free_func
 117 #       define  REALLOC wimlib_realloc_func
 118 #       define  CALLOC  wimlib_calloc
 119 #       define  STRDUP  wimlib_strdup
 120 #else
 121 #       include <stdlib.h>
 122 #       include <string.h>
 123 #       define  MALLOC  malloc
 124 #       define  FREE    free
 125 #       define  REALLOC realloc
 126 #       define  CALLOC  calloc
 127 #       define  STRDUP  strdup
 128 #endif /* ENABLE_CUSTOM_MEMORY_ALLOCATOR */
 129
 130
 131 extern char *utf16_to_utf8(const char *utf16_str, size_t utf16_len,
 132                            size_t *utf8_len_ret);
 133
 134 extern char *utf8_to_utf16(const char *utf8_str, size_t utf8_len,
 135                            size_t *utf16_len_ret);
 136
 137 extern void randomize_byte_array(u8 *p, size_t n);
 138
 139 extern void randomize_char_array_with_alnum(char p[], size_t n);
 140
 141 extern const char *path_next_part(const char *path,
 142                                   size_t *first_part_len_ret);
 143
 144 extern const char *path_basename(const char *path);
 145
 146 extern void to_parent_name(char buf[], size_t len);
 147
 148 extern void print_string(const void *string, size_t len);
 149
 150 extern int get_num_path_components(const char *path);
 151
 152 extern ssize_t full_write(int fd, const void *buf, size_t n);
 153
 154 static inline void print_byte_field(const u8 field[], size_t len)
 155 {
 156         while (len--)
 157                 printf("%02hhx", *field++);
 158 }
 159
 160
 161 #endif /* _WIMLIB_UTIL_H */