blob: 39f2d0e758883d9194b37c9eba079b61a5030938 [file] [log] [blame]
buzbee311ca162013-02-28 15:56:43 -08001/*
2 * Copyright (C) 2013 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
Nicolas Geoffrayf3e2cc42014-02-18 18:37:26 +000017#include "mir_graph.h"
18
19#include <inttypes.h>
20
Ian Rogers6282dc12013-04-18 15:54:02 -070021#include "base/stl_util.h"
buzbee311ca162013-02-28 15:56:43 -080022#include "compiler_internals.h"
buzbee311ca162013-02-28 15:56:43 -080023#include "dex_file-inl.h"
Vladimir Marko5816ed42013-11-27 17:04:20 +000024#include "dex/quick/dex_file_to_method_inliner_map.h"
25#include "dex/quick/dex_file_method_inliner.h"
Nicolas Geoffrayf3e2cc42014-02-18 18:37:26 +000026#include "leb128.h"
Vladimir Marko5816ed42013-11-27 17:04:20 +000027
buzbee311ca162013-02-28 15:56:43 -080028namespace art {
29
30#define MAX_PATTERN_LEN 5
31
buzbee1fd33462013-03-25 13:40:45 -070032const char* MIRGraph::extended_mir_op_names_[kMirOpLast - kMirOpFirst] = {
33 "Phi",
34 "Copy",
35 "FusedCmplFloat",
36 "FusedCmpgFloat",
37 "FusedCmplDouble",
38 "FusedCmpgDouble",
39 "FusedCmpLong",
40 "Nop",
41 "OpNullCheck",
42 "OpRangeCheck",
43 "OpDivZeroCheck",
44 "Check1",
45 "Check2",
46 "Select",
47};
48
buzbee862a7602013-04-05 10:58:54 -070049MIRGraph::MIRGraph(CompilationUnit* cu, ArenaAllocator* arena)
buzbee1fd33462013-03-25 13:40:45 -070050 : reg_location_(NULL),
51 cu_(cu),
buzbee311ca162013-02-28 15:56:43 -080052 ssa_base_vregs_(NULL),
53 ssa_subscripts_(NULL),
buzbee311ca162013-02-28 15:56:43 -080054 vreg_to_ssa_map_(NULL),
55 ssa_last_defs_(NULL),
56 is_constant_v_(NULL),
57 constant_values_(NULL),
buzbee862a7602013-04-05 10:58:54 -070058 use_counts_(arena, 256, kGrowableArrayMisc),
59 raw_use_counts_(arena, 256, kGrowableArrayMisc),
buzbee311ca162013-02-28 15:56:43 -080060 num_reachable_blocks_(0),
buzbee862a7602013-04-05 10:58:54 -070061 dfs_order_(NULL),
62 dfs_post_order_(NULL),
63 dom_post_order_traversal_(NULL),
buzbee311ca162013-02-28 15:56:43 -080064 i_dom_list_(NULL),
65 def_block_matrix_(NULL),
66 temp_block_v_(NULL),
67 temp_dalvik_register_v_(NULL),
68 temp_ssa_register_v_(NULL),
buzbee862a7602013-04-05 10:58:54 -070069 block_list_(arena, 100, kGrowableArrayBlockList),
buzbee311ca162013-02-28 15:56:43 -080070 try_block_addr_(NULL),
71 entry_block_(NULL),
72 exit_block_(NULL),
buzbee311ca162013-02-28 15:56:43 -080073 num_blocks_(0),
74 current_code_item_(NULL),
buzbeeb48819d2013-09-14 16:15:25 -070075 dex_pc_to_block_map_(arena, 0, kGrowableArrayMisc),
buzbee311ca162013-02-28 15:56:43 -080076 current_method_(kInvalidEntry),
77 current_offset_(kInvalidEntry),
78 def_count_(0),
79 opcode_count_(NULL),
buzbee1fd33462013-03-25 13:40:45 -070080 num_ssa_regs_(0),
81 method_sreg_(0),
buzbee862a7602013-04-05 10:58:54 -070082 attributes_(METHOD_IS_LEAF), // Start with leaf assumption, change on encountering invoke.
83 checkstats_(NULL),
buzbeeb48819d2013-09-14 16:15:25 -070084 arena_(arena),
85 backward_branches_(0),
Razvan A Lupusoruda7a69b2014-01-08 15:09:50 -080086 forward_branches_(0),
87 compiler_temps_(arena, 6, kGrowableArrayMisc),
88 num_non_special_compiler_temps_(0),
Vladimir Marko7f6cf562014-01-29 10:31:55 +000089 max_available_non_special_compiler_temps_(0),
90 ifield_annotations_(arena, 0u),
91 sfield_annotations_(arena, 0u) {
buzbee862a7602013-04-05 10:58:54 -070092 try_block_addr_ = new (arena_) ArenaBitVector(arena_, 0, true /* expandable */);
Razvan A Lupusoruda7a69b2014-01-08 15:09:50 -080093 max_available_special_compiler_temps_ = std::abs(static_cast<int>(kVRegNonSpecialTempBaseReg))
94 - std::abs(static_cast<int>(kVRegTempBaseReg));
buzbee311ca162013-02-28 15:56:43 -080095}
96
Ian Rogers6282dc12013-04-18 15:54:02 -070097MIRGraph::~MIRGraph() {
98 STLDeleteElements(&m_units_);
99}
100
buzbee311ca162013-02-28 15:56:43 -0800101/*
102 * Parse an instruction, return the length of the instruction
103 */
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700104int MIRGraph::ParseInsn(const uint16_t* code_ptr, DecodedInstruction* decoded_instruction) {
buzbee311ca162013-02-28 15:56:43 -0800105 const Instruction* instruction = Instruction::At(code_ptr);
106 *decoded_instruction = DecodedInstruction(instruction);
107
108 return instruction->SizeInCodeUnits();
109}
110
111
112/* Split an existing block from the specified code offset into two */
buzbee0d829482013-10-11 15:24:55 -0700113BasicBlock* MIRGraph::SplitBlock(DexOffset code_offset,
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700114 BasicBlock* orig_block, BasicBlock** immed_pred_block_p) {
buzbee0d829482013-10-11 15:24:55 -0700115 DCHECK_GT(code_offset, orig_block->start_offset);
buzbee311ca162013-02-28 15:56:43 -0800116 MIR* insn = orig_block->first_mir_insn;
buzbee0d829482013-10-11 15:24:55 -0700117 MIR* prev = NULL;
buzbee311ca162013-02-28 15:56:43 -0800118 while (insn) {
119 if (insn->offset == code_offset) break;
buzbee0d829482013-10-11 15:24:55 -0700120 prev = insn;
buzbee311ca162013-02-28 15:56:43 -0800121 insn = insn->next;
122 }
123 if (insn == NULL) {
124 LOG(FATAL) << "Break split failed";
125 }
buzbee862a7602013-04-05 10:58:54 -0700126 BasicBlock *bottom_block = NewMemBB(kDalvikByteCode, num_blocks_++);
127 block_list_.Insert(bottom_block);
buzbee311ca162013-02-28 15:56:43 -0800128
129 bottom_block->start_offset = code_offset;
130 bottom_block->first_mir_insn = insn;
131 bottom_block->last_mir_insn = orig_block->last_mir_insn;
132
133 /* If this block was terminated by a return, the flag needs to go with the bottom block */
134 bottom_block->terminated_by_return = orig_block->terminated_by_return;
135 orig_block->terminated_by_return = false;
136
buzbee311ca162013-02-28 15:56:43 -0800137 /* Handle the taken path */
138 bottom_block->taken = orig_block->taken;
buzbee0d829482013-10-11 15:24:55 -0700139 if (bottom_block->taken != NullBasicBlockId) {
140 orig_block->taken = NullBasicBlockId;
141 BasicBlock* bb_taken = GetBasicBlock(bottom_block->taken);
142 bb_taken->predecessors->Delete(orig_block->id);
143 bb_taken->predecessors->Insert(bottom_block->id);
buzbee311ca162013-02-28 15:56:43 -0800144 }
145
146 /* Handle the fallthrough path */
147 bottom_block->fall_through = orig_block->fall_through;
buzbee0d829482013-10-11 15:24:55 -0700148 orig_block->fall_through = bottom_block->id;
149 bottom_block->predecessors->Insert(orig_block->id);
150 if (bottom_block->fall_through != NullBasicBlockId) {
151 BasicBlock* bb_fall_through = GetBasicBlock(bottom_block->fall_through);
152 bb_fall_through->predecessors->Delete(orig_block->id);
153 bb_fall_through->predecessors->Insert(bottom_block->id);
buzbee311ca162013-02-28 15:56:43 -0800154 }
155
156 /* Handle the successor list */
buzbee0d829482013-10-11 15:24:55 -0700157 if (orig_block->successor_block_list_type != kNotUsed) {
158 bottom_block->successor_block_list_type = orig_block->successor_block_list_type;
159 bottom_block->successor_blocks = orig_block->successor_blocks;
160 orig_block->successor_block_list_type = kNotUsed;
161 orig_block->successor_blocks = NULL;
162 GrowableArray<SuccessorBlockInfo*>::Iterator iterator(bottom_block->successor_blocks);
buzbee311ca162013-02-28 15:56:43 -0800163 while (true) {
buzbee862a7602013-04-05 10:58:54 -0700164 SuccessorBlockInfo *successor_block_info = iterator.Next();
buzbee311ca162013-02-28 15:56:43 -0800165 if (successor_block_info == NULL) break;
buzbee0d829482013-10-11 15:24:55 -0700166 BasicBlock *bb = GetBasicBlock(successor_block_info->block);
167 bb->predecessors->Delete(orig_block->id);
168 bb->predecessors->Insert(bottom_block->id);
buzbee311ca162013-02-28 15:56:43 -0800169 }
170 }
171
buzbee0d829482013-10-11 15:24:55 -0700172 orig_block->last_mir_insn = prev;
173 prev->next = NULL;
buzbee311ca162013-02-28 15:56:43 -0800174
buzbee311ca162013-02-28 15:56:43 -0800175 /*
176 * Update the immediate predecessor block pointer so that outgoing edges
177 * can be applied to the proper block.
178 */
179 if (immed_pred_block_p) {
180 DCHECK_EQ(*immed_pred_block_p, orig_block);
181 *immed_pred_block_p = bottom_block;
182 }
buzbeeb48819d2013-09-14 16:15:25 -0700183
184 // Associate dex instructions in the bottom block with the new container.
Vladimir Marko4376c872014-01-23 12:39:29 +0000185 DCHECK(insn != nullptr);
186 DCHECK(insn != orig_block->first_mir_insn);
187 DCHECK(insn == bottom_block->first_mir_insn);
188 DCHECK_EQ(insn->offset, bottom_block->start_offset);
189 DCHECK(static_cast<int>(insn->dalvikInsn.opcode) == kMirOpCheck ||
190 !IsPseudoMirOp(insn->dalvikInsn.opcode));
191 DCHECK_EQ(dex_pc_to_block_map_.Get(insn->offset), orig_block->id);
192 MIR* p = insn;
193 dex_pc_to_block_map_.Put(p->offset, bottom_block->id);
194 while (p != bottom_block->last_mir_insn) {
195 p = p->next;
196 DCHECK(p != nullptr);
buzbeeb48819d2013-09-14 16:15:25 -0700197 int opcode = p->dalvikInsn.opcode;
198 /*
199 * Some messiness here to ensure that we only enter real opcodes and only the
200 * first half of a potentially throwing instruction that has been split into
Vladimir Marko4376c872014-01-23 12:39:29 +0000201 * CHECK and work portions. Since the 2nd half of a split operation is always
202 * the first in a BasicBlock, we can't hit it here.
buzbeeb48819d2013-09-14 16:15:25 -0700203 */
Vladimir Marko4376c872014-01-23 12:39:29 +0000204 if ((opcode == kMirOpCheck) || !IsPseudoMirOp(opcode)) {
205 DCHECK_EQ(dex_pc_to_block_map_.Get(p->offset), orig_block->id);
buzbeeb48819d2013-09-14 16:15:25 -0700206 dex_pc_to_block_map_.Put(p->offset, bottom_block->id);
207 }
buzbeeb48819d2013-09-14 16:15:25 -0700208 }
209
buzbee311ca162013-02-28 15:56:43 -0800210 return bottom_block;
211}
212
213/*
214 * Given a code offset, find out the block that starts with it. If the offset
215 * is in the middle of an existing block, split it into two. If immed_pred_block_p
216 * is not non-null and is the block being split, update *immed_pred_block_p to
217 * point to the bottom block so that outgoing edges can be set up properly
218 * (by the caller)
219 * Utilizes a map for fast lookup of the typical cases.
220 */
buzbee0d829482013-10-11 15:24:55 -0700221BasicBlock* MIRGraph::FindBlock(DexOffset code_offset, bool split, bool create,
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700222 BasicBlock** immed_pred_block_p) {
buzbeebd663de2013-09-10 15:41:31 -0700223 if (code_offset >= cu_->code_item->insns_size_in_code_units_) {
buzbee311ca162013-02-28 15:56:43 -0800224 return NULL;
225 }
buzbeeb48819d2013-09-14 16:15:25 -0700226
227 int block_id = dex_pc_to_block_map_.Get(code_offset);
228 BasicBlock* bb = (block_id == 0) ? NULL : block_list_.Get(block_id);
229
230 if ((bb != NULL) && (bb->start_offset == code_offset)) {
231 // Does this containing block start with the desired instruction?
buzbeebd663de2013-09-10 15:41:31 -0700232 return bb;
233 }
buzbee311ca162013-02-28 15:56:43 -0800234
buzbeeb48819d2013-09-14 16:15:25 -0700235 // No direct hit.
236 if (!create) {
237 return NULL;
buzbee311ca162013-02-28 15:56:43 -0800238 }
239
buzbeeb48819d2013-09-14 16:15:25 -0700240 if (bb != NULL) {
241 // The target exists somewhere in an existing block.
242 return SplitBlock(code_offset, bb, bb == *immed_pred_block_p ? immed_pred_block_p : NULL);
243 }
244
245 // Create a new block.
buzbee862a7602013-04-05 10:58:54 -0700246 bb = NewMemBB(kDalvikByteCode, num_blocks_++);
247 block_list_.Insert(bb);
buzbee311ca162013-02-28 15:56:43 -0800248 bb->start_offset = code_offset;
buzbeeb48819d2013-09-14 16:15:25 -0700249 dex_pc_to_block_map_.Put(bb->start_offset, bb->id);
buzbee311ca162013-02-28 15:56:43 -0800250 return bb;
251}
252
buzbeeb48819d2013-09-14 16:15:25 -0700253
buzbee311ca162013-02-28 15:56:43 -0800254/* Identify code range in try blocks and set up the empty catch blocks */
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700255void MIRGraph::ProcessTryCatchBlocks() {
buzbee311ca162013-02-28 15:56:43 -0800256 int tries_size = current_code_item_->tries_size_;
buzbee0d829482013-10-11 15:24:55 -0700257 DexOffset offset;
buzbee311ca162013-02-28 15:56:43 -0800258
259 if (tries_size == 0) {
260 return;
261 }
262
263 for (int i = 0; i < tries_size; i++) {
264 const DexFile::TryItem* pTry =
265 DexFile::GetTryItems(*current_code_item_, i);
buzbee0d829482013-10-11 15:24:55 -0700266 DexOffset start_offset = pTry->start_addr_;
267 DexOffset end_offset = start_offset + pTry->insn_count_;
buzbee311ca162013-02-28 15:56:43 -0800268 for (offset = start_offset; offset < end_offset; offset++) {
buzbee862a7602013-04-05 10:58:54 -0700269 try_block_addr_->SetBit(offset);
buzbee311ca162013-02-28 15:56:43 -0800270 }
271 }
272
273 // Iterate over each of the handlers to enqueue the empty Catch blocks
274 const byte* handlers_ptr = DexFile::GetCatchHandlerData(*current_code_item_, 0);
275 uint32_t handlers_size = DecodeUnsignedLeb128(&handlers_ptr);
276 for (uint32_t idx = 0; idx < handlers_size; idx++) {
277 CatchHandlerIterator iterator(handlers_ptr);
278 for (; iterator.HasNext(); iterator.Next()) {
279 uint32_t address = iterator.GetHandlerAddress();
280 FindBlock(address, false /* split */, true /*create*/,
281 /* immed_pred_block_p */ NULL);
282 }
283 handlers_ptr = iterator.EndDataPointer();
284 }
285}
286
287/* Process instructions with the kBranch flag */
buzbee0d829482013-10-11 15:24:55 -0700288BasicBlock* MIRGraph::ProcessCanBranch(BasicBlock* cur_block, MIR* insn, DexOffset cur_offset,
289 int width, int flags, const uint16_t* code_ptr,
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700290 const uint16_t* code_end) {
buzbee0d829482013-10-11 15:24:55 -0700291 DexOffset target = cur_offset;
buzbee311ca162013-02-28 15:56:43 -0800292 switch (insn->dalvikInsn.opcode) {
293 case Instruction::GOTO:
294 case Instruction::GOTO_16:
295 case Instruction::GOTO_32:
296 target += insn->dalvikInsn.vA;
297 break;
298 case Instruction::IF_EQ:
299 case Instruction::IF_NE:
300 case Instruction::IF_LT:
301 case Instruction::IF_GE:
302 case Instruction::IF_GT:
303 case Instruction::IF_LE:
304 cur_block->conditional_branch = true;
305 target += insn->dalvikInsn.vC;
306 break;
307 case Instruction::IF_EQZ:
308 case Instruction::IF_NEZ:
309 case Instruction::IF_LTZ:
310 case Instruction::IF_GEZ:
311 case Instruction::IF_GTZ:
312 case Instruction::IF_LEZ:
313 cur_block->conditional_branch = true;
314 target += insn->dalvikInsn.vB;
315 break;
316 default:
317 LOG(FATAL) << "Unexpected opcode(" << insn->dalvikInsn.opcode << ") with kBranch set";
318 }
buzbeeb48819d2013-09-14 16:15:25 -0700319 CountBranch(target);
buzbee311ca162013-02-28 15:56:43 -0800320 BasicBlock *taken_block = FindBlock(target, /* split */ true, /* create */ true,
321 /* immed_pred_block_p */ &cur_block);
buzbee0d829482013-10-11 15:24:55 -0700322 cur_block->taken = taken_block->id;
323 taken_block->predecessors->Insert(cur_block->id);
buzbee311ca162013-02-28 15:56:43 -0800324
325 /* Always terminate the current block for conditional branches */
326 if (flags & Instruction::kContinue) {
327 BasicBlock *fallthrough_block = FindBlock(cur_offset + width,
328 /*
329 * If the method is processed
330 * in sequential order from the
331 * beginning, we don't need to
332 * specify split for continue
333 * blocks. However, this
334 * routine can be called by
335 * compileLoop, which starts
336 * parsing the method from an
337 * arbitrary address in the
338 * method body.
339 */
340 true,
341 /* create */
342 true,
343 /* immed_pred_block_p */
344 &cur_block);
buzbee0d829482013-10-11 15:24:55 -0700345 cur_block->fall_through = fallthrough_block->id;
346 fallthrough_block->predecessors->Insert(cur_block->id);
buzbee311ca162013-02-28 15:56:43 -0800347 } else if (code_ptr < code_end) {
buzbee27247762013-07-28 12:03:58 -0700348 FindBlock(cur_offset + width, /* split */ false, /* create */ true,
buzbee311ca162013-02-28 15:56:43 -0800349 /* immed_pred_block_p */ NULL);
buzbee311ca162013-02-28 15:56:43 -0800350 }
351 return cur_block;
352}
353
354/* Process instructions with the kSwitch flag */
buzbee17189ac2013-11-08 11:07:02 -0800355BasicBlock* MIRGraph::ProcessCanSwitch(BasicBlock* cur_block, MIR* insn, DexOffset cur_offset,
356 int width, int flags) {
buzbee311ca162013-02-28 15:56:43 -0800357 const uint16_t* switch_data =
358 reinterpret_cast<const uint16_t*>(GetCurrentInsns() + cur_offset + insn->dalvikInsn.vB);
359 int size;
360 const int* keyTable;
361 const int* target_table;
362 int i;
363 int first_key;
364
365 /*
366 * Packed switch data format:
367 * ushort ident = 0x0100 magic value
368 * ushort size number of entries in the table
369 * int first_key first (and lowest) switch case value
370 * int targets[size] branch targets, relative to switch opcode
371 *
372 * Total size is (4+size*2) 16-bit code units.
373 */
374 if (insn->dalvikInsn.opcode == Instruction::PACKED_SWITCH) {
375 DCHECK_EQ(static_cast<int>(switch_data[0]),
376 static_cast<int>(Instruction::kPackedSwitchSignature));
377 size = switch_data[1];
378 first_key = switch_data[2] | (switch_data[3] << 16);
379 target_table = reinterpret_cast<const int*>(&switch_data[4]);
380 keyTable = NULL; // Make the compiler happy
381 /*
382 * Sparse switch data format:
383 * ushort ident = 0x0200 magic value
384 * ushort size number of entries in the table; > 0
385 * int keys[size] keys, sorted low-to-high; 32-bit aligned
386 * int targets[size] branch targets, relative to switch opcode
387 *
388 * Total size is (2+size*4) 16-bit code units.
389 */
390 } else {
391 DCHECK_EQ(static_cast<int>(switch_data[0]),
392 static_cast<int>(Instruction::kSparseSwitchSignature));
393 size = switch_data[1];
394 keyTable = reinterpret_cast<const int*>(&switch_data[2]);
395 target_table = reinterpret_cast<const int*>(&switch_data[2 + size*2]);
396 first_key = 0; // To make the compiler happy
397 }
398
buzbee0d829482013-10-11 15:24:55 -0700399 if (cur_block->successor_block_list_type != kNotUsed) {
buzbee311ca162013-02-28 15:56:43 -0800400 LOG(FATAL) << "Successor block list already in use: "
buzbee0d829482013-10-11 15:24:55 -0700401 << static_cast<int>(cur_block->successor_block_list_type);
buzbee311ca162013-02-28 15:56:43 -0800402 }
buzbee0d829482013-10-11 15:24:55 -0700403 cur_block->successor_block_list_type =
404 (insn->dalvikInsn.opcode == Instruction::PACKED_SWITCH) ? kPackedSwitch : kSparseSwitch;
405 cur_block->successor_blocks =
Brian Carlstromdf629502013-07-17 22:39:56 -0700406 new (arena_) GrowableArray<SuccessorBlockInfo*>(arena_, size, kGrowableArraySuccessorBlocks);
buzbee311ca162013-02-28 15:56:43 -0800407
408 for (i = 0; i < size; i++) {
409 BasicBlock *case_block = FindBlock(cur_offset + target_table[i], /* split */ true,
410 /* create */ true, /* immed_pred_block_p */ &cur_block);
411 SuccessorBlockInfo *successor_block_info =
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -0700412 static_cast<SuccessorBlockInfo*>(arena_->Alloc(sizeof(SuccessorBlockInfo),
413 ArenaAllocator::kAllocSuccessor));
buzbee0d829482013-10-11 15:24:55 -0700414 successor_block_info->block = case_block->id;
buzbee311ca162013-02-28 15:56:43 -0800415 successor_block_info->key =
416 (insn->dalvikInsn.opcode == Instruction::PACKED_SWITCH) ?
417 first_key + i : keyTable[i];
buzbee0d829482013-10-11 15:24:55 -0700418 cur_block->successor_blocks->Insert(successor_block_info);
419 case_block->predecessors->Insert(cur_block->id);
buzbee311ca162013-02-28 15:56:43 -0800420 }
421
422 /* Fall-through case */
Brian Carlstromdf629502013-07-17 22:39:56 -0700423 BasicBlock* fallthrough_block = FindBlock(cur_offset + width, /* split */ false,
424 /* create */ true, /* immed_pred_block_p */ NULL);
buzbee0d829482013-10-11 15:24:55 -0700425 cur_block->fall_through = fallthrough_block->id;
426 fallthrough_block->predecessors->Insert(cur_block->id);
buzbee17189ac2013-11-08 11:07:02 -0800427 return cur_block;
buzbee311ca162013-02-28 15:56:43 -0800428}
429
430/* Process instructions with the kThrow flag */
buzbee0d829482013-10-11 15:24:55 -0700431BasicBlock* MIRGraph::ProcessCanThrow(BasicBlock* cur_block, MIR* insn, DexOffset cur_offset,
432 int width, int flags, ArenaBitVector* try_block_addr,
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700433 const uint16_t* code_ptr, const uint16_t* code_end) {
buzbee862a7602013-04-05 10:58:54 -0700434 bool in_try_block = try_block_addr->IsBitSet(cur_offset);
buzbee17189ac2013-11-08 11:07:02 -0800435 bool is_throw = (insn->dalvikInsn.opcode == Instruction::THROW);
436 bool build_all_edges =
437 (cu_->disable_opt & (1 << kSuppressExceptionEdges)) || is_throw || in_try_block;
buzbee311ca162013-02-28 15:56:43 -0800438
439 /* In try block */
440 if (in_try_block) {
441 CatchHandlerIterator iterator(*current_code_item_, cur_offset);
442
buzbee0d829482013-10-11 15:24:55 -0700443 if (cur_block->successor_block_list_type != kNotUsed) {
buzbee311ca162013-02-28 15:56:43 -0800444 LOG(INFO) << PrettyMethod(cu_->method_idx, *cu_->dex_file);
445 LOG(FATAL) << "Successor block list already in use: "
buzbee0d829482013-10-11 15:24:55 -0700446 << static_cast<int>(cur_block->successor_block_list_type);
buzbee311ca162013-02-28 15:56:43 -0800447 }
448
buzbee0d829482013-10-11 15:24:55 -0700449 cur_block->successor_block_list_type = kCatch;
450 cur_block->successor_blocks =
buzbee862a7602013-04-05 10:58:54 -0700451 new (arena_) GrowableArray<SuccessorBlockInfo*>(arena_, 2, kGrowableArraySuccessorBlocks);
buzbee311ca162013-02-28 15:56:43 -0800452
Brian Carlstrom02c8cc62013-07-18 15:54:44 -0700453 for (; iterator.HasNext(); iterator.Next()) {
buzbee311ca162013-02-28 15:56:43 -0800454 BasicBlock *catch_block = FindBlock(iterator.GetHandlerAddress(), false /* split*/,
455 false /* creat */, NULL /* immed_pred_block_p */);
456 catch_block->catch_entry = true;
457 if (kIsDebugBuild) {
458 catches_.insert(catch_block->start_offset);
459 }
460 SuccessorBlockInfo *successor_block_info = reinterpret_cast<SuccessorBlockInfo*>
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -0700461 (arena_->Alloc(sizeof(SuccessorBlockInfo), ArenaAllocator::kAllocSuccessor));
buzbee0d829482013-10-11 15:24:55 -0700462 successor_block_info->block = catch_block->id;
buzbee311ca162013-02-28 15:56:43 -0800463 successor_block_info->key = iterator.GetHandlerTypeIndex();
buzbee0d829482013-10-11 15:24:55 -0700464 cur_block->successor_blocks->Insert(successor_block_info);
465 catch_block->predecessors->Insert(cur_block->id);
buzbee311ca162013-02-28 15:56:43 -0800466 }
buzbee17189ac2013-11-08 11:07:02 -0800467 } else if (build_all_edges) {
buzbee862a7602013-04-05 10:58:54 -0700468 BasicBlock *eh_block = NewMemBB(kExceptionHandling, num_blocks_++);
buzbee0d829482013-10-11 15:24:55 -0700469 cur_block->taken = eh_block->id;
buzbee862a7602013-04-05 10:58:54 -0700470 block_list_.Insert(eh_block);
buzbee311ca162013-02-28 15:56:43 -0800471 eh_block->start_offset = cur_offset;
buzbee0d829482013-10-11 15:24:55 -0700472 eh_block->predecessors->Insert(cur_block->id);
buzbee311ca162013-02-28 15:56:43 -0800473 }
474
buzbee17189ac2013-11-08 11:07:02 -0800475 if (is_throw) {
buzbee311ca162013-02-28 15:56:43 -0800476 cur_block->explicit_throw = true;
buzbee27247762013-07-28 12:03:58 -0700477 if (code_ptr < code_end) {
buzbee311ca162013-02-28 15:56:43 -0800478 // Force creation of new block following THROW via side-effect
479 FindBlock(cur_offset + width, /* split */ false, /* create */ true,
480 /* immed_pred_block_p */ NULL);
481 }
482 if (!in_try_block) {
483 // Don't split a THROW that can't rethrow - we're done.
484 return cur_block;
485 }
486 }
487
buzbee17189ac2013-11-08 11:07:02 -0800488 if (!build_all_edges) {
489 /*
490 * Even though there is an exception edge here, control cannot return to this
491 * method. Thus, for the purposes of dataflow analysis and optimization, we can
492 * ignore the edge. Doing this reduces compile time, and increases the scope
493 * of the basic-block level optimization pass.
494 */
495 return cur_block;
496 }
497
buzbee311ca162013-02-28 15:56:43 -0800498 /*
499 * Split the potentially-throwing instruction into two parts.
500 * The first half will be a pseudo-op that captures the exception
501 * edges and terminates the basic block. It always falls through.
502 * Then, create a new basic block that begins with the throwing instruction
503 * (minus exceptions). Note: this new basic block must NOT be entered into
504 * the block_map. If the potentially-throwing instruction is the target of a
505 * future branch, we need to find the check psuedo half. The new
506 * basic block containing the work portion of the instruction should
507 * only be entered via fallthrough from the block containing the
508 * pseudo exception edge MIR. Note also that this new block is
509 * not automatically terminated after the work portion, and may
510 * contain following instructions.
buzbeeb48819d2013-09-14 16:15:25 -0700511 *
512 * Note also that the dex_pc_to_block_map_ entry for the potentially
513 * throwing instruction will refer to the original basic block.
buzbee311ca162013-02-28 15:56:43 -0800514 */
buzbee862a7602013-04-05 10:58:54 -0700515 BasicBlock *new_block = NewMemBB(kDalvikByteCode, num_blocks_++);
516 block_list_.Insert(new_block);
buzbee311ca162013-02-28 15:56:43 -0800517 new_block->start_offset = insn->offset;
buzbee0d829482013-10-11 15:24:55 -0700518 cur_block->fall_through = new_block->id;
519 new_block->predecessors->Insert(cur_block->id);
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -0700520 MIR* new_insn = static_cast<MIR*>(arena_->Alloc(sizeof(MIR), ArenaAllocator::kAllocMIR));
buzbee311ca162013-02-28 15:56:43 -0800521 *new_insn = *insn;
522 insn->dalvikInsn.opcode =
523 static_cast<Instruction::Code>(kMirOpCheck);
524 // Associate the two halves
525 insn->meta.throw_insn = new_insn;
buzbee311ca162013-02-28 15:56:43 -0800526 AppendMIR(new_block, new_insn);
527 return new_block;
528}
529
530/* Parse a Dex method and insert it into the MIRGraph at the current insert point. */
531void MIRGraph::InlineMethod(const DexFile::CodeItem* code_item, uint32_t access_flags,
Ian Rogers8b2c0b92013-09-19 02:56:49 -0700532 InvokeType invoke_type, uint16_t class_def_idx,
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700533 uint32_t method_idx, jobject class_loader, const DexFile& dex_file) {
buzbee311ca162013-02-28 15:56:43 -0800534 current_code_item_ = code_item;
535 method_stack_.push_back(std::make_pair(current_method_, current_offset_));
536 current_method_ = m_units_.size();
537 current_offset_ = 0;
538 // TODO: will need to snapshot stack image and use that as the mir context identification.
539 m_units_.push_back(new DexCompilationUnit(cu_, class_loader, Runtime::Current()->GetClassLinker(),
Vladimir Marko2730db02014-01-27 11:15:17 +0000540 dex_file, current_code_item_, class_def_idx, method_idx, access_flags,
541 cu_->compiler_driver->GetVerifiedMethod(&dex_file, method_idx)));
buzbee311ca162013-02-28 15:56:43 -0800542 const uint16_t* code_ptr = current_code_item_->insns_;
543 const uint16_t* code_end =
544 current_code_item_->insns_ + current_code_item_->insns_size_in_code_units_;
545
546 // TODO: need to rework expansion of block list & try_block_addr when inlining activated.
buzbeeb48819d2013-09-14 16:15:25 -0700547 // TUNING: use better estimate of basic blocks for following resize.
buzbee862a7602013-04-05 10:58:54 -0700548 block_list_.Resize(block_list_.Size() + current_code_item_->insns_size_in_code_units_);
buzbeeb48819d2013-09-14 16:15:25 -0700549 dex_pc_to_block_map_.SetSize(dex_pc_to_block_map_.Size() + current_code_item_->insns_size_in_code_units_);
buzbeebd663de2013-09-10 15:41:31 -0700550
buzbee311ca162013-02-28 15:56:43 -0800551 // TODO: replace with explicit resize routine. Using automatic extension side effect for now.
buzbee862a7602013-04-05 10:58:54 -0700552 try_block_addr_->SetBit(current_code_item_->insns_size_in_code_units_);
553 try_block_addr_->ClearBit(current_code_item_->insns_size_in_code_units_);
buzbee311ca162013-02-28 15:56:43 -0800554
555 // If this is the first method, set up default entry and exit blocks.
556 if (current_method_ == 0) {
557 DCHECK(entry_block_ == NULL);
558 DCHECK(exit_block_ == NULL);
Brian Carlstrom42748892013-07-18 18:04:08 -0700559 DCHECK_EQ(num_blocks_, 0);
buzbee0d829482013-10-11 15:24:55 -0700560 // Use id 0 to represent a null block.
561 BasicBlock* null_block = NewMemBB(kNullBlock, num_blocks_++);
562 DCHECK_EQ(null_block->id, NullBasicBlockId);
563 null_block->hidden = true;
564 block_list_.Insert(null_block);
buzbee862a7602013-04-05 10:58:54 -0700565 entry_block_ = NewMemBB(kEntryBlock, num_blocks_++);
buzbee862a7602013-04-05 10:58:54 -0700566 block_list_.Insert(entry_block_);
buzbee0d829482013-10-11 15:24:55 -0700567 exit_block_ = NewMemBB(kExitBlock, num_blocks_++);
buzbee862a7602013-04-05 10:58:54 -0700568 block_list_.Insert(exit_block_);
buzbee311ca162013-02-28 15:56:43 -0800569 // TODO: deprecate all "cu->" fields; move what's left to wherever CompilationUnit is allocated.
570 cu_->dex_file = &dex_file;
571 cu_->class_def_idx = class_def_idx;
572 cu_->method_idx = method_idx;
573 cu_->access_flags = access_flags;
574 cu_->invoke_type = invoke_type;
575 cu_->shorty = dex_file.GetMethodShorty(dex_file.GetMethodId(method_idx));
576 cu_->num_ins = current_code_item_->ins_size_;
577 cu_->num_regs = current_code_item_->registers_size_ - cu_->num_ins;
578 cu_->num_outs = current_code_item_->outs_size_;
579 cu_->num_dalvik_registers = current_code_item_->registers_size_;
580 cu_->insns = current_code_item_->insns_;
581 cu_->code_item = current_code_item_;
582 } else {
583 UNIMPLEMENTED(FATAL) << "Nested inlining not implemented.";
584 /*
585 * Will need to manage storage for ins & outs, push prevous state and update
586 * insert point.
587 */
588 }
589
590 /* Current block to record parsed instructions */
buzbee862a7602013-04-05 10:58:54 -0700591 BasicBlock *cur_block = NewMemBB(kDalvikByteCode, num_blocks_++);
buzbee0d829482013-10-11 15:24:55 -0700592 DCHECK_EQ(current_offset_, 0U);
buzbee311ca162013-02-28 15:56:43 -0800593 cur_block->start_offset = current_offset_;
buzbee862a7602013-04-05 10:58:54 -0700594 block_list_.Insert(cur_block);
buzbee0d829482013-10-11 15:24:55 -0700595 // TODO: for inlining support, insert at the insert point rather than entry block.
596 entry_block_->fall_through = cur_block->id;
597 cur_block->predecessors->Insert(entry_block_->id);
buzbee311ca162013-02-28 15:56:43 -0800598
599 /* Identify code range in try blocks and set up the empty catch blocks */
600 ProcessTryCatchBlocks();
601
buzbee311ca162013-02-28 15:56:43 -0800602 /* Parse all instructions and put them into containing basic blocks */
603 while (code_ptr < code_end) {
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -0700604 MIR *insn = static_cast<MIR *>(arena_->Alloc(sizeof(MIR), ArenaAllocator::kAllocMIR));
buzbee311ca162013-02-28 15:56:43 -0800605 insn->offset = current_offset_;
606 insn->m_unit_index = current_method_;
607 int width = ParseInsn(code_ptr, &insn->dalvikInsn);
608 insn->width = width;
609 Instruction::Code opcode = insn->dalvikInsn.opcode;
610 if (opcode_count_ != NULL) {
611 opcode_count_[static_cast<int>(opcode)]++;
612 }
613
buzbee311ca162013-02-28 15:56:43 -0800614 int flags = Instruction::FlagsOf(insn->dalvikInsn.opcode);
615
buzbee1da1e2f2013-11-15 13:37:01 -0800616 uint64_t df_flags = oat_data_flow_attributes_[insn->dalvikInsn.opcode];
buzbee311ca162013-02-28 15:56:43 -0800617
618 if (df_flags & DF_HAS_DEFS) {
619 def_count_ += (df_flags & DF_A_WIDE) ? 2 : 1;
620 }
621
buzbee1da1e2f2013-11-15 13:37:01 -0800622 if (df_flags & DF_LVN) {
623 cur_block->use_lvn = true; // Run local value numbering on this basic block.
624 }
625
buzbee27247762013-07-28 12:03:58 -0700626 // Check for inline data block signatures
627 if (opcode == Instruction::NOP) {
628 // A simple NOP will have a width of 1 at this point, embedded data NOP > 1.
629 if ((width == 1) && ((current_offset_ & 0x1) == 0x1) && ((code_end - code_ptr) > 1)) {
630 // Could be an aligning nop. If an embedded data NOP follows, treat pair as single unit.
631 uint16_t following_raw_instruction = code_ptr[1];
632 if ((following_raw_instruction == Instruction::kSparseSwitchSignature) ||
633 (following_raw_instruction == Instruction::kPackedSwitchSignature) ||
634 (following_raw_instruction == Instruction::kArrayDataSignature)) {
635 width += Instruction::At(code_ptr + 1)->SizeInCodeUnits();
636 }
637 }
638 if (width == 1) {
639 // It is a simple nop - treat normally.
640 AppendMIR(cur_block, insn);
641 } else {
buzbee0d829482013-10-11 15:24:55 -0700642 DCHECK(cur_block->fall_through == NullBasicBlockId);
643 DCHECK(cur_block->taken == NullBasicBlockId);
buzbee27247762013-07-28 12:03:58 -0700644 // Unreachable instruction, mark for no continuation.
645 flags &= ~Instruction::kContinue;
646 }
647 } else {
648 AppendMIR(cur_block, insn);
649 }
650
buzbeeb48819d2013-09-14 16:15:25 -0700651 // Associate the starting dex_pc for this opcode with its containing basic block.
652 dex_pc_to_block_map_.Put(insn->offset, cur_block->id);
653
buzbee27247762013-07-28 12:03:58 -0700654 code_ptr += width;
655
buzbee311ca162013-02-28 15:56:43 -0800656 if (flags & Instruction::kBranch) {
657 cur_block = ProcessCanBranch(cur_block, insn, current_offset_,
658 width, flags, code_ptr, code_end);
659 } else if (flags & Instruction::kReturn) {
660 cur_block->terminated_by_return = true;
buzbee0d829482013-10-11 15:24:55 -0700661 cur_block->fall_through = exit_block_->id;
662 exit_block_->predecessors->Insert(cur_block->id);
buzbee311ca162013-02-28 15:56:43 -0800663 /*
664 * Terminate the current block if there are instructions
665 * afterwards.
666 */
667 if (code_ptr < code_end) {
668 /*
669 * Create a fallthrough block for real instructions
670 * (incl. NOP).
671 */
buzbee27247762013-07-28 12:03:58 -0700672 FindBlock(current_offset_ + width, /* split */ false, /* create */ true,
673 /* immed_pred_block_p */ NULL);
buzbee311ca162013-02-28 15:56:43 -0800674 }
675 } else if (flags & Instruction::kThrow) {
676 cur_block = ProcessCanThrow(cur_block, insn, current_offset_, width, flags, try_block_addr_,
677 code_ptr, code_end);
678 } else if (flags & Instruction::kSwitch) {
buzbee17189ac2013-11-08 11:07:02 -0800679 cur_block = ProcessCanSwitch(cur_block, insn, current_offset_, width, flags);
buzbee311ca162013-02-28 15:56:43 -0800680 }
681 current_offset_ += width;
682 BasicBlock *next_block = FindBlock(current_offset_, /* split */ false, /* create */
683 false, /* immed_pred_block_p */ NULL);
684 if (next_block) {
685 /*
686 * The next instruction could be the target of a previously parsed
687 * forward branch so a block is already created. If the current
688 * instruction is not an unconditional branch, connect them through
689 * the fall-through link.
690 */
buzbee0d829482013-10-11 15:24:55 -0700691 DCHECK(cur_block->fall_through == NullBasicBlockId ||
692 GetBasicBlock(cur_block->fall_through) == next_block ||
693 GetBasicBlock(cur_block->fall_through) == exit_block_);
buzbee311ca162013-02-28 15:56:43 -0800694
buzbee0d829482013-10-11 15:24:55 -0700695 if ((cur_block->fall_through == NullBasicBlockId) && (flags & Instruction::kContinue)) {
696 cur_block->fall_through = next_block->id;
697 next_block->predecessors->Insert(cur_block->id);
buzbee311ca162013-02-28 15:56:43 -0800698 }
699 cur_block = next_block;
700 }
701 }
Vladimir Marko5816ed42013-11-27 17:04:20 +0000702
buzbee311ca162013-02-28 15:56:43 -0800703 if (cu_->enable_debug & (1 << kDebugDumpCFG)) {
704 DumpCFG("/sdcard/1_post_parse_cfg/", true);
705 }
706
707 if (cu_->verbose) {
buzbee1fd33462013-03-25 13:40:45 -0700708 DumpMIRGraph();
buzbee311ca162013-02-28 15:56:43 -0800709 }
710}
711
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700712void MIRGraph::ShowOpcodeStats() {
buzbee311ca162013-02-28 15:56:43 -0800713 DCHECK(opcode_count_ != NULL);
714 LOG(INFO) << "Opcode Count";
715 for (int i = 0; i < kNumPackedOpcodes; i++) {
716 if (opcode_count_[i] != 0) {
717 LOG(INFO) << "-C- " << Instruction::Name(static_cast<Instruction::Code>(i))
718 << " " << opcode_count_[i];
719 }
720 }
721}
722
723// TODO: use a configurable base prefix, and adjust callers to supply pass name.
724/* Dump the CFG into a DOT graph */
Jean Christophe Beylerd0a51552014-01-10 14:18:31 -0800725void MIRGraph::DumpCFG(const char* dir_prefix, bool all_blocks, const char *suffix) {
buzbee311ca162013-02-28 15:56:43 -0800726 FILE* file;
727 std::string fname(PrettyMethod(cu_->method_idx, *cu_->dex_file));
728 ReplaceSpecialChars(fname);
Jean Christophe Beylerd0a51552014-01-10 14:18:31 -0800729 fname = StringPrintf("%s%s%x%s.dot", dir_prefix, fname.c_str(),
730 GetBasicBlock(GetEntryBlock()->fall_through)->start_offset,
731 suffix == nullptr ? "" : suffix);
buzbee311ca162013-02-28 15:56:43 -0800732 file = fopen(fname.c_str(), "w");
733 if (file == NULL) {
734 return;
735 }
736 fprintf(file, "digraph G {\n");
737
738 fprintf(file, " rankdir=TB\n");
739
740 int num_blocks = all_blocks ? GetNumBlocks() : num_reachable_blocks_;
741 int idx;
742
743 for (idx = 0; idx < num_blocks; idx++) {
buzbee862a7602013-04-05 10:58:54 -0700744 int block_idx = all_blocks ? idx : dfs_order_->Get(idx);
buzbee311ca162013-02-28 15:56:43 -0800745 BasicBlock *bb = GetBasicBlock(block_idx);
746 if (bb == NULL) break;
747 if (bb->block_type == kDead) continue;
748 if (bb->block_type == kEntryBlock) {
749 fprintf(file, " entry_%d [shape=Mdiamond];\n", bb->id);
750 } else if (bb->block_type == kExitBlock) {
751 fprintf(file, " exit_%d [shape=Mdiamond];\n", bb->id);
752 } else if (bb->block_type == kDalvikByteCode) {
753 fprintf(file, " block%04x_%d [shape=record,label = \"{ \\\n",
754 bb->start_offset, bb->id);
755 const MIR *mir;
756 fprintf(file, " {block id %d\\l}%s\\\n", bb->id,
757 bb->first_mir_insn ? " | " : " ");
758 for (mir = bb->first_mir_insn; mir; mir = mir->next) {
759 int opcode = mir->dalvikInsn.opcode;
760 fprintf(file, " {%04x %s %s %s\\l}%s\\\n", mir->offset,
buzbee1fd33462013-03-25 13:40:45 -0700761 mir->ssa_rep ? GetDalvikDisassembly(mir) :
buzbee311ca162013-02-28 15:56:43 -0800762 (opcode < kMirOpFirst) ? Instruction::Name(mir->dalvikInsn.opcode) :
buzbee1fd33462013-03-25 13:40:45 -0700763 extended_mir_op_names_[opcode - kMirOpFirst],
buzbee311ca162013-02-28 15:56:43 -0800764 (mir->optimization_flags & MIR_IGNORE_RANGE_CHECK) != 0 ? " no_rangecheck" : " ",
765 (mir->optimization_flags & MIR_IGNORE_NULL_CHECK) != 0 ? " no_nullcheck" : " ",
766 mir->next ? " | " : " ");
767 }
768 fprintf(file, " }\"];\n\n");
769 } else if (bb->block_type == kExceptionHandling) {
770 char block_name[BLOCK_NAME_LEN];
771
772 GetBlockName(bb, block_name);
773 fprintf(file, " %s [shape=invhouse];\n", block_name);
774 }
775
776 char block_name1[BLOCK_NAME_LEN], block_name2[BLOCK_NAME_LEN];
777
buzbee0d829482013-10-11 15:24:55 -0700778 if (bb->taken != NullBasicBlockId) {
buzbee311ca162013-02-28 15:56:43 -0800779 GetBlockName(bb, block_name1);
buzbee0d829482013-10-11 15:24:55 -0700780 GetBlockName(GetBasicBlock(bb->taken), block_name2);
buzbee311ca162013-02-28 15:56:43 -0800781 fprintf(file, " %s:s -> %s:n [style=dotted]\n",
782 block_name1, block_name2);
783 }
buzbee0d829482013-10-11 15:24:55 -0700784 if (bb->fall_through != NullBasicBlockId) {
buzbee311ca162013-02-28 15:56:43 -0800785 GetBlockName(bb, block_name1);
buzbee0d829482013-10-11 15:24:55 -0700786 GetBlockName(GetBasicBlock(bb->fall_through), block_name2);
buzbee311ca162013-02-28 15:56:43 -0800787 fprintf(file, " %s:s -> %s:n\n", block_name1, block_name2);
788 }
789
buzbee0d829482013-10-11 15:24:55 -0700790 if (bb->successor_block_list_type != kNotUsed) {
buzbee311ca162013-02-28 15:56:43 -0800791 fprintf(file, " succ%04x_%d [shape=%s,label = \"{ \\\n",
792 bb->start_offset, bb->id,
buzbee0d829482013-10-11 15:24:55 -0700793 (bb->successor_block_list_type == kCatch) ? "Mrecord" : "record");
794 GrowableArray<SuccessorBlockInfo*>::Iterator iterator(bb->successor_blocks);
buzbee862a7602013-04-05 10:58:54 -0700795 SuccessorBlockInfo *successor_block_info = iterator.Next();
buzbee311ca162013-02-28 15:56:43 -0800796
797 int succ_id = 0;
798 while (true) {
799 if (successor_block_info == NULL) break;
800
buzbee0d829482013-10-11 15:24:55 -0700801 BasicBlock *dest_block = GetBasicBlock(successor_block_info->block);
buzbee862a7602013-04-05 10:58:54 -0700802 SuccessorBlockInfo *next_successor_block_info = iterator.Next();
buzbee311ca162013-02-28 15:56:43 -0800803
804 fprintf(file, " {<f%d> %04x: %04x\\l}%s\\\n",
805 succ_id++,
806 successor_block_info->key,
807 dest_block->start_offset,
808 (next_successor_block_info != NULL) ? " | " : " ");
809
810 successor_block_info = next_successor_block_info;
811 }
812 fprintf(file, " }\"];\n\n");
813
814 GetBlockName(bb, block_name1);
815 fprintf(file, " %s:s -> succ%04x_%d:n [style=dashed]\n",
816 block_name1, bb->start_offset, bb->id);
817
buzbee0d829482013-10-11 15:24:55 -0700818 if (bb->successor_block_list_type == kPackedSwitch ||
819 bb->successor_block_list_type == kSparseSwitch) {
820 GrowableArray<SuccessorBlockInfo*>::Iterator iter(bb->successor_blocks);
buzbee311ca162013-02-28 15:56:43 -0800821
822 succ_id = 0;
823 while (true) {
buzbee862a7602013-04-05 10:58:54 -0700824 SuccessorBlockInfo *successor_block_info = iter.Next();
buzbee311ca162013-02-28 15:56:43 -0800825 if (successor_block_info == NULL) break;
826
buzbee0d829482013-10-11 15:24:55 -0700827 BasicBlock* dest_block = GetBasicBlock(successor_block_info->block);
buzbee311ca162013-02-28 15:56:43 -0800828
829 GetBlockName(dest_block, block_name2);
830 fprintf(file, " succ%04x_%d:f%d:e -> %s:n\n", bb->start_offset,
831 bb->id, succ_id++, block_name2);
832 }
833 }
834 }
835 fprintf(file, "\n");
836
837 if (cu_->verbose) {
838 /* Display the dominator tree */
839 GetBlockName(bb, block_name1);
840 fprintf(file, " cfg%s [label=\"%s\", shape=none];\n",
841 block_name1, block_name1);
842 if (bb->i_dom) {
buzbee0d829482013-10-11 15:24:55 -0700843 GetBlockName(GetBasicBlock(bb->i_dom), block_name2);
buzbee311ca162013-02-28 15:56:43 -0800844 fprintf(file, " cfg%s:s -> cfg%s:n\n\n", block_name2, block_name1);
845 }
846 }
847 }
848 fprintf(file, "}\n");
849 fclose(file);
850}
851
buzbee1fd33462013-03-25 13:40:45 -0700852/* Insert an MIR instruction to the end of a basic block */
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700853void MIRGraph::AppendMIR(BasicBlock* bb, MIR* mir) {
buzbee1fd33462013-03-25 13:40:45 -0700854 if (bb->first_mir_insn == NULL) {
855 DCHECK(bb->last_mir_insn == NULL);
856 bb->last_mir_insn = bb->first_mir_insn = mir;
buzbee0d829482013-10-11 15:24:55 -0700857 mir->next = NULL;
buzbee1fd33462013-03-25 13:40:45 -0700858 } else {
859 bb->last_mir_insn->next = mir;
buzbee1fd33462013-03-25 13:40:45 -0700860 mir->next = NULL;
861 bb->last_mir_insn = mir;
862 }
863}
864
865/* Insert an MIR instruction to the head of a basic block */
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700866void MIRGraph::PrependMIR(BasicBlock* bb, MIR* mir) {
buzbee1fd33462013-03-25 13:40:45 -0700867 if (bb->first_mir_insn == NULL) {
868 DCHECK(bb->last_mir_insn == NULL);
869 bb->last_mir_insn = bb->first_mir_insn = mir;
buzbee0d829482013-10-11 15:24:55 -0700870 mir->next = NULL;
buzbee1fd33462013-03-25 13:40:45 -0700871 } else {
buzbee1fd33462013-03-25 13:40:45 -0700872 mir->next = bb->first_mir_insn;
buzbee1fd33462013-03-25 13:40:45 -0700873 bb->first_mir_insn = mir;
874 }
875}
876
877/* Insert a MIR instruction after the specified MIR */
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700878void MIRGraph::InsertMIRAfter(BasicBlock* bb, MIR* current_mir, MIR* new_mir) {
buzbee1fd33462013-03-25 13:40:45 -0700879 new_mir->next = current_mir->next;
880 current_mir->next = new_mir;
881
buzbee0d829482013-10-11 15:24:55 -0700882 if (bb->last_mir_insn == current_mir) {
buzbee1fd33462013-03-25 13:40:45 -0700883 /* Is the last MIR in the block */
884 bb->last_mir_insn = new_mir;
885 }
886}
887
Razvan A Lupusoru3bc01742014-02-06 13:18:43 -0800888MIR* MIRGraph::GetNextUnconditionalMir(BasicBlock* bb, MIR* current) {
889 MIR* next_mir = nullptr;
890
891 if (current != nullptr) {
892 next_mir = current->next;
893 }
894
895 if (next_mir == nullptr) {
896 // Only look for next MIR that follows unconditionally.
897 if ((bb->taken == NullBasicBlockId) && (bb->fall_through != NullBasicBlockId)) {
898 next_mir = GetBasicBlock(bb->fall_through)->first_mir_insn;
899 }
900 }
901
902 return next_mir;
903}
904
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700905char* MIRGraph::GetDalvikDisassembly(const MIR* mir) {
buzbee1fd33462013-03-25 13:40:45 -0700906 DecodedInstruction insn = mir->dalvikInsn;
907 std::string str;
908 int flags = 0;
909 int opcode = insn.opcode;
910 char* ret;
911 bool nop = false;
912 SSARepresentation* ssa_rep = mir->ssa_rep;
913 Instruction::Format dalvik_format = Instruction::k10x; // Default to no-operand format
914 int defs = (ssa_rep != NULL) ? ssa_rep->num_defs : 0;
915 int uses = (ssa_rep != NULL) ? ssa_rep->num_uses : 0;
916
917 // Handle special cases.
918 if ((opcode == kMirOpCheck) || (opcode == kMirOpCheckPart2)) {
919 str.append(extended_mir_op_names_[opcode - kMirOpFirst]);
920 str.append(": ");
921 // Recover the original Dex instruction
922 insn = mir->meta.throw_insn->dalvikInsn;
923 ssa_rep = mir->meta.throw_insn->ssa_rep;
924 defs = ssa_rep->num_defs;
925 uses = ssa_rep->num_uses;
926 opcode = insn.opcode;
927 } else if (opcode == kMirOpNop) {
928 str.append("[");
buzbee0d829482013-10-11 15:24:55 -0700929 // Recover original opcode.
930 insn.opcode = Instruction::At(current_code_item_->insns_ + mir->offset)->Opcode();
931 opcode = insn.opcode;
buzbee1fd33462013-03-25 13:40:45 -0700932 nop = true;
933 }
934
935 if (opcode >= kMirOpFirst) {
936 str.append(extended_mir_op_names_[opcode - kMirOpFirst]);
937 } else {
938 dalvik_format = Instruction::FormatOf(insn.opcode);
939 flags = Instruction::FlagsOf(insn.opcode);
940 str.append(Instruction::Name(insn.opcode));
941 }
942
943 if (opcode == kMirOpPhi) {
buzbee0d829482013-10-11 15:24:55 -0700944 BasicBlockId* incoming = mir->meta.phi_incoming;
buzbee1fd33462013-03-25 13:40:45 -0700945 str.append(StringPrintf(" %s = (%s",
946 GetSSANameWithConst(ssa_rep->defs[0], true).c_str(),
947 GetSSANameWithConst(ssa_rep->uses[0], true).c_str()));
Brian Carlstromb1eba212013-07-17 18:07:19 -0700948 str.append(StringPrintf(":%d", incoming[0]));
buzbee1fd33462013-03-25 13:40:45 -0700949 int i;
950 for (i = 1; i < uses; i++) {
951 str.append(StringPrintf(", %s:%d",
952 GetSSANameWithConst(ssa_rep->uses[i], true).c_str(),
953 incoming[i]));
954 }
955 str.append(")");
956 } else if ((flags & Instruction::kBranch) != 0) {
957 // For branches, decode the instructions to print out the branch targets.
958 int offset = 0;
959 switch (dalvik_format) {
960 case Instruction::k21t:
961 str.append(StringPrintf(" %s,", GetSSANameWithConst(ssa_rep->uses[0], false).c_str()));
962 offset = insn.vB;
963 break;
964 case Instruction::k22t:
965 str.append(StringPrintf(" %s, %s,", GetSSANameWithConst(ssa_rep->uses[0], false).c_str(),
966 GetSSANameWithConst(ssa_rep->uses[1], false).c_str()));
967 offset = insn.vC;
968 break;
969 case Instruction::k10t:
970 case Instruction::k20t:
971 case Instruction::k30t:
972 offset = insn.vA;
973 break;
974 default:
975 LOG(FATAL) << "Unexpected branch format " << dalvik_format << " from " << insn.opcode;
976 }
977 str.append(StringPrintf(" 0x%x (%c%x)", mir->offset + offset,
978 offset > 0 ? '+' : '-', offset > 0 ? offset : -offset));
979 } else {
980 // For invokes-style formats, treat wide regs as a pair of singles
981 bool show_singles = ((dalvik_format == Instruction::k35c) ||
982 (dalvik_format == Instruction::k3rc));
983 if (defs != 0) {
984 str.append(StringPrintf(" %s", GetSSANameWithConst(ssa_rep->defs[0], false).c_str()));
985 if (uses != 0) {
986 str.append(", ");
987 }
988 }
989 for (int i = 0; i < uses; i++) {
990 str.append(
991 StringPrintf(" %s", GetSSANameWithConst(ssa_rep->uses[i], show_singles).c_str()));
992 if (!show_singles && (reg_location_ != NULL) && reg_location_[i].wide) {
993 // For the listing, skip the high sreg.
994 i++;
995 }
996 if (i != (uses -1)) {
997 str.append(",");
998 }
999 }
1000 switch (dalvik_format) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001001 case Instruction::k11n: // Add one immediate from vB
buzbee1fd33462013-03-25 13:40:45 -07001002 case Instruction::k21s:
1003 case Instruction::k31i:
1004 case Instruction::k21h:
1005 str.append(StringPrintf(", #%d", insn.vB));
1006 break;
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001007 case Instruction::k51l: // Add one wide immediate
Ian Rogers23b03b52014-01-24 11:10:03 -08001008 str.append(StringPrintf(", #%" PRId64, insn.vB_wide));
buzbee1fd33462013-03-25 13:40:45 -07001009 break;
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001010 case Instruction::k21c: // One register, one string/type/method index
buzbee1fd33462013-03-25 13:40:45 -07001011 case Instruction::k31c:
1012 str.append(StringPrintf(", index #%d", insn.vB));
1013 break;
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001014 case Instruction::k22c: // Two registers, one string/type/method index
buzbee1fd33462013-03-25 13:40:45 -07001015 str.append(StringPrintf(", index #%d", insn.vC));
1016 break;
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001017 case Instruction::k22s: // Add one immediate from vC
buzbee1fd33462013-03-25 13:40:45 -07001018 case Instruction::k22b:
1019 str.append(StringPrintf(", #%d", insn.vC));
1020 break;
Brian Carlstrom02c8cc62013-07-18 15:54:44 -07001021 default: {
1022 // Nothing left to print
buzbee1fd33462013-03-25 13:40:45 -07001023 }
Brian Carlstrom02c8cc62013-07-18 15:54:44 -07001024 }
buzbee1fd33462013-03-25 13:40:45 -07001025 }
1026 if (nop) {
1027 str.append("]--optimized away");
1028 }
1029 int length = str.length() + 1;
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -07001030 ret = static_cast<char*>(arena_->Alloc(length, ArenaAllocator::kAllocDFInfo));
buzbee1fd33462013-03-25 13:40:45 -07001031 strncpy(ret, str.c_str(), length);
1032 return ret;
1033}
1034
1035/* Turn method name into a legal Linux file name */
Brian Carlstrom2ce745c2013-07-17 17:44:30 -07001036void MIRGraph::ReplaceSpecialChars(std::string& str) {
Brian Carlstrom9b7085a2013-07-18 15:15:21 -07001037 static const struct { const char before; const char after; } match[] = {
1038 {'/', '-'}, {';', '#'}, {' ', '#'}, {'$', '+'},
1039 {'(', '@'}, {')', '@'}, {'<', '='}, {'>', '='}
1040 };
buzbee1fd33462013-03-25 13:40:45 -07001041 for (unsigned int i = 0; i < sizeof(match)/sizeof(match[0]); i++) {
1042 std::replace(str.begin(), str.end(), match[i].before, match[i].after);
1043 }
1044}
1045
Brian Carlstrom2ce745c2013-07-17 17:44:30 -07001046std::string MIRGraph::GetSSAName(int ssa_reg) {
Ian Rogers39ebcb82013-05-30 16:57:23 -07001047 // TODO: This value is needed for LLVM and debugging. Currently, we compute this and then copy to
1048 // the arena. We should be smarter and just place straight into the arena, or compute the
1049 // value more lazily.
buzbee1fd33462013-03-25 13:40:45 -07001050 return StringPrintf("v%d_%d", SRegToVReg(ssa_reg), GetSSASubscript(ssa_reg));
1051}
1052
1053// Similar to GetSSAName, but if ssa name represents an immediate show that as well.
Brian Carlstrom2ce745c2013-07-17 17:44:30 -07001054std::string MIRGraph::GetSSANameWithConst(int ssa_reg, bool singles_only) {
buzbee1fd33462013-03-25 13:40:45 -07001055 if (reg_location_ == NULL) {
1056 // Pre-SSA - just use the standard name
1057 return GetSSAName(ssa_reg);
1058 }
1059 if (IsConst(reg_location_[ssa_reg])) {
1060 if (!singles_only && reg_location_[ssa_reg].wide) {
Ian Rogers23b03b52014-01-24 11:10:03 -08001061 return StringPrintf("v%d_%d#0x%" PRIx64, SRegToVReg(ssa_reg), GetSSASubscript(ssa_reg),
buzbee1fd33462013-03-25 13:40:45 -07001062 ConstantValueWide(reg_location_[ssa_reg]));
1063 } else {
Brian Carlstromb1eba212013-07-17 18:07:19 -07001064 return StringPrintf("v%d_%d#0x%x", SRegToVReg(ssa_reg), GetSSASubscript(ssa_reg),
buzbee1fd33462013-03-25 13:40:45 -07001065 ConstantValue(reg_location_[ssa_reg]));
1066 }
1067 } else {
1068 return StringPrintf("v%d_%d", SRegToVReg(ssa_reg), GetSSASubscript(ssa_reg));
1069 }
1070}
1071
Brian Carlstrom2ce745c2013-07-17 17:44:30 -07001072void MIRGraph::GetBlockName(BasicBlock* bb, char* name) {
buzbee1fd33462013-03-25 13:40:45 -07001073 switch (bb->block_type) {
1074 case kEntryBlock:
1075 snprintf(name, BLOCK_NAME_LEN, "entry_%d", bb->id);
1076 break;
1077 case kExitBlock:
1078 snprintf(name, BLOCK_NAME_LEN, "exit_%d", bb->id);
1079 break;
1080 case kDalvikByteCode:
1081 snprintf(name, BLOCK_NAME_LEN, "block%04x_%d", bb->start_offset, bb->id);
1082 break;
1083 case kExceptionHandling:
1084 snprintf(name, BLOCK_NAME_LEN, "exception%04x_%d", bb->start_offset,
1085 bb->id);
1086 break;
1087 default:
1088 snprintf(name, BLOCK_NAME_LEN, "_%d", bb->id);
1089 break;
1090 }
1091}
1092
Brian Carlstrom2ce745c2013-07-17 17:44:30 -07001093const char* MIRGraph::GetShortyFromTargetIdx(int target_idx) {
buzbee0d829482013-10-11 15:24:55 -07001094 // TODO: for inlining support, use current code unit.
buzbee1fd33462013-03-25 13:40:45 -07001095 const DexFile::MethodId& method_id = cu_->dex_file->GetMethodId(target_idx);
1096 return cu_->dex_file->GetShorty(method_id.proto_idx_);
1097}
1098
1099/* Debug Utility - dump a compilation unit */
Brian Carlstrom2ce745c2013-07-17 17:44:30 -07001100void MIRGraph::DumpMIRGraph() {
buzbee1fd33462013-03-25 13:40:45 -07001101 BasicBlock* bb;
1102 const char* block_type_names[] = {
buzbee17189ac2013-11-08 11:07:02 -08001103 "Null Block",
buzbee1fd33462013-03-25 13:40:45 -07001104 "Entry Block",
1105 "Code Block",
1106 "Exit Block",
1107 "Exception Handling",
1108 "Catch Block"
1109 };
1110
1111 LOG(INFO) << "Compiling " << PrettyMethod(cu_->method_idx, *cu_->dex_file);
1112 LOG(INFO) << cu_->insns << " insns";
1113 LOG(INFO) << GetNumBlocks() << " blocks in total";
buzbee862a7602013-04-05 10:58:54 -07001114 GrowableArray<BasicBlock*>::Iterator iterator(&block_list_);
buzbee1fd33462013-03-25 13:40:45 -07001115
1116 while (true) {
buzbee862a7602013-04-05 10:58:54 -07001117 bb = iterator.Next();
buzbee1fd33462013-03-25 13:40:45 -07001118 if (bb == NULL) break;
1119 LOG(INFO) << StringPrintf("Block %d (%s) (insn %04x - %04x%s)",
1120 bb->id,
1121 block_type_names[bb->block_type],
1122 bb->start_offset,
1123 bb->last_mir_insn ? bb->last_mir_insn->offset : bb->start_offset,
1124 bb->last_mir_insn ? "" : " empty");
buzbee0d829482013-10-11 15:24:55 -07001125 if (bb->taken != NullBasicBlockId) {
1126 LOG(INFO) << " Taken branch: block " << bb->taken
1127 << "(0x" << std::hex << GetBasicBlock(bb->taken)->start_offset << ")";
buzbee1fd33462013-03-25 13:40:45 -07001128 }
buzbee0d829482013-10-11 15:24:55 -07001129 if (bb->fall_through != NullBasicBlockId) {
1130 LOG(INFO) << " Fallthrough : block " << bb->fall_through
1131 << " (0x" << std::hex << GetBasicBlock(bb->fall_through)->start_offset << ")";
buzbee1fd33462013-03-25 13:40:45 -07001132 }
1133 }
1134}
1135
1136/*
1137 * Build an array of location records for the incoming arguments.
1138 * Note: one location record per word of arguments, with dummy
1139 * high-word loc for wide arguments. Also pull up any following
1140 * MOVE_RESULT and incorporate it into the invoke.
1141 */
1142CallInfo* MIRGraph::NewMemCallInfo(BasicBlock* bb, MIR* mir, InvokeType type,
Brian Carlstrom2ce745c2013-07-17 17:44:30 -07001143 bool is_range) {
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -07001144 CallInfo* info = static_cast<CallInfo*>(arena_->Alloc(sizeof(CallInfo),
1145 ArenaAllocator::kAllocMisc));
buzbee1fd33462013-03-25 13:40:45 -07001146 MIR* move_result_mir = FindMoveResult(bb, mir);
1147 if (move_result_mir == NULL) {
1148 info->result.location = kLocInvalid;
1149 } else {
1150 info->result = GetRawDest(move_result_mir);
buzbee1fd33462013-03-25 13:40:45 -07001151 move_result_mir->dalvikInsn.opcode = static_cast<Instruction::Code>(kMirOpNop);
1152 }
1153 info->num_arg_words = mir->ssa_rep->num_uses;
1154 info->args = (info->num_arg_words == 0) ? NULL : static_cast<RegLocation*>
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -07001155 (arena_->Alloc(sizeof(RegLocation) * info->num_arg_words, ArenaAllocator::kAllocMisc));
buzbee1fd33462013-03-25 13:40:45 -07001156 for (int i = 0; i < info->num_arg_words; i++) {
1157 info->args[i] = GetRawSrc(mir, i);
1158 }
1159 info->opt_flags = mir->optimization_flags;
1160 info->type = type;
1161 info->is_range = is_range;
1162 info->index = mir->dalvikInsn.vB;
1163 info->offset = mir->offset;
1164 return info;
1165}
1166
buzbee862a7602013-04-05 10:58:54 -07001167// Allocate a new basic block.
Brian Carlstrom2ce745c2013-07-17 17:44:30 -07001168BasicBlock* MIRGraph::NewMemBB(BBType block_type, int block_id) {
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -07001169 BasicBlock* bb = static_cast<BasicBlock*>(arena_->Alloc(sizeof(BasicBlock),
1170 ArenaAllocator::kAllocBB));
buzbee862a7602013-04-05 10:58:54 -07001171 bb->block_type = block_type;
1172 bb->id = block_id;
1173 // TUNING: better estimate of the exit block predecessors?
buzbee0d829482013-10-11 15:24:55 -07001174 bb->predecessors = new (arena_) GrowableArray<BasicBlockId>(arena_,
Brian Carlstromdf629502013-07-17 22:39:56 -07001175 (block_type == kExitBlock) ? 2048 : 2,
1176 kGrowableArrayPredecessors);
buzbee0d829482013-10-11 15:24:55 -07001177 bb->successor_block_list_type = kNotUsed;
buzbee862a7602013-04-05 10:58:54 -07001178 block_id_map_.Put(block_id, block_id);
1179 return bb;
1180}
buzbee1fd33462013-03-25 13:40:45 -07001181
Jean Christophe Beyler4e97c532014-01-07 10:07:18 -08001182void MIRGraph::InitializeConstantPropagation() {
1183 is_constant_v_ = new (arena_) ArenaBitVector(arena_, GetNumSSARegs(), false);
1184 constant_values_ = static_cast<int*>(arena_->Alloc(sizeof(int) * GetNumSSARegs(), ArenaAllocator::kAllocDFInfo));
1185}
1186
1187void MIRGraph::InitializeMethodUses() {
1188 // The gate starts by initializing the use counts
1189 int num_ssa_regs = GetNumSSARegs();
1190 use_counts_.Resize(num_ssa_regs + 32);
1191 raw_use_counts_.Resize(num_ssa_regs + 32);
1192 // Initialize list
1193 for (int i = 0; i < num_ssa_regs; i++) {
1194 use_counts_.Insert(0);
1195 raw_use_counts_.Insert(0);
1196 }
1197}
1198
1199void MIRGraph::InitializeSSATransformation() {
1200 /* Compute the DFS order */
1201 ComputeDFSOrders();
1202
1203 /* Compute the dominator info */
1204 ComputeDominators();
1205
1206 /* Allocate data structures in preparation for SSA conversion */
1207 CompilerInitializeSSAConversion();
1208
1209 /* Find out the "Dalvik reg def x block" relation */
1210 ComputeDefBlockMatrix();
1211
1212 /* Insert phi nodes to dominance frontiers for all variables */
1213 InsertPhiNodes();
1214
1215 /* Rename register names by local defs and phi nodes */
1216 ClearAllVisitedFlags();
1217 DoDFSPreOrderSSARename(GetEntryBlock());
1218
1219 /*
1220 * Shared temp bit vector used by each block to count the number of defs
1221 * from all the predecessor blocks.
1222 */
1223 temp_ssa_register_v_ =
1224 new (arena_) ArenaBitVector(arena_, GetNumSSARegs(), false, kBitMapTempSSARegisterV);
1225}
1226
1227void MIRGraph::CheckSSARegisterVector() {
1228 DCHECK(temp_ssa_register_v_ != nullptr);
1229}
1230
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001231} // namespace art