1 /*
   2  * Copyright (c) 1997, 2021, 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_OPTO_COMPILE_HPP
  26 #define SHARE_OPTO_COMPILE_HPP
  27 
  28 #include "asm/codeBuffer.hpp"
  29 #include "ci/compilerInterface.hpp"
  30 #include "code/debugInfoRec.hpp"
  31 #include "compiler/compiler_globals.hpp"
  32 #include "compiler/compilerOracle.hpp"
  33 #include "compiler/compileBroker.hpp"
  34 #include "compiler/compilerEvent.hpp"
  35 #include "libadt/dict.hpp"
  36 #include "libadt/vectset.hpp"
  37 #include "memory/resourceArea.hpp"
  38 #include "oops/methodData.hpp"
  39 #include "opto/idealGraphPrinter.hpp"
  40 #include "opto/phasetype.hpp"
  41 #include "opto/phase.hpp"
  42 #include "opto/regmask.hpp"
  43 #include "runtime/deoptimization.hpp"
  44 #include "runtime/sharedRuntime.hpp"
  45 #include "runtime/timerTrace.hpp"
  46 #include "runtime/vmThread.hpp"
  47 #include "utilities/ticks.hpp"
  48 
  49 class AbstractLockNode;
  50 class AddPNode;
  51 class Block;
  52 class Bundle;
  53 class CallGenerator;
  54 class CallNode;
  55 class CloneMap;
  56 class ConnectionGraph;
  57 class IdealGraphPrinter;
  58 class InlineTree;
  59 class Int_Array;
  60 class Matcher;
  61 class MachConstantNode;
  62 class MachConstantBaseNode;
  63 class MachNode;
  64 class MachOper;
  65 class MachSafePointNode;
  66 class Node;
  67 class Node_Array;
  68 class Node_List;
  69 class Node_Notes;
  70 class NodeCloneInfo;
  71 class OptoReg;
  72 class PhaseCFG;
  73 class PhaseGVN;
  74 class PhaseIterGVN;
  75 class PhaseRegAlloc;
  76 class PhaseCCP;
  77 class PhaseOutput;
  78 class RootNode;
  79 class relocInfo;
  80 class Scope;
  81 class StartNode;
  82 class SafePointNode;
  83 class JVMState;
  84 class Type;
  85 class TypeData;
  86 class TypeInt;
  87 class TypeInteger;
  88 class TypePtr;
  89 class TypeOopPtr;
  90 class TypeFunc;
  91 class TypeVect;
  92 class Unique_Node_List;
  93 class InlineTypeBaseNode;
  94 class nmethod;
  95 class Node_Stack;
  96 struct Final_Reshape_Counts;
  97 
  98 enum LoopOptsMode {
  99   LoopOptsDefault,
 100   LoopOptsNone,
 101   LoopOptsMaxUnroll,
 102   LoopOptsShenandoahExpand,
 103   LoopOptsShenandoahPostExpand,
 104   LoopOptsSkipSplitIf,
 105   LoopOptsVerify
 106 };
 107 
 108 typedef unsigned int node_idx_t;
 109 class NodeCloneInfo {
 110  private:
 111   uint64_t _idx_clone_orig;
 112  public:
 113 
 114   void set_idx(node_idx_t idx) {
 115     _idx_clone_orig = (_idx_clone_orig & CONST64(0xFFFFFFFF00000000)) | idx;
 116   }
 117   node_idx_t idx() const { return (node_idx_t)(_idx_clone_orig & 0xFFFFFFFF); }
 118 
 119   void set_gen(int generation) {
 120     uint64_t g = (uint64_t)generation << 32;
 121     _idx_clone_orig = (_idx_clone_orig & 0xFFFFFFFF) | g;
 122   }
 123   int gen() const { return (int)(_idx_clone_orig >> 32); }
 124 
 125   void set(uint64_t x) { _idx_clone_orig = x; }
 126   void set(node_idx_t x, int g) { set_idx(x); set_gen(g); }
 127   uint64_t get() const { return _idx_clone_orig; }
 128 
 129   NodeCloneInfo(uint64_t idx_clone_orig) : _idx_clone_orig(idx_clone_orig) {}
 130   NodeCloneInfo(node_idx_t x, int g) : _idx_clone_orig(0) { set(x, g); }
 131 
 132   void dump() const;
 133 };
 134 
 135 class CloneMap {
 136   friend class Compile;
 137  private:
 138   bool      _debug;
 139   Dict*     _dict;
 140   int       _clone_idx;   // current cloning iteration/generation in loop unroll
 141  public:
 142   void*     _2p(node_idx_t key)   const          { return (void*)(intptr_t)key; } // 2 conversion functions to make gcc happy
 143   node_idx_t _2_node_idx_t(const void* k) const  { return (node_idx_t)(intptr_t)k; }
 144   Dict*     dict()                const          { return _dict; }
 145   void insert(node_idx_t key, uint64_t val)      { assert(_dict->operator[](_2p(key)) == NULL, "key existed"); _dict->Insert(_2p(key), (void*)val); }
 146   void insert(node_idx_t key, NodeCloneInfo& ci) { insert(key, ci.get()); }
 147   void remove(node_idx_t key)                    { _dict->Delete(_2p(key)); }
 148   uint64_t value(node_idx_t key)  const          { return (uint64_t)_dict->operator[](_2p(key)); }
 149   node_idx_t idx(node_idx_t key)  const          { return NodeCloneInfo(value(key)).idx(); }
 150   int gen(node_idx_t key)         const          { return NodeCloneInfo(value(key)).gen(); }
 151   int gen(const void* k)          const          { return gen(_2_node_idx_t(k)); }
 152   int max_gen()                   const;
 153   void clone(Node* old, Node* nnn, int gen);
 154   void verify_insert_and_clone(Node* old, Node* nnn, int gen);
 155   void dump(node_idx_t key)       const;
 156 
 157   int  clone_idx() const                         { return _clone_idx; }
 158   void set_clone_idx(int x)                      { _clone_idx = x; }
 159   bool is_debug()                 const          { return _debug; }
 160   void set_debug(bool debug)                     { _debug = debug; }
 161   static const char* debug_option_name;
 162 
 163   bool same_idx(node_idx_t k1, node_idx_t k2)  const { return idx(k1) == idx(k2); }
 164   bool same_gen(node_idx_t k1, node_idx_t k2)  const { return gen(k1) == gen(k2); }
 165 };
 166 
 167 //------------------------------Compile----------------------------------------
 168 // This class defines a top-level Compiler invocation.
 169 
 170 class Compile : public Phase {
 171   friend class VMStructs;
 172 
 173  public:
 174   // Fixed alias indexes.  (See also MergeMemNode.)
 175   enum {
 176     AliasIdxTop = 1,  // pseudo-index, aliases to nothing (used as sentinel value)
 177     AliasIdxBot = 2,  // pseudo-index, aliases to everything
 178     AliasIdxRaw = 3   // hard-wired index for TypeRawPtr::BOTTOM
 179   };
 180 
 181   // Variant of TraceTime(NULL, &_t_accumulator, CITime);
 182   // Integrated with logging.  If logging is turned on, and CITimeVerbose is true,
 183   // then brackets are put into the log, with time stamps and node counts.
 184   // (The time collection itself is always conditionalized on CITime.)
 185   class TracePhase : public TraceTime {
 186    private:
 187     Compile*    C;
 188     CompileLog* _log;
 189     const char* _phase_name;
 190     bool _dolog;
 191    public:
 192     TracePhase(const char* name, elapsedTimer* accumulator);
 193     ~TracePhase();
 194   };
 195 
 196   // Information per category of alias (memory slice)
 197   class AliasType {
 198    private:
 199     friend class Compile;
 200 
 201     int             _index;         // unique index, used with MergeMemNode
 202     const TypePtr*  _adr_type;      // normalized address type
 203     ciField*        _field;         // relevant instance field, or null if none
 204     const Type*     _element;       // relevant array element type, or null if none
 205     bool            _is_rewritable; // false if the memory is write-once only
 206     int             _general_index; // if this is type is an instance, the general
 207                                     // type that this is an instance of
 208 
 209     void Init(int i, const TypePtr* at);
 210 
 211    public:
 212     int             index()         const { return _index; }
 213     const TypePtr*  adr_type()      const { return _adr_type; }
 214     ciField*        field()         const { return _field; }
 215     const Type*     element()       const { return _element; }
 216     bool            is_rewritable() const { return _is_rewritable; }
 217     bool            is_volatile()   const { return (_field ? _field->is_volatile() : false); }
 218     int             general_index() const { return (_general_index != 0) ? _general_index : _index; }
 219 
 220     void set_rewritable(bool z) { _is_rewritable = z; }
 221     void set_field(ciField* f) {
 222       assert(!_field,"");
 223       _field = f;
 224       if (f->is_final() || f->is_stable()) {
 225         // In the case of @Stable, multiple writes are possible but may be assumed to be no-ops.
 226         _is_rewritable = false;
 227       }
 228     }
 229     void set_element(const Type* e) {
 230       assert(_element == NULL, "");
 231       _element = e;
 232     }
 233 
 234     BasicType basic_type() const;
 235 
 236     void print_on(outputStream* st) PRODUCT_RETURN;
 237   };
 238 
 239   enum {
 240     logAliasCacheSize = 6,
 241     AliasCacheSize = (1<<logAliasCacheSize)
 242   };
 243   struct AliasCacheEntry { const TypePtr* _adr_type; int _index; };  // simple duple type
 244   enum {
 245     trapHistLength = MethodData::_trap_hist_limit
 246   };
 247 
 248  private:
 249   // Fixed parameters to this compilation.
 250   const int             _compile_id;
 251   const bool            _subsume_loads;         // Load can be matched as part of a larger op.
 252   const bool            _do_escape_analysis;    // Do escape analysis.
 253   const bool            _install_code;          // Install the code that was compiled
 254   const bool            _eliminate_boxing;      // Do boxing elimination.
 255   const bool            _do_locks_coarsening;   // Do locks coarsening
 256   ciMethod*             _method;                // The method being compiled.
 257   int                   _entry_bci;             // entry bci for osr methods.
 258   const TypeFunc*       _tf;                    // My kind of signature
 259   InlineTree*           _ilt;                   // Ditto (temporary).
 260   address               _stub_function;         // VM entry for stub being compiled, or NULL
 261   const char*           _stub_name;             // Name of stub or adapter being compiled, or NULL
 262   address               _stub_entry_point;      // Compile code entry for generated stub, or NULL
 263 
 264   // Control of this compilation.
 265   int                   _max_inline_size;       // Max inline size for this compilation
 266   int                   _freq_inline_size;      // Max hot method inline size for this compilation
 267   int                   _fixed_slots;           // count of frame slots not allocated by the register
 268                                                 // allocator i.e. locks, original deopt pc, etc.
 269   uintx                 _max_node_limit;        // Max unique node count during a single compilation.
 270 
 271   bool                  _post_loop_opts_phase;  // Loop opts are finished.
 272 
 273   int                   _major_progress;        // Count of something big happening
 274   bool                  _inlining_progress;     // progress doing incremental inlining?
 275   bool                  _inlining_incrementally;// Are we doing incremental inlining (post parse)
 276   bool                  _do_cleanup;            // Cleanup is needed before proceeding with incremental inlining
 277   bool                  _has_loops;             // True if the method _may_ have some loops
 278   bool                  _has_split_ifs;         // True if the method _may_ have some split-if
 279   bool                  _has_unsafe_access;     // True if the method _may_ produce faults in unsafe loads or stores.
 280   bool                  _has_stringbuilder;     // True StringBuffers or StringBuilders are allocated
 281   bool                  _has_boxed_value;       // True if a boxed object is allocated
 282   bool                  _has_reserved_stack_access; // True if the method or an inlined method is annotated with ReservedStackAccess
 283   uint                  _max_vector_size;       // Maximum size of generated vectors
 284   bool                  _clear_upper_avx;       // Clear upper bits of ymm registers using vzeroupper
 285   uint                  _trap_hist[trapHistLength];  // Cumulative traps
 286   bool                  _trap_can_recompile;    // Have we emitted a recompiling trap?
 287   uint                  _decompile_count;       // Cumulative decompilation counts.
 288   bool                  _do_inlining;           // True if we intend to do inlining
 289   bool                  _do_scheduling;         // True if we intend to do scheduling
 290   bool                  _do_freq_based_layout;  // True if we intend to do frequency based block layout
 291   bool                  _do_vector_loop;        // True if allowed to execute loop in parallel iterations
 292   bool                  _use_cmove;             // True if CMove should be used without profitability analysis
 293   bool                  _age_code;              // True if we need to profile code age (decrement the aging counter)
 294   int                   _AliasLevel;            // Locally-adjusted version of AliasLevel flag.
 295   bool                  _print_assembly;        // True if we should dump assembly code for this compilation
 296   bool                  _print_inlining;        // True if we should print inlining for this compilation
 297   bool                  _print_intrinsics;      // True if we should print intrinsics for this compilation
 298 #ifndef PRODUCT
 299   uint                  _igv_idx;               // Counter for IGV node identifiers
 300   bool                  _trace_opto_output;
 301   bool                  _print_ideal;
 302   bool                  _parsed_irreducible_loop; // True if ciTypeFlow detected irreducible loops during parsing
 303 #endif
 304   bool                  _has_irreducible_loop;  // Found irreducible loops
 305   // JSR 292
 306   bool                  _has_method_handle_invokes; // True if this method has MethodHandle invokes.
 307   RTMState              _rtm_state;             // State of Restricted Transactional Memory usage
 308   int                   _loop_opts_cnt;         // loop opts round
 309   bool                  _clinit_barrier_on_entry; // True if clinit barrier is needed on nmethod entry
 310   bool                  _has_flattened_accesses; // Any known flattened array accesses?
 311   bool                  _flattened_accesses_share_alias; // Initially all flattened array share a single slice
 312   bool                  _scalarize_in_safepoints; // Scalarize inline types in safepoint debug info
 313   uint                  _stress_seed;           // Seed for stress testing
 314 
 315   // Compilation environment.
 316   Arena                 _comp_arena;            // Arena with lifetime equivalent to Compile
 317   void*                 _barrier_set_state;     // Potential GC barrier state for Compile
 318   ciEnv*                _env;                   // CI interface
 319   DirectiveSet*         _directive;             // Compiler directive
 320   CompileLog*           _log;                   // from CompilerThread
 321   const char*           _failure_reason;        // for record_failure/failing pattern
 322   GrowableArray<CallGenerator*> _intrinsics;    // List of intrinsics.
 323   GrowableArray<Node*>  _macro_nodes;           // List of nodes which need to be expanded before matching.
 324   GrowableArray<Node*>  _predicate_opaqs;       // List of Opaque1 nodes for the loop predicates.
 325   GrowableArray<Node*>  _skeleton_predicate_opaqs; // List of Opaque4 nodes for the loop skeleton predicates.
 326   GrowableArray<Node*>  _expensive_nodes;       // List of nodes that are expensive to compute and that we'd better not let the GVN freely common
 327   GrowableArray<Node*>  _for_post_loop_igvn;    // List of nodes for IGVN after loop opts are over
 328   GrowableArray<Node*>  _inline_type_nodes;     // List of InlineType nodes
 329   GrowableArray<Node_List*> _coarsened_locks;   // List of coarsened Lock and Unlock nodes
 330   ConnectionGraph*      _congraph;
 331 #ifndef PRODUCT
 332   IdealGraphPrinter*    _printer;
 333   static IdealGraphPrinter* _debug_file_printer;
 334   static IdealGraphPrinter* _debug_network_printer;
 335 #endif
 336 
 337 
 338   // Node management
 339   uint                  _unique;                // Counter for unique Node indices
 340   VectorSet             _dead_node_list;        // Set of dead nodes
 341   uint                  _dead_node_count;       // Number of dead nodes; VectorSet::Size() is O(N).
 342                                                 // So use this to keep count and make the call O(1).
 343   DEBUG_ONLY(Unique_Node_List* _modified_nodes;)   // List of nodes which inputs were modified
 344   DEBUG_ONLY(bool       _phase_optimize_finished;) // Used for live node verification while creating new nodes
 345 
 346   debug_only(static int _debug_idx;)            // Monotonic counter (not reset), use -XX:BreakAtNode=<idx>
 347   Arena                 _node_arena;            // Arena for new-space Nodes
 348   Arena                 _old_arena;             // Arena for old-space Nodes, lifetime during xform
 349   RootNode*             _root;                  // Unique root of compilation, or NULL after bail-out.
 350   Node*                 _top;                   // Unique top node.  (Reset by various phases.)
 351 
 352   Node*                 _immutable_memory;      // Initial memory state
 353 
 354   Node*                 _recent_alloc_obj;
 355   Node*                 _recent_alloc_ctl;
 356 
 357   // Constant table
 358   MachConstantBaseNode* _mach_constant_base_node;  // Constant table base node singleton.
 359 
 360 
 361   // Blocked array of debugging and profiling information,
 362   // tracked per node.
 363   enum { _log2_node_notes_block_size = 8,
 364          _node_notes_block_size = (1<<_log2_node_notes_block_size)
 365   };
 366   GrowableArray<Node_Notes*>* _node_note_array;
 367   Node_Notes*           _default_node_notes;  // default notes for new nodes
 368 
 369   // After parsing and every bulk phase we hang onto the Root instruction.
 370   // The RootNode instruction is where the whole program begins.  It produces
 371   // the initial Control and BOTTOM for everybody else.
 372 
 373   // Type management
 374   Arena                 _Compile_types;         // Arena for all types
 375   Arena*                _type_arena;            // Alias for _Compile_types except in Initialize_shared()
 376   Dict*                 _type_dict;             // Intern table
 377   CloneMap              _clone_map;             // used for recording history of cloned nodes
 378   size_t                _type_last_size;        // Last allocation size (see Type::operator new/delete)
 379   ciMethod*             _last_tf_m;             // Cache for
 380   const TypeFunc*       _last_tf;               //  TypeFunc::make
 381   AliasType**           _alias_types;           // List of alias types seen so far.
 382   int                   _num_alias_types;       // Logical length of _alias_types
 383   int                   _max_alias_types;       // Physical length of _alias_types
 384   AliasCacheEntry       _alias_cache[AliasCacheSize]; // Gets aliases w/o data structure walking
 385 
 386   // Parsing, optimization
 387   PhaseGVN*             _initial_gvn;           // Results of parse-time PhaseGVN
 388   Unique_Node_List*     _for_igvn;              // Initial work-list for next round of Iterative GVN
 389 
 390   GrowableArray<CallGenerator*> _late_inlines;        // List of CallGenerators to be revisited after main parsing has finished.
 391   GrowableArray<CallGenerator*> _string_late_inlines; // same but for string operations
 392   GrowableArray<CallGenerator*> _boxing_late_inlines; // same but for boxing operations
 393 
 394   GrowableArray<CallGenerator*> _vector_reboxing_late_inlines; // same but for vector reboxing operations
 395 
 396   int                           _late_inlines_pos;    // Where in the queue should the next late inlining candidate go (emulate depth first inlining)
 397   uint                          _number_of_mh_late_inlines; // number of method handle late inlining still pending
 398 
 399   GrowableArray<RuntimeStub*>   _native_invokers;
 400 
 401   // Inlining may not happen in parse order which would make
 402   // PrintInlining output confusing. Keep track of PrintInlining
 403   // pieces in order.
 404   class PrintInliningBuffer : public CHeapObj<mtCompiler> {
 405    private:
 406     CallGenerator* _cg;
 407     stringStream   _ss;
 408     static const size_t default_stream_buffer_size = 128;
 409 
 410    public:
 411     PrintInliningBuffer()
 412       : _cg(NULL), _ss(default_stream_buffer_size) {}
 413 
 414     stringStream* ss()             { return &_ss; }
 415     CallGenerator* cg()            { return _cg; }
 416     void set_cg(CallGenerator* cg) { _cg = cg; }
 417   };
 418 
 419   stringStream* _print_inlining_stream;
 420   GrowableArray<PrintInliningBuffer*>* _print_inlining_list;
 421   int _print_inlining_idx;
 422   char* _print_inlining_output;
 423 
 424   // Only keep nodes in the expensive node list that need to be optimized
 425   void cleanup_expensive_nodes(PhaseIterGVN &igvn);
 426   // Use for sorting expensive nodes to bring similar nodes together
 427   static int cmp_expensive_nodes(Node** n1, Node** n2);
 428   // Expensive nodes list already sorted?
 429   bool expensive_nodes_sorted() const;
 430   // Remove the speculative part of types and clean up the graph
 431   void remove_speculative_types(PhaseIterGVN &igvn);
 432 
 433   void* _replay_inline_data; // Pointer to data loaded from file
 434 
 435   void print_inlining_stream_free();
 436   void print_inlining_init();
 437   void print_inlining_reinit();
 438   void print_inlining_commit();
 439   void print_inlining_push();
 440   PrintInliningBuffer* print_inlining_current();
 441 
 442   void log_late_inline_failure(CallGenerator* cg, const char* msg);
 443   DEBUG_ONLY(bool _exception_backedge;)
 444 
 445  public:
 446 
 447   void* barrier_set_state() const { return _barrier_set_state; }
 448 
 449   outputStream* print_inlining_stream() const {
 450     assert(print_inlining() || print_intrinsics(), "PrintInlining off?");
 451     return _print_inlining_stream;
 452   }
 453 
 454   void print_inlining_update(CallGenerator* cg);
 455   void print_inlining_update_delayed(CallGenerator* cg);
 456   void print_inlining_move_to(CallGenerator* cg);
 457   void print_inlining_assert_ready();
 458   void print_inlining_reset();
 459 
 460   void print_inlining(ciMethod* method, int inline_level, int bci, const char* msg = NULL) {
 461     stringStream ss;
 462     CompileTask::print_inlining_inner(&ss, method, inline_level, bci, msg);
 463     print_inlining_stream()->print("%s", ss.as_string());
 464   }
 465 
 466 #ifndef PRODUCT
 467   IdealGraphPrinter* printer() { return _printer; }
 468 #endif
 469 
 470   void log_late_inline(CallGenerator* cg);
 471   void log_inline_id(CallGenerator* cg);
 472   void log_inline_failure(const char* msg);
 473 
 474   void* replay_inline_data() const { return _replay_inline_data; }
 475 
 476   // Dump inlining replay data to the stream.
 477   void dump_inline_data(outputStream* out);
 478 
 479  private:
 480   // Matching, CFG layout, allocation, code generation
 481   PhaseCFG*             _cfg;                   // Results of CFG finding
 482   int                   _java_calls;            // Number of java calls in the method
 483   int                   _inner_loops;           // Number of inner loops in the method
 484   Matcher*              _matcher;               // Engine to map ideal to machine instructions
 485   PhaseRegAlloc*        _regalloc;              // Results of register allocation.
 486   RegMask               _FIRST_STACK_mask;      // All stack slots usable for spills (depends on frame layout)
 487   Arena*                _indexSet_arena;        // control IndexSet allocation within PhaseChaitin
 488   void*                 _indexSet_free_block_list; // free list of IndexSet bit blocks
 489   int                   _interpreter_frame_size;
 490 
 491   PhaseOutput*          _output;
 492 
 493  public:
 494   // Accessors
 495 
 496   // The Compile instance currently active in this (compiler) thread.
 497   static Compile* current() {
 498     return (Compile*) ciEnv::current()->compiler_data();
 499   }
 500 
 501   int interpreter_frame_size() const            { return _interpreter_frame_size; }
 502 
 503   PhaseOutput*      output() const              { return _output; }
 504   void              set_output(PhaseOutput* o)  { _output = o; }
 505 
 506   // ID for this compilation.  Useful for setting breakpoints in the debugger.
 507   int               compile_id() const          { return _compile_id; }
 508   DirectiveSet*     directive() const           { return _directive; }
 509 
 510   // Does this compilation allow instructions to subsume loads?  User
 511   // instructions that subsume a load may result in an unschedulable
 512   // instruction sequence.
 513   bool              subsume_loads() const       { return _subsume_loads; }
 514   /** Do escape analysis. */
 515   bool              do_escape_analysis() const  { return _do_escape_analysis; }
 516   /** Do boxing elimination. */
 517   bool              eliminate_boxing() const    { return _eliminate_boxing; }
 518   /** Do aggressive boxing elimination. */
 519   bool              aggressive_unboxing() const { return _eliminate_boxing && AggressiveUnboxing; }
 520   bool              should_install_code() const { return _install_code; }
 521   /** Do locks coarsening. */
 522   bool              do_locks_coarsening() const { return _do_locks_coarsening; }
 523 
 524   // Other fixed compilation parameters.
 525   ciMethod*         method() const              { return _method; }
 526   int               entry_bci() const           { return _entry_bci; }
 527   bool              is_osr_compilation() const  { return _entry_bci != InvocationEntryBci; }
 528   bool              is_method_compilation() const { return (_method != NULL && !_method->flags().is_native()); }
 529   const TypeFunc*   tf() const                  { assert(_tf!=NULL, ""); return _tf; }
 530   void         init_tf(const TypeFunc* tf)      { assert(_tf==NULL, ""); _tf = tf; }
 531   InlineTree*       ilt() const                 { return _ilt; }
 532   address           stub_function() const       { return _stub_function; }
 533   const char*       stub_name() const           { return _stub_name; }
 534   address           stub_entry_point() const    { return _stub_entry_point; }
 535   void          set_stub_entry_point(address z) { _stub_entry_point = z; }
 536 
 537   // Control of this compilation.
 538   int               fixed_slots() const         { assert(_fixed_slots >= 0, "");         return _fixed_slots; }
 539   void          set_fixed_slots(int n)          { _fixed_slots = n; }
 540   int               major_progress() const      { return _major_progress; }
 541   void          set_inlining_progress(bool z)   { _inlining_progress = z; }
 542   int               inlining_progress() const   { return _inlining_progress; }
 543   void          set_inlining_incrementally(bool z) { _inlining_incrementally = z; }
 544   int               inlining_incrementally() const { return _inlining_incrementally; }
 545   void          set_do_cleanup(bool z)          { _do_cleanup = z; }
 546   int               do_cleanup() const          { return _do_cleanup; }
 547   void          set_major_progress()            { _major_progress++; }
 548   void          restore_major_progress(int progress) { _major_progress += progress; }
 549   void        clear_major_progress()            { _major_progress = 0; }
 550   int               max_inline_size() const     { return _max_inline_size; }
 551   void          set_freq_inline_size(int n)     { _freq_inline_size = n; }
 552   int               freq_inline_size() const    { return _freq_inline_size; }
 553   void          set_max_inline_size(int n)      { _max_inline_size = n; }
 554   bool              has_loops() const           { return _has_loops; }
 555   void          set_has_loops(bool z)           { _has_loops = z; }
 556   bool              has_split_ifs() const       { return _has_split_ifs; }
 557   void          set_has_split_ifs(bool z)       { _has_split_ifs = z; }
 558   bool              has_unsafe_access() const   { return _has_unsafe_access; }
 559   void          set_has_unsafe_access(bool z)   { _has_unsafe_access = z; }
 560   bool              has_stringbuilder() const   { return _has_stringbuilder; }
 561   void          set_has_stringbuilder(bool z)   { _has_stringbuilder = z; }
 562   bool              has_boxed_value() const     { return _has_boxed_value; }
 563   void          set_has_boxed_value(bool z)     { _has_boxed_value = z; }
 564   bool              has_reserved_stack_access() const { return _has_reserved_stack_access; }
 565   void          set_has_reserved_stack_access(bool z) { _has_reserved_stack_access = z; }
 566   uint              max_vector_size() const     { return _max_vector_size; }
 567   void          set_max_vector_size(uint s)     { _max_vector_size = s; }
 568   bool              clear_upper_avx() const     { return _clear_upper_avx; }
 569   void          set_clear_upper_avx(bool s)     { _clear_upper_avx = s; }
 570   void          set_trap_count(uint r, uint c)  { assert(r < trapHistLength, "oob");        _trap_hist[r] = c; }
 571   uint              trap_count(uint r) const    { assert(r < trapHistLength, "oob"); return _trap_hist[r]; }
 572   bool              trap_can_recompile() const  { return _trap_can_recompile; }
 573   void          set_trap_can_recompile(bool z)  { _trap_can_recompile = z; }
 574   uint              decompile_count() const     { return _decompile_count; }
 575   void          set_decompile_count(uint c)     { _decompile_count = c; }
 576   bool              allow_range_check_smearing() const;
 577   bool              do_inlining() const         { return _do_inlining; }
 578   void          set_do_inlining(bool z)         { _do_inlining = z; }
 579   bool              do_scheduling() const       { return _do_scheduling; }
 580   void          set_do_scheduling(bool z)       { _do_scheduling = z; }
 581   bool              do_freq_based_layout() const{ return _do_freq_based_layout; }
 582   void          set_do_freq_based_layout(bool z){ _do_freq_based_layout = z; }
 583   bool              do_vector_loop() const      { return _do_vector_loop; }
 584   void          set_do_vector_loop(bool z)      { _do_vector_loop = z; }
 585   bool              use_cmove() const           { return _use_cmove; }
 586   void          set_use_cmove(bool z)           { _use_cmove = z; }
 587   bool              age_code() const             { return _age_code; }
 588   void          set_age_code(bool z)             { _age_code = z; }
 589   int               AliasLevel() const           { return _AliasLevel; }
 590   bool              print_assembly() const       { return _print_assembly; }
 591   void          set_print_assembly(bool z)       { _print_assembly = z; }
 592   bool              print_inlining() const       { return _print_inlining; }
 593   void          set_print_inlining(bool z)       { _print_inlining = z; }
 594   bool              print_intrinsics() const     { return _print_intrinsics; }
 595   void          set_print_intrinsics(bool z)     { _print_intrinsics = z; }
 596   RTMState          rtm_state()  const           { return _rtm_state; }
 597   void          set_rtm_state(RTMState s)        { _rtm_state = s; }
 598   bool              use_rtm() const              { return (_rtm_state & NoRTM) == 0; }
 599   bool          profile_rtm() const              { return _rtm_state == ProfileRTM; }
 600   uint              max_node_limit() const       { return (uint)_max_node_limit; }
 601   void          set_max_node_limit(uint n)       { _max_node_limit = n; }
 602   bool              clinit_barrier_on_entry()       { return _clinit_barrier_on_entry; }
 603   void          set_clinit_barrier_on_entry(bool z) { _clinit_barrier_on_entry = z; }
 604   void          set_flattened_accesses()         { _has_flattened_accesses = true; }
 605   bool          flattened_accesses_share_alias() const { return _flattened_accesses_share_alias; }
 606   void          set_flattened_accesses_share_alias(bool z) { _flattened_accesses_share_alias = z; }
 607   bool          scalarize_in_safepoints() const { return _scalarize_in_safepoints; }
 608   void          set_scalarize_in_safepoints(bool z) { _scalarize_in_safepoints = z; }
 609 
 610   // Support for scalarized inline type calling convention
 611   bool              has_scalarized_args() const  { return _method != NULL && _method->has_scalarized_args(); }
 612   bool              needs_stack_repair()  const  { return _method != NULL && _method->get_Method()->c2_needs_stack_repair(); }
 613 
 614   // check the CompilerOracle for special behaviours for this compile
 615   bool          method_has_option(enum CompileCommand option) {
 616     return method() != NULL && method()->has_option(option);
 617   }
 618 
 619 #ifndef PRODUCT
 620   uint          next_igv_idx()                  { return _igv_idx++; }
 621   bool          trace_opto_output() const       { return _trace_opto_output; }
 622   bool          print_ideal() const             { return _print_ideal; }
 623   bool              parsed_irreducible_loop() const { return _parsed_irreducible_loop; }
 624   void          set_parsed_irreducible_loop(bool z) { _parsed_irreducible_loop = z; }
 625   int _in_dump_cnt;  // Required for dumping ir nodes.
 626 #endif
 627   bool              has_irreducible_loop() const { return _has_irreducible_loop; }
 628   void          set_has_irreducible_loop(bool z) { _has_irreducible_loop = z; }
 629 
 630   // JSR 292
 631   bool              has_method_handle_invokes() const { return _has_method_handle_invokes;     }
 632   void          set_has_method_handle_invokes(bool z) {        _has_method_handle_invokes = z; }
 633 
 634   Ticks _latest_stage_start_counter;
 635 
 636   void begin_method(int level = 1) {
 637 #ifndef PRODUCT
 638     if (_method != NULL && should_print(level)) {
 639       _printer->begin_method();
 640     }
 641 #endif
 642     C->_latest_stage_start_counter.stamp();
 643   }
 644 
 645   bool should_print(int level = 1) {
 646 #ifndef PRODUCT
 647     if (PrintIdealGraphLevel < 0) { // disabled by the user
 648       return false;
 649     }
 650 
 651     bool need = directive()->IGVPrintLevelOption >= level;
 652     if (need && !_printer) {
 653       _printer = IdealGraphPrinter::printer();
 654       assert(_printer != NULL, "_printer is NULL when we need it!");
 655       _printer->set_compile(this);
 656     }
 657     return need;
 658 #else
 659     return false;
 660 #endif
 661   }
 662 
 663   void print_method(CompilerPhaseType cpt, const char *name, int level = 1);
 664   void print_method(CompilerPhaseType cpt, int level = 1, int idx = 0);
 665   void print_method(CompilerPhaseType cpt, Node* n, int level = 3);
 666 
 667 #ifndef PRODUCT
 668   void igv_print_method_to_file(const char* phase_name = "Debug", bool append = false);
 669   void igv_print_method_to_network(const char* phase_name = "Debug");
 670   static IdealGraphPrinter* debug_file_printer() { return _debug_file_printer; }
 671   static IdealGraphPrinter* debug_network_printer() { return _debug_network_printer; }
 672 #endif
 673 
 674   void end_method(int level = 1);
 675 
 676   int           macro_count()             const { return _macro_nodes.length(); }
 677   int           predicate_count()         const { return _predicate_opaqs.length(); }
 678   int           skeleton_predicate_count() const { return _skeleton_predicate_opaqs.length(); }
 679   int           expensive_count()         const { return _expensive_nodes.length(); }
 680   int           coarsened_count()         const { return _coarsened_locks.length(); }
 681 
 682   Node*         macro_node(int idx)       const { return _macro_nodes.at(idx); }
 683   Node*         predicate_opaque1_node(int idx) const { return _predicate_opaqs.at(idx); }
 684   Node*         skeleton_predicate_opaque4_node(int idx) const { return _skeleton_predicate_opaqs.at(idx); }
 685   Node*         expensive_node(int idx)   const { return _expensive_nodes.at(idx); }
 686 
 687   ConnectionGraph* congraph()                   { return _congraph;}
 688   void set_congraph(ConnectionGraph* congraph)  { _congraph = congraph;}
 689   void add_macro_node(Node * n) {
 690     //assert(n->is_macro(), "must be a macro node");
 691     assert(!_macro_nodes.contains(n), "duplicate entry in expand list");
 692     _macro_nodes.append(n);
 693   }
 694   void remove_macro_node(Node* n) {
 695     // this function may be called twice for a node so we can only remove it
 696     // if it's still existing.
 697     _macro_nodes.remove_if_existing(n);
 698     // remove from _predicate_opaqs list also if it is there
 699     if (predicate_count() > 0) {
 700       _predicate_opaqs.remove_if_existing(n);
 701     }
 702     // Remove from coarsened locks list if present
 703     if (coarsened_count() > 0) {
 704       remove_coarsened_lock(n);
 705     }
 706   }
 707   void add_expensive_node(Node* n);
 708   void remove_expensive_node(Node* n) {
 709     _expensive_nodes.remove_if_existing(n);
 710   }
 711   void add_predicate_opaq(Node* n) {
 712     assert(!_predicate_opaqs.contains(n), "duplicate entry in predicate opaque1");
 713     assert(_macro_nodes.contains(n), "should have already been in macro list");
 714     _predicate_opaqs.append(n);
 715   }
 716   void add_skeleton_predicate_opaq(Node* n) {
 717     assert(!_skeleton_predicate_opaqs.contains(n), "duplicate entry in skeleton predicate opaque4 list");
 718     _skeleton_predicate_opaqs.append(n);
 719   }
 720   void remove_skeleton_predicate_opaq(Node* n) {
 721     if (skeleton_predicate_count() > 0) {
 722       _skeleton_predicate_opaqs.remove_if_existing(n);
 723     }
 724   }
 725   void add_coarsened_locks(GrowableArray<AbstractLockNode*>& locks);
 726   void remove_coarsened_lock(Node* n);
 727   bool coarsened_locks_consistent();
 728 
 729   bool       post_loop_opts_phase() { return _post_loop_opts_phase;  }
 730   void   set_post_loop_opts_phase() { _post_loop_opts_phase = true;  }
 731   void reset_post_loop_opts_phase() { _post_loop_opts_phase = false; }
 732 
 733   void record_for_post_loop_opts_igvn(Node* n);
 734   void remove_from_post_loop_opts_igvn(Node* n);
 735   void process_for_post_loop_opts_igvn(PhaseIterGVN& igvn);
 736 
 737   // Keep track of inline type nodes for later processing
 738   void add_inline_type(Node* n);
 739   void remove_inline_type(Node* n);
 740   void process_inline_types(PhaseIterGVN &igvn, bool remove = false);
 741 
 742   void adjust_flattened_array_access_aliases(PhaseIterGVN& igvn);
 743 
 744   void sort_macro_nodes();
 745 
 746   // remove the opaque nodes that protect the predicates so that the unused checks and
 747   // uncommon traps will be eliminated from the graph.
 748   void cleanup_loop_predicates(PhaseIterGVN &igvn);
 749   bool is_predicate_opaq(Node* n) {
 750     return _predicate_opaqs.contains(n);
 751   }
 752 
 753   // Are there candidate expensive nodes for optimization?
 754   bool should_optimize_expensive_nodes(PhaseIterGVN &igvn);
 755   // Check whether n1 and n2 are similar
 756   static int cmp_expensive_nodes(Node* n1, Node* n2);
 757   // Sort expensive nodes to locate similar expensive nodes
 758   void sort_expensive_nodes();
 759 
 760   // Compilation environment.
 761   Arena*      comp_arena()           { return &_comp_arena; }
 762   ciEnv*      env() const            { return _env; }
 763   CompileLog* log() const            { return _log; }
 764   bool        failing() const        { return _env->failing() || _failure_reason != NULL; }
 765   const char* failure_reason() const { return (_env->failing()) ? _env->failure_reason() : _failure_reason; }
 766 
 767   bool failure_reason_is(const char* r) const {
 768     return (r == _failure_reason) || (r != NULL && _failure_reason != NULL && strcmp(r, _failure_reason) == 0);
 769   }
 770 
 771   void record_failure(const char* reason);
 772   void record_method_not_compilable(const char* reason) {
 773     env()->record_method_not_compilable(reason);
 774     // Record failure reason.
 775     record_failure(reason);
 776   }
 777   bool check_node_count(uint margin, const char* reason) {
 778     if (live_nodes() + margin > max_node_limit()) {
 779       record_method_not_compilable(reason);
 780       return true;
 781     } else {
 782       return false;
 783     }
 784   }
 785 
 786   // Node management
 787   uint         unique() const              { return _unique; }
 788   uint         next_unique()               { return _unique++; }
 789   void         set_unique(uint i)          { _unique = i; }
 790   static int   debug_idx()                 { return debug_only(_debug_idx)+0; }
 791   static void  set_debug_idx(int i)        { debug_only(_debug_idx = i); }
 792   Arena*       node_arena()                { return &_node_arena; }
 793   Arena*       old_arena()                 { return &_old_arena; }
 794   RootNode*    root() const                { return _root; }
 795   void         set_root(RootNode* r)       { _root = r; }
 796   StartNode*   start() const;              // (Derived from root.)
 797   void         init_start(StartNode* s);
 798   Node*        immutable_memory();
 799 
 800   Node*        recent_alloc_ctl() const    { return _recent_alloc_ctl; }
 801   Node*        recent_alloc_obj() const    { return _recent_alloc_obj; }
 802   void         set_recent_alloc(Node* ctl, Node* obj) {
 803                                                   _recent_alloc_ctl = ctl;
 804                                                   _recent_alloc_obj = obj;
 805                                            }
 806   void         record_dead_node(uint idx)  { if (_dead_node_list.test_set(idx)) return;
 807                                              _dead_node_count++;
 808                                            }
 809   void         reset_dead_node_list()      { _dead_node_list.reset();
 810                                              _dead_node_count = 0;
 811                                            }
 812   uint          live_nodes() const         {
 813     int  val = _unique - _dead_node_count;
 814     assert (val >= 0, "number of tracked dead nodes %d more than created nodes %d", _unique, _dead_node_count);
 815             return (uint) val;
 816                                            }
 817 #ifdef ASSERT
 818   void         set_phase_optimize_finished() { _phase_optimize_finished = true; }
 819   bool         phase_optimize_finished() const { return _phase_optimize_finished; }
 820   uint         count_live_nodes_by_graph_walk();
 821   void         print_missing_nodes();
 822 #endif
 823 
 824   // Record modified nodes to check that they are put on IGVN worklist
 825   void         record_modified_node(Node* n) NOT_DEBUG_RETURN;
 826   void         remove_modified_node(Node* n) NOT_DEBUG_RETURN;
 827   DEBUG_ONLY( Unique_Node_List*   modified_nodes() const { return _modified_nodes; } )
 828 
 829   MachConstantBaseNode*     mach_constant_base_node();
 830   bool                  has_mach_constant_base_node() const { return _mach_constant_base_node != NULL; }
 831   // Generated by adlc, true if CallNode requires MachConstantBase.
 832   bool                      needs_deep_clone_jvms();
 833 
 834   // Handy undefined Node
 835   Node*             top() const                 { return _top; }
 836 
 837   // these are used by guys who need to know about creation and transformation of top:
 838   Node*             cached_top_node()           { return _top; }
 839   void          set_cached_top_node(Node* tn);
 840 
 841   GrowableArray<Node_Notes*>* node_note_array() const { return _node_note_array; }
 842   void set_node_note_array(GrowableArray<Node_Notes*>* arr) { _node_note_array = arr; }
 843   Node_Notes* default_node_notes() const        { return _default_node_notes; }
 844   void    set_default_node_notes(Node_Notes* n) { _default_node_notes = n; }
 845 
 846   Node_Notes*       node_notes_at(int idx) {
 847     return locate_node_notes(_node_note_array, idx, false);
 848   }
 849   inline bool   set_node_notes_at(int idx, Node_Notes* value);
 850 
 851   // Copy notes from source to dest, if they exist.
 852   // Overwrite dest only if source provides something.
 853   // Return true if information was moved.
 854   bool copy_node_notes_to(Node* dest, Node* source);
 855 
 856   // Workhorse function to sort out the blocked Node_Notes array:
 857   inline Node_Notes* locate_node_notes(GrowableArray<Node_Notes*>* arr,
 858                                        int idx, bool can_grow = false);
 859 
 860   void grow_node_notes(GrowableArray<Node_Notes*>* arr, int grow_by);
 861 
 862   // Type management
 863   Arena*            type_arena()                { return _type_arena; }
 864   Dict*             type_dict()                 { return _type_dict; }
 865   size_t            type_last_size()            { return _type_last_size; }
 866   int               num_alias_types()           { return _num_alias_types; }
 867 
 868   void          init_type_arena()                       { _type_arena = &_Compile_types; }
 869   void          set_type_arena(Arena* a)                { _type_arena = a; }
 870   void          set_type_dict(Dict* d)                  { _type_dict = d; }
 871   void          set_type_last_size(size_t sz)           { _type_last_size = sz; }
 872 
 873   const TypeFunc* last_tf(ciMethod* m) {
 874     return (m == _last_tf_m) ? _last_tf : NULL;
 875   }
 876   void set_last_tf(ciMethod* m, const TypeFunc* tf) {
 877     assert(m != NULL || tf == NULL, "");
 878     _last_tf_m = m;
 879     _last_tf = tf;
 880   }
 881 
 882   AliasType*        alias_type(int                idx)  { assert(idx < num_alias_types(), "oob"); return _alias_types[idx]; }
 883   AliasType*        alias_type(const TypePtr* adr_type, ciField* field = NULL, bool uncached = false) { return find_alias_type(adr_type, false, field, uncached); }
 884   bool         have_alias_type(const TypePtr* adr_type);
 885   AliasType*        alias_type(ciField*         field);
 886 
 887   int               get_alias_index(const TypePtr* at, bool uncached = false) { return alias_type(at, NULL, uncached)->index(); }
 888   const TypePtr*    get_adr_type(uint aidx)             { return alias_type(aidx)->adr_type(); }
 889   int               get_general_index(uint aidx)        { return alias_type(aidx)->general_index(); }
 890 
 891   // Building nodes
 892   void              rethrow_exceptions(JVMState* jvms);
 893   void              return_values(JVMState* jvms);
 894   JVMState*         build_start_state(StartNode* start, const TypeFunc* tf);
 895 
 896   // Decide how to build a call.
 897   // The profile factor is a discount to apply to this site's interp. profile.
 898   CallGenerator*    call_generator(ciMethod* call_method, int vtable_index, bool call_does_dispatch,
 899                                    JVMState* jvms, bool allow_inline, float profile_factor, ciKlass* speculative_receiver_type = NULL,
 900                                    bool allow_intrinsics = true);
 901   bool should_delay_inlining(ciMethod* call_method, JVMState* jvms) {
 902     return should_delay_string_inlining(call_method, jvms) ||
 903            should_delay_boxing_inlining(call_method, jvms) ||
 904            should_delay_vector_inlining(call_method, jvms);
 905   }
 906   bool should_delay_string_inlining(ciMethod* call_method, JVMState* jvms);
 907   bool should_delay_boxing_inlining(ciMethod* call_method, JVMState* jvms);
 908   bool should_delay_vector_inlining(ciMethod* call_method, JVMState* jvms);
 909   bool should_delay_vector_reboxing_inlining(ciMethod* call_method, JVMState* jvms);
 910 
 911   // Helper functions to identify inlining potential at call-site
 912   ciMethod* optimize_virtual_call(ciMethod* caller, ciInstanceKlass* klass,
 913                                   ciKlass* holder, ciMethod* callee,
 914                                   const TypeOopPtr* receiver_type, bool is_virtual,
 915                                   bool &call_does_dispatch, int &vtable_index,
 916                                   bool check_access = true);
 917   ciMethod* optimize_inlining(ciMethod* caller, ciInstanceKlass* klass, ciKlass* holder,
 918                               ciMethod* callee, const TypeOopPtr* receiver_type,
 919                               bool check_access = true);
 920 
 921   // Report if there were too many traps at a current method and bci.
 922   // Report if a trap was recorded, and/or PerMethodTrapLimit was exceeded.
 923   // If there is no MDO at all, report no trap unless told to assume it.
 924   bool too_many_traps(ciMethod* method, int bci, Deoptimization::DeoptReason reason);
 925   // This version, unspecific to a particular bci, asks if
 926   // PerMethodTrapLimit was exceeded for all inlined methods seen so far.
 927   bool too_many_traps(Deoptimization::DeoptReason reason,
 928                       // Privately used parameter for logging:
 929                       ciMethodData* logmd = NULL);
 930   // Report if there were too many recompiles at a method and bci.
 931   bool too_many_recompiles(ciMethod* method, int bci, Deoptimization::DeoptReason reason);
 932   // Report if there were too many traps or recompiles at a method and bci.
 933   bool too_many_traps_or_recompiles(ciMethod* method, int bci, Deoptimization::DeoptReason reason) {
 934     return too_many_traps(method, bci, reason) ||
 935            too_many_recompiles(method, bci, reason);
 936   }
 937   // Return a bitset with the reasons where deoptimization is allowed,
 938   // i.e., where there were not too many uncommon traps.
 939   int _allowed_reasons;
 940   int      allowed_deopt_reasons() { return _allowed_reasons; }
 941   void set_allowed_deopt_reasons();
 942 
 943   // Parsing, optimization
 944   PhaseGVN*         initial_gvn()               { return _initial_gvn; }
 945   Unique_Node_List* for_igvn()                  { return _for_igvn; }
 946   inline void       record_for_igvn(Node* n);   // Body is after class Unique_Node_List.
 947   void          set_initial_gvn(PhaseGVN *gvn)           { _initial_gvn = gvn; }
 948   void          set_for_igvn(Unique_Node_List *for_igvn) { _for_igvn = for_igvn; }
 949 
 950   // Replace n by nn using initial_gvn, calling hash_delete and
 951   // record_for_igvn as needed.
 952   void gvn_replace_by(Node* n, Node* nn);
 953 
 954 
 955   void              identify_useful_nodes(Unique_Node_List &useful);
 956   void              update_dead_node_list(Unique_Node_List &useful);
 957   void              disconnect_useless_nodes(Unique_Node_List &useful, Unique_Node_List* worklist);
 958 
 959   void              remove_useless_node(Node* dead);
 960 
 961   // Record this CallGenerator for inlining at the end of parsing.
 962   void              add_late_inline(CallGenerator* cg)        {
 963     _late_inlines.insert_before(_late_inlines_pos, cg);
 964     _late_inlines_pos++;
 965   }
 966 
 967   void              prepend_late_inline(CallGenerator* cg)    {
 968     _late_inlines.insert_before(0, cg);
 969   }
 970 
 971   void              add_string_late_inline(CallGenerator* cg) {
 972     _string_late_inlines.push(cg);
 973   }
 974 
 975   void              add_boxing_late_inline(CallGenerator* cg) {
 976     _boxing_late_inlines.push(cg);
 977   }
 978 
 979   void              add_vector_reboxing_late_inline(CallGenerator* cg) {
 980     _vector_reboxing_late_inlines.push(cg);
 981   }
 982 
 983   void add_native_invoker(RuntimeStub* stub);
 984 
 985   const GrowableArray<RuntimeStub*> native_invokers() const { return _native_invokers; }
 986 
 987   void remove_useless_nodes       (GrowableArray<Node*>&        node_list, Unique_Node_List &useful);
 988 
 989   void remove_useless_late_inlines(GrowableArray<CallGenerator*>* inlines, Unique_Node_List &useful);
 990   void remove_useless_late_inlines(GrowableArray<CallGenerator*>* inlines, Node* dead);
 991 
 992   void remove_useless_coarsened_locks(Unique_Node_List& useful);
 993 
 994   void process_print_inlining();
 995   void dump_print_inlining();
 996 
 997   bool over_inlining_cutoff() const {
 998     if (!inlining_incrementally()) {
 999       return unique() > (uint)NodeCountInliningCutoff;
1000     } else {
1001       // Give some room for incremental inlining algorithm to "breathe"
1002       // and avoid thrashing when live node count is close to the limit.
1003       // Keep in mind that live_nodes() isn't accurate during inlining until
1004       // dead node elimination step happens (see Compile::inline_incrementally).
1005       return live_nodes() > (uint)LiveNodeCountInliningCutoff * 11 / 10;
1006     }
1007   }
1008 
1009   void inc_number_of_mh_late_inlines() { _number_of_mh_late_inlines++; }
1010   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--; }
1011   bool has_mh_late_inlines() const     { return _number_of_mh_late_inlines > 0; }
1012 
1013   bool inline_incrementally_one();
1014   void inline_incrementally_cleanup(PhaseIterGVN& igvn);
1015   void inline_incrementally(PhaseIterGVN& igvn);
1016   void inline_string_calls(bool parse_time);
1017   void inline_boxing_calls(PhaseIterGVN& igvn);
1018   bool optimize_loops(PhaseIterGVN& igvn, LoopOptsMode mode);
1019   void remove_root_to_sfpts_edges(PhaseIterGVN& igvn);
1020 
1021   void inline_vector_reboxing_calls();
1022   bool has_vbox_nodes();
1023 
1024   void process_late_inline_calls_no_inline(PhaseIterGVN& igvn);
1025 
1026   // Matching, CFG layout, allocation, code generation
1027   PhaseCFG*         cfg()                       { return _cfg; }
1028   bool              has_java_calls() const      { return _java_calls > 0; }
1029   int               java_calls() const          { return _java_calls; }
1030   int               inner_loops() const         { return _inner_loops; }
1031   Matcher*          matcher()                   { return _matcher; }
1032   PhaseRegAlloc*    regalloc()                  { return _regalloc; }
1033   RegMask&          FIRST_STACK_mask()          { return _FIRST_STACK_mask; }
1034   Arena*            indexSet_arena()            { return _indexSet_arena; }
1035   void*             indexSet_free_block_list()  { return _indexSet_free_block_list; }
1036   DebugInformationRecorder* debug_info()        { return env()->debug_info(); }
1037 
1038   void  update_interpreter_frame_size(int size) {
1039     if (_interpreter_frame_size < size) {
1040       _interpreter_frame_size = size;
1041     }
1042   }
1043 
1044   void          set_matcher(Matcher* m)                 { _matcher = m; }
1045 //void          set_regalloc(PhaseRegAlloc* ra)           { _regalloc = ra; }
1046   void          set_indexSet_arena(Arena* a)            { _indexSet_arena = a; }
1047   void          set_indexSet_free_block_list(void* p)   { _indexSet_free_block_list = p; }
1048 
1049   void  set_java_calls(int z) { _java_calls  = z; }
1050   void set_inner_loops(int z) { _inner_loops = z; }
1051 
1052   Dependencies* dependencies() { return env()->dependencies(); }
1053 
1054   // Major entry point.  Given a Scope, compile the associated method.
1055   // For normal compilations, entry_bci is InvocationEntryBci.  For on stack
1056   // replacement, entry_bci indicates the bytecode for which to compile a
1057   // continuation.
1058   Compile(ciEnv* ci_env, ciMethod* target,
1059           int entry_bci, bool subsume_loads, bool do_escape_analysis,
1060           bool eliminate_boxing, bool do_locks_coarsening,
1061           bool install_code, DirectiveSet* directive);
1062 
1063   // Second major entry point.  From the TypeFunc signature, generate code
1064   // to pass arguments from the Java calling convention to the C calling
1065   // convention.
1066   Compile(ciEnv* ci_env, const TypeFunc *(*gen)(),
1067           address stub_function, const char *stub_name,
1068           int is_fancy_jump, bool pass_tls,
1069           bool return_pc, DirectiveSet* directive);
1070 
1071   // Are we compiling a method?
1072   bool has_method() { return method() != NULL; }
1073 
1074   // Maybe print some information about this compile.
1075   void print_compile_messages();
1076 
1077   // Final graph reshaping, a post-pass after the regular optimizer is done.
1078   bool final_graph_reshaping();
1079 
1080   // returns true if adr is completely contained in the given alias category
1081   bool must_alias(const TypePtr* adr, int alias_idx);
1082 
1083   // returns true if adr overlaps with the given alias category
1084   bool can_alias(const TypePtr* adr, int alias_idx);
1085 
1086   // Stack slots that may be unused by the calling convention but must
1087   // otherwise be preserved.  On Intel this includes the return address.
1088   // On PowerPC it includes the 4 words holding the old TOC & LR glue.
1089   uint in_preserve_stack_slots() {
1090     return SharedRuntime::in_preserve_stack_slots();
1091   }
1092 
1093   // "Top of Stack" slots that may be unused by the calling convention but must
1094   // otherwise be preserved.
1095   // On Intel these are not necessary and the value can be zero.
1096   static uint out_preserve_stack_slots() {
1097     return SharedRuntime::out_preserve_stack_slots();
1098   }
1099 
1100   // Number of outgoing stack slots killed above the out_preserve_stack_slots
1101   // for calls to C.  Supports the var-args backing area for register parms.
1102   uint varargs_C_out_slots_killed() const;
1103 
1104   // Number of Stack Slots consumed by a synchronization entry
1105   int sync_stack_slots() const;
1106 
1107   // Compute the name of old_SP.  See <arch>.ad for frame layout.
1108   OptoReg::Name compute_old_SP();
1109 
1110  private:
1111   // Phase control:
1112   void Init(int aliaslevel);                     // Prepare for a single compilation
1113   int  Inline_Warm();                            // Find more inlining work.
1114   void Finish_Warm();                            // Give up on further inlines.
1115   void Optimize();                               // Given a graph, optimize it
1116   void Code_Gen();                               // Generate code from a graph
1117 
1118   // Management of the AliasType table.
1119   void grow_alias_types();
1120   AliasCacheEntry* probe_alias_cache(const TypePtr* adr_type);
1121   const TypePtr *flatten_alias_type(const TypePtr* adr_type) const;
1122   AliasType* find_alias_type(const TypePtr* adr_type, bool no_create, ciField* field, bool uncached = false);
1123 
1124   void verify_top(Node*) const PRODUCT_RETURN;
1125 
1126   // Intrinsic setup.
1127   CallGenerator* make_vm_intrinsic(ciMethod* m, bool is_virtual);          // constructor
1128   int            intrinsic_insertion_index(ciMethod* m, bool is_virtual, bool& found);  // helper
1129   CallGenerator* find_intrinsic(ciMethod* m, bool is_virtual);             // query fn
1130   void           register_intrinsic(CallGenerator* cg);                    // update fn
1131 
1132 #ifndef PRODUCT
1133   static juint  _intrinsic_hist_count[];
1134   static jubyte _intrinsic_hist_flags[];
1135 #endif
1136   // Function calls made by the public function final_graph_reshaping.
1137   // No need to be made public as they are not called elsewhere.
1138   void final_graph_reshaping_impl( Node *n, Final_Reshape_Counts &frc);
1139   void final_graph_reshaping_main_switch(Node* n, Final_Reshape_Counts& frc, uint nop);
1140   void final_graph_reshaping_walk( Node_Stack &nstack, Node *root, Final_Reshape_Counts &frc );
1141   void eliminate_redundant_card_marks(Node* n);
1142 
1143   // Logic cone optimization.
1144   void optimize_logic_cones(PhaseIterGVN &igvn);
1145   void collect_logic_cone_roots(Unique_Node_List& list);
1146   void process_logic_cone_root(PhaseIterGVN &igvn, Node* n, VectorSet& visited);
1147   bool compute_logic_cone(Node* n, Unique_Node_List& partition, Unique_Node_List& inputs);
1148   uint compute_truth_table(Unique_Node_List& partition, Unique_Node_List& inputs);
1149   uint eval_macro_logic_op(uint func, uint op1, uint op2, uint op3);
1150   Node* xform_to_MacroLogicV(PhaseIterGVN &igvn, const TypeVect* vt, Unique_Node_List& partitions, Unique_Node_List& inputs);
1151   void check_no_dead_use() const NOT_DEBUG_RETURN;
1152 
1153  public:
1154 
1155   // Note:  Histogram array size is about 1 Kb.
1156   enum {                        // flag bits:
1157     _intrinsic_worked = 1,      // succeeded at least once
1158     _intrinsic_failed = 2,      // tried it but it failed
1159     _intrinsic_disabled = 4,    // was requested but disabled (e.g., -XX:-InlineUnsafeOps)
1160     _intrinsic_virtual = 8,     // was seen in the virtual form (rare)
1161     _intrinsic_both = 16        // was seen in the non-virtual form (usual)
1162   };
1163   // Update histogram.  Return boolean if this is a first-time occurrence.
1164   static bool gather_intrinsic_statistics(vmIntrinsics::ID id,
1165                                           bool is_virtual, int flags) PRODUCT_RETURN0;
1166   static void print_intrinsic_statistics() PRODUCT_RETURN;
1167 
1168   // Graph verification code
1169   // Walk the node list, verifying that there is a one-to-one
1170   // correspondence between Use-Def edges and Def-Use edges
1171   // The option no_dead_code enables stronger checks that the
1172   // graph is strongly connected from root in both directions.
1173   void verify_graph_edges(bool no_dead_code = false) PRODUCT_RETURN;
1174 
1175   // End-of-run dumps.
1176   static void print_statistics() PRODUCT_RETURN;
1177 
1178   // Verify ADLC assumptions during startup
1179   static void adlc_verification() PRODUCT_RETURN;
1180 
1181   // Definitions of pd methods
1182   static void pd_compiler2_init();
1183 
1184   // Static parse-time type checking logic for gen_subtype_check:
1185   enum { SSC_always_false, SSC_always_true, SSC_easy_test, SSC_full_test };
1186   int static_subtype_check(ciKlass* superk, ciKlass* subk);
1187 
1188   static Node* conv_I2X_index(PhaseGVN* phase, Node* offset, const TypeInt* sizetype,
1189                               // Optional control dependency (for example, on range check)
1190                               Node* ctrl = NULL);
1191 
1192   // Convert integer value to a narrowed long type dependent on ctrl (for example, a range check)
1193   static Node* constrained_convI2L(PhaseGVN* phase, Node* value, const TypeInt* itype, Node* ctrl, bool carry_dependency = false);
1194 
1195   Node* optimize_acmp(PhaseGVN* phase, Node* a, Node* b);
1196 
1197   // Auxiliary method for randomized fuzzing/stressing
1198   int random();
1199   bool randomized_select(int count);
1200 
1201   // supporting clone_map
1202   CloneMap&     clone_map();
1203   void          set_clone_map(Dict* d);
1204 
1205   bool needs_clinit_barrier(ciField* ik,         ciMethod* accessing_method);
1206   bool needs_clinit_barrier(ciMethod* ik,        ciMethod* accessing_method);
1207   bool needs_clinit_barrier(ciInstanceKlass* ik, ciMethod* accessing_method);
1208 
1209 #ifdef IA32
1210  private:
1211   bool _select_24_bit_instr;   // We selected an instruction with a 24-bit result
1212   bool _in_24_bit_fp_mode;     // We are emitting instructions with 24-bit results
1213 
1214   // Remember if this compilation changes hardware mode to 24-bit precision.
1215   void set_24_bit_selection_and_mode(bool selection, bool mode) {
1216     _select_24_bit_instr = selection;
1217     _in_24_bit_fp_mode   = mode;
1218   }
1219 
1220  public:
1221   bool select_24_bit_instr() const { return _select_24_bit_instr; }
1222   bool in_24_bit_fp_mode() const   { return _in_24_bit_fp_mode; }
1223 #endif // IA32
1224 #ifdef ASSERT
1225   bool _type_verify_symmetry;
1226   void set_exception_backedge() { _exception_backedge = true; }
1227   bool has_exception_backedge() const { return _exception_backedge; }
1228 #endif
1229 
1230   static bool push_thru_add(PhaseGVN* phase, Node* z, const TypeInteger* tz, const TypeInteger*& rx, const TypeInteger*& ry,
1231                             BasicType bt);
1232 
1233   static Node* narrow_value(BasicType bt, Node* value, const Type* type, PhaseGVN* phase, bool transform_res);
1234 };
1235 
1236 #endif // SHARE_OPTO_COMPILE_HPP