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