ua_server.c 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820
  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 2014-2017 (c) Florian Palm
  7. * Copyright 2015-2016 (c) Sten Grüner
  8. * Copyright 2015-2016 (c) Chris Iatrou
  9. * Copyright 2015 (c) LEvertz
  10. * Copyright 2015-2016 (c) Oleksiy Vasylyev
  11. * Copyright 2016 (c) Julian Grothoff
  12. * Copyright 2016-2017 (c) Stefan Profanter, fortiss GmbH
  13. * Copyright 2016 (c) Lorenz Haas
  14. * Copyright 2017 (c) frax2222
  15. * Copyright 2017 (c) Mark Giraud, Fraunhofer IOSB
  16. * Copyright 2018 (c) Hilscher Gesellschaft für Systemautomation mbH (Author: Martin Lang)
  17. * Copyright 2019 (c) Kalycito Infotech Private Limited
  18. */
  19. #include "ua_server_internal.h"
  20. #if UA_MULTITHREADING >= 100
  21. #include "server/ua_server_methodqueue.h"
  22. #endif
  23. #ifdef UA_ENABLE_PUBSUB_INFORMATIONMODEL
  24. #include "ua_pubsub_ns0.h"
  25. #endif
  26. #ifdef UA_ENABLE_SUBSCRIPTIONS
  27. #include "ua_subscription.h"
  28. #endif
  29. #ifdef UA_ENABLE_VALGRIND_INTERACTIVE
  30. #include <valgrind/memcheck.h>
  31. #endif
  32. /**********************/
  33. /* Namespace Handling */
  34. /**********************/
  35. /*
  36. * The NS1 Uri can be changed by the user to some custom string.
  37. * This method is called to initialize the NS1 Uri if it is not set before to the default Application URI.
  38. *
  39. * This is done as soon as the Namespace Array is read or written via node value read / write services,
  40. * or UA_Server_addNamespace, UA_Server_getNamespaceByName or UA_Server_run_startup is called.
  41. *
  42. * Therefore one has to set the custom NS1 URI before one of the previously mentioned steps.
  43. */
  44. void setupNs1Uri(UA_Server *server) {
  45. if (!server->namespaces[1].data) {
  46. UA_String_copy(&server->config.applicationDescription.applicationUri, &server->namespaces[1]);
  47. }
  48. }
  49. UA_UInt16 addNamespace(UA_Server *server, const UA_String name) {
  50. /* ensure that the uri for ns1 is set up from the app description */
  51. setupNs1Uri(server);
  52. /* Check if the namespace already exists in the server's namespace array */
  53. for(UA_UInt16 i = 0; i < server->namespacesSize; ++i) {
  54. if(UA_String_equal(&name, &server->namespaces[i]))
  55. return i;
  56. }
  57. /* Make the array bigger */
  58. UA_String *newNS = (UA_String*)UA_realloc(server->namespaces,
  59. sizeof(UA_String) * (server->namespacesSize + 1));
  60. if(!newNS)
  61. return 0;
  62. server->namespaces = newNS;
  63. /* Copy the namespace string */
  64. UA_StatusCode retval = UA_String_copy(&name, &server->namespaces[server->namespacesSize]);
  65. if(retval != UA_STATUSCODE_GOOD)
  66. return 0;
  67. /* Announce the change (otherwise, the array appears unchanged) */
  68. ++server->namespacesSize;
  69. return (UA_UInt16)(server->namespacesSize - 1);
  70. }
  71. UA_UInt16 UA_Server_addNamespace(UA_Server *server, const char* name) {
  72. /* Override const attribute to get string (dirty hack) */
  73. UA_String nameString;
  74. nameString.length = strlen(name);
  75. nameString.data = (UA_Byte*)(uintptr_t)name;
  76. UA_LOCK(server->serviceMutex);
  77. UA_UInt16 retVal = addNamespace(server, nameString);
  78. UA_UNLOCK(server->serviceMutex);
  79. return retVal;
  80. }
  81. UA_ServerConfig*
  82. UA_Server_getConfig(UA_Server *server)
  83. {
  84. if(!server)
  85. return NULL;
  86. return &server->config;
  87. }
  88. UA_StatusCode
  89. UA_Server_getNamespaceByName(UA_Server *server, const UA_String namespaceUri,
  90. size_t* foundIndex) {
  91. UA_LOCK(server->serviceMutex);
  92. /* ensure that the uri for ns1 is set up from the app description */
  93. setupNs1Uri(server);
  94. for(size_t idx = 0; idx < server->namespacesSize; idx++) {
  95. if(!UA_String_equal(&server->namespaces[idx], &namespaceUri))
  96. continue;
  97. (*foundIndex) = idx;
  98. UA_UNLOCK(server->serviceMutex);
  99. return UA_STATUSCODE_GOOD;
  100. }
  101. UA_UNLOCK(server->serviceMutex);
  102. return UA_STATUSCODE_BADNOTFOUND;
  103. }
  104. UA_StatusCode
  105. UA_Server_forEachChildNodeCall(UA_Server *server, UA_NodeId parentNodeId,
  106. UA_NodeIteratorCallback callback, void *handle) {
  107. UA_LOCK(server->serviceMutex);
  108. const UA_Node *parent = UA_Nodestore_getNode(server->nsCtx, &parentNodeId);
  109. if(!parent) {
  110. UA_UNLOCK(server->serviceMutex);
  111. return UA_STATUSCODE_BADNODEIDINVALID;
  112. }
  113. /* TODO: We need to do an ugly copy of the references array since users may
  114. * delete references from within the callback. In single-threaded mode this
  115. * changes the same node we point at here. In multi-threaded mode, this
  116. * creates a new copy as nodes are truly immutable.
  117. * The callback could remove a node via the regular public API.
  118. * This can remove a member of the nodes-array we iterate over...
  119. * */
  120. UA_Node *parentCopy = UA_Node_copy_alloc(parent);
  121. if(!parentCopy) {
  122. UA_Nodestore_releaseNode(server->nsCtx, parent);
  123. UA_UNLOCK(server->serviceMutex);
  124. return UA_STATUSCODE_BADUNEXPECTEDERROR;
  125. }
  126. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  127. for(size_t i = parentCopy->referencesSize; i > 0; --i) {
  128. UA_NodeReferenceKind *ref = &parentCopy->references[i - 1];
  129. for(size_t j = 0; j<ref->targetIdsSize; j++) {
  130. UA_UNLOCK(server->serviceMutex);
  131. retval = callback(ref->targetIds[j].nodeId, ref->isInverse,
  132. ref->referenceTypeId, handle);
  133. UA_LOCK(server->serviceMutex);
  134. if(retval != UA_STATUSCODE_GOOD)
  135. goto cleanup;
  136. }
  137. }
  138. cleanup:
  139. UA_Node_deleteMembers(parentCopy);
  140. UA_free(parentCopy);
  141. UA_Nodestore_releaseNode(server->nsCtx, parent);
  142. UA_UNLOCK(server->serviceMutex);
  143. return retval;
  144. }
  145. /********************/
  146. /* Server Lifecycle */
  147. /********************/
  148. /* The server needs to be stopped before it can be deleted */
  149. void UA_Server_delete(UA_Server *server) {
  150. /* Delete all internal data */
  151. UA_SecureChannelManager_deleteMembers(&server->secureChannelManager);
  152. UA_LOCK(server->serviceMutex);
  153. UA_SessionManager_deleteMembers(&server->sessionManager);
  154. UA_UNLOCK(server->serviceMutex);
  155. UA_Array_delete(server->namespaces, server->namespacesSize, &UA_TYPES[UA_TYPES_STRING]);
  156. #ifdef UA_ENABLE_SUBSCRIPTIONS
  157. UA_MonitoredItem *mon, *mon_tmp;
  158. LIST_FOREACH_SAFE(mon, &server->localMonitoredItems, listEntry, mon_tmp) {
  159. LIST_REMOVE(mon, listEntry);
  160. UA_LOCK(server->serviceMutex);
  161. UA_MonitoredItem_delete(server, mon);
  162. UA_UNLOCK(server->serviceMutex);
  163. }
  164. #endif
  165. #ifdef UA_ENABLE_PUBSUB
  166. UA_PubSubManager_delete(server, &server->pubSubManager);
  167. #endif
  168. #ifdef UA_ENABLE_DISCOVERY
  169. UA_DiscoveryManager_deleteMembers(&server->discoveryManager, server);
  170. #endif
  171. #if UA_MULTITHREADING >= 100
  172. UA_Server_removeCallback(server, server->nCBIdResponse);
  173. UA_Server_MethodQueues_delete(server);
  174. UA_AsyncMethodManager_deleteMembers(&server->asyncMethodManager);
  175. #endif
  176. /* Clean up the Admin Session */
  177. UA_LOCK(server->serviceMutex);
  178. UA_Session_deleteMembersCleanup(&server->adminSession, server);
  179. UA_UNLOCK(server->serviceMutex);
  180. /* Clean up the work queue */
  181. UA_WorkQueue_cleanup(&server->workQueue);
  182. /* Delete the timed work */
  183. UA_Timer_deleteMembers(&server->timer);
  184. /* Clean up the nodestore */
  185. UA_Nodestore_delete(server->nsCtx);
  186. /* Clean up the config */
  187. UA_ServerConfig_clean(&server->config);
  188. #if UA_MULTITHREADING >= 100
  189. UA_LOCK_DESTROY(server->networkMutex)
  190. UA_LOCK_DESTROY(server->serviceMutex)
  191. #endif
  192. /* Delete the server itself */
  193. UA_free(server);
  194. }
  195. /* Recurring cleanup. Removing unused and timed-out channels and sessions */
  196. static void
  197. UA_Server_cleanup(UA_Server *server, void *_) {
  198. UA_LOCK(server->serviceMutex);
  199. UA_DateTime nowMonotonic = UA_DateTime_nowMonotonic();
  200. UA_SessionManager_cleanupTimedOut(&server->sessionManager, nowMonotonic);
  201. UA_SecureChannelManager_cleanupTimedOut(&server->secureChannelManager, nowMonotonic);
  202. #ifdef UA_ENABLE_DISCOVERY
  203. UA_Discovery_cleanupTimedOut(server, nowMonotonic);
  204. #endif
  205. UA_UNLOCK(server->serviceMutex);
  206. }
  207. /********************/
  208. /* Server Lifecycle */
  209. /********************/
  210. static UA_Server *
  211. UA_Server_init(UA_Server *server) {
  212. /* Init start time to zero, the actual start time will be sampled in
  213. * UA_Server_run_startup() */
  214. server->startTime = 0;
  215. /* Set a seed for non-cyptographic randomness */
  216. #ifndef UA_ENABLE_DETERMINISTIC_RNG
  217. UA_random_seed((UA_UInt64)UA_DateTime_now());
  218. #endif
  219. #if UA_MULTITHREADING >= 100
  220. UA_LOCK_INIT(server->networkMutex)
  221. UA_LOCK_INIT(server->serviceMutex)
  222. #endif
  223. /* Initialize the handling of repeated callbacks */
  224. UA_Timer_init(&server->timer);
  225. UA_WorkQueue_init(&server->workQueue);
  226. /* Initialize the adminSession */
  227. UA_Session_init(&server->adminSession);
  228. server->adminSession.sessionId.identifierType = UA_NODEIDTYPE_GUID;
  229. server->adminSession.sessionId.identifier.guid.data1 = 1;
  230. server->adminSession.validTill = UA_INT64_MAX;
  231. /* Create Namespaces 0 and 1
  232. * Ns1 will be filled later with the uri from the app description */
  233. server->namespaces = (UA_String *)UA_Array_new(2, &UA_TYPES[UA_TYPES_STRING]);
  234. if(!server->namespaces) {
  235. UA_Server_delete(server);
  236. return NULL;
  237. }
  238. server->namespaces[0] = UA_STRING_ALLOC("http://opcfoundation.org/UA/");
  239. server->namespaces[1] = UA_STRING_NULL;
  240. server->namespacesSize = 2;
  241. /* Initialized SecureChannel and Session managers */
  242. UA_SecureChannelManager_init(&server->secureChannelManager, server);
  243. UA_SessionManager_init(&server->sessionManager, server);
  244. #if UA_MULTITHREADING >= 100
  245. UA_AsyncMethodManager_init(&server->asyncMethodManager, server);
  246. UA_Server_MethodQueues_init(server);
  247. /* Add a regular callback for for checking responmses using a 50ms interval. */
  248. UA_Server_addRepeatedCallback(server, (UA_ServerCallback)UA_Server_CallMethodResponse, NULL,
  249. 50.0, &server->nCBIdResponse);
  250. #endif
  251. /* Add a regular callback for cleanup and maintenance. With a 10s interval. */
  252. UA_Server_addRepeatedCallback(server, (UA_ServerCallback)UA_Server_cleanup, NULL,
  253. 10000.0, NULL);
  254. /* Initialize namespace 0*/
  255. UA_StatusCode retVal = UA_Nodestore_new(&server->nsCtx);
  256. if(retVal != UA_STATUSCODE_GOOD)
  257. goto cleanup;
  258. retVal = UA_Server_initNS0(server);
  259. if(retVal != UA_STATUSCODE_GOOD)
  260. goto cleanup;
  261. /* Build PubSub information model */
  262. #ifdef UA_ENABLE_PUBSUB_INFORMATIONMODEL
  263. UA_Server_initPubSubNS0(server);
  264. #endif
  265. return server;
  266. cleanup:
  267. UA_Server_delete(server);
  268. return NULL;
  269. }
  270. UA_Server *
  271. UA_Server_newWithConfig(const UA_ServerConfig *config) {
  272. if(!config)
  273. return NULL;
  274. UA_Server *server = (UA_Server *)UA_calloc(1, sizeof(UA_Server));
  275. if(!server)
  276. return NULL;
  277. server->config = *config;
  278. return UA_Server_init(server);
  279. }
  280. /* Returns if the server should be shut down immediately */
  281. static UA_Boolean
  282. setServerShutdown(UA_Server *server) {
  283. if(server->endTime != 0)
  284. return false;
  285. if(server->config.shutdownDelay == 0)
  286. return true;
  287. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  288. "Shutting down the server with a delay of %i ms", (int)server->config.shutdownDelay);
  289. server->endTime = UA_DateTime_now() + (UA_DateTime)(server->config.shutdownDelay * UA_DATETIME_MSEC);
  290. return false;
  291. }
  292. /*******************/
  293. /* Timed Callbacks */
  294. /*******************/
  295. UA_StatusCode
  296. UA_Server_addTimedCallback(UA_Server *server, UA_ServerCallback callback,
  297. void *data, UA_DateTime date, UA_UInt64 *callbackId) {
  298. UA_LOCK(server->serviceMutex);
  299. UA_StatusCode retval = UA_Timer_addTimedCallback(&server->timer,
  300. (UA_ApplicationCallback)callback,
  301. server, data, date, callbackId);
  302. UA_UNLOCK(server->serviceMutex);
  303. return retval;
  304. }
  305. UA_StatusCode
  306. addRepeatedCallback(UA_Server *server, UA_ServerCallback callback,
  307. void *data, UA_Double interval_ms,
  308. UA_UInt64 *callbackId) {
  309. return UA_Timer_addRepeatedCallback(&server->timer,
  310. (UA_ApplicationCallback)callback,
  311. server, data, interval_ms, callbackId);
  312. }
  313. UA_StatusCode
  314. UA_Server_addRepeatedCallback(UA_Server *server, UA_ServerCallback callback,
  315. void *data, UA_Double interval_ms,
  316. UA_UInt64 *callbackId) {
  317. UA_LOCK(server->serviceMutex);
  318. UA_StatusCode retval = addRepeatedCallback(server, callback, data, interval_ms, callbackId);
  319. UA_UNLOCK(server->serviceMutex);
  320. return retval;
  321. }
  322. UA_StatusCode
  323. changeRepeatedCallbackInterval(UA_Server *server, UA_UInt64 callbackId,
  324. UA_Double interval_ms) {
  325. return UA_Timer_changeRepeatedCallbackInterval(&server->timer, callbackId,
  326. interval_ms);
  327. }
  328. UA_StatusCode
  329. UA_Server_changeRepeatedCallbackInterval(UA_Server *server, UA_UInt64 callbackId,
  330. UA_Double interval_ms) {
  331. UA_LOCK(server->serviceMutex);
  332. UA_StatusCode retval = changeRepeatedCallbackInterval(server, callbackId, interval_ms);
  333. UA_UNLOCK(server->serviceMutex);
  334. return retval;
  335. }
  336. void
  337. removeCallback(UA_Server *server, UA_UInt64 callbackId) {
  338. UA_Timer_removeCallback(&server->timer, callbackId);
  339. }
  340. void
  341. UA_Server_removeCallback(UA_Server *server, UA_UInt64 callbackId) {
  342. UA_LOCK(server->serviceMutex);
  343. removeCallback(server, callbackId);
  344. UA_UNLOCK(server->serviceMutex);
  345. }
  346. UA_StatusCode UA_EXPORT
  347. UA_Server_updateCertificate(UA_Server *server,
  348. const UA_ByteString *oldCertificate,
  349. const UA_ByteString *newCertificate,
  350. const UA_ByteString *newPrivateKey,
  351. UA_Boolean closeSessions,
  352. UA_Boolean closeSecureChannels) {
  353. if (server == NULL || oldCertificate == NULL
  354. || newCertificate == NULL || newPrivateKey == NULL) {
  355. return UA_STATUSCODE_BADINTERNALERROR;
  356. }
  357. if (closeSessions) {
  358. UA_SessionManager *sm = &server->sessionManager;
  359. session_list_entry *current;
  360. LIST_FOREACH(current, &sm->sessions, pointers) {
  361. if (UA_ByteString_equal(oldCertificate,
  362. &current->session.header.channel->securityPolicy->localCertificate)) {
  363. UA_LOCK(server->serviceMutex);
  364. UA_SessionManager_removeSession(sm, &current->session.header.authenticationToken);
  365. UA_UNLOCK(server->serviceMutex);
  366. }
  367. }
  368. }
  369. if (closeSecureChannels) {
  370. UA_SecureChannelManager *cm = &server->secureChannelManager;
  371. channel_entry *entry;
  372. TAILQ_FOREACH(entry, &cm->channels, pointers) {
  373. if(UA_ByteString_equal(&entry->channel.securityPolicy->localCertificate, oldCertificate)){
  374. UA_SecureChannelManager_close(cm, entry->channel.securityToken.channelId);
  375. }
  376. }
  377. }
  378. size_t i = 0;
  379. while (i < server->config.endpointsSize) {
  380. UA_EndpointDescription *ed = &server->config.endpoints[i];
  381. if (UA_ByteString_equal(&ed->serverCertificate, oldCertificate)) {
  382. UA_String_deleteMembers(&ed->serverCertificate);
  383. UA_String_copy(newCertificate, &ed->serverCertificate);
  384. UA_SecurityPolicy *sp = UA_SecurityPolicy_getSecurityPolicyByUri(server, &server->config.endpoints[i].securityPolicyUri);
  385. if(!sp)
  386. return UA_STATUSCODE_BADINTERNALERROR;
  387. sp->updateCertificateAndPrivateKey(sp, *newCertificate, *newPrivateKey);
  388. }
  389. i++;
  390. }
  391. return UA_STATUSCODE_GOOD;
  392. }
  393. /***************************/
  394. /* Server lookup functions */
  395. /***************************/
  396. UA_SecurityPolicy *
  397. UA_SecurityPolicy_getSecurityPolicyByUri(const UA_Server *server,
  398. const UA_ByteString *securityPolicyUri) {
  399. for(size_t i = 0; i < server->config.securityPoliciesSize; i++) {
  400. UA_SecurityPolicy *securityPolicyCandidate = &server->config.securityPolicies[i];
  401. if(UA_ByteString_equal(securityPolicyUri, &securityPolicyCandidate->policyUri))
  402. return securityPolicyCandidate;
  403. }
  404. return NULL;
  405. }
  406. #ifdef UA_ENABLE_ENCRYPTION
  407. /* The local ApplicationURI has to match the certificates of the
  408. * SecurityPolicies */
  409. static void
  410. verifyServerApplicationURI(const UA_Server *server) {
  411. #if UA_LOGLEVEL <= 400
  412. for(size_t i = 0; i < server->config.securityPoliciesSize; i++) {
  413. UA_SecurityPolicy *sp = &server->config.securityPolicies[i];
  414. if(!sp->certificateVerification)
  415. continue;
  416. UA_StatusCode retval =
  417. sp->certificateVerification->
  418. verifyApplicationURI(sp->certificateVerification->context,
  419. &sp->localCertificate,
  420. &server->config.applicationDescription.applicationUri);
  421. if(retval != UA_STATUSCODE_GOOD) {
  422. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  423. "The configured ApplicationURI does not match the URI "
  424. "specified in the certificate for the SecurityPolicy %.*s",
  425. (int)sp->policyUri.length, sp->policyUri.data);
  426. }
  427. }
  428. #endif
  429. }
  430. #endif
  431. #if UA_MULTITHREADING >= 100
  432. void
  433. UA_Server_InsertMethodResponse(UA_Server *server, const UA_UInt32 nRequestId,
  434. const UA_NodeId *nSessionId, const UA_UInt32 nIndex,
  435. const UA_CallMethodResult *response) {
  436. /* Grab the open Request, so we can continue to construct the response */
  437. asyncmethod_list_entry *data =
  438. UA_AsyncMethodManager_getById(&server->asyncMethodManager, nRequestId, nSessionId);
  439. if(!data) {
  440. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  441. "UA_Server_InsertMethodResponse: can not find UA_CallRequest/UA_CallResponse "
  442. "for Req# %u", nRequestId);
  443. return;
  444. }
  445. /* Add UA_CallMethodResult to UA_CallResponse */
  446. UA_CallResponse* pResponse = &data->response;
  447. UA_CallMethodResult_copy(response, pResponse->results + nIndex);
  448. /* Reduce the number of open results. Are we done yet with all requests? */
  449. data->nCountdown -= 1;
  450. if(data->nCountdown > 0)
  451. return;
  452. /* Get the session */
  453. UA_LOCK(server->serviceMutex);
  454. UA_Session* session = UA_SessionManager_getSessionById(&server->sessionManager, data->sessionId);
  455. UA_UNLOCK(server->serviceMutex);
  456. if(!session) {
  457. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER, "UA_Server_InsertMethodResponse: Session is gone");
  458. UA_AsyncMethodManager_removeEntry(&server->asyncMethodManager, data);
  459. return;
  460. }
  461. /* Check the channel */
  462. UA_SecureChannel* channel = session->header.channel;
  463. if(!channel) {
  464. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER, "UA_Server_InsertMethodResponse: Channel is gone");
  465. UA_AsyncMethodManager_removeEntry(&server->asyncMethodManager, data);
  466. return;
  467. }
  468. /* Okay, here we go, send the UA_CallResponse */
  469. sendResponse(channel, data->requestId, data->requestHandle,
  470. (UA_ResponseHeader*)&data->response.responseHeader, data->responseType);
  471. UA_LOG_DEBUG(&server->config.logger, UA_LOGCATEGORY_SERVER,
  472. "UA_Server_SendResponse: Response for Req# %u sent", data->requestId);
  473. /* Remove this job from the UA_AsyncMethodManager */
  474. UA_AsyncMethodManager_removeEntry(&server->asyncMethodManager, data);
  475. }
  476. void
  477. UA_Server_CallMethodResponse(UA_Server *server, void* data) {
  478. /* Server fetches Result from queue */
  479. struct AsyncMethodQueueElement* pResponseServer = NULL;
  480. while(UA_Server_GetAsyncMethodResult(server, &pResponseServer)) {
  481. UA_LOG_DEBUG(&server->config.logger, UA_LOGCATEGORY_SERVER,
  482. "UA_Server_CallMethodResponse: Got Response: OKAY");
  483. UA_Server_InsertMethodResponse(server, pResponseServer->m_nRequestId, &pResponseServer->m_nSessionId,
  484. pResponseServer->m_nIndex, &pResponseServer->m_Response);
  485. UA_Server_DeleteMethodQueueElement(server, pResponseServer);
  486. }
  487. }
  488. #endif
  489. /********************/
  490. /* Main Server Loop */
  491. /********************/
  492. #define UA_MAXTIMEOUT 50 /* Max timeout in ms between main-loop iterations */
  493. /* Start: Spin up the workers and the network layer and sample the server's
  494. * start time.
  495. * Iterate: Process repeated callbacks and events in the network layer. This
  496. * part can be driven from an external main-loop in an event-driven
  497. * single-threaded architecture.
  498. * Stop: Stop workers, finish all callbacks, stop the network layer, clean up */
  499. UA_StatusCode
  500. UA_Server_run_startup(UA_Server *server) {
  501. /* ensure that the uri for ns1 is set up from the app description */
  502. setupNs1Uri(server);
  503. /* write ServerArray with same ApplicationURI value as NamespaceArray */
  504. UA_StatusCode retVal = writeNs0VariableArray(server, UA_NS0ID_SERVER_SERVERARRAY,
  505. &server->config.applicationDescription.applicationUri,
  506. 1, &UA_TYPES[UA_TYPES_STRING]);
  507. if(retVal != UA_STATUSCODE_GOOD)
  508. return retVal;
  509. if(server->state > UA_SERVERLIFECYCLE_FRESH)
  510. return UA_STATUSCODE_GOOD;
  511. /* At least one endpoint has to be configured */
  512. if(server->config.endpointsSize == 0) {
  513. UA_LOG_WARNING(&server->config.logger, UA_LOGCATEGORY_SERVER,
  514. "There has to be at least one endpoint.");
  515. }
  516. /* Initialized discovery */
  517. #ifdef UA_ENABLE_DISCOVERY
  518. UA_DiscoveryManager_init(&server->discoveryManager, server);
  519. #endif
  520. /* Does the ApplicationURI match the local certificates? */
  521. #ifdef UA_ENABLE_ENCRYPTION
  522. verifyServerApplicationURI(server);
  523. #endif
  524. /* Sample the start time and set it to the Server object */
  525. server->startTime = UA_DateTime_now();
  526. UA_Variant var;
  527. UA_Variant_init(&var);
  528. UA_Variant_setScalar(&var, &server->startTime, &UA_TYPES[UA_TYPES_DATETIME]);
  529. UA_Server_writeValue(server,
  530. UA_NODEID_NUMERIC(0, UA_NS0ID_SERVER_SERVERSTATUS_STARTTIME),
  531. var);
  532. /* Start the networklayers */
  533. UA_StatusCode result = UA_STATUSCODE_GOOD;
  534. for(size_t i = 0; i < server->config.networkLayersSize; ++i) {
  535. UA_ServerNetworkLayer *nl = &server->config.networkLayers[i];
  536. result |= nl->start(nl, &server->config.customHostname);
  537. }
  538. /* Update the application description to match the previously added discovery urls.
  539. * We can only do this after the network layer is started since it inits the discovery url */
  540. if (server->config.applicationDescription.discoveryUrlsSize != 0) {
  541. UA_Array_delete(server->config.applicationDescription.discoveryUrls, server->config.applicationDescription.discoveryUrlsSize, &UA_TYPES[UA_TYPES_STRING]);
  542. server->config.applicationDescription.discoveryUrlsSize = 0;
  543. }
  544. server->config.applicationDescription.discoveryUrls = (UA_String *) UA_Array_new(server->config.networkLayersSize, &UA_TYPES[UA_TYPES_STRING]);
  545. if (!server->config.applicationDescription.discoveryUrls) {
  546. return UA_STATUSCODE_BADOUTOFMEMORY;
  547. }
  548. server->config.applicationDescription.discoveryUrlsSize = server->config.networkLayersSize;
  549. for (size_t i=0; i< server->config.applicationDescription.discoveryUrlsSize; i++) {
  550. UA_ServerNetworkLayer *nl = &server->config.networkLayers[i];
  551. UA_String_copy(&nl->discoveryUrl, &server->config.applicationDescription.discoveryUrls[i]);
  552. }
  553. /* Spin up the worker threads */
  554. #if UA_MULTITHREADING >= 200
  555. UA_LOG_INFO(&server->config.logger, UA_LOGCATEGORY_SERVER,
  556. "Spinning up %u worker thread(s)", server->config.nThreads);
  557. UA_WorkQueue_start(&server->workQueue, server->config.nThreads);
  558. #endif
  559. /* Start the multicast discovery server */
  560. #ifdef UA_ENABLE_DISCOVERY_MULTICAST
  561. if(server->config.discovery.mdnsEnable)
  562. startMulticastDiscoveryServer(server);
  563. #endif
  564. server->state = UA_SERVERLIFECYCLE_FRESH;
  565. return result;
  566. }
  567. static void
  568. serverExecuteRepeatedCallback(UA_Server *server, UA_ApplicationCallback cb,
  569. void *callbackApplication, void *data) {
  570. #if UA_MULTITHREADING >= 200
  571. UA_WorkQueue_enqueue(&server->workQueue, cb, callbackApplication, data);
  572. #else
  573. cb(callbackApplication, data);
  574. #endif
  575. }
  576. UA_UInt16
  577. UA_Server_run_iterate(UA_Server *server, UA_Boolean waitInternal) {
  578. /* Process repeated work */
  579. UA_DateTime now = UA_DateTime_nowMonotonic();
  580. UA_DateTime nextRepeated = UA_Timer_process(&server->timer, now,
  581. (UA_TimerExecutionCallback)serverExecuteRepeatedCallback, server);
  582. UA_DateTime latest = now + (UA_MAXTIMEOUT * UA_DATETIME_MSEC);
  583. if(nextRepeated > latest)
  584. nextRepeated = latest;
  585. UA_UInt16 timeout = 0;
  586. /* round always to upper value to avoid timeout to be set to 0
  587. * if(nextRepeated - now) < (UA_DATETIME_MSEC/2) */
  588. if(waitInternal)
  589. timeout = (UA_UInt16)(((nextRepeated - now) + (UA_DATETIME_MSEC - 1)) / UA_DATETIME_MSEC);
  590. /* Listen on the networklayer */
  591. for(size_t i = 0; i < server->config.networkLayersSize; ++i) {
  592. UA_ServerNetworkLayer *nl = &server->config.networkLayers[i];
  593. nl->listen(nl, server, timeout);
  594. }
  595. #if defined(UA_ENABLE_DISCOVERY_MULTICAST) && (UA_MULTITHREADING < 200)
  596. if(server->config.discovery.mdnsEnable) {
  597. // TODO multicastNextRepeat does not consider new input data (requests)
  598. // on the socket. It will be handled on the next call. if needed, we
  599. // need to use select with timeout on the multicast socket
  600. // server->mdnsSocket (see example in mdnsd library) on higher level.
  601. UA_DateTime multicastNextRepeat = 0;
  602. UA_StatusCode hasNext =
  603. iterateMulticastDiscoveryServer(server, &multicastNextRepeat, true);
  604. if(hasNext == UA_STATUSCODE_GOOD && multicastNextRepeat < nextRepeated)
  605. nextRepeated = multicastNextRepeat;
  606. }
  607. #endif
  608. #if UA_MULTITHREADING < 200
  609. UA_WorkQueue_manuallyProcessDelayed(&server->workQueue);
  610. #endif
  611. now = UA_DateTime_nowMonotonic();
  612. timeout = 0;
  613. if(nextRepeated > now)
  614. timeout = (UA_UInt16)((nextRepeated - now) / UA_DATETIME_MSEC);
  615. return timeout;
  616. }
  617. UA_StatusCode
  618. UA_Server_run_shutdown(UA_Server *server) {
  619. /* Stop the netowrk layer */
  620. for(size_t i = 0; i < server->config.networkLayersSize; ++i) {
  621. UA_ServerNetworkLayer *nl = &server->config.networkLayers[i];
  622. nl->stop(nl, server);
  623. }
  624. #if UA_MULTITHREADING >= 200
  625. /* Shut down the workers */
  626. UA_LOG_INFO(&server->config.logger, UA_LOGCATEGORY_SERVER,
  627. "Shutting down %u worker thread(s)",
  628. (UA_UInt32)server->workQueue.workersSize);
  629. UA_WorkQueue_stop(&server->workQueue);
  630. #endif
  631. #ifdef UA_ENABLE_DISCOVERY_MULTICAST
  632. /* Stop multicast discovery */
  633. if(server->config.discovery.mdnsEnable)
  634. stopMulticastDiscoveryServer(server);
  635. #endif
  636. /* Execute all delayed callbacks */
  637. UA_WorkQueue_cleanup(&server->workQueue);
  638. return UA_STATUSCODE_GOOD;
  639. }
  640. static UA_Boolean
  641. testShutdownCondition(UA_Server *server) {
  642. if(server->endTime == 0)
  643. return false;
  644. return (UA_DateTime_now() > server->endTime);
  645. }
  646. UA_StatusCode
  647. UA_Server_run(UA_Server *server, const volatile UA_Boolean *running) {
  648. UA_StatusCode retval = UA_Server_run_startup(server);
  649. if(retval != UA_STATUSCODE_GOOD)
  650. return retval;
  651. #ifdef UA_ENABLE_VALGRIND_INTERACTIVE
  652. size_t loopCount = 0;
  653. #endif
  654. while(!testShutdownCondition(server)) {
  655. #ifdef UA_ENABLE_VALGRIND_INTERACTIVE
  656. if(loopCount == 0) {
  657. VALGRIND_DO_LEAK_CHECK;
  658. }
  659. ++loopCount;
  660. loopCount %= UA_VALGRIND_INTERACTIVE_INTERVAL;
  661. #endif
  662. UA_Server_run_iterate(server, true);
  663. if(!*running) {
  664. if(setServerShutdown(server))
  665. break;
  666. }
  667. }
  668. return UA_Server_run_shutdown(server);
  669. }
  670. #ifdef UA_ENABLE_HISTORIZING
  671. /* Allow insert of historical data */
  672. UA_Boolean
  673. UA_Server_AccessControl_allowHistoryUpdateUpdateData(UA_Server *server,
  674. const UA_NodeId *sessionId, void *sessionContext,
  675. const UA_NodeId *nodeId,
  676. UA_PerformUpdateType performInsertReplace,
  677. const UA_DataValue *value) {
  678. if(server->config.accessControl.allowHistoryUpdateUpdateData &&
  679. !server->config.accessControl.allowHistoryUpdateUpdateData(server, &server->config.accessControl,
  680. sessionId, sessionContext, nodeId,
  681. performInsertReplace, value)) {
  682. return false;
  683. }
  684. return true;
  685. }
  686. /* Allow delete of historical data */
  687. UA_Boolean
  688. UA_Server_AccessControl_allowHistoryUpdateDeleteRawModified(UA_Server *server,
  689. const UA_NodeId *sessionId, void *sessionContext,
  690. const UA_NodeId *nodeId,
  691. UA_DateTime startTimestamp,
  692. UA_DateTime endTimestamp,
  693. bool isDeleteModified) {
  694. if(server->config.accessControl.allowHistoryUpdateDeleteRawModified &&
  695. !server->config.accessControl.allowHistoryUpdateDeleteRawModified(server, &server->config.accessControl,
  696. sessionId, sessionContext, nodeId,
  697. startTimestamp, endTimestamp,
  698. isDeleteModified)) {
  699. return false;
  700. }
  701. return true;
  702. }
  703. #endif /* UA_ENABLE_HISTORIZING */