SkEventTracer Class Reference

#include <SkEventTracer.h>

Inheritance diagram for SkEventTracer:

Public Types
enum	CategoryGroupEnabledFlags { kEnabledForRecording_CategoryGroupEnabledFlags = 1 << 0 , kEnabledForMonitoring_CategoryGroupEnabledFlags = 1 << 1 , kEnabledForEventCallback_CategoryGroupEnabledFlags = 1 << 2 }
typedef uint64_t	Handle

Public Member Functions
virtual	~SkEventTracer ()=default
virtual const uint8_t *	getCategoryGroupEnabled (const char *name)=0
virtual const char *	getCategoryGroupName (const uint8_t *categoryEnabledFlag)=0
virtual SkEventTracer::Handle	addTraceEvent (char phase, const uint8_t *categoryEnabledFlag, const char *name, uint64_t id, int32_t numArgs, const char **argNames, const uint8_t *argTypes, const uint64_t *argValues, uint8_t flags)=0
virtual void	updateTraceEventDuration (const uint8_t *categoryEnabledFlag, const char *name, SkEventTracer::Handle handle)=0
virtual void	newTracingSection (const char *)

Static Public Member Functions
static bool	SetInstance (SkEventTracer *, bool leakTracer=false)
static SkEventTracer *	GetInstance ()

Protected Member Functions
	SkEventTracer ()=default
	SkEventTracer (const SkEventTracer &)=delete
SkEventTracer &	operator= (const SkEventTracer &)=delete

Detailed Description

Definition at line 23 of file SkEventTracer.h.

Member Typedef Documentation

Handle

typedef uint64_t SkEventTracer::Handle

Definition at line 26 of file SkEventTracer.h.

Member Enumeration Documentation

CategoryGroupEnabledFlags

enum SkEventTracer::CategoryGroupEnabledFlags

Enumerator
kEnabledForRecording_CategoryGroupEnabledFlags
kEnabledForMonitoring_CategoryGroupEnabledFlags
kEnabledForEventCallback_CategoryGroupEnabledFlags

Definition at line 53 of file SkEventTracer.h.

                                   {
        // Category group enabled for the recording mode.
        kEnabledForRecording_CategoryGroupEnabledFlags = 1 << 0,
        // Category group enabled for the monitoring mode.
        kEnabledForMonitoring_CategoryGroupEnabledFlags = 1 << 1,
        // Category group enabled by SetEventCallbackEnabled().
        kEnabledForEventCallback_CategoryGroupEnabledFlags = 1 << 2,
    };

Constructor & Destructor Documentation

~SkEventTracer()

virtual SkEventTracer::~SkEventTracer ( )

virtualdefault

SkEventTracer() [1/2]

SkEventTracer::SkEventTracer ( )

protecteddefault

SkEventTracer() [2/2]

SkEventTracer::SkEventTracer ( const SkEventTracer &  )

protecteddelete

Member Function Documentation

addTraceEvent()

virtual SkEventTracer::Handle SkEventTracer::addTraceEvent ( char  phase, const uint8_t *  categoryEnabledFlag, const char *  name, uint64_t  id, int32_t  numArgs, const char **  argNames, const uint8_t *  argTypes, const uint64_t *  argValues, uint8_t  flags  )

pure virtual

getCategoryGroupEnabled()

virtual const uint8_t * SkEventTracer::getCategoryGroupEnabled ( const char *  name )

pure virtual

Implemented in flutter::FlutterEventTracer, SkATrace, SkDefaultEventTracer, ChromeTracingTracer, SkDebugfTracer, and SkPerfettoTrace.

getCategoryGroupName()

virtual const char * SkEventTracer::getCategoryGroupName ( const uint8_t *  categoryEnabledFlag )

pure virtual

Implemented in flutter::FlutterEventTracer, SkATrace, SkDefaultEventTracer, ChromeTracingTracer, SkDebugfTracer, and SkPerfettoTrace.

GetInstance()

SkEventTracer * SkEventTracer::GetInstance ( )

static

Gets the event tracer. If this is the first call to SetInstance or GetIntance then a default event tracer is installed and returned.

Definition at line 63 of file SkEventTracer.cpp.

                                          {
    if (auto tracer = gUserTracer.load(std::memory_order_acquire)) {
        return tracer;
    }
    static SkOnce once;
    static SkDefaultEventTracer* defaultTracer;
    once([] { defaultTracer = new SkDefaultEventTracer; });
    return defaultTracer;
}

newTracingSection()

virtual void SkEventTracer::newTracingSection ( const char *  )

inlinevirtual

Reimplemented in SkATrace, SkDefaultEventTracer, ChromeTracingTracer, SkDebugfTracer, and SkPerfettoTrace.

Definition at line 82 of file SkEventTracer.h.

{}

operator=()

SkEventTracer & SkEventTracer::operator= ( const SkEventTracer &  )

protecteddelete

SetInstance()

bool SkEventTracer::SetInstance ( SkEventTracer *  tracer, bool  leakTracer = false  )

static

If this is the first call to SetInstance or GetInstance then the passed instance is installed and true is returned. Otherwise, false is returned. In either case ownership of the tracer is transferred and it will be deleted when no longer needed.

Not deleting the tracer on process exit should not cause problems as the whole heap is about to go away with the process. This can also improve performance by reducing the amount of work needed.

Parameters

leakTracer

Do not delete tracer on process exit.

Definition at line 49 of file SkEventTracer.cpp.

                                                                      {
    SkEventTracer* expected = nullptr;
    if (!gUserTracer.compare_exchange_strong(expected, tracer)) {
        delete tracer;
        return false;
    }
    // If leaking the tracer is accepted then there is no need to install
    // the atexit.
    if (!leakTracer) {
        atexit([]() { delete gUserTracer.load(); });
    }
    return true;
}

updateTraceEventDuration()

virtual void SkEventTracer::updateTraceEventDuration ( const uint8_t *  categoryEnabledFlag, const char *  name, SkEventTracer::Handle  handle  )

pure virtual

Implemented in flutter::FlutterEventTracer, SkATrace, SkDefaultEventTracer, ChromeTracingTracer, SkDebugfTracer, and SkPerfettoTrace.

---

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

• third_party/skia/include/utils/SkEventTracer.h
• third_party/skia/src/utils/SkEventTracer.cpp