WaveChart Class Reference

rusEfi console sniffer data buffer More...

#include <engine_sniffer.h>

Collaboration diagram for WaveChart:

Public Member Functions
	WaveChart ()
void	init ()
void	addEvent3 (const char *name, const char *msg)
	Register an event for digital sniffer.
void	reset ()
void	startDataCollection ()
void	publishIfFull ()
void	publish ()
bool	isFull () const
bool	isStartedTooLongAgo () const
int	getSize ()

Data Fields
efitick_t	pauseEngineSnifferUntilNt = 0

Private Attributes
Logging	logging
char	timeBuffer [_MAX_FILLER+2]
uint32_t	counter = 0
bool	collectingData = false
efitick_t	startTimeNt = 0
volatile int	isInitialized = false

Detailed Description

rusEfi console sniffer data buffer

Definition at line 35 of file engine_sniffer.h.

Constructor & Destructor Documentation

WaveChart()

WaveChart::WaveChart

(

)

Definition at line 75 of file engine_sniffer.cpp.

                     : logging("wave chart", WAVE_LOGGING_BUFFER, sizeof(WAVE_LOGGING_BUFFER)) {
}

Member Function Documentation

addEvent3()

void WaveChart::addEvent3	(	const char *	name,
		const char *	msg
	)

Register an event for digital sniffer.

We want smaller times within a chart in order to reduce packet size.

todo: migrate to binary fractions in order to eliminate this division? I do not like division

at least that's 32 bit division now

printf is a heavy method, append is used here as a performance optimization

Definition at line 150 of file engine_sniffer.cpp.

                                                            {
#if EFI_TEXT_LOGGING
    ScopePerf perf(PE::EngineSniffer);
    efitick_t nowNt = getTimeNowNt();
 
    if (nowNt < pauseEngineSnifferUntilNt) {
        return;
    }
    if (!getTriggerCentral()->isEngineSnifferEnabled) {
        return;
    }
    if (skipUntilEngineCycle != 0 && getRevolutionCounter() < skipUntilEngineCycle)
        return;
#if EFI_SIMULATOR
    if (!collectingData) {
        return;
    }
#endif
    efiAssertVoid(ObdCode::CUSTOM_ERR_6651, name!=NULL, "WC: NULL name");
 
#if EFI_PROD_CODE
    efiAssertVoid(ObdCode::CUSTOM_ERR_6652, getCurrentRemainingStack() > 32, "lowstck#2c");
#endif /* EFI_PROD_CODE */
 
    efiAssertVoid(ObdCode::CUSTOM_ERR_6653, isInitialized, "chart not initialized");
 
    if (isFull()) {
        return;
    }
 
    // we have multiple threads writing to the same output buffer
    chibios_rt::CriticalSectionLocker csl;
 
    if (counter == 0) {
        startTimeNt = nowNt;
    }
    counter++;
 
    /**
     * We want smaller times within a chart in order to reduce packet size.
     */
    /**
     * todo: migrate to binary fractions in order to eliminate
     * this division? I do not like division
     *
     * at least that's 32 bit division now
     */
    uint32_t diffNt = nowNt - startTimeNt;
    uint32_t time100 = NT2US(diffNt / ENGINE_SNIFFER_UNIT_US);
 
    if (logging.remainingSize() > 35) {
        /**
         * printf is a heavy method, append is used here as a performance optimization
         */
        logging.appendFast(name);
        logging.appendChar(CHART_DELIMETER);
        logging.appendFast(msg);
        logging.appendChar(CHART_DELIMETER);
//      time100 -= startTime100;
 
        itoa10(timeBuffer, time100);
        logging.appendFast(timeBuffer);
        logging.appendChar(CHART_DELIMETER);
        logging.terminate();
    }
#endif /* EFI_TEXT_LOGGING */
}

Here is the call graph for this function:

getSize()

int WaveChart::getSize

(

)

Definition at line 110 of file engine_sniffer.cpp.

                       {
    return counter;
}

Referenced by triggerInfo().

Here is the caller graph for this function:

init()

void WaveChart::init

(

)

Definition at line 78 of file engine_sniffer.cpp.

                     {
    isInitialized = true;
    reset();
}

Referenced by initWaveChart().

Here is the call graph for this function:

Here is the caller graph for this function:

isFull()

bool WaveChart::isFull

(

)

const

Definition at line 106 of file engine_sniffer.cpp.

                             {
    return counter >= engineConfiguration->engineChartSize;
}

Referenced by addEvent3(), and publishIfFull().

Here is the caller graph for this function:

isStartedTooLongAgo()

bool WaveChart::isStartedTooLongAgo

(

)

const

Say at 300rpm we should get at least four events per revolution. That's 300/60*4=20 events per second engineChartSize/20 is the longest meaningful chart.

Definition at line 95 of file engine_sniffer.cpp.

                                          {
    /**
     * Say at 300rpm we should get at least four events per revolution.
     * That's 300/60*4=20 events per second
     * engineChartSize/20 is the longest meaningful chart.
     *
     */
    efidur_t chartDurationNt = getTimeNowNt() - startTimeNt;
    return startTimeNt != 0 && NT2US(chartDurationNt) > engineConfiguration->engineChartSize * 1000000 / 20;
}

Referenced by publishIfFull().

Here is the call graph for this function:

Here is the caller graph for this function:

publish()

void WaveChart::publish

(

)

Definition at line 136 of file engine_sniffer.cpp.

                        {
#if EFI_ENGINE_SNIFFER
    logging.appendPrintf( LOG_DELIMITER);
    waveChartUsedSize = logging.loggingSize();
 
    if (getTriggerCentral()->isEngineSnifferEnabled) {
        scheduleLogging(&logging);
    }
#endif /* EFI_ENGINE_SNIFFER */
}

Referenced by publishIfFull().

Here is the call graph for this function:

Here is the caller graph for this function:

publishIfFull()

void WaveChart::publishIfFull

(

)

Definition at line 129 of file engine_sniffer.cpp.

                              {
    if (isFull() || isStartedTooLongAgo()) {
        publish();
        reset();
    }
}

Referenced by printOverallStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

void WaveChart::reset

(

)

Definition at line 83 of file engine_sniffer.cpp.

                      {
    logging.reset();
    counter = 0;
    startTimeNt = 0;
    collectingData = false;
    logging.appendPrintf( "%s%s", PROTOCOL_ENGINE_SNIFFER, LOG_DELIMITER);
}

Referenced by init(), publishIfFull(), Engine::resetEngineSnifferIfInTestMode(), and resetNow().

Here is the call graph for this function:

Here is the caller graph for this function:

startDataCollection()

void WaveChart::startDataCollection

(

)

Definition at line 91 of file engine_sniffer.cpp.

                                    {
    collectingData = true;
}

Referenced by addEngineSnifferTdcEvent().

Here is the caller graph for this function:

Field Documentation

collectingData

bool WaveChart::collectingData = false

private

We want to avoid visual jitter thus we want the left edge to be aligned https://github.com/rusefi/rusefi/issues/780

Definition at line 59 of file engine_sniffer.h.

Referenced by addEvent3(), reset(), and startDataCollection().

counter

uint32_t WaveChart::counter = 0

private

Definition at line 54 of file engine_sniffer.h.

Referenced by addEvent3(), getSize(), isFull(), and reset().

isInitialized

volatile int WaveChart::isInitialized = false

private

Definition at line 61 of file engine_sniffer.h.

Referenced by addEvent3(), and init().

logging

Logging WaveChart::logging

private

Definition at line 51 of file engine_sniffer.h.

Referenced by addEvent3(), publish(), and reset().

pauseEngineSnifferUntilNt

efitick_t WaveChart::pauseEngineSnifferUntilNt = 0

Definition at line 47 of file engine_sniffer.h.

Referenced by addEvent3(), and Engine::resetEngineSnifferIfInTestMode().

startTimeNt

efitick_t WaveChart::startTimeNt = 0

private

Definition at line 60 of file engine_sniffer.h.

Referenced by addEvent3(), isStartedTooLongAgo(), and reset().

timeBuffer

char WaveChart::timeBuffer[_MAX_FILLER+2]

private

Definition at line 52 of file engine_sniffer.h.

Referenced by addEvent3().

---

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

• development/engine_sniffer.h
• development/engine_sniffer.cpp