blob: 0a3698946e879185b075a0b90e9f96a45f167299 [file] [log] [blame]
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +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_CODE_GENERATOR_H_
18#define ART_COMPILER_OPTIMIZING_CODE_GENERATOR_H_
19
Ian Rogersd582fa42014-11-05 23:46:43 -080020#include "arch/instruction_set.h"
Calin Juravle34166012014-12-19 17:22:29 +000021#include "arch/instruction_set_features.h"
Vladimir Markof9f64412015-09-02 14:05:49 +010022#include "base/arena_containers.h"
23#include "base/arena_object.h"
Nicolas Geoffray01bc96d2014-04-11 17:43:50 +010024#include "base/bit_field.h"
Calin Juravlecd6dffe2015-01-08 17:35:35 +000025#include "driver/compiler_options.h"
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +000026#include "globals.h"
Alexandre Rameseb7b7392015-06-19 14:47:01 +010027#include "graph_visualizer.h"
Nicolas Geoffray4e3d23a2014-05-22 18:32:45 +010028#include "locations.h"
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +000029#include "memory_region.h"
30#include "nodes.h"
Serban Constantinescuecc43662015-08-13 13:33:12 +010031#include "optimizing_compiler_stats.h"
Nicolas Geoffray39468442014-09-02 15:17:15 +010032#include "stack_map_stream.h"
Andreas Gampe85b62f22015-09-09 13:15:38 -070033#include "utils/label.h"
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +000034
35namespace art {
36
Roland Levillain6d0e4832014-11-27 18:31:21 +000037// Binary encoding of 2^32 for type double.
38static int64_t constexpr k2Pow32EncodingForDouble = INT64_C(0x41F0000000000000);
39// Binary encoding of 2^31 for type double.
40static int64_t constexpr k2Pow31EncodingForDouble = INT64_C(0x41E0000000000000);
41
Mark Mendelle82549b2015-05-06 10:55:34 -040042// Minimum value for a primitive integer.
43static int32_t constexpr kPrimIntMin = 0x80000000;
44// Minimum value for a primitive long.
45static int64_t constexpr kPrimLongMin = INT64_C(0x8000000000000000);
46
Roland Levillain3f8f9362014-12-02 17:45:01 +000047// Maximum value for a primitive integer.
48static int32_t constexpr kPrimIntMax = 0x7fffffff;
Roland Levillain624279f2014-12-04 11:54:28 +000049// Maximum value for a primitive long.
Mark Mendelle82549b2015-05-06 10:55:34 -040050static int64_t constexpr kPrimLongMax = INT64_C(0x7fffffffffffffff);
Roland Levillain3f8f9362014-12-02 17:45:01 +000051
Nicolas Geoffray92a73ae2014-10-16 11:12:52 +010052class Assembler;
Nicolas Geoffraye5038322014-07-04 09:41:32 +010053class CodeGenerator;
Nicolas Geoffray92cf83e2014-03-18 17:59:20 +000054class DexCompilationUnit;
Vladimir Marko58155012015-08-19 12:49:41 +000055class LinkerPatch;
Nicolas Geoffrayf0e39372014-11-12 17:50:07 +000056class ParallelMoveResolver;
Andreas Gampee21dc3d2014-12-08 16:59:43 -080057class SrcMapElem;
58template <class Alloc>
Yevgeny Roubane3ea8382014-08-08 16:29:38 +070059class SrcMap;
Andreas Gampee21dc3d2014-12-08 16:59:43 -080060using DefaultSrcMap = SrcMap<std::allocator<SrcMapElem>>;
Nicolas Geoffray92cf83e2014-03-18 17:59:20 +000061
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +000062class CodeAllocator {
63 public:
Nicolas Geoffraye5038322014-07-04 09:41:32 +010064 CodeAllocator() {}
65 virtual ~CodeAllocator() {}
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +000066
67 virtual uint8_t* Allocate(size_t size) = 0;
68
69 private:
70 DISALLOW_COPY_AND_ASSIGN(CodeAllocator);
71};
72
Ian Rogers6a3c1fc2014-10-31 00:33:20 -070073class SlowPathCode : public ArenaObject<kArenaAllocSlowPaths> {
Nicolas Geoffraye5038322014-07-04 09:41:32 +010074 public:
Nicolas Geoffrayeeefa122015-03-13 18:52:59 +000075 SlowPathCode() {
76 for (size_t i = 0; i < kMaximumNumberOfExpectedRegisters; ++i) {
77 saved_core_stack_offsets_[i] = kRegisterNotSaved;
78 saved_fpu_stack_offsets_[i] = kRegisterNotSaved;
79 }
80 }
81
Nicolas Geoffraye5038322014-07-04 09:41:32 +010082 virtual ~SlowPathCode() {}
83
Nicolas Geoffraye5038322014-07-04 09:41:32 +010084 virtual void EmitNativeCode(CodeGenerator* codegen) = 0;
85
Zheng Xuda403092015-04-24 17:35:39 +080086 virtual void SaveLiveRegisters(CodeGenerator* codegen, LocationSummary* locations);
87 virtual void RestoreLiveRegisters(CodeGenerator* codegen, LocationSummary* locations);
Nicolas Geoffraya8ac9132015-03-13 16:36:36 +000088
Nicolas Geoffrayeeefa122015-03-13 18:52:59 +000089 bool IsCoreRegisterSaved(int reg) const {
90 return saved_core_stack_offsets_[reg] != kRegisterNotSaved;
91 }
92
93 bool IsFpuRegisterSaved(int reg) const {
94 return saved_fpu_stack_offsets_[reg] != kRegisterNotSaved;
95 }
96
97 uint32_t GetStackOffsetOfCoreRegister(int reg) const {
98 return saved_core_stack_offsets_[reg];
99 }
100
101 uint32_t GetStackOffsetOfFpuRegister(int reg) const {
102 return saved_fpu_stack_offsets_[reg];
103 }
104
Alexandre Rames8158f282015-08-07 10:26:17 +0100105 virtual bool IsFatal() const { return false; }
106
Alexandre Rames9931f312015-06-19 14:47:01 +0100107 virtual const char* GetDescription() const = 0;
108
Andreas Gampe85b62f22015-09-09 13:15:38 -0700109 Label* GetEntryLabel() { return &entry_label_; }
110 Label* GetExitLabel() { return &exit_label_; }
111
Zheng Xuda403092015-04-24 17:35:39 +0800112 protected:
Nicolas Geoffrayeeefa122015-03-13 18:52:59 +0000113 static constexpr size_t kMaximumNumberOfExpectedRegisters = 32;
114 static constexpr uint32_t kRegisterNotSaved = -1;
115 uint32_t saved_core_stack_offsets_[kMaximumNumberOfExpectedRegisters];
116 uint32_t saved_fpu_stack_offsets_[kMaximumNumberOfExpectedRegisters];
Zheng Xuda403092015-04-24 17:35:39 +0800117
118 private:
Andreas Gampe85b62f22015-09-09 13:15:38 -0700119 Label entry_label_;
120 Label exit_label_;
121
Nicolas Geoffraye5038322014-07-04 09:41:32 +0100122 DISALLOW_COPY_AND_ASSIGN(SlowPathCode);
123};
124
Roland Levillain2d27c8e2015-04-28 15:48:45 +0100125class InvokeDexCallingConventionVisitor {
126 public:
127 virtual Location GetNextLocation(Primitive::Type type) = 0;
Nicolas Geoffrayfd88f162015-06-03 11:23:52 +0100128 virtual Location GetReturnLocation(Primitive::Type type) const = 0;
129 virtual Location GetMethodLocation() const = 0;
Roland Levillain2d27c8e2015-04-28 15:48:45 +0100130
131 protected:
132 InvokeDexCallingConventionVisitor() {}
133 virtual ~InvokeDexCallingConventionVisitor() {}
134
135 // The current index for core registers.
136 uint32_t gp_index_ = 0u;
137 // The current index for floating-point registers.
138 uint32_t float_index_ = 0u;
139 // The current stack index.
140 uint32_t stack_index_ = 0u;
141
142 private:
143 DISALLOW_COPY_AND_ASSIGN(InvokeDexCallingConventionVisitor);
144};
145
Calin Juravlee460d1d2015-09-29 04:52:17 +0100146class FieldAccessCallingConvention {
147 public:
148 virtual Location GetObjectLocation() const = 0;
149 virtual Location GetFieldIndexLocation() const = 0;
150 virtual Location GetReturnLocation(Primitive::Type type) const = 0;
151 virtual Location GetSetValueLocation(Primitive::Type type, bool is_instance) const = 0;
152 virtual Location GetFpuLocation(Primitive::Type type) const = 0;
153 virtual ~FieldAccessCallingConvention() {}
154
155 protected:
156 FieldAccessCallingConvention() {}
157
158 private:
159 DISALLOW_COPY_AND_ASSIGN(FieldAccessCallingConvention);
160};
161
Nicolas Geoffray12df9eb2015-01-09 14:53:50 +0000162class CodeGenerator {
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000163 public:
164 // Compiles the graph to executable instructions. Returns whether the compilation
165 // succeeded.
Nicolas Geoffray73e80c32014-07-22 17:47:56 +0100166 void CompileBaseline(CodeAllocator* allocator, bool is_leaf = false);
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100167 void CompileOptimized(CodeAllocator* allocator);
Nicolas Geoffray12df9eb2015-01-09 14:53:50 +0000168 static CodeGenerator* Create(HGraph* graph,
Calin Juravle34166012014-12-19 17:22:29 +0000169 InstructionSet instruction_set,
Calin Juravlecd6dffe2015-01-08 17:35:35 +0000170 const InstructionSetFeatures& isa_features,
Serban Constantinescuecc43662015-08-13 13:33:12 +0100171 const CompilerOptions& compiler_options,
172 OptimizingCompilerStats* stats = nullptr);
Nicolas Geoffray12df9eb2015-01-09 14:53:50 +0000173 virtual ~CodeGenerator() {}
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000174
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000175 HGraph* GetGraph() const { return graph_; }
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000176
Nicolas Geoffraydc23d832015-02-16 11:15:43 +0000177 HBasicBlock* GetNextBlockToEmit() const;
178 HBasicBlock* FirstNonEmptyBlock(HBasicBlock* block) const;
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000179 bool GoesToNextBlock(HBasicBlock* current, HBasicBlock* next) const;
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000180
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100181 size_t GetStackSlotOfParameter(HParameterValue* parameter) const {
182 // Note that this follows the current calling convention.
183 return GetFrameSize()
Mathieu Chartiere401d142015-04-22 13:56:20 -0700184 + InstructionSetPointerSize(GetInstructionSet()) // Art method
Nicolas Geoffraye27f31a2014-06-12 17:53:14 +0100185 + parameter->GetIndex() * kVRegSize;
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100186 }
187
Nicolas Geoffray92a73ae2014-10-16 11:12:52 +0100188 virtual void Initialize() = 0;
Serban Constantinescu32f5b4d2014-11-25 20:05:46 +0000189 virtual void Finalize(CodeAllocator* allocator);
Vladimir Marko58155012015-08-19 12:49:41 +0000190 virtual void EmitLinkerPatches(ArenaVector<LinkerPatch>* linker_patches);
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000191 virtual void GenerateFrameEntry() = 0;
192 virtual void GenerateFrameExit() = 0;
Nicolas Geoffray92a73ae2014-10-16 11:12:52 +0100193 virtual void Bind(HBasicBlock* block) = 0;
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100194 virtual void Move(HInstruction* instruction, Location location, HInstruction* move_for) = 0;
Calin Juravle175dc732015-08-25 15:42:32 +0100195 virtual void MoveConstant(Location destination, int32_t value) = 0;
Calin Juravlee460d1d2015-09-29 04:52:17 +0100196 virtual void MoveLocation(Location dst, Location src, Primitive::Type dst_type) = 0;
197 virtual void AddLocationAsTemp(Location location, LocationSummary* locations) = 0;
198
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000199 virtual Assembler* GetAssembler() = 0;
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100200 virtual const Assembler& GetAssembler() const = 0;
Nicolas Geoffray707c8092014-04-04 10:50:14 +0100201 virtual size_t GetWordSize() const = 0;
Mark Mendellf85a9ca2015-01-13 09:20:58 -0500202 virtual size_t GetFloatingPointSpillSlotSize() const = 0;
Nicolas Geoffrayde58ab22014-11-05 12:46:03 +0000203 virtual uintptr_t GetAddressOf(HBasicBlock* block) const = 0;
Nicolas Geoffray4c204ba2015-02-03 15:12:35 +0000204 void InitializeCodeGeneration(size_t number_of_spill_slots,
205 size_t maximum_number_of_live_core_registers,
206 size_t maximum_number_of_live_fp_registers,
207 size_t number_of_out_slots,
Vladimir Markofa6b93c2015-09-15 10:15:55 +0100208 const ArenaVector<HBasicBlock*>& block_order);
Nicolas Geoffrayab032bc2014-07-15 12:55:21 +0100209 int32_t GetStackSlot(HLocal* local) const;
210 Location GetTemporaryLocation(HTemporary* temp) const;
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000211
212 uint32_t GetFrameSize() const { return frame_size_; }
213 void SetFrameSize(uint32_t size) { frame_size_ = size; }
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +0000214 uint32_t GetCoreSpillMask() const { return core_spill_mask_; }
Nicolas Geoffrayd97dc402015-01-22 13:50:01 +0000215 uint32_t GetFpuSpillMask() const { return fpu_spill_mask_; }
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000216
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100217 size_t GetNumberOfCoreRegisters() const { return number_of_core_registers_; }
218 size_t GetNumberOfFloatingPointRegisters() const { return number_of_fpu_registers_; }
Nicolas Geoffray98893962015-01-21 12:32:32 +0000219 virtual void SetupBlockedRegisters(bool is_baseline) const = 0;
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100220
Nicolas Geoffray4dee6362015-01-23 18:23:14 +0000221 virtual void ComputeSpillMask() {
222 core_spill_mask_ = allocated_registers_.GetCoreRegisters() & core_callee_save_mask_;
223 DCHECK_NE(core_spill_mask_, 0u) << "At least the return address register must be saved";
224 fpu_spill_mask_ = allocated_registers_.GetFloatingPointRegisters() & fpu_callee_save_mask_;
225 }
226
227 static uint32_t ComputeRegisterMask(const int* registers, size_t length) {
228 uint32_t mask = 0;
229 for (size_t i = 0, e = length; i < e; ++i) {
230 mask |= (1 << registers[i]);
231 }
232 return mask;
233 }
234
Nicolas Geoffraya7062e02014-05-22 12:50:17 +0100235 virtual void DumpCoreRegister(std::ostream& stream, int reg) const = 0;
236 virtual void DumpFloatingPointRegister(std::ostream& stream, int reg) const = 0;
Nicolas Geoffray412f10c2014-06-19 10:00:34 +0100237 virtual InstructionSet GetInstructionSet() const = 0;
Calin Juravlecd6dffe2015-01-08 17:35:35 +0000238
239 const CompilerOptions& GetCompilerOptions() const { return compiler_options_; }
240
Serban Constantinescuecc43662015-08-13 13:33:12 +0100241 void MaybeRecordStat(MethodCompilationStat compilation_stat, size_t count = 1) const;
242
Nicolas Geoffray102cbed2014-10-15 18:31:05 +0100243 // Saves the register in the stack. Returns the size taken on stack.
244 virtual size_t SaveCoreRegister(size_t stack_index, uint32_t reg_id) = 0;
245 // Restores the register from the stack. Returns the size taken on stack.
246 virtual size_t RestoreCoreRegister(size_t stack_index, uint32_t reg_id) = 0;
Nicolas Geoffray234d69d2015-03-09 10:28:50 +0000247
248 virtual size_t SaveFloatingPointRegister(size_t stack_index, uint32_t reg_id) = 0;
249 virtual size_t RestoreFloatingPointRegister(size_t stack_index, uint32_t reg_id) = 0;
250
Nicolas Geoffray840e5462015-01-07 16:01:24 +0000251 virtual bool NeedsTwoRegisters(Primitive::Type type) const = 0;
Nicolas Geoffray234d69d2015-03-09 10:28:50 +0000252 // Returns whether we should split long moves in parallel moves.
253 virtual bool ShouldSplitLongMoves() const { return false; }
Nicolas Geoffraya7062e02014-05-22 12:50:17 +0100254
Nicolas Geoffray98893962015-01-21 12:32:32 +0000255 bool IsCoreCalleeSaveRegister(int reg) const {
256 return (core_callee_save_mask_ & (1 << reg)) != 0;
257 }
258
259 bool IsFloatingPointCalleeSaveRegister(int reg) const {
260 return (fpu_callee_save_mask_ & (1 << reg)) != 0;
261 }
262
Yevgeny Rouban2a7c1ef2015-07-22 18:36:24 +0600263 // Record native to dex mapping for a suspend point. Required by runtime.
Nicolas Geoffrayeeefa122015-03-13 18:52:59 +0000264 void RecordPcInfo(HInstruction* instruction, uint32_t dex_pc, SlowPathCode* slow_path = nullptr);
Yevgeny Rouban2a7c1ef2015-07-22 18:36:24 +0600265 // Record additional native to dex mappings for native debugging/profiling tools.
266 void RecordNativeDebugInfo(uint32_t dex_pc, uintptr_t native_pc_begin, uintptr_t native_pc_end);
267
Calin Juravle77520bc2015-01-12 18:45:46 +0000268 bool CanMoveNullCheckToUser(HNullCheck* null_check);
269 void MaybeRecordImplicitNullCheck(HInstruction* instruction);
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +0000270
David Brazdil77a48ae2015-09-15 12:34:04 +0000271 // Records a stack map which the runtime might use to set catch phi values
272 // during exception delivery.
273 // TODO: Replace with a catch-entering instruction that records the environment.
274 void RecordCatchBlockInfo();
275
276 // Returns true if implicit null checks are allowed in the compiler options
277 // and if the null check is not inside a try block. We currently cannot do
278 // implicit null checks in that case because we need the NullCheckSlowPath to
279 // save live registers, which may be needed by the runtime to set catch phis.
280 bool IsImplicitNullCheckAllowed(HNullCheck* null_check) const;
281
Nicolas Geoffraye5038322014-07-04 09:41:32 +0100282 void AddSlowPath(SlowPathCode* slow_path) {
Vladimir Marko225b6462015-09-28 12:17:40 +0100283 slow_paths_.push_back(slow_path);
Nicolas Geoffraye5038322014-07-04 09:41:32 +0100284 }
285
Yevgeny Rouban2a7c1ef2015-07-22 18:36:24 +0600286 void SetSrcMap(DefaultSrcMap* src_map) { src_map_ = src_map; }
287
Vladimir Markof9f64412015-09-02 14:05:49 +0100288 void BuildMappingTable(ArenaVector<uint8_t>* vector) const;
289 void BuildVMapTable(ArenaVector<uint8_t>* vector) const;
Nicolas Geoffray92cf83e2014-03-18 17:59:20 +0000290 void BuildNativeGCMap(
Vladimir Markof9f64412015-09-02 14:05:49 +0100291 ArenaVector<uint8_t>* vector, const DexCompilationUnit& dex_compilation_unit) const;
292 void BuildStackMaps(ArenaVector<uint8_t>* vector);
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000293
Roland Levillain3e3d7332015-04-28 11:00:54 +0100294 bool IsBaseline() const {
295 return is_baseline_;
296 }
297
Nicolas Geoffrayf12feb82014-07-17 18:32:41 +0100298 bool IsLeafMethod() const {
299 return is_leaf_;
300 }
301
302 void MarkNotLeaf() {
303 is_leaf_ = false;
Nicolas Geoffrayc0572a42015-02-06 14:35:25 +0000304 requires_current_method_ = true;
305 }
306
307 void SetRequiresCurrentMethod() {
308 requires_current_method_ = true;
309 }
310
311 bool RequiresCurrentMethod() const {
312 return requires_current_method_;
Nicolas Geoffrayf12feb82014-07-17 18:32:41 +0100313 }
314
Nicolas Geoffray3c049742014-09-24 18:10:46 +0100315 // Clears the spill slots taken by loop phis in the `LocationSummary` of the
316 // suspend check. This is called when the code generator generates code
317 // for the suspend check at the back edge (instead of where the suspend check
318 // is, which is the loop entry). At this point, the spill slots for the phis
319 // have not been written to.
320 void ClearSpillSlotsFromLoopPhisInStackMap(HSuspendCheck* suspend_check) const;
321
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100322 bool* GetBlockedCoreRegisters() const { return blocked_core_registers_; }
Nicolas Geoffray102cbed2014-10-15 18:31:05 +0100323 bool* GetBlockedFloatingPointRegisters() const { return blocked_fpu_registers_; }
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100324
Nicolas Geoffray19a19cf2014-10-22 16:07:05 +0100325 // Helper that returns the pointer offset of an index in an object array.
326 // Note: this method assumes we always have the same pointer size, regardless
327 // of the architecture.
328 static size_t GetCacheOffset(uint32_t index);
Mathieu Chartiere401d142015-04-22 13:56:20 -0700329 // Pointer variant for ArtMethod and ArtField arrays.
330 size_t GetCachePointerOffset(uint32_t index);
Nicolas Geoffray19a19cf2014-10-22 16:07:05 +0100331
Nicolas Geoffray90218252015-04-15 11:56:51 +0100332 void EmitParallelMoves(Location from1,
333 Location to1,
334 Primitive::Type type1,
335 Location from2,
336 Location to2,
337 Primitive::Type type2);
Nicolas Geoffrayf0e39372014-11-12 17:50:07 +0000338
Nicolas Geoffrayaf07bc12014-11-12 18:08:09 +0000339 static bool StoreNeedsWriteBarrier(Primitive::Type type, HInstruction* value) {
David Brazdil522e2242015-03-17 18:48:28 +0000340 // Check that null value is not represented as an integer constant.
341 DCHECK(type != Primitive::kPrimNot || !value->IsIntConstant());
342 return type == Primitive::kPrimNot && !value->IsNullConstant();
Nicolas Geoffrayaf07bc12014-11-12 18:08:09 +0000343 }
344
Alexandre Rames78e3ef62015-08-12 13:43:29 +0100345 void ValidateInvokeRuntime(HInstruction* instruction, SlowPathCode* slow_path);
346
Nicolas Geoffray98893962015-01-21 12:32:32 +0000347 void AddAllocatedRegister(Location location) {
348 allocated_registers_.Add(location);
349 }
350
Nicolas Geoffray45b83af2015-07-06 15:12:53 +0000351 bool HasAllocatedRegister(bool is_core, int reg) const {
352 return is_core
353 ? allocated_registers_.ContainsCoreRegister(reg)
354 : allocated_registers_.ContainsFloatingPointRegister(reg);
355 }
356
Nicolas Geoffrayc0572a42015-02-06 14:35:25 +0000357 void AllocateLocations(HInstruction* instruction);
358
Roland Levillainaa9b7c42015-02-17 15:40:09 +0000359 // Tells whether the stack frame of the compiled method is
360 // considered "empty", that is either actually having a size of zero,
361 // or just containing the saved return address register.
362 bool HasEmptyFrame() const {
363 return GetFrameSize() == (CallPushesPC() ? GetWordSize() : 0);
364 }
365
Nicolas Geoffrayd6138ef2015-02-18 14:48:53 +0000366 static int32_t GetInt32ValueOf(HConstant* constant) {
367 if (constant->IsIntConstant()) {
368 return constant->AsIntConstant()->GetValue();
369 } else if (constant->IsNullConstant()) {
370 return 0;
371 } else {
372 DCHECK(constant->IsFloatConstant());
Roland Levillainda4d79b2015-03-24 14:36:11 +0000373 return bit_cast<int32_t, float>(constant->AsFloatConstant()->GetValue());
Nicolas Geoffrayd6138ef2015-02-18 14:48:53 +0000374 }
375 }
376
377 static int64_t GetInt64ValueOf(HConstant* constant) {
378 if (constant->IsIntConstant()) {
379 return constant->AsIntConstant()->GetValue();
380 } else if (constant->IsNullConstant()) {
381 return 0;
382 } else if (constant->IsFloatConstant()) {
Roland Levillainda4d79b2015-03-24 14:36:11 +0000383 return bit_cast<int32_t, float>(constant->AsFloatConstant()->GetValue());
Nicolas Geoffrayd6138ef2015-02-18 14:48:53 +0000384 } else if (constant->IsLongConstant()) {
385 return constant->AsLongConstant()->GetValue();
386 } else {
387 DCHECK(constant->IsDoubleConstant());
Roland Levillainda4d79b2015-03-24 14:36:11 +0000388 return bit_cast<int64_t, double>(constant->AsDoubleConstant()->GetValue());
Nicolas Geoffrayd6138ef2015-02-18 14:48:53 +0000389 }
390 }
391
Nicolas Geoffraya8ac9132015-03-13 16:36:36 +0000392 size_t GetFirstRegisterSlotInSlowPath() const {
393 return first_register_slot_in_slow_path_;
394 }
395
396 uint32_t FrameEntrySpillSize() const {
397 return GetFpuSpillSize() + GetCoreSpillSize();
398 }
399
Roland Levillainec525fc2015-04-28 15:50:20 +0100400 virtual ParallelMoveResolver* GetMoveResolver() = 0;
Nicolas Geoffraya8ac9132015-03-13 16:36:36 +0000401
Nicolas Geoffrayfd88f162015-06-03 11:23:52 +0100402 static void CreateCommonInvokeLocationSummary(
403 HInvoke* invoke, InvokeDexCallingConventionVisitor* visitor);
404
Calin Juravle175dc732015-08-25 15:42:32 +0100405 void GenerateInvokeUnresolvedRuntimeCall(HInvokeUnresolved* invoke);
406
Calin Juravlee460d1d2015-09-29 04:52:17 +0100407 void CreateUnresolvedFieldLocationSummary(
408 HInstruction* field_access,
409 Primitive::Type field_type,
410 const FieldAccessCallingConvention& calling_convention);
411
412 void GenerateUnresolvedFieldAccess(
413 HInstruction* field_access,
414 Primitive::Type field_type,
415 uint32_t field_index,
416 uint32_t dex_pc,
417 const FieldAccessCallingConvention& calling_convention);
418
Calin Juravle98893e12015-10-02 21:05:03 +0100419 // TODO: This overlaps a bit with MoveFromReturnRegister. Refactor for a better design.
420 static void CreateLoadClassLocationSummary(HLoadClass* cls,
421 Location runtime_type_index_location,
422 Location runtime_return_location);
423
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100424 void SetDisassemblyInformation(DisassemblyInformation* info) { disasm_info_ = info; }
425 DisassemblyInformation* GetDisassemblyInformation() const { return disasm_info_; }
426
Calin Juravle175dc732015-08-25 15:42:32 +0100427 virtual void InvokeRuntime(QuickEntrypointEnum entrypoint,
428 HInstruction* instruction,
429 uint32_t dex_pc,
430 SlowPathCode* slow_path) = 0;
431
Andreas Gampe85b62f22015-09-09 13:15:38 -0700432 // Generate a call to a static or direct method.
433 virtual void GenerateStaticOrDirectCall(HInvokeStaticOrDirect* invoke, Location temp) = 0;
434 // Generate a call to a virtual method.
435 virtual void GenerateVirtualCall(HInvokeVirtual* invoke, Location temp) = 0;
436
437 // Copy the result of a call into the given target.
438 virtual void MoveFromReturnRegister(Location trg, Primitive::Type type) = 0;
439
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000440 protected:
Vladimir Marko58155012015-08-19 12:49:41 +0000441 // Method patch info used for recording locations of required linker patches and
442 // target methods. The target method can be used for various purposes, whether for
443 // patching the address of the method or the code pointer or a PC-relative call.
444 template <typename LabelType>
445 struct MethodPatchInfo {
446 explicit MethodPatchInfo(MethodReference m) : target_method(m), label() { }
447
448 MethodReference target_method;
449 LabelType label;
450 };
451
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100452 CodeGenerator(HGraph* graph,
453 size_t number_of_core_registers,
454 size_t number_of_fpu_registers,
Calin Juravlecd6dffe2015-01-08 17:35:35 +0000455 size_t number_of_register_pairs,
Nicolas Geoffray98893962015-01-21 12:32:32 +0000456 uint32_t core_callee_save_mask,
457 uint32_t fpu_callee_save_mask,
Serban Constantinescuecc43662015-08-13 13:33:12 +0100458 const CompilerOptions& compiler_options,
459 OptimizingCompilerStats* stats)
Nicolas Geoffrayc0572a42015-02-06 14:35:25 +0000460 : frame_size_(0),
Nicolas Geoffray4361bef2014-08-20 04:59:12 +0100461 core_spill_mask_(0),
Nicolas Geoffrayd97dc402015-01-22 13:50:01 +0000462 fpu_spill_mask_(0),
Nicolas Geoffray3bca0df2014-09-19 11:01:00 +0100463 first_register_slot_in_slow_path_(0),
Vladimir Marko5233f932015-09-29 19:01:15 +0100464 blocked_core_registers_(graph->GetArena()->AllocArray<bool>(number_of_core_registers,
465 kArenaAllocCodeGenerator)),
466 blocked_fpu_registers_(graph->GetArena()->AllocArray<bool>(number_of_fpu_registers,
467 kArenaAllocCodeGenerator)),
468 blocked_register_pairs_(graph->GetArena()->AllocArray<bool>(number_of_register_pairs,
469 kArenaAllocCodeGenerator)),
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100470 number_of_core_registers_(number_of_core_registers),
471 number_of_fpu_registers_(number_of_fpu_registers),
472 number_of_register_pairs_(number_of_register_pairs),
Nicolas Geoffray98893962015-01-21 12:32:32 +0000473 core_callee_save_mask_(core_callee_save_mask),
474 fpu_callee_save_mask_(fpu_callee_save_mask),
Vladimir Markocf93a5c2015-06-16 11:33:24 +0000475 stack_map_stream_(graph->GetArena()),
476 block_order_(nullptr),
Roland Levillain3e3d7332015-04-28 11:00:54 +0100477 is_baseline_(false),
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100478 disasm_info_(nullptr),
Serban Constantinescuecc43662015-08-13 13:33:12 +0100479 stats_(stats),
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000480 graph_(graph),
Calin Juravlecd6dffe2015-01-08 17:35:35 +0000481 compiler_options_(compiler_options),
Yevgeny Rouban2a7c1ef2015-07-22 18:36:24 +0600482 src_map_(nullptr),
Vladimir Marko225b6462015-09-28 12:17:40 +0100483 slow_paths_(graph->GetArena()->Adapter(kArenaAllocCodeGenerator)),
Nicolas Geoffray4c204ba2015-02-03 15:12:35 +0000484 current_block_index_(0),
Nicolas Geoffray39468442014-09-02 15:17:15 +0100485 is_leaf_(true),
Vladimir Marko225b6462015-09-28 12:17:40 +0100486 requires_current_method_(false) {
487 slow_paths_.reserve(8);
488 }
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000489
Nicolas Geoffraya7aca372014-04-28 17:47:12 +0100490 // Register allocation logic.
491 void AllocateRegistersLocally(HInstruction* instruction) const;
492
493 // Backend specific implementation for allocating a register.
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100494 virtual Location AllocateFreeRegister(Primitive::Type type) const = 0;
Nicolas Geoffraya7aca372014-04-28 17:47:12 +0100495
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100496 static size_t FindFreeEntry(bool* array, size_t length);
Nicolas Geoffray3c035032014-10-28 10:46:40 +0000497 static size_t FindTwoFreeConsecutiveAlignedEntries(bool* array, size_t length);
Nicolas Geoffraya7aca372014-04-28 17:47:12 +0100498
Nicolas Geoffraya7aca372014-04-28 17:47:12 +0100499 virtual Location GetStackLocation(HLoadLocal* load) const = 0;
500
Nicolas Geoffrayc0572a42015-02-06 14:35:25 +0000501 virtual HGraphVisitor* GetLocationBuilder() = 0;
502 virtual HGraphVisitor* GetInstructionVisitor() = 0;
Nicolas Geoffrayf0e39372014-11-12 17:50:07 +0000503
Nicolas Geoffrayd97dc402015-01-22 13:50:01 +0000504 // Returns the location of the first spilled entry for floating point registers,
505 // relative to the stack pointer.
506 uint32_t GetFpuSpillStart() const {
Nicolas Geoffrayd97dc402015-01-22 13:50:01 +0000507 return GetFrameSize() - FrameEntrySpillSize();
508 }
509
510 uint32_t GetFpuSpillSize() const {
511 return POPCOUNT(fpu_spill_mask_) * GetFloatingPointSpillSlotSize();
512 }
513
514 uint32_t GetCoreSpillSize() const {
515 return POPCOUNT(core_spill_mask_) * GetWordSize();
516 }
517
Nicolas Geoffrayc0572a42015-02-06 14:35:25 +0000518 bool HasAllocatedCalleeSaveRegisters() const {
519 // We check the core registers against 1 because it always comprises the return PC.
520 return (POPCOUNT(allocated_registers_.GetCoreRegisters() & core_callee_save_mask_) != 1)
521 || (POPCOUNT(allocated_registers_.GetFloatingPointRegisters() & fpu_callee_save_mask_) != 0);
522 }
523
524 bool CallPushesPC() const {
525 InstructionSet instruction_set = GetInstructionSet();
526 return instruction_set == kX86 || instruction_set == kX86_64;
527 }
528
Vladimir Marko225b6462015-09-28 12:17:40 +0100529 // Arm64 has its own type for a label, so we need to templatize these methods
Nicolas Geoffraydc23d832015-02-16 11:15:43 +0000530 // to share the logic.
Vladimir Marko225b6462015-09-28 12:17:40 +0100531
532 template <typename LabelType>
533 LabelType* CommonInitializeLabels() {
534 size_t size = GetGraph()->GetBlocks().size();
535 LabelType* labels = GetGraph()->GetArena()->AllocArray<LabelType>(size,
536 kArenaAllocCodeGenerator);
537 for (size_t i = 0; i != size; ++i) {
538 new(labels + i) LabelType();
539 }
540 return labels;
541 }
542
Vladimir Marko58155012015-08-19 12:49:41 +0000543 template <typename LabelType>
544 LabelType* CommonGetLabelOf(LabelType* raw_pointer_to_labels_array, HBasicBlock* block) const {
Nicolas Geoffraydc23d832015-02-16 11:15:43 +0000545 block = FirstNonEmptyBlock(block);
546 return raw_pointer_to_labels_array + block->GetBlockId();
547 }
548
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +0000549 // Frame size required for this method.
550 uint32_t frame_size_;
551 uint32_t core_spill_mask_;
Nicolas Geoffrayd97dc402015-01-22 13:50:01 +0000552 uint32_t fpu_spill_mask_;
Nicolas Geoffray3bca0df2014-09-19 11:01:00 +0100553 uint32_t first_register_slot_in_slow_path_;
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +0000554
Nicolas Geoffray98893962015-01-21 12:32:32 +0000555 // Registers that were allocated during linear scan.
556 RegisterSet allocated_registers_;
557
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100558 // Arrays used when doing register allocation to know which
559 // registers we can allocate. `SetupBlockedRegisters` updates the
560 // arrays.
561 bool* const blocked_core_registers_;
562 bool* const blocked_fpu_registers_;
563 bool* const blocked_register_pairs_;
564 size_t number_of_core_registers_;
565 size_t number_of_fpu_registers_;
566 size_t number_of_register_pairs_;
Nicolas Geoffray98893962015-01-21 12:32:32 +0000567 const uint32_t core_callee_save_mask_;
568 const uint32_t fpu_callee_save_mask_;
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100569
Vladimir Markocf93a5c2015-06-16 11:33:24 +0000570 StackMapStream stack_map_stream_;
571
572 // The order to use for code generation.
Vladimir Markofa6b93c2015-09-15 10:15:55 +0100573 const ArenaVector<HBasicBlock*>* block_order_;
Vladimir Markocf93a5c2015-06-16 11:33:24 +0000574
Roland Levillain3e3d7332015-04-28 11:00:54 +0100575 // Whether we are using baseline.
576 bool is_baseline_;
577
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100578 DisassemblyInformation* disasm_info_;
579
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000580 private:
Nicolas Geoffrayc0572a42015-02-06 14:35:25 +0000581 void InitLocationsBaseline(HInstruction* instruction);
Nicolas Geoffray3bca0df2014-09-19 11:01:00 +0100582 size_t GetStackOffsetOfSavedRegister(size_t index);
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100583 void GenerateSlowPaths();
Nicolas Geoffray4c204ba2015-02-03 15:12:35 +0000584 void CompileInternal(CodeAllocator* allocator, bool is_baseline);
Mark Mendell5f874182015-03-04 15:42:45 -0500585 void BlockIfInRegister(Location location, bool is_out = false) const;
Nicolas Geoffrayb1d0f3f2015-05-14 12:41:51 +0100586 void EmitEnvironment(HEnvironment* environment, SlowPathCode* slow_path);
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000587
Serban Constantinescuecc43662015-08-13 13:33:12 +0100588 OptimizingCompilerStats* stats_;
589
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000590 HGraph* const graph_;
Calin Juravlecd6dffe2015-01-08 17:35:35 +0000591 const CompilerOptions& compiler_options_;
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000592
Yevgeny Rouban2a7c1ef2015-07-22 18:36:24 +0600593 // Native to dex_pc map used for native debugging/profiling tools.
594 DefaultSrcMap* src_map_;
Vladimir Marko225b6462015-09-28 12:17:40 +0100595 ArenaVector<SlowPathCode*> slow_paths_;
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000596
Nicolas Geoffray4c204ba2015-02-03 15:12:35 +0000597 // The current block index in `block_order_` of the block
598 // we are generating code for.
599 size_t current_block_index_;
600
Nicolas Geoffrayc0572a42015-02-06 14:35:25 +0000601 // Whether the method is a leaf method.
Nicolas Geoffrayf12feb82014-07-17 18:32:41 +0100602 bool is_leaf_;
603
Nicolas Geoffrayc0572a42015-02-06 14:35:25 +0000604 // Whether an instruction in the graph accesses the current method.
605 bool requires_current_method_;
606
David Srbeckyc6b4dd82015-04-07 20:32:43 +0100607 friend class OptimizingCFITest;
608
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000609 DISALLOW_COPY_AND_ASSIGN(CodeGenerator);
610};
611
Nicolas Geoffray7fb49da2014-10-06 09:12:41 +0100612template <typename C, typename F>
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100613class CallingConvention {
614 public:
Nicolas Geoffray7fb49da2014-10-06 09:12:41 +0100615 CallingConvention(const C* registers,
616 size_t number_of_registers,
617 const F* fpu_registers,
Mathieu Chartiere401d142015-04-22 13:56:20 -0700618 size_t number_of_fpu_registers,
619 size_t pointer_size)
Nicolas Geoffray7fb49da2014-10-06 09:12:41 +0100620 : registers_(registers),
621 number_of_registers_(number_of_registers),
622 fpu_registers_(fpu_registers),
Mathieu Chartiere401d142015-04-22 13:56:20 -0700623 number_of_fpu_registers_(number_of_fpu_registers),
624 pointer_size_(pointer_size) {}
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100625
626 size_t GetNumberOfRegisters() const { return number_of_registers_; }
Nicolas Geoffray7fb49da2014-10-06 09:12:41 +0100627 size_t GetNumberOfFpuRegisters() const { return number_of_fpu_registers_; }
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100628
Nicolas Geoffray7fb49da2014-10-06 09:12:41 +0100629 C GetRegisterAt(size_t index) const {
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100630 DCHECK_LT(index, number_of_registers_);
631 return registers_[index];
632 }
633
Nicolas Geoffray7fb49da2014-10-06 09:12:41 +0100634 F GetFpuRegisterAt(size_t index) const {
635 DCHECK_LT(index, number_of_fpu_registers_);
636 return fpu_registers_[index];
637 }
638
639 size_t GetStackOffsetOf(size_t index) const {
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100640 // We still reserve the space for parameters passed by registers.
Mathieu Chartiere401d142015-04-22 13:56:20 -0700641 // Add space for the method pointer.
642 return pointer_size_ + index * kVRegSize;
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100643 }
644
645 private:
Nicolas Geoffray7fb49da2014-10-06 09:12:41 +0100646 const C* registers_;
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100647 const size_t number_of_registers_;
Nicolas Geoffray7fb49da2014-10-06 09:12:41 +0100648 const F* fpu_registers_;
649 const size_t number_of_fpu_registers_;
Mathieu Chartiere401d142015-04-22 13:56:20 -0700650 const size_t pointer_size_;
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100651
652 DISALLOW_COPY_AND_ASSIGN(CallingConvention);
653};
654
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000655} // namespace art
656
657#endif // ART_COMPILER_OPTIMIZING_CODE_GENERATOR_H_