ua_pubsub.c 56 KB

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