1/*
2 * Copyright (c) 1997, 2018, 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#include "precompiled.hpp"
26#include "opto/callnode.hpp"
27#include "opto/cfgnode.hpp"
28#include "opto/matcher.hpp"
29#include "opto/mathexactnode.hpp"
30#include "opto/multnode.hpp"
31#include "opto/opcodes.hpp"
32#include "opto/phaseX.hpp"
33#include "opto/regmask.hpp"
34#include "opto/type.hpp"
35#include "utilities/vmError.hpp"
36
37//=============================================================================
38//------------------------------MultiNode--------------------------------------
39const RegMask &MultiNode::out_RegMask() const {
40 return RegMask::Empty;
41}
42
43Node *MultiNode::match( const ProjNode *proj, const Matcher *m ) { return proj->clone(); }
44
45//------------------------------proj_out---------------------------------------
46// Get a named projection or null if not found
47ProjNode* MultiNode::proj_out_or_null(uint which_proj) const {
48 assert((Opcode() != Op_If && Opcode() != Op_RangeCheck) || which_proj == (uint)true || which_proj == (uint)false, "must be 1 or 0");
49 assert((Opcode() != Op_If && Opcode() != Op_RangeCheck) || outcnt() == 2, "bad if #1");
50 for( DUIterator_Fast imax, i = fast_outs(imax); i < imax; i++ ) {
51 Node *p = fast_out(i);
52 if (p->is_Proj()) {
53 ProjNode *proj = p->as_Proj();
54 if (proj->_con == which_proj) {
55 assert((Opcode() != Op_If && Opcode() != Op_RangeCheck) || proj->Opcode() == (which_proj ? Op_IfTrue : Op_IfFalse), "bad if #2");
56 return proj;
57 }
58 } else {
59 assert(p == this && this->is_Start(), "else must be proj");
60 continue;
61 }
62 }
63 return NULL;
64}
65
66// Get a named projection
67ProjNode* MultiNode::proj_out(uint which_proj) const {
68 ProjNode* p = proj_out_or_null(which_proj);
69 assert(p != NULL, "named projection %u not found", which_proj);
70 return p;
71}
72
73//=============================================================================
74//------------------------------ProjNode---------------------------------------
75uint ProjNode::hash() const {
76 // only one input
77 return (uintptr_t)in(TypeFunc::Control) + (_con << 1) + (_is_io_use ? 1 : 0);
78}
79bool ProjNode::cmp( const Node &n ) const { return _con == ((ProjNode&)n)._con && ((ProjNode&)n)._is_io_use == _is_io_use; }
80uint ProjNode::size_of() const { return sizeof(ProjNode); }
81
82// Test if we propagate interesting control along this projection
83bool ProjNode::is_CFG() const {
84 Node *def = in(0);
85 return (_con == TypeFunc::Control && def->is_CFG());
86}
87
88const Type* ProjNode::proj_type(const Type* t) const {
89 if (t == Type::TOP) {
90 return Type::TOP;
91 }
92 if (t == Type::BOTTOM) {
93 return Type::BOTTOM;
94 }
95 t = t->is_tuple()->field_at(_con);
96 Node* n = in(0);
97 if ((_con == TypeFunc::Parms) &&
98 n->is_CallStaticJava() && n->as_CallStaticJava()->is_boxing_method()) {
99 // The result of autoboxing is always non-null on normal path.
100 t = t->join_speculative(TypePtr::NOTNULL);
101 }
102 return t;
103}
104
105const Type *ProjNode::bottom_type() const {
106 if (in(0) == NULL) return Type::TOP;
107 return proj_type(in(0)->bottom_type());
108}
109
110const TypePtr *ProjNode::adr_type() const {
111 if (bottom_type() == Type::MEMORY) {
112 // in(0) might be a narrow MemBar; otherwise we will report TypePtr::BOTTOM
113 Node* ctrl = in(0);
114 if (ctrl == NULL) return NULL; // node is dead
115 const TypePtr* adr_type = ctrl->adr_type();
116 #ifdef ASSERT
117 if (!VMError::is_error_reported() && !Node::in_dump())
118 assert(adr_type != NULL, "source must have adr_type");
119 #endif
120 return adr_type;
121 }
122 assert(bottom_type()->base() != Type::Memory, "no other memories?");
123 return NULL;
124}
125
126bool ProjNode::pinned() const { return in(0)->pinned(); }
127#ifndef PRODUCT
128void ProjNode::dump_spec(outputStream *st) const { st->print("#%d",_con); if(_is_io_use) st->print(" (i_o_use)");}
129
130void ProjNode::dump_compact_spec(outputStream *st) const {
131 for (DUIterator i = this->outs(); this->has_out(i); i++) {
132 Node* o = this->out(i);
133 if (NotANode(o)) {
134 st->print("[?]");
135 } else if (o == NULL) {
136 st->print("[_]");
137 } else {
138 st->print("[%d]", o->_idx);
139 }
140 }
141 st->print("#%d", _con);
142}
143#endif
144
145//----------------------------check_con----------------------------------------
146void ProjNode::check_con() const {
147 Node* n = in(0);
148 if (n == NULL) return; // should be assert, but NodeHash makes bogons
149 if (n->is_Mach()) return; // mach. projs. are not type-safe
150 if (n->is_Start()) return; // alas, starts can have mach. projs. also
151 if (_con == SCMemProjNode::SCMEMPROJCON ) return;
152 const Type* t = n->bottom_type();
153 if (t == Type::TOP) return; // multi is dead
154 assert(_con < t->is_tuple()->cnt(), "ProjNode::_con must be in range");
155}
156
157//------------------------------Value------------------------------------------
158const Type* ProjNode::Value(PhaseGVN* phase) const {
159 if (in(0) == NULL) return Type::TOP;
160 return proj_type(phase->type(in(0)));
161}
162
163//------------------------------out_RegMask------------------------------------
164// Pass the buck uphill
165const RegMask &ProjNode::out_RegMask() const {
166 return RegMask::Empty;
167}
168
169//------------------------------ideal_reg--------------------------------------
170uint ProjNode::ideal_reg() const {
171 return bottom_type()->ideal_reg();
172}
173
174//-------------------------------is_uncommon_trap_proj----------------------------
175// Return uncommon trap call node if proj is for "proj->[region->..]call_uct"
176// NULL otherwise
177CallStaticJavaNode* ProjNode::is_uncommon_trap_proj(Deoptimization::DeoptReason reason) {
178 int path_limit = 10;
179 Node* out = this;
180 for (int ct = 0; ct < path_limit; ct++) {
181 out = out->unique_ctrl_out();
182 if (out == NULL)
183 return NULL;
184 if (out->is_CallStaticJava()) {
185 CallStaticJavaNode* call = out->as_CallStaticJava();
186 int req = call->uncommon_trap_request();
187 if (req != 0) {
188 Deoptimization::DeoptReason trap_reason = Deoptimization::trap_request_reason(req);
189 if (trap_reason == reason || reason == Deoptimization::Reason_none) {
190 return call;
191 }
192 }
193 return NULL; // don't do further after call
194 }
195 if (out->Opcode() != Op_Region)
196 return NULL;
197 }
198 return NULL;
199}
200
201//-------------------------------is_uncommon_trap_if_pattern-------------------------
202// Return uncommon trap call node for "if(test)-> proj -> ...
203// |
204// V
205// other_proj->[region->..]call_uct"
206// NULL otherwise
207// "must_reason_predicate" means the uct reason must be Reason_predicate
208CallStaticJavaNode* ProjNode::is_uncommon_trap_if_pattern(Deoptimization::DeoptReason reason) {
209 Node *in0 = in(0);
210 if (!in0->is_If()) return NULL;
211 // Variation of a dead If node.
212 if (in0->outcnt() < 2) return NULL;
213 IfNode* iff = in0->as_If();
214
215 // we need "If(Conv2B(Opaque1(...)))" pattern for reason_predicate
216 if (reason != Deoptimization::Reason_none) {
217 if (iff->in(1)->Opcode() != Op_Conv2B ||
218 iff->in(1)->in(1)->Opcode() != Op_Opaque1) {
219 return NULL;
220 }
221 }
222
223 ProjNode* other_proj = iff->proj_out(1-_con);
224 CallStaticJavaNode* call = other_proj->is_uncommon_trap_proj(reason);
225 if (call != NULL) {
226 assert(reason == Deoptimization::Reason_none ||
227 Compile::current()->is_predicate_opaq(iff->in(1)->in(1)), "should be on the list");
228 return call;
229 }
230 return NULL;
231}
232
233ProjNode* ProjNode::other_if_proj() const {
234 assert(_con == 0 || _con == 1, "not an if?");
235 return in(0)->as_If()->proj_out(1-_con);
236}
237