[doc][13/14] Document AArch64 target attributes and pragmas
[official-gcc.git] / gcc / pass_manager.h
blob7d539e47aa81722a8d30317ad7184d38abf6bfe6
1 /* pass_manager.h - The pipeline of optimization passes
2 Copyright (C) 2013-2015 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
9 version.
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
14 for more details.
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/>. */
20 #ifndef GCC_PASS_MANAGER_H
21 #define GCC_PASS_MANAGER_H
23 class opt_pass;
24 struct register_pass_info;
26 /* Define a list of pass lists so that both passes.c and plugins can easily
27 find all the pass lists. */
28 #define GCC_PASS_LISTS \
29 DEF_PASS_LIST (all_lowering_passes) \
30 DEF_PASS_LIST (all_small_ipa_passes) \
31 DEF_PASS_LIST (all_regular_ipa_passes) \
32 DEF_PASS_LIST (all_late_ipa_passes) \
33 DEF_PASS_LIST (all_passes)
35 #define DEF_PASS_LIST(LIST) PASS_LIST_NO_##LIST,
36 enum pass_list
38 GCC_PASS_LISTS
39 PASS_LIST_NUM
41 #undef DEF_PASS_LIST
43 namespace gcc {
45 class context;
47 class pass_manager
49 public:
50 void *operator new (size_t sz);
51 void operator delete (void *ptr);
53 pass_manager (context *ctxt);
54 ~pass_manager ();
56 void register_pass (struct register_pass_info *pass_info);
57 void register_one_dump_file (opt_pass *pass);
59 opt_pass *get_pass_for_id (int id) const;
61 void dump_passes () const;
63 void dump_profile_report () const;
65 void finish_optimization_passes ();
67 /* Access to specific passes, so that the majority can be private. */
68 void execute_early_local_passes ();
69 unsigned int execute_pass_mode_switching ();
71 /* Various passes are manually cloned by epiphany. */
72 opt_pass *get_pass_split_all_insns () const {
73 return pass_split_all_insns_1;
75 opt_pass *get_pass_mode_switching () const {
76 return pass_mode_switching_1;
78 opt_pass *get_pass_peephole2 () const { return pass_peephole2_1; }
79 opt_pass *get_pass_profile () const { return pass_profile_1; }
81 public:
82 /* The root of the compilation pass tree, once constructed. */
83 opt_pass *all_passes;
84 opt_pass *all_small_ipa_passes;
85 opt_pass *all_lowering_passes;
86 opt_pass *all_regular_ipa_passes;
87 opt_pass *all_late_ipa_passes;
89 /* A map from static pass id to optimization pass. */
90 opt_pass **passes_by_id;
91 int passes_by_id_size;
93 opt_pass **pass_lists[PASS_LIST_NUM];
95 private:
96 void set_pass_for_id (int id, opt_pass *pass);
97 void register_dump_files (opt_pass *pass);
99 private:
100 context *m_ctxt;
102 /* References to all of the individual passes.
103 These fields are generated via macro expansion.
105 For example:
106 NEXT_PASS (pass_build_cfg, 1);
107 within pass-instances.def means that there is a field:
108 opt_pass *pass_build_cfg_1;
110 Similarly, the various:
111 NEXT_PASS (pass_copy_prop, 1);
113 NEXT_PASS (pass_copy_prop, 8);
114 in pass-instances.def lead to fields:
115 opt_pass *pass_copy_prop_1;
117 opt_pass *pass_copy_prop_8; */
119 #define INSERT_PASSES_AFTER(PASS)
120 #define PUSH_INSERT_PASSES_WITHIN(PASS)
121 #define POP_INSERT_PASSES()
122 #define NEXT_PASS(PASS, NUM) opt_pass *PASS ## _ ## NUM
123 #define TERMINATE_PASS_LIST()
125 #include "pass-instances.def"
127 #undef INSERT_PASSES_AFTER
128 #undef PUSH_INSERT_PASSES_WITHIN
129 #undef POP_INSERT_PASSES
130 #undef NEXT_PASS
131 #undef TERMINATE_PASS_LIST
133 }; // class pass_manager
135 } // namespace gcc
137 #endif /* ! GCC_PASS_MANAGER_H */