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