ua_types_encoding_binary.c 60 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759
  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-2018 (c) Fraunhofer IOSB (Author: Julius Pfrommer)
  6. * Copyright 2014-2017 (c) Florian Palm
  7. * Copyright 2014-2016 (c) Sten Grüner
  8. * Copyright 2014 (c) Leon Urbas
  9. * Copyright 2015 (c) LEvertz
  10. * Copyright 2015 (c) Chris Iatrou
  11. * Copyright 2015-2016 (c) Oleksiy Vasylyev
  12. * Copyright 2016-2017 (c) Stefan Profanter, fortiss GmbH
  13. * Copyright 2016 (c) Lorenz Haas
  14. * Copyright 2017 (c) Mark Giraud, Fraunhofer IOSB
  15. * Copyright 2017 (c) Henrik Norrman
  16. */
  17. #include "ua_util_internal.h"
  18. #include "ua_types_encoding_binary.h"
  19. #include "ua_types_generated.h"
  20. #include "ua_types_generated_handling.h"
  21. /**
  22. * Type Encoding and Decoding
  23. * --------------------------
  24. * The following methods contain encoding and decoding functions for the builtin
  25. * data types and generic functions that operate on all types and arrays. This
  26. * requires the type description from a UA_DataType structure.
  27. *
  28. * Encoding Context
  29. * ^^^^^^^^^^^^^^^^
  30. * If possible, the encoding context is stored in a thread-local variable to
  31. * speed up encoding. If thread-local variables are not supported, the context
  32. * is "looped through" every method call. The ``_``-macro accesses either the
  33. * thread-local or the "looped through" context . */
  34. /* Part 6 §5.1.5: Decoders shall support at least 100 nesting levels */
  35. #define UA_ENCODING_MAX_RECURSION 100
  36. typedef struct {
  37. /* Pointers to the current position and the last position in the buffer */
  38. u8 *pos;
  39. const u8 *end;
  40. u8 **oldpos; /* Sentinel for a lower stacktrace exchanging the buffer */
  41. u16 depth; /* How often did we en-/decoding recurse? */
  42. const UA_DataTypeArray *customTypes;
  43. UA_exchangeEncodeBuffer exchangeBufferCallback;
  44. void *exchangeBufferCallbackHandle;
  45. } Ctx;
  46. typedef status
  47. (*encodeBinarySignature)(const void *UA_RESTRICT src, const UA_DataType *type,
  48. Ctx *UA_RESTRICT ctx);
  49. typedef status
  50. (*decodeBinarySignature)(void *UA_RESTRICT dst, const UA_DataType *type,
  51. Ctx *UA_RESTRICT ctx);
  52. typedef size_t
  53. (*calcSizeBinarySignature)(const void *UA_RESTRICT p, const UA_DataType *contenttype);
  54. #define ENCODE_BINARY(TYPE) static status \
  55. TYPE##_encodeBinary(const UA_##TYPE *UA_RESTRICT src, \
  56. const UA_DataType *type, Ctx *UA_RESTRICT ctx)
  57. #define DECODE_BINARY(TYPE) static status \
  58. TYPE##_decodeBinary(UA_##TYPE *UA_RESTRICT dst, \
  59. const UA_DataType *type, Ctx *UA_RESTRICT ctx)
  60. #define CALCSIZE_BINARY(TYPE) static size_t \
  61. TYPE##_calcSizeBinary(const UA_##TYPE *UA_RESTRICT src, \
  62. const UA_DataType *_)
  63. #define ENCODE_DIRECT(SRC, TYPE) TYPE##_encodeBinary((const UA_##TYPE*)SRC, NULL, ctx)
  64. #define DECODE_DIRECT(DST, TYPE) TYPE##_decodeBinary((UA_##TYPE*)DST, NULL, ctx)
  65. /* Jumptables for de-/encoding and computing the buffer length. The methods in
  66. * the decoding jumptable do not all clean up their allocated memory when an
  67. * error occurs. So a final _clear needs to be called before returning to the
  68. * user. */
  69. extern const encodeBinarySignature encodeBinaryJumpTable[UA_DATATYPEKINDS];
  70. extern const decodeBinarySignature decodeBinaryJumpTable[UA_DATATYPEKINDS];
  71. extern const calcSizeBinarySignature calcSizeBinaryJumpTable[UA_DATATYPEKINDS];
  72. /* Breaking a message up into chunks is integrated with the encoding. When the
  73. * end of a buffer is reached, a callback is executed that sends the current
  74. * buffer as a chunk and exchanges the encoding buffer "underneath" the ongoing
  75. * encoding. This reduces the RAM requirements and unnecessary copying. */
  76. /* Send the current chunk and replace the buffer */
  77. static status exchangeBuffer(Ctx *ctx) {
  78. if(!ctx->exchangeBufferCallback)
  79. return UA_STATUSCODE_BADENCODINGERROR;
  80. return ctx->exchangeBufferCallback(ctx->exchangeBufferCallbackHandle,
  81. &ctx->pos, &ctx->end);
  82. }
  83. /* If encoding fails, exchange the buffer and try again. */
  84. static status
  85. encodeWithExchangeBuffer(const void *ptr, const UA_DataType *type, Ctx *ctx) {
  86. u8 *oldpos = ctx->pos; /* Last known good position */
  87. ctx->oldpos = &oldpos;
  88. status ret = encodeBinaryJumpTable[type->typeKind](ptr, type, ctx);
  89. if(ret == UA_STATUSCODE_BADENCODINGLIMITSEXCEEDED && ctx->oldpos == &oldpos) {
  90. ctx->pos = oldpos; /* Send the position to the last known good position
  91. * and switch */
  92. ret = exchangeBuffer(ctx);
  93. if(ret != UA_STATUSCODE_GOOD)
  94. return ret;
  95. ret = encodeBinaryJumpTable[type->typeKind](ptr, type, ctx);
  96. }
  97. return ret;
  98. }
  99. #define ENCODE_WITHEXCHANGE(VAR, TYPE) \
  100. encodeWithExchangeBuffer((const void*)VAR, &UA_TYPES[TYPE], ctx)
  101. /*****************/
  102. /* Integer Types */
  103. /*****************/
  104. #if !UA_BINARY_OVERLAYABLE_INTEGER
  105. #pragma message "Integer endianness could not be detected to be little endian. Use slow generic encoding."
  106. /* These en/decoding functions are only used when the architecture isn't little-endian. */
  107. static void
  108. UA_encode16(const u16 v, u8 buf[2]) {
  109. buf[0] = (u8)v;
  110. buf[1] = (u8)(v >> 8);
  111. }
  112. static void
  113. UA_decode16(const u8 buf[2], u16 *v) {
  114. *v = (u16)((u16)buf[0] + (((u16)buf[1]) << 8));
  115. }
  116. static void
  117. UA_encode32(const u32 v, u8 buf[4]) {
  118. buf[0] = (u8)v;
  119. buf[1] = (u8)(v >> 8);
  120. buf[2] = (u8)(v >> 16);
  121. buf[3] = (u8)(v >> 24);
  122. }
  123. static void
  124. UA_decode32(const u8 buf[4], u32 *v) {
  125. *v = (u32)((u32)buf[0] + (((u32)buf[1]) << 8) +
  126. (((u32)buf[2]) << 16) + (((u32)buf[3]) << 24));
  127. }
  128. static void
  129. UA_encode64(const u64 v, u8 buf[8]) {
  130. buf[0] = (u8)v;
  131. buf[1] = (u8)(v >> 8);
  132. buf[2] = (u8)(v >> 16);
  133. buf[3] = (u8)(v >> 24);
  134. buf[4] = (u8)(v >> 32);
  135. buf[5] = (u8)(v >> 40);
  136. buf[6] = (u8)(v >> 48);
  137. buf[7] = (u8)(v >> 56);
  138. }
  139. static void
  140. UA_decode64(const u8 buf[8], u64 *v) {
  141. *v = (u64)((u64)buf[0] + (((u64)buf[1]) << 8) +
  142. (((u64)buf[2]) << 16) + (((u64)buf[3]) << 24) +
  143. (((u64)buf[4]) << 32) + (((u64)buf[5]) << 40) +
  144. (((u64)buf[6]) << 48) + (((u64)buf[7]) << 56));
  145. }
  146. #endif /* !UA_BINARY_OVERLAYABLE_INTEGER */
  147. /* Boolean */
  148. /* Note that sizeof(bool) != 1 on some platforms. Overlayable integer encoding
  149. * is disabled in those cases. */
  150. ENCODE_BINARY(Boolean) {
  151. if(ctx->pos + 1 > ctx->end)
  152. return UA_STATUSCODE_BADENCODINGLIMITSEXCEEDED;
  153. *ctx->pos = *(const u8*)src;
  154. ++ctx->pos;
  155. return UA_STATUSCODE_GOOD;
  156. }
  157. DECODE_BINARY(Boolean) {
  158. if(ctx->pos + 1 > ctx->end)
  159. return UA_STATUSCODE_BADDECODINGERROR;
  160. *dst = (*ctx->pos > 0) ? true : false;
  161. ++ctx->pos;
  162. return UA_STATUSCODE_GOOD;
  163. }
  164. /* Byte */
  165. ENCODE_BINARY(Byte) {
  166. if(ctx->pos + sizeof(u8) > ctx->end)
  167. return UA_STATUSCODE_BADENCODINGLIMITSEXCEEDED;
  168. *ctx->pos = *(const u8*)src;
  169. ++ctx->pos;
  170. return UA_STATUSCODE_GOOD;
  171. }
  172. DECODE_BINARY(Byte) {
  173. if(ctx->pos + sizeof(u8) > ctx->end)
  174. return UA_STATUSCODE_BADDECODINGERROR;
  175. *dst = *ctx->pos;
  176. ++ctx->pos;
  177. return UA_STATUSCODE_GOOD;
  178. }
  179. /* UInt16 */
  180. ENCODE_BINARY(UInt16) {
  181. if(ctx->pos + sizeof(u16) > ctx->end)
  182. return UA_STATUSCODE_BADENCODINGLIMITSEXCEEDED;
  183. #if UA_BINARY_OVERLAYABLE_INTEGER
  184. memcpy(ctx->pos, src, sizeof(u16));
  185. #else
  186. UA_encode16(*src, ctx->pos);
  187. #endif
  188. ctx->pos += 2;
  189. return UA_STATUSCODE_GOOD;
  190. }
  191. DECODE_BINARY(UInt16) {
  192. if(ctx->pos + sizeof(u16) > ctx->end)
  193. return UA_STATUSCODE_BADDECODINGERROR;
  194. #if UA_BINARY_OVERLAYABLE_INTEGER
  195. memcpy(dst, ctx->pos, sizeof(u16));
  196. #else
  197. UA_decode16(ctx->pos, dst);
  198. #endif
  199. ctx->pos += 2;
  200. return UA_STATUSCODE_GOOD;
  201. }
  202. /* UInt32 */
  203. ENCODE_BINARY(UInt32) {
  204. if(ctx->pos + sizeof(u32) > ctx->end)
  205. return UA_STATUSCODE_BADENCODINGLIMITSEXCEEDED;
  206. #if UA_BINARY_OVERLAYABLE_INTEGER
  207. memcpy(ctx->pos, src, sizeof(u32));
  208. #else
  209. UA_encode32(*src, ctx->pos);
  210. #endif
  211. ctx->pos += 4;
  212. return UA_STATUSCODE_GOOD;
  213. }
  214. DECODE_BINARY(UInt32) {
  215. if(ctx->pos + sizeof(u32) > ctx->end)
  216. return UA_STATUSCODE_BADDECODINGERROR;
  217. #if UA_BINARY_OVERLAYABLE_INTEGER
  218. memcpy(dst, ctx->pos, sizeof(u32));
  219. #else
  220. UA_decode32(ctx->pos, dst);
  221. #endif
  222. ctx->pos += 4;
  223. return UA_STATUSCODE_GOOD;
  224. }
  225. /* UInt64 */
  226. ENCODE_BINARY(UInt64) {
  227. if(ctx->pos + sizeof(u64) > ctx->end)
  228. return UA_STATUSCODE_BADENCODINGLIMITSEXCEEDED;
  229. #if UA_BINARY_OVERLAYABLE_INTEGER
  230. memcpy(ctx->pos, src, sizeof(u64));
  231. #else
  232. UA_encode64(*src, ctx->pos);
  233. #endif
  234. ctx->pos += 8;
  235. return UA_STATUSCODE_GOOD;
  236. }
  237. DECODE_BINARY(UInt64) {
  238. if(ctx->pos + sizeof(u64) > ctx->end)
  239. return UA_STATUSCODE_BADDECODINGERROR;
  240. #if UA_BINARY_OVERLAYABLE_INTEGER
  241. memcpy(dst, ctx->pos, sizeof(u64));
  242. #else
  243. UA_decode64(ctx->pos, dst);
  244. #endif
  245. ctx->pos += 8;
  246. return UA_STATUSCODE_GOOD;
  247. }
  248. /************************/
  249. /* Floating Point Types */
  250. /************************/
  251. /* Can we reuse the integer encoding mechanism by casting floating point
  252. * values? */
  253. #if (UA_FLOAT_IEEE754 == 1) && (UA_LITTLE_ENDIAN == UA_FLOAT_LITTLE_ENDIAN)
  254. # define Float_encodeBinary UInt32_encodeBinary
  255. # define Float_decodeBinary UInt32_decodeBinary
  256. # define Double_encodeBinary UInt64_encodeBinary
  257. # define Double_decodeBinary UInt64_decodeBinary
  258. #else
  259. #include <math.h>
  260. #pragma message "No native IEEE 754 format detected. Use slow generic encoding."
  261. /* Handling of IEEE754 floating point values was taken from Beej's Guide to
  262. * Network Programming (http://beej.us/guide/bgnet/) and enhanced to cover the
  263. * edge cases +/-0, +/-inf and nan. */
  264. static uint64_t
  265. pack754(long double f, unsigned bits, unsigned expbits) {
  266. unsigned significandbits = bits - expbits - 1;
  267. long double fnorm;
  268. long long sign;
  269. if(f < 0) { sign = 1; fnorm = -f; }
  270. else { sign = 0; fnorm = f; }
  271. int shift = 0;
  272. while(fnorm >= 2.0) { fnorm /= 2.0; ++shift; }
  273. while(fnorm < 1.0) { fnorm *= 2.0; --shift; }
  274. fnorm = fnorm - 1.0;
  275. long long significand = (long long)(fnorm * ((float)(1LL<<significandbits) + 0.5f));
  276. long long exponent = shift + ((1<<(expbits-1)) - 1);
  277. return (uint64_t)((sign<<(bits-1)) | (exponent<<(bits-expbits-1)) | significand);
  278. }
  279. static long double
  280. unpack754(uint64_t i, unsigned bits, unsigned expbits) {
  281. unsigned significandbits = bits - expbits - 1;
  282. long double result = (long double)(i&(uint64_t)((1LL<<significandbits)-1));
  283. result /= (1LL<<significandbits);
  284. result += 1.0f;
  285. unsigned bias = (unsigned)(1<<(expbits-1)) - 1;
  286. long long shift = (long long)((i>>significandbits) & (uint64_t)((1LL<<expbits)-1)) - bias;
  287. while(shift > 0) { result *= 2.0; --shift; }
  288. while(shift < 0) { result /= 2.0; ++shift; }
  289. result *= ((i>>(bits-1))&1)? -1.0: 1.0;
  290. return result;
  291. }
  292. /* Float */
  293. #define FLOAT_NAN 0xffc00000
  294. #define FLOAT_INF 0x7f800000
  295. #define FLOAT_NEG_INF 0xff800000
  296. #define FLOAT_NEG_ZERO 0x80000000
  297. ENCODE_BINARY(Float) {
  298. UA_Float f = *src;
  299. u32 encoded;
  300. /* cppcheck-suppress duplicateExpression */
  301. if(f != f) encoded = FLOAT_NAN;
  302. else if(f == 0.0f) encoded = signbit(f) ? FLOAT_NEG_ZERO : 0;
  303. else if(f/f != f/f) encoded = f > 0 ? FLOAT_INF : FLOAT_NEG_INF;
  304. else encoded = (u32)pack754(f, 32, 8);
  305. return ENCODE_DIRECT(&encoded, UInt32);
  306. }
  307. DECODE_BINARY(Float) {
  308. u32 decoded;
  309. status ret = DECODE_DIRECT(&decoded, UInt32);
  310. if(ret != UA_STATUSCODE_GOOD)
  311. return ret;
  312. if(decoded == 0) *dst = 0.0f;
  313. else if(decoded == FLOAT_NEG_ZERO) *dst = -0.0f;
  314. else if(decoded == FLOAT_INF) *dst = INFINITY;
  315. else if(decoded == FLOAT_NEG_INF) *dst = -INFINITY;
  316. else if((decoded >= 0x7f800001 && decoded <= 0x7fffffff) ||
  317. (decoded >= 0xff800001)) *dst = NAN;
  318. else *dst = (UA_Float)unpack754(decoded, 32, 8);
  319. return UA_STATUSCODE_GOOD;
  320. }
  321. /* Double */
  322. #define DOUBLE_NAN 0xfff8000000000000L
  323. #define DOUBLE_INF 0x7ff0000000000000L
  324. #define DOUBLE_NEG_INF 0xfff0000000000000L
  325. #define DOUBLE_NEG_ZERO 0x8000000000000000L
  326. ENCODE_BINARY(Double) {
  327. UA_Double d = *src;
  328. u64 encoded;
  329. /* cppcheck-suppress duplicateExpression */
  330. if(d != d) encoded = DOUBLE_NAN;
  331. else if(d == 0.0) encoded = signbit(d) ? DOUBLE_NEG_ZERO : 0;
  332. else if(d/d != d/d) encoded = d > 0 ? DOUBLE_INF : DOUBLE_NEG_INF;
  333. else encoded = pack754(d, 64, 11);
  334. return ENCODE_DIRECT(&encoded, UInt64);
  335. }
  336. DECODE_BINARY(Double) {
  337. u64 decoded;
  338. status ret = DECODE_DIRECT(&decoded, UInt64);
  339. if(ret != UA_STATUSCODE_GOOD)
  340. return ret;
  341. if(decoded == 0) *dst = 0.0;
  342. else if(decoded == DOUBLE_NEG_ZERO) *dst = -0.0;
  343. else if(decoded == DOUBLE_INF) *dst = INFINITY;
  344. else if(decoded == DOUBLE_NEG_INF) *dst = -INFINITY;
  345. else if((decoded >= 0x7ff0000000000001L && decoded <= 0x7fffffffffffffffL) ||
  346. (decoded >= 0xfff0000000000001L)) *dst = NAN;
  347. else *dst = (UA_Double)unpack754(decoded, 64, 11);
  348. return UA_STATUSCODE_GOOD;
  349. }
  350. #endif
  351. /******************/
  352. /* Array Handling */
  353. /******************/
  354. static status
  355. Array_encodeBinaryOverlayable(uintptr_t ptr, size_t length,
  356. size_t elementMemSize, Ctx *ctx) {
  357. /* Store the number of already encoded elements */
  358. size_t finished = 0;
  359. /* Loop as long as more elements remain than fit into the chunk */
  360. while(ctx->end < ctx->pos + (elementMemSize * (length-finished))) {
  361. size_t possible = ((uintptr_t)ctx->end - (uintptr_t)ctx->pos) / (sizeof(u8) * elementMemSize);
  362. size_t possibleMem = possible * elementMemSize;
  363. memcpy(ctx->pos, (void*)ptr, possibleMem);
  364. ctx->pos += possibleMem;
  365. ptr += possibleMem;
  366. finished += possible;
  367. status ret = exchangeBuffer(ctx);
  368. ctx->oldpos = NULL; /* Set the sentinel so that no upper stack frame
  369. * with a saved pos attempts to exchange from an
  370. * invalid position in the old buffer. */
  371. if(ret != UA_STATUSCODE_GOOD)
  372. return ret;
  373. }
  374. /* Encode the remaining elements */
  375. memcpy(ctx->pos, (void*)ptr, elementMemSize * (length-finished));
  376. ctx->pos += elementMemSize * (length-finished);
  377. return UA_STATUSCODE_GOOD;
  378. }
  379. static status
  380. Array_encodeBinaryComplex(uintptr_t ptr, size_t length,
  381. const UA_DataType *type, Ctx *ctx) {
  382. /* Encode every element */
  383. for(size_t i = 0; i < length; ++i) {
  384. status ret = encodeWithExchangeBuffer((const void*)ptr, type, ctx);
  385. ptr += type->memSize;
  386. if(ret != UA_STATUSCODE_GOOD)
  387. return ret; /* Unrecoverable fail */
  388. }
  389. return UA_STATUSCODE_GOOD;
  390. }
  391. static status
  392. Array_encodeBinary(const void *src, size_t length,
  393. const UA_DataType *type, Ctx *ctx) {
  394. /* Check and convert the array length to int32 */
  395. i32 signed_length = -1;
  396. if(length > UA_INT32_MAX)
  397. return UA_STATUSCODE_BADINTERNALERROR;
  398. if(length > 0)
  399. signed_length = (i32)length;
  400. else if(src == UA_EMPTY_ARRAY_SENTINEL)
  401. signed_length = 0;
  402. /* Encode the array length */
  403. status ret = ENCODE_WITHEXCHANGE(&signed_length, UA_TYPES_INT32);
  404. /* Quit early? */
  405. if(ret != UA_STATUSCODE_GOOD || length == 0)
  406. return ret;
  407. /* Encode the content */
  408. if(!type->overlayable)
  409. return Array_encodeBinaryComplex((uintptr_t)src, length, type, ctx);
  410. return Array_encodeBinaryOverlayable((uintptr_t)src, length, type->memSize, ctx);
  411. }
  412. static status
  413. Array_decodeBinary(void *UA_RESTRICT *UA_RESTRICT dst, size_t *out_length,
  414. const UA_DataType *type, Ctx *ctx) {
  415. /* Decode the length */
  416. i32 signed_length;
  417. status ret = DECODE_DIRECT(&signed_length, UInt32); /* Int32 */
  418. if(ret != UA_STATUSCODE_GOOD)
  419. return ret;
  420. /* Return early for empty arrays */
  421. if(signed_length <= 0) {
  422. *out_length = 0;
  423. if(signed_length < 0)
  424. *dst = NULL;
  425. else
  426. *dst = UA_EMPTY_ARRAY_SENTINEL;
  427. return UA_STATUSCODE_GOOD;
  428. }
  429. /* Filter out arrays that can obviously not be decoded, because the message
  430. * is too small for the array length. This prevents the allocation of very
  431. * long arrays for bogus messages.*/
  432. size_t length = (size_t)signed_length;
  433. if(ctx->pos + ((type->memSize * length) / 32) > ctx->end)
  434. return UA_STATUSCODE_BADDECODINGERROR;
  435. /* Allocate memory */
  436. *dst = UA_calloc(length, type->memSize);
  437. if(!*dst)
  438. return UA_STATUSCODE_BADOUTOFMEMORY;
  439. if(type->overlayable) {
  440. /* memcpy overlayable array */
  441. if(ctx->end < ctx->pos + (type->memSize * length)) {
  442. UA_free(*dst);
  443. *dst = NULL;
  444. return UA_STATUSCODE_BADDECODINGERROR;
  445. }
  446. memcpy(*dst, ctx->pos, type->memSize * length);
  447. ctx->pos += type->memSize * length;
  448. } else {
  449. /* Decode array members */
  450. uintptr_t ptr = (uintptr_t)*dst;
  451. for(size_t i = 0; i < length; ++i) {
  452. ret = decodeBinaryJumpTable[type->typeKind]((void*)ptr, type, ctx);
  453. if(ret != UA_STATUSCODE_GOOD) {
  454. /* +1 because last element is also already initialized */
  455. UA_Array_delete(*dst, i+1, type);
  456. *dst = NULL;
  457. return ret;
  458. }
  459. ptr += type->memSize;
  460. }
  461. }
  462. *out_length = length;
  463. return UA_STATUSCODE_GOOD;
  464. }
  465. /*****************/
  466. /* Builtin Types */
  467. /*****************/
  468. ENCODE_BINARY(String) {
  469. return Array_encodeBinary(src->data, src->length, &UA_TYPES[UA_TYPES_BYTE], ctx);
  470. }
  471. DECODE_BINARY(String) {
  472. return Array_decodeBinary((void**)&dst->data, &dst->length, &UA_TYPES[UA_TYPES_BYTE], ctx);
  473. }
  474. /* Guid */
  475. ENCODE_BINARY(Guid) {
  476. status ret = UA_STATUSCODE_GOOD;
  477. ret |= ENCODE_DIRECT(&src->data1, UInt32);
  478. ret |= ENCODE_DIRECT(&src->data2, UInt16);
  479. ret |= ENCODE_DIRECT(&src->data3, UInt16);
  480. if(ctx->pos + (8*sizeof(u8)) > ctx->end)
  481. return UA_STATUSCODE_BADENCODINGLIMITSEXCEEDED;
  482. memcpy(ctx->pos, src->data4, 8*sizeof(u8));
  483. ctx->pos += 8;
  484. return ret;
  485. }
  486. DECODE_BINARY(Guid) {
  487. status ret = UA_STATUSCODE_GOOD;
  488. ret |= DECODE_DIRECT(&dst->data1, UInt32);
  489. ret |= DECODE_DIRECT(&dst->data2, UInt16);
  490. ret |= DECODE_DIRECT(&dst->data3, UInt16);
  491. if(ctx->pos + (8*sizeof(u8)) > ctx->end)
  492. return UA_STATUSCODE_BADDECODINGERROR;
  493. memcpy(dst->data4, ctx->pos, 8*sizeof(u8));
  494. ctx->pos += 8;
  495. return ret;
  496. }
  497. /* NodeId */
  498. #define UA_NODEIDTYPE_NUMERIC_TWOBYTE 0
  499. #define UA_NODEIDTYPE_NUMERIC_FOURBYTE 1
  500. #define UA_NODEIDTYPE_NUMERIC_COMPLETE 2
  501. #define UA_EXPANDEDNODEID_SERVERINDEX_FLAG 0x40
  502. #define UA_EXPANDEDNODEID_NAMESPACEURI_FLAG 0x80
  503. /* For ExpandedNodeId, we prefill the encoding mask. */
  504. static status
  505. NodeId_encodeBinaryWithEncodingMask(UA_NodeId const *src, u8 encoding, Ctx *ctx) {
  506. status ret = UA_STATUSCODE_GOOD;
  507. switch(src->identifierType) {
  508. case UA_NODEIDTYPE_NUMERIC:
  509. if(src->identifier.numeric > UA_UINT16_MAX || src->namespaceIndex > UA_BYTE_MAX) {
  510. encoding |= UA_NODEIDTYPE_NUMERIC_COMPLETE;
  511. ret |= ENCODE_DIRECT(&encoding, Byte);
  512. ret |= ENCODE_DIRECT(&src->namespaceIndex, UInt16);
  513. ret |= ENCODE_DIRECT(&src->identifier.numeric, UInt32);
  514. } else if(src->identifier.numeric > UA_BYTE_MAX || src->namespaceIndex > 0) {
  515. encoding |= UA_NODEIDTYPE_NUMERIC_FOURBYTE;
  516. ret |= ENCODE_DIRECT(&encoding, Byte);
  517. u8 nsindex = (u8)src->namespaceIndex;
  518. ret |= ENCODE_DIRECT(&nsindex, Byte);
  519. u16 identifier16 = (u16)src->identifier.numeric;
  520. ret |= ENCODE_DIRECT(&identifier16, UInt16);
  521. } else {
  522. encoding |= UA_NODEIDTYPE_NUMERIC_TWOBYTE;
  523. ret |= ENCODE_DIRECT(&encoding, Byte);
  524. u8 identifier8 = (u8)src->identifier.numeric;
  525. ret |= ENCODE_DIRECT(&identifier8, Byte);
  526. }
  527. break;
  528. case UA_NODEIDTYPE_STRING:
  529. encoding |= UA_NODEIDTYPE_STRING;
  530. ret |= ENCODE_DIRECT(&encoding, Byte);
  531. ret |= ENCODE_DIRECT(&src->namespaceIndex, UInt16);
  532. if(ret != UA_STATUSCODE_GOOD)
  533. return ret;
  534. ret = ENCODE_DIRECT(&src->identifier.string, String);
  535. break;
  536. case UA_NODEIDTYPE_GUID:
  537. encoding |= UA_NODEIDTYPE_GUID;
  538. ret |= ENCODE_DIRECT(&encoding, Byte);
  539. ret |= ENCODE_DIRECT(&src->namespaceIndex, UInt16);
  540. ret |= ENCODE_DIRECT(&src->identifier.guid, Guid);
  541. break;
  542. case UA_NODEIDTYPE_BYTESTRING:
  543. encoding |= UA_NODEIDTYPE_BYTESTRING;
  544. ret |= ENCODE_DIRECT(&encoding, Byte);
  545. ret |= ENCODE_DIRECT(&src->namespaceIndex, UInt16);
  546. if(ret != UA_STATUSCODE_GOOD)
  547. return ret;
  548. ret = ENCODE_DIRECT(&src->identifier.byteString, String); /* ByteString */
  549. break;
  550. default:
  551. return UA_STATUSCODE_BADINTERNALERROR;
  552. }
  553. return ret;
  554. }
  555. ENCODE_BINARY(NodeId) {
  556. return NodeId_encodeBinaryWithEncodingMask(src, 0, ctx);
  557. }
  558. DECODE_BINARY(NodeId) {
  559. u8 dstByte = 0, encodingByte = 0;
  560. u16 dstUInt16 = 0;
  561. /* Decode the encoding bitfield */
  562. status ret = DECODE_DIRECT(&encodingByte, Byte);
  563. if(ret != UA_STATUSCODE_GOOD)
  564. return ret;
  565. /* Filter out the bits used only for ExpandedNodeIds */
  566. encodingByte &= (u8)~(UA_EXPANDEDNODEID_SERVERINDEX_FLAG |
  567. UA_EXPANDEDNODEID_NAMESPACEURI_FLAG);
  568. /* Decode the namespace and identifier */
  569. switch(encodingByte) {
  570. case UA_NODEIDTYPE_NUMERIC_TWOBYTE:
  571. dst->identifierType = UA_NODEIDTYPE_NUMERIC;
  572. ret = DECODE_DIRECT(&dstByte, Byte);
  573. dst->identifier.numeric = dstByte;
  574. dst->namespaceIndex = 0;
  575. break;
  576. case UA_NODEIDTYPE_NUMERIC_FOURBYTE:
  577. dst->identifierType = UA_NODEIDTYPE_NUMERIC;
  578. ret |= DECODE_DIRECT(&dstByte, Byte);
  579. dst->namespaceIndex = dstByte;
  580. ret |= DECODE_DIRECT(&dstUInt16, UInt16);
  581. dst->identifier.numeric = dstUInt16;
  582. break;
  583. case UA_NODEIDTYPE_NUMERIC_COMPLETE:
  584. dst->identifierType = UA_NODEIDTYPE_NUMERIC;
  585. ret |= DECODE_DIRECT(&dst->namespaceIndex, UInt16);
  586. ret |= DECODE_DIRECT(&dst->identifier.numeric, UInt32);
  587. break;
  588. case UA_NODEIDTYPE_STRING:
  589. dst->identifierType = UA_NODEIDTYPE_STRING;
  590. ret |= DECODE_DIRECT(&dst->namespaceIndex, UInt16);
  591. ret |= DECODE_DIRECT(&dst->identifier.string, String);
  592. break;
  593. case UA_NODEIDTYPE_GUID:
  594. dst->identifierType = UA_NODEIDTYPE_GUID;
  595. ret |= DECODE_DIRECT(&dst->namespaceIndex, UInt16);
  596. ret |= DECODE_DIRECT(&dst->identifier.guid, Guid);
  597. break;
  598. case UA_NODEIDTYPE_BYTESTRING:
  599. dst->identifierType = UA_NODEIDTYPE_BYTESTRING;
  600. ret |= DECODE_DIRECT(&dst->namespaceIndex, UInt16);
  601. ret |= DECODE_DIRECT(&dst->identifier.byteString, String); /* ByteString */
  602. break;
  603. default:
  604. ret |= UA_STATUSCODE_BADINTERNALERROR;
  605. break;
  606. }
  607. return ret;
  608. }
  609. /* ExpandedNodeId */
  610. ENCODE_BINARY(ExpandedNodeId) {
  611. /* Set up the encoding mask */
  612. u8 encoding = 0;
  613. if((void*)src->namespaceUri.data > UA_EMPTY_ARRAY_SENTINEL)
  614. encoding |= UA_EXPANDEDNODEID_NAMESPACEURI_FLAG;
  615. if(src->serverIndex > 0)
  616. encoding |= UA_EXPANDEDNODEID_SERVERINDEX_FLAG;
  617. /* Encode the NodeId */
  618. status ret = NodeId_encodeBinaryWithEncodingMask(&src->nodeId, encoding, ctx);
  619. if(ret != UA_STATUSCODE_GOOD)
  620. return ret;
  621. /* Encode the namespace. */
  622. if((void*)src->namespaceUri.data > UA_EMPTY_ARRAY_SENTINEL) {
  623. ret = ENCODE_DIRECT(&src->namespaceUri, String);
  624. if(ret != UA_STATUSCODE_GOOD)
  625. return ret;
  626. }
  627. /* Encode the serverIndex */
  628. if(src->serverIndex > 0)
  629. ret = ENCODE_WITHEXCHANGE(&src->serverIndex, UA_TYPES_UINT32);
  630. return ret;
  631. }
  632. DECODE_BINARY(ExpandedNodeId) {
  633. /* Decode the encoding mask */
  634. if(ctx->pos >= ctx->end)
  635. return UA_STATUSCODE_BADDECODINGERROR;
  636. u8 encoding = *ctx->pos;
  637. /* Decode the NodeId */
  638. status ret = DECODE_DIRECT(&dst->nodeId, NodeId);
  639. /* Decode the NamespaceUri */
  640. if(encoding & UA_EXPANDEDNODEID_NAMESPACEURI_FLAG) {
  641. dst->nodeId.namespaceIndex = 0;
  642. ret |= DECODE_DIRECT(&dst->namespaceUri, String);
  643. }
  644. /* Decode the ServerIndex */
  645. if(encoding & UA_EXPANDEDNODEID_SERVERINDEX_FLAG)
  646. ret |= DECODE_DIRECT(&dst->serverIndex, UInt32);
  647. return ret;
  648. }
  649. /* QualifiedName */
  650. ENCODE_BINARY(QualifiedName) {
  651. return ENCODE_DIRECT(&src->namespaceIndex, UInt16) |
  652. ENCODE_DIRECT(&src->name, String);
  653. }
  654. DECODE_BINARY(QualifiedName) {
  655. return DECODE_DIRECT(&dst->namespaceIndex, UInt16) |
  656. DECODE_DIRECT(&dst->name, String);
  657. }
  658. /* LocalizedText */
  659. #define UA_LOCALIZEDTEXT_ENCODINGMASKTYPE_LOCALE 0x01
  660. #define UA_LOCALIZEDTEXT_ENCODINGMASKTYPE_TEXT 0x02
  661. ENCODE_BINARY(LocalizedText) {
  662. /* Set up the encoding mask */
  663. u8 encoding = 0;
  664. if(src->locale.data)
  665. encoding |= UA_LOCALIZEDTEXT_ENCODINGMASKTYPE_LOCALE;
  666. if(src->text.data)
  667. encoding |= UA_LOCALIZEDTEXT_ENCODINGMASKTYPE_TEXT;
  668. /* Encode the encoding byte */
  669. status ret = ENCODE_DIRECT(&encoding, Byte);
  670. if(ret != UA_STATUSCODE_GOOD)
  671. return ret;
  672. /* Encode the strings */
  673. if(encoding & UA_LOCALIZEDTEXT_ENCODINGMASKTYPE_LOCALE)
  674. ret |= ENCODE_DIRECT(&src->locale, String);
  675. if(encoding & UA_LOCALIZEDTEXT_ENCODINGMASKTYPE_TEXT)
  676. ret |= ENCODE_DIRECT(&src->text, String);
  677. return ret;
  678. }
  679. DECODE_BINARY(LocalizedText) {
  680. /* Decode the encoding mask */
  681. u8 encoding = 0;
  682. status ret = DECODE_DIRECT(&encoding, Byte);
  683. /* Decode the content */
  684. if(encoding & UA_LOCALIZEDTEXT_ENCODINGMASKTYPE_LOCALE)
  685. ret |= DECODE_DIRECT(&dst->locale, String);
  686. if(encoding & UA_LOCALIZEDTEXT_ENCODINGMASKTYPE_TEXT)
  687. ret |= DECODE_DIRECT(&dst->text, String);
  688. return ret;
  689. }
  690. /* The binary encoding has a different nodeid from the data type. So it is not
  691. * possible to reuse UA_findDataType */
  692. static const UA_DataType *
  693. UA_findDataTypeByBinaryInternal(const UA_NodeId *typeId, Ctx *ctx) {
  694. /* We only store a numeric identifier for the encoding nodeid of data types */
  695. if(typeId->identifierType != UA_NODEIDTYPE_NUMERIC)
  696. return NULL;
  697. /* Always look in built-in types first
  698. * (may contain data types from all namespaces) */
  699. for(size_t i = 0; i < UA_TYPES_COUNT; ++i) {
  700. if(UA_TYPES[i].binaryEncodingId == typeId->identifier.numeric &&
  701. UA_TYPES[i].typeId.namespaceIndex == typeId->namespaceIndex)
  702. return &UA_TYPES[i];
  703. }
  704. const UA_DataTypeArray *customTypes = ctx->customTypes;
  705. while(customTypes) {
  706. for(size_t i = 0; i < customTypes->typesSize; ++i) {
  707. if(customTypes->types[i].binaryEncodingId == typeId->identifier.numeric &&
  708. customTypes->types[i].typeId.namespaceIndex == typeId->namespaceIndex)
  709. return &customTypes->types[i];
  710. }
  711. customTypes = customTypes->next;
  712. }
  713. return NULL;
  714. }
  715. const UA_DataType *
  716. UA_findDataTypeByBinary(const UA_NodeId *typeId) {
  717. Ctx ctx;
  718. ctx.customTypes = NULL;
  719. return UA_findDataTypeByBinaryInternal(typeId, &ctx);
  720. }
  721. /* ExtensionObject */
  722. ENCODE_BINARY(ExtensionObject) {
  723. u8 encoding = (u8)src->encoding;
  724. /* No content or already encoded content. */
  725. if(encoding <= UA_EXTENSIONOBJECT_ENCODED_XML) {
  726. status ret = ENCODE_DIRECT(&src->content.encoded.typeId, NodeId);
  727. if(ret != UA_STATUSCODE_GOOD)
  728. return ret;
  729. ret = ENCODE_WITHEXCHANGE(&encoding, UA_TYPES_BYTE);
  730. if(ret != UA_STATUSCODE_GOOD)
  731. return ret;
  732. switch(src->encoding) {
  733. case UA_EXTENSIONOBJECT_ENCODED_NOBODY:
  734. break;
  735. case UA_EXTENSIONOBJECT_ENCODED_BYTESTRING:
  736. case UA_EXTENSIONOBJECT_ENCODED_XML:
  737. ret = ENCODE_DIRECT(&src->content.encoded.body, String); /* ByteString */
  738. break;
  739. default:
  740. ret = UA_STATUSCODE_BADINTERNALERROR;
  741. }
  742. return ret;
  743. }
  744. /* Cannot encode with no data or no type description */
  745. if(!src->content.decoded.type || !src->content.decoded.data)
  746. return UA_STATUSCODE_BADENCODINGERROR;
  747. /* Write the NodeId for the binary encoded type. The NodeId is always
  748. * numeric, so no buffer replacement is taking place. */
  749. UA_NodeId typeId = src->content.decoded.type->typeId;
  750. if(typeId.identifierType != UA_NODEIDTYPE_NUMERIC)
  751. return UA_STATUSCODE_BADENCODINGERROR;
  752. typeId.identifier.numeric = src->content.decoded.type->binaryEncodingId;
  753. status ret = ENCODE_DIRECT(&typeId, NodeId);
  754. /* Write the encoding byte */
  755. encoding = UA_EXTENSIONOBJECT_ENCODED_BYTESTRING;
  756. ret |= ENCODE_DIRECT(&encoding, Byte);
  757. /* Compute the content length */
  758. const UA_DataType *contentType = src->content.decoded.type;
  759. size_t len = UA_calcSizeBinary(src->content.decoded.data, contentType);
  760. /* Encode the content length */
  761. if(len > UA_INT32_MAX)
  762. return UA_STATUSCODE_BADENCODINGERROR;
  763. i32 signed_len = (i32)len;
  764. ret |= ENCODE_DIRECT(&signed_len, UInt32); /* Int32 */
  765. /* Return early upon failures (no buffer exchange until here) */
  766. if(ret != UA_STATUSCODE_GOOD)
  767. return ret;
  768. /* Encode the content */
  769. return encodeWithExchangeBuffer(src->content.decoded.data, contentType, ctx);
  770. }
  771. static status
  772. ExtensionObject_decodeBinaryContent(UA_ExtensionObject *dst, const UA_NodeId *typeId, Ctx *ctx) {
  773. /* Lookup the datatype */
  774. const UA_DataType *type = UA_findDataTypeByBinaryInternal(typeId, ctx);
  775. /* Unknown type, just take the binary content */
  776. if(!type) {
  777. dst->encoding = UA_EXTENSIONOBJECT_ENCODED_BYTESTRING;
  778. UA_NodeId_copy(typeId, &dst->content.encoded.typeId);
  779. return DECODE_DIRECT(&dst->content.encoded.body, String); /* ByteString */
  780. }
  781. /* Allocate memory */
  782. dst->content.decoded.data = UA_new(type);
  783. if(!dst->content.decoded.data)
  784. return UA_STATUSCODE_BADOUTOFMEMORY;
  785. /* Jump over the length field (TODO: check if the decoded length matches) */
  786. ctx->pos += 4;
  787. /* Decode */
  788. dst->encoding = UA_EXTENSIONOBJECT_DECODED;
  789. dst->content.decoded.type = type;
  790. return decodeBinaryJumpTable[type->typeKind](dst->content.decoded.data, type, ctx);
  791. }
  792. DECODE_BINARY(ExtensionObject) {
  793. u8 encoding = 0;
  794. UA_NodeId binTypeId; /* Can contain a string nodeid. But no corresponding
  795. * type is then found in open62541. We only store
  796. * numerical nodeids of the binary encoding identifier.
  797. * The extenionobject will be decoded to contain a
  798. * binary blob. */
  799. UA_NodeId_init(&binTypeId);
  800. status ret = UA_STATUSCODE_GOOD;
  801. ret |= DECODE_DIRECT(&binTypeId, NodeId);
  802. ret |= DECODE_DIRECT(&encoding, Byte);
  803. if(ret != UA_STATUSCODE_GOOD) {
  804. UA_NodeId_clear(&binTypeId);
  805. return ret;
  806. }
  807. switch(encoding) {
  808. case UA_EXTENSIONOBJECT_ENCODED_BYTESTRING:
  809. ret = ExtensionObject_decodeBinaryContent(dst, &binTypeId, ctx);
  810. UA_NodeId_deleteMembers(&binTypeId);
  811. break;
  812. case UA_EXTENSIONOBJECT_ENCODED_NOBODY:
  813. dst->encoding = (UA_ExtensionObjectEncoding)encoding;
  814. dst->content.encoded.typeId = binTypeId; /* move to dst */
  815. dst->content.encoded.body = UA_BYTESTRING_NULL;
  816. break;
  817. case UA_EXTENSIONOBJECT_ENCODED_XML:
  818. dst->encoding = (UA_ExtensionObjectEncoding)encoding;
  819. dst->content.encoded.typeId = binTypeId; /* move to dst */
  820. ret = DECODE_DIRECT(&dst->content.encoded.body, String); /* ByteString */
  821. if(ret != UA_STATUSCODE_GOOD)
  822. UA_NodeId_clear(&dst->content.encoded.typeId);
  823. break;
  824. default:
  825. UA_NodeId_clear(&binTypeId);
  826. ret = UA_STATUSCODE_BADDECODINGERROR;
  827. break;
  828. }
  829. return ret;
  830. }
  831. /* Variant */
  832. static status
  833. Variant_encodeBinaryWrapExtensionObject(const UA_Variant *src,
  834. const UA_Boolean isArray, Ctx *ctx) {
  835. /* Default to 1 for a scalar. */
  836. size_t length = 1;
  837. /* Encode the array length if required */
  838. status ret = UA_STATUSCODE_GOOD;
  839. if(isArray) {
  840. if(src->arrayLength > UA_INT32_MAX)
  841. return UA_STATUSCODE_BADENCODINGERROR;
  842. length = src->arrayLength;
  843. i32 encodedLength = (i32)src->arrayLength;
  844. ret = ENCODE_DIRECT(&encodedLength, UInt32); /* Int32 */
  845. if(ret != UA_STATUSCODE_GOOD)
  846. return ret;
  847. }
  848. /* Set up the ExtensionObject */
  849. UA_ExtensionObject eo;
  850. UA_ExtensionObject_init(&eo);
  851. eo.encoding = UA_EXTENSIONOBJECT_DECODED;
  852. eo.content.decoded.type = src->type;
  853. const u16 memSize = src->type->memSize;
  854. uintptr_t ptr = (uintptr_t)src->data;
  855. /* Iterate over the array */
  856. for(size_t i = 0; i < length && ret == UA_STATUSCODE_GOOD; ++i) {
  857. eo.content.decoded.data = (void*)ptr;
  858. ret = encodeWithExchangeBuffer(&eo, &UA_TYPES[UA_TYPES_EXTENSIONOBJECT], ctx);
  859. ptr += memSize;
  860. }
  861. return ret;
  862. }
  863. enum UA_VARIANT_ENCODINGMASKTYPE {
  864. UA_VARIANT_ENCODINGMASKTYPE_TYPEID_MASK = 0x3F, /* bits 0:5 */
  865. UA_VARIANT_ENCODINGMASKTYPE_DIMENSIONS = (0x01 << 6), /* bit 6 */
  866. UA_VARIANT_ENCODINGMASKTYPE_ARRAY = (0x01 << 7) /* bit 7 */
  867. };
  868. ENCODE_BINARY(Variant) {
  869. /* Quit early for the empty variant */
  870. u8 encoding = 0;
  871. if(!src->type)
  872. return ENCODE_DIRECT(&encoding, Byte);
  873. /* Set the content type in the encoding mask */
  874. const UA_Boolean isBuiltin = (src->type->typeKind <= UA_DATATYPEKIND_DIAGNOSTICINFO);
  875. const UA_Boolean isEnum = (src->type->typeKind == UA_DATATYPEKIND_ENUM);
  876. if(isBuiltin)
  877. encoding |= UA_VARIANT_ENCODINGMASKTYPE_TYPEID_MASK & (u8)(src->type->typeKind + 1);
  878. else if(isEnum)
  879. encoding |= UA_VARIANT_ENCODINGMASKTYPE_TYPEID_MASK & (u8)(UA_TYPES_INT32 + 1);
  880. else
  881. encoding |= UA_VARIANT_ENCODINGMASKTYPE_TYPEID_MASK & (u8)(UA_TYPES_EXTENSIONOBJECT + 1);
  882. /* Set the array type in the encoding mask */
  883. const UA_Boolean isArray = src->arrayLength > 0 || src->data <= UA_EMPTY_ARRAY_SENTINEL;
  884. const UA_Boolean hasDimensions = isArray && src->arrayDimensionsSize > 0;
  885. if(isArray) {
  886. encoding |= UA_VARIANT_ENCODINGMASKTYPE_ARRAY;
  887. if(hasDimensions)
  888. encoding |= UA_VARIANT_ENCODINGMASKTYPE_DIMENSIONS;
  889. }
  890. /* Encode the encoding byte */
  891. status ret = ENCODE_DIRECT(&encoding, Byte);
  892. if(ret != UA_STATUSCODE_GOOD)
  893. return ret;
  894. /* Encode the content */
  895. if(!isBuiltin && !isEnum)
  896. ret = Variant_encodeBinaryWrapExtensionObject(src, isArray, ctx);
  897. else if(!isArray)
  898. ret = encodeWithExchangeBuffer(src->data, src->type, ctx);
  899. else
  900. ret = Array_encodeBinary(src->data, src->arrayLength, src->type, ctx);
  901. /* Encode the array dimensions */
  902. if(hasDimensions && ret == UA_STATUSCODE_GOOD)
  903. ret = Array_encodeBinary(src->arrayDimensions, src->arrayDimensionsSize,
  904. &UA_TYPES[UA_TYPES_INT32], ctx);
  905. return ret;
  906. }
  907. static status
  908. Variant_decodeBinaryUnwrapExtensionObject(UA_Variant *dst, Ctx *ctx) {
  909. /* Save the position in the ByteString. If unwrapping is not possible, start
  910. * from here to decode a normal ExtensionObject. */
  911. u8 *old_pos = ctx->pos;
  912. /* Decode the DataType */
  913. UA_NodeId typeId;
  914. UA_NodeId_init(&typeId);
  915. status ret = DECODE_DIRECT(&typeId, NodeId);
  916. if(ret != UA_STATUSCODE_GOOD)
  917. return ret;
  918. /* Decode the EncodingByte */
  919. u8 encoding;
  920. ret = DECODE_DIRECT(&encoding, Byte);
  921. if(ret != UA_STATUSCODE_GOOD) {
  922. UA_NodeId_clear(&typeId);
  923. return ret;
  924. }
  925. /* Search for the datatype. Default to ExtensionObject. */
  926. if(encoding == UA_EXTENSIONOBJECT_ENCODED_BYTESTRING &&
  927. (dst->type = UA_findDataTypeByBinaryInternal(&typeId, ctx)) != NULL) {
  928. /* Jump over the length field (TODO: check if length matches) */
  929. ctx->pos += 4;
  930. } else {
  931. /* Reset and decode as ExtensionObject */
  932. dst->type = &UA_TYPES[UA_TYPES_EXTENSIONOBJECT];
  933. ctx->pos = old_pos;
  934. UA_NodeId_clear(&typeId);
  935. }
  936. /* Allocate memory */
  937. dst->data = UA_new(dst->type);
  938. if(!dst->data)
  939. return UA_STATUSCODE_BADOUTOFMEMORY;
  940. /* Decode the content */
  941. return decodeBinaryJumpTable[dst->type->typeKind](dst->data, dst->type, ctx);
  942. }
  943. /* The resulting variant always has the storagetype UA_VARIANT_DATA. */
  944. DECODE_BINARY(Variant) {
  945. /* Decode the encoding byte */
  946. u8 encodingByte;
  947. status ret = DECODE_DIRECT(&encodingByte, Byte);
  948. if(ret != UA_STATUSCODE_GOOD)
  949. return ret;
  950. /* Return early for an empty variant (was already _inited) */
  951. if(encodingByte == 0)
  952. return UA_STATUSCODE_GOOD;
  953. /* Does the variant contain an array? */
  954. const UA_Boolean isArray = (encodingByte & UA_VARIANT_ENCODINGMASKTYPE_ARRAY) > 0;
  955. /* Get the datatype of the content. The type must be a builtin data type.
  956. * All not-builtin types are wrapped in an ExtensionObject. The "type kind"
  957. * for types up to DiagnsticInfo equals to the index in the encoding
  958. * byte. */
  959. size_t typeKind = (size_t)((encodingByte & UA_VARIANT_ENCODINGMASKTYPE_TYPEID_MASK) - 1);
  960. if(typeKind > UA_DATATYPEKIND_DIAGNOSTICINFO)
  961. return UA_STATUSCODE_BADDECODINGERROR;
  962. /* A variant cannot contain a variant. But it can contain an array of
  963. * variants */
  964. if(typeKind == UA_DATATYPEKIND_VARIANT && !isArray)
  965. return UA_STATUSCODE_BADDECODINGERROR;
  966. /* Check the recursion limit */
  967. if(ctx->depth > UA_ENCODING_MAX_RECURSION)
  968. return UA_STATUSCODE_BADENCODINGERROR;
  969. ctx->depth++;
  970. /* Decode the content */
  971. dst->type = &UA_TYPES[typeKind];
  972. if(isArray) {
  973. ret = Array_decodeBinary(&dst->data, &dst->arrayLength, dst->type, ctx);
  974. } else if(typeKind != UA_DATATYPEKIND_EXTENSIONOBJECT) {
  975. dst->data = UA_new(dst->type);
  976. if(!dst->data)
  977. return UA_STATUSCODE_BADOUTOFMEMORY;
  978. ret = decodeBinaryJumpTable[typeKind](dst->data, dst->type, ctx);
  979. } else {
  980. ret = Variant_decodeBinaryUnwrapExtensionObject(dst, ctx);
  981. }
  982. /* Decode array dimensions */
  983. if(isArray && (encodingByte & UA_VARIANT_ENCODINGMASKTYPE_DIMENSIONS) > 0)
  984. ret |= Array_decodeBinary((void**)&dst->arrayDimensions, &dst->arrayDimensionsSize,
  985. &UA_TYPES[UA_TYPES_INT32], ctx);
  986. ctx->depth--;
  987. return ret;
  988. }
  989. /* DataValue */
  990. ENCODE_BINARY(DataValue) {
  991. /* Set up the encoding mask */
  992. u8 encodingMask = (u8)
  993. (((u8)src->hasValue) |
  994. ((u8)src->hasStatus << 1) |
  995. ((u8)src->hasSourceTimestamp << 2) |
  996. ((u8)src->hasServerTimestamp << 3) |
  997. ((u8)src->hasSourcePicoseconds << 4) |
  998. ((u8)src->hasServerPicoseconds << 5));
  999. /* Encode the encoding byte */
  1000. status ret = ENCODE_DIRECT(&encodingMask, Byte);
  1001. if(ret != UA_STATUSCODE_GOOD)
  1002. return ret;
  1003. /* Encode the variant. */
  1004. if(src->hasValue) {
  1005. ret = ENCODE_DIRECT(&src->value, Variant);
  1006. if(ret != UA_STATUSCODE_GOOD)
  1007. return ret;
  1008. }
  1009. if(src->hasStatus)
  1010. ret |= ENCODE_WITHEXCHANGE(&src->status, UA_TYPES_STATUSCODE);
  1011. if(src->hasSourceTimestamp)
  1012. ret |= ENCODE_WITHEXCHANGE(&src->sourceTimestamp, UA_TYPES_DATETIME);
  1013. if(src->hasSourcePicoseconds)
  1014. ret |= ENCODE_WITHEXCHANGE(&src->sourcePicoseconds, UA_TYPES_UINT16);
  1015. if(src->hasServerTimestamp)
  1016. ret |= ENCODE_WITHEXCHANGE(&src->serverTimestamp, UA_TYPES_DATETIME);
  1017. if(src->hasServerPicoseconds)
  1018. ret |= ENCODE_WITHEXCHANGE(&src->serverPicoseconds, UA_TYPES_UINT16);
  1019. return ret;
  1020. }
  1021. #define MAX_PICO_SECONDS 9999
  1022. DECODE_BINARY(DataValue) {
  1023. /* Decode the encoding mask */
  1024. u8 encodingMask;
  1025. status ret = DECODE_DIRECT(&encodingMask, Byte);
  1026. if(ret != UA_STATUSCODE_GOOD)
  1027. return ret;
  1028. /* Check the recursion limit */
  1029. if(ctx->depth > UA_ENCODING_MAX_RECURSION)
  1030. return UA_STATUSCODE_BADENCODINGERROR;
  1031. ctx->depth++;
  1032. /* Decode the content */
  1033. if(encodingMask & 0x01) {
  1034. dst->hasValue = true;
  1035. ret |= DECODE_DIRECT(&dst->value, Variant);
  1036. }
  1037. if(encodingMask & 0x02) {
  1038. dst->hasStatus = true;
  1039. ret |= DECODE_DIRECT(&dst->status, UInt32); /* StatusCode */
  1040. }
  1041. if(encodingMask & 0x04) {
  1042. dst->hasSourceTimestamp = true;
  1043. ret |= DECODE_DIRECT(&dst->sourceTimestamp, UInt64); /* DateTime */
  1044. }
  1045. if(encodingMask & 0x10) {
  1046. dst->hasSourcePicoseconds = true;
  1047. ret |= DECODE_DIRECT(&dst->sourcePicoseconds, UInt16);
  1048. if(dst->sourcePicoseconds > MAX_PICO_SECONDS)
  1049. dst->sourcePicoseconds = MAX_PICO_SECONDS;
  1050. }
  1051. if(encodingMask & 0x08) {
  1052. dst->hasServerTimestamp = true;
  1053. ret |= DECODE_DIRECT(&dst->serverTimestamp, UInt64); /* DateTime */
  1054. }
  1055. if(encodingMask & 0x20) {
  1056. dst->hasServerPicoseconds = true;
  1057. ret |= DECODE_DIRECT(&dst->serverPicoseconds, UInt16);
  1058. if(dst->serverPicoseconds > MAX_PICO_SECONDS)
  1059. dst->serverPicoseconds = MAX_PICO_SECONDS;
  1060. }
  1061. ctx->depth--;
  1062. return ret;
  1063. }
  1064. /* DiagnosticInfo */
  1065. ENCODE_BINARY(DiagnosticInfo) {
  1066. /* Set up the encoding mask */
  1067. u8 encodingMask = (u8)
  1068. ((u8)src->hasSymbolicId | ((u8)src->hasNamespaceUri << 1) |
  1069. ((u8)src->hasLocalizedText << 2) | ((u8)src->hasLocale << 3) |
  1070. ((u8)src->hasAdditionalInfo << 4) | ((u8)src->hasInnerDiagnosticInfo << 5));
  1071. /* Encode the numeric content */
  1072. status ret = ENCODE_DIRECT(&encodingMask, Byte);
  1073. if(src->hasSymbolicId)
  1074. ret |= ENCODE_DIRECT(&src->symbolicId, UInt32); /* Int32 */
  1075. if(src->hasNamespaceUri)
  1076. ret |= ENCODE_DIRECT(&src->namespaceUri, UInt32); /* Int32 */
  1077. if(src->hasLocalizedText)
  1078. ret |= ENCODE_DIRECT(&src->localizedText, UInt32); /* Int32 */
  1079. if(src->hasLocale)
  1080. ret |= ENCODE_DIRECT(&src->locale, UInt32); /* Int32 */
  1081. if(ret != UA_STATUSCODE_GOOD)
  1082. return ret;
  1083. /* Encode the additional info */
  1084. if(src->hasAdditionalInfo) {
  1085. ret = ENCODE_DIRECT(&src->additionalInfo, String);
  1086. if(ret != UA_STATUSCODE_GOOD)
  1087. return ret;
  1088. }
  1089. /* Encode the inner status code */
  1090. if(src->hasInnerStatusCode) {
  1091. ret = ENCODE_WITHEXCHANGE(&src->innerStatusCode, UA_TYPES_UINT32);
  1092. if(ret != UA_STATUSCODE_GOOD)
  1093. return ret;
  1094. }
  1095. /* Encode the inner diagnostic info */
  1096. if(src->hasInnerDiagnosticInfo)
  1097. ret = ENCODE_WITHEXCHANGE(&src->innerDiagnosticInfo,
  1098. UA_TYPES_DIAGNOSTICINFO);
  1099. return ret;
  1100. }
  1101. DECODE_BINARY(DiagnosticInfo) {
  1102. /* Decode the encoding mask */
  1103. u8 encodingMask;
  1104. status ret = DECODE_DIRECT(&encodingMask, Byte);
  1105. if(ret != UA_STATUSCODE_GOOD)
  1106. return ret;
  1107. /* Decode the content */
  1108. if(encodingMask & 0x01) {
  1109. dst->hasSymbolicId = true;
  1110. ret |= DECODE_DIRECT(&dst->symbolicId, UInt32); /* Int32 */
  1111. }
  1112. if(encodingMask & 0x02) {
  1113. dst->hasNamespaceUri = true;
  1114. ret |= DECODE_DIRECT(&dst->namespaceUri, UInt32); /* Int32 */
  1115. }
  1116. if(encodingMask & 0x04) {
  1117. dst->hasLocalizedText = true;
  1118. ret |= DECODE_DIRECT(&dst->localizedText, UInt32); /* Int32 */
  1119. }
  1120. if(encodingMask & 0x08) {
  1121. dst->hasLocale = true;
  1122. ret |= DECODE_DIRECT(&dst->locale, UInt32); /* Int32 */
  1123. }
  1124. if(encodingMask & 0x10) {
  1125. dst->hasAdditionalInfo = true;
  1126. ret |= DECODE_DIRECT(&dst->additionalInfo, String);
  1127. }
  1128. if(encodingMask & 0x20) {
  1129. dst->hasInnerStatusCode = true;
  1130. ret |= DECODE_DIRECT(&dst->innerStatusCode, UInt32); /* StatusCode */
  1131. }
  1132. if(encodingMask & 0x40) {
  1133. /* innerDiagnosticInfo is allocated on the heap */
  1134. dst->innerDiagnosticInfo = (UA_DiagnosticInfo*)
  1135. UA_calloc(1, sizeof(UA_DiagnosticInfo));
  1136. if(!dst->innerDiagnosticInfo)
  1137. return UA_STATUSCODE_BADOUTOFMEMORY;
  1138. dst->hasInnerDiagnosticInfo = true;
  1139. /* Check the recursion limit */
  1140. if(ctx->depth > UA_ENCODING_MAX_RECURSION)
  1141. return UA_STATUSCODE_BADENCODINGERROR;
  1142. ctx->depth++;
  1143. ret |= DECODE_DIRECT(dst->innerDiagnosticInfo, DiagnosticInfo);
  1144. ctx->depth--;
  1145. }
  1146. return ret;
  1147. }
  1148. static status
  1149. encodeBinaryStruct(const void *src, const UA_DataType *type, Ctx *ctx) {
  1150. /* Check the recursion limit */
  1151. if(ctx->depth > UA_ENCODING_MAX_RECURSION)
  1152. return UA_STATUSCODE_BADENCODINGERROR;
  1153. ctx->depth++;
  1154. uintptr_t ptr = (uintptr_t)src;
  1155. status ret = UA_STATUSCODE_GOOD;
  1156. u8 membersSize = type->membersSize;
  1157. const UA_DataType *typelists[2] = { UA_TYPES, &type[-type->typeIndex] };
  1158. /* Loop over members */
  1159. for(size_t i = 0; i < membersSize; ++i) {
  1160. const UA_DataTypeMember *m = &type->members[i];
  1161. const UA_DataType *mt = &typelists[!m->namespaceZero][m->memberTypeIndex];
  1162. ptr += m->padding;
  1163. /* Array. Buffer-exchange is done inside Array_encodeBinary if required. */
  1164. if(m->isArray) {
  1165. const size_t length = *((const size_t*)ptr);
  1166. ptr += sizeof(size_t);
  1167. ret = Array_encodeBinary(*(void *UA_RESTRICT const *)ptr, length, mt, ctx);
  1168. ptr += sizeof(void*);
  1169. continue;
  1170. }
  1171. /* Scalar */
  1172. ret = encodeWithExchangeBuffer((const void*)ptr, mt, ctx);
  1173. ptr += mt->memSize;
  1174. }
  1175. ctx->depth--;
  1176. return ret;
  1177. }
  1178. static status
  1179. encodeBinaryNotImplemented(const void *src, const UA_DataType *type, Ctx *ctx) {
  1180. return UA_STATUSCODE_BADNOTIMPLEMENTED;
  1181. }
  1182. /********************/
  1183. /* Structured Types */
  1184. /********************/
  1185. const encodeBinarySignature encodeBinaryJumpTable[UA_DATATYPEKINDS] = {
  1186. (encodeBinarySignature)Boolean_encodeBinary,
  1187. (encodeBinarySignature)Byte_encodeBinary, /* SByte */
  1188. (encodeBinarySignature)Byte_encodeBinary,
  1189. (encodeBinarySignature)UInt16_encodeBinary, /* Int16 */
  1190. (encodeBinarySignature)UInt16_encodeBinary,
  1191. (encodeBinarySignature)UInt32_encodeBinary, /* Int32 */
  1192. (encodeBinarySignature)UInt32_encodeBinary,
  1193. (encodeBinarySignature)UInt64_encodeBinary, /* Int64 */
  1194. (encodeBinarySignature)UInt64_encodeBinary,
  1195. (encodeBinarySignature)Float_encodeBinary,
  1196. (encodeBinarySignature)Double_encodeBinary,
  1197. (encodeBinarySignature)String_encodeBinary,
  1198. (encodeBinarySignature)UInt64_encodeBinary, /* DateTime */
  1199. (encodeBinarySignature)Guid_encodeBinary,
  1200. (encodeBinarySignature)String_encodeBinary, /* ByteString */
  1201. (encodeBinarySignature)String_encodeBinary, /* XmlElement */
  1202. (encodeBinarySignature)NodeId_encodeBinary,
  1203. (encodeBinarySignature)ExpandedNodeId_encodeBinary,
  1204. (encodeBinarySignature)UInt32_encodeBinary, /* StatusCode */
  1205. (encodeBinarySignature)QualifiedName_encodeBinary,
  1206. (encodeBinarySignature)LocalizedText_encodeBinary,
  1207. (encodeBinarySignature)ExtensionObject_encodeBinary,
  1208. (encodeBinarySignature)DataValue_encodeBinary,
  1209. (encodeBinarySignature)Variant_encodeBinary,
  1210. (encodeBinarySignature)DiagnosticInfo_encodeBinary,
  1211. (encodeBinarySignature)encodeBinaryNotImplemented, /* Decimal */
  1212. (encodeBinarySignature)UInt32_encodeBinary, /* Enumeration */
  1213. (encodeBinarySignature)encodeBinaryStruct,
  1214. (encodeBinarySignature)encodeBinaryNotImplemented, /* Structure with Optional Fields */
  1215. (encodeBinarySignature)encodeBinaryStruct, /* Union */
  1216. (encodeBinarySignature)encodeBinaryStruct /* BitfieldCluster */
  1217. };
  1218. status
  1219. UA_encodeBinary(const void *src, const UA_DataType *type,
  1220. u8 **bufPos, const u8 **bufEnd,
  1221. UA_exchangeEncodeBuffer exchangeCallback, void *exchangeHandle) {
  1222. /* Set up the context */
  1223. Ctx ctx;
  1224. ctx.pos = *bufPos;
  1225. ctx.end = *bufEnd;
  1226. ctx.depth = 0;
  1227. ctx.exchangeBufferCallback = exchangeCallback;
  1228. ctx.exchangeBufferCallbackHandle = exchangeHandle;
  1229. if(!ctx.pos)
  1230. return UA_STATUSCODE_BADINVALIDARGUMENT;
  1231. /* Encode */
  1232. status ret = encodeWithExchangeBuffer(src, type, &ctx);
  1233. /* Set the new buffer position for the output. Beware that the buffer might
  1234. * have been exchanged internally. */
  1235. *bufPos = ctx.pos;
  1236. *bufEnd = ctx.end;
  1237. return ret;
  1238. }
  1239. static status
  1240. decodeBinaryNotImplemented(void *dst, const UA_DataType *type, Ctx *ctx) {
  1241. return UA_STATUSCODE_BADNOTIMPLEMENTED;
  1242. }
  1243. static status
  1244. decodeBinaryStructure(void *dst, const UA_DataType *type, Ctx *ctx) {
  1245. /* Check the recursion limit */
  1246. if(ctx->depth > UA_ENCODING_MAX_RECURSION)
  1247. return UA_STATUSCODE_BADENCODINGERROR;
  1248. ctx->depth++;
  1249. uintptr_t ptr = (uintptr_t)dst;
  1250. status ret = UA_STATUSCODE_GOOD;
  1251. u8 membersSize = type->membersSize;
  1252. const UA_DataType *typelists[2] = { UA_TYPES, &type[-type->typeIndex] };
  1253. /* Loop over members */
  1254. for(size_t i = 0; i < membersSize && ret == UA_STATUSCODE_GOOD; ++i) {
  1255. const UA_DataTypeMember *m = &type->members[i];
  1256. const UA_DataType *mt = &typelists[!m->namespaceZero][m->memberTypeIndex];
  1257. ptr += m->padding;
  1258. /* Array */
  1259. if(m->isArray) {
  1260. size_t *length = (size_t*)ptr;
  1261. ptr += sizeof(size_t);
  1262. ret = Array_decodeBinary((void *UA_RESTRICT *UA_RESTRICT)ptr, length, mt , ctx);
  1263. ptr += sizeof(void*);
  1264. continue;
  1265. }
  1266. /* Scalar */
  1267. ret = decodeBinaryJumpTable[mt->typeKind]((void *UA_RESTRICT)ptr, mt, ctx);
  1268. ptr += mt->memSize;
  1269. }
  1270. ctx->depth--;
  1271. return ret;
  1272. }
  1273. const decodeBinarySignature decodeBinaryJumpTable[UA_DATATYPEKINDS] = {
  1274. (decodeBinarySignature)Boolean_decodeBinary,
  1275. (decodeBinarySignature)Byte_decodeBinary, /* SByte */
  1276. (decodeBinarySignature)Byte_decodeBinary,
  1277. (decodeBinarySignature)UInt16_decodeBinary, /* Int16 */
  1278. (decodeBinarySignature)UInt16_decodeBinary,
  1279. (decodeBinarySignature)UInt32_decodeBinary, /* Int32 */
  1280. (decodeBinarySignature)UInt32_decodeBinary,
  1281. (decodeBinarySignature)UInt64_decodeBinary, /* Int64 */
  1282. (decodeBinarySignature)UInt64_decodeBinary,
  1283. (decodeBinarySignature)Float_decodeBinary,
  1284. (decodeBinarySignature)Double_decodeBinary,
  1285. (decodeBinarySignature)String_decodeBinary,
  1286. (decodeBinarySignature)UInt64_decodeBinary, /* DateTime */
  1287. (decodeBinarySignature)Guid_decodeBinary,
  1288. (decodeBinarySignature)String_decodeBinary, /* ByteString */
  1289. (decodeBinarySignature)String_decodeBinary, /* XmlElement */
  1290. (decodeBinarySignature)NodeId_decodeBinary,
  1291. (decodeBinarySignature)ExpandedNodeId_decodeBinary,
  1292. (decodeBinarySignature)UInt32_decodeBinary, /* StatusCode */
  1293. (decodeBinarySignature)QualifiedName_decodeBinary,
  1294. (decodeBinarySignature)LocalizedText_decodeBinary,
  1295. (decodeBinarySignature)ExtensionObject_decodeBinary,
  1296. (decodeBinarySignature)DataValue_decodeBinary,
  1297. (decodeBinarySignature)Variant_decodeBinary,
  1298. (decodeBinarySignature)DiagnosticInfo_decodeBinary,
  1299. (decodeBinarySignature)decodeBinaryNotImplemented, /* Decimal */
  1300. (decodeBinarySignature)UInt32_decodeBinary, /* Enumeration */
  1301. (decodeBinarySignature)decodeBinaryStructure,
  1302. (decodeBinarySignature)decodeBinaryNotImplemented, /* Structure with optional fields */
  1303. (decodeBinarySignature)decodeBinaryNotImplemented, /* Union */
  1304. (decodeBinarySignature)decodeBinaryNotImplemented /* BitfieldCluster */
  1305. };
  1306. status
  1307. UA_decodeBinary(const UA_ByteString *src, size_t *offset, void *dst,
  1308. const UA_DataType *type, const UA_DataTypeArray *customTypes) {
  1309. /* Set up the context */
  1310. Ctx ctx;
  1311. ctx.pos = &src->data[*offset];
  1312. ctx.end = &src->data[src->length];
  1313. ctx.depth = 0;
  1314. ctx.customTypes = customTypes;
  1315. /* Decode */
  1316. memset(dst, 0, type->memSize); /* Initialize the value */
  1317. status ret = decodeBinaryJumpTable[type->typeKind](dst, type, &ctx);
  1318. if(ret == UA_STATUSCODE_GOOD) {
  1319. /* Set the new offset */
  1320. *offset = (size_t)(ctx.pos - src->data) / sizeof(u8);
  1321. } else {
  1322. /* Clean up */
  1323. UA_clear(dst, type);
  1324. memset(dst, 0, type->memSize);
  1325. }
  1326. return ret;
  1327. }
  1328. /**
  1329. * Compute the Message Size
  1330. * ------------------------
  1331. * The following methods are used to compute the length of a datum in binary
  1332. * encoding. */
  1333. static size_t
  1334. Array_calcSizeBinary(const void *src, size_t length, const UA_DataType *type) {
  1335. size_t s = 4; /* length */
  1336. if(type->overlayable) {
  1337. s += type->memSize * length;
  1338. return s;
  1339. }
  1340. uintptr_t ptr = (uintptr_t)src;
  1341. for(size_t i = 0; i < length; ++i) {
  1342. s += calcSizeBinaryJumpTable[type->typeKind]((const void*)ptr, type);
  1343. ptr += type->memSize;
  1344. }
  1345. return s;
  1346. }
  1347. static size_t calcSizeBinary1(const void *_, const UA_DataType *__) { return 1; }
  1348. static size_t calcSizeBinary2(const void *_, const UA_DataType *__) { return 2; }
  1349. static size_t calcSizeBinary4(const void *_, const UA_DataType *__) { return 4; }
  1350. static size_t calcSizeBinary8(const void *_, const UA_DataType *__) { return 8; }
  1351. CALCSIZE_BINARY(String) { return 4 + src->length; }
  1352. CALCSIZE_BINARY(Guid) { return 16; }
  1353. CALCSIZE_BINARY(NodeId) {
  1354. size_t s = 1; /* Encoding byte */
  1355. switch(src->identifierType) {
  1356. case UA_NODEIDTYPE_NUMERIC:
  1357. if(src->identifier.numeric > UA_UINT16_MAX || src->namespaceIndex > UA_BYTE_MAX) {
  1358. s += 6;
  1359. } else if(src->identifier.numeric > UA_BYTE_MAX || src->namespaceIndex > 0) {
  1360. s += 3;
  1361. } else {
  1362. s += 1;
  1363. }
  1364. break;
  1365. case UA_NODEIDTYPE_BYTESTRING:
  1366. case UA_NODEIDTYPE_STRING:
  1367. s += 2;
  1368. s += String_calcSizeBinary(&src->identifier.string, NULL);
  1369. break;
  1370. case UA_NODEIDTYPE_GUID:
  1371. s += 18;
  1372. break;
  1373. default:
  1374. return 0;
  1375. }
  1376. return s;
  1377. }
  1378. CALCSIZE_BINARY(ExpandedNodeId) {
  1379. size_t s = NodeId_calcSizeBinary(&src->nodeId, NULL);
  1380. if(src->namespaceUri.length > 0)
  1381. s += String_calcSizeBinary(&src->namespaceUri, NULL);
  1382. if(src->serverIndex > 0)
  1383. s += 4;
  1384. return s;
  1385. }
  1386. CALCSIZE_BINARY(QualifiedName) {
  1387. return 2 + String_calcSizeBinary(&src->name, NULL);
  1388. }
  1389. CALCSIZE_BINARY(LocalizedText) {
  1390. size_t s = 1; /* Encoding byte */
  1391. if(src->locale.data)
  1392. s += String_calcSizeBinary(&src->locale, NULL);
  1393. if(src->text.data)
  1394. s += String_calcSizeBinary(&src->text, NULL);
  1395. return s;
  1396. }
  1397. CALCSIZE_BINARY(ExtensionObject) {
  1398. size_t s = 1; /* Encoding byte */
  1399. /* Encoded content */
  1400. if(src->encoding <= UA_EXTENSIONOBJECT_ENCODED_XML) {
  1401. s += NodeId_calcSizeBinary(&src->content.encoded.typeId, NULL);
  1402. switch(src->encoding) {
  1403. case UA_EXTENSIONOBJECT_ENCODED_NOBODY:
  1404. break;
  1405. case UA_EXTENSIONOBJECT_ENCODED_BYTESTRING:
  1406. case UA_EXTENSIONOBJECT_ENCODED_XML:
  1407. s += String_calcSizeBinary(&src->content.encoded.body, NULL);
  1408. break;
  1409. default:
  1410. return 0;
  1411. }
  1412. return s;
  1413. }
  1414. /* Decoded content */
  1415. if(!src->content.decoded.type || !src->content.decoded.data)
  1416. return 0;
  1417. if(src->content.decoded.type->typeId.identifierType != UA_NODEIDTYPE_NUMERIC)
  1418. return 0;
  1419. s += NodeId_calcSizeBinary(&src->content.decoded.type->typeId, NULL); /* Type encoding length */
  1420. s += 4; /* Encoding length field */
  1421. const UA_DataType *type = src->content.decoded.type;
  1422. s += calcSizeBinaryJumpTable[type->typeKind](src->content.decoded.data, type); /* Encoding length */
  1423. return s;
  1424. }
  1425. CALCSIZE_BINARY(Variant) {
  1426. size_t s = 1; /* Encoding byte */
  1427. if(!src->type)
  1428. return s;
  1429. const UA_Boolean isArray = src->arrayLength > 0 || src->data <= UA_EMPTY_ARRAY_SENTINEL;
  1430. if(isArray)
  1431. s += Array_calcSizeBinary(src->data, src->arrayLength, src->type);
  1432. else
  1433. s += calcSizeBinaryJumpTable[src->type->typeKind](src->data, src->type);
  1434. const UA_Boolean isBuiltin = (src->type->typeKind <= UA_DATATYPEKIND_DIAGNOSTICINFO);
  1435. const UA_Boolean isEnum = (src->type->typeKind == UA_DATATYPEKIND_ENUM);
  1436. if(!isBuiltin && !isEnum) {
  1437. /* The type is wrapped inside an extensionobject */
  1438. /* (NodeId + encoding byte + extension object length) * array length */
  1439. size_t length = isArray ? src->arrayLength : 1;
  1440. s += (NodeId_calcSizeBinary(&src->type->typeId, NULL) + 1 + 4) * length;
  1441. }
  1442. const UA_Boolean hasDimensions = isArray && src->arrayDimensionsSize > 0;
  1443. if(hasDimensions)
  1444. s += Array_calcSizeBinary(src->arrayDimensions, src->arrayDimensionsSize,
  1445. &UA_TYPES[UA_TYPES_INT32]);
  1446. return s;
  1447. }
  1448. CALCSIZE_BINARY(DataValue) {
  1449. size_t s = 1; /* Encoding byte */
  1450. if(src->hasValue)
  1451. s += Variant_calcSizeBinary(&src->value, NULL);
  1452. if(src->hasStatus)
  1453. s += 4;
  1454. if(src->hasSourceTimestamp)
  1455. s += 8;
  1456. if(src->hasSourcePicoseconds)
  1457. s += 2;
  1458. if(src->hasServerTimestamp)
  1459. s += 8;
  1460. if(src->hasServerPicoseconds)
  1461. s += 2;
  1462. return s;
  1463. }
  1464. CALCSIZE_BINARY(DiagnosticInfo) {
  1465. size_t s = 1; /* Encoding byte */
  1466. if(src->hasSymbolicId)
  1467. s += 4;
  1468. if(src->hasNamespaceUri)
  1469. s += 4;
  1470. if(src->hasLocalizedText)
  1471. s += 4;
  1472. if(src->hasLocale)
  1473. s += 4;
  1474. if(src->hasAdditionalInfo)
  1475. s += String_calcSizeBinary(&src->additionalInfo, NULL);
  1476. if(src->hasInnerStatusCode)
  1477. s += 4;
  1478. if(src->hasInnerDiagnosticInfo)
  1479. s += DiagnosticInfo_calcSizeBinary(src->innerDiagnosticInfo, NULL);
  1480. return s;
  1481. }
  1482. static size_t
  1483. calcSizeBinaryStructure(const void *p, const UA_DataType *type) {
  1484. size_t s = 0;
  1485. uintptr_t ptr = (uintptr_t)p;
  1486. u8 membersSize = type->membersSize;
  1487. const UA_DataType *typelists[2] = { UA_TYPES, &type[-type->typeIndex] };
  1488. /* Loop over members */
  1489. for(size_t i = 0; i < membersSize; ++i) {
  1490. const UA_DataTypeMember *member = &type->members[i];
  1491. const UA_DataType *membertype = &typelists[!member->namespaceZero][member->memberTypeIndex];
  1492. ptr += member->padding;
  1493. /* Array */
  1494. if(member->isArray) {
  1495. const size_t length = *((const size_t*)ptr);
  1496. ptr += sizeof(size_t);
  1497. s += Array_calcSizeBinary(*(void *UA_RESTRICT const *)ptr, length, membertype);
  1498. ptr += sizeof(void*);
  1499. continue;
  1500. }
  1501. /* Scalar */
  1502. s += calcSizeBinaryJumpTable[membertype->typeKind]((const void*)ptr, membertype);
  1503. ptr += membertype->memSize;
  1504. }
  1505. return s;
  1506. }
  1507. static size_t
  1508. calcSizeBinaryNotImplemented(const void *p, const UA_DataType *type) {
  1509. return 0;
  1510. }
  1511. const calcSizeBinarySignature calcSizeBinaryJumpTable[UA_DATATYPEKINDS] = {
  1512. (calcSizeBinarySignature)calcSizeBinary1, /* Boolean */
  1513. (calcSizeBinarySignature)calcSizeBinary1, /* SByte */
  1514. (calcSizeBinarySignature)calcSizeBinary1, /* Byte */
  1515. (calcSizeBinarySignature)calcSizeBinary2, /* Int16 */
  1516. (calcSizeBinarySignature)calcSizeBinary2, /* UInt16 */
  1517. (calcSizeBinarySignature)calcSizeBinary4, /* Int32 */
  1518. (calcSizeBinarySignature)calcSizeBinary4, /* UInt32 */
  1519. (calcSizeBinarySignature)calcSizeBinary8, /* Int64 */
  1520. (calcSizeBinarySignature)calcSizeBinary8, /* UInt64 */
  1521. (calcSizeBinarySignature)calcSizeBinary4, /* Float */
  1522. (calcSizeBinarySignature)calcSizeBinary8, /* Double */
  1523. (calcSizeBinarySignature)String_calcSizeBinary,
  1524. (calcSizeBinarySignature)calcSizeBinary8, /* DateTime */
  1525. (calcSizeBinarySignature)Guid_calcSizeBinary,
  1526. (calcSizeBinarySignature)String_calcSizeBinary, /* ByteString */
  1527. (calcSizeBinarySignature)String_calcSizeBinary, /* XmlElement */
  1528. (calcSizeBinarySignature)NodeId_calcSizeBinary,
  1529. (calcSizeBinarySignature)ExpandedNodeId_calcSizeBinary,
  1530. (calcSizeBinarySignature)calcSizeBinary4, /* StatusCode */
  1531. (calcSizeBinarySignature)QualifiedName_calcSizeBinary,
  1532. (calcSizeBinarySignature)LocalizedText_calcSizeBinary,
  1533. (calcSizeBinarySignature)ExtensionObject_calcSizeBinary,
  1534. (calcSizeBinarySignature)DataValue_calcSizeBinary,
  1535. (calcSizeBinarySignature)Variant_calcSizeBinary,
  1536. (calcSizeBinarySignature)DiagnosticInfo_calcSizeBinary,
  1537. (calcSizeBinarySignature)calcSizeBinaryNotImplemented, /* Decimal */
  1538. (calcSizeBinarySignature)calcSizeBinary4, /* Enumeration */
  1539. (calcSizeBinarySignature)calcSizeBinaryStructure,
  1540. (calcSizeBinarySignature)calcSizeBinaryNotImplemented, /* Structure with Optional Fields */
  1541. (calcSizeBinarySignature)calcSizeBinaryNotImplemented, /* Union */
  1542. (calcSizeBinarySignature)calcSizeBinaryNotImplemented /* BitfieldCluster */
  1543. };
  1544. size_t
  1545. UA_calcSizeBinary(const void *p, const UA_DataType *type) {
  1546. return calcSizeBinaryJumpTable[type->typeKind](p, type);
  1547. }