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

[border-agent] simplify ForwardContext allocation and ownership (#9444)

Browse Source 
This commit updates `ForwardContext` to be `Heap::Allocatable` and
uses `OwnerPtr` to simplify the ownership (and freeing) of allocated
`ForwardContext` objects.
This commit is contained in:
Abtin Keshavarzian
2023-09-20 14:17:45 -07:00
committed by GitHub
parent df128246ac
commit 753b305207
2 changed files with 37 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/meshcop/border_agent.cpp
+29 -29
View File
@@ -41,6 +41,7 @@
#include "common/instance.hpp"
#include "common/locator_getters.hpp"
#include "common/log.hpp"
#include "common/owned_ptr.hpp"
#include "common/settings.hpp"
#include "meshcop/meshcop.hpp"
#include "meshcop/meshcop_tlvs.hpp"
@@ -56,10 +57,10 @@ RegisterLogModule("BorderAgent");
//----------------------------------------------------------------------------------------------------------------------
// `BorderAgent::ForwardContext`
void BorderAgent::ForwardContext::Init(Instance &aInstance,
const Coap::Message &aMessage,
bool aPetition,
bool aSeparate)
Error BorderAgent::ForwardContext::Init(Instance &aInstance,
const Coap::Message &aMessage,
bool aPetition,
bool aSeparate)
{
InstanceLocatorInit::Init(aInstance);
mMessageId = aMessage.GetMessageId();
@@ -68,9 +69,11 @@ void BorderAgent::ForwardContext::Init(Instance &aInstance,
mType = aMessage.GetType();
mTokenLength = aMessage.GetTokenLength();
memcpy(mToken, aMessage.GetToken(), mTokenLength);
return kErrorNone;
}
Error BorderAgent::ForwardContext::ToHeader(Coap::Message &aMessage, uint8_t aCode)
Error BorderAgent::ForwardContext::ToHeader(Coap::Message &aMessage, uint8_t aCode) const
{
if ((mType == Coap::kTypeNonConfirmable) || mSeparate)
{
@@ -114,7 +117,7 @@ Coap::Message::Code BorderAgent::CoapCodeFromError(Error aError)
return code;
}
void BorderAgent::SendErrorMessage(ForwardContext &aForwardContext, Error aError)
void BorderAgent::SendErrorMessage(const ForwardContext &aForwardContext, Error aError)
{
Error error = kErrorNone;
Coap::Message *message = nullptr;
@@ -170,12 +173,14 @@ void BorderAgent::HandleCoapResponse(void *aContext,
{
OT_UNUSED_VARIABLE(aMessageInfo);
ForwardContext &forwardContext = *static_cast<ForwardContext *>(aContext);
OwnedPtr<ForwardContext> forwardContext(static_cast<ForwardContext *>(aContext));
forwardContext.Get<BorderAgent>().HandleCoapResponse(forwardContext, AsCoapMessagePtr(aMessage), aResult);
forwardContext->Get<BorderAgent>().HandleCoapResponse(*forwardContext.Get(), AsCoapMessagePtr(aMessage), aResult);
}
void BorderAgent::HandleCoapResponse(ForwardContext &aForwardContext, const Coap::Message *aResponse, Error aResult)
void BorderAgent::HandleCoapResponse(const ForwardContext &aForwardContext,
const Coap::Message *aResponse,
Error aResult)
{
Coap::Message *message = nullptr;
Error error;
@@ -223,8 +228,6 @@ exit:
SendErrorMessage(aForwardContext, error);
}
Heap::Free(&aForwardContext);
}
BorderAgent::BorderAgent(Instance &aInstance)
@@ -516,12 +519,12 @@ exit:
Error BorderAgent::ForwardToLeader(const Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo, Uri aUri)
{
Error error = kErrorNone;
ForwardContext *forwardContext = nullptr;
Tmf::MessageInfo messageInfo(GetInstance());
Coap::Message *message = nullptr;
bool petition = false;
bool separate = false;
Error error = kErrorNone;
OwnedPtr<ForwardContext> forwardContext;
Tmf::MessageInfo messageInfo(GetInstance());
Coap::Message *message = nullptr;
bool petition = false;
bool separate = false;
VerifyOrExit(mState != kStateStopped);
@@ -543,10 +546,8 @@ Error BorderAgent::ForwardToLeader(const Coap::Message &aMessage, const Ip6::Mes
SuccessOrExit(error = Get<Tmf::SecureAgent>().SendAck(aMessage, aMessageInfo));
}
forwardContext = static_cast<ForwardContext *>(Heap::CAlloc(1, sizeof(ForwardContext)));
VerifyOrExit(forwardContext != nullptr, error = kErrorNoBufs);
forwardContext->Init(GetInstance(), aMessage, petition, separate);
forwardContext.Reset(ForwardContext::AllocateAndInit(GetInstance(), aMessage, petition, separate));
VerifyOrExit(!forwardContext.IsNull(), error = kErrorNoBufs);
message = Get<Tmf::Agent>().NewPriorityConfirmablePostMessage(aUri);
VerifyOrExit(message != nullptr, error = kErrorNoBufs);
@@ -557,10 +558,14 @@ Error BorderAgent::ForwardToLeader(const Coap::Message &aMessage, const Ip6::Mes
SuccessOrExit(error = messageInfo.SetSockAddrToRlocPeerAddrToLeaderAloc());
messageInfo.SetSockPortToTmf();
SuccessOrExit(error = Get<Tmf::Agent>().SendMessage(*message, messageInfo, HandleCoapResponse, forwardContext));
SuccessOrExit(error =
Get<Tmf::Agent>().SendMessage(*message, messageInfo, HandleCoapResponse, forwardContext.Get()));
// HandleCoapResponse is responsible to free this forward context.
forwardContext = nullptr;
// Release the ownership of `forwardContext` since `SendMessage()`
// will own it. We take back ownership from `HandleCoapResponse()`
// callback.
forwardContext.Release();
LogInfo("Forwarded request to leader on %s", PathForUri(aUri));
@@ -569,11 +574,6 @@ exit:
if (error != kErrorNone)
{
if (forwardContext != nullptr)
{
Heap::Free(forwardContext);
}
FreeMessage(message);
SendErrorMessage(aMessage, separate, error);
}
src/core/meshcop/border_agent.hpp
+8 -7
View File
@@ -41,6 +41,7 @@
#include <openthread/border_agent.h>
#include "common/as_core_type.hpp"
#include "common/heap_allocatable.hpp"
#include "common/locator.hpp"
#include "common/non_copyable.hpp"
#include "common/notifier.hpp"
@@ -159,13 +160,13 @@ private:
static constexpr uint16_t kUdpPort = OPENTHREAD_CONFIG_BORDER_AGENT_UDP_PORT;
static constexpr uint32_t kKeepAliveTimeout = 50 * 1000; // Timeout to reject a commissioner (in msec)
class ForwardContext : public InstanceLocatorInit
class ForwardContext : public InstanceLocatorInit, public Heap::Allocatable<ForwardContext>
{
public:
void Init(Instance &aInstance, const Coap::Message &aMessage, bool aPetition, bool aSeparate);
Error Init(Instance &aInstance, const Coap::Message &aMessage, bool aPetition, bool aSeparate);
bool IsPetition(void) const { return mPetition; }
uint16_t GetMessageId(void) const { return mMessageId; }
Error ToHeader(Coap::Message &aMessage, uint8_t aCode);
Error ToHeader(Coap::Message &aMessage, uint8_t aCode) const;
private:
uint16_t mMessageId; // The CoAP Message ID of the original request.
@@ -180,7 +181,7 @@ private:
Coap::Message::Code CoapCodeFromError(Error aError);
Error SendMessage(Coap::Message &aMessage);
void SendErrorMessage(ForwardContext &aForwardContext, Error aError);
void SendErrorMessage(const ForwardContext &aForwardContext, Error aError);
void SendErrorMessage(const Coap::Message &aRequest, bool aSeparate, Error aError);
static void HandleConnected(bool aConnected, void *aContext);
@@ -194,9 +195,9 @@ private:
otMessage *aMessage,
const otMessageInfo *aMessageInfo,
Error aResult);
void HandleCoapResponse(ForwardContext &aForwardContext, const Coap::Message *aResponse, Error aResult);
Error ForwardToLeader(const Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo, Uri aUri);
Error ForwardToCommissioner(Coap::Message &aForwardMessage, const Message &aMessage);
void HandleCoapResponse(const ForwardContext &aForwardContext, const Coap::Message *aResponse, Error aResult);
Error ForwardToLeader(const Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo, Uri aUri);
Error ForwardToCommissioner(Coap::Message &aForwardMessage, const Message &aMessage);
static bool HandleUdpReceive(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo);
bool HandleUdpReceive(const Message &aMessage, const Ip6::MessageInfo &aMessageInfo);