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

[logging] remove otLogResult and move to module (#7360)

Browse Source 
This commit removes the `otLogResult{Bbr/Platform}()` macros from
`logging.hpp` and instead have each module implement `LogError()`
method. The main goal behind this change to simplify the logging
module and reduce number of macros/definitions in it (to prepare for
new logging model to be introduced).
This commit is contained in:
Abtin Keshavarzian
2022-01-27 10:29:09 -08:00
committed by GitHub
parent 69ed42f491
commit d71742049f
6 changed files with 68 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/backbone_router/backbone_tmf.cpp
+18 -7
View File
@@ -77,20 +77,31 @@ bool BackboneTmfAgent::IsBackboneTmfMessage(const Ip6::MessageInfo &aMessageInfo
void BackboneTmfAgent::SubscribeMulticast(const Ip6::Address &aAddress)
{
Error error;
Error error = mSocket.JoinNetifMulticastGroup(OT_NETIF_BACKBONE, aAddress);
error = mSocket.JoinNetifMulticastGroup(OT_NETIF_BACKBONE, aAddress);
otLogResultBbr(error, "Backbone TMF subscribes %s", aAddress.ToString().AsCString());
LogError("Backbone TMF subscribes", aAddress, error);
}
void BackboneTmfAgent::UnsubscribeMulticast(const Ip6::Address &aAddress)
{
Error error;
Error error = mSocket.LeaveNetifMulticastGroup(OT_NETIF_BACKBONE, aAddress);
error = mSocket.LeaveNetifMulticastGroup(OT_NETIF_BACKBONE, aAddress);
LogError("Backbone TMF unsubscribes", aAddress, error);
}
otLogResultBbr(error, "Backbone TMF unsubscribes %s", aAddress.ToString().AsCString());
void BackboneTmfAgent::LogError(const char *aText, const Ip6::Address &aAddress, Error aError) const
{
OT_UNUSED_VARIABLE(aText);
OT_UNUSED_VARIABLE(aAddress);
if (aError == kErrorNone)
{
otLogInfoBbr("%s %s: %s", aText, aAddress.ToString().AsCString(), ErrorToString(aError));
}
else
{
otLogWarnBbr("%s %s: %s", aText, aAddress.ToString().AsCString(), ErrorToString(aError));
}
}
} // namespace BackboneRouter
src/core/backbone_router/backbone_tmf.hpp
+1
View File
@@ -99,6 +99,7 @@ public:
void UnsubscribeMulticast(const Ip6::Address &aAddress);
private:
void LogError(const char *aText, const Ip6::Address &aAddress, Error aError) const;
static Error Filter(const ot::Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo, void *aContext);
};
src/core/backbone_router/bbr_manager.cpp
+15 -1
View File
@@ -130,7 +130,7 @@ void Manager::HandleNotifierEvents(Events aEvents)
error = mBackboneTmfAgent.Start();
otLogResultBbr(error, "Start Backbone TMF agent");
LogError("Start Backbone TMF agent", error);
}
}
}
@@ -793,6 +793,20 @@ exit:
}
#endif // OPENTHREAD_CONFIG_BACKBONE_ROUTER_DUA_NDPROXYING_ENABLE
void Manager::LogError(const char *aText, Error aError) const
{
OT_UNUSED_VARIABLE(aText);
if (aError == kErrorNone)
{
otLogInfoBbr("%s: %s", aText, ErrorToString(aError));
}
else
{
otLogWarnBbr("%s: %s", aText, ErrorToString(aError));
}
}
} // namespace BackboneRouter
} // namespace ot
src/core/backbone_router/bbr_manager.hpp
+2
View File
@@ -229,6 +229,8 @@ private:
static void HandleTimer(Timer &aTimer);
void HandleTimer(void);
void LogError(const char *aText, Error aError) const;
#if OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
Coap::Resource mMulticastListenerRegistration;
#endif
src/core/common/logging.hpp
-41
View File
@@ -2582,47 +2582,6 @@ void otDumpMacFrame(otLogLevel aLogLevel, const char *aId, const void *aBuf, siz
*/
void otDump(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aId, const void *aBuf, size_t aLength);
#define _otLogResult(aRegion, aError, ...) \
do \
{ \
otError _err = (aError); \
\
if (_err == OT_ERROR_NONE) \
{ \
otLogInfo##aRegion(OT_FIRST_ARG(__VA_ARGS__) ": %s" OT_REST_ARGS(__VA_ARGS__), \
otThreadErrorToString(_err)); \
} \
else \
{ \
otLogWarn##aRegion(OT_FIRST_ARG(__VA_ARGS__) ": %s" OT_REST_ARGS(__VA_ARGS__), \
otThreadErrorToString(_err)); \
} \
} while (false)
/**
* @def otLogResultPlat
*
* This function generates a log for the Plat region according to the error result. If @p aError is `kErrorNone`, the
* log level is info. Otherwise the log level is warn.
*
* @param[in] aError The error result.
* @param[in] ... Arguments for the format specification.
*
*/
#define otLogResultPlat(aError, ...) _otLogResult(Plat, aError, __VA_ARGS__)
/**
* @def otLogResultBbr
*
* This function generates a log for the BBR region according to the error result. If @p aError is `OT_ERROR_NONE`, the
* log level is info. Otherwise the log level is warn.
*
* @param[in] aError The error result.
* @param[in] ... Arguments for the format specification.
*
*/
#define otLogResultBbr(aError, ...) _otLogResult(Bbr, aError, __VA_ARGS__)
#ifdef __cplusplus
}
#endif
src/posix/platform/multicast_routing.cpp
+32 -16
View File
@@ -34,6 +34,7 @@
#include <net/if.h>
#include <netinet/icmp6.h>
#include <netinet/in.h>
#include <stdio.h>
#include <sys/ioctl.h>
#include <sys/socket.h>
#include <sys/types.h>
@@ -52,6 +53,21 @@
namespace ot {
namespace Posix {
#define LogResult(aError, ...) \
do \
{ \
otError _err = (aError); \
\
if (_err == OT_ERROR_NONE) \
{ \
otLogInfoPlat(OT_FIRST_ARG(__VA_ARGS__) ": %s" OT_REST_ARGS(__VA_ARGS__), otThreadErrorToString(_err)); \
} \
else \
{ \
otLogWarnPlat(OT_FIRST_ARG(__VA_ARGS__) ": %s" OT_REST_ARGS(__VA_ARGS__), otThreadErrorToString(_err)); \
} \
} while (false)
void MulticastRoutingManager::SetUp(void)
{
OT_ASSERT(gInstance != nullptr);
@@ -97,7 +113,7 @@ void MulticastRoutingManager::Enable(void)
InitMulticastRouterSock();
otLogResultPlat(OT_ERROR_NONE, "MulticastRoutingManager: %s", __FUNCTION__);
LogResult(OT_ERROR_NONE, "MulticastRoutingManager: %s", __FUNCTION__);
exit:
return;
}
@@ -106,7 +122,7 @@ void MulticastRoutingManager::Disable(void)
{
FinalizeMulticastRouterSock();
otLogResultPlat(OT_ERROR_NONE, "MulticastRoutingManager: %s", __FUNCTION__);
LogResult(OT_ERROR_NONE, "MulticastRoutingManager: %s", __FUNCTION__);
}
void MulticastRoutingManager::Add(const Ip6::Address &aAddress)
@@ -116,7 +132,7 @@ void MulticastRoutingManager::Add(const Ip6::Address &aAddress)
UnblockInboundMulticastForwardingCache(aAddress);
UpdateMldReport(aAddress, true);
otLogResultPlat(OT_ERROR_NONE, "MulticastRoutingManager: %s: %s", __FUNCTION__, aAddress.ToString().AsCString());
LogResult(OT_ERROR_NONE, "MulticastRoutingManager: %s: %s", __FUNCTION__, aAddress.ToString().AsCString());
exit:
return;
@@ -131,7 +147,7 @@ void MulticastRoutingManager::Remove(const Ip6::Address &aAddress)
RemoveInboundMulticastForwardingCache(aAddress);
UpdateMldReport(aAddress, false);
otLogResultPlat(error, "MulticastRoutingManager: %s: %s", __FUNCTION__, aAddress.ToString().AsCString());
LogResult(error, "MulticastRoutingManager: %s: %s", __FUNCTION__, aAddress.ToString().AsCString());
exit:
return;
@@ -149,8 +165,8 @@ void MulticastRoutingManager::UpdateMldReport(const Ip6::Address &aAddress, bool
? OT_ERROR_FAILED
: OT_ERROR_NONE);
otLogResultPlat(error, "MulticastRoutingManager: %s: address %s %s", __FUNCTION__, aAddress.ToString().AsCString(),
(isAdd ? "Added" : "Removed"));
LogResult(error, "MulticastRoutingManager: %s: address %s %s", __FUNCTION__, aAddress.ToString().AsCString(),
(isAdd ? "Added" : "Removed"));
}
bool MulticastRoutingManager::HasMulticastListener(const Ip6::Address &aAddress) const
@@ -266,7 +282,7 @@ void MulticastRoutingManager::ProcessMulticastRouterMessages(void)
error = AddMulticastForwardingCache(src, dst, static_cast<MifIndex>(mrt6msg->im6_mif));
exit:
otLogResultPlat(error, "MulticastRoutingManager: %s", __FUNCTION__);
LogResult(error, "MulticastRoutingManager: %s", __FUNCTION__);
}
otError MulticastRoutingManager::AddMulticastForwardingCache(const Ip6::Address &aSrcAddr,
@@ -321,9 +337,9 @@ otError MulticastRoutingManager::AddMulticastForwardingCache(const Ip6::Address
SaveMulticastForwardingCache(aSrcAddr, aGroupAddr, aIif, forwardMif);
exit:
otLogResultPlat(error, "MulticastRoutingManager: %s: add dynamic route: %s %s => %s %s", __FUNCTION__,
MifIndexToString(aIif), aSrcAddr.ToString().AsCString(), aGroupAddr.ToString().AsCString(),
MifIndexToString(forwardMif));
LogResult(error, "MulticastRoutingManager: %s: add dynamic route: %s %s => %s %s", __FUNCTION__,
MifIndexToString(aIif), aSrcAddr.ToString().AsCString(), aGroupAddr.ToString().AsCString(),
MifIndexToString(forwardMif));
return error;
}
@@ -358,9 +374,9 @@ void MulticastRoutingManager::UnblockInboundMulticastForwardingCache(const Ip6::
mfc.Set(kMifIndexBackbone, kMifIndexThread);
otLogResultPlat(error, "MulticastRoutingManager: %s: %s %s => %s %s", __FUNCTION__, MifIndexToString(mfc.mIif),
mfc.mSrcAddr.ToString().AsCString(), mfc.mGroupAddr.ToString().AsCString(),
MifIndexToString(kMifIndexThread));
LogResult(error, "MulticastRoutingManager: %s: %s %s => %s %s", __FUNCTION__, MifIndexToString(mfc.mIif),
mfc.mSrcAddr.ToString().AsCString(), mfc.mGroupAddr.ToString().AsCString(),
MifIndexToString(kMifIndexThread));
}
}
@@ -586,9 +602,9 @@ void MulticastRoutingManager::RemoveMulticastForwardingCache(
? OT_ERROR_NONE
: OT_ERROR_FAILED;
otLogResultPlat(error, "MulticastRoutingManager: %s: %s %s => %s %s", __FUNCTION__, MifIndexToString(aMfc.mIif),
aMfc.mSrcAddr.ToString().AsCString(), aMfc.mGroupAddr.ToString().AsCString(),
MifIndexToString(aMfc.mOif));
LogResult(error, "MulticastRoutingManager: %s: %s %s => %s %s", __FUNCTION__, MifIndexToString(aMfc.mIif),
aMfc.mSrcAddr.ToString().AsCString(), aMfc.mGroupAddr.ToString().AsCString(),
MifIndexToString(aMfc.mOif));
aMfc.Erase();
}