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 #include "oat_file_assistant.h" 18 19 #include <sstream> 20 21 #include <sys/stat.h> 22 23 #include "android-base/stringprintf.h" 24 #include "android-base/strings.h" 25 26 #include "base/logging.h" 27 #include "compiler_filter.h" 28 #include "class_linker.h" 29 #include "exec_utils.h" 30 #include "gc/heap.h" 31 #include "gc/space/image_space.h" 32 #include "image.h" 33 #include "oat.h" 34 #include "os.h" 35 #include "runtime.h" 36 #include "scoped_thread_state_change-inl.h" 37 #include "utils.h" 38 #include "vdex_file.h" 39 40 namespace art { 41 42 using android::base::StringPrintf; 43 44 std::ostream& operator << (std::ostream& stream, const OatFileAssistant::OatStatus status) { 45 switch (status) { 46 case OatFileAssistant::kOatCannotOpen: 47 stream << "kOatCannotOpen"; 48 break; 49 case OatFileAssistant::kOatDexOutOfDate: 50 stream << "kOatDexOutOfDate"; 51 break; 52 case OatFileAssistant::kOatBootImageOutOfDate: 53 stream << "kOatBootImageOutOfDate"; 54 break; 55 case OatFileAssistant::kOatRelocationOutOfDate: 56 stream << "kOatRelocationOutOfDate"; 57 break; 58 case OatFileAssistant::kOatUpToDate: 59 stream << "kOatUpToDate"; 60 break; 61 default: 62 UNREACHABLE(); 63 } 64 65 return stream; 66 } 67 68 OatFileAssistant::OatFileAssistant(const char* dex_location, 69 const InstructionSet isa, 70 bool load_executable) 71 : isa_(isa), 72 load_executable_(load_executable), 73 odex_(this, /*is_oat_location*/ false), 74 oat_(this, /*is_oat_location*/ true) { 75 CHECK(dex_location != nullptr) << "OatFileAssistant: null dex location"; 76 77 // Try to get the realpath for the dex location. 78 // 79 // This is OK with respect to dalvik cache naming scheme because we never 80 // generate oat files starting from symlinks which go into dalvik cache. 81 // (recall that the oat files in dalvik cache are encoded by replacing '/' 82 // with '@' in the path). 83 // The boot image oat files (which are symlinked in dalvik-cache) are not 84 // loaded via the oat file assistant. 85 // 86 // The only case when the dex location may resolve to a different path 87 // is for secondary dex files (e.g. /data/user/0 symlinks to /data/data and 88 // the app is free to create its own internal layout). Related to this it is 89 // worthwhile to mention that installd resolves the secondary dex location 90 // before calling dex2oat. 91 UniqueCPtr<const char[]> dex_location_real(realpath(dex_location, nullptr)); 92 if (dex_location_real != nullptr) { 93 dex_location_.assign(dex_location_real.get()); 94 } else { 95 // If we can't get the realpath of the location there's not much point in trying to move on. 96 PLOG(ERROR) << "Could not get the realpath of dex_location " << dex_location; 97 return; 98 } 99 100 if (load_executable_ && isa != kRuntimeISA) { 101 LOG(WARNING) << "OatFileAssistant: Load executable specified, " 102 << "but isa is not kRuntimeISA. Will not attempt to load executable."; 103 load_executable_ = false; 104 } 105 106 // Get the odex filename. 107 std::string error_msg; 108 std::string odex_file_name; 109 if (DexLocationToOdexFilename(dex_location_, isa_, &odex_file_name, &error_msg)) { 110 odex_.Reset(odex_file_name); 111 } else { 112 LOG(WARNING) << "Failed to determine odex file name: " << error_msg; 113 } 114 115 // Get the oat filename. 116 std::string oat_file_name; 117 if (DexLocationToOatFilename(dex_location_, isa_, &oat_file_name, &error_msg)) { 118 oat_.Reset(oat_file_name); 119 } else { 120 LOG(WARNING) << "Failed to determine oat file name for dex location " 121 << dex_location_ << ": " << error_msg; 122 } 123 124 // Check if the dex directory is writable. 125 // This will be needed in most uses of OatFileAssistant and so it's OK to 126 // compute it eagerly. (the only use which will not make use of it is 127 // OatFileAssistant::GetStatusDump()) 128 size_t pos = dex_location_.rfind('/'); 129 if (pos == std::string::npos) { 130 LOG(WARNING) << "Failed to determine dex file parent directory: " << dex_location_; 131 } else { 132 std::string parent = dex_location_.substr(0, pos); 133 if (access(parent.c_str(), W_OK) == 0) { 134 dex_parent_writable_ = true; 135 } else { 136 VLOG(oat) << "Dex parent of " << dex_location_ << " is not writable: " << strerror(errno); 137 } 138 } 139 } 140 141 OatFileAssistant::~OatFileAssistant() { 142 // Clean up the lock file. 143 if (flock_.HasFile()) { 144 unlink(flock_.GetFile()->GetPath().c_str()); 145 } 146 } 147 148 bool OatFileAssistant::IsInBootClassPath() { 149 // Note: We check the current boot class path, regardless of the ISA 150 // specified by the user. This is okay, because the boot class path should 151 // be the same for all ISAs. 152 // TODO: Can we verify the boot class path is the same for all ISAs? 153 Runtime* runtime = Runtime::Current(); 154 ClassLinker* class_linker = runtime->GetClassLinker(); 155 const auto& boot_class_path = class_linker->GetBootClassPath(); 156 for (size_t i = 0; i < boot_class_path.size(); i++) { 157 if (boot_class_path[i]->GetLocation() == dex_location_) { 158 VLOG(oat) << "Dex location " << dex_location_ << " is in boot class path"; 159 return true; 160 } 161 } 162 return false; 163 } 164 165 bool OatFileAssistant::Lock(std::string* error_msg) { 166 CHECK(error_msg != nullptr); 167 CHECK(!flock_.HasFile()) << "OatFileAssistant::Lock already acquired"; 168 169 // Note the lock will only succeed for secondary dex files and in test 170 // environment. 171 // 172 // The lock *will fail* for all primary apks in a production environment. 173 // The app does not have permissions to create locks next to its dex location 174 // (be it system, data or vendor parition). We also cannot use the odex or 175 // oat location for the same reasoning. 176 // 177 // This is best effort and if it fails it's unlikely that we will be able 178 // to generate oat files anyway. 179 std::string lock_file_name = dex_location_ + "." + GetInstructionSetString(isa_) + ".flock"; 180 181 if (!flock_.Init(lock_file_name.c_str(), error_msg)) { 182 unlink(lock_file_name.c_str()); 183 return false; 184 } 185 return true; 186 } 187 188 int OatFileAssistant::GetDexOptNeeded(CompilerFilter::Filter target, bool profile_changed) { 189 OatFileInfo& info = GetBestInfo(); 190 DexOptNeeded dexopt_needed = info.GetDexOptNeeded(target, profile_changed); 191 if (info.IsOatLocation() || dexopt_needed == kDex2OatFromScratch) { 192 return dexopt_needed; 193 } 194 return -dexopt_needed; 195 } 196 197 // Figure out the currently specified compile filter option in the runtime. 198 // Returns true on success, false if the compiler filter is invalid, in which 199 // case error_msg describes the problem. 200 static bool GetRuntimeCompilerFilterOption(CompilerFilter::Filter* filter, 201 std::string* error_msg) { 202 CHECK(filter != nullptr); 203 CHECK(error_msg != nullptr); 204 205 *filter = OatFileAssistant::kDefaultCompilerFilterForDexLoading; 206 for (StringPiece option : Runtime::Current()->GetCompilerOptions()) { 207 if (option.starts_with("--compiler-filter=")) { 208 const char* compiler_filter_string = option.substr(strlen("--compiler-filter=")).data(); 209 if (!CompilerFilter::ParseCompilerFilter(compiler_filter_string, filter)) { 210 *error_msg = std::string("Unknown --compiler-filter value: ") 211 + std::string(compiler_filter_string); 212 return false; 213 } 214 } 215 } 216 return true; 217 } 218 219 bool OatFileAssistant::IsUpToDate() { 220 return GetBestInfo().Status() == kOatUpToDate; 221 } 222 223 OatFileAssistant::ResultOfAttemptToUpdate 224 OatFileAssistant::MakeUpToDate(bool profile_changed, std::string* error_msg) { 225 CompilerFilter::Filter target; 226 if (!GetRuntimeCompilerFilterOption(&target, error_msg)) { 227 return kUpdateNotAttempted; 228 } 229 230 OatFileInfo& info = GetBestInfo(); 231 switch (info.GetDexOptNeeded(target, profile_changed)) { 232 case kNoDexOptNeeded: 233 return kUpdateSucceeded; 234 235 // TODO: For now, don't bother with all the different ways we can call 236 // dex2oat to generate the oat file. Always generate the oat file as if it 237 // were kDex2OatFromScratch. 238 case kDex2OatFromScratch: 239 case kDex2OatForBootImage: 240 case kDex2OatForRelocation: 241 case kDex2OatForFilter: 242 return GenerateOatFileNoChecks(info, target, error_msg); 243 } 244 UNREACHABLE(); 245 } 246 247 std::unique_ptr<OatFile> OatFileAssistant::GetBestOatFile() { 248 return GetBestInfo().ReleaseFileForUse(); 249 } 250 251 std::string OatFileAssistant::GetStatusDump() { 252 std::ostringstream status; 253 bool oat_file_exists = false; 254 bool odex_file_exists = false; 255 if (oat_.Status() != kOatCannotOpen) { 256 // If we can open the file, Filename should not return null. 257 CHECK(oat_.Filename() != nullptr); 258 259 oat_file_exists = true; 260 status << *oat_.Filename() << "[status=" << oat_.Status() << ", "; 261 const OatFile* file = oat_.GetFile(); 262 if (file == nullptr) { 263 // If the file is null even though the status is not kOatCannotOpen, it 264 // means we must have a vdex file with no corresponding oat file. In 265 // this case we cannot determine the compilation filter. Indicate that 266 // we have only the vdex file instead. 267 status << "vdex-only"; 268 } else { 269 status << "compilation_filter=" << CompilerFilter::NameOfFilter(file->GetCompilerFilter()); 270 } 271 } 272 273 if (odex_.Status() != kOatCannotOpen) { 274 // If we can open the file, Filename should not return null. 275 CHECK(odex_.Filename() != nullptr); 276 277 odex_file_exists = true; 278 if (oat_file_exists) { 279 status << "] "; 280 } 281 status << *odex_.Filename() << "[status=" << odex_.Status() << ", "; 282 const OatFile* file = odex_.GetFile(); 283 if (file == nullptr) { 284 status << "vdex-only"; 285 } else { 286 status << "compilation_filter=" << CompilerFilter::NameOfFilter(file->GetCompilerFilter()); 287 } 288 } 289 290 if (!oat_file_exists && !odex_file_exists) { 291 status << "invalid["; 292 } 293 294 status << "]"; 295 return status.str(); 296 } 297 298 std::vector<std::unique_ptr<const DexFile>> OatFileAssistant::LoadDexFiles( 299 const OatFile& oat_file, const char* dex_location) { 300 std::vector<std::unique_ptr<const DexFile>> dex_files; 301 302 // Load the main dex file. 303 std::string error_msg; 304 const OatFile::OatDexFile* oat_dex_file = oat_file.GetOatDexFile( 305 dex_location, nullptr, &error_msg); 306 if (oat_dex_file == nullptr) { 307 LOG(WARNING) << error_msg; 308 return std::vector<std::unique_ptr<const DexFile>>(); 309 } 310 311 std::unique_ptr<const DexFile> dex_file = oat_dex_file->OpenDexFile(&error_msg); 312 if (dex_file.get() == nullptr) { 313 LOG(WARNING) << "Failed to open dex file from oat dex file: " << error_msg; 314 return std::vector<std::unique_ptr<const DexFile>>(); 315 } 316 dex_files.push_back(std::move(dex_file)); 317 318 // Load the rest of the multidex entries 319 for (size_t i = 1; ; i++) { 320 std::string multidex_dex_location = DexFile::GetMultiDexLocation(i, dex_location); 321 oat_dex_file = oat_file.GetOatDexFile(multidex_dex_location.c_str(), nullptr); 322 if (oat_dex_file == nullptr) { 323 // There are no more multidex entries to load. 324 break; 325 } 326 327 dex_file = oat_dex_file->OpenDexFile(&error_msg); 328 if (dex_file.get() == nullptr) { 329 LOG(WARNING) << "Failed to open dex file from oat dex file: " << error_msg; 330 return std::vector<std::unique_ptr<const DexFile>>(); 331 } 332 dex_files.push_back(std::move(dex_file)); 333 } 334 return dex_files; 335 } 336 337 bool OatFileAssistant::HasOriginalDexFiles() { 338 // Ensure GetRequiredDexChecksums has been run so that 339 // has_original_dex_files_ is initialized. We don't care about the result of 340 // GetRequiredDexChecksums. 341 GetRequiredDexChecksums(); 342 return has_original_dex_files_; 343 } 344 345 OatFileAssistant::OatStatus OatFileAssistant::OdexFileStatus() { 346 return odex_.Status(); 347 } 348 349 OatFileAssistant::OatStatus OatFileAssistant::OatFileStatus() { 350 return oat_.Status(); 351 } 352 353 bool OatFileAssistant::DexChecksumUpToDate(const VdexFile& file, std::string* error_msg) { 354 const std::vector<uint32_t>* required_dex_checksums = GetRequiredDexChecksums(); 355 if (required_dex_checksums == nullptr) { 356 LOG(WARNING) << "Required dex checksums not found. Assuming dex checksums are up to date."; 357 return true; 358 } 359 360 uint32_t number_of_dex_files = file.GetHeader().GetNumberOfDexFiles(); 361 if (required_dex_checksums->size() != number_of_dex_files) { 362 *error_msg = StringPrintf("expected %zu dex files but found %u", 363 required_dex_checksums->size(), 364 number_of_dex_files); 365 return false; 366 } 367 368 for (uint32_t i = 0; i < number_of_dex_files; i++) { 369 uint32_t expected_checksum = (*required_dex_checksums)[i]; 370 uint32_t actual_checksum = file.GetLocationChecksum(i); 371 if (expected_checksum != actual_checksum) { 372 std::string dex = DexFile::GetMultiDexLocation(i, dex_location_.c_str()); 373 *error_msg = StringPrintf("Dex checksum does not match for dex: %s." 374 "Expected: %u, actual: %u", 375 dex.c_str(), 376 expected_checksum, 377 actual_checksum); 378 return false; 379 } 380 } 381 382 return true; 383 } 384 385 bool OatFileAssistant::DexChecksumUpToDate(const OatFile& file, std::string* error_msg) { 386 const std::vector<uint32_t>* required_dex_checksums = GetRequiredDexChecksums(); 387 if (required_dex_checksums == nullptr) { 388 LOG(WARNING) << "Required dex checksums not found. Assuming dex checksums are up to date."; 389 return true; 390 } 391 392 uint32_t number_of_dex_files = file.GetOatHeader().GetDexFileCount(); 393 if (required_dex_checksums->size() != number_of_dex_files) { 394 *error_msg = StringPrintf("expected %zu dex files but found %u", 395 required_dex_checksums->size(), 396 number_of_dex_files); 397 return false; 398 } 399 400 for (uint32_t i = 0; i < number_of_dex_files; i++) { 401 std::string dex = DexFile::GetMultiDexLocation(i, dex_location_.c_str()); 402 uint32_t expected_checksum = (*required_dex_checksums)[i]; 403 const OatFile::OatDexFile* oat_dex_file = file.GetOatDexFile(dex.c_str(), nullptr); 404 if (oat_dex_file == nullptr) { 405 *error_msg = StringPrintf("failed to find %s in %s", dex.c_str(), file.GetLocation().c_str()); 406 return false; 407 } 408 uint32_t actual_checksum = oat_dex_file->GetDexFileLocationChecksum(); 409 if (expected_checksum != actual_checksum) { 410 VLOG(oat) << "Dex checksum does not match for dex: " << dex 411 << ". Expected: " << expected_checksum 412 << ", Actual: " << actual_checksum; 413 return false; 414 } 415 } 416 return true; 417 } 418 419 OatFileAssistant::OatStatus OatFileAssistant::GivenOatFileStatus(const OatFile& file) { 420 // Verify the ART_USE_READ_BARRIER state. 421 // TODO: Don't fully reject files due to read barrier state. If they contain 422 // compiled code and are otherwise okay, we should return something like 423 // kOatRelocationOutOfDate. If they don't contain compiled code, the read 424 // barrier state doesn't matter. 425 const bool is_cc = file.GetOatHeader().IsConcurrentCopying(); 426 constexpr bool kRuntimeIsCC = kUseReadBarrier; 427 if (is_cc != kRuntimeIsCC) { 428 return kOatCannotOpen; 429 } 430 431 // Verify the dex checksum. 432 std::string error_msg; 433 if (kIsVdexEnabled) { 434 VdexFile* vdex = file.GetVdexFile(); 435 if (!DexChecksumUpToDate(*vdex, &error_msg)) { 436 LOG(ERROR) << error_msg; 437 return kOatDexOutOfDate; 438 } 439 } else { 440 if (!DexChecksumUpToDate(file, &error_msg)) { 441 LOG(ERROR) << error_msg; 442 return kOatDexOutOfDate; 443 } 444 } 445 446 CompilerFilter::Filter current_compiler_filter = file.GetCompilerFilter(); 447 448 // Verify the image checksum 449 if (CompilerFilter::DependsOnImageChecksum(current_compiler_filter)) { 450 const ImageInfo* image_info = GetImageInfo(); 451 if (image_info == nullptr) { 452 VLOG(oat) << "No image for oat image checksum to match against."; 453 454 if (HasOriginalDexFiles()) { 455 return kOatBootImageOutOfDate; 456 } 457 458 // If there is no original dex file to fall back to, grudgingly accept 459 // the oat file. This could technically lead to crashes, but there's no 460 // way we could find a better oat file to use for this dex location, 461 // and it's better than being stuck in a boot loop with no way out. 462 // The problem will hopefully resolve itself the next time the runtime 463 // starts up. 464 LOG(WARNING) << "Dex location " << dex_location_ << " does not seem to include dex file. " 465 << "Allow oat file use. This is potentially dangerous."; 466 } else if (file.GetOatHeader().GetImageFileLocationOatChecksum() != image_info->oat_checksum) { 467 VLOG(oat) << "Oat image checksum does not match image checksum."; 468 return kOatBootImageOutOfDate; 469 } 470 } else { 471 VLOG(oat) << "Image checksum test skipped for compiler filter " << current_compiler_filter; 472 } 473 474 if (CompilerFilter::IsAotCompilationEnabled(current_compiler_filter)) { 475 if (!file.IsPic()) { 476 const ImageInfo* image_info = GetImageInfo(); 477 if (image_info == nullptr) { 478 VLOG(oat) << "No image to check oat relocation against."; 479 return kOatRelocationOutOfDate; 480 } 481 482 // Verify the oat_data_begin recorded for the image in the oat file matches 483 // the actual oat_data_begin for boot.oat in the image. 484 const OatHeader& oat_header = file.GetOatHeader(); 485 uintptr_t oat_data_begin = oat_header.GetImageFileLocationOatDataBegin(); 486 if (oat_data_begin != image_info->oat_data_begin) { 487 VLOG(oat) << file.GetLocation() << 488 ": Oat file image oat_data_begin (" << oat_data_begin << ")" 489 << " does not match actual image oat_data_begin (" 490 << image_info->oat_data_begin << ")"; 491 return kOatRelocationOutOfDate; 492 } 493 494 // Verify the oat_patch_delta recorded for the image in the oat file matches 495 // the actual oat_patch_delta for the image. 496 int32_t oat_patch_delta = oat_header.GetImagePatchDelta(); 497 if (oat_patch_delta != image_info->patch_delta) { 498 VLOG(oat) << file.GetLocation() << 499 ": Oat file image patch delta (" << oat_patch_delta << ")" 500 << " does not match actual image patch delta (" 501 << image_info->patch_delta << ")"; 502 return kOatRelocationOutOfDate; 503 } 504 } else { 505 // Oat files compiled in PIC mode do not require relocation. 506 VLOG(oat) << "Oat relocation test skipped for PIC oat file"; 507 } 508 } else { 509 VLOG(oat) << "Oat relocation test skipped for compiler filter " << current_compiler_filter; 510 } 511 return kOatUpToDate; 512 } 513 514 static bool DexLocationToOdexNames(const std::string& location, 515 InstructionSet isa, 516 std::string* odex_filename, 517 std::string* oat_dir, 518 std::string* isa_dir, 519 std::string* error_msg) { 520 CHECK(odex_filename != nullptr); 521 CHECK(error_msg != nullptr); 522 523 // The odex file name is formed by replacing the dex_location extension with 524 // .odex and inserting an oat/<isa> directory. For example: 525 // location = /foo/bar/baz.jar 526 // odex_location = /foo/bar/oat/<isa>/baz.odex 527 528 // Find the directory portion of the dex location and add the oat/<isa> 529 // directory. 530 size_t pos = location.rfind('/'); 531 if (pos == std::string::npos) { 532 *error_msg = "Dex location " + location + " has no directory."; 533 return false; 534 } 535 std::string dir = location.substr(0, pos+1); 536 // Add the oat directory. 537 dir += "oat"; 538 if (oat_dir != nullptr) { 539 *oat_dir = dir; 540 } 541 // Add the isa directory 542 dir += "/" + std::string(GetInstructionSetString(isa)); 543 if (isa_dir != nullptr) { 544 *isa_dir = dir; 545 } 546 547 // Get the base part of the file without the extension. 548 std::string file = location.substr(pos+1); 549 pos = file.rfind('.'); 550 if (pos == std::string::npos) { 551 *error_msg = "Dex location " + location + " has no extension."; 552 return false; 553 } 554 std::string base = file.substr(0, pos); 555 556 *odex_filename = dir + "/" + base + ".odex"; 557 return true; 558 } 559 560 // Prepare a subcomponent of the odex directory. 561 // (i.e. create and set the expected permissions on the path `dir`). 562 static bool PrepareDirectory(const std::string& dir, std::string* error_msg) { 563 struct stat dir_stat; 564 if (TEMP_FAILURE_RETRY(stat(dir.c_str(), &dir_stat)) == 0) { 565 // The directory exists. Check if it is indeed a directory. 566 if (!S_ISDIR(dir_stat.st_mode)) { 567 *error_msg = dir + " is not a dir"; 568 return false; 569 } else { 570 // The dir is already on disk. 571 return true; 572 } 573 } 574 575 // Failed to stat. We need to create the directory. 576 if (errno != ENOENT) { 577 *error_msg = "Could not stat isa dir " + dir + ":" + strerror(errno); 578 return false; 579 } 580 581 mode_t mode = S_IRWXU | S_IXGRP | S_IXOTH; 582 if (mkdir(dir.c_str(), mode) != 0) { 583 *error_msg = "Could not create dir " + dir + ":" + strerror(errno); 584 return false; 585 } 586 if (chmod(dir.c_str(), mode) != 0) { 587 *error_msg = "Could not create the oat dir " + dir + ":" + strerror(errno); 588 return false; 589 } 590 return true; 591 } 592 593 // Prepares the odex directory for the given dex location. 594 static bool PrepareOdexDirectories(const std::string& dex_location, 595 const std::string& expected_odex_location, 596 InstructionSet isa, 597 std::string* error_msg) { 598 std::string actual_odex_location; 599 std::string oat_dir; 600 std::string isa_dir; 601 if (!DexLocationToOdexNames( 602 dex_location, isa, &actual_odex_location, &oat_dir, &isa_dir, error_msg)) { 603 return false; 604 } 605 DCHECK_EQ(expected_odex_location, actual_odex_location); 606 607 if (!PrepareDirectory(oat_dir, error_msg)) { 608 return false; 609 } 610 if (!PrepareDirectory(isa_dir, error_msg)) { 611 return false; 612 } 613 return true; 614 } 615 616 OatFileAssistant::ResultOfAttemptToUpdate OatFileAssistant::GenerateOatFileNoChecks( 617 OatFileAssistant::OatFileInfo& info, CompilerFilter::Filter filter, std::string* error_msg) { 618 CHECK(error_msg != nullptr); 619 620 Runtime* runtime = Runtime::Current(); 621 if (!runtime->IsDex2OatEnabled()) { 622 *error_msg = "Generation of oat file for dex location " + dex_location_ 623 + " not attempted because dex2oat is disabled."; 624 return kUpdateNotAttempted; 625 } 626 627 if (info.Filename() == nullptr) { 628 *error_msg = "Generation of oat file for dex location " + dex_location_ 629 + " not attempted because the oat file name could not be determined."; 630 return kUpdateNotAttempted; 631 } 632 const std::string& oat_file_name = *info.Filename(); 633 const std::string& vdex_file_name = GetVdexFilename(oat_file_name); 634 635 // dex2oat ignores missing dex files and doesn't report an error. 636 // Check explicitly here so we can detect the error properly. 637 // TODO: Why does dex2oat behave that way? 638 struct stat dex_path_stat; 639 if (TEMP_FAILURE_RETRY(stat(dex_location_.c_str(), &dex_path_stat)) != 0) { 640 *error_msg = "Could not access dex location " + dex_location_ + ":" + strerror(errno); 641 return kUpdateNotAttempted; 642 } 643 644 // If this is the odex location, we need to create the odex file layout (../oat/isa/..) 645 if (!info.IsOatLocation()) { 646 if (!PrepareOdexDirectories(dex_location_, oat_file_name, isa_, error_msg)) { 647 return kUpdateNotAttempted; 648 } 649 } 650 651 // Set the permissions for the oat and the vdex files. 652 // The user always gets read and write while the group and others propagate 653 // the reading access of the original dex file. 654 mode_t file_mode = S_IRUSR | S_IWUSR | 655 (dex_path_stat.st_mode & S_IRGRP) | 656 (dex_path_stat.st_mode & S_IROTH); 657 658 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_file_name.c_str())); 659 if (vdex_file.get() == nullptr) { 660 *error_msg = "Generation of oat file " + oat_file_name 661 + " not attempted because the vdex file " + vdex_file_name 662 + " could not be opened."; 663 return kUpdateNotAttempted; 664 } 665 666 if (fchmod(vdex_file->Fd(), file_mode) != 0) { 667 *error_msg = "Generation of oat file " + oat_file_name 668 + " not attempted because the vdex file " + vdex_file_name 669 + " could not be made world readable."; 670 return kUpdateNotAttempted; 671 } 672 673 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_file_name.c_str())); 674 if (oat_file.get() == nullptr) { 675 *error_msg = "Generation of oat file " + oat_file_name 676 + " not attempted because the oat file could not be created."; 677 return kUpdateNotAttempted; 678 } 679 680 if (fchmod(oat_file->Fd(), file_mode) != 0) { 681 *error_msg = "Generation of oat file " + oat_file_name 682 + " not attempted because the oat file could not be made world readable."; 683 oat_file->Erase(); 684 return kUpdateNotAttempted; 685 } 686 687 std::vector<std::string> args; 688 args.push_back("--dex-file=" + dex_location_); 689 args.push_back("--output-vdex-fd=" + std::to_string(vdex_file->Fd())); 690 args.push_back("--oat-fd=" + std::to_string(oat_file->Fd())); 691 args.push_back("--oat-location=" + oat_file_name); 692 args.push_back("--compiler-filter=" + CompilerFilter::NameOfFilter(filter)); 693 694 if (!Dex2Oat(args, error_msg)) { 695 // Manually delete the oat and vdex files. This ensures there is no garbage 696 // left over if the process unexpectedly died. 697 vdex_file->Erase(); 698 unlink(vdex_file_name.c_str()); 699 oat_file->Erase(); 700 unlink(oat_file_name.c_str()); 701 return kUpdateFailed; 702 } 703 704 if (vdex_file->FlushCloseOrErase() != 0) { 705 *error_msg = "Unable to close vdex file " + vdex_file_name; 706 unlink(vdex_file_name.c_str()); 707 return kUpdateFailed; 708 } 709 710 if (oat_file->FlushCloseOrErase() != 0) { 711 *error_msg = "Unable to close oat file " + oat_file_name; 712 unlink(oat_file_name.c_str()); 713 return kUpdateFailed; 714 } 715 716 // Mark that the odex file has changed and we should try to reload. 717 info.Reset(); 718 return kUpdateSucceeded; 719 } 720 721 bool OatFileAssistant::Dex2Oat(const std::vector<std::string>& args, 722 std::string* error_msg) { 723 Runtime* runtime = Runtime::Current(); 724 std::string image_location = ImageLocation(); 725 if (image_location.empty()) { 726 *error_msg = "No image location found for Dex2Oat."; 727 return false; 728 } 729 730 std::vector<std::string> argv; 731 argv.push_back(runtime->GetCompilerExecutable()); 732 argv.push_back("--runtime-arg"); 733 argv.push_back("-classpath"); 734 argv.push_back("--runtime-arg"); 735 std::string class_path = runtime->GetClassPathString(); 736 if (class_path == "") { 737 class_path = OatFile::kSpecialSharedLibrary; 738 } 739 argv.push_back(class_path); 740 if (runtime->IsJavaDebuggable()) { 741 argv.push_back("--debuggable"); 742 } 743 runtime->AddCurrentRuntimeFeaturesAsDex2OatArguments(&argv); 744 745 if (!runtime->IsVerificationEnabled()) { 746 argv.push_back("--compiler-filter=verify-none"); 747 } 748 749 if (runtime->MustRelocateIfPossible()) { 750 argv.push_back("--runtime-arg"); 751 argv.push_back("-Xrelocate"); 752 } else { 753 argv.push_back("--runtime-arg"); 754 argv.push_back("-Xnorelocate"); 755 } 756 757 if (!kIsTargetBuild) { 758 argv.push_back("--host"); 759 } 760 761 argv.push_back("--boot-image=" + image_location); 762 763 std::vector<std::string> compiler_options = runtime->GetCompilerOptions(); 764 argv.insert(argv.end(), compiler_options.begin(), compiler_options.end()); 765 766 argv.insert(argv.end(), args.begin(), args.end()); 767 768 std::string command_line(android::base::Join(argv, ' ')); 769 return Exec(argv, error_msg); 770 } 771 772 bool OatFileAssistant::DexLocationToOdexFilename(const std::string& location, 773 InstructionSet isa, 774 std::string* odex_filename, 775 std::string* error_msg) { 776 return DexLocationToOdexNames(location, isa, odex_filename, nullptr, nullptr, error_msg); 777 } 778 779 bool OatFileAssistant::DexLocationToOatFilename(const std::string& location, 780 InstructionSet isa, 781 std::string* oat_filename, 782 std::string* error_msg) { 783 CHECK(oat_filename != nullptr); 784 CHECK(error_msg != nullptr); 785 786 std::string cache_dir = GetDalvikCache(GetInstructionSetString(isa)); 787 if (cache_dir.empty()) { 788 *error_msg = "Dalvik cache directory does not exist"; 789 return false; 790 } 791 792 // TODO: The oat file assistant should be the definitive place for 793 // determining the oat file name from the dex location, not 794 // GetDalvikCacheFilename. 795 return GetDalvikCacheFilename(location.c_str(), cache_dir.c_str(), oat_filename, error_msg); 796 } 797 798 std::string OatFileAssistant::ImageLocation() { 799 Runtime* runtime = Runtime::Current(); 800 const std::vector<gc::space::ImageSpace*>& image_spaces = 801 runtime->GetHeap()->GetBootImageSpaces(); 802 if (image_spaces.empty()) { 803 return ""; 804 } 805 return image_spaces[0]->GetImageLocation(); 806 } 807 808 const std::vector<uint32_t>* OatFileAssistant::GetRequiredDexChecksums() { 809 if (!required_dex_checksums_attempted_) { 810 required_dex_checksums_attempted_ = true; 811 required_dex_checksums_found_ = false; 812 cached_required_dex_checksums_.clear(); 813 std::string error_msg; 814 if (DexFile::GetMultiDexChecksums(dex_location_.c_str(), 815 &cached_required_dex_checksums_, 816 &error_msg)) { 817 required_dex_checksums_found_ = true; 818 has_original_dex_files_ = true; 819 } else { 820 // This can happen if the original dex file has been stripped from the 821 // apk. 822 VLOG(oat) << "OatFileAssistant: " << error_msg; 823 has_original_dex_files_ = false; 824 825 // Get the checksums from the odex if we can. 826 const OatFile* odex_file = odex_.GetFile(); 827 if (odex_file != nullptr) { 828 required_dex_checksums_found_ = true; 829 for (size_t i = 0; i < odex_file->GetOatHeader().GetDexFileCount(); i++) { 830 std::string dex = DexFile::GetMultiDexLocation(i, dex_location_.c_str()); 831 const OatFile::OatDexFile* odex_dex_file = odex_file->GetOatDexFile(dex.c_str(), nullptr); 832 if (odex_dex_file == nullptr) { 833 required_dex_checksums_found_ = false; 834 break; 835 } 836 cached_required_dex_checksums_.push_back(odex_dex_file->GetDexFileLocationChecksum()); 837 } 838 } 839 } 840 } 841 return required_dex_checksums_found_ ? &cached_required_dex_checksums_ : nullptr; 842 } 843 844 std::unique_ptr<OatFileAssistant::ImageInfo> 845 OatFileAssistant::ImageInfo::GetRuntimeImageInfo(InstructionSet isa, std::string* error_msg) { 846 CHECK(error_msg != nullptr); 847 848 Runtime* runtime = Runtime::Current(); 849 std::unique_ptr<ImageInfo> info(new ImageInfo()); 850 info->location = runtime->GetImageLocation(); 851 852 std::unique_ptr<ImageHeader> image_header( 853 gc::space::ImageSpace::ReadImageHeader(info->location.c_str(), isa, error_msg)); 854 if (image_header == nullptr) { 855 return nullptr; 856 } 857 858 info->oat_checksum = image_header->GetOatChecksum(); 859 info->oat_data_begin = reinterpret_cast<uintptr_t>(image_header->GetOatDataBegin()); 860 info->patch_delta = image_header->GetPatchDelta(); 861 return info; 862 } 863 864 const OatFileAssistant::ImageInfo* OatFileAssistant::GetImageInfo() { 865 if (!image_info_load_attempted_) { 866 image_info_load_attempted_ = true; 867 std::string error_msg; 868 cached_image_info_ = ImageInfo::GetRuntimeImageInfo(isa_, &error_msg); 869 if (cached_image_info_ == nullptr) { 870 LOG(WARNING) << "Unable to get runtime image info: " << error_msg; 871 } 872 } 873 return cached_image_info_.get(); 874 } 875 876 OatFileAssistant::OatFileInfo& OatFileAssistant::GetBestInfo() { 877 // TODO(calin): Document the side effects of class loading when 878 // running dalvikvm command line. 879 if (dex_parent_writable_) { 880 // If the parent of the dex file is writable it means that we can 881 // create the odex file. In this case we unconditionally pick the odex 882 // as the best oat file. This corresponds to the regular use case when 883 // apps gets installed or when they load private, secondary dex file. 884 // For apps on the system partition the odex location will not be 885 // writable and thus the oat location might be more up to date. 886 return odex_; 887 } 888 889 // We cannot write to the odex location. This must be a system app. 890 891 // If the oat location is usable take it. 892 if (oat_.IsUseable()) { 893 return oat_; 894 } 895 896 // The oat file is not usable but the odex file might be up to date. 897 // This is an indication that we are dealing with an up to date prebuilt 898 // (that doesn't need relocation). 899 if (odex_.Status() == kOatUpToDate) { 900 return odex_; 901 } 902 903 // The oat file is not usable and the odex file is not up to date. 904 // However we have access to the original dex file which means we can make 905 // the oat location up to date. 906 if (HasOriginalDexFiles()) { 907 return oat_; 908 } 909 910 // We got into the worst situation here: 911 // - the oat location is not usable 912 // - the prebuild odex location is not up to date 913 // - and we don't have the original dex file anymore (stripped). 914 // Pick the odex if it exists, or the oat if not. 915 return (odex_.Status() == kOatCannotOpen) ? oat_ : odex_; 916 } 917 918 std::unique_ptr<gc::space::ImageSpace> OatFileAssistant::OpenImageSpace(const OatFile* oat_file) { 919 DCHECK(oat_file != nullptr); 920 std::string art_file = ReplaceFileExtension(oat_file->GetLocation(), "art"); 921 if (art_file.empty()) { 922 return nullptr; 923 } 924 std::string error_msg; 925 ScopedObjectAccess soa(Thread::Current()); 926 std::unique_ptr<gc::space::ImageSpace> ret = 927 gc::space::ImageSpace::CreateFromAppImage(art_file.c_str(), oat_file, &error_msg); 928 if (ret == nullptr && (VLOG_IS_ON(image) || OS::FileExists(art_file.c_str()))) { 929 LOG(INFO) << "Failed to open app image " << art_file.c_str() << " " << error_msg; 930 } 931 return ret; 932 } 933 934 OatFileAssistant::OatFileInfo::OatFileInfo(OatFileAssistant* oat_file_assistant, 935 bool is_oat_location) 936 : oat_file_assistant_(oat_file_assistant), is_oat_location_(is_oat_location) 937 {} 938 939 bool OatFileAssistant::OatFileInfo::IsOatLocation() { 940 return is_oat_location_; 941 } 942 943 const std::string* OatFileAssistant::OatFileInfo::Filename() { 944 return filename_provided_ ? &filename_ : nullptr; 945 } 946 947 bool OatFileAssistant::OatFileInfo::IsUseable() { 948 switch (Status()) { 949 case kOatCannotOpen: 950 case kOatDexOutOfDate: 951 case kOatBootImageOutOfDate: return false; 952 953 case kOatRelocationOutOfDate: 954 case kOatUpToDate: return true; 955 } 956 UNREACHABLE(); 957 } 958 959 OatFileAssistant::OatStatus OatFileAssistant::OatFileInfo::Status() { 960 if (!status_attempted_) { 961 status_attempted_ = true; 962 const OatFile* file = GetFile(); 963 if (file == nullptr) { 964 // Check to see if there is a vdex file we can make use of. 965 std::string error_msg; 966 std::string vdex_filename = GetVdexFilename(filename_); 967 std::unique_ptr<VdexFile> vdex = VdexFile::Open(vdex_filename, 968 /*writeable*/false, 969 /*low_4gb*/false, 970 /*unquicken*/false, 971 &error_msg); 972 if (vdex == nullptr) { 973 status_ = kOatCannotOpen; 974 VLOG(oat) << "unable to open vdex file " << vdex_filename << ": " << error_msg; 975 } else { 976 if (oat_file_assistant_->DexChecksumUpToDate(*vdex, &error_msg)) { 977 // The vdex file does not contain enough information to determine 978 // whether it is up to date with respect to the boot image, so we 979 // assume it is out of date. 980 VLOG(oat) << error_msg; 981 status_ = kOatBootImageOutOfDate; 982 } else { 983 status_ = kOatDexOutOfDate; 984 } 985 } 986 } else { 987 status_ = oat_file_assistant_->GivenOatFileStatus(*file); 988 VLOG(oat) << file->GetLocation() << " is " << status_ 989 << " with filter " << file->GetCompilerFilter(); 990 } 991 } 992 return status_; 993 } 994 995 OatFileAssistant::DexOptNeeded OatFileAssistant::OatFileInfo::GetDexOptNeeded( 996 CompilerFilter::Filter target, bool profile_changed) { 997 bool compilation_desired = CompilerFilter::IsAotCompilationEnabled(target); 998 bool filter_okay = CompilerFilterIsOkay(target, profile_changed); 999 1000 if (filter_okay && Status() == kOatUpToDate) { 1001 // The oat file is in good shape as is. 1002 return kNoDexOptNeeded; 1003 } 1004 1005 if (filter_okay && !compilation_desired && Status() == kOatRelocationOutOfDate) { 1006 // If no compilation is desired, then it doesn't matter if the oat 1007 // file needs relocation. It's in good shape as is. 1008 return kNoDexOptNeeded; 1009 } 1010 1011 if (filter_okay && Status() == kOatRelocationOutOfDate) { 1012 return kDex2OatForRelocation; 1013 } 1014 1015 if (IsUseable()) { 1016 return kDex2OatForFilter; 1017 } 1018 1019 if (Status() == kOatBootImageOutOfDate) { 1020 return kDex2OatForBootImage; 1021 } 1022 1023 if (oat_file_assistant_->HasOriginalDexFiles()) { 1024 return kDex2OatFromScratch; 1025 } else { 1026 // Otherwise there is nothing we can do, even if we want to. 1027 return kNoDexOptNeeded; 1028 } 1029 } 1030 1031 const OatFile* OatFileAssistant::OatFileInfo::GetFile() { 1032 CHECK(!file_released_) << "GetFile called after oat file released."; 1033 if (!load_attempted_) { 1034 load_attempted_ = true; 1035 if (filename_provided_) { 1036 std::string error_msg; 1037 file_.reset(OatFile::Open(filename_.c_str(), 1038 filename_.c_str(), 1039 nullptr, 1040 nullptr, 1041 oat_file_assistant_->load_executable_, 1042 /*low_4gb*/false, 1043 oat_file_assistant_->dex_location_.c_str(), 1044 &error_msg)); 1045 if (file_.get() == nullptr) { 1046 VLOG(oat) << "OatFileAssistant test for existing oat file " 1047 << filename_ << ": " << error_msg; 1048 } 1049 } 1050 } 1051 return file_.get(); 1052 } 1053 1054 bool OatFileAssistant::OatFileInfo::CompilerFilterIsOkay( 1055 CompilerFilter::Filter target, bool profile_changed) { 1056 const OatFile* file = GetFile(); 1057 if (file == nullptr) { 1058 return false; 1059 } 1060 1061 CompilerFilter::Filter current = file->GetCompilerFilter(); 1062 if (profile_changed && CompilerFilter::DependsOnProfile(current)) { 1063 VLOG(oat) << "Compiler filter not okay because Profile changed"; 1064 return false; 1065 } 1066 return CompilerFilter::IsAsGoodAs(current, target); 1067 } 1068 1069 bool OatFileAssistant::OatFileInfo::IsExecutable() { 1070 const OatFile* file = GetFile(); 1071 return (file != nullptr && file->IsExecutable()); 1072 } 1073 1074 void OatFileAssistant::OatFileInfo::Reset() { 1075 load_attempted_ = false; 1076 file_.reset(); 1077 status_attempted_ = false; 1078 } 1079 1080 void OatFileAssistant::OatFileInfo::Reset(const std::string& filename) { 1081 filename_provided_ = true; 1082 filename_ = filename; 1083 Reset(); 1084 } 1085 1086 std::unique_ptr<OatFile> OatFileAssistant::OatFileInfo::ReleaseFile() { 1087 file_released_ = true; 1088 return std::move(file_); 1089 } 1090 1091 std::unique_ptr<OatFile> OatFileAssistant::OatFileInfo::ReleaseFileForUse() { 1092 if (Status() == kOatUpToDate) { 1093 return ReleaseFile(); 1094 } 1095 1096 VLOG(oat) << "Oat File Assistant: No relocated oat file found," 1097 << " attempting to fall back to interpreting oat file instead."; 1098 1099 if (Status() == kOatRelocationOutOfDate && !IsExecutable()) { 1100 return ReleaseFile(); 1101 } 1102 1103 if (Status() == kOatRelocationOutOfDate) { 1104 // We are loading an oat file for runtime use that needs relocation. 1105 // Reload the file non-executable to ensure that we interpret out of the 1106 // dex code in the oat file rather than trying to execute the unrelocated 1107 // compiled code. 1108 oat_file_assistant_->load_executable_ = false; 1109 Reset(); 1110 if (IsUseable()) { 1111 CHECK(!IsExecutable()); 1112 return ReleaseFile(); 1113 } 1114 } 1115 return std::unique_ptr<OatFile>(); 1116 } 1117 } // namespace art 1118