Define FrameTimingSequence (facebook#54674)

Summary:
Pull Request resolved: facebook#54674

# Changelog: [Internal]

This diff introduces a definition for `FrameTimingSequence`, which will represent the different phases of a frame that will be reported as part of the trace.

These sequences will be stored on a `HostTargetTraceRecording`. It is `Host`'s responsibility to propagate these entities to `HostTarget`, there will be a corresponding method for this.

Reviewed By: sbuggay

Differential Revision: D87373811

fbshipit-source-id: bd894f8c39a6d4ee0bef1303e4f801b27fabc901

Author: hoxyq

packages/react-native/ReactCommon/jsinspector-modern/HostTargetTraceRecording.cpp

@@ -20,7 +20,15 @@ HostTargetTraceRecording::HostTargetTraceRecording(
     : hostTarget_(hostTarget),
       tracingMode_(tracingMode),
       enabledCategories_(std::move(enabledCategories)),
-      windowSize_(windowSize) {}
+      windowSize_(windowSize) {
+  if (windowSize) {
+    frameTimings_ = tracing::TimeWindowedBuffer<tracing::FrameTimingSequence>(
+        [](auto& sequence) { return sequence.beginDrawingTimestamp; },
+        *windowSize);
+  } else {
+    frameTimings_ = tracing::TimeWindowedBuffer<tracing::FrameTimingSequence>();
+  };
+}
 
 void HostTargetTraceRecording::setTracedInstance(
     InstanceTarget* instanceTarget) {
@@ -60,9 +68,19 @@ tracing::HostTracingProfile HostTargetTraceRecording::stop() {
   return tracing::HostTracingProfile{
       .processId = oscompat::getCurrentProcessId(),
       .startTime = startTime,
+      .frameTimings = frameTimings_.pruneExpiredAndExtract(),
       .instanceTracingProfiles = std::move(state.instanceTracingProfiles),
       .runtimeSamplingProfiles = std::move(state.runtimeSamplingProfiles),
   };
 }
 
+void HostTargetTraceRecording::recordFrameTimings(
+    tracing::FrameTimingSequence frameTimingSequence) {
+  assert(
+      state_.has_value() &&
+      "The state for this tracing session has not been initialized.");
+
+  frameTimings_.push(frameTimingSequence);
+}
+
 } // namespace facebook::react::jsinspector_modern

packages/react-native/ReactCommon/jsinspector-modern/HostTargetTraceRecording.h

@@ -11,7 +11,9 @@
 #include "HostTarget.h"
 #include "InstanceTarget.h"
 
+#include <jsinspector-modern/tracing/FrameTimingSequence.h>
 #include <jsinspector-modern/tracing/HostTracingProfile.h>
+#include <jsinspector-modern/tracing/TimeWindowedBuffer.h>
 #include <jsinspector-modern/tracing/TraceRecordingState.h>
 #include <jsinspector-modern/tracing/TracingCategory.h>
 #include <react/timing/primitives.h>
@@ -67,6 +69,13 @@ class HostTargetTraceRecording {
    */
   tracing::HostTracingProfile stop();
 
+  /**
+   * Adds the frame timing sequence to the current state of this trace recording.
+   *
+   * The caller guarantees the protection from data races. This is protected by the tracing mutex in HostTarget.
+   */
+  void recordFrameTimings(tracing::FrameTimingSequence frameTimingSequence);
+
  private:
   /**
    * The Host for which this Trace Recording is going to happen.
@@ -104,6 +113,11 @@ class HostTargetTraceRecording {
    * The size of the time window for this recording.
    */
   std::optional<HighResDuration> windowSize_;
+
+  /**
+   * Frame timings captured on the Host side.
+   */
+  tracing::TimeWindowedBuffer<tracing::FrameTimingSequence> frameTimings_;
 };
 
 } // namespace facebook::react::jsinspector_modern

packages/react-native/ReactCommon/jsinspector-modern/tracing/FrameTimingSequence.h

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include "TraceEvent.h"
+
+#include <react/timing/primitives.h>
+
+namespace facebook::react::jsinspector_modern::tracing {
+
+/**
+ * A struct representing a sequence of frame timings that happened on the Host side.
+ */
+struct FrameTimingSequence {
+  FrameTimingSequence() = delete;
+
+  FrameTimingSequence(
+      uint64_t id,
+      ThreadId threadId,
+      HighResTimeStamp beginDrawingTimestamp,
+      HighResTimeStamp commitTimestamp,
+      HighResTimeStamp endDrawingTimestamp)
+      : id(id),
+        threadId(threadId),
+        beginDrawingTimestamp(beginDrawingTimestamp),
+        commitTimestamp(commitTimestamp),
+        endDrawingTimestamp(endDrawingTimestamp)
+  {
+  }
+
+  /**
+   * Unique ID of the sequence, used by Chrome DevTools Frontend to identify the events that form one sequence.
+   */
+  uint64_t id;
+
+  /**
+   * The ID of the native thread that is associated with the frame.
+   */
+  ThreadId threadId;
+
+  HighResTimeStamp beginDrawingTimestamp;
+  HighResTimeStamp commitTimestamp;
+  HighResTimeStamp endDrawingTimestamp;
+};
+
+} // namespace facebook::react::jsinspector_modern::tracing

packages/react-native/ReactCommon/jsinspector-modern/tracing/HostTracingProfile.h

@@ -7,6 +7,7 @@
 
 #pragma once
 
+#include "FrameTimingSequence.h"
 #include "InstanceTracingProfile.h"
 #include "RuntimeSamplingProfile.h"
 
@@ -29,6 +30,9 @@ struct HostTracingProfile {
   // The timestamp at which this Trace Recording started.
   HighResTimeStamp startTime;
 
+  // Frame timings captured on the Host side.
+  std::vector<FrameTimingSequence> frameTimings;
+
   // All captured Instance Tracing Profiles during this Trace Recording.
   std::vector<InstanceTracingProfile> instanceTracingProfiles;