nodes.h revision 10c9cbe05ab860cb7d5ce82c411698a10f811aa6
1/* 2 * Copyright (C) 2014 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17#ifndef ART_COMPILER_OPTIMIZING_NODES_H_ 18#define ART_COMPILER_OPTIMIZING_NODES_H_ 19 20#include "invoke_type.h" 21#include "locations.h" 22#include "offsets.h" 23#include "primitive.h" 24#include "utils/arena_object.h" 25#include "utils/arena_bit_vector.h" 26#include "utils/growable_array.h" 27 28namespace art { 29 30class HBasicBlock; 31class HEnvironment; 32class HInstruction; 33class HIntConstant; 34class HInvoke; 35class HGraphVisitor; 36class HPhi; 37class HSuspendCheck; 38class LiveInterval; 39class LocationSummary; 40 41static const int kDefaultNumberOfBlocks = 8; 42static const int kDefaultNumberOfSuccessors = 2; 43static const int kDefaultNumberOfPredecessors = 2; 44static const int kDefaultNumberOfDominatedBlocks = 1; 45static const int kDefaultNumberOfBackEdges = 1; 46 47static constexpr uint32_t kMaxIntShiftValue = 0x1f; 48static constexpr uint64_t kMaxLongShiftValue = 0x3f; 49 50enum IfCondition { 51 kCondEQ, 52 kCondNE, 53 kCondLT, 54 kCondLE, 55 kCondGT, 56 kCondGE, 57}; 58 59class HInstructionList { 60 public: 61 HInstructionList() : first_instruction_(nullptr), last_instruction_(nullptr) {} 62 63 void AddInstruction(HInstruction* instruction); 64 void RemoveInstruction(HInstruction* instruction); 65 66 // Return true if this list contains `instruction`. 67 bool Contains(HInstruction* instruction) const; 68 69 // Return true if `instruction1` is found before `instruction2` in 70 // this instruction list and false otherwise. Abort if none 71 // of these instructions is found. 72 bool FoundBefore(const HInstruction* instruction1, 73 const HInstruction* instruction2) const; 74 75 private: 76 HInstruction* first_instruction_; 77 HInstruction* last_instruction_; 78 79 friend class HBasicBlock; 80 friend class HGraph; 81 friend class HInstruction; 82 friend class HInstructionIterator; 83 friend class HBackwardInstructionIterator; 84 85 DISALLOW_COPY_AND_ASSIGN(HInstructionList); 86}; 87 88// Control-flow graph of a method. Contains a list of basic blocks. 89class HGraph : public ArenaObject<kArenaAllocMisc> { 90 public: 91 HGraph(ArenaAllocator* arena, int start_instruction_id = 0) 92 : arena_(arena), 93 blocks_(arena, kDefaultNumberOfBlocks), 94 reverse_post_order_(arena, kDefaultNumberOfBlocks), 95 entry_block_(nullptr), 96 exit_block_(nullptr), 97 maximum_number_of_out_vregs_(0), 98 number_of_vregs_(0), 99 number_of_in_vregs_(0), 100 temporaries_vreg_slots_(0), 101 current_instruction_id_(start_instruction_id) {} 102 103 ArenaAllocator* GetArena() const { return arena_; } 104 const GrowableArray<HBasicBlock*>& GetBlocks() const { return blocks_; } 105 HBasicBlock* GetBlock(size_t id) const { return blocks_.Get(id); } 106 107 HBasicBlock* GetEntryBlock() const { return entry_block_; } 108 HBasicBlock* GetExitBlock() const { return exit_block_; } 109 110 void SetEntryBlock(HBasicBlock* block) { entry_block_ = block; } 111 void SetExitBlock(HBasicBlock* block) { exit_block_ = block; } 112 113 void AddBlock(HBasicBlock* block); 114 115 // Try building the SSA form of this graph, with dominance computation and loop 116 // recognition. Returns whether it was successful in doing all these steps. 117 bool TryBuildingSsa() { 118 BuildDominatorTree(); 119 TransformToSsa(); 120 return AnalyzeNaturalLoops(); 121 } 122 123 void BuildDominatorTree(); 124 void TransformToSsa(); 125 void SimplifyCFG(); 126 127 // Analyze all natural loops in this graph. Returns false if one 128 // loop is not natural, that is the header does not dominate the 129 // back edge. 130 bool AnalyzeNaturalLoops() const; 131 132 // Inline this graph in `outer_graph`, replacing the given `invoke` instruction. 133 void InlineInto(HGraph* outer_graph, HInvoke* invoke); 134 135 void SplitCriticalEdge(HBasicBlock* block, HBasicBlock* successor); 136 void SimplifyLoop(HBasicBlock* header); 137 138 int32_t GetNextInstructionId() { 139 DCHECK_NE(current_instruction_id_, INT32_MAX); 140 return current_instruction_id_++; 141 } 142 143 int32_t GetCurrentInstructionId() const { 144 return current_instruction_id_; 145 } 146 147 void SetCurrentInstructionId(int32_t id) { 148 current_instruction_id_ = id; 149 } 150 151 uint16_t GetMaximumNumberOfOutVRegs() const { 152 return maximum_number_of_out_vregs_; 153 } 154 155 void SetMaximumNumberOfOutVRegs(uint16_t new_value) { 156 maximum_number_of_out_vregs_ = new_value; 157 } 158 159 void UpdateTemporariesVRegSlots(size_t slots) { 160 temporaries_vreg_slots_ = std::max(slots, temporaries_vreg_slots_); 161 } 162 163 size_t GetTemporariesVRegSlots() const { 164 return temporaries_vreg_slots_; 165 } 166 167 void SetNumberOfVRegs(uint16_t number_of_vregs) { 168 number_of_vregs_ = number_of_vregs; 169 } 170 171 uint16_t GetNumberOfVRegs() const { 172 return number_of_vregs_; 173 } 174 175 void SetNumberOfInVRegs(uint16_t value) { 176 number_of_in_vregs_ = value; 177 } 178 179 uint16_t GetNumberOfLocalVRegs() const { 180 return number_of_vregs_ - number_of_in_vregs_; 181 } 182 183 const GrowableArray<HBasicBlock*>& GetReversePostOrder() const { 184 return reverse_post_order_; 185 } 186 187 private: 188 HBasicBlock* FindCommonDominator(HBasicBlock* first, HBasicBlock* second) const; 189 void VisitBlockForDominatorTree(HBasicBlock* block, 190 HBasicBlock* predecessor, 191 GrowableArray<size_t>* visits); 192 void FindBackEdges(ArenaBitVector* visited); 193 void VisitBlockForBackEdges(HBasicBlock* block, 194 ArenaBitVector* visited, 195 ArenaBitVector* visiting); 196 void RemoveInstructionsAsUsersFromDeadBlocks(const ArenaBitVector& visited) const; 197 void RemoveDeadBlocks(const ArenaBitVector& visited) const; 198 199 ArenaAllocator* const arena_; 200 201 // List of blocks in insertion order. 202 GrowableArray<HBasicBlock*> blocks_; 203 204 // List of blocks to perform a reverse post order tree traversal. 205 GrowableArray<HBasicBlock*> reverse_post_order_; 206 207 HBasicBlock* entry_block_; 208 HBasicBlock* exit_block_; 209 210 // The maximum number of virtual registers arguments passed to a HInvoke in this graph. 211 uint16_t maximum_number_of_out_vregs_; 212 213 // The number of virtual registers in this method. Contains the parameters. 214 uint16_t number_of_vregs_; 215 216 // The number of virtual registers used by parameters of this method. 217 uint16_t number_of_in_vregs_; 218 219 // Number of vreg size slots that the temporaries use (used in baseline compiler). 220 size_t temporaries_vreg_slots_; 221 222 // The current id to assign to a newly added instruction. See HInstruction.id_. 223 int32_t current_instruction_id_; 224 225 ART_FRIEND_TEST(GraphTest, IfSuccessorSimpleJoinBlock1); 226 DISALLOW_COPY_AND_ASSIGN(HGraph); 227}; 228 229class HLoopInformation : public ArenaObject<kArenaAllocMisc> { 230 public: 231 HLoopInformation(HBasicBlock* header, HGraph* graph) 232 : header_(header), 233 suspend_check_(nullptr), 234 back_edges_(graph->GetArena(), kDefaultNumberOfBackEdges), 235 // Make bit vector growable, as the number of blocks may change. 236 blocks_(graph->GetArena(), graph->GetBlocks().Size(), true) {} 237 238 HBasicBlock* GetHeader() const { 239 return header_; 240 } 241 242 HSuspendCheck* GetSuspendCheck() const { return suspend_check_; } 243 void SetSuspendCheck(HSuspendCheck* check) { suspend_check_ = check; } 244 bool HasSuspendCheck() const { return suspend_check_ != nullptr; } 245 246 void AddBackEdge(HBasicBlock* back_edge) { 247 back_edges_.Add(back_edge); 248 } 249 250 void RemoveBackEdge(HBasicBlock* back_edge) { 251 back_edges_.Delete(back_edge); 252 } 253 254 bool IsBackEdge(HBasicBlock* block) { 255 for (size_t i = 0, e = back_edges_.Size(); i < e; ++i) { 256 if (back_edges_.Get(i) == block) return true; 257 } 258 return false; 259 } 260 261 size_t NumberOfBackEdges() const { 262 return back_edges_.Size(); 263 } 264 265 HBasicBlock* GetPreHeader() const; 266 267 const GrowableArray<HBasicBlock*>& GetBackEdges() const { 268 return back_edges_; 269 } 270 271 void ClearBackEdges() { 272 back_edges_.Reset(); 273 } 274 275 // Find blocks that are part of this loop. Returns whether the loop is a natural loop, 276 // that is the header dominates the back edge. 277 bool Populate(); 278 279 // Returns whether this loop information contains `block`. 280 // Note that this loop information *must* be populated before entering this function. 281 bool Contains(const HBasicBlock& block) const; 282 283 // Returns whether this loop information is an inner loop of `other`. 284 // Note that `other` *must* be populated before entering this function. 285 bool IsIn(const HLoopInformation& other) const; 286 287 const ArenaBitVector& GetBlocks() const { return blocks_; } 288 289 private: 290 // Internal recursive implementation of `Populate`. 291 void PopulateRecursive(HBasicBlock* block); 292 293 HBasicBlock* header_; 294 HSuspendCheck* suspend_check_; 295 GrowableArray<HBasicBlock*> back_edges_; 296 ArenaBitVector blocks_; 297 298 DISALLOW_COPY_AND_ASSIGN(HLoopInformation); 299}; 300 301static constexpr size_t kNoLifetime = -1; 302static constexpr uint32_t kNoDexPc = -1; 303 304// A block in a method. Contains the list of instructions represented 305// as a double linked list. Each block knows its predecessors and 306// successors. 307 308class HBasicBlock : public ArenaObject<kArenaAllocMisc> { 309 public: 310 explicit HBasicBlock(HGraph* graph, uint32_t dex_pc = kNoDexPc) 311 : graph_(graph), 312 predecessors_(graph->GetArena(), kDefaultNumberOfPredecessors), 313 successors_(graph->GetArena(), kDefaultNumberOfSuccessors), 314 loop_information_(nullptr), 315 dominator_(nullptr), 316 dominated_blocks_(graph->GetArena(), kDefaultNumberOfDominatedBlocks), 317 block_id_(-1), 318 dex_pc_(dex_pc), 319 lifetime_start_(kNoLifetime), 320 lifetime_end_(kNoLifetime), 321 is_catch_block_(false) {} 322 323 const GrowableArray<HBasicBlock*>& GetPredecessors() const { 324 return predecessors_; 325 } 326 327 const GrowableArray<HBasicBlock*>& GetSuccessors() const { 328 return successors_; 329 } 330 331 const GrowableArray<HBasicBlock*>& GetDominatedBlocks() const { 332 return dominated_blocks_; 333 } 334 335 bool IsEntryBlock() const { 336 return graph_->GetEntryBlock() == this; 337 } 338 339 bool IsExitBlock() const { 340 return graph_->GetExitBlock() == this; 341 } 342 343 void AddBackEdge(HBasicBlock* back_edge) { 344 if (loop_information_ == nullptr) { 345 loop_information_ = new (graph_->GetArena()) HLoopInformation(this, graph_); 346 } 347 DCHECK_EQ(loop_information_->GetHeader(), this); 348 loop_information_->AddBackEdge(back_edge); 349 } 350 351 HGraph* GetGraph() const { return graph_; } 352 353 int GetBlockId() const { return block_id_; } 354 void SetBlockId(int id) { block_id_ = id; } 355 356 HBasicBlock* GetDominator() const { return dominator_; } 357 void SetDominator(HBasicBlock* dominator) { dominator_ = dominator; } 358 void AddDominatedBlock(HBasicBlock* block) { dominated_blocks_.Add(block); } 359 360 int NumberOfBackEdges() const { 361 return loop_information_ == nullptr 362 ? 0 363 : loop_information_->NumberOfBackEdges(); 364 } 365 366 HInstruction* GetFirstInstruction() const { return instructions_.first_instruction_; } 367 HInstruction* GetLastInstruction() const { return instructions_.last_instruction_; } 368 const HInstructionList& GetInstructions() const { return instructions_; } 369 const HInstructionList& GetPhis() const { return phis_; } 370 HInstruction* GetFirstPhi() const { return phis_.first_instruction_; } 371 372 void AddSuccessor(HBasicBlock* block) { 373 successors_.Add(block); 374 block->predecessors_.Add(this); 375 } 376 377 void ReplaceSuccessor(HBasicBlock* existing, HBasicBlock* new_block) { 378 size_t successor_index = GetSuccessorIndexOf(existing); 379 DCHECK_NE(successor_index, static_cast<size_t>(-1)); 380 existing->RemovePredecessor(this); 381 new_block->predecessors_.Add(this); 382 successors_.Put(successor_index, new_block); 383 } 384 385 void RemovePredecessor(HBasicBlock* block) { 386 predecessors_.Delete(block); 387 } 388 389 void ClearAllPredecessors() { 390 predecessors_.Reset(); 391 } 392 393 void AddPredecessor(HBasicBlock* block) { 394 predecessors_.Add(block); 395 block->successors_.Add(this); 396 } 397 398 void SwapPredecessors() { 399 DCHECK_EQ(predecessors_.Size(), 2u); 400 HBasicBlock* temp = predecessors_.Get(0); 401 predecessors_.Put(0, predecessors_.Get(1)); 402 predecessors_.Put(1, temp); 403 } 404 405 size_t GetPredecessorIndexOf(HBasicBlock* predecessor) { 406 for (size_t i = 0, e = predecessors_.Size(); i < e; ++i) { 407 if (predecessors_.Get(i) == predecessor) { 408 return i; 409 } 410 } 411 return -1; 412 } 413 414 size_t GetSuccessorIndexOf(HBasicBlock* successor) { 415 for (size_t i = 0, e = successors_.Size(); i < e; ++i) { 416 if (successors_.Get(i) == successor) { 417 return i; 418 } 419 } 420 return -1; 421 } 422 423 void AddInstruction(HInstruction* instruction); 424 void RemoveInstruction(HInstruction* instruction); 425 void InsertInstructionBefore(HInstruction* instruction, HInstruction* cursor); 426 // Replace instruction `initial` with `replacement` within this block. 427 void ReplaceAndRemoveInstructionWith(HInstruction* initial, 428 HInstruction* replacement); 429 void AddPhi(HPhi* phi); 430 void InsertPhiAfter(HPhi* instruction, HPhi* cursor); 431 void RemovePhi(HPhi* phi); 432 433 bool IsLoopHeader() const { 434 return (loop_information_ != nullptr) && (loop_information_->GetHeader() == this); 435 } 436 437 bool IsLoopPreHeaderFirstPredecessor() const { 438 DCHECK(IsLoopHeader()); 439 DCHECK(!GetPredecessors().IsEmpty()); 440 return GetPredecessors().Get(0) == GetLoopInformation()->GetPreHeader(); 441 } 442 443 HLoopInformation* GetLoopInformation() const { 444 return loop_information_; 445 } 446 447 // Set the loop_information_ on this block. This method overrides the current 448 // loop_information if it is an outer loop of the passed loop information. 449 void SetInLoop(HLoopInformation* info) { 450 if (IsLoopHeader()) { 451 // Nothing to do. This just means `info` is an outer loop. 452 } else if (loop_information_ == nullptr) { 453 loop_information_ = info; 454 } else if (loop_information_->Contains(*info->GetHeader())) { 455 // Block is currently part of an outer loop. Make it part of this inner loop. 456 // Note that a non loop header having a loop information means this loop information 457 // has already been populated 458 loop_information_ = info; 459 } else { 460 // Block is part of an inner loop. Do not update the loop information. 461 // Note that we cannot do the check `info->Contains(loop_information_)->GetHeader()` 462 // at this point, because this method is being called while populating `info`. 463 } 464 } 465 466 bool IsInLoop() const { return loop_information_ != nullptr; } 467 468 // Returns wheter this block dominates the blocked passed as parameter. 469 bool Dominates(HBasicBlock* block) const; 470 471 size_t GetLifetimeStart() const { return lifetime_start_; } 472 size_t GetLifetimeEnd() const { return lifetime_end_; } 473 474 void SetLifetimeStart(size_t start) { lifetime_start_ = start; } 475 void SetLifetimeEnd(size_t end) { lifetime_end_ = end; } 476 477 uint32_t GetDexPc() const { return dex_pc_; } 478 479 bool IsCatchBlock() const { return is_catch_block_; } 480 void SetIsCatchBlock() { is_catch_block_ = true; } 481 482 private: 483 HGraph* const graph_; 484 GrowableArray<HBasicBlock*> predecessors_; 485 GrowableArray<HBasicBlock*> successors_; 486 HInstructionList instructions_; 487 HInstructionList phis_; 488 HLoopInformation* loop_information_; 489 HBasicBlock* dominator_; 490 GrowableArray<HBasicBlock*> dominated_blocks_; 491 int block_id_; 492 // The dex program counter of the first instruction of this block. 493 const uint32_t dex_pc_; 494 size_t lifetime_start_; 495 size_t lifetime_end_; 496 bool is_catch_block_; 497 498 friend class HGraph; 499 friend class HInstruction; 500 501 DISALLOW_COPY_AND_ASSIGN(HBasicBlock); 502}; 503 504#define FOR_EACH_CONCRETE_INSTRUCTION(M) \ 505 M(Add, BinaryOperation) \ 506 M(And, BinaryOperation) \ 507 M(ArrayGet, Instruction) \ 508 M(ArrayLength, Instruction) \ 509 M(ArraySet, Instruction) \ 510 M(BoundsCheck, Instruction) \ 511 M(CheckCast, Instruction) \ 512 M(ClinitCheck, Instruction) \ 513 M(Compare, BinaryOperation) \ 514 M(Condition, BinaryOperation) \ 515 M(Div, BinaryOperation) \ 516 M(DivZeroCheck, Instruction) \ 517 M(DoubleConstant, Constant) \ 518 M(Equal, Condition) \ 519 M(Exit, Instruction) \ 520 M(FloatConstant, Constant) \ 521 M(Goto, Instruction) \ 522 M(GreaterThan, Condition) \ 523 M(GreaterThanOrEqual, Condition) \ 524 M(If, Instruction) \ 525 M(InstanceFieldGet, Instruction) \ 526 M(InstanceFieldSet, Instruction) \ 527 M(InstanceOf, Instruction) \ 528 M(IntConstant, Constant) \ 529 M(InvokeInterface, Invoke) \ 530 M(InvokeStaticOrDirect, Invoke) \ 531 M(InvokeVirtual, Invoke) \ 532 M(LessThan, Condition) \ 533 M(LessThanOrEqual, Condition) \ 534 M(LoadClass, Instruction) \ 535 M(LoadException, Instruction) \ 536 M(LoadLocal, Instruction) \ 537 M(LoadString, Instruction) \ 538 M(Local, Instruction) \ 539 M(LongConstant, Constant) \ 540 M(MonitorOperation, Instruction) \ 541 M(Mul, BinaryOperation) \ 542 M(Neg, UnaryOperation) \ 543 M(NewArray, Instruction) \ 544 M(NewInstance, Instruction) \ 545 M(Not, UnaryOperation) \ 546 M(NotEqual, Condition) \ 547 M(NullCheck, Instruction) \ 548 M(Or, BinaryOperation) \ 549 M(ParallelMove, Instruction) \ 550 M(ParameterValue, Instruction) \ 551 M(Phi, Instruction) \ 552 M(Rem, BinaryOperation) \ 553 M(Return, Instruction) \ 554 M(ReturnVoid, Instruction) \ 555 M(Shl, BinaryOperation) \ 556 M(Shr, BinaryOperation) \ 557 M(StaticFieldGet, Instruction) \ 558 M(StaticFieldSet, Instruction) \ 559 M(StoreLocal, Instruction) \ 560 M(Sub, BinaryOperation) \ 561 M(SuspendCheck, Instruction) \ 562 M(Temporary, Instruction) \ 563 M(Throw, Instruction) \ 564 M(TypeConversion, Instruction) \ 565 M(UShr, BinaryOperation) \ 566 M(Xor, BinaryOperation) \ 567 568#define FOR_EACH_INSTRUCTION(M) \ 569 FOR_EACH_CONCRETE_INSTRUCTION(M) \ 570 M(Constant, Instruction) \ 571 M(UnaryOperation, Instruction) \ 572 M(BinaryOperation, Instruction) \ 573 M(Invoke, Instruction) 574 575#define FORWARD_DECLARATION(type, super) class H##type; 576FOR_EACH_INSTRUCTION(FORWARD_DECLARATION) 577#undef FORWARD_DECLARATION 578 579#define DECLARE_INSTRUCTION(type) \ 580 virtual InstructionKind GetKind() const { return k##type; } \ 581 virtual const char* DebugName() const { return #type; } \ 582 virtual const H##type* As##type() const OVERRIDE { return this; } \ 583 virtual H##type* As##type() OVERRIDE { return this; } \ 584 virtual bool InstructionTypeEquals(HInstruction* other) const { \ 585 return other->Is##type(); \ 586 } \ 587 virtual void Accept(HGraphVisitor* visitor) 588 589template <typename T> 590class HUseListNode : public ArenaObject<kArenaAllocMisc> { 591 public: 592 HUseListNode(T* user, size_t index, HUseListNode* tail) 593 : user_(user), index_(index), tail_(tail) {} 594 595 HUseListNode* GetTail() const { return tail_; } 596 T* GetUser() const { return user_; } 597 size_t GetIndex() const { return index_; } 598 599 void SetTail(HUseListNode<T>* node) { tail_ = node; } 600 601 private: 602 T* const user_; 603 const size_t index_; 604 HUseListNode<T>* tail_; 605 606 DISALLOW_COPY_AND_ASSIGN(HUseListNode); 607}; 608 609// Represents the side effects an instruction may have. 610class SideEffects : public ValueObject { 611 public: 612 SideEffects() : flags_(0) {} 613 614 static SideEffects None() { 615 return SideEffects(0); 616 } 617 618 static SideEffects All() { 619 return SideEffects(ChangesSomething().flags_ | DependsOnSomething().flags_); 620 } 621 622 static SideEffects ChangesSomething() { 623 return SideEffects((1 << kFlagChangesCount) - 1); 624 } 625 626 static SideEffects DependsOnSomething() { 627 int count = kFlagDependsOnCount - kFlagChangesCount; 628 return SideEffects(((1 << count) - 1) << kFlagChangesCount); 629 } 630 631 SideEffects Union(SideEffects other) const { 632 return SideEffects(flags_ | other.flags_); 633 } 634 635 bool HasSideEffects() const { 636 size_t all_bits_set = (1 << kFlagChangesCount) - 1; 637 return (flags_ & all_bits_set) != 0; 638 } 639 640 bool HasAllSideEffects() const { 641 size_t all_bits_set = (1 << kFlagChangesCount) - 1; 642 return all_bits_set == (flags_ & all_bits_set); 643 } 644 645 bool DependsOn(SideEffects other) const { 646 size_t depends_flags = other.ComputeDependsFlags(); 647 return (flags_ & depends_flags) != 0; 648 } 649 650 bool HasDependencies() const { 651 int count = kFlagDependsOnCount - kFlagChangesCount; 652 size_t all_bits_set = (1 << count) - 1; 653 return ((flags_ >> kFlagChangesCount) & all_bits_set) != 0; 654 } 655 656 private: 657 static constexpr int kFlagChangesSomething = 0; 658 static constexpr int kFlagChangesCount = kFlagChangesSomething + 1; 659 660 static constexpr int kFlagDependsOnSomething = kFlagChangesCount; 661 static constexpr int kFlagDependsOnCount = kFlagDependsOnSomething + 1; 662 663 explicit SideEffects(size_t flags) : flags_(flags) {} 664 665 size_t ComputeDependsFlags() const { 666 return flags_ << kFlagChangesCount; 667 } 668 669 size_t flags_; 670}; 671 672class HInstruction : public ArenaObject<kArenaAllocMisc> { 673 public: 674 explicit HInstruction(SideEffects side_effects) 675 : previous_(nullptr), 676 next_(nullptr), 677 block_(nullptr), 678 id_(-1), 679 ssa_index_(-1), 680 uses_(nullptr), 681 env_uses_(nullptr), 682 environment_(nullptr), 683 locations_(nullptr), 684 live_interval_(nullptr), 685 lifetime_position_(kNoLifetime), 686 side_effects_(side_effects) {} 687 688 virtual ~HInstruction() {} 689 690#define DECLARE_KIND(type, super) k##type, 691 enum InstructionKind { 692 FOR_EACH_INSTRUCTION(DECLARE_KIND) 693 }; 694#undef DECLARE_KIND 695 696 HInstruction* GetNext() const { return next_; } 697 HInstruction* GetPrevious() const { return previous_; } 698 699 HBasicBlock* GetBlock() const { return block_; } 700 void SetBlock(HBasicBlock* block) { block_ = block; } 701 bool IsInBlock() const { return block_ != nullptr; } 702 bool IsInLoop() const { return block_->IsInLoop(); } 703 bool IsLoopHeaderPhi() { return IsPhi() && block_->IsLoopHeader(); } 704 705 virtual size_t InputCount() const = 0; 706 virtual HInstruction* InputAt(size_t i) const = 0; 707 708 virtual void Accept(HGraphVisitor* visitor) = 0; 709 virtual const char* DebugName() const = 0; 710 711 virtual Primitive::Type GetType() const { return Primitive::kPrimVoid; } 712 virtual void SetRawInputAt(size_t index, HInstruction* input) = 0; 713 714 virtual bool NeedsEnvironment() const { return false; } 715 virtual bool IsControlFlow() const { return false; } 716 virtual bool CanThrow() const { return false; } 717 bool HasSideEffects() const { return side_effects_.HasSideEffects(); } 718 719 void AddUseAt(HInstruction* user, size_t index) { 720 uses_ = new (block_->GetGraph()->GetArena()) HUseListNode<HInstruction>(user, index, uses_); 721 } 722 723 void AddEnvUseAt(HEnvironment* user, size_t index) { 724 DCHECK(user != nullptr); 725 env_uses_ = new (block_->GetGraph()->GetArena()) HUseListNode<HEnvironment>( 726 user, index, env_uses_); 727 } 728 729 void RemoveUser(HInstruction* user, size_t index); 730 void RemoveEnvironmentUser(HEnvironment* user, size_t index); 731 732 HUseListNode<HInstruction>* GetUses() const { return uses_; } 733 HUseListNode<HEnvironment>* GetEnvUses() const { return env_uses_; } 734 735 bool HasUses() const { return uses_ != nullptr || env_uses_ != nullptr; } 736 bool HasEnvironmentUses() const { return env_uses_ != nullptr; } 737 738 size_t NumberOfUses() const { 739 // TODO: Optimize this method if it is used outside of the HGraphVisualizer. 740 size_t result = 0; 741 HUseListNode<HInstruction>* current = uses_; 742 while (current != nullptr) { 743 current = current->GetTail(); 744 ++result; 745 } 746 return result; 747 } 748 749 // Does this instruction strictly dominate `other_instruction`? 750 // Returns false if this instruction and `other_instruction` are the same. 751 // Aborts if this instruction and `other_instruction` are both phis. 752 bool StrictlyDominates(HInstruction* other_instruction) const; 753 754 int GetId() const { return id_; } 755 void SetId(int id) { id_ = id; } 756 757 int GetSsaIndex() const { return ssa_index_; } 758 void SetSsaIndex(int ssa_index) { ssa_index_ = ssa_index; } 759 bool HasSsaIndex() const { return ssa_index_ != -1; } 760 761 bool HasEnvironment() const { return environment_ != nullptr; } 762 HEnvironment* GetEnvironment() const { return environment_; } 763 void SetEnvironment(HEnvironment* environment) { environment_ = environment; } 764 765 // Returns the number of entries in the environment. Typically, that is the 766 // number of dex registers in a method. It could be more in case of inlining. 767 size_t EnvironmentSize() const; 768 769 LocationSummary* GetLocations() const { return locations_; } 770 void SetLocations(LocationSummary* locations) { locations_ = locations; } 771 772 void ReplaceWith(HInstruction* instruction); 773 void ReplaceInput(HInstruction* replacement, size_t index); 774 775 // Insert `this` instruction in `cursor`'s graph, just before `cursor`. 776 void InsertBefore(HInstruction* cursor); 777 778 bool HasOnlyOneUse() const { 779 return uses_ != nullptr && uses_->GetTail() == nullptr; 780 } 781 782#define INSTRUCTION_TYPE_CHECK(type, super) \ 783 bool Is##type() const { return (As##type() != nullptr); } \ 784 virtual const H##type* As##type() const { return nullptr; } \ 785 virtual H##type* As##type() { return nullptr; } 786 787 FOR_EACH_INSTRUCTION(INSTRUCTION_TYPE_CHECK) 788#undef INSTRUCTION_TYPE_CHECK 789 790 // Returns whether the instruction can be moved within the graph. 791 virtual bool CanBeMoved() const { return false; } 792 793 // Returns whether the two instructions are of the same kind. 794 virtual bool InstructionTypeEquals(HInstruction* other) const { 795 UNUSED(other); 796 return false; 797 } 798 799 // Returns whether any data encoded in the two instructions is equal. 800 // This method does not look at the inputs. Both instructions must be 801 // of the same type, otherwise the method has undefined behavior. 802 virtual bool InstructionDataEquals(HInstruction* other) const { 803 UNUSED(other); 804 return false; 805 } 806 807 // Returns whether two instructions are equal, that is: 808 // 1) They have the same type and contain the same data (InstructionDataEquals). 809 // 2) Their inputs are identical. 810 bool Equals(HInstruction* other) const; 811 812 virtual InstructionKind GetKind() const = 0; 813 814 virtual size_t ComputeHashCode() const { 815 size_t result = GetKind(); 816 for (size_t i = 0, e = InputCount(); i < e; ++i) { 817 result = (result * 31) + InputAt(i)->GetId(); 818 } 819 return result; 820 } 821 822 SideEffects GetSideEffects() const { return side_effects_; } 823 824 size_t GetLifetimePosition() const { return lifetime_position_; } 825 void SetLifetimePosition(size_t position) { lifetime_position_ = position; } 826 LiveInterval* GetLiveInterval() const { return live_interval_; } 827 void SetLiveInterval(LiveInterval* interval) { live_interval_ = interval; } 828 bool HasLiveInterval() const { return live_interval_ != nullptr; } 829 830 private: 831 HInstruction* previous_; 832 HInstruction* next_; 833 HBasicBlock* block_; 834 835 // An instruction gets an id when it is added to the graph. 836 // It reflects creation order. A negative id means the instruction 837 // has not been added to the graph. 838 int id_; 839 840 // When doing liveness analysis, instructions that have uses get an SSA index. 841 int ssa_index_; 842 843 // List of instructions that have this instruction as input. 844 HUseListNode<HInstruction>* uses_; 845 846 // List of environments that contain this instruction. 847 HUseListNode<HEnvironment>* env_uses_; 848 849 // The environment associated with this instruction. Not null if the instruction 850 // might jump out of the method. 851 HEnvironment* environment_; 852 853 // Set by the code generator. 854 LocationSummary* locations_; 855 856 // Set by the liveness analysis. 857 LiveInterval* live_interval_; 858 859 // Set by the liveness analysis, this is the position in a linear 860 // order of blocks where this instruction's live interval start. 861 size_t lifetime_position_; 862 863 const SideEffects side_effects_; 864 865 friend class HBasicBlock; 866 friend class HGraph; 867 friend class HInstructionList; 868 869 DISALLOW_COPY_AND_ASSIGN(HInstruction); 870}; 871std::ostream& operator<<(std::ostream& os, const HInstruction::InstructionKind& rhs); 872 873template<typename T> 874class HUseIterator : public ValueObject { 875 public: 876 explicit HUseIterator(HUseListNode<T>* uses) : current_(uses) {} 877 878 bool Done() const { return current_ == nullptr; } 879 880 void Advance() { 881 DCHECK(!Done()); 882 current_ = current_->GetTail(); 883 } 884 885 HUseListNode<T>* Current() const { 886 DCHECK(!Done()); 887 return current_; 888 } 889 890 private: 891 HUseListNode<T>* current_; 892 893 friend class HValue; 894}; 895 896// A HEnvironment object contains the values of virtual registers at a given location. 897class HEnvironment : public ArenaObject<kArenaAllocMisc> { 898 public: 899 HEnvironment(ArenaAllocator* arena, size_t number_of_vregs) : vregs_(arena, number_of_vregs) { 900 vregs_.SetSize(number_of_vregs); 901 for (size_t i = 0; i < number_of_vregs; i++) { 902 vregs_.Put(i, nullptr); 903 } 904 } 905 906 void Populate(const GrowableArray<HInstruction*>& env) { 907 for (size_t i = 0; i < env.Size(); i++) { 908 HInstruction* instruction = env.Get(i); 909 vregs_.Put(i, instruction); 910 if (instruction != nullptr) { 911 instruction->AddEnvUseAt(this, i); 912 } 913 } 914 } 915 916 void SetRawEnvAt(size_t index, HInstruction* instruction) { 917 vregs_.Put(index, instruction); 918 } 919 920 HInstruction* GetInstructionAt(size_t index) const { 921 return vregs_.Get(index); 922 } 923 924 GrowableArray<HInstruction*>* GetVRegs() { 925 return &vregs_; 926 } 927 928 size_t Size() const { return vregs_.Size(); } 929 930 private: 931 GrowableArray<HInstruction*> vregs_; 932 933 DISALLOW_COPY_AND_ASSIGN(HEnvironment); 934}; 935 936class HInputIterator : public ValueObject { 937 public: 938 explicit HInputIterator(HInstruction* instruction) : instruction_(instruction), index_(0) {} 939 940 bool Done() const { return index_ == instruction_->InputCount(); } 941 HInstruction* Current() const { return instruction_->InputAt(index_); } 942 void Advance() { index_++; } 943 944 private: 945 HInstruction* instruction_; 946 size_t index_; 947 948 DISALLOW_COPY_AND_ASSIGN(HInputIterator); 949}; 950 951class HInstructionIterator : public ValueObject { 952 public: 953 explicit HInstructionIterator(const HInstructionList& instructions) 954 : instruction_(instructions.first_instruction_) { 955 next_ = Done() ? nullptr : instruction_->GetNext(); 956 } 957 958 bool Done() const { return instruction_ == nullptr; } 959 HInstruction* Current() const { return instruction_; } 960 void Advance() { 961 instruction_ = next_; 962 next_ = Done() ? nullptr : instruction_->GetNext(); 963 } 964 965 private: 966 HInstruction* instruction_; 967 HInstruction* next_; 968 969 DISALLOW_COPY_AND_ASSIGN(HInstructionIterator); 970}; 971 972class HBackwardInstructionIterator : public ValueObject { 973 public: 974 explicit HBackwardInstructionIterator(const HInstructionList& instructions) 975 : instruction_(instructions.last_instruction_) { 976 next_ = Done() ? nullptr : instruction_->GetPrevious(); 977 } 978 979 bool Done() const { return instruction_ == nullptr; } 980 HInstruction* Current() const { return instruction_; } 981 void Advance() { 982 instruction_ = next_; 983 next_ = Done() ? nullptr : instruction_->GetPrevious(); 984 } 985 986 private: 987 HInstruction* instruction_; 988 HInstruction* next_; 989 990 DISALLOW_COPY_AND_ASSIGN(HBackwardInstructionIterator); 991}; 992 993// An embedded container with N elements of type T. Used (with partial 994// specialization for N=0) because embedded arrays cannot have size 0. 995template<typename T, intptr_t N> 996class EmbeddedArray { 997 public: 998 EmbeddedArray() : elements_() {} 999 1000 intptr_t GetLength() const { return N; } 1001 1002 const T& operator[](intptr_t i) const { 1003 DCHECK_LT(i, GetLength()); 1004 return elements_[i]; 1005 } 1006 1007 T& operator[](intptr_t i) { 1008 DCHECK_LT(i, GetLength()); 1009 return elements_[i]; 1010 } 1011 1012 const T& At(intptr_t i) const { 1013 return (*this)[i]; 1014 } 1015 1016 void SetAt(intptr_t i, const T& val) { 1017 (*this)[i] = val; 1018 } 1019 1020 private: 1021 T elements_[N]; 1022}; 1023 1024template<typename T> 1025class EmbeddedArray<T, 0> { 1026 public: 1027 intptr_t length() const { return 0; } 1028 const T& operator[](intptr_t i) const { 1029 UNUSED(i); 1030 LOG(FATAL) << "Unreachable"; 1031 UNREACHABLE(); 1032 } 1033 T& operator[](intptr_t i) { 1034 UNUSED(i); 1035 LOG(FATAL) << "Unreachable"; 1036 UNREACHABLE(); 1037 } 1038}; 1039 1040template<intptr_t N> 1041class HTemplateInstruction: public HInstruction { 1042 public: 1043 HTemplateInstruction<N>(SideEffects side_effects) 1044 : HInstruction(side_effects), inputs_() {} 1045 virtual ~HTemplateInstruction() {} 1046 1047 virtual size_t InputCount() const { return N; } 1048 virtual HInstruction* InputAt(size_t i) const { return inputs_[i]; } 1049 1050 protected: 1051 virtual void SetRawInputAt(size_t i, HInstruction* instruction) { 1052 inputs_[i] = instruction; 1053 } 1054 1055 private: 1056 EmbeddedArray<HInstruction*, N> inputs_; 1057 1058 friend class SsaBuilder; 1059}; 1060 1061template<intptr_t N> 1062class HExpression : public HTemplateInstruction<N> { 1063 public: 1064 HExpression<N>(Primitive::Type type, SideEffects side_effects) 1065 : HTemplateInstruction<N>(side_effects), type_(type) {} 1066 virtual ~HExpression() {} 1067 1068 virtual Primitive::Type GetType() const { return type_; } 1069 1070 protected: 1071 Primitive::Type type_; 1072}; 1073 1074// Represents dex's RETURN_VOID opcode. A HReturnVoid is a control flow 1075// instruction that branches to the exit block. 1076class HReturnVoid : public HTemplateInstruction<0> { 1077 public: 1078 HReturnVoid() : HTemplateInstruction(SideEffects::None()) {} 1079 1080 virtual bool IsControlFlow() const { return true; } 1081 1082 DECLARE_INSTRUCTION(ReturnVoid); 1083 1084 private: 1085 DISALLOW_COPY_AND_ASSIGN(HReturnVoid); 1086}; 1087 1088// Represents dex's RETURN opcodes. A HReturn is a control flow 1089// instruction that branches to the exit block. 1090class HReturn : public HTemplateInstruction<1> { 1091 public: 1092 explicit HReturn(HInstruction* value) : HTemplateInstruction(SideEffects::None()) { 1093 SetRawInputAt(0, value); 1094 } 1095 1096 virtual bool IsControlFlow() const { return true; } 1097 1098 DECLARE_INSTRUCTION(Return); 1099 1100 private: 1101 DISALLOW_COPY_AND_ASSIGN(HReturn); 1102}; 1103 1104// The exit instruction is the only instruction of the exit block. 1105// Instructions aborting the method (HThrow and HReturn) must branch to the 1106// exit block. 1107class HExit : public HTemplateInstruction<0> { 1108 public: 1109 HExit() : HTemplateInstruction(SideEffects::None()) {} 1110 1111 virtual bool IsControlFlow() const { return true; } 1112 1113 DECLARE_INSTRUCTION(Exit); 1114 1115 private: 1116 DISALLOW_COPY_AND_ASSIGN(HExit); 1117}; 1118 1119// Jumps from one block to another. 1120class HGoto : public HTemplateInstruction<0> { 1121 public: 1122 HGoto() : HTemplateInstruction(SideEffects::None()) {} 1123 1124 bool IsControlFlow() const OVERRIDE { return true; } 1125 1126 HBasicBlock* GetSuccessor() const { 1127 return GetBlock()->GetSuccessors().Get(0); 1128 } 1129 1130 DECLARE_INSTRUCTION(Goto); 1131 1132 private: 1133 DISALLOW_COPY_AND_ASSIGN(HGoto); 1134}; 1135 1136 1137// Conditional branch. A block ending with an HIf instruction must have 1138// two successors. 1139class HIf : public HTemplateInstruction<1> { 1140 public: 1141 explicit HIf(HInstruction* input) : HTemplateInstruction(SideEffects::None()) { 1142 SetRawInputAt(0, input); 1143 } 1144 1145 bool IsControlFlow() const OVERRIDE { return true; } 1146 1147 HBasicBlock* IfTrueSuccessor() const { 1148 return GetBlock()->GetSuccessors().Get(0); 1149 } 1150 1151 HBasicBlock* IfFalseSuccessor() const { 1152 return GetBlock()->GetSuccessors().Get(1); 1153 } 1154 1155 DECLARE_INSTRUCTION(If); 1156 1157 virtual bool IsIfInstruction() const { return true; } 1158 1159 private: 1160 DISALLOW_COPY_AND_ASSIGN(HIf); 1161}; 1162 1163class HUnaryOperation : public HExpression<1> { 1164 public: 1165 HUnaryOperation(Primitive::Type result_type, HInstruction* input) 1166 : HExpression(result_type, SideEffects::None()) { 1167 SetRawInputAt(0, input); 1168 } 1169 1170 HInstruction* GetInput() const { return InputAt(0); } 1171 Primitive::Type GetResultType() const { return GetType(); } 1172 1173 virtual bool CanBeMoved() const { return true; } 1174 virtual bool InstructionDataEquals(HInstruction* other) const { 1175 UNUSED(other); 1176 return true; 1177 } 1178 1179 // Try to statically evaluate `operation` and return a HConstant 1180 // containing the result of this evaluation. If `operation` cannot 1181 // be evaluated as a constant, return nullptr. 1182 HConstant* TryStaticEvaluation() const; 1183 1184 // Apply this operation to `x`. 1185 virtual int32_t Evaluate(int32_t x) const = 0; 1186 virtual int64_t Evaluate(int64_t x) const = 0; 1187 1188 DECLARE_INSTRUCTION(UnaryOperation); 1189 1190 private: 1191 DISALLOW_COPY_AND_ASSIGN(HUnaryOperation); 1192}; 1193 1194class HBinaryOperation : public HExpression<2> { 1195 public: 1196 HBinaryOperation(Primitive::Type result_type, 1197 HInstruction* left, 1198 HInstruction* right) : HExpression(result_type, SideEffects::None()) { 1199 SetRawInputAt(0, left); 1200 SetRawInputAt(1, right); 1201 } 1202 1203 HInstruction* GetLeft() const { return InputAt(0); } 1204 HInstruction* GetRight() const { return InputAt(1); } 1205 Primitive::Type GetResultType() const { return GetType(); } 1206 1207 virtual bool IsCommutative() { return false; } 1208 1209 virtual bool CanBeMoved() const { return true; } 1210 virtual bool InstructionDataEquals(HInstruction* other) const { 1211 UNUSED(other); 1212 return true; 1213 } 1214 1215 // Try to statically evaluate `operation` and return a HConstant 1216 // containing the result of this evaluation. If `operation` cannot 1217 // be evaluated as a constant, return nullptr. 1218 HConstant* TryStaticEvaluation() const; 1219 1220 // Apply this operation to `x` and `y`. 1221 virtual int32_t Evaluate(int32_t x, int32_t y) const = 0; 1222 virtual int64_t Evaluate(int64_t x, int64_t y) const = 0; 1223 1224 DECLARE_INSTRUCTION(BinaryOperation); 1225 1226 private: 1227 DISALLOW_COPY_AND_ASSIGN(HBinaryOperation); 1228}; 1229 1230class HCondition : public HBinaryOperation { 1231 public: 1232 HCondition(HInstruction* first, HInstruction* second) 1233 : HBinaryOperation(Primitive::kPrimBoolean, first, second), 1234 needs_materialization_(true) {} 1235 1236 virtual bool IsCommutative() { return true; } 1237 1238 bool NeedsMaterialization() const { return needs_materialization_; } 1239 void ClearNeedsMaterialization() { needs_materialization_ = false; } 1240 1241 // For code generation purposes, returns whether this instruction is just before 1242 // `if_`, and disregard moves in between. 1243 bool IsBeforeWhenDisregardMoves(HIf* if_) const; 1244 1245 DECLARE_INSTRUCTION(Condition); 1246 1247 virtual IfCondition GetCondition() const = 0; 1248 1249 private: 1250 // For register allocation purposes, returns whether this instruction needs to be 1251 // materialized (that is, not just be in the processor flags). 1252 bool needs_materialization_; 1253 1254 DISALLOW_COPY_AND_ASSIGN(HCondition); 1255}; 1256 1257// Instruction to check if two inputs are equal to each other. 1258class HEqual : public HCondition { 1259 public: 1260 HEqual(HInstruction* first, HInstruction* second) 1261 : HCondition(first, second) {} 1262 1263 virtual int32_t Evaluate(int32_t x, int32_t y) const OVERRIDE { 1264 return x == y ? 1 : 0; 1265 } 1266 virtual int64_t Evaluate(int64_t x, int64_t y) const OVERRIDE { 1267 return x == y ? 1 : 0; 1268 } 1269 1270 DECLARE_INSTRUCTION(Equal); 1271 1272 virtual IfCondition GetCondition() const { 1273 return kCondEQ; 1274 } 1275 1276 private: 1277 DISALLOW_COPY_AND_ASSIGN(HEqual); 1278}; 1279 1280class HNotEqual : public HCondition { 1281 public: 1282 HNotEqual(HInstruction* first, HInstruction* second) 1283 : HCondition(first, second) {} 1284 1285 virtual int32_t Evaluate(int32_t x, int32_t y) const OVERRIDE { 1286 return x != y ? 1 : 0; 1287 } 1288 virtual int64_t Evaluate(int64_t x, int64_t y) const OVERRIDE { 1289 return x != y ? 1 : 0; 1290 } 1291 1292 DECLARE_INSTRUCTION(NotEqual); 1293 1294 virtual IfCondition GetCondition() const { 1295 return kCondNE; 1296 } 1297 1298 private: 1299 DISALLOW_COPY_AND_ASSIGN(HNotEqual); 1300}; 1301 1302class HLessThan : public HCondition { 1303 public: 1304 HLessThan(HInstruction* first, HInstruction* second) 1305 : HCondition(first, second) {} 1306 1307 virtual int32_t Evaluate(int32_t x, int32_t y) const OVERRIDE { 1308 return x < y ? 1 : 0; 1309 } 1310 virtual int64_t Evaluate(int64_t x, int64_t y) const OVERRIDE { 1311 return x < y ? 1 : 0; 1312 } 1313 1314 DECLARE_INSTRUCTION(LessThan); 1315 1316 virtual IfCondition GetCondition() const { 1317 return kCondLT; 1318 } 1319 1320 private: 1321 DISALLOW_COPY_AND_ASSIGN(HLessThan); 1322}; 1323 1324class HLessThanOrEqual : public HCondition { 1325 public: 1326 HLessThanOrEqual(HInstruction* first, HInstruction* second) 1327 : HCondition(first, second) {} 1328 1329 virtual int32_t Evaluate(int32_t x, int32_t y) const OVERRIDE { 1330 return x <= y ? 1 : 0; 1331 } 1332 virtual int64_t Evaluate(int64_t x, int64_t y) const OVERRIDE { 1333 return x <= y ? 1 : 0; 1334 } 1335 1336 DECLARE_INSTRUCTION(LessThanOrEqual); 1337 1338 virtual IfCondition GetCondition() const { 1339 return kCondLE; 1340 } 1341 1342 private: 1343 DISALLOW_COPY_AND_ASSIGN(HLessThanOrEqual); 1344}; 1345 1346class HGreaterThan : public HCondition { 1347 public: 1348 HGreaterThan(HInstruction* first, HInstruction* second) 1349 : HCondition(first, second) {} 1350 1351 virtual int32_t Evaluate(int32_t x, int32_t y) const OVERRIDE { 1352 return x > y ? 1 : 0; 1353 } 1354 virtual int64_t Evaluate(int64_t x, int64_t y) const OVERRIDE { 1355 return x > y ? 1 : 0; 1356 } 1357 1358 DECLARE_INSTRUCTION(GreaterThan); 1359 1360 virtual IfCondition GetCondition() const { 1361 return kCondGT; 1362 } 1363 1364 private: 1365 DISALLOW_COPY_AND_ASSIGN(HGreaterThan); 1366}; 1367 1368class HGreaterThanOrEqual : public HCondition { 1369 public: 1370 HGreaterThanOrEqual(HInstruction* first, HInstruction* second) 1371 : HCondition(first, second) {} 1372 1373 virtual int32_t Evaluate(int32_t x, int32_t y) const OVERRIDE { 1374 return x >= y ? 1 : 0; 1375 } 1376 virtual int64_t Evaluate(int64_t x, int64_t y) const OVERRIDE { 1377 return x >= y ? 1 : 0; 1378 } 1379 1380 DECLARE_INSTRUCTION(GreaterThanOrEqual); 1381 1382 virtual IfCondition GetCondition() const { 1383 return kCondGE; 1384 } 1385 1386 private: 1387 DISALLOW_COPY_AND_ASSIGN(HGreaterThanOrEqual); 1388}; 1389 1390 1391// Instruction to check how two inputs compare to each other. 1392// Result is 0 if input0 == input1, 1 if input0 > input1, or -1 if input0 < input1. 1393class HCompare : public HBinaryOperation { 1394 public: 1395 // The bias applies for floating point operations and indicates how NaN 1396 // comparisons are treated: 1397 enum Bias { 1398 kNoBias, // bias is not applicable (i.e. for long operation) 1399 kGtBias, // return 1 for NaN comparisons 1400 kLtBias, // return -1 for NaN comparisons 1401 }; 1402 1403 HCompare(Primitive::Type type, HInstruction* first, HInstruction* second, Bias bias) 1404 : HBinaryOperation(Primitive::kPrimInt, first, second), bias_(bias) { 1405 DCHECK_EQ(type, first->GetType()); 1406 DCHECK_EQ(type, second->GetType()); 1407 } 1408 1409 int32_t Evaluate(int32_t x, int32_t y) const OVERRIDE { 1410 return 1411 x == y ? 0 : 1412 x > y ? 1 : 1413 -1; 1414 } 1415 1416 int64_t Evaluate(int64_t x, int64_t y) const OVERRIDE { 1417 return 1418 x == y ? 0 : 1419 x > y ? 1 : 1420 -1; 1421 } 1422 1423 bool InstructionDataEquals(HInstruction* other) const OVERRIDE { 1424 return bias_ == other->AsCompare()->bias_; 1425 } 1426 1427 bool IsGtBias() { return bias_ == kGtBias; } 1428 1429 DECLARE_INSTRUCTION(Compare); 1430 1431 private: 1432 const Bias bias_; 1433 1434 DISALLOW_COPY_AND_ASSIGN(HCompare); 1435}; 1436 1437// A local in the graph. Corresponds to a Dex register. 1438class HLocal : public HTemplateInstruction<0> { 1439 public: 1440 explicit HLocal(uint16_t reg_number) 1441 : HTemplateInstruction(SideEffects::None()), reg_number_(reg_number) {} 1442 1443 DECLARE_INSTRUCTION(Local); 1444 1445 uint16_t GetRegNumber() const { return reg_number_; } 1446 1447 private: 1448 // The Dex register number. 1449 const uint16_t reg_number_; 1450 1451 DISALLOW_COPY_AND_ASSIGN(HLocal); 1452}; 1453 1454// Load a given local. The local is an input of this instruction. 1455class HLoadLocal : public HExpression<1> { 1456 public: 1457 HLoadLocal(HLocal* local, Primitive::Type type) 1458 : HExpression(type, SideEffects::None()) { 1459 SetRawInputAt(0, local); 1460 } 1461 1462 HLocal* GetLocal() const { return reinterpret_cast<HLocal*>(InputAt(0)); } 1463 1464 DECLARE_INSTRUCTION(LoadLocal); 1465 1466 private: 1467 DISALLOW_COPY_AND_ASSIGN(HLoadLocal); 1468}; 1469 1470// Store a value in a given local. This instruction has two inputs: the value 1471// and the local. 1472class HStoreLocal : public HTemplateInstruction<2> { 1473 public: 1474 HStoreLocal(HLocal* local, HInstruction* value) : HTemplateInstruction(SideEffects::None()) { 1475 SetRawInputAt(0, local); 1476 SetRawInputAt(1, value); 1477 } 1478 1479 HLocal* GetLocal() const { return reinterpret_cast<HLocal*>(InputAt(0)); } 1480 1481 DECLARE_INSTRUCTION(StoreLocal); 1482 1483 private: 1484 DISALLOW_COPY_AND_ASSIGN(HStoreLocal); 1485}; 1486 1487class HConstant : public HExpression<0> { 1488 public: 1489 explicit HConstant(Primitive::Type type) : HExpression(type, SideEffects::None()) {} 1490 1491 virtual bool CanBeMoved() const { return true; } 1492 1493 DECLARE_INSTRUCTION(Constant); 1494 1495 private: 1496 DISALLOW_COPY_AND_ASSIGN(HConstant); 1497}; 1498 1499class HFloatConstant : public HConstant { 1500 public: 1501 explicit HFloatConstant(float value) : HConstant(Primitive::kPrimFloat), value_(value) {} 1502 1503 float GetValue() const { return value_; } 1504 1505 virtual bool InstructionDataEquals(HInstruction* other) const { 1506 return bit_cast<float, int32_t>(other->AsFloatConstant()->value_) == 1507 bit_cast<float, int32_t>(value_); 1508 } 1509 1510 virtual size_t ComputeHashCode() const { return static_cast<size_t>(GetValue()); } 1511 1512 DECLARE_INSTRUCTION(FloatConstant); 1513 1514 private: 1515 const float value_; 1516 1517 DISALLOW_COPY_AND_ASSIGN(HFloatConstant); 1518}; 1519 1520class HDoubleConstant : public HConstant { 1521 public: 1522 explicit HDoubleConstant(double value) : HConstant(Primitive::kPrimDouble), value_(value) {} 1523 1524 double GetValue() const { return value_; } 1525 1526 virtual bool InstructionDataEquals(HInstruction* other) const { 1527 return bit_cast<double, int64_t>(other->AsDoubleConstant()->value_) == 1528 bit_cast<double, int64_t>(value_); 1529 } 1530 1531 virtual size_t ComputeHashCode() const { return static_cast<size_t>(GetValue()); } 1532 1533 DECLARE_INSTRUCTION(DoubleConstant); 1534 1535 private: 1536 const double value_; 1537 1538 DISALLOW_COPY_AND_ASSIGN(HDoubleConstant); 1539}; 1540 1541// Constants of the type int. Those can be from Dex instructions, or 1542// synthesized (for example with the if-eqz instruction). 1543class HIntConstant : public HConstant { 1544 public: 1545 explicit HIntConstant(int32_t value) : HConstant(Primitive::kPrimInt), value_(value) {} 1546 1547 int32_t GetValue() const { return value_; } 1548 1549 virtual bool InstructionDataEquals(HInstruction* other) const { 1550 return other->AsIntConstant()->value_ == value_; 1551 } 1552 1553 virtual size_t ComputeHashCode() const { return GetValue(); } 1554 1555 DECLARE_INSTRUCTION(IntConstant); 1556 1557 private: 1558 const int32_t value_; 1559 1560 DISALLOW_COPY_AND_ASSIGN(HIntConstant); 1561}; 1562 1563class HLongConstant : public HConstant { 1564 public: 1565 explicit HLongConstant(int64_t value) : HConstant(Primitive::kPrimLong), value_(value) {} 1566 1567 int64_t GetValue() const { return value_; } 1568 1569 virtual bool InstructionDataEquals(HInstruction* other) const { 1570 return other->AsLongConstant()->value_ == value_; 1571 } 1572 1573 virtual size_t ComputeHashCode() const { return static_cast<size_t>(GetValue()); } 1574 1575 DECLARE_INSTRUCTION(LongConstant); 1576 1577 private: 1578 const int64_t value_; 1579 1580 DISALLOW_COPY_AND_ASSIGN(HLongConstant); 1581}; 1582 1583class HInvoke : public HInstruction { 1584 public: 1585 HInvoke(ArenaAllocator* arena, 1586 uint32_t number_of_arguments, 1587 Primitive::Type return_type, 1588 uint32_t dex_pc) 1589 : HInstruction(SideEffects::All()), 1590 inputs_(arena, number_of_arguments), 1591 return_type_(return_type), 1592 dex_pc_(dex_pc) { 1593 inputs_.SetSize(number_of_arguments); 1594 } 1595 1596 virtual size_t InputCount() const { return inputs_.Size(); } 1597 virtual HInstruction* InputAt(size_t i) const { return inputs_.Get(i); } 1598 1599 // Runtime needs to walk the stack, so Dex -> Dex calls need to 1600 // know their environment. 1601 virtual bool NeedsEnvironment() const { return true; } 1602 1603 void SetArgumentAt(size_t index, HInstruction* argument) { 1604 SetRawInputAt(index, argument); 1605 } 1606 1607 virtual void SetRawInputAt(size_t index, HInstruction* input) { 1608 inputs_.Put(index, input); 1609 } 1610 1611 virtual Primitive::Type GetType() const { return return_type_; } 1612 1613 uint32_t GetDexPc() const { return dex_pc_; } 1614 1615 DECLARE_INSTRUCTION(Invoke); 1616 1617 protected: 1618 GrowableArray<HInstruction*> inputs_; 1619 const Primitive::Type return_type_; 1620 const uint32_t dex_pc_; 1621 1622 private: 1623 DISALLOW_COPY_AND_ASSIGN(HInvoke); 1624}; 1625 1626class HInvokeStaticOrDirect : public HInvoke { 1627 public: 1628 HInvokeStaticOrDirect(ArenaAllocator* arena, 1629 uint32_t number_of_arguments, 1630 Primitive::Type return_type, 1631 uint32_t dex_pc, 1632 uint32_t index_in_dex_cache, 1633 InvokeType invoke_type) 1634 : HInvoke(arena, number_of_arguments, return_type, dex_pc), 1635 index_in_dex_cache_(index_in_dex_cache), 1636 invoke_type_(invoke_type) {} 1637 1638 uint32_t GetIndexInDexCache() const { return index_in_dex_cache_; } 1639 InvokeType GetInvokeType() const { return invoke_type_; } 1640 1641 DECLARE_INSTRUCTION(InvokeStaticOrDirect); 1642 1643 private: 1644 const uint32_t index_in_dex_cache_; 1645 const InvokeType invoke_type_; 1646 1647 DISALLOW_COPY_AND_ASSIGN(HInvokeStaticOrDirect); 1648}; 1649 1650class HInvokeVirtual : public HInvoke { 1651 public: 1652 HInvokeVirtual(ArenaAllocator* arena, 1653 uint32_t number_of_arguments, 1654 Primitive::Type return_type, 1655 uint32_t dex_pc, 1656 uint32_t vtable_index) 1657 : HInvoke(arena, number_of_arguments, return_type, dex_pc), 1658 vtable_index_(vtable_index) {} 1659 1660 uint32_t GetVTableIndex() const { return vtable_index_; } 1661 1662 DECLARE_INSTRUCTION(InvokeVirtual); 1663 1664 private: 1665 const uint32_t vtable_index_; 1666 1667 DISALLOW_COPY_AND_ASSIGN(HInvokeVirtual); 1668}; 1669 1670class HInvokeInterface : public HInvoke { 1671 public: 1672 HInvokeInterface(ArenaAllocator* arena, 1673 uint32_t number_of_arguments, 1674 Primitive::Type return_type, 1675 uint32_t dex_pc, 1676 uint32_t dex_method_index, 1677 uint32_t imt_index) 1678 : HInvoke(arena, number_of_arguments, return_type, dex_pc), 1679 dex_method_index_(dex_method_index), 1680 imt_index_(imt_index) {} 1681 1682 uint32_t GetImtIndex() const { return imt_index_; } 1683 uint32_t GetDexMethodIndex() const { return dex_method_index_; } 1684 1685 DECLARE_INSTRUCTION(InvokeInterface); 1686 1687 private: 1688 const uint32_t dex_method_index_; 1689 const uint32_t imt_index_; 1690 1691 DISALLOW_COPY_AND_ASSIGN(HInvokeInterface); 1692}; 1693 1694class HNewInstance : public HExpression<0> { 1695 public: 1696 HNewInstance(uint32_t dex_pc, uint16_t type_index) 1697 : HExpression(Primitive::kPrimNot, SideEffects::None()), 1698 dex_pc_(dex_pc), 1699 type_index_(type_index) {} 1700 1701 uint32_t GetDexPc() const { return dex_pc_; } 1702 uint16_t GetTypeIndex() const { return type_index_; } 1703 1704 // Calls runtime so needs an environment. 1705 bool NeedsEnvironment() const OVERRIDE { return true; } 1706 // It may throw when called on: 1707 // - interfaces 1708 // - abstract/innaccessible/unknown classes 1709 // TODO: optimize when possible. 1710 bool CanThrow() const OVERRIDE { return true; } 1711 1712 DECLARE_INSTRUCTION(NewInstance); 1713 1714 private: 1715 const uint32_t dex_pc_; 1716 const uint16_t type_index_; 1717 1718 DISALLOW_COPY_AND_ASSIGN(HNewInstance); 1719}; 1720 1721class HNeg : public HUnaryOperation { 1722 public: 1723 explicit HNeg(Primitive::Type result_type, HInstruction* input) 1724 : HUnaryOperation(result_type, input) {} 1725 1726 virtual int32_t Evaluate(int32_t x) const OVERRIDE { return -x; } 1727 virtual int64_t Evaluate(int64_t x) const OVERRIDE { return -x; } 1728 1729 DECLARE_INSTRUCTION(Neg); 1730 1731 private: 1732 DISALLOW_COPY_AND_ASSIGN(HNeg); 1733}; 1734 1735class HNewArray : public HExpression<1> { 1736 public: 1737 HNewArray(HInstruction* length, uint32_t dex_pc, uint16_t type_index) 1738 : HExpression(Primitive::kPrimNot, SideEffects::None()), 1739 dex_pc_(dex_pc), 1740 type_index_(type_index) { 1741 SetRawInputAt(0, length); 1742 } 1743 1744 uint32_t GetDexPc() const { return dex_pc_; } 1745 uint16_t GetTypeIndex() const { return type_index_; } 1746 1747 // Calls runtime so needs an environment. 1748 virtual bool NeedsEnvironment() const { return true; } 1749 1750 DECLARE_INSTRUCTION(NewArray); 1751 1752 private: 1753 const uint32_t dex_pc_; 1754 const uint16_t type_index_; 1755 1756 DISALLOW_COPY_AND_ASSIGN(HNewArray); 1757}; 1758 1759class HAdd : public HBinaryOperation { 1760 public: 1761 HAdd(Primitive::Type result_type, HInstruction* left, HInstruction* right) 1762 : HBinaryOperation(result_type, left, right) {} 1763 1764 virtual bool IsCommutative() { return true; } 1765 1766 virtual int32_t Evaluate(int32_t x, int32_t y) const OVERRIDE { 1767 return x + y; 1768 } 1769 virtual int64_t Evaluate(int64_t x, int64_t y) const OVERRIDE { 1770 return x + y; 1771 } 1772 1773 DECLARE_INSTRUCTION(Add); 1774 1775 private: 1776 DISALLOW_COPY_AND_ASSIGN(HAdd); 1777}; 1778 1779class HSub : public HBinaryOperation { 1780 public: 1781 HSub(Primitive::Type result_type, HInstruction* left, HInstruction* right) 1782 : HBinaryOperation(result_type, left, right) {} 1783 1784 virtual int32_t Evaluate(int32_t x, int32_t y) const OVERRIDE { 1785 return x - y; 1786 } 1787 virtual int64_t Evaluate(int64_t x, int64_t y) const OVERRIDE { 1788 return x - y; 1789 } 1790 1791 DECLARE_INSTRUCTION(Sub); 1792 1793 private: 1794 DISALLOW_COPY_AND_ASSIGN(HSub); 1795}; 1796 1797class HMul : public HBinaryOperation { 1798 public: 1799 HMul(Primitive::Type result_type, HInstruction* left, HInstruction* right) 1800 : HBinaryOperation(result_type, left, right) {} 1801 1802 virtual bool IsCommutative() { return true; } 1803 1804 virtual int32_t Evaluate(int32_t x, int32_t y) const { return x * y; } 1805 virtual int64_t Evaluate(int64_t x, int64_t y) const { return x * y; } 1806 1807 DECLARE_INSTRUCTION(Mul); 1808 1809 private: 1810 DISALLOW_COPY_AND_ASSIGN(HMul); 1811}; 1812 1813class HDiv : public HBinaryOperation { 1814 public: 1815 HDiv(Primitive::Type result_type, HInstruction* left, HInstruction* right, uint32_t dex_pc) 1816 : HBinaryOperation(result_type, left, right), dex_pc_(dex_pc) {} 1817 1818 virtual int32_t Evaluate(int32_t x, int32_t y) const { 1819 // Our graph structure ensures we never have 0 for `y` during constant folding. 1820 DCHECK_NE(y, 0); 1821 // Special case -1 to avoid getting a SIGFPE on x86(_64). 1822 return (y == -1) ? -x : x / y; 1823 } 1824 1825 virtual int64_t Evaluate(int64_t x, int64_t y) const { 1826 DCHECK_NE(y, 0); 1827 // Special case -1 to avoid getting a SIGFPE on x86(_64). 1828 return (y == -1) ? -x : x / y; 1829 } 1830 1831 uint32_t GetDexPc() const { return dex_pc_; } 1832 1833 DECLARE_INSTRUCTION(Div); 1834 1835 private: 1836 const uint32_t dex_pc_; 1837 1838 DISALLOW_COPY_AND_ASSIGN(HDiv); 1839}; 1840 1841class HRem : public HBinaryOperation { 1842 public: 1843 HRem(Primitive::Type result_type, HInstruction* left, HInstruction* right, uint32_t dex_pc) 1844 : HBinaryOperation(result_type, left, right), dex_pc_(dex_pc) {} 1845 1846 virtual int32_t Evaluate(int32_t x, int32_t y) const { 1847 DCHECK_NE(y, 0); 1848 // Special case -1 to avoid getting a SIGFPE on x86(_64). 1849 return (y == -1) ? 0 : x % y; 1850 } 1851 1852 virtual int64_t Evaluate(int64_t x, int64_t y) const { 1853 DCHECK_NE(y, 0); 1854 // Special case -1 to avoid getting a SIGFPE on x86(_64). 1855 return (y == -1) ? 0 : x % y; 1856 } 1857 1858 uint32_t GetDexPc() const { return dex_pc_; } 1859 1860 DECLARE_INSTRUCTION(Rem); 1861 1862 private: 1863 const uint32_t dex_pc_; 1864 1865 DISALLOW_COPY_AND_ASSIGN(HRem); 1866}; 1867 1868class HDivZeroCheck : public HExpression<1> { 1869 public: 1870 HDivZeroCheck(HInstruction* value, uint32_t dex_pc) 1871 : HExpression(value->GetType(), SideEffects::None()), dex_pc_(dex_pc) { 1872 SetRawInputAt(0, value); 1873 } 1874 1875 bool CanBeMoved() const OVERRIDE { return true; } 1876 1877 bool InstructionDataEquals(HInstruction* other) const OVERRIDE { 1878 UNUSED(other); 1879 return true; 1880 } 1881 1882 bool NeedsEnvironment() const OVERRIDE { return true; } 1883 bool CanThrow() const OVERRIDE { return true; } 1884 1885 uint32_t GetDexPc() const { return dex_pc_; } 1886 1887 DECLARE_INSTRUCTION(DivZeroCheck); 1888 1889 private: 1890 const uint32_t dex_pc_; 1891 1892 DISALLOW_COPY_AND_ASSIGN(HDivZeroCheck); 1893}; 1894 1895class HShl : public HBinaryOperation { 1896 public: 1897 HShl(Primitive::Type result_type, HInstruction* left, HInstruction* right) 1898 : HBinaryOperation(result_type, left, right) {} 1899 1900 int32_t Evaluate(int32_t x, int32_t y) const OVERRIDE { return x << (y & kMaxIntShiftValue); } 1901 int64_t Evaluate(int64_t x, int64_t y) const OVERRIDE { return x << (y & kMaxLongShiftValue); } 1902 1903 DECLARE_INSTRUCTION(Shl); 1904 1905 private: 1906 DISALLOW_COPY_AND_ASSIGN(HShl); 1907}; 1908 1909class HShr : public HBinaryOperation { 1910 public: 1911 HShr(Primitive::Type result_type, HInstruction* left, HInstruction* right) 1912 : HBinaryOperation(result_type, left, right) {} 1913 1914 int32_t Evaluate(int32_t x, int32_t y) const OVERRIDE { return x >> (y & kMaxIntShiftValue); } 1915 int64_t Evaluate(int64_t x, int64_t y) const OVERRIDE { return x >> (y & kMaxLongShiftValue); } 1916 1917 DECLARE_INSTRUCTION(Shr); 1918 1919 private: 1920 DISALLOW_COPY_AND_ASSIGN(HShr); 1921}; 1922 1923class HUShr : public HBinaryOperation { 1924 public: 1925 HUShr(Primitive::Type result_type, HInstruction* left, HInstruction* right) 1926 : HBinaryOperation(result_type, left, right) {} 1927 1928 int32_t Evaluate(int32_t x, int32_t y) const OVERRIDE { 1929 uint32_t ux = static_cast<uint32_t>(x); 1930 uint32_t uy = static_cast<uint32_t>(y) & kMaxIntShiftValue; 1931 return static_cast<int32_t>(ux >> uy); 1932 } 1933 1934 int64_t Evaluate(int64_t x, int64_t y) const OVERRIDE { 1935 uint64_t ux = static_cast<uint64_t>(x); 1936 uint64_t uy = static_cast<uint64_t>(y) & kMaxLongShiftValue; 1937 return static_cast<int64_t>(ux >> uy); 1938 } 1939 1940 DECLARE_INSTRUCTION(UShr); 1941 1942 private: 1943 DISALLOW_COPY_AND_ASSIGN(HUShr); 1944}; 1945 1946class HAnd : public HBinaryOperation { 1947 public: 1948 HAnd(Primitive::Type result_type, HInstruction* left, HInstruction* right) 1949 : HBinaryOperation(result_type, left, right) {} 1950 1951 bool IsCommutative() OVERRIDE { return true; } 1952 1953 int32_t Evaluate(int32_t x, int32_t y) const OVERRIDE { return x & y; } 1954 int64_t Evaluate(int64_t x, int64_t y) const OVERRIDE { return x & y; } 1955 1956 DECLARE_INSTRUCTION(And); 1957 1958 private: 1959 DISALLOW_COPY_AND_ASSIGN(HAnd); 1960}; 1961 1962class HOr : public HBinaryOperation { 1963 public: 1964 HOr(Primitive::Type result_type, HInstruction* left, HInstruction* right) 1965 : HBinaryOperation(result_type, left, right) {} 1966 1967 bool IsCommutative() OVERRIDE { return true; } 1968 1969 int32_t Evaluate(int32_t x, int32_t y) const OVERRIDE { return x | y; } 1970 int64_t Evaluate(int64_t x, int64_t y) const OVERRIDE { return x | y; } 1971 1972 DECLARE_INSTRUCTION(Or); 1973 1974 private: 1975 DISALLOW_COPY_AND_ASSIGN(HOr); 1976}; 1977 1978class HXor : public HBinaryOperation { 1979 public: 1980 HXor(Primitive::Type result_type, HInstruction* left, HInstruction* right) 1981 : HBinaryOperation(result_type, left, right) {} 1982 1983 bool IsCommutative() OVERRIDE { return true; } 1984 1985 int32_t Evaluate(int32_t x, int32_t y) const OVERRIDE { return x ^ y; } 1986 int64_t Evaluate(int64_t x, int64_t y) const OVERRIDE { return x ^ y; } 1987 1988 DECLARE_INSTRUCTION(Xor); 1989 1990 private: 1991 DISALLOW_COPY_AND_ASSIGN(HXor); 1992}; 1993 1994// The value of a parameter in this method. Its location depends on 1995// the calling convention. 1996class HParameterValue : public HExpression<0> { 1997 public: 1998 HParameterValue(uint8_t index, Primitive::Type parameter_type) 1999 : HExpression(parameter_type, SideEffects::None()), index_(index) {} 2000 2001 uint8_t GetIndex() const { return index_; } 2002 2003 DECLARE_INSTRUCTION(ParameterValue); 2004 2005 private: 2006 // The index of this parameter in the parameters list. Must be less 2007 // than HGraph::number_of_in_vregs_; 2008 const uint8_t index_; 2009 2010 DISALLOW_COPY_AND_ASSIGN(HParameterValue); 2011}; 2012 2013class HNot : public HUnaryOperation { 2014 public: 2015 explicit HNot(Primitive::Type result_type, HInstruction* input) 2016 : HUnaryOperation(result_type, input) {} 2017 2018 virtual bool CanBeMoved() const { return true; } 2019 virtual bool InstructionDataEquals(HInstruction* other) const { 2020 UNUSED(other); 2021 return true; 2022 } 2023 2024 virtual int32_t Evaluate(int32_t x) const OVERRIDE { return ~x; } 2025 virtual int64_t Evaluate(int64_t x) const OVERRIDE { return ~x; } 2026 2027 DECLARE_INSTRUCTION(Not); 2028 2029 private: 2030 DISALLOW_COPY_AND_ASSIGN(HNot); 2031}; 2032 2033class HTypeConversion : public HExpression<1> { 2034 public: 2035 // Instantiate a type conversion of `input` to `result_type`. 2036 HTypeConversion(Primitive::Type result_type, HInstruction* input, uint32_t dex_pc) 2037 : HExpression(result_type, SideEffects::None()), dex_pc_(dex_pc) { 2038 SetRawInputAt(0, input); 2039 DCHECK_NE(input->GetType(), result_type); 2040 } 2041 2042 HInstruction* GetInput() const { return InputAt(0); } 2043 Primitive::Type GetInputType() const { return GetInput()->GetType(); } 2044 Primitive::Type GetResultType() const { return GetType(); } 2045 2046 // Required by the x86 and ARM code generators when producing calls 2047 // to the runtime. 2048 uint32_t GetDexPc() const { return dex_pc_; } 2049 2050 bool CanBeMoved() const OVERRIDE { return true; } 2051 bool InstructionDataEquals(HInstruction* other ATTRIBUTE_UNUSED) const OVERRIDE { return true; } 2052 2053 DECLARE_INSTRUCTION(TypeConversion); 2054 2055 private: 2056 const uint32_t dex_pc_; 2057 2058 DISALLOW_COPY_AND_ASSIGN(HTypeConversion); 2059}; 2060 2061class HPhi : public HInstruction { 2062 public: 2063 HPhi(ArenaAllocator* arena, uint32_t reg_number, size_t number_of_inputs, Primitive::Type type) 2064 : HInstruction(SideEffects::None()), 2065 inputs_(arena, number_of_inputs), 2066 reg_number_(reg_number), 2067 type_(type), 2068 is_live_(false) { 2069 inputs_.SetSize(number_of_inputs); 2070 } 2071 2072 virtual size_t InputCount() const { return inputs_.Size(); } 2073 virtual HInstruction* InputAt(size_t i) const { return inputs_.Get(i); } 2074 2075 virtual void SetRawInputAt(size_t index, HInstruction* input) { 2076 inputs_.Put(index, input); 2077 } 2078 2079 void AddInput(HInstruction* input); 2080 2081 virtual Primitive::Type GetType() const { return type_; } 2082 void SetType(Primitive::Type type) { type_ = type; } 2083 2084 uint32_t GetRegNumber() const { return reg_number_; } 2085 2086 void SetDead() { is_live_ = false; } 2087 void SetLive() { is_live_ = true; } 2088 bool IsDead() const { return !is_live_; } 2089 bool IsLive() const { return is_live_; } 2090 2091 DECLARE_INSTRUCTION(Phi); 2092 2093 private: 2094 GrowableArray<HInstruction*> inputs_; 2095 const uint32_t reg_number_; 2096 Primitive::Type type_; 2097 bool is_live_; 2098 2099 DISALLOW_COPY_AND_ASSIGN(HPhi); 2100}; 2101 2102class HNullCheck : public HExpression<1> { 2103 public: 2104 HNullCheck(HInstruction* value, uint32_t dex_pc) 2105 : HExpression(value->GetType(), SideEffects::None()), dex_pc_(dex_pc) { 2106 SetRawInputAt(0, value); 2107 } 2108 2109 virtual bool CanBeMoved() const { return true; } 2110 virtual bool InstructionDataEquals(HInstruction* other) const { 2111 UNUSED(other); 2112 return true; 2113 } 2114 2115 virtual bool NeedsEnvironment() const { return true; } 2116 2117 virtual bool CanThrow() const { return true; } 2118 2119 uint32_t GetDexPc() const { return dex_pc_; } 2120 2121 DECLARE_INSTRUCTION(NullCheck); 2122 2123 private: 2124 const uint32_t dex_pc_; 2125 2126 DISALLOW_COPY_AND_ASSIGN(HNullCheck); 2127}; 2128 2129class FieldInfo : public ValueObject { 2130 public: 2131 FieldInfo(MemberOffset field_offset, Primitive::Type field_type, bool is_volatile) 2132 : field_offset_(field_offset), field_type_(field_type), is_volatile_(is_volatile) {} 2133 2134 MemberOffset GetFieldOffset() const { return field_offset_; } 2135 Primitive::Type GetFieldType() const { return field_type_; } 2136 bool IsVolatile() const { return is_volatile_; } 2137 2138 private: 2139 const MemberOffset field_offset_; 2140 const Primitive::Type field_type_; 2141 const bool is_volatile_; 2142}; 2143 2144class HInstanceFieldGet : public HExpression<1> { 2145 public: 2146 HInstanceFieldGet(HInstruction* value, 2147 Primitive::Type field_type, 2148 MemberOffset field_offset, 2149 bool is_volatile) 2150 : HExpression(field_type, SideEffects::DependsOnSomething()), 2151 field_info_(field_offset, field_type, is_volatile) { 2152 SetRawInputAt(0, value); 2153 } 2154 2155 bool CanBeMoved() const OVERRIDE { return !IsVolatile(); } 2156 2157 bool InstructionDataEquals(HInstruction* other) const OVERRIDE { 2158 HInstanceFieldGet* other_get = other->AsInstanceFieldGet(); 2159 return GetFieldOffset().SizeValue() == other_get->GetFieldOffset().SizeValue(); 2160 } 2161 2162 virtual size_t ComputeHashCode() const { 2163 return (HInstruction::ComputeHashCode() << 7) | GetFieldOffset().SizeValue(); 2164 } 2165 2166 const FieldInfo& GetFieldInfo() const { return field_info_; } 2167 MemberOffset GetFieldOffset() const { return field_info_.GetFieldOffset(); } 2168 Primitive::Type GetFieldType() const { return field_info_.GetFieldType(); } 2169 bool IsVolatile() const { return field_info_.IsVolatile(); } 2170 2171 DECLARE_INSTRUCTION(InstanceFieldGet); 2172 2173 private: 2174 const FieldInfo field_info_; 2175 2176 DISALLOW_COPY_AND_ASSIGN(HInstanceFieldGet); 2177}; 2178 2179class HInstanceFieldSet : public HTemplateInstruction<2> { 2180 public: 2181 HInstanceFieldSet(HInstruction* object, 2182 HInstruction* value, 2183 Primitive::Type field_type, 2184 MemberOffset field_offset, 2185 bool is_volatile) 2186 : HTemplateInstruction(SideEffects::ChangesSomething()), 2187 field_info_(field_offset, field_type, is_volatile) { 2188 SetRawInputAt(0, object); 2189 SetRawInputAt(1, value); 2190 } 2191 2192 const FieldInfo& GetFieldInfo() const { return field_info_; } 2193 MemberOffset GetFieldOffset() const { return field_info_.GetFieldOffset(); } 2194 Primitive::Type GetFieldType() const { return field_info_.GetFieldType(); } 2195 bool IsVolatile() const { return field_info_.IsVolatile(); } 2196 2197 HInstruction* GetValue() const { return InputAt(1); } 2198 2199 DECLARE_INSTRUCTION(InstanceFieldSet); 2200 2201 private: 2202 const FieldInfo field_info_; 2203 2204 DISALLOW_COPY_AND_ASSIGN(HInstanceFieldSet); 2205}; 2206 2207class HArrayGet : public HExpression<2> { 2208 public: 2209 HArrayGet(HInstruction* array, HInstruction* index, Primitive::Type type) 2210 : HExpression(type, SideEffects::DependsOnSomething()) { 2211 SetRawInputAt(0, array); 2212 SetRawInputAt(1, index); 2213 } 2214 2215 bool CanBeMoved() const OVERRIDE { return true; } 2216 bool InstructionDataEquals(HInstruction* other) const OVERRIDE { 2217 UNUSED(other); 2218 return true; 2219 } 2220 void SetType(Primitive::Type type) { type_ = type; } 2221 2222 HInstruction* GetArray() const { return InputAt(0); } 2223 HInstruction* GetIndex() const { return InputAt(1); } 2224 2225 DECLARE_INSTRUCTION(ArrayGet); 2226 2227 private: 2228 DISALLOW_COPY_AND_ASSIGN(HArrayGet); 2229}; 2230 2231class HArraySet : public HTemplateInstruction<3> { 2232 public: 2233 HArraySet(HInstruction* array, 2234 HInstruction* index, 2235 HInstruction* value, 2236 Primitive::Type expected_component_type, 2237 uint32_t dex_pc) 2238 : HTemplateInstruction(SideEffects::ChangesSomething()), 2239 dex_pc_(dex_pc), 2240 expected_component_type_(expected_component_type), 2241 needs_type_check_(value->GetType() == Primitive::kPrimNot) { 2242 SetRawInputAt(0, array); 2243 SetRawInputAt(1, index); 2244 SetRawInputAt(2, value); 2245 } 2246 2247 bool NeedsEnvironment() const { 2248 // We currently always call a runtime method to catch array store 2249 // exceptions. 2250 return needs_type_check_; 2251 } 2252 2253 void ClearNeedsTypeCheck() { 2254 needs_type_check_ = false; 2255 } 2256 2257 bool NeedsTypeCheck() const { return needs_type_check_; } 2258 2259 uint32_t GetDexPc() const { return dex_pc_; } 2260 2261 HInstruction* GetArray() const { return InputAt(0); } 2262 HInstruction* GetIndex() const { return InputAt(1); } 2263 HInstruction* GetValue() const { return InputAt(2); } 2264 2265 Primitive::Type GetComponentType() const { 2266 // The Dex format does not type floating point index operations. Since the 2267 // `expected_component_type_` is set during building and can therefore not 2268 // be correct, we also check what is the value type. If it is a floating 2269 // point type, we must use that type. 2270 Primitive::Type value_type = GetValue()->GetType(); 2271 return ((value_type == Primitive::kPrimFloat) || (value_type == Primitive::kPrimDouble)) 2272 ? value_type 2273 : expected_component_type_; 2274 } 2275 2276 DECLARE_INSTRUCTION(ArraySet); 2277 2278 private: 2279 const uint32_t dex_pc_; 2280 const Primitive::Type expected_component_type_; 2281 bool needs_type_check_; 2282 2283 DISALLOW_COPY_AND_ASSIGN(HArraySet); 2284}; 2285 2286class HArrayLength : public HExpression<1> { 2287 public: 2288 explicit HArrayLength(HInstruction* array) 2289 : HExpression(Primitive::kPrimInt, SideEffects::None()) { 2290 // Note that arrays do not change length, so the instruction does not 2291 // depend on any write. 2292 SetRawInputAt(0, array); 2293 } 2294 2295 virtual bool CanBeMoved() const { return true; } 2296 virtual bool InstructionDataEquals(HInstruction* other) const { 2297 UNUSED(other); 2298 return true; 2299 } 2300 2301 DECLARE_INSTRUCTION(ArrayLength); 2302 2303 private: 2304 DISALLOW_COPY_AND_ASSIGN(HArrayLength); 2305}; 2306 2307class HBoundsCheck : public HExpression<2> { 2308 public: 2309 HBoundsCheck(HInstruction* index, HInstruction* length, uint32_t dex_pc) 2310 : HExpression(index->GetType(), SideEffects::None()), dex_pc_(dex_pc) { 2311 DCHECK(index->GetType() == Primitive::kPrimInt); 2312 SetRawInputAt(0, index); 2313 SetRawInputAt(1, length); 2314 } 2315 2316 virtual bool CanBeMoved() const { return true; } 2317 virtual bool InstructionDataEquals(HInstruction* other) const { 2318 UNUSED(other); 2319 return true; 2320 } 2321 2322 virtual bool NeedsEnvironment() const { return true; } 2323 2324 virtual bool CanThrow() const { return true; } 2325 2326 uint32_t GetDexPc() const { return dex_pc_; } 2327 2328 DECLARE_INSTRUCTION(BoundsCheck); 2329 2330 private: 2331 const uint32_t dex_pc_; 2332 2333 DISALLOW_COPY_AND_ASSIGN(HBoundsCheck); 2334}; 2335 2336/** 2337 * Some DEX instructions are folded into multiple HInstructions that need 2338 * to stay live until the last HInstruction. This class 2339 * is used as a marker for the baseline compiler to ensure its preceding 2340 * HInstruction stays live. `index` represents the stack location index of the 2341 * instruction (the actual offset is computed as index * vreg_size). 2342 */ 2343class HTemporary : public HTemplateInstruction<0> { 2344 public: 2345 explicit HTemporary(size_t index) : HTemplateInstruction(SideEffects::None()), index_(index) {} 2346 2347 size_t GetIndex() const { return index_; } 2348 2349 Primitive::Type GetType() const OVERRIDE { 2350 // The previous instruction is the one that will be stored in the temporary location. 2351 DCHECK(GetPrevious() != nullptr); 2352 return GetPrevious()->GetType(); 2353 } 2354 2355 DECLARE_INSTRUCTION(Temporary); 2356 2357 private: 2358 const size_t index_; 2359 2360 DISALLOW_COPY_AND_ASSIGN(HTemporary); 2361}; 2362 2363class HSuspendCheck : public HTemplateInstruction<0> { 2364 public: 2365 explicit HSuspendCheck(uint32_t dex_pc) 2366 : HTemplateInstruction(SideEffects::None()), dex_pc_(dex_pc) {} 2367 2368 virtual bool NeedsEnvironment() const { 2369 return true; 2370 } 2371 2372 uint32_t GetDexPc() const { return dex_pc_; } 2373 2374 DECLARE_INSTRUCTION(SuspendCheck); 2375 2376 private: 2377 const uint32_t dex_pc_; 2378 2379 DISALLOW_COPY_AND_ASSIGN(HSuspendCheck); 2380}; 2381 2382/** 2383 * Instruction to load a Class object. 2384 */ 2385class HLoadClass : public HExpression<0> { 2386 public: 2387 HLoadClass(uint16_t type_index, 2388 bool is_referrers_class, 2389 uint32_t dex_pc) 2390 : HExpression(Primitive::kPrimNot, SideEffects::None()), 2391 type_index_(type_index), 2392 is_referrers_class_(is_referrers_class), 2393 dex_pc_(dex_pc), 2394 generate_clinit_check_(false) {} 2395 2396 bool CanBeMoved() const OVERRIDE { return true; } 2397 2398 bool InstructionDataEquals(HInstruction* other) const OVERRIDE { 2399 return other->AsLoadClass()->type_index_ == type_index_; 2400 } 2401 2402 size_t ComputeHashCode() const OVERRIDE { return type_index_; } 2403 2404 uint32_t GetDexPc() const { return dex_pc_; } 2405 uint16_t GetTypeIndex() const { return type_index_; } 2406 bool IsReferrersClass() const { return is_referrers_class_; } 2407 2408 bool NeedsEnvironment() const OVERRIDE { 2409 // Will call runtime and load the class if the class is not loaded yet. 2410 // TODO: finer grain decision. 2411 return !is_referrers_class_; 2412 } 2413 2414 bool MustGenerateClinitCheck() const { 2415 return generate_clinit_check_; 2416 } 2417 2418 void SetMustGenerateClinitCheck() { 2419 generate_clinit_check_ = true; 2420 } 2421 2422 bool CanCallRuntime() const { 2423 return MustGenerateClinitCheck() || !is_referrers_class_; 2424 } 2425 2426 DECLARE_INSTRUCTION(LoadClass); 2427 2428 private: 2429 const uint16_t type_index_; 2430 const bool is_referrers_class_; 2431 const uint32_t dex_pc_; 2432 // Whether this instruction must generate the initialization check. 2433 // Used for code generation. 2434 bool generate_clinit_check_; 2435 2436 DISALLOW_COPY_AND_ASSIGN(HLoadClass); 2437}; 2438 2439class HLoadString : public HExpression<0> { 2440 public: 2441 HLoadString(uint32_t string_index, uint32_t dex_pc) 2442 : HExpression(Primitive::kPrimNot, SideEffects::None()), 2443 string_index_(string_index), 2444 dex_pc_(dex_pc) {} 2445 2446 bool CanBeMoved() const OVERRIDE { return true; } 2447 2448 bool InstructionDataEquals(HInstruction* other) const OVERRIDE { 2449 return other->AsLoadString()->string_index_ == string_index_; 2450 } 2451 2452 size_t ComputeHashCode() const OVERRIDE { return string_index_; } 2453 2454 uint32_t GetDexPc() const { return dex_pc_; } 2455 uint32_t GetStringIndex() const { return string_index_; } 2456 2457 // TODO: Can we deopt or debug when we resolve a string? 2458 bool NeedsEnvironment() const OVERRIDE { return false; } 2459 2460 DECLARE_INSTRUCTION(LoadString); 2461 2462 private: 2463 const uint32_t string_index_; 2464 const uint32_t dex_pc_; 2465 2466 DISALLOW_COPY_AND_ASSIGN(HLoadString); 2467}; 2468 2469// TODO: Pass this check to HInvokeStaticOrDirect nodes. 2470/** 2471 * Performs an initialization check on its Class object input. 2472 */ 2473class HClinitCheck : public HExpression<1> { 2474 public: 2475 explicit HClinitCheck(HLoadClass* constant, uint32_t dex_pc) 2476 : HExpression(Primitive::kPrimNot, SideEffects::All()), 2477 dex_pc_(dex_pc) { 2478 SetRawInputAt(0, constant); 2479 } 2480 2481 bool CanBeMoved() const OVERRIDE { return true; } 2482 bool InstructionDataEquals(HInstruction* other) const OVERRIDE { 2483 UNUSED(other); 2484 return true; 2485 } 2486 2487 bool NeedsEnvironment() const OVERRIDE { 2488 // May call runtime to initialize the class. 2489 return true; 2490 } 2491 2492 uint32_t GetDexPc() const { return dex_pc_; } 2493 2494 HLoadClass* GetLoadClass() const { return InputAt(0)->AsLoadClass(); } 2495 2496 DECLARE_INSTRUCTION(ClinitCheck); 2497 2498 private: 2499 const uint32_t dex_pc_; 2500 2501 DISALLOW_COPY_AND_ASSIGN(HClinitCheck); 2502}; 2503 2504class HStaticFieldGet : public HExpression<1> { 2505 public: 2506 HStaticFieldGet(HInstruction* cls, 2507 Primitive::Type field_type, 2508 MemberOffset field_offset, 2509 bool is_volatile) 2510 : HExpression(field_type, SideEffects::DependsOnSomething()), 2511 field_info_(field_offset, field_type, is_volatile) { 2512 SetRawInputAt(0, cls); 2513 } 2514 2515 2516 bool CanBeMoved() const OVERRIDE { return !IsVolatile(); } 2517 2518 bool InstructionDataEquals(HInstruction* other) const OVERRIDE { 2519 HStaticFieldGet* other_get = other->AsStaticFieldGet(); 2520 return GetFieldOffset().SizeValue() == other_get->GetFieldOffset().SizeValue(); 2521 } 2522 2523 size_t ComputeHashCode() const OVERRIDE { 2524 return (HInstruction::ComputeHashCode() << 7) | GetFieldOffset().SizeValue(); 2525 } 2526 2527 const FieldInfo& GetFieldInfo() const { return field_info_; } 2528 MemberOffset GetFieldOffset() const { return field_info_.GetFieldOffset(); } 2529 Primitive::Type GetFieldType() const { return field_info_.GetFieldType(); } 2530 bool IsVolatile() const { return field_info_.IsVolatile(); } 2531 2532 DECLARE_INSTRUCTION(StaticFieldGet); 2533 2534 private: 2535 const FieldInfo field_info_; 2536 2537 DISALLOW_COPY_AND_ASSIGN(HStaticFieldGet); 2538}; 2539 2540class HStaticFieldSet : public HTemplateInstruction<2> { 2541 public: 2542 HStaticFieldSet(HInstruction* cls, 2543 HInstruction* value, 2544 Primitive::Type field_type, 2545 MemberOffset field_offset, 2546 bool is_volatile) 2547 : HTemplateInstruction(SideEffects::ChangesSomething()), 2548 field_info_(field_offset, field_type, is_volatile) { 2549 SetRawInputAt(0, cls); 2550 SetRawInputAt(1, value); 2551 } 2552 2553 const FieldInfo& GetFieldInfo() const { return field_info_; } 2554 MemberOffset GetFieldOffset() const { return field_info_.GetFieldOffset(); } 2555 Primitive::Type GetFieldType() const { return field_info_.GetFieldType(); } 2556 bool IsVolatile() const { return field_info_.IsVolatile(); } 2557 2558 HInstruction* GetValue() const { return InputAt(1); } 2559 2560 DECLARE_INSTRUCTION(StaticFieldSet); 2561 2562 private: 2563 const FieldInfo field_info_; 2564 2565 DISALLOW_COPY_AND_ASSIGN(HStaticFieldSet); 2566}; 2567 2568// Implement the move-exception DEX instruction. 2569class HLoadException : public HExpression<0> { 2570 public: 2571 HLoadException() : HExpression(Primitive::kPrimNot, SideEffects::None()) {} 2572 2573 DECLARE_INSTRUCTION(LoadException); 2574 2575 private: 2576 DISALLOW_COPY_AND_ASSIGN(HLoadException); 2577}; 2578 2579class HThrow : public HTemplateInstruction<1> { 2580 public: 2581 HThrow(HInstruction* exception, uint32_t dex_pc) 2582 : HTemplateInstruction(SideEffects::None()), dex_pc_(dex_pc) { 2583 SetRawInputAt(0, exception); 2584 } 2585 2586 bool IsControlFlow() const OVERRIDE { return true; } 2587 2588 bool NeedsEnvironment() const OVERRIDE { return true; } 2589 2590 uint32_t GetDexPc() const { return dex_pc_; } 2591 2592 DECLARE_INSTRUCTION(Throw); 2593 2594 private: 2595 uint32_t dex_pc_; 2596 2597 DISALLOW_COPY_AND_ASSIGN(HThrow); 2598}; 2599 2600class HInstanceOf : public HExpression<2> { 2601 public: 2602 HInstanceOf(HInstruction* object, 2603 HLoadClass* constant, 2604 bool class_is_final, 2605 uint32_t dex_pc) 2606 : HExpression(Primitive::kPrimBoolean, SideEffects::None()), 2607 class_is_final_(class_is_final), 2608 dex_pc_(dex_pc) { 2609 SetRawInputAt(0, object); 2610 SetRawInputAt(1, constant); 2611 } 2612 2613 bool CanBeMoved() const OVERRIDE { return true; } 2614 2615 bool InstructionDataEquals(HInstruction* other ATTRIBUTE_UNUSED) const OVERRIDE { 2616 return true; 2617 } 2618 2619 bool NeedsEnvironment() const OVERRIDE { 2620 return false; 2621 } 2622 2623 uint32_t GetDexPc() const { return dex_pc_; } 2624 2625 bool IsClassFinal() const { return class_is_final_; } 2626 2627 DECLARE_INSTRUCTION(InstanceOf); 2628 2629 private: 2630 const bool class_is_final_; 2631 const uint32_t dex_pc_; 2632 2633 DISALLOW_COPY_AND_ASSIGN(HInstanceOf); 2634}; 2635 2636class HCheckCast : public HTemplateInstruction<2> { 2637 public: 2638 HCheckCast(HInstruction* object, 2639 HLoadClass* constant, 2640 bool class_is_final, 2641 uint32_t dex_pc) 2642 : HTemplateInstruction(SideEffects::None()), 2643 class_is_final_(class_is_final), 2644 dex_pc_(dex_pc) { 2645 SetRawInputAt(0, object); 2646 SetRawInputAt(1, constant); 2647 } 2648 2649 bool CanBeMoved() const OVERRIDE { return true; } 2650 2651 bool InstructionDataEquals(HInstruction* other ATTRIBUTE_UNUSED) const OVERRIDE { 2652 return true; 2653 } 2654 2655 bool NeedsEnvironment() const OVERRIDE { 2656 // Instruction may throw a CheckCastError. 2657 return true; 2658 } 2659 2660 bool CanThrow() const OVERRIDE { return true; } 2661 2662 uint32_t GetDexPc() const { return dex_pc_; } 2663 2664 bool IsClassFinal() const { return class_is_final_; } 2665 2666 DECLARE_INSTRUCTION(CheckCast); 2667 2668 private: 2669 const bool class_is_final_; 2670 const uint32_t dex_pc_; 2671 2672 DISALLOW_COPY_AND_ASSIGN(HCheckCast); 2673}; 2674 2675class HMonitorOperation : public HTemplateInstruction<1> { 2676 public: 2677 enum OperationKind { 2678 kEnter, 2679 kExit, 2680 }; 2681 2682 HMonitorOperation(HInstruction* object, OperationKind kind, uint32_t dex_pc) 2683 : HTemplateInstruction(SideEffects::None()), kind_(kind), dex_pc_(dex_pc) { 2684 SetRawInputAt(0, object); 2685 } 2686 2687 // Instruction may throw a Java exception, so we need an environment. 2688 bool NeedsEnvironment() const OVERRIDE { return true; } 2689 bool CanThrow() const OVERRIDE { return true; } 2690 2691 uint32_t GetDexPc() const { return dex_pc_; } 2692 2693 bool IsEnter() const { return kind_ == kEnter; } 2694 2695 DECLARE_INSTRUCTION(MonitorOperation); 2696 2697 private: 2698 const OperationKind kind_; 2699 const uint32_t dex_pc_; 2700 2701 private: 2702 DISALLOW_COPY_AND_ASSIGN(HMonitorOperation); 2703}; 2704 2705class MoveOperands : public ArenaObject<kArenaAllocMisc> { 2706 public: 2707 MoveOperands(Location source, Location destination, HInstruction* instruction) 2708 : source_(source), destination_(destination), instruction_(instruction) {} 2709 2710 Location GetSource() const { return source_; } 2711 Location GetDestination() const { return destination_; } 2712 2713 void SetSource(Location value) { source_ = value; } 2714 void SetDestination(Location value) { destination_ = value; } 2715 2716 // The parallel move resolver marks moves as "in-progress" by clearing the 2717 // destination (but not the source). 2718 Location MarkPending() { 2719 DCHECK(!IsPending()); 2720 Location dest = destination_; 2721 destination_ = Location::NoLocation(); 2722 return dest; 2723 } 2724 2725 void ClearPending(Location dest) { 2726 DCHECK(IsPending()); 2727 destination_ = dest; 2728 } 2729 2730 bool IsPending() const { 2731 DCHECK(!source_.IsInvalid() || destination_.IsInvalid()); 2732 return destination_.IsInvalid() && !source_.IsInvalid(); 2733 } 2734 2735 // True if this blocks a move from the given location. 2736 bool Blocks(Location loc) const { 2737 return !IsEliminated() && source_.Equals(loc); 2738 } 2739 2740 // A move is redundant if it's been eliminated, if its source and 2741 // destination are the same, or if its destination is unneeded. 2742 bool IsRedundant() const { 2743 return IsEliminated() || destination_.IsInvalid() || source_.Equals(destination_); 2744 } 2745 2746 // We clear both operands to indicate move that's been eliminated. 2747 void Eliminate() { 2748 source_ = destination_ = Location::NoLocation(); 2749 } 2750 2751 bool IsEliminated() const { 2752 DCHECK(!source_.IsInvalid() || destination_.IsInvalid()); 2753 return source_.IsInvalid(); 2754 } 2755 2756 HInstruction* GetInstruction() const { return instruction_; } 2757 2758 private: 2759 Location source_; 2760 Location destination_; 2761 // The instruction this move is assocatied with. Null when this move is 2762 // for moving an input in the expected locations of user (including a phi user). 2763 // This is only used in debug mode, to ensure we do not connect interval siblings 2764 // in the same parallel move. 2765 HInstruction* instruction_; 2766 2767 DISALLOW_COPY_AND_ASSIGN(MoveOperands); 2768}; 2769 2770static constexpr size_t kDefaultNumberOfMoves = 4; 2771 2772class HParallelMove : public HTemplateInstruction<0> { 2773 public: 2774 explicit HParallelMove(ArenaAllocator* arena) 2775 : HTemplateInstruction(SideEffects::None()), moves_(arena, kDefaultNumberOfMoves) {} 2776 2777 void AddMove(MoveOperands* move) { 2778 if (kIsDebugBuild && move->GetInstruction() != nullptr) { 2779 for (size_t i = 0, e = moves_.Size(); i < e; ++i) { 2780 DCHECK_NE(moves_.Get(i)->GetInstruction(), move->GetInstruction()) 2781 << "Doing parallel moves for the same instruction."; 2782 } 2783 } 2784 moves_.Add(move); 2785 } 2786 2787 MoveOperands* MoveOperandsAt(size_t index) const { 2788 return moves_.Get(index); 2789 } 2790 2791 size_t NumMoves() const { return moves_.Size(); } 2792 2793 DECLARE_INSTRUCTION(ParallelMove); 2794 2795 private: 2796 GrowableArray<MoveOperands*> moves_; 2797 2798 DISALLOW_COPY_AND_ASSIGN(HParallelMove); 2799}; 2800 2801class HGraphVisitor : public ValueObject { 2802 public: 2803 explicit HGraphVisitor(HGraph* graph) : graph_(graph) {} 2804 virtual ~HGraphVisitor() {} 2805 2806 virtual void VisitInstruction(HInstruction* instruction) { UNUSED(instruction); } 2807 virtual void VisitBasicBlock(HBasicBlock* block); 2808 2809 // Visit the graph following basic block insertion order. 2810 void VisitInsertionOrder(); 2811 2812 // Visit the graph following dominator tree reverse post-order. 2813 void VisitReversePostOrder(); 2814 2815 HGraph* GetGraph() const { return graph_; } 2816 2817 // Visit functions for instruction classes. 2818#define DECLARE_VISIT_INSTRUCTION(name, super) \ 2819 virtual void Visit##name(H##name* instr) { VisitInstruction(instr); } 2820 2821 FOR_EACH_INSTRUCTION(DECLARE_VISIT_INSTRUCTION) 2822 2823#undef DECLARE_VISIT_INSTRUCTION 2824 2825 private: 2826 HGraph* const graph_; 2827 2828 DISALLOW_COPY_AND_ASSIGN(HGraphVisitor); 2829}; 2830 2831class HGraphDelegateVisitor : public HGraphVisitor { 2832 public: 2833 explicit HGraphDelegateVisitor(HGraph* graph) : HGraphVisitor(graph) {} 2834 virtual ~HGraphDelegateVisitor() {} 2835 2836 // Visit functions that delegate to to super class. 2837#define DECLARE_VISIT_INSTRUCTION(name, super) \ 2838 virtual void Visit##name(H##name* instr) OVERRIDE { Visit##super(instr); } 2839 2840 FOR_EACH_INSTRUCTION(DECLARE_VISIT_INSTRUCTION) 2841 2842#undef DECLARE_VISIT_INSTRUCTION 2843 2844 private: 2845 DISALLOW_COPY_AND_ASSIGN(HGraphDelegateVisitor); 2846}; 2847 2848class HInsertionOrderIterator : public ValueObject { 2849 public: 2850 explicit HInsertionOrderIterator(const HGraph& graph) : graph_(graph), index_(0) {} 2851 2852 bool Done() const { return index_ == graph_.GetBlocks().Size(); } 2853 HBasicBlock* Current() const { return graph_.GetBlocks().Get(index_); } 2854 void Advance() { ++index_; } 2855 2856 private: 2857 const HGraph& graph_; 2858 size_t index_; 2859 2860 DISALLOW_COPY_AND_ASSIGN(HInsertionOrderIterator); 2861}; 2862 2863class HReversePostOrderIterator : public ValueObject { 2864 public: 2865 explicit HReversePostOrderIterator(const HGraph& graph) : graph_(graph), index_(0) {} 2866 2867 bool Done() const { return index_ == graph_.GetReversePostOrder().Size(); } 2868 HBasicBlock* Current() const { return graph_.GetReversePostOrder().Get(index_); } 2869 void Advance() { ++index_; } 2870 2871 private: 2872 const HGraph& graph_; 2873 size_t index_; 2874 2875 DISALLOW_COPY_AND_ASSIGN(HReversePostOrderIterator); 2876}; 2877 2878class HPostOrderIterator : public ValueObject { 2879 public: 2880 explicit HPostOrderIterator(const HGraph& graph) 2881 : graph_(graph), index_(graph_.GetReversePostOrder().Size()) {} 2882 2883 bool Done() const { return index_ == 0; } 2884 HBasicBlock* Current() const { return graph_.GetReversePostOrder().Get(index_ - 1); } 2885 void Advance() { --index_; } 2886 2887 private: 2888 const HGraph& graph_; 2889 size_t index_; 2890 2891 DISALLOW_COPY_AND_ASSIGN(HPostOrderIterator); 2892}; 2893 2894} // namespace art 2895 2896#endif // ART_COMPILER_OPTIMIZING_NODES_H_ 2897