mirror of
https://github.com/mollyim/webrtc.git
synced 2025-05-12 21:30:45 +01:00
db50b03553
This adds Perfetto support to WebRTC with a GN flag rtc_use_perfetto. The configuration of perfetto depends on whether or not webrtc is build within Chrome or not. When in Chrome, WebRTC will depend on //third_party/perfetto:libperfetto. When building standalone, specific includes required for Perfetto are exposed with the library webrtc_libperfetto. The perfetto trace API is exposed with a header export in trace_event.h which is used instead of the legacy API. The addition of Perfetto means there are 4 compilation modes for tracing in WebRTC, 1. No tracing implementation. 2. Legacy tracing (AddTraceEvent/GetCategoryEnabled). 3.a. Perfetto statically linked (webrtc_libperfetto). 3.b. Perfetto in Chrome (Chrome's libperfetto). This CL removes the tracing expectations from rtc_stats_integrationtest.cc because those directly used the old API. Integration into Chrome is a follow up CL which depends on https://chromium-review.googlesource.com/c/chromium/src/+/5471691. Tested: Ran Chrome with Perfetto and traces appear. WebRTC Unit test tracing working: https://ui.perfetto.dev/#!?s=04ea2613ea36b814394639a1ec4b60be5b5097527f1a485995ecc13469885468 Bug: webrtc:15917 Change-Id: I537d79dc247c2b759689910c621087286a4d8fdc Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/347880 Reviewed-by: Harald Alvestrand <hta@webrtc.org> Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org> Auto-Submit: Evan Shrubsole <eshr@google.com> Commit-Queue: Harald Alvestrand <hta@webrtc.org> Reviewed-by: Mikhail Khokhlov <khokhlov@google.com> Cr-Commit-Position: refs/heads/main@{#42166}
88 lines
3.3 KiB
C++
88 lines
3.3 KiB
C++
/*
|
|
* Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license
|
|
* that can be found in the LICENSE file in the root of the source
|
|
* tree. An additional intellectual property rights grant can be found
|
|
* in the file PATENTS. All contributing project authors may
|
|
* be found in the AUTHORS file in the root of the source tree.
|
|
*/
|
|
|
|
#ifndef RTC_BASE_EVENT_TRACER_H_
|
|
#define RTC_BASE_EVENT_TRACER_H_
|
|
|
|
// This file defines the interface for event tracing in WebRTC.
|
|
//
|
|
// Event log handlers are set through SetupEventTracer(). User of this API will
|
|
// provide two function pointers to handle event tracing calls.
|
|
//
|
|
// * GetCategoryEnabledPtr
|
|
// Event tracing system calls this function to determine if a particular
|
|
// event category is enabled.
|
|
//
|
|
// * AddTraceEventPtr
|
|
// Adds a tracing event. It is the user's responsibility to log the data
|
|
// provided.
|
|
//
|
|
// Parameters for the above two functions are described in trace_event.h.
|
|
|
|
#include <stdio.h>
|
|
|
|
#include "absl/strings/string_view.h"
|
|
#include "rtc_base/system/rtc_export.h"
|
|
|
|
namespace webrtc {
|
|
|
|
#if defined(RTC_USE_PERFETTO)
|
|
void RegisterPerfettoTrackEvents();
|
|
#else
|
|
typedef const unsigned char* (*GetCategoryEnabledPtr)(const char* name);
|
|
typedef void (*AddTraceEventPtr)(char phase,
|
|
const unsigned char* category_enabled,
|
|
const char* name,
|
|
unsigned long long id,
|
|
int num_args,
|
|
const char** arg_names,
|
|
const unsigned char* arg_types,
|
|
const unsigned long long* arg_values,
|
|
unsigned char flags);
|
|
|
|
// User of WebRTC can call this method to setup event tracing.
|
|
//
|
|
// This method must be called before any WebRTC methods. Functions
|
|
// provided should be thread-safe.
|
|
void SetupEventTracer(GetCategoryEnabledPtr get_category_enabled_ptr,
|
|
AddTraceEventPtr add_trace_event_ptr);
|
|
|
|
// This class defines interface for the event tracing system to call
|
|
// internally. Do not call these methods directly.
|
|
class EventTracer {
|
|
public:
|
|
static const unsigned char* GetCategoryEnabled(const char* name);
|
|
|
|
static void AddTraceEvent(char phase,
|
|
const unsigned char* category_enabled,
|
|
const char* name,
|
|
unsigned long long id,
|
|
int num_args,
|
|
const char** arg_names,
|
|
const unsigned char* arg_types,
|
|
const unsigned long long* arg_values,
|
|
unsigned char flags);
|
|
};
|
|
#endif
|
|
|
|
} // namespace webrtc
|
|
|
|
namespace rtc::tracing {
|
|
// Set up internal event tracer.
|
|
// TODO(webrtc:15917): Implement for perfetto.
|
|
RTC_EXPORT void SetupInternalTracer(bool enable_all_categories = true);
|
|
RTC_EXPORT bool StartInternalCapture(absl::string_view filename);
|
|
RTC_EXPORT void StartInternalCaptureToFile(FILE* file);
|
|
RTC_EXPORT void StopInternalCapture();
|
|
// Make sure we run this, this will tear down the internal tracing.
|
|
RTC_EXPORT void ShutdownInternalTracer();
|
|
} // namespace rtc::tracing
|
|
|
|
#endif // RTC_BASE_EVENT_TRACER_H_
|