Make select jsinspector tracing implementation headers private (#58796)

Summary:
Pull Request resolved: #58796

Mark the following tracing headers as private instead of for-frameworks. All of them are implementation details of React Native's tracing infrastructure, and no for-frameworks header includes them:

- `EventLoopReporter` is an RAII helper the runtime scheduler uses to report event loop task and microtask phases to the performance tracer. It is only used by `EventLoopReporter.cpp` and `RuntimeScheduler_Modern.cpp`.
- `RuntimeSamplingProfileTraceEventSerializer` turns a runtime sampling profile into trace events. It is only used by tracing sources, `TracingAgent.cpp` and its own unit test.
- `TraceEventSerializer` serializes trace events to `folly::dynamic`. It is only used by tracing sources and `TracingAgent.cpp`.
- `TraceEventGenerator` builds trace events for the performance tracer and the host profile serializer. It is only used by tracing sources and was already not exported in Buck.
- `ProfileTreeNode` is an auxiliary tree used to build the profile and deduplicate identical frames. It is only used by `RuntimeSamplingProfileTraceEventSerializer.cpp` and its own unit test.
- `Timing.h` defines the tracing clock origin and the conversions from `HighResTimeStamp` and `HighResDuration` to trace event microseconds. It is only used by tracing sources and a tracing unit test.

`TracingAgent.h` included `Timing.h` without using it; that include is removed.

React Native's own targets define `RN_BUILDING`, so the private guard does not affect them.

Changelog: [Internal]

Reviewed By: cipolleschi

Differential Revision: D122780825

fbshipit-source-id: 70f290a589ec895d80111a585e77a382ad4a1695

Author: coado

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

@@ -15,7 +15,6 @@
 #include <React/Timing.h>
 #include <jsinspector-modern/cdp/CdpJson.h>
 #include <jsinspector-modern/tracing/HostTracingProfile.h>
-#include <jsinspector-modern/tracing/Timing.h>
 
 namespace facebook::react::jsinspector_modern {
 

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

@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <react/cxxstableapi/FrameworksGuard.h>
+#include <react/cxxstableapi/PrivateGuard.h>
 
 #if defined(REACT_NATIVE_DEBUGGER_ENABLED)
 #include <React/Timing.h>

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

@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <react/cxxstableapi/FrameworksGuard.h>
+#include <react/cxxstableapi/PrivateGuard.h>
 
 #include <utility>
 

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

@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <react/cxxstableapi/FrameworksGuard.h>
+#include <react/cxxstableapi/PrivateGuard.h>
 
 #include "RuntimeSamplingProfile.h"
 

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

@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <react/cxxstableapi/FrameworksGuard.h>
+#include <react/cxxstableapi/PrivateGuard.h>
 
 #include <cassert>
 

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

@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <react/cxxstableapi/FrameworksGuard.h>
+#include <react/cxxstableapi/PrivateGuard.h>
 
 #include "TraceEvent.h"
 

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

@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <react/cxxstableapi/FrameworksGuard.h>
+#include <react/cxxstableapi/PrivateGuard.h>
 
 #include "TraceEvent.h"
 #include "TraceEventProfile.h"

scripts/cxx-api/api-snapshots/ReactAndroidFrameworksCxx.api

@@ -9531,7 +9531,6 @@ class facebook::react::jsinspector_modern::WeakList {
 }
 
 
-constexpr facebook::react::HighResTimeStamp facebook::react::jsinspector_modern::tracing::TRACING_TIME_ORIGIN;
 constexpr facebook::react::HighResTimeStamp facebook::react::jsinspector_modern::tracing::kCurrentBufferStartTimeUninitialized;
 using facebook::react::jsinspector_modern::tracing::Categories = folly::small_vector<facebook::react::jsinspector_modern::tracing::Category, 1>;
 using facebook::react::jsinspector_modern::tracing::ConsoleTimeStampEntry = std::variant<facebook::react::HighResTimeStamp, std::string>;
@@ -9540,7 +9539,6 @@ using facebook::react::jsinspector_modern::tracing::Headers = std::map<std::stri
 using facebook::react::jsinspector_modern::tracing::ProcessId = uint64_t;
 using facebook::react::jsinspector_modern::tracing::RuntimeProfileId = uint16_t;
 using facebook::react::jsinspector_modern::tracing::ThreadId = uint64_t;
-int64_t facebook::react::jsinspector_modern::tracing::highResDurationToTracingClockDuration(facebook::react::HighResDuration duration);
 std::optional<facebook::react::jsinspector_modern::tracing::Category> facebook::react::jsinspector_modern::tracing::getTracingCategoryFromString(const std::string& str);
 std::optional<facebook::react::jsinspector_modern::tracing::ConsoleTimeStampColor> facebook::react::jsinspector_modern::tracing::getConsoleTimeStampColorFromString(const std::string& str);
 std::optional<folly::dynamic> facebook::react::jsinspector_modern::tracing::getConsoleTimeStampDetailFromObject(facebook::jsi::Runtime& runtime, const facebook::jsi::Value& detailValue);
@@ -9549,7 +9547,6 @@ std::string facebook::react::jsinspector_modern::tracing::consoleTimeStampColorT
 std::string facebook::react::jsinspector_modern::tracing::serializeTracingCategories(const facebook::react::jsinspector_modern::tracing::Categories& categories);
 std::string facebook::react::jsinspector_modern::tracing::serializeTracingCategories(const std::set<facebook::react::jsinspector_modern::tracing::Category>& categories);
 std::string facebook::react::jsinspector_modern::tracing::tracingCategoryToString(const facebook::react::jsinspector_modern::tracing::Category& category);
-uint64_t facebook::react::jsinspector_modern::tracing::highResTimeStampToTracingClockTimeStamp(facebook::react::HighResTimeStamp timestamp);
 
 class facebook::react::jsinspector_modern::tracing::HostTracingProfileSerializer {
   public static void emitAsDataCollectedChunks(facebook::react::jsinspector_modern::tracing::HostTracingProfile&& hostTracingProfile, const std::function<void(folly::dynamic&& chunk)>& chunkCallback, size_t maxChunkBytes, uint16_t profileTraceEventsChunkSize);
@@ -9580,56 +9577,16 @@ class facebook::react::jsinspector_modern::tracing::PerformanceTracer {
   public void unsubscribeFromTracingStateChanges(uint32_t subscriptionId);
 }
 
-class facebook::react::jsinspector_modern::tracing::ProfileTreeNode {
-  public ProfileTreeNode(uint32_t id, facebook::react::jsinspector_modern::tracing::ProfileTreeNode::CodeType codeType, facebook::react::jsinspector_modern::tracing::RuntimeSamplingProfile::SampleCallStackFrame callFrame, uint32_t parentId = facebook::react::jsinspector_modern::tracing::ProfileTreeNode::NO_PARENT);
-  public bool hasParent() const;
-  public const facebook::react::jsinspector_modern::tracing::RuntimeSamplingProfile::SampleCallStackFrame& getCallFrame() const;
-  public facebook::react::jsinspector_modern::tracing::ProfileTreeNode* addChild(uint32_t childId, facebook::react::jsinspector_modern::tracing::ProfileTreeNode::CodeType childCodeType, facebook::react::jsinspector_modern::tracing::RuntimeSamplingProfile::SampleCallStackFrame childCallFrame);
-  public facebook::react::jsinspector_modern::tracing::ProfileTreeNode* getIfAlreadyExists(facebook::react::jsinspector_modern::tracing::ProfileTreeNode::CodeType childCodeType, const facebook::react::jsinspector_modern::tracing::RuntimeSamplingProfile::SampleCallStackFrame& childCallFrame);
-  public facebook::react::jsinspector_modern::tracing::ProfileTreeNode::CodeType getCodeType() const;
-  public static constexpr uint32_t NO_PARENT;
-  public uint32_t getId() const;
-  public uint32_t getParentId() const;
-}
-
-enum facebook::react::jsinspector_modern::tracing::ProfileTreeNode::CodeType {
-  JavaScript,
-  Other,
-}
-
 class facebook::react::jsinspector_modern::tracing::RawRuntimeProfile {
   public virtual ~RawRuntimeProfile() = default;
 }
 
-class facebook::react::jsinspector_modern::tracing::RuntimeSamplingProfileTraceEventSerializer {
-  public static void serializeAndDispatch(facebook::react::jsinspector_modern::tracing::RuntimeSamplingProfile&& profile, facebook::react::jsinspector_modern::tracing::IdGenerator& profileIdGenerator, facebook::react::HighResTimeStamp tracingStartTime, const std::function<void(folly::dynamic&& traceEventsChunk)>& dispatchCallback, uint16_t traceEventChunkSize, uint16_t profileChunkSize = PROFILE_CHUNK_SIZE, uint16_t maxUniqueNodesPerChunk = MAX_UNIQUE_NODES_PER_CHUNK);
-  public static void serializeAndDispatch(std::vector<facebook::react::jsinspector_modern::tracing::RuntimeSamplingProfile>&& profiles, facebook::react::jsinspector_modern::tracing::IdGenerator& profileIdGenerator, facebook::react::HighResTimeStamp tracingStartTime, const std::function<void(folly::dynamic&& traceEventsChunk)>& dispatchCallback, uint16_t traceEventChunkSize, uint16_t profileChunkSize = PROFILE_CHUNK_SIZE, uint16_t maxUniqueNodesPerChunk = MAX_UNIQUE_NODES_PER_CHUNK);
-}
-
 class facebook::react::jsinspector_modern::tracing::TargetTracingAgent {
   protected facebook::react::jsinspector_modern::tracing::TraceRecordingState& state_;
   public TargetTracingAgent(facebook::react::jsinspector_modern::tracing::TraceRecordingState& state);
   public bool isRunningInBackgroundMode();
 }
 
-class facebook::react::jsinspector_modern::tracing::TraceEventGenerator {
-  public static facebook::react::jsinspector_modern::tracing::TraceEvent createIdleBeginFrameEvent(facebook::react::jsinspector_modern::tracing::FrameSequenceId sequenceId, int layerTreeId, facebook::react::HighResTimeStamp timestamp, facebook::react::jsinspector_modern::tracing::ProcessId processId, facebook::react::jsinspector_modern::tracing::ThreadId threadId);
-  public static facebook::react::jsinspector_modern::tracing::TraceEvent createNeedsBeginFrameChangedEvent(int layerTreeId, facebook::react::HighResTimeStamp timestamp, facebook::react::jsinspector_modern::tracing::ProcessId processId, facebook::react::jsinspector_modern::tracing::ThreadId threadId);
-  public static facebook::react::jsinspector_modern::tracing::TraceEvent createScreenshotEvent(facebook::react::jsinspector_modern::tracing::FrameSequenceId frameSequenceId, int sourceId, std::vector<uint8_t>&& snapshot, facebook::react::HighResTimeStamp expectedDisplayTime, facebook::react::jsinspector_modern::tracing::ProcessId processId, facebook::react::jsinspector_modern::tracing::ThreadId threadId);
-  public static facebook::react::jsinspector_modern::tracing::TraceEvent createSetLayerTreeIdEvent(std::string frame, int layerTreeId, facebook::react::jsinspector_modern::tracing::ProcessId processId, facebook::react::jsinspector_modern::tracing::ThreadId threadId, facebook::react::HighResTimeStamp timestamp);
-  public static std::pair<facebook::react::jsinspector_modern::tracing::TraceEvent, facebook::react::jsinspector_modern::tracing::TraceEvent> createFrameTimingsEvents(facebook::react::jsinspector_modern::tracing::FrameSequenceId sequenceId, int layerTreeId, facebook::react::HighResTimeStamp beginTimestamp, facebook::react::HighResTimeStamp endTimestamp, facebook::react::jsinspector_modern::tracing::ProcessId processId, facebook::react::jsinspector_modern::tracing::ThreadId threadId);
-}
-
-class facebook::react::jsinspector_modern::tracing::TraceEventSerializer {
-  public static folly::dynamic serialize(facebook::react::jsinspector_modern::tracing::TraceEvent&& event);
-  public static folly::dynamic serializeProfileChunk(facebook::react::jsinspector_modern::tracing::TraceEventProfileChunk&& profileChunk);
-  public static folly::dynamic serializeProfileChunkCPUProfile(facebook::react::jsinspector_modern::tracing::TraceEventProfileChunk::CPUProfile&& cpuProfile);
-  public static folly::dynamic serializeProfileChunkCPUProfileNode(facebook::react::jsinspector_modern::tracing::TraceEventProfileChunk::CPUProfile::Node&& node);
-  public static folly::dynamic serializeProfileChunkCPUProfileNodeCallFrame(facebook::react::jsinspector_modern::tracing::TraceEventProfileChunk::CPUProfile::Node::CallFrame&& callFrame);
-  public static folly::dynamic serializeProfileChunkTimeDeltas(facebook::react::jsinspector_modern::tracing::TraceEventProfileChunk::TimeDeltas&& deltas);
-  public static size_t estimateJsonSize(const folly::dynamic& value);
-}
-
 enum facebook::react::jsinspector_modern::tracing::Category {
   Frame,
   HiddenTimeline,
@@ -9654,25 +9611,11 @@ enum facebook::react::jsinspector_modern::tracing::ConsoleTimeStampColor {
   Warning,
 }
 
-enum facebook::react::jsinspector_modern::tracing::EventLoopPhase {
-  Microtasks,
-  Task,
-}
-
 enum facebook::react::jsinspector_modern::tracing::Mode {
   Background,
   CDP,
 }
 
-struct facebook::react::jsinspector_modern::tracing::EventLoopReporter {
-  public EventLoopReporter(const facebook::react::jsinspector_modern::tracing::EventLoopReporter&) = delete;
-  public EventLoopReporter(facebook::react::jsinspector_modern::tracing::EventLoopPhase phase);
-  public EventLoopReporter(facebook::react::jsinspector_modern::tracing::EventLoopReporter&&) = delete;
-  public facebook::react::jsinspector_modern::tracing::EventLoopReporter& operator=(const facebook::react::jsinspector_modern::tracing::EventLoopReporter&) = delete;
-  public facebook::react::jsinspector_modern::tracing::EventLoopReporter& operator=(facebook::react::jsinspector_modern::tracing::EventLoopReporter&&) = delete;
-  public ~EventLoopReporter();
-}
-
 struct facebook::react::jsinspector_modern::tracing::FrameTimingSequence {
   public FrameTimingSequence() = delete;
   public FrameTimingSequence(facebook::react::jsinspector_modern::tracing::FrameSequenceId id, facebook::react::jsinspector_modern::tracing::ThreadId threadId, facebook::react::HighResTimeStamp beginTimestamp, facebook::react::HighResTimeStamp endTimestamp, std::optional<std::vector<uint8_t>> screenshot = std::nullopt, facebook::react::HighResDuration vsyncInterval = facebook::react::HighResDuration::zero());
@@ -9698,10 +9641,6 @@ struct facebook::react::jsinspector_modern::tracing::HostTracingProfile {
   public ~HostTracingProfile() = default;
 }
 
-struct facebook::react::jsinspector_modern::tracing::IdGenerator {
-  public uint32_t getNext();
-}
-
 struct facebook::react::jsinspector_modern::tracing::InstanceTracingProfile {
   public std::vector<facebook::react::jsinspector_modern::tracing::TraceEvent> performanceTraceEvents;
 }