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