1 /*
2 * Copyright (c) 2012, 2025, 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 "utilities/bitMap.inline.hpp"
29 #include "utilities/stringUtils.hpp"
30
31 #define COMPILER_PHASES(flags) \
32 flags(BEFORE_STRINGOPTS, "Before StringOpts") \
33 flags(AFTER_STRINGOPTS, "After StringOpts") \
34 flags(BEFORE_REMOVEUSELESS, "Before RemoveUseless") \
35 flags(AFTER_PARSING, "After Parsing") \
36 flags(BEFORE_ITER_GVN, "Before Iter GVN") \
37 flags(ITER_GVN1, "Iter GVN 1") \
38 flags(AFTER_ITER_GVN_STEP, "After Iter GVN Step") \
39 flags(AFTER_ITER_GVN, "After Iter GVN") \
40 flags(INCREMENTAL_INLINE_STEP, "Incremental Inline Step") \
41 flags(INCREMENTAL_INLINE_CLEANUP, "Incremental Inline Cleanup") \
42 flags(INCREMENTAL_INLINE, "Incremental Inline") \
43 flags(INCREMENTAL_BOXING_INLINE, "Incremental Boxing Inline") \
44 flags(EXPAND_VUNBOX, "Expand VectorUnbox") \
45 flags(SCALARIZE_VBOX, "Scalarize VectorBox") \
46 flags(INLINE_VECTOR_REBOX, "Inline Vector Rebox Calls") \
47 flags(EXPAND_VBOX, "Expand VectorBox") \
48 flags(ELIMINATE_VBOX_ALLOC, "Eliminate VectorBoxAllocate") \
49 flags(ITER_GVN_BEFORE_EA, "Iter GVN before EA") \
50 flags(ITER_GVN_AFTER_VECTOR, "Iter GVN after Vector Box Elimination") \
51 flags(BEFORE_LOOP_OPTS, "Before Loop Optimizations") \
52 flags(PHASEIDEAL_BEFORE_EA, "PhaseIdealLoop before EA") \
53 flags(AFTER_EA, "After Escape Analysis") \
54 flags(ITER_GVN_AFTER_EA, "Iter GVN after EA") \
55 flags(BEFORE_BEAUTIFY_LOOPS, "Before Beautify Loops") \
56 flags(AFTER_BEAUTIFY_LOOPS, "After Beautify Loops") \
57 flags(BEFORE_CLOOPS, "Before CountedLoop") \
58 flags(AFTER_CLOOPS, "After CountedLoop") \
59 flags(BEFORE_SPLIT_IF, "Before Split-If") \
60 flags(AFTER_SPLIT_IF, "After Split-If") \
61 flags(BEFORE_LOOP_PREDICATION_IC, "Before Loop Predication IC") \
62 flags(AFTER_LOOP_PREDICATION_IC, "After Loop Predication IC") \
63 flags(BEFORE_LOOP_PREDICATION_RC, "Before Loop Predication RC") \
64 flags(AFTER_LOOP_PREDICATION_RC, "After Loop Predication RC") \
65 flags(BEFORE_PARTIAL_PEELING, "Before Partial Peeling") \
66 flags(AFTER_PARTIAL_PEELING, "After Partial Peeling") \
67 flags(BEFORE_LOOP_PEELING, "Before Loop Peeling") \
68 flags(AFTER_LOOP_PEELING, "After Loop Peeling") \
69 flags(BEFORE_LOOP_UNSWITCHING, "Before Loop Unswitching") \
70 flags(AFTER_LOOP_UNSWITCHING, "After Loop Unswitching") \
71 flags(BEFORE_LOOP_MULTIVERSIONING, "Before Loop Multiversioning") \
72 flags(AFTER_LOOP_MULTIVERSIONING, "After Loop Multiversioning") \
73 flags(BEFORE_RANGE_CHECK_ELIMINATION, "Before Range Check Elimination") \
74 flags(AFTER_RANGE_CHECK_ELIMINATION, "After Range Check Elimination") \
75 flags(ITER_GVN_AFTER_ELIMINATION, "Iter GVN after Eliminating Allocations and Locks") \
76 flags(BEFORE_PRE_MAIN_POST, "Before Pre/Main/Post Loops") \
77 flags(AFTER_PRE_MAIN_POST, "After Pre/Main/Post Loops") \
78 flags(BEFORE_POST_LOOP, "Before Post Loop") \
79 flags(AFTER_POST_LOOP, "After Post Loop") \
80 flags(BEFORE_REMOVE_EMPTY_LOOP, "Before Remove Empty Loop") \
81 flags(AFTER_REMOVE_EMPTY_LOOP, "After Remove Empty Loop") \
82 flags(BEFORE_ONE_ITERATION_LOOP, "Before Replace One-Iteration Loop") \
83 flags(AFTER_ONE_ITERATION_LOOP, "After Replace One-Iteration Loop") \
84 flags(BEFORE_DUPLICATE_LOOP_BACKEDGE, "Before Duplicate Loop Backedge") \
85 flags(AFTER_DUPLICATE_LOOP_BACKEDGE, "After Duplicate Loop Backedge") \
86 flags(BEFORE_LOOP_UNROLLING, "Before Loop Unrolling") \
87 flags(AFTER_LOOP_UNROLLING, "After Loop Unrolling") \
88 flags(PHASEIDEALLOOP1, "PhaseIdealLoop 1") \
89 flags(PHASEIDEALLOOP2, "PhaseIdealLoop 2") \
90 flags(PHASEIDEALLOOP3, "PhaseIdealLoop 3") \
91 flags(AUTO_VECTORIZATION1_BEFORE_APPLY, "AutoVectorization 1, before Apply") \
92 flags(AUTO_VECTORIZATION2_AFTER_REORDER, "AutoVectorization 2, after Apply Memop Reordering") \
93 flags(AUTO_VECTORIZATION3_AFTER_ADJUST_LIMIT, "AutoVectorization 3, after Adjusting Pre-loop Limit") \
94 flags(AUTO_VECTORIZATION4_AFTER_SPECULATIVE_RUNTIME_CHECKS, "AutoVectorization 4, after Adding Speculative Runtime Checks") \
95 flags(AUTO_VECTORIZATION5_AFTER_APPLY, "AutoVectorization 5, after Apply") \
96 flags(BEFORE_CCP1, "Before PhaseCCP 1") \
97 flags(CCP1, "PhaseCCP 1") \
98 flags(ITER_GVN2, "Iter GVN 2") \
99 flags(PHASEIDEALLOOP_ITERATIONS, "PhaseIdealLoop iterations") \
100 flags(AFTER_LOOP_OPTS, "After Loop Optimizations") \
101 flags(AFTER_MERGE_STORES, "After Merge Stores") \
102 flags(AFTER_MACRO_ELIMINATION_STEP, "After Macro Elimination Step") \
103 flags(AFTER_MACRO_ELIMINATION, "After Macro Elimination") \
104 flags(BEFORE_MACRO_EXPANSION , "Before Macro Expansion") \
105 flags(AFTER_MACRO_EXPANSION_STEP, "After Macro Expansion Step") \
106 flags(AFTER_MACRO_EXPANSION, "After Macro Expansion") \
107 flags(BARRIER_EXPANSION, "Barrier Expand") \
108 flags(OPTIMIZE_FINISHED, "Optimize Finished") \
109 flags(BEFORE_MATCHING, "Before Matching") \
110 flags(MATCHING, "After Matching") \
111 flags(GLOBAL_CODE_MOTION, "Global Code Motion") \
112 flags(INITIAL_LIVENESS, "Initial Liveness") \
113 flags(LIVE_RANGE_STRETCHING, "Live Range Stretching") \
114 flags(AGGRESSIVE_COALESCING, "Aggressive Coalescing") \
115 flags(INITIAL_SPILLING, "Initial Spilling") \
116 flags(CONSERVATIVE_COALESCING, "Conservative Coalescing") \
117 flags(ITERATIVE_SPILLING, "Iterative Spilling") \
118 flags(AFTER_ITERATIVE_SPILLING, "After Iterative Spilling") \
119 flags(POST_ALLOCATION_COPY_REMOVAL, "Post-allocation Copy Removal") \
120 flags(MERGE_MULTI_DEFS, "Merge Multiple Definitions") \
121 flags(FIX_UP_SPILLS, "Fix up Spills") \
122 flags(REGISTER_ALLOCATION, "Register Allocation") \
123 flags(BLOCK_ORDERING, "Block Ordering") \
124 flags(PEEPHOLE, "Peephole") \
125 flags(POSTALLOC_EXPAND, "Post-allocation Expand") \
126 flags(MACH_ANALYSIS, "After Mach Analysis") \
127 flags(FINAL_CODE, "Final Code") \
128 flags(END, "End") \
129 flags(FAILURE, "Failure") \
130 flags(SPLIT_INLINES_ARRAY, "Split inlines array") \
131 flags(SPLIT_INLINES_ARRAY_IGVN, "IGVN after split inlines array") \
132 flags(ALL, "All") \
133 flags(DEBUG, "Debug")
134
135 #define table_entry(name, description) PHASE_##name,
136 enum CompilerPhaseType {
137 COMPILER_PHASES(table_entry)
138 PHASE_NUM_TYPES,
139 PHASE_NONE
140 };
141 #undef table_entry
142
143 static const char* phase_descriptions[] = {
144 #define array_of_labels(name, description) description,
145 COMPILER_PHASES(array_of_labels)
146 #undef array_of_labels
147 };
148
149 static const char* phase_names[] = {
150 #define array_of_labels(name, description) #name,
151 COMPILER_PHASES(array_of_labels)
152 #undef array_of_labels
153 };
154
155 class CompilerPhaseTypeHelper {
156 public:
157 static const char* to_name(CompilerPhaseType cpt) {
158 return phase_names[cpt];
159 }
160 static const char* to_description(CompilerPhaseType cpt) {
161 return phase_descriptions[cpt];
162 }
163 };
164
165 static CompilerPhaseType find_phase(const char* str) {
166 for (int i = 0; i < PHASE_NUM_TYPES; i++) {
167 if (strcmp(phase_names[i], str) == 0) {
168 return (CompilerPhaseType)i;
169 }
170 }
171 return PHASE_NONE;
172 }
173
174 class PhaseNameValidator {
175 private:
176 CHeapBitMap _phase_name_set;
177 bool _valid;
178 char* _bad;
179
180 public:
181 PhaseNameValidator(ccstrlist option) :
182 _phase_name_set(PHASE_NUM_TYPES, mtCompiler),
183 _valid(true),
184 _bad(nullptr)
185 {
186 for (StringUtils::CommaSeparatedStringIterator iter(option); *iter != nullptr && _valid; ++iter) {
187
188 CompilerPhaseType cpt = find_phase(*iter);
189 if (PHASE_NONE == cpt) {
190 const size_t len = MIN2<size_t>(strlen(*iter), 63) + 1; // cap len to a value we know is enough for all phase descriptions
191 _bad = NEW_C_HEAP_ARRAY(char, len, mtCompiler);
192 // strncpy always writes len characters. If the source string is shorter, the function fills the remaining bytes with nulls.
193 strncpy(_bad, *iter, len);
194 _valid = false;
195 } else if (PHASE_ALL == cpt) {
196 _phase_name_set.set_range(0, PHASE_NUM_TYPES);
197 } else {
198 assert(cpt < PHASE_NUM_TYPES, "out of bounds");
199 _phase_name_set.set_bit(cpt);
200 }
201 }
202 }
203
204 ~PhaseNameValidator() {
205 if (_bad != nullptr) {
206 FREE_C_HEAP_ARRAY(char, _bad);
207 }
208 }
209
210 const BitMap& phase_name_set() const {
211 assert(is_valid(), "Use of invalid phase name set");
212 return _phase_name_set;
213 }
214
215 bool is_valid() const {
216 return _valid;
217 }
218
219 const char* what() const {
220 return _bad;
221 }
222 };
223
224 #endif // SHARE_OPTO_PHASETYPE_HPP