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