tim::component::perfetto_trace Struct Reference

Component providing perfetto implementation. More...

#include "timemory/components/perfetto/perfetto.hpp"

Collaboration diagram for tim::component::perfetto_trace:

Classes
struct	config

Public Types
using	TracingInitArgs = backend::perfetto::tracing_init_args
using	TracingSession = backend::perfetto::tracing_session
using	value_type = void
using	base_type = base< perfetto_trace, value_type >
using	strset_t = std::unordered_set< std::string >
using	strset_iterator = typename strset_t::iterator
using	storage_type = empty_storage

Public Member Functions
constexpr	perfetto_trace ()=default
template<typename Tp >
void	store (const char *, Tp, enable_if_t< std::is_integral< Tp >::value, int >=0)
template<typename Tp >
void	store (Tp, enable_if_t< std::is_integral< Tp >::value, int >=0)
void	start (const char *)
void	start ()
void	stop ()
void	set_prefix (const char *)
void	get () const

Static Public Member Functions
static std::string	label ()
static std::string	description ()
static config &	get_config ()
static void	global_init ()
static void	global_finalize ()
template<typename... Args>
static opaque	get_opaque (Args &&...)

Detailed Description

Component providing perfetto implementation.

Definition at line 51 of file perfetto.hpp.

Member Typedef Documentation

base_type

using tim::component::perfetto_trace::base_type = base<perfetto_trace, value_type>

Definition at line 57 of file perfetto.hpp.

storage_type

using tim::component::empty_base::storage_type = empty_storage

inherited

Definition at line 66 of file declaration.hpp.

strset_iterator

using tim::component::perfetto_trace::strset_iterator = typename strset_t::iterator

Definition at line 59 of file perfetto.hpp.

strset_t

using tim::component::perfetto_trace::strset_t = std::unordered_set<std::string>

Definition at line 58 of file perfetto.hpp.

TracingInitArgs

using tim::component::perfetto_trace::TracingInitArgs = backend::perfetto::tracing_init_args

Definition at line 53 of file perfetto.hpp.

TracingSession

using tim::component::perfetto_trace::TracingSession = backend::perfetto::tracing_session

Definition at line 54 of file perfetto.hpp.

value_type

using tim::component::perfetto_trace::value_type = void

Definition at line 56 of file perfetto.hpp.

Constructor & Destructor Documentation

perfetto_trace()

constexpr tim::component::perfetto_trace::perfetto_trace ( )

constexprdefault

Member Function Documentation

description()

std::string tim::component::perfetto_trace::description ( )

static

Definition at line 59 of file perfetto.cpp.

{
    return "Provides Perfetto Tracing SDK: system profiling, app tracing and trace "
           "analysis";
}

get()

void tim::component::empty_base::get ( ) const

inlineinherited

Definition at line 69 of file declaration.hpp.

{}

get_config()

perfetto_trace::config & tim::component::perfetto_trace::get_config ( )

static

Definition at line 67 of file perfetto.cpp.

{
    static auto _config = perfetto_trace::config{};
    return _config;
}

Referenced by global_finalize(), and global_init().

get_opaque()

template<typename... Args>

static opaque tim::component::empty_base::get_opaque ( Args &&  ... )

inlinestaticinherited

Definition at line 72 of file declaration.hpp.

    {
        return opaque{};
    }

global_finalize()

void tim::component::perfetto_trace::global_finalize ( )

static

Definition at line 136 of file perfetto.cpp.

{
#if defined(TIMEMORY_USE_PERFETTO)
    DEBUG_PRINT_HERE("Finalizing %s", label().c_str());
    dmp::barrier();
 
    // Make sure the last event is closed for this example.
    ::perfetto::TrackEvent::Flush();
 
    auto& _session = get_config().session;
    if(!_session)
        return;
 
    // Stop tracing and read the trace data.
    _session->StopBlocking();
    std::vector<char> trace_data(_session->ReadTraceBlocking());
 
    auto        _rank     = dmp::rank();
    std::string _label    = label();
    std::string _category = ::tim::trait::perfetto_category<TIMEMORY_PERFETTO_API>::value;
    std::string _fname    = tim::settings::compose_output_filename(
        TIMEMORY_JOIN('_', _label, _category), "pftrace", dmp::is_initialized(), _rank);
    // output to a unique filename per rank if DMP is initialized
    printf("[%s]|%i> Outputting '%s'...\n", _label.c_str(), (int) _rank, _fname.c_str());
    manager::instance()->add_file_output("binary", _label, _fname);
 
    // Write the result into a file.
    // Note: To save memory with longer traces, you can tell Perfetto to write
    // directly into a file by passing a file descriptor into Setup() above.
    std::ofstream output{};
    output.open(_fname.c_str(), std::ios::out | std::ios::binary);
    output.write(&trace_data[0], trace_data.size());
    output.close();
 
    dmp::barrier();
    if(_rank == 0)
        puts("");
#endif
}

References tim::settings::compose_output_filename(), DEBUG_PRINT_HERE, get_config(), tim::manager::instance(), label(), and TIMEMORY_JOIN.

global_init()

void tim::component::perfetto_trace::global_init ( )

static

Definition at line 75 of file perfetto.cpp.

{
#if defined(TIMEMORY_USE_PERFETTO)
    DEBUG_PRINT_HERE("Initializing %s", label().c_str());
    if(get_config().session)
        return;
 
    auto& args     = get_tracing_init_args();
    auto& _session = get_config().session;
    auto  shmem_size_hint =
        tim::get_env<size_t>("TIMEMORY_PERFETTO_SHMEM_SIZE_HINT_KB", 40960);
    auto buffer_size = tim::get_env<size_t>("TIMEMORY_PERFETTO_BUFFER_SIZE_KB", 1024000);
 
    ::perfetto::TraceConfig                   cfg{};
    ::perfetto::protos::gen::TrackEventConfig track_event_cfg{};
 
    cfg.add_buffers()->set_size_kb(buffer_size);
    auto* ds_cfg = cfg.add_data_sources()->mutable_config();
    ds_cfg->set_name("track_event");
    ds_cfg->set_track_event_config_raw(track_event_cfg.SerializeAsString());
 
    args.shmem_size_hint_kb = shmem_size_hint;
 
    if(get_config().in_process)
        args.backends |= ::perfetto::kInProcessBackend;
 
    if(get_config().system_backend)
        args.backends |= ::perfetto::kSystemBackend;
 
    ::perfetto::Tracing::Initialize(args);
    ::perfetto::TrackEvent::Register();
 
    _session = ::perfetto::Tracing::NewTrace();
    _session->Setup(cfg);
    _session->StartBlocking();
 
    /*
    ::perfetto::ProcessTrack _process_track        = ::perfetto::ProcessTrack::Current();
    ::perfetto::protos::gen::TrackDescriptor _desc = _process_track.Serialize();
    auto& _cmdline = settings::instance()->get_command_line();
    if(!_cmdline.empty())
    {
        auto _name = _cmdline.at(0);
        auto _pos  = _name.find_last_of('/');
        if(_pos != std::string::npos && _pos + 1 < _name.size())
            _name = _name.substr(_pos + 1);
        _desc.mutable_process()->set_process_name(_name);
    }
    else
    {
        std::string _category =
            ::tim::trait::perfetto_category<TIMEMORY_PERFETTO_API>::value;
        _desc.mutable_process()->set_process_name(TIMEMORY_JOIN("-", label(), _category));
    }
    ::perfetto::TrackEvent::SetTrackDescriptor(_process_track, _desc);
    */
#endif
}

References DEBUG_PRINT_HERE, get_config(), and label().

label()

std::string tim::component::perfetto_trace::label ( )

static

Definition at line 52 of file perfetto.cpp.

{
    return "perfetto_trace";
}

Referenced by global_finalize(), and global_init().

set_prefix()

void tim::component::perfetto_trace::set_prefix

(

const char *

_prefix

)

Definition at line 208 of file perfetto.cpp.

{
    if(_prefix && m_prefix != _prefix)
    {
        m_prefix = _prefix;
    }
}

References tim::_prefix.

start() [1/2]

void tim::component::perfetto_trace::start

(

)

Definition at line 186 of file perfetto.cpp.

{
    if(m_prefix)
        backend::perfetto::trace_event_start<TIMEMORY_PERFETTO_API>(m_prefix);
}

start() [2/2]

void tim::component::perfetto_trace::start

(

const char *

_label

)

Definition at line 194 of file perfetto.cpp.

{
    backend::perfetto::trace_event_start<TIMEMORY_PERFETTO_API>(_label);
}

stop()

void tim::component::perfetto_trace::stop

(

)

Definition at line 201 of file perfetto.cpp.

{
    backend::perfetto::trace_event_stop<TIMEMORY_PERFETTO_API>();
}

store() [1/2]

template<typename Tp >

void tim::component::perfetto_trace::store	(	const char *	_label,
		Tp	_val,
		enable_if_t< std::is_integral< Tp >::value, int >	= 0
	)

Definition at line 120 of file perfetto.hpp.

{
    backend::perfetto::trace_counter<TIMEMORY_PERFETTO_API>(_label, _val);
}

store() [2/2]

template<typename Tp >

void tim::component::perfetto_trace::store	(	Tp	_val,
		enable_if_t< std::is_integral< Tp >::value, int >	= 0
	)

Definition at line 111 of file perfetto.hpp.

{
    if(m_prefix)
        backend::perfetto::trace_counter(m_prefix, _val);
}

---

The documentation for this struct was generated from the following files:

• timemory/components/perfetto/perfetto.hpp
• timemory/components/perfetto/perfetto.cpp