ua_pubsub_writer.c 86 KB

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