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