1 /* 2 * Copyright (c) 2000, 2012, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. 8 * 9 * This code is distributed in the hope that it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12 * version 2 for more details (a copy is included in the LICENSE file that 13 * accompanied this code). 14 * 15 * You should have received a copy of the GNU General Public License version 16 * 2 along with this work; if not, write to the Free Software Foundation, 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18 * 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20 * or visit www.oracle.com if you need additional information or have any 21 * questions. 22 * 23 */ 24 25 #ifndef SHARE_VM_CI_CITYPEFLOW_HPP 26 #define SHARE_VM_CI_CITYPEFLOW_HPP 27 28 #ifdef COMPILER2 29 #include "ci/ciEnv.hpp" 30 #include "ci/ciKlass.hpp" 31 #include "ci/ciMethodBlocks.hpp" 32 #endif 33 #ifdef SHARK 34 #include "ci/ciEnv.hpp" 35 #include "ci/ciKlass.hpp" 36 #include "ci/ciMethodBlocks.hpp" 37 #include "shark/shark_globals.hpp" 38 #endif 39 40 41 class ciTypeFlow : public ResourceObj { 42 private: 43 ciEnv* _env; 44 ciMethod* _method; 45 ciMethodBlocks* _methodBlocks; 46 int _osr_bci; 47 48 // information cached from the method: 49 int _max_locals; 50 int _max_stack; 51 int _code_size; 52 bool _has_irreducible_entry; 53 54 const char* _failure_reason; 55 56 public: 57 class StateVector; 58 class Loop; 59 class Block; 60 61 // Build a type flow analyzer 62 // Do an OSR analysis if osr_bci >= 0. 63 ciTypeFlow(ciEnv* env, ciMethod* method, int osr_bci = InvocationEntryBci); 64 65 // Accessors 66 ciMethod* method() const { return _method; } 67 ciEnv* env() { return _env; } 68 Arena* arena() { return _env->arena(); } 69 bool is_osr_flow() const{ return _osr_bci != InvocationEntryBci; } 70 int start_bci() const { return is_osr_flow()? _osr_bci: 0; } 71 int max_locals() const { return _max_locals; } 72 int max_stack() const { return _max_stack; } 73 int max_cells() const { return _max_locals + _max_stack; } 74 int code_size() const { return _code_size; } 75 bool has_irreducible_entry() const { return _has_irreducible_entry; } 76 77 // Represents information about an "active" jsr call. This 78 // class represents a call to the routine at some entry address 79 // with some distinct return address. 80 class JsrRecord : public ResourceObj { 81 private: 82 int _entry_address; 83 int _return_address; 84 public: 85 JsrRecord(int entry_address, int return_address) { 86 _entry_address = entry_address; 87 _return_address = return_address; 88 } 89 90 int entry_address() const { return _entry_address; } 91 int return_address() const { return _return_address; } 92 93 void print_on(outputStream* st) const { 94 #ifndef PRODUCT 95 st->print("%d->%d", entry_address(), return_address()); 96 #endif 97 } 98 }; 99 100 // A JsrSet represents some set of JsrRecords. This class 101 // is used to record a set of all jsr routines which we permit 102 // execution to return (ret) from. 103 // 104 // During abstract interpretation, JsrSets are used to determine 105 // whether two paths which reach a given block are unique, and 106 // should be cloned apart, or are compatible, and should merge 107 // together. 108 // 109 // Note that different amounts of effort can be expended determining 110 // if paths are compatible. <DISCUSSION> 111 class JsrSet : public ResourceObj { 112 private: 113 GrowableArray<JsrRecord*>* _set; 114 115 JsrRecord* record_at(int i) { 116 return _set->at(i); 117 } 118 119 // Insert the given JsrRecord into the JsrSet, maintaining the order 120 // of the set and replacing any element with the same entry address. 121 void insert_jsr_record(JsrRecord* record); 122 123 // Remove the JsrRecord with the given return address from the JsrSet. 124 void remove_jsr_record(int return_address); 125 126 public: 127 JsrSet(Arena* arena, int default_len = 4); 128 129 // Copy this JsrSet. 130 void copy_into(JsrSet* jsrs); 131 132 // Is this JsrSet compatible with some other JsrSet? 133 bool is_compatible_with(JsrSet* other); 134 135 // Apply the effect of a single bytecode to the JsrSet. 136 void apply_control(ciTypeFlow* analyzer, 137 ciBytecodeStream* str, 138 StateVector* state); 139 140 // What is the cardinality of this set? 141 int size() const { return _set->length(); } 142 143 void print_on(outputStream* st) const PRODUCT_RETURN; 144 }; 145 146 class LocalSet VALUE_OBJ_CLASS_SPEC { 147 private: 148 enum Constants { max = 63 }; 149 uint64_t _bits; 150 public: 151 LocalSet() : _bits(0) {} 152 void add(uint32_t i) { if (i < (uint32_t)max) _bits |= (1LL << i); } 153 void add(LocalSet* ls) { _bits |= ls->_bits; } 154 bool test(uint32_t i) const { return i < (uint32_t)max ? (_bits>>i)&1U : true; } 155 void clear() { _bits = 0; } 156 void print_on(outputStream* st, int limit) const PRODUCT_RETURN; 157 }; 158 159 // Used as a combined index for locals and temps 160 enum Cell { 161 Cell_0, Cell_max = INT_MAX 162 }; 163 164 // A StateVector summarizes the type information at some 165 // point in the program 166 class StateVector : public ResourceObj { 167 private: 168 ciType** _types; 169 int _stack_size; 170 int _monitor_count; 171 ciTypeFlow* _outer; 172 173 int _trap_bci; 174 int _trap_index; 175 176 LocalSet _def_locals; // For entire block 177 178 static ciType* type_meet_internal(ciType* t1, ciType* t2, ciTypeFlow* analyzer); 179 180 public: 181 // Special elements in our type lattice. 182 enum { 183 T_TOP = T_VOID, // why not? 184 T_BOTTOM = T_CONFLICT, 185 T_LONG2 = T_SHORT, // 2nd word of T_LONG 186 T_DOUBLE2 = T_CHAR, // 2nd word of T_DOUBLE 187 T_NULL = T_BYTE // for now. 188 }; 189 static ciType* top_type() { return ciType::make((BasicType)T_TOP); } 190 static ciType* bottom_type() { return ciType::make((BasicType)T_BOTTOM); } 191 static ciType* long2_type() { return ciType::make((BasicType)T_LONG2); } 192 static ciType* double2_type(){ return ciType::make((BasicType)T_DOUBLE2); } 193 static ciType* null_type() { return ciType::make((BasicType)T_NULL); } 194 195 static ciType* half_type(ciType* t) { 196 switch (t->basic_type()) { 197 case T_LONG: return long2_type(); 198 case T_DOUBLE: return double2_type(); 199 default: ShouldNotReachHere(); return NULL; 200 } 201 } 202 203 // The meet operation for our type lattice. 204 ciType* type_meet(ciType* t1, ciType* t2) { 205 return type_meet_internal(t1, t2, outer()); 206 } 207 208 // Accessors 209 ciTypeFlow* outer() const { return _outer; } 210 211 int stack_size() const { return _stack_size; } 212 void set_stack_size(int ss) { _stack_size = ss; } 213 214 int monitor_count() const { return _monitor_count; } 215 void set_monitor_count(int mc) { _monitor_count = mc; } 216 217 LocalSet* def_locals() { return &_def_locals; } 218 const LocalSet* def_locals() const { return &_def_locals; } 219 220 static Cell start_cell() { return (Cell)0; } 221 static Cell next_cell(Cell c) { return (Cell)(((int)c) + 1); } 222 Cell limit_cell() const { 223 return (Cell)(outer()->max_locals() + stack_size()); 224 } 225 226 // Cell creation 227 Cell local(int lnum) const { 228 assert(lnum < outer()->max_locals(), "index check"); 229 return (Cell)(lnum); 230 } 231 232 Cell stack(int snum) const { 233 assert(snum < stack_size(), "index check"); 234 return (Cell)(outer()->max_locals() + snum); 235 } 236 237 Cell tos() const { return stack(stack_size()-1); } 238 239 // For external use only: 240 ciType* local_type_at(int i) const { return type_at(local(i)); } 241 ciType* stack_type_at(int i) const { return type_at(stack(i)); } 242 243 // Accessors for the type of some Cell c 244 ciType* type_at(Cell c) const { 245 assert(start_cell() <= c && c < limit_cell(), "out of bounds"); 246 return _types[c]; 247 } 248 249 void set_type_at(Cell c, ciType* type) { 250 assert(start_cell() <= c && c < limit_cell(), "out of bounds"); 251 _types[c] = type; 252 } 253 254 // Top-of-stack operations. 255 void set_type_at_tos(ciType* type) { set_type_at(tos(), type); } 256 ciType* type_at_tos() const { return type_at(tos()); } 257 258 void push(ciType* type) { 259 _stack_size++; 260 set_type_at_tos(type); 261 } 262 void pop() { 263 debug_only(set_type_at_tos(bottom_type())); 264 _stack_size--; 265 } 266 ciType* pop_value() { 267 ciType* t = type_at_tos(); 268 pop(); 269 return t; 270 } 271 272 // Convenience operations. 273 bool is_reference(ciType* type) const { 274 return type == null_type() || !type->is_primitive_type(); 275 } 276 bool is_int(ciType* type) const { 277 return type->basic_type() == T_INT; 278 } 279 bool is_long(ciType* type) const { 280 return type->basic_type() == T_LONG; 281 } 282 bool is_float(ciType* type) const { 283 return type->basic_type() == T_FLOAT; 284 } 285 bool is_double(ciType* type) const { 286 return type->basic_type() == T_DOUBLE; 287 } 288 289 void store_to_local(int lnum) { 290 _def_locals.add((uint) lnum); 291 } 292 293 void push_translate(ciType* type); 294 295 void push_int() { 296 push(ciType::make(T_INT)); 297 } 298 void pop_int() { 299 assert(is_int(type_at_tos()), "must be integer"); 300 pop(); 301 } 302 void check_int(Cell c) { 303 assert(is_int(type_at(c)), "must be integer"); 304 } 305 void push_double() { 306 push(ciType::make(T_DOUBLE)); 307 push(double2_type()); 308 } 309 void pop_double() { 310 assert(type_at_tos() == double2_type(), "must be 2nd half"); 311 pop(); 312 assert(is_double(type_at_tos()), "must be double"); 313 pop(); 314 } 315 void push_float() { 316 push(ciType::make(T_FLOAT)); 317 } 318 void pop_float() { 319 assert(is_float(type_at_tos()), "must be float"); 320 pop(); 321 } 322 void push_long() { 323 push(ciType::make(T_LONG)); 324 push(long2_type()); 325 } 326 void pop_long() { 327 assert(type_at_tos() == long2_type(), "must be 2nd half"); 328 pop(); 329 assert(is_long(type_at_tos()), "must be long"); 330 pop(); 331 } 332 void push_object(ciKlass* klass) { 333 push(klass); 334 } 335 void pop_object() { 336 assert(is_reference(type_at_tos()), "must be reference type"); 337 pop(); 338 } 339 void pop_array() { 340 assert(type_at_tos() == null_type() || 341 type_at_tos()->is_array_klass(), "must be array type"); 342 pop(); 343 } 344 // pop_objArray and pop_typeArray narrow the tos to ciObjArrayKlass 345 // or ciTypeArrayKlass (resp.). In the rare case that an explicit 346 // null is popped from the stack, we return NULL. Caller beware. 347 ciObjArrayKlass* pop_objArray() { 348 ciType* array = pop_value(); 349 if (array == null_type()) return NULL; 350 assert(array->is_obj_array_klass(), "must be object array type"); 351 return array->as_obj_array_klass(); 352 } 353 ciTypeArrayKlass* pop_typeArray() { 354 ciType* array = pop_value(); 355 if (array == null_type()) return NULL; 356 assert(array->is_type_array_klass(), "must be prim array type"); 357 return array->as_type_array_klass(); 358 } 359 void push_null() { 360 push(null_type()); 361 } 362 void do_null_assert(ciKlass* unloaded_klass); 363 364 // Helper convenience routines. 365 void do_aaload(ciBytecodeStream* str); 366 void do_checkcast(ciBytecodeStream* str); 367 void do_getfield(ciBytecodeStream* str); 368 void do_getstatic(ciBytecodeStream* str); 369 void do_invoke(ciBytecodeStream* str, bool has_receiver); 370 void do_jsr(ciBytecodeStream* str); 371 void do_ldc(ciBytecodeStream* str); 372 void do_multianewarray(ciBytecodeStream* str); 373 void do_new(ciBytecodeStream* str); 374 void do_vnew(ciBytecodeStream* str); 375 void do_newarray(ciBytecodeStream* str); 376 void do_putfield(ciBytecodeStream* str); 377 void do_putstatic(ciBytecodeStream* str); 378 void do_ret(ciBytecodeStream* str); 379 void do_vunbox(ciBytecodeStream* str); 380 void do_vbox(ciBytecodeStream* str); 381 382 void overwrite_local_double_long(int index) { 383 // Invalidate the previous local if it contains first half of 384 // a double or long value since it's seconf half is being overwritten. 385 int prev_index = index - 1; 386 if (prev_index >= 0 && 387 (is_double(type_at(local(prev_index))) || 388 is_long(type_at(local(prev_index))))) { 389 set_type_at(local(prev_index), bottom_type()); 390 } 391 } 392 393 void load_local_object(int index) { 394 ciType* type = type_at(local(index)); 395 assert(is_reference(type), "must be reference type"); 396 push(type); 397 } 398 void store_local_object(int index) { 399 ciType* type = pop_value(); 400 assert(is_reference(type) || type->is_return_address(), 401 "must be reference type or return address"); 402 overwrite_local_double_long(index); 403 set_type_at(local(index), type); 404 store_to_local(index); 405 } 406 407 void load_local_double(int index) { 408 ciType* type = type_at(local(index)); 409 ciType* type2 = type_at(local(index+1)); 410 assert(is_double(type), "must be double type"); 411 assert(type2 == double2_type(), "must be 2nd half"); 412 push(type); 413 push(double2_type()); 414 } 415 void store_local_double(int index) { 416 ciType* type2 = pop_value(); 417 ciType* type = pop_value(); 418 assert(is_double(type), "must be double"); 419 assert(type2 == double2_type(), "must be 2nd half"); 420 overwrite_local_double_long(index); 421 set_type_at(local(index), type); 422 set_type_at(local(index+1), type2); 423 store_to_local(index); 424 store_to_local(index+1); 425 } 426 427 void load_local_float(int index) { 428 ciType* type = type_at(local(index)); 429 assert(is_float(type), "must be float type"); 430 push(type); 431 } 432 void store_local_float(int index) { 433 ciType* type = pop_value(); 434 assert(is_float(type), "must be float type"); 435 overwrite_local_double_long(index); 436 set_type_at(local(index), type); 437 store_to_local(index); 438 } 439 440 void load_local_int(int index) { 441 ciType* type = type_at(local(index)); 442 assert(is_int(type), "must be int type"); 443 push(type); 444 } 445 void store_local_int(int index) { 446 ciType* type = pop_value(); 447 assert(is_int(type), "must be int type"); 448 overwrite_local_double_long(index); 449 set_type_at(local(index), type); 450 store_to_local(index); 451 } 452 453 void load_local_long(int index) { 454 ciType* type = type_at(local(index)); 455 ciType* type2 = type_at(local(index+1)); 456 assert(is_long(type), "must be long type"); 457 assert(type2 == long2_type(), "must be 2nd half"); 458 push(type); 459 push(long2_type()); 460 } 461 void store_local_long(int index) { 462 ciType* type2 = pop_value(); 463 ciType* type = pop_value(); 464 assert(is_long(type), "must be long"); 465 assert(type2 == long2_type(), "must be 2nd half"); 466 overwrite_local_double_long(index); 467 set_type_at(local(index), type); 468 set_type_at(local(index+1), type2); 469 store_to_local(index); 470 store_to_local(index+1); 471 } 472 473 // Stop interpretation of this path with a trap. 474 void trap(ciBytecodeStream* str, ciKlass* klass, int index); 475 476 public: 477 StateVector(ciTypeFlow* outer); 478 479 // Copy our value into some other StateVector 480 void copy_into(StateVector* copy) const; 481 482 // Meets this StateVector with another, destructively modifying this 483 // one. Returns true if any modification takes place. 484 bool meet(const StateVector* incoming); 485 486 // Ditto, except that the incoming state is coming from an exception. 487 bool meet_exception(ciInstanceKlass* exc, const StateVector* incoming); 488 489 // Apply the effect of one bytecode to this StateVector 490 bool apply_one_bytecode(ciBytecodeStream* stream); 491 492 // What is the bci of the trap? 493 int trap_bci() { return _trap_bci; } 494 495 // What is the index associated with the trap? 496 int trap_index() { return _trap_index; } 497 498 void print_cell_on(outputStream* st, Cell c) const PRODUCT_RETURN; 499 void print_on(outputStream* st) const PRODUCT_RETURN; 500 }; 501 502 // Parameter for "find_block" calls: 503 // Describes the difference between a public and backedge copy. 504 enum CreateOption { 505 create_public_copy, 506 create_backedge_copy, 507 no_create 508 }; 509 510 // Successor iterator 511 class SuccIter : public StackObj { 512 private: 513 Block* _pred; 514 int _index; 515 Block* _succ; 516 public: 517 SuccIter() : _pred(NULL), _index(-1), _succ(NULL) {} 518 SuccIter(Block* pred) : _pred(pred), _index(-1), _succ(NULL) { next(); } 519 int index() { return _index; } 520 Block* pred() { return _pred; } // Return predecessor 521 bool done() { return _index < 0; } // Finished? 522 Block* succ() { return _succ; } // Return current successor 523 void next(); // Advance 524 void set_succ(Block* succ); // Update current successor 525 bool is_normal_ctrl() { return index() < _pred->successors()->length(); } 526 }; 527 528 // A basic block 529 class Block : public ResourceObj { 530 private: 531 ciBlock* _ciblock; 532 GrowableArray<Block*>* _exceptions; 533 GrowableArray<ciInstanceKlass*>* _exc_klasses; 534 GrowableArray<Block*>* _successors; 535 GrowableArray<Block*>* _predecessors; 536 StateVector* _state; 537 JsrSet* _jsrs; 538 539 int _trap_bci; 540 int _trap_index; 541 542 // pre_order, assigned at first visit. Used as block ID and "visited" tag 543 int _pre_order; 544 545 // A post-order, used to compute the reverse post order (RPO) provided to the client 546 int _post_order; // used to compute rpo 547 548 // Has this block been cloned for a loop backedge? 549 bool _backedge_copy; 550 551 // This block is entry to irreducible loop. 552 bool _irreducible_entry; 553 554 // This block has monitor entry point. 555 bool _has_monitorenter; 556 557 // A pointer used for our internal work list 558 bool _on_work_list; // on the work list 559 Block* _next; 560 Block* _rpo_next; // Reverse post order list 561 562 // Loop info 563 Loop* _loop; // nearest loop 564 565 ciBlock* ciblock() const { return _ciblock; } 566 StateVector* state() const { return _state; } 567 568 // Compute the exceptional successors and types for this Block. 569 void compute_exceptions(); 570 571 public: 572 // constructors 573 Block(ciTypeFlow* outer, ciBlock* ciblk, JsrSet* jsrs); 574 575 void set_trap(int trap_bci, int trap_index) { 576 _trap_bci = trap_bci; 577 _trap_index = trap_index; 578 assert(has_trap(), ""); 579 } 580 bool has_trap() const { return _trap_bci != -1; } 581 int trap_bci() const { assert(has_trap(), ""); return _trap_bci; } 582 int trap_index() const { assert(has_trap(), ""); return _trap_index; } 583 584 // accessors 585 ciTypeFlow* outer() const { return state()->outer(); } 586 int start() const { return _ciblock->start_bci(); } 587 int limit() const { return _ciblock->limit_bci(); } 588 int control() const { return _ciblock->control_bci(); } 589 JsrSet* jsrs() const { return _jsrs; } 590 591 bool is_backedge_copy() const { return _backedge_copy; } 592 void set_backedge_copy(bool z); 593 int backedge_copy_count() const { return outer()->backedge_copy_count(ciblock()->index(), _jsrs); } 594 595 // access to entry state 596 int stack_size() const { return _state->stack_size(); } 597 int monitor_count() const { return _state->monitor_count(); } 598 ciType* local_type_at(int i) const { return _state->local_type_at(i); } 599 ciType* stack_type_at(int i) const { return _state->stack_type_at(i); } 600 601 // Data flow on locals 602 bool is_invariant_local(uint v) const { 603 assert(is_loop_head(), "only loop heads"); 604 // Find outermost loop with same loop head 605 Loop* lp = loop(); 606 while (lp->parent() != NULL) { 607 if (lp->parent()->head() != lp->head()) break; 608 lp = lp->parent(); 609 } 610 return !lp->def_locals()->test(v); 611 } 612 LocalSet* def_locals() { return _state->def_locals(); } 613 const LocalSet* def_locals() const { return _state->def_locals(); } 614 615 // Get the successors for this Block. 616 GrowableArray<Block*>* successors(ciBytecodeStream* str, 617 StateVector* state, 618 JsrSet* jsrs); 619 GrowableArray<Block*>* successors() { 620 assert(_successors != NULL, "must be filled in"); 621 return _successors; 622 } 623 624 // Predecessors of this block (including exception edges) 625 GrowableArray<Block*>* predecessors() { 626 assert(_predecessors != NULL, "must be filled in"); 627 return _predecessors; 628 } 629 630 // Get the exceptional successors for this Block. 631 GrowableArray<Block*>* exceptions() { 632 if (_exceptions == NULL) { 633 compute_exceptions(); 634 } 635 return _exceptions; 636 } 637 638 // Get the exception klasses corresponding to the 639 // exceptional successors for this Block. 640 GrowableArray<ciInstanceKlass*>* exc_klasses() { 641 if (_exc_klasses == NULL) { 642 compute_exceptions(); 643 } 644 return _exc_klasses; 645 } 646 647 // Is this Block compatible with a given JsrSet? 648 bool is_compatible_with(JsrSet* other) { 649 return _jsrs->is_compatible_with(other); 650 } 651 652 // Copy the value of our state vector into another. 653 void copy_state_into(StateVector* copy) const { 654 _state->copy_into(copy); 655 } 656 657 // Copy the value of our JsrSet into another 658 void copy_jsrs_into(JsrSet* copy) const { 659 _jsrs->copy_into(copy); 660 } 661 662 // Meets the start state of this block with another state, destructively 663 // modifying this one. Returns true if any modification takes place. 664 bool meet(const StateVector* incoming) { 665 return state()->meet(incoming); 666 } 667 668 // Ditto, except that the incoming state is coming from an 669 // exception path. This means the stack is replaced by the 670 // appropriate exception type. 671 bool meet_exception(ciInstanceKlass* exc, const StateVector* incoming) { 672 return state()->meet_exception(exc, incoming); 673 } 674 675 // Work list manipulation 676 void set_next(Block* block) { _next = block; } 677 Block* next() const { return _next; } 678 679 void set_on_work_list(bool c) { _on_work_list = c; } 680 bool is_on_work_list() const { return _on_work_list; } 681 682 bool has_pre_order() const { return _pre_order >= 0; } 683 void set_pre_order(int po) { assert(!has_pre_order(), ""); _pre_order = po; } 684 int pre_order() const { assert(has_pre_order(), ""); return _pre_order; } 685 void set_next_pre_order() { set_pre_order(outer()->inc_next_pre_order()); } 686 bool is_start() const { return _pre_order == outer()->start_block_num(); } 687 688 // Reverse post order 689 void df_init(); 690 bool has_post_order() const { return _post_order >= 0; } 691 void set_post_order(int po) { assert(!has_post_order() && po >= 0, ""); _post_order = po; } 692 void reset_post_order(int o){ _post_order = o; } 693 int post_order() const { assert(has_post_order(), ""); return _post_order; } 694 695 bool has_rpo() const { return has_post_order() && outer()->have_block_count(); } 696 int rpo() const { assert(has_rpo(), ""); return outer()->block_count() - post_order() - 1; } 697 void set_rpo_next(Block* b) { _rpo_next = b; } 698 Block* rpo_next() { return _rpo_next; } 699 700 // Loops 701 Loop* loop() const { return _loop; } 702 void set_loop(Loop* lp) { _loop = lp; } 703 bool is_loop_head() const { return _loop && _loop->head() == this; } 704 void set_irreducible_entry(bool c) { _irreducible_entry = c; } 705 bool is_irreducible_entry() const { return _irreducible_entry; } 706 void set_has_monitorenter() { _has_monitorenter = true; } 707 bool has_monitorenter() const { return _has_monitorenter; } 708 bool is_visited() const { return has_pre_order(); } 709 bool is_post_visited() const { return has_post_order(); } 710 bool is_clonable_exit(Loop* lp); 711 Block* looping_succ(Loop* lp); // Successor inside of loop 712 bool is_single_entry_loop_head() const { 713 if (!is_loop_head()) return false; 714 for (Loop* lp = loop(); lp != NULL && lp->head() == this; lp = lp->parent()) 715 if (lp->is_irreducible()) return false; 716 return true; 717 } 718 719 void print_value_on(outputStream* st) const PRODUCT_RETURN; 720 void print_on(outputStream* st) const PRODUCT_RETURN; 721 }; 722 723 // Loop 724 class Loop : public ResourceObj { 725 private: 726 Loop* _parent; 727 Loop* _sibling; // List of siblings, null terminated 728 Loop* _child; // Head of child list threaded thru sibling pointer 729 Block* _head; // Head of loop 730 Block* _tail; // Tail of loop 731 bool _irreducible; 732 LocalSet _def_locals; 733 734 public: 735 Loop(Block* head, Block* tail) : 736 _head(head), _tail(tail), 737 _parent(NULL), _sibling(NULL), _child(NULL), 738 _irreducible(false), _def_locals() {} 739 740 Loop* parent() const { return _parent; } 741 Loop* sibling() const { return _sibling; } 742 Loop* child() const { return _child; } 743 Block* head() const { return _head; } 744 Block* tail() const { return _tail; } 745 void set_parent(Loop* p) { _parent = p; } 746 void set_sibling(Loop* s) { _sibling = s; } 747 void set_child(Loop* c) { _child = c; } 748 void set_head(Block* hd) { _head = hd; } 749 void set_tail(Block* tl) { _tail = tl; } 750 751 int depth() const; // nesting depth 752 753 // Returns true if lp is a nested loop or us. 754 bool contains(Loop* lp) const; 755 bool contains(Block* blk) const { return contains(blk->loop()); } 756 757 // Data flow on locals 758 LocalSet* def_locals() { return &_def_locals; } 759 const LocalSet* def_locals() const { return &_def_locals; } 760 761 // Merge the branch lp into this branch, sorting on the loop head 762 // pre_orders. Returns the new branch. 763 Loop* sorted_merge(Loop* lp); 764 765 // Mark non-single entry to loop 766 void set_irreducible(Block* entry) { 767 _irreducible = true; 768 entry->set_irreducible_entry(true); 769 } 770 bool is_irreducible() const { return _irreducible; } 771 772 bool is_root() const { return _tail->pre_order() == max_jint; } 773 774 void print(outputStream* st = tty, int indent = 0) const PRODUCT_RETURN; 775 }; 776 777 // Postorder iteration over the loop tree. 778 class PostorderLoops : public StackObj { 779 private: 780 Loop* _root; 781 Loop* _current; 782 public: 783 PostorderLoops(Loop* root) : _root(root), _current(root) { 784 while (_current->child() != NULL) { 785 _current = _current->child(); 786 } 787 } 788 bool done() { return _current == NULL; } // Finished iterating? 789 void next(); // Advance to next loop 790 Loop* current() { return _current; } // Return current loop. 791 }; 792 793 // Preorder iteration over the loop tree. 794 class PreorderLoops : public StackObj { 795 private: 796 Loop* _root; 797 Loop* _current; 798 public: 799 PreorderLoops(Loop* root) : _root(root), _current(root) {} 800 bool done() { return _current == NULL; } // Finished iterating? 801 void next(); // Advance to next loop 802 Loop* current() { return _current; } // Return current loop. 803 }; 804 805 // Standard indexes of successors, for various bytecodes. 806 enum { 807 FALL_THROUGH = 0, // normal control 808 IF_NOT_TAKEN = 0, // the not-taken branch of an if (i.e., fall-through) 809 IF_TAKEN = 1, // the taken branch of an if 810 GOTO_TARGET = 0, // unique successor for goto, jsr, or ret 811 SWITCH_DEFAULT = 0, // default branch of a switch 812 SWITCH_CASES = 1 // first index for any non-default switch branches 813 // Unlike in other blocks, the successors of a switch are listed uniquely. 814 }; 815 816 private: 817 // A mapping from pre_order to Blocks. This array is created 818 // only at the end of the flow. 819 Block** _block_map; 820 821 // For each ciBlock index, a list of Blocks which share this ciBlock. 822 GrowableArray<Block*>** _idx_to_blocklist; 823 // count of ciBlocks 824 int _ciblock_count; 825 826 // Tells if a given instruction is able to generate an exception edge. 827 bool can_trap(ciBytecodeStream& str); 828 829 // Clone the loop heads. Returns true if any cloning occurred. 830 bool clone_loop_heads(Loop* lp, StateVector* temp_vector, JsrSet* temp_set); 831 832 // Clone lp's head and replace tail's successors with clone. 833 Block* clone_loop_head(Loop* lp, StateVector* temp_vector, JsrSet* temp_set); 834 835 public: 836 // Return the block beginning at bci which has a JsrSet compatible 837 // with jsrs. 838 Block* block_at(int bci, JsrSet* set, CreateOption option = create_public_copy); 839 840 // block factory 841 Block* get_block_for(int ciBlockIndex, JsrSet* jsrs, CreateOption option = create_public_copy); 842 843 // How many of the blocks have the backedge_copy bit set? 844 int backedge_copy_count(int ciBlockIndex, JsrSet* jsrs) const; 845 846 // Return an existing block containing bci which has a JsrSet compatible 847 // with jsrs, or NULL if there is none. 848 Block* existing_block_at(int bci, JsrSet* set) { return block_at(bci, set, no_create); } 849 850 // Tell whether the flow analysis has encountered an error of some sort. 851 bool failing() { return env()->failing() || _failure_reason != NULL; } 852 853 // Reason this compilation is failing, such as "too many basic blocks". 854 const char* failure_reason() { return _failure_reason; } 855 856 // Note a failure. 857 void record_failure(const char* reason); 858 859 // Return the block of a given pre-order number. 860 int have_block_count() const { return _block_map != NULL; } 861 int block_count() const { assert(have_block_count(), ""); 862 return _next_pre_order; } 863 Block* pre_order_at(int po) const { assert(0 <= po && po < block_count(), "out of bounds"); 864 return _block_map[po]; } 865 Block* start_block() const { return pre_order_at(start_block_num()); } 866 int start_block_num() const { return 0; } 867 Block* rpo_at(int rpo) const { assert(0 <= rpo && rpo < block_count(), "out of bounds"); 868 return _block_map[rpo]; } 869 int next_pre_order() { return _next_pre_order; } 870 int inc_next_pre_order() { return _next_pre_order++; } 871 872 private: 873 // A work list used during flow analysis. 874 Block* _work_list; 875 876 // List of blocks in reverse post order 877 Block* _rpo_list; 878 879 // Next Block::_pre_order. After mapping, doubles as block_count. 880 int _next_pre_order; 881 882 // Are there more blocks on the work list? 883 bool work_list_empty() { return _work_list == NULL; } 884 885 // Get the next basic block from our work list. 886 Block* work_list_next(); 887 888 // Add a basic block to our work list. 889 void add_to_work_list(Block* block); 890 891 // Prepend a basic block to rpo list. 892 void prepend_to_rpo_list(Block* blk) { 893 blk->set_rpo_next(_rpo_list); 894 _rpo_list = blk; 895 } 896 897 // Root of the loop tree 898 Loop* _loop_tree_root; 899 900 // State used for make_jsr_record 901 int _jsr_count; 902 GrowableArray<JsrRecord*>* _jsr_records; 903 904 public: 905 // Make a JsrRecord for a given (entry, return) pair, if such a record 906 // does not already exist. 907 JsrRecord* make_jsr_record(int entry_address, int return_address); 908 909 void set_loop_tree_root(Loop* ltr) { _loop_tree_root = ltr; } 910 Loop* loop_tree_root() { return _loop_tree_root; } 911 912 private: 913 // Get the initial state for start_bci: 914 const StateVector* get_start_state(); 915 916 // Merge the current state into all exceptional successors at the 917 // current point in the code. 918 void flow_exceptions(GrowableArray<Block*>* exceptions, 919 GrowableArray<ciInstanceKlass*>* exc_klasses, 920 StateVector* state); 921 922 // Merge the current state into all successors at the current point 923 // in the code. 924 void flow_successors(GrowableArray<Block*>* successors, 925 StateVector* state); 926 927 // Interpret the effects of the bytecodes on the incoming state 928 // vector of a basic block. Push the changed state to succeeding 929 // basic blocks. 930 void flow_block(Block* block, 931 StateVector* scratch_state, 932 JsrSet* scratch_jsrs); 933 934 // Perform the type flow analysis, creating and cloning Blocks as 935 // necessary. 936 void flow_types(); 937 938 // Perform the depth first type flow analysis. Helper for flow_types. 939 void df_flow_types(Block* start, 940 bool do_flow, 941 StateVector* temp_vector, 942 JsrSet* temp_set); 943 944 // Incrementally build loop tree. 945 void build_loop_tree(Block* blk); 946 947 // Create the block map, which indexes blocks in pre_order. 948 void map_blocks(); 949 950 public: 951 // Perform type inference flow analysis. 952 void do_flow(); 953 954 // Determine if bci is dominated by dom_bci 955 bool is_dominated_by(int bci, int dom_bci); 956 957 void print_on(outputStream* st) const PRODUCT_RETURN; 958 959 void rpo_print_on(outputStream* st) const PRODUCT_RETURN; 960 }; 961 962 #endif // SHARE_VM_CI_CITYPEFLOW_HPP