ua_types.c 36 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066
  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. #include "ua_util.h"
  5. #include "ua_types.h"
  6. #include "ua_types_generated.h"
  7. #include "ua_types_generated_handling.h"
  8. #include "pcg_basic.h"
  9. #include "libc_time.h"
  10. /* Datatype Handling
  11. * -----------------
  12. * This file contains handling functions for the builtin types and functions
  13. * handling of structured types and arrays. These need type descriptions in a
  14. * UA_DataType structure. The UA_DataType structures as well as all non-builtin
  15. * datatypes are autogenerated. */
  16. /* Global definition of NULL type instances. These are always zeroed out, as
  17. * mandated by the C/C++ standard for global values with no initializer. */
  18. const UA_String UA_STRING_NULL = {0, NULL};
  19. const UA_ByteString UA_BYTESTRING_NULL = {0, NULL};
  20. const UA_Guid UA_GUID_NULL = {0, 0, 0, {0,0,0,0,0,0,0,0}};
  21. const UA_NodeId UA_NODEID_NULL = {0, UA_NODEIDTYPE_NUMERIC, {0}};
  22. const UA_ExpandedNodeId UA_EXPANDEDNODEID_NULL = {{0, UA_NODEIDTYPE_NUMERIC, {0}}, {0, NULL}, 0};
  23. /* TODO: The standard-defined types are ordered. See if binary search is
  24. * more efficient. */
  25. const UA_DataType *
  26. UA_findDataType(const UA_NodeId *typeId) {
  27. if(typeId->identifierType != UA_NODEIDTYPE_NUMERIC ||
  28. typeId->namespaceIndex != 0)
  29. return NULL;
  30. for(size_t i = 0; i < UA_TYPES_COUNT; ++i) {
  31. if(UA_TYPES[i].typeId.identifier.numeric == typeId->identifier.numeric)
  32. return &UA_TYPES[i];
  33. }
  34. return NULL;
  35. }
  36. /***************************/
  37. /* Random Number Generator */
  38. /***************************/
  39. static UA_THREAD_LOCAL pcg32_random_t UA_rng = PCG32_INITIALIZER;
  40. void
  41. UA_random_seed(u64 seed) {
  42. pcg32_srandom_r(&UA_rng, seed, (u64)UA_DateTime_now());
  43. }
  44. u32
  45. UA_UInt32_random(void) {
  46. return (u32)pcg32_random_r(&UA_rng);
  47. }
  48. /*****************/
  49. /* Builtin Types */
  50. /*****************/
  51. static void deleteMembers_noInit(void *p, const UA_DataType *type);
  52. static UA_StatusCode copy_noInit(const void *src, void *dst, const UA_DataType *type);
  53. UA_String
  54. UA_String_fromChars(char const src[]) {
  55. UA_String str;
  56. str.length = strlen(src);
  57. if(str.length > 0) {
  58. str.data = (u8*)UA_malloc(str.length);
  59. if(!str.data)
  60. return UA_STRING_NULL;
  61. memcpy(str.data, src, str.length);
  62. } else {
  63. str.data = (u8*)UA_EMPTY_ARRAY_SENTINEL;
  64. }
  65. return str;
  66. }
  67. UA_Boolean
  68. UA_String_equal(const UA_String *s1, const UA_String *s2) {
  69. if(s1->length != s2->length)
  70. return false;
  71. i32 is = memcmp((char const*)s1->data,
  72. (char const*)s2->data, s1->length);
  73. return (is == 0) ? true : false;
  74. }
  75. static void
  76. String_deleteMembers(UA_String *s, const UA_DataType *_) {
  77. UA_free((void*)((uintptr_t)s->data & ~(uintptr_t)UA_EMPTY_ARRAY_SENTINEL));
  78. }
  79. /* DateTime */
  80. UA_DateTimeStruct
  81. UA_DateTime_toStruct(UA_DateTime t) {
  82. /* Calculating the the milli-, micro- and nanoseconds */
  83. UA_DateTimeStruct dateTimeStruct;
  84. dateTimeStruct.nanoSec = (u16)((t % 10) * 100);
  85. dateTimeStruct.microSec = (u16)((t % 10000) / 10);
  86. dateTimeStruct.milliSec = (u16)((t % 10000000) / 10000);
  87. /* Calculating the unix time with #include <time.h> */
  88. long long secSinceUnixEpoch = (long long)
  89. ((t - UA_DATETIME_UNIX_EPOCH) / UA_DATETIME_SEC);
  90. struct mytm ts;
  91. memset(&ts, 0, sizeof(struct mytm));
  92. __secs_to_tm(secSinceUnixEpoch, &ts);
  93. dateTimeStruct.sec = (u16)ts.tm_sec;
  94. dateTimeStruct.min = (u16)ts.tm_min;
  95. dateTimeStruct.hour = (u16)ts.tm_hour;
  96. dateTimeStruct.day = (u16)ts.tm_mday;
  97. dateTimeStruct.month = (u16)(ts.tm_mon + 1);
  98. dateTimeStruct.year = (u16)(ts.tm_year + 1900);
  99. return dateTimeStruct;
  100. }
  101. static void
  102. printNumber(u16 n, u8 *pos, size_t digits) {
  103. for(size_t i = digits; i > 0; --i) {
  104. pos[i-1] = (u8)((n % 10) + '0');
  105. n = n / 10;
  106. }
  107. }
  108. UA_String
  109. UA_DateTime_toString(UA_DateTime t) {
  110. /* length of the string is 31 (plus \0 at the end) */
  111. UA_String str = {31, (u8*)UA_malloc(32)};
  112. if(!str.data)
  113. return UA_STRING_NULL;
  114. UA_DateTimeStruct tSt = UA_DateTime_toStruct(t);
  115. printNumber(tSt.month, str.data, 2);
  116. str.data[2] = '/';
  117. printNumber(tSt.day, &str.data[3], 2);
  118. str.data[5] = '/';
  119. printNumber(tSt.year, &str.data[6], 4);
  120. str.data[10] = ' ';
  121. printNumber(tSt.hour, &str.data[11], 2);
  122. str.data[13] = ':';
  123. printNumber(tSt.min, &str.data[14], 2);
  124. str.data[16] = ':';
  125. printNumber(tSt.sec, &str.data[17], 2);
  126. str.data[19] = '.';
  127. printNumber(tSt.milliSec, &str.data[20], 3);
  128. str.data[23] = '.';
  129. printNumber(tSt.microSec, &str.data[24], 3);
  130. str.data[27] = '.';
  131. printNumber(tSt.nanoSec, &str.data[28], 3);
  132. return str;
  133. }
  134. /* Guid */
  135. UA_Boolean
  136. UA_Guid_equal(const UA_Guid *g1, const UA_Guid *g2) {
  137. if(memcmp(g1, g2, sizeof(UA_Guid)) == 0)
  138. return true;
  139. return false;
  140. }
  141. UA_Guid
  142. UA_Guid_random(void) {
  143. UA_Guid result;
  144. result.data1 = (u32)pcg32_random_r(&UA_rng);
  145. u32 r = (u32)pcg32_random_r(&UA_rng);
  146. result.data2 = (u16) r;
  147. result.data3 = (u16) (r >> 16);
  148. r = (u32)pcg32_random_r(&UA_rng);
  149. result.data4[0] = (u8)r;
  150. result.data4[1] = (u8)(r >> 4);
  151. result.data4[2] = (u8)(r >> 8);
  152. result.data4[3] = (u8)(r >> 12);
  153. r = (u32)pcg32_random_r(&UA_rng);
  154. result.data4[4] = (u8)r;
  155. result.data4[5] = (u8)(r >> 4);
  156. result.data4[6] = (u8)(r >> 8);
  157. result.data4[7] = (u8)(r >> 12);
  158. return result;
  159. }
  160. /* ByteString */
  161. UA_StatusCode
  162. UA_ByteString_allocBuffer(UA_ByteString *bs, size_t length) {
  163. UA_ByteString_init(bs);
  164. if(length == 0)
  165. return UA_STATUSCODE_GOOD;
  166. bs->data = (u8*)UA_malloc(length);
  167. if(!bs->data)
  168. return UA_STATUSCODE_BADOUTOFMEMORY;
  169. bs->length = length;
  170. return UA_STATUSCODE_GOOD;
  171. }
  172. /* NodeId */
  173. static void
  174. NodeId_deleteMembers(UA_NodeId *p, const UA_DataType *_) {
  175. switch(p->identifierType) {
  176. case UA_NODEIDTYPE_STRING:
  177. case UA_NODEIDTYPE_BYTESTRING:
  178. String_deleteMembers(&p->identifier.string, NULL);
  179. break;
  180. default: break;
  181. }
  182. }
  183. static UA_StatusCode
  184. NodeId_copy(UA_NodeId const *src, UA_NodeId *dst, const UA_DataType *_) {
  185. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  186. switch(src->identifierType) {
  187. case UA_NODEIDTYPE_NUMERIC:
  188. *dst = *src;
  189. return UA_STATUSCODE_GOOD;
  190. case UA_NODEIDTYPE_STRING:
  191. retval |= UA_String_copy(&src->identifier.string,
  192. &dst->identifier.string);
  193. break;
  194. case UA_NODEIDTYPE_GUID:
  195. retval |= UA_Guid_copy(&src->identifier.guid, &dst->identifier.guid);
  196. break;
  197. case UA_NODEIDTYPE_BYTESTRING:
  198. retval |= UA_ByteString_copy(&src->identifier.byteString,
  199. &dst->identifier.byteString);
  200. break;
  201. default:
  202. return UA_STATUSCODE_BADINTERNALERROR;
  203. }
  204. dst->namespaceIndex = src->namespaceIndex;
  205. dst->identifierType = src->identifierType;
  206. return retval;
  207. }
  208. UA_Boolean
  209. UA_NodeId_isNull(const UA_NodeId *p) {
  210. if(p->namespaceIndex != 0)
  211. return false;
  212. switch(p->identifierType) {
  213. case UA_NODEIDTYPE_NUMERIC:
  214. return (p->identifier.numeric == 0);
  215. case UA_NODEIDTYPE_GUID:
  216. return (p->identifier.guid.data1 == 0 &&
  217. p->identifier.guid.data2 == 0 &&
  218. p->identifier.guid.data3 == 0 &&
  219. p->identifier.guid.data4[0] == 0 &&
  220. p->identifier.guid.data4[1] == 0 &&
  221. p->identifier.guid.data4[2] == 0 &&
  222. p->identifier.guid.data4[3] == 0 &&
  223. p->identifier.guid.data4[4] == 0 &&
  224. p->identifier.guid.data4[5] == 0 &&
  225. p->identifier.guid.data4[6] == 0 &&
  226. p->identifier.guid.data4[7] == 0);
  227. default:
  228. break;
  229. }
  230. return (p->identifier.string.length == 0);
  231. }
  232. UA_Boolean
  233. UA_NodeId_equal(const UA_NodeId *n1, const UA_NodeId *n2) {
  234. if(n1->namespaceIndex != n2->namespaceIndex ||
  235. n1->identifierType!=n2->identifierType)
  236. return false;
  237. switch(n1->identifierType) {
  238. case UA_NODEIDTYPE_NUMERIC:
  239. if(n1->identifier.numeric == n2->identifier.numeric)
  240. return true;
  241. else
  242. return false;
  243. case UA_NODEIDTYPE_STRING:
  244. return UA_String_equal(&n1->identifier.string,
  245. &n2->identifier.string);
  246. case UA_NODEIDTYPE_GUID:
  247. return UA_Guid_equal(&n1->identifier.guid,
  248. &n2->identifier.guid);
  249. case UA_NODEIDTYPE_BYTESTRING:
  250. return UA_ByteString_equal(&n1->identifier.byteString,
  251. &n2->identifier.byteString);
  252. }
  253. return false;
  254. }
  255. /* FNV non-cryptographic hash function. See
  256. * https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function */
  257. #define FNV_PRIME_32 16777619
  258. static u32
  259. fnv32(u32 fnv, const u8 *buf, size_t size) {
  260. for(size_t i = 0; i < size; ++i) {
  261. fnv = fnv ^ (buf[i]);
  262. fnv = fnv * FNV_PRIME_32;
  263. }
  264. return fnv;
  265. }
  266. u32
  267. UA_NodeId_hash(const UA_NodeId *n) {
  268. switch(n->identifierType) {
  269. case UA_NODEIDTYPE_NUMERIC:
  270. default:
  271. // shift knuth multiplication to use highest 32 bits and after addition make sure we don't have an integer overflow
  272. return (u32)((n->namespaceIndex + ((n->identifier.numeric * (u64)2654435761) >> (32))) & UINT32_C(4294967295)); /* Knuth's multiplicative hashing */
  273. case UA_NODEIDTYPE_STRING:
  274. case UA_NODEIDTYPE_BYTESTRING:
  275. return fnv32(n->namespaceIndex, n->identifier.string.data, n->identifier.string.length);
  276. case UA_NODEIDTYPE_GUID:
  277. return fnv32(n->namespaceIndex, (const u8*)&n->identifier.guid, sizeof(UA_Guid));
  278. }
  279. }
  280. /* ExpandedNodeId */
  281. static void
  282. ExpandedNodeId_deleteMembers(UA_ExpandedNodeId *p, const UA_DataType *_) {
  283. NodeId_deleteMembers(&p->nodeId, _);
  284. String_deleteMembers(&p->namespaceUri, NULL);
  285. }
  286. static UA_StatusCode
  287. ExpandedNodeId_copy(UA_ExpandedNodeId const *src, UA_ExpandedNodeId *dst,
  288. const UA_DataType *_) {
  289. UA_StatusCode retval = NodeId_copy(&src->nodeId, &dst->nodeId, NULL);
  290. retval |= UA_String_copy(&src->namespaceUri, &dst->namespaceUri);
  291. dst->serverIndex = src->serverIndex;
  292. return retval;
  293. }
  294. /* ExtensionObject */
  295. static void
  296. ExtensionObject_deleteMembers(UA_ExtensionObject *p, const UA_DataType *_) {
  297. switch(p->encoding) {
  298. case UA_EXTENSIONOBJECT_ENCODED_NOBODY:
  299. case UA_EXTENSIONOBJECT_ENCODED_BYTESTRING:
  300. case UA_EXTENSIONOBJECT_ENCODED_XML:
  301. NodeId_deleteMembers(&p->content.encoded.typeId, NULL);
  302. String_deleteMembers(&p->content.encoded.body, NULL);
  303. break;
  304. case UA_EXTENSIONOBJECT_DECODED:
  305. if(p->content.decoded.data)
  306. UA_delete(p->content.decoded.data, p->content.decoded.type);
  307. break;
  308. default:
  309. break;
  310. }
  311. }
  312. static UA_StatusCode
  313. ExtensionObject_copy(UA_ExtensionObject const *src, UA_ExtensionObject *dst,
  314. const UA_DataType *_) {
  315. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  316. switch(src->encoding) {
  317. case UA_EXTENSIONOBJECT_ENCODED_NOBODY:
  318. case UA_EXTENSIONOBJECT_ENCODED_BYTESTRING:
  319. case UA_EXTENSIONOBJECT_ENCODED_XML:
  320. dst->encoding = src->encoding;
  321. retval = NodeId_copy(&src->content.encoded.typeId,
  322. &dst->content.encoded.typeId, NULL);
  323. retval |= UA_ByteString_copy(&src->content.encoded.body,
  324. &dst->content.encoded.body);
  325. break;
  326. case UA_EXTENSIONOBJECT_DECODED:
  327. case UA_EXTENSIONOBJECT_DECODED_NODELETE:
  328. if(!src->content.decoded.type || !src->content.decoded.data)
  329. return UA_STATUSCODE_BADINTERNALERROR;
  330. dst->encoding = UA_EXTENSIONOBJECT_DECODED;
  331. dst->content.decoded.type = src->content.decoded.type;
  332. retval = UA_Array_copy(src->content.decoded.data, 1,
  333. &dst->content.decoded.data, src->content.decoded.type);
  334. break;
  335. default:
  336. break;
  337. }
  338. return retval;
  339. }
  340. /* Variant */
  341. static void
  342. Variant_deletemembers(UA_Variant *p, const UA_DataType *_) {
  343. if(p->storageType != UA_VARIANT_DATA)
  344. return;
  345. if(p->type && p->data > UA_EMPTY_ARRAY_SENTINEL) {
  346. if(p->arrayLength == 0)
  347. p->arrayLength = 1;
  348. UA_Array_delete(p->data, p->arrayLength, p->type);
  349. }
  350. if((void*)p->arrayDimensions > UA_EMPTY_ARRAY_SENTINEL)
  351. UA_free(p->arrayDimensions);
  352. }
  353. static UA_StatusCode
  354. Variant_copy(UA_Variant const *src, UA_Variant *dst, const UA_DataType *_) {
  355. size_t length = src->arrayLength;
  356. if(UA_Variant_isScalar(src))
  357. length = 1;
  358. UA_StatusCode retval = UA_Array_copy(src->data, length,
  359. &dst->data, src->type);
  360. if(retval != UA_STATUSCODE_GOOD)
  361. return retval;
  362. dst->arrayLength = src->arrayLength;
  363. dst->type = src->type;
  364. if(src->arrayDimensions) {
  365. retval = UA_Array_copy(src->arrayDimensions, src->arrayDimensionsSize,
  366. (void**)&dst->arrayDimensions, &UA_TYPES[UA_TYPES_INT32]);
  367. if(retval != UA_STATUSCODE_GOOD)
  368. return retval;
  369. dst->arrayDimensionsSize = src->arrayDimensionsSize;
  370. }
  371. return UA_STATUSCODE_GOOD;
  372. }
  373. void
  374. UA_Variant_setScalar(UA_Variant *v, void * UA_RESTRICT p,
  375. const UA_DataType *type) {
  376. UA_Variant_init(v);
  377. v->type = type;
  378. v->arrayLength = 0;
  379. v->data = p;
  380. }
  381. UA_StatusCode
  382. UA_Variant_setScalarCopy(UA_Variant *v, const void *p,
  383. const UA_DataType *type) {
  384. void *n = UA_malloc(type->memSize);
  385. if(!n)
  386. return UA_STATUSCODE_BADOUTOFMEMORY;
  387. UA_StatusCode retval = UA_copy(p, n, type);
  388. if(retval != UA_STATUSCODE_GOOD) {
  389. UA_free(n);
  390. //cppcheck-suppress memleak
  391. return retval;
  392. }
  393. UA_Variant_setScalar(v, n, type);
  394. //cppcheck-suppress memleak
  395. return UA_STATUSCODE_GOOD;
  396. }
  397. void UA_Variant_setArray(UA_Variant *v, void * UA_RESTRICT array,
  398. size_t arraySize, const UA_DataType *type) {
  399. UA_Variant_init(v);
  400. v->data = array;
  401. v->arrayLength = arraySize;
  402. v->type = type;
  403. }
  404. UA_StatusCode
  405. UA_Variant_setArrayCopy(UA_Variant *v, const void *array,
  406. size_t arraySize, const UA_DataType *type) {
  407. UA_Variant_init(v);
  408. UA_StatusCode retval = UA_Array_copy(array, arraySize, &v->data, type);
  409. if(retval != UA_STATUSCODE_GOOD)
  410. return retval;
  411. v->arrayLength = arraySize;
  412. v->type = type;
  413. return UA_STATUSCODE_GOOD;
  414. }
  415. /* Test if a range is compatible with a variant. If yes, the following values
  416. * are set:
  417. * - total: how many elements are in the range
  418. * - block: how big is each contiguous block of elements in the variant that
  419. * maps into the range
  420. * - stride: how many elements are between the blocks (beginning to beginning)
  421. * - first: where does the first block begin */
  422. static UA_StatusCode
  423. computeStrides(const UA_Variant *v, const UA_NumericRange range,
  424. size_t *total, size_t *block, size_t *stride, size_t *first) {
  425. /* Test for max array size (64bit only) */
  426. #if (SIZE_MAX > 0xffffffff)
  427. if(v->arrayLength > UA_UINT32_MAX)
  428. return UA_STATUSCODE_BADINTERNALERROR;
  429. #endif
  430. /* Test the integrity of the source variant dimensions, make dimensions
  431. * vector of one dimension if none defined */
  432. u32 arrayLength = (u32)v->arrayLength;
  433. const u32 *dims = &arrayLength;
  434. size_t dims_count = 1;
  435. if(v->arrayDimensionsSize > 0) {
  436. size_t elements = 1;
  437. dims_count = v->arrayDimensionsSize;
  438. dims = (u32*)v->arrayDimensions;
  439. for(size_t i = 0; i < dims_count; ++i)
  440. elements *= dims[i];
  441. if(elements != v->arrayLength)
  442. return UA_STATUSCODE_BADINTERNALERROR;
  443. }
  444. UA_assert(dims_count > 0);
  445. /* Test the integrity of the range and compute the max index used for every
  446. * dimension. The standard says in Part 4, Section 7.22:
  447. *
  448. * When reading a value, the indexes may not specify a range that is within
  449. * the bounds of the array. The Server shall return a partial result if some
  450. * elements exist within the range. */
  451. size_t count = 1;
  452. UA_UInt32 *realmax = (UA_UInt32*)UA_alloca(sizeof(UA_UInt32) * dims_count);
  453. if(range.dimensionsSize != dims_count)
  454. return UA_STATUSCODE_BADINDEXRANGENODATA;
  455. for(size_t i = 0; i < dims_count; ++i) {
  456. if(range.dimensions[i].min > range.dimensions[i].max)
  457. return UA_STATUSCODE_BADINDEXRANGEINVALID;
  458. if(range.dimensions[i].min >= dims[i])
  459. return UA_STATUSCODE_BADINDEXRANGENODATA;
  460. if(range.dimensions[i].max < dims[i])
  461. realmax[i] = range.dimensions[i].max;
  462. else
  463. realmax[i] = dims[i] - 1;
  464. count *= (realmax[i] - range.dimensions[i].min) + 1;
  465. }
  466. *total = count;
  467. /* Compute the stride length and the position of the first element */
  468. *block = count; /* Assume the range describes the entire array. */
  469. *stride = v->arrayLength; /* So it can be copied as a contiguous block. */
  470. *first = 0;
  471. size_t running_dimssize = 1;
  472. bool found_contiguous = false;
  473. for(size_t k = dims_count; k > 0;) {
  474. --k;
  475. size_t dimrange = 1 + realmax[k] - range.dimensions[k].min;
  476. if(!found_contiguous && dimrange != dims[k]) {
  477. /* Found the maximum block that can be copied contiguously */
  478. found_contiguous = true;
  479. *block = running_dimssize * dimrange;
  480. *stride = running_dimssize * dims[k];
  481. }
  482. *first += running_dimssize * range.dimensions[k].min;
  483. running_dimssize *= dims[k];
  484. }
  485. return UA_STATUSCODE_GOOD;
  486. }
  487. /* Is the type string-like? */
  488. static bool
  489. isStringLike(const UA_DataType *type) {
  490. if(type->membersSize == 1 && type->members[0].isArray &&
  491. type->members[0].namespaceZero &&
  492. type->members[0].memberTypeIndex == UA_TYPES_BYTE)
  493. return true;
  494. return false;
  495. }
  496. /* Returns the part of the string that lies within the rangedimension */
  497. static UA_StatusCode
  498. copySubString(const UA_String *src, UA_String *dst,
  499. const UA_NumericRangeDimension *dim) {
  500. if(dim->min > dim->max)
  501. return UA_STATUSCODE_BADINDEXRANGEINVALID;
  502. if(dim->min >= src->length)
  503. return UA_STATUSCODE_BADINDEXRANGENODATA;
  504. size_t length;
  505. if(dim->max < src->length)
  506. length = dim->max - dim->min + 1;
  507. else
  508. length = src->length - dim->min;
  509. UA_StatusCode retval = UA_ByteString_allocBuffer(dst, length);
  510. if(retval != UA_STATUSCODE_GOOD)
  511. return retval;
  512. memcpy(dst->data, &src->data[dim->min], length);
  513. return UA_STATUSCODE_GOOD;
  514. }
  515. UA_StatusCode
  516. UA_Variant_copyRange(const UA_Variant *src, UA_Variant *dst,
  517. const UA_NumericRange range) {
  518. if (!src->type)
  519. return UA_STATUSCODE_BADINVALIDARGUMENT;
  520. bool isScalar = UA_Variant_isScalar(src);
  521. bool stringLike = isStringLike(src->type);
  522. UA_Variant arraySrc;
  523. /* Extract the range for copying at this level. The remaining range is dealt
  524. * with in the "scalar" type that may define an array by itself (string,
  525. * variant, ...). */
  526. UA_NumericRange thisrange, nextrange;
  527. UA_NumericRangeDimension scalarThisDimension = {0,0}; /* a single entry */
  528. if(isScalar) {
  529. /* Replace scalar src with array of length 1 */
  530. arraySrc = *src;
  531. arraySrc.arrayLength = 1;
  532. src = &arraySrc;
  533. /* Deal with all range dimensions within the scalar */
  534. thisrange.dimensions = &scalarThisDimension;
  535. thisrange.dimensionsSize = 1;
  536. nextrange = range;
  537. } else {
  538. /* Deal with as many range dimensions as possible right now */
  539. size_t dims = src->arrayDimensionsSize;
  540. if(dims == 0)
  541. dims = 1;
  542. if(dims > range.dimensionsSize)
  543. return UA_STATUSCODE_BADINDEXRANGEINVALID;
  544. thisrange = range;
  545. thisrange.dimensionsSize = dims;
  546. nextrange.dimensions = &range.dimensions[dims];
  547. nextrange.dimensionsSize = range.dimensionsSize - dims;
  548. }
  549. /* Compute the strides */
  550. size_t count, block, stride, first;
  551. UA_StatusCode retval = computeStrides(src, thisrange, &count,
  552. &block, &stride, &first);
  553. if(retval != UA_STATUSCODE_GOOD)
  554. return retval;
  555. /* Allocate the array */
  556. UA_Variant_init(dst);
  557. dst->data = UA_Array_new(count, src->type);
  558. if(!dst->data)
  559. return UA_STATUSCODE_BADOUTOFMEMORY;
  560. /* Copy the range */
  561. size_t block_count = count / block;
  562. size_t elem_size = src->type->memSize;
  563. uintptr_t nextdst = (uintptr_t)dst->data;
  564. uintptr_t nextsrc = (uintptr_t)src->data + (elem_size * first);
  565. if(nextrange.dimensionsSize == 0) {
  566. /* no nextrange */
  567. if(src->type->pointerFree) {
  568. for(size_t i = 0; i < block_count; ++i) {
  569. memcpy((void*)nextdst, (void*)nextsrc, elem_size * block);
  570. nextdst += block * elem_size;
  571. nextsrc += stride * elem_size;
  572. }
  573. } else {
  574. for(size_t i = 0; i < block_count; ++i) {
  575. for(size_t j = 0; j < block; ++j) {
  576. retval = UA_copy((const void*)nextsrc,
  577. (void*)nextdst, src->type);
  578. nextdst += elem_size;
  579. nextsrc += elem_size;
  580. }
  581. nextsrc += (stride - block) * elem_size;
  582. }
  583. }
  584. } else {
  585. /* nextrange can only be used for variants and stringlike with remaining
  586. * range of dimension 1 */
  587. if(src->type != &UA_TYPES[UA_TYPES_VARIANT]) {
  588. if(!stringLike)
  589. retval = UA_STATUSCODE_BADINDEXRANGENODATA;
  590. if(nextrange.dimensionsSize != 1)
  591. retval = UA_STATUSCODE_BADINDEXRANGENODATA;
  592. }
  593. /* Copy the content */
  594. for(size_t i = 0; i < block_count; ++i) {
  595. for(size_t j = 0; j < block && retval == UA_STATUSCODE_GOOD; ++j) {
  596. if(stringLike)
  597. retval = copySubString((const UA_String*)nextsrc,
  598. (UA_String*)nextdst,
  599. nextrange.dimensions);
  600. else
  601. retval = UA_Variant_copyRange((const UA_Variant*)nextsrc,
  602. (UA_Variant*)nextdst,
  603. nextrange);
  604. nextdst += elem_size;
  605. nextsrc += elem_size;
  606. }
  607. nextsrc += (stride - block) * elem_size;
  608. }
  609. }
  610. /* Clean up if copying failed */
  611. if(retval != UA_STATUSCODE_GOOD) {
  612. UA_Array_delete(dst->data, count, src->type);
  613. dst->data = NULL;
  614. return retval;
  615. }
  616. /* Done if scalar */
  617. dst->type = src->type;
  618. if(isScalar)
  619. return retval;
  620. /* Copy array dimensions */
  621. dst->arrayLength = count;
  622. if(src->arrayDimensionsSize > 0) {
  623. dst->arrayDimensions =
  624. (u32*)UA_Array_new(thisrange.dimensionsSize, &UA_TYPES[UA_TYPES_UINT32]);
  625. if(!dst->arrayDimensions) {
  626. Variant_deletemembers(dst, NULL);
  627. return UA_STATUSCODE_BADOUTOFMEMORY;
  628. }
  629. dst->arrayDimensionsSize = thisrange.dimensionsSize;
  630. for(size_t k = 0; k < thisrange.dimensionsSize; ++k)
  631. dst->arrayDimensions[k] =
  632. thisrange.dimensions[k].max - thisrange.dimensions[k].min + 1;
  633. }
  634. return UA_STATUSCODE_GOOD;
  635. }
  636. /* TODO: Allow ranges to reach inside a scalars that are array-like, e.g.
  637. * variant and strings. This is already possible for reading... */
  638. static UA_StatusCode
  639. Variant_setRange(UA_Variant *v, void *array, size_t arraySize,
  640. const UA_NumericRange range, bool copy) {
  641. /* Compute the strides */
  642. size_t count, block, stride, first;
  643. UA_StatusCode retval = computeStrides(v, range, &count,
  644. &block, &stride, &first);
  645. if(retval != UA_STATUSCODE_GOOD)
  646. return retval;
  647. if(count != arraySize)
  648. return UA_STATUSCODE_BADINDEXRANGEINVALID;
  649. /* Move/copy the elements */
  650. size_t block_count = count / block;
  651. size_t elem_size = v->type->memSize;
  652. uintptr_t nextdst = (uintptr_t)v->data + (first * elem_size);
  653. uintptr_t nextsrc = (uintptr_t)array;
  654. if(v->type->pointerFree || !copy) {
  655. for(size_t i = 0; i < block_count; ++i) {
  656. memcpy((void*)nextdst, (void*)nextsrc, elem_size * block);
  657. nextsrc += block * elem_size;
  658. nextdst += stride * elem_size;
  659. }
  660. } else {
  661. for(size_t i = 0; i < block_count; ++i) {
  662. for(size_t j = 0; j < block; ++j) {
  663. deleteMembers_noInit((void*)nextdst, v->type);
  664. retval |= UA_copy((void*)nextsrc, (void*)nextdst, v->type);
  665. nextdst += elem_size;
  666. nextsrc += elem_size;
  667. }
  668. nextdst += (stride - block) * elem_size;
  669. }
  670. }
  671. /* If members were moved, initialize original array to prevent reuse */
  672. if(!copy && !v->type->pointerFree)
  673. memset(array, 0, sizeof(elem_size)*arraySize);
  674. return retval;
  675. }
  676. UA_StatusCode
  677. UA_Variant_setRange(UA_Variant *v, void * UA_RESTRICT array,
  678. size_t arraySize, const UA_NumericRange range) {
  679. return Variant_setRange(v, array, arraySize, range, false);
  680. }
  681. UA_StatusCode
  682. UA_Variant_setRangeCopy(UA_Variant *v, const void *array,
  683. size_t arraySize, const UA_NumericRange range) {
  684. return Variant_setRange(v, (void*)(uintptr_t)array,
  685. arraySize, range, true);
  686. }
  687. /* LocalizedText */
  688. static void
  689. LocalizedText_deleteMembers(UA_LocalizedText *p, const UA_DataType *_) {
  690. String_deleteMembers(&p->locale, NULL);
  691. String_deleteMembers(&p->text, NULL);
  692. }
  693. static UA_StatusCode
  694. LocalizedText_copy(UA_LocalizedText const *src, UA_LocalizedText *dst,
  695. const UA_DataType *_) {
  696. UA_StatusCode retval = UA_String_copy(&src->locale, &dst->locale);
  697. retval |= UA_String_copy(&src->text, &dst->text);
  698. return retval;
  699. }
  700. /* DataValue */
  701. static void
  702. DataValue_deleteMembers(UA_DataValue *p, const UA_DataType *_) {
  703. Variant_deletemembers(&p->value, NULL);
  704. }
  705. static UA_StatusCode
  706. DataValue_copy(UA_DataValue const *src, UA_DataValue *dst,
  707. const UA_DataType *_) {
  708. memcpy(dst, src, sizeof(UA_DataValue));
  709. UA_Variant_init(&dst->value);
  710. UA_StatusCode retval = Variant_copy(&src->value, &dst->value, NULL);
  711. if(retval != UA_STATUSCODE_GOOD)
  712. DataValue_deleteMembers(dst, NULL);
  713. return retval;
  714. }
  715. /* DiagnosticInfo */
  716. static void
  717. DiagnosticInfo_deleteMembers(UA_DiagnosticInfo *p, const UA_DataType *_) {
  718. String_deleteMembers(&p->additionalInfo, NULL);
  719. if(p->hasInnerDiagnosticInfo && p->innerDiagnosticInfo) {
  720. DiagnosticInfo_deleteMembers(p->innerDiagnosticInfo, NULL);
  721. UA_free(p->innerDiagnosticInfo);
  722. }
  723. }
  724. static UA_StatusCode
  725. DiagnosticInfo_copy(UA_DiagnosticInfo const *src, UA_DiagnosticInfo *dst,
  726. const UA_DataType *_) {
  727. memcpy(dst, src, sizeof(UA_DiagnosticInfo));
  728. UA_String_init(&dst->additionalInfo);
  729. dst->innerDiagnosticInfo = NULL;
  730. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  731. if(src->hasAdditionalInfo)
  732. retval = UA_String_copy(&src->additionalInfo, &dst->additionalInfo);
  733. if(src->hasInnerDiagnosticInfo && src->innerDiagnosticInfo) {
  734. dst->innerDiagnosticInfo = (UA_DiagnosticInfo*)UA_malloc(sizeof(UA_DiagnosticInfo));
  735. if(dst->innerDiagnosticInfo) {
  736. retval |= DiagnosticInfo_copy(src->innerDiagnosticInfo,
  737. dst->innerDiagnosticInfo, NULL);
  738. dst->hasInnerDiagnosticInfo = true;
  739. } else {
  740. dst->hasInnerDiagnosticInfo = false;
  741. retval |= UA_STATUSCODE_BADOUTOFMEMORY;
  742. }
  743. }
  744. return retval;
  745. }
  746. /********************/
  747. /* Structured Types */
  748. /********************/
  749. void *
  750. UA_new(const UA_DataType *type) {
  751. void *p = UA_calloc(1, type->memSize);
  752. return p;
  753. }
  754. static UA_StatusCode
  755. copyByte(const u8 *src, u8 *dst, const UA_DataType *_) {
  756. *dst = *src;
  757. return UA_STATUSCODE_GOOD;
  758. }
  759. static UA_StatusCode
  760. copy2Byte(const u16 *src, u16 *dst, const UA_DataType *_) {
  761. *dst = *src;
  762. return UA_STATUSCODE_GOOD;
  763. }
  764. static UA_StatusCode
  765. copy4Byte(const u32 *src, u32 *dst, const UA_DataType *_) {
  766. *dst = *src;
  767. return UA_STATUSCODE_GOOD;
  768. }
  769. static UA_StatusCode
  770. copy8Byte(const u64 *src, u64 *dst, const UA_DataType *_) {
  771. *dst = *src;
  772. return UA_STATUSCODE_GOOD;
  773. }
  774. static UA_StatusCode
  775. copyGuid(const UA_Guid *src, UA_Guid *dst, const UA_DataType *_) {
  776. *dst = *src;
  777. return UA_STATUSCODE_GOOD;
  778. }
  779. typedef UA_StatusCode
  780. (*UA_copySignature)(const void *src, void *dst, const UA_DataType *type);
  781. static const UA_copySignature copyJumpTable[UA_BUILTIN_TYPES_COUNT + 1] = {
  782. (UA_copySignature)copyByte, // Boolean
  783. (UA_copySignature)copyByte, // SByte
  784. (UA_copySignature)copyByte, // Byte
  785. (UA_copySignature)copy2Byte, // Int16
  786. (UA_copySignature)copy2Byte, // UInt16
  787. (UA_copySignature)copy4Byte, // Int32
  788. (UA_copySignature)copy4Byte, // UInt32
  789. (UA_copySignature)copy8Byte, // Int64
  790. (UA_copySignature)copy8Byte, // UInt64
  791. (UA_copySignature)copy4Byte, // Float
  792. (UA_copySignature)copy8Byte, // Double
  793. (UA_copySignature)copy_noInit, // String
  794. (UA_copySignature)copy8Byte, // DateTime
  795. (UA_copySignature)copyGuid, // Guid
  796. (UA_copySignature)copy_noInit, // ByteString
  797. (UA_copySignature)copy_noInit, // XmlElement
  798. (UA_copySignature)NodeId_copy,
  799. (UA_copySignature)ExpandedNodeId_copy,
  800. (UA_copySignature)copy4Byte, // StatusCode
  801. (UA_copySignature)copy_noInit, // QualifiedName
  802. (UA_copySignature)LocalizedText_copy, // LocalizedText
  803. (UA_copySignature)ExtensionObject_copy,
  804. (UA_copySignature)DataValue_copy,
  805. (UA_copySignature)Variant_copy,
  806. (UA_copySignature)DiagnosticInfo_copy,
  807. (UA_copySignature)copy_noInit // all others
  808. };
  809. static UA_StatusCode
  810. copy_noInit(const void *src, void *dst, const UA_DataType *type) {
  811. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  812. uintptr_t ptrs = (uintptr_t)src;
  813. uintptr_t ptrd = (uintptr_t)dst;
  814. u8 membersSize = type->membersSize;
  815. for(size_t i = 0; i < membersSize; ++i) {
  816. const UA_DataTypeMember *m= &type->members[i];
  817. const UA_DataType *typelists[2] = { UA_TYPES, &type[-type->typeIndex] };
  818. const UA_DataType *mt = &typelists[!m->namespaceZero][m->memberTypeIndex];
  819. if(!m->isArray) {
  820. ptrs += m->padding;
  821. ptrd += m->padding;
  822. size_t fi = mt->builtin ? mt->typeIndex : UA_BUILTIN_TYPES_COUNT;
  823. retval |= copyJumpTable[fi]((const void*)ptrs, (void*)ptrd, mt);
  824. ptrs += mt->memSize;
  825. ptrd += mt->memSize;
  826. } else {
  827. ptrs += m->padding;
  828. ptrd += m->padding;
  829. size_t *dst_size = (size_t*)ptrd;
  830. const size_t size = *((const size_t*)ptrs);
  831. ptrs += sizeof(size_t);
  832. ptrd += sizeof(size_t);
  833. retval |= UA_Array_copy(*(void* const*)ptrs, size, (void**)ptrd, mt);
  834. if(retval == UA_STATUSCODE_GOOD)
  835. *dst_size = size;
  836. else
  837. *dst_size = 0;
  838. ptrs += sizeof(void*);
  839. ptrd += sizeof(void*);
  840. }
  841. }
  842. return retval;
  843. }
  844. UA_StatusCode
  845. UA_copy(const void *src, void *dst, const UA_DataType *type) {
  846. memset(dst, 0, type->memSize); /* init */
  847. UA_StatusCode retval = copy_noInit(src, dst, type);
  848. if(retval != UA_STATUSCODE_GOOD)
  849. UA_deleteMembers(dst, type);
  850. return retval;
  851. }
  852. static void nopDeleteMembers(void *p, const UA_DataType *type) { }
  853. typedef void (*UA_deleteMembersSignature)(void *p, const UA_DataType *type);
  854. static const
  855. UA_deleteMembersSignature deleteMembersJumpTable[UA_BUILTIN_TYPES_COUNT + 1] = {
  856. (UA_deleteMembersSignature)nopDeleteMembers, // Boolean
  857. (UA_deleteMembersSignature)nopDeleteMembers, // SByte
  858. (UA_deleteMembersSignature)nopDeleteMembers, // Byte
  859. (UA_deleteMembersSignature)nopDeleteMembers, // Int16
  860. (UA_deleteMembersSignature)nopDeleteMembers, // UInt16
  861. (UA_deleteMembersSignature)nopDeleteMembers, // Int32
  862. (UA_deleteMembersSignature)nopDeleteMembers, // UInt32
  863. (UA_deleteMembersSignature)nopDeleteMembers, // Int64
  864. (UA_deleteMembersSignature)nopDeleteMembers, // UInt64
  865. (UA_deleteMembersSignature)nopDeleteMembers, // Float
  866. (UA_deleteMembersSignature)nopDeleteMembers, // Double
  867. (UA_deleteMembersSignature)String_deleteMembers, // String
  868. (UA_deleteMembersSignature)nopDeleteMembers, // DateTime
  869. (UA_deleteMembersSignature)nopDeleteMembers, // Guid
  870. (UA_deleteMembersSignature)String_deleteMembers, // ByteString
  871. (UA_deleteMembersSignature)String_deleteMembers, // XmlElement
  872. (UA_deleteMembersSignature)NodeId_deleteMembers,
  873. (UA_deleteMembersSignature)ExpandedNodeId_deleteMembers, // ExpandedNodeId
  874. (UA_deleteMembersSignature)nopDeleteMembers, // StatusCode
  875. (UA_deleteMembersSignature)deleteMembers_noInit, // QualifiedName
  876. (UA_deleteMembersSignature)LocalizedText_deleteMembers, // LocalizedText
  877. (UA_deleteMembersSignature)ExtensionObject_deleteMembers,
  878. (UA_deleteMembersSignature)DataValue_deleteMembers,
  879. (UA_deleteMembersSignature)Variant_deletemembers,
  880. (UA_deleteMembersSignature)DiagnosticInfo_deleteMembers,
  881. (UA_deleteMembersSignature)deleteMembers_noInit,
  882. };
  883. static void
  884. deleteMembers_noInit(void *p, const UA_DataType *type) {
  885. uintptr_t ptr = (uintptr_t)p;
  886. u8 membersSize = type->membersSize;
  887. for(size_t i = 0; i < membersSize; ++i) {
  888. const UA_DataTypeMember *m= &type->members[i];
  889. const UA_DataType *typelists[2] = { UA_TYPES, &type[-type->typeIndex] };
  890. const UA_DataType *mt = &typelists[!m->namespaceZero][m->memberTypeIndex];
  891. if(!m->isArray) {
  892. ptr += m->padding;
  893. size_t fi = mt->builtin ? mt->typeIndex : UA_BUILTIN_TYPES_COUNT;
  894. deleteMembersJumpTable[fi]((void*)ptr, mt);
  895. ptr += mt->memSize;
  896. } else {
  897. ptr += m->padding;
  898. size_t length = *(size_t*)ptr;
  899. ptr += sizeof(size_t);
  900. UA_Array_delete(*(void**)ptr, length, mt);
  901. ptr += sizeof(void*);
  902. }
  903. }
  904. }
  905. void
  906. UA_deleteMembers(void *p, const UA_DataType *type) {
  907. deleteMembers_noInit(p, type);
  908. memset(p, 0, type->memSize); /* init */
  909. }
  910. void
  911. UA_delete(void *p, const UA_DataType *type) {
  912. deleteMembers_noInit(p, type);
  913. UA_free(p);
  914. }
  915. /******************/
  916. /* Array Handling */
  917. /******************/
  918. void *
  919. UA_Array_new(size_t size, const UA_DataType *type) {
  920. if(size > UA_INT32_MAX)
  921. return NULL;
  922. if(size == 0)
  923. return UA_EMPTY_ARRAY_SENTINEL;
  924. return UA_calloc(size, type->memSize);
  925. }
  926. UA_StatusCode
  927. UA_Array_copy(const void *src, size_t size,
  928. void **dst, const UA_DataType *type) {
  929. if(size == 0) {
  930. if(src == NULL)
  931. *dst = NULL;
  932. else
  933. *dst= UA_EMPTY_ARRAY_SENTINEL;
  934. return UA_STATUSCODE_GOOD;
  935. }
  936. if(!type)
  937. return UA_STATUSCODE_BADINTERNALERROR;
  938. /* calloc, so we don't have to check retval in every iteration of copying */
  939. *dst = UA_calloc(size, type->memSize);
  940. if(!*dst)
  941. return UA_STATUSCODE_BADOUTOFMEMORY;
  942. if(type->pointerFree) {
  943. memcpy(*dst, src, type->memSize * size);
  944. return UA_STATUSCODE_GOOD;
  945. }
  946. uintptr_t ptrs = (uintptr_t)src;
  947. uintptr_t ptrd = (uintptr_t)*dst;
  948. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  949. for(size_t i = 0; i < size; ++i) {
  950. retval |= UA_copy((void*)ptrs, (void*)ptrd, type);
  951. ptrs += type->memSize;
  952. ptrd += type->memSize;
  953. }
  954. if(retval != UA_STATUSCODE_GOOD) {
  955. UA_Array_delete(*dst, size, type);
  956. *dst = NULL;
  957. }
  958. return retval;
  959. }
  960. void
  961. UA_Array_delete(void *p, size_t size, const UA_DataType *type) {
  962. if(!type->pointerFree) {
  963. uintptr_t ptr = (uintptr_t)p;
  964. for(size_t i = 0; i < size; ++i) {
  965. UA_deleteMembers((void*)ptr, type);
  966. ptr += type->memSize;
  967. }
  968. }
  969. UA_free((void*)((uintptr_t)p & ~(uintptr_t)UA_EMPTY_ARRAY_SENTINEL));
  970. }