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