gcc/dumpfile.h

   1 /* Definitions for the shared dumpfile.
   2    Copyright (C) 2004-2018 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_original,                 /* dump each function before optimizing it */
  34   TDI_gimple,                   /* dump each function after gimplifying it */
  35   TDI_nested,                   /* dump each function after unnesting it */
  36
  37   TDI_lang_all,                 /* enable all the language dumps.  */
  38   TDI_tree_all,                 /* enable all the GENERIC/GIMPLE dumps.  */
  39   TDI_rtl_all,                  /* enable all the RTL dumps.  */
  40   TDI_ipa_all,                  /* enable all the IPA dumps.  */
  41
  42   TDI_end
  43 };
  44
  45 /* Enum used to distinguish dump files to types.  */
  46
  47 enum dump_kind
  48 {
  49   DK_none,
  50   DK_lang,
  51   DK_tree,
  52   DK_rtl,
  53   DK_ipa
  54 };
  55
  56 /* Bit masks to control dumping. Not all values are applicable to all
  57    dumps. Add new ones at the end. When you define new values, extend
  58    the DUMP_OPTIONS array in dumpfile.c. The TDF_* flags coexist with
  59    MSG_* flags (for -fopt-info) and the bit values must be chosen to
  60    allow that.  */
  61 enum dump_flag
  62 {
  63   /* Value of TDF_NONE is used just for bits filtered by TDF_KIND_MASK.  */
  64   TDF_NONE  = 0,
  65
  66   /* Dump node addresses.  */
  67   TDF_ADDRESS = (1 << 0),
  68
  69   /* Don't go wild following links.  */
  70   TDF_SLIM = (1 << 1),
  71
  72   /* Don't unparse the function.  */
  73   TDF_RAW = (1 << 2),
  74
  75   /* Show more detailed info about each pass.  */
  76   TDF_DETAILS = (1 << 3),
  77
  78   /* Dump various statistics about each pass.  */
  79   TDF_STATS = (1 << 4),
  80
  81   /* Display basic block boundaries.  */
  82   TDF_BLOCKS = (1 << 5),
  83
  84   /* Display virtual operands.  */
  85   TDF_VOPS = (1 << 6),
  86
  87   /* Display statement line numbers.  */
  88   TDF_LINENO = (1 << 7),
  89
  90   /* Display decl UIDs.  */
  91   TDF_UID  = (1 << 8),
  92
  93   /* Address of stmt.  */
  94   TDF_STMTADDR = (1 << 9),
  95
  96   /* A graph dump is being emitted.  */
  97   TDF_GRAPH = (1 << 10),
  98
  99   /* Display memory symbols in expr.
 100      Implies TDF_VOPS.  */
 101   TDF_MEMSYMS = (1 << 11),
 102
 103   /* A flag to only print the RHS of a gimple stmt.  */
 104   TDF_RHS_ONLY = (1 << 12),
 105
 106   /* Display asm names of decls.  */
 107   TDF_ASMNAME = (1 << 13),
 108
 109   /* Display EH region number holding this gimple statement.  */
 110   TDF_EH  = (1 << 14),
 111
 112   /* Omit UIDs from dumps.  */
 113   TDF_NOUID = (1 << 15),
 114
 115   /* Display alias information.  */
 116   TDF_ALIAS = (1 << 16),
 117
 118   /* Enumerate locals by uid.  */
 119   TDF_ENUMERATE_LOCALS = (1 << 17),
 120
 121   /* Dump cselib details.  */
 122   TDF_CSELIB = (1 << 18),
 123
 124   /* Dump SCEV details.  */
 125   TDF_SCEV = (1 << 19),
 126
 127   /* Dump in GIMPLE FE syntax  */
 128   TDF_GIMPLE = (1 << 20),
 129
 130   /* Dump folding details.  */
 131   TDF_FOLDING = (1 << 21),
 132
 133   /* -fopt-info optimized sources.  */
 134   MSG_OPTIMIZED_LOCATIONS = (1 << 22),
 135
 136   /* Missed opportunities.  */
 137   MSG_MISSED_OPTIMIZATION = (1 << 23),
 138
 139   /* General optimization info.  */
 140   MSG_NOTE = (1 << 24),
 141
 142   MSG_ALL = (MSG_OPTIMIZED_LOCATIONS
 143              | MSG_MISSED_OPTIMIZATION
 144              | MSG_NOTE),
 145
 146   /* Dumping for -fcompare-debug.  */
 147   TDF_COMPARE_DEBUG = (1 << 25)
 148 };
 149
 150 /* Dump flags type.  */
 151
 152 typedef enum dump_flag dump_flags_t;
 153
 154 static inline dump_flags_t
 155 operator| (dump_flags_t lhs, dump_flags_t rhs)
 156 {
 157   return (dump_flags_t)((int)lhs | (int)rhs);
 158 }
 159
 160 static inline dump_flags_t
 161 operator& (dump_flags_t lhs, dump_flags_t rhs)
 162 {
 163   return (dump_flags_t)((int)lhs & (int)rhs);
 164 }
 165
 166 static inline dump_flags_t
 167 operator~ (dump_flags_t flags)
 168 {
 169   return (dump_flags_t)~((int)flags);
 170 }
 171
 172 static inline dump_flags_t &
 173 operator|= (dump_flags_t &lhs, dump_flags_t rhs)
 174 {
 175   lhs = (dump_flags_t)((int)lhs | (int)rhs);
 176   return lhs;
 177 }
 178
 179 static inline dump_flags_t &
 180 operator&= (dump_flags_t &lhs, dump_flags_t rhs)
 181 {
 182   lhs = (dump_flags_t)((int)lhs & (int)rhs);
 183   return lhs;
 184 }
 185
 186 /* Flags to control high-level -fopt-info dumps.  Usually these flags
 187    define a group of passes.  An optimization pass can be part of
 188    multiple groups.  */
 189
 190 enum optgroup_flag
 191 {
 192   OPTGROUP_NONE = 0,
 193
 194   /* IPA optimization passes */
 195   OPTGROUP_IPA  = (1 << 1),
 196
 197   /* Loop optimization passes */
 198   OPTGROUP_LOOP = (1 << 2),
 199
 200   /* Inlining passes */
 201   OPTGROUP_INLINE = (1 << 3),
 202
 203   /* OMP (Offloading and Multi Processing) transformations */
 204   OPTGROUP_OMP = (1 << 4),
 205
 206   /* Vectorization passes */
 207   OPTGROUP_VEC = (1 << 5),
 208
 209   /* All other passes */
 210   OPTGROUP_OTHER = (1 << 6),
 211
 212   OPTGROUP_ALL = (OPTGROUP_IPA | OPTGROUP_LOOP | OPTGROUP_INLINE
 213                   | OPTGROUP_OMP | OPTGROUP_VEC | OPTGROUP_OTHER)
 214 };
 215
 216 typedef enum optgroup_flag optgroup_flags_t;
 217
 218 static inline optgroup_flags_t
 219 operator| (optgroup_flags_t lhs, optgroup_flags_t rhs)
 220 {
 221   return (optgroup_flags_t)((int)lhs | (int)rhs);
 222 }
 223
 224 static inline optgroup_flags_t &
 225 operator|= (optgroup_flags_t &lhs, optgroup_flags_t rhs)
 226 {
 227   lhs = (optgroup_flags_t)((int)lhs | (int)rhs);
 228   return lhs;
 229 }
 230
 231 /* Define a tree dump switch.  */
 232 struct dump_file_info
 233 {
 234   /* Suffix to give output file.  */
 235   const char *suffix;
 236   /* Command line dump switch.  */
 237   const char *swtch;
 238   /* Command line glob.  */
 239   const char *glob;
 240   /* Filename for the pass-specific stream.  */
 241   const char *pfilename;
 242   /* Filename for the -fopt-info stream.  */
 243   const char *alt_filename;
 244   /* Pass-specific dump stream.  */
 245   FILE *pstream;
 246   /* -fopt-info stream.  */
 247   FILE *alt_stream;
 248   /* Dump kind.  */
 249   dump_kind dkind;
 250   /* Dump flags.  */
 251   dump_flags_t pflags;
 252   /* A pass flags for -fopt-info.  */
 253   dump_flags_t alt_flags;
 254   /* Flags for -fopt-info given by a user.  */
 255   optgroup_flags_t optgroup_flags;
 256   /* State of pass-specific stream.  */
 257   int pstate;
 258   /* State of the -fopt-info stream.  */
 259   int alt_state;
 260   /* Dump file number.  */
 261   int num;
 262   /* Fields "suffix", "swtch", "glob" can be const strings,
 263      or can be dynamically allocated, needing free.  */
 264   bool owns_strings;
 265   /* When a given dump file is being initialized, this flag is set to true
 266      if the corresponding TDF_graph dump file has also been initialized.  */
 267   bool graph_dump_initialized;
 268 };
 269
 270 /* In dumpfile.c */
 271 extern FILE *dump_begin (int, dump_flags_t *);
 272 extern void dump_end (int, FILE *);
 273 extern int opt_info_switch_p (const char *);
 274 extern const char *dump_flag_name (int);
 275 extern void dump_printf (dump_flags_t, const char *, ...) ATTRIBUTE_PRINTF_2;
 276 extern void dump_printf_loc (dump_flags_t, source_location,
 277                              const char *, ...) ATTRIBUTE_PRINTF_3;
 278 extern void dump_function (int phase, tree fn);
 279 extern void dump_basic_block (dump_flags_t, basic_block, int);
 280 extern void dump_generic_expr_loc (dump_flags_t, source_location, dump_flags_t, tree);
 281 extern void dump_generic_expr (dump_flags_t, dump_flags_t, tree);
 282 extern void dump_gimple_stmt_loc (dump_flags_t, source_location, dump_flags_t,
 283                                   gimple *, int);
 284 extern void dump_gimple_stmt (dump_flags_t, dump_flags_t, gimple *, int);
 285 extern void print_combine_total_stats (void);
 286 extern bool enable_rtl_dump_file (void);
 287
 288 template<unsigned int N, typename C>
 289 void dump_dec (dump_flags_t, const poly_int<N, C> &);
 290
 291 /* In tree-dump.c  */
 292 extern void dump_node (const_tree, dump_flags_t, FILE *);
 293
 294 /* In combine.c  */
 295 extern void dump_combine_total_stats (FILE *);
 296 /* In cfghooks.c  */
 297 extern void dump_bb (FILE *, basic_block, int, dump_flags_t);
 298
 299 /* Global variables used to communicate with passes.  */
 300 extern FILE *dump_file;
 301 extern FILE *alt_dump_file;
 302 extern dump_flags_t dump_flags;
 303 extern const char *dump_file_name;
 304
 305 /* Return true if any of the dumps is enabled, false otherwise. */
 306 static inline bool
 307 dump_enabled_p (void)
 308 {
 309   return (dump_file || alt_dump_file);
 310 }
 311
 312 namespace gcc {
 313
 314 class dump_manager
 315 {
 316 public:
 317
 318   dump_manager ();
 319   ~dump_manager ();
 320
 321   /* Register a dumpfile.
 322
 323      TAKE_OWNERSHIP determines whether callee takes ownership of strings
 324      SUFFIX, SWTCH, and GLOB. */
 325   unsigned int
 326   dump_register (const char *suffix, const char *swtch, const char *glob,
 327                  dump_kind dkind, optgroup_flags_t optgroup_flags,
 328                  bool take_ownership);
 329
 330   /* Allow languages and middle-end to register their dumps before the
 331      optimization passes.  */
 332   void
 333   register_dumps ();
 334
 335   /* Return the dump_file_info for the given phase.  */
 336   struct dump_file_info *
 337   get_dump_file_info (int phase) const;
 338
 339   struct dump_file_info *
 340   get_dump_file_info_by_switch (const char *swtch) const;
 341
 342   /* Return the name of the dump file for the given phase.
 343      If the dump is not enabled, returns NULL.  */
 344   char *
 345   get_dump_file_name (int phase) const;
 346
 347   char *
 348   get_dump_file_name (struct dump_file_info *dfi) const;
 349
 350   int
 351   dump_switch_p (const char *arg);
 352
 353   /* Start a dump for PHASE. Store user-supplied dump flags in
 354      *FLAG_PTR.  Return the number of streams opened.  Set globals
 355      DUMP_FILE, and ALT_DUMP_FILE to point to the opened streams, and
 356      set dump_flags appropriately for both pass dump stream and
 357      -fopt-info stream. */
 358   int
 359   dump_start (int phase, dump_flags_t *flag_ptr);
 360
 361   /* Finish a tree dump for PHASE and close associated dump streams.  Also
 362      reset the globals DUMP_FILE, ALT_DUMP_FILE, and DUMP_FLAGS.  */
 363   void
 364   dump_finish (int phase);
 365
 366   FILE *
 367   dump_begin (int phase, dump_flags_t *flag_ptr);
 368
 369   /* Returns nonzero if tree dump PHASE has been initialized.  */
 370   int
 371   dump_initialized_p (int phase) const;
 372
 373   /* Returns the switch name of PHASE.  */
 374   const char *
 375   dump_flag_name (int phase) const;
 376
 377 private:
 378
 379   int
 380   dump_phase_enabled_p (int phase) const;
 381
 382   int
 383   dump_switch_p_1 (const char *arg, struct dump_file_info *dfi, bool doglob);
 384
 385   int
 386   dump_enable_all (dump_kind dkind, dump_flags_t flags, const char *filename);
 387
 388   int
 389   opt_info_enable_passes (optgroup_flags_t optgroup_flags, dump_flags_t flags,
 390                           const char *filename);
 391
 392 private:
 393
 394   /* Dynamically registered dump files and switches.  */
 395   int m_next_dump;
 396   struct dump_file_info *m_extra_dump_files;
 397   size_t m_extra_dump_files_in_use;
 398   size_t m_extra_dump_files_alloced;
 399
 400   /* Grant access to dump_enable_all.  */
 401   friend bool ::enable_rtl_dump_file (void);
 402
 403   /* Grant access to opt_info_enable_passes.  */
 404   friend int ::opt_info_switch_p (const char *arg);
 405
 406 }; // class dump_manager
 407
 408 } // namespace gcc
 409
 410 #endif /* GCC_DUMPFILE_H */