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