mirror of
https://github.com/espressif/openthread.git
synced 2026-06-05 21:14:49 +00:00
Abtin Keshavarzian
8274fb4ec1
This commit introduces a set of public APIs to allow manipulation of `otSteeringData`. The new APIs are provided when the configuration `OPENTHREAD_CONFIG_MESHCOP_STEERING_DATA_API_ENABLE` is enabled. The internal `SteeringData` is also improved to enhance robustness. Methods such as `Init()`, `UpdateBloomFilter()` now return an `Error` to signal failures on invalid arguments (e.g., invalid length) instead of asserting.
317 lines
11 KiB
C++
317 lines
11 KiB
C++
/*
|
|
* Copyright (c) 2020-21, The OpenThread Authors.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. Neither the name of the copyright holder nor the
|
|
* names of its contributors may be used to endorse or promote products
|
|
* derived from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#include "test_platform.h"
|
|
|
|
#include <openthread/config.h>
|
|
|
|
#include "test_util.hpp"
|
|
#include "common/clearable.hpp"
|
|
#include "meshcop/meshcop.hpp"
|
|
#include "meshcop/timestamp.hpp"
|
|
|
|
namespace ot {
|
|
|
|
void TestSteeringData(void)
|
|
{
|
|
MeshCoP::SteeringData steeringData;
|
|
MeshCoP::SteeringData::HashBitIndexes indexes;
|
|
Mac::ExtAddress joinerId1;
|
|
Mac::ExtAddress joinerId2;
|
|
|
|
const uint8_t kAddress1[sizeof(Mac::ExtAddress)] = {0x10, 0x20, 0x03, 0x15, 0x10, 0x00, 0x60, 0x16};
|
|
const uint8_t kAddress2[sizeof(Mac::ExtAddress)] = {0xbe, 0xef, 0xca, 0xfe, 0xde, 0xad, 0xba, 0xbe};
|
|
|
|
joinerId1.Set(kAddress1);
|
|
joinerId2.Set(kAddress2);
|
|
|
|
MeshCoP::SteeringData::CalculateHashBitIndexes(joinerId2, indexes);
|
|
|
|
steeringData.SetToPermitAllJoiners();
|
|
|
|
DumpBuffer("After SetToPermitAllJoiners()", steeringData.GetData(), steeringData.GetLength());
|
|
VerifyOrQuit(steeringData.GetLength() == 1);
|
|
VerifyOrQuit(steeringData.PermitsAllJoiners());
|
|
VerifyOrQuit(!steeringData.IsEmpty());
|
|
VerifyOrQuit(steeringData.Contains(joinerId1));
|
|
VerifyOrQuit(steeringData.Contains(joinerId2));
|
|
VerifyOrQuit(steeringData.Contains(indexes));
|
|
|
|
steeringData.Clear();
|
|
|
|
DumpBuffer("After Clear()", steeringData.GetData(), steeringData.GetLength());
|
|
VerifyOrQuit(steeringData.GetLength() == 1);
|
|
VerifyOrQuit(!steeringData.PermitsAllJoiners());
|
|
VerifyOrQuit(steeringData.IsEmpty());
|
|
VerifyOrQuit(!steeringData.Contains(joinerId1));
|
|
VerifyOrQuit(!steeringData.Contains(joinerId2));
|
|
VerifyOrQuit(!steeringData.Contains(indexes));
|
|
|
|
for (uint8_t len = MeshCoP::SteeringData::kMinLength; len <= MeshCoP::SteeringData::kMaxLength; len++)
|
|
{
|
|
printf("\n--------------------------------------------");
|
|
|
|
SuccessOrQuit(steeringData.Init(len));
|
|
|
|
VerifyOrQuit(steeringData.GetLength() == len);
|
|
VerifyOrQuit(steeringData.IsEmpty());
|
|
VerifyOrQuit(!steeringData.PermitsAllJoiners());
|
|
VerifyOrQuit(!steeringData.Contains(joinerId1));
|
|
VerifyOrQuit(!steeringData.Contains(joinerId2));
|
|
VerifyOrQuit(!steeringData.Contains(indexes));
|
|
|
|
SuccessOrQuit(steeringData.UpdateBloomFilter(joinerId1));
|
|
printf("\nAfter UpdateBloomFilter(joinerId1): %s", steeringData.ToString().AsCString());
|
|
VerifyOrQuit(steeringData.GetLength() == len);
|
|
VerifyOrQuit(!steeringData.IsEmpty());
|
|
VerifyOrQuit(!steeringData.PermitsAllJoiners());
|
|
VerifyOrQuit(steeringData.Contains(joinerId1));
|
|
|
|
SuccessOrQuit(steeringData.UpdateBloomFilter(joinerId2));
|
|
printf("\nAfter UpdateBloomFilter(joinerId2): %s", steeringData.ToString().AsCString());
|
|
VerifyOrQuit(steeringData.GetLength() == len);
|
|
VerifyOrQuit(!steeringData.IsEmpty());
|
|
VerifyOrQuit(!steeringData.PermitsAllJoiners());
|
|
VerifyOrQuit(steeringData.Contains(joinerId1));
|
|
VerifyOrQuit(steeringData.Contains(joinerId2));
|
|
VerifyOrQuit(steeringData.Contains(indexes));
|
|
}
|
|
|
|
VerifyOrQuit(steeringData.Init(0) == kErrorInvalidArgs);
|
|
VerifyOrQuit(steeringData.Init(MeshCoP::SteeringData::kMaxLength + 1) == kErrorInvalidArgs);
|
|
|
|
ClearAllBytes(steeringData);
|
|
VerifyOrQuit(steeringData.GetLength() == 0);
|
|
VerifyOrQuit(steeringData.UpdateBloomFilter(joinerId1) == kErrorInvalidArgs);
|
|
|
|
printf("TestSteeringData() passed\n");
|
|
}
|
|
|
|
void TestSteeringDataBloomFilterMerge(void)
|
|
{
|
|
static constexpr uint8_t kMaxJoinerIds = 3;
|
|
|
|
static const uint8_t kTestSteeringDataLengths[] = {16, 8, 4, 2, 1};
|
|
|
|
Instance *instance;
|
|
MeshCoP::SteeringData steeringData;
|
|
MeshCoP::SteeringData otherSteeringData;
|
|
|
|
Mac::ExtAddress joinerIds[kMaxJoinerIds];
|
|
Mac::ExtAddress otherJoinerIds[kMaxJoinerIds];
|
|
|
|
instance = static_cast<Instance *>(testInitInstance());
|
|
VerifyOrQuit(instance != nullptr);
|
|
|
|
printf("\n--------------------------------------------");
|
|
printf("\nTestSteeringDataBloomFilterMerge()");
|
|
printf("\nJoiner IDs for SteeringData");
|
|
|
|
for (Mac::ExtAddress &id : joinerIds)
|
|
{
|
|
uint8_t buffer[sizeof(Mac::ExtAddress)];
|
|
|
|
Random::NonCrypto::FillBuffer(buffer, sizeof(buffer));
|
|
id.Set(buffer);
|
|
printf("\n %s", id.ToString().AsCString());
|
|
}
|
|
|
|
printf("\n--------------------------------------------");
|
|
printf("\nJoiner IDs for OtherSteeringData");
|
|
|
|
for (Mac::ExtAddress &id : otherJoinerIds)
|
|
{
|
|
uint8_t buffer[sizeof(Mac::ExtAddress)];
|
|
|
|
Random::NonCrypto::FillBuffer(buffer, sizeof(buffer));
|
|
id.Set(buffer);
|
|
printf("\n %s", id.ToString().AsCString());
|
|
}
|
|
|
|
for (uint8_t length : kTestSteeringDataLengths)
|
|
{
|
|
for (uint8_t otherLength : kTestSteeringDataLengths)
|
|
{
|
|
printf("\n--------------------------------------------");
|
|
printf("\nLen:%u OtherLen:%u", length, otherLength);
|
|
|
|
SuccessOrQuit(steeringData.Init(length));
|
|
SuccessOrQuit(otherSteeringData.Init(otherLength));
|
|
|
|
VerifyOrQuit(steeringData.GetLength() == length);
|
|
VerifyOrQuit(otherSteeringData.GetLength() == otherLength);
|
|
VerifyOrQuit(steeringData.IsEmpty());
|
|
VerifyOrQuit(otherSteeringData.IsEmpty());
|
|
|
|
if (otherLength > length)
|
|
{
|
|
VerifyOrQuit(steeringData.MergeBloomFilterWith(otherSteeringData) != kErrorNone);
|
|
continue;
|
|
}
|
|
|
|
SuccessOrQuit(steeringData.MergeBloomFilterWith(otherSteeringData));
|
|
|
|
VerifyOrQuit(steeringData.GetLength() == length);
|
|
VerifyOrQuit(otherSteeringData.GetLength() == otherLength);
|
|
VerifyOrQuit(steeringData.IsEmpty());
|
|
VerifyOrQuit(otherSteeringData.IsEmpty());
|
|
|
|
for (Mac::ExtAddress &id : joinerIds)
|
|
{
|
|
SuccessOrQuit(steeringData.UpdateBloomFilter(id));
|
|
VerifyOrQuit(steeringData.Contains(id));
|
|
}
|
|
|
|
for (Mac::ExtAddress &id : otherJoinerIds)
|
|
{
|
|
SuccessOrQuit(otherSteeringData.UpdateBloomFilter(id));
|
|
VerifyOrQuit(otherSteeringData.Contains(id));
|
|
}
|
|
|
|
printf("\nSteering Data : %s", steeringData.ToString().AsCString());
|
|
printf("\nOther Steering Data : %s", otherSteeringData.ToString().AsCString());
|
|
|
|
SuccessOrQuit(steeringData.MergeBloomFilterWith(otherSteeringData));
|
|
|
|
printf("\nMerged Steering Data: %s", steeringData.ToString().AsCString());
|
|
|
|
VerifyOrQuit(steeringData.GetLength() == length);
|
|
|
|
for (const Mac::ExtAddress &id : joinerIds)
|
|
{
|
|
VerifyOrQuit(steeringData.Contains(id));
|
|
}
|
|
|
|
for (const Mac::ExtAddress &id : otherJoinerIds)
|
|
{
|
|
VerifyOrQuit(steeringData.Contains(id));
|
|
}
|
|
}
|
|
}
|
|
|
|
printf("\nTestSteeringDataBloomFilterMerge() passed\n");
|
|
}
|
|
|
|
void TestTimestamp(void)
|
|
{
|
|
MeshCoP::Timestamp t1;
|
|
MeshCoP::Timestamp t2;
|
|
MeshCoP::Timestamp::Info info;
|
|
|
|
t1.Clear();
|
|
VerifyOrQuit(t1.GetSeconds() == 0);
|
|
VerifyOrQuit(t1.GetTicks() == 0);
|
|
VerifyOrQuit(!t1.GetAuthoritative());
|
|
VerifyOrQuit(t1.IsValid());
|
|
VerifyOrQuit(MeshCoP::Timestamp::Compare(t1, t1) == 0);
|
|
|
|
t1.ConvertTo(info);
|
|
VerifyOrQuit(info.mSeconds == 0);
|
|
VerifyOrQuit(info.mTicks == 0);
|
|
VerifyOrQuit(!info.mAuthoritative);
|
|
|
|
t2.SetToInvalid();
|
|
VerifyOrQuit(!t2.IsValid());
|
|
VerifyOrQuit(MeshCoP::Timestamp::Compare(t2, t2) == 0);
|
|
|
|
t2.ConvertTo(info);
|
|
VerifyOrQuit(info.mSeconds == 0xffffffffffff);
|
|
VerifyOrQuit(info.mTicks == 0x7fff);
|
|
VerifyOrQuit(info.mAuthoritative);
|
|
|
|
VerifyOrQuit(MeshCoP::Timestamp::Compare(t1, t2) > 0);
|
|
VerifyOrQuit(MeshCoP::Timestamp::Compare(t2, t1) < 0);
|
|
|
|
t2 = t1;
|
|
VerifyOrQuit(MeshCoP::Timestamp::Compare(t1, t2) == 0);
|
|
VerifyOrQuit(t2.IsValid());
|
|
VerifyOrQuit(t1.IsValid());
|
|
|
|
t1.SetSeconds(0x12345678abcd);
|
|
VerifyOrQuit(t1.GetSeconds() == 0x12345678abcd);
|
|
VerifyOrQuit(t1.IsValid());
|
|
VerifyOrQuit(MeshCoP::Timestamp::Compare(t1, t2) > 0);
|
|
VerifyOrQuit(MeshCoP::Timestamp::Compare(t2, t1) < 0);
|
|
|
|
t2.SetSeconds(0x12345678abcd);
|
|
VerifyOrQuit(t1.GetSeconds() == 0x12345678abcd);
|
|
VerifyOrQuit(t2.IsValid());
|
|
VerifyOrQuit(MeshCoP::Timestamp::Compare(t1, t2) == 0);
|
|
|
|
t1.SetAuthoritative(true);
|
|
VerifyOrQuit(t1.GetAuthoritative());
|
|
VerifyOrQuit(t1.IsValid());
|
|
VerifyOrQuit(MeshCoP::Timestamp::Compare(t1, t2) > 0);
|
|
|
|
t1.SetAuthoritative(false);
|
|
VerifyOrQuit(!t1.GetAuthoritative());
|
|
VerifyOrQuit(t1.IsValid());
|
|
VerifyOrQuit(MeshCoP::Timestamp::Compare(t1, t2) == 0);
|
|
|
|
t1.SetTicks(0x7fff);
|
|
VerifyOrQuit(t1.GetTicks() == 0x7fff);
|
|
VerifyOrQuit(!t1.GetAuthoritative());
|
|
VerifyOrQuit(t1.IsValid());
|
|
VerifyOrQuit(MeshCoP::Timestamp::Compare(t1, t2) > 0);
|
|
VerifyOrQuit(MeshCoP::Timestamp::Compare(t2, t1) < 0);
|
|
|
|
t2.SetTicks(0x7fff);
|
|
VerifyOrQuit(t2.GetTicks() == 0x7fff);
|
|
VerifyOrQuit(!t2.GetAuthoritative());
|
|
VerifyOrQuit(t2.IsValid());
|
|
VerifyOrQuit(MeshCoP::Timestamp::Compare(t1, t2) == 0);
|
|
|
|
t2.ConvertTo(info);
|
|
VerifyOrQuit(info.mSeconds == 0x12345678abcd);
|
|
VerifyOrQuit(info.mTicks == 0x7fff);
|
|
VerifyOrQuit(!info.mAuthoritative);
|
|
|
|
t1.SetToOrphanAnnounce();
|
|
VerifyOrQuit(t1.IsValid());
|
|
VerifyOrQuit(t1.IsOrphanAnnounce());
|
|
|
|
t1.ConvertTo(info);
|
|
VerifyOrQuit(info.mSeconds == 0);
|
|
VerifyOrQuit(info.mTicks == 0);
|
|
VerifyOrQuit(info.mAuthoritative);
|
|
|
|
printf("TestTimestamp() passed\n");
|
|
}
|
|
|
|
} // namespace ot
|
|
|
|
int main(void)
|
|
{
|
|
ot::TestSteeringData();
|
|
ot::TestSteeringDataBloomFilterMerge();
|
|
ot::TestTimestamp();
|
|
|
|
printf("\nAll tests passed.\n");
|
|
return 0;
|
|
}
|