1 /*
2 * Copyright (c) 1997, 2025, Oracle and/or its affiliates. All rights reserved.
3 * Copyright (c) 2024, 2025, Alibaba Group Holding Limited. All rights reserved.
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 *
6 * This code is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 only, as
8 * published by the Free Software Foundation.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * questions.
23 *
24 */
25
26 #ifndef SHARE_OPTO_NODE_HPP
27 #define SHARE_OPTO_NODE_HPP
28
29 #include "libadt/vectset.hpp"
30 #include "opto/compile.hpp"
31 #include "opto/type.hpp"
32 #include "utilities/copy.hpp"
33
34 // Portions of code courtesy of Clifford Click
35
36 // Optimization - Graph Style
37
38
39 class AbstractLockNode;
40 class AddNode;
41 class AddPNode;
42 class AliasInfo;
43 class AllocateArrayNode;
44 class AllocateNode;
45 class ArrayCopyNode;
46 class BaseCountedLoopNode;
47 class BaseCountedLoopEndNode;
48 class BlackholeNode;
49 class Block;
50 class BoolNode;
51 class BoxLockNode;
52 class CMoveNode;
53 class CallDynamicJavaNode;
54 class CallJavaNode;
55 class CallLeafNode;
56 class CallLeafNoFPNode;
57 class CallNode;
58 class CallRuntimeNode;
59 class CallStaticJavaNode;
60 class CastFFNode;
61 class CastHHNode;
62 class CastDDNode;
63 class CastVVNode;
64 class CastIINode;
65 class CastLLNode;
66 class CastPPNode;
67 class CatchNode;
68 class CatchProjNode;
69 class CheckCastPPNode;
70 class ClearArrayNode;
71 class CmpNode;
72 class CodeBuffer;
73 class ConstraintCastNode;
74 class ConNode;
75 class ConINode;
76 class ConvertNode;
77 class CompareAndSwapNode;
78 class CompareAndExchangeNode;
79 class CountedLoopNode;
80 class CountedLoopEndNode;
81 class DecodeNarrowPtrNode;
82 class DecodeNNode;
83 class DecodeNKlassNode;
84 class EncodeNarrowPtrNode;
85 class EncodePNode;
86 class EncodePKlassNode;
87 class FastLockNode;
88 class FastUnlockNode;
89 class FlatArrayCheckNode;
90 class HaltNode;
91 class IfNode;
92 class IfProjNode;
93 class IfFalseNode;
94 class IfTrueNode;
95 class InitializeNode;
96 class JVMState;
97 class JumpNode;
98 class JumpProjNode;
99 class LoadNode;
100 class LoadStoreNode;
101 class LoadStoreConditionalNode;
102 class LockNode;
103 class LongCountedLoopNode;
104 class LongCountedLoopEndNode;
105 class LoopNode;
106 class LShiftNode;
107 class MachBranchNode;
108 class MachCallDynamicJavaNode;
109 class MachCallJavaNode;
110 class MachCallLeafNode;
111 class MachCallNode;
112 class MachCallRuntimeNode;
113 class MachCallStaticJavaNode;
114 class MachConstantBaseNode;
115 class MachConstantNode;
116 class MachGotoNode;
117 class MachIfNode;
118 class MachJumpNode;
119 class MachNode;
120 class MachNullCheckNode;
121 class MachProjNode;
122 class MachPrologNode;
123 class MachReturnNode;
124 class MachSafePointNode;
125 class MachSpillCopyNode;
126 class MachTempNode;
127 class MachMergeNode;
128 class MachMemBarNode;
129 class MachVEPNode;
130 class Matcher;
131 class MemBarNode;
132 class MemBarStoreStoreNode;
133 class MemNode;
134 class MergeMemNode;
135 class MoveNode;
136 class MulNode;
137 class MultiNode;
138 class MultiBranchNode;
139 class NegNode;
140 class NegVNode;
141 class NeverBranchNode;
142 class Opaque1Node;
143 class OpaqueLoopInitNode;
144 class OpaqueLoopStrideNode;
145 class OpaqueMultiversioningNode;
146 class OpaqueNotNullNode;
147 class OpaqueInitializedAssertionPredicateNode;
148 class OpaqueTemplateAssertionPredicateNode;
149 class OuterStripMinedLoopNode;
150 class OuterStripMinedLoopEndNode;
151 class Node;
152 class Node_Array;
153 class Node_List;
154 class Node_Stack;
155 class OopMap;
156 class ParmNode;
157 class ParsePredicateNode;
158 class PCTableNode;
159 class PhaseCCP;
160 class PhaseGVN;
161 class PhaseIdealLoop;
162 class PhaseIterGVN;
163 class PhaseRegAlloc;
164 class PhaseTransform;
165 class PhaseValues;
166 class PhiNode;
167 class Pipeline;
168 class PopulateIndexNode;
169 class ProjNode;
170 class RangeCheckNode;
171 class ReductionNode;
172 class RegMask;
173 class RegionNode;
174 class RootNode;
175 class SafePointNode;
176 class SafePointScalarObjectNode;
177 class SafePointScalarMergeNode;
178 class SaturatingVectorNode;
179 class StartNode;
180 class State;
181 class StoreNode;
182 class SubNode;
183 class SubTypeCheckNode;
184 class Type;
185 class TypeNode;
186 class UnlockNode;
187 class InlineTypeNode;
188 class VectorNode;
189 class LoadVectorNode;
190 class LoadVectorMaskedNode;
191 class StoreVectorMaskedNode;
192 class LoadVectorGatherNode;
193 class LoadVectorGatherMaskedNode;
194 class StoreVectorNode;
195 class StoreVectorScatterNode;
196 class StoreVectorScatterMaskedNode;
197 class VerifyVectorAlignmentNode;
198 class VectorMaskCmpNode;
199 class VectorUnboxNode;
200 class VectorSet;
201 class VectorReinterpretNode;
202 class ShiftVNode;
203 class MulVLNode;
204 class ExpandVNode;
205 class CompressVNode;
206 class CompressMNode;
207 class C2_MacroAssembler;
208
209
210 #ifndef OPTO_DU_ITERATOR_ASSERT
211 #ifdef ASSERT
212 #define OPTO_DU_ITERATOR_ASSERT 1
213 #else
214 #define OPTO_DU_ITERATOR_ASSERT 0
215 #endif
216 #endif //OPTO_DU_ITERATOR_ASSERT
217
218 #if OPTO_DU_ITERATOR_ASSERT
219 class DUIterator;
220 class DUIterator_Fast;
221 class DUIterator_Last;
222 #else
223 typedef uint DUIterator;
224 typedef Node** DUIterator_Fast;
225 typedef Node** DUIterator_Last;
226 #endif
227
228 typedef ResizeableResourceHashtable<Node*, Node*, AnyObj::RESOURCE_AREA, mtCompiler> OrigToNewHashtable;
229
230 // Node Sentinel
231 #define NodeSentinel (Node*)-1
232
233 // Unknown count frequency
234 #define COUNT_UNKNOWN (-1.0f)
235
236 //------------------------------Node-------------------------------------------
237 // Nodes define actions in the program. They create values, which have types.
238 // They are both vertices in a directed graph and program primitives. Nodes
239 // are labeled; the label is the "opcode", the primitive function in the lambda
240 // calculus sense that gives meaning to the Node. Node inputs are ordered (so
241 // that "a-b" is different from "b-a"). The inputs to a Node are the inputs to
242 // the Node's function. These inputs also define a Type equation for the Node.
243 // Solving these Type equations amounts to doing dataflow analysis.
244 // Control and data are uniformly represented in the graph. Finally, Nodes
245 // have a unique dense integer index which is used to index into side arrays
246 // whenever I have phase-specific information.
247
248 class Node {
249
250 // Lots of restrictions on cloning Nodes
251 NONCOPYABLE(Node);
252
253 public:
254 friend class Compile;
255 #if OPTO_DU_ITERATOR_ASSERT
256 friend class DUIterator_Common;
257 friend class DUIterator;
258 friend class DUIterator_Fast;
259 friend class DUIterator_Last;
260 #endif
261
262 // Because Nodes come and go, I define an Arena of Node structures to pull
263 // from. This should allow fast access to node creation & deletion. This
264 // field is a local cache of a value defined in some "program fragment" for
265 // which these Nodes are just a part of.
266
267 inline void* operator new(size_t x) throw() {
268 Compile* C = Compile::current();
269 Node* n = (Node*)C->node_arena()->AmallocWords(x);
270 return (void*)n;
271 }
272
273 // Delete is a NOP
274 void operator delete( void *ptr ) {}
275 // Fancy destructor; eagerly attempt to reclaim Node numberings and storage
276 void destruct(PhaseValues* phase);
277
278 // Create a new Node. Required is the number is of inputs required for
279 // semantic correctness.
280 Node( uint required );
281
282 // Create a new Node with given input edges.
283 // This version requires use of the "edge-count" new.
284 // E.g. new (C,3) FooNode( C, nullptr, left, right );
285 Node( Node *n0 );
286 Node( Node *n0, Node *n1 );
287 Node( Node *n0, Node *n1, Node *n2 );
288 Node( Node *n0, Node *n1, Node *n2, Node *n3 );
289 Node( Node *n0, Node *n1, Node *n2, Node *n3, Node *n4 );
290 Node( Node *n0, Node *n1, Node *n2, Node *n3, Node *n4, Node *n5 );
291 Node( Node *n0, Node *n1, Node *n2, Node *n3,
292 Node *n4, Node *n5, Node *n6 );
293
294 // Clone an inherited Node given only the base Node type.
295 Node* clone() const;
296
297 // Clone a Node, immediately supplying one or two new edges.
298 // The first and second arguments, if non-null, replace in(1) and in(2),
299 // respectively.
300 Node* clone_with_data_edge(Node* in1, Node* in2 = nullptr) const {
301 Node* nn = clone();
302 if (in1 != nullptr) nn->set_req(1, in1);
303 if (in2 != nullptr) nn->set_req(2, in2);
304 return nn;
305 }
306
307 private:
308 // Shared setup for the above constructors.
309 // Handles all interactions with Compile::current.
310 // Puts initial values in all Node fields except _idx.
311 // Returns the initial value for _idx, which cannot
312 // be initialized by assignment.
313 inline int Init(int req);
314
315 //----------------- input edge handling
316 protected:
317 friend class PhaseCFG; // Access to address of _in array elements
318 Node **_in; // Array of use-def references to Nodes
319 Node **_out; // Array of def-use references to Nodes
320
321 // Input edges are split into two categories. Required edges are required
322 // for semantic correctness; order is important and nulls are allowed.
323 // Precedence edges are used to help determine execution order and are
324 // added, e.g., for scheduling purposes. They are unordered and not
325 // duplicated; they have no embedded nulls. Edges from 0 to _cnt-1
326 // are required, from _cnt to _max-1 are precedence edges.
327 node_idx_t _cnt; // Total number of required Node inputs.
328
329 node_idx_t _max; // Actual length of input array.
330
331 // Output edges are an unordered list of def-use edges which exactly
332 // correspond to required input edges which point from other nodes
333 // to this one. Thus the count of the output edges is the number of
334 // users of this node.
335 node_idx_t _outcnt; // Total number of Node outputs.
336
337 node_idx_t _outmax; // Actual length of output array.
338
339 // Grow the actual input array to the next larger power-of-2 bigger than len.
340 void grow( uint len );
341 // Grow the output array to the next larger power-of-2 bigger than len.
342 void out_grow( uint len );
343 // Resize input or output array to grow it to the next larger power-of-2
344 // bigger than len.
345 void resize_array(Node**& array, node_idx_t& max_size, uint len, bool needs_clearing);
346
347 public:
348 // Each Node is assigned a unique small/dense number. This number is used
349 // to index into auxiliary arrays of data and bit vectors.
350 // The value of _idx can be changed using the set_idx() method.
351 //
352 // The PhaseRenumberLive phase renumbers nodes based on liveness information.
353 // Therefore, it updates the value of the _idx field. The parse-time _idx is
354 // preserved in _parse_idx.
355 node_idx_t _idx;
356 DEBUG_ONLY(const node_idx_t _parse_idx;)
357 // IGV node identifier. Two nodes, possibly in different compilation phases,
358 // have the same IGV identifier if (and only if) they are the very same node
359 // (same memory address) or one is "derived" from the other (by e.g.
360 // renumbering or matching). This identifier makes it possible to follow the
361 // entire lifetime of a node in IGV even if its C2 identifier (_idx) changes.
362 NOT_PRODUCT(node_idx_t _igv_idx;)
363
364 // Get the (read-only) number of input edges
365 uint req() const { return _cnt; }
366 uint len() const { return _max; }
367 // Get the (read-only) number of output edges
368 uint outcnt() const { return _outcnt; }
369
370 #if OPTO_DU_ITERATOR_ASSERT
371 // Iterate over the out-edges of this node. Deletions are illegal.
372 inline DUIterator outs() const;
373 // Use this when the out array might have changed to suppress asserts.
374 inline DUIterator& refresh_out_pos(DUIterator& i) const;
375 // Does the node have an out at this position? (Used for iteration.)
376 inline bool has_out(DUIterator& i) const;
377 inline Node* out(DUIterator& i) const;
378 // Iterate over the out-edges of this node. All changes are illegal.
379 inline DUIterator_Fast fast_outs(DUIterator_Fast& max) const;
380 inline Node* fast_out(DUIterator_Fast& i) const;
381 // Iterate over the out-edges of this node, deleting one at a time.
382 inline DUIterator_Last last_outs(DUIterator_Last& min) const;
383 inline Node* last_out(DUIterator_Last& i) const;
384 // The inline bodies of all these methods are after the iterator definitions.
385 #else
386 // Iterate over the out-edges of this node. Deletions are illegal.
387 // This iteration uses integral indexes, to decouple from array reallocations.
388 DUIterator outs() const { return 0; }
389 // Use this when the out array might have changed to suppress asserts.
390 DUIterator refresh_out_pos(DUIterator i) const { return i; }
391
392 // Reference to the i'th output Node. Error if out of bounds.
393 Node* out(DUIterator i) const { assert(i < _outcnt, "oob"); return _out[i]; }
394 // Does the node have an out at this position? (Used for iteration.)
395 bool has_out(DUIterator i) const { return i < _outcnt; }
396
397 // Iterate over the out-edges of this node. All changes are illegal.
398 // This iteration uses a pointer internal to the out array.
399 DUIterator_Fast fast_outs(DUIterator_Fast& max) const {
400 Node** out = _out;
401 // Assign a limit pointer to the reference argument:
402 max = out + (ptrdiff_t)_outcnt;
403 // Return the base pointer:
404 return out;
405 }
406 Node* fast_out(DUIterator_Fast i) const { return *i; }
407 // Iterate over the out-edges of this node, deleting one at a time.
408 // This iteration uses a pointer internal to the out array.
409 DUIterator_Last last_outs(DUIterator_Last& min) const {
410 Node** out = _out;
411 // Assign a limit pointer to the reference argument:
412 min = out;
413 // Return the pointer to the start of the iteration:
414 return out + (ptrdiff_t)_outcnt - 1;
415 }
416 Node* last_out(DUIterator_Last i) const { return *i; }
417 #endif
418
419 // Reference to the i'th input Node. Error if out of bounds.
420 Node* in(uint i) const { assert(i < _max, "oob: i=%d, _max=%d", i, _max); return _in[i]; }
421 // Reference to the i'th input Node. null if out of bounds.
422 Node* lookup(uint i) const { return ((i < _max) ? _in[i] : nullptr); }
423 // Reference to the i'th output Node. Error if out of bounds.
424 // Use this accessor sparingly. We are going trying to use iterators instead.
425 Node* raw_out(uint i) const { assert(i < _outcnt,"oob"); return _out[i]; }
426 // Return the unique out edge.
427 Node* unique_out() const { assert(_outcnt==1,"not unique"); return _out[0]; }
428 // Delete out edge at position 'i' by moving last out edge to position 'i'
429 void raw_del_out(uint i) {
430 assert(i < _outcnt,"oob");
431 assert(_outcnt > 0,"oob");
432 #if OPTO_DU_ITERATOR_ASSERT
433 // Record that a change happened here.
434 DEBUG_ONLY(_last_del = _out[i]; ++_del_tick);
435 #endif
436 _out[i] = _out[--_outcnt];
437 // Smash the old edge so it can't be used accidentally.
438 DEBUG_ONLY(_out[_outcnt] = (Node *)(uintptr_t)0xdeadbeef);
439 }
440
441 #ifdef ASSERT
442 bool is_dead() const;
443 static bool is_not_dead(const Node* n);
444 bool is_reachable_from_root() const;
445 #endif
446 // Check whether node has become unreachable
447 bool is_unreachable(PhaseIterGVN &igvn) const;
448
449 // Set a required input edge, also updates corresponding output edge
450 void add_req( Node *n ); // Append a NEW required input
451 void add_req( Node *n0, Node *n1 ) {
452 add_req(n0); add_req(n1); }
453 void add_req( Node *n0, Node *n1, Node *n2 ) {
454 add_req(n0); add_req(n1); add_req(n2); }
455 void add_req_batch( Node* n, uint m ); // Append m NEW required inputs (all n).
456 void del_req( uint idx ); // Delete required edge & compact
457 void del_req_ordered( uint idx ); // Delete required edge & compact with preserved order
458 void ins_req( uint i, Node *n ); // Insert a NEW required input
459 void set_req( uint i, Node *n ) {
460 assert( is_not_dead(n), "can not use dead node");
461 assert( i < _cnt, "oob: i=%d, _cnt=%d", i, _cnt);
462 assert( !VerifyHashTableKeys || _hash_lock == 0,
463 "remove node from hash table before modifying it");
464 Node** p = &_in[i]; // cache this._in, across the del_out call
465 if (*p != nullptr) (*p)->del_out((Node *)this);
466 (*p) = n;
467 if (n != nullptr) n->add_out((Node *)this);
468 Compile::current()->record_modified_node(this);
469 }
470 // Light version of set_req() to init inputs after node creation.
471 void init_req( uint i, Node *n ) {
472 assert( (i == 0 && this == n) ||
473 is_not_dead(n), "can not use dead node");
474 assert( i < _cnt, "oob");
475 assert( !VerifyHashTableKeys || _hash_lock == 0,
476 "remove node from hash table before modifying it");
477 assert( _in[i] == nullptr, "sanity");
478 _in[i] = n;
479 if (n != nullptr) n->add_out((Node *)this);
480 Compile::current()->record_modified_node(this);
481 }
482 // Find first occurrence of n among my edges:
483 int find_edge(Node* n);
484 int find_prec_edge(Node* n) {
485 for (uint i = req(); i < len(); i++) {
486 if (_in[i] == n) return i;
487 if (_in[i] == nullptr) {
488 DEBUG_ONLY( while ((++i) < len()) assert(_in[i] == nullptr, "Gap in prec edges!"); )
489 break;
490 }
491 }
492 return -1;
493 }
494 int replace_edge(Node* old, Node* neww, PhaseGVN* gvn = nullptr);
495 int replace_edges_in_range(Node* old, Node* neww, int start, int end, PhaseGVN* gvn);
496 // null out all inputs to eliminate incoming Def-Use edges.
497 void disconnect_inputs(Compile* C);
498
499 // Quickly, return true if and only if I am Compile::current()->top().
500 bool is_top() const {
501 assert((this == (Node*) Compile::current()->top()) == (_out == nullptr), "");
502 return (_out == nullptr);
503 }
504 // Reaffirm invariants for is_top. (Only from Compile::set_cached_top_node.)
505 void setup_is_top();
506
507 // Strip away casting. (It is depth-limited.)
508 Node* uncast(bool keep_deps = false) const;
509 // Return whether two Nodes are equivalent, after stripping casting.
510 bool eqv_uncast(const Node* n, bool keep_deps = false) const {
511 return (this->uncast(keep_deps) == n->uncast(keep_deps));
512 }
513
514 // Find out of current node that matches opcode.
515 Node* find_out_with(int opcode);
516 // Return true if the current node has an out that matches opcode.
517 bool has_out_with(int opcode);
518 // Return true if the current node has an out that matches any of the opcodes.
519 bool has_out_with(int opcode1, int opcode2, int opcode3, int opcode4);
520
521 private:
522 static Node* uncast_helper(const Node* n, bool keep_deps);
523
524 // Add an output edge to the end of the list
525 void add_out( Node *n ) {
526 if (is_top()) return;
527 if( _outcnt == _outmax ) out_grow(_outcnt);
528 _out[_outcnt++] = n;
529 }
530 // Delete an output edge
531 void del_out( Node *n ) {
532 if (is_top()) return;
533 Node** outp = &_out[_outcnt];
534 // Find and remove n
535 do {
536 assert(outp > _out, "Missing Def-Use edge");
537 } while (*--outp != n);
538 *outp = _out[--_outcnt];
539 // Smash the old edge so it can't be used accidentally.
540 DEBUG_ONLY(_out[_outcnt] = (Node *)(uintptr_t)0xdeadbeef);
541 // Record that a change happened here.
542 #if OPTO_DU_ITERATOR_ASSERT
543 DEBUG_ONLY(_last_del = n; ++_del_tick);
544 #endif
545 }
546 // Close gap after removing edge.
547 void close_prec_gap_at(uint gap) {
548 assert(_cnt <= gap && gap < _max, "no valid prec edge");
549 uint i = gap;
550 Node *last = nullptr;
551 for (; i < _max-1; ++i) {
552 Node *next = _in[i+1];
553 if (next == nullptr) break;
554 last = next;
555 }
556 _in[gap] = last; // Move last slot to empty one.
557 _in[i] = nullptr; // null out last slot.
558 }
559
560 public:
561 // Globally replace this node by a given new node, updating all uses.
562 void replace_by(Node* new_node);
563 // Globally replace this node by a given new node, updating all uses
564 // and cutting input edges of old node.
565 void subsume_by(Node* new_node, Compile* c) {
566 replace_by(new_node);
567 disconnect_inputs(c);
568 }
569 void set_req_X(uint i, Node *n, PhaseIterGVN *igvn);
570 void set_req_X(uint i, Node *n, PhaseGVN *gvn);
571 // Find the one non-null required input. RegionNode only
572 Node *nonnull_req() const;
573 // Add or remove precedence edges
574 void add_prec( Node *n );
575 void rm_prec( uint i );
576
577 // Note: prec(i) will not necessarily point to n if edge already exists.
578 void set_prec( uint i, Node *n ) {
579 assert(i < _max, "oob: i=%d, _max=%d", i, _max);
580 assert(is_not_dead(n), "can not use dead node");
581 assert(i >= _cnt, "not a precedence edge");
582 // Avoid spec violation: duplicated prec edge.
583 if (_in[i] == n) return;
584 if (n == nullptr || find_prec_edge(n) != -1) {
585 rm_prec(i);
586 return;
587 }
588 if (_in[i] != nullptr) _in[i]->del_out((Node *)this);
589 _in[i] = n;
590 n->add_out((Node *)this);
591 Compile::current()->record_modified_node(this);
592 }
593
594 // Set this node's index, used by cisc_version to replace current node
595 void set_idx(uint new_idx) {
596 _idx = new_idx;
597 }
598 // Swap input edge order. (Edge indexes i1 and i2 are usually 1 and 2.)
599 void swap_edges(uint i1, uint i2) {
600 DEBUG_ONLY(uint check_hash = (VerifyHashTableKeys && _hash_lock) ? hash() : NO_HASH);
601 // Def-Use info is unchanged
602 Node* n1 = in(i1);
603 Node* n2 = in(i2);
604 _in[i1] = n2;
605 _in[i2] = n1;
606 // If this node is in the hash table, make sure it doesn't need a rehash.
607 assert(check_hash == NO_HASH || check_hash == hash(), "edge swap must preserve hash code");
608 // Flip swapped edges flag.
609 if (has_swapped_edges()) {
610 remove_flag(Node::Flag_has_swapped_edges);
611 } else {
612 add_flag(Node::Flag_has_swapped_edges);
613 }
614 }
615
616 // Iterators over input Nodes for a Node X are written as:
617 // for( i = 0; i < X.req(); i++ ) ... X[i] ...
618 // NOTE: Required edges can contain embedded null pointers.
619
620 //----------------- Other Node Properties
621
622 // Generate class IDs for (some) ideal nodes so that it is possible to determine
623 // the type of a node using a non-virtual method call (the method is_<Node>() below).
624 //
625 // A class ID of an ideal node is a set of bits. In a class ID, a single bit determines
626 // the type of the node the ID represents; another subset of an ID's bits are reserved
627 // for the superclasses of the node represented by the ID.
628 //
629 // By design, if A is a supertype of B, A.is_B() returns true and B.is_A()
630 // returns false. A.is_A() returns true.
631 //
632 // If two classes, A and B, have the same superclass, a different bit of A's class id
633 // is reserved for A's type than for B's type. That bit is specified by the third
634 // parameter in the macro DEFINE_CLASS_ID.
635 //
636 // By convention, classes with deeper hierarchy are declared first. Moreover,
637 // classes with the same hierarchy depth are sorted by usage frequency.
638 //
639 // The query method masks the bits to cut off bits of subclasses and then compares
640 // the result with the class id (see the macro DEFINE_CLASS_QUERY below).
641 //
642 // Class_MachCall=30, ClassMask_MachCall=31
643 // 12 8 4 0
644 // 0 0 0 0 0 0 0 0 1 1 1 1 0
645 // | | | |
646 // | | | Bit_Mach=2
647 // | | Bit_MachReturn=4
648 // | Bit_MachSafePoint=8
649 // Bit_MachCall=16
650 //
651 // Class_CountedLoop=56, ClassMask_CountedLoop=63
652 // 12 8 4 0
653 // 0 0 0 0 0 0 0 1 1 1 0 0 0
654 // | | |
655 // | | Bit_Region=8
656 // | Bit_Loop=16
657 // Bit_CountedLoop=32
658
659 #define DEFINE_CLASS_ID(cl, supcl, subn) \
660 Bit_##cl = (Class_##supcl == 0) ? 1 << subn : (Bit_##supcl) << (1 + subn) , \
661 Class_##cl = Class_##supcl + Bit_##cl , \
662 ClassMask_##cl = ((Bit_##cl << 1) - 1) ,
663
664 // This enum is used only for C2 ideal and mach nodes with is_<node>() methods
665 // so that its values fit into 32 bits.
666 enum NodeClasses {
667 Bit_Node = 0x00000000,
668 Class_Node = 0x00000000,
669 ClassMask_Node = 0xFFFFFFFF,
670
671 DEFINE_CLASS_ID(Multi, Node, 0)
672 DEFINE_CLASS_ID(SafePoint, Multi, 0)
673 DEFINE_CLASS_ID(Call, SafePoint, 0)
674 DEFINE_CLASS_ID(CallJava, Call, 0)
675 DEFINE_CLASS_ID(CallStaticJava, CallJava, 0)
676 DEFINE_CLASS_ID(CallDynamicJava, CallJava, 1)
677 DEFINE_CLASS_ID(CallRuntime, Call, 1)
678 DEFINE_CLASS_ID(CallLeaf, CallRuntime, 0)
679 DEFINE_CLASS_ID(CallLeafNoFP, CallLeaf, 0)
680 DEFINE_CLASS_ID(Allocate, Call, 2)
681 DEFINE_CLASS_ID(AllocateArray, Allocate, 0)
682 DEFINE_CLASS_ID(AbstractLock, Call, 3)
683 DEFINE_CLASS_ID(Lock, AbstractLock, 0)
684 DEFINE_CLASS_ID(Unlock, AbstractLock, 1)
685 DEFINE_CLASS_ID(ArrayCopy, Call, 4)
686 DEFINE_CLASS_ID(MultiBranch, Multi, 1)
687 DEFINE_CLASS_ID(PCTable, MultiBranch, 0)
688 DEFINE_CLASS_ID(Catch, PCTable, 0)
689 DEFINE_CLASS_ID(Jump, PCTable, 1)
690 DEFINE_CLASS_ID(If, MultiBranch, 1)
691 DEFINE_CLASS_ID(BaseCountedLoopEnd, If, 0)
692 DEFINE_CLASS_ID(CountedLoopEnd, BaseCountedLoopEnd, 0)
693 DEFINE_CLASS_ID(LongCountedLoopEnd, BaseCountedLoopEnd, 1)
694 DEFINE_CLASS_ID(RangeCheck, If, 1)
695 DEFINE_CLASS_ID(OuterStripMinedLoopEnd, If, 2)
696 DEFINE_CLASS_ID(ParsePredicate, If, 3)
697 DEFINE_CLASS_ID(NeverBranch, MultiBranch, 2)
698 DEFINE_CLASS_ID(Start, Multi, 2)
699 DEFINE_CLASS_ID(MemBar, Multi, 3)
700 DEFINE_CLASS_ID(Initialize, MemBar, 0)
701 DEFINE_CLASS_ID(MemBarStoreStore, MemBar, 1)
702 DEFINE_CLASS_ID(Blackhole, MemBar, 2)
703
704 DEFINE_CLASS_ID(Mach, Node, 1)
705 DEFINE_CLASS_ID(MachReturn, Mach, 0)
706 DEFINE_CLASS_ID(MachSafePoint, MachReturn, 0)
707 DEFINE_CLASS_ID(MachCall, MachSafePoint, 0)
708 DEFINE_CLASS_ID(MachCallJava, MachCall, 0)
709 DEFINE_CLASS_ID(MachCallStaticJava, MachCallJava, 0)
710 DEFINE_CLASS_ID(MachCallDynamicJava, MachCallJava, 1)
711 DEFINE_CLASS_ID(MachCallRuntime, MachCall, 1)
712 DEFINE_CLASS_ID(MachCallLeaf, MachCallRuntime, 0)
713 DEFINE_CLASS_ID(MachBranch, Mach, 1)
714 DEFINE_CLASS_ID(MachIf, MachBranch, 0)
715 DEFINE_CLASS_ID(MachGoto, MachBranch, 1)
716 DEFINE_CLASS_ID(MachNullCheck, MachBranch, 2)
717 DEFINE_CLASS_ID(MachSpillCopy, Mach, 2)
718 DEFINE_CLASS_ID(MachTemp, Mach, 3)
719 DEFINE_CLASS_ID(MachConstantBase, Mach, 4)
720 DEFINE_CLASS_ID(MachConstant, Mach, 5)
721 DEFINE_CLASS_ID(MachJump, MachConstant, 0)
722 DEFINE_CLASS_ID(MachMerge, Mach, 6)
723 DEFINE_CLASS_ID(MachMemBar, Mach, 7)
724 DEFINE_CLASS_ID(MachProlog, Mach, 8)
725 DEFINE_CLASS_ID(MachVEP, Mach, 9)
726
727 DEFINE_CLASS_ID(Type, Node, 2)
728 DEFINE_CLASS_ID(Phi, Type, 0)
729 DEFINE_CLASS_ID(ConstraintCast, Type, 1)
730 DEFINE_CLASS_ID(CastII, ConstraintCast, 0)
731 DEFINE_CLASS_ID(CheckCastPP, ConstraintCast, 1)
732 DEFINE_CLASS_ID(CastLL, ConstraintCast, 2)
733 DEFINE_CLASS_ID(CastFF, ConstraintCast, 3)
734 DEFINE_CLASS_ID(CastDD, ConstraintCast, 4)
735 DEFINE_CLASS_ID(CastVV, ConstraintCast, 5)
736 DEFINE_CLASS_ID(CastPP, ConstraintCast, 6)
737 DEFINE_CLASS_ID(CastHH, ConstraintCast, 7)
738 DEFINE_CLASS_ID(CMove, Type, 3)
739 DEFINE_CLASS_ID(SafePointScalarObject, Type, 4)
740 DEFINE_CLASS_ID(DecodeNarrowPtr, Type, 5)
741 DEFINE_CLASS_ID(DecodeN, DecodeNarrowPtr, 0)
742 DEFINE_CLASS_ID(DecodeNKlass, DecodeNarrowPtr, 1)
743 DEFINE_CLASS_ID(EncodeNarrowPtr, Type, 6)
744 DEFINE_CLASS_ID(EncodeP, EncodeNarrowPtr, 0)
745 DEFINE_CLASS_ID(EncodePKlass, EncodeNarrowPtr, 1)
746 DEFINE_CLASS_ID(Vector, Type, 7)
747 DEFINE_CLASS_ID(VectorMaskCmp, Vector, 0)
748 DEFINE_CLASS_ID(VectorUnbox, Vector, 1)
749 DEFINE_CLASS_ID(VectorReinterpret, Vector, 2)
750 DEFINE_CLASS_ID(ShiftV, Vector, 3)
751 DEFINE_CLASS_ID(CompressV, Vector, 4)
752 DEFINE_CLASS_ID(ExpandV, Vector, 5)
753 DEFINE_CLASS_ID(CompressM, Vector, 6)
754 DEFINE_CLASS_ID(Reduction, Vector, 7)
755 DEFINE_CLASS_ID(NegV, Vector, 8)
756 DEFINE_CLASS_ID(SaturatingVector, Vector, 9)
757 DEFINE_CLASS_ID(MulVL, Vector, 10)
758 DEFINE_CLASS_ID(InlineType, Type, 8)
759 DEFINE_CLASS_ID(Con, Type, 9)
760 DEFINE_CLASS_ID(ConI, Con, 0)
761 DEFINE_CLASS_ID(SafePointScalarMerge, Type, 10)
762 DEFINE_CLASS_ID(Convert, Type, 11)
763
764
765 DEFINE_CLASS_ID(Proj, Node, 3)
766 DEFINE_CLASS_ID(CatchProj, Proj, 0)
767 DEFINE_CLASS_ID(JumpProj, Proj, 1)
768 DEFINE_CLASS_ID(IfProj, Proj, 2)
769 DEFINE_CLASS_ID(IfTrue, IfProj, 0)
770 DEFINE_CLASS_ID(IfFalse, IfProj, 1)
771 DEFINE_CLASS_ID(Parm, Proj, 4)
772 DEFINE_CLASS_ID(MachProj, Proj, 5)
773
774 DEFINE_CLASS_ID(Mem, Node, 4)
775 DEFINE_CLASS_ID(Load, Mem, 0)
776 DEFINE_CLASS_ID(LoadVector, Load, 0)
777 DEFINE_CLASS_ID(LoadVectorGather, LoadVector, 0)
778 DEFINE_CLASS_ID(LoadVectorGatherMasked, LoadVector, 1)
779 DEFINE_CLASS_ID(LoadVectorMasked, LoadVector, 2)
780 DEFINE_CLASS_ID(Store, Mem, 1)
781 DEFINE_CLASS_ID(StoreVector, Store, 0)
782 DEFINE_CLASS_ID(StoreVectorScatter, StoreVector, 0)
783 DEFINE_CLASS_ID(StoreVectorScatterMasked, StoreVector, 1)
784 DEFINE_CLASS_ID(StoreVectorMasked, StoreVector, 2)
785 DEFINE_CLASS_ID(LoadStore, Mem, 2)
786 DEFINE_CLASS_ID(LoadStoreConditional, LoadStore, 0)
787 DEFINE_CLASS_ID(CompareAndSwap, LoadStoreConditional, 0)
788 DEFINE_CLASS_ID(CompareAndExchangeNode, LoadStore, 1)
789
790 DEFINE_CLASS_ID(Region, Node, 5)
791 DEFINE_CLASS_ID(Loop, Region, 0)
792 DEFINE_CLASS_ID(Root, Loop, 0)
793 DEFINE_CLASS_ID(BaseCountedLoop, Loop, 1)
794 DEFINE_CLASS_ID(CountedLoop, BaseCountedLoop, 0)
795 DEFINE_CLASS_ID(LongCountedLoop, BaseCountedLoop, 1)
796 DEFINE_CLASS_ID(OuterStripMinedLoop, Loop, 2)
797
798 DEFINE_CLASS_ID(Sub, Node, 6)
799 DEFINE_CLASS_ID(Cmp, Sub, 0)
800 DEFINE_CLASS_ID(FastLock, Cmp, 0)
801 DEFINE_CLASS_ID(FastUnlock, Cmp, 1)
802 DEFINE_CLASS_ID(SubTypeCheck, Cmp, 2)
803 DEFINE_CLASS_ID(FlatArrayCheck, Cmp, 3)
804
805 DEFINE_CLASS_ID(MergeMem, Node, 7)
806 DEFINE_CLASS_ID(Bool, Node, 8)
807 DEFINE_CLASS_ID(AddP, Node, 9)
808 DEFINE_CLASS_ID(BoxLock, Node, 10)
809 DEFINE_CLASS_ID(Add, Node, 11)
810 DEFINE_CLASS_ID(Mul, Node, 12)
811 DEFINE_CLASS_ID(ClearArray, Node, 14)
812 DEFINE_CLASS_ID(Halt, Node, 15)
813 DEFINE_CLASS_ID(Opaque1, Node, 16)
814 DEFINE_CLASS_ID(OpaqueLoopInit, Opaque1, 0)
815 DEFINE_CLASS_ID(OpaqueLoopStride, Opaque1, 1)
816 DEFINE_CLASS_ID(OpaqueMultiversioning, Opaque1, 2)
817 DEFINE_CLASS_ID(OpaqueNotNull, Node, 17)
818 DEFINE_CLASS_ID(OpaqueInitializedAssertionPredicate, Node, 18)
819 DEFINE_CLASS_ID(OpaqueTemplateAssertionPredicate, Node, 19)
820 DEFINE_CLASS_ID(Move, Node, 20)
821 DEFINE_CLASS_ID(LShift, Node, 21)
822 DEFINE_CLASS_ID(Neg, Node, 22)
823
824 _max_classes = ClassMask_Neg
825 };
826 #undef DEFINE_CLASS_ID
827
828 // Flags are sorted by usage frequency.
829 enum NodeFlags {
830 Flag_is_Copy = 1 << 0, // should be first bit to avoid shift
831 Flag_rematerialize = 1 << 1,
832 Flag_needs_anti_dependence_check = 1 << 2,
833 Flag_is_macro = 1 << 3,
834 Flag_is_Con = 1 << 4,
835 Flag_is_cisc_alternate = 1 << 5,
836 Flag_is_dead_loop_safe = 1 << 6,
837 Flag_may_be_short_branch = 1 << 7,
838 Flag_avoid_back_to_back_before = 1 << 8,
839 Flag_avoid_back_to_back_after = 1 << 9,
840 Flag_has_call = 1 << 10,
841 Flag_has_swapped_edges = 1 << 11,
842 Flag_is_scheduled = 1 << 12,
843 Flag_is_expensive = 1 << 13,
844 Flag_is_predicated_vector = 1 << 14,
845 Flag_for_post_loop_opts_igvn = 1 << 15,
846 Flag_for_merge_stores_igvn = 1 << 16,
847 Flag_is_removed_by_peephole = 1 << 17,
848 Flag_is_predicated_using_blend = 1 << 18,
849 _last_flag = Flag_is_predicated_using_blend
850 };
851
852 class PD;
853
854 private:
855 juint _class_id;
856 juint _flags;
857
858 #ifdef ASSERT
859 static juint max_flags();
860 #endif
861
862 protected:
863 // These methods should be called from constructors only.
864 void init_class_id(juint c) {
865 _class_id = c; // cast out const
866 }
867 void init_flags(uint fl) {
868 assert(fl <= max_flags(), "invalid node flag");
869 _flags |= fl;
870 }
871 void clear_flag(uint fl) {
872 assert(fl <= max_flags(), "invalid node flag");
873 _flags &= ~fl;
874 }
875
876 public:
877 juint class_id() const { return _class_id; }
878
879 juint flags() const { return _flags; }
880
881 void add_flag(juint fl) { init_flags(fl); }
882
883 void remove_flag(juint fl) { clear_flag(fl); }
884
885 // Return a dense integer opcode number
886 virtual int Opcode() const;
887
888 // Virtual inherited Node size
889 virtual uint size_of() const;
890
891 // Other interesting Node properties
892 #define DEFINE_CLASS_QUERY(type) \
893 bool is_##type() const { \
894 return ((_class_id & ClassMask_##type) == Class_##type); \
895 } \
896 type##Node *as_##type() const { \
897 assert(is_##type(), "invalid node class: %s", Name()); \
898 return (type##Node*)this; \
899 } \
900 type##Node* isa_##type() const { \
901 return (is_##type()) ? as_##type() : nullptr; \
902 }
903
904 DEFINE_CLASS_QUERY(AbstractLock)
905 DEFINE_CLASS_QUERY(Add)
906 DEFINE_CLASS_QUERY(AddP)
907 DEFINE_CLASS_QUERY(Allocate)
908 DEFINE_CLASS_QUERY(AllocateArray)
909 DEFINE_CLASS_QUERY(ArrayCopy)
910 DEFINE_CLASS_QUERY(BaseCountedLoop)
911 DEFINE_CLASS_QUERY(BaseCountedLoopEnd)
912 DEFINE_CLASS_QUERY(Blackhole)
913 DEFINE_CLASS_QUERY(Bool)
914 DEFINE_CLASS_QUERY(BoxLock)
915 DEFINE_CLASS_QUERY(Call)
916 DEFINE_CLASS_QUERY(CallDynamicJava)
917 DEFINE_CLASS_QUERY(CallJava)
918 DEFINE_CLASS_QUERY(CallLeaf)
919 DEFINE_CLASS_QUERY(CallLeafNoFP)
920 DEFINE_CLASS_QUERY(CallRuntime)
921 DEFINE_CLASS_QUERY(CallStaticJava)
922 DEFINE_CLASS_QUERY(Catch)
923 DEFINE_CLASS_QUERY(CatchProj)
924 DEFINE_CLASS_QUERY(CheckCastPP)
925 DEFINE_CLASS_QUERY(CastII)
926 DEFINE_CLASS_QUERY(CastLL)
927 DEFINE_CLASS_QUERY(CastFF)
928 DEFINE_CLASS_QUERY(ConI)
929 DEFINE_CLASS_QUERY(CastPP)
930 DEFINE_CLASS_QUERY(ConstraintCast)
931 DEFINE_CLASS_QUERY(ClearArray)
932 DEFINE_CLASS_QUERY(CMove)
933 DEFINE_CLASS_QUERY(Cmp)
934 DEFINE_CLASS_QUERY(Convert)
935 DEFINE_CLASS_QUERY(CountedLoop)
936 DEFINE_CLASS_QUERY(CountedLoopEnd)
937 DEFINE_CLASS_QUERY(DecodeNarrowPtr)
938 DEFINE_CLASS_QUERY(DecodeN)
939 DEFINE_CLASS_QUERY(DecodeNKlass)
940 DEFINE_CLASS_QUERY(EncodeNarrowPtr)
941 DEFINE_CLASS_QUERY(EncodeP)
942 DEFINE_CLASS_QUERY(EncodePKlass)
943 DEFINE_CLASS_QUERY(FastLock)
944 DEFINE_CLASS_QUERY(FastUnlock)
945 DEFINE_CLASS_QUERY(FlatArrayCheck)
946 DEFINE_CLASS_QUERY(Halt)
947 DEFINE_CLASS_QUERY(If)
948 DEFINE_CLASS_QUERY(RangeCheck)
949 DEFINE_CLASS_QUERY(IfProj)
950 DEFINE_CLASS_QUERY(IfFalse)
951 DEFINE_CLASS_QUERY(IfTrue)
952 DEFINE_CLASS_QUERY(Initialize)
953 DEFINE_CLASS_QUERY(Jump)
954 DEFINE_CLASS_QUERY(JumpProj)
955 DEFINE_CLASS_QUERY(LongCountedLoop)
956 DEFINE_CLASS_QUERY(LongCountedLoopEnd)
957 DEFINE_CLASS_QUERY(Load)
958 DEFINE_CLASS_QUERY(LoadStore)
959 DEFINE_CLASS_QUERY(LoadStoreConditional)
960 DEFINE_CLASS_QUERY(Lock)
961 DEFINE_CLASS_QUERY(Loop)
962 DEFINE_CLASS_QUERY(LShift)
963 DEFINE_CLASS_QUERY(Mach)
964 DEFINE_CLASS_QUERY(MachBranch)
965 DEFINE_CLASS_QUERY(MachCall)
966 DEFINE_CLASS_QUERY(MachCallDynamicJava)
967 DEFINE_CLASS_QUERY(MachCallJava)
968 DEFINE_CLASS_QUERY(MachCallLeaf)
969 DEFINE_CLASS_QUERY(MachCallRuntime)
970 DEFINE_CLASS_QUERY(MachCallStaticJava)
971 DEFINE_CLASS_QUERY(MachConstantBase)
972 DEFINE_CLASS_QUERY(MachConstant)
973 DEFINE_CLASS_QUERY(MachGoto)
974 DEFINE_CLASS_QUERY(MachIf)
975 DEFINE_CLASS_QUERY(MachJump)
976 DEFINE_CLASS_QUERY(MachNullCheck)
977 DEFINE_CLASS_QUERY(MachProj)
978 DEFINE_CLASS_QUERY(MachProlog)
979 DEFINE_CLASS_QUERY(MachReturn)
980 DEFINE_CLASS_QUERY(MachSafePoint)
981 DEFINE_CLASS_QUERY(MachSpillCopy)
982 DEFINE_CLASS_QUERY(MachTemp)
983 DEFINE_CLASS_QUERY(MachMemBar)
984 DEFINE_CLASS_QUERY(MachMerge)
985 DEFINE_CLASS_QUERY(MachVEP)
986 DEFINE_CLASS_QUERY(Mem)
987 DEFINE_CLASS_QUERY(MemBar)
988 DEFINE_CLASS_QUERY(MemBarStoreStore)
989 DEFINE_CLASS_QUERY(MergeMem)
990 DEFINE_CLASS_QUERY(Move)
991 DEFINE_CLASS_QUERY(Mul)
992 DEFINE_CLASS_QUERY(Multi)
993 DEFINE_CLASS_QUERY(MultiBranch)
994 DEFINE_CLASS_QUERY(MulVL)
995 DEFINE_CLASS_QUERY(Neg)
996 DEFINE_CLASS_QUERY(NegV)
997 DEFINE_CLASS_QUERY(NeverBranch)
998 DEFINE_CLASS_QUERY(Opaque1)
999 DEFINE_CLASS_QUERY(OpaqueNotNull)
1000 DEFINE_CLASS_QUERY(OpaqueInitializedAssertionPredicate)
1001 DEFINE_CLASS_QUERY(OpaqueTemplateAssertionPredicate)
1002 DEFINE_CLASS_QUERY(OpaqueLoopInit)
1003 DEFINE_CLASS_QUERY(OpaqueLoopStride)
1004 DEFINE_CLASS_QUERY(OpaqueMultiversioning)
1005 DEFINE_CLASS_QUERY(OuterStripMinedLoop)
1006 DEFINE_CLASS_QUERY(OuterStripMinedLoopEnd)
1007 DEFINE_CLASS_QUERY(Parm)
1008 DEFINE_CLASS_QUERY(ParsePredicate)
1009 DEFINE_CLASS_QUERY(PCTable)
1010 DEFINE_CLASS_QUERY(Phi)
1011 DEFINE_CLASS_QUERY(Proj)
1012 DEFINE_CLASS_QUERY(Reduction)
1013 DEFINE_CLASS_QUERY(Region)
1014 DEFINE_CLASS_QUERY(Root)
1015 DEFINE_CLASS_QUERY(SafePoint)
1016 DEFINE_CLASS_QUERY(SafePointScalarObject)
1017 DEFINE_CLASS_QUERY(SafePointScalarMerge)
1018 DEFINE_CLASS_QUERY(Start)
1019 DEFINE_CLASS_QUERY(Store)
1020 DEFINE_CLASS_QUERY(Sub)
1021 DEFINE_CLASS_QUERY(SubTypeCheck)
1022 DEFINE_CLASS_QUERY(Type)
1023 DEFINE_CLASS_QUERY(InlineType)
1024 DEFINE_CLASS_QUERY(Vector)
1025 DEFINE_CLASS_QUERY(VectorMaskCmp)
1026 DEFINE_CLASS_QUERY(VectorUnbox)
1027 DEFINE_CLASS_QUERY(VectorReinterpret)
1028 DEFINE_CLASS_QUERY(CompressV)
1029 DEFINE_CLASS_QUERY(ExpandV)
1030 DEFINE_CLASS_QUERY(CompressM)
1031 DEFINE_CLASS_QUERY(LoadVector)
1032 DEFINE_CLASS_QUERY(LoadVectorGather)
1033 DEFINE_CLASS_QUERY(LoadVectorMasked)
1034 DEFINE_CLASS_QUERY(LoadVectorGatherMasked)
1035 DEFINE_CLASS_QUERY(StoreVector)
1036 DEFINE_CLASS_QUERY(StoreVectorScatter)
1037 DEFINE_CLASS_QUERY(StoreVectorMasked)
1038 DEFINE_CLASS_QUERY(StoreVectorScatterMasked)
1039 DEFINE_CLASS_QUERY(SaturatingVector)
1040 DEFINE_CLASS_QUERY(ShiftV)
1041 DEFINE_CLASS_QUERY(Unlock)
1042
1043 #undef DEFINE_CLASS_QUERY
1044
1045 // duplicate of is_MachSpillCopy()
1046 bool is_SpillCopy () const {
1047 return ((_class_id & ClassMask_MachSpillCopy) == Class_MachSpillCopy);
1048 }
1049
1050 bool is_Con () const { return (_flags & Flag_is_Con) != 0; }
1051 // The data node which is safe to leave in dead loop during IGVN optimization.
1052 bool is_dead_loop_safe() const;
1053
1054 // is_Copy() returns copied edge index (0 or 1)
1055 uint is_Copy() const { return (_flags & Flag_is_Copy); }
1056
1057 virtual bool is_CFG() const { return false; }
1058
1059 // If this node is control-dependent on a test, can it be
1060 // rerouted to a dominating equivalent test? This is usually
1061 // true of non-CFG nodes, but can be false for operations which
1062 // depend for their correct sequencing on more than one test.
1063 // (In that case, hoisting to a dominating test may silently
1064 // skip some other important test.)
1065 virtual bool depends_only_on_test() const { assert(!is_CFG(), ""); return true; };
1066
1067 // When building basic blocks, I need to have a notion of block beginning
1068 // Nodes, next block selector Nodes (block enders), and next block
1069 // projections. These calls need to work on their machine equivalents. The
1070 // Ideal beginning Nodes are RootNode, RegionNode and StartNode.
1071 bool is_block_start() const {
1072 if ( is_Region() )
1073 return this == (const Node*)in(0);
1074 else
1075 return is_Start();
1076 }
1077
1078 // The Ideal control projection Nodes are IfTrue/IfFalse, JumpProjNode, Root,
1079 // Goto and Return. This call also returns the block ending Node.
1080 virtual const Node *is_block_proj() const;
1081
1082 // The node is a "macro" node which needs to be expanded before matching
1083 bool is_macro() const { return (_flags & Flag_is_macro) != 0; }
1084 // The node is expensive: the best control is set during loop opts
1085 bool is_expensive() const { return (_flags & Flag_is_expensive) != 0 && in(0) != nullptr; }
1086 // The node's original edge position is swapped.
1087 bool has_swapped_edges() const { return (_flags & Flag_has_swapped_edges) != 0; }
1088
1089 bool is_predicated_vector() const { return (_flags & Flag_is_predicated_vector) != 0; }
1090
1091 bool is_predicated_using_blend() const { return (_flags & Flag_is_predicated_using_blend) != 0; }
1092
1093 // Used in lcm to mark nodes that have scheduled
1094 bool is_scheduled() const { return (_flags & Flag_is_scheduled) != 0; }
1095
1096 bool for_post_loop_opts_igvn() const { return (_flags & Flag_for_post_loop_opts_igvn) != 0; }
1097 bool for_merge_stores_igvn() const { return (_flags & Flag_for_merge_stores_igvn) != 0; }
1098
1099 // Is 'n' possibly a loop entry (i.e. a Parse Predicate projection)?
1100 static bool may_be_loop_entry(Node* n) {
1101 return n != nullptr && n->is_IfProj() && n->in(0)->is_ParsePredicate();
1102 }
1103
1104 //----------------- Optimization
1105
1106 // Get the worst-case Type output for this Node.
1107 virtual const class Type *bottom_type() const;
1108
1109 // If we find a better type for a node, try to record it permanently.
1110 // Return true if this node actually changed.
1111 // Be sure to do the hash_delete game in the "rehash" variant.
1112 void raise_bottom_type(const Type* new_type);
1113
1114 // Get the address type with which this node uses and/or defs memory,
1115 // or null if none. The address type is conservatively wide.
1116 // Returns non-null for calls, membars, loads, stores, etc.
1117 // Returns TypePtr::BOTTOM if the node touches memory "broadly".
1118 virtual const class TypePtr *adr_type() const { return nullptr; }
1119
1120 // Return an existing node which computes the same function as this node.
1121 // The optimistic combined algorithm requires this to return a Node which
1122 // is a small number of steps away (e.g., one of my inputs).
1123 virtual Node* Identity(PhaseGVN* phase);
1124
1125 // Return the set of values this Node can take on at runtime.
1126 virtual const Type* Value(PhaseGVN* phase) const;
1127
1128 // Return a node which is more "ideal" than the current node.
1129 // The invariants on this call are subtle. If in doubt, read the
1130 // treatise in node.cpp above the default implementation AND TEST WITH
1131 // -XX:VerifyIterativeGVN=1
1132 virtual Node *Ideal(PhaseGVN *phase, bool can_reshape);
1133
1134 // Some nodes have specific Ideal subgraph transformations only if they are
1135 // unique users of specific nodes. Such nodes should be put on IGVN worklist
1136 // for the transformations to happen.
1137 bool has_special_unique_user() const;
1138
1139 // Skip Proj and CatchProj nodes chains. Check for Null and Top.
1140 Node* find_exact_control(Node* ctrl);
1141
1142 // Results of the dominance analysis.
1143 enum class DomResult {
1144 NotDominate, // 'this' node does not dominate 'sub'.
1145 Dominate, // 'this' node dominates or is equal to 'sub'.
1146 EncounteredDeadCode // Result is undefined due to encountering dead code.
1147 };
1148 // Check if 'this' node dominates or equal to 'sub'.
1149 DomResult dominates(Node* sub, Node_List &nlist);
1150
1151 bool remove_dead_region(PhaseGVN *phase, bool can_reshape);
1152 public:
1153
1154 // See if there is valid pipeline info
1155 static const Pipeline *pipeline_class();
1156 virtual const Pipeline *pipeline() const;
1157
1158 // Compute the latency from the def to this instruction of the ith input node
1159 uint latency(uint i);
1160
1161 // Hash & compare functions, for pessimistic value numbering
1162
1163 // If the hash function returns the special sentinel value NO_HASH,
1164 // the node is guaranteed never to compare equal to any other node.
1165 // If we accidentally generate a hash with value NO_HASH the node
1166 // won't go into the table and we'll lose a little optimization.
1167 static const uint NO_HASH = 0;
1168 virtual uint hash() const;
1169 virtual bool cmp( const Node &n ) const;
1170
1171 // Operation appears to be iteratively computed (such as an induction variable)
1172 // It is possible for this operation to return false for a loop-varying
1173 // value, if it appears (by local graph inspection) to be computed by a simple conditional.
1174 bool is_iteratively_computed();
1175
1176 // Determine if a node is a counted loop induction variable.
1177 // NOTE: The method is defined in "loopnode.cpp".
1178 bool is_cloop_ind_var() const;
1179
1180 // Return a node with opcode "opc" and same inputs as "this" if one can
1181 // be found; Otherwise return null;
1182 Node* find_similar(int opc);
1183
1184 // Return the unique control out if only one. Null if none or more than one.
1185 Node* unique_ctrl_out_or_null() const;
1186 // Return the unique control out. Asserts if none or more than one control out.
1187 Node* unique_ctrl_out() const;
1188
1189 // Set control or add control as precedence edge
1190 void ensure_control_or_add_prec(Node* c);
1191 void add_prec_from(Node* n);
1192
1193 // Visit boundary uses of the node and apply a callback function for each.
1194 // Recursively traverse uses, stopping and applying the callback when
1195 // reaching a boundary node, defined by is_boundary. Note: the function
1196 // definition appears after the complete type definition of Node_List.
1197 template <typename Callback, typename Check>
1198 void visit_uses(Callback callback, Check is_boundary) const;
1199
1200 // Returns a clone of the current node that's pinned (if the current node is not) for nodes found in array accesses
1201 // (Load and range check CastII nodes).
1202 // This is used when an array access is made dependent on 2 or more range checks (range check smearing or Loop Predication).
1203 virtual Node* pin_array_access_node() const {
1204 return nullptr;
1205 }
1206
1207 //----------------- Code Generation
1208
1209 // Ideal register class for Matching. Zero means unmatched instruction
1210 // (these are cloned instead of converted to machine nodes).
1211 virtual uint ideal_reg() const;
1212
1213 static const uint NotAMachineReg; // must be > max. machine register
1214
1215 // Do we Match on this edge index or not? Generally false for Control
1216 // and true for everything else. Weird for calls & returns.
1217 virtual uint match_edge(uint idx) const;
1218
1219 // Register class output is returned in
1220 virtual const RegMask &out_RegMask() const;
1221 // Register class input is expected in
1222 virtual const RegMask &in_RegMask(uint) const;
1223 // Should we clone rather than spill this instruction?
1224 bool rematerialize() const;
1225
1226 // Return JVM State Object if this Node carries debug info, or null otherwise
1227 virtual JVMState* jvms() const;
1228
1229 // Print as assembly
1230 virtual void format( PhaseRegAlloc *, outputStream* st = tty ) const;
1231 // Emit bytes using C2_MacroAssembler
1232 virtual void emit(C2_MacroAssembler *masm, PhaseRegAlloc *ra_) const;
1233 // Size of instruction in bytes
1234 virtual uint size(PhaseRegAlloc *ra_) const;
1235
1236 // Convenience function to extract an integer constant from a node.
1237 // If it is not an integer constant (either Con, CastII, or Mach),
1238 // return value_if_unknown.
1239 jint find_int_con(jint value_if_unknown) const {
1240 const TypeInt* t = find_int_type();
1241 return (t != nullptr && t->is_con()) ? t->get_con() : value_if_unknown;
1242 }
1243 // Return the constant, knowing it is an integer constant already
1244 jint get_int() const {
1245 const TypeInt* t = find_int_type();
1246 guarantee(t != nullptr, "must be con");
1247 return t->get_con();
1248 }
1249 // Here's where the work is done. Can produce non-constant int types too.
1250 const TypeInt* find_int_type() const;
1251 const TypeInteger* find_integer_type(BasicType bt) const;
1252
1253 // Same thing for long (and intptr_t, via type.hpp):
1254 jlong get_long() const {
1255 const TypeLong* t = find_long_type();
1256 guarantee(t != nullptr, "must be con");
1257 return t->get_con();
1258 }
1259 jlong find_long_con(jint value_if_unknown) const {
1260 const TypeLong* t = find_long_type();
1261 return (t != nullptr && t->is_con()) ? t->get_con() : value_if_unknown;
1262 }
1263 const TypeLong* find_long_type() const;
1264
1265 jlong get_integer_as_long(BasicType bt) const {
1266 const TypeInteger* t = find_integer_type(bt);
1267 guarantee(t != nullptr && t->is_con(), "must be con");
1268 return t->get_con_as_long(bt);
1269 }
1270 jlong find_integer_as_long(BasicType bt, jlong value_if_unknown) const {
1271 const TypeInteger* t = find_integer_type(bt);
1272 if (t == nullptr || !t->is_con()) return value_if_unknown;
1273 return t->get_con_as_long(bt);
1274 }
1275 const TypePtr* get_ptr_type() const;
1276
1277 // These guys are called by code generated by ADLC:
1278 intptr_t get_ptr() const;
1279 intptr_t get_narrowcon() const;
1280 jdouble getd() const;
1281 jfloat getf() const;
1282 jshort geth() const;
1283
1284 // Nodes which are pinned into basic blocks
1285 virtual bool pinned() const { return false; }
1286
1287 // Nodes which use memory without consuming it, hence need antidependences
1288 // More specifically, needs_anti_dependence_check returns true iff the node
1289 // (a) does a load, and (b) does not perform a store (except perhaps to a
1290 // stack slot or some other unaliased location).
1291 bool needs_anti_dependence_check() const;
1292
1293 // Return which operand this instruction may cisc-spill. In other words,
1294 // return operand position that can convert from reg to memory access
1295 virtual int cisc_operand() const { return AdlcVMDeps::Not_cisc_spillable; }
1296 bool is_cisc_alternate() const { return (_flags & Flag_is_cisc_alternate) != 0; }
1297
1298 // Whether this is a memory-writing machine node.
1299 bool is_memory_writer() const { return is_Mach() && bottom_type()->has_memory(); }
1300
1301 // Whether this is a memory phi node
1302 bool is_memory_phi() const { return is_Phi() && bottom_type() == Type::MEMORY; }
1303
1304 bool is_div_or_mod(BasicType bt) const;
1305
1306 bool is_pure_function() const;
1307
1308 bool is_data_proj_of_pure_function(const Node* maybe_pure_function) const;
1309
1310 //----------------- Printing, etc
1311 #ifndef PRODUCT
1312 public:
1313 Node* find(int idx, bool only_ctrl = false); // Search the graph for the given idx.
1314 Node* find_ctrl(int idx); // Search control ancestors for the given idx.
1315 void dump_bfs(const int max_distance, Node* target, const char* options, outputStream* st, const frame* fr = nullptr) const;
1316 void dump_bfs(const int max_distance, Node* target, const char* options) const; // directly to tty
1317 void dump_bfs(const int max_distance) const; // dump_bfs(max_distance, nullptr, nullptr)
1318 void dump_bfs(const int max_distance, Node* target, const char* options, void* sp, void* fp, void* pc) const;
1319 class DumpConfig {
1320 public:
1321 // overridden to implement coloring of node idx
1322 virtual void pre_dump(outputStream *st, const Node* n) = 0;
1323 virtual void post_dump(outputStream *st) = 0;
1324 };
1325 void dump_idx(bool align = false, outputStream* st = tty, DumpConfig* dc = nullptr) const;
1326 void dump_name(outputStream* st = tty, DumpConfig* dc = nullptr) const;
1327 void dump() const; // print node with newline
1328 void dump(const char* suffix, bool mark = false, outputStream* st = tty, DumpConfig* dc = nullptr) const; // Print this node.
1329 void dump(int depth) const; // Print this node, recursively to depth d
1330 void dump_ctrl(int depth) const; // Print control nodes, to depth d
1331 void dump_comp() const; // Print this node in compact representation.
1332 // Print this node in compact representation.
1333 void dump_comp(const char* suffix, outputStream *st = tty) const;
1334 private:
1335 virtual void dump_req(outputStream* st = tty, DumpConfig* dc = nullptr) const; // Print required-edge info
1336 virtual void dump_prec(outputStream* st = tty, DumpConfig* dc = nullptr) const; // Print precedence-edge info
1337 virtual void dump_out(outputStream* st = tty, DumpConfig* dc = nullptr) const; // Print the output edge info
1338 public:
1339 virtual void dump_spec(outputStream *st) const {}; // Print per-node info
1340 // Print compact per-node info
1341 virtual void dump_compact_spec(outputStream *st) const { dump_spec(st); }
1342
1343 static void verify(int verify_depth, VectorSet& visited, Node_List& worklist);
1344
1345 // This call defines a class-unique string used to identify class instances
1346 virtual const char *Name() const;
1347
1348 void dump_format(PhaseRegAlloc *ra) const; // debug access to MachNode::format(...)
1349 static bool in_dump() { return Compile::current()->_in_dump_cnt > 0; } // check if we are in a dump call
1350 #endif
1351 #ifdef ASSERT
1352 void verify_construction();
1353 bool verify_jvms(const JVMState* jvms) const;
1354
1355 Node* _debug_orig; // Original version of this, if any.
1356 Node* debug_orig() const { return _debug_orig; }
1357 void set_debug_orig(Node* orig); // _debug_orig = orig
1358 void dump_orig(outputStream *st, bool print_key = true) const;
1359
1360 uint64_t _debug_idx; // Unique value assigned to every node.
1361 uint64_t debug_idx() const { return _debug_idx; }
1362 void set_debug_idx(uint64_t debug_idx) { _debug_idx = debug_idx; }
1363
1364 int _hash_lock; // Barrier to modifications of nodes in the hash table
1365 void enter_hash_lock() { ++_hash_lock; assert(_hash_lock < 99, "in too many hash tables?"); }
1366 void exit_hash_lock() { --_hash_lock; assert(_hash_lock >= 0, "mispaired hash locks"); }
1367
1368 static void init_NodeProperty();
1369
1370 #if OPTO_DU_ITERATOR_ASSERT
1371 const Node* _last_del; // The last deleted node.
1372 uint _del_tick; // Bumped when a deletion happens..
1373 #endif
1374 #endif
1375 };
1376
1377 inline bool not_a_node(const Node* n) {
1378 if (n == nullptr) return true;
1379 if (((intptr_t)n & 1) != 0) return true; // uninitialized, etc.
1380 if (*(address*)n == badAddress) return true; // kill by Node::destruct
1381 return false;
1382 }
1383
1384 //-----------------------------------------------------------------------------
1385 // Iterators over DU info, and associated Node functions.
1386
1387 #if OPTO_DU_ITERATOR_ASSERT
1388
1389 // Common code for assertion checking on DU iterators.
1390 class DUIterator_Common {
1391 #ifdef ASSERT
1392 protected:
1393 bool _vdui; // cached value of VerifyDUIterators
1394 const Node* _node; // the node containing the _out array
1395 uint _outcnt; // cached node->_outcnt
1396 uint _del_tick; // cached node->_del_tick
1397 Node* _last; // last value produced by the iterator
1398
1399 void sample(const Node* node); // used by c'tor to set up for verifies
1400 void verify(const Node* node, bool at_end_ok = false);
1401 void verify_resync();
1402 void reset(const DUIterator_Common& that);
1403
1404 // The VDUI_ONLY macro protects code conditionalized on VerifyDUIterators
1405 #define I_VDUI_ONLY(i,x) { if ((i)._vdui) { x; } }
1406 #else
1407 #define I_VDUI_ONLY(i,x) { }
1408 #endif //ASSERT
1409 };
1410
1411 #define VDUI_ONLY(x) I_VDUI_ONLY(*this, x)
1412
1413 // Default DU iterator. Allows appends onto the out array.
1414 // Allows deletion from the out array only at the current point.
1415 // Usage:
1416 // for (DUIterator i = x->outs(); x->has_out(i); i++) {
1417 // Node* y = x->out(i);
1418 // ...
1419 // }
1420 // Compiles in product mode to a unsigned integer index, which indexes
1421 // onto a repeatedly reloaded base pointer of x->_out. The loop predicate
1422 // also reloads x->_outcnt. If you delete, you must perform "--i" just
1423 // before continuing the loop. You must delete only the last-produced
1424 // edge. You must delete only a single copy of the last-produced edge,
1425 // or else you must delete all copies at once (the first time the edge
1426 // is produced by the iterator).
1427 class DUIterator : public DUIterator_Common {
1428 friend class Node;
1429
1430 // This is the index which provides the product-mode behavior.
1431 // Whatever the product-mode version of the system does to the
1432 // DUI index is done to this index. All other fields in
1433 // this class are used only for assertion checking.
1434 uint _idx;
1435
1436 #ifdef ASSERT
1437 uint _refresh_tick; // Records the refresh activity.
1438
1439 void sample(const Node* node); // Initialize _refresh_tick etc.
1440 void verify(const Node* node, bool at_end_ok = false);
1441 void verify_increment(); // Verify an increment operation.
1442 void verify_resync(); // Verify that we can back up over a deletion.
1443 void verify_finish(); // Verify that the loop terminated properly.
1444 void refresh(); // Resample verification info.
1445 void reset(const DUIterator& that); // Resample after assignment.
1446 #endif
1447
1448 DUIterator(const Node* node, int dummy_to_avoid_conversion)
1449 { _idx = 0; DEBUG_ONLY(sample(node)); }
1450
1451 public:
1452 // initialize to garbage; clear _vdui to disable asserts
1453 DUIterator()
1454 { /*initialize to garbage*/ DEBUG_ONLY(_vdui = false); }
1455
1456 DUIterator(const DUIterator& that)
1457 { _idx = that._idx; DEBUG_ONLY(_vdui = false; reset(that)); }
1458
1459 void operator++(int dummy_to_specify_postfix_op)
1460 { _idx++; VDUI_ONLY(verify_increment()); }
1461
1462 void operator--()
1463 { VDUI_ONLY(verify_resync()); --_idx; }
1464
1465 ~DUIterator()
1466 { VDUI_ONLY(verify_finish()); }
1467
1468 void operator=(const DUIterator& that)
1469 { _idx = that._idx; DEBUG_ONLY(reset(that)); }
1470 };
1471
1472 DUIterator Node::outs() const
1473 { return DUIterator(this, 0); }
1474 DUIterator& Node::refresh_out_pos(DUIterator& i) const
1475 { I_VDUI_ONLY(i, i.refresh()); return i; }
1476 bool Node::has_out(DUIterator& i) const
1477 { I_VDUI_ONLY(i, i.verify(this,true));return i._idx < _outcnt; }
1478 Node* Node::out(DUIterator& i) const
1479 { I_VDUI_ONLY(i, i.verify(this)); return DEBUG_ONLY(i._last=) _out[i._idx]; }
1480
1481
1482 // Faster DU iterator. Disallows insertions into the out array.
1483 // Allows deletion from the out array only at the current point.
1484 // Usage:
1485 // for (DUIterator_Fast imax, i = x->fast_outs(imax); i < imax; i++) {
1486 // Node* y = x->fast_out(i);
1487 // ...
1488 // }
1489 // Compiles in product mode to raw Node** pointer arithmetic, with
1490 // no reloading of pointers from the original node x. If you delete,
1491 // you must perform "--i; --imax" just before continuing the loop.
1492 // If you delete multiple copies of the same edge, you must decrement
1493 // imax, but not i, multiple times: "--i, imax -= num_edges".
1494 class DUIterator_Fast : public DUIterator_Common {
1495 friend class Node;
1496 friend class DUIterator_Last;
1497
1498 // This is the pointer which provides the product-mode behavior.
1499 // Whatever the product-mode version of the system does to the
1500 // DUI pointer is done to this pointer. All other fields in
1501 // this class are used only for assertion checking.
1502 Node** _outp;
1503
1504 #ifdef ASSERT
1505 void verify(const Node* node, bool at_end_ok = false);
1506 void verify_limit();
1507 void verify_resync();
1508 void verify_relimit(uint n);
1509 void reset(const DUIterator_Fast& that);
1510 #endif
1511
1512 // Note: offset must be signed, since -1 is sometimes passed
1513 DUIterator_Fast(const Node* node, ptrdiff_t offset)
1514 { _outp = node->_out + offset; DEBUG_ONLY(sample(node)); }
1515
1516 public:
1517 // initialize to garbage; clear _vdui to disable asserts
1518 DUIterator_Fast()
1519 { /*initialize to garbage*/ DEBUG_ONLY(_vdui = false); }
1520
1521 DUIterator_Fast(const DUIterator_Fast& that)
1522 { _outp = that._outp; DEBUG_ONLY(_vdui = false; reset(that)); }
1523
1524 void operator++(int dummy_to_specify_postfix_op)
1525 { _outp++; VDUI_ONLY(verify(_node, true)); }
1526
1527 void operator--()
1528 { VDUI_ONLY(verify_resync()); --_outp; }
1529
1530 void operator-=(uint n) // applied to the limit only
1531 { _outp -= n; VDUI_ONLY(verify_relimit(n)); }
1532
1533 bool operator<(DUIterator_Fast& limit) {
1534 I_VDUI_ONLY(*this, this->verify(_node, true));
1535 I_VDUI_ONLY(limit, limit.verify_limit());
1536 return _outp < limit._outp;
1537 }
1538
1539 void operator=(const DUIterator_Fast& that)
1540 { _outp = that._outp; DEBUG_ONLY(reset(that)); }
1541 };
1542
1543 DUIterator_Fast Node::fast_outs(DUIterator_Fast& imax) const {
1544 // Assign a limit pointer to the reference argument:
1545 imax = DUIterator_Fast(this, (ptrdiff_t)_outcnt);
1546 // Return the base pointer:
1547 return DUIterator_Fast(this, 0);
1548 }
1549 Node* Node::fast_out(DUIterator_Fast& i) const {
1550 I_VDUI_ONLY(i, i.verify(this));
1551 return DEBUG_ONLY(i._last=) *i._outp;
1552 }
1553
1554
1555 // Faster DU iterator. Requires each successive edge to be removed.
1556 // Does not allow insertion of any edges.
1557 // Usage:
1558 // for (DUIterator_Last imin, i = x->last_outs(imin); i >= imin; i -= num_edges) {
1559 // Node* y = x->last_out(i);
1560 // ...
1561 // }
1562 // Compiles in product mode to raw Node** pointer arithmetic, with
1563 // no reloading of pointers from the original node x.
1564 class DUIterator_Last : private DUIterator_Fast {
1565 friend class Node;
1566
1567 #ifdef ASSERT
1568 void verify(const Node* node, bool at_end_ok = false);
1569 void verify_limit();
1570 void verify_step(uint num_edges);
1571 #endif
1572
1573 // Note: offset must be signed, since -1 is sometimes passed
1574 DUIterator_Last(const Node* node, ptrdiff_t offset)
1575 : DUIterator_Fast(node, offset) { }
1576
1577 void operator++(int dummy_to_specify_postfix_op) {} // do not use
1578 void operator<(int) {} // do not use
1579
1580 public:
1581 DUIterator_Last() { }
1582 // initialize to garbage
1583
1584 DUIterator_Last(const DUIterator_Last& that) = default;
1585
1586 void operator--()
1587 { _outp--; VDUI_ONLY(verify_step(1)); }
1588
1589 void operator-=(uint n)
1590 { _outp -= n; VDUI_ONLY(verify_step(n)); }
1591
1592 bool operator>=(DUIterator_Last& limit) {
1593 I_VDUI_ONLY(*this, this->verify(_node, true));
1594 I_VDUI_ONLY(limit, limit.verify_limit());
1595 return _outp >= limit._outp;
1596 }
1597
1598 DUIterator_Last& operator=(const DUIterator_Last& that) = default;
1599 };
1600
1601 DUIterator_Last Node::last_outs(DUIterator_Last& imin) const {
1602 // Assign a limit pointer to the reference argument:
1603 imin = DUIterator_Last(this, 0);
1604 // Return the initial pointer:
1605 return DUIterator_Last(this, (ptrdiff_t)_outcnt - 1);
1606 }
1607 Node* Node::last_out(DUIterator_Last& i) const {
1608 I_VDUI_ONLY(i, i.verify(this));
1609 return DEBUG_ONLY(i._last=) *i._outp;
1610 }
1611
1612 #endif //OPTO_DU_ITERATOR_ASSERT
1613
1614 #undef I_VDUI_ONLY
1615 #undef VDUI_ONLY
1616
1617 // An Iterator that truly follows the iterator pattern. Doesn't
1618 // support deletion but could be made to.
1619 //
1620 // for (SimpleDUIterator i(n); i.has_next(); i.next()) {
1621 // Node* m = i.get();
1622 //
1623 class SimpleDUIterator : public StackObj {
1624 private:
1625 Node* node;
1626 DUIterator_Fast imax;
1627 DUIterator_Fast i;
1628 public:
1629 SimpleDUIterator(Node* n): node(n), i(n->fast_outs(imax)) {}
1630 bool has_next() { return i < imax; }
1631 void next() { i++; }
1632 Node* get() { return node->fast_out(i); }
1633 };
1634
1635
1636 //-----------------------------------------------------------------------------
1637 // Map dense integer indices to Nodes. Uses classic doubling-array trick.
1638 // Abstractly provides an infinite array of Node*'s, initialized to null.
1639 // Note that the constructor just zeros things, and since I use Arena
1640 // allocation I do not need a destructor to reclaim storage.
1641 class Node_Array : public AnyObj {
1642 protected:
1643 Arena* _a; // Arena to allocate in
1644 uint _max;
1645 Node** _nodes;
1646 ReallocMark _nesting; // Safety checks for arena reallocation
1647
1648 // Grow array to required capacity
1649 void maybe_grow(uint i) {
1650 if (i >= _max) {
1651 grow(i);
1652 }
1653 }
1654 void grow(uint i);
1655
1656 public:
1657 Node_Array(Arena* a, uint max = OptoNodeListSize) : _a(a), _max(max) {
1658 _nodes = NEW_ARENA_ARRAY(a, Node*, max);
1659 clear();
1660 }
1661 Node_Array() : Node_Array(Thread::current()->resource_area()) {}
1662
1663 NONCOPYABLE(Node_Array);
1664 Node_Array& operator=(Node_Array&&) = delete;
1665 // Allow move constructor for && (eg. capture return of function)
1666 Node_Array(Node_Array&&) = default;
1667
1668 Node *operator[] ( uint i ) const // Lookup, or null for not mapped
1669 { return (i<_max) ? _nodes[i] : (Node*)nullptr; }
1670 Node* at(uint i) const { assert(i<_max,"oob"); return _nodes[i]; }
1671 Node** adr() { return _nodes; }
1672 // Extend the mapping: index i maps to Node *n.
1673 void map( uint i, Node *n ) { maybe_grow(i); _nodes[i] = n; }
1674 void insert( uint i, Node *n );
1675 void remove( uint i ); // Remove, preserving order
1676 // Clear all entries in _nodes to null but keep storage
1677 void clear() {
1678 Copy::zero_to_bytes(_nodes, _max * sizeof(Node*));
1679 }
1680
1681 uint max() const { return _max; }
1682 void dump() const;
1683 };
1684
1685 class Node_List : public Node_Array {
1686 uint _cnt;
1687 public:
1688 Node_List(uint max = OptoNodeListSize) : Node_Array(Thread::current()->resource_area(), max), _cnt(0) {}
1689 Node_List(Arena *a, uint max = OptoNodeListSize) : Node_Array(a, max), _cnt(0) {}
1690
1691 NONCOPYABLE(Node_List);
1692 Node_List& operator=(Node_List&&) = delete;
1693 // Allow move constructor for && (eg. capture return of function)
1694 Node_List(Node_List&&) = default;
1695
1696 bool contains(const Node* n) const {
1697 for (uint e = 0; e < size(); e++) {
1698 if (at(e) == n) return true;
1699 }
1700 return false;
1701 }
1702 void insert( uint i, Node *n ) { Node_Array::insert(i,n); _cnt++; }
1703 void remove( uint i ) { Node_Array::remove(i); _cnt--; }
1704 void push( Node *b ) { map(_cnt++,b); }
1705 void yank( Node *n ); // Find and remove
1706 Node *pop() { return _nodes[--_cnt]; }
1707 void clear() { _cnt = 0; Node_Array::clear(); } // retain storage
1708 void copy(const Node_List& from) {
1709 if (from._max > _max) {
1710 grow(from._max);
1711 }
1712 _cnt = from._cnt;
1713 Copy::conjoint_words_to_higher((HeapWord*)&from._nodes[0], (HeapWord*)&_nodes[0], from._max * sizeof(Node*));
1714 }
1715
1716 uint size() const { return _cnt; }
1717 void dump() const;
1718 void dump_simple() const;
1719 };
1720
1721 // Definition must appear after complete type definition of Node_List
1722 template <typename Callback, typename Check>
1723 void Node::visit_uses(Callback callback, Check is_boundary) const {
1724 ResourceMark rm;
1725 VectorSet visited;
1726 Node_List worklist;
1727
1728 // The initial worklist consists of the direct uses
1729 for (DUIterator_Fast kmax, k = fast_outs(kmax); k < kmax; k++) {
1730 Node* out = fast_out(k);
1731 if (!visited.test_set(out->_idx)) { worklist.push(out); }
1732 }
1733
1734 while (worklist.size() > 0) {
1735 Node* use = worklist.pop();
1736 // Apply callback on boundary nodes
1737 if (is_boundary(use)) {
1738 callback(use);
1739 } else {
1740 // Not a boundary node, continue search
1741 for (DUIterator_Fast kmax, k = use->fast_outs(kmax); k < kmax; k++) {
1742 Node* out = use->fast_out(k);
1743 if (!visited.test_set(out->_idx)) { worklist.push(out); }
1744 }
1745 }
1746 }
1747 }
1748
1749
1750 //------------------------------Unique_Node_List-------------------------------
1751 class Unique_Node_List : public Node_List {
1752 VectorSet _in_worklist;
1753 uint _clock_index; // Index in list where to pop from next
1754 public:
1755 Unique_Node_List() : Node_List(), _clock_index(0) {}
1756 Unique_Node_List(Arena *a) : Node_List(a), _in_worklist(a), _clock_index(0) {}
1757
1758 NONCOPYABLE(Unique_Node_List);
1759 Unique_Node_List& operator=(Unique_Node_List&&) = delete;
1760 // Allow move constructor for && (eg. capture return of function)
1761 Unique_Node_List(Unique_Node_List&&) = default;
1762
1763 void remove( Node *n );
1764 bool member(const Node* n) const { return _in_worklist.test(n->_idx) != 0; }
1765 VectorSet& member_set(){ return _in_worklist; }
1766
1767 void push(Node* b) {
1768 if( !_in_worklist.test_set(b->_idx) )
1769 Node_List::push(b);
1770 }
1771 void push_non_cfg_inputs_of(const Node* node) {
1772 for (uint i = 1; i < node->req(); i++) {
1773 Node* input = node->in(i);
1774 if (input != nullptr && !input->is_CFG()) {
1775 push(input);
1776 }
1777 }
1778 }
1779
1780 void push_outputs_of(const Node* node) {
1781 for (DUIterator_Fast imax, i = node->fast_outs(imax); i < imax; i++) {
1782 Node* output = node->fast_out(i);
1783 push(output);
1784 }
1785 }
1786
1787 Node *pop() {
1788 if( _clock_index >= size() ) _clock_index = 0;
1789 Node *b = at(_clock_index);
1790 map( _clock_index, Node_List::pop());
1791 if (size() != 0) _clock_index++; // Always start from 0
1792 _in_worklist.remove(b->_idx);
1793 return b;
1794 }
1795 Node *remove(uint i) {
1796 Node *b = Node_List::at(i);
1797 _in_worklist.remove(b->_idx);
1798 map(i,Node_List::pop());
1799 return b;
1800 }
1801 void yank(Node *n) {
1802 _in_worklist.remove(n->_idx);
1803 Node_List::yank(n);
1804 }
1805 void clear() {
1806 _in_worklist.clear(); // Discards storage but grows automatically
1807 Node_List::clear();
1808 _clock_index = 0;
1809 }
1810 void ensure_empty() {
1811 assert(size() == 0, "must be empty");
1812 clear(); // just in case
1813 }
1814
1815 // Used after parsing to remove useless nodes before Iterative GVN
1816 void remove_useless_nodes(VectorSet& useful);
1817
1818 // If the idx of the Nodes change, we must recompute the VectorSet
1819 void recompute_idx_set() {
1820 _in_worklist.clear();
1821 for (uint i = 0; i < size(); i++) {
1822 Node* n = at(i);
1823 _in_worklist.set(n->_idx);
1824 }
1825 }
1826
1827 #ifdef ASSERT
1828 bool is_subset_of(Unique_Node_List& other) {
1829 for (uint i = 0; i < size(); i++) {
1830 Node* n = at(i);
1831 if (!other.member(n)) {
1832 return false;
1833 }
1834 }
1835 return true;
1836 }
1837 #endif
1838
1839 bool contains(const Node* n) const {
1840 fatal("use faster member() instead");
1841 return false;
1842 }
1843
1844 #ifndef PRODUCT
1845 void print_set() const { _in_worklist.print(); }
1846 #endif
1847 };
1848
1849 // Unique_Mixed_Node_List
1850 // unique: nodes are added only once
1851 // mixed: allow new and old nodes
1852 class Unique_Mixed_Node_List : public ResourceObj {
1853 public:
1854 Unique_Mixed_Node_List() : _visited_set(cmpkey, hashkey) {}
1855
1856 void add(Node* node) {
1857 if (not_a_node(node)) {
1858 return; // Gracefully handle null, -1, 0xabababab, etc.
1859 }
1860 if (_visited_set[node] == nullptr) {
1861 _visited_set.Insert(node, node);
1862 _worklist.push(node);
1863 }
1864 }
1865
1866 Node* operator[] (uint i) const {
1867 return _worklist[i];
1868 }
1869
1870 size_t size() {
1871 return _worklist.size();
1872 }
1873
1874 private:
1875 Dict _visited_set;
1876 Node_List _worklist;
1877 };
1878
1879 // Inline definition of Compile::record_for_igvn must be deferred to this point.
1880 inline void Compile::record_for_igvn(Node* n) {
1881 _igvn_worklist->push(n);
1882 }
1883
1884 // Inline definition of Compile::remove_for_igvn must be deferred to this point.
1885 inline void Compile::remove_for_igvn(Node* n) {
1886 _igvn_worklist->remove(n);
1887 }
1888
1889 //------------------------------Node_Stack-------------------------------------
1890 class Node_Stack {
1891 protected:
1892 struct INode {
1893 Node *node; // Processed node
1894 uint indx; // Index of next node's child
1895 };
1896 INode *_inode_top; // tos, stack grows up
1897 INode *_inode_max; // End of _inodes == _inodes + _max
1898 INode *_inodes; // Array storage for the stack
1899 Arena *_a; // Arena to allocate in
1900 ReallocMark _nesting; // Safety checks for arena reallocation
1901 void grow();
1902 public:
1903 Node_Stack(int size) {
1904 size_t max = (size > OptoNodeListSize) ? size : OptoNodeListSize;
1905 _a = Thread::current()->resource_area();
1906 _inodes = NEW_ARENA_ARRAY( _a, INode, max );
1907 _inode_max = _inodes + max;
1908 _inode_top = _inodes - 1; // stack is empty
1909 }
1910
1911 Node_Stack(Arena *a, int size) : _a(a) {
1912 size_t max = (size > OptoNodeListSize) ? size : OptoNodeListSize;
1913 _inodes = NEW_ARENA_ARRAY( _a, INode, max );
1914 _inode_max = _inodes + max;
1915 _inode_top = _inodes - 1; // stack is empty
1916 }
1917
1918 void pop() {
1919 assert(_inode_top >= _inodes, "node stack underflow");
1920 --_inode_top;
1921 }
1922 void push(Node *n, uint i) {
1923 ++_inode_top;
1924 grow();
1925 INode *top = _inode_top; // optimization
1926 top->node = n;
1927 top->indx = i;
1928 }
1929 Node *node() const {
1930 return _inode_top->node;
1931 }
1932 Node* node_at(uint i) const {
1933 assert(_inodes + i <= _inode_top, "in range");
1934 return _inodes[i].node;
1935 }
1936 uint index() const {
1937 return _inode_top->indx;
1938 }
1939 uint index_at(uint i) const {
1940 assert(_inodes + i <= _inode_top, "in range");
1941 return _inodes[i].indx;
1942 }
1943 void set_node(Node *n) {
1944 _inode_top->node = n;
1945 }
1946 void set_index(uint i) {
1947 _inode_top->indx = i;
1948 }
1949 uint size_max() const { return (uint)pointer_delta(_inode_max, _inodes, sizeof(INode)); } // Max size
1950 uint size() const { return (uint)pointer_delta((_inode_top+1), _inodes, sizeof(INode)); } // Current size
1951 bool is_nonempty() const { return (_inode_top >= _inodes); }
1952 bool is_empty() const { return (_inode_top < _inodes); }
1953 void clear() { _inode_top = _inodes - 1; } // retain storage
1954
1955 // Node_Stack is used to map nodes.
1956 Node* find(uint idx) const;
1957
1958 NONCOPYABLE(Node_Stack);
1959 };
1960
1961
1962 //-----------------------------Node_Notes--------------------------------------
1963 // Debugging or profiling annotations loosely and sparsely associated
1964 // with some nodes. See Compile::node_notes_at for the accessor.
1965 class Node_Notes {
1966 JVMState* _jvms;
1967
1968 public:
1969 Node_Notes(JVMState* jvms = nullptr) {
1970 _jvms = jvms;
1971 }
1972
1973 JVMState* jvms() { return _jvms; }
1974 void set_jvms(JVMState* x) { _jvms = x; }
1975
1976 // True if there is nothing here.
1977 bool is_clear() {
1978 return (_jvms == nullptr);
1979 }
1980
1981 // Make there be nothing here.
1982 void clear() {
1983 _jvms = nullptr;
1984 }
1985
1986 // Make a new, clean node notes.
1987 static Node_Notes* make(Compile* C) {
1988 Node_Notes* nn = NEW_ARENA_ARRAY(C->comp_arena(), Node_Notes, 1);
1989 nn->clear();
1990 return nn;
1991 }
1992
1993 Node_Notes* clone(Compile* C) {
1994 Node_Notes* nn = NEW_ARENA_ARRAY(C->comp_arena(), Node_Notes, 1);
1995 (*nn) = (*this);
1996 return nn;
1997 }
1998
1999 // Absorb any information from source.
2000 bool update_from(Node_Notes* source) {
2001 bool changed = false;
2002 if (source != nullptr) {
2003 if (source->jvms() != nullptr) {
2004 set_jvms(source->jvms());
2005 changed = true;
2006 }
2007 }
2008 return changed;
2009 }
2010 };
2011
2012 // Inlined accessors for Compile::node_nodes that require the preceding class:
2013 inline Node_Notes*
2014 Compile::locate_node_notes(GrowableArray<Node_Notes*>* arr,
2015 int idx, bool can_grow) {
2016 assert(idx >= 0, "oob");
2017 int block_idx = (idx >> _log2_node_notes_block_size);
2018 int grow_by = (block_idx - (arr == nullptr? 0: arr->length()));
2019 if (grow_by >= 0) {
2020 if (!can_grow) return nullptr;
2021 grow_node_notes(arr, grow_by + 1);
2022 }
2023 if (arr == nullptr) return nullptr;
2024 // (Every element of arr is a sub-array of length _node_notes_block_size.)
2025 return arr->at(block_idx) + (idx & (_node_notes_block_size-1));
2026 }
2027
2028 inline Node_Notes* Compile::node_notes_at(int idx) {
2029 return locate_node_notes(_node_note_array, idx, false);
2030 }
2031
2032 inline bool
2033 Compile::set_node_notes_at(int idx, Node_Notes* value) {
2034 if (value == nullptr || value->is_clear())
2035 return false; // nothing to write => write nothing
2036 Node_Notes* loc = locate_node_notes(_node_note_array, idx, true);
2037 assert(loc != nullptr, "");
2038 return loc->update_from(value);
2039 }
2040
2041
2042 //------------------------------TypeNode---------------------------------------
2043 // Node with a Type constant.
2044 class TypeNode : public Node {
2045 protected:
2046 virtual uint hash() const; // Check the type
2047 virtual bool cmp( const Node &n ) const;
2048 virtual uint size_of() const; // Size is bigger
2049 const Type* const _type;
2050 public:
2051 void set_type(const Type* t) {
2052 assert(t != nullptr, "sanity");
2053 DEBUG_ONLY(uint check_hash = (VerifyHashTableKeys && _hash_lock) ? hash() : NO_HASH);
2054 *(const Type**)&_type = t; // cast away const-ness
2055 // If this node is in the hash table, make sure it doesn't need a rehash.
2056 assert(check_hash == NO_HASH || check_hash == hash(), "type change must preserve hash code");
2057 }
2058 const Type* type() const { assert(_type != nullptr, "sanity"); return _type; };
2059 TypeNode( const Type *t, uint required ) : Node(required), _type(t) {
2060 init_class_id(Class_Type);
2061 }
2062 virtual const Type* Value(PhaseGVN* phase) const;
2063 virtual Node* Ideal(PhaseGVN* phase, bool can_reshape);
2064 virtual const Type *bottom_type() const;
2065 virtual uint ideal_reg() const;
2066
2067 void make_path_dead(PhaseIterGVN* igvn, PhaseIdealLoop* loop, Node* ctrl_use, uint j, const char* phase_str);
2068 #ifndef PRODUCT
2069 virtual void dump_spec(outputStream *st) const;
2070 virtual void dump_compact_spec(outputStream *st) const;
2071 #endif
2072 void make_paths_from_here_dead(PhaseIterGVN* igvn, PhaseIdealLoop* loop, const char* phase_str);
2073 void create_halt_path(PhaseIterGVN* igvn, Node* c, PhaseIdealLoop* loop, const char* phase_str) const;
2074 };
2075
2076 #include "opto/opcodes.hpp"
2077
2078 #define Op_IL(op) \
2079 inline int Op_ ## op(BasicType bt) { \
2080 assert(bt == T_INT || bt == T_LONG, "only for int or longs"); \
2081 if (bt == T_INT) { \
2082 return Op_## op ## I; \
2083 } \
2084 return Op_## op ## L; \
2085 }
2086
2087 Op_IL(Add)
2088 Op_IL(And)
2089 Op_IL(Sub)
2090 Op_IL(Mul)
2091 Op_IL(URShift)
2092 Op_IL(LShift)
2093 Op_IL(Xor)
2094 Op_IL(Cmp)
2095 Op_IL(Div)
2096 Op_IL(Mod)
2097 Op_IL(UDiv)
2098 Op_IL(UMod)
2099
2100 inline int Op_ConIL(BasicType bt) {
2101 assert(bt == T_INT || bt == T_LONG, "only for int or longs");
2102 if (bt == T_INT) {
2103 return Op_ConI;
2104 }
2105 return Op_ConL;
2106 }
2107
2108 inline int Op_Cmp_unsigned(BasicType bt) {
2109 assert(bt == T_INT || bt == T_LONG, "only for int or longs");
2110 if (bt == T_INT) {
2111 return Op_CmpU;
2112 }
2113 return Op_CmpUL;
2114 }
2115
2116 inline int Op_Cast(BasicType bt) {
2117 assert(bt == T_INT || bt == T_LONG, "only for int or longs");
2118 if (bt == T_INT) {
2119 return Op_CastII;
2120 }
2121 return Op_CastLL;
2122 }
2123
2124 inline int Op_DivIL(BasicType bt, bool is_unsigned) {
2125 assert(bt == T_INT || bt == T_LONG, "only for int or longs");
2126 if (bt == T_INT) {
2127 if (is_unsigned) {
2128 return Op_UDivI;
2129 } else {
2130 return Op_DivI;
2131 }
2132 }
2133 if (is_unsigned) {
2134 return Op_UDivL;
2135 } else {
2136 return Op_DivL;
2137 }
2138 }
2139
2140 inline int Op_DivModIL(BasicType bt, bool is_unsigned) {
2141 assert(bt == T_INT || bt == T_LONG, "only for int or longs");
2142 if (bt == T_INT) {
2143 if (is_unsigned) {
2144 return Op_UDivModI;
2145 } else {
2146 return Op_DivModI;
2147 }
2148 }
2149 if (is_unsigned) {
2150 return Op_UDivModL;
2151 } else {
2152 return Op_DivModL;
2153 }
2154 }
2155
2156 // Interface to define actions that should be taken when running DataNodeBFS. Each use can extend this class to specify
2157 // a customized BFS.
2158 class BFSActions : public StackObj {
2159 public:
2160 // Should a node's inputs further be visited in the BFS traversal? By default, we visit all data inputs. Override this
2161 // method to provide a custom filter.
2162 virtual bool should_visit(Node* node) const {
2163 // By default, visit all inputs.
2164 return true;
2165 };
2166
2167 // Is the visited node a target node that we are looking for in the BFS traversal? We do not visit its inputs further
2168 // but the BFS will continue to visit all unvisited nodes in the queue.
2169 virtual bool is_target_node(Node* node) const = 0;
2170
2171 // Defines an action that should be taken when we visit a target node in the BFS traversal.
2172 virtual void target_node_action(Node* target_node) = 0;
2173 };
2174
2175 // Class to perform a BFS traversal on the data nodes from a given start node. The provided BFSActions guide which
2176 // data node's inputs should be further visited, which data nodes are target nodes and what to do with the target nodes.
2177 class DataNodeBFS : public StackObj {
2178 BFSActions& _bfs_actions;
2179
2180 public:
2181 explicit DataNodeBFS(BFSActions& bfs_action) : _bfs_actions(bfs_action) {}
2182
2183 // Run the BFS starting from 'start_node' and apply the actions provided to this class.
2184 void run(Node* start_node) {
2185 ResourceMark rm;
2186 Unique_Node_List _nodes_to_visit;
2187 _nodes_to_visit.push(start_node);
2188 for (uint i = 0; i < _nodes_to_visit.size(); i++) {
2189 Node* next = _nodes_to_visit[i];
2190 for (uint j = 1; j < next->req(); j++) {
2191 Node* input = next->in(j);
2192 if (_bfs_actions.is_target_node(input)) {
2193 assert(_bfs_actions.should_visit(input), "must also pass node filter");
2194 _bfs_actions.target_node_action(input);
2195 } else if (_bfs_actions.should_visit(input)) {
2196 _nodes_to_visit.push(input);
2197 }
2198 }
2199 }
2200 }
2201 };
2202
2203 #endif // SHARE_OPTO_NODE_HPP