ua_pubsub_writer.c 89 KB

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