ua_services_subscription.c 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859
  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 2014-2018 (c) Fraunhofer IOSB (Author: Julius Pfrommer)
  6. * Copyright 2016-2017 (c) Florian Palm
  7. * Copyright 2015 (c) Chris Iatrou
  8. * Copyright 2015-2016 (c) Sten Grüner
  9. * Copyright 2015-2016 (c) Oleksiy Vasylyev
  10. * Copyright 2017 (c) Stefan Profanter, fortiss GmbH
  11. * Copyright 2018 (c) Ari Breitkreuz, fortiss GmbH
  12. * Copyright 2017 (c) Mattias Bornhager
  13. * Copyright 2017 (c) Henrik Norrman
  14. * Copyright 2017-2018 (c) Thomas Stalder, Blue Time Concept SA
  15. * Copyright 2018 (c) Fabian Arndt, Root-Core
  16. */
  17. #include "ua_server_internal.h"
  18. #include "ua_services.h"
  19. #include "ua_subscription.h"
  20. #ifdef UA_ENABLE_SUBSCRIPTIONS /* conditional compilation */
  21. #define UA_BOUNDEDVALUE_SETWBOUNDS(BOUNDS, SRC, DST) { \
  22. if(SRC > BOUNDS.max) DST = BOUNDS.max; \
  23. else if(SRC < BOUNDS.min) DST = BOUNDS.min; \
  24. else DST = SRC; \
  25. }
  26. static UA_StatusCode
  27. setSubscriptionSettings(UA_Server *server, UA_Subscription *subscription,
  28. UA_Double requestedPublishingInterval,
  29. UA_UInt32 requestedLifetimeCount,
  30. UA_UInt32 requestedMaxKeepAliveCount,
  31. UA_UInt32 maxNotificationsPerPublish, UA_Byte priority) {
  32. /* deregister the callback if required */
  33. Subscription_unregisterPublishCallback(server, subscription);
  34. /* re-parameterize the subscription */
  35. subscription->publishingInterval = requestedPublishingInterval;
  36. UA_BOUNDEDVALUE_SETWBOUNDS(server->config.publishingIntervalLimits,
  37. requestedPublishingInterval, subscription->publishingInterval);
  38. /* check for nan*/
  39. if(requestedPublishingInterval != requestedPublishingInterval)
  40. subscription->publishingInterval = server->config.publishingIntervalLimits.min;
  41. UA_BOUNDEDVALUE_SETWBOUNDS(server->config.keepAliveCountLimits,
  42. requestedMaxKeepAliveCount, subscription->maxKeepAliveCount);
  43. UA_BOUNDEDVALUE_SETWBOUNDS(server->config.lifeTimeCountLimits,
  44. requestedLifetimeCount, subscription->lifeTimeCount);
  45. if(subscription->lifeTimeCount < 3 * subscription->maxKeepAliveCount)
  46. subscription->lifeTimeCount = 3 * subscription->maxKeepAliveCount;
  47. subscription->notificationsPerPublish = maxNotificationsPerPublish;
  48. if(maxNotificationsPerPublish == 0 ||
  49. maxNotificationsPerPublish > server->config.maxNotificationsPerPublish)
  50. subscription->notificationsPerPublish = server->config.maxNotificationsPerPublish;
  51. subscription->priority = priority;
  52. UA_StatusCode retval = Subscription_registerPublishCallback(server, subscription);
  53. if(retval != UA_STATUSCODE_GOOD) {
  54. UA_LOG_DEBUG_SESSION(&server->config.logger, subscription->session,
  55. "Subscription %u | Could not register publish callback with error code %s",
  56. subscription->subscriptionId, UA_StatusCode_name(retval));
  57. }
  58. return retval;
  59. }
  60. void
  61. Service_CreateSubscription(UA_Server *server, UA_Session *session,
  62. const UA_CreateSubscriptionRequest *request,
  63. UA_CreateSubscriptionResponse *response) {
  64. /* Check limits for the number of subscriptions */
  65. if((server->config.maxSubscriptionsPerSession != 0) &&
  66. (session->numSubscriptions >= server->config.maxSubscriptionsPerSession)) {
  67. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYSUBSCRIPTIONS;
  68. return;
  69. }
  70. /* Create the subscription */
  71. UA_Subscription *newSubscription = UA_Subscription_new(session, response->subscriptionId);
  72. if(!newSubscription) {
  73. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  74. "Processing CreateSubscriptionRequest failed");
  75. response->responseHeader.serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
  76. return;
  77. }
  78. UA_Session_addSubscription(session, newSubscription); /* Also assigns the subscription id */
  79. /* Set the subscription parameters */
  80. newSubscription->publishingEnabled = request->publishingEnabled;
  81. UA_StatusCode retval = setSubscriptionSettings(server, newSubscription, request->requestedPublishingInterval,
  82. request->requestedLifetimeCount, request->requestedMaxKeepAliveCount,
  83. request->maxNotificationsPerPublish, request->priority);
  84. if(retval != UA_STATUSCODE_GOOD) {
  85. response->responseHeader.serviceResult = retval;
  86. return;
  87. }
  88. newSubscription->currentKeepAliveCount = newSubscription->maxKeepAliveCount; /* set settings first */
  89. /* Prepare the response */
  90. response->subscriptionId = newSubscription->subscriptionId;
  91. response->revisedPublishingInterval = newSubscription->publishingInterval;
  92. response->revisedLifetimeCount = newSubscription->lifeTimeCount;
  93. response->revisedMaxKeepAliveCount = newSubscription->maxKeepAliveCount;
  94. UA_LOG_INFO_SESSION(&server->config.logger, session, "Subscription %u | "
  95. "Created the Subscription with a publishing interval of %.2f ms",
  96. response->subscriptionId, newSubscription->publishingInterval);
  97. }
  98. void
  99. Service_ModifySubscription(UA_Server *server, UA_Session *session,
  100. const UA_ModifySubscriptionRequest *request,
  101. UA_ModifySubscriptionResponse *response) {
  102. UA_LOG_DEBUG_SESSION(&server->config.logger, session, "Processing ModifySubscriptionRequest");
  103. UA_Subscription *sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  104. if(!sub) {
  105. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  106. return;
  107. }
  108. UA_StatusCode retval = setSubscriptionSettings(server, sub, request->requestedPublishingInterval,
  109. request->requestedLifetimeCount, request->requestedMaxKeepAliveCount,
  110. request->maxNotificationsPerPublish, request->priority);
  111. if(retval != UA_STATUSCODE_GOOD) {
  112. response->responseHeader.serviceResult = retval;
  113. return;
  114. }
  115. sub->currentLifetimeCount = 0; /* Reset the subscription lifetime */
  116. response->revisedPublishingInterval = sub->publishingInterval;
  117. response->revisedLifetimeCount = sub->lifeTimeCount;
  118. response->revisedMaxKeepAliveCount = sub->maxKeepAliveCount;
  119. }
  120. static void
  121. Operation_SetPublishingMode(UA_Server *Server, UA_Session *session,
  122. const UA_Boolean *publishingEnabled, const UA_UInt32 *subscriptionId,
  123. UA_StatusCode *result) {
  124. UA_Subscription *sub = UA_Session_getSubscriptionById(session, *subscriptionId);
  125. if(!sub) {
  126. *result = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  127. return;
  128. }
  129. sub->currentLifetimeCount = 0; /* Reset the subscription lifetime */
  130. sub->publishingEnabled = *publishingEnabled; /* Set the publishing mode */
  131. }
  132. void
  133. Service_SetPublishingMode(UA_Server *server, UA_Session *session,
  134. const UA_SetPublishingModeRequest *request,
  135. UA_SetPublishingModeResponse *response) {
  136. UA_LOG_DEBUG_SESSION(&server->config.logger, session, "Processing SetPublishingModeRequest");
  137. UA_Boolean publishingEnabled = request->publishingEnabled; /* request is const */
  138. response->responseHeader.serviceResult =
  139. UA_Server_processServiceOperations(server, session, (UA_ServiceOperation)Operation_SetPublishingMode,
  140. &publishingEnabled,
  141. &request->subscriptionIdsSize, &UA_TYPES[UA_TYPES_UINT32],
  142. &response->resultsSize, &UA_TYPES[UA_TYPES_STATUSCODE]);
  143. }
  144. static UA_StatusCode
  145. setMonitoredItemSettings(UA_Server *server, UA_MonitoredItem *mon,
  146. UA_MonitoringMode monitoringMode,
  147. const UA_MonitoringParameters *params,
  148. const UA_DataType* dataType) {
  149. /* Filter */
  150. if(params->filter.encoding != UA_EXTENSIONOBJECT_DECODED) {
  151. UA_DataChangeFilter_init(&(mon->filter.dataChangeFilter));
  152. mon->filter.dataChangeFilter.trigger = UA_DATACHANGETRIGGER_STATUSVALUE;
  153. } else if(params->filter.content.decoded.type == &UA_TYPES[UA_TYPES_DATACHANGEFILTER]) {
  154. UA_DataChangeFilter *filter = (UA_DataChangeFilter *)params->filter.content.decoded.data;
  155. // TODO implement EURange to support UA_DEADBANDTYPE_PERCENT
  156. switch(filter->deadbandType) {
  157. case UA_DEADBANDTYPE_NONE:
  158. break;
  159. case UA_DEADBANDTYPE_ABSOLUTE:
  160. if(!dataType || !UA_DataType_isNumeric(dataType))
  161. return UA_STATUSCODE_BADFILTERNOTALLOWED;
  162. break;
  163. case UA_DEADBANDTYPE_PERCENT:
  164. return UA_STATUSCODE_BADMONITOREDITEMFILTERUNSUPPORTED;
  165. default:
  166. return UA_STATUSCODE_BADMONITOREDITEMFILTERUNSUPPORTED;
  167. }
  168. UA_DataChangeFilter_copy(filter, &mon->filter.dataChangeFilter);
  169. #ifdef UA_ENABLE_SUBSCRIPTIONS_EVENTS
  170. } else if (params->filter.content.decoded.type == &UA_TYPES[UA_TYPES_EVENTFILTER]) {
  171. UA_EventFilter_copy((UA_EventFilter *)params->filter.content.decoded.data,
  172. &mon->filter.eventFilter);
  173. #endif
  174. } else {
  175. return UA_STATUSCODE_BADMONITOREDITEMFILTERINVALID;
  176. }
  177. /* <-- The point of no return --> */
  178. /* Unregister the callback */
  179. UA_MonitoredItem_unregisterSampleCallback(server, mon);
  180. /* Remove the old samples */
  181. UA_ByteString_deleteMembers(&mon->lastSampledValue);
  182. UA_Variant_deleteMembers(&mon->lastValue);
  183. /* ClientHandle */
  184. mon->clientHandle = params->clientHandle;
  185. /* SamplingInterval */
  186. UA_Double samplingInterval = params->samplingInterval;
  187. if(mon->attributeId == UA_ATTRIBUTEID_VALUE) {
  188. mon->monitoredItemType = UA_MONITOREDITEMTYPE_CHANGENOTIFY;
  189. const UA_VariableNode *vn = (const UA_VariableNode *)
  190. UA_Nodestore_get(server, &mon->monitoredNodeId);
  191. if(vn) {
  192. if(vn->nodeClass == UA_NODECLASS_VARIABLE &&
  193. samplingInterval < vn->minimumSamplingInterval)
  194. samplingInterval = vn->minimumSamplingInterval;
  195. UA_Nodestore_release(server, (const UA_Node *)vn);
  196. }
  197. } else if(mon->attributeId == UA_ATTRIBUTEID_EVENTNOTIFIER) {
  198. /* TODO: events should not need a samplinginterval */
  199. samplingInterval = 10000.0f; // 10 seconds to reduce the load
  200. mon->monitoredItemType = UA_MONITOREDITEMTYPE_EVENTNOTIFY;
  201. } else {
  202. mon->monitoredItemType = UA_MONITOREDITEMTYPE_CHANGENOTIFY;
  203. }
  204. mon->samplingInterval = samplingInterval;
  205. UA_BOUNDEDVALUE_SETWBOUNDS(server->config.samplingIntervalLimits,
  206. samplingInterval, mon->samplingInterval);
  207. if(samplingInterval != samplingInterval) /* Check for nan */
  208. mon->samplingInterval = server->config.samplingIntervalLimits.min;
  209. UA_assert(mon->monitoredItemType != 0);
  210. /* QueueSize */
  211. UA_BOUNDEDVALUE_SETWBOUNDS(server->config.queueSizeLimits,
  212. params->queueSize, mon->maxQueueSize);
  213. /* DiscardOldest */
  214. mon->discardOldest = params->discardOldest;
  215. /* Register sample callback if reporting is enabled */
  216. mon->monitoringMode = monitoringMode;
  217. if(monitoringMode == UA_MONITORINGMODE_REPORTING)
  218. return UA_MonitoredItem_registerSampleCallback(server, mon);
  219. return UA_STATUSCODE_GOOD;
  220. }
  221. static const UA_String binaryEncoding = {sizeof("Default Binary") - 1, (UA_Byte *)"Default Binary"};
  222. #ifdef UA_ENABLE_SUBSCRIPTIONS_EVENTS
  223. static UA_StatusCode UA_Server_addMonitoredItemToNodeEditNodeCallback(UA_Server *server, UA_Session *session,
  224. UA_Node *node, void *data) {
  225. /* data is the MonitoredItem */
  226. /* SLIST_INSERT_HEAD */
  227. ((UA_MonitoredItem *)data)->next = ((UA_ObjectNode *)node)->monitoredItemQueue;
  228. ((UA_ObjectNode *)node)->monitoredItemQueue = (UA_MonitoredItem *)data;
  229. return UA_STATUSCODE_GOOD;
  230. }
  231. #endif
  232. /* Thread-local variables to pass additional arguments into the operation */
  233. struct createMonContext {
  234. UA_Subscription *sub;
  235. UA_TimestampsToReturn timestampsToReturn;
  236. /* If sub is NULL, use local callbacks */
  237. UA_Server_DataChangeNotificationCallback dataChangeCallback;
  238. void *context;
  239. };
  240. static void
  241. Operation_CreateMonitoredItem(UA_Server *server, UA_Session *session, struct createMonContext *cmc,
  242. const UA_MonitoredItemCreateRequest *request,
  243. UA_MonitoredItemCreateResult *result) {
  244. /* Check available capacity */
  245. if(server->config.maxMonitoredItemsPerSubscription != 0 && cmc->sub &&
  246. cmc->sub->monitoredItemsSize >= server->config.maxMonitoredItemsPerSubscription) {
  247. result->statusCode = UA_STATUSCODE_BADTOOMANYMONITOREDITEMS;
  248. return;
  249. }
  250. /* Make an example read to get errors in the itemToMonitor. Allow return
  251. * codes "good" and "uncertain", as well as a list of statuscodes that might
  252. * be repaired inside the data source. */
  253. UA_DataValue v = UA_Server_readWithSession(server, session, &request->itemToMonitor,
  254. cmc->timestampsToReturn);
  255. if(v.hasStatus && (v.status >> 30) > 1 &&
  256. v.status != UA_STATUSCODE_BADRESOURCEUNAVAILABLE &&
  257. v.status != UA_STATUSCODE_BADCOMMUNICATIONERROR &&
  258. v.status != UA_STATUSCODE_BADWAITINGFORINITIALDATA &&
  259. v.status != UA_STATUSCODE_BADUSERACCESSDENIED &&
  260. v.status != UA_STATUSCODE_BADNOTREADABLE &&
  261. v.status != UA_STATUSCODE_BADINDEXRANGENODATA) {
  262. result->statusCode = v.status;
  263. UA_DataValue_deleteMembers(&v);
  264. return;
  265. }
  266. /* Check if the encoding is supported */
  267. if(request->itemToMonitor.dataEncoding.name.length > 0 &&
  268. (!UA_String_equal(&binaryEncoding, &request->itemToMonitor.dataEncoding.name) ||
  269. request->itemToMonitor.dataEncoding.namespaceIndex != 0)) {
  270. result->statusCode = UA_STATUSCODE_BADDATAENCODINGUNSUPPORTED;
  271. UA_DataValue_deleteMembers(&v);
  272. return;
  273. }
  274. /* Check if the encoding is set for a value */
  275. if(request->itemToMonitor.attributeId != UA_ATTRIBUTEID_VALUE &&
  276. request->itemToMonitor.dataEncoding.name.length > 0) {
  277. result->statusCode = UA_STATUSCODE_BADDATAENCODINGINVALID;
  278. UA_DataValue_deleteMembers(&v);
  279. return;
  280. }
  281. /* Allocate the MonitoredItem */
  282. size_t nmsize = sizeof(UA_MonitoredItem);
  283. if(!cmc->sub)
  284. nmsize = sizeof(UA_LocalMonitoredItem);
  285. UA_MonitoredItem *newMon = (UA_MonitoredItem*)UA_malloc(nmsize);
  286. if(!newMon) {
  287. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  288. UA_DataValue_deleteMembers(&v);
  289. return;
  290. }
  291. /* Initialize the MonitoredItem */
  292. UA_MonitoredItem_init(newMon, cmc->sub);
  293. newMon->attributeId = request->itemToMonitor.attributeId;
  294. newMon->timestampsToReturn = cmc->timestampsToReturn;
  295. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  296. retval |= UA_NodeId_copy(&request->itemToMonitor.nodeId, &newMon->monitoredNodeId);
  297. retval |= UA_String_copy(&request->itemToMonitor.indexRange, &newMon->indexRange);
  298. retval |= setMonitoredItemSettings(server, newMon, request->monitoringMode,
  299. &request->requestedParameters, v.value.type);
  300. UA_DataValue_deleteMembers(&v);
  301. if(retval != UA_STATUSCODE_GOOD) {
  302. UA_LOG_INFO_SESSION(&server->config.logger, session,
  303. "Subscription %u | Could not create a MonitoredItem "
  304. "with StatusCode %s", cmc->sub ? cmc->sub->subscriptionId : 0,
  305. UA_StatusCode_name(retval));
  306. result->statusCode = retval;
  307. UA_MonitoredItem_delete(server, newMon);
  308. return;
  309. }
  310. /* Add to the subscriptions or the local MonitoredItems */
  311. if(cmc->sub) {
  312. newMon->monitoredItemId = ++cmc->sub->lastMonitoredItemId;
  313. UA_Subscription_addMonitoredItem(cmc->sub, newMon);
  314. #ifdef UA_ENABLE_SUBSCRIPTIONS_EVENTS
  315. if(newMon->monitoredItemType == UA_MONITOREDITEMTYPE_EVENTNOTIFY) {
  316. /* Insert the monitored item into the node's queue */
  317. UA_Server_editNode(server, NULL, &newMon->monitoredNodeId,
  318. UA_Server_addMonitoredItemToNodeEditNodeCallback, newMon);
  319. }
  320. #endif
  321. } else {
  322. //TODO support events for local monitored items
  323. UA_LocalMonitoredItem *localMon = (UA_LocalMonitoredItem*)newMon;
  324. localMon->context = cmc->context;
  325. localMon->callback.dataChangeCallback = cmc->dataChangeCallback;
  326. newMon->monitoredItemId = ++server->lastLocalMonitoredItemId;
  327. LIST_INSERT_HEAD(&server->localMonitoredItems, newMon, listEntry);
  328. }
  329. /* Register MonitoredItem in userland */
  330. if(server->config.monitoredItemRegisterCallback) {
  331. void *targetContext = NULL;
  332. UA_Server_getNodeContext(server, request->itemToMonitor.nodeId, &targetContext);
  333. server->config.monitoredItemRegisterCallback(server, &session->sessionId,
  334. session->sessionHandle,
  335. &request->itemToMonitor.nodeId,
  336. targetContext, newMon->attributeId, false);
  337. newMon->registered = true;
  338. }
  339. UA_LOG_INFO_SESSION(&server->config.logger, session,
  340. "Subscription %u | MonitoredItem %i | "
  341. "Created the MonitoredItem",
  342. cmc->sub ? cmc->sub->subscriptionId : 0,
  343. newMon->monitoredItemId);
  344. /* Create the first sample */
  345. if(request->monitoringMode == UA_MONITORINGMODE_REPORTING)
  346. UA_MonitoredItem_sampleCallback(server, newMon);
  347. /* Prepare the response */
  348. result->revisedSamplingInterval = newMon->samplingInterval;
  349. result->revisedQueueSize = newMon->maxQueueSize;
  350. result->monitoredItemId = newMon->monitoredItemId;
  351. }
  352. void
  353. Service_CreateMonitoredItems(UA_Server *server, UA_Session *session,
  354. const UA_CreateMonitoredItemsRequest *request,
  355. UA_CreateMonitoredItemsResponse *response) {
  356. UA_LOG_DEBUG_SESSION(&server->config.logger, session, "Processing CreateMonitoredItemsRequest");
  357. if(server->config.maxMonitoredItemsPerCall != 0 &&
  358. request->itemsToCreateSize > server->config.maxMonitoredItemsPerCall) {
  359. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  360. return;
  361. }
  362. /* Check if the timestampstoreturn is valid */
  363. struct createMonContext cmc;
  364. cmc.timestampsToReturn = request->timestampsToReturn;
  365. if(cmc.timestampsToReturn > UA_TIMESTAMPSTORETURN_NEITHER) {
  366. response->responseHeader.serviceResult = UA_STATUSCODE_BADTIMESTAMPSTORETURNINVALID;
  367. return;
  368. }
  369. /* Find the subscription */
  370. cmc.sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  371. if(!cmc.sub) {
  372. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  373. return;
  374. }
  375. /* Reset the subscription lifetime */
  376. cmc.sub->currentLifetimeCount = 0;
  377. response->responseHeader.serviceResult =
  378. UA_Server_processServiceOperations(server, session, (UA_ServiceOperation)Operation_CreateMonitoredItem, &cmc,
  379. &request->itemsToCreateSize, &UA_TYPES[UA_TYPES_MONITOREDITEMCREATEREQUEST],
  380. &response->resultsSize, &UA_TYPES[UA_TYPES_MONITOREDITEMCREATERESULT]);
  381. }
  382. UA_MonitoredItemCreateResult
  383. UA_Server_createDataChangeMonitoredItem(UA_Server *server,
  384. UA_TimestampsToReturn timestampsToReturn,
  385. const UA_MonitoredItemCreateRequest item,
  386. void *monitoredItemContext,
  387. UA_Server_DataChangeNotificationCallback callback) {
  388. struct createMonContext cmc;
  389. cmc.sub = NULL;
  390. cmc.context = monitoredItemContext;
  391. cmc.dataChangeCallback = callback;
  392. cmc.timestampsToReturn = timestampsToReturn;
  393. UA_MonitoredItemCreateResult result;
  394. UA_MonitoredItemCreateResult_init(&result);
  395. Operation_CreateMonitoredItem(server, &server->adminSession, &cmc, &item, &result);
  396. return result;
  397. }
  398. static void
  399. Operation_ModifyMonitoredItem(UA_Server *server, UA_Session *session, UA_Subscription *sub,
  400. const UA_MonitoredItemModifyRequest *request,
  401. UA_MonitoredItemModifyResult *result) {
  402. /* Get the MonitoredItem */
  403. UA_MonitoredItem *mon = UA_Subscription_getMonitoredItem(sub, request->monitoredItemId);
  404. if(!mon) {
  405. result->statusCode = UA_STATUSCODE_BADMONITOREDITEMIDINVALID;
  406. return;
  407. }
  408. /* Read the current value to test if filters are possible.
  409. * Can return an empty value (v.value.type == NULL). */
  410. UA_ReadValueId rvid;
  411. UA_ReadValueId_init(&rvid);
  412. rvid.nodeId = mon->monitoredNodeId;
  413. rvid.attributeId = mon->attributeId;
  414. rvid.indexRange = mon->indexRange;
  415. UA_DataValue v = UA_Server_readWithSession(server, session, &rvid, mon->timestampsToReturn);
  416. UA_StatusCode retval = setMonitoredItemSettings(server, mon, mon->monitoringMode,
  417. &request->requestedParameters,
  418. v.value.type);
  419. UA_DataValue_deleteMembers(&v);
  420. if(retval != UA_STATUSCODE_GOOD) {
  421. result->statusCode = retval;
  422. return;
  423. }
  424. result->revisedSamplingInterval = mon->samplingInterval;
  425. result->revisedQueueSize = mon->maxQueueSize;
  426. /* Remove some notifications if the queue is now too small */
  427. UA_MonitoredItem_ensureQueueSpace(server, mon);
  428. }
  429. void
  430. Service_ModifyMonitoredItems(UA_Server *server, UA_Session *session,
  431. const UA_ModifyMonitoredItemsRequest *request,
  432. UA_ModifyMonitoredItemsResponse *response) {
  433. UA_LOG_DEBUG_SESSION(&server->config.logger, session, "Processing ModifyMonitoredItemsRequest");
  434. if(server->config.maxMonitoredItemsPerCall != 0 &&
  435. request->itemsToModifySize > server->config.maxMonitoredItemsPerCall) {
  436. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  437. return;
  438. }
  439. /* Check if the timestampstoreturn is valid */
  440. if(request->timestampsToReturn > UA_TIMESTAMPSTORETURN_NEITHER) {
  441. response->responseHeader.serviceResult = UA_STATUSCODE_BADTIMESTAMPSTORETURNINVALID;
  442. return;
  443. }
  444. /* Get the subscription */
  445. UA_Subscription *sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  446. if(!sub) {
  447. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  448. return;
  449. }
  450. sub->currentLifetimeCount = 0; /* Reset the subscription lifetime */
  451. response->responseHeader.serviceResult =
  452. UA_Server_processServiceOperations(server, session,
  453. (UA_ServiceOperation)Operation_ModifyMonitoredItem, sub,
  454. &request->itemsToModifySize, &UA_TYPES[UA_TYPES_MONITOREDITEMMODIFYREQUEST],
  455. &response->resultsSize, &UA_TYPES[UA_TYPES_MONITOREDITEMMODIFYRESULT]);
  456. }
  457. struct setMonitoringContext {
  458. UA_Subscription *sub;
  459. UA_MonitoringMode monitoringMode;
  460. };
  461. static void
  462. Operation_SetMonitoringMode(UA_Server *server, UA_Session *session,
  463. struct setMonitoringContext *smc,
  464. const UA_UInt32 *monitoredItemId, UA_StatusCode *result) {
  465. UA_MonitoredItem *mon = UA_Subscription_getMonitoredItem(smc->sub, *monitoredItemId);
  466. if(!mon) {
  467. *result = UA_STATUSCODE_BADMONITOREDITEMIDINVALID;
  468. return;
  469. }
  470. if(mon->monitoredItemType != UA_MONITOREDITEMTYPE_CHANGENOTIFY
  471. && mon->monitoredItemType != UA_MONITOREDITEMTYPE_EVENTNOTIFY) {
  472. *result = UA_STATUSCODE_BADNOTIMPLEMENTED;
  473. return;
  474. }
  475. /* Check if the MonitoringMode is valid or not */
  476. if(smc->monitoringMode > UA_MONITORINGMODE_REPORTING) {
  477. *result = UA_STATUSCODE_BADMONITORINGMODEINVALID;
  478. return;
  479. }
  480. if(mon->monitoringMode == smc->monitoringMode)
  481. return;
  482. mon->monitoringMode = smc->monitoringMode;
  483. if(mon->monitoringMode == UA_MONITORINGMODE_REPORTING) {
  484. *result = UA_MonitoredItem_registerSampleCallback(server, mon);
  485. } else {
  486. UA_MonitoredItem_unregisterSampleCallback(server, mon);
  487. // TODO correctly implement SAMPLING
  488. /* Setting the mode to DISABLED or SAMPLING causes all queued Notifications to be deleted */
  489. UA_Notification *notification, *notification_tmp;
  490. TAILQ_FOREACH_SAFE(notification, &mon->queue, listEntry, notification_tmp) {
  491. UA_Notification_dequeue(server, notification);
  492. UA_Notification_delete(notification);
  493. }
  494. /* Initialize lastSampledValue */
  495. UA_ByteString_deleteMembers(&mon->lastSampledValue);
  496. UA_Variant_deleteMembers(&mon->lastValue);
  497. }
  498. }
  499. void
  500. Service_SetMonitoringMode(UA_Server *server, UA_Session *session,
  501. const UA_SetMonitoringModeRequest *request,
  502. UA_SetMonitoringModeResponse *response) {
  503. UA_LOG_DEBUG_SESSION(&server->config.logger, session, "Processing SetMonitoringMode");
  504. if(server->config.maxMonitoredItemsPerCall != 0 &&
  505. request->monitoredItemIdsSize > server->config.maxMonitoredItemsPerCall) {
  506. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  507. return;
  508. }
  509. /* Get the subscription */
  510. struct setMonitoringContext smc;
  511. smc.sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  512. if(!smc.sub) {
  513. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  514. return;
  515. }
  516. smc.sub->currentLifetimeCount = 0; /* Reset the subscription lifetime */
  517. smc.monitoringMode = request->monitoringMode;
  518. response->responseHeader.serviceResult =
  519. UA_Server_processServiceOperations(server, session,
  520. (UA_ServiceOperation)Operation_SetMonitoringMode, &smc,
  521. &request->monitoredItemIdsSize, &UA_TYPES[UA_TYPES_UINT32],
  522. &response->resultsSize, &UA_TYPES[UA_TYPES_STATUSCODE]);
  523. }
  524. /* TODO: Unify with senderror in ua_server_binary.c */
  525. static void
  526. subscriptionSendError(UA_SecureChannel *channel, UA_UInt32 requestHandle,
  527. UA_UInt32 requestId, UA_StatusCode error) {
  528. UA_PublishResponse err_response;
  529. UA_PublishResponse_init(&err_response);
  530. err_response.responseHeader.requestHandle = requestHandle;
  531. err_response.responseHeader.timestamp = UA_DateTime_now();
  532. err_response.responseHeader.serviceResult = error;
  533. UA_SecureChannel_sendSymmetricMessage(channel, requestId, UA_MESSAGETYPE_MSG,
  534. &err_response, &UA_TYPES[UA_TYPES_PUBLISHRESPONSE]);
  535. }
  536. void
  537. Service_Publish(UA_Server *server, UA_Session *session,
  538. const UA_PublishRequest *request, UA_UInt32 requestId) {
  539. UA_LOG_DEBUG_SESSION(&server->config.logger, session, "Processing PublishRequest");
  540. /* Return an error if the session has no subscription */
  541. if(LIST_EMPTY(&session->serverSubscriptions)) {
  542. subscriptionSendError(session->header.channel, request->requestHeader.requestHandle,
  543. requestId, UA_STATUSCODE_BADNOSUBSCRIPTION);
  544. return;
  545. }
  546. /* Handle too many subscriptions to free resources before trying to allocate
  547. * resources for the new publish request. If the limit has been reached the
  548. * oldest publish request shall be responded */
  549. if((server->config.maxPublishReqPerSession != 0) &&
  550. (session->numPublishReq >= server->config.maxPublishReqPerSession)) {
  551. if(!UA_Subscription_reachedPublishReqLimit(server, session)) {
  552. subscriptionSendError(session->header.channel, requestId,
  553. request->requestHeader.requestHandle,
  554. UA_STATUSCODE_BADINTERNALERROR);
  555. return;
  556. }
  557. }
  558. /* Allocate the response to store it in the retransmission queue */
  559. UA_PublishResponseEntry *entry = (UA_PublishResponseEntry *)
  560. UA_malloc(sizeof(UA_PublishResponseEntry));
  561. if(!entry) {
  562. subscriptionSendError(session->header.channel, requestId,
  563. request->requestHeader.requestHandle,
  564. UA_STATUSCODE_BADOUTOFMEMORY);
  565. return;
  566. }
  567. /* Prepare the response */
  568. entry->requestId = requestId;
  569. UA_PublishResponse *response = &entry->response;
  570. UA_PublishResponse_init(response);
  571. response->responseHeader.requestHandle = request->requestHeader.requestHandle;
  572. /* Allocate the results array to acknowledge the acknowledge */
  573. if(request->subscriptionAcknowledgementsSize > 0) {
  574. response->results = (UA_StatusCode *)
  575. UA_Array_new(request->subscriptionAcknowledgementsSize,
  576. &UA_TYPES[UA_TYPES_STATUSCODE]);
  577. if(!response->results) {
  578. UA_free(entry);
  579. subscriptionSendError(session->header.channel, requestId,
  580. request->requestHeader.requestHandle,
  581. UA_STATUSCODE_BADOUTOFMEMORY);
  582. return;
  583. }
  584. response->resultsSize = request->subscriptionAcknowledgementsSize;
  585. }
  586. /* Delete Acknowledged Subscription Messages */
  587. for(size_t i = 0; i < request->subscriptionAcknowledgementsSize; ++i) {
  588. UA_SubscriptionAcknowledgement *ack = &request->subscriptionAcknowledgements[i];
  589. UA_Subscription *sub = UA_Session_getSubscriptionById(session, ack->subscriptionId);
  590. if(!sub) {
  591. response->results[i] = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  592. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  593. "Cannot process acknowledgements subscription %u",
  594. ack->subscriptionId);
  595. continue;
  596. }
  597. /* Remove the acked transmission from the retransmission queue */
  598. response->results[i] = UA_Subscription_removeRetransmissionMessage(sub, ack->sequenceNumber);
  599. }
  600. /* Queue the publish response. It will be dequeued in a repeated publish
  601. * callback. This can also be triggered right now for a late
  602. * subscription. */
  603. UA_Session_queuePublishReq(session, entry, false);
  604. UA_LOG_DEBUG_SESSION(&server->config.logger, session, "Queued a publication message");
  605. /* If there are late subscriptions, the new publish request is used to
  606. * answer them immediately. However, a single subscription that generates
  607. * many notifications must not "starve" other late subscriptions. Therefore
  608. * we keep track of the last subscription that got preferential treatment.
  609. * We start searching for late subscriptions **after** the last one. */
  610. UA_Subscription *immediate = NULL;
  611. if(session->lastSeenSubscriptionId > 0) {
  612. LIST_FOREACH(immediate, &session->serverSubscriptions, listEntry) {
  613. if(immediate->subscriptionId == session->lastSeenSubscriptionId) {
  614. immediate = LIST_NEXT(immediate, listEntry);
  615. break;
  616. }
  617. }
  618. }
  619. /* If no entry was found, start at the beginning and don't restart */
  620. UA_Boolean found = false;
  621. if(!immediate)
  622. immediate = LIST_FIRST(&session->serverSubscriptions);
  623. else
  624. found = true;
  625. repeat:
  626. while(immediate) {
  627. if(immediate->state == UA_SUBSCRIPTIONSTATE_LATE) {
  628. session->lastSeenSubscriptionId = immediate->subscriptionId;
  629. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  630. "Subscription %u | Response on a late subscription",
  631. immediate->subscriptionId);
  632. UA_Subscription_publish(server, immediate);
  633. return;
  634. }
  635. immediate = LIST_NEXT(immediate, listEntry);
  636. }
  637. /* Restart at the beginning of the list */
  638. if(found) {
  639. immediate = LIST_FIRST(&session->serverSubscriptions);
  640. found = false;
  641. goto repeat;
  642. }
  643. /* No late subscription this time */
  644. session->lastSeenSubscriptionId = 0;
  645. }
  646. static void
  647. Operation_DeleteSubscription(UA_Server *server, UA_Session *session, void *_,
  648. const UA_UInt32 *subscriptionId, UA_StatusCode *result) {
  649. *result = UA_Session_deleteSubscription(server, session, *subscriptionId);
  650. if(*result == UA_STATUSCODE_GOOD) {
  651. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  652. "Subscription %u | Subscription deleted",
  653. *subscriptionId);
  654. } else {
  655. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  656. "Deleting Subscription with Id %u failed with error code %s",
  657. *subscriptionId, UA_StatusCode_name(*result));
  658. }
  659. }
  660. void
  661. Service_DeleteSubscriptions(UA_Server *server, UA_Session *session,
  662. const UA_DeleteSubscriptionsRequest *request,
  663. UA_DeleteSubscriptionsResponse *response) {
  664. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  665. "Processing DeleteSubscriptionsRequest");
  666. response->responseHeader.serviceResult =
  667. UA_Server_processServiceOperations(server, session,
  668. (UA_ServiceOperation)Operation_DeleteSubscription, NULL,
  669. &request->subscriptionIdsSize, &UA_TYPES[UA_TYPES_UINT32],
  670. &response->resultsSize, &UA_TYPES[UA_TYPES_STATUSCODE]);
  671. /* The session has at least one subscription */
  672. if(LIST_FIRST(&session->serverSubscriptions))
  673. return;
  674. /* Send remaining publish responses if the last subscription was removed */
  675. UA_Subscription_answerPublishRequestsNoSubscription(server, session);
  676. }
  677. static void
  678. Operation_DeleteMonitoredItem(UA_Server *server, UA_Session *session, UA_Subscription *sub,
  679. const UA_UInt32 *monitoredItemId, UA_StatusCode *result) {
  680. *result = UA_Subscription_deleteMonitoredItem(server, sub, *monitoredItemId);
  681. }
  682. void
  683. Service_DeleteMonitoredItems(UA_Server *server, UA_Session *session,
  684. const UA_DeleteMonitoredItemsRequest *request,
  685. UA_DeleteMonitoredItemsResponse *response) {
  686. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  687. "Processing DeleteMonitoredItemsRequest");
  688. if(server->config.maxMonitoredItemsPerCall != 0 &&
  689. request->monitoredItemIdsSize > server->config.maxMonitoredItemsPerCall) {
  690. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  691. return;
  692. }
  693. /* Get the subscription */
  694. UA_Subscription *sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  695. if(!sub) {
  696. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  697. return;
  698. }
  699. /* Reset the subscription lifetime */
  700. sub->currentLifetimeCount = 0;
  701. response->responseHeader.serviceResult =
  702. UA_Server_processServiceOperations(server, session,
  703. (UA_ServiceOperation)Operation_DeleteMonitoredItem, sub,
  704. &request->monitoredItemIdsSize, &UA_TYPES[UA_TYPES_UINT32],
  705. &response->resultsSize, &UA_TYPES[UA_TYPES_STATUSCODE]);
  706. }
  707. UA_StatusCode
  708. UA_Server_deleteMonitoredItem(UA_Server *server, UA_UInt32 monitoredItemId) {
  709. UA_MonitoredItem *mon;
  710. LIST_FOREACH(mon, &server->localMonitoredItems, listEntry) {
  711. if(mon->monitoredItemId != monitoredItemId)
  712. continue;
  713. LIST_REMOVE(mon, listEntry);
  714. UA_MonitoredItem_delete(server, mon);
  715. return UA_STATUSCODE_GOOD;
  716. }
  717. return UA_STATUSCODE_BADMONITOREDITEMIDINVALID;
  718. }
  719. void
  720. Service_Republish(UA_Server *server, UA_Session *session,
  721. const UA_RepublishRequest *request,
  722. UA_RepublishResponse *response) {
  723. UA_LOG_DEBUG_SESSION(&server->config.logger, session,
  724. "Processing RepublishRequest");
  725. /* Get the subscription */
  726. UA_Subscription *sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  727. if(!sub) {
  728. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  729. return;
  730. }
  731. /* Reset the subscription lifetime */
  732. sub->currentLifetimeCount = 0;
  733. /* Find the notification in the retransmission queue */
  734. UA_NotificationMessageEntry *entry;
  735. TAILQ_FOREACH(entry, &sub->retransmissionQueue, listEntry) {
  736. if(entry->message.sequenceNumber == request->retransmitSequenceNumber)
  737. break;
  738. }
  739. if(!entry) {
  740. response->responseHeader.serviceResult = UA_STATUSCODE_BADMESSAGENOTAVAILABLE;
  741. return;
  742. }
  743. response->responseHeader.serviceResult =
  744. UA_NotificationMessage_copy(&entry->message, &response->notificationMessage);
  745. }
  746. #endif /* UA_ENABLE_SUBSCRIPTIONS */