1 /*
2 * Copyright (c) 2014, 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/addnode.hpp"
27 #include "opto/callnode.hpp"
28 #include "opto/castnode.hpp"
29 #include "opto/connode.hpp"
30 #include "opto/matcher.hpp"
31 #include "opto/phaseX.hpp"
32 #include "opto/subnode.hpp"
33 #include "opto/type.hpp"
34
35 //=============================================================================
36 // If input is already higher or equal to cast type, then this is an identity.
37 Node* ConstraintCastNode::Identity(PhaseGVN* phase) {
38 Node* dom = dominating_cast(phase, phase);
39 if (dom != NULL) {
40 return dom;
41 }
42 if (_dependency != RegularDependency) {
43 return this;
44 }
45 return phase->type(in(1))->higher_equal_speculative(_type) ? in(1) : this;
46 }
47
48 //------------------------------Value------------------------------------------
49 // Take 'join' of input and cast-up type
50 const Type* ConstraintCastNode::Value(PhaseGVN* phase) const {
51 if (in(0) && phase->type(in(0)) == Type::TOP) return Type::TOP;
52 const Type* ft = phase->type(in(1))->filter_speculative(_type);
53
54 #ifdef ASSERT
55 // Previous versions of this function had some special case logic,
56 // which is no longer necessary. Make sure of the required effects.
57 switch (Opcode()) {
58 case Op_CastII:
59 {
60 const Type* t1 = phase->type(in(1));
61 if( t1 == Type::TOP ) assert(ft == Type::TOP, "special case #1");
62 const Type* rt = t1->join_speculative(_type);
63 if (rt->empty()) assert(ft == Type::TOP, "special case #2");
64 break;
65 }
66 case Op_CastPP:
67 if (phase->type(in(1)) == TypePtr::NULL_PTR &&
68 _type->isa_ptr() && _type->is_ptr()->_ptr == TypePtr::NotNull)
69 assert(ft == Type::TOP, "special case #3");
70 break;
71 }
72 #endif //ASSERT
73
74 return ft;
75 }
76
77 //------------------------------Ideal------------------------------------------
78 // Return a node which is more "ideal" than the current node. Strip out
79 // control copies
80 Node *ConstraintCastNode::Ideal(PhaseGVN *phase, bool can_reshape) {
81 return (in(0) && remove_dead_region(phase, can_reshape)) ? this : NULL;
82 }
83
84 bool ConstraintCastNode::cmp(const Node &n) const {
85 return TypeNode::cmp(n) && ((ConstraintCastNode&)n)._dependency == _dependency;
86 }
87
88 uint ConstraintCastNode::size_of() const {
89 return sizeof(*this);
90 }
91
92 Node* ConstraintCastNode::make_cast(int opcode, Node* c, Node *n, const Type *t, DependencyType dependency) {
93 switch(opcode) {
94 case Op_CastII: {
95 Node* cast = new CastIINode(n, t, dependency);
96 cast->set_req(0, c);
97 return cast;
98 }
99 case Op_CastLL: {
100 Node* cast = new CastLLNode(n, t, dependency);
101 cast->set_req(0, c);
102 return cast;
103 }
104 case Op_CastPP: {
105 Node* cast = new CastPPNode(n, t, dependency);
106 cast->set_req(0, c);
107 return cast;
108 }
109 case Op_CastFF: {
110 Node* cast = new CastFFNode(n, t, dependency);
111 cast->set_req(0, c);
112 return cast;
113 }
114 case Op_CastDD: {
115 Node* cast = new CastDDNode(n, t, dependency);
116 cast->set_req(0, c);
117 return cast;
118 }
119 case Op_CastVV: {
120 Node* cast = new CastVVNode(n, t, dependency);
121 cast->set_req(0, c);
122 return cast;
123 }
124 case Op_CheckCastPP: return new CheckCastPPNode(c, n, t, dependency);
125 default:
126 fatal("Bad opcode %d", opcode);
127 }
128 return NULL;
129 }
130
131 Node* ConstraintCastNode::make(Node* c, Node *n, const Type *t, BasicType bt) {
132 switch(bt) {
133 case T_INT: {
134 return make_cast(Op_CastII, c, n, t, RegularDependency);
135 }
136 case T_LONG: {
137 return make_cast(Op_CastLL, c, n, t, RegularDependency);
138 }
139 default:
140 fatal("Bad basic type %s", type2name(bt));
141 }
142 return NULL;
143 }
144
145 TypeNode* ConstraintCastNode::dominating_cast(PhaseGVN* gvn, PhaseTransform* pt) const {
146 if (_dependency == UnconditionalDependency) {
147 return NULL;
148 }
149 Node* val = in(1);
150 Node* ctl = in(0);
151 int opc = Opcode();
152 if (ctl == NULL) {
153 return NULL;
154 }
155 // Range check CastIIs may all end up under a single range check and
156 // in that case only the narrower CastII would be kept by the code
157 // below which would be incorrect.
158 if (is_CastII() && as_CastII()->has_range_check()) {
159 return NULL;
160 }
161 if (type()->isa_rawptr() && (gvn->type_or_null(val) == NULL || gvn->type(val)->isa_oopptr())) {
162 return NULL;
163 }
164 for (DUIterator_Fast imax, i = val->fast_outs(imax); i < imax; i++) {
165 Node* u = val->fast_out(i);
166 if (u != this &&
167 u->outcnt() > 0 &&
168 u->Opcode() == opc &&
169 u->in(0) != NULL &&
170 u->bottom_type()->higher_equal(type())) {
171 if (pt->is_dominator(u->in(0), ctl)) {
172 return u->as_Type();
173 }
174 if (is_CheckCastPP() && u->in(1)->is_Proj() && u->in(1)->in(0)->is_Allocate() &&
175 u->in(0)->is_Proj() && u->in(0)->in(0)->is_Initialize() &&
176 u->in(1)->in(0)->as_Allocate()->initialization() == u->in(0)->in(0)) {
177 // CheckCastPP following an allocation always dominates all
178 // use of the allocation result
179 return u->as_Type();
180 }
181 }
182 }
183 return NULL;
184 }
185
186 #ifndef PRODUCT
187 void ConstraintCastNode::dump_spec(outputStream *st) const {
188 TypeNode::dump_spec(st);
189 if (_dependency != RegularDependency) {
190 st->print(" %s dependency", _dependency == StrongDependency ? "strong" : "unconditional");
191 }
192 }
193 #endif
194
195 const Type* CastIINode::Value(PhaseGVN* phase) const {
196 const Type *res = ConstraintCastNode::Value(phase);
197 if (res == Type::TOP) {
198 return Type::TOP;
199 }
200 assert(res->isa_int(), "res must be int");
201
202 // Similar to ConvI2LNode::Value() for the same reasons
203 // see if we can remove type assertion after loop opts
204 // But here we have to pay extra attention:
205 // Do not narrow the type of range check dependent CastIINodes to
206 // avoid corruption of the graph if a CastII is replaced by TOP but
207 // the corresponding range check is not removed.
208 if (!_range_check_dependency && phase->C->post_loop_opts_phase()) {
209 const TypeInt* this_type = res->is_int();
210 const TypeInt* in_type = phase->type(in(1))->isa_int();
211 if (in_type != NULL &&
212 (in_type->_lo != this_type->_lo ||
213 in_type->_hi != this_type->_hi)) {
214 jint lo1 = this_type->_lo;
215 jint hi1 = this_type->_hi;
216 int w1 = this_type->_widen;
217 if (lo1 >= 0) {
218 // Keep a range assertion of >=0.
219 lo1 = 0; hi1 = max_jint;
220 } else if (hi1 < 0) {
221 // Keep a range assertion of <0.
222 lo1 = min_jint; hi1 = -1;
223 } else {
224 lo1 = min_jint; hi1 = max_jint;
225 }
226 res = TypeInt::make(MAX2(in_type->_lo, lo1),
227 MIN2(in_type->_hi, hi1),
228 MAX2((int)in_type->_widen, w1));
229 }
230 }
231
232 // Try to improve the type of the CastII if we recognize a CmpI/If
233 // pattern.
234 if (_dependency != RegularDependency) {
235 if (in(0) != NULL && in(0)->in(0) != NULL && in(0)->in(0)->is_If()) {
236 assert(in(0)->is_IfFalse() || in(0)->is_IfTrue(), "should be If proj");
237 Node* proj = in(0);
238 if (proj->in(0)->in(1)->is_Bool()) {
239 Node* b = proj->in(0)->in(1);
240 if (b->in(1)->Opcode() == Op_CmpI) {
241 Node* cmp = b->in(1);
242 if (cmp->in(1) == in(1) && phase->type(cmp->in(2))->isa_int()) {
243 const TypeInt* in2_t = phase->type(cmp->in(2))->is_int();
244 const Type* t = TypeInt::INT;
245 BoolTest test = b->as_Bool()->_test;
246 if (proj->is_IfFalse()) {
247 test = test.negate();
248 }
249 BoolTest::mask m = test._test;
250 jlong lo_long = min_jint;
251 jlong hi_long = max_jint;
252 if (m == BoolTest::le || m == BoolTest::lt) {
253 hi_long = in2_t->_hi;
254 if (m == BoolTest::lt) {
255 hi_long -= 1;
256 }
257 } else if (m == BoolTest::ge || m == BoolTest::gt) {
258 lo_long = in2_t->_lo;
259 if (m == BoolTest::gt) {
260 lo_long += 1;
261 }
262 } else if (m == BoolTest::eq) {
263 lo_long = in2_t->_lo;
264 hi_long = in2_t->_hi;
265 } else if (m == BoolTest::ne) {
266 // can't do any better
267 } else {
268 stringStream ss;
269 test.dump_on(&ss);
270 fatal("unexpected comparison %s", ss.as_string());
271 }
272 int lo_int = (int)lo_long;
273 int hi_int = (int)hi_long;
274
275 if (lo_long != (jlong)lo_int) {
276 lo_int = min_jint;
277 }
278 if (hi_long != (jlong)hi_int) {
279 hi_int = max_jint;
280 }
281
282 t = TypeInt::make(lo_int, hi_int, Type::WidenMax);
283
284 res = res->filter_speculative(t);
285 return res;
286 }
287 }
288 }
289 }
290 }
291 return res;
292 }
293
294 static Node* find_or_make_CastII(PhaseIterGVN* igvn, Node* parent, Node* control, const TypeInt* type, ConstraintCastNode::DependencyType dependency) {
295 Node* n = new CastIINode(parent, type, dependency);
296 n->set_req(0, control);
297 Node* existing = igvn->hash_find_insert(n);
298 if (existing != NULL) {
299 n->destruct(igvn);
300 return existing;
301 }
302 return igvn->register_new_node_with_optimizer(n);
303 }
304
305 Node *CastIINode::Ideal(PhaseGVN *phase, bool can_reshape) {
306 Node* progress = ConstraintCastNode::Ideal(phase, can_reshape);
307 if (progress != NULL) {
308 return progress;
309 }
310 if (can_reshape && !_range_check_dependency && !phase->C->post_loop_opts_phase()) {
311 // makes sure we run ::Value to potentially remove type assertion after loop opts
312 phase->C->record_for_post_loop_opts_igvn(this);
313 }
314 PhaseIterGVN* igvn = phase->is_IterGVN();
315 const TypeInt* this_type = this->type()->is_int();
316 Node* z = in(1);
317 const TypeInteger* rx = NULL;
318 const TypeInteger* ry = NULL;
319 // Similar to ConvI2LNode::Ideal() for the same reasons
320 if (!_range_check_dependency && Compile::push_thru_add(phase, z, this_type, rx, ry, T_INT)) {
321 if (igvn == NULL) {
322 // Postpone this optimization to iterative GVN, where we can handle deep
323 // AddI chains without an exponential number of recursive Ideal() calls.
324 phase->record_for_igvn(this);
325 return NULL;
326 }
327 int op = z->Opcode();
328 Node* x = z->in(1);
329 Node* y = z->in(2);
330
331 Node* cx = find_or_make_CastII(igvn, x, in(0), rx->is_int(), _dependency);
332 Node* cy = find_or_make_CastII(igvn, y, in(0), ry->is_int(), _dependency);
333 switch (op) {
334 case Op_AddI: return new AddINode(cx, cy);
335 case Op_SubI: return new SubINode(cx, cy);
336 default: ShouldNotReachHere();
337 }
338 }
339 return NULL;
340 }
341
342 Node* CastIINode::Identity(PhaseGVN* phase) {
343 Node* progress = ConstraintCastNode::Identity(phase);
344 if (progress != this) {
345 return progress;
346 }
347 if (_range_check_dependency) {
348 if (phase->C->post_loop_opts_phase()) {
349 return this->in(1);
350 } else {
351 phase->C->record_for_post_loop_opts_igvn(this);
352 }
353 }
354 return this;
355 }
356
357 bool CastIINode::cmp(const Node &n) const {
358 return ConstraintCastNode::cmp(n) && ((CastIINode&)n)._range_check_dependency == _range_check_dependency;
359 }
360
361 uint CastIINode::size_of() const {
362 return sizeof(*this);
363 }
364
365 #ifndef PRODUCT
366 void CastIINode::dump_spec(outputStream* st) const {
367 ConstraintCastNode::dump_spec(st);
368 if (_range_check_dependency) {
369 st->print(" range check dependency");
370 }
371 }
372 #endif
373
374 //=============================================================================
375 //------------------------------Identity---------------------------------------
376 // If input is already higher or equal to cast type, then this is an identity.
377 Node* CheckCastPPNode::Identity(PhaseGVN* phase) {
378 Node* dom = dominating_cast(phase, phase);
379 if (dom != NULL) {
380 return dom;
381 }
382 if (_dependency != RegularDependency) {
383 return this;
384 }
385 const Type* t = phase->type(in(1));
386 if (EnableVectorReboxing && in(1)->Opcode() == Op_VectorBox) {
387 if (t->higher_equal_speculative(phase->type(this))) {
388 return in(1);
389 }
390 } else if (t == phase->type(this)) {
391 // Toned down to rescue meeting at a Phi 3 different oops all implementing
392 // the same interface.
393 return in(1);
394 }
395 return this;
396 }
397
398 //------------------------------Value------------------------------------------
399 // Take 'join' of input and cast-up type, unless working with an Interface
400 const Type* CheckCastPPNode::Value(PhaseGVN* phase) const {
401 if( in(0) && phase->type(in(0)) == Type::TOP ) return Type::TOP;
402
403 const Type *inn = phase->type(in(1));
404 if( inn == Type::TOP ) return Type::TOP; // No information yet
405
406 const TypePtr *in_type = inn->isa_ptr();
407 const TypePtr *my_type = _type->isa_ptr();
408 const Type *result = _type;
409 if( in_type != NULL && my_type != NULL ) {
410 TypePtr::PTR in_ptr = in_type->ptr();
411 if (in_ptr == TypePtr::Null) {
412 result = in_type;
413 } else if (in_ptr == TypePtr::Constant) {
414 if (my_type->isa_rawptr()) {
415 result = my_type;
416 } else {
417 const TypeOopPtr *jptr = my_type->isa_oopptr();
418 assert(jptr, "");
419 result = !in_type->higher_equal(_type)
420 ? my_type->cast_to_ptr_type(TypePtr::NotNull)
421 : in_type;
422 }
423 } else {
424 result = my_type->cast_to_ptr_type( my_type->join_ptr(in_ptr) );
425 }
426 }
427
428 // This is the code from TypePtr::xmeet() that prevents us from
429 // having 2 ways to represent the same type. We have to replicate it
430 // here because we don't go through meet/join.
431 if (result->remove_speculative() == result->speculative()) {
432 result = result->remove_speculative();
433 }
434
435 // Same as above: because we don't go through meet/join, remove the
436 // speculative type if we know we won't use it.
437 return result->cleanup_speculative();
438
439 // JOIN NOT DONE HERE BECAUSE OF INTERFACE ISSUES.
440 // FIX THIS (DO THE JOIN) WHEN UNION TYPES APPEAR!
441
442 //
443 // Remove this code after overnight run indicates no performance
444 // loss from not performing JOIN at CheckCastPPNode
445 //
446 // const TypeInstPtr *in_oop = in->isa_instptr();
447 // const TypeInstPtr *my_oop = _type->isa_instptr();
448 // // If either input is an 'interface', return destination type
449 // assert (in_oop == NULL || in_oop->klass() != NULL, "");
450 // assert (my_oop == NULL || my_oop->klass() != NULL, "");
451 // if( (in_oop && in_oop->klass()->is_interface())
452 // ||(my_oop && my_oop->klass()->is_interface()) ) {
453 // TypePtr::PTR in_ptr = in->isa_ptr() ? in->is_ptr()->_ptr : TypePtr::BotPTR;
454 // // Preserve cast away nullness for interfaces
455 // if( in_ptr == TypePtr::NotNull && my_oop && my_oop->_ptr == TypePtr::BotPTR ) {
456 // return my_oop->cast_to_ptr_type(TypePtr::NotNull);
457 // }
458 // return _type;
459 // }
460 //
461 // // Neither the input nor the destination type is an interface,
462 //
463 // // history: JOIN used to cause weird corner case bugs
464 // // return (in == TypeOopPtr::NULL_PTR) ? in : _type;
465 // // JOIN picks up NotNull in common instance-of/check-cast idioms, both oops.
466 // // JOIN does not preserve NotNull in other cases, e.g. RawPtr vs InstPtr
467 // const Type *join = in->join(_type);
468 // // Check if join preserved NotNull'ness for pointers
469 // if( join->isa_ptr() && _type->isa_ptr() ) {
470 // TypePtr::PTR join_ptr = join->is_ptr()->_ptr;
471 // TypePtr::PTR type_ptr = _type->is_ptr()->_ptr;
472 // // If there isn't any NotNull'ness to preserve
473 // // OR if join preserved NotNull'ness then return it
474 // if( type_ptr == TypePtr::BotPTR || type_ptr == TypePtr::Null ||
475 // join_ptr == TypePtr::NotNull || join_ptr == TypePtr::Constant ) {
476 // return join;
477 // }
478 // // ELSE return same old type as before
479 // return _type;
480 // }
481 // // Not joining two pointers
482 // return join;
483 }
484
485 //=============================================================================
486 //------------------------------Value------------------------------------------
487 const Type* CastX2PNode::Value(PhaseGVN* phase) const {
488 const Type* t = phase->type(in(1));
489 if (t == Type::TOP) return Type::TOP;
490 if (t->base() == Type_X && t->singleton()) {
491 uintptr_t bits = (uintptr_t) t->is_intptr_t()->get_con();
492 if (bits == 0) return TypePtr::NULL_PTR;
493 return TypeRawPtr::make((address) bits);
494 }
495 return CastX2PNode::bottom_type();
496 }
497
498 //------------------------------Idealize---------------------------------------
499 static inline bool fits_in_int(const Type* t, bool but_not_min_int = false) {
500 if (t == Type::TOP) return false;
501 const TypeX* tl = t->is_intptr_t();
502 jint lo = min_jint;
503 jint hi = max_jint;
504 if (but_not_min_int) ++lo; // caller wants to negate the value w/o overflow
505 return (tl->_lo >= lo) && (tl->_hi <= hi);
506 }
507
508 static inline Node* addP_of_X2P(PhaseGVN *phase,
509 Node* base,
510 Node* dispX,
511 bool negate = false) {
512 if (negate) {
513 dispX = phase->transform(new SubXNode(phase->MakeConX(0), dispX));
514 }
515 return new AddPNode(phase->C->top(),
516 phase->transform(new CastX2PNode(base)),
517 dispX);
518 }
519
520 Node *CastX2PNode::Ideal(PhaseGVN *phase, bool can_reshape) {
521 // convert CastX2P(AddX(x, y)) to AddP(CastX2P(x), y) if y fits in an int
522 int op = in(1)->Opcode();
523 Node* x;
524 Node* y;
525 switch (op) {
526 case Op_SubX:
527 x = in(1)->in(1);
528 // Avoid ideal transformations ping-pong between this and AddP for raw pointers.
529 if (phase->find_intptr_t_con(x, -1) == 0)
530 break;
531 y = in(1)->in(2);
532 if (fits_in_int(phase->type(y), true)) {
533 return addP_of_X2P(phase, x, y, true);
534 }
535 break;
536 case Op_AddX:
537 x = in(1)->in(1);
538 y = in(1)->in(2);
539 if (fits_in_int(phase->type(y))) {
540 return addP_of_X2P(phase, x, y);
541 }
542 if (fits_in_int(phase->type(x))) {
543 return addP_of_X2P(phase, y, x);
544 }
545 break;
546 }
547 return NULL;
548 }
549
550 //------------------------------Identity---------------------------------------
551 Node* CastX2PNode::Identity(PhaseGVN* phase) {
552 if (in(1)->Opcode() == Op_CastP2X) return in(1)->in(1);
553 return this;
554 }
555
556 //=============================================================================
557 //------------------------------Value------------------------------------------
558 const Type* CastP2XNode::Value(PhaseGVN* phase) const {
559 const Type* t = phase->type(in(1));
560 if (t == Type::TOP) return Type::TOP;
561 if (t->base() == Type::RawPtr && t->singleton()) {
562 uintptr_t bits = (uintptr_t) t->is_rawptr()->get_con();
563 return TypeX::make(bits);
564 }
565 return CastP2XNode::bottom_type();
566 }
567
568 Node *CastP2XNode::Ideal(PhaseGVN *phase, bool can_reshape) {
569 return (in(0) && remove_dead_region(phase, can_reshape)) ? this : NULL;
570 }
571
572 //------------------------------Identity---------------------------------------
573 Node* CastP2XNode::Identity(PhaseGVN* phase) {
574 if (in(1)->Opcode() == Op_CastX2P) return in(1)->in(1);
575 return this;
576 }
577
578 Node* ConstraintCastNode::make_cast_for_type(Node* c, Node* in, const Type* type, DependencyType dependency) {
579 Node* cast= NULL;
580 if (type->isa_int()) {
581 cast = make_cast(Op_CastII, c, in, type, dependency);
582 } else if (type->isa_long()) {
583 cast = make_cast(Op_CastLL, c, in, type, dependency);
584 } else if (type->isa_float()) {
585 cast = make_cast(Op_CastFF, c, in, type, dependency);
586 } else if (type->isa_double()) {
587 cast = make_cast(Op_CastDD, c, in, type, dependency);
588 } else if (type->isa_vect()) {
589 cast = make_cast(Op_CastVV, c, in, type, dependency);
590 } else if (type->isa_ptr()) {
591 cast = make_cast(Op_CastPP, c, in, type, dependency);
592 }
593 return cast;
594 }