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