ua_pubsub.c 53 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174
  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. */
  7. #include "server/ua_server_internal.h"
  8. #include "ua_types_encoding_binary.h"
  9. #ifdef UA_ENABLE_PUBSUB /* conditional compilation */
  10. #include "ua_server_pubsub.h"
  11. #include "ua_pubsub.h"
  12. #include "ua_pubsub_manager.h"
  13. #include "ua_pubsub_networkmessage.h"
  14. #ifdef UA_ENABLE_PUBSUB_INFORMATIONMODEL
  15. #include "ua_pubsub_ns0.h"
  16. #endif
  17. /* Forward declaration */
  18. static void
  19. UA_WriterGroup_deleteMembers(UA_Server *server, UA_WriterGroup *writerGroup);
  20. static void
  21. UA_DataSetField_deleteMembers(UA_DataSetField *field);
  22. /**********************************************/
  23. /* Connection */
  24. /**********************************************/
  25. UA_StatusCode
  26. UA_PubSubConnectionConfig_copy(const UA_PubSubConnectionConfig *src,
  27. UA_PubSubConnectionConfig *dst) {
  28. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  29. memcpy(dst, src, sizeof(UA_PubSubConnectionConfig));
  30. retVal |= UA_String_copy(&src->name, &dst->name);
  31. retVal |= UA_Variant_copy(&src->address, &dst->address);
  32. retVal |= UA_String_copy(&src->transportProfileUri, &dst->transportProfileUri);
  33. retVal |= UA_Variant_copy(&src->connectionTransportSettings, &dst->connectionTransportSettings);
  34. if(src->connectionPropertiesSize > 0){
  35. dst->connectionProperties = (UA_KeyValuePair *)
  36. UA_calloc(src->connectionPropertiesSize, sizeof(UA_KeyValuePair));
  37. if(!dst->connectionProperties){
  38. return UA_STATUSCODE_BADOUTOFMEMORY;
  39. }
  40. for(size_t i = 0; i < src->connectionPropertiesSize; i++){
  41. retVal |= UA_QualifiedName_copy(&src->connectionProperties[i].key,
  42. &dst->connectionProperties[i].key);
  43. retVal |= UA_Variant_copy(&src->connectionProperties[i].value,
  44. &dst->connectionProperties[i].value);
  45. }
  46. }
  47. return retVal;
  48. }
  49. UA_StatusCode
  50. UA_Server_getPubSubConnectionConfig(UA_Server *server, const UA_NodeId connection,
  51. UA_PubSubConnectionConfig *config) {
  52. if(!config)
  53. return UA_STATUSCODE_BADINVALIDARGUMENT;
  54. UA_PubSubConnection *currentPubSubConnection =
  55. UA_PubSubConnection_findConnectionbyId(server, connection);
  56. if(!currentPubSubConnection)
  57. return UA_STATUSCODE_BADNOTFOUND;
  58. UA_PubSubConnectionConfig tmpPubSubConnectionConfig;
  59. //deep copy of the actual config
  60. UA_PubSubConnectionConfig_copy(currentPubSubConnection->config, &tmpPubSubConnectionConfig);
  61. *config = tmpPubSubConnectionConfig;
  62. return UA_STATUSCODE_GOOD;
  63. }
  64. UA_PubSubConnection *
  65. UA_PubSubConnection_findConnectionbyId(UA_Server *server, UA_NodeId connectionIdentifier) {
  66. for(size_t i = 0; i < server->pubSubManager.connectionsSize; i++){
  67. if(UA_NodeId_equal(&connectionIdentifier, &server->pubSubManager.connections[i].identifier)){
  68. return &server->pubSubManager.connections[i];
  69. }
  70. }
  71. return NULL;
  72. }
  73. void
  74. UA_PubSubConnectionConfig_deleteMembers(UA_PubSubConnectionConfig *connectionConfig) {
  75. UA_String_deleteMembers(&connectionConfig->name);
  76. UA_String_deleteMembers(&connectionConfig->transportProfileUri);
  77. UA_Variant_deleteMembers(&connectionConfig->connectionTransportSettings);
  78. UA_Variant_deleteMembers(&connectionConfig->address);
  79. for(size_t i = 0; i < connectionConfig->connectionPropertiesSize; i++){
  80. UA_QualifiedName_deleteMembers(&connectionConfig->connectionProperties[i].key);
  81. UA_Variant_deleteMembers(&connectionConfig->connectionProperties[i].value);
  82. }
  83. UA_free(connectionConfig->connectionProperties);
  84. }
  85. void
  86. UA_PubSubConnection_deleteMembers(UA_Server *server, UA_PubSubConnection *connection) {
  87. //delete connection config
  88. UA_PubSubConnectionConfig_deleteMembers(connection->config);
  89. //remove contained WriterGroups
  90. UA_WriterGroup *writerGroup, *tmpWriterGroup;
  91. LIST_FOREACH_SAFE(writerGroup, &connection->writerGroups, listEntry, tmpWriterGroup){
  92. UA_Server_removeWriterGroup(server, writerGroup->identifier);
  93. }
  94. UA_NodeId_deleteMembers(&connection->identifier);
  95. if(connection->channel){
  96. connection->channel->close(connection->channel);
  97. }
  98. UA_free(connection->config);
  99. }
  100. UA_StatusCode
  101. UA_Server_addWriterGroup(UA_Server *server, const UA_NodeId connection,
  102. const UA_WriterGroupConfig *writerGroupConfig,
  103. UA_NodeId *writerGroupIdentifier) {
  104. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  105. if(!writerGroupConfig)
  106. return UA_STATUSCODE_BADINVALIDARGUMENT;
  107. //search the connection by the given connectionIdentifier
  108. UA_PubSubConnection *currentConnectionContext =
  109. UA_PubSubConnection_findConnectionbyId(server, connection);
  110. if(!currentConnectionContext)
  111. return UA_STATUSCODE_BADNOTFOUND;
  112. //allocate memory for new WriterGroup
  113. UA_WriterGroup *newWriterGroup = (UA_WriterGroup *) UA_calloc(1, sizeof(UA_WriterGroup));
  114. if (!newWriterGroup)
  115. return UA_STATUSCODE_BADOUTOFMEMORY;
  116. newWriterGroup->linkedConnection = currentConnectionContext->identifier;
  117. UA_PubSubManager_generateUniqueNodeId(server, &newWriterGroup->identifier);
  118. if(writerGroupIdentifier){
  119. UA_NodeId_copy(&newWriterGroup->identifier, writerGroupIdentifier);
  120. }
  121. UA_WriterGroupConfig tmpWriterGroupConfig;
  122. //deep copy of the config
  123. retVal |= UA_WriterGroupConfig_copy(writerGroupConfig, &tmpWriterGroupConfig);
  124. newWriterGroup->config = tmpWriterGroupConfig;
  125. retVal |= UA_WriterGroup_addPublishCallback(server, newWriterGroup);
  126. LIST_INSERT_HEAD(&currentConnectionContext->writerGroups, newWriterGroup, listEntry);
  127. #ifdef UA_ENABLE_PUBSUB_INFORMATIONMODEL
  128. addWriterGroupRepresentation(server, newWriterGroup);
  129. #endif
  130. return retVal;
  131. }
  132. UA_StatusCode
  133. UA_Server_removeWriterGroup(UA_Server *server, const UA_NodeId writerGroup){
  134. UA_WriterGroup *wg = UA_WriterGroup_findWGbyId(server, writerGroup);
  135. if(!wg)
  136. return UA_STATUSCODE_BADNOTFOUND;
  137. UA_PubSubConnection *connection =
  138. UA_PubSubConnection_findConnectionbyId(server, wg->linkedConnection);
  139. if(!connection)
  140. return UA_STATUSCODE_BADNOTFOUND;
  141. //unregister the publish callback
  142. if(UA_PubSubManager_removeRepeatedPubSubCallback(server, wg->publishCallbackId) != UA_STATUSCODE_GOOD)
  143. return UA_STATUSCODE_BADINTERNALERROR;
  144. #ifdef UA_ENABLE_PUBSUB_INFORMATIONMODEL
  145. removeGroupRepresentation(server, wg);
  146. #endif
  147. UA_WriterGroup_deleteMembers(server, wg);
  148. LIST_REMOVE(wg, listEntry);
  149. UA_free(wg);
  150. return UA_STATUSCODE_GOOD;
  151. }
  152. /**********************************************/
  153. /* PublishedDataSet */
  154. /**********************************************/
  155. UA_StatusCode
  156. UA_PublishedDataSetConfig_copy(const UA_PublishedDataSetConfig *src,
  157. UA_PublishedDataSetConfig *dst) {
  158. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  159. memcpy(dst, src, sizeof(UA_PublishedDataSetConfig));
  160. retVal |= UA_String_copy(&src->name, &dst->name);
  161. switch(src->publishedDataSetType){
  162. case UA_PUBSUB_DATASET_PUBLISHEDITEMS:
  163. //no additional items
  164. break;
  165. case UA_PUBSUB_DATASET_PUBLISHEDITEMS_TEMPLATE:
  166. if (src->config.itemsTemplate.variablesToAddSize > 0){
  167. dst->config.itemsTemplate.variablesToAdd = (UA_PublishedVariableDataType *) UA_calloc(
  168. src->config.itemsTemplate.variablesToAddSize, sizeof(UA_PublishedVariableDataType));
  169. }
  170. for(size_t i = 0; i < src->config.itemsTemplate.variablesToAddSize; i++){
  171. retVal |= UA_PublishedVariableDataType_copy(&src->config.itemsTemplate.variablesToAdd[i],
  172. &dst->config.itemsTemplate.variablesToAdd[i]);
  173. }
  174. retVal |= UA_DataSetMetaDataType_copy(&src->config.itemsTemplate.metaData,
  175. &dst->config.itemsTemplate.metaData);
  176. break;
  177. default:
  178. return UA_STATUSCODE_BADINVALIDARGUMENT;
  179. }
  180. return retVal;
  181. }
  182. UA_StatusCode
  183. UA_Server_getPublishedDataSetConfig(UA_Server *server, const UA_NodeId pds,
  184. UA_PublishedDataSetConfig *config){
  185. if(!config)
  186. return UA_STATUSCODE_BADINVALIDARGUMENT;
  187. UA_PublishedDataSet *currentPublishedDataSet = UA_PublishedDataSet_findPDSbyId(server, pds);
  188. if(!currentPublishedDataSet)
  189. return UA_STATUSCODE_BADNOTFOUND;
  190. UA_PublishedDataSetConfig tmpPublishedDataSetConfig;
  191. //deep copy of the actual config
  192. UA_PublishedDataSetConfig_copy(&currentPublishedDataSet->config, &tmpPublishedDataSetConfig);
  193. *config = tmpPublishedDataSetConfig;
  194. return UA_STATUSCODE_GOOD;
  195. }
  196. UA_PublishedDataSet *
  197. UA_PublishedDataSet_findPDSbyId(UA_Server *server, UA_NodeId identifier){
  198. for(size_t i = 0; i < server->pubSubManager.publishedDataSetsSize; i++){
  199. if(UA_NodeId_equal(&server->pubSubManager.publishedDataSets[i].identifier, &identifier)){
  200. return &server->pubSubManager.publishedDataSets[i];
  201. }
  202. }
  203. return NULL;
  204. }
  205. void
  206. UA_PublishedDataSetConfig_deleteMembers(UA_PublishedDataSetConfig *pdsConfig){
  207. //delete pds config
  208. UA_String_deleteMembers(&pdsConfig->name);
  209. switch (pdsConfig->publishedDataSetType){
  210. case UA_PUBSUB_DATASET_PUBLISHEDITEMS:
  211. //no additional items
  212. break;
  213. case UA_PUBSUB_DATASET_PUBLISHEDITEMS_TEMPLATE:
  214. if (pdsConfig->config.itemsTemplate.variablesToAddSize > 0){
  215. for(size_t i = 0; i < pdsConfig->config.itemsTemplate.variablesToAddSize; i++){
  216. UA_PublishedVariableDataType_deleteMembers(&pdsConfig->config.itemsTemplate.variablesToAdd[i]);
  217. }
  218. UA_free(pdsConfig->config.itemsTemplate.variablesToAdd);
  219. }
  220. UA_DataSetMetaDataType_deleteMembers(&pdsConfig->config.itemsTemplate.metaData);
  221. break;
  222. default:
  223. break;
  224. }
  225. }
  226. void
  227. UA_PublishedDataSet_deleteMembers(UA_Server *server, UA_PublishedDataSet *publishedDataSet){
  228. UA_PublishedDataSetConfig_deleteMembers(&publishedDataSet->config);
  229. //delete PDS
  230. UA_DataSetMetaDataType_deleteMembers(&publishedDataSet->dataSetMetaData);
  231. UA_DataSetField *field, *tmpField;
  232. LIST_FOREACH_SAFE(field, &publishedDataSet->fields, listEntry, tmpField) {
  233. UA_Server_removeDataSetField(server, field->identifier);
  234. }
  235. UA_NodeId_deleteMembers(&publishedDataSet->identifier);
  236. }
  237. UA_DataSetFieldResult
  238. UA_Server_addDataSetField(UA_Server *server, const UA_NodeId publishedDataSet,
  239. const UA_DataSetFieldConfig *fieldConfig,
  240. UA_NodeId *fieldIdentifier) {
  241. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  242. UA_DataSetFieldResult result = {UA_STATUSCODE_BADINVALIDARGUMENT, {0, 0}};
  243. if(!fieldConfig)
  244. return result;
  245. UA_PublishedDataSet *currentDataSet = UA_PublishedDataSet_findPDSbyId(server, publishedDataSet);
  246. if(currentDataSet == NULL){
  247. result.result = UA_STATUSCODE_BADNOTFOUND;
  248. return result;
  249. }
  250. if(currentDataSet->config.publishedDataSetType != UA_PUBSUB_DATASET_PUBLISHEDITEMS){
  251. result.result = UA_STATUSCODE_BADNOTIMPLEMENTED;
  252. return result;
  253. }
  254. UA_DataSetField *newField = (UA_DataSetField *) UA_calloc(1, sizeof(UA_DataSetField));
  255. if(!newField){
  256. result.result = UA_STATUSCODE_BADINTERNALERROR;
  257. return result;
  258. }
  259. UA_DataSetFieldConfig tmpFieldConfig;
  260. retVal |= UA_DataSetFieldConfig_copy(fieldConfig, &tmpFieldConfig);
  261. newField->config = tmpFieldConfig;
  262. UA_PubSubManager_generateUniqueNodeId(server, &newField->identifier);
  263. if(fieldIdentifier != NULL){
  264. UA_NodeId_copy(&newField->identifier, fieldIdentifier);
  265. }
  266. newField->publishedDataSet = currentDataSet->identifier;
  267. //update major version of parent published data set
  268. currentDataSet->dataSetMetaData.configurationVersion.majorVersion = UA_PubSubConfigurationVersionTimeDifference();
  269. LIST_INSERT_HEAD(&currentDataSet->fields, newField, listEntry);
  270. if(newField->config.field.variable.promotedField)
  271. currentDataSet->promotedFieldsCount++;
  272. currentDataSet->fieldSize++;
  273. result.result = retVal;
  274. result.configurationVersion.majorVersion = currentDataSet->dataSetMetaData.configurationVersion.majorVersion;
  275. result.configurationVersion.minorVersion = currentDataSet->dataSetMetaData.configurationVersion.minorVersion;
  276. return result;
  277. }
  278. UA_DataSetFieldResult
  279. UA_Server_removeDataSetField(UA_Server *server, const UA_NodeId dsf) {
  280. UA_DataSetField *currentField = UA_DataSetField_findDSFbyId(server, dsf);
  281. UA_DataSetFieldResult result = {UA_STATUSCODE_BADNOTFOUND, {0, 0}};
  282. if(!currentField)
  283. return result;
  284. UA_PublishedDataSet *parentPublishedDataSet =
  285. UA_PublishedDataSet_findPDSbyId(server, currentField->publishedDataSet);
  286. if(!parentPublishedDataSet)
  287. return result;
  288. parentPublishedDataSet->fieldSize--;
  289. if(currentField->config.field.variable.promotedField)
  290. parentPublishedDataSet->promotedFieldsCount--;
  291. /* update major version of PublishedDataSet */
  292. parentPublishedDataSet->dataSetMetaData.configurationVersion.majorVersion =
  293. UA_PubSubConfigurationVersionTimeDifference();
  294. UA_DataSetField_deleteMembers(currentField);
  295. LIST_REMOVE(currentField, listEntry);
  296. UA_free(currentField);
  297. result.result = UA_STATUSCODE_GOOD;
  298. result.configurationVersion.majorVersion = parentPublishedDataSet->dataSetMetaData.configurationVersion.majorVersion;
  299. result.configurationVersion.minorVersion = parentPublishedDataSet->dataSetMetaData.configurationVersion.minorVersion;
  300. return result;
  301. }
  302. /**********************************************/
  303. /* DataSetWriter */
  304. /**********************************************/
  305. UA_StatusCode
  306. UA_DataSetWriterConfig_copy(const UA_DataSetWriterConfig *src,
  307. UA_DataSetWriterConfig *dst){
  308. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  309. memcpy(dst, src, sizeof(UA_DataSetWriterConfig));
  310. retVal |= UA_String_copy(&src->name, &dst->name);
  311. retVal |= UA_String_copy(&src->dataSetName, &dst->dataSetName);
  312. retVal |= UA_ExtensionObject_copy(&src->messageSettings, &dst->messageSettings);
  313. dst->dataSetWriterProperties = (UA_KeyValuePair *)
  314. UA_calloc(src->dataSetWriterPropertiesSize, sizeof(UA_KeyValuePair));
  315. if(!dst->dataSetWriterProperties)
  316. return UA_STATUSCODE_BADOUTOFMEMORY;
  317. for(size_t i = 0; i < src->dataSetWriterPropertiesSize; i++){
  318. retVal |= UA_KeyValuePair_copy(&src->dataSetWriterProperties[i], &dst->dataSetWriterProperties[i]);
  319. }
  320. return retVal;
  321. }
  322. UA_StatusCode
  323. UA_Server_getDataSetWriterConfig(UA_Server *server, const UA_NodeId dsw,
  324. UA_DataSetWriterConfig *config){
  325. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  326. if(!config)
  327. return UA_STATUSCODE_BADINVALIDARGUMENT;
  328. UA_DataSetWriter *currentDataSetWriter = UA_DataSetWriter_findDSWbyId(server, dsw);
  329. if(!currentDataSetWriter)
  330. return UA_STATUSCODE_BADNOTFOUND;
  331. UA_DataSetWriterConfig tmpWriterConfig;
  332. //deep copy of the actual config
  333. retVal |= UA_DataSetWriterConfig_copy(&currentDataSetWriter->config, &tmpWriterConfig);
  334. *config = tmpWriterConfig;
  335. return retVal;
  336. }
  337. UA_DataSetWriter *
  338. UA_DataSetWriter_findDSWbyId(UA_Server *server, UA_NodeId identifier) {
  339. for(size_t i = 0; i < server->pubSubManager.connectionsSize; i++){
  340. UA_WriterGroup *tmpWriterGroup;
  341. LIST_FOREACH(tmpWriterGroup, &server->pubSubManager.connections[i].writerGroups, listEntry){
  342. UA_DataSetWriter *tmpWriter;
  343. LIST_FOREACH(tmpWriter, &tmpWriterGroup->writers, listEntry){
  344. if(UA_NodeId_equal(&tmpWriter->identifier, &identifier)){
  345. return tmpWriter;
  346. }
  347. }
  348. }
  349. }
  350. return NULL;
  351. }
  352. void
  353. UA_DataSetWriterConfig_deleteMembers(UA_DataSetWriterConfig *pdsConfig) {
  354. UA_String_deleteMembers(&pdsConfig->name);
  355. UA_String_deleteMembers(&pdsConfig->dataSetName);
  356. for(size_t i = 0; i < pdsConfig->dataSetWriterPropertiesSize; i++){
  357. UA_KeyValuePair_deleteMembers(&pdsConfig->dataSetWriterProperties[i]);
  358. }
  359. UA_free(pdsConfig->dataSetWriterProperties);
  360. UA_ExtensionObject_deleteMembers(&pdsConfig->messageSettings);
  361. }
  362. static void
  363. UA_DataSetWriter_deleteMembers(UA_Server *server, UA_DataSetWriter *dataSetWriter) {
  364. UA_DataSetWriterConfig_deleteMembers(&dataSetWriter->config);
  365. //delete DataSetWriter
  366. UA_NodeId_deleteMembers(&dataSetWriter->identifier);
  367. UA_NodeId_deleteMembers(&dataSetWriter->linkedWriterGroup);
  368. UA_NodeId_deleteMembers(&dataSetWriter->connectedDataSet);
  369. #ifdef UA_ENABLE_PUBSUB_DELTAFRAMES
  370. //delete lastSamples store
  371. for(size_t i = 0; i < dataSetWriter->lastSamplesCount; i++) {
  372. UA_DataValue_deleteMembers(&dataSetWriter->lastSamples[i].value);
  373. }
  374. UA_free(dataSetWriter->lastSamples);
  375. dataSetWriter->lastSamples = NULL;
  376. dataSetWriter->lastSamplesCount = 0;
  377. #endif
  378. }
  379. /**********************************************/
  380. /* WriterGroup */
  381. /**********************************************/
  382. UA_StatusCode
  383. UA_WriterGroupConfig_copy(const UA_WriterGroupConfig *src,
  384. UA_WriterGroupConfig *dst){
  385. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  386. memcpy(dst, src, sizeof(UA_WriterGroupConfig));
  387. retVal |= UA_String_copy(&src->name, &dst->name);
  388. retVal |= UA_ExtensionObject_copy(&src->transportSettings, &dst->transportSettings);
  389. retVal |= UA_ExtensionObject_copy(&src->messageSettings, &dst->messageSettings);
  390. dst->groupProperties = (UA_KeyValuePair *) UA_calloc(src->groupPropertiesSize, sizeof(UA_KeyValuePair));
  391. if(!dst->groupProperties)
  392. return UA_STATUSCODE_BADOUTOFMEMORY;
  393. for(size_t i = 0; i < src->groupPropertiesSize; i++){
  394. retVal |= UA_KeyValuePair_copy(&src->groupProperties[i], &dst->groupProperties[i]);
  395. }
  396. return retVal;
  397. }
  398. UA_StatusCode
  399. UA_Server_getWriterGroupConfig(UA_Server *server, const UA_NodeId writerGroup,
  400. UA_WriterGroupConfig *config){
  401. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  402. if(!config)
  403. return UA_STATUSCODE_BADINVALIDARGUMENT;
  404. UA_WriterGroup *currentWriterGroup = UA_WriterGroup_findWGbyId(server, writerGroup);
  405. if(!currentWriterGroup){
  406. return UA_STATUSCODE_BADNOTFOUND;
  407. }
  408. UA_WriterGroupConfig tmpWriterGroupConfig;
  409. //deep copy of the actual config
  410. retVal |= UA_WriterGroupConfig_copy(&currentWriterGroup->config, &tmpWriterGroupConfig);
  411. *config = tmpWriterGroupConfig;
  412. return retVal;
  413. }
  414. UA_StatusCode
  415. UA_Server_updateWriterGroupConfig(UA_Server *server, UA_NodeId writerGroupIdentifier,
  416. const UA_WriterGroupConfig *config){
  417. if(!config)
  418. return UA_STATUSCODE_BADINVALIDARGUMENT;
  419. UA_WriterGroup *currentWriterGroup = UA_WriterGroup_findWGbyId(server, writerGroupIdentifier);
  420. if(!currentWriterGroup)
  421. return UA_STATUSCODE_BADNOTFOUND;
  422. //The update functionality will be extended during the next PubSub batches.
  423. //Currently is only a change of the publishing interval possible.
  424. if(currentWriterGroup->config.publishingInterval != config->publishingInterval) {
  425. UA_PubSubManager_removeRepeatedPubSubCallback(server, currentWriterGroup->publishCallbackId);
  426. currentWriterGroup->config.publishingInterval = config->publishingInterval;
  427. UA_WriterGroup_addPublishCallback(server, currentWriterGroup);
  428. } else if (currentWriterGroup->config.priority != config->priority) {
  429. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  430. "No or unsupported WriterGroup update.");
  431. }
  432. return UA_STATUSCODE_GOOD;
  433. }
  434. UA_WriterGroup *
  435. UA_WriterGroup_findWGbyId(UA_Server *server, UA_NodeId identifier){
  436. for(size_t i = 0; i < server->pubSubManager.connectionsSize; i++){
  437. UA_WriterGroup *tmpWriterGroup;
  438. LIST_FOREACH(tmpWriterGroup, &server->pubSubManager.connections[i].writerGroups, listEntry) {
  439. if(UA_NodeId_equal(&identifier, &tmpWriterGroup->identifier)){
  440. return tmpWriterGroup;
  441. }
  442. }
  443. }
  444. return NULL;
  445. }
  446. void
  447. UA_WriterGroupConfig_deleteMembers(UA_WriterGroupConfig *writerGroupConfig){
  448. //delete writerGroup config
  449. UA_String_deleteMembers(&writerGroupConfig->name);
  450. UA_ExtensionObject_deleteMembers(&writerGroupConfig->transportSettings);
  451. UA_ExtensionObject_deleteMembers(&writerGroupConfig->messageSettings);
  452. for(size_t i = 0; i < writerGroupConfig->groupPropertiesSize; i++){
  453. UA_KeyValuePair_deleteMembers(&writerGroupConfig->groupProperties[i]);
  454. }
  455. UA_free(writerGroupConfig->groupProperties);
  456. }
  457. static void
  458. UA_WriterGroup_deleteMembers(UA_Server *server, UA_WriterGroup *writerGroup) {
  459. UA_WriterGroupConfig_deleteMembers(&writerGroup->config);
  460. //delete WriterGroup
  461. //delete all writers. Therefore removeDataSetWriter is called from PublishedDataSet
  462. UA_DataSetWriter *dataSetWriter, *tmpDataSetWriter;
  463. LIST_FOREACH_SAFE(dataSetWriter, &writerGroup->writers, listEntry, tmpDataSetWriter){
  464. UA_Server_removeDataSetWriter(server, dataSetWriter->identifier);
  465. }
  466. UA_NodeId_deleteMembers(&writerGroup->linkedConnection);
  467. UA_NodeId_deleteMembers(&writerGroup->identifier);
  468. }
  469. UA_StatusCode
  470. UA_Server_addDataSetWriter(UA_Server *server,
  471. const UA_NodeId writerGroup, const UA_NodeId dataSet,
  472. const UA_DataSetWriterConfig *dataSetWriterConfig,
  473. UA_NodeId *writerIdentifier) {
  474. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  475. if(!dataSetWriterConfig)
  476. return UA_STATUSCODE_BADINVALIDARGUMENT;
  477. UA_PublishedDataSet *currentDataSetContext = UA_PublishedDataSet_findPDSbyId(server, dataSet);
  478. if(!currentDataSetContext)
  479. return UA_STATUSCODE_BADNOTFOUND;
  480. UA_WriterGroup *wg = UA_WriterGroup_findWGbyId(server, writerGroup);
  481. if(!wg)
  482. return UA_STATUSCODE_BADNOTFOUND;
  483. UA_DataSetWriter *newDataSetWriter = (UA_DataSetWriter *) UA_calloc(1, sizeof(UA_DataSetWriter));
  484. if(!newDataSetWriter)
  485. return UA_STATUSCODE_BADOUTOFMEMORY;
  486. //copy the config into the new dataSetWriter
  487. UA_DataSetWriterConfig tmpDataSetWriterConfig;
  488. retVal |= UA_DataSetWriterConfig_copy(dataSetWriterConfig, &tmpDataSetWriterConfig);
  489. newDataSetWriter->config = tmpDataSetWriterConfig;
  490. //save the current version of the connected PublishedDataSet
  491. newDataSetWriter->connectedDataSetVersion = currentDataSetContext->dataSetMetaData.configurationVersion;
  492. #ifdef UA_ENABLE_PUBSUB_DELTAFRAMES
  493. //initialize the queue for the last values
  494. newDataSetWriter->lastSamples = (UA_DataSetWriterSample * )
  495. UA_calloc(currentDataSetContext->fieldSize, sizeof(UA_DataSetWriterSample));
  496. if(!newDataSetWriter->lastSamples) {
  497. UA_DataSetWriterConfig_deleteMembers(&newDataSetWriter->config);
  498. UA_free(newDataSetWriter);
  499. return UA_STATUSCODE_BADOUTOFMEMORY;
  500. }
  501. newDataSetWriter->lastSamplesCount = currentDataSetContext->fieldSize;
  502. #endif
  503. //connect PublishedDataSet with DataSetWriter
  504. newDataSetWriter->connectedDataSet = currentDataSetContext->identifier;
  505. newDataSetWriter->linkedWriterGroup = wg->identifier;
  506. UA_PubSubManager_generateUniqueNodeId(server, &newDataSetWriter->identifier);
  507. if(writerIdentifier != NULL)
  508. UA_NodeId_copy(&newDataSetWriter->identifier, writerIdentifier);
  509. //add the new writer to the group
  510. LIST_INSERT_HEAD(&wg->writers, newDataSetWriter, listEntry);
  511. wg->writersCount++;
  512. #ifdef UA_ENABLE_PUBSUB_INFORMATIONMODEL
  513. addDataSetWriterRepresentation(server, newDataSetWriter);
  514. #endif
  515. return retVal;
  516. }
  517. UA_StatusCode
  518. UA_Server_removeDataSetWriter(UA_Server *server, const UA_NodeId dsw){
  519. UA_DataSetWriter *dataSetWriter = UA_DataSetWriter_findDSWbyId(server, dsw);
  520. if(!dataSetWriter)
  521. return UA_STATUSCODE_BADNOTFOUND;
  522. UA_WriterGroup *linkedWriterGroup = UA_WriterGroup_findWGbyId(server, dataSetWriter->linkedWriterGroup);
  523. if(!linkedWriterGroup)
  524. return UA_STATUSCODE_BADNOTFOUND;
  525. linkedWriterGroup->writersCount--;
  526. #ifdef UA_ENABLE_PUBSUB_INFORMATIONMODEL
  527. removeDataSetWriterRepresentation(server, dataSetWriter);
  528. #endif
  529. //remove DataSetWriter from group
  530. UA_DataSetWriter_deleteMembers(server, dataSetWriter);
  531. LIST_REMOVE(dataSetWriter, listEntry);
  532. UA_free(dataSetWriter);
  533. return UA_STATUSCODE_GOOD;
  534. }
  535. /**********************************************/
  536. /* DataSetField */
  537. /**********************************************/
  538. UA_StatusCode
  539. UA_DataSetFieldConfig_copy(const UA_DataSetFieldConfig *src, UA_DataSetFieldConfig *dst){
  540. memcpy(dst, src, sizeof(UA_DataSetFieldConfig));
  541. if(src->dataSetFieldType == UA_PUBSUB_DATASETFIELD_VARIABLE) {
  542. UA_String_copy(&src->field.variable.fieldNameAlias, &dst->field.variable.fieldNameAlias);
  543. UA_PublishedVariableDataType_copy(&src->field.variable.publishParameters,
  544. &dst->field.variable.publishParameters);
  545. } else {
  546. return UA_STATUSCODE_BADNOTSUPPORTED;
  547. }
  548. return UA_STATUSCODE_GOOD;
  549. }
  550. UA_StatusCode
  551. UA_Server_getDataSetFieldConfig(UA_Server *server, const UA_NodeId dsf,
  552. UA_DataSetFieldConfig *config) {
  553. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  554. if(!config)
  555. return UA_STATUSCODE_BADINVALIDARGUMENT;
  556. UA_DataSetField *currentDataSetField = UA_DataSetField_findDSFbyId(server, dsf);
  557. if(!currentDataSetField)
  558. return UA_STATUSCODE_BADNOTFOUND;
  559. UA_DataSetFieldConfig tmpFieldConfig;
  560. //deep copy of the actual config
  561. retVal |= UA_DataSetFieldConfig_copy(&currentDataSetField->config, &tmpFieldConfig);
  562. *config = tmpFieldConfig;
  563. return retVal;
  564. }
  565. UA_DataSetField *
  566. UA_DataSetField_findDSFbyId(UA_Server *server, UA_NodeId identifier) {
  567. for(size_t i = 0; i < server->pubSubManager.publishedDataSetsSize; i++){
  568. UA_DataSetField *tmpField;
  569. LIST_FOREACH(tmpField, &server->pubSubManager.publishedDataSets[i].fields, listEntry){
  570. if(UA_NodeId_equal(&tmpField->identifier, &identifier)){
  571. return tmpField;
  572. }
  573. }
  574. }
  575. return NULL;
  576. }
  577. void
  578. UA_DataSetFieldConfig_deleteMembers(UA_DataSetFieldConfig *dataSetFieldConfig){
  579. if(dataSetFieldConfig->dataSetFieldType == UA_PUBSUB_DATASETFIELD_VARIABLE){
  580. UA_String_deleteMembers(&dataSetFieldConfig->field.variable.fieldNameAlias);
  581. UA_PublishedVariableDataType_deleteMembers(&dataSetFieldConfig->field.variable.publishParameters);
  582. }
  583. }
  584. static void
  585. UA_DataSetField_deleteMembers(UA_DataSetField *field) {
  586. UA_DataSetFieldConfig_deleteMembers(&field->config);
  587. //delete DataSetField
  588. UA_NodeId_deleteMembers(&field->identifier);
  589. UA_NodeId_deleteMembers(&field->publishedDataSet);
  590. UA_FieldMetaData_deleteMembers(&field->fieldMetaData);
  591. }
  592. /*********************************************************/
  593. /* PublishValues handling */
  594. /*********************************************************/
  595. /**
  596. * Compare two variants. Internally used for value change detection.
  597. *
  598. * @return true if the value has changed
  599. */
  600. #ifdef UA_ENABLE_PUBSUB_DELTAFRAMES
  601. static UA_Boolean
  602. valueChangedVariant(UA_Variant *oldValue, UA_Variant *newValue){
  603. if(! (oldValue && newValue))
  604. return false;
  605. UA_ByteString *oldValueEncoding = UA_ByteString_new(), *newValueEncoding = UA_ByteString_new();
  606. size_t oldValueEncodingSize, newValueEncodingSize;
  607. oldValueEncodingSize = UA_calcSizeBinary(oldValue, &UA_TYPES[UA_TYPES_VARIANT]);
  608. newValueEncodingSize = UA_calcSizeBinary(newValue, &UA_TYPES[UA_TYPES_VARIANT]);
  609. if((oldValueEncodingSize == 0) || (newValueEncodingSize == 0))
  610. return false;
  611. if(oldValueEncodingSize != newValueEncodingSize)
  612. return true;
  613. if(UA_ByteString_allocBuffer(oldValueEncoding, oldValueEncodingSize) != UA_STATUSCODE_GOOD)
  614. return false;
  615. if(UA_ByteString_allocBuffer(newValueEncoding, newValueEncodingSize) != UA_STATUSCODE_GOOD)
  616. return false;
  617. UA_Byte *bufPosOldValue = oldValueEncoding->data;
  618. const UA_Byte *bufEndOldValue = &oldValueEncoding->data[oldValueEncoding->length];
  619. UA_Byte *bufPosNewValue = newValueEncoding->data;
  620. const UA_Byte *bufEndNewValue = &newValueEncoding->data[newValueEncoding->length];
  621. if(UA_encodeBinary(oldValue, &UA_TYPES[UA_TYPES_VARIANT],
  622. &bufPosOldValue, &bufEndOldValue, NULL, NULL) != UA_STATUSCODE_GOOD){
  623. return false;
  624. }
  625. if(UA_encodeBinary(newValue, &UA_TYPES[UA_TYPES_VARIANT],
  626. &bufPosNewValue, &bufEndNewValue, NULL, NULL) != UA_STATUSCODE_GOOD){
  627. return false;
  628. }
  629. oldValueEncoding->length = (uintptr_t)bufPosOldValue - (uintptr_t)oldValueEncoding->data;
  630. newValueEncoding->length = (uintptr_t)bufPosNewValue - (uintptr_t)newValueEncoding->data;
  631. UA_Boolean compareResult = !UA_ByteString_equal(oldValueEncoding, newValueEncoding);
  632. UA_ByteString_delete(oldValueEncoding);
  633. UA_ByteString_delete(newValueEncoding);
  634. return compareResult;
  635. }
  636. #endif
  637. /**
  638. * Obtain the latest value for a specific DataSetField. This method is currently
  639. * called inside the DataSetMessage generation process.
  640. */
  641. static void
  642. UA_PubSubDataSetField_sampleValue(UA_Server *server, UA_DataSetField *field,
  643. UA_DataValue *value) {
  644. /* Read the value */
  645. UA_ReadValueId rvid;
  646. UA_ReadValueId_init(&rvid);
  647. rvid.nodeId = field->config.field.variable.publishParameters.publishedVariable;
  648. rvid.attributeId = field->config.field.variable.publishParameters.attributeId;
  649. rvid.indexRange = field->config.field.variable.publishParameters.indexRange;
  650. *value = UA_Server_read(server, &rvid, UA_TIMESTAMPSTORETURN_BOTH);
  651. }
  652. static UA_StatusCode
  653. UA_PubSubDataSetWriter_generateKeyFrameMessage(UA_Server *server, UA_DataSetMessage *dataSetMessage,
  654. UA_DataSetWriter *dataSetWriter) {
  655. UA_PublishedDataSet *currentDataSet =
  656. UA_PublishedDataSet_findPDSbyId(server, dataSetWriter->connectedDataSet);
  657. if(!currentDataSet)
  658. return UA_STATUSCODE_BADNOTFOUND;
  659. /* Prepare DataSetMessageContent */
  660. dataSetMessage->header.dataSetMessageValid = true;
  661. dataSetMessage->header.dataSetMessageType = UA_DATASETMESSAGE_DATAKEYFRAME;
  662. dataSetMessage->data.keyFrameData.fieldCount = currentDataSet->fieldSize;
  663. dataSetMessage->data.keyFrameData.dataSetFields = (UA_DataValue *)
  664. UA_Array_new(currentDataSet->fieldSize, &UA_TYPES[UA_TYPES_DATAVALUE]);
  665. if(!dataSetMessage->data.keyFrameData.dataSetFields)
  666. return UA_STATUSCODE_BADOUTOFMEMORY;
  667. /* Loop over the fields */
  668. size_t counter = 0;
  669. UA_DataSetField *dsf;
  670. LIST_FOREACH(dsf, &currentDataSet->fields, listEntry) {
  671. /* Sample the value */
  672. UA_DataValue *dfv = &dataSetMessage->data.keyFrameData.dataSetFields[counter];
  673. UA_PubSubDataSetField_sampleValue(server, dsf, dfv);
  674. /* Deactivate statuscode? */
  675. if((dataSetWriter->config.dataSetFieldContentMask & UA_DATASETFIELDCONTENTMASK_STATUSCODE) == 0)
  676. dfv->hasStatus = false;
  677. /* Deactivate timestamps */
  678. if((dataSetWriter->config.dataSetFieldContentMask & UA_DATASETFIELDCONTENTMASK_SOURCETIMESTAMP) == 0)
  679. dfv->hasSourceTimestamp = false;
  680. if((dataSetWriter->config.dataSetFieldContentMask & UA_DATASETFIELDCONTENTMASK_SOURCEPICOSECONDS) == 0)
  681. dfv->hasSourcePicoseconds = false;
  682. if((dataSetWriter->config.dataSetFieldContentMask & UA_DATASETFIELDCONTENTMASK_SERVERTIMESTAMP) == 0)
  683. dfv->hasServerTimestamp = false;
  684. if((dataSetWriter->config.dataSetFieldContentMask & UA_DATASETFIELDCONTENTMASK_SERVERPICOSECONDS) == 0)
  685. dfv->hasServerPicoseconds = false;
  686. #ifdef UA_ENABLE_PUBSUB_DELTAFRAMES
  687. /* Update lastValue store */
  688. UA_DataValue_deleteMembers(&dataSetWriter->lastSamples[counter].value);
  689. UA_DataValue_copy(dfv, &dataSetWriter->lastSamples[counter].value);
  690. #endif
  691. counter++;
  692. }
  693. return UA_STATUSCODE_GOOD;
  694. }
  695. #ifdef UA_ENABLE_PUBSUB_DELTAFRAMES
  696. static UA_StatusCode
  697. UA_PubSubDataSetWriter_generateDeltaFrameMessage(UA_Server *server,
  698. UA_DataSetMessage *dataSetMessage,
  699. UA_DataSetWriter *dataSetWriter) {
  700. UA_PublishedDataSet *currentDataSet =
  701. UA_PublishedDataSet_findPDSbyId(server, dataSetWriter->connectedDataSet);
  702. if(!currentDataSet)
  703. return UA_STATUSCODE_BADNOTFOUND;
  704. /* Prepare DataSetMessageContent */
  705. memset(dataSetMessage, 0, sizeof(UA_DataSetMessage));
  706. dataSetMessage->header.dataSetMessageValid = true;
  707. dataSetMessage->header.dataSetMessageType = UA_DATASETMESSAGE_DATADELTAFRAME;
  708. UA_DataSetField *dsf;
  709. size_t counter = 0;
  710. LIST_FOREACH(dsf, &currentDataSet->fields, listEntry) {
  711. /* Sample the value */
  712. UA_DataValue value;
  713. UA_DataValue_init(&value);
  714. UA_PubSubDataSetField_sampleValue(server, dsf, &value);
  715. /* Check if the value has changed */
  716. if(valueChangedVariant(&dataSetWriter->lastSamples[counter].value.value, &value.value)) {
  717. /* increase fieldCount for current delta message */
  718. dataSetMessage->data.deltaFrameData.fieldCount++;
  719. dataSetWriter->lastSamples[counter].valueChanged = true;
  720. /* Update last stored sample */
  721. UA_DataValue_deleteMembers(&dataSetWriter->lastSamples[counter].value);
  722. dataSetWriter->lastSamples[counter].value = value;
  723. } else {
  724. UA_DataValue_deleteMembers(&value);
  725. dataSetWriter->lastSamples[counter].valueChanged = false;
  726. }
  727. counter++;
  728. }
  729. /* Allocate DeltaFrameFields */
  730. UA_DataSetMessage_DeltaFrameField *deltaFields = (UA_DataSetMessage_DeltaFrameField *)
  731. UA_calloc(dataSetMessage->data.deltaFrameData.fieldCount, sizeof(UA_DataSetMessage_DeltaFrameField));
  732. if(!deltaFields)
  733. return UA_STATUSCODE_BADOUTOFMEMORY;
  734. dataSetMessage->data.deltaFrameData.deltaFrameFields = deltaFields;
  735. size_t currentDeltaField = 0;
  736. for(size_t i = 0; i < currentDataSet->fieldSize; i++) {
  737. if(!dataSetWriter->lastSamples[i].valueChanged)
  738. continue;
  739. UA_DataSetMessage_DeltaFrameField *dff = &deltaFields[currentDeltaField];
  740. dff->fieldIndex = (UA_UInt16) i;
  741. UA_DataValue_copy(&dataSetWriter->lastSamples[i].value, &dff->fieldValue);
  742. dataSetWriter->lastSamples[i].valueChanged = false;
  743. /* Deactivate statuscode? */
  744. if((dataSetWriter->config.dataSetFieldContentMask & UA_DATASETFIELDCONTENTMASK_STATUSCODE) == 0)
  745. dff->fieldValue.hasStatus = false;
  746. /* Deactivate timestamps? */
  747. if((dataSetWriter->config.dataSetFieldContentMask & UA_DATASETFIELDCONTENTMASK_SOURCETIMESTAMP) == 0)
  748. dff->fieldValue.hasSourceTimestamp = false;
  749. if((dataSetWriter->config.dataSetFieldContentMask & UA_DATASETFIELDCONTENTMASK_SOURCEPICOSECONDS) == 0)
  750. dff->fieldValue.hasServerPicoseconds = false;
  751. if((dataSetWriter->config.dataSetFieldContentMask & UA_DATASETFIELDCONTENTMASK_SERVERTIMESTAMP) == 0)
  752. dff->fieldValue.hasServerTimestamp = false;
  753. if((dataSetWriter->config.dataSetFieldContentMask & UA_DATASETFIELDCONTENTMASK_SERVERPICOSECONDS) == 0)
  754. dff->fieldValue.hasServerPicoseconds = false;
  755. currentDeltaField++;
  756. }
  757. return UA_STATUSCODE_GOOD;
  758. }
  759. #endif
  760. /**
  761. * Generate a DataSetMessage for the given writer.
  762. *
  763. * @param dataSetWriter ptr to corresponding writer
  764. * @return ptr to generated DataSetMessage
  765. */
  766. static UA_StatusCode
  767. UA_DataSetWriter_generateDataSetMessage(UA_Server *server, UA_DataSetMessage *dataSetMessage,
  768. UA_DataSetWriter *dataSetWriter) {
  769. UA_PublishedDataSet *currentDataSet =
  770. UA_PublishedDataSet_findPDSbyId(server, dataSetWriter->connectedDataSet);
  771. if(!currentDataSet)
  772. return UA_STATUSCODE_BADNOTFOUND;
  773. /* Reset the message */
  774. memset(dataSetMessage, 0, sizeof(UA_DataSetMessage));
  775. /* Currently is only UADP supported. The configuration Flags are included
  776. * inside the std. defined UA_UadpDataSetWriterMessageDataType */
  777. UA_UadpDataSetWriterMessageDataType defaultUadpConfiguration;
  778. UA_UadpDataSetWriterMessageDataType *dataSetWriterMessageDataType = NULL;
  779. if((dataSetWriter->config.messageSettings.encoding == UA_EXTENSIONOBJECT_DECODED ||
  780. dataSetWriter->config.messageSettings.encoding == UA_EXTENSIONOBJECT_DECODED_NODELETE) &&
  781. (dataSetWriter->config.messageSettings.content.decoded.type == &UA_TYPES[UA_TYPES_UADPDATASETWRITERMESSAGEDATATYPE])) {
  782. dataSetWriterMessageDataType = (UA_UadpDataSetWriterMessageDataType *)
  783. dataSetWriter->config.messageSettings.content.decoded.data;
  784. } else {
  785. /* create default flag configuration if no
  786. * UadpDataSetWriterMessageDataType was passed in */
  787. memset(&defaultUadpConfiguration, 0, sizeof(UA_UadpDataSetWriterMessageDataType));
  788. defaultUadpConfiguration.dataSetMessageContentMask = (UA_UadpDataSetMessageContentMask)
  789. (UA_UADPDATASETMESSAGECONTENTMASK_TIMESTAMP | UA_UADPDATASETMESSAGECONTENTMASK_MAJORVERSION |
  790. UA_UADPDATASETMESSAGECONTENTMASK_MINORVERSION);
  791. dataSetWriterMessageDataType = &defaultUadpConfiguration;
  792. }
  793. /* Sanity-test the configuration */
  794. if(dataSetWriterMessageDataType->networkMessageNumber != 0 ||
  795. dataSetWriterMessageDataType->dataSetOffset != 0 ||
  796. dataSetWriterMessageDataType->configuredSize !=0 ) {
  797. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  798. "Static DSM configuration not supported. Using defaults");
  799. dataSetWriterMessageDataType->networkMessageNumber = 0;
  800. dataSetWriterMessageDataType->dataSetOffset = 0;
  801. dataSetWriterMessageDataType->configuredSize = 0;
  802. }
  803. /* The field encoding depends on the flags inside the writer config.
  804. * TODO: This can be moved to the encoding layer. */
  805. if(dataSetWriter->config.dataSetFieldContentMask & UA_DATASETFIELDCONTENTMASK_RAWDATAENCODING) {
  806. dataSetMessage->header.fieldEncoding = UA_FIELDENCODING_RAWDATA;
  807. } else if (dataSetWriter->config.dataSetFieldContentMask &
  808. (UA_DATASETFIELDCONTENTMASK_SOURCETIMESTAMP | UA_DATASETFIELDCONTENTMASK_SERVERPICOSECONDS |
  809. UA_DATASETFIELDCONTENTMASK_SOURCEPICOSECONDS | UA_DATASETFIELDCONTENTMASK_STATUSCODE)) {
  810. dataSetMessage->header.fieldEncoding = UA_FIELDENCODING_DATAVALUE;
  811. } else {
  812. dataSetMessage->header.fieldEncoding = UA_FIELDENCODING_VARIANT;
  813. }
  814. /* Std: 'The DataSetMessageContentMask defines the flags for the content of the DataSetMessage header.' */
  815. if(dataSetWriterMessageDataType->dataSetMessageContentMask & UA_UADPDATASETMESSAGECONTENTMASK_MAJORVERSION){
  816. dataSetMessage->header.configVersionMajorVersionEnabled = true;
  817. dataSetMessage->header.configVersionMajorVersion =
  818. currentDataSet->dataSetMetaData.configurationVersion.majorVersion;
  819. }
  820. if(dataSetWriterMessageDataType->dataSetMessageContentMask & UA_UADPDATASETMESSAGECONTENTMASK_MINORVERSION){
  821. dataSetMessage->header.configVersionMinorVersionEnabled = true;
  822. dataSetMessage->header.configVersionMinorVersion =
  823. currentDataSet->dataSetMetaData.configurationVersion.minorVersion;
  824. }
  825. if(dataSetWriterMessageDataType->dataSetMessageContentMask & UA_UADPDATASETMESSAGECONTENTMASK_SEQUENCENUMBER) {
  826. dataSetMessage->header.dataSetMessageSequenceNrEnabled = true;
  827. dataSetMessage->header.dataSetMessageSequenceNr =
  828. dataSetWriter->actualDataSetMessageSequenceCount;
  829. }
  830. if(dataSetWriterMessageDataType->dataSetMessageContentMask & UA_UADPDATASETMESSAGECONTENTMASK_TIMESTAMP) {
  831. dataSetMessage->header.timestampEnabled = true;
  832. dataSetMessage->header.timestamp = UA_DateTime_now();
  833. }
  834. /* TODO: Picoseconds resolution not supported atm */
  835. if(dataSetWriterMessageDataType->dataSetMessageContentMask & UA_UADPDATASETMESSAGECONTENTMASK_PICOSECONDS) {
  836. dataSetMessage->header.picoSecondsIncluded = false;
  837. }
  838. /* TODO: Statuscode not supported yet */
  839. if(dataSetWriterMessageDataType->dataSetMessageContentMask & UA_UADPDATASETMESSAGECONTENTMASK_STATUS){
  840. dataSetMessage->header.statusEnabled = false;
  841. }
  842. /* Set the sequence count. Automatically rolls over to zero */
  843. dataSetWriter->actualDataSetMessageSequenceCount++;
  844. #ifdef UA_ENABLE_PUBSUB_DELTAFRAMES
  845. /* Check if the PublishedDataSet version has changed -> if yes flush the lastValue store and send a KeyFrame */
  846. if(dataSetWriter->connectedDataSetVersion.majorVersion != currentDataSet->dataSetMetaData.configurationVersion.majorVersion ||
  847. dataSetWriter->connectedDataSetVersion.minorVersion != currentDataSet->dataSetMetaData.configurationVersion.minorVersion) {
  848. /* Remove old samples */
  849. for(size_t i = 0; i < dataSetWriter->lastSamplesCount; i++)
  850. UA_DataValue_deleteMembers(&dataSetWriter->lastSamples[i].value);
  851. /* Realloc pds dependent memory */
  852. dataSetWriter->lastSamplesCount = currentDataSet->fieldSize;
  853. UA_DataSetWriterSample *newSamplesArray = (UA_DataSetWriterSample * )
  854. UA_realloc(dataSetWriter->lastSamples, sizeof(UA_DataSetWriterSample) * dataSetWriter->lastSamplesCount);
  855. if(!newSamplesArray)
  856. return UA_STATUSCODE_BADOUTOFMEMORY;
  857. dataSetWriter->lastSamples = newSamplesArray;
  858. memset(dataSetWriter->lastSamples, 0, sizeof(UA_DataSetWriterSample) * dataSetWriter->lastSamplesCount);
  859. dataSetWriter->connectedDataSetVersion = currentDataSet->dataSetMetaData.configurationVersion;
  860. UA_PubSubDataSetWriter_generateKeyFrameMessage(server, dataSetMessage, dataSetWriter);
  861. dataSetWriter->deltaFrameCounter = 0;
  862. return UA_STATUSCODE_GOOD;
  863. }
  864. /* The standard defines: if a PDS contains only one fields no delta messages
  865. * should be generated because they need more memory than a keyframe with 1
  866. * field. */
  867. if(currentDataSet->fieldSize > 1 && dataSetWriter->deltaFrameCounter > 0 &&
  868. dataSetWriter->deltaFrameCounter <= dataSetWriter->config.keyFrameCount) {
  869. UA_PubSubDataSetWriter_generateDeltaFrameMessage(server, dataSetMessage, dataSetWriter);
  870. dataSetWriter->deltaFrameCounter++;
  871. return UA_STATUSCODE_GOOD;
  872. }
  873. dataSetWriter->deltaFrameCounter = 1;
  874. #endif
  875. UA_PubSubDataSetWriter_generateKeyFrameMessage(server, dataSetMessage, dataSetWriter);
  876. return UA_STATUSCODE_GOOD;
  877. }
  878. /*
  879. * This callback triggers the collection and publish of NetworkMessages and the contained DataSetMessages.
  880. */
  881. void
  882. UA_WriterGroup_publishCallback(UA_Server *server, UA_WriterGroup *writerGroup) {
  883. if(!writerGroup) {
  884. UA_LOG_ERROR(&server->config.logger, UA_LOGCATEGORY_SERVER,
  885. "Publish failed. WriterGroup not found");
  886. return;
  887. }
  888. if(writerGroup->writersCount <= 0)
  889. return;
  890. if(writerGroup->config.encodingMimeType != UA_PUBSUB_ENCODING_UADP) {
  891. UA_LOG_ERROR(&server->config.logger, UA_LOGCATEGORY_SERVER, "Unknown encoding type.");
  892. return;
  893. }
  894. UA_PubSubConnection *connection = UA_PubSubConnection_findConnectionbyId(server, writerGroup->linkedConnection);
  895. if(!connection) {
  896. UA_LOG_ERROR(&server->config.logger, UA_LOGCATEGORY_SERVER,
  897. "Publish failed. PubSubConnection invalid.");
  898. return;
  899. }
  900. //prevent error if the maxEncapsulatedDataSetMessageCount is set to 0->1
  901. writerGroup->config.maxEncapsulatedDataSetMessageCount = (UA_UInt16) (writerGroup->config.maxEncapsulatedDataSetMessageCount == 0 ||
  902. writerGroup->config.maxEncapsulatedDataSetMessageCount > UA_BYTE_MAX
  903. ? 1 : writerGroup->config.maxEncapsulatedDataSetMessageCount);
  904. UA_DataSetMessage *dsmStore = (UA_DataSetMessage *) UA_calloc(writerGroup->writersCount, sizeof(UA_DataSetMessage));
  905. if(!dsmStore) {
  906. UA_LOG_ERROR(&server->config.logger, UA_LOGCATEGORY_SERVER,
  907. "DataSetMessage allocation failed");
  908. return;
  909. }
  910. memset(dsmStore, 0, sizeof(UA_DataSetMessage) * writerGroup->writersCount);
  911. //The binary DataSetMessage sizes are part of the payload. Memory is allocated on the stack.
  912. UA_STACKARRAY(UA_UInt16, dsmSizes, writerGroup->writersCount);
  913. UA_STACKARRAY(UA_UInt16, dsWriterIds, writerGroup->writersCount);
  914. memset(dsmSizes, 0, writerGroup->writersCount * sizeof(UA_UInt16));
  915. memset(dsWriterIds, 0, writerGroup->writersCount * sizeof(UA_UInt16));
  916. /*
  917. * Calculate the number of needed NetworkMessages. The previous allocated DataSetMessage array is
  918. * filled from left for combined DSM messages and from the right for single DSM.
  919. * Allocated DSM Array
  920. * +----------------------------+
  921. * |DSM1||DSM2||DSM3||DSM4||DSM5|
  922. * +--+----+-----+-----+-----+--+
  923. * | | | | |
  924. * | | | | |
  925. * +--v----v-----v-----v--+--v--+
  926. * | NM1 || NM2 | NM3 |
  927. * +----------------------+-----+
  928. * NetworkMessages
  929. */
  930. UA_UInt16 combinedNetworkMessageCount = 0, singleNetworkMessagesCount = 0;
  931. UA_DataSetWriter *tmpDataSetWriter;
  932. LIST_FOREACH(tmpDataSetWriter, &writerGroup->writers, listEntry){
  933. //if promoted fields are contained in the PublishedDataSet, then this DSM must encapsulated in one NM
  934. UA_PublishedDataSet *tmpPublishedDataSet = UA_PublishedDataSet_findPDSbyId(server, tmpDataSetWriter->connectedDataSet);
  935. if(!tmpPublishedDataSet) {
  936. UA_LOG_ERROR(&server->config.logger, UA_LOGCATEGORY_SERVER,
  937. "Publish failed. PublishedDataSet not found");
  938. return;
  939. }
  940. if(tmpPublishedDataSet->promotedFieldsCount > 0) {
  941. if(UA_DataSetWriter_generateDataSetMessage(server, &dsmStore[(writerGroup->writersCount - 1) - singleNetworkMessagesCount],
  942. tmpDataSetWriter) != UA_STATUSCODE_GOOD){
  943. UA_LOG_ERROR(&server->config.logger, UA_LOGCATEGORY_SERVER,
  944. "Publish failed. DataSetMessage creation failed");
  945. return;
  946. };
  947. dsWriterIds[(writerGroup->writersCount - 1) - singleNetworkMessagesCount] = tmpDataSetWriter->config.dataSetWriterId;
  948. dsmSizes[(writerGroup->writersCount-1) - singleNetworkMessagesCount] = (UA_UInt16) UA_DataSetMessage_calcSizeBinary(&dsmStore[(writerGroup->writersCount-1)
  949. - singleNetworkMessagesCount]);
  950. singleNetworkMessagesCount++;
  951. } else {
  952. if(UA_DataSetWriter_generateDataSetMessage(server, &dsmStore[combinedNetworkMessageCount], tmpDataSetWriter) != UA_STATUSCODE_GOOD){
  953. UA_LOG_ERROR(&server->config.logger, UA_LOGCATEGORY_SERVER,
  954. "Publish failed. DataSetMessage creation failed");
  955. return;
  956. };
  957. dsWriterIds[combinedNetworkMessageCount] = tmpDataSetWriter->config.dataSetWriterId;
  958. dsmSizes[combinedNetworkMessageCount] = (UA_UInt16) UA_DataSetMessage_calcSizeBinary(&dsmStore[combinedNetworkMessageCount]);
  959. combinedNetworkMessageCount++;
  960. }
  961. }
  962. UA_UInt32 networkMessageCount = singleNetworkMessagesCount;
  963. if(combinedNetworkMessageCount != 0){
  964. combinedNetworkMessageCount = (UA_UInt16) (
  965. combinedNetworkMessageCount / writerGroup->config.maxEncapsulatedDataSetMessageCount +
  966. (combinedNetworkMessageCount % writerGroup->config.maxEncapsulatedDataSetMessageCount) == 0 ? 0 : 1);
  967. networkMessageCount += combinedNetworkMessageCount;
  968. }
  969. if(networkMessageCount < 1){
  970. for(size_t i = 0; i < writerGroup->writersCount; i++){
  971. UA_DataSetMessage_free(&dsmStore[i]);
  972. }
  973. UA_free(dsmStore);
  974. return;
  975. }
  976. //Alloc memory for the NetworkMessages on the stack
  977. UA_STACKARRAY(UA_NetworkMessage, nmStore, networkMessageCount);
  978. memset(nmStore, 0, networkMessageCount * sizeof(UA_NetworkMessage));
  979. UA_UInt32 currentDSMPosition = 0;
  980. for(UA_UInt32 i = 0; i < networkMessageCount; i++) {
  981. nmStore[i].version = 1;
  982. nmStore[i].networkMessageType = UA_NETWORKMESSAGE_DATASET;
  983. nmStore[i].payloadHeaderEnabled = true;
  984. //create combined NetworkMessages
  985. if(i < (networkMessageCount-singleNetworkMessagesCount)){
  986. if(combinedNetworkMessageCount - (i * writerGroup->config.maxEncapsulatedDataSetMessageCount)){
  987. if(combinedNetworkMessageCount == 1){
  988. nmStore[i].payloadHeader.dataSetPayloadHeader.count = (UA_Byte) ((writerGroup->writersCount) - singleNetworkMessagesCount);
  989. currentDSMPosition = 0;
  990. } else {
  991. nmStore[i].payloadHeader.dataSetPayloadHeader.count = (UA_Byte) writerGroup->config.maxEncapsulatedDataSetMessageCount;
  992. currentDSMPosition = i * writerGroup->config.maxEncapsulatedDataSetMessageCount;
  993. }
  994. //nmStore[i].payloadHeader.dataSetPayloadHeader.count = (UA_Byte) writerGroup->config.maxEncapsulatedDataSetMessageCount;
  995. nmStore[i].payload.dataSetPayload.dataSetMessages = &dsmStore[currentDSMPosition];
  996. nmStore->payload.dataSetPayload.sizes = &dsmSizes[currentDSMPosition];
  997. nmStore->payloadHeader.dataSetPayloadHeader.dataSetWriterIds = &dsWriterIds[currentDSMPosition];
  998. } else {
  999. currentDSMPosition = i * writerGroup->config.maxEncapsulatedDataSetMessageCount;
  1000. nmStore[i].payloadHeader.dataSetPayloadHeader.count = (UA_Byte) (currentDSMPosition - ((i - 1) * writerGroup->config.maxEncapsulatedDataSetMessageCount)); //attention cast from uint32 to byte
  1001. nmStore[i].payload.dataSetPayload.dataSetMessages = &dsmStore[currentDSMPosition];
  1002. nmStore->payload.dataSetPayload.sizes = &dsmSizes[currentDSMPosition];
  1003. nmStore->payloadHeader.dataSetPayloadHeader.dataSetWriterIds = &dsWriterIds[currentDSMPosition];
  1004. }
  1005. } else {///create single NetworkMessages (1 DSM per NM)
  1006. nmStore[i].payloadHeader.dataSetPayloadHeader.count = 1;
  1007. currentDSMPosition = (UA_UInt32) combinedNetworkMessageCount + (i - combinedNetworkMessageCount/writerGroup->config.maxEncapsulatedDataSetMessageCount
  1008. + (combinedNetworkMessageCount % writerGroup->config.maxEncapsulatedDataSetMessageCount) == 0 ? 0 : 1);
  1009. nmStore[i].payload.dataSetPayload.dataSetMessages = &dsmStore[currentDSMPosition];
  1010. nmStore->payload.dataSetPayload.sizes = &dsmSizes[currentDSMPosition];
  1011. nmStore->payloadHeader.dataSetPayloadHeader.dataSetWriterIds = &dsWriterIds[currentDSMPosition];
  1012. }
  1013. //send the prepared messages
  1014. UA_ByteString buf;
  1015. size_t msgSize = UA_NetworkMessage_calcSizeBinary(&nmStore[i]);
  1016. if(UA_ByteString_allocBuffer(&buf, msgSize) == UA_STATUSCODE_GOOD) {
  1017. UA_Byte *bufPos = buf.data;
  1018. memset(bufPos, 0, msgSize);
  1019. const UA_Byte *bufEnd = &(buf.data[buf.length]);
  1020. if(UA_NetworkMessage_encodeBinary(&nmStore[i], &bufPos, bufEnd) != UA_STATUSCODE_GOOD){
  1021. UA_ByteString_deleteMembers(&buf);
  1022. return;
  1023. };
  1024. connection->channel->send(connection->channel, NULL, &buf);
  1025. }
  1026. //The stack allocated sizes and dataSetWriterIds field must be set to NULL to prevent invalid free.
  1027. nmStore[i].payload.dataSetPayload.sizes = NULL;
  1028. nmStore->payloadHeader.dataSetPayloadHeader.dataSetWriterIds = NULL;
  1029. UA_ByteString_deleteMembers(&buf);
  1030. UA_NetworkMessage_deleteMembers(&nmStore[i]);
  1031. }
  1032. }
  1033. /*
  1034. * Add new publishCallback. The first execution is triggered directly after creation.
  1035. * @Warning - The duration (double) is currently casted to int. -> intervals smaller 1ms are not possible.
  1036. */
  1037. UA_StatusCode
  1038. UA_WriterGroup_addPublishCallback(UA_Server *server, UA_WriterGroup *writerGroup) {
  1039. UA_StatusCode retval =
  1040. UA_PubSubManager_addRepeatedCallback(server, (UA_ServerCallback) UA_WriterGroup_publishCallback,
  1041. writerGroup, writerGroup->config.publishingInterval,
  1042. &writerGroup->publishCallbackId);
  1043. if(retval == UA_STATUSCODE_GOOD)
  1044. writerGroup->publishCallbackIsRegistered = true;
  1045. //run once after creation
  1046. UA_WriterGroup_publishCallback(server, writerGroup);
  1047. return retval;
  1048. }
  1049. #endif /* UA_ENABLE_PUBSUB */