gcc/dumpfile.h

   1 /* Definitions for the shared dumpfile.
   2    Copyright (C) 2004-2017 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 3, or (at your option)
   9 any later version.
  10
  11 GCC is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING3.  If not see
  18 <http://www.gnu.org/licenses/>.  */
  19
  20
  21 #ifndef GCC_DUMPFILE_H
  22 #define GCC_DUMPFILE_H 1
  23
  24
  25 /* Different tree dump places.  When you add new tree dump places,
  26    extend the DUMP_FILES array in dumpfile.c.  */
  27 enum tree_dump_index
  28 {
  29   TDI_none,                     /* No dump */
  30   TDI_cgraph,                   /* dump function call graph.  */
  31   TDI_inheritance,              /* dump type inheritance graph.  */
  32   TDI_clones,                   /* dump IPA cloning decisions.  */
  33   TDI_tu,                       /* dump the whole translation unit.  */
  34   TDI_original,                 /* dump each function before optimizing it */
  35   TDI_generic,                  /* dump each function after genericizing it */
  36   TDI_nested,                   /* dump each function after unnesting it */
  37
  38   TDI_lang_all,                 /* enable all the language dumps.  */
  39   TDI_tree_all,                 /* enable all the GENERIC/GIMPLE dumps.  */
  40   TDI_rtl_all,                  /* enable all the RTL dumps.  */
  41   TDI_ipa_all,                  /* enable all the IPA dumps.  */
  42
  43   TDI_end
  44 };
  45
  46 /* Enum used to distinguish dump files to types.  */
  47
  48 enum dump_kind
  49 {
  50   DK_none,
  51   DK_lang,
  52   DK_tree,
  53   DK_rtl,
  54   DK_ipa
  55 };
  56
  57 /* Bit masks to control dumping. Not all values are applicable to all
  58    dumps. Add new ones at the end. When you define new values, extend
  59    the DUMP_OPTIONS array in dumpfile.c. The TDF_* flags coexist with
  60    MSG_* flags (for -fopt-info) and the bit values must be chosen to
  61    allow that.  */
  62 #define TDF_ADDRESS     (1 << 3)        /* dump node addresses */
  63 #define TDF_SLIM        (1 << 4)        /* don't go wild following links */
  64 #define TDF_RAW         (1 << 5)        /* don't unparse the function */
  65 #define TDF_DETAILS     (1 << 6)        /* show more detailed info about
  66                                            each pass */
  67 #define TDF_STATS       (1 << 7)        /* dump various statistics about
  68                                            each pass */
  69 #define TDF_BLOCKS      (1 << 8)        /* display basic block boundaries */
  70 #define TDF_VOPS        (1 << 9)        /* display virtual operands */
  71 #define TDF_LINENO      (1 << 10)       /* display statement line numbers */
  72 #define TDF_UID         (1 << 11)       /* display decl UIDs */
  73
  74 #define TDF_STMTADDR    (1 << 12)       /* Address of stmt.  */
  75
  76 #define TDF_GRAPH       (1 << 13)       /* a graph dump is being emitted */
  77 #define TDF_MEMSYMS     (1 << 14)       /* display memory symbols in expr.
  78                                            Implies TDF_VOPS.  */
  79
  80 #define TDF_DIAGNOSTIC  (1 << 15)       /* A dump to be put in a diagnostic
  81                                            message.  */
  82 #define TDF_VERBOSE     (1 << 16)       /* A dump that uses the full tree
  83                                            dumper to print stmts.  */
  84 #define TDF_RHS_ONLY    (1 << 17)       /* a flag to only print the RHS of
  85                                            a gimple stmt.  */
  86 #define TDF_ASMNAME     (1 << 18)       /* display asm names of decls  */
  87 #define TDF_EH          (1 << 19)       /* display EH region number
  88                                            holding this gimple statement.  */
  89 #define TDF_NOUID       (1 << 20)       /* omit UIDs from dumps.  */
  90 #define TDF_ALIAS       (1 << 21)       /* display alias information  */
  91 #define TDF_ENUMERATE_LOCALS (1 << 22)  /* Enumerate locals by uid.  */
  92 #define TDF_CSELIB      (1 << 23)       /* Dump cselib details.  */
  93 #define TDF_SCEV        (1 << 24)       /* Dump SCEV details.  */
  94 #define TDF_COMMENT     (1 << 25)       /* Dump lines with prefix ";;"  */
  95 #define TDF_GIMPLE      (1 << 26)       /* Dump in GIMPLE FE syntax  */
  96 #define MSG_OPTIMIZED_LOCATIONS  (1 << 27)  /* -fopt-info optimized sources */
  97 #define MSG_MISSED_OPTIMIZATION  (1 << 28)  /* missed opportunities */
  98 #define MSG_NOTE                 (1 << 29)  /* general optimization info */
  99 #define MSG_ALL         (MSG_OPTIMIZED_LOCATIONS | MSG_MISSED_OPTIMIZATION \
 100                          | MSG_NOTE)
 101
 102
 103 /* Value of TDF_NONE is used just for bits filtered by TDF_KIND_MASK.  */
 104
 105 #define TDF_NONE 0
 106
 107 /* Flags to control high-level -fopt-info dumps.  Usually these flags
 108    define a group of passes.  An optimization pass can be part of
 109    multiple groups.  */
 110 #define OPTGROUP_NONE        (0)
 111 #define OPTGROUP_IPA         (1 << 1)   /* IPA optimization passes */
 112 #define OPTGROUP_LOOP        (1 << 2)   /* Loop optimization passes */
 113 #define OPTGROUP_INLINE      (1 << 3)   /* Inlining passes */
 114 #define OPTGROUP_OMP         (1 << 4)   /* OMP (Offloading and Multi
 115                                            Processing) transformations */
 116 #define OPTGROUP_VEC         (1 << 5)   /* Vectorization passes */
 117 #define OPTGROUP_OTHER       (1 << 6)   /* All other passes */
 118 #define OPTGROUP_ALL         (OPTGROUP_IPA | OPTGROUP_LOOP | OPTGROUP_INLINE \
 119                               | OPTGROUP_OMP | OPTGROUP_VEC | OPTGROUP_OTHER)
 120
 121 /* Dump flags type.  */
 122
 123 typedef uint64_t dump_flags_t;
 124
 125 /* Define a tree dump switch.  */
 126 struct dump_file_info
 127 {
 128   /* Constructor.  */
 129   CONSTEXPR dump_file_info ();
 130
 131   /* Constructor.  */
 132   dump_file_info (const char *_suffix, const char *_swtch, dump_kind _dkind,
 133                   int _num);
 134
 135   /* Suffix to give output file.  */
 136   const char *suffix;
 137   /* Command line dump switch.  */
 138   const char *swtch;
 139   /* Command line glob.  */
 140   const char *glob;
 141   /* Filename for the pass-specific stream.  */
 142   const char *pfilename;
 143   /* Filename for the -fopt-info stream.  */
 144   const char *alt_filename;
 145   /* Pass-specific dump stream.  */
 146   FILE *pstream;
 147   /* -fopt-info stream.  */
 148   FILE *alt_stream;
 149   /* Dump kind.  */
 150   dump_kind dkind;
 151   /* Dump flags.  */
 152   dump_flags_t pflags;
 153   /* A pass flags for -fopt-info.  */
 154   int alt_flags;
 155   /* Flags for -fopt-info given by a user.  */
 156   int optgroup_flags;
 157   /* State of pass-specific stream.  */
 158   int pstate;
 159   /* State of the -fopt-info stream.  */
 160   int alt_state;
 161   /* Dump file number.  */
 162   int num;
 163   /* Fields "suffix", "swtch", "glob" can be const strings,
 164      or can be dynamically allocated, needing free.  */
 165   bool owns_strings;
 166   /* When a given dump file is being initialized, this flag is set to true
 167      if the corresponding TDF_graph dump file has also been initialized.  */
 168   bool graph_dump_initialized;
 169 };
 170
 171 /* In dumpfile.c */
 172 extern FILE *dump_begin (int, dump_flags_t *);
 173 extern void dump_end (int, FILE *);
 174 extern int opt_info_switch_p (const char *);
 175 extern const char *dump_flag_name (int);
 176 extern void dump_printf (dump_flags_t, const char *, ...) ATTRIBUTE_PRINTF_2;
 177 extern void dump_printf_loc (dump_flags_t, source_location,
 178                              const char *, ...) ATTRIBUTE_PRINTF_3;
 179 extern void dump_function (int phase, tree fn);
 180 extern void dump_basic_block (int, basic_block, int);
 181 extern void dump_generic_expr_loc (int, source_location, int, tree);
 182 extern void dump_generic_expr (dump_flags_t, dump_flags_t, tree);
 183 extern void dump_gimple_stmt_loc (dump_flags_t, source_location, dump_flags_t,
 184                                   gimple *, int);
 185 extern void dump_gimple_stmt (dump_flags_t, dump_flags_t, gimple *, int);
 186 extern void print_combine_total_stats (void);
 187 extern bool enable_rtl_dump_file (void);
 188
 189 /* In tree-dump.c  */
 190 extern void dump_node (const_tree, dump_flags_t, FILE *);
 191
 192 /* In combine.c  */
 193 extern void dump_combine_total_stats (FILE *);
 194 /* In cfghooks.c  */
 195 extern void dump_bb (FILE *, basic_block, int, dump_flags_t);
 196
 197 /* Global variables used to communicate with passes.  */
 198 extern FILE *dump_file;
 199 extern FILE *alt_dump_file;
 200 extern dump_flags_t dump_flags;
 201 extern const char *dump_file_name;
 202
 203 /* Return true if any of the dumps is enabled, false otherwise. */
 204 static inline bool
 205 dump_enabled_p (void)
 206 {
 207   return (dump_file || alt_dump_file);
 208 }
 209
 210 namespace gcc {
 211
 212 class dump_manager
 213 {
 214 public:
 215
 216   dump_manager ();
 217   ~dump_manager ();
 218
 219   /* Register a dumpfile.
 220
 221      TAKE_OWNERSHIP determines whether callee takes ownership of strings
 222      SUFFIX, SWTCH, and GLOB. */
 223   unsigned int
 224   dump_register (const char *suffix, const char *swtch, const char *glob,
 225                  dump_kind dkind, int optgroup_flags, bool take_ownership);
 226
 227   /* Return the dump_file_info for the given phase.  */
 228   struct dump_file_info *
 229   get_dump_file_info (int phase) const;
 230
 231   struct dump_file_info *
 232   get_dump_file_info_by_switch (const char *swtch) const;
 233
 234   /* Return the name of the dump file for the given phase.
 235      If the dump is not enabled, returns NULL.  */
 236   char *
 237   get_dump_file_name (int phase) const;
 238
 239   char *
 240   get_dump_file_name (struct dump_file_info *dfi) const;
 241
 242   int
 243   dump_switch_p (const char *arg);
 244
 245   /* Start a dump for PHASE. Store user-supplied dump flags in
 246      *FLAG_PTR.  Return the number of streams opened.  Set globals
 247      DUMP_FILE, and ALT_DUMP_FILE to point to the opened streams, and
 248      set dump_flags appropriately for both pass dump stream and
 249      -fopt-info stream. */
 250   int
 251   dump_start (int phase, dump_flags_t *flag_ptr);
 252
 253   /* Finish a tree dump for PHASE and close associated dump streams.  Also
 254      reset the globals DUMP_FILE, ALT_DUMP_FILE, and DUMP_FLAGS.  */
 255   void
 256   dump_finish (int phase);
 257
 258   FILE *
 259   dump_begin (int phase, dump_flags_t *flag_ptr);
 260
 261   /* Returns nonzero if tree dump PHASE has been initialized.  */
 262   int
 263   dump_initialized_p (int phase) const;
 264
 265   /* Returns the switch name of PHASE.  */
 266   const char *
 267   dump_flag_name (int phase) const;
 268
 269 private:
 270
 271   int
 272   dump_phase_enabled_p (int phase) const;
 273
 274   int
 275   dump_switch_p_1 (const char *arg, struct dump_file_info *dfi, bool doglob);
 276
 277   int
 278   dump_enable_all (dump_kind dkind, dump_flags_t flags, const char *filename);
 279
 280   int
 281   opt_info_enable_passes (int optgroup_flags, dump_flags_t flags,
 282                           const char *filename);
 283
 284 private:
 285
 286   /* Dynamically registered dump files and switches.  */
 287   int m_next_dump;
 288   struct dump_file_info *m_extra_dump_files;
 289   size_t m_extra_dump_files_in_use;
 290   size_t m_extra_dump_files_alloced;
 291
 292   /* Grant access to dump_enable_all.  */
 293   friend bool ::enable_rtl_dump_file (void);
 294
 295   /* Grant access to opt_info_enable_passes.  */
 296   friend int ::opt_info_switch_p (const char *arg);
 297
 298 }; // class dump_manager
 299
 300 } // namespace gcc
 301
 302 #endif /* GCC_DUMPFILE_H */