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               _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 
 96   // compilation helpers
 97   void initialize();
 98   void build_hir();
 99   void emit_lir();
100 
101   void emit_code_epilog(LIR_Assembler* assembler);
102   int  emit_code_body();
103 
104   int  compile_java_method();
105   void install_code(int frame_size);
106   void compile_method();
107 
108   void generate_exception_handler_table();
109 
110   ExceptionInfoList* exception_info_list() const { return _exception_info_list; }
111   ExceptionHandlerTable* exception_handler_table() { return &_exception_handler_table; }
112 
113   void        set_allocator(LinearScan* allocator) { _allocator = allocator; }
114 
115   Instruction*       _current_instruction;       // the instruction currently being processed
116 #ifndef PRODUCT
117   Instruction*       _last_instruction_printed;  // the last instruction printed during traversal
118   CFGPrinterOutput*  _cfg_printer_output;
119 #endif // PRODUCT
120 
121  public:
122   // creation
123   Compilation(AbstractCompiler* compiler, ciEnv* env, ciMethod* method,
124               int osr_bci, BufferBlob* buffer_blob, bool install_code, DirectiveSet* directive);
125   ~Compilation();
126 
127 
128   static Compilation* current() {
129     return (Compilation*) ciEnv::current()->compiler_data();
130   }
131 
132   // accessors
133   ciEnv* env() const                             { return _env; }
134   DirectiveSet* directive() const                { return _directive; }
135   CompileLog* log() const                        { return _log; }
136   AbstractCompiler* compiler() const             { return _compiler; }
137   bool has_exception_handlers() const            { return _has_exception_handlers; }
138   bool has_fpu_code() const                      { return _has_fpu_code; }
139   bool has_unsafe_access() const                 { return _has_unsafe_access; }
140   int max_vector_size() const                    { return 0; }
141   ciMethod* method() const                       { return _method; }
142   int osr_bci() const                            { return _osr_bci; }
143   bool is_osr_compile() const                    { return osr_bci() >= 0; }
144   IR* hir() const                                { return _hir; }
145   int max_spills() const                         { return _max_spills; }
146   FrameMap* frame_map() const                    { return _frame_map; }
147   CodeBuffer* code()                             { return &_code; }
148   C1_MacroAssembler* masm() const                { return _masm; }
149   CodeOffsets* offsets()                         { return &_offsets; }
150   Arena* arena()                                 { return _arena; }
151   bool has_access_indexed()                      { return _has_access_indexed; }
152   bool should_install_code()                     { return _install_code && InstallMethods; }
153   LinearScan* allocator()                        { return _allocator; }
154 
155   // Instruction ids
156   int get_next_id()                              { return _next_id++; }
157   int number_of_instructions() const             { return _next_id; }
158 
159   // BlockBegin ids
160   int get_next_block_id()                        { return _next_block_id++; }
161   int number_of_blocks() const                   { return _next_block_id; }
162 
163   // setters
164   void set_has_exception_handlers(bool f)        { _has_exception_handlers = f; }
165   void set_has_fpu_code(bool f)                  { _has_fpu_code = f; }
166   void set_has_unsafe_access(bool f)             { _has_unsafe_access = f; }
167   void set_would_profile(bool f)                 { _would_profile = f; }
168   void set_has_access_indexed(bool f)            { _has_access_indexed = f; }
169   // Add a set of exception handlers covering the given PC offset
170   void add_exception_handlers_for_pco(int pco, XHandlers* exception_handlers);
171   // Statistics gathering
172   void notice_inlined_method(ciMethod* method);
173 
174   // JSR 292
175   bool     has_method_handle_invokes() const { return _has_method_handle_invokes;     }
176   void set_has_method_handle_invokes(bool z) {        _has_method_handle_invokes = z; }
177 
178   bool     has_reserved_stack_access() const { return _has_reserved_stack_access; }
179   void set_has_reserved_stack_access(bool z) { _has_reserved_stack_access = z; }
180 
181   DebugInformationRecorder* debug_info_recorder() const; // = _env->debug_info();
182   Dependencies* dependency_recorder() const; // = _env->dependencies()
183   ImplicitExceptionTable* implicit_exception_table()     { return &_implicit_exception_table; }
184 
185   Instruction* current_instruction() const       { return _current_instruction; }
186   Instruction* set_current_instruction(Instruction* instr) {
187     Instruction* previous = _current_instruction;
188     _current_instruction = instr;
189     return previous;
190   }
191 
192 #ifndef PRODUCT
193   void maybe_print_current_instruction();
194   CFGPrinterOutput* cfg_printer_output() {
195     guarantee(_cfg_printer_output != NULL, "CFG printer output not initialized");
196     return _cfg_printer_output;
197   }
198 #endif // PRODUCT
199 
200   // error handling
201   void bailout(const char* msg);
202   bool bailed_out() const                        { return _bailout_msg != NULL; }
203   const char* bailout_msg() const                { return _bailout_msg; }
204 
205   static int desired_max_code_buffer_size() {
206     return (int)NMethodSizeLimit;  // default 64K
207   }
208   static int desired_max_constant_size() {
209     return desired_max_code_buffer_size() / 10;
210   }
211 
212   static bool setup_code_buffer(CodeBuffer* cb, int call_stub_estimate);
213 
214   // timers
215   static void print_timers();
216 
217 #ifndef PRODUCT
218   // debugging support.
219   // produces a file named c1compileonly in the current directory with
220   // directives to compile only the current method and it's inlines.
221   // The file can be passed to the command line option -XX:Flags=<filename>
222   void compile_only_this_method();
223   void compile_only_this_scope(outputStream* st, IRScope* scope);
224   void exclude_this_method();
225 #endif // PRODUCT
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   bool age_code() const {
261     return _method->profile_aging();
262   }
263 
264   // will compilation make optimistic assumptions that might lead to
265   // deoptimization and that the runtime will account for?
266   bool is_optimistic() {
267     return CompilerConfig::is_c1_only_no_jvmci() && !is_profiling() &&
268       (RangeCheckElimination || UseLoopInvariantCodeMotion) &&
269       method()->method_data()->trap_count(Deoptimization::Reason_none) == 0;
270   }
271 
272   ciKlass* cha_exact_type(ciType* type);
273 
274   // Dump inlining replay data to the stream.
275   void dump_inline_data(outputStream* out) { /* do nothing now */ }
276 
277   // How much stack space would the interpreter need in case of a
278   // deoptimization (worst case)
279   void update_interpreter_frame_size(int size) {
280     if (_interpreter_frame_size < size) {
281       _interpreter_frame_size = size;
282     }
283   }
284 
285   int interpreter_frame_size() const {
286     return _interpreter_frame_size;
287   }







288 };
289 
290 
291 // Macro definitions for unified bailout-support
292 // The methods bailout() and bailed_out() are present in all classes
293 // that might bailout, but forward all calls to Compilation
294 #define BAILOUT(msg)               { bailout(msg); return;              }
295 #define BAILOUT_(msg, res)         { bailout(msg); return res;          }
296 
297 #define CHECK_BAILOUT()            { if (bailed_out()) return;          }
298 #define CHECK_BAILOUT_(res)        { if (bailed_out()) return res;      }
299 
300 // BAILOUT check with reset of bound labels
301 #define CHECK_BAILOUT1(l1)         { if (bailed_out()) { l1.reset();                         return; } }
302 #define CHECK_BAILOUT2(l1, l2)     { if (bailed_out()) { l1.reset(); l2.reset();             return; } }
303 #define CHECK_BAILOUT3(l1, l2, l3) { if (bailed_out()) { l1.reset(); l2.reset(); l3.reset(); return; } }
304 
305 
306 class InstructionMark: public StackObj {
307  private:
308   Compilation* _compilation;
309   Instruction*  _previous;
310 
311  public:
312   InstructionMark(Compilation* compilation, Instruction* instr) {
313     _compilation = compilation;
314     _previous = _compilation->set_current_instruction(instr);
315   }
316   ~InstructionMark() {
317     _compilation->set_current_instruction(_previous);
318   }
319 };
320 
321 
322 //----------------------------------------------------------------------
323 // Base class for objects allocated by the compiler in the compilation arena
324 class CompilationResourceObj ALLOCATION_SUPER_CLASS_SPEC {
325  public:
326   void* operator new(size_t size) throw() { return Compilation::current()->arena()->Amalloc(size); }
327   void* operator new(size_t size, Arena* arena) throw() {
328     return arena->Amalloc(size);
329   }
330   void  operator delete(void* p) {} // nothing to do
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
--- EOF ---