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