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