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