Line data Source code
1 : /*
2 : *
3 : * Copyright (c) 2021 Project CHIP Authors
4 : * All rights reserved.
5 : *
6 : * Licensed under the Apache License, Version 2.0 (the "License");
7 : * you may not use this file except in compliance with the License.
8 : * You may obtain a copy of the License at
9 : *
10 : * http://www.apache.org/licenses/LICENSE-2.0
11 : *
12 : * Unless required by applicable law or agreed to in writing, software
13 : * distributed under the License is distributed on an "AS IS" BASIS,
14 : * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 : * See the License for the specific language governing permissions and
16 : * limitations under the License.
17 : */
18 :
19 : /**
20 : * @file
21 : * Implementation of CHIP Device Controller Factory, a utility/manager class
22 : * that vends Controller objects
23 : */
24 :
25 : #include <controller/CHIPDeviceControllerFactory.h>
26 :
27 : #include <app/InteractionModelEngine.h>
28 : #include <app/OperationalSessionSetup.h>
29 : #include <app/TimerDelegates.h>
30 : #include <app/reporting/ReportSchedulerImpl.h>
31 : #include <app/util/DataModelHandler.h>
32 : #include <lib/core/ErrorStr.h>
33 : #include <messaging/ReliableMessageProtocolConfig.h>
34 :
35 : #if CONFIG_DEVICE_LAYER
36 : #include <platform/CHIPDeviceLayer.h>
37 : #include <platform/ConfigurationManager.h>
38 : #endif
39 :
40 : #include <app/server/Dnssd.h>
41 : #include <protocols/secure_channel/CASEServer.h>
42 : #include <protocols/secure_channel/SimpleSessionResumptionStorage.h>
43 :
44 : using namespace chip::Inet;
45 : using namespace chip::System;
46 : using namespace chip::Credentials;
47 :
48 : namespace chip {
49 : namespace Controller {
50 :
51 0 : CHIP_ERROR DeviceControllerFactory::Init(FactoryInitParams params)
52 : {
53 :
54 : // SystemState is only set the first time init is called, after that it is managed
55 : // internally. If SystemState is set then init has already completed.
56 0 : if (mSystemState != nullptr)
57 : {
58 0 : ChipLogError(Controller, "Device Controller Factory already initialized...");
59 0 : return CHIP_NO_ERROR;
60 : }
61 :
62 : // Save our initialization state that we can't recover later from a
63 : // created-but-shut-down system state.
64 0 : mListenPort = params.listenPort;
65 0 : mFabricIndependentStorage = params.fabricIndependentStorage;
66 0 : mOperationalKeystore = params.operationalKeystore;
67 0 : mOpCertStore = params.opCertStore;
68 0 : mCertificateValidityPolicy = params.certificateValidityPolicy;
69 0 : mSessionResumptionStorage = params.sessionResumptionStorage;
70 0 : mEnableServerInteractions = params.enableServerInteractions;
71 :
72 : // Initialize the system state. Note that it is left in a somewhat
73 : // special state where it is initialized, but has a ref count of 0.
74 0 : CHIP_ERROR err = InitSystemState(params);
75 :
76 0 : return err;
77 : }
78 :
79 0 : CHIP_ERROR DeviceControllerFactory::ReinitSystemStateIfNecessary()
80 : {
81 0 : VerifyOrReturnError(mSystemState != nullptr, CHIP_ERROR_INCORRECT_STATE);
82 0 : VerifyOrReturnError(mSystemState->IsShutDown(), CHIP_NO_ERROR);
83 :
84 0 : FactoryInitParams params;
85 0 : params.systemLayer = mSystemState->SystemLayer();
86 0 : params.udpEndPointManager = mSystemState->UDPEndPointManager();
87 : #if INET_CONFIG_ENABLE_TCP_ENDPOINT
88 0 : params.tcpEndPointManager = mSystemState->TCPEndPointManager();
89 : #endif
90 : #if CONFIG_NETWORK_LAYER_BLE
91 0 : params.bleLayer = mSystemState->BleLayer();
92 : #endif
93 0 : params.listenPort = mListenPort;
94 0 : params.fabricIndependentStorage = mFabricIndependentStorage;
95 0 : params.enableServerInteractions = mEnableServerInteractions;
96 0 : params.groupDataProvider = mSystemState->GetGroupDataProvider();
97 0 : params.sessionKeystore = mSystemState->GetSessionKeystore();
98 0 : params.fabricTable = mSystemState->Fabrics();
99 0 : params.operationalKeystore = mOperationalKeystore;
100 0 : params.opCertStore = mOpCertStore;
101 0 : params.certificateValidityPolicy = mCertificateValidityPolicy;
102 0 : params.sessionResumptionStorage = mSessionResumptionStorage;
103 :
104 : // re-initialization keeps any previously initialized values. The only place where
105 : // a provider exists is in the InteractionModelEngine, so just say "keep it as is".
106 0 : params.dataModelProvider = app::InteractionModelEngine::GetInstance()->GetDataModelProvider();
107 :
108 0 : return InitSystemState(params);
109 : }
110 :
111 0 : CHIP_ERROR DeviceControllerFactory::InitSystemState(FactoryInitParams params)
112 : {
113 0 : if (mSystemState != nullptr)
114 : {
115 0 : Platform::Delete(mSystemState);
116 0 : mSystemState = nullptr;
117 : }
118 :
119 0 : DeviceControllerSystemStateParams stateParams;
120 : #if CONFIG_DEVICE_LAYER
121 0 : ReturnErrorOnFailure(DeviceLayer::PlatformMgr().InitChipStack());
122 :
123 0 : stateParams.systemLayer = &DeviceLayer::SystemLayer();
124 0 : stateParams.udpEndPointManager = DeviceLayer::UDPEndPointManager();
125 : #if INET_CONFIG_ENABLE_TCP_ENDPOINT
126 0 : stateParams.tcpEndPointManager = DeviceLayer::TCPEndPointManager();
127 : #endif
128 : #else
129 : stateParams.systemLayer = params.systemLayer;
130 : stateParams.tcpEndPointManager = params.tcpEndPointManager;
131 : stateParams.udpEndPointManager = params.udpEndPointManager;
132 : ChipLogError(Controller, "Warning: Device Controller Factory should be with a CHIP Device Layer...");
133 : #endif // CONFIG_DEVICE_LAYER
134 :
135 : #if INET_CONFIG_ENABLE_TCP_ENDPOINT
136 0 : auto tcpListenParams = Transport::TcpListenParameters(stateParams.tcpEndPointManager)
137 0 : .SetAddressType(IPAddressType::kIPv6)
138 0 : .SetListenPort(params.listenPort)
139 0 : .SetServerListenEnabled(false); // Initialize as a TCP Client
140 : #endif
141 :
142 0 : if (params.dataModelProvider == nullptr)
143 : {
144 0 : ChipLogError(AppServer, "Device Controller Factory requires a `dataModelProvider` value.");
145 0 : ChipLogError(AppServer, "For backwards compatibility, you likely can use `CodegenDataModelProviderInstance(...)`");
146 : }
147 :
148 0 : VerifyOrReturnError(params.dataModelProvider != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
149 0 : VerifyOrReturnError(stateParams.systemLayer != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
150 0 : VerifyOrReturnError(stateParams.udpEndPointManager != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
151 :
152 : // OperationalCertificateStore needs to be provided to init the fabric table if fabric table is
153 : // not provided wholesale.
154 0 : VerifyOrReturnError((params.fabricTable != nullptr) || (params.opCertStore != nullptr), CHIP_ERROR_INVALID_ARGUMENT);
155 0 : VerifyOrReturnError(params.sessionKeystore != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
156 :
157 : #if CONFIG_NETWORK_LAYER_BLE
158 : #if CONFIG_DEVICE_LAYER
159 0 : stateParams.bleLayer = DeviceLayer::ConnectivityMgr().GetBleLayer();
160 : #else
161 : stateParams.bleLayer = params.bleLayer;
162 : #endif // CONFIG_DEVICE_LAYER
163 : #if CHIP_DEVICE_CONFIG_ENABLE_WIFIPAF
164 0 : stateParams.wifipaf_layer = params.wifipaf_layer;
165 : #endif
166 0 : VerifyOrReturnError(stateParams.bleLayer != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
167 : #endif
168 :
169 0 : stateParams.transportMgr = chip::Platform::New<DeviceTransportMgr>();
170 :
171 : //
172 : // The logic below expects IPv6 to be at index 0 of this tuple. Keep that logic in sync with
173 : // this code.
174 : //
175 0 : ReturnErrorOnFailure(stateParams.transportMgr->Init(Transport::UdpListenParameters(stateParams.udpEndPointManager)
176 : .SetAddressType(Inet::IPAddressType::kIPv6)
177 : .SetListenPort(params.listenPort)
178 : #if INET_CONFIG_ENABLE_IPV4
179 : ,
180 : //
181 : // The logic below expects IPv4 to be at index 1 of this tuple,
182 : // if it's enabled. Keep that logic in sync with this code.
183 : //
184 : Transport::UdpListenParameters(stateParams.udpEndPointManager)
185 : .SetAddressType(Inet::IPAddressType::kIPv4)
186 : .SetListenPort(params.listenPort)
187 : #endif
188 : #if CONFIG_NETWORK_LAYER_BLE
189 : ,
190 : Transport::BleListenParameters(stateParams.bleLayer)
191 : #endif
192 : #if INET_CONFIG_ENABLE_TCP_ENDPOINT
193 : ,
194 : tcpListenParams
195 : #endif
196 : #if CHIP_DEVICE_CONFIG_ENABLE_WIFIPAF
197 : ,
198 : Transport::WiFiPAFListenParameters()
199 : #endif
200 : #if CHIP_DEVICE_CONFIG_ENABLE_NFC_BASED_COMMISSIONING
201 : ,
202 : Transport::NfcListenParameters(nullptr)
203 : #endif
204 : ));
205 :
206 : // TODO(#16231): All the new'ed state above/below in this method is never properly released or null-checked!
207 0 : stateParams.sessionMgr = chip::Platform::New<SessionManager>();
208 0 : stateParams.certificateValidityPolicy = params.certificateValidityPolicy;
209 0 : stateParams.unsolicitedStatusHandler = Platform::New<Protocols::SecureChannel::UnsolicitedStatusHandler>();
210 0 : stateParams.exchangeMgr = chip::Platform::New<Messaging::ExchangeManager>();
211 0 : stateParams.messageCounterManager = chip::Platform::New<secure_channel::MessageCounterManager>();
212 0 : stateParams.groupDataProvider = params.groupDataProvider;
213 0 : stateParams.timerDelegate = chip::Platform::New<chip::app::DefaultTimerDelegate>();
214 0 : stateParams.reportScheduler = chip::Platform::New<app::reporting::ReportSchedulerImpl>(stateParams.timerDelegate);
215 0 : stateParams.sessionKeystore = params.sessionKeystore;
216 0 : stateParams.bdxTransferServer = chip::Platform::New<bdx::BDXTransferServer>();
217 :
218 : // if no fabricTable was provided, create one and track it in stateParams for cleanup
219 0 : stateParams.fabricTable = params.fabricTable;
220 :
221 0 : FabricTable * tempFabricTable = nullptr;
222 0 : if (stateParams.fabricTable == nullptr)
223 : {
224 : // TODO(#16231): Previously (and still) the objects new-ed in this entire method seem expected to last forever...
225 0 : auto newFabricTable = Platform::MakeUnique<FabricTable>();
226 0 : VerifyOrReturnError(newFabricTable, CHIP_ERROR_NO_MEMORY);
227 :
228 0 : FabricTable::InitParams fabricTableInitParams;
229 0 : fabricTableInitParams.storage = params.fabricIndependentStorage;
230 0 : fabricTableInitParams.operationalKeystore = params.operationalKeystore;
231 0 : fabricTableInitParams.opCertStore = params.opCertStore;
232 0 : ReturnErrorOnFailure(newFabricTable->Init(fabricTableInitParams));
233 0 : stateParams.fabricTable = newFabricTable.release();
234 0 : tempFabricTable = stateParams.fabricTable;
235 0 : }
236 :
237 : SessionResumptionStorage * sessionResumptionStorage;
238 0 : if (params.sessionResumptionStorage == nullptr)
239 : {
240 0 : auto ownedSessionResumptionStorage = chip::Platform::MakeUnique<SimpleSessionResumptionStorage>();
241 0 : ReturnErrorOnFailure(ownedSessionResumptionStorage->Init(params.fabricIndependentStorage));
242 0 : stateParams.ownedSessionResumptionStorage = std::move(ownedSessionResumptionStorage);
243 0 : stateParams.externalSessionResumptionStorage = nullptr;
244 0 : sessionResumptionStorage = stateParams.ownedSessionResumptionStorage.get();
245 0 : }
246 : else
247 : {
248 0 : stateParams.ownedSessionResumptionStorage = nullptr;
249 0 : stateParams.externalSessionResumptionStorage = params.sessionResumptionStorage;
250 0 : sessionResumptionStorage = stateParams.externalSessionResumptionStorage;
251 : }
252 :
253 0 : auto delegate = chip::Platform::MakeUnique<ControllerFabricDelegate>();
254 0 : ReturnErrorOnFailure(delegate->Init(sessionResumptionStorage, stateParams.groupDataProvider));
255 0 : stateParams.fabricTableDelegate = delegate.get();
256 0 : ReturnErrorOnFailure(stateParams.fabricTable->AddFabricDelegate(stateParams.fabricTableDelegate));
257 0 : delegate.release();
258 :
259 0 : ReturnErrorOnFailure(stateParams.sessionMgr->Init(stateParams.systemLayer, stateParams.transportMgr,
260 : stateParams.messageCounterManager, params.fabricIndependentStorage,
261 : stateParams.fabricTable, *stateParams.sessionKeystore));
262 0 : ReturnErrorOnFailure(stateParams.exchangeMgr->Init(stateParams.sessionMgr));
263 0 : ReturnErrorOnFailure(stateParams.messageCounterManager->Init(stateParams.exchangeMgr));
264 0 : ReturnErrorOnFailure(stateParams.unsolicitedStatusHandler->Init(stateParams.exchangeMgr));
265 0 : ReturnErrorOnFailure(stateParams.bdxTransferServer->Init(stateParams.systemLayer, stateParams.exchangeMgr));
266 :
267 0 : chip::app::InteractionModelEngine * interactionModelEngine = chip::app::InteractionModelEngine::GetInstance();
268 :
269 : // Initialize the data model now that everything cluster implementations might
270 : // depend on is initalized.
271 0 : interactionModelEngine->SetDataModelProvider(params.dataModelProvider);
272 :
273 0 : ReturnErrorOnFailure(Dnssd::Resolver::Instance().Init(stateParams.udpEndPointManager));
274 :
275 0 : if (params.enableServerInteractions)
276 : {
277 0 : stateParams.caseServer = chip::Platform::New<CASEServer>();
278 :
279 : // Enable listening for session establishment messages.
280 0 : ReturnErrorOnFailure(stateParams.caseServer->ListenForSessionEstablishment(
281 : stateParams.exchangeMgr, stateParams.sessionMgr, stateParams.fabricTable, sessionResumptionStorage,
282 : stateParams.certificateValidityPolicy, stateParams.groupDataProvider));
283 :
284 : // Our IPv6 transport is at index 0.
285 0 : app::DnssdServer::Instance().SetSecuredIPv6Port(
286 0 : stateParams.transportMgr->GetTransport().GetImplAtIndex<0>().GetBoundPort());
287 :
288 : #if INET_CONFIG_ENABLE_IPV4
289 : // If enabled, our IPv4 transport is at index 1.
290 0 : app::DnssdServer::Instance().SetSecuredIPv4Port(
291 0 : stateParams.transportMgr->GetTransport().GetImplAtIndex<1>().GetBoundPort());
292 : #endif // INET_CONFIG_ENABLE_IPV4
293 :
294 : //
295 : // TODO: This is a hack to workaround the fact that we have a bi-polar stack that has controller and server modalities that
296 : // are mutually exclusive in terms of initialization of key stack singletons. Consequently, DnssdServer accesses
297 : // Server::GetInstance().GetFabricTable() to access the fabric table, but we don't want to do that when we're initializing
298 : // the controller logic since the factory here has its own fabric table.
299 : //
300 : // Consequently, reach in set the fabric table pointer to point to the right version.
301 : //
302 0 : app::DnssdServer::Instance().SetFabricTable(stateParams.fabricTable);
303 :
304 : #if INET_CONFIG_ENABLE_TCP_ENDPOINT
305 : // Disable the TCP Server based on the TCPListenParameters setting.
306 0 : app::DnssdServer::Instance().SetTCPServerEnabled(tcpListenParams.IsServerListenEnabled());
307 : #endif
308 : }
309 :
310 0 : stateParams.sessionSetupPool = Platform::New<DeviceControllerSystemStateParams::SessionSetupPool>();
311 0 : stateParams.caseClientPool = Platform::New<DeviceControllerSystemStateParams::CASEClientPool>();
312 :
313 : CASEClientInitParams sessionInitParams = {
314 0 : .sessionManager = stateParams.sessionMgr,
315 : .sessionResumptionStorage = sessionResumptionStorage,
316 0 : .certificateValidityPolicy = stateParams.certificateValidityPolicy,
317 0 : .exchangeMgr = stateParams.exchangeMgr,
318 0 : .fabricTable = stateParams.fabricTable,
319 0 : .groupDataProvider = stateParams.groupDataProvider,
320 : // Don't provide an MRP local config, so each CASE initiation will use
321 : // the then-current value.
322 : .mrpLocalConfig = NullOptional,
323 0 : };
324 :
325 : CASESessionManagerConfig sessionManagerConfig = {
326 : .sessionInitParams = sessionInitParams,
327 0 : .clientPool = stateParams.caseClientPool,
328 0 : .sessionSetupPool = stateParams.sessionSetupPool,
329 0 : };
330 :
331 : // TODO: Need to be able to create a CASESessionManagerConfig here!
332 0 : stateParams.caseSessionManager = Platform::New<CASESessionManager>();
333 0 : ReturnErrorOnFailure(stateParams.caseSessionManager->Init(stateParams.systemLayer, sessionManagerConfig));
334 :
335 0 : ReturnErrorOnFailure(interactionModelEngine->Init(stateParams.exchangeMgr, stateParams.fabricTable, stateParams.reportScheduler,
336 : stateParams.caseSessionManager));
337 :
338 : // store the system state
339 0 : mSystemState = chip::Platform::New<DeviceControllerSystemState>(std::move(stateParams));
340 0 : mSystemState->SetTempFabricTable(tempFabricTable, params.enableServerInteractions);
341 0 : ChipLogDetail(Controller, "System State Initialized...");
342 0 : return CHIP_NO_ERROR;
343 0 : }
344 :
345 0 : void DeviceControllerFactory::PopulateInitParams(ControllerInitParams & controllerParams, const SetupParams & params)
346 : {
347 0 : controllerParams.operationalCredentialsDelegate = params.operationalCredentialsDelegate;
348 0 : controllerParams.operationalKeypair = params.operationalKeypair;
349 0 : controllerParams.hasExternallyOwnedOperationalKeypair = params.hasExternallyOwnedOperationalKeypair;
350 0 : controllerParams.controllerNOC = params.controllerNOC;
351 0 : controllerParams.controllerICAC = params.controllerICAC;
352 0 : controllerParams.controllerRCAC = params.controllerRCAC;
353 0 : controllerParams.permitMultiControllerFabrics = params.permitMultiControllerFabrics;
354 0 : controllerParams.removeFromFabricTableOnShutdown = params.removeFromFabricTableOnShutdown;
355 0 : controllerParams.deleteFromFabricTableOnShutdown = params.deleteFromFabricTableOnShutdown;
356 :
357 0 : controllerParams.systemState = mSystemState;
358 0 : controllerParams.controllerVendorId = params.controllerVendorId;
359 :
360 0 : controllerParams.enableServerInteractions = params.enableServerInteractions;
361 0 : if (params.fabricIndex.HasValue())
362 : {
363 0 : controllerParams.fabricIndex.SetValue(params.fabricIndex.Value());
364 : }
365 0 : }
366 :
367 0 : void DeviceControllerFactory::ControllerInitialized(const DeviceController & controller)
368 : {
369 0 : if (mEnableServerInteractions && controller.GetFabricIndex() != kUndefinedFabricIndex)
370 : {
371 : // Restart DNS-SD advertising, because initialization of this controller could
372 : // have modified whether a particular fabric identity should be
373 : // advertised. Just calling AdvertiseOperational() is not good enough
374 : // here, since we might be removing advertising.
375 0 : app::DnssdServer::Instance().StartServer();
376 : }
377 0 : }
378 :
379 0 : CHIP_ERROR DeviceControllerFactory::SetupController(SetupParams params, DeviceController & controller)
380 : {
381 0 : VerifyOrReturnError(params.controllerVendorId != VendorId::Unspecified, CHIP_ERROR_INVALID_ARGUMENT);
382 0 : ReturnErrorOnFailure(ReinitSystemStateIfNecessary());
383 :
384 0 : ControllerInitParams controllerParams;
385 0 : PopulateInitParams(controllerParams, params);
386 :
387 0 : CHIP_ERROR err = controller.Init(controllerParams);
388 :
389 0 : if (err == CHIP_NO_ERROR)
390 : {
391 0 : ControllerInitialized(controller);
392 : }
393 :
394 0 : return err;
395 : }
396 :
397 0 : CHIP_ERROR DeviceControllerFactory::SetupCommissioner(SetupParams params, DeviceCommissioner & commissioner)
398 : {
399 0 : VerifyOrReturnError(params.controllerVendorId != VendorId::Unspecified, CHIP_ERROR_INVALID_ARGUMENT);
400 0 : ReturnErrorOnFailure(ReinitSystemStateIfNecessary());
401 :
402 0 : CommissionerInitParams commissionerParams;
403 :
404 : // PopulateInitParams works against ControllerInitParams base class of CommissionerInitParams only
405 0 : PopulateInitParams(commissionerParams, params);
406 :
407 : // Set commissioner-specific fields not in ControllerInitParams
408 0 : commissionerParams.pairingDelegate = params.pairingDelegate;
409 0 : commissionerParams.defaultCommissioner = params.defaultCommissioner;
410 0 : commissionerParams.deviceAttestationVerifier = params.deviceAttestationVerifier;
411 :
412 0 : CHIP_ERROR err = commissioner.Init(commissionerParams);
413 :
414 0 : if (err == CHIP_NO_ERROR)
415 : {
416 0 : ControllerInitialized(commissioner);
417 : }
418 :
419 0 : return err;
420 : }
421 :
422 0 : CHIP_ERROR DeviceControllerFactory::ServiceEvents()
423 : {
424 0 : VerifyOrReturnError(mSystemState != nullptr, CHIP_ERROR_INCORRECT_STATE);
425 :
426 : #if CONFIG_DEVICE_LAYER
427 0 : ReturnErrorOnFailure(DeviceLayer::PlatformMgr().StartEventLoopTask());
428 : #endif // CONFIG_DEVICE_LAYER
429 :
430 0 : return CHIP_NO_ERROR;
431 : }
432 :
433 0 : void DeviceControllerFactory::RetainSystemState()
434 : {
435 0 : (void) mSystemState->Retain();
436 0 : }
437 :
438 0 : bool DeviceControllerFactory::ReleaseSystemState()
439 : {
440 0 : return mSystemState->Release();
441 : }
442 :
443 0 : CHIP_ERROR DeviceControllerFactory::EnsureAndRetainSystemState()
444 : {
445 0 : ReturnErrorOnFailure(ReinitSystemStateIfNecessary());
446 0 : RetainSystemState();
447 0 : return CHIP_NO_ERROR;
448 : }
449 :
450 0 : DeviceControllerFactory::~DeviceControllerFactory()
451 : {
452 0 : Shutdown();
453 0 : }
454 :
455 0 : void DeviceControllerFactory::Shutdown()
456 : {
457 0 : if (mSystemState != nullptr)
458 : {
459 : // ~DeviceControllerSystemState will call Shutdown(),
460 : // which in turn ensures that the reference count is 0.
461 0 : Platform::Delete(mSystemState);
462 0 : mSystemState = nullptr;
463 : }
464 0 : mFabricIndependentStorage = nullptr;
465 0 : mOperationalKeystore = nullptr;
466 0 : mOpCertStore = nullptr;
467 0 : mCertificateValidityPolicy = nullptr;
468 0 : mSessionResumptionStorage = nullptr;
469 0 : }
470 :
471 0 : void DeviceControllerSystemState::Shutdown()
472 : {
473 0 : VerifyOrDie(mRefCount == 0);
474 0 : if (mHaveShutDown)
475 : {
476 : // Nothing else to do here.
477 0 : return;
478 : }
479 0 : mHaveShutDown = true;
480 :
481 0 : ChipLogDetail(Controller, "Shutting down the System State, this will teardown the CHIP Stack");
482 :
483 0 : if (mTempFabricTable && mEnableServerInteractions)
484 : {
485 : // The DnssdServer is holding a reference to our temp fabric table,
486 : // which we are about to destroy. Stop it, so that it will stop trying
487 : // to use it.
488 0 : app::DnssdServer::Instance().StopServer();
489 : }
490 :
491 0 : if (mFabricTableDelegate != nullptr)
492 : {
493 0 : if (mFabrics != nullptr)
494 : {
495 0 : mFabrics->RemoveFabricDelegate(mFabricTableDelegate);
496 : }
497 :
498 0 : chip::Platform::Delete(mFabricTableDelegate);
499 0 : mFabricTableDelegate = nullptr;
500 : }
501 :
502 0 : if (mBDXTransferServer != nullptr)
503 : {
504 0 : mBDXTransferServer->Shutdown();
505 0 : chip::Platform::Delete(mBDXTransferServer);
506 0 : mBDXTransferServer = nullptr;
507 : }
508 :
509 0 : if (mCASEServer != nullptr)
510 : {
511 0 : mCASEServer->Shutdown();
512 0 : chip::Platform::Delete(mCASEServer);
513 0 : mCASEServer = nullptr;
514 : }
515 :
516 0 : if (mCASESessionManager != nullptr)
517 : {
518 0 : mCASESessionManager->Shutdown();
519 0 : Platform::Delete(mCASESessionManager);
520 0 : mCASESessionManager = nullptr;
521 : }
522 :
523 : // The above took care of CASE handshakes, and shutting down all the
524 : // controllers should have taken care of the PASE handshakes. Clean up any
525 : // outstanding secure sessions (shouldn't really be any, since controllers
526 : // should have handled that, but just in case).
527 0 : if (mSessionMgr != nullptr)
528 : {
529 0 : mSessionMgr->ExpireAllSecureSessions();
530 : }
531 :
532 : // mCASEClientPool and mSessionSetupPool must be deallocated
533 : // after mCASESessionManager, which uses them.
534 :
535 0 : if (mSessionSetupPool != nullptr)
536 : {
537 0 : Platform::Delete(mSessionSetupPool);
538 0 : mSessionSetupPool = nullptr;
539 : }
540 :
541 0 : if (mCASEClientPool != nullptr)
542 : {
543 0 : Platform::Delete(mCASEClientPool);
544 0 : mCASEClientPool = nullptr;
545 : }
546 :
547 0 : Dnssd::Resolver::Instance().Shutdown();
548 :
549 : // Shut down the interaction model
550 0 : app::InteractionModelEngine::GetInstance()->Shutdown();
551 :
552 : // Shut down the TransportMgr. This holds Inet::UDPEndPoints so it must be shut down
553 : // before PlatformMgr().Shutdown() shuts down Inet.
554 0 : if (mTransportMgr != nullptr)
555 : {
556 0 : mTransportMgr->Close();
557 0 : chip::Platform::Delete(mTransportMgr);
558 0 : mTransportMgr = nullptr;
559 : }
560 :
561 0 : if (mExchangeMgr != nullptr)
562 : {
563 0 : mExchangeMgr->Shutdown();
564 : }
565 0 : if (mSessionMgr != nullptr)
566 : {
567 0 : mSessionMgr->Shutdown();
568 : }
569 :
570 0 : mSystemLayer = nullptr;
571 0 : mUDPEndPointManager = nullptr;
572 : #if INET_CONFIG_ENABLE_TCP_ENDPOINT
573 0 : mTCPEndPointManager = nullptr;
574 : #endif
575 : #if CONFIG_NETWORK_LAYER_BLE
576 0 : mBleLayer = nullptr;
577 : #endif // CONFIG_NETWORK_LAYER_BLE
578 :
579 0 : if (mMessageCounterManager != nullptr)
580 : {
581 0 : chip::Platform::Delete(mMessageCounterManager);
582 0 : mMessageCounterManager = nullptr;
583 : }
584 :
585 0 : if (mExchangeMgr != nullptr)
586 : {
587 0 : chip::Platform::Delete(mExchangeMgr);
588 0 : mExchangeMgr = nullptr;
589 : }
590 :
591 0 : if (mUnsolicitedStatusHandler != nullptr)
592 : {
593 0 : Platform::Delete(mUnsolicitedStatusHandler);
594 0 : mUnsolicitedStatusHandler = nullptr;
595 : }
596 :
597 0 : if (mSessionMgr != nullptr)
598 : {
599 0 : chip::Platform::Delete(mSessionMgr);
600 0 : mSessionMgr = nullptr;
601 : }
602 :
603 0 : if (mReportScheduler != nullptr)
604 : {
605 0 : chip::Platform::Delete(mReportScheduler);
606 0 : mReportScheduler = nullptr;
607 : }
608 :
609 0 : if (mTimerDelegate != nullptr)
610 : {
611 0 : chip::Platform::Delete(mTimerDelegate);
612 0 : mTimerDelegate = nullptr;
613 : }
614 :
615 0 : if (mTempFabricTable != nullptr)
616 : {
617 0 : mTempFabricTable->Shutdown();
618 0 : chip::Platform::Delete(mTempFabricTable);
619 0 : mTempFabricTable = nullptr;
620 : // if we created a temp fabric table, then mFabrics points to it.
621 : // if we did not create a temp fabric table, then keep the reference
622 : // so that SetupController/Commissioner can use it
623 0 : mFabrics = nullptr;
624 : }
625 :
626 : #if CONFIG_DEVICE_LAYER
627 : //
628 : // We can safely call PlatformMgr().Shutdown(), which like DeviceController::Shutdown(),
629 : // expects to be called with external thread synchronization and will not try to acquire the
630 : // stack lock.
631 : //
632 : // Actually stopping the event queue is a separable call that applications will have to sequence.
633 : // Consumers are expected to call PlaformMgr().StopEventLoopTask() before calling
634 : // DeviceController::Shutdown() in the CONFIG_DEVICE_LAYER configuration
635 : //
636 0 : DeviceLayer::PlatformMgr().Shutdown();
637 : #endif
638 : }
639 :
640 : } // namespace Controller
641 : } // namespace chip
|
