Logging Class Reference

#include <datalogging.h>

Inheritance diagram for Logging:

Collaboration diagram for Logging:

Public Member Functions
	Logging ()=delete
	Logging (const char *name, char *buffer, int bufferSize)
void	reset ()
void	appendFast (const char *text)
void	appendPrintf (const char *fmt,...) __attribute__((format(printf
void void	appendFloat (float value, int precision)
void	terminate ()
void	appendChar (char c)
size_t	loggingSize () const
size_t	remainingSize () const

Data Fields
const char *const	name = nullptr
char *const	buffer = nullptr
const int	bufferSize = 0
char *	linePointer = nullptr

Detailed Description

Definition at line 17 of file datalogging.h.

Constructor & Destructor Documentation

Logging() [1/2]

Logging::Logging ( )

delete

Logging() [2/2]

Logging::Logging	(	const char *	name,
		char *	buffer,
		int	bufferSize
	)

Definition at line 133 of file datalogging.cpp.

    : name(p_name)
    , buffer(p_buffer)
    , bufferSize(p_bufferSize)
{
    reset();
}

Here is the call graph for this function:

Member Function Documentation

appendChar()

void Logging::appendChar ( char  c )

inline

This macro breaks the normal zero=termination constraint, please take care of this outside of this function

Definition at line 40 of file datalogging.h.

                            {
        *linePointer = c;
        linePointer++;
    }

Referenced by WaveChart::addEvent3().

Here is the caller graph for this function:

appendFast()

void Logging::appendFast

(

const char *

text

)

Note

This method if fast because it does not validate much, be sure what you are doing

Definition at line 73 of file datalogging.cpp.

                                         {
    char *s = linePointer;
    while ((*s++ = *text++) != 0)
        ;
    linePointer = s - 1;
}

Referenced by WaveChart::addEvent3().

Here is the caller graph for this function:

appendFloat()

void Logging::appendFloat	(	float	value,
		int	precision
	)

todo: #1 this implementation is less than perfect todo: #2 The only way to avoid double promotion would probably be using *float instead of float See also http://stackoverflow.com/questions/5522051/printing-a-float-in-c-while-avoiding-variadic-parameter-promotion-to-double

Definition at line 97 of file datalogging.cpp.

                                                    {
    /**
     * todo: #1 this implementation is less than perfect
     * todo: #2 The only way to avoid double promotion would probably be using *float instead of float
     * See also http://stackoverflow.com/questions/5522051/printing-a-float-in-c-while-avoiding-variadic-parameter-promotion-to-double
     */
    switch (precision) {
    case 1:
        appendPrintf("%.1f", value);
        break;
    case 2:
        appendPrintf("%.2f", value);
        break;
    case 3:
        appendPrintf("%.3f", value);
        break;
    case 4:
        appendPrintf("%.4f", value);
        break;
    case 5:
        appendPrintf("%.5f", value);
        break;
    case 6:
        appendPrintf("%.6f", value);
        break;
 
    default:
        appendPrintf("%.2f", value);
    }
}

Referenced by reportWave().

Here is the call graph for this function:

Here is the caller graph for this function:

appendPrintf()

void Logging::appendPrintf	(	const char *	fmt,
			...
	)

Definition at line 80 of file datalogging.cpp.

                                               {
    efiAssertVoid(ObdCode::CUSTOM_APPEND_STACK, hasLotsOfRemainingStack(), "lowstck#4");
 
    size_t available = remainingSize();
 
    va_list ap;
    va_start(ap, fmt);
    size_t written = chvsnprintf(linePointer, available, fmt, ap);
    va_end(ap);
 
    // chvnsprintf returns how many bytes WOULD HAVE been written if it fit,
    // so clip it to the available space if necessary
    linePointer += (written > available) ? available : written;
    // ensure buffer is always null terminated
    buffer[bufferSize - 1] = '\0';
}

Referenced by appendFloat(), printHistogram(), WaveChart::publish(), reportWave(), and WaveChart::reset().

Here is the call graph for this function:

Here is the caller graph for this function:

loggingSize()

size_t Logging::loggingSize ( ) const

inline

Definition at line 45 of file datalogging.h.

                               {
        return (uintptr_t)linePointer - (uintptr_t)buffer;
    }

Referenced by WaveChart::publish(), and remainingSize().

Here is the caller graph for this function:

remainingSize()

size_t Logging::remainingSize ( ) const

inline

Definition at line 49 of file datalogging.h.

                                 {
        return bufferSize - loggingSize();
    }

Referenced by WaveChart::addEvent3(), and appendPrintf().

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

void Logging::reset

(

)

Definition at line 128 of file datalogging.cpp.

                    {
    linePointer = buffer;
    *linePointer = 0;
}

Referenced by Logging(), printHistogram(), WaveChart::reset(), and scheduleLogging().

Here is the caller graph for this function:

terminate()

void Logging::terminate ( )

inline

Definition at line 33 of file datalogging.h.

                     {
        linePointer[0] = '\0';
    }

Referenced by WaveChart::addEvent3().

Here is the caller graph for this function:

Field Documentation

buffer

char* const Logging::buffer = nullptr

Zero-terminated buffer of pending debug message

Unless a larger external buffer is specified, this is just a pointer to DEFAULT_BUFFER

Definition at line 63 of file datalogging.h.

Referenced by appendPrintf(), loggingSize(), reset(), and LogBuffer< TBufferSize >::writeLogger().

bufferSize

const int Logging::bufferSize = 0

Definition at line 64 of file datalogging.h.

Referenced by appendPrintf(), and remainingSize().

linePointer

char* Logging::linePointer = nullptr

This pointer is always pointing at the position within the buffer into which next write operation would append additional data

Definition at line 70 of file datalogging.h.

Referenced by appendChar(), appendFast(), appendPrintf(), loggingSize(), reset(), and terminate().

name

const char* const Logging::name = nullptr

Definition at line 56 of file datalogging.h.

---

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

• util/datalogging.h
• util/datalogging.cpp