Wed, 03 Jul 2019 20:42:37 +0800
Merge
1 /*
2 * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
25 #include "precompiled.hpp"
26 #include "c1/c1_Canonicalizer.hpp"
27 #include "c1/c1_Optimizer.hpp"
28 #include "c1/c1_ValueMap.hpp"
29 #include "c1/c1_ValueSet.hpp"
30 #include "c1/c1_ValueStack.hpp"
31 #include "utilities/bitMap.inline.hpp"
32 #include "compiler/compileLog.hpp"
34 define_array(ValueSetArray, ValueSet*);
35 define_stack(ValueSetList, ValueSetArray);
38 Optimizer::Optimizer(IR* ir) {
39 assert(ir->is_valid(), "IR must be valid");
40 _ir = ir;
41 }
43 class CE_Eliminator: public BlockClosure {
44 private:
45 IR* _hir;
46 int _cee_count; // the number of CEs successfully eliminated
47 int _ifop_count; // the number of IfOps successfully simplified
48 int _has_substitution;
50 public:
51 CE_Eliminator(IR* hir) : _cee_count(0), _ifop_count(0), _hir(hir) {
52 _has_substitution = false;
53 _hir->iterate_preorder(this);
54 if (_has_substitution) {
55 // substituted some ifops/phis, so resolve the substitution
56 SubstitutionResolver sr(_hir);
57 }
59 CompileLog* log = _hir->compilation()->log();
60 if (log != NULL)
61 log->set_context("optimize name='cee'");
62 }
64 ~CE_Eliminator() {
65 CompileLog* log = _hir->compilation()->log();
66 if (log != NULL)
67 log->clear_context(); // skip marker if nothing was printed
68 }
70 int cee_count() const { return _cee_count; }
71 int ifop_count() const { return _ifop_count; }
73 void adjust_exception_edges(BlockBegin* block, BlockBegin* sux) {
74 int e = sux->number_of_exception_handlers();
75 for (int i = 0; i < e; i++) {
76 BlockBegin* xhandler = sux->exception_handler_at(i);
77 block->add_exception_handler(xhandler);
79 assert(xhandler->is_predecessor(sux), "missing predecessor");
80 if (sux->number_of_preds() == 0) {
81 // sux is disconnected from graph so disconnect from exception handlers
82 xhandler->remove_predecessor(sux);
83 }
84 if (!xhandler->is_predecessor(block)) {
85 xhandler->add_predecessor(block);
86 }
87 }
88 }
90 virtual void block_do(BlockBegin* block);
92 private:
93 Value make_ifop(Value x, Instruction::Condition cond, Value y, Value tval, Value fval);
94 };
96 void CE_Eliminator::block_do(BlockBegin* block) {
97 // 1) find conditional expression
98 // check if block ends with an If
99 If* if_ = block->end()->as_If();
100 if (if_ == NULL) return;
102 // check if If works on int or object types
103 // (we cannot handle If's working on long, float or doubles yet,
104 // since IfOp doesn't support them - these If's show up if cmp
105 // operations followed by If's are eliminated)
106 ValueType* if_type = if_->x()->type();
107 if (!if_type->is_int() && !if_type->is_object()) return;
109 BlockBegin* t_block = if_->tsux();
110 BlockBegin* f_block = if_->fsux();
111 Instruction* t_cur = t_block->next();
112 Instruction* f_cur = f_block->next();
114 // one Constant may be present between BlockBegin and BlockEnd
115 Value t_const = NULL;
116 Value f_const = NULL;
117 if (t_cur->as_Constant() != NULL && !t_cur->can_trap()) {
118 t_const = t_cur;
119 t_cur = t_cur->next();
120 }
121 if (f_cur->as_Constant() != NULL && !f_cur->can_trap()) {
122 f_const = f_cur;
123 f_cur = f_cur->next();
124 }
126 // check if both branches end with a goto
127 Goto* t_goto = t_cur->as_Goto();
128 if (t_goto == NULL) return;
129 Goto* f_goto = f_cur->as_Goto();
130 if (f_goto == NULL) return;
132 // check if both gotos merge into the same block
133 BlockBegin* sux = t_goto->default_sux();
134 if (sux != f_goto->default_sux()) return;
136 // check if at least one word was pushed on sux_state
137 // inlining depths must match
138 ValueStack* if_state = if_->state();
139 ValueStack* sux_state = sux->state();
140 if (if_state->scope()->level() > sux_state->scope()->level()) {
141 while (sux_state->scope() != if_state->scope()) {
142 if_state = if_state->caller_state();
143 assert(if_state != NULL, "states do not match up");
144 }
145 } else if (if_state->scope()->level() < sux_state->scope()->level()) {
146 while (sux_state->scope() != if_state->scope()) {
147 sux_state = sux_state->caller_state();
148 assert(sux_state != NULL, "states do not match up");
149 }
150 }
152 if (sux_state->stack_size() <= if_state->stack_size()) return;
154 // check if phi function is present at end of successor stack and that
155 // only this phi was pushed on the stack
156 Value sux_phi = sux_state->stack_at(if_state->stack_size());
157 if (sux_phi == NULL || sux_phi->as_Phi() == NULL || sux_phi->as_Phi()->block() != sux) return;
158 if (sux_phi->type()->size() != sux_state->stack_size() - if_state->stack_size()) return;
160 // get the values that were pushed in the true- and false-branch
161 Value t_value = t_goto->state()->stack_at(if_state->stack_size());
162 Value f_value = f_goto->state()->stack_at(if_state->stack_size());
164 // backend does not support floats
165 assert(t_value->type()->base() == f_value->type()->base(), "incompatible types");
166 if (t_value->type()->is_float_kind()) return;
168 // check that successor has no other phi functions but sux_phi
169 // this can happen when t_block or f_block contained additonal stores to local variables
170 // that are no longer represented by explicit instructions
171 for_each_phi_fun(sux, phi,
172 if (phi != sux_phi) return;
173 );
174 // true and false blocks can't have phis
175 for_each_phi_fun(t_block, phi, return; );
176 for_each_phi_fun(f_block, phi, return; );
178 // 2) substitute conditional expression
179 // with an IfOp followed by a Goto
180 // cut if_ away and get node before
181 Instruction* cur_end = if_->prev();
183 // append constants of true- and false-block if necessary
184 // clone constants because original block must not be destroyed
185 assert((t_value != f_const && f_value != t_const) || t_const == f_const, "mismatch");
186 if (t_value == t_const) {
187 t_value = new Constant(t_const->type());
188 NOT_PRODUCT(t_value->set_printable_bci(if_->printable_bci()));
189 cur_end = cur_end->set_next(t_value);
190 }
191 if (f_value == f_const) {
192 f_value = new Constant(f_const->type());
193 NOT_PRODUCT(f_value->set_printable_bci(if_->printable_bci()));
194 cur_end = cur_end->set_next(f_value);
195 }
197 Value result = make_ifop(if_->x(), if_->cond(), if_->y(), t_value, f_value);
198 assert(result != NULL, "make_ifop must return a non-null instruction");
199 if (!result->is_linked() && result->can_be_linked()) {
200 NOT_PRODUCT(result->set_printable_bci(if_->printable_bci()));
201 cur_end = cur_end->set_next(result);
202 }
204 // append Goto to successor
205 ValueStack* state_before = if_->state_before();
206 Goto* goto_ = new Goto(sux, state_before, if_->is_safepoint() || t_goto->is_safepoint() || f_goto->is_safepoint());
208 // prepare state for Goto
209 ValueStack* goto_state = if_state;
210 goto_state = goto_state->copy(ValueStack::StateAfter, goto_state->bci());
211 goto_state->push(result->type(), result);
212 assert(goto_state->is_same(sux_state), "states must match now");
213 goto_->set_state(goto_state);
215 cur_end = cur_end->set_next(goto_, goto_state->bci());
217 // Adjust control flow graph
218 BlockBegin::disconnect_edge(block, t_block);
219 BlockBegin::disconnect_edge(block, f_block);
220 if (t_block->number_of_preds() == 0) {
221 BlockBegin::disconnect_edge(t_block, sux);
222 }
223 adjust_exception_edges(block, t_block);
224 if (f_block->number_of_preds() == 0) {
225 BlockBegin::disconnect_edge(f_block, sux);
226 }
227 adjust_exception_edges(block, f_block);
229 // update block end
230 block->set_end(goto_);
232 // substitute the phi if possible
233 if (sux_phi->as_Phi()->operand_count() == 1) {
234 assert(sux_phi->as_Phi()->operand_at(0) == result, "screwed up phi");
235 sux_phi->set_subst(result);
236 _has_substitution = true;
237 }
239 // 3) successfully eliminated a conditional expression
240 _cee_count++;
241 if (PrintCEE) {
242 tty->print_cr("%d. CEE in B%d (B%d B%d)", cee_count(), block->block_id(), t_block->block_id(), f_block->block_id());
243 tty->print_cr("%d. IfOp in B%d", ifop_count(), block->block_id());
244 }
246 _hir->verify();
247 }
249 Value CE_Eliminator::make_ifop(Value x, Instruction::Condition cond, Value y, Value tval, Value fval) {
250 if (!OptimizeIfOps) {
251 return new IfOp(x, cond, y, tval, fval);
252 }
254 tval = tval->subst();
255 fval = fval->subst();
256 if (tval == fval) {
257 _ifop_count++;
258 return tval;
259 }
261 x = x->subst();
262 y = y->subst();
264 Constant* y_const = y->as_Constant();
265 if (y_const != NULL) {
266 IfOp* x_ifop = x->as_IfOp();
267 if (x_ifop != NULL) { // x is an ifop, y is a constant
268 Constant* x_tval_const = x_ifop->tval()->subst()->as_Constant();
269 Constant* x_fval_const = x_ifop->fval()->subst()->as_Constant();
271 if (x_tval_const != NULL && x_fval_const != NULL) {
272 Instruction::Condition x_ifop_cond = x_ifop->cond();
274 Constant::CompareResult t_compare_res = x_tval_const->compare(cond, y_const);
275 Constant::CompareResult f_compare_res = x_fval_const->compare(cond, y_const);
277 // not_comparable here is a valid return in case we're comparing unloaded oop constants
278 if (t_compare_res != Constant::not_comparable && f_compare_res != Constant::not_comparable) {
279 Value new_tval = t_compare_res == Constant::cond_true ? tval : fval;
280 Value new_fval = f_compare_res == Constant::cond_true ? tval : fval;
282 _ifop_count++;
283 if (new_tval == new_fval) {
284 return new_tval;
285 } else {
286 return new IfOp(x_ifop->x(), x_ifop_cond, x_ifop->y(), new_tval, new_fval);
287 }
288 }
289 }
290 } else {
291 Constant* x_const = x->as_Constant();
292 if (x_const != NULL) { // x and y are constants
293 Constant::CompareResult x_compare_res = x_const->compare(cond, y_const);
294 // not_comparable here is a valid return in case we're comparing unloaded oop constants
295 if (x_compare_res != Constant::not_comparable) {
296 _ifop_count++;
297 return x_compare_res == Constant::cond_true ? tval : fval;
298 }
299 }
300 }
301 }
302 return new IfOp(x, cond, y, tval, fval);
303 }
305 void Optimizer::eliminate_conditional_expressions() {
306 #ifndef MIPS
307 // find conditional expressions & replace them with IfOps
308 CE_Eliminator ce(ir());
309 #endif
310 }
312 class BlockMerger: public BlockClosure {
313 private:
314 IR* _hir;
315 int _merge_count; // the number of block pairs successfully merged
317 public:
318 BlockMerger(IR* hir)
319 : _hir(hir)
320 , _merge_count(0)
321 {
322 _hir->iterate_preorder(this);
323 CompileLog* log = _hir->compilation()->log();
324 if (log != NULL)
325 log->set_context("optimize name='eliminate_blocks'");
326 }
328 ~BlockMerger() {
329 CompileLog* log = _hir->compilation()->log();
330 if (log != NULL)
331 log->clear_context(); // skip marker if nothing was printed
332 }
334 bool try_merge(BlockBegin* block) {
335 BlockEnd* end = block->end();
336 if (end->as_Goto() != NULL) {
337 assert(end->number_of_sux() == 1, "end must have exactly one successor");
338 // Note: It would be sufficient to check for the number of successors (= 1)
339 // in order to decide if this block can be merged potentially. That
340 // would then also include switch statements w/ only a default case.
341 // However, in that case we would need to make sure the switch tag
342 // expression is executed if it can produce observable side effects.
343 // We should probably have the canonicalizer simplifying such switch
344 // statements and then we are sure we don't miss these merge opportunities
345 // here (was bug - gri 7/7/99).
346 BlockBegin* sux = end->default_sux();
347 if (sux->number_of_preds() == 1 && !sux->is_entry_block() && !end->is_safepoint()) {
348 // merge the two blocks
350 #ifdef ASSERT
351 // verify that state at the end of block and at the beginning of sux are equal
352 // no phi functions must be present at beginning of sux
353 ValueStack* sux_state = sux->state();
354 ValueStack* end_state = end->state();
356 assert(end_state->scope() == sux_state->scope(), "scopes must match");
357 assert(end_state->stack_size() == sux_state->stack_size(), "stack not equal");
358 assert(end_state->locals_size() == sux_state->locals_size(), "locals not equal");
360 int index;
361 Value sux_value;
362 for_each_stack_value(sux_state, index, sux_value) {
363 assert(sux_value == end_state->stack_at(index), "stack not equal");
364 }
365 for_each_local_value(sux_state, index, sux_value) {
366 assert(sux_value == end_state->local_at(index), "locals not equal");
367 }
368 assert(sux_state->caller_state() == end_state->caller_state(), "caller not equal");
369 #endif
371 // find instruction before end & append first instruction of sux block
372 Instruction* prev = end->prev();
373 Instruction* next = sux->next();
374 assert(prev->as_BlockEnd() == NULL, "must not be a BlockEnd");
375 prev->set_next(next);
376 prev->fixup_block_pointers();
377 sux->disconnect_from_graph();
378 block->set_end(sux->end());
379 // add exception handlers of deleted block, if any
380 for (int k = 0; k < sux->number_of_exception_handlers(); k++) {
381 BlockBegin* xhandler = sux->exception_handler_at(k);
382 block->add_exception_handler(xhandler);
384 // also substitute predecessor of exception handler
385 assert(xhandler->is_predecessor(sux), "missing predecessor");
386 xhandler->remove_predecessor(sux);
387 if (!xhandler->is_predecessor(block)) {
388 xhandler->add_predecessor(block);
389 }
390 }
392 // debugging output
393 _merge_count++;
394 if (PrintBlockElimination) {
395 tty->print_cr("%d. merged B%d & B%d (stack size = %d)",
396 _merge_count, block->block_id(), sux->block_id(), sux->state()->stack_size());
397 }
399 _hir->verify();
401 If* if_ = block->end()->as_If();
402 if (if_) {
403 IfOp* ifop = if_->x()->as_IfOp();
404 Constant* con = if_->y()->as_Constant();
405 bool swapped = false;
406 if (!con || !ifop) {
407 ifop = if_->y()->as_IfOp();
408 con = if_->x()->as_Constant();
409 swapped = true;
410 }
411 if (con && ifop) {
412 Constant* tval = ifop->tval()->as_Constant();
413 Constant* fval = ifop->fval()->as_Constant();
414 if (tval && fval) {
415 // Find the instruction before if_, starting with ifop.
416 // When if_ and ifop are not in the same block, prev
417 // becomes NULL In such (rare) cases it is not
418 // profitable to perform the optimization.
419 Value prev = ifop;
420 while (prev != NULL && prev->next() != if_) {
421 prev = prev->next();
422 }
424 if (prev != NULL) {
425 Instruction::Condition cond = if_->cond();
426 BlockBegin* tsux = if_->tsux();
427 BlockBegin* fsux = if_->fsux();
428 if (swapped) {
429 cond = Instruction::mirror(cond);
430 }
432 BlockBegin* tblock = tval->compare(cond, con, tsux, fsux);
433 BlockBegin* fblock = fval->compare(cond, con, tsux, fsux);
434 if (tblock != fblock && !if_->is_safepoint()) {
435 If* newif = new If(ifop->x(), ifop->cond(), false, ifop->y(),
436 tblock, fblock, if_->state_before(), if_->is_safepoint());
437 newif->set_state(if_->state()->copy());
439 assert(prev->next() == if_, "must be guaranteed by above search");
440 NOT_PRODUCT(newif->set_printable_bci(if_->printable_bci()));
441 prev->set_next(newif);
442 block->set_end(newif);
444 _merge_count++;
445 if (PrintBlockElimination) {
446 tty->print_cr("%d. replaced If and IfOp at end of B%d with single If", _merge_count, block->block_id());
447 }
449 _hir->verify();
450 }
451 }
452 }
453 }
454 }
456 return true;
457 }
458 }
459 return false;
460 }
462 virtual void block_do(BlockBegin* block) {
463 _hir->verify();
464 // repeat since the same block may merge again
465 while (try_merge(block)) {
466 _hir->verify();
467 }
468 }
469 };
472 void Optimizer::eliminate_blocks() {
473 // merge blocks if possible
474 BlockMerger bm(ir());
475 }
478 class NullCheckEliminator;
479 class NullCheckVisitor: public InstructionVisitor {
480 private:
481 NullCheckEliminator* _nce;
482 NullCheckEliminator* nce() { return _nce; }
484 public:
485 NullCheckVisitor() {}
487 void set_eliminator(NullCheckEliminator* nce) { _nce = nce; }
489 void do_Phi (Phi* x);
490 void do_Local (Local* x);
491 void do_Constant (Constant* x);
492 void do_LoadField (LoadField* x);
493 void do_StoreField (StoreField* x);
494 void do_ArrayLength (ArrayLength* x);
495 void do_LoadIndexed (LoadIndexed* x);
496 void do_StoreIndexed (StoreIndexed* x);
497 void do_NegateOp (NegateOp* x);
498 void do_ArithmeticOp (ArithmeticOp* x);
499 void do_ShiftOp (ShiftOp* x);
500 void do_LogicOp (LogicOp* x);
501 void do_CompareOp (CompareOp* x);
502 void do_IfOp (IfOp* x);
503 void do_Convert (Convert* x);
504 void do_NullCheck (NullCheck* x);
505 void do_TypeCast (TypeCast* x);
506 void do_Invoke (Invoke* x);
507 void do_NewInstance (NewInstance* x);
508 void do_NewTypeArray (NewTypeArray* x);
509 void do_NewObjectArray (NewObjectArray* x);
510 void do_NewMultiArray (NewMultiArray* x);
511 void do_CheckCast (CheckCast* x);
512 void do_InstanceOf (InstanceOf* x);
513 void do_MonitorEnter (MonitorEnter* x);
514 void do_MonitorExit (MonitorExit* x);
515 void do_Intrinsic (Intrinsic* x);
516 void do_BlockBegin (BlockBegin* x);
517 void do_Goto (Goto* x);
518 void do_If (If* x);
519 void do_IfInstanceOf (IfInstanceOf* x);
520 void do_TableSwitch (TableSwitch* x);
521 void do_LookupSwitch (LookupSwitch* x);
522 void do_Return (Return* x);
523 void do_Throw (Throw* x);
524 void do_Base (Base* x);
525 void do_OsrEntry (OsrEntry* x);
526 void do_ExceptionObject(ExceptionObject* x);
527 void do_RoundFP (RoundFP* x);
528 void do_UnsafeGetRaw (UnsafeGetRaw* x);
529 void do_UnsafePutRaw (UnsafePutRaw* x);
530 void do_UnsafeGetObject(UnsafeGetObject* x);
531 void do_UnsafePutObject(UnsafePutObject* x);
532 void do_UnsafeGetAndSetObject(UnsafeGetAndSetObject* x);
533 void do_UnsafePrefetchRead (UnsafePrefetchRead* x);
534 void do_UnsafePrefetchWrite(UnsafePrefetchWrite* x);
535 void do_ProfileCall (ProfileCall* x);
536 void do_ProfileReturnType (ProfileReturnType* x);
537 void do_ProfileInvoke (ProfileInvoke* x);
538 void do_RuntimeCall (RuntimeCall* x);
539 void do_MemBar (MemBar* x);
540 void do_RangeCheckPredicate(RangeCheckPredicate* x);
541 #ifdef ASSERT
542 void do_Assert (Assert* x);
543 #endif
544 };
547 // Because of a static contained within (for the purpose of iteration
548 // over instructions), it is only valid to have one of these active at
549 // a time
550 class NullCheckEliminator: public ValueVisitor {
551 private:
552 Optimizer* _opt;
554 ValueSet* _visitable_instructions; // Visit each instruction only once per basic block
555 BlockList* _work_list; // Basic blocks to visit
557 bool visitable(Value x) {
558 assert(_visitable_instructions != NULL, "check");
559 return _visitable_instructions->contains(x);
560 }
561 void mark_visited(Value x) {
562 assert(_visitable_instructions != NULL, "check");
563 _visitable_instructions->remove(x);
564 }
565 void mark_visitable(Value x) {
566 assert(_visitable_instructions != NULL, "check");
567 _visitable_instructions->put(x);
568 }
569 void clear_visitable_state() {
570 assert(_visitable_instructions != NULL, "check");
571 _visitable_instructions->clear();
572 }
574 ValueSet* _set; // current state, propagated to subsequent BlockBegins
575 ValueSetList _block_states; // BlockBegin null-check states for all processed blocks
576 NullCheckVisitor _visitor;
577 NullCheck* _last_explicit_null_check;
579 bool set_contains(Value x) { assert(_set != NULL, "check"); return _set->contains(x); }
580 void set_put (Value x) { assert(_set != NULL, "check"); _set->put(x); }
581 void set_remove (Value x) { assert(_set != NULL, "check"); _set->remove(x); }
583 BlockList* work_list() { return _work_list; }
585 void iterate_all();
586 void iterate_one(BlockBegin* block);
588 ValueSet* state() { return _set; }
589 void set_state_from (ValueSet* state) { _set->set_from(state); }
590 ValueSet* state_for (BlockBegin* block) { return _block_states[block->block_id()]; }
591 void set_state_for (BlockBegin* block, ValueSet* stack) { _block_states[block->block_id()] = stack; }
592 // Returns true if caused a change in the block's state.
593 bool merge_state_for(BlockBegin* block,
594 ValueSet* incoming_state);
596 public:
597 // constructor
598 NullCheckEliminator(Optimizer* opt)
599 : _opt(opt)
600 , _set(new ValueSet())
601 , _last_explicit_null_check(NULL)
602 , _block_states(BlockBegin::number_of_blocks(), NULL)
603 , _work_list(new BlockList()) {
604 _visitable_instructions = new ValueSet();
605 _visitor.set_eliminator(this);
606 CompileLog* log = _opt->ir()->compilation()->log();
607 if (log != NULL)
608 log->set_context("optimize name='null_check_elimination'");
609 }
611 ~NullCheckEliminator() {
612 CompileLog* log = _opt->ir()->compilation()->log();
613 if (log != NULL)
614 log->clear_context(); // skip marker if nothing was printed
615 }
617 Optimizer* opt() { return _opt; }
618 IR* ir () { return opt()->ir(); }
620 // Process a graph
621 void iterate(BlockBegin* root);
623 void visit(Value* f);
625 // In some situations (like NullCheck(x); getfield(x)) the debug
626 // information from the explicit NullCheck can be used to populate
627 // the getfield, even if the two instructions are in different
628 // scopes; this allows implicit null checks to be used but the
629 // correct exception information to be generated. We must clear the
630 // last-traversed NullCheck when we reach a potentially-exception-
631 // throwing instruction, as well as in some other cases.
632 void set_last_explicit_null_check(NullCheck* check) { _last_explicit_null_check = check; }
633 NullCheck* last_explicit_null_check() { return _last_explicit_null_check; }
634 Value last_explicit_null_check_obj() { return (_last_explicit_null_check
635 ? _last_explicit_null_check->obj()
636 : NULL); }
637 NullCheck* consume_last_explicit_null_check() {
638 _last_explicit_null_check->unpin(Instruction::PinExplicitNullCheck);
639 _last_explicit_null_check->set_can_trap(false);
640 return _last_explicit_null_check;
641 }
642 void clear_last_explicit_null_check() { _last_explicit_null_check = NULL; }
644 // Handlers for relevant instructions
645 // (separated out from NullCheckVisitor for clarity)
647 // The basic contract is that these must leave the instruction in
648 // the desired state; must not assume anything about the state of
649 // the instruction. We make multiple passes over some basic blocks
650 // and the last pass is the only one whose result is valid.
651 void handle_AccessField (AccessField* x);
652 void handle_ArrayLength (ArrayLength* x);
653 void handle_LoadIndexed (LoadIndexed* x);
654 void handle_StoreIndexed (StoreIndexed* x);
655 void handle_NullCheck (NullCheck* x);
656 void handle_Invoke (Invoke* x);
657 void handle_NewInstance (NewInstance* x);
658 void handle_NewArray (NewArray* x);
659 void handle_AccessMonitor (AccessMonitor* x);
660 void handle_Intrinsic (Intrinsic* x);
661 void handle_ExceptionObject (ExceptionObject* x);
662 void handle_Phi (Phi* x);
663 void handle_ProfileCall (ProfileCall* x);
664 void handle_ProfileReturnType (ProfileReturnType* x);
665 };
668 // NEEDS_CLEANUP
669 // There may be other instructions which need to clear the last
670 // explicit null check. Anything across which we can not hoist the
671 // debug information for a NullCheck instruction must clear it. It
672 // might be safer to pattern match "NullCheck ; {AccessField,
673 // ArrayLength, LoadIndexed}" but it is more easily structured this way.
674 // Should test to see performance hit of clearing it for all handlers
675 // with empty bodies below. If it is negligible then we should leave
676 // that in for safety, otherwise should think more about it.
677 void NullCheckVisitor::do_Phi (Phi* x) { nce()->handle_Phi(x); }
678 void NullCheckVisitor::do_Local (Local* x) {}
679 void NullCheckVisitor::do_Constant (Constant* x) { /* FIXME: handle object constants */ }
680 void NullCheckVisitor::do_LoadField (LoadField* x) { nce()->handle_AccessField(x); }
681 void NullCheckVisitor::do_StoreField (StoreField* x) { nce()->handle_AccessField(x); }
682 void NullCheckVisitor::do_ArrayLength (ArrayLength* x) { nce()->handle_ArrayLength(x); }
683 void NullCheckVisitor::do_LoadIndexed (LoadIndexed* x) { nce()->handle_LoadIndexed(x); }
684 void NullCheckVisitor::do_StoreIndexed (StoreIndexed* x) { nce()->handle_StoreIndexed(x); }
685 void NullCheckVisitor::do_NegateOp (NegateOp* x) {}
686 void NullCheckVisitor::do_ArithmeticOp (ArithmeticOp* x) { if (x->can_trap()) nce()->clear_last_explicit_null_check(); }
687 void NullCheckVisitor::do_ShiftOp (ShiftOp* x) {}
688 void NullCheckVisitor::do_LogicOp (LogicOp* x) {}
689 void NullCheckVisitor::do_CompareOp (CompareOp* x) {}
690 void NullCheckVisitor::do_IfOp (IfOp* x) {}
691 void NullCheckVisitor::do_Convert (Convert* x) {}
692 void NullCheckVisitor::do_NullCheck (NullCheck* x) { nce()->handle_NullCheck(x); }
693 void NullCheckVisitor::do_TypeCast (TypeCast* x) {}
694 void NullCheckVisitor::do_Invoke (Invoke* x) { nce()->handle_Invoke(x); }
695 void NullCheckVisitor::do_NewInstance (NewInstance* x) { nce()->handle_NewInstance(x); }
696 void NullCheckVisitor::do_NewTypeArray (NewTypeArray* x) { nce()->handle_NewArray(x); }
697 void NullCheckVisitor::do_NewObjectArray (NewObjectArray* x) { nce()->handle_NewArray(x); }
698 void NullCheckVisitor::do_NewMultiArray (NewMultiArray* x) { nce()->handle_NewArray(x); }
699 void NullCheckVisitor::do_CheckCast (CheckCast* x) { nce()->clear_last_explicit_null_check(); }
700 void NullCheckVisitor::do_InstanceOf (InstanceOf* x) {}
701 void NullCheckVisitor::do_MonitorEnter (MonitorEnter* x) { nce()->handle_AccessMonitor(x); }
702 void NullCheckVisitor::do_MonitorExit (MonitorExit* x) { nce()->handle_AccessMonitor(x); }
703 void NullCheckVisitor::do_Intrinsic (Intrinsic* x) { nce()->handle_Intrinsic(x); }
704 void NullCheckVisitor::do_BlockBegin (BlockBegin* x) {}
705 void NullCheckVisitor::do_Goto (Goto* x) {}
706 void NullCheckVisitor::do_If (If* x) {}
707 void NullCheckVisitor::do_IfInstanceOf (IfInstanceOf* x) {}
708 void NullCheckVisitor::do_TableSwitch (TableSwitch* x) {}
709 void NullCheckVisitor::do_LookupSwitch (LookupSwitch* x) {}
710 void NullCheckVisitor::do_Return (Return* x) {}
711 void NullCheckVisitor::do_Throw (Throw* x) { nce()->clear_last_explicit_null_check(); }
712 void NullCheckVisitor::do_Base (Base* x) {}
713 void NullCheckVisitor::do_OsrEntry (OsrEntry* x) {}
714 void NullCheckVisitor::do_ExceptionObject(ExceptionObject* x) { nce()->handle_ExceptionObject(x); }
715 void NullCheckVisitor::do_RoundFP (RoundFP* x) {}
716 void NullCheckVisitor::do_UnsafeGetRaw (UnsafeGetRaw* x) {}
717 void NullCheckVisitor::do_UnsafePutRaw (UnsafePutRaw* x) {}
718 void NullCheckVisitor::do_UnsafeGetObject(UnsafeGetObject* x) {}
719 void NullCheckVisitor::do_UnsafePutObject(UnsafePutObject* x) {}
720 void NullCheckVisitor::do_UnsafeGetAndSetObject(UnsafeGetAndSetObject* x) {}
721 void NullCheckVisitor::do_UnsafePrefetchRead (UnsafePrefetchRead* x) {}
722 void NullCheckVisitor::do_UnsafePrefetchWrite(UnsafePrefetchWrite* x) {}
723 void NullCheckVisitor::do_ProfileCall (ProfileCall* x) { nce()->clear_last_explicit_null_check();
724 nce()->handle_ProfileCall(x); }
725 void NullCheckVisitor::do_ProfileReturnType (ProfileReturnType* x) { nce()->handle_ProfileReturnType(x); }
726 void NullCheckVisitor::do_ProfileInvoke (ProfileInvoke* x) {}
727 void NullCheckVisitor::do_RuntimeCall (RuntimeCall* x) {}
728 void NullCheckVisitor::do_MemBar (MemBar* x) {}
729 void NullCheckVisitor::do_RangeCheckPredicate(RangeCheckPredicate* x) {}
730 #ifdef ASSERT
731 void NullCheckVisitor::do_Assert (Assert* x) {}
732 #endif
734 void NullCheckEliminator::visit(Value* p) {
735 assert(*p != NULL, "should not find NULL instructions");
736 if (visitable(*p)) {
737 mark_visited(*p);
738 (*p)->visit(&_visitor);
739 }
740 }
742 bool NullCheckEliminator::merge_state_for(BlockBegin* block, ValueSet* incoming_state) {
743 ValueSet* state = state_for(block);
744 if (state == NULL) {
745 state = incoming_state->copy();
746 set_state_for(block, state);
747 return true;
748 } else {
749 bool changed = state->set_intersect(incoming_state);
750 if (PrintNullCheckElimination && changed) {
751 tty->print_cr("Block %d's null check state changed", block->block_id());
752 }
753 return changed;
754 }
755 }
758 void NullCheckEliminator::iterate_all() {
759 while (work_list()->length() > 0) {
760 iterate_one(work_list()->pop());
761 }
762 }
765 void NullCheckEliminator::iterate_one(BlockBegin* block) {
766 clear_visitable_state();
767 // clear out an old explicit null checks
768 set_last_explicit_null_check(NULL);
770 if (PrintNullCheckElimination) {
771 tty->print_cr(" ...iterating block %d in null check elimination for %s::%s%s",
772 block->block_id(),
773 ir()->method()->holder()->name()->as_utf8(),
774 ir()->method()->name()->as_utf8(),
775 ir()->method()->signature()->as_symbol()->as_utf8());
776 }
778 // Create new state if none present (only happens at root)
779 if (state_for(block) == NULL) {
780 ValueSet* tmp_state = new ValueSet();
781 set_state_for(block, tmp_state);
782 // Initial state is that local 0 (receiver) is non-null for
783 // non-static methods
784 ValueStack* stack = block->state();
785 IRScope* scope = stack->scope();
786 ciMethod* method = scope->method();
787 if (!method->is_static()) {
788 Local* local0 = stack->local_at(0)->as_Local();
789 assert(local0 != NULL, "must be");
790 assert(local0->type() == objectType, "invalid type of receiver");
792 if (local0 != NULL) {
793 // Local 0 is used in this scope
794 tmp_state->put(local0);
795 if (PrintNullCheckElimination) {
796 tty->print_cr("Local 0 (value %d) proven non-null upon entry", local0->id());
797 }
798 }
799 }
800 }
802 // Must copy block's state to avoid mutating it during iteration
803 // through the block -- otherwise "not-null" states can accidentally
804 // propagate "up" through the block during processing of backward
805 // branches and algorithm is incorrect (and does not converge)
806 set_state_from(state_for(block));
808 // allow visiting of Phis belonging to this block
809 for_each_phi_fun(block, phi,
810 mark_visitable(phi);
811 );
813 BlockEnd* e = block->end();
814 assert(e != NULL, "incomplete graph");
815 int i;
817 // Propagate the state before this block into the exception
818 // handlers. They aren't true successors since we aren't guaranteed
819 // to execute the whole block before executing them. Also putting
820 // them on first seems to help reduce the amount of iteration to
821 // reach a fixed point.
822 for (i = 0; i < block->number_of_exception_handlers(); i++) {
823 BlockBegin* next = block->exception_handler_at(i);
824 if (merge_state_for(next, state())) {
825 if (!work_list()->contains(next)) {
826 work_list()->push(next);
827 }
828 }
829 }
831 // Iterate through block, updating state.
832 for (Instruction* instr = block; instr != NULL; instr = instr->next()) {
833 // Mark instructions in this block as visitable as they are seen
834 // in the instruction list. This keeps the iteration from
835 // visiting instructions which are references in other blocks or
836 // visiting instructions more than once.
837 mark_visitable(instr);
838 if (instr->is_pinned() || instr->can_trap() || (instr->as_NullCheck() != NULL)) {
839 mark_visited(instr);
840 instr->input_values_do(this);
841 instr->visit(&_visitor);
842 }
843 }
845 // Propagate state to successors if necessary
846 for (i = 0; i < e->number_of_sux(); i++) {
847 BlockBegin* next = e->sux_at(i);
848 if (merge_state_for(next, state())) {
849 if (!work_list()->contains(next)) {
850 work_list()->push(next);
851 }
852 }
853 }
854 }
857 void NullCheckEliminator::iterate(BlockBegin* block) {
858 work_list()->push(block);
859 iterate_all();
860 }
862 void NullCheckEliminator::handle_AccessField(AccessField* x) {
863 if (x->is_static()) {
864 if (x->as_LoadField() != NULL) {
865 // If the field is a non-null static final object field (as is
866 // often the case for sun.misc.Unsafe), put this LoadField into
867 // the non-null map
868 ciField* field = x->field();
869 if (field->is_constant()) {
870 ciConstant field_val = field->constant_value();
871 BasicType field_type = field_val.basic_type();
872 if (field_type == T_OBJECT || field_type == T_ARRAY) {
873 ciObject* obj_val = field_val.as_object();
874 if (!obj_val->is_null_object()) {
875 if (PrintNullCheckElimination) {
876 tty->print_cr("AccessField %d proven non-null by static final non-null oop check",
877 x->id());
878 }
879 set_put(x);
880 }
881 }
882 }
883 }
884 // Be conservative
885 clear_last_explicit_null_check();
886 return;
887 }
889 Value obj = x->obj();
890 if (set_contains(obj)) {
891 // Value is non-null => update AccessField
892 if (last_explicit_null_check_obj() == obj && !x->needs_patching()) {
893 x->set_explicit_null_check(consume_last_explicit_null_check());
894 x->set_needs_null_check(true);
895 if (PrintNullCheckElimination) {
896 tty->print_cr("Folded NullCheck %d into AccessField %d's null check for value %d",
897 x->explicit_null_check()->id(), x->id(), obj->id());
898 }
899 } else {
900 x->set_explicit_null_check(NULL);
901 x->set_needs_null_check(false);
902 if (PrintNullCheckElimination) {
903 tty->print_cr("Eliminated AccessField %d's null check for value %d", x->id(), obj->id());
904 }
905 }
906 } else {
907 set_put(obj);
908 if (PrintNullCheckElimination) {
909 tty->print_cr("AccessField %d of value %d proves value to be non-null", x->id(), obj->id());
910 }
911 // Ensure previous passes do not cause wrong state
912 x->set_needs_null_check(true);
913 x->set_explicit_null_check(NULL);
914 }
915 clear_last_explicit_null_check();
916 }
919 void NullCheckEliminator::handle_ArrayLength(ArrayLength* x) {
920 Value array = x->array();
921 if (set_contains(array)) {
922 // Value is non-null => update AccessArray
923 if (last_explicit_null_check_obj() == array) {
924 x->set_explicit_null_check(consume_last_explicit_null_check());
925 x->set_needs_null_check(true);
926 if (PrintNullCheckElimination) {
927 tty->print_cr("Folded NullCheck %d into ArrayLength %d's null check for value %d",
928 x->explicit_null_check()->id(), x->id(), array->id());
929 }
930 } else {
931 x->set_explicit_null_check(NULL);
932 x->set_needs_null_check(false);
933 if (PrintNullCheckElimination) {
934 tty->print_cr("Eliminated ArrayLength %d's null check for value %d", x->id(), array->id());
935 }
936 }
937 } else {
938 set_put(array);
939 if (PrintNullCheckElimination) {
940 tty->print_cr("ArrayLength %d of value %d proves value to be non-null", x->id(), array->id());
941 }
942 // Ensure previous passes do not cause wrong state
943 x->set_needs_null_check(true);
944 x->set_explicit_null_check(NULL);
945 }
946 clear_last_explicit_null_check();
947 }
950 void NullCheckEliminator::handle_LoadIndexed(LoadIndexed* x) {
951 Value array = x->array();
952 if (set_contains(array)) {
953 // Value is non-null => update AccessArray
954 if (last_explicit_null_check_obj() == array) {
955 x->set_explicit_null_check(consume_last_explicit_null_check());
956 x->set_needs_null_check(true);
957 if (PrintNullCheckElimination) {
958 tty->print_cr("Folded NullCheck %d into LoadIndexed %d's null check for value %d",
959 x->explicit_null_check()->id(), x->id(), array->id());
960 }
961 } else {
962 x->set_explicit_null_check(NULL);
963 x->set_needs_null_check(false);
964 if (PrintNullCheckElimination) {
965 tty->print_cr("Eliminated LoadIndexed %d's null check for value %d", x->id(), array->id());
966 }
967 }
968 } else {
969 set_put(array);
970 if (PrintNullCheckElimination) {
971 tty->print_cr("LoadIndexed %d of value %d proves value to be non-null", x->id(), array->id());
972 }
973 // Ensure previous passes do not cause wrong state
974 x->set_needs_null_check(true);
975 x->set_explicit_null_check(NULL);
976 }
977 clear_last_explicit_null_check();
978 }
981 void NullCheckEliminator::handle_StoreIndexed(StoreIndexed* x) {
982 Value array = x->array();
983 if (set_contains(array)) {
984 // Value is non-null => update AccessArray
985 if (PrintNullCheckElimination) {
986 tty->print_cr("Eliminated StoreIndexed %d's null check for value %d", x->id(), array->id());
987 }
988 x->set_needs_null_check(false);
989 } else {
990 set_put(array);
991 if (PrintNullCheckElimination) {
992 tty->print_cr("StoreIndexed %d of value %d proves value to be non-null", x->id(), array->id());
993 }
994 // Ensure previous passes do not cause wrong state
995 x->set_needs_null_check(true);
996 }
997 clear_last_explicit_null_check();
998 }
1001 void NullCheckEliminator::handle_NullCheck(NullCheck* x) {
1002 Value obj = x->obj();
1003 if (set_contains(obj)) {
1004 // Already proven to be non-null => this NullCheck is useless
1005 if (PrintNullCheckElimination) {
1006 tty->print_cr("Eliminated NullCheck %d for value %d", x->id(), obj->id());
1007 }
1008 // Don't unpin since that may shrink obj's live range and make it unavailable for debug info.
1009 // The code generator won't emit LIR for a NullCheck that cannot trap.
1010 x->set_can_trap(false);
1011 } else {
1012 // May be null => add to map and set last explicit NullCheck
1013 x->set_can_trap(true);
1014 // make sure it's pinned if it can trap
1015 x->pin(Instruction::PinExplicitNullCheck);
1016 set_put(obj);
1017 set_last_explicit_null_check(x);
1018 if (PrintNullCheckElimination) {
1019 tty->print_cr("NullCheck %d of value %d proves value to be non-null", x->id(), obj->id());
1020 }
1021 }
1022 }
1025 void NullCheckEliminator::handle_Invoke(Invoke* x) {
1026 if (!x->has_receiver()) {
1027 // Be conservative
1028 clear_last_explicit_null_check();
1029 return;
1030 }
1032 Value recv = x->receiver();
1033 if (!set_contains(recv)) {
1034 set_put(recv);
1035 if (PrintNullCheckElimination) {
1036 tty->print_cr("Invoke %d of value %d proves value to be non-null", x->id(), recv->id());
1037 }
1038 }
1039 clear_last_explicit_null_check();
1040 }
1043 void NullCheckEliminator::handle_NewInstance(NewInstance* x) {
1044 set_put(x);
1045 if (PrintNullCheckElimination) {
1046 tty->print_cr("NewInstance %d is non-null", x->id());
1047 }
1048 }
1051 void NullCheckEliminator::handle_NewArray(NewArray* x) {
1052 set_put(x);
1053 if (PrintNullCheckElimination) {
1054 tty->print_cr("NewArray %d is non-null", x->id());
1055 }
1056 }
1059 void NullCheckEliminator::handle_ExceptionObject(ExceptionObject* x) {
1060 set_put(x);
1061 if (PrintNullCheckElimination) {
1062 tty->print_cr("ExceptionObject %d is non-null", x->id());
1063 }
1064 }
1067 void NullCheckEliminator::handle_AccessMonitor(AccessMonitor* x) {
1068 Value obj = x->obj();
1069 if (set_contains(obj)) {
1070 // Value is non-null => update AccessMonitor
1071 if (PrintNullCheckElimination) {
1072 tty->print_cr("Eliminated AccessMonitor %d's null check for value %d", x->id(), obj->id());
1073 }
1074 x->set_needs_null_check(false);
1075 } else {
1076 set_put(obj);
1077 if (PrintNullCheckElimination) {
1078 tty->print_cr("AccessMonitor %d of value %d proves value to be non-null", x->id(), obj->id());
1079 }
1080 // Ensure previous passes do not cause wrong state
1081 x->set_needs_null_check(true);
1082 }
1083 clear_last_explicit_null_check();
1084 }
1087 void NullCheckEliminator::handle_Intrinsic(Intrinsic* x) {
1088 if (!x->has_receiver()) {
1089 if (x->id() == vmIntrinsics::_arraycopy) {
1090 for (int i = 0; i < x->number_of_arguments(); i++) {
1091 x->set_arg_needs_null_check(i, !set_contains(x->argument_at(i)));
1092 }
1093 }
1095 // Be conservative
1096 clear_last_explicit_null_check();
1097 return;
1098 }
1100 Value recv = x->receiver();
1101 if (set_contains(recv)) {
1102 // Value is non-null => update Intrinsic
1103 if (PrintNullCheckElimination) {
1104 tty->print_cr("Eliminated Intrinsic %d's null check for value %d", x->id(), recv->id());
1105 }
1106 x->set_needs_null_check(false);
1107 } else {
1108 set_put(recv);
1109 if (PrintNullCheckElimination) {
1110 tty->print_cr("Intrinsic %d of value %d proves value to be non-null", x->id(), recv->id());
1111 }
1112 // Ensure previous passes do not cause wrong state
1113 x->set_needs_null_check(true);
1114 }
1115 clear_last_explicit_null_check();
1116 }
1119 void NullCheckEliminator::handle_Phi(Phi* x) {
1120 int i;
1121 bool all_non_null = true;
1122 if (x->is_illegal()) {
1123 all_non_null = false;
1124 } else {
1125 for (i = 0; i < x->operand_count(); i++) {
1126 Value input = x->operand_at(i);
1127 if (!set_contains(input)) {
1128 all_non_null = false;
1129 }
1130 }
1131 }
1133 if (all_non_null) {
1134 // Value is non-null => update Phi
1135 if (PrintNullCheckElimination) {
1136 tty->print_cr("Eliminated Phi %d's null check for phifun because all inputs are non-null", x->id());
1137 }
1138 x->set_needs_null_check(false);
1139 } else if (set_contains(x)) {
1140 set_remove(x);
1141 }
1142 }
1144 void NullCheckEliminator::handle_ProfileCall(ProfileCall* x) {
1145 for (int i = 0; i < x->nb_profiled_args(); i++) {
1146 x->set_arg_needs_null_check(i, !set_contains(x->profiled_arg_at(i)));
1147 }
1148 }
1150 void NullCheckEliminator::handle_ProfileReturnType(ProfileReturnType* x) {
1151 x->set_needs_null_check(!set_contains(x->ret()));
1152 }
1154 void Optimizer::eliminate_null_checks() {
1155 ResourceMark rm;
1157 NullCheckEliminator nce(this);
1159 if (PrintNullCheckElimination) {
1160 tty->print_cr("Starting null check elimination for method %s::%s%s",
1161 ir()->method()->holder()->name()->as_utf8(),
1162 ir()->method()->name()->as_utf8(),
1163 ir()->method()->signature()->as_symbol()->as_utf8());
1164 }
1166 // Apply to graph
1167 nce.iterate(ir()->start());
1169 // walk over the graph looking for exception
1170 // handlers and iterate over them as well
1171 int nblocks = BlockBegin::number_of_blocks();
1172 BlockList blocks(nblocks);
1173 boolArray visited_block(nblocks, false);
1175 blocks.push(ir()->start());
1176 visited_block[ir()->start()->block_id()] = true;
1177 for (int i = 0; i < blocks.length(); i++) {
1178 BlockBegin* b = blocks[i];
1179 // exception handlers need to be treated as additional roots
1180 for (int e = b->number_of_exception_handlers(); e-- > 0; ) {
1181 BlockBegin* excp = b->exception_handler_at(e);
1182 int id = excp->block_id();
1183 if (!visited_block[id]) {
1184 blocks.push(excp);
1185 visited_block[id] = true;
1186 nce.iterate(excp);
1187 }
1188 }
1189 // traverse successors
1190 BlockEnd *end = b->end();
1191 for (int s = end->number_of_sux(); s-- > 0; ) {
1192 BlockBegin* next = end->sux_at(s);
1193 int id = next->block_id();
1194 if (!visited_block[id]) {
1195 blocks.push(next);
1196 visited_block[id] = true;
1197 }
1198 }
1199 }
1202 if (PrintNullCheckElimination) {
1203 tty->print_cr("Done with null check elimination for method %s::%s%s",
1204 ir()->method()->holder()->name()->as_utf8(),
1205 ir()->method()->name()->as_utf8(),
1206 ir()->method()->signature()->as_symbol()->as_utf8());
1207 }
1208 }