espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-19 17:09:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

[mesh-forwarder] simplify logging messages (#10716)

Browse Source 
This commit simplifies logging methods (e.g., `LogIp6Message()`) in
the `MeshForwarder` class:
- Log lines are prepared in a `String`, allowing new fields to be
  added conditionally. This simplifies the code and avoids complex
  `printf`-style formats for handling optional fields.
- New helper methods are added to prepare common labels in a log line
  (e.g., adding MAC address, adding security/error/priority fields).
- Logging IPv6 source/destination addresses is simplified by defining
  a new helper to log an address/port.
This commit is contained in:
Abtin Keshavarzian
2024-09-16 14:55:50 -07:00
committed by GitHub
parent 67b8f5c821
commit 9d8fcfdb8b
4 changed files with 99 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/common/log.hpp
+2
View File
@@ -78,6 +78,8 @@ enum LogLevel : uint8_t
constexpr uint8_t kMaxLogModuleNameLength = 14; ///< Maximum module name length
constexpr uint16_t kMaxLogStringSize = OPENTHREAD_CONFIG_LOG_MAX_SIZE; ///< Max size of log string
#if OT_SHOULD_LOG && (OPENTHREAD_CONFIG_LOG_LEVEL != OT_LOG_LEVEL_NONE)
/**
* Registers log module name.
src/core/thread/mesh_forwarder.cpp
+74 -39
View File
@@ -43,6 +43,7 @@
#include "net/ip6.hpp"
#include "net/ip6_filter.hpp"
#include "net/netif.hpp"
#include "net/socket.hpp"
#include "net/tcp6.hpp"
#include "net/udp6.hpp"
#include "radio/radio.hpp"
@@ -1882,27 +1883,27 @@ const char *MeshForwarder::MessagePriorityToString(const Message &aMessage)
#if OPENTHREAD_CONFIG_LOG_SRC_DST_IP_ADDRESSES
void MeshForwarder::LogIp6SourceDestAddresses(const Ip6::Headers &aHeaders, LogLevel aLogLevel)
{
uint16_t srcPort = aHeaders.GetSourcePort();
uint16_t dstPort = aHeaders.GetDestinationPort();
if (srcPort != 0)
{
LogAt(aLogLevel, " src:[%s]:%d", aHeaders.GetSourceAddress().ToString().AsCString(), srcPort);
}
else
{
LogAt(aLogLevel, " src:[%s]", aHeaders.GetSourceAddress().ToString().AsCString());
}
if (dstPort != 0)
{
LogAt(aLogLevel, " dst:[%s]:%d", aHeaders.GetDestinationAddress().ToString().AsCString(), dstPort);
}
else
{
LogAt(aLogLevel, " dst:[%s]", aHeaders.GetDestinationAddress().ToString().AsCString());
}
LogIp6AddressAndPort("src", aHeaders.GetSourceAddress(), aHeaders.GetSourcePort(), aLogLevel);
LogIp6AddressAndPort("dst", aHeaders.GetDestinationAddress(), aHeaders.GetDestinationPort(), aLogLevel);
}
void MeshForwarder::LogIp6AddressAndPort(const char *aLabel,
const Ip6::Address &aAddress,
uint16_t aPort,
LogLevel aLogLevel)
{
Ip6::SockAddr::InfoString string;
string.Append("[%s]", aAddress.ToString().AsCString());
if (aPort != 0)
{
string.Append(":%u", aPort);
}
LogAt(aLogLevel, " %s:%s", aLabel, string.AsCString());
}
#else
void MeshForwarder::LogIp6SourceDestAddresses(const Ip6::Headers &, LogLevel) {}
#endif
@@ -1913,30 +1914,19 @@ void MeshForwarder::LogIp6Message(MessageAction aAction,
Error aError,
LogLevel aLogLevel)
{
Ip6::Headers headers;
bool shouldLogRss;
bool shouldLogRadio = false;
const char *radioString = "";
Ip6::Headers headers;
String<kMaxLogStringSize> string;
SuccessOrExit(headers.ParseFrom(aMessage));
shouldLogRss = (aAction == kMessageReceive) || (aAction == kMessageReassemblyDrop);
string.Append("%s IPv6 %s msg, len:%u, chksum:%04x, ecn:%s, ", MessageActionToString(aAction, aError),
Ip6::Ip6::IpProtoToString(headers.GetIpProto()), aMessage.GetLength(), headers.GetChecksum(),
Ip6::Ip6::EcnToString(headers.GetEcn()));
#if OPENTHREAD_CONFIG_MULTI_RADIO
shouldLogRadio = true;
radioString = aMessage.IsRadioTypeSet() ? RadioTypeToString(aMessage.GetRadioType()) : "all";
#endif
AppendMacAddrToLogString(string, aAction, aMacAddress);
AppendSecErrorPrioRssRadioLabelsToLogString(string, aAction, aMessage, aError);
LogAt(aLogLevel, "%s IPv6 %s msg, len:%d, chksum:%04x, ecn:%s%s%s, sec:%s%s%s, prio:%s%s%s%s%s",
MessageActionToString(aAction, aError), Ip6::Ip6::IpProtoToString(headers.GetIpProto()), aMessage.GetLength(),
headers.GetChecksum(), Ip6::Ip6::EcnToString(headers.GetEcn()),
(aMacAddress == nullptr) ? "" : ((aAction == kMessageReceive) ? ", from:" : ", to:"),
(aMacAddress == nullptr) ? "" : aMacAddress->ToString().AsCString(),
ToYesNo(aMessage.IsLinkSecurityEnabled()),
(aError == kErrorNone) ? "" : ", error:", (aError == kErrorNone) ? "" : ErrorToString(aError),
MessagePriorityToString(aMessage), shouldLogRss ? ", rss:" : "",
shouldLogRss ? aMessage.GetRssAverager().ToString().AsCString() : "", shouldLogRadio ? ", radio:" : "",
radioString);
LogAt(aLogLevel, "%s", string.AsCString());
if (aAction != kMessagePrepareIndirect)
{
@@ -1947,6 +1937,51 @@ exit:
return;
}
void MeshForwarder::AppendMacAddrToLogString(StringWriter &aString,
MessageAction aAction,
const Mac::Address *aMacAddress)
{
VerifyOrExit(aMacAddress != nullptr);
if (aAction == kMessageReceive)
{
aString.Append("from:");
}
else
{
aString.Append("to:");
}
aString.Append("%s, ", aMacAddress->ToString().AsCString());
exit:
return;
}
void MeshForwarder::AppendSecErrorPrioRssRadioLabelsToLogString(StringWriter &aString,
MessageAction aAction,
const Message &aMessage,
Error aError)
{
aString.Append("sec:%s, ", ToYesNo(aMessage.IsLinkSecurityEnabled()));
if (aError != kErrorNone)
{
aString.Append("error:%s, ", ErrorToString(aError));
}
aString.Append("prio:%s", MessagePriorityToString(aMessage));
if ((aAction == kMessageReceive) || (aAction == kMessageReassemblyDrop))
{
aString.Append(", rss:%s", aMessage.GetRssAverager().ToString().AsCString());
}
#if OPENTHREAD_CONFIG_MULTI_RADIO
aString.Append(", radio:%s", aMessage.IsRadioTypeSet() ? RadioTypeToString(aMessage.GetRadioType()) : "all");
#endif
}
void MeshForwarder::LogMessage(MessageAction aAction, const Message &aMessage)
{
LogMessage(aAction, aMessage, kErrorNone);
src/core/thread/mesh_forwarder.hpp
+8
View File
@@ -637,6 +637,9 @@ private:
const Mac::Address *aAddress,
Error aError,
LogLevel aLogLevel);
#endif
#if OPENTHREAD_CONFIG_LOG_SRC_DST_IP_ADDRESSES
void LogIp6AddressAndPort(const char *aLabel, const Ip6::Address &aAddress, uint16_t aPort, LogLevel aLogLevel);
#endif
void LogIp6SourceDestAddresses(const Ip6::Headers &aHeaders, LogLevel aLogLevel);
void LogIp6Message(MessageAction aAction,
@@ -644,6 +647,11 @@ private:
const Mac::Address *aAddress,
Error aError,
LogLevel aLogLevel);
void AppendSecErrorPrioRssRadioLabelsToLogString(StringWriter &aString,
MessageAction aAction,
const Message &aMessage,
Error aError);
void AppendMacAddrToLogString(StringWriter &aString, MessageAction aAction, const Mac::Address *aMacAddress);
#endif // #if OT_SHOULD_LOG_AT(OT_LOG_LEVEL_NOTE)
using TxTask = TaskletIn<MeshForwarder, &MeshForwarder::ScheduleTransmissionTask>;
src/core/thread/mesh_forwarder_ftd.cpp
+15 -23
View File
@@ -874,14 +874,12 @@ Error MeshForwarder::LogMeshFragmentHeader(MessageAction aAction,
Mac::Addresses &aMeshAddrs,
LogLevel aLogLevel)
{
Error error = kErrorFailed;
bool hasFragmentHeader = false;
bool shouldLogRss;
Lowpan::MeshHeader meshHeader;
Lowpan::FragmentHeader fragmentHeader;
uint16_t headerLength;
bool shouldLogRadio = false;
const char *radioString = "";
Error error = kErrorFailed;
bool hasFragmentHeader = false;
Lowpan::MeshHeader meshHeader;
Lowpan::FragmentHeader fragmentHeader;
uint16_t headerLength;
String<kMaxLogStringSize> string;
SuccessOrExit(meshHeader.ParseFrom(aMessage, headerLength));
@@ -896,23 +894,17 @@ Error MeshForwarder::LogMeshFragmentHeader(MessageAction aAction,
aOffset += headerLength;
}
shouldLogRss = (aAction == kMessageReceive) || (aAction == kMessageReassemblyDrop);
string.Append("%s mesh frame, len:%u, ", MessageActionToString(aAction, aError), aMessage.GetLength());
#if OPENTHREAD_CONFIG_MULTI_RADIO
shouldLogRadio = true;
radioString = aMessage.IsRadioTypeSet() ? RadioTypeToString(aMessage.GetRadioType()) : "all";
#endif
AppendMacAddrToLogString(string, aAction, aMacAddress);
LogAt(aLogLevel, "%s mesh frame, len:%d%s%s, msrc:%s, mdst:%s, hops:%d, frag:%s, sec:%s%s%s%s%s%s%s",
MessageActionToString(aAction, aError), aMessage.GetLength(),
(aMacAddress == nullptr) ? "" : ((aAction == kMessageReceive) ? ", from:" : ", to:"),
(aMacAddress == nullptr) ? "" : aMacAddress->ToString().AsCString(),
aMeshAddrs.mSource.ToString().AsCString(), aMeshAddrs.mDestination.ToString().AsCString(),
meshHeader.GetHopsLeft() + ((aAction == kMessageReceive) ? 1 : 0), ToYesNo(hasFragmentHeader),
ToYesNo(aMessage.IsLinkSecurityEnabled()),
(aError == kErrorNone) ? "" : ", error:", (aError == kErrorNone) ? "" : ErrorToString(aError),
shouldLogRss ? ", rss:" : "", shouldLogRss ? aMessage.GetRssAverager().ToString().AsCString() : "",
shouldLogRadio ? ", radio:" : "", radioString);
string.Append("msrc:%s, mdst:%s, hops:%d, frag:%s, ", aMeshAddrs.mSource.ToString().AsCString(),
aMeshAddrs.mDestination.ToString().AsCString(),
meshHeader.GetHopsLeft() + ((aAction == kMessageReceive) ? 1 : 0), ToYesNo(hasFragmentHeader));
AppendSecErrorPrioRssRadioLabelsToLogString(string, aAction, aMessage, aError);
LogAt(aLogLevel, "%s", string.AsCString());
if (hasFragmentHeader)
{