blob: e4194442d3cc9f4571d57894d753aee89c2fef67 [file] [log] [blame]
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -07001/*
2 * Copyright (C) 2015 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#include "oat_file_manager.h"
18
19#include <memory>
20#include <queue>
21#include <vector>
22
Andreas Gampe46ee31b2016-12-14 10:11:49 -080023#include "android-base/stringprintf.h"
Nicolas Geoffray68bf3902017-09-07 14:40:48 +010024#include "android-base/strings.h"
Andreas Gampe46ee31b2016-12-14 10:11:49 -080025
Andreas Gampe90b936d2017-01-31 08:58:55 -080026#include "art_field-inl.h"
Jeff Hao8ec0a202017-03-07 21:56:31 -080027#include "base/bit_vector-inl.h"
David Sehr891a50e2017-10-27 17:01:07 -070028#include "base/file_utils.h"
Andreas Gampe57943812017-12-06 21:39:13 -080029#include "base/logging.h" // For VLOG.
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -070030#include "base/stl_util.h"
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080031#include "base/systrace.h"
Mathieu Chartierfbc31082016-01-24 11:59:56 -080032#include "class_linker.h"
Calin Juravle7b0648a2017-07-07 18:40:50 -070033#include "class_loader_context.h"
David Sehr013fd802018-01-11 22:55:24 -080034#include "dex/art_dex_file_loader.h"
David Sehr9e734c72018-01-04 17:56:19 -080035#include "dex/dex_file-inl.h"
36#include "dex/dex_file_loader.h"
37#include "dex/dex_file_tracking_registrar.h"
Mathieu Chartier61d2b2d2016-02-04 13:31:46 -080038#include "gc/scoped_gc_critical_section.h"
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -070039#include "gc/space/image_space.h"
Mathieu Chartierfbc31082016-01-24 11:59:56 -080040#include "handle_scope-inl.h"
Andreas Gampe08883de2016-11-08 13:20:52 -080041#include "jni_internal.h"
Mathieu Chartierfbc31082016-01-24 11:59:56 -080042#include "mirror/class_loader.h"
Andreas Gampe90b936d2017-01-31 08:58:55 -080043#include "mirror/object-inl.h"
Alex Light2ce6fc82017-12-18 16:42:36 -080044#include "oat_file.h"
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -070045#include "oat_file_assistant.h"
Mathieu Chartier3398c782016-09-30 10:27:43 -070046#include "obj_ptr-inl.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070047#include "scoped_thread_state_change-inl.h"
Andreas Gampeb486a982017-06-01 13:45:54 -070048#include "thread-current-inl.h"
Mathieu Chartiera9d82fe2016-01-25 20:06:11 -080049#include "thread_list.h"
Andreas Gampe90b936d2017-01-31 08:58:55 -080050#include "well_known_classes.h"
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -070051
52namespace art {
53
Andreas Gampe46ee31b2016-12-14 10:11:49 -080054using android::base::StringPrintf;
55
Mathieu Chartier120aa282017-08-05 16:03:03 -070056// If true, we attempt to load the application image if it exists.
Mathieu Chartierfbc31082016-01-24 11:59:56 -080057static constexpr bool kEnableAppImage = true;
58
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -070059const OatFile* OatFileManager::RegisterOatFile(std::unique_ptr<const OatFile> oat_file) {
Mathieu Chartiere58991b2015-10-13 07:59:34 -070060 WriterMutexLock mu(Thread::Current(), *Locks::oat_file_manager_lock_);
Nicolas Geoffray29742602017-12-14 10:09:03 +000061 CHECK(!only_use_system_oat_files_ ||
62 LocationIsOnSystem(oat_file->GetLocation().c_str()) ||
63 !oat_file->IsExecutable())
Nicolas Geoffray68bf3902017-09-07 14:40:48 +010064 << "Registering a non /system oat file: " << oat_file->GetLocation();
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -070065 DCHECK(oat_file != nullptr);
66 if (kIsDebugBuild) {
Mathieu Chartiere58991b2015-10-13 07:59:34 -070067 CHECK(oat_files_.find(oat_file) == oat_files_.end());
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -070068 for (const std::unique_ptr<const OatFile>& existing : oat_files_) {
69 CHECK_NE(oat_file.get(), existing.get()) << oat_file->GetLocation();
70 // Check that we don't have an oat file with the same address. Copies of the same oat file
71 // should be loaded at different addresses.
72 CHECK_NE(oat_file->Begin(), existing->Begin()) << "Oat file already mapped at that location";
73 }
74 }
75 have_non_pic_oat_file_ = have_non_pic_oat_file_ || !oat_file->IsPic();
Mathieu Chartiere58991b2015-10-13 07:59:34 -070076 const OatFile* ret = oat_file.get();
77 oat_files_.insert(std::move(oat_file));
78 return ret;
79}
80
81void OatFileManager::UnRegisterAndDeleteOatFile(const OatFile* oat_file) {
82 WriterMutexLock mu(Thread::Current(), *Locks::oat_file_manager_lock_);
83 DCHECK(oat_file != nullptr);
84 std::unique_ptr<const OatFile> compare(oat_file);
85 auto it = oat_files_.find(compare);
86 CHECK(it != oat_files_.end());
87 oat_files_.erase(it);
88 compare.release();
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -070089}
90
Calin Juravle0b791272016-04-18 16:38:27 +010091const OatFile* OatFileManager::FindOpenedOatFileFromDexLocation(
92 const std::string& dex_base_location) const {
93 ReaderMutexLock mu(Thread::Current(), *Locks::oat_file_manager_lock_);
94 for (const std::unique_ptr<const OatFile>& oat_file : oat_files_) {
95 const std::vector<const OatDexFile*>& oat_dex_files = oat_file->GetOatDexFiles();
96 for (const OatDexFile* oat_dex_file : oat_dex_files) {
Mathieu Chartier79c87da2017-10-10 11:54:29 -070097 if (DexFileLoader::GetBaseLocation(oat_dex_file->GetDexFileLocation()) == dex_base_location) {
Calin Juravle0b791272016-04-18 16:38:27 +010098 return oat_file.get();
99 }
100 }
101 }
102 return nullptr;
103}
104
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700105const OatFile* OatFileManager::FindOpenedOatFileFromOatLocation(const std::string& oat_location)
106 const {
107 ReaderMutexLock mu(Thread::Current(), *Locks::oat_file_manager_lock_);
Mathieu Chartiere58991b2015-10-13 07:59:34 -0700108 return FindOpenedOatFileFromOatLocationLocked(oat_location);
109}
110
111const OatFile* OatFileManager::FindOpenedOatFileFromOatLocationLocked(
112 const std::string& oat_location) const {
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700113 for (const std::unique_ptr<const OatFile>& oat_file : oat_files_) {
114 if (oat_file->GetLocation() == oat_location) {
115 return oat_file.get();
116 }
117 }
118 return nullptr;
119}
120
Jeff Haodcdc85b2015-12-04 14:06:18 -0800121std::vector<const OatFile*> OatFileManager::GetBootOatFiles() const {
122 std::vector<const OatFile*> oat_files;
123 std::vector<gc::space::ImageSpace*> image_spaces =
124 Runtime::Current()->GetHeap()->GetBootImageSpaces();
125 for (gc::space::ImageSpace* image_space : image_spaces) {
126 oat_files.push_back(image_space->GetOatFile());
127 }
128 return oat_files;
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700129}
130
131const OatFile* OatFileManager::GetPrimaryOatFile() const {
132 ReaderMutexLock mu(Thread::Current(), *Locks::oat_file_manager_lock_);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800133 std::vector<const OatFile*> boot_oat_files = GetBootOatFiles();
134 if (!boot_oat_files.empty()) {
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700135 for (const std::unique_ptr<const OatFile>& oat_file : oat_files_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800136 if (std::find(boot_oat_files.begin(), boot_oat_files.end(), oat_file.get()) ==
137 boot_oat_files.end()) {
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700138 return oat_file.get();
139 }
140 }
141 }
142 return nullptr;
143}
144
Vladimir Markob0b68cf2017-11-14 18:11:50 +0000145OatFileManager::OatFileManager()
146 : have_non_pic_oat_file_(false), only_use_system_oat_files_(false) {}
147
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700148OatFileManager::~OatFileManager() {
Mathieu Chartiere58991b2015-10-13 07:59:34 -0700149 // Explicitly clear oat_files_ since the OatFile destructor calls back into OatFileManager for
150 // UnRegisterOatFileLocation.
151 oat_files_.clear();
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700152}
153
Jeff Haodcdc85b2015-12-04 14:06:18 -0800154std::vector<const OatFile*> OatFileManager::RegisterImageOatFiles(
155 std::vector<gc::space::ImageSpace*> spaces) {
156 std::vector<const OatFile*> oat_files;
157 for (gc::space::ImageSpace* space : spaces) {
158 oat_files.push_back(RegisterOatFile(space->ReleaseOatFile()));
159 }
160 return oat_files;
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700161}
162
Jeff Hao8ec0a202017-03-07 21:56:31 -0800163class TypeIndexInfo {
164 public:
165 explicit TypeIndexInfo(const DexFile* dex_file)
166 : type_indexes_(GenerateTypeIndexes(dex_file)),
167 iter_(type_indexes_.Indexes().begin()),
168 end_(type_indexes_.Indexes().end()) { }
169
170 BitVector& GetTypeIndexes() {
171 return type_indexes_;
172 }
173 BitVector::IndexIterator& GetIterator() {
174 return iter_;
175 }
176 BitVector::IndexIterator& GetIteratorEnd() {
177 return end_;
178 }
179 void AdvanceIterator() {
180 iter_++;
181 }
182
183 private:
184 static BitVector GenerateTypeIndexes(const DexFile* dex_file) {
185 BitVector type_indexes(/*start_bits*/0, /*expandable*/true, Allocator::GetMallocAllocator());
186 for (uint16_t i = 0; i < dex_file->NumClassDefs(); ++i) {
187 const DexFile::ClassDef& class_def = dex_file->GetClassDef(i);
188 uint16_t type_idx = class_def.class_idx_.index_;
189 type_indexes.SetBit(type_idx);
190 }
191 return type_indexes;
192 }
193
194 // BitVector with bits set for the type indexes of all classes in the input dex file.
195 BitVector type_indexes_;
196 BitVector::IndexIterator iter_;
197 BitVector::IndexIterator end_;
198};
199
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700200class DexFileAndClassPair : ValueObject {
201 public:
Jeff Hao8ec0a202017-03-07 21:56:31 -0800202 DexFileAndClassPair(const DexFile* dex_file, TypeIndexInfo* type_info, bool from_loaded_oat)
203 : type_info_(type_info),
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700204 dex_file_(dex_file),
Jeff Hao8ec0a202017-03-07 21:56:31 -0800205 cached_descriptor_(dex_file_->StringByTypeIdx(dex::TypeIndex(*type_info->GetIterator()))),
206 from_loaded_oat_(from_loaded_oat) {
207 type_info_->AdvanceIterator();
208 }
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700209
Mathieu Chartier80b37b72015-10-12 18:13:39 -0700210 DexFileAndClassPair(const DexFileAndClassPair& rhs) = default;
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700211
Mathieu Chartier80b37b72015-10-12 18:13:39 -0700212 DexFileAndClassPair& operator=(const DexFileAndClassPair& rhs) = default;
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700213
214 const char* GetCachedDescriptor() const {
215 return cached_descriptor_;
216 }
217
218 bool operator<(const DexFileAndClassPair& rhs) const {
219 const int cmp = strcmp(cached_descriptor_, rhs.cached_descriptor_);
220 if (cmp != 0) {
221 // Note that the order must be reversed. We want to iterate over the classes in dex files.
222 // They are sorted lexicographically. Thus, the priority-queue must be a min-queue.
223 return cmp > 0;
224 }
225 return dex_file_ < rhs.dex_file_;
226 }
227
228 bool DexFileHasMoreClasses() const {
Jeff Hao8ec0a202017-03-07 21:56:31 -0800229 return type_info_->GetIterator() != type_info_->GetIteratorEnd();
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700230 }
231
232 void Next() {
Jeff Hao8ec0a202017-03-07 21:56:31 -0800233 cached_descriptor_ = dex_file_->StringByTypeIdx(dex::TypeIndex(*type_info_->GetIterator()));
234 type_info_->AdvanceIterator();
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700235 }
236
237 bool FromLoadedOat() const {
238 return from_loaded_oat_;
239 }
240
241 const DexFile* GetDexFile() const {
Jeff Haof0192c82016-03-28 20:39:50 -0700242 return dex_file_;
243 }
244
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700245 private:
Jeff Hao8ec0a202017-03-07 21:56:31 -0800246 TypeIndexInfo* type_info_;
Jeff Haof0192c82016-03-28 20:39:50 -0700247 const DexFile* dex_file_;
Jeff Hao8ec0a202017-03-07 21:56:31 -0800248 const char* cached_descriptor_;
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700249 bool from_loaded_oat_; // We only need to compare mismatches between what we load now
250 // and what was loaded before. Any old duplicates must have been
251 // OK, and any new "internal" duplicates are as well (they must
252 // be from multidex, which resolves correctly).
253};
254
Jeff Hao8ec0a202017-03-07 21:56:31 -0800255static void AddDexFilesFromOat(
256 const OatFile* oat_file,
257 /*out*/std::vector<const DexFile*>* dex_files,
258 std::vector<std::unique_ptr<const DexFile>>* opened_dex_files) {
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700259 for (const OatDexFile* oat_dex_file : oat_file->GetOatDexFiles()) {
260 std::string error;
261 std::unique_ptr<const DexFile> dex_file = oat_dex_file->OpenDexFile(&error);
262 if (dex_file == nullptr) {
263 LOG(WARNING) << "Could not create dex file from oat file: " << error;
264 } else if (dex_file->NumClassDefs() > 0U) {
Jeff Hao8ec0a202017-03-07 21:56:31 -0800265 dex_files->push_back(dex_file.get());
Mathieu Chartier14d7b3e2016-06-09 16:18:04 -0700266 opened_dex_files->push_back(std::move(dex_file));
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700267 }
268 }
269}
270
Jeff Hao8ec0a202017-03-07 21:56:31 -0800271static void AddNext(/*inout*/DexFileAndClassPair& original,
272 /*inout*/std::priority_queue<DexFileAndClassPair>& heap) {
273 if (original.DexFileHasMoreClasses()) {
274 original.Next();
275 heap.push(std::move(original));
Jeff Haof0192c82016-03-28 20:39:50 -0700276 }
277}
278
Jeff Hao8ec0a202017-03-07 21:56:31 -0800279static bool CollisionCheck(std::vector<const DexFile*>& dex_files_loaded,
280 std::vector<const DexFile*>& dex_files_unloaded,
281 std::string* error_msg /*out*/) {
282 // Generate type index information for each dex file.
283 std::vector<TypeIndexInfo> loaded_types;
284 for (const DexFile* dex_file : dex_files_loaded) {
285 loaded_types.push_back(TypeIndexInfo(dex_file));
286 }
287 std::vector<TypeIndexInfo> unloaded_types;
288 for (const DexFile* dex_file : dex_files_unloaded) {
289 unloaded_types.push_back(TypeIndexInfo(dex_file));
290 }
291
292 // Populate the queue of dex file and class pairs with the loaded and unloaded dex files.
293 std::priority_queue<DexFileAndClassPair> queue;
294 for (size_t i = 0; i < dex_files_loaded.size(); ++i) {
295 if (loaded_types[i].GetIterator() != loaded_types[i].GetIteratorEnd()) {
296 queue.emplace(dex_files_loaded[i], &loaded_types[i], /*from_loaded_oat*/true);
297 }
298 }
299 for (size_t i = 0; i < dex_files_unloaded.size(); ++i) {
300 if (unloaded_types[i].GetIterator() != unloaded_types[i].GetIteratorEnd()) {
301 queue.emplace(dex_files_unloaded[i], &unloaded_types[i], /*from_loaded_oat*/false);
302 }
303 }
304
305 // Now drain the queue.
Jeff Hao0471ece2017-04-07 16:28:12 -0700306 bool has_duplicates = false;
307 error_msg->clear();
Jeff Hao8ec0a202017-03-07 21:56:31 -0800308 while (!queue.empty()) {
309 // Modifying the top element is only safe if we pop right after.
310 DexFileAndClassPair compare_pop(queue.top());
311 queue.pop();
312
313 // Compare against the following elements.
314 while (!queue.empty()) {
315 DexFileAndClassPair top(queue.top());
316 if (strcmp(compare_pop.GetCachedDescriptor(), top.GetCachedDescriptor()) == 0) {
317 // Same descriptor. Check whether it's crossing old-oat-files to new-oat-files.
318 if (compare_pop.FromLoadedOat() != top.FromLoadedOat()) {
Jeff Hao0471ece2017-04-07 16:28:12 -0700319 error_msg->append(
320 StringPrintf("Found duplicated class when checking oat files: '%s' in %s and %s\n",
Jeff Hao8ec0a202017-03-07 21:56:31 -0800321 compare_pop.GetCachedDescriptor(),
322 compare_pop.GetDexFile()->GetLocation().c_str(),
Jeff Hao0471ece2017-04-07 16:28:12 -0700323 top.GetDexFile()->GetLocation().c_str()));
324 if (!VLOG_IS_ON(oat)) {
325 return true;
326 }
327 has_duplicates = true;
Jeff Hao8ec0a202017-03-07 21:56:31 -0800328 }
329 queue.pop();
330 AddNext(top, queue);
331 } else {
332 // Something else. Done here.
333 break;
334 }
335 }
336 AddNext(compare_pop, queue);
337 }
338
Jeff Hao0471ece2017-04-07 16:28:12 -0700339 return has_duplicates;
Jeff Haof0192c82016-03-28 20:39:50 -0700340}
341
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700342// Check for class-def collisions in dex files.
343//
Calin Juravle27e0d1f2017-07-26 00:16:07 -0700344// This first walks the class loader chain present in the given context, getting all the dex files
345// from the class loader.
Jeff Haof0192c82016-03-28 20:39:50 -0700346//
Calin Juravle27e0d1f2017-07-26 00:16:07 -0700347// If the context is null (which means the initial class loader was null or unsupported)
348// this returns false. b/37777332.
349//
350// This first checks whether all class loaders in the context have the same type and
351// classpath. If so, we exit early. Otherwise, we do the collision check.
Jeff Haof0192c82016-03-28 20:39:50 -0700352//
353// The collision check works by maintaining a heap with one class from each dex file, sorted by the
354// class descriptor. Then a dex-file/class pair is continually removed from the heap and compared
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700355// against the following top element. If the descriptor is the same, it is now checked whether
356// the two elements agree on whether their dex file was from an already-loaded oat-file or the
357// new oat file. Any disagreement indicates a collision.
358bool OatFileManager::HasCollisions(const OatFile* oat_file,
Calin Juravle27e0d1f2017-07-26 00:16:07 -0700359 const ClassLoaderContext* context,
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700360 std::string* error_msg /*out*/) const {
361 DCHECK(oat_file != nullptr);
362 DCHECK(error_msg != nullptr);
Jeff Haof0192c82016-03-28 20:39:50 -0700363
Calin Juravle3f918642017-07-11 19:04:20 -0700364 // The context might be null if there are unrecognized class loaders in the chain or they
365 // don't meet sensible sanity conditions. In this case we assume that the app knows what it's
366 // doing and accept the oat file.
367 // Note that this has correctness implications as we cannot guarantee that the class resolution
368 // used during compilation is OK (b/37777332).
369 if (context == nullptr) {
370 LOG(WARNING) << "Skipping duplicate class check due to unsupported classloader";
Narayan Kamath5c525742017-04-28 10:19:29 +0100371 return false;
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700372 }
373
Calin Juravle3f918642017-07-11 19:04:20 -0700374 // If the pat file loading context matches the context used during compilation then we accept
375 // the oat file without addition checks
Calin Juravle44e5efa2017-09-12 00:54:26 -0700376 if (context->VerifyClassLoaderContextMatch(oat_file->GetClassLoaderContext())) {
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700377 return false;
378 }
379
Calin Juravle3f918642017-07-11 19:04:20 -0700380 // The class loader context does not match. Perform a full duplicate classes check.
381
382 std::vector<const DexFile*> dex_files_loaded = context->FlattenOpenedDexFiles();
383
Narayan Kamath5c525742017-04-28 10:19:29 +0100384 // Vector that holds the newly opened dex files live, this is done to prevent leaks.
385 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
386
Andreas Gampe1fdbe1b2016-06-10 08:36:20 -0700387 ScopedTrace st("Collision check");
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700388 // Add dex files from the oat file to check.
Jeff Hao8ec0a202017-03-07 21:56:31 -0800389 std::vector<const DexFile*> dex_files_unloaded;
390 AddDexFilesFromOat(oat_file, &dex_files_unloaded, &opened_dex_files);
391 return CollisionCheck(dex_files_loaded, dex_files_unloaded, error_msg);
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700392}
393
394std::vector<std::unique_ptr<const DexFile>> OatFileManager::OpenDexFilesFromOat(
395 const char* dex_location,
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800396 jobject class_loader,
397 jobjectArray dex_elements,
Mathieu Chartiere58991b2015-10-13 07:59:34 -0700398 const OatFile** out_oat_file,
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700399 std::vector<std::string>* error_msgs) {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800400 ScopedTrace trace(__FUNCTION__);
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700401 CHECK(dex_location != nullptr);
402 CHECK(error_msgs != nullptr);
403
404 // Verify we aren't holding the mutator lock, which could starve GC if we
405 // have to generate or relocate an oat file.
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800406 Thread* const self = Thread::Current();
407 Locks::mutator_lock_->AssertNotHeld(self);
408 Runtime* const runtime = Runtime::Current();
Calin Juravleb077e152016-02-18 18:47:37 +0000409
Calin Juravle27e0d1f2017-07-26 00:16:07 -0700410 std::unique_ptr<ClassLoaderContext> context;
411 // If the class_loader is null there's not much we can do. This happens if a dex files is loaded
412 // directly with DexFile APIs instead of using class loaders.
413 if (class_loader == nullptr) {
414 LOG(WARNING) << "Opening an oat file without a class loader. "
415 << "Are you using the deprecated DexFile APIs?";
416 context = nullptr;
417 } else {
418 context = ClassLoaderContext::CreateContextForClassLoader(class_loader, dex_elements);
419 }
420
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700421 OatFileAssistant oat_file_assistant(dex_location,
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700422 kRuntimeISA,
Nicolas Geoffray29742602017-12-14 10:09:03 +0000423 !runtime->IsAotCompiler(),
424 only_use_system_oat_files_);
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700425
426 // Lock the target oat location to avoid races generating and loading the
427 // oat file.
428 std::string error_msg;
429 if (!oat_file_assistant.Lock(/*out*/&error_msg)) {
430 // Don't worry too much if this fails. If it does fail, it's unlikely we
431 // can generate an oat file anyway.
432 VLOG(class_linker) << "OatFileAssistant::Lock: " << error_msg;
433 }
434
435 const OatFile* source_oat_file = nullptr;
436
Nicolas Geoffray29742602017-12-14 10:09:03 +0000437 if (!oat_file_assistant.IsUpToDate()) {
Richard Uhler01be6812016-05-17 10:34:52 -0700438 // Update the oat file on disk if we can, based on the --compiler-filter
439 // option derived from the current runtime options.
440 // This may fail, but that's okay. Best effort is all that matters here.
Calin Juravle8d8d37b2017-10-02 14:56:29 -0700441 // TODO(calin): b/64530081 b/66984396. Pass a null context to verify and compile
442 // secondary dex files in isolation (and avoid to extract/verify the main apk
443 // if it's in the class path). Note this trades correctness for performance
444 // since the resulting slow down is unacceptable in some cases until b/64530081
445 // is fixed.
Nicolas Geoffray55f39ed2017-11-24 10:52:05 +0000446 // We still pass the class loader context when the classpath string of the runtime
447 // is not empty, which is the situation when ART is invoked standalone.
448 ClassLoaderContext* actual_context = Runtime::Current()->GetClassPathString().empty()
449 ? nullptr
450 : context.get();
Calin Juravle8d8d37b2017-10-02 14:56:29 -0700451 switch (oat_file_assistant.MakeUpToDate(/*profile_changed*/ false,
Nicolas Geoffray55f39ed2017-11-24 10:52:05 +0000452 actual_context,
Calin Juravle44e5efa2017-09-12 00:54:26 -0700453 /*out*/ &error_msg)) {
Richard Uhler01be6812016-05-17 10:34:52 -0700454 case OatFileAssistant::kUpdateFailed:
455 LOG(WARNING) << error_msg;
456 break;
Richard Uhler1e860612016-03-30 12:17:55 -0700457
Richard Uhler01be6812016-05-17 10:34:52 -0700458 case OatFileAssistant::kUpdateNotAttempted:
459 // Avoid spamming the logs if we decided not to attempt making the oat
460 // file up to date.
461 VLOG(oat) << error_msg;
462 break;
Richard Uhler1e860612016-03-30 12:17:55 -0700463
Richard Uhler01be6812016-05-17 10:34:52 -0700464 case OatFileAssistant::kUpdateSucceeded:
465 // Nothing to do.
466 break;
467 }
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700468 }
469
470 // Get the oat file on disk.
471 std::unique_ptr<const OatFile> oat_file(oat_file_assistant.GetBestOatFile().release());
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800472
Nicolas Geoffray29742602017-12-14 10:09:03 +0000473 if ((class_loader != nullptr || dex_elements != nullptr) && oat_file != nullptr) {
Nicolas Geoffray68bf3902017-09-07 14:40:48 +0100474 // Prevent oat files from being loaded if no class_loader or dex_elements are provided.
475 // This can happen when the deprecated DexFile.<init>(String) is called directly, and it
476 // could load oat files without checking the classpath, which would be incorrect.
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700477 // Take the file only if it has no collisions, or we must take it because of preopting.
Jeff Haof0192c82016-03-28 20:39:50 -0700478 bool accept_oat_file =
Calin Juravle27e0d1f2017-07-26 00:16:07 -0700479 !HasCollisions(oat_file.get(), context.get(), /*out*/ &error_msg);
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700480 if (!accept_oat_file) {
481 // Failed the collision check. Print warning.
482 if (Runtime::Current()->IsDexFileFallbackEnabled()) {
Narayan Kamath5c525742017-04-28 10:19:29 +0100483 if (!oat_file_assistant.HasOriginalDexFiles()) {
484 // We need to fallback but don't have original dex files. We have to
485 // fallback to opening the existing oat file. This is potentially
486 // unsafe so we warn about it.
487 accept_oat_file = true;
488
489 LOG(WARNING) << "Dex location " << dex_location << " does not seem to include dex file. "
490 << "Allow oat file use. This is potentially dangerous.";
491 } else {
492 // We have to fallback and found original dex files - extract them from an APK.
493 // Also warn about this operation because it's potentially wasteful.
494 LOG(WARNING) << "Found duplicate classes, falling back to extracting from APK : "
495 << dex_location;
496 LOG(WARNING) << "NOTE: This wastes RAM and hurts startup performance.";
497 }
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700498 } else {
Narayan Kamath5c525742017-04-28 10:19:29 +0100499 // TODO: We should remove this. The fact that we're here implies -Xno-dex-file-fallback
500 // was set, which means that we should never fallback. If we don't have original dex
501 // files, we should just fail resolution as the flag intended.
502 if (!oat_file_assistant.HasOriginalDexFiles()) {
503 accept_oat_file = true;
504 }
505
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700506 LOG(WARNING) << "Found duplicate classes, dex-file-fallback disabled, will be failing to "
507 " load classes for " << dex_location;
508 }
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700509
Narayan Kamath5c525742017-04-28 10:19:29 +0100510 LOG(WARNING) << error_msg;
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700511 }
512
513 if (accept_oat_file) {
514 VLOG(class_linker) << "Registering " << oat_file->GetLocation();
515 source_oat_file = RegisterOatFile(std::move(oat_file));
Mathieu Chartiere58991b2015-10-13 07:59:34 -0700516 *out_oat_file = source_oat_file;
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700517 }
518 }
519
520 std::vector<std::unique_ptr<const DexFile>> dex_files;
521
522 // Load the dex files from the oat file.
523 if (source_oat_file != nullptr) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800524 bool added_image_space = false;
525 if (source_oat_file->IsExecutable()) {
Alex Light2ce6fc82017-12-18 16:42:36 -0800526 // We need to throw away the image space if we are debuggable but the oat-file source of the
527 // image is not otherwise we might get classes with inlined methods or other such things.
528 std::unique_ptr<gc::space::ImageSpace> image_space;
529 if (kEnableAppImage && (!runtime->IsJavaDebuggable() || source_oat_file->IsDebuggable())) {
530 image_space = oat_file_assistant.OpenImageSpace(source_oat_file);
531 } else {
532 image_space = nullptr;
533 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800534 if (image_space != nullptr) {
535 ScopedObjectAccess soa(self);
536 StackHandleScope<1> hs(self);
537 Handle<mirror::ClassLoader> h_loader(
Mathieu Chartier0795f232016-09-27 18:43:30 -0700538 hs.NewHandle(soa.Decode<mirror::ClassLoader>(class_loader)));
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800539 // Can not load app image without class loader.
Andreas Gampefa4333d2017-02-14 11:10:34 -0800540 if (h_loader != nullptr) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800541 std::string temp_error_msg;
542 // Add image space has a race condition since other threads could be reading from the
543 // spaces array.
Mathieu Chartiera9d82fe2016-01-25 20:06:11 -0800544 {
545 ScopedThreadSuspension sts(self, kSuspended);
Mathieu Chartier61d2b2d2016-02-04 13:31:46 -0800546 gc::ScopedGCCriticalSection gcs(self,
547 gc::kGcCauseAddRemoveAppImageSpace,
548 gc::kCollectorTypeAddRemoveAppImageSpace);
Mathieu Chartiera9d82fe2016-01-25 20:06:11 -0800549 ScopedSuspendAll ssa("Add image space");
550 runtime->GetHeap()->AddSpace(image_space.get());
551 }
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800552 {
553 ScopedTrace trace2(StringPrintf("Adding image space for location %s", dex_location));
554 added_image_space = runtime->GetClassLinker()->AddImageSpace(image_space.get(),
555 h_loader,
556 dex_elements,
557 dex_location,
558 /*out*/&dex_files,
559 /*out*/&temp_error_msg);
560 }
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800561 if (added_image_space) {
Mathieu Chartierbd064ea2016-02-11 16:27:18 -0800562 // Successfully added image space to heap, release the map so that it does not get
563 // freed.
564 image_space.release();
Bharadwaj Kalandhabhatta0bb40312017-06-01 10:47:00 -0700565
566 // Register for tracking.
567 for (const auto& dex_file : dex_files) {
568 dex::tracking::RegisterDexFile(dex_file.get());
569 }
Mathieu Chartierbd064ea2016-02-11 16:27:18 -0800570 } else {
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800571 LOG(INFO) << "Failed to add image file " << temp_error_msg;
572 dex_files.clear();
Mathieu Chartiera9d82fe2016-01-25 20:06:11 -0800573 {
574 ScopedThreadSuspension sts(self, kSuspended);
Mathieu Chartier61d2b2d2016-02-04 13:31:46 -0800575 gc::ScopedGCCriticalSection gcs(self,
576 gc::kGcCauseAddRemoveAppImageSpace,
577 gc::kCollectorTypeAddRemoveAppImageSpace);
Mathieu Chartiera9d82fe2016-01-25 20:06:11 -0800578 ScopedSuspendAll ssa("Remove image space");
579 runtime->GetHeap()->RemoveSpace(image_space.get());
580 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800581 // Non-fatal, don't update error_msg.
582 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800583 }
584 }
585 }
586 if (!added_image_space) {
587 DCHECK(dex_files.empty());
588 dex_files = oat_file_assistant.LoadDexFiles(*source_oat_file, dex_location);
Bharadwaj Kalandhabhatta0bb40312017-06-01 10:47:00 -0700589
590 // Register for tracking.
591 for (const auto& dex_file : dex_files) {
592 dex::tracking::RegisterDexFile(dex_file.get());
593 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800594 }
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700595 if (dex_files.empty()) {
596 error_msgs->push_back("Failed to open dex files from " + source_oat_file->GetLocation());
Mathieu Chartierbe8303d2017-08-17 17:39:39 -0700597 } else {
Mathieu Chartier120aa282017-08-05 16:03:03 -0700598 // Opened dex files from an oat file, madvise them to their loaded state.
599 for (const std::unique_ptr<const DexFile>& dex_file : dex_files) {
600 OatDexFile::MadviseDexFile(*dex_file, MadviseState::kMadviseStateAtLoad);
601 }
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700602 }
603 }
604
605 // Fall back to running out of the original dex file if we couldn't load any
606 // dex_files from the oat file.
607 if (dex_files.empty()) {
608 if (oat_file_assistant.HasOriginalDexFiles()) {
609 if (Runtime::Current()->IsDexFileFallbackEnabled()) {
Aart Bik37d6a3b2016-06-21 18:30:10 -0700610 static constexpr bool kVerifyChecksum = true;
David Sehr013fd802018-01-11 22:55:24 -0800611 const ArtDexFileLoader dex_file_loader;
612 if (!dex_file_loader.Open(dex_location,
613 dex_location,
614 Runtime::Current()->IsVerificationEnabled(),
615 kVerifyChecksum,
616 /*out*/ &error_msg,
617 &dex_files)) {
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700618 LOG(WARNING) << error_msg;
Alex Light3045b662016-04-20 14:26:34 -0700619 error_msgs->push_back("Failed to open dex files from " + std::string(dex_location)
620 + " because: " + error_msg);
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700621 }
622 } else {
623 error_msgs->push_back("Fallback mode disabled, skipping dex files.");
624 }
625 } else {
626 error_msgs->push_back("No original dex files found for dex location "
627 + std::string(dex_location));
628 }
629 }
Calin Juravlec90bc922016-02-24 10:13:09 +0000630
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700631 return dex_files;
632}
633
Nicolas Geoffray68bf3902017-09-07 14:40:48 +0100634void OatFileManager::SetOnlyUseSystemOatFiles() {
635 ReaderMutexLock mu(Thread::Current(), *Locks::oat_file_manager_lock_);
636 CHECK_EQ(oat_files_.size(), GetBootOatFiles().size());
637 only_use_system_oat_files_ = true;
638}
639
Nicolas Geoffray04680f32016-03-17 11:56:54 +0000640void OatFileManager::DumpForSigQuit(std::ostream& os) {
641 ReaderMutexLock mu(Thread::Current(), *Locks::oat_file_manager_lock_);
642 std::vector<const OatFile*> boot_oat_files = GetBootOatFiles();
643 for (const std::unique_ptr<const OatFile>& oat_file : oat_files_) {
644 if (ContainsElement(boot_oat_files, oat_file.get())) {
645 continue;
646 }
Andreas Gampe29d38e72016-03-23 15:31:51 +0000647 os << oat_file->GetLocation() << ": " << oat_file->GetCompilerFilter() << "\n";
Nicolas Geoffray04680f32016-03-17 11:56:54 +0000648 }
649}
650
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700651} // namespace art