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 exception_info_list() const107 ExceptionInfoList* exception_info_list() const { return _exception_info_list; } exception_handler_table()108 ExceptionHandlerTable* exception_handler_table() { return &_exception_handler_table; } 109 allocator()110 LinearScan* allocator() { return _allocator; } set_allocator(LinearScan * 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 current()125 static Compilation* current() { 126 return (Compilation*) ciEnv::current()->compiler_data(); 127 } 128 129 // accessors env() const130 ciEnv* env() const { return _env; } log() const131 CompileLog* log() const { return _log; } compiler() const132 AbstractCompiler* compiler() const { return _compiler; } has_exception_handlers() const133 bool has_exception_handlers() const { return _has_exception_handlers; } has_fpu_code() const134 bool has_fpu_code() const { return _has_fpu_code; } has_unsafe_access() const135 bool has_unsafe_access() const { return _has_unsafe_access; } max_vector_size() const136 int max_vector_size() const { return 0; } method() const137 ciMethod* method() const { return _method; } osr_bci() const138 int osr_bci() const { return _osr_bci; } is_osr_compile() const139 bool is_osr_compile() const { return osr_bci() >= 0; } hir() const140 IR* hir() const { return _hir; } max_spills() const141 int max_spills() const { return _max_spills; } frame_map() const142 FrameMap* frame_map() const { return _frame_map; } code()143 CodeBuffer* code() { return &_code; } masm() const144 C1_MacroAssembler* masm() const { return _masm; } offsets()145 CodeOffsets* offsets() { return &_offsets; } arena()146 Arena* arena() { return _arena; } has_access_indexed()147 bool has_access_indexed() { return _has_access_indexed; } 148 149 // Instruction ids get_next_id()150 int get_next_id() { return _next_id++; } number_of_instructions() const151 int number_of_instructions() const { return _next_id; } 152 153 // BlockBegin ids get_next_block_id()154 int get_next_block_id() { return _next_block_id++; } number_of_blocks() const155 int number_of_blocks() const { return _next_block_id; } 156 157 // setters set_has_exception_handlers(bool f)158 void set_has_exception_handlers(bool f) { _has_exception_handlers = f; } set_has_fpu_code(bool f)159 void set_has_fpu_code(bool f) { _has_fpu_code = f; } set_has_unsafe_access(bool f)160 void set_has_unsafe_access(bool f) { _has_unsafe_access = f; } set_would_profile(bool f)161 void set_would_profile(bool f) { _would_profile = f; } set_has_access_indexed(bool 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 has_method_handle_invokes() const169 bool has_method_handle_invokes() const { return _has_method_handle_invokes; } set_has_method_handle_invokes(bool z)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() implicit_exception_table()174 ImplicitExceptionTable* implicit_exception_table() { return &_implicit_exception_table; } 175 current_instruction() const176 Instruction* current_instruction() const { return _current_instruction; } set_current_instruction(Instruction * instr)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); bailed_out() const189 bool bailed_out() const { return _bailout_msg != NULL; } bailout_msg() const190 const char* bailout_msg() const { return _bailout_msg; } 191 desired_max_code_buffer_size()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 } desired_max_constant_size()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 is_profiling()219 bool is_profiling() { 220 return env()->comp_level() == CompLevel_full_profile || 221 env()->comp_level() == CompLevel_limited_profile; 222 } count_invocations()223 bool count_invocations() { return is_profiling(); } count_backedges()224 bool count_backedges() { return is_profiling(); } 225 226 // Helpers for generation of profile information profile_branches()227 bool profile_branches() { 228 return env()->comp_level() == CompLevel_full_profile && 229 C1UpdateMethodData && C1ProfileBranches; 230 } profile_calls()231 bool profile_calls() { 232 return env()->comp_level() == CompLevel_full_profile && 233 C1UpdateMethodData && C1ProfileCalls; 234 } profile_inlined_calls()235 bool profile_inlined_calls() { 236 return profile_calls() && C1ProfileInlinedCalls; 237 } profile_checkcasts()238 bool profile_checkcasts() { 239 return env()->comp_level() == CompLevel_full_profile && 240 C1UpdateMethodData && C1ProfileCheckcasts; 241 } profile_parameters()242 bool profile_parameters() { 243 return env()->comp_level() == CompLevel_full_profile && 244 C1UpdateMethodData && MethodData::profile_parameters(); 245 } profile_arguments()246 bool profile_arguments() { 247 return env()->comp_level() == CompLevel_full_profile && 248 C1UpdateMethodData && MethodData::profile_arguments(); 249 } profile_return()250 bool profile_return() { 251 return env()->comp_level() == CompLevel_full_profile && 252 C1UpdateMethodData && MethodData::profile_return(); 253 } 254 // will compilation make optimistic assumptions that might lead to 255 // deoptimization and that the runtime will account for? is_optimistic() const256 bool is_optimistic() const { 257 return !TieredCompilation && 258 (RangeCheckElimination || UseLoopInvariantCodeMotion) && 259 method()->method_data()->trap_count(Deoptimization::Reason_none) == 0; 260 } 261 262 ciKlass* cha_exact_type(ciType* type); 263 264 // Dump inlining replay data to the stream. dump_inline_data(outputStream * out)265 void dump_inline_data(outputStream* out) { /* do nothing now */ } 266 267 // How much stack space would the interpreter need in case of a 268 // deoptimization (worst case) update_interpreter_frame_size(int size)269 void update_interpreter_frame_size(int size) { 270 if (_interpreter_frame_size < size) { 271 _interpreter_frame_size = size; 272 } 273 } 274 interpreter_frame_size() const275 int interpreter_frame_size() const { 276 return _interpreter_frame_size; 277 } 278 }; 279 280 281 // Macro definitions for unified bailout-support 282 // The methods bailout() and bailed_out() are present in all classes 283 // that might bailout, but forward all calls to Compilation 284 #define BAILOUT(msg) { bailout(msg); return; } 285 #define BAILOUT_(msg, res) { bailout(msg); return res; } 286 287 #define CHECK_BAILOUT() { if (bailed_out()) return; } 288 #define CHECK_BAILOUT_(res) { if (bailed_out()) return res; } 289 290 291 class InstructionMark: public StackObj { 292 private: 293 Compilation* _compilation; 294 Instruction* _previous; 295 296 public: InstructionMark(Compilation * compilation,Instruction * instr)297 InstructionMark(Compilation* compilation, Instruction* instr) { 298 _compilation = compilation; 299 _previous = _compilation->set_current_instruction(instr); 300 } ~InstructionMark()301 ~InstructionMark() { 302 _compilation->set_current_instruction(_previous); 303 } 304 }; 305 306 307 //---------------------------------------------------------------------- 308 // Base class for objects allocated by the compiler in the compilation arena 309 class CompilationResourceObj ALLOCATION_SUPER_CLASS_SPEC { 310 public: operator new(size_t size)311 void* operator new(size_t size) throw() { return Compilation::current()->arena()->Amalloc(size); } operator new(size_t size,Arena * arena)312 void* operator new(size_t size, Arena* arena) throw() { 313 return arena->Amalloc(size); 314 } operator delete(void * p)315 void operator delete(void* p) {} // nothing to do 316 }; 317 318 319 //---------------------------------------------------------------------- 320 // Class for aggregating exception handler information. 321 322 // Effectively extends XHandlers class with PC offset of 323 // potentially exception-throwing instruction. 324 // This class is used at the end of the compilation to build the 325 // ExceptionHandlerTable. 326 class ExceptionInfo: public CompilationResourceObj { 327 private: 328 int _pco; // PC of potentially exception-throwing instruction 329 XHandlers* _exception_handlers; // flat list of exception handlers covering this PC 330 331 public: ExceptionInfo(int pco,XHandlers * exception_handlers)332 ExceptionInfo(int pco, XHandlers* exception_handlers) 333 : _pco(pco) 334 , _exception_handlers(exception_handlers) 335 { } 336 pco()337 int pco() { return _pco; } exception_handlers()338 XHandlers* exception_handlers() { return _exception_handlers; } 339 }; 340 341 #endif // SHARE_VM_C1_C1_COMPILATION_HPP 342