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> |
| 22 | #include <string> |
| 23 | |
| 24 | #include "arch/instruction_set.h" |
| 25 | #include "base/scoped_flock.h" |
| 26 | #include "base/unix_file/fd_file.h" |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame^] | 27 | #include "compiler_filter.h" |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 28 | #include "oat_file.h" |
| 29 | #include "os.h" |
| 30 | #include "profiler.h" |
| 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 | // |
| 104 | // profile_changed should be true if the profile has recently changed |
| 105 | // for this dex location. |
| 106 | // |
| 107 | // load_executable should be true if the caller intends to try and load |
| 108 | // executable code for this dex location. |
Calin Juravle | b077e15 | 2016-02-18 18:47:37 +0000 | [diff] [blame] | 109 | OatFileAssistant(const char* dex_location, |
Calin Juravle | b077e15 | 2016-02-18 18:47:37 +0000 | [diff] [blame] | 110 | const InstructionSet isa, |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame^] | 111 | bool profile_changed, |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 112 | bool load_executable); |
| 113 | |
| 114 | // Constructs an OatFileAssistant, providing an explicit target oat_location |
| 115 | // to use instead of the standard oat location. |
Calin Juravle | b077e15 | 2016-02-18 18:47:37 +0000 | [diff] [blame] | 116 | OatFileAssistant(const char* dex_location, |
| 117 | const char* oat_location, |
Calin Juravle | b077e15 | 2016-02-18 18:47:37 +0000 | [diff] [blame] | 118 | const InstructionSet isa, |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame^] | 119 | bool profile_changed, |
Calin Juravle | b077e15 | 2016-02-18 18:47:37 +0000 | [diff] [blame] | 120 | bool load_executable); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 121 | |
| 122 | ~OatFileAssistant(); |
| 123 | |
| 124 | // Returns true if the dex location refers to an element of the boot class |
| 125 | // path. |
| 126 | bool IsInBootClassPath(); |
| 127 | |
| 128 | // Obtains a lock on the target oat file. |
| 129 | // Only one OatFileAssistant object can hold the lock for a target oat file |
| 130 | // at a time. The Lock is released automatically when the OatFileAssistant |
| 131 | // object goes out of scope. The Lock() method must not be called if the |
| 132 | // lock has already been acquired. |
| 133 | // |
| 134 | // Returns true on success. |
| 135 | // Returns false on error, in which case error_msg will contain more |
| 136 | // information on the error. |
| 137 | // |
| 138 | // The 'error_msg' argument must not be null. |
| 139 | // |
| 140 | // This is intended to be used to avoid race conditions when multiple |
| 141 | // processes generate oat files, such as when a foreground Activity and |
| 142 | // a background Service both use DexClassLoaders pointing to the same dex |
| 143 | // file. |
| 144 | bool Lock(std::string* error_msg); |
| 145 | |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 146 | // 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^] | 147 | // dex location that is at least as good as an oat file generated with the |
| 148 | // given compiler filter. |
| 149 | DexOptNeeded GetDexOptNeeded(CompilerFilter::Filter target_compiler_filter); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 150 | |
| 151 | // Attempts to generate or relocate the oat file as needed to make it up to |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame^] | 152 | // date with in a way that is at least as good as an oat file generated with |
| 153 | // the given compiler filter. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 154 | // Returns true on success. |
| 155 | // |
| 156 | // 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] | 157 | // describing why there was failure. error_msg must not be null. |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame^] | 158 | bool MakeUpToDate(CompilerFilter::Filter target_compiler_filter, std::string* error_msg); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 159 | |
| 160 | // Returns an oat file that can be used for loading dex files. |
Mathieu Chartier | 2cebb24 | 2015-04-21 16:50:40 -0700 | [diff] [blame] | 161 | // Returns null if no suitable oat file was found. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 162 | // |
| 163 | // After this call, no other methods of the OatFileAssistant should be |
| 164 | // called, because access to the loaded oat file has been taken away from |
| 165 | // the OatFileAssistant object. |
| 166 | std::unique_ptr<OatFile> GetBestOatFile(); |
| 167 | |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 168 | // Open and returns an image space associated with the oat file. |
| 169 | gc::space::ImageSpace* OpenImageSpace(const OatFile* oat_file); |
| 170 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 171 | // Loads the dex files in the given oat file for the given dex location. |
| 172 | // The oat file should be up to date for the given dex location. |
| 173 | // This loads multiple dex files in the case of multidex. |
| 174 | // Returns an empty vector if no dex files for that location could be loaded |
| 175 | // from the oat file. |
| 176 | // |
| 177 | // The caller is responsible for freeing the dex_files returned, if any. The |
| 178 | // dex_files will only remain valid as long as the oat_file is valid. |
| 179 | static std::vector<std::unique_ptr<const DexFile>> LoadDexFiles( |
| 180 | const OatFile& oat_file, const char* dex_location); |
| 181 | |
Richard Uhler | 9b994ea | 2015-06-24 08:44:19 -0700 | [diff] [blame] | 182 | // Returns true if there are dex files in the original dex location that can |
| 183 | // be compiled with dex2oat for this dex location. |
| 184 | // Returns false if there is no original dex file, or if the original dex |
| 185 | // file is an apk/zip without a classes.dex entry. |
| 186 | bool HasOriginalDexFiles(); |
| 187 | |
Richard Uhler | 6343411 | 2015-03-16 14:32:16 -0700 | [diff] [blame] | 188 | // If the dex file has been installed with a compiled oat file alongside |
| 189 | // it, the compiled oat file will have the extension .odex, and is referred |
| 190 | // to as the odex file. It is called odex for legacy reasons; the file is |
| 191 | // really an oat file. The odex file will often, but not always, have a |
| 192 | // patch delta of 0 and need to be relocated before use for the purposes of |
| 193 | // ASLR. The odex file is treated as if it were read-only. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 194 | // These methods return the location and status of the odex file for the dex |
| 195 | // location. |
| 196 | // Notes: |
| 197 | // * OdexFileName may return null if the odex file name could not be |
| 198 | // determined. |
| 199 | const std::string* OdexFileName(); |
| 200 | bool OdexFileExists(); |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 201 | OatStatus OdexFileStatus(); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 202 | bool OdexFileIsOutOfDate(); |
| 203 | bool OdexFileNeedsRelocation(); |
| 204 | bool OdexFileIsUpToDate(); |
| 205 | |
| 206 | // When the dex files is compiled on the target device, the oat file is the |
| 207 | // result. The oat file will have been relocated to some |
| 208 | // (possibly-out-of-date) offset for ASLR. |
| 209 | // These methods return the location and status of the target oat file for |
| 210 | // the dex location. |
| 211 | // |
| 212 | // Notes: |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 213 | // * OatFileName may return null if the oat file name could not be |
| 214 | // determined. |
| 215 | const std::string* OatFileName(); |
| 216 | bool OatFileExists(); |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 217 | OatStatus OatFileStatus(); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 218 | bool OatFileIsOutOfDate(); |
| 219 | bool OatFileNeedsRelocation(); |
| 220 | bool OatFileIsUpToDate(); |
| 221 | |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 222 | // Return image file name. Does not cache since it relies on the oat file. |
| 223 | std::string ArtFileName(const OatFile* oat_file) const; |
| 224 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 225 | // These methods return the status for a given opened oat file with respect |
| 226 | // to the dex 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 | bool GivenOatFileIsOutOfDate(const OatFile& file); |
| 229 | bool GivenOatFileNeedsRelocation(const OatFile& file); |
| 230 | bool GivenOatFileIsUpToDate(const OatFile& file); |
| 231 | |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 232 | // Generates the oat file by relocation from the named input file. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 233 | // This does not check the current status before attempting to relocate the |
| 234 | // oat file. |
| 235 | // Returns true on success. |
| 236 | // This will fail if dex2oat is not enabled in the current runtime. |
| 237 | // |
| 238 | // 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] | 239 | // describing why there was failure. error_msg must not be null. |
Richard Uhler | 95abd04 | 2015-03-24 09:51:28 -0700 | [diff] [blame] | 240 | bool RelocateOatFile(const std::string* input_file, std::string* error_msg); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 241 | |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame^] | 242 | // Generate the oat file from the dex file using the given compiler filter. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 243 | // This does not check the current status before attempting to generate the |
| 244 | // oat file. |
| 245 | // Returns true on success. |
| 246 | // This will fail if dex2oat is not enabled in the current runtime. |
| 247 | // |
| 248 | // 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] | 249 | // describing why there was failure. error_msg must not be null. |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame^] | 250 | bool GenerateOatFile(CompilerFilter::Filter filter, std::string* error_msg); |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 251 | |
| 252 | // Executes dex2oat using the current runtime configuration overridden with |
| 253 | // the given arguments. This does not check to see if dex2oat is enabled in |
| 254 | // the runtime configuration. |
| 255 | // Returns true on success. |
| 256 | // |
| 257 | // 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] | 258 | // describing why there was failure. error_msg must not be null. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 259 | // |
| 260 | // TODO: The OatFileAssistant probably isn't the right place to have this |
| 261 | // function. |
| 262 | static bool Dex2Oat(const std::vector<std::string>& args, std::string* error_msg); |
| 263 | |
| 264 | // Constructs the odex file name for the given dex location. |
| 265 | // Returns true on success, in which case odex_filename is set to the odex |
| 266 | // file name. |
| 267 | // Returns false on error, in which case error_msg describes the error. |
| 268 | // Neither odex_filename nor error_msg may be null. |
| 269 | static bool DexFilenameToOdexFilename(const std::string& location, |
| 270 | InstructionSet isa, std::string* odex_filename, std::string* error_msg); |
| 271 | |
| 272 | private: |
| 273 | struct ImageInfo { |
| 274 | uint32_t oat_checksum = 0; |
| 275 | uintptr_t oat_data_begin = 0; |
| 276 | int32_t patch_delta = 0; |
| 277 | std::string location; |
| 278 | }; |
| 279 | |
| 280 | // Returns the path to the dalvik cache directory. |
| 281 | // Does not check existence of the cache or try to create it. |
| 282 | // Includes the trailing slash. |
| 283 | // Returns an empty string if we can't get the dalvik cache directory path. |
| 284 | std::string DalvikCacheDirectory(); |
| 285 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 286 | // Returns the current image location. |
| 287 | // Returns an empty string if the image location could not be retrieved. |
| 288 | // |
| 289 | // TODO: This method should belong with an image file manager, not |
| 290 | // the oat file assistant. |
| 291 | static std::string ImageLocation(); |
| 292 | |
| 293 | // Gets the dex checksum required for an up-to-date oat file. |
| 294 | // Returns dex_checksum if a required checksum was located. Returns |
Mathieu Chartier | 2cebb24 | 2015-04-21 16:50:40 -0700 | [diff] [blame] | 295 | // null if the required checksum was not found. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 296 | // The caller shouldn't clean up or free the returned pointer. |
Richard Uhler | 9b994ea | 2015-06-24 08:44:19 -0700 | [diff] [blame] | 297 | // This sets the has_original_dex_files_ field to true if a checksum was |
| 298 | // found for the dex_location_ dex file. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 299 | const uint32_t* GetRequiredDexChecksum(); |
| 300 | |
| 301 | // Returns the loaded odex file. |
Mathieu Chartier | 2cebb24 | 2015-04-21 16:50:40 -0700 | [diff] [blame] | 302 | // Loads the file if needed. Returns null if the file failed to load. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 303 | // The caller shouldn't clean up or free the returned pointer. |
| 304 | const OatFile* GetOdexFile(); |
| 305 | |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame^] | 306 | // Returns true if the compiler filter used to generate the odex file is at |
| 307 | // least as good as the given target filter. |
| 308 | bool OdexFileCompilerFilterIsOkay(CompilerFilter::Filter target); |
| 309 | |
Richard Uhler | 5f946da | 2015-07-17 12:28:32 -0700 | [diff] [blame] | 310 | // Returns true if the odex file is opened executable. |
| 311 | bool OdexFileIsExecutable(); |
| 312 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 313 | // Clear any cached information about the odex file that depends on the |
| 314 | // contents of the file. |
| 315 | void ClearOdexFileCache(); |
| 316 | |
| 317 | // Returns the loaded oat file. |
Mathieu Chartier | 2cebb24 | 2015-04-21 16:50:40 -0700 | [diff] [blame] | 318 | // Loads the file if needed. Returns null if the file failed to load. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 319 | // The caller shouldn't clean up or free the returned pointer. |
| 320 | const OatFile* GetOatFile(); |
| 321 | |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame^] | 322 | // Returns true if the compiler filter used to generate the oat file is at |
| 323 | // least as good as the given target filter. |
| 324 | bool OatFileCompilerFilterIsOkay(CompilerFilter::Filter target); |
| 325 | |
Richard Uhler | 5f946da | 2015-07-17 12:28:32 -0700 | [diff] [blame] | 326 | // Returns true if the oat file is opened executable. |
| 327 | bool OatFileIsExecutable(); |
| 328 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 329 | // Clear any cached information about the oat file that depends on the |
| 330 | // contents of the file. |
| 331 | void ClearOatFileCache(); |
| 332 | |
| 333 | // Returns the loaded image info. |
Mathieu Chartier | 2cebb24 | 2015-04-21 16:50:40 -0700 | [diff] [blame] | 334 | // 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] | 335 | // to load. |
| 336 | // The caller shouldn't clean up or free the returned pointer. |
| 337 | const ImageInfo* GetImageInfo(); |
| 338 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 339 | // To implement Lock(), we lock a dummy file where the oat file would go |
| 340 | // (adding ".flock" to the target file name) and retain the lock for the |
| 341 | // remaining lifetime of the OatFileAssistant object. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 342 | ScopedFlock flock_; |
| 343 | |
Richard Uhler | 740eec9 | 2015-10-15 15:12:23 -0700 | [diff] [blame] | 344 | std::string dex_location_; |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 345 | |
| 346 | // In a properly constructed OatFileAssistant object, isa_ should be either |
| 347 | // the 32 or 64 bit variant for the current device. |
| 348 | const InstructionSet isa_ = kNone; |
| 349 | |
Andreas Gampe | 29d38e7 | 2016-03-23 15:31:51 +0000 | [diff] [blame^] | 350 | // Whether the profile has recently changed. |
| 351 | bool profile_changed_ = false; |
| 352 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 353 | // Whether we will attempt to load oat files executable. |
| 354 | bool load_executable_ = false; |
| 355 | |
| 356 | // Cached value of the required dex checksum. |
| 357 | // This should be accessed only by the GetRequiredDexChecksum() method. |
Richard Uhler | 9b994ea | 2015-06-24 08:44:19 -0700 | [diff] [blame] | 358 | uint32_t cached_required_dex_checksum_; |
| 359 | bool required_dex_checksum_attempted_ = false; |
| 360 | bool required_dex_checksum_found_; |
| 361 | bool has_original_dex_files_; |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 362 | |
| 363 | // Cached value of the odex file name. |
| 364 | // This should be accessed only by the OdexFileName() method. |
| 365 | bool cached_odex_file_name_attempted_ = false; |
| 366 | bool cached_odex_file_name_found_; |
| 367 | std::string cached_odex_file_name_; |
| 368 | |
| 369 | // Cached value of the loaded odex file. |
| 370 | // Use the GetOdexFile method rather than accessing this directly, unless you |
| 371 | // know the odex file isn't out of date. |
| 372 | bool odex_file_load_attempted_ = false; |
| 373 | std::unique_ptr<OatFile> cached_odex_file_; |
| 374 | |
| 375 | // Cached results for OdexFileIsOutOfDate |
| 376 | bool odex_file_is_out_of_date_attempted_ = false; |
| 377 | bool cached_odex_file_is_out_of_date_; |
| 378 | |
| 379 | // Cached results for OdexFileIsUpToDate |
| 380 | bool odex_file_is_up_to_date_attempted_ = false; |
| 381 | bool cached_odex_file_is_up_to_date_; |
| 382 | |
| 383 | // Cached value of the oat file name. |
| 384 | // This should be accessed only by the OatFileName() method. |
| 385 | bool cached_oat_file_name_attempted_ = false; |
| 386 | bool cached_oat_file_name_found_; |
| 387 | std::string cached_oat_file_name_; |
| 388 | |
Richard Uhler | b361d94 | 2015-05-07 10:52:28 -0700 | [diff] [blame] | 389 | // Cached value of the loaded oat file. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 390 | // Use the GetOatFile method rather than accessing this directly, unless you |
Richard Uhler | b361d94 | 2015-05-07 10:52:28 -0700 | [diff] [blame] | 391 | // know the oat file isn't out of date. |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 392 | bool oat_file_load_attempted_ = false; |
| 393 | std::unique_ptr<OatFile> cached_oat_file_; |
| 394 | |
| 395 | // Cached results for OatFileIsOutOfDate |
| 396 | bool oat_file_is_out_of_date_attempted_ = false; |
| 397 | bool cached_oat_file_is_out_of_date_; |
| 398 | |
| 399 | // Cached results for OatFileIsUpToDate |
| 400 | bool oat_file_is_up_to_date_attempted_ = false; |
| 401 | bool cached_oat_file_is_up_to_date_; |
| 402 | |
| 403 | // Cached value of the image info. |
| 404 | // Use the GetImageInfo method rather than accessing these directly. |
| 405 | // TODO: The image info should probably be moved out of the oat file |
| 406 | // assistant to an image file manager. |
| 407 | bool image_info_load_attempted_ = false; |
| 408 | bool image_info_load_succeeded_ = false; |
| 409 | ImageInfo cached_image_info_; |
| 410 | |
Richard Uhler | 66d874d | 2015-01-15 09:37:19 -0800 | [diff] [blame] | 411 | // For debugging only. |
| 412 | // If this flag is set, the oat or odex file has been released to the user |
| 413 | // of the OatFileAssistant object and the OatFileAssistant object is in a |
| 414 | // bad state and should no longer be used. |
| 415 | bool oat_file_released_ = false; |
| 416 | |
| 417 | DISALLOW_COPY_AND_ASSIGN(OatFileAssistant); |
| 418 | }; |
| 419 | |
| 420 | } // namespace art |
| 421 | |
| 422 | #endif // ART_RUNTIME_OAT_FILE_ASSISTANT_H_ |