dex2oat.cc revision 919f5536182890d2e03f59b961acf8f7c836ff61
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 <inttypes.h> 18#include <stdio.h> 19#include <stdlib.h> 20#include <sys/stat.h> 21#include "base/memory_tool.h" 22 23#include <fstream> 24#include <iostream> 25#include <sstream> 26#include <string> 27#include <unordered_set> 28#include <vector> 29 30#if defined(__linux__) && defined(__arm__) 31#include <sys/personality.h> 32#include <sys/utsname.h> 33#endif 34 35#define ATRACE_TAG ATRACE_TAG_DALVIK 36#include <cutils/trace.h> 37 38#include "art_method-inl.h" 39#include "arch/instruction_set_features.h" 40#include "arch/mips/instruction_set_features_mips.h" 41#include "base/dumpable.h" 42#include "base/macros.h" 43#include "base/stl_util.h" 44#include "base/stringpiece.h" 45#include "base/time_utils.h" 46#include "base/timing_logger.h" 47#include "base/unix_file/fd_file.h" 48#include "class_linker.h" 49#include "compiler.h" 50#include "compiler_callbacks.h" 51#include "dex_file-inl.h" 52#include "dex/pass_manager.h" 53#include "dex/verification_results.h" 54#include "dex/quick_compiler_callbacks.h" 55#include "dex/quick/dex_file_to_method_inliner_map.h" 56#include "driver/compiler_driver.h" 57#include "driver/compiler_options.h" 58#include "dwarf/method_debug_info.h" 59#include "elf_file.h" 60#include "elf_writer.h" 61#include "elf_writer_quick.h" 62#include "gc/space/image_space.h" 63#include "gc/space/space-inl.h" 64#include "image_writer.h" 65#include "interpreter/unstarted_runtime.h" 66#include "jit/offline_profiling_info.h" 67#include "leb128.h" 68#include "mirror/class-inl.h" 69#include "mirror/class_loader.h" 70#include "mirror/object-inl.h" 71#include "mirror/object_array-inl.h" 72#include "oat_writer.h" 73#include "os.h" 74#include "profile_assistant.h" 75#include "runtime.h" 76#include "runtime_options.h" 77#include "ScopedLocalRef.h" 78#include "scoped_thread_state_change.h" 79#include "utils.h" 80#include "well_known_classes.h" 81#include "zip_archive.h" 82 83namespace art { 84 85static int original_argc; 86static char** original_argv; 87 88static std::string CommandLine() { 89 std::vector<std::string> command; 90 for (int i = 0; i < original_argc; ++i) { 91 command.push_back(original_argv[i]); 92 } 93 return Join(command, ' '); 94} 95 96// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be 97// even more aggressive. There won't be much reasonable data here for us in that case anyways (the 98// locations are all staged). 99static std::string StrippedCommandLine() { 100 std::vector<std::string> command; 101 102 // Do a pre-pass to look for zip-fd. 103 bool saw_zip_fd = false; 104 for (int i = 0; i < original_argc; ++i) { 105 if (StartsWith(original_argv[i], "--zip-fd=")) { 106 saw_zip_fd = true; 107 break; 108 } 109 } 110 111 // Now filter out things. 112 for (int i = 0; i < original_argc; ++i) { 113 // All runtime-arg parameters are dropped. 114 if (strcmp(original_argv[i], "--runtime-arg") == 0) { 115 i++; // Drop the next part, too. 116 continue; 117 } 118 119 // Any instruction-setXXX is dropped. 120 if (StartsWith(original_argv[i], "--instruction-set")) { 121 continue; 122 } 123 124 // The boot image is dropped. 125 if (StartsWith(original_argv[i], "--boot-image=")) { 126 continue; 127 } 128 129 // This should leave any dex-file and oat-file options, describing what we compiled. 130 131 // However, we prefer to drop this when we saw --zip-fd. 132 if (saw_zip_fd) { 133 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X 134 if (StartsWith(original_argv[i], "--zip-") || 135 StartsWith(original_argv[i], "--dex-") || 136 StartsWith(original_argv[i], "--oat-") || 137 StartsWith(original_argv[i], "--swap-") || 138 StartsWith(original_argv[i], "--app-image-")) { 139 continue; 140 } 141 } 142 143 command.push_back(original_argv[i]); 144 } 145 146 // Construct the final output. 147 if (command.size() <= 1U) { 148 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line. 149 return "Starting dex2oat."; 150 } 151 return Join(command, ' '); 152} 153 154static void UsageErrorV(const char* fmt, va_list ap) { 155 std::string error; 156 StringAppendV(&error, fmt, ap); 157 LOG(ERROR) << error; 158} 159 160static void UsageError(const char* fmt, ...) { 161 va_list ap; 162 va_start(ap, fmt); 163 UsageErrorV(fmt, ap); 164 va_end(ap); 165} 166 167NO_RETURN static void Usage(const char* fmt, ...) { 168 va_list ap; 169 va_start(ap, fmt); 170 UsageErrorV(fmt, ap); 171 va_end(ap); 172 173 UsageError("Command: %s", CommandLine().c_str()); 174 175 UsageError("Usage: dex2oat [options]..."); 176 UsageError(""); 177 UsageError(" -j<number>: specifies the number of threads used for compilation."); 178 UsageError(" Default is the number of detected hardware threads available on the"); 179 UsageError(" host system."); 180 UsageError(" Example: -j12"); 181 UsageError(""); 182 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile."); 183 UsageError(" Example: --dex-file=/system/framework/core.jar"); 184 UsageError(""); 185 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to"); 186 UsageError(" encode in the oat file for the corresponding --dex-file argument."); 187 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar"); 188 UsageError(" --dex-location=/system/framework/core.jar"); 189 UsageError(""); 190 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file"); 191 UsageError(" containing a classes.dex file to compile."); 192 UsageError(" Example: --zip-fd=5"); 193 UsageError(""); 194 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file"); 195 UsageError(" corresponding to the file descriptor specified by --zip-fd."); 196 UsageError(" Example: --zip-location=/system/app/Calculator.apk"); 197 UsageError(""); 198 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename."); 199 UsageError(" Example: --oat-file=/system/framework/boot.oat"); 200 UsageError(""); 201 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor."); 202 UsageError(" Example: --oat-fd=6"); 203 UsageError(""); 204 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding"); 205 UsageError(" to the file descriptor specified by --oat-fd."); 206 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat"); 207 UsageError(""); 208 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols."); 209 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat"); 210 UsageError(""); 211 UsageError(" --image=<file.art>: specifies an output image filename."); 212 UsageError(" Example: --image=/system/framework/boot.art"); 213 UsageError(""); 214 UsageError(" --image-format=(uncompressed|lz4):"); 215 UsageError(" Which format to store the image."); 216 UsageError(" Example: --image-format=lz4"); 217 UsageError(" Default: uncompressed"); 218 UsageError(""); 219 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image."); 220 UsageError(" Example: --image=frameworks/base/preloaded-classes"); 221 UsageError(""); 222 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image."); 223 UsageError(" Example: --base=0x50000000"); 224 UsageError(""); 225 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path."); 226 UsageError(" Do not include the arch as part of the name, it is added automatically."); 227 UsageError(" Example: --boot-image=/system/framework/boot.art"); 228 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)"); 229 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art"); 230 UsageError(""); 231 UsageError(" --android-root=<path>: used to locate libraries for portable linking."); 232 UsageError(" Example: --android-root=out/host/linux-x86"); 233 UsageError(" Default: $ANDROID_ROOT"); 234 UsageError(""); 235 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular"); 236 UsageError(" instruction set."); 237 UsageError(" Example: --instruction-set=x86"); 238 UsageError(" Default: arm"); 239 UsageError(""); 240 UsageError(" --instruction-set-features=...,: Specify instruction set features"); 241 UsageError(" Example: --instruction-set-features=div"); 242 UsageError(" Default: default"); 243 UsageError(""); 244 UsageError(" --compile-pic: Force indirect use of code, methods, and classes"); 245 UsageError(" Default: disabled"); 246 UsageError(""); 247 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend"); 248 UsageError(" set."); 249 UsageError(" Example: --compiler-backend=Optimizing"); 250 UsageError(" Default: Optimizing"); 251 UsageError(""); 252 UsageError(" --compiler-filter=" 253 "(verify-none" 254 "|interpret-only" 255 "|space" 256 "|balanced" 257 "|speed" 258 "|everything" 259 "|time):"); 260 UsageError(" select compiler filter."); 261 UsageError(" Example: --compiler-filter=everything"); 262 UsageError(" Default: speed"); 263 UsageError(""); 264 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge"); 265 UsageError(" method for compiler filter tuning."); 266 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold); 267 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold); 268 UsageError(""); 269 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large"); 270 UsageError(" method for compiler filter tuning."); 271 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold); 272 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold); 273 UsageError(""); 274 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small"); 275 UsageError(" method for compiler filter tuning."); 276 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold); 277 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold); 278 UsageError(""); 279 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny"); 280 UsageError(" method for compiler filter tuning."); 281 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold); 282 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold); 283 UsageError(""); 284 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for"); 285 UsageError(" compiler filter tuning. If the input has fewer than this many methods"); 286 UsageError(" and the filter is not interpret-only or verify-none, overrides the"); 287 UsageError(" filter to use speed"); 288 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold); 289 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold); 290 UsageError(""); 291 UsageError(" --inline-depth-limit=<depth-limit>: the depth limit of inlining for fine tuning"); 292 UsageError(" the compiler. A zero value will disable inlining. Honored only by Optimizing."); 293 UsageError(" Has priority over the --compiler-filter option. Intended for "); 294 UsageError(" development/experimental use."); 295 UsageError(" Example: --inline-depth-limit=%d", CompilerOptions::kDefaultInlineDepthLimit); 296 UsageError(" Default: %d", CompilerOptions::kDefaultInlineDepthLimit); 297 UsageError(""); 298 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method"); 299 UsageError(" can have to be considered for inlining. A zero value will disable inlining."); 300 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option."); 301 UsageError(" Intended for development/experimental use."); 302 UsageError(" Example: --inline-max-code-units=%d", 303 CompilerOptions::kDefaultInlineMaxCodeUnits); 304 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits); 305 UsageError(""); 306 UsageError(" --dump-timing: display a breakdown of where time was spent"); 307 UsageError(""); 308 UsageError(" --include-patch-information: Include patching information so the generated code"); 309 UsageError(" can have its base address moved without full recompilation."); 310 UsageError(""); 311 UsageError(" --no-include-patch-information: Do not include patching information."); 312 UsageError(""); 313 UsageError(" -g"); 314 UsageError(" --generate-debug-info: Generate debug information for native debugging,"); 315 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections."); 316 UsageError(" If used without --native-debuggable, it will be best-effort only."); 317 UsageError(" This option does not affect the generated code. (disabled by default)"); 318 UsageError(""); 319 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging."); 320 UsageError(""); 321 UsageError(" --debuggable: Produce code debuggable with Java debugger."); 322 UsageError(""); 323 UsageError(" --native-debuggable: Produce code debuggable with native debugger (like LLDB)."); 324 UsageError(" Implies --debuggable."); 325 UsageError(""); 326 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,"); 327 UsageError(" such as initial heap size, maximum heap size, and verbose output."); 328 UsageError(" Use a separate --runtime-arg switch for each argument."); 329 UsageError(" Example: --runtime-arg -Xms256m"); 330 UsageError(""); 331 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation."); 332 UsageError(" Can be specified multiple time, in which case the data from the different"); 333 UsageError(" profiles will be aggregated."); 334 UsageError(""); 335 UsageError(" --reference-profile-file=<filename>: specify a reference profile file to use when"); 336 UsageError(" compiling. The data in this file will be compared with the data in the"); 337 UsageError(" associated --profile-file and the compilation will proceed only if there is"); 338 UsageError(" a significant difference (--reference-profile-file is paired with"); 339 UsageError(" --profile-file in the natural order). If the compilation was attempted then"); 340 UsageError(" --profile-file will be merged into --reference-profile-file. Valid only when"); 341 UsageError(" specified together with --profile-file."); 342 UsageError(""); 343 UsageError(" --print-pass-names: print a list of pass names"); 344 UsageError(""); 345 UsageError(" --disable-passes=<pass-names>: disable one or more passes separated by comma."); 346 UsageError(" Example: --disable-passes=UseCount,BBOptimizations"); 347 UsageError(""); 348 UsageError(" --print-pass-options: print a list of passes that have configurable options along " 349 "with the setting."); 350 UsageError(" Will print default if no overridden setting exists."); 351 UsageError(""); 352 UsageError(" --pass-options=Pass1Name:Pass1OptionName:Pass1Option#," 353 "Pass2Name:Pass2OptionName:Pass2Option#"); 354 UsageError(" Used to specify a pass specific option. The setting itself must be integer."); 355 UsageError(" Separator used between options is a comma."); 356 UsageError(""); 357 UsageError(" --swap-file=<file-name>: specifies a file to use for swap."); 358 UsageError(" Example: --swap-file=/data/tmp/swap.001"); 359 UsageError(""); 360 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor)."); 361 UsageError(" Example: --swap-fd=10"); 362 UsageError(""); 363 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image."); 364 UsageError(" Example: --app-image-fd=10"); 365 UsageError(""); 366 UsageError(" --app-image-file=<file-name>: specify a file name for app image."); 367 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art"); 368 UsageError(""); 369 UsageError(" --multi-image: specify that separate oat and image files be generated for each " 370 "input dex file."); 371 UsageError(""); 372 std::cerr << "See log for usage error information\n"; 373 exit(EXIT_FAILURE); 374} 375 376// The primary goal of the watchdog is to prevent stuck build servers 377// during development when fatal aborts lead to a cascade of failures 378// that result in a deadlock. 379class WatchDog { 380// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks 381#undef CHECK_PTHREAD_CALL 382#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \ 383 do { \ 384 int rc = call args; \ 385 if (rc != 0) { \ 386 errno = rc; \ 387 std::string message(# call); \ 388 message += " failed for "; \ 389 message += reason; \ 390 Fatal(message); \ 391 } \ 392 } while (false) 393 394 public: 395 explicit WatchDog(bool is_watch_dog_enabled) { 396 is_watch_dog_enabled_ = is_watch_dog_enabled; 397 if (!is_watch_dog_enabled_) { 398 return; 399 } 400 shutting_down_ = false; 401 const char* reason = "dex2oat watch dog thread startup"; 402 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason); 403 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, nullptr), reason); 404 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason); 405 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason); 406 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason); 407 } 408 ~WatchDog() { 409 if (!is_watch_dog_enabled_) { 410 return; 411 } 412 const char* reason = "dex2oat watch dog thread shutdown"; 413 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason); 414 shutting_down_ = true; 415 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason); 416 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason); 417 418 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason); 419 420 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason); 421 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason); 422 } 423 424 private: 425 static void* CallBack(void* arg) { 426 WatchDog* self = reinterpret_cast<WatchDog*>(arg); 427 ::art::SetThreadName("dex2oat watch dog"); 428 self->Wait(); 429 return nullptr; 430 } 431 432 NO_RETURN static void Fatal(const std::string& message) { 433 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However, 434 // it's rather easy to hang in unwinding. 435 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around 436 // logcat logging or stderr output. 437 LogMessage::LogLine(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str()); 438 exit(1); 439 } 440 441 void Wait() { 442 // TODO: tune the multiplier for GC verification, the following is just to make the timeout 443 // large. 444 constexpr int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1; 445 timespec timeout_ts; 446 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts); 447 const char* reason = "dex2oat watch dog thread waiting"; 448 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason); 449 while (!shutting_down_) { 450 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts)); 451 if (rc == ETIMEDOUT) { 452 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds", 453 kWatchDogTimeoutSeconds)); 454 } else if (rc != 0) { 455 std::string message(StringPrintf("pthread_cond_timedwait failed: %s", 456 strerror(errno))); 457 Fatal(message.c_str()); 458 } 459 } 460 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason); 461 } 462 463 // When setting timeouts, keep in mind that the build server may not be as fast as your desktop. 464 // Debug builds are slower so they have larger timeouts. 465 static constexpr int64_t kSlowdownFactor = kIsDebugBuild ? 5U : 1U; 466 467 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager 468 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort 469 // itself before that watchdog would take down the system server. 470 static constexpr int64_t kWatchDogTimeoutSeconds = kSlowdownFactor * (9 * 60 + 30); 471 472 bool is_watch_dog_enabled_; 473 bool shutting_down_; 474 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases. 475 pthread_mutex_t mutex_; 476 pthread_cond_t cond_; 477 pthread_attr_t attr_; 478 pthread_t pthread_; 479}; 480 481static constexpr size_t kMinDexFilesForSwap = 2; 482static constexpr size_t kMinDexFileCumulativeSizeForSwap = 20 * MB; 483 484static bool UseSwap(bool is_image, std::vector<const DexFile*>& dex_files) { 485 if (is_image) { 486 // Don't use swap, we know generation should succeed, and we don't want to slow it down. 487 return false; 488 } 489 if (dex_files.size() < kMinDexFilesForSwap) { 490 // If there are less dex files than the threshold, assume it's gonna be fine. 491 return false; 492 } 493 size_t dex_files_size = 0; 494 for (const auto* dex_file : dex_files) { 495 dex_files_size += dex_file->GetHeader().file_size_; 496 } 497 return dex_files_size >= kMinDexFileCumulativeSizeForSwap; 498} 499 500class Dex2Oat FINAL { 501 public: 502 explicit Dex2Oat(TimingLogger* timings) : 503 compiler_kind_(Compiler::kOptimizing), 504 instruction_set_(kRuntimeISA), 505 // Take the default set of instruction features from the build. 506 verification_results_(nullptr), 507 method_inliner_map_(), 508 runtime_(nullptr), 509 thread_count_(sysconf(_SC_NPROCESSORS_CONF)), 510 start_ns_(NanoTime()), 511 oat_fd_(-1), 512 zip_fd_(-1), 513 image_base_(0U), 514 image_classes_zip_filename_(nullptr), 515 image_classes_filename_(nullptr), 516 image_storage_mode_(ImageHeader::kStorageModeUncompressed), 517 compiled_classes_zip_filename_(nullptr), 518 compiled_classes_filename_(nullptr), 519 compiled_methods_zip_filename_(nullptr), 520 compiled_methods_filename_(nullptr), 521 app_image_(false), 522 boot_image_(false), 523 multi_image_(false), 524 is_host_(false), 525 image_writer_(nullptr), 526 driver_(nullptr), 527 dump_stats_(false), 528 dump_passes_(false), 529 dump_timing_(false), 530 dump_slow_timing_(kIsDebugBuild), 531 dump_cfg_append_(false), 532 swap_fd_(-1), 533 app_image_fd_(kInvalidImageFd), 534 timings_(timings) {} 535 536 ~Dex2Oat() { 537 // Free opened dex files before deleting the runtime_, because ~DexFile 538 // uses MemMap, which is shut down by ~Runtime. 539 class_path_files_.clear(); 540 opened_dex_files_.clear(); 541 542 // Log completion time before deleting the runtime_, because this accesses 543 // the runtime. 544 LogCompletionTime(); 545 546 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) { 547 // We want to just exit on non-debug builds, not bringing the runtime down 548 // in an orderly fashion. So release the following fields. 549 driver_.release(); 550 image_writer_.release(); 551 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) { 552 dex_file.release(); 553 } 554 for (std::unique_ptr<File>& oat_file : oat_files_) { 555 oat_file.release(); 556 } 557 runtime_.release(); 558 verification_results_.release(); 559 key_value_store_.release(); 560 } 561 } 562 563 struct ParserOptions { 564 std::vector<const char*> oat_symbols; 565 std::string boot_image_filename; 566 bool watch_dog_enabled = true; 567 bool requested_specific_compiler = false; 568 std::string error_msg; 569 }; 570 571 void ParseZipFd(const StringPiece& option) { 572 ParseUintOption(option, "--zip-fd", &zip_fd_, Usage); 573 } 574 575 void ParseOatFd(const StringPiece& option) { 576 ParseUintOption(option, "--oat-fd", &oat_fd_, Usage); 577 } 578 579 void ParseJ(const StringPiece& option) { 580 ParseUintOption(option, "-j", &thread_count_, Usage, /* is_long_option */ false); 581 } 582 583 void ParseBase(const StringPiece& option) { 584 DCHECK(option.starts_with("--base=")); 585 const char* image_base_str = option.substr(strlen("--base=")).data(); 586 char* end; 587 image_base_ = strtoul(image_base_str, &end, 16); 588 if (end == image_base_str || *end != '\0') { 589 Usage("Failed to parse hexadecimal value for option %s", option.data()); 590 } 591 } 592 593 void ParseInstructionSet(const StringPiece& option) { 594 DCHECK(option.starts_with("--instruction-set=")); 595 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data(); 596 // StringPiece is not necessarily zero-terminated, so need to make a copy and ensure it. 597 std::unique_ptr<char[]> buf(new char[instruction_set_str.length() + 1]); 598 strncpy(buf.get(), instruction_set_str.data(), instruction_set_str.length()); 599 buf.get()[instruction_set_str.length()] = 0; 600 instruction_set_ = GetInstructionSetFromString(buf.get()); 601 // arm actually means thumb2. 602 if (instruction_set_ == InstructionSet::kArm) { 603 instruction_set_ = InstructionSet::kThumb2; 604 } 605 } 606 607 void ParseInstructionSetVariant(const StringPiece& option, ParserOptions* parser_options) { 608 DCHECK(option.starts_with("--instruction-set-variant=")); 609 StringPiece str = option.substr(strlen("--instruction-set-variant=")).data(); 610 instruction_set_features_.reset( 611 InstructionSetFeatures::FromVariant( 612 instruction_set_, str.as_string(), &parser_options->error_msg)); 613 if (instruction_set_features_.get() == nullptr) { 614 Usage("%s", parser_options->error_msg.c_str()); 615 } 616 } 617 618 void ParseInstructionSetFeatures(const StringPiece& option, ParserOptions* parser_options) { 619 DCHECK(option.starts_with("--instruction-set-features=")); 620 StringPiece str = option.substr(strlen("--instruction-set-features=")).data(); 621 if (instruction_set_features_.get() == nullptr) { 622 instruction_set_features_.reset( 623 InstructionSetFeatures::FromVariant( 624 instruction_set_, "default", &parser_options->error_msg)); 625 if (instruction_set_features_.get() == nullptr) { 626 Usage("Problem initializing default instruction set features variant: %s", 627 parser_options->error_msg.c_str()); 628 } 629 } 630 instruction_set_features_.reset( 631 instruction_set_features_->AddFeaturesFromString(str.as_string(), 632 &parser_options->error_msg)); 633 if (instruction_set_features_.get() == nullptr) { 634 Usage("Error parsing '%s': %s", option.data(), parser_options->error_msg.c_str()); 635 } 636 } 637 638 void ParseCompilerBackend(const StringPiece& option, ParserOptions* parser_options) { 639 DCHECK(option.starts_with("--compiler-backend=")); 640 parser_options->requested_specific_compiler = true; 641 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data(); 642 if (backend_str == "Quick") { 643 compiler_kind_ = Compiler::kQuick; 644 } else if (backend_str == "Optimizing") { 645 compiler_kind_ = Compiler::kOptimizing; 646 } else { 647 Usage("Unknown compiler backend: %s", backend_str.data()); 648 } 649 } 650 651 void ParseImageFormat(const StringPiece& option) { 652 const StringPiece substr("--image-format="); 653 DCHECK(option.starts_with(substr)); 654 const StringPiece format_str = option.substr(substr.length()); 655 if (format_str == "lz4") { 656 image_storage_mode_ = ImageHeader::kStorageModeLZ4; 657 } else if (format_str == "uncompressed") { 658 image_storage_mode_ = ImageHeader::kStorageModeUncompressed; 659 } else { 660 Usage("Unknown image format: %s", format_str.data()); 661 } 662 } 663 664 void ProcessOptions(ParserOptions* parser_options) { 665 boot_image_ = !image_filenames_.empty(); 666 app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty(); 667 668 if (IsAppImage() && IsBootImage()) { 669 Usage("Can't have both --image and (--app-image-fd or --app-image-file)"); 670 } 671 672 if (IsBootImage()) { 673 // We need the boot image to always be debuggable. 674 compiler_options_->debuggable_ = true; 675 } 676 677 if (oat_filenames_.empty() && oat_fd_ == -1) { 678 Usage("Output must be supplied with either --oat-file or --oat-fd"); 679 } 680 681 if (!oat_filenames_.empty() && oat_fd_ != -1) { 682 Usage("--oat-file should not be used with --oat-fd"); 683 } 684 685 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) { 686 Usage("--oat-symbols should not be used with --oat-fd"); 687 } 688 689 if (!parser_options->oat_symbols.empty() && is_host_) { 690 Usage("--oat-symbols should not be used with --host"); 691 } 692 693 if (oat_fd_ != -1 && !image_filenames_.empty()) { 694 Usage("--oat-fd should not be used with --image"); 695 } 696 697 if (!parser_options->oat_symbols.empty() && 698 parser_options->oat_symbols.size() != oat_filenames_.size()) { 699 Usage("--oat-file arguments do not match --oat-symbols arguments"); 700 } 701 702 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) { 703 Usage("--oat-file arguments do not match --image arguments"); 704 } 705 706 if (android_root_.empty()) { 707 const char* android_root_env_var = getenv("ANDROID_ROOT"); 708 if (android_root_env_var == nullptr) { 709 Usage("--android-root unspecified and ANDROID_ROOT not set"); 710 } 711 android_root_ += android_root_env_var; 712 } 713 714 if (!boot_image_ && parser_options->boot_image_filename.empty()) { 715 parser_options->boot_image_filename += android_root_; 716 parser_options->boot_image_filename += "/framework/boot.art"; 717 } 718 if (!parser_options->boot_image_filename.empty()) { 719 boot_image_filename_ = parser_options->boot_image_filename; 720 } 721 722 if (image_classes_filename_ != nullptr && !IsBootImage()) { 723 Usage("--image-classes should only be used with --image"); 724 } 725 726 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) { 727 Usage("--image-classes should not be used with --boot-image"); 728 } 729 730 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) { 731 Usage("--image-classes-zip should be used with --image-classes"); 732 } 733 734 if (compiled_classes_filename_ != nullptr && !IsBootImage()) { 735 Usage("--compiled-classes should only be used with --image"); 736 } 737 738 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) { 739 Usage("--compiled-classes should not be used with --boot-image"); 740 } 741 742 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) { 743 Usage("--compiled-classes-zip should be used with --compiled-classes"); 744 } 745 746 if (dex_filenames_.empty() && zip_fd_ == -1) { 747 Usage("Input must be supplied with either --dex-file or --zip-fd"); 748 } 749 750 if (!dex_filenames_.empty() && zip_fd_ != -1) { 751 Usage("--dex-file should not be used with --zip-fd"); 752 } 753 754 if (!dex_filenames_.empty() && !zip_location_.empty()) { 755 Usage("--dex-file should not be used with --zip-location"); 756 } 757 758 if (dex_locations_.empty()) { 759 for (const char* dex_file_name : dex_filenames_) { 760 dex_locations_.push_back(dex_file_name); 761 } 762 } else if (dex_locations_.size() != dex_filenames_.size()) { 763 Usage("--dex-location arguments do not match --dex-file arguments"); 764 } 765 766 if (!dex_filenames_.empty() && !oat_filenames_.empty()) { 767 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) { 768 Usage("--oat-file arguments must be singular or match --dex-file arguments"); 769 } 770 } 771 772 if (zip_fd_ != -1 && zip_location_.empty()) { 773 Usage("--zip-location should be supplied with --zip-fd"); 774 } 775 776 if (boot_image_filename_.empty()) { 777 if (image_base_ == 0) { 778 Usage("Non-zero --base not specified"); 779 } 780 } 781 782 if (!profile_files_.empty()) { 783 if (!reference_profile_files_.empty() && 784 (reference_profile_files_.size() != profile_files_.size())) { 785 Usage("If specified, --reference-profile-file should match the number of --profile-file."); 786 } 787 } 788 789 if (!parser_options->oat_symbols.empty()) { 790 oat_unstripped_ = std::move(parser_options->oat_symbols); 791 } 792 793 // If no instruction set feature was given, use the default one for the target 794 // instruction set. 795 if (instruction_set_features_.get() == nullptr) { 796 instruction_set_features_.reset( 797 InstructionSetFeatures::FromVariant( 798 instruction_set_, "default", &parser_options->error_msg)); 799 if (instruction_set_features_.get() == nullptr) { 800 Usage("Problem initializing default instruction set features variant: %s", 801 parser_options->error_msg.c_str()); 802 } 803 } 804 805 if (instruction_set_ == kRuntimeISA) { 806 std::unique_ptr<const InstructionSetFeatures> runtime_features( 807 InstructionSetFeatures::FromCppDefines()); 808 if (!instruction_set_features_->Equals(runtime_features.get())) { 809 LOG(WARNING) << "Mismatch between dex2oat instruction set features (" 810 << *instruction_set_features_ << ") and those of dex2oat executable (" 811 << *runtime_features <<") for the command line:\n" 812 << CommandLine(); 813 } 814 } 815 816 // It they are not set, use default values for inlining settings. 817 // TODO: We should rethink the compiler filter. We mostly save 818 // time here, which is orthogonal to space. 819 if (compiler_options_->inline_depth_limit_ == CompilerOptions::kUnsetInlineDepthLimit) { 820 compiler_options_->inline_depth_limit_ = 821 (compiler_options_->compiler_filter_ == CompilerOptions::kSpace) 822 // Implementation of the space filter: limit inlining depth. 823 ? CompilerOptions::kSpaceFilterInlineDepthLimit 824 : CompilerOptions::kDefaultInlineDepthLimit; 825 } 826 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) { 827 compiler_options_->inline_max_code_units_ = 828 (compiler_options_->compiler_filter_ == CompilerOptions::kSpace) 829 // Implementation of the space filter: limit inlining max code units. 830 ? CompilerOptions::kSpaceFilterInlineMaxCodeUnits 831 : CompilerOptions::kDefaultInlineMaxCodeUnits; 832 } 833 834 // Checks are all explicit until we know the architecture. 835 // Set the compilation target's implicit checks options. 836 switch (instruction_set_) { 837 case kArm: 838 case kThumb2: 839 case kArm64: 840 case kX86: 841 case kX86_64: 842 case kMips: 843 case kMips64: 844 compiler_options_->implicit_null_checks_ = true; 845 compiler_options_->implicit_so_checks_ = true; 846 break; 847 848 default: 849 // Defaults are correct. 850 break; 851 } 852 853 compiler_options_->verbose_methods_ = verbose_methods_.empty() ? nullptr : &verbose_methods_; 854 855 if (!IsBootImage() && multi_image_) { 856 Usage("--multi-image can only be used when creating boot images"); 857 } 858 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) { 859 Usage("--multi-image cannot be used with multiple image names"); 860 } 861 862 // For now, if we're on the host and compile the boot image, *always* use multiple image files. 863 if (!kIsTargetBuild && IsBootImage()) { 864 if (image_filenames_.size() == 1) { 865 multi_image_ = true; 866 } 867 } 868 869 // Done with usage checks, enable watchdog if requested 870 if (parser_options->watch_dog_enabled) { 871 watchdog_.reset(new WatchDog(true)); 872 } 873 874 // Fill some values into the key-value store for the oat header. 875 key_value_store_.reset(new SafeMap<std::string, std::string>()); 876 } 877 878 void ExpandOatAndImageFilenames() { 879 std::string base_oat = oat_filenames_[0]; 880 size_t last_oat_slash = base_oat.rfind('/'); 881 if (last_oat_slash == std::string::npos) { 882 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str()); 883 } 884 // We also need to honor path components that were encoded through '@'. Otherwise the loading 885 // code won't be able to find the images. 886 if (base_oat.find('@', last_oat_slash) != std::string::npos) { 887 last_oat_slash = base_oat.rfind('@'); 888 } 889 base_oat = base_oat.substr(0, last_oat_slash + 1); 890 891 std::string base_img = image_filenames_[0]; 892 size_t last_img_slash = base_img.rfind('/'); 893 if (last_img_slash == std::string::npos) { 894 Usage("--multi-image used with unusable image filename %s", base_img.c_str()); 895 } 896 // We also need to honor path components that were encoded through '@'. Otherwise the loading 897 // code won't be able to find the images. 898 if (base_img.find('@', last_img_slash) != std::string::npos) { 899 last_img_slash = base_img.rfind('@'); 900 } 901 902 // Get the prefix, which is the primary image name (without path components). Strip the 903 // extension. 904 std::string prefix = base_img.substr(last_img_slash + 1); 905 if (prefix.rfind('.') != std::string::npos) { 906 prefix = prefix.substr(0, prefix.rfind('.')); 907 } 908 if (!prefix.empty()) { 909 prefix = prefix + "-"; 910 } 911 912 base_img = base_img.substr(0, last_img_slash + 1); 913 914 // Note: we have some special case here for our testing. We have to inject the differentiating 915 // parts for the different core images. 916 std::string infix; // Empty infix by default. 917 { 918 // Check the first name. 919 std::string dex_file = oat_filenames_[0]; 920 size_t last_dex_slash = dex_file.rfind('/'); 921 if (last_dex_slash != std::string::npos) { 922 dex_file = dex_file.substr(last_dex_slash + 1); 923 } 924 size_t last_dex_dot = dex_file.rfind('.'); 925 if (last_dex_dot != std::string::npos) { 926 dex_file = dex_file.substr(0, last_dex_dot); 927 } 928 if (StartsWith(dex_file, "core-")) { 929 infix = dex_file.substr(strlen("core")); 930 } 931 } 932 933 // Now create the other names. Use a counted loop to skip the first one. 934 for (size_t i = 1; i < dex_locations_.size(); ++i) { 935 // TODO: Make everything properly std::string. 936 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art"); 937 char_backing_storage_.push_back(base_img + image_name); 938 image_filenames_.push_back((char_backing_storage_.end() - 1)->c_str()); 939 940 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat"); 941 char_backing_storage_.push_back(base_oat + oat_name); 942 oat_filenames_.push_back((char_backing_storage_.end() - 1)->c_str()); 943 } 944 } 945 946 // Modify the input string in the following way: 947 // 0) Assume input is /a/b/c.d 948 // 1) Strip the path -> c.d 949 // 2) Inject prefix p -> pc.d 950 // 3) Inject infix i -> pci.d 951 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s 952 static std::string CreateMultiImageName(std::string in, 953 const std::string& prefix, 954 const std::string& infix, 955 const char* replace_suffix) { 956 size_t last_dex_slash = in.rfind('/'); 957 if (last_dex_slash != std::string::npos) { 958 in = in.substr(last_dex_slash + 1); 959 } 960 if (!prefix.empty()) { 961 in = prefix + in; 962 } 963 if (!infix.empty()) { 964 // Inject infix. 965 size_t last_dot = in.rfind('.'); 966 if (last_dot != std::string::npos) { 967 in.insert(last_dot, infix); 968 } 969 } 970 if (EndsWith(in, ".jar")) { 971 in = in.substr(0, in.length() - strlen(".jar")) + 972 (replace_suffix != nullptr ? replace_suffix : ""); 973 } 974 return in; 975 } 976 977 void InsertCompileOptions(int argc, char** argv) { 978 std::ostringstream oss; 979 for (int i = 0; i < argc; ++i) { 980 if (i > 0) { 981 oss << ' '; 982 } 983 oss << argv[i]; 984 } 985 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str()); 986 oss.str(""); // Reset. 987 oss << kRuntimeISA; 988 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str()); 989 key_value_store_->Put( 990 OatHeader::kPicKey, 991 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue); 992 key_value_store_->Put( 993 OatHeader::kDebuggableKey, 994 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue); 995 } 996 997 // Parse the arguments from the command line. In case of an unrecognized option or impossible 998 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method 999 // returns, arguments have been successfully parsed. 1000 void ParseArgs(int argc, char** argv) { 1001 original_argc = argc; 1002 original_argv = argv; 1003 1004 InitLogging(argv); 1005 1006 // Skip over argv[0]. 1007 argv++; 1008 argc--; 1009 1010 if (argc == 0) { 1011 Usage("No arguments specified"); 1012 } 1013 1014 std::unique_ptr<ParserOptions> parser_options(new ParserOptions()); 1015 compiler_options_.reset(new CompilerOptions()); 1016 1017 for (int i = 0; i < argc; i++) { 1018 const StringPiece option(argv[i]); 1019 const bool log_options = false; 1020 if (log_options) { 1021 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i]; 1022 } 1023 if (option.starts_with("--dex-file=")) { 1024 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data()); 1025 } else if (option.starts_with("--dex-location=")) { 1026 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data()); 1027 } else if (option.starts_with("--zip-fd=")) { 1028 ParseZipFd(option); 1029 } else if (option.starts_with("--zip-location=")) { 1030 zip_location_ = option.substr(strlen("--zip-location=")).data(); 1031 } else if (option.starts_with("--oat-file=")) { 1032 oat_filenames_.push_back(option.substr(strlen("--oat-file=")).data()); 1033 } else if (option.starts_with("--oat-symbols=")) { 1034 parser_options->oat_symbols.push_back(option.substr(strlen("--oat-symbols=")).data()); 1035 } else if (option.starts_with("--oat-fd=")) { 1036 ParseOatFd(option); 1037 } else if (option == "--watch-dog") { 1038 parser_options->watch_dog_enabled = true; 1039 } else if (option == "--no-watch-dog") { 1040 parser_options->watch_dog_enabled = false; 1041 } else if (option.starts_with("-j")) { 1042 ParseJ(option); 1043 } else if (option.starts_with("--oat-location=")) { 1044 oat_location_ = option.substr(strlen("--oat-location=")).data(); 1045 } else if (option.starts_with("--image=")) { 1046 image_filenames_.push_back(option.substr(strlen("--image=")).data()); 1047 } else if (option.starts_with("--image-classes=")) { 1048 image_classes_filename_ = option.substr(strlen("--image-classes=")).data(); 1049 } else if (option.starts_with("--image-classes-zip=")) { 1050 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data(); 1051 } else if (option.starts_with("--image-format=")) { 1052 ParseImageFormat(option); 1053 } else if (option.starts_with("--compiled-classes=")) { 1054 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data(); 1055 } else if (option.starts_with("--compiled-classes-zip=")) { 1056 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data(); 1057 } else if (option.starts_with("--compiled-methods=")) { 1058 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data(); 1059 } else if (option.starts_with("--compiled-methods-zip=")) { 1060 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data(); 1061 } else if (option.starts_with("--base=")) { 1062 ParseBase(option); 1063 } else if (option.starts_with("--boot-image=")) { 1064 parser_options->boot_image_filename = option.substr(strlen("--boot-image=")).data(); 1065 } else if (option.starts_with("--android-root=")) { 1066 android_root_ = option.substr(strlen("--android-root=")).data(); 1067 } else if (option.starts_with("--instruction-set=")) { 1068 ParseInstructionSet(option); 1069 } else if (option.starts_with("--instruction-set-variant=")) { 1070 ParseInstructionSetVariant(option, parser_options.get()); 1071 } else if (option.starts_with("--instruction-set-features=")) { 1072 ParseInstructionSetFeatures(option, parser_options.get()); 1073 } else if (option.starts_with("--compiler-backend=")) { 1074 ParseCompilerBackend(option, parser_options.get()); 1075 } else if (option.starts_with("--profile-file=")) { 1076 profile_files_.push_back(option.substr(strlen("--profile-file=")).ToString()); 1077 } else if (option.starts_with("--reference-profile-file=")) { 1078 reference_profile_files_.push_back( 1079 option.substr(strlen("--reference-profile-file=")).ToString()); 1080 } else if (option == "--no-profile-file") { 1081 // No profile 1082 } else if (option == "--host") { 1083 is_host_ = true; 1084 } else if (option == "--runtime-arg") { 1085 if (++i >= argc) { 1086 Usage("Missing required argument for --runtime-arg"); 1087 } 1088 if (log_options) { 1089 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i]; 1090 } 1091 runtime_args_.push_back(argv[i]); 1092 } else if (option == "--dump-timing") { 1093 dump_timing_ = true; 1094 } else if (option == "--dump-passes") { 1095 dump_passes_ = true; 1096 } else if (option.starts_with("--dump-cfg=")) { 1097 dump_cfg_file_name_ = option.substr(strlen("--dump-cfg=")).data(); 1098 } else if (option.starts_with("--dump-cfg-append")) { 1099 dump_cfg_append_ = true; 1100 } else if (option == "--dump-stats") { 1101 dump_stats_ = true; 1102 } else if (option.starts_with("--swap-file=")) { 1103 swap_file_name_ = option.substr(strlen("--swap-file=")).data(); 1104 } else if (option.starts_with("--swap-fd=")) { 1105 ParseUintOption(option, "--swap-fd", &swap_fd_, Usage); 1106 } else if (option.starts_with("--app-image-file=")) { 1107 app_image_file_name_ = option.substr(strlen("--app-image-file=")).data(); 1108 } else if (option.starts_with("--app-image-fd=")) { 1109 ParseUintOption(option, "--app-image-fd", &app_image_fd_, Usage); 1110 } else if (option.starts_with("--verbose-methods=")) { 1111 // TODO: rather than switch off compiler logging, make all VLOG(compiler) messages 1112 // conditional on having verbost methods. 1113 gLogVerbosity.compiler = false; 1114 Split(option.substr(strlen("--verbose-methods=")).ToString(), ',', &verbose_methods_); 1115 } else if (option == "--multi-image") { 1116 multi_image_ = true; 1117 } else if (option.starts_with("--no-inline-from=")) { 1118 no_inline_from_string_ = option.substr(strlen("--no-inline-from=")).data(); 1119 } else if (!compiler_options_->ParseCompilerOption(option, Usage)) { 1120 Usage("Unknown argument %s", option.data()); 1121 } 1122 } 1123 1124 ProcessOptions(parser_options.get()); 1125 1126 // Insert some compiler things. 1127 InsertCompileOptions(argc, argv); 1128 } 1129 1130 // Check whether the oat output files are writable, and open them for later. Also open a swap 1131 // file, if a name is given. 1132 bool OpenFile() { 1133 // Expand oat and image filenames for multi image. 1134 if (IsBootImage() && multi_image_) { 1135 ExpandOatAndImageFilenames(); 1136 } 1137 1138 bool create_file = oat_fd_ == -1; // as opposed to using open file descriptor 1139 if (create_file) { 1140 for (const char* oat_filename : oat_filenames_) { 1141 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename)); 1142 if (oat_file.get() == nullptr) { 1143 PLOG(ERROR) << "Failed to create oat file: " << oat_filename; 1144 return false; 1145 } 1146 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) { 1147 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename; 1148 oat_file->Erase(); 1149 return false; 1150 } 1151 oat_files_.push_back(std::move(oat_file)); 1152 } 1153 } else { 1154 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, true)); 1155 oat_file->DisableAutoClose(); 1156 if (oat_file->SetLength(0) != 0) { 1157 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed."; 1158 } 1159 if (oat_file.get() == nullptr) { 1160 PLOG(ERROR) << "Failed to create oat file: " << oat_location_; 1161 return false; 1162 } 1163 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) { 1164 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_location_; 1165 oat_file->Erase(); 1166 return false; 1167 } 1168 oat_filenames_.push_back(oat_location_.c_str()); 1169 oat_files_.push_back(std::move(oat_file)); 1170 } 1171 1172 // Swap file handling. 1173 // 1174 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file 1175 // that we can use for swap. 1176 // 1177 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We 1178 // will immediately unlink to satisfy the swap fd assumption. 1179 if (swap_fd_ == -1 && !swap_file_name_.empty()) { 1180 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str())); 1181 if (swap_file.get() == nullptr) { 1182 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_; 1183 return false; 1184 } 1185 swap_fd_ = swap_file->Fd(); 1186 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately. 1187 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be 1188 // released immediately. 1189 unlink(swap_file_name_.c_str()); 1190 } 1191 1192 // If we use a swap file, ensure we are above the threshold to make it necessary. 1193 if (swap_fd_ != -1) { 1194 if (!UseSwap(IsBootImage(), dex_files_)) { 1195 close(swap_fd_); 1196 swap_fd_ = -1; 1197 VLOG(compiler) << "Decided to run without swap."; 1198 } else { 1199 LOG(INFO) << "Large app, accepted running with swap."; 1200 } 1201 } 1202 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that. 1203 1204 // Organize inputs, handling multi-dex and multiple oat file outputs. 1205 CreateDexOatMappings(); 1206 1207 return true; 1208 } 1209 1210 void EraseOatFiles() { 1211 for (size_t i = 0; i < oat_files_.size(); ++i) { 1212 DCHECK(oat_files_[i].get() != nullptr); 1213 oat_files_[i]->Erase(); 1214 oat_files_[i].reset(); 1215 } 1216 } 1217 1218 void Shutdown() { 1219 ScopedObjectAccess soa(Thread::Current()); 1220 for (jobject dex_cache : dex_caches_) { 1221 soa.Env()->DeleteLocalRef(dex_cache); 1222 } 1223 dex_caches_.clear(); 1224 } 1225 1226 // Set up the environment for compilation. Includes starting the runtime and loading/opening the 1227 // boot class path. 1228 bool Setup() { 1229 TimingLogger::ScopedTiming t("dex2oat Setup", timings_); 1230 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap. 1231 1232 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods()) { 1233 return false; 1234 } 1235 1236 verification_results_.reset(new VerificationResults(compiler_options_.get())); 1237 callbacks_.reset(new QuickCompilerCallbacks( 1238 verification_results_.get(), 1239 &method_inliner_map_, 1240 IsBootImage() ? 1241 CompilerCallbacks::CallbackMode::kCompileBootImage : 1242 CompilerCallbacks::CallbackMode::kCompileApp)); 1243 1244 RuntimeArgumentMap runtime_options; 1245 if (!PrepareRuntimeOptions(&runtime_options)) { 1246 return false; 1247 } 1248 1249 { 1250 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_); 1251 if (!CreateRuntime(std::move(runtime_options))) { 1252 return false; 1253 } 1254 } 1255 1256 // Runtime::Create acquired the mutator_lock_ that is normally given away when we 1257 // Runtime::Start, give it away now so that we don't starve GC. 1258 Thread* self = Thread::Current(); 1259 self->TransitionFromRunnableToSuspended(kNative); 1260 // If we're doing the image, override the compiler filter to force full compilation. Must be 1261 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force 1262 // compilation of class initializers. 1263 // Whilst we're in native take the opportunity to initialize well known classes. 1264 WellKnownClasses::Init(self->GetJniEnv()); 1265 1266 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker(); 1267 if (boot_image_filename_.empty()) { 1268 dex_files_ = class_linker->GetBootClassPath(); 1269 // Prune invalid dex locations. 1270 for (size_t i = 0; i < dex_locations_.size(); i++) { 1271 const char* dex_location = dex_locations_[i]; 1272 bool contains = false; 1273 for (const DexFile* dex_file : dex_files_) { 1274 if (strcmp(dex_location, dex_file->GetLocation().c_str()) == 0) { 1275 contains = true; 1276 break; 1277 } 1278 } 1279 if (!contains) { 1280 dex_locations_.erase(dex_locations_.begin() + i); 1281 i--; 1282 } 1283 } 1284 } else { 1285 TimingLogger::ScopedTiming t_dex("Opening dex files", timings_); 1286 if (dex_filenames_.empty()) { 1287 ATRACE_BEGIN("Opening zip archive from file descriptor"); 1288 std::string error_msg; 1289 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::OpenFromFd(zip_fd_, 1290 zip_location_.c_str(), 1291 &error_msg)); 1292 if (zip_archive.get() == nullptr) { 1293 LOG(ERROR) << "Failed to open zip from file descriptor for '" << zip_location_ << "': " 1294 << error_msg; 1295 return false; 1296 } 1297 if (!DexFile::OpenFromZip(*zip_archive.get(), zip_location_, &error_msg, &opened_dex_files_)) { 1298 LOG(ERROR) << "Failed to open dex from file descriptor for zip file '" << zip_location_ 1299 << "': " << error_msg; 1300 return false; 1301 } 1302 for (auto& dex_file : opened_dex_files_) { 1303 dex_files_.push_back(dex_file.get()); 1304 } 1305 ATRACE_END(); 1306 } else { 1307 size_t failure_count = OpenDexFiles(dex_filenames_, dex_locations_, &opened_dex_files_); 1308 if (failure_count > 0) { 1309 LOG(ERROR) << "Failed to open some dex files: " << failure_count; 1310 return false; 1311 } 1312 for (auto& dex_file : opened_dex_files_) { 1313 dex_files_.push_back(dex_file.get()); 1314 } 1315 } 1316 1317 constexpr bool kSaveDexInput = false; 1318 if (kSaveDexInput) { 1319 SaveDexInput(); 1320 } 1321 } 1322 // Ensure opened dex files are writable for dex-to-dex transformations. Also ensure that 1323 // the dex caches stay live since we don't want class unloading to occur during compilation. 1324 for (const auto& dex_file : dex_files_) { 1325 if (!dex_file->EnableWrite()) { 1326 PLOG(ERROR) << "Failed to make .dex file writeable '" << dex_file->GetLocation() << "'\n"; 1327 } 1328 ScopedObjectAccess soa(self); 1329 dex_caches_.push_back(soa.AddLocalReference<jobject>( 1330 class_linker->RegisterDexFile(*dex_file, Runtime::Current()->GetLinearAlloc()))); 1331 dex_file->CreateTypeLookupTable(); 1332 } 1333 1334 /* 1335 * If we're not in interpret-only or verify-none mode, go ahead and compile small applications. 1336 * Don't bother to check if we're doing the image. 1337 */ 1338 if (!IsBootImage() && 1339 compiler_options_->IsCompilationEnabled() && 1340 compiler_kind_ == Compiler::kQuick) { 1341 size_t num_methods = 0; 1342 for (size_t i = 0; i != dex_files_.size(); ++i) { 1343 const DexFile* dex_file = dex_files_[i]; 1344 CHECK(dex_file != nullptr); 1345 num_methods += dex_file->NumMethodIds(); 1346 } 1347 if (num_methods <= compiler_options_->GetNumDexMethodsThreshold()) { 1348 compiler_options_->SetCompilerFilter(CompilerOptions::kSpeed); 1349 VLOG(compiler) << "Below method threshold, compiling anyways"; 1350 } 1351 } 1352 1353 return true; 1354 } 1355 1356 void CreateDexOatMappings() { 1357 if (oat_files_.size() > 1) { 1358 size_t index = 0; 1359 for (size_t i = 0; i < oat_files_.size(); ++i) { 1360 std::vector<const DexFile*> dex_files; 1361 if (index < dex_files_.size()) { 1362 dex_files.push_back(dex_files_[index]); 1363 dex_file_oat_filename_map_.emplace(dex_files_[index], oat_filenames_[i]); 1364 index++; 1365 while (index < dex_files_.size() && 1366 (dex_files_[index]->GetBaseLocation() == dex_files_[index - 1]->GetBaseLocation())) { 1367 dex_file_oat_filename_map_.emplace(dex_files_[index], oat_filenames_[i]); 1368 dex_files.push_back(dex_files_[index]); 1369 index++; 1370 } 1371 } 1372 dex_files_per_oat_file_.push_back(std::move(dex_files)); 1373 } 1374 } else { 1375 dex_files_per_oat_file_.push_back(dex_files_); 1376 for (const DexFile* dex_file : dex_files_) { 1377 dex_file_oat_filename_map_.emplace(dex_file, oat_filenames_[0]); 1378 } 1379 } 1380 } 1381 1382 // Create and invoke the compiler driver. This will compile all the dex files. 1383 void Compile() { 1384 TimingLogger::ScopedTiming t("dex2oat Compile", timings_); 1385 compiler_phases_timings_.reset(new CumulativeLogger("compilation times")); 1386 1387 // Handle and ClassLoader creation needs to come after Runtime::Create 1388 jobject class_loader = nullptr; 1389 Thread* self = Thread::Current(); 1390 1391 if (!boot_image_filename_.empty()) { 1392 ClassLinker* class_linker = Runtime::Current()->GetClassLinker(); 1393 OpenClassPathFiles(runtime_->GetClassPathString(), dex_files_, &class_path_files_); 1394 ScopedObjectAccess soa(self); 1395 1396 // Classpath: first the class-path given. 1397 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_); 1398 1399 // Store the classpath we have right now. 1400 key_value_store_->Put(OatHeader::kClassPathKey, 1401 OatFile::EncodeDexFileDependencies(class_path_files)); 1402 1403 // Then the dex files we'll compile. Thus we'll resolve the class-path first. 1404 class_path_files.insert(class_path_files.end(), dex_files_.begin(), dex_files_.end()); 1405 1406 class_loader = class_linker->CreatePathClassLoader(self, class_path_files); 1407 } 1408 1409 // Find the dex file we should not inline from. 1410 1411 // For now, on the host always have core-oj removed. 1412 if (!kIsTargetBuild && no_inline_from_string_.empty()) { 1413 no_inline_from_string_ = "core-oj"; 1414 } 1415 1416 if (!no_inline_from_string_.empty()) { 1417 ClassLinker* class_linker = Runtime::Current()->GetClassLinker(); 1418 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_); 1419 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = { 1420 &class_linker->GetBootClassPath(), 1421 &class_path_files, 1422 &dex_files_ 1423 }; 1424 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) { 1425 if (dex_file_vector == nullptr) { 1426 continue; 1427 } 1428 1429 bool found = false; 1430 1431 for (const DexFile* dex_file : *dex_file_vector) { 1432 // Try the complete location first. 1433 found = no_inline_from_string_ == dex_file->GetLocation(); 1434 // The try just the name. 1435 if (!found) { 1436 size_t last_slash = dex_file->GetLocation().rfind('/'); 1437 if (last_slash != std::string::npos) { 1438 found = StartsWith(dex_file->GetLocation().substr(last_slash + 1), 1439 no_inline_from_string_.c_str()); 1440 } 1441 } 1442 1443 if (found) { 1444 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation(); 1445 compiler_options_->no_inline_from_ = dex_file; 1446 break; 1447 } 1448 } 1449 1450 if (found) { 1451 break; 1452 } 1453 } 1454 } 1455 1456 if (IsBootImage() && image_filenames_.size() > 1) { 1457 // If we're compiling the boot image, store the boot classpath into the Key-Value store. If 1458 // the image filename was adapted (e.g., for our tests), we need to change this here, too, but 1459 // need to strip all path components (they will be re-established when loading). 1460 // We need this for the multi-image case. 1461 std::ostringstream bootcp_oss; 1462 bool first_bootcp = true; 1463 for (size_t i = 0; i < dex_locations_.size(); ++i) { 1464 if (!first_bootcp) { 1465 bootcp_oss << ":"; 1466 } 1467 1468 std::string dex_loc = dex_locations_[i]; 1469 std::string image_filename = image_filenames_[i]; 1470 1471 // Use the dex_loc path, but the image_filename name (without path elements). 1472 size_t dex_last_slash = dex_loc.rfind('/'); 1473 1474 // npos is max(size_t). That makes this a bit ugly. 1475 size_t image_last_slash = image_filename.rfind('/'); 1476 size_t image_last_at = image_filename.rfind('@'); 1477 size_t image_last_sep = (image_last_slash == std::string::npos) 1478 ? image_last_at 1479 : (image_last_at == std::string::npos) 1480 ? std::string::npos 1481 : std::max(image_last_slash, image_last_at); 1482 // Note: whenever image_last_sep == npos, +1 overflow means using the full string. 1483 1484 if (dex_last_slash == std::string::npos) { 1485 dex_loc = image_filename.substr(image_last_sep + 1); 1486 } else { 1487 dex_loc = dex_loc.substr(0, dex_last_slash + 1) + 1488 image_filename.substr(image_last_sep + 1); 1489 } 1490 1491 // Image filenames already end with .art, no need to replace. 1492 1493 bootcp_oss << dex_loc; 1494 first_bootcp = false; 1495 } 1496 key_value_store_->Put(OatHeader::kBootClassPath, bootcp_oss.str()); 1497 } 1498 1499 driver_.reset(new CompilerDriver(compiler_options_.get(), 1500 verification_results_.get(), 1501 &method_inliner_map_, 1502 compiler_kind_, 1503 instruction_set_, 1504 instruction_set_features_.get(), 1505 IsBootImage(), 1506 image_classes_.release(), 1507 compiled_classes_.release(), 1508 nullptr, 1509 thread_count_, 1510 dump_stats_, 1511 dump_passes_, 1512 dump_cfg_file_name_, 1513 dump_cfg_append_, 1514 compiler_phases_timings_.get(), 1515 swap_fd_, 1516 &dex_file_oat_filename_map_, 1517 profile_compilation_info_.get())); 1518 driver_->SetDexFilesForOatFile(dex_files_); 1519 driver_->CompileAll(class_loader, dex_files_, timings_); 1520 } 1521 1522 // Notes on the interleaving of creating the images and oat files to 1523 // ensure the references between the two are correct. 1524 // 1525 // Currently we have a memory layout that looks something like this: 1526 // 1527 // +--------------+ 1528 // | images | 1529 // +--------------+ 1530 // | oat files | 1531 // +--------------+ 1532 // | alloc spaces | 1533 // +--------------+ 1534 // 1535 // There are several constraints on the loading of the images and oat files. 1536 // 1537 // 1. The images are expected to be loaded at an absolute address and 1538 // contain Objects with absolute pointers within the images. 1539 // 1540 // 2. There are absolute pointers from Methods in the images to their 1541 // code in the oat files. 1542 // 1543 // 3. There are absolute pointers from the code in the oat files to Methods 1544 // in the images. 1545 // 1546 // 4. There are absolute pointers from code in the oat files to other code 1547 // in the oat files. 1548 // 1549 // To get this all correct, we go through several steps. 1550 // 1551 // 1. We prepare offsets for all data in the oat files and calculate 1552 // the oat data size and code size. During this stage, we also set 1553 // oat code offsets in methods for use by the image writer. 1554 // 1555 // 2. We prepare offsets for the objects in the images and calculate 1556 // the image sizes. 1557 // 1558 // 3. We create the oat files. Originally this was just our own proprietary 1559 // file but now it is contained within an ELF dynamic object (aka an .so 1560 // file). Since we know the image sizes and oat data sizes and code sizes we 1561 // can prepare the ELF headers and we then know the ELF memory segment 1562 // layout and we can now resolve all references. The compiler provides 1563 // LinkerPatch information in each CompiledMethod and we resolve these, 1564 // using the layout information and image object locations provided by 1565 // image writer, as we're writing the method code. 1566 // 1567 // 4. We create the image files. They need to know where the oat files 1568 // will be loaded after itself. Originally oat files were simply 1569 // memory mapped so we could predict where their contents were based 1570 // on the file size. Now that they are ELF files, we need to inspect 1571 // the ELF files to understand the in memory segment layout including 1572 // where the oat header is located within. 1573 // TODO: We could just remember this information from step 3. 1574 // 1575 // 5. We fixup the ELF program headers so that dlopen will try to 1576 // load the .so at the desired location at runtime by offsetting the 1577 // Elf32_Phdr.p_vaddr values by the desired base address. 1578 // TODO: Do this in step 3. We already know the layout there. 1579 // 1580 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5. 1581 // are done by the CreateImageFile() below. 1582 1583 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the 1584 // ImageWriter, if necessary. 1585 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure 1586 // case (when the file will be explicitly erased). 1587 bool CreateOatFiles() { 1588 CHECK(key_value_store_.get() != nullptr); 1589 1590 TimingLogger::ScopedTiming t("dex2oat Oat", timings_); 1591 1592 std::vector<std::unique_ptr<OatWriter>> oat_writers; 1593 { 1594 TimingLogger::ScopedTiming t2("dex2oat OatWriter", timings_); 1595 std::string image_file_location; 1596 uint32_t image_file_location_oat_checksum = 0; 1597 uintptr_t image_file_location_oat_data_begin = 0; 1598 int32_t image_patch_delta = 0; 1599 1600 if (app_image_ && image_base_ == 0) { 1601 std::vector<gc::space::ImageSpace*> image_spaces = 1602 Runtime::Current()->GetHeap()->GetBootImageSpaces(); 1603 for (gc::space::ImageSpace* image_space : image_spaces) { 1604 image_base_ = std::max(image_base_, RoundUp( 1605 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()), 1606 kPageSize)); 1607 } 1608 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_); 1609 } 1610 1611 if (IsImage()) { 1612 PrepareImageWriter(image_base_); 1613 } 1614 1615 if (!IsBootImage()) { 1616 TimingLogger::ScopedTiming t3("Loading image checksum", timings_); 1617 std::vector<gc::space::ImageSpace*> image_spaces = 1618 Runtime::Current()->GetHeap()->GetBootImageSpaces(); 1619 image_file_location_oat_checksum = image_spaces[0]->GetImageHeader().GetOatChecksum(); 1620 image_file_location_oat_data_begin = 1621 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin()); 1622 image_patch_delta = image_spaces[0]->GetImageHeader().GetPatchDelta(); 1623 std::vector<std::string> image_filenames; 1624 for (const gc::space::ImageSpace* image_space : image_spaces) { 1625 image_filenames.push_back(image_space->GetImageFilename()); 1626 } 1627 image_file_location = Join(image_filenames, ':'); 1628 } 1629 1630 if (!image_file_location.empty()) { 1631 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location); 1632 } 1633 1634 for (size_t i = 0; i < oat_files_.size(); ++i) { 1635 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i]; 1636 std::unique_ptr<OatWriter> oat_writer(new OatWriter(dex_files, 1637 image_file_location_oat_checksum, 1638 image_file_location_oat_data_begin, 1639 image_patch_delta, 1640 driver_.get(), 1641 image_writer_.get(), 1642 IsBootImage(), 1643 timings_, 1644 key_value_store_.get())); 1645 oat_writers.push_back(std::move(oat_writer)); 1646 } 1647 } 1648 1649 if (IsImage()) { 1650 // The OatWriter constructor has already updated offsets in methods and we need to 1651 // prepare method offsets in the image address space for direct method patching. 1652 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_); 1653 if (!image_writer_->PrepareImageAddressSpace()) { 1654 LOG(ERROR) << "Failed to prepare image address space."; 1655 return false; 1656 } 1657 } 1658 1659 { 1660 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_); 1661 for (size_t i = 0; i < oat_files_.size(); ++i) { 1662 std::unique_ptr<File>& oat_file = oat_files_[i]; 1663 std::unique_ptr<OatWriter>& oat_writer = oat_writers[i]; 1664 std::unique_ptr<ElfWriter> elf_writer = 1665 CreateElfWriterQuick(instruction_set_, compiler_options_.get(), oat_file.get()); 1666 1667 elf_writer->Start(); 1668 1669 OutputStream* rodata = elf_writer->StartRoData(); 1670 if (!oat_writer->WriteRodata(rodata)) { 1671 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath(); 1672 return false; 1673 } 1674 elf_writer->EndRoData(rodata); 1675 1676 OutputStream* text = elf_writer->StartText(); 1677 if (!oat_writer->WriteCode(text)) { 1678 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath(); 1679 return false; 1680 } 1681 elf_writer->EndText(text); 1682 1683 elf_writer->SetBssSize(oat_writer->GetBssSize()); 1684 elf_writer->WriteDynamicSection(); 1685 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo()); 1686 elf_writer->WritePatchLocations(oat_writer->GetAbsolutePatchLocations()); 1687 1688 if (!elf_writer->End()) { 1689 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath(); 1690 return false; 1691 } 1692 1693 // Flush the oat file. 1694 if (oat_files_[i] != nullptr) { 1695 if (oat_files_[i]->Flush() != 0) { 1696 PLOG(ERROR) << "Failed to flush oat file: " << oat_filenames_[i]; 1697 oat_files_[i]->Erase(); 1698 return false; 1699 } 1700 } 1701 1702 if (IsImage()) { 1703 // Update oat estimates. 1704 UpdateImageWriter(i); 1705 } 1706 1707 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i]; 1708 } 1709 } 1710 1711 return true; 1712 } 1713 1714 // If we are compiling an image, invoke the image creation routine. Else just skip. 1715 bool HandleImage() { 1716 if (IsImage()) { 1717 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_); 1718 if (!CreateImageFile()) { 1719 return false; 1720 } 1721 VLOG(compiler) << "Images written successfully"; 1722 } 1723 return true; 1724 } 1725 1726 // Create a copy from stripped to unstripped. 1727 bool CopyStrippedToUnstripped() { 1728 for (size_t i = 0; i < oat_unstripped_.size(); ++i) { 1729 // If we don't want to strip in place, copy from stripped location to unstripped location. 1730 // We need to strip after image creation because FixupElf needs to use .strtab. 1731 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) { 1732 // If the oat file is still open, flush it. 1733 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) { 1734 if (!FlushCloseOatFile(i)) { 1735 return false; 1736 } 1737 } 1738 1739 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_); 1740 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i])); 1741 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i])); 1742 size_t buffer_size = 8192; 1743 std::unique_ptr<uint8_t[]> buffer(new uint8_t[buffer_size]); 1744 while (true) { 1745 int bytes_read = TEMP_FAILURE_RETRY(read(in->Fd(), buffer.get(), buffer_size)); 1746 if (bytes_read <= 0) { 1747 break; 1748 } 1749 bool write_ok = out->WriteFully(buffer.get(), bytes_read); 1750 CHECK(write_ok); 1751 } 1752 if (out->FlushCloseOrErase() != 0) { 1753 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i]; 1754 return false; 1755 } 1756 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i]; 1757 } 1758 } 1759 return true; 1760 } 1761 1762 bool FlushOatFiles() { 1763 TimingLogger::ScopedTiming t2("dex2oat Flush ELF", timings_); 1764 for (size_t i = 0; i < oat_files_.size(); ++i) { 1765 if (oat_files_[i].get() != nullptr) { 1766 if (oat_files_[i]->Flush() != 0) { 1767 PLOG(ERROR) << "Failed to flush oat file: " << oat_filenames_[i]; 1768 oat_files_[i]->Erase(); 1769 return false; 1770 } 1771 } 1772 } 1773 return true; 1774 } 1775 1776 bool FlushCloseOatFile(size_t i) { 1777 if (oat_files_[i].get() != nullptr) { 1778 std::unique_ptr<File> tmp(oat_files_[i].release()); 1779 if (tmp->FlushCloseOrErase() != 0) { 1780 PLOG(ERROR) << "Failed to flush and close oat file: " << oat_filenames_[i]; 1781 return false; 1782 } 1783 } 1784 return true; 1785 } 1786 1787 bool FlushCloseOatFiles() { 1788 bool result = true; 1789 for (size_t i = 0; i < oat_files_.size(); ++i) { 1790 result &= FlushCloseOatFile(i); 1791 } 1792 return result; 1793 } 1794 1795 void DumpTiming() { 1796 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) { 1797 LOG(INFO) << Dumpable<TimingLogger>(*timings_); 1798 } 1799 if (dump_passes_) { 1800 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger()); 1801 } 1802 } 1803 1804 CompilerOptions* GetCompilerOptions() const { 1805 return compiler_options_.get(); 1806 } 1807 1808 bool IsImage() const { 1809 return IsAppImage() || IsBootImage(); 1810 } 1811 1812 bool IsAppImage() const { 1813 return app_image_; 1814 } 1815 1816 bool IsBootImage() const { 1817 return boot_image_; 1818 } 1819 1820 bool IsHost() const { 1821 return is_host_; 1822 } 1823 1824 bool UseProfileGuidedCompilation() const { 1825 return !profile_files_.empty(); 1826 } 1827 1828 bool ProcessProfiles() { 1829 DCHECK(UseProfileGuidedCompilation()); 1830 ProfileCompilationInfo* info = nullptr; 1831 if (ProfileAssistant::ProcessProfiles(profile_files_, reference_profile_files_, &info)) { 1832 profile_compilation_info_.reset(info); 1833 return true; 1834 } 1835 return false; 1836 } 1837 1838 bool ShouldCompileBasedOnProfiles() const { 1839 DCHECK(UseProfileGuidedCompilation()); 1840 // If we are given profiles, compile only if we have new information. 1841 return profile_compilation_info_ != nullptr; 1842 } 1843 1844 private: 1845 template <typename T> 1846 static std::vector<T*> MakeNonOwningPointerVector(const std::vector<std::unique_ptr<T>>& src) { 1847 std::vector<T*> result; 1848 result.reserve(src.size()); 1849 for (const std::unique_ptr<T>& t : src) { 1850 result.push_back(t.get()); 1851 } 1852 return result; 1853 } 1854 1855 static size_t OpenDexFiles(std::vector<const char*>& dex_filenames, 1856 std::vector<const char*>& dex_locations, 1857 std::vector<std::unique_ptr<const DexFile>>* dex_files) { 1858 DCHECK(dex_files != nullptr) << "OpenDexFiles out-param is nullptr"; 1859 size_t failure_count = 0; 1860 for (size_t i = 0; i < dex_filenames.size(); i++) { 1861 const char* dex_filename = dex_filenames[i]; 1862 const char* dex_location = dex_locations[i]; 1863 ATRACE_BEGIN(StringPrintf("Opening dex file '%s'", dex_filenames[i]).c_str()); 1864 std::string error_msg; 1865 if (!OS::FileExists(dex_filename)) { 1866 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filename << "'"; 1867 dex_filenames.erase(dex_filenames.begin() + i); 1868 dex_locations.erase(dex_locations.begin() + i); 1869 i--; 1870 continue; 1871 } 1872 if (!DexFile::Open(dex_filename, dex_location, &error_msg, dex_files)) { 1873 LOG(WARNING) << "Failed to open .dex from file '" << dex_filename << "': " << error_msg; 1874 ++failure_count; 1875 } 1876 ATRACE_END(); 1877 } 1878 return failure_count; 1879 } 1880 1881 // Returns true if dex_files has a dex with the named location. We compare canonical locations, 1882 // so that relative and absolute paths will match. Not caching for the dex_files isn't very 1883 // efficient, but under normal circumstances the list is neither large nor is this part too 1884 // sensitive. 1885 static bool DexFilesContains(const std::vector<const DexFile*>& dex_files, 1886 const std::string& location) { 1887 std::string canonical_location(DexFile::GetDexCanonicalLocation(location.c_str())); 1888 for (size_t i = 0; i < dex_files.size(); ++i) { 1889 if (DexFile::GetDexCanonicalLocation(dex_files[i]->GetLocation().c_str()) == 1890 canonical_location) { 1891 return true; 1892 } 1893 } 1894 return false; 1895 } 1896 1897 // Appends to opened_dex_files any elements of class_path that dex_files 1898 // doesn't already contain. This will open those dex files as necessary. 1899 static void OpenClassPathFiles(const std::string& class_path, 1900 std::vector<const DexFile*> dex_files, 1901 std::vector<std::unique_ptr<const DexFile>>* opened_dex_files) { 1902 DCHECK(opened_dex_files != nullptr) << "OpenClassPathFiles out-param is nullptr"; 1903 std::vector<std::string> parsed; 1904 Split(class_path, ':', &parsed); 1905 // Take Locks::mutator_lock_ so that lock ordering on the ClassLinker::dex_lock_ is maintained. 1906 ScopedObjectAccess soa(Thread::Current()); 1907 for (size_t i = 0; i < parsed.size(); ++i) { 1908 if (DexFilesContains(dex_files, parsed[i])) { 1909 continue; 1910 } 1911 std::string error_msg; 1912 if (!DexFile::Open(parsed[i].c_str(), parsed[i].c_str(), &error_msg, opened_dex_files)) { 1913 LOG(WARNING) << "Failed to open dex file '" << parsed[i] << "': " << error_msg; 1914 } 1915 } 1916 } 1917 1918 bool PrepareImageClasses() { 1919 // If --image-classes was specified, calculate the full list of classes to include in the image. 1920 if (image_classes_filename_ != nullptr) { 1921 image_classes_ = 1922 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image"); 1923 if (image_classes_ == nullptr) { 1924 return false; 1925 } 1926 } else if (IsBootImage()) { 1927 image_classes_.reset(new std::unordered_set<std::string>); 1928 } 1929 return true; 1930 } 1931 1932 bool PrepareCompiledClasses() { 1933 // If --compiled-classes was specified, calculate the full list of classes to compile in the 1934 // image. 1935 if (compiled_classes_filename_ != nullptr) { 1936 compiled_classes_ = 1937 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled"); 1938 if (compiled_classes_ == nullptr) { 1939 return false; 1940 } 1941 } else { 1942 compiled_classes_.reset(nullptr); // By default compile everything. 1943 } 1944 return true; 1945 } 1946 1947 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename, 1948 const char* classes_filename, 1949 const char* tag) { 1950 std::unique_ptr<std::unordered_set<std::string>> classes; 1951 std::string error_msg; 1952 if (zip_filename != nullptr) { 1953 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg)); 1954 } else { 1955 classes.reset(ReadImageClassesFromFile(classes_filename)); 1956 } 1957 if (classes == nullptr) { 1958 LOG(ERROR) << "Failed to create list of " << tag << " classes from '" 1959 << classes_filename << "': " << error_msg; 1960 } 1961 return classes; 1962 } 1963 1964 bool PrepareCompiledMethods() { 1965 // If --compiled-methods was specified, read the methods to compile from the given file(s). 1966 if (compiled_methods_filename_ != nullptr) { 1967 std::string error_msg; 1968 if (compiled_methods_zip_filename_ != nullptr) { 1969 compiled_methods_.reset(ReadCommentedInputFromZip(compiled_methods_zip_filename_, 1970 compiled_methods_filename_, 1971 nullptr, // No post-processing. 1972 &error_msg)); 1973 } else { 1974 compiled_methods_.reset(ReadCommentedInputFromFile(compiled_methods_filename_, 1975 nullptr)); // No post-processing. 1976 } 1977 if (compiled_methods_.get() == nullptr) { 1978 LOG(ERROR) << "Failed to create list of compiled methods from '" 1979 << compiled_methods_filename_ << "': " << error_msg; 1980 return false; 1981 } 1982 } else { 1983 compiled_methods_.reset(nullptr); // By default compile everything. 1984 } 1985 return true; 1986 } 1987 1988 void SaveDexInput() { 1989 for (size_t i = 0; i < dex_files_.size(); ++i) { 1990 const DexFile* dex_file = dex_files_[i]; 1991 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex", 1992 getpid(), i)); 1993 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str())); 1994 if (tmp_file.get() == nullptr) { 1995 PLOG(ERROR) << "Failed to open file " << tmp_file_name 1996 << ". Try: adb shell chmod 777 /data/local/tmp"; 1997 continue; 1998 } 1999 // This is just dumping files for debugging. Ignore errors, and leave remnants. 2000 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size())); 2001 UNUSED(tmp_file->Flush()); 2002 UNUSED(tmp_file->Close()); 2003 LOG(INFO) << "Wrote input to " << tmp_file_name; 2004 } 2005 } 2006 2007 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options) { 2008 RuntimeOptions raw_options; 2009 if (boot_image_filename_.empty()) { 2010 std::string boot_class_path = "-Xbootclasspath:"; 2011 boot_class_path += Join(dex_filenames_, ':'); 2012 raw_options.push_back(std::make_pair(boot_class_path, nullptr)); 2013 std::string boot_class_path_locations = "-Xbootclasspath-locations:"; 2014 boot_class_path_locations += Join(dex_locations_, ':'); 2015 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr)); 2016 } else { 2017 std::string boot_image_option = "-Ximage:"; 2018 boot_image_option += boot_image_filename_; 2019 raw_options.push_back(std::make_pair(boot_image_option, nullptr)); 2020 } 2021 for (size_t i = 0; i < runtime_args_.size(); i++) { 2022 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr)); 2023 } 2024 2025 raw_options.push_back(std::make_pair("compilercallbacks", callbacks_.get())); 2026 raw_options.push_back( 2027 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_))); 2028 2029 // Only allow no boot image for the runtime if we're compiling one. When we compile an app, 2030 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might 2031 // have been stripped in preopting, anyways). 2032 if (!IsBootImage()) { 2033 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr)); 2034 } 2035 // Disable libsigchain. We don't don't need it during compilation and it prevents us 2036 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT). 2037 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr)); 2038 2039 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) { 2040 LOG(ERROR) << "Failed to parse runtime options"; 2041 return false; 2042 } 2043 return true; 2044 } 2045 2046 // Create a runtime necessary for compilation. 2047 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) 2048 SHARED_TRYLOCK_FUNCTION(true, Locks::mutator_lock_) { 2049 if (!Runtime::Create(std::move(runtime_options))) { 2050 LOG(ERROR) << "Failed to create runtime"; 2051 return false; 2052 } 2053 runtime_.reset(Runtime::Current()); 2054 runtime_->SetInstructionSet(instruction_set_); 2055 for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) { 2056 Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i); 2057 if (!runtime_->HasCalleeSaveMethod(type)) { 2058 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type); 2059 } 2060 } 2061 runtime_->GetClassLinker()->FixupDexCaches(runtime_->GetResolutionMethod()); 2062 2063 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this 2064 // set up. 2065 interpreter::UnstartedRuntime::Initialize(); 2066 2067 runtime_->GetClassLinker()->RunRootClinits(); 2068 2069 return true; 2070 } 2071 2072 void PrepareImageWriter(uintptr_t image_base) { 2073 DCHECK(IsImage()); 2074 image_writer_.reset(new ImageWriter(*driver_, 2075 image_base, 2076 compiler_options_->GetCompilePic(), 2077 IsAppImage(), 2078 image_storage_mode_, 2079 oat_filenames_, 2080 dex_file_oat_filename_map_)); 2081 } 2082 2083 // Let the ImageWriter write the image files. If we do not compile PIC, also fix up the oat files. 2084 bool CreateImageFile() 2085 REQUIRES(!Locks::mutator_lock_) { 2086 CHECK(image_writer_ != nullptr); 2087 if (!IsBootImage()) { 2088 image_filenames_.push_back(app_image_file_name_.c_str()); 2089 } 2090 if (!image_writer_->Write(app_image_fd_, image_filenames_, oat_filenames_)) { 2091 LOG(ERROR) << "Failure during image file creation"; 2092 return false; 2093 } 2094 2095 // We need the OatDataBegin entries. 2096 std::map<const char*, uintptr_t> oat_data_begins; 2097 for (const char* oat_filename : oat_filenames_) { 2098 oat_data_begins.emplace(oat_filename, image_writer_->GetOatDataBegin(oat_filename)); 2099 } 2100 // Destroy ImageWriter before doing FixupElf. 2101 image_writer_.reset(); 2102 2103 for (const char* oat_filename : oat_filenames_) { 2104 // Do not fix up the ELF file if we are --compile-pic or compiling the app image 2105 if (!compiler_options_->GetCompilePic() && IsBootImage()) { 2106 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename)); 2107 if (oat_file.get() == nullptr) { 2108 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename; 2109 return false; 2110 } 2111 2112 uintptr_t oat_data_begin = oat_data_begins.find(oat_filename)->second; 2113 2114 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begin)) { 2115 oat_file->Erase(); 2116 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath(); 2117 return false; 2118 } 2119 2120 if (oat_file->FlushCloseOrErase()) { 2121 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath(); 2122 return false; 2123 } 2124 } 2125 } 2126 2127 return true; 2128 } 2129 2130 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;) 2131 static std::unordered_set<std::string>* ReadImageClassesFromFile( 2132 const char* image_classes_filename) { 2133 std::function<std::string(const char*)> process = DotToDescriptor; 2134 return ReadCommentedInputFromFile(image_classes_filename, &process); 2135 } 2136 2137 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;) 2138 static std::unordered_set<std::string>* ReadImageClassesFromZip( 2139 const char* zip_filename, 2140 const char* image_classes_filename, 2141 std::string* error_msg) { 2142 std::function<std::string(const char*)> process = DotToDescriptor; 2143 return ReadCommentedInputFromZip(zip_filename, image_classes_filename, &process, error_msg); 2144 } 2145 2146 // Read lines from the given file, dropping comments and empty lines. Post-process each line with 2147 // the given function. 2148 static std::unordered_set<std::string>* ReadCommentedInputFromFile( 2149 const char* input_filename, std::function<std::string(const char*)>* process) { 2150 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in)); 2151 if (input_file.get() == nullptr) { 2152 LOG(ERROR) << "Failed to open input file " << input_filename; 2153 return nullptr; 2154 } 2155 std::unique_ptr<std::unordered_set<std::string>> result( 2156 ReadCommentedInputStream(*input_file, process)); 2157 input_file->close(); 2158 return result.release(); 2159 } 2160 2161 // Read lines from the given file from the given zip file, dropping comments and empty lines. 2162 // Post-process each line with the given function. 2163 static std::unordered_set<std::string>* ReadCommentedInputFromZip( 2164 const char* zip_filename, 2165 const char* input_filename, 2166 std::function<std::string(const char*)>* process, 2167 std::string* error_msg) { 2168 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg)); 2169 if (zip_archive.get() == nullptr) { 2170 return nullptr; 2171 } 2172 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg)); 2173 if (zip_entry.get() == nullptr) { 2174 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename, 2175 zip_filename, error_msg->c_str()); 2176 return nullptr; 2177 } 2178 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename, 2179 input_filename, 2180 error_msg)); 2181 if (input_file.get() == nullptr) { 2182 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename, 2183 zip_filename, error_msg->c_str()); 2184 return nullptr; 2185 } 2186 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()), 2187 input_file->Size()); 2188 std::istringstream input_stream(input_string); 2189 return ReadCommentedInputStream(input_stream, process); 2190 } 2191 2192 // Read lines from the given stream, dropping comments and empty lines. Post-process each line 2193 // with the given function. 2194 static std::unordered_set<std::string>* ReadCommentedInputStream( 2195 std::istream& in_stream, 2196 std::function<std::string(const char*)>* process) { 2197 std::unique_ptr<std::unordered_set<std::string>> image_classes( 2198 new std::unordered_set<std::string>); 2199 while (in_stream.good()) { 2200 std::string dot; 2201 std::getline(in_stream, dot); 2202 if (StartsWith(dot, "#") || dot.empty()) { 2203 continue; 2204 } 2205 if (process != nullptr) { 2206 std::string descriptor((*process)(dot.c_str())); 2207 image_classes->insert(descriptor); 2208 } else { 2209 image_classes->insert(dot); 2210 } 2211 } 2212 return image_classes.release(); 2213 } 2214 2215 void LogCompletionTime() { 2216 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there 2217 // is no image, there won't be a Runtime::Current(). 2218 // Note: driver creation can fail when loading an invalid dex file. 2219 LOG(INFO) << "dex2oat took " << PrettyDuration(NanoTime() - start_ns_) 2220 << " (threads: " << thread_count_ << ") " 2221 << ((Runtime::Current() != nullptr && driver_ != nullptr) ? 2222 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) : 2223 ""); 2224 } 2225 2226 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) { 2227 std::string res(image_filename); 2228 size_t last_slash = res.rfind('/'); 2229 if (last_slash == std::string::npos || last_slash == 0) { 2230 return res; 2231 } 2232 size_t penultimate_slash = res.rfind('/', last_slash - 1); 2233 if (penultimate_slash == std::string::npos) { 2234 return res; 2235 } 2236 // Check that the string in-between is the expected one. 2237 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) != 2238 GetInstructionSetString(isa)) { 2239 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res; 2240 return res; 2241 } 2242 return res.substr(0, penultimate_slash) + res.substr(last_slash); 2243 } 2244 2245 // Update the estimate for the oat file with the given index. 2246 void UpdateImageWriter(size_t index) { 2247 DCHECK(image_writer_ != nullptr); 2248 DCHECK_LT(index, oat_filenames_.size()); 2249 2250 image_writer_->UpdateOatFile(oat_filenames_[index]); 2251 } 2252 2253 std::unique_ptr<CompilerOptions> compiler_options_; 2254 Compiler::Kind compiler_kind_; 2255 2256 InstructionSet instruction_set_; 2257 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_; 2258 2259 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_; 2260 2261 std::unique_ptr<VerificationResults> verification_results_; 2262 2263 DexFileToMethodInlinerMap method_inliner_map_; 2264 std::unique_ptr<QuickCompilerCallbacks> callbacks_; 2265 2266 // Ownership for the class path files. 2267 std::vector<std::unique_ptr<const DexFile>> class_path_files_; 2268 2269 std::unique_ptr<Runtime> runtime_; 2270 2271 size_t thread_count_; 2272 uint64_t start_ns_; 2273 std::unique_ptr<WatchDog> watchdog_; 2274 std::vector<std::unique_ptr<File>> oat_files_; 2275 std::string oat_location_; 2276 std::vector<const char*> oat_filenames_; 2277 std::vector<const char*> oat_unstripped_; 2278 int oat_fd_; 2279 std::vector<const char*> dex_filenames_; 2280 std::vector<const char*> dex_locations_; 2281 int zip_fd_; 2282 std::string zip_location_; 2283 std::string boot_image_filename_; 2284 std::vector<const char*> runtime_args_; 2285 std::vector<const char*> image_filenames_; 2286 uintptr_t image_base_; 2287 const char* image_classes_zip_filename_; 2288 const char* image_classes_filename_; 2289 ImageHeader::StorageMode image_storage_mode_; 2290 const char* compiled_classes_zip_filename_; 2291 const char* compiled_classes_filename_; 2292 const char* compiled_methods_zip_filename_; 2293 const char* compiled_methods_filename_; 2294 std::unique_ptr<std::unordered_set<std::string>> image_classes_; 2295 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_; 2296 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_; 2297 bool app_image_; 2298 bool boot_image_; 2299 bool multi_image_; 2300 bool is_host_; 2301 std::string android_root_; 2302 std::vector<const DexFile*> dex_files_; 2303 std::string no_inline_from_string_; 2304 std::vector<jobject> dex_caches_; 2305 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_; 2306 2307 std::unique_ptr<ImageWriter> image_writer_; 2308 std::unique_ptr<CompilerDriver> driver_; 2309 2310 std::vector<std::string> verbose_methods_; 2311 bool dump_stats_; 2312 bool dump_passes_; 2313 bool dump_timing_; 2314 bool dump_slow_timing_; 2315 std::string dump_cfg_file_name_; 2316 bool dump_cfg_append_; 2317 std::string swap_file_name_; 2318 int swap_fd_; 2319 std::string app_image_file_name_; 2320 int app_image_fd_; 2321 std::vector<std::string> profile_files_; 2322 std::vector<std::string> reference_profile_files_; 2323 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_; 2324 TimingLogger* timings_; 2325 std::unique_ptr<CumulativeLogger> compiler_phases_timings_; 2326 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_; 2327 std::unordered_map<const DexFile*, const char*> dex_file_oat_filename_map_; 2328 2329 // Backing storage. 2330 std::vector<std::string> char_backing_storage_; 2331 2332 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat); 2333}; 2334 2335static void b13564922() { 2336#if defined(__linux__) && defined(__arm__) 2337 int major, minor; 2338 struct utsname uts; 2339 if (uname(&uts) != -1 && 2340 sscanf(uts.release, "%d.%d", &major, &minor) == 2 && 2341 ((major < 3) || ((major == 3) && (minor < 4)))) { 2342 // Kernels before 3.4 don't handle the ASLR well and we can run out of address 2343 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization. 2344 int old_personality = personality(0xffffffff); 2345 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) { 2346 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE); 2347 if (new_personality == -1) { 2348 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed."; 2349 } 2350 } 2351 } 2352#endif 2353} 2354 2355static int CompileImage(Dex2Oat& dex2oat) { 2356 dex2oat.Compile(); 2357 2358 if (!dex2oat.CreateOatFiles()) { 2359 dex2oat.EraseOatFiles(); 2360 return EXIT_FAILURE; 2361 } 2362 2363 // Close the image oat files. We always expect the output file by name, and it will be 2364 // re-opened from the unstripped name. Note: it's easier to *flush* and close... 2365 if (!dex2oat.FlushCloseOatFiles()) { 2366 return EXIT_FAILURE; 2367 } 2368 2369 // Creates the boot.art and patches the oat files. 2370 if (!dex2oat.HandleImage()) { 2371 return EXIT_FAILURE; 2372 } 2373 2374 // When given --host, finish early without stripping. 2375 if (dex2oat.IsHost()) { 2376 dex2oat.DumpTiming(); 2377 return EXIT_SUCCESS; 2378 } 2379 2380 // Copy stripped to unstripped location, if necessary. 2381 if (!dex2oat.CopyStrippedToUnstripped()) { 2382 return EXIT_FAILURE; 2383 } 2384 2385 // FlushClose again, as stripping might have re-opened the oat files. 2386 if (!dex2oat.FlushCloseOatFiles()) { 2387 return EXIT_FAILURE; 2388 } 2389 2390 dex2oat.DumpTiming(); 2391 return EXIT_SUCCESS; 2392} 2393 2394static int CompileApp(Dex2Oat& dex2oat) { 2395 dex2oat.Compile(); 2396 2397 if (!dex2oat.CreateOatFiles()) { 2398 dex2oat.EraseOatFiles(); 2399 return EXIT_FAILURE; 2400 } 2401 2402 // Do not close the oat files here. We might have gotten the output file by file descriptor, 2403 // which we would lose. 2404 2405 // When given --host, finish early without stripping. 2406 if (dex2oat.IsHost()) { 2407 if (!dex2oat.FlushCloseOatFiles()) { 2408 return EXIT_FAILURE; 2409 } 2410 2411 dex2oat.DumpTiming(); 2412 return EXIT_SUCCESS; 2413 } 2414 2415 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the 2416 // stripped versions. If this is given, we expect to be able to open writable files by name. 2417 if (!dex2oat.CopyStrippedToUnstripped()) { 2418 return EXIT_FAILURE; 2419 } 2420 2421 // Flush and close the files. 2422 if (!dex2oat.FlushCloseOatFiles()) { 2423 return EXIT_FAILURE; 2424 } 2425 2426 dex2oat.DumpTiming(); 2427 return EXIT_SUCCESS; 2428} 2429 2430static int dex2oat(int argc, char** argv) { 2431 b13564922(); 2432 2433 TimingLogger timings("compiler", false, false); 2434 2435 Dex2Oat dex2oat(&timings); 2436 2437 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError. 2438 dex2oat.ParseArgs(argc, argv); 2439 2440 // Process profile information and assess if we need to do a profile guided compilation. 2441 // This operation involves I/O. 2442 if (dex2oat.UseProfileGuidedCompilation()) { 2443 if (dex2oat.ProcessProfiles()) { 2444 if (!dex2oat.ShouldCompileBasedOnProfiles()) { 2445 LOG(INFO) << "Skipped compilation because of insignificant profile delta"; 2446 return EXIT_SUCCESS; 2447 } 2448 } else { 2449 LOG(WARNING) << "Failed to process profile files"; 2450 return EXIT_FAILURE; 2451 } 2452 } 2453 2454 // Print the complete line when any of the following is true: 2455 // 1) Debug build 2456 // 2) Compiling an image 2457 // 3) Compiling with --host 2458 // 4) Compiling on the host (not a target build) 2459 // Otherwise, print a stripped command line. 2460 if (kIsDebugBuild || dex2oat.IsBootImage() || dex2oat.IsHost() || !kIsTargetBuild) { 2461 LOG(INFO) << CommandLine(); 2462 } else { 2463 LOG(INFO) << StrippedCommandLine(); 2464 } 2465 2466 if (!dex2oat.Setup()) { 2467 return EXIT_FAILURE; 2468 } 2469 2470 // Check early that the result of compilation can be written 2471 if (!dex2oat.OpenFile()) { 2472 dex2oat.EraseOatFiles(); 2473 return EXIT_FAILURE; 2474 } 2475 2476 bool result; 2477 if (dex2oat.IsImage()) { 2478 result = CompileImage(dex2oat); 2479 } else { 2480 result = CompileApp(dex2oat); 2481 } 2482 2483 dex2oat.Shutdown(); 2484 return result; 2485} 2486} // namespace art 2487 2488int main(int argc, char** argv) { 2489 int result = art::dex2oat(argc, argv); 2490 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take 2491 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class 2492 // should not destruct the runtime in this case. 2493 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) { 2494 exit(result); 2495 } 2496 return result; 2497} 2498