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