log.h

Go to the documentation of this file.

#pragma once
 
#include <sys/defs.h>
 
#include <boot/boot_info.h>
 
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <sys/fs.h>
#include <sys/math.h>
#include <sys/proc.h>
 
/**
 * @brief Kernel logging and debugging.
 * @defgroup kernel_log Logging Subsystem
 * @ingroup kernel
 *
 * @{
 */
 
/**
 * @brief Maximum buffer size for various logging buffers.
 */
#define LOG_MAX_BUFFER 0x1000
 
/**
 * @brief Log levels.
 */
typedef enum
{
    LOG_LEVEL_DEBUG,
    LOG_LEVEL_USER,
    LOG_LEVEL_INFO,
    LOG_LEVEL_WARN,
    LOG_LEVEL_ERR,
    LOG_LEVEL_PANIC,
} log_level_t;
 
/**
 * @brief Initialize the logging system.
 */
void log_init(void);
 
/**
 * @brief Expose kernel logs via the `/dev/klog` file.
 */
void log_expose(void);
 
/**
 * @brief Print a unformatted log message.
 *
 * @warning See `log_vprint()` regarding the log lock and `LOG_LEVEL_PANIC`.
 *
 * @param level The log level.
 * @param string The message string.
 * @param length The length of the message.
 */
void log_nprint(log_level_t level, const char* string, uint64_t length);
 
/**
 * @brief Print a formatted log message.
 *
 * @warning See `log_vprint()` regarding the log lock and `LOG_LEVEL_PANIC`.
 *
 * @param level The log level.
 * @param format The format string.
 * @param ... The format arguments.
 */
void log_print(log_level_t level, const char* format, ...);
 
/**
 * @brief Print a formatted log message with a va_list.
 *
 * @warning If the log level is `LOG_LEVEL_PANIC`, this function will not acquire the log lock to avoid recursive
 * panics. Its up to the panic system to ensure all other CPUs are halted before calling this.
 *
 * @param level The log level.
 * @param format The format string.
 * @param args The va_list of arguments.
 */
void log_vprint(log_level_t level, const char* format, va_list args);
 
#ifndef NDEBUG
#define LOG_DEBUG(format, ...) log_print(LOG_LEVEL_DEBUG, format __VA_OPT__(, ) __VA_ARGS__)
#else
#define LOG_DEBUG(format, ...) ((void)0)
#endif
 
#define LOG_USER(format, ...) log_print(LOG_LEVEL_USER, format __VA_OPT__(, ) __VA_ARGS__)
#define LOG_INFO(format, ...) log_print(LOG_LEVEL_INFO, format __VA_OPT__(, ) __VA_ARGS__)
#define LOG_WARN(format, ...) log_print(LOG_LEVEL_WARN, format __VA_OPT__(, ) __VA_ARGS__)
#define LOG_ERR(format, ...) log_print(LOG_LEVEL_ERR, format __VA_OPT__(, ) __VA_ARGS__)
#define LOG_PANIC(format, ...) log_print(LOG_LEVEL_PANIC, format __VA_OPT__(, ) __VA_ARGS__)
 
/** @} */