ua_types_encoding_binary.c 61 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764
  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_types_encoding_binary.h"
  18. #include <open62541/types_generated.h>
  19. #include <open62541/types_generated_handling.h>
  20. #include "ua_util_internal.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 0u
  499. #define UA_NODEIDTYPE_NUMERIC_FOURBYTE 1u
  500. #define UA_NODEIDTYPE_NUMERIC_COMPLETE 2u
  501. #define UA_EXPANDEDNODEID_SERVERINDEX_FLAG 0x40u
  502. #define UA_EXPANDEDNODEID_NAMESPACEURI_FLAG 0x80u
  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:encoding |= (u8)UA_NODEIDTYPE_STRING;
  529. ret |= ENCODE_DIRECT(&encoding, Byte);
  530. ret |= ENCODE_DIRECT(&src->namespaceIndex, UInt16);
  531. if(ret != UA_STATUSCODE_GOOD)
  532. return ret;
  533. ret = ENCODE_DIRECT(&src->identifier.string, String);
  534. break;
  535. case UA_NODEIDTYPE_GUID:encoding |= (u8)UA_NODEIDTYPE_GUID;
  536. ret |= ENCODE_DIRECT(&encoding, Byte);
  537. ret |= ENCODE_DIRECT(&src->namespaceIndex, UInt16);
  538. ret |= ENCODE_DIRECT(&src->identifier.guid, Guid);
  539. break;
  540. case UA_NODEIDTYPE_BYTESTRING:encoding |= (u8)UA_NODEIDTYPE_BYTESTRING;
  541. ret |= ENCODE_DIRECT(&encoding, Byte);
  542. ret |= ENCODE_DIRECT(&src->namespaceIndex, UInt16);
  543. if(ret != UA_STATUSCODE_GOOD)
  544. return ret;
  545. ret = ENCODE_DIRECT(&src->identifier.byteString, String); /* ByteString */
  546. break;
  547. default:
  548. return UA_STATUSCODE_BADINTERNALERROR;
  549. }
  550. return ret;
  551. }
  552. ENCODE_BINARY(NodeId) {
  553. return NodeId_encodeBinaryWithEncodingMask(src, 0, ctx);
  554. }
  555. DECODE_BINARY(NodeId) {
  556. u8 dstByte = 0, encodingByte = 0;
  557. u16 dstUInt16 = 0;
  558. /* Decode the encoding bitfield */
  559. status ret = DECODE_DIRECT(&encodingByte, Byte);
  560. if(ret != UA_STATUSCODE_GOOD)
  561. return ret;
  562. /* Filter out the bits used only for ExpandedNodeIds */
  563. encodingByte &= (u8)~(UA_EXPANDEDNODEID_SERVERINDEX_FLAG |
  564. UA_EXPANDEDNODEID_NAMESPACEURI_FLAG);
  565. /* Decode the namespace and identifier */
  566. switch(encodingByte) {
  567. case UA_NODEIDTYPE_NUMERIC_TWOBYTE:
  568. dst->identifierType = UA_NODEIDTYPE_NUMERIC;
  569. ret = DECODE_DIRECT(&dstByte, Byte);
  570. dst->identifier.numeric = dstByte;
  571. dst->namespaceIndex = 0;
  572. break;
  573. case UA_NODEIDTYPE_NUMERIC_FOURBYTE:
  574. dst->identifierType = UA_NODEIDTYPE_NUMERIC;
  575. ret |= DECODE_DIRECT(&dstByte, Byte);
  576. dst->namespaceIndex = dstByte;
  577. ret |= DECODE_DIRECT(&dstUInt16, UInt16);
  578. dst->identifier.numeric = dstUInt16;
  579. break;
  580. case UA_NODEIDTYPE_NUMERIC_COMPLETE:
  581. dst->identifierType = UA_NODEIDTYPE_NUMERIC;
  582. ret |= DECODE_DIRECT(&dst->namespaceIndex, UInt16);
  583. ret |= DECODE_DIRECT(&dst->identifier.numeric, UInt32);
  584. break;
  585. case UA_NODEIDTYPE_STRING:
  586. dst->identifierType = UA_NODEIDTYPE_STRING;
  587. ret |= DECODE_DIRECT(&dst->namespaceIndex, UInt16);
  588. ret |= DECODE_DIRECT(&dst->identifier.string, String);
  589. break;
  590. case UA_NODEIDTYPE_GUID:
  591. dst->identifierType = UA_NODEIDTYPE_GUID;
  592. ret |= DECODE_DIRECT(&dst->namespaceIndex, UInt16);
  593. ret |= DECODE_DIRECT(&dst->identifier.guid, Guid);
  594. break;
  595. case UA_NODEIDTYPE_BYTESTRING:
  596. dst->identifierType = UA_NODEIDTYPE_BYTESTRING;
  597. ret |= DECODE_DIRECT(&dst->namespaceIndex, UInt16);
  598. ret |= DECODE_DIRECT(&dst->identifier.byteString, String); /* ByteString */
  599. break;
  600. default:
  601. ret |= UA_STATUSCODE_BADINTERNALERROR;
  602. break;
  603. }
  604. return ret;
  605. }
  606. /* ExpandedNodeId */
  607. ENCODE_BINARY(ExpandedNodeId) {
  608. /* Set up the encoding mask */
  609. u8 encoding = 0;
  610. if((void*)src->namespaceUri.data > UA_EMPTY_ARRAY_SENTINEL)
  611. encoding |= UA_EXPANDEDNODEID_NAMESPACEURI_FLAG;
  612. if(src->serverIndex > 0)
  613. encoding |= UA_EXPANDEDNODEID_SERVERINDEX_FLAG;
  614. /* Encode the NodeId */
  615. status ret = NodeId_encodeBinaryWithEncodingMask(&src->nodeId, encoding, ctx);
  616. if(ret != UA_STATUSCODE_GOOD)
  617. return ret;
  618. /* Encode the namespace. */
  619. if((void*)src->namespaceUri.data > UA_EMPTY_ARRAY_SENTINEL) {
  620. ret = ENCODE_DIRECT(&src->namespaceUri, String);
  621. if(ret != UA_STATUSCODE_GOOD)
  622. return ret;
  623. }
  624. /* Encode the serverIndex */
  625. if(src->serverIndex > 0)
  626. ret = ENCODE_WITHEXCHANGE(&src->serverIndex, UA_TYPES_UINT32);
  627. return ret;
  628. }
  629. DECODE_BINARY(ExpandedNodeId) {
  630. /* Decode the encoding mask */
  631. if(ctx->pos >= ctx->end)
  632. return UA_STATUSCODE_BADDECODINGERROR;
  633. u8 encoding = *ctx->pos;
  634. /* Decode the NodeId */
  635. status ret = DECODE_DIRECT(&dst->nodeId, NodeId);
  636. /* Decode the NamespaceUri */
  637. if(encoding & UA_EXPANDEDNODEID_NAMESPACEURI_FLAG) {
  638. dst->nodeId.namespaceIndex = 0;
  639. ret |= DECODE_DIRECT(&dst->namespaceUri, String);
  640. }
  641. /* Decode the ServerIndex */
  642. if(encoding & UA_EXPANDEDNODEID_SERVERINDEX_FLAG)
  643. ret |= DECODE_DIRECT(&dst->serverIndex, UInt32);
  644. return ret;
  645. }
  646. /* QualifiedName */
  647. ENCODE_BINARY(QualifiedName) {
  648. status ret = ENCODE_DIRECT(&src->namespaceIndex, UInt16);
  649. ret |= ENCODE_DIRECT(&src->name, String);
  650. return ret;
  651. }
  652. DECODE_BINARY(QualifiedName) {
  653. status ret = DECODE_DIRECT(&dst->namespaceIndex, UInt16);
  654. ret |= DECODE_DIRECT(&dst->name, String);
  655. return ret;
  656. }
  657. /* LocalizedText */
  658. #define UA_LOCALIZEDTEXT_ENCODINGMASKTYPE_LOCALE 0x01u
  659. #define UA_LOCALIZEDTEXT_ENCODINGMASKTYPE_TEXT 0x02u
  660. ENCODE_BINARY(LocalizedText) {
  661. /* Set up the encoding mask */
  662. u8 encoding = 0;
  663. if(src->locale.data)
  664. encoding |= UA_LOCALIZEDTEXT_ENCODINGMASKTYPE_LOCALE;
  665. if(src->text.data)
  666. encoding |= UA_LOCALIZEDTEXT_ENCODINGMASKTYPE_TEXT;
  667. /* Encode the encoding byte */
  668. status ret = ENCODE_DIRECT(&encoding, Byte);
  669. if(ret != UA_STATUSCODE_GOOD)
  670. return ret;
  671. /* Encode the strings */
  672. if(encoding & UA_LOCALIZEDTEXT_ENCODINGMASKTYPE_LOCALE)
  673. ret |= ENCODE_DIRECT(&src->locale, String);
  674. if(encoding & UA_LOCALIZEDTEXT_ENCODINGMASKTYPE_TEXT)
  675. ret |= ENCODE_DIRECT(&src->text, String);
  676. return ret;
  677. }
  678. DECODE_BINARY(LocalizedText) {
  679. /* Decode the encoding mask */
  680. u8 encoding = 0;
  681. status ret = DECODE_DIRECT(&encoding, Byte);
  682. /* Decode the content */
  683. if(encoding & UA_LOCALIZEDTEXT_ENCODINGMASKTYPE_LOCALE)
  684. ret |= DECODE_DIRECT(&dst->locale, String);
  685. if(encoding & UA_LOCALIZEDTEXT_ENCODINGMASKTYPE_TEXT)
  686. ret |= DECODE_DIRECT(&dst->text, String);
  687. return ret;
  688. }
  689. /* The binary encoding has a different nodeid from the data type. So it is not
  690. * possible to reuse UA_findDataType */
  691. static const UA_DataType *
  692. UA_findDataTypeByBinaryInternal(const UA_NodeId *typeId, Ctx *ctx) {
  693. /* We only store a numeric identifier for the encoding nodeid of data types */
  694. if(typeId->identifierType != UA_NODEIDTYPE_NUMERIC)
  695. return NULL;
  696. /* Always look in built-in types first
  697. * (may contain data types from all namespaces) */
  698. for(size_t i = 0; i < UA_TYPES_COUNT; ++i) {
  699. if(UA_TYPES[i].binaryEncodingId == typeId->identifier.numeric &&
  700. UA_TYPES[i].typeId.namespaceIndex == typeId->namespaceIndex)
  701. return &UA_TYPES[i];
  702. }
  703. const UA_DataTypeArray *customTypes = ctx->customTypes;
  704. while(customTypes) {
  705. for(size_t i = 0; i < customTypes->typesSize; ++i) {
  706. if(customTypes->types[i].binaryEncodingId == typeId->identifier.numeric &&
  707. customTypes->types[i].typeId.namespaceIndex == typeId->namespaceIndex)
  708. return &customTypes->types[i];
  709. }
  710. customTypes = customTypes->next;
  711. }
  712. return NULL;
  713. }
  714. const UA_DataType *
  715. UA_findDataTypeByBinary(const UA_NodeId *typeId) {
  716. Ctx ctx;
  717. ctx.customTypes = NULL;
  718. return UA_findDataTypeByBinaryInternal(typeId, &ctx);
  719. }
  720. /* ExtensionObject */
  721. ENCODE_BINARY(ExtensionObject) {
  722. u8 encoding = (u8)src->encoding;
  723. /* No content or already encoded content. */
  724. if(encoding <= UA_EXTENSIONOBJECT_ENCODED_XML) {
  725. status ret = ENCODE_DIRECT(&src->content.encoded.typeId, NodeId);
  726. if(ret != UA_STATUSCODE_GOOD)
  727. return ret;
  728. ret = ENCODE_WITHEXCHANGE(&encoding, UA_TYPES_BYTE);
  729. if(ret != UA_STATUSCODE_GOOD)
  730. return ret;
  731. switch(src->encoding) {
  732. case UA_EXTENSIONOBJECT_ENCODED_NOBODY:
  733. break;
  734. case UA_EXTENSIONOBJECT_ENCODED_BYTESTRING:
  735. case UA_EXTENSIONOBJECT_ENCODED_XML:
  736. ret = ENCODE_DIRECT(&src->content.encoded.body, String); /* ByteString */
  737. break;
  738. default:
  739. ret = UA_STATUSCODE_BADINTERNALERROR;
  740. }
  741. return ret;
  742. }
  743. /* Cannot encode with no data or no type description */
  744. if(!src->content.decoded.type || !src->content.decoded.data)
  745. return UA_STATUSCODE_BADENCODINGERROR;
  746. /* Write the NodeId for the binary encoded type. The NodeId is always
  747. * numeric, so no buffer replacement is taking place. */
  748. UA_NodeId typeId = src->content.decoded.type->typeId;
  749. if(typeId.identifierType != UA_NODEIDTYPE_NUMERIC)
  750. return UA_STATUSCODE_BADENCODINGERROR;
  751. typeId.identifier.numeric = src->content.decoded.type->binaryEncodingId;
  752. status ret = ENCODE_DIRECT(&typeId, NodeId);
  753. /* Write the encoding byte */
  754. encoding = UA_EXTENSIONOBJECT_ENCODED_BYTESTRING;
  755. ret |= ENCODE_DIRECT(&encoding, Byte);
  756. /* Compute the content length */
  757. const UA_DataType *contentType = src->content.decoded.type;
  758. size_t len = UA_calcSizeBinary(src->content.decoded.data, contentType);
  759. /* Encode the content length */
  760. if(len > UA_INT32_MAX)
  761. return UA_STATUSCODE_BADENCODINGERROR;
  762. i32 signed_len = (i32)len;
  763. ret |= ENCODE_DIRECT(&signed_len, UInt32); /* Int32 */
  764. /* Return early upon failures (no buffer exchange until here) */
  765. if(ret != UA_STATUSCODE_GOOD)
  766. return ret;
  767. /* Encode the content */
  768. return encodeWithExchangeBuffer(src->content.decoded.data, contentType, ctx);
  769. }
  770. static status
  771. ExtensionObject_decodeBinaryContent(UA_ExtensionObject *dst, const UA_NodeId *typeId, Ctx *ctx) {
  772. /* Lookup the datatype */
  773. const UA_DataType *type = UA_findDataTypeByBinaryInternal(typeId, ctx);
  774. /* Unknown type, just take the binary content */
  775. if(!type) {
  776. dst->encoding = UA_EXTENSIONOBJECT_ENCODED_BYTESTRING;
  777. UA_NodeId_copy(typeId, &dst->content.encoded.typeId);
  778. return DECODE_DIRECT(&dst->content.encoded.body, String); /* ByteString */
  779. }
  780. /* Allocate memory */
  781. dst->content.decoded.data = UA_new(type);
  782. if(!dst->content.decoded.data)
  783. return UA_STATUSCODE_BADOUTOFMEMORY;
  784. /* Jump over the length field (TODO: check if the decoded length matches) */
  785. ctx->pos += 4;
  786. /* Decode */
  787. dst->encoding = UA_EXTENSIONOBJECT_DECODED;
  788. dst->content.decoded.type = type;
  789. return decodeBinaryJumpTable[type->typeKind](dst->content.decoded.data, type, ctx);
  790. }
  791. DECODE_BINARY(ExtensionObject) {
  792. u8 encoding = 0;
  793. UA_NodeId binTypeId; /* Can contain a string nodeid. But no corresponding
  794. * type is then found in open62541. We only store
  795. * numerical nodeids of the binary encoding identifier.
  796. * The extenionobject will be decoded to contain a
  797. * binary blob. */
  798. UA_NodeId_init(&binTypeId);
  799. status ret = UA_STATUSCODE_GOOD;
  800. ret |= DECODE_DIRECT(&binTypeId, NodeId);
  801. ret |= DECODE_DIRECT(&encoding, Byte);
  802. if(ret != UA_STATUSCODE_GOOD) {
  803. UA_NodeId_clear(&binTypeId);
  804. return ret;
  805. }
  806. switch(encoding) {
  807. case UA_EXTENSIONOBJECT_ENCODED_BYTESTRING:
  808. ret = ExtensionObject_decodeBinaryContent(dst, &binTypeId, ctx);
  809. UA_NodeId_deleteMembers(&binTypeId);
  810. break;
  811. case UA_EXTENSIONOBJECT_ENCODED_NOBODY:
  812. dst->encoding = (UA_ExtensionObjectEncoding)encoding;
  813. dst->content.encoded.typeId = binTypeId; /* move to dst */
  814. dst->content.encoded.body = UA_BYTESTRING_NULL;
  815. break;
  816. case UA_EXTENSIONOBJECT_ENCODED_XML:
  817. dst->encoding = (UA_ExtensionObjectEncoding)encoding;
  818. dst->content.encoded.typeId = binTypeId; /* move to dst */
  819. ret = DECODE_DIRECT(&dst->content.encoded.body, String); /* ByteString */
  820. if(ret != UA_STATUSCODE_GOOD)
  821. UA_NodeId_clear(&dst->content.encoded.typeId);
  822. break;
  823. default:
  824. UA_NodeId_clear(&binTypeId);
  825. ret = UA_STATUSCODE_BADDECODINGERROR;
  826. break;
  827. }
  828. return ret;
  829. }
  830. /* Variant */
  831. static status
  832. Variant_encodeBinaryWrapExtensionObject(const UA_Variant *src,
  833. const UA_Boolean isArray, Ctx *ctx) {
  834. /* Default to 1 for a scalar. */
  835. size_t length = 1;
  836. /* Encode the array length if required */
  837. status ret = UA_STATUSCODE_GOOD;
  838. if(isArray) {
  839. if(src->arrayLength > UA_INT32_MAX)
  840. return UA_STATUSCODE_BADENCODINGERROR;
  841. length = src->arrayLength;
  842. i32 encodedLength = (i32)src->arrayLength;
  843. ret = ENCODE_DIRECT(&encodedLength, UInt32); /* Int32 */
  844. if(ret != UA_STATUSCODE_GOOD)
  845. return ret;
  846. }
  847. /* Set up the ExtensionObject */
  848. UA_ExtensionObject eo;
  849. UA_ExtensionObject_init(&eo);
  850. eo.encoding = UA_EXTENSIONOBJECT_DECODED;
  851. eo.content.decoded.type = src->type;
  852. const u16 memSize = src->type->memSize;
  853. uintptr_t ptr = (uintptr_t)src->data;
  854. /* Iterate over the array */
  855. for(size_t i = 0; i < length && ret == UA_STATUSCODE_GOOD; ++i) {
  856. eo.content.decoded.data = (void*)ptr;
  857. ret = encodeWithExchangeBuffer(&eo, &UA_TYPES[UA_TYPES_EXTENSIONOBJECT], ctx);
  858. ptr += memSize;
  859. }
  860. return ret;
  861. }
  862. enum UA_VARIANT_ENCODINGMASKTYPE {
  863. UA_VARIANT_ENCODINGMASKTYPE_TYPEID_MASK = 0x3Fu, /* bits 0:5 */
  864. UA_VARIANT_ENCODINGMASKTYPE_DIMENSIONS = (u8)(0x01u << 6u), /* bit 6 */
  865. UA_VARIANT_ENCODINGMASKTYPE_ARRAY = (u8)(0x01u << 7u) /* bit 7 */
  866. };
  867. ENCODE_BINARY(Variant) {
  868. /* Quit early for the empty variant */
  869. u8 encoding = 0;
  870. if(!src->type)
  871. return ENCODE_DIRECT(&encoding, Byte);
  872. /* Set the content type in the encoding mask */
  873. const UA_Boolean isBuiltin = (src->type->typeKind <= UA_DATATYPEKIND_DIAGNOSTICINFO);
  874. const UA_Boolean isEnum = (src->type->typeKind == UA_DATATYPEKIND_ENUM);
  875. if(isBuiltin)
  876. encoding = (u8)(encoding | (u8)((u8)UA_VARIANT_ENCODINGMASKTYPE_TYPEID_MASK & (u8)(src->type->typeKind + 1u)));
  877. else if(isEnum)
  878. encoding = (u8)(encoding | (u8)((u8)UA_VARIANT_ENCODINGMASKTYPE_TYPEID_MASK & (u8)(UA_TYPES_INT32 + 1u)));
  879. else
  880. encoding = (u8)(encoding | (u8)((u8)UA_VARIANT_ENCODINGMASKTYPE_TYPEID_MASK & (u8)(UA_TYPES_EXTENSIONOBJECT + 1u)));
  881. /* Set the array type in the encoding mask */
  882. const UA_Boolean isArray = src->arrayLength > 0 || src->data <= UA_EMPTY_ARRAY_SENTINEL;
  883. const UA_Boolean hasDimensions = isArray && src->arrayDimensionsSize > 0;
  884. if(isArray) {
  885. encoding |= (u8)UA_VARIANT_ENCODINGMASKTYPE_ARRAY;
  886. if(hasDimensions)
  887. encoding |= (u8)UA_VARIANT_ENCODINGMASKTYPE_DIMENSIONS;
  888. }
  889. /* Encode the encoding byte */
  890. status ret = ENCODE_DIRECT(&encoding, Byte);
  891. if(ret != UA_STATUSCODE_GOOD)
  892. return ret;
  893. /* Encode the content */
  894. if(!isBuiltin && !isEnum)
  895. ret = Variant_encodeBinaryWrapExtensionObject(src, isArray, ctx);
  896. else if(!isArray)
  897. ret = encodeWithExchangeBuffer(src->data, src->type, ctx);
  898. else
  899. ret = Array_encodeBinary(src->data, src->arrayLength, src->type, ctx);
  900. /* Encode the array dimensions */
  901. if(hasDimensions && ret == UA_STATUSCODE_GOOD)
  902. ret = Array_encodeBinary(src->arrayDimensions, src->arrayDimensionsSize,
  903. &UA_TYPES[UA_TYPES_INT32], ctx);
  904. return ret;
  905. }
  906. static status
  907. Variant_decodeBinaryUnwrapExtensionObject(UA_Variant *dst, Ctx *ctx) {
  908. /* Save the position in the ByteString. If unwrapping is not possible, start
  909. * from here to decode a normal ExtensionObject. */
  910. u8 *old_pos = ctx->pos;
  911. /* Decode the DataType */
  912. UA_NodeId typeId;
  913. UA_NodeId_init(&typeId);
  914. status ret = DECODE_DIRECT(&typeId, NodeId);
  915. if(ret != UA_STATUSCODE_GOOD)
  916. return ret;
  917. /* Decode the EncodingByte */
  918. u8 encoding;
  919. ret = DECODE_DIRECT(&encoding, Byte);
  920. if(ret != UA_STATUSCODE_GOOD) {
  921. UA_NodeId_clear(&typeId);
  922. return ret;
  923. }
  924. /* Search for the datatype. Default to ExtensionObject. */
  925. if(encoding == UA_EXTENSIONOBJECT_ENCODED_BYTESTRING &&
  926. (dst->type = UA_findDataTypeByBinaryInternal(&typeId, ctx)) != NULL) {
  927. /* Jump over the length field (TODO: check if length matches) */
  928. ctx->pos += 4;
  929. } else {
  930. /* Reset and decode as ExtensionObject */
  931. dst->type = &UA_TYPES[UA_TYPES_EXTENSIONOBJECT];
  932. ctx->pos = old_pos;
  933. UA_NodeId_clear(&typeId);
  934. }
  935. /* Allocate memory */
  936. dst->data = UA_new(dst->type);
  937. if(!dst->data)
  938. return UA_STATUSCODE_BADOUTOFMEMORY;
  939. /* Decode the content */
  940. return decodeBinaryJumpTable[dst->type->typeKind](dst->data, dst->type, ctx);
  941. }
  942. /* The resulting variant always has the storagetype UA_VARIANT_DATA. */
  943. DECODE_BINARY(Variant) {
  944. /* Decode the encoding byte */
  945. u8 encodingByte;
  946. status ret = DECODE_DIRECT(&encodingByte, Byte);
  947. if(ret != UA_STATUSCODE_GOOD)
  948. return ret;
  949. /* Return early for an empty variant (was already _inited) */
  950. if(encodingByte == 0)
  951. return UA_STATUSCODE_GOOD;
  952. /* Does the variant contain an array? */
  953. const UA_Boolean isArray = (encodingByte & (u8)UA_VARIANT_ENCODINGMASKTYPE_ARRAY) > 0;
  954. /* Get the datatype of the content. The type must be a builtin data type.
  955. * All not-builtin types are wrapped in an ExtensionObject. The "type kind"
  956. * for types up to DiagnsticInfo equals to the index in the encoding
  957. * byte. */
  958. size_t typeKind = (size_t)((encodingByte & (u8)UA_VARIANT_ENCODINGMASKTYPE_TYPEID_MASK) - 1);
  959. if(typeKind > UA_DATATYPEKIND_DIAGNOSTICINFO)
  960. return UA_STATUSCODE_BADDECODINGERROR;
  961. /* A variant cannot contain a variant. But it can contain an array of
  962. * variants */
  963. if(typeKind == UA_DATATYPEKIND_VARIANT && !isArray)
  964. return UA_STATUSCODE_BADDECODINGERROR;
  965. /* Check the recursion limit */
  966. if(ctx->depth > UA_ENCODING_MAX_RECURSION)
  967. return UA_STATUSCODE_BADENCODINGERROR;
  968. ctx->depth++;
  969. /* Decode the content */
  970. dst->type = &UA_TYPES[typeKind];
  971. if(isArray) {
  972. ret = Array_decodeBinary(&dst->data, &dst->arrayLength, dst->type, ctx);
  973. } else if(typeKind != UA_DATATYPEKIND_EXTENSIONOBJECT) {
  974. dst->data = UA_new(dst->type);
  975. if(!dst->data)
  976. return UA_STATUSCODE_BADOUTOFMEMORY;
  977. ret = decodeBinaryJumpTable[typeKind](dst->data, dst->type, ctx);
  978. } else {
  979. ret = Variant_decodeBinaryUnwrapExtensionObject(dst, ctx);
  980. }
  981. /* Decode array dimensions */
  982. if(isArray && (encodingByte & (u8)UA_VARIANT_ENCODINGMASKTYPE_DIMENSIONS) > 0)
  983. ret |= Array_decodeBinary((void**)&dst->arrayDimensions, &dst->arrayDimensionsSize,
  984. &UA_TYPES[UA_TYPES_INT32], ctx);
  985. ctx->depth--;
  986. return ret;
  987. }
  988. /* DataValue */
  989. ENCODE_BINARY(DataValue) {
  990. /* Set up the encoding mask */
  991. u8 encodingMask = src->hasValue;
  992. encodingMask |= (u8)(src->hasStatus << 1u);
  993. encodingMask |= (u8)(src->hasSourceTimestamp << 2u);
  994. encodingMask |= (u8)(src->hasServerTimestamp << 3u);
  995. encodingMask |= (u8)(src->hasSourcePicoseconds << 4u);
  996. encodingMask |= (u8)(src->hasServerPicoseconds << 5u);
  997. /* Encode the encoding byte */
  998. status ret = ENCODE_DIRECT(&encodingMask, Byte);
  999. if(ret != UA_STATUSCODE_GOOD)
  1000. return ret;
  1001. /* Encode the variant. */
  1002. if(src->hasValue) {
  1003. ret = ENCODE_DIRECT(&src->value, Variant);
  1004. if(ret != UA_STATUSCODE_GOOD)
  1005. return ret;
  1006. }
  1007. if(src->hasStatus)
  1008. ret |= ENCODE_WITHEXCHANGE(&src->status, UA_TYPES_STATUSCODE);
  1009. if(src->hasSourceTimestamp)
  1010. ret |= ENCODE_WITHEXCHANGE(&src->sourceTimestamp, UA_TYPES_DATETIME);
  1011. if(src->hasSourcePicoseconds)
  1012. ret |= ENCODE_WITHEXCHANGE(&src->sourcePicoseconds, UA_TYPES_UINT16);
  1013. if(src->hasServerTimestamp)
  1014. ret |= ENCODE_WITHEXCHANGE(&src->serverTimestamp, UA_TYPES_DATETIME);
  1015. if(src->hasServerPicoseconds)
  1016. ret |= ENCODE_WITHEXCHANGE(&src->serverPicoseconds, UA_TYPES_UINT16);
  1017. return ret;
  1018. }
  1019. #define MAX_PICO_SECONDS 9999
  1020. DECODE_BINARY(DataValue) {
  1021. /* Decode the encoding mask */
  1022. u8 encodingMask;
  1023. status ret = DECODE_DIRECT(&encodingMask, Byte);
  1024. if(ret != UA_STATUSCODE_GOOD)
  1025. return ret;
  1026. /* Check the recursion limit */
  1027. if(ctx->depth > UA_ENCODING_MAX_RECURSION)
  1028. return UA_STATUSCODE_BADENCODINGERROR;
  1029. ctx->depth++;
  1030. /* Decode the content */
  1031. if(encodingMask & 0x01u) {
  1032. dst->hasValue = true;
  1033. ret |= DECODE_DIRECT(&dst->value, Variant);
  1034. }
  1035. if(encodingMask & 0x02u) {
  1036. dst->hasStatus = true;
  1037. ret |= DECODE_DIRECT(&dst->status, UInt32); /* StatusCode */
  1038. }
  1039. if(encodingMask & 0x04u) {
  1040. dst->hasSourceTimestamp = true;
  1041. ret |= DECODE_DIRECT(&dst->sourceTimestamp, UInt64); /* DateTime */
  1042. }
  1043. if(encodingMask & 0x10u) {
  1044. dst->hasSourcePicoseconds = true;
  1045. ret |= DECODE_DIRECT(&dst->sourcePicoseconds, UInt16);
  1046. if(dst->sourcePicoseconds > MAX_PICO_SECONDS)
  1047. dst->sourcePicoseconds = MAX_PICO_SECONDS;
  1048. }
  1049. if(encodingMask & 0x08u) {
  1050. dst->hasServerTimestamp = true;
  1051. ret |= DECODE_DIRECT(&dst->serverTimestamp, UInt64); /* DateTime */
  1052. }
  1053. if(encodingMask & 0x20u) {
  1054. dst->hasServerPicoseconds = true;
  1055. ret |= DECODE_DIRECT(&dst->serverPicoseconds, UInt16);
  1056. if(dst->serverPicoseconds > MAX_PICO_SECONDS)
  1057. dst->serverPicoseconds = MAX_PICO_SECONDS;
  1058. }
  1059. ctx->depth--;
  1060. return ret;
  1061. }
  1062. /* DiagnosticInfo */
  1063. ENCODE_BINARY(DiagnosticInfo) {
  1064. /* Set up the encoding mask */
  1065. u8 encodingMask = src->hasSymbolicId;
  1066. encodingMask |= (u8)(src->hasNamespaceUri << 1u);
  1067. encodingMask |= (u8)(src->hasLocalizedText << 2u);
  1068. encodingMask |= (u8)(src->hasLocale << 3u);
  1069. encodingMask |= (u8)(src->hasAdditionalInfo << 4u);
  1070. encodingMask |= (u8)(src->hasInnerDiagnosticInfo << 5u);
  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 & 0x01u) {
  1109. dst->hasSymbolicId = true;
  1110. ret |= DECODE_DIRECT(&dst->symbolicId, UInt32); /* Int32 */
  1111. }
  1112. if(encodingMask & 0x02u) {
  1113. dst->hasNamespaceUri = true;
  1114. ret |= DECODE_DIRECT(&dst->namespaceUri, UInt32); /* Int32 */
  1115. }
  1116. if(encodingMask & 0x04u) {
  1117. dst->hasLocalizedText = true;
  1118. ret |= DECODE_DIRECT(&dst->localizedText, UInt32); /* Int32 */
  1119. }
  1120. if(encodingMask & 0x08u) {
  1121. dst->hasLocale = true;
  1122. ret |= DECODE_DIRECT(&dst->locale, UInt32); /* Int32 */
  1123. }
  1124. if(encodingMask & 0x10u) {
  1125. dst->hasAdditionalInfo = true;
  1126. ret |= DECODE_DIRECT(&dst->additionalInfo, String);
  1127. }
  1128. if(encodingMask & 0x20u) {
  1129. dst->hasInnerStatusCode = true;
  1130. ret |= DECODE_DIRECT(&dst->innerStatusCode, UInt32); /* StatusCode */
  1131. }
  1132. if(encodingMask & 0x40u) {
  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. (void)src, (void)type, (void)ctx;
  1181. return UA_STATUSCODE_BADNOTIMPLEMENTED;
  1182. }
  1183. /********************/
  1184. /* Structured Types */
  1185. /********************/
  1186. const encodeBinarySignature encodeBinaryJumpTable[UA_DATATYPEKINDS] = {
  1187. (encodeBinarySignature)Boolean_encodeBinary,
  1188. (encodeBinarySignature)Byte_encodeBinary, /* SByte */
  1189. (encodeBinarySignature)Byte_encodeBinary,
  1190. (encodeBinarySignature)UInt16_encodeBinary, /* Int16 */
  1191. (encodeBinarySignature)UInt16_encodeBinary,
  1192. (encodeBinarySignature)UInt32_encodeBinary, /* Int32 */
  1193. (encodeBinarySignature)UInt32_encodeBinary,
  1194. (encodeBinarySignature)UInt64_encodeBinary, /* Int64 */
  1195. (encodeBinarySignature)UInt64_encodeBinary,
  1196. (encodeBinarySignature)Float_encodeBinary,
  1197. (encodeBinarySignature)Double_encodeBinary,
  1198. (encodeBinarySignature)String_encodeBinary,
  1199. (encodeBinarySignature)UInt64_encodeBinary, /* DateTime */
  1200. (encodeBinarySignature)Guid_encodeBinary,
  1201. (encodeBinarySignature)String_encodeBinary, /* ByteString */
  1202. (encodeBinarySignature)String_encodeBinary, /* XmlElement */
  1203. (encodeBinarySignature)NodeId_encodeBinary,
  1204. (encodeBinarySignature)ExpandedNodeId_encodeBinary,
  1205. (encodeBinarySignature)UInt32_encodeBinary, /* StatusCode */
  1206. (encodeBinarySignature)QualifiedName_encodeBinary,
  1207. (encodeBinarySignature)LocalizedText_encodeBinary,
  1208. (encodeBinarySignature)ExtensionObject_encodeBinary,
  1209. (encodeBinarySignature)DataValue_encodeBinary,
  1210. (encodeBinarySignature)Variant_encodeBinary,
  1211. (encodeBinarySignature)DiagnosticInfo_encodeBinary,
  1212. (encodeBinarySignature)encodeBinaryNotImplemented, /* Decimal */
  1213. (encodeBinarySignature)UInt32_encodeBinary, /* Enumeration */
  1214. (encodeBinarySignature)encodeBinaryStruct,
  1215. (encodeBinarySignature)encodeBinaryNotImplemented, /* Structure with Optional Fields */
  1216. (encodeBinarySignature)encodeBinaryStruct, /* Union */
  1217. (encodeBinarySignature)encodeBinaryStruct /* BitfieldCluster */
  1218. };
  1219. status
  1220. UA_encodeBinary(const void *src, const UA_DataType *type,
  1221. u8 **bufPos, const u8 **bufEnd,
  1222. UA_exchangeEncodeBuffer exchangeCallback, void *exchangeHandle) {
  1223. /* Set up the context */
  1224. Ctx ctx;
  1225. ctx.pos = *bufPos;
  1226. ctx.end = *bufEnd;
  1227. ctx.depth = 0;
  1228. ctx.exchangeBufferCallback = exchangeCallback;
  1229. ctx.exchangeBufferCallbackHandle = exchangeHandle;
  1230. if(!ctx.pos)
  1231. return UA_STATUSCODE_BADINVALIDARGUMENT;
  1232. /* Encode */
  1233. status ret = encodeWithExchangeBuffer(src, type, &ctx);
  1234. /* Set the new buffer position for the output. Beware that the buffer might
  1235. * have been exchanged internally. */
  1236. *bufPos = ctx.pos;
  1237. *bufEnd = ctx.end;
  1238. return ret;
  1239. }
  1240. static status
  1241. decodeBinaryNotImplemented(void *dst, const UA_DataType *type, Ctx *ctx) {
  1242. (void)dst, (void)type, (void)ctx;
  1243. return UA_STATUSCODE_BADNOTIMPLEMENTED;
  1244. }
  1245. static status
  1246. decodeBinaryStructure(void *dst, const UA_DataType *type, Ctx *ctx) {
  1247. /* Check the recursion limit */
  1248. if(ctx->depth > UA_ENCODING_MAX_RECURSION)
  1249. return UA_STATUSCODE_BADENCODINGERROR;
  1250. ctx->depth++;
  1251. uintptr_t ptr = (uintptr_t)dst;
  1252. status ret = UA_STATUSCODE_GOOD;
  1253. u8 membersSize = type->membersSize;
  1254. const UA_DataType *typelists[2] = { UA_TYPES, &type[-type->typeIndex] };
  1255. /* Loop over members */
  1256. for(size_t i = 0; i < membersSize && ret == UA_STATUSCODE_GOOD; ++i) {
  1257. const UA_DataTypeMember *m = &type->members[i];
  1258. const UA_DataType *mt = &typelists[!m->namespaceZero][m->memberTypeIndex];
  1259. ptr += m->padding;
  1260. /* Array */
  1261. if(m->isArray) {
  1262. size_t *length = (size_t*)ptr;
  1263. ptr += sizeof(size_t);
  1264. ret = Array_decodeBinary((void *UA_RESTRICT *UA_RESTRICT)ptr, length, mt , ctx);
  1265. ptr += sizeof(void*);
  1266. continue;
  1267. }
  1268. /* Scalar */
  1269. ret = decodeBinaryJumpTable[mt->typeKind]((void *UA_RESTRICT)ptr, mt, ctx);
  1270. ptr += mt->memSize;
  1271. }
  1272. ctx->depth--;
  1273. return ret;
  1274. }
  1275. const decodeBinarySignature decodeBinaryJumpTable[UA_DATATYPEKINDS] = {
  1276. (decodeBinarySignature)Boolean_decodeBinary,
  1277. (decodeBinarySignature)Byte_decodeBinary, /* SByte */
  1278. (decodeBinarySignature)Byte_decodeBinary,
  1279. (decodeBinarySignature)UInt16_decodeBinary, /* Int16 */
  1280. (decodeBinarySignature)UInt16_decodeBinary,
  1281. (decodeBinarySignature)UInt32_decodeBinary, /* Int32 */
  1282. (decodeBinarySignature)UInt32_decodeBinary,
  1283. (decodeBinarySignature)UInt64_decodeBinary, /* Int64 */
  1284. (decodeBinarySignature)UInt64_decodeBinary,
  1285. (decodeBinarySignature)Float_decodeBinary,
  1286. (decodeBinarySignature)Double_decodeBinary,
  1287. (decodeBinarySignature)String_decodeBinary,
  1288. (decodeBinarySignature)UInt64_decodeBinary, /* DateTime */
  1289. (decodeBinarySignature)Guid_decodeBinary,
  1290. (decodeBinarySignature)String_decodeBinary, /* ByteString */
  1291. (decodeBinarySignature)String_decodeBinary, /* XmlElement */
  1292. (decodeBinarySignature)NodeId_decodeBinary,
  1293. (decodeBinarySignature)ExpandedNodeId_decodeBinary,
  1294. (decodeBinarySignature)UInt32_decodeBinary, /* StatusCode */
  1295. (decodeBinarySignature)QualifiedName_decodeBinary,
  1296. (decodeBinarySignature)LocalizedText_decodeBinary,
  1297. (decodeBinarySignature)ExtensionObject_decodeBinary,
  1298. (decodeBinarySignature)DataValue_decodeBinary,
  1299. (decodeBinarySignature)Variant_decodeBinary,
  1300. (decodeBinarySignature)DiagnosticInfo_decodeBinary,
  1301. (decodeBinarySignature)decodeBinaryNotImplemented, /* Decimal */
  1302. (decodeBinarySignature)UInt32_decodeBinary, /* Enumeration */
  1303. (decodeBinarySignature)decodeBinaryStructure,
  1304. (decodeBinarySignature)decodeBinaryNotImplemented, /* Structure with optional fields */
  1305. (decodeBinarySignature)decodeBinaryNotImplemented, /* Union */
  1306. (decodeBinarySignature)decodeBinaryNotImplemented /* BitfieldCluster */
  1307. };
  1308. status
  1309. UA_decodeBinary(const UA_ByteString *src, size_t *offset, void *dst,
  1310. const UA_DataType *type, const UA_DataTypeArray *customTypes) {
  1311. /* Set up the context */
  1312. Ctx ctx;
  1313. ctx.pos = &src->data[*offset];
  1314. ctx.end = &src->data[src->length];
  1315. ctx.depth = 0;
  1316. ctx.customTypes = customTypes;
  1317. /* Decode */
  1318. memset(dst, 0, type->memSize); /* Initialize the value */
  1319. status ret = decodeBinaryJumpTable[type->typeKind](dst, type, &ctx);
  1320. if(ret == UA_STATUSCODE_GOOD) {
  1321. /* Set the new offset */
  1322. *offset = (size_t)(ctx.pos - src->data) / sizeof(u8);
  1323. } else {
  1324. /* Clean up */
  1325. UA_clear(dst, type);
  1326. memset(dst, 0, type->memSize);
  1327. }
  1328. return ret;
  1329. }
  1330. /**
  1331. * Compute the Message Size
  1332. * ------------------------
  1333. * The following methods are used to compute the length of a datum in binary
  1334. * encoding. */
  1335. static size_t
  1336. Array_calcSizeBinary(const void *src, size_t length, const UA_DataType *type) {
  1337. size_t s = 4; /* length */
  1338. if(type->overlayable) {
  1339. s += type->memSize * length;
  1340. return s;
  1341. }
  1342. uintptr_t ptr = (uintptr_t)src;
  1343. for(size_t i = 0; i < length; ++i) {
  1344. s += calcSizeBinaryJumpTable[type->typeKind]((const void*)ptr, type);
  1345. ptr += type->memSize;
  1346. }
  1347. return s;
  1348. }
  1349. static size_t calcSizeBinary1(const void *_, const UA_DataType *__) { (void)_, (void)__; return 1; }
  1350. static size_t calcSizeBinary2(const void *_, const UA_DataType *__) { (void)_, (void)__; return 2; }
  1351. static size_t calcSizeBinary4(const void *_, const UA_DataType *__) { (void)_, (void)__; return 4; }
  1352. static size_t calcSizeBinary8(const void *_, const UA_DataType *__) { (void)_, (void)__; return 8; }
  1353. CALCSIZE_BINARY(String) { return 4 + src->length; }
  1354. CALCSIZE_BINARY(Guid) { return 16; }
  1355. CALCSIZE_BINARY(NodeId) {
  1356. size_t s = 1; /* Encoding byte */
  1357. switch(src->identifierType) {
  1358. case UA_NODEIDTYPE_NUMERIC:
  1359. if(src->identifier.numeric > UA_UINT16_MAX || src->namespaceIndex > UA_BYTE_MAX) {
  1360. s += 6;
  1361. } else if(src->identifier.numeric > UA_BYTE_MAX || src->namespaceIndex > 0) {
  1362. s += 3;
  1363. } else {
  1364. s += 1;
  1365. }
  1366. break;
  1367. case UA_NODEIDTYPE_BYTESTRING:
  1368. case UA_NODEIDTYPE_STRING:
  1369. s += 2;
  1370. s += String_calcSizeBinary(&src->identifier.string, NULL);
  1371. break;
  1372. case UA_NODEIDTYPE_GUID:
  1373. s += 18;
  1374. break;
  1375. default:
  1376. return 0;
  1377. }
  1378. return s;
  1379. }
  1380. CALCSIZE_BINARY(ExpandedNodeId) {
  1381. size_t s = NodeId_calcSizeBinary(&src->nodeId, NULL);
  1382. if(src->namespaceUri.length > 0)
  1383. s += String_calcSizeBinary(&src->namespaceUri, NULL);
  1384. if(src->serverIndex > 0)
  1385. s += 4;
  1386. return s;
  1387. }
  1388. CALCSIZE_BINARY(QualifiedName) {
  1389. return 2 + String_calcSizeBinary(&src->name, NULL);
  1390. }
  1391. CALCSIZE_BINARY(LocalizedText) {
  1392. size_t s = 1; /* Encoding byte */
  1393. if(src->locale.data)
  1394. s += String_calcSizeBinary(&src->locale, NULL);
  1395. if(src->text.data)
  1396. s += String_calcSizeBinary(&src->text, NULL);
  1397. return s;
  1398. }
  1399. CALCSIZE_BINARY(ExtensionObject) {
  1400. size_t s = 1; /* Encoding byte */
  1401. /* Encoded content */
  1402. if(src->encoding <= UA_EXTENSIONOBJECT_ENCODED_XML) {
  1403. s += NodeId_calcSizeBinary(&src->content.encoded.typeId, NULL);
  1404. switch(src->encoding) {
  1405. case UA_EXTENSIONOBJECT_ENCODED_NOBODY:
  1406. break;
  1407. case UA_EXTENSIONOBJECT_ENCODED_BYTESTRING:
  1408. case UA_EXTENSIONOBJECT_ENCODED_XML:
  1409. s += String_calcSizeBinary(&src->content.encoded.body, NULL);
  1410. break;
  1411. default:
  1412. return 0;
  1413. }
  1414. return s;
  1415. }
  1416. /* Decoded content */
  1417. if(!src->content.decoded.type || !src->content.decoded.data)
  1418. return 0;
  1419. if(src->content.decoded.type->typeId.identifierType != UA_NODEIDTYPE_NUMERIC)
  1420. return 0;
  1421. s += NodeId_calcSizeBinary(&src->content.decoded.type->typeId, NULL); /* Type encoding length */
  1422. s += 4; /* Encoding length field */
  1423. const UA_DataType *type = src->content.decoded.type;
  1424. s += calcSizeBinaryJumpTable[type->typeKind](src->content.decoded.data, type); /* Encoding length */
  1425. return s;
  1426. }
  1427. CALCSIZE_BINARY(Variant) {
  1428. size_t s = 1; /* Encoding byte */
  1429. if(!src->type)
  1430. return s;
  1431. const UA_Boolean isArray = src->arrayLength > 0 || src->data <= UA_EMPTY_ARRAY_SENTINEL;
  1432. if(isArray)
  1433. s += Array_calcSizeBinary(src->data, src->arrayLength, src->type);
  1434. else
  1435. s += calcSizeBinaryJumpTable[src->type->typeKind](src->data, src->type);
  1436. const UA_Boolean isBuiltin = (src->type->typeKind <= UA_DATATYPEKIND_DIAGNOSTICINFO);
  1437. const UA_Boolean isEnum = (src->type->typeKind == UA_DATATYPEKIND_ENUM);
  1438. if(!isBuiltin && !isEnum) {
  1439. /* The type is wrapped inside an extensionobject */
  1440. /* (NodeId + encoding byte + extension object length) * array length */
  1441. size_t length = isArray ? src->arrayLength : 1;
  1442. s += (NodeId_calcSizeBinary(&src->type->typeId, NULL) + 1 + 4) * length;
  1443. }
  1444. const UA_Boolean hasDimensions = isArray && src->arrayDimensionsSize > 0;
  1445. if(hasDimensions)
  1446. s += Array_calcSizeBinary(src->arrayDimensions, src->arrayDimensionsSize,
  1447. &UA_TYPES[UA_TYPES_INT32]);
  1448. return s;
  1449. }
  1450. CALCSIZE_BINARY(DataValue) {
  1451. size_t s = 1; /* Encoding byte */
  1452. if(src->hasValue)
  1453. s += Variant_calcSizeBinary(&src->value, NULL);
  1454. if(src->hasStatus)
  1455. s += 4;
  1456. if(src->hasSourceTimestamp)
  1457. s += 8;
  1458. if(src->hasSourcePicoseconds)
  1459. s += 2;
  1460. if(src->hasServerTimestamp)
  1461. s += 8;
  1462. if(src->hasServerPicoseconds)
  1463. s += 2;
  1464. return s;
  1465. }
  1466. CALCSIZE_BINARY(DiagnosticInfo) {
  1467. size_t s = 1; /* Encoding byte */
  1468. if(src->hasSymbolicId)
  1469. s += 4;
  1470. if(src->hasNamespaceUri)
  1471. s += 4;
  1472. if(src->hasLocalizedText)
  1473. s += 4;
  1474. if(src->hasLocale)
  1475. s += 4;
  1476. if(src->hasAdditionalInfo)
  1477. s += String_calcSizeBinary(&src->additionalInfo, NULL);
  1478. if(src->hasInnerStatusCode)
  1479. s += 4;
  1480. if(src->hasInnerDiagnosticInfo)
  1481. s += DiagnosticInfo_calcSizeBinary(src->innerDiagnosticInfo, NULL);
  1482. return s;
  1483. }
  1484. static size_t
  1485. calcSizeBinaryStructure(const void *p, const UA_DataType *type) {
  1486. size_t s = 0;
  1487. uintptr_t ptr = (uintptr_t)p;
  1488. u8 membersSize = type->membersSize;
  1489. const UA_DataType *typelists[2] = { UA_TYPES, &type[-type->typeIndex] };
  1490. /* Loop over members */
  1491. for(size_t i = 0; i < membersSize; ++i) {
  1492. const UA_DataTypeMember *member = &type->members[i];
  1493. const UA_DataType *membertype = &typelists[!member->namespaceZero][member->memberTypeIndex];
  1494. ptr += member->padding;
  1495. /* Array */
  1496. if(member->isArray) {
  1497. const size_t length = *((const size_t*)ptr);
  1498. ptr += sizeof(size_t);
  1499. s += Array_calcSizeBinary(*(void *UA_RESTRICT const *)ptr, length, membertype);
  1500. ptr += sizeof(void*);
  1501. continue;
  1502. }
  1503. /* Scalar */
  1504. s += calcSizeBinaryJumpTable[membertype->typeKind]((const void*)ptr, membertype);
  1505. ptr += membertype->memSize;
  1506. }
  1507. return s;
  1508. }
  1509. static size_t
  1510. calcSizeBinaryNotImplemented(const void *p, const UA_DataType *type) {
  1511. (void)p, (void)type;
  1512. return 0;
  1513. }
  1514. const calcSizeBinarySignature calcSizeBinaryJumpTable[UA_DATATYPEKINDS] = {
  1515. (calcSizeBinarySignature)calcSizeBinary1, /* Boolean */
  1516. (calcSizeBinarySignature)calcSizeBinary1, /* SByte */
  1517. (calcSizeBinarySignature)calcSizeBinary1, /* Byte */
  1518. (calcSizeBinarySignature)calcSizeBinary2, /* Int16 */
  1519. (calcSizeBinarySignature)calcSizeBinary2, /* UInt16 */
  1520. (calcSizeBinarySignature)calcSizeBinary4, /* Int32 */
  1521. (calcSizeBinarySignature)calcSizeBinary4, /* UInt32 */
  1522. (calcSizeBinarySignature)calcSizeBinary8, /* Int64 */
  1523. (calcSizeBinarySignature)calcSizeBinary8, /* UInt64 */
  1524. (calcSizeBinarySignature)calcSizeBinary4, /* Float */
  1525. (calcSizeBinarySignature)calcSizeBinary8, /* Double */
  1526. (calcSizeBinarySignature)String_calcSizeBinary,
  1527. (calcSizeBinarySignature)calcSizeBinary8, /* DateTime */
  1528. (calcSizeBinarySignature)Guid_calcSizeBinary,
  1529. (calcSizeBinarySignature)String_calcSizeBinary, /* ByteString */
  1530. (calcSizeBinarySignature)String_calcSizeBinary, /* XmlElement */
  1531. (calcSizeBinarySignature)NodeId_calcSizeBinary,
  1532. (calcSizeBinarySignature)ExpandedNodeId_calcSizeBinary,
  1533. (calcSizeBinarySignature)calcSizeBinary4, /* StatusCode */
  1534. (calcSizeBinarySignature)QualifiedName_calcSizeBinary,
  1535. (calcSizeBinarySignature)LocalizedText_calcSizeBinary,
  1536. (calcSizeBinarySignature)ExtensionObject_calcSizeBinary,
  1537. (calcSizeBinarySignature)DataValue_calcSizeBinary,
  1538. (calcSizeBinarySignature)Variant_calcSizeBinary,
  1539. (calcSizeBinarySignature)DiagnosticInfo_calcSizeBinary,
  1540. (calcSizeBinarySignature)calcSizeBinaryNotImplemented, /* Decimal */
  1541. (calcSizeBinarySignature)calcSizeBinary4, /* Enumeration */
  1542. (calcSizeBinarySignature)calcSizeBinaryStructure,
  1543. (calcSizeBinarySignature)calcSizeBinaryNotImplemented, /* Structure with Optional Fields */
  1544. (calcSizeBinarySignature)calcSizeBinaryNotImplemented, /* Union */
  1545. (calcSizeBinarySignature)calcSizeBinaryNotImplemented /* BitfieldCluster */
  1546. };
  1547. size_t
  1548. UA_calcSizeBinary(const void *p, const UA_DataType *type) {
  1549. return calcSizeBinaryJumpTable[type->typeKind](p, type);
  1550. }