1 /*
2 * Copyright (c) 1999, 2024, 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
37 class CompilationFailureInfo;
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 FrameMap* _frame_map;
77 C1_MacroAssembler* _masm;
78 bool _has_exception_handlers;
79 bool _has_fpu_code;
80 bool _has_unsafe_access;
81 bool _has_irreducible_loops;
82 bool _would_profile;
83 bool _has_method_handle_invokes; // True if this method has MethodHandle invokes.
84 bool _has_reserved_stack_access;
85 bool _has_monitors; // Fastpath monitors detection for Continuations
86 bool _has_scoped_access; // For shared scope closure
87 bool _install_code;
88 const char* _bailout_msg;
89 CompilationFailureInfo* _first_failure_details; // Details for the first failure happening during compilation
90 bool _oom;
91 ExceptionInfoList* _exception_info_list;
92 ExceptionHandlerTable _exception_handler_table;
93 ImplicitExceptionTable _implicit_exception_table;
94 LinearScan* _allocator;
95 CodeOffsets _offsets;
96 CodeBuffer _code;
97 bool _has_access_indexed;
98 int _interpreter_frame_size; // Stack space needed in case of a deoptimization
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_scoped_access() const { return _has_scoped_access; }
147 bool has_irreducible_loops() const { return _has_irreducible_loops; }
148 int max_vector_size() const { return 0; }
149 ciMethod* method() const { return _method; }
150 int osr_bci() const { return _osr_bci; }
151 bool is_osr_compile() const { return osr_bci() >= 0; }
152 IR* hir() const { return _hir; }
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 void set_has_scoped_access(bool f) { _has_scoped_access = f; }
179 // Add a set of exception handlers covering the given PC offset
180 void add_exception_handlers_for_pco(int pco, XHandlers* exception_handlers);
181 // Statistics gathering
182 void notice_inlined_method(ciMethod* method);
183
184 // JSR 292
185 bool has_method_handle_invokes() const { return _has_method_handle_invokes; }
186 void set_has_method_handle_invokes(bool z) { _has_method_handle_invokes = z; }
187
188 bool has_reserved_stack_access() const { return _has_reserved_stack_access; }
189 void set_has_reserved_stack_access(bool z) { _has_reserved_stack_access = z; }
190
191 DebugInformationRecorder* debug_info_recorder() const; // = _env->debug_info();
192 Dependencies* dependency_recorder() const; // = _env->dependencies()
193 ImplicitExceptionTable* implicit_exception_table() { return &_implicit_exception_table; }
194
195 Instruction* current_instruction() const { return _current_instruction; }
196 Instruction* set_current_instruction(Instruction* instr) {
197 Instruction* previous = _current_instruction;
198 _current_instruction = instr;
199 return previous;
200 }
201
202 #ifndef PRODUCT
203 void maybe_print_current_instruction();
204 CFGPrinterOutput* cfg_printer_output() {
205 guarantee(_cfg_printer_output != nullptr, "CFG printer output not initialized");
206 return _cfg_printer_output;
207 }
208 #endif // PRODUCT
209
210 // MemLimit handling
211 bool oom() const { return _oom; }
212 void set_oom() { _oom = true; }
213
214 // error handling
215 void bailout(const char* msg);
216 bool bailed_out() const { return _bailout_msg != nullptr; }
217 const char* bailout_msg() const { return _bailout_msg; }
218 const CompilationFailureInfo* first_failure_details() const { return _first_failure_details; }
219
220 static uint desired_max_code_buffer_size() {
221 return (uint)NMethodSizeLimit; // default 64K
222 }
223 static uint desired_max_constant_size() {
224 return desired_max_code_buffer_size() / 10;
225 }
226
227 static bool setup_code_buffer(CodeBuffer* cb, int call_stub_estimate);
228
229 // timers
230 static void print_timers();
231
232 bool is_profiling() {
233 return env()->comp_level() == CompLevel_full_profile ||
234 env()->comp_level() == CompLevel_limited_profile;
235 }
236
237 // Helpers for generation of profile information
238 bool profile_branches() {
239 return env()->comp_level() == CompLevel_full_profile &&
240 C1UpdateMethodData && C1ProfileBranches;
241 }
242 bool profile_calls() {
243 return env()->comp_level() == CompLevel_full_profile &&
244 C1UpdateMethodData && C1ProfileCalls;
245 }
246 bool profile_inlined_calls() {
247 return profile_calls() && C1ProfileInlinedCalls;
248 }
249 bool profile_checkcasts() {
250 return env()->comp_level() == CompLevel_full_profile &&
251 C1UpdateMethodData && C1ProfileCheckcasts;
252 }
253 bool profile_parameters() {
254 return env()->comp_level() == CompLevel_full_profile &&
255 C1UpdateMethodData && MethodData::profile_parameters();
256 }
257 bool profile_arguments() {
258 return env()->comp_level() == CompLevel_full_profile &&
259 C1UpdateMethodData && MethodData::profile_arguments();
260 }
261 bool profile_return() {
262 return env()->comp_level() == CompLevel_full_profile &&
263 C1UpdateMethodData && MethodData::profile_return();
264 }
265
266 // will compilation make optimistic assumptions that might lead to
267 // deoptimization and that the runtime will account for?
268 bool is_optimistic() {
269 return CompilerConfig::is_c1_only_no_jvmci() && !is_profiling() &&
270 (RangeCheckElimination || UseLoopInvariantCodeMotion) &&
271 method()->method_data()->trap_count(Deoptimization::Reason_none) == 0;
272 }
273
274 ciKlass* cha_exact_type(ciType* type);
275
276 // Dump inlining replay data to the stream.
277 void dump_inline_data(outputStream* out) { /* do nothing now */ }
278
279 // How much stack space would the interpreter need in case of a
280 // deoptimization (worst case)
281 void update_interpreter_frame_size(int size) {
282 if (_interpreter_frame_size < size) {
283 _interpreter_frame_size = size;
284 }
285 }
286
287 int interpreter_frame_size() const {
288 return _interpreter_frame_size;
289 }
290 };
291
292
293 // Macro definitions for unified bailout-support
294 // The methods bailout() and bailed_out() are present in all classes
295 // that might bailout, but forward all calls to Compilation
296 #define BAILOUT(msg) { bailout(msg); return; }
297 #define BAILOUT_(msg, res) { bailout(msg); return res; }
298
299 #define CHECK_BAILOUT() { if (bailed_out()) return; }
300 #define CHECK_BAILOUT_(res) { if (bailed_out()) return res; }
301
302 // BAILOUT check with reset of bound labels
303 #define CHECK_BAILOUT1(l1) { if (bailed_out()) { l1.reset(); return; } }
304 #define CHECK_BAILOUT2(l1, l2) { if (bailed_out()) { l1.reset(); l2.reset(); return; } }
305 #define CHECK_BAILOUT3(l1, l2, l3) { if (bailed_out()) { l1.reset(); l2.reset(); l3.reset(); return; } }
306
307
308 class InstructionMark: public StackObj {
309 private:
310 Compilation* _compilation;
311 Instruction* _previous;
312
313 public:
314 InstructionMark(Compilation* compilation, Instruction* instr) {
315 _compilation = compilation;
316 _previous = _compilation->set_current_instruction(instr);
317 }
318 ~InstructionMark() {
319 _compilation->set_current_instruction(_previous);
320 }
321 };
322
323
324 //----------------------------------------------------------------------
325 // Base class for objects allocated by the compiler in the compilation arena
326 class CompilationResourceObj {
327 public:
328 void* operator new(size_t size) throw() { return Compilation::current()->arena()->Amalloc(size); }
329 void* operator new(size_t size, Arena* arena) throw() {
330 return arena->Amalloc(size);
331 }
332 void operator delete(void* p) {} // nothing to do
333
334 #ifndef PRODUCT
335 // Printing support
336 void print() const;
337 virtual void print_on(outputStream* st) const;
338 #endif
339 };
340
341
342 //----------------------------------------------------------------------
343 // Class for aggregating exception handler information.
344
345 // Effectively extends XHandlers class with PC offset of
346 // potentially exception-throwing instruction.
347 // This class is used at the end of the compilation to build the
348 // ExceptionHandlerTable.
349 class ExceptionInfo: public CompilationResourceObj {
350 private:
351 int _pco; // PC of potentially exception-throwing instruction
352 XHandlers* _exception_handlers; // flat list of exception handlers covering this PC
353
354 public:
355 ExceptionInfo(int pco, XHandlers* exception_handlers)
356 : _pco(pco)
357 , _exception_handlers(exception_handlers)
358 { }
359
360 int pco() { return _pco; }
361 XHandlers* exception_handlers() { return _exception_handlers; }
362 };
363
364 #endif // SHARE_C1_C1_COMPILATION_HPP