commit 8a76d89dee8517e445155a1725a050e228f4eaef
author Jeremy Kerr <jk@codeconstruct.com.au> Fri Jul 26 17:19:57 2024 +0800
committer Jeremy Kerr <jk@codeconstruct.com.au> Mon Feb 24 11:09:44 2025 +0000
tree 411f2f4bfba62d9ea59fcbfe80511ca0f8d42253
parent 8d9af0236b3cbe89a25e4b239a9075135c8a54a0

ncsi: log interface types using to_string

Add a to_string() method for Interfaces, to handle printing via lg2.

Since we're printing the interface object, don't specify _INDEX on the
metadata, this may not always be an index.

Also, interface indices are typically referred to as decimal. Use
decimal instead of a lg2::hex conversion.

Change-Id: I90b5fbac52adde3bbc3f2699087373ed96361083
Signed-off-by: Jeremy Kerr <jk@codeconstruct.com.au>

src/ncsi_util.cpp

diff --git a/src/ncsi_util.cpp b/src/ncsi_util.cpp
index 8539b5c..3eb73ad 100644
--- a/src/ncsi_util.cpp
+++ b/src/ncsi_util.cpp
@@ -339,7 +339,7 @@
     {
         lg2::error("Failed to set the attribute , RC : {RC} INTERFACE : "
                    "{INTERFACE}",
-                   "RC", ret, "INTERFACE", lg2::hex, interface.ifindex);
+                   "RC", ret, "INTERFACE", interface);
         return ret;
     }
 
@@ -420,13 +420,18 @@
 
 } // namespace internal
 
+std::string to_string(Interface& interface)
+{
+    return std::to_string(interface.ifindex);
+}
+
 int sendOemCommand(Interface& interface, int package, int channel,
                    int operation, std::span<const unsigned char> payload)
 {
     lg2::debug("Send OEM Command, CHANNEL : {CHANNEL} , PACKAGE : {PACKAGE}, "
-               "INTERFACE_INDEX: {INTERFACE_INDEX}",
+               "INTERFACE: {INTERFACE}",
                "CHANNEL", lg2::hex, channel, "PACKAGE", lg2::hex, package,
-               "INTERFACE_INDEX", lg2::hex, interface.ifindex);
+               "INTERFACE", interface);
     if (!payload.empty())
     {
         lg2::debug("Payload: {PAYLOAD}", "PAYLOAD", toHexStr(payload));
@@ -441,11 +446,10 @@
 
 int setChannel(Interface& interface, int package, int channel)
 {
-    lg2::debug(
-        "Set CHANNEL : {CHANNEL} , PACKAGE : {PACKAGE}, INTERFACE_INDEX: "
-        "{INTERFACE_INDEX}",
-        "CHANNEL", lg2::hex, channel, "PACKAGE", lg2::hex, package,
-        "INTERFACE_INDEX", lg2::hex, interface.ifindex);
+    lg2::debug("Set CHANNEL : {CHANNEL} , PACKAGE : {PACKAGE}, INTERFACE : "
+               "{INTERFACE}",
+               "CHANNEL", lg2::hex, channel, "PACKAGE", lg2::hex, package,
+               "INTERFACE", interface);
     return internal::applyCmd(
         interface, internal::Command(ncsi_nl_commands::NCSI_CMD_SET_INTERFACE),
         package, channel);
@@ -453,8 +457,8 @@
 
 int clearInterface(Interface& interface)
 {
-    lg2::debug("ClearInterface , INTERFACE_INDEX : {INTERFACE_INDEX}",
-               "INTERFACE_INDEX", lg2::hex, interface.ifindex);
+    lg2::debug("ClearInterface , INTERFACE : {INTERFACE}", "INTERFACE",
+               interface);
     return internal::applyCmd(
         interface,
         internal::Command(ncsi_nl_commands::NCSI_CMD_CLEAR_INTERFACE));
@@ -462,10 +466,8 @@
 
 int getInfo(Interface& interface, int package)
 {
-    lg2::debug(
-        "Get Info , PACKAGE : {PACKAGE}, INTERFACE_INDEX: {INTERFACE_INDEX}",
-        "PACKAGE", lg2::hex, package, "INTERFACE_INDEX", lg2::hex,
-        interface.ifindex);
+    lg2::debug("Get Info , PACKAGE : {PACKAGE}, INTERFACE: {INTERFACE}",
+               "PACKAGE", lg2::hex, package, "INTERFACE", interface);
     if (package == DEFAULT_VALUE)
     {
         return internal::applyCmd(
@@ -482,9 +484,8 @@
 
 int setPackageMask(Interface& interface, unsigned int mask)
 {
-    lg2::debug(
-        "Set Package Mask , INTERFACE_INDEX: {INTERFACE_INDEX} MASK: {MASK}",
-        "INTERFACE_INDEX", lg2::hex, interface.ifindex, "MASK", lg2::hex, mask);
+    lg2::debug("Set Package Mask , INTERFACE: {INTERFACE} MASK: {MASK}",
+               "INTERFACE", interface, "MASK", lg2::hex, mask);
     auto payload = std::span<const unsigned char>(
         reinterpret_cast<const unsigned char*>(&mask),
         reinterpret_cast<const unsigned char*>(&mask) + sizeof(decltype(mask)));
@@ -497,9 +498,9 @@
 int setChannelMask(Interface& interface, int package, unsigned int mask)
 {
     lg2::debug(
-        "Set Channel Mask , INTERFACE_INDEX: {INTERFACE_INDEX}, PACKAGE : {PACKAGE} MASK: {MASK}",
-        "INTERFACE_INDEX", lg2::hex, interface.ifindex, "PACKAGE", lg2::hex,
-        package, "MASK", lg2::hex, mask);
+        "Set Channel Mask , INTERFACE: {INTERFACE}, PACKAGE : {PACKAGE} MASK: {MASK}",
+        "INTERFACE", interface, "PACKAGE", lg2::hex, package, "MASK", lg2::hex,
+        mask);
     auto payload = std::span<const unsigned char>(
         reinterpret_cast<const unsigned char*>(&mask),
         reinterpret_cast<const unsigned char*>(&mask) + sizeof(decltype(mask)));