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