blob: 6ccbf0fdebe4a7957034baffe3b030820e2e230e [file] [log] [blame]
Elliott Hughes2faa5f12012-01-30 14:42:07 -08001/*
2 * Copyright (C) 2011 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 */
Brian Carlstrom9ea1cb12011-08-24 23:18:18 -070016
Brian Carlstromfc0e3212013-07-17 14:40:12 -070017#ifndef ART_COMPILER_DRIVER_COMPILER_DRIVER_H_
18#define ART_COMPILER_DRIVER_COMPILER_DRIVER_H_
Brian Carlstrom9ea1cb12011-08-24 23:18:18 -070019
Elliott Hughes8add92d2012-01-18 18:18:43 -080020#include <set>
21#include <string>
Logan Chiendf576142012-03-20 17:36:32 +080022#include <vector>
Elliott Hughese5448b52012-01-18 16:44:06 -080023
Elliott Hughes76b61672012-12-12 17:47:30 -080024#include "base/mutex.h"
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +000025#include "base/timing_logger.h"
Brian Carlstrom51c24672013-07-11 16:00:56 -070026#include "class_reference.h"
Brian Carlstrom0755ec52012-01-11 15:19:46 -080027#include "compiled_class.h"
Brian Carlstrom3320cf42011-10-04 14:58:28 -070028#include "compiled_method.h"
Nicolas Geoffrayf5df8972014-02-14 18:37:08 +000029#include "compiler_backend.h"
Brian Carlstrom9ea1cb12011-08-24 23:18:18 -070030#include "dex_file.h"
Elliott Hughes0f3c5532012-03-30 14:51:51 -070031#include "instruction_set.h"
32#include "invoke_type.h"
Brian Carlstrom51c24672013-07-11 16:00:56 -070033#include "method_reference.h"
Brian Carlstrom56d947f2013-07-15 13:14:23 -070034#include "os.h"
Ian Rogers1cb0a1d2011-10-06 15:24:35 -070035#include "runtime.h"
Elliott Hughesa0e18062012-04-13 15:59:59 -070036#include "safe_map.h"
Mathieu Chartier0e4627e2012-10-23 16:13:36 -070037#include "thread_pool.h"
Nicolas Geoffray818f2102014-02-18 16:43:35 +000038#include "utils/arena_allocator.h"
Mathieu Chartier193bad92013-08-29 18:46:00 -070039#include "utils/dedupe_set.h"
Ian Rogers0571d352011-11-03 19:51:38 -070040
Brian Carlstrom9ea1cb12011-08-24 23:18:18 -070041namespace art {
42
Vladimir Marko2bc47802014-02-10 09:43:07 +000043namespace verifier {
44class MethodVerifier;
45} // namespace verifier
46
Ian Rogersc8b306f2012-02-17 21:34:44 -080047class AOTCompilationStats;
Brian Carlstrom6449c622014-02-10 23:48:36 -080048class CompilerOptions;
Ian Rogers89756f22013-03-04 16:40:02 -080049class DexCompilationUnit;
Vladimir Marko5816ed42013-11-27 17:04:20 +000050class DexFileToMethodInlinerMap;
Ian Rogersb48b9eb2014-02-28 16:20:21 -080051struct InlineIGetIPutData;
Brian Carlstromc50d8e12013-07-23 22:35:16 -070052class OatWriter;
Nicolas Geoffrayf5df8972014-02-14 18:37:08 +000053class ParallelCompilationManager;
Elliott Hughes601a1232012-02-02 17:47:38 -080054class TimingLogger;
Vladimir Markoc7f83202014-01-24 17:55:18 +000055class VerificationResults;
Vladimir Marko2730db02014-01-27 11:15:17 +000056class VerifiedMethod;
Ian Rogers996cc582012-02-14 22:23:29 -080057
Ian Rogers848871b2013-08-05 10:56:33 -070058enum EntryPointCallingConvention {
59 // ABI of invocations to a method's interpreter entry point.
60 kInterpreterAbi,
61 // ABI of calls to a method's native code, only used for native methods.
62 kJniAbi,
63 // ABI of calls to a method's portable code entry point.
64 kPortableAbi,
65 // ABI of calls to a method's quick code entry point.
66 kQuickAbi
67};
68
Sebastien Hertz75021222013-07-16 18:34:50 +020069enum DexToDexCompilationLevel {
70 kDontDexToDexCompile, // Only meaning wrt image time interpretation.
71 kRequired, // Dex-to-dex compilation required for correctness.
72 kOptimize // Perform required transformation and peep-hole optimizations.
73};
74
buzbee4df2bbd2012-10-11 14:46:06 -070075// Thread-local storage compiler worker threads
76class CompilerTls {
buzbee4df2bbd2012-10-11 14:46:06 -070077 public:
78 CompilerTls() : llvm_info_(NULL) {}
79 ~CompilerTls() {}
80
81 void* GetLLVMInfo() { return llvm_info_; }
82
83 void SetLLVMInfo(void* llvm_info) { llvm_info_ = llvm_info; }
84
85 private:
86 void* llvm_info_;
buzbee4df2bbd2012-10-11 14:46:06 -070087};
88
Ian Rogers1212a022013-03-04 10:48:41 -080089class CompilerDriver {
Brian Carlstrom9ea1cb12011-08-24 23:18:18 -070090 public:
Brian Carlstrom96391602013-06-13 19:49:50 -070091 typedef std::set<std::string> DescriptorSet;
92
Brian Carlstromaded5f72011-10-07 17:15:04 -070093 // Create a compiler targeting the requested "instruction_set".
Brian Carlstromae826982011-11-09 01:33:42 -080094 // "image" should be true if image specific optimizations should be
95 // enabled. "image_classes" lets the compiler know what classes it
96 // can assume will be in the image, with NULL implying all available
97 // classes.
Brian Carlstrom6449c622014-02-10 23:48:36 -080098 explicit CompilerDriver(const CompilerOptions* compiler_options,
99 VerificationResults* verification_results,
Vladimir Marko5816ed42013-11-27 17:04:20 +0000100 DexFileToMethodInlinerMap* method_inliner_map,
Nicolas Geoffrayf5df8972014-02-14 18:37:08 +0000101 CompilerBackend::Kind compiler_backend_kind,
102 InstructionSet instruction_set,
Dave Allison70202782013-10-22 17:52:19 -0700103 InstructionSetFeatures instruction_set_features,
Brian Carlstrom96391602013-06-13 19:49:50 -0700104 bool image, DescriptorSet* image_classes,
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +0000105 size_t thread_count, bool dump_stats, bool dump_passes,
106 CumulativeLogger* timer);
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700107
Ian Rogers1212a022013-03-04 10:48:41 -0800108 ~CompilerDriver();
Ian Rogers2c8f6532011-09-02 17:16:34 -0700109
Brian Carlstrom45602482013-07-21 22:07:55 -0700110 void CompileAll(jobject class_loader, const std::vector<const DexFile*>& dex_files,
Ian Rogers3d504072014-03-01 09:16:49 -0800111 TimingLogger* timings)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700112 LOCKS_EXCLUDED(Locks::mutator_lock_);
Brian Carlstrom8a487412011-08-29 20:08:52 -0700113
Ian Rogersef7d42f2014-01-06 12:55:46 -0800114 // Compile a single Method.
Ian Rogers3d504072014-03-01 09:16:49 -0800115 void CompileOne(mirror::ArtMethod* method, TimingLogger* timings)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700116 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Brian Carlstrom9ea1cb12011-08-24 23:18:18 -0700117
Vladimir Markoc7f83202014-01-24 17:55:18 +0000118 VerificationResults* GetVerificationResults() const {
119 return verification_results_;
Vladimir Marko2b5eaa22013-12-13 13:59:30 +0000120 }
121
Vladimir Marko5816ed42013-11-27 17:04:20 +0000122 DexFileToMethodInlinerMap* GetMethodInlinerMap() const {
123 return method_inliner_map_;
124 }
125
Ian Rogers3d504072014-03-01 09:16:49 -0800126 InstructionSet GetInstructionSet() const {
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700127 return instruction_set_;
128 }
129
Ian Rogers3d504072014-03-01 09:16:49 -0800130 InstructionSetFeatures GetInstructionSetFeatures() const {
Dave Allison70202782013-10-22 17:52:19 -0700131 return instruction_set_features_;
132 }
133
Brian Carlstrom6449c622014-02-10 23:48:36 -0800134 const CompilerOptions& GetCompilerOptions() const {
Brian Carlstrom6449c622014-02-10 23:48:36 -0800135 return *compiler_options_;
136 }
137
Nicolas Geoffrayf5df8972014-02-14 18:37:08 +0000138 CompilerBackend* GetCompilerBackend() const {
139 return compiler_backend_.get();
buzbeec531cef2012-10-18 07:09:20 -0700140 }
141
Ian Rogerse6bb3b22013-08-19 21:51:45 -0700142 // Are we compiling and creating an image file?
Brian Carlstromaded5f72011-10-07 17:15:04 -0700143 bool IsImage() const {
144 return image_;
145 }
146
Brian Carlstrom96391602013-06-13 19:49:50 -0700147 DescriptorSet* GetImageClasses() const {
148 return image_classes_.get();
149 }
150
buzbee4df2bbd2012-10-11 14:46:06 -0700151 CompilerTls* GetTls();
152
Jeff Hao0aba0ba2013-06-03 14:49:28 -0700153 // Generate the trampolines that are invoked by unresolved direct methods.
Ian Rogers848871b2013-08-05 10:56:33 -0700154 const std::vector<uint8_t>* CreateInterpreterToInterpreterBridge() const
155 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
156 const std::vector<uint8_t>* CreateInterpreterToCompiledCodeBridge() const
157 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
158 const std::vector<uint8_t>* CreateJniDlsymLookup() const
159 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Jeff Hao88474b42013-10-23 16:24:40 -0700160 const std::vector<uint8_t>* CreatePortableImtConflictTrampoline() const
161 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Jeff Hao0aba0ba2013-06-03 14:49:28 -0700162 const std::vector<uint8_t>* CreatePortableResolutionTrampoline() const
163 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers848871b2013-08-05 10:56:33 -0700164 const std::vector<uint8_t>* CreatePortableToInterpreterBridge() const
165 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Jeff Hao88474b42013-10-23 16:24:40 -0700166 const std::vector<uint8_t>* CreateQuickImtConflictTrampoline() const
167 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Jeff Hao0aba0ba2013-06-03 14:49:28 -0700168 const std::vector<uint8_t>* CreateQuickResolutionTrampoline() const
169 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers848871b2013-08-05 10:56:33 -0700170 const std::vector<uint8_t>* CreateQuickToInterpreterBridge() const
Jeff Hao0aba0ba2013-06-03 14:49:28 -0700171 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
172
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700173 CompiledClass* GetCompiledClass(ClassReference ref) const
174 LOCKS_EXCLUDED(compiled_classes_lock_);
Ian Rogers0571d352011-11-03 19:51:38 -0700175
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700176 CompiledMethod* GetCompiledMethod(MethodReference ref) const
177 LOCKS_EXCLUDED(compiled_methods_lock_);
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800178
Ian Rogers8b2c0b92013-09-19 02:56:49 -0700179 void AddRequiresConstructorBarrier(Thread* self, const DexFile* dex_file,
180 uint16_t class_def_index);
181 bool RequiresConstructorBarrier(Thread* self, const DexFile* dex_file, uint16_t class_def_index);
Ian Rogersfffdb022013-01-04 15:14:08 -0800182
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700183 // Callbacks from compiler to see what runtime checks must be generated.
Ian Rogers0571d352011-11-03 19:51:38 -0700184
Ian Rogers5ddb4102014-01-07 08:58:46 -0800185 bool CanAssumeTypeIsPresentInDexCache(const DexFile& dex_file, uint32_t type_idx);
Ian Rogers1bddec32012-02-04 12:27:34 -0800186
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700187 bool CanAssumeStringIsPresentInDexCache(const DexFile& dex_file, uint32_t string_idx)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700188 LOCKS_EXCLUDED(Locks::mutator_lock_);
Ian Rogers1bddec32012-02-04 12:27:34 -0800189
190 // Are runtime access checks necessary in the compiled code?
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700191 bool CanAccessTypeWithoutChecks(uint32_t referrer_idx, const DexFile& dex_file,
Ian Rogersc9e463c2013-06-05 16:52:26 -0700192 uint32_t type_idx, bool* type_known_final = NULL,
193 bool* type_known_abstract = NULL,
194 bool* equals_referrers_class = NULL)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700195 LOCKS_EXCLUDED(Locks::mutator_lock_);
Ian Rogers1bddec32012-02-04 12:27:34 -0800196
197 // Are runtime access and instantiable checks necessary in the code?
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700198 bool CanAccessInstantiableTypeWithoutChecks(uint32_t referrer_idx, const DexFile& dex_file,
199 uint32_t type_idx)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700200 LOCKS_EXCLUDED(Locks::mutator_lock_);
Ian Rogers1bddec32012-02-04 12:27:34 -0800201
Hiroshi Yamauchibe1ca552014-01-15 11:46:48 -0800202 bool CanEmbedTypeInCode(const DexFile& dex_file, uint32_t type_idx,
203 bool* is_type_initialized, bool* use_direct_type_ptr,
204 uintptr_t* direct_type_ptr);
205
Vladimir Marko2bc47802014-02-10 09:43:07 +0000206 // Can we fast path instance field access in a verified accessor?
207 // If yes, computes field's offset and volatility and whether the method is static or not.
208 static bool ComputeSpecialAccessorInfo(uint32_t field_idx, bool is_put,
209 verifier::MethodVerifier* verifier,
210 InlineIGetIPutData* result)
211 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
212
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700213 // Can we fast path instance field access? Computes field's offset and volatility.
Ian Rogers9b297bf2013-09-06 11:11:25 -0700214 bool ComputeInstanceFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit, bool is_put,
215 int* field_offset, bool* is_volatile)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700216 LOCKS_EXCLUDED(Locks::mutator_lock_);
Ian Rogers1bddec32012-02-04 12:27:34 -0800217
218 // Can we fastpath static field access? Computes field's offset, volatility and whether the
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700219 // field is within the referrer (which can avoid checking class initialization).
Ian Rogers9b297bf2013-09-06 11:11:25 -0700220 bool ComputeStaticFieldInfo(uint32_t field_idx, const DexCompilationUnit* mUnit, bool is_put,
Ian Rogers5ddb4102014-01-07 08:58:46 -0800221 int* field_offset, int* storage_index,
222 bool* is_referrers_class, bool* is_volatile, bool* is_initialized)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700223 LOCKS_EXCLUDED(Locks::mutator_lock_);
Ian Rogers1bddec32012-02-04 12:27:34 -0800224
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700225 // Can we fastpath a interface, super class or virtual method call? Computes method's vtable
226 // index.
Ian Rogerse3cd2f02013-05-24 15:32:56 -0700227 bool ComputeInvokeInfo(const DexCompilationUnit* mUnit, const uint32_t dex_pc,
Ian Rogers65ec92c2013-09-06 10:49:58 -0700228 bool update_stats, bool enable_devirtualization,
229 InvokeType* type, MethodReference* target_method, int* vtable_idx,
230 uintptr_t* direct_code, uintptr_t* direct_method)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700231 LOCKS_EXCLUDED(Locks::mutator_lock_);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800232
Vladimir Marko2730db02014-01-27 11:15:17 +0000233 const VerifiedMethod* GetVerifiedMethod(const DexFile* dex_file, uint32_t method_idx) const;
234 bool IsSafeCast(const DexCompilationUnit* mUnit, uint32_t dex_pc);
Ian Rogersfae370a2013-06-05 08:33:27 -0700235
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700236 // Record patch information for later fix up.
237 void AddCodePatch(const DexFile* dex_file,
Ian Rogers8b2c0b92013-09-19 02:56:49 -0700238 uint16_t referrer_class_def_idx,
Brian Carlstromf5822582012-03-19 22:34:31 -0700239 uint32_t referrer_method_idx,
Ian Rogers08f753d2012-08-24 14:35:25 -0700240 InvokeType referrer_invoke_type,
Brian Carlstromf5822582012-03-19 22:34:31 -0700241 uint32_t target_method_idx,
Ian Rogers08f753d2012-08-24 14:35:25 -0700242 InvokeType target_invoke_type,
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700243 size_t literal_offset)
244 LOCKS_EXCLUDED(compiled_methods_lock_);
Mark Mendell55d0eac2014-02-06 11:02:52 -0800245 void AddRelativeCodePatch(const DexFile* dex_file,
246 uint16_t referrer_class_def_idx,
247 uint32_t referrer_method_idx,
248 InvokeType referrer_invoke_type,
249 uint32_t target_method_idx,
250 InvokeType target_invoke_type,
251 size_t literal_offset,
252 int32_t pc_relative_offset)
253 LOCKS_EXCLUDED(compiled_methods_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700254 void AddMethodPatch(const DexFile* dex_file,
Ian Rogers8b2c0b92013-09-19 02:56:49 -0700255 uint16_t referrer_class_def_idx,
Brian Carlstromf5822582012-03-19 22:34:31 -0700256 uint32_t referrer_method_idx,
Ian Rogers08f753d2012-08-24 14:35:25 -0700257 InvokeType referrer_invoke_type,
Brian Carlstromf5822582012-03-19 22:34:31 -0700258 uint32_t target_method_idx,
Ian Rogers08f753d2012-08-24 14:35:25 -0700259 InvokeType target_invoke_type,
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700260 size_t literal_offset)
261 LOCKS_EXCLUDED(compiled_methods_lock_);
Hiroshi Yamauchibe1ca552014-01-15 11:46:48 -0800262 void AddClassPatch(const DexFile* dex_file,
263 uint16_t referrer_class_def_idx,
264 uint32_t referrer_method_idx,
265 uint32_t target_method_idx,
266 size_t literal_offset)
267 LOCKS_EXCLUDED(compiled_methods_lock_);
Ian Rogers3fa13792012-03-18 15:53:45 -0700268
Brian Carlstrom96391602013-06-13 19:49:50 -0700269 bool GetSupportBootImageFixup() const {
270 return support_boot_image_fixup_;
271 }
272
273 void SetSupportBootImageFixup(bool support_boot_image_fixup) {
274 support_boot_image_fixup_ = support_boot_image_fixup;
275 }
276
Ian Rogers3d504072014-03-01 09:16:49 -0800277 ArenaPool* GetArenaPool() {
278 return &arena_pool_;
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -0700279 }
Brian Carlstrom96391602013-06-13 19:49:50 -0700280
Brian Carlstrom3f47c122013-03-07 00:02:40 -0800281 bool WriteElf(const std::string& android_root,
Brian Carlstrom265091e2013-01-30 14:08:26 -0800282 bool is_host,
283 const std::vector<const DexFile*>& dex_files,
Ian Rogers3d504072014-03-01 09:16:49 -0800284 OatWriter* oat_writer,
Brian Carlstrom265091e2013-01-30 14:08:26 -0800285 File* file);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800286
Ian Rogers3d504072014-03-01 09:16:49 -0800287 // TODO: move to a common home for llvm helpers once quick/portable are merged.
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800288 static void InstructionSetToLLVMTarget(InstructionSet instruction_set,
Ian Rogers3d504072014-03-01 09:16:49 -0800289 std::string* target_triple,
290 std::string* target_cpu,
291 std::string* target_attr);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800292
Elliott Hughes6f4976c2012-03-13 21:19:01 -0700293 void SetCompilerContext(void* compiler_context) {
294 compiler_context_ = compiler_context;
295 }
296
297 void* GetCompilerContext() const {
298 return compiler_context_;
299 }
300
Logan Chien08e1ba32012-05-08 15:08:51 +0800301 size_t GetThreadCount() const {
302 return thread_count_;
303 }
304
Hiroshi Yamauchibe1ca552014-01-15 11:46:48 -0800305 class CallPatchInformation;
306 class TypePatchInformation;
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +0000307
308 bool GetDumpPasses() const {
309 return dump_passes_;
310 }
311
Ian Rogers3d504072014-03-01 09:16:49 -0800312 CumulativeLogger* GetTimingsLogger() const {
313 return timings_logger_;
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +0000314 }
315
Brian Carlstromf5822582012-03-19 22:34:31 -0700316 class PatchInformation {
317 public:
Brian Carlstromf5822582012-03-19 22:34:31 -0700318 const DexFile& GetDexFile() const {
319 return *dex_file_;
320 }
Ian Rogers8b2c0b92013-09-19 02:56:49 -0700321 uint16_t GetReferrerClassDefIdx() const {
322 return referrer_class_def_idx_;
323 }
Brian Carlstromf5822582012-03-19 22:34:31 -0700324 uint32_t GetReferrerMethodIdx() const {
325 return referrer_method_idx_;
326 }
Hiroshi Yamauchibe1ca552014-01-15 11:46:48 -0800327 size_t GetLiteralOffset() const {
328 return literal_offset_;
329 }
330
331 virtual bool IsCall() const {
332 return false;
333 }
334 virtual bool IsType() const {
335 return false;
336 }
337 virtual const CallPatchInformation* AsCall() const {
338 LOG(FATAL) << "Unreachable";
339 return nullptr;
340 }
341 virtual const TypePatchInformation* AsType() const {
342 LOG(FATAL) << "Unreachable";
343 return nullptr;
344 }
345
346 protected:
347 PatchInformation(const DexFile* dex_file,
348 uint16_t referrer_class_def_idx,
349 uint32_t referrer_method_idx,
350 size_t literal_offset)
351 : dex_file_(dex_file),
352 referrer_class_def_idx_(referrer_class_def_idx),
353 referrer_method_idx_(referrer_method_idx),
354 literal_offset_(literal_offset) {
355 CHECK(dex_file_ != NULL);
356 }
357 virtual ~PatchInformation() {}
358
359 const DexFile* const dex_file_;
360 const uint16_t referrer_class_def_idx_;
361 const uint32_t referrer_method_idx_;
362 const size_t literal_offset_;
363
364 friend class CompilerDriver;
365 };
366
367 class CallPatchInformation : public PatchInformation {
368 public:
Ian Rogers08f753d2012-08-24 14:35:25 -0700369 InvokeType GetReferrerInvokeType() const {
370 return referrer_invoke_type_;
Brian Carlstromf5822582012-03-19 22:34:31 -0700371 }
372 uint32_t GetTargetMethodIdx() const {
373 return target_method_idx_;
374 }
Ian Rogers08f753d2012-08-24 14:35:25 -0700375 InvokeType GetTargetInvokeType() const {
376 return target_invoke_type_;
Brian Carlstromf5822582012-03-19 22:34:31 -0700377 }
Hiroshi Yamauchibe1ca552014-01-15 11:46:48 -0800378
379 const CallPatchInformation* AsCall() const {
380 return this;
381 }
382 bool IsCall() const {
383 return true;
Brian Carlstromf5822582012-03-19 22:34:31 -0700384 }
Mark Mendell55d0eac2014-02-06 11:02:52 -0800385 virtual bool IsRelative() const {
386 return false;
387 }
388 virtual int RelativeOffset() const {
389 return 0;
390 }
Brian Carlstromf5822582012-03-19 22:34:31 -0700391
Mark Mendell55d0eac2014-02-06 11:02:52 -0800392 protected:
Hiroshi Yamauchibe1ca552014-01-15 11:46:48 -0800393 CallPatchInformation(const DexFile* dex_file,
394 uint16_t referrer_class_def_idx,
395 uint32_t referrer_method_idx,
396 InvokeType referrer_invoke_type,
397 uint32_t target_method_idx,
398 InvokeType target_invoke_type,
399 size_t literal_offset)
400 : PatchInformation(dex_file, referrer_class_def_idx,
401 referrer_method_idx, literal_offset),
402 referrer_invoke_type_(referrer_invoke_type),
403 target_method_idx_(target_method_idx),
404 target_invoke_type_(target_invoke_type) {
Brian Carlstromf5822582012-03-19 22:34:31 -0700405 }
406
Mark Mendell55d0eac2014-02-06 11:02:52 -0800407 private:
Ian Rogers8b2c0b92013-09-19 02:56:49 -0700408 const InvokeType referrer_invoke_type_;
409 const uint32_t target_method_idx_;
410 const InvokeType target_invoke_type_;
Brian Carlstromf5822582012-03-19 22:34:31 -0700411
Ian Rogers1212a022013-03-04 10:48:41 -0800412 friend class CompilerDriver;
Hiroshi Yamauchibe1ca552014-01-15 11:46:48 -0800413 DISALLOW_COPY_AND_ASSIGN(CallPatchInformation);
Brian Carlstromf5822582012-03-19 22:34:31 -0700414 };
415
Mark Mendell55d0eac2014-02-06 11:02:52 -0800416 class RelativeCallPatchInformation : public CallPatchInformation {
417 public:
418 bool IsRelative() const {
419 return true;
420 }
421 int RelativeOffset() const {
422 return offset_;
423 }
424
425 private:
426 RelativeCallPatchInformation(const DexFile* dex_file,
427 uint16_t referrer_class_def_idx,
428 uint32_t referrer_method_idx,
429 InvokeType referrer_invoke_type,
430 uint32_t target_method_idx,
431 InvokeType target_invoke_type,
432 size_t literal_offset,
433 int32_t pc_relative_offset)
434 : CallPatchInformation(dex_file, referrer_class_def_idx,
435 referrer_method_idx, referrer_invoke_type,
436 target_method_idx, target_invoke_type, literal_offset),
437 offset_(pc_relative_offset) {
438 }
439
440 const int offset_;
441
442 friend class CompilerDriver;
443 DISALLOW_COPY_AND_ASSIGN(RelativeCallPatchInformation);
444 };
445
Hiroshi Yamauchibe1ca552014-01-15 11:46:48 -0800446 class TypePatchInformation : public PatchInformation {
447 public:
448 uint32_t GetTargetTypeIdx() const {
449 return target_type_idx_;
450 }
451
452 bool IsType() const {
453 return true;
454 }
455 const TypePatchInformation* AsType() const {
456 return this;
457 }
458
459 private:
460 TypePatchInformation(const DexFile* dex_file,
461 uint16_t referrer_class_def_idx,
462 uint32_t referrer_method_idx,
463 uint32_t target_type_idx,
464 size_t literal_offset)
465 : PatchInformation(dex_file, referrer_class_def_idx,
466 referrer_method_idx, literal_offset),
467 target_type_idx_(target_type_idx) {
468 }
469
470 const uint32_t target_type_idx_;
471
472 friend class CompilerDriver;
473 DISALLOW_COPY_AND_ASSIGN(TypePatchInformation);
474 };
475
476 const std::vector<const CallPatchInformation*>& GetCodeToPatch() const {
Brian Carlstromf5822582012-03-19 22:34:31 -0700477 return code_to_patch_;
478 }
Hiroshi Yamauchibe1ca552014-01-15 11:46:48 -0800479 const std::vector<const CallPatchInformation*>& GetMethodsToPatch() const {
Brian Carlstromf5822582012-03-19 22:34:31 -0700480 return methods_to_patch_;
481 }
Hiroshi Yamauchibe1ca552014-01-15 11:46:48 -0800482 const std::vector<const TypePatchInformation*>& GetClassesToPatch() const {
483 return classes_to_patch_;
484 }
Brian Carlstromf5822582012-03-19 22:34:31 -0700485
Ian Rogers3d1548d2012-09-24 14:08:03 -0700486 // Checks if class specified by type_idx is one of the image_classes_
Ian Rogersdfb325e2013-10-30 01:00:44 -0700487 bool IsImageClass(const char* descriptor) const;
Ian Rogers3d1548d2012-09-24 14:08:03 -0700488
Ian Rogers8f3c9ae2013-08-20 17:26:41 -0700489 void RecordClassStatus(ClassReference ref, mirror::Class::Status status)
490 LOCKS_EXCLUDED(compiled_classes_lock_);
Ian Rogers3d1548d2012-09-24 14:08:03 -0700491
Mathieu Chartier193bad92013-08-29 18:46:00 -0700492 std::vector<uint8_t>* DeduplicateCode(const std::vector<uint8_t>& code);
493 std::vector<uint8_t>* DeduplicateMappingTable(const std::vector<uint8_t>& code);
494 std::vector<uint8_t>* DeduplicateVMapTable(const std::vector<uint8_t>& code);
495 std::vector<uint8_t>* DeduplicateGCMap(const std::vector<uint8_t>& code);
Mark Mendellae9fd932014-02-10 16:14:35 -0800496 std::vector<uint8_t>* DeduplicateCFIInfo(const std::vector<uint8_t>* cfi_info);
497
498 /*
499 * @brief return the pointer to the Call Frame Information.
500 * @return pointer to call frame information for this compilation.
501 */
502 std::vector<uint8_t>* GetCallFrameInformation() const {
503 return cfi_info_.get();
504 }
Mathieu Chartier193bad92013-08-29 18:46:00 -0700505
Brian Carlstrom9ea1cb12011-08-24 23:18:18 -0700506 private:
Ian Rogers2ed3b952012-03-17 11:49:39 -0700507 // Compute constant code and method pointers when possible
Ian Rogers83883d72013-10-21 21:07:24 -0700508 void GetCodeAndMethodForDirectCall(InvokeType* type, InvokeType sharp_type,
509 bool no_guarantee_of_dex_cache_entry,
Ian Rogers4f6ad8a2013-03-18 15:27:28 -0700510 mirror::Class* referrer_class,
Brian Carlstromea46f952013-07-30 01:26:50 -0700511 mirror::ArtMethod* method,
Ian Rogers65ec92c2013-09-06 10:49:58 -0700512 bool update_stats,
Ian Rogers83883d72013-10-21 21:07:24 -0700513 MethodReference* target_method,
Ian Rogers65ec92c2013-09-06 10:49:58 -0700514 uintptr_t* direct_code, uintptr_t* direct_method)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700515 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
Ian Rogers2ed3b952012-03-17 11:49:39 -0700516
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700517 void PreCompile(jobject class_loader, const std::vector<const DexFile*>& dex_files,
Ian Rogers3d504072014-03-01 09:16:49 -0800518 ThreadPool* thread_pool, TimingLogger* timings)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700519 LOCKS_EXCLUDED(Locks::mutator_lock_);
Brian Carlstromae826982011-11-09 01:33:42 -0800520
Ian Rogers3d504072014-03-01 09:16:49 -0800521 void LoadImageClasses(TimingLogger* timings);
Brian Carlstrom96391602013-06-13 19:49:50 -0700522
Brian Carlstrom9ea1cb12011-08-24 23:18:18 -0700523 // Attempt to resolve all type, methods, fields, and strings
524 // referenced from code in the dex file following PathClassLoader
525 // ordering semantics.
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700526 void Resolve(jobject class_loader, const std::vector<const DexFile*>& dex_files,
Ian Rogers3d504072014-03-01 09:16:49 -0800527 ThreadPool* thread_pool, TimingLogger* timings)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700528 LOCKS_EXCLUDED(Locks::mutator_lock_);
Brian Carlstrom2f663822012-11-07 22:49:06 -0800529 void ResolveDexFile(jobject class_loader, const DexFile& dex_file,
Ian Rogers3d504072014-03-01 09:16:49 -0800530 ThreadPool* thread_pool, TimingLogger* timings)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700531 LOCKS_EXCLUDED(Locks::mutator_lock_);
Brian Carlstrom9ea1cb12011-08-24 23:18:18 -0700532
Ian Rogers3d1548d2012-09-24 14:08:03 -0700533 void Verify(jobject class_loader, const std::vector<const DexFile*>& dex_files,
Ian Rogers3d504072014-03-01 09:16:49 -0800534 ThreadPool* thread_pool, TimingLogger* timings);
Brian Carlstrom2f663822012-11-07 22:49:06 -0800535 void VerifyDexFile(jobject class_loader, const DexFile& dex_file,
Ian Rogers3d504072014-03-01 09:16:49 -0800536 ThreadPool* thread_pool, TimingLogger* timings)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700537 LOCKS_EXCLUDED(Locks::mutator_lock_);
jeffhao98eacac2011-09-14 16:11:53 -0700538
Brian Carlstrom2f663822012-11-07 22:49:06 -0800539 void InitializeClasses(jobject class_loader, const std::vector<const DexFile*>& dex_files,
Ian Rogers3d504072014-03-01 09:16:49 -0800540 ThreadPool* thread_pool, TimingLogger* timings)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700541 LOCKS_EXCLUDED(Locks::mutator_lock_);
Ian Rogers64b6d142012-10-29 16:34:15 -0700542 void InitializeClasses(jobject class_loader, const DexFile& dex_file,
Ian Rogers3d504072014-03-01 09:16:49 -0800543 ThreadPool* thread_pool, TimingLogger* timings)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700544 LOCKS_EXCLUDED(Locks::mutator_lock_, compiled_classes_lock_);
Brian Carlstroma5a97a22011-09-15 14:08:49 -0700545
Ian Rogers3d504072014-03-01 09:16:49 -0800546 void UpdateImageClasses(TimingLogger* timings) LOCKS_EXCLUDED(Locks::mutator_lock_);
Brian Carlstrom96391602013-06-13 19:49:50 -0700547 static void FindClinitImageClassesCallback(mirror::Object* object, void* arg)
548 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
549
Ian Rogers3d1548d2012-09-24 14:08:03 -0700550 void Compile(jobject class_loader, const std::vector<const DexFile*>& dex_files,
Ian Rogers3d504072014-03-01 09:16:49 -0800551 ThreadPool* thread_pool, TimingLogger* timings);
Brian Carlstrom2f663822012-11-07 22:49:06 -0800552 void CompileDexFile(jobject class_loader, const DexFile& dex_file,
Ian Rogers3d504072014-03-01 09:16:49 -0800553 ThreadPool* thread_pool, TimingLogger* timings)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700554 LOCKS_EXCLUDED(Locks::mutator_lock_);
Ian Rogers08f753d2012-08-24 14:35:25 -0700555 void CompileMethod(const DexFile::CodeItem* code_item, uint32_t access_flags,
Ian Rogers8b2c0b92013-09-19 02:56:49 -0700556 InvokeType invoke_type, uint16_t class_def_idx, uint32_t method_idx,
Sebastien Hertz2d6ba512013-05-17 11:31:37 +0200557 jobject class_loader, const DexFile& dex_file,
Sebastien Hertz75021222013-07-16 18:34:50 +0200558 DexToDexCompilationLevel dex_to_dex_compilation_level)
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700559 LOCKS_EXCLUDED(compiled_methods_lock_);
Brian Carlstrom83db7722011-08-26 17:32:56 -0700560
Ian Rogers219b5a82013-03-04 13:48:24 -0800561 static void CompileClass(const ParallelCompilationManager* context, size_t class_def_index)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700562 LOCKS_EXCLUDED(Locks::mutator_lock_);
Elliott Hughesc225caa2012-02-03 15:43:37 -0800563
Hiroshi Yamauchibe1ca552014-01-15 11:46:48 -0800564 std::vector<const CallPatchInformation*> code_to_patch_;
565 std::vector<const CallPatchInformation*> methods_to_patch_;
566 std::vector<const TypePatchInformation*> classes_to_patch_;
Ian Rogers3fa13792012-03-18 15:53:45 -0700567
Brian Carlstromae7083d2014-02-24 21:56:02 -0800568 const CompilerOptions* const compiler_options_;
569 VerificationResults* const verification_results_;
570 DexFileToMethodInlinerMap* const method_inliner_map_;
Vladimir Marko2b5eaa22013-12-13 13:59:30 +0000571
Nicolas Geoffrayf5df8972014-02-14 18:37:08 +0000572 UniquePtr<CompilerBackend> compiler_backend_;
buzbeec531cef2012-10-18 07:09:20 -0700573
Dave Allison70202782013-10-22 17:52:19 -0700574 const InstructionSet instruction_set_;
575 const InstructionSetFeatures instruction_set_features_;
Ian Rogers2c8f6532011-09-02 17:16:34 -0700576
Ian Rogersfffdb022013-01-04 15:14:08 -0800577 // All class references that require
Ian Rogers8f3c9ae2013-08-20 17:26:41 -0700578 mutable ReaderWriterMutex freezing_constructor_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
Ian Rogersfffdb022013-01-04 15:14:08 -0800579 std::set<ClassReference> freezing_constructor_classes_ GUARDED_BY(freezing_constructor_lock_);
580
Elliott Hughesa0e18062012-04-13 15:59:59 -0700581 typedef SafeMap<const ClassReference, CompiledClass*> ClassTable;
Ian Rogersfffdb022013-01-04 15:14:08 -0800582 // All class references that this compiler has compiled.
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700583 mutable Mutex compiled_classes_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
Elliott Hughesf8349362012-06-18 15:00:06 -0700584 ClassTable compiled_classes_ GUARDED_BY(compiled_classes_lock_);
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800585
Ian Rogerse3cd2f02013-05-24 15:32:56 -0700586 typedef SafeMap<const MethodReference, CompiledMethod*, MethodReferenceComparator> MethodTable;
Ian Rogersfffdb022013-01-04 15:14:08 -0800587 // All method references that this compiler has compiled.
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700588 mutable Mutex compiled_methods_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
Elliott Hughesf8349362012-06-18 15:00:06 -0700589 MethodTable compiled_methods_ GUARDED_BY(compiled_methods_lock_);
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700590
Brian Carlstrom96391602013-06-13 19:49:50 -0700591 const bool image_;
592
593 // If image_ is true, specifies the classes that will be included in
594 // the image. Note if image_classes_ is NULL, all classes are
595 // included in the image.
596 UniquePtr<DescriptorSet> image_classes_;
597
Elliott Hughes5523ee02012-02-03 18:18:34 -0800598 size_t thread_count_;
Elliott Hughesbb551fa2012-01-25 16:35:29 -0800599 uint64_t start_ns_;
600
Ian Rogersc8b306f2012-02-17 21:34:44 -0800601 UniquePtr<AOTCompilationStats> stats_;
Ian Rogers996cc582012-02-14 22:23:29 -0800602
Brian Carlstromba0668e2012-03-26 13:14:07 -0700603 bool dump_stats_;
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +0000604 const bool dump_passes_;
605
606 CumulativeLogger* const timings_logger_;
Brian Carlstromba0668e2012-03-26 13:14:07 -0700607
Ian Rogers1212a022013-03-04 10:48:41 -0800608 typedef void (*CompilerCallbackFn)(CompilerDriver& driver);
609 typedef MutexLock* (*CompilerMutexLockFn)(CompilerDriver& driver);
Logan Chienf7015fd2012-03-18 01:19:37 +0800610
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800611 void* compiler_library_;
Elliott Hughes46f060a2012-03-09 17:36:50 -0800612
Sebastien Hertz75021222013-07-16 18:34:50 +0200613 typedef void (*DexToDexCompilerFn)(CompilerDriver& driver,
614 const DexFile::CodeItem* code_item,
615 uint32_t access_flags, InvokeType invoke_type,
616 uint32_t class_dex_idx, uint32_t method_idx,
617 jobject class_loader, const DexFile& dex_file,
618 DexToDexCompilationLevel dex_to_dex_compilation_level);
Sebastien Hertz75021222013-07-16 18:34:50 +0200619 DexToDexCompilerFn dex_to_dex_compiler_;
Sebastien Hertz2d6ba512013-05-17 11:31:37 +0200620
Elliott Hughes6f4976c2012-03-13 21:19:01 -0700621 void* compiler_context_;
622
buzbee4df2bbd2012-10-11 14:46:06 -0700623 pthread_key_t tls_key_;
624
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -0700625 // Arena pool used by the compiler.
626 ArenaPool arena_pool_;
627
Ian Rogers1212a022013-03-04 10:48:41 -0800628 typedef void (*CompilerEnableAutoElfLoadingFn)(CompilerDriver& driver);
Logan Chienf7015fd2012-03-18 01:19:37 +0800629 CompilerEnableAutoElfLoadingFn compiler_enable_auto_elf_loading_;
630
631 typedef const void* (*CompilerGetMethodCodeAddrFn)
Brian Carlstromea46f952013-07-30 01:26:50 -0700632 (const CompilerDriver& driver, const CompiledMethod* cm, const mirror::ArtMethod* method);
Logan Chienf7015fd2012-03-18 01:19:37 +0800633 CompilerGetMethodCodeAddrFn compiler_get_method_code_addr_;
634
Brian Carlstrom96391602013-06-13 19:49:50 -0700635 bool support_boot_image_fixup_;
636
Mark Mendellae9fd932014-02-10 16:14:35 -0800637 // Call Frame Information, which might be generated to help stack tracebacks.
638 UniquePtr<std::vector<uint8_t> > cfi_info_;
639
Mathieu Chartier193bad92013-08-29 18:46:00 -0700640 // DeDuplication data structures, these own the corresponding byte arrays.
641 class DedupeHashFunc {
642 public:
643 size_t operator()(const std::vector<uint8_t>& array) const {
Ian Rogersd133b972013-09-05 11:01:30 -0700644 // For small arrays compute a hash using every byte.
Mathieu Chartier193bad92013-08-29 18:46:00 -0700645 static const size_t kSmallArrayThreshold = 16;
Ian Rogersd133b972013-09-05 11:01:30 -0700646 size_t hash = 0x811c9dc5;
647 if (array.size() <= kSmallArrayThreshold) {
648 for (uint8_t b : array) {
649 hash = (hash * 16777619) ^ b;
Mathieu Chartier193bad92013-08-29 18:46:00 -0700650 }
651 } else {
Ian Rogers936bf022013-09-06 08:44:06 -0700652 // For larger arrays use the 2 bytes at 6 bytes (the location of a push registers
653 // instruction field for quick generated code on ARM) and then select a number of other
654 // values at random.
Ian Rogersd133b972013-09-05 11:01:30 -0700655 static const size_t kRandomHashCount = 16;
Ian Rogers936bf022013-09-06 08:44:06 -0700656 for (size_t i = 0; i < 2; ++i) {
657 uint8_t b = array[i + 6];
Ian Rogersd133b972013-09-05 11:01:30 -0700658 hash = (hash * 16777619) ^ b;
659 }
Ian Rogers936bf022013-09-06 08:44:06 -0700660 for (size_t i = 2; i < kRandomHashCount; ++i) {
Mathieu Chartier193bad92013-08-29 18:46:00 -0700661 size_t r = i * 1103515245 + 12345;
Ian Rogersd133b972013-09-05 11:01:30 -0700662 uint8_t b = array[r % array.size()];
663 hash = (hash * 16777619) ^ b;
Mathieu Chartier193bad92013-08-29 18:46:00 -0700664 }
665 }
Ian Rogersd133b972013-09-05 11:01:30 -0700666 hash += hash << 13;
667 hash ^= hash >> 7;
668 hash += hash << 3;
669 hash ^= hash >> 17;
670 hash += hash << 5;
Mathieu Chartier193bad92013-08-29 18:46:00 -0700671 return hash;
672 }
673 };
Ian Rogersd133b972013-09-05 11:01:30 -0700674 DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_code_;
675 DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_mapping_table_;
676 DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_vmap_table_;
677 DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_gc_map_;
Mark Mendellae9fd932014-02-10 16:14:35 -0800678 DedupeSet<std::vector<uint8_t>, size_t, DedupeHashFunc, 4> dedupe_cfi_info_;
Mathieu Chartier193bad92013-08-29 18:46:00 -0700679
Ian Rogers1212a022013-03-04 10:48:41 -0800680 DISALLOW_COPY_AND_ASSIGN(CompilerDriver);
Brian Carlstrom9ea1cb12011-08-24 23:18:18 -0700681};
682
Brian Carlstrom9ea1cb12011-08-24 23:18:18 -0700683} // namespace art
684
Brian Carlstromfc0e3212013-07-17 14:40:12 -0700685#endif // ART_COMPILER_DRIVER_COMPILER_DRIVER_H_