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