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

[api] remove the XpanId and PanId structs #264

Merged
merged 2 commits into from
May 8, 2024
Merged

[api] remove the XpanId and PanId structs #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dbfa960
[API] remove the PanId struct
wgtdkp Apr 29, 2024
5cb6cc8
Merge branch 'main' into remove-panid-struct
wgtdkp May 7, 2024
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
11 changes: 9 additions & 2 deletions include/commissioner/error.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,14 +264,21 @@ inline bool operator!=(const ErrorCode &aErrorCode, const Error &aError)
return !(aErrorCode == aError);
}

std::string ErrorCodeToString(ErrorCode code);

/**
* Allows pretty-print in unit tests.
*
* See https://google.github.io/googletest/advanced.html#teaching-googletest-how-to-print-your-values
*/
inline void PrintTo(const Error &error, std::ostream *os)
inline void PrintTo(const Error &aError, std::ostream *os)
{
*os << aError.ToString();
}

inline void PrintTo(ErrorCode aErrorCode, std::ostream *os)
{
*os << error.ToString();
*os << ErrorCodeToString(aErrorCode);
}

} // namespace commissioner
Expand Down
56 changes: 3 additions & 53 deletions include/commissioner/network_data.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,36 +52,6 @@ static constexpr uint8_t kMlrStatusNoResources = 4;
static constexpr uint8_t kMlrStatusNotPrimary = 5;
static constexpr uint8_t kMlrStatusFailure = 6;

/**
* Extended PAN Id wrapper
*/
struct XpanId
{
static constexpr uint64_t kEmptyXpanId = 0;

uint64_t mValue;

XpanId(uint64_t val);

XpanId();

std::string str() const;

bool operator==(const XpanId &aOther) const;

bool operator!=(const XpanId &aOther) const;
bool operator<(const XpanId &aOther) const;

explicit operator std::string() const;

/**
* Decodes hexadecimal string.
*/
Error FromHex(const std::string &aInput);
};

typedef std::vector<XpanId> XpanIdArray;

/**
* @brief The Commissioner Dataset of the Thread Network Data.
*
Expand Down Expand Up @@ -249,26 +219,6 @@ enum SecurityPolicyFlags
kSecurityPolicyMask_VR = 1 << 5 | 1 << 6 | 1 << 7, /// Protocol version
};

/**
* A PAN identifier.
*/
struct PanId
{
static constexpr uint64_t kEmptyPanId = 0;

uint16_t mValue;
explicit PanId(uint16_t aValue);
PanId(const PanId &aOther) = default;
PanId();

PanId &operator=(const PanId &aValue) = default;
PanId &operator=(uint16_t aValue);
explicit operator uint16_t() const;
explicit operator std::string() const;

Error FromHex(const std::string &aInput);
};

/**
* @brief The Active Operational Dataset of the Thread Network Data.
*
Expand All @@ -283,13 +233,13 @@ struct PanId
struct ActiveOperationalDataset
{
Timestamp mActiveTimestamp;
ByteArray mExtendedPanId;
uint16_t mPanId;
std::string mNetworkName;
Channel mChannel;
ChannelMask mChannelMask;
XpanId mExtendedPanId;
ByteArray mMeshLocalPrefix;
ByteArray mNetworkMasterKey;
std::string mNetworkName;
PanId mPanId;
ByteArray mPSKc;
SecurityPolicy mSecurityPolicy;

Expand Down
87 changes: 36 additions & 51 deletions src/app/cli/interpreter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ namespace ot {
namespace commissioner {

using ot::commissioner::persistent_storage::Network;
using ot::commissioner::utils::Hex;
using ot::commissioner::utils::ParseInteger;

namespace {
/**
Expand Down Expand Up @@ -177,10 +179,9 @@ Interpreter::NetworkSelectionComparator::~NetworkSelectionComparator()
Network nwk;
RegistryStatus status = mInterpreter.mRegistry->GetCurrentNetwork(nwk);

if (status == RegistryStatus::kSuccess && mStartWith.mValue != nwk.mXpan.mValue)
if (status == RegistryStatus::kSuccess && mStartWith != nwk.mXpan)
{
Console::Write(nwk.mXpan.mValue == XpanId::kEmptyXpanId ? WARN_NETWORK_SELECTION_DROPPED
: WARN_NETWORK_SELECTION_CHANGED,
Console::Write(nwk.mXpan == 0 ? WARN_NETWORK_SELECTION_DROPPED : WARN_NETWORK_SELECTION_CHANGED,
Console::Color::kYellow);
}
}
Expand Down Expand Up @@ -351,23 +352,6 @@ template <typename T> static std::string ToHex(T aInteger)
return "0x" + utils::Hex(utils::Encode(aInteger));
};

template <typename T> static Error ParseInteger(T &aInteger, const std::string &aStr)
{
Error error;
uint64_t integer;
char *endPtr = nullptr;

integer = strtoull(aStr.c_str(), &endPtr, 0);

VerifyOrExit(endPtr != nullptr && endPtr > aStr.c_str(),
error = ERROR_INVALID_ARGS("{} is not a valid integer", aStr));

aInteger = integer;

exit:
return error;
}

static inline std::string ToLower(const std::string &aStr)
{
return utils::ToLower(aStr);
Expand Down Expand Up @@ -404,11 +388,11 @@ Error Interpreter::UpdateNetworkSelectionInfo(bool onStart /*=false*/)

VerifyOrExit(mRegistry->GetCurrentNetwork(nwk) == Registry::Status::kSuccess,
error = ERROR_REGISTRY_ERROR(RUNTIME_CUR_NETWORK_FAILED));
if (onStart && nwk.mXpan.mValue != XpanId::kEmptyXpanId)
if (onStart && nwk.mXpan != 0)
{
Console::Write(fmt::format(FMT_STRING("Network selection recalled from previous session.\n"
"Restored to [{}:'{}']"),
nwk.mXpan.str(), nwk.mName),
utils::Hex(nwk.mXpan), nwk.mName),
Console::Color::kGreen);
}
exit:
Expand Down Expand Up @@ -549,7 +533,7 @@ Interpreter::Value Interpreter::Eval(const Expression &aExpr)

if (mContext.mNwkAliases.size() > 0 || mContext.mDomAliases.size() > 0)
{
XpanIdArray nids;
std::vector<uint64_t> nids;

SuccessOrExit(value = ValidateMultiNetworkSyntax(retExpr, nids));
if (IsMultiJob(retExpr)) // asynchronous processing required
Expand All @@ -574,19 +558,19 @@ Interpreter::Value Interpreter::Eval(const Expression &aExpr)
// handle single command using selected network
if (mContext.mImportFiles.size() > 0)
{
XpanId xpan = XpanId();
uint64_t xpan = 0;
if (mContext.mNwkAliases.empty())
{
auto result = mRegistry->GetCurrentNetworkXpan(xpan);
if (result != Registry::Status::kSuccess)
{
xpan = XpanId();
xpan = 0;
}
}
else
{
XpanIdArray nwks;
StringArray unresolved;
std::vector<uint64_t> nwks;
StringArray unresolved;
VerifyOrExit(mRegistry->GetNetworkXpansByAliases(mContext.mNwkAliases, nwks, unresolved) ==
Registry::Status::kSuccess,
value = ERROR_INVALID_ARGS("Failed to resolve network alias for import"));
Expand Down Expand Up @@ -624,7 +608,7 @@ bool Interpreter::IsInactiveCommissionerAllowed(const Expression &aExpr)
return IsFeatureSupported(mInactiveCommissionerExecution, aExpr);
}

Interpreter::Value Interpreter::ValidateMultiNetworkSyntax(const Expression &aExpr, XpanIdArray &aNids)
Interpreter::Value Interpreter::ValidateMultiNetworkSyntax(const Expression &aExpr, std::vector<uint64_t> &aNids)
{
Error error;
bool supported;
Expand Down Expand Up @@ -846,7 +830,7 @@ void Interpreter::PrintOrExport(const Value &aValue)

void Interpreter::PrintNetworkMessage(uint64_t aNid, std::string aMessage, Console::Color aColor)
{
std::string nidHex = std::string(XpanId(aNid));
std::string nidHex = utils::Hex(aNid);
PrintNetworkMessage(nidHex, aMessage, aColor);
}

Expand Down Expand Up @@ -970,7 +954,7 @@ Interpreter::Value Interpreter::ProcessStart(const Expression &aExpr)
case 1:
{
// starting currently selected network
XpanId nid;
uint64_t nid;
RegistryStatus status = mRegistry->GetCurrentNetworkXpan(nid);
VerifyOrExit(status == RegistryStatus::kSuccess,
value = ERROR_REGISTRY_ERROR("getting selected network failed"));
Expand Down Expand Up @@ -1191,7 +1175,7 @@ Interpreter::Value Interpreter::ProcessBr(const Expression &aExpr)
}
else
{
PrintNetworkMessage(nwk.mXpan.mValue, RUNTIME_LOOKUP_FAILED, COLOR_ALIAS_FAILED);
PrintNetworkMessage(nwk.mXpan, RUNTIME_LOOKUP_FAILED, COLOR_ALIAS_FAILED);
}
}
}
Expand Down Expand Up @@ -1547,8 +1531,8 @@ Interpreter::Value Interpreter::ProcessBr(const Expression &aExpr)
ExitNow(value = ERROR_CANCELLED("Scan cancelled by user"));
}

XpanIdArray xpans;
StringArray unresolved;
std::vector<uint64_t> xpans;
StringArray unresolved;
if (!mContext.mNwkAliases.empty())
{
VerifyOrExit(mRegistry->GetNetworkXpansByAliases(mContext.mNwkAliases, xpans, unresolved) ==
Expand Down Expand Up @@ -1580,8 +1564,7 @@ Interpreter::Value Interpreter::ProcessBr(const Expression &aExpr)
(agentOrError.mBorderAgent.mDomainName == mContext.mDomAliases[0])) ||
(!mContext.mNwkAliases.empty() &&
(agentOrError.mBorderAgent.mPresentFlags & BorderAgent::kExtendedPanIdBit) &&
(std::find(xpans.begin(), xpans.end(), XpanId(agentOrError.mBorderAgent.mExtendedPanId)) !=
xpans.end())))
(std::find(xpans.begin(), xpans.end(), agentOrError.mBorderAgent.mExtendedPanId) != xpans.end())))
{
baJson.push_back(ba);
}
Expand Down Expand Up @@ -1686,9 +1669,9 @@ Interpreter::Value Interpreter::ProcessNetwork(const Expression &aExpr)
}
else
{
StringArray aliases = {aExpr[2]};
XpanIdArray xpans;
StringArray unresolved;
StringArray aliases = {aExpr[2]};
std::vector<uint64_t> xpans;
StringArray unresolved;
VerifyOrExit(mRegistry->GetNetworkXpansByAliases(aliases, xpans, unresolved) == RegistryStatus::kSuccess,
value = ERROR_REGISTRY_ERROR("Failed to resolve extended PAN Id for network '{}'", aExpr[2]));
VerifyOrExit(xpans.size() == 1, value = ERROR_IO_ERROR("Detected {} networks instead of 1 for alias '{}'",
Expand Down Expand Up @@ -1721,8 +1704,8 @@ Interpreter::Value Interpreter::ProcessNetwork(const Expression &aExpr)
nwkData += '/';
}
nwkData += nwk.mName;
json[nwk.mXpan.str()] = nwkData;
value = json.dump(JSON_INDENT_DEFAULT);
json[utils::Hex(nwk.mXpan)] = nwkData;
value = json.dump(JSON_INDENT_DEFAULT);
}
}
else
Expand Down Expand Up @@ -2115,7 +2098,7 @@ Interpreter::Value Interpreter::ProcessOpDatasetJob(CommissionerAppPtr &aCommiss
}
else if (CaseInsensitiveEqual(aExpr[2], "panid"))
{
PanId panid;
uint16_t panid;
if (isSet)
{
uint32_t delay;
Expand All @@ -2127,7 +2110,7 @@ Interpreter::Value Interpreter::ProcessOpDatasetJob(CommissionerAppPtr &aCommiss
else
{
SuccessOrExit(value = aCommissioner->GetPanId(panid));
value = std::string(panid);
value = Hex(panid);
}
}
else if (CaseInsensitiveEqual(aExpr[2], "pskc"))
Expand Down Expand Up @@ -2166,7 +2149,7 @@ Interpreter::Value Interpreter::ProcessOpDatasetJob(CommissionerAppPtr &aCommiss
ActiveOperationalDataset dataset;
StringArray nwkAliases;
StringArray unresolved;
XpanIdArray xpans;
std::vector<uint64_t> xpans;

if (isSet)
{
Expand All @@ -2186,13 +2169,13 @@ Interpreter::Value Interpreter::ProcessOpDatasetJob(CommissionerAppPtr &aCommiss
// Get network object for the opdataset object
if ((dataset.mPresentFlags & ActiveOperationalDataset::kExtendedPanIdBit) != 0)
{
xpans.push_back(dataset.mExtendedPanId);
xpans.push_back(utils::Decode<uint64_t>(dataset.mExtendedPanId));
}
else
{
if ((dataset.mPresentFlags & ActiveOperationalDataset::kPanIdBit) != 0)
{
nwkAliases.push_back(fmt::format(FMT_STRING("0x{:04X}"), dataset.mPanId.mValue));
nwkAliases.push_back(Hex(dataset.mPanId));
}
else if ((dataset.mPresentFlags & ActiveOperationalDataset::kNetworkNameBit) != 0)
{
Expand All @@ -2214,8 +2197,9 @@ Interpreter::Value Interpreter::ProcessOpDatasetJob(CommissionerAppPtr &aCommiss
}
if (mRegistry->GetNetworkByXpan(xpans[0], nwk) != RegistryStatus::kSuccess)
{
Console::Write(fmt::format(FMT_STRING("Failed to find network record by XPAN '{}'"), xpans[0].str()),
Console::Color::kYellow);
Console::Write(
fmt::format(FMT_STRING("Failed to find network record by XPAN '{}'"), utils::Hex(xpans[0])),
Console::Color::kYellow);
break; /// @todo It is possible that network XPAN ID
/// might have change since the last sync
/// so maybe it is worth to look up for
Expand All @@ -2227,13 +2211,14 @@ Interpreter::Value Interpreter::ProcessOpDatasetJob(CommissionerAppPtr &aCommiss
#define AODS_FIELD_IF_IS_SET(field, defaultValue) \
(((dataset.mPresentFlags & ActiveOperationalDataset::k##field##Bit) == 0) ? (defaultValue) : (dataset.m##field))

nwk.mName = AODS_FIELD_IF_IS_SET(NetworkName, "");
nwk.mXpan = AODS_FIELD_IF_IS_SET(ExtendedPanId, XpanId{});
nwk.mName = AODS_FIELD_IF_IS_SET(NetworkName, "");
nwk.mXpan =
utils::Decode<uint64_t>(AODS_FIELD_IF_IS_SET(ExtendedPanId, ByteArray(kExtendedPanIdLength, 0)));
nwk.mChannel = AODS_FIELD_IF_IS_SET(Channel, (Channel{0, 0})).mNumber;
nwk.mPan = AODS_FIELD_IF_IS_SET(PanId, PanId{});
nwk.mPan = AODS_FIELD_IF_IS_SET(PanId, 0);
if ((dataset.mPresentFlags & ActiveOperationalDataset::kPanIdBit) == 0)
{
nwk.mPan = PanId::kEmptyPanId;
nwk.mPan = 0;
}
else
{
Expand Down
4 changes: 2 additions & 2 deletions src/app/cli/interpreter.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ class Interpreter
struct NetworkSelectionComparator
{
const Interpreter &mInterpreter;
XpanId mStartWith;
uint64_t mStartWith;
bool mSuccess;

NetworkSelectionComparator(const Interpreter &aInterpreter);
Expand Down Expand Up @@ -179,7 +179,7 @@ class Interpreter
* resolution of the provided network aliases is checked in the
* course of execution.
*/
Value ValidateMultiNetworkSyntax(const Expression &aExpr, XpanIdArray &aNids);
Value ValidateMultiNetworkSyntax(const Expression &aExpr, std::vector<uint64_t> &aNids);
/**
* Resolves network aliases into a set of network ids. In the
* course of resolution, duplicate network ids are compacted if
Expand Down
Loading
Loading