espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-09-14 13:10:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

[tlv] improve encapsulation and docs for Tlv::Info (#12301)

Browse Source 
This change renames `Tlv::ParsedInfo` to `Tlv::Info` to make it more
concise and to better reflect its purpose as a metadata holder for a
TLV in a message.

The member variables of `Tlv::Info` are made private and public
accessor methods are introduced to interact with the object's
contenet. This helps ensure that the internal representation of the
parsed TLV information is not modified directly by external modules.
All existing caller are updated to use the new name and the public
helper getter methods.

The Doxygen comments of `Tlv::Info` are also improved for better
clarity. Unit test `test_tlv` is also updated to validate all the
new methods.
This commit is contained in:
Abtin Keshavarzian
2026-01-16 16:53:32 -08:00
committed by GitHub
parent b3d3b5c3c7
commit 5f7aa17460
7 changed files with 352 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/unit/test_tlv.cpp
+174
View File
@@ -288,11 +288,185 @@ void TestTlv(void)
testFreeInstance(instance);
}
void TestTlvInfo(void)
{
Instance *instance;
Message *message;
uint16_t offset;
uint16_t len;
Tlv tlv;
ExtendedTlv extTlv;
Tlv::Info info;
instance = testInitInstance();
VerifyOrQuit(instance != nullptr);
message = instance->Get<MessagePool>().Allocate(Message::kTypeOther);
VerifyOrQuit(message != nullptr);
// Append TLV 1: Standard TLV with 1-byte value.
tlv.SetType(1);
tlv.SetLength(1);
SuccessOrQuit(message->Append(tlv));
SuccessOrQuit(message->Append<uint8_t>(0xaa));
// Append TLV 2: Extended TLV with 2-byte value.
extTlv.SetType(2);
extTlv.SetLength(2);
SuccessOrQuit(message->Append(extTlv));
SuccessOrQuit(message->Append<uint16_t>(0xcafe));
// Append TLV 3: Standard empty TLV.
tlv.SetType(3);
tlv.SetLength(0);
SuccessOrQuit(message->Append(tlv));
// Append TLV 4: Extended empty TLV.
extTlv.SetType(4);
extTlv.SetLength(0);
SuccessOrQuit(message->Append(extTlv));
// Append TLV 5: Malformed standard TLV (claims length 2, but has only 1).
tlv.SetType(5);
tlv.SetLength(2);
SuccessOrQuit(message->Append(tlv));
SuccessOrQuit(message->Append<uint8_t>(0x12));
for (uint8_t testIter = 0; testIter <= 1; testIter++)
{
offset = 0;
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// TLV 1 (standard, len=1)
len = 1;
if (testIter == 0)
{
SuccessOrQuit(info.ParseFrom(*message, offset));
}
else
{
SuccessOrQuit(info.FindIn(*message, 1));
}
VerifyOrQuit(info.GetType() == 1);
VerifyOrQuit(info.GetLength() == len);
VerifyOrQuit(!info.IsExtended());
VerifyOrQuit(info.GetSize() == sizeof(Tlv) + len);
VerifyOrQuit(info.GetTlvOffset() == offset);
VerifyOrQuit(info.GetValueOffset() == offset + sizeof(Tlv));
VerifyOrQuit(info.GetTlvOffsetRange().GetOffset() == offset);
VerifyOrQuit(info.GetTlvOffsetRange().GetLength() == sizeof(Tlv) + len);
VerifyOrQuit(info.GetValueOffsetRange().GetOffset() == offset + sizeof(Tlv));
VerifyOrQuit(info.GetValueOffsetRange().GetLength() == len);
offset = info.GetTlvOffsetRange().GetEndOffset();
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// TLV 2 (extended, len=2)
len = 2;
if (testIter == 0)
{
SuccessOrQuit(info.ParseFrom(*message, offset));
}
else
{
SuccessOrQuit(info.FindIn(*message, 2));
}
VerifyOrQuit(info.GetType() == 2);
VerifyOrQuit(info.GetLength() == len);
VerifyOrQuit(info.IsExtended());
VerifyOrQuit(info.GetSize() == sizeof(ExtendedTlv) + len);
VerifyOrQuit(info.GetTlvOffset() == offset);
VerifyOrQuit(info.GetValueOffset() == offset + sizeof(ExtendedTlv));
VerifyOrQuit(info.GetTlvOffsetRange().GetOffset() == offset);
VerifyOrQuit(info.GetTlvOffsetRange().GetLength() == sizeof(ExtendedTlv) + len);
VerifyOrQuit(info.GetValueOffsetRange().GetOffset() == offset + sizeof(ExtendedTlv));
VerifyOrQuit(info.GetValueOffsetRange().GetLength() == len);
offset = info.GetTlvOffsetRange().GetEndOffset();
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// TLV 3 (standard, empty)
len = 0;
if (testIter == 0)
{
SuccessOrQuit(info.ParseFrom(*message, offset));
}
else
{
SuccessOrQuit(info.FindIn(*message, 3));
}
VerifyOrQuit(info.GetType() == 3);
VerifyOrQuit(info.GetLength() == len);
VerifyOrQuit(!info.IsExtended());
VerifyOrQuit(info.GetSize() == sizeof(Tlv) + len);
VerifyOrQuit(info.GetTlvOffset() == offset);
VerifyOrQuit(info.GetValueOffset() == offset + sizeof(Tlv));
VerifyOrQuit(info.GetTlvOffsetRange().GetOffset() == offset);
VerifyOrQuit(info.GetTlvOffsetRange().GetLength() == sizeof(Tlv) + len);
VerifyOrQuit(info.GetValueOffsetRange().GetOffset() == offset + sizeof(Tlv));
VerifyOrQuit(info.GetValueOffsetRange().GetLength() == len);
offset = info.GetTlvOffsetRange().GetEndOffset();
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// TLV 4 (extended, empty)
len = 0;
if (testIter == 0)
{
SuccessOrQuit(info.ParseFrom(*message, offset));
}
else
{
SuccessOrQuit(info.FindIn(*message, 4));
}
VerifyOrQuit(info.GetType() == 4);
VerifyOrQuit(info.GetLength() == len);
VerifyOrQuit(info.IsExtended());
VerifyOrQuit(info.GetSize() == sizeof(ExtendedTlv) + len);
VerifyOrQuit(info.GetTlvOffset() == offset);
VerifyOrQuit(info.GetValueOffset() == offset + sizeof(ExtendedTlv));
VerifyOrQuit(info.GetTlvOffsetRange().GetOffset() == offset);
VerifyOrQuit(info.GetTlvOffsetRange().GetLength() == sizeof(ExtendedTlv) + len);
VerifyOrQuit(info.GetValueOffsetRange().GetOffset() == offset + sizeof(ExtendedTlv));
VerifyOrQuit(info.GetValueOffsetRange().GetLength() == len);
offset = info.GetTlvOffsetRange().GetEndOffset();
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// Test TLV 5 (malformed)
if (testIter == 0)
{
VerifyOrQuit(info.ParseFrom(*message, offset) == kErrorParse);
}
else
{
VerifyOrQuit(info.FindIn(*message, 5) != kErrorNone);
}
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
message->Free();
testFreeInstance(instance);
}
} // namespace ot
int main(void)
{
ot::TestTlv();
ot::TestTlvInfo();
printf("All tests passed\n");
return 0;
}