ua_pubsub_writer.c 86 KB

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