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> 21 #include <set> 22 #include <string> 23 #include <unordered_map> 24 #include <vector> 25 26 #include "base/compiler_filter.h" 27 #include "base/locks.h" 28 #include "base/macros.h" 29 #include "jni.h" 30 31 namespace art { 32 33 namespace gc { 34 namespace space { 35 class ImageSpace; 36 } // namespace space 37 } // namespace gc 38 39 class ClassLoaderContext; 40 class DexFile; 41 class MemMap; 42 class OatFile; 43 class ThreadPool; 44 45 // Class for dealing with oat file management. 46 // 47 // This class knows about all the loaded oat files and provides utility functions. The oat file 48 // pointers returned from functions are always valid. 49 class OatFileManager { 50 public: 51 OatFileManager(); 52 ~OatFileManager(); 53 54 // Add an oat file to the internal accounting, std::aborts if there already exists an oat file 55 // with the same base address. Returns the oat file pointer from oat_file. 56 // The `in_memory` parameter is whether the oat file is not present on disk, 57 // but only in memory (for example files created with memfd). 58 const OatFile* RegisterOatFile(std::unique_ptr<const OatFile> oat_file, bool in_memory = false) 59 REQUIRES(!Locks::oat_file_manager_lock_); 60 61 void UnRegisterAndDeleteOatFile(const OatFile* oat_file) 62 REQUIRES(!Locks::oat_file_manager_lock_); 63 64 // Find the first opened oat file with the same location, returns null if there are none. 65 const OatFile* FindOpenedOatFileFromOatLocation(const std::string& oat_location) const 66 REQUIRES(!Locks::oat_file_manager_lock_); 67 68 // Find the oat file which contains a dex files with the given dex base location, 69 // returns null if there are none. 70 const OatFile* FindOpenedOatFileFromDexLocation(const std::string& dex_base_location) const 71 REQUIRES(!Locks::oat_file_manager_lock_); 72 73 // Returns the boot image oat files. 74 std::vector<const OatFile*> GetBootOatFiles() const; 75 76 // Returns the oat files for the images, registers the oat files. 77 // Takes ownership of the imagespace's underlying oat files. 78 std::vector<const OatFile*> RegisterImageOatFiles( 79 const std::vector<gc::space::ImageSpace*>& spaces) 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, 98 jobject class_loader, 99 jobjectArray dex_elements, 100 /*out*/ const OatFile** out_oat_file, 101 /*out*/ std::vector<std::string>* error_msgs) 102 REQUIRES(!Locks::oat_file_manager_lock_, !Locks::mutator_lock_); 103 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 121 void DumpForSigQuit(std::ostream& os); 122 123 void SetOnlyUseTrustedOatFiles(); 124 void ClearOnlyUseTrustedOatFiles(); 125 126 // Spawn a background thread which verifies all classes in the given dex files. 127 void RunBackgroundVerification(const std::vector<const DexFile*>& dex_files, 128 jobject class_loader); 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 any ongoing background verification tasks to finish. 138 void WaitForBackgroundVerificationTasksToFinish(); 139 140 // Wait for all background verification tasks to finish. This is only used by tests. 141 void WaitForBackgroundVerificationTasks(); 142 143 // Maximum number of anonymous vdex files kept in the process' data folder. 144 static constexpr size_t kAnonymousVdexCacheSize = 8u; 145 146 bool ContainsPc(const void* pc) REQUIRES(!Locks::oat_file_manager_lock_); 147 148 private: 149 std::vector<std::unique_ptr<const DexFile>> OpenDexFilesFromOat_Impl( 150 std::vector<MemMap>&& dex_mem_maps, 151 jobject class_loader, 152 jobjectArray dex_elements, 153 /*out*/ const OatFile** out_oat_file, 154 /*out*/ std::vector<std::string>* error_msgs) 155 REQUIRES(!Locks::oat_file_manager_lock_, !Locks::mutator_lock_); 156 157 const OatFile* FindOpenedOatFileFromOatLocationLocked(const std::string& oat_location) const 158 REQUIRES(Locks::oat_file_manager_lock_); 159 160 // Return true if we should attempt to load the app image. 161 bool ShouldLoadAppImage(const OatFile* source_oat_file) const; 162 163 std::set<std::unique_ptr<const OatFile>> oat_files_ GUARDED_BY(Locks::oat_file_manager_lock_); 164 165 // Only use the compiled code in an OAT file when the file is on /system. If the OAT file 166 // is not on /system, don't load it "executable". 167 bool only_use_system_oat_files_; 168 169 // Single-thread pool used to run the verifier in the background. 170 std::unique_ptr<ThreadPool> verification_thread_pool_; 171 172 DISALLOW_COPY_AND_ASSIGN(OatFileManager); 173 }; 174 175 } // namespace art 176 177 #endif // ART_RUNTIME_OAT_FILE_MANAGER_H_ 178