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