Logging.h

Go to the documentation of this file.

//===-- temu-c/Logging.h - Logging functions --------------------*- C++ -*-===//
//
// T-EMU: The Terma Emulator
// (c) Terma 2015
// Authors: Mattias Holm <maho (at) terma.com>
//
//===----------------------------------------------------------------------===//

#ifndef TEMU_LOGGING_H
#define TEMU_LOGGING_H

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

#ifdef __cplusplus
extern "C" {
#endif


typedef enum temu_LogLevel {
  teLL_Fatal = 0, 
  teLL_Critical = 0, 
  teLL_Error,    
  teLL_Warning,  
  teLL_Info,     
  teLL_Debug,    
} temu_LogLevel;

TEMU_API void temu_logSetLevel(temu_LogLevel LogLevel);

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

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, 2, 3)));

TEMU_API void temu_logCritical(const void *Obj, const char *Msg, ...)
  __attribute__((noreturn))
  __attribute__((format(printf, 2, 3)))
  __attribute__((deprecated));

TEMU_API void temu_logError(const void *Obj, const char *Msg, ...)
  __attribute__((format(printf, 2, 3)));

TEMU_API void temu_logWarning(const void *Obj, const char *Msg, ...)
  __attribute__((format(printf, 2, 3)));

TEMU_API void temu_logInfo(const void *Obj, const char *Msg, ...)
  __attribute__((format(printf, 2, 3)));

TEMU_API void temu_logDebugFunc(const void *Obj, const char *Msg, ...)
  __attribute__((format(printf, 2, 3)));

#ifdef NDEBUG
static inline void
temu_logDebug(const void *Obj TEMU_UNUSED, const char *Msg TEMU_UNUSED, ...)
{
  ; // Nothing
}

#else

#define temu_logDebug temu_logDebugFunc

#endif


/*
 * New logging API
 *
 * The new logging API provides specialised logging for temu_Object
 * derived classes.  They cannot be used by external classes.
 *
 * EXPERIMENTAL API New logging API. The New logging API provides
 * improved logging support.  Among the features include custom
 * logging categories and per device per categor control of the
 * logging.  16 logging categories are supported, of which the first
 * 8 are reserved for T-EMU (i.e. global categories).
 * The next 8 can be controlled per class.
 *
 * The reserved categories is split in three main categories (sim,
 * target and config). These are further subdivided in severity.
 *
 * The config category is used to inform users during the
 * configuration phase or any issues detected with dynamic
 * configuration. For example, a device with an IRQ property may be
 * restricted to e.g. 8 different IRQs, if the user sets another value
 * than the allowed ones then a config error would be logged.
 *
 * The target category is for errors triggered by target software, for
 * example writing a register would be logged with
 * temu_logTargetDebug(). Note that the category is intended for
 * direct effects, which is mostly related to MMIO activity.
 *
 * The sim category is for other errors caused by e.g. invalid use of
 * the T-EMU APIs, or other failures.
 *
 * A nice feature of this API is the support for user definable
 * categories. These categories are per class. But category enabling
 * is controlled per object and globally. A category can be added to a
 * class using temu_addLoggingCategory() (see Objsys.h), and queried
 * by id using temu_getLoggingCategory(). The ID can then be used in
 * calls to temu_logToCategory().
 *
 */

// User reserved categories are those above 8
#define teLC_FirstUserCat  8

#define teLC_DefaultCat 0
#define teLC_SimCat 1
#define teLC_TargetCat 2
#define teLC_ConfigCat 3

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

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

TEMU_API void temu_logSimFatal(const void *Obj, const char *Msg, ...)
  __attribute__((noreturn))
  __attribute__((format(printf, 2, 3)));

TEMU_API void temu_logSimError(const void *Obj, const char *Msg, ...)
  __attribute__((format(printf, 2, 3)));

TEMU_API void temu_logSimWarning(const void *Obj, const char *Msg, ...)
  __attribute__((format(printf, 2, 3)));

TEMU_API void temu_logSimInfo(const void *Obj, const char *Msg, ...)
  __attribute__((format(printf, 2, 3)));

TEMU_API void temu_logTargetFatal(const void *Obj, const char *Msg, ...)
  __attribute__((noreturn))
  __attribute__((format(printf, 2, 3)));


TEMU_API void temu_logTargetError(const void *Obj, const char *Msg, ...)
  __attribute__((format(printf, 2, 3)));

TEMU_API void temu_logTargetWarning(const void *Obj, const char *Msg, ...)
  __attribute__((format(printf, 2, 3)));

TEMU_API void temu_logTargetInfo(const void *Obj, const char *Msg, ...)
  __attribute__((format(printf, 2, 3)));



TEMU_API void temu_logConfigFatal(const void *Obj, const char *Msg, ...)
  __attribute__((noreturn))
  __attribute__((format(printf, 2, 3)));


TEMU_API void temu_logConfigError(const void *Obj, const char *Msg, ...)
  __attribute__((format(printf, 2, 3)));

TEMU_API void temu_logConfigWarning(const void *Obj, const char *Msg, ...)
  __attribute__((format(printf, 2, 3)));

TEMU_API void temu_logConfigInfo(const void *Obj, const char *Msg, ...)
  __attribute__((format(printf, 2, 3)));

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

#ifdef __cplusplus
}
#endif

#endif /* ! TEMU_LOGGING_H */