1 /*
  2  * Copyright (c) 1999, 2022, 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   int                _max_monitors; // Max number of active monitors, for fast-locking
 87   bool               _install_code;
 88   const char*        _bailout_msg;
 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   int max_monitors() const                       { return _max_monitors; }
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   int max_spills() const                         { return _max_spills; }
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 push_monitor()                            { _max_monitors++; }
178 
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 != NULL, "CFG printer output not initialized");
206     return _cfg_printer_output;
207   }
208 #endif // PRODUCT
209 
210   // error handling
211   void bailout(const char* msg);
212   bool bailed_out() const                        { return _bailout_msg != NULL; }
213   const char* bailout_msg() const                { return _bailout_msg; }
214 
215   static int desired_max_code_buffer_size() {
216     return (int)NMethodSizeLimit;  // default 64K
217   }
218   static int desired_max_constant_size() {
219     return desired_max_code_buffer_size() / 10;
220   }
221 
222   static bool setup_code_buffer(CodeBuffer* cb, int call_stub_estimate);
223 
224   // timers
225   static void print_timers();
226 
227   bool is_profiling() {
228     return env()->comp_level() == CompLevel_full_profile ||
229            env()->comp_level() == CompLevel_limited_profile;
230   }
231 
232   // Helpers for generation of profile information
233   bool profile_branches() {
234     return env()->comp_level() == CompLevel_full_profile &&
235       C1UpdateMethodData && C1ProfileBranches;
236   }
237   bool profile_calls() {
238     return env()->comp_level() == CompLevel_full_profile &&
239       C1UpdateMethodData && C1ProfileCalls;
240   }
241   bool profile_inlined_calls() {
242     return profile_calls() && C1ProfileInlinedCalls;
243   }
244   bool profile_checkcasts() {
245     return env()->comp_level() == CompLevel_full_profile &&
246       C1UpdateMethodData && C1ProfileCheckcasts;
247   }
248   bool profile_parameters() {
249     return env()->comp_level() == CompLevel_full_profile &&
250       C1UpdateMethodData && MethodData::profile_parameters();
251   }
252   bool profile_arguments() {
253     return env()->comp_level() == CompLevel_full_profile &&
254       C1UpdateMethodData && MethodData::profile_arguments();
255   }
256   bool profile_return() {
257     return env()->comp_level() == CompLevel_full_profile &&
258       C1UpdateMethodData && MethodData::profile_return();
259   }
260 
261   // will compilation make optimistic assumptions that might lead to
262   // deoptimization and that the runtime will account for?
263   bool is_optimistic() {
264     return CompilerConfig::is_c1_only_no_jvmci() && !is_profiling() &&
265       (RangeCheckElimination || UseLoopInvariantCodeMotion) &&
266       method()->method_data()->trap_count(Deoptimization::Reason_none) == 0;
267   }
268 
269   ciKlass* cha_exact_type(ciType* type);
270 
271   // Dump inlining replay data to the stream.
272   void dump_inline_data(outputStream* out) { /* do nothing now */ }
273 
274   // How much stack space would the interpreter need in case of a
275   // deoptimization (worst case)
276   void update_interpreter_frame_size(int size) {
277     if (_interpreter_frame_size < size) {
278       _interpreter_frame_size = size;
279     }
280   }
281 
282   int interpreter_frame_size() const {
283     return _interpreter_frame_size;
284   }
285 };
286 
287 
288 // Macro definitions for unified bailout-support
289 // The methods bailout() and bailed_out() are present in all classes
290 // that might bailout, but forward all calls to Compilation
291 #define BAILOUT(msg)               { bailout(msg); return;              }
292 #define BAILOUT_(msg, res)         { bailout(msg); return res;          }
293 
294 #define CHECK_BAILOUT()            { if (bailed_out()) return;          }
295 #define CHECK_BAILOUT_(res)        { if (bailed_out()) return res;      }
296 
297 // BAILOUT check with reset of bound labels
298 #define CHECK_BAILOUT1(l1)         { if (bailed_out()) { l1.reset();                         return; } }
299 #define CHECK_BAILOUT2(l1, l2)     { if (bailed_out()) { l1.reset(); l2.reset();             return; } }
300 #define CHECK_BAILOUT3(l1, l2, l3) { if (bailed_out()) { l1.reset(); l2.reset(); l3.reset(); return; } }
301 
302 
303 class InstructionMark: public StackObj {
304  private:
305   Compilation* _compilation;
306   Instruction*  _previous;
307 
308  public:
309   InstructionMark(Compilation* compilation, Instruction* instr) {
310     _compilation = compilation;
311     _previous = _compilation->set_current_instruction(instr);
312   }
313   ~InstructionMark() {
314     _compilation->set_current_instruction(_previous);
315   }
316 };
317 
318 
319 //----------------------------------------------------------------------
320 // Base class for objects allocated by the compiler in the compilation arena
321 class CompilationResourceObj {
322  public:
323   void* operator new(size_t size) throw() { return Compilation::current()->arena()->Amalloc(size); }
324   void* operator new(size_t size, Arena* arena) throw() {
325     return arena->Amalloc(size);
326   }
327   void  operator delete(void* p) {} // nothing to do
328 
329 #ifndef PRODUCT
330   // Printing support
331   void print() const;
332   virtual void print_on(outputStream* st) const;
333 #endif
334 };
335 
336 
337 //----------------------------------------------------------------------
338 // Class for aggregating exception handler information.
339 
340 // Effectively extends XHandlers class with PC offset of
341 // potentially exception-throwing instruction.
342 // This class is used at the end of the compilation to build the
343 // ExceptionHandlerTable.
344 class ExceptionInfo: public CompilationResourceObj {
345  private:
346   int             _pco;                // PC of potentially exception-throwing instruction
347   XHandlers*      _exception_handlers; // flat list of exception handlers covering this PC
348 
349  public:
350   ExceptionInfo(int pco, XHandlers* exception_handlers)
351     : _pco(pco)
352     , _exception_handlers(exception_handlers)
353   { }
354 
355   int pco()                                      { return _pco; }
356   XHandlers* exception_handlers()                { return _exception_handlers; }
357 };
358 
359 #endif // SHARE_C1_C1_COMPILATION_HPP