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