A class that handles logging messages to the console and files. More...

#include <logger.h>

Inheritance diagram for MaxOS::Logger:

Public Member Functions
	Logger ()
	Constructs a Logger object and sets it as the active logger.

void	add_log_writer (OutputStream *log_writer)
	Adds an output stream to the logger.

void	disable_log_writer (OutputStream *log_writer)
	Prevents an output stream from being used.

void	enable_log_writer (OutputStream *log_writer)
	Lets an output stream from be used.

void	enable_all_log_writers ()
	Mark all log writes as allowed to output to.

void	set_log_level (LogLevel log_level)
	Sets the log level of the logger.

void	write_char (char c) final
	Writes a character to the logger.

void	printf (const char *format,...)
	Prints a formatted string to the logger (thread safe)

Logger &	operator<< (LogLevel log_level)
	Sets the log level of the logger.

Static Public Member Functions
static void	assert (bool condition, const char *message,...)
	Puts the system into a panic state if the condition is false, printing the message first.

static Logger *	active_logger ()
	Gets the active logger (to be used to modify the logger)

static LogRecord	Out ()
	Gets the active logger.

static LogRecord	ERROR ()
	Gets the active logger for error logs.

static LogRecord	WARNING ()
	Gets the active logger for warnings.

static LogRecord	HEADER ()
	Gets the active logger for headers.

static LogRecord	INFO ()
	Gets the active logger for info logs.

static LogRecord	TEST ()
	Gets the active logger for testing logs.

static LogRecord	DEBUG ()
	Gets the active logger for debug logs.

Friends
class	LogRecord

Detailed Description

A class that handles logging messages to the console and files.

Definition at line 51 of file logger.h.

Constructor & Destructor Documentation

◆ Logger()

Logger::Logger ( )

Constructs a Logger object and sets it as the active logger.

Definition at line 25 of file logger.cpp.

: m_log_writers()
{
 
    s_active_logger = this;
 
    // The following line is generated automatically by the MaxOS build system.
    s_progress_total =                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               15;
 
}

Member Function Documentation

◆ active_logger()

Logger * Logger::active_logger ( )

static

Gets the active logger (to be used to modify the logger)

Returns: The active logger

Definition at line 240 of file logger.cpp.

                              {
    return s_active_logger;
}

Referenced by MaxOS::console::FramebufferConsole::finish(), MaxOS::console::FramebufferConsole::FramebufferConsole(), MaxOS::system::CPU::prepare_for_panic(), and MaxOS::processes::GlobalScheduler::print_running_header().

◆ add_log_writer()

void Logger::add_log_writer ( OutputStream * log_writer )

Adds an output stream to the logger.

Parameters

log_writer The output stream to add

Definition at line 44 of file logger.cpp.

                                                    {
 
    // If the list is not empty
    if (m_log_writer_count >= MAX_LOG_WRITERS)
        return;
 
    // Add the output stream to the list
    m_log_writers[m_log_writer_count] = log_writer;
    m_log_writers_enabled[m_log_writer_count] = true;
    m_log_writer_count++;
 
    // Print the setup info
    *this << LogLevel::INFO << "Logger setup: " << m_log_writer_count << "\n";
    *this << LogLevel::HEADER << "MaxOS v" << VERSION_STRING << " [ build " << BUILD_NUMBER << " ]\n";
 
}

References MaxOS::MAX_LOG_WRITERS.

Referenced by MaxOS::console::FramebufferConsole::FramebufferConsole(), and MaxOS::console::SerialConsole::SerialConsole().

◆ assert()

void Logger::assert	(	bool	condition,
		const char *	message,
			...
	)

static

Puts the system into a panic state if the condition is false, printing the message first.

Parameters

condition	The condition to check if is met
message	The message to print if the condition fails
...	The arguments to format into the string

Definition at line 267 of file logger.cpp.

                                                            {
 
    // If the condition is met then everything is ok
    if (condition)
        return;
 
    va_list parameters;
    va_start(parameters, message);
 
    // Hang the system
    CPU::PANIC(String::formatted(message, parameters).c_str());
}

References MaxOS::system::CPU::PANIC().

◆ DEBUG()

LogRecord Logger::DEBUG ( )

static

Gets the active logger for debug logs.

Returns: The debug logger

Definition at line 204 of file logger.cpp.

                        {
    return LogRecord(*s_active_logger, LogLevel::DEBUG);
}

Referenced by MaxOS::processes::GlobalScheduler::add_process(), MaxOS::processes::GlobalScheduler::add_thread(), MaxOS::hardwarecommunication::AdvancedConfigurationAndPowerInterface::AdvancedConfigurationAndPowerInterface(), MaxOS::hardwarecommunication::AdvancedProgrammableInterruptController::AdvancedProgrammableInterruptController(), MaxOS::hardwarecommunication::Clock::calibrate(), MaxOS::system::CPU::check_nx(), MaxOS::system::Core::Core(), core_main(), MaxOS::console::FramebufferConsole::FramebufferConsole(), MaxOS::system::GlobalDescriptorTable::GlobalDescriptorTable(), MaxOS::system::Core::init_sse(), MaxOS::system::Core::init_tss(), MaxOS::hardwarecommunication::IOAPIC::IOAPIC(), MaxOS::system::GlobalDescriptorTable::load(), MaxOS::processes::GlobalScheduler::load_multiboot_elfs(), MaxOS::hardwarecommunication::LocalAPIC::LocalAPIC(), MaxOS::system::Multiboot::Multiboot(), MaxOS::memory::PhysicalMemoryManager::PhysicalMemoryManager(), MaxOS::memory::PhysicalMemoryManager::reserve(), MaxOS::system::Core::wake_up(), and MaxOS::processes::Process::~Process().

◆ disable_log_writer()

void Logger::disable_log_writer ( OutputStream * log_writer )

Prevents an output stream from being used.

Parameters

log_writer The output stream to stop using

Definition at line 66 of file logger.cpp.

                                                        {
 
    // If the list is empty
    if (m_log_writer_count == 0)
        return;
 
    // Find the output stream in the list
    for (int i = 0; i < m_log_writer_count; i++)
        if (m_log_writers[i] == log_writer)
            m_log_writers_enabled[i] = false;
}

Referenced by MaxOS::console::FramebufferConsole::finish().

◆ enable_all_log_writers()

void Logger::enable_all_log_writers ( )

Mark all log writes as allowed to output to.

Definition at line 99 of file logger.cpp.

                                    {
    for (int i = 0; i < m_log_writer_count; i++)
        if (!m_log_writers_enabled[i])
            m_log_writers_enabled[i] = true;
}

◆ enable_log_writer()

void Logger::enable_log_writer ( OutputStream * log_writer )

Lets an output stream from be used.

Parameters

log_writer The output stream to use

Definition at line 83 of file logger.cpp.

                                                       {
 
    // If the list is empty
    if (m_log_writer_count == 0)
        return;
 
    // Find the output stream in the list
    for (int i = 0; i < m_log_writer_count; i++)
        if (m_log_writers[i] == log_writer)
            m_log_writers_enabled[i] = true;
 
}

◆ ERROR()

LogRecord Logger::ERROR ( )

static

Gets the active logger for error logs.

Returns: The error logger

Definition at line 222 of file logger.cpp.

                        {
    return LogRecord(*s_active_logger, LogLevel::ERROR);
}

Referenced by MaxOS::system::SyscallManager::handle_interrupt(), MaxOS::system::CPU::PANIC(), MaxOS::system::CPU::prepare_for_panic(), MaxOS::system::CPU::print_registers(), and MaxOS::system::CPU::stack_trace().

◆ HEADER()

LogRecord Logger::HEADER ( )

static

Gets the active logger for headers.

Returns: The header logger

Definition at line 231 of file logger.cpp.

                         {
    return LogRecord(*s_active_logger, LogLevel::HEADER);
}

Referenced by MaxOS::console::FramebufferConsole::finish(), and kernel_main().

◆ INFO()

LogRecord Logger::INFO ( )

static

Gets the active logger for info logs.

Returns: The info logger

Definition at line 195 of file logger.cpp.

                       {
    return LogRecord(*s_active_logger, LogLevel::INFO);
}

Referenced by MaxOS::hardwarecommunication::InterruptManager::activate(), MaxOS::hardwarecommunication::AdvancedConfigurationAndPowerInterface::AdvancedConfigurationAndPowerInterface(), MaxOS::hardwarecommunication::AdvancedProgrammableInterruptController::AdvancedProgrammableInterruptController(), MaxOS::hardwarecommunication::Clock::calibrate(), MaxOS::hardwarecommunication::Clock::Clock(), MaxOS::system::CPU::CPU(), MaxOS::console::FramebufferConsole::FramebufferConsole(), MaxOS::processes::GlobalScheduler::GlobalScheduler(), MaxOS::system::CPU::init_cores(), MaxOS::hardwarecommunication::InterruptManager::InterruptManager(), kernel_main(), MaxOS::memory::PhysicalMemoryManager::PhysicalMemoryManager(), MaxOS::system::SyscallManager::syscall_klog(), and MaxOS::system::SyscallManager::SyscallManager().

◆ operator<<()

Logger & Logger::operator<< ( LogLevel log_level )

Sets the log level of the logger.

Parameters

log_level The log level to set

Returns: This logger

Definition at line 286 of file logger.cpp.

                                             {
 
    set_log_level(log_level);
    return *this;
 
}

References set_log_level().

◆ Out()

LogRecord Logger::Out ( )

static

Gets the active logger.

Returns: The active logger

Definition at line 176 of file logger.cpp.

                      {
 
    return LogRecord(*s_active_logger, LogLevel::OUT);
}

Referenced by MaxOS::system::CPU::PANIC(), MaxOS::system::CPU::prepare_for_panic(), and MaxOS::system::SyscallManager::syscall_klog().

◆ printf()

void Logger::printf	(	const char *	format,
			...
	)

Prints a formatted string to the logger (thread safe)

Parameters

format	The format string
...	The arguments to format

Definition at line 250 of file logger.cpp.

                                           {
 
 
    // Create a pointer to the data
    va_list parameters;
    va_start(parameters, format);
 
    write(String::formatted(format, parameters));
}

Referenced by MaxOS::processes::GlobalScheduler::print_running_header().

◆ set_log_level()

void Logger::set_log_level ( LogLevel log_level )

Sets the log level of the logger.

Parameters

log_level The log level to set

Definition at line 110 of file logger.cpp.

                                             {
 
    // Set the log level
    m_log_level = log_level;
 
    // Update the progress bar
    if (log_level == LogLevel::INFO) {
        FramebufferConsole::update_progress_bar((m_progress_current * 100) / s_progress_total);
        m_progress_current++;
    }
 
    // Print the header
    switch (log_level) {
 
        case LogLevel::HEADER:
            *this << ANSI_COLOURS[FG_Blue]   << "[  BOOT    ] ";
            break;
 
        case LogLevel::INFO:
            *this << ANSI_COLOURS[FG_Cyan]   << "[  INFO    ]" << ANSI_COLOURS[FG_White] << " ";
            break;
 
        case LogLevel::TEST:
            *this << ANSI_COLOURS[FG_Green]  << "[  TEST    ]" << ANSI_COLOURS[FG_White] << " ";
            break;
 
        case LogLevel::DEBUG:
            *this << ANSI_COLOURS[FG_Yellow] << "[  DEBUG   ]" << ANSI_COLOURS[Reset] << " ";
            break;
 
        case LogLevel::WARNING:
            *this << ANSI_COLOURS[BG_Yellow] << ANSI_COLOURS[FG_White] << "[ WARNING  ]" << ANSI_COLOURS[Reset] << " ";
            break;
 
        case LogLevel::ERROR:
            *this << ANSI_COLOURS[BG_Red]   << "[  ERROR   ]" << ANSI_COLOURS[Reset] << " ";
            break;
    }
 
    GlobalScheduler::print_running_header();
}

References MaxOS::processes::GlobalScheduler::print_running_header(), and MaxOS::console::FramebufferConsole::update_progress_bar().

Referenced by MaxOS::LogRecord::LogRecord(), and operator<<().

◆ TEST()

LogRecord Logger::TEST ( )

static

Gets the active logger for testing logs.

Returns: The testing logger

Definition at line 186 of file logger.cpp.

                       {
    return LogRecord(*s_active_logger, LogLevel::TEST);
}

◆ WARNING()

LogRecord Logger::WARNING ( )

static

Gets the active logger for warnings.

Returns: The warning logger

Definition at line 213 of file logger.cpp.

                          {
    return LogRecord(*s_active_logger, LogLevel::WARNING);
}

Referenced by MaxOS::hardwarecommunication::LocalAPIC::LocalAPIC(), and MaxOS::system::Core::wake_up().

◆ write_char()

void Logger::write_char ( char c )

final

Writes a character to the logger.

Parameters

c	The character to write

Definition at line 158 of file logger.cpp.

                              {
 
    // Ensure logging at this level is enabled
    if (m_log_level > MAX_LOG_LEVEL)
        return;
 
    // Write the character to all output streams
    for (int i = 0; i < m_log_writer_count; i++)
        if (m_log_writers_enabled[i])
            m_log_writers[i]->write_char(c);
 
}

References MaxOS::MAX_LOG_LEVEL.

Referenced by MaxOS::LogRecord::operator<<().

Friends And Related Symbol Documentation

◆ LogRecord

friend class LogRecord

friend

Definition at line 53 of file logger.h.

The documentation for this class was generated from the following files:

/home/runner/work/MaxOS/MaxOS/kernel/include/common/logger.h
/home/runner/work/MaxOS/MaxOS/kernel/src/common/logger.cpp

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Logger()

Member Function Documentation

◆ active_logger()

◆ add_log_writer()

◆ assert()

◆ DEBUG()

◆ disable_log_writer()

◆ enable_all_log_writers()

◆ enable_log_writer()

◆ ERROR()

◆ HEADER()

◆ INFO()

◆ operator<<()

◆ Out()

◆ printf()

◆ set_log_level()

◆ TEST()

◆ WARNING()

◆ write_char()

Friends And Related Symbol Documentation

◆ LogRecord