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