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