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 #include "base/stl_util.h" 29 #include "base/stringpiece.h" 30 #include "base/timing_logger.h" 31 #include "base/unix_file/fd_file.h" 32 #include "class_linker.h" 33 #include "dex_file-inl.h" 34 #include "driver/compiler_driver.h" 35 #include "elf_fixup.h" 36 #include "elf_stripper.h" 37 #include "gc/space/image_space.h" 38 #include "gc/space/space-inl.h" 39 #include "image_writer.h" 40 #include "leb128.h" 41 #include "mirror/art_method-inl.h" 42 #include "mirror/class-inl.h" 43 #include "mirror/class_loader.h" 44 #include "mirror/object-inl.h" 45 #include "mirror/object_array-inl.h" 46 #include "oat_writer.h" 47 #include "object_utils.h" 48 #include "os.h" 49 #include "runtime.h" 50 #include "ScopedLocalRef.h" 51 #include "scoped_thread_state_change.h" 52 #include "sirt_ref.h" 53 #include "vector_output_stream.h" 54 #include "well_known_classes.h" 55 #include "zip_archive.h" 56 57 namespace art { 58 59 static void UsageErrorV(const char* fmt, va_list ap) { 60 std::string error; 61 StringAppendV(&error, fmt, ap); 62 LOG(ERROR) << error; 63 } 64 65 static void UsageError(const char* fmt, ...) { 66 va_list ap; 67 va_start(ap, fmt); 68 UsageErrorV(fmt, ap); 69 va_end(ap); 70 } 71 72 static void Usage(const char* fmt, ...) { 73 va_list ap; 74 va_start(ap, fmt); 75 UsageErrorV(fmt, ap); 76 va_end(ap); 77 78 UsageError("Usage: dex2oat [options]..."); 79 UsageError(""); 80 UsageError(" --dex-file=<dex-file>: specifies a .dex file to compile."); 81 UsageError(" Example: --dex-file=/system/framework/core.jar"); 82 UsageError(""); 83 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file"); 84 UsageError(" containing a classes.dex file to compile."); 85 UsageError(" Example: --zip-fd=5"); 86 UsageError(""); 87 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file"); 88 UsageError(" corresponding to the file descriptor specified by --zip-fd."); 89 UsageError(" Example: --zip-location=/system/app/Calculator.apk"); 90 UsageError(""); 91 UsageError(" --oat-file=<file.oat>: specifies the oat output destination via a filename."); 92 UsageError(" Example: --oat-file=/system/framework/boot.oat"); 93 UsageError(""); 94 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor."); 95 UsageError(" Example: --oat-file=/system/framework/boot.oat"); 96 UsageError(""); 97 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding"); 98 UsageError(" to the file descriptor specified by --oat-fd."); 99 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app (at) Calculator.apk.oat"); 100 UsageError(""); 101 UsageError(" --oat-symbols=<file.oat>: specifies the oat output destination with full symbols."); 102 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat"); 103 UsageError(""); 104 UsageError(" --bitcode=<file.bc>: specifies the optional bitcode filename."); 105 UsageError(" Example: --bitcode=/system/framework/boot.bc"); 106 UsageError(""); 107 UsageError(" --image=<file.art>: specifies the output image filename."); 108 UsageError(" Example: --image=/system/framework/boot.art"); 109 UsageError(""); 110 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image."); 111 UsageError(" Example: --image=frameworks/base/preloaded-classes"); 112 UsageError(""); 113 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image."); 114 UsageError(" Example: --base=0x50000000"); 115 UsageError(""); 116 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path."); 117 UsageError(" Example: --boot-image=/system/framework/boot.art"); 118 UsageError(" Default: <host-prefix>/system/framework/boot.art"); 119 UsageError(""); 120 UsageError(" --host-prefix=<path>: used to translate host paths to target paths during"); 121 UsageError(" cross compilation."); 122 UsageError(" Example: --host-prefix=out/target/product/crespo"); 123 UsageError(" Default: $ANDROID_PRODUCT_OUT"); 124 UsageError(""); 125 UsageError(" --android-root=<path>: used to locate libraries for portable linking."); 126 UsageError(" Example: --android-root=out/host/linux-x86"); 127 UsageError(" Default: $ANDROID_ROOT"); 128 UsageError(""); 129 UsageError(" --instruction-set=(arm|mips|x86): compile for a particular instruction"); 130 UsageError(" set."); 131 UsageError(" Example: --instruction-set=x86"); 132 UsageError(" Default: arm"); 133 UsageError(""); 134 UsageError(" --compiler-backend=(Quick|QuickGBC|Portable): select compiler backend"); 135 UsageError(" set."); 136 UsageError(" Example: --instruction-set=Portable"); 137 UsageError(" Default: Quick"); 138 UsageError(""); 139 UsageError(" --host: used with Portable backend to link against host runtime libraries"); 140 UsageError(""); 141 UsageError(" --dump-timing: display a breakdown of where time was spent"); 142 UsageError(""); 143 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,"); 144 UsageError(" such as initial heap size, maximum heap size, and verbose output."); 145 UsageError(" Use a separate --runtime-arg switch for each argument."); 146 UsageError(" Example: --runtime-arg -Xms256m"); 147 UsageError(""); 148 std::cerr << "See log for usage error information\n"; 149 exit(EXIT_FAILURE); 150 } 151 152 class Dex2Oat { 153 public: 154 static bool Create(Dex2Oat** p_dex2oat, 155 Runtime::Options& options, 156 CompilerBackend compiler_backend, 157 InstructionSet instruction_set, 158 size_t thread_count) 159 SHARED_TRYLOCK_FUNCTION(true, Locks::mutator_lock_) { 160 if (!CreateRuntime(options, instruction_set)) { 161 *p_dex2oat = NULL; 162 return false; 163 } 164 *p_dex2oat = new Dex2Oat(Runtime::Current(), compiler_backend, instruction_set, thread_count); 165 return true; 166 } 167 168 ~Dex2Oat() { 169 delete runtime_; 170 VLOG(compiler) << "dex2oat took " << PrettyDuration(NanoTime() - start_ns_) 171 << " (threads: " << thread_count_ << ")"; 172 } 173 174 175 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;) 176 CompilerDriver::DescriptorSet* ReadImageClassesFromFile(const char* image_classes_filename) { 177 UniquePtr<std::ifstream> image_classes_file(new std::ifstream(image_classes_filename, 178 std::ifstream::in)); 179 if (image_classes_file.get() == NULL) { 180 LOG(ERROR) << "Failed to open image classes file " << image_classes_filename; 181 return NULL; 182 } 183 UniquePtr<CompilerDriver::DescriptorSet> result(ReadImageClasses(*image_classes_file.get())); 184 image_classes_file->close(); 185 return result.release(); 186 } 187 188 CompilerDriver::DescriptorSet* ReadImageClasses(std::istream& image_classes_stream) { 189 UniquePtr<CompilerDriver::DescriptorSet> image_classes(new CompilerDriver::DescriptorSet); 190 while (image_classes_stream.good()) { 191 std::string dot; 192 std::getline(image_classes_stream, dot); 193 if (StartsWith(dot, "#") || dot.empty()) { 194 continue; 195 } 196 std::string descriptor(DotToDescriptor(dot.c_str())); 197 image_classes->insert(descriptor); 198 } 199 return image_classes.release(); 200 } 201 202 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;) 203 CompilerDriver::DescriptorSet* ReadImageClassesFromZip(const std::string& zip_filename, 204 const char* image_classes_filename) { 205 UniquePtr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename)); 206 if (zip_archive.get() == NULL) { 207 LOG(ERROR) << "Failed to open zip file " << zip_filename; 208 return NULL; 209 } 210 UniquePtr<ZipEntry> zip_entry(zip_archive->Find(image_classes_filename)); 211 if (zip_entry.get() == NULL) { 212 LOG(ERROR) << "Failed to find " << image_classes_filename << " within " << zip_filename; 213 return NULL; 214 } 215 UniquePtr<MemMap> image_classes_file(zip_entry->ExtractToMemMap(image_classes_filename)); 216 if (image_classes_file.get() == NULL) { 217 LOG(ERROR) << "Failed to extract " << image_classes_filename << " from " << zip_filename; 218 return NULL; 219 } 220 const std::string image_classes_string(reinterpret_cast<char*>(image_classes_file->Begin()), 221 image_classes_file->Size()); 222 std::istringstream image_classes_stream(image_classes_string); 223 return ReadImageClasses(image_classes_stream); 224 } 225 226 const CompilerDriver* CreateOatFile(const std::string& boot_image_option, 227 const std::string* host_prefix, 228 const std::string& android_root, 229 bool is_host, 230 const std::vector<const DexFile*>& dex_files, 231 File* oat_file, 232 const std::string& bitcode_filename, 233 bool image, 234 UniquePtr<CompilerDriver::DescriptorSet>& image_classes, 235 bool dump_stats, 236 base::TimingLogger& timings) { 237 // SirtRef and ClassLoader creation needs to come after Runtime::Create 238 jobject class_loader = NULL; 239 Thread* self = Thread::Current(); 240 if (!boot_image_option.empty()) { 241 ClassLinker* class_linker = Runtime::Current()->GetClassLinker(); 242 std::vector<const DexFile*> class_path_files(dex_files); 243 OpenClassPathFiles(runtime_->GetClassPathString(), class_path_files); 244 ScopedObjectAccess soa(self); 245 for (size_t i = 0; i < class_path_files.size(); i++) { 246 class_linker->RegisterDexFile(*class_path_files[i]); 247 } 248 soa.Env()->AllocObject(WellKnownClasses::dalvik_system_PathClassLoader); 249 ScopedLocalRef<jobject> class_loader_local(soa.Env(), 250 soa.Env()->AllocObject(WellKnownClasses::dalvik_system_PathClassLoader)); 251 class_loader = soa.Env()->NewGlobalRef(class_loader_local.get()); 252 Runtime::Current()->SetCompileTimeClassPath(class_loader, class_path_files); 253 } 254 255 UniquePtr<CompilerDriver> driver(new CompilerDriver(compiler_backend_, 256 instruction_set_, 257 image, 258 image_classes.release(), 259 thread_count_, 260 dump_stats)); 261 262 if (compiler_backend_ == kPortable) { 263 driver->SetBitcodeFileName(bitcode_filename); 264 } 265 266 driver->CompileAll(class_loader, dex_files, timings); 267 268 timings.NewSplit("dex2oat OatWriter"); 269 std::string image_file_location; 270 uint32_t image_file_location_oat_checksum = 0; 271 uint32_t image_file_location_oat_data_begin = 0; 272 if (!driver->IsImage()) { 273 gc::space::ImageSpace* image_space = Runtime::Current()->GetHeap()->GetImageSpace(); 274 image_file_location_oat_checksum = image_space->GetImageHeader().GetOatChecksum(); 275 image_file_location_oat_data_begin = 276 reinterpret_cast<uint32_t>(image_space->GetImageHeader().GetOatDataBegin()); 277 image_file_location = image_space->GetImageFilename(); 278 if (host_prefix != NULL && StartsWith(image_file_location, host_prefix->c_str())) { 279 image_file_location = image_file_location.substr(host_prefix->size()); 280 } 281 } 282 283 OatWriter oat_writer(dex_files, 284 image_file_location_oat_checksum, 285 image_file_location_oat_data_begin, 286 image_file_location, 287 driver.get()); 288 289 if (!driver->WriteElf(android_root, is_host, dex_files, oat_writer, oat_file)) { 290 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath(); 291 return NULL; 292 } 293 294 return driver.release(); 295 } 296 297 bool CreateImageFile(const std::string& image_filename, 298 uintptr_t image_base, 299 const std::string& oat_filename, 300 const std::string& oat_location, 301 const CompilerDriver& compiler) 302 LOCKS_EXCLUDED(Locks::mutator_lock_) { 303 uintptr_t oat_data_begin; 304 { 305 // ImageWriter is scoped so it can free memory before doing FixupElf 306 ImageWriter image_writer(compiler); 307 if (!image_writer.Write(image_filename, image_base, oat_filename, oat_location)) { 308 LOG(ERROR) << "Failed to create image file " << image_filename; 309 return false; 310 } 311 oat_data_begin = image_writer.GetOatDataBegin(); 312 } 313 314 UniquePtr<File> oat_file(OS::OpenFileReadWrite(oat_filename.c_str())); 315 if (oat_file.get() == NULL) { 316 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename; 317 return false; 318 } 319 if (!ElfFixup::Fixup(oat_file.get(), oat_data_begin)) { 320 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath(); 321 return false; 322 } 323 return true; 324 } 325 326 private: 327 explicit Dex2Oat(Runtime* runtime, 328 CompilerBackend compiler_backend, 329 InstructionSet instruction_set, 330 size_t thread_count) 331 : compiler_backend_(compiler_backend), 332 instruction_set_(instruction_set), 333 runtime_(runtime), 334 thread_count_(thread_count), 335 start_ns_(NanoTime()) { 336 } 337 338 static bool CreateRuntime(Runtime::Options& options, InstructionSet instruction_set) 339 SHARED_TRYLOCK_FUNCTION(true, Locks::mutator_lock_) { 340 if (!Runtime::Create(options, false)) { 341 LOG(ERROR) << "Failed to create runtime"; 342 return false; 343 } 344 Runtime* runtime = Runtime::Current(); 345 // if we loaded an existing image, we will reuse values from the image roots. 346 if (!runtime->HasResolutionMethod()) { 347 runtime->SetResolutionMethod(runtime->CreateResolutionMethod()); 348 } 349 for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) { 350 Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i); 351 if (!runtime->HasCalleeSaveMethod(type)) { 352 runtime->SetCalleeSaveMethod(runtime->CreateCalleeSaveMethod(instruction_set, type), type); 353 } 354 } 355 runtime->GetClassLinker()->FixupDexCaches(runtime->GetResolutionMethod()); 356 return true; 357 } 358 359 // Appends to dex_files any elements of class_path that it doesn't already 360 // contain. This will open those dex files as necessary. 361 static void OpenClassPathFiles(const std::string& class_path, 362 std::vector<const DexFile*>& dex_files) { 363 std::vector<std::string> parsed; 364 Split(class_path, ':', parsed); 365 // Take Locks::mutator_lock_ so that lock ordering on the ClassLinker::dex_lock_ is maintained. 366 ScopedObjectAccess soa(Thread::Current()); 367 for (size_t i = 0; i < parsed.size(); ++i) { 368 if (DexFilesContains(dex_files, parsed[i])) { 369 continue; 370 } 371 const DexFile* dex_file = DexFile::Open(parsed[i], parsed[i]); 372 if (dex_file == NULL) { 373 LOG(WARNING) << "Failed to open dex file " << parsed[i]; 374 } else { 375 dex_files.push_back(dex_file); 376 } 377 } 378 } 379 380 // Returns true if dex_files has a dex with the named location. 381 static bool DexFilesContains(const std::vector<const DexFile*>& dex_files, 382 const std::string& location) { 383 for (size_t i = 0; i < dex_files.size(); ++i) { 384 if (dex_files[i]->GetLocation() == location) { 385 return true; 386 } 387 } 388 return false; 389 } 390 391 const CompilerBackend compiler_backend_; 392 393 const InstructionSet instruction_set_; 394 395 Runtime* runtime_; 396 size_t thread_count_; 397 uint64_t start_ns_; 398 399 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat); 400 }; 401 402 static bool ParseInt(const char* in, int* out) { 403 char* end; 404 int result = strtol(in, &end, 10); 405 if (in == end || *end != '\0') { 406 return false; 407 } 408 *out = result; 409 return true; 410 } 411 412 static size_t OpenDexFiles(const std::vector<const char*>& dex_filenames, 413 const std::vector<const char*>& dex_locations, 414 std::vector<const DexFile*>& dex_files) { 415 size_t failure_count = 0; 416 for (size_t i = 0; i < dex_filenames.size(); i++) { 417 const char* dex_filename = dex_filenames[i]; 418 const char* dex_location = dex_locations[i]; 419 const DexFile* dex_file = DexFile::Open(dex_filename, dex_location); 420 if (dex_file == NULL) { 421 LOG(WARNING) << "Failed to open .dex from file '" << dex_filename << "'\n"; 422 ++failure_count; 423 } else { 424 dex_files.push_back(dex_file); 425 } 426 } 427 return failure_count; 428 } 429 430 // The primary goal of the watchdog is to prevent stuck build servers 431 // during development when fatal aborts lead to a cascade of failures 432 // that result in a deadlock. 433 class WatchDog { 434 // WatchDog defines its own CHECK_PTHREAD_CALL to avoid using Log which uses locks 435 #undef CHECK_PTHREAD_CALL 436 #define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \ 437 do { \ 438 int rc = call args; \ 439 if (rc != 0) { \ 440 errno = rc; \ 441 std::string message(# call); \ 442 message += " failed for "; \ 443 message += reason; \ 444 Fatal(message); \ 445 } \ 446 } while (false) 447 448 public: 449 explicit WatchDog(bool is_watch_dog_enabled) { 450 is_watch_dog_enabled_ = is_watch_dog_enabled; 451 if (!is_watch_dog_enabled_) { 452 return; 453 } 454 shutting_down_ = false; 455 const char* reason = "dex2oat watch dog thread startup"; 456 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, NULL), reason); 457 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, NULL), reason); 458 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason); 459 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason); 460 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason); 461 } 462 ~WatchDog() { 463 if (!is_watch_dog_enabled_) { 464 return; 465 } 466 const char* reason = "dex2oat watch dog thread shutdown"; 467 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason); 468 shutting_down_ = true; 469 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason); 470 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason); 471 472 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, NULL), reason); 473 474 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason); 475 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason); 476 } 477 478 private: 479 static void* CallBack(void* arg) { 480 WatchDog* self = reinterpret_cast<WatchDog*>(arg); 481 ::art::SetThreadName("dex2oat watch dog"); 482 self->Wait(); 483 return NULL; 484 } 485 486 static void Message(char severity, const std::string& message) { 487 // TODO: Remove when we switch to LOG when we can guarantee it won't prevent shutdown in error 488 // cases. 489 fprintf(stderr, "dex2oat%s %c %d %d %s\n", 490 kIsDebugBuild ? "d" : "", 491 severity, 492 getpid(), 493 GetTid(), 494 message.c_str()); 495 } 496 497 static void Warn(const std::string& message) { 498 Message('W', message); 499 } 500 501 static void Fatal(const std::string& message) { 502 Message('F', message); 503 exit(1); 504 } 505 506 void Wait() { 507 bool warning = true; 508 CHECK_GT(kWatchDogTimeoutSeconds, kWatchDogWarningSeconds); 509 // TODO: tune the multiplier for GC verification, the following is just to make the timeout 510 // large. 511 int64_t multiplier = gc::kDesiredHeapVerification > gc::kVerifyAllFast ? 100 : 1; 512 timespec warning_ts; 513 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogWarningSeconds * 1000, 0, &warning_ts); 514 timespec timeout_ts; 515 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts); 516 const char* reason = "dex2oat watch dog thread waiting"; 517 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason); 518 while (!shutting_down_) { 519 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, 520 warning ? &warning_ts 521 : &timeout_ts)); 522 if (rc == ETIMEDOUT) { 523 std::string message(StringPrintf("dex2oat did not finish after %d seconds", 524 warning ? kWatchDogWarningSeconds 525 : kWatchDogTimeoutSeconds)); 526 if (warning) { 527 Warn(message.c_str()); 528 warning = false; 529 } else { 530 Fatal(message.c_str()); 531 } 532 } else if (rc != 0) { 533 std::string message(StringPrintf("pthread_cond_timedwait failed: %s", 534 strerror(errno))); 535 Fatal(message.c_str()); 536 } 537 } 538 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason); 539 } 540 541 // When setting timeouts, keep in mind that the build server may not be as fast as your desktop. 542 #if ART_USE_PORTABLE_COMPILER 543 static const unsigned int kWatchDogWarningSeconds = 2 * 60; // 2 minutes. 544 static const unsigned int kWatchDogTimeoutSeconds = 30 * 60; // 25 minutes + buffer. 545 #else 546 static const unsigned int kWatchDogWarningSeconds = 1 * 60; // 1 minute. 547 static const unsigned int kWatchDogTimeoutSeconds = 6 * 60; // 5 minutes + buffer. 548 #endif 549 550 bool is_watch_dog_enabled_; 551 bool shutting_down_; 552 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases. 553 pthread_mutex_t mutex_; 554 pthread_cond_t cond_; 555 pthread_attr_t attr_; 556 pthread_t pthread_; 557 }; 558 const unsigned int WatchDog::kWatchDogWarningSeconds; 559 const unsigned int WatchDog::kWatchDogTimeoutSeconds; 560 561 static int dex2oat(int argc, char** argv) { 562 base::TimingLogger timings("compiler", false, false); 563 564 InitLogging(argv); 565 566 // Skip over argv[0]. 567 argv++; 568 argc--; 569 570 if (argc == 0) { 571 Usage("No arguments specified"); 572 } 573 574 std::vector<const char*> dex_filenames; 575 std::vector<const char*> dex_locations; 576 int zip_fd = -1; 577 std::string zip_location; 578 std::string oat_filename; 579 std::string oat_symbols; 580 std::string oat_location; 581 int oat_fd = -1; 582 std::string bitcode_filename; 583 const char* image_classes_zip_filename = NULL; 584 const char* image_classes_filename = NULL; 585 std::string image_filename; 586 std::string boot_image_filename; 587 uintptr_t image_base = 0; 588 UniquePtr<std::string> host_prefix; 589 std::string android_root; 590 std::vector<const char*> runtime_args; 591 int thread_count = sysconf(_SC_NPROCESSORS_CONF); 592 #if defined(ART_USE_PORTABLE_COMPILER) 593 CompilerBackend compiler_backend = kPortable; 594 #else 595 CompilerBackend compiler_backend = kQuick; 596 #endif 597 #if defined(__arm__) 598 InstructionSet instruction_set = kThumb2; 599 #elif defined(__i386__) 600 InstructionSet instruction_set = kX86; 601 #elif defined(__mips__) 602 InstructionSet instruction_set = kMips; 603 #else 604 #error "Unsupported architecture" 605 #endif 606 bool is_host = false; 607 bool dump_stats = kIsDebugBuild; 608 bool dump_timing = false; 609 bool dump_slow_timing = kIsDebugBuild; 610 bool watch_dog_enabled = !kIsTargetBuild; 611 612 613 for (int i = 0; i < argc; i++) { 614 const StringPiece option(argv[i]); 615 bool log_options = false; 616 if (log_options) { 617 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i]; 618 } 619 if (option.starts_with("--dex-file=")) { 620 dex_filenames.push_back(option.substr(strlen("--dex-file=")).data()); 621 } else if (option.starts_with("--dex-location=")) { 622 dex_locations.push_back(option.substr(strlen("--dex-location=")).data()); 623 } else if (option.starts_with("--zip-fd=")) { 624 const char* zip_fd_str = option.substr(strlen("--zip-fd=")).data(); 625 if (!ParseInt(zip_fd_str, &zip_fd)) { 626 Usage("Failed to parse --zip-fd argument '%s' as an integer", zip_fd_str); 627 } 628 } else if (option.starts_with("--zip-location=")) { 629 zip_location = option.substr(strlen("--zip-location=")).data(); 630 } else if (option.starts_with("--oat-file=")) { 631 oat_filename = option.substr(strlen("--oat-file=")).data(); 632 } else if (option.starts_with("--oat-symbols=")) { 633 oat_symbols = option.substr(strlen("--oat-symbols=")).data(); 634 } else if (option.starts_with("--oat-fd=")) { 635 const char* oat_fd_str = option.substr(strlen("--oat-fd=")).data(); 636 if (!ParseInt(oat_fd_str, &oat_fd)) { 637 Usage("Failed to parse --oat-fd argument '%s' as an integer", oat_fd_str); 638 } 639 } else if (option == "--watch-dog") { 640 watch_dog_enabled = true; 641 } else if (option == "--no-watch-dog") { 642 watch_dog_enabled = false; 643 } else if (option.starts_with("-j")) { 644 const char* thread_count_str = option.substr(strlen("-j")).data(); 645 if (!ParseInt(thread_count_str, &thread_count)) { 646 Usage("Failed to parse -j argument '%s' as an integer", thread_count_str); 647 } 648 } else if (option.starts_with("--oat-location=")) { 649 oat_location = option.substr(strlen("--oat-location=")).data(); 650 } else if (option.starts_with("--bitcode=")) { 651 bitcode_filename = option.substr(strlen("--bitcode=")).data(); 652 } else if (option.starts_with("--image=")) { 653 image_filename = option.substr(strlen("--image=")).data(); 654 } else if (option.starts_with("--image-classes=")) { 655 image_classes_filename = option.substr(strlen("--image-classes=")).data(); 656 } else if (option.starts_with("--image-classes-zip=")) { 657 image_classes_zip_filename = option.substr(strlen("--image-classes-zip=")).data(); 658 } else if (option.starts_with("--base=")) { 659 const char* image_base_str = option.substr(strlen("--base=")).data(); 660 char* end; 661 image_base = strtoul(image_base_str, &end, 16); 662 if (end == image_base_str || *end != '\0') { 663 Usage("Failed to parse hexadecimal value for option %s", option.data()); 664 } 665 } else if (option.starts_with("--boot-image=")) { 666 boot_image_filename = option.substr(strlen("--boot-image=")).data(); 667 } else if (option.starts_with("--host-prefix=")) { 668 host_prefix.reset(new std::string(option.substr(strlen("--host-prefix=")).data())); 669 } else if (option.starts_with("--android-root=")) { 670 android_root = option.substr(strlen("--android-root=")).data(); 671 } else if (option.starts_with("--instruction-set=")) { 672 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data(); 673 if (instruction_set_str == "arm") { 674 instruction_set = kThumb2; 675 } else if (instruction_set_str == "mips") { 676 instruction_set = kMips; 677 } else if (instruction_set_str == "x86") { 678 instruction_set = kX86; 679 } 680 } else if (option.starts_with("--compiler-backend=")) { 681 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data(); 682 if (backend_str == "Quick") { 683 compiler_backend = kQuick; 684 } else if (backend_str == "Portable") { 685 compiler_backend = kPortable; 686 } 687 } else if (option == "--host") { 688 is_host = true; 689 } else if (option == "--runtime-arg") { 690 if (++i >= argc) { 691 Usage("Missing required argument for --runtime-arg"); 692 } 693 if (log_options) { 694 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i]; 695 } 696 runtime_args.push_back(argv[i]); 697 } else if (option == "--dump-timing") { 698 dump_timing = true; 699 } else { 700 Usage("Unknown argument %s", option.data()); 701 } 702 } 703 704 if (oat_filename.empty() && oat_fd == -1) { 705 Usage("Output must be supplied with either --oat-file or --oat-fd"); 706 } 707 708 if (!oat_filename.empty() && oat_fd != -1) { 709 Usage("--oat-file should not be used with --oat-fd"); 710 } 711 712 if (!oat_symbols.empty() && oat_fd != -1) { 713 Usage("--oat-symbols should not be used with --oat-fd"); 714 } 715 716 if (!oat_symbols.empty() && is_host) { 717 Usage("--oat-symbols should not be used with --host"); 718 } 719 720 if (oat_fd != -1 && !image_filename.empty()) { 721 Usage("--oat-fd should not be used with --image"); 722 } 723 724 if (host_prefix.get() == NULL) { 725 const char* android_product_out = getenv("ANDROID_PRODUCT_OUT"); 726 if (android_product_out != NULL) { 727 host_prefix.reset(new std::string(android_product_out)); 728 } 729 } 730 731 if (android_root.empty()) { 732 const char* android_root_env_var = getenv("ANDROID_ROOT"); 733 if (android_root_env_var == NULL) { 734 Usage("--android-root unspecified and ANDROID_ROOT not set"); 735 } 736 android_root += android_root_env_var; 737 } 738 739 bool image = (!image_filename.empty()); 740 if (!image && boot_image_filename.empty()) { 741 if (host_prefix.get() == NULL) { 742 boot_image_filename += GetAndroidRoot(); 743 } else { 744 boot_image_filename += *host_prefix.get(); 745 boot_image_filename += "/system"; 746 } 747 boot_image_filename += "/framework/boot.art"; 748 } 749 std::string boot_image_option; 750 if (!boot_image_filename.empty()) { 751 boot_image_option += "-Ximage:"; 752 boot_image_option += boot_image_filename; 753 } 754 755 if (image_classes_filename != NULL && !image) { 756 Usage("--image-classes should only be used with --image"); 757 } 758 759 if (image_classes_filename != NULL && !boot_image_option.empty()) { 760 Usage("--image-classes should not be used with --boot-image"); 761 } 762 763 if (image_classes_zip_filename != NULL && image_classes_filename == NULL) { 764 Usage("--image-classes-zip should be used with --image-classes"); 765 } 766 767 if (dex_filenames.empty() && zip_fd == -1) { 768 Usage("Input must be supplied with either --dex-file or --zip-fd"); 769 } 770 771 if (!dex_filenames.empty() && zip_fd != -1) { 772 Usage("--dex-file should not be used with --zip-fd"); 773 } 774 775 if (!dex_filenames.empty() && !zip_location.empty()) { 776 Usage("--dex-file should not be used with --zip-location"); 777 } 778 779 if (dex_locations.empty()) { 780 for (size_t i = 0; i < dex_filenames.size(); i++) { 781 dex_locations.push_back(dex_filenames[i]); 782 } 783 } else if (dex_locations.size() != dex_filenames.size()) { 784 Usage("--dex-location arguments do not match --dex-file arguments"); 785 } 786 787 if (zip_fd != -1 && zip_location.empty()) { 788 Usage("--zip-location should be supplied with --zip-fd"); 789 } 790 791 if (boot_image_option.empty()) { 792 if (image_base == 0) { 793 Usage("Non-zero --base not specified"); 794 } 795 } 796 797 std::string oat_stripped(oat_filename); 798 std::string oat_unstripped; 799 if (!oat_symbols.empty()) { 800 oat_unstripped += oat_symbols; 801 } else { 802 oat_unstripped += oat_filename; 803 } 804 805 // Done with usage checks, enable watchdog if requested 806 WatchDog watch_dog(watch_dog_enabled); 807 808 // Check early that the result of compilation can be written 809 UniquePtr<File> oat_file; 810 bool create_file = !oat_unstripped.empty(); // as opposed to using open file descriptor 811 if (create_file) { 812 oat_file.reset(OS::CreateEmptyFile(oat_unstripped.c_str())); 813 if (oat_location.empty()) { 814 oat_location = oat_filename; 815 } 816 } else { 817 oat_file.reset(new File(oat_fd, oat_location)); 818 oat_file->DisableAutoClose(); 819 } 820 if (oat_file.get() == NULL) { 821 PLOG(ERROR) << "Failed to create oat file: " << oat_location; 822 return EXIT_FAILURE; 823 } 824 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) { 825 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_location; 826 return EXIT_FAILURE; 827 } 828 829 timings.StartSplit("dex2oat Setup"); 830 LOG(INFO) << "dex2oat: " << oat_location; 831 832 if (image) { 833 bool has_compiler_filter = false; 834 for (const char* r : runtime_args) { 835 if (strncmp(r, "-compiler-filter:", 17) == 0) { 836 has_compiler_filter = true; 837 break; 838 } 839 } 840 if (!has_compiler_filter) { 841 runtime_args.push_back("-compiler-filter:everything"); 842 } 843 } 844 845 Runtime::Options options; 846 options.push_back(std::make_pair("compiler", reinterpret_cast<void*>(NULL))); 847 std::vector<const DexFile*> boot_class_path; 848 if (boot_image_option.empty()) { 849 size_t failure_count = OpenDexFiles(dex_filenames, dex_locations, boot_class_path); 850 if (failure_count > 0) { 851 LOG(ERROR) << "Failed to open some dex files: " << failure_count; 852 return EXIT_FAILURE; 853 } 854 options.push_back(std::make_pair("bootclasspath", &boot_class_path)); 855 } else { 856 options.push_back(std::make_pair(boot_image_option.c_str(), reinterpret_cast<void*>(NULL))); 857 } 858 if (host_prefix.get() != NULL) { 859 options.push_back(std::make_pair("host-prefix", host_prefix->c_str())); 860 } 861 for (size_t i = 0; i < runtime_args.size(); i++) { 862 options.push_back(std::make_pair(runtime_args[i], reinterpret_cast<void*>(NULL))); 863 } 864 865 #ifdef ART_SEA_IR_MODE 866 options.push_back(std::make_pair("-sea_ir", reinterpret_cast<void*>(NULL))); 867 #endif 868 869 Dex2Oat* p_dex2oat; 870 if (!Dex2Oat::Create(&p_dex2oat, options, compiler_backend, instruction_set, thread_count)) { 871 LOG(ERROR) << "Failed to create dex2oat"; 872 return EXIT_FAILURE; 873 } 874 UniquePtr<Dex2Oat> dex2oat(p_dex2oat); 875 // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start, 876 // give it away now so that we don't starve GC. 877 Thread* self = Thread::Current(); 878 self->TransitionFromRunnableToSuspended(kNative); 879 // If we're doing the image, override the compiler filter to force full compilation. Must be 880 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force 881 // compilation of class initializers. 882 // Whilst we're in native take the opportunity to initialize well known classes. 883 WellKnownClasses::Init(self->GetJniEnv()); 884 885 // If --image-classes was specified, calculate the full list of classes to include in the image 886 UniquePtr<CompilerDriver::DescriptorSet> image_classes(NULL); 887 if (image_classes_filename != NULL) { 888 if (image_classes_zip_filename != NULL) { 889 image_classes.reset(dex2oat->ReadImageClassesFromZip(image_classes_zip_filename, 890 image_classes_filename)); 891 } else { 892 image_classes.reset(dex2oat->ReadImageClassesFromFile(image_classes_filename)); 893 } 894 if (image_classes.get() == NULL) { 895 LOG(ERROR) << "Failed to create list of image classes from " << image_classes_filename; 896 return EXIT_FAILURE; 897 } 898 } 899 900 std::vector<const DexFile*> dex_files; 901 if (boot_image_option.empty()) { 902 dex_files = Runtime::Current()->GetClassLinker()->GetBootClassPath(); 903 } else { 904 if (dex_filenames.empty()) { 905 UniquePtr<ZipArchive> zip_archive(ZipArchive::OpenFromFd(zip_fd)); 906 if (zip_archive.get() == NULL) { 907 LOG(ERROR) << "Failed to open zip from file descriptor for " << zip_location; 908 return EXIT_FAILURE; 909 } 910 const DexFile* dex_file = DexFile::Open(*zip_archive.get(), zip_location); 911 if (dex_file == NULL) { 912 LOG(ERROR) << "Failed to open dex from file descriptor for zip file: " << zip_location; 913 return EXIT_FAILURE; 914 } 915 dex_files.push_back(dex_file); 916 } else { 917 size_t failure_count = OpenDexFiles(dex_filenames, dex_locations, dex_files); 918 if (failure_count > 0) { 919 LOG(ERROR) << "Failed to open some dex files: " << failure_count; 920 return EXIT_FAILURE; 921 } 922 } 923 924 // Ensure opened dex files are writable for dex-to-dex transformations. 925 for (const auto& dex_file : dex_files) { 926 if (!dex_file->EnableWrite()) { 927 PLOG(ERROR) << "Failed to make .dex file writeable '" << dex_file->GetLocation() << "'\n"; 928 } 929 } 930 } 931 932 /* 933 * If we're not in interpret-only mode, go ahead and compile small applications. Don't 934 * bother to check if we're doing the image. 935 */ 936 if (!image && (Runtime::Current()->GetCompilerFilter() != Runtime::kInterpretOnly)) { 937 size_t num_methods = 0; 938 for (size_t i = 0; i != dex_files.size(); ++i) { 939 const DexFile* dex_file = dex_files[i]; 940 CHECK(dex_file != NULL); 941 num_methods += dex_file->NumMethodIds(); 942 } 943 if (num_methods <= Runtime::Current()->GetNumDexMethodsThreshold()) { 944 Runtime::Current()->SetCompilerFilter(Runtime::kSpeed); 945 VLOG(compiler) << "Below method threshold, compiling anyways"; 946 } 947 } 948 949 UniquePtr<const CompilerDriver> compiler(dex2oat->CreateOatFile(boot_image_option, 950 host_prefix.get(), 951 android_root, 952 is_host, 953 dex_files, 954 oat_file.get(), 955 bitcode_filename, 956 image, 957 image_classes, 958 dump_stats, 959 timings)); 960 961 if (compiler.get() == NULL) { 962 LOG(ERROR) << "Failed to create oat file: " << oat_location; 963 return EXIT_FAILURE; 964 } 965 966 VLOG(compiler) << "Oat file written successfully (unstripped): " << oat_location; 967 968 // Notes on the interleaving of creating the image and oat file to 969 // ensure the references between the two are correct. 970 // 971 // Currently we have a memory layout that looks something like this: 972 // 973 // +--------------+ 974 // | image | 975 // +--------------+ 976 // | boot oat | 977 // +--------------+ 978 // | alloc spaces | 979 // +--------------+ 980 // 981 // There are several constraints on the loading of the image and boot.oat. 982 // 983 // 1. The image is expected to be loaded at an absolute address and 984 // contains Objects with absolute pointers within the image. 985 // 986 // 2. There are absolute pointers from Methods in the image to their 987 // code in the oat. 988 // 989 // 3. There are absolute pointers from the code in the oat to Methods 990 // in the image. 991 // 992 // 4. There are absolute pointers from code in the oat to other code 993 // in the oat. 994 // 995 // To get this all correct, we go through several steps. 996 // 997 // 1. We have already created that oat file above with 998 // CreateOatFile. Originally this was just our own proprietary file 999 // but now it is contained within an ELF dynamic object (aka an .so 1000 // file). The Compiler returned by CreateOatFile provides 1001 // PatchInformation for references to oat code and Methods that need 1002 // to be update once we know where the oat file will be located 1003 // after the image. 1004 // 1005 // 2. We create the image file. It needs to know where the oat file 1006 // will be loaded after itself. Originally when oat file was simply 1007 // memory mapped so we could predict where its contents were based 1008 // on the file size. Now that it is an ELF file, we need to inspect 1009 // the ELF file to understand the in memory segment layout including 1010 // where the oat header is located within. ImageWriter's 1011 // PatchOatCodeAndMethods uses the PatchInformation from the 1012 // Compiler to touch up absolute references in the oat file. 1013 // 1014 // 3. We fixup the ELF program headers so that dlopen will try to 1015 // load the .so at the desired location at runtime by offsetting the 1016 // Elf32_Phdr.p_vaddr values by the desired base address. 1017 // 1018 if (image) { 1019 timings.NewSplit("dex2oat ImageWriter"); 1020 bool image_creation_success = dex2oat->CreateImageFile(image_filename, 1021 image_base, 1022 oat_unstripped, 1023 oat_location, 1024 *compiler.get()); 1025 if (!image_creation_success) { 1026 return EXIT_FAILURE; 1027 } 1028 VLOG(compiler) << "Image written successfully: " << image_filename; 1029 } 1030 1031 if (is_host) { 1032 if (dump_timing || (dump_slow_timing && timings.GetTotalNs() > MsToNs(1000))) { 1033 LOG(INFO) << Dumpable<base::TimingLogger>(timings); 1034 } 1035 return EXIT_SUCCESS; 1036 } 1037 1038 // If we don't want to strip in place, copy from unstripped location to stripped location. 1039 // We need to strip after image creation because FixupElf needs to use .strtab. 1040 if (oat_unstripped != oat_stripped) { 1041 timings.NewSplit("dex2oat OatFile copy"); 1042 oat_file.reset(); 1043 UniquePtr<File> in(OS::OpenFileForReading(oat_unstripped.c_str())); 1044 UniquePtr<File> out(OS::CreateEmptyFile(oat_stripped.c_str())); 1045 size_t buffer_size = 8192; 1046 UniquePtr<uint8_t> buffer(new uint8_t[buffer_size]); 1047 while (true) { 1048 int bytes_read = TEMP_FAILURE_RETRY(read(in->Fd(), buffer.get(), buffer_size)); 1049 if (bytes_read <= 0) { 1050 break; 1051 } 1052 bool write_ok = out->WriteFully(buffer.get(), bytes_read); 1053 CHECK(write_ok); 1054 } 1055 oat_file.reset(out.release()); 1056 VLOG(compiler) << "Oat file copied successfully (stripped): " << oat_stripped; 1057 } 1058 1059 #if ART_USE_PORTABLE_COMPILER // We currently only generate symbols on Portable 1060 timings.NewSplit("dex2oat ElfStripper"); 1061 // Strip unneeded sections for target 1062 off_t seek_actual = lseek(oat_file->Fd(), 0, SEEK_SET); 1063 CHECK_EQ(0, seek_actual); 1064 ElfStripper::Strip(oat_file.get()); 1065 1066 1067 // We wrote the oat file successfully, and want to keep it. 1068 VLOG(compiler) << "Oat file written successfully (stripped): " << oat_location; 1069 #endif // ART_USE_PORTABLE_COMPILER 1070 1071 timings.EndSplit(); 1072 1073 if (dump_timing || (dump_slow_timing && timings.GetTotalNs() > MsToNs(1000))) { 1074 LOG(INFO) << Dumpable<base::TimingLogger>(timings); 1075 } 1076 1077 // Everything was successfully written, do an explicit exit here to avoid running Runtime 1078 // destructors that take time (bug 10645725) unless we're a debug build or running on valgrind. 1079 if (!kIsDebugBuild || (RUNNING_ON_VALGRIND == 0)) { 1080 exit(EXIT_SUCCESS); 1081 } 1082 1083 return EXIT_SUCCESS; 1084 } 1085 1086 1087 } // namespace art 1088 1089 int main(int argc, char** argv) { 1090 return art::dex2oat(argc, argv); 1091 } 1092
