1 /* Language-independent diagnostic subroutines for the GNU Compiler Collection
2 Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
3 2009 Free Software Foundation, Inc.
4 Contributed by Gabriel Dos Reis <gdr@codesourcery.com>
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 3, or (at your option) any later
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
23 /* This file implements the language independent aspect of diagnostic
27 #undef FLOAT /* This is for hpux. They should change hpux. */
28 #undef FFS /* Some systems define this in param.h. */
30 #include "coretypes.h"
39 #include "diagnostic.h"
40 #include "langhooks.h"
41 #include "langhooks-def.h"
45 #define pedantic_warning_kind() (flag_pedantic_errors ? DK_ERROR : DK_WARNING)
46 #define permissive_error_kind() (flag_permissive ? DK_WARNING : DK_ERROR)
49 static char *build_message_string (const char *, ...) ATTRIBUTE_PRINTF_1
;
51 static void default_diagnostic_starter (diagnostic_context
*,
53 static void default_diagnostic_finalizer (diagnostic_context
*,
56 static void error_recursion (diagnostic_context
*) ATTRIBUTE_NORETURN
;
58 static void diagnostic_action_after_output (diagnostic_context
*,
60 static void real_abort (void) ATTRIBUTE_NORETURN
;
62 /* A diagnostic_context surrogate for stderr. */
63 static diagnostic_context global_diagnostic_context
;
64 diagnostic_context
*global_dc
= &global_diagnostic_context
;
67 /* Return a malloc'd string containing MSG formatted a la printf. The
68 caller is responsible for freeing the memory. */
70 build_message_string (const char *msg
, ...)
76 vasprintf (&str
, msg
, ap
);
82 /* Same as diagnostic_build_prefix, but only the source FILE is given. */
84 file_name_as_prefix (const char *f
)
86 return build_message_string ("%s: ", f
);
91 /* Initialize the diagnostic message outputting machinery. */
93 diagnostic_initialize (diagnostic_context
*context
)
95 /* Allocate a basic pretty-printer. Clients will replace this a
96 much more elaborated pretty-printer if they wish. */
97 context
->printer
= XNEW (pretty_printer
);
98 pp_construct (context
->printer
, NULL
, 0);
99 /* By default, diagnostics are sent to stderr. */
100 context
->printer
->buffer
->stream
= stderr
;
101 /* By default, we emit prefixes once per message. */
102 context
->printer
->wrapping
.rule
= DIAGNOSTICS_SHOW_PREFIX_ONCE
;
104 memset (context
->diagnostic_count
, 0, sizeof context
->diagnostic_count
);
105 context
->issue_warnings_are_errors_message
= true;
106 context
->warning_as_error_requested
= false;
107 memset (context
->classify_diagnostic
, DK_UNSPECIFIED
,
108 sizeof context
->classify_diagnostic
);
109 context
->show_option_requested
= false;
110 context
->abort_on_error
= false;
111 context
->internal_error
= NULL
;
112 diagnostic_starter (context
) = default_diagnostic_starter
;
113 diagnostic_finalizer (context
) = default_diagnostic_finalizer
;
114 context
->last_module
= 0;
115 context
->last_function
= NULL
;
119 /* Initialize DIAGNOSTIC, where the message MSG has already been
122 diagnostic_set_info_translated (diagnostic_info
*diagnostic
, const char *msg
,
123 va_list *args
, location_t location
,
126 diagnostic
->message
.err_no
= errno
;
127 diagnostic
->message
.args_ptr
= args
;
128 diagnostic
->message
.format_spec
= msg
;
129 diagnostic
->location
= location
;
130 diagnostic
->override_column
= 0;
131 diagnostic
->kind
= kind
;
132 diagnostic
->option_index
= 0;
135 /* Initialize DIAGNOSTIC, where the message GMSGID has not yet been
138 diagnostic_set_info (diagnostic_info
*diagnostic
, const char *gmsgid
,
139 va_list *args
, location_t location
,
142 diagnostic_set_info_translated (diagnostic
, _(gmsgid
), args
, location
, kind
);
145 /* Return a malloc'd string describing a location. The caller is
146 responsible for freeing the memory. */
148 diagnostic_build_prefix (diagnostic_info
*diagnostic
)
150 static const char *const diagnostic_kind_text
[] = {
151 #define DEFINE_DIAGNOSTIC_KIND(K, T) (T),
152 #include "diagnostic.def"
153 #undef DEFINE_DIAGNOSTIC_KIND
156 const char *text
= _(diagnostic_kind_text
[diagnostic
->kind
]);
157 expanded_location s
= expand_location (diagnostic
->location
);
158 if (diagnostic
->override_column
)
159 s
.column
= diagnostic
->override_column
;
160 gcc_assert (diagnostic
->kind
< DK_LAST_DIAGNOSTIC_KIND
);
164 ? build_message_string ("%s: %s", progname
, text
)
166 ? build_message_string ("%s:%d:%d: %s", s
.file
, s
.line
, s
.column
, text
)
167 : build_message_string ("%s:%d: %s", s
.file
, s
.line
, text
));
170 /* Take any action which is expected to happen after the diagnostic
171 is written out. This function does not always return. */
173 diagnostic_action_after_output (diagnostic_context
*context
,
174 diagnostic_info
*diagnostic
)
176 switch (diagnostic
->kind
)
186 if (context
->abort_on_error
)
188 if (flag_fatal_errors
)
190 fnotice (stderr
, "compilation terminated due to -Wfatal-errors.\n");
191 exit (FATAL_EXIT_CODE
);
196 if (context
->abort_on_error
)
199 fnotice (stderr
, "Please submit a full bug report,\n"
200 "with preprocessed source if appropriate.\n"
201 "See %s for instructions.\n", bug_report_url
);
202 exit (ICE_EXIT_CODE
);
205 if (context
->abort_on_error
)
208 fnotice (stderr
, "compilation terminated.\n");
209 exit (FATAL_EXIT_CODE
);
216 /* Prints out, if necessary, the name of the current function
217 that caused an error. Called from all error and warning functions. */
219 diagnostic_report_current_function (diagnostic_context
*context
,
220 diagnostic_info
*diagnostic
)
222 diagnostic_report_current_module (context
);
223 lang_hooks
.print_error_function (context
, input_filename
, diagnostic
);
227 diagnostic_report_current_module (diagnostic_context
*context
)
229 const struct line_map
*map
;
231 if (pp_needs_newline (context
->printer
))
233 pp_newline (context
->printer
);
234 pp_needs_newline (context
->printer
) = false;
237 if (input_location
<= BUILTINS_LOCATION
)
240 map
= linemap_lookup (line_table
, input_location
);
241 if (map
&& diagnostic_last_module_changed (context
, map
))
243 diagnostic_set_last_module (context
, map
);
244 if (! MAIN_FILE_P (map
))
246 map
= INCLUDED_FROM (line_table
, map
);
247 if (flag_show_column
)
248 pp_verbatim (context
->printer
,
249 "In file included from %s:%d:%d",
251 LAST_SOURCE_LINE (map
), LAST_SOURCE_COLUMN (map
));
253 pp_verbatim (context
->printer
,
254 "In file included from %s:%d",
255 map
->to_file
, LAST_SOURCE_LINE (map
));
256 while (! MAIN_FILE_P (map
))
258 map
= INCLUDED_FROM (line_table
, map
);
259 pp_verbatim (context
->printer
,
261 map
->to_file
, LAST_SOURCE_LINE (map
));
263 pp_verbatim (context
->printer
, ":");
264 pp_newline (context
->printer
);
270 default_diagnostic_starter (diagnostic_context
*context
,
271 diagnostic_info
*diagnostic
)
273 diagnostic_report_current_function (context
, diagnostic
);
274 pp_set_prefix (context
->printer
, diagnostic_build_prefix (diagnostic
));
278 default_diagnostic_finalizer (diagnostic_context
*context
,
279 diagnostic_info
*diagnostic ATTRIBUTE_UNUSED
)
281 pp_destroy_prefix (context
->printer
);
284 /* Interface to specify diagnostic kind overrides. Returns the
285 previous setting, or DK_UNSPECIFIED if the parameters are out of
288 diagnostic_classify_diagnostic (diagnostic_context
*context
,
290 diagnostic_t new_kind
)
292 diagnostic_t old_kind
;
294 if (option_index
<= 0
295 || option_index
>= N_OPTS
296 || new_kind
>= DK_LAST_DIAGNOSTIC_KIND
)
297 return DK_UNSPECIFIED
;
299 old_kind
= context
->classify_diagnostic
[option_index
];
300 context
->classify_diagnostic
[option_index
] = new_kind
;
304 /* Report a diagnostic message (an error or a warning) as specified by
305 DC. This function is *the* subroutine in terms of which front-ends
306 should implement their specific diagnostic handling modules. The
307 front-end independent format specifiers are exactly those described
308 in the documentation of output_format.
309 Return true if a diagnostic was printed, false otherwise. */
312 diagnostic_report_diagnostic (diagnostic_context
*context
,
313 diagnostic_info
*diagnostic
)
315 location_t location
= diagnostic
->location
;
316 bool maybe_print_warnings_as_errors_message
= false;
317 const char *saved_format_spec
;
319 /* Give preference to being able to inhibit warnings, before they
320 get reclassified to something else. */
321 if ((diagnostic
->kind
== DK_WARNING
|| diagnostic
->kind
== DK_PEDWARN
)
322 && !diagnostic_report_warnings_p (location
))
325 if (diagnostic
->kind
== DK_PEDWARN
)
326 diagnostic
->kind
= pedantic_warning_kind ();
328 if (context
->lock
> 0)
330 /* If we're reporting an ICE in the middle of some other error,
331 try to flush out the previous error, then let this one
332 through. Don't do this more than once. */
333 if (diagnostic
->kind
== DK_ICE
&& context
->lock
== 1)
334 pp_flush (context
->printer
);
336 error_recursion (context
);
339 /* If the user requested that warnings be treated as errors, so be
340 it. Note that we do this before the next block so that
341 individual warnings can be overridden back to warnings with
343 if (context
->warning_as_error_requested
344 && diagnostic
->kind
== DK_WARNING
)
346 diagnostic
->kind
= DK_ERROR
;
347 maybe_print_warnings_as_errors_message
= true;
350 if (diagnostic
->option_index
)
352 /* This tests if the user provided the appropriate -Wfoo or
354 if (! option_enabled (diagnostic
->option_index
))
356 /* This tests if the user provided the appropriate -Werror=foo
358 if (context
->classify_diagnostic
[diagnostic
->option_index
] != DK_UNSPECIFIED
)
360 diagnostic
->kind
= context
->classify_diagnostic
[diagnostic
->option_index
];
361 maybe_print_warnings_as_errors_message
= false;
363 /* This allows for future extensions, like temporarily disabling
364 warnings for ranges of source code. */
365 if (diagnostic
->kind
== DK_IGNORED
)
369 /* If we changed the kind due to -Werror, and didn't override it, we
370 need to print this message. */
371 if (context
->issue_warnings_are_errors_message
372 && maybe_print_warnings_as_errors_message
)
374 pp_verbatim (context
->printer
,
375 "%s: warnings being treated as errors\n", progname
);
376 context
->issue_warnings_are_errors_message
= false;
381 if (diagnostic
->kind
== DK_ICE
&& plugins_active_p ())
383 fnotice (stderr
, "*** WARNING *** there are active plugins, do not report"
384 " this as a bug unless you can reproduce it without enabling"
386 dump_active_plugins (stderr
);
389 if (diagnostic
->kind
== DK_ICE
)
391 #ifndef ENABLE_CHECKING
392 /* When not checking, ICEs are converted to fatal errors when an
393 error has already occurred. This is counteracted by
395 if ((diagnostic_kind_count (context
, DK_ERROR
) > 0
396 || diagnostic_kind_count (context
, DK_SORRY
) > 0)
397 && !context
->abort_on_error
)
399 expanded_location s
= expand_location (diagnostic
->location
);
400 fnotice (stderr
, "%s:%d: confused by earlier errors, bailing out\n",
402 exit (ICE_EXIT_CODE
);
405 if (context
->internal_error
)
406 (*context
->internal_error
) (diagnostic
->message
.format_spec
,
407 diagnostic
->message
.args_ptr
);
409 ++diagnostic_kind_count (context
, diagnostic
->kind
);
411 saved_format_spec
= diagnostic
->message
.format_spec
;
412 if (context
->show_option_requested
&& diagnostic
->option_index
)
413 diagnostic
->message
.format_spec
414 = ACONCAT ((diagnostic
->message
.format_spec
,
415 " [", cl_options
[diagnostic
->option_index
].opt_text
, "]", NULL
));
417 diagnostic
->message
.locus
= &diagnostic
->location
;
418 diagnostic
->message
.abstract_origin
= &diagnostic
->abstract_origin
;
419 diagnostic
->abstract_origin
= NULL
;
420 pp_format (context
->printer
, &diagnostic
->message
);
421 (*diagnostic_starter (context
)) (context
, diagnostic
);
422 pp_output_formatted_text (context
->printer
);
423 (*diagnostic_finalizer (context
)) (context
, diagnostic
);
424 pp_flush (context
->printer
);
425 diagnostic_action_after_output (context
, diagnostic
);
426 diagnostic
->message
.format_spec
= saved_format_spec
;
427 diagnostic
->abstract_origin
= NULL
;
434 /* Given a partial pathname as input, return another pathname that
435 shares no directory elements with the pathname of __FILE__. This
436 is used by fancy_abort() to print `Internal compiler error in expr.c'
437 instead of `Internal compiler error in ../../GCC/gcc/expr.c'. */
440 trim_filename (const char *name
)
442 static const char this_file
[] = __FILE__
;
443 const char *p
= name
, *q
= this_file
;
445 /* First skip any "../" in each filename. This allows us to give a proper
446 reference to a file in a subdirectory. */
447 while (p
[0] == '.' && p
[1] == '.' && IS_DIR_SEPARATOR (p
[2]))
450 while (q
[0] == '.' && q
[1] == '.' && IS_DIR_SEPARATOR (q
[2]))
453 /* Now skip any parts the two filenames have in common. */
454 while (*p
== *q
&& *p
!= 0 && *q
!= 0)
457 /* Now go backwards until the previous directory separator. */
458 while (p
> name
&& !IS_DIR_SEPARATOR (p
[-1]))
464 /* Standard error reporting routines in increasing order of severity.
465 All of these take arguments like printf. */
467 /* Text to be emitted verbatim to the error message stream; this
468 produces no prefix and disables line-wrapping. Use rarely. */
470 verbatim (const char *gmsgid
, ...)
475 va_start (ap
, gmsgid
);
478 text
.format_spec
= _(gmsgid
);
480 text
.abstract_origin
= NULL
;
481 pp_format_verbatim (global_dc
->printer
, &text
);
482 pp_flush (global_dc
->printer
);
487 emit_diagnostic (diagnostic_t kind
, location_t location
, int opt
,
488 const char *gmsgid
, ...)
490 diagnostic_info diagnostic
;
493 va_start (ap
, gmsgid
);
494 if (kind
== DK_PERMERROR
)
496 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, location
,
497 permissive_error_kind ());
498 diagnostic
.option_index
= OPT_fpermissive
;
501 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, location
, kind
);
502 if (kind
== DK_WARNING
|| kind
== DK_PEDWARN
)
503 diagnostic
.option_index
= opt
;
507 return report_diagnostic (&diagnostic
);
510 /* An informative note at LOCATION. Use this for additional details on an error
513 inform (location_t location
, const char *gmsgid
, ...)
515 diagnostic_info diagnostic
;
518 va_start (ap
, gmsgid
);
519 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, location
, DK_NOTE
);
520 report_diagnostic (&diagnostic
);
524 /* A warning at INPUT_LOCATION. Use this for code which is correct according
525 to the relevant language specification but is likely to be buggy anyway.
526 Returns true if the warning was printed, false if it was inhibited. */
528 warning (int opt
, const char *gmsgid
, ...)
530 diagnostic_info diagnostic
;
533 va_start (ap
, gmsgid
);
534 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, input_location
, DK_WARNING
);
535 diagnostic
.option_index
= opt
;
538 return report_diagnostic (&diagnostic
);
541 /* A warning at LOCATION. Use this for code which is correct according to the
542 relevant language specification but is likely to be buggy anyway.
543 Returns true if the warning was printed, false if it was inhibited. */
546 warning_at (location_t location
, int opt
, const char *gmsgid
, ...)
548 diagnostic_info diagnostic
;
551 va_start (ap
, gmsgid
);
552 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, location
, DK_WARNING
);
553 diagnostic
.option_index
= opt
;
555 return report_diagnostic (&diagnostic
);
558 /* A "pedantic" warning at LOCATION: issues a warning unless
559 -pedantic-errors was given on the command line, in which case it
560 issues an error. Use this for diagnostics required by the relevant
561 language standard, if you have chosen not to make them errors.
563 Note that these diagnostics are issued independent of the setting
564 of the -pedantic command-line switch. To get a warning enabled
565 only with that switch, use either "if (pedantic) pedwarn
566 (OPT_pedantic,...)" or just "pedwarn (OPT_pedantic,..)". To get a
567 pedwarn independently of the -pedantic switch use "pedwarn (0,...)".
569 Returns true if the warning was printed, false if it was inhibited. */
572 pedwarn (location_t location
, int opt
, const char *gmsgid
, ...)
574 diagnostic_info diagnostic
;
577 va_start (ap
, gmsgid
);
578 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, location
, DK_PEDWARN
);
579 diagnostic
.option_index
= opt
;
581 return report_diagnostic (&diagnostic
);
584 /* A "permissive" error at LOCATION: issues an error unless
585 -fpermissive was given on the command line, in which case it issues
586 a warning. Use this for things that really should be errors but we
587 want to support legacy code.
589 Returns true if the warning was printed, false if it was inhibited. */
592 permerror (location_t location
, const char *gmsgid
, ...)
594 diagnostic_info diagnostic
;
597 va_start (ap
, gmsgid
);
598 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, location
,
599 permissive_error_kind ());
600 diagnostic
.option_index
= OPT_fpermissive
;
602 return report_diagnostic (&diagnostic
);
605 /* A hard error: the code is definitely ill-formed, and an object file
606 will not be produced. */
608 error (const char *gmsgid
, ...)
610 diagnostic_info diagnostic
;
613 va_start (ap
, gmsgid
);
614 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, input_location
, DK_ERROR
);
615 report_diagnostic (&diagnostic
);
619 /* Same as ebove, but use location LOC instead of input_location. */
621 error_at (location_t loc
, const char *gmsgid
, ...)
623 diagnostic_info diagnostic
;
626 va_start (ap
, gmsgid
);
627 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, loc
, DK_ERROR
);
628 report_diagnostic (&diagnostic
);
632 /* "Sorry, not implemented." Use for a language feature which is
633 required by the relevant specification but not implemented by GCC.
634 An object file will not be produced. */
636 sorry (const char *gmsgid
, ...)
638 diagnostic_info diagnostic
;
641 va_start (ap
, gmsgid
);
642 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, input_location
, DK_SORRY
);
643 report_diagnostic (&diagnostic
);
647 /* An error which is severe enough that we make no attempt to
648 continue. Do not use this for internal consistency checks; that's
649 internal_error. Use of this function should be rare. */
651 fatal_error (const char *gmsgid
, ...)
653 diagnostic_info diagnostic
;
656 va_start (ap
, gmsgid
);
657 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, input_location
, DK_FATAL
);
658 report_diagnostic (&diagnostic
);
664 /* An internal consistency check has failed. We make no attempt to
665 continue. Note that unless there is debugging value to be had from
666 a more specific message, or some other good reason, you should use
667 abort () instead of calling this function directly. */
669 internal_error (const char *gmsgid
, ...)
671 diagnostic_info diagnostic
;
674 va_start (ap
, gmsgid
);
675 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, input_location
, DK_ICE
);
676 report_diagnostic (&diagnostic
);
682 /* Special case error functions. Most are implemented in terms of the
683 above, or should be. */
685 /* Print a diagnostic MSGID on FILE. This is just fprintf, except it
686 runs its second argument through gettext. */
688 fnotice (FILE *file
, const char *cmsgid
, ...)
692 va_start (ap
, cmsgid
);
693 vfprintf (file
, _(cmsgid
), ap
);
697 /* Inform the user that an error occurred while trying to report some
698 other error. This indicates catastrophic internal inconsistencies,
699 so give up now. But do try to flush out the previous error.
700 This mustn't use internal_error, that will cause infinite recursion. */
703 error_recursion (diagnostic_context
*context
)
705 diagnostic_info diagnostic
;
707 if (context
->lock
< 3)
708 pp_flush (context
->printer
);
711 "Internal compiler error: Error reporting routines re-entered.\n");
713 /* Call diagnostic_action_after_output to get the "please submit a bug
714 report" message. It only looks at the kind field of diagnostic_info. */
715 diagnostic
.kind
= DK_ICE
;
716 diagnostic_action_after_output (context
, &diagnostic
);
718 /* Do not use gcc_unreachable here; that goes through internal_error
719 and therefore would cause infinite recursion. */
723 /* Report an internal compiler error in a friendly manner. This is
724 the function that gets called upon use of abort() in the source
725 code generally, thanks to a special macro. */
728 fancy_abort (const char *file
, int line
, const char *function
)
730 internal_error ("in %s, at %s:%d", function
, trim_filename (file
), line
);
733 /* Really call the system 'abort'. This has to go right at the end of
734 this file, so that there are no functions after it that call abort
735 and get the system abort instead of our macro. */