Monero
misc_log_ex.h
Go to the documentation of this file.
1 // Copyright (c) 2006-2013, Andrey N. Sabelnikov, www.sabelnikov.net
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are met:
6 // * Redistributions of source code must retain the above copyright
7 // notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright
9 // notice, this list of conditions and the following disclaimer in the
10 // documentation and/or other materials provided with the distribution.
11 // * Neither the name of the Andrey N. Sabelnikov nor the
12 // names of its contributors may be used to endorse or promote products
13 // derived from this software without specific prior written permission.
14 //
15 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER BE LIABLE FOR ANY
19 // DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 // ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 //
26 
27 
28 #ifndef _MISC_LOG_EX_H_
29 #define _MISC_LOG_EX_H_
30 
31 #ifdef __cplusplus
32 
33 #include <string>
34 
35 #include "easylogging++.h"
36 
37 #undef MONERO_DEFAULT_LOG_CATEGORY
38 #define MONERO_DEFAULT_LOG_CATEGORY "default"
39 
40 #define MAX_LOG_FILE_SIZE 104850000 // 100 MB - 7600 bytes
41 #define MAX_LOG_FILES 50
42 
43 #define MCLOG_TYPE(level, cat, color, type, x) do { \
44  if (el::Loggers::allowed(level, cat)) { \
45  el::base::Writer(level, color, __FILE__, __LINE__, ELPP_FUNC, type).construct(cat) << x; \
46  } \
47  } while (0)
48 
49 #define MCLOG(level, cat, color, x) MCLOG_TYPE(level, cat, color, el::base::DispatchAction::NormalLog, x)
50 #define MCLOG_FILE(level, cat, x) MCLOG_TYPE(level, cat, el::Color::Default, el::base::DispatchAction::FileOnlyLog, x)
51 
52 #define MCFATAL(cat,x) MCLOG(el::Level::Fatal,cat, el::Color::Default, x)
53 #define MCERROR(cat,x) MCLOG(el::Level::Error,cat, el::Color::Default, x)
54 #define MCWARNING(cat,x) MCLOG(el::Level::Warning,cat, el::Color::Default, x)
55 #define MCINFO(cat,x) MCLOG(el::Level::Info,cat, el::Color::Default, x)
56 #define MCDEBUG(cat,x) MCLOG(el::Level::Debug,cat, el::Color::Default, x)
57 #define MCTRACE(cat,x) MCLOG(el::Level::Trace,cat, el::Color::Default, x)
58 
59 #define MCLOG_COLOR(level,cat,color,x) MCLOG(level,cat,color,x)
60 #define MCLOG_RED(level,cat,x) MCLOG_COLOR(level,cat,el::Color::Red,x)
61 #define MCLOG_GREEN(level,cat,x) MCLOG_COLOR(level,cat,el::Color::Green,x)
62 #define MCLOG_YELLOW(level,cat,x) MCLOG_COLOR(level,cat,el::Color::Yellow,x)
63 #define MCLOG_BLUE(level,cat,x) MCLOG_COLOR(level,cat,el::Color::Blue,x)
64 #define MCLOG_MAGENTA(level,cat,x) MCLOG_COLOR(level,cat,el::Color::Magenta,x)
65 #define MCLOG_CYAN(level,cat,x) MCLOG_COLOR(level,cat,el::Color::Cyan,x)
66 
67 #define MLOG_RED(level,x) MCLOG_RED(level,MONERO_DEFAULT_LOG_CATEGORY,x)
68 #define MLOG_GREEN(level,x) MCLOG_GREEN(level,MONERO_DEFAULT_LOG_CATEGORY,x)
69 #define MLOG_YELLOW(level,x) MCLOG_YELLOW(level,MONERO_DEFAULT_LOG_CATEGORY,x)
70 #define MLOG_BLUE(level,x) MCLOG_BLUE(level,MONERO_DEFAULT_LOG_CATEGORY,x)
71 #define MLOG_MAGENTA(level,x) MCLOG_MAGENTA(level,MONERO_DEFAULT_LOG_CATEGORY,x)
72 #define MLOG_CYAN(level,x) MCLOG_CYAN(level,MONERO_DEFAULT_LOG_CATEGORY,x)
73 
74 #define MFATAL(x) MCFATAL(MONERO_DEFAULT_LOG_CATEGORY,x)
75 #define MERROR(x) MCERROR(MONERO_DEFAULT_LOG_CATEGORY,x)
76 #define MWARNING(x) MCWARNING(MONERO_DEFAULT_LOG_CATEGORY,x)
77 #define MINFO(x) MCINFO(MONERO_DEFAULT_LOG_CATEGORY,x)
78 #define MDEBUG(x) MCDEBUG(MONERO_DEFAULT_LOG_CATEGORY,x)
79 #define MTRACE(x) MCTRACE(MONERO_DEFAULT_LOG_CATEGORY,x)
80 #define MLOG(level,x) MCLOG(level,MONERO_DEFAULT_LOG_CATEGORY,el::Color::Default,x)
81 
82 #define MGINFO(x) MCINFO("global",x)
83 #define MGINFO_RED(x) MCLOG_RED(el::Level::Info, "global",x)
84 #define MGINFO_GREEN(x) MCLOG_GREEN(el::Level::Info, "global",x)
85 #define MGINFO_YELLOW(x) MCLOG_YELLOW(el::Level::Info, "global",x)
86 #define MGINFO_BLUE(x) MCLOG_BLUE(el::Level::Info, "global",x)
87 #define MGINFO_MAGENTA(x) MCLOG_MAGENTA(el::Level::Info, "global",x)
88 #define MGINFO_CYAN(x) MCLOG_CYAN(el::Level::Info, "global",x)
89 
90 #define IFLOG(level, cat, color, type, init, x) \
91  do { \
92  if (el::Loggers::allowed(level, cat)) { \
93  init; \
94  el::base::Writer(level, color, __FILE__, __LINE__, ELPP_FUNC, type).construct(cat) << x; \
95  } \
96  } while(0)
97 #define MIDEBUG(init, x) IFLOG(el::Level::Debug, MONERO_DEFAULT_LOG_CATEGORY, el::Color::Default, el::base::DispatchAction::NormalLog, init, x)
98 
99 
100 #define LOG_ERROR(x) MERROR(x)
101 #define LOG_PRINT_L0(x) MWARNING(x)
102 #define LOG_PRINT_L1(x) MINFO(x)
103 #define LOG_PRINT_L2(x) MDEBUG(x)
104 #define LOG_PRINT_L3(x) MTRACE(x)
105 #define LOG_PRINT_L4(x) MTRACE(x)
106 
107 #define _dbg3(x) MTRACE(x)
108 #define _dbg2(x) MDEBUG(x)
109 #define _dbg1(x) MDEBUG(x)
110 #define _info(x) MINFO(x)
111 #define _note(x) MDEBUG(x)
112 #define _fact(x) MDEBUG(x)
113 #define _mark(x) MDEBUG(x)
114 #define _warn(x) MWARNING(x)
115 #define _erro(x) MERROR(x)
116 
117 #define MLOG_SET_THREAD_NAME(x) el::Helpers::setThreadName(x)
118 
119 #ifndef LOCAL_ASSERT
120 #include <assert.h>
121 #if (defined _MSC_VER)
122 #define LOCAL_ASSERT(expr) {if(epee::debug::get_set_enable_assert()){_ASSERTE(expr);}}
123 #else
124 #define LOCAL_ASSERT(expr)
125 #endif
126 
127 #endif
128 
129 std::string mlog_get_default_log_path(const char *default_filename);
130 void mlog_configure(const std::string &filename_base, bool console, const std::size_t max_log_file_size = MAX_LOG_FILE_SIZE, const std::size_t max_log_files = MAX_LOG_FILES);
131 void mlog_set_categories(const char *categories);
133 void mlog_set_log_level(int level);
134 void mlog_set_log(const char *log);
135 
136 namespace epee
137 {
138 namespace debug
139 {
140  inline bool get_set_enable_assert(bool set = false, bool v = false)
141  {
142  static bool e = true;
143  if(set)
144  e = v;
145  return e;
146  }
147 }
148 
149 
150 
151 #define ENDL std::endl
152 
153 #define TRY_ENTRY() try {
154 #define CATCH_ENTRY(location, return_val) } \
155  catch(const std::exception& ex) \
156 { \
157  (void)(ex); \
158  LOG_ERROR("Exception at [" << location << "], what=" << ex.what()); \
159  return return_val; \
160 }\
161  catch(...)\
162 {\
163  LOG_ERROR("Exception at [" << location << "], generic exception \"...\"");\
164  return return_val; \
165 }
166 
167 #define CATCH_ENTRY_L0(lacation, return_val) CATCH_ENTRY(lacation, return_val)
168 #define CATCH_ENTRY_L1(lacation, return_val) CATCH_ENTRY(lacation, return_val)
169 #define CATCH_ENTRY_L2(lacation, return_val) CATCH_ENTRY(lacation, return_val)
170 #define CATCH_ENTRY_L3(lacation, return_val) CATCH_ENTRY(lacation, return_val)
171 #define CATCH_ENTRY_L4(lacation, return_val) CATCH_ENTRY(lacation, return_val)
172 
173 
174 #define ASSERT_MES_AND_THROW(message) {LOG_ERROR(message); std::stringstream ss; ss << message; throw std::runtime_error(ss.str());}
175 #define CHECK_AND_ASSERT_THROW_MES(expr, message) do {if(!(expr)) ASSERT_MES_AND_THROW(message);} while(0)
176 
177 
178 #ifndef CHECK_AND_ASSERT
179 #define CHECK_AND_ASSERT(expr, fail_ret_val) do{if(!(expr)){LOCAL_ASSERT(expr); return fail_ret_val;};}while(0)
180 #endif
181 
182 #ifndef CHECK_AND_ASSERT_MES
183 #define CHECK_AND_ASSERT_MES(expr, fail_ret_val, message) do{if(!(expr)) {LOG_ERROR(message); return fail_ret_val;};}while(0)
184 #endif
185 
186 #ifndef CHECK_AND_NO_ASSERT_MES_L
187 #define CHECK_AND_NO_ASSERT_MES_L(expr, fail_ret_val, l, message) do{if(!(expr)) {LOG_PRINT_L##l(message); /*LOCAL_ASSERT(expr);*/ return fail_ret_val;};}while(0)
188 #endif
189 
190 #ifndef CHECK_AND_NO_ASSERT_MES
191 #define CHECK_AND_NO_ASSERT_MES(expr, fail_ret_val, message) CHECK_AND_NO_ASSERT_MES_L(expr, fail_ret_val, 0, message)
192 #endif
193 
194 #ifndef CHECK_AND_NO_ASSERT_MES_L1
195 #define CHECK_AND_NO_ASSERT_MES_L1(expr, fail_ret_val, message) CHECK_AND_NO_ASSERT_MES_L(expr, fail_ret_val, 1, message)
196 #endif
197 
198 
199 #ifndef CHECK_AND_ASSERT_MES_NO_RET
200 #define CHECK_AND_ASSERT_MES_NO_RET(expr, message) do{if(!(expr)) {LOG_ERROR(message); return;};}while(0)
201 #endif
202 
203 
204 #ifndef CHECK_AND_ASSERT_MES2
205 #define CHECK_AND_ASSERT_MES2(expr, message) do{if(!(expr)) {LOG_ERROR(message); };}while(0)
206 #endif
207 
208 enum console_colors
209 {
210  console_color_default,
211  console_color_white,
212  console_color_red,
213  console_color_green,
214  console_color_blue,
215  console_color_cyan,
216  console_color_magenta,
217  console_color_yellow
218 };
219 
220 bool is_stdout_a_tty();
221 void set_console_color(int color, bool bright);
222 void reset_console_color();
223 
224 }
225 
226 extern "C"
227 {
228 
229 #endif
230 
231 #ifdef __GNUC__
232 #define ATTRIBUTE_PRINTF __attribute__((format(printf, 2, 3)))
233 #else
234 #define ATTRIBUTE_PRINTF
235 #endif
236 
237 bool merror(const char *category, const char *format, ...) ATTRIBUTE_PRINTF;
238 bool mwarning(const char *category, const char *format, ...) ATTRIBUTE_PRINTF;
239 bool minfo(const char *category, const char *format, ...) ATTRIBUTE_PRINTF;
240 bool mdebug(const char *category, const char *format, ...) ATTRIBUTE_PRINTF;
241 bool mtrace(const char *category, const char *format, ...) ATTRIBUTE_PRINTF;
242 
243 #ifdef __cplusplus
244 
245 }
246 
247 #endif
248 
249 #endif //_MISC_LOG_EX_H_
void mlog_set_log(const char *log)
Definition: mlog.cpp:289
::std::string string
Definition: gtest-port.h:1097
bool mwarning(const char *category, const char *format,...) ATTRIBUTE_PRINTF
std::string mlog_get_categories()
Definition: mlog.cpp:277
bool merror(const char *category, const char *format,...) ATTRIBUTE_PRINTF
e
Definition: pymoduletest.py:79
#define ATTRIBUTE_PRINTF
Definition: misc_log_ex.h:234
void reset_console_color()
Definition: mlog.cpp:471
static void log()
Definition: logging.cpp:81
void mlog_set_log_level(int level)
Definition: mlog.cpp:283
void set_console_color(int color, bool bright)
Definition: mlog.cpp:349
bool mtrace(const char *category, const char *format,...) ATTRIBUTE_PRINTF
TODO: (mj-xmr) This will be reduced in an another PR.
Definition: byte_slice.h:39
bool is_stdout_a_tty()
Definition: mlog.cpp:324
bool minfo(const char *category, const char *format,...) ATTRIBUTE_PRINTF
Definition: console.py:1
std::string mlog_get_default_log_path(const char *default_filename)
Definition: mlog.cpp:72
void mlog_set_categories(const char *categories)
Definition: mlog.cpp:239
bool mdebug(const char *category, const char *format,...) ATTRIBUTE_PRINTF
void mlog_configure(const std::string &filename_base, bool console, const std::size_t max_log_file_size, const std::size_t max_log_files)
Definition: mlog.cpp:148
#define const
Definition: ipfrdr.c:80