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