ua_config.h.in 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306
  1. /* This Source Code Form is subject to the terms of the Mozilla Public
  2. * License, v. 2.0. If a copy of the MPL was not distributed with this
  3. * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
  4. #ifndef UA_CONFIG_H_
  5. #define UA_CONFIG_H_
  6. #ifdef __cplusplus
  7. extern "C" {
  8. #endif
  9. /**
  10. * open62541 Version
  11. * ----------------- */
  12. #define UA_OPEN62541_VER_MAJOR ${OPEN62541_VER_MAJOR}
  13. #define UA_OPEN62541_VER_MINOR ${OPEN62541_VER_MINOR}
  14. #define UA_OPEN62541_VER_PATCH ${OPEN62541_VER_PATCH}
  15. #define UA_OPEN62541_VER_LABEL "${OPEN62541_VER_LABEL}" /* Release candidate label, etc. */
  16. #define UA_OPEN62541_VER_COMMIT "${OPEN62541_VER_COMMIT}"
  17. /**
  18. * Feature Options
  19. * ---------------
  20. * Changing the feature options has no effect on a pre-compiled library. */
  21. #define UA_LOGLEVEL ${UA_LOGLEVEL}
  22. #cmakedefine UA_ENABLE_METHODCALLS
  23. #cmakedefine UA_ENABLE_NODEMANAGEMENT
  24. #cmakedefine UA_ENABLE_SUBSCRIPTIONS
  25. #cmakedefine UA_ENABLE_MULTITHREADING
  26. #cmakedefine UA_ENABLE_ENCRYPTION
  27. /* Advanced Options */
  28. #cmakedefine UA_ENABLE_STATUSCODE_DESCRIPTIONS
  29. #cmakedefine UA_ENABLE_TYPENAMES
  30. #cmakedefine UA_ENABLE_DETERMINISTIC_RNG
  31. #cmakedefine UA_ENABLE_GENERATE_NAMESPACE0
  32. #cmakedefine UA_ENABLE_NONSTANDARD_UDP
  33. #cmakedefine UA_ENABLE_DISCOVERY
  34. #cmakedefine UA_ENABLE_DISCOVERY_MULTICAST
  35. #cmakedefine UA_ENABLE_DISCOVERY_SEMAPHORE
  36. #cmakedefine UA_ENABLE_UNIT_TEST_FAILURE_HOOKS
  37. #cmakedefine UA_ENABLE_VALGRIND_INTERACTIVE
  38. #define UA_VALGRIND_INTERACTIVE_INTERVAL ${UA_VALGRIND_INTERACTIVE_INTERVAL}
  39. /* Options for Debugging */
  40. #cmakedefine UA_DEBUG
  41. #cmakedefine UA_DEBUG_DUMP_PKGS
  42. /**
  43. * C99 Definitions
  44. * --------------- */
  45. #include <string.h>
  46. #include <stddef.h>
  47. /* Include stdint.h and stdbool.h or workaround for older Visual Studios */
  48. #if !defined(_MSC_VER) || _MSC_VER >= 1600
  49. # include <stdint.h>
  50. # include <stdbool.h> /* C99 Boolean */
  51. # if defined(_WRS_KERNEL)
  52. # define UINT32_C(x) ((x) + (UINT32_MAX - UINT32_MAX))
  53. # endif
  54. #else
  55. # include "ms_stdint.h"
  56. # if !defined(__bool_true_false_are_defined)
  57. # define bool short
  58. # define true 1
  59. # define false 0
  60. # define __bool_true_false_are_defined
  61. # endif
  62. #endif
  63. /**
  64. * Assertions
  65. * ----------
  66. * The assert macro is disabled by defining NDEBUG. It is often forgotten to
  67. * include -DNDEBUG in the compiler flags when using the single-file release. So
  68. * we make assertions dependent on the UA_DEBUG definition handled by CMake. */
  69. #ifdef UA_DEBUG
  70. # include <assert.h>
  71. # define UA_assert(ignore) assert(ignore)
  72. #else
  73. # define UA_assert(ignore)
  74. #endif
  75. /* Outputs an error message at compile time if the assert fails.
  76. * Example usage:
  77. * UA_STATIC_ASSERT(sizeof(long)==7, use_another_compiler_luke)
  78. * See: https://stackoverflow.com/a/4815532/869402 */
  79. #if defined(__cplusplus) && __cplusplus >= 201103L /* C++11 or above */
  80. # define UA_STATIC_ASSERT(cond,msg) static_assert(cond, #msg)
  81. #elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L /* C11 or above */
  82. # define UA_STATIC_ASSERT(cond,msg) _Static_assert(cond, #msg)
  83. #elif defined(__GNUC__) || defined(__clang__) || defined(_MSC_VER) /* GCC, Clang, MSC */
  84. # define UA_CTASTR2(pre,post) pre ## post
  85. # define UA_CTASTR(pre,post) UA_CTASTR2(pre,post)
  86. # define UA_STATIC_ASSERT(cond,msg) \
  87. typedef struct { \
  88. int UA_CTASTR(static_assertion_failed_,msg) : !!(cond); \
  89. } UA_CTASTR(static_assertion_failed_,__COUNTER__)
  90. #else /* Everybody else */
  91. # define UA_STATIC_ASSERT(cond,msg) typedef char static_assertion_##msg[(cond)?1:-1]
  92. #endif
  93. /**
  94. * Memory Management
  95. * -----------------
  96. * The default is to use the malloc implementation from ``stdlib.h``. Override
  97. * if required. Changing the settings has no effect on a pre-compiled
  98. * library. */
  99. #include <stdlib.h>
  100. #if defined(_WIN32) && !defined(__clang__)
  101. # include <malloc.h>
  102. #endif
  103. #if !defined(UA_FREERTOS)
  104. # define UA_free(ptr) free(ptr)
  105. # define UA_malloc(size) malloc(size)
  106. # define UA_calloc(num, size) calloc(num, size)
  107. # define UA_realloc(ptr, size) realloc(ptr, size)
  108. #else
  109. # include <FreeRTOS.h>
  110. # define UA_free(ptr) vPortFree(ptr)
  111. # define UA_malloc(size) pvPortMalloc(size)
  112. # define UA_calloc(num, size) pvPortCalloc(num, size)
  113. # define UA_realloc(ptr, size) pvPortRealloc(ptr, size)
  114. #endif
  115. #if defined(__GNUC__) || defined(__clang__)
  116. # define UA_alloca(size) __builtin_alloca (size)
  117. #elif defined(_WIN32)
  118. # define UA_alloca(SIZE) _alloca(SIZE)
  119. #else
  120. # include <alloca.h>
  121. # define UA_alloca(SIZE) alloca(SIZE)
  122. #endif
  123. /**
  124. * Function Export
  125. * ---------------
  126. * On Win32: Define ``UA_DYNAMIC_LINKING`` and ``UA_DYNAMIC_LINKING_EXPORT`` in
  127. * order to export symbols for a DLL. Define ``UA_DYNAMIC_LINKING`` only to
  128. * import symbols from a DLL.*/
  129. #cmakedefine UA_DYNAMIC_LINKING
  130. #if defined(_WIN32) && defined(UA_DYNAMIC_LINKING)
  131. # ifdef UA_DYNAMIC_LINKING_EXPORT /* export dll */
  132. # ifdef __GNUC__
  133. # define UA_EXPORT __attribute__ ((dllexport))
  134. # else
  135. # define UA_EXPORT __declspec(dllexport)
  136. # endif
  137. # else /* import dll */
  138. # ifdef __GNUC__
  139. # define UA_EXPORT __attribute__ ((dllimport))
  140. # else
  141. # define UA_EXPORT __declspec(dllimport)
  142. # endif
  143. # endif
  144. #else /* non win32 */
  145. # if __GNUC__ || __clang__
  146. # define UA_EXPORT __attribute__ ((visibility ("default")))
  147. # endif
  148. #endif
  149. #ifndef UA_EXPORT
  150. # define UA_EXPORT /* fallback to default */
  151. #endif
  152. /**
  153. * Inline Functions
  154. * ---------------- */
  155. #ifdef _MSC_VER
  156. # define UA_INLINE __inline
  157. #else
  158. # define UA_INLINE inline
  159. #endif
  160. /**
  161. * Non-aliasing pointers
  162. * -------------------- */
  163. #ifdef _MSC_VER
  164. # define UA_RESTRICT __restrict
  165. #elif defined(__GNUC__)
  166. # define UA_RESTRICT __restrict__
  167. #else
  168. # define UA_RESTRICT restrict
  169. #endif
  170. /**
  171. * Function attributes
  172. * ------------------- */
  173. #if defined(__GNUC__) || defined(__clang__)
  174. # define UA_FUNC_ATTR_MALLOC __attribute__((malloc))
  175. # define UA_FUNC_ATTR_PURE __attribute__ ((pure))
  176. # define UA_FUNC_ATTR_CONST __attribute__((const))
  177. # define UA_FUNC_ATTR_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
  178. # define UA_FORMAT(X,Y) __attribute__ ((format (printf, X, Y)))
  179. #else
  180. # define UA_FUNC_ATTR_MALLOC
  181. # define UA_FUNC_ATTR_PURE
  182. # define UA_FUNC_ATTR_CONST
  183. # define UA_FUNC_ATTR_WARN_UNUSED_RESULT
  184. # define UA_FORMAT(X,Y)
  185. #endif
  186. #if defined(__GNUC__) || defined(__clang__)
  187. # define UA_DEPRECATED __attribute__((deprecated))
  188. #elif defined(_MSC_VER)
  189. # define UA_DEPRECATED __declspec(deprecated)
  190. #else
  191. # define UA_DEPRECATED
  192. #endif
  193. /**
  194. * Detect Binary Overlaying for Encoding
  195. * -------------------------------------
  196. * Integers and floating point numbers are transmitted in little-endian (IEEE 754
  197. * for floating point) encoding. If the target architecture uses the same
  198. * format, numeral datatypes can be memcpy'd (overlayed) on the binary stream.
  199. * This speeds up encoding.
  200. *
  201. * Integer Endianness
  202. * ^^^^^^^^^^^^^^^^^^
  203. * The definition ``UA_BINARY_OVERLAYABLE_INTEGER`` is true when the integer
  204. * representation of the target architecture is little-endian. */
  205. #if defined(_WIN32)
  206. # define UA_BINARY_OVERLAYABLE_INTEGER 1
  207. #elif (defined(__BYTE_ORDER__) && defined(__ORDER_LITTLE_ENDIAN__) && \
  208. (__BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__))
  209. # define UA_BINARY_OVERLAYABLE_INTEGER 1
  210. #elif defined(__linux__) /* Linux (including Android) */
  211. # include <endian.h>
  212. # if __BYTE_ORDER == __LITTLE_ENDIAN
  213. # define UA_BINARY_OVERLAYABLE_INTEGER 1
  214. # endif
  215. #elif defined(__OpenBSD__) /* OpenBSD */
  216. # include <sys/endian.h>
  217. # if BYTE_ORDER == LITTLE_ENDIAN
  218. # define UA_BINARY_OVERLAYABLE_INTEGER 1
  219. # endif
  220. #elif defined(__NetBSD__) || defined(__FreeBSD__) || defined(__DragonFly__) /* Other BSD */
  221. # include <sys/endian.h>
  222. # if _BYTE_ORDER == _LITTLE_ENDIAN
  223. # define UA_BINARY_OVERLAYABLE_INTEGER 1
  224. # endif
  225. #elif defined(__APPLE__) /* Apple (MacOS, iOS) */
  226. # include <libkern/OSByteOrder.h>
  227. # if defined(__LITTLE_ENDIAN__)
  228. # define UA_BINARY_OVERLAYABLE_INTEGER 1
  229. # endif
  230. #elif defined(__QNX__) || defined(__QNXNTO__) /* QNX */
  231. # include <gulliver.h>
  232. # if defined(__LITTLEENDIAN__)
  233. # define UA_BINARY_OVERLAYABLE_INTEGER 1
  234. # endif
  235. #endif
  236. #ifndef UA_BINARY_OVERLAYABLE_INTEGER
  237. # define UA_BINARY_OVERLAYABLE_INTEGER 0
  238. #endif
  239. /**
  240. * Float Endianness
  241. * ^^^^^^^^^^^^^^^^
  242. * The definition ``UA_BINARY_OVERLAYABLE_FLOAT`` is true when the floating
  243. * point number representation of the target architecture is IEEE 754. Note that
  244. * this cannot be reliable detected with macros for the clang compiler
  245. * (beginning of 2017). ``UA_BINARY_OVERLAYABLE_FLOAT`` can be manually set if
  246. * the target is known to be little endian with floats in the IEEE 754
  247. * format. */
  248. #if defined(_WIN32)
  249. # define UA_BINARY_OVERLAYABLE_FLOAT 1
  250. #elif defined(__FLOAT_WORD_ORDER__) && defined(__ORDER_LITTLE_ENDIAN__) && \
  251. (__FLOAT_WORD_ORDER__ == __ORDER_LITTLE_ENDIAN__) /* Defined only in GCC */
  252. # define UA_BINARY_OVERLAYABLE_FLOAT 1
  253. #elif defined(__FLOAT_WORD_ORDER) && defined(__LITTLE_ENDIAN) && \
  254. (__FLOAT_WORD_ORDER == __LITTLE_ENDIAN) /* Defined only in GCC */
  255. # define UA_BINARY_OVERLAYABLE_FLOAT 1
  256. #elif defined(__linux__) /* Linux (including Android) */
  257. # include <endian.h>
  258. # if defined(__ANDROID__)
  259. # if __BYTE_ORDER == __LITTLE_ENDIAN
  260. # define UA_BINARY_OVERLAYABLE_INTEGER 1
  261. # endif
  262. # elif __FLOAT_WORD_ORDER == __LITTLE_ENDIAN
  263. # define UA_BINARY_OVERLAYABLE_FLOAT 1
  264. # endif
  265. #elif defined(_WRS_KERNEL)
  266. # define UA_BINARY_OVERLAYABLE_FLOAT 1
  267. #endif
  268. #ifndef UA_BINARY_OVERLAYABLE_FLOAT
  269. # define UA_BINARY_OVERLAYABLE_FLOAT 0
  270. #endif
  271. #ifdef __cplusplus
  272. } // extern "C"
  273. #endif
  274. #endif /* UA_CONFIG_H_ */