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