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