1 /*
   2  * Copyright (c) 1997, 2011, 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_OPTO_COMPILE_HPP
  26 #define SHARE_VM_OPTO_COMPILE_HPP
  27 
  28 #include "asm/codeBuffer.hpp"
  29 #include "ci/compilerInterface.hpp"
  30 #include "code/debugInfoRec.hpp"
  31 #include "code/exceptionHandlerTable.hpp"
  32 #include "compiler/compilerOracle.hpp"
  33 #include "libadt/dict.hpp"
  34 #include "libadt/port.hpp"
  35 #include "libadt/vectset.hpp"
  36 #include "memory/resourceArea.hpp"
  37 #include "opto/idealGraphPrinter.hpp"
  38 #include "opto/phase.hpp"
  39 #include "opto/regmask.hpp"
  40 #include "runtime/deoptimization.hpp"
  41 #include "runtime/vmThread.hpp"
  42 
  43 class Block;
  44 class Bundle;
  45 class C2Compiler;
  46 class CallGenerator;
  47 class ConnectionGraph;
  48 class InlineTree;
  49 class Int_Array;
  50 class Matcher;
  51 class MachConstantNode;
  52 class MachConstantBaseNode;
  53 class MachNode;
  54 class MachOper;
  55 class MachSafePointNode;
  56 class Node;
  57 class Node_Array;
  58 class Node_Notes;
  59 class OptoReg;
  60 class PhaseCFG;
  61 class PhaseGVN;
  62 class PhaseIterGVN;
  63 class PhaseRegAlloc;
  64 class PhaseCCP;
  65 class PhaseCCP_DCE;
  66 class RootNode;
  67 class relocInfo;
  68 class Scope;
  69 class StartNode;
  70 class SafePointNode;
  71 class JVMState;
  72 class TypeData;
  73 class TypePtr;
  74 class TypeFunc;
  75 class Unique_Node_List;
  76 class nmethod;
  77 class WarmCallInfo;
  78 
  79 //------------------------------Compile----------------------------------------
  80 // This class defines a top-level Compiler invocation.
  81 
  82 class Compile : public Phase {
  83   friend class VMStructs;
  84 
  85  public:
  86   // Fixed alias indexes.  (See also MergeMemNode.)
  87   enum {
  88     AliasIdxTop = 1,  // pseudo-index, aliases to nothing (used as sentinel value)
  89     AliasIdxBot = 2,  // pseudo-index, aliases to everything
  90     AliasIdxRaw = 3   // hard-wired index for TypeRawPtr::BOTTOM
  91   };
  92 
  93   // Variant of TraceTime(NULL, &_t_accumulator, TimeCompiler);
  94   // Integrated with logging.  If logging is turned on, and dolog is true,
  95   // then brackets are put into the log, with time stamps and node counts.
  96   // (The time collection itself is always conditionalized on TimeCompiler.)
  97   class TracePhase : public TraceTime {
  98    private:
  99     Compile*    C;
 100     CompileLog* _log;
 101    public:
 102     TracePhase(const char* name, elapsedTimer* accumulator, bool dolog);
 103     ~TracePhase();
 104   };
 105 
 106   // Information per category of alias (memory slice)
 107   class AliasType {
 108    private:
 109     friend class Compile;
 110 
 111     int             _index;         // unique index, used with MergeMemNode
 112     const TypePtr*  _adr_type;      // normalized address type
 113     ciField*        _field;         // relevant instance field, or null if none
 114     bool            _is_rewritable; // false if the memory is write-once only
 115     int             _general_index; // if this is type is an instance, the general
 116                                     // type that this is an instance of
 117 
 118     void Init(int i, const TypePtr* at);
 119 
 120    public:
 121     int             index()         const { return _index; }
 122     const TypePtr*  adr_type()      const { return _adr_type; }
 123     ciField*        field()         const { return _field; }
 124     bool            is_rewritable() const { return _is_rewritable; }
 125     bool            is_volatile()   const { return (_field ? _field->is_volatile() : false); }
 126     int             general_index() const { return (_general_index != 0) ? _general_index : _index; }
 127 
 128     void set_rewritable(bool z) { _is_rewritable = z; }
 129     void set_field(ciField* f) {
 130       assert(!_field,"");
 131       _field = f;
 132       if (f->is_final())  _is_rewritable = false;
 133     }
 134 
 135     void print_on(outputStream* st) PRODUCT_RETURN;
 136   };
 137 
 138   enum {
 139     logAliasCacheSize = 6,
 140     AliasCacheSize = (1<<logAliasCacheSize)
 141   };
 142   struct AliasCacheEntry { const TypePtr* _adr_type; int _index; };  // simple duple type
 143   enum {
 144     trapHistLength = methodDataOopDesc::_trap_hist_limit
 145   };
 146 
 147   // Constant entry of the constant table.
 148   class Constant {
 149   private:
 150     BasicType _type;
 151     jvalue    _value;
 152     int       _offset;         // offset of this constant (in bytes) relative to the constant table base.
 153     bool      _can_be_reused;  // true (default) if the value can be shared with other users.
 154 
 155   public:
 156     Constant() : _type(T_ILLEGAL), _offset(-1), _can_be_reused(true) { _value.l = 0; }
 157     Constant(BasicType type, jvalue value, bool can_be_reused = true) :
 158       _type(type),
 159       _value(value),
 160       _offset(-1),
 161       _can_be_reused(can_be_reused)
 162     {}
 163 
 164     bool operator==(const Constant& other);
 165 
 166     BasicType type()      const    { return _type; }
 167 
 168     jlong   get_jlong()   const    { return _value.j; }
 169     jfloat  get_jfloat()  const    { return _value.f; }
 170     jdouble get_jdouble() const    { return _value.d; }
 171     jobject get_jobject() const    { return _value.l; }
 172 
 173     int         offset()  const    { return _offset; }
 174     void    set_offset(int offset) {        _offset = offset; }
 175 
 176     bool    can_be_reused() const  { return _can_be_reused; }
 177   };
 178 
 179   // Constant table.
 180   class ConstantTable {
 181   private:
 182     GrowableArray<Constant> _constants;          // Constants of this table.
 183     int                     _size;               // Size in bytes the emitted constant table takes (including padding).
 184     int                     _table_base_offset;  // Offset of the table base that gets added to the constant offsets.
 185 
 186   public:
 187     ConstantTable() :
 188       _size(-1),
 189       _table_base_offset(-1)  // We can use -1 here since the constant table is always bigger than 2 bytes (-(size / 2), see MachConstantBaseNode::emit).
 190     {}
 191 
 192     int size() const { assert(_size != -1, "size not yet calculated"); return _size; }
 193 
 194     void set_table_base_offset(int x)  { assert(_table_base_offset == -1, "set only once");                        _table_base_offset = x; }
 195     int      table_base_offset() const { assert(_table_base_offset != -1, "table base offset not yet set"); return _table_base_offset; }
 196 
 197     void emit(CodeBuffer& cb);
 198 
 199     // Returns the offset of the last entry (the top) of the constant table.
 200     int  top_offset() const { assert(_constants.top().offset() != -1, "constant not yet bound"); return _constants.top().offset(); }
 201 
 202     void calculate_offsets_and_size();
 203     int  find_offset(Constant& con) const;
 204 
 205     void     add(Constant& con);
 206     Constant add(BasicType type, jvalue value);
 207     Constant add(MachOper* oper);
 208     Constant add(jfloat f) {
 209       jvalue value; value.f = f;
 210       return add(T_FLOAT, value);
 211     }
 212     Constant add(jdouble d) {
 213       jvalue value; value.d = d;
 214       return add(T_DOUBLE, value);
 215     }
 216 
 217     // Jump table
 218     Constant allocate_jump_table(MachConstantNode* n);
 219     void         fill_jump_table(CodeBuffer& cb, MachConstantNode* n, GrowableArray<Label*> labels) const;
 220   };
 221 
 222  private:
 223   // Fixed parameters to this compilation.
 224   const int             _compile_id;
 225   const bool            _save_argument_registers; // save/restore arg regs for trampolines
 226   const bool            _subsume_loads;         // Load can be matched as part of a larger op.
 227   const bool            _do_escape_analysis;    // Do escape analysis.
 228   ciMethod*             _method;                // The method being compiled.
 229   int                   _entry_bci;             // entry bci for osr methods.
 230   const TypeFunc*       _tf;                    // My kind of signature
 231   InlineTree*           _ilt;                   // Ditto (temporary).
 232   address               _stub_function;         // VM entry for stub being compiled, or NULL
 233   const char*           _stub_name;             // Name of stub or adapter being compiled, or NULL
 234   address               _stub_entry_point;      // Compile code entry for generated stub, or NULL
 235 
 236   // Control of this compilation.
 237   int                   _num_loop_opts;         // Number of iterations for doing loop optimiztions
 238   int                   _max_inline_size;       // Max inline size for this compilation
 239   int                   _freq_inline_size;      // Max hot method inline size for this compilation
 240   int                   _fixed_slots;           // count of frame slots not allocated by the register
 241                                                 // allocator i.e. locks, original deopt pc, etc.
 242   // For deopt
 243   int                   _orig_pc_slot;
 244   int                   _orig_pc_slot_offset_in_bytes;
 245 
 246   int                   _major_progress;        // Count of something big happening
 247   bool                  _has_loops;             // True if the method _may_ have some loops
 248   bool                  _has_split_ifs;         // True if the method _may_ have some split-if
 249   bool                  _has_unsafe_access;     // True if the method _may_ produce faults in unsafe loads or stores.
 250   bool                  _has_stringbuilder;     // True StringBuffers or StringBuilders are allocated
 251   uint                  _trap_hist[trapHistLength];  // Cumulative traps
 252   bool                  _trap_can_recompile;    // Have we emitted a recompiling trap?
 253   uint                  _decompile_count;       // Cumulative decompilation counts.
 254   bool                  _do_inlining;           // True if we intend to do inlining
 255   bool                  _do_scheduling;         // True if we intend to do scheduling
 256   bool                  _do_freq_based_layout;  // True if we intend to do frequency based block layout
 257   bool                  _do_count_invocations;  // True if we generate code to count invocations
 258   bool                  _do_method_data_update; // True if we generate code to update methodDataOops
 259   int                   _AliasLevel;            // Locally-adjusted version of AliasLevel flag.
 260   bool                  _print_assembly;        // True if we should dump assembly code for this compilation
 261 #ifndef PRODUCT
 262   bool                  _trace_opto_output;
 263   bool                  _parsed_irreducible_loop; // True if ciTypeFlow detected irreducible loops during parsing
 264 #endif
 265 
 266   // JSR 292
 267   bool                  _has_method_handle_invokes; // True if this method has MethodHandle invokes.
 268 
 269   // Compilation environment.
 270   Arena                 _comp_arena;            // Arena with lifetime equivalent to Compile
 271   ciEnv*                _env;                   // CI interface
 272   CompileLog*           _log;                   // from CompilerThread
 273   const char*           _failure_reason;        // for record_failure/failing pattern
 274   GrowableArray<CallGenerator*>* _intrinsics;   // List of intrinsics.
 275   GrowableArray<Node*>* _macro_nodes;           // List of nodes which need to be expanded before matching.
 276   GrowableArray<Node*>* _predicate_opaqs;       // List of Opaque1 nodes for the loop predicates.
 277   ConnectionGraph*      _congraph;
 278 #ifndef PRODUCT
 279   IdealGraphPrinter*    _printer;
 280 #endif
 281 
 282   // Node management
 283   uint                  _unique;                // Counter for unique Node indices
 284   debug_only(static int _debug_idx;)            // Monotonic counter (not reset), use -XX:BreakAtNode=<idx>
 285   Arena                 _node_arena;            // Arena for new-space Nodes
 286   Arena                 _old_arena;             // Arena for old-space Nodes, lifetime during xform
 287   RootNode*             _root;                  // Unique root of compilation, or NULL after bail-out.
 288   Node*                 _top;                   // Unique top node.  (Reset by various phases.)
 289 
 290   Node*                 _immutable_memory;      // Initial memory state
 291 
 292   Node*                 _recent_alloc_obj;
 293   Node*                 _recent_alloc_ctl;
 294 
 295   // Constant table
 296   ConstantTable         _constant_table;        // The constant table for this compile.
 297   MachConstantBaseNode* _mach_constant_base_node;  // Constant table base node singleton.
 298 
 299 
 300   // Blocked array of debugging and profiling information,
 301   // tracked per node.
 302   enum { _log2_node_notes_block_size = 8,
 303          _node_notes_block_size = (1<<_log2_node_notes_block_size)
 304   };
 305   GrowableArray<Node_Notes*>* _node_note_array;
 306   Node_Notes*           _default_node_notes;  // default notes for new nodes
 307 
 308   // After parsing and every bulk phase we hang onto the Root instruction.
 309   // The RootNode instruction is where the whole program begins.  It produces
 310   // the initial Control and BOTTOM for everybody else.
 311 
 312   // Type management
 313   Arena                 _Compile_types;         // Arena for all types
 314   Arena*                _type_arena;            // Alias for _Compile_types except in Initialize_shared()
 315   Dict*                 _type_dict;             // Intern table
 316   void*                 _type_hwm;              // Last allocation (see Type::operator new/delete)
 317   size_t                _type_last_size;        // Last allocation size (see Type::operator new/delete)
 318   ciMethod*             _last_tf_m;             // Cache for
 319   const TypeFunc*       _last_tf;               //  TypeFunc::make
 320   AliasType**           _alias_types;           // List of alias types seen so far.
 321   int                   _num_alias_types;       // Logical length of _alias_types
 322   int                   _max_alias_types;       // Physical length of _alias_types
 323   AliasCacheEntry       _alias_cache[AliasCacheSize]; // Gets aliases w/o data structure walking
 324 
 325   // Parsing, optimization
 326   PhaseGVN*             _initial_gvn;           // Results of parse-time PhaseGVN
 327   Unique_Node_List*     _for_igvn;              // Initial work-list for next round of Iterative GVN
 328   WarmCallInfo*         _warm_calls;            // Sorted work-list for heat-based inlining.
 329 
 330   GrowableArray<CallGenerator*> _late_inlines;  // List of CallGenerators to be revisited after
 331                                                 // main parsing has finished.
 332 
 333   // Matching, CFG layout, allocation, code generation
 334   PhaseCFG*             _cfg;                   // Results of CFG finding
 335   bool                  _select_24_bit_instr;   // We selected an instruction with a 24-bit result
 336   bool                  _in_24_bit_fp_mode;     // We are emitting instructions with 24-bit results
 337   int                   _java_calls;            // Number of java calls in the method
 338   int                   _inner_loops;           // Number of inner loops in the method
 339   Matcher*              _matcher;               // Engine to map ideal to machine instructions
 340   PhaseRegAlloc*        _regalloc;              // Results of register allocation.
 341   int                   _frame_slots;           // Size of total frame in stack slots
 342   CodeOffsets           _code_offsets;          // Offsets into the code for various interesting entries
 343   RegMask               _FIRST_STACK_mask;      // All stack slots usable for spills (depends on frame layout)
 344   Arena*                _indexSet_arena;        // control IndexSet allocation within PhaseChaitin
 345   void*                 _indexSet_free_block_list; // free list of IndexSet bit blocks
 346 
 347   uint                  _node_bundling_limit;
 348   Bundle*               _node_bundling_base;    // Information for instruction bundling
 349 
 350   // Instruction bits passed off to the VM
 351   int                   _method_size;           // Size of nmethod code segment in bytes
 352   CodeBuffer            _code_buffer;           // Where the code is assembled
 353   int                   _first_block_size;      // Size of unvalidated entry point code / OSR poison code
 354   ExceptionHandlerTable _handler_table;         // Table of native-code exception handlers
 355   ImplicitExceptionTable _inc_table;            // Table of implicit null checks in native code
 356   OopMapSet*            _oop_map_set;           // Table of oop maps (one for each safepoint location)
 357   static int            _CompiledZap_count;     // counter compared against CompileZap[First/Last]
 358   BufferBlob*           _scratch_buffer_blob;   // For temporary code buffers.
 359   relocInfo*            _scratch_locs_memory;   // For temporary code buffers.
 360   int                   _scratch_const_size;    // For temporary code buffers.
 361   bool                  _in_scratch_emit_size;  // true when in scratch_emit_size.
 362 
 363  public:
 364   // Accessors
 365 
 366   // The Compile instance currently active in this (compiler) thread.
 367   static Compile* current() {
 368     return (Compile*) ciEnv::current()->compiler_data();
 369   }
 370 
 371   // ID for this compilation.  Useful for setting breakpoints in the debugger.
 372   int               compile_id() const          { return _compile_id; }
 373 
 374   // Does this compilation allow instructions to subsume loads?  User
 375   // instructions that subsume a load may result in an unschedulable
 376   // instruction sequence.
 377   bool              subsume_loads() const       { return _subsume_loads; }
 378   // Do escape analysis.
 379   bool              do_escape_analysis() const  { return _do_escape_analysis; }
 380   bool              save_argument_registers() const { return _save_argument_registers; }
 381 
 382 
 383   // Other fixed compilation parameters.
 384   ciMethod*         method() const              { return _method; }
 385   int               entry_bci() const           { return _entry_bci; }
 386   bool              is_osr_compilation() const  { return _entry_bci != InvocationEntryBci; }
 387   bool              is_method_compilation() const { return (_method != NULL && !_method->flags().is_native()); }
 388   const TypeFunc*   tf() const                  { assert(_tf!=NULL, ""); return _tf; }
 389   void         init_tf(const TypeFunc* tf)      { assert(_tf==NULL, ""); _tf = tf; }
 390   InlineTree*       ilt() const                 { return _ilt; }
 391   address           stub_function() const       { return _stub_function; }
 392   const char*       stub_name() const           { return _stub_name; }
 393   address           stub_entry_point() const    { return _stub_entry_point; }
 394 
 395   // Control of this compilation.
 396   int               fixed_slots() const         { assert(_fixed_slots >= 0, "");         return _fixed_slots; }
 397   void          set_fixed_slots(int n)          { _fixed_slots = n; }
 398   int               major_progress() const      { return _major_progress; }
 399   void          set_major_progress()            { _major_progress++; }
 400   void        clear_major_progress()            { _major_progress = 0; }
 401   int               num_loop_opts() const       { return _num_loop_opts; }
 402   void          set_num_loop_opts(int n)        { _num_loop_opts = n; }
 403   int               max_inline_size() const     { return _max_inline_size; }
 404   void          set_freq_inline_size(int n)     { _freq_inline_size = n; }
 405   int               freq_inline_size() const    { return _freq_inline_size; }
 406   void          set_max_inline_size(int n)      { _max_inline_size = n; }
 407   bool              has_loops() const           { return _has_loops; }
 408   void          set_has_loops(bool z)           { _has_loops = z; }
 409   bool              has_split_ifs() const       { return _has_split_ifs; }
 410   void          set_has_split_ifs(bool z)       { _has_split_ifs = z; }
 411   bool              has_unsafe_access() const   { return _has_unsafe_access; }
 412   void          set_has_unsafe_access(bool z)   { _has_unsafe_access = z; }
 413   bool              has_stringbuilder() const   { return _has_stringbuilder; }
 414   void          set_has_stringbuilder(bool z)   { _has_stringbuilder = z; }
 415   void          set_trap_count(uint r, uint c)  { assert(r < trapHistLength, "oob");        _trap_hist[r] = c; }
 416   uint              trap_count(uint r) const    { assert(r < trapHistLength, "oob"); return _trap_hist[r]; }
 417   bool              trap_can_recompile() const  { return _trap_can_recompile; }
 418   void          set_trap_can_recompile(bool z)  { _trap_can_recompile = z; }
 419   uint              decompile_count() const     { return _decompile_count; }
 420   void          set_decompile_count(uint c)     { _decompile_count = c; }
 421   bool              allow_range_check_smearing() const;
 422   bool              do_inlining() const         { return _do_inlining; }
 423   void          set_do_inlining(bool z)         { _do_inlining = z; }
 424   bool              do_scheduling() const       { return _do_scheduling; }
 425   void          set_do_scheduling(bool z)       { _do_scheduling = z; }
 426   bool              do_freq_based_layout() const{ return _do_freq_based_layout; }
 427   void          set_do_freq_based_layout(bool z){ _do_freq_based_layout = z; }
 428   bool              do_count_invocations() const{ return _do_count_invocations; }
 429   void          set_do_count_invocations(bool z){ _do_count_invocations = z; }
 430   bool              do_method_data_update() const { return _do_method_data_update; }
 431   void          set_do_method_data_update(bool z) { _do_method_data_update = z; }
 432   int               AliasLevel() const          { return _AliasLevel; }
 433   bool              print_assembly() const       { return _print_assembly; }
 434   void          set_print_assembly(bool z)       { _print_assembly = z; }
 435   // check the CompilerOracle for special behaviours for this compile
 436   bool          method_has_option(const char * option) {
 437     return method() != NULL && method()->has_option(option);
 438   }
 439 #ifndef PRODUCT
 440   bool          trace_opto_output() const       { return _trace_opto_output; }
 441   bool              parsed_irreducible_loop() const { return _parsed_irreducible_loop; }
 442   void          set_parsed_irreducible_loop(bool z) { _parsed_irreducible_loop = z; }
 443 #endif
 444 
 445   // JSR 292
 446   bool              has_method_handle_invokes() const { return _has_method_handle_invokes;     }
 447   void          set_has_method_handle_invokes(bool z) {        _has_method_handle_invokes = z; }
 448 
 449   void begin_method() {
 450 #ifndef PRODUCT
 451     if (_printer) _printer->begin_method(this);
 452 #endif
 453   }
 454   void print_method(const char * name, int level = 1) {
 455 #ifndef PRODUCT
 456     if (_printer) _printer->print_method(this, name, level);
 457 #endif
 458   }
 459   void end_method() {
 460 #ifndef PRODUCT
 461     if (_printer) _printer->end_method();
 462 #endif
 463   }
 464 
 465   int           macro_count()                   { return _macro_nodes->length(); }
 466   int           predicate_count()               { return _predicate_opaqs->length();}
 467   Node*         macro_node(int idx)             { return _macro_nodes->at(idx); }
 468   Node*         predicate_opaque1_node(int idx) { return _predicate_opaqs->at(idx);}
 469   ConnectionGraph* congraph()                   { return _congraph;}
 470   void set_congraph(ConnectionGraph* congraph)  { _congraph = congraph;}
 471   void add_macro_node(Node * n) {
 472     //assert(n->is_macro(), "must be a macro node");
 473     assert(!_macro_nodes->contains(n), " duplicate entry in expand list");
 474     _macro_nodes->append(n);
 475   }
 476   void remove_macro_node(Node * n) {
 477     // this function may be called twice for a node so check
 478     // that the node is in the array before attempting to remove it
 479     if (_macro_nodes->contains(n))
 480       _macro_nodes->remove(n);
 481     // remove from _predicate_opaqs list also if it is there
 482     if (predicate_count() > 0 && _predicate_opaqs->contains(n)){
 483       _predicate_opaqs->remove(n);
 484     }
 485   }
 486   void add_predicate_opaq(Node * n) {
 487     assert(!_predicate_opaqs->contains(n), " duplicate entry in predicate opaque1");
 488     assert(_macro_nodes->contains(n), "should have already been in macro list");
 489     _predicate_opaqs->append(n);
 490   }
 491   // remove the opaque nodes that protect the predicates so that the unused checks and
 492   // uncommon traps will be eliminated from the graph.
 493   void cleanup_loop_predicates(PhaseIterGVN &igvn);
 494   bool is_predicate_opaq(Node * n) {
 495     return _predicate_opaqs->contains(n);
 496   }
 497 
 498   // Compilation environment.
 499   Arena*            comp_arena()                { return &_comp_arena; }
 500   ciEnv*            env() const                 { return _env; }
 501   CompileLog*       log() const                 { return _log; }
 502   bool              failing() const             { return _env->failing() || _failure_reason != NULL; }
 503   const char* failure_reason() { return _failure_reason; }
 504   bool              failure_reason_is(const char* r) { return (r==_failure_reason) || (r!=NULL && _failure_reason!=NULL && strcmp(r, _failure_reason)==0); }
 505 
 506   void record_failure(const char* reason);
 507   void record_method_not_compilable(const char* reason, bool all_tiers = false) {
 508     // All bailouts cover "all_tiers" when TieredCompilation is off.
 509     if (!TieredCompilation) all_tiers = true;
 510     env()->record_method_not_compilable(reason, all_tiers);
 511     // Record failure reason.
 512     record_failure(reason);
 513   }
 514   void record_method_not_compilable_all_tiers(const char* reason) {
 515     record_method_not_compilable(reason, true);
 516   }
 517   bool check_node_count(uint margin, const char* reason) {
 518     if (unique() + margin > (uint)MaxNodeLimit) {
 519       record_method_not_compilable(reason);
 520       return true;
 521     } else {
 522       return false;
 523     }
 524   }
 525 
 526   // Node management
 527   uint              unique() const              { return _unique; }
 528   uint         next_unique()                    { return _unique++; }
 529   void          set_unique(uint i)              { _unique = i; }
 530   static int        debug_idx()                 { return debug_only(_debug_idx)+0; }
 531   static void   set_debug_idx(int i)            { debug_only(_debug_idx = i); }
 532   Arena*            node_arena()                { return &_node_arena; }
 533   Arena*            old_arena()                 { return &_old_arena; }
 534   RootNode*         root() const                { return _root; }
 535   void          set_root(RootNode* r)           { _root = r; }
 536   StartNode*        start() const;              // (Derived from root.)
 537   void         init_start(StartNode* s);
 538   Node*             immutable_memory();
 539 
 540   Node*             recent_alloc_ctl() const    { return _recent_alloc_ctl; }
 541   Node*             recent_alloc_obj() const    { return _recent_alloc_obj; }
 542   void          set_recent_alloc(Node* ctl, Node* obj) {
 543                                                   _recent_alloc_ctl = ctl;
 544                                                   _recent_alloc_obj = obj;
 545                                                 }
 546 
 547   // Constant table
 548   ConstantTable&   constant_table() { return _constant_table; }
 549 
 550   MachConstantBaseNode*     mach_constant_base_node();
 551   bool                  has_mach_constant_base_node() const { return _mach_constant_base_node != NULL; }
 552 
 553   // Handy undefined Node
 554   Node*             top() const                 { return _top; }
 555 
 556   // these are used by guys who need to know about creation and transformation of top:
 557   Node*             cached_top_node()           { return _top; }
 558   void          set_cached_top_node(Node* tn);
 559 
 560   GrowableArray<Node_Notes*>* node_note_array() const { return _node_note_array; }
 561   void set_node_note_array(GrowableArray<Node_Notes*>* arr) { _node_note_array = arr; }
 562   Node_Notes* default_node_notes() const        { return _default_node_notes; }
 563   void    set_default_node_notes(Node_Notes* n) { _default_node_notes = n; }
 564 
 565   Node_Notes*       node_notes_at(int idx) {
 566     return locate_node_notes(_node_note_array, idx, false);
 567   }
 568   inline bool   set_node_notes_at(int idx, Node_Notes* value);
 569 
 570   // Copy notes from source to dest, if they exist.
 571   // Overwrite dest only if source provides something.
 572   // Return true if information was moved.
 573   bool copy_node_notes_to(Node* dest, Node* source);
 574 
 575   // Workhorse function to sort out the blocked Node_Notes array:
 576   inline Node_Notes* locate_node_notes(GrowableArray<Node_Notes*>* arr,
 577                                        int idx, bool can_grow = false);
 578 
 579   void grow_node_notes(GrowableArray<Node_Notes*>* arr, int grow_by);
 580 
 581   // Type management
 582   Arena*            type_arena()                { return _type_arena; }
 583   Dict*             type_dict()                 { return _type_dict; }
 584   void*             type_hwm()                  { return _type_hwm; }
 585   size_t            type_last_size()            { return _type_last_size; }
 586   int               num_alias_types()           { return _num_alias_types; }
 587 
 588   void          init_type_arena()                       { _type_arena = &_Compile_types; }
 589   void          set_type_arena(Arena* a)                { _type_arena = a; }
 590   void          set_type_dict(Dict* d)                  { _type_dict = d; }
 591   void          set_type_hwm(void* p)                   { _type_hwm = p; }
 592   void          set_type_last_size(size_t sz)           { _type_last_size = sz; }
 593 
 594   const TypeFunc* last_tf(ciMethod* m) {
 595     return (m == _last_tf_m) ? _last_tf : NULL;
 596   }
 597   void set_last_tf(ciMethod* m, const TypeFunc* tf) {
 598     assert(m != NULL || tf == NULL, "");
 599     _last_tf_m = m;
 600     _last_tf = tf;
 601   }
 602 
 603   AliasType*        alias_type(int                idx)  { assert(idx < num_alias_types(), "oob"); return _alias_types[idx]; }
 604   AliasType*        alias_type(const TypePtr* adr_type, ciField* field = NULL) { return find_alias_type(adr_type, false, field); }
 605   bool         have_alias_type(const TypePtr* adr_type);
 606   AliasType*        alias_type(ciField*         field);
 607 
 608   int               get_alias_index(const TypePtr* at)  { return alias_type(at)->index(); }
 609   const TypePtr*    get_adr_type(uint aidx)             { return alias_type(aidx)->adr_type(); }
 610   int               get_general_index(uint aidx)        { return alias_type(aidx)->general_index(); }
 611 
 612   // Building nodes
 613   void              rethrow_exceptions(JVMState* jvms);
 614   void              return_values(JVMState* jvms);
 615   JVMState*         build_start_state(StartNode* start, const TypeFunc* tf);
 616 
 617   // Decide how to build a call.
 618   // The profile factor is a discount to apply to this site's interp. profile.
 619   CallGenerator*    call_generator(ciMethod* call_method, int vtable_index, bool call_is_virtual, JVMState* jvms, bool allow_inline, float profile_factor);
 620   bool should_delay_inlining(ciMethod* call_method, JVMState* jvms);
 621 
 622   // Report if there were too many traps at a current method and bci.
 623   // Report if a trap was recorded, and/or PerMethodTrapLimit was exceeded.
 624   // If there is no MDO at all, report no trap unless told to assume it.
 625   bool too_many_traps(ciMethod* method, int bci, Deoptimization::DeoptReason reason);
 626   // This version, unspecific to a particular bci, asks if
 627   // PerMethodTrapLimit was exceeded for all inlined methods seen so far.
 628   bool too_many_traps(Deoptimization::DeoptReason reason,
 629                       // Privately used parameter for logging:
 630                       ciMethodData* logmd = NULL);
 631   // Report if there were too many recompiles at a method and bci.
 632   bool too_many_recompiles(ciMethod* method, int bci, Deoptimization::DeoptReason reason);
 633 
 634   // Parsing, optimization
 635   PhaseGVN*         initial_gvn()               { return _initial_gvn; }
 636   Unique_Node_List* for_igvn()                  { return _for_igvn; }
 637   inline void       record_for_igvn(Node* n);   // Body is after class Unique_Node_List.
 638   void          set_initial_gvn(PhaseGVN *gvn)           { _initial_gvn = gvn; }
 639   void          set_for_igvn(Unique_Node_List *for_igvn) { _for_igvn = for_igvn; }
 640 
 641   // Replace n by nn using initial_gvn, calling hash_delete and
 642   // record_for_igvn as needed.
 643   void gvn_replace_by(Node* n, Node* nn);
 644 
 645 
 646   void              identify_useful_nodes(Unique_Node_List &useful);
 647   void              remove_useless_nodes  (Unique_Node_List &useful);
 648 
 649   WarmCallInfo*     warm_calls() const          { return _warm_calls; }
 650   void          set_warm_calls(WarmCallInfo* l) { _warm_calls = l; }
 651   WarmCallInfo* pop_warm_call();
 652 
 653   // Record this CallGenerator for inlining at the end of parsing.
 654   void              add_late_inline(CallGenerator* cg) { _late_inlines.push(cg); }
 655 
 656   // Matching, CFG layout, allocation, code generation
 657   PhaseCFG*         cfg()                       { return _cfg; }
 658   bool              select_24_bit_instr() const { return _select_24_bit_instr; }
 659   bool              in_24_bit_fp_mode() const   { return _in_24_bit_fp_mode; }
 660   bool              has_java_calls() const      { return _java_calls > 0; }
 661   int               java_calls() const          { return _java_calls; }
 662   int               inner_loops() const         { return _inner_loops; }
 663   Matcher*          matcher()                   { return _matcher; }
 664   PhaseRegAlloc*    regalloc()                  { return _regalloc; }
 665   int               frame_slots() const         { return _frame_slots; }
 666   int               frame_size_in_words() const; // frame_slots in units of the polymorphic 'words'
 667   RegMask&          FIRST_STACK_mask()          { return _FIRST_STACK_mask; }
 668   Arena*            indexSet_arena()            { return _indexSet_arena; }
 669   void*             indexSet_free_block_list()  { return _indexSet_free_block_list; }
 670   uint              node_bundling_limit()       { return _node_bundling_limit; }
 671   Bundle*           node_bundling_base()        { return _node_bundling_base; }
 672   void          set_node_bundling_limit(uint n) { _node_bundling_limit = n; }
 673   void          set_node_bundling_base(Bundle* b) { _node_bundling_base = b; }
 674   bool          starts_bundle(const Node *n) const;
 675   bool          need_stack_bang(int frame_size_in_bytes) const;
 676   bool          need_register_stack_bang() const;
 677 
 678   void          set_matcher(Matcher* m)                 { _matcher = m; }
 679 //void          set_regalloc(PhaseRegAlloc* ra)           { _regalloc = ra; }
 680   void          set_indexSet_arena(Arena* a)            { _indexSet_arena = a; }
 681   void          set_indexSet_free_block_list(void* p)   { _indexSet_free_block_list = p; }
 682 
 683   // Remember if this compilation changes hardware mode to 24-bit precision
 684   void set_24_bit_selection_and_mode(bool selection, bool mode) {
 685     _select_24_bit_instr = selection;
 686     _in_24_bit_fp_mode   = mode;
 687   }
 688 
 689   void  set_java_calls(int z) { _java_calls  = z; }
 690   void set_inner_loops(int z) { _inner_loops = z; }
 691 
 692   // Instruction bits passed off to the VM
 693   int               code_size()                 { return _method_size; }
 694   CodeBuffer*       code_buffer()               { return &_code_buffer; }
 695   int               first_block_size()          { return _first_block_size; }
 696   void              set_frame_complete(int off) { _code_offsets.set_value(CodeOffsets::Frame_Complete, off); }
 697   ExceptionHandlerTable*  handler_table()       { return &_handler_table; }
 698   ImplicitExceptionTable* inc_table()           { return &_inc_table; }
 699   OopMapSet*        oop_map_set()               { return _oop_map_set; }
 700   DebugInformationRecorder* debug_info()        { return env()->debug_info(); }
 701   Dependencies*     dependencies()              { return env()->dependencies(); }
 702   static int        CompiledZap_count()         { return _CompiledZap_count; }
 703   BufferBlob*       scratch_buffer_blob()       { return _scratch_buffer_blob; }
 704   void         init_scratch_buffer_blob(int const_size);
 705   void        clear_scratch_buffer_blob();
 706   void          set_scratch_buffer_blob(BufferBlob* b) { _scratch_buffer_blob = b; }
 707   relocInfo*        scratch_locs_memory()       { return _scratch_locs_memory; }
 708   void          set_scratch_locs_memory(relocInfo* b)  { _scratch_locs_memory = b; }
 709 
 710   // emit to scratch blob, report resulting size
 711   uint              scratch_emit_size(const Node* n);
 712   void       set_in_scratch_emit_size(bool x)   {        _in_scratch_emit_size = x; }
 713   bool           in_scratch_emit_size() const   { return _in_scratch_emit_size;     }
 714 
 715   enum ScratchBufferBlob {
 716     MAX_inst_size       = 1024,
 717     MAX_locs_size       = 128, // number of relocInfo elements
 718     MAX_const_size      = 128,
 719     MAX_stubs_size      = 128
 720   };
 721 
 722   // Major entry point.  Given a Scope, compile the associated method.
 723   // For normal compilations, entry_bci is InvocationEntryBci.  For on stack
 724   // replacement, entry_bci indicates the bytecode for which to compile a
 725   // continuation.
 726   Compile(ciEnv* ci_env, C2Compiler* compiler, ciMethod* target,
 727           int entry_bci, bool subsume_loads, bool do_escape_analysis);
 728 
 729   // Second major entry point.  From the TypeFunc signature, generate code
 730   // to pass arguments from the Java calling convention to the C calling
 731   // convention.
 732   Compile(ciEnv* ci_env, const TypeFunc *(*gen)(),
 733           address stub_function, const char *stub_name,
 734           int is_fancy_jump, bool pass_tls,
 735           bool save_arg_registers, bool return_pc);
 736 
 737   // From the TypeFunc signature, generate code to pass arguments
 738   // from Compiled calling convention to Interpreter's calling convention
 739   void Generate_Compiled_To_Interpreter_Graph(const TypeFunc *tf, address interpreter_entry);
 740 
 741   // From the TypeFunc signature, generate code to pass arguments
 742   // from Interpreter's calling convention to Compiler's calling convention
 743   void Generate_Interpreter_To_Compiled_Graph(const TypeFunc *tf);
 744 
 745   // Are we compiling a method?
 746   bool has_method() { return method() != NULL; }
 747 
 748   // Maybe print some information about this compile.
 749   void print_compile_messages();
 750 
 751   // Final graph reshaping, a post-pass after the regular optimizer is done.
 752   bool final_graph_reshaping();
 753 
 754   // returns true if adr is completely contained in the given alias category
 755   bool must_alias(const TypePtr* adr, int alias_idx);
 756 
 757   // returns true if adr overlaps with the given alias category
 758   bool can_alias(const TypePtr* adr, int alias_idx);
 759 
 760   // Driver for converting compiler's IR into machine code bits
 761   void Output();
 762 
 763   // Accessors for node bundling info.
 764   Bundle* node_bundling(const Node *n);
 765   bool valid_bundle_info(const Node *n);
 766 
 767   // Schedule and Bundle the instructions
 768   void ScheduleAndBundle();
 769 
 770   // Build OopMaps for each GC point
 771   void BuildOopMaps();
 772 
 773   // Append debug info for the node "local" at safepoint node "sfpt" to the
 774   // "array",   May also consult and add to "objs", which describes the
 775   // scalar-replaced objects.
 776   void FillLocArray( int idx, MachSafePointNode* sfpt,
 777                      Node *local, GrowableArray<ScopeValue*> *array,
 778                      GrowableArray<ScopeValue*> *objs );
 779 
 780   // If "objs" contains an ObjectValue whose id is "id", returns it, else NULL.
 781   static ObjectValue* sv_for_node_id(GrowableArray<ScopeValue*> *objs, int id);
 782   // Requres that "objs" does not contains an ObjectValue whose id matches
 783   // that of "sv.  Appends "sv".
 784   static void set_sv_for_object_node(GrowableArray<ScopeValue*> *objs,
 785                                      ObjectValue* sv );
 786 
 787   // Process an OopMap Element while emitting nodes
 788   void Process_OopMap_Node(MachNode *mach, int code_offset);
 789 
 790   // Initialize code buffer
 791   CodeBuffer* init_buffer(uint* blk_starts);
 792 
 793   // Write out basic block data to code buffer
 794   void fill_buffer(CodeBuffer* cb, uint* blk_starts);
 795 
 796   // Determine which variable sized branches can be shortened
 797   void shorten_branches(uint* blk_starts, int& code_size, int& reloc_size, int& stub_size);
 798 
 799   // Compute the size of first NumberOfLoopInstrToAlign instructions
 800   // at the head of a loop.
 801   void compute_loop_first_inst_sizes();
 802 
 803   // Compute the information for the exception tables
 804   void FillExceptionTables(uint cnt, uint *call_returns, uint *inct_starts, Label *blk_labels);
 805 
 806   // Stack slots that may be unused by the calling convention but must
 807   // otherwise be preserved.  On Intel this includes the return address.
 808   // On PowerPC it includes the 4 words holding the old TOC & LR glue.
 809   uint in_preserve_stack_slots();
 810 
 811   // "Top of Stack" slots that may be unused by the calling convention but must
 812   // otherwise be preserved.
 813   // On Intel these are not necessary and the value can be zero.
 814   // On Sparc this describes the words reserved for storing a register window
 815   // when an interrupt occurs.
 816   static uint out_preserve_stack_slots();
 817 
 818   // Number of outgoing stack slots killed above the out_preserve_stack_slots
 819   // for calls to C.  Supports the var-args backing area for register parms.
 820   uint varargs_C_out_slots_killed() const;
 821 
 822   // Number of Stack Slots consumed by a synchronization entry
 823   int sync_stack_slots() const;
 824 
 825   // Compute the name of old_SP.  See <arch>.ad for frame layout.
 826   OptoReg::Name compute_old_SP();
 827 
 828 #ifdef ENABLE_ZAP_DEAD_LOCALS
 829   static bool is_node_getting_a_safepoint(Node*);
 830   void Insert_zap_nodes();
 831   Node* call_zap_node(MachSafePointNode* n, int block_no);
 832 #endif
 833 
 834  private:
 835   // Phase control:
 836   void Init(int aliaslevel);                     // Prepare for a single compilation
 837   int  Inline_Warm();                            // Find more inlining work.
 838   void Finish_Warm();                            // Give up on further inlines.
 839   void Optimize();                               // Given a graph, optimize it
 840   void Code_Gen();                               // Generate code from a graph
 841 
 842   // Management of the AliasType table.
 843   void grow_alias_types();
 844   AliasCacheEntry* probe_alias_cache(const TypePtr* adr_type);
 845   const TypePtr *flatten_alias_type(const TypePtr* adr_type) const;
 846   AliasType* find_alias_type(const TypePtr* adr_type, bool no_create, ciField* field);
 847 
 848   void verify_top(Node*) const PRODUCT_RETURN;
 849 
 850   // Intrinsic setup.
 851   void           register_library_intrinsics();                            // initializer
 852   CallGenerator* make_vm_intrinsic(ciMethod* m, bool is_virtual);          // constructor
 853   int            intrinsic_insertion_index(ciMethod* m, bool is_virtual);  // helper
 854   CallGenerator* find_intrinsic(ciMethod* m, bool is_virtual);             // query fn
 855   void           register_intrinsic(CallGenerator* cg);                    // update fn
 856 
 857 #ifndef PRODUCT
 858   static juint  _intrinsic_hist_count[vmIntrinsics::ID_LIMIT];
 859   static jubyte _intrinsic_hist_flags[vmIntrinsics::ID_LIMIT];
 860 #endif
 861 
 862  public:
 863 
 864   // Note:  Histogram array size is about 1 Kb.
 865   enum {                        // flag bits:
 866     _intrinsic_worked = 1,      // succeeded at least once
 867     _intrinsic_failed = 2,      // tried it but it failed
 868     _intrinsic_disabled = 4,    // was requested but disabled (e.g., -XX:-InlineUnsafeOps)
 869     _intrinsic_virtual = 8,     // was seen in the virtual form (rare)
 870     _intrinsic_both = 16        // was seen in the non-virtual form (usual)
 871   };
 872   // Update histogram.  Return boolean if this is a first-time occurrence.
 873   static bool gather_intrinsic_statistics(vmIntrinsics::ID id,
 874                                           bool is_virtual, int flags) PRODUCT_RETURN0;
 875   static void print_intrinsic_statistics() PRODUCT_RETURN;
 876 
 877   // Graph verification code
 878   // Walk the node list, verifying that there is a one-to-one
 879   // correspondence between Use-Def edges and Def-Use edges
 880   // The option no_dead_code enables stronger checks that the
 881   // graph is strongly connected from root in both directions.
 882   void verify_graph_edges(bool no_dead_code = false) PRODUCT_RETURN;
 883 
 884   // Print bytecodes, including the scope inlining tree
 885   void print_codes();
 886 
 887   // End-of-run dumps.
 888   static void print_statistics() PRODUCT_RETURN;
 889 
 890   // Dump formatted assembly
 891   void dump_asm(int *pcs = NULL, uint pc_limit = 0) PRODUCT_RETURN;
 892   void dump_pc(int *pcs, int pc_limit, Node *n);
 893 
 894   // Verify ADLC assumptions during startup
 895   static void adlc_verification() PRODUCT_RETURN;
 896 
 897   // Definitions of pd methods
 898   static void pd_compiler2_init();
 899 };
 900 
 901 #endif // SHARE_VM_OPTO_COMPILE_HPP