1/* Definitions for the shared dumpfile.
2   Copyright (C) 2004-2015 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published by
8the Free Software Foundation; either version 3, or (at your option)
9any later version.
10
11GCC is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along 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#include "line-map.h"
25
26/* Different tree dump places.  When you add new tree dump places,
27   extend the DUMP_FILES array in dumpfile.c.  */
28enum tree_dump_index
29{
30  TDI_none,			/* No dump */
31  TDI_cgraph,                   /* dump function call graph.  */
32  TDI_inheritance,              /* dump type inheritance graph.  */
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 MSG_OPTIMIZED_LOCATIONS  (1 << 26)  /* -fopt-info optimized sources */
87#define MSG_MISSED_OPTIMIZATION  (1 << 27)  /* missed opportunities */
88#define MSG_NOTE                 (1 << 28)  /* general optimization info */
89#define MSG_ALL         (MSG_OPTIMIZED_LOCATIONS | MSG_MISSED_OPTIMIZATION \
90                         | MSG_NOTE)
91
92
93/* Flags to control high-level -fopt-info dumps.  Usually these flags
94   define a group of passes.  An optimization pass can be part of
95   multiple groups.  */
96#define OPTGROUP_NONE        (0)
97#define OPTGROUP_IPA         (1 << 1)   /* IPA optimization passes */
98#define OPTGROUP_LOOP        (1 << 2)   /* Loop optimization passes */
99#define OPTGROUP_INLINE      (1 << 3)   /* Inlining passes */
100#define OPTGROUP_VEC         (1 << 4)   /* Vectorization passes */
101#define OPTGROUP_OTHER       (1 << 5)   /* All other passes */
102#define OPTGROUP_ALL	     (OPTGROUP_IPA | OPTGROUP_LOOP | OPTGROUP_INLINE \
103                              | OPTGROUP_VEC | OPTGROUP_OTHER)
104
105/* Define a tree dump switch.  */
106struct dump_file_info
107{
108  const char *suffix;           /* suffix to give output file.  */
109  const char *swtch;            /* command line dump switch */
110  const char *glob;             /* command line glob  */
111  const char *pfilename;        /* filename for the pass-specific stream  */
112  const char *alt_filename;     /* filename for the -fopt-info stream  */
113  FILE *pstream;                /* pass-specific dump stream  */
114  FILE *alt_stream;             /* -fopt-info stream */
115  int pflags;                   /* dump flags */
116  int optgroup_flags;           /* optgroup flags for -fopt-info */
117  int alt_flags;                /* flags for opt-info */
118  int pstate;                   /* state of pass-specific stream */
119  int alt_state;                /* state of the -fopt-info stream */
120  int num;                      /* dump file number */
121  bool owns_strings;            /* fields "suffix", "swtch", "glob" can be
122				   const strings, or can be dynamically
123				   allocated, needing free.  */
124};
125
126/* In dumpfile.c */
127extern FILE *dump_begin (int, int *);
128extern void dump_end (int, FILE *);
129extern int opt_info_switch_p (const char *);
130extern const char *dump_flag_name (int);
131extern void dump_printf (int, const char *, ...) ATTRIBUTE_PRINTF_2;
132extern void dump_printf_loc (int, source_location,
133                             const char *, ...) ATTRIBUTE_PRINTF_3;
134extern void dump_basic_block (int, basic_block, int);
135extern void dump_generic_expr_loc (int, source_location, int, tree);
136extern void dump_generic_expr (int, int, tree);
137extern void dump_gimple_stmt_loc (int, source_location, int, gimple, int);
138extern void dump_gimple_stmt (int, int, gimple, int);
139extern void print_combine_total_stats (void);
140extern bool enable_rtl_dump_file (void);
141
142/* In tree-dump.c  */
143extern void dump_node (const_tree, int, FILE *);
144
145/* In combine.c  */
146extern void dump_combine_total_stats (FILE *);
147/* In cfghooks.c  */
148extern void dump_bb (FILE *, basic_block, int, int);
149
150/* Global variables used to communicate with passes.  */
151extern FILE *dump_file;
152extern FILE *alt_dump_file;
153extern int dump_flags;
154extern const char *dump_file_name;
155
156/* Return true if any of the dumps is enabled, false otherwise. */
157static inline bool
158dump_enabled_p (void)
159{
160  return (dump_file || alt_dump_file);
161}
162
163namespace gcc {
164
165class dump_manager
166{
167public:
168
169  dump_manager ();
170  ~dump_manager ();
171
172  /* Register a dumpfile.
173
174     TAKE_OWNERSHIP determines whether callee takes ownership of strings
175     SUFFIX, SWTCH, and GLOB. */
176  unsigned int
177  dump_register (const char *suffix, const char *swtch, const char *glob,
178		 int flags, int optgroup_flags,
179		 bool take_ownership);
180
181  /* Return the dump_file_info for the given phase.  */
182  struct dump_file_info *
183  get_dump_file_info (int phase) const;
184
185  struct dump_file_info *
186  get_dump_file_info_by_switch (const char *swtch) const;
187
188  /* Return the name of the dump file for the given phase.
189     If the dump is not enabled, returns NULL.  */
190  char *
191  get_dump_file_name (int phase) const;
192
193  char *
194  get_dump_file_name (struct dump_file_info *dfi) const;
195
196  int
197  dump_switch_p (const char *arg);
198
199  /* Start a dump for PHASE. Store user-supplied dump flags in
200     *FLAG_PTR.  Return the number of streams opened.  Set globals
201     DUMP_FILE, and ALT_DUMP_FILE to point to the opened streams, and
202     set dump_flags appropriately for both pass dump stream and
203     -fopt-info stream. */
204  int
205  dump_start (int phase, int *flag_ptr);
206
207  /* Finish a tree dump for PHASE and close associated dump streams.  Also
208     reset the globals DUMP_FILE, ALT_DUMP_FILE, and DUMP_FLAGS.  */
209  void
210  dump_finish (int phase);
211
212  FILE *
213  dump_begin (int phase, int *flag_ptr);
214
215  /* Returns nonzero if tree dump PHASE has been initialized.  */
216  int
217  dump_initialized_p (int phase) const;
218
219  /* Returns the switch name of PHASE.  */
220  const char *
221  dump_flag_name (int phase) const;
222
223private:
224
225  int
226  dump_phase_enabled_p (int phase) const;
227
228  int
229  dump_switch_p_1 (const char *arg, struct dump_file_info *dfi, bool doglob);
230
231  int
232  dump_enable_all (int flags, const char *filename);
233
234  int
235  opt_info_enable_passes (int optgroup_flags, int flags, const char *filename);
236
237private:
238
239  /* Dynamically registered dump files and switches.  */
240  int m_next_dump;
241  struct dump_file_info *m_extra_dump_files;
242  size_t m_extra_dump_files_in_use;
243  size_t m_extra_dump_files_alloced;
244
245  /* Grant access to dump_enable_all.  */
246  friend bool ::enable_rtl_dump_file (void);
247
248  /* Grant access to opt_info_enable_passes.  */
249  friend int ::opt_info_switch_p (const char *arg);
250
251}; // class dump_manager
252
253} // namespace gcc
254
255#endif /* GCC_DUMPFILE_H */
256