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