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