blob: a92014dc79800f782f5717b2fa255f9661598f6f [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"
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +000025#include "compiled_method.h"
Calin Juravlecd6dffe2015-01-08 17:35:35 +000026#include "driver/compiler_options.h"
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +000027#include "globals.h"
Alexandre Rameseb7b7392015-06-19 14:47:01 +010028#include "graph_visualizer.h"
Nicolas Geoffray4e3d23a2014-05-22 18:32:45 +010029#include "locations.h"
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +000030#include "memory_region.h"
31#include "nodes.h"
Serban Constantinescuecc43662015-08-13 13:33:12 +010032#include "optimizing_compiler_stats.h"
Nicolas Geoffray39468442014-09-02 15:17:15 +010033#include "stack_map_stream.h"
Andreas Gampe85b62f22015-09-09 13:15:38 -070034#include "utils/label.h"
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +000035
36namespace art {
37
Roland Levillain6d0e4832014-11-27 18:31:21 +000038// Binary encoding of 2^32 for type double.
39static int64_t constexpr k2Pow32EncodingForDouble = INT64_C(0x41F0000000000000);
40// Binary encoding of 2^31 for type double.
41static int64_t constexpr k2Pow31EncodingForDouble = INT64_C(0x41E0000000000000);
42
Mark Mendelle82549b2015-05-06 10:55:34 -040043// Minimum value for a primitive integer.
44static int32_t constexpr kPrimIntMin = 0x80000000;
45// Minimum value for a primitive long.
46static int64_t constexpr kPrimLongMin = INT64_C(0x8000000000000000);
47
Roland Levillain3f8f9362014-12-02 17:45:01 +000048// Maximum value for a primitive integer.
49static int32_t constexpr kPrimIntMax = 0x7fffffff;
Roland Levillain624279f2014-12-04 11:54:28 +000050// Maximum value for a primitive long.
Mark Mendelle82549b2015-05-06 10:55:34 -040051static int64_t constexpr kPrimLongMax = INT64_C(0x7fffffffffffffff);
Roland Levillain3f8f9362014-12-02 17:45:01 +000052
Nicolas Geoffray92a73ae2014-10-16 11:12:52 +010053class Assembler;
Nicolas Geoffraye5038322014-07-04 09:41:32 +010054class CodeGenerator;
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +000055class CompilerDriver;
Vladimir Marko58155012015-08-19 12:49:41 +000056class LinkerPatch;
Nicolas Geoffrayf0e39372014-11-12 17:50:07 +000057class ParallelMoveResolver;
Nicolas Geoffray92cf83e2014-03-18 17:59:20 +000058
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +000059class CodeAllocator {
60 public:
Nicolas Geoffraye5038322014-07-04 09:41:32 +010061 CodeAllocator() {}
62 virtual ~CodeAllocator() {}
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +000063
64 virtual uint8_t* Allocate(size_t size) = 0;
65
66 private:
67 DISALLOW_COPY_AND_ASSIGN(CodeAllocator);
68};
69
Ian Rogers6a3c1fc2014-10-31 00:33:20 -070070class SlowPathCode : public ArenaObject<kArenaAllocSlowPaths> {
Nicolas Geoffraye5038322014-07-04 09:41:32 +010071 public:
Nicolas Geoffrayeeefa122015-03-13 18:52:59 +000072 SlowPathCode() {
73 for (size_t i = 0; i < kMaximumNumberOfExpectedRegisters; ++i) {
74 saved_core_stack_offsets_[i] = kRegisterNotSaved;
75 saved_fpu_stack_offsets_[i] = kRegisterNotSaved;
76 }
77 }
78
Nicolas Geoffraye5038322014-07-04 09:41:32 +010079 virtual ~SlowPathCode() {}
80
Nicolas Geoffraye5038322014-07-04 09:41:32 +010081 virtual void EmitNativeCode(CodeGenerator* codegen) = 0;
82
Zheng Xuda403092015-04-24 17:35:39 +080083 virtual void SaveLiveRegisters(CodeGenerator* codegen, LocationSummary* locations);
84 virtual void RestoreLiveRegisters(CodeGenerator* codegen, LocationSummary* locations);
Nicolas Geoffraya8ac9132015-03-13 16:36:36 +000085
Nicolas Geoffrayeeefa122015-03-13 18:52:59 +000086 bool IsCoreRegisterSaved(int reg) const {
87 return saved_core_stack_offsets_[reg] != kRegisterNotSaved;
88 }
89
90 bool IsFpuRegisterSaved(int reg) const {
91 return saved_fpu_stack_offsets_[reg] != kRegisterNotSaved;
92 }
93
94 uint32_t GetStackOffsetOfCoreRegister(int reg) const {
95 return saved_core_stack_offsets_[reg];
96 }
97
98 uint32_t GetStackOffsetOfFpuRegister(int reg) const {
99 return saved_fpu_stack_offsets_[reg];
100 }
101
Alexandre Rames8158f282015-08-07 10:26:17 +0100102 virtual bool IsFatal() const { return false; }
103
Alexandre Rames9931f312015-06-19 14:47:01 +0100104 virtual const char* GetDescription() const = 0;
105
Andreas Gampe85b62f22015-09-09 13:15:38 -0700106 Label* GetEntryLabel() { return &entry_label_; }
107 Label* GetExitLabel() { return &exit_label_; }
108
Zheng Xuda403092015-04-24 17:35:39 +0800109 protected:
Nicolas Geoffrayeeefa122015-03-13 18:52:59 +0000110 static constexpr size_t kMaximumNumberOfExpectedRegisters = 32;
111 static constexpr uint32_t kRegisterNotSaved = -1;
112 uint32_t saved_core_stack_offsets_[kMaximumNumberOfExpectedRegisters];
113 uint32_t saved_fpu_stack_offsets_[kMaximumNumberOfExpectedRegisters];
Zheng Xuda403092015-04-24 17:35:39 +0800114
115 private:
Andreas Gampe85b62f22015-09-09 13:15:38 -0700116 Label entry_label_;
117 Label exit_label_;
118
Nicolas Geoffraye5038322014-07-04 09:41:32 +0100119 DISALLOW_COPY_AND_ASSIGN(SlowPathCode);
120};
121
Roland Levillain2d27c8e2015-04-28 15:48:45 +0100122class InvokeDexCallingConventionVisitor {
123 public:
124 virtual Location GetNextLocation(Primitive::Type type) = 0;
Nicolas Geoffrayfd88f162015-06-03 11:23:52 +0100125 virtual Location GetReturnLocation(Primitive::Type type) const = 0;
126 virtual Location GetMethodLocation() const = 0;
Roland Levillain2d27c8e2015-04-28 15:48:45 +0100127
128 protected:
129 InvokeDexCallingConventionVisitor() {}
130 virtual ~InvokeDexCallingConventionVisitor() {}
131
132 // The current index for core registers.
133 uint32_t gp_index_ = 0u;
134 // The current index for floating-point registers.
135 uint32_t float_index_ = 0u;
136 // The current stack index.
137 uint32_t stack_index_ = 0u;
138
139 private:
140 DISALLOW_COPY_AND_ASSIGN(InvokeDexCallingConventionVisitor);
141};
142
Calin Juravlee460d1d2015-09-29 04:52:17 +0100143class FieldAccessCallingConvention {
144 public:
145 virtual Location GetObjectLocation() const = 0;
146 virtual Location GetFieldIndexLocation() const = 0;
147 virtual Location GetReturnLocation(Primitive::Type type) const = 0;
148 virtual Location GetSetValueLocation(Primitive::Type type, bool is_instance) const = 0;
149 virtual Location GetFpuLocation(Primitive::Type type) const = 0;
150 virtual ~FieldAccessCallingConvention() {}
151
152 protected:
153 FieldAccessCallingConvention() {}
154
155 private:
156 DISALLOW_COPY_AND_ASSIGN(FieldAccessCallingConvention);
157};
158
Nicolas Geoffray12df9eb2015-01-09 14:53:50 +0000159class CodeGenerator {
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000160 public:
161 // Compiles the graph to executable instructions. Returns whether the compilation
162 // succeeded.
Nicolas Geoffray73e80c32014-07-22 17:47:56 +0100163 void CompileBaseline(CodeAllocator* allocator, bool is_leaf = false);
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100164 void CompileOptimized(CodeAllocator* allocator);
Nicolas Geoffray12df9eb2015-01-09 14:53:50 +0000165 static CodeGenerator* Create(HGraph* graph,
Calin Juravle34166012014-12-19 17:22:29 +0000166 InstructionSet instruction_set,
Calin Juravlecd6dffe2015-01-08 17:35:35 +0000167 const InstructionSetFeatures& isa_features,
Serban Constantinescuecc43662015-08-13 13:33:12 +0100168 const CompilerOptions& compiler_options,
169 OptimizingCompilerStats* stats = nullptr);
Nicolas Geoffray12df9eb2015-01-09 14:53:50 +0000170 virtual ~CodeGenerator() {}
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000171
Vladimir Markodc151b22015-10-15 18:02:30 +0100172 // Get the graph. This is the outermost graph, never the graph of a method being inlined.
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000173 HGraph* GetGraph() const { return graph_; }
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000174
Nicolas Geoffraydc23d832015-02-16 11:15:43 +0000175 HBasicBlock* GetNextBlockToEmit() const;
176 HBasicBlock* FirstNonEmptyBlock(HBasicBlock* block) const;
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000177 bool GoesToNextBlock(HBasicBlock* current, HBasicBlock* next) const;
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000178
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100179 size_t GetStackSlotOfParameter(HParameterValue* parameter) const {
180 // Note that this follows the current calling convention.
181 return GetFrameSize()
Mathieu Chartiere401d142015-04-22 13:56:20 -0700182 + InstructionSetPointerSize(GetInstructionSet()) // Art method
Nicolas Geoffraye27f31a2014-06-12 17:53:14 +0100183 + parameter->GetIndex() * kVRegSize;
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100184 }
185
Nicolas Geoffray92a73ae2014-10-16 11:12:52 +0100186 virtual void Initialize() = 0;
Serban Constantinescu32f5b4d2014-11-25 20:05:46 +0000187 virtual void Finalize(CodeAllocator* allocator);
Vladimir Marko58155012015-08-19 12:49:41 +0000188 virtual void EmitLinkerPatches(ArenaVector<LinkerPatch>* linker_patches);
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000189 virtual void GenerateFrameEntry() = 0;
190 virtual void GenerateFrameExit() = 0;
Nicolas Geoffray92a73ae2014-10-16 11:12:52 +0100191 virtual void Bind(HBasicBlock* block) = 0;
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100192 virtual void Move(HInstruction* instruction, Location location, HInstruction* move_for) = 0;
Calin Juravle175dc732015-08-25 15:42:32 +0100193 virtual void MoveConstant(Location destination, int32_t value) = 0;
Calin Juravlee460d1d2015-09-29 04:52:17 +0100194 virtual void MoveLocation(Location dst, Location src, Primitive::Type dst_type) = 0;
195 virtual void AddLocationAsTemp(Location location, LocationSummary* locations) = 0;
196
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000197 virtual Assembler* GetAssembler() = 0;
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100198 virtual const Assembler& GetAssembler() const = 0;
Nicolas Geoffray707c8092014-04-04 10:50:14 +0100199 virtual size_t GetWordSize() const = 0;
Mark Mendellf85a9ca2015-01-13 09:20:58 -0500200 virtual size_t GetFloatingPointSpillSlotSize() const = 0;
Nicolas Geoffrayde58ab22014-11-05 12:46:03 +0000201 virtual uintptr_t GetAddressOf(HBasicBlock* block) const = 0;
Nicolas Geoffray4c204ba2015-02-03 15:12:35 +0000202 void InitializeCodeGeneration(size_t number_of_spill_slots,
203 size_t maximum_number_of_live_core_registers,
204 size_t maximum_number_of_live_fp_registers,
205 size_t number_of_out_slots,
Vladimir Markofa6b93c2015-09-15 10:15:55 +0100206 const ArenaVector<HBasicBlock*>& block_order);
Nicolas Geoffrayab032bc2014-07-15 12:55:21 +0100207 int32_t GetStackSlot(HLocal* local) const;
208 Location GetTemporaryLocation(HTemporary* temp) const;
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000209
210 uint32_t GetFrameSize() const { return frame_size_; }
211 void SetFrameSize(uint32_t size) { frame_size_ = size; }
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +0000212 uint32_t GetCoreSpillMask() const { return core_spill_mask_; }
Nicolas Geoffrayd97dc402015-01-22 13:50:01 +0000213 uint32_t GetFpuSpillMask() const { return fpu_spill_mask_; }
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000214
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100215 size_t GetNumberOfCoreRegisters() const { return number_of_core_registers_; }
216 size_t GetNumberOfFloatingPointRegisters() const { return number_of_fpu_registers_; }
Nicolas Geoffray98893962015-01-21 12:32:32 +0000217 virtual void SetupBlockedRegisters(bool is_baseline) const = 0;
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100218
Nicolas Geoffray4dee6362015-01-23 18:23:14 +0000219 virtual void ComputeSpillMask() {
220 core_spill_mask_ = allocated_registers_.GetCoreRegisters() & core_callee_save_mask_;
221 DCHECK_NE(core_spill_mask_, 0u) << "At least the return address register must be saved";
222 fpu_spill_mask_ = allocated_registers_.GetFloatingPointRegisters() & fpu_callee_save_mask_;
223 }
224
225 static uint32_t ComputeRegisterMask(const int* registers, size_t length) {
226 uint32_t mask = 0;
227 for (size_t i = 0, e = length; i < e; ++i) {
228 mask |= (1 << registers[i]);
229 }
230 return mask;
231 }
232
Nicolas Geoffraya7062e02014-05-22 12:50:17 +0100233 virtual void DumpCoreRegister(std::ostream& stream, int reg) const = 0;
234 virtual void DumpFloatingPointRegister(std::ostream& stream, int reg) const = 0;
Nicolas Geoffray412f10c2014-06-19 10:00:34 +0100235 virtual InstructionSet GetInstructionSet() const = 0;
Calin Juravlecd6dffe2015-01-08 17:35:35 +0000236
237 const CompilerOptions& GetCompilerOptions() const { return compiler_options_; }
238
Serban Constantinescuecc43662015-08-13 13:33:12 +0100239 void MaybeRecordStat(MethodCompilationStat compilation_stat, size_t count = 1) const;
240
Nicolas Geoffray102cbed2014-10-15 18:31:05 +0100241 // Saves the register in the stack. Returns the size taken on stack.
242 virtual size_t SaveCoreRegister(size_t stack_index, uint32_t reg_id) = 0;
243 // Restores the register from the stack. Returns the size taken on stack.
244 virtual size_t RestoreCoreRegister(size_t stack_index, uint32_t reg_id) = 0;
Nicolas Geoffray234d69d2015-03-09 10:28:50 +0000245
246 virtual size_t SaveFloatingPointRegister(size_t stack_index, uint32_t reg_id) = 0;
247 virtual size_t RestoreFloatingPointRegister(size_t stack_index, uint32_t reg_id) = 0;
248
Nicolas Geoffray840e5462015-01-07 16:01:24 +0000249 virtual bool NeedsTwoRegisters(Primitive::Type type) const = 0;
Nicolas Geoffray234d69d2015-03-09 10:28:50 +0000250 // Returns whether we should split long moves in parallel moves.
251 virtual bool ShouldSplitLongMoves() const { return false; }
Nicolas Geoffraya7062e02014-05-22 12:50:17 +0100252
Nicolas Geoffray98893962015-01-21 12:32:32 +0000253 bool IsCoreCalleeSaveRegister(int reg) const {
254 return (core_callee_save_mask_ & (1 << reg)) != 0;
255 }
256
257 bool IsFloatingPointCalleeSaveRegister(int reg) const {
258 return (fpu_callee_save_mask_ & (1 << reg)) != 0;
259 }
260
Yevgeny Rouban2a7c1ef2015-07-22 18:36:24 +0600261 // Record native to dex mapping for a suspend point. Required by runtime.
Nicolas Geoffrayeeefa122015-03-13 18:52:59 +0000262 void RecordPcInfo(HInstruction* instruction, uint32_t dex_pc, SlowPathCode* slow_path = nullptr);
Yevgeny Rouban2a7c1ef2015-07-22 18:36:24 +0600263 // Record additional native to dex mappings for native debugging/profiling tools.
264 void RecordNativeDebugInfo(uint32_t dex_pc, uintptr_t native_pc_begin, uintptr_t native_pc_end);
265
Calin Juravle77520bc2015-01-12 18:45:46 +0000266 bool CanMoveNullCheckToUser(HNullCheck* null_check);
267 void MaybeRecordImplicitNullCheck(HInstruction* instruction);
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +0000268
David Brazdil77a48ae2015-09-15 12:34:04 +0000269 // Records a stack map which the runtime might use to set catch phi values
270 // during exception delivery.
271 // TODO: Replace with a catch-entering instruction that records the environment.
272 void RecordCatchBlockInfo();
273
274 // Returns true if implicit null checks are allowed in the compiler options
275 // and if the null check is not inside a try block. We currently cannot do
276 // implicit null checks in that case because we need the NullCheckSlowPath to
277 // save live registers, which may be needed by the runtime to set catch phis.
278 bool IsImplicitNullCheckAllowed(HNullCheck* null_check) const;
279
Nicolas Geoffraye5038322014-07-04 09:41:32 +0100280 void AddSlowPath(SlowPathCode* slow_path) {
Vladimir Marko225b6462015-09-28 12:17:40 +0100281 slow_paths_.push_back(slow_path);
Nicolas Geoffraye5038322014-07-04 09:41:32 +0100282 }
283
Vladimir Markof9f64412015-09-02 14:05:49 +0100284 void BuildMappingTable(ArenaVector<uint8_t>* vector) const;
285 void BuildVMapTable(ArenaVector<uint8_t>* vector) const;
Nicolas Geoffray92cf83e2014-03-18 17:59:20 +0000286 void BuildNativeGCMap(
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +0000287 ArenaVector<uint8_t>* vector, const CompilerDriver& compiler_driver) const;
288 void BuildStackMaps(MemoryRegion region);
289 size_t ComputeStackMapsSize();
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000290
Roland Levillain3e3d7332015-04-28 11:00:54 +0100291 bool IsBaseline() const {
292 return is_baseline_;
293 }
294
Nicolas Geoffrayf12feb82014-07-17 18:32:41 +0100295 bool IsLeafMethod() const {
296 return is_leaf_;
297 }
298
299 void MarkNotLeaf() {
300 is_leaf_ = false;
Nicolas Geoffrayc0572a42015-02-06 14:35:25 +0000301 requires_current_method_ = true;
302 }
303
304 void SetRequiresCurrentMethod() {
305 requires_current_method_ = true;
306 }
307
308 bool RequiresCurrentMethod() const {
309 return requires_current_method_;
Nicolas Geoffrayf12feb82014-07-17 18:32:41 +0100310 }
311
Nicolas Geoffray3c049742014-09-24 18:10:46 +0100312 // Clears the spill slots taken by loop phis in the `LocationSummary` of the
313 // suspend check. This is called when the code generator generates code
314 // for the suspend check at the back edge (instead of where the suspend check
315 // is, which is the loop entry). At this point, the spill slots for the phis
316 // have not been written to.
317 void ClearSpillSlotsFromLoopPhisInStackMap(HSuspendCheck* suspend_check) const;
318
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100319 bool* GetBlockedCoreRegisters() const { return blocked_core_registers_; }
Nicolas Geoffray102cbed2014-10-15 18:31:05 +0100320 bool* GetBlockedFloatingPointRegisters() const { return blocked_fpu_registers_; }
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100321
Nicolas Geoffray19a19cf2014-10-22 16:07:05 +0100322 // Helper that returns the pointer offset of an index in an object array.
323 // Note: this method assumes we always have the same pointer size, regardless
324 // of the architecture.
325 static size_t GetCacheOffset(uint32_t index);
Mathieu Chartiere401d142015-04-22 13:56:20 -0700326 // Pointer variant for ArtMethod and ArtField arrays.
327 size_t GetCachePointerOffset(uint32_t index);
Nicolas Geoffray19a19cf2014-10-22 16:07:05 +0100328
Nicolas Geoffray90218252015-04-15 11:56:51 +0100329 void EmitParallelMoves(Location from1,
330 Location to1,
331 Primitive::Type type1,
332 Location from2,
333 Location to2,
334 Primitive::Type type2);
Nicolas Geoffrayf0e39372014-11-12 17:50:07 +0000335
Nicolas Geoffrayaf07bc12014-11-12 18:08:09 +0000336 static bool StoreNeedsWriteBarrier(Primitive::Type type, HInstruction* value) {
David Brazdil522e2242015-03-17 18:48:28 +0000337 // Check that null value is not represented as an integer constant.
338 DCHECK(type != Primitive::kPrimNot || !value->IsIntConstant());
339 return type == Primitive::kPrimNot && !value->IsNullConstant();
Nicolas Geoffrayaf07bc12014-11-12 18:08:09 +0000340 }
341
Alexandre Rames78e3ef62015-08-12 13:43:29 +0100342 void ValidateInvokeRuntime(HInstruction* instruction, SlowPathCode* slow_path);
343
Nicolas Geoffray98893962015-01-21 12:32:32 +0000344 void AddAllocatedRegister(Location location) {
345 allocated_registers_.Add(location);
346 }
347
Nicolas Geoffray45b83af2015-07-06 15:12:53 +0000348 bool HasAllocatedRegister(bool is_core, int reg) const {
349 return is_core
350 ? allocated_registers_.ContainsCoreRegister(reg)
351 : allocated_registers_.ContainsFloatingPointRegister(reg);
352 }
353
Nicolas Geoffrayc0572a42015-02-06 14:35:25 +0000354 void AllocateLocations(HInstruction* instruction);
355
Roland Levillainaa9b7c42015-02-17 15:40:09 +0000356 // Tells whether the stack frame of the compiled method is
357 // considered "empty", that is either actually having a size of zero,
358 // or just containing the saved return address register.
359 bool HasEmptyFrame() const {
360 return GetFrameSize() == (CallPushesPC() ? GetWordSize() : 0);
361 }
362
Nicolas Geoffrayd6138ef2015-02-18 14:48:53 +0000363 static int32_t GetInt32ValueOf(HConstant* constant) {
364 if (constant->IsIntConstant()) {
365 return constant->AsIntConstant()->GetValue();
366 } else if (constant->IsNullConstant()) {
367 return 0;
368 } else {
369 DCHECK(constant->IsFloatConstant());
Roland Levillainda4d79b2015-03-24 14:36:11 +0000370 return bit_cast<int32_t, float>(constant->AsFloatConstant()->GetValue());
Nicolas Geoffrayd6138ef2015-02-18 14:48:53 +0000371 }
372 }
373
374 static int64_t GetInt64ValueOf(HConstant* constant) {
375 if (constant->IsIntConstant()) {
376 return constant->AsIntConstant()->GetValue();
377 } else if (constant->IsNullConstant()) {
378 return 0;
379 } else if (constant->IsFloatConstant()) {
Roland Levillainda4d79b2015-03-24 14:36:11 +0000380 return bit_cast<int32_t, float>(constant->AsFloatConstant()->GetValue());
Nicolas Geoffrayd6138ef2015-02-18 14:48:53 +0000381 } else if (constant->IsLongConstant()) {
382 return constant->AsLongConstant()->GetValue();
383 } else {
384 DCHECK(constant->IsDoubleConstant());
Roland Levillainda4d79b2015-03-24 14:36:11 +0000385 return bit_cast<int64_t, double>(constant->AsDoubleConstant()->GetValue());
Nicolas Geoffrayd6138ef2015-02-18 14:48:53 +0000386 }
387 }
388
Nicolas Geoffraya8ac9132015-03-13 16:36:36 +0000389 size_t GetFirstRegisterSlotInSlowPath() const {
390 return first_register_slot_in_slow_path_;
391 }
392
393 uint32_t FrameEntrySpillSize() const {
394 return GetFpuSpillSize() + GetCoreSpillSize();
395 }
396
Roland Levillainec525fc2015-04-28 15:50:20 +0100397 virtual ParallelMoveResolver* GetMoveResolver() = 0;
Nicolas Geoffraya8ac9132015-03-13 16:36:36 +0000398
Nicolas Geoffrayfd88f162015-06-03 11:23:52 +0100399 static void CreateCommonInvokeLocationSummary(
400 HInvoke* invoke, InvokeDexCallingConventionVisitor* visitor);
401
Calin Juravle175dc732015-08-25 15:42:32 +0100402 void GenerateInvokeUnresolvedRuntimeCall(HInvokeUnresolved* invoke);
403
Calin Juravlee460d1d2015-09-29 04:52:17 +0100404 void CreateUnresolvedFieldLocationSummary(
405 HInstruction* field_access,
406 Primitive::Type field_type,
407 const FieldAccessCallingConvention& calling_convention);
408
409 void GenerateUnresolvedFieldAccess(
410 HInstruction* field_access,
411 Primitive::Type field_type,
412 uint32_t field_index,
413 uint32_t dex_pc,
414 const FieldAccessCallingConvention& calling_convention);
415
Calin Juravle98893e12015-10-02 21:05:03 +0100416 // TODO: This overlaps a bit with MoveFromReturnRegister. Refactor for a better design.
417 static void CreateLoadClassLocationSummary(HLoadClass* cls,
418 Location runtime_type_index_location,
419 Location runtime_return_location);
420
Nicolas Geoffray5bd05a52015-10-13 09:48:30 +0100421 static void CreateSystemArrayCopyLocationSummary(HInvoke* invoke);
422
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100423 void SetDisassemblyInformation(DisassemblyInformation* info) { disasm_info_ = info; }
424 DisassemblyInformation* GetDisassemblyInformation() const { return disasm_info_; }
425
Calin Juravle175dc732015-08-25 15:42:32 +0100426 virtual void InvokeRuntime(QuickEntrypointEnum entrypoint,
427 HInstruction* instruction,
428 uint32_t dex_pc,
429 SlowPathCode* slow_path) = 0;
430
Vladimir Markodc151b22015-10-15 18:02:30 +0100431 // Check if the desired_dispatch_info is supported. If it is, return it,
432 // otherwise return a fall-back info that should be used instead.
433 virtual HInvokeStaticOrDirect::DispatchInfo GetSupportedInvokeStaticOrDirectDispatch(
434 const HInvokeStaticOrDirect::DispatchInfo& desired_dispatch_info,
435 MethodReference target_method) = 0;
436
Andreas Gampe85b62f22015-09-09 13:15:38 -0700437 // Generate a call to a static or direct method.
438 virtual void GenerateStaticOrDirectCall(HInvokeStaticOrDirect* invoke, Location temp) = 0;
439 // Generate a call to a virtual method.
440 virtual void GenerateVirtualCall(HInvokeVirtual* invoke, Location temp) = 0;
441
442 // Copy the result of a call into the given target.
443 virtual void MoveFromReturnRegister(Location trg, Primitive::Type type) = 0;
444
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +0000445 const ArenaVector<SrcMapElem>& GetSrcMappingTable() const {
446 return src_map_;
447 }
448
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000449 protected:
Vladimir Marko58155012015-08-19 12:49:41 +0000450 // Method patch info used for recording locations of required linker patches and
451 // target methods. The target method can be used for various purposes, whether for
452 // patching the address of the method or the code pointer or a PC-relative call.
453 template <typename LabelType>
454 struct MethodPatchInfo {
455 explicit MethodPatchInfo(MethodReference m) : target_method(m), label() { }
456
457 MethodReference target_method;
458 LabelType label;
459 };
460
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100461 CodeGenerator(HGraph* graph,
462 size_t number_of_core_registers,
463 size_t number_of_fpu_registers,
Calin Juravlecd6dffe2015-01-08 17:35:35 +0000464 size_t number_of_register_pairs,
Nicolas Geoffray98893962015-01-21 12:32:32 +0000465 uint32_t core_callee_save_mask,
466 uint32_t fpu_callee_save_mask,
Serban Constantinescuecc43662015-08-13 13:33:12 +0100467 const CompilerOptions& compiler_options,
468 OptimizingCompilerStats* stats)
Nicolas Geoffrayc0572a42015-02-06 14:35:25 +0000469 : frame_size_(0),
Nicolas Geoffray4361bef2014-08-20 04:59:12 +0100470 core_spill_mask_(0),
Nicolas Geoffrayd97dc402015-01-22 13:50:01 +0000471 fpu_spill_mask_(0),
Nicolas Geoffray3bca0df2014-09-19 11:01:00 +0100472 first_register_slot_in_slow_path_(0),
Vladimir Marko5233f932015-09-29 19:01:15 +0100473 blocked_core_registers_(graph->GetArena()->AllocArray<bool>(number_of_core_registers,
474 kArenaAllocCodeGenerator)),
475 blocked_fpu_registers_(graph->GetArena()->AllocArray<bool>(number_of_fpu_registers,
476 kArenaAllocCodeGenerator)),
477 blocked_register_pairs_(graph->GetArena()->AllocArray<bool>(number_of_register_pairs,
478 kArenaAllocCodeGenerator)),
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100479 number_of_core_registers_(number_of_core_registers),
480 number_of_fpu_registers_(number_of_fpu_registers),
481 number_of_register_pairs_(number_of_register_pairs),
Nicolas Geoffray98893962015-01-21 12:32:32 +0000482 core_callee_save_mask_(core_callee_save_mask),
483 fpu_callee_save_mask_(fpu_callee_save_mask),
Vladimir Markocf93a5c2015-06-16 11:33:24 +0000484 stack_map_stream_(graph->GetArena()),
485 block_order_(nullptr),
Roland Levillain3e3d7332015-04-28 11:00:54 +0100486 is_baseline_(false),
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100487 disasm_info_(nullptr),
Serban Constantinescuecc43662015-08-13 13:33:12 +0100488 stats_(stats),
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000489 graph_(graph),
Calin Juravlecd6dffe2015-01-08 17:35:35 +0000490 compiler_options_(compiler_options),
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +0000491 src_map_(graph->GetArena()->Adapter(kArenaAllocCodeGenerator)),
Vladimir Marko225b6462015-09-28 12:17:40 +0100492 slow_paths_(graph->GetArena()->Adapter(kArenaAllocCodeGenerator)),
Nicolas Geoffray4c204ba2015-02-03 15:12:35 +0000493 current_block_index_(0),
Nicolas Geoffray39468442014-09-02 15:17:15 +0100494 is_leaf_(true),
Vladimir Marko225b6462015-09-28 12:17:40 +0100495 requires_current_method_(false) {
496 slow_paths_.reserve(8);
497 }
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000498
Nicolas Geoffraya7aca372014-04-28 17:47:12 +0100499 // Register allocation logic.
500 void AllocateRegistersLocally(HInstruction* instruction) const;
501
502 // Backend specific implementation for allocating a register.
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100503 virtual Location AllocateFreeRegister(Primitive::Type type) const = 0;
Nicolas Geoffraya7aca372014-04-28 17:47:12 +0100504
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100505 static size_t FindFreeEntry(bool* array, size_t length);
Nicolas Geoffray3c035032014-10-28 10:46:40 +0000506 static size_t FindTwoFreeConsecutiveAlignedEntries(bool* array, size_t length);
Nicolas Geoffraya7aca372014-04-28 17:47:12 +0100507
Nicolas Geoffraya7aca372014-04-28 17:47:12 +0100508 virtual Location GetStackLocation(HLoadLocal* load) const = 0;
509
Nicolas Geoffrayc0572a42015-02-06 14:35:25 +0000510 virtual HGraphVisitor* GetLocationBuilder() = 0;
511 virtual HGraphVisitor* GetInstructionVisitor() = 0;
Nicolas Geoffrayf0e39372014-11-12 17:50:07 +0000512
Nicolas Geoffrayd97dc402015-01-22 13:50:01 +0000513 // Returns the location of the first spilled entry for floating point registers,
514 // relative to the stack pointer.
515 uint32_t GetFpuSpillStart() const {
Nicolas Geoffrayd97dc402015-01-22 13:50:01 +0000516 return GetFrameSize() - FrameEntrySpillSize();
517 }
518
519 uint32_t GetFpuSpillSize() const {
520 return POPCOUNT(fpu_spill_mask_) * GetFloatingPointSpillSlotSize();
521 }
522
523 uint32_t GetCoreSpillSize() const {
524 return POPCOUNT(core_spill_mask_) * GetWordSize();
525 }
526
Nicolas Geoffrayc0572a42015-02-06 14:35:25 +0000527 bool HasAllocatedCalleeSaveRegisters() const {
528 // We check the core registers against 1 because it always comprises the return PC.
529 return (POPCOUNT(allocated_registers_.GetCoreRegisters() & core_callee_save_mask_) != 1)
530 || (POPCOUNT(allocated_registers_.GetFloatingPointRegisters() & fpu_callee_save_mask_) != 0);
531 }
532
533 bool CallPushesPC() const {
534 InstructionSet instruction_set = GetInstructionSet();
535 return instruction_set == kX86 || instruction_set == kX86_64;
536 }
537
Vladimir Marko225b6462015-09-28 12:17:40 +0100538 // Arm64 has its own type for a label, so we need to templatize these methods
Nicolas Geoffraydc23d832015-02-16 11:15:43 +0000539 // to share the logic.
Vladimir Marko225b6462015-09-28 12:17:40 +0100540
541 template <typename LabelType>
542 LabelType* CommonInitializeLabels() {
Vladimir Markob95fb772015-09-30 13:32:31 +0100543 // We use raw array allocations instead of ArenaVector<> because Labels are
544 // non-constructible and non-movable and as such cannot be held in a vector.
Vladimir Marko225b6462015-09-28 12:17:40 +0100545 size_t size = GetGraph()->GetBlocks().size();
546 LabelType* labels = GetGraph()->GetArena()->AllocArray<LabelType>(size,
547 kArenaAllocCodeGenerator);
548 for (size_t i = 0; i != size; ++i) {
549 new(labels + i) LabelType();
550 }
551 return labels;
552 }
553
Vladimir Marko58155012015-08-19 12:49:41 +0000554 template <typename LabelType>
555 LabelType* CommonGetLabelOf(LabelType* raw_pointer_to_labels_array, HBasicBlock* block) const {
Nicolas Geoffraydc23d832015-02-16 11:15:43 +0000556 block = FirstNonEmptyBlock(block);
557 return raw_pointer_to_labels_array + block->GetBlockId();
558 }
559
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +0000560 // Frame size required for this method.
561 uint32_t frame_size_;
562 uint32_t core_spill_mask_;
Nicolas Geoffrayd97dc402015-01-22 13:50:01 +0000563 uint32_t fpu_spill_mask_;
Nicolas Geoffray3bca0df2014-09-19 11:01:00 +0100564 uint32_t first_register_slot_in_slow_path_;
Nicolas Geoffray8ccc3f52014-03-19 10:34:11 +0000565
Nicolas Geoffray98893962015-01-21 12:32:32 +0000566 // Registers that were allocated during linear scan.
567 RegisterSet allocated_registers_;
568
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100569 // Arrays used when doing register allocation to know which
570 // registers we can allocate. `SetupBlockedRegisters` updates the
571 // arrays.
572 bool* const blocked_core_registers_;
573 bool* const blocked_fpu_registers_;
574 bool* const blocked_register_pairs_;
575 size_t number_of_core_registers_;
576 size_t number_of_fpu_registers_;
577 size_t number_of_register_pairs_;
Nicolas Geoffray98893962015-01-21 12:32:32 +0000578 const uint32_t core_callee_save_mask_;
579 const uint32_t fpu_callee_save_mask_;
Nicolas Geoffray71175b72014-10-09 22:13:55 +0100580
Vladimir Markocf93a5c2015-06-16 11:33:24 +0000581 StackMapStream stack_map_stream_;
582
583 // The order to use for code generation.
Vladimir Markofa6b93c2015-09-15 10:15:55 +0100584 const ArenaVector<HBasicBlock*>* block_order_;
Vladimir Markocf93a5c2015-06-16 11:33:24 +0000585
Roland Levillain3e3d7332015-04-28 11:00:54 +0100586 // Whether we are using baseline.
587 bool is_baseline_;
588
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100589 DisassemblyInformation* disasm_info_;
590
Nicolas Geoffraybab4ed72014-03-11 17:53:17 +0000591 private:
Nicolas Geoffrayc0572a42015-02-06 14:35:25 +0000592 void InitLocationsBaseline(HInstruction* instruction);
Nicolas Geoffray3bca0df2014-09-19 11:01:00 +0100593 size_t GetStackOffsetOfSavedRegister(size_t index);
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100594 void GenerateSlowPaths();
Nicolas Geoffray4c204ba2015-02-03 15:12:35 +0000595 void CompileInternal(CodeAllocator* allocator, bool is_baseline);
Mark Mendell5f874182015-03-04 15:42:45 -0500596 void BlockIfInRegister(Location location, bool is_out = false) const;
Nicolas Geoffrayb1d0f3f2015-05-14 12:41:51 +0100597 void EmitEnvironment(HEnvironment* environment, SlowPathCode* slow_path);
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000598
Serban Constantinescuecc43662015-08-13 13:33:12 +0100599 OptimizingCompilerStats* stats_;
600
Nicolas Geoffray787c3072014-03-17 10:20:19 +0000601 HGraph* const graph_;
Calin Juravlecd6dffe2015-01-08 17:35:35 +0000602 const CompilerOptions& compiler_options_;
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000603
Yevgeny Rouban2a7c1ef2015-07-22 18:36:24 +0600604 // Native to dex_pc map used for native debugging/profiling tools.
Nicolas Geoffrayd28b9692015-11-04 14:36:55 +0000605 ArenaVector<SrcMapElem> src_map_;
Vladimir Marko225b6462015-09-28 12:17:40 +0100606 ArenaVector<SlowPathCode*> slow_paths_;
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000607
Nicolas Geoffray4c204ba2015-02-03 15:12:35 +0000608 // The current block index in `block_order_` of the block
609 // we are generating code for.
610 size_t current_block_index_;
611
Nicolas Geoffrayc0572a42015-02-06 14:35:25 +0000612 // Whether the method is a leaf method.
Nicolas Geoffrayf12feb82014-07-17 18:32:41 +0100613 bool is_leaf_;
614
Nicolas Geoffrayc0572a42015-02-06 14:35:25 +0000615 // Whether an instruction in the graph accesses the current method.
616 bool requires_current_method_;
617
David Srbeckyc6b4dd82015-04-07 20:32:43 +0100618 friend class OptimizingCFITest;
619
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000620 DISALLOW_COPY_AND_ASSIGN(CodeGenerator);
621};
622
Nicolas Geoffray7fb49da2014-10-06 09:12:41 +0100623template <typename C, typename F>
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100624class CallingConvention {
625 public:
Nicolas Geoffray7fb49da2014-10-06 09:12:41 +0100626 CallingConvention(const C* registers,
627 size_t number_of_registers,
628 const F* fpu_registers,
Mathieu Chartiere401d142015-04-22 13:56:20 -0700629 size_t number_of_fpu_registers,
630 size_t pointer_size)
Nicolas Geoffray7fb49da2014-10-06 09:12:41 +0100631 : registers_(registers),
632 number_of_registers_(number_of_registers),
633 fpu_registers_(fpu_registers),
Mathieu Chartiere401d142015-04-22 13:56:20 -0700634 number_of_fpu_registers_(number_of_fpu_registers),
635 pointer_size_(pointer_size) {}
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100636
637 size_t GetNumberOfRegisters() const { return number_of_registers_; }
Nicolas Geoffray7fb49da2014-10-06 09:12:41 +0100638 size_t GetNumberOfFpuRegisters() const { return number_of_fpu_registers_; }
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100639
Nicolas Geoffray7fb49da2014-10-06 09:12:41 +0100640 C GetRegisterAt(size_t index) const {
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100641 DCHECK_LT(index, number_of_registers_);
642 return registers_[index];
643 }
644
Nicolas Geoffray7fb49da2014-10-06 09:12:41 +0100645 F GetFpuRegisterAt(size_t index) const {
646 DCHECK_LT(index, number_of_fpu_registers_);
647 return fpu_registers_[index];
648 }
649
650 size_t GetStackOffsetOf(size_t index) const {
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100651 // We still reserve the space for parameters passed by registers.
Mathieu Chartiere401d142015-04-22 13:56:20 -0700652 // Add space for the method pointer.
653 return pointer_size_ + index * kVRegSize;
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100654 }
655
656 private:
Nicolas Geoffray7fb49da2014-10-06 09:12:41 +0100657 const C* registers_;
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100658 const size_t number_of_registers_;
Nicolas Geoffray7fb49da2014-10-06 09:12:41 +0100659 const F* fpu_registers_;
660 const size_t number_of_fpu_registers_;
Mathieu Chartiere401d142015-04-22 13:56:20 -0700661 const size_t pointer_size_;
Nicolas Geoffray4a34a422014-04-03 10:38:37 +0100662
663 DISALLOW_COPY_AND_ASSIGN(CallingConvention);
664};
665
Nicolas Geoffrayd4dd2552014-02-28 10:23:58 +0000666} // namespace art
667
668#endif // ART_COMPILER_OPTIMIZING_CODE_GENERATOR_H_