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_method_handle_invokes; // True if this method has MethodHandle invokes.
83 bool _has_reserved_stack_access;
84 bool _has_monitors; // Fastpath monitors detection for Continuations
85 bool _has_scoped_access; // For shared scope closure
86 bool _install_code;
87 const char* _bailout_msg;
88 CompilationFailureInfo* _first_failure_details; // Details for the first failure happening during compilation
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 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_scoped_access() const { return _has_scoped_access; }
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 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 void set_has_scoped_access(bool f) { _has_scoped_access = 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 const CompilationFailureInfo* first_failure_details() const { return _first_failure_details; }
218
219 static uint desired_max_code_buffer_size() {
220 return (uint)NMethodSizeLimit; // default 64K
221 }
222 static uint desired_max_constant_size() {
223 return desired_max_code_buffer_size() / 10;
224 }
225
226 static bool setup_code_buffer(CodeBuffer* cb, int call_stub_estimate);
227
228 // timers
229 static void print_timers();
230
231 bool is_profiling() {
232 return env()->comp_level() == CompLevel_full_profile ||
233 env()->comp_level() == CompLevel_limited_profile;
234 }
235
236 // Helpers for generation of profile information
237 bool profile_branches() {
238 return env()->comp_level() == CompLevel_full_profile &&
239 C1UpdateMethodData && C1ProfileBranches;
240 }
241 bool profile_calls() {
242 return env()->comp_level() == CompLevel_full_profile &&
243 C1UpdateMethodData && C1ProfileCalls;
244 }
245 bool profile_inlined_calls() {
246 return profile_calls() && C1ProfileInlinedCalls;
247 }
248 bool profile_checkcasts() {
249 return env()->comp_level() == CompLevel_full_profile &&
250 C1UpdateMethodData && C1ProfileCheckcasts;
251 }
252 bool profile_parameters() {
253 return env()->comp_level() == CompLevel_full_profile &&
254 C1UpdateMethodData && MethodData::profile_parameters();
255 }
256 bool profile_arguments() {
257 return env()->comp_level() == CompLevel_full_profile &&
258 C1UpdateMethodData && MethodData::profile_arguments();
259 }
260 bool profile_return() {
261 return env()->comp_level() == CompLevel_full_profile &&
262 C1UpdateMethodData && MethodData::profile_return();
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() {
268 return CompilerConfig::is_c1_only_no_jvmci() && !is_profiling() &&
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 {
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 #ifndef PRODUCT
334 // Printing support
335 void print() const;
336 virtual void print_on(outputStream* st) const;
337 #endif
338 };
339
340
341 //----------------------------------------------------------------------
342 // Class for aggregating exception handler information.
343
344 // Effectively extends XHandlers class with PC offset of
345 // potentially exception-throwing instruction.
346 // This class is used at the end of the compilation to build the
347 // ExceptionHandlerTable.
348 class ExceptionInfo: public CompilationResourceObj {
349 private:
350 int _pco; // PC of potentially exception-throwing instruction
351 XHandlers* _exception_handlers; // flat list of exception handlers covering this PC
352
353 public:
354 ExceptionInfo(int pco, XHandlers* exception_handlers)
355 : _pco(pco)
356 , _exception_handlers(exception_handlers)
357 { }
358
359 int pco() { return _pco; }
360 XHandlers* exception_handlers() { return _exception_handlers; }
361 };
362
363 #endif // SHARE_C1_C1_COMPILATION_HPP