check.h 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277
  1. /* Check (assertions)
  2. * Portable Snippets - https://github.com/nemequ/portable-snippets
  3. * Created by Evan Nemerson <evan@nemerson.com>
  4. *
  5. * To the extent possible under law, the authors have waived all
  6. * copyright and related or neighboring rights to this code. For
  7. * details, see the Creative Commons Zero 1.0 Universal license at
  8. * https://creativecommons.org/publicdomain/zero/1.0/
  9. *
  10. * SPDX-License-Identifier: CC0-1.0
  11. */
  12. #if !defined(SIMDE_CHECK_H)
  13. #define SIMDE_CHECK_H
  14. #if !defined(SIMDE_NDEBUG) && !defined(SIMDE_DEBUG)
  15. # define SIMDE_NDEBUG 1
  16. #endif
  17. #include "hedley.h"
  18. #include "simde-diagnostic.h"
  19. #include <stdint.h>
  20. #if !defined(_WIN32)
  21. # define SIMDE_SIZE_MODIFIER "z"
  22. # define SIMDE_CHAR_MODIFIER "hh"
  23. # define SIMDE_SHORT_MODIFIER "h"
  24. #else
  25. # if defined(_M_X64) || defined(__amd64__)
  26. # define SIMDE_SIZE_MODIFIER "I64"
  27. # else
  28. # define SIMDE_SIZE_MODIFIER ""
  29. # endif
  30. # define SIMDE_CHAR_MODIFIER ""
  31. # define SIMDE_SHORT_MODIFIER ""
  32. #endif
  33. #if defined(_MSC_VER) && (_MSC_VER >= 1500)
  34. # define SIMDE_PUSH_DISABLE_MSVC_C4127_ __pragma(warning(push)) __pragma(warning(disable:4127))
  35. # define SIMDE_POP_DISABLE_MSVC_C4127_ __pragma(warning(pop))
  36. #else
  37. # define SIMDE_PUSH_DISABLE_MSVC_C4127_
  38. # define SIMDE_POP_DISABLE_MSVC_C4127_
  39. #endif
  40. #if !defined(simde_errorf)
  41. # if defined(__has_include)
  42. # if __has_include(<stdio.h>)
  43. # include <stdio.h>
  44. # endif
  45. # elif defined(SIMDE_STDC_HOSTED)
  46. # if SIMDE_STDC_HOSTED == 1
  47. # include <stdio.h>
  48. # endif
  49. # elif defined(__STDC_HOSTED__)
  50. # if __STDC_HOSTETD__ == 1
  51. # include <stdio.h>
  52. # endif
  53. # endif
  54. # include "debug-trap.h"
  55. HEDLEY_DIAGNOSTIC_PUSH
  56. SIMDE_DIAGNOSTIC_DISABLE_VARIADIC_MACROS_
  57. # if defined(EOF)
  58. # define simde_errorf(format, ...) (fprintf(stderr, format, __VA_ARGS__), abort())
  59. # else
  60. # define simde_errorf(format, ...) (simde_trap())
  61. # endif
  62. HEDLEY_DIAGNOSTIC_POP
  63. #endif
  64. #define simde_error(msg) simde_errorf("%s", msg)
  65. #if defined(SIMDE_NDEBUG) || \
  66. (defined(__cplusplus) && (__cplusplus < 201103L)) || \
  67. (defined(__STDC__) && (__STDC__ < 199901L))
  68. # if defined(SIMDE_CHECK_FAIL_DEFINED)
  69. # define simde_assert(expr)
  70. # else
  71. # if defined(HEDLEY_ASSUME)
  72. # define simde_assert(expr) HEDLEY_ASSUME(expr)
  73. # elif HEDLEY_GCC_VERSION_CHECK(4,5,0)
  74. # define simde_assert(expr) ((void) (!!(expr) ? 1 : (__builtin_unreachable(), 1)))
  75. # elif HEDLEY_MSVC_VERSION_CHECK(13,10,0)
  76. # define simde_assert(expr) __assume(expr)
  77. # else
  78. # define simde_assert(expr)
  79. # endif
  80. # endif
  81. # define simde_assert_true(expr) simde_assert(expr)
  82. # define simde_assert_false(expr) simde_assert(!(expr))
  83. # define simde_assert_type_full(prefix, suffix, T, fmt, a, op, b) simde_assert(((a) op (b)))
  84. # define simde_assert_double_equal(a, b, precision)
  85. # define simde_assert_string_equal(a, b)
  86. # define simde_assert_string_not_equal(a, b)
  87. # define simde_assert_memory_equal(size, a, b)
  88. # define simde_assert_memory_not_equal(size, a, b)
  89. #else
  90. # define simde_assert(expr) \
  91. do { \
  92. if (!HEDLEY_LIKELY(expr)) { \
  93. simde_error("assertion failed: " #expr "\n"); \
  94. } \
  95. SIMDE_PUSH_DISABLE_MSVC_C4127_ \
  96. } while (0) \
  97. SIMDE_POP_DISABLE_MSVC_C4127_
  98. # define simde_assert_true(expr) \
  99. do { \
  100. if (!HEDLEY_LIKELY(expr)) { \
  101. simde_error("assertion failed: " #expr " is not true\n"); \
  102. } \
  103. SIMDE_PUSH_DISABLE_MSVC_C4127_ \
  104. } while (0) \
  105. SIMDE_POP_DISABLE_MSVC_C4127_
  106. # define simde_assert_false(expr) \
  107. do { \
  108. if (!HEDLEY_LIKELY(!(expr))) { \
  109. simde_error("assertion failed: " #expr " is not false\n"); \
  110. } \
  111. SIMDE_PUSH_DISABLE_MSVC_C4127_ \
  112. } while (0) \
  113. SIMDE_POP_DISABLE_MSVC_C4127_
  114. # define simde_assert_type_full(prefix, suffix, T, fmt, a, op, b) \
  115. do { \
  116. T simde_tmp_a_ = (a); \
  117. T simde_tmp_b_ = (b); \
  118. if (!(simde_tmp_a_ op simde_tmp_b_)) { \
  119. simde_errorf("assertion failed: %s %s %s (" prefix "%" fmt suffix " %s " prefix "%" fmt suffix ")\n", \
  120. #a, #op, #b, simde_tmp_a_, #op, simde_tmp_b_); \
  121. } \
  122. SIMDE_PUSH_DISABLE_MSVC_C4127_ \
  123. } while (0) \
  124. SIMDE_POP_DISABLE_MSVC_C4127_
  125. # define simde_assert_double_equal(a, b, precision) \
  126. do { \
  127. const double simde_tmp_a_ = (a); \
  128. const double simde_tmp_b_ = (b); \
  129. const double simde_tmp_diff_ = ((simde_tmp_a_ - simde_tmp_b_) < 0) ? \
  130. -(simde_tmp_a_ - simde_tmp_b_) : \
  131. (simde_tmp_a_ - simde_tmp_b_); \
  132. if (HEDLEY_UNLIKELY(simde_tmp_diff_ > 1e-##precision)) { \
  133. simde_errorf("assertion failed: %s == %s (%0." #precision "g == %0." #precision "g)\n", \
  134. #a, #b, simde_tmp_a_, simde_tmp_b_); \
  135. } \
  136. SIMDE_PUSH_DISABLE_MSVC_C4127_ \
  137. } while (0) \
  138. SIMDE_POP_DISABLE_MSVC_C4127_
  139. # include <string.h>
  140. # define simde_assert_string_equal(a, b) \
  141. do { \
  142. const char* simde_tmp_a_ = a; \
  143. const char* simde_tmp_b_ = b; \
  144. if (HEDLEY_UNLIKELY(strcmp(simde_tmp_a_, simde_tmp_b_) != 0)) { \
  145. simde_errorf("assertion failed: string %s == %s (\"%s\" == \"%s\")\n", \
  146. #a, #b, simde_tmp_a_, simde_tmp_b_); \
  147. } \
  148. SIMDE_PUSH_DISABLE_MSVC_C4127_ \
  149. } while (0) \
  150. SIMDE_POP_DISABLE_MSVC_C4127_
  151. # define simde_assert_string_not_equal(a, b) \
  152. do { \
  153. const char* simde_tmp_a_ = a; \
  154. const char* simde_tmp_b_ = b; \
  155. if (HEDLEY_UNLIKELY(strcmp(simde_tmp_a_, simde_tmp_b_) == 0)) { \
  156. simde_errorf("assertion failed: string %s != %s (\"%s\" == \"%s\")\n", \
  157. #a, #b, simde_tmp_a_, simde_tmp_b_); \
  158. } \
  159. SIMDE_PUSH_DISABLE_MSVC_C4127_ \
  160. } while (0) \
  161. SIMDE_POP_DISABLE_MSVC_C4127_
  162. # define simde_assert_memory_equal(size, a, b) \
  163. do { \
  164. const unsigned char* simde_tmp_a_ = (const unsigned char*) (a); \
  165. const unsigned char* simde_tmp_b_ = (const unsigned char*) (b); \
  166. const size_t simde_tmp_size_ = (size); \
  167. if (HEDLEY_UNLIKELY(memcmp(simde_tmp_a_, simde_tmp_b_, simde_tmp_size_)) != 0) { \
  168. size_t simde_tmp_pos_; \
  169. for (simde_tmp_pos_ = 0 ; simde_tmp_pos_ < simde_tmp_size_ ; simde_tmp_pos_++) { \
  170. if (simde_tmp_a_[simde_tmp_pos_] != simde_tmp_b_[simde_tmp_pos_]) { \
  171. simde_errorf("assertion failed: memory %s == %s, at offset %" SIMDE_SIZE_MODIFIER "u\n", \
  172. #a, #b, simde_tmp_pos_); \
  173. break; \
  174. } \
  175. } \
  176. } \
  177. SIMDE_PUSH_DISABLE_MSVC_C4127_ \
  178. } while (0) \
  179. SIMDE_POP_DISABLE_MSVC_C4127_
  180. # define simde_assert_memory_not_equal(size, a, b) \
  181. do { \
  182. const unsigned char* simde_tmp_a_ = (const unsigned char*) (a); \
  183. const unsigned char* simde_tmp_b_ = (const unsigned char*) (b); \
  184. const size_t simde_tmp_size_ = (size); \
  185. if (HEDLEY_UNLIKELY(memcmp(simde_tmp_a_, simde_tmp_b_, simde_tmp_size_)) == 0) { \
  186. simde_errorf("assertion failed: memory %s != %s (%" SIMDE_SIZE_MODIFIER "u bytes)\n", \
  187. #a, #b, simde_tmp_size_); \
  188. } \
  189. SIMDE_PUSH_DISABLE_MSVC_C4127_ \
  190. } while (0) \
  191. SIMDE_POP_DISABLE_MSVC_C4127_
  192. #endif
  193. #define simde_assert_type(T, fmt, a, op, b) \
  194. simde_assert_type_full("", "", T, fmt, a, op, b)
  195. #define simde_assert_char(a, op, b) \
  196. simde_assert_type_full("'\\x", "'", char, "02" SIMDE_CHAR_MODIFIER "x", a, op, b)
  197. #define simde_assert_uchar(a, op, b) \
  198. simde_assert_type_full("'\\x", "'", unsigned char, "02" SIMDE_CHAR_MODIFIER "x", a, op, b)
  199. #define simde_assert_short(a, op, b) \
  200. simde_assert_type(short, SIMDE_SHORT_MODIFIER "d", a, op, b)
  201. #define simde_assert_ushort(a, op, b) \
  202. simde_assert_type(unsigned short, SIMDE_SHORT_MODIFIER "u", a, op, b)
  203. #define simde_assert_int(a, op, b) \
  204. simde_assert_type(int, "d", a, op, b)
  205. #define simde_assert_uint(a, op, b) \
  206. simde_assert_type(unsigned int, "u", a, op, b)
  207. #define simde_assert_long(a, op, b) \
  208. simde_assert_type(long int, "ld", a, op, b)
  209. #define simde_assert_ulong(a, op, b) \
  210. simde_assert_type(unsigned long int, "lu", a, op, b)
  211. #define simde_assert_llong(a, op, b) \
  212. simde_assert_type(long long int, "lld", a, op, b)
  213. #define simde_assert_ullong(a, op, b) \
  214. simde_assert_type(unsigned long long int, "llu", a, op, b)
  215. #define simde_assert_size(a, op, b) \
  216. simde_assert_type(size_t, SIMDE_SIZE_MODIFIER "u", a, op, b)
  217. #define simde_assert_float(a, op, b) \
  218. simde_assert_type(float, "f", a, op, b)
  219. #define simde_assert_double(a, op, b) \
  220. simde_assert_type(double, "g", a, op, b)
  221. #define simde_assert_ptr(a, op, b) \
  222. simde_assert_type(const void*, "p", a, op, b)
  223. #define simde_assert_int8(a, op, b) \
  224. simde_assert_type(int8_t, PRIi8, a, op, b)
  225. #define simde_assert_uint8(a, op, b) \
  226. simde_assert_type(uint8_t, PRIu8, a, op, b)
  227. #define simde_assert_int16(a, op, b) \
  228. simde_assert_type(int16_t, PRIi16, a, op, b)
  229. #define simde_assert_uint16(a, op, b) \
  230. simde_assert_type(uint16_t, PRIu16, a, op, b)
  231. #define simde_assert_int32(a, op, b) \
  232. simde_assert_type(int32_t, PRIi32, a, op, b)
  233. #define simde_assert_uint32(a, op, b) \
  234. simde_assert_type(uint32_t, PRIu32, a, op, b)
  235. #define simde_assert_int64(a, op, b) \
  236. simde_assert_type(int64_t, PRIi64, a, op, b)
  237. #define simde_assert_uint64(a, op, b) \
  238. simde_assert_type(uint64_t, PRIu64, a, op, b)
  239. #define simde_assert_ptr_equal(a, b) \
  240. simde_assert_ptr(a, ==, b)
  241. #define simde_assert_ptr_not_equal(a, b) \
  242. simde_assert_ptr(a, !=, b)
  243. #define simde_assert_null(ptr) \
  244. simde_assert_ptr(ptr, ==, NULL)
  245. #define simde_assert_not_null(ptr) \
  246. simde_assert_ptr(ptr, !=, NULL)
  247. #define simde_assert_ptr_null(ptr) \
  248. simde_assert_ptr(ptr, ==, NULL)
  249. #define simde_assert_ptr_not_null(ptr) \
  250. simde_assert_ptr(ptr, !=, NULL)
  251. #endif /* !defined(SIMDE_CHECK_H) */