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