/* Dump infrastructure for optimizations and intermediate representation.
- Copyright (C) 2012-2018 Free Software Foundation, Inc.
+ Copyright (C) 2012-2020 Free Software Foundation, Inc.
This file is part of GCC.
#include "tree-pass.h" /* for "current_pass". */
#include "optinfo-emit-json.h"
#include "stringpool.h" /* for get_identifier. */
+#include "spellcheck.h"
/* If non-NULL, return one past-the-end of the matching SUBPART of
the WHOLE string. */
static dump_flags_t pflags; /* current dump_flags */
-static void dump_loc (dump_flags_t, FILE *, source_location);
+static void dump_loc (dump_flags_t, FILE *, location_t);
/* Current -fopt-info output stream, if any, and flags. */
static FILE *alt_dump_file = NULL;
in dumpfile.h and opt_info_options below. */
static const kv_pair<dump_flags_t> dump_options[] =
{
+ {"none", TDF_NONE},
{"address", TDF_ADDRESS},
{"asmname", TDF_ASMNAME},
{"slim", TDF_SLIM},
{"optimized", MSG_OPTIMIZED_LOCATIONS},
{"missed", MSG_MISSED_OPTIMIZATION},
{"note", MSG_NOTE},
- {"optall", MSG_ALL},
+ {"optall", MSG_ALL_KINDS},
{"all", dump_flags_t (TDF_ALL_VALUES
& ~(TDF_RAW | TDF_SLIM | TDF_LINENO | TDF_GRAPH
| TDF_STMTADDR | TDF_RHS_ONLY | TDF_NOUID
{"optimized", MSG_OPTIMIZED_LOCATIONS},
{"missed", MSG_MISSED_OPTIMIZATION},
{"note", MSG_NOTE},
- {"all", MSG_ALL},
+ {"all", MSG_ALL_KINDS},
+ {"internals", MSG_PRIORITY_INTERNALS},
{NULL, TDF_NONE}
};
static const char *
kind_as_string (dump_flags_t dump_kind)
{
- switch (dump_kind & MSG_ALL)
+ switch (dump_kind & MSG_ALL_KINDS)
{
default:
gcc_unreachable ();
/* Print source location on DFILE if enabled. */
static void
-dump_loc (dump_flags_t dump_kind, FILE *dfile, source_location loc)
+dump_loc (dump_flags_t dump_kind, FILE *dfile, location_t loc)
{
if (dump_kind)
{
/* Print source location to PP if enabled. */
static void
-dump_loc (dump_flags_t dump_kind, pretty_printer *pp, source_location loc)
+dump_loc (dump_flags_t dump_kind, pretty_printer *pp, location_t loc)
{
if (dump_kind)
{
delete m_pending;
}
+void
+dump_context::set_json_writer (optrecord_json_writer *writer)
+{
+ delete m_json_writer;
+ m_json_writer = writer;
+}
+
+/* Perform cleanup activity for -fsave-optimization-record.
+ Currently, the file is written out here in one go, before cleaning
+ up. */
+
+void
+dump_context::finish_any_json_writer ()
+{
+ if (!m_json_writer)
+ return;
+
+ m_json_writer->write ();
+ delete m_json_writer;
+ m_json_writer = NULL;
+}
+
/* Update the "dumps_are_enabled" global; to be called whenever dump_file
or alt_dump_file change, or when changing dump_context in selftests. */
|| m_test_pp);
}
+/* Determine if a message of kind DUMP_KIND and at the current scope depth
+ should be printed.
+
+ Only show messages that match FILTER both on their kind *and*
+ their priority. */
+
+bool
+dump_context::apply_dump_filter_p (dump_flags_t dump_kind,
+ dump_flags_t filter) const
+{
+ /* Few messages, if any, have an explicit MSG_PRIORITY.
+ If DUMP_KIND does, we'll use it.
+ Otherwise, generate an implicit priority value for the message based
+ on the current scope depth.
+ Messages at the top-level scope are MSG_PRIORITY_USER_FACING,
+ whereas those in nested scopes are MSG_PRIORITY_INTERNALS. */
+ if (!(dump_kind & MSG_ALL_PRIORITIES))
+ {
+ dump_flags_t implicit_priority
+ = (m_scope_depth > 0
+ ? MSG_PRIORITY_INTERNALS
+ : MSG_PRIORITY_USER_FACING);
+ dump_kind |= implicit_priority;
+ }
+
+ return (dump_kind & (filter & MSG_ALL_KINDS)
+ && dump_kind & (filter & MSG_ALL_PRIORITIES));
+}
+
/* Print LOC to the appropriate dump destinations, given DUMP_KIND.
If optinfos are enabled, begin a new optinfo. */
void
-dump_context::dump_loc (dump_flags_t dump_kind, const dump_location_t &loc)
+dump_context::dump_loc (const dump_metadata_t &metadata,
+ const dump_user_location_t &loc)
{
end_any_optinfo ();
+ dump_loc_immediate (metadata.get_dump_flags (), loc);
+
+ if (optinfo_enabled_p ())
+ begin_next_optinfo (metadata, loc);
+}
+
+/* As dump_loc above, but without starting a new optinfo. */
+
+void
+dump_context::dump_loc_immediate (dump_flags_t dump_kind,
+ const dump_user_location_t &loc)
+{
location_t srcloc = loc.get_location_t ();
- if (dump_file && (dump_kind & pflags))
+ if (dump_file && apply_dump_filter_p (dump_kind, pflags))
::dump_loc (dump_kind, dump_file, srcloc);
- if (alt_dump_file && (dump_kind & alt_flags))
+ if (alt_dump_file && apply_dump_filter_p (dump_kind, alt_flags))
::dump_loc (dump_kind, alt_dump_file, srcloc);
/* Support for temp_dump_context in selftests. */
- if (m_test_pp && (dump_kind & m_test_pp_flags))
+ if (m_test_pp && apply_dump_filter_p (dump_kind, m_test_pp_flags))
::dump_loc (dump_kind, m_test_pp, srcloc);
-
- if (optinfo_enabled_p ())
- {
- optinfo &info = begin_next_optinfo (loc);
- info.handle_dump_file_kind (dump_kind);
- }
}
/* Make an item for the given dump call, equivalent to print_gimple_stmt. */
EXTRA_DUMP_FLAGS on the dump streams if DUMP_KIND is enabled. */
void
-dump_context::dump_gimple_stmt (dump_flags_t dump_kind,
+dump_context::dump_gimple_stmt (const dump_metadata_t &metadata,
dump_flags_t extra_dump_flags,
gimple *gs, int spc)
{
optinfo_item *item
= make_item_for_dump_gimple_stmt (gs, spc, dump_flags | extra_dump_flags);
- emit_item (item, dump_kind);
+ emit_item (item, metadata.get_dump_flags ());
if (optinfo_enabled_p ())
{
- optinfo &info = ensure_pending_optinfo ();
- info.handle_dump_file_kind (dump_kind);
+ optinfo &info = ensure_pending_optinfo (metadata);
info.add_item (item);
}
else
/* Similar to dump_gimple_stmt, except additionally print source location. */
void
-dump_context::dump_gimple_stmt_loc (dump_flags_t dump_kind,
- const dump_location_t &loc,
+dump_context::dump_gimple_stmt_loc (const dump_metadata_t &metadata,
+ const dump_user_location_t &loc,
dump_flags_t extra_dump_flags,
gimple *gs, int spc)
{
- dump_loc (dump_kind, loc);
- dump_gimple_stmt (dump_kind, extra_dump_flags, gs, spc);
+ dump_loc (metadata, loc);
+ dump_gimple_stmt (metadata, extra_dump_flags, gs, spc);
}
/* Make an item for the given dump call, equivalent to print_gimple_expr. */
Do not terminate with a newline or semicolon. */
void
-dump_context::dump_gimple_expr (dump_flags_t dump_kind,
+dump_context::dump_gimple_expr (const dump_metadata_t &metadata,
dump_flags_t extra_dump_flags,
gimple *gs, int spc)
{
optinfo_item *item
= make_item_for_dump_gimple_expr (gs, spc, dump_flags | extra_dump_flags);
- emit_item (item, dump_kind);
+ emit_item (item, metadata.get_dump_flags ());
if (optinfo_enabled_p ())
{
- optinfo &info = ensure_pending_optinfo ();
- info.handle_dump_file_kind (dump_kind);
+ optinfo &info = ensure_pending_optinfo (metadata);
info.add_item (item);
}
else
/* Similar to dump_gimple_expr, except additionally print source location. */
void
-dump_context::dump_gimple_expr_loc (dump_flags_t dump_kind,
- const dump_location_t &loc,
+dump_context::dump_gimple_expr_loc (const dump_metadata_t &metadata,
+ const dump_user_location_t &loc,
dump_flags_t extra_dump_flags,
gimple *gs,
int spc)
{
- dump_loc (dump_kind, loc);
- dump_gimple_expr (dump_kind, extra_dump_flags, gs, spc);
+ dump_loc (metadata, loc);
+ dump_gimple_expr (metadata, extra_dump_flags, gs, spc);
}
/* Make an item for the given dump call, equivalent to print_generic_expr. */
DUMP_KIND is enabled. */
void
-dump_context::dump_generic_expr (dump_flags_t dump_kind,
+dump_context::dump_generic_expr (const dump_metadata_t &metadata,
dump_flags_t extra_dump_flags,
tree t)
{
optinfo_item *item
= make_item_for_dump_generic_expr (t, dump_flags | extra_dump_flags);
- emit_item (item, dump_kind);
+ emit_item (item, metadata.get_dump_flags ());
if (optinfo_enabled_p ())
{
- optinfo &info = ensure_pending_optinfo ();
- info.handle_dump_file_kind (dump_kind);
+ optinfo &info = ensure_pending_optinfo (metadata);
info.add_item (item);
}
else
location. */
void
-dump_context::dump_generic_expr_loc (dump_flags_t dump_kind,
- const dump_location_t &loc,
+dump_context::dump_generic_expr_loc (const dump_metadata_t &metadata,
+ const dump_user_location_t &loc,
dump_flags_t extra_dump_flags,
tree t)
{
- dump_loc (dump_kind, loc);
- dump_generic_expr (dump_kind, extra_dump_flags, t);
+ dump_loc (metadata, loc);
+ dump_generic_expr (metadata, extra_dump_flags, t);
}
-/* A subclass of pretty_printer for implementing dump_context::dump_printf_va.
- In particular, the formatted chunks are captured as optinfo_item instances,
- thus retaining metadata about the entities being dumped (e.g. source
- locations), rather than just as plain text. */
+/* Make an item for the given dump call. */
-class dump_pretty_printer : public pretty_printer
+static optinfo_item *
+make_item_for_dump_symtab_node (symtab_node *node)
{
-public:
- dump_pretty_printer (dump_context *context, dump_flags_t dump_kind);
-
- void emit_items (optinfo *dest);
-
-private:
- /* Information on an optinfo_item that was generated during phase 2 of
- formatting. */
- struct stashed_item
- {
- stashed_item (const char **buffer_ptr_, optinfo_item *item_)
- : buffer_ptr (buffer_ptr_), item (item_) {}
- const char **buffer_ptr;
- optinfo_item *item;
- };
-
- static bool format_decoder_cb (pretty_printer *pp, text_info *text,
- const char *spec, int /*precision*/,
- bool /*wide*/, bool /*set_locus*/,
- bool /*verbose*/, bool */*quoted*/,
- const char **buffer_ptr);
-
- bool decode_format (text_info *text, const char *spec,
- const char **buffer_ptr);
-
- void stash_item (const char **buffer_ptr, optinfo_item *item);
-
- void emit_any_pending_textual_chunks (optinfo *dest);
-
- void emit_item (optinfo_item *item, optinfo *dest);
-
- dump_context *m_context;
- dump_flags_t m_dump_kind;
- auto_vec<stashed_item> m_stashed_items;
-};
+ location_t loc = DECL_SOURCE_LOCATION (node->decl);
+ optinfo_item *item
+ = new optinfo_item (OPTINFO_ITEM_KIND_SYMTAB_NODE, loc,
+ xstrdup (node->dump_name ()));
+ return item;
+}
/* dump_pretty_printer's ctor. */
Supported format codes (in addition to the standard pretty_printer ones)
are:
+ %C: cgraph_node *:
+ Equivalent to: dump_symtab_node (MSG_*, node)
%E: gimple *:
Equivalent to: dump_gimple_expr (MSG_*, TDF_SLIM, stmt, 0)
%G: gimple *:
%T: tree:
Equivalent to: dump_generic_expr (MSG_*, arg, TDF_SLIM).
- FIXME: add symtab_node?
+ TODO: add a format code that can handle (symtab_node*) *and* both
+ subclasses (presumably means teaching -Wformat about non-virtual
+ subclasses).
These format codes build optinfo_item instances, thus capturing metadata
about the arguments being dumped, as well as the textual output. */
for later use (to capture metadata, rather than plain text). */
switch (*spec)
{
+ case 'C':
+ {
+ cgraph_node *node = va_arg (*text->args_ptr, cgraph_node *);
+
+ /* Make an item for the node, and stash it. */
+ optinfo_item *item = make_item_for_dump_symtab_node (node);
+ stash_item (buffer_ptr, item);
+ return true;
+ }
+
case 'E':
{
gimple *stmt = va_arg (*text->args_ptr, gimple *);
/* Output a formatted message using FORMAT on appropriate dump streams. */
void
-dump_context::dump_printf_va (dump_flags_t dump_kind, const char *format,
+dump_context::dump_printf_va (const dump_metadata_t &metadata, const char *format,
va_list *ap)
{
- dump_pretty_printer pp (this, dump_kind);
+ dump_pretty_printer pp (this, metadata.get_dump_flags ());
text_info text;
text.err_no = errno;
/* Phase 3. */
if (optinfo_enabled_p ())
{
- optinfo &info = ensure_pending_optinfo ();
- info.handle_dump_file_kind (dump_kind);
+ optinfo &info = ensure_pending_optinfo (metadata);
pp.emit_items (&info);
}
else
dump location captured. */
void
-dump_context::dump_printf_loc_va (dump_flags_t dump_kind,
- const dump_location_t &loc,
+dump_context::dump_printf_loc_va (const dump_metadata_t &metadata,
+ const dump_user_location_t &loc,
const char *format, va_list *ap)
{
- dump_loc (dump_kind, loc);
- dump_printf_va (dump_kind, format, ap);
+ dump_loc (metadata, loc);
+ dump_printf_va (metadata, format, ap);
}
/* Make an item for the given dump call, equivalent to print_dec. */
template<unsigned int N, typename C>
void
-dump_context::dump_dec (dump_flags_t dump_kind, const poly_int<N, C> &value)
+dump_context::dump_dec (const dump_metadata_t &metadata, const poly_int<N, C> &value)
{
optinfo_item *item = make_item_for_dump_dec (value);
- emit_item (item, dump_kind);
+ emit_item (item, metadata.get_dump_flags ());
if (optinfo_enabled_p ())
{
- optinfo &info = ensure_pending_optinfo ();
- info.handle_dump_file_kind (dump_kind);
+ optinfo &info = ensure_pending_optinfo (metadata);
info.add_item (item);
}
else
delete item;
}
-/* Make an item for the given dump call. */
-
-static optinfo_item *
-make_item_for_dump_symtab_node (symtab_node *node)
-{
- location_t loc = DECL_SOURCE_LOCATION (node->decl);
- optinfo_item *item
- = new optinfo_item (OPTINFO_ITEM_KIND_SYMTAB_NODE, loc,
- xstrdup (node->dump_name ()));
- return item;
-}
-
/* Output the name of NODE on appropriate dump streams. */
void
-dump_context::dump_symtab_node (dump_flags_t dump_kind, symtab_node *node)
+dump_context::dump_symtab_node (const dump_metadata_t &metadata, symtab_node *node)
{
optinfo_item *item = make_item_for_dump_symtab_node (node);
- emit_item (item, dump_kind);
+ emit_item (item, metadata.get_dump_flags ());
if (optinfo_enabled_p ())
{
- optinfo &info = ensure_pending_optinfo ();
- info.handle_dump_file_kind (dump_kind);
+ optinfo &info = ensure_pending_optinfo (metadata);
info.add_item (item);
}
else
}
/* Push a nested dump scope.
+ Increment the scope depth.
Print "=== NAME ===\n" to the dumpfile, if any, and to the -fopt-info
destination, if any.
- Emit a "scope" optinfo if optinfos are enabled.
- Increment the scope depth. */
+ Emit a "scope" optinfo if optinfos are enabled. */
void
-dump_context::begin_scope (const char *name, const dump_location_t &loc)
+dump_context::begin_scope (const char *name,
+ const dump_user_location_t &user_location,
+ const dump_impl_location_t &impl_location)
{
- if (dump_file && (MSG_NOTE & pflags))
- ::dump_loc (MSG_NOTE, dump_file, loc.get_location_t ());
+ m_scope_depth++;
+
+ location_t src_loc = user_location.get_location_t ();
- if (alt_dump_file && (MSG_NOTE & alt_flags))
- ::dump_loc (MSG_NOTE, alt_dump_file, loc.get_location_t ());
+ if (dump_file && apply_dump_filter_p (MSG_NOTE, pflags))
+ ::dump_loc (MSG_NOTE, dump_file, src_loc);
+
+ if (alt_dump_file && apply_dump_filter_p (MSG_NOTE, alt_flags))
+ ::dump_loc (MSG_NOTE, alt_dump_file, src_loc);
/* Support for temp_dump_context in selftests. */
- if (m_test_pp && (MSG_NOTE & m_test_pp_flags))
- ::dump_loc (MSG_NOTE, m_test_pp, loc.get_location_t ());
+ if (m_test_pp && apply_dump_filter_p (MSG_NOTE, m_test_pp_flags))
+ ::dump_loc (MSG_NOTE, m_test_pp, src_loc);
pretty_printer pp;
pp_printf (&pp, "=== %s ===\n", name);
if (optinfo_enabled_p ())
{
- optinfo &info = begin_next_optinfo (loc);
+ optinfo &info
+ = begin_next_optinfo (dump_metadata_t (MSG_NOTE, impl_location),
+ user_location);
info.m_kind = OPTINFO_KIND_SCOPE;
info.add_item (item);
+ end_any_optinfo ();
}
else
delete item;
-
- m_scope_depth++;
}
/* Pop a nested dump scope. */
{
end_any_optinfo ();
m_scope_depth--;
- optimization_records_maybe_pop_dump_scope ();
+
+ if (m_json_writer)
+ m_json_writer->pop_scope ();
+}
+
+/* Should optinfo instances be created?
+ All creation of optinfos should be guarded by this predicate.
+ Return true if any optinfo destinations are active. */
+
+bool
+dump_context::optinfo_enabled_p () const
+{
+ return (optimization_records_enabled_p ());
}
/* Return the optinfo currently being accumulated, creating one if
necessary. */
optinfo &
-dump_context::ensure_pending_optinfo ()
+dump_context::ensure_pending_optinfo (const dump_metadata_t &metadata)
{
if (!m_pending)
- return begin_next_optinfo (dump_location_t (dump_user_location_t ()));
+ return begin_next_optinfo (metadata, dump_user_location_t ());
return *m_pending;
}
accumulated. */
optinfo &
-dump_context::begin_next_optinfo (const dump_location_t &loc)
+dump_context::begin_next_optinfo (const dump_metadata_t &metadata,
+ const dump_user_location_t &user_loc)
{
end_any_optinfo ();
gcc_assert (m_pending == NULL);
+ dump_location_t loc (user_loc, metadata.get_impl_location ());
m_pending = new optinfo (loc, OPTINFO_KIND_NOTE, current_pass);
+ m_pending->handle_dump_file_kind (metadata.get_dump_flags ());
return *m_pending;
}
dump_context::end_any_optinfo ()
{
if (m_pending)
- m_pending->emit ();
+ emit_optinfo (m_pending);
delete m_pending;
m_pending = NULL;
}
+/* Emit the optinfo to all of the "non-immediate" destinations
+ (emission to "immediate" destinations is done by
+ dump_context::emit_item). */
+
+void
+dump_context::emit_optinfo (const optinfo *info)
+{
+ /* -fsave-optimization-record. */
+ if (m_json_writer)
+ m_json_writer->add_record (info);
+}
+
/* Emit ITEM to all item destinations (those that don't require
consolidation into optinfo instances). */
void
dump_context::emit_item (optinfo_item *item, dump_flags_t dump_kind)
{
- if (dump_file && (dump_kind & pflags))
+ if (dump_file && apply_dump_filter_p (dump_kind, pflags))
fprintf (dump_file, "%s", item->get_text ());
- if (alt_dump_file && (dump_kind & alt_flags))
+ if (alt_dump_file && apply_dump_filter_p (dump_kind, alt_flags))
fprintf (alt_dump_file, "%s", item->get_text ());
/* Support for temp_dump_context in selftests. */
- if (m_test_pp && (dump_kind & m_test_pp_flags))
+ if (m_test_pp && apply_dump_filter_p (dump_kind, m_test_pp_flags))
pp_string (m_test_pp, item->get_text ());
}
/* Implementation of dump_* API calls, calling into dump_context
member functions. */
+/* Calls to the dump_* functions do non-trivial work, so they ought
+ to be guarded by:
+ if (dump_enabled_p ())
+ Assert that they are guarded, and, if assertions are disabled,
+ bail out if the calls weren't properly guarded. */
+
+#define VERIFY_DUMP_ENABLED_P \
+ do { \
+ gcc_assert (dump_enabled_p ()); \
+ if (!dump_enabled_p ()) \
+ return; \
+ } while (0)
+
/* Dump gimple statement GS with SPC indentation spaces and
EXTRA_DUMP_FLAGS on the dump streams if DUMP_KIND is enabled. */
void
-dump_gimple_stmt (dump_flags_t dump_kind, dump_flags_t extra_dump_flags,
+dump_gimple_stmt (const dump_metadata_t &metadata, dump_flags_t extra_dump_flags,
gimple *gs, int spc)
{
- dump_context::get ().dump_gimple_stmt (dump_kind, extra_dump_flags, gs, spc);
+ VERIFY_DUMP_ENABLED_P;
+ dump_context::get ().dump_gimple_stmt (metadata, extra_dump_flags, gs, spc);
}
/* Similar to dump_gimple_stmt, except additionally print source location. */
void
-dump_gimple_stmt_loc (dump_flags_t dump_kind, const dump_location_t &loc,
+dump_gimple_stmt_loc (const dump_metadata_t &metadata,
+ const dump_user_location_t &loc,
dump_flags_t extra_dump_flags, gimple *gs, int spc)
{
- dump_context::get ().dump_gimple_stmt_loc (dump_kind, loc, extra_dump_flags,
+ VERIFY_DUMP_ENABLED_P;
+ dump_context::get ().dump_gimple_stmt_loc (metadata, loc, extra_dump_flags,
gs, spc);
}
Do not terminate with a newline or semicolon. */
void
-dump_gimple_expr (dump_flags_t dump_kind, dump_flags_t extra_dump_flags,
+dump_gimple_expr (const dump_metadata_t &metadata,
+ dump_flags_t extra_dump_flags,
gimple *gs, int spc)
{
- dump_context::get ().dump_gimple_expr (dump_kind, extra_dump_flags, gs, spc);
+ VERIFY_DUMP_ENABLED_P;
+ dump_context::get ().dump_gimple_expr (metadata, extra_dump_flags, gs, spc);
}
/* Similar to dump_gimple_expr, except additionally print source location. */
void
-dump_gimple_expr_loc (dump_flags_t dump_kind, const dump_location_t &loc,
+dump_gimple_expr_loc (const dump_metadata_t &metadata,
+ const dump_user_location_t &loc,
dump_flags_t extra_dump_flags, gimple *gs, int spc)
{
- dump_context::get ().dump_gimple_expr_loc (dump_kind, loc, extra_dump_flags,
+ VERIFY_DUMP_ENABLED_P;
+ dump_context::get ().dump_gimple_expr_loc (metadata, loc, extra_dump_flags,
gs, spc);
}
DUMP_KIND is enabled. */
void
-dump_generic_expr (dump_flags_t dump_kind, dump_flags_t extra_dump_flags,
+dump_generic_expr (const dump_metadata_t &metadata, dump_flags_t extra_dump_flags,
tree t)
{
- dump_context::get ().dump_generic_expr (dump_kind, extra_dump_flags, t);
+ VERIFY_DUMP_ENABLED_P;
+ dump_context::get ().dump_generic_expr (metadata, extra_dump_flags, t);
}
/* Similar to dump_generic_expr, except additionally print the source
location. */
void
-dump_generic_expr_loc (dump_flags_t dump_kind, const dump_location_t &loc,
+dump_generic_expr_loc (const dump_metadata_t &metadata,
+ const dump_user_location_t &loc,
dump_flags_t extra_dump_flags, tree t)
{
- dump_context::get ().dump_generic_expr_loc (dump_kind, loc, extra_dump_flags,
+ VERIFY_DUMP_ENABLED_P;
+ dump_context::get ().dump_generic_expr_loc (metadata, loc, extra_dump_flags,
t);
}
/* Output a formatted message using FORMAT on appropriate dump streams. */
void
-dump_printf (dump_flags_t dump_kind, const char *format, ...)
+dump_printf (const dump_metadata_t &metadata, const char *format, ...)
{
+ VERIFY_DUMP_ENABLED_P;
va_list ap;
va_start (ap, format);
- dump_context::get ().dump_printf_va (dump_kind, format, &ap);
+ dump_context::get ().dump_printf_va (metadata, format, &ap);
va_end (ap);
}
dump location captured. */
void
-dump_printf_loc (dump_flags_t dump_kind, const dump_location_t &loc,
+dump_printf_loc (const dump_metadata_t &metadata,
+ const dump_user_location_t &loc,
const char *format, ...)
{
+ VERIFY_DUMP_ENABLED_P;
va_list ap;
va_start (ap, format);
- dump_context::get ().dump_printf_loc_va (dump_kind, loc, format, &ap);
+ dump_context::get ().dump_printf_loc_va (metadata, loc, format, &ap);
va_end (ap);
}
template<unsigned int N, typename C>
void
-dump_dec (dump_flags_t dump_kind, const poly_int<N, C> &value)
+dump_dec (const dump_metadata_t &metadata, const poly_int<N, C> &value)
{
- dump_context::get ().dump_dec (dump_kind, value);
+ VERIFY_DUMP_ENABLED_P;
+ dump_context::get ().dump_dec (metadata, value);
}
-template void dump_dec (dump_flags_t, const poly_uint16 &);
-template void dump_dec (dump_flags_t, const poly_int64 &);
-template void dump_dec (dump_flags_t, const poly_uint64 &);
-template void dump_dec (dump_flags_t, const poly_offset_int &);
-template void dump_dec (dump_flags_t, const poly_widest_int &);
+template void dump_dec (const dump_metadata_t &metadata, const poly_uint16 &);
+template void dump_dec (const dump_metadata_t &metadata, const poly_int64 &);
+template void dump_dec (const dump_metadata_t &metadata, const poly_uint64 &);
+template void dump_dec (const dump_metadata_t &metadata, const poly_offset_int &);
+template void dump_dec (const dump_metadata_t &metadata, const poly_widest_int &);
void
dump_dec (dump_flags_t dump_kind, const poly_wide_int &value, signop sgn)
{
- if (dump_file && (dump_kind & pflags))
+ VERIFY_DUMP_ENABLED_P;
+ if (dump_file
+ && dump_context::get ().apply_dump_filter_p (dump_kind, pflags))
print_dec (value, dump_file, sgn);
- if (alt_dump_file && (dump_kind & alt_flags))
+ if (alt_dump_file
+ && dump_context::get ().apply_dump_filter_p (dump_kind, alt_flags))
print_dec (value, alt_dump_file, sgn);
}
void
dump_hex (dump_flags_t dump_kind, const poly_wide_int &value)
{
- if (dump_file && (dump_kind & pflags))
+ VERIFY_DUMP_ENABLED_P;
+ if (dump_file
+ && dump_context::get ().apply_dump_filter_p (dump_kind, pflags))
print_hex (value, dump_file);
- if (alt_dump_file && (dump_kind & alt_flags))
+ if (alt_dump_file
+ && dump_context::get ().apply_dump_filter_p (dump_kind, alt_flags))
print_hex (value, alt_dump_file);
}
/* Output the name of NODE on appropriate dump streams. */
void
-dump_symtab_node (dump_flags_t dump_kind, symtab_node *node)
+dump_symtab_node (const dump_metadata_t &metadata, symtab_node *node)
{
- dump_context::get ().dump_symtab_node (dump_kind, node);
+ VERIFY_DUMP_ENABLED_P;
+ dump_context::get ().dump_symtab_node (metadata, node);
}
/* Get the current dump scope-nesting depth.
Increment the scope depth. */
void
-dump_begin_scope (const char *name, const dump_location_t &loc)
+dump_begin_scope (const char *name,
+ const dump_user_location_t &user_location,
+ const dump_impl_location_t &impl_location)
{
- dump_context::get ().begin_scope (name, loc);
+ dump_context::get ().begin_scope (name, user_location, impl_location);
}
/* Pop a nested dump scope. */
gcc::dump_manager::
dump_begin (int phase, dump_flags_t *flag_ptr, int part)
{
- char *name;
- struct dump_file_info *dfi;
- FILE *stream;
-
if (phase == TDI_none || !dump_phase_enabled_p (phase))
return NULL;
- name = get_dump_file_name (phase, part);
+ char *name = get_dump_file_name (phase, part);
if (!name)
return NULL;
- dfi = get_dump_file_info (phase);
+ struct dump_file_info *dfi = get_dump_file_info (phase);
/* We do not support re-opening of dump files with parts. This would require
tracking pstate per part of the dump file. */
- stream = dump_open (name, part != -1 || dfi->pstate < 0);
+ FILE *stream = dump_open (name, part != -1 || dfi->pstate < 0);
if (stream)
dfi->pstate = 1;
free (name);
return true;
}
-/* Parse ARG as a dump switch. Return nonzero if it is, and store the
- relevant details in the dump_files array. */
+/* Helper routine to parse -<dump format>[=filename]
+ and return the corresponding dump flag. If POS_P is non-NULL,
+ assign start of filename into *POS_P. */
-int
-gcc::dump_manager::
-dump_switch_p_1 (const char *arg, struct dump_file_info *dfi, bool doglob)
+dump_flags_t
+parse_dump_option (const char *option_value, const char **pos_p)
{
- const char *option_value;
const char *ptr;
dump_flags_t flags;
- if (doglob && !dfi->glob)
- return 0;
-
- option_value = skip_leading_substring (arg, doglob ? dfi->glob : dfi->swtch);
- if (!option_value)
- return 0;
-
- if (*option_value && *option_value != '-' && *option_value != '=')
- return 0;
-
ptr = option_value;
- flags = TDF_NONE;
+ if (pos_p)
+ *pos_p = NULL;
+
+ /* Retain "user-facing" and "internals" messages, but filter out
+ those from an opt_problem being re-emitted at the top level
+ (MSG_PRIORITY_REEMITTED), so as to avoid duplicate messages
+ messing up scan-tree-dump-times" in DejaGnu tests. */
+ flags = MSG_PRIORITY_USER_FACING | MSG_PRIORITY_INTERNALS;
while (*ptr)
{
const char *end_ptr;
const char *eq_ptr;
unsigned length;
-
while (*ptr == '-')
ptr++;
end_ptr = strchr (ptr, '-');
eq_ptr = strchr (ptr, '=');
if (eq_ptr && !end_ptr)
- end_ptr = eq_ptr;
+ end_ptr = eq_ptr;
if (!end_ptr)
end_ptr = ptr + strlen (ptr);
for (option_ptr = dump_options; option_ptr->name; option_ptr++)
if (strlen (option_ptr->name) == length
&& !memcmp (option_ptr->name, ptr, length))
- {
- flags |= option_ptr->value;
+ {
+ flags |= option_ptr->value;
goto found;
- }
+ }
if (*ptr == '=')
- {
+ {
/* Interpret rest of the argument as a dump filename. This
filename overrides other command line filenames. */
- if (dfi->pfilename)
- free (CONST_CAST (char *, dfi->pfilename));
- dfi->pfilename = xstrdup (ptr + 1);
- break;
- }
+ if (pos_p)
+ *pos_p = ptr + 1;
+ break;
+ }
else
- warning (0, "ignoring unknown option %q.*s in %<-fdump-%s%>",
- length, ptr, dfi->swtch);
- found:;
+ {
+ warning (0, "ignoring unknown option %q.*s",
+ length, ptr);
+ flags = TDF_ERROR;
+ }
+ found:
ptr = end_ptr;
+ }
+
+ return flags;
+}
+
+/* Parse ARG as a dump switch. Return nonzero if it is, and store the
+ relevant details in the dump_files array. */
+
+int
+gcc::dump_manager::
+dump_switch_p_1 (const char *arg, struct dump_file_info *dfi, bool doglob)
+{
+ const char *option_value;
+ dump_flags_t flags = TDF_NONE;
+
+ if (doglob && !dfi->glob)
+ return 0;
+
+ option_value = skip_leading_substring (arg, doglob ? dfi->glob : dfi->swtch);
+ if (!option_value)
+ return 0;
+
+ if (*option_value && *option_value != '-' && *option_value != '=')
+ return 0;
+
+ const char *filename;
+ flags = parse_dump_option (option_value, &filename);
+ if (filename)
+ {
+ if (dfi->pfilename)
+ free (CONST_CAST (char *, dfi->pfilename));
+ dfi->pfilename = xstrdup (filename);
}
dfi->pstate = -1;
return 1;
}
-int
+void
gcc::dump_manager::
dump_switch_p (const char *arg)
{
for (i = 0; i < m_extra_dump_files_in_use; i++)
any |= dump_switch_p_1 (arg, &m_extra_dump_files[i], true);
-
- return any;
+ if (!any)
+ {
+ auto_vec<const char *> candidates;
+ for (size_t i = TDI_none + 1; i != TDI_end; i++)
+ candidates.safe_push (dump_files[i].swtch);
+ for (size_t i = 0; i < m_extra_dump_files_in_use; i++)
+ candidates.safe_push (m_extra_dump_files[i].swtch);
+ const char *hint = find_closest_string (arg, &candidates);
+ if (hint)
+ error ("unrecognized command-line option %<-fdump-%s%>; "
+ "did you mean %<-fdump-%s%>?", arg, hint);
+ else
+ error ("unrecognized command-line option %<-fdump-%s%>", arg);
+ }
}
/* Parse ARG as a -fopt-info switch and store flags, optgroup_flags
ptr = option_value;
*filename = NULL;
- *flags = TDF_NONE;
+
+ /* Default to filtering out "internals" messages, and retaining
+ "user-facing" messages, and those from an opt_problem being
+ re-emitted at the top level. */
+ *flags = MSG_PRIORITY_USER_FACING | MSG_PRIORITY_REEMITTED;
+
*optgroup_flags = OPTGROUP_NONE;
if (!ptr)
end_ptr = strchr (ptr, '-');
eq_ptr = strchr (ptr, '=');
- if (eq_ptr && !end_ptr)
+ if (eq_ptr && (!end_ptr || eq_ptr < end_ptr))
end_ptr = eq_ptr;
-
- if (!end_ptr)
+ else if (!end_ptr)
end_ptr = ptr + strlen (ptr);
length = end_ptr - ptr;
}
file_seen = xstrdup (filename);
- if (!flags)
- flags = MSG_OPTIMIZED_LOCATIONS;
+ if (!(flags & MSG_ALL_KINDS))
+ flags |= MSG_OPTIMIZED_LOCATIONS;
if (!optgroup_flags)
optgroup_flags = OPTGROUP_ALL;
void
dump_basic_block (dump_flags_t dump_kind, basic_block bb, int indent)
{
- if (dump_file && (dump_kind & pflags))
+ if (dump_file
+ && dump_context::get ().apply_dump_filter_p (dump_kind, pflags))
dump_bb (dump_file, bb, indent, TDF_DETAILS);
- if (alt_dump_file && (dump_kind & alt_flags))
+ if (alt_dump_file
+ && dump_context::get ().apply_dump_filter_p (dump_kind, alt_flags))
dump_bb (alt_dump_file, bb, indent, TDF_DETAILS);
}
return num_enabled > 0;
}
+/* debug_dump_context's ctor. Temporarily override the dump_context
+ (to forcibly enable output to stderr). */
+
+debug_dump_context::debug_dump_context ()
+: m_context (),
+ m_saved (&dump_context::get ()),
+ m_saved_flags (dump_flags),
+ m_saved_pflags (pflags),
+ m_saved_file (dump_file)
+{
+ set_dump_file (stderr);
+ dump_context::s_current = &m_context;
+ pflags = dump_flags = MSG_ALL_KINDS | MSG_ALL_PRIORITIES;
+ dump_context::get ().refresh_dumps_are_enabled ();
+}
+
+/* debug_dump_context's dtor. Restore the saved dump_context. */
+
+debug_dump_context::~debug_dump_context ()
+{
+ set_dump_file (m_saved_file);
+ dump_context::s_current = m_saved;
+ dump_flags = m_saved_flags;
+ pflags = m_saved_pflags;
+ dump_context::get ().refresh_dumps_are_enabled ();
+}
+
+
#if CHECKING_P
+namespace selftest {
+
/* temp_dump_context's ctor. Temporarily override the dump_context
(to forcibly enable optinfo-generation). */
temp_dump_context::temp_dump_context (bool forcibly_enable_optinfo,
+ bool forcibly_enable_dumping,
dump_flags_t test_pp_flags)
-
: m_context (),
- m_saved (&dump_context ().get ())
+ m_saved (&dump_context::get ())
{
dump_context::s_current = &m_context;
- m_context.m_forcibly_enable_optinfo = forcibly_enable_optinfo;
- m_context.m_test_pp = &m_pp;
- m_context.m_test_pp_flags = test_pp_flags;
+ if (forcibly_enable_optinfo)
+ m_context.set_json_writer (new optrecord_json_writer ());
+ /* Conditionally enable the test dump, so that we can verify both the
+ dump_enabled_p and the !dump_enabled_p cases in selftests. */
+ if (forcibly_enable_dumping)
+ {
+ m_context.m_test_pp = &m_pp;
+ m_context.m_test_pp_flags = test_pp_flags;
+ }
dump_context::get ().refresh_dumps_are_enabled ();
}
temp_dump_context::~temp_dump_context ()
{
+ m_context.set_json_writer (NULL);
+
dump_context::s_current = m_saved;
dump_context::get ().refresh_dumps_are_enabled ();
return pp_formatted_text (&m_pp);
}
-namespace selftest {
+/* Verify that IMPL_LOC is within EXPECTED_FILE at EXPECTED_LINE,
+ from EXPECTED_FUNCTION, using LOC for the location of any failure,
+ provided that the build compiler is sufficiently recent. */
+
+static void
+assert_impl_location_eq (const location &loc ATTRIBUTE_UNUSED,
+ const dump_impl_location_t &impl_loc ATTRIBUTE_UNUSED,
+ const char *expected_file ATTRIBUTE_UNUSED,
+ int expected_line ATTRIBUTE_UNUSED,
+ const char *expected_function ATTRIBUTE_UNUSED)
+{
+#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8)
+ ASSERT_STR_CONTAINS_AT (loc, impl_loc.m_file, expected_file);
+ ASSERT_EQ_AT (loc, impl_loc.m_line, expected_line);
+ ASSERT_STR_CONTAINS_AT (loc, impl_loc.m_function, expected_function);
+#endif
+}
+
+/* Verify that IMPL_LOC is within EXPECTED_FILE at EXPECTED_LINE,
+ from EXPECTED_FUNCTION, provided that the build compiler is
+ sufficiently recent. */
+
+#define ASSERT_IMPL_LOCATION_EQ(IMPL_LOC, EXPECTED_FILE, EXPECTED_LINE, \
+ EXPECTED_FUNCTION) \
+ SELFTEST_BEGIN_STMT \
+ assert_impl_location_eq (SELFTEST_LOCATION, IMPL_LOC, \
+ EXPECTED_FILE, EXPECTED_LINE, \
+ EXPECTED_FUNCTION); \
+ SELFTEST_END_STMT
/* Verify that the dump_location_t constructors capture the source location
at which they were called (provided that the build compiler is sufficiently
static void
test_impl_location ()
{
-#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8)
/* Default ctor. */
{
dump_location_t loc;
const int expected_line = __LINE__ - 1;
- ASSERT_STR_CONTAINS (loc.get_impl_location ().m_file, "dumpfile.c");
- ASSERT_EQ (loc.get_impl_location ().m_line, expected_line);
+ ASSERT_IMPL_LOCATION_EQ (loc.get_impl_location (),
+ "dumpfile.c", expected_line, "test_impl_location");
}
/* Constructing from a gimple. */
{
dump_location_t loc ((gimple *)NULL);
const int expected_line = __LINE__ - 1;
- ASSERT_STR_CONTAINS (loc.get_impl_location ().m_file, "dumpfile.c");
- ASSERT_EQ (loc.get_impl_location ().m_line, expected_line);
+ ASSERT_IMPL_LOCATION_EQ (loc.get_impl_location (),
+ "dumpfile.c", expected_line, "test_impl_location");
}
/* Constructing from an rtx_insn. */
{
dump_location_t loc ((rtx_insn *)NULL);
const int expected_line = __LINE__ - 1;
- ASSERT_STR_CONTAINS (loc.get_impl_location ().m_file, "dumpfile.c");
- ASSERT_EQ (loc.get_impl_location ().m_line, expected_line);
+ ASSERT_IMPL_LOCATION_EQ (loc.get_impl_location (),
+ "dumpfile.c", expected_line, "test_impl_location");
}
-#endif
}
/* Verify that the text dumped so far in CONTEXT equals
EXPECTED_TEXT, using LOC for the location of any failure.
As a side-effect, the internal buffer is 0-terminated. */
-static void
+void
verify_dumped_text (const location &loc,
temp_dump_context *context,
const char *expected_text)
expected_text);
}
-/* Verify that the text dumped so far in CONTEXT equals
- EXPECTED_TEXT.
- As a side-effect, the internal buffer is 0-terminated. */
-
-#define ASSERT_DUMPED_TEXT_EQ(CONTEXT, EXPECTED_TEXT) \
- SELFTEST_BEGIN_STMT \
- verify_dumped_text (SELFTEST_LOCATION, &(CONTEXT), (EXPECTED_TEXT)); \
- SELFTEST_END_STMT
-
/* Verify that ITEM has the expected values. */
-static void
+void
verify_item (const location &loc,
const optinfo_item *item,
enum optinfo_item_kind expected_kind,
ASSERT_STREQ_AT (loc, item->get_text (), expected_text);
}
-/* Verify that ITEM is a text item, with EXPECTED_TEXT. */
-
-#define ASSERT_IS_TEXT(ITEM, EXPECTED_TEXT) \
- SELFTEST_BEGIN_STMT \
- verify_item (SELFTEST_LOCATION, (ITEM), OPTINFO_ITEM_KIND_TEXT, \
- UNKNOWN_LOCATION, (EXPECTED_TEXT)); \
- SELFTEST_END_STMT
-
-/* Verify that ITEM is a tree item, with the expected values. */
-
-#define ASSERT_IS_TREE(ITEM, EXPECTED_LOCATION, EXPECTED_TEXT) \
- SELFTEST_BEGIN_STMT \
- verify_item (SELFTEST_LOCATION, (ITEM), OPTINFO_ITEM_KIND_TREE, \
- (EXPECTED_LOCATION), (EXPECTED_TEXT)); \
- SELFTEST_END_STMT
-
-/* Verify that ITEM is a gimple item, with the expected values. */
-
-#define ASSERT_IS_GIMPLE(ITEM, EXPECTED_LOCATION, EXPECTED_TEXT) \
- SELFTEST_BEGIN_STMT \
- verify_item (SELFTEST_LOCATION, (ITEM), OPTINFO_ITEM_KIND_GIMPLE, \
- (EXPECTED_LOCATION), (EXPECTED_TEXT)); \
- SELFTEST_END_STMT
-
/* Verify that calls to the dump_* API are captured and consolidated into
optimization records. */
linemap_add (line_table, LC_ENTER, false, "test.txt", 0);
linemap_line_start (line_table, 5, 100);
linemap_add (line_table, LC_LEAVE, false, NULL, 0);
- location_t where = linemap_position_for_column (line_table, 10);
- if (where > LINE_MAP_MAX_LOCATION_WITH_COLS)
+ location_t decl_loc = linemap_position_for_column (line_table, 8);
+ location_t stmt_loc = linemap_position_for_column (line_table, 10);
+ if (stmt_loc > LINE_MAP_MAX_LOCATION_WITH_COLS)
return;
- dump_location_t loc = dump_location_t::from_location_t (where);
+ dump_user_location_t loc = dump_user_location_t::from_location_t (stmt_loc);
gimple *stmt = gimple_build_return (NULL);
- gimple_set_location (stmt, where);
+ gimple_set_location (stmt, stmt_loc);
- tree test_decl = build_decl (UNKNOWN_LOCATION, VAR_DECL,
+ tree test_decl = build_decl (decl_loc, FUNCTION_DECL,
get_identifier ("test_decl"),
- integer_type_node);
+ build_function_type_list (void_type_node,
+ NULL_TREE));
+
+ symbol_table_test tmp_symtab;
+
+ cgraph_node *node = cgraph_node::get_create (test_decl);
+ gcc_assert (node);
+
/* Run all tests twice, with and then without optinfo enabled, to ensure
that immediate destinations vs optinfo-based destinations both
work, independently of each other, with no leaks. */
/* Test of dump_printf. */
{
- temp_dump_context tmp (with_optinfo, MSG_ALL);
+ temp_dump_context tmp (with_optinfo, true,
+ MSG_ALL_KINDS | MSG_PRIORITY_USER_FACING);
dump_printf (MSG_NOTE, "int: %i str: %s", 42, "foo");
+ const int expected_impl_line = __LINE__ - 1;
ASSERT_DUMPED_TEXT_EQ (tmp, "int: 42 str: foo");
if (with_optinfo)
ASSERT_EQ (info->get_kind (), OPTINFO_KIND_NOTE);
ASSERT_EQ (info->num_items (), 1);
ASSERT_IS_TEXT (info->get_item (0), "int: 42 str: foo");
+ ASSERT_IMPL_LOCATION_EQ (info->get_impl_location (),
+ "dumpfile.c", expected_impl_line,
+ "test_capture_of_dump_calls");
}
}
/* Test of dump_printf with %T. */
{
- temp_dump_context tmp (with_optinfo, MSG_ALL);
+ temp_dump_context tmp (with_optinfo, true,
+ MSG_ALL_KINDS | MSG_PRIORITY_USER_FACING);
dump_printf (MSG_NOTE, "tree: %T", integer_zero_node);
+ const int expected_impl_line = __LINE__ - 1;
ASSERT_DUMPED_TEXT_EQ (tmp, "tree: 0");
if (with_optinfo)
ASSERT_EQ (info->num_items (), 2);
ASSERT_IS_TEXT (info->get_item (0), "tree: ");
ASSERT_IS_TREE (info->get_item (1), UNKNOWN_LOCATION, "0");
+ ASSERT_IMPL_LOCATION_EQ (info->get_impl_location (),
+ "dumpfile.c", expected_impl_line,
+ "test_capture_of_dump_calls");
}
}
/* Test of dump_printf with %E. */
{
- temp_dump_context tmp (with_optinfo, MSG_ALL);
+ temp_dump_context tmp (with_optinfo, true,
+ MSG_ALL_KINDS | MSG_PRIORITY_USER_FACING);
dump_printf (MSG_NOTE, "gimple: %E", stmt);
+ const int expected_impl_line = __LINE__ - 1;
ASSERT_DUMPED_TEXT_EQ (tmp, "gimple: return;");
if (with_optinfo)
ASSERT_EQ (info->get_kind (), OPTINFO_KIND_NOTE);
ASSERT_EQ (info->num_items (), 2);
ASSERT_IS_TEXT (info->get_item (0), "gimple: ");
- ASSERT_IS_GIMPLE (info->get_item (1), where, "return;");
+ ASSERT_IS_GIMPLE (info->get_item (1), stmt_loc, "return;");
+ ASSERT_IMPL_LOCATION_EQ (info->get_impl_location (),
+ "dumpfile.c", expected_impl_line,
+ "test_capture_of_dump_calls");
}
}
/* Test of dump_printf with %G. */
{
- temp_dump_context tmp (with_optinfo, MSG_ALL);
+ temp_dump_context tmp (with_optinfo, true,
+ MSG_ALL_KINDS | MSG_PRIORITY_USER_FACING);
dump_printf (MSG_NOTE, "gimple: %G", stmt);
+ const int expected_impl_line = __LINE__ - 1;
ASSERT_DUMPED_TEXT_EQ (tmp, "gimple: return;\n");
if (with_optinfo)
ASSERT_EQ (info->get_kind (), OPTINFO_KIND_NOTE);
ASSERT_EQ (info->num_items (), 2);
ASSERT_IS_TEXT (info->get_item (0), "gimple: ");
- ASSERT_IS_GIMPLE (info->get_item (1), where, "return;\n");
+ ASSERT_IS_GIMPLE (info->get_item (1), stmt_loc, "return;\n");
+ ASSERT_IMPL_LOCATION_EQ (info->get_impl_location (),
+ "dumpfile.c", expected_impl_line,
+ "test_capture_of_dump_calls");
+ }
+ }
+
+ /* Test of dump_printf with %C. */
+ {
+ temp_dump_context tmp (with_optinfo, true,
+ MSG_ALL_KINDS | MSG_PRIORITY_USER_FACING);
+ dump_printf (MSG_NOTE, "node: %C", node);
+ const int expected_impl_line = __LINE__ - 1;
+
+ ASSERT_DUMPED_TEXT_EQ (tmp, "node: test_decl/0");
+ if (with_optinfo)
+ {
+ optinfo *info = tmp.get_pending_optinfo ();
+ ASSERT_TRUE (info != NULL);
+ ASSERT_EQ (info->get_kind (), OPTINFO_KIND_NOTE);
+ ASSERT_EQ (info->num_items (), 2);
+ ASSERT_IS_TEXT (info->get_item (0), "node: ");
+ ASSERT_IS_SYMTAB_NODE (info->get_item (1), decl_loc, "test_decl/0");
+ ASSERT_IMPL_LOCATION_EQ (info->get_impl_location (),
+ "dumpfile.c", expected_impl_line,
+ "test_capture_of_dump_calls");
}
}
- multiple dump-specific format codes: some consecutive, others
separated by text, trailing text after the final one. */
{
- temp_dump_context tmp (with_optinfo, MSG_ALL);
+ temp_dump_context tmp (with_optinfo, true,
+ MSG_ALL_KINDS | MSG_PRIORITY_USER_FACING);
dump_printf_loc (MSG_NOTE, loc, "before %T and %T"
" %i consecutive %E%E after\n",
integer_zero_node, test_decl, 42, stmt, stmt);
ASSERT_IS_TEXT (info->get_item (2), " and ");
ASSERT_IS_TREE (info->get_item (3), UNKNOWN_LOCATION, "test_decl");
ASSERT_IS_TEXT (info->get_item (4), " 42 consecutive ");
- ASSERT_IS_GIMPLE (info->get_item (5), where, "return;");
- ASSERT_IS_GIMPLE (info->get_item (6), where, "return;");
+ ASSERT_IS_GIMPLE (info->get_item (5), stmt_loc, "return;");
+ ASSERT_IS_GIMPLE (info->get_item (6), stmt_loc, "return;");
ASSERT_IS_TEXT (info->get_item (7), " after\n");
+ /* We don't ASSERT_IMPL_LOCATION_EQ here, to avoid having to
+ enforce at which exact line the multiline dump_printf_loc
+ occurred. */
}
}
/* Tree, via dump_generic_expr. */
{
- temp_dump_context tmp (with_optinfo, MSG_ALL);
+ temp_dump_context tmp (with_optinfo, true,
+ MSG_ALL_KINDS | MSG_PRIORITY_USER_FACING);
dump_printf_loc (MSG_NOTE, loc, "test of tree: ");
+ const int expected_impl_line = __LINE__ - 1;
dump_generic_expr (MSG_NOTE, TDF_SLIM, integer_zero_node);
ASSERT_DUMPED_TEXT_EQ (tmp, "test.txt:5:10: note: test of tree: 0");
{
optinfo *info = tmp.get_pending_optinfo ();
ASSERT_TRUE (info != NULL);
- ASSERT_EQ (info->get_location_t (), where);
+ ASSERT_EQ (info->get_location_t (), stmt_loc);
ASSERT_EQ (info->get_kind (), OPTINFO_KIND_NOTE);
ASSERT_EQ (info->num_items (), 2);
ASSERT_IS_TEXT (info->get_item (0), "test of tree: ");
ASSERT_IS_TREE (info->get_item (1), UNKNOWN_LOCATION, "0");
+ ASSERT_IMPL_LOCATION_EQ (info->get_impl_location (),
+ "dumpfile.c", expected_impl_line,
+ "test_capture_of_dump_calls");
}
}
/* Tree, via dump_generic_expr_loc. */
{
- temp_dump_context tmp (with_optinfo, MSG_ALL);
+ temp_dump_context tmp (with_optinfo, true,
+ MSG_ALL_KINDS | MSG_PRIORITY_USER_FACING);
dump_generic_expr_loc (MSG_NOTE, loc, TDF_SLIM, integer_one_node);
+ const int expected_impl_line = __LINE__ - 1;
ASSERT_DUMPED_TEXT_EQ (tmp, "test.txt:5:10: note: 1");
if (with_optinfo)
{
optinfo *info = tmp.get_pending_optinfo ();
ASSERT_TRUE (info != NULL);
- ASSERT_EQ (info->get_location_t (), where);
+ ASSERT_EQ (info->get_location_t (), stmt_loc);
ASSERT_EQ (info->get_kind (), OPTINFO_KIND_NOTE);
ASSERT_EQ (info->num_items (), 1);
ASSERT_IS_TREE (info->get_item (0), UNKNOWN_LOCATION, "1");
+ ASSERT_IMPL_LOCATION_EQ (info->get_impl_location (),
+ "dumpfile.c", expected_impl_line,
+ "test_capture_of_dump_calls");
}
}
{
/* dump_gimple_stmt_loc. */
{
- temp_dump_context tmp (with_optinfo, MSG_ALL);
+ temp_dump_context tmp (with_optinfo, true,
+ MSG_ALL_KINDS | MSG_PRIORITY_USER_FACING);
dump_gimple_stmt_loc (MSG_NOTE, loc, TDF_SLIM, stmt, 2);
+ const int expected_impl_line = __LINE__ - 1;
ASSERT_DUMPED_TEXT_EQ (tmp, "test.txt:5:10: note: return;\n");
if (with_optinfo)
optinfo *info = tmp.get_pending_optinfo ();
ASSERT_TRUE (info != NULL);
ASSERT_EQ (info->num_items (), 1);
- ASSERT_IS_GIMPLE (info->get_item (0), where, "return;\n");
+ ASSERT_IS_GIMPLE (info->get_item (0), stmt_loc, "return;\n");
+ ASSERT_IMPL_LOCATION_EQ (info->get_impl_location (),
+ "dumpfile.c", expected_impl_line,
+ "test_capture_of_dump_calls");
}
}
/* dump_gimple_stmt. */
{
- temp_dump_context tmp (with_optinfo, MSG_ALL);
+ temp_dump_context tmp (with_optinfo, true,
+ MSG_ALL_KINDS | MSG_PRIORITY_USER_FACING);
dump_gimple_stmt (MSG_NOTE, TDF_SLIM, stmt, 2);
+ const int expected_impl_line = __LINE__ - 1;
ASSERT_DUMPED_TEXT_EQ (tmp, "return;\n");
if (with_optinfo)
optinfo *info = tmp.get_pending_optinfo ();
ASSERT_TRUE (info != NULL);
ASSERT_EQ (info->num_items (), 1);
- ASSERT_IS_GIMPLE (info->get_item (0), where, "return;\n");
+ ASSERT_IS_GIMPLE (info->get_item (0), stmt_loc, "return;\n");
+ ASSERT_IMPL_LOCATION_EQ (info->get_impl_location (),
+ "dumpfile.c", expected_impl_line,
+ "test_capture_of_dump_calls");
}
}
/* dump_gimple_expr_loc. */
{
- temp_dump_context tmp (with_optinfo, MSG_ALL);
+ temp_dump_context tmp (with_optinfo, true,
+ MSG_ALL_KINDS | MSG_PRIORITY_USER_FACING);
dump_gimple_expr_loc (MSG_NOTE, loc, TDF_SLIM, stmt, 2);
+ const int expected_impl_line = __LINE__ - 1;
ASSERT_DUMPED_TEXT_EQ (tmp, "test.txt:5:10: note: return;");
if (with_optinfo)
optinfo *info = tmp.get_pending_optinfo ();
ASSERT_TRUE (info != NULL);
ASSERT_EQ (info->num_items (), 1);
- ASSERT_IS_GIMPLE (info->get_item (0), where, "return;");
+ ASSERT_IS_GIMPLE (info->get_item (0), stmt_loc, "return;");
+ ASSERT_IMPL_LOCATION_EQ (info->get_impl_location (),
+ "dumpfile.c", expected_impl_line,
+ "test_capture_of_dump_calls");
}
}
/* dump_gimple_expr. */
{
- temp_dump_context tmp (with_optinfo, MSG_ALL);
+ temp_dump_context tmp (with_optinfo, true,
+ MSG_ALL_KINDS | MSG_PRIORITY_USER_FACING);
dump_gimple_expr (MSG_NOTE, TDF_SLIM, stmt, 2);
+ const int expected_impl_line = __LINE__ - 1;
ASSERT_DUMPED_TEXT_EQ (tmp, "return;");
if (with_optinfo)
optinfo *info = tmp.get_pending_optinfo ();
ASSERT_TRUE (info != NULL);
ASSERT_EQ (info->num_items (), 1);
- ASSERT_IS_GIMPLE (info->get_item (0), where, "return;");
+ ASSERT_IS_GIMPLE (info->get_item (0), stmt_loc, "return;");
+ ASSERT_IMPL_LOCATION_EQ (info->get_impl_location (),
+ "dumpfile.c", expected_impl_line,
+ "test_capture_of_dump_calls");
}
}
}
+ /* symtab_node. */
+ {
+ temp_dump_context tmp (with_optinfo, true,
+ MSG_ALL_KINDS | MSG_PRIORITY_USER_FACING);
+ dump_symtab_node (MSG_NOTE, node);
+ const int expected_impl_line = __LINE__ - 1;
+
+ ASSERT_DUMPED_TEXT_EQ (tmp, "test_decl/0");
+ if (with_optinfo)
+ {
+ optinfo *info = tmp.get_pending_optinfo ();
+ ASSERT_TRUE (info != NULL);
+ ASSERT_EQ (info->get_kind (), OPTINFO_KIND_NOTE);
+ ASSERT_EQ (info->num_items (), 1);
+ ASSERT_IS_SYMTAB_NODE (info->get_item (0), decl_loc, "test_decl/0");
+ ASSERT_IMPL_LOCATION_EQ (info->get_impl_location (),
+ "dumpfile.c", expected_impl_line,
+ "test_capture_of_dump_calls");
+ }
+ }
+
/* poly_int. */
{
- temp_dump_context tmp (with_optinfo, MSG_ALL);
+ temp_dump_context tmp (with_optinfo, true,
+ MSG_ALL_KINDS | MSG_PRIORITY_USER_FACING);
dump_dec (MSG_NOTE, poly_int64 (42));
+ const int expected_impl_line = __LINE__ - 1;
ASSERT_DUMPED_TEXT_EQ (tmp, "42");
if (with_optinfo)
ASSERT_TRUE (info != NULL);
ASSERT_EQ (info->num_items (), 1);
ASSERT_IS_TEXT (info->get_item (0), "42");
+ ASSERT_IMPL_LOCATION_EQ (info->get_impl_location (),
+ "dumpfile.c", expected_impl_line,
+ "test_capture_of_dump_calls");
}
}
- /* scopes. */
- {
- temp_dump_context tmp (with_optinfo, MSG_ALL);
- dump_printf_loc (MSG_NOTE, stmt, "msg 1\n");
+ /* Scopes. Test with all 4 combinations of
+ filtering by MSG_PRIORITY_USER_FACING
+ and/or filtering by MSG_PRIORITY_INTERNALS. */
+ for (int j = 0; j < 3; j++)
{
- AUTO_DUMP_SCOPE ("outer scope", stmt);
- dump_printf_loc (MSG_NOTE, stmt, "msg 2\n");
+ dump_flags_t dump_filter = MSG_ALL_KINDS;
+ if (j % 2)
+ dump_filter |= MSG_PRIORITY_USER_FACING;
+ if (j / 2)
+ dump_filter |= MSG_PRIORITY_INTERNALS;
+
+ temp_dump_context tmp (with_optinfo, true, dump_filter);
+ /* Emit various messages, mostly with implicit priority. */
+ dump_printf_loc (MSG_NOTE, stmt, "msg 1\n");
+ dump_printf_loc (MSG_NOTE | MSG_PRIORITY_INTERNALS, stmt,
+ "explicitly internal msg\n");
{
- AUTO_DUMP_SCOPE ("middle scope", stmt);
- dump_printf_loc (MSG_NOTE, stmt, "msg 3\n");
+ AUTO_DUMP_SCOPE ("outer scope", stmt);
+ dump_printf_loc (MSG_NOTE, stmt, "msg 2\n");
{
- AUTO_DUMP_SCOPE ("inner scope", stmt);
- dump_printf_loc (MSG_NOTE, stmt, "msg 4\n");
+ AUTO_DUMP_SCOPE ("middle scope", stmt);
+ dump_printf_loc (MSG_NOTE, stmt, "msg 3\n");
+ {
+ AUTO_DUMP_SCOPE ("inner scope", stmt);
+ dump_printf_loc (MSG_NOTE, stmt, "msg 4\n");
+ dump_printf_loc (MSG_NOTE | MSG_PRIORITY_USER_FACING, stmt,
+ "explicitly user-facing msg\n");
+ }
+ dump_printf_loc (MSG_NOTE, stmt, "msg 5\n");
}
- dump_printf_loc (MSG_NOTE, stmt, "msg 5\n");
+ dump_printf_loc (MSG_NOTE, stmt, "msg 6\n");
}
- dump_printf_loc (MSG_NOTE, stmt, "msg 6\n");
- }
- dump_printf_loc (MSG_NOTE, stmt, "msg 7\n");
+ dump_printf_loc (MSG_NOTE, stmt, "msg 7\n");
+ const int expected_impl_line = __LINE__ - 1;
- ASSERT_DUMPED_TEXT_EQ (tmp,
- "test.txt:5:10: note: msg 1\n"
- "test.txt:5:10: note: === outer scope ===\n"
- "test.txt:5:10: note: msg 2\n"
- "test.txt:5:10: note: === middle scope ===\n"
- "test.txt:5:10: note: msg 3\n"
- "test.txt:5:10: note: === inner scope ===\n"
- "test.txt:5:10: note: msg 4\n"
- "test.txt:5:10: note: msg 5\n"
- "test.txt:5:10: note: msg 6\n"
- "test.txt:5:10: note: msg 7\n");
- if (with_optinfo)
- {
- optinfo *info = tmp.get_pending_optinfo ();
- ASSERT_TRUE (info != NULL);
- ASSERT_EQ (info->num_items (), 1);
- ASSERT_IS_TEXT (info->get_item (0), "msg 7\n");
- }
- }
+ switch (dump_filter & MSG_ALL_PRIORITIES)
+ {
+ default:
+ gcc_unreachable ();
+ case 0:
+ ASSERT_DUMPED_TEXT_EQ (tmp, "");
+ break;
+ case MSG_PRIORITY_USER_FACING:
+ ASSERT_DUMPED_TEXT_EQ
+ (tmp,
+ "test.txt:5:10: note: msg 1\n"
+ "test.txt:5:10: note: explicitly user-facing msg\n"
+ "test.txt:5:10: note: msg 7\n");
+ break;
+ case MSG_PRIORITY_INTERNALS:
+ ASSERT_DUMPED_TEXT_EQ
+ (tmp,
+ "test.txt:5:10: note: explicitly internal msg\n"
+ "test.txt:5:10: note: === outer scope ===\n"
+ "test.txt:5:10: note: msg 2\n"
+ "test.txt:5:10: note: === middle scope ===\n"
+ "test.txt:5:10: note: msg 3\n"
+ "test.txt:5:10: note: === inner scope ===\n"
+ "test.txt:5:10: note: msg 4\n"
+ "test.txt:5:10: note: msg 5\n"
+ "test.txt:5:10: note: msg 6\n");
+ break;
+ case MSG_ALL_PRIORITIES:
+ ASSERT_DUMPED_TEXT_EQ
+ (tmp,
+ "test.txt:5:10: note: msg 1\n"
+ "test.txt:5:10: note: explicitly internal msg\n"
+ "test.txt:5:10: note: === outer scope ===\n"
+ "test.txt:5:10: note: msg 2\n"
+ "test.txt:5:10: note: === middle scope ===\n"
+ "test.txt:5:10: note: msg 3\n"
+ "test.txt:5:10: note: === inner scope ===\n"
+ "test.txt:5:10: note: msg 4\n"
+ "test.txt:5:10: note: explicitly user-facing msg\n"
+ "test.txt:5:10: note: msg 5\n"
+ "test.txt:5:10: note: msg 6\n"
+ "test.txt:5:10: note: msg 7\n");
+ break;
+ }
+ if (with_optinfo)
+ {
+ optinfo *info = tmp.get_pending_optinfo ();
+ ASSERT_TRUE (info != NULL);
+ ASSERT_EQ (info->num_items (), 1);
+ ASSERT_IS_TEXT (info->get_item (0), "msg 7\n");
+ ASSERT_IMPL_LOCATION_EQ (info->get_impl_location (),
+ "dumpfile.c", expected_impl_line,
+ "test_capture_of_dump_calls");
+ }
+ }
}
/* Verify that MSG_* affects optinfo->get_kind (); we tested MSG_NOTE
{
/* MSG_OPTIMIZED_LOCATIONS. */
{
- temp_dump_context tmp (true, MSG_ALL);
+ temp_dump_context tmp (true, true, MSG_ALL_KINDS);
dump_printf_loc (MSG_OPTIMIZED_LOCATIONS, loc, "test");
ASSERT_EQ (tmp.get_pending_optinfo ()->get_kind (),
OPTINFO_KIND_SUCCESS);
/* MSG_MISSED_OPTIMIZATION. */
{
- temp_dump_context tmp (true, MSG_ALL);
+ temp_dump_context tmp (true, true, MSG_ALL_KINDS);
dump_printf_loc (MSG_MISSED_OPTIMIZATION, loc, "test");
ASSERT_EQ (tmp.get_pending_optinfo ()->get_kind (),
OPTINFO_KIND_FAILURE);
/* Verify that MSG_* affect AUTO_DUMP_SCOPE and the dump calls. */
{
- temp_dump_context tmp (false, MSG_OPTIMIZED_LOCATIONS);
+ temp_dump_context tmp (false, true,
+ MSG_OPTIMIZED_LOCATIONS | MSG_ALL_PRIORITIES);
dump_printf_loc (MSG_NOTE, stmt, "msg 1\n");
{
AUTO_DUMP_SCOPE ("outer scope", stmt);
}
}
+static void
+test_pr87025 ()
+{
+ dump_user_location_t loc
+ = dump_user_location_t::from_location_t (UNKNOWN_LOCATION);
+
+ temp_dump_context tmp (true, true,
+ MSG_ALL_KINDS | MSG_PRIORITY_USER_FACING);
+ {
+ AUTO_DUMP_SCOPE ("outer scope", loc);
+ dump_printf (MSG_NOTE, "msg1\n");
+ }
+}
+
/* Run all of the selftests within this file. */
void
{
test_impl_location ();
for_each_line_table_case (test_capture_of_dump_calls);
+ test_pr87025 ();
}
} // namespace selftest