SkSL::SkSLDebugTracePlayer Class Reference

#include <SkSLDebugTracePlayer.h>

Classes
struct	VariableData

Public Types
using	BreakpointSet = std::unordered_set< int >
using	LineNumberMap = std::unordered_map< int, int >

Public Member Functions
void	reset (sk_sp< DebugTracePriv > trace)
void	step ()
void	stepOver ()
void	stepOut ()
void	run ()
void	setBreakpoints (std::unordered_set< int > breakpointLines)
void	addBreakpoint (int line)
void	removeBreakpoint (int line)
const BreakpointSet &	getBreakpoints ()
bool	traceHasCompleted () const
bool	atBreakpoint () const
size_t	cursor ()
int32_t	getCurrentLine () const
int32_t	getCurrentLineInStackFrame (int stackFrameIndex) const
std::vector< int >	getCallStack () const
int	getStackDepth () const
const LineNumberMap &	getLineNumbersReached () const
std::vector< VariableData >	getLocalVariables (int stackFrameIndex) const
std::vector< VariableData >	getGlobalVariables () const

Detailed Description

Plays back a SkSL debug trace, allowing its contents to be viewed like a traditional debugger.

Definition at line 28 of file SkSLDebugTracePlayer.h.

Member Typedef Documentation

BreakpointSet

using SkSL::SkSLDebugTracePlayer::BreakpointSet = std::unordered_set<int>

Definition at line 55 of file SkSLDebugTracePlayer.h.

LineNumberMap

using SkSL::SkSLDebugTracePlayer::LineNumberMap = std::unordered_map<int, int>

Returns every line number reached inside this debug trace, along with the remaining number of times that this trace will reach it. e.g. {100, 2} means line 100 will be reached twice.

Definition at line 83 of file SkSLDebugTracePlayer.h.

Member Function Documentation

addBreakpoint()

void SkSL::SkSLDebugTracePlayer::addBreakpoint

(

int

line

)

Definition at line 131 of file SkSLDebugTracePlayer.cpp.

                                                 {
    fBreakpointLines.insert(line);
}

atBreakpoint()

bool SkSL::SkSLDebugTracePlayer::atBreakpoint

(

)

const

Returns true if there is a breakpoint set at the current line.

Definition at line 123 of file SkSLDebugTracePlayer.cpp.

                                              {
    return fBreakpointLines.count(this->getCurrentLine());
}

cursor()

size_t SkSL::SkSLDebugTracePlayer::cursor ( )

inline

Retrieves the cursor position.

Definition at line 65 of file SkSLDebugTracePlayer.h.

{ return fCursor; }

getBreakpoints()

const BreakpointSet & SkSL::SkSLDebugTracePlayer::getBreakpoints ( )

inline

Definition at line 56 of file SkSLDebugTracePlayer.h.

{ return fBreakpointLines; }

getCallStack()

std::vector< int > SkSL::SkSLDebugTracePlayer::getCallStack

(

)

const

Returns the call stack as an array of FunctionInfo indices.

Definition at line 139 of file SkSLDebugTracePlayer.cpp.

                                                        {
    SkASSERT(!fStack.empty());
    std::vector<int> funcs;
    funcs.reserve(fStack.size() - 1);
    for (size_t index = 1; index < fStack.size(); ++index) {
        funcs.push_back(fStack[index].fFunction);
    }
    return funcs;
}

getCurrentLine()

int32_t SkSL::SkSLDebugTracePlayer::getCurrentLine

(

)

const

Retrieves the current line.

Definition at line 109 of file SkSLDebugTracePlayer.cpp.

                                                   {
    SkASSERT(!fStack.empty());
    return fStack.back().fLine;
}

getCurrentLineInStackFrame()

int32_t SkSL::SkSLDebugTracePlayer::getCurrentLineInStackFrame

(

int

stackFrameIndex

)

const

Retrieves the current line for a given stack frame.

Definition at line 114 of file SkSLDebugTracePlayer.cpp.

                                                                                  {
    // The first entry on the stack is the "global" frame before we enter main, so offset our index
    // by one to account for it.
    ++stackFrameIndex;
    SkASSERT(stackFrameIndex > 0);
    SkASSERT((size_t)stackFrameIndex < fStack.size());
    return fStack[stackFrameIndex].fLine;
}

getGlobalVariables()

std::vector< SkSLDebugTracePlayer::VariableData > SkSL::SkSLDebugTracePlayer::getGlobalVariables

(

)

const

Definition at line 182 of file SkSLDebugTracePlayer.cpp.

                                                                                           {
    if (fStack.empty()) {
        return {};
    }
    return this->getVariablesForDisplayMask(fStack.front().fDisplayMask);
}

getLineNumbersReached()

const LineNumberMap & SkSL::SkSLDebugTracePlayer::getLineNumbersReached ( ) const

inline

Definition at line 84 of file SkSLDebugTracePlayer.h.

{ return fLineNumbers; }

getLocalVariables()

std::vector< SkSLDebugTracePlayer::VariableData > SkSL::SkSLDebugTracePlayer::getLocalVariables

(

int

stackFrameIndex

)

const

Definition at line 170 of file SkSLDebugTracePlayer.cpp.

                                   {
    // The first entry on the stack is the "global" frame before we enter main, so offset our index
    // by one to account for it.
    ++stackFrameIndex;
    if (stackFrameIndex <= 0 || (size_t)stackFrameIndex >= fStack.size()) {
        SkDEBUGFAILF("stack frame %d doesn't exist", stackFrameIndex - 1);
        return {};
    }
    return this->getVariablesForDisplayMask(fStack[stackFrameIndex].fDisplayMask);
}

getStackDepth()

int SkSL::SkSLDebugTracePlayer::getStackDepth

(

)

const

Returns the size of the call stack.

Definition at line 149 of file SkSLDebugTracePlayer.cpp.

                                              {
    SkASSERT(!fStack.empty());
    return fStack.size() - 1;
}

removeBreakpoint()

void SkSL::SkSLDebugTracePlayer::removeBreakpoint

(

int

line

)

Definition at line 135 of file SkSLDebugTracePlayer.cpp.

                                                    {
    fBreakpointLines.erase(line);
}

reset()

void SkSL::SkSLDebugTracePlayer::reset

(

sk_sp< DebugTracePriv >

trace

)

Resets playback to the start of the trace. Breakpoints are not cleared.

Definition at line 18 of file SkSLDebugTracePlayer.cpp.

                                                                 {
    size_t nslots = debugTrace ? debugTrace->fSlotInfo.size() : 0;
    fDebugTrace = debugTrace;
    fCursor = 0;
    fScope = 0;
    fSlots.clear();
    fSlots.resize(nslots, {/*fValue=*/0,
                           /*fScope=*/INT_MAX,
                           /*fWriteTime=*/0});
    fStack.clear();
    fStack.push_back({/*fFunction=*/-1,
                      /*fLine=*/-1,
                      /*fDisplayMask=*/SkBitSet(nslots)});
    fDirtyMask.emplace(nslots);
    fReturnValues.emplace(nslots);
 
    if (fDebugTrace) {
        for (size_t slotIdx = 0; slotIdx < nslots; ++slotIdx) {
            if (fDebugTrace->fSlotInfo[slotIdx].fnReturnValue >= 0) {
                fReturnValues->set(slotIdx);
            }
        }
 
        for (const TraceInfo& trace : fDebugTrace->fTraceInfo) {
            if (trace.op == TraceInfo::Op::kLine) {
                fLineNumbers[trace.data[0]] += 1;
            }
        }
    }
}

run()

void SkSL::SkSLDebugTracePlayer::run

(

)

Advances the simulation until we hit a breakpoint, or the trace completes.

Definition at line 84 of file SkSLDebugTracePlayer.cpp.

                               {
    this->tidyState();
    while (!this->traceHasCompleted()) {
        if (this->execute(fCursor++)) {
            if (this->atBreakpoint()) {
                break;
            }
        }
    }
}

setBreakpoints()

void SkSL::SkSLDebugTracePlayer::setBreakpoints

(

std::unordered_set< int >

breakpointLines

)

Breakpoints will force the simulation to stop whenever a desired line is reached.

Definition at line 127 of file SkSLDebugTracePlayer.cpp.

                                                                               {
    fBreakpointLines = std::move(breakpointLines);
}

step()

void SkSL::SkSLDebugTracePlayer::step

(

)

Advances the simulation to the next Line op.

Definition at line 49 of file SkSLDebugTracePlayer.cpp.

                                {
    this->tidyState();
    while (!this->traceHasCompleted()) {
        if (this->execute(fCursor++)) {
            break;
        }
    }
}

stepOut()

void SkSL::SkSLDebugTracePlayer::stepOut

(

)

Advances the simulation until we exit from the current stack frame. Breakpoints will also stop the simulation even if we haven't left the stack frame.

Definition at line 71 of file SkSLDebugTracePlayer.cpp.

                                   {
    this->tidyState();
    size_t initialStackDepth = fStack.size();
    while (!this->traceHasCompleted()) {
        if (this->execute(fCursor++)) {
            bool hasEscapedFromInitialStackDepth = (fStack.size() < initialStackDepth);
            if (hasEscapedFromInitialStackDepth || this->atBreakpoint()) {
                break;
            }
        }
    }
}

stepOver()

void SkSL::SkSLDebugTracePlayer::stepOver

(

)

Advances the simulation to the next Line op, skipping past matched Enter/Exit pairs. Breakpoints will also stop the simulation even if we haven't reached an Exit.

Definition at line 58 of file SkSLDebugTracePlayer.cpp.

                                    {
    this->tidyState();
    size_t initialStackDepth = fStack.size();
    while (!this->traceHasCompleted()) {
        bool canEscapeFromThisStackDepth = (fStack.size() <= initialStackDepth);
        if (this->execute(fCursor++)) {
            if (canEscapeFromThisStackDepth || this->atBreakpoint()) {
                break;
            }
        }
    }
}

traceHasCompleted()

bool SkSL::SkSLDebugTracePlayer::traceHasCompleted

(

)

const

Returns true if we have reached the end of the trace.

Definition at line 105 of file SkSLDebugTracePlayer.cpp.

                                                   {
    return !fDebugTrace || fCursor >= fDebugTrace->fTraceInfo.size();
}

---

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

• third_party/skia/src/sksl/tracing/SkSLDebugTracePlayer.h
• third_party/skia/src/sksl/tracing/SkSLDebugTracePlayer.cpp