gcc/optinfo.cc

   1 /* Optimization information.
   2    Copyright (C) 2018 Free Software Foundation, Inc.
   3    Contributed by David Malcolm <dmalcolm@redhat.com>.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 3, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21 #include "config.h"
  22 #include "system.h"
  23 #include "coretypes.h"
  24
  25 #include "backend.h"
  26 #include "tree.h"
  27 #include "gimple.h"
  28
  29 #include "optinfo.h"
  30 #include "optinfo-emit-json.h"
  31 #include "dump-context.h"
  32 #include "pretty-print.h"
  33 #include "gimple-pretty-print.h"
  34 #include "cgraph.h"
  35 #include "selftest.h"
  36
  37 /* optinfo_item's ctor.  */
  38
  39 optinfo_item::optinfo_item (enum optinfo_item_kind kind, location_t location,
  40                             char *text, bool owned)
  41 : m_kind (kind), m_location (location), m_text (text), m_owned (owned)
  42 {
  43 }
  44
  45 /* optinfo_item's dtor.  */
  46
  47 optinfo_item::~optinfo_item ()
  48 {
  49   if (m_owned)
  50     free (m_text);
  51 }
  52
  53 /* Get a string from KIND.  */
  54
  55 const char *
  56 optinfo_kind_to_string (enum optinfo_kind kind)
  57 {
  58   switch (kind)
  59     {
  60     default:
  61       gcc_unreachable ();
  62     case OPTINFO_KIND_SUCCESS:
  63       return "success";
  64     case OPTINFO_KIND_FAILURE:
  65       return "failure";
  66     case OPTINFO_KIND_NOTE:
  67       return "note";
  68     case OPTINFO_KIND_SCOPE:
  69       return "scope";
  70     }
  71 }
  72
  73 /* optinfo's dtor.  */
  74
  75 optinfo::~optinfo ()
  76 {
  77   /* Cleanup.  */
  78   unsigned i;
  79   optinfo_item *item;
  80   FOR_EACH_VEC_ELT (m_items, i, item)
  81     delete item;
  82 }
  83
  84 /* Emit the optinfo to all of the active destinations.  */
  85
  86 void
  87 optinfo::emit ()
  88 {
  89   /* -fsave-optimization-record.  */
  90   optimization_records_maybe_record_optinfo (this);
  91 }
  92
  93 /* Update the optinfo's kind based on DUMP_KIND.  */
  94
  95 void
  96 optinfo::handle_dump_file_kind (dump_flags_t dump_kind)
  97 {
  98   if (dump_kind & MSG_OPTIMIZED_LOCATIONS)
  99     m_kind = OPTINFO_KIND_SUCCESS;
 100   else if (dump_kind & MSG_MISSED_OPTIMIZATION)
 101     m_kind = OPTINFO_KIND_FAILURE;
 102   else if (dump_kind & MSG_NOTE)
 103     m_kind = OPTINFO_KIND_NOTE;
 104 }
 105
 106 /* Append a string literal to this optinfo.  */
 107
 108 void
 109 optinfo::add_string (const char *str)
 110 {
 111   optinfo_item *item
 112     = new optinfo_item (OPTINFO_ITEM_KIND_TEXT, UNKNOWN_LOCATION,
 113                         const_cast <char *> (str), false);
 114   m_items.safe_push (item);
 115 }
 116
 117 /* Append printf-formatted text to this optinfo.  */
 118
 119 void
 120 optinfo::add_printf (const char *format, ...)
 121 {
 122   va_list ap;
 123   va_start (ap, format);
 124   add_printf_va (format, ap);
 125   va_end (ap);
 126 }
 127
 128 /* Append printf-formatted text to this optinfo.  */
 129
 130 void
 131 optinfo::add_printf_va (const char *format, va_list ap)
 132 {
 133   char *formatted_text = xvasprintf (format, ap);
 134   optinfo_item *item
 135     = new optinfo_item (OPTINFO_ITEM_KIND_TEXT, UNKNOWN_LOCATION,
 136                         formatted_text, true);
 137   m_items.safe_push (item);
 138 }
 139
 140 /* Append a gimple statement to this optinfo, equivalent to
 141    print_gimple_stmt.  */
 142
 143 void
 144 optinfo::add_gimple_stmt (gimple *stmt, int spc, dump_flags_t dump_flags)
 145 {
 146   pretty_printer pp;
 147   pp_needs_newline (&pp) = true;
 148   pp_gimple_stmt_1 (&pp, stmt, spc, dump_flags);
 149   pp_newline (&pp);
 150
 151   optinfo_item *item
 152     = new optinfo_item (OPTINFO_ITEM_KIND_GIMPLE, gimple_location (stmt),
 153                         xstrdup (pp_formatted_text (&pp)), true);
 154   m_items.safe_push (item);
 155 }
 156
 157 /* Append a gimple statement to this optinfo, equivalent to
 158    print_gimple_expr.  */
 159
 160 void
 161 optinfo::add_gimple_expr (gimple *stmt, int spc, dump_flags_t dump_flags)
 162 {
 163   dump_flags |= TDF_RHS_ONLY;
 164   pretty_printer pp;
 165   pp_needs_newline (&pp) = true;
 166   pp_gimple_stmt_1 (&pp, stmt, spc, dump_flags);
 167
 168   optinfo_item *item
 169     = new optinfo_item (OPTINFO_ITEM_KIND_GIMPLE, gimple_location (stmt),
 170                         xstrdup (pp_formatted_text (&pp)), true);
 171   m_items.safe_push (item);
 172 }
 173
 174 /* Append a tree node to this optinfo, equivalent to print_generic_expr.  */
 175
 176 void
 177 optinfo::add_tree (tree node, dump_flags_t dump_flags)
 178 {
 179   pretty_printer pp;
 180   pp_needs_newline (&pp) = true;
 181   pp_translate_identifiers (&pp) = false;
 182   dump_generic_node (&pp, node, 0, dump_flags, false);
 183
 184   location_t loc = UNKNOWN_LOCATION;
 185   if (EXPR_HAS_LOCATION (node))
 186     loc = EXPR_LOCATION (node);
 187
 188   optinfo_item *item
 189     = new optinfo_item (OPTINFO_ITEM_KIND_TREE, loc,
 190                         xstrdup (pp_formatted_text (&pp)), true);
 191   m_items.safe_push (item);
 192 }
 193
 194 /* Append a symbol table node to this optinfo.  */
 195
 196 void
 197 optinfo::add_symtab_node (symtab_node *node)
 198 {
 199   location_t loc = DECL_SOURCE_LOCATION (node->decl);
 200   optinfo_item *item
 201     = new optinfo_item (OPTINFO_ITEM_KIND_SYMTAB_NODE, loc,
 202                         xstrdup (node->dump_name ()), true);
 203   m_items.safe_push (item);
 204 }
 205
 206 /* Append the decimal represenation of a wide_int_ref to this
 207    optinfo.  */
 208
 209 void
 210 optinfo::add_dec (const wide_int_ref &wi, signop sgn)
 211 {
 212   char buf[WIDE_INT_PRINT_BUFFER_SIZE];
 213   print_dec (wi, buf, sgn);
 214   optinfo_item *item
 215     = new optinfo_item (OPTINFO_ITEM_KIND_TEXT, UNKNOWN_LOCATION,
 216                         xstrdup (buf), true);
 217   m_items.safe_push (item);
 218 }
 219
 220 /* Should optinfo instances be created?
 221    All creation of optinfos should be guarded by this predicate.
 222    Return true if any optinfo destinations are active.  */
 223
 224 bool optinfo_enabled_p ()
 225 {
 226   return (dump_context::get ().forcibly_enable_optinfo_p ()
 227           || optimization_records_enabled_p ());
 228 }
 229
 230 /* Return true if any of the active optinfo destinations make use
 231    of inlining information.
 232    (if true, then the information is preserved).  */
 233
 234 bool optinfo_wants_inlining_info_p ()
 235 {
 236   return optimization_records_enabled_p ();
 237 }