esp32_diagnostic_trace: Review changes

Author: pimpalemahesh

src/tracing/esp32_diagnostic_trace/DiagnosticInterface.h

@@ -0,0 +1,68 @@
+/*
+ *
+ *    Copyright (c) 2024 Project CHIP Authors
+ *    All rights reserved.
+ *
+ *    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.
+ */
+
+#pragma once
+
+#include <lib/core/CHIPError.h>
+#include <lib/core/TLVCircularBuffer.h>
+#include <lib/support/Span.h>
+
+namespace chip {
+namespace Tracing {
+namespace Diagnostics {
+
+class DiagnosticEntry
+{
+public:
+    virtual ~DiagnosticEntry()                                       = default;
+    virtual CHIP_ERROR Encode(chip::TLV::CircularTLVWriter & writer) = 0;
+};
+
+/**
+ * @brief Interface for storing and retrieving diagnostic data.
+ */
+class DiagnosticStorageInterface
+{
+public:
+    /**
+     * @brief Virtual destructor for the interface.
+     */
+    virtual ~DiagnosticStorageInterface() = default;
+
+    /**
+     * @brief Stores a diagnostic entry.
+     * @param diagnostic  Reference to a DiagnosticEntry object containing the
+     *                    diagnostic data to store.
+     * @return CHIP_ERROR Returns CHIP_NO_ERROR on success, or an appropriate error code on failure.
+     */
+    virtual CHIP_ERROR Store(DiagnosticEntry & diagnostic) = 0;
+
+    /**
+     * @brief Retrieves diagnostic data as a payload.
+     * @param payload  Reference to a MutableByteSpan where the retrieved
+     *                 diagnostic data will be stored.
+     * @return CHIP_ERROR Returns CHIP_NO_ERROR on success, or an appropriate error code on failure.
+     */
+    virtual CHIP_ERROR Retrieve(MutableByteSpan & payload) = 0;
+};
+
+} // namespace Diagnostics
+
+} // namespace Tracing
+
+} // namespace chip

src/tracing/esp32_diagnostic_trace/DiagnosticStorageManager.cpp

@@ -21,6 +21,8 @@
 #include <lib/support/logging/CHIPLogging.h>
 #include <tracing/esp32_diagnostic_trace/DiagnosticStorageManager.h>
 
+#define TLV_CLOSING_BYTES 4
+
 namespace chip {
 namespace Tracing {
 using namespace chip::TLV;
@@ -105,7 +107,7 @@ CHIP_ERROR DiagnosticStorageImpl::Retrieve(MutableByteSpan & payload)
                 (reader.GetTag() == ContextTag(DIAGNOSTICS_TAG::METRIC) || reader.GetTag() == ContextTag(DIAGNOSTICS_TAG::TRACE) ||
                  reader.GetTag() == ContextTag(DIAGNOSTICS_TAG::COUNTER)))
             {
-                if ((reader.GetLengthRead() - writer.GetLengthWritten()) < writer.GetRemainingFreeLength())
+                if ((reader.GetLengthRead() - writer.GetLengthWritten()) < (writer.GetRemainingFreeLength() + TLV_CLOSING_BYTES))
                 {
                     err = writer.CopyElement(reader);
                     if (err == CHIP_ERROR_BUFFER_TOO_SMALL)

src/tracing/esp32_diagnostic_trace/Diagnostics.h

@@ -17,10 +17,7 @@
  */
 
 #pragma once
-
-#include <lib/core/CHIPError.h>
-#include <lib/core/TLVCircularBuffer.h>
-#include <lib/support/Span.h>
+#include <tracing/esp32_diagnostic_trace/DiagnosticInterface.h>
 
 namespace chip {
 namespace Tracing {
@@ -38,13 +35,6 @@ enum class DIAGNOSTICS_TAG
     TIMESTAMP = 6
 };
 
-class DiagnosticEntry
-{
-public:
-    virtual ~DiagnosticEntry()                                       = default;
-    virtual CHIP_ERROR Encode(chip::TLV::CircularTLVWriter & writer) = 0;
-};
-
 template <typename T>
 class Metric : public DiagnosticEntry
 {
@@ -188,34 +178,6 @@ class Counter : public DiagnosticEntry
     uint32_t timestamp_;
 };
 
-/**
- * @brief Interface for storing and retrieving diagnostic data.
- */
-class DiagnosticStorageInterface
-{
-public:
-    /**
-     * @brief Virtual destructor for the interface.
-     */
-    virtual ~DiagnosticStorageInterface() = default;
-
-    /**
-     * @brief Stores a diagnostic entry.
-     * @param diagnostic  Reference to a DiagnosticEntry object containing the
-     *                    diagnostic data to store.
-     * @return CHIP_ERROR Returns CHIP_NO_ERROR on success, or an appropriate error code on failure.
-     */
-    virtual CHIP_ERROR Store(DiagnosticEntry & diagnostic) = 0;
-
-    /**
-     * @brief Retrieves diagnostic data as a payload.
-     * @param payload  Reference to a MutableByteSpan where the retrieved
-     *                 diagnostic data will be stored.
-     * @return CHIP_ERROR Returns CHIP_NO_ERROR on success, or an appropriate error code on failure.
-     */
-    virtual CHIP_ERROR Retrieve(MutableByteSpan & payload) = 0;
-};
-
 } // namespace Diagnostics
 } // namespace Tracing
 } // namespace chip