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
|
/* Declarations for debug printing functions.
Copyright (C) 2014-2022 Free Software Foundation, Inc.
This file is part of GDB.
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/>. */
#ifndef COMMON_COMMON_DEBUG_H
#define COMMON_COMMON_DEBUG_H
#include "gdbsupport/gdb_optional.h"
#include "gdbsupport/preprocessor.h"
#include <stdarg.h>
/* Set to true to enable debugging of hardware breakpoint/
watchpoint support code. */
extern bool show_debug_regs;
/* Print a formatted message to the appropriate channel for
debugging output for the client. */
extern void debug_printf (const char *format, ...)
ATTRIBUTE_PRINTF (1, 2);
/* Print a formatted message to the appropriate channel for
debugging output for the client. This function must be
provided by the client. */
extern void debug_vprintf (const char *format, va_list ap)
ATTRIBUTE_PRINTF (1, 0);
/* Print a debug statement prefixed with the module and function name, and
with a newline at the end. */
extern void ATTRIBUTE_PRINTF (3, 4) debug_prefixed_printf
(const char *module, const char *func, const char *format, ...);
/* Print a debug statement prefixed with the module and function name, and
with a newline at the end. */
extern void ATTRIBUTE_PRINTF (3, 0) debug_prefixed_vprintf
(const char *module, const char *func, const char *format, va_list args);
/* Helper to define "_debug_print" macros.
DEBUG_ENABLED_COND is an expression that evaluates to true if the debugging
statement is enabled and should be printed.
The other arguments, as well as the name of the current function, are
forwarded to debug_prefixed_printf. */
#define debug_prefixed_printf_cond(debug_enabled_cond, module, fmt, ...) \
do \
{ \
if (debug_enabled_cond) \
debug_prefixed_printf (module, __func__, fmt, ##__VA_ARGS__); \
} \
while (0)
#define debug_prefixed_printf_cond_nofunc(debug_enabled_cond, module, fmt, ...) \
do \
{ \
if (debug_enabled_cond) \
debug_prefixed_printf (module, nullptr, fmt, ##__VA_ARGS__); \
} \
while (0)
/* Nesting depth of scoped_debug_start_end objects. */
extern int debug_print_depth;
/* Print a message on construction and destruction, to denote the start and end
of an operation. Increment DEBUG_PRINT_DEPTH on construction and decrement
it on destruction, such that nested debug statements will be printed with
an indent and appear "inside" this one. */
struct scoped_debug_start_end
{
/* DEBUG_ENABLED is a reference to a variable that indicates whether debugging
is enabled, so if the debug statements should be printed. Is is read
separately at construction and destruction, such that the start statement
could be printed but not the end statement, or vice-versa.
MODULE and FUNC are forwarded to debug_prefixed_printf.
START_PREFIX and END_PREFIX are the statements to print on construction and
destruction, respectively.
If the FMT format string is non-nullptr, then a `: ` is appended to the
messages, followed by the rendering of that format string. The format
string is rendered during construction and is re-used as is for the
message on exit. */
scoped_debug_start_end (bool &debug_enabled, const char *module,
const char *func, const char *start_prefix,
const char *end_prefix, const char *fmt, ...)
ATTRIBUTE_NULL_PRINTF (7, 8)
: m_debug_enabled (debug_enabled),
m_module (module),
m_func (func),
m_end_prefix (end_prefix),
m_with_format (fmt != nullptr)
{
if (m_debug_enabled)
{
if (fmt != nullptr)
{
va_list args;
va_start (args, fmt);
m_msg = string_vprintf (fmt, args);
va_end (args);
debug_prefixed_printf (m_module, m_func, "%s: %s",
start_prefix, m_msg->c_str ());
}
else
debug_prefixed_printf (m_module, m_func, "%s", start_prefix);
++debug_print_depth;
m_must_decrement_print_depth = true;
}
}
DISABLE_COPY_AND_ASSIGN (scoped_debug_start_end);
~scoped_debug_start_end ()
{
if (m_must_decrement_print_depth)
{
gdb_assert (debug_print_depth > 0);
--debug_print_depth;
}
if (m_debug_enabled)
{
if (m_with_format)
{
if (m_msg.has_value ())
debug_prefixed_printf (m_module, m_func, "%s: %s",
m_end_prefix, m_msg->c_str ());
else
{
/* A format string was passed to the constructor, but debug
control variable wasn't set at the time, so we don't have the
rendering of the format string. */
debug_prefixed_printf (m_module, m_func, "%s: <%s debugging was not enabled on entry>",
m_end_prefix, m_module);
}
}
else
debug_prefixed_printf (m_module, m_func, "%s", m_end_prefix);
}
}
private:
bool &m_debug_enabled;
const char *m_module;
const char *m_func;
const char *m_end_prefix;
/* The result of formatting the format string in the constructor. */
gdb::optional<std::string> m_msg;
/* True is a non-nullptr format was passed to the constructor. */
bool m_with_format;
/* This is used to handle the case where debugging is enabled during
construction but not during destruction, or vice-versa. We want to make
sure there are as many increments are there are decrements. */
bool m_must_decrement_print_depth = false;
};
/* Helper to define a module-specific start/end debug macro. */
#define scoped_debug_start_end(debug_enabled, module, fmt, ...) \
scoped_debug_start_end CONCAT(scoped_debug_start_end, __LINE__) \
(debug_enabled, module, __func__, "start", "end", fmt, ##__VA_ARGS__)
/* Helper to define a module-specific enter/exit debug macro. This is a special
case of `scoped_debug_start_end` where the start and end messages are "enter"
and "exit", to denote entry and exit of a function. */
#define scoped_debug_enter_exit(debug_enabled, module) \
scoped_debug_start_end CONCAT(scoped_debug_start_end, __LINE__) \
(debug_enabled, module, __func__, "enter", "exit", nullptr)
#endif /* COMMON_COMMON_DEBUG_H */
|
