1 /*
2 * Copyright (c) 1999, 2019, 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_C1_C1_COMPILATION_HPP
26 #define SHARE_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 class CFGPrinterOutput;
55 typedef LIR_OprDesc* LIR_Opr;
56
57 typedef GrowableArray<BasicType> BasicTypeArray;
58 typedef GrowableArray<BasicType> BasicTypeList;
59 typedef GrowableArray<ExceptionInfo*> ExceptionInfoList;
60
61 class Compilation: public StackObj {
62 friend class CompilationResourceObj;
63 private:
64 // compilation specifics
65 Arena* _arena;
66 int _next_id;
67 int _next_block_id;
68 AbstractCompiler* _compiler;
69 DirectiveSet* _directive;
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 bool _has_reserved_stack_access;
84 bool _install_code;
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 CFGPrinterOutput* _cfg_printer_output;
119 #endif // PRODUCT
120
121 public:
122 // creation
123 Compilation(AbstractCompiler* compiler, ciEnv* env, ciMethod* method,
124 int osr_bci, BufferBlob* buffer_blob, bool install_code, 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 bool should_install_code() { return _install_code && InstallMethods; }
153
154 // Instruction ids
155 int get_next_id() { return _next_id++; }
156 int number_of_instructions() const { return _next_id; }
157
158 // BlockBegin ids
159 int get_next_block_id() { return _next_block_id++; }
160 int number_of_blocks() const { return _next_block_id; }
161
162 // setters
163 void set_has_exception_handlers(bool f) { _has_exception_handlers = f; }
164 void set_has_fpu_code(bool f) { _has_fpu_code = f; }
165 void set_has_unsafe_access(bool f) { _has_unsafe_access = f; }
166 void set_would_profile(bool f) { _would_profile = f; }
167 void set_has_access_indexed(bool f) { _has_access_indexed = f; }
168 // Add a set of exception handlers covering the given PC offset
169 void add_exception_handlers_for_pco(int pco, XHandlers* exception_handlers);
170 // Statistics gathering
171 void notice_inlined_method(ciMethod* method);
172
173 // JSR 292
174 bool has_method_handle_invokes() const { return _has_method_handle_invokes; }
175 void set_has_method_handle_invokes(bool z) { _has_method_handle_invokes = z; }
176
177 bool has_reserved_stack_access() const { return _has_reserved_stack_access; }
178 void set_has_reserved_stack_access(bool z) { _has_reserved_stack_access = z; }
179
180 DebugInformationRecorder* debug_info_recorder() const; // = _env->debug_info();
181 Dependencies* dependency_recorder() const; // = _env->dependencies()
182 ImplicitExceptionTable* implicit_exception_table() { return &_implicit_exception_table; }
183
184 Instruction* current_instruction() const { return _current_instruction; }
185 Instruction* set_current_instruction(Instruction* instr) {
186 Instruction* previous = _current_instruction;
187 _current_instruction = instr;
188 return previous;
189 }
190
191 #ifndef PRODUCT
192 void maybe_print_current_instruction();
193 CFGPrinterOutput* cfg_printer_output() {
194 guarantee(_cfg_printer_output != NULL, "CFG printer output not initialized");
195 return _cfg_printer_output;
196 }
197 #endif // PRODUCT
198
199 // error handling
200 void bailout(const char* msg);
201 bool bailed_out() const { return _bailout_msg != NULL; }
202 const char* bailout_msg() const { return _bailout_msg; }
203
204 static int desired_max_code_buffer_size() {
205 return (int)NMethodSizeLimit; // default 64K
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 // BAILOUT check with reset of bound labels
302 #define CHECK_BAILOUT1(l1) { if (bailed_out()) { l1.reset(); return; } }
303 #define CHECK_BAILOUT2(l1, l2) { if (bailed_out()) { l1.reset(); l2.reset(); return; } }
304 #define CHECK_BAILOUT3(l1, l2, l3) { if (bailed_out()) { l1.reset(); l2.reset(); l3.reset(); return; } }
305
306
307 class InstructionMark: public StackObj {
308 private:
309 Compilation* _compilation;
310 Instruction* _previous;
311
312 public:
313 InstructionMark(Compilation* compilation, Instruction* instr) {
314 _compilation = compilation;
315 _previous = _compilation->set_current_instruction(instr);
316 }
317 ~InstructionMark() {
318 _compilation->set_current_instruction(_previous);
319 }
320 };
321
322
323 //----------------------------------------------------------------------
324 // Base class for objects allocated by the compiler in the compilation arena
325 class CompilationResourceObj ALLOCATION_SUPER_CLASS_SPEC {
326 public:
327 void* operator new(size_t size) throw() { return Compilation::current()->arena()->Amalloc(size); }
328 void* operator new(size_t size, Arena* arena) throw() {
329 return arena->Amalloc(size);
330 }
331 void operator delete(void* p) {} // nothing to do
332 };
333
334
335 //----------------------------------------------------------------------
336 // Class for aggregating exception handler information.
337
338 // Effectively extends XHandlers class with PC offset of
339 // potentially exception-throwing instruction.
340 // This class is used at the end of the compilation to build the
341 // ExceptionHandlerTable.
342 class ExceptionInfo: public CompilationResourceObj {
343 private:
344 int _pco; // PC of potentially exception-throwing instruction
345 XHandlers* _exception_handlers; // flat list of exception handlers covering this PC
346
347 public:
348 ExceptionInfo(int pco, XHandlers* exception_handlers)
349 : _pco(pco)
350 , _exception_handlers(exception_handlers)
351 { }
352
353 int pco() { return _pco; }
354 XHandlers* exception_handlers() { return _exception_handlers; }
355 };
356
357 #endif // SHARE_C1_C1_COMPILATION_HPP