1 /*
   2  * Copyright (c) 1997, 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_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 "compiler/compileBroker.hpp"
  34 #include "libadt/dict.hpp"
  35 #include "libadt/vectset.hpp"
  36 #include "memory/resourceArea.hpp"
  37 #include "opto/idealGraphPrinter.hpp"
  38 #include "opto/phasetype.hpp"
  39 #include "opto/phase.hpp"
  40 #include "opto/regmask.hpp"
  41 #include "runtime/deoptimization.hpp"
  42 #include "runtime/vmThread.hpp"
  43 #include "trace/tracing.hpp"
  44 #include "utilities/ticks.hpp"
  45 
  46 class Block;
  47 class Bundle;
  48 class C2Compiler;
  49 class CallGenerator;
  50 class CloneMap;
  51 class ConnectionGraph;
  52 class InlineTree;
  53 class Int_Array;
  54 class Matcher;
  55 class MachConstantNode;
  56 class MachConstantBaseNode;
  57 class MachNode;
  58 class MachOper;
  59 class MachSafePointNode;
  60 class Node;
  61 class Node_Array;
  62 class Node_Notes;
  63 class NodeCloneInfo;
  64 class OptoReg;
  65 class PhaseCFG;
  66 class PhaseGVN;
  67 class PhaseIterGVN;
  68 class PhaseRegAlloc;
  69 class PhaseCCP;
  70 class PhaseCCP_DCE;
  71 class RootNode;
  72 class relocInfo;
  73 class Scope;
  74 class StartNode;
  75 class SafePointNode;
  76 class JVMState;
  77 class Type;
  78 class TypeData;
  79 class TypeInt;
  80 class TypePtr;
  81 class TypeOopPtr;
  82 class TypeFunc;
  83 class Unique_Node_List;
  84 class nmethod;
  85 class WarmCallInfo;
  86 class Node_Stack;
  87 struct Final_Reshape_Counts;
  88 
  89 typedef unsigned int node_idx_t;
  90 class NodeCloneInfo {
  91  private:
  92   uint64_t  _idx_clone_orig;
  93  public:
  94 
  95   void set_idx(node_idx_t idx) {
  96     _idx_clone_orig = _idx_clone_orig & 0xFFFFFFFF00000000 | idx;
  97   }
  98   node_idx_t idx() const { return (node_idx_t)(_idx_clone_orig & 0xFFFFFFFF); }
  99 
 100   void set_gen(int generation) {
 101     uint64_t  g = (uint64_t)generation << 32;
 102     _idx_clone_orig = _idx_clone_orig & 0xFFFFFFFF | g;
 103   }
 104   int gen() const { return (int)(_idx_clone_orig >> 32); }
 105 
 106   void set(uint64_t x) {  _idx_clone_orig = x; }
 107   void set(node_idx_t x, int g) {  set_idx(x); set_gen(g); }
 108   uint64_t get() const { return _idx_clone_orig; }
 109 
 110   NodeCloneInfo(uint64_t idx_clone_orig) : _idx_clone_orig(idx_clone_orig) {}
 111   NodeCloneInfo(node_idx_t x, int g) {set(x, g);}
 112 
 113   void dump() const;
 114 };
 115 
 116 class CloneMap {
 117   friend class Compile;
 118  private:
 119   bool      _debug;
 120   Dict*     _dict;
 121   int       _clone_idx;   // current cloning iteration/generation in loop unroll
 122  public:
 123   void*     _2p(node_idx_t key)   const          { return (void*)(intptr_t)key; } // 2 conversion functions to make gcc happy
 124   node_idx_t _2_node_idx_t(const void* k) const  { return (node_idx_t)(intptr_t)k; }
 125   Dict*     dict()                const          { return _dict; }
 126   void insert(node_idx_t key, uint64_t val)      { assert(_dict->operator[](_2p(key)) == NULL, "key existed"); _dict->Insert(_2p(key), (void*)val); }
 127   void insert(node_idx_t key, NodeCloneInfo& ci) { insert(key, ci.get()); }
 128   void remove(node_idx_t key)                    { _dict->Delete(_2p(key)); }
 129   uint64_t value(node_idx_t key)  const          { return (uint64_t)_dict->operator[](_2p(key)); }
 130   node_idx_t idx(node_idx_t key)  const          { return NodeCloneInfo(value(key)).idx(); }
 131   int gen(node_idx_t key)         const          { return NodeCloneInfo(value(key)).gen(); }
 132   int gen(const void* k)          const          { return gen(_2_node_idx_t(k)); }
 133   int max_gen()                   const;
 134   void clone(Node* old, Node* nnn, int gen);
 135   void verify_insert_and_clone(Node* old, Node* nnn, int gen);
 136   void dump(node_idx_t key)       const;
 137 
 138   int  clone_idx() const                         { return _clone_idx; }
 139   void set_clone_idx(int x)                      { _clone_idx = x; }
 140   bool is_debug()                 const          { return _debug; }
 141   void set_debug(bool debug)                     { _debug = debug; }
 142   static const char* debug_option_name;
 143 
 144   bool same_idx(node_idx_t k1, node_idx_t k2)  const { return idx(k1) == idx(k2); }
 145   bool same_gen(node_idx_t k1, node_idx_t k2)  const { return gen(k1) == gen(k2); }
 146 };
 147 
 148 //------------------------------Compile----------------------------------------
 149 // This class defines a top-level Compiler invocation.
 150 
 151 class Compile : public Phase {
 152   friend class VMStructs;
 153 
 154  public:
 155   // Fixed alias indexes.  (See also MergeMemNode.)
 156   enum {
 157     AliasIdxTop = 1,  // pseudo-index, aliases to nothing (used as sentinel value)
 158     AliasIdxBot = 2,  // pseudo-index, aliases to everything
 159     AliasIdxRaw = 3   // hard-wired index for TypeRawPtr::BOTTOM
 160   };
 161 
 162   // Variant of TraceTime(NULL, &_t_accumulator, CITime);
 163   // Integrated with logging.  If logging is turned on, and CITimeVerbose is true,
 164   // then brackets are put into the log, with time stamps and node counts.
 165   // (The time collection itself is always conditionalized on CITime.)
 166   class TracePhase : public TraceTime {
 167    private:
 168     Compile*    C;
 169     CompileLog* _log;
 170     const char* _phase_name;
 171     bool _dolog;
 172    public:
 173     TracePhase(const char* name, elapsedTimer* accumulator);
 174     ~TracePhase();
 175   };
 176 
 177   // Information per category of alias (memory slice)
 178   class AliasType {
 179    private:
 180     friend class Compile;
 181 
 182     int             _index;         // unique index, used with MergeMemNode
 183     const TypePtr*  _adr_type;      // normalized address type
 184     ciField*        _field;         // relevant instance field, or null if none
 185     const Type*     _element;       // relevant array element type, or null if none
 186     bool            _is_rewritable; // false if the memory is write-once only
 187     int             _general_index; // if this is type is an instance, the general
 188                                     // type that this is an instance of
 189 
 190     void Init(int i, const TypePtr* at);
 191 
 192    public:
 193     int             index()         const { return _index; }
 194     const TypePtr*  adr_type()      const { return _adr_type; }
 195     ciField*        field()         const { return _field; }
 196     const Type*     element()       const { return _element; }
 197     bool            is_rewritable() const { return _is_rewritable; }
 198     bool            is_volatile()   const { return (_field ? _field->is_volatile() : false); }
 199     int             general_index() const { return (_general_index != 0) ? _general_index : _index; }
 200 
 201     void set_rewritable(bool z) { _is_rewritable = z; }
 202     void set_field(ciField* f) {
 203       assert(!_field,"");
 204       _field = f;
 205       if (f->is_final() || f->is_stable()) {
 206         // In the case of @Stable, multiple writes are possible but may be assumed to be no-ops.
 207         _is_rewritable = false;
 208       }
 209     }
 210     void set_element(const Type* e) {
 211       assert(_element == NULL, "");
 212       _element = e;
 213     }
 214 
 215     void print_on(outputStream* st) PRODUCT_RETURN;
 216   };
 217 
 218   enum {
 219     logAliasCacheSize = 6,
 220     AliasCacheSize = (1<<logAliasCacheSize)
 221   };
 222   struct AliasCacheEntry { const TypePtr* _adr_type; int _index; };  // simple duple type
 223   enum {
 224     trapHistLength = MethodData::_trap_hist_limit
 225   };
 226 
 227   // Constant entry of the constant table.
 228   class Constant {
 229   private:
 230     BasicType _type;
 231     union {
 232       jvalue    _value;
 233       Metadata* _metadata;
 234     } _v;
 235     int       _offset;         // offset of this constant (in bytes) relative to the constant table base.
 236     float     _freq;
 237     bool      _can_be_reused;  // true (default) if the value can be shared with other users.
 238 
 239   public:
 240     Constant() : _type(T_ILLEGAL), _offset(-1), _freq(0.0f), _can_be_reused(true) { _v._value.l = 0; }
 241     Constant(BasicType type, jvalue value, float freq = 0.0f, bool can_be_reused = true) :
 242       _type(type),
 243       _offset(-1),
 244       _freq(freq),
 245       _can_be_reused(can_be_reused)
 246     {
 247       assert(type != T_METADATA, "wrong constructor");
 248       _v._value = value;
 249     }
 250     Constant(Metadata* metadata, bool can_be_reused = true) :
 251       _type(T_METADATA),
 252       _offset(-1),
 253       _freq(0.0f),
 254       _can_be_reused(can_be_reused)
 255     {
 256       _v._metadata = metadata;
 257     }
 258 
 259     bool operator==(const Constant& other);
 260 
 261     BasicType type()      const    { return _type; }
 262 
 263     jlong   get_jlong()   const    { return _v._value.j; }
 264     jfloat  get_jfloat()  const    { return _v._value.f; }
 265     jdouble get_jdouble() const    { return _v._value.d; }
 266     jobject get_jobject() const    { return _v._value.l; }
 267 
 268     Metadata* get_metadata() const { return _v._metadata; }
 269 
 270     int         offset()  const    { return _offset; }
 271     void    set_offset(int offset) {        _offset = offset; }
 272 
 273     float       freq()    const    { return _freq;         }
 274     void    inc_freq(float freq)   {        _freq += freq; }
 275 
 276     bool    can_be_reused() const  { return _can_be_reused; }
 277   };
 278 
 279   // Constant table.
 280   class ConstantTable {
 281   private:
 282     GrowableArray<Constant> _constants;          // Constants of this table.
 283     int                     _size;               // Size in bytes the emitted constant table takes (including padding).
 284     int                     _table_base_offset;  // Offset of the table base that gets added to the constant offsets.
 285     int                     _nof_jump_tables;    // Number of jump-tables in this constant table.
 286 
 287     static int qsort_comparator(Constant* a, Constant* b);
 288 
 289     // We use negative frequencies to keep the order of the
 290     // jump-tables in which they were added.  Otherwise we get into
 291     // trouble with relocation.
 292     float next_jump_table_freq() { return -1.0f * (++_nof_jump_tables); }
 293 
 294   public:
 295     ConstantTable() :
 296       _size(-1),
 297       _table_base_offset(-1),  // We can use -1 here since the constant table is always bigger than 2 bytes (-(size / 2), see MachConstantBaseNode::emit).
 298       _nof_jump_tables(0)
 299     {}
 300 
 301     int size() const { assert(_size != -1, "not calculated yet"); return _size; }
 302 
 303     int calculate_table_base_offset() const;  // AD specific
 304     void set_table_base_offset(int x)  { assert(_table_base_offset == -1 || x == _table_base_offset, "can't change"); _table_base_offset = x; }
 305     int      table_base_offset() const { assert(_table_base_offset != -1, "not set yet");                      return _table_base_offset; }
 306 
 307     void emit(CodeBuffer& cb);
 308 
 309     // Returns the offset of the last entry (the top) of the constant table.
 310     int  top_offset() const { assert(_constants.top().offset() != -1, "not bound yet"); return _constants.top().offset(); }
 311 
 312     void calculate_offsets_and_size();
 313     int  find_offset(Constant& con) const;
 314 
 315     void     add(Constant& con);
 316     Constant add(MachConstantNode* n, BasicType type, jvalue value);
 317     Constant add(Metadata* metadata);
 318     Constant add(MachConstantNode* n, MachOper* oper);
 319     Constant add(MachConstantNode* n, jfloat f) {
 320       jvalue value; value.f = f;
 321       return add(n, T_FLOAT, value);
 322     }
 323     Constant add(MachConstantNode* n, jdouble d) {
 324       jvalue value; value.d = d;
 325       return add(n, T_DOUBLE, value);
 326     }
 327 
 328     // Jump-table
 329     Constant  add_jump_table(MachConstantNode* n);
 330     void     fill_jump_table(CodeBuffer& cb, MachConstantNode* n, GrowableArray<Label*> labels) const;
 331   };
 332 
 333  private:
 334   // Fixed parameters to this compilation.
 335   const int             _compile_id;
 336   const bool            _save_argument_registers; // save/restore arg regs for trampolines
 337   const bool            _subsume_loads;         // Load can be matched as part of a larger op.
 338   const bool            _do_escape_analysis;    // Do escape analysis.
 339   const bool            _eliminate_boxing;      // Do boxing elimination.
 340   ciMethod*             _method;                // The method being compiled.
 341   int                   _entry_bci;             // entry bci for osr methods.
 342   const TypeFunc*       _tf;                    // My kind of signature
 343   InlineTree*           _ilt;                   // Ditto (temporary).
 344   address               _stub_function;         // VM entry for stub being compiled, or NULL
 345   const char*           _stub_name;             // Name of stub or adapter being compiled, or NULL
 346   address               _stub_entry_point;      // Compile code entry for generated stub, or NULL
 347 
 348   // Control of this compilation.
 349   int                   _num_loop_opts;         // Number of iterations for doing loop optimiztions
 350   int                   _max_inline_size;       // Max inline size for this compilation
 351   int                   _freq_inline_size;      // Max hot method inline size for this compilation
 352   int                   _fixed_slots;           // count of frame slots not allocated by the register
 353                                                 // allocator i.e. locks, original deopt pc, etc.
 354   uintx                 _max_node_limit;        // Max unique node count during a single compilation.
 355   // For deopt
 356   int                   _orig_pc_slot;
 357   int                   _orig_pc_slot_offset_in_bytes;
 358 
 359   int                   _major_progress;        // Count of something big happening
 360   bool                  _inlining_progress;     // progress doing incremental inlining?
 361   bool                  _inlining_incrementally;// Are we doing incremental inlining (post parse)
 362   bool                  _has_loops;             // True if the method _may_ have some loops
 363   bool                  _has_split_ifs;         // True if the method _may_ have some split-if
 364   bool                  _has_unsafe_access;     // True if the method _may_ produce faults in unsafe loads or stores.
 365   bool                  _has_stringbuilder;     // True StringBuffers or StringBuilders are allocated
 366   bool                  _has_boxed_value;       // True if a boxed object is allocated
 367   int                   _max_vector_size;       // Maximum size of generated vectors
 368   uint                  _trap_hist[trapHistLength];  // Cumulative traps
 369   bool                  _trap_can_recompile;    // Have we emitted a recompiling trap?
 370   uint                  _decompile_count;       // Cumulative decompilation counts.
 371   bool                  _do_inlining;           // True if we intend to do inlining
 372   bool                  _do_scheduling;         // True if we intend to do scheduling
 373   bool                  _do_freq_based_layout;  // True if we intend to do frequency based block layout
 374   bool                  _do_count_invocations;  // True if we generate code to count invocations
 375   bool                  _do_method_data_update; // True if we generate code to update MethodData*s
 376   bool                  _do_vector_loop;        // True if allowed to execute loop in parallel iterations
 377   bool                  _age_code;              // True if we need to profile code age (decrement the aging counter)
 378   int                   _AliasLevel;            // Locally-adjusted version of AliasLevel flag.
 379   bool                  _print_assembly;        // True if we should dump assembly code for this compilation
 380   bool                  _print_inlining;        // True if we should print inlining for this compilation
 381   bool                  _print_intrinsics;      // True if we should print intrinsics for this compilation
 382 #ifndef PRODUCT
 383   bool                  _trace_opto_output;
 384   bool                  _parsed_irreducible_loop; // True if ciTypeFlow detected irreducible loops during parsing
 385 #endif
 386   bool                  _has_irreducible_loop;  // Found irreducible loops
 387   // JSR 292
 388   bool                  _has_method_handle_invokes; // True if this method has MethodHandle invokes.
 389   RTMState              _rtm_state;             // State of Restricted Transactional Memory usage
 390 
 391   // Compilation environment.
 392   Arena                 _comp_arena;            // Arena with lifetime equivalent to Compile
 393   ciEnv*                _env;                   // CI interface
 394   CompileLog*           _log;                   // from CompilerThread
 395   const char*           _failure_reason;        // for record_failure/failing pattern
 396   GrowableArray<CallGenerator*>* _intrinsics;   // List of intrinsics.
 397   GrowableArray<Node*>* _macro_nodes;           // List of nodes which need to be expanded before matching.
 398   GrowableArray<Node*>* _predicate_opaqs;       // List of Opaque1 nodes for the loop predicates.
 399   GrowableArray<Node*>* _expensive_nodes;       // List of nodes that are expensive to compute and that we'd better not let the GVN freely common
 400   ConnectionGraph*      _congraph;
 401 #ifndef PRODUCT
 402   IdealGraphPrinter*    _printer;
 403 #endif
 404 
 405 
 406   // Node management
 407   uint                  _unique;                // Counter for unique Node indices
 408   VectorSet             _dead_node_list;        // Set of dead nodes
 409   uint                  _dead_node_count;       // Number of dead nodes; VectorSet::Size() is O(N).
 410                                                 // So use this to keep count and make the call O(1).
 411   DEBUG_ONLY( Unique_Node_List* _modified_nodes; )  // List of nodes which inputs were modified
 412 
 413   debug_only(static int _debug_idx;)            // Monotonic counter (not reset), use -XX:BreakAtNode=<idx>
 414   Arena                 _node_arena;            // Arena for new-space Nodes
 415   Arena                 _old_arena;             // Arena for old-space Nodes, lifetime during xform
 416   RootNode*             _root;                  // Unique root of compilation, or NULL after bail-out.
 417   Node*                 _top;                   // Unique top node.  (Reset by various phases.)
 418 
 419   Node*                 _immutable_memory;      // Initial memory state
 420 
 421   Node*                 _recent_alloc_obj;
 422   Node*                 _recent_alloc_ctl;
 423 
 424   // Constant table
 425   ConstantTable         _constant_table;        // The constant table for this compile.
 426   MachConstantBaseNode* _mach_constant_base_node;  // Constant table base node singleton.
 427 
 428 
 429   // Blocked array of debugging and profiling information,
 430   // tracked per node.
 431   enum { _log2_node_notes_block_size = 8,
 432          _node_notes_block_size = (1<<_log2_node_notes_block_size)
 433   };
 434   GrowableArray<Node_Notes*>* _node_note_array;
 435   Node_Notes*           _default_node_notes;  // default notes for new nodes
 436 
 437   // After parsing and every bulk phase we hang onto the Root instruction.
 438   // The RootNode instruction is where the whole program begins.  It produces
 439   // the initial Control and BOTTOM for everybody else.
 440 
 441   // Type management
 442   Arena                 _Compile_types;         // Arena for all types
 443   Arena*                _type_arena;            // Alias for _Compile_types except in Initialize_shared()
 444   Dict*                 _type_dict;             // Intern table
 445   CloneMap              _clone_map;             // used for recording history of cloned nodes
 446   void*                 _type_hwm;              // Last allocation (see Type::operator new/delete)
 447   size_t                _type_last_size;        // Last allocation size (see Type::operator new/delete)
 448   ciMethod*             _last_tf_m;             // Cache for
 449   const TypeFunc*       _last_tf;               //  TypeFunc::make
 450   AliasType**           _alias_types;           // List of alias types seen so far.
 451   int                   _num_alias_types;       // Logical length of _alias_types
 452   int                   _max_alias_types;       // Physical length of _alias_types
 453   AliasCacheEntry       _alias_cache[AliasCacheSize]; // Gets aliases w/o data structure walking
 454 
 455   // Parsing, optimization
 456   PhaseGVN*             _initial_gvn;           // Results of parse-time PhaseGVN
 457   Unique_Node_List*     _for_igvn;              // Initial work-list for next round of Iterative GVN
 458   WarmCallInfo*         _warm_calls;            // Sorted work-list for heat-based inlining.
 459 
 460   GrowableArray<CallGenerator*> _late_inlines;        // List of CallGenerators to be revisited after
 461                                                       // main parsing has finished.
 462   GrowableArray<CallGenerator*> _string_late_inlines; // same but for string operations
 463 
 464   GrowableArray<CallGenerator*> _boxing_late_inlines; // same but for boxing operations
 465 
 466   int                           _late_inlines_pos;    // Where in the queue should the next late inlining candidate go (emulate depth first inlining)
 467   uint                          _number_of_mh_late_inlines; // number of method handle late inlining still pending
 468 
 469 
 470   // Inlining may not happen in parse order which would make
 471   // PrintInlining output confusing. Keep track of PrintInlining
 472   // pieces in order.
 473   class PrintInliningBuffer : public ResourceObj {
 474    private:
 475     CallGenerator* _cg;
 476     stringStream* _ss;
 477 
 478    public:
 479     PrintInliningBuffer()
 480       : _cg(NULL) { _ss = new stringStream(); }
 481 
 482     stringStream* ss() const { return _ss; }
 483     CallGenerator* cg() const { return _cg; }
 484     void set_cg(CallGenerator* cg) { _cg = cg; }
 485   };
 486 
 487   stringStream* _print_inlining_stream;
 488   GrowableArray<PrintInliningBuffer>* _print_inlining_list;
 489   int _print_inlining_idx;
 490   char* _print_inlining_output;
 491 
 492   // Only keep nodes in the expensive node list that need to be optimized
 493   void cleanup_expensive_nodes(PhaseIterGVN &igvn);
 494   // Use for sorting expensive nodes to bring similar nodes together
 495   static int cmp_expensive_nodes(Node** n1, Node** n2);
 496   // Expensive nodes list already sorted?
 497   bool expensive_nodes_sorted() const;
 498   // Remove the speculative part of types and clean up the graph
 499   void remove_speculative_types(PhaseIterGVN &igvn);
 500 
 501   void* _replay_inline_data; // Pointer to data loaded from file
 502 
 503   void print_inlining_init();
 504   void print_inlining_reinit();
 505   void print_inlining_commit();
 506   void print_inlining_push();
 507   PrintInliningBuffer& print_inlining_current();
 508 
 509   void log_late_inline_failure(CallGenerator* cg, const char* msg);
 510 
 511  public:
 512 
 513   outputStream* print_inlining_stream() const {
 514     assert(print_inlining() || print_intrinsics(), "PrintInlining off?");
 515     return _print_inlining_stream;
 516   }
 517 
 518   void print_inlining_update(CallGenerator* cg);
 519   void print_inlining_update_delayed(CallGenerator* cg);
 520   void print_inlining_move_to(CallGenerator* cg);
 521   void print_inlining_assert_ready();
 522   void print_inlining_reset();
 523 
 524   void print_inlining(ciMethod* method, int inline_level, int bci, const char* msg = NULL) {
 525     stringStream ss;
 526     CompileTask::print_inlining(&ss, method, inline_level, bci, msg);
 527     print_inlining_stream()->print("%s", ss.as_string());
 528   }
 529 
 530   void log_late_inline(CallGenerator* cg);
 531   void log_inline_id(CallGenerator* cg);
 532   void log_inline_failure(const char* msg);
 533 
 534   void* replay_inline_data() const { return _replay_inline_data; }
 535 
 536   // Dump inlining replay data to the stream.
 537   void dump_inline_data(outputStream* out);
 538 
 539  private:
 540   // Matching, CFG layout, allocation, code generation
 541   PhaseCFG*             _cfg;                   // Results of CFG finding
 542   bool                  _select_24_bit_instr;   // We selected an instruction with a 24-bit result
 543   bool                  _in_24_bit_fp_mode;     // We are emitting instructions with 24-bit results
 544   int                   _java_calls;            // Number of java calls in the method
 545   int                   _inner_loops;           // Number of inner loops in the method
 546   Matcher*              _matcher;               // Engine to map ideal to machine instructions
 547   PhaseRegAlloc*        _regalloc;              // Results of register allocation.
 548   int                   _frame_slots;           // Size of total frame in stack slots
 549   CodeOffsets           _code_offsets;          // Offsets into the code for various interesting entries
 550   RegMask               _FIRST_STACK_mask;      // All stack slots usable for spills (depends on frame layout)
 551   Arena*                _indexSet_arena;        // control IndexSet allocation within PhaseChaitin
 552   void*                 _indexSet_free_block_list; // free list of IndexSet bit blocks
 553   int                   _interpreter_frame_size;
 554 
 555   uint                  _node_bundling_limit;
 556   Bundle*               _node_bundling_base;    // Information for instruction bundling
 557 
 558   // Instruction bits passed off to the VM
 559   int                   _method_size;           // Size of nmethod code segment in bytes
 560   CodeBuffer            _code_buffer;           // Where the code is assembled
 561   int                   _first_block_size;      // Size of unvalidated entry point code / OSR poison code
 562   ExceptionHandlerTable _handler_table;         // Table of native-code exception handlers
 563   ImplicitExceptionTable _inc_table;            // Table of implicit null checks in native code
 564   OopMapSet*            _oop_map_set;           // Table of oop maps (one for each safepoint location)
 565   static int            _CompiledZap_count;     // counter compared against CompileZap[First/Last]
 566   BufferBlob*           _scratch_buffer_blob;   // For temporary code buffers.
 567   relocInfo*            _scratch_locs_memory;   // For temporary code buffers.
 568   int                   _scratch_const_size;    // For temporary code buffers.
 569   bool                  _in_scratch_emit_size;  // true when in scratch_emit_size.
 570 
 571  public:
 572   // Accessors
 573 
 574   // The Compile instance currently active in this (compiler) thread.
 575   static Compile* current() {
 576     return (Compile*) ciEnv::current()->compiler_data();
 577   }
 578 
 579   // ID for this compilation.  Useful for setting breakpoints in the debugger.
 580   int               compile_id() const          { return _compile_id; }
 581 
 582   // Does this compilation allow instructions to subsume loads?  User
 583   // instructions that subsume a load may result in an unschedulable
 584   // instruction sequence.
 585   bool              subsume_loads() const       { return _subsume_loads; }
 586   /** Do escape analysis. */
 587   bool              do_escape_analysis() const  { return _do_escape_analysis; }
 588   /** Do boxing elimination. */
 589   bool              eliminate_boxing() const    { return _eliminate_boxing; }
 590   /** Do aggressive boxing elimination. */
 591   bool              aggressive_unboxing() const { return _eliminate_boxing && AggressiveUnboxing; }
 592   bool              save_argument_registers() const { return _save_argument_registers; }
 593 
 594 
 595   // Other fixed compilation parameters.
 596   ciMethod*         method() const              { return _method; }
 597   int               entry_bci() const           { return _entry_bci; }
 598   bool              is_osr_compilation() const  { return _entry_bci != InvocationEntryBci; }
 599   bool              is_method_compilation() const { return (_method != NULL && !_method->flags().is_native()); }
 600   const TypeFunc*   tf() const                  { assert(_tf!=NULL, ""); return _tf; }
 601   void         init_tf(const TypeFunc* tf)      { assert(_tf==NULL, ""); _tf = tf; }
 602   InlineTree*       ilt() const                 { return _ilt; }
 603   address           stub_function() const       { return _stub_function; }
 604   const char*       stub_name() const           { return _stub_name; }
 605   address           stub_entry_point() const    { return _stub_entry_point; }
 606 
 607   // Control of this compilation.
 608   int               fixed_slots() const         { assert(_fixed_slots >= 0, "");         return _fixed_slots; }
 609   void          set_fixed_slots(int n)          { _fixed_slots = n; }
 610   int               major_progress() const      { return _major_progress; }
 611   void          set_inlining_progress(bool z)   { _inlining_progress = z; }
 612   int               inlining_progress() const   { return _inlining_progress; }
 613   void          set_inlining_incrementally(bool z) { _inlining_incrementally = z; }
 614   int               inlining_incrementally() const { return _inlining_incrementally; }
 615   void          set_major_progress()            { _major_progress++; }
 616   void        clear_major_progress()            { _major_progress = 0; }
 617   int               num_loop_opts() const       { return _num_loop_opts; }
 618   void          set_num_loop_opts(int n)        { _num_loop_opts = n; }
 619   int               max_inline_size() const     { return _max_inline_size; }
 620   void          set_freq_inline_size(int n)     { _freq_inline_size = n; }
 621   int               freq_inline_size() const    { return _freq_inline_size; }
 622   void          set_max_inline_size(int n)      { _max_inline_size = n; }
 623   bool              has_loops() const           { return _has_loops; }
 624   void          set_has_loops(bool z)           { _has_loops = z; }
 625   bool              has_split_ifs() const       { return _has_split_ifs; }
 626   void          set_has_split_ifs(bool z)       { _has_split_ifs = z; }
 627   bool              has_unsafe_access() const   { return _has_unsafe_access; }
 628   void          set_has_unsafe_access(bool z)   { _has_unsafe_access = z; }
 629   bool              has_stringbuilder() const   { return _has_stringbuilder; }
 630   void          set_has_stringbuilder(bool z)   { _has_stringbuilder = z; }
 631   bool              has_boxed_value() const     { return _has_boxed_value; }
 632   void          set_has_boxed_value(bool z)     { _has_boxed_value = z; }
 633   int               max_vector_size() const     { return _max_vector_size; }
 634   void          set_max_vector_size(int s)      { _max_vector_size = s; }
 635   void          set_trap_count(uint r, uint c)  { assert(r < trapHistLength, "oob");        _trap_hist[r] = c; }
 636   uint              trap_count(uint r) const    { assert(r < trapHistLength, "oob"); return _trap_hist[r]; }
 637   bool              trap_can_recompile() const  { return _trap_can_recompile; }
 638   void          set_trap_can_recompile(bool z)  { _trap_can_recompile = z; }
 639   uint              decompile_count() const     { return _decompile_count; }
 640   void          set_decompile_count(uint c)     { _decompile_count = c; }
 641   bool              allow_range_check_smearing() const;
 642   bool              do_inlining() const         { return _do_inlining; }
 643   void          set_do_inlining(bool z)         { _do_inlining = z; }
 644   bool              do_scheduling() const       { return _do_scheduling; }
 645   void          set_do_scheduling(bool z)       { _do_scheduling = z; }
 646   bool              do_freq_based_layout() const{ return _do_freq_based_layout; }
 647   void          set_do_freq_based_layout(bool z){ _do_freq_based_layout = z; }
 648   bool              do_count_invocations() const{ return _do_count_invocations; }
 649   void          set_do_count_invocations(bool z){ _do_count_invocations = z; }
 650   bool              do_method_data_update() const { return _do_method_data_update; }
 651   void          set_do_method_data_update(bool z) { _do_method_data_update = z; }
 652   bool              do_vector_loop() const      { return _do_vector_loop; }
 653   void          set_do_vector_loop(bool z)      { _do_vector_loop = z; }
 654   bool              age_code() const             { return _age_code; }
 655   void          set_age_code(bool z)             { _age_code = z; }
 656   int               AliasLevel() const           { return _AliasLevel; }
 657   bool              print_assembly() const       { return _print_assembly; }
 658   void          set_print_assembly(bool z)       { _print_assembly = z; }
 659   bool              print_inlining() const       { return _print_inlining; }
 660   void          set_print_inlining(bool z)       { _print_inlining = z; }
 661   bool              print_intrinsics() const     { return _print_intrinsics; }
 662   void          set_print_intrinsics(bool z)     { _print_intrinsics = z; }
 663   RTMState          rtm_state()  const           { return _rtm_state; }
 664   void          set_rtm_state(RTMState s)        { _rtm_state = s; }
 665   bool              use_rtm() const              { return (_rtm_state & NoRTM) == 0; }
 666   bool          profile_rtm() const              { return _rtm_state == ProfileRTM; }
 667   uint              max_node_limit() const       { return (uint)_max_node_limit; }
 668   void          set_max_node_limit(uint n)       { _max_node_limit = n; }
 669 
 670   // check the CompilerOracle for special behaviours for this compile
 671   bool          method_has_option(const char * option) {
 672     return method() != NULL && method()->has_option(option);
 673   }
 674   template<typename T>
 675   bool          method_has_option_value(const char * option, T& value) {
 676     return method() != NULL && method()->has_option_value(option, value);
 677   }
 678 #ifndef PRODUCT
 679   bool          trace_opto_output() const       { return _trace_opto_output; }
 680   bool              parsed_irreducible_loop() const { return _parsed_irreducible_loop; }
 681   void          set_parsed_irreducible_loop(bool z) { _parsed_irreducible_loop = z; }
 682   int _in_dump_cnt;  // Required for dumping ir nodes.
 683 #endif
 684   bool              has_irreducible_loop() const { return _has_irreducible_loop; }
 685   void          set_has_irreducible_loop(bool z) { _has_irreducible_loop = z; }
 686 
 687   // JSR 292
 688   bool              has_method_handle_invokes() const { return _has_method_handle_invokes;     }
 689   void          set_has_method_handle_invokes(bool z) {        _has_method_handle_invokes = z; }
 690 
 691   Ticks _latest_stage_start_counter;
 692 
 693   void begin_method() {
 694 #ifndef PRODUCT
 695     if (_printer && _printer->should_print(_method)) {
 696       _printer->begin_method(this);
 697     }
 698 #endif
 699     C->_latest_stage_start_counter.stamp();
 700   }
 701 
 702   void print_method(CompilerPhaseType cpt, int level = 1) {
 703     EventCompilerPhase event;
 704     if (event.should_commit()) {
 705       event.set_starttime(C->_latest_stage_start_counter);
 706       event.set_phase((u1) cpt);
 707       event.set_compileID(C->_compile_id);
 708       event.set_phaseLevel(level);
 709       event.commit();
 710     }
 711 
 712 
 713 #ifndef PRODUCT
 714     if (_printer && _printer->should_print(_method)) {
 715       _printer->print_method(this, CompilerPhaseTypeHelper::to_string(cpt), level);
 716     }
 717 #endif
 718     C->_latest_stage_start_counter.stamp();
 719   }
 720 
 721   void end_method(int level = 1) {
 722     EventCompilerPhase event;
 723     if (event.should_commit()) {
 724       event.set_starttime(C->_latest_stage_start_counter);
 725       event.set_phase((u1) PHASE_END);
 726       event.set_compileID(C->_compile_id);
 727       event.set_phaseLevel(level);
 728       event.commit();
 729     }
 730 #ifndef PRODUCT
 731     if (_printer && _printer->should_print(_method)) {
 732       _printer->end_method();
 733     }
 734 #endif
 735   }
 736 
 737   int           macro_count()             const { return _macro_nodes->length(); }
 738   int           predicate_count()         const { return _predicate_opaqs->length();}
 739   int           expensive_count()         const { return _expensive_nodes->length(); }
 740   Node*         macro_node(int idx)       const { return _macro_nodes->at(idx); }
 741   Node*         predicate_opaque1_node(int idx) const { return _predicate_opaqs->at(idx);}
 742   Node*         expensive_node(int idx)   const { return _expensive_nodes->at(idx); }
 743   ConnectionGraph* congraph()                   { return _congraph;}
 744   void set_congraph(ConnectionGraph* congraph)  { _congraph = congraph;}
 745   void add_macro_node(Node * n) {
 746     //assert(n->is_macro(), "must be a macro node");
 747     assert(!_macro_nodes->contains(n), " duplicate entry in expand list");
 748     _macro_nodes->append(n);
 749   }
 750   void remove_macro_node(Node * n) {
 751     // this function may be called twice for a node so check
 752     // that the node is in the array before attempting to remove it
 753     if (_macro_nodes->contains(n))
 754       _macro_nodes->remove(n);
 755     // remove from _predicate_opaqs list also if it is there
 756     if (predicate_count() > 0 && _predicate_opaqs->contains(n)){
 757       _predicate_opaqs->remove(n);
 758     }
 759   }
 760   void add_expensive_node(Node * n);
 761   void remove_expensive_node(Node * n) {
 762     if (_expensive_nodes->contains(n)) {
 763       _expensive_nodes->remove(n);
 764     }
 765   }
 766   void add_predicate_opaq(Node * n) {
 767     assert(!_predicate_opaqs->contains(n), " duplicate entry in predicate opaque1");
 768     assert(_macro_nodes->contains(n), "should have already been in macro list");
 769     _predicate_opaqs->append(n);
 770   }
 771   // remove the opaque nodes that protect the predicates so that the unused checks and
 772   // uncommon traps will be eliminated from the graph.
 773   void cleanup_loop_predicates(PhaseIterGVN &igvn);
 774   bool is_predicate_opaq(Node * n) {
 775     return _predicate_opaqs->contains(n);
 776   }
 777 
 778   // Are there candidate expensive nodes for optimization?
 779   bool should_optimize_expensive_nodes(PhaseIterGVN &igvn);
 780   // Check whether n1 and n2 are similar
 781   static int cmp_expensive_nodes(Node* n1, Node* n2);
 782   // Sort expensive nodes to locate similar expensive nodes
 783   void sort_expensive_nodes();
 784 
 785   // Compilation environment.
 786   Arena*      comp_arena()           { return &_comp_arena; }
 787   ciEnv*      env() const            { return _env; }
 788   CompileLog* log() const            { return _log; }
 789   bool        failing() const        { return _env->failing() || _failure_reason != NULL; }
 790   const char* failure_reason() const { return (_env->failing()) ? _env->failure_reason() : _failure_reason; }
 791 
 792   bool failure_reason_is(const char* r) const {
 793     return (r == _failure_reason) || (r != NULL && _failure_reason != NULL && strcmp(r, _failure_reason) == 0);
 794   }
 795 
 796   void record_failure(const char* reason);
 797   void record_method_not_compilable(const char* reason, bool all_tiers = false) {
 798     // All bailouts cover "all_tiers" when TieredCompilation is off.
 799     if (!TieredCompilation) all_tiers = true;
 800     env()->record_method_not_compilable(reason, all_tiers);
 801     // Record failure reason.
 802     record_failure(reason);
 803   }
 804   void record_method_not_compilable_all_tiers(const char* reason) {
 805     record_method_not_compilable(reason, true);
 806   }
 807   bool check_node_count(uint margin, const char* reason) {
 808     if (live_nodes() + margin > max_node_limit()) {
 809       record_method_not_compilable(reason);
 810       return true;
 811     } else {
 812       return false;
 813     }
 814   }
 815 
 816   // Node management
 817   uint         unique() const              { return _unique; }
 818   uint         next_unique()               { return _unique++; }
 819   void         set_unique(uint i)          { _unique = i; }
 820   static int   debug_idx()                 { return debug_only(_debug_idx)+0; }
 821   static void  set_debug_idx(int i)        { debug_only(_debug_idx = i); }
 822   Arena*       node_arena()                { return &_node_arena; }
 823   Arena*       old_arena()                 { return &_old_arena; }
 824   RootNode*    root() const                { return _root; }
 825   void         set_root(RootNode* r)       { _root = r; }
 826   StartNode*   start() const;              // (Derived from root.)
 827   void         init_start(StartNode* s);
 828   Node*        immutable_memory();
 829 
 830   Node*        recent_alloc_ctl() const    { return _recent_alloc_ctl; }
 831   Node*        recent_alloc_obj() const    { return _recent_alloc_obj; }
 832   void         set_recent_alloc(Node* ctl, Node* obj) {
 833                                                   _recent_alloc_ctl = ctl;
 834                                                   _recent_alloc_obj = obj;
 835                                            }
 836   void         record_dead_node(uint idx)  { if (_dead_node_list.test_set(idx)) return;
 837                                              _dead_node_count++;
 838                                            }
 839   bool         is_dead_node(uint idx)      { return _dead_node_list.test(idx) != 0; }
 840   uint         dead_node_count()           { return _dead_node_count; }
 841   void         reset_dead_node_list()      { _dead_node_list.Reset();
 842                                              _dead_node_count = 0;
 843                                            }
 844   uint          live_nodes() const         {
 845     int  val = _unique - _dead_node_count;
 846     assert (val >= 0, err_msg_res("number of tracked dead nodes %d more than created nodes %d", _unique, _dead_node_count));
 847             return (uint) val;
 848                                            }
 849 #ifdef ASSERT
 850   uint         count_live_nodes_by_graph_walk();
 851   void         print_missing_nodes();
 852 #endif
 853 
 854   // Record modified nodes to check that they are put on IGVN worklist
 855   void         record_modified_node(Node* n) NOT_DEBUG_RETURN;
 856   void         remove_modified_node(Node* n) NOT_DEBUG_RETURN;
 857   DEBUG_ONLY( Unique_Node_List*   modified_nodes() const { return _modified_nodes; } )
 858 
 859   // Constant table
 860   ConstantTable&   constant_table() { return _constant_table; }
 861 
 862   MachConstantBaseNode*     mach_constant_base_node();
 863   bool                  has_mach_constant_base_node() const { return _mach_constant_base_node != NULL; }
 864   // Generated by adlc, true if CallNode requires MachConstantBase.
 865   bool                      needs_clone_jvms();
 866 
 867   // Handy undefined Node
 868   Node*             top() const                 { return _top; }
 869 
 870   // these are used by guys who need to know about creation and transformation of top:
 871   Node*             cached_top_node()           { return _top; }
 872   void          set_cached_top_node(Node* tn);
 873 
 874   GrowableArray<Node_Notes*>* node_note_array() const { return _node_note_array; }
 875   void set_node_note_array(GrowableArray<Node_Notes*>* arr) { _node_note_array = arr; }
 876   Node_Notes* default_node_notes() const        { return _default_node_notes; }
 877   void    set_default_node_notes(Node_Notes* n) { _default_node_notes = n; }
 878 
 879   Node_Notes*       node_notes_at(int idx) {
 880     return locate_node_notes(_node_note_array, idx, false);
 881   }
 882   inline bool   set_node_notes_at(int idx, Node_Notes* value);
 883 
 884   // Copy notes from source to dest, if they exist.
 885   // Overwrite dest only if source provides something.
 886   // Return true if information was moved.
 887   bool copy_node_notes_to(Node* dest, Node* source);
 888 
 889   // Workhorse function to sort out the blocked Node_Notes array:
 890   inline Node_Notes* locate_node_notes(GrowableArray<Node_Notes*>* arr,
 891                                        int idx, bool can_grow = false);
 892 
 893   void grow_node_notes(GrowableArray<Node_Notes*>* arr, int grow_by);
 894 
 895   // Type management
 896   Arena*            type_arena()                { return _type_arena; }
 897   Dict*             type_dict()                 { return _type_dict; }
 898   void*             type_hwm()                  { return _type_hwm; }
 899   size_t            type_last_size()            { return _type_last_size; }
 900   int               num_alias_types()           { return _num_alias_types; }
 901 
 902   void          init_type_arena()                       { _type_arena = &_Compile_types; }
 903   void          set_type_arena(Arena* a)                { _type_arena = a; }
 904   void          set_type_dict(Dict* d)                  { _type_dict = d; }
 905   void          set_type_hwm(void* p)                   { _type_hwm = p; }
 906   void          set_type_last_size(size_t sz)           { _type_last_size = sz; }
 907 
 908   const TypeFunc* last_tf(ciMethod* m) {
 909     return (m == _last_tf_m) ? _last_tf : NULL;
 910   }
 911   void set_last_tf(ciMethod* m, const TypeFunc* tf) {
 912     assert(m != NULL || tf == NULL, "");
 913     _last_tf_m = m;
 914     _last_tf = tf;
 915   }
 916 
 917   AliasType*        alias_type(int                idx)  { assert(idx < num_alias_types(), "oob"); return _alias_types[idx]; }
 918   AliasType*        alias_type(const TypePtr* adr_type, ciField* field = NULL) { return find_alias_type(adr_type, false, field); }
 919   bool         have_alias_type(const TypePtr* adr_type);
 920   AliasType*        alias_type(ciField*         field);
 921 
 922   int               get_alias_index(const TypePtr* at)  { return alias_type(at)->index(); }
 923   const TypePtr*    get_adr_type(uint aidx)             { return alias_type(aidx)->adr_type(); }
 924   int               get_general_index(uint aidx)        { return alias_type(aidx)->general_index(); }
 925 
 926   // Building nodes
 927   void              rethrow_exceptions(JVMState* jvms);
 928   void              return_values(JVMState* jvms);
 929   JVMState*         build_start_state(StartNode* start, const TypeFunc* tf);
 930 
 931   // Decide how to build a call.
 932   // The profile factor is a discount to apply to this site's interp. profile.
 933   CallGenerator*    call_generator(ciMethod* call_method, int vtable_index, bool call_does_dispatch,
 934                                    JVMState* jvms, bool allow_inline, float profile_factor, ciKlass* speculative_receiver_type = NULL,
 935                                    bool allow_intrinsics = true, bool delayed_forbidden = false);
 936   bool should_delay_inlining(ciMethod* call_method, JVMState* jvms) {
 937     return should_delay_string_inlining(call_method, jvms) ||
 938            should_delay_boxing_inlining(call_method, jvms);
 939   }
 940   bool should_delay_string_inlining(ciMethod* call_method, JVMState* jvms);
 941   bool should_delay_boxing_inlining(ciMethod* call_method, JVMState* jvms);
 942 
 943   // Helper functions to identify inlining potential at call-site
 944   ciMethod* optimize_virtual_call(ciMethod* caller, int bci, ciInstanceKlass* klass,
 945                                   ciKlass* holder, ciMethod* callee,
 946                                   const TypeOopPtr* receiver_type, bool is_virtual,
 947                                   bool &call_does_dispatch, int &vtable_index,
 948                                   bool check_access = true);
 949   ciMethod* optimize_inlining(ciMethod* caller, int bci, ciInstanceKlass* klass,
 950                               ciMethod* callee, const TypeOopPtr* receiver_type,
 951                               bool check_access = true);
 952 
 953   // Report if there were too many traps at a current method and bci.
 954   // Report if a trap was recorded, and/or PerMethodTrapLimit was exceeded.
 955   // If there is no MDO at all, report no trap unless told to assume it.
 956   bool too_many_traps(ciMethod* method, int bci, Deoptimization::DeoptReason reason);
 957   // This version, unspecific to a particular bci, asks if
 958   // PerMethodTrapLimit was exceeded for all inlined methods seen so far.
 959   bool too_many_traps(Deoptimization::DeoptReason reason,
 960                       // Privately used parameter for logging:
 961                       ciMethodData* logmd = NULL);
 962   // Report if there were too many recompiles at a method and bci.
 963   bool too_many_recompiles(ciMethod* method, int bci, Deoptimization::DeoptReason reason);
 964   // Return a bitset with the reasons where deoptimization is allowed,
 965   // i.e., where there were not too many uncommon traps.
 966   int _allowed_reasons;
 967   int      allowed_deopt_reasons() { return _allowed_reasons; }
 968   void set_allowed_deopt_reasons();
 969 
 970   // Parsing, optimization
 971   PhaseGVN*         initial_gvn()               { return _initial_gvn; }
 972   Unique_Node_List* for_igvn()                  { return _for_igvn; }
 973   inline void       record_for_igvn(Node* n);   // Body is after class Unique_Node_List.
 974   void          set_initial_gvn(PhaseGVN *gvn)           { _initial_gvn = gvn; }
 975   void          set_for_igvn(Unique_Node_List *for_igvn) { _for_igvn = for_igvn; }
 976 
 977   // Replace n by nn using initial_gvn, calling hash_delete and
 978   // record_for_igvn as needed.
 979   void gvn_replace_by(Node* n, Node* nn);
 980 
 981 
 982   void              identify_useful_nodes(Unique_Node_List &useful);
 983   void              update_dead_node_list(Unique_Node_List &useful);
 984   void              remove_useless_nodes (Unique_Node_List &useful);
 985 
 986   WarmCallInfo*     warm_calls() const          { return _warm_calls; }
 987   void          set_warm_calls(WarmCallInfo* l) { _warm_calls = l; }
 988   WarmCallInfo* pop_warm_call();
 989 
 990   // Record this CallGenerator for inlining at the end of parsing.
 991   void              add_late_inline(CallGenerator* cg)        {
 992     _late_inlines.insert_before(_late_inlines_pos, cg);
 993     _late_inlines_pos++;
 994   }
 995 
 996   void              prepend_late_inline(CallGenerator* cg)    {
 997     _late_inlines.insert_before(0, cg);
 998   }
 999 
1000   void              add_string_late_inline(CallGenerator* cg) {
1001     _string_late_inlines.push(cg);
1002   }
1003 
1004   void              add_boxing_late_inline(CallGenerator* cg) {
1005     _boxing_late_inlines.push(cg);
1006   }
1007 
1008   void remove_useless_late_inlines(GrowableArray<CallGenerator*>* inlines, Unique_Node_List &useful);
1009 
1010   void process_print_inlining();
1011   void dump_print_inlining();
1012 
1013   bool over_inlining_cutoff() const {
1014     if (!inlining_incrementally()) {
1015       return unique() > (uint)NodeCountInliningCutoff;
1016     } else {
1017       return live_nodes() > (uint)LiveNodeCountInliningCutoff;
1018     }
1019   }
1020 
1021   void inc_number_of_mh_late_inlines() { _number_of_mh_late_inlines++; }
1022   void dec_number_of_mh_late_inlines() { assert(_number_of_mh_late_inlines > 0, "_number_of_mh_late_inlines < 0 !"); _number_of_mh_late_inlines--; }
1023   bool has_mh_late_inlines() const     { return _number_of_mh_late_inlines > 0; }
1024 
1025   void inline_incrementally_one(PhaseIterGVN& igvn);
1026   void inline_incrementally(PhaseIterGVN& igvn);
1027   void inline_string_calls(bool parse_time);
1028   void inline_boxing_calls(PhaseIterGVN& igvn);
1029 
1030   // Matching, CFG layout, allocation, code generation
1031   PhaseCFG*         cfg()                       { return _cfg; }
1032   bool              select_24_bit_instr() const { return _select_24_bit_instr; }
1033   bool              in_24_bit_fp_mode() const   { return _in_24_bit_fp_mode; }
1034   bool              has_java_calls() const      { return _java_calls > 0; }
1035   int               java_calls() const          { return _java_calls; }
1036   int               inner_loops() const         { return _inner_loops; }
1037   Matcher*          matcher()                   { return _matcher; }
1038   PhaseRegAlloc*    regalloc()                  { return _regalloc; }
1039   int               frame_slots() const         { return _frame_slots; }
1040   int               frame_size_in_words() const; // frame_slots in units of the polymorphic 'words'
1041   int               frame_size_in_bytes() const { return _frame_slots << LogBytesPerInt; }
1042   RegMask&          FIRST_STACK_mask()          { return _FIRST_STACK_mask; }
1043   Arena*            indexSet_arena()            { return _indexSet_arena; }
1044   void*             indexSet_free_block_list()  { return _indexSet_free_block_list; }
1045   uint              node_bundling_limit()       { return _node_bundling_limit; }
1046   Bundle*           node_bundling_base()        { return _node_bundling_base; }
1047   void          set_node_bundling_limit(uint n) { _node_bundling_limit = n; }
1048   void          set_node_bundling_base(Bundle* b) { _node_bundling_base = b; }
1049   bool          starts_bundle(const Node *n) const;
1050   bool          need_stack_bang(int frame_size_in_bytes) const;
1051   bool          need_register_stack_bang() const;
1052 
1053   void  update_interpreter_frame_size(int size) {
1054     if (_interpreter_frame_size < size) {
1055       _interpreter_frame_size = size;
1056     }
1057   }
1058   int           bang_size_in_bytes() const;
1059 
1060   void          set_matcher(Matcher* m)                 { _matcher = m; }
1061 //void          set_regalloc(PhaseRegAlloc* ra)           { _regalloc = ra; }
1062   void          set_indexSet_arena(Arena* a)            { _indexSet_arena = a; }
1063   void          set_indexSet_free_block_list(void* p)   { _indexSet_free_block_list = p; }
1064 
1065   // Remember if this compilation changes hardware mode to 24-bit precision
1066   void set_24_bit_selection_and_mode(bool selection, bool mode) {
1067     _select_24_bit_instr = selection;
1068     _in_24_bit_fp_mode   = mode;
1069   }
1070 
1071   void  set_java_calls(int z) { _java_calls  = z; }
1072   void set_inner_loops(int z) { _inner_loops = z; }
1073 
1074   // Instruction bits passed off to the VM
1075   int               code_size()                 { return _method_size; }
1076   CodeBuffer*       code_buffer()               { return &_code_buffer; }
1077   int               first_block_size()          { return _first_block_size; }
1078   void              set_frame_complete(int off) { _code_offsets.set_value(CodeOffsets::Frame_Complete, off); }
1079   ExceptionHandlerTable*  handler_table()       { return &_handler_table; }
1080   ImplicitExceptionTable* inc_table()           { return &_inc_table; }
1081   OopMapSet*        oop_map_set()               { return _oop_map_set; }
1082   DebugInformationRecorder* debug_info()        { return env()->debug_info(); }
1083   Dependencies*     dependencies()              { return env()->dependencies(); }
1084   static int        CompiledZap_count()         { return _CompiledZap_count; }
1085   BufferBlob*       scratch_buffer_blob()       { return _scratch_buffer_blob; }
1086   void         init_scratch_buffer_blob(int const_size);
1087   void        clear_scratch_buffer_blob();
1088   void          set_scratch_buffer_blob(BufferBlob* b) { _scratch_buffer_blob = b; }
1089   relocInfo*        scratch_locs_memory()       { return _scratch_locs_memory; }
1090   void          set_scratch_locs_memory(relocInfo* b)  { _scratch_locs_memory = b; }
1091 
1092   // emit to scratch blob, report resulting size
1093   uint              scratch_emit_size(const Node* n);
1094   void       set_in_scratch_emit_size(bool x)   {        _in_scratch_emit_size = x; }
1095   bool           in_scratch_emit_size() const   { return _in_scratch_emit_size;     }
1096 
1097   enum ScratchBufferBlob {
1098     MAX_inst_size       = 1024,
1099     MAX_locs_size       = 128, // number of relocInfo elements
1100     MAX_const_size      = 128,
1101     MAX_stubs_size      = 128
1102   };
1103 
1104   // Major entry point.  Given a Scope, compile the associated method.
1105   // For normal compilations, entry_bci is InvocationEntryBci.  For on stack
1106   // replacement, entry_bci indicates the bytecode for which to compile a
1107   // continuation.
1108   Compile(ciEnv* ci_env, C2Compiler* compiler, ciMethod* target,
1109           int entry_bci, bool subsume_loads, bool do_escape_analysis,
1110           bool eliminate_boxing);
1111 
1112   // Second major entry point.  From the TypeFunc signature, generate code
1113   // to pass arguments from the Java calling convention to the C calling
1114   // convention.
1115   Compile(ciEnv* ci_env, const TypeFunc *(*gen)(),
1116           address stub_function, const char *stub_name,
1117           int is_fancy_jump, bool pass_tls,
1118           bool save_arg_registers, bool return_pc);
1119 
1120   // From the TypeFunc signature, generate code to pass arguments
1121   // from Compiled calling convention to Interpreter's calling convention
1122   void Generate_Compiled_To_Interpreter_Graph(const TypeFunc *tf, address interpreter_entry);
1123 
1124   // From the TypeFunc signature, generate code to pass arguments
1125   // from Interpreter's calling convention to Compiler's calling convention
1126   void Generate_Interpreter_To_Compiled_Graph(const TypeFunc *tf);
1127 
1128   // Are we compiling a method?
1129   bool has_method() { return method() != NULL; }
1130 
1131   // Maybe print some information about this compile.
1132   void print_compile_messages();
1133 
1134   // Final graph reshaping, a post-pass after the regular optimizer is done.
1135   bool final_graph_reshaping();
1136 
1137   // returns true if adr is completely contained in the given alias category
1138   bool must_alias(const TypePtr* adr, int alias_idx);
1139 
1140   // returns true if adr overlaps with the given alias category
1141   bool can_alias(const TypePtr* adr, int alias_idx);
1142 
1143   // Driver for converting compiler's IR into machine code bits
1144   void Output();
1145 
1146   // Accessors for node bundling info.
1147   Bundle* node_bundling(const Node *n);
1148   bool valid_bundle_info(const Node *n);
1149 
1150   // Schedule and Bundle the instructions
1151   void ScheduleAndBundle();
1152 
1153   // Build OopMaps for each GC point
1154   void BuildOopMaps();
1155 
1156   // Append debug info for the node "local" at safepoint node "sfpt" to the
1157   // "array",   May also consult and add to "objs", which describes the
1158   // scalar-replaced objects.
1159   void FillLocArray( int idx, MachSafePointNode* sfpt,
1160                      Node *local, GrowableArray<ScopeValue*> *array,
1161                      GrowableArray<ScopeValue*> *objs );
1162 
1163   // If "objs" contains an ObjectValue whose id is "id", returns it, else NULL.
1164   static ObjectValue* sv_for_node_id(GrowableArray<ScopeValue*> *objs, int id);
1165   // Requres that "objs" does not contains an ObjectValue whose id matches
1166   // that of "sv.  Appends "sv".
1167   static void set_sv_for_object_node(GrowableArray<ScopeValue*> *objs,
1168                                      ObjectValue* sv );
1169 
1170   // Process an OopMap Element while emitting nodes
1171   void Process_OopMap_Node(MachNode *mach, int code_offset);
1172 
1173   // Initialize code buffer
1174   CodeBuffer* init_buffer(uint* blk_starts);
1175 
1176   // Write out basic block data to code buffer
1177   void fill_buffer(CodeBuffer* cb, uint* blk_starts);
1178 
1179   // Determine which variable sized branches can be shortened
1180   void shorten_branches(uint* blk_starts, int& code_size, int& reloc_size, int& stub_size);
1181 
1182   // Compute the size of first NumberOfLoopInstrToAlign instructions
1183   // at the head of a loop.
1184   void compute_loop_first_inst_sizes();
1185 
1186   // Compute the information for the exception tables
1187   void FillExceptionTables(uint cnt, uint *call_returns, uint *inct_starts, Label *blk_labels);
1188 
1189   // Stack slots that may be unused by the calling convention but must
1190   // otherwise be preserved.  On Intel this includes the return address.
1191   // On PowerPC it includes the 4 words holding the old TOC & LR glue.
1192   uint in_preserve_stack_slots();
1193 
1194   // "Top of Stack" slots that may be unused by the calling convention but must
1195   // otherwise be preserved.
1196   // On Intel these are not necessary and the value can be zero.
1197   // On Sparc this describes the words reserved for storing a register window
1198   // when an interrupt occurs.
1199   static uint out_preserve_stack_slots();
1200 
1201   // Number of outgoing stack slots killed above the out_preserve_stack_slots
1202   // for calls to C.  Supports the var-args backing area for register parms.
1203   uint varargs_C_out_slots_killed() const;
1204 
1205   // Number of Stack Slots consumed by a synchronization entry
1206   int sync_stack_slots() const;
1207 
1208   // Compute the name of old_SP.  See <arch>.ad for frame layout.
1209   OptoReg::Name compute_old_SP();
1210 
1211 #ifdef ENABLE_ZAP_DEAD_LOCALS
1212   static bool is_node_getting_a_safepoint(Node*);
1213   void Insert_zap_nodes();
1214   Node* call_zap_node(MachSafePointNode* n, int block_no);
1215 #endif
1216 
1217  private:
1218   // Phase control:
1219   void Init(int aliaslevel);                     // Prepare for a single compilation
1220   int  Inline_Warm();                            // Find more inlining work.
1221   void Finish_Warm();                            // Give up on further inlines.
1222   void Optimize();                               // Given a graph, optimize it
1223   void Code_Gen();                               // Generate code from a graph
1224 
1225   // Management of the AliasType table.
1226   void grow_alias_types();
1227   AliasCacheEntry* probe_alias_cache(const TypePtr* adr_type);
1228   const TypePtr *flatten_alias_type(const TypePtr* adr_type) const;
1229   AliasType* find_alias_type(const TypePtr* adr_type, bool no_create, ciField* field);
1230 
1231   void verify_top(Node*) const PRODUCT_RETURN;
1232 
1233   // Intrinsic setup.
1234   void           register_library_intrinsics();                            // initializer
1235   CallGenerator* make_vm_intrinsic(ciMethod* m, bool is_virtual);          // constructor
1236   int            intrinsic_insertion_index(ciMethod* m, bool is_virtual);  // helper
1237   CallGenerator* find_intrinsic(ciMethod* m, bool is_virtual);             // query fn
1238   void           register_intrinsic(CallGenerator* cg);                    // update fn
1239 
1240 #ifndef PRODUCT
1241   static juint  _intrinsic_hist_count[vmIntrinsics::ID_LIMIT];
1242   static jubyte _intrinsic_hist_flags[vmIntrinsics::ID_LIMIT];
1243 #endif
1244   // Function calls made by the public function final_graph_reshaping.
1245   // No need to be made public as they are not called elsewhere.
1246   void final_graph_reshaping_impl( Node *n, Final_Reshape_Counts &frc);
1247   void final_graph_reshaping_walk( Node_Stack &nstack, Node *root, Final_Reshape_Counts &frc );
1248   void eliminate_redundant_card_marks(Node* n);
1249 
1250  public:
1251 
1252   // Note:  Histogram array size is about 1 Kb.
1253   enum {                        // flag bits:
1254     _intrinsic_worked = 1,      // succeeded at least once
1255     _intrinsic_failed = 2,      // tried it but it failed
1256     _intrinsic_disabled = 4,    // was requested but disabled (e.g., -XX:-InlineUnsafeOps)
1257     _intrinsic_virtual = 8,     // was seen in the virtual form (rare)
1258     _intrinsic_both = 16        // was seen in the non-virtual form (usual)
1259   };
1260   // Update histogram.  Return boolean if this is a first-time occurrence.
1261   static bool gather_intrinsic_statistics(vmIntrinsics::ID id,
1262                                           bool is_virtual, int flags) PRODUCT_RETURN0;
1263   static void print_intrinsic_statistics() PRODUCT_RETURN;
1264 
1265   // Graph verification code
1266   // Walk the node list, verifying that there is a one-to-one
1267   // correspondence between Use-Def edges and Def-Use edges
1268   // The option no_dead_code enables stronger checks that the
1269   // graph is strongly connected from root in both directions.
1270   void verify_graph_edges(bool no_dead_code = false) PRODUCT_RETURN;
1271 
1272   // Verify GC barrier patterns
1273   void verify_barriers() PRODUCT_RETURN;
1274 
1275   // End-of-run dumps.
1276   static void print_statistics() PRODUCT_RETURN;
1277 
1278   // Dump formatted assembly
1279   void dump_asm(int *pcs = NULL, uint pc_limit = 0) PRODUCT_RETURN;
1280   void dump_pc(int *pcs, int pc_limit, Node *n);
1281 
1282   // Verify ADLC assumptions during startup
1283   static void adlc_verification() PRODUCT_RETURN;
1284 
1285   // Definitions of pd methods
1286   static void pd_compiler2_init();
1287 
1288   // Static parse-time type checking logic for gen_subtype_check:
1289   enum { SSC_always_false, SSC_always_true, SSC_easy_test, SSC_full_test };
1290   int static_subtype_check(ciKlass* superk, ciKlass* subk);
1291 
1292   static Node* conv_I2X_index(PhaseGVN *phase, Node* offset, const TypeInt* sizetype);
1293 
1294   // Auxiliary method for randomized fuzzing/stressing
1295   static bool randomized_select(int count);
1296 
1297   // supporting clone_map
1298   CloneMap&     clone_map();
1299   void          set_clone_map(Dict* d);
1300 
1301 };
1302 
1303 #endif // SHARE_VM_OPTO_COMPILE_HPP