1 /* 2 * Copyright (c) 1999, 2013, 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_VM_C1_C1_COMPILATION_HPP 26 #define SHARE_VM_C1_C1_COMPILATION_HPP 27 28 #include "ci/ciEnv.hpp" 29 #include "ci/ciMethodData.hpp" 30 #include "code/exceptionHandlerTable.hpp" 31 #include "memory/resourceArea.hpp" 32 #include "runtime/deoptimization.hpp" 33 34 class CompilationResourceObj; 35 class XHandlers; 36 class ExceptionInfo; 37 class DebugInformationRecorder; 38 class FrameMap; 39 class IR; 40 class IRScope; 41 class Instruction; 42 class LinearScan; 43 class OopMap; 44 class LIR_Emitter; 45 class LIR_Assembler; 46 class CodeEmitInfo; 47 class ciEnv; 48 class ciMethod; 49 class ValueStack; 50 class LIR_OprDesc; 51 class C1_MacroAssembler; 52 class CFGPrinter; 53 typedef LIR_OprDesc* LIR_Opr; 54 55 56 define_array(BasicTypeArray, BasicType) 57 define_stack(BasicTypeList, BasicTypeArray) 58 59 define_array(ExceptionInfoArray, ExceptionInfo*) 60 define_stack(ExceptionInfoList, ExceptionInfoArray) 61 62 class Compilation: public StackObj { 63 friend class CompilationResourceObj; 64 private: 65 // compilation specifics 66 Arena* _arena; 67 int _next_id; 68 int _next_block_id; 69 AbstractCompiler* _compiler; 70 ciEnv* _env; 71 CompileLog* _log; 72 ciMethod* _method; 73 int _osr_bci; 74 IR* _hir; 75 int _max_spills; 76 FrameMap* _frame_map; 77 C1_MacroAssembler* _masm; 78 bool _has_exception_handlers; 79 bool _has_fpu_code; 80 bool _has_unsafe_access; 81 bool _would_profile; 82 bool _has_method_handle_invokes; // True if this method has MethodHandle invokes. 83 const char* _bailout_msg; 84 ExceptionInfoList* _exception_info_list; 85 ExceptionHandlerTable _exception_handler_table; 86 ImplicitExceptionTable _implicit_exception_table; 87 LinearScan* _allocator; 88 CodeOffsets _offsets; 89 CodeBuffer _code; 90 bool _has_access_indexed; 91 int _interpreter_frame_size; // Stack space needed in case of a deoptimization 92 93 // compilation helpers 94 void initialize(); 95 void build_hir(); 96 void emit_lir(); 97 98 void emit_code_epilog(LIR_Assembler* assembler); 99 int emit_code_body(); 100 101 int compile_java_method(); 102 void install_code(int frame_size); 103 void compile_method(); 104 105 void generate_exception_handler_table(); 106 107 ExceptionInfoList* exception_info_list() const { return _exception_info_list; } 108 ExceptionHandlerTable* exception_handler_table() { return &_exception_handler_table; } 109 110 LinearScan* allocator() { return _allocator; } 111 void set_allocator(LinearScan* allocator) { _allocator = allocator; } 112 113 Instruction* _current_instruction; // the instruction currently being processed 114 #ifndef PRODUCT 115 Instruction* _last_instruction_printed; // the last instruction printed during traversal 116 #endif // PRODUCT 117 118 public: 119 // creation 120 Compilation(AbstractCompiler* compiler, ciEnv* env, ciMethod* method, 121 int osr_bci, BufferBlob* buffer_blob); 122 ~Compilation(); 123 124 125 static Compilation* current() { 126 return (Compilation*) ciEnv::current()->compiler_data(); 127 } 128 129 // accessors 130 ciEnv* env() const { return _env; } 131 CompileLog* log() const { return _log; } 132 AbstractCompiler* compiler() const { return _compiler; } 133 bool has_exception_handlers() const { return _has_exception_handlers; } 134 bool has_fpu_code() const { return _has_fpu_code; } 135 bool has_unsafe_access() const { return _has_unsafe_access; } 136 int max_vector_size() const { return 0; } 137 ciMethod* method() const { return _method; } 138 int osr_bci() const { return _osr_bci; } 139 bool is_osr_compile() const { return osr_bci() >= 0; } 140 IR* hir() const { return _hir; } 141 int max_spills() const { return _max_spills; } 142 FrameMap* frame_map() const { return _frame_map; } 143 CodeBuffer* code() { return &_code; } 144 C1_MacroAssembler* masm() const { return _masm; } 145 CodeOffsets* offsets() { return &_offsets; } 146 Arena* arena() { return _arena; } 147 bool has_access_indexed() { return _has_access_indexed; } 148 149 // Instruction ids 150 int get_next_id() { return _next_id++; } 151 int number_of_instructions() const { return _next_id; } 152 153 // BlockBegin ids 154 int get_next_block_id() { return _next_block_id++; } 155 int number_of_blocks() const { return _next_block_id; } 156 157 // setters 158 void set_has_exception_handlers(bool f) { _has_exception_handlers = f; } 159 void set_has_fpu_code(bool f) { _has_fpu_code = f; } 160 void set_has_unsafe_access(bool f) { _has_unsafe_access = f; } 161 void set_would_profile(bool f) { _would_profile = f; } 162 void set_has_access_indexed(bool f) { _has_access_indexed = f; } 163 // Add a set of exception handlers covering the given PC offset 164 void add_exception_handlers_for_pco(int pco, XHandlers* exception_handlers); 165 // Statistics gathering 166 void notice_inlined_method(ciMethod* method); 167 168 // JSR 292 169 bool has_method_handle_invokes() const { return _has_method_handle_invokes; } 170 void set_has_method_handle_invokes(bool z) { _has_method_handle_invokes = z; } 171 172 DebugInformationRecorder* debug_info_recorder() const; // = _env->debug_info(); 173 Dependencies* dependency_recorder() const; // = _env->dependencies() 174 ImplicitExceptionTable* implicit_exception_table() { return &_implicit_exception_table; } 175 176 Instruction* current_instruction() const { return _current_instruction; } 177 Instruction* set_current_instruction(Instruction* instr) { 178 Instruction* previous = _current_instruction; 179 _current_instruction = instr; 180 return previous; 181 } 182 183 #ifndef PRODUCT 184 void maybe_print_current_instruction(); 185 #endif // PRODUCT 186 187 // error handling 188 void bailout(const char* msg); 189 bool bailed_out() const { return _bailout_msg != NULL; } 190 const char* bailout_msg() const { return _bailout_msg; } 191 192 static int desired_max_code_buffer_size() { 193 #ifndef PPC 194 return (int) NMethodSizeLimit; // default 256K or 512K 195 #else 196 // conditional branches on PPC are restricted to 16 bit signed 197 return MIN2((unsigned int)NMethodSizeLimit,32*K); 198 #endif 199 } 200 static int desired_max_constant_size() { 201 return desired_max_code_buffer_size() / 10; 202 } 203 204 static bool setup_code_buffer(CodeBuffer* cb, int call_stub_estimate); 205 206 // timers 207 static void print_timers(); 208 209 #ifndef PRODUCT 210 // debugging support. 211 // produces a file named c1compileonly in the current directory with 212 // directives to compile only the current method and it's inlines. 213 // The file can be passed to the command line option -XX:Flags=<filename> 214 void compile_only_this_method(); 215 void compile_only_this_scope(outputStream* st, IRScope* scope); 216 void exclude_this_method(); 217 #endif // PRODUCT 218 219 bool is_profiling() { 220 return env()->comp_level() == CompLevel_full_profile || 221 env()->comp_level() == CompLevel_limited_profile; 222 } 223 bool count_invocations() { return is_profiling(); } 224 bool count_backedges() { return is_profiling(); } 225 226 // Helpers for generation of profile information 227 bool profile_branches() { 228 return env()->comp_level() == CompLevel_full_profile && 229 C1UpdateMethodData && C1ProfileBranches; 230 } 231 bool profile_calls() { 232 return env()->comp_level() == CompLevel_full_profile && 233 C1UpdateMethodData && C1ProfileCalls; 234 } 235 bool profile_inlined_calls() { 236 return profile_calls() && C1ProfileInlinedCalls; 237 } 238 bool profile_checkcasts() { 239 return env()->comp_level() == CompLevel_full_profile && 240 C1UpdateMethodData && C1ProfileCheckcasts; 241 } 242 bool profile_parameters() { 243 return env()->comp_level() == CompLevel_full_profile && 244 C1UpdateMethodData && MethodData::profile_parameters(); 245 } 246 bool profile_arguments() { 247 return env()->comp_level() == CompLevel_full_profile && 248 C1UpdateMethodData && MethodData::profile_arguments(); 249 } 250 bool profile_return() { 251 return env()->comp_level() == CompLevel_full_profile && 252 C1UpdateMethodData && MethodData::profile_return(); 253 } 254 bool age_code() const { 255 return _method->profile_aging(); 256 } 257 258 // will compilation make optimistic assumptions that might lead to 259 // deoptimization and that the runtime will account for? 260 bool is_optimistic() const { 261 return !TieredCompilation && 262 (RangeCheckElimination || UseLoopInvariantCodeMotion) && 263 method()->method_data()->trap_count(Deoptimization::Reason_none) == 0; 264 } 265 266 ciKlass* cha_exact_type(ciType* type); 267 268 // Dump inlining replay data to the stream. 269 void dump_inline_data(outputStream* out) { /* do nothing now */ } 270 271 // How much stack space would the interpreter need in case of a 272 // deoptimization (worst case) 273 void update_interpreter_frame_size(int size) { 274 if (_interpreter_frame_size < size) { 275 _interpreter_frame_size = size; 276 } 277 } 278 279 int interpreter_frame_size() const { 280 return _interpreter_frame_size; 281 } 282 }; 283 284 285 // Macro definitions for unified bailout-support 286 // The methods bailout() and bailed_out() are present in all classes 287 // that might bailout, but forward all calls to Compilation 288 #define BAILOUT(msg) { bailout(msg); return; } 289 #define BAILOUT_(msg, res) { bailout(msg); return res; } 290 291 #define CHECK_BAILOUT() { if (bailed_out()) return; } 292 #define CHECK_BAILOUT_(res) { if (bailed_out()) return res; } 293 294 295 class InstructionMark: public StackObj { 296 private: 297 Compilation* _compilation; 298 Instruction* _previous; 299 300 public: 301 InstructionMark(Compilation* compilation, Instruction* instr) { 302 _compilation = compilation; 303 _previous = _compilation->set_current_instruction(instr); 304 } 305 ~InstructionMark() { 306 _compilation->set_current_instruction(_previous); 307 } 308 }; 309 310 311 //---------------------------------------------------------------------- 312 // Base class for objects allocated by the compiler in the compilation arena 313 class CompilationResourceObj ALLOCATION_SUPER_CLASS_SPEC { 314 public: 315 void* operator new(size_t size) throw() { return Compilation::current()->arena()->Amalloc(size); } 316 void* operator new(size_t size, Arena* arena) throw() { 317 return arena->Amalloc(size); 318 } 319 void operator delete(void* p) {} // nothing to do 320 }; 321 322 323 //---------------------------------------------------------------------- 324 // Class for aggregating exception handler information. 325 326 // Effectively extends XHandlers class with PC offset of 327 // potentially exception-throwing instruction. 328 // This class is used at the end of the compilation to build the 329 // ExceptionHandlerTable. 330 class ExceptionInfo: public CompilationResourceObj { 331 private: 332 int _pco; // PC of potentially exception-throwing instruction 333 XHandlers* _exception_handlers; // flat list of exception handlers covering this PC 334 335 public: 336 ExceptionInfo(int pco, XHandlers* exception_handlers) 337 : _pco(pco) 338 , _exception_handlers(exception_handlers) 339 { } 340 341 int pco() { return _pco; } 342 XHandlers* exception_handlers() { return _exception_handlers; } 343 }; 344 345 #endif // SHARE_VM_C1_C1_COMPILATION_HPP