Skip to content

libkineto: native Perfetto (.pftrace) trace export #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ajassani wants to merge 1 commit into
base: main
Choose a base branch
from
Open

libkineto: native Perfetto (.pftrace) trace export #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions libkineto/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ set(KINETO_LIBRARY_TYPE "default" CACHE STRING
set_property(CACHE KINETO_LIBRARY_TYPE PROPERTY STRINGS default shared static)
option(KINETO_BUILD_TESTS "Build kineto unit tests" ON)
option(KINETO_BUILD_BENCHMARKS "Build kineto benchmarks" OFF)
option(KINETO_ENABLE_PERFETTO "Enable native Perfetto/pftrace trace export" OFF)
set(PERFETTO_SOURCE_DIR "" CACHE PATH
"Path to a Perfetto checkout containing sdk/perfetto.h and sdk/perfetto.cc")

set(LIBKINETO_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
set(LIBKINETO_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/src")
Expand Down Expand Up @@ -213,6 +216,33 @@ elseif(KINETO_BACKEND STREQUAL "xpu")
endif()
endif()

if(KINETO_ENABLE_PERFETTO)
if(NOT PERFETTO_SOURCE_DIR)
if(DEFINED ENV{PERFETTO_SOURCE_DIR})
set(PERFETTO_SOURCE_DIR "$ENV{PERFETTO_SOURCE_DIR}")
elseif(EXISTS "${LIBKINETO_THIRDPARTY_DIR}/perfetto/sdk/perfetto.h")
set(PERFETTO_SOURCE_DIR "${LIBKINETO_THIRDPARTY_DIR}/perfetto")
endif()
endif()
if(NOT EXISTS "${PERFETTO_SOURCE_DIR}/sdk/perfetto.h" OR
NOT EXISTS "${PERFETTO_SOURCE_DIR}/sdk/perfetto.cc")
message(FATAL_ERROR
"KINETO_ENABLE_PERFETTO=ON requires PERFETTO_SOURCE_DIR to point to "
"a Perfetto checkout containing sdk/perfetto.h and sdk/perfetto.cc.")
endif()
add_library(kineto_perfetto STATIC
"${PERFETTO_SOURCE_DIR}/sdk/perfetto.cc")
target_include_directories(kineto_perfetto SYSTEM PUBLIC
"${PERFETTO_SOURCE_DIR}/sdk")
set_target_properties(kineto_perfetto PROPERTIES
POSITION_INDEPENDENT_CODE ON)
if(MSVC)
target_compile_options(kineto_perfetto PRIVATE /w)
else()
target_compile_options(kineto_perfetto PRIVATE -w -O0 -g0)
endif()
list(APPEND KINETO_DEFINITIONS "KINETO_ENABLE_PERFETTO")
endif()
target_compile_definitions(kineto_base PUBLIC "${KINETO_DEFINITIONS}")
target_compile_options(kineto_base PRIVATE "${KINETO_COMPILE_OPTIONS}")
target_compile_definitions(kineto_api PUBLIC "${KINETO_DEFINITIONS}")
Expand Down Expand Up @@ -249,6 +279,9 @@ target_include_directories(kineto_base SYSTEM PUBLIC
$<BUILD_INTERFACE:${DYNOLOG_INCLUDE_DIR}>
$<BUILD_INTERFACE:${IPCFABRIC_INCLUDE_DIR}>)
target_link_libraries(kineto_base PRIVATE $<BUILD_INTERFACE:fmt::fmt-header-only>)
if(KINETO_ENABLE_PERFETTO)
target_link_libraries(kineto_base PUBLIC kineto_perfetto)
endif()

target_include_directories(kineto_api PUBLIC
$<BUILD_INTERFACE:${LIBKINETO_DIR}>
Expand All @@ -265,6 +298,9 @@ elseif(NOT KINETO_LIBRARY_TYPE STREQUAL "default")
endif()

add_library(kineto $<TARGET_OBJECTS:kineto_base> $<TARGET_OBJECTS:kineto_api>)
if(KINETO_ENABLE_PERFETTO)
target_link_libraries(kineto $<BUILD_INTERFACE:kineto_perfetto>)
endif()
if(BUILD_SHARED_LIBS)
set_property(TARGET kineto_base PROPERTY POSITION_INDEPENDENT_CODE ON)
set_property(TARGET kineto_api PROPERTY POSITION_INDEPENDENT_CODE ON)
Expand Down
1 change: 1 addition & 0 deletions libkineto/libkineto_defs.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ def get_libkineto_cpu_only_srcs(with_api = True):
"src/init.cpp",
"src/output_csv.cpp",
"src/output_json.cpp",
"src/output_perfetto.cpp",
] + (get_libkineto_api_srcs() if with_api else [])

def get_libkineto_public_headers():
Expand Down
8 changes: 8 additions & 0 deletions libkineto/src/ActivityProfilerController.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@

#include "output_json.h"
#include "output_membuf.h"
#ifdef KINETO_ENABLE_PERFETTO
#include "output_perfetto.h"
#endif

#include "Logger.h"

Expand Down Expand Up @@ -111,6 +114,11 @@ static ActivityLoggerFactory initLoggerFactory() {
factory.addProtocol("file", [](const std::string& url) {
return std::unique_ptr<ActivityLogger>(new ChromeTraceLogger(url));
});
#ifdef KINETO_ENABLE_PERFETTO
factory.addProtocol("pftrace", [](const std::string& url) {
return std::unique_ptr<ActivityLogger>(new PerfettoTraceLogger(url));
});
#endif
return factory;
}

Expand Down
5 changes: 4 additions & 1 deletion libkineto/src/ActivityTrace.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
#include "ActivityTraceInterface.h"
#include "output_json.h"
#include "output_membuf.h"
#ifdef KINETO_ENABLE_PERFETTO
#include "output_perfetto.h"
#endif

namespace libkineto {

Expand All @@ -31,7 +34,7 @@ class ActivityTrace : public ActivityTraceInterface {
std::string prefix;
// if no protocol is specified, default to file
if (url.find("://") == url.npos) {
prefix = "file://";
prefix = url.ends_with(".pftrace") ? "pftrace://" : "file://";
}
memLogger_->setChromeLogger(loggerFactory_.makeLogger(prefix + url));
memLogger_->log(*memLogger_->getChromeLogger());
Expand Down
Loading
Loading