1 /*
   2  * Copyright (c) 1999, 2015, 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_VM_C1_C1_COMPILATION_HPP
  26 #define SHARE_VM_C1_C1_COMPILATION_HPP
  27 
  28 #include "ci/ciEnv.hpp"
  29 #include "ci/ciMethodData.hpp"
  30 #include "code/exceptionHandlerTable.hpp"
  31 #include "memory/resourceArea.hpp"
  32 #include "runtime/deoptimization.hpp"
  33 
  34 class CompilationResourceObj;
  35 class XHandlers;
  36 class ExceptionInfo;
  37 class DebugInformationRecorder;
  38 class FrameMap;
  39 class IR;
  40 class IRScope;
  41 class Instruction;
  42 class LinearScan;
  43 class OopMap;
  44 class LIR_Emitter;
  45 class LIR_Assembler;
  46 class CodeEmitInfo;
  47 class ciEnv;
  48 class ciMethod;
  49 class ValueStack;
  50 class LIR_OprDesc;
  51 class C1_MacroAssembler;
  52 class CFGPrinter;
  53 typedef LIR_OprDesc* LIR_Opr;
  54 
  55 
  56 define_array(BasicTypeArray, BasicType)
  57 define_stack(BasicTypeList, BasicTypeArray)
  58 
  59 define_array(ExceptionInfoArray, ExceptionInfo*)
  60 define_stack(ExceptionInfoList,  ExceptionInfoArray)
  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   const char*        _bailout_msg;
  85   ExceptionInfoList* _exception_info_list;
  86   ExceptionHandlerTable _exception_handler_table;
  87   ImplicitExceptionTable _implicit_exception_table;
  88   LinearScan*        _allocator;
  89   CodeOffsets        _offsets;
  90   CodeBuffer         _code;
  91   bool               _has_access_indexed;
  92   int                _interpreter_frame_size; // Stack space needed in case of a deoptimization
  93 
  94   // compilation helpers
  95   void initialize();
  96   void build_hir();
  97   void emit_lir();
  98 
  99   void emit_code_epilog(LIR_Assembler* assembler);
 100   int  emit_code_body();
 101 
 102   int  compile_java_method();
 103   void install_code(int frame_size);
 104   void compile_method();
 105 
 106   void generate_exception_handler_table();
 107 
 108   ExceptionInfoList* exception_info_list() const { return _exception_info_list; }
 109   ExceptionHandlerTable* exception_handler_table() { return &_exception_handler_table; }
 110 
 111   LinearScan* allocator()                          { return _allocator;      }
 112   void        set_allocator(LinearScan* allocator) { _allocator = allocator; }
 113 
 114   Instruction*       _current_instruction;       // the instruction currently being processed
 115 #ifndef PRODUCT
 116   Instruction*       _last_instruction_printed;  // the last instruction printed during traversal
 117 #endif // PRODUCT
 118 
 119  public:
 120   // creation
 121   Compilation(AbstractCompiler* compiler, ciEnv* env, ciMethod* method,
 122               int osr_bci, BufferBlob* buffer_blob, DirectiveSet* directive);
 123   ~Compilation();
 124 
 125 
 126   static Compilation* current() {
 127     return (Compilation*) ciEnv::current()->compiler_data();
 128   }
 129 
 130   // accessors
 131   ciEnv* env() const                             { return _env; }
 132   DirectiveSet* directive() const                { return _directive; }
 133   CompileLog* log() const                        { return _log; }
 134   AbstractCompiler* compiler() const             { return _compiler; }
 135   bool has_exception_handlers() const            { return _has_exception_handlers; }
 136   bool has_fpu_code() const                      { return _has_fpu_code; }
 137   bool has_unsafe_access() const                 { return _has_unsafe_access; }
 138   int max_vector_size() const                    { return 0; }
 139   ciMethod* method() const                       { return _method; }
 140   int osr_bci() const                            { return _osr_bci; }
 141   bool is_osr_compile() const                    { return osr_bci() >= 0; }
 142   IR* hir() const                                { return _hir; }
 143   int max_spills() const                         { return _max_spills; }
 144   FrameMap* frame_map() const                    { return _frame_map; }
 145   CodeBuffer* code()                             { return &_code; }
 146   C1_MacroAssembler* masm() const                { return _masm; }
 147   CodeOffsets* offsets()                         { return &_offsets; }
 148   Arena* arena()                                 { return _arena; }
 149   bool has_access_indexed()                      { return _has_access_indexed; }
 150 
 151   // Instruction ids
 152   int get_next_id()                              { return _next_id++; }
 153   int number_of_instructions() const             { return _next_id; }
 154 
 155   // BlockBegin ids
 156   int get_next_block_id()                        { return _next_block_id++; }
 157   int number_of_blocks() const                   { return _next_block_id; }
 158 
 159   // setters
 160   void set_has_exception_handlers(bool f)        { _has_exception_handlers = f; }
 161   void set_has_fpu_code(bool f)                  { _has_fpu_code = f; }
 162   void set_has_unsafe_access(bool f)             { _has_unsafe_access = f; }
 163   void set_would_profile(bool f)                 { _would_profile = f; }
 164   void set_has_access_indexed(bool f)            { _has_access_indexed = f; }
 165   // Add a set of exception handlers covering the given PC offset
 166   void add_exception_handlers_for_pco(int pco, XHandlers* exception_handlers);
 167   // Statistics gathering
 168   void notice_inlined_method(ciMethod* method);
 169 
 170   // JSR 292
 171   bool     has_method_handle_invokes() const { return _has_method_handle_invokes;     }
 172   void set_has_method_handle_invokes(bool z) {        _has_method_handle_invokes = z; }
 173 
 174   DebugInformationRecorder* debug_info_recorder() const; // = _env->debug_info();
 175   Dependencies* dependency_recorder() const; // = _env->dependencies()
 176   ImplicitExceptionTable* implicit_exception_table()     { return &_implicit_exception_table; }
 177 
 178   Instruction* current_instruction() const       { return _current_instruction; }
 179   Instruction* set_current_instruction(Instruction* instr) {
 180     Instruction* previous = _current_instruction;
 181     _current_instruction = instr;
 182     return previous;
 183   }
 184 
 185 #ifndef PRODUCT
 186   void maybe_print_current_instruction();
 187 #endif // PRODUCT
 188 
 189   // error handling
 190   void bailout(const char* msg);
 191   bool bailed_out() const                        { return _bailout_msg != NULL; }
 192   const char* bailout_msg() const                { return _bailout_msg; }
 193 
 194   static int desired_max_code_buffer_size() {
 195 #ifndef PPC32
 196     return (int) NMethodSizeLimit;  // default 256K or 512K
 197 #else
 198     // conditional branches on PPC are restricted to 16 bit signed
 199     return MIN2((unsigned int)NMethodSizeLimit,32*K);
 200 #endif
 201   }
 202   static int desired_max_constant_size() {
 203     return desired_max_code_buffer_size() / 10;
 204   }
 205 
 206   static bool setup_code_buffer(CodeBuffer* cb, int call_stub_estimate);
 207 
 208   // timers
 209   static void print_timers();
 210 
 211 #ifndef PRODUCT
 212   // debugging support.
 213   // produces a file named c1compileonly in the current directory with
 214   // directives to compile only the current method and it's inlines.
 215   // The file can be passed to the command line option -XX:Flags=<filename>
 216   void compile_only_this_method();
 217   void compile_only_this_scope(outputStream* st, IRScope* scope);
 218   void exclude_this_method();
 219 #endif // PRODUCT
 220 
 221   bool is_profiling() {
 222     return env()->comp_level() == CompLevel_full_profile ||
 223            env()->comp_level() == CompLevel_limited_profile;
 224   }
 225   bool count_invocations() { return is_profiling(); }
 226   bool count_backedges()   { return is_profiling(); }
 227 
 228   // Helpers for generation of profile information
 229   bool profile_branches() {
 230     return env()->comp_level() == CompLevel_full_profile &&
 231       C1UpdateMethodData && C1ProfileBranches;
 232   }
 233   bool profile_calls() {
 234     return env()->comp_level() == CompLevel_full_profile &&
 235       C1UpdateMethodData && C1ProfileCalls;
 236   }
 237   bool profile_inlined_calls() {
 238     return profile_calls() && C1ProfileInlinedCalls;
 239   }
 240   bool profile_checkcasts() {
 241     return env()->comp_level() == CompLevel_full_profile &&
 242       C1UpdateMethodData && C1ProfileCheckcasts;
 243   }
 244   bool profile_parameters() {
 245     return env()->comp_level() == CompLevel_full_profile &&
 246       C1UpdateMethodData && MethodData::profile_parameters();
 247   }
 248   bool profile_arguments() {
 249     return env()->comp_level() == CompLevel_full_profile &&
 250       C1UpdateMethodData && MethodData::profile_arguments();
 251   }
 252   bool profile_return() {
 253     return env()->comp_level() == CompLevel_full_profile &&
 254       C1UpdateMethodData && MethodData::profile_return();
 255   }
 256   bool age_code() const {
 257     return _method->profile_aging();
 258   }
 259 
 260   // will compilation make optimistic assumptions that might lead to
 261   // deoptimization and that the runtime will account for?
 262   bool is_optimistic() const                             {
 263     return !TieredCompilation &&
 264       (RangeCheckElimination || UseLoopInvariantCodeMotion) &&
 265       method()->method_data()->trap_count(Deoptimization::Reason_none) == 0;
 266   }
 267 
 268   ciKlass* cha_exact_type(ciType* type);
 269 
 270   // Dump inlining replay data to the stream.
 271   void dump_inline_data(outputStream* out) { /* do nothing now */ }
 272 
 273   // How much stack space would the interpreter need in case of a
 274   // deoptimization (worst case)
 275   void update_interpreter_frame_size(int size) {
 276     if (_interpreter_frame_size < size) {
 277       _interpreter_frame_size = size;
 278     }
 279   }
 280 
 281   int interpreter_frame_size() const {
 282     return _interpreter_frame_size;
 283   }
 284 };
 285 
 286 
 287 // Macro definitions for unified bailout-support
 288 // The methods bailout() and bailed_out() are present in all classes
 289 // that might bailout, but forward all calls to Compilation
 290 #define BAILOUT(msg)               { bailout(msg); return;              }
 291 #define BAILOUT_(msg, res)         { bailout(msg); return res;          }
 292 
 293 #define CHECK_BAILOUT()            { if (bailed_out()) return;          }
 294 #define CHECK_BAILOUT_(res)        { if (bailed_out()) return res;      }
 295 
 296 
 297 class InstructionMark: public StackObj {
 298  private:
 299   Compilation* _compilation;
 300   Instruction*  _previous;
 301 
 302  public:
 303   InstructionMark(Compilation* compilation, Instruction* instr) {
 304     _compilation = compilation;
 305     _previous = _compilation->set_current_instruction(instr);
 306   }
 307   ~InstructionMark() {
 308     _compilation->set_current_instruction(_previous);
 309   }
 310 };
 311 
 312 
 313 //----------------------------------------------------------------------
 314 // Base class for objects allocated by the compiler in the compilation arena
 315 class CompilationResourceObj ALLOCATION_SUPER_CLASS_SPEC {
 316  public:
 317   void* operator new(size_t size) throw() { return Compilation::current()->arena()->Amalloc(size); }
 318   void* operator new(size_t size, Arena* arena) throw() {
 319     return arena->Amalloc(size);
 320   }
 321   void  operator delete(void* p) {} // nothing to do
 322 };
 323 
 324 
 325 //----------------------------------------------------------------------
 326 // Class for aggregating exception handler information.
 327 
 328 // Effectively extends XHandlers class with PC offset of
 329 // potentially exception-throwing instruction.
 330 // This class is used at the end of the compilation to build the
 331 // ExceptionHandlerTable.
 332 class ExceptionInfo: public CompilationResourceObj {
 333  private:
 334   int             _pco;                // PC of potentially exception-throwing instruction
 335   XHandlers*      _exception_handlers; // flat list of exception handlers covering this PC
 336 
 337  public:
 338   ExceptionInfo(int pco, XHandlers* exception_handlers)
 339     : _pco(pco)
 340     , _exception_handlers(exception_handlers)
 341   { }
 342 
 343   int pco()                                      { return _pco; }
 344   XHandlers* exception_handlers()                { return _exception_handlers; }
 345 };
 346 
 347 #endif // SHARE_VM_C1_C1_COMPILATION_HPP