UEFIStarter/logger_8h_source.html

 #ifndef __LOGGER_H
 #define __LOGGER_H

 #include <Uefi.h>

 #define TRACE_HERE LOG.trace(L"%a#%d",__FILE__,__LINE__);

 #define ON_ERROR_WARN(TEXT) if(result!=EFI_SUCCESS) LOG.warn(TEXT);

 #define ON_ERROR_RETURN(TEXT,RV) if(result!=EFI_SUCCESS) \
   { \
     LOG.error(L"%s() returned status %d (%r)",TEXT,result,result); \
     return RV; \
   }


 typedef enum
 {
   OFF=0,
   ERROR,
   WARN,
   INFO,
   DEBUG,
   TRACE
 } LOGLEVEL;

 extern const CHAR16 *logger_level_names[];


 typedef void logger_print_function_t(LOGLEVEL level, CHAR16 *msg);

 typedef void EFIAPI logger_function_t(UINT16 *fmt, ...);

 typedef struct
 {
   logger_function_t *trace;
   logger_function_t *debug;
   logger_function_t *info;
   logger_function_t *warn;
   logger_function_t *error;
 } loggers_t;

 extern const loggers_t LOG;


 LOGLEVEL get_log_level();
 LOGLEVEL set_log_level(LOGLEVEL level);

 void reset_logger_entry_counts();
 UINTN get_logger_entry_count(LOGLEVEL level);

 void kill();

 logger_print_function_t *set_logger_function(logger_print_function_t *func);

 #endif
WARN
warnings: something may have broken
Definition: logger.h:46

set_logger_function
logger_print_function_t * set_logger_function(logger_print_function_t *func)
Sets a new log writer.
Definition: logger.c:191

set_log_level
LOGLEVEL set_log_level(LOGLEVEL level)
Sets a new log level.
Definition: logger.c:43

get_logger_entry_count
UINTN get_logger_entry_count(LOGLEVEL level)
Gets a log level&#39;s message count.
Definition: logger.c:164

LOG
const loggers_t LOG
The global logging facility.
Definition: logger.c:139

loggers_t::info
logger_function_t * info
logger for INFO level
Definition: logger.h:76

logger_function_t
void EFIAPI logger_function_t(UINT16 *fmt,...)
function pointer for logging functions to be invoked directly
Definition: logger.h:69

DEBUG
debug messages: something breaks and I&#39;m trying to fix it
Definition: logger.h:48

TRACE
trace messages: something breaks and I don&#39;t know what or where
Definition: logger.h:49

ERROR
error messages: something definitely broke
Definition: logger.h:45

kill
void kill()
Immediately halts the UEFI environment.
Definition: logger.c:179

LOGLEVEL
LOGLEVEL
the list of log levels
Definition: logger.h:42

loggers_t::error
logger_function_t * error
logger for ERROR level
Definition: logger.h:78

loggers_t::warn
logger_function_t * warn
logger for WARN level
Definition: logger.h:77

logger_print_function_t
void logger_print_function_t(LOGLEVEL level, CHAR16 *msg)
function pointer for log output functions
Definition: logger.h:61

OFF
disable logging: la-la-la, I can&#39;t hear you
Definition: logger.h:44

reset_logger_entry_counts
void reset_logger_entry_counts()
Resets all log levels&#39; message counts.
Definition: logger.c:151

INFO
informative messages: just in case something breaks
Definition: logger.h:47

loggers_t::trace
logger_function_t * trace
logger for TRACE level
Definition: logger.h:74

loggers_t
logging facility data type, contains logging function pointer for each log level
Definition: logger.h:72

logger_level_names
const CHAR16 * logger_level_names[]
list of log level&#39;s printable names
Definition: logger.c:17

loggers_t::debug
logger_function_t * debug
logger for DEBUG level
Definition: logger.h:75

get_log_level
LOGLEVEL get_log_level()
Fetches the current log level.
Definition: logger.c:31