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