ua_types_encoding_binary.c 62 KB

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