ErrlogMacros

#define GETBUFFER_ERRLOG( buffer, size ) GETBUFFER_LOG(log_channel_ERR, buffer, size)

See GETBUFFER_LOG.

#define COMPARE_ERRLOG( size, logbuffer ) COMPARE_LOG(log_channel_ERR, size, logbuffer)

See COMPARE_LOG.

#define CLEARBUFFER_ERRLOG( ) CLEARBUFFER_LOG(log_channel_ERR)

See CLEARBUFFER_LOG.

#define FLUSHBUFFER_ERRLOG( ) FLUSHBUFFER_LOG(log_channel_ERR)

See FLUSHBUFFER_LOG.

#define PRINTF_ERRLOG(     ... ) PRINTF_LOG(log_channel_ERR, log_flags_NONE, 0, __VA_ARGS__)

Logs a generic printf type format string as error.

Parameter

Example

int i ; PRINTF_ERRLOG("%d", i)

#define PRINTTEXT_ERRLOG(     TEXTID,     ... ) do { PRINTTEXT_LOG( log_channel_ERR, log_flags_NONE, 0, TEXTID ## _ERRLOG, __VA_ARGS__) ; } while(0)

Logs an TEXTID from C-kern/resource/errlog.text.  The parameters after TEXTID must match the parameters of the resource TEXTID.

#define PRINTTEXT_USER_ERRLOG(     TEXTID,     ... ) do { PRINTTEXT_LOG( log_channel_USERERR, log_flags_NONE, 0, TEXTID ## _ERRLOG, __VA_ARGS__) ; } while(0)

Logs an TEXTID from C-kern/resource/errlog.text to log_channel_USERERR.  The parameters after TEXTID must match the parameters of the resource TEXTID.

#define TRACEABORT_ERRLOG(     err ) TRACE_NOARG_ERRLOG(log_flags_END|log_flags_OPTIONALHEADER, FUNCTION_ABORT, err)

Logs the abortion of a function and the its corresponding error code.  If a function encounters an error from which it cannot recover it should roll back the system to its previous state before it was called and use

TRACEABORT_ERRLOG(return_error_code)

to signal this fact.

#define TRACEABORTFREE_ERRLOG(     err ) TRACE_NOARG_ERRLOG(log_flags_END|log_flags_OPTIONALHEADER, FUNCTION_ABORT_FREE, err)

Logs that an error occurred during free_XXX or delete_XXX.  This means that not all resources could have been freed only as many as possible.

#define TRACECALL_ERRLOG(     fct_name,     err ) TRACE_ERRLOG(log_flags_START, FUNCTION_CALL, err, fct_name)

Logs reason of failure and name of called app function.  Use this function to log an error in a function which calls a library function which does no logging on its own.

TODO: Support own error IDs

#define TRACEOUTOFMEM_ERRLOG(     size,     err ) TRACE_ERRLOG(log_flags_START, MEMORY_OUT_OF, err, size)

Logs “out of memory” reason for function abort.  If a function could not allocate memory of size bytes and therefore aborts with an error code

TRACEOUTOFMEM_ERRLOG(size_of_memory_in_bytes)

should be called before TRACEABORT_ERRLOG to document the event leading to an abort.

#define TRACESYSCALL_ERRLOG(     sys_fctname,     err ) TRACE_ERRLOG(log_flags_START, FUNCTION_SYSCALL, err, sys_fctname)

Logs reason of failure and name of called system function.  In POSIX compatible systems sys_errno should be set to the C error variable: errno.

#define TRACE_ERRLOG(     FLAGS,     TEXTID,     err,     ... ) TRACE2_ERRLOG(FLAGS, TEXTID, __FUNCTION__, __FILE__, __LINE__, err, __VA_ARGS__)

Logs an TEXTID from C-kern/resource/errlog.text and error number err.  Parameter FLAGS carries additional flags to control the logging process - see log_flags_e.  Any additional arguments are listed after err.  Use TRACE_ERRLOG to log any language specific text with additional parameter values.

#define TRACE2_ERRLOG(     FLAGS,     TEXTID,     funcname,     filename,     linenr,     err,     ... ) do { log_header_t _header = log_header_INIT(funcname, filename, linenr, err) ; PRINTTEXT_LOG(log_channel_ERR, FLAGS, &_header, TEXTID ## _ERRLOG, __VA_ARGS__) ; } while(0)

Logs an TEXTID from C-kern/resource/errlog.text and error number err.

Parameter

#define TRACE_NOARG_ERRLOG(     FLAGS,     TEXTID,     err ) do { log_header_t _header = log_header_INIT(__FUNCTION__, __FILE__, __LINE__, err) ; PRINTTEXT_NOARG_LOG( log_channel_ERR, FLAGS, &_header, TEXTID ## _ERRLOG) ; } while(0)

Logs an TEXTID from C-kern/resource/errlog.text and error number err.  Parameter FLAGS carries additional flags to control the logging process - see log_flags_e.  There are no additional arguments.  Use TRACE_NOARG_ERRLOG to log any language specific text with no parameter values.

#define PRINTARRAYFIELD_ERRLOG(     format,     arrname,     index ) PRINTARRAYFIELD_LOG(log_channel_ERR, format, arrname, index)

Log value of variable stored in array at offset i.  The logged text is “array[i]=value”.

Parameter

Example

This code logs “names[0]=Jo\n” and “names[1]=Jane\n”.

const char * names[] = { "Jo", "Jane" } ;
for(int i = 0; i < 2; ++i) { PRINTARRAYFIELD_ERRLOG("s", names, i) ; }

#define PRINTCSTR_ERRLOG( varname ) PRINTCSTR_LOG(log_channel_ERR, varname)

Log “name=value” of string variable.  Example:

const char * name = "Jo" ; PRINTCSTR_ERRLOG(name) ;

#define PRINTINT_ERRLOG( varname ) PRINTINT_LOG(log_channel_ERR, varname)

Log “name=value” of int variable.  Example:

const int max = 100 ; PRINTINT_ERRLOG(max) ;

#define PRINTINT64_ERRLOG( varname ) PRINTINT64_LOG(log_channel_ERR, varname)

Log “name=value” of int variable.  Example:

const int64_t min = 100 ; PRINTINT64_ERRLOG(min) ;

#define PRINTSIZE_ERRLOG( varname ) PRINTSIZE_LOG(log_channel_ERR, varname)

Log “name=value” of size_t variable.  Example:

const size_t maxsize = 100 ; PRINTSIZE_ERRLOG(maxsize) ;

#define PRINTUINT8_ERRLOG( varname ) PRINTUINT8_LOG(log_channel_ERR, varname)

Log “name=value” of uint8_t variable.  Example:

const uint8_t limit = 255 ; PRINTUINT8_ERRLOG(limit) ;

#define PRINTUINT16_ERRLOG( varname ) PRINTUINT16_LOG(log_channel_ERR, varname)

Log “name=value” of uint16_t variable.  Example:

const uint16_t limit = 65535 ; PRINTUINT16_ERRLOG(limit) ;

#define PRINTUINT32_ERRLOG( varname ) PRINTUINT32_LOG(log_channel_ERR, varname)

Log “name=value” of uint32_t variable.  Example:

const uint32_t max = 100 ; PRINTUINT32_ERRLOG(max) ;

#define PRINTUINT64_ERRLOG( varname ) PRINTUINT64_LOG(log_channel_ERR, varname)

Log “name=value” of uint64_t variable.  Example:

const uint64_t max = 100 ; PRINTUINT64_ERRLOG(max) ;

#define PRINTPTR_ERRLOG( varname ) PRINTPTR_LOG(log_channel_ERR, varname)

Log “name=value” of pointer variable.  Example:

const void * ptr = &g_variable ; PRINTPTR_ERRLOG(ptr) ;

#define PRINTDOUBLE_ERRLOG( varname ) PRINTDOUBLE_LOG(log_channel_ERR, varname)

Log “name=value” of double or float variable.  Example:

const double d = 1.234 ; PRINTDOUBLE_ERRLOG(d) ;