ua_pubsub.c 53 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167
  1. /* This Source Code Form is subject to the terms of the Mozilla Public
  2. * License, v. 2.0. If a copy of the MPL was not distributed with this
  3. * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  4. *
  5. * Copyright (c) 2017-2018 Fraunhofer IOSB (Author: Andreas Ebner)
  6. */
  7. #include "server/ua_server_internal.h"
  8. #include "ua_types_encoding_binary.h"
  9. #ifdef UA_ENABLE_PUBSUB /* conditional compilation */
  10. #include "ua_server_pubsub.h"
  11. #include "ua_pubsub.h"
  12. #include "ua_pubsub_manager.h"
  13. #include "ua_pubsub_networkmessage.h"
  14. #ifdef UA_ENABLE_PUBSUB_INFORMATIONMODEL
  15. #include "ua_pubsub_ns0.h"
  16. #endif
  17. /* Forward declaration */
  18. static void
  19. UA_WriterGroup_deleteMembers(UA_Server *server, UA_WriterGroup *writerGroup);
  20. static void
  21. UA_DataSetField_deleteMembers(UA_DataSetField *field);
  22. /**********************************************/
  23. /* Connection */
  24. /**********************************************/
  25. UA_StatusCode
  26. UA_PubSubConnectionConfig_copy(const UA_PubSubConnectionConfig *src,
  27. UA_PubSubConnectionConfig *dst) {
  28. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  29. memcpy(dst, src, sizeof(UA_PubSubConnectionConfig));
  30. retVal |= UA_String_copy(&src->name, &dst->name);
  31. retVal |= UA_Variant_copy(&src->address, &dst->address);
  32. retVal |= UA_String_copy(&src->transportProfileUri, &dst->transportProfileUri);
  33. retVal |= UA_Variant_copy(&src->connectionTransportSettings, &dst->connectionTransportSettings);
  34. if(src->connectionPropertiesSize > 0){
  35. dst->connectionProperties = (UA_KeyValuePair *)
  36. UA_calloc(src->connectionPropertiesSize, sizeof(UA_KeyValuePair));
  37. if(!dst->connectionProperties){
  38. return UA_STATUSCODE_BADOUTOFMEMORY;
  39. }
  40. for(size_t i = 0; i < src->connectionPropertiesSize; i++){
  41. retVal |= UA_QualifiedName_copy(&src->connectionProperties[i].key,
  42. &dst->connectionProperties[i].key);
  43. retVal |= UA_Variant_copy(&src->connectionProperties[i].value,
  44. &dst->connectionProperties[i].value);
  45. }
  46. }
  47. return retVal;
  48. }
  49. UA_StatusCode
  50. UA_Server_getPubSubConnectionConfig(UA_Server *server, const UA_NodeId connection,
  51. UA_PubSubConnectionConfig *config) {
  52. if(!config)
  53. return UA_STATUSCODE_BADINVALIDARGUMENT;
  54. UA_PubSubConnection *currentPubSubConnection =
  55. UA_PubSubConnection_findConnectionbyId(server, connection);
  56. if(!currentPubSubConnection)
  57. return UA_STATUSCODE_BADNOTFOUND;
  58. UA_PubSubConnectionConfig tmpPubSubConnectionConfig;
  59. //deep copy of the actual config
  60. UA_PubSubConnectionConfig_copy(currentPubSubConnection->config, &tmpPubSubConnectionConfig);
  61. *config = tmpPubSubConnectionConfig;
  62. return UA_STATUSCODE_GOOD;
  63. }
  64. UA_PubSubConnection *
  65. UA_PubSubConnection_findConnectionbyId(UA_Server *server, UA_NodeId connectionIdentifier) {
  66. for(size_t i = 0; i < server->pubSubManager.connectionsSize; i++){
  67. if(UA_NodeId_equal(&connectionIdentifier, &server->pubSubManager.connections[i].identifier)){
  68. return &server->pubSubManager.connections[i];
  69. }
  70. }
  71. return NULL;
  72. }
  73. void
  74. UA_PubSubConnectionConfig_deleteMembers(UA_PubSubConnectionConfig *connectionConfig) {
  75. UA_String_deleteMembers(&connectionConfig->name);
  76. UA_String_deleteMembers(&connectionConfig->transportProfileUri);
  77. UA_Variant_deleteMembers(&connectionConfig->connectionTransportSettings);
  78. UA_Variant_deleteMembers(&connectionConfig->address);
  79. for(size_t i = 0; i < connectionConfig->connectionPropertiesSize; i++){
  80. UA_QualifiedName_deleteMembers(&connectionConfig->connectionProperties[i].key);
  81. UA_Variant_deleteMembers(&connectionConfig->connectionProperties[i].value);
  82. }
  83. UA_free(connectionConfig->connectionProperties);
  84. }
  85. void
  86. UA_PubSubConnection_deleteMembers(UA_Server *server, UA_PubSubConnection *connection) {
  87. //delete connection config
  88. UA_PubSubConnectionConfig_deleteMembers(connection->config);
  89. //remove contained WriterGroups
  90. UA_WriterGroup *writerGroup, *tmpWriterGroup;
  91. LIST_FOREACH_SAFE(writerGroup, &connection->writerGroups, listEntry, tmpWriterGroup){
  92. UA_Server_removeWriterGroup(server, writerGroup->identifier);
  93. }
  94. UA_NodeId_deleteMembers(&connection->identifier);
  95. if(connection->channel){
  96. connection->channel->close(connection->channel);
  97. }
  98. UA_free(connection->config);
  99. }
  100. UA_StatusCode
  101. UA_Server_addWriterGroup(UA_Server *server, const UA_NodeId connection,
  102. const UA_WriterGroupConfig *writerGroupConfig,
  103. UA_NodeId *writerGroupIdentifier) {
  104. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  105. if(!writerGroupConfig)
  106. return UA_STATUSCODE_BADINVALIDARGUMENT;
  107. //search the connection by the given connectionIdentifier
  108. UA_PubSubConnection *currentConnectionContext =
  109. UA_PubSubConnection_findConnectionbyId(server, connection);
  110. if(!currentConnectionContext)
  111. return UA_STATUSCODE_BADNOTFOUND;
  112. //allocate memory for new WriterGroup
  113. UA_WriterGroup *newWriterGroup = (UA_WriterGroup *) UA_calloc(1, sizeof(UA_WriterGroup));
  114. if (!newWriterGroup)
  115. return UA_STATUSCODE_BADOUTOFMEMORY;
  116. newWriterGroup->linkedConnection = currentConnectionContext->identifier;
  117. UA_PubSubManager_generateUniqueNodeId(server, &newWriterGroup->identifier);
  118. if(writerGroupIdentifier){
  119. UA_NodeId_copy(&newWriterGroup->identifier, writerGroupIdentifier);
  120. }
  121. UA_WriterGroupConfig tmpWriterGroupConfig;
  122. //deep copy of the config
  123. retVal |= UA_WriterGroupConfig_copy(writerGroupConfig, &tmpWriterGroupConfig);
  124. newWriterGroup->config = tmpWriterGroupConfig;
  125. retVal |= UA_WriterGroup_addPublishCallback(server, newWriterGroup);
  126. LIST_INSERT_HEAD(&currentConnectionContext->writerGroups, newWriterGroup, listEntry);
  127. #ifdef UA_ENABLE_PUBSUB_INFORMATIONMODEL
  128. addWriterGroupRepresentation(server, newWriterGroup);
  129. #endif
  130. return retVal;
  131. }
  132. UA_StatusCode
  133. UA_Server_removeWriterGroup(UA_Server *server, const UA_NodeId writerGroup){
  134. UA_WriterGroup *wg = UA_WriterGroup_findWGbyId(server, writerGroup);
  135. if(!wg)
  136. return UA_STATUSCODE_BADNOTFOUND;
  137. UA_PubSubConnection *connection =
  138. UA_PubSubConnection_findConnectionbyId(server, wg->linkedConnection);
  139. if(!connection)
  140. return UA_STATUSCODE_BADNOTFOUND;
  141. //unregister the publish callback
  142. if(UA_PubSubManager_removeRepeatedPubSubCallback(server, wg->publishCallbackId) != UA_STATUSCODE_GOOD)
  143. return UA_STATUSCODE_BADINTERNALERROR;
  144. #ifdef UA_ENABLE_PUBSUB_INFORMATIONMODEL
  145. removeWriterGroupRepresentation(server, wg);
  146. #endif
  147. UA_WriterGroup_deleteMembers(server, wg);
  148. LIST_REMOVE(wg, listEntry);
  149. UA_free(wg);
  150. return UA_STATUSCODE_GOOD;
  151. }
  152. /**********************************************/
  153. /* PublishedDataSet */
  154. /**********************************************/
  155. UA_StatusCode
  156. UA_PublishedDataSetConfig_copy(const UA_PublishedDataSetConfig *src,
  157. UA_PublishedDataSetConfig *dst) {
  158. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  159. memcpy(dst, src, sizeof(UA_PublishedDataSetConfig));
  160. retVal |= UA_String_copy(&src->name, &dst->name);
  161. switch(src->publishedDataSetType){
  162. case UA_PUBSUB_DATASET_PUBLISHEDITEMS:
  163. //no additional items
  164. break;
  165. case UA_PUBSUB_DATASET_PUBLISHEDITEMS_TEMPLATE:
  166. if (src->config.itemsTemplate.variablesToAddSize > 0){
  167. dst->config.itemsTemplate.variablesToAdd = (UA_PublishedVariableDataType *) UA_calloc(
  168. src->config.itemsTemplate.variablesToAddSize, sizeof(UA_PublishedVariableDataType));
  169. }
  170. for(size_t i = 0; i < src->config.itemsTemplate.variablesToAddSize; i++){
  171. retVal |= UA_PublishedVariableDataType_copy(&src->config.itemsTemplate.variablesToAdd[i],
  172. &dst->config.itemsTemplate.variablesToAdd[i]);
  173. }
  174. retVal |= UA_DataSetMetaDataType_copy(&src->config.itemsTemplate.metaData,
  175. &dst->config.itemsTemplate.metaData);
  176. break;
  177. default:
  178. return UA_STATUSCODE_BADINVALIDARGUMENT;
  179. }
  180. return retVal;
  181. }
  182. UA_StatusCode
  183. UA_Server_getPublishedDataSetConfig(UA_Server *server, const UA_NodeId pds,
  184. UA_PublishedDataSetConfig *config){
  185. if(!config)
  186. return UA_STATUSCODE_BADINVALIDARGUMENT;
  187. UA_PublishedDataSet *currentPublishedDataSet = UA_PublishedDataSet_findPDSbyId(server, pds);
  188. if(!currentPublishedDataSet)
  189. return UA_STATUSCODE_BADNOTFOUND;
  190. UA_PublishedDataSetConfig tmpPublishedDataSetConfig;
  191. //deep copy of the actual config
  192. UA_PublishedDataSetConfig_copy(&currentPublishedDataSet->config, &tmpPublishedDataSetConfig);
  193. *config = tmpPublishedDataSetConfig;
  194. return UA_STATUSCODE_GOOD;
  195. }
  196. UA_PublishedDataSet *
  197. UA_PublishedDataSet_findPDSbyId(UA_Server *server, UA_NodeId identifier){
  198. for(size_t i = 0; i < server->pubSubManager.publishedDataSetsSize; i++){
  199. if(UA_NodeId_equal(&server->pubSubManager.publishedDataSets[i].identifier, &identifier)){
  200. return &server->pubSubManager.publishedDataSets[i];
  201. }
  202. }
  203. return NULL;
  204. }
  205. void
  206. UA_PublishedDataSetConfig_deleteMembers(UA_PublishedDataSetConfig *pdsConfig){
  207. //delete pds config
  208. UA_String_deleteMembers(&pdsConfig->name);
  209. switch (pdsConfig->publishedDataSetType){
  210. case UA_PUBSUB_DATASET_PUBLISHEDITEMS:
  211. //no additional items
  212. break;
  213. case UA_PUBSUB_DATASET_PUBLISHEDITEMS_TEMPLATE:
  214. if (pdsConfig->config.itemsTemplate.variablesToAddSize > 0){
  215. for(size_t i = 0; i < pdsConfig->config.itemsTemplate.variablesToAddSize; i++){
  216. UA_PublishedVariableDataType_deleteMembers(&pdsConfig->config.itemsTemplate.variablesToAdd[i]);
  217. }
  218. UA_free(pdsConfig->config.itemsTemplate.variablesToAdd);
  219. }
  220. UA_DataSetMetaDataType_deleteMembers(&pdsConfig->config.itemsTemplate.metaData);
  221. break;
  222. default:
  223. break;
  224. }
  225. }
  226. void
  227. UA_PublishedDataSet_deleteMembers(UA_Server *server, UA_PublishedDataSet *publishedDataSet){
  228. UA_PublishedDataSetConfig_deleteMembers(&publishedDataSet->config);
  229. //delete PDS
  230. UA_DataSetMetaDataType_deleteMembers(&publishedDataSet->dataSetMetaData);
  231. UA_DataSetField *field, *tmpField;
  232. LIST_FOREACH_SAFE(field, &publishedDataSet->fields, listEntry, tmpField) {
  233. UA_Server_removeDataSetField(server, field->identifier);
  234. }
  235. UA_NodeId_deleteMembers(&publishedDataSet->identifier);
  236. }
  237. UA_DataSetFieldResult
  238. UA_Server_addDataSetField(UA_Server *server, const UA_NodeId publishedDataSet,
  239. const UA_DataSetFieldConfig *fieldConfig,
  240. UA_NodeId *fieldIdentifier) {
  241. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  242. UA_DataSetFieldResult result = {UA_STATUSCODE_BADINVALIDARGUMENT, {0, 0}};
  243. if(!fieldConfig)
  244. return result;
  245. UA_PublishedDataSet *currentDataSet = UA_PublishedDataSet_findPDSbyId(server, publishedDataSet);
  246. if(currentDataSet == NULL){
  247. result.result = UA_STATUSCODE_BADNOTFOUND;
  248. return result;
  249. }
  250. if(currentDataSet->config.publishedDataSetType != UA_PUBSUB_DATASET_PUBLISHEDITEMS){
  251. result.result = UA_STATUSCODE_BADNOTIMPLEMENTED;
  252. return result;
  253. }
  254. UA_DataSetField *newField = (UA_DataSetField *) UA_calloc(1, sizeof(UA_DataSetField));
  255. if(!newField){
  256. result.result = UA_STATUSCODE_BADINTERNALERROR;
  257. return result;
  258. }
  259. UA_DataSetFieldConfig tmpFieldConfig;
  260. retVal |= UA_DataSetFieldConfig_copy(fieldConfig, &tmpFieldConfig);
  261. newField->config = tmpFieldConfig;
  262. UA_PubSubManager_generateUniqueNodeId(server, &newField->identifier);
  263. if(fieldIdentifier != NULL){
  264. UA_NodeId_copy(&newField->identifier, fieldIdentifier);
  265. }
  266. newField->publishedDataSet = currentDataSet->identifier;
  267. //update major version of parent published data set
  268. currentDataSet->dataSetMetaData.configurationVersion.majorVersion = UA_PubSubConfigurationVersionTimeDifference();
  269. LIST_INSERT_HEAD(&currentDataSet->fields, newField, listEntry);
  270. if(newField->config.field.variable.promotedField)
  271. currentDataSet->promotedFieldsCount++;
  272. currentDataSet->fieldSize++;
  273. result.result = retVal;
  274. result.configurationVersion.majorVersion = currentDataSet->dataSetMetaData.configurationVersion.majorVersion;
  275. result.configurationVersion.minorVersion = currentDataSet->dataSetMetaData.configurationVersion.minorVersion;
  276. return result;
  277. }
  278. UA_DataSetFieldResult
  279. UA_Server_removeDataSetField(UA_Server *server, const UA_NodeId dsf) {
  280. UA_DataSetField *currentField = UA_DataSetField_findDSFbyId(server, dsf);
  281. UA_DataSetFieldResult result = {UA_STATUSCODE_BADNOTFOUND, {0, 0}};
  282. if(!currentField)
  283. return result;
  284. UA_PublishedDataSet *parentPublishedDataSet =
  285. UA_PublishedDataSet_findPDSbyId(server, currentField->publishedDataSet);
  286. if(!parentPublishedDataSet)
  287. return result;
  288. parentPublishedDataSet->fieldSize--;
  289. if(currentField->config.field.variable.promotedField)
  290. parentPublishedDataSet->promotedFieldsCount--;
  291. /* update major version of PublishedDataSet */
  292. parentPublishedDataSet->dataSetMetaData.configurationVersion.majorVersion =
  293. UA_PubSubConfigurationVersionTimeDifference();
  294. UA_DataSetField_deleteMembers(currentField);
  295. LIST_REMOVE(currentField, listEntry);
  296. UA_free(currentField);
  297. result.result = UA_STATUSCODE_GOOD;
  298. result.configurationVersion.majorVersion = parentPublishedDataSet->dataSetMetaData.configurationVersion.majorVersion;
  299. result.configurationVersion.minorVersion = parentPublishedDataSet->dataSetMetaData.configurationVersion.minorVersion;
  300. return result;
  301. }
  302. /**********************************************/
  303. /* DataSetWriter */
  304. /**********************************************/
  305. UA_StatusCode
  306. UA_DataSetWriterConfig_copy(const UA_DataSetWriterConfig *src,
  307. UA_DataSetWriterConfig *dst){
  308. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  309. memcpy(dst, src, sizeof(UA_DataSetWriterConfig));
  310. retVal |= UA_String_copy(&src->name, &dst->name);
  311. retVal |= UA_String_copy(&src->dataSetName, &dst->dataSetName);
  312. retVal |= UA_ExtensionObject_copy(&src->messageSettings, &dst->messageSettings);
  313. dst->dataSetWriterProperties = (UA_KeyValuePair *)
  314. UA_calloc(src->dataSetWriterPropertiesSize, sizeof(UA_KeyValuePair));
  315. if(!dst->dataSetWriterProperties)
  316. return UA_STATUSCODE_BADOUTOFMEMORY;
  317. for(size_t i = 0; i < src->dataSetWriterPropertiesSize; i++){
  318. retVal |= UA_KeyValuePair_copy(&src->dataSetWriterProperties[i], &dst->dataSetWriterProperties[i]);
  319. }
  320. return retVal;
  321. }
  322. UA_StatusCode
  323. UA_Server_getDataSetWriterConfig(UA_Server *server, const UA_NodeId dsw,
  324. UA_DataSetWriterConfig *config){
  325. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  326. if(!config)
  327. return UA_STATUSCODE_BADINVALIDARGUMENT;
  328. UA_DataSetWriter *currentDataSetWriter = UA_DataSetWriter_findDSWbyId(server, dsw);
  329. if(!currentDataSetWriter)
  330. return UA_STATUSCODE_BADNOTFOUND;
  331. UA_DataSetWriterConfig tmpWriterConfig;
  332. //deep copy of the actual config
  333. retVal |= UA_DataSetWriterConfig_copy(&currentDataSetWriter->config, &tmpWriterConfig);
  334. *config = tmpWriterConfig;
  335. return retVal;
  336. }
  337. UA_DataSetWriter *
  338. UA_DataSetWriter_findDSWbyId(UA_Server *server, UA_NodeId identifier) {
  339. for(size_t i = 0; i < server->pubSubManager.connectionsSize; i++){
  340. UA_WriterGroup *tmpWriterGroup;
  341. LIST_FOREACH(tmpWriterGroup, &server->pubSubManager.connections[i].writerGroups, listEntry){
  342. UA_DataSetWriter *tmpWriter;
  343. LIST_FOREACH(tmpWriter, &tmpWriterGroup->writers, listEntry){
  344. if(UA_NodeId_equal(&tmpWriter->identifier, &identifier)){
  345. return tmpWriter;
  346. }
  347. }
  348. }
  349. }
  350. return NULL;
  351. }
  352. void
  353. UA_DataSetWriterConfig_deleteMembers(UA_DataSetWriterConfig *pdsConfig) {
  354. UA_String_deleteMembers(&pdsConfig->name);
  355. UA_String_deleteMembers(&pdsConfig->dataSetName);
  356. for(size_t i = 0; i < pdsConfig->dataSetWriterPropertiesSize; i++){
  357. UA_KeyValuePair_deleteMembers(&pdsConfig->dataSetWriterProperties[i]);
  358. }
  359. UA_free(pdsConfig->dataSetWriterProperties);
  360. UA_ExtensionObject_deleteMembers(&pdsConfig->messageSettings);
  361. }
  362. static void
  363. UA_DataSetWriter_deleteMembers(UA_Server *server, UA_DataSetWriter *dataSetWriter) {
  364. UA_DataSetWriterConfig_deleteMembers(&dataSetWriter->config);
  365. //delete DataSetWriter
  366. UA_NodeId_deleteMembers(&dataSetWriter->identifier);
  367. UA_NodeId_deleteMembers(&dataSetWriter->linkedWriterGroup);
  368. UA_NodeId_deleteMembers(&dataSetWriter->connectedDataSet);
  369. #ifdef UA_ENABLE_PUBSUB_DELTAFRAMES
  370. //delete lastSamples store
  371. for(size_t i = 0; i < dataSetWriter->lastSamplesCount; i++) {
  372. UA_DataValue_deleteMembers(&dataSetWriter->lastSamples[i].value);
  373. }
  374. UA_free(dataSetWriter->lastSamples);
  375. dataSetWriter->lastSamples = NULL;
  376. dataSetWriter->lastSamplesCount = 0;
  377. #endif
  378. }
  379. /**********************************************/
  380. /* WriterGroup */
  381. /**********************************************/
  382. UA_StatusCode
  383. UA_WriterGroupConfig_copy(const UA_WriterGroupConfig *src,
  384. UA_WriterGroupConfig *dst){
  385. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  386. memcpy(dst, src, sizeof(UA_WriterGroupConfig));
  387. retVal |= UA_String_copy(&src->name, &dst->name);
  388. retVal |= UA_ExtensionObject_copy(&src->transportSettings, &dst->transportSettings);
  389. retVal |= UA_ExtensionObject_copy(&src->messageSettings, &dst->messageSettings);
  390. dst->groupProperties = (UA_KeyValuePair *) UA_calloc(src->groupPropertiesSize, sizeof(UA_KeyValuePair));
  391. if(!dst->groupProperties)
  392. return UA_STATUSCODE_BADOUTOFMEMORY;
  393. for(size_t i = 0; i < src->groupPropertiesSize; i++){
  394. retVal |= UA_KeyValuePair_copy(&src->groupProperties[i], &dst->groupProperties[i]);
  395. }
  396. return retVal;
  397. }
  398. UA_StatusCode
  399. UA_Server_getWriterGroupConfig(UA_Server *server, const UA_NodeId writerGroup,
  400. UA_WriterGroupConfig *config){
  401. UA_StatusCode retVal = UA_STATUSCODE_GOOD;
  402. if(!config)
  403. return UA_STATUSCODE_BADINVALIDARGUMENT;
  404. UA_WriterGroup *currentWriterGroup = UA_WriterGroup_findWGbyId(server, writerGroup);
  405. if(!currentWriterGroup){
  406. return UA_STATUSCODE_BADNOTFOUND;
  407. }
  408. UA_WriterGroupConfig tmpWriterGroupConfig;
  409. //deep copy of the actual config
  410. retVal |= UA_WriterGroupConfig_copy(&currentWriterGroup->config, &tmpWriterGroupConfig);
  411. *config = tmpWriterGroupConfig;
  412. return retVal;
  413. }
  414. UA_StatusCode
  415. UA_Server_updateWriterGroupConfig(UA_Server *server, UA_NodeId writerGroupIdentifier,
  416. const UA_WriterGroupConfig *config){
  417. if(!config)
  418. return UA_STATUSCODE_BADINVALIDARGUMENT;
  419. UA_WriterGroup *currentWriterGroup = UA_WriterGroup_findWGbyId(server, writerGroupIdentifier);
  420. if(!currentWriterGroup)
  421. return UA_STATUSCODE_BADNOTFOUND;
  422. //The update functionality will be extended during the next PubSub batches.
  423. //Currently is only a change of the publishing interval possible.
  424. if(currentWriterGroup->config.publishingInterval != config->publishingInterval) {
  425. UA_PubSubManager_removeRepeatedPubSubCallback(server, currentWriterGroup->publishCallbackId);
  426. currentWriterGroup->config.publishingInterval = config->publishingInterval;
  427. UA_WriterGroup_addPublishCallback(server, currentWriterGroup);
  428. } else if (currentWriterGroup->config.priority != config->priority) {
  429. UA_LOG_WARNING(server->config.logger, UA_LOGCATEGORY_SERVER, "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, "Publish failed. WriterGroup not found");
  884. return;
  885. }
  886. if(writerGroup->writersCount <= 0)
  887. return;
  888. if(writerGroup->config.encodingMimeType != UA_PUBSUB_ENCODING_UADP) {
  889. UA_LOG_ERROR(server->config.logger, UA_LOGCATEGORY_SERVER, "Unknown encoding type.");
  890. return;
  891. }
  892. UA_PubSubConnection *connection = UA_PubSubConnection_findConnectionbyId(server, writerGroup->linkedConnection);
  893. if(!connection){
  894. UA_LOG_ERROR(server->config.logger, UA_LOGCATEGORY_SERVER, "Publish failed. PubSubConnection invalid.");
  895. return;
  896. }
  897. //prevent error if the maxEncapsulatedDataSetMessageCount is set to 0->1
  898. writerGroup->config.maxEncapsulatedDataSetMessageCount = (UA_UInt16) (writerGroup->config.maxEncapsulatedDataSetMessageCount == 0 ||
  899. writerGroup->config.maxEncapsulatedDataSetMessageCount > UA_BYTE_MAX
  900. ? 1 : writerGroup->config.maxEncapsulatedDataSetMessageCount);
  901. UA_DataSetMessage *dsmStore = (UA_DataSetMessage *) UA_calloc(writerGroup->writersCount, sizeof(UA_DataSetMessage));
  902. if(!dsmStore) {
  903. UA_LOG_ERROR(server->config.logger, UA_LOGCATEGORY_SERVER, "DataSetMessage allocation failed");
  904. return;
  905. }
  906. memset(dsmStore, 0, sizeof(UA_DataSetMessage) * writerGroup->writersCount);
  907. //The binary DataSetMessage sizes are part of the payload. Memory is allocated on the stack.
  908. UA_STACKARRAY(UA_UInt16, dsmSizes, writerGroup->writersCount);
  909. UA_STACKARRAY(UA_UInt16, dsWriterIds, writerGroup->writersCount);
  910. memset(dsmSizes, 0, writerGroup->writersCount * sizeof(UA_UInt16));
  911. memset(dsWriterIds, 0, writerGroup->writersCount * sizeof(UA_UInt16));
  912. /*
  913. * Calculate the number of needed NetworkMessages. The previous allocated DataSetMessage array is
  914. * filled from left for combined DSM messages and from the right for single DSM.
  915. * Allocated DSM Array
  916. * +----------------------------+
  917. * |DSM1||DSM2||DSM3||DSM4||DSM5|
  918. * +--+----+-----+-----+-----+--+
  919. * | | | | |
  920. * | | | | |
  921. * +--v----v-----v-----v--+--v--+
  922. * | NM1 || NM2 | NM3 |
  923. * +----------------------+-----+
  924. * NetworkMessages
  925. */
  926. UA_UInt16 combinedNetworkMessageCount = 0, singleNetworkMessagesCount = 0;
  927. UA_DataSetWriter *tmpDataSetWriter;
  928. LIST_FOREACH(tmpDataSetWriter, &writerGroup->writers, listEntry){
  929. //if promoted fields are contained in the PublishedDataSet, then this DSM must encapsulated in one NM
  930. UA_PublishedDataSet *tmpPublishedDataSet = UA_PublishedDataSet_findPDSbyId(server, tmpDataSetWriter->connectedDataSet);
  931. if(!tmpPublishedDataSet) {
  932. UA_LOG_ERROR(server->config.logger, UA_LOGCATEGORY_SERVER, "Publish failed. PublishedDataSet not found");
  933. return;
  934. }
  935. if(tmpPublishedDataSet->promotedFieldsCount > 0) {
  936. if(UA_DataSetWriter_generateDataSetMessage(server, &dsmStore[(writerGroup->writersCount - 1) - singleNetworkMessagesCount],
  937. tmpDataSetWriter) != UA_STATUSCODE_GOOD){
  938. UA_LOG_ERROR(server->config.logger, UA_LOGCATEGORY_SERVER, "Publish failed. DataSetMessage creation failed");
  939. return;
  940. };
  941. dsWriterIds[(writerGroup->writersCount - 1) - singleNetworkMessagesCount] = tmpDataSetWriter->config.dataSetWriterId;
  942. dsmSizes[(writerGroup->writersCount-1) - singleNetworkMessagesCount] = (UA_UInt16) UA_DataSetMessage_calcSizeBinary(&dsmStore[(writerGroup->writersCount-1)
  943. - singleNetworkMessagesCount]);
  944. singleNetworkMessagesCount++;
  945. } else {
  946. if(UA_DataSetWriter_generateDataSetMessage(server, &dsmStore[combinedNetworkMessageCount], tmpDataSetWriter) != UA_STATUSCODE_GOOD){
  947. UA_LOG_ERROR(server->config.logger, UA_LOGCATEGORY_SERVER, "Publish failed. DataSetMessage creation failed");
  948. return;
  949. };
  950. dsWriterIds[combinedNetworkMessageCount] = tmpDataSetWriter->config.dataSetWriterId;
  951. dsmSizes[combinedNetworkMessageCount] = (UA_UInt16) UA_DataSetMessage_calcSizeBinary(&dsmStore[combinedNetworkMessageCount]);
  952. combinedNetworkMessageCount++;
  953. }
  954. }
  955. UA_UInt32 networkMessageCount = singleNetworkMessagesCount;
  956. if(combinedNetworkMessageCount != 0){
  957. combinedNetworkMessageCount = (UA_UInt16) (
  958. combinedNetworkMessageCount / writerGroup->config.maxEncapsulatedDataSetMessageCount +
  959. (combinedNetworkMessageCount % writerGroup->config.maxEncapsulatedDataSetMessageCount) == 0 ? 0 : 1);
  960. networkMessageCount += combinedNetworkMessageCount;
  961. }
  962. if(networkMessageCount < 1){
  963. for(size_t i = 0; i < writerGroup->writersCount; i++){
  964. UA_DataSetMessage_free(&dsmStore[i]);
  965. }
  966. UA_free(dsmStore);
  967. return;
  968. }
  969. //Alloc memory for the NetworkMessages on the stack
  970. UA_STACKARRAY(UA_NetworkMessage, nmStore, networkMessageCount);
  971. memset(nmStore, 0, networkMessageCount * sizeof(UA_NetworkMessage));
  972. UA_UInt32 currentDSMPosition = 0;
  973. for(UA_UInt32 i = 0; i < networkMessageCount; i++) {
  974. nmStore[i].version = 1;
  975. nmStore[i].networkMessageType = UA_NETWORKMESSAGE_DATASET;
  976. nmStore[i].payloadHeaderEnabled = true;
  977. //create combined NetworkMessages
  978. if(i < (networkMessageCount-singleNetworkMessagesCount)){
  979. if(combinedNetworkMessageCount - (i * writerGroup->config.maxEncapsulatedDataSetMessageCount)){
  980. if(combinedNetworkMessageCount == 1){
  981. nmStore[i].payloadHeader.dataSetPayloadHeader.count = (UA_Byte) ((writerGroup->writersCount) - singleNetworkMessagesCount);
  982. currentDSMPosition = 0;
  983. } else {
  984. nmStore[i].payloadHeader.dataSetPayloadHeader.count = (UA_Byte) writerGroup->config.maxEncapsulatedDataSetMessageCount;
  985. currentDSMPosition = i * writerGroup->config.maxEncapsulatedDataSetMessageCount;
  986. }
  987. //nmStore[i].payloadHeader.dataSetPayloadHeader.count = (UA_Byte) writerGroup->config.maxEncapsulatedDataSetMessageCount;
  988. nmStore[i].payload.dataSetPayload.dataSetMessages = &dsmStore[currentDSMPosition];
  989. nmStore->payload.dataSetPayload.sizes = &dsmSizes[currentDSMPosition];
  990. nmStore->payloadHeader.dataSetPayloadHeader.dataSetWriterIds = &dsWriterIds[currentDSMPosition];
  991. } else {
  992. currentDSMPosition = i * writerGroup->config.maxEncapsulatedDataSetMessageCount;
  993. nmStore[i].payloadHeader.dataSetPayloadHeader.count = (UA_Byte) (currentDSMPosition - ((i - 1) * writerGroup->config.maxEncapsulatedDataSetMessageCount)); //attention cast from uint32 to byte
  994. nmStore[i].payload.dataSetPayload.dataSetMessages = &dsmStore[currentDSMPosition];
  995. nmStore->payload.dataSetPayload.sizes = &dsmSizes[currentDSMPosition];
  996. nmStore->payloadHeader.dataSetPayloadHeader.dataSetWriterIds = &dsWriterIds[currentDSMPosition];
  997. }
  998. } else {///create single NetworkMessages (1 DSM per NM)
  999. nmStore[i].payloadHeader.dataSetPayloadHeader.count = 1;
  1000. currentDSMPosition = (UA_UInt32) combinedNetworkMessageCount + (i - combinedNetworkMessageCount/writerGroup->config.maxEncapsulatedDataSetMessageCount
  1001. + (combinedNetworkMessageCount % writerGroup->config.maxEncapsulatedDataSetMessageCount) == 0 ? 0 : 1);
  1002. nmStore[i].payload.dataSetPayload.dataSetMessages = &dsmStore[currentDSMPosition];
  1003. nmStore->payload.dataSetPayload.sizes = &dsmSizes[currentDSMPosition];
  1004. nmStore->payloadHeader.dataSetPayloadHeader.dataSetWriterIds = &dsWriterIds[currentDSMPosition];
  1005. }
  1006. //send the prepared messages
  1007. UA_ByteString buf;
  1008. size_t msgSize = UA_NetworkMessage_calcSizeBinary(&nmStore[i]);
  1009. if(UA_ByteString_allocBuffer(&buf, msgSize) == UA_STATUSCODE_GOOD) {
  1010. UA_Byte *bufPos = buf.data;
  1011. memset(bufPos, 0, msgSize);
  1012. const UA_Byte *bufEnd = &(buf.data[buf.length]);
  1013. if(UA_NetworkMessage_encodeBinary(&nmStore[i], &bufPos, bufEnd) != UA_STATUSCODE_GOOD){
  1014. UA_ByteString_deleteMembers(&buf);
  1015. return;
  1016. };
  1017. connection->channel->send(connection->channel, NULL, &buf);
  1018. }
  1019. //The stack allocated sizes and dataSetWriterIds field must be set to NULL to prevent invalid free.
  1020. nmStore[i].payload.dataSetPayload.sizes = NULL;
  1021. nmStore->payloadHeader.dataSetPayloadHeader.dataSetWriterIds = NULL;
  1022. UA_ByteString_deleteMembers(&buf);
  1023. UA_NetworkMessage_deleteMembers(&nmStore[i]);
  1024. }
  1025. }
  1026. /*
  1027. * Add new publishCallback. The first execution is triggered directly after creation.
  1028. * @Warning - The duration (double) is currently casted to int. -> intervals smaller 1ms are not possible.
  1029. */
  1030. UA_StatusCode
  1031. UA_WriterGroup_addPublishCallback(UA_Server *server, UA_WriterGroup *writerGroup) {
  1032. UA_StatusCode retval =
  1033. UA_PubSubManager_addRepeatedCallback(server, (UA_ServerCallback) UA_WriterGroup_publishCallback,
  1034. writerGroup, (UA_UInt32) writerGroup->config.publishingInterval,
  1035. &writerGroup->publishCallbackId);
  1036. if(retval == UA_STATUSCODE_GOOD)
  1037. writerGroup->publishCallbackIsRegistered = true;
  1038. //run once after creation
  1039. UA_WriterGroup_publishCallback(server, writerGroup);
  1040. return retval;
  1041. }
  1042. #endif /* UA_ENABLE_PUBSUB */