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
|
/* Support for complaint handling during symbol reading in GDB.
Copyright (C) 1990-2024 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/>. */
#include "defs.h"
#include "complaints.h"
#include "command.h"
#include "gdbcmd.h"
#include "run-on-main-thread.h"
#include "gdbsupport/selftest.h"
#include <unordered_map>
#include <mutex>
/* Map format strings to counters. */
static std::unordered_map<const char *, int> counters;
/* How many complaints about a particular thing should be printed
before we stop whining about it? Default is no whining at all,
since so many systems have ill-constructed symbol files. */
int stop_whining = 0;
#if CXX_STD_THREAD
static std::mutex complaint_mutex;
#endif /* CXX_STD_THREAD */
/* See complaints.h. */
void
complaint_internal (const char *fmt, ...)
{
va_list args;
{
#if CXX_STD_THREAD
std::lock_guard<std::mutex> guard (complaint_mutex);
#endif
if (++counters[fmt] > stop_whining)
return;
}
va_start (args, fmt);
warning_hook_handler handler = get_warning_hook_handler ();
if (handler != nullptr)
handler (fmt, args);
else
{
gdb_puts (_("During symbol reading: "), gdb_stderr);
gdb_vprintf (gdb_stderr, fmt, args);
gdb_puts ("\n", gdb_stderr);
}
va_end (args);
}
/* See complaints.h. */
void
clear_complaints ()
{
counters.clear ();
}
/* See complaints.h. */
thread_local complaint_interceptor *complaint_interceptor::g_complaint_interceptor;
/* See complaints.h. */
complaint_interceptor::complaint_interceptor ()
: m_saved_complaint_interceptor (&g_complaint_interceptor, this),
m_saved_warning_hook (issue_complaint)
{
}
/* A helper that wraps a warning hook. */
static void
wrap_warning_hook (warning_hook_handler hook, ...)
{
va_list args;
va_start (args, hook);
hook ("%s", args);
va_end (args);
}
/* See complaints.h. */
void
re_emit_complaints (const complaint_collection &complaints)
{
gdb_assert (is_main_thread ());
for (const std::string &str : complaints)
{
warning_hook_handler handler = get_warning_hook_handler ();
if (handler != nullptr)
wrap_warning_hook (handler, str.c_str ());
else
gdb_printf (gdb_stderr, _("During symbol reading: %s\n"),
str.c_str ());
}
}
/* See complaints.h. */
void
complaint_interceptor::issue_complaint (const char *fmt, va_list args)
{
#if CXX_STD_THREAD
std::lock_guard<std::mutex> guard (complaint_mutex);
#endif
g_complaint_interceptor->m_complaints.insert (string_vprintf (fmt, args));
}
static void
complaints_show_value (struct ui_file *file, int from_tty,
struct cmd_list_element *cmd, const char *value)
{
gdb_printf (file, _("Max number of complaints about incorrect"
" symbols is %s.\n"),
value);
}
#if GDB_SELF_TEST
namespace selftests {
/* Entry point for complaints unit tests. */
static void
test_complaints ()
{
std::unordered_map<const char *, int> tmp;
scoped_restore reset_counters = make_scoped_restore (&counters, tmp);
scoped_restore reset_stop_whining = make_scoped_restore (&stop_whining, 2);
#define CHECK_COMPLAINT(STR, CNT) \
do \
{ \
std::string output; \
execute_fn_to_string (output, []() { complaint (STR); }, false); \
std::string expected \
= _("During symbol reading: ") + std::string (STR "\n"); \
SELF_CHECK (output == expected); \
SELF_CHECK (counters[STR] == CNT); \
} while (0)
#define CHECK_COMPLAINT_SILENT(STR, CNT) \
do \
{ \
std::string output; \
execute_fn_to_string (output, []() { complaint (STR); }, false); \
SELF_CHECK (output.empty ()); \
SELF_CHECK (counters[STR] == CNT); \
} while (0)
CHECK_COMPLAINT ("maintenance complaint 0", 1);
CHECK_COMPLAINT ("maintenance complaint 0", 2);
CHECK_COMPLAINT_SILENT ("maintenance complaint 0", 3);
CHECK_COMPLAINT ("maintenance complaint 1", 1);
clear_complaints ();
CHECK_COMPLAINT ("maintenance complaint 0", 1);
#undef CHECK_COMPLAINT
#undef CHECK_COMPLAINT_SILENT
}
} // namespace selftests
#endif /* GDB_SELF_TEST */
void _initialize_complaints ();
void
_initialize_complaints ()
{
add_setshow_zinteger_cmd ("complaints", class_support,
&stop_whining, _("\
Set max number of complaints about incorrect symbols."), _("\
Show max number of complaints about incorrect symbols."), NULL,
NULL, complaints_show_value,
&setlist, &showlist);
#if GDB_SELF_TEST
selftests::register_test ("complaints", selftests::test_complaints);
#endif /* GDB_SELF_TEST */
}
|
