espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-06-06 05:24:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

[takelet] add template TaskeltIn to simplify handler functions (#8064)

Browse Source 
This class adds a template sub-class of `Tasklet` which allows
us to directly specify an `Owner` of tasklet along with handler
callback as a member method of `Owner`. This helps simplify the
use of `Tasklet` in core module.
This commit is contained in:
Abtin Keshavarzian
2022-08-24 10:44:48 -07:00
committed by GitHub
parent 5516024905
commit 9699d319af
22 changed files with 100 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/border_router/routing_manager.cpp
+1 -6
View File
@@ -1288,7 +1288,7 @@ void RoutingManager::ResetDiscoveredPrefixStaleTimer(void)
RoutingManager::DiscoveredPrefixTable::DiscoveredPrefixTable(Instance &aInstance)
: InstanceLocator(aInstance)
, mTimer(aInstance, HandleTimer)
, mSignalTask(aInstance, HandleSignalTask)
, mSignalTask(aInstance)
, mAllowDefaultRouteInNetData(false)
{
}
@@ -1823,11 +1823,6 @@ void RoutingManager::DiscoveredPrefixTable::SignalTableChanged(void)
mSignalTask.Post();
}
void RoutingManager::DiscoveredPrefixTable::HandleSignalTask(Tasklet &aTasklet)
{
aTasklet.Get<RoutingManager>().HandleDiscoveredPrefixTableChanged();
}
void RoutingManager::DiscoveredPrefixTable::InitIterator(PrefixTableIterator &aIterator) const
{
Iterator &iterator = static_cast<Iterator &>(aIterator);
src/core/border_router/routing_manager.hpp
+5 -3
View File
@@ -349,6 +349,8 @@ private:
kAdvPrefixesFromNetData,
};
void HandleDiscoveredPrefixTableChanged(void); // Declare early so we can use in `mSignalTask`
class DiscoveredPrefixTable : public InstanceLocator
{
// This class maintains the discovered on-link and route prefixes
@@ -517,12 +519,13 @@ private:
void HandleTimer(void);
void RemoveExpiredEntries(void);
void SignalTableChanged(void);
static void HandleSignalTask(Tasklet &aTasklet);
using SignalTask = TaskletIn<RoutingManager, &RoutingManager::HandleDiscoveredPrefixTableChanged>;
Array<Router, kMaxRouters> mRouters;
Pool<Entry, kMaxEntries> mEntryPool;
TimerMilli mTimer;
Tasklet mSignalTask;
SignalTask mSignalTask;
bool mAllowDefaultRouteInNetData;
};
@@ -672,7 +675,6 @@ private:
bool ShouldProcessPrefixInfoOption(const Ip6::Nd::PrefixInfoOption &aPio, const Ip6::Prefix &aPrefix);
bool ShouldProcessRouteInfoOption(const Ip6::Nd::RouteInfoOption &aRio, const Ip6::Prefix &aPrefix);
void UpdateDiscoveredPrefixTableOnNetDataChange(void);
void HandleDiscoveredPrefixTableChanged(void);
bool NetworkDataContainsOmrPrefix(const Ip6::Prefix &aPrefix) const;
void UpdateRouterAdvertHeader(const Ip6::Nd::RouterAdvertMessage *aRouterAdvertMessage);
bool IsReceivedRouterAdvertFromManager(const Ip6::Nd::RouterAdvertMessage &aRaMessage) const;
src/core/common/locator_getters.hpp
+7
View File
@@ -39,6 +39,7 @@
#include "common/instance.hpp"
#include "common/locator.hpp"
#include "common/tasklet.hpp"
namespace ot {
@@ -49,6 +50,12 @@ inline Type &GetProvider<InstanceGetProvider>::Get(void) const
return static_cast<const InstanceGetProvider *>(this)->GetInstance().template Get<Type>();
}
template <typename Owner, void (Owner::*HandleTaskletPtr)(void)>
void TaskletIn<Owner, HandleTaskletPtr>::HandleTasklet(Tasklet &aTasklet)
{
(aTasklet.Get<Owner>().*HandleTaskletPtr)();
}
} // namespace ot
#endif // LOCATOR_GETTERS_HPP_
src/core/common/notifier.cpp
+1 -6
View File
@@ -46,7 +46,7 @@ RegisterLogModule("Notifier");
Notifier::Notifier(Instance &aInstance)
: InstanceLocator(aInstance)
, mTask(aInstance, Notifier::EmitEvents)
, mTask(aInstance)
{
for (ExternalCallback &callback : mExternalCallbacks)
{
@@ -118,11 +118,6 @@ void Notifier::SignalIfFirst(Event aEvent)
}
}
void Notifier::EmitEvents(Tasklet &aTasklet)
{
aTasklet.Get<Notifier>().EmitEvents();
}
void Notifier::EmitEvents(void)
{
Events events;
src/core/common/notifier.hpp
+4 -3
View File
@@ -313,15 +313,16 @@ private:
void * mContext;
};
static void EmitEvents(Tasklet &aTasklet);
void EmitEvents(void);
void EmitEvents(void);
void LogEvents(Events aEvents) const;
const char *EventToString(Event aEvent) const;
using EmitEventsTask = TaskletIn<Notifier, &Notifier::EmitEvents>;
Events mEventsToSignal;
Events mSignaledEvents;
Tasklet mTask;
EmitEventsTask mTask;
ExternalCallback mExternalCallbacks[kMaxExternalHandlers];
};
src/core/common/tasklet.hpp
+27
View File
@@ -149,6 +149,33 @@ private:
Tasklet *mNext;
};
/**
* This template class defines a tasklet owned by specific type and using a method on owner type as the callback.
*
* @tparam Owner The type of owner of this tasklet.
* @tparam HandleTaskletPtr A pointer to a non-static member method of `Owner` to use as tasklet handler.
*
* The `Owner` MUST be a type that is accessible using `InstanceLocator::Get<Owner>()`.
*
*/
template <typename Owner, void (Owner::*HandleTaskletPtr)(void)> class TaskletIn : public Tasklet
{
public:
/**
* This constructor initializes the tasklet.
*
* @param[in] aInstance The OpenThread instance.
*
*/
explicit TaskletIn(Instance &aInstance)
: Tasklet(aInstance, HandleTasklet)
{
}
private:
static void HandleTasklet(Tasklet &aTasklet); // Implemented in `locator_getters.hpp`
};
/**
* This class defines a tasklet that also maintains a user context pointer.
*
src/core/mac/mac.cpp
+1 -6
View File
@@ -100,7 +100,7 @@ Mac::Mac(Instance &aInstance)
, mActiveScanHandler(nullptr) // Initialize `mActiveScanHandler` and `mEnergyScanHandler` union
, mScanHandlerContext(nullptr)
, mLinks(aInstance)
, mOperationTask(aInstance, Mac::HandleOperationTask)
, mOperationTask(aInstance)
, mTimer(aInstance, Mac::HandleTimer)
, mKeyIdMode2FrameCounter(0)
, mCcaSampleCount(0)
@@ -608,11 +608,6 @@ void Mac::StartOperation(Operation aOperation)
}
}
void Mac::HandleOperationTask(Tasklet &aTasklet)
{
aTasklet.Get<Mac>().PerformNextOperation();
}
void Mac::PerformNextOperation(void)
{
VerifyOrExit(mOperation == kOperationIdle);
src/core/mac/mac.hpp
+3 -2
View File
@@ -763,7 +763,6 @@ private:
static void HandleTimer(Timer &aTimer);
void HandleTimer(void);
static void HandleOperationTask(Tasklet &aTasklet);
void Scan(Operation aScanOperation, uint32_t aScanChannels, uint16_t aScanDuration);
Error UpdateScanChannel(void);
@@ -789,6 +788,8 @@ private:
#endif
static const char *OperationToString(Operation aOperation);
using OperationTask = TaskletIn<Mac, &Mac::PerformNextOperation>;
static const otExtAddress sMode2ExtAddress;
bool mEnabled : 1;
@@ -835,7 +836,7 @@ private:
void *mScanHandlerContext;
Links mLinks;
Tasklet mOperationTask;
OperationTask mOperationTask;
TimerMilli mTimer;
otMacCounters mCounters;
uint32_t mKeyIdMode2FrameCounter;
src/core/net/ip6.cpp
+1 -6
View File
@@ -75,7 +75,7 @@ Ip6::Ip6(Instance &aInstance)
, mReceiveIp4DatagramCallback(nullptr)
, mReceiveIp4DatagramCallbackContext(nullptr)
#endif
, mSendQueueTask(aInstance, Ip6::HandleSendQueue)
, mSendQueueTask(aInstance)
, mIcmp(aInstance)
, mUdp(aInstance)
, mMpl(aInstance)
@@ -543,11 +543,6 @@ exit:
return error;
}
void Ip6::HandleSendQueue(Tasklet &aTasklet)
{
aTasklet.Get<Ip6>().HandleSendQueue();
}
void Ip6::HandleSendQueue(void)
{
Message *message;
src/core/net/ip6.hpp
+4 -3
View File
@@ -343,8 +343,7 @@ private:
static constexpr uint16_t kMinimalMtu = 1280;
static void HandleSendQueue(Tasklet &aTasklet);
void HandleSendQueue(void);
void HandleSendQueue(void);
static uint8_t PriorityToDscp(Message::Priority aPriority);
static Error GetDatagramPriority(const uint8_t *aData, uint16_t aDataLen, Message::Priority &aPriority);
@@ -383,6 +382,8 @@ private:
bool ShouldForwardToThread(const MessageInfo &aMessageInfo, MessageOrigin aOrigin) const;
bool IsOnLink(const Address &aAddress) const;
using SendQueueTask = TaskletIn<Ip6, &Ip6::HandleSendQueue>;
bool mForwardingEnabled;
bool mIsReceiveIp6FilterEnabled;
otIp6ReceiveCallback mReceiveIp6DatagramCallback;
@@ -394,7 +395,7 @@ private:
#endif
PriorityQueue mSendQueue;
Tasklet mSendQueueTask;
SendQueueTask mSendQueueTask;
Icmp mIcmp;
Udp mUdp;
src/core/net/tcp6.cpp
+1 -8
View File
@@ -73,7 +73,7 @@ static_assert(offsetof(Tcp::Listener, mTcbListen) == 0, "mTcbListen field in otT
Tcp::Tcp(Instance &aInstance)
: InstanceLocator(aInstance)
, mTimer(aInstance, Tcp::HandleTimer)
, mTasklet(aInstance, Tcp::HandleTasklet)
, mTasklet(aInstance)
, mEphemeralPort(kDynamicPortMin)
{
OT_UNUSED_VARIABLE(mEphemeralPort);
@@ -918,13 +918,6 @@ restart:
}
}
void Tcp::HandleTasklet(Tasklet &aTasklet)
{
OT_ASSERT(&aTasklet == &aTasklet.Get<Tcp>().mTasklet);
LogDebg("TCP tasklet invoked");
aTasklet.Get<Tcp>().ProcessCallbacks();
}
void Tcp::ProcessCallbacks(void)
{
for (Endpoint &endpoint : mEndpoints)
src/core/net/tcp6.hpp
+4 -3
View File
@@ -680,11 +680,12 @@ private:
static void HandleTimer(Timer &aTimer);
void ProcessTimers(void);
static void HandleTasklet(Tasklet &aTasklet);
void ProcessCallbacks(void);
void ProcessCallbacks(void);
using TcpTasklet = TaskletIn<Tcp, &Tcp::ProcessCallbacks>;
TimerMilli mTimer;
Tasklet mTasklet;
TcpTasklet mTasklet;
LinkedList<Endpoint> mEndpoints;
LinkedList<Listener> mListeners;
src/core/radio/trel_interface.cpp
+1 -6
View File
@@ -59,7 +59,7 @@ Interface::Interface(Instance &aInstance)
, mInitialized(false)
, mEnabled(false)
, mFiltered(false)
, mRegisterServiceTask(aInstance, HandleRegisterServiceTask)
, mRegisterServiceTask(aInstance)
{
}
@@ -127,11 +127,6 @@ exit:
return;
}
void Interface::HandleRegisterServiceTask(Tasklet &aTasklet)
{
aTasklet.Get<Interface>().RegisterService();
}
void Interface::RegisterService(void)
{
// TXT data consists of two entries: the length fields, the
src/core/radio/trel_interface.hpp
+15 -14
View File
@@ -242,21 +242,22 @@ private:
void HandleReceived(uint8_t *aBuffer, uint16_t aLength);
void HandleDiscoveredPeerInfo(const Peer::Info &aInfo);
static void HandleRegisterServiceTask(Tasklet &aTasklet);
void RegisterService(void);
Error ParsePeerInfoTxtData(const Peer::Info & aInfo,
Mac::ExtAddress & aExtAddress,
MeshCoP::ExtendedPanId &aExtPanId) const;
Peer * GetNewPeerEntry(void);
void RemovePeerEntry(Peer &aEntry);
void RegisterService(void);
Error ParsePeerInfoTxtData(const Peer::Info & aInfo,
Mac::ExtAddress & aExtAddress,
MeshCoP::ExtendedPanId &aExtPanId) const;
Peer *GetNewPeerEntry(void);
void RemovePeerEntry(Peer &aEntry);
bool mInitialized : 1;
bool mEnabled : 1;
bool mFiltered : 1;
Tasklet mRegisterServiceTask;
uint16_t mUdpPort;
Packet mRxPacket;
PeerTable mPeerTable;
using RegsiterServiceTask = TaskletIn<Interface, &Interface::RegisterService>;
bool mInitialized : 1;
bool mEnabled : 1;
bool mFiltered : 1;
RegsiterServiceTask mRegisterServiceTask;
uint16_t mUdpPort;
Packet mRxPacket;
PeerTable mPeerTable;
};
} // namespace Trel
src/core/radio/trel_link.cpp
+1 -6
View File
@@ -51,7 +51,7 @@ Link::Link(Instance &aInstance)
, mRxChannel(0)
, mPanId(Mac::kPanIdBroadcast)
, mTxPacketNumber(0)
, mTxTasklet(aInstance, HandleTxTasklet)
, mTxTasklet(aInstance)
, mTimer(aInstance, HandleTimer)
, mInterface(aInstance)
{
@@ -116,11 +116,6 @@ void Link::Send(void)
mTxTasklet.Post();
}
void Link::HandleTxTasklet(Tasklet &aTasklet)
{
aTasklet.Get<Link>().HandleTxTasklet();
}
void Link::HandleTxTasklet(void)
{
BeginTransmit();
src/core/radio/trel_link.hpp
+4 -3
View File
@@ -174,19 +174,20 @@ private:
void HandleTimer(Neighbor &aNeighbor);
void HandleNotifierEvents(Events aEvents);
static void HandleTxTasklet(Tasklet &aTasklet);
void HandleTxTasklet(void);
void HandleTxTasklet(void);
static void HandleTimer(Timer &aTimer);
void HandleTimer(void);
static const char *StateToString(State aState);
using TxTasklet = TaskletIn<Link, &Link::HandleTxTasklet>;
State mState;
uint8_t mRxChannel;
Mac::PanId mPanId;
uint32_t mTxPacketNumber;
Tasklet mTxTasklet;
TxTasklet mTxTasklet;
TimerMilli mTimer;
Interface mInterface;
Mac::RxFrame mRxFrame;
src/core/thread/dua_manager.cpp
+1 -6
View File
@@ -54,7 +54,7 @@ RegisterLogModule("DuaManager");
DuaManager::DuaManager(Instance &aInstance)
: InstanceLocator(aInstance)
, mRegistrationTask(aInstance, DuaManager::HandleRegistrationTask)
, mRegistrationTask(aInstance)
, mDuaNotification(UriPath::kDuaRegistrationNotify, &DuaManager::HandleDuaNotification, this)
, mIsDuaPending(false)
#if OPENTHREAD_CONFIG_DUA_ENABLE
@@ -402,11 +402,6 @@ void DuaManager::HandleTimeTick(void)
UpdateTimeTickerRegistration();
}
void DuaManager::HandleRegistrationTask(Tasklet &aTasklet)
{
aTasklet.Get<DuaManager>().PerformNextRegistration();
}
void DuaManager::UpdateTimeTickerRegistration(void)
{
if (mDelay.mValue == 0)
src/core/thread/dua_manager.hpp
+6 -6
View File
@@ -195,8 +195,6 @@ private:
void HandleTimeTick(void);
static void HandleRegistrationTask(Tasklet &aTasklet);
void UpdateTimeTickerRegistration(void);
static void HandleDuaResponse(void * aContext,
@@ -214,10 +212,12 @@ private:
void UpdateReregistrationDelay(void);
void UpdateCheckDelay(uint8_t aDelay);
Tasklet mRegistrationTask;
Coap::Resource mDuaNotification;
Ip6::Address mRegisteringDua;
bool mIsDuaPending : 1;
using RegistrationTask = TaskletIn<DuaManager, &DuaManager::PerformNextRegistration>;
RegistrationTask mRegistrationTask;
Coap::Resource mDuaNotification;
Ip6::Address mRegisteringDua;
bool mIsDuaPending : 1;
#if OPENTHREAD_CONFIG_DUA_ENABLE
enum DuaState : uint8_t
src/core/thread/mesh_forwarder.cpp
+1 -6
View File
@@ -105,7 +105,7 @@ MeshForwarder::MeshForwarder(Instance &aInstance)
, mDelayNextTx(false)
, mTxDelayTimer(aInstance, HandleTxDelayTimer)
#endif
, mScheduleTransmissionTask(aInstance, MeshForwarder::ScheduleTransmissionTask)
, mScheduleTransmissionTask(aInstance)
#if OPENTHREAD_FTD
, mIndirectSender(aInstance)
#endif
@@ -521,11 +521,6 @@ exit:
#endif // (OPENTHREAD_CONFIG_MAX_FRAMES_IN_DIRECT_TX_QUEUE > 0)
void MeshForwarder::ScheduleTransmissionTask(Tasklet &aTasklet)
{
aTasklet.Get<MeshForwarder>().ScheduleTransmissionTask();
}
void MeshForwarder::ScheduleTransmissionTask(void)
{
VerifyOrExit(!mSendBusy && !mTxPaused);
src/core/thread/mesh_forwarder.hpp
+5 -4
View File
@@ -487,9 +487,8 @@ private:
void UpdateSendMessage(Error aFrameTxError, Mac::Address &aMacDest, Neighbor *aNeighbor);
void RemoveMessageIfNoPendingTx(Message &aMessage);
void HandleTimeTick(void);
static void ScheduleTransmissionTask(Tasklet &aTasklet);
void ScheduleTransmissionTask(void);
void HandleTimeTick(void);
void ScheduleTransmissionTask(void);
Error GetFramePriority(const FrameData &aFrameData, const Mac::Addresses &aMacAddrs, Message::Priority &aPriority);
Error GetFragmentPriority(Lowpan::FragmentHeader &aFragmentHeader,
@@ -555,6 +554,8 @@ private:
LogLevel aLogLevel);
#endif // #if OT_SHOULD_LOG_AT(OT_LOG_LEVEL_NOTE)
using TxTask = TaskletIn<MeshForwarder, &MeshForwarder::ScheduleTransmissionTask>;
PriorityQueue mSendQueue;
MessageQueue mReassemblyList;
uint16_t mFragTag;
@@ -574,7 +575,7 @@ private:
TimerMilli mTxDelayTimer;
#endif
Tasklet mScheduleTransmissionTask;
TxTask mScheduleTransmissionTask;
otIpCounters mIpCounters;
src/core/thread/network_data_notifier.cpp
+1 -6
View File
@@ -50,7 +50,7 @@ RegisterLogModule("NetworkData");
Notifier::Notifier(Instance &aInstance)
: InstanceLocator(aInstance)
, mTimer(aInstance, HandleTimer)
, mSynchronizeDataTask(aInstance, HandleSynchronizeDataTask)
, mSynchronizeDataTask(aInstance)
, mNextDelay(0)
, mWaitingForResponse(false)
#if OPENTHREAD_FTD && OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE && OPENTHREAD_CONFIG_BORDER_ROUTER_REQUEST_ROUTER_ROLE
@@ -71,11 +71,6 @@ void Notifier::HandleServerDataUpdated(void)
mSynchronizeDataTask.Post();
}
void Notifier::HandleSynchronizeDataTask(Tasklet &aTasklet)
{
aTasklet.Get<Notifier>().SynchronizeServerData();
}
void Notifier::SynchronizeServerData(void)
{
Error error = kErrorNotFound;
src/core/thread/network_data_notifier.hpp
+6 -6
View File
@@ -115,18 +115,18 @@ private:
Error aResult);
void HandleCoapResponse(Error aResult);
static void HandleSynchronizeDataTask(Tasklet &aTasklet);
void SynchronizeServerData(void);
#if OPENTHREAD_FTD && OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE && OPENTHREAD_CONFIG_BORDER_ROUTER_REQUEST_ROUTER_ROLE
void ScheduleRouterRoleUpgradeIfEligible(void);
void HandleTimeTick(void);
#endif
TimerMilli mTimer;
Tasklet mSynchronizeDataTask;
uint32_t mNextDelay;
bool mWaitingForResponse : 1;
using SynchronizeDataTask = TaskletIn<Notifier, &Notifier::SynchronizeServerData>;
TimerMilli mTimer;
SynchronizeDataTask mSynchronizeDataTask;
uint32_t mNextDelay;
bool mWaitingForResponse : 1;
#if OPENTHREAD_FTD && OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE && OPENTHREAD_CONFIG_BORDER_ROUTER_REQUEST_ROUTER_ROLE
bool mDidRequestRouterRoleUpgrade : 1;