1 /*
2 * Copyright (c) 2012, 2023, 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
30 #define COMPILER_PHASES(flags) \
31 flags(BEFORE_STRINGOPTS, "Before StringOpts") \
32 flags(AFTER_STRINGOPTS, "After StringOpts") \
33 flags(BEFORE_REMOVEUSELESS, "Before RemoveUseless") \
34 flags(AFTER_PARSING, "After Parsing") \
35 flags(BEFORE_ITER_GVN, "Before Iter GVN") \
36 flags(ITER_GVN1, "Iter GVN 1") \
37 flags(AFTER_ITER_GVN_STEP, "After Iter GVN Step") \
38 flags(AFTER_ITER_GVN, "After Iter GVN") \
39 flags(INCREMENTAL_INLINE_STEP, "Incremental Inline Step") \
40 flags(INCREMENTAL_INLINE_CLEANUP, "Incremental Inline Cleanup") \
41 flags(INCREMENTAL_INLINE, "Incremental Inline") \
42 flags(INCREMENTAL_BOXING_INLINE, "Incremental Boxing Inline") \
43 flags(EXPAND_VUNBOX, "Expand VectorUnbox") \
44 flags(SCALARIZE_VBOX, "Scalarize VectorBox") \
45 flags(INLINE_VECTOR_REBOX, "Inline Vector Rebox Calls") \
46 flags(EXPAND_VBOX, "Expand VectorBox") \
47 flags(ELIMINATE_VBOX_ALLOC, "Eliminate VectorBoxAllocate") \
48 flags(ITER_GVN_BEFORE_EA, "Iter GVN before EA") \
49 flags(ITER_GVN_AFTER_VECTOR, "Iter GVN after vector box elimination") \
50 flags(BEFORE_BEAUTIFY_LOOPS, "Before beautify loops") \
51 flags(AFTER_BEAUTIFY_LOOPS, "After beautify loops") \
52 flags(BEFORE_CLOOPS, "Before CountedLoop") \
53 flags(AFTER_CLOOPS, "After CountedLoop") \
54 flags(PHASEIDEAL_BEFORE_EA, "PhaseIdealLoop before EA") \
55 flags(AFTER_EA, "After Escape Analysis") \
56 flags(ITER_GVN_AFTER_EA, "Iter GVN after EA") \
57 flags(ITER_GVN_AFTER_ELIMINATION, "Iter GVN after eliminating allocations and locks") \
58 flags(PHASEIDEALLOOP1, "PhaseIdealLoop 1") \
59 flags(PHASEIDEALLOOP2, "PhaseIdealLoop 2") \
60 flags(PHASEIDEALLOOP3, "PhaseIdealLoop 3") \
61 flags(CCP1, "PhaseCCP 1") \
62 flags(ITER_GVN2, "Iter GVN 2") \
63 flags(PHASEIDEALLOOP_ITERATIONS, "PhaseIdealLoop iterations") \
64 flags(MACRO_EXPANSION, "Macro expand") \
65 flags(BARRIER_EXPANSION, "Barrier expand") \
66 flags(OPTIMIZE_FINISHED, "Optimize finished") \
67 flags(BEFORE_MATCHING, "Before matching") \
68 flags(MATCHING, "After matching") \
69 flags(GLOBAL_CODE_MOTION, "Global code motion") \
70 flags(MACH_ANALYSIS, "After mach analysis") \
71 flags(FINAL_CODE, "Final Code") \
72 flags(END, "End") \
73 flags(FAILURE, "Failure") \
74 flags(ALL, "All") \
75 flags(DEBUG, "Debug")
76
77 #define table_entry(name, description) PHASE_##name,
78 enum CompilerPhaseType {
79 COMPILER_PHASES(table_entry)
80 PHASE_NUM_TYPES,
81 PHASE_NONE
82 };
83 #undef table_entry
84
85 static const char* phase_descriptions[] = {
86 #define array_of_labels(name, description) description,
87 COMPILER_PHASES(array_of_labels)
88 #undef array_of_labels
89 };
90
91 static const char* phase_names[] = {
92 #define array_of_labels(name, description) #name,
93 COMPILER_PHASES(array_of_labels)
94 #undef array_of_labels
95 };
96
97 class CompilerPhaseTypeHelper {
98 public:
99 static const char* to_name(CompilerPhaseType cpt) {
100 return phase_names[cpt];
101 }
102 static const char* to_description(CompilerPhaseType cpt) {
103 return phase_descriptions[cpt];
104 }
105 };
106
107 static CompilerPhaseType find_phase(const char* str) {
108 for (int i = 0; i < PHASE_NUM_TYPES; i++) {
109 if (strcmp(phase_names[i], str) == 0) {
110 return (CompilerPhaseType)i;
111 }
112 }
113 return PHASE_NONE;
114 }
115
116 class PhaseNameIter {
117 private:
118 char* _token;
119 char* _saved_ptr;
120 char* _list;
121
122 public:
123 PhaseNameIter(ccstrlist option) {
124 _list = (char*) canonicalize(option);
125 _saved_ptr = _list;
126 _token = strtok_r(_saved_ptr, ",", &_saved_ptr);
127 }
128
129 ~PhaseNameIter() {
130 FREE_C_HEAP_ARRAY(char, _list);
131 }
132
133 const char* operator*() const { return _token; }
134
135 PhaseNameIter& operator++() {
136 _token = strtok_r(nullptr, ",", &_saved_ptr);
137 return *this;
138 }
139
140 ccstrlist canonicalize(ccstrlist option_value) {
141 char* canonicalized_list = NEW_C_HEAP_ARRAY(char, strlen(option_value) + 1, mtCompiler);
142 int i = 0;
143 char current;
144 while ((current = option_value[i]) != '\0') {
145 if (current == '\n' || current == ' ') {
146 canonicalized_list[i] = ',';
147 } else {
148 canonicalized_list[i] = current;
149 }
150 i++;
151 }
152 canonicalized_list[i] = '\0';
153 return canonicalized_list;
154 }
155 };
156
157 class PhaseNameValidator {
158 private:
159 CHeapBitMap _phase_name_set;
160 bool _valid;
161 char* _bad;
162
163 public:
164 PhaseNameValidator(ccstrlist option) :
165 _phase_name_set(PHASE_NUM_TYPES, mtCompiler),
166 _valid(true),
167 _bad(nullptr)
168 {
169 for (PhaseNameIter iter(option); *iter != nullptr && _valid; ++iter) {
170
171 CompilerPhaseType cpt = find_phase(*iter);
172 if (PHASE_NONE == cpt) {
173 const size_t len = MIN2<size_t>(strlen(*iter), 63) + 1; // cap len to a value we know is enough for all phase descriptions
174 _bad = NEW_C_HEAP_ARRAY(char, len, mtCompiler);
175 // strncpy always writes len characters. If the source string is shorter, the function fills the remaining bytes with nulls.
176 strncpy(_bad, *iter, len);
177 _valid = false;
178 } else if (PHASE_ALL == cpt) {
179 _phase_name_set.set_range(0, PHASE_NUM_TYPES);
180 } else {
181 assert(cpt < PHASE_NUM_TYPES, "out of bounds");
182 _phase_name_set.set_bit(cpt);
183 }
184 }
185 }
186
187 ~PhaseNameValidator() {
188 if (_bad != nullptr) {
189 FREE_C_HEAP_ARRAY(char, _bad);
190 }
191 }
192
193 const BitMap& phase_name_set() const {
194 assert(is_valid(), "Use of invalid phase name set");
195 return _phase_name_set;
196 }
197
198 bool is_valid() const {
199 return _valid;
200 }
201
202 const char* what() const {
203 return _bad;
204 }
205 };
206
207 #endif // SHARE_OPTO_PHASETYPE_HPP