1 /*
2 * Copyright (c) 2012, 2026, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_OPTO_PHASETYPE_HPP
26 #define SHARE_OPTO_PHASETYPE_HPP
27
28 #include "memory/allocation.hpp"
29 #include "utilities/bitMap.inline.hpp"
30 #include "utilities/stringUtils.hpp"
31
32 #define COMPILER_PHASES(flags) \
33 flags(BEFORE_STRINGOPTS, "Before StringOpts") \
34 flags(AFTER_STRINGOPTS, "After StringOpts") \
35 flags(BEFORE_REMOVEUSELESS, "Before RemoveUseless") \
36 flags(AFTER_PARSING, "After Parsing") \
37 flags(BEFORE_ITER_GVN, "Before Iter GVN") \
38 flags(ITER_GVN1, "Iter GVN 1") \
39 flags(AFTER_ITER_GVN_STEP, "After Iter GVN Step") \
40 flags(AFTER_ITER_GVN, "After Iter GVN") \
41 flags(INCREMENTAL_INLINE_STEP, "Incremental Inline Step") \
42 flags(INCREMENTAL_INLINE_CLEANUP, "Incremental Inline Cleanup") \
43 flags(INCREMENTAL_INLINE, "Incremental Inline") \
44 flags(INCREMENTAL_BOXING_INLINE, "Incremental Boxing Inline") \
45 flags(EXPAND_VUNBOX, "Expand VectorUnbox") \
46 flags(SCALARIZE_VBOX, "Scalarize VectorBox") \
47 flags(INLINE_VECTOR_REBOX, "Inline Vector Rebox Calls") \
48 flags(EXPAND_VBOX, "Expand VectorBox") \
49 flags(ELIMINATE_VBOX_ALLOC, "Eliminate VectorBoxAllocate") \
50 flags(ITER_GVN_BEFORE_EA, "Iter GVN before EA") \
51 flags(ITER_GVN_AFTER_VECTOR, "Iter GVN after Vector Box Elimination") \
52 flags(BEFORE_LOOP_OPTS, "Before Loop Optimizations") \
53 flags(PHASEIDEAL_BEFORE_EA, "PhaseIdealLoop before EA") \
54 flags(EA_AFTER_INITIAL_CONGRAPH, "EA: 1. Intial Connection Graph") \
55 flags(EA_CONNECTION_GRAPH_PROPAGATE_ITER, "EA: 2. Connection Graph Propagate Iter") \
56 flags(EA_COMPLETE_CONNECTION_GRAPH_ITER, "EA: 2. Complete Connection Graph Iter") \
57 flags(EA_AFTER_COMPLETE_CONGRAPH, "EA: 2. Complete Connection Graph") \
58 flags(EA_ADJUST_SCALAR_REPLACEABLE_ITER, "EA: 3. Adjust scalar_replaceable State Iter") \
59 flags(EA_PROPAGATE_NSR_ITER, "EA: 3. Propagate NSR Iter") \
60 flags(EA_AFTER_PROPAGATE_NSR, "EA: 3. Propagate NSR") \
61 flags(EA_AFTER_GRAPH_OPTIMIZATION, "EA: 4. After Graph Optimization") \
62 flags(EA_AFTER_SPLIT_UNIQUE_TYPES_1, "EA: 5. After split_unique_types Phase 1") \
63 flags(EA_AFTER_SPLIT_UNIQUE_TYPES_3, "EA: 5. After split_unique_types Phase 3") \
64 flags(EA_AFTER_SPLIT_UNIQUE_TYPES_4, "EA: 5. After split_unique_types Phase 4") \
65 flags(EA_AFTER_SPLIT_UNIQUE_TYPES, "EA: 5. After split_unique_types") \
66 flags(EA_AFTER_REDUCE_PHI_ON_SAFEPOINTS, "EA: 6. After reduce_phi_on_safepoints") \
67 flags(EA_BEFORE_PHI_REDUCTION, "EA: 5. Before Phi Reduction") \
68 flags(EA_AFTER_PHI_CASTPP_REDUCTION, "EA: 5. Phi -> CastPP Reduction") \
69 flags(EA_AFTER_PHI_ADDP_REDUCTION, "EA: 5. Phi -> AddP Reduction") \
70 flags(EA_AFTER_PHI_CMP_REDUCTION, "EA: 5. Phi -> Cmp Reduction") \
71 flags(AFTER_EA, "After Escape Analysis") \
72 flags(ITER_GVN_AFTER_EA, "Iter GVN after EA") \
73 flags(BEFORE_BEAUTIFY_LOOPS, "Before Beautify Loops") \
74 flags(AFTER_BEAUTIFY_LOOPS, "After Beautify Loops") \
75 flags(BEFORE_CLOOPS, "Before CountedLoop") \
76 flags(AFTER_CLOOPS, "After CountedLoop") \
77 flags(BEFORE_SPLIT_IF, "Before Split-If") \
78 flags(AFTER_SPLIT_IF, "After Split-If") \
79 flags(BEFORE_LOOP_PREDICATION_IC, "Before Loop Predication IC") \
80 flags(AFTER_LOOP_PREDICATION_IC, "After Loop Predication IC") \
81 flags(BEFORE_LOOP_PREDICATION_RC, "Before Loop Predication RC") \
82 flags(AFTER_LOOP_PREDICATION_RC, "After Loop Predication RC") \
83 flags(BEFORE_PARTIAL_PEELING, "Before Partial Peeling") \
84 flags(AFTER_PARTIAL_PEELING, "After Partial Peeling") \
85 flags(BEFORE_LOOP_PEELING, "Before Loop Peeling") \
86 flags(AFTER_LOOP_PEELING, "After Loop Peeling") \
87 flags(BEFORE_LOOP_UNSWITCHING, "Before Loop Unswitching") \
88 flags(AFTER_LOOP_UNSWITCHING, "After Loop Unswitching") \
89 flags(BEFORE_LOOP_MULTIVERSIONING, "Before Loop Multiversioning") \
90 flags(AFTER_LOOP_MULTIVERSIONING, "After Loop Multiversioning") \
91 flags(BEFORE_RANGE_CHECK_ELIMINATION, "Before Range Check Elimination") \
92 flags(AFTER_RANGE_CHECK_ELIMINATION, "After Range Check Elimination") \
93 flags(ITER_GVN_AFTER_ELIMINATION, "Iter GVN after Eliminating Allocations and Locks") \
94 flags(BEFORE_PRE_MAIN_POST, "Before Pre/Main/Post Loops") \
95 flags(AFTER_PRE_MAIN_POST, "After Pre/Main/Post Loops") \
96 flags(BEFORE_POST_LOOP, "Before Post Loop") \
97 flags(AFTER_POST_LOOP, "After Post Loop") \
98 flags(BEFORE_REMOVE_EMPTY_LOOP, "Before Remove Empty Loop") \
99 flags(AFTER_REMOVE_EMPTY_LOOP, "After Remove Empty Loop") \
100 flags(BEFORE_ONE_ITERATION_LOOP, "Before Replace One-Iteration Loop") \
101 flags(AFTER_ONE_ITERATION_LOOP, "After Replace One-Iteration Loop") \
102 flags(BEFORE_DUPLICATE_LOOP_BACKEDGE, "Before Duplicate Loop Backedge") \
103 flags(AFTER_DUPLICATE_LOOP_BACKEDGE, "After Duplicate Loop Backedge") \
104 flags(BEFORE_LOOP_UNROLLING, "Before Loop Unrolling") \
105 flags(AFTER_LOOP_UNROLLING, "After Loop Unrolling") \
106 flags(PHASEIDEALLOOP1, "PhaseIdealLoop 1") \
107 flags(PHASEIDEALLOOP2, "PhaseIdealLoop 2") \
108 flags(PHASEIDEALLOOP3, "PhaseIdealLoop 3") \
109 flags(AUTO_VECTORIZATION1_BEFORE_APPLY, "AutoVectorization 1, before Apply") \
110 flags(AUTO_VECTORIZATION3_AFTER_ADJUST_LIMIT, "AutoVectorization 2, after Adjusting Pre-loop Limit") \
111 flags(AUTO_VECTORIZATION4_AFTER_SPECULATIVE_RUNTIME_CHECKS, "AutoVectorization 3, after Adding Speculative Runtime Checks") \
112 flags(AUTO_VECTORIZATION5_AFTER_APPLY, "AutoVectorization 4, after Apply") \
113 flags(BEFORE_CCP1, "Before PhaseCCP 1") \
114 flags(CCP1, "PhaseCCP 1") \
115 flags(ITER_GVN2, "Iter GVN 2") \
116 flags(PHASEIDEALLOOP_ITERATIONS, "PhaseIdealLoop iterations") \
117 flags(AFTER_LOOP_OPTS, "After Loop Optimizations") \
118 flags(AFTER_MERGE_STORES, "After Merge Stores") \
119 flags(AFTER_MACRO_ELIMINATION_STEP, "After Macro Elimination Step") \
120 flags(AFTER_MACRO_ELIMINATION, "After Macro Elimination") \
121 flags(BEFORE_MACRO_EXPANSION , "Before Macro Expansion") \
122 flags(AFTER_MACRO_EXPANSION_STEP, "After Macro Expansion Step") \
123 flags(AFTER_MACRO_EXPANSION, "After Macro Expansion") \
124 flags(BARRIER_EXPANSION, "Barrier Expand") \
125 flags(OPTIMIZE_FINISHED, "Optimize Finished") \
126 flags(BEFORE_MATCHING, "Before Matching") \
127 flags(MATCHING, "After Matching") \
128 flags(GLOBAL_CODE_MOTION, "Global Code Motion") \
129 flags(INITIAL_LIVENESS, "Initial Liveness") \
130 flags(LIVE_RANGE_STRETCHING, "Live Range Stretching") \
131 flags(AGGRESSIVE_COALESCING, "Aggressive Coalescing") \
132 flags(INITIAL_SPILLING, "Initial Spilling") \
133 flags(CONSERVATIVE_COALESCING, "Conservative Coalescing") \
134 flags(ITERATIVE_SPILLING, "Iterative Spilling") \
135 flags(AFTER_ITERATIVE_SPILLING, "After Iterative Spilling") \
136 flags(POST_ALLOCATION_COPY_REMOVAL, "Post-allocation Copy Removal") \
137 flags(MERGE_MULTI_DEFS, "Merge Multiple Definitions") \
138 flags(FIX_UP_SPILLS, "Fix up Spills") \
139 flags(REGISTER_ALLOCATION, "Register Allocation") \
140 flags(BLOCK_ORDERING, "Block Ordering") \
141 flags(PEEPHOLE, "Peephole") \
142 flags(POSTALLOC_EXPAND, "Post-allocation Expand") \
143 flags(MACH_ANALYSIS, "After Mach Analysis") \
144 flags(FINAL_CODE, "Final Code") \
145 flags(END, "End") \
146 flags(FAILURE, "Failure") \
147 flags(SPLIT_INLINES_ARRAY, "Split inlines array") \
148 flags(SPLIT_INLINES_ARRAY_IGVN, "IGVN after split inlines array") \
149 flags(ALL, "All") \
150 flags(DEBUG, "Debug")
151
152 #define table_entry(name, description) PHASE_##name,
153 enum CompilerPhaseType {
154 COMPILER_PHASES(table_entry)
155 PHASE_NUM_TYPES,
156 PHASE_NONE
157 };
158 #undef table_entry
159
160 class CompilerPhaseTypeHelper {
161 private:
162 static const char* const _phase_descriptions[];
163 static const char* const _phase_names[];
164
165 public:
166 static const char* to_name(CompilerPhaseType cpt) {
167 return _phase_names[cpt];
168 }
169 static const char* to_description(CompilerPhaseType cpt) {
170 return _phase_descriptions[cpt];
171 }
172
173 static CompilerPhaseType find_phase(const char* str);
174 };
175
176 class PhaseNameValidator {
177 private:
178 CHeapBitMap _phase_name_set;
179 bool _valid;
180 char* _bad;
181
182 public:
183 PhaseNameValidator(ccstrlist option) :
184 _phase_name_set(PHASE_NUM_TYPES, mtCompiler),
185 _valid(true),
186 _bad(nullptr)
187 {
188 for (StringUtils::CommaSeparatedStringIterator iter(option); *iter != nullptr && _valid; ++iter) {
189
190 CompilerPhaseType cpt = CompilerPhaseTypeHelper::find_phase(*iter);
191 if (PHASE_NONE == cpt) {
192 const size_t len = MIN2<size_t>(strlen(*iter), 63) + 1; // cap len to a value we know is enough for all phase descriptions
193 _bad = NEW_C_HEAP_ARRAY(char, len, mtCompiler);
194 // strncpy always writes len characters. If the source string is shorter, the function fills the remaining bytes with nulls.
195 strncpy(_bad, *iter, len);
196 _valid = false;
197 } else if (PHASE_ALL == cpt) {
198 _phase_name_set.set_range(0, PHASE_NUM_TYPES);
199 } else {
200 assert(cpt < PHASE_NUM_TYPES, "out of bounds");
201 _phase_name_set.set_bit(cpt);
202 }
203 }
204 }
205
206 ~PhaseNameValidator() {
207 if (_bad != nullptr) {
208 FREE_C_HEAP_ARRAY(char, _bad);
209 }
210 }
211
212 const BitMap& phase_name_set() const {
213 assert(is_valid(), "Use of invalid phase name set");
214 return _phase_name_set;
215 }
216
217 bool is_valid() const {
218 return _valid;
219 }
220
221 const char* what() const {
222 return _bad;
223 }
224 };
225
226 #endif // SHARE_OPTO_PHASETYPE_HPP