mutek/printk.h header reference
[Kernel services module]

The source code of this header can be browsed online.

Description  

Debugging messages output API

Members  

Types  

Functions  

  • void hexdumpk(uintptr_t address, const void *data, size_t len)
  • void logk_set_filter(struct printk_backend_s *backend, const char id[4], enum logk_level_e level)
  • ssize_t printk(const char *format, ...)
  • void printk_register(struct printk_backend_s *s, printk_handler_t *handler)
  • void printk_unregister(struct printk_backend_s *s)
  • ssize_t vprintk(const char *format, va_list ap)
  • void writek(const char *data, size_t len)
  • ssize_t logk_(const char *format, ...)
  • ssize_t vlogk_(const char *format, va_list ap)

Macros  

Members detail  

#define GCT_CONTAINER_ALGO_printk_backend  

This macro is declared in mutek/printk.h source file, line 17.

#define GCT_CONTAINER_LOCK_printk_backend  

This macro is declared in mutek/printk.h source file, line 18.

#define LOGK_MODULE_ID  

This macro is declared in mutek/printk.h source file, line 22.

A four characters logk module id defined for the current compilation unit.

Preprocessor condition: not defined( LOGK_MODULE_ID )

#define MUTEK_PRINTK_H_  

This macro is declared in mutek/printk.h source file, line 8.

#define PRINTK_HANDLER(n)  

This macro is declared in mutek/printk.h source file, line 42.

See also printk_handler_t.

#define PRINTK_RET(val, ...)  

This macro is declared in mutek/printk.h source file, line 174.

silently ignore calls to these functions when printk is disabled.

void hexdumpk(uintptr_t address, const void *data, size_t len)  

This function prints a binary memory dump of memory to the backends. Output is terminal-protected (all characters between ascii(0) and ascii(31) are replaced by "." in output).

Address appearing on the side of the dump can be defined.

Output is not filtered according to the log level.

This is available when CONFIG_MUTEK_PRINTK_HEXDUMP is defined.

#define hexdumpk(...)  

This macro is declared in mutek/printk.h source file, line 169.

silently ignore calls to these functions when printk is disabled.

Preprocessor condition: not defined( CONFIG_MUTEK_PRINTK )

#define logk(format...)  

This macro is declared in mutek/printk.h source file, line 143.

This macro sends a line to the printk backends with the LOGK_LEVEL_NORMAL level

Preprocessor condition: defined( CONFIG_MUTEK_PRINTK )

#define logk(format...)  

This macro is declared in mutek/printk.h source file, line 162.

silently ignore calls to these functions when printk is disabled.

Preprocessor condition: not defined( CONFIG_MUTEK_PRINTK )

#define logk_debug(format...)  

This macro is declared in mutek/printk.h source file, line 139.

This macro sends a line to the printk backends with the LOGK_LEVEL_DEBUG level

Preprocessor condition: defined( CONFIG_MUTEK_PRINTK )

#define logk_debug(format...)  

This macro is declared in mutek/printk.h source file, line 160.

silently ignore calls to these functions when printk is disabled.

Preprocessor condition: not defined( CONFIG_MUTEK_PRINTK )

#define logk_error(format...)  

This macro is declared in mutek/printk.h source file, line 151.

This macro sends a line to the printk backends with the LOGK_LEVEL_ERROR level

Preprocessor condition: defined( CONFIG_MUTEK_PRINTK )

#define logk_error(format...)  

This macro is declared in mutek/printk.h source file, line 166.

silently ignore calls to these functions when printk is disabled.

Preprocessor condition: not defined( CONFIG_MUTEK_PRINTK )

enum logk_level_e  

This enum is declared in mutek/printk.h source file, line 29.

This enum specifies the logk level.

See also logk_set_filter.

IdentifierDescription
LOGK_LEVEL_TRACE
LOGK_LEVEL_DEBUG
LOGK_LEVEL_NORMAL
LOGK_LEVEL_WARNING
LOGK_LEVEL_ERROR

void logk_set_filter(struct printk_backend_s *backend, const char id[4], enum logk_level_e level)  

This function set the logk runtime filtering. Filtering by module is disabled if the id pointer is NULL.

This is available when CONFIG_MUTEK_PRINTK is defined.

See also CONFIG_MUTEK_PRINTK_RUNTIME_LEVEL and CONFIG_MUTEK_PRINTK_RUNTIME_EXPR.

#define logk_trace(format...)  

This macro is declared in mutek/printk.h source file, line 135.

This macro sends a line to the printk backends with the LOGK_LEVEL_TRACE level

Preprocessor condition: defined( CONFIG_MUTEK_PRINTK )

#define logk_trace(format...)  

This macro is declared in mutek/printk.h source file, line 158.

silently ignore calls to these functions when printk is disabled.

Preprocessor condition: not defined( CONFIG_MUTEK_PRINTK )

#define logk_warning(format...)  

This macro is declared in mutek/printk.h source file, line 147.

This macro sends a line to the printk backends with the LOGK_LEVEL_WARNING level

Preprocessor condition: defined( CONFIG_MUTEK_PRINTK )

#define logk_warning(format...)  

This macro is declared in mutek/printk.h source file, line 164.

silently ignore calls to these functions when printk is disabled.

Preprocessor condition: not defined( CONFIG_MUTEK_PRINTK )

ssize_t printk(const char *format, ...)  

This function outputs a formatted string to the backends.

Output is not filtered according to the log level. Use the logk family of functions instead when the intent is to output filtered log entries.

This is available when CONFIG_MUTEK_PRINTK is defined.

See also formatter_printf.

#define printk(...)  

This macro is declared in mutek/printk.h source file, line 167.

silently ignore calls to these functions when printk is disabled.

Preprocessor condition: not defined( CONFIG_MUTEK_PRINTK )

typedef void * printk_backend_entry_t  

This typedef is declared in mutek/printk.h source file, line 58.

typedef struct printk_backend_s * printk_backend_item_t  

This typedef is declared in mutek/printk.h source file, line 58.

typedef void * printk_backend_root_t  

This typedef is declared in mutek/printk.h source file, line 58.

struct printk_backend_s  

This struct is declared in mutek/printk.h source file, line 51.

printk backend entry

See also printk_backend_item_t.

typedef void (printk_handler_t)(struct printk_backend_s *backend, const char *str, size_t len)   

This typedef is declared in mutek/printk.h source file, line 47.

This typedef is the printk backend output handler. It may be called from interrupt context.

This declaration involves expansion of the PRINTK_HANDLER macro.

typedef char printk_module_len_isnt_4_t[-(sizeof("none")!=5)]  

This typedef is declared in mutek/printk.h source file, line 38.

static assert for logk module id len

This declaration involves expansion of the LOGK_MODULE_ID macro.

void printk_register(struct printk_backend_s *s, printk_handler_t *handler)  

This function registers a printk backend

This is available when CONFIG_MUTEK_PRINTK is defined.

void printk_unregister(struct printk_backend_s *s)  

This function unregisters a printk backend

This is available when CONFIG_MUTEK_PRINTK is defined.

#define vlogk(format, ap)  

This macro is declared in mutek/printk.h source file, line 142.

This macro sends a line to the printk backends with the LOGK_LEVEL_NORMAL level

Preprocessor condition: defined( CONFIG_MUTEK_PRINTK )

#define vlogk(format, ap)  

This macro is declared in mutek/printk.h source file, line 161.

silently ignore calls to these functions when printk is disabled.

Preprocessor condition: not defined( CONFIG_MUTEK_PRINTK )

#define vlogk_debug(format, ap)  

This macro is declared in mutek/printk.h source file, line 138.

This macro sends a line to the printk backends with the LOGK_LEVEL_DEBUG level

Preprocessor condition: defined( CONFIG_MUTEK_PRINTK )

#define vlogk_debug(format, ap)  

This macro is declared in mutek/printk.h source file, line 159.

silently ignore calls to these functions when printk is disabled.

Preprocessor condition: not defined( CONFIG_MUTEK_PRINTK )

#define vlogk_error(format, ap)  

This macro is declared in mutek/printk.h source file, line 150.

This macro sends a line to the printk backends with the LOGK_LEVEL_ERROR level

Preprocessor condition: defined( CONFIG_MUTEK_PRINTK )

#define vlogk_error(format, ap)  

This macro is declared in mutek/printk.h source file, line 165.

silently ignore calls to these functions when printk is disabled.

Preprocessor condition: not defined( CONFIG_MUTEK_PRINTK )

#define vlogk_trace(format, ap)  

This macro is declared in mutek/printk.h source file, line 134.

This macro sends a line to the printk backends with the LOGK_LEVEL_TRACE level

Preprocessor condition: defined( CONFIG_MUTEK_PRINTK )

#define vlogk_trace(format, ap)  

This macro is declared in mutek/printk.h source file, line 157.

silently ignore calls to these functions when printk is disabled.

Preprocessor condition: not defined( CONFIG_MUTEK_PRINTK )

#define vlogk_warning(format, ap)  

This macro is declared in mutek/printk.h source file, line 146.

This macro sends a line to the printk backends with the LOGK_LEVEL_WARNING level

Preprocessor condition: defined( CONFIG_MUTEK_PRINTK )

#define vlogk_warning(format, ap)  

This macro is declared in mutek/printk.h source file, line 163.

silently ignore calls to these functions when printk is disabled.

Preprocessor condition: not defined( CONFIG_MUTEK_PRINTK )

ssize_t vprintk(const char *format, va_list ap)  

This is available when CONFIG_MUTEK_PRINTK is defined.

See also printk.

#define vprintk(...)  

This macro is declared in mutek/printk.h source file, line 168.

silently ignore calls to these functions when printk is disabled.

Preprocessor condition: not defined( CONFIG_MUTEK_PRINTK )

void writek(const char *data, size_t len)  

This function write raw data to the current backends. Output is not filtered according to the log level.

This is available when CONFIG_MUTEK_PRINTK is defined.

#define writek(...)  

This macro is declared in mutek/printk.h source file, line 170.

silently ignore calls to these functions when printk is disabled.

Preprocessor condition: not defined( CONFIG_MUTEK_PRINTK )

ssize_t logk_(const char *format, ...)  

This is available when CONFIG_MUTEK_PRINTK is defined.

This function is for internal use only.

See also logk.

#define logk_level_(log_func, level_str, format, ...)  

This macro is declared in mutek/printk.h source file, line 115.

This macro is for internal use only.

ssize_t vlogk_(const char *format, va_list ap)  

This is available when CONFIG_MUTEK_PRINTK is defined.

This function is for internal use only.

See also vlogk.

Valid XHTML 1.0 StrictGenerated by diaxen on Wed Oct 17 21:18:38 2018 using MkDoc