ua_pubsub_writer.c 84 KB

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