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