ua_config.h.in 8.8 KB

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