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
|
/*
* Author: Sven Gothel <sgothel@jausoft.com>
* Copyright (c) 2020 Gothel Software e.K.
* Copyright (c) 2020 ZAFENA AB
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef JAU_DEBUG_HPP_
#define JAU_DEBUG_HPP_
#include <memory>
#include <cstdint>
#include <cinttypes>
#include <cstring>
#include <string>
#include <cstdio>
#include <cstdarg>
extern "C" {
#include <errno.h>
}
#include <jau/environment.hpp>
// #define PERF_PRINT_ON 1
namespace jau {
/**
* Returns a de-mangled backtrace string separated by newline excluding this function.
* <p>
* Returns one line per stack frame, each with
* <pre>
* - stack frame number
* - demangled function name + offset (sp)
* - the instruction pointer (pc)
* - the stack pointer (sp)
* </pre>
* </p>
* @param skip_anon_frames if true, skip all frames w/o proc-name
* @param max_frames number of stack frames to be printed or -1 for unlimited, defaults to -1
* @param skip_frames number of stack frames to skip, default is one frame for this function.
* @return the de-mangled backtrace, separated by newline
*/
std::string get_backtrace(const bool skip_anon_frames, const jau::snsize_t max_frames=-1, const jau::snsize_t skip_frames=1) noexcept;
/**
* Prints the de-mangled backtrace string separated by newline excluding this function to stderr, using get_backtrace().
* @param skip_anon_frames if true, skip all frames w/o proc-name
* @param max_frames number of stack frames to be printed or -1 for unlimited, defaults to -1
* @param skip_frames number of stack frames to skip, default is two frames for this function and for get_backtrace().
* @see get_backtrace()
*/
void print_backtrace(const bool skip_anon_frames, const jau::snsize_t max_frames=-1, const jau::snsize_t skip_frames=2) noexcept;
void DBG_PRINT_impl(const char * format, ...) noexcept;
/** Use for environment-variable environment::DEBUG conditional debug messages, prefix '[elapsed_time] Debug: '. */
#define DBG_PRINT(...) { if( jau::environment::get().debug ) { jau::DBG_PRINT_impl(__VA_ARGS__); } }
/** Use for environment-variable environment::DEBUG_JNI conditional debug messages, prefix '[elapsed_time] Debug: '. */
#define DBG_JNI_PRINT(...) { if( jau::environment::get().debug_jni ) { jau::DBG_PRINT_impl(__VA_ARGS__); } }
void WORDY_PRINT_impl(const char * format, ...) noexcept;
/**
* Use for environment-variable environment::VERBOSE conditional verbose messages, prefix '[elapsed_time] Wordy: '.
* <p>
* 'Wordy' is the shorter English form of the Latin word 'verbosus', from which the word 'verbosity' is sourced.
* </p>
*/
#define WORDY_PRINT(...) { if( jau::environment::get().verbose ) { jau::WORDY_PRINT_impl(__VA_ARGS__); } }
#define PERF_TS_T0_BASE() const uint64_t _t0 = jau::getCurrentMilliseconds()
#define PERF_TS_TD_BASE(m) { const uint64_t _td = jau::getCurrentMilliseconds() - _t0; \
fprintf(stderr, "[%'9" PRIu64 "] PERF %s done in %d ms,\n", jau::environment::getElapsedMillisecond(), (m), (int)_td); }
#ifdef PERF_PRINT_ON
#define PERF_TS_T0() PERF_TS_T0_BASE()
#define PERF_TS_TD(m) PERF_TS_TD_BASE(m)
#else
#define PERF_TS_T0()
#define PERF_TS_TD(m)
#endif
#ifdef PERF2_PRINT_ON
#define PERF2_TS_T0() PERF_TS_T0_BASE()
#define PERF2_TS_TD(m) PERF_TS_TD_BASE(m)
#else
#define PERF2_TS_T0()
#define PERF2_TS_TD(m)
#endif
#ifdef PERF3_PRINT_ON
#define PERF3_TS_T0() PERF_TS_T0_BASE()
#define PERF3_TS_TD(m) PERF_TS_TD_BASE(m)
#else
#define PERF3_TS_T0()
#define PERF3_TS_TD(m)
#endif
/** Use for unconditional ::abort() call with given messages, prefix '[elapsed_time] ABORT @ file:line: '. Function also appends last errno and strerror(errno). */
void ABORT_impl(const char *func, const char *file, const int line, const char * format, ...) noexcept;
/** Use for unconditional ::abort() call with given messages, prefix '[elapsed_time] ABORT @ FILE:LINE: '. Function also appends last errno and strerror(errno). */
#define ABORT(...) { jau::ABORT_impl(__func__, __FILE__, __LINE__, __VA_ARGS__); }
/** Use for unconditional error messages, prefix '[elapsed_time] Error @ file:line: '. Function also appends last errno and strerror(errno). */
void ERR_PRINTv(const char *func, const char *file, const int line, const char * format, va_list args) noexcept;
void ERR_PRINT_impl(const char *prefix, const bool backtrace, const char *func, const char *file, const int line, const char * format, ...) noexcept;
/** Use for unconditional error messages, prefix '[elapsed_time] Error @ FILE:LINE: '. Function also appends last errno, strerror(errno) and full backtrace*/
#define ERR_PRINT(...) { jau::ERR_PRINT_impl("Error", true /* backtrace */, __func__, __FILE__, __LINE__, __VA_ARGS__); }
/** Use for unconditional error messages, prefix '[elapsed_time] Error @ FILE:LINE: '. Function also appends last errno and strerror(errno). No backtrace. */
#define ERR_PRINT2(...) { jau::ERR_PRINT_impl("Error", false /* backtrace */, __func__, __FILE__, __LINE__, __VA_ARGS__); }
/** Use for unconditional interruption messages, prefix '[elapsed_time] Interrupted @ FILE:LINE: '. Function also appends last errno and strerror(errno). */
#define IRQ_PRINT(...) { jau::ERR_PRINT_impl("Interrupted", false /* backtrace */, __func__, __FILE__, __LINE__, __VA_ARGS__); }
/** Use for unconditional warning messages, prefix '[elapsed_time] Warning @ file:line: ' */
void WARN_PRINTv(const char *func, const char *file, const int line, const char * format, va_list args) noexcept;
void WARN_PRINT_impl(const char *func, const char *file, const int line, const char * format, ...) noexcept;
/** Use for unconditional warning messages, prefix '[elapsed_time] Warning @ FILE:LINE: ' */
#define WARN_PRINT(...) { jau::WARN_PRINT_impl(__func__, __FILE__, __LINE__, __VA_ARGS__); }
/** Use for unconditional informal messages, prefix '[elapsed_time] Info: '. */
void INFO_PRINT(const char * format, ...) noexcept;
/** Use for unconditional plain messages, prefix '[elapsed_time] ' if printPrefix == true. */
void PLAIN_PRINT(const bool printPrefix, const char * format, ...) noexcept;
/**
* Convenient fprintf() invocation, prepending the environment::getElapsedMillisecond() timestamp.
* @param stream the output stream
* @param format the format
* @param args the optional arguments
*/
int fprintf_td(FILE* stream, const char * format, ...) noexcept;
void COND_PRINT_impl(const char * format, ...) noexcept;
/** Use for conditional plain messages, prefix '[elapsed_time] '. */
#define COND_PRINT(C, ...) { if( C ) { jau::COND_PRINT_impl(__VA_ARGS__); } }
template<class List>
inline void printSharedPtrList(std::string prefix, List & list) noexcept {
fprintf(stderr, "%s: Start: %zu elements\n", prefix.c_str(), (size_t)list.size());
int idx = 0;
for (auto it = list.begin(); it != list.end(); idx++) {
typename List::value_type & e = *it;
if ( nullptr != e ) {
fprintf(stderr, "%s[%d]: useCount %zu, mem %p\n", prefix.c_str(), idx, (size_t)e.use_count(), e.get());
} else {
fprintf(stderr, "%s[%d]: NULL\n", prefix.c_str(), idx);
}
++it;
}
}
} // namespace jau
#endif /* JAU_DEBUG_HPP_ */
|
