1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
/* 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 */
|
