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
|
//
// Copyright 2011 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/msg.hpp>
#include <uhd/utils/static.hpp>
#include <boost/filesystem.hpp>
#include <boost/format.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/date_time/posix_time/posix_time.hpp>
#ifdef BOOST_MSVC
//whoops! https://svn.boost.org/trac/boost/ticket/5287
//enjoy this useless dummy class instead
namespace boost{ namespace interprocess{
struct file_lock{
file_lock(const char * = NULL){}
void lock(void){}
void unlock(void){}
};
}} //namespace
#else
#include <boost/interprocess/sync/file_lock.hpp>
#endif
#ifdef BOOST_MSVC
#define USE_GET_TEMP_PATH
#include <Windows.h> //GetTempPath
#endif
#include <stdio.h> //P_tmpdir
#include <cstdlib> //getenv
#include <fstream>
#include <sstream>
#include <cctype>
namespace fs = boost::filesystem;
namespace pt = boost::posix_time;
namespace ip = boost::interprocess;
/***********************************************************************
* Helper function to get the system's temporary path
**********************************************************************/
static fs::path get_temp_path(void){
const char *tmp_path = NULL;
//try the official uhd temp path environment variable
tmp_path = std::getenv("UHD_TEMP_PATH");
if (tmp_path != NULL) return tmp_path;
//try the windows function if available
#ifdef USE_GET_TEMP_PATH
char lpBuffer[2048];
if (GetTempPath(sizeof(lpBuffer), lpBuffer)) return lpBuffer;
#endif
//try windows environment variables
tmp_path = std::getenv("TMP");
if (tmp_path != NULL) return tmp_path;
tmp_path = std::getenv("TEMP");
if (tmp_path != NULL) return tmp_path;
//try the stdio define if available
#ifdef P_tmpdir
return P_tmpdir;
#endif
//try unix environment variables
tmp_path = std::getenv("TMPDIR");
if (tmp_path != NULL) return tmp_path;
//give up and use the unix default
return "/tmp";
}
/***********************************************************************
* Global resources for the logger
**********************************************************************/
class log_resource_type{
public:
boost::mutex mutex;
std::ostringstream ss;
uhd::_log::verbosity_t verbosity, level;
log_resource_type(void){
//file lock pointer must be null
_file_lock = NULL;
//set the default log level
level = uhd::_log::never;
//allow override from macro definition
#ifdef UHD_LOG_LEVEL
_set_log_level(BOOST_STRINGIZE(UHD_LOG_LEVEL));
#endif
//allow override from environment variable
const char * log_level_env = std::getenv("UHD_LOG_LEVEL");
if (log_level_env != NULL) _set_log_level(log_level_env);
}
~log_resource_type(void){
_file_stream.close();
if (_file_lock != NULL) delete _file_lock;
}
void log_to_file(void){
if (verbosity < level) return;
if (_file_lock == NULL){
const std::string log_path = (get_temp_path() / "uhd.log").string();
_file_stream.open(log_path.c_str(), std::fstream::out | std::fstream::app);
_file_lock = new ip::file_lock(log_path.c_str());
}
_file_lock->lock();
_file_stream << ss.str() << std::flush;
_file_lock->unlock();
}
private:
//! set the log level from a string that is either a digit or an enum name
void _set_log_level(const std::string &log_level_str){
const uhd::_log::verbosity_t log_level_num = uhd::_log::verbosity_t(log_level_str[0]-'0');
if (std::isdigit(log_level_str[0]) and log_level_num >= uhd::_log::always and log_level_num <= uhd::_log::never){
this->level = log_level_num;
return;
}
#define if_lls_equal(name) else if(log_level_str == #name) this->level = uhd::_log::name
if_lls_equal(always);
if_lls_equal(often);
if_lls_equal(regularly);
if_lls_equal(rarely);
if_lls_equal(very_rarely);
if_lls_equal(never);
}
//file stream and lock:
std::ofstream _file_stream;
ip::file_lock *_file_lock;
};
UHD_SINGLETON_FCN(log_resource_type, log_rs);
/***********************************************************************
* The logger object implementation
**********************************************************************/
//! get the relative file path from the host directory
static std::string get_rel_file_path(const fs::path &file){
fs::path abs_path = file.branch_path();
fs::path rel_path = file.leaf();
while (not abs_path.empty() and abs_path.leaf() != "host"){
rel_path = abs_path.leaf() / rel_path;
abs_path = abs_path.branch_path();
}
return rel_path.string();
}
uhd::_log::log::log(
const verbosity_t verbosity,
const std::string &file,
const unsigned int line,
const std::string &function
){
log_rs().mutex.lock();
log_rs().verbosity = verbosity;
const std::string time = pt::to_simple_string(pt::microsec_clock::local_time());
const std::string header1 = str(boost::format("-- %s - level %d") % time % int(verbosity));
const std::string header2 = str(boost::format("-- %s") % function).substr(0, 80);
const std::string header3 = str(boost::format("-- %s:%u") % get_rel_file_path(file) % line);
const std::string border = std::string(std::max(std::max(header1.size(), header2.size()), header3.size()), '-');
log_rs().ss
<< std::endl
<< border << std::endl
<< header1 << std::endl
<< header2 << std::endl
<< header3 << std::endl
<< border << std::endl
;
}
uhd::_log::log::~log(void){
log_rs().ss << std::endl;
try{
log_rs().log_to_file();
}
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) and unlock the mutex.
*
* 1) Set logging level to never.
* 2) Unlock the mutex.
* 3) Send the error message.
* 4) Return.
*/
log_rs().level = never;
log_rs().ss.str(""); //clear for next call
log_rs().mutex.unlock();
UHD_MSG(error)
<< "Logging failed: " << e.what() << std::endl
<< "Logging has been disabled for this process" << std::endl
;
return;
}
log_rs().ss.str(""); //clear for next call
log_rs().mutex.unlock();
}
std::ostream & uhd::_log::log::operator()(void){
return log_rs().ss;
}
|
