Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2014 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | #ifndef ART_RUNTIME_OAT_FILE_ASSISTANT_H_ |
| 18 | #define ART_RUNTIME_OAT_FILE_ASSISTANT_H_ |
| 19 | |
| 20 | #include <cstdint> |
| 21 | #include <memory> |
Narayan Kamath | 8943c1d | 2016-05-02 13:14:48 +0100 | [diff] [blame] | 22 | #include <sstream> |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 23 | #include <string> |
| 24 | |
| 25 | #include "arch/instruction_set.h" |
David Sehr | c431b9d | 2018-03-02 12:01:51 -0800 | [diff] [blame] | 26 | #include "base/os.h" |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 27 | #include "base/scoped_flock.h" |
| 28 | #include "base/unix_file/fd_file.h" |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame] | 29 | #include "compiler_filter.h" |
Calin Juravle | 44e5efa | 2017-09-12 00:54:26 -0700 | [diff] [blame] | 30 | #include "class_loader_context.h" |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 31 | #include "oat_file.h" |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 32 | |
| 33 | namespace art { |
| 34 | |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 35 | namespace gc { |
| 36 | namespace space { |
| 37 | class ImageSpace; |
| 38 | } // namespace space |
| 39 | } // namespace gc |
| 40 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 41 | // Class for assisting with oat file management. |
| 42 | // |
| 43 | // This class collects common utilities for determining the status of an oat |
| 44 | // file on the device, updating the oat file, and loading the oat file. |
| 45 | // |
| 46 | // The oat file assistant is intended to be used with dex locations not on the |
| 47 | // boot class path. See the IsInBootClassPath method for a way to check if the |
| 48 | // dex location is in the boot class path. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 49 | class OatFileAssistant { |
| 50 | public: |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 51 | enum DexOptNeeded { |
Richard Uhler | 7225a8d | 2016-11-22 10:12:03 +0000 | [diff] [blame] | 52 | // No dexopt should (or can) be done to update the apk/jar. |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 53 | // Matches Java: dalvik.system.DexFile.NO_DEXOPT_NEEDED = 0 |
| 54 | kNoDexOptNeeded = 0, |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 55 | |
Richard Uhler | 7225a8d | 2016-11-22 10:12:03 +0000 | [diff] [blame] | 56 | // dex2oat should be run to update the apk/jar from scratch. |
| 57 | // Matches Java: dalvik.system.DexFile.DEX2OAT_FROM_SCRATCH = 1 |
| 58 | kDex2OatFromScratch = 1, |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 59 | |
Richard Uhler | 7225a8d | 2016-11-22 10:12:03 +0000 | [diff] [blame] | 60 | // dex2oat should be run to update the apk/jar because the existing code |
| 61 | // is out of date with respect to the boot image. |
| 62 | // Matches Java: dalvik.system.DexFile.DEX2OAT_FOR_BOOT_IMAGE |
| 63 | kDex2OatForBootImage = 2, |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 64 | |
Richard Uhler | 7225a8d | 2016-11-22 10:12:03 +0000 | [diff] [blame] | 65 | // dex2oat should be run to update the apk/jar because the existing code |
| 66 | // is out of date with respect to the target compiler filter. |
| 67 | // Matches Java: dalvik.system.DexFile.DEX2OAT_FOR_FILTER |
| 68 | kDex2OatForFilter = 3, |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 69 | }; |
| 70 | |
| 71 | enum OatStatus { |
Richard Uhler | 03bc659 | 2016-11-22 09:42:04 +0000 | [diff] [blame] | 72 | // kOatCannotOpen - The oat file cannot be opened, because it does not |
| 73 | // exist, is unreadable, or otherwise corrupted. |
| 74 | kOatCannotOpen, |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 75 | |
Richard Uhler | 03bc659 | 2016-11-22 09:42:04 +0000 | [diff] [blame] | 76 | // kOatDexOutOfDate - The oat file is out of date with respect to the dex file. |
| 77 | kOatDexOutOfDate, |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 78 | |
Richard Uhler | 03bc659 | 2016-11-22 09:42:04 +0000 | [diff] [blame] | 79 | // kOatBootImageOutOfDate - The oat file is up to date with respect to the |
| 80 | // dex file, but is out of date with respect to the boot image. |
| 81 | kOatBootImageOutOfDate, |
| 82 | |
Richard Uhler | 03bc659 | 2016-11-22 09:42:04 +0000 | [diff] [blame] | 83 | // kOatUpToDate - The oat file is completely up to date with respect to |
| 84 | // the dex file and boot image. |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 85 | kOatUpToDate, |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 86 | }; |
| 87 | |
| 88 | // Constructs an OatFileAssistant object to assist the oat file |
| 89 | // corresponding to the given dex location with the target instruction set. |
| 90 | // |
Mathieu Chartier | 2cebb24 | 2015-04-21 16:50:40 -0700 | [diff] [blame] | 91 | // The dex_location must not be null and should remain available and |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 92 | // unchanged for the duration of the lifetime of the OatFileAssistant object. |
| 93 | // Typically the dex_location is the absolute path to the original, |
| 94 | // un-optimized dex file. |
| 95 | // |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 96 | // Note: Currently the dex_location must have an extension. |
| 97 | // TODO: Relax this restriction? |
| 98 | // |
| 99 | // The isa should be either the 32 bit or 64 bit variant for the current |
| 100 | // device. For example, on an arm device, use arm or arm64. An oat file can |
| 101 | // be loaded executable only if the ISA matches the current runtime. |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame] | 102 | // |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame] | 103 | // load_executable should be true if the caller intends to try and load |
| 104 | // executable code for this dex location. |
Nicolas Geoffray | 2974260 | 2017-12-14 10:09:03 +0000 | [diff] [blame] | 105 | // |
| 106 | // only_load_system_executable should be true if the caller intends to have |
| 107 | // only oat files from /system loaded executable. |
Calin Juravle | b077e15 | 2016-02-18 18:47:37 +0000 | [diff] [blame] | 108 | OatFileAssistant(const char* dex_location, |
Calin Juravle | b077e15 | 2016-02-18 18:47:37 +0000 | [diff] [blame] | 109 | const InstructionSet isa, |
Nicolas Geoffray | 2974260 | 2017-12-14 10:09:03 +0000 | [diff] [blame] | 110 | bool load_executable, |
| 111 | bool only_load_system_executable = false); |
Shubham Ajmera | c12bf4c | 2017-10-24 16:59:42 -0700 | [diff] [blame] | 112 | |
| 113 | // Similar to this(const char*, const InstructionSet, bool), however, if a valid zip_fd is |
| 114 | // provided, vdex, oat, and zip files will be read from vdex_fd, oat_fd and zip_fd respectively. |
| 115 | // Otherwise, dex_location will be used to construct necessary filenames. |
| 116 | OatFileAssistant(const char* dex_location, |
| 117 | const InstructionSet isa, |
Shubham Ajmera | b22dea0 | 2017-10-04 18:36:41 -0700 | [diff] [blame] | 118 | bool load_executable, |
Nicolas Geoffray | 2974260 | 2017-12-14 10:09:03 +0000 | [diff] [blame] | 119 | bool only_load_system_executable, |
Shubham Ajmera | c12bf4c | 2017-10-24 16:59:42 -0700 | [diff] [blame] | 120 | int vdex_fd, |
| 121 | int oat_fd, |
| 122 | int zip_fd); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 123 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 124 | ~OatFileAssistant(); |
| 125 | |
| 126 | // Returns true if the dex location refers to an element of the boot class |
| 127 | // path. |
| 128 | bool IsInBootClassPath(); |
| 129 | |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 130 | // Return what action needs to be taken to produce up-to-date code for this |
Shubham Ajmera | e4e812a | 2017-05-25 20:09:58 -0700 | [diff] [blame] | 131 | // dex location. If "downgrade" is set to false, it verifies if the current |
| 132 | // compiler filter is at least as good as an oat file generated with the |
| 133 | // given compiler filter otherwise, if its set to true, it checks whether |
| 134 | // the oat file generated with the target filter will be downgraded as |
| 135 | // compared to the current state. For example, if the current compiler filter is |
| 136 | // quicken, and target filter is verify, it will recommend to dexopt, while |
| 137 | // if the target filter is speed profile, it will recommend to keep it in its |
| 138 | // current state. |
| 139 | // profile_changed should be true to indicate the profile has recently changed |
| 140 | // for this dex location. |
| 141 | // If the purpose of the dexopt is to downgrade the compiler filter, |
| 142 | // set downgrade to true. |
Richard Uhler | 7225a8d | 2016-11-22 10:12:03 +0000 | [diff] [blame] | 143 | // Returns a positive status code if the status refers to the oat file in |
| 144 | // the oat location. Returns a negative status code if the status refers to |
| 145 | // the oat file in the odex location. |
Shubham Ajmera | e4e812a | 2017-05-25 20:09:58 -0700 | [diff] [blame] | 146 | int GetDexOptNeeded(CompilerFilter::Filter target_compiler_filter, |
| 147 | bool profile_changed = false, |
Calin Juravle | 44e5efa | 2017-09-12 00:54:26 -0700 | [diff] [blame] | 148 | bool downgrade = false, |
David Brazdil | 8982186 | 2019-03-19 13:57:43 +0000 | [diff] [blame^] | 149 | ClassLoaderContext* context = nullptr, |
| 150 | const std::vector<int>& context_fds = std::vector<int>()); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 151 | |
Richard Uhler | 01be681 | 2016-05-17 10:34:52 -0700 | [diff] [blame] | 152 | // Returns true if there is up-to-date code for this dex location, |
| 153 | // irrespective of the compiler filter of the up-to-date code. |
| 154 | bool IsUpToDate(); |
| 155 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 156 | // Returns an oat file that can be used for loading dex files. |
Mathieu Chartier | 2cebb24 | 2015-04-21 16:50:40 -0700 | [diff] [blame] | 157 | // Returns null if no suitable oat file was found. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 158 | // |
| 159 | // After this call, no other methods of the OatFileAssistant should be |
| 160 | // called, because access to the loaded oat file has been taken away from |
| 161 | // the OatFileAssistant object. |
| 162 | std::unique_ptr<OatFile> GetBestOatFile(); |
| 163 | |
Richard Uhler | 46cc64f | 2016-11-14 14:53:55 +0000 | [diff] [blame] | 164 | // Returns a human readable description of the status of the code for the |
| 165 | // dex file. The returned description is for debugging purposes only. |
| 166 | std::string GetStatusDump(); |
| 167 | |
Calin Juravle | 5f9a801 | 2018-02-12 20:27:46 -0800 | [diff] [blame] | 168 | // Computes the optimization status of the given dex file. The result is |
| 169 | // returned via the two output parameters. |
| 170 | // - out_compilation_filter: the level of optimizations (compiler filter) |
| 171 | // - out_compilation_reason: the optimization reason. The reason might |
| 172 | // be "unknown" if the compiler artifacts were not annotated during optimizations. |
| 173 | // |
| 174 | // This method will try to mimic the runtime effect of loading the dex file. |
| 175 | // For example, if there is no usable oat file, the compiler filter will be set |
| 176 | // to "run-from-apk". |
| 177 | static void GetOptimizationStatus(const std::string& filename, |
| 178 | InstructionSet isa, |
| 179 | std::string* out_compilation_filter, |
| 180 | std::string* out_compilation_reason); |
| 181 | |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 182 | // Open and returns an image space associated with the oat file. |
Andreas Gampe | a463b6a | 2016-08-12 21:53:32 -0700 | [diff] [blame] | 183 | static std::unique_ptr<gc::space::ImageSpace> OpenImageSpace(const OatFile* oat_file); |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 184 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 185 | // Loads the dex files in the given oat file for the given dex location. |
| 186 | // The oat file should be up to date for the given dex location. |
| 187 | // This loads multiple dex files in the case of multidex. |
| 188 | // Returns an empty vector if no dex files for that location could be loaded |
| 189 | // from the oat file. |
| 190 | // |
| 191 | // The caller is responsible for freeing the dex_files returned, if any. The |
| 192 | // dex_files will only remain valid as long as the oat_file is valid. |
| 193 | static std::vector<std::unique_ptr<const DexFile>> LoadDexFiles( |
| 194 | const OatFile& oat_file, const char* dex_location); |
| 195 | |
Calin Juravle | 87e2cb6 | 2017-06-13 21:48:45 -0700 | [diff] [blame] | 196 | // Same as `std::vector<std::unique_ptr<const DexFile>> LoadDexFiles(...)` with the difference: |
| 197 | // - puts the dex files in the given vector |
| 198 | // - returns whether or not all dex files were successfully opened |
| 199 | static bool LoadDexFiles(const OatFile& oat_file, |
| 200 | const std::string& dex_location, |
| 201 | std::vector<std::unique_ptr<const DexFile>>* out_dex_files); |
| 202 | |
Richard Uhler | 9b994ea | 2015-06-24 08:44:19 -0700 | [diff] [blame] | 203 | // Returns true if there are dex files in the original dex location that can |
| 204 | // be compiled with dex2oat for this dex location. |
| 205 | // Returns false if there is no original dex file, or if the original dex |
| 206 | // file is an apk/zip without a classes.dex entry. |
| 207 | bool HasOriginalDexFiles(); |
| 208 | |
Richard Uhler | 6343411 | 2015-03-16 14:32:16 -0700 | [diff] [blame] | 209 | // If the dex file has been installed with a compiled oat file alongside |
| 210 | // it, the compiled oat file will have the extension .odex, and is referred |
| 211 | // to as the odex file. It is called odex for legacy reasons; the file is |
| 212 | // really an oat file. The odex file will often, but not always, have a |
| 213 | // patch delta of 0 and need to be relocated before use for the purposes of |
| 214 | // ASLR. The odex file is treated as if it were read-only. |
Richard Uhler | 03bc659 | 2016-11-22 09:42:04 +0000 | [diff] [blame] | 215 | // |
| 216 | // Returns the status of the odex file for the dex location. |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 217 | OatStatus OdexFileStatus(); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 218 | |
| 219 | // When the dex files is compiled on the target device, the oat file is the |
| 220 | // result. The oat file will have been relocated to some |
| 221 | // (possibly-out-of-date) offset for ASLR. |
Richard Uhler | 03bc659 | 2016-11-22 09:42:04 +0000 | [diff] [blame] | 222 | // |
| 223 | // Returns the status of the oat file for the dex location. |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 224 | OatStatus OatFileStatus(); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 225 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 226 | // Constructs the odex file name for the given dex location. |
| 227 | // Returns true on success, in which case odex_filename is set to the odex |
| 228 | // file name. |
Richard Uhler | e8e48ae | 2016-04-19 12:41:04 -0700 | [diff] [blame] | 229 | // Returns false on error, in which case error_msg describes the error and |
| 230 | // odex_filename is not changed. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 231 | // Neither odex_filename nor error_msg may be null. |
Richard Uhler | b81881d | 2016-04-19 13:08:04 -0700 | [diff] [blame] | 232 | static bool DexLocationToOdexFilename(const std::string& location, |
| 233 | InstructionSet isa, |
| 234 | std::string* odex_filename, |
| 235 | std::string* error_msg); |
| 236 | |
| 237 | // Constructs the oat file name for the given dex location. |
| 238 | // Returns true on success, in which case oat_filename is set to the oat |
| 239 | // file name. |
| 240 | // Returns false on error, in which case error_msg describes the error and |
| 241 | // oat_filename is not changed. |
| 242 | // Neither oat_filename nor error_msg may be null. |
| 243 | static bool DexLocationToOatFilename(const std::string& location, |
| 244 | InstructionSet isa, |
| 245 | std::string* oat_filename, |
| 246 | std::string* error_msg); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 247 | |
| 248 | private: |
| 249 | struct ImageInfo { |
Vladimir Marko | 0ace563 | 2018-12-14 11:11:47 +0000 | [diff] [blame] | 250 | bool ValidateBootClassPathChecksums(const OatFile& oat_file) const; |
| 251 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 252 | std::string location; |
Vladimir Marko | 0ace563 | 2018-12-14 11:11:47 +0000 | [diff] [blame] | 253 | std::string boot_class_path_checksums; |
Richard Uhler | 95e0967 | 2017-02-22 11:37:41 +0000 | [diff] [blame] | 254 | |
| 255 | static std::unique_ptr<ImageInfo> GetRuntimeImageInfo(InstructionSet isa, |
| 256 | std::string* error_msg); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 257 | }; |
| 258 | |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 259 | class OatFileInfo { |
| 260 | public: |
| 261 | // Initially the info is for no file in particular. It will treat the |
| 262 | // file as out of date until Reset is called with a real filename to use |
| 263 | // the cache for. |
Richard Uhler | 88bc673 | 2016-11-14 14:38:03 +0000 | [diff] [blame] | 264 | // Pass true for is_oat_location if the information associated with this |
| 265 | // OatFileInfo is for the oat location, as opposed to the odex location. |
| 266 | OatFileInfo(OatFileAssistant* oat_file_assistant, bool is_oat_location); |
| 267 | |
| 268 | bool IsOatLocation(); |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 269 | |
| 270 | const std::string* Filename(); |
Richard Uhler | 03bc659 | 2016-11-22 09:42:04 +0000 | [diff] [blame] | 271 | |
| 272 | // Returns true if this oat file can be used for running code. The oat |
| 273 | // file can be used for running code as long as it is not out of date with |
| 274 | // respect to the dex code or boot image. An oat file that is out of date |
| 275 | // with respect to relocation is considered useable, because it's possible |
| 276 | // to interpret the dex code rather than run the unrelocated compiled |
| 277 | // code. |
| 278 | bool IsUseable(); |
| 279 | |
| 280 | // Returns the status of this oat file. |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 281 | OatStatus Status(); |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 282 | |
Richard Uhler | 70a8426 | 2016-11-08 16:51:51 +0000 | [diff] [blame] | 283 | // Return the DexOptNeeded value for this oat file with respect to the |
| 284 | // given target_compilation_filter. |
| 285 | // profile_changed should be true to indicate the profile has recently |
| 286 | // changed for this dex location. |
Shubham Ajmera | e4e812a | 2017-05-25 20:09:58 -0700 | [diff] [blame] | 287 | // downgrade should be true if the purpose of dexopt is to downgrade the |
| 288 | // compiler filter. |
Richard Uhler | 70a8426 | 2016-11-08 16:51:51 +0000 | [diff] [blame] | 289 | DexOptNeeded GetDexOptNeeded(CompilerFilter::Filter target_compiler_filter, |
Shubham Ajmera | e4e812a | 2017-05-25 20:09:58 -0700 | [diff] [blame] | 290 | bool profile_changed, |
Calin Juravle | 44e5efa | 2017-09-12 00:54:26 -0700 | [diff] [blame] | 291 | bool downgrade, |
David Brazdil | 8982186 | 2019-03-19 13:57:43 +0000 | [diff] [blame^] | 292 | ClassLoaderContext* context, |
| 293 | const std::vector<int>& context_fds); |
Richard Uhler | 70a8426 | 2016-11-08 16:51:51 +0000 | [diff] [blame] | 294 | |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 295 | // Returns the loaded file. |
| 296 | // Loads the file if needed. Returns null if the file failed to load. |
| 297 | // The caller shouldn't clean up or free the returned pointer. |
| 298 | const OatFile* GetFile(); |
| 299 | |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 300 | // Returns true if the file is opened executable. |
| 301 | bool IsExecutable(); |
| 302 | |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 303 | // Clear any cached information about the file that depends on the |
| 304 | // contents of the file. This does not reset the provided filename. |
| 305 | void Reset(); |
| 306 | |
| 307 | // Clear any cached information and switch to getting info about the oat |
| 308 | // file with the given filename. |
Nicolas Geoffray | 3002509 | 2018-04-19 14:43:29 +0100 | [diff] [blame] | 309 | void Reset(const std::string& filename, |
| 310 | bool use_fd, |
| 311 | int zip_fd = -1, |
| 312 | int vdex_fd = -1, |
| 313 | int oat_fd = -1); |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 314 | |
Richard Uhler | 70a8426 | 2016-11-08 16:51:51 +0000 | [diff] [blame] | 315 | // Release the loaded oat file for runtime use. |
| 316 | // Returns null if the oat file hasn't been loaded or is out of date. |
| 317 | // Ensures the returned file is not loaded executable if it has unuseable |
| 318 | // compiled code. |
| 319 | // |
| 320 | // After this call, no other methods of the OatFileInfo should be |
| 321 | // called, because access to the loaded oat file has been taken away from |
| 322 | // the OatFileInfo object. |
| 323 | std::unique_ptr<OatFile> ReleaseFileForUse(); |
| 324 | |
| 325 | private: |
| 326 | // Returns true if the compiler filter used to generate the file is at |
| 327 | // least as good as the given target filter. profile_changed should be |
| 328 | // true to indicate the profile has recently changed for this dex |
| 329 | // location. |
Shubham Ajmera | e4e812a | 2017-05-25 20:09:58 -0700 | [diff] [blame] | 330 | // downgrade should be true if the purpose of dexopt is to downgrade the |
| 331 | // compiler filter. |
| 332 | bool CompilerFilterIsOkay(CompilerFilter::Filter target, bool profile_changed, bool downgrade); |
Richard Uhler | 70a8426 | 2016-11-08 16:51:51 +0000 | [diff] [blame] | 333 | |
David Brazdil | 8982186 | 2019-03-19 13:57:43 +0000 | [diff] [blame^] | 334 | bool ClassLoaderContextIsOkay(ClassLoaderContext* context, const std::vector<int>& context_fds); |
Calin Juravle | 44e5efa | 2017-09-12 00:54:26 -0700 | [diff] [blame] | 335 | |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 336 | // Release the loaded oat file. |
| 337 | // Returns null if the oat file hasn't been loaded. |
| 338 | // |
| 339 | // After this call, no other methods of the OatFileInfo should be |
| 340 | // called, because access to the loaded oat file has been taken away from |
| 341 | // the OatFileInfo object. |
| 342 | std::unique_ptr<OatFile> ReleaseFile(); |
| 343 | |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 344 | OatFileAssistant* oat_file_assistant_; |
Richard Uhler | 88bc673 | 2016-11-14 14:38:03 +0000 | [diff] [blame] | 345 | const bool is_oat_location_; |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 346 | |
| 347 | bool filename_provided_ = false; |
| 348 | std::string filename_; |
| 349 | |
Nicolas Geoffray | 3002509 | 2018-04-19 14:43:29 +0100 | [diff] [blame] | 350 | int zip_fd_ = -1; |
Shubham Ajmera | b22dea0 | 2017-10-04 18:36:41 -0700 | [diff] [blame] | 351 | int oat_fd_ = -1; |
| 352 | int vdex_fd_ = -1; |
Shubham Ajmera | c12bf4c | 2017-10-24 16:59:42 -0700 | [diff] [blame] | 353 | bool use_fd_ = false; |
Shubham Ajmera | b22dea0 | 2017-10-04 18:36:41 -0700 | [diff] [blame] | 354 | |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 355 | bool load_attempted_ = false; |
| 356 | std::unique_ptr<OatFile> file_; |
| 357 | |
| 358 | bool status_attempted_ = false; |
Andreas Gampe | d9911ee | 2017-03-27 13:27:24 -0700 | [diff] [blame] | 359 | OatStatus status_ = OatStatus::kOatCannotOpen; |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 360 | |
| 361 | // For debugging only. |
| 362 | // If this flag is set, the file has been released to the user and the |
| 363 | // OatFileInfo object is in a bad state and should no longer be used. |
| 364 | bool file_released_ = false; |
| 365 | }; |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 366 | |
Richard Uhler | 88bc673 | 2016-11-14 14:38:03 +0000 | [diff] [blame] | 367 | // Return info for the best oat file. |
| 368 | OatFileInfo& GetBestInfo(); |
| 369 | |
Shubham Ajmera | c12bf4c | 2017-10-24 16:59:42 -0700 | [diff] [blame] | 370 | // Returns true when vdex/oat/odex files should be read from file descriptors. |
| 371 | // The method checks the value of zip_fd_, and if the value is valid, returns |
| 372 | // true. This is required to have a deterministic behavior around how different |
| 373 | // files are being read. |
| 374 | bool UseFdToReadFiles(); |
| 375 | |
Richard Uhler | 2f27abd | 2017-01-31 14:02:34 +0000 | [diff] [blame] | 376 | // Returns true if the dex checksums in the given vdex file are up to date |
| 377 | // with respect to the dex location. If the dex checksums are not up to |
| 378 | // date, error_msg is updated with a message describing the problem. |
| 379 | bool DexChecksumUpToDate(const VdexFile& file, std::string* error_msg); |
| 380 | |
| 381 | // Returns true if the dex checksums in the given oat file are up to date |
| 382 | // with respect to the dex location. If the dex checksums are not up to |
| 383 | // date, error_msg is updated with a message describing the problem. |
| 384 | bool DexChecksumUpToDate(const OatFile& file, std::string* error_msg); |
| 385 | |
Richard Uhler | 03bc659 | 2016-11-22 09:42:04 +0000 | [diff] [blame] | 386 | // Return the status for a given opened oat file with respect to the dex |
| 387 | // location. |
| 388 | OatStatus GivenOatFileStatus(const OatFile& file); |
| 389 | |
Richard Uhler | 69bcf2c | 2017-01-24 10:25:21 +0000 | [diff] [blame] | 390 | // Gets the dex checksums required for an up-to-date oat file. |
| 391 | // Returns cached_required_dex_checksums if the required checksums were |
| 392 | // located. Returns null if the required checksums were not found. The |
| 393 | // caller shouldn't clean up or free the returned pointer. This sets the |
| 394 | // has_original_dex_files_ field to true if the checksums were found for the |
| 395 | // dex_location_ dex file. |
| 396 | const std::vector<uint32_t>* GetRequiredDexChecksums(); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 397 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 398 | // Returns the loaded image info. |
Mathieu Chartier | 2cebb24 | 2015-04-21 16:50:40 -0700 | [diff] [blame] | 399 | // Loads the image info if needed. Returns null if the image info failed |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 400 | // to load. |
| 401 | // The caller shouldn't clean up or free the returned pointer. |
| 402 | const ImageInfo* GetImageInfo(); |
| 403 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 404 | // To implement Lock(), we lock a dummy file where the oat file would go |
| 405 | // (adding ".flock" to the target file name) and retain the lock for the |
| 406 | // remaining lifetime of the OatFileAssistant object. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 407 | ScopedFlock flock_; |
| 408 | |
Richard Uhler | 740eec9 | 2015-10-15 15:12:23 -0700 | [diff] [blame] | 409 | std::string dex_location_; |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 410 | |
Calin Juravle | 357c66d | 2017-05-04 01:57:17 +0000 | [diff] [blame] | 411 | // Whether or not the parent directory of the dex file is writable. |
| 412 | bool dex_parent_writable_ = false; |
| 413 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 414 | // In a properly constructed OatFileAssistant object, isa_ should be either |
| 415 | // the 32 or 64 bit variant for the current device. |
Vladimir Marko | 33bff25 | 2017-11-01 14:35:42 +0000 | [diff] [blame] | 416 | const InstructionSet isa_ = InstructionSet::kNone; |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 417 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 418 | // Whether we will attempt to load oat files executable. |
| 419 | bool load_executable_ = false; |
| 420 | |
Nicolas Geoffray | 2974260 | 2017-12-14 10:09:03 +0000 | [diff] [blame] | 421 | // Whether only oat files on /system are loaded executable. |
| 422 | const bool only_load_system_executable_ = false; |
Nicolas Geoffray | 66ff8a8 | 2018-02-28 13:27:55 +0000 | [diff] [blame] | 423 | // Whether the potential zip file only contains uncompressed dex. |
| 424 | // Will be set during GetRequiredDexChecksums. |
| 425 | bool zip_file_only_contains_uncompressed_dex_ = true; |
Nicolas Geoffray | 2974260 | 2017-12-14 10:09:03 +0000 | [diff] [blame] | 426 | |
Richard Uhler | 69bcf2c | 2017-01-24 10:25:21 +0000 | [diff] [blame] | 427 | // Cached value of the required dex checksums. |
| 428 | // This should be accessed only by the GetRequiredDexChecksums() method. |
| 429 | std::vector<uint32_t> cached_required_dex_checksums_; |
| 430 | bool required_dex_checksums_attempted_ = false; |
| 431 | bool required_dex_checksums_found_; |
Richard Uhler | 9b994ea | 2015-06-24 08:44:19 -0700 | [diff] [blame] | 432 | bool has_original_dex_files_; |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 433 | |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 434 | OatFileInfo odex_; |
| 435 | OatFileInfo oat_; |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 436 | |
Shubham Ajmera | c12bf4c | 2017-10-24 16:59:42 -0700 | [diff] [blame] | 437 | // File descriptor corresponding to apk, dex file, or zip. |
| 438 | int zip_fd_; |
| 439 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 440 | // Cached value of the image info. |
| 441 | // Use the GetImageInfo method rather than accessing these directly. |
| 442 | // TODO: The image info should probably be moved out of the oat file |
| 443 | // assistant to an image file manager. |
| 444 | bool image_info_load_attempted_ = false; |
Richard Uhler | 95e0967 | 2017-02-22 11:37:41 +0000 | [diff] [blame] | 445 | std::unique_ptr<ImageInfo> cached_image_info_; |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 446 | |
Calin Juravle | 357c66d | 2017-05-04 01:57:17 +0000 | [diff] [blame] | 447 | friend class OatFileAssistantTest; |
| 448 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 449 | DISALLOW_COPY_AND_ASSIGN(OatFileAssistant); |
| 450 | }; |
| 451 | |
Narayan Kamath | 8943c1d | 2016-05-02 13:14:48 +0100 | [diff] [blame] | 452 | std::ostream& operator << (std::ostream& stream, const OatFileAssistant::OatStatus status); |
| 453 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 454 | } // namespace art |
| 455 | |
| 456 | #endif // ART_RUNTIME_OAT_FILE_ASSISTANT_H_ |