blob: ea0cacc4ea73d8fdc9d4d828af0633f398987379 [file] [log] [blame]
Nicolas Geoffray818f2102014-02-18 16:43:35 +00001/*
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
Nicolas Geoffray4e3d23a2014-05-22 18:32:45 +010020#include "locations.h"
Nicolas Geoffraye5038322014-07-04 09:41:32 +010021#include "offsets.h"
Ian Rogerse63db272014-07-15 15:36:11 -070022#include "primitive.h"
Nicolas Geoffray818f2102014-02-18 16:43:35 +000023#include "utils/allocation.h"
Nicolas Geoffray0e336432014-02-26 18:24:38 +000024#include "utils/arena_bit_vector.h"
Nicolas Geoffray818f2102014-02-18 16:43:35 +000025#include "utils/growable_array.h"
26
27namespace art {
28
29class HBasicBlock;
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +010030class HEnvironment;
Nicolas Geoffray818f2102014-02-18 16:43:35 +000031class HInstruction;
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +000032class HIntConstant;
Nicolas Geoffray818f2102014-02-18 16:43:35 +000033class HGraphVisitor;
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +010034class HPhi;
Nicolas Geoffrayddb311f2014-05-16 09:28:54 +010035class LiveInterval;
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +000036class LocationSummary;
Nicolas Geoffray818f2102014-02-18 16:43:35 +000037
38static const int kDefaultNumberOfBlocks = 8;
39static const int kDefaultNumberOfSuccessors = 2;
40static const int kDefaultNumberOfPredecessors = 2;
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +000041static const int kDefaultNumberOfBackEdges = 1;
Nicolas Geoffray818f2102014-02-18 16:43:35 +000042
Dave Allison20dfc792014-06-16 20:44:29 -070043enum IfCondition {
44 kCondEQ,
45 kCondNE,
46 kCondLT,
47 kCondLE,
48 kCondGT,
49 kCondGE,
50};
51
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +010052class HInstructionList {
53 public:
54 HInstructionList() : first_instruction_(nullptr), last_instruction_(nullptr) {}
55
56 void AddInstruction(HInstruction* instruction);
57 void RemoveInstruction(HInstruction* instruction);
58
59 private:
60 HInstruction* first_instruction_;
61 HInstruction* last_instruction_;
62
63 friend class HBasicBlock;
64 friend class HInstructionIterator;
Nicolas Geoffray804d0932014-05-02 08:46:00 +010065 friend class HBackwardInstructionIterator;
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +010066
67 DISALLOW_COPY_AND_ASSIGN(HInstructionList);
68};
69
Nicolas Geoffray818f2102014-02-18 16:43:35 +000070// Control-flow graph of a method. Contains a list of basic blocks.
71class HGraph : public ArenaObject {
72 public:
73 explicit HGraph(ArenaAllocator* arena)
74 : arena_(arena),
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +000075 blocks_(arena, kDefaultNumberOfBlocks),
Nicolas Geoffray622d9c32014-05-12 16:11:02 +010076 reverse_post_order_(arena, kDefaultNumberOfBlocks),
Nicolas Geoffray4a34a422014-04-03 10:38:37 +010077 maximum_number_of_out_vregs_(0),
Nicolas Geoffrayf583e592014-04-07 13:20:42 +010078 number_of_vregs_(0),
79 number_of_in_vregs_(0),
Nicolas Geoffraye5038322014-07-04 09:41:32 +010080 number_of_temporaries_(0),
Dave Allison20dfc792014-06-16 20:44:29 -070081 current_instruction_id_(0) {}
Nicolas Geoffray818f2102014-02-18 16:43:35 +000082
Nicolas Geoffray787c3072014-03-17 10:20:19 +000083 ArenaAllocator* GetArena() const { return arena_; }
Nicolas Geoffray804d0932014-05-02 08:46:00 +010084 const GrowableArray<HBasicBlock*>& GetBlocks() const { return blocks_; }
Nicolas Geoffray818f2102014-02-18 16:43:35 +000085
Nicolas Geoffray787c3072014-03-17 10:20:19 +000086 HBasicBlock* GetEntryBlock() const { return entry_block_; }
87 HBasicBlock* GetExitBlock() const { return exit_block_; }
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +000088
Nicolas Geoffray787c3072014-03-17 10:20:19 +000089 void SetEntryBlock(HBasicBlock* block) { entry_block_ = block; }
90 void SetExitBlock(HBasicBlock* block) { exit_block_ = block; }
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +000091
Nicolas Geoffray818f2102014-02-18 16:43:35 +000092 void AddBlock(HBasicBlock* block);
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +010093
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +000094 void BuildDominatorTree();
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +010095 void TransformToSSA();
96 void SimplifyCFG();
Nicolas Geoffray818f2102014-02-18 16:43:35 +000097
Nicolas Geoffray622d9c32014-05-12 16:11:02 +010098 // Find all natural loops in this graph. Aborts computation and returns false
Nicolas Geoffrayf635e632014-05-14 09:43:38 +010099 // if one loop is not natural, that is the header does not dominate the back
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100100 // edge.
101 bool FindNaturalLoops() const;
102
103 void SplitCriticalEdge(HBasicBlock* block, HBasicBlock* successor);
104 void SimplifyLoop(HBasicBlock* header);
105
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000106 int GetNextInstructionId() {
107 return current_instruction_id_++;
108 }
109
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100110 uint16_t GetMaximumNumberOfOutVRegs() const {
111 return maximum_number_of_out_vregs_;
112 }
113
114 void UpdateMaximumNumberOfOutVRegs(uint16_t new_value) {
115 maximum_number_of_out_vregs_ = std::max(new_value, maximum_number_of_out_vregs_);
116 }
117
Nicolas Geoffraye5038322014-07-04 09:41:32 +0100118 void UpdateNumberOfTemporaries(size_t count) {
119 number_of_temporaries_ = std::max(count, number_of_temporaries_);
120 }
121
122 size_t GetNumberOfTemporaries() const {
123 return number_of_temporaries_;
124 }
125
Nicolas Geoffrayf583e592014-04-07 13:20:42 +0100126 void SetNumberOfVRegs(uint16_t number_of_vregs) {
127 number_of_vregs_ = number_of_vregs;
128 }
129
130 uint16_t GetNumberOfVRegs() const {
131 return number_of_vregs_;
132 }
133
134 void SetNumberOfInVRegs(uint16_t value) {
135 number_of_in_vregs_ = value;
136 }
137
138 uint16_t GetNumberOfInVRegs() const {
139 return number_of_in_vregs_;
140 }
141
Nicolas Geoffrayab032bc2014-07-15 12:55:21 +0100142 uint16_t GetNumberOfLocalVRegs() const {
143 return number_of_vregs_ - number_of_in_vregs_;
144 }
145
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100146 const GrowableArray<HBasicBlock*>& GetReversePostOrder() const {
147 return reverse_post_order_;
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100148 }
Nicolas Geoffrayf583e592014-04-07 13:20:42 +0100149
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000150 private:
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000151 HBasicBlock* FindCommonDominator(HBasicBlock* first, HBasicBlock* second) const;
152 void VisitBlockForDominatorTree(HBasicBlock* block,
153 HBasicBlock* predecessor,
154 GrowableArray<size_t>* visits);
Nicolas Geoffray804d0932014-05-02 08:46:00 +0100155 void FindBackEdges(ArenaBitVector* visited);
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000156 void VisitBlockForBackEdges(HBasicBlock* block,
157 ArenaBitVector* visited,
Nicolas Geoffray804d0932014-05-02 08:46:00 +0100158 ArenaBitVector* visiting);
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000159 void RemoveDeadBlocks(const ArenaBitVector& visited) const;
160
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000161 ArenaAllocator* const arena_;
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000162
163 // List of blocks in insertion order.
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000164 GrowableArray<HBasicBlock*> blocks_;
165
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100166 // List of blocks to perform a reverse post order tree traversal.
167 GrowableArray<HBasicBlock*> reverse_post_order_;
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000168
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000169 HBasicBlock* entry_block_;
170 HBasicBlock* exit_block_;
171
Nicolas Geoffrayf583e592014-04-07 13:20:42 +0100172 // The maximum number of virtual registers arguments passed to a HInvoke in this graph.
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100173 uint16_t maximum_number_of_out_vregs_;
174
Nicolas Geoffrayf583e592014-04-07 13:20:42 +0100175 // The number of virtual registers in this method. Contains the parameters.
176 uint16_t number_of_vregs_;
177
178 // The number of virtual registers used by parameters of this method.
179 uint16_t number_of_in_vregs_;
180
Nicolas Geoffraye5038322014-07-04 09:41:32 +0100181 // The number of temporaries that will be needed for the baseline compiler.
182 size_t number_of_temporaries_;
183
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000184 // The current id to assign to a newly added instruction. See HInstruction.id_.
185 int current_instruction_id_;
186
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000187 DISALLOW_COPY_AND_ASSIGN(HGraph);
188};
189
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000190class HLoopInformation : public ArenaObject {
191 public:
192 HLoopInformation(HBasicBlock* header, HGraph* graph)
193 : header_(header),
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100194 back_edges_(graph->GetArena(), kDefaultNumberOfBackEdges),
195 blocks_(graph->GetArena(), graph->GetBlocks().Size(), false) {}
196
197 HBasicBlock* GetHeader() const {
198 return header_;
199 }
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000200
201 void AddBackEdge(HBasicBlock* back_edge) {
202 back_edges_.Add(back_edge);
203 }
204
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100205 void RemoveBackEdge(HBasicBlock* back_edge) {
206 back_edges_.Delete(back_edge);
207 }
208
209 bool IsBackEdge(HBasicBlock* block) {
210 for (size_t i = 0, e = back_edges_.Size(); i < e; ++i) {
211 if (back_edges_.Get(i) == block) return true;
212 }
213 return false;
214 }
215
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000216 int NumberOfBackEdges() const {
217 return back_edges_.Size();
218 }
219
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100220 HBasicBlock* GetPreHeader() const;
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100221
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100222 const GrowableArray<HBasicBlock*>& GetBackEdges() const {
223 return back_edges_;
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100224 }
225
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100226 void ClearBackEdges() {
227 back_edges_.Reset();
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100228 }
229
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100230 // Find blocks that are part of this loop. Returns whether the loop is a natural loop,
231 // that is the header dominates the back edge.
232 bool Populate();
233
234 // Returns whether this loop information contains `block`.
235 // Note that this loop information *must* be populated before entering this function.
236 bool Contains(const HBasicBlock& block) const;
237
238 // Returns whether this loop information is an inner loop of `other`.
239 // Note that `other` *must* be populated before entering this function.
240 bool IsIn(const HLoopInformation& other) const;
241
242 const ArenaBitVector& GetBlocks() const { return blocks_; }
243
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000244 private:
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100245 // Internal recursive implementation of `Populate`.
246 void PopulateRecursive(HBasicBlock* block);
247
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000248 HBasicBlock* header_;
249 GrowableArray<HBasicBlock*> back_edges_;
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100250 ArenaBitVector blocks_;
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000251
252 DISALLOW_COPY_AND_ASSIGN(HLoopInformation);
253};
254
Nicolas Geoffrayddb311f2014-05-16 09:28:54 +0100255static constexpr size_t kNoLifetime = -1;
256
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000257// A block in a method. Contains the list of instructions represented
258// as a double linked list. Each block knows its predecessors and
259// successors.
260class HBasicBlock : public ArenaObject {
261 public:
262 explicit HBasicBlock(HGraph* graph)
263 : graph_(graph),
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000264 predecessors_(graph->GetArena(), kDefaultNumberOfPredecessors),
265 successors_(graph->GetArena(), kDefaultNumberOfSuccessors),
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000266 loop_information_(nullptr),
267 dominator_(nullptr),
Nicolas Geoffrayddb311f2014-05-16 09:28:54 +0100268 block_id_(-1),
269 lifetime_start_(kNoLifetime),
270 lifetime_end_(kNoLifetime) {}
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000271
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100272 const GrowableArray<HBasicBlock*>& GetPredecessors() const {
273 return predecessors_;
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000274 }
275
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100276 const GrowableArray<HBasicBlock*>& GetSuccessors() const {
277 return successors_;
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000278 }
279
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000280 void AddBackEdge(HBasicBlock* back_edge) {
281 if (loop_information_ == nullptr) {
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000282 loop_information_ = new (graph_->GetArena()) HLoopInformation(this, graph_);
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000283 }
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100284 DCHECK_EQ(loop_information_->GetHeader(), this);
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000285 loop_information_->AddBackEdge(back_edge);
286 }
287
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000288 HGraph* GetGraph() const { return graph_; }
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000289
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000290 int GetBlockId() const { return block_id_; }
291 void SetBlockId(int id) { block_id_ = id; }
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000292
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000293 HBasicBlock* GetDominator() const { return dominator_; }
294 void SetDominator(HBasicBlock* dominator) { dominator_ = dominator; }
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000295
296 int NumberOfBackEdges() const {
297 return loop_information_ == nullptr
298 ? 0
299 : loop_information_->NumberOfBackEdges();
300 }
301
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100302 HInstruction* GetFirstInstruction() const { return instructions_.first_instruction_; }
303 HInstruction* GetLastInstruction() const { return instructions_.last_instruction_; }
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100304 const HInstructionList& GetInstructions() const { return instructions_; }
305 const HInstructionList& GetPhis() const { return phis_; }
Nicolas Geoffraya7062e02014-05-22 12:50:17 +0100306 HInstruction* GetFirstPhi() const { return phis_.first_instruction_; }
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000307
308 void AddSuccessor(HBasicBlock* block) {
309 successors_.Add(block);
310 block->predecessors_.Add(this);
311 }
312
Nicolas Geoffrayec7e4722014-06-06 11:24:33 +0100313 void ReplaceSuccessor(HBasicBlock* existing, HBasicBlock* new_block) {
314 size_t successor_index = GetSuccessorIndexOf(existing);
315 DCHECK_NE(successor_index, static_cast<size_t>(-1));
316 existing->RemovePredecessor(this);
317 new_block->predecessors_.Add(this);
318 successors_.Put(successor_index, new_block);
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000319 }
320
Nicolas Geoffrayec7e4722014-06-06 11:24:33 +0100321 void RemovePredecessor(HBasicBlock* block) {
322 predecessors_.Delete(block);
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100323 }
324
325 void ClearAllPredecessors() {
326 predecessors_.Reset();
327 }
328
329 void AddPredecessor(HBasicBlock* block) {
330 predecessors_.Add(block);
331 block->successors_.Add(this);
332 }
333
Nicolas Geoffrayddb311f2014-05-16 09:28:54 +0100334 size_t GetPredecessorIndexOf(HBasicBlock* predecessor) {
335 for (size_t i = 0, e = predecessors_.Size(); i < e; ++i) {
336 if (predecessors_.Get(i) == predecessor) {
337 return i;
338 }
339 }
340 return -1;
341 }
342
Nicolas Geoffrayec7e4722014-06-06 11:24:33 +0100343 size_t GetSuccessorIndexOf(HBasicBlock* successor) {
344 for (size_t i = 0, e = successors_.Size(); i < e; ++i) {
345 if (successors_.Get(i) == successor) {
346 return i;
347 }
348 }
349 return -1;
350 }
351
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000352 void AddInstruction(HInstruction* instruction);
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100353 void RemoveInstruction(HInstruction* instruction);
Nicolas Geoffray4e3d23a2014-05-22 18:32:45 +0100354 void InsertInstructionBefore(HInstruction* instruction, HInstruction* cursor);
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100355 void AddPhi(HPhi* phi);
356 void RemovePhi(HPhi* phi);
357
358 bool IsLoopHeader() const {
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100359 return (loop_information_ != nullptr) && (loop_information_->GetHeader() == this);
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100360 }
361
362 HLoopInformation* GetLoopInformation() const {
363 return loop_information_;
364 }
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000365
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100366 // Set the loop_information_ on this block. This method overrides the current
367 // loop_information if it is an outer loop of the passed loop information.
368 void SetInLoop(HLoopInformation* info) {
369 if (IsLoopHeader()) {
370 // Nothing to do. This just means `info` is an outer loop.
371 } else if (loop_information_ == nullptr) {
372 loop_information_ = info;
373 } else if (loop_information_->Contains(*info->GetHeader())) {
374 // Block is currently part of an outer loop. Make it part of this inner loop.
375 // Note that a non loop header having a loop information means this loop information
376 // has already been populated
377 loop_information_ = info;
378 } else {
379 // Block is part of an inner loop. Do not update the loop information.
380 // Note that we cannot do the check `info->Contains(loop_information_)->GetHeader()`
381 // at this point, because this method is being called while populating `info`.
382 }
383 }
384
Nicolas Geoffray7dc206a2014-07-11 09:49:49 +0100385 bool IsInLoop() const { return loop_information_ != nullptr; }
386
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100387 // Returns wheter this block dominates the blocked passed as parameter.
388 bool Dominates(HBasicBlock* block) const;
389
Nicolas Geoffrayddb311f2014-05-16 09:28:54 +0100390 size_t GetLifetimeStart() const { return lifetime_start_; }
391 size_t GetLifetimeEnd() const { return lifetime_end_; }
392
393 void SetLifetimeStart(size_t start) { lifetime_start_ = start; }
394 void SetLifetimeEnd(size_t end) { lifetime_end_ = end; }
395
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000396 private:
397 HGraph* const graph_;
398 GrowableArray<HBasicBlock*> predecessors_;
399 GrowableArray<HBasicBlock*> successors_;
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100400 HInstructionList instructions_;
401 HInstructionList phis_;
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000402 HLoopInformation* loop_information_;
403 HBasicBlock* dominator_;
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000404 int block_id_;
Nicolas Geoffrayddb311f2014-05-16 09:28:54 +0100405 size_t lifetime_start_;
406 size_t lifetime_end_;
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000407
408 DISALLOW_COPY_AND_ASSIGN(HBasicBlock);
409};
410
Nicolas Geoffray96f89a22014-07-11 10:57:49 +0100411#define FOR_EACH_CONCRETE_INSTRUCTION(M) \
Nicolas Geoffrayd8ee7372014-03-28 15:43:40 +0000412 M(Add) \
Dave Allison20dfc792014-06-16 20:44:29 -0700413 M(Condition) \
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000414 M(Equal) \
Dave Allison20dfc792014-06-16 20:44:29 -0700415 M(NotEqual) \
416 M(LessThan) \
417 M(LessThanOrEqual) \
418 M(GreaterThan) \
419 M(GreaterThanOrEqual) \
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000420 M(Exit) \
421 M(Goto) \
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000422 M(If) \
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000423 M(IntConstant) \
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +0000424 M(InvokeStatic) \
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000425 M(LoadLocal) \
426 M(Local) \
Nicolas Geoffray01bc96d2014-04-11 17:43:50 +0100427 M(LongConstant) \
Nicolas Geoffray2e7038a2014-04-03 18:49:58 +0100428 M(NewInstance) \
Nicolas Geoffrayb55f8352014-04-07 15:26:35 +0100429 M(Not) \
Nicolas Geoffrayf583e592014-04-07 13:20:42 +0100430 M(ParameterValue) \
Nicolas Geoffray4e3d23a2014-05-22 18:32:45 +0100431 M(ParallelMove) \
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100432 M(Phi) \
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000433 M(Return) \
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000434 M(ReturnVoid) \
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000435 M(StoreLocal) \
Nicolas Geoffrayf583e592014-04-07 13:20:42 +0100436 M(Sub) \
Nicolas Geoffray412f10c2014-06-19 10:00:34 +0100437 M(Compare) \
Nicolas Geoffraye5038322014-07-04 09:41:32 +0100438 M(InstanceFieldGet) \
439 M(InstanceFieldSet) \
Nicolas Geoffray3c7bb982014-07-23 16:04:16 +0100440 M(ArrayGet) \
441 M(ArraySet) \
442 M(ArrayLength) \
443 M(BoundsCheck) \
Nicolas Geoffraye5038322014-07-04 09:41:32 +0100444 M(NullCheck) \
445 M(Temporary) \
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000446
Nicolas Geoffray96f89a22014-07-11 10:57:49 +0100447#define FOR_EACH_INSTRUCTION(M) \
448 FOR_EACH_CONCRETE_INSTRUCTION(M) \
449 M(Constant)
Dave Allison20dfc792014-06-16 20:44:29 -0700450
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000451#define FORWARD_DECLARATION(type) class H##type;
452FOR_EACH_INSTRUCTION(FORWARD_DECLARATION)
453#undef FORWARD_DECLARATION
454
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000455#define DECLARE_INSTRUCTION(type) \
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000456 virtual const char* DebugName() const { return #type; } \
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000457 virtual H##type* As##type() { return this; } \
Nicolas Geoffraya7062e02014-05-22 12:50:17 +0100458 virtual void Accept(HGraphVisitor* visitor) \
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000459
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100460template <typename T>
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000461class HUseListNode : public ArenaObject {
462 public:
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100463 HUseListNode(T* user, size_t index, HUseListNode* tail)
Dave Allison20dfc792014-06-16 20:44:29 -0700464 : user_(user), index_(index), tail_(tail) {}
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000465
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000466 HUseListNode* GetTail() const { return tail_; }
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100467 T* GetUser() const { return user_; }
468 size_t GetIndex() const { return index_; }
469
470 void SetTail(HUseListNode<T>* node) { tail_ = node; }
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000471
472 private:
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100473 T* const user_;
474 const size_t index_;
475 HUseListNode<T>* tail_;
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000476
477 DISALLOW_COPY_AND_ASSIGN(HUseListNode);
478};
479
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000480class HInstruction : public ArenaObject {
481 public:
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000482 HInstruction()
483 : previous_(nullptr),
484 next_(nullptr),
485 block_(nullptr),
486 id_(-1),
Nicolas Geoffray804d0932014-05-02 08:46:00 +0100487 ssa_index_(-1),
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000488 uses_(nullptr),
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100489 env_uses_(nullptr),
490 environment_(nullptr),
Nicolas Geoffrayddb311f2014-05-16 09:28:54 +0100491 locations_(nullptr),
492 live_interval_(nullptr),
493 lifetime_position_(kNoLifetime) {}
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000494
Dave Allison20dfc792014-06-16 20:44:29 -0700495 virtual ~HInstruction() {}
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000496
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000497 HInstruction* GetNext() const { return next_; }
498 HInstruction* GetPrevious() const { return previous_; }
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000499
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000500 HBasicBlock* GetBlock() const { return block_; }
501 void SetBlock(HBasicBlock* block) { block_ = block; }
Nicolas Geoffray7dc206a2014-07-11 09:49:49 +0100502 bool IsInBlock() const { return block_ != nullptr; }
503 bool IsInLoop() const { return block_->IsInLoop(); }
Nicolas Geoffray3ac17fc2014-08-06 23:02:54 +0100504 bool IsLoopHeaderPhi() { return IsPhi() && block_->IsLoopHeader(); }
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000505
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100506 virtual size_t InputCount() const = 0;
507 virtual HInstruction* InputAt(size_t i) const = 0;
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000508
509 virtual void Accept(HGraphVisitor* visitor) = 0;
510 virtual const char* DebugName() const = 0;
511
Nicolas Geoffray01bc96d2014-04-11 17:43:50 +0100512 virtual Primitive::Type GetType() const { return Primitive::kPrimVoid; }
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100513 virtual void SetRawInputAt(size_t index, HInstruction* input) = 0;
Nicolas Geoffray01bc96d2014-04-11 17:43:50 +0100514
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100515 virtual bool NeedsEnvironment() const { return false; }
Nicolas Geoffrayec7e4722014-06-06 11:24:33 +0100516 virtual bool IsControlFlow() const { return false; }
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100517
518 void AddUseAt(HInstruction* user, size_t index) {
519 uses_ = new (block_->GetGraph()->GetArena()) HUseListNode<HInstruction>(user, index, uses_);
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000520 }
521
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100522 void AddEnvUseAt(HEnvironment* user, size_t index) {
523 env_uses_ = new (block_->GetGraph()->GetArena()) HUseListNode<HEnvironment>(
524 user, index, env_uses_);
525 }
526
527 void RemoveUser(HInstruction* user, size_t index);
528
529 HUseListNode<HInstruction>* GetUses() const { return uses_; }
530 HUseListNode<HEnvironment>* GetEnvUses() const { return env_uses_; }
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000531
Nicolas Geoffray804d0932014-05-02 08:46:00 +0100532 bool HasUses() const { return uses_ != nullptr || env_uses_ != nullptr; }
Nicolas Geoffray7dc206a2014-07-11 09:49:49 +0100533 bool HasEnvironmentUses() const { return env_uses_ != nullptr; }
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000534
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100535 size_t NumberOfUses() const {
Nicolas Geoffray0d3f5782014-05-14 09:43:38 +0100536 // TODO: Optimize this method if it is used outside of the HGraphVisualizer.
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100537 size_t result = 0;
538 HUseListNode<HInstruction>* current = uses_;
539 while (current != nullptr) {
540 current = current->GetTail();
541 ++result;
542 }
543 return result;
544 }
545
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000546 int GetId() const { return id_; }
547 void SetId(int id) { id_ = id; }
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000548
Nicolas Geoffray804d0932014-05-02 08:46:00 +0100549 int GetSsaIndex() const { return ssa_index_; }
550 void SetSsaIndex(int ssa_index) { ssa_index_ = ssa_index; }
551 bool HasSsaIndex() const { return ssa_index_ != -1; }
552
553 bool HasEnvironment() const { return environment_ != nullptr; }
554 HEnvironment* GetEnvironment() const { return environment_; }
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100555 void SetEnvironment(HEnvironment* environment) { environment_ = environment; }
556
Nicolas Geoffray39468442014-09-02 15:17:15 +0100557 // Returns the number of entries in the environment. Typically, that is the
558 // number of dex registers in a method. It could be more in case of inlining.
559 size_t EnvironmentSize() const;
560
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000561 LocationSummary* GetLocations() const { return locations_; }
562 void SetLocations(LocationSummary* locations) { locations_ = locations; }
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000563
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100564 void ReplaceWith(HInstruction* instruction);
565
Dave Allison20dfc792014-06-16 20:44:29 -0700566 bool HasOnlyOneUse() const {
567 return uses_ != nullptr && uses_->GetTail() == nullptr;
568 }
569
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000570#define INSTRUCTION_TYPE_CHECK(type) \
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100571 bool Is##type() { return (As##type() != nullptr); } \
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000572 virtual H##type* As##type() { return nullptr; }
573
574 FOR_EACH_INSTRUCTION(INSTRUCTION_TYPE_CHECK)
575#undef INSTRUCTION_TYPE_CHECK
576
Nicolas Geoffrayddb311f2014-05-16 09:28:54 +0100577 size_t GetLifetimePosition() const { return lifetime_position_; }
578 void SetLifetimePosition(size_t position) { lifetime_position_ = position; }
579 LiveInterval* GetLiveInterval() const { return live_interval_; }
580 void SetLiveInterval(LiveInterval* interval) { live_interval_ = interval; }
581 bool HasLiveInterval() const { return live_interval_ != nullptr; }
582
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000583 private:
584 HInstruction* previous_;
585 HInstruction* next_;
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000586 HBasicBlock* block_;
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000587
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000588 // An instruction gets an id when it is added to the graph.
589 // It reflects creation order. A negative id means the instruction
Nicolas Geoffray39468442014-09-02 15:17:15 +0100590 // has not been added to the graph.
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000591 int id_;
592
Nicolas Geoffray804d0932014-05-02 08:46:00 +0100593 // When doing liveness analysis, instructions that have uses get an SSA index.
594 int ssa_index_;
595
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100596 // List of instructions that have this instruction as input.
597 HUseListNode<HInstruction>* uses_;
598
599 // List of environments that contain this instruction.
600 HUseListNode<HEnvironment>* env_uses_;
601
Nicolas Geoffray39468442014-09-02 15:17:15 +0100602 // The environment associated with this instruction. Not null if the instruction
603 // might jump out of the method.
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100604 HEnvironment* environment_;
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000605
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000606 // Set by the code generator.
607 LocationSummary* locations_;
608
Nicolas Geoffrayddb311f2014-05-16 09:28:54 +0100609 // Set by the liveness analysis.
610 LiveInterval* live_interval_;
611
612 // Set by the liveness analysis, this is the position in a linear
613 // order of blocks where this instruction's live interval start.
614 size_t lifetime_position_;
615
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000616 friend class HBasicBlock;
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100617 friend class HInstructionList;
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000618
619 DISALLOW_COPY_AND_ASSIGN(HInstruction);
620};
621
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100622template<typename T>
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000623class HUseIterator : public ValueObject {
624 public:
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100625 explicit HUseIterator(HUseListNode<T>* uses) : current_(uses) {}
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000626
627 bool Done() const { return current_ == nullptr; }
628
629 void Advance() {
630 DCHECK(!Done());
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000631 current_ = current_->GetTail();
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000632 }
633
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100634 HUseListNode<T>* Current() const {
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000635 DCHECK(!Done());
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100636 return current_;
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000637 }
638
639 private:
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100640 HUseListNode<T>* current_;
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000641
642 friend class HValue;
643};
644
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100645// A HEnvironment object contains the values of virtual registers at a given location.
646class HEnvironment : public ArenaObject {
647 public:
648 HEnvironment(ArenaAllocator* arena, size_t number_of_vregs) : vregs_(arena, number_of_vregs) {
649 vregs_.SetSize(number_of_vregs);
650 for (size_t i = 0; i < number_of_vregs; i++) {
651 vregs_.Put(i, nullptr);
652 }
653 }
654
655 void Populate(const GrowableArray<HInstruction*>& env) {
656 for (size_t i = 0; i < env.Size(); i++) {
657 HInstruction* instruction = env.Get(i);
658 vregs_.Put(i, instruction);
659 if (instruction != nullptr) {
660 instruction->AddEnvUseAt(this, i);
661 }
662 }
663 }
664
665 void SetRawEnvAt(size_t index, HInstruction* instruction) {
666 vregs_.Put(index, instruction);
667 }
668
Nicolas Geoffray39468442014-09-02 15:17:15 +0100669 HInstruction* GetInstructionAt(size_t index) const {
670 return vregs_.Get(index);
671 }
672
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100673 GrowableArray<HInstruction*>* GetVRegs() {
674 return &vregs_;
675 }
676
Nicolas Geoffray39468442014-09-02 15:17:15 +0100677 size_t Size() const { return vregs_.Size(); }
678
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100679 private:
680 GrowableArray<HInstruction*> vregs_;
681
682 DISALLOW_COPY_AND_ASSIGN(HEnvironment);
683};
684
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000685class HInputIterator : public ValueObject {
686 public:
Dave Allison20dfc792014-06-16 20:44:29 -0700687 explicit HInputIterator(HInstruction* instruction) : instruction_(instruction), index_(0) {}
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000688
689 bool Done() const { return index_ == instruction_->InputCount(); }
690 HInstruction* Current() const { return instruction_->InputAt(index_); }
691 void Advance() { index_++; }
692
693 private:
694 HInstruction* instruction_;
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100695 size_t index_;
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000696
697 DISALLOW_COPY_AND_ASSIGN(HInputIterator);
698};
699
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000700class HInstructionIterator : public ValueObject {
701 public:
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100702 explicit HInstructionIterator(const HInstructionList& instructions)
703 : instruction_(instructions.first_instruction_) {
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000704 next_ = Done() ? nullptr : instruction_->GetNext();
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000705 }
706
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000707 bool Done() const { return instruction_ == nullptr; }
708 HInstruction* Current() const { return instruction_; }
709 void Advance() {
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000710 instruction_ = next_;
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000711 next_ = Done() ? nullptr : instruction_->GetNext();
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000712 }
713
714 private:
715 HInstruction* instruction_;
716 HInstruction* next_;
Nicolas Geoffrayddb311f2014-05-16 09:28:54 +0100717
718 DISALLOW_COPY_AND_ASSIGN(HInstructionIterator);
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000719};
720
Nicolas Geoffray804d0932014-05-02 08:46:00 +0100721class HBackwardInstructionIterator : public ValueObject {
722 public:
723 explicit HBackwardInstructionIterator(const HInstructionList& instructions)
724 : instruction_(instructions.last_instruction_) {
725 next_ = Done() ? nullptr : instruction_->GetPrevious();
726 }
727
728 bool Done() const { return instruction_ == nullptr; }
729 HInstruction* Current() const { return instruction_; }
730 void Advance() {
731 instruction_ = next_;
732 next_ = Done() ? nullptr : instruction_->GetPrevious();
733 }
734
735 private:
736 HInstruction* instruction_;
737 HInstruction* next_;
Nicolas Geoffrayddb311f2014-05-16 09:28:54 +0100738
739 DISALLOW_COPY_AND_ASSIGN(HBackwardInstructionIterator);
Nicolas Geoffray804d0932014-05-02 08:46:00 +0100740};
741
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000742// An embedded container with N elements of type T. Used (with partial
743// specialization for N=0) because embedded arrays cannot have size 0.
744template<typename T, intptr_t N>
745class EmbeddedArray {
746 public:
Dave Allison20dfc792014-06-16 20:44:29 -0700747 EmbeddedArray() : elements_() {}
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000748
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000749 intptr_t GetLength() const { return N; }
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000750
751 const T& operator[](intptr_t i) const {
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000752 DCHECK_LT(i, GetLength());
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000753 return elements_[i];
754 }
755
756 T& operator[](intptr_t i) {
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000757 DCHECK_LT(i, GetLength());
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000758 return elements_[i];
759 }
760
761 const T& At(intptr_t i) const {
762 return (*this)[i];
763 }
764
765 void SetAt(intptr_t i, const T& val) {
766 (*this)[i] = val;
767 }
768
769 private:
770 T elements_[N];
771};
772
773template<typename T>
774class EmbeddedArray<T, 0> {
775 public:
776 intptr_t length() const { return 0; }
777 const T& operator[](intptr_t i) const {
778 LOG(FATAL) << "Unreachable";
779 static T sentinel = 0;
780 return sentinel;
781 }
782 T& operator[](intptr_t i) {
783 LOG(FATAL) << "Unreachable";
784 static T sentinel = 0;
785 return sentinel;
786 }
787};
788
789template<intptr_t N>
790class HTemplateInstruction: public HInstruction {
791 public:
Dave Allison20dfc792014-06-16 20:44:29 -0700792 HTemplateInstruction<N>() : inputs_() {}
793 virtual ~HTemplateInstruction() {}
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000794
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100795 virtual size_t InputCount() const { return N; }
796 virtual HInstruction* InputAt(size_t i) const { return inputs_[i]; }
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000797
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000798 protected:
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100799 virtual void SetRawInputAt(size_t i, HInstruction* instruction) {
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000800 inputs_[i] = instruction;
801 }
802
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000803 private:
804 EmbeddedArray<HInstruction*, N> inputs_;
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +0100805
806 friend class SsaBuilder;
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000807};
808
Dave Allison20dfc792014-06-16 20:44:29 -0700809template<intptr_t N>
810class HExpression: public HTemplateInstruction<N> {
811 public:
812 explicit HExpression<N>(Primitive::Type type) : type_(type) {}
813 virtual ~HExpression() {}
814
815 virtual Primitive::Type GetType() const { return type_; }
816
817 private:
818 const Primitive::Type type_;
819};
820
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000821// Represents dex's RETURN_VOID opcode. A HReturnVoid is a control flow
822// instruction that branches to the exit block.
823class HReturnVoid : public HTemplateInstruction<0> {
824 public:
Nicolas Geoffrayec7e4722014-06-06 11:24:33 +0100825 HReturnVoid() {}
826
827 virtual bool IsControlFlow() const { return true; }
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000828
Nicolas Geoffraya7062e02014-05-22 12:50:17 +0100829 DECLARE_INSTRUCTION(ReturnVoid);
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000830
831 private:
832 DISALLOW_COPY_AND_ASSIGN(HReturnVoid);
833};
834
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000835// Represents dex's RETURN opcodes. A HReturn is a control flow
836// instruction that branches to the exit block.
837class HReturn : public HTemplateInstruction<1> {
838 public:
839 explicit HReturn(HInstruction* value) {
840 SetRawInputAt(0, value);
841 }
842
Nicolas Geoffrayec7e4722014-06-06 11:24:33 +0100843 virtual bool IsControlFlow() const { return true; }
844
Nicolas Geoffraya7062e02014-05-22 12:50:17 +0100845 DECLARE_INSTRUCTION(Return);
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000846
847 private:
848 DISALLOW_COPY_AND_ASSIGN(HReturn);
849};
850
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000851// The exit instruction is the only instruction of the exit block.
852// Instructions aborting the method (HTrow and HReturn) must branch to the
853// exit block.
854class HExit : public HTemplateInstruction<0> {
855 public:
Nicolas Geoffrayec7e4722014-06-06 11:24:33 +0100856 HExit() {}
857
858 virtual bool IsControlFlow() const { return true; }
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000859
Nicolas Geoffraya7062e02014-05-22 12:50:17 +0100860 DECLARE_INSTRUCTION(Exit);
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000861
862 private:
863 DISALLOW_COPY_AND_ASSIGN(HExit);
864};
865
866// Jumps from one block to another.
867class HGoto : public HTemplateInstruction<0> {
868 public:
Nicolas Geoffrayec7e4722014-06-06 11:24:33 +0100869 HGoto() {}
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000870
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000871 HBasicBlock* GetSuccessor() const {
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100872 return GetBlock()->GetSuccessors().Get(0);
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000873 }
874
Nicolas Geoffrayec7e4722014-06-06 11:24:33 +0100875 virtual bool IsControlFlow() const { return true; }
876
Nicolas Geoffraya7062e02014-05-22 12:50:17 +0100877 DECLARE_INSTRUCTION(Goto);
Nicolas Geoffray818f2102014-02-18 16:43:35 +0000878
879 private:
880 DISALLOW_COPY_AND_ASSIGN(HGoto);
881};
882
Dave Allison20dfc792014-06-16 20:44:29 -0700883
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000884// Conditional branch. A block ending with an HIf instruction must have
885// two successors.
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000886class HIf : public HTemplateInstruction<1> {
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000887 public:
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000888 explicit HIf(HInstruction* input) {
889 SetRawInputAt(0, input);
890 }
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000891
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000892 HBasicBlock* IfTrueSuccessor() const {
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100893 return GetBlock()->GetSuccessors().Get(0);
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000894 }
895
896 HBasicBlock* IfFalseSuccessor() const {
Nicolas Geoffray622d9c32014-05-12 16:11:02 +0100897 return GetBlock()->GetSuccessors().Get(1);
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000898 }
899
Nicolas Geoffrayec7e4722014-06-06 11:24:33 +0100900 virtual bool IsControlFlow() const { return true; }
901
Nicolas Geoffraya7062e02014-05-22 12:50:17 +0100902 DECLARE_INSTRUCTION(If);
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000903
Dave Allison20dfc792014-06-16 20:44:29 -0700904 virtual bool IsIfInstruction() const { return true; }
905
Nicolas Geoffraybe9a92a2014-02-25 14:22:56 +0000906 private:
907 DISALLOW_COPY_AND_ASSIGN(HIf);
908};
909
Dave Allison20dfc792014-06-16 20:44:29 -0700910class HBinaryOperation : public HExpression<2> {
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000911 public:
Nicolas Geoffrayd8ee7372014-03-28 15:43:40 +0000912 HBinaryOperation(Primitive::Type result_type,
913 HInstruction* left,
Dave Allison20dfc792014-06-16 20:44:29 -0700914 HInstruction* right) : HExpression(result_type) {
Nicolas Geoffrayd8ee7372014-03-28 15:43:40 +0000915 SetRawInputAt(0, left);
916 SetRawInputAt(1, right);
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000917 }
918
Nicolas Geoffrayd8ee7372014-03-28 15:43:40 +0000919 HInstruction* GetLeft() const { return InputAt(0); }
920 HInstruction* GetRight() const { return InputAt(1); }
Dave Allison20dfc792014-06-16 20:44:29 -0700921 Primitive::Type GetResultType() const { return GetType(); }
Nicolas Geoffrayd8ee7372014-03-28 15:43:40 +0000922
923 virtual bool IsCommutative() { return false; }
924
925 private:
Nicolas Geoffrayd8ee7372014-03-28 15:43:40 +0000926 DISALLOW_COPY_AND_ASSIGN(HBinaryOperation);
927};
928
Dave Allison20dfc792014-06-16 20:44:29 -0700929class HCondition : public HBinaryOperation {
Nicolas Geoffrayd8ee7372014-03-28 15:43:40 +0000930 public:
Dave Allison20dfc792014-06-16 20:44:29 -0700931 HCondition(HInstruction* first, HInstruction* second)
Nicolas Geoffrayd8ee7372014-03-28 15:43:40 +0000932 : HBinaryOperation(Primitive::kPrimBoolean, first, second) {}
933
934 virtual bool IsCommutative() { return true; }
Dave Allison20dfc792014-06-16 20:44:29 -0700935 bool NeedsMaterialization() const;
Nicolas Geoffrayd8ee7372014-03-28 15:43:40 +0000936
Dave Allison20dfc792014-06-16 20:44:29 -0700937 DECLARE_INSTRUCTION(Condition);
938
939 virtual IfCondition GetCondition() const = 0;
940
941 private:
942 DISALLOW_COPY_AND_ASSIGN(HCondition);
943};
944
945// Instruction to check if two inputs are equal to each other.
946class HEqual : public HCondition {
947 public:
948 HEqual(HInstruction* first, HInstruction* second)
949 : HCondition(first, second) {}
Nicolas Geoffray01bc96d2014-04-11 17:43:50 +0100950
Nicolas Geoffraya7062e02014-05-22 12:50:17 +0100951 DECLARE_INSTRUCTION(Equal);
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000952
Dave Allison20dfc792014-06-16 20:44:29 -0700953 virtual IfCondition GetCondition() const {
954 return kCondEQ;
955 }
956
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +0000957 private:
958 DISALLOW_COPY_AND_ASSIGN(HEqual);
959};
960
Dave Allison20dfc792014-06-16 20:44:29 -0700961class HNotEqual : public HCondition {
962 public:
963 HNotEqual(HInstruction* first, HInstruction* second)
964 : HCondition(first, second) {}
965
966 DECLARE_INSTRUCTION(NotEqual);
967
968 virtual IfCondition GetCondition() const {
969 return kCondNE;
970 }
971
972 private:
973 DISALLOW_COPY_AND_ASSIGN(HNotEqual);
974};
975
976class HLessThan : public HCondition {
977 public:
978 HLessThan(HInstruction* first, HInstruction* second)
979 : HCondition(first, second) {}
980
981 DECLARE_INSTRUCTION(LessThan);
982
983 virtual IfCondition GetCondition() const {
984 return kCondLT;
985 }
986
987 private:
988 DISALLOW_COPY_AND_ASSIGN(HLessThan);
989};
990
991class HLessThanOrEqual : public HCondition {
992 public:
993 HLessThanOrEqual(HInstruction* first, HInstruction* second)
994 : HCondition(first, second) {}
995
996 DECLARE_INSTRUCTION(LessThanOrEqual);
997
998 virtual IfCondition GetCondition() const {
999 return kCondLE;
1000 }
1001
1002 private:
1003 DISALLOW_COPY_AND_ASSIGN(HLessThanOrEqual);
1004};
1005
1006class HGreaterThan : public HCondition {
1007 public:
1008 HGreaterThan(HInstruction* first, HInstruction* second)
1009 : HCondition(first, second) {}
1010
1011 DECLARE_INSTRUCTION(GreaterThan);
1012
1013 virtual IfCondition GetCondition() const {
1014 return kCondGT;
1015 }
1016
1017 private:
1018 DISALLOW_COPY_AND_ASSIGN(HGreaterThan);
1019};
1020
1021class HGreaterThanOrEqual : public HCondition {
1022 public:
1023 HGreaterThanOrEqual(HInstruction* first, HInstruction* second)
1024 : HCondition(first, second) {}
1025
1026 DECLARE_INSTRUCTION(GreaterThanOrEqual);
1027
1028 virtual IfCondition GetCondition() const {
1029 return kCondGE;
1030 }
1031
1032 private:
1033 DISALLOW_COPY_AND_ASSIGN(HGreaterThanOrEqual);
1034};
1035
1036
Nicolas Geoffray412f10c2014-06-19 10:00:34 +01001037// Instruction to check how two inputs compare to each other.
1038// Result is 0 if input0 == input1, 1 if input0 > input1, or -1 if input0 < input1.
1039class HCompare : public HBinaryOperation {
1040 public:
1041 HCompare(Primitive::Type type, HInstruction* first, HInstruction* second)
1042 : HBinaryOperation(Primitive::kPrimInt, first, second) {
1043 DCHECK_EQ(type, first->GetType());
1044 DCHECK_EQ(type, second->GetType());
1045 }
1046
1047 DECLARE_INSTRUCTION(Compare);
1048
1049 private:
1050 DISALLOW_COPY_AND_ASSIGN(HCompare);
1051};
1052
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +00001053// A local in the graph. Corresponds to a Dex register.
1054class HLocal : public HTemplateInstruction<0> {
1055 public:
Dave Allison20dfc792014-06-16 20:44:29 -07001056 explicit HLocal(uint16_t reg_number) : reg_number_(reg_number) {}
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +00001057
Nicolas Geoffraya7062e02014-05-22 12:50:17 +01001058 DECLARE_INSTRUCTION(Local);
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +00001059
Nicolas Geoffray787c3072014-03-17 10:20:19 +00001060 uint16_t GetRegNumber() const { return reg_number_; }
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +00001061
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +00001062 private:
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +00001063 // The Dex register number.
1064 const uint16_t reg_number_;
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +00001065
1066 DISALLOW_COPY_AND_ASSIGN(HLocal);
1067};
1068
1069// Load a given local. The local is an input of this instruction.
Dave Allison20dfc792014-06-16 20:44:29 -07001070class HLoadLocal : public HExpression<1> {
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +00001071 public:
Dave Allison20dfc792014-06-16 20:44:29 -07001072 explicit HLoadLocal(HLocal* local, Primitive::Type type) : HExpression(type) {
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +00001073 SetRawInputAt(0, local);
1074 }
1075
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +00001076 HLocal* GetLocal() const { return reinterpret_cast<HLocal*>(InputAt(0)); }
1077
Nicolas Geoffraya7062e02014-05-22 12:50:17 +01001078 DECLARE_INSTRUCTION(LoadLocal);
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +00001079
1080 private:
1081 DISALLOW_COPY_AND_ASSIGN(HLoadLocal);
1082};
1083
1084// Store a value in a given local. This instruction has two inputs: the value
1085// and the local.
1086class HStoreLocal : public HTemplateInstruction<2> {
1087 public:
1088 HStoreLocal(HLocal* local, HInstruction* value) {
1089 SetRawInputAt(0, local);
1090 SetRawInputAt(1, value);
1091 }
1092
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +00001093 HLocal* GetLocal() const { return reinterpret_cast<HLocal*>(InputAt(0)); }
1094
Nicolas Geoffraya7062e02014-05-22 12:50:17 +01001095 DECLARE_INSTRUCTION(StoreLocal);
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +00001096
1097 private:
1098 DISALLOW_COPY_AND_ASSIGN(HStoreLocal);
1099};
1100
Nicolas Geoffray96f89a22014-07-11 10:57:49 +01001101class HConstant : public HExpression<0> {
1102 public:
1103 explicit HConstant(Primitive::Type type) : HExpression(type) {}
1104
1105 DECLARE_INSTRUCTION(Constant);
1106
1107 private:
1108 DISALLOW_COPY_AND_ASSIGN(HConstant);
1109};
1110
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +00001111// Constants of the type int. Those can be from Dex instructions, or
1112// synthesized (for example with the if-eqz instruction).
Nicolas Geoffray96f89a22014-07-11 10:57:49 +01001113class HIntConstant : public HConstant {
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +00001114 public:
Nicolas Geoffray96f89a22014-07-11 10:57:49 +01001115 explicit HIntConstant(int32_t value) : HConstant(Primitive::kPrimInt), value_(value) {}
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +00001116
Nicolas Geoffray787c3072014-03-17 10:20:19 +00001117 int32_t GetValue() const { return value_; }
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +00001118
Nicolas Geoffraya7062e02014-05-22 12:50:17 +01001119 DECLARE_INSTRUCTION(IntConstant);
Nicolas Geoffray3ff386a2014-03-04 14:46:47 +00001120
1121 private:
1122 const int32_t value_;
1123
1124 DISALLOW_COPY_AND_ASSIGN(HIntConstant);
1125};
1126
Nicolas Geoffray96f89a22014-07-11 10:57:49 +01001127class HLongConstant : public HConstant {
Nicolas Geoffray01bc96d2014-04-11 17:43:50 +01001128 public:
Nicolas Geoffray96f89a22014-07-11 10:57:49 +01001129 explicit HLongConstant(int64_t value) : HConstant(Primitive::kPrimLong), value_(value) {}
Nicolas Geoffray01bc96d2014-04-11 17:43:50 +01001130
1131 int64_t GetValue() const { return value_; }
1132
Nicolas Geoffraya7062e02014-05-22 12:50:17 +01001133 DECLARE_INSTRUCTION(LongConstant);
Nicolas Geoffray01bc96d2014-04-11 17:43:50 +01001134
1135 private:
1136 const int64_t value_;
1137
1138 DISALLOW_COPY_AND_ASSIGN(HLongConstant);
1139};
1140
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +00001141class HInvoke : public HInstruction {
1142 public:
Nicolas Geoffray01bc96d2014-04-11 17:43:50 +01001143 HInvoke(ArenaAllocator* arena,
1144 uint32_t number_of_arguments,
1145 Primitive::Type return_type,
1146 uint32_t dex_pc)
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +00001147 : inputs_(arena, number_of_arguments),
Nicolas Geoffray01bc96d2014-04-11 17:43:50 +01001148 return_type_(return_type),
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +00001149 dex_pc_(dex_pc) {
1150 inputs_.SetSize(number_of_arguments);
1151 }
1152
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +01001153 virtual size_t InputCount() const { return inputs_.Size(); }
1154 virtual HInstruction* InputAt(size_t i) const { return inputs_.Get(i); }
1155
1156 // Runtime needs to walk the stack, so Dex -> Dex calls need to
1157 // know their environment.
1158 virtual bool NeedsEnvironment() const { return true; }
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +00001159
Nicolas Geoffray4a34a422014-04-03 10:38:37 +01001160 void SetArgumentAt(size_t index, HInstruction* argument) {
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +01001161 SetRawInputAt(index, argument);
1162 }
1163
1164 virtual void SetRawInputAt(size_t index, HInstruction* input) {
1165 inputs_.Put(index, input);
Nicolas Geoffray4a34a422014-04-03 10:38:37 +01001166 }
1167
Nicolas Geoffray01bc96d2014-04-11 17:43:50 +01001168 virtual Primitive::Type GetType() const { return return_type_; }
1169
Nicolas Geoffray2e7038a2014-04-03 18:49:58 +01001170 uint32_t GetDexPc() const { return dex_pc_; }
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +00001171
1172 protected:
1173 GrowableArray<HInstruction*> inputs_;
Nicolas Geoffray01bc96d2014-04-11 17:43:50 +01001174 const Primitive::Type return_type_;
Nicolas Geoffray2e7038a2014-04-03 18:49:58 +01001175 const uint32_t dex_pc_;
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +00001176
1177 private:
1178 DISALLOW_COPY_AND_ASSIGN(HInvoke);
1179};
1180
1181class HInvokeStatic : public HInvoke {
1182 public:
Nicolas Geoffray4a34a422014-04-03 10:38:37 +01001183 HInvokeStatic(ArenaAllocator* arena,
1184 uint32_t number_of_arguments,
Nicolas Geoffray01bc96d2014-04-11 17:43:50 +01001185 Primitive::Type return_type,
Nicolas Geoffray2e7038a2014-04-03 18:49:58 +01001186 uint32_t dex_pc,
1187 uint32_t index_in_dex_cache)
Nicolas Geoffray01bc96d2014-04-11 17:43:50 +01001188 : HInvoke(arena, number_of_arguments, return_type, dex_pc),
1189 index_in_dex_cache_(index_in_dex_cache) {}
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +00001190
1191 uint32_t GetIndexInDexCache() const { return index_in_dex_cache_; }
1192
Nicolas Geoffraya7062e02014-05-22 12:50:17 +01001193 DECLARE_INSTRUCTION(InvokeStatic);
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +00001194
1195 private:
Nicolas Geoffray4a34a422014-04-03 10:38:37 +01001196 const uint32_t index_in_dex_cache_;
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +00001197
1198 DISALLOW_COPY_AND_ASSIGN(HInvokeStatic);
1199};
1200
Dave Allison20dfc792014-06-16 20:44:29 -07001201class HNewInstance : public HExpression<0> {
Nicolas Geoffray2e7038a2014-04-03 18:49:58 +01001202 public:
Dave Allison20dfc792014-06-16 20:44:29 -07001203 HNewInstance(uint32_t dex_pc, uint16_t type_index) : HExpression(Primitive::kPrimNot),
1204 dex_pc_(dex_pc), type_index_(type_index) {}
Nicolas Geoffray2e7038a2014-04-03 18:49:58 +01001205
1206 uint32_t GetDexPc() const { return dex_pc_; }
1207 uint16_t GetTypeIndex() const { return type_index_; }
1208
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +01001209 // Calls runtime so needs an environment.
1210 virtual bool NeedsEnvironment() const { return true; }
1211
Nicolas Geoffraya7062e02014-05-22 12:50:17 +01001212 DECLARE_INSTRUCTION(NewInstance);
Nicolas Geoffray2e7038a2014-04-03 18:49:58 +01001213
1214 private:
1215 const uint32_t dex_pc_;
1216 const uint16_t type_index_;
1217
1218 DISALLOW_COPY_AND_ASSIGN(HNewInstance);
1219};
1220
Nicolas Geoffrayd8ee7372014-03-28 15:43:40 +00001221class HAdd : public HBinaryOperation {
1222 public:
1223 HAdd(Primitive::Type result_type, HInstruction* left, HInstruction* right)
1224 : HBinaryOperation(result_type, left, right) {}
1225
1226 virtual bool IsCommutative() { return true; }
1227
1228 DECLARE_INSTRUCTION(Add);
1229
1230 private:
1231 DISALLOW_COPY_AND_ASSIGN(HAdd);
1232};
1233
Nicolas Geoffrayf583e592014-04-07 13:20:42 +01001234class HSub : public HBinaryOperation {
1235 public:
1236 HSub(Primitive::Type result_type, HInstruction* left, HInstruction* right)
1237 : HBinaryOperation(result_type, left, right) {}
1238
1239 virtual bool IsCommutative() { return false; }
1240
1241 DECLARE_INSTRUCTION(Sub);
1242
1243 private:
1244 DISALLOW_COPY_AND_ASSIGN(HSub);
1245};
1246
1247// The value of a parameter in this method. Its location depends on
1248// the calling convention.
Dave Allison20dfc792014-06-16 20:44:29 -07001249class HParameterValue : public HExpression<0> {
Nicolas Geoffrayf583e592014-04-07 13:20:42 +01001250 public:
Nicolas Geoffray01bc96d2014-04-11 17:43:50 +01001251 HParameterValue(uint8_t index, Primitive::Type parameter_type)
Dave Allison20dfc792014-06-16 20:44:29 -07001252 : HExpression(parameter_type), index_(index) {}
Nicolas Geoffrayf583e592014-04-07 13:20:42 +01001253
1254 uint8_t GetIndex() const { return index_; }
1255
1256 DECLARE_INSTRUCTION(ParameterValue);
1257
1258 private:
1259 // The index of this parameter in the parameters list. Must be less
1260 // than HGraph::number_of_in_vregs_;
1261 const uint8_t index_;
1262
1263 DISALLOW_COPY_AND_ASSIGN(HParameterValue);
1264};
1265
Dave Allison20dfc792014-06-16 20:44:29 -07001266class HNot : public HExpression<1> {
Nicolas Geoffrayb55f8352014-04-07 15:26:35 +01001267 public:
Dave Allison20dfc792014-06-16 20:44:29 -07001268 explicit HNot(HInstruction* input) : HExpression(Primitive::kPrimBoolean) {
Nicolas Geoffrayb55f8352014-04-07 15:26:35 +01001269 SetRawInputAt(0, input);
1270 }
1271
1272 DECLARE_INSTRUCTION(Not);
1273
1274 private:
1275 DISALLOW_COPY_AND_ASSIGN(HNot);
1276};
1277
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +01001278class HPhi : public HInstruction {
1279 public:
1280 HPhi(ArenaAllocator* arena, uint32_t reg_number, size_t number_of_inputs, Primitive::Type type)
1281 : inputs_(arena, number_of_inputs),
1282 reg_number_(reg_number),
Nicolas Geoffray7dc206a2014-07-11 09:49:49 +01001283 type_(type),
1284 is_live_(false) {
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +01001285 inputs_.SetSize(number_of_inputs);
1286 }
1287
1288 virtual size_t InputCount() const { return inputs_.Size(); }
1289 virtual HInstruction* InputAt(size_t i) const { return inputs_.Get(i); }
1290
1291 virtual void SetRawInputAt(size_t index, HInstruction* input) {
1292 inputs_.Put(index, input);
1293 }
1294
1295 void AddInput(HInstruction* input);
1296
1297 virtual Primitive::Type GetType() const { return type_; }
Nicolas Geoffraya7062e02014-05-22 12:50:17 +01001298 void SetType(Primitive::Type type) { type_ = type; }
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +01001299
1300 uint32_t GetRegNumber() const { return reg_number_; }
1301
Nicolas Geoffray7dc206a2014-07-11 09:49:49 +01001302 void SetDead() { is_live_ = false; }
1303 void SetLive() { is_live_ = true; }
1304 bool IsDead() const { return !is_live_; }
1305 bool IsLive() const { return is_live_; }
1306
Nicolas Geoffraya7062e02014-05-22 12:50:17 +01001307 DECLARE_INSTRUCTION(Phi);
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +01001308
Nicolas Geoffray96f89a22014-07-11 10:57:49 +01001309 private:
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +01001310 GrowableArray<HInstruction*> inputs_;
1311 const uint32_t reg_number_;
Nicolas Geoffraya7062e02014-05-22 12:50:17 +01001312 Primitive::Type type_;
Nicolas Geoffray7dc206a2014-07-11 09:49:49 +01001313 bool is_live_;
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +01001314
Nicolas Geoffrayc32e7702014-04-24 12:43:16 +01001315 DISALLOW_COPY_AND_ASSIGN(HPhi);
1316};
1317
Nicolas Geoffraye5038322014-07-04 09:41:32 +01001318class HNullCheck : public HExpression<1> {
1319 public:
1320 HNullCheck(HInstruction* value, uint32_t dex_pc)
1321 : HExpression(value->GetType()), dex_pc_(dex_pc) {
1322 SetRawInputAt(0, value);
1323 }
1324
1325 virtual bool NeedsEnvironment() const { return true; }
1326
1327 uint32_t GetDexPc() const { return dex_pc_; }
1328
1329 DECLARE_INSTRUCTION(NullCheck);
1330
1331 private:
1332 const uint32_t dex_pc_;
1333
1334 DISALLOW_COPY_AND_ASSIGN(HNullCheck);
1335};
1336
1337class FieldInfo : public ValueObject {
1338 public:
Nicolas Geoffray39468442014-09-02 15:17:15 +01001339 explicit FieldInfo(MemberOffset field_offset, Primitive::Type field_type)
1340 : field_offset_(field_offset), field_type_(field_type) {}
Nicolas Geoffraye5038322014-07-04 09:41:32 +01001341
1342 MemberOffset GetFieldOffset() const { return field_offset_; }
Nicolas Geoffray39468442014-09-02 15:17:15 +01001343 Primitive::Type GetFieldType() const { return field_type_; }
Nicolas Geoffraye5038322014-07-04 09:41:32 +01001344
1345 private:
1346 const MemberOffset field_offset_;
Nicolas Geoffray39468442014-09-02 15:17:15 +01001347 const Primitive::Type field_type_;
Nicolas Geoffraye5038322014-07-04 09:41:32 +01001348};
1349
1350class HInstanceFieldGet : public HExpression<1> {
1351 public:
1352 HInstanceFieldGet(HInstruction* value,
1353 Primitive::Type field_type,
1354 MemberOffset field_offset)
Nicolas Geoffray39468442014-09-02 15:17:15 +01001355 : HExpression(field_type), field_info_(field_offset, field_type) {
Nicolas Geoffraye5038322014-07-04 09:41:32 +01001356 SetRawInputAt(0, value);
1357 }
1358
1359 MemberOffset GetFieldOffset() const { return field_info_.GetFieldOffset(); }
Nicolas Geoffray39468442014-09-02 15:17:15 +01001360 Primitive::Type GetFieldType() const { return field_info_.GetFieldType(); }
Nicolas Geoffraye5038322014-07-04 09:41:32 +01001361
1362 DECLARE_INSTRUCTION(InstanceFieldGet);
1363
1364 private:
1365 const FieldInfo field_info_;
1366
1367 DISALLOW_COPY_AND_ASSIGN(HInstanceFieldGet);
1368};
1369
1370class HInstanceFieldSet : public HTemplateInstruction<2> {
1371 public:
1372 HInstanceFieldSet(HInstruction* object,
1373 HInstruction* value,
Nicolas Geoffray39468442014-09-02 15:17:15 +01001374 Primitive::Type field_type,
Nicolas Geoffraye5038322014-07-04 09:41:32 +01001375 MemberOffset field_offset)
Nicolas Geoffray39468442014-09-02 15:17:15 +01001376 : field_info_(field_offset, field_type) {
Nicolas Geoffraye5038322014-07-04 09:41:32 +01001377 SetRawInputAt(0, object);
1378 SetRawInputAt(1, value);
1379 }
1380
1381 MemberOffset GetFieldOffset() const { return field_info_.GetFieldOffset(); }
Nicolas Geoffray39468442014-09-02 15:17:15 +01001382 Primitive::Type GetFieldType() const { return field_info_.GetFieldType(); }
Nicolas Geoffraye5038322014-07-04 09:41:32 +01001383
1384 DECLARE_INSTRUCTION(InstanceFieldSet);
1385
1386 private:
1387 const FieldInfo field_info_;
1388
1389 DISALLOW_COPY_AND_ASSIGN(HInstanceFieldSet);
1390};
1391
Nicolas Geoffray3c7bb982014-07-23 16:04:16 +01001392class HArrayGet : public HExpression<2> {
1393 public:
1394 HArrayGet(HInstruction* array, HInstruction* index, Primitive::Type type)
1395 : HExpression(type) {
1396 SetRawInputAt(0, array);
1397 SetRawInputAt(1, index);
1398 }
1399
1400 DECLARE_INSTRUCTION(ArrayGet);
1401
1402 private:
1403 DISALLOW_COPY_AND_ASSIGN(HArrayGet);
1404};
1405
1406class HArraySet : public HTemplateInstruction<3> {
1407 public:
1408 HArraySet(HInstruction* array,
1409 HInstruction* index,
1410 HInstruction* value,
Nicolas Geoffray39468442014-09-02 15:17:15 +01001411 Primitive::Type component_type,
1412 uint32_t dex_pc) : dex_pc_(dex_pc), component_type_(component_type) {
Nicolas Geoffray3c7bb982014-07-23 16:04:16 +01001413 SetRawInputAt(0, array);
1414 SetRawInputAt(1, index);
1415 SetRawInputAt(2, value);
1416 }
1417
1418 virtual bool NeedsEnvironment() const {
1419 // We currently always call a runtime method to catch array store
1420 // exceptions.
1421 return InputAt(2)->GetType() == Primitive::kPrimNot;
1422 }
1423
1424 uint32_t GetDexPc() const { return dex_pc_; }
1425
Nicolas Geoffray39468442014-09-02 15:17:15 +01001426 Primitive::Type GetComponentType() const { return component_type_; }
1427
Nicolas Geoffray3c7bb982014-07-23 16:04:16 +01001428 DECLARE_INSTRUCTION(ArraySet);
1429
1430 private:
1431 const uint32_t dex_pc_;
Nicolas Geoffray39468442014-09-02 15:17:15 +01001432 const Primitive::Type component_type_;
Nicolas Geoffray3c7bb982014-07-23 16:04:16 +01001433
1434 DISALLOW_COPY_AND_ASSIGN(HArraySet);
1435};
1436
1437class HArrayLength : public HExpression<1> {
1438 public:
1439 explicit HArrayLength(HInstruction* array) : HExpression(Primitive::kPrimInt) {
1440 SetRawInputAt(0, array);
1441 }
1442
1443 DECLARE_INSTRUCTION(ArrayLength);
1444
1445 private:
1446 DISALLOW_COPY_AND_ASSIGN(HArrayLength);
1447};
1448
1449class HBoundsCheck : public HExpression<2> {
1450 public:
1451 HBoundsCheck(HInstruction* index, HInstruction* length, uint32_t dex_pc)
1452 : HExpression(index->GetType()), dex_pc_(dex_pc) {
1453 DCHECK(index->GetType() == Primitive::kPrimInt);
1454 SetRawInputAt(0, index);
1455 SetRawInputAt(1, length);
1456 }
1457
1458 virtual bool NeedsEnvironment() const { return true; }
1459
1460 uint32_t GetDexPc() const { return dex_pc_; }
1461
1462 DECLARE_INSTRUCTION(BoundsCheck);
1463
1464 private:
1465 const uint32_t dex_pc_;
1466
1467 DISALLOW_COPY_AND_ASSIGN(HBoundsCheck);
1468};
1469
Nicolas Geoffraye5038322014-07-04 09:41:32 +01001470/**
1471 * Some DEX instructions are folded into multiple HInstructions that need
1472 * to stay live until the last HInstruction. This class
1473 * is used as a marker for the baseline compiler to ensure its preceding
1474 * HInstruction stays live. `index` is the temporary number that is used
1475 * for knowing the stack offset where to store the instruction.
1476 */
1477class HTemporary : public HTemplateInstruction<0> {
1478 public:
1479 explicit HTemporary(size_t index) : index_(index) {}
1480
1481 size_t GetIndex() const { return index_; }
1482
1483 DECLARE_INSTRUCTION(Temporary);
1484
1485 private:
1486 const size_t index_;
1487
1488 DISALLOW_COPY_AND_ASSIGN(HTemporary);
1489};
1490
Nicolas Geoffray4e3d23a2014-05-22 18:32:45 +01001491class MoveOperands : public ArenaObject {
1492 public:
1493 MoveOperands(Location source, Location destination)
1494 : source_(source), destination_(destination) {}
1495
1496 Location GetSource() const { return source_; }
1497 Location GetDestination() const { return destination_; }
1498
1499 void SetSource(Location value) { source_ = value; }
1500 void SetDestination(Location value) { destination_ = value; }
1501
1502 // The parallel move resolver marks moves as "in-progress" by clearing the
1503 // destination (but not the source).
1504 Location MarkPending() {
1505 DCHECK(!IsPending());
1506 Location dest = destination_;
1507 destination_ = Location::NoLocation();
1508 return dest;
1509 }
1510
1511 void ClearPending(Location dest) {
1512 DCHECK(IsPending());
1513 destination_ = dest;
1514 }
1515
1516 bool IsPending() const {
1517 DCHECK(!source_.IsInvalid() || destination_.IsInvalid());
1518 return destination_.IsInvalid() && !source_.IsInvalid();
1519 }
1520
1521 // True if this blocks a move from the given location.
1522 bool Blocks(Location loc) const {
1523 return !IsEliminated() && source_.Equals(loc);
1524 }
1525
1526 // A move is redundant if it's been eliminated, if its source and
1527 // destination are the same, or if its destination is unneeded.
1528 bool IsRedundant() const {
1529 return IsEliminated() || destination_.IsInvalid() || source_.Equals(destination_);
1530 }
1531
1532 // We clear both operands to indicate move that's been eliminated.
1533 void Eliminate() {
1534 source_ = destination_ = Location::NoLocation();
1535 }
1536
1537 bool IsEliminated() const {
1538 DCHECK(!source_.IsInvalid() || destination_.IsInvalid());
1539 return source_.IsInvalid();
1540 }
1541
1542 private:
1543 Location source_;
1544 Location destination_;
1545
1546 DISALLOW_COPY_AND_ASSIGN(MoveOperands);
1547};
1548
1549static constexpr size_t kDefaultNumberOfMoves = 4;
1550
1551class HParallelMove : public HTemplateInstruction<0> {
1552 public:
1553 explicit HParallelMove(ArenaAllocator* arena) : moves_(arena, kDefaultNumberOfMoves) {}
1554
1555 void AddMove(MoveOperands* move) {
1556 moves_.Add(move);
1557 }
1558
1559 MoveOperands* MoveOperandsAt(size_t index) const {
1560 return moves_.Get(index);
1561 }
1562
1563 size_t NumMoves() const { return moves_.Size(); }
1564
Nicolas Geoffraya7062e02014-05-22 12:50:17 +01001565 DECLARE_INSTRUCTION(ParallelMove);
Nicolas Geoffray4e3d23a2014-05-22 18:32:45 +01001566
1567 private:
1568 GrowableArray<MoveOperands*> moves_;
1569
1570 DISALLOW_COPY_AND_ASSIGN(HParallelMove);
1571};
1572
Nicolas Geoffray818f2102014-02-18 16:43:35 +00001573class HGraphVisitor : public ValueObject {
1574 public:
Dave Allison20dfc792014-06-16 20:44:29 -07001575 explicit HGraphVisitor(HGraph* graph) : graph_(graph) {}
1576 virtual ~HGraphVisitor() {}
Nicolas Geoffray818f2102014-02-18 16:43:35 +00001577
Dave Allison20dfc792014-06-16 20:44:29 -07001578 virtual void VisitInstruction(HInstruction* instruction) {}
Nicolas Geoffray818f2102014-02-18 16:43:35 +00001579 virtual void VisitBasicBlock(HBasicBlock* block);
1580
1581 void VisitInsertionOrder();
1582
Nicolas Geoffray787c3072014-03-17 10:20:19 +00001583 HGraph* GetGraph() const { return graph_; }
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +00001584
Nicolas Geoffray818f2102014-02-18 16:43:35 +00001585 // Visit functions for instruction classes.
1586#define DECLARE_VISIT_INSTRUCTION(name) \
1587 virtual void Visit##name(H##name* instr) { VisitInstruction(instr); }
1588
1589 FOR_EACH_INSTRUCTION(DECLARE_VISIT_INSTRUCTION)
1590
1591#undef DECLARE_VISIT_INSTRUCTION
1592
1593 private:
1594 HGraph* graph_;
1595
1596 DISALLOW_COPY_AND_ASSIGN(HGraphVisitor);
1597};
1598
Nicolas Geoffray804d0932014-05-02 08:46:00 +01001599class HInsertionOrderIterator : public ValueObject {
1600 public:
1601 explicit HInsertionOrderIterator(const HGraph& graph) : graph_(graph), index_(0) {}
1602
1603 bool Done() const { return index_ == graph_.GetBlocks().Size(); }
1604 HBasicBlock* Current() const { return graph_.GetBlocks().Get(index_); }
1605 void Advance() { ++index_; }
1606
1607 private:
1608 const HGraph& graph_;
1609 size_t index_;
1610
1611 DISALLOW_COPY_AND_ASSIGN(HInsertionOrderIterator);
1612};
1613
Nicolas Geoffray622d9c32014-05-12 16:11:02 +01001614class HReversePostOrderIterator : public ValueObject {
Nicolas Geoffray804d0932014-05-02 08:46:00 +01001615 public:
Nicolas Geoffray622d9c32014-05-12 16:11:02 +01001616 explicit HReversePostOrderIterator(const HGraph& graph) : graph_(graph), index_(0) {}
Nicolas Geoffray804d0932014-05-02 08:46:00 +01001617
Nicolas Geoffray622d9c32014-05-12 16:11:02 +01001618 bool Done() const { return index_ == graph_.GetReversePostOrder().Size(); }
1619 HBasicBlock* Current() const { return graph_.GetReversePostOrder().Get(index_); }
Nicolas Geoffray804d0932014-05-02 08:46:00 +01001620 void Advance() { ++index_; }
1621
1622 private:
1623 const HGraph& graph_;
1624 size_t index_;
1625
Nicolas Geoffray622d9c32014-05-12 16:11:02 +01001626 DISALLOW_COPY_AND_ASSIGN(HReversePostOrderIterator);
Nicolas Geoffray804d0932014-05-02 08:46:00 +01001627};
1628
Nicolas Geoffray622d9c32014-05-12 16:11:02 +01001629class HPostOrderIterator : public ValueObject {
Nicolas Geoffray804d0932014-05-02 08:46:00 +01001630 public:
Nicolas Geoffray622d9c32014-05-12 16:11:02 +01001631 explicit HPostOrderIterator(const HGraph& graph)
1632 : graph_(graph), index_(graph_.GetReversePostOrder().Size()) {}
Nicolas Geoffray804d0932014-05-02 08:46:00 +01001633
1634 bool Done() const { return index_ == 0; }
Nicolas Geoffray622d9c32014-05-12 16:11:02 +01001635 HBasicBlock* Current() const { return graph_.GetReversePostOrder().Get(index_ - 1); }
Nicolas Geoffray804d0932014-05-02 08:46:00 +01001636 void Advance() { --index_; }
1637
1638 private:
1639 const HGraph& graph_;
1640 size_t index_;
1641
Nicolas Geoffray622d9c32014-05-12 16:11:02 +01001642 DISALLOW_COPY_AND_ASSIGN(HPostOrderIterator);
Nicolas Geoffray804d0932014-05-02 08:46:00 +01001643};
1644
Nicolas Geoffray818f2102014-02-18 16:43:35 +00001645} // namespace art
1646
1647#endif // ART_COMPILER_OPTIMIZING_NODES_H_