ua_pubsub.c 53 KB

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