Split apart text-only logging and binary logging. (#29661)

Text-only logging does not depend on Span, but binary logging (LogByteSpan) does. And Span.h depends on text-only logging. We were manually breaking the cycle caused by having both logging types in CHIPLogging.h by not including Span.h from CHIPLogging.h and forward-declaring Span instead. This fixes things so that we have a TextOnlyLogging.h (which is used by Span.h, via CodeUtils.h, and does not use Span at all), and a BinaryLogging.h which uses Span and includes Span.h.
project-chip · Feb 28, 2024 · 3328387 · 3328387
1 parent d883a38
commit 3328387
Show file tree

Hide file tree

Showing 10 changed files with 583 additions and 486 deletions.
diff --git a/examples/common/pigweed/RpcService.cpp b/examples/common/pigweed/RpcService.cpp
@@ -30,7 +30,7 @@
 #include "pw_stream/sys_io_stream.h"
 #include "pw_sys_io/sys_io.h"
 
-#include <lib/support/logging/CHIPLogging.h>
+#include <lib/support/logging/TextOnlyLogging.h>
 
 #include <array>
 

diff --git a/examples/platform/ameba/PigweedLogger.cpp b/examples/platform/ameba/PigweedLogger.cpp
@@ -18,7 +18,7 @@
 #include "FreeRTOS.h"
 #include "pw_sys_io_ameba/init.h"
 #include "semphr.h"
-#include <lib/support/logging/CHIPLogging.h>
+#include <lib/support/logging/TextOnlyLogging.h>
 #include <pw_hdlc/encoder.h>
 #include <pw_stream/sys_io_stream.h>
 

diff --git a/examples/platform/silabs/SilabsDeviceAttestationCreds.cpp b/examples/platform/silabs/SilabsDeviceAttestationCreds.cpp
@@ -20,6 +20,7 @@
 #include <lib/core/CHIPError.h>
 #include <lib/support/CodeUtils.h>
 #include <lib/support/Span.h>
+#include <lib/support/logging/CHIPLogging.h>
 #include <platform/silabs/SilabsConfig.h>
 #include <psa/crypto.h>
 

diff --git a/src/lib/support/BUILD.gn b/src/lib/support/BUILD.gn
@@ -140,8 +140,11 @@ static_library("support") {
     "Variant.h",
     "ZclString.cpp",
     "ZclString.h",
-    "logging/CHIPLogging.cpp",
+    "logging/BinaryLogging.cpp",
+    "logging/BinaryLogging.h",
     "logging/CHIPLogging.h",
+    "logging/TextOnlyLogging.cpp",
+    "logging/TextOnlyLogging.h",
     "verhoeff/Verhoeff.cpp",
     "verhoeff/Verhoeff.h",
     "verhoeff/Verhoeff10.cpp",

diff --git a/src/lib/support/CodeUtils.h b/src/lib/support/CodeUtils.h
@@ -29,7 +29,7 @@
 #include <lib/core/CHIPConfig.h>
 #include <lib/core/CHIPError.h>
 #include <lib/core/ErrorStr.h>
-#include <lib/support/logging/CHIPLogging.h>
+#include <lib/support/logging/TextOnlyLogging.h>
 
 /**
  * Base-level abnormal termination.

diff --git a/src/lib/support/logging/BinaryLogging.cpp b/src/lib/support/logging/BinaryLogging.cpp
@@ -0,0 +1,59 @@
+/*
+ *    Copyright (c) 2020-2023 Project CHIP Authors
+ *    Copyright (c) 2013-2017 Nest Labs, Inc.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#include "BinaryLogging.h"
+
+namespace chip {
+namespace Logging {
+
+#if _CHIP_USE_LOGGING
+
+void LogByteSpan(uint8_t module, uint8_t category, const ByteSpan & span)
+{
+    // Maximum number of characters needed to print 8 byte buffer including formatting (0x)
+    // 8 bytes * (2 nibbles per byte + 4 character for ", 0x") + null termination.
+    // Rounding up to 50 bytes.
+    char output[50];
+    size_t offset = 0;
+    for (unsigned int i = 0; i < span.size(); i++)
+    {
+        if (i % 8 == 0 && offset != 0)
+        {
+            Log(module, category, "%s", output);
+            offset = 0;
+        }
+        int result = snprintf(&output[offset], sizeof(output) - offset, "0x%02x, ", (unsigned char) span.data()[i]);
+        if (result > 0)
+        {
+            offset += static_cast<size_t>(result);
+        }
+        else
+        {
+            Log(module, Logging::kLogCategory_Error, "Failed to print ByteSpan buffer");
+            return;
+        }
+    }
+    if (offset != 0)
+    {
+        Log(module, category, "%s", output);
+    }
+}
+
+#endif // _CHIP_USE_LOGGING
+
+} // namespace Logging
+} // namespace chip
diff --git a/src/lib/support/logging/BinaryLogging.h b/src/lib/support/logging/BinaryLogging.h
@@ -0,0 +1,79 @@
+/*
+ *    Copyright (c) 2020-2023 Project CHIP Authors
+ *    Copyright (c) 2013-2017 Nest Labs, Inc.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+/**
+ *    @file
+ *      This file defines macros, constants, and interfaces for logging binary
+ *      data (represented by ByteSpan).
+ */
+
+#pragma once
+
+#include <lib/core/CHIPConfig.h>
+
+#include <lib/support/Span.h>
+#include <lib/support/logging/TextOnlyLogging.h>
+
+namespace chip {
+namespace Logging {
+
+#if CHIP_DETAIL_LOGGING
+
+/**
+ * @def ChipLogByteSpan(MOD, DATA)
+ *
+ * @brief
+ *   Log a byte span for the specified module in the 'Detail' category.
+ *
+ */
+#define ChipLogByteSpan(MOD, DATA) ChipInternalLogByteSpan(MOD, DETAIL, DATA)
+
+#else // CHIP_DETAIL_LOGGING
+#define ChipLogByteSpan(MOD, DATA) ((void) 0)
+#endif // CHIP_DETAIL_LOGGING
+
+// _CHIP_USE_LOGGING is defined in TextOnlyLogging.h
+#if _CHIP_USE_LOGGING
+
+void LogByteSpan(uint8_t module, uint8_t category, const ByteSpan & span);
+
+#if CHIP_SYSTEM_CONFIG_PLATFORM_LOG
+#ifndef ChipPlatformLogByteSpan
+#error "CHIP_SYSTEM_CONFIG_PLATFORM_LOG is enabled but ChipPlatformLogByteSpan() is not defined"
+#endif
+#define ChipInternalLogByteSpan(...) ChipPlatformLogByteSpan(__VA_ARGS__)
+#else // CHIP_SYSTEM_CONFIG_PLATFORM_LOG
+#define ChipInternalLogByteSpan(MOD, CAT, DATA)                                                                                    \
+    if (CHIP_CONFIG_LOG_MODULE_##MOD && IsModuleCategoryEnabled(MOD, CAT))                                                         \
+    {                                                                                                                              \
+        ChipInternalLogByteSpanImpl(MOD, CHIP_LOG_CATEGORY_##CAT, DATA);                                                           \
+    }
+#endif // CHIP_SYSTEM_CONFIG_PLATFORM_LOG
+
+#define ChipInternalLogByteSpanImpl(MOD, CAT, DATA)                                                                                \
+    do                                                                                                                             \
+    {                                                                                                                              \
+        if (chip::Logging::IsCategoryEnabled(CAT))                                                                                 \
+        {                                                                                                                          \
+            chip::Logging::LogByteSpan(chip::Logging::kLogModule_##MOD, CAT, DATA);                                                \
+        }                                                                                                                          \
+    } while (0)
+
+#endif // _CHIP_USE_LOGGING
+
+} // namespace Logging
+} // namespace chip