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