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