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