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