Skip to content

Commit 0339c31

Browse files
andy31415andy31415
authored
Replace operator const char * from StorageKeyName with an explicit call (project-chip#23480)
* Mass rename: ```shell rg '\(DefaultStorageKeyAllocator::[a-zA-Z]*\([a-zA-Z0-9_,]*\)' | cut -f1 -d: | uniq | xargs sd '(\\(DefaultStorageKeyAllocator::[a-zA-Z]*\\([a-zA-Z0-9_,]*\\))' '${1}.KeyName()' ``` * Added a lot more KeyName * Restyle * A few more changes to make things compile * More fixes * Restyle * One more missed usage of Keyname in tests
1 parent a99675e commit 0339c31

23 files changed

+140
-128
lines changed

‎examples/platform/linux/testing/CustomCSRResponseOperationalKeyStore.cpp

+2-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,8 @@ CHIP_ERROR CustomCSRResponseOperationalKeyStore::ReuseOpKeypair(FabricIndex fabr
7171

7272
// In order to retrieve a keypair that has already been registered, assume the device
7373
// as already been commissioned and fabric index 1 is the registered fabric.
74-
CHIP_ERROR err = mStorage->SyncGetKeyValue(DefaultStorageKeyAllocator::FabricOpKey(1 /* fabricIndex */), buf.Bytes(), size);
74+
CHIP_ERROR err =
75+
mStorage->SyncGetKeyValue(DefaultStorageKeyAllocator::FabricOpKey(1 /* fabricIndex */).KeyName(), buf.Bytes(), size);
7576
if (err == CHIP_ERROR_PERSISTED_STORAGE_VALUE_NOT_FOUND)
7677
{
7778
err = CHIP_ERROR_INVALID_FABRIC_INDEX;

‎examples/providers/DeviceInfoProviderImpl.cpp

+8-6
Original file line numberDiff line numberDiff line change
@@ -120,15 +120,15 @@ bool DeviceInfoProviderImpl::FixedLabelIteratorImpl::Next(FixedLabelType & outpu
120120

121121
CHIP_ERROR DeviceInfoProviderImpl::SetUserLabelLength(EndpointId endpoint, size_t val)
122122
{
123-
return mStorage->SyncSetKeyValue(DefaultStorageKeyAllocator::UserLabelLengthKey(endpoint), &val,
123+
return mStorage->SyncSetKeyValue(DefaultStorageKeyAllocator::UserLabelLengthKey(endpoint).KeyName(), &val,
124124
static_cast<uint16_t>(sizeof(val)));
125125
}
126126

127127
CHIP_ERROR DeviceInfoProviderImpl::GetUserLabelLength(EndpointId endpoint, size_t & val)
128128
{
129129
uint16_t len = static_cast<uint16_t>(sizeof(val));
130130

131-
return mStorage->SyncGetKeyValue(DefaultStorageKeyAllocator::UserLabelLengthKey(endpoint), &val, len);
131+
return mStorage->SyncGetKeyValue(DefaultStorageKeyAllocator::UserLabelLengthKey(endpoint).KeyName(), &val, len);
132132
}
133133

134134
CHIP_ERROR DeviceInfoProviderImpl::SetUserLabelAt(EndpointId endpoint, size_t index, const UserLabelType & userLabel)
@@ -145,13 +145,15 @@ CHIP_ERROR DeviceInfoProviderImpl::SetUserLabelAt(EndpointId endpoint, size_t in
145145
ReturnErrorOnFailure(writer.PutString(kLabelValueTag, userLabel.value));
146146
ReturnErrorOnFailure(writer.EndContainer(outerType));
147147

148-
return mStorage->SyncSetKeyValue(DefaultStorageKeyAllocator::UserLabelIndexKey(endpoint, static_cast<uint32_t>(index)), buf,
149-
static_cast<uint16_t>(writer.GetLengthWritten()));
148+
return mStorage->SyncSetKeyValue(
149+
DefaultStorageKeyAllocator::UserLabelIndexKey(endpoint, static_cast<uint32_t>(index)).KeyName(), buf,
150+
static_cast<uint16_t>(writer.GetLengthWritten()));
150151
}
151152

152153
CHIP_ERROR DeviceInfoProviderImpl::DeleteUserLabelAt(EndpointId endpoint, size_t index)
153154
{
154-
return mStorage->SyncDeleteKeyValue(DefaultStorageKeyAllocator::UserLabelIndexKey(endpoint, static_cast<uint32_t>(index)));
155+
return mStorage->SyncDeleteKeyValue(
156+
DefaultStorageKeyAllocator::UserLabelIndexKey(endpoint, static_cast<uint32_t>(index)).KeyName());
155157
}
156158

157159
DeviceInfoProvider::UserLabelIterator * DeviceInfoProviderImpl::IterateUserLabel(EndpointId endpoint)
@@ -180,7 +182,7 @@ bool DeviceInfoProviderImpl::UserLabelIteratorImpl::Next(UserLabelType & output)
180182
uint16_t len = static_cast<uint16_t>(sizeof(buf));
181183

182184
err = mProvider.mStorage->SyncGetKeyValue(
183-
DefaultStorageKeyAllocator::UserLabelIndexKey(mEndpoint, static_cast<uint32_t>(mIndex)), buf, len);
185+
DefaultStorageKeyAllocator::UserLabelIndexKey(mEndpoint, static_cast<uint32_t>(mIndex)).KeyName(), buf, len);
184186
VerifyOrReturnError(err == CHIP_NO_ERROR, false);
185187

186188
TLV::ContiguousBufferTLVReader reader;

‎src/app/DefaultAttributePersistenceProvider.cpp

+4-3
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ CHIP_ERROR DefaultAttributePersistenceProvider::WriteValue(const ConcreteAttribu
3535
return CHIP_ERROR_BUFFER_TOO_SMALL;
3636
}
3737
return mStorage->SyncSetKeyValue(
38-
DefaultStorageKeyAllocator::AttributeValue(aPath.mEndpointId, aPath.mClusterId, aPath.mAttributeId), aValue.data(),
39-
static_cast<uint16_t>(aValue.size()));
38+
DefaultStorageKeyAllocator::AttributeValue(aPath.mEndpointId, aPath.mClusterId, aPath.mAttributeId).KeyName(),
39+
aValue.data(), static_cast<uint16_t>(aValue.size()));
4040
}
4141

4242
CHIP_ERROR DefaultAttributePersistenceProvider::ReadValue(const ConcreteAttributePath & aPath,
@@ -46,7 +46,8 @@ CHIP_ERROR DefaultAttributePersistenceProvider::ReadValue(const ConcreteAttribut
4646

4747
uint16_t size = static_cast<uint16_t>(min(aValue.size(), static_cast<size_t>(UINT16_MAX)));
4848
ReturnErrorOnFailure(mStorage->SyncGetKeyValue(
49-
DefaultStorageKeyAllocator::AttributeValue(aPath.mEndpointId, aPath.mClusterId, aPath.mAttributeId), aValue.data(), size));
49+
DefaultStorageKeyAllocator::AttributeValue(aPath.mEndpointId, aPath.mClusterId, aPath.mAttributeId).KeyName(),
50+
aValue.data(), size));
5051
EmberAfAttributeType type = aMetadata->attributeType;
5152
if (emberAfIsStringAttributeType(type))
5253
{

‎src/app/clusters/access-control-server/access-control-server.cpp

+9-8
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ CHIP_ERROR AccessControlAttribute::ReadExtension(AttributeValueEncoder & aEncode
200200
uint8_t buffer[kExtensionDataMaxLength] = { 0 };
201201
uint16_t size = static_cast<uint16_t>(sizeof(buffer));
202202
CHIP_ERROR errStorage = storage.SyncGetKeyValue(
203-
DefaultStorageKeyAllocator::AccessControlExtensionEntry(fabric.GetFabricIndex()), buffer, size);
203+
DefaultStorageKeyAllocator::AccessControlExtensionEntry(fabric.GetFabricIndex()).KeyName(), buffer, size);
204204
ReturnErrorCodeIf(errStorage == CHIP_ERROR_BUFFER_TOO_SMALL, CHIP_ERROR_INCORRECT_STATE);
205205
if (errStorage == CHIP_ERROR_PERSISTED_STORAGE_VALUE_NOT_FOUND)
206206
{
@@ -299,8 +299,8 @@ CHIP_ERROR AccessControlAttribute::WriteExtension(const ConcreteDataAttributePat
299299

300300
uint8_t buffer[kExtensionDataMaxLength] = { 0 };
301301
uint16_t size = static_cast<uint16_t>(sizeof(buffer));
302-
CHIP_ERROR errStorage =
303-
storage.SyncGetKeyValue(DefaultStorageKeyAllocator::AccessControlExtensionEntry(accessingFabricIndex), buffer, size);
302+
CHIP_ERROR errStorage = storage.SyncGetKeyValue(
303+
DefaultStorageKeyAllocator::AccessControlExtensionEntry(accessingFabricIndex).KeyName(), buffer, size);
304304
ReturnErrorCodeIf(errStorage == CHIP_ERROR_BUFFER_TOO_SMALL, CHIP_ERROR_INCORRECT_STATE);
305305
ReturnErrorCodeIf(errStorage != CHIP_NO_ERROR && errStorage != CHIP_ERROR_PERSISTED_STORAGE_VALUE_NOT_FOUND, errStorage);
306306

@@ -315,8 +315,8 @@ CHIP_ERROR AccessControlAttribute::WriteExtension(const ConcreteDataAttributePat
315315
if (count == 0)
316316
{
317317
ReturnErrorCodeIf(errStorage == CHIP_ERROR_PERSISTED_STORAGE_VALUE_NOT_FOUND, CHIP_NO_ERROR);
318-
ReturnErrorOnFailure(
319-
storage.SyncDeleteKeyValue(DefaultStorageKeyAllocator::AccessControlExtensionEntry(accessingFabricIndex)));
318+
ReturnErrorOnFailure(storage.SyncDeleteKeyValue(
319+
DefaultStorageKeyAllocator::AccessControlExtensionEntry(accessingFabricIndex).KeyName()));
320320
AccessControlCluster::Structs::ExtensionEntry::Type item = {
321321
.data = ByteSpan(buffer, size),
322322
.fabricIndex = accessingFabricIndex,
@@ -340,7 +340,7 @@ CHIP_ERROR AccessControlAttribute::WriteExtension(const ConcreteDataAttributePat
340340
ReturnErrorOnFailure(CheckExtensionEntryDataFormat(item.data));
341341

342342
ReturnErrorOnFailure(
343-
storage.SyncSetKeyValue(DefaultStorageKeyAllocator::AccessControlExtensionEntry(accessingFabricIndex),
343+
storage.SyncSetKeyValue(DefaultStorageKeyAllocator::AccessControlExtensionEntry(accessingFabricIndex).KeyName(),
344344
item.data.data(), static_cast<uint16_t>(item.data.size())));
345345
ReturnErrorOnFailure(LogExtensionChangedEvent(item, aDecoder.GetSubjectDescriptor(),
346346
errStorage == CHIP_ERROR_PERSISTED_STORAGE_VALUE_NOT_FOUND
@@ -362,8 +362,9 @@ CHIP_ERROR AccessControlAttribute::WriteExtension(const ConcreteDataAttributePat
362362

363363
ReturnErrorOnFailure(CheckExtensionEntryDataFormat(item.data));
364364

365-
ReturnErrorOnFailure(storage.SyncSetKeyValue(DefaultStorageKeyAllocator::AccessControlExtensionEntry(accessingFabricIndex),
366-
item.data.data(), static_cast<uint16_t>(item.data.size())));
365+
ReturnErrorOnFailure(
366+
storage.SyncSetKeyValue(DefaultStorageKeyAllocator::AccessControlExtensionEntry(accessingFabricIndex).KeyName(),
367+
item.data.data(), static_cast<uint16_t>(item.data.size())));
367368
ReturnErrorOnFailure(
368369
LogExtensionChangedEvent(item, aDecoder.GetSubjectDescriptor(), AccessControlCluster::ChangeTypeEnum::kAdded));
369370
}

‎src/app/clusters/ota-requestor/DefaultOTARequestorStorage.cpp

+15-14
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ CHIP_ERROR DefaultOTARequestorStorage::StoreDefaultProviders(const ProviderLocat
5555

5656
ReturnErrorOnFailure(writer.EndContainer(outerType));
5757

58-
return mPersistentStorage->SyncSetKeyValue(DefaultStorageKeyAllocator::OTADefaultProviders(), buffer,
58+
return mPersistentStorage->SyncSetKeyValue(DefaultStorageKeyAllocator::OTADefaultProviders().KeyName(), buffer,
5959
static_cast<uint16_t>(writer.GetLengthWritten()));
6060
}
6161

@@ -64,7 +64,7 @@ CHIP_ERROR DefaultOTARequestorStorage::LoadDefaultProviders(ProviderLocationList
6464
uint8_t buffer[kProviderListMaxSerializedSize];
6565
MutableByteSpan bufferSpan(buffer);
6666

67-
ReturnErrorOnFailure(Load(DefaultStorageKeyAllocator::OTADefaultProviders(), bufferSpan));
67+
ReturnErrorOnFailure(Load(DefaultStorageKeyAllocator::OTADefaultProviders().KeyName(), bufferSpan));
6868

6969
TLV::TLVReader reader;
7070
TLV::TLVType outerType;
@@ -93,21 +93,21 @@ CHIP_ERROR DefaultOTARequestorStorage::StoreCurrentProviderLocation(const Provid
9393
writer.Init(buffer);
9494
ReturnErrorOnFailure(provider.EncodeForRead(writer, TLV::AnonymousTag(), provider.fabricIndex));
9595

96-
return mPersistentStorage->SyncSetKeyValue(DefaultStorageKeyAllocator::OTACurrentProvider(), buffer,
96+
return mPersistentStorage->SyncSetKeyValue(DefaultStorageKeyAllocator::OTACurrentProvider().KeyName(), buffer,
9797
static_cast<uint16_t>(writer.GetLengthWritten()));
9898
}
9999

100100
CHIP_ERROR DefaultOTARequestorStorage::ClearCurrentProviderLocation()
101101
{
102-
return mPersistentStorage->SyncDeleteKeyValue(DefaultStorageKeyAllocator::OTACurrentProvider());
102+
return mPersistentStorage->SyncDeleteKeyValue(DefaultStorageKeyAllocator::OTACurrentProvider().KeyName());
103103
}
104104

105105
CHIP_ERROR DefaultOTARequestorStorage::LoadCurrentProviderLocation(ProviderLocationType & provider)
106106
{
107107
uint8_t buffer[kProviderMaxSerializedSize];
108108
MutableByteSpan bufferSpan(buffer);
109109

110-
ReturnErrorOnFailure(Load(DefaultStorageKeyAllocator::OTACurrentProvider(), bufferSpan));
110+
ReturnErrorOnFailure(Load(DefaultStorageKeyAllocator::OTACurrentProvider().KeyName(), bufferSpan));
111111

112112
TLV::TLVReader reader;
113113

@@ -120,54 +120,55 @@ CHIP_ERROR DefaultOTARequestorStorage::LoadCurrentProviderLocation(ProviderLocat
120120

121121
CHIP_ERROR DefaultOTARequestorStorage::StoreUpdateToken(ByteSpan updateToken)
122122
{
123-
return mPersistentStorage->SyncSetKeyValue(DefaultStorageKeyAllocator::OTAUpdateToken(), updateToken.data(),
123+
return mPersistentStorage->SyncSetKeyValue(DefaultStorageKeyAllocator::OTAUpdateToken().KeyName(), updateToken.data(),
124124
static_cast<uint16_t>(updateToken.size()));
125125
}
126126

127127
CHIP_ERROR DefaultOTARequestorStorage::ClearUpdateToken()
128128
{
129-
return mPersistentStorage->SyncDeleteKeyValue(DefaultStorageKeyAllocator::OTAUpdateToken());
129+
return mPersistentStorage->SyncDeleteKeyValue(DefaultStorageKeyAllocator::OTAUpdateToken().KeyName());
130130
}
131131

132132
CHIP_ERROR DefaultOTARequestorStorage::LoadUpdateToken(MutableByteSpan & updateToken)
133133
{
134-
return Load(DefaultStorageKeyAllocator::OTAUpdateToken(), updateToken);
134+
return Load(DefaultStorageKeyAllocator::OTAUpdateToken().KeyName(), updateToken);
135135
}
136136

137137
CHIP_ERROR DefaultOTARequestorStorage::StoreCurrentUpdateState(OTAUpdateStateEnum currentUpdateState)
138138
{
139-
return mPersistentStorage->SyncSetKeyValue(DefaultStorageKeyAllocator::OTACurrentUpdateState(), &currentUpdateState,
139+
return mPersistentStorage->SyncSetKeyValue(DefaultStorageKeyAllocator::OTACurrentUpdateState().KeyName(), &currentUpdateState,
140140
sizeof(currentUpdateState));
141141
}
142142

143143
CHIP_ERROR DefaultOTARequestorStorage::LoadCurrentUpdateState(OTAUpdateStateEnum & currentUpdateState)
144144
{
145145
uint16_t size = static_cast<uint16_t>(sizeof(currentUpdateState));
146146

147-
return mPersistentStorage->SyncGetKeyValue(DefaultStorageKeyAllocator::OTACurrentUpdateState(), &currentUpdateState, size);
147+
return mPersistentStorage->SyncGetKeyValue(DefaultStorageKeyAllocator::OTACurrentUpdateState().KeyName(), &currentUpdateState,
148+
size);
148149
}
149150

150151
CHIP_ERROR DefaultOTARequestorStorage::ClearCurrentUpdateState()
151152
{
152-
return mPersistentStorage->SyncDeleteKeyValue(DefaultStorageKeyAllocator::OTACurrentUpdateState());
153+
return mPersistentStorage->SyncDeleteKeyValue(DefaultStorageKeyAllocator::OTACurrentUpdateState().KeyName());
153154
}
154155

155156
CHIP_ERROR DefaultOTARequestorStorage::StoreTargetVersion(uint32_t targetVersion)
156157
{
157-
return mPersistentStorage->SyncSetKeyValue(DefaultStorageKeyAllocator::OTATargetVersion(), &targetVersion,
158+
return mPersistentStorage->SyncSetKeyValue(DefaultStorageKeyAllocator::OTATargetVersion().KeyName(), &targetVersion,
158159
sizeof(targetVersion));
159160
}
160161

161162
CHIP_ERROR DefaultOTARequestorStorage::LoadTargetVersion(uint32_t & targetVersion)
162163
{
163164
uint16_t size = static_cast<uint16_t>(sizeof(targetVersion));
164165

165-
return mPersistentStorage->SyncGetKeyValue(DefaultStorageKeyAllocator::OTATargetVersion(), &targetVersion, size);
166+
return mPersistentStorage->SyncGetKeyValue(DefaultStorageKeyAllocator::OTATargetVersion().KeyName(), &targetVersion, size);
166167
}
167168

168169
CHIP_ERROR DefaultOTARequestorStorage::ClearTargetVersion()
169170
{
170-
return mPersistentStorage->SyncDeleteKeyValue(DefaultStorageKeyAllocator::OTATargetVersion());
171+
return mPersistentStorage->SyncDeleteKeyValue(DefaultStorageKeyAllocator::OTATargetVersion().KeyName());
171172
}
172173

173174
CHIP_ERROR DefaultOTARequestorStorage::Load(const char * key, MutableByteSpan & buffer)

‎src/app/server/DefaultAclStorage.cpp

+10-9
Original file line numberDiff line numberDiff line change
@@ -85,19 +85,19 @@ class : public EntryListener
8585
while (true)
8686
{
8787
uint16_t size = static_cast<uint16_t>(sizeof(buffer));
88-
err = mPersistentStorage->SyncGetKeyValue(DefaultStorageKeyAllocator::AccessControlAclEntry(fabric, index + 1),
89-
buffer, size);
88+
err = mPersistentStorage->SyncGetKeyValue(
89+
DefaultStorageKeyAllocator::AccessControlAclEntry(fabric, index + 1).KeyName(), buffer, size);
9090
if (err == CHIP_ERROR_PERSISTED_STORAGE_VALUE_NOT_FOUND)
9191
{
9292
break;
9393
}
9494
SuccessOrExit(err);
9595
SuccessOrExit(err = mPersistentStorage->SyncSetKeyValue(
96-
DefaultStorageKeyAllocator::AccessControlAclEntry(fabric, index), buffer, size));
96+
DefaultStorageKeyAllocator::AccessControlAclEntry(fabric, index).KeyName(), buffer, size));
9797
index++;
9898
}
99-
SuccessOrExit(
100-
err = mPersistentStorage->SyncDeleteKeyValue(DefaultStorageKeyAllocator::AccessControlAclEntry(fabric, index)));
99+
SuccessOrExit(err = mPersistentStorage->SyncDeleteKeyValue(
100+
DefaultStorageKeyAllocator::AccessControlAclEntry(fabric, index).KeyName()));
101101
}
102102
else
103103
{
@@ -107,9 +107,9 @@ class : public EntryListener
107107
writer.Init(buffer);
108108
EncodableEntry encodableEntry(*entry);
109109
SuccessOrExit(err = encodableEntry.EncodeForWrite(writer, TLV::AnonymousTag()));
110-
SuccessOrExit(err =
111-
mPersistentStorage->SyncSetKeyValue(DefaultStorageKeyAllocator::AccessControlAclEntry(fabric, index),
112-
buffer, static_cast<uint16_t>(writer.GetLengthWritten())));
110+
SuccessOrExit(err = mPersistentStorage->SyncSetKeyValue(
111+
DefaultStorageKeyAllocator::AccessControlAclEntry(fabric, index).KeyName(), buffer,
112+
static_cast<uint16_t>(writer.GetLengthWritten())));
113113
}
114114

115115
return;
@@ -147,7 +147,8 @@ CHIP_ERROR DefaultAclStorage::Init(PersistentStorageDelegate & persistentStorage
147147
{
148148
uint8_t buffer[kEncodedEntryTotalBytes] = { 0 };
149149
uint16_t size = static_cast<uint16_t>(sizeof(buffer));
150-
err = persistentStorage.SyncGetKeyValue(DefaultStorageKeyAllocator::AccessControlAclEntry(fabric, index), buffer, size);
150+
err = persistentStorage.SyncGetKeyValue(DefaultStorageKeyAllocator::AccessControlAclEntry(fabric, index).KeyName(),
151+
buffer, size);
151152
if (err == CHIP_ERROR_PERSISTED_STORAGE_VALUE_NOT_FOUND)
152153
{
153154
break;

‎src/app/server/Server.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ class Server
446446

447447
// Remove ACL extension entry for the given fabricIndex.
448448
auto & storage = mServer->GetPersistentStorage();
449-
aclErr = storage.SyncDeleteKeyValue(DefaultStorageKeyAllocator::AccessControlExtensionEntry(fabricIndex));
449+
aclErr = storage.SyncDeleteKeyValue(DefaultStorageKeyAllocator::AccessControlExtensionEntry(fabricIndex).KeyName());
450450

451451
if (aclErr != CHIP_NO_ERROR && aclErr != CHIP_ERROR_PERSISTED_STORAGE_VALUE_NOT_FOUND)
452452
{

0 commit comments

Comments
 (0)