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