d67841a990
The checkstyle utility highlights some minor warnings against the logger
implementation.
Fix these up.
Fixes: edbd2059d8 ("libcamera: Add initial logger")
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
143 lines
3.7 KiB
C++
143 lines
3.7 KiB
C++
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
/*
|
|
* Copyright (C) 2018, Google Inc.
|
|
*
|
|
* log.cpp - Logging infrastructure
|
|
*/
|
|
|
|
#include <cstdio>
|
|
#include <cstdlib>
|
|
#include <ctime>
|
|
#include <iomanip>
|
|
#include <string.h>
|
|
|
|
#include "log.h"
|
|
#include "utils.h"
|
|
|
|
/**
|
|
* \file log.h
|
|
* \brief Logging infrastructure
|
|
*/
|
|
|
|
namespace libcamera {
|
|
|
|
/**
|
|
* \enum LogSeverity
|
|
* Log message severity
|
|
* \var LogDebug
|
|
* Debug message
|
|
* \var LogInfo
|
|
* Informational message
|
|
* \var LogWarning
|
|
* Warning message, signals a potential issue
|
|
* \var LogError
|
|
* Error message, signals an unrecoverable issue
|
|
* \var LogFatal
|
|
* Fatal message, signals an unrecoverable issue and aborts execution
|
|
*/
|
|
|
|
/**
|
|
* \def LOG(severity)
|
|
* \brief Log a message
|
|
*
|
|
* Return an std::ostream reference to which a message can be logged using the
|
|
* iostream API. The \a severity controls whether the message is printed or
|
|
* dropped, depending on the global log level.
|
|
*
|
|
* If the severity is set to Fatal, execution is aborted and the program
|
|
* terminates immediately after printing the message.
|
|
*/
|
|
|
|
/**
|
|
* \def ASSERT(condition)
|
|
* \brief Abort program execution if assertion fails
|
|
*
|
|
* If \a condition is false, ASSERT() logs an error message with the Fatal log
|
|
* level and aborts program execution.
|
|
*
|
|
* If the macro NDEBUG is defined before including log.h, ASSERT() generates no
|
|
* code.
|
|
*
|
|
* Using conditions that have side effects with ASSERT() is not recommended, as
|
|
* these effects would depend on whether NDEBUG is defined or not. Similarly,
|
|
* ASSERT() should not be used to check for errors that can occur under normal
|
|
* conditions as those checks would then be removed when compiling with NDEBUG.
|
|
*/
|
|
|
|
static const char *log_severity_name(LogSeverity severity)
|
|
{
|
|
static const char *const names[] = {
|
|
" DBG",
|
|
" INFO",
|
|
" WARN",
|
|
" ERR",
|
|
"FATAL",
|
|
};
|
|
|
|
if (static_cast<unsigned int>(severity) < ARRAY_SIZE(names))
|
|
return names[severity];
|
|
else
|
|
return "UNKWN";
|
|
}
|
|
|
|
/**
|
|
* \class LogMessage
|
|
* \brief Internal log message representation.
|
|
*
|
|
* The LogMessage class models a single message in the log. It serves as a
|
|
* helper to provide the std::ostream API for logging, and must never be used
|
|
* directly. Use the LOG() macro instead access the log infrastructure.
|
|
*/
|
|
|
|
/**
|
|
* \param fileName The file name where the message is logged from
|
|
* \param line The line number where the message is logged from
|
|
* \param severity The log message severity, controlling how the message will be
|
|
* displayed
|
|
*
|
|
* Create a log message pertaining to line \a line of file \a fileName. The
|
|
* \a severity argument sets the message severity to control whether it will be
|
|
* output or dropped.
|
|
*/
|
|
LogMessage::LogMessage(const char *fileName, unsigned int line,
|
|
LogSeverity severity)
|
|
: severity_(severity)
|
|
{
|
|
/* Log the timestamp, severity and file information. */
|
|
struct timespec timestamp;
|
|
clock_gettime(CLOCK_MONOTONIC, ×tamp);
|
|
msgStream.fill('0');
|
|
msgStream << "[" << timestamp.tv_sec / (60 * 60) << ":"
|
|
<< std::setw(2) << (timestamp.tv_sec / 60) % 60 << ":"
|
|
<< std::setw(2) << timestamp.tv_sec % 60 << "."
|
|
<< std::setw(9) << timestamp.tv_nsec << "]";
|
|
msgStream.fill(' ');
|
|
|
|
msgStream << " " << log_severity_name(severity);
|
|
msgStream << " " << basename(fileName) << ":" << line << " ";
|
|
}
|
|
|
|
LogMessage::~LogMessage()
|
|
{
|
|
msgStream << std::endl;
|
|
|
|
std::string msg(msgStream.str());
|
|
fwrite(msg.data(), msg.size(), 1, stderr);
|
|
fflush(stderr);
|
|
|
|
if (severity_ == LogSeverity::LogFatal)
|
|
std::abort();
|
|
}
|
|
|
|
/**
|
|
* \fn std::ostream& LogMessage::stream()
|
|
*
|
|
* Data is added to a LogMessage through the stream returned by this function.
|
|
* The stream implements the std::ostream API and can be used for logging as
|
|
* std::cout.
|
|
*
|
|
* \return A reference to the log message stream
|
|
*/
|
|
|
|
} /* namespace libcamera */
|