1 /* Support for complaint handling during symbol reading in GDB.
3 Copyright (C) 1990-2014 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "complaints.h"
25 extern void _initialize_complaints (void);
27 /* Should each complaint message be self explanatory, or should we
28 assume that a series of complaints is being produced? */
30 /* case 1: First message of a series that must
31 start off with explanation. case 2: Subsequent message of a series
32 that needs no explanation (the user already knows we have a problem
33 so we can just state our piece). */
34 enum complaint_series
{
35 /* Isolated self explanatory message. */
37 /* First message of a series, includes an explanation. */
39 /* First message of a series, but does not need to include any sort
42 /* Subsequent message of a series that needs no explanation (the
43 user already knows we have a problem so we can just state our
48 /* Structure to manage complaints about symbol file contents. */
56 struct complain
*next
;
59 /* The explanatory message that should accompany the complaint. The
60 message is in two parts - pre and post - that are printed around
61 the complaint text. */
70 struct complain
*root
;
72 /* Should each complaint be self explanatory, or should we assume
73 that a series of complaints is being produced? case 0: Isolated
74 self explanatory message. case 1: First message of a series that
75 must start off with explanation. case 2: Subsequent message of a
76 series that needs no explanation (the user already knows we have
77 a problem so we can just state our piece). */
80 /* The explanatory messages that should accompany the complaint.
81 NOTE: cagney/2002-08-14: In a desperate attempt at being vaguely
82 i18n friendly, this is an array of two messages. When present,
83 the PRE and POST EXPLANATION[SERIES] are used to wrap the
85 const struct explanation
*explanation
;
88 static struct complain complaint_sentinel
;
90 /* The symbol table complaint table. */
92 static struct explanation symfile_explanations
[] = {
93 { "During symbol reading, ", "." },
94 { "During symbol reading...", "..."},
100 static struct complaints symfile_complaint_book
= {
105 struct complaints
*symfile_complaints
= &symfile_complaint_book
;
107 /* Wrapper function to, on-demand, fill in a complaints object. */
109 static struct complaints
*
110 get_complaints (struct complaints
**c
)
114 (*c
) = XNEW (struct complaints
);
115 (*c
)->root
= &complaint_sentinel
;
116 (*c
)->series
= ISOLATED_MESSAGE
;
117 (*c
)->explanation
= NULL
;
121 static struct complain
* ATTRIBUTE_PRINTF (4, 0)
122 find_complaint (struct complaints
*complaints
, const char *file
,
123 int line
, const char *fmt
)
125 struct complain
*complaint
;
127 /* Find the complaint in the table. A more efficient search
128 algorithm (based on hash table or something) could be used. But
129 that can wait until someone shows evidence that this lookup is
130 a real bottle neck. */
131 for (complaint
= complaints
->root
;
133 complaint
= complaint
->next
)
135 if (complaint
->fmt
== fmt
136 && complaint
->file
== file
137 && complaint
->line
== line
)
141 /* Oops not seen before, fill in a new complaint. */
142 complaint
= XNEW (struct complain
);
143 complaint
->fmt
= fmt
;
144 complaint
->file
= file
;
145 complaint
->line
= line
;
146 complaint
->counter
= 0;
147 complaint
->next
= NULL
;
149 /* File it, return it. */
150 complaint
->next
= complaints
->root
;
151 complaints
->root
= complaint
;
156 /* How many complaints about a particular thing should be printed
157 before we stop whining about it? Default is no whining at all,
158 since so many systems have ill-constructed symbol files. */
160 static int stop_whining
= 0;
162 /* Print a complaint, and link the complaint block into a chain for
165 static void ATTRIBUTE_PRINTF (4, 0)
166 vcomplaint (struct complaints
**c
, const char *file
,
167 int line
, const char *fmt
,
170 struct complaints
*complaints
= get_complaints (c
);
171 struct complain
*complaint
= find_complaint (complaints
, file
,
173 enum complaint_series series
;
175 gdb_assert (complaints
!= NULL
);
177 complaint
->counter
++;
178 if (complaint
->counter
> stop_whining
)
182 series
= SUBSEQUENT_MESSAGE
;
184 series
= complaints
->series
;
186 if (complaint
->file
!= NULL
)
187 internal_vwarning (complaint
->file
, complaint
->line
,
188 complaint
->fmt
, args
);
189 else if (deprecated_warning_hook
)
190 (*deprecated_warning_hook
) (complaint
->fmt
, args
);
193 if (complaints
->explanation
== NULL
)
194 /* A [v]warning() call always appends a newline. */
195 vwarning (complaint
->fmt
, args
);
199 struct cleanup
*cleanups
;
200 msg
= xstrvprintf (complaint
->fmt
, args
);
201 cleanups
= make_cleanup (xfree
, msg
);
203 if (series
!= SUBSEQUENT_MESSAGE
)
206 fprintf_filtered (gdb_stderr
, "%s%s%s",
207 complaints
->explanation
[series
].prefix
, msg
,
208 complaints
->explanation
[series
].postfix
);
209 /* Force a line-break after any isolated message. For the
210 other cases, clear_complaints() takes care of any missing
211 trailing newline, the wrap_here() is just a hint. */
212 if (series
== ISOLATED_MESSAGE
)
213 /* It would be really nice to use begin_line() here.
214 Unfortunately that function doesn't track GDB_STDERR and
215 consequently will sometimes supress a line when it
217 fputs_filtered ("\n", gdb_stderr
);
220 do_cleanups (cleanups
);
226 case ISOLATED_MESSAGE
:
229 complaints
->series
= SUBSEQUENT_MESSAGE
;
231 case SUBSEQUENT_MESSAGE
:
232 case SHORT_FIRST_MESSAGE
:
233 complaints
->series
= SUBSEQUENT_MESSAGE
;
237 /* If GDB dumps core, we'd like to see the complaints first.
238 Presumably GDB will not be sending so many complaints that this
239 becomes a performance hog. */
241 gdb_flush (gdb_stderr
);
245 complaint (struct complaints
**complaints
, const char *fmt
, ...)
249 va_start (args
, fmt
);
250 vcomplaint (complaints
, NULL
/*file*/, 0/*line*/, fmt
, args
);
255 internal_complaint (struct complaints
**complaints
, const char *file
,
256 int line
, const char *fmt
, ...)
259 va_start (args
, fmt
);
260 vcomplaint (complaints
, file
, line
, fmt
, args
);
264 /* Clear out / initialize all complaint counters that have ever been
265 incremented. If LESS_VERBOSE is 1, be less verbose about
266 successive complaints, since the messages are appearing all
267 together during a command that is reporting a contiguous block of
268 complaints (rather than being interleaved with other messages). If
269 noisy is 1, we are in a noisy command, and our caller will print
270 enough context for the user to figure it out. */
273 clear_complaints (struct complaints
**c
, int less_verbose
, int noisy
)
275 struct complaints
*complaints
= get_complaints (c
);
278 for (p
= complaints
->root
; p
!= NULL
; p
= p
->next
)
283 switch (complaints
->series
)
286 /* Haven't yet printed anything. */
288 case SHORT_FIRST_MESSAGE
:
289 /* Haven't yet printed anything. */
291 case ISOLATED_MESSAGE
:
292 /* The code above, always forces a line-break. No need to do it
295 case SUBSEQUENT_MESSAGE
:
296 /* It would be really nice to use begin_line() here.
297 Unfortunately that function doesn't track GDB_STDERR and
298 consequently will sometimes supress a line when it
300 fputs_unfiltered ("\n", gdb_stderr
);
303 internal_error (__FILE__
, __LINE__
, _("bad switch"));
307 complaints
->series
= ISOLATED_MESSAGE
;
309 complaints
->series
= FIRST_MESSAGE
;
311 complaints
->series
= SHORT_FIRST_MESSAGE
;
315 complaints_show_value (struct ui_file
*file
, int from_tty
,
316 struct cmd_list_element
*cmd
, const char *value
)
318 fprintf_filtered (file
, _("Max number of complaints about incorrect"
319 " symbols is %s.\n"),
324 _initialize_complaints (void)
326 add_setshow_zinteger_cmd ("complaints", class_support
,
328 Set max number of complaints about incorrect symbols."), _("\
329 Show max number of complaints about incorrect symbols."), NULL
,
330 NULL
, complaints_show_value
,
331 &setlist
, &showlist
);