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