ua_pubsub_writer.c 88 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977
  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 (c) 2017-2018 Fraunhofer IOSB (Author: Andreas Ebner)
  6. * Copyright (c) 2019 Fraunhofer IOSB (Author: Julius Pfrommer)
  7. * Copyright (c) 2019 Kalycito Infotech Private Limited
  8. */
  9. #include <open62541/server_pubsub.h>
  10. #include <open62541/plugin/log_stdout.h>
  11. #include "server/ua_server_internal.h"
  12. #ifdef UA_ENABLE_PUBSUB /* conditional compilation */
  13. #include "ua_pubsub.h"
  14. #include "ua_pubsub_networkmessage.h"
  15. #ifdef UA_ENABLE_PUBSUB_INFORMATIONMODEL
  16. #include "ua_pubsub_ns0.h"
  17. #endif
  18. #ifdef UA_ENABLE_PUBSUB_DELTAFRAMES
  19. #include "ua_types_encoding_binary.h"
  20. #endif
  21. #define UA_MAX_STACKBUF 512 /* Max size of network messages on the stack */
  22. /* Forward declaration */
  23. static void
  24. UA_WriterGroup_clear(UA_Server *server, UA_WriterGroup *writerGroup);
  25. static void
  26. UA_DataSetField_clear(UA_DataSetField *field);
  27. static UA_StatusCode
  28. generateNetworkMessage(UA_PubSubConnection *connection, UA_WriterGroup *wg,
  29. UA_DataSetMessage *dsm, UA_UInt16 *writerIds, UA_Byte dsmCount,
  30. UA_ExtensionObject *messageSettings,
  31. UA_ExtensionObject *transportSettings,
  32. UA_NetworkMessage *networkMessage);
  33. static UA_StatusCode
  34. UA_DataSetWriter_generateDataSetMessage(UA_Server *server, UA_DataSetMessage *dataSetMessage,
  35. UA_DataSetWriter *dataSetWriter);
  36. /**********************************************/
  37. /* Connection */
  38. /**********************************************/
  39. UA_StatusCode
  40. UA_PubSubConnectionConfig_copy(const UA_PubSubConnectionConfig *src,
  41. UA_PubSubConnectionConfig *dst) {
  42. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  43. memcpy(dst, src, sizeof(UA_PubSubConnectionConfig));
  44. retVal |= UA_String_copy(&src->name, &dst->name);
  45. retVal |= UA_Variant_copy(&src->address, &dst->address);
  46. retVal |= UA_String_copy(&src->transportProfileUri, &dst->transportProfileUri);
  47. retVal |= UA_Variant_copy(&src->connectionTransportSettings, &dst->connectionTransportSettings);
  48. if(src->connectionPropertiesSize > 0){
  49. dst->connectionProperties = (UA_KeyValuePair *)
  50. UA_calloc(src->connectionPropertiesSize, sizeof(UA_KeyValuePair));
  51. if(!dst->connectionProperties){
  52. return UA_STATUSCODE_BADOUTOFMEMORY;
  53. }
  54. for(size_t i = 0; i < src->connectionPropertiesSize; i++){
  55. retVal |= UA_QualifiedName_copy(&src->connectionProperties[i].key,
  56. &dst->connectionProperties[i].key);
  57. retVal |= UA_Variant_copy(&src->connectionProperties[i].value,
  58. &dst->connectionProperties[i].value);
  59. }
  60. }
  61. return retVal;
  62. }
  63. UA_StatusCode
  64. UA_Server_getPubSubConnectionConfig(UA_Server *server, const UA_NodeId connection,
  65. UA_PubSubConnectionConfig *config) {
  66. if(!config)
  67. return UA_STATUSCODE_BADINVALIDARGUMENT;
  68. UA_PubSubConnection *currentPubSubConnection =
  69. UA_PubSubConnection_findConnectionbyId(server, connection);
  70. if(!currentPubSubConnection)
  71. return UA_STATUSCODE_BADNOTFOUND;
  72. UA_PubSubConnectionConfig tmpPubSubConnectionConfig;
  73. //deep copy of the actual config
  74. UA_PubSubConnectionConfig_copy(currentPubSubConnection->config, &tmpPubSubConnectionConfig);
  75. *config = tmpPubSubConnectionConfig;
  76. return UA_STATUSCODE_GOOD;
  77. }
  78. UA_PubSubConnection *
  79. UA_PubSubConnection_findConnectionbyId(UA_Server *server, UA_NodeId connectionIdentifier) {
  80. for(size_t i = 0; i < server->pubSubManager.connectionsSize; i++){
  81. if(UA_NodeId_equal(&connectionIdentifier, &server->pubSubManager.connections[i].identifier)){
  82. return &server->pubSubManager.connections[i];
  83. }
  84. }
  85. return NULL;
  86. }
  87. void
  88. UA_PubSubConnectionConfig_clear(UA_PubSubConnectionConfig *connectionConfig) {
  89. UA_String_clear(&connectionConfig->name);
  90. UA_String_clear(&connectionConfig->transportProfileUri);
  91. UA_Variant_clear(&connectionConfig->connectionTransportSettings);
  92. UA_Variant_clear(&connectionConfig->address);
  93. for(size_t i = 0; i < connectionConfig->connectionPropertiesSize; i++){
  94. UA_QualifiedName_clear(&connectionConfig->connectionProperties[i].key);
  95. UA_Variant_clear(&connectionConfig->connectionProperties[i].value);
  96. }
  97. UA_free(connectionConfig->connectionProperties);
  98. }
  99. void
  100. UA_PubSubConnection_clear(UA_Server *server, UA_PubSubConnection *connection) {
  101. //delete connection config
  102. UA_PubSubConnectionConfig_clear(connection->config);
  103. //remove contained WriterGroups
  104. UA_WriterGroup *writerGroup, *tmpWriterGroup;
  105. LIST_FOREACH_SAFE(writerGroup, &connection->writerGroups, listEntry, tmpWriterGroup){
  106. UA_Server_removeWriterGroup(server, writerGroup->identifier);
  107. }
  108. /* remove contained ReaderGroups */
  109. UA_ReaderGroup *readerGroups, *tmpReaderGroup;
  110. LIST_FOREACH_SAFE(readerGroups, &connection->readerGroups, listEntry, tmpReaderGroup){
  111. UA_Server_removeReaderGroup(server, readerGroups->identifier);
  112. }
  113. UA_NodeId_clear(&connection->identifier);
  114. if(connection->channel){
  115. connection->channel->close(connection->channel);
  116. }
  117. UA_free(connection->config);
  118. }
  119. UA_StatusCode
  120. UA_PubSubConnection_regist(UA_Server *server, UA_NodeId *connectionIdentifier) {
  121. UA_PubSubConnection *connection =
  122. UA_PubSubConnection_findConnectionbyId(server, *connectionIdentifier);
  123. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  124. if(connection == NULL) {
  125. return UA_STATUSCODE_BADNOTFOUND;
  126. }
  127. retval = connection->channel->regist(connection->channel, NULL, NULL);
  128. if(retval != UA_STATUSCODE_GOOD) {
  129. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  130. "register channel failed: 0x%x!", retval);
  131. }
  132. return retval;
  133. }
  134. UA_StatusCode
  135. UA_Server_addWriterGroup(UA_Server *server, const UA_NodeId connection,
  136. const UA_WriterGroupConfig *writerGroupConfig,
  137. UA_NodeId *writerGroupIdentifier) {
  138. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  139. if(!writerGroupConfig)
  140. return UA_STATUSCODE_BADINVALIDARGUMENT;
  141. //search the connection by the given connectionIdentifier
  142. UA_PubSubConnection *currentConnectionContext =
  143. UA_PubSubConnection_findConnectionbyId(server, connection);
  144. if(!currentConnectionContext)
  145. return UA_STATUSCODE_BADNOTFOUND;
  146. if(currentConnectionContext->config->configurationFrozen){
  147. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  148. "Adding WriterGroup failed. PubSubConnection is frozen.");
  149. return UA_STATUSCODE_BADCONFIGURATIONERROR;
  150. }
  151. //allocate memory for new WriterGroup
  152. UA_WriterGroup *newWriterGroup = (UA_WriterGroup *) UA_calloc(1, sizeof(UA_WriterGroup));
  153. if(!newWriterGroup)
  154. return UA_STATUSCODE_BADOUTOFMEMORY;
  155. newWriterGroup->linkedConnection = currentConnectionContext->identifier;
  156. UA_PubSubManager_generateUniqueNodeId(server, &newWriterGroup->identifier);
  157. if(writerGroupIdentifier){
  158. UA_NodeId_copy(&newWriterGroup->identifier, writerGroupIdentifier);
  159. }
  160. //deep copy of the config
  161. UA_WriterGroupConfig tmpWriterGroupConfig;
  162. retVal |= UA_WriterGroupConfig_copy(writerGroupConfig, &tmpWriterGroupConfig);
  163. if(!tmpWriterGroupConfig.messageSettings.content.decoded.type) {
  164. UA_UadpWriterGroupMessageDataType *wgm = UA_UadpWriterGroupMessageDataType_new();
  165. tmpWriterGroupConfig.messageSettings.content.decoded.data = wgm;
  166. tmpWriterGroupConfig.messageSettings.content.decoded.type =
  167. &UA_TYPES[UA_TYPES_UADPWRITERGROUPMESSAGEDATATYPE];
  168. tmpWriterGroupConfig.messageSettings.encoding = UA_EXTENSIONOBJECT_DECODED;
  169. }
  170. newWriterGroup->config = tmpWriterGroupConfig;
  171. LIST_INSERT_HEAD(&currentConnectionContext->writerGroups, newWriterGroup, listEntry);
  172. #ifdef UA_ENABLE_PUBSUB_INFORMATIONMODEL
  173. addWriterGroupRepresentation(server, newWriterGroup);
  174. #endif
  175. return retVal;
  176. }
  177. UA_StatusCode
  178. UA_Server_removeWriterGroup(UA_Server *server, const UA_NodeId writerGroup){
  179. UA_WriterGroup *wg = UA_WriterGroup_findWGbyId(server, writerGroup);
  180. if(!wg)
  181. return UA_STATUSCODE_BADNOTFOUND;
  182. if(wg->config.configurationFrozen){
  183. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  184. "Delete WriterGroup failed. WriterGroup is frozen.");
  185. return UA_STATUSCODE_BADCONFIGURATIONERROR;
  186. }
  187. UA_PubSubConnection *connection =
  188. UA_PubSubConnection_findConnectionbyId(server, wg->linkedConnection);
  189. if(!connection)
  190. return UA_STATUSCODE_BADNOTFOUND;
  191. if(connection->config->configurationFrozen){
  192. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  193. "Delete WriterGroup failed. PubSubConnection is frozen.");
  194. return UA_STATUSCODE_BADCONFIGURATIONERROR;
  195. }
  196. if(wg->state == UA_PUBSUBSTATE_OPERATIONAL){
  197. //unregister the publish callback
  198. UA_PubSubManager_removeRepeatedPubSubCallback(server, wg->publishCallbackId);
  199. }
  200. #ifdef UA_ENABLE_PUBSUB_INFORMATIONMODEL
  201. removeGroupRepresentation(server, wg);
  202. #endif
  203. UA_WriterGroup_clear(server, wg);
  204. LIST_REMOVE(wg, listEntry);
  205. UA_free(wg);
  206. return UA_STATUSCODE_GOOD;
  207. }
  208. UA_StatusCode
  209. UA_Server_freezeWriterGroupConfiguration(UA_Server *server, const UA_NodeId writerGroup){
  210. UA_WriterGroup *wg = UA_WriterGroup_findWGbyId(server, writerGroup);
  211. if(!wg)
  212. return UA_STATUSCODE_BADNOTFOUND;
  213. //PubSubConnection freezeCounter++
  214. UA_PubSubConnection *pubSubConnection = UA_PubSubConnection_findConnectionbyId(server, wg->linkedConnection);
  215. pubSubConnection->configurationFreezeCounter++;
  216. pubSubConnection->config->configurationFrozen = UA_TRUE;
  217. //WriterGroup freeze
  218. wg->config.configurationFrozen = UA_TRUE;
  219. //DataSetWriter freeze
  220. size_t dsmCount = 0;
  221. UA_DataSetWriter *dataSetWriter;
  222. LIST_FOREACH(dataSetWriter, &wg->writers, listEntry){
  223. dataSetWriter->config.configurationFrozen = UA_TRUE;
  224. //PublishedDataSet freezeCounter++
  225. UA_PublishedDataSet *publishedDataSet = UA_PublishedDataSet_findPDSbyId(server, dataSetWriter->connectedDataSet);
  226. publishedDataSet->configurationFreezeCounter++;
  227. publishedDataSet->config.configurationFrozen = UA_TRUE;
  228. //DataSetFields freeze
  229. UA_DataSetField *dataSetField;
  230. TAILQ_FOREACH(dataSetField, &publishedDataSet->fields, listEntry){
  231. dataSetField->config.configurationFrozen = UA_TRUE;
  232. }
  233. }
  234. if(wg->config.rtLevel == UA_PUBSUB_RT_FIXED_SIZE){
  235. if(wg->config.encodingMimeType != UA_PUBSUB_ENCODING_UADP) {
  236. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  237. "PubSub-RT configuration fail: Non-RT capable encoding.");
  238. return UA_STATUSCODE_BADNOTSUPPORTED;
  239. }
  240. //TODO Clarify: should we only allow = maxEncapsulatedDataSetMessageCount == 1 with RT?
  241. //TODO Clarify: Behaviour if the finale size is more than MTU
  242. //generate data set messages
  243. UA_STACKARRAY(UA_UInt16, dsWriterIds, wg->writersCount);
  244. UA_STACKARRAY(UA_DataSetMessage, dsmStore, wg->writersCount);
  245. UA_DataSetWriter *dsw;
  246. LIST_FOREACH(dsw, &wg->writers, listEntry) {
  247. /* Find the dataset */
  248. UA_PublishedDataSet *pds =
  249. UA_PublishedDataSet_findPDSbyId(server, dsw->connectedDataSet);
  250. if(!pds) {
  251. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  252. "PubSub Publish: PublishedDataSet not found");
  253. continue;
  254. }
  255. if(pds->promotedFieldsCount > 0) {
  256. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  257. "PubSub-RT configuration fail: PDS contains promoted fields.");
  258. return UA_STATUSCODE_BADNOTSUPPORTED;
  259. }
  260. //TODO Check if all fields have an fixed size and static value source
  261. //loop over the fields and check value source + type
  262. /* Generate the DSM */
  263. UA_StatusCode res =
  264. UA_DataSetWriter_generateDataSetMessage(server, &dsmStore[dsmCount], dsw);
  265. if(res != UA_STATUSCODE_GOOD) {
  266. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  267. "PubSub RT Offset calculation: DataSetMessage buffering failed");
  268. continue;
  269. }
  270. dsWriterIds[dsmCount] = dsw->config.dataSetWriterId;
  271. dsmCount++;
  272. }
  273. UA_NetworkMessage networkMessage;
  274. generateNetworkMessage(pubSubConnection, wg, dsmStore, dsWriterIds, (UA_Byte) dsmCount,
  275. &wg->config.messageSettings, &wg->config.transportSettings, &networkMessage);
  276. UA_NetworkMessage_generateOffsetBuffer(&wg->bufferedMessage, &networkMessage);
  277. /* Allocate the buffer. Allocate on the stack if the buffer is small. */
  278. UA_ByteString buf;
  279. size_t msgSize = UA_NetworkMessage_calcSizeBinary(&networkMessage);
  280. UA_StatusCode retval = UA_ByteString_allocBuffer(&buf, msgSize);
  281. if(retval != UA_STATUSCODE_GOOD)
  282. return UA_STATUSCODE_BADOUTOFMEMORY;
  283. wg->bufferedMessage.buffer = buf;
  284. const UA_Byte *bufEnd = &wg->bufferedMessage.buffer.data[wg->bufferedMessage.buffer.length];
  285. UA_Byte *bufPos = wg->bufferedMessage.buffer.data;
  286. UA_NetworkMessage_encodeBinary(&networkMessage, &bufPos, bufEnd);
  287. }
  288. return UA_STATUSCODE_GOOD;
  289. }
  290. UA_StatusCode
  291. UA_Server_unfreezeWriterGroupConfiguration(UA_Server *server, const UA_NodeId writerGroup){
  292. UA_WriterGroup *wg = UA_WriterGroup_findWGbyId(server, writerGroup);
  293. if(!wg)
  294. return UA_STATUSCODE_BADNOTFOUND;
  295. //if(wg->config.rtLevel == UA_PUBSUB_RT_NONE){
  296. // UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  297. // "PubSub configuration freeze without RT configuration has no effect.");
  298. // return UA_STATUSCODE_BADCONFIGURATIONERROR;
  299. //}
  300. //PubSubConnection freezeCounter--
  301. UA_PubSubConnection *pubSubConnection = UA_PubSubConnection_findConnectionbyId(server, wg->linkedConnection);
  302. pubSubConnection->configurationFreezeCounter--;
  303. if(pubSubConnection->configurationFreezeCounter == 0){
  304. pubSubConnection->config->configurationFrozen = UA_FALSE;
  305. }
  306. //WriterGroup unfreeze
  307. wg->config.configurationFrozen = UA_FALSE;
  308. //DataSetWriter unfreeze
  309. UA_DataSetWriter *dataSetWriter;
  310. LIST_FOREACH(dataSetWriter, &wg->writers, listEntry){
  311. UA_PublishedDataSet *publishedDataSet = UA_PublishedDataSet_findPDSbyId(server, dataSetWriter->connectedDataSet);
  312. //PublishedDataSet freezeCounter--
  313. publishedDataSet->configurationFreezeCounter--;
  314. if(publishedDataSet->configurationFreezeCounter == 0){
  315. publishedDataSet->config.configurationFrozen = UA_FALSE;
  316. UA_DataSetField *dataSetField;
  317. TAILQ_FOREACH(dataSetField, &publishedDataSet->fields, listEntry){
  318. dataSetField->config.configurationFrozen = UA_FALSE;
  319. }
  320. }
  321. dataSetWriter->config.configurationFrozen = UA_FALSE;
  322. }
  323. return UA_STATUSCODE_GOOD;
  324. }
  325. UA_StatusCode UA_EXPORT
  326. UA_Server_setWriterGroupOperational(UA_Server *server, const UA_NodeId writerGroup){
  327. UA_WriterGroup *wg = UA_WriterGroup_findWGbyId(server, writerGroup);
  328. if(!wg)
  329. return UA_STATUSCODE_BADNOTFOUND;
  330. return UA_WriterGroup_setPubSubState(server, UA_PUBSUBSTATE_OPERATIONAL, wg);
  331. }
  332. UA_StatusCode UA_EXPORT
  333. UA_Server_setWriterGroupDisabled(UA_Server *server, const UA_NodeId writerGroup){
  334. UA_WriterGroup *wg = UA_WriterGroup_findWGbyId(server, writerGroup);
  335. if(!wg)
  336. return UA_STATUSCODE_BADNOTFOUND;
  337. return UA_WriterGroup_setPubSubState(server, UA_PUBSUBSTATE_DISABLED, wg);
  338. }
  339. /**********************************************/
  340. /* PublishedDataSet */
  341. /**********************************************/
  342. UA_StatusCode
  343. UA_PublishedDataSetConfig_copy(const UA_PublishedDataSetConfig *src,
  344. UA_PublishedDataSetConfig *dst) {
  345. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  346. memcpy(dst, src, sizeof(UA_PublishedDataSetConfig));
  347. retVal |= UA_String_copy(&src->name, &dst->name);
  348. switch(src->publishedDataSetType){
  349. case UA_PUBSUB_DATASET_PUBLISHEDITEMS:
  350. //no additional items
  351. break;
  352. case UA_PUBSUB_DATASET_PUBLISHEDITEMS_TEMPLATE:
  353. if(src->config.itemsTemplate.variablesToAddSize > 0){
  354. dst->config.itemsTemplate.variablesToAdd = (UA_PublishedVariableDataType *) UA_calloc(
  355. src->config.itemsTemplate.variablesToAddSize, sizeof(UA_PublishedVariableDataType));
  356. }
  357. for(size_t i = 0; i < src->config.itemsTemplate.variablesToAddSize; i++){
  358. retVal |= UA_PublishedVariableDataType_copy(&src->config.itemsTemplate.variablesToAdd[i],
  359. &dst->config.itemsTemplate.variablesToAdd[i]);
  360. }
  361. retVal |= UA_DataSetMetaDataType_copy(&src->config.itemsTemplate.metaData,
  362. &dst->config.itemsTemplate.metaData);
  363. break;
  364. default:
  365. return UA_STATUSCODE_BADINVALIDARGUMENT;
  366. }
  367. return retVal;
  368. }
  369. UA_StatusCode
  370. UA_Server_getPublishedDataSetConfig(UA_Server *server, const UA_NodeId pds,
  371. UA_PublishedDataSetConfig *config){
  372. if(!config)
  373. return UA_STATUSCODE_BADINVALIDARGUMENT;
  374. UA_PublishedDataSet *currentPublishedDataSet = UA_PublishedDataSet_findPDSbyId(server, pds);
  375. if(!currentPublishedDataSet)
  376. return UA_STATUSCODE_BADNOTFOUND;
  377. UA_PublishedDataSetConfig tmpPublishedDataSetConfig;
  378. //deep copy of the actual config
  379. UA_PublishedDataSetConfig_copy(&currentPublishedDataSet->config, &tmpPublishedDataSetConfig);
  380. *config = tmpPublishedDataSetConfig;
  381. return UA_STATUSCODE_GOOD;
  382. }
  383. UA_StatusCode
  384. UA_Server_getPublishedDataSetMetaData(UA_Server *server, const UA_NodeId pds, UA_DataSetMetaDataType *metaData){
  385. if(!metaData)
  386. return UA_STATUSCODE_BADINVALIDARGUMENT;
  387. UA_PublishedDataSet *currentPublishedDataSet = UA_PublishedDataSet_findPDSbyId(server, pds);
  388. if(!currentPublishedDataSet)
  389. return UA_STATUSCODE_BADNOTFOUND;
  390. UA_DataSetMetaDataType tmpDataSetMetaData;
  391. if(UA_DataSetMetaDataType_copy(&currentPublishedDataSet->dataSetMetaData, &tmpDataSetMetaData) != UA_STATUSCODE_GOOD)
  392. return UA_STATUSCODE_BADINTERNALERROR;
  393. *metaData = tmpDataSetMetaData;
  394. return UA_STATUSCODE_GOOD;
  395. }
  396. UA_PublishedDataSet *
  397. UA_PublishedDataSet_findPDSbyId(UA_Server *server, UA_NodeId identifier){
  398. for(size_t i = 0; i < server->pubSubManager.publishedDataSetsSize; i++){
  399. if(UA_NodeId_equal(&server->pubSubManager.publishedDataSets[i].identifier, &identifier)){
  400. return &server->pubSubManager.publishedDataSets[i];
  401. }
  402. }
  403. return NULL;
  404. }
  405. void
  406. UA_PublishedDataSetConfig_clear(UA_PublishedDataSetConfig *pdsConfig){
  407. //delete pds config
  408. UA_String_clear(&pdsConfig->name);
  409. switch (pdsConfig->publishedDataSetType){
  410. case UA_PUBSUB_DATASET_PUBLISHEDITEMS:
  411. //no additional items
  412. break;
  413. case UA_PUBSUB_DATASET_PUBLISHEDITEMS_TEMPLATE:
  414. if(pdsConfig->config.itemsTemplate.variablesToAddSize > 0){
  415. for(size_t i = 0; i < pdsConfig->config.itemsTemplate.variablesToAddSize; i++){
  416. UA_PublishedVariableDataType_clear(&pdsConfig->config.itemsTemplate.variablesToAdd[i]);
  417. }
  418. UA_free(pdsConfig->config.itemsTemplate.variablesToAdd);
  419. }
  420. UA_DataSetMetaDataType_clear(&pdsConfig->config.itemsTemplate.metaData);
  421. break;
  422. default:
  423. break;
  424. }
  425. }
  426. void
  427. UA_PublishedDataSet_clear(UA_Server *server, UA_PublishedDataSet *publishedDataSet){
  428. UA_PublishedDataSetConfig_clear(&publishedDataSet->config);
  429. //delete PDS
  430. UA_DataSetField *field, *tmpField;
  431. TAILQ_FOREACH_SAFE(field, &publishedDataSet->fields, listEntry, tmpField) {
  432. UA_Server_removeDataSetField(server, field->identifier);
  433. }
  434. UA_DataSetMetaDataType_clear(&publishedDataSet->dataSetMetaData);
  435. UA_NodeId_clear(&publishedDataSet->identifier);
  436. }
  437. static UA_StatusCode
  438. generateFieldMetaData(UA_Server *server, UA_DataSetField *field, UA_FieldMetaData *fieldMetaData){
  439. switch (field->config.dataSetFieldType){
  440. case UA_PUBSUB_DATASETFIELD_VARIABLE:
  441. if(UA_String_copy(&field->config.field.variable.fieldNameAlias, &fieldMetaData->name) != UA_STATUSCODE_GOOD)
  442. return UA_STATUSCODE_BADINTERNALERROR;
  443. fieldMetaData->description = UA_LOCALIZEDTEXT_ALLOC("", "");
  444. fieldMetaData->dataSetFieldId = UA_GUID_NULL;
  445. //ToDo after freeze PR, the value source must be checked (other behavior for static value source)
  446. if(field->config.field.variable.staticValueSourceEnabled){
  447. fieldMetaData->arrayDimensions = (UA_UInt32 *) UA_calloc(
  448. field->config.field.variable.staticValueSource.value.arrayDimensionsSize, sizeof(UA_UInt32));
  449. if(fieldMetaData->arrayDimensions == NULL)
  450. return UA_STATUSCODE_BADOUTOFMEMORY;
  451. memcpy(fieldMetaData->arrayDimensions, field->config.field.variable.staticValueSource.value.arrayDimensions,
  452. sizeof(UA_UInt32) *field->config.field.variable.staticValueSource.value.arrayDimensionsSize);
  453. fieldMetaData->arrayDimensionsSize = field->config.field.variable.staticValueSource.value.arrayDimensionsSize;
  454. if(UA_NodeId_copy(&field->config.field.variable.staticValueSource.value.type->typeId,
  455. &fieldMetaData->dataType) != UA_STATUSCODE_GOOD){
  456. if(fieldMetaData->arrayDimensions){
  457. UA_free(fieldMetaData->arrayDimensions);
  458. return UA_STATUSCODE_BADINTERNALERROR;
  459. }
  460. }
  461. fieldMetaData->properties = NULL;
  462. fieldMetaData->propertiesSize = 0;
  463. //TODO collect value rank for the static field source
  464. fieldMetaData->fieldFlags = UA_DATASETFIELDFLAGS_NONE;
  465. return UA_STATUSCODE_GOOD;
  466. }
  467. UA_Variant value;
  468. UA_Variant_init(&value);
  469. if(UA_Server_readArrayDimensions(server, field->config.field.variable.publishParameters.publishedVariable,
  470. &value) != UA_STATUSCODE_GOOD){
  471. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  472. "PubSub meta data generation. Reading ArrayDimension failed.");
  473. } else {
  474. fieldMetaData->arrayDimensions = (UA_UInt32 *) UA_calloc(value.arrayDimensionsSize, sizeof(UA_UInt32));
  475. if(fieldMetaData->arrayDimensions == NULL)
  476. return UA_STATUSCODE_BADOUTOFMEMORY;
  477. memcpy(fieldMetaData->arrayDimensions, value.arrayDimensions, sizeof(UA_UInt32)*value.arrayDimensionsSize);
  478. fieldMetaData->arrayDimensionsSize = value.arrayDimensionsSize;
  479. }
  480. if(UA_Server_readDataType(server, field->config.field.variable.publishParameters.publishedVariable,
  481. &fieldMetaData->dataType) != UA_STATUSCODE_GOOD){
  482. if(fieldMetaData->arrayDimensions){
  483. UA_free(fieldMetaData->arrayDimensions);
  484. return UA_STATUSCODE_BADINTERNALERROR;
  485. }
  486. }
  487. fieldMetaData->properties = NULL;
  488. fieldMetaData->propertiesSize = 0;
  489. UA_Int32 valueRank;
  490. if(UA_Server_readValueRank(server, field->config.field.variable.publishParameters.publishedVariable,
  491. &valueRank) != UA_STATUSCODE_GOOD){
  492. if(fieldMetaData->arrayDimensions){
  493. UA_free(fieldMetaData->arrayDimensions);
  494. return UA_STATUSCODE_BADINTERNALERROR;
  495. }
  496. }
  497. fieldMetaData->valueRank = valueRank;
  498. if(field->config.field.variable.promotedField){
  499. fieldMetaData->fieldFlags = UA_DATASETFIELDFLAGS_PROMOTEDFIELD;
  500. } else {
  501. fieldMetaData->fieldFlags = UA_DATASETFIELDFLAGS_NONE;
  502. }
  503. //TODO collect the following fields
  504. //fieldMetaData.builtInType
  505. //fieldMetaData.maxStringLength
  506. return UA_STATUSCODE_GOOD;
  507. case UA_PUBSUB_DATASETFIELD_EVENT:
  508. return UA_STATUSCODE_BADNOTSUPPORTED;
  509. default:
  510. return UA_STATUSCODE_BADNOTSUPPORTED;
  511. }
  512. }
  513. UA_DataSetFieldResult
  514. UA_Server_addDataSetField(UA_Server *server, const UA_NodeId publishedDataSet,
  515. const UA_DataSetFieldConfig *fieldConfig,
  516. UA_NodeId *fieldIdentifier) {
  517. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  518. UA_DataSetFieldResult result = {UA_STATUSCODE_BADINVALIDARGUMENT, {0, 0}};
  519. if(!fieldConfig)
  520. return result;
  521. UA_PublishedDataSet *currentDataSet = UA_PublishedDataSet_findPDSbyId(server, publishedDataSet);
  522. if(currentDataSet == NULL){
  523. result.result = UA_STATUSCODE_BADNOTFOUND;
  524. return result;
  525. }
  526. if(currentDataSet->config.configurationFrozen){
  527. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  528. "Adding DataSetField failed. PublishedDataSet is frozen.");
  529. result.result = UA_STATUSCODE_BADCONFIGURATIONERROR;
  530. return result;
  531. }
  532. if(currentDataSet->config.publishedDataSetType != UA_PUBSUB_DATASET_PUBLISHEDITEMS){
  533. result.result = UA_STATUSCODE_BADNOTIMPLEMENTED;
  534. return result;
  535. }
  536. UA_DataSetField *newField = (UA_DataSetField *) UA_calloc(1, sizeof(UA_DataSetField));
  537. if(!newField){
  538. result.result = UA_STATUSCODE_BADINTERNALERROR;
  539. return result;
  540. }
  541. UA_DataSetFieldConfig tmpFieldConfig;
  542. retVal |= UA_DataSetFieldConfig_copy(fieldConfig, &tmpFieldConfig);
  543. newField->config = tmpFieldConfig;
  544. UA_PubSubManager_generateUniqueNodeId(server, &newField->identifier);
  545. if(fieldIdentifier != NULL){
  546. UA_NodeId_copy(&newField->identifier, fieldIdentifier);
  547. }
  548. newField->publishedDataSet = currentDataSet->identifier;
  549. //update major version of parent published data set
  550. currentDataSet->dataSetMetaData.configurationVersion.majorVersion = UA_PubSubConfigurationVersionTimeDifference();
  551. /* The order of DataSetFields should be the same in both creating and publishing.
  552. * So adding DataSetFields at the the end of the DataSets using TAILQ structure */
  553. if (currentDataSet->fieldSize != 0)
  554. TAILQ_INSERT_TAIL(&currentDataSet->fields, newField, listEntry);
  555. else
  556. TAILQ_INSERT_HEAD(&currentDataSet->fields, newField, listEntry);
  557. if(newField->config.field.variable.promotedField)
  558. currentDataSet->promotedFieldsCount++;
  559. currentDataSet->fieldSize++;
  560. //generate fieldMetadata within the DataSetMetaData
  561. currentDataSet->dataSetMetaData.fieldsSize++;
  562. UA_FieldMetaData *fieldMetaData = (UA_FieldMetaData *) UA_realloc(currentDataSet->dataSetMetaData.fields, currentDataSet->dataSetMetaData.fieldsSize *
  563. sizeof(UA_FieldMetaData));
  564. if(!fieldMetaData){
  565. result.result = UA_STATUSCODE_BADOUTOFMEMORY;
  566. return result;
  567. }
  568. currentDataSet->dataSetMetaData.fields = fieldMetaData;
  569. UA_FieldMetaData_init(&fieldMetaData[currentDataSet->fieldSize-1]);
  570. if(generateFieldMetaData(server, newField, &fieldMetaData[currentDataSet->fieldSize-1]) != UA_STATUSCODE_GOOD){
  571. UA_Server_removeDataSetField(server, newField->identifier);
  572. result.result = UA_STATUSCODE_BADINTERNALERROR;
  573. return result;
  574. }
  575. result.result = retVal;
  576. result.configurationVersion.majorVersion = currentDataSet->dataSetMetaData.configurationVersion.majorVersion;
  577. result.configurationVersion.minorVersion = currentDataSet->dataSetMetaData.configurationVersion.minorVersion;
  578. return result;
  579. }
  580. UA_DataSetFieldResult
  581. UA_Server_removeDataSetField(UA_Server *server, const UA_NodeId dsf) {
  582. UA_DataSetField *currentField = UA_DataSetField_findDSFbyId(server, dsf);
  583. UA_DataSetFieldResult result = {UA_STATUSCODE_BADNOTFOUND, {0, 0}};
  584. if(!currentField)
  585. return result;
  586. if(currentField->config.configurationFrozen){
  587. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  588. "Remove DataSetField failed. DataSetField is frozen.");
  589. result.result = UA_STATUSCODE_BADCONFIGURATIONERROR;
  590. return result;
  591. }
  592. UA_PublishedDataSet *parentPublishedDataSet =
  593. UA_PublishedDataSet_findPDSbyId(server, currentField->publishedDataSet);
  594. if(!parentPublishedDataSet)
  595. return result;
  596. if(parentPublishedDataSet->config.configurationFrozen){
  597. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  598. "Remove DataSetField failed. PublishedDataSet is frozen.");
  599. result.result = UA_STATUSCODE_BADCONFIGURATIONERROR;
  600. return result;
  601. }
  602. parentPublishedDataSet->fieldSize--;
  603. if(currentField->config.field.variable.promotedField)
  604. parentPublishedDataSet->promotedFieldsCount--;
  605. /* update major version of PublishedDataSet */
  606. parentPublishedDataSet->dataSetMetaData.configurationVersion.majorVersion =
  607. UA_PubSubConfigurationVersionTimeDifference();
  608. currentField->fieldMetaData.arrayDimensions = NULL;
  609. currentField->fieldMetaData.properties = NULL;
  610. currentField->fieldMetaData.name = UA_STRING_NULL;
  611. currentField->fieldMetaData.description.locale = UA_STRING_NULL;
  612. currentField->fieldMetaData.description.text = UA_STRING_NULL;
  613. UA_DataSetField_clear(currentField);
  614. TAILQ_REMOVE(&parentPublishedDataSet->fields, currentField, listEntry);
  615. UA_free(currentField);
  616. result.result = UA_STATUSCODE_GOOD;
  617. //regenerate DataSetMetaData
  618. parentPublishedDataSet->dataSetMetaData.fieldsSize--;
  619. if(parentPublishedDataSet->dataSetMetaData.fieldsSize > 0){
  620. for(size_t i = 0; i < parentPublishedDataSet->dataSetMetaData.fieldsSize+1; i++) {
  621. UA_FieldMetaData_clear(&parentPublishedDataSet->dataSetMetaData.fields[i]);
  622. }
  623. UA_free(parentPublishedDataSet->dataSetMetaData.fields);
  624. UA_FieldMetaData *fieldMetaData = (UA_FieldMetaData *) UA_calloc(parentPublishedDataSet->dataSetMetaData.fieldsSize,
  625. sizeof(UA_FieldMetaData));
  626. if(!fieldMetaData){
  627. result.result = UA_STATUSCODE_BADOUTOFMEMORY;
  628. return result;
  629. }
  630. UA_DataSetField *tmpDSF;
  631. size_t counter = 0;
  632. TAILQ_FOREACH(tmpDSF, &parentPublishedDataSet->fields, listEntry){
  633. UA_FieldMetaData tmpFieldMetaData;
  634. UA_FieldMetaData_init(&tmpFieldMetaData);
  635. if(generateFieldMetaData(server, tmpDSF, &tmpFieldMetaData) != UA_STATUSCODE_GOOD){
  636. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  637. "PubSub MetaData generation failed!");
  638. //TODO how to ensure consistency if the metadata regeneration fails
  639. result.result = UA_STATUSCODE_BADINTERNALERROR;
  640. }
  641. fieldMetaData[counter++] = tmpFieldMetaData;
  642. }
  643. parentPublishedDataSet->dataSetMetaData.fields = fieldMetaData;
  644. } else {
  645. UA_FieldMetaData_delete(parentPublishedDataSet->dataSetMetaData.fields);
  646. parentPublishedDataSet->dataSetMetaData.fields = NULL;
  647. }
  648. result.configurationVersion.majorVersion = parentPublishedDataSet->dataSetMetaData.configurationVersion.majorVersion;
  649. result.configurationVersion.minorVersion = parentPublishedDataSet->dataSetMetaData.configurationVersion.minorVersion;
  650. return result;
  651. }
  652. /**********************************************/
  653. /* DataSetWriter */
  654. /**********************************************/
  655. UA_StatusCode
  656. UA_DataSetWriterConfig_copy(const UA_DataSetWriterConfig *src,
  657. UA_DataSetWriterConfig *dst){
  658. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  659. memcpy(dst, src, sizeof(UA_DataSetWriterConfig));
  660. retVal |= UA_String_copy(&src->name, &dst->name);
  661. retVal |= UA_String_copy(&src->dataSetName, &dst->dataSetName);
  662. retVal |= UA_ExtensionObject_copy(&src->messageSettings, &dst->messageSettings);
  663. if (src->dataSetWriterPropertiesSize > 0) {
  664. dst->dataSetWriterProperties = (UA_KeyValuePair *)
  665. UA_calloc(src->dataSetWriterPropertiesSize, sizeof(UA_KeyValuePair));
  666. if(!dst->dataSetWriterProperties)
  667. return UA_STATUSCODE_BADOUTOFMEMORY;
  668. for(size_t i = 0; i < src->dataSetWriterPropertiesSize; i++){
  669. retVal |= UA_KeyValuePair_copy(&src->dataSetWriterProperties[i], &dst->dataSetWriterProperties[i]);
  670. }
  671. }
  672. return retVal;
  673. }
  674. UA_StatusCode
  675. UA_Server_getDataSetWriterConfig(UA_Server *server, const UA_NodeId dsw,
  676. UA_DataSetWriterConfig *config){
  677. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  678. if(!config)
  679. return UA_STATUSCODE_BADINVALIDARGUMENT;
  680. UA_DataSetWriter *currentDataSetWriter = UA_DataSetWriter_findDSWbyId(server, dsw);
  681. if(!currentDataSetWriter)
  682. return UA_STATUSCODE_BADNOTFOUND;
  683. UA_DataSetWriterConfig tmpWriterConfig;
  684. //deep copy of the actual config
  685. retVal |= UA_DataSetWriterConfig_copy(&currentDataSetWriter->config, &tmpWriterConfig);
  686. *config = tmpWriterConfig;
  687. return retVal;
  688. }
  689. UA_DataSetWriter *
  690. UA_DataSetWriter_findDSWbyId(UA_Server *server, UA_NodeId identifier) {
  691. for(size_t i = 0; i < server->pubSubManager.connectionsSize; i++){
  692. UA_WriterGroup *tmpWriterGroup;
  693. LIST_FOREACH(tmpWriterGroup, &server->pubSubManager.connections[i].writerGroups, listEntry){
  694. UA_DataSetWriter *tmpWriter;
  695. LIST_FOREACH(tmpWriter, &tmpWriterGroup->writers, listEntry){
  696. if(UA_NodeId_equal(&tmpWriter->identifier, &identifier)){
  697. return tmpWriter;
  698. }
  699. }
  700. }
  701. }
  702. return NULL;
  703. }
  704. void
  705. UA_DataSetWriterConfig_clear(UA_DataSetWriterConfig *pdsConfig) {
  706. UA_String_clear(&pdsConfig->name);
  707. UA_String_clear(&pdsConfig->dataSetName);
  708. for(size_t i = 0; i < pdsConfig->dataSetWriterPropertiesSize; i++){
  709. UA_KeyValuePair_clear(&pdsConfig->dataSetWriterProperties[i]);
  710. }
  711. UA_free(pdsConfig->dataSetWriterProperties);
  712. UA_ExtensionObject_clear(&pdsConfig->messageSettings);
  713. }
  714. static void
  715. UA_DataSetWriter_clear(UA_Server *server, UA_DataSetWriter *dataSetWriter) {
  716. UA_DataSetWriterConfig_clear(&dataSetWriter->config);
  717. //delete DataSetWriter
  718. UA_NodeId_clear(&dataSetWriter->identifier);
  719. UA_NodeId_clear(&dataSetWriter->linkedWriterGroup);
  720. UA_NodeId_clear(&dataSetWriter->connectedDataSet);
  721. #ifdef UA_ENABLE_PUBSUB_DELTAFRAMES
  722. //delete lastSamples store
  723. for(size_t i = 0; i < dataSetWriter->lastSamplesCount; i++) {
  724. UA_DataValue_clear(&dataSetWriter->lastSamples[i].value);
  725. }
  726. UA_free(dataSetWriter->lastSamples);
  727. dataSetWriter->lastSamples = NULL;
  728. dataSetWriter->lastSamplesCount = 0;
  729. #endif
  730. }
  731. //state machine methods not part of the open62541 state machine API
  732. UA_StatusCode
  733. UA_DataSetWriter_setPubSubState(UA_Server *server, UA_PubSubState state, UA_DataSetWriter *dataSetWriter){
  734. switch(state){
  735. case UA_PUBSUBSTATE_DISABLED:
  736. switch (dataSetWriter->state){
  737. case UA_PUBSUBSTATE_DISABLED:
  738. return UA_STATUSCODE_GOOD;
  739. case UA_PUBSUBSTATE_PAUSED:
  740. dataSetWriter->state = UA_PUBSUBSTATE_DISABLED;
  741. //no further action is required
  742. break;
  743. case UA_PUBSUBSTATE_OPERATIONAL:
  744. dataSetWriter->state = UA_PUBSUBSTATE_DISABLED;
  745. break;
  746. case UA_PUBSUBSTATE_ERROR:
  747. break;
  748. default:
  749. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  750. "Received unknown PubSub state!");
  751. }
  752. break;
  753. case UA_PUBSUBSTATE_PAUSED:
  754. switch (dataSetWriter->state){
  755. case UA_PUBSUBSTATE_DISABLED:
  756. break;
  757. case UA_PUBSUBSTATE_PAUSED:
  758. return UA_STATUSCODE_GOOD;
  759. case UA_PUBSUBSTATE_OPERATIONAL:
  760. break;
  761. case UA_PUBSUBSTATE_ERROR:
  762. break;
  763. default:
  764. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  765. "Received unknown PubSub state!");
  766. }
  767. break;
  768. case UA_PUBSUBSTATE_OPERATIONAL:
  769. switch (dataSetWriter->state){
  770. case UA_PUBSUBSTATE_DISABLED:
  771. dataSetWriter->state = UA_PUBSUBSTATE_OPERATIONAL;
  772. break;
  773. case UA_PUBSUBSTATE_PAUSED:
  774. break;
  775. case UA_PUBSUBSTATE_OPERATIONAL:
  776. return UA_STATUSCODE_GOOD;
  777. case UA_PUBSUBSTATE_ERROR:
  778. break;
  779. default:
  780. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  781. "Received unknown PubSub state!");
  782. }
  783. break;
  784. case UA_PUBSUBSTATE_ERROR:
  785. switch (dataSetWriter->state){
  786. case UA_PUBSUBSTATE_DISABLED:
  787. break;
  788. case UA_PUBSUBSTATE_PAUSED:
  789. break;
  790. case UA_PUBSUBSTATE_OPERATIONAL:
  791. break;
  792. case UA_PUBSUBSTATE_ERROR:
  793. return UA_STATUSCODE_GOOD;
  794. default:
  795. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  796. "Received unknown PubSub state!");
  797. }
  798. break;
  799. default:
  800. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  801. "Received unknown PubSub state!");
  802. }
  803. return UA_STATUSCODE_GOOD;
  804. }
  805. /**********************************************/
  806. /* WriterGroup */
  807. /**********************************************/
  808. UA_StatusCode
  809. UA_WriterGroupConfig_copy(const UA_WriterGroupConfig *src,
  810. UA_WriterGroupConfig *dst){
  811. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  812. memcpy(dst, src, sizeof(UA_WriterGroupConfig));
  813. retVal |= UA_String_copy(&src->name, &dst->name);
  814. retVal |= UA_ExtensionObject_copy(&src->transportSettings, &dst->transportSettings);
  815. retVal |= UA_ExtensionObject_copy(&src->messageSettings, &dst->messageSettings);
  816. if (src->groupPropertiesSize > 0) {
  817. dst->groupProperties = (UA_KeyValuePair *) UA_calloc(src->groupPropertiesSize, sizeof(UA_KeyValuePair));
  818. if(!dst->groupProperties)
  819. return UA_STATUSCODE_BADOUTOFMEMORY;
  820. for(size_t i = 0; i < src->groupPropertiesSize; i++){
  821. retVal |= UA_KeyValuePair_copy(&src->groupProperties[i], &dst->groupProperties[i]);
  822. }
  823. }
  824. return retVal;
  825. }
  826. UA_StatusCode
  827. UA_Server_getWriterGroupConfig(UA_Server *server, const UA_NodeId writerGroup,
  828. UA_WriterGroupConfig *config){
  829. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  830. if(!config)
  831. return UA_STATUSCODE_BADINVALIDARGUMENT;
  832. UA_WriterGroup *currentWriterGroup = UA_WriterGroup_findWGbyId(server, writerGroup);
  833. if(!currentWriterGroup){
  834. return UA_STATUSCODE_BADNOTFOUND;
  835. }
  836. UA_WriterGroupConfig tmpWriterGroupConfig;
  837. //deep copy of the actual config
  838. retVal |= UA_WriterGroupConfig_copy(&currentWriterGroup->config, &tmpWriterGroupConfig);
  839. *config = tmpWriterGroupConfig;
  840. return retVal;
  841. }
  842. UA_StatusCode
  843. UA_Server_updateWriterGroupConfig(UA_Server *server, UA_NodeId writerGroupIdentifier,
  844. const UA_WriterGroupConfig *config){
  845. if(!config)
  846. return UA_STATUSCODE_BADINVALIDARGUMENT;
  847. UA_WriterGroup *currentWriterGroup = UA_WriterGroup_findWGbyId(server, writerGroupIdentifier);
  848. if(!currentWriterGroup)
  849. return UA_STATUSCODE_BADNOTFOUND;
  850. if(currentWriterGroup->config.configurationFrozen){
  851. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  852. "Modify WriterGroup failed. WriterGroup is frozen.");
  853. return UA_STATUSCODE_BADCONFIGURATIONERROR;
  854. }
  855. //The update functionality will be extended during the next PubSub batches.
  856. //Currently is only a change of the publishing interval possible.
  857. if(currentWriterGroup->config.maxEncapsulatedDataSetMessageCount != config->maxEncapsulatedDataSetMessageCount){
  858. currentWriterGroup->config.maxEncapsulatedDataSetMessageCount = config->maxEncapsulatedDataSetMessageCount;
  859. if(currentWriterGroup->config.messageSettings.encoding == UA_EXTENSIONOBJECT_ENCODED_NOBODY) {
  860. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  861. "MaxEncapsulatedDataSetMessag need enabled 'PayloadHeader' within the message settings.");
  862. }
  863. }
  864. if(currentWriterGroup->config.publishingInterval != config->publishingInterval) {
  865. if(currentWriterGroup->config.rtLevel == UA_PUBSUB_RT_NONE && currentWriterGroup->state == UA_PUBSUBSTATE_OPERATIONAL){
  866. UA_PubSubManager_removeRepeatedPubSubCallback(server, currentWriterGroup->publishCallbackId);
  867. currentWriterGroup->config.publishingInterval = config->publishingInterval;
  868. UA_WriterGroup_addPublishCallback(server, currentWriterGroup);
  869. } else {
  870. currentWriterGroup->config.publishingInterval = config->publishingInterval;
  871. }
  872. }
  873. if(currentWriterGroup->config.priority != config->priority) {
  874. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  875. "No or unsupported WriterGroup update.");
  876. }
  877. return UA_STATUSCODE_GOOD;
  878. }
  879. UA_WriterGroup *
  880. UA_WriterGroup_findWGbyId(UA_Server *server, UA_NodeId identifier){
  881. for(size_t i = 0; i < server->pubSubManager.connectionsSize; i++){
  882. UA_WriterGroup *tmpWriterGroup;
  883. LIST_FOREACH(tmpWriterGroup, &server->pubSubManager.connections[i].writerGroups, listEntry) {
  884. if(UA_NodeId_equal(&identifier, &tmpWriterGroup->identifier)){
  885. return tmpWriterGroup;
  886. }
  887. }
  888. }
  889. return NULL;
  890. }
  891. void
  892. UA_WriterGroupConfig_clear(UA_WriterGroupConfig *writerGroupConfig){
  893. //delete writerGroup config
  894. UA_String_clear(&writerGroupConfig->name);
  895. UA_ExtensionObject_clear(&writerGroupConfig->transportSettings);
  896. UA_ExtensionObject_clear(&writerGroupConfig->messageSettings);
  897. for(size_t i = 0; i < writerGroupConfig->groupPropertiesSize; i++){
  898. UA_KeyValuePair_clear(&writerGroupConfig->groupProperties[i]);
  899. }
  900. UA_free(writerGroupConfig->groupProperties);
  901. }
  902. static void
  903. UA_WriterGroup_clear(UA_Server *server, UA_WriterGroup *writerGroup) {
  904. UA_WriterGroupConfig_clear(&writerGroup->config);
  905. //delete WriterGroup
  906. //delete all writers. Therefore removeDataSetWriter is called from PublishedDataSet
  907. UA_DataSetWriter *dataSetWriter, *tmpDataSetWriter;
  908. LIST_FOREACH_SAFE(dataSetWriter, &writerGroup->writers, listEntry, tmpDataSetWriter){
  909. UA_Server_removeDataSetWriter(server, dataSetWriter->identifier);
  910. }
  911. UA_NodeId_clear(&writerGroup->linkedConnection);
  912. UA_NodeId_clear(&writerGroup->identifier);
  913. }
  914. UA_StatusCode
  915. UA_WriterGroup_setPubSubState(UA_Server *server, UA_PubSubState state, UA_WriterGroup *writerGroup){
  916. UA_DataSetWriter *dataSetWriter;
  917. switch(state){
  918. case UA_PUBSUBSTATE_DISABLED:
  919. switch (writerGroup->state){
  920. case UA_PUBSUBSTATE_DISABLED:
  921. return UA_STATUSCODE_GOOD;
  922. case UA_PUBSUBSTATE_PAUSED:
  923. break;
  924. case UA_PUBSUBSTATE_OPERATIONAL:
  925. UA_PubSubManager_removeRepeatedPubSubCallback(server, writerGroup->publishCallbackId);
  926. LIST_FOREACH(dataSetWriter, &writerGroup->writers, listEntry){
  927. UA_DataSetWriter_setPubSubState(server, UA_PUBSUBSTATE_DISABLED, dataSetWriter);
  928. }
  929. writerGroup->state = UA_PUBSUBSTATE_DISABLED;
  930. break;
  931. case UA_PUBSUBSTATE_ERROR:
  932. break;
  933. default:
  934. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  935. "Received unknown PubSub state!");
  936. }
  937. break;
  938. case UA_PUBSUBSTATE_PAUSED:
  939. switch (writerGroup->state){
  940. case UA_PUBSUBSTATE_DISABLED:
  941. break;
  942. case UA_PUBSUBSTATE_PAUSED:
  943. return UA_STATUSCODE_GOOD;
  944. case UA_PUBSUBSTATE_OPERATIONAL:
  945. break;
  946. case UA_PUBSUBSTATE_ERROR:
  947. break;
  948. default:
  949. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  950. "Received unknown PubSub state!");
  951. }
  952. break;
  953. case UA_PUBSUBSTATE_OPERATIONAL:
  954. switch (writerGroup->state){
  955. case UA_PUBSUBSTATE_DISABLED:
  956. writerGroup->state = UA_PUBSUBSTATE_OPERATIONAL;
  957. UA_PubSubManager_removeRepeatedPubSubCallback(server, writerGroup->publishCallbackId);
  958. LIST_FOREACH(dataSetWriter, &writerGroup->writers, listEntry){
  959. UA_DataSetWriter_setPubSubState(server, UA_PUBSUBSTATE_OPERATIONAL, dataSetWriter);
  960. }
  961. UA_WriterGroup_addPublishCallback(server, writerGroup);
  962. break;
  963. case UA_PUBSUBSTATE_PAUSED:
  964. break;
  965. case UA_PUBSUBSTATE_OPERATIONAL:
  966. return UA_STATUSCODE_GOOD;
  967. case UA_PUBSUBSTATE_ERROR:
  968. break;
  969. default:
  970. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  971. "Received unknown PubSub state!");
  972. }
  973. break;
  974. case UA_PUBSUBSTATE_ERROR:
  975. switch (writerGroup->state){
  976. case UA_PUBSUBSTATE_DISABLED:
  977. break;
  978. case UA_PUBSUBSTATE_PAUSED:
  979. break;
  980. case UA_PUBSUBSTATE_OPERATIONAL:
  981. break;
  982. case UA_PUBSUBSTATE_ERROR:
  983. return UA_STATUSCODE_GOOD;
  984. default:
  985. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  986. "Received unknown PubSub state!");
  987. }
  988. break;
  989. default:
  990. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  991. "Received unknown PubSub state!");
  992. }
  993. return UA_STATUSCODE_GOOD;
  994. }
  995. UA_StatusCode
  996. UA_Server_addDataSetWriter(UA_Server *server,
  997. const UA_NodeId writerGroup, const UA_NodeId dataSet,
  998. const UA_DataSetWriterConfig *dataSetWriterConfig,
  999. UA_NodeId *writerIdentifier) {
  1000. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  1001. if(!dataSetWriterConfig)
  1002. return UA_STATUSCODE_BADINVALIDARGUMENT;
  1003. UA_PublishedDataSet *currentDataSetContext = UA_PublishedDataSet_findPDSbyId(server, dataSet);
  1004. if(!currentDataSetContext)
  1005. return UA_STATUSCODE_BADNOTFOUND;
  1006. if(currentDataSetContext->config.configurationFrozen){
  1007. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  1008. "Adding DataSetWriter failed. PublishedDataSet is frozen.");
  1009. return UA_STATUSCODE_BADCONFIGURATIONERROR;
  1010. }
  1011. UA_WriterGroup *wg = UA_WriterGroup_findWGbyId(server, writerGroup);
  1012. if(!wg)
  1013. return UA_STATUSCODE_BADNOTFOUND;
  1014. if(wg->config.configurationFrozen){
  1015. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  1016. "Adding DataSetWriter failed. WriterGroup is frozen.");
  1017. return UA_STATUSCODE_BADCONFIGURATIONERROR;
  1018. }
  1019. UA_DataSetWriter *newDataSetWriter = (UA_DataSetWriter *) UA_calloc(1, sizeof(UA_DataSetWriter));
  1020. if(!newDataSetWriter)
  1021. return UA_STATUSCODE_BADOUTOFMEMORY;
  1022. //copy the config into the new dataSetWriter
  1023. UA_DataSetWriterConfig tmpDataSetWriterConfig;
  1024. retVal |= UA_DataSetWriterConfig_copy(dataSetWriterConfig, &tmpDataSetWriterConfig);
  1025. newDataSetWriter->config = tmpDataSetWriterConfig;
  1026. //save the current version of the connected PublishedDataSet
  1027. newDataSetWriter->connectedDataSetVersion = currentDataSetContext->dataSetMetaData.configurationVersion;
  1028. #ifdef UA_ENABLE_PUBSUB_DELTAFRAMES
  1029. //initialize the queue for the last values
  1030. if (currentDataSetContext->fieldSize > 0) {
  1031. newDataSetWriter->lastSamples = (UA_DataSetWriterSample * )
  1032. UA_calloc(currentDataSetContext->fieldSize, sizeof(UA_DataSetWriterSample));
  1033. if(!newDataSetWriter->lastSamples) {
  1034. UA_DataSetWriterConfig_clear(&newDataSetWriter->config);
  1035. UA_free(newDataSetWriter);
  1036. return UA_STATUSCODE_BADOUTOFMEMORY;
  1037. }
  1038. newDataSetWriter->lastSamplesCount = currentDataSetContext->fieldSize;
  1039. }
  1040. #endif
  1041. //connect PublishedDataSet with DataSetWriter
  1042. newDataSetWriter->connectedDataSet = currentDataSetContext->identifier;
  1043. newDataSetWriter->linkedWriterGroup = wg->identifier;
  1044. UA_PubSubManager_generateUniqueNodeId(server, &newDataSetWriter->identifier);
  1045. if(writerIdentifier != NULL)
  1046. UA_NodeId_copy(&newDataSetWriter->identifier, writerIdentifier);
  1047. //add the new writer to the group
  1048. LIST_INSERT_HEAD(&wg->writers, newDataSetWriter, listEntry);
  1049. wg->writersCount++;
  1050. #ifdef UA_ENABLE_PUBSUB_INFORMATIONMODEL
  1051. addDataSetWriterRepresentation(server, newDataSetWriter);
  1052. #endif
  1053. return retVal;
  1054. }
  1055. UA_StatusCode
  1056. UA_Server_removeDataSetWriter(UA_Server *server, const UA_NodeId dsw){
  1057. UA_DataSetWriter *dataSetWriter = UA_DataSetWriter_findDSWbyId(server, dsw);
  1058. if(!dataSetWriter)
  1059. return UA_STATUSCODE_BADNOTFOUND;
  1060. if(dataSetWriter->config.configurationFrozen){
  1061. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  1062. "Remove DataSetWriter failed. DataSetWriter is frozen.");
  1063. return UA_STATUSCODE_BADCONFIGURATIONERROR;
  1064. }
  1065. UA_WriterGroup *linkedWriterGroup = UA_WriterGroup_findWGbyId(server, dataSetWriter->linkedWriterGroup);
  1066. if(!linkedWriterGroup)
  1067. return UA_STATUSCODE_BADNOTFOUND;
  1068. if(linkedWriterGroup->config.configurationFrozen){
  1069. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  1070. "Remove DataSetWriter failed. WriterGroup is frozen.");
  1071. return UA_STATUSCODE_BADCONFIGURATIONERROR;
  1072. }
  1073. UA_PublishedDataSet *publishedDataSet = UA_PublishedDataSet_findPDSbyId(server, dataSetWriter->connectedDataSet);
  1074. if(!publishedDataSet)
  1075. return UA_STATUSCODE_BADNOTFOUND;
  1076. linkedWriterGroup->writersCount--;
  1077. #ifdef UA_ENABLE_PUBSUB_INFORMATIONMODEL
  1078. removeDataSetWriterRepresentation(server, dataSetWriter);
  1079. #endif
  1080. //remove DataSetWriter from group
  1081. UA_DataSetWriter_clear(server, dataSetWriter);
  1082. LIST_REMOVE(dataSetWriter, listEntry);
  1083. UA_free(dataSetWriter);
  1084. return UA_STATUSCODE_GOOD;
  1085. }
  1086. /**********************************************/
  1087. /* DataSetField */
  1088. /**********************************************/
  1089. UA_StatusCode
  1090. UA_DataSetFieldConfig_copy(const UA_DataSetFieldConfig *src, UA_DataSetFieldConfig *dst){
  1091. memcpy(dst, src, sizeof(UA_DataSetFieldConfig));
  1092. if(src->dataSetFieldType == UA_PUBSUB_DATASETFIELD_VARIABLE) {
  1093. UA_String_copy(&src->field.variable.fieldNameAlias, &dst->field.variable.fieldNameAlias);
  1094. UA_PublishedVariableDataType_copy(&src->field.variable.publishParameters,
  1095. &dst->field.variable.publishParameters);
  1096. } else {
  1097. return UA_STATUSCODE_BADNOTSUPPORTED;
  1098. }
  1099. return UA_STATUSCODE_GOOD;
  1100. }
  1101. UA_StatusCode
  1102. UA_Server_getDataSetFieldConfig(UA_Server *server, const UA_NodeId dsf,
  1103. UA_DataSetFieldConfig *config) {
  1104. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  1105. if(!config)
  1106. return UA_STATUSCODE_BADINVALIDARGUMENT;
  1107. UA_DataSetField *currentDataSetField = UA_DataSetField_findDSFbyId(server, dsf);
  1108. if(!currentDataSetField)
  1109. return UA_STATUSCODE_BADNOTFOUND;
  1110. UA_DataSetFieldConfig tmpFieldConfig;
  1111. //deep copy of the actual config
  1112. retVal |= UA_DataSetFieldConfig_copy(&currentDataSetField->config, &tmpFieldConfig);
  1113. *config = tmpFieldConfig;
  1114. return retVal;
  1115. }
  1116. UA_DataSetField *
  1117. UA_DataSetField_findDSFbyId(UA_Server *server, UA_NodeId identifier) {
  1118. for(size_t i = 0; i < server->pubSubManager.publishedDataSetsSize; i++){
  1119. UA_DataSetField *tmpField;
  1120. TAILQ_FOREACH(tmpField, &server->pubSubManager.publishedDataSets[i].fields, listEntry){
  1121. if(UA_NodeId_equal(&tmpField->identifier, &identifier)){
  1122. return tmpField;
  1123. }
  1124. }
  1125. }
  1126. return NULL;
  1127. }
  1128. void
  1129. UA_DataSetFieldConfig_clear(UA_DataSetFieldConfig *dataSetFieldConfig){
  1130. if(dataSetFieldConfig->dataSetFieldType == UA_PUBSUB_DATASETFIELD_VARIABLE){
  1131. UA_String_clear(&dataSetFieldConfig->field.variable.fieldNameAlias);
  1132. UA_PublishedVariableDataType_clear(&dataSetFieldConfig->field.variable.publishParameters);
  1133. }
  1134. }
  1135. static void
  1136. UA_DataSetField_clear(UA_DataSetField *field) {
  1137. UA_DataSetFieldConfig_clear(&field->config);
  1138. //delete DataSetField
  1139. UA_NodeId_clear(&field->identifier);
  1140. UA_NodeId_clear(&field->publishedDataSet);
  1141. UA_FieldMetaData_clear(&field->fieldMetaData);
  1142. }
  1143. /*********************************************************/
  1144. /* PublishValues handling */
  1145. /*********************************************************/
  1146. /**
  1147. * Compare two variants. Internally used for value change detection.
  1148. *
  1149. * @return true if the value has changed
  1150. */
  1151. #ifdef UA_ENABLE_PUBSUB_DELTAFRAMES
  1152. static UA_Boolean
  1153. valueChangedVariant(UA_Variant *oldValue, UA_Variant *newValue){
  1154. if(! (oldValue && newValue))
  1155. return false;
  1156. UA_ByteString *oldValueEncoding = UA_ByteString_new(), *newValueEncoding = UA_ByteString_new();
  1157. size_t oldValueEncodingSize, newValueEncodingSize;
  1158. oldValueEncodingSize = UA_calcSizeBinary(oldValue, &UA_TYPES[UA_TYPES_VARIANT]);
  1159. newValueEncodingSize = UA_calcSizeBinary(newValue, &UA_TYPES[UA_TYPES_VARIANT]);
  1160. if((oldValueEncodingSize == 0) || (newValueEncodingSize == 0))
  1161. return false;
  1162. if(oldValueEncodingSize != newValueEncodingSize)
  1163. return true;
  1164. if(UA_ByteString_allocBuffer(oldValueEncoding, oldValueEncodingSize) != UA_STATUSCODE_GOOD)
  1165. return false;
  1166. if(UA_ByteString_allocBuffer(newValueEncoding, newValueEncodingSize) != UA_STATUSCODE_GOOD)
  1167. return false;
  1168. UA_Byte *bufPosOldValue = oldValueEncoding->data;
  1169. const UA_Byte *bufEndOldValue = &oldValueEncoding->data[oldValueEncoding->length];
  1170. UA_Byte *bufPosNewValue = newValueEncoding->data;
  1171. const UA_Byte *bufEndNewValue = &newValueEncoding->data[newValueEncoding->length];
  1172. if(UA_encodeBinary(oldValue, &UA_TYPES[UA_TYPES_VARIANT],
  1173. &bufPosOldValue, &bufEndOldValue, NULL, NULL) != UA_STATUSCODE_GOOD){
  1174. return false;
  1175. }
  1176. if(UA_encodeBinary(newValue, &UA_TYPES[UA_TYPES_VARIANT],
  1177. &bufPosNewValue, &bufEndNewValue, NULL, NULL) != UA_STATUSCODE_GOOD){
  1178. return false;
  1179. }
  1180. oldValueEncoding->length = (uintptr_t)bufPosOldValue - (uintptr_t)oldValueEncoding->data;
  1181. newValueEncoding->length = (uintptr_t)bufPosNewValue - (uintptr_t)newValueEncoding->data;
  1182. UA_Boolean compareResult = !UA_ByteString_equal(oldValueEncoding, newValueEncoding);
  1183. UA_ByteString_delete(oldValueEncoding);
  1184. UA_ByteString_delete(newValueEncoding);
  1185. return compareResult;
  1186. }
  1187. #endif
  1188. /**
  1189. * Obtain the latest value for a specific DataSetField. This method is currently
  1190. * called inside the DataSetMessage generation process.
  1191. */
  1192. static void
  1193. UA_PubSubDataSetField_sampleValue(UA_Server *server, UA_DataSetField *field,
  1194. UA_DataValue *value) {
  1195. /* Read the value */
  1196. if(field->config.field.variable.staticValueSourceEnabled == UA_FALSE){
  1197. UA_ReadValueId rvid;
  1198. UA_ReadValueId_init(&rvid);
  1199. rvid.nodeId = field->config.field.variable.publishParameters.publishedVariable;
  1200. rvid.attributeId = field->config.field.variable.publishParameters.attributeId;
  1201. rvid.indexRange = field->config.field.variable.publishParameters.indexRange;
  1202. *value = UA_Server_read(server, &rvid, UA_TIMESTAMPSTORETURN_BOTH);
  1203. } else {
  1204. value->value.storageType = UA_VARIANT_DATA_NODELETE;
  1205. *value = field->config.field.variable.staticValueSource;
  1206. }
  1207. }
  1208. static UA_StatusCode
  1209. UA_PubSubDataSetWriter_generateKeyFrameMessage(UA_Server *server, UA_DataSetMessage *dataSetMessage,
  1210. UA_DataSetWriter *dataSetWriter) {
  1211. UA_PublishedDataSet *currentDataSet =
  1212. UA_PublishedDataSet_findPDSbyId(server, dataSetWriter->connectedDataSet);
  1213. if(!currentDataSet)
  1214. return UA_STATUSCODE_BADNOTFOUND;
  1215. /* Prepare DataSetMessageContent */
  1216. dataSetMessage->header.dataSetMessageValid = true;
  1217. dataSetMessage->header.dataSetMessageType = UA_DATASETMESSAGE_DATAKEYFRAME;
  1218. dataSetMessage->data.keyFrameData.fieldCount = currentDataSet->fieldSize;
  1219. dataSetMessage->data.keyFrameData.dataSetFields = (UA_DataValue *)
  1220. UA_Array_new(currentDataSet->fieldSize, &UA_TYPES[UA_TYPES_DATAVALUE]);
  1221. if(!dataSetMessage->data.keyFrameData.dataSetFields)
  1222. return UA_STATUSCODE_BADOUTOFMEMORY;
  1223. #ifdef UA_ENABLE_JSON_ENCODING
  1224. /* json: insert fieldnames used as json keys */
  1225. dataSetMessage->data.keyFrameData.fieldNames =
  1226. (UA_String *)UA_Array_new(currentDataSet->fieldSize, &UA_TYPES[UA_TYPES_STRING]);
  1227. if(!dataSetMessage->data.keyFrameData.fieldNames)
  1228. return UA_STATUSCODE_BADOUTOFMEMORY;
  1229. #endif
  1230. /* Loop over the fields */
  1231. size_t counter = 0;
  1232. UA_DataSetField *dsf;
  1233. TAILQ_FOREACH(dsf, &currentDataSet->fields, listEntry) {
  1234. #ifdef UA_ENABLE_JSON_ENCODING
  1235. /* json: store the fieldNameAlias*/
  1236. UA_String_copy(&dsf->config.field.variable.fieldNameAlias,
  1237. &dataSetMessage->data.keyFrameData.fieldNames[counter]);
  1238. #endif
  1239. /* Sample the value */
  1240. UA_DataValue *dfv = &dataSetMessage->data.keyFrameData.dataSetFields[counter];
  1241. UA_PubSubDataSetField_sampleValue(server, dsf, dfv);
  1242. /* Deactivate statuscode? */
  1243. if(((u64)dataSetWriter->config.dataSetFieldContentMask & (u64)UA_DATASETFIELDCONTENTMASK_STATUSCODE) == 0)
  1244. dfv->hasStatus = false;
  1245. /* Deactivate timestamps */
  1246. if(((u64)dataSetWriter->config.dataSetFieldContentMask &
  1247. (u64)UA_DATASETFIELDCONTENTMASK_SOURCETIMESTAMP) == 0)
  1248. dfv->hasSourceTimestamp = false;
  1249. if(((u64)dataSetWriter->config.dataSetFieldContentMask &
  1250. (u64)UA_DATASETFIELDCONTENTMASK_SOURCEPICOSECONDS) == 0)
  1251. dfv->hasSourcePicoseconds = false;
  1252. if(((u64)dataSetWriter->config.dataSetFieldContentMask &
  1253. (u64)UA_DATASETFIELDCONTENTMASK_SERVERTIMESTAMP) == 0)
  1254. dfv->hasServerTimestamp = false;
  1255. if(((u64)dataSetWriter->config.dataSetFieldContentMask &
  1256. (u64)UA_DATASETFIELDCONTENTMASK_SERVERPICOSECONDS) == 0)
  1257. dfv->hasServerPicoseconds = false;
  1258. #ifdef UA_ENABLE_PUBSUB_DELTAFRAMES
  1259. /* Update lastValue store */
  1260. UA_DataValue_clear(&dataSetWriter->lastSamples[counter].value);
  1261. UA_DataValue_copy(dfv, &dataSetWriter->lastSamples[counter].value);
  1262. #endif
  1263. counter++;
  1264. }
  1265. return UA_STATUSCODE_GOOD;
  1266. }
  1267. #ifdef UA_ENABLE_PUBSUB_DELTAFRAMES
  1268. static UA_StatusCode
  1269. UA_PubSubDataSetWriter_generateDeltaFrameMessage(UA_Server *server,
  1270. UA_DataSetMessage *dataSetMessage,
  1271. UA_DataSetWriter *dataSetWriter) {
  1272. UA_PublishedDataSet *currentDataSet =
  1273. UA_PublishedDataSet_findPDSbyId(server, dataSetWriter->connectedDataSet);
  1274. if(!currentDataSet)
  1275. return UA_STATUSCODE_BADNOTFOUND;
  1276. /* Prepare DataSetMessageContent */
  1277. memset(dataSetMessage, 0, sizeof(UA_DataSetMessage));
  1278. dataSetMessage->header.dataSetMessageValid = true;
  1279. dataSetMessage->header.dataSetMessageType = UA_DATASETMESSAGE_DATADELTAFRAME;
  1280. if (currentDataSet->fieldSize == 0) {
  1281. return UA_STATUSCODE_GOOD;
  1282. }
  1283. UA_DataSetField *dsf;
  1284. size_t counter = 0;
  1285. TAILQ_FOREACH(dsf, &currentDataSet->fields, listEntry) {
  1286. /* Sample the value */
  1287. UA_DataValue value;
  1288. UA_DataValue_init(&value);
  1289. UA_PubSubDataSetField_sampleValue(server, dsf, &value);
  1290. /* Check if the value has changed */
  1291. if(valueChangedVariant(&dataSetWriter->lastSamples[counter].value.value, &value.value)) {
  1292. /* increase fieldCount for current delta message */
  1293. dataSetMessage->data.deltaFrameData.fieldCount++;
  1294. dataSetWriter->lastSamples[counter].valueChanged = true;
  1295. /* Update last stored sample */
  1296. UA_DataValue_clear(&dataSetWriter->lastSamples[counter].value);
  1297. dataSetWriter->lastSamples[counter].value = value;
  1298. } else {
  1299. UA_DataValue_clear(&value);
  1300. dataSetWriter->lastSamples[counter].valueChanged = false;
  1301. }
  1302. counter++;
  1303. }
  1304. /* Allocate DeltaFrameFields */
  1305. UA_DataSetMessage_DeltaFrameField *deltaFields = (UA_DataSetMessage_DeltaFrameField *)
  1306. UA_calloc(dataSetMessage->data.deltaFrameData.fieldCount, sizeof(UA_DataSetMessage_DeltaFrameField));
  1307. if(!deltaFields)
  1308. return UA_STATUSCODE_BADOUTOFMEMORY;
  1309. dataSetMessage->data.deltaFrameData.deltaFrameFields = deltaFields;
  1310. size_t currentDeltaField = 0;
  1311. for(size_t i = 0; i < currentDataSet->fieldSize; i++) {
  1312. if(!dataSetWriter->lastSamples[i].valueChanged)
  1313. continue;
  1314. UA_DataSetMessage_DeltaFrameField *dff = &deltaFields[currentDeltaField];
  1315. dff->fieldIndex = (UA_UInt16) i;
  1316. UA_DataValue_copy(&dataSetWriter->lastSamples[i].value, &dff->fieldValue);
  1317. dataSetWriter->lastSamples[i].valueChanged = false;
  1318. /* Deactivate statuscode? */
  1319. if(((u64)dataSetWriter->config.dataSetFieldContentMask & (u64)UA_DATASETFIELDCONTENTMASK_STATUSCODE) == 0)
  1320. dff->fieldValue.hasStatus = false;
  1321. /* Deactivate timestamps? */
  1322. if(((u64)dataSetWriter->config.dataSetFieldContentMask & (u64)UA_DATASETFIELDCONTENTMASK_SOURCETIMESTAMP) == 0)
  1323. dff->fieldValue.hasSourceTimestamp = false;
  1324. if(((u64)dataSetWriter->config.dataSetFieldContentMask & (u64)UA_DATASETFIELDCONTENTMASK_SOURCEPICOSECONDS) == 0)
  1325. dff->fieldValue.hasServerPicoseconds = false;
  1326. if(((u64)dataSetWriter->config.dataSetFieldContentMask & (u64)UA_DATASETFIELDCONTENTMASK_SERVERTIMESTAMP) == 0)
  1327. dff->fieldValue.hasServerTimestamp = false;
  1328. if(((u64)dataSetWriter->config.dataSetFieldContentMask & (u64)UA_DATASETFIELDCONTENTMASK_SERVERPICOSECONDS) == 0)
  1329. dff->fieldValue.hasServerPicoseconds = false;
  1330. currentDeltaField++;
  1331. }
  1332. return UA_STATUSCODE_GOOD;
  1333. }
  1334. #endif
  1335. /**
  1336. * Generate a DataSetMessage for the given writer.
  1337. *
  1338. * @param dataSetWriter ptr to corresponding writer
  1339. * @return ptr to generated DataSetMessage
  1340. */
  1341. static UA_StatusCode
  1342. UA_DataSetWriter_generateDataSetMessage(UA_Server *server, UA_DataSetMessage *dataSetMessage,
  1343. UA_DataSetWriter *dataSetWriter) {
  1344. UA_PublishedDataSet *currentDataSet =
  1345. UA_PublishedDataSet_findPDSbyId(server, dataSetWriter->connectedDataSet);
  1346. if(!currentDataSet)
  1347. return UA_STATUSCODE_BADNOTFOUND;
  1348. /* Reset the message */
  1349. memset(dataSetMessage, 0, sizeof(UA_DataSetMessage));
  1350. /* store messageType to switch between json or uadp (default) */
  1351. UA_UInt16 messageType = UA_TYPES_UADPDATASETWRITERMESSAGEDATATYPE;
  1352. UA_JsonDataSetWriterMessageDataType *jsonDataSetWriterMessageDataType = NULL;
  1353. /* The configuration Flags are included
  1354. * inside the std. defined UA_UadpDataSetWriterMessageDataType */
  1355. UA_UadpDataSetWriterMessageDataType defaultUadpConfiguration;
  1356. UA_UadpDataSetWriterMessageDataType *dataSetWriterMessageDataType = NULL;
  1357. if((dataSetWriter->config.messageSettings.encoding == UA_EXTENSIONOBJECT_DECODED ||
  1358. dataSetWriter->config.messageSettings.encoding == UA_EXTENSIONOBJECT_DECODED_NODELETE) &&
  1359. (dataSetWriter->config.messageSettings.content.decoded.type ==
  1360. &UA_TYPES[UA_TYPES_UADPDATASETWRITERMESSAGEDATATYPE])) {
  1361. dataSetWriterMessageDataType = (UA_UadpDataSetWriterMessageDataType *)
  1362. dataSetWriter->config.messageSettings.content.decoded.data;
  1363. /* type is UADP */
  1364. messageType = UA_TYPES_UADPDATASETWRITERMESSAGEDATATYPE;
  1365. } else if((dataSetWriter->config.messageSettings.encoding == UA_EXTENSIONOBJECT_DECODED ||
  1366. dataSetWriter->config.messageSettings.encoding == UA_EXTENSIONOBJECT_DECODED_NODELETE) &&
  1367. (dataSetWriter->config.messageSettings.content.decoded.type ==
  1368. &UA_TYPES[UA_TYPES_JSONDATASETWRITERMESSAGEDATATYPE])) {
  1369. jsonDataSetWriterMessageDataType = (UA_JsonDataSetWriterMessageDataType *)
  1370. dataSetWriter->config.messageSettings.content.decoded.data;
  1371. /* type is JSON */
  1372. messageType = UA_TYPES_JSONDATASETWRITERMESSAGEDATATYPE;
  1373. } else {
  1374. /* create default flag configuration if no
  1375. * UadpDataSetWriterMessageDataType was passed in */
  1376. memset(&defaultUadpConfiguration, 0, sizeof(UA_UadpDataSetWriterMessageDataType));
  1377. defaultUadpConfiguration.dataSetMessageContentMask = (UA_UadpDataSetMessageContentMask)
  1378. ((u64)UA_UADPDATASETMESSAGECONTENTMASK_TIMESTAMP | (u64)UA_UADPDATASETMESSAGECONTENTMASK_MAJORVERSION |
  1379. (u64)UA_UADPDATASETMESSAGECONTENTMASK_MINORVERSION);
  1380. dataSetWriterMessageDataType = &defaultUadpConfiguration;
  1381. }
  1382. /* Sanity-test the configuration */
  1383. if(dataSetWriterMessageDataType &&
  1384. (dataSetWriterMessageDataType->networkMessageNumber != 0 ||
  1385. dataSetWriterMessageDataType->dataSetOffset != 0 ||
  1386. dataSetWriterMessageDataType->configuredSize != 0)) {
  1387. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  1388. "Static DSM configuration not supported. Using defaults");
  1389. dataSetWriterMessageDataType->networkMessageNumber = 0;
  1390. dataSetWriterMessageDataType->dataSetOffset = 0;
  1391. dataSetWriterMessageDataType->configuredSize = 0;
  1392. }
  1393. /* The field encoding depends on the flags inside the writer config.
  1394. * TODO: This can be moved to the encoding layer. */
  1395. if(dataSetWriter->config.dataSetFieldContentMask & (u64)UA_DATASETFIELDCONTENTMASK_RAWDATA
  1396. ) {
  1397. dataSetMessage->header.fieldEncoding = UA_FIELDENCODING_RAWDATA;
  1398. } else if((u64)dataSetWriter->config.dataSetFieldContentMask &
  1399. ((u64)UA_DATASETFIELDCONTENTMASK_SOURCETIMESTAMP | (u64)UA_DATASETFIELDCONTENTMASK_SERVERPICOSECONDS |
  1400. (u64)UA_DATASETFIELDCONTENTMASK_SOURCEPICOSECONDS | (u64)UA_DATASETFIELDCONTENTMASK_STATUSCODE)) {
  1401. dataSetMessage->header.fieldEncoding = UA_FIELDENCODING_DATAVALUE;
  1402. } else {
  1403. dataSetMessage->header.fieldEncoding = UA_FIELDENCODING_VARIANT;
  1404. }
  1405. if(messageType == UA_TYPES_UADPDATASETWRITERMESSAGEDATATYPE) {
  1406. /* Std: 'The DataSetMessageContentMask defines the flags for the content of the DataSetMessage header.' */
  1407. if((u64)dataSetWriterMessageDataType->dataSetMessageContentMask &
  1408. (u64)UA_UADPDATASETMESSAGECONTENTMASK_MAJORVERSION) {
  1409. dataSetMessage->header.configVersionMajorVersionEnabled = true;
  1410. dataSetMessage->header.configVersionMajorVersion =
  1411. currentDataSet->dataSetMetaData.configurationVersion.majorVersion;
  1412. }
  1413. if((u64)dataSetWriterMessageDataType->dataSetMessageContentMask &
  1414. (u64)UA_UADPDATASETMESSAGECONTENTMASK_MINORVERSION) {
  1415. dataSetMessage->header.configVersionMinorVersionEnabled = true;
  1416. dataSetMessage->header.configVersionMinorVersion =
  1417. currentDataSet->dataSetMetaData.configurationVersion.minorVersion;
  1418. }
  1419. if((u64)dataSetWriterMessageDataType->dataSetMessageContentMask &
  1420. (u64)UA_UADPDATASETMESSAGECONTENTMASK_SEQUENCENUMBER) {
  1421. dataSetMessage->header.dataSetMessageSequenceNrEnabled = true;
  1422. dataSetMessage->header.dataSetMessageSequenceNr =
  1423. dataSetWriter->actualDataSetMessageSequenceCount;
  1424. }
  1425. if((u64)dataSetWriterMessageDataType->dataSetMessageContentMask &
  1426. (u64)UA_UADPDATASETMESSAGECONTENTMASK_TIMESTAMP) {
  1427. dataSetMessage->header.timestampEnabled = true;
  1428. dataSetMessage->header.timestamp = UA_DateTime_now();
  1429. }
  1430. /* TODO: Picoseconds resolution not supported atm */
  1431. if((u64)dataSetWriterMessageDataType->dataSetMessageContentMask &
  1432. (u64)UA_UADPDATASETMESSAGECONTENTMASK_PICOSECONDS) {
  1433. dataSetMessage->header.picoSecondsIncluded = false;
  1434. }
  1435. /* TODO: Statuscode not supported yet */
  1436. if((u64)dataSetWriterMessageDataType->dataSetMessageContentMask &
  1437. (u64)UA_UADPDATASETMESSAGECONTENTMASK_STATUS) {
  1438. dataSetMessage->header.statusEnabled = false;
  1439. }
  1440. } else if(messageType == UA_TYPES_JSONDATASETWRITERMESSAGEDATATYPE) {
  1441. if((u64)jsonDataSetWriterMessageDataType->dataSetMessageContentMask &
  1442. (u64)UA_JSONDATASETMESSAGECONTENTMASK_METADATAVERSION) {
  1443. dataSetMessage->header.configVersionMajorVersionEnabled = true;
  1444. dataSetMessage->header.configVersionMajorVersion =
  1445. currentDataSet->dataSetMetaData.configurationVersion.majorVersion;
  1446. }
  1447. if((u64)jsonDataSetWriterMessageDataType->dataSetMessageContentMask &
  1448. (u64)UA_JSONDATASETMESSAGECONTENTMASK_METADATAVERSION) {
  1449. dataSetMessage->header.configVersionMinorVersionEnabled = true;
  1450. dataSetMessage->header.configVersionMinorVersion =
  1451. currentDataSet->dataSetMetaData.configurationVersion.minorVersion;
  1452. }
  1453. if((u64)jsonDataSetWriterMessageDataType->dataSetMessageContentMask &
  1454. (u64)UA_JSONDATASETMESSAGECONTENTMASK_SEQUENCENUMBER) {
  1455. dataSetMessage->header.dataSetMessageSequenceNrEnabled = true;
  1456. dataSetMessage->header.dataSetMessageSequenceNr =
  1457. dataSetWriter->actualDataSetMessageSequenceCount;
  1458. }
  1459. if((u64)jsonDataSetWriterMessageDataType->dataSetMessageContentMask &
  1460. (u64)UA_JSONDATASETMESSAGECONTENTMASK_TIMESTAMP) {
  1461. dataSetMessage->header.timestampEnabled = true;
  1462. dataSetMessage->header.timestamp = UA_DateTime_now();
  1463. }
  1464. /* TODO: Statuscode not supported yet */
  1465. if((u64)jsonDataSetWriterMessageDataType->dataSetMessageContentMask &
  1466. (u64)UA_JSONDATASETMESSAGECONTENTMASK_STATUS) {
  1467. dataSetMessage->header.statusEnabled = false;
  1468. }
  1469. }
  1470. /* Set the sequence count. Automatically rolls over to zero */
  1471. dataSetWriter->actualDataSetMessageSequenceCount++;
  1472. /* JSON does not differ between deltaframes and keyframes, only keyframes are currently used. */
  1473. if(messageType != UA_TYPES_JSONDATASETWRITERMESSAGEDATATYPE){
  1474. #ifdef UA_ENABLE_PUBSUB_DELTAFRAMES
  1475. /* Check if the PublishedDataSet version has changed -> if yes flush the lastValue store and send a KeyFrame */
  1476. if(dataSetWriter->connectedDataSetVersion.majorVersion != currentDataSet->dataSetMetaData.configurationVersion.majorVersion ||
  1477. dataSetWriter->connectedDataSetVersion.minorVersion != currentDataSet->dataSetMetaData.configurationVersion.minorVersion) {
  1478. /* Remove old samples */
  1479. for(size_t i = 0; i < dataSetWriter->lastSamplesCount; i++)
  1480. UA_DataValue_clear(&dataSetWriter->lastSamples[i].value);
  1481. /* Realloc pds dependent memory */
  1482. dataSetWriter->lastSamplesCount = currentDataSet->fieldSize;
  1483. UA_DataSetWriterSample *newSamplesArray = (UA_DataSetWriterSample * )
  1484. UA_realloc(dataSetWriter->lastSamples, sizeof(UA_DataSetWriterSample) * dataSetWriter->lastSamplesCount);
  1485. if(!newSamplesArray)
  1486. return UA_STATUSCODE_BADOUTOFMEMORY;
  1487. dataSetWriter->lastSamples = newSamplesArray;
  1488. memset(dataSetWriter->lastSamples, 0, sizeof(UA_DataSetWriterSample) * dataSetWriter->lastSamplesCount);
  1489. dataSetWriter->connectedDataSetVersion = currentDataSet->dataSetMetaData.configurationVersion;
  1490. UA_PubSubDataSetWriter_generateKeyFrameMessage(server, dataSetMessage, dataSetWriter);
  1491. dataSetWriter->deltaFrameCounter = 0;
  1492. return UA_STATUSCODE_GOOD;
  1493. }
  1494. /* The standard defines: if a PDS contains only one fields no delta messages
  1495. * should be generated because they need more memory than a keyframe with 1
  1496. * field. */
  1497. if(currentDataSet->fieldSize > 1 && dataSetWriter->deltaFrameCounter > 0 &&
  1498. dataSetWriter->deltaFrameCounter <= dataSetWriter->config.keyFrameCount) {
  1499. UA_PubSubDataSetWriter_generateDeltaFrameMessage(server, dataSetMessage, dataSetWriter);
  1500. dataSetWriter->deltaFrameCounter++;
  1501. return UA_STATUSCODE_GOOD;
  1502. }
  1503. dataSetWriter->deltaFrameCounter = 1;
  1504. #endif
  1505. }
  1506. UA_PubSubDataSetWriter_generateKeyFrameMessage(server, dataSetMessage, dataSetWriter);
  1507. return UA_STATUSCODE_GOOD;
  1508. }
  1509. static UA_StatusCode
  1510. sendNetworkMessageJson(UA_PubSubConnection *connection, UA_DataSetMessage *dsm,
  1511. UA_UInt16 *writerIds, UA_Byte dsmCount, UA_ExtensionObject *transportSettings) {
  1512. UA_StatusCode retval = UA_STATUSCODE_BADNOTSUPPORTED;
  1513. #ifdef UA_ENABLE_JSON_ENCODING
  1514. UA_NetworkMessage nm;
  1515. memset(&nm, 0, sizeof(UA_NetworkMessage));
  1516. nm.version = 1;
  1517. nm.networkMessageType = UA_NETWORKMESSAGE_DATASET;
  1518. nm.payloadHeaderEnabled = true;
  1519. nm.payloadHeader.dataSetPayloadHeader.count = dsmCount;
  1520. nm.payloadHeader.dataSetPayloadHeader.dataSetWriterIds = writerIds;
  1521. nm.payload.dataSetPayload.dataSetMessages = dsm;
  1522. /* Allocate the buffer. Allocate on the stack if the buffer is small. */
  1523. UA_ByteString buf;
  1524. size_t msgSize = UA_NetworkMessage_calcSizeJson(&nm, NULL, 0, NULL, 0, true);
  1525. size_t stackSize = 1;
  1526. if(msgSize <= UA_MAX_STACKBUF)
  1527. stackSize = msgSize;
  1528. UA_STACKARRAY(UA_Byte, stackBuf, stackSize);
  1529. buf.data = stackBuf;
  1530. buf.length = msgSize;
  1531. if(msgSize > UA_MAX_STACKBUF) {
  1532. retval = UA_ByteString_allocBuffer(&buf, msgSize);
  1533. if(retval != UA_STATUSCODE_GOOD)
  1534. return retval;
  1535. }
  1536. /* Encode the message */
  1537. UA_Byte *bufPos = buf.data;
  1538. memset(bufPos, 0, msgSize);
  1539. const UA_Byte *bufEnd = &buf.data[buf.length];
  1540. retval = UA_NetworkMessage_encodeJson(&nm, &bufPos, &bufEnd, NULL, 0, NULL, 0, true);
  1541. if(retval != UA_STATUSCODE_GOOD) {
  1542. if(msgSize > UA_MAX_STACKBUF)
  1543. UA_ByteString_clear(&buf);
  1544. return retval;
  1545. }
  1546. /* Send the prepared messages */
  1547. retval = connection->channel->send(connection->channel, transportSettings, &buf);
  1548. if(msgSize > UA_MAX_STACKBUF)
  1549. UA_ByteString_clear(&buf);
  1550. #endif
  1551. return retval;
  1552. }
  1553. static UA_StatusCode
  1554. generateNetworkMessage(UA_PubSubConnection *connection, UA_WriterGroup *wg,
  1555. UA_DataSetMessage *dsm, UA_UInt16 *writerIds, UA_Byte dsmCount,
  1556. UA_ExtensionObject *messageSettings,
  1557. UA_ExtensionObject *transportSettings,
  1558. UA_NetworkMessage *networkMessage) {
  1559. if(messageSettings->content.decoded.type !=
  1560. &UA_TYPES[UA_TYPES_UADPWRITERGROUPMESSAGEDATATYPE])
  1561. return UA_STATUSCODE_BADINTERNALERROR;
  1562. UA_UadpWriterGroupMessageDataType *wgm = (UA_UadpWriterGroupMessageDataType*)
  1563. messageSettings->content.decoded.data;
  1564. memset(networkMessage, 0, sizeof(UA_NetworkMessage));
  1565. networkMessage->publisherIdEnabled =
  1566. ((u64)wgm->networkMessageContentMask & (u64)UA_UADPNETWORKMESSAGECONTENTMASK_PUBLISHERID) != 0;
  1567. networkMessage->groupHeaderEnabled =
  1568. ((u64)wgm->networkMessageContentMask & (u64)UA_UADPNETWORKMESSAGECONTENTMASK_GROUPHEADER) != 0;
  1569. networkMessage->groupHeader.writerGroupIdEnabled =
  1570. ((u64)wgm->networkMessageContentMask & (u64)UA_UADPNETWORKMESSAGECONTENTMASK_WRITERGROUPID) != 0;
  1571. networkMessage->groupHeader.groupVersionEnabled =
  1572. ((u64)wgm->networkMessageContentMask & (u64)UA_UADPNETWORKMESSAGECONTENTMASK_GROUPVERSION) != 0;
  1573. networkMessage->groupHeader.networkMessageNumberEnabled =
  1574. ((u64)wgm->networkMessageContentMask & (u64)UA_UADPNETWORKMESSAGECONTENTMASK_NETWORKMESSAGENUMBER) != 0;
  1575. networkMessage->groupHeader.sequenceNumberEnabled =
  1576. ((u64)wgm->networkMessageContentMask & (u64)UA_UADPNETWORKMESSAGECONTENTMASK_SEQUENCENUMBER) != 0;
  1577. networkMessage->payloadHeaderEnabled =
  1578. ((u64)wgm->networkMessageContentMask & (u64)UA_UADPNETWORKMESSAGECONTENTMASK_PAYLOADHEADER) != 0;
  1579. networkMessage->timestampEnabled =
  1580. ((u64)wgm->networkMessageContentMask & (u64)UA_UADPNETWORKMESSAGECONTENTMASK_TIMESTAMP) != 0;
  1581. networkMessage->picosecondsEnabled =
  1582. ((u64)wgm->networkMessageContentMask & (u64)UA_UADPNETWORKMESSAGECONTENTMASK_PICOSECONDS) != 0;
  1583. networkMessage->dataSetClassIdEnabled =
  1584. ((u64)wgm->networkMessageContentMask & (u64)UA_UADPNETWORKMESSAGECONTENTMASK_DATASETCLASSID) != 0;
  1585. networkMessage->promotedFieldsEnabled =
  1586. ((u64)wgm->networkMessageContentMask & (u64)UA_UADPNETWORKMESSAGECONTENTMASK_PROMOTEDFIELDS) != 0;
  1587. networkMessage->version = 1;
  1588. networkMessage->networkMessageType = UA_NETWORKMESSAGE_DATASET;
  1589. if(connection->config->publisherIdType == UA_PUBSUB_PUBLISHERID_NUMERIC) {
  1590. networkMessage->publisherIdType = UA_PUBLISHERDATATYPE_UINT16;
  1591. networkMessage->publisherId.publisherIdUInt32 = connection->config->publisherId.numeric;
  1592. } else if(connection->config->publisherIdType == UA_PUBSUB_PUBLISHERID_STRING){
  1593. networkMessage->publisherIdType = UA_PUBLISHERDATATYPE_STRING;
  1594. networkMessage->publisherId.publisherIdString = connection->config->publisherId.string;
  1595. }
  1596. /* Compute the length of the dsm separately for the header */
  1597. UA_STACKARRAY(UA_UInt16, dsmLengths, dsmCount);
  1598. for(UA_Byte i = 0; i < dsmCount; i++)
  1599. dsmLengths[i] = (UA_UInt16)UA_DataSetMessage_calcSizeBinary(&dsm[i]);
  1600. networkMessage->payloadHeader.dataSetPayloadHeader.count = dsmCount;
  1601. networkMessage->payloadHeader.dataSetPayloadHeader.dataSetWriterIds = writerIds;
  1602. networkMessage->groupHeader.writerGroupId = wg->config.writerGroupId;
  1603. networkMessage->groupHeader.networkMessageNumber = 1;
  1604. networkMessage->payload.dataSetPayload.sizes = dsmLengths;
  1605. networkMessage->payload.dataSetPayload.dataSetMessages = dsm;
  1606. return UA_STATUSCODE_GOOD;
  1607. }
  1608. static UA_StatusCode
  1609. sendBufferedNetworkMessage(UA_PubSubConnection *connection,
  1610. UA_NetworkMessageOffsetBuffer *buffer, UA_ExtensionObject *transportSettings) {
  1611. if(UA_NetworkMessage_updateBufferedMessage(buffer) != UA_STATUSCODE_GOOD)
  1612. UA_LOG_DEBUG(UA_Log_Stdout, UA_LOGCATEGORY_SERVER, "PubSub sending. Unknown field type.");
  1613. UA_StatusCode retval = connection->channel->send(connection->channel, transportSettings, &buffer->buffer);
  1614. return retval;
  1615. }
  1616. static UA_StatusCode
  1617. sendNetworkMessage(UA_PubSubConnection *connection, UA_WriterGroup *wg,
  1618. UA_DataSetMessage *dsm, UA_UInt16 *writerIds, UA_Byte dsmCount,
  1619. UA_ExtensionObject *messageSettings,
  1620. UA_ExtensionObject *transportSettings) {
  1621. UA_NetworkMessage nm;
  1622. generateNetworkMessage(connection, wg, dsm, writerIds, dsmCount, messageSettings, transportSettings, &nm);
  1623. /* Allocate the buffer. Allocate on the stack if the buffer is small. */
  1624. UA_ByteString buf;
  1625. size_t msgSize = UA_NetworkMessage_calcSizeBinary(&nm);
  1626. size_t stackSize = 1;
  1627. if(msgSize <= UA_MAX_STACKBUF)
  1628. stackSize = msgSize;
  1629. UA_STACKARRAY(UA_Byte, stackBuf, stackSize);
  1630. buf.data = stackBuf;
  1631. buf.length = msgSize;
  1632. UA_StatusCode retval;
  1633. if(msgSize > UA_MAX_STACKBUF) {
  1634. retval = UA_ByteString_allocBuffer(&buf, msgSize);
  1635. if(retval != UA_STATUSCODE_GOOD)
  1636. return retval;
  1637. }
  1638. /* Encode the message */
  1639. UA_Byte *bufPos = buf.data;
  1640. memset(bufPos, 0, msgSize);
  1641. const UA_Byte *bufEnd = &buf.data[buf.length];
  1642. retval = UA_NetworkMessage_encodeBinary(&nm, &bufPos, bufEnd);
  1643. if(retval != UA_STATUSCODE_GOOD) {
  1644. if(msgSize > UA_MAX_STACKBUF)
  1645. UA_ByteString_clear(&buf);
  1646. return retval;
  1647. }
  1648. /* Send the prepared messages */
  1649. retval = connection->channel->send(connection->channel, transportSettings, &buf);
  1650. if(msgSize > UA_MAX_STACKBUF)
  1651. UA_ByteString_clear(&buf);
  1652. return retval;
  1653. }
  1654. /* This callback triggers the collection and publish of NetworkMessages and the
  1655. * contained DataSetMessages. */
  1656. void
  1657. UA_WriterGroup_publishCallback(UA_Server *server, UA_WriterGroup *writerGroup) {
  1658. UA_LOG_DEBUG(&server->config.logger, UA_LOGCATEGORY_SERVER, "Publish Callback");
  1659. if(!writerGroup) {
  1660. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  1661. "Publish failed. WriterGroup not found");
  1662. return;
  1663. }
  1664. /* Nothing to do? */
  1665. if(writerGroup->writersCount <= 0)
  1666. return;
  1667. /* Binary or Json encoding? */
  1668. if(writerGroup->config.encodingMimeType != UA_PUBSUB_ENCODING_UADP &&
  1669. writerGroup->config.encodingMimeType != UA_PUBSUB_ENCODING_JSON) {
  1670. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  1671. "Publish failed: Unknown encoding type.");
  1672. return;
  1673. }
  1674. /* Find the connection associated with the writer */
  1675. UA_PubSubConnection *connection =
  1676. UA_PubSubConnection_findConnectionbyId(server, writerGroup->linkedConnection);
  1677. if(!connection) {
  1678. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  1679. "Publish failed. PubSubConnection invalid.");
  1680. return;
  1681. }
  1682. //TODO Avoid connection lookup while publish! Attention simple pointer vs. realloc in pubsub manager
  1683. if(writerGroup->config.rtLevel == UA_PUBSUB_RT_FIXED_SIZE) {
  1684. sendBufferedNetworkMessage(connection, &writerGroup->bufferedMessage, &writerGroup->config.transportSettings);
  1685. return;
  1686. }
  1687. /* How many DSM can be sent in one NM? */
  1688. UA_Byte maxDSM = (UA_Byte)writerGroup->config.maxEncapsulatedDataSetMessageCount;
  1689. if(writerGroup->config.maxEncapsulatedDataSetMessageCount > UA_BYTE_MAX)
  1690. maxDSM = UA_BYTE_MAX;
  1691. /* If the maxEncapsulatedDataSetMessageCount is set to 0->1 */
  1692. if(maxDSM == 0)
  1693. maxDSM = 1;
  1694. /* It is possible to put several DataSetMessages into one NetworkMessage.
  1695. * But only if they do not contain promoted fields. NM with only DSM are
  1696. * sent out right away. The others are kept in a buffer for "batching". */
  1697. size_t dsmCount = 0;
  1698. UA_DataSetWriter *dsw;
  1699. UA_STACKARRAY(UA_UInt16, dsWriterIds, writerGroup->writersCount);
  1700. UA_STACKARRAY(UA_DataSetMessage, dsmStore, writerGroup->writersCount);
  1701. LIST_FOREACH(dsw, &writerGroup->writers, listEntry) {
  1702. /* Find the dataset */
  1703. UA_PublishedDataSet *pds =
  1704. UA_PublishedDataSet_findPDSbyId(server, dsw->connectedDataSet);
  1705. if(!pds) {
  1706. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  1707. "PubSub Publish: PublishedDataSet not found");
  1708. continue;
  1709. }
  1710. /* Generate the DSM */
  1711. UA_StatusCode res =
  1712. UA_DataSetWriter_generateDataSetMessage(server, &dsmStore[dsmCount], dsw);
  1713. if(res != UA_STATUSCODE_GOOD) {
  1714. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  1715. "PubSub Publish: DataSetMessage creation failed");
  1716. continue;
  1717. }
  1718. /* Send right away if there is only this DSM in a NM. If promoted fields
  1719. * are contained in the PublishedDataSet, then this DSM must go into a
  1720. * dedicated NM as well. */
  1721. if(pds->promotedFieldsCount > 0 || maxDSM == 1) {
  1722. if(writerGroup->config.encodingMimeType == UA_PUBSUB_ENCODING_UADP){
  1723. res = sendNetworkMessage(connection, writerGroup, &dsmStore[dsmCount],
  1724. &dsw->config.dataSetWriterId, 1,
  1725. &writerGroup->config.messageSettings,
  1726. &writerGroup->config.transportSettings);
  1727. }else if(writerGroup->config.encodingMimeType == UA_PUBSUB_ENCODING_JSON){
  1728. res = sendNetworkMessageJson(connection, &dsmStore[dsmCount],
  1729. &dsw->config.dataSetWriterId, 1, &writerGroup->config.transportSettings);
  1730. }
  1731. if(res != UA_STATUSCODE_GOOD)
  1732. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  1733. "PubSub Publish: Could not send a NetworkMessage");
  1734. UA_DataSetMessage_free(&dsmStore[dsmCount]);
  1735. continue;
  1736. }
  1737. dsWriterIds[dsmCount] = dsw->config.dataSetWriterId;
  1738. dsmCount++;
  1739. }
  1740. /* Send the NetworkMessages with batched DataSetMessages */
  1741. size_t nmCount = (dsmCount / maxDSM) + ((dsmCount % maxDSM) == 0 ? 0 : 1);
  1742. for(UA_UInt32 i = 0; i < nmCount; i++) {
  1743. UA_Byte nmDsmCount = maxDSM;
  1744. if(i == nmCount - 1 && (dsmCount % maxDSM))
  1745. nmDsmCount = (UA_Byte)dsmCount % maxDSM;
  1746. UA_StatusCode res3 = UA_STATUSCODE_GOOD;
  1747. if(writerGroup->config.encodingMimeType == UA_PUBSUB_ENCODING_UADP){
  1748. res3 = sendNetworkMessage(connection, writerGroup, &dsmStore[i * maxDSM],
  1749. &dsWriterIds[i * maxDSM], nmDsmCount,
  1750. &writerGroup->config.messageSettings,
  1751. &writerGroup->config.transportSettings);
  1752. }else if(writerGroup->config.encodingMimeType == UA_PUBSUB_ENCODING_JSON){
  1753. res3 = sendNetworkMessageJson(connection, &dsmStore[i * maxDSM],
  1754. &dsWriterIds[i * maxDSM], nmDsmCount, &writerGroup->config.transportSettings);
  1755. }
  1756. if(res3 != UA_STATUSCODE_GOOD)
  1757. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  1758. "PubSub Publish: Sending a NetworkMessage failed");
  1759. }
  1760. /* Clean up DSM */
  1761. for(size_t i = 0; i < dsmCount; i++)
  1762. UA_DataSetMessage_free(&dsmStore[i]);
  1763. }
  1764. /* Add new publishCallback. The first execution is triggered directly after
  1765. * creation. */
  1766. UA_StatusCode
  1767. UA_WriterGroup_addPublishCallback(UA_Server *server, UA_WriterGroup *writerGroup) {
  1768. UA_StatusCode retval =
  1769. UA_PubSubManager_addRepeatedCallback(server,
  1770. (UA_ServerCallback) UA_WriterGroup_publishCallback,
  1771. writerGroup, writerGroup->config.publishingInterval,
  1772. &writerGroup->publishCallbackId);
  1773. if(retval == UA_STATUSCODE_GOOD)
  1774. writerGroup->publishCallbackIsRegistered = true;
  1775. /* Run once after creation */
  1776. UA_WriterGroup_publishCallback(server, writerGroup);
  1777. return retval;
  1778. }
  1779. #endif /* UA_ENABLE_PUBSUB */