Skip to content

Commit 9890846

Browse files
jtung-applejtung-apple
committed
[Darwin] More logging for MTRDevice persistence
1 parent 6d8613d commit 9890846

File tree

5 files changed

+53
-16
lines changed

5 files changed

+53
-16
lines changed

‎src/darwin/Framework/CHIP/MTRDevice.mm

+2
Original file line numberDiff line numberDiff line change
@@ -904,6 +904,7 @@ - (void)_handleEventReport:(NSArray<NSDictionary<NSString *, id> *> *)eventRepor
904904
}
905905
}
906906
}
907+
MTR_LOG_INFO("%@ _getCachedDataVersions dataVersions count: %lu readCache count: %lu", self, dataVersions.count, _readCache.count);
907908
os_unfair_lock_unlock(&self->_lock);
908909

909910
return dataVersions;
@@ -1948,6 +1949,7 @@ - (NSArray *)_getAttributesToReportWithReportedValues:(NSArray<NSDictionary<NSSt
19481949

19491950
- (void)setAttributeValues:(NSArray<NSDictionary *> *)attributeValues reportChanges:(BOOL)reportChanges
19501951
{
1952+
MTR_LOG_INFO("%@ setAttributeValues count: %lu reportChanges: %d", self, attributeValues.count, reportChanges);
19511953
if (reportChanges) {
19521954
[self _handleAttributeReport:attributeValues];
19531955
} else {

‎src/darwin/Framework/CHIP/MTRDeviceController.mm

+2-1
Original file line numberDiff line numberDiff line change
@@ -887,7 +887,8 @@ - (MTRDevice *)deviceForNodeID:(NSNumber *)nodeID
887887

888888
// Load persisted attributes if they exist.
889889
NSArray * attributesFromCache = [_controllerDataStore getStoredAttributesForNodeID:nodeID];
890-
if (attributesFromCache) {
890+
MTR_LOG_INFO("Loaded %lu attributes from storage for %@", attributesFromCache.count, deviceToReturn);
891+
if (attributesFromCache.count) {
891892
[deviceToReturn setAttributeValues:attributesFromCache reportChanges:NO];
892893
}
893894
}

‎src/darwin/Framework/CHIP/MTRDeviceControllerDataStore.mm

+38-11
Original file line numberDiff line numberDiff line change
@@ -503,6 +503,7 @@ - (void)_pruneEmptyStoredAttributesBranches
503503
NSMutableArray<NSNumber *> * nodeIndex = [self _fetchNodeIndex].mutableCopy;
504504
NSUInteger nodeIndexCount = nodeIndex.count;
505505

506+
NSUInteger storeFailures = 0;
506507
for (NSNumber * nodeID in nodeIndex) {
507508
// Fetch endpoint index
508509
NSMutableArray<NSNumber *> * endpointIndex = [self _fetchEndpointIndexForNodeID:nodeID].mutableCopy;
@@ -529,35 +530,55 @@ - (void)_pruneEmptyStoredAttributesBranches
529530
if (!attributeIndex.count) {
530531
[clusterIndex removeObject:clusterID];
531532
} else if (attributeIndex.count != attributeIndexCount) {
532-
[self _storeAttributeIndex:attributeIndex forNodeID:nodeID endpointID:endpointID clusterID:clusterID];
533+
BOOL success = [self _storeAttributeIndex:attributeIndex forNodeID:nodeID endpointID:endpointID clusterID:clusterID];
534+
if (!success) {
535+
storeFailures++;
536+
MTR_LOG_INFO("Store failed for attributeIndex");
537+
}
533538
}
534539
}
535540

536541
if (!clusterIndex.count) {
537542
[endpointIndex removeObject:endpointID];
538543
} else if (clusterIndex.count != clusterIndexCount) {
539-
[self _storeClusterIndex:clusterIndex forNodeID:nodeID endpointID:endpointID];
544+
BOOL success = [self _storeClusterIndex:clusterIndex forNodeID:nodeID endpointID:endpointID];
545+
if (!success) {
546+
storeFailures++;
547+
MTR_LOG_INFO("Store failed for clusterIndex");
548+
}
540549
}
541550
}
542551

543552
if (!endpointIndex.count) {
544553
[nodeIndex removeObject:nodeID];
545554
} else if (endpointIndex.count != endpointIndexCount) {
546-
[self _storeEndpointIndex:endpointIndex forNodeID:nodeID];
555+
BOOL success = [self _storeEndpointIndex:endpointIndex forNodeID:nodeID];
556+
if (!success) {
557+
storeFailures++;
558+
MTR_LOG_INFO("Store failed for endpointIndex");
559+
}
547560
}
548561
}
549562

550563
if (!nodeIndex.count) {
551564
[self _deleteNodeIndex];
552565
} else if (nodeIndex.count != nodeIndexCount) {
553-
[self _storeNodeIndex:nodeIndex];
566+
BOOL success = [self _storeNodeIndex:nodeIndex];
567+
if (!success) {
568+
storeFailures++;
569+
MTR_LOG_INFO("Store failed for nodeIndex");
570+
}
571+
}
572+
573+
if (storeFailures) {
574+
MTR_LOG_ERROR("Store failed in _pruneEmptyStoredAttributesBranches: %lu", storeFailures);
554575
}
555576
}
556577

557578
- (void)storeAttributeValues:(NSArray<NSDictionary *> *)dataValues forNodeID:(NSNumber *)nodeID
558579
{
559580
dispatch_async(_storageDelegateQueue, ^{
560-
BOOL anyStoreFailed = NO;
581+
NSUInteger storeFailures = 0;
561582

562583
for (NSDictionary * dataValue in dataValues) {
563584
MTRAttributePath * path = dataValue[MTRAttributePathKey];
@@ -573,7 +594,8 @@ - (void)storeAttributeValues:(NSArray<NSDictionary *> *)dataValues forNodeID:(NS
573594
storeFailed = ![self _storeNodeIndex:[nodeIndex arrayByAddingObject:nodeID]];
574595
}
575596
if (storeFailed) {
576-
anyStoreFailed = YES;
597+
storeFailures++;
598+
MTR_LOG_INFO("Store failed for nodeIndex");
577599
continue;
578600
}
579601

@@ -586,7 +608,8 @@ - (void)storeAttributeValues:(NSArray<NSDictionary *> *)dataValues forNodeID:(NS
586608
storeFailed = ![self _storeEndpointIndex:[endpointIndex arrayByAddingObject:path.endpoint] forNodeID:nodeID];
587609
}
588610
if (storeFailed) {
589-
anyStoreFailed = YES;
611+
storeFailures++;
612+
MTR_LOG_INFO("Store failed for endpointIndex");
590613
continue;
591614
}
592615

@@ -599,7 +622,8 @@ - (void)storeAttributeValues:(NSArray<NSDictionary *> *)dataValues forNodeID:(NS
599622
storeFailed = ![self _storeClusterIndex:[clusterIndex arrayByAddingObject:path.cluster] forNodeID:nodeID endpointID:path.endpoint];
600623
}
601624
if (storeFailed) {
602-
anyStoreFailed = YES;
625+
storeFailures++;
626+
MTR_LOG_INFO("Store failed for clusterIndex");
603627
continue;
604628
}
605629

@@ -615,20 +639,23 @@ - (void)storeAttributeValues:(NSArray<NSDictionary *> *)dataValues forNodeID:(NS
615639
storeFailed = ![self _storeAttributeIndex:[attributeIndex arrayByAddingObject:path.attribute] forNodeID:nodeID endpointID:path.endpoint clusterID:path.cluster];
616640
}
617641
if (storeFailed) {
618-
anyStoreFailed = YES;
642+
storeFailures++;
643+
MTR_LOG_INFO("Store failed for attributeIndex");
619644
continue;
620645
}
621646

622647
// Store value
623648
storeFailed = [self _storeAttributeValue:value forNodeID:nodeID endpointID:path.endpoint clusterID:path.cluster attributeID:path.attribute];
624649
if (storeFailed) {
625-
anyStoreFailed = YES;
650+
storeFailures++;
651+
MTR_LOG_INFO("Store failed for attribute value");
626652
}
627653
}
628654

629655
// In the rare event that store fails, allow all attribute store attempts to go through and prune empty branches at the end altogether.
630-
if (anyStoreFailed) {
656+
if (storeFailures) {
631657
[self _pruneEmptyStoredAttributesBranches];
658+
MTR_LOG_ERROR("Store failed in -storeAttributeValues:forNodeID: %lu", storeFailures);
632659
}
633660
});
634661
}

‎src/darwin/Framework/CHIP/MTRDeviceControllerLocalTestStorage.m ‎src/darwin/Framework/CHIP/MTRDeviceControllerLocalTestStorage.mm

+7
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
*/
1717

1818
#import "MTRDeviceControllerLocalTestStorage.h"
19+
#import "MTRLogging_Internal.h"
1920

2021
#if MTR_PER_CONTROLLER_STORAGE_ENABLED
2122

@@ -36,12 +37,18 @@ + (void)setLocalTestStorageEnabled:(BOOL)localTestStorageEnabled
3637
{
3738
NSUserDefaults * defaults = [[NSUserDefaults alloc] initWithSuiteName:kLocalTestUserDefaultDomain];
3839
[defaults setBool:localTestStorageEnabled forKey:kLocalTestUserDefaultEnabledKey];
40+
MTR_LOG_INFO("MTRDeviceControllerLocalTestStorage setLocalTestStorageEnabled %d", localTestStorageEnabled);
41+
BOOL storedLocalTestStorageEnabled = [defaults boolForKey:kLocalTestUserDefaultEnabledKey];
42+
if (storedLocalTestStorageEnabled != localTestStorageEnabled) {
43+
MTR_LOG_ERROR("MTRDeviceControllerLocalTestStorage setLocalTestStorageEnabled %d failed", localTestStorageEnabled);
44+
}
3945
}
4046

4147
- (instancetype)initWithPassThroughStorage:(id<MTRDeviceControllerStorageDelegate>)passThroughStorage
4248
{
4349
if (self = [super init]) {
4450
_passThroughStorage = passThroughStorage;
51+
MTR_LOG_INFO("MTRDeviceControllerLocalTestStorage initialized with pass-through storage %@", passThroughStorage);
4552
}
4653
return self;
4754
}

‎src/darwin/Framework/Matter.xcodeproj/project.pbxproj

+4-4
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@
240240
5ACDDD7D27CD16D200EFD68A /* MTRClusterStateCacheContainer.mm in Sources */ = {isa = PBXBuildFile; fileRef = 5ACDDD7C27CD16D200EFD68A /* MTRClusterStateCacheContainer.mm */; };
241241
5ACDDD7E27CD3F3A00EFD68A /* MTRClusterStateCacheContainer_Internal.h in Headers */ = {isa = PBXBuildFile; fileRef = 5ACDDD7B27CD14AF00EFD68A /* MTRClusterStateCacheContainer_Internal.h */; };
242242
5AE6D4E427A99041001F2493 /* MTRDeviceTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 5AE6D4E327A99041001F2493 /* MTRDeviceTests.m */; };
243-
75139A6F2B7FE5E900E3A919 /* MTRDeviceControllerLocalTestStorage.m in Sources */ = {isa = PBXBuildFile; fileRef = 75139A6E2B7FE5E900E3A919 /* MTRDeviceControllerLocalTestStorage.m */; };
243+
75139A6F2B7FE5E900E3A919 /* MTRDeviceControllerLocalTestStorage.mm in Sources */ = {isa = PBXBuildFile; fileRef = 75139A6E2B7FE5E900E3A919 /* MTRDeviceControllerLocalTestStorage.mm */; };
244244
75139A702B7FE68C00E3A919 /* MTRDeviceControllerLocalTestStorage.h in Headers */ = {isa = PBXBuildFile; fileRef = 75139A6D2B7FE5D600E3A919 /* MTRDeviceControllerLocalTestStorage.h */; settings = {ATTRIBUTES = (Private, ); }; };
245245
7534F12828BFF20300390851 /* MTRDeviceAttestationDelegate.mm in Sources */ = {isa = PBXBuildFile; fileRef = 7534F12628BFF20300390851 /* MTRDeviceAttestationDelegate.mm */; };
246246
7534F12928BFF20300390851 /* MTRDeviceAttestationDelegate_Internal.h in Headers */ = {isa = PBXBuildFile; fileRef = 7534F12728BFF20300390851 /* MTRDeviceAttestationDelegate_Internal.h */; };
@@ -640,7 +640,7 @@
640640
5AE6D4E327A99041001F2493 /* MTRDeviceTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MTRDeviceTests.m; sourceTree = "<group>"; };
641641
75139A6C2B7FE19100E3A919 /* MTRTestDeclarations.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MTRTestDeclarations.h; sourceTree = "<group>"; };
642642
75139A6D2B7FE5D600E3A919 /* MTRDeviceControllerLocalTestStorage.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MTRDeviceControllerLocalTestStorage.h; sourceTree = "<group>"; };
643-
75139A6E2B7FE5E900E3A919 /* MTRDeviceControllerLocalTestStorage.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MTRDeviceControllerLocalTestStorage.m; sourceTree = "<group>"; };
643+
75139A6E2B7FE5E900E3A919 /* MTRDeviceControllerLocalTestStorage.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = MTRDeviceControllerLocalTestStorage.mm; sourceTree = "<group>"; };
644644
7534F12628BFF20300390851 /* MTRDeviceAttestationDelegate.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = MTRDeviceAttestationDelegate.mm; sourceTree = "<group>"; };
645645
7534F12728BFF20300390851 /* MTRDeviceAttestationDelegate_Internal.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MTRDeviceAttestationDelegate_Internal.h; sourceTree = "<group>"; };
646646
754F3DF327FBB94B00E60580 /* MTREventTLVValueDecoder_Internal.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MTREventTLVValueDecoder_Internal.h; sourceTree = "<group>"; };
@@ -1248,7 +1248,7 @@
12481248
5136661128067D540025EDAE /* MTRDeviceControllerFactory_Internal.h */,
12491249
5136661028067D540025EDAE /* MTRDeviceControllerFactory.mm */,
12501250
75139A6D2B7FE5D600E3A919 /* MTRDeviceControllerLocalTestStorage.h */,
1251-
75139A6E2B7FE5E900E3A919 /* MTRDeviceControllerLocalTestStorage.m */,
1251+
75139A6E2B7FE5E900E3A919 /* MTRDeviceControllerLocalTestStorage.mm */,
12521252
5A6FEC8D27B5624E00F25F42 /* MTRDeviceControllerOverXPC.h */,
12531253
5A830D6B27CFCF590053B85D /* MTRDeviceControllerOverXPC_Internal.h */,
12541254
5A6FEC8F27B563D900F25F42 /* MTRDeviceControllerOverXPC.mm */,
@@ -1851,7 +1851,7 @@
18511851
75B765C32A1D82D30014719B /* MTRAttributeSpecifiedCheck.mm in Sources */,
18521852
AF5F90FF2878D351005503FA /* MTROTAProviderDelegateBridge.mm in Sources */,
18531853
516415FF2B6B132200D5CE11 /* DataModelHandler.cpp in Sources */,
1854-
75139A6F2B7FE5E900E3A919 /* MTRDeviceControllerLocalTestStorage.m in Sources */,
1854+
75139A6F2B7FE5E900E3A919 /* MTRDeviceControllerLocalTestStorage.mm in Sources */,
18551855
51E95DFC2A78443C00A434F0 /* MTRSessionResumptionStorageBridge.mm in Sources */,
18561856
514C79ED2B62ADCD00DD6D7B /* ember-compatibility-functions.cpp in Sources */,
18571857
7534F12828BFF20300390851 /* MTRDeviceAttestationDelegate.mm in Sources */,

0 commit comments

Comments
 (0)