introducing filter to etdumpgen

Summary: This diff introduce etdump filter to etdumpgen. Detail design can be found in Details can be found in #9260

Differential Revision: D72151631

Author: Gasoonjia

devtools/etdump/etdump_filter.h

@@ -77,8 +77,9 @@ class ETDumpFilter : public ::executorch::runtime::EventTracerFilterBase {
    *
    * @return A Result<bool> indicating whether the event matches the filter
    * criteria.
-   *         - True if the event matches the filter, or filter is unset.
-   *         - False if the event does not match or is unknown.
+   *         - True if the event matches the filter.
+   *         - False if the event does not match, or is unknown, or filter is
+   * unset.
    *         - An error code if an error occurs during filtering.
    */
   Result<bool> filter(

devtools/etdump/etdump_flatcc.cpp

@@ -369,6 +369,19 @@ Result<bool> ETDumpGen::log_intermediate_output_delegate_helper(
       InvalidArgument,
       "Only name or delegate_debug_index can be valid. Check DelegateMappingBuilder documentation for more details.");
 
+  if (filter_) {
+    Result<bool> result = filter_->filter(name, delegate_debug_index);
+    if (!result.ok()) {
+      return result;
+    }
+
+    // If the filter returns true, meaning this event should be filtered out and
+    // we should not log it.
+    if (result.get()) {
+      return false;
+    }
+  }
+
   check_ready_to_add_events();
   int64_t string_id = name != nullptr ? create_string_entry(name) : -1;
 
@@ -654,6 +667,11 @@ DataSinkBase* ETDumpGen::get_data_sink() {
   return data_sink_;
 }
 
+void ETDumpGen::set_delegation_intermediate_output_filter(
+    EventTracerFilterBase* filter) {
+  filter_ = filter;
+}
+
 long ETDumpGen::write_tensor_or_raise_error(Tensor tensor) {
   // Previously, the function copy_tensor_to_debug_buffer returned 0xFF..F when
   // given an empty tensor, which is an invalid offset for most buffers. In our

devtools/etdump/etdump_flatcc.h

@@ -25,6 +25,7 @@ namespace executorch {
 namespace etdump {
 
 using ::executorch::runtime::DelegateDebugIntId;
+using ::executorch::runtime::EventTracerFilterBase;
 using ::executorch::runtime::Result;
 
 namespace internal {
@@ -146,6 +147,13 @@ class ETDumpGen : public ::executorch::runtime::EventTracer {
       const char* name,
       DelegateDebugIntId delegate_debug_index,
       const double& output) override;
+
+  /**
+   * Set the filter of event tracer for delegation intermediate outputs.
+   */
+  virtual void set_delegation_intermediate_output_filter(
+      EventTracerFilterBase* event_tracer_filter) override;
+
   void set_debug_buffer(::executorch::runtime::Span<uint8_t> buffer);
   void set_data_sink(DataSinkBase* data_sink);
   ETDumpResult get_etdump_data();
@@ -188,6 +196,8 @@ class ETDumpGen : public ::executorch::runtime::EventTracer {
   int bundled_input_index_ = -1;
   State state_ = State::Init;
   struct internal::ETDumpStaticAllocator alloc_;
+
+  EventTracerFilterBase* filter_ = nullptr;
 };
 
 } // namespace etdump

devtools/etdump/tests/etdump_test.cpp

@@ -12,6 +12,7 @@
 
 #include <executorch/devtools/etdump/data_sinks/buffer_data_sink.h>
 #include <executorch/devtools/etdump/data_sinks/file_data_sink.h>
+#include <executorch/devtools/etdump/etdump_filter.h>
 #include <executorch/devtools/etdump/etdump_flatcc.h>
 #include <executorch/devtools/etdump/etdump_schema_flatcc_builder.h>
 #include <executorch/devtools/etdump/etdump_schema_flatcc_reader.h>
@@ -33,6 +34,7 @@ using ::executorch::runtime::AllocatorID;
 using ::executorch::runtime::ArrayRef;
 using ::executorch::runtime::BoxedEvalueList;
 using ::executorch::runtime::DelegateDebugIdType;
+using ::executorch::runtime::DelegateDebugIntId;
 using ::executorch::runtime::Error;
 using ::executorch::runtime::EValue;
 using ::executorch::runtime::EventTracerEntry;
@@ -45,6 +47,8 @@ using ::executorch::runtime::testing::TensorFactory;
 using ::executorch::etdump::BufferDataSink;
 using ::executorch::etdump::FileDataSink;
 
+using ::executorch::etdump::ETDumpFilter;
+
 class ProfilerETDumpTest : public ::testing::Test {
  protected:
   void SetUp() override {
@@ -75,6 +79,70 @@ class ProfilerETDumpTest : public ::testing::Test {
         "Must set data sink before writing tensor-like data");
   }
 
+  void check_log_with_filter(
+      const char* name,
+      DelegateDebugIntId delegate_debug_index,
+      bool use_tensor_input,
+      bool expected_log,
+      bool expected_ok) {
+    TensorFactory<ScalarType::Float> tf;
+    for (size_t i = 0; i < 2; i++) {
+      const size_t buffer_size = 2048;
+
+      void* ptr = malloc(buffer_size);
+      auto buffer_data_sink = BufferDataSink::create(ptr, buffer_size);
+      auto filter = ETDumpFilter();
+      filter.add_regex("filtered.*");
+      filter.set_debug_handle_range(1, 10);
+      etdump_gen[i]->set_delegation_intermediate_output_filter(&filter);
+
+      etdump_gen[i]->create_event_block("test_block");
+      etdump_gen[i]->set_data_sink(&buffer_data_sink.get());
+
+      // size of empty etdump
+      size_t initial_size = 68;
+
+      // Perform logging
+
+      if (use_tensor_input) {
+        auto tensor = tf.ones({3, 2});
+        auto result = etdump_gen[i]->log_intermediate_output_delegate(
+            name, delegate_debug_index, tensor);
+        ASSERT_EQ(result.ok(), expected_ok);
+        if (expected_ok) {
+          ASSERT_EQ(result.get(), expected_log);
+        }
+      } else { // use tensor_list instead
+        std::vector<Tensor> tensors = {tf.ones({5, 4}), tf.ones({7, 6})};
+        Result<bool> result = etdump_gen[i]->log_intermediate_output_delegate(
+            name,
+            delegate_debug_index,
+            ArrayRef<Tensor>(tensors.data(), tensors.size()));
+        ASSERT_EQ(result.ok(), expected_ok);
+        if (expected_ok) {
+          ASSERT_EQ(result.get(), expected_log);
+        }
+      }
+
+      // Get final size of etdump
+      ETDumpResult final_result = etdump_gen[i]->get_etdump_data();
+      size_t final_size = final_result.size;
+      // Check if the size of etdump has changed based on logging success
+      if (expected_log) {
+        ASSERT_NE(initial_size, final_size); // Expect size change if logged
+      } else {
+        ASSERT_EQ(
+            initial_size, final_size); // Expect no size change if not logged
+      }
+
+      if (!etdump_gen[i]->is_static_etdump()) {
+        free(final_result.buf);
+      }
+
+      free(ptr);
+    }
+  }
+
   ETDumpGen* etdump_gen[2];
   uint8_t* buf = nullptr;
   std::unique_ptr<TempFile> temp_file;
@@ -652,7 +720,7 @@ TEST_F(ProfilerETDumpTest, VerifyDelegateIntermediateLogging) {
 
       void* ptr = malloc(2048);
       Span<uint8_t> buffer((uint8_t*)ptr, 2048);
-      ;
+
       auto buffer_data_sink = BufferDataSink::create(ptr, 2048);
       auto file_data_sink = FileDataSink::create(dump_file_path.c_str());
 
@@ -892,3 +960,62 @@ TEST_F(ProfilerETDumpTest, WriteAfterGetETDumpData) {
     }
   }
 }
+
+TEST_F(ProfilerETDumpTest, LogWithRegexAndUnsetDelegateDebugIdOnTensor) {
+  check_log_with_filter(
+      "filtered_event",
+      kUnsetDelegateDebugIntId,
+      /*use_tensor_input=*/true,
+      /*expected_log=*/false,
+      /*expected_ok=*/true);
+}
+
+TEST_F(ProfilerETDumpTest, LogWithRegexAndUnsetDelegateDebugIdOnTensorList) {
+  check_log_with_filter(
+      "filtered_event",
+      kUnsetDelegateDebugIntId,
+      /*use_tensor_input=*/true,
+      /*expected_log=*/false,
+      /*expected_ok=*/true);
+}
+
+TEST_F(ProfilerETDumpTest, LogWithNullptrAndInRange) {
+  check_log_with_filter(
+      nullptr,
+      5,
+      /*use_tensor_input=*/true,
+      /*expected_log=*/false,
+      /*expected_ok=*/true);
+}
+TEST_F(ProfilerETDumpTest, LogWithNonMatchingRegexAndOutOfRange) {
+  check_log_with_filter(
+      "unfiltered_event",
+      kUnsetDelegateDebugIntId,
+      /*use_tensor_input=*/true,
+      /*expected_log=*/true,
+      /*expected_ok=*/true);
+}
+TEST_F(ProfilerETDumpTest, LogWithNullptrAndOutOfRange) {
+  check_log_with_filter(
+      nullptr,
+      20,
+      /*use_tensor_input=*/true,
+      /*expected_log=*/true,
+      /*expected_ok=*/true);
+}
+TEST_F(ProfilerETDumpTest, LogWithRegexAndInRange) {
+  check_log_with_filter(
+      "filtered_event",
+      5,
+      /*use_tensor_input=*/true,
+      /*expected_log=*/false,
+      /*expected_ok=*/false);
+}
+TEST_F(ProfilerETDumpTest, LogWithNullptrAndUnsetDebugHandle) {
+  check_log_with_filter(
+      nullptr,
+      kUnsetDelegateDebugIntId,
+      /*use_tensor_input=*/true,
+      /*expected_log=*/false,
+      /*expected_ok=*/false);
+}

devtools/etdump/tests/targets.bzl

@@ -19,6 +19,7 @@ def define_common_targets():
             "//executorch/extension/testing_util:temp_file",
             "//executorch/runtime/platform:platform",
             "//executorch/runtime/core/exec_aten/testing_util:tensor_util",
+            "//executorch/devtools/etdump:etdump_filter",
         ],
     )
 

runtime/core/event_tracer.h

@@ -439,6 +439,12 @@ class EventTracer {
       DelegateDebugIntId delegate_debug_index,
       const double& output) = 0;
 
+  /**
+   * Set the filter of event tracer for delegation intermediate outputs.
+   */
+  virtual void set_delegation_intermediate_output_filter(
+      EventTracerFilterBase* event_tracer_filter) = 0;
+
   /**
    * Helper function to set the chain id ands debug handle. Users have two
    * options, the first is that they can directly pass in the chain id and debug
@@ -513,12 +519,6 @@ class EventTracer {
     event_tracer_profiling_level_ = profiling_level;
   }
 
-  /**
-   * Set the filter of event tracer for delegation intermediate outputs.
-   */
-  void set_delegation_intermediate_output_filter(
-      EventTracerFilterBase* event_tracer_filter);
-
   /**
    * Return the current level of event tracer profiling.
    */

runtime/core/test/event_tracer_test.cpp

@@ -28,6 +28,7 @@ using executorch::runtime::EValue;
 using executorch::runtime::EventTracer;
 using executorch::runtime::EventTracerDebugLogLevel;
 using executorch::runtime::EventTracerEntry;
+using executorch::runtime::EventTracerFilterBase;
 using executorch::runtime::kUnsetChainId;
 using executorch::runtime::kUnsetDebugHandle;
 using executorch::runtime::kUnsetDelegateDebugIntId;
@@ -90,6 +91,11 @@ class DummyEventTracer : public EventTracer {
     (void)metadata_len;
   }
 
+  void set_delegation_intermediate_output_filter(
+      EventTracerFilterBase* event_tracer_filter) override {
+    (void)event_tracer_filter;
+  }
+
   void log_profiling_delegate(
       const char* name,
       DelegateDebugIntId delegate_debug_id,