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