1 /*
  2  * Copyright (c) 1999, 2021, 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/compilerDirectives.hpp"
 33 #include "memory/resourceArea.hpp"
 34 #include "runtime/deoptimization.hpp"
 35 
 36 class CompilationResourceObj;
 37 class XHandlers;
 38 class ExceptionInfo;
 39 class DebugInformationRecorder;
 40 class FrameMap;
 41 class IR;
 42 class IRScope;
 43 class Instruction;
 44 class LinearScan;
 45 class OopMap;
 46 class LIR_Emitter;
 47 class LIR_Assembler;
 48 class CodeEmitInfo;
 49 class ciEnv;
 50 class ciMethod;
 51 class ValueStack;
 52 class LIR_OprDesc;
 53 class C1_MacroAssembler;
 54 class CFGPrinter;
 55 class CFGPrinterOutput;
 56 typedef LIR_OprDesc* LIR_Opr;
 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   int                _max_spills;
 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               _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   int max_vector_size() const                    { return 0; }
144   ciMethod* method() const                       { return _method; }
145   int osr_bci() const                            { return _osr_bci; }
146   bool is_osr_compile() const                    { return osr_bci() >= 0; }
147   IR* hir() const                                { return _hir; }
148   int max_spills() const                         { return _max_spills; }
149   FrameMap* frame_map() const                    { return _frame_map; }
150   CodeBuffer* code()                             { return &_code; }
151   C1_MacroAssembler* masm() const                { return _masm; }
152   CodeOffsets* offsets()                         { return &_offsets; }
153   Arena* arena()                                 { return _arena; }
154   bool has_access_indexed()                      { return _has_access_indexed; }
155   bool should_install_code()                     { return _install_code && InstallMethods; }
156   LinearScan* allocator()                        { return _allocator; }
157 
158   // Instruction ids
159   int get_next_id()                              { return _next_id++; }
160   int number_of_instructions() const             { return _next_id; }
161 
162   // BlockBegin ids
163   int get_next_block_id()                        { return _next_block_id++; }
164   int number_of_blocks() const                   { return _next_block_id; }
165 
166   // setters
167   void set_has_exception_handlers(bool f)        { _has_exception_handlers = f; }
168   void set_has_fpu_code(bool f)                  { _has_fpu_code = f; }
169   void set_has_unsafe_access(bool f)             { _has_unsafe_access = f; }
170   void set_would_profile(bool f)                 { _would_profile = f; }
171   void set_has_access_indexed(bool f)            { _has_access_indexed = f; }
172   void set_has_monitors(bool f)                  { _has_monitors = f; }
173   // Add a set of exception handlers covering the given PC offset
174   void add_exception_handlers_for_pco(int pco, XHandlers* exception_handlers);
175   // Statistics gathering
176   void notice_inlined_method(ciMethod* method);
177 
178   // JSR 292
179   bool     has_method_handle_invokes() const { return _has_method_handle_invokes;     }
180   void set_has_method_handle_invokes(bool z) {        _has_method_handle_invokes = z; }
181 
182   bool     has_reserved_stack_access() const { return _has_reserved_stack_access; }
183   void set_has_reserved_stack_access(bool z) { _has_reserved_stack_access = z; }
184 
185   DebugInformationRecorder* debug_info_recorder() const; // = _env->debug_info();
186   Dependencies* dependency_recorder() const; // = _env->dependencies()
187   ImplicitExceptionTable* implicit_exception_table()     { return &_implicit_exception_table; }
188 
189   Instruction* current_instruction() const       { return _current_instruction; }
190   Instruction* set_current_instruction(Instruction* instr) {
191     Instruction* previous = _current_instruction;
192     _current_instruction = instr;
193     return previous;
194   }
195 
196 #ifndef PRODUCT
197   void maybe_print_current_instruction();
198   CFGPrinterOutput* cfg_printer_output() {
199     guarantee(_cfg_printer_output != NULL, "CFG printer output not initialized");
200     return _cfg_printer_output;
201   }
202 #endif // PRODUCT
203 
204   // error handling
205   void bailout(const char* msg);
206   bool bailed_out() const                        { return _bailout_msg != NULL; }
207   const char* bailout_msg() const                { return _bailout_msg; }
208 
209   static int desired_max_code_buffer_size() {
210     return (int)NMethodSizeLimit;  // default 64K
211   }
212   static int desired_max_constant_size() {
213     return desired_max_code_buffer_size() / 10;
214   }
215 
216   static bool setup_code_buffer(CodeBuffer* cb, int call_stub_estimate);
217 
218   // timers
219   static void print_timers();
220 
221 #ifndef PRODUCT
222   // debugging support.
223   // produces a file named c1compileonly in the current directory with
224   // directives to compile only the current method and it's inlines.
225   // The file can be passed to the command line option -XX:Flags=<filename>
226   void compile_only_this_method();
227   void compile_only_this_scope(outputStream* st, IRScope* scope);
228   void exclude_this_method();
229 #endif // PRODUCT
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   bool age_code() const {
265     return _method->profile_aging();
266   }
267 
268   // will compilation make optimistic assumptions that might lead to
269   // deoptimization and that the runtime will account for?
270   bool is_optimistic() {
271     return CompilerConfig::is_c1_only_no_jvmci() && !is_profiling() &&
272       (RangeCheckElimination || UseLoopInvariantCodeMotion) &&
273       method()->method_data()->trap_count(Deoptimization::Reason_none) == 0;
274   }
275 
276   ciKlass* cha_exact_type(ciType* type);
277 
278   // Dump inlining replay data to the stream.
279   void dump_inline_data(outputStream* out) { /* do nothing now */ }
280 
281   // How much stack space would the interpreter need in case of a
282   // deoptimization (worst case)
283   void update_interpreter_frame_size(int size) {
284     if (_interpreter_frame_size < size) {
285       _interpreter_frame_size = size;
286     }
287   }
288 
289   int interpreter_frame_size() const {
290     return _interpreter_frame_size;
291   }
292 };
293 
294 
295 // Macro definitions for unified bailout-support
296 // The methods bailout() and bailed_out() are present in all classes
297 // that might bailout, but forward all calls to Compilation
298 #define BAILOUT(msg)               { bailout(msg); return;              }
299 #define BAILOUT_(msg, res)         { bailout(msg); return res;          }
300 
301 #define CHECK_BAILOUT()            { if (bailed_out()) return;          }
302 #define CHECK_BAILOUT_(res)        { if (bailed_out()) return res;      }
303 
304 // BAILOUT check with reset of bound labels
305 #define CHECK_BAILOUT1(l1)         { if (bailed_out()) { l1.reset();                         return; } }
306 #define CHECK_BAILOUT2(l1, l2)     { if (bailed_out()) { l1.reset(); l2.reset();             return; } }
307 #define CHECK_BAILOUT3(l1, l2, l3) { if (bailed_out()) { l1.reset(); l2.reset(); l3.reset(); return; } }
308 
309 
310 class InstructionMark: public StackObj {
311  private:
312   Compilation* _compilation;
313   Instruction*  _previous;
314 
315  public:
316   InstructionMark(Compilation* compilation, Instruction* instr) {
317     _compilation = compilation;
318     _previous = _compilation->set_current_instruction(instr);
319   }
320   ~InstructionMark() {
321     _compilation->set_current_instruction(_previous);
322   }
323 };
324 
325 
326 //----------------------------------------------------------------------
327 // Base class for objects allocated by the compiler in the compilation arena
328 class CompilationResourceObj ALLOCATION_SUPER_CLASS_SPEC {
329  public:
330   void* operator new(size_t size) throw() { return Compilation::current()->arena()->Amalloc(size); }
331   void* operator new(size_t size, Arena* arena) throw() {
332     return arena->Amalloc(size);
333   }
334   void  operator delete(void* p) {} // nothing to do
335 };
336 
337 
338 //----------------------------------------------------------------------
339 // Class for aggregating exception handler information.
340 
341 // Effectively extends XHandlers class with PC offset of
342 // potentially exception-throwing instruction.
343 // This class is used at the end of the compilation to build the
344 // ExceptionHandlerTable.
345 class ExceptionInfo: public CompilationResourceObj {
346  private:
347   int             _pco;                // PC of potentially exception-throwing instruction
348   XHandlers*      _exception_handlers; // flat list of exception handlers covering this PC
349 
350  public:
351   ExceptionInfo(int pco, XHandlers* exception_handlers)
352     : _pco(pco)
353     , _exception_handlers(exception_handlers)
354   { }
355 
356   int pco()                                      { return _pco; }
357   XHandlers* exception_handlers()                { return _exception_handlers; }
358 };
359 
360 #endif // SHARE_C1_C1_COMPILATION_HPP