#include "temu-c/Support/Attributes.h"
#include "temu-c/Support/Objsys.h"
#include <stdarg.h>
#include <stdio.h>

Include dependency graph for Logging.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	temu_logDebug temu_logDebugFunc

#define	teLC_FirstUserCat 8

#define	teLC_DefaultCat 0

#define	teLC_SimCat 1

#define	teLC_TargetCat 2

#define	teLC_ConfigCat 3

Typedefs
typedef enum temu_LogLevel	temu_LogLevel

Enumerations
enum	temu_LogLevel { teLL_Fatal = 0, teLL_Error, teLL_Warning, teLL_Info, teLL_Trace, teLL_Debug }

Functions
TEMU_API void	temu_logSetLevel (temu_LogLevel LogLevel)

TEMU_API void	temu_logSetFunc (void(LogFunc)(const char ))

TEMU_API void	temu_logSetAdvancedFunc (void(LogFunc)(void , temu_Object , unsigned, temu_LogLevel, const char ), void *UserData)

TEMU_API void	temu_logSetDefaultFile (FILE *FP)

TEMU_API void	temu_logSetColour (int Enable)

TEMU_API void	temu_logFatal (const void Obj, const char Msg,...) __attribute__((noreturn)) __attribute__((format(printf

TEMU_API void TEMU_API void	temu_logError (const void Obj, const char Msg,...) __attribute__((format(printf

TEMU_API void TEMU_API void TEMU_API void	temu_logWarning (const void Obj, const char Msg,...) __attribute__((format(printf

TEMU_API void TEMU_API void TEMU_API void TEMU_API void	temu_logInfo (const void Obj, const char Msg,...) __attribute__((format(printf

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void	temu_logTrace (const void Obj, const char Msg,...) __attribute__((format(printf

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void	temu_logDebugFunc (const void Obj, const char Msg,...) __attribute__((format(printf

TEMU_API void	temu_logToCategoryVA (const void Obj, unsigned Category, temu_LogLevel Severity, const char Msg, va_list Args)

TEMU_API void	temu_logSetSeverity (void *Obj, unsigned Category, temu_LogLevel Severity)

TEMU_API void	temu_logToCategory (const void Obj, unsigned Category, temu_LogLevel Severity, const char Msg,...) __attribute__((format(printf

TEMU_API void TEMU_API void	temu_logSimFatal (const void Obj, const char Msg,...) __attribute__((noreturn)) __attribute__((format(printf

TEMU_API void TEMU_API void TEMU_API void	temu_logSimError (const void Obj, const char Msg,...) __attribute__((format(printf

TEMU_API void TEMU_API void TEMU_API void TEMU_API void	temu_logSimWarning (const void Obj, const char Msg,...) __attribute__((format(printf

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void	temu_logSimInfo (const void Obj, const char Msg,...) __attribute__((format(printf

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void	temu_logTargetFatal (const void Obj, const char Msg,...) __attribute__((noreturn)) __attribute__((format(printf

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void	temu_logTargetError (const void Obj, const char Msg,...) __attribute__((format(printf

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void	temu_logTargetWarning (const void Obj, const char Msg,...) __attribute__((format(printf

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void	temu_logTargetInfo (const void Obj, const char Msg,...) __attribute__((format(printf

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void	temu_logConfigFatal (const void Obj, const char Msg,...) __attribute__((noreturn)) __attribute__((format(printf

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void	temu_logConfigError (const void Obj, const char Msg,...) __attribute__((format(printf

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void	temu_logConfigWarning (const void Obj, const char Msg,...) __attribute__((format(printf

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void	temu_logConfigInfo (const void Obj, const char Msg,...) __attribute__((format(printf

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API temu_LogLevel	temu_objectGetLogLevel (void *Obj, unsigned Category)

TEMU_API void	temu_objectSetLogLevel (void *Obj, unsigned Category, temu_LogLevel LogLevel)

Detailed Description

TEMU logging functions. TEMU provides a logging facility to log messages from models. These messages can be of a number of severity levels and will be assigned to a model object. When printing the message will be formatted as follows: "<severity> : <object> : message\n", where <severity> is one of debug, info, warning, error and critical and <object> is the name of the object generating the log message.

TEMU provides a "critical" log message, these messages are critical in the sense that after they have been logged, the emulator will terminate abnormally. Critical messages should never happen normally are typically placed in unreachable code locations.

Error messages imply that something failed but that the caller of the failed function is expected to take action in some way. Typical case is when opening a file (e.g. an SREC or ELF binary) specified by the user and the file did not exist.

Warning message exist to notify the user about something that may be an issue, but not necessarily is. An example is in the object system temu_checkSanity function, which will check whether objects are properly configured by being fully connected.

Info messages are normal messages, that exist solely to provide information to the user. For example, a model may print status info after it has been created.

Debug messages should not occur during normal use, and the debug function will be a static inline function with no body when building a model with -DNDEBUG. This is important, because the compiler will eliminate the call to the empty function, while still remaining fully typesafe and NOT being a macro.

Macro Definition Documentation

◆ teLC_ConfigCat

#define teLC_ConfigCat 3

◆ teLC_DefaultCat

#define teLC_DefaultCat 0

◆ teLC_FirstUserCat

#define teLC_FirstUserCat 8

◆ teLC_SimCat

#define teLC_SimCat 1

◆ teLC_TargetCat

#define teLC_TargetCat 2

◆ temu_logDebug

#define temu_logDebug temu_logDebugFunc

Typedef Documentation

◆ temu_LogLevel

typedef enum temu_LogLevel temu_LogLevel

Logging levels corresponds roughly to some of the RFC 5424 severity levels.

Enumeration Type Documentation

◆ temu_LogLevel

enum temu_LogLevel

Logging levels corresponds roughly to some of the RFC 5424 severity levels.

Enumerator
teLL_Fatal	Fatal, emulator cannot keep on running.
teLL_Error	Error happened, in principle critical but up to user.
teLL_Warning	Warnings.
teLL_Info	Normal messages.
teLL_Trace	Trace messages, not compiled away.
teLL_Debug	Debug.

Function Documentation

◆ temu_logConfigError()

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void temu_logConfigError	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log configuration error

Parameters

Obj	Object
Msg	Printf formatted message string

◆ temu_logConfigFatal()

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void temu_logConfigFatal	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log configuration fatal error

Parameters

Obj	Object
Msg	Printf formatted message string

◆ temu_logConfigInfo()

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void temu_logConfigInfo	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log configuration info

Parameters

Obj	Object
Msg	Printf formatted message string

◆ temu_logConfigWarning()

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void temu_logConfigWarning	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log configuration warning

Parameters

Obj	Object
Msg	Printf formatted message string

◆ temu_logDebugFunc()

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void temu_logDebugFunc	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log a message with debug severity

Warning: This function is intended for internal use only. Do not call this directly. Use temu_logDebug() instead.

Parameters

Obj	is the source of the log message
Msg	The message to log

◆ temu_logError()

TEMU_API void TEMU_API void temu_logError	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log a message with error severity

Parameters

Obj	is the source of the log message
Msg	The message to log

◆ temu_logFatal()

TEMU_API void temu_logFatal	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log a message with fatal severity; The program will terminate after calling this

Parameters

Obj	is the source of the log message
Msg	The message to log

◆ temu_logInfo()

TEMU_API void TEMU_API void TEMU_API void TEMU_API void temu_logInfo	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log a message with info severity

Parameters

Obj	is the source of the log message
Msg	The message to log

◆ temu_logSetAdvancedFunc()

TEMU_API void temu_logSetAdvancedFunc	(	void()(void , temu_Object , unsigned, temu_LogLevel, const char )	LogFunc,
		void *	UserData
	)

Set advanced logging function.

It is possible to provide a custom function for handling logging messages from TEMU. This can be used by a simulator that provides a centralized logging facility to also handle TEMU logging messages. By default, the messages will be printed to stderr using fputs.

The advanced logging function does not get messages with a terminating linefeed. In addition, the function receives the object, category and log level as its own parameters.

The message does not contain object name / time stamps. The integrator would be expected to extract the time stamp from the objects time source if set.

LogFunc will take the following parameters:

User data:: Void pointer passed to UserData parameter (may be NULL). Object pointer:: Pointer to object issuing the log message (may be NULL). Category:: Category id of log message. Log level:: Severity of logging message. Message:: The log message, as a '\0' terminated string.

Parameters

LogFunc	Logging function to use. NULL to restore the default.
UserData	User data to pass to the logging functions first parameter.

◆ temu_logSetColour()

TEMU_API void temu_logSetColour ( int Enable )

Enable colours on logging

Parameters

Enable 0 to disable colours, 1 to enable

◆ temu_logSetDefaultFile()

TEMU_API void temu_logSetDefaultFile ( FILE * FP )

Set the logging file for the default logging function. Pass NULL to restore default (stderr).

Parameters

FP	Logging file pointer, NULL to restore default.

◆ temu_logSetFunc()

TEMU_API void temu_logSetFunc ( void(*)(const char *) LogFunc )

Set logging function.

It is possible to provide a custom function for handling logging messages from TEMU. This can be used by a simulator that provides a centralized logging facility to also handle TEMU logging messages. By default, the messages will be printed to stderr using fputs. Note that messages will be terminated by "\n\0", so if your logging system adds a linefeed, the message may need to be transformed.

Parameters

LogFunc Logging function to use. NULL to restore the default.

◆ temu_logSetLevel()

TEMU_API void temu_logSetLevel ( temu_LogLevel LogLevel )

Set logging level. Messages will be logged if they are of the set level or higher priority.

Parameters

LogLevel The logging level.

◆ temu_logSetSeverity()

TEMU_API void temu_logSetSeverity	(	void *	Obj,
		unsigned	Category,
		temu_LogLevel	Severity
	)

Set severity for specific category.

Parameters

Obj	Object for which to modify logging severity
Category	Category to change severity for (e.g. teLC_DefaultCat)
Severity	The log level for which messages shall be emitted.

◆ temu_logSimError()

TEMU_API void TEMU_API void TEMU_API void temu_logSimError	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log simulation error

Parameters

Obj	Object
Msg	Printf formatted message string

◆ temu_logSimFatal()

TEMU_API void TEMU_API void temu_logSimFatal	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log fatal issue Fatal messages result in termination of the program after the message.

Parameters

Obj	Object
Msg	Printf formatted message string

◆ temu_logSimInfo()

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void temu_logSimInfo	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log simulation info

Parameters

Obj	Object
Msg	Printf formatted message string

◆ temu_logSimWarning()

TEMU_API void TEMU_API void TEMU_API void TEMU_API void temu_logSimWarning	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log simulation warning

Parameters

Obj	Object
Msg	Printf formatted message string

◆ temu_logTargetError()

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void temu_logTargetError	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log target error

Parameters

Obj	Object
Msg	Printf formatted message string

◆ temu_logTargetFatal()

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void temu_logTargetFatal	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log target fatal error This should typically never happen, but it may be convenient in some cases.

Parameters

Obj	Object
Msg	Printf formatted message string

◆ temu_logTargetInfo()

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void temu_logTargetInfo	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log target info

Parameters

Obj	Object
Msg	Printf formatted message string

◆ temu_logTargetWarning()

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void temu_logTargetWarning	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log target warning

Parameters

Obj	Object
Msg	Printf formatted message string

◆ temu_logToCategory()

TEMU_API void temu_logToCategory	(	const void *	Obj,
		unsigned	Category,
		temu_LogLevel	Severity,
		const char *	Msg,
			...
	)

Log message in the numbered category

Parameters

Obj	Object that is the source of the log message
Category	Category of message (e.g. `teLC_DefaultCat`)
Severity	The log level for which the message shall be emitted.
Msg	Printf formatted message string.

◆ temu_logToCategoryVA()

TEMU_API void temu_logToCategoryVA	(	const void *	Obj,
		unsigned	Category,
		temu_LogLevel	Severity,
		const char *	Msg,
		va_list	Args
	)

◆ temu_logTrace()

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void temu_logTrace	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log a message with trace severity

Parameters

Obj	is the source of the log message
Msg	The message to log

◆ temu_logWarning()

TEMU_API void TEMU_API void TEMU_API void temu_logWarning	(	const void *	Obj,
		const char *	Msg,
			...
	)

Log a message with warning severity

Parameters

Obj	is the source of the log message
Msg	The message to log

◆ temu_objectGetLogLevel()

TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API void TEMU_API temu_LogLevel temu_objectGetLogLevel	(	void *	Obj,
		unsigned	Category
	)

Get object specific logging level for category

Parameters

Obj	Object
Category	Category

Returns: Logging level for the given Category

◆ temu_objectSetLogLevel()

TEMU_API void temu_objectSetLogLevel	(	void *	Obj,
		unsigned	Category,
		temu_LogLevel	LogLevel
	)

Set object specific logging level for category

Parameters

Obj	Object
Category	Category
LogLevel	Level to set for the given `Category`

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ teLC_ConfigCat

◆ teLC_DefaultCat

◆ teLC_FirstUserCat

◆ teLC_SimCat

◆ teLC_TargetCat

◆ temu_logDebug

Typedef Documentation

◆ temu_LogLevel

Enumeration Type Documentation

◆ temu_LogLevel

Function Documentation

◆ temu_logConfigError()

◆ temu_logConfigFatal()

◆ temu_logConfigInfo()

◆ temu_logConfigWarning()

◆ temu_logDebugFunc()

◆ temu_logError()

◆ temu_logFatal()

◆ temu_logInfo()

◆ temu_logSetAdvancedFunc()

◆ temu_logSetColour()

◆ temu_logSetDefaultFile()

◆ temu_logSetFunc()

◆ temu_logSetLevel()

◆ temu_logSetSeverity()

◆ temu_logSimError()

◆ temu_logSimFatal()

◆ temu_logSimInfo()

◆ temu_logSimWarning()

◆ temu_logTargetError()

◆ temu_logTargetFatal()

◆ temu_logTargetInfo()

◆ temu_logTargetWarning()

◆ temu_logToCategory()

◆ temu_logToCategoryVA()

◆ temu_logTrace()

◆ temu_logWarning()

◆ temu_objectGetLogLevel()

◆ temu_objectSetLogLevel()