Start profiling deligate

Author: zhongmingyuan

devtools/etdump/etdump_flatcc.cpp

@@ -230,11 +230,12 @@ EventTracerEntry ETDumpGen::start_profiling(
 
 // TODO: Update all occurrences of the ProfileEvent calls once the
 // EventTracerEntry struct is updated.
-EventTracerEntry ETDumpGen::start_profiling_delegate(
+Result<EventTracerEntry> ETDumpGen::start_profiling_delegate(
     const char* name,
     DelegateDebugIntId delegate_debug_index) {
-  ET_CHECK_MSG(
+  ET_CHECK_OR_RETURN_ERROR(
       (name == nullptr) ^ (delegate_debug_index == kUnsetDelegateDebugIntId),
+      InvalidArgument,
       "Only name or delegate_debug_index can be valid. Check DelegateMappingBuilder documentation for more details.");
   check_ready_to_add_events();
   EventTracerEntry prof_entry;
@@ -247,7 +248,7 @@ EventTracerEntry ETDumpGen::start_profiling_delegate(
       ? create_string_entry(name)
       : delegate_debug_index;
   prof_entry.start_time = et_pal_current_ticks();
-  return prof_entry;
+  return Result<EventTracerEntry>(prof_entry);
 }
 
 void ETDumpGen::end_profiling_delegate(

devtools/etdump/etdump_flatcc.h

@@ -83,7 +83,7 @@ class ETDumpGen : public ::executorch::runtime::EventTracer {
       ::executorch::runtime::DebugHandle debug_handle = 0) override;
   virtual void end_profiling(
       ::executorch::runtime::EventTracerEntry prof_entry) override;
-  virtual ::executorch::runtime::EventTracerEntry start_profiling_delegate(
+  virtual Result<::executorch::runtime::EventTracerEntry> start_profiling_delegate(
       const char* name,
       DelegateDebugIntId delegate_debug_index) override;
   virtual void end_profiling_delegate(

devtools/etdump/tests/etdump_test.cpp

@@ -821,7 +821,7 @@ TEST_F(ProfilerETDumpTest, LogDelegateEvents) {
     etdump_gen[i]->log_profiling_delegate(
         nullptr, 278, 1, 2, metadata, strlen(metadata) + 1);
     EventTracerEntry entry = etdump_gen[i]->start_profiling_delegate(
-        "test_event", kUnsetDelegateDebugIntId);
+        "test_event", kUnsetDelegateDebugIntId).get();
     EXPECT_NE(entry.delegate_event_id_type, DelegateDebugIdType::kNone);
     // Event 2
     etdump_gen[i]->end_profiling_delegate(

docs/source/delegate-debugging.md

@@ -89,7 +89,7 @@ To log events in real-time (for example, explicitly denoting the profiling start
 To start an `EventTracerEntry` using `event_tracer_start_profiling_delegate`, the **Delegate Debug Identifier** (provided AOT to the `debug_handle_map`) is passed as either the name or `delegate_debug_id` argument depending on the **Delegate Debug Identifier** type (str and int respectively)
 
 ```c++
-EventTracerEntry event_tracer_start_profiling_delegate(
+Result<EventTracerEntry> event_tracer_start_profiling_delegate(
     EventTracer* event_tracer,
     const char* name,
     DebugHandle delegate_debug_id)

runtime/core/event_tracer.h

@@ -217,7 +217,7 @@ class EventTracer {
    * based names are used by this delegate to identify ops executed in the
    * backend then kUnsetDebugHandle should be passed in here.
    */
-  virtual EventTracerEntry start_profiling_delegate(
+  virtual Result<EventTracerEntry> start_profiling_delegate(
       const char* name,
       DelegateDebugIntId delegate_debug_index) = 0;
 

runtime/core/event_tracer_hooks_delegate.h

@@ -46,8 +46,9 @@ namespace runtime {
  * @param[in] delegate_debug_id The id of the delegate event. If string
  * based names are used by this delegate to identify ops executed in the
  * backend then kUnsetDebugHandle should be passed in here.
+
  */
-inline EventTracerEntry event_tracer_start_profiling_delegate(
+inline Result<EventTracerEntry> event_tracer_start_profiling_delegate(
     EventTracer* event_tracer,
     const char* name,
     DebugHandle delegate_debug_id) {
@@ -60,7 +61,7 @@ inline EventTracerEntry event_tracer_start_profiling_delegate(
   (void)delegate_debug_id;
 #endif
   // There is no active tracer; this value will be ignored.
-  return EventTracerEntry();
+  return Result<EventTracerEntry>(EventTracerEntry());
 }
 
 /**

runtime/core/test/event_tracer_test.cpp

@@ -74,12 +74,12 @@ class DummyEventTracer : public EventTracer {
     return 0;
   }
 
-  EventTracerEntry start_profiling_delegate(
+  Result<EventTracerEntry> start_profiling_delegate(
       const char* name,
       DelegateDebugIntId delegate_debug_id) override {
     (void)name;
     (void)delegate_debug_id;
-    return EventTracerEntry();
+    return Result<EventTracerEntry>(EventTracerEntry());
   }
 
   void end_profiling_delegate(
@@ -236,7 +236,7 @@ TEST(TestEventTracer, SimpleEventTracerTest) {
  */
 void RunSimpleTracerTestDelegate(EventTracer* event_tracer) {
   EventTracerEntry event_tracer_entry = event_tracer_start_profiling_delegate(
-      event_tracer, "test_event", kUnsetDelegateDebugIntId);
+      event_tracer, "test_event", kUnsetDelegateDebugIntId).get();
   event_tracer_end_profiling_delegate(
       event_tracer, event_tracer_entry, nullptr);
   event_tracer_start_profiling_delegate(event_tracer, nullptr, 1);