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