components/performance_manager/public/tracing_support.h

// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_PERFORMANCE_MANAGER_PUBLIC_TRACING_SUPPORT_H_
#define COMPONENTS_PERFORMANCE_MANAGER_PUBLIC_TRACING_SUPPORT_H_

#include <optional>

#include "third_party/perfetto/include/perfetto/tracing/string_helpers.h"
#include "third_party/perfetto/include/perfetto/tracing/track.h"

namespace performance_manager {

class ProcessNode;

// Returns true iff `process_node` has a ProcessTrack that can be used in
// CreateProcessTracingTrack.
bool HasProcessTracingTrack(const ProcessNode* process_node);

// Returns a Perfetto NamedTrack with the given `name` (and optionally `id`),
// which will be nested under the ProcessTrack for the process hosted in
// `process_node`. The browser process can write trace events to this track,
// which will be grouped with the child process in traces.
//
// Note: Must only be called if HasProcessTracingTrack() returns true for
// `process_node`. This doesn't return an `optional<NamedTrack>` because
// Track has deleted assignment operators, making it very awkward to use with
// `optional`.
perfetto::NamedTrack CreateProcessTracingTrack(const ProcessNode* process_node,
                                               perfetto::DynamicString name,
                                               uint64_t id = 0);
perfetto::NamedTrack CreateProcessTracingTrack(const ProcessNode* process_node,
                                               perfetto::StaticString name,
                                               uint64_t id = 0);

}  // namespace performance_manager

#endif  // COMPONENTS_PERFORMANCE_MANAGER_PUBLIC_TRACING_SUPPORT_H_