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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
|
//
// Copyright 2012,2014,2016 Ettus Research LLC
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
#include <uhd/utils/log.hpp>
#include <uhd/utils/static.hpp>
#include <uhd/utils/paths.hpp>
#include <boost/filesystem.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/date_time/posix_time/posix_time.hpp>
#include <boost/thread/locks.hpp>
#include <boost/interprocess/sync/file_lock.hpp>
#include <fstream>
#include <cctype>
namespace fs = boost::filesystem;
namespace pt = boost::posix_time;
namespace ip = boost::interprocess;
static const std::string PURPLE = "\033[35;1m"; // purple
static const std::string BLUE = "\033[34;1m"; // blue
static const std::string GREEN = "\033[32;1m"; // green
static const std::string YELLOW = "\033[33;1m"; // yellow
static const std::string RED = "\033[31;0m"; // red
static const std::string BRED = "\033[31;1m"; // bright red
static const std::string RESET_COLORS = "\033[39;0m"; // reset colors
static const std::string verbosity_color(const uhd::log::severity_level &level){
switch(level){
case (uhd::log::trace):
return PURPLE;
case(uhd::log::debug):
return BLUE;
case(uhd::log::info):
return GREEN;
case(uhd::log::warning):
return YELLOW;
case(uhd::log::error):
return RED;
case(uhd::log::fatal):
return BRED;
default:
return RESET_COLORS;
}
}
/***********************************************************************
* Global resources for the logger
**********************************************************************/
class log_resource_type{
public:
uhd::log::severity_level level;
uhd::log::severity_level file_level;
uhd::log::severity_level console_level;
log_resource_type(void): level(uhd::log::info), file_level(uhd::log::info), console_level(uhd::log::info){
//file lock pointer must be null
_file_lock = NULL;
//default to no file logging
this->file_logging = false;
//set the default log level
this->level = uhd::log::off;
this->file_level = uhd::log::off;
this->console_level = uhd::log::off;
//allow override from macro definition
#ifdef UHD_LOG_MIN_LEVEL
this->level = _get_log_level(BOOST_STRINGIZE(UHD_LOG_MIN_LEVEL), this->level);
#endif
#if defined(UHD_LOG_FILE_LEVEL) && defined(UHD_LOG_FILE_PATH)
this->file_level = _get_log_level(BOOST_STRINGIZE(UHD_LOG_FILE_LEVEL), this->file_level);
#endif
#ifdef UHD_LOG_CONSOLE_LEVEL
this->console_level = _get_log_level(BOOST_STRINGIZE(UHD_LOG_CONSOLE_LEVEL), this->console_level);
#endif
#ifdef UHD_LOG_FILE
this->log_file_target = BOOST_STRINGIZE(UHD_LOG_FILE);
this->file_logging = true;
#endif
//allow override from environment variables
const char * log_level_env = std::getenv("UHD_LOG_LEVEL");
if (log_level_env != NULL && log_level_env[0] != '\0') this->level = _get_log_level(log_level_env, this->level);
const char * log_file_level_env = std::getenv("UHD_LOG_FILE_LEVEL");
if (log_file_level_env != NULL && log_file_level_env[0] != '\0') this->file_level = _get_log_level(log_file_level_env, this->file_level);
const char * log_console_level_env = std::getenv("UHD_LOG_CONSOLE_LEVEL");
if (log_console_level_env != NULL && log_console_level_env[0] != '\0') this->console_level = _get_log_level(log_console_level_env, this->console_level);
const char* log_file_env = std::getenv("UHD_LOG_FILE");
if ((log_file_env != NULL) && (log_file_env[0] != '\0')) {
this->log_file_target = log_file_env;
this->file_logging = true;
}
}
~log_resource_type(void){
if (this->file_logging){
boost::lock_guard<boost::mutex> lock(_mutex);
_file_stream.close();
if (_file_lock != NULL) delete _file_lock;
}
}
void log_to_file(const std::string &log_msg){
if ( this->file_logging ){
boost::lock_guard<boost::mutex> lock(_mutex);
if (_file_lock == NULL){
_file_stream.open(this->log_file_target.c_str(), std::fstream::out | std::fstream::app);
_file_lock = new ip::file_lock(this->log_file_target.c_str());
}
_file_lock->lock();
_file_stream << log_msg << std::flush;
_file_lock->unlock();
}
}
private:
//! set the log level from a string that is either a digit or an enum name
bool file_logging;
std::string log_file_target;
uhd::log::severity_level _get_log_level(const std::string &log_level_str,
const uhd::log::severity_level &previous_level){
if (std::isdigit(log_level_str[0])) {
const uhd::log::severity_level log_level_num =
uhd::log::severity_level(std::stoi(log_level_str));
if (log_level_num >= uhd::log::trace and
log_level_num <= uhd::log::fatal) {
return log_level_num;
}else{
return previous_level;
}
}
#define if_loglevel_equal(name) \
else if (log_level_str == #name) return uhd::log::name
if_loglevel_equal(trace);
if_loglevel_equal(debug);
if_loglevel_equal(info);
if_loglevel_equal(warning);
if_loglevel_equal(error);
if_loglevel_equal(fatal);
if_loglevel_equal(off);
return previous_level;
}
//file stream and lock:
std::ofstream _file_stream;
ip::file_lock *_file_lock;
boost::mutex _mutex;
};
UHD_SINGLETON_FCN(log_resource_type, log_rs);
/***********************************************************************
* The logger object implementation
**********************************************************************/
//! get the relative file path from the host directory
inline std::string path_to_filename(std::string path)
{
return path.substr(path.find_last_of("/\\") + 1);
}
uhd::_log::log::log(
const uhd::log::severity_level verbosity,
const std::string &file,
const unsigned int line,
const std::string &component,
const boost::thread::id id
)
{
_log_it = (verbosity >= log_rs().level);
_log_file =(verbosity >= log_rs().file_level);
_log_console = (verbosity >= log_rs().console_level);
if (_log_it)
{
if (_log_file){
const std::string time = pt::to_simple_string(pt::microsec_clock::local_time());
_file
<< time << ","
<< "0x" << id << ","
<< path_to_filename(file) << ":" << line << ","
<< verbosity << ","
<< component << ","
;
}
#ifndef UHD_LOG_CONSOLE_DISABLE
if (_log_console){
#ifdef UHD_LOG_CONSOLE_TIME
const std::string time = pt::to_simple_string(pt::microsec_clock::local_time());
#endif
_console
#ifdef UHD_LOG_CONSOLE_COLOR
<< verbosity_color(verbosity)
#endif
#ifdef UHD_LOG_CONSOLE_TIME
<< "[" << time << "] "
#endif
#ifdef UHD_LOG_CONSOLE_THREAD
<< "[0x" << id << "] "
#endif
#ifdef UHD_LOG_CONSOLE_SRC
<< "[" << path_to_filename(file) << ":" << line << "] "
#endif
<< "[" << verbosity << "] "
<< "[" << component << "] "
#ifdef UHD_LOG_CONSOLE_COLOR
<< RESET_COLORS
#endif
;
}
#endif
}
}
uhd::_log::log::~log(void)
{
if (not _log_it)
return;
#ifndef UHD_LOG_CONSOLE_DISABLE
if ( _log_console ){
std::clog << _console.str() << _ss.str() << std::endl;
}
#endif
if ( _log_file){
_file << _ss.str() << std::endl;
try{
log_rs().log_to_file(_file.str());
}
catch(const std::exception &e){
/*!
* Critical behavior below.
* The following steps must happen in order to avoid a lock-up condition.
* This is because the message facility will call into the logging facility.
* Therefore we must disable the logger (level = never) before messaging.
*/
log_rs().level = uhd::log::off;
std::cerr
<< "Logging failed: " << e.what() << std::endl
<< "Logging has been disabled for this process" << std::endl
;
}
}
}
void
uhd::_log::log::set_log_level(uhd::log::severity_level level){
log_rs().level = level;
}
void
uhd::_log::log::set_console_level(uhd::log::severity_level level){
log_rs().console_level = level;
}
void
uhd::_log::log::set_file_level(uhd::log::severity_level level){
log_rs().file_level = level;
}
|
