Tue, 18 Dec 2012 14:55:25 +0100
8005031: Some cleanup in c2 to prepare for incremental inlining support
Summary: collection of small changes to prepare for incremental inlining.
Reviewed-by: twisti, kvn
1 /*
2 * Copyright (c) 1997, 2012, 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 */
25 #ifndef SHARE_VM_OPTO_COMPILE_HPP
26 #define SHARE_VM_OPTO_COMPILE_HPP
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/port.hpp"
36 #include "libadt/vectset.hpp"
37 #include "memory/resourceArea.hpp"
38 #include "opto/idealGraphPrinter.hpp"
39 #include "opto/phase.hpp"
40 #include "opto/regmask.hpp"
41 #include "runtime/deoptimization.hpp"
42 #include "runtime/vmThread.hpp"
44 class Block;
45 class Bundle;
46 class C2Compiler;
47 class CallGenerator;
48 class ConnectionGraph;
49 class InlineTree;
50 class Int_Array;
51 class Matcher;
52 class MachConstantNode;
53 class MachConstantBaseNode;
54 class MachNode;
55 class MachOper;
56 class MachSafePointNode;
57 class Node;
58 class Node_Array;
59 class Node_Notes;
60 class OptoReg;
61 class PhaseCFG;
62 class PhaseGVN;
63 class PhaseIterGVN;
64 class PhaseRegAlloc;
65 class PhaseCCP;
66 class PhaseCCP_DCE;
67 class RootNode;
68 class relocInfo;
69 class Scope;
70 class StartNode;
71 class SafePointNode;
72 class JVMState;
73 class TypeData;
74 class TypePtr;
75 class TypeFunc;
76 class Unique_Node_List;
77 class nmethod;
78 class WarmCallInfo;
79 class Node_Stack;
80 struct Final_Reshape_Counts;
82 //------------------------------Compile----------------------------------------
83 // This class defines a top-level Compiler invocation.
85 class Compile : public Phase {
86 friend class VMStructs;
88 public:
89 // Fixed alias indexes. (See also MergeMemNode.)
90 enum {
91 AliasIdxTop = 1, // pseudo-index, aliases to nothing (used as sentinel value)
92 AliasIdxBot = 2, // pseudo-index, aliases to everything
93 AliasIdxRaw = 3 // hard-wired index for TypeRawPtr::BOTTOM
94 };
96 // Variant of TraceTime(NULL, &_t_accumulator, TimeCompiler);
97 // Integrated with logging. If logging is turned on, and dolog is true,
98 // then brackets are put into the log, with time stamps and node counts.
99 // (The time collection itself is always conditionalized on TimeCompiler.)
100 class TracePhase : public TraceTime {
101 private:
102 Compile* C;
103 CompileLog* _log;
104 const char* _phase_name;
105 bool _dolog;
106 public:
107 TracePhase(const char* name, elapsedTimer* accumulator, bool dolog);
108 ~TracePhase();
109 };
111 // Information per category of alias (memory slice)
112 class AliasType {
113 private:
114 friend class Compile;
116 int _index; // unique index, used with MergeMemNode
117 const TypePtr* _adr_type; // normalized address type
118 ciField* _field; // relevant instance field, or null if none
119 bool _is_rewritable; // false if the memory is write-once only
120 int _general_index; // if this is type is an instance, the general
121 // type that this is an instance of
123 void Init(int i, const TypePtr* at);
125 public:
126 int index() const { return _index; }
127 const TypePtr* adr_type() const { return _adr_type; }
128 ciField* field() const { return _field; }
129 bool is_rewritable() const { return _is_rewritable; }
130 bool is_volatile() const { return (_field ? _field->is_volatile() : false); }
131 int general_index() const { return (_general_index != 0) ? _general_index : _index; }
133 void set_rewritable(bool z) { _is_rewritable = z; }
134 void set_field(ciField* f) {
135 assert(!_field,"");
136 _field = f;
137 if (f->is_final()) _is_rewritable = false;
138 }
140 void print_on(outputStream* st) PRODUCT_RETURN;
141 };
143 enum {
144 logAliasCacheSize = 6,
145 AliasCacheSize = (1<<logAliasCacheSize)
146 };
147 struct AliasCacheEntry { const TypePtr* _adr_type; int _index; }; // simple duple type
148 enum {
149 trapHistLength = MethodData::_trap_hist_limit
150 };
152 // Constant entry of the constant table.
153 class Constant {
154 private:
155 BasicType _type;
156 union {
157 jvalue _value;
158 Metadata* _metadata;
159 } _v;
160 int _offset; // offset of this constant (in bytes) relative to the constant table base.
161 float _freq;
162 bool _can_be_reused; // true (default) if the value can be shared with other users.
164 public:
165 Constant() : _type(T_ILLEGAL), _offset(-1), _freq(0.0f), _can_be_reused(true) { _v._value.l = 0; }
166 Constant(BasicType type, jvalue value, float freq = 0.0f, bool can_be_reused = true) :
167 _type(type),
168 _offset(-1),
169 _freq(freq),
170 _can_be_reused(can_be_reused)
171 {
172 assert(type != T_METADATA, "wrong constructor");
173 _v._value = value;
174 }
175 Constant(Metadata* metadata, bool can_be_reused = true) :
176 _type(T_METADATA),
177 _offset(-1),
178 _freq(0.0f),
179 _can_be_reused(can_be_reused)
180 {
181 _v._metadata = metadata;
182 }
184 bool operator==(const Constant& other);
186 BasicType type() const { return _type; }
188 jlong get_jlong() const { return _v._value.j; }
189 jfloat get_jfloat() const { return _v._value.f; }
190 jdouble get_jdouble() const { return _v._value.d; }
191 jobject get_jobject() const { return _v._value.l; }
193 Metadata* get_metadata() const { return _v._metadata; }
195 int offset() const { return _offset; }
196 void set_offset(int offset) { _offset = offset; }
198 float freq() const { return _freq; }
199 void inc_freq(float freq) { _freq += freq; }
201 bool can_be_reused() const { return _can_be_reused; }
202 };
204 // Constant table.
205 class ConstantTable {
206 private:
207 GrowableArray<Constant> _constants; // Constants of this table.
208 int _size; // Size in bytes the emitted constant table takes (including padding).
209 int _table_base_offset; // Offset of the table base that gets added to the constant offsets.
210 int _nof_jump_tables; // Number of jump-tables in this constant table.
212 static int qsort_comparator(Constant* a, Constant* b);
214 // We use negative frequencies to keep the order of the
215 // jump-tables in which they were added. Otherwise we get into
216 // trouble with relocation.
217 float next_jump_table_freq() { return -1.0f * (++_nof_jump_tables); }
219 public:
220 ConstantTable() :
221 _size(-1),
222 _table_base_offset(-1), // We can use -1 here since the constant table is always bigger than 2 bytes (-(size / 2), see MachConstantBaseNode::emit).
223 _nof_jump_tables(0)
224 {}
226 int size() const { assert(_size != -1, "not calculated yet"); return _size; }
228 int calculate_table_base_offset() const; // AD specific
229 void set_table_base_offset(int x) { assert(_table_base_offset == -1 || x == _table_base_offset, "can't change"); _table_base_offset = x; }
230 int table_base_offset() const { assert(_table_base_offset != -1, "not set yet"); return _table_base_offset; }
232 void emit(CodeBuffer& cb);
234 // Returns the offset of the last entry (the top) of the constant table.
235 int top_offset() const { assert(_constants.top().offset() != -1, "not bound yet"); return _constants.top().offset(); }
237 void calculate_offsets_and_size();
238 int find_offset(Constant& con) const;
240 void add(Constant& con);
241 Constant add(MachConstantNode* n, BasicType type, jvalue value);
242 Constant add(Metadata* metadata);
243 Constant add(MachConstantNode* n, MachOper* oper);
244 Constant add(MachConstantNode* n, jfloat f) {
245 jvalue value; value.f = f;
246 return add(n, T_FLOAT, value);
247 }
248 Constant add(MachConstantNode* n, jdouble d) {
249 jvalue value; value.d = d;
250 return add(n, T_DOUBLE, value);
251 }
253 // Jump-table
254 Constant add_jump_table(MachConstantNode* n);
255 void fill_jump_table(CodeBuffer& cb, MachConstantNode* n, GrowableArray<Label*> labels) const;
256 };
258 private:
259 // Fixed parameters to this compilation.
260 const int _compile_id;
261 const bool _save_argument_registers; // save/restore arg regs for trampolines
262 const bool _subsume_loads; // Load can be matched as part of a larger op.
263 const bool _do_escape_analysis; // Do escape analysis.
264 ciMethod* _method; // The method being compiled.
265 int _entry_bci; // entry bci for osr methods.
266 const TypeFunc* _tf; // My kind of signature
267 InlineTree* _ilt; // Ditto (temporary).
268 address _stub_function; // VM entry for stub being compiled, or NULL
269 const char* _stub_name; // Name of stub or adapter being compiled, or NULL
270 address _stub_entry_point; // Compile code entry for generated stub, or NULL
272 // Control of this compilation.
273 int _num_loop_opts; // Number of iterations for doing loop optimiztions
274 int _max_inline_size; // Max inline size for this compilation
275 int _freq_inline_size; // Max hot method inline size for this compilation
276 int _fixed_slots; // count of frame slots not allocated by the register
277 // allocator i.e. locks, original deopt pc, etc.
278 // For deopt
279 int _orig_pc_slot;
280 int _orig_pc_slot_offset_in_bytes;
282 int _major_progress; // Count of something big happening
283 bool _has_loops; // True if the method _may_ have some loops
284 bool _has_split_ifs; // True if the method _may_ have some split-if
285 bool _has_unsafe_access; // True if the method _may_ produce faults in unsafe loads or stores.
286 bool _has_stringbuilder; // True StringBuffers or StringBuilders are allocated
287 int _max_vector_size; // Maximum size of generated vectors
288 uint _trap_hist[trapHistLength]; // Cumulative traps
289 bool _trap_can_recompile; // Have we emitted a recompiling trap?
290 uint _decompile_count; // Cumulative decompilation counts.
291 bool _do_inlining; // True if we intend to do inlining
292 bool _do_scheduling; // True if we intend to do scheduling
293 bool _do_freq_based_layout; // True if we intend to do frequency based block layout
294 bool _do_count_invocations; // True if we generate code to count invocations
295 bool _do_method_data_update; // True if we generate code to update MethodData*s
296 int _AliasLevel; // Locally-adjusted version of AliasLevel flag.
297 bool _print_assembly; // True if we should dump assembly code for this compilation
298 #ifndef PRODUCT
299 bool _trace_opto_output;
300 bool _parsed_irreducible_loop; // True if ciTypeFlow detected irreducible loops during parsing
301 #endif
303 // JSR 292
304 bool _has_method_handle_invokes; // True if this method has MethodHandle invokes.
306 // Compilation environment.
307 Arena _comp_arena; // Arena with lifetime equivalent to Compile
308 ciEnv* _env; // CI interface
309 CompileLog* _log; // from CompilerThread
310 const char* _failure_reason; // for record_failure/failing pattern
311 GrowableArray<CallGenerator*>* _intrinsics; // List of intrinsics.
312 GrowableArray<Node*>* _macro_nodes; // List of nodes which need to be expanded before matching.
313 GrowableArray<Node*>* _predicate_opaqs; // List of Opaque1 nodes for the loop predicates.
314 ConnectionGraph* _congraph;
315 #ifndef PRODUCT
316 IdealGraphPrinter* _printer;
317 #endif
319 // Node management
320 uint _unique; // Counter for unique Node indices
321 VectorSet _dead_node_list; // Set of dead nodes
322 uint _dead_node_count; // Number of dead nodes; VectorSet::Size() is O(N).
323 // So use this to keep count and make the call O(1).
324 debug_only(static int _debug_idx;) // Monotonic counter (not reset), use -XX:BreakAtNode=<idx>
325 Arena _node_arena; // Arena for new-space Nodes
326 Arena _old_arena; // Arena for old-space Nodes, lifetime during xform
327 RootNode* _root; // Unique root of compilation, or NULL after bail-out.
328 Node* _top; // Unique top node. (Reset by various phases.)
330 Node* _immutable_memory; // Initial memory state
332 Node* _recent_alloc_obj;
333 Node* _recent_alloc_ctl;
335 // Constant table
336 ConstantTable _constant_table; // The constant table for this compile.
337 MachConstantBaseNode* _mach_constant_base_node; // Constant table base node singleton.
340 // Blocked array of debugging and profiling information,
341 // tracked per node.
342 enum { _log2_node_notes_block_size = 8,
343 _node_notes_block_size = (1<<_log2_node_notes_block_size)
344 };
345 GrowableArray<Node_Notes*>* _node_note_array;
346 Node_Notes* _default_node_notes; // default notes for new nodes
348 // After parsing and every bulk phase we hang onto the Root instruction.
349 // The RootNode instruction is where the whole program begins. It produces
350 // the initial Control and BOTTOM for everybody else.
352 // Type management
353 Arena _Compile_types; // Arena for all types
354 Arena* _type_arena; // Alias for _Compile_types except in Initialize_shared()
355 Dict* _type_dict; // Intern table
356 void* _type_hwm; // Last allocation (see Type::operator new/delete)
357 size_t _type_last_size; // Last allocation size (see Type::operator new/delete)
358 ciMethod* _last_tf_m; // Cache for
359 const TypeFunc* _last_tf; // TypeFunc::make
360 AliasType** _alias_types; // List of alias types seen so far.
361 int _num_alias_types; // Logical length of _alias_types
362 int _max_alias_types; // Physical length of _alias_types
363 AliasCacheEntry _alias_cache[AliasCacheSize]; // Gets aliases w/o data structure walking
365 // Parsing, optimization
366 PhaseGVN* _initial_gvn; // Results of parse-time PhaseGVN
367 Unique_Node_List* _for_igvn; // Initial work-list for next round of Iterative GVN
368 WarmCallInfo* _warm_calls; // Sorted work-list for heat-based inlining.
370 GrowableArray<CallGenerator*> _late_inlines; // List of CallGenerators to be revisited after
371 // main parsing has finished.
373 // Inlining may not happen in parse order which would make
374 // PrintInlining output confusing. Keep track of PrintInlining
375 // pieces in order.
376 class PrintInliningBuffer : public ResourceObj {
377 private:
378 CallGenerator* _cg;
379 stringStream* _ss;
381 public:
382 PrintInliningBuffer()
383 : _cg(NULL) { _ss = new stringStream(); }
385 stringStream* ss() const { return _ss; }
386 CallGenerator* cg() const { return _cg; }
387 void set_cg(CallGenerator* cg) { _cg = cg; }
388 };
390 GrowableArray<PrintInliningBuffer>* _print_inlining_list;
391 int _print_inlining;
393 public:
395 outputStream* print_inlining_stream() const {
396 return _print_inlining_list->at(_print_inlining).ss();
397 }
399 void print_inlining_skip(CallGenerator* cg) {
400 if (PrintInlining) {
401 _print_inlining_list->at(_print_inlining).set_cg(cg);
402 _print_inlining++;
403 _print_inlining_list->insert_before(_print_inlining, PrintInliningBuffer());
404 }
405 }
407 void print_inlining_insert(CallGenerator* cg) {
408 if (PrintInlining) {
409 for (int i = 0; i < _print_inlining_list->length(); i++) {
410 if (_print_inlining_list->at(i).cg() == cg) {
411 _print_inlining_list->insert_before(i+1, PrintInliningBuffer());
412 _print_inlining = i+1;
413 _print_inlining_list->at(i).set_cg(NULL);
414 return;
415 }
416 }
417 ShouldNotReachHere();
418 }
419 }
421 void print_inlining(ciMethod* method, int inline_level, int bci, const char* msg = NULL) {
422 stringStream ss;
423 CompileTask::print_inlining(&ss, method, inline_level, bci, msg);
424 print_inlining_stream()->print(ss.as_string());
425 }
427 private:
428 // Matching, CFG layout, allocation, code generation
429 PhaseCFG* _cfg; // Results of CFG finding
430 bool _select_24_bit_instr; // We selected an instruction with a 24-bit result
431 bool _in_24_bit_fp_mode; // We are emitting instructions with 24-bit results
432 int _java_calls; // Number of java calls in the method
433 int _inner_loops; // Number of inner loops in the method
434 Matcher* _matcher; // Engine to map ideal to machine instructions
435 PhaseRegAlloc* _regalloc; // Results of register allocation.
436 int _frame_slots; // Size of total frame in stack slots
437 CodeOffsets _code_offsets; // Offsets into the code for various interesting entries
438 RegMask _FIRST_STACK_mask; // All stack slots usable for spills (depends on frame layout)
439 Arena* _indexSet_arena; // control IndexSet allocation within PhaseChaitin
440 void* _indexSet_free_block_list; // free list of IndexSet bit blocks
442 uint _node_bundling_limit;
443 Bundle* _node_bundling_base; // Information for instruction bundling
445 // Instruction bits passed off to the VM
446 int _method_size; // Size of nmethod code segment in bytes
447 CodeBuffer _code_buffer; // Where the code is assembled
448 int _first_block_size; // Size of unvalidated entry point code / OSR poison code
449 ExceptionHandlerTable _handler_table; // Table of native-code exception handlers
450 ImplicitExceptionTable _inc_table; // Table of implicit null checks in native code
451 OopMapSet* _oop_map_set; // Table of oop maps (one for each safepoint location)
452 static int _CompiledZap_count; // counter compared against CompileZap[First/Last]
453 BufferBlob* _scratch_buffer_blob; // For temporary code buffers.
454 relocInfo* _scratch_locs_memory; // For temporary code buffers.
455 int _scratch_const_size; // For temporary code buffers.
456 bool _in_scratch_emit_size; // true when in scratch_emit_size.
458 public:
459 // Accessors
461 // The Compile instance currently active in this (compiler) thread.
462 static Compile* current() {
463 return (Compile*) ciEnv::current()->compiler_data();
464 }
466 // ID for this compilation. Useful for setting breakpoints in the debugger.
467 int compile_id() const { return _compile_id; }
469 // Does this compilation allow instructions to subsume loads? User
470 // instructions that subsume a load may result in an unschedulable
471 // instruction sequence.
472 bool subsume_loads() const { return _subsume_loads; }
473 // Do escape analysis.
474 bool do_escape_analysis() const { return _do_escape_analysis; }
475 bool save_argument_registers() const { return _save_argument_registers; }
478 // Other fixed compilation parameters.
479 ciMethod* method() const { return _method; }
480 int entry_bci() const { return _entry_bci; }
481 bool is_osr_compilation() const { return _entry_bci != InvocationEntryBci; }
482 bool is_method_compilation() const { return (_method != NULL && !_method->flags().is_native()); }
483 const TypeFunc* tf() const { assert(_tf!=NULL, ""); return _tf; }
484 void init_tf(const TypeFunc* tf) { assert(_tf==NULL, ""); _tf = tf; }
485 InlineTree* ilt() const { return _ilt; }
486 address stub_function() const { return _stub_function; }
487 const char* stub_name() const { return _stub_name; }
488 address stub_entry_point() const { return _stub_entry_point; }
490 // Control of this compilation.
491 int fixed_slots() const { assert(_fixed_slots >= 0, ""); return _fixed_slots; }
492 void set_fixed_slots(int n) { _fixed_slots = n; }
493 int major_progress() const { return _major_progress; }
494 void set_major_progress() { _major_progress++; }
495 void clear_major_progress() { _major_progress = 0; }
496 int num_loop_opts() const { return _num_loop_opts; }
497 void set_num_loop_opts(int n) { _num_loop_opts = n; }
498 int max_inline_size() const { return _max_inline_size; }
499 void set_freq_inline_size(int n) { _freq_inline_size = n; }
500 int freq_inline_size() const { return _freq_inline_size; }
501 void set_max_inline_size(int n) { _max_inline_size = n; }
502 bool has_loops() const { return _has_loops; }
503 void set_has_loops(bool z) { _has_loops = z; }
504 bool has_split_ifs() const { return _has_split_ifs; }
505 void set_has_split_ifs(bool z) { _has_split_ifs = z; }
506 bool has_unsafe_access() const { return _has_unsafe_access; }
507 void set_has_unsafe_access(bool z) { _has_unsafe_access = z; }
508 bool has_stringbuilder() const { return _has_stringbuilder; }
509 void set_has_stringbuilder(bool z) { _has_stringbuilder = z; }
510 int max_vector_size() const { return _max_vector_size; }
511 void set_max_vector_size(int s) { _max_vector_size = s; }
512 void set_trap_count(uint r, uint c) { assert(r < trapHistLength, "oob"); _trap_hist[r] = c; }
513 uint trap_count(uint r) const { assert(r < trapHistLength, "oob"); return _trap_hist[r]; }
514 bool trap_can_recompile() const { return _trap_can_recompile; }
515 void set_trap_can_recompile(bool z) { _trap_can_recompile = z; }
516 uint decompile_count() const { return _decompile_count; }
517 void set_decompile_count(uint c) { _decompile_count = c; }
518 bool allow_range_check_smearing() const;
519 bool do_inlining() const { return _do_inlining; }
520 void set_do_inlining(bool z) { _do_inlining = z; }
521 bool do_scheduling() const { return _do_scheduling; }
522 void set_do_scheduling(bool z) { _do_scheduling = z; }
523 bool do_freq_based_layout() const{ return _do_freq_based_layout; }
524 void set_do_freq_based_layout(bool z){ _do_freq_based_layout = z; }
525 bool do_count_invocations() const{ return _do_count_invocations; }
526 void set_do_count_invocations(bool z){ _do_count_invocations = z; }
527 bool do_method_data_update() const { return _do_method_data_update; }
528 void set_do_method_data_update(bool z) { _do_method_data_update = z; }
529 int AliasLevel() const { return _AliasLevel; }
530 bool print_assembly() const { return _print_assembly; }
531 void set_print_assembly(bool z) { _print_assembly = z; }
532 // check the CompilerOracle for special behaviours for this compile
533 bool method_has_option(const char * option) {
534 return method() != NULL && method()->has_option(option);
535 }
536 #ifndef PRODUCT
537 bool trace_opto_output() const { return _trace_opto_output; }
538 bool parsed_irreducible_loop() const { return _parsed_irreducible_loop; }
539 void set_parsed_irreducible_loop(bool z) { _parsed_irreducible_loop = z; }
540 #endif
542 // JSR 292
543 bool has_method_handle_invokes() const { return _has_method_handle_invokes; }
544 void set_has_method_handle_invokes(bool z) { _has_method_handle_invokes = z; }
546 void begin_method() {
547 #ifndef PRODUCT
548 if (_printer) _printer->begin_method(this);
549 #endif
550 }
551 void print_method(const char * name, int level = 1) {
552 #ifndef PRODUCT
553 if (_printer) _printer->print_method(this, name, level);
554 #endif
555 }
556 void end_method() {
557 #ifndef PRODUCT
558 if (_printer) _printer->end_method();
559 #endif
560 }
562 int macro_count() { return _macro_nodes->length(); }
563 int predicate_count() { return _predicate_opaqs->length();}
564 Node* macro_node(int idx) { return _macro_nodes->at(idx); }
565 Node* predicate_opaque1_node(int idx) { return _predicate_opaqs->at(idx);}
566 ConnectionGraph* congraph() { return _congraph;}
567 void set_congraph(ConnectionGraph* congraph) { _congraph = congraph;}
568 void add_macro_node(Node * n) {
569 //assert(n->is_macro(), "must be a macro node");
570 assert(!_macro_nodes->contains(n), " duplicate entry in expand list");
571 _macro_nodes->append(n);
572 }
573 void remove_macro_node(Node * n) {
574 // this function may be called twice for a node so check
575 // that the node is in the array before attempting to remove it
576 if (_macro_nodes->contains(n))
577 _macro_nodes->remove(n);
578 // remove from _predicate_opaqs list also if it is there
579 if (predicate_count() > 0 && _predicate_opaqs->contains(n)){
580 _predicate_opaqs->remove(n);
581 }
582 }
583 void add_predicate_opaq(Node * n) {
584 assert(!_predicate_opaqs->contains(n), " duplicate entry in predicate opaque1");
585 assert(_macro_nodes->contains(n), "should have already been in macro list");
586 _predicate_opaqs->append(n);
587 }
588 // remove the opaque nodes that protect the predicates so that the unused checks and
589 // uncommon traps will be eliminated from the graph.
590 void cleanup_loop_predicates(PhaseIterGVN &igvn);
591 bool is_predicate_opaq(Node * n) {
592 return _predicate_opaqs->contains(n);
593 }
595 // Compilation environment.
596 Arena* comp_arena() { return &_comp_arena; }
597 ciEnv* env() const { return _env; }
598 CompileLog* log() const { return _log; }
599 bool failing() const { return _env->failing() || _failure_reason != NULL; }
600 const char* failure_reason() { return _failure_reason; }
601 bool failure_reason_is(const char* r) { return (r==_failure_reason) || (r!=NULL && _failure_reason!=NULL && strcmp(r, _failure_reason)==0); }
603 void record_failure(const char* reason);
604 void record_method_not_compilable(const char* reason, bool all_tiers = false) {
605 // All bailouts cover "all_tiers" when TieredCompilation is off.
606 if (!TieredCompilation) all_tiers = true;
607 env()->record_method_not_compilable(reason, all_tiers);
608 // Record failure reason.
609 record_failure(reason);
610 }
611 void record_method_not_compilable_all_tiers(const char* reason) {
612 record_method_not_compilable(reason, true);
613 }
614 bool check_node_count(uint margin, const char* reason) {
615 if (live_nodes() + margin > (uint)MaxNodeLimit) {
616 record_method_not_compilable(reason);
617 return true;
618 } else {
619 return false;
620 }
621 }
623 // Node management
624 uint unique() const { return _unique; }
625 uint next_unique() { return _unique++; }
626 void set_unique(uint i) { _unique = i; }
627 static int debug_idx() { return debug_only(_debug_idx)+0; }
628 static void set_debug_idx(int i) { debug_only(_debug_idx = i); }
629 Arena* node_arena() { return &_node_arena; }
630 Arena* old_arena() { return &_old_arena; }
631 RootNode* root() const { return _root; }
632 void set_root(RootNode* r) { _root = r; }
633 StartNode* start() const; // (Derived from root.)
634 void init_start(StartNode* s);
635 Node* immutable_memory();
637 Node* recent_alloc_ctl() const { return _recent_alloc_ctl; }
638 Node* recent_alloc_obj() const { return _recent_alloc_obj; }
639 void set_recent_alloc(Node* ctl, Node* obj) {
640 _recent_alloc_ctl = ctl;
641 _recent_alloc_obj = obj;
642 }
643 void record_dead_node(uint idx) { if (_dead_node_list.test_set(idx)) return;
644 _dead_node_count++;
645 }
646 uint dead_node_count() { return _dead_node_count; }
647 void reset_dead_node_list() { _dead_node_list.Reset();
648 _dead_node_count = 0;
649 }
650 uint live_nodes() const {
651 int val = _unique - _dead_node_count;
652 assert (val >= 0, err_msg_res("number of tracked dead nodes %d more than created nodes %d", _unique, _dead_node_count));
653 return (uint) val;
654 }
655 #ifdef ASSERT
656 uint count_live_nodes_by_graph_walk();
657 void print_missing_nodes();
658 #endif
660 // Constant table
661 ConstantTable& constant_table() { return _constant_table; }
663 MachConstantBaseNode* mach_constant_base_node();
664 bool has_mach_constant_base_node() const { return _mach_constant_base_node != NULL; }
666 // Handy undefined Node
667 Node* top() const { return _top; }
669 // these are used by guys who need to know about creation and transformation of top:
670 Node* cached_top_node() { return _top; }
671 void set_cached_top_node(Node* tn);
673 GrowableArray<Node_Notes*>* node_note_array() const { return _node_note_array; }
674 void set_node_note_array(GrowableArray<Node_Notes*>* arr) { _node_note_array = arr; }
675 Node_Notes* default_node_notes() const { return _default_node_notes; }
676 void set_default_node_notes(Node_Notes* n) { _default_node_notes = n; }
678 Node_Notes* node_notes_at(int idx) {
679 return locate_node_notes(_node_note_array, idx, false);
680 }
681 inline bool set_node_notes_at(int idx, Node_Notes* value);
683 // Copy notes from source to dest, if they exist.
684 // Overwrite dest only if source provides something.
685 // Return true if information was moved.
686 bool copy_node_notes_to(Node* dest, Node* source);
688 // Workhorse function to sort out the blocked Node_Notes array:
689 inline Node_Notes* locate_node_notes(GrowableArray<Node_Notes*>* arr,
690 int idx, bool can_grow = false);
692 void grow_node_notes(GrowableArray<Node_Notes*>* arr, int grow_by);
694 // Type management
695 Arena* type_arena() { return _type_arena; }
696 Dict* type_dict() { return _type_dict; }
697 void* type_hwm() { return _type_hwm; }
698 size_t type_last_size() { return _type_last_size; }
699 int num_alias_types() { return _num_alias_types; }
701 void init_type_arena() { _type_arena = &_Compile_types; }
702 void set_type_arena(Arena* a) { _type_arena = a; }
703 void set_type_dict(Dict* d) { _type_dict = d; }
704 void set_type_hwm(void* p) { _type_hwm = p; }
705 void set_type_last_size(size_t sz) { _type_last_size = sz; }
707 const TypeFunc* last_tf(ciMethod* m) {
708 return (m == _last_tf_m) ? _last_tf : NULL;
709 }
710 void set_last_tf(ciMethod* m, const TypeFunc* tf) {
711 assert(m != NULL || tf == NULL, "");
712 _last_tf_m = m;
713 _last_tf = tf;
714 }
716 AliasType* alias_type(int idx) { assert(idx < num_alias_types(), "oob"); return _alias_types[idx]; }
717 AliasType* alias_type(const TypePtr* adr_type, ciField* field = NULL) { return find_alias_type(adr_type, false, field); }
718 bool have_alias_type(const TypePtr* adr_type);
719 AliasType* alias_type(ciField* field);
721 int get_alias_index(const TypePtr* at) { return alias_type(at)->index(); }
722 const TypePtr* get_adr_type(uint aidx) { return alias_type(aidx)->adr_type(); }
723 int get_general_index(uint aidx) { return alias_type(aidx)->general_index(); }
725 // Building nodes
726 void rethrow_exceptions(JVMState* jvms);
727 void return_values(JVMState* jvms);
728 JVMState* build_start_state(StartNode* start, const TypeFunc* tf);
730 // Decide how to build a call.
731 // The profile factor is a discount to apply to this site's interp. profile.
732 CallGenerator* call_generator(ciMethod* call_method, int vtable_index, bool call_is_virtual, JVMState* jvms, bool allow_inline, float profile_factor, bool allow_intrinsics = true);
733 bool should_delay_inlining(ciMethod* call_method, JVMState* jvms);
735 // Report if there were too many traps at a current method and bci.
736 // Report if a trap was recorded, and/or PerMethodTrapLimit was exceeded.
737 // If there is no MDO at all, report no trap unless told to assume it.
738 bool too_many_traps(ciMethod* method, int bci, Deoptimization::DeoptReason reason);
739 // This version, unspecific to a particular bci, asks if
740 // PerMethodTrapLimit was exceeded for all inlined methods seen so far.
741 bool too_many_traps(Deoptimization::DeoptReason reason,
742 // Privately used parameter for logging:
743 ciMethodData* logmd = NULL);
744 // Report if there were too many recompiles at a method and bci.
745 bool too_many_recompiles(ciMethod* method, int bci, Deoptimization::DeoptReason reason);
747 // Parsing, optimization
748 PhaseGVN* initial_gvn() { return _initial_gvn; }
749 Unique_Node_List* for_igvn() { return _for_igvn; }
750 inline void record_for_igvn(Node* n); // Body is after class Unique_Node_List.
751 void set_initial_gvn(PhaseGVN *gvn) { _initial_gvn = gvn; }
752 void set_for_igvn(Unique_Node_List *for_igvn) { _for_igvn = for_igvn; }
754 // Replace n by nn using initial_gvn, calling hash_delete and
755 // record_for_igvn as needed.
756 void gvn_replace_by(Node* n, Node* nn);
759 void identify_useful_nodes(Unique_Node_List &useful);
760 void update_dead_node_list(Unique_Node_List &useful);
761 void remove_useless_nodes (Unique_Node_List &useful);
763 WarmCallInfo* warm_calls() const { return _warm_calls; }
764 void set_warm_calls(WarmCallInfo* l) { _warm_calls = l; }
765 WarmCallInfo* pop_warm_call();
767 // Record this CallGenerator for inlining at the end of parsing.
768 void add_late_inline(CallGenerator* cg) { _late_inlines.push(cg); }
770 void dump_inlining();
772 // Matching, CFG layout, allocation, code generation
773 PhaseCFG* cfg() { return _cfg; }
774 bool select_24_bit_instr() const { return _select_24_bit_instr; }
775 bool in_24_bit_fp_mode() const { return _in_24_bit_fp_mode; }
776 bool has_java_calls() const { return _java_calls > 0; }
777 int java_calls() const { return _java_calls; }
778 int inner_loops() const { return _inner_loops; }
779 Matcher* matcher() { return _matcher; }
780 PhaseRegAlloc* regalloc() { return _regalloc; }
781 int frame_slots() const { return _frame_slots; }
782 int frame_size_in_words() const; // frame_slots in units of the polymorphic 'words'
783 RegMask& FIRST_STACK_mask() { return _FIRST_STACK_mask; }
784 Arena* indexSet_arena() { return _indexSet_arena; }
785 void* indexSet_free_block_list() { return _indexSet_free_block_list; }
786 uint node_bundling_limit() { return _node_bundling_limit; }
787 Bundle* node_bundling_base() { return _node_bundling_base; }
788 void set_node_bundling_limit(uint n) { _node_bundling_limit = n; }
789 void set_node_bundling_base(Bundle* b) { _node_bundling_base = b; }
790 bool starts_bundle(const Node *n) const;
791 bool need_stack_bang(int frame_size_in_bytes) const;
792 bool need_register_stack_bang() const;
794 void set_matcher(Matcher* m) { _matcher = m; }
795 //void set_regalloc(PhaseRegAlloc* ra) { _regalloc = ra; }
796 void set_indexSet_arena(Arena* a) { _indexSet_arena = a; }
797 void set_indexSet_free_block_list(void* p) { _indexSet_free_block_list = p; }
799 // Remember if this compilation changes hardware mode to 24-bit precision
800 void set_24_bit_selection_and_mode(bool selection, bool mode) {
801 _select_24_bit_instr = selection;
802 _in_24_bit_fp_mode = mode;
803 }
805 void set_java_calls(int z) { _java_calls = z; }
806 void set_inner_loops(int z) { _inner_loops = z; }
808 // Instruction bits passed off to the VM
809 int code_size() { return _method_size; }
810 CodeBuffer* code_buffer() { return &_code_buffer; }
811 int first_block_size() { return _first_block_size; }
812 void set_frame_complete(int off) { _code_offsets.set_value(CodeOffsets::Frame_Complete, off); }
813 ExceptionHandlerTable* handler_table() { return &_handler_table; }
814 ImplicitExceptionTable* inc_table() { return &_inc_table; }
815 OopMapSet* oop_map_set() { return _oop_map_set; }
816 DebugInformationRecorder* debug_info() { return env()->debug_info(); }
817 Dependencies* dependencies() { return env()->dependencies(); }
818 static int CompiledZap_count() { return _CompiledZap_count; }
819 BufferBlob* scratch_buffer_blob() { return _scratch_buffer_blob; }
820 void init_scratch_buffer_blob(int const_size);
821 void clear_scratch_buffer_blob();
822 void set_scratch_buffer_blob(BufferBlob* b) { _scratch_buffer_blob = b; }
823 relocInfo* scratch_locs_memory() { return _scratch_locs_memory; }
824 void set_scratch_locs_memory(relocInfo* b) { _scratch_locs_memory = b; }
826 // emit to scratch blob, report resulting size
827 uint scratch_emit_size(const Node* n);
828 void set_in_scratch_emit_size(bool x) { _in_scratch_emit_size = x; }
829 bool in_scratch_emit_size() const { return _in_scratch_emit_size; }
831 enum ScratchBufferBlob {
832 MAX_inst_size = 1024,
833 MAX_locs_size = 128, // number of relocInfo elements
834 MAX_const_size = 128,
835 MAX_stubs_size = 128
836 };
838 // Major entry point. Given a Scope, compile the associated method.
839 // For normal compilations, entry_bci is InvocationEntryBci. For on stack
840 // replacement, entry_bci indicates the bytecode for which to compile a
841 // continuation.
842 Compile(ciEnv* ci_env, C2Compiler* compiler, ciMethod* target,
843 int entry_bci, bool subsume_loads, bool do_escape_analysis);
845 // Second major entry point. From the TypeFunc signature, generate code
846 // to pass arguments from the Java calling convention to the C calling
847 // convention.
848 Compile(ciEnv* ci_env, const TypeFunc *(*gen)(),
849 address stub_function, const char *stub_name,
850 int is_fancy_jump, bool pass_tls,
851 bool save_arg_registers, bool return_pc);
853 // From the TypeFunc signature, generate code to pass arguments
854 // from Compiled calling convention to Interpreter's calling convention
855 void Generate_Compiled_To_Interpreter_Graph(const TypeFunc *tf, address interpreter_entry);
857 // From the TypeFunc signature, generate code to pass arguments
858 // from Interpreter's calling convention to Compiler's calling convention
859 void Generate_Interpreter_To_Compiled_Graph(const TypeFunc *tf);
861 // Are we compiling a method?
862 bool has_method() { return method() != NULL; }
864 // Maybe print some information about this compile.
865 void print_compile_messages();
867 // Final graph reshaping, a post-pass after the regular optimizer is done.
868 bool final_graph_reshaping();
870 // returns true if adr is completely contained in the given alias category
871 bool must_alias(const TypePtr* adr, int alias_idx);
873 // returns true if adr overlaps with the given alias category
874 bool can_alias(const TypePtr* adr, int alias_idx);
876 // Driver for converting compiler's IR into machine code bits
877 void Output();
879 // Accessors for node bundling info.
880 Bundle* node_bundling(const Node *n);
881 bool valid_bundle_info(const Node *n);
883 // Schedule and Bundle the instructions
884 void ScheduleAndBundle();
886 // Build OopMaps for each GC point
887 void BuildOopMaps();
889 // Append debug info for the node "local" at safepoint node "sfpt" to the
890 // "array", May also consult and add to "objs", which describes the
891 // scalar-replaced objects.
892 void FillLocArray( int idx, MachSafePointNode* sfpt,
893 Node *local, GrowableArray<ScopeValue*> *array,
894 GrowableArray<ScopeValue*> *objs );
896 // If "objs" contains an ObjectValue whose id is "id", returns it, else NULL.
897 static ObjectValue* sv_for_node_id(GrowableArray<ScopeValue*> *objs, int id);
898 // Requres that "objs" does not contains an ObjectValue whose id matches
899 // that of "sv. Appends "sv".
900 static void set_sv_for_object_node(GrowableArray<ScopeValue*> *objs,
901 ObjectValue* sv );
903 // Process an OopMap Element while emitting nodes
904 void Process_OopMap_Node(MachNode *mach, int code_offset);
906 // Initialize code buffer
907 CodeBuffer* init_buffer(uint* blk_starts);
909 // Write out basic block data to code buffer
910 void fill_buffer(CodeBuffer* cb, uint* blk_starts);
912 // Determine which variable sized branches can be shortened
913 void shorten_branches(uint* blk_starts, int& code_size, int& reloc_size, int& stub_size);
915 // Compute the size of first NumberOfLoopInstrToAlign instructions
916 // at the head of a loop.
917 void compute_loop_first_inst_sizes();
919 // Compute the information for the exception tables
920 void FillExceptionTables(uint cnt, uint *call_returns, uint *inct_starts, Label *blk_labels);
922 // Stack slots that may be unused by the calling convention but must
923 // otherwise be preserved. On Intel this includes the return address.
924 // On PowerPC it includes the 4 words holding the old TOC & LR glue.
925 uint in_preserve_stack_slots();
927 // "Top of Stack" slots that may be unused by the calling convention but must
928 // otherwise be preserved.
929 // On Intel these are not necessary and the value can be zero.
930 // On Sparc this describes the words reserved for storing a register window
931 // when an interrupt occurs.
932 static uint out_preserve_stack_slots();
934 // Number of outgoing stack slots killed above the out_preserve_stack_slots
935 // for calls to C. Supports the var-args backing area for register parms.
936 uint varargs_C_out_slots_killed() const;
938 // Number of Stack Slots consumed by a synchronization entry
939 int sync_stack_slots() const;
941 // Compute the name of old_SP. See <arch>.ad for frame layout.
942 OptoReg::Name compute_old_SP();
944 #ifdef ENABLE_ZAP_DEAD_LOCALS
945 static bool is_node_getting_a_safepoint(Node*);
946 void Insert_zap_nodes();
947 Node* call_zap_node(MachSafePointNode* n, int block_no);
948 #endif
950 private:
951 // Phase control:
952 void Init(int aliaslevel); // Prepare for a single compilation
953 int Inline_Warm(); // Find more inlining work.
954 void Finish_Warm(); // Give up on further inlines.
955 void Optimize(); // Given a graph, optimize it
956 void Code_Gen(); // Generate code from a graph
958 // Management of the AliasType table.
959 void grow_alias_types();
960 AliasCacheEntry* probe_alias_cache(const TypePtr* adr_type);
961 const TypePtr *flatten_alias_type(const TypePtr* adr_type) const;
962 AliasType* find_alias_type(const TypePtr* adr_type, bool no_create, ciField* field);
964 void verify_top(Node*) const PRODUCT_RETURN;
966 // Intrinsic setup.
967 void register_library_intrinsics(); // initializer
968 CallGenerator* make_vm_intrinsic(ciMethod* m, bool is_virtual); // constructor
969 int intrinsic_insertion_index(ciMethod* m, bool is_virtual); // helper
970 CallGenerator* find_intrinsic(ciMethod* m, bool is_virtual); // query fn
971 void register_intrinsic(CallGenerator* cg); // update fn
973 #ifndef PRODUCT
974 static juint _intrinsic_hist_count[vmIntrinsics::ID_LIMIT];
975 static jubyte _intrinsic_hist_flags[vmIntrinsics::ID_LIMIT];
976 #endif
977 // Function calls made by the public function final_graph_reshaping.
978 // No need to be made public as they are not called elsewhere.
979 void final_graph_reshaping_impl( Node *n, Final_Reshape_Counts &frc);
980 void final_graph_reshaping_walk( Node_Stack &nstack, Node *root, Final_Reshape_Counts &frc );
981 void eliminate_redundant_card_marks(Node* n);
983 public:
985 // Note: Histogram array size is about 1 Kb.
986 enum { // flag bits:
987 _intrinsic_worked = 1, // succeeded at least once
988 _intrinsic_failed = 2, // tried it but it failed
989 _intrinsic_disabled = 4, // was requested but disabled (e.g., -XX:-InlineUnsafeOps)
990 _intrinsic_virtual = 8, // was seen in the virtual form (rare)
991 _intrinsic_both = 16 // was seen in the non-virtual form (usual)
992 };
993 // Update histogram. Return boolean if this is a first-time occurrence.
994 static bool gather_intrinsic_statistics(vmIntrinsics::ID id,
995 bool is_virtual, int flags) PRODUCT_RETURN0;
996 static void print_intrinsic_statistics() PRODUCT_RETURN;
998 // Graph verification code
999 // Walk the node list, verifying that there is a one-to-one
1000 // correspondence between Use-Def edges and Def-Use edges
1001 // The option no_dead_code enables stronger checks that the
1002 // graph is strongly connected from root in both directions.
1003 void verify_graph_edges(bool no_dead_code = false) PRODUCT_RETURN;
1005 // End-of-run dumps.
1006 static void print_statistics() PRODUCT_RETURN;
1008 // Dump formatted assembly
1009 void dump_asm(int *pcs = NULL, uint pc_limit = 0) PRODUCT_RETURN;
1010 void dump_pc(int *pcs, int pc_limit, Node *n);
1012 // Verify ADLC assumptions during startup
1013 static void adlc_verification() PRODUCT_RETURN;
1015 // Definitions of pd methods
1016 static void pd_compiler2_init();
1017 };
1019 #endif // SHARE_VM_OPTO_COMPILE_HPP