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