ChromeTracingTracer Class Reference

#include <ChromeTracingTracer.h>

Inheritance diagram for ChromeTracingTracer:

Public Member Functions
	ChromeTracingTracer (const char *filename)
	~ChromeTracingTracer () override
SkEventTracer::Handle	addTraceEvent (char phase, const uint8_t *categoryEnabledFlag, const char *name, uint64_t id, int numArgs, const char **argNames, const uint8_t *argTypes, const uint64_t *argValues, uint8_t flags) override
void	updateTraceEventDuration (const uint8_t *categoryEnabledFlag, const char *name, SkEventTracer::Handle handle) override
const uint8_t *	getCategoryGroupEnabled (const char *name) override
const char *	getCategoryGroupName (const uint8_t *categoryEnabledFlag) override
void	newTracingSection (const char *name) override
Public Member Functions inherited from SkEventTracer
virtual	~SkEventTracer ()=default
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

Additional Inherited Members
Public Types inherited from SkEventTracer
enum	CategoryGroupEnabledFlags { kEnabledForRecording_CategoryGroupEnabledFlags = 1 << 0 , kEnabledForMonitoring_CategoryGroupEnabledFlags = 1 << 1 , kEnabledForEventCallback_CategoryGroupEnabledFlags = 1 << 2 }
typedef uint64_t	Handle
Static Public Member Functions inherited from SkEventTracer
static bool	SetInstance (SkEventTracer *, bool leakTracer=false)
static SkEventTracer *	GetInstance ()
Protected Member Functions inherited from SkEventTracer
	SkEventTracer ()=default
	SkEventTracer (const SkEventTracer &)=delete
SkEventTracer &	operator= (const SkEventTracer &)=delete

Detailed Description

A SkEventTracer implementation that logs events to JSON for viewing with chrome://tracing.

Definition at line 22 of file ChromeTracingTracer.h.

Constructor & Destructor Documentation

ChromeTracingTracer()

ChromeTracingTracer::ChromeTracingTracer

(

const char *

filename

)

Definition at line 55 of file ChromeTracingTracer.cpp.

                                                             : fFilename(filename) {
    this->createBlock();
}

~ChromeTracingTracer()

ChromeTracingTracer::~ChromeTracingTracer ( )

override

Definition at line 59 of file ChromeTracingTracer.cpp.

{ this->flush(); }

Member Function Documentation

addTraceEvent()

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

override

Definition at line 82 of file ChromeTracingTracer.cpp.

                                                                                {
    // TODO: Respect flags (or assert). INSTANT events encode scope in flags, should be stored
    // using "s" key in JSON. COPY flag should be supported or rejected.
 
    // Figure out how much extra storage we need for copied strings
    int size = static_cast<int>(sizeof(TraceEvent) + numArgs * sizeof(TraceEventArg));
    for (int i = 0; i < numArgs; ++i) {
        if (TRACE_VALUE_TYPE_COPY_STRING == argTypes[i]) {
            size += strlen(skia_private::TraceValueAsString(argValues[i])) + 1;
        }
    }
 
    size = SkAlign8(size);
 
    STArray<128, uint8_t, true> storage;
    uint8_t* storagePtr = storage.push_back_n(size);
 
    TraceEvent* traceEvent  = reinterpret_cast<TraceEvent*>(storagePtr);
    traceEvent->fPhase      = phase;
    traceEvent->fNumArgs    = numArgs;
    traceEvent->fSize       = size;
    traceEvent->fName       = name;
    traceEvent->fID         = id;
    traceEvent->fClockBegin = std::chrono::steady_clock::now().time_since_epoch().count();
    traceEvent->fClockEnd   = 0;
    traceEvent->fThreadID   = SkGetThreadID();
 
    TraceEventArg* traceEventArgs  = traceEvent->args();
    char*          stringTableBase = traceEvent->stringTable();
    char*          stringTable     = stringTableBase;
    for (int i = 0; i < numArgs; ++i) {
        traceEventArgs[i].fArgName = argNames[i];
        traceEventArgs[i].fArgType = argTypes[i];
        if (TRACE_VALUE_TYPE_COPY_STRING == argTypes[i]) {
            // Just write an offset into the arguments array
            traceEventArgs[i].fArgValue = stringTable - stringTableBase;
 
            // Copy string into our buffer (and advance)
            const char* valueStr = skia_private::TraceValueAsString(argValues[i]);
            while (*valueStr) {
                *stringTable++ = *valueStr++;
            }
            *stringTable++ = 0;
        } else {
            traceEventArgs[i].fArgValue = argValues[i];
        }
    }
 
    return this->appendEvent(storagePtr, size);
}

getCategoryGroupEnabled()

const uint8_t * ChromeTracingTracer::getCategoryGroupEnabled ( const char *  name )

inlineoverridevirtual

Implements SkEventTracer.

Definition at line 41 of file ChromeTracingTracer.h.

                                                                      {
        return fCategories.getCategoryGroupEnabled(name);
    }

getCategoryGroupName()

const char * ChromeTracingTracer::getCategoryGroupName ( const uint8_t *  categoryEnabledFlag )

inlineoverridevirtual

Implements SkEventTracer.

Definition at line 45 of file ChromeTracingTracer.h.

                                                                                  {
        return fCategories.getCategoryGroupName(categoryEnabledFlag);
    }

newTracingSection()

void ChromeTracingTracer::newTracingSection ( const char *  name )

inlineoverridevirtual

Reimplemented from SkEventTracer.

Definition at line 50 of file ChromeTracingTracer.h.

{}

updateTraceEventDuration()

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

overridevirtual

Implements SkEventTracer.

Definition at line 141 of file ChromeTracingTracer.cpp.

                                                                               {
    // We could probably get away with not locking here, but let's be totally safe.
    SkAutoSpinlock lock(fMutex);
    TraceEvent*    traceEvent = reinterpret_cast<TraceEvent*>(handle);
    traceEvent->fClockEnd         = std::chrono::steady_clock::now().time_since_epoch().count();
}

---

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

• third_party/skia/tools/trace/ChromeTracingTracer.h
• third_party/skia/tools/trace/ChromeTracingTracer.cpp