dex2oat.cc revision 998ee7d0f62a1ee7efaaad49e728d19c38b4c9c3
1/* 2 * Copyright (C) 2011 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 <stdio.h> 18#include <stdlib.h> 19#include <sys/stat.h> 20#include <valgrind.h> 21 22#include <fstream> 23#include <iostream> 24#include <sstream> 25#include <string> 26#include <vector> 27 28#if defined(__linux__) && defined(__arm__) 29#include <sys/personality.h> 30#include <sys/utsname.h> 31#endif 32 33#include "base/stl_util.h" 34#include "base/stringpiece.h" 35#include "base/timing_logger.h" 36#include "base/unix_file/fd_file.h" 37#include "class_linker.h" 38#include "compiler.h" 39#include "compiler_callbacks.h" 40#include "dex_file-inl.h" 41#include "dex/pass_driver_me_opts.h" 42#include "dex/verification_results.h" 43#include "dex/quick_compiler_callbacks.h" 44#include "dex/quick/dex_file_to_method_inliner_map.h" 45#include "driver/compiler_driver.h" 46#include "driver/compiler_options.h" 47#include "elf_fixup.h" 48#include "elf_patcher.h" 49#include "elf_stripper.h" 50#include "gc/space/image_space.h" 51#include "gc/space/space-inl.h" 52#include "image_writer.h" 53#include "leb128.h" 54#include "mirror/art_method-inl.h" 55#include "mirror/class-inl.h" 56#include "mirror/class_loader.h" 57#include "mirror/object-inl.h" 58#include "mirror/object_array-inl.h" 59#include "oat_writer.h" 60#include "os.h" 61#include "runtime.h" 62#include "ScopedLocalRef.h" 63#include "scoped_thread_state_change.h" 64#include "utils.h" 65#include "vector_output_stream.h" 66#include "well_known_classes.h" 67#include "zip_archive.h" 68 69namespace art { 70 71static int original_argc; 72static char** original_argv; 73 74static std::string CommandLine() { 75 std::vector<std::string> command; 76 for (int i = 0; i < original_argc; ++i) { 77 command.push_back(original_argv[i]); 78 } 79 return Join(command, ' '); 80} 81 82static void UsageErrorV(const char* fmt, va_list ap) { 83 std::string error; 84 StringAppendV(&error, fmt, ap); 85 LOG(ERROR) << error; 86} 87 88static void UsageError(const char* fmt, ...) { 89 va_list ap; 90 va_start(ap, fmt); 91 UsageErrorV(fmt, ap); 92 va_end(ap); 93} 94 95static void Usage(const char* fmt, ...) { 96 va_list ap; 97 va_start(ap, fmt); 98 UsageErrorV(fmt, ap); 99 va_end(ap); 100 101 UsageError("Command: %s", CommandLine().c_str()); 102 103 UsageError("Usage: dex2oat [options]..."); 104 UsageError(""); 105 UsageError(" --dex-file=<dex-file>: specifies a .dex file to compile."); 106 UsageError(" Example: --dex-file=/system/framework/core.jar"); 107 UsageError(""); 108 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file"); 109 UsageError(" containing a classes.dex file to compile."); 110 UsageError(" Example: --zip-fd=5"); 111 UsageError(""); 112 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file"); 113 UsageError(" corresponding to the file descriptor specified by --zip-fd."); 114 UsageError(" Example: --zip-location=/system/app/Calculator.apk"); 115 UsageError(""); 116 UsageError(" --oat-file=<file.oat>: specifies the oat output destination via a filename."); 117 UsageError(" Example: --oat-file=/system/framework/boot.oat"); 118 UsageError(""); 119 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor."); 120 UsageError(" Example: --oat-fd=6"); 121 UsageError(""); 122 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding"); 123 UsageError(" to the file descriptor specified by --oat-fd."); 124 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat"); 125 UsageError(""); 126 UsageError(" --oat-symbols=<file.oat>: specifies the oat output destination with full symbols."); 127 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat"); 128 UsageError(""); 129 UsageError(" --bitcode=<file.bc>: specifies the optional bitcode filename."); 130 UsageError(" Example: --bitcode=/system/framework/boot.bc"); 131 UsageError(""); 132 UsageError(" --image=<file.art>: specifies the output image filename."); 133 UsageError(" Example: --image=/system/framework/boot.art"); 134 UsageError(""); 135 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image."); 136 UsageError(" Example: --image=frameworks/base/preloaded-classes"); 137 UsageError(""); 138 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image."); 139 UsageError(" Example: --base=0x50000000"); 140 UsageError(""); 141 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path."); 142 UsageError(" Example: --boot-image=/system/framework/boot.art"); 143 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art"); 144 UsageError(""); 145 UsageError(" --android-root=<path>: used to locate libraries for portable linking."); 146 UsageError(" Example: --android-root=out/host/linux-x86"); 147 UsageError(" Default: $ANDROID_ROOT"); 148 UsageError(""); 149 UsageError(" --instruction-set=(arm|arm64|mips|x86|x86_64): compile for a particular"); 150 UsageError(" instruction set."); 151 UsageError(" Example: --instruction-set=x86"); 152 UsageError(" Default: arm"); 153 UsageError(""); 154 UsageError(" --instruction-set-features=...,: Specify instruction set features"); 155 UsageError(" Example: --instruction-set-features=div"); 156 UsageError(" Default: default"); 157 UsageError(""); 158 UsageError(" --compiler-backend=(Quick|Optimizing|Portable): select compiler backend"); 159 UsageError(" set."); 160 UsageError(" Example: --compiler-backend=Portable"); 161 UsageError(" Default: Quick"); 162 UsageError(""); 163 UsageError(" --compiler-filter=(verify-none|interpret-only|space|balanced|speed|everything):"); 164 UsageError(" select compiler filter."); 165 UsageError(" Example: --compiler-filter=everything"); 166#if ART_SMALL_MODE 167 UsageError(" Default: interpret-only"); 168#else 169 UsageError(" Default: speed"); 170#endif 171 UsageError(""); 172 UsageError(" --huge-method-max=<method-instruction-count>: the threshold size for a huge"); 173 UsageError(" method for compiler filter tuning."); 174 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold); 175 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold); 176 UsageError(""); 177 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge"); 178 UsageError(" method for compiler filter tuning."); 179 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold); 180 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold); 181 UsageError(""); 182 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large"); 183 UsageError(" method for compiler filter tuning."); 184 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold); 185 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold); 186 UsageError(""); 187 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small"); 188 UsageError(" method for compiler filter tuning."); 189 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold); 190 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold); 191 UsageError(""); 192 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny"); 193 UsageError(" method for compiler filter tuning."); 194 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold); 195 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold); 196 UsageError(""); 197 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for"); 198 UsageError(" compiler filter tuning. If the input has fewer than this many methods"); 199 UsageError(" and the filter is not interpret-only or verify-none, overrides the"); 200 UsageError(" filter to use speed"); 201 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold); 202 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold); 203 UsageError(""); 204 UsageError(" --host: used with Portable backend to link against host runtime libraries"); 205 UsageError(""); 206 UsageError(" --dump-timing: display a breakdown of where time was spent"); 207 UsageError(""); 208 UsageError(" --include-patch-information: Include patching information so the generated code"); 209 UsageError(" can have its base address moved without full recompilation."); 210 UsageError(""); 211 UsageError(" --no-include-patch-information: Do not include patching information."); 212 UsageError(""); 213 UsageError(" --include-debug-symbols: Include ELF symbols in this oat file"); 214 UsageError(""); 215 UsageError(" --no-include-debug-symbols: Do not include ELF symbols in this oat file"); 216 UsageError(""); 217 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,"); 218 UsageError(" such as initial heap size, maximum heap size, and verbose output."); 219 UsageError(" Use a separate --runtime-arg switch for each argument."); 220 UsageError(" Example: --runtime-arg -Xms256m"); 221 UsageError(""); 222 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation."); 223 UsageError(""); 224 UsageError(" --print-pass-names: print a list of pass names"); 225 UsageError(""); 226 UsageError(" --disable-passes=<pass-names>: disable one or more passes separated by comma."); 227 UsageError(" Example: --disable-passes=UseCount,BBOptimizations"); 228 UsageError(""); 229 std::cerr << "See log for usage error information\n"; 230 exit(EXIT_FAILURE); 231} 232 233class Dex2Oat { 234 public: 235 static bool Create(Dex2Oat** p_dex2oat, 236 const RuntimeOptions& runtime_options, 237 const CompilerOptions& compiler_options, 238 Compiler::Kind compiler_kind, 239 InstructionSet instruction_set, 240 InstructionSetFeatures instruction_set_features, 241 VerificationResults* verification_results, 242 DexFileToMethodInlinerMap* method_inliner_map, 243 size_t thread_count) 244 SHARED_TRYLOCK_FUNCTION(true, Locks::mutator_lock_) { 245 CHECK(verification_results != nullptr); 246 CHECK(method_inliner_map != nullptr); 247 std::unique_ptr<Dex2Oat> dex2oat(new Dex2Oat(&compiler_options, 248 compiler_kind, 249 instruction_set, 250 instruction_set_features, 251 verification_results, 252 method_inliner_map, 253 thread_count)); 254 if (!dex2oat->CreateRuntime(runtime_options, instruction_set)) { 255 *p_dex2oat = nullptr; 256 return false; 257 } 258 *p_dex2oat = dex2oat.release(); 259 return true; 260 } 261 262 ~Dex2Oat() { 263 delete runtime_; 264 LogCompletionTime(); 265 } 266 267 void LogCompletionTime() { 268 LOG(INFO) << "dex2oat took " << PrettyDuration(NanoTime() - start_ns_) 269 << " (threads: " << thread_count_ << ")"; 270 } 271 272 273 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;) 274 std::set<std::string>* ReadImageClassesFromFile(const char* image_classes_filename) { 275 std::unique_ptr<std::ifstream> image_classes_file(new std::ifstream(image_classes_filename, 276 std::ifstream::in)); 277 if (image_classes_file.get() == nullptr) { 278 LOG(ERROR) << "Failed to open image classes file " << image_classes_filename; 279 return nullptr; 280 } 281 std::unique_ptr<std::set<std::string>> result(ReadImageClasses(*image_classes_file)); 282 image_classes_file->close(); 283 return result.release(); 284 } 285 286 std::set<std::string>* ReadImageClasses(std::istream& image_classes_stream) { 287 std::unique_ptr<std::set<std::string>> image_classes(new std::set<std::string>); 288 while (image_classes_stream.good()) { 289 std::string dot; 290 std::getline(image_classes_stream, dot); 291 if (StartsWith(dot, "#") || dot.empty()) { 292 continue; 293 } 294 std::string descriptor(DotToDescriptor(dot.c_str())); 295 image_classes->insert(descriptor); 296 } 297 return image_classes.release(); 298 } 299 300 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;) 301 std::set<std::string>* ReadImageClassesFromZip(const char* zip_filename, 302 const char* image_classes_filename, 303 std::string* error_msg) { 304 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg)); 305 if (zip_archive.get() == nullptr) { 306 return nullptr; 307 } 308 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(image_classes_filename, error_msg)); 309 if (zip_entry.get() == nullptr) { 310 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", image_classes_filename, 311 zip_filename, error_msg->c_str()); 312 return nullptr; 313 } 314 std::unique_ptr<MemMap> image_classes_file(zip_entry->ExtractToMemMap(zip_filename, 315 image_classes_filename, 316 error_msg)); 317 if (image_classes_file.get() == nullptr) { 318 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", image_classes_filename, 319 zip_filename, error_msg->c_str()); 320 return nullptr; 321 } 322 const std::string image_classes_string(reinterpret_cast<char*>(image_classes_file->Begin()), 323 image_classes_file->Size()); 324 std::istringstream image_classes_stream(image_classes_string); 325 return ReadImageClasses(image_classes_stream); 326 } 327 328 bool PatchOatCode(const CompilerDriver* compiler_driver, File* oat_file, 329 const std::string& oat_location, std::string* error_msg) { 330 // We asked to include patch information but we are not making an image. We need to fix 331 // everything up manually. 332 std::unique_ptr<ElfFile> elf_file(ElfFile::Open(oat_file, PROT_READ|PROT_WRITE, 333 MAP_SHARED, error_msg)); 334 if (elf_file.get() == NULL) { 335 LOG(ERROR) << error_msg; 336 return false; 337 } 338 { 339 ReaderMutexLock mu(Thread::Current(), *Locks::mutator_lock_); 340 return ElfPatcher::Patch(compiler_driver, elf_file.get(), oat_location, error_msg); 341 } 342 } 343 344 const CompilerDriver* CreateOatFile(const std::string& boot_image_option, 345 const std::string& android_root, 346 bool is_host, 347 const std::vector<const DexFile*>& dex_files, 348 File* oat_file, 349 const std::string& oat_location, 350 const std::string& bitcode_filename, 351 bool image, 352 std::unique_ptr<std::set<std::string>>& image_classes, 353 bool dump_stats, 354 bool dump_passes, 355 TimingLogger& timings, 356 CumulativeLogger& compiler_phases_timings, 357 std::string profile_file, 358 SafeMap<std::string, std::string>* key_value_store) { 359 CHECK(key_value_store != nullptr); 360 361 // Handle and ClassLoader creation needs to come after Runtime::Create 362 jobject class_loader = nullptr; 363 Thread* self = Thread::Current(); 364 if (!boot_image_option.empty()) { 365 ClassLinker* class_linker = Runtime::Current()->GetClassLinker(); 366 std::vector<const DexFile*> class_path_files(dex_files); 367 OpenClassPathFiles(runtime_->GetClassPathString(), class_path_files); 368 ScopedObjectAccess soa(self); 369 for (size_t i = 0; i < class_path_files.size(); i++) { 370 class_linker->RegisterDexFile(*class_path_files[i]); 371 } 372 soa.Env()->AllocObject(WellKnownClasses::dalvik_system_PathClassLoader); 373 ScopedLocalRef<jobject> class_loader_local(soa.Env(), 374 soa.Env()->AllocObject(WellKnownClasses::dalvik_system_PathClassLoader)); 375 class_loader = soa.Env()->NewGlobalRef(class_loader_local.get()); 376 Runtime::Current()->SetCompileTimeClassPath(class_loader, class_path_files); 377 } 378 379 std::unique_ptr<CompilerDriver> driver(new CompilerDriver(compiler_options_, 380 verification_results_, 381 method_inliner_map_, 382 compiler_kind_, 383 instruction_set_, 384 instruction_set_features_, 385 image, 386 image_classes.release(), 387 thread_count_, 388 dump_stats, 389 dump_passes, 390 &compiler_phases_timings, 391 profile_file)); 392 393 driver->GetCompiler()->SetBitcodeFileName(*driver.get(), bitcode_filename); 394 395 driver->CompileAll(class_loader, dex_files, &timings); 396 397 TimingLogger::ScopedTiming t2("dex2oat OatWriter", &timings); 398 std::string image_file_location; 399 uint32_t image_file_location_oat_checksum = 0; 400 uintptr_t image_file_location_oat_data_begin = 0; 401 int32_t image_patch_delta = 0; 402 if (!driver->IsImage()) { 403 TimingLogger::ScopedTiming t3("Loading image checksum", &timings); 404 gc::space::ImageSpace* image_space = Runtime::Current()->GetHeap()->GetImageSpace(); 405 image_file_location_oat_checksum = image_space->GetImageHeader().GetOatChecksum(); 406 image_file_location_oat_data_begin = 407 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatDataBegin()); 408 image_file_location = image_space->GetImageFilename(); 409 image_patch_delta = image_space->GetImageHeader().GetPatchDelta(); 410 } 411 412 if (!image_file_location.empty()) { 413 key_value_store->Put(OatHeader::kImageLocationKey, image_file_location); 414 } 415 416 OatWriter oat_writer(dex_files, image_file_location_oat_checksum, 417 image_file_location_oat_data_begin, 418 image_patch_delta, 419 driver.get(), 420 &timings, 421 key_value_store); 422 423 t2.NewTiming("Writing ELF"); 424 if (!driver->WriteElf(android_root, is_host, dex_files, &oat_writer, oat_file)) { 425 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath(); 426 return nullptr; 427 } 428 429 // Flush result to disk. Patching code will re-open the file (mmap), so ensure that our view 430 // of the file already made it there and won't be re-ordered with writes from PatchOat or 431 // image patching. 432 oat_file->Flush(); 433 434 if (!driver->IsImage() && driver->GetCompilerOptions().GetIncludePatchInformation()) { 435 t2.NewTiming("Patching ELF"); 436 std::string error_msg; 437 if (!PatchOatCode(driver.get(), oat_file, oat_location, &error_msg)) { 438 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath() << ": " << error_msg; 439 return nullptr; 440 } 441 } 442 443 return driver.release(); 444 } 445 446 bool CreateImageFile(const std::string& image_filename, 447 uintptr_t image_base, 448 const std::string& oat_filename, 449 const std::string& oat_location, 450 const CompilerDriver& compiler) 451 LOCKS_EXCLUDED(Locks::mutator_lock_) { 452 uintptr_t oat_data_begin; 453 { 454 // ImageWriter is scoped so it can free memory before doing FixupElf 455 ImageWriter image_writer(compiler); 456 if (!image_writer.Write(image_filename, image_base, oat_filename, oat_location)) { 457 LOG(ERROR) << "Failed to create image file " << image_filename; 458 return false; 459 } 460 oat_data_begin = image_writer.GetOatDataBegin(); 461 } 462 463 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename.c_str())); 464 if (oat_file.get() == nullptr) { 465 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename; 466 return false; 467 } 468 if (!ElfFixup::Fixup(oat_file.get(), oat_data_begin)) { 469 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath(); 470 return false; 471 } 472 return true; 473 } 474 475 private: 476 explicit Dex2Oat(const CompilerOptions* compiler_options, 477 Compiler::Kind compiler_kind, 478 InstructionSet instruction_set, 479 InstructionSetFeatures instruction_set_features, 480 VerificationResults* verification_results, 481 DexFileToMethodInlinerMap* method_inliner_map, 482 size_t thread_count) 483 : compiler_options_(compiler_options), 484 compiler_kind_(compiler_kind), 485 instruction_set_(instruction_set), 486 instruction_set_features_(instruction_set_features), 487 verification_results_(verification_results), 488 method_inliner_map_(method_inliner_map), 489 runtime_(nullptr), 490 thread_count_(thread_count), 491 start_ns_(NanoTime()) { 492 CHECK(compiler_options != nullptr); 493 CHECK(verification_results != nullptr); 494 CHECK(method_inliner_map != nullptr); 495 } 496 497 bool CreateRuntime(const RuntimeOptions& runtime_options, InstructionSet instruction_set) 498 SHARED_TRYLOCK_FUNCTION(true, Locks::mutator_lock_) { 499 if (!Runtime::Create(runtime_options, false)) { 500 LOG(ERROR) << "Failed to create runtime"; 501 return false; 502 } 503 Runtime* runtime = Runtime::Current(); 504 runtime->SetInstructionSet(instruction_set); 505 for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) { 506 Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i); 507 if (!runtime->HasCalleeSaveMethod(type)) { 508 runtime->SetCalleeSaveMethod(runtime->CreateCalleeSaveMethod(type), type); 509 } 510 } 511 runtime->GetClassLinker()->FixupDexCaches(runtime->GetResolutionMethod()); 512 runtime->GetClassLinker()->RunRootClinits(); 513 runtime_ = runtime; 514 return true; 515 } 516 517 // Appends to dex_files any elements of class_path that it doesn't already 518 // contain. This will open those dex files as necessary. 519 static void OpenClassPathFiles(const std::string& class_path, 520 std::vector<const DexFile*>& dex_files) { 521 std::vector<std::string> parsed; 522 Split(class_path, ':', parsed); 523 // Take Locks::mutator_lock_ so that lock ordering on the ClassLinker::dex_lock_ is maintained. 524 ScopedObjectAccess soa(Thread::Current()); 525 for (size_t i = 0; i < parsed.size(); ++i) { 526 if (DexFilesContains(dex_files, parsed[i])) { 527 continue; 528 } 529 std::string error_msg; 530 if (!DexFile::Open(parsed[i].c_str(), parsed[i].c_str(), &error_msg, &dex_files)) { 531 LOG(WARNING) << "Failed to open dex file '" << parsed[i] << "': " << error_msg; 532 } 533 } 534 } 535 536 // Returns true if dex_files has a dex with the named location. 537 static bool DexFilesContains(const std::vector<const DexFile*>& dex_files, 538 const std::string& location) { 539 for (size_t i = 0; i < dex_files.size(); ++i) { 540 if (dex_files[i]->GetLocation() == location) { 541 return true; 542 } 543 } 544 return false; 545 } 546 547 const CompilerOptions* const compiler_options_; 548 const Compiler::Kind compiler_kind_; 549 550 const InstructionSet instruction_set_; 551 const InstructionSetFeatures instruction_set_features_; 552 553 VerificationResults* const verification_results_; 554 DexFileToMethodInlinerMap* const method_inliner_map_; 555 Runtime* runtime_; 556 size_t thread_count_; 557 uint64_t start_ns_; 558 559 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat); 560}; 561 562static size_t OpenDexFiles(const std::vector<const char*>& dex_filenames, 563 const std::vector<const char*>& dex_locations, 564 std::vector<const DexFile*>& dex_files) { 565 size_t failure_count = 0; 566 for (size_t i = 0; i < dex_filenames.size(); i++) { 567 const char* dex_filename = dex_filenames[i]; 568 const char* dex_location = dex_locations[i]; 569 ATRACE_BEGIN(StringPrintf("Opening dex file '%s'", dex_filenames[i]).c_str()); 570 std::string error_msg; 571 if (!OS::FileExists(dex_filename)) { 572 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filename << "'"; 573 continue; 574 } 575 if (!DexFile::Open(dex_filename, dex_location, &error_msg, &dex_files)) { 576 LOG(WARNING) << "Failed to open .dex from file '" << dex_filename << "': " << error_msg; 577 ++failure_count; 578 } 579 ATRACE_END(); 580 } 581 return failure_count; 582} 583 584// The primary goal of the watchdog is to prevent stuck build servers 585// during development when fatal aborts lead to a cascade of failures 586// that result in a deadlock. 587class WatchDog { 588// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using Log which uses locks 589#undef CHECK_PTHREAD_CALL 590#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \ 591 do { \ 592 int rc = call args; \ 593 if (rc != 0) { \ 594 errno = rc; \ 595 std::string message(# call); \ 596 message += " failed for "; \ 597 message += reason; \ 598 Fatal(message); \ 599 } \ 600 } while (false) 601 602 public: 603 explicit WatchDog(bool is_watch_dog_enabled) { 604 is_watch_dog_enabled_ = is_watch_dog_enabled; 605 if (!is_watch_dog_enabled_) { 606 return; 607 } 608 shutting_down_ = false; 609 const char* reason = "dex2oat watch dog thread startup"; 610 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason); 611 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, nullptr), reason); 612 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason); 613 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason); 614 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason); 615 } 616 ~WatchDog() { 617 if (!is_watch_dog_enabled_) { 618 return; 619 } 620 const char* reason = "dex2oat watch dog thread shutdown"; 621 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason); 622 shutting_down_ = true; 623 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason); 624 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason); 625 626 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason); 627 628 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason); 629 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason); 630 } 631 632 private: 633 static void* CallBack(void* arg) { 634 WatchDog* self = reinterpret_cast<WatchDog*>(arg); 635 ::art::SetThreadName("dex2oat watch dog"); 636 self->Wait(); 637 return nullptr; 638 } 639 640 static void Message(char severity, const std::string& message) { 641 // TODO: Remove when we switch to LOG when we can guarantee it won't prevent shutdown in error 642 // cases. 643 fprintf(stderr, "dex2oat%s %c %d %d %s\n", 644 kIsDebugBuild ? "d" : "", 645 severity, 646 getpid(), 647 GetTid(), 648 message.c_str()); 649 } 650 651 static void Warn(const std::string& message) { 652 Message('W', message); 653 } 654 655 static void Fatal(const std::string& message) { 656 Message('F', message); 657 exit(1); 658 } 659 660 void Wait() { 661 bool warning = true; 662 CHECK_GT(kWatchDogTimeoutSeconds, kWatchDogWarningSeconds); 663 // TODO: tune the multiplier for GC verification, the following is just to make the timeout 664 // large. 665 int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1; 666 timespec warning_ts; 667 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogWarningSeconds * 1000, 0, &warning_ts); 668 timespec timeout_ts; 669 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts); 670 const char* reason = "dex2oat watch dog thread waiting"; 671 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason); 672 while (!shutting_down_) { 673 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, 674 warning ? &warning_ts 675 : &timeout_ts)); 676 if (rc == ETIMEDOUT) { 677 std::string message(StringPrintf("dex2oat did not finish after %d seconds", 678 warning ? kWatchDogWarningSeconds 679 : kWatchDogTimeoutSeconds)); 680 if (warning) { 681 Warn(message.c_str()); 682 warning = false; 683 } else { 684 Fatal(message.c_str()); 685 } 686 } else if (rc != 0) { 687 std::string message(StringPrintf("pthread_cond_timedwait failed: %s", 688 strerror(errno))); 689 Fatal(message.c_str()); 690 } 691 } 692 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason); 693 } 694 695 // When setting timeouts, keep in mind that the build server may not be as fast as your desktop. 696 // Debug builds are slower so they have larger timeouts. 697 static const unsigned int kSlowdownFactor = kIsDebugBuild ? 5U : 1U; 698#if ART_USE_PORTABLE_COMPILER 699 // 2 minutes scaled by kSlowdownFactor. 700 static const unsigned int kWatchDogWarningSeconds = kSlowdownFactor * 2 * 60; 701 // 30 minutes scaled by kSlowdownFactor. 702 static const unsigned int kWatchDogTimeoutSeconds = kSlowdownFactor * 30 * 60; 703#else 704 // 1 minutes scaled by kSlowdownFactor. 705 static const unsigned int kWatchDogWarningSeconds = kSlowdownFactor * 1 * 60; 706 // 6 minutes scaled by kSlowdownFactor. 707 static const unsigned int kWatchDogTimeoutSeconds = kSlowdownFactor * 6 * 60; 708#endif 709 710 bool is_watch_dog_enabled_; 711 bool shutting_down_; 712 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases. 713 pthread_mutex_t mutex_; 714 pthread_cond_t cond_; 715 pthread_attr_t attr_; 716 pthread_t pthread_; 717}; 718const unsigned int WatchDog::kWatchDogWarningSeconds; 719const unsigned int WatchDog::kWatchDogTimeoutSeconds; 720 721// Given a set of instruction features from the build, parse it. The 722// input 'str' is a comma separated list of feature names. Parse it and 723// return the InstructionSetFeatures object. 724static InstructionSetFeatures ParseFeatureList(std::string str) { 725 InstructionSetFeatures result; 726 typedef std::vector<std::string> FeatureList; 727 FeatureList features; 728 Split(str, ',', features); 729 for (FeatureList::iterator i = features.begin(); i != features.end(); i++) { 730 std::string feature = Trim(*i); 731 if (feature == "default") { 732 // Nothing to do. 733 } else if (feature == "div") { 734 // Supports divide instruction. 735 result.SetHasDivideInstruction(true); 736 } else if (feature == "nodiv") { 737 // Turn off support for divide instruction. 738 result.SetHasDivideInstruction(false); 739 } else if (feature == "lpae") { 740 // Supports Large Physical Address Extension. 741 result.SetHasLpae(true); 742 } else if (feature == "nolpae") { 743 // Turn off support for Large Physical Address Extension. 744 result.SetHasLpae(false); 745 } else { 746 Usage("Unknown instruction set feature: '%s'", feature.c_str()); 747 } 748 } 749 // others... 750 return result; 751} 752 753void ParseStringAfterChar(const std::string& s, char c, std::string* parsed_value) { 754 std::string::size_type colon = s.find(c); 755 if (colon == std::string::npos) { 756 Usage("Missing char %c in option %s\n", c, s.c_str()); 757 } 758 // Add one to remove the char we were trimming until. 759 *parsed_value = s.substr(colon + 1); 760} 761 762void ParseDouble(const std::string& option, char after_char, 763 double min, double max, double* parsed_value) { 764 std::string substring; 765 ParseStringAfterChar(option, after_char, &substring); 766 bool sane_val = true; 767 double value; 768 if (false) { 769 // TODO: this doesn't seem to work on the emulator. b/15114595 770 std::stringstream iss(substring); 771 iss >> value; 772 // Ensure that we have a value, there was no cruft after it and it satisfies a sensible range. 773 sane_val = iss.eof() && (value >= min) && (value <= max); 774 } else { 775 char* end = nullptr; 776 value = strtod(substring.c_str(), &end); 777 sane_val = *end == '\0' && value >= min && value <= max; 778 } 779 if (!sane_val) { 780 Usage("Invalid double value %s for option %s\n", substring.c_str(), option.c_str()); 781 } 782 *parsed_value = value; 783} 784 785static void b13564922() { 786#if defined(__linux__) && defined(__arm__) 787 int major, minor; 788 struct utsname uts; 789 if (uname(&uts) != -1 && 790 sscanf(uts.release, "%d.%d", &major, &minor) == 2 && 791 ((major < 3) || ((major == 3) && (minor < 4)))) { 792 // Kernels before 3.4 don't handle the ASLR well and we can run out of address 793 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization. 794 int old_personality = personality(0xffffffff); 795 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) { 796 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE); 797 if (new_personality == -1) { 798 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed."; 799 } 800 } 801 } 802#endif 803} 804 805static int dex2oat(int argc, char** argv) { 806 b13564922(); 807 808 original_argc = argc; 809 original_argv = argv; 810 811 TimingLogger timings("compiler", false, false); 812 CumulativeLogger compiler_phases_timings("compilation times"); 813 814 InitLogging(argv); 815 816 // Skip over argv[0]. 817 argv++; 818 argc--; 819 820 if (argc == 0) { 821 Usage("No arguments specified"); 822 } 823 824 std::vector<const char*> dex_filenames; 825 std::vector<const char*> dex_locations; 826 int zip_fd = -1; 827 std::string zip_location; 828 std::string oat_filename; 829 std::string oat_symbols; 830 std::string oat_location; 831 int oat_fd = -1; 832 std::string bitcode_filename; 833 const char* image_classes_zip_filename = nullptr; 834 const char* image_classes_filename = nullptr; 835 std::string image_filename; 836 std::string boot_image_filename; 837 uintptr_t image_base = 0; 838 std::string android_root; 839 std::vector<const char*> runtime_args; 840 int thread_count = sysconf(_SC_NPROCESSORS_CONF); 841 Compiler::Kind compiler_kind = kUsePortableCompiler 842 ? Compiler::kPortable 843 : Compiler::kQuick; 844 const char* compiler_filter_string = nullptr; 845 bool compile_pic = false; 846 int huge_method_threshold = CompilerOptions::kDefaultHugeMethodThreshold; 847 int large_method_threshold = CompilerOptions::kDefaultLargeMethodThreshold; 848 int small_method_threshold = CompilerOptions::kDefaultSmallMethodThreshold; 849 int tiny_method_threshold = CompilerOptions::kDefaultTinyMethodThreshold; 850 int num_dex_methods_threshold = CompilerOptions::kDefaultNumDexMethodsThreshold; 851 852 // Take the default set of instruction features from the build. 853 InstructionSetFeatures instruction_set_features = 854 ParseFeatureList(Runtime::GetDefaultInstructionSetFeatures()); 855 856 InstructionSet instruction_set = kRuntimeISA; 857 858 // Profile file to use 859 std::string profile_file; 860 double top_k_profile_threshold = CompilerOptions::kDefaultTopKProfileThreshold; 861 862 bool is_host = false; 863 bool dump_stats = false; 864 bool dump_timing = false; 865 bool dump_passes = false; 866 bool include_patch_information = CompilerOptions::kDefaultIncludePatchInformation; 867 bool include_debug_symbols = kIsDebugBuild; 868 bool dump_slow_timing = kIsDebugBuild; 869 bool watch_dog_enabled = true; 870 bool generate_gdb_information = kIsDebugBuild; 871 872 // Checks are all explicit until we know the architecture. 873 bool implicit_null_checks = false; 874 bool implicit_so_checks = false; 875 bool implicit_suspend_checks = false; 876 877 for (int i = 0; i < argc; i++) { 878 const StringPiece option(argv[i]); 879 const bool log_options = false; 880 if (log_options) { 881 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i]; 882 } 883 if (option.starts_with("--dex-file=")) { 884 dex_filenames.push_back(option.substr(strlen("--dex-file=")).data()); 885 } else if (option.starts_with("--dex-location=")) { 886 dex_locations.push_back(option.substr(strlen("--dex-location=")).data()); 887 } else if (option.starts_with("--zip-fd=")) { 888 const char* zip_fd_str = option.substr(strlen("--zip-fd=")).data(); 889 if (!ParseInt(zip_fd_str, &zip_fd)) { 890 Usage("Failed to parse --zip-fd argument '%s' as an integer", zip_fd_str); 891 } 892 if (zip_fd < 0) { 893 Usage("--zip-fd passed a negative value %d", zip_fd); 894 } 895 } else if (option.starts_with("--zip-location=")) { 896 zip_location = option.substr(strlen("--zip-location=")).data(); 897 } else if (option.starts_with("--oat-file=")) { 898 oat_filename = option.substr(strlen("--oat-file=")).data(); 899 } else if (option.starts_with("--oat-symbols=")) { 900 oat_symbols = option.substr(strlen("--oat-symbols=")).data(); 901 } else if (option.starts_with("--oat-fd=")) { 902 const char* oat_fd_str = option.substr(strlen("--oat-fd=")).data(); 903 if (!ParseInt(oat_fd_str, &oat_fd)) { 904 Usage("Failed to parse --oat-fd argument '%s' as an integer", oat_fd_str); 905 } 906 if (oat_fd < 0) { 907 Usage("--oat-fd passed a negative value %d", oat_fd); 908 } 909 } else if (option == "--watch-dog") { 910 watch_dog_enabled = true; 911 } else if (option == "--no-watch-dog") { 912 watch_dog_enabled = false; 913 } else if (option == "--gen-gdb-info") { 914 generate_gdb_information = true; 915 // Debug symbols are needed for gdb information. 916 include_debug_symbols = true; 917 } else if (option == "--no-gen-gdb-info") { 918 generate_gdb_information = false; 919 } else if (option.starts_with("-j")) { 920 const char* thread_count_str = option.substr(strlen("-j")).data(); 921 if (!ParseInt(thread_count_str, &thread_count)) { 922 Usage("Failed to parse -j argument '%s' as an integer", thread_count_str); 923 } 924 } else if (option.starts_with("--oat-location=")) { 925 oat_location = option.substr(strlen("--oat-location=")).data(); 926 } else if (option.starts_with("--bitcode=")) { 927 bitcode_filename = option.substr(strlen("--bitcode=")).data(); 928 } else if (option.starts_with("--image=")) { 929 image_filename = option.substr(strlen("--image=")).data(); 930 } else if (option.starts_with("--image-classes=")) { 931 image_classes_filename = option.substr(strlen("--image-classes=")).data(); 932 } else if (option.starts_with("--image-classes-zip=")) { 933 image_classes_zip_filename = option.substr(strlen("--image-classes-zip=")).data(); 934 } else if (option.starts_with("--base=")) { 935 const char* image_base_str = option.substr(strlen("--base=")).data(); 936 char* end; 937 image_base = strtoul(image_base_str, &end, 16); 938 if (end == image_base_str || *end != '\0') { 939 Usage("Failed to parse hexadecimal value for option %s", option.data()); 940 } 941 } else if (option.starts_with("--boot-image=")) { 942 boot_image_filename = option.substr(strlen("--boot-image=")).data(); 943 } else if (option.starts_with("--android-root=")) { 944 android_root = option.substr(strlen("--android-root=")).data(); 945 } else if (option.starts_with("--instruction-set=")) { 946 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data(); 947 if (instruction_set_str == "arm") { 948 instruction_set = kThumb2; 949 } else if (instruction_set_str == "arm64") { 950 instruction_set = kArm64; 951 } else if (instruction_set_str == "mips") { 952 instruction_set = kMips; 953 } else if (instruction_set_str == "x86") { 954 instruction_set = kX86; 955 } else if (instruction_set_str == "x86_64") { 956 instruction_set = kX86_64; 957 } 958 } else if (option.starts_with("--instruction-set-features=")) { 959 StringPiece str = option.substr(strlen("--instruction-set-features=")).data(); 960 instruction_set_features = ParseFeatureList(str.as_string()); 961 } else if (option.starts_with("--compiler-backend=")) { 962 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data(); 963 if (backend_str == "Quick") { 964 compiler_kind = Compiler::kQuick; 965 } else if (backend_str == "Optimizing") { 966 compiler_kind = Compiler::kOptimizing; 967 } else if (backend_str == "Portable") { 968 compiler_kind = Compiler::kPortable; 969 } 970 } else if (option.starts_with("--compiler-filter=")) { 971 compiler_filter_string = option.substr(strlen("--compiler-filter=")).data(); 972 } else if (option == "--compile-pic") { 973 compile_pic = true; 974 } else if (option.starts_with("--huge-method-max=")) { 975 const char* threshold = option.substr(strlen("--huge-method-max=")).data(); 976 if (!ParseInt(threshold, &huge_method_threshold)) { 977 Usage("Failed to parse --huge-method-max '%s' as an integer", threshold); 978 } 979 if (huge_method_threshold < 0) { 980 Usage("--huge-method-max passed a negative value %s", huge_method_threshold); 981 } 982 } else if (option.starts_with("--large-method-max=")) { 983 const char* threshold = option.substr(strlen("--large-method-max=")).data(); 984 if (!ParseInt(threshold, &large_method_threshold)) { 985 Usage("Failed to parse --large-method-max '%s' as an integer", threshold); 986 } 987 if (large_method_threshold < 0) { 988 Usage("--large-method-max passed a negative value %s", large_method_threshold); 989 } 990 } else if (option.starts_with("--small-method-max=")) { 991 const char* threshold = option.substr(strlen("--small-method-max=")).data(); 992 if (!ParseInt(threshold, &small_method_threshold)) { 993 Usage("Failed to parse --small-method-max '%s' as an integer", threshold); 994 } 995 if (small_method_threshold < 0) { 996 Usage("--small-method-max passed a negative value %s", small_method_threshold); 997 } 998 } else if (option.starts_with("--tiny-method-max=")) { 999 const char* threshold = option.substr(strlen("--tiny-method-max=")).data(); 1000 if (!ParseInt(threshold, &tiny_method_threshold)) { 1001 Usage("Failed to parse --tiny-method-max '%s' as an integer", threshold); 1002 } 1003 if (tiny_method_threshold < 0) { 1004 Usage("--tiny-method-max passed a negative value %s", tiny_method_threshold); 1005 } 1006 } else if (option.starts_with("--num-dex-methods=")) { 1007 const char* threshold = option.substr(strlen("--num-dex-methods=")).data(); 1008 if (!ParseInt(threshold, &num_dex_methods_threshold)) { 1009 Usage("Failed to parse --num-dex-methods '%s' as an integer", threshold); 1010 } 1011 if (num_dex_methods_threshold < 0) { 1012 Usage("--num-dex-methods passed a negative value %s", num_dex_methods_threshold); 1013 } 1014 } else if (option == "--host") { 1015 is_host = true; 1016 } else if (option == "--runtime-arg") { 1017 if (++i >= argc) { 1018 Usage("Missing required argument for --runtime-arg"); 1019 } 1020 if (log_options) { 1021 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i]; 1022 } 1023 runtime_args.push_back(argv[i]); 1024 } else if (option == "--dump-timing") { 1025 dump_timing = true; 1026 } else if (option == "--dump-passes") { 1027 dump_passes = true; 1028 } else if (option == "--dump-stats") { 1029 dump_stats = true; 1030 } else if (option == "--include-debug-symbols" || option == "--no-strip-symbols") { 1031 include_debug_symbols = true; 1032 } else if (option == "--no-include-debug-symbols" || option == "--strip-symbols") { 1033 include_debug_symbols = false; 1034 generate_gdb_information = false; // Depends on debug symbols, see above. 1035 } else if (option.starts_with("--profile-file=")) { 1036 profile_file = option.substr(strlen("--profile-file=")).data(); 1037 VLOG(compiler) << "dex2oat: profile file is " << profile_file; 1038 } else if (option == "--no-profile-file") { 1039 // No profile 1040 } else if (option.starts_with("--top-k-profile-threshold=")) { 1041 ParseDouble(option.data(), '=', 0.0, 100.0, &top_k_profile_threshold); 1042 } else if (option == "--print-pass-names") { 1043 PassDriverMEOpts::PrintPassNames(); 1044 } else if (option.starts_with("--disable-passes=")) { 1045 std::string disable_passes = option.substr(strlen("--disable-passes=")).data(); 1046 PassDriverMEOpts::CreateDefaultPassList(disable_passes); 1047 } else if (option.starts_with("--print-passes=")) { 1048 std::string print_passes = option.substr(strlen("--print-passes=")).data(); 1049 PassDriverMEOpts::SetPrintPassList(print_passes); 1050 } else if (option == "--print-all-passes") { 1051 PassDriverMEOpts::SetPrintAllPasses(); 1052 } else if (option.starts_with("--dump-cfg-passes=")) { 1053 std::string dump_passes = option.substr(strlen("--dump-cfg-passes=")).data(); 1054 PassDriverMEOpts::SetDumpPassList(dump_passes); 1055 } else if (option == "--include-patch-information") { 1056 include_patch_information = true; 1057 } else if (option == "--no-include-patch-information") { 1058 include_patch_information = false; 1059 } else { 1060 Usage("Unknown argument %s", option.data()); 1061 } 1062 } 1063 1064 if (oat_filename.empty() && oat_fd == -1) { 1065 Usage("Output must be supplied with either --oat-file or --oat-fd"); 1066 } 1067 1068 if (!oat_filename.empty() && oat_fd != -1) { 1069 Usage("--oat-file should not be used with --oat-fd"); 1070 } 1071 1072 if (!oat_symbols.empty() && oat_fd != -1) { 1073 Usage("--oat-symbols should not be used with --oat-fd"); 1074 } 1075 1076 if (!oat_symbols.empty() && is_host) { 1077 Usage("--oat-symbols should not be used with --host"); 1078 } 1079 1080 if (oat_fd != -1 && !image_filename.empty()) { 1081 Usage("--oat-fd should not be used with --image"); 1082 } 1083 1084 if (android_root.empty()) { 1085 const char* android_root_env_var = getenv("ANDROID_ROOT"); 1086 if (android_root_env_var == nullptr) { 1087 Usage("--android-root unspecified and ANDROID_ROOT not set"); 1088 } 1089 android_root += android_root_env_var; 1090 } 1091 1092 bool image = (!image_filename.empty()); 1093 if (!image && boot_image_filename.empty()) { 1094 boot_image_filename += android_root; 1095 boot_image_filename += "/framework/boot.art"; 1096 } 1097 std::string boot_image_option; 1098 if (!boot_image_filename.empty()) { 1099 boot_image_option += "-Ximage:"; 1100 boot_image_option += boot_image_filename; 1101 } 1102 1103 if (image_classes_filename != nullptr && !image) { 1104 Usage("--image-classes should only be used with --image"); 1105 } 1106 1107 if (image_classes_filename != nullptr && !boot_image_option.empty()) { 1108 Usage("--image-classes should not be used with --boot-image"); 1109 } 1110 1111 if (image_classes_zip_filename != nullptr && image_classes_filename == nullptr) { 1112 Usage("--image-classes-zip should be used with --image-classes"); 1113 } 1114 1115 if (dex_filenames.empty() && zip_fd == -1) { 1116 Usage("Input must be supplied with either --dex-file or --zip-fd"); 1117 } 1118 1119 if (!dex_filenames.empty() && zip_fd != -1) { 1120 Usage("--dex-file should not be used with --zip-fd"); 1121 } 1122 1123 if (!dex_filenames.empty() && !zip_location.empty()) { 1124 Usage("--dex-file should not be used with --zip-location"); 1125 } 1126 1127 if (dex_locations.empty()) { 1128 for (size_t i = 0; i < dex_filenames.size(); i++) { 1129 dex_locations.push_back(dex_filenames[i]); 1130 } 1131 } else if (dex_locations.size() != dex_filenames.size()) { 1132 Usage("--dex-location arguments do not match --dex-file arguments"); 1133 } 1134 1135 if (zip_fd != -1 && zip_location.empty()) { 1136 Usage("--zip-location should be supplied with --zip-fd"); 1137 } 1138 1139 if (boot_image_option.empty()) { 1140 if (image_base == 0) { 1141 Usage("Non-zero --base not specified"); 1142 } 1143 } 1144 1145 std::string oat_stripped(oat_filename); 1146 std::string oat_unstripped; 1147 if (!oat_symbols.empty()) { 1148 oat_unstripped += oat_symbols; 1149 } else { 1150 oat_unstripped += oat_filename; 1151 } 1152 1153 if (compiler_filter_string == nullptr) { 1154 if (instruction_set == kMips64) { 1155 // TODO: fix compiler for Mips64. 1156 compiler_filter_string = "interpret-only"; 1157 } else if (image) { 1158 compiler_filter_string = "speed"; 1159 } else { 1160#if ART_SMALL_MODE 1161 compiler_filter_string = "interpret-only"; 1162#else 1163 compiler_filter_string = "speed"; 1164#endif 1165 } 1166 } 1167 CHECK(compiler_filter_string != nullptr); 1168 CompilerOptions::CompilerFilter compiler_filter = CompilerOptions::kDefaultCompilerFilter; 1169 if (strcmp(compiler_filter_string, "verify-none") == 0) { 1170 compiler_filter = CompilerOptions::kVerifyNone; 1171 } else if (strcmp(compiler_filter_string, "interpret-only") == 0) { 1172 compiler_filter = CompilerOptions::kInterpretOnly; 1173 } else if (strcmp(compiler_filter_string, "space") == 0) { 1174 compiler_filter = CompilerOptions::kSpace; 1175 } else if (strcmp(compiler_filter_string, "balanced") == 0) { 1176 compiler_filter = CompilerOptions::kBalanced; 1177 } else if (strcmp(compiler_filter_string, "speed") == 0) { 1178 compiler_filter = CompilerOptions::kSpeed; 1179 } else if (strcmp(compiler_filter_string, "everything") == 0) { 1180 compiler_filter = CompilerOptions::kEverything; 1181 } else { 1182 Usage("Unknown --compiler-filter value %s", compiler_filter_string); 1183 } 1184 1185 // Set the compilation target's implicit checks options. 1186 switch (instruction_set) { 1187 case kArm: 1188 case kThumb2: 1189 case kArm64: 1190 case kX86: 1191 case kX86_64: 1192 implicit_null_checks = true; 1193 implicit_so_checks = true; 1194 break; 1195 1196 default: 1197 // Defaults are correct. 1198 break; 1199 } 1200 1201 std::unique_ptr<CompilerOptions> compiler_options(new CompilerOptions(compiler_filter, 1202 huge_method_threshold, 1203 large_method_threshold, 1204 small_method_threshold, 1205 tiny_method_threshold, 1206 num_dex_methods_threshold, 1207 generate_gdb_information, 1208 include_patch_information, 1209 top_k_profile_threshold, 1210 include_debug_symbols, 1211 implicit_null_checks, 1212 implicit_so_checks, 1213 implicit_suspend_checks, 1214 compile_pic 1215#ifdef ART_SEA_IR_MODE 1216 , compiler_options.sea_ir_ = 1217 true; 1218#endif 1219 )); // NOLINT(whitespace/parens) 1220 1221 // Done with usage checks, enable watchdog if requested 1222 WatchDog watch_dog(watch_dog_enabled); 1223 1224 // Check early that the result of compilation can be written 1225 std::unique_ptr<File> oat_file; 1226 bool create_file = !oat_unstripped.empty(); // as opposed to using open file descriptor 1227 if (create_file) { 1228 oat_file.reset(OS::CreateEmptyFile(oat_unstripped.c_str())); 1229 if (oat_location.empty()) { 1230 oat_location = oat_filename; 1231 } 1232 } else { 1233 oat_file.reset(new File(oat_fd, oat_location)); 1234 oat_file->DisableAutoClose(); 1235 oat_file->SetLength(0); 1236 } 1237 if (oat_file.get() == nullptr) { 1238 PLOG(ERROR) << "Failed to create oat file: " << oat_location; 1239 return EXIT_FAILURE; 1240 } 1241 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) { 1242 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_location; 1243 return EXIT_FAILURE; 1244 } 1245 1246 timings.StartTiming("dex2oat Setup"); 1247 LOG(INFO) << CommandLine(); 1248 1249 RuntimeOptions runtime_options; 1250 std::vector<const DexFile*> boot_class_path; 1251 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap. 1252 if (boot_image_option.empty()) { 1253 size_t failure_count = OpenDexFiles(dex_filenames, dex_locations, boot_class_path); 1254 if (failure_count > 0) { 1255 LOG(ERROR) << "Failed to open some dex files: " << failure_count; 1256 return EXIT_FAILURE; 1257 } 1258 runtime_options.push_back(std::make_pair("bootclasspath", &boot_class_path)); 1259 } else { 1260 runtime_options.push_back(std::make_pair(boot_image_option.c_str(), nullptr)); 1261 } 1262 for (size_t i = 0; i < runtime_args.size(); i++) { 1263 runtime_options.push_back(std::make_pair(runtime_args[i], nullptr)); 1264 } 1265 1266 std::unique_ptr<VerificationResults> verification_results(new VerificationResults( 1267 compiler_options.get())); 1268 DexFileToMethodInlinerMap method_inliner_map; 1269 QuickCompilerCallbacks callbacks(verification_results.get(), &method_inliner_map); 1270 runtime_options.push_back(std::make_pair("compilercallbacks", &callbacks)); 1271 runtime_options.push_back( 1272 std::make_pair("imageinstructionset", 1273 reinterpret_cast<const void*>(GetInstructionSetString(instruction_set)))); 1274 1275 Dex2Oat* p_dex2oat; 1276 if (!Dex2Oat::Create(&p_dex2oat, 1277 runtime_options, 1278 *compiler_options, 1279 compiler_kind, 1280 instruction_set, 1281 instruction_set_features, 1282 verification_results.get(), 1283 &method_inliner_map, 1284 thread_count)) { 1285 LOG(ERROR) << "Failed to create dex2oat"; 1286 timings.EndTiming(); 1287 return EXIT_FAILURE; 1288 } 1289 std::unique_ptr<Dex2Oat> dex2oat(p_dex2oat); 1290 1291 // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start, 1292 // give it away now so that we don't starve GC. 1293 Thread* self = Thread::Current(); 1294 self->TransitionFromRunnableToSuspended(kNative); 1295 // If we're doing the image, override the compiler filter to force full compilation. Must be 1296 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force 1297 // compilation of class initializers. 1298 // Whilst we're in native take the opportunity to initialize well known classes. 1299 WellKnownClasses::Init(self->GetJniEnv()); 1300 1301 // If --image-classes was specified, calculate the full list of classes to include in the image 1302 std::unique_ptr<std::set<std::string>> image_classes(nullptr); 1303 if (image_classes_filename != nullptr) { 1304 std::string error_msg; 1305 if (image_classes_zip_filename != nullptr) { 1306 image_classes.reset(dex2oat->ReadImageClassesFromZip(image_classes_zip_filename, 1307 image_classes_filename, 1308 &error_msg)); 1309 } else { 1310 image_classes.reset(dex2oat->ReadImageClassesFromFile(image_classes_filename)); 1311 } 1312 if (image_classes.get() == nullptr) { 1313 LOG(ERROR) << "Failed to create list of image classes from '" << image_classes_filename << 1314 "': " << error_msg; 1315 timings.EndTiming(); 1316 return EXIT_FAILURE; 1317 } 1318 } else if (image) { 1319 image_classes.reset(new std::set<std::string>); 1320 } 1321 1322 std::vector<const DexFile*> dex_files; 1323 if (boot_image_option.empty()) { 1324 dex_files = Runtime::Current()->GetClassLinker()->GetBootClassPath(); 1325 } else { 1326 if (dex_filenames.empty()) { 1327 ATRACE_BEGIN("Opening zip archive from file descriptor"); 1328 std::string error_msg; 1329 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::OpenFromFd(zip_fd, zip_location.c_str(), 1330 &error_msg)); 1331 if (zip_archive.get() == nullptr) { 1332 LOG(ERROR) << "Failed to open zip from file descriptor for '" << zip_location << "': " 1333 << error_msg; 1334 timings.EndTiming(); 1335 return EXIT_FAILURE; 1336 } 1337 if (!DexFile::OpenFromZip(*zip_archive.get(), zip_location, &error_msg, &dex_files)) { 1338 LOG(ERROR) << "Failed to open dex from file descriptor for zip file '" << zip_location 1339 << "': " << error_msg; 1340 timings.EndTiming(); 1341 return EXIT_FAILURE; 1342 } 1343 ATRACE_END(); 1344 } else { 1345 size_t failure_count = OpenDexFiles(dex_filenames, dex_locations, dex_files); 1346 if (failure_count > 0) { 1347 LOG(ERROR) << "Failed to open some dex files: " << failure_count; 1348 timings.EndTiming(); 1349 return EXIT_FAILURE; 1350 } 1351 } 1352 1353 const bool kSaveDexInput = false; 1354 if (kSaveDexInput) { 1355 for (size_t i = 0; i < dex_files.size(); ++i) { 1356 const DexFile* dex_file = dex_files[i]; 1357 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex", getpid(), i)); 1358 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str())); 1359 if (tmp_file.get() == nullptr) { 1360 PLOG(ERROR) << "Failed to open file " << tmp_file_name 1361 << ". Try: adb shell chmod 777 /data/local/tmp"; 1362 continue; 1363 } 1364 tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()); 1365 LOG(INFO) << "Wrote input to " << tmp_file_name; 1366 } 1367 } 1368 } 1369 // Ensure opened dex files are writable for dex-to-dex transformations. 1370 for (const auto& dex_file : dex_files) { 1371 if (!dex_file->EnableWrite()) { 1372 PLOG(ERROR) << "Failed to make .dex file writeable '" << dex_file->GetLocation() << "'\n"; 1373 } 1374 } 1375 1376 /* 1377 * If we're not in interpret-only or verify-none mode, go ahead and compile small applications. 1378 * Don't bother to check if we're doing the image. 1379 */ 1380 if (!image && compiler_options->IsCompilationEnabled()) { 1381 size_t num_methods = 0; 1382 for (size_t i = 0; i != dex_files.size(); ++i) { 1383 const DexFile* dex_file = dex_files[i]; 1384 CHECK(dex_file != nullptr); 1385 num_methods += dex_file->NumMethodIds(); 1386 } 1387 if (num_methods <= compiler_options->GetNumDexMethodsThreshold()) { 1388 compiler_options->SetCompilerFilter(CompilerOptions::kSpeed); 1389 VLOG(compiler) << "Below method threshold, compiling anyways"; 1390 } 1391 } 1392 1393 // Fill some values into the key-value store for the oat header. 1394 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store( 1395 new SafeMap<std::string, std::string>()); 1396 1397 // Insert some compiler things. 1398 { 1399 std::ostringstream oss; 1400 for (int i = 0; i < argc; ++i) { 1401 if (i > 0) { 1402 oss << ' '; 1403 } 1404 oss << argv[i]; 1405 } 1406 key_value_store->Put(OatHeader::kDex2OatCmdLineKey, oss.str()); 1407 oss.str(""); // Reset. 1408 oss << kRuntimeISA; 1409 key_value_store->Put(OatHeader::kDex2OatHostKey, oss.str()); 1410 key_value_store->Put(OatHeader::kPicKey, compile_pic ? "true" : "false"); 1411 } 1412 1413 std::unique_ptr<const CompilerDriver> compiler(dex2oat->CreateOatFile(boot_image_option, 1414 android_root, 1415 is_host, 1416 dex_files, 1417 oat_file.get(), 1418 oat_location, 1419 bitcode_filename, 1420 image, 1421 image_classes, 1422 dump_stats, 1423 dump_passes, 1424 timings, 1425 compiler_phases_timings, 1426 profile_file, 1427 key_value_store.get())); 1428 if (compiler.get() == nullptr) { 1429 LOG(ERROR) << "Failed to create oat file: " << oat_location; 1430 timings.EndTiming(); 1431 return EXIT_FAILURE; 1432 } 1433 1434 VLOG(compiler) << "Oat file written successfully (unstripped): " << oat_location; 1435 1436 // Notes on the interleaving of creating the image and oat file to 1437 // ensure the references between the two are correct. 1438 // 1439 // Currently we have a memory layout that looks something like this: 1440 // 1441 // +--------------+ 1442 // | image | 1443 // +--------------+ 1444 // | boot oat | 1445 // +--------------+ 1446 // | alloc spaces | 1447 // +--------------+ 1448 // 1449 // There are several constraints on the loading of the image and boot.oat. 1450 // 1451 // 1. The image is expected to be loaded at an absolute address and 1452 // contains Objects with absolute pointers within the image. 1453 // 1454 // 2. There are absolute pointers from Methods in the image to their 1455 // code in the oat. 1456 // 1457 // 3. There are absolute pointers from the code in the oat to Methods 1458 // in the image. 1459 // 1460 // 4. There are absolute pointers from code in the oat to other code 1461 // in the oat. 1462 // 1463 // To get this all correct, we go through several steps. 1464 // 1465 // 1. We have already created that oat file above with 1466 // CreateOatFile. Originally this was just our own proprietary file 1467 // but now it is contained within an ELF dynamic object (aka an .so 1468 // file). The Compiler returned by CreateOatFile provides 1469 // PatchInformation for references to oat code and Methods that need 1470 // to be update once we know where the oat file will be located 1471 // after the image. 1472 // 1473 // 2. We create the image file. It needs to know where the oat file 1474 // will be loaded after itself. Originally when oat file was simply 1475 // memory mapped so we could predict where its contents were based 1476 // on the file size. Now that it is an ELF file, we need to inspect 1477 // the ELF file to understand the in memory segment layout including 1478 // where the oat header is located within. ElfPatcher's Patch method 1479 // uses the PatchInformation from the Compiler to touch up absolute 1480 // references in the oat file. 1481 // 1482 // 3. We fixup the ELF program headers so that dlopen will try to 1483 // load the .so at the desired location at runtime by offsetting the 1484 // Elf32_Phdr.p_vaddr values by the desired base address. 1485 // 1486 if (image) { 1487 TimingLogger::ScopedTiming t("dex2oat ImageWriter", &timings); 1488 bool image_creation_success = dex2oat->CreateImageFile(image_filename, 1489 image_base, 1490 oat_unstripped, 1491 oat_location, 1492 *compiler.get()); 1493 if (!image_creation_success) { 1494 timings.EndTiming(); 1495 return EXIT_FAILURE; 1496 } 1497 VLOG(compiler) << "Image written successfully: " << image_filename; 1498 } 1499 1500 if (is_host) { 1501 timings.EndTiming(); 1502 if (dump_timing || (dump_slow_timing && timings.GetTotalNs() > MsToNs(1000))) { 1503 LOG(INFO) << Dumpable<TimingLogger>(timings); 1504 } 1505 if (dump_passes) { 1506 LOG(INFO) << Dumpable<CumulativeLogger>(*compiler.get()->GetTimingsLogger()); 1507 } 1508 return EXIT_SUCCESS; 1509 } 1510 1511 // If we don't want to strip in place, copy from unstripped location to stripped location. 1512 // We need to strip after image creation because FixupElf needs to use .strtab. 1513 if (oat_unstripped != oat_stripped) { 1514 TimingLogger::ScopedTiming t("dex2oat OatFile copy", &timings); 1515 oat_file.reset(); 1516 std::unique_ptr<File> in(OS::OpenFileForReading(oat_unstripped.c_str())); 1517 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_stripped.c_str())); 1518 size_t buffer_size = 8192; 1519 std::unique_ptr<uint8_t> buffer(new uint8_t[buffer_size]); 1520 while (true) { 1521 int bytes_read = TEMP_FAILURE_RETRY(read(in->Fd(), buffer.get(), buffer_size)); 1522 if (bytes_read <= 0) { 1523 break; 1524 } 1525 bool write_ok = out->WriteFully(buffer.get(), bytes_read); 1526 CHECK(write_ok); 1527 } 1528 oat_file.reset(out.release()); 1529 VLOG(compiler) << "Oat file copied successfully (stripped): " << oat_stripped; 1530 } 1531 1532#if ART_USE_PORTABLE_COMPILER // We currently only generate symbols on Portable 1533 if (!compiler_options.GetIncludeDebugSymbols()) { 1534 timings.NewSplit("dex2oat ElfStripper"); 1535 // Strip unneeded sections for target 1536 off_t seek_actual = lseek(oat_file->Fd(), 0, SEEK_SET); 1537 CHECK_EQ(0, seek_actual); 1538 std::string error_msg; 1539 CHECK(ElfStripper::Strip(oat_file.get(), &error_msg)) << error_msg; 1540 1541 1542 // We wrote the oat file successfully, and want to keep it. 1543 VLOG(compiler) << "Oat file written successfully (stripped): " << oat_location; 1544 } else { 1545 VLOG(compiler) << "Oat file written successfully without stripping: " << oat_location; 1546 } 1547#endif // ART_USE_PORTABLE_COMPILER 1548 1549 timings.EndTiming(); 1550 1551 if (dump_timing || (dump_slow_timing && timings.GetTotalNs() > MsToNs(1000))) { 1552 LOG(INFO) << Dumpable<TimingLogger>(timings); 1553 } 1554 if (dump_passes) { 1555 LOG(INFO) << Dumpable<CumulativeLogger>(compiler_phases_timings); 1556 } 1557 1558 // Everything was successfully written, do an explicit exit here to avoid running Runtime 1559 // destructors that take time (bug 10645725) unless we're a debug build or running on valgrind. 1560 if (!kIsDebugBuild && (RUNNING_ON_VALGRIND == 0)) { 1561 dex2oat->LogCompletionTime(); 1562 exit(EXIT_SUCCESS); 1563 } 1564 1565 return EXIT_SUCCESS; 1566} // NOLINT(readability/fn_size) 1567} // namespace art 1568 1569int main(int argc, char** argv) { 1570 return art::dex2oat(argc, argv); 1571} 1572