1 /*
2 * Copyright (c) 1997, 2025, 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_OPTO_COMPILE_HPP
26 #define SHARE_OPTO_COMPILE_HPP
27
28 #include "asm/codeBuffer.hpp"
29 #include "ci/compilerInterface.hpp"
30 #include "code/debugInfoRec.hpp"
31 #include "compiler/compiler_globals.hpp"
32 #include "compiler/compileBroker.hpp"
33 #include "compiler/compilerEvent.hpp"
34 #include "compiler/cHeapStringHolder.hpp"
35 #include "libadt/dict.hpp"
36 #include "libadt/vectset.hpp"
37 #include "memory/resourceArea.hpp"
38 #include "oops/methodData.hpp"
39 #include "opto/idealGraphPrinter.hpp"
40 #include "opto/phasetype.hpp"
41 #include "opto/phase.hpp"
42 #include "opto/regmask.hpp"
43 #include "runtime/deoptimization.hpp"
44 #include "runtime/sharedRuntime.hpp"
45 #include "runtime/timerTrace.hpp"
46 #include "runtime/vmThread.hpp"
47 #include "utilities/ticks.hpp"
48 #include "utilities/vmEnums.hpp"
49 #include "opto/printinlining.hpp"
50
51 class AbstractLockNode;
52 class AddPNode;
53 class Block;
54 class Bundle;
55 class CallGenerator;
56 class CallNode;
57 class CallStaticJavaNode;
58 class CloneMap;
59 class CompilationFailureInfo;
60 class ConnectionGraph;
61 class IdealGraphPrinter;
62 class InlineTree;
63 class Matcher;
64 class MachConstantNode;
65 class MachConstantBaseNode;
66 class MachNode;
67 class MachOper;
68 class MachSafePointNode;
69 class Node;
70 class Node_Array;
71 class Node_List;
72 class Node_Notes;
73 class NodeHash;
74 class NodeCloneInfo;
75 class OpaqueTemplateAssertionPredicateNode;
76 class OptoReg;
77 class ParsePredicateNode;
78 class PhaseCFG;
79 class PhaseGVN;
80 class PhaseIterGVN;
81 class PhaseRegAlloc;
82 class PhaseCCP;
83 class PhaseOutput;
84 class RootNode;
85 class relocInfo;
86 class StartNode;
87 class SafePointNode;
88 class JVMState;
89 class Type;
90 class TypeInt;
91 class TypeInteger;
92 class TypeKlassPtr;
93 class TypePtr;
94 class TypeOopPtr;
95 class TypeFunc;
96 class TypeVect;
97 class Type_Array;
98 class Unique_Node_List;
99 class UnstableIfTrap;
100 class InlineTypeNode;
101 class nmethod;
102 class Node_Stack;
103 struct Final_Reshape_Counts;
104 class VerifyMeetResult;
105
106 enum LoopOptsMode {
107 LoopOptsDefault,
108 LoopOptsNone,
109 LoopOptsMaxUnroll,
110 LoopOptsShenandoahExpand,
111 LoopOptsSkipSplitIf,
112 LoopOptsVerify
113 };
114
115 // The type of all node counts and indexes.
116 // It must hold at least 16 bits, but must also be fast to load and store.
117 // This type, if less than 32 bits, could limit the number of possible nodes.
118 // (To make this type platform-specific, move to globalDefinitions_xxx.hpp.)
119 typedef unsigned int node_idx_t;
120
121 class NodeCloneInfo {
122 private:
123 uint64_t _idx_clone_orig;
124 public:
125
126 void set_idx(node_idx_t idx) {
127 _idx_clone_orig = (_idx_clone_orig & CONST64(0xFFFFFFFF00000000)) | idx;
128 }
129 node_idx_t idx() const { return (node_idx_t)(_idx_clone_orig & 0xFFFFFFFF); }
130
131 void set_gen(int generation) {
132 uint64_t g = (uint64_t)generation << 32;
133 _idx_clone_orig = (_idx_clone_orig & 0xFFFFFFFF) | g;
134 }
135 int gen() const { return (int)(_idx_clone_orig >> 32); }
136
137 void set(uint64_t x) { _idx_clone_orig = x; }
138 void set(node_idx_t x, int g) { set_idx(x); set_gen(g); }
139 uint64_t get() const { return _idx_clone_orig; }
140
141 NodeCloneInfo(uint64_t idx_clone_orig) : _idx_clone_orig(idx_clone_orig) {}
142 NodeCloneInfo(node_idx_t x, int g) : _idx_clone_orig(0) { set(x, g); }
143
144 void dump_on(outputStream* st) const;
145 };
146
147 class CloneMap {
148 friend class Compile;
149 private:
150 bool _debug;
151 Dict* _dict;
152 int _clone_idx; // current cloning iteration/generation in loop unroll
153 public:
154 void* _2p(node_idx_t key) const { return (void*)(intptr_t)key; } // 2 conversion functions to make gcc happy
155 node_idx_t _2_node_idx_t(const void* k) const { return (node_idx_t)(intptr_t)k; }
156 Dict* dict() const { return _dict; }
157 void insert(node_idx_t key, uint64_t val) { assert(_dict->operator[](_2p(key)) == nullptr, "key existed"); _dict->Insert(_2p(key), (void*)val); }
158 void insert(node_idx_t key, NodeCloneInfo& ci) { insert(key, ci.get()); }
159 void remove(node_idx_t key) { _dict->Delete(_2p(key)); }
160 uint64_t value(node_idx_t key) const { return (uint64_t)_dict->operator[](_2p(key)); }
161 node_idx_t idx(node_idx_t key) const { return NodeCloneInfo(value(key)).idx(); }
162 int gen(node_idx_t key) const { return NodeCloneInfo(value(key)).gen(); }
163 int gen(const void* k) const { return gen(_2_node_idx_t(k)); }
164 int max_gen() const;
165 void clone(Node* old, Node* nnn, int gen);
166 void verify_insert_and_clone(Node* old, Node* nnn, int gen);
167 void dump(node_idx_t key, outputStream* st) const;
168
169 int clone_idx() const { return _clone_idx; }
170 void set_clone_idx(int x) { _clone_idx = x; }
171 bool is_debug() const { return _debug; }
172 void set_debug(bool debug) { _debug = debug; }
173
174 bool same_idx(node_idx_t k1, node_idx_t k2) const { return idx(k1) == idx(k2); }
175 bool same_gen(node_idx_t k1, node_idx_t k2) const { return gen(k1) == gen(k2); }
176 };
177
178 class Options {
179 friend class Compile;
180 private:
181 const bool _subsume_loads; // Load can be matched as part of a larger op.
182 const bool _do_escape_analysis; // Do escape analysis.
183 const bool _do_iterative_escape_analysis; // Do iterative escape analysis.
184 const bool _do_reduce_allocation_merges; // Do try to reduce allocation merges.
185 const bool _eliminate_boxing; // Do boxing elimination.
186 const bool _do_locks_coarsening; // Do locks coarsening
187 const bool _do_superword; // Do SuperWord
188 const bool _install_code; // Install the code that was compiled
189 public:
190 Options(bool subsume_loads,
191 bool do_escape_analysis,
192 bool do_iterative_escape_analysis,
193 bool do_reduce_allocation_merges,
194 bool eliminate_boxing,
195 bool do_locks_coarsening,
196 bool do_superword,
197 bool install_code) :
198 _subsume_loads(subsume_loads),
199 _do_escape_analysis(do_escape_analysis),
200 _do_iterative_escape_analysis(do_iterative_escape_analysis),
201 _do_reduce_allocation_merges(do_reduce_allocation_merges),
202 _eliminate_boxing(eliminate_boxing),
203 _do_locks_coarsening(do_locks_coarsening),
204 _do_superword(do_superword),
205 _install_code(install_code) {
206 }
207
208 static Options for_runtime_stub() {
209 return Options(
210 /* subsume_loads = */ true,
211 /* do_escape_analysis = */ false,
212 /* do_iterative_escape_analysis = */ false,
213 /* do_reduce_allocation_merges = */ false,
214 /* eliminate_boxing = */ false,
215 /* do_lock_coarsening = */ false,
216 /* do_superword = */ true,
217 /* install_code = */ true
218 );
219 }
220 };
221
222 //------------------------------Compile----------------------------------------
223 // This class defines a top-level Compiler invocation.
224
225 class Compile : public Phase {
226
227 public:
228 // Fixed alias indexes. (See also MergeMemNode.)
229 enum {
230 AliasIdxTop = 1, // pseudo-index, aliases to nothing (used as sentinel value)
231 AliasIdxBot = 2, // pseudo-index, aliases to everything
232 AliasIdxRaw = 3 // hard-wired index for TypeRawPtr::BOTTOM
233 };
234
235 // Variant of TraceTime(nullptr, &_t_accumulator, CITime);
236 // Integrated with logging. If logging is turned on, and CITimeVerbose is true,
237 // then brackets are put into the log, with time stamps and node counts.
238 // (The time collection itself is always conditionalized on CITime.)
239 class TracePhase : public TraceTime {
240 private:
241 Compile* const _compile;
242 CompileLog* _log;
243 const bool _dolog;
244 public:
245 TracePhase(PhaseTraceId phaseTraceId);
246 TracePhase(const char* name, PhaseTraceId phaseTraceId);
247 ~TracePhase();
248 const char* phase_name() const { return title(); }
249 };
250
251 // Information per category of alias (memory slice)
252 class AliasType {
253 private:
254 friend class Compile;
255
256 int _index; // unique index, used with MergeMemNode
257 const TypePtr* _adr_type; // normalized address type
258 ciField* _field; // relevant instance field, or null if none
259 const Type* _element; // relevant array element type, or null if none
260 bool _is_rewritable; // false if the memory is write-once only
261 int _general_index; // if this is type is an instance, the general
262 // type that this is an instance of
263
264 void Init(int i, const TypePtr* at);
265
266 public:
267 int index() const { return _index; }
268 const TypePtr* adr_type() const { return _adr_type; }
269 ciField* field() const { return _field; }
270 const Type* element() const { return _element; }
271 bool is_rewritable() const { return _is_rewritable; }
272 bool is_volatile() const { return (_field ? _field->is_volatile() : false); }
273 int general_index() const { return (_general_index != 0) ? _general_index : _index; }
274
275 void set_rewritable(bool z) { _is_rewritable = z; }
276 void set_field(ciField* f) {
277 assert(!_field,"");
278 _field = f;
279 if (f->is_final() || f->is_stable()) {
280 // In the case of @Stable, multiple writes are possible but may be assumed to be no-ops.
281 _is_rewritable = false;
282 }
283 }
284 void set_element(const Type* e) {
285 assert(_element == nullptr, "");
286 _element = e;
287 }
288
289 BasicType basic_type() const;
290
291 void print_on(outputStream* st) PRODUCT_RETURN;
292 };
293
294 enum {
295 logAliasCacheSize = 6,
296 AliasCacheSize = (1<<logAliasCacheSize)
297 };
298 struct AliasCacheEntry { const TypePtr* _adr_type; int _index; }; // simple duple type
299 enum {
300 trapHistLength = MethodData::_trap_hist_limit
301 };
302
303 private:
304 // Fixed parameters to this compilation.
305 const int _compile_id;
306 const Options _options; // Compilation options
307 ciMethod* _method; // The method being compiled.
308 int _entry_bci; // entry bci for osr methods.
309 const TypeFunc* _tf; // My kind of signature
310 InlineTree* _ilt; // Ditto (temporary).
311 address _stub_function; // VM entry for stub being compiled, or null
312 const char* _stub_name; // Name of stub or adapter being compiled, or null
313 address _stub_entry_point; // Compile code entry for generated stub, or null
314
315 // Control of this compilation.
316 int _max_inline_size; // Max inline size for this compilation
317 int _freq_inline_size; // Max hot method inline size for this compilation
318 int _fixed_slots; // count of frame slots not allocated by the register
319 // allocator i.e. locks, original deopt pc, etc.
320 uintx _max_node_limit; // Max unique node count during a single compilation.
321
322 bool _post_loop_opts_phase; // Loop opts are finished.
323 bool _merge_stores_phase; // Phase for merging stores, after post loop opts phase.
324 bool _allow_macro_nodes; // True if we allow creation of macro nodes.
325
326 int _major_progress; // Count of something big happening
327 bool _inlining_progress; // progress doing incremental inlining?
328 bool _inlining_incrementally;// Are we doing incremental inlining (post parse)
329 bool _do_cleanup; // Cleanup is needed before proceeding with incremental inlining
330 bool _has_loops; // True if the method _may_ have some loops
331 bool _has_split_ifs; // True if the method _may_ have some split-if
332 bool _has_unsafe_access; // True if the method _may_ produce faults in unsafe loads or stores.
333 bool _has_stringbuilder; // True StringBuffers or StringBuilders are allocated
334 bool _has_boxed_value; // True if a boxed object is allocated
335 bool _has_reserved_stack_access; // True if the method or an inlined method is annotated with ReservedStackAccess
336 bool _has_circular_inline_type; // True if method loads an inline type with a circular, non-flat field
337 uint _max_vector_size; // Maximum size of generated vectors
338 bool _clear_upper_avx; // Clear upper bits of ymm registers using vzeroupper
339 uint _trap_hist[trapHistLength]; // Cumulative traps
340 bool _trap_can_recompile; // Have we emitted a recompiling trap?
341 uint _decompile_count; // Cumulative decompilation counts.
342 bool _do_inlining; // True if we intend to do inlining
343 bool _do_scheduling; // True if we intend to do scheduling
344 bool _do_freq_based_layout; // True if we intend to do frequency based block layout
345 bool _do_vector_loop; // True if allowed to execute loop in parallel iterations
346 bool _use_cmove; // True if CMove should be used without profitability analysis
347 bool _do_aliasing; // True if we intend to do aliasing
348 bool _print_assembly; // True if we should dump assembly code for this compilation
349 bool _print_inlining; // True if we should print inlining for this compilation
350 bool _print_intrinsics; // True if we should print intrinsics for this compilation
351 #ifndef PRODUCT
352 uint _igv_idx; // Counter for IGV node identifiers
353 uint _igv_phase_iter[PHASE_NUM_TYPES]; // Counters for IGV phase iterations
354 bool _trace_opto_output;
355 bool _parsed_irreducible_loop; // True if ciTypeFlow detected irreducible loops during parsing
356 #endif
357 bool _has_irreducible_loop; // Found irreducible loops
358 // JSR 292
359 bool _has_method_handle_invokes; // True if this method has MethodHandle invokes.
360 bool _has_monitors; // Metadata transfered to nmethod to enable Continuations lock-detection fastpath
361 bool _has_scoped_access; // For shared scope closure
362 bool _clinit_barrier_on_entry; // True if clinit barrier is needed on nmethod entry
363 int _loop_opts_cnt; // loop opts round
364 bool _has_flat_accesses; // Any known flat array accesses?
365 bool _flat_accesses_share_alias; // Initially all flat array share a single slice
366 bool _scalarize_in_safepoints; // Scalarize inline types in safepoint debug info
367 uint _stress_seed; // Seed for stress testing
368
369 // Compilation environment.
370 Arena _comp_arena; // Arena with lifetime equivalent to Compile
371 void* _barrier_set_state; // Potential GC barrier state for Compile
372 ciEnv* _env; // CI interface
373 DirectiveSet* _directive; // Compiler directive
374 CompileLog* _log; // from CompilerThread
375 CHeapStringHolder _failure_reason; // for record_failure/failing pattern
376 CompilationFailureInfo* _first_failure_details; // Details for the first failure happening during compilation
377 GrowableArray<CallGenerator*> _intrinsics; // List of intrinsics.
378 GrowableArray<Node*> _macro_nodes; // List of nodes which need to be expanded before matching.
379 GrowableArray<ParsePredicateNode*> _parse_predicates; // List of Parse Predicates.
380 // List of OpaqueTemplateAssertionPredicateNode nodes for Template Assertion Predicates which can be seen as list
381 // of Template Assertion Predicates themselves.
382 GrowableArray<OpaqueTemplateAssertionPredicateNode*> _template_assertion_predicate_opaques;
383 GrowableArray<Node*> _expensive_nodes; // List of nodes that are expensive to compute and that we'd better not let the GVN freely common
384 GrowableArray<Node*> _for_post_loop_igvn; // List of nodes for IGVN after loop opts are over
385 GrowableArray<Node*> _inline_type_nodes; // List of InlineType nodes
386 GrowableArray<Node*> _for_merge_stores_igvn; // List of nodes for IGVN merge stores
387 GrowableArray<UnstableIfTrap*> _unstable_if_traps; // List of ifnodes after IGVN
388 GrowableArray<Node_List*> _coarsened_locks; // List of coarsened Lock and Unlock nodes
389 ConnectionGraph* _congraph;
390 #ifndef PRODUCT
391 IdealGraphPrinter* _igv_printer;
392 static IdealGraphPrinter* _debug_file_printer;
393 static IdealGraphPrinter* _debug_network_printer;
394 #endif
395
396
397 // Node management
398 uint _unique; // Counter for unique Node indices
399 uint _dead_node_count; // Number of dead nodes; VectorSet::Size() is O(N).
400 // So use this to keep count and make the call O(1).
401 VectorSet _dead_node_list; // Set of dead nodes
402 DEBUG_ONLY(Unique_Node_List* _modified_nodes;) // List of nodes which inputs were modified
403 DEBUG_ONLY(bool _phase_optimize_finished;) // Used for live node verification while creating new nodes
404
405 DEBUG_ONLY(bool _phase_verify_ideal_loop;) // Are we in PhaseIdealLoop verification?
406
407 // Arenas for new-space and old-space nodes.
408 // Swapped between using _node_arena.
409 // The lifetime of the old-space nodes is during xform.
410 Arena _node_arena_one;
411 Arena _node_arena_two;
412 Arena* _node_arena;
413 public:
414 Arena* swap_old_and_new() {
415 Arena* filled_arena_ptr = _node_arena;
416 Arena* old_arena_ptr = old_arena();
417 old_arena_ptr->destruct_contents();
418 _node_arena = old_arena_ptr;
419 return filled_arena_ptr;
420 }
421 private:
422 RootNode* _root; // Unique root of compilation, or null after bail-out.
423 Node* _top; // Unique top node. (Reset by various phases.)
424
425 Node* _immutable_memory; // Initial memory state
426
427 Node* _recent_alloc_obj;
428 Node* _recent_alloc_ctl;
429
430 // Constant table
431 MachConstantBaseNode* _mach_constant_base_node; // Constant table base node singleton.
432
433
434 // Blocked array of debugging and profiling information,
435 // tracked per node.
436 enum { _log2_node_notes_block_size = 8,
437 _node_notes_block_size = (1<<_log2_node_notes_block_size)
438 };
439 GrowableArray<Node_Notes*>* _node_note_array;
440 Node_Notes* _default_node_notes; // default notes for new nodes
441
442 // After parsing and every bulk phase we hang onto the Root instruction.
443 // The RootNode instruction is where the whole program begins. It produces
444 // the initial Control and BOTTOM for everybody else.
445
446 // Type management
447 Arena _Compile_types; // Arena for all types
448 Arena* _type_arena; // Alias for _Compile_types except in Initialize_shared()
449 Dict* _type_dict; // Intern table
450 CloneMap _clone_map; // used for recording history of cloned nodes
451 size_t _type_last_size; // Last allocation size (see Type::operator new/delete)
452 ciMethod* _last_tf_m; // Cache for
453 const TypeFunc* _last_tf; // TypeFunc::make
454 AliasType** _alias_types; // List of alias types seen so far.
455 int _num_alias_types; // Logical length of _alias_types
456 int _max_alias_types; // Physical length of _alias_types
457 AliasCacheEntry _alias_cache[AliasCacheSize]; // Gets aliases w/o data structure walking
458
459 // Parsing, optimization
460 PhaseGVN* _initial_gvn; // Results of parse-time PhaseGVN
461
462 // Shared worklist for all IGVN rounds. Nodes can be pushed to it at any time.
463 // If pushed outside IGVN, the Node is processed in the next IGVN round.
464 Unique_Node_List* _igvn_worklist;
465
466 // Shared type array for GVN, IGVN and CCP. It maps node idx -> Type*.
467 Type_Array* _types;
468
469 // Shared node hash table for GVN, IGVN and CCP.
470 NodeHash* _node_hash;
471
472 GrowableArray<CallGenerator*> _late_inlines; // List of CallGenerators to be revisited after main parsing has finished.
473 GrowableArray<CallGenerator*> _string_late_inlines; // same but for string operations
474 GrowableArray<CallGenerator*> _boxing_late_inlines; // same but for boxing operations
475
476 GrowableArray<CallGenerator*> _vector_reboxing_late_inlines; // same but for vector reboxing operations
477
478 int _late_inlines_pos; // Where in the queue should the next late inlining candidate go (emulate depth first inlining)
479 uint _number_of_mh_late_inlines; // number of method handle late inlining still pending
480
481 // "MemLimit" directive was specified and the memory limit was hit during compilation
482 bool _oom;
483
484 // Only keep nodes in the expensive node list that need to be optimized
485 void cleanup_expensive_nodes(PhaseIterGVN &igvn);
486 // Use for sorting expensive nodes to bring similar nodes together
487 static int cmp_expensive_nodes(Node** n1, Node** n2);
488 // Expensive nodes list already sorted?
489 bool expensive_nodes_sorted() const;
490 // Remove the speculative part of types and clean up the graph
491 void remove_speculative_types(PhaseIterGVN &igvn);
492
493 void* _replay_inline_data; // Pointer to data loaded from file
494
495 void log_late_inline_failure(CallGenerator* cg, const char* msg);
496 DEBUG_ONLY(bool _exception_backedge;)
497
498 void record_method_not_compilable_oom();
499
500 InlinePrinter _inline_printer;
501
502 public:
503 void* barrier_set_state() const { return _barrier_set_state; }
504
505 InlinePrinter* inline_printer() { return &_inline_printer; }
506
507 #ifndef PRODUCT
508 IdealGraphPrinter* igv_printer() { return _igv_printer; }
509 void reset_igv_phase_iter(CompilerPhaseType cpt) { _igv_phase_iter[cpt] = 0; }
510 #endif
511
512 void log_late_inline(CallGenerator* cg);
513 void log_inline_id(CallGenerator* cg);
514 void log_inline_failure(const char* msg);
515
516 void* replay_inline_data() const { return _replay_inline_data; }
517
518 // Dump inlining replay data to the stream.
519 void dump_inline_data(outputStream* out);
520 void dump_inline_data_reduced(outputStream* out);
521
522 private:
523 // Matching, CFG layout, allocation, code generation
524 PhaseCFG* _cfg; // Results of CFG finding
525 int _java_calls; // Number of java calls in the method
526 int _inner_loops; // Number of inner loops in the method
527 Matcher* _matcher; // Engine to map ideal to machine instructions
528 PhaseRegAlloc* _regalloc; // Results of register allocation.
529 RegMask _FIRST_STACK_mask; // All stack slots usable for spills (depends on frame layout)
530 Arena* _indexSet_arena; // control IndexSet allocation within PhaseChaitin
531 void* _indexSet_free_block_list; // free list of IndexSet bit blocks
532 int _interpreter_frame_size;
533
534 PhaseOutput* _output;
535
536 public:
537 // Accessors
538
539 // The Compile instance currently active in this (compiler) thread.
540 static Compile* current() {
541 return (Compile*) ciEnv::current()->compiler_data();
542 }
543
544 int interpreter_frame_size() const { return _interpreter_frame_size; }
545
546 PhaseOutput* output() const { return _output; }
547 void set_output(PhaseOutput* o) { _output = o; }
548
549 // ID for this compilation. Useful for setting breakpoints in the debugger.
550 int compile_id() const { return _compile_id; }
551 DirectiveSet* directive() const { return _directive; }
552
553 // Does this compilation allow instructions to subsume loads? User
554 // instructions that subsume a load may result in an unschedulable
555 // instruction sequence.
556 bool subsume_loads() const { return _options._subsume_loads; }
557 /** Do escape analysis. */
558 bool do_escape_analysis() const { return _options._do_escape_analysis; }
559 bool do_iterative_escape_analysis() const { return _options._do_iterative_escape_analysis; }
560 bool do_reduce_allocation_merges() const { return _options._do_reduce_allocation_merges; }
561 /** Do boxing elimination. */
562 bool eliminate_boxing() const { return _options._eliminate_boxing; }
563 /** Do aggressive boxing elimination. */
564 bool aggressive_unboxing() const { return _options._eliminate_boxing && AggressiveUnboxing; }
565 bool should_install_code() const { return _options._install_code; }
566 /** Do locks coarsening. */
567 bool do_locks_coarsening() const { return _options._do_locks_coarsening; }
568 bool do_superword() const { return _options._do_superword; }
569
570 // Other fixed compilation parameters.
571 ciMethod* method() const { return _method; }
572 int entry_bci() const { return _entry_bci; }
573 bool is_osr_compilation() const { return _entry_bci != InvocationEntryBci; }
574 bool is_method_compilation() const { return (_method != nullptr && !_method->flags().is_native()); }
575 const TypeFunc* tf() const { assert(_tf!=nullptr, ""); return _tf; }
576 void init_tf(const TypeFunc* tf) { assert(_tf==nullptr, ""); _tf = tf; }
577 InlineTree* ilt() const { return _ilt; }
578 address stub_function() const { return _stub_function; }
579 const char* stub_name() const { return _stub_name; }
580 address stub_entry_point() const { return _stub_entry_point; }
581 void set_stub_entry_point(address z) { _stub_entry_point = z; }
582
583 // Control of this compilation.
584 int fixed_slots() const { assert(_fixed_slots >= 0, ""); return _fixed_slots; }
585 void set_fixed_slots(int n) { _fixed_slots = n; }
586 int major_progress() const { return _major_progress; }
587 void set_inlining_progress(bool z) { _inlining_progress = z; }
588 int inlining_progress() const { return _inlining_progress; }
589 void set_inlining_incrementally(bool z) { _inlining_incrementally = z; }
590 int inlining_incrementally() const { return _inlining_incrementally; }
591 void set_do_cleanup(bool z) { _do_cleanup = z; }
592 int do_cleanup() const { return _do_cleanup; }
593 void set_major_progress() { _major_progress++; }
594 void restore_major_progress(int progress) { _major_progress += progress; }
595 void clear_major_progress() { _major_progress = 0; }
596 int max_inline_size() const { return _max_inline_size; }
597 void set_freq_inline_size(int n) { _freq_inline_size = n; }
598 int freq_inline_size() const { return _freq_inline_size; }
599 void set_max_inline_size(int n) { _max_inline_size = n; }
600 bool has_loops() const { return _has_loops; }
601 void set_has_loops(bool z) { _has_loops = z; }
602 bool has_split_ifs() const { return _has_split_ifs; }
603 void set_has_split_ifs(bool z) { _has_split_ifs = z; }
604 bool has_unsafe_access() const { return _has_unsafe_access; }
605 void set_has_unsafe_access(bool z) { _has_unsafe_access = z; }
606 bool has_stringbuilder() const { return _has_stringbuilder; }
607 void set_has_stringbuilder(bool z) { _has_stringbuilder = z; }
608 bool has_boxed_value() const { return _has_boxed_value; }
609 void set_has_boxed_value(bool z) { _has_boxed_value = z; }
610 bool has_reserved_stack_access() const { return _has_reserved_stack_access; }
611 void set_has_reserved_stack_access(bool z) { _has_reserved_stack_access = z; }
612 bool has_circular_inline_type() const { return _has_circular_inline_type; }
613 void set_has_circular_inline_type(bool z) { _has_circular_inline_type = z; }
614 uint max_vector_size() const { return _max_vector_size; }
615 void set_max_vector_size(uint s) { _max_vector_size = s; }
616 bool clear_upper_avx() const { return _clear_upper_avx; }
617 void set_clear_upper_avx(bool s) { _clear_upper_avx = s; }
618 void set_trap_count(uint r, uint c) { assert(r < trapHistLength, "oob"); _trap_hist[r] = c; }
619 uint trap_count(uint r) const { assert(r < trapHistLength, "oob"); return _trap_hist[r]; }
620 bool trap_can_recompile() const { return _trap_can_recompile; }
621 void set_trap_can_recompile(bool z) { _trap_can_recompile = z; }
622 uint decompile_count() const { return _decompile_count; }
623 void set_decompile_count(uint c) { _decompile_count = c; }
624 bool allow_range_check_smearing() const;
625 bool do_inlining() const { return _do_inlining; }
626 void set_do_inlining(bool z) { _do_inlining = z; }
627 bool do_scheduling() const { return _do_scheduling; }
628 void set_do_scheduling(bool z) { _do_scheduling = z; }
629 bool do_freq_based_layout() const{ return _do_freq_based_layout; }
630 void set_do_freq_based_layout(bool z){ _do_freq_based_layout = z; }
631 bool do_vector_loop() const { return _do_vector_loop; }
632 void set_do_vector_loop(bool z) { _do_vector_loop = z; }
633 bool use_cmove() const { return _use_cmove; }
634 void set_use_cmove(bool z) { _use_cmove = z; }
635 bool do_aliasing() const { return _do_aliasing; }
636 bool print_assembly() const { return _print_assembly; }
637 void set_print_assembly(bool z) { _print_assembly = z; }
638 bool print_inlining() const { return _print_inlining; }
639 void set_print_inlining(bool z) { _print_inlining = z; }
640 bool print_intrinsics() const { return _print_intrinsics; }
641 void set_print_intrinsics(bool z) { _print_intrinsics = z; }
642 uint max_node_limit() const { return (uint)_max_node_limit; }
643 void set_max_node_limit(uint n) { _max_node_limit = n; }
644 bool clinit_barrier_on_entry() { return _clinit_barrier_on_entry; }
645 void set_clinit_barrier_on_entry(bool z) { _clinit_barrier_on_entry = z; }
646 void set_flat_accesses() { _has_flat_accesses = true; }
647 bool flat_accesses_share_alias() const { return _flat_accesses_share_alias; }
648 void set_flat_accesses_share_alias(bool z) { _flat_accesses_share_alias = z; }
649 bool scalarize_in_safepoints() const { return _scalarize_in_safepoints; }
650 void set_scalarize_in_safepoints(bool z) { _scalarize_in_safepoints = z; }
651
652 // Support for scalarized inline type calling convention
653 bool has_scalarized_args() const { return _method != nullptr && _method->has_scalarized_args(); }
654 bool needs_stack_repair() const { return _method != nullptr && _method->get_Method()->c2_needs_stack_repair(); }
655
656 bool has_monitors() const { return _has_monitors; }
657 void set_has_monitors(bool v) { _has_monitors = v; }
658 bool has_scoped_access() const { return _has_scoped_access; }
659 void set_has_scoped_access(bool v) { _has_scoped_access = v; }
660
661 // check the CompilerOracle for special behaviours for this compile
662 bool method_has_option(CompileCommandEnum option) {
663 return method() != nullptr && method()->has_option(option);
664 }
665
666 #ifndef PRODUCT
667 uint next_igv_idx() { return _igv_idx++; }
668 bool trace_opto_output() const { return _trace_opto_output; }
669 void print_ideal_ir(const char* phase_name);
670 bool should_print_ideal() const { return _directive->PrintIdealOption; }
671 bool parsed_irreducible_loop() const { return _parsed_irreducible_loop; }
672 void set_parsed_irreducible_loop(bool z) { _parsed_irreducible_loop = z; }
673 int _in_dump_cnt; // Required for dumping ir nodes.
674 #endif
675 bool has_irreducible_loop() const { return _has_irreducible_loop; }
676 void set_has_irreducible_loop(bool z) { _has_irreducible_loop = z; }
677
678 // JSR 292
679 bool has_method_handle_invokes() const { return _has_method_handle_invokes; }
680 void set_has_method_handle_invokes(bool z) { _has_method_handle_invokes = z; }
681
682 Ticks _latest_stage_start_counter;
683
684 void begin_method();
685 void end_method();
686 bool should_print_igv(int level);
687 bool should_print_phase(CompilerPhaseType cpt);
688
689 void print_method(CompilerPhaseType cpt, int level, Node* n = nullptr);
690
691 #ifndef PRODUCT
692 void init_igv();
693 void dump_igv(const char* graph_name, int level = 3) {
694 if (should_print_igv(level)) {
695 _igv_printer->print_graph(graph_name);
696 }
697 }
698
699 void igv_print_method_to_file(const char* phase_name = "Debug", bool append = false);
700 void igv_print_method_to_network(const char* phase_name = "Debug");
701 void igv_print_graph_to_network(const char* name, GrowableArray<const Node*>& visible_nodes);
702 static IdealGraphPrinter* debug_file_printer() { return _debug_file_printer; }
703 static IdealGraphPrinter* debug_network_printer() { return _debug_network_printer; }
704 #endif
705
706 const GrowableArray<ParsePredicateNode*>& parse_predicates() const {
707 return _parse_predicates;
708 }
709
710 const GrowableArray<OpaqueTemplateAssertionPredicateNode*>& template_assertion_predicate_opaques() const {
711 return _template_assertion_predicate_opaques;
712 }
713
714 int macro_count() const { return _macro_nodes.length(); }
715 int parse_predicate_count() const { return _parse_predicates.length(); }
716 int template_assertion_predicate_count() const { return _template_assertion_predicate_opaques.length(); }
717 int expensive_count() const { return _expensive_nodes.length(); }
718 int coarsened_count() const { return _coarsened_locks.length(); }
719
720 Node* macro_node(int idx) const { return _macro_nodes.at(idx); }
721
722 Node* expensive_node(int idx) const { return _expensive_nodes.at(idx); }
723
724 ConnectionGraph* congraph() { return _congraph;}
725 void set_congraph(ConnectionGraph* congraph) { _congraph = congraph;}
726 void add_macro_node(Node * n) {
727 //assert(n->is_macro(), "must be a macro node");
728 assert(!_macro_nodes.contains(n), "duplicate entry in expand list");
729 _macro_nodes.append(n);
730 }
731 void remove_macro_node(Node* n) {
732 // this function may be called twice for a node so we can only remove it
733 // if it's still existing.
734 _macro_nodes.remove_if_existing(n);
735 // Remove from coarsened locks list if present
736 if (coarsened_count() > 0) {
737 remove_coarsened_lock(n);
738 }
739 }
740 void add_expensive_node(Node* n);
741 void remove_expensive_node(Node* n) {
742 _expensive_nodes.remove_if_existing(n);
743 }
744
745 void add_parse_predicate(ParsePredicateNode* n) {
746 assert(!_parse_predicates.contains(n), "duplicate entry in Parse Predicate list");
747 _parse_predicates.append(n);
748 }
749
750 void remove_parse_predicate(ParsePredicateNode* n) {
751 if (parse_predicate_count() > 0) {
752 _parse_predicates.remove_if_existing(n);
753 }
754 }
755
756 void add_template_assertion_predicate_opaque(OpaqueTemplateAssertionPredicateNode* n) {
757 assert(!_template_assertion_predicate_opaques.contains(n),
758 "Duplicate entry in Template Assertion Predicate OpaqueTemplateAssertionPredicate list");
759 _template_assertion_predicate_opaques.append(n);
760 }
761
762 void remove_template_assertion_predicate_opaque(OpaqueTemplateAssertionPredicateNode* n) {
763 if (template_assertion_predicate_count() > 0) {
764 _template_assertion_predicate_opaques.remove_if_existing(n);
765 }
766 }
767 void add_coarsened_locks(GrowableArray<AbstractLockNode*>& locks);
768 void remove_coarsened_lock(Node* n);
769 bool coarsened_locks_consistent();
770 void mark_unbalanced_boxes() const;
771
772 bool post_loop_opts_phase() { return _post_loop_opts_phase; }
773 void set_post_loop_opts_phase() { _post_loop_opts_phase = true; }
774 void reset_post_loop_opts_phase() { _post_loop_opts_phase = false; }
775
776 #ifdef ASSERT
777 bool phase_verify_ideal_loop() const { return _phase_verify_ideal_loop; }
778 void set_phase_verify_ideal_loop() { _phase_verify_ideal_loop = true; }
779 void reset_phase_verify_ideal_loop() { _phase_verify_ideal_loop = false; }
780 #endif
781
782 bool allow_macro_nodes() { return _allow_macro_nodes; }
783 void reset_allow_macro_nodes() { _allow_macro_nodes = false; }
784
785 void record_for_post_loop_opts_igvn(Node* n);
786 void remove_from_post_loop_opts_igvn(Node* n);
787 void process_for_post_loop_opts_igvn(PhaseIterGVN& igvn);
788
789 // Keep track of inline type nodes for later processing
790 void add_inline_type(Node* n);
791 void remove_inline_type(Node* n);
792 void process_inline_types(PhaseIterGVN &igvn, bool remove = false);
793
794 void adjust_flat_array_access_aliases(PhaseIterGVN& igvn);
795
796 void record_unstable_if_trap(UnstableIfTrap* trap);
797 bool remove_unstable_if_trap(CallStaticJavaNode* unc, bool yield);
798 void remove_useless_unstable_if_traps(Unique_Node_List &useful);
799 void process_for_unstable_if_traps(PhaseIterGVN& igvn);
800
801 bool merge_stores_phase() { return _merge_stores_phase; }
802 void set_merge_stores_phase() { _merge_stores_phase = true; }
803 void record_for_merge_stores_igvn(Node* n);
804 void remove_from_merge_stores_igvn(Node* n);
805 void process_for_merge_stores_igvn(PhaseIterGVN& igvn);
806
807 void shuffle_macro_nodes();
808 void sort_macro_nodes();
809
810 void mark_parse_predicate_nodes_useless(PhaseIterGVN& igvn);
811
812 // Are there candidate expensive nodes for optimization?
813 bool should_optimize_expensive_nodes(PhaseIterGVN &igvn);
814 // Check whether n1 and n2 are similar
815 static int cmp_expensive_nodes(Node* n1, Node* n2);
816 // Sort expensive nodes to locate similar expensive nodes
817 void sort_expensive_nodes();
818
819 // Compilation environment.
820 Arena* comp_arena() { return &_comp_arena; }
821 ciEnv* env() const { return _env; }
822 CompileLog* log() const { return _log; }
823
824 bool failing_internal() const {
825 return _env->failing() ||
826 _failure_reason.get() != nullptr;
827 }
828
829 const char* failure_reason() const {
830 return _env->failing() ? _env->failure_reason()
831 : _failure_reason.get();
832 }
833
834 const CompilationFailureInfo* first_failure_details() const { return _first_failure_details; }
835
836 bool failing() {
837 if (failing_internal()) {
838 return true;
839 }
840 #ifdef ASSERT
841 // Disable stress code for PhaseIdealLoop verification (would have cascading effects).
842 if (phase_verify_ideal_loop()) {
843 return false;
844 }
845 if (StressBailout) {
846 return fail_randomly();
847 }
848 #endif
849 return false;
850 }
851
852 #ifdef ASSERT
853 bool fail_randomly();
854 bool failure_is_artificial();
855 #endif
856
857 bool failure_reason_is(const char* r) const {
858 return (r == _failure_reason.get()) ||
859 (r != nullptr &&
860 _failure_reason.get() != nullptr &&
861 strcmp(r, _failure_reason.get()) == 0);
862 }
863
864 void record_failure(const char* reason DEBUG_ONLY(COMMA bool allow_multiple_failures = false));
865 void record_method_not_compilable(const char* reason DEBUG_ONLY(COMMA bool allow_multiple_failures = false)) {
866 env()->record_method_not_compilable(reason);
867 // Record failure reason.
868 record_failure(reason DEBUG_ONLY(COMMA allow_multiple_failures));
869 }
870 bool check_node_count(uint margin, const char* reason) {
871 if (oom()) {
872 record_method_not_compilable_oom();
873 return true;
874 }
875 if (live_nodes() + margin > max_node_limit()) {
876 record_method_not_compilable(reason);
877 return true;
878 } else {
879 return false;
880 }
881 }
882 bool oom() const { return _oom; }
883 void set_oom() { _oom = true; }
884
885 // Node management
886 uint unique() const { return _unique; }
887 uint next_unique() { return _unique++; }
888 void set_unique(uint i) { _unique = i; }
889 Arena* node_arena() { return _node_arena; }
890 Arena* old_arena() { return (&_node_arena_one == _node_arena) ? &_node_arena_two : &_node_arena_one; }
891 RootNode* root() const { return _root; }
892 void set_root(RootNode* r) { _root = r; }
893 StartNode* start() const; // (Derived from root.)
894 void verify_start(StartNode* s) const NOT_DEBUG_RETURN;
895 Node* immutable_memory();
896
897 Node* recent_alloc_ctl() const { return _recent_alloc_ctl; }
898 Node* recent_alloc_obj() const { return _recent_alloc_obj; }
899 void set_recent_alloc(Node* ctl, Node* obj) {
900 _recent_alloc_ctl = ctl;
901 _recent_alloc_obj = obj;
902 }
903 void record_dead_node(uint idx) { if (_dead_node_list.test_set(idx)) return;
904 _dead_node_count++;
905 }
906 void reset_dead_node_list() { _dead_node_list.reset();
907 _dead_node_count = 0;
908 }
909 uint live_nodes() const {
910 int val = _unique - _dead_node_count;
911 assert (val >= 0, "number of tracked dead nodes %d more than created nodes %d", _unique, _dead_node_count);
912 return (uint) val;
913 }
914 #ifdef ASSERT
915 void set_phase_optimize_finished() { _phase_optimize_finished = true; }
916 bool phase_optimize_finished() const { return _phase_optimize_finished; }
917 uint count_live_nodes_by_graph_walk();
918 void print_missing_nodes();
919 #endif
920
921 // Record modified nodes to check that they are put on IGVN worklist
922 void record_modified_node(Node* n) NOT_DEBUG_RETURN;
923 void remove_modified_node(Node* n) NOT_DEBUG_RETURN;
924 DEBUG_ONLY( Unique_Node_List* modified_nodes() const { return _modified_nodes; } )
925
926 MachConstantBaseNode* mach_constant_base_node();
927 bool has_mach_constant_base_node() const { return _mach_constant_base_node != nullptr; }
928 // Generated by adlc, true if CallNode requires MachConstantBase.
929 bool needs_deep_clone_jvms();
930
931 // Handy undefined Node
932 Node* top() const { return _top; }
933
934 // these are used by guys who need to know about creation and transformation of top:
935 Node* cached_top_node() { return _top; }
936 void set_cached_top_node(Node* tn);
937
938 GrowableArray<Node_Notes*>* node_note_array() const { return _node_note_array; }
939 void set_node_note_array(GrowableArray<Node_Notes*>* arr) { _node_note_array = arr; }
940 Node_Notes* default_node_notes() const { return _default_node_notes; }
941 void set_default_node_notes(Node_Notes* n) { _default_node_notes = n; }
942
943 Node_Notes* node_notes_at(int idx);
944
945 inline bool set_node_notes_at(int idx, Node_Notes* value);
946 // Copy notes from source to dest, if they exist.
947 // Overwrite dest only if source provides something.
948 // Return true if information was moved.
949 bool copy_node_notes_to(Node* dest, Node* source);
950
951 // Workhorse function to sort out the blocked Node_Notes array:
952 inline Node_Notes* locate_node_notes(GrowableArray<Node_Notes*>* arr,
953 int idx, bool can_grow = false);
954
955 void grow_node_notes(GrowableArray<Node_Notes*>* arr, int grow_by);
956
957 // Type management
958 Arena* type_arena() { return _type_arena; }
959 Dict* type_dict() { return _type_dict; }
960 size_t type_last_size() { return _type_last_size; }
961 int num_alias_types() { return _num_alias_types; }
962
963 void init_type_arena() { _type_arena = &_Compile_types; }
964 void set_type_arena(Arena* a) { _type_arena = a; }
965 void set_type_dict(Dict* d) { _type_dict = d; }
966 void set_type_last_size(size_t sz) { _type_last_size = sz; }
967
968 const TypeFunc* last_tf(ciMethod* m) {
969 return (m == _last_tf_m) ? _last_tf : nullptr;
970 }
971 void set_last_tf(ciMethod* m, const TypeFunc* tf) {
972 assert(m != nullptr || tf == nullptr, "");
973 _last_tf_m = m;
974 _last_tf = tf;
975 }
976
977 AliasType* alias_type(int idx) { assert(idx < num_alias_types(), "oob"); return _alias_types[idx]; }
978 AliasType* alias_type(const TypePtr* adr_type, ciField* field = nullptr, bool uncached = false) { return find_alias_type(adr_type, false, field, uncached); }
979 bool have_alias_type(const TypePtr* adr_type);
980 AliasType* alias_type(ciField* field);
981
982 int get_alias_index(const TypePtr* at, bool uncached = false) { return alias_type(at, nullptr, uncached)->index(); }
983 const TypePtr* get_adr_type(uint aidx) { return alias_type(aidx)->adr_type(); }
984 int get_general_index(uint aidx) { return alias_type(aidx)->general_index(); }
985
986 // Building nodes
987 void rethrow_exceptions(JVMState* jvms);
988 void return_values(JVMState* jvms);
989 JVMState* build_start_state(StartNode* start, const TypeFunc* tf);
990
991 // Decide how to build a call.
992 // The profile factor is a discount to apply to this site's interp. profile.
993 CallGenerator* call_generator(ciMethod* call_method, int vtable_index, bool call_does_dispatch,
994 JVMState* jvms, bool allow_inline, float profile_factor, ciKlass* speculative_receiver_type = nullptr,
995 bool allow_intrinsics = true);
996 bool should_delay_inlining(ciMethod* call_method, JVMState* jvms) {
997 return should_delay_string_inlining(call_method, jvms) ||
998 should_delay_boxing_inlining(call_method, jvms) ||
999 should_delay_vector_inlining(call_method, jvms);
1000 }
1001 bool should_delay_string_inlining(ciMethod* call_method, JVMState* jvms);
1002 bool should_delay_boxing_inlining(ciMethod* call_method, JVMState* jvms);
1003 bool should_delay_vector_inlining(ciMethod* call_method, JVMState* jvms);
1004 bool should_delay_vector_reboxing_inlining(ciMethod* call_method, JVMState* jvms);
1005
1006 // Helper functions to identify inlining potential at call-site
1007 ciMethod* optimize_virtual_call(ciMethod* caller, ciInstanceKlass* klass,
1008 ciKlass* holder, ciMethod* callee,
1009 const TypeOopPtr* receiver_type, bool is_virtual,
1010 bool &call_does_dispatch, int &vtable_index,
1011 bool check_access = true);
1012 ciMethod* optimize_inlining(ciMethod* caller, ciInstanceKlass* klass, ciKlass* holder,
1013 ciMethod* callee, const TypeOopPtr* receiver_type,
1014 bool check_access = true);
1015
1016 // Report if there were too many traps at a current method and bci.
1017 // Report if a trap was recorded, and/or PerMethodTrapLimit was exceeded.
1018 // If there is no MDO at all, report no trap unless told to assume it.
1019 bool too_many_traps(ciMethod* method, int bci, Deoptimization::DeoptReason reason);
1020 // This version, unspecific to a particular bci, asks if
1021 // PerMethodTrapLimit was exceeded for all inlined methods seen so far.
1022 bool too_many_traps(Deoptimization::DeoptReason reason,
1023 // Privately used parameter for logging:
1024 ciMethodData* logmd = nullptr);
1025 // Report if there were too many recompiles at a method and bci.
1026 bool too_many_recompiles(ciMethod* method, int bci, Deoptimization::DeoptReason reason);
1027 // Report if there were too many traps or recompiles at a method and bci.
1028 bool too_many_traps_or_recompiles(ciMethod* method, int bci, Deoptimization::DeoptReason reason) {
1029 return too_many_traps(method, bci, reason) ||
1030 too_many_recompiles(method, bci, reason);
1031 }
1032 // Return a bitset with the reasons where deoptimization is allowed,
1033 // i.e., where there were not too many uncommon traps.
1034 int _allowed_reasons;
1035 int allowed_deopt_reasons() { return _allowed_reasons; }
1036 void set_allowed_deopt_reasons();
1037
1038 // Parsing, optimization
1039 PhaseGVN* initial_gvn() { return _initial_gvn; }
1040 Unique_Node_List* igvn_worklist() {
1041 assert(_igvn_worklist != nullptr, "must be created in Compile::Compile");
1042 return _igvn_worklist;
1043 }
1044 Type_Array* types() {
1045 assert(_types != nullptr, "must be created in Compile::Compile");
1046 return _types;
1047 }
1048 NodeHash* node_hash() {
1049 assert(_node_hash != nullptr, "must be created in Compile::Compile");
1050 return _node_hash;
1051 }
1052 inline void record_for_igvn(Node* n); // Body is after class Unique_Node_List in node.hpp.
1053 inline void remove_for_igvn(Node* n); // Body is after class Unique_Node_List in node.hpp.
1054 void set_initial_gvn(PhaseGVN *gvn) { _initial_gvn = gvn; }
1055
1056 // Replace n by nn using initial_gvn, calling hash_delete and
1057 // record_for_igvn as needed.
1058 void gvn_replace_by(Node* n, Node* nn);
1059
1060
1061 void identify_useful_nodes(Unique_Node_List &useful);
1062 void update_dead_node_list(Unique_Node_List &useful);
1063 void disconnect_useless_nodes(Unique_Node_List& useful, Unique_Node_List& worklist, const Unique_Node_List* root_and_safepoints = nullptr);
1064
1065 void remove_useless_node(Node* dead);
1066
1067 // Record this CallGenerator for inlining at the end of parsing.
1068 void add_late_inline(CallGenerator* cg) {
1069 _late_inlines.insert_before(_late_inlines_pos, cg);
1070 _late_inlines_pos++;
1071 }
1072
1073 void prepend_late_inline(CallGenerator* cg) {
1074 _late_inlines.insert_before(0, cg);
1075 }
1076
1077 void add_string_late_inline(CallGenerator* cg) {
1078 _string_late_inlines.push(cg);
1079 }
1080
1081 void add_boxing_late_inline(CallGenerator* cg) {
1082 _boxing_late_inlines.push(cg);
1083 }
1084
1085 void add_vector_reboxing_late_inline(CallGenerator* cg) {
1086 _vector_reboxing_late_inlines.push(cg);
1087 }
1088
1089 template<typename N, ENABLE_IF(std::is_base_of<Node, N>::value)>
1090 void remove_useless_nodes(GrowableArray<N*>& node_list, Unique_Node_List& useful);
1091
1092 void remove_useless_late_inlines(GrowableArray<CallGenerator*>* inlines, Unique_Node_List &useful);
1093 void remove_useless_late_inlines(GrowableArray<CallGenerator*>* inlines, Node* dead);
1094
1095 void remove_useless_coarsened_locks(Unique_Node_List& useful);
1096
1097 void dump_print_inlining();
1098
1099 bool over_inlining_cutoff() const {
1100 if (!inlining_incrementally()) {
1101 return unique() > (uint)NodeCountInliningCutoff;
1102 } else {
1103 // Give some room for incremental inlining algorithm to "breathe"
1104 // and avoid thrashing when live node count is close to the limit.
1105 // Keep in mind that live_nodes() isn't accurate during inlining until
1106 // dead node elimination step happens (see Compile::inline_incrementally).
1107 return live_nodes() > (uint)LiveNodeCountInliningCutoff * 11 / 10;
1108 }
1109 }
1110
1111 void inc_number_of_mh_late_inlines() { _number_of_mh_late_inlines++; }
1112 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--; }
1113 bool has_mh_late_inlines() const { return _number_of_mh_late_inlines > 0; }
1114
1115 bool inline_incrementally_one();
1116 void inline_incrementally_cleanup(PhaseIterGVN& igvn);
1117 void inline_incrementally(PhaseIterGVN& igvn);
1118 bool should_delay_inlining() { return AlwaysIncrementalInline || (StressIncrementalInlining && (random() % 2) == 0); }
1119 void inline_string_calls(bool parse_time);
1120 void inline_boxing_calls(PhaseIterGVN& igvn);
1121 bool optimize_loops(PhaseIterGVN& igvn, LoopOptsMode mode);
1122 void remove_root_to_sfpts_edges(PhaseIterGVN& igvn);
1123
1124 void inline_vector_reboxing_calls();
1125 bool has_vbox_nodes();
1126
1127 void process_late_inline_calls_no_inline(PhaseIterGVN& igvn);
1128
1129 // Matching, CFG layout, allocation, code generation
1130 PhaseCFG* cfg() { return _cfg; }
1131 bool has_java_calls() const { return _java_calls > 0; }
1132 int java_calls() const { return _java_calls; }
1133 int inner_loops() const { return _inner_loops; }
1134 Matcher* matcher() { return _matcher; }
1135 PhaseRegAlloc* regalloc() { return _regalloc; }
1136 RegMask& FIRST_STACK_mask() { return _FIRST_STACK_mask; }
1137 Arena* indexSet_arena() { return _indexSet_arena; }
1138 void* indexSet_free_block_list() { return _indexSet_free_block_list; }
1139 DebugInformationRecorder* debug_info() { return env()->debug_info(); }
1140
1141 void update_interpreter_frame_size(int size) {
1142 if (_interpreter_frame_size < size) {
1143 _interpreter_frame_size = size;
1144 }
1145 }
1146
1147 void set_matcher(Matcher* m) { _matcher = m; }
1148 //void set_regalloc(PhaseRegAlloc* ra) { _regalloc = ra; }
1149 void set_indexSet_arena(Arena* a) { _indexSet_arena = a; }
1150 void set_indexSet_free_block_list(void* p) { _indexSet_free_block_list = p; }
1151
1152 void set_java_calls(int z) { _java_calls = z; }
1153 void set_inner_loops(int z) { _inner_loops = z; }
1154
1155 Dependencies* dependencies() { return env()->dependencies(); }
1156
1157 // Major entry point. Given a Scope, compile the associated method.
1158 // For normal compilations, entry_bci is InvocationEntryBci. For on stack
1159 // replacement, entry_bci indicates the bytecode for which to compile a
1160 // continuation.
1161 Compile(ciEnv* ci_env, ciMethod* target,
1162 int entry_bci, Options options, DirectiveSet* directive);
1163
1164 // Second major entry point. From the TypeFunc signature, generate code
1165 // to pass arguments from the Java calling convention to the C calling
1166 // convention.
1167 Compile(ciEnv* ci_env, const TypeFunc *(*gen)(),
1168 address stub_function, const char *stub_name,
1169 int is_fancy_jump, bool pass_tls,
1170 bool return_pc, DirectiveSet* directive);
1171
1172 ~Compile();
1173
1174 // Are we compiling a method?
1175 bool has_method() { return method() != nullptr; }
1176
1177 // Maybe print some information about this compile.
1178 void print_compile_messages();
1179
1180 // Final graph reshaping, a post-pass after the regular optimizer is done.
1181 bool final_graph_reshaping();
1182
1183 // returns true if adr is completely contained in the given alias category
1184 bool must_alias(const TypePtr* adr, int alias_idx);
1185
1186 // returns true if adr overlaps with the given alias category
1187 bool can_alias(const TypePtr* adr, int alias_idx);
1188
1189 // Stack slots that may be unused by the calling convention but must
1190 // otherwise be preserved. On Intel this includes the return address.
1191 // On PowerPC it includes the 4 words holding the old TOC & LR glue.
1192 uint in_preserve_stack_slots() {
1193 return SharedRuntime::in_preserve_stack_slots();
1194 }
1195
1196 // "Top of Stack" slots that may be unused by the calling convention but must
1197 // otherwise be preserved.
1198 // On Intel these are not necessary and the value can be zero.
1199 static uint out_preserve_stack_slots() {
1200 return SharedRuntime::out_preserve_stack_slots();
1201 }
1202
1203 // Number of outgoing stack slots killed above the out_preserve_stack_slots
1204 // for calls to C. Supports the var-args backing area for register parms.
1205 uint varargs_C_out_slots_killed() const;
1206
1207 // Number of Stack Slots consumed by a synchronization entry
1208 int sync_stack_slots() const;
1209
1210 // Compute the name of old_SP. See <arch>.ad for frame layout.
1211 OptoReg::Name compute_old_SP();
1212
1213 private:
1214 // Phase control:
1215 void Init(bool aliasing); // Prepare for a single compilation
1216 void Optimize(); // Given a graph, optimize it
1217 void Code_Gen(); // Generate code from a graph
1218
1219 // Management of the AliasType table.
1220 void grow_alias_types();
1221 AliasCacheEntry* probe_alias_cache(const TypePtr* adr_type);
1222 const TypePtr *flatten_alias_type(const TypePtr* adr_type) const;
1223 AliasType* find_alias_type(const TypePtr* adr_type, bool no_create, ciField* field, bool uncached = false);
1224
1225 void verify_top(Node*) const PRODUCT_RETURN;
1226
1227 // Intrinsic setup.
1228 CallGenerator* make_vm_intrinsic(ciMethod* m, bool is_virtual); // constructor
1229 int intrinsic_insertion_index(ciMethod* m, bool is_virtual, bool& found); // helper
1230 CallGenerator* find_intrinsic(ciMethod* m, bool is_virtual); // query fn
1231 void register_intrinsic(CallGenerator* cg); // update fn
1232
1233 #ifndef PRODUCT
1234 static juint _intrinsic_hist_count[];
1235 static jubyte _intrinsic_hist_flags[];
1236 #endif
1237 // Function calls made by the public function final_graph_reshaping.
1238 // No need to be made public as they are not called elsewhere.
1239 void final_graph_reshaping_impl(Node *n, Final_Reshape_Counts& frc, Unique_Node_List& dead_nodes);
1240 void final_graph_reshaping_main_switch(Node* n, Final_Reshape_Counts& frc, uint nop, Unique_Node_List& dead_nodes);
1241 void final_graph_reshaping_walk(Node_Stack& nstack, Node* root, Final_Reshape_Counts& frc, Unique_Node_List& dead_nodes);
1242 void handle_div_mod_op(Node* n, BasicType bt, bool is_unsigned);
1243
1244 // Logic cone optimization.
1245 void optimize_logic_cones(PhaseIterGVN &igvn);
1246 void collect_logic_cone_roots(Unique_Node_List& list);
1247 void process_logic_cone_root(PhaseIterGVN &igvn, Node* n, VectorSet& visited);
1248 bool compute_logic_cone(Node* n, Unique_Node_List& partition, Unique_Node_List& inputs);
1249 uint compute_truth_table(Unique_Node_List& partition, Unique_Node_List& inputs);
1250 uint eval_macro_logic_op(uint func, uint op1, uint op2, uint op3);
1251 Node* xform_to_MacroLogicV(PhaseIterGVN &igvn, const TypeVect* vt, Unique_Node_List& partitions, Unique_Node_List& inputs);
1252 void check_no_dead_use() const NOT_DEBUG_RETURN;
1253
1254 public:
1255
1256 // Note: Histogram array size is about 1 Kb.
1257 enum { // flag bits:
1258 _intrinsic_worked = 1, // succeeded at least once
1259 _intrinsic_failed = 2, // tried it but it failed
1260 _intrinsic_disabled = 4, // was requested but disabled (e.g., -XX:-InlineUnsafeOps)
1261 _intrinsic_virtual = 8, // was seen in the virtual form (rare)
1262 _intrinsic_both = 16 // was seen in the non-virtual form (usual)
1263 };
1264 // Update histogram. Return boolean if this is a first-time occurrence.
1265 static bool gather_intrinsic_statistics(vmIntrinsics::ID id,
1266 bool is_virtual, int flags) PRODUCT_RETURN0;
1267 static void print_intrinsic_statistics() PRODUCT_RETURN;
1268
1269 // Graph verification code
1270 // Walk the node list, verifying that there is a one-to-one correspondence
1271 // between Use-Def edges and Def-Use edges. The option no_dead_code enables
1272 // stronger checks that the graph is strongly connected from starting points
1273 // in both directions.
1274 // root_and_safepoints is used to give the starting points for the traversal.
1275 // If not supplied, only root is used. When this check is called after CCP,
1276 // we need to start traversal from Root and safepoints, just like CCP does its
1277 // own traversal (see PhaseCCP::transform for reasons).
1278 //
1279 // To call this function, there are 2 ways to go:
1280 // - give root_and_safepoints to start traversal everywhere needed (like after CCP)
1281 // - if the whole graph is assumed to be reachable from Root's input,
1282 // root_and_safepoints is not needed (like in PhaseRemoveUseless).
1283 //
1284 // Failure to specify root_and_safepoints in case the graph is not fully
1285 // reachable from Root's input make this check unsound (can miss inconsistencies)
1286 // and even incomplete (can make up non-existing problems) if no_dead_code is
1287 // true.
1288 void verify_graph_edges(bool no_dead_code = false, const Unique_Node_List* root_and_safepoints = nullptr) const PRODUCT_RETURN;
1289
1290 // Verify bi-directional correspondence of edges
1291 void verify_bidirectional_edges(Unique_Node_List& visited, const Unique_Node_List* root_and_safepoints = nullptr) const;
1292
1293 // End-of-run dumps.
1294 static void print_statistics() PRODUCT_RETURN;
1295
1296 // Verify ADLC assumptions during startup
1297 static void adlc_verification() PRODUCT_RETURN;
1298
1299 // Definitions of pd methods
1300 static void pd_compiler2_init();
1301
1302 // Static parse-time type checking logic for gen_subtype_check:
1303 enum SubTypeCheckResult { SSC_always_false, SSC_always_true, SSC_easy_test, SSC_full_test };
1304 SubTypeCheckResult static_subtype_check(const TypeKlassPtr* superk, const TypeKlassPtr* subk, bool skip = StressReflectiveCode);
1305
1306 static Node* conv_I2X_index(PhaseGVN* phase, Node* offset, const TypeInt* sizetype,
1307 // Optional control dependency (for example, on range check)
1308 Node* ctrl = nullptr);
1309
1310 // Convert integer value to a narrowed long type dependent on ctrl (for example, a range check)
1311 static Node* constrained_convI2L(PhaseGVN* phase, Node* value, const TypeInt* itype, Node* ctrl, bool carry_dependency = false);
1312
1313 Node* optimize_acmp(PhaseGVN* phase, Node* a, Node* b);
1314
1315 // Auxiliary method for randomized fuzzing/stressing
1316 int random();
1317 bool randomized_select(int count);
1318
1319 // seed random number generation and log the seed for repeatability.
1320 void initialize_stress_seed(const DirectiveSet* directive);
1321
1322 // supporting clone_map
1323 CloneMap& clone_map();
1324 void set_clone_map(Dict* d);
1325
1326 bool needs_clinit_barrier(ciField* ik, ciMethod* accessing_method);
1327 bool needs_clinit_barrier(ciMethod* ik, ciMethod* accessing_method);
1328 bool needs_clinit_barrier(ciInstanceKlass* ik, ciMethod* accessing_method);
1329
1330 #ifdef ASSERT
1331 VerifyMeetResult* _type_verify;
1332 void set_exception_backedge() { _exception_backedge = true; }
1333 bool has_exception_backedge() const { return _exception_backedge; }
1334 #endif
1335
1336 static bool push_thru_add(PhaseGVN* phase, Node* z, const TypeInteger* tz, const TypeInteger*& rx, const TypeInteger*& ry,
1337 BasicType out_bt, BasicType in_bt);
1338
1339 static Node* narrow_value(BasicType bt, Node* value, const Type* type, PhaseGVN* phase, bool transform_res);
1340 };
1341
1342 #endif // SHARE_OPTO_COMPILE_HPP