Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 1 | /* |
| 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 | #ifndef ART_RUNTIME_OAT_FILE_MANAGER_H_ |
| 18 | #define ART_RUNTIME_OAT_FILE_MANAGER_H_ |
| 19 | |
| 20 | #include <memory> |
Mathieu Chartier | e58991b | 2015-10-13 07:59:34 -0700 | [diff] [blame] | 21 | #include <set> |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 22 | #include <string> |
Mathieu Chartier | e58991b | 2015-10-13 07:59:34 -0700 | [diff] [blame] | 23 | #include <unordered_map> |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 24 | #include <vector> |
| 25 | |
Andreas Gampe | 7fbc4a5 | 2018-11-28 08:26:47 -0800 | [diff] [blame] | 26 | #include "base/locks.h" |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 27 | #include "base/macros.h" |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 28 | #include "jni.h" |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 29 | |
| 30 | namespace art { |
| 31 | |
| 32 | namespace gc { |
| 33 | namespace space { |
| 34 | class ImageSpace; |
| 35 | } // namespace space |
| 36 | } // namespace gc |
| 37 | |
Calin Juravle | 27e0d1f | 2017-07-26 00:16:07 -0700 | [diff] [blame] | 38 | class ClassLoaderContext; |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 39 | class DexFile; |
David Brazdil | 7126c5b | 2019-03-05 00:02:51 +0000 | [diff] [blame] | 40 | class MemMap; |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 41 | class OatFile; |
David Brazdil | 331a5e1 | 2019-04-01 22:46:16 +0000 | [diff] [blame] | 42 | class ThreadPool; |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 43 | |
| 44 | // Class for dealing with oat file management. |
| 45 | // |
| 46 | // This class knows about all the loaded oat files and provides utility functions. The oat file |
| 47 | // pointers returned from functions are always valid. |
| 48 | class OatFileManager { |
| 49 | public: |
Vladimir Marko | b0b68cf | 2017-11-14 18:11:50 +0000 | [diff] [blame] | 50 | OatFileManager(); |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 51 | ~OatFileManager(); |
| 52 | |
| 53 | // Add an oat file to the internal accounting, std::aborts if there already exists an oat file |
| 54 | // with the same base address. Returns the oat file pointer from oat_file. |
| 55 | const OatFile* RegisterOatFile(std::unique_ptr<const OatFile> oat_file) |
| 56 | REQUIRES(!Locks::oat_file_manager_lock_); |
| 57 | |
Mathieu Chartier | e58991b | 2015-10-13 07:59:34 -0700 | [diff] [blame] | 58 | void UnRegisterAndDeleteOatFile(const OatFile* oat_file) |
| 59 | REQUIRES(!Locks::oat_file_manager_lock_); |
| 60 | |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 61 | // Find the first opened oat file with the same location, returns null if there are none. |
| 62 | const OatFile* FindOpenedOatFileFromOatLocation(const std::string& oat_location) const |
| 63 | REQUIRES(!Locks::oat_file_manager_lock_); |
| 64 | |
Calin Juravle | 0b79127 | 2016-04-18 16:38:27 +0100 | [diff] [blame] | 65 | // Find the oat file which contains a dex files with the given dex base location, |
| 66 | // returns null if there are none. |
| 67 | const OatFile* FindOpenedOatFileFromDexLocation(const std::string& dex_base_location) const |
| 68 | REQUIRES(!Locks::oat_file_manager_lock_); |
| 69 | |
Jeff Hao | dcdc85b | 2015-12-04 14:06:18 -0800 | [diff] [blame] | 70 | // Returns the boot image oat files. |
| 71 | std::vector<const OatFile*> GetBootOatFiles() const; |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 72 | |
| 73 | // Returns the first non-image oat file in the class path. |
| 74 | const OatFile* GetPrimaryOatFile() const REQUIRES(!Locks::oat_file_manager_lock_); |
| 75 | |
Jeff Hao | dcdc85b | 2015-12-04 14:06:18 -0800 | [diff] [blame] | 76 | // Returns the oat files for the images, registers the oat files. |
| 77 | // Takes ownership of the imagespace's underlying oat files. |
Stephen Hines | 48ba197 | 2018-09-24 13:35:54 -0700 | [diff] [blame] | 78 | std::vector<const OatFile*> RegisterImageOatFiles( |
| 79 | const std::vector<gc::space::ImageSpace*>& spaces) |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 80 | REQUIRES(!Locks::oat_file_manager_lock_); |
| 81 | |
| 82 | // Finds or creates the oat file holding dex_location. Then loads and returns |
| 83 | // all corresponding dex files (there may be more than one dex file loaded |
| 84 | // in the case of multidex). |
| 85 | // This may return the original, unquickened dex files if the oat file could |
| 86 | // not be generated. |
| 87 | // |
| 88 | // Returns an empty vector if the dex files could not be loaded. In this |
| 89 | // case, there will be at least one error message returned describing why no |
| 90 | // dex files could not be loaded. The 'error_msgs' argument must not be |
| 91 | // null, regardless of whether there is an error or not. |
| 92 | // |
| 93 | // This method should not be called with the mutator_lock_ held, because it |
| 94 | // could end up starving GC if we need to generate or relocate any oat |
| 95 | // files. |
| 96 | std::vector<std::unique_ptr<const DexFile>> OpenDexFilesFromOat( |
| 97 | const char* dex_location, |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 98 | jobject class_loader, |
| 99 | jobjectArray dex_elements, |
Mathieu Chartier | e58991b | 2015-10-13 07:59:34 -0700 | [diff] [blame] | 100 | /*out*/ const OatFile** out_oat_file, |
| 101 | /*out*/ std::vector<std::string>* error_msgs) |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 102 | REQUIRES(!Locks::oat_file_manager_lock_, !Locks::mutator_lock_); |
| 103 | |
David Brazdil | 7126c5b | 2019-03-05 00:02:51 +0000 | [diff] [blame] | 104 | // Opens dex files provided in `dex_mem_maps` and attempts to find an anonymous |
| 105 | // vdex file created during a previous load attempt. If found, will initialize |
| 106 | // an instance of OatFile to back the DexFiles and preverify them using the |
| 107 | // vdex's VerifierDeps. |
| 108 | // |
| 109 | // Returns an empty vector if the dex files could not be loaded. In this |
| 110 | // case, there will be at least one error message returned describing why no |
| 111 | // dex files could not be loaded. The 'error_msgs' argument must not be |
| 112 | // null, regardless of whether there is an error or not. |
| 113 | std::vector<std::unique_ptr<const DexFile>> OpenDexFilesFromOat( |
| 114 | std::vector<MemMap>&& dex_mem_maps, |
| 115 | jobject class_loader, |
| 116 | jobjectArray dex_elements, |
| 117 | /*out*/ const OatFile** out_oat_file, |
| 118 | /*out*/ std::vector<std::string>* error_msgs) |
| 119 | REQUIRES(!Locks::oat_file_manager_lock_, !Locks::mutator_lock_); |
| 120 | |
Nicolas Geoffray | 04680f3 | 2016-03-17 11:56:54 +0000 | [diff] [blame] | 121 | void DumpForSigQuit(std::ostream& os); |
| 122 | |
Andreas Gampe | 9ef308d | 2019-03-28 11:06:26 -0700 | [diff] [blame] | 123 | void SetOnlyUseSystemOatFiles(bool enforce, bool assert_no_files_loaded); |
Nicolas Geoffray | 68bf390 | 2017-09-07 14:40:48 +0100 | [diff] [blame] | 124 | |
David Brazdil | 331a5e1 | 2019-04-01 22:46:16 +0000 | [diff] [blame] | 125 | // Spawn a background thread which verifies all classes in the given dex files. |
| 126 | void RunBackgroundVerification(const std::vector<const DexFile*>& dex_files, |
David Brazdil | 35a3f6a | 2019-03-04 15:59:06 +0000 | [diff] [blame] | 127 | jobject class_loader, |
| 128 | const char* class_loader_context); |
David Brazdil | 331a5e1 | 2019-04-01 22:46:16 +0000 | [diff] [blame] | 129 | |
| 130 | // Wait for thread pool workers to be created. This is used during shutdown as |
| 131 | // threads are not allowed to attach while runtime is in shutdown lock. |
| 132 | void WaitForWorkersToBeCreated(); |
| 133 | |
| 134 | // If allocated, delete a thread pool of background verification threads. |
| 135 | void DeleteThreadPool(); |
| 136 | |
| 137 | // Wait for all background verification tasks to finish. This is only used by tests. |
| 138 | void WaitForBackgroundVerificationTasks(); |
| 139 | |
David Brazdil | 35a3f6a | 2019-03-04 15:59:06 +0000 | [diff] [blame] | 140 | // Maximum number of anonymous vdex files kept in the process' data folder. |
| 141 | static constexpr size_t kAnonymousVdexCacheSize = 8u; |
| 142 | |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 143 | private: |
Mathieu Chartier | adc9086 | 2018-05-11 13:03:06 -0700 | [diff] [blame] | 144 | enum class CheckCollisionResult { |
| 145 | kSkippedUnsupportedClassLoader, |
| 146 | kSkippedClassLoaderContextSharedLibrary, |
| 147 | kNoCollisions, |
| 148 | kPerformedHasCollisions, |
| 149 | }; |
| 150 | |
David Brazdil | 7126c5b | 2019-03-05 00:02:51 +0000 | [diff] [blame] | 151 | std::vector<std::unique_ptr<const DexFile>> OpenDexFilesFromOat_Impl( |
| 152 | std::vector<MemMap>&& dex_mem_maps, |
| 153 | jobject class_loader, |
| 154 | jobjectArray dex_elements, |
| 155 | /*out*/ const OatFile** out_oat_file, |
| 156 | /*out*/ std::vector<std::string>* error_msgs) |
| 157 | REQUIRES(!Locks::oat_file_manager_lock_, !Locks::mutator_lock_); |
| 158 | |
Calin Juravle | 27e0d1f | 2017-07-26 00:16:07 -0700 | [diff] [blame] | 159 | // Check that the class loader context of the given oat file matches the given context. |
| 160 | // This will perform a check that all class loaders in the chain have the same type and |
| 161 | // classpath. |
| 162 | // If the context is null (which means the initial class loader was null or unsupported) |
Mathieu Chartier | adc9086 | 2018-05-11 13:03:06 -0700 | [diff] [blame] | 163 | // this returns kSkippedUnsupportedClassLoader. |
Calin Juravle | 27e0d1f | 2017-07-26 00:16:07 -0700 | [diff] [blame] | 164 | // If the context does not validate the method will check for duplicate class definitions of |
| 165 | // the given oat file against the oat files (either from the class loaders if possible or all |
| 166 | // non-boot oat files otherwise). |
Mathieu Chartier | adc9086 | 2018-05-11 13:03:06 -0700 | [diff] [blame] | 167 | // Return kPerformedHasCollisions if there are any class definition collisions in the oat_file. |
| 168 | CheckCollisionResult CheckCollision(const OatFile* oat_file, |
| 169 | const ClassLoaderContext* context, |
| 170 | /*out*/ std::string* error_msg) const |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 171 | REQUIRES(!Locks::oat_file_manager_lock_); |
| 172 | |
Mathieu Chartier | e58991b | 2015-10-13 07:59:34 -0700 | [diff] [blame] | 173 | const OatFile* FindOpenedOatFileFromOatLocationLocked(const std::string& oat_location) const |
| 174 | REQUIRES(Locks::oat_file_manager_lock_); |
| 175 | |
Mathieu Chartier | adc9086 | 2018-05-11 13:03:06 -0700 | [diff] [blame] | 176 | // Return true if we should accept the oat file. |
| 177 | bool AcceptOatFile(CheckCollisionResult result) const; |
| 178 | |
| 179 | // Return true if we should attempt to load the app image. |
| 180 | bool ShouldLoadAppImage(CheckCollisionResult check_collision_result, |
| 181 | const OatFile* source_oat_file, |
| 182 | ClassLoaderContext* context, |
| 183 | std::string* error_msg); |
| 184 | |
Mathieu Chartier | e58991b | 2015-10-13 07:59:34 -0700 | [diff] [blame] | 185 | std::set<std::unique_ptr<const OatFile>> oat_files_ GUARDED_BY(Locks::oat_file_manager_lock_); |
Nicolas Geoffray | 2974260 | 2017-12-14 10:09:03 +0000 | [diff] [blame] | 186 | |
| 187 | // Only use the compiled code in an OAT file when the file is on /system. If the OAT file |
| 188 | // is not on /system, don't load it "executable". |
Nicolas Geoffray | 68bf390 | 2017-09-07 14:40:48 +0100 | [diff] [blame] | 189 | bool only_use_system_oat_files_; |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame] | 190 | |
David Brazdil | 331a5e1 | 2019-04-01 22:46:16 +0000 | [diff] [blame] | 191 | // Single-thread pool used to run the verifier in the background. |
| 192 | std::unique_ptr<ThreadPool> verification_thread_pool_; |
| 193 | |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 194 | DISALLOW_COPY_AND_ASSIGN(OatFileManager); |
| 195 | }; |
| 196 | |
| 197 | } // namespace art |
| 198 | |
| 199 | #endif // ART_RUNTIME_OAT_FILE_MANAGER_H_ |