Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make DataModel::Provider return a Complete attribute metadata as its public interface #37519

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
+46 −19
Open

Make DataModel::Provider return a Complete attribute metadata as its public interface #37519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
86f9028
Start adding complete metadata, before updating tests
andreilitvin Feb 11, 2025
a3de73e
Restyle
andreilitvin Feb 11, 2025
b97b040
Fix codegen data model provider unit tests
andreilitvin Feb 11, 2025
9a8af9b
Fix includes
andreilitvin Feb 11, 2025
450c980
Restyled by clang-format
restyled-commits Feb 11, 2025
48b83d2
Update src/data-model-providers/codegen/CodegenDataModelProvider.cpp
andy31415 Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions src/app/GlobalAttributes.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,14 +97,6 @@ DataModel::ActionReturnStatus ReadGlobalAttributeFromMetadata(DataModel::Provide
// and this reduces template variants for Encode, saving flash.
ReturnErrorOnFailure(listEncodeHelper.Encode(static_cast<uint64_t>(entry.attributeId)));
}

for (auto id : GlobalAttributesNotInMetadata)
{
// NOTE: cast to u64 because TLV encodes all numbers the same (no TLV sideffects)
// and this reduces template variants for Encode, saving flash.
ReturnErrorOnFailure(listEncodeHelper.Encode(static_cast<uint64_t>(id)));
}

return CHIP_NO_ERROR;
});
}
Expand Down
10 changes: 5 additions & 5 deletions src/app/data-model-provider/ProviderMetadataTree.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,14 @@ class ProviderMetadataTree
virtual CHIP_ERROR ClientClusters(EndpointId endpointId, ListBuilder<ClusterId> & builder) = 0;
virtual CHIP_ERROR ServerClusters(EndpointId endpointId, ListBuilder<ServerClusterEntry> & builder) = 0;

/// Attribute lists contain all attributes EXCEPT the list attributes that
/// are part of metadata. The output from this method MUST NOT contain:
/// - AttributeList::Id
/// Attribute lists contain all attributes. This MUST include all global
/// attributes (See SPEC 7.13 Global Elements / Global Attributes Table).
/// In particular this MUST contain:
/// - AcceptedCommandList::Id
/// - GeneratedCommandList::Id
/// However it MUST ALWAYS contain:
/// - AttributeList::Id
/// - ClusterRevision::Id
/// - FeatureMap::Id
/// - GeneratedCommandList::Id
virtual CHIP_ERROR Attributes(const ConcreteClusterPath & path, ListBuilder<AttributeEntry> & builder) = 0;
virtual CHIP_ERROR GeneratedCommands(const ConcreteClusterPath & path, ListBuilder<CommandId> & builder) = 0;
virtual CHIP_ERROR AcceptedCommands(const ConcreteClusterPath & path, ListBuilder<AcceptedCommandEntry> & builder) = 0;
Expand Down
25 changes: 23 additions & 2 deletions src/data-model-providers/codegen/CodegenDataModelProvider.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,15 @@
#include <data-model-providers/codegen/CodegenDataModelProvider.h>

#include <access/AccessControl.h>
#include <access/Privilege.h>
#include <app-common/zap-generated/attribute-type.h>
#include <app/CommandHandlerInterface.h>
#include <app/CommandHandlerInterfaceRegistry.h>
#include <app/ConcreteAttributePath.h>
#include <app/ConcreteClusterPath.h>
#include <app/ConcreteCommandPath.h>
#include <app/EventPathParams.h>
#include <app/GlobalAttributes.h>
#include <app/RequiredPrivilege.h>
#include <app/data-model-provider/MetadataList.h>
#include <app/data-model-provider/MetadataTypes.h>
Expand Down Expand Up @@ -267,8 +269,15 @@ CHIP_ERROR CodegenDataModelProvider::Attributes(const ConcreteClusterPath & path
VerifyOrReturnValue(cluster->attributeCount > 0, CHIP_NO_ERROR);
VerifyOrReturnValue(cluster->attributes != nullptr, CHIP_NO_ERROR);

// TODO: if ember would encode data in AttributeEntry form, we could reference things directly
ReturnErrorOnFailure(builder.EnsureAppendCapacity(cluster->attributeCount));
// TODO: if ember would encode data in AttributeEntry form, we could reference things directly (shorter code,
// although still allocation overhead due to global attributes not in metadata)
//
// We have Attributes from ember + global attributes that are NOT in ember metadata.
// We have to report them all
constexpr size_t kGlobalAttributeNotInMetadataCount =
ArraySize(GlobalAttributesNotInMetadata);

ReturnErrorOnFailure(builder.EnsureAppendCapacity(cluster->attributeCount + kGlobalAttributeNotInMetadataCount));

Span<const EmberAfAttributeMetadata> attributeSpan(cluster->attributes, cluster->attributeCount);

Expand All @@ -277,6 +286,18 @@ CHIP_ERROR CodegenDataModelProvider::Attributes(const ConcreteClusterPath & path
ReturnErrorOnFailure(builder.Append(AttributeEntryFrom(path, attribute)));
}

DataModel::AttributeEntry globalListEntry;

globalListEntry.readPrivilege = Access::Privilege::kView;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth documenting that this is per-spec, and if this changes (e.g. a new global attribute with different access is added) we need to update this code?

globalListEntry.flags.Set(DataModel::AttributeQualityFlags::kListAttribute);
// these entries should also be `Fixed` however no such flag is propagated (we do not track)

for (auto & attribute : GlobalAttributesNotInMetadata)
{
globalListEntry.attributeId = attribute;
ReturnErrorOnFailure(builder.Append(globalListEntry));
}

return CHIP_NO_ERROR;
}

Expand Down
22 changes: 18 additions & 4 deletions src/data-model-providers/codegen/tests/TestCodegenModelViaMocks.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1073,7 +1073,7 @@ TEST_F(TestCodegenModelViaMocks, IterateOverAttributes)

EXPECT_EQ(model.Attributes(ConcreteClusterPath(kMockEndpoint2, MockClusterId(2)), builder), CHIP_NO_ERROR);
auto attributes = builder.TakeBuffer();
ASSERT_EQ(attributes.size(), 4u);
ASSERT_EQ(attributes.size(), 7u);

ASSERT_EQ(attributes[0].attributeId, ClusterRevision::Id);
ASSERT_FALSE(attributes[0].flags.Has(AttributeQualityFlags::kListAttribute));
Expand All @@ -1086,6 +1086,16 @@ TEST_F(TestCodegenModelViaMocks, IterateOverAttributes)

ASSERT_EQ(attributes[3].attributeId, MockAttributeId(2));
ASSERT_TRUE(attributes[3].flags.Has(AttributeQualityFlags::kListAttribute));

// Ends with global list attributes
ASSERT_EQ(attributes[4].attributeId, GeneratedCommandList::Id);
ASSERT_TRUE(attributes[4].flags.Has(AttributeQualityFlags::kListAttribute));

ASSERT_EQ(attributes[5].attributeId, AcceptedCommandList::Id);
ASSERT_TRUE(attributes[5].flags.Has(AttributeQualityFlags::kListAttribute));

ASSERT_EQ(attributes[6].attributeId, AttributeList::Id);
ASSERT_TRUE(attributes[6].flags.Has(AttributeQualityFlags::kListAttribute));
}

TEST_F(TestCodegenModelViaMocks, FindAttribute)
Expand Down Expand Up @@ -1127,7 +1137,7 @@ TEST_F(TestCodegenModelViaMocks, FindAttribute)
EXPECT_FALSE(info->writePrivilege.has_value()); // NOLINT(bugprone-unchecked-optional-access)
}

// global attributes are EXPLICITLY not supported
// global attributes are EXPLICITLY supported
TEST_F(TestCodegenModelViaMocks, GlobalAttributeInfo)
{
UseMockNodeConfig config(gTestNodeConfig);
Expand All @@ -1138,10 +1148,14 @@ TEST_F(TestCodegenModelViaMocks, GlobalAttributeInfo)
std::optional<AttributeEntry> info = finder.Find(
ConcreteAttributePath(kMockEndpoint1, MockClusterId(1), Clusters::Globals::Attributes::GeneratedCommandList::Id));

ASSERT_FALSE(info.has_value());
ASSERT_TRUE(info.has_value());

info = finder.Find(ConcreteAttributePath(kMockEndpoint1, MockClusterId(1), Clusters::Globals::Attributes::AttributeList::Id));
ASSERT_FALSE(info.has_value());
ASSERT_TRUE(info.has_value());

info = finder.Find(
ConcreteAttributePath(kMockEndpoint1, MockClusterId(1), Clusters::Globals::Attributes::AcceptedCommandList::Id));
ASSERT_TRUE(info.has_value());
}

TEST_F(TestCodegenModelViaMocks, IterateOverAcceptedCommands)
Expand Down
Loading