1 /* Dump infrastructure for optimizations and intermediate representation.
2 Copyright (C) 2012-2018 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
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/>. */
22 #include "coretypes.h"
25 #include "gimple-pretty-print.h"
26 #include "diagnostic-core.h"
29 #include "profile-count.h"
31 #include "langhooks.h"
32 #include "backend.h" /* for gimple.h. */
33 #include "gimple.h" /* for dump_user_location_t ctor. */
34 #include "rtl.h" /* for dump_user_location_t ctor. */
37 /* If non-NULL, return one past-the-end of the matching SUBPART of
39 #define skip_leading_substring(whole, part) \
40 (strncmp (whole, part, strlen (part)) ? NULL : whole + strlen (part))
42 static dump_flags_t pflags
; /* current dump_flags */
44 static void dump_loc (dump_flags_t
, FILE *, source_location
);
46 /* Current -fopt-info output stream, if any, and flags. */
47 static FILE *alt_dump_file
= NULL
;
48 static dump_flags_t alt_flags
;
50 static FILE *dump_open_alternate_stream (struct dump_file_info
*);
52 /* These are currently used for communicating between passes.
53 However, instead of accessing them directly, the passes can use
54 dump_printf () for dumps. */
55 FILE *dump_file
= NULL
;
56 const char *dump_file_name
;
57 dump_flags_t dump_flags
;
58 bool dumps_are_enabled
= false;
61 /* Update the "dumps_are_enabled" global; to be called whenever dump_file
62 or alt_dump_file change. */
65 refresh_dumps_are_enabled ()
67 dumps_are_enabled
= (dump_file
|| alt_dump_file
);
70 /* Set global "dump_file" to NEW_DUMP_FILE, refreshing the "dumps_are_enabled"
74 set_dump_file (FILE *new_dump_file
)
76 dump_file
= new_dump_file
;
77 refresh_dumps_are_enabled ();
80 /* Set "alt_dump_file" to NEW_ALT_DUMP_FILE, refreshing the "dumps_are_enabled"
84 set_alt_dump_file (FILE *new_alt_dump_file
)
86 alt_dump_file
= new_alt_dump_file
;
87 refresh_dumps_are_enabled ();
90 #define DUMP_FILE_INFO(suffix, swtch, dkind, num) \
91 {suffix, swtch, NULL, NULL, NULL, NULL, NULL, dkind, TDF_NONE, TDF_NONE, \
92 OPTGROUP_NONE, 0, 0, num, false, false}
94 /* Table of tree dump switches. This must be consistent with the
95 TREE_DUMP_INDEX enumeration in dumpfile.h. */
96 static struct dump_file_info dump_files
[TDI_end
] =
98 DUMP_FILE_INFO (NULL
, NULL
, DK_none
, 0),
99 DUMP_FILE_INFO (".cgraph", "ipa-cgraph", DK_ipa
, 0),
100 DUMP_FILE_INFO (".type-inheritance", "ipa-type-inheritance", DK_ipa
, 0),
101 DUMP_FILE_INFO (".ipa-clones", "ipa-clones", DK_ipa
, 0),
102 DUMP_FILE_INFO (".original", "tree-original", DK_tree
, 0),
103 DUMP_FILE_INFO (".gimple", "tree-gimple", DK_tree
, 0),
104 DUMP_FILE_INFO (".nested", "tree-nested", DK_tree
, 0),
105 DUMP_FILE_INFO (".lto-stream-out", "ipa-lto-stream-out", DK_ipa
, 0),
106 #define FIRST_AUTO_NUMBERED_DUMP 1
107 #define FIRST_ME_AUTO_NUMBERED_DUMP 4
109 DUMP_FILE_INFO (NULL
, "lang-all", DK_lang
, 0),
110 DUMP_FILE_INFO (NULL
, "tree-all", DK_tree
, 0),
111 DUMP_FILE_INFO (NULL
, "rtl-all", DK_rtl
, 0),
112 DUMP_FILE_INFO (NULL
, "ipa-all", DK_ipa
, 0),
115 /* Define a name->number mapping for a dump flag value. */
116 template <typename ValueType
>
119 const char *const name
; /* the name of the value */
120 const ValueType value
; /* the value of the name */
123 /* Table of dump options. This must be consistent with the TDF_* flags
124 in dumpfile.h and opt_info_options below. */
125 static const kv_pair
<dump_flags_t
> dump_options
[] =
127 {"address", TDF_ADDRESS
},
128 {"asmname", TDF_ASMNAME
},
131 {"graph", TDF_GRAPH
},
132 {"details", (TDF_DETAILS
| MSG_OPTIMIZED_LOCATIONS
133 | MSG_MISSED_OPTIMIZATION
135 {"cselib", TDF_CSELIB
},
136 {"stats", TDF_STATS
},
137 {"blocks", TDF_BLOCKS
},
139 {"lineno", TDF_LINENO
},
141 {"stmtaddr", TDF_STMTADDR
},
142 {"memsyms", TDF_MEMSYMS
},
144 {"alias", TDF_ALIAS
},
145 {"nouid", TDF_NOUID
},
146 {"enumerate_locals", TDF_ENUMERATE_LOCALS
},
148 {"gimple", TDF_GIMPLE
},
149 {"folding", TDF_FOLDING
},
150 {"optimized", MSG_OPTIMIZED_LOCATIONS
},
151 {"missed", MSG_MISSED_OPTIMIZATION
},
154 {"all", dump_flags_t (~(TDF_RAW
| TDF_SLIM
| TDF_LINENO
| TDF_GRAPH
155 | TDF_STMTADDR
| TDF_RHS_ONLY
| TDF_NOUID
156 | TDF_ENUMERATE_LOCALS
| TDF_SCEV
| TDF_GIMPLE
))},
160 /* A subset of the dump_options table which is used for -fopt-info
161 types. This must be consistent with the MSG_* flags in dumpfile.h.
163 static const kv_pair
<dump_flags_t
> optinfo_verbosity_options
[] =
165 {"optimized", MSG_OPTIMIZED_LOCATIONS
},
166 {"missed", MSG_MISSED_OPTIMIZATION
},
172 /* Flags used for -fopt-info groups. */
173 static const kv_pair
<optgroup_flags_t
> optgroup_options
[] =
175 {"ipa", OPTGROUP_IPA
},
176 {"loop", OPTGROUP_LOOP
},
177 {"inline", OPTGROUP_INLINE
},
178 {"omp", OPTGROUP_OMP
},
179 {"vec", OPTGROUP_VEC
},
180 {"optall", OPTGROUP_ALL
},
181 {NULL
, OPTGROUP_NONE
}
184 gcc::dump_manager::dump_manager ():
185 m_next_dump (FIRST_AUTO_NUMBERED_DUMP
),
186 m_extra_dump_files (NULL
),
187 m_extra_dump_files_in_use (0),
188 m_extra_dump_files_alloced (0)
192 gcc::dump_manager::~dump_manager ()
194 for (size_t i
= 0; i
< m_extra_dump_files_in_use
; i
++)
196 dump_file_info
*dfi
= &m_extra_dump_files
[i
];
197 /* suffix, swtch, glob are statically allocated for the entries
198 in dump_files, and for statistics, but are dynamically allocated
199 for those for passes. */
200 if (dfi
->owns_strings
)
202 XDELETEVEC (const_cast <char *> (dfi
->suffix
));
203 XDELETEVEC (const_cast <char *> (dfi
->swtch
));
204 XDELETEVEC (const_cast <char *> (dfi
->glob
));
206 /* These, if non-NULL, are always dynamically allocated. */
207 XDELETEVEC (const_cast <char *> (dfi
->pfilename
));
208 XDELETEVEC (const_cast <char *> (dfi
->alt_filename
));
210 XDELETEVEC (m_extra_dump_files
);
215 dump_register (const char *suffix
, const char *swtch
, const char *glob
,
216 dump_kind dkind
, optgroup_flags_t optgroup_flags
,
219 int num
= m_next_dump
++;
221 size_t count
= m_extra_dump_files_in_use
++;
223 if (count
>= m_extra_dump_files_alloced
)
225 if (m_extra_dump_files_alloced
== 0)
226 m_extra_dump_files_alloced
= 512;
228 m_extra_dump_files_alloced
*= 2;
229 m_extra_dump_files
= XRESIZEVEC (struct dump_file_info
,
231 m_extra_dump_files_alloced
);
233 /* Construct a new object in the space allocated above. */
234 new (m_extra_dump_files
+ count
) dump_file_info ();
238 /* Zero out the already constructed object. */
239 m_extra_dump_files
[count
] = dump_file_info ();
242 m_extra_dump_files
[count
].suffix
= suffix
;
243 m_extra_dump_files
[count
].swtch
= swtch
;
244 m_extra_dump_files
[count
].glob
= glob
;
245 m_extra_dump_files
[count
].dkind
= dkind
;
246 m_extra_dump_files
[count
].optgroup_flags
= optgroup_flags
;
247 m_extra_dump_files
[count
].num
= num
;
248 m_extra_dump_files
[count
].owns_strings
= take_ownership
;
250 return count
+ TDI_end
;
254 /* Allow languages and middle-end to register their dumps before the
255 optimization passes. */
261 lang_hooks
.register_dumps (this);
262 /* If this assert fails, some FE registered more than
263 FIRST_ME_AUTO_NUMBERED_DUMP - FIRST_AUTO_NUMBERED_DUMP
264 dump files. Bump FIRST_ME_AUTO_NUMBERED_DUMP accordingly. */
265 gcc_assert (m_next_dump
<= FIRST_ME_AUTO_NUMBERED_DUMP
);
266 m_next_dump
= FIRST_ME_AUTO_NUMBERED_DUMP
;
267 dump_files
[TDI_original
].num
= m_next_dump
++;
268 dump_files
[TDI_gimple
].num
= m_next_dump
++;
269 dump_files
[TDI_nested
].num
= m_next_dump
++;
273 /* Return the dump_file_info for the given phase. */
275 struct dump_file_info
*
277 get_dump_file_info (int phase
) const
280 return &dump_files
[phase
];
281 else if ((size_t) (phase
- TDI_end
) >= m_extra_dump_files_in_use
)
284 return m_extra_dump_files
+ (phase
- TDI_end
);
287 /* Locate the dump_file_info with swtch equal to SWTCH,
288 or return NULL if no such dump_file_info exists. */
290 struct dump_file_info
*
292 get_dump_file_info_by_switch (const char *swtch
) const
294 for (unsigned i
= 0; i
< m_extra_dump_files_in_use
; i
++)
295 if (strcmp (m_extra_dump_files
[i
].swtch
, swtch
) == 0)
296 return &m_extra_dump_files
[i
];
303 /* Return the name of the dump file for the given phase.
304 The caller is responsible for calling free on the returned
306 If the dump is not enabled, returns NULL. */
310 get_dump_file_name (int phase
) const
312 struct dump_file_info
*dfi
;
314 if (phase
== TDI_none
)
317 dfi
= get_dump_file_info (phase
);
319 return get_dump_file_name (dfi
);
322 /* Return the name of the dump file for the given dump_file_info.
323 The caller is responsible for calling free on the returned
325 If the dump is not enabled, returns NULL. */
329 get_dump_file_name (struct dump_file_info
*dfi
) const
335 if (dfi
->pstate
== 0)
338 /* If available, use the command line dump filename. */
340 return xstrdup (dfi
->pfilename
);
346 /* (null), LANG, TREE, RTL, IPA. */
347 char suffix
= " ltri"[dfi
->dkind
];
349 if (snprintf (dump_id
, sizeof (dump_id
), ".%03d%c", dfi
->num
, suffix
) < 0)
353 return concat (dump_base_name
, dump_id
, dfi
->suffix
, NULL
);
356 /* Open a dump file called FILENAME. Some filenames are special and
357 refer to the standard streams. TRUNC indicates whether this is the
358 first open (so the file should be truncated, rather than appended).
359 An error message is emitted in the event of failure. */
362 dump_open (const char *filename
, bool trunc
)
364 if (strcmp ("stderr", filename
) == 0)
367 if (strcmp ("stdout", filename
) == 0
368 || strcmp ("-", filename
) == 0)
371 FILE *stream
= fopen (filename
, trunc
? "w" : "a");
374 error ("could not open dump file %qs: %m", filename
);
378 /* For a given DFI, open an alternate dump filename (which could also
379 be a standard stream such as stdout/stderr). If the alternate dump
380 file cannot be opened, return NULL. */
383 dump_open_alternate_stream (struct dump_file_info
*dfi
)
385 if (!dfi
->alt_filename
)
389 return dfi
->alt_stream
;
391 FILE *stream
= dump_open (dfi
->alt_filename
, dfi
->alt_state
< 0);
399 /* Construct a dump_user_location_t from STMT (using its location and
402 dump_user_location_t::dump_user_location_t (gimple
*stmt
)
403 : m_count (), m_loc (UNKNOWN_LOCATION
)
408 m_count
= stmt
->bb
->count
;
409 m_loc
= gimple_location (stmt
);
413 /* Construct a dump_user_location_t from an RTL instruction (using its
414 location and hotness). */
416 dump_user_location_t::dump_user_location_t (rtx_insn
*insn
)
417 : m_count (), m_loc (UNKNOWN_LOCATION
)
421 basic_block bb
= BLOCK_FOR_INSN (insn
);
424 m_loc
= INSN_LOCATION (insn
);
428 /* Construct from a function declaration. This one requires spelling out
429 to avoid accidentally constructing from other kinds of tree. */
432 dump_user_location_t::from_function_decl (tree fndecl
)
436 // FIXME: profile count for function?
437 return dump_user_location_t (profile_count (),
438 DECL_SOURCE_LOCATION (fndecl
));
441 /* Print source location on DFILE if enabled. */
444 dump_loc (dump_flags_t dump_kind
, FILE *dfile
, source_location loc
)
448 if (LOCATION_LOCUS (loc
) > BUILTINS_LOCATION
)
449 fprintf (dfile
, "%s:%d:%d: note: ", LOCATION_FILE (loc
),
450 LOCATION_LINE (loc
), LOCATION_COLUMN (loc
));
451 else if (current_function_decl
)
452 fprintf (dfile
, "%s:%d:%d: note: ",
453 DECL_SOURCE_FILE (current_function_decl
),
454 DECL_SOURCE_LINE (current_function_decl
),
455 DECL_SOURCE_COLUMN (current_function_decl
));
456 /* Indentation based on scope depth. */
457 fprintf (dfile
, "%*s", get_dump_scope_depth (), "");
461 /* Dump gimple statement GS with SPC indentation spaces and
462 EXTRA_DUMP_FLAGS on the dump streams if DUMP_KIND is enabled. */
465 dump_gimple_stmt (dump_flags_t dump_kind
, dump_flags_t extra_dump_flags
,
468 if (dump_file
&& (dump_kind
& pflags
))
469 print_gimple_stmt (dump_file
, gs
, spc
, dump_flags
| extra_dump_flags
);
471 if (alt_dump_file
&& (dump_kind
& alt_flags
))
472 print_gimple_stmt (alt_dump_file
, gs
, spc
, dump_flags
| extra_dump_flags
);
475 /* Similar to dump_gimple_stmt, except additionally print source location. */
478 dump_gimple_stmt_loc (dump_flags_t dump_kind
, const dump_location_t
&loc
,
479 dump_flags_t extra_dump_flags
, gimple
*gs
, int spc
)
481 location_t srcloc
= loc
.get_location_t ();
482 if (dump_file
&& (dump_kind
& pflags
))
484 dump_loc (dump_kind
, dump_file
, srcloc
);
485 print_gimple_stmt (dump_file
, gs
, spc
, dump_flags
| extra_dump_flags
);
488 if (alt_dump_file
&& (dump_kind
& alt_flags
))
490 dump_loc (dump_kind
, alt_dump_file
, srcloc
);
491 print_gimple_stmt (alt_dump_file
, gs
, spc
, dump_flags
| extra_dump_flags
);
495 /* Dump expression tree T using EXTRA_DUMP_FLAGS on dump streams if
496 DUMP_KIND is enabled. */
499 dump_generic_expr (dump_flags_t dump_kind
, dump_flags_t extra_dump_flags
,
502 if (dump_file
&& (dump_kind
& pflags
))
503 print_generic_expr (dump_file
, t
, dump_flags
| extra_dump_flags
);
505 if (alt_dump_file
&& (dump_kind
& alt_flags
))
506 print_generic_expr (alt_dump_file
, t
, dump_flags
| extra_dump_flags
);
510 /* Similar to dump_generic_expr, except additionally print the source
514 dump_generic_expr_loc (dump_flags_t dump_kind
, const dump_location_t
&loc
,
515 dump_flags_t extra_dump_flags
, tree t
)
517 location_t srcloc
= loc
.get_location_t ();
518 if (dump_file
&& (dump_kind
& pflags
))
520 dump_loc (dump_kind
, dump_file
, srcloc
);
521 print_generic_expr (dump_file
, t
, dump_flags
| extra_dump_flags
);
524 if (alt_dump_file
&& (dump_kind
& alt_flags
))
526 dump_loc (dump_kind
, alt_dump_file
, srcloc
);
527 print_generic_expr (alt_dump_file
, t
, dump_flags
| extra_dump_flags
);
531 /* Output a formatted message using FORMAT on appropriate dump streams. */
534 dump_printf (dump_flags_t dump_kind
, const char *format
, ...)
536 if (dump_file
&& (dump_kind
& pflags
))
539 va_start (ap
, format
);
540 vfprintf (dump_file
, format
, ap
);
544 if (alt_dump_file
&& (dump_kind
& alt_flags
))
547 va_start (ap
, format
);
548 vfprintf (alt_dump_file
, format
, ap
);
553 /* Similar to dump_printf, except source location is also printed. */
556 dump_printf_loc (dump_flags_t dump_kind
, const dump_location_t
&loc
,
557 const char *format
, ...)
559 location_t srcloc
= loc
.get_location_t ();
560 if (dump_file
&& (dump_kind
& pflags
))
563 dump_loc (dump_kind
, dump_file
, srcloc
);
564 va_start (ap
, format
);
565 vfprintf (dump_file
, format
, ap
);
569 if (alt_dump_file
&& (dump_kind
& alt_flags
))
572 dump_loc (dump_kind
, alt_dump_file
, srcloc
);
573 va_start (ap
, format
);
574 vfprintf (alt_dump_file
, format
, ap
);
579 /* Output VALUE in decimal to appropriate dump streams. */
581 template<unsigned int N
, typename C
>
583 dump_dec (dump_flags_t dump_kind
, const poly_int
<N
, C
> &value
)
585 STATIC_ASSERT (poly_coeff_traits
<C
>::signedness
>= 0);
586 signop sgn
= poly_coeff_traits
<C
>::signedness
? SIGNED
: UNSIGNED
;
587 if (dump_file
&& (dump_kind
& pflags
))
588 print_dec (value
, dump_file
, sgn
);
590 if (alt_dump_file
&& (dump_kind
& alt_flags
))
591 print_dec (value
, alt_dump_file
, sgn
);
594 template void dump_dec (dump_flags_t
, const poly_uint16
&);
595 template void dump_dec (dump_flags_t
, const poly_int64
&);
596 template void dump_dec (dump_flags_t
, const poly_uint64
&);
597 template void dump_dec (dump_flags_t
, const poly_offset_int
&);
598 template void dump_dec (dump_flags_t
, const poly_widest_int
&);
600 /* The current dump scope-nesting depth. */
602 static int dump_scope_depth
;
604 /* Get the current dump scope-nesting depth.
605 For use by dump_*_loc (for showing nesting via indentation). */
608 get_dump_scope_depth ()
610 return dump_scope_depth
;
613 /* Push a nested dump scope.
614 Print "=== NAME ===\n" to the dumpfile, if any, and to the -fopt-info
616 Increment the scope depth. */
619 dump_begin_scope (const char *name
, const dump_location_t
&loc
)
621 dump_printf_loc (MSG_NOTE
, loc
, "=== %s ===\n", name
);
625 /* Pop a nested dump scope. */
633 /* Start a dump for PHASE. Store user-supplied dump flags in
634 *FLAG_PTR. Return the number of streams opened. Set globals
635 DUMP_FILE, and ALT_DUMP_FILE to point to the opened streams, and
636 set dump_flags appropriately for both pass dump stream and
637 -fopt-info stream. */
641 dump_start (int phase
, dump_flags_t
*flag_ptr
)
645 struct dump_file_info
*dfi
;
647 if (phase
== TDI_none
|| !dump_phase_enabled_p (phase
))
650 dfi
= get_dump_file_info (phase
);
651 name
= get_dump_file_name (phase
);
654 stream
= dump_open (name
, dfi
->pstate
< 0);
661 dfi
->pstream
= stream
;
662 set_dump_file (dfi
->pstream
);
663 /* Initialize current dump flags. */
664 pflags
= dfi
->pflags
;
667 stream
= dump_open_alternate_stream (dfi
);
670 dfi
->alt_stream
= stream
;
672 set_alt_dump_file (dfi
->alt_stream
);
673 /* Initialize current -fopt-info flags. */
674 alt_flags
= dfi
->alt_flags
;
678 *flag_ptr
= dfi
->pflags
;
683 /* Finish a tree dump for PHASE and close associated dump streams. Also
684 reset the globals DUMP_FILE, ALT_DUMP_FILE, and DUMP_FLAGS. */
688 dump_finish (int phase
)
690 struct dump_file_info
*dfi
;
694 dfi
= get_dump_file_info (phase
);
695 if (dfi
->pstream
&& dfi
->pstream
!= stdout
&& dfi
->pstream
!= stderr
)
696 fclose (dfi
->pstream
);
698 if (dfi
->alt_stream
&& dfi
->alt_stream
!= stdout
&& dfi
->alt_stream
!= stderr
)
699 fclose (dfi
->alt_stream
);
701 dfi
->alt_stream
= NULL
;
703 set_dump_file (NULL
);
704 set_alt_dump_file (NULL
);
705 dump_flags
= TDF_NONE
;
706 alt_flags
= TDF_NONE
;
710 /* Begin a tree dump for PHASE. Stores any user supplied flag in
711 *FLAG_PTR and returns a stream to write to. If the dump is not
712 enabled, returns NULL.
713 Multiple calls will reopen and append to the dump file. */
716 dump_begin (int phase
, dump_flags_t
*flag_ptr
)
718 return g
->get_dumps ()->dump_begin (phase
, flag_ptr
);
723 dump_begin (int phase
, dump_flags_t
*flag_ptr
)
726 struct dump_file_info
*dfi
;
729 if (phase
== TDI_none
|| !dump_phase_enabled_p (phase
))
732 name
= get_dump_file_name (phase
);
735 dfi
= get_dump_file_info (phase
);
737 stream
= dump_open (name
, dfi
->pstate
< 0);
743 *flag_ptr
= dfi
->pflags
;
745 /* Initialize current flags */
746 pflags
= dfi
->pflags
;
750 /* Returns nonzero if dump PHASE is enabled for at least one stream.
751 If PHASE is TDI_tree_all, return nonzero if any dump is enabled for
756 dump_phase_enabled_p (int phase
) const
758 if (phase
== TDI_tree_all
)
761 for (i
= TDI_none
+ 1; i
< (size_t) TDI_end
; i
++)
762 if (dump_files
[i
].pstate
|| dump_files
[i
].alt_state
)
764 for (i
= 0; i
< m_extra_dump_files_in_use
; i
++)
765 if (m_extra_dump_files
[i
].pstate
|| m_extra_dump_files
[i
].alt_state
)
771 struct dump_file_info
*dfi
= get_dump_file_info (phase
);
772 return dfi
->pstate
|| dfi
->alt_state
;
776 /* Returns nonzero if tree dump PHASE has been initialized. */
780 dump_initialized_p (int phase
) const
782 struct dump_file_info
*dfi
= get_dump_file_info (phase
);
783 return dfi
->pstate
> 0 || dfi
->alt_state
> 0;
786 /* Returns the switch name of PHASE. */
789 dump_flag_name (int phase
)
791 return g
->get_dumps ()->dump_flag_name (phase
);
796 dump_flag_name (int phase
) const
798 struct dump_file_info
*dfi
= get_dump_file_info (phase
);
802 /* Finish a tree dump for PHASE. STREAM is the stream created by
806 dump_end (int phase ATTRIBUTE_UNUSED
, FILE *stream
)
808 if (stream
!= stderr
&& stream
!= stdout
)
812 /* Enable all tree dumps with FLAGS on FILENAME. Return number of
813 enabled tree dumps. */
817 dump_enable_all (dump_kind dkind
, dump_flags_t flags
, const char *filename
)
822 for (i
= TDI_none
+ 1; i
< (size_t) TDI_end
; i
++)
824 if ((dump_files
[i
].dkind
== dkind
))
826 const char *old_filename
= dump_files
[i
].pfilename
;
827 dump_files
[i
].pstate
= -1;
828 dump_files
[i
].pflags
|= flags
;
830 /* Override the existing filename. */
833 dump_files
[i
].pfilename
= xstrdup (filename
);
834 /* Since it is a command-line provided file, which is
835 common to all the phases, use it in append mode. */
836 dump_files
[i
].pstate
= 1;
838 if (old_filename
&& filename
!= old_filename
)
839 free (CONST_CAST (char *, old_filename
));
843 for (i
= 0; i
< m_extra_dump_files_in_use
; i
++)
845 if ((m_extra_dump_files
[i
].dkind
== dkind
))
847 const char *old_filename
= m_extra_dump_files
[i
].pfilename
;
848 m_extra_dump_files
[i
].pstate
= -1;
849 m_extra_dump_files
[i
].pflags
|= flags
;
851 /* Override the existing filename. */
854 m_extra_dump_files
[i
].pfilename
= xstrdup (filename
);
855 /* Since it is a command-line provided file, which is
856 common to all the phases, use it in append mode. */
857 m_extra_dump_files
[i
].pstate
= 1;
859 if (old_filename
&& filename
!= old_filename
)
860 free (CONST_CAST (char *, old_filename
));
867 /* Enable -fopt-info dumps on all dump files matching OPTGROUP_FLAGS.
868 Enable dumps with FLAGS on FILENAME. Return the number of enabled
873 opt_info_enable_passes (optgroup_flags_t optgroup_flags
, dump_flags_t flags
,
874 const char *filename
)
879 for (i
= TDI_none
+ 1; i
< (size_t) TDI_end
; i
++)
881 if ((dump_files
[i
].optgroup_flags
& optgroup_flags
))
883 const char *old_filename
= dump_files
[i
].alt_filename
;
884 /* Since this file is shared among different passes, it
885 should be opened in append mode. */
886 dump_files
[i
].alt_state
= 1;
887 dump_files
[i
].alt_flags
|= flags
;
889 /* Override the existing filename. */
891 dump_files
[i
].alt_filename
= xstrdup (filename
);
892 if (old_filename
&& filename
!= old_filename
)
893 free (CONST_CAST (char *, old_filename
));
897 for (i
= 0; i
< m_extra_dump_files_in_use
; i
++)
899 if ((m_extra_dump_files
[i
].optgroup_flags
& optgroup_flags
))
901 const char *old_filename
= m_extra_dump_files
[i
].alt_filename
;
902 /* Since this file is shared among different passes, it
903 should be opened in append mode. */
904 m_extra_dump_files
[i
].alt_state
= 1;
905 m_extra_dump_files
[i
].alt_flags
|= flags
;
907 /* Override the existing filename. */
909 m_extra_dump_files
[i
].alt_filename
= xstrdup (filename
);
910 if (old_filename
&& filename
!= old_filename
)
911 free (CONST_CAST (char *, old_filename
));
918 /* Parse ARG as a dump switch. Return nonzero if it is, and store the
919 relevant details in the dump_files array. */
923 dump_switch_p_1 (const char *arg
, struct dump_file_info
*dfi
, bool doglob
)
925 const char *option_value
;
929 if (doglob
&& !dfi
->glob
)
932 option_value
= skip_leading_substring (arg
, doglob
? dfi
->glob
: dfi
->swtch
);
936 if (*option_value
&& *option_value
!= '-' && *option_value
!= '=')
944 const struct kv_pair
<dump_flags_t
> *option_ptr
;
951 end_ptr
= strchr (ptr
, '-');
952 eq_ptr
= strchr (ptr
, '=');
954 if (eq_ptr
&& !end_ptr
)
958 end_ptr
= ptr
+ strlen (ptr
);
959 length
= end_ptr
- ptr
;
961 for (option_ptr
= dump_options
; option_ptr
->name
; option_ptr
++)
962 if (strlen (option_ptr
->name
) == length
963 && !memcmp (option_ptr
->name
, ptr
, length
))
965 flags
|= option_ptr
->value
;
971 /* Interpret rest of the argument as a dump filename. This
972 filename overrides other command line filenames. */
974 free (CONST_CAST (char *, dfi
->pfilename
));
975 dfi
->pfilename
= xstrdup (ptr
+ 1);
979 warning (0, "ignoring unknown option %q.*s in %<-fdump-%s%>",
980 length
, ptr
, dfi
->swtch
);
986 dfi
->pflags
|= flags
;
988 /* Process -fdump-tree-all and -fdump-rtl-all, by enabling all the
990 if (dfi
->suffix
== NULL
)
991 dump_enable_all (dfi
->dkind
, dfi
->pflags
, dfi
->pfilename
);
998 dump_switch_p (const char *arg
)
1003 for (i
= TDI_none
+ 1; i
!= TDI_end
; i
++)
1004 any
|= dump_switch_p_1 (arg
, &dump_files
[i
], false);
1006 /* Don't glob if we got a hit already */
1008 for (i
= TDI_none
+ 1; i
!= TDI_end
; i
++)
1009 any
|= dump_switch_p_1 (arg
, &dump_files
[i
], true);
1011 for (i
= 0; i
< m_extra_dump_files_in_use
; i
++)
1012 any
|= dump_switch_p_1 (arg
, &m_extra_dump_files
[i
], false);
1015 for (i
= 0; i
< m_extra_dump_files_in_use
; i
++)
1016 any
|= dump_switch_p_1 (arg
, &m_extra_dump_files
[i
], true);
1022 /* Parse ARG as a -fopt-info switch and store flags, optgroup_flags
1023 and filename. Return non-zero if it is a recognized switch. */
1026 opt_info_switch_p_1 (const char *arg
, dump_flags_t
*flags
,
1027 optgroup_flags_t
*optgroup_flags
, char **filename
)
1029 const char *option_value
;
1037 *optgroup_flags
= OPTGROUP_NONE
;
1040 return 1; /* Handle '-fopt-info' without any additional options. */
1044 const char *end_ptr
;
1050 end_ptr
= strchr (ptr
, '-');
1051 eq_ptr
= strchr (ptr
, '=');
1053 if (eq_ptr
&& !end_ptr
)
1057 end_ptr
= ptr
+ strlen (ptr
);
1058 length
= end_ptr
- ptr
;
1060 for (const kv_pair
<dump_flags_t
> *option_ptr
= optinfo_verbosity_options
;
1061 option_ptr
->name
; option_ptr
++)
1062 if (strlen (option_ptr
->name
) == length
1063 && !memcmp (option_ptr
->name
, ptr
, length
))
1065 *flags
|= option_ptr
->value
;
1069 for (const kv_pair
<optgroup_flags_t
> *option_ptr
= optgroup_options
;
1070 option_ptr
->name
; option_ptr
++)
1071 if (strlen (option_ptr
->name
) == length
1072 && !memcmp (option_ptr
->name
, ptr
, length
))
1074 *optgroup_flags
|= option_ptr
->value
;
1080 /* Interpret rest of the argument as a dump filename. This
1081 filename overrides other command line filenames. */
1082 *filename
= xstrdup (ptr
+ 1);
1087 warning (0, "unknown option %q.*s in %<-fopt-info-%s%>",
1098 /* Return non-zero if ARG is a recognized switch for
1099 -fopt-info. Return zero otherwise. */
1102 opt_info_switch_p (const char *arg
)
1105 optgroup_flags_t optgroup_flags
;
1107 static char *file_seen
= NULL
;
1108 gcc::dump_manager
*dumps
= g
->get_dumps ();
1110 if (!opt_info_switch_p_1 (arg
, &flags
, &optgroup_flags
, &filename
))
1114 filename
= xstrdup ("stderr");
1116 /* Bail out if a different filename has been specified. */
1117 if (file_seen
&& strcmp (file_seen
, filename
))
1119 warning (0, "ignoring possibly conflicting option %<-fopt-info-%s%>",
1124 file_seen
= xstrdup (filename
);
1126 flags
= MSG_OPTIMIZED_LOCATIONS
;
1127 if (!optgroup_flags
)
1128 optgroup_flags
= OPTGROUP_ALL
;
1130 return dumps
->opt_info_enable_passes (optgroup_flags
, flags
, filename
);
1133 /* Print basic block on the dump streams. */
1136 dump_basic_block (dump_flags_t dump_kind
, basic_block bb
, int indent
)
1138 if (dump_file
&& (dump_kind
& pflags
))
1139 dump_bb (dump_file
, bb
, indent
, TDF_DETAILS
);
1140 if (alt_dump_file
&& (dump_kind
& alt_flags
))
1141 dump_bb (alt_dump_file
, bb
, indent
, TDF_DETAILS
);
1144 /* Dump FUNCTION_DECL FN as tree dump PHASE. */
1147 dump_function (int phase
, tree fn
)
1152 stream
= dump_begin (phase
, &flags
);
1155 dump_function_to_file (fn
, stream
, flags
);
1156 dump_end (phase
, stream
);
1160 /* Print information from the combine pass on dump_file. */
1163 print_combine_total_stats (void)
1166 dump_combine_total_stats (dump_file
);
1169 /* Enable RTL dump for all the RTL passes. */
1172 enable_rtl_dump_file (void)
1174 gcc::dump_manager
*dumps
= g
->get_dumps ();
1176 dumps
->dump_enable_all (DK_rtl
, dump_flags_t (TDF_DETAILS
) | TDF_BLOCKS
,
1178 return num_enabled
> 0;
1183 namespace selftest
{
1185 /* Verify that the dump_location_t constructors capture the source location
1186 at which they were called (provided that the build compiler is sufficiently
1190 test_impl_location ()
1192 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8)
1195 dump_location_t loc
;
1196 const int expected_line
= __LINE__
- 1;
1197 ASSERT_STR_CONTAINS (loc
.get_impl_location ().m_file
, "dumpfile.c");
1198 ASSERT_EQ (loc
.get_impl_location ().m_line
, expected_line
);
1201 /* Constructing from a gimple. */
1203 dump_location_t
loc ((gimple
*)NULL
);
1204 const int expected_line
= __LINE__
- 1;
1205 ASSERT_STR_CONTAINS (loc
.get_impl_location ().m_file
, "dumpfile.c");
1206 ASSERT_EQ (loc
.get_impl_location ().m_line
, expected_line
);
1209 /* Constructing from an rtx_insn. */
1211 dump_location_t
loc ((rtx_insn
*)NULL
);
1212 const int expected_line
= __LINE__
- 1;
1213 ASSERT_STR_CONTAINS (loc
.get_impl_location ().m_file
, "dumpfile.c");
1214 ASSERT_EQ (loc
.get_impl_location ().m_line
, expected_line
);
1219 /* Run all of the selftests within this file. */
1224 test_impl_location ();
1227 } // namespace selftest
1229 #endif /* CHECKING_P */