perf_trace.cpp File Reference

Detailed Description

https://github.com/rusefi/rusefi/wiki/Developer-Performance-Tracing

See JsonOutput.java in rusEfi console

Definition in file perf_trace.cpp.

Enumerations
enum class	EPhase : char { Start , End , InstantThread , InstantGlobal }

Functions
static void	stopTrace ()
static void	perfEventImpl (PE event, EPhase phase)
void	perfEventBegin (PE event)
void	perfEventEnd (PE event)
void	perfEventInstantGlobal (PE event)
void	perfTraceEnable ()
const BigBufferHandle	perfTraceGetBuffer ()

Variables
static BigBufferHandle	s_traceBuffer
static size_t	s_nextIdx = 0
static bool	s_isTracing = false

Enumeration Type Documentation

EPhase

enum class EPhase : char

strong

Enumerator
Start
End
InstantThread
InstantGlobal

Definition at line 15 of file perf_trace.cpp.

{
    Start,
    End,
    InstantThread,
    InstantGlobal,
};

Function Documentation

perfEventBegin()

void perfEventBegin

(

PE

event

)

Definition at line 109 of file perf_trace.cpp.

                              {
    perfEventImpl(event, EPhase::Start);
}

Referenced by irqEnterHook(), and ScopePerf::ScopePerf().

Here is the call graph for this function:

Here is the caller graph for this function:

perfEventEnd()

void perfEventEnd

(

PE

event

)

Definition at line 113 of file perf_trace.cpp.

                            {
    perfEventImpl(event, EPhase::End);
}

Referenced by irqExitHook(), and ScopePerf::~ScopePerf().

Here is the call graph for this function:

Here is the caller graph for this function:

perfEventImpl()

static void perfEventImpl ( PE  event, EPhase  phase  )

static

Definition at line 48 of file perf_trace.cpp.

                                                  {
#if EFI_PROD_CODE
    // Bail if we aren't allowed to trace
    if constexpr (!ENABLE_PERF_TRACE) {
        return;
    }
 
    // Bail if we aren't tracing
    if (!s_isTracing || !s_traceBuffer) {
        return;
    }
 
    // todo: why doesn't getTimeNowLowerNt() work here?
    // It returns 0 like we're in a unit test
    uint32_t timestamp = port_rt_get_counter_value();
 
    size_t idx;
 
    // Critical section: disable interrupts to reserve an index.
    // We could lock, but this gets called a LOT - so locks could
    // significantly alter the results of the measurement.
    // In addition, if we want to trace lock/unlock events, we can't
    // be locking ourselves from the trace functionality.
    {
        uint32_t prim = __get_PRIMASK();
        __disable_irq();
 
        idx = s_nextIdx++;
        if (s_nextIdx >= TRACE_BUFFER_LENGTH) {
            stopTrace();
        }
 
        // Restore previous interrupt state - don't restore if they weren't enabled
        if (!prim) {
            __enable_irq();
        }
    }
 
    // We can safely write data out of the lock, our spot is reserved
    volatile TraceEntry& entry = s_traceBuffer.get<TraceEntry>()[idx];
 
    entry.Event = event;
    entry.Phase = phase;
    // Get the current active interrupt - this is the "process ID"
    auto isr = static_cast<uint8_t>(SCB->ICSR & SCB_ICSR_VECTACTIVE_Msk);
 
    // Get the current thread (if not interrupt) and use as the thread ID
    if (isr == 0) {
        entry.ThreadId = chThdGetSelfX()->threadId;
        entry.IsrId = 0;
    } else {
        entry.IsrId = isr - 16;
 
        // Interrupts have no thread - all are T0
        entry.ThreadId = 0;
    }
 
    entry.Timestamp = timestamp;
#endif // EFI_PROD_CODE
}

Referenced by perfEventBegin(), perfEventEnd(), and perfEventInstantGlobal().

Here is the call graph for this function:

Here is the caller graph for this function:

perfEventInstantGlobal()

void perfEventInstantGlobal

(

PE

event

)

Definition at line 117 of file perf_trace.cpp.

                                      {
    perfEventImpl(event, EPhase::InstantGlobal);
}

Referenced by contextSwitchHook(), onLockHook(), and onUnlockHook().

Here is the call graph for this function:

Here is the caller graph for this function:

perfTraceEnable()

void perfTraceEnable

(

)

Definition at line 121 of file perf_trace.cpp.

                       {
#if EFI_TOOTH_LOGGER
    // force release of the buffer if occupied by the tooth logger
    if (IsToothLoggerEnabled()) {
        // don't worry, it will be automatically enabled
        // when the next TS_GET_COMPOSITE_BUFFER_DONE_DIFFERENTLY command arrives
        DisableToothLogger();
    }
#endif // EFI_TOOTH_LOGGER
    s_traceBuffer = getBigBuffer(BigBufferUser::PerfTrace);
    s_isTracing = true;
}

Referenced by TunerStudio::handleCrcCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

perfTraceGetBuffer()

const BigBufferHandle perfTraceGetBuffer

(

)

Definition at line 134 of file perf_trace.cpp.

                                           {
    // stop tracing if you try to get the buffer early
    stopTrace();
 
    // transfer ownership of the buffer to the caller
    return efi::move(s_traceBuffer);
}

Referenced by TunerStudio::handleCrcCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

stopTrace()

static void stopTrace ( )

static

Definition at line 43 of file perf_trace.cpp.

                        {
    s_isTracing = false;
    s_nextIdx = 0;
}

Referenced by perfEventImpl(), and perfTraceGetBuffer().

Here is the caller graph for this function:

Variable Documentation

s_isTracing

bool s_isTracing = false

static

Definition at line 41 of file perf_trace.cpp.

Referenced by perfEventImpl(), perfTraceEnable(), and stopTrace().

s_nextIdx

size_t s_nextIdx = 0

static

Definition at line 39 of file perf_trace.cpp.

Referenced by perfEventImpl(), and stopTrace().

s_traceBuffer

BigBufferHandle s_traceBuffer

static

Definition at line 38 of file perf_trace.cpp.

Referenced by perfEventImpl(), perfTraceEnable(), and perfTraceGetBuffer().

Go to the source code of this file.