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