ua_types.h 34 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004
  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. *
  5. * Copyright 2014 (c) Leon Urbas
  6. * Copyright 2014, 2016-2017 (c) Florian Palm
  7. * Copyright 2014-2017 (c) Fraunhofer IOSB (Author: Julius Pfrommer)
  8. * Copyright 2015-2016 (c) Sten Grüner
  9. * Copyright 2015-2016 (c) Chris Iatrou
  10. * Copyright 2015 (c) Nick Goossens
  11. * Copyright 2015-2016 (c) Oleksiy Vasylyev
  12. * Copyright 2017 (c) Stefan Profanter, fortiss GmbH
  13. * Copyright 2017 (c) Thomas Stalder, Blue Time Concept SA
  14. */
  15. #ifndef UA_TYPES_H_
  16. #define UA_TYPES_H_
  17. #include "ua_config.h"
  18. #include "ua_constants.h"
  19. #include "ua_statuscodes.h"
  20. _UA_BEGIN_DECLS
  21. #define UA_BUILTIN_TYPES_COUNT 25U
  22. /**
  23. * .. _types:
  24. *
  25. * Data Types
  26. * ==========
  27. *
  28. * The OPC UA protocol defines 25 builtin data types and three ways of combining
  29. * them into higher-order types: arrays, structures and unions. In open62541,
  30. * only the builtin data types are defined manually. All other data types are
  31. * generated from standard XML definitions. Their exact definitions can be
  32. * looked up at https://opcfoundation.org/UA/schemas/Opc.Ua.Types.bsd.xml.
  33. *
  34. * For users that are new to open62541, take a look at the :ref:`tutorial for
  35. * working with data types<types-tutorial>` before diving into the
  36. * implementation details.
  37. *
  38. * Builtin Types
  39. * -------------
  40. *
  41. * Boolean
  42. * ^^^^^^^
  43. * A two-state logical value (true or false). */
  44. typedef bool UA_Boolean;
  45. #define UA_TRUE true UA_INTERNAL_DEPRECATED
  46. #define UA_FALSE false UA_INTERNAL_DEPRECATED
  47. /**
  48. * SByte
  49. * ^^^^^
  50. * An integer value between -128 and 127. */
  51. typedef int8_t UA_SByte;
  52. #define UA_SBYTE_MIN (-128)
  53. #define UA_SBYTE_MAX 127
  54. /**
  55. * Byte
  56. * ^^^^
  57. * An integer value between 0 and 255. */
  58. typedef uint8_t UA_Byte;
  59. #define UA_BYTE_MIN 0
  60. #define UA_BYTE_MAX 255
  61. /**
  62. * Int16
  63. * ^^^^^
  64. * An integer value between -32 768 and 32 767. */
  65. typedef int16_t UA_Int16;
  66. #define UA_INT16_MIN (-32768)
  67. #define UA_INT16_MAX 32767
  68. /**
  69. * UInt16
  70. * ^^^^^^
  71. * An integer value between 0 and 65 535. */
  72. typedef uint16_t UA_UInt16;
  73. #define UA_UINT16_MIN 0
  74. #define UA_UINT16_MAX 65535
  75. /**
  76. * Int32
  77. * ^^^^^
  78. * An integer value between -2 147 483 648 and 2 147 483 647. */
  79. typedef int32_t UA_Int32;
  80. #define UA_INT32_MIN (-2147483648)
  81. #define UA_INT32_MAX 2147483647
  82. /**
  83. * UInt32
  84. * ^^^^^^
  85. * An integer value between 0 and 4 294 967 295. */
  86. typedef uint32_t UA_UInt32;
  87. #define UA_UINT32_MIN 0
  88. #define UA_UINT32_MAX 4294967295
  89. /**
  90. * Int64
  91. * ^^^^^
  92. * An integer value between -9 223 372 036 854 775 808 and
  93. * 9 223 372 036 854 775 807. */
  94. typedef int64_t UA_Int64;
  95. #define UA_INT64_MIN ((int64_t)-9223372036854775808)
  96. #define UA_INT64_MAX (int64_t)9223372036854775807
  97. /**
  98. * UInt64
  99. * ^^^^^^
  100. * An integer value between 0 and 18 446 744 073 709 551 615. */
  101. typedef uint64_t UA_UInt64;
  102. #define UA_UINT64_MIN (int64_t)0
  103. #define UA_UINT64_MAX (int64_t)18446744073709551615
  104. /**
  105. * Float
  106. * ^^^^^
  107. * An IEEE single precision (32 bit) floating point value. */
  108. typedef float UA_Float;
  109. /**
  110. * Double
  111. * ^^^^^^
  112. * An IEEE double precision (64 bit) floating point value. */
  113. typedef double UA_Double;
  114. /**
  115. * .. _statuscode:
  116. *
  117. * StatusCode
  118. * ^^^^^^^^^^
  119. * A numeric identifier for a error or condition that is associated with a value
  120. * or an operation. See the section :ref:`statuscodes` for the meaning of a
  121. * specific code. */
  122. typedef uint32_t UA_StatusCode;
  123. /* Returns the human-readable name of the StatusCode. If no matching StatusCode
  124. * is found, a default string for "Unknown" is returned. This feature might be
  125. * disabled to create a smaller binary with the
  126. * UA_ENABLE_STATUSCODE_DESCRIPTIONS build-flag. Then the function returns an
  127. * empty string for every StatusCode. */
  128. UA_EXPORT const char *
  129. UA_StatusCode_name(UA_StatusCode code);
  130. /**
  131. * String
  132. * ^^^^^^
  133. * A sequence of Unicode characters. Strings are just an array of UA_Byte. */
  134. typedef struct {
  135. size_t length; /* The length of the string */
  136. UA_Byte *data; /* The content (not null-terminated) */
  137. } UA_String;
  138. /* Copies the content on the heap. Returns a null-string when alloc fails */
  139. UA_String UA_EXPORT UA_String_fromChars(char const src[]) UA_FUNC_ATTR_WARN_UNUSED_RESULT;
  140. UA_Boolean UA_EXPORT UA_String_equal(const UA_String *s1, const UA_String *s2);
  141. UA_EXPORT extern const UA_String UA_STRING_NULL;
  142. /**
  143. * ``UA_STRING`` returns a string pointing to the original char-array.
  144. * ``UA_STRING_ALLOC`` is shorthand for ``UA_String_fromChars`` and makes a copy
  145. * of the char-array. */
  146. static UA_INLINE UA_String
  147. UA_STRING(char *chars) {
  148. UA_String str; str.length = strlen(chars);
  149. str.data = (UA_Byte*)chars; return str;
  150. }
  151. #define UA_STRING_ALLOC(CHARS) UA_String_fromChars(CHARS)
  152. /* Define strings at compile time (in ROM) */
  153. #define UA_STRING_STATIC(CHARS) {sizeof(CHARS)-1, (UA_Byte*)CHARS}
  154. /**
  155. * .. _datetime:
  156. *
  157. * DateTime
  158. * ^^^^^^^^
  159. * An instance in time. A DateTime value is encoded as a 64-bit signed integer
  160. * which represents the number of 100 nanosecond intervals since January 1, 1601
  161. * (UTC).
  162. *
  163. * The methods providing an interface to the system clock are provided by a
  164. * "plugin" that is statically linked with the library. */
  165. typedef int64_t UA_DateTime;
  166. /* Multiples to convert durations to DateTime */
  167. #define UA_DATETIME_USEC 10LL
  168. #define UA_DATETIME_MSEC (UA_DATETIME_USEC * 1000LL)
  169. #define UA_DATETIME_SEC (UA_DATETIME_MSEC * 1000LL)
  170. /* The current time in UTC time */
  171. UA_DateTime UA_EXPORT UA_DateTime_now(void);
  172. /* Offset between local time and UTC time */
  173. UA_Int64 UA_EXPORT UA_DateTime_localTimeUtcOffset(void);
  174. /* CPU clock invariant to system time changes. Use only to measure durations,
  175. * not absolute time. */
  176. UA_DateTime UA_EXPORT UA_DateTime_nowMonotonic(void);
  177. /* Represents a Datetime as a structure */
  178. typedef struct UA_DateTimeStruct {
  179. UA_UInt16 nanoSec;
  180. UA_UInt16 microSec;
  181. UA_UInt16 milliSec;
  182. UA_UInt16 sec;
  183. UA_UInt16 min;
  184. UA_UInt16 hour;
  185. UA_UInt16 day;
  186. UA_UInt16 month;
  187. UA_UInt16 year;
  188. } UA_DateTimeStruct;
  189. UA_DateTimeStruct UA_EXPORT UA_DateTime_toStruct(UA_DateTime t);
  190. /* The C99 standard (7.23.1) says: "The range and precision of times
  191. * representable in clock_t and time_t are implementation-defined." On most
  192. * systems, time_t is a 4 or 8 byte integer counting seconds since the UTC Unix
  193. * epoch. The following methods are used for conversion. */
  194. /* Datetime of 1 Jan 1970 00:00 */
  195. #define UA_DATETIME_UNIX_EPOCH (11644473600LL * UA_DATETIME_SEC)
  196. static UA_INLINE UA_Int64
  197. UA_DateTime_toUnixTime(UA_DateTime date) {
  198. return (date - UA_DATETIME_UNIX_EPOCH) / UA_DATETIME_SEC;
  199. }
  200. static UA_INLINE UA_DateTime
  201. UA_DateTime_fromUnixTime(UA_Int64 unixDate) {
  202. return (unixDate * UA_DATETIME_SEC) + UA_DATETIME_UNIX_EPOCH;
  203. }
  204. /**
  205. * Guid
  206. * ^^^^
  207. * A 16 byte value that can be used as a globally unique identifier. */
  208. typedef struct {
  209. UA_UInt32 data1;
  210. UA_UInt16 data2;
  211. UA_UInt16 data3;
  212. UA_Byte data4[8];
  213. } UA_Guid;
  214. UA_Boolean UA_EXPORT UA_Guid_equal(const UA_Guid *g1, const UA_Guid *g2);
  215. UA_EXPORT extern const UA_Guid UA_GUID_NULL;
  216. /**
  217. * ByteString
  218. * ^^^^^^^^^^
  219. * A sequence of octets. */
  220. typedef UA_String UA_ByteString;
  221. static UA_INLINE UA_Boolean
  222. UA_ByteString_equal(const UA_ByteString *string1,
  223. const UA_ByteString *string2) {
  224. return UA_String_equal((const UA_String*)string1,
  225. (const UA_String*)string2);
  226. }
  227. /* Allocates memory of size length for the bytestring.
  228. * The content is not set to zero. */
  229. UA_StatusCode UA_EXPORT
  230. UA_ByteString_allocBuffer(UA_ByteString *bs, size_t length);
  231. UA_EXPORT extern const UA_ByteString UA_BYTESTRING_NULL;
  232. static UA_INLINE UA_ByteString
  233. UA_BYTESTRING(char *chars) {
  234. UA_ByteString str; str.length = strlen(chars);
  235. str.data = (UA_Byte*)chars; return str;
  236. }
  237. static UA_INLINE UA_ByteString
  238. UA_BYTESTRING_ALLOC(const char *chars) {
  239. UA_String str = UA_String_fromChars(chars); UA_ByteString bstr;
  240. bstr.length = str.length; bstr.data = str.data; return bstr;
  241. }
  242. /**
  243. * XmlElement
  244. * ^^^^^^^^^^
  245. * An XML element. */
  246. typedef UA_String UA_XmlElement;
  247. /**
  248. * .. _nodeid:
  249. *
  250. * NodeId
  251. * ^^^^^^
  252. * An identifier for a node in the address space of an OPC UA Server. */
  253. enum UA_NodeIdType {
  254. UA_NODEIDTYPE_NUMERIC = 0, /* In the binary encoding, this can also
  255. * become 1 or 2 (two-byte and four-byte
  256. * encoding of small numeric nodeids) */
  257. UA_NODEIDTYPE_STRING = 3,
  258. UA_NODEIDTYPE_GUID = 4,
  259. UA_NODEIDTYPE_BYTESTRING = 5
  260. };
  261. typedef struct {
  262. UA_UInt16 namespaceIndex;
  263. enum UA_NodeIdType identifierType;
  264. union {
  265. UA_UInt32 numeric;
  266. UA_String string;
  267. UA_Guid guid;
  268. UA_ByteString byteString;
  269. } identifier;
  270. } UA_NodeId;
  271. UA_EXPORT extern const UA_NodeId UA_NODEID_NULL;
  272. UA_Boolean UA_EXPORT UA_NodeId_isNull(const UA_NodeId *p);
  273. UA_Boolean UA_EXPORT UA_NodeId_equal(const UA_NodeId *n1, const UA_NodeId *n2);
  274. /* Returns a non-cryptographic hash for the NodeId */
  275. UA_UInt32 UA_EXPORT UA_NodeId_hash(const UA_NodeId *n);
  276. /** The following functions are shorthand for creating NodeIds. */
  277. static UA_INLINE UA_NodeId
  278. UA_NODEID_NUMERIC(UA_UInt16 nsIndex, UA_UInt32 identifier) {
  279. UA_NodeId id; id.namespaceIndex = nsIndex;
  280. id.identifierType = UA_NODEIDTYPE_NUMERIC;
  281. id.identifier.numeric = identifier; return id;
  282. }
  283. static UA_INLINE UA_NodeId
  284. UA_NODEID_STRING(UA_UInt16 nsIndex, char *chars) {
  285. UA_NodeId id; id.namespaceIndex = nsIndex;
  286. id.identifierType = UA_NODEIDTYPE_STRING;
  287. id.identifier.string = UA_STRING(chars); return id;
  288. }
  289. static UA_INLINE UA_NodeId
  290. UA_NODEID_STRING_ALLOC(UA_UInt16 nsIndex, const char *chars) {
  291. UA_NodeId id; id.namespaceIndex = nsIndex;
  292. id.identifierType = UA_NODEIDTYPE_STRING;
  293. id.identifier.string = UA_STRING_ALLOC(chars); return id;
  294. }
  295. static UA_INLINE UA_NodeId
  296. UA_NODEID_GUID(UA_UInt16 nsIndex, UA_Guid guid) {
  297. UA_NodeId id; id.namespaceIndex = nsIndex;
  298. id.identifierType = UA_NODEIDTYPE_GUID;
  299. id.identifier.guid = guid; return id;
  300. }
  301. static UA_INLINE UA_NodeId
  302. UA_NODEID_BYTESTRING(UA_UInt16 nsIndex, char *chars) {
  303. UA_NodeId id; id.namespaceIndex = nsIndex;
  304. id.identifierType = UA_NODEIDTYPE_BYTESTRING;
  305. id.identifier.byteString = UA_BYTESTRING(chars); return id;
  306. }
  307. static UA_INLINE UA_NodeId
  308. UA_NODEID_BYTESTRING_ALLOC(UA_UInt16 nsIndex, const char *chars) {
  309. UA_NodeId id; id.namespaceIndex = nsIndex;
  310. id.identifierType = UA_NODEIDTYPE_BYTESTRING;
  311. id.identifier.byteString = UA_BYTESTRING_ALLOC(chars); return id;
  312. }
  313. /**
  314. * ExpandedNodeId
  315. * ^^^^^^^^^^^^^^
  316. * A NodeId that allows the namespace URI to be specified instead of an index. */
  317. typedef struct {
  318. UA_NodeId nodeId;
  319. UA_String namespaceUri;
  320. UA_UInt32 serverIndex;
  321. } UA_ExpandedNodeId;
  322. UA_Boolean UA_EXPORT UA_ExpandedNodeId_equal(const UA_ExpandedNodeId *n1,
  323. const UA_ExpandedNodeId *n2);
  324. UA_EXPORT extern const UA_ExpandedNodeId UA_EXPANDEDNODEID_NULL;
  325. /** The following functions are shorthand for creating ExpandedNodeIds. */
  326. static UA_INLINE UA_ExpandedNodeId
  327. UA_EXPANDEDNODEID_NUMERIC(UA_UInt16 nsIndex, UA_UInt32 identifier) {
  328. UA_ExpandedNodeId id; id.nodeId = UA_NODEID_NUMERIC(nsIndex, identifier);
  329. id.serverIndex = 0; id.namespaceUri = UA_STRING_NULL; return id;
  330. }
  331. static UA_INLINE UA_ExpandedNodeId
  332. UA_EXPANDEDNODEID_STRING(UA_UInt16 nsIndex, char *chars) {
  333. UA_ExpandedNodeId id; id.nodeId = UA_NODEID_STRING(nsIndex, chars);
  334. id.serverIndex = 0; id.namespaceUri = UA_STRING_NULL; return id;
  335. }
  336. static UA_INLINE UA_ExpandedNodeId
  337. UA_EXPANDEDNODEID_STRING_ALLOC(UA_UInt16 nsIndex, const char *chars) {
  338. UA_ExpandedNodeId id; id.nodeId = UA_NODEID_STRING_ALLOC(nsIndex, chars);
  339. id.serverIndex = 0; id.namespaceUri = UA_STRING_NULL; return id;
  340. }
  341. static UA_INLINE UA_ExpandedNodeId
  342. UA_EXPANDEDNODEID_STRING_GUID(UA_UInt16 nsIndex, UA_Guid guid) {
  343. UA_ExpandedNodeId id; id.nodeId = UA_NODEID_GUID(nsIndex, guid);
  344. id.serverIndex = 0; id.namespaceUri = UA_STRING_NULL; return id;
  345. }
  346. static UA_INLINE UA_ExpandedNodeId
  347. UA_EXPANDEDNODEID_BYTESTRING(UA_UInt16 nsIndex, char *chars) {
  348. UA_ExpandedNodeId id; id.nodeId = UA_NODEID_BYTESTRING(nsIndex, chars);
  349. id.serverIndex = 0; id.namespaceUri = UA_STRING_NULL; return id;
  350. }
  351. static UA_INLINE UA_ExpandedNodeId
  352. UA_EXPANDEDNODEID_BYTESTRING_ALLOC(UA_UInt16 nsIndex, const char *chars) {
  353. UA_ExpandedNodeId id; id.nodeId = UA_NODEID_BYTESTRING_ALLOC(nsIndex, chars);
  354. id.serverIndex = 0; id.namespaceUri = UA_STRING_NULL; return id;
  355. }
  356. /**
  357. * .. _qualifiedname:
  358. *
  359. * QualifiedName
  360. * ^^^^^^^^^^^^^
  361. * A name qualified by a namespace. */
  362. typedef struct {
  363. UA_UInt16 namespaceIndex;
  364. UA_String name;
  365. } UA_QualifiedName;
  366. static UA_INLINE UA_Boolean
  367. UA_QualifiedName_isNull(const UA_QualifiedName *q) {
  368. return (q->namespaceIndex == 0 && q->name.length == 0);
  369. }
  370. static UA_INLINE UA_QualifiedName
  371. UA_QUALIFIEDNAME(UA_UInt16 nsIndex, char *chars) {
  372. UA_QualifiedName qn; qn.namespaceIndex = nsIndex;
  373. qn.name = UA_STRING(chars); return qn;
  374. }
  375. static UA_INLINE UA_QualifiedName
  376. UA_QUALIFIEDNAME_ALLOC(UA_UInt16 nsIndex, const char *chars) {
  377. UA_QualifiedName qn; qn.namespaceIndex = nsIndex;
  378. qn.name = UA_STRING_ALLOC(chars); return qn;
  379. }
  380. UA_Boolean UA_EXPORT
  381. UA_QualifiedName_equal(const UA_QualifiedName *qn1,
  382. const UA_QualifiedName *qn2);
  383. /**
  384. * LocalizedText
  385. * ^^^^^^^^^^^^^
  386. * Human readable text with an optional locale identifier. */
  387. typedef struct {
  388. UA_String locale;
  389. UA_String text;
  390. } UA_LocalizedText;
  391. static UA_INLINE UA_LocalizedText
  392. UA_LOCALIZEDTEXT(char *locale, char *text) {
  393. UA_LocalizedText lt; lt.locale = UA_STRING(locale);
  394. lt.text = UA_STRING(text); return lt;
  395. }
  396. static UA_INLINE UA_LocalizedText
  397. UA_LOCALIZEDTEXT_ALLOC(const char *locale, const char *text) {
  398. UA_LocalizedText lt; lt.locale = UA_STRING_ALLOC(locale);
  399. lt.text = UA_STRING_ALLOC(text); return lt;
  400. }
  401. /**
  402. * .. _numericrange:
  403. *
  404. * NumericRange
  405. * ^^^^^^^^^^^^
  406. *
  407. * NumericRanges are used to indicate subsets of a (multidimensional) array.
  408. * They no official data type in the OPC UA standard and are transmitted only
  409. * with a string encoding, such as "1:2,0:3,5". The colon separates min/max
  410. * index and the comma separates dimensions. A single value indicates a range
  411. * with a single element (min==max). */
  412. typedef struct {
  413. UA_UInt32 min;
  414. UA_UInt32 max;
  415. } UA_NumericRangeDimension;
  416. typedef struct {
  417. size_t dimensionsSize;
  418. UA_NumericRangeDimension *dimensions;
  419. } UA_NumericRange;
  420. UA_StatusCode UA_EXPORT
  421. UA_NumericRange_parseFromString(UA_NumericRange *range, const UA_String *str);
  422. /**
  423. * .. _variant:
  424. *
  425. * Variant
  426. * ^^^^^^^
  427. *
  428. * Variants may contain values of any type together with a description of the
  429. * content. See the section on :ref:`generic-types` on how types are described.
  430. * The standard mandates that variants contain built-in data types only. If the
  431. * value is not of a builtin type, it is wrapped into an :ref:`extensionobject`.
  432. * open62541 hides this wrapping transparently in the encoding layer. If the
  433. * data type is unknown to the receiver, the variant contains the original
  434. * ExtensionObject in binary or XML encoding.
  435. *
  436. * Variants may contain a scalar value or an array. For details on the handling
  437. * of arrays, see the section on :ref:`array-handling`. Array variants can have
  438. * an additional dimensionality (matrix, 3-tensor, ...) defined in an array of
  439. * dimension lengths. The actual values are kept in an array of dimensions one.
  440. * For users who work with higher-dimensions arrays directly, keep in mind that
  441. * dimensions of higher rank are serialized first (the highest rank dimension
  442. * has stride 1 and elements follow each other directly). Usually it is simplest
  443. * to interact with higher-dimensional arrays via ``UA_NumericRange``
  444. * descriptions (see :ref:`array-handling`).
  445. *
  446. * To differentiate between scalar / array variants, the following definition is
  447. * used. ``UA_Variant_isScalar`` provides simplified access to these checks.
  448. *
  449. * - ``arrayLength == 0 && data == NULL``: undefined array of length -1
  450. * - ``arrayLength == 0 && data == UA_EMPTY_ARRAY_SENTINEL``: array of length 0
  451. * - ``arrayLength == 0 && data > UA_EMPTY_ARRAY_SENTINEL``: scalar value
  452. * - ``arrayLength > 0``: array of the given length
  453. *
  454. * Variants can also be *empty*. Then, the pointer to the type description is
  455. * ``NULL``. */
  456. /* Forward declaration. See the section on Generic Type Handling */
  457. struct UA_DataType;
  458. typedef struct UA_DataType UA_DataType;
  459. #define UA_EMPTY_ARRAY_SENTINEL ((void*)0x01)
  460. typedef enum {
  461. UA_VARIANT_DATA, /* The data has the same lifecycle as the
  462. variant */
  463. UA_VARIANT_DATA_NODELETE /* The data is "borrowed" by the variant and
  464. shall not be deleted at the end of the
  465. variant's lifecycle. */
  466. } UA_VariantStorageType;
  467. typedef struct {
  468. const UA_DataType *type; /* The data type description */
  469. UA_VariantStorageType storageType;
  470. size_t arrayLength; /* The number of elements in the data array */
  471. void *data; /* Points to the scalar or array data */
  472. size_t arrayDimensionsSize; /* The number of dimensions */
  473. UA_UInt32 *arrayDimensions; /* The length of each dimension */
  474. } UA_Variant;
  475. /* Returns true if the variant has no value defined (contains neither an array
  476. * nor a scalar value).
  477. *
  478. * @param v The variant
  479. * @return Is the variant empty */
  480. static UA_INLINE UA_Boolean
  481. UA_Variant_isEmpty(const UA_Variant *v) {
  482. return v->type == NULL;
  483. }
  484. /* Returns true if the variant contains a scalar value. Note that empty variants
  485. * contain an array of length -1 (undefined).
  486. *
  487. * @param v The variant
  488. * @return Does the variant contain a scalar value */
  489. static UA_INLINE UA_Boolean
  490. UA_Variant_isScalar(const UA_Variant *v) {
  491. return (v->arrayLength == 0 && v->data > UA_EMPTY_ARRAY_SENTINEL);
  492. }
  493. /* Returns true if the variant contains a scalar value of the given type.
  494. *
  495. * @param v The variant
  496. * @param type The data type
  497. * @return Does the variant contain a scalar value of the given type */
  498. static UA_INLINE UA_Boolean
  499. UA_Variant_hasScalarType(const UA_Variant *v, const UA_DataType *type) {
  500. return UA_Variant_isScalar(v) && type == v->type;
  501. }
  502. /* Returns true if the variant contains an array of the given type.
  503. *
  504. * @param v The variant
  505. * @param type The data type
  506. * @return Does the variant contain an array of the given type */
  507. static UA_INLINE UA_Boolean
  508. UA_Variant_hasArrayType(const UA_Variant *v, const UA_DataType *type) {
  509. return (!UA_Variant_isScalar(v)) && type == v->type;
  510. }
  511. /* Set the variant to a scalar value that already resides in memory. The value
  512. * takes on the lifecycle of the variant and is deleted with it.
  513. *
  514. * @param v The variant
  515. * @param p A pointer to the value data
  516. * @param type The datatype of the value in question */
  517. void UA_EXPORT
  518. UA_Variant_setScalar(UA_Variant *v, void * UA_RESTRICT p,
  519. const UA_DataType *type);
  520. /* Set the variant to a scalar value that is copied from an existing variable.
  521. * @param v The variant
  522. * @param p A pointer to the value data
  523. * @param type The datatype of the value
  524. * @return Indicates whether the operation succeeded or returns an error code */
  525. UA_StatusCode UA_EXPORT
  526. UA_Variant_setScalarCopy(UA_Variant *v, const void *p,
  527. const UA_DataType *type);
  528. /* Set the variant to an array that already resides in memory. The array takes
  529. * on the lifecycle of the variant and is deleted with it.
  530. *
  531. * @param v The variant
  532. * @param array A pointer to the array data
  533. * @param arraySize The size of the array
  534. * @param type The datatype of the array */
  535. void UA_EXPORT
  536. UA_Variant_setArray(UA_Variant *v, void * UA_RESTRICT array,
  537. size_t arraySize, const UA_DataType *type);
  538. /* Set the variant to an array that is copied from an existing array.
  539. *
  540. * @param v The variant
  541. * @param array A pointer to the array data
  542. * @param arraySize The size of the array
  543. * @param type The datatype of the array
  544. * @return Indicates whether the operation succeeded or returns an error code */
  545. UA_StatusCode UA_EXPORT
  546. UA_Variant_setArrayCopy(UA_Variant *v, const void *array,
  547. size_t arraySize, const UA_DataType *type);
  548. /* Copy the variant, but use only a subset of the (multidimensional) array into
  549. * a variant. Returns an error code if the variant is not an array or if the
  550. * indicated range does not fit.
  551. *
  552. * @param src The source variant
  553. * @param dst The target variant
  554. * @param range The range of the copied data
  555. * @return Returns UA_STATUSCODE_GOOD or an error code */
  556. UA_StatusCode UA_EXPORT
  557. UA_Variant_copyRange(const UA_Variant *src, UA_Variant *dst,
  558. const UA_NumericRange range);
  559. /* Insert a range of data into an existing variant. The data array can't be
  560. * reused afterwards if it contains types without a fixed size (e.g. strings)
  561. * since the members are moved into the variant and take on its lifecycle.
  562. *
  563. * @param v The variant
  564. * @param dataArray The data array. The type must match the variant
  565. * @param dataArraySize The length of the data array. This is checked to match
  566. * the range size.
  567. * @param range The range of where the new data is inserted
  568. * @return Returns UA_STATUSCODE_GOOD or an error code */
  569. UA_StatusCode UA_EXPORT
  570. UA_Variant_setRange(UA_Variant *v, void * UA_RESTRICT array,
  571. size_t arraySize, const UA_NumericRange range);
  572. /* Deep-copy a range of data into an existing variant.
  573. *
  574. * @param v The variant
  575. * @param dataArray The data array. The type must match the variant
  576. * @param dataArraySize The length of the data array. This is checked to match
  577. * the range size.
  578. * @param range The range of where the new data is inserted
  579. * @return Returns UA_STATUSCODE_GOOD or an error code */
  580. UA_StatusCode UA_EXPORT
  581. UA_Variant_setRangeCopy(UA_Variant *v, const void *array,
  582. size_t arraySize, const UA_NumericRange range);
  583. /**
  584. * .. _extensionobject:
  585. *
  586. * ExtensionObject
  587. * ^^^^^^^^^^^^^^^
  588. *
  589. * ExtensionObjects may contain scalars of any data type. Even those that are
  590. * unknown to the receiver. See the section on :ref:`generic-types` on how types
  591. * are described. If the received data type is unknown, the encoded string and
  592. * target NodeId is stored instead of the decoded value. */
  593. typedef enum {
  594. UA_EXTENSIONOBJECT_ENCODED_NOBODY = 0,
  595. UA_EXTENSIONOBJECT_ENCODED_BYTESTRING = 1,
  596. UA_EXTENSIONOBJECT_ENCODED_XML = 2,
  597. UA_EXTENSIONOBJECT_DECODED = 3,
  598. UA_EXTENSIONOBJECT_DECODED_NODELETE = 4 /* Don't delete the content
  599. together with the
  600. ExtensionObject */
  601. } UA_ExtensionObjectEncoding;
  602. typedef struct {
  603. UA_ExtensionObjectEncoding encoding;
  604. union {
  605. struct {
  606. UA_NodeId typeId; /* The nodeid of the datatype */
  607. UA_ByteString body; /* The bytestring of the encoded data */
  608. } encoded;
  609. struct {
  610. const UA_DataType *type;
  611. void *data;
  612. } decoded;
  613. } content;
  614. } UA_ExtensionObject;
  615. /**
  616. * .. _datavalue:
  617. *
  618. * DataValue
  619. * ^^^^^^^^^
  620. * A data value with an associated status code and timestamps. */
  621. typedef struct {
  622. UA_Variant value;
  623. UA_DateTime sourceTimestamp;
  624. UA_DateTime serverTimestamp;
  625. UA_UInt16 sourcePicoseconds;
  626. UA_UInt16 serverPicoseconds;
  627. UA_StatusCode status;
  628. UA_Boolean hasValue : 1;
  629. UA_Boolean hasStatus : 1;
  630. UA_Boolean hasSourceTimestamp : 1;
  631. UA_Boolean hasServerTimestamp : 1;
  632. UA_Boolean hasSourcePicoseconds : 1;
  633. UA_Boolean hasServerPicoseconds : 1;
  634. } UA_DataValue;
  635. /**
  636. * DiagnosticInfo
  637. * ^^^^^^^^^^^^^^
  638. * A structure that contains detailed error and diagnostic information
  639. * associated with a StatusCode. */
  640. typedef struct UA_DiagnosticInfo {
  641. UA_Boolean hasSymbolicId : 1;
  642. UA_Boolean hasNamespaceUri : 1;
  643. UA_Boolean hasLocalizedText : 1;
  644. UA_Boolean hasLocale : 1;
  645. UA_Boolean hasAdditionalInfo : 1;
  646. UA_Boolean hasInnerStatusCode : 1;
  647. UA_Boolean hasInnerDiagnosticInfo : 1;
  648. UA_Int32 symbolicId;
  649. UA_Int32 namespaceUri;
  650. UA_Int32 localizedText;
  651. UA_Int32 locale;
  652. UA_String additionalInfo;
  653. UA_StatusCode innerStatusCode;
  654. struct UA_DiagnosticInfo *innerDiagnosticInfo;
  655. } UA_DiagnosticInfo;
  656. /**
  657. * .. _generic-types:
  658. *
  659. * Generic Type Handling
  660. * ---------------------
  661. *
  662. * All information about a (builtin/structured) data type is stored in a
  663. * ``UA_DataType``. The array ``UA_TYPES`` contains the description of all
  664. * standard-defined types. This type description is used for the following
  665. * generic operations that work on all types:
  666. *
  667. * - ``void T_init(T *ptr)``: Initialize the data type. This is synonymous with
  668. * zeroing out the memory, i.e. ``memset(ptr, 0, sizeof(T))``.
  669. * - ``T* T_new()``: Allocate and return the memory for the data type. The
  670. * value is already initialized.
  671. * - ``UA_StatusCode T_copy(const T *src, T *dst)``: Copy the content of the
  672. * data type. Returns ``UA_STATUSCODE_GOOD`` or
  673. * ``UA_STATUSCODE_BADOUTOFMEMORY``.
  674. * - ``void T_clear(T *ptr)``: Delete the dynamically allocated content
  675. * of the data type and perform a ``T_init`` to reset the type.
  676. * - ``void T_delete(T *ptr)``: Delete the content of the data type and the
  677. * memory for the data type itself.
  678. *
  679. * Specializations, such as ``UA_Int32_new()`` are derived from the generic
  680. * type operations as static inline functions. */
  681. typedef struct {
  682. #ifdef UA_ENABLE_TYPENAMES
  683. const char *memberName;
  684. #endif
  685. UA_UInt16 memberTypeIndex; /* Index of the member in the array of data
  686. types */
  687. UA_Byte padding; /* How much padding is there before this
  688. member element? For arrays this is the
  689. padding before the size_t length member.
  690. (No padding between size_t and the
  691. following ptr.) */
  692. UA_Boolean namespaceZero : 1; /* The type of the member is defined in
  693. namespace zero. In this implementation,
  694. types from custom namespace may contain
  695. members from the same namespace or
  696. namespace zero only.*/
  697. UA_Boolean isArray : 1; /* The member is an array */
  698. } UA_DataTypeMember;
  699. /* The DataType "kind" is an internal type classification. It is used to
  700. * dispatch handling to the correct routines. */
  701. #define UA_DATATYPEKINDS 31
  702. typedef enum {
  703. UA_DATATYPEKIND_BOOLEAN = 0,
  704. UA_DATATYPEKIND_SBYTE = 1,
  705. UA_DATATYPEKIND_BYTE = 2,
  706. UA_DATATYPEKIND_INT16 = 3,
  707. UA_DATATYPEKIND_UINT16 = 4,
  708. UA_DATATYPEKIND_INT32 = 5,
  709. UA_DATATYPEKIND_UINT32 = 6,
  710. UA_DATATYPEKIND_INT64 = 7,
  711. UA_DATATYPEKIND_UINT64 = 8,
  712. UA_DATATYPEKIND_FLOAT = 9,
  713. UA_DATATYPEKIND_DOUBLE = 10,
  714. UA_DATATYPEKIND_STRING = 11,
  715. UA_DATATYPEKIND_DATETIME = 12,
  716. UA_DATATYPEKIND_GUID = 13,
  717. UA_DATATYPEKIND_BYTESTRING = 14,
  718. UA_DATATYPEKIND_XMLELEMENT = 15,
  719. UA_DATATYPEKIND_NODEID = 16,
  720. UA_DATATYPEKIND_EXPANDEDNODEID = 17,
  721. UA_DATATYPEKIND_STATUSCODE = 18,
  722. UA_DATATYPEKIND_QUALIFIEDNAME = 19,
  723. UA_DATATYPEKIND_LOCALIZEDTEXT = 20,
  724. UA_DATATYPEKIND_EXTENSIONOBJECT = 21,
  725. UA_DATATYPEKIND_DATAVALUE = 22,
  726. UA_DATATYPEKIND_VARIANT = 23,
  727. UA_DATATYPEKIND_DIAGNOSTICINFO = 24,
  728. UA_DATATYPEKIND_DECIMAL = 25,
  729. UA_DATATYPEKIND_ENUM = 26,
  730. UA_DATATYPEKIND_STRUCTURE = 27,
  731. UA_DATATYPEKIND_OPTSTRUCT = 28, /* struct with optional fields */
  732. UA_DATATYPEKIND_UNION = 29,
  733. UA_DATATYPEKIND_BITFIELDCLUSTER = 30 /* bitfields + padding */
  734. } UA_DataTypeKind;
  735. struct UA_DataType {
  736. #ifdef UA_ENABLE_TYPENAMES
  737. const char *typeName;
  738. #endif
  739. UA_NodeId typeId; /* The nodeid of the type */
  740. UA_UInt16 memSize; /* Size of the struct in memory */
  741. UA_UInt16 typeIndex; /* Index of the type in the datatypetable */
  742. UA_UInt32 typeKind : 6; /* Dispatch index for the handling routines */
  743. UA_UInt32 pointerFree : 1; /* The type (and its members) contains no
  744. * pointers that need to be freed */
  745. UA_UInt32 overlayable : 1; /* The type has the identical memory layout
  746. * in memory and on the binary stream. */
  747. UA_UInt32 membersSize : 8; /* How many members does the type have? */
  748. UA_UInt32 binaryEncodingId : 16; /* NodeId of datatype when encoded as binary */
  749. //UA_UInt16 xmlEncodingId; /* NodeId of datatype when encoded as XML */
  750. UA_DataTypeMember *members;
  751. };
  752. /* Test if the data type is a numeric builtin data type. This includes Boolean,
  753. * integers and floating point numbers. Not included are DateTime and
  754. * StatusCode. */
  755. UA_Boolean
  756. UA_DataType_isNumeric(const UA_DataType *type);
  757. /**
  758. * Builtin data types can be accessed as UA_TYPES[UA_TYPES_XXX], where XXX is
  759. * the name of the data type. If only the NodeId of a type is known, use the
  760. * following method to retrieve the data type description. */
  761. /* Returns the data type description for the type's identifier or NULL if no
  762. * matching data type was found. */
  763. const UA_DataType UA_EXPORT *
  764. UA_findDataType(const UA_NodeId *typeId);
  765. /** The following functions are used for generic handling of data types. */
  766. /* Allocates and initializes a variable of type dataType
  767. *
  768. * @param type The datatype description
  769. * @return Returns the memory location of the variable or NULL if no
  770. * memory could be allocated */
  771. void UA_EXPORT * UA_new(const UA_DataType *type) UA_FUNC_ATTR_MALLOC;
  772. /* Initializes a variable to default values
  773. *
  774. * @param p The memory location of the variable
  775. * @param type The datatype description */
  776. static UA_INLINE void
  777. UA_init(void *p, const UA_DataType *type) {
  778. memset(p, 0, type->memSize);
  779. }
  780. /* Copies the content of two variables. If copying fails (e.g. because no memory
  781. * was available for an array), then dst is emptied and initialized to prevent
  782. * memory leaks.
  783. *
  784. * @param src The memory location of the source variable
  785. * @param dst The memory location of the destination variable
  786. * @param type The datatype description
  787. * @return Indicates whether the operation succeeded or returns an error code */
  788. UA_StatusCode UA_EXPORT
  789. UA_copy(const void *src, void *dst, const UA_DataType *type);
  790. /* Deletes the dynamically allocated content of a variable (e.g. resets all
  791. * arrays to undefined arrays). Afterwards, the variable can be safely deleted
  792. * without causing memory leaks. But the variable is not initialized and may
  793. * contain old data that is not memory-relevant.
  794. *
  795. * @param p The memory location of the variable
  796. * @param type The datatype description of the variable */
  797. void UA_EXPORT UA_clear(void *p, const UA_DataType *type);
  798. #define UA_deleteMembers(p, type) UA_clear(p, type)
  799. /* Frees a variable and all of its content.
  800. *
  801. * @param p The memory location of the variable
  802. * @param type The datatype description of the variable */
  803. void UA_EXPORT UA_delete(void *p, const UA_DataType *type);
  804. /**
  805. * .. _array-handling:
  806. *
  807. * Array handling
  808. * --------------
  809. * In OPC UA, arrays can have a length of zero or more with the usual meaning.
  810. * In addition, arrays can be undefined. Then, they don't even have a length. In
  811. * the binary encoding, this is indicated by an array of length -1.
  812. *
  813. * In open62541 however, we use ``size_t`` for array lengths. An undefined array
  814. * has length 0 and the data pointer is ``NULL``. An array of length 0 also has
  815. * length 0 but a data pointer ``UA_EMPTY_ARRAY_SENTINEL``. */
  816. /* Allocates and initializes an array of variables of a specific type
  817. *
  818. * @param size The requested array length
  819. * @param type The datatype description
  820. * @return Returns the memory location of the variable or NULL if no memory
  821. could be allocated */
  822. void UA_EXPORT *
  823. UA_Array_new(size_t size, const UA_DataType *type) UA_FUNC_ATTR_MALLOC;
  824. /* Allocates and copies an array
  825. *
  826. * @param src The memory location of the source array
  827. * @param size The size of the array
  828. * @param dst The location of the pointer to the new array
  829. * @param type The datatype of the array members
  830. * @return Returns UA_STATUSCODE_GOOD or UA_STATUSCODE_BADOUTOFMEMORY */
  831. UA_StatusCode UA_EXPORT
  832. UA_Array_copy(const void *src, size_t size, void **dst,
  833. const UA_DataType *type) UA_FUNC_ATTR_WARN_UNUSED_RESULT;
  834. /* Deletes an array.
  835. *
  836. * @param p The memory location of the array
  837. * @param size The size of the array
  838. * @param type The datatype of the array members */
  839. void UA_EXPORT UA_Array_delete(void *p, size_t size, const UA_DataType *type);
  840. /**
  841. * Random Number Generator
  842. * -----------------------
  843. * If UA_ENABLE_MULTITHREADING is defined, then the seed is stored in thread
  844. * local storage. The seed is initialized for every thread in the
  845. * server/client. */
  846. void UA_EXPORT UA_random_seed(UA_UInt64 seed);
  847. UA_UInt32 UA_EXPORT UA_UInt32_random(void); /* no cryptographic entropy */
  848. UA_Guid UA_EXPORT UA_Guid_random(void); /* no cryptographic entropy */
  849. /**
  850. * .. _generated-types:
  851. *
  852. * Generated Data Type Definitions
  853. * -------------------------------
  854. *
  855. * The following data types were auto-generated from a definition in XML format.
  856. */
  857. /* The following is used to exclude type names in the definition of UA_DataType
  858. * structures if the feature is disabled. */
  859. #ifdef UA_ENABLE_TYPENAMES
  860. # define UA_TYPENAME(name) name,
  861. #else
  862. # define UA_TYPENAME(name)
  863. #endif
  864. /* Datatype arrays with custom type definitions can be added in a linked list to
  865. * the client or server configuration. Datatype members can point to types in
  866. * the same array via the ``memberTypeIndex``. If ``namespaceZero`` is set to
  867. * true, the member datatype is looked up in the array of builtin datatypes
  868. * instead. */
  869. typedef struct UA_DataTypeArray {
  870. const struct UA_DataTypeArray *next;
  871. const size_t typesSize;
  872. const UA_DataType *types;
  873. } UA_DataTypeArray;
  874. /**
  875. *
  876. * .. toctree::
  877. *
  878. * types_generated */
  879. _UA_END_DECLS
  880. #endif /* UA_TYPES_H_ */