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