1 /*
   2  * Copyright (c) 1997, 2010, 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 class Block;
  26 class Bundle;
  27 class C2Compiler;
  28 class CallGenerator;
  29 class ConnectionGraph;
  30 class InlineTree;
  31 class Int_Array;
  32 class Matcher;
  33 class MachConstantBaseNode;
  34 class MachNode;
  35 class MachSafePointNode;
  36 class Node;
  37 class Node_Array;
  38 class Node_Notes;
  39 class OptoReg;
  40 class PhaseCFG;
  41 class PhaseGVN;
  42 class PhaseIterGVN;
  43 class PhaseRegAlloc;
  44 class PhaseCCP;
  45 class PhaseCCP_DCE;
  46 class RootNode;
  47 class relocInfo;
  48 class Scope;
  49 class StartNode;
  50 class SafePointNode;
  51 class JVMState;
  52 class TypeData;
  53 class TypePtr;
  54 class TypeFunc;
  55 class Unique_Node_List;
  56 class nmethod;
  57 class WarmCallInfo;
  58 
  59 //------------------------------Compile----------------------------------------
  60 // This class defines a top-level Compiler invocation.
  61 
  62 class Compile : public Phase {
  63  public:
  64   // Fixed alias indexes.  (See also MergeMemNode.)
  65   enum {
  66     AliasIdxTop = 1,  // pseudo-index, aliases to nothing (used as sentinel value)
  67     AliasIdxBot = 2,  // pseudo-index, aliases to everything
  68     AliasIdxRaw = 3   // hard-wired index for TypeRawPtr::BOTTOM
  69   };
  70 
  71   // Variant of TraceTime(NULL, &_t_accumulator, TimeCompiler);
  72   // Integrated with logging.  If logging is turned on, and dolog is true,
  73   // then brackets are put into the log, with time stamps and node counts.
  74   // (The time collection itself is always conditionalized on TimeCompiler.)
  75   class TracePhase : public TraceTime {
  76    private:
  77     Compile*    C;
  78     CompileLog* _log;
  79    public:
  80     TracePhase(const char* name, elapsedTimer* accumulator, bool dolog);
  81     ~TracePhase();
  82   };
  83 
  84   // Information per category of alias (memory slice)
  85   class AliasType {
  86    private:
  87     friend class Compile;
  88 
  89     int             _index;         // unique index, used with MergeMemNode
  90     const TypePtr*  _adr_type;      // normalized address type
  91     ciField*        _field;         // relevant instance field, or null if none
  92     bool            _is_rewritable; // false if the memory is write-once only
  93     int             _general_index; // if this is type is an instance, the general
  94                                     // type that this is an instance of
  95 
  96     void Init(int i, const TypePtr* at);
  97 
  98    public:
  99     int             index()         const { return _index; }
 100     const TypePtr*  adr_type()      const { return _adr_type; }
 101     ciField*        field()         const { return _field; }
 102     bool            is_rewritable() const { return _is_rewritable; }
 103     bool            is_volatile()   const { return (_field ? _field->is_volatile() : false); }
 104     int             general_index() const { return (_general_index != 0) ? _general_index : _index; }
 105 
 106     void set_rewritable(bool z) { _is_rewritable = z; }
 107     void set_field(ciField* f) {
 108       assert(!_field,"");
 109       _field = f;
 110       if (f->is_final())  _is_rewritable = false;
 111     }
 112 
 113     void print_on(outputStream* st) PRODUCT_RETURN;
 114   };
 115 
 116   enum {
 117     logAliasCacheSize = 6,
 118     AliasCacheSize = (1<<logAliasCacheSize)
 119   };
 120   struct AliasCacheEntry { const TypePtr* _adr_type; int _index; };  // simple duple type
 121   enum {
 122     trapHistLength = methodDataOopDesc::_trap_hist_limit
 123   };
 124 
 125  private:
 126   // Fixed parameters to this compilation.
 127   const int             _compile_id;
 128   const bool            _save_argument_registers; // save/restore arg regs for trampolines
 129   const bool            _subsume_loads;         // Load can be matched as part of a larger op.
 130   const bool            _do_escape_analysis;    // Do escape analysis.
 131   ciMethod*             _method;                // The method being compiled.
 132   int                   _entry_bci;             // entry bci for osr methods.
 133   const TypeFunc*       _tf;                    // My kind of signature
 134   InlineTree*           _ilt;                   // Ditto (temporary).
 135   address               _stub_function;         // VM entry for stub being compiled, or NULL
 136   const char*           _stub_name;             // Name of stub or adapter being compiled, or NULL
 137   address               _stub_entry_point;      // Compile code entry for generated stub, or NULL
 138 
 139   // Control of this compilation.
 140   int                   _num_loop_opts;         // Number of iterations for doing loop optimiztions
 141   int                   _max_inline_size;       // Max inline size for this compilation
 142   int                   _freq_inline_size;      // Max hot method inline size for this compilation
 143   int                   _fixed_slots;           // count of frame slots not allocated by the register
 144                                                 // allocator i.e. locks, original deopt pc, etc.
 145   // For deopt
 146   int                   _orig_pc_slot;
 147   int                   _orig_pc_slot_offset_in_bytes;
 148 
 149   int                   _major_progress;        // Count of something big happening
 150   bool                  _has_loops;             // True if the method _may_ have some loops
 151   bool                  _has_split_ifs;         // True if the method _may_ have some split-if
 152   bool                  _has_unsafe_access;     // True if the method _may_ produce faults in unsafe loads or stores.
 153   bool                  _has_stringbuilder;     // True StringBuffers or StringBuilders are allocated
 154   uint                  _trap_hist[trapHistLength];  // Cumulative traps
 155   bool                  _trap_can_recompile;    // Have we emitted a recompiling trap?
 156   uint                  _decompile_count;       // Cumulative decompilation counts.
 157   bool                  _do_inlining;           // True if we intend to do inlining
 158   bool                  _do_scheduling;         // True if we intend to do scheduling
 159   bool                  _do_freq_based_layout;  // True if we intend to do frequency based block layout
 160   bool                  _do_count_invocations;  // True if we generate code to count invocations
 161   bool                  _do_method_data_update; // True if we generate code to update methodDataOops
 162   int                   _AliasLevel;            // Locally-adjusted version of AliasLevel flag.
 163   bool                  _print_assembly;        // True if we should dump assembly code for this compilation
 164 #ifndef PRODUCT
 165   bool                  _trace_opto_output;
 166   bool                  _parsed_irreducible_loop; // True if ciTypeFlow detected irreducible loops during parsing
 167 #endif
 168 
 169   // JSR 292
 170   bool                  _has_method_handle_invokes; // True if this method has MethodHandle invokes.
 171 
 172   // Compilation environment.
 173   Arena                 _comp_arena;            // Arena with lifetime equivalent to Compile
 174   ciEnv*                _env;                   // CI interface
 175   CompileLog*           _log;                   // from CompilerThread
 176   const char*           _failure_reason;        // for record_failure/failing pattern
 177   GrowableArray<CallGenerator*>* _intrinsics;   // List of intrinsics.
 178   GrowableArray<Node*>* _macro_nodes;           // List of nodes which need to be expanded before matching.
 179   GrowableArray<Node*>* _predicate_opaqs;       // List of Opaque1 nodes for the loop predicates.
 180   ConnectionGraph*      _congraph;
 181 #ifndef PRODUCT
 182   IdealGraphPrinter*    _printer;
 183 #endif
 184 
 185   // Node management
 186   uint                  _unique;                // Counter for unique Node indices
 187   debug_only(static int _debug_idx;)            // Monotonic counter (not reset), use -XX:BreakAtNode=<idx>
 188   Arena                 _node_arena;            // Arena for new-space Nodes
 189   Arena                 _old_arena;             // Arena for old-space Nodes, lifetime during xform
 190   RootNode*             _root;                  // Unique root of compilation, or NULL after bail-out.
 191   Node*                 _top;                   // Unique top node.  (Reset by various phases.)
 192 
 193   Node*                 _immutable_memory;      // Initial memory state
 194 
 195   Node*                 _recent_alloc_obj;
 196   Node*                 _recent_alloc_ctl;
 197 
 198   MachConstantBaseNode* _mach_constant_base_node;  // Constant table base node singleton.
 199 
 200 
 201   // Blocked array of debugging and profiling information,
 202   // tracked per node.
 203   enum { _log2_node_notes_block_size = 8,
 204          _node_notes_block_size = (1<<_log2_node_notes_block_size)
 205   };
 206   GrowableArray<Node_Notes*>* _node_note_array;
 207   Node_Notes*           _default_node_notes;  // default notes for new nodes
 208 
 209   // After parsing and every bulk phase we hang onto the Root instruction.
 210   // The RootNode instruction is where the whole program begins.  It produces
 211   // the initial Control and BOTTOM for everybody else.
 212 
 213   // Type management
 214   Arena                 _Compile_types;         // Arena for all types
 215   Arena*                _type_arena;            // Alias for _Compile_types except in Initialize_shared()
 216   Dict*                 _type_dict;             // Intern table
 217   void*                 _type_hwm;              // Last allocation (see Type::operator new/delete)
 218   size_t                _type_last_size;        // Last allocation size (see Type::operator new/delete)
 219   ciMethod*             _last_tf_m;             // Cache for
 220   const TypeFunc*       _last_tf;               //  TypeFunc::make
 221   AliasType**           _alias_types;           // List of alias types seen so far.
 222   int                   _num_alias_types;       // Logical length of _alias_types
 223   int                   _max_alias_types;       // Physical length of _alias_types
 224   AliasCacheEntry       _alias_cache[AliasCacheSize]; // Gets aliases w/o data structure walking
 225 
 226   // Parsing, optimization
 227   PhaseGVN*             _initial_gvn;           // Results of parse-time PhaseGVN
 228   Unique_Node_List*     _for_igvn;              // Initial work-list for next round of Iterative GVN
 229   WarmCallInfo*         _warm_calls;            // Sorted work-list for heat-based inlining.
 230 
 231   GrowableArray<CallGenerator*> _late_inlines;  // List of CallGenerators to be revisited after
 232                                                 // main parsing has finished.
 233 
 234   // Matching, CFG layout, allocation, code generation
 235   PhaseCFG*             _cfg;                   // Results of CFG finding
 236   bool                  _select_24_bit_instr;   // We selected an instruction with a 24-bit result
 237   bool                  _in_24_bit_fp_mode;     // We are emitting instructions with 24-bit results
 238   int                   _java_calls;            // Number of java calls in the method
 239   int                   _inner_loops;           // Number of inner loops in the method
 240   Matcher*              _matcher;               // Engine to map ideal to machine instructions
 241   PhaseRegAlloc*        _regalloc;              // Results of register allocation.
 242   int                   _frame_slots;           // Size of total frame in stack slots
 243   CodeOffsets           _code_offsets;          // Offsets into the code for various interesting entries
 244   RegMask               _FIRST_STACK_mask;      // All stack slots usable for spills (depends on frame layout)
 245   Arena*                _indexSet_arena;        // control IndexSet allocation within PhaseChaitin
 246   void*                 _indexSet_free_block_list; // free list of IndexSet bit blocks
 247 
 248   uint                  _node_bundling_limit;
 249   Bundle*               _node_bundling_base;    // Information for instruction bundling
 250 
 251   // Instruction bits passed off to the VM
 252   int                   _method_size;           // Size of nmethod code segment in bytes
 253   CodeBuffer            _code_buffer;           // Where the code is assembled
 254   int                   _first_block_size;      // Size of unvalidated entry point code / OSR poison code
 255   ExceptionHandlerTable _handler_table;         // Table of native-code exception handlers
 256   ImplicitExceptionTable _inc_table;            // Table of implicit null checks in native code
 257   OopMapSet*            _oop_map_set;           // Table of oop maps (one for each safepoint location)
 258   static int            _CompiledZap_count;     // counter compared against CompileZap[First/Last]
 259   BufferBlob*           _scratch_buffer_blob;   // For temporary code buffers.
 260   relocInfo*            _scratch_locs_memory;   // For temporary code buffers.
 261   int                   _scratch_const_size;    // For temporary code buffers.
 262   bool                  _in_scratch_emit_size;  // true when in scratch_emit_size.
 263 
 264  public:
 265   // Accessors
 266 
 267   // The Compile instance currently active in this (compiler) thread.
 268   static Compile* current() {
 269     return (Compile*) ciEnv::current()->compiler_data();
 270   }
 271 
 272   // ID for this compilation.  Useful for setting breakpoints in the debugger.
 273   int               compile_id() const          { return _compile_id; }
 274 
 275   // Does this compilation allow instructions to subsume loads?  User
 276   // instructions that subsume a load may result in an unschedulable
 277   // instruction sequence.
 278   bool              subsume_loads() const       { return _subsume_loads; }
 279   // Do escape analysis.
 280   bool              do_escape_analysis() const  { return _do_escape_analysis; }
 281   bool              save_argument_registers() const { return _save_argument_registers; }
 282 
 283 
 284   // Other fixed compilation parameters.
 285   ciMethod*         method() const              { return _method; }
 286   int               entry_bci() const           { return _entry_bci; }
 287   bool              is_osr_compilation() const  { return _entry_bci != InvocationEntryBci; }
 288   bool              is_method_compilation() const { return (_method != NULL && !_method->flags().is_native()); }
 289   const TypeFunc*   tf() const                  { assert(_tf!=NULL, ""); return _tf; }
 290   void         init_tf(const TypeFunc* tf)      { assert(_tf==NULL, ""); _tf = tf; }
 291   InlineTree*       ilt() const                 { return _ilt; }
 292   address           stub_function() const       { return _stub_function; }
 293   const char*       stub_name() const           { return _stub_name; }
 294   address           stub_entry_point() const    { return _stub_entry_point; }
 295 
 296   // Control of this compilation.
 297   int               fixed_slots() const         { assert(_fixed_slots >= 0, "");         return _fixed_slots; }
 298   void          set_fixed_slots(int n)          { _fixed_slots = n; }
 299   int               major_progress() const      { return _major_progress; }
 300   void          set_major_progress()            { _major_progress++; }
 301   void        clear_major_progress()            { _major_progress = 0; }
 302   int               num_loop_opts() const       { return _num_loop_opts; }
 303   void          set_num_loop_opts(int n)        { _num_loop_opts = n; }
 304   int               max_inline_size() const     { return _max_inline_size; }
 305   void          set_freq_inline_size(int n)     { _freq_inline_size = n; }
 306   int               freq_inline_size() const    { return _freq_inline_size; }
 307   void          set_max_inline_size(int n)      { _max_inline_size = n; }
 308   bool              has_loops() const           { return _has_loops; }
 309   void          set_has_loops(bool z)           { _has_loops = z; }
 310   bool              has_split_ifs() const       { return _has_split_ifs; }
 311   void          set_has_split_ifs(bool z)       { _has_split_ifs = z; }
 312   bool              has_unsafe_access() const   { return _has_unsafe_access; }
 313   void          set_has_unsafe_access(bool z)   { _has_unsafe_access = z; }
 314   bool              has_stringbuilder() const   { return _has_stringbuilder; }
 315   void          set_has_stringbuilder(bool z)   { _has_stringbuilder = z; }
 316   void          set_trap_count(uint r, uint c)  { assert(r < trapHistLength, "oob");        _trap_hist[r] = c; }
 317   uint              trap_count(uint r) const    { assert(r < trapHistLength, "oob"); return _trap_hist[r]; }
 318   bool              trap_can_recompile() const  { return _trap_can_recompile; }
 319   void          set_trap_can_recompile(bool z)  { _trap_can_recompile = z; }
 320   uint              decompile_count() const     { return _decompile_count; }
 321   void          set_decompile_count(uint c)     { _decompile_count = c; }
 322   bool              allow_range_check_smearing() const;
 323   bool              do_inlining() const         { return _do_inlining; }
 324   void          set_do_inlining(bool z)         { _do_inlining = z; }
 325   bool              do_scheduling() const       { return _do_scheduling; }
 326   void          set_do_scheduling(bool z)       { _do_scheduling = z; }
 327   bool              do_freq_based_layout() const{ return _do_freq_based_layout; }
 328   void          set_do_freq_based_layout(bool z){ _do_freq_based_layout = z; }
 329   bool              do_count_invocations() const{ return _do_count_invocations; }
 330   void          set_do_count_invocations(bool z){ _do_count_invocations = z; }
 331   bool              do_method_data_update() const { return _do_method_data_update; }
 332   void          set_do_method_data_update(bool z) { _do_method_data_update = z; }
 333   int               AliasLevel() const          { return _AliasLevel; }
 334   bool              print_assembly() const       { return _print_assembly; }
 335   void          set_print_assembly(bool z)       { _print_assembly = z; }
 336   // check the CompilerOracle for special behaviours for this compile
 337   bool          method_has_option(const char * option) {
 338     return method() != NULL && method()->has_option(option);
 339   }
 340 #ifndef PRODUCT
 341   bool          trace_opto_output() const       { return _trace_opto_output; }
 342   bool              parsed_irreducible_loop() const { return _parsed_irreducible_loop; }
 343   void          set_parsed_irreducible_loop(bool z) { _parsed_irreducible_loop = z; }
 344 #endif
 345 
 346   // JSR 292
 347   bool              has_method_handle_invokes() const { return _has_method_handle_invokes;     }
 348   void          set_has_method_handle_invokes(bool z) {        _has_method_handle_invokes = z; }
 349 
 350   void begin_method() {
 351 #ifndef PRODUCT
 352     if (_printer) _printer->begin_method(this);
 353 #endif
 354   }
 355   void print_method(const char * name, int level = 1) {
 356 #ifndef PRODUCT
 357     if (_printer) _printer->print_method(this, name, level);
 358 #endif
 359   }
 360   void end_method() {
 361 #ifndef PRODUCT
 362     if (_printer) _printer->end_method();
 363 #endif
 364   }
 365 
 366   int           macro_count()                   { return _macro_nodes->length(); }
 367   int           predicate_count()               { return _predicate_opaqs->length();}
 368   Node*         macro_node(int idx)             { return _macro_nodes->at(idx); }
 369   Node*         predicate_opaque1_node(int idx) { return _predicate_opaqs->at(idx);}
 370   ConnectionGraph* congraph()                   { return _congraph;}
 371   void set_congraph(ConnectionGraph* congraph)  { _congraph = congraph;}
 372   void add_macro_node(Node * n) {
 373     //assert(n->is_macro(), "must be a macro node");
 374     assert(!_macro_nodes->contains(n), " duplicate entry in expand list");
 375     _macro_nodes->append(n);
 376   }
 377   void remove_macro_node(Node * n) {
 378     // this function may be called twice for a node so check
 379     // that the node is in the array before attempting to remove it
 380     if (_macro_nodes->contains(n))
 381       _macro_nodes->remove(n);
 382     // remove from _predicate_opaqs list also if it is there
 383     if (predicate_count() > 0 && _predicate_opaqs->contains(n)){
 384       _predicate_opaqs->remove(n);
 385     }
 386   }
 387   void add_predicate_opaq(Node * n) {
 388     assert(!_predicate_opaqs->contains(n), " duplicate entry in predicate opaque1");
 389     assert(_macro_nodes->contains(n), "should have already been in macro list");
 390     _predicate_opaqs->append(n);
 391   }
 392   // remove the opaque nodes that protect the predicates so that the unused checks and
 393   // uncommon traps will be eliminated from the graph.
 394   void cleanup_loop_predicates(PhaseIterGVN &igvn);
 395 
 396   // Compilation environment.
 397   Arena*            comp_arena()                { return &_comp_arena; }
 398   ciEnv*            env() const                 { return _env; }
 399   CompileLog*       log() const                 { return _log; }
 400   bool              failing() const             { return _env->failing() || _failure_reason != NULL; }
 401   const char* failure_reason() { return _failure_reason; }
 402   bool              failure_reason_is(const char* r) { return (r==_failure_reason) || (r!=NULL && _failure_reason!=NULL && strcmp(r, _failure_reason)==0); }
 403 
 404   void record_failure(const char* reason);
 405   void record_method_not_compilable(const char* reason, bool all_tiers = false) {
 406     // All bailouts cover "all_tiers" when TieredCompilation is off.
 407     if (!TieredCompilation) all_tiers = true;
 408     env()->record_method_not_compilable(reason, all_tiers);
 409     // Record failure reason.
 410     record_failure(reason);
 411   }
 412   void record_method_not_compilable_all_tiers(const char* reason) {
 413     record_method_not_compilable(reason, true);
 414   }
 415   bool check_node_count(uint margin, const char* reason) {
 416     if (unique() + margin > (uint)MaxNodeLimit) {
 417       record_method_not_compilable(reason);
 418       return true;
 419     } else {
 420       return false;
 421     }
 422   }
 423 
 424   // Node management
 425   uint              unique() const              { return _unique; }
 426   uint         next_unique()                    { return _unique++; }
 427   void          set_unique(uint i)              { _unique = i; }
 428   static int        debug_idx()                 { return debug_only(_debug_idx)+0; }
 429   static void   set_debug_idx(int i)            { debug_only(_debug_idx = i); }
 430   Arena*            node_arena()                { return &_node_arena; }
 431   Arena*            old_arena()                 { return &_old_arena; }
 432   RootNode*         root() const                { return _root; }
 433   void          set_root(RootNode* r)           { _root = r; }
 434   StartNode*        start() const;              // (Derived from root.)
 435   void         init_start(StartNode* s);
 436   Node*             immutable_memory();
 437 
 438   Node*             recent_alloc_ctl() const    { return _recent_alloc_ctl; }
 439   Node*             recent_alloc_obj() const    { return _recent_alloc_obj; }
 440   void          set_recent_alloc(Node* ctl, Node* obj) {
 441                                                   _recent_alloc_ctl = ctl;
 442                                                   _recent_alloc_obj = obj;
 443                                                 }
 444 
 445   MachConstantBaseNode*     mach_constant_base_node();
 446   bool                  has_mach_constant_base_node() const { return _mach_constant_base_node != NULL; }
 447 
 448   // Handy undefined Node
 449   Node*             top() const                 { return _top; }
 450 
 451   // these are used by guys who need to know about creation and transformation of top:
 452   Node*             cached_top_node()           { return _top; }
 453   void          set_cached_top_node(Node* tn);
 454 
 455   GrowableArray<Node_Notes*>* node_note_array() const { return _node_note_array; }
 456   void set_node_note_array(GrowableArray<Node_Notes*>* arr) { _node_note_array = arr; }
 457   Node_Notes* default_node_notes() const        { return _default_node_notes; }
 458   void    set_default_node_notes(Node_Notes* n) { _default_node_notes = n; }
 459 
 460   Node_Notes*       node_notes_at(int idx) {
 461     return locate_node_notes(_node_note_array, idx, false);
 462   }
 463   inline bool   set_node_notes_at(int idx, Node_Notes* value);
 464 
 465   // Copy notes from source to dest, if they exist.
 466   // Overwrite dest only if source provides something.
 467   // Return true if information was moved.
 468   bool copy_node_notes_to(Node* dest, Node* source);
 469 
 470   // Workhorse function to sort out the blocked Node_Notes array:
 471   inline Node_Notes* locate_node_notes(GrowableArray<Node_Notes*>* arr,
 472                                        int idx, bool can_grow = false);
 473 
 474   void grow_node_notes(GrowableArray<Node_Notes*>* arr, int grow_by);
 475 
 476   // Type management
 477   Arena*            type_arena()                { return _type_arena; }
 478   Dict*             type_dict()                 { return _type_dict; }
 479   void*             type_hwm()                  { return _type_hwm; }
 480   size_t            type_last_size()            { return _type_last_size; }
 481   int               num_alias_types()           { return _num_alias_types; }
 482 
 483   void          init_type_arena()                       { _type_arena = &_Compile_types; }
 484   void          set_type_arena(Arena* a)                { _type_arena = a; }
 485   void          set_type_dict(Dict* d)                  { _type_dict = d; }
 486   void          set_type_hwm(void* p)                   { _type_hwm = p; }
 487   void          set_type_last_size(size_t sz)           { _type_last_size = sz; }
 488 
 489   const TypeFunc* last_tf(ciMethod* m) {
 490     return (m == _last_tf_m) ? _last_tf : NULL;
 491   }
 492   void set_last_tf(ciMethod* m, const TypeFunc* tf) {
 493     assert(m != NULL || tf == NULL, "");
 494     _last_tf_m = m;
 495     _last_tf = tf;
 496   }
 497 
 498   AliasType*        alias_type(int                idx)  { assert(idx < num_alias_types(), "oob"); return _alias_types[idx]; }
 499   AliasType*        alias_type(const TypePtr* adr_type) { return find_alias_type(adr_type, false); }
 500   bool         have_alias_type(const TypePtr* adr_type);
 501   AliasType*        alias_type(ciField*         field);
 502 
 503   int               get_alias_index(const TypePtr* at)  { return alias_type(at)->index(); }
 504   const TypePtr*    get_adr_type(uint aidx)             { return alias_type(aidx)->adr_type(); }
 505   int               get_general_index(uint aidx)        { return alias_type(aidx)->general_index(); }
 506 
 507   // Building nodes
 508   void              rethrow_exceptions(JVMState* jvms);
 509   void              return_values(JVMState* jvms);
 510   JVMState*         build_start_state(StartNode* start, const TypeFunc* tf);
 511 
 512   // Decide how to build a call.
 513   // The profile factor is a discount to apply to this site's interp. profile.
 514   CallGenerator*    call_generator(ciMethod* call_method, int vtable_index, bool call_is_virtual, JVMState* jvms, bool allow_inline, float profile_factor);
 515   bool should_delay_inlining(ciMethod* call_method, JVMState* jvms);
 516 
 517   // Report if there were too many traps at a current method and bci.
 518   // Report if a trap was recorded, and/or PerMethodTrapLimit was exceeded.
 519   // If there is no MDO at all, report no trap unless told to assume it.
 520   bool too_many_traps(ciMethod* method, int bci, Deoptimization::DeoptReason reason);
 521   // This version, unspecific to a particular bci, asks if
 522   // PerMethodTrapLimit was exceeded for all inlined methods seen so far.
 523   bool too_many_traps(Deoptimization::DeoptReason reason,
 524                       // Privately used parameter for logging:
 525                       ciMethodData* logmd = NULL);
 526   // Report if there were too many recompiles at a method and bci.
 527   bool too_many_recompiles(ciMethod* method, int bci, Deoptimization::DeoptReason reason);
 528 
 529   // Parsing, optimization
 530   PhaseGVN*         initial_gvn()               { return _initial_gvn; }
 531   Unique_Node_List* for_igvn()                  { return _for_igvn; }
 532   inline void       record_for_igvn(Node* n);   // Body is after class Unique_Node_List.
 533   void          set_initial_gvn(PhaseGVN *gvn)           { _initial_gvn = gvn; }
 534   void          set_for_igvn(Unique_Node_List *for_igvn) { _for_igvn = for_igvn; }
 535 
 536   // Replace n by nn using initial_gvn, calling hash_delete and
 537   // record_for_igvn as needed.
 538   void gvn_replace_by(Node* n, Node* nn);
 539 
 540 
 541   void              identify_useful_nodes(Unique_Node_List &useful);
 542   void              remove_useless_nodes  (Unique_Node_List &useful);
 543 
 544   WarmCallInfo*     warm_calls() const          { return _warm_calls; }
 545   void          set_warm_calls(WarmCallInfo* l) { _warm_calls = l; }
 546   WarmCallInfo* pop_warm_call();
 547 
 548   // Record this CallGenerator for inlining at the end of parsing.
 549   void              add_late_inline(CallGenerator* cg) { _late_inlines.push(cg); }
 550 
 551   // Matching, CFG layout, allocation, code generation
 552   PhaseCFG*         cfg()                       { return _cfg; }
 553   bool              select_24_bit_instr() const { return _select_24_bit_instr; }
 554   bool              in_24_bit_fp_mode() const   { return _in_24_bit_fp_mode; }
 555   bool              has_java_calls() const      { return _java_calls > 0; }
 556   int               java_calls() const          { return _java_calls; }
 557   int               inner_loops() const         { return _inner_loops; }
 558   Matcher*          matcher()                   { return _matcher; }
 559   PhaseRegAlloc*    regalloc()                  { return _regalloc; }
 560   int               frame_slots() const         { return _frame_slots; }
 561   int               frame_size_in_words() const; // frame_slots in units of the polymorphic 'words'
 562   RegMask&          FIRST_STACK_mask()          { return _FIRST_STACK_mask; }
 563   Arena*            indexSet_arena()            { return _indexSet_arena; }
 564   void*             indexSet_free_block_list()  { return _indexSet_free_block_list; }
 565   uint              node_bundling_limit()       { return _node_bundling_limit; }
 566   Bundle*           node_bundling_base()        { return _node_bundling_base; }
 567   void          set_node_bundling_limit(uint n) { _node_bundling_limit = n; }
 568   void          set_node_bundling_base(Bundle* b) { _node_bundling_base = b; }
 569   bool          starts_bundle(const Node *n) const;
 570   bool          need_stack_bang(int frame_size_in_bytes) const;
 571   bool          need_register_stack_bang() const;
 572 
 573   void          set_matcher(Matcher* m)                 { _matcher = m; }
 574 //void          set_regalloc(PhaseRegAlloc* ra)           { _regalloc = ra; }
 575   void          set_indexSet_arena(Arena* a)            { _indexSet_arena = a; }
 576   void          set_indexSet_free_block_list(void* p)   { _indexSet_free_block_list = p; }
 577 
 578   // Remember if this compilation changes hardware mode to 24-bit precision
 579   void set_24_bit_selection_and_mode(bool selection, bool mode) {
 580     _select_24_bit_instr = selection;
 581     _in_24_bit_fp_mode   = mode;
 582   }
 583 
 584   void  set_java_calls(int z) { _java_calls  = z; }
 585   void set_inner_loops(int z) { _inner_loops = z; }
 586 
 587   // Instruction bits passed off to the VM
 588   int               code_size()                 { return _method_size; }
 589   CodeBuffer*       code_buffer()               { return &_code_buffer; }
 590   int               first_block_size()          { return _first_block_size; }
 591   void              set_frame_complete(int off) { _code_offsets.set_value(CodeOffsets::Frame_Complete, off); }
 592   ExceptionHandlerTable*  handler_table()       { return &_handler_table; }
 593   ImplicitExceptionTable* inc_table()           { return &_inc_table; }
 594   OopMapSet*        oop_map_set()               { return _oop_map_set; }
 595   DebugInformationRecorder* debug_info()        { return env()->debug_info(); }
 596   Dependencies*     dependencies()              { return env()->dependencies(); }
 597   static int        CompiledZap_count()         { return _CompiledZap_count; }
 598   BufferBlob*       scratch_buffer_blob()       { return _scratch_buffer_blob; }
 599   void         init_scratch_buffer_blob(int const_size);
 600   void        clear_scratch_buffer_blob();
 601   void          set_scratch_buffer_blob(BufferBlob* b) { _scratch_buffer_blob = b; }
 602   relocInfo*        scratch_locs_memory()       { return _scratch_locs_memory; }
 603   void          set_scratch_locs_memory(relocInfo* b)  { _scratch_locs_memory = b; }
 604 
 605   // emit to scratch blob, report resulting size
 606   uint              scratch_emit_size(const Node* n);
 607   void       set_in_scratch_emit_size(bool x)   {        _in_scratch_emit_size = x; }
 608   bool           in_scratch_emit_size() const   { return _in_scratch_emit_size;     }
 609 
 610   enum ScratchBufferBlob {
 611     MAX_inst_size       = 1024,
 612     MAX_locs_size       = 128, // number of relocInfo elements
 613     MAX_const_size      = 128,
 614     MAX_stubs_size      = 128
 615   };
 616 
 617   // Major entry point.  Given a Scope, compile the associated method.
 618   // For normal compilations, entry_bci is InvocationEntryBci.  For on stack
 619   // replacement, entry_bci indicates the bytecode for which to compile a
 620   // continuation.
 621   Compile(ciEnv* ci_env, C2Compiler* compiler, ciMethod* target,
 622           int entry_bci, bool subsume_loads, bool do_escape_analysis);
 623 
 624   // Second major entry point.  From the TypeFunc signature, generate code
 625   // to pass arguments from the Java calling convention to the C calling
 626   // convention.
 627   Compile(ciEnv* ci_env, const TypeFunc *(*gen)(),
 628           address stub_function, const char *stub_name,
 629           int is_fancy_jump, bool pass_tls,
 630           bool save_arg_registers, bool return_pc);
 631 
 632   // From the TypeFunc signature, generate code to pass arguments
 633   // from Compiled calling convention to Interpreter's calling convention
 634   void Generate_Compiled_To_Interpreter_Graph(const TypeFunc *tf, address interpreter_entry);
 635 
 636   // From the TypeFunc signature, generate code to pass arguments
 637   // from Interpreter's calling convention to Compiler's calling convention
 638   void Generate_Interpreter_To_Compiled_Graph(const TypeFunc *tf);
 639 
 640   // Are we compiling a method?
 641   bool has_method() { return method() != NULL; }
 642 
 643   // Maybe print some information about this compile.
 644   void print_compile_messages();
 645 
 646   // Final graph reshaping, a post-pass after the regular optimizer is done.
 647   bool final_graph_reshaping();
 648 
 649   // returns true if adr is completely contained in the given alias category
 650   bool must_alias(const TypePtr* adr, int alias_idx);
 651 
 652   // returns true if adr overlaps with the given alias category
 653   bool can_alias(const TypePtr* adr, int alias_idx);
 654 
 655   // Driver for converting compiler's IR into machine code bits
 656   void Output();
 657 
 658   // Accessors for node bundling info.
 659   Bundle* node_bundling(const Node *n);
 660   bool valid_bundle_info(const Node *n);
 661 
 662   // Schedule and Bundle the instructions
 663   void ScheduleAndBundle();
 664 
 665   // Build OopMaps for each GC point
 666   void BuildOopMaps();
 667 
 668   // Append debug info for the node "local" at safepoint node "sfpt" to the
 669   // "array",   May also consult and add to "objs", which describes the
 670   // scalar-replaced objects.
 671   void FillLocArray( int idx, MachSafePointNode* sfpt,
 672                      Node *local, GrowableArray<ScopeValue*> *array,
 673                      GrowableArray<ScopeValue*> *objs );
 674 
 675   // If "objs" contains an ObjectValue whose id is "id", returns it, else NULL.
 676   static ObjectValue* sv_for_node_id(GrowableArray<ScopeValue*> *objs, int id);
 677   // Requres that "objs" does not contains an ObjectValue whose id matches
 678   // that of "sv.  Appends "sv".
 679   static void set_sv_for_object_node(GrowableArray<ScopeValue*> *objs,
 680                                      ObjectValue* sv );
 681 
 682   // Process an OopMap Element while emitting nodes
 683   void Process_OopMap_Node(MachNode *mach, int code_offset);
 684 
 685   // Write out basic block data to code buffer
 686   void Fill_buffer();
 687 
 688   // Determine which variable sized branches can be shortened
 689   void Shorten_branches(Label *labels, int& code_size, int& reloc_size, int& stub_size);
 690 
 691   // Compute the size of first NumberOfLoopInstrToAlign instructions
 692   // at the head of a loop.
 693   void compute_loop_first_inst_sizes();
 694 
 695   // Compute the information for the exception tables
 696   void FillExceptionTables(uint cnt, uint *call_returns, uint *inct_starts, Label *blk_labels);
 697 
 698   // Stack slots that may be unused by the calling convention but must
 699   // otherwise be preserved.  On Intel this includes the return address.
 700   // On PowerPC it includes the 4 words holding the old TOC & LR glue.
 701   uint in_preserve_stack_slots();
 702 
 703   // "Top of Stack" slots that may be unused by the calling convention but must
 704   // otherwise be preserved.
 705   // On Intel these are not necessary and the value can be zero.
 706   // On Sparc this describes the words reserved for storing a register window
 707   // when an interrupt occurs.
 708   static uint out_preserve_stack_slots();
 709 
 710   // Number of outgoing stack slots killed above the out_preserve_stack_slots
 711   // for calls to C.  Supports the var-args backing area for register parms.
 712   uint varargs_C_out_slots_killed() const;
 713 
 714   // Number of Stack Slots consumed by a synchronization entry
 715   int sync_stack_slots() const;
 716 
 717   // Compute the name of old_SP.  See <arch>.ad for frame layout.
 718   OptoReg::Name compute_old_SP();
 719 
 720 #ifdef ENABLE_ZAP_DEAD_LOCALS
 721   static bool is_node_getting_a_safepoint(Node*);
 722   void Insert_zap_nodes();
 723   Node* call_zap_node(MachSafePointNode* n, int block_no);
 724 #endif
 725 
 726  private:
 727   // Phase control:
 728   void Init(int aliaslevel);                     // Prepare for a single compilation
 729   int  Inline_Warm();                            // Find more inlining work.
 730   void Finish_Warm();                            // Give up on further inlines.
 731   void Optimize();                               // Given a graph, optimize it
 732   void Code_Gen();                               // Generate code from a graph
 733 
 734   // Management of the AliasType table.
 735   void grow_alias_types();
 736   AliasCacheEntry* probe_alias_cache(const TypePtr* adr_type);
 737   const TypePtr *flatten_alias_type(const TypePtr* adr_type) const;
 738   AliasType* find_alias_type(const TypePtr* adr_type, bool no_create);
 739 
 740   void verify_top(Node*) const PRODUCT_RETURN;
 741 
 742   // Intrinsic setup.
 743   void           register_library_intrinsics();                            // initializer
 744   CallGenerator* make_vm_intrinsic(ciMethod* m, bool is_virtual);          // constructor
 745   int            intrinsic_insertion_index(ciMethod* m, bool is_virtual);  // helper
 746   CallGenerator* find_intrinsic(ciMethod* m, bool is_virtual);             // query fn
 747   void           register_intrinsic(CallGenerator* cg);                    // update fn
 748 
 749 #ifndef PRODUCT
 750   static juint  _intrinsic_hist_count[vmIntrinsics::ID_LIMIT];
 751   static jubyte _intrinsic_hist_flags[vmIntrinsics::ID_LIMIT];
 752 #endif
 753 
 754  public:
 755 
 756   // Note:  Histogram array size is about 1 Kb.
 757   enum {                        // flag bits:
 758     _intrinsic_worked = 1,      // succeeded at least once
 759     _intrinsic_failed = 2,      // tried it but it failed
 760     _intrinsic_disabled = 4,    // was requested but disabled (e.g., -XX:-InlineUnsafeOps)
 761     _intrinsic_virtual = 8,     // was seen in the virtual form (rare)
 762     _intrinsic_both = 16        // was seen in the non-virtual form (usual)
 763   };
 764   // Update histogram.  Return boolean if this is a first-time occurrence.
 765   static bool gather_intrinsic_statistics(vmIntrinsics::ID id,
 766                                           bool is_virtual, int flags) PRODUCT_RETURN0;
 767   static void print_intrinsic_statistics() PRODUCT_RETURN;
 768 
 769   // Graph verification code
 770   // Walk the node list, verifying that there is a one-to-one
 771   // correspondence between Use-Def edges and Def-Use edges
 772   // The option no_dead_code enables stronger checks that the
 773   // graph is strongly connected from root in both directions.
 774   void verify_graph_edges(bool no_dead_code = false) PRODUCT_RETURN;
 775 
 776   // Print bytecodes, including the scope inlining tree
 777   void print_codes();
 778 
 779   // End-of-run dumps.
 780   static void print_statistics() PRODUCT_RETURN;
 781 
 782   // Dump formatted assembly
 783   void dump_asm(int *pcs = NULL, uint pc_limit = 0) PRODUCT_RETURN;
 784   void dump_pc(int *pcs, int pc_limit, Node *n);
 785 
 786   // Verify ADLC assumptions during startup
 787   static void adlc_verification() PRODUCT_RETURN;
 788 
 789   // Definitions of pd methods
 790   static void pd_compiler2_init();
 791 };