annotate gcc/pass_manager.h @ 158:494b0b89df80 default tip

...
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 18:13:55 +0900
parents 1830386684a0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
111
kono
parents:
diff changeset
1 /* pass_manager.h - The pipeline of optimization passes
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
2 Copyright (C) 2013-2020 Free Software Foundation, Inc.
111
kono
parents:
diff changeset
3
kono
parents:
diff changeset
4 This file is part of GCC.
kono
parents:
diff changeset
5
kono
parents:
diff changeset
6 GCC is free software; you can redistribute it and/or modify it under
kono
parents:
diff changeset
7 the terms of the GNU General Public License as published by the Free
kono
parents:
diff changeset
8 Software Foundation; either version 3, or (at your option) any later
kono
parents:
diff changeset
9 version.
kono
parents:
diff changeset
10
kono
parents:
diff changeset
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
kono
parents:
diff changeset
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
kono
parents:
diff changeset
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
kono
parents:
diff changeset
14 for more details.
kono
parents:
diff changeset
15
kono
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
kono
parents:
diff changeset
17 along with GCC; see the file COPYING3. If not see
kono
parents:
diff changeset
18 <http://www.gnu.org/licenses/>. */
kono
parents:
diff changeset
19
kono
parents:
diff changeset
20 #ifndef GCC_PASS_MANAGER_H
kono
parents:
diff changeset
21 #define GCC_PASS_MANAGER_H
kono
parents:
diff changeset
22
kono
parents:
diff changeset
23 class opt_pass;
kono
parents:
diff changeset
24 struct register_pass_info;
kono
parents:
diff changeset
25
kono
parents:
diff changeset
26 /* Define a list of pass lists so that both passes.c and plugins can easily
kono
parents:
diff changeset
27 find all the pass lists. */
kono
parents:
diff changeset
28 #define GCC_PASS_LISTS \
kono
parents:
diff changeset
29 DEF_PASS_LIST (all_lowering_passes) \
kono
parents:
diff changeset
30 DEF_PASS_LIST (all_small_ipa_passes) \
kono
parents:
diff changeset
31 DEF_PASS_LIST (all_regular_ipa_passes) \
kono
parents:
diff changeset
32 DEF_PASS_LIST (all_late_ipa_passes) \
kono
parents:
diff changeset
33 DEF_PASS_LIST (all_passes)
kono
parents:
diff changeset
34
kono
parents:
diff changeset
35 #define DEF_PASS_LIST(LIST) PASS_LIST_NO_##LIST,
kono
parents:
diff changeset
36 enum pass_list
kono
parents:
diff changeset
37 {
kono
parents:
diff changeset
38 GCC_PASS_LISTS
kono
parents:
diff changeset
39 PASS_LIST_NUM
kono
parents:
diff changeset
40 };
kono
parents:
diff changeset
41 #undef DEF_PASS_LIST
kono
parents:
diff changeset
42
kono
parents:
diff changeset
43 namespace gcc {
kono
parents:
diff changeset
44
kono
parents:
diff changeset
45 class context;
kono
parents:
diff changeset
46
kono
parents:
diff changeset
47 class pass_manager
kono
parents:
diff changeset
48 {
kono
parents:
diff changeset
49 public:
kono
parents:
diff changeset
50 pass_manager (context *ctxt);
kono
parents:
diff changeset
51 ~pass_manager ();
kono
parents:
diff changeset
52
kono
parents:
diff changeset
53 void register_pass (struct register_pass_info *pass_info);
kono
parents:
diff changeset
54 void register_one_dump_file (opt_pass *pass);
kono
parents:
diff changeset
55
kono
parents:
diff changeset
56 opt_pass *get_pass_for_id (int id) const;
kono
parents:
diff changeset
57
kono
parents:
diff changeset
58 void dump_passes () const;
kono
parents:
diff changeset
59
kono
parents:
diff changeset
60 void dump_profile_report () const;
kono
parents:
diff changeset
61
kono
parents:
diff changeset
62 void finish_optimization_passes ();
kono
parents:
diff changeset
63
kono
parents:
diff changeset
64 /* Access to specific passes, so that the majority can be private. */
kono
parents:
diff changeset
65 void execute_early_local_passes ();
kono
parents:
diff changeset
66 unsigned int execute_pass_mode_switching ();
kono
parents:
diff changeset
67
kono
parents:
diff changeset
68 /* Various passes are manually cloned by epiphany. */
kono
parents:
diff changeset
69 opt_pass *get_pass_split_all_insns () const {
kono
parents:
diff changeset
70 return pass_split_all_insns_1;
kono
parents:
diff changeset
71 }
kono
parents:
diff changeset
72 opt_pass *get_pass_mode_switching () const {
kono
parents:
diff changeset
73 return pass_mode_switching_1;
kono
parents:
diff changeset
74 }
kono
parents:
diff changeset
75 opt_pass *get_pass_peephole2 () const { return pass_peephole2_1; }
kono
parents:
diff changeset
76 opt_pass *get_pass_profile () const { return pass_profile_1; }
kono
parents:
diff changeset
77
kono
parents:
diff changeset
78 void register_pass_name (opt_pass *pass, const char *name);
kono
parents:
diff changeset
79
kono
parents:
diff changeset
80 opt_pass *get_pass_by_name (const char *name);
kono
parents:
diff changeset
81
kono
parents:
diff changeset
82 opt_pass *get_rest_of_compilation () const
kono
parents:
diff changeset
83 {
kono
parents:
diff changeset
84 return pass_rest_of_compilation_1;
kono
parents:
diff changeset
85 }
kono
parents:
diff changeset
86 opt_pass *get_clean_slate () const { return pass_clean_state_1; }
kono
parents:
diff changeset
87
kono
parents:
diff changeset
88 public:
kono
parents:
diff changeset
89 /* The root of the compilation pass tree, once constructed. */
kono
parents:
diff changeset
90 opt_pass *all_passes;
kono
parents:
diff changeset
91 opt_pass *all_small_ipa_passes;
kono
parents:
diff changeset
92 opt_pass *all_lowering_passes;
kono
parents:
diff changeset
93 opt_pass *all_regular_ipa_passes;
kono
parents:
diff changeset
94 opt_pass *all_late_ipa_passes;
kono
parents:
diff changeset
95
kono
parents:
diff changeset
96 /* A map from static pass id to optimization pass. */
kono
parents:
diff changeset
97 opt_pass **passes_by_id;
kono
parents:
diff changeset
98 int passes_by_id_size;
kono
parents:
diff changeset
99
kono
parents:
diff changeset
100 opt_pass **pass_lists[PASS_LIST_NUM];
kono
parents:
diff changeset
101
kono
parents:
diff changeset
102 private:
kono
parents:
diff changeset
103 void set_pass_for_id (int id, opt_pass *pass);
kono
parents:
diff changeset
104 void register_dump_files (opt_pass *pass);
kono
parents:
diff changeset
105 void create_pass_tab () const;
kono
parents:
diff changeset
106
kono
parents:
diff changeset
107 private:
kono
parents:
diff changeset
108 context *m_ctxt;
kono
parents:
diff changeset
109 hash_map<nofree_string_hash, opt_pass *> *m_name_to_pass_map;
kono
parents:
diff changeset
110
kono
parents:
diff changeset
111 /* References to all of the individual passes.
kono
parents:
diff changeset
112 These fields are generated via macro expansion.
kono
parents:
diff changeset
113
kono
parents:
diff changeset
114 For example:
kono
parents:
diff changeset
115 NEXT_PASS (pass_build_cfg, 1);
kono
parents:
diff changeset
116 within pass-instances.def means that there is a field:
kono
parents:
diff changeset
117 opt_pass *pass_build_cfg_1;
kono
parents:
diff changeset
118
kono
parents:
diff changeset
119 Similarly, the various:
kono
parents:
diff changeset
120 NEXT_PASS (pass_copy_prop, 1);
kono
parents:
diff changeset
121 ...
kono
parents:
diff changeset
122 NEXT_PASS (pass_copy_prop, 8);
kono
parents:
diff changeset
123 in pass-instances.def lead to fields:
kono
parents:
diff changeset
124 opt_pass *pass_copy_prop_1;
kono
parents:
diff changeset
125 ...
kono
parents:
diff changeset
126 opt_pass *pass_copy_prop_8; */
kono
parents:
diff changeset
127
kono
parents:
diff changeset
128 #define INSERT_PASSES_AFTER(PASS)
kono
parents:
diff changeset
129 #define PUSH_INSERT_PASSES_WITHIN(PASS)
kono
parents:
diff changeset
130 #define POP_INSERT_PASSES()
kono
parents:
diff changeset
131 #define NEXT_PASS(PASS, NUM) opt_pass *PASS ## _ ## NUM
kono
parents:
diff changeset
132 #define NEXT_PASS_WITH_ARG(PASS, NUM, ARG) NEXT_PASS (PASS, NUM)
kono
parents:
diff changeset
133 #define TERMINATE_PASS_LIST(PASS)
kono
parents:
diff changeset
134
kono
parents:
diff changeset
135 #include "pass-instances.def"
kono
parents:
diff changeset
136
kono
parents:
diff changeset
137 #undef INSERT_PASSES_AFTER
kono
parents:
diff changeset
138 #undef PUSH_INSERT_PASSES_WITHIN
kono
parents:
diff changeset
139 #undef POP_INSERT_PASSES
kono
parents:
diff changeset
140 #undef NEXT_PASS
kono
parents:
diff changeset
141 #undef NEXT_PASS_WITH_ARG
kono
parents:
diff changeset
142 #undef TERMINATE_PASS_LIST
kono
parents:
diff changeset
143
kono
parents:
diff changeset
144 }; // class pass_manager
kono
parents:
diff changeset
145
kono
parents:
diff changeset
146 } // namespace gcc
kono
parents:
diff changeset
147
kono
parents:
diff changeset
148 #endif /* ! GCC_PASS_MANAGER_H */
kono
parents:
diff changeset
149