blob: 9819457cec51a6a972c500c749a42bd905c88291 [file] [log] [blame]
// Copyright 2018 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "base/macros.h"
#include "services/tracing/perfetto/producer_host.h"
#include "services/tracing/public/mojom/perfetto_service.mojom.h"
#include "third_party/perfetto/include/perfetto/tracing/core/producer.h"
#include "third_party/perfetto/include/perfetto/tracing/core/tracing_service.h"
namespace perfetto {
class CommitDataRequest;
} // namespace perfetto
namespace tracing {
// This class is the service-side part of the Perfetto Producer pair
// and is responsible for registering any available DataSources
// with Perfetto (like ChromeTracing) in OnConnect(). It will forward
// control messages from Perfetto to its per-process ProducerClient
// counterpart, like starting tracing with a specific shared memory buffer,
// create/teardown instances of specific data sources, etc.
// It's managed by PerfettoService which is responsible for
// creating a ProducerHost when a ProducerClient registers itself
// and connects them together.
class ProducerHost : public tracing::mojom::ProducerHost,
public perfetto::Producer {
~ProducerHost() override;
// Called by the ProducerService to register the
// Producer with Perfetto and connect to the
// corresponding remote ProducerClient.
void Initialize(mojom::ProducerClientPtr producer_client,
perfetto::TracingService* service,
const std::string& name);
// perfetto::Producer implementation.
// Gets called by perfetto::TracingService to toggle specific data sources
// when requested by a Perfetto Consumer.
void OnConnect() override;
void OnDisconnect() override;
void SetupDataSource(perfetto::DataSourceInstanceID id,
const perfetto::DataSourceConfig& config) override;
void StartDataSource(perfetto::DataSourceInstanceID id,
const perfetto::DataSourceConfig& config) override;
void StopDataSource(perfetto::DataSourceInstanceID) override;
void OnTracingSetup() override;
void Flush(perfetto::FlushRequestID,
const perfetto::DataSourceInstanceID* raw_data_source_ids,
size_t num_data_sources) override;
// mojom::ProducerHost implementation.
// This interface gets called by the per-process ProducerClients
// to signal that there's changes to be committed to the
// Shared Memory buffer (like finished chunks).
void CommitData(mojom::CommitDataRequestPtr data_request) override;
// Called by the ProducerClient to signal the Host that it can
// provide a specific data source.
void RegisterDataSource(
mojom::DataSourceRegistrationPtr registration_info) override;
// Called to signal the Host that a specific flush request
// is finished.
void NotifyFlushComplete(uint64_t flush_request_id) override;
// Called by the ProducerClient to associate a TraceWriter with a target
// buffer, which is required to support scraping of the SMB by the service.
void RegisterTraceWriter(uint32_t writer_id, uint32_t target_buffer) override;
void UnregisterTraceWriter(uint32_t writer_id) override;
void OnConnectionError();
base::RepeatingCallback<void(const perfetto::CommitDataRequest&)>
mojom::ProducerClientPtr producer_client_;
// Perfetto guarantees that no OnXX callbacks are invoked on |this|
// immediately after |producer_endpoint_| is destroyed.
} // namespace tracing