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