ua_pubsub_writer.c 91 KB

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