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" |
| 26 | #include "base/scoped_flock.h" |
| 27 | #include "base/unix_file/fd_file.h" |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame] | 28 | #include "compiler_filter.h" |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 29 | #include "oat_file.h" |
| 30 | #include "os.h" |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 31 | |
| 32 | namespace art { |
| 33 | |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 34 | namespace gc { |
| 35 | namespace space { |
| 36 | class ImageSpace; |
| 37 | } // namespace space |
| 38 | } // namespace gc |
| 39 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 40 | // Class for assisting with oat file management. |
| 41 | // |
| 42 | // This class collects common utilities for determining the status of an oat |
| 43 | // file on the device, updating the oat file, and loading the oat file. |
| 44 | // |
| 45 | // The oat file assistant is intended to be used with dex locations not on the |
| 46 | // boot class path. See the IsInBootClassPath method for a way to check if the |
| 47 | // dex location is in the boot class path. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 48 | class OatFileAssistant { |
| 49 | public: |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 50 | enum DexOptNeeded { |
| 51 | // kNoDexOptNeeded - The code for this dex location is up to date and can |
| 52 | // be used as is. |
| 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 | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 56 | // kDex2OatNeeded - In order to make the code for this dex location up to |
| 57 | // date, dex2oat must be run on the dex file. |
| 58 | // Matches Java: dalvik.system.DexFile.DEX2OAT_NEEDED = 1 |
| 59 | kDex2OatNeeded = 1, |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 60 | |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 61 | // kPatchOatNeeded - In order to make the code for this dex location up to |
| 62 | // date, patchoat must be run on the odex file. |
| 63 | // Matches Java: dalvik.system.DexFile.PATCHOAT_NEEDED = 2 |
| 64 | kPatchOatNeeded = 2, |
| 65 | |
| 66 | // kSelfPatchOatNeeded - In order to make the code for this dex location |
| 67 | // up to date, patchoat must be run on the oat file. |
| 68 | // Matches Java: dalvik.system.DexFile.SELF_PATCHOAT_NEEDED = 3 |
| 69 | kSelfPatchOatNeeded = 3, |
| 70 | }; |
| 71 | |
| 72 | enum OatStatus { |
| 73 | // kOatOutOfDate - An oat file is said to be out of date if the file does |
Calin Juravle | b077e15 | 2016-02-18 18:47:37 +0000 | [diff] [blame] | 74 | // not exist, is out of date with respect to the dex file or boot image, |
| 75 | // or does not meet the target compilation type. |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 76 | kOatOutOfDate, |
| 77 | |
| 78 | // kOatNeedsRelocation - An oat file is said to need relocation if the |
| 79 | // code is up to date, but not yet properly relocated for address space |
| 80 | // layout randomization (ASLR). In this case, the oat file is neither |
| 81 | // "out of date" nor "up to date". |
| 82 | kOatNeedsRelocation, |
| 83 | |
| 84 | // kOatUpToDate - An oat file is said to be up to date if it is not out of |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 85 | // date and has been properly relocated for the purposes of ASLR. |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 86 | kOatUpToDate, |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 87 | }; |
| 88 | |
| 89 | // Constructs an OatFileAssistant object to assist the oat file |
| 90 | // corresponding to the given dex location with the target instruction set. |
| 91 | // |
Mathieu Chartier | 2cebb24 | 2015-04-21 16:50:40 -0700 | [diff] [blame] | 92 | // The dex_location must not be null and should remain available and |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 93 | // unchanged for the duration of the lifetime of the OatFileAssistant object. |
| 94 | // Typically the dex_location is the absolute path to the original, |
| 95 | // un-optimized dex file. |
| 96 | // |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 97 | // Note: Currently the dex_location must have an extension. |
| 98 | // TODO: Relax this restriction? |
| 99 | // |
| 100 | // The isa should be either the 32 bit or 64 bit variant for the current |
| 101 | // device. For example, on an arm device, use arm or arm64. An oat file can |
| 102 | // be loaded executable only if the ISA matches the current runtime. |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame] | 103 | // |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame] | 104 | // load_executable should be true if the caller intends to try and load |
| 105 | // executable code for this dex location. |
Calin Juravle | b077e15 | 2016-02-18 18:47:37 +0000 | [diff] [blame] | 106 | OatFileAssistant(const char* dex_location, |
Calin Juravle | b077e15 | 2016-02-18 18:47:37 +0000 | [diff] [blame] | 107 | const InstructionSet isa, |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 108 | bool load_executable); |
| 109 | |
| 110 | // Constructs an OatFileAssistant, providing an explicit target oat_location |
| 111 | // to use instead of the standard oat location. |
Calin Juravle | b077e15 | 2016-02-18 18:47:37 +0000 | [diff] [blame] | 112 | OatFileAssistant(const char* dex_location, |
| 113 | const char* oat_location, |
Calin Juravle | b077e15 | 2016-02-18 18:47:37 +0000 | [diff] [blame] | 114 | const InstructionSet isa, |
| 115 | bool load_executable); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 116 | |
| 117 | ~OatFileAssistant(); |
| 118 | |
| 119 | // Returns true if the dex location refers to an element of the boot class |
| 120 | // path. |
| 121 | bool IsInBootClassPath(); |
| 122 | |
| 123 | // Obtains a lock on the target oat file. |
| 124 | // Only one OatFileAssistant object can hold the lock for a target oat file |
| 125 | // at a time. The Lock is released automatically when the OatFileAssistant |
| 126 | // object goes out of scope. The Lock() method must not be called if the |
| 127 | // lock has already been acquired. |
| 128 | // |
| 129 | // Returns true on success. |
| 130 | // Returns false on error, in which case error_msg will contain more |
| 131 | // information on the error. |
| 132 | // |
| 133 | // The 'error_msg' argument must not be null. |
| 134 | // |
| 135 | // This is intended to be used to avoid race conditions when multiple |
| 136 | // processes generate oat files, such as when a foreground Activity and |
| 137 | // a background Service both use DexClassLoaders pointing to the same dex |
| 138 | // file. |
| 139 | bool Lock(std::string* error_msg); |
| 140 | |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 141 | // Return what action needs to be taken to produce up-to-date code for this |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame] | 142 | // dex location that is at least as good as an oat file generated with the |
Richard Uhler | d1472a2 | 2016-04-15 15:18:56 -0700 | [diff] [blame] | 143 | // given compiler filter. profile_changed should be true to indicate the |
| 144 | // profile has recently changed for this dex location. |
| 145 | DexOptNeeded GetDexOptNeeded(CompilerFilter::Filter target_compiler_filter, |
| 146 | bool profile_changed = false); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 147 | |
Richard Uhler | 01be681 | 2016-05-17 10:34:52 -0700 | [diff] [blame] | 148 | // Returns true if there is up-to-date code for this dex location, |
| 149 | // irrespective of the compiler filter of the up-to-date code. |
| 150 | bool IsUpToDate(); |
| 151 | |
Richard Uhler | 1e86061 | 2016-03-30 12:17:55 -0700 | [diff] [blame] | 152 | // Return code used when attempting to generate updated code. |
| 153 | enum ResultOfAttemptToUpdate { |
| 154 | kUpdateFailed, // We tried making the code up to date, but |
| 155 | // encountered an unexpected failure. |
| 156 | kUpdateNotAttempted, // We wanted to update the code, but determined we |
| 157 | // should not make the attempt. |
| 158 | kUpdateSucceeded // We successfully made the code up to date |
| 159 | // (possibly by doing nothing). |
| 160 | }; |
| 161 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 162 | // Attempts to generate or relocate the oat file as needed to make it up to |
Richard Uhler | f4b3487 | 2016-04-13 11:03:46 -0700 | [diff] [blame] | 163 | // date based on the current runtime and compiler options. |
Richard Uhler | d1472a2 | 2016-04-15 15:18:56 -0700 | [diff] [blame] | 164 | // profile_changed should be true to indicate the profile has recently |
| 165 | // changed for this dex location. |
| 166 | // |
| 167 | // Returns the result of attempting to update the code. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 168 | // |
Richard Uhler | 1e86061 | 2016-03-30 12:17:55 -0700 | [diff] [blame] | 169 | // If the result is not kUpdateSucceeded, the value of error_msg will be set |
| 170 | // to a string describing why there was a failure or the update was not |
| 171 | // attempted. error_msg must not be null. |
Richard Uhler | d1472a2 | 2016-04-15 15:18:56 -0700 | [diff] [blame] | 172 | ResultOfAttemptToUpdate MakeUpToDate(bool profile_changed, std::string* error_msg); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 173 | |
| 174 | // Returns an oat file that can be used for loading dex files. |
Mathieu Chartier | 2cebb24 | 2015-04-21 16:50:40 -0700 | [diff] [blame] | 175 | // Returns null if no suitable oat file was found. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 176 | // |
| 177 | // After this call, no other methods of the OatFileAssistant should be |
| 178 | // called, because access to the loaded oat file has been taken away from |
| 179 | // the OatFileAssistant object. |
| 180 | std::unique_ptr<OatFile> GetBestOatFile(); |
| 181 | |
Richard Uhler | 46cc64f | 2016-11-14 14:53:55 +0000 | [diff] [blame] | 182 | // Returns a human readable description of the status of the code for the |
| 183 | // dex file. The returned description is for debugging purposes only. |
| 184 | std::string GetStatusDump(); |
| 185 | |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 186 | // Open and returns an image space associated with the oat file. |
Andreas Gampe | a463b6a | 2016-08-12 21:53:32 -0700 | [diff] [blame] | 187 | static std::unique_ptr<gc::space::ImageSpace> OpenImageSpace(const OatFile* oat_file); |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 188 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 189 | // Loads the dex files in the given oat file for the given dex location. |
| 190 | // The oat file should be up to date for the given dex location. |
| 191 | // This loads multiple dex files in the case of multidex. |
| 192 | // Returns an empty vector if no dex files for that location could be loaded |
| 193 | // from the oat file. |
| 194 | // |
| 195 | // The caller is responsible for freeing the dex_files returned, if any. The |
| 196 | // dex_files will only remain valid as long as the oat_file is valid. |
| 197 | static std::vector<std::unique_ptr<const DexFile>> LoadDexFiles( |
| 198 | const OatFile& oat_file, const char* dex_location); |
| 199 | |
Richard Uhler | 9b994ea | 2015-06-24 08:44:19 -0700 | [diff] [blame] | 200 | // Returns true if there are dex files in the original dex location that can |
| 201 | // be compiled with dex2oat for this dex location. |
| 202 | // Returns false if there is no original dex file, or if the original dex |
| 203 | // file is an apk/zip without a classes.dex entry. |
| 204 | bool HasOriginalDexFiles(); |
| 205 | |
Richard Uhler | 6343411 | 2015-03-16 14:32:16 -0700 | [diff] [blame] | 206 | // If the dex file has been installed with a compiled oat file alongside |
| 207 | // it, the compiled oat file will have the extension .odex, and is referred |
| 208 | // to as the odex file. It is called odex for legacy reasons; the file is |
| 209 | // really an oat file. The odex file will often, but not always, have a |
| 210 | // patch delta of 0 and need to be relocated before use for the purposes of |
| 211 | // ASLR. The odex file is treated as if it were read-only. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 212 | // These methods return the location and status of the odex file for the dex |
| 213 | // location. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 214 | bool OdexFileExists(); |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 215 | OatStatus OdexFileStatus(); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 216 | |
| 217 | // When the dex files is compiled on the target device, the oat file is the |
| 218 | // result. The oat file will have been relocated to some |
| 219 | // (possibly-out-of-date) offset for ASLR. |
| 220 | // These methods return the location and status of the target oat file for |
| 221 | // the dex location. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 222 | bool OatFileExists(); |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 223 | OatStatus OatFileStatus(); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 224 | |
Richard Uhler | e8109f7 | 2016-04-18 10:40:50 -0700 | [diff] [blame] | 225 | // Return the status for a given opened oat file with respect to the dex |
| 226 | // location. |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 227 | OatStatus GivenOatFileStatus(const OatFile& file); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 228 | |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 229 | // Generates the oat file by relocation from the named input file. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 230 | // This does not check the current status before attempting to relocate the |
| 231 | // oat file. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 232 | // |
Richard Uhler | 1e86061 | 2016-03-30 12:17:55 -0700 | [diff] [blame] | 233 | // If the result is not kUpdateSucceeded, the value of error_msg will be set |
| 234 | // to a string describing why there was a failure or the update was not |
| 235 | // attempted. error_msg must not be null. |
| 236 | ResultOfAttemptToUpdate RelocateOatFile(const std::string* input_file, std::string* error_msg); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 237 | |
Richard Uhler | f4b3487 | 2016-04-13 11:03:46 -0700 | [diff] [blame] | 238 | // Generate the oat file from the dex file using the current runtime |
| 239 | // compiler options. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 240 | // This does not check the current status before attempting to generate the |
| 241 | // oat file. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 242 | // |
Richard Uhler | 1e86061 | 2016-03-30 12:17:55 -0700 | [diff] [blame] | 243 | // If the result is not kUpdateSucceeded, the value of error_msg will be set |
| 244 | // to a string describing why there was a failure or the update was not |
| 245 | // attempted. error_msg must not be null. |
Richard Uhler | f4b3487 | 2016-04-13 11:03:46 -0700 | [diff] [blame] | 246 | ResultOfAttemptToUpdate GenerateOatFile(std::string* error_msg); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 247 | |
| 248 | // Executes dex2oat using the current runtime configuration overridden with |
| 249 | // the given arguments. This does not check to see if dex2oat is enabled in |
| 250 | // the runtime configuration. |
| 251 | // Returns true on success. |
| 252 | // |
| 253 | // If there is a failure, the value of error_msg will be set to a string |
Mathieu Chartier | 2cebb24 | 2015-04-21 16:50:40 -0700 | [diff] [blame] | 254 | // describing why there was failure. error_msg must not be null. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 255 | // |
| 256 | // TODO: The OatFileAssistant probably isn't the right place to have this |
| 257 | // function. |
| 258 | static bool Dex2Oat(const std::vector<std::string>& args, std::string* error_msg); |
| 259 | |
| 260 | // Constructs the odex file name for the given dex location. |
| 261 | // Returns true on success, in which case odex_filename is set to the odex |
| 262 | // file name. |
Richard Uhler | e8e48ae | 2016-04-19 12:41:04 -0700 | [diff] [blame] | 263 | // Returns false on error, in which case error_msg describes the error and |
| 264 | // odex_filename is not changed. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 265 | // Neither odex_filename nor error_msg may be null. |
Richard Uhler | b81881d | 2016-04-19 13:08:04 -0700 | [diff] [blame] | 266 | static bool DexLocationToOdexFilename(const std::string& location, |
| 267 | InstructionSet isa, |
| 268 | std::string* odex_filename, |
| 269 | std::string* error_msg); |
| 270 | |
| 271 | // Constructs the oat file name for the given dex location. |
| 272 | // Returns true on success, in which case oat_filename is set to the oat |
| 273 | // file name. |
| 274 | // Returns false on error, in which case error_msg describes the error and |
| 275 | // oat_filename is not changed. |
| 276 | // Neither oat_filename nor error_msg may be null. |
| 277 | static bool DexLocationToOatFilename(const std::string& location, |
| 278 | InstructionSet isa, |
| 279 | std::string* oat_filename, |
| 280 | std::string* error_msg); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 281 | |
Jeff Hao | fd336c3 | 2016-04-07 19:46:31 -0700 | [diff] [blame] | 282 | static uint32_t CalculateCombinedImageChecksum(InstructionSet isa = kRuntimeISA); |
Jeff Hao | b11ffb7 | 2016-04-07 15:40:54 -0700 | [diff] [blame] | 283 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 284 | private: |
| 285 | struct ImageInfo { |
| 286 | uint32_t oat_checksum = 0; |
| 287 | uintptr_t oat_data_begin = 0; |
| 288 | int32_t patch_delta = 0; |
| 289 | std::string location; |
| 290 | }; |
| 291 | |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 292 | class OatFileInfo { |
| 293 | public: |
| 294 | // Initially the info is for no file in particular. It will treat the |
| 295 | // file as out of date until Reset is called with a real filename to use |
| 296 | // the cache for. |
Richard Uhler | 88bc673 | 2016-11-14 14:38:03 +0000 | [diff] [blame^] | 297 | // Pass true for is_oat_location if the information associated with this |
| 298 | // OatFileInfo is for the oat location, as opposed to the odex location. |
| 299 | OatFileInfo(OatFileAssistant* oat_file_assistant, bool is_oat_location); |
| 300 | |
| 301 | bool IsOatLocation(); |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 302 | |
| 303 | const std::string* Filename(); |
| 304 | bool Exists(); |
| 305 | OatStatus Status(); |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 306 | // Must only be called if the associated file exists, i.e, if |
| 307 | // |Exists() == true|. |
| 308 | CompilerFilter::Filter CompilerFilter(); |
| 309 | |
Richard Uhler | 70a8426 | 2016-11-08 16:51:51 +0000 | [diff] [blame] | 310 | // Return the DexOptNeeded value for this oat file with respect to the |
| 311 | // given target_compilation_filter. |
| 312 | // profile_changed should be true to indicate the profile has recently |
| 313 | // changed for this dex location. |
| 314 | // If patchoat is needed, this function will return the kPatchOatNeeded |
| 315 | // status, not the kSelfPatchOatNeeded status. |
| 316 | DexOptNeeded GetDexOptNeeded(CompilerFilter::Filter target_compiler_filter, |
| 317 | bool profile_changed); |
| 318 | |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 319 | // Returns the loaded file. |
| 320 | // Loads the file if needed. Returns null if the file failed to load. |
| 321 | // The caller shouldn't clean up or free the returned pointer. |
| 322 | const OatFile* GetFile(); |
| 323 | |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 324 | // Returns true if the file is opened executable. |
| 325 | bool IsExecutable(); |
| 326 | |
| 327 | // Returns true if the file has patch info required to run patchoat. |
| 328 | bool HasPatchInfo(); |
| 329 | |
| 330 | // Clear any cached information about the file that depends on the |
| 331 | // contents of the file. This does not reset the provided filename. |
| 332 | void Reset(); |
| 333 | |
| 334 | // Clear any cached information and switch to getting info about the oat |
| 335 | // file with the given filename. |
| 336 | void Reset(const std::string& filename); |
| 337 | |
Richard Uhler | 70a8426 | 2016-11-08 16:51:51 +0000 | [diff] [blame] | 338 | // Release the loaded oat file for runtime use. |
| 339 | // Returns null if the oat file hasn't been loaded or is out of date. |
| 340 | // Ensures the returned file is not loaded executable if it has unuseable |
| 341 | // compiled code. |
| 342 | // |
| 343 | // After this call, no other methods of the OatFileInfo should be |
| 344 | // called, because access to the loaded oat file has been taken away from |
| 345 | // the OatFileInfo object. |
| 346 | std::unique_ptr<OatFile> ReleaseFileForUse(); |
| 347 | |
| 348 | private: |
| 349 | // Returns true if the compiler filter used to generate the file is at |
| 350 | // least as good as the given target filter. profile_changed should be |
| 351 | // true to indicate the profile has recently changed for this dex |
| 352 | // location. |
| 353 | bool CompilerFilterIsOkay(CompilerFilter::Filter target, bool profile_changed); |
| 354 | |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 355 | // Release the loaded oat file. |
| 356 | // Returns null if the oat file hasn't been loaded. |
| 357 | // |
| 358 | // After this call, no other methods of the OatFileInfo should be |
| 359 | // called, because access to the loaded oat file has been taken away from |
| 360 | // the OatFileInfo object. |
| 361 | std::unique_ptr<OatFile> ReleaseFile(); |
| 362 | |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 363 | OatFileAssistant* oat_file_assistant_; |
Richard Uhler | 88bc673 | 2016-11-14 14:38:03 +0000 | [diff] [blame^] | 364 | const bool is_oat_location_; |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 365 | |
| 366 | bool filename_provided_ = false; |
| 367 | std::string filename_; |
| 368 | |
| 369 | bool load_attempted_ = false; |
| 370 | std::unique_ptr<OatFile> file_; |
| 371 | |
| 372 | bool status_attempted_ = false; |
| 373 | OatStatus status_; |
| 374 | |
| 375 | // For debugging only. |
| 376 | // If this flag is set, the file has been released to the user and the |
| 377 | // OatFileInfo object is in a bad state and should no longer be used. |
| 378 | bool file_released_ = false; |
| 379 | }; |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 380 | |
Richard Uhler | 88bc673 | 2016-11-14 14:38:03 +0000 | [diff] [blame^] | 381 | // Return info for the best oat file. |
| 382 | OatFileInfo& GetBestInfo(); |
| 383 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 384 | // Returns the current image location. |
| 385 | // Returns an empty string if the image location could not be retrieved. |
| 386 | // |
| 387 | // TODO: This method should belong with an image file manager, not |
| 388 | // the oat file assistant. |
| 389 | static std::string ImageLocation(); |
| 390 | |
| 391 | // Gets the dex checksum required for an up-to-date oat file. |
| 392 | // Returns dex_checksum if a required checksum was located. Returns |
Mathieu Chartier | 2cebb24 | 2015-04-21 16:50:40 -0700 | [diff] [blame] | 393 | // null if the required checksum was not found. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 394 | // The caller shouldn't clean up or free the returned pointer. |
Richard Uhler | 9b994ea | 2015-06-24 08:44:19 -0700 | [diff] [blame] | 395 | // This sets the has_original_dex_files_ field to true if a checksum was |
| 396 | // found for the dex_location_ dex file. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 397 | const uint32_t* GetRequiredDexChecksum(); |
| 398 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 399 | // Returns the loaded image info. |
Mathieu Chartier | 2cebb24 | 2015-04-21 16:50:40 -0700 | [diff] [blame] | 400 | // 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] | 401 | // to load. |
| 402 | // The caller shouldn't clean up or free the returned pointer. |
| 403 | const ImageInfo* GetImageInfo(); |
| 404 | |
Jeff Hao | b11ffb7 | 2016-04-07 15:40:54 -0700 | [diff] [blame] | 405 | uint32_t GetCombinedImageChecksum(); |
| 406 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 407 | // To implement Lock(), we lock a dummy file where the oat file would go |
| 408 | // (adding ".flock" to the target file name) and retain the lock for the |
| 409 | // remaining lifetime of the OatFileAssistant object. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 410 | ScopedFlock flock_; |
| 411 | |
Richard Uhler | 740eec9 | 2015-10-15 15:12:23 -0700 | [diff] [blame] | 412 | std::string dex_location_; |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 413 | |
| 414 | // In a properly constructed OatFileAssistant object, isa_ should be either |
| 415 | // the 32 or 64 bit variant for the current device. |
| 416 | const InstructionSet isa_ = kNone; |
| 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 | |
| 421 | // Cached value of the required dex checksum. |
| 422 | // This should be accessed only by the GetRequiredDexChecksum() method. |
Richard Uhler | 9b994ea | 2015-06-24 08:44:19 -0700 | [diff] [blame] | 423 | uint32_t cached_required_dex_checksum_; |
| 424 | bool required_dex_checksum_attempted_ = false; |
| 425 | bool required_dex_checksum_found_; |
| 426 | bool has_original_dex_files_; |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 427 | |
Richard Uhler | 743bf36 | 2016-04-19 15:39:37 -0700 | [diff] [blame] | 428 | OatFileInfo odex_; |
| 429 | OatFileInfo oat_; |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 430 | |
| 431 | // Cached value of the image info. |
| 432 | // Use the GetImageInfo method rather than accessing these directly. |
| 433 | // TODO: The image info should probably be moved out of the oat file |
| 434 | // assistant to an image file manager. |
| 435 | bool image_info_load_attempted_ = false; |
| 436 | bool image_info_load_succeeded_ = false; |
| 437 | ImageInfo cached_image_info_; |
Jeff Hao | b11ffb7 | 2016-04-07 15:40:54 -0700 | [diff] [blame] | 438 | uint32_t combined_image_checksum_ = 0; |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 439 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 440 | DISALLOW_COPY_AND_ASSIGN(OatFileAssistant); |
| 441 | }; |
| 442 | |
Narayan Kamath | 8943c1d | 2016-05-02 13:14:48 +0100 | [diff] [blame] | 443 | std::ostream& operator << (std::ostream& stream, const OatFileAssistant::OatStatus status); |
| 444 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 445 | } // namespace art |
| 446 | |
| 447 | #endif // ART_RUNTIME_OAT_FILE_ASSISTANT_H_ |