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 <forward_list>
24 #include <fstream>
25 #include <iostream>
26 #include <limits>
27 #include <sstream>
28 #include <string>
29 #include <type_traits>
30 #include <vector>
31
32 #if defined(__linux__) && defined(__arm__)
33 #include <sys/personality.h>
34 #include <sys/utsname.h>
35 #endif
36
37 #include "android-base/stringprintf.h"
38 #include "android-base/strings.h"
39
40 #include "arch/instruction_set_features.h"
41 #include "arch/mips/instruction_set_features_mips.h"
42 #include "art_method-inl.h"
43 #include "base/callee_save_type.h"
44 #include "base/dumpable.h"
45 #include "base/file_utils.h"
46 #include "base/leb128.h"
47 #include "base/macros.h"
48 #include "base/mutex.h"
49 #include "base/os.h"
50 #include "base/scoped_flock.h"
51 #include "base/stl_util.h"
52 #include "base/time_utils.h"
53 #include "base/timing_logger.h"
54 #include "base/unix_file/fd_file.h"
55 #include "base/utils.h"
56 #include "base/zip_archive.h"
57 #include "class_linker.h"
58 #include "class_loader_context.h"
59 #include "cmdline_parser.h"
60 #include "compiler.h"
61 #include "compiler_callbacks.h"
62 #include "debug/elf_debug_writer.h"
63 #include "debug/method_debug_info.h"
64 #include "dex/descriptors_names.h"
65 #include "dex/dex_file-inl.h"
66 #include "dex/quick_compiler_callbacks.h"
67 #include "dex/verification_results.h"
68 #include "dex2oat_options.h"
69 #include "dex2oat_return_codes.h"
70 #include "dexlayout.h"
71 #include "driver/compiler_driver.h"
72 #include "driver/compiler_options.h"
73 #include "driver/compiler_options_map-inl.h"
74 #include "elf_file.h"
75 #include "gc/space/image_space.h"
76 #include "gc/space/space-inl.h"
77 #include "gc/verification.h"
78 #include "interpreter/unstarted_runtime.h"
79 #include "jni/java_vm_ext.h"
80 #include "linker/elf_writer.h"
81 #include "linker/elf_writer_quick.h"
82 #include "linker/image_writer.h"
83 #include "linker/multi_oat_relative_patcher.h"
84 #include "linker/oat_writer.h"
85 #include "mirror/class-inl.h"
86 #include "mirror/class_loader.h"
87 #include "mirror/object-inl.h"
88 #include "mirror/object_array-inl.h"
89 #include "oat_file.h"
90 #include "oat_file_assistant.h"
91 #include "profile/profile_compilation_info.h"
92 #include "runtime.h"
93 #include "runtime_options.h"
94 #include "scoped_thread_state_change-inl.h"
95 #include "stream/buffered_output_stream.h"
96 #include "stream/file_output_stream.h"
97 #include "vdex_file.h"
98 #include "verifier/verifier_deps.h"
99 #include "well_known_classes.h"
100
101 namespace art {
102
103 using android::base::StringAppendV;
104 using android::base::StringPrintf;
105 using gc::space::ImageSpace;
106
107 static constexpr size_t kDefaultMinDexFilesForSwap = 2;
108 static constexpr size_t kDefaultMinDexFileCumulativeSizeForSwap = 20 * MB;
109
110 // Compiler filter override for very large apps.
111 static constexpr CompilerFilter::Filter kLargeAppFilter = CompilerFilter::kVerify;
112
113 static int original_argc;
114 static char** original_argv;
115
CommandLine()116 static std::string CommandLine() {
117 std::vector<std::string> command;
118 command.reserve(original_argc);
119 for (int i = 0; i < original_argc; ++i) {
120 command.push_back(original_argv[i]);
121 }
122 return android::base::Join(command, ' ');
123 }
124
125 // A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
126 // even more aggressive. There won't be much reasonable data here for us in that case anyways (the
127 // locations are all staged).
StrippedCommandLine()128 static std::string StrippedCommandLine() {
129 std::vector<std::string> command;
130
131 // Do a pre-pass to look for zip-fd and the compiler filter.
132 bool saw_zip_fd = false;
133 bool saw_compiler_filter = false;
134 for (int i = 0; i < original_argc; ++i) {
135 if (android::base::StartsWith(original_argv[i], "--zip-fd=")) {
136 saw_zip_fd = true;
137 }
138 if (android::base::StartsWith(original_argv[i], "--compiler-filter=")) {
139 saw_compiler_filter = true;
140 }
141 }
142
143 // Now filter out things.
144 for (int i = 0; i < original_argc; ++i) {
145 // All runtime-arg parameters are dropped.
146 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
147 i++; // Drop the next part, too.
148 continue;
149 }
150
151 // Any instruction-setXXX is dropped.
152 if (android::base::StartsWith(original_argv[i], "--instruction-set")) {
153 continue;
154 }
155
156 // The boot image is dropped.
157 if (android::base::StartsWith(original_argv[i], "--boot-image=")) {
158 continue;
159 }
160
161 // The image format is dropped.
162 if (android::base::StartsWith(original_argv[i], "--image-format=")) {
163 continue;
164 }
165
166 // This should leave any dex-file and oat-file options, describing what we compiled.
167
168 // However, we prefer to drop this when we saw --zip-fd.
169 if (saw_zip_fd) {
170 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
171 if (android::base::StartsWith(original_argv[i], "--zip-") ||
172 android::base::StartsWith(original_argv[i], "--dex-") ||
173 android::base::StartsWith(original_argv[i], "--oat-") ||
174 android::base::StartsWith(original_argv[i], "--swap-") ||
175 android::base::StartsWith(original_argv[i], "--app-image-")) {
176 continue;
177 }
178 }
179
180 command.push_back(original_argv[i]);
181 }
182
183 if (!saw_compiler_filter) {
184 command.push_back("--compiler-filter=" +
185 CompilerFilter::NameOfFilter(CompilerFilter::kDefaultCompilerFilter));
186 }
187
188 // Construct the final output.
189 if (command.size() <= 1U) {
190 // It seems only "/apex/com.android.runtime/bin/dex2oat" is left, or not
191 // even that. Use a pretty line.
192 return "Starting dex2oat.";
193 }
194 return android::base::Join(command, ' ');
195 }
196
UsageErrorV(const char * fmt,va_list ap)197 static void UsageErrorV(const char* fmt, va_list ap) {
198 std::string error;
199 StringAppendV(&error, fmt, ap);
200 LOG(ERROR) << error;
201 }
202
UsageError(const char * fmt,...)203 static void UsageError(const char* fmt, ...) {
204 va_list ap;
205 va_start(ap, fmt);
206 UsageErrorV(fmt, ap);
207 va_end(ap);
208 }
209
Usage(const char * fmt,...)210 NO_RETURN static void Usage(const char* fmt, ...) {
211 va_list ap;
212 va_start(ap, fmt);
213 UsageErrorV(fmt, ap);
214 va_end(ap);
215
216 UsageError("Command: %s", CommandLine().c_str());
217
218 UsageError("Usage: dex2oat [options]...");
219 UsageError("");
220 UsageError(" -j<number>: specifies the number of threads used for compilation.");
221 UsageError(" Default is the number of detected hardware threads available on the");
222 UsageError(" host system.");
223 UsageError(" Example: -j12");
224 UsageError("");
225 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
226 UsageError(" Example: --dex-file=/system/framework/core.jar");
227 UsageError("");
228 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
229 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
230 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
231 UsageError(" --dex-location=/system/framework/core.jar");
232 UsageError("");
233 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
234 UsageError(" containing a classes.dex file to compile.");
235 UsageError(" Example: --zip-fd=5");
236 UsageError("");
237 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
238 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
239 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
240 UsageError("");
241 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
242 UsageError(" Example: --oat-file=/system/framework/boot.oat");
243 UsageError("");
244 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
245 UsageError(" Example: --oat-fd=6");
246 UsageError("");
247 UsageError(" --input-vdex-fd=<number>: specifies the vdex input source via a file descriptor.");
248 UsageError(" Example: --input-vdex-fd=6");
249 UsageError("");
250 UsageError(" --output-vdex-fd=<number>: specifies the vdex output destination via a file");
251 UsageError(" descriptor.");
252 UsageError(" Example: --output-vdex-fd=6");
253 UsageError("");
254 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
255 UsageError(" to the file descriptor specified by --oat-fd.");
256 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
257 UsageError("");
258 UsageError(" --oat-symbols=<file.oat>: specifies a destination where the oat file is copied.");
259 UsageError(" This is equivalent to file copy as build post-processing step.");
260 UsageError(" It is intended to be used with --strip and it happens before it.");
261 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
262 UsageError("");
263 UsageError(" --strip: remove all debugging sections at the end (but keep mini-debug-info).");
264 UsageError(" This is equivalent to the \"strip\" command as build post-processing step.");
265 UsageError(" It is intended to be used with --oat-symbols and it happens after it.");
266 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
267 UsageError("");
268 UsageError(" --image=<file.art>: specifies an output image filename.");
269 UsageError(" Example: --image=/system/framework/boot.art");
270 UsageError("");
271 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
272 UsageError(" Which format to store the image.");
273 UsageError(" Example: --image-format=lz4");
274 UsageError(" Default: uncompressed");
275 UsageError("");
276 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
277 UsageError(" Example: --image=frameworks/base/preloaded-classes");
278 UsageError("");
279 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
280 UsageError(" Example: --base=0x50000000");
281 UsageError("");
282 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
283 UsageError(" Do not include the arch as part of the name, it is added automatically.");
284 UsageError(" Example: --boot-image=/system/framework/boot.art");
285 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
286 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
287 UsageError("");
288 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
289 UsageError(" Example: --android-root=out/host/linux-x86");
290 UsageError(" Default: $ANDROID_ROOT");
291 UsageError("");
292 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
293 UsageError(" instruction set.");
294 UsageError(" Example: --instruction-set=x86");
295 UsageError(" Default: arm");
296 UsageError("");
297 UsageError(" --instruction-set-features=...,: Specify instruction set features");
298 UsageError(" On target the value 'runtime' can be used to detect features at run time.");
299 UsageError(" If target does not support run-time detection the value 'runtime'");
300 UsageError(" has the same effect as the value 'default'.");
301 UsageError(" Note: the value 'runtime' has no effect if it is used on host.");
302 UsageError(" Example: --instruction-set-features=div");
303 UsageError(" Default: default");
304 UsageError("");
305 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
306 UsageError(" set.");
307 UsageError(" Example: --compiler-backend=Optimizing");
308 UsageError(" Default: Optimizing");
309 UsageError("");
310 UsageError(" --compiler-filter="
311 "(assume-verified"
312 "|extract"
313 "|verify"
314 "|quicken"
315 "|space-profile"
316 "|space"
317 "|speed-profile"
318 "|speed"
319 "|everything-profile"
320 "|everything):");
321 UsageError(" select compiler filter.");
322 UsageError(" Example: --compiler-filter=everything");
323 UsageError(" Default: speed");
324 UsageError("");
325 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
326 UsageError(" method for compiler filter tuning.");
327 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
328 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
329 UsageError("");
330 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
331 UsageError(" method for compiler filter tuning.");
332 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
333 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
334 UsageError("");
335 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
336 UsageError(" method for compiler filter tuning.");
337 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
338 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
339 UsageError("");
340 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
341 UsageError(" method for compiler filter tuning.");
342 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
343 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
344 UsageError("");
345 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
346 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
347 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
348 UsageError(" overrides the filter to use speed");
349 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
350 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
351 UsageError("");
352 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
353 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
354 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
355 UsageError(" Intended for development/experimental use.");
356 UsageError(" Example: --inline-max-code-units=%d",
357 CompilerOptions::kDefaultInlineMaxCodeUnits);
358 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
359 UsageError("");
360 UsageError(" --dump-timings: display a breakdown of where time was spent");
361 UsageError("");
362 UsageError(" --dump-pass-timings: display a breakdown of time spent in optimization");
363 UsageError(" passes for each compiled method.");
364 UsageError("");
365 UsageError(" -g");
366 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
367 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
368 UsageError(" If used without --debuggable, it will be best-effort only.");
369 UsageError(" This option does not affect the generated code. (disabled by default)");
370 UsageError("");
371 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
372 UsageError("");
373 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
374 UsageError(" debug information necessary to print backtraces. (disabled by default)");
375 UsageError("");
376 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
377 UsageError("");
378 UsageError(" --generate-build-id: Generate GNU-compatible linker build ID ELF section with");
379 UsageError(" SHA-1 of the file content (and thus stable across identical builds)");
380 UsageError("");
381 UsageError(" --no-generate-build-id: Do not generate the build ID ELF section.");
382 UsageError("");
383 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
384 UsageError("");
385 UsageError(" --avoid-storing-invocation: Avoid storing the invocation args in the key value");
386 UsageError(" store. Used to test determinism with different args.");
387 UsageError("");
388 UsageError(" --write-invocation-to=<file>: Write the invocation commandline to the given file");
389 UsageError(" for later use. Used to test determinism with different host architectures.");
390 UsageError("");
391 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
392 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
393 UsageError(" Use a separate --runtime-arg switch for each argument.");
394 UsageError(" Example: --runtime-arg -Xms256m");
395 UsageError("");
396 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
397 UsageError("");
398 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
399 UsageError(" Cannot be used together with --profile-file.");
400 UsageError("");
401 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
402 UsageError(" Example: --swap-file=/data/tmp/swap.001");
403 UsageError("");
404 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
405 UsageError(" Example: --swap-fd=10");
406 UsageError("");
407 UsageError(" --swap-dex-size-threshold=<size>: specifies the minimum total dex file size in");
408 UsageError(" bytes to allow the use of swap.");
409 UsageError(" Example: --swap-dex-size-threshold=1000000");
410 UsageError(" Default: %zu", kDefaultMinDexFileCumulativeSizeForSwap);
411 UsageError("");
412 UsageError(" --swap-dex-count-threshold=<count>: specifies the minimum number of dex files to");
413 UsageError(" allow the use of swap.");
414 UsageError(" Example: --swap-dex-count-threshold=10");
415 UsageError(" Default: %zu", kDefaultMinDexFilesForSwap);
416 UsageError("");
417 UsageError(" --very-large-app-threshold=<size>: specifies the minimum total dex file size in");
418 UsageError(" bytes to consider the input \"very large\" and reduce compilation done.");
419 UsageError(" Example: --very-large-app-threshold=100000000");
420 UsageError("");
421 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
422 UsageError(" The image is non-empty only if a profile is passed in.");
423 UsageError(" Example: --app-image-fd=10");
424 UsageError("");
425 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
426 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
427 UsageError("");
428 UsageError(" --multi-image: obsolete, ignored");
429 UsageError("");
430 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
431 UsageError("");
432 UsageError(" --dump-cfg=<cfg-file>: dump control-flow graphs (CFGs) to specified file.");
433 UsageError(" Example: --dump-cfg=output.cfg");
434 UsageError("");
435 UsageError(" --dump-cfg-append: when dumping CFGs to an existing file, append new CFG data to");
436 UsageError(" existing data (instead of overwriting existing data with new data, which is");
437 UsageError(" the default behavior). This option is only meaningful when used with");
438 UsageError(" --dump-cfg.");
439 UsageError("");
440 UsageError(" --classpath-dir=<directory-path>: directory used to resolve relative class paths.");
441 UsageError("");
442 UsageError(" --class-loader-context=<string spec>: a string specifying the intended");
443 UsageError(" runtime loading context for the compiled dex files.");
444 UsageError("");
445 UsageError(" --stored-class-loader-context=<string spec>: a string specifying the intended");
446 UsageError(" runtime loading context that is stored in the oat file. Overrides");
447 UsageError(" --class-loader-context. Note that this ignores the classpath_dir arg.");
448 UsageError("");
449 UsageError(" It describes how the class loader chain should be built in order to ensure");
450 UsageError(" classes are resolved during dex2aot as they would be resolved at runtime.");
451 UsageError(" This spec will be encoded in the oat file. If at runtime the dex file is");
452 UsageError(" loaded in a different context, the oat file will be rejected.");
453 UsageError("");
454 UsageError(" The chain is interpreted in the natural 'parent order', meaning that class");
455 UsageError(" loader 'i+1' will be the parent of class loader 'i'.");
456 UsageError(" The compilation sources will be appended to the classpath of the first class");
457 UsageError(" loader.");
458 UsageError("");
459 UsageError(" E.g. if the context is 'PCL[lib1.dex];DLC[lib2.dex]' and ");
460 UsageError(" --dex-file=src.dex then dex2oat will setup a PathClassLoader with classpath ");
461 UsageError(" 'lib1.dex:src.dex' and set its parent to a DelegateLastClassLoader with ");
462 UsageError(" classpath 'lib2.dex'.");
463 UsageError("");
464 UsageError(" Note that the compiler will be tolerant if the source dex files specified");
465 UsageError(" with --dex-file are found in the classpath. The source dex files will be");
466 UsageError(" removed from any class loader's classpath possibly resulting in empty");
467 UsageError(" class loaders.");
468 UsageError("");
469 UsageError(" Example: --class-loader-context=PCL[lib1.dex:lib2.dex];DLC[lib3.dex]");
470 UsageError("");
471 UsageError(" --class-loader-context-fds=<fds>: a colon-separated list of file descriptors");
472 UsageError(" for dex files in --class-loader-context. Their order must be the same as");
473 UsageError(" dex files in flattened class loader context.");
474 UsageError("");
475 UsageError(" --dirty-image-objects=<directory-path>: list of known dirty objects in the image.");
476 UsageError(" The image writer will group them together.");
477 UsageError("");
478 UsageError(" --compact-dex-level=none|fast: None avoids generating compact dex, fast");
479 UsageError(" generates compact dex with low compile time. If speed-profile is specified as");
480 UsageError(" the compiler filter and the profile is not empty, the default compact dex");
481 UsageError(" level is always used.");
482 UsageError("");
483 UsageError(" --deduplicate-code=true|false: enable|disable code deduplication. Deduplicated");
484 UsageError(" code will have an arbitrary symbol tagged with [DEDUPED].");
485 UsageError("");
486 UsageError(" --copy-dex-files=true|false: enable|disable copying the dex files into the");
487 UsageError(" output vdex.");
488 UsageError("");
489 UsageError(" --compilation-reason=<string>: optional metadata specifying the reason for");
490 UsageError(" compiling the apk. If specified, the string will be embedded verbatim in");
491 UsageError(" the key value store of the oat file.");
492 UsageError(" Example: --compilation-reason=install");
493 UsageError("");
494 UsageError(" --resolve-startup-const-strings=true|false: If true, the compiler eagerly");
495 UsageError(" resolves strings referenced from const-string of startup methods.");
496 UsageError("");
497 UsageError(" --max-image-block-size=<size>: Maximum solid block size for compressed images.");
498 UsageError("");
499 std::cerr << "See log for usage error information\n";
500 exit(EXIT_FAILURE);
501 }
502
503 // The primary goal of the watchdog is to prevent stuck build servers
504 // during development when fatal aborts lead to a cascade of failures
505 // that result in a deadlock.
506 class WatchDog {
507 // WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
508 #undef CHECK_PTHREAD_CALL
509 #define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
510 do { \
511 int rc = call args; \
512 if (rc != 0) { \
513 errno = rc; \
514 std::string message(# call); \
515 message += " failed for "; \
516 message += reason; \
517 Fatal(message); \
518 } \
519 } while (false)
520
521 public:
WatchDog(int64_t timeout_in_milliseconds)522 explicit WatchDog(int64_t timeout_in_milliseconds)
523 : timeout_in_milliseconds_(timeout_in_milliseconds),
524 shutting_down_(false) {
525 const char* reason = "dex2oat watch dog thread startup";
526 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
527 #ifndef __APPLE__
528 pthread_condattr_t condattr;
529 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_init, (&condattr), reason);
530 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_setclock, (&condattr, CLOCK_MONOTONIC), reason);
531 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, &condattr), reason);
532 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_destroy, (&condattr), reason);
533 #endif
534 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
535 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
536 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
537 }
~WatchDog()538 ~WatchDog() {
539 const char* reason = "dex2oat watch dog thread shutdown";
540 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
541 shutting_down_ = true;
542 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
543 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
544
545 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
546
547 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
548 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
549 }
550
SetRuntime(Runtime * runtime)551 static void SetRuntime(Runtime* runtime) {
552 const char* reason = "dex2oat watch dog set runtime";
553 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&runtime_mutex_), reason);
554 runtime_ = runtime;
555 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&runtime_mutex_), reason);
556 }
557
558 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
559 // large.
560 static constexpr int64_t kWatchdogVerifyMultiplier =
561 kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
562
563 // When setting timeouts, keep in mind that the build server may not be as fast as your
564 // desktop. Debug builds are slower so they have larger timeouts.
565 static constexpr int64_t kWatchdogSlowdownFactor = kIsDebugBuild ? 5U : 1U;
566
567 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
568 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
569 // itself before that watchdog would take down the system server.
570 static constexpr int64_t kWatchDogTimeoutSeconds = kWatchdogSlowdownFactor * (9 * 60 + 30);
571
572 static constexpr int64_t kDefaultWatchdogTimeoutInMS =
573 kWatchdogVerifyMultiplier * kWatchDogTimeoutSeconds * 1000;
574
575 private:
CallBack(void * arg)576 static void* CallBack(void* arg) {
577 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
578 ::art::SetThreadName("dex2oat watch dog");
579 self->Wait();
580 return nullptr;
581 }
582
Fatal(const std::string & message)583 NO_RETURN static void Fatal(const std::string& message) {
584 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
585 // it's rather easy to hang in unwinding.
586 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
587 // logcat logging or stderr output.
588 LogHelper::LogLineLowStack(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
589
590 // If we're on the host, try to dump all threads to get a sense of what's going on. This is
591 // restricted to the host as the dump may itself go bad.
592 // TODO: Use a double watchdog timeout, so we can enable this on-device.
593 Runtime* runtime = GetRuntime();
594 if (!kIsTargetBuild && runtime != nullptr) {
595 runtime->AttachCurrentThread("Watchdog thread attached for dumping",
596 true,
597 nullptr,
598 false);
599 runtime->DumpForSigQuit(std::cerr);
600 }
601 exit(1);
602 }
603
Wait()604 void Wait() {
605 timespec timeout_ts;
606 #if defined(__APPLE__)
607 InitTimeSpec(true, CLOCK_REALTIME, timeout_in_milliseconds_, 0, &timeout_ts);
608 #else
609 InitTimeSpec(true, CLOCK_MONOTONIC, timeout_in_milliseconds_, 0, &timeout_ts);
610 #endif
611 const char* reason = "dex2oat watch dog thread waiting";
612 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
613 while (!shutting_down_) {
614 int rc = pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts);
615 if (rc == EINTR) {
616 continue;
617 } else if (rc == ETIMEDOUT) {
618 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
619 timeout_in_milliseconds_/1000));
620 } else if (rc != 0) {
621 std::string message(StringPrintf("pthread_cond_timedwait failed: %s", strerror(rc)));
622 Fatal(message);
623 }
624 }
625 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
626 }
627
GetRuntime()628 static Runtime* GetRuntime() {
629 const char* reason = "dex2oat watch dog get runtime";
630 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&runtime_mutex_), reason);
631 Runtime* runtime = runtime_;
632 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&runtime_mutex_), reason);
633 return runtime;
634 }
635
636 static pthread_mutex_t runtime_mutex_;
637 static Runtime* runtime_;
638
639 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
640 pthread_mutex_t mutex_;
641 pthread_cond_t cond_;
642 pthread_attr_t attr_;
643 pthread_t pthread_;
644
645 const int64_t timeout_in_milliseconds_;
646 bool shutting_down_;
647 };
648
649 pthread_mutex_t WatchDog::runtime_mutex_ = PTHREAD_MUTEX_INITIALIZER;
650 Runtime* WatchDog::runtime_ = nullptr;
651
652 class Dex2Oat final {
653 public:
Dex2Oat(TimingLogger * timings)654 explicit Dex2Oat(TimingLogger* timings) :
655 compiler_kind_(Compiler::kOptimizing),
656 // Take the default set of instruction features from the build.
657 key_value_store_(nullptr),
658 verification_results_(nullptr),
659 runtime_(nullptr),
660 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
661 start_ns_(NanoTime()),
662 start_cputime_ns_(ProcessCpuNanoTime()),
663 strip_(false),
664 oat_fd_(-1),
665 input_vdex_fd_(-1),
666 output_vdex_fd_(-1),
667 input_vdex_file_(nullptr),
668 dm_fd_(-1),
669 zip_fd_(-1),
670 image_base_(0U),
671 image_classes_zip_filename_(nullptr),
672 image_classes_filename_(nullptr),
673 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
674 passes_to_run_filename_(nullptr),
675 dirty_image_objects_filename_(nullptr),
676 is_host_(false),
677 elf_writers_(),
678 oat_writers_(),
679 rodata_(),
680 image_writer_(nullptr),
681 driver_(nullptr),
682 opened_dex_files_maps_(),
683 opened_dex_files_(),
684 avoid_storing_invocation_(false),
685 swap_fd_(kInvalidFd),
686 app_image_fd_(kInvalidFd),
687 profile_file_fd_(kInvalidFd),
688 timings_(timings),
689 force_determinism_(false)
690 {}
691
~Dex2Oat()692 ~Dex2Oat() {
693 // Log completion time before deleting the runtime_, because this accesses
694 // the runtime.
695 LogCompletionTime();
696
697 if (!kIsDebugBuild && !(kRunningOnMemoryTool && kMemoryToolDetectsLeaks)) {
698 // We want to just exit on non-debug builds, not bringing the runtime down
699 // in an orderly fashion. So release the following fields.
700 driver_.release(); // NOLINT
701 image_writer_.release(); // NOLINT
702 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
703 dex_file.release(); // NOLINT
704 }
705 new std::vector<MemMap>(std::move(opened_dex_files_maps_)); // Leak MemMaps.
706 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
707 vdex_file.release(); // NOLINT
708 }
709 for (std::unique_ptr<File>& oat_file : oat_files_) {
710 oat_file.release(); // NOLINT
711 }
712 runtime_.release(); // NOLINT
713 verification_results_.release(); // NOLINT
714 key_value_store_.release(); // NOLINT
715 }
716 }
717
718 struct ParserOptions {
719 std::vector<std::string> oat_symbols;
720 std::string boot_image_filename;
721 int64_t watch_dog_timeout_in_ms = -1;
722 bool watch_dog_enabled = true;
723 bool requested_specific_compiler = false;
724 std::string error_msg;
725 };
726
ParseBase(const std::string & option)727 void ParseBase(const std::string& option) {
728 char* end;
729 image_base_ = strtoul(option.c_str(), &end, 16);
730 if (end == option.c_str() || *end != '\0') {
731 Usage("Failed to parse hexadecimal value for option %s", option.data());
732 }
733 }
734
VerifyProfileData()735 bool VerifyProfileData() {
736 return profile_compilation_info_->VerifyProfileData(compiler_options_->dex_files_for_oat_file_);
737 }
738
ParseInstructionSetVariant(const std::string & option,ParserOptions * parser_options)739 void ParseInstructionSetVariant(const std::string& option, ParserOptions* parser_options) {
740 compiler_options_->instruction_set_features_ = InstructionSetFeatures::FromVariant(
741 compiler_options_->instruction_set_, option, &parser_options->error_msg);
742 if (compiler_options_->instruction_set_features_ == nullptr) {
743 Usage("%s", parser_options->error_msg.c_str());
744 }
745 }
746
ParseInstructionSetFeatures(const std::string & option,ParserOptions * parser_options)747 void ParseInstructionSetFeatures(const std::string& option, ParserOptions* parser_options) {
748 if (compiler_options_->instruction_set_features_ == nullptr) {
749 compiler_options_->instruction_set_features_ = InstructionSetFeatures::FromVariant(
750 compiler_options_->instruction_set_, "default", &parser_options->error_msg);
751 if (compiler_options_->instruction_set_features_ == nullptr) {
752 Usage("Problem initializing default instruction set features variant: %s",
753 parser_options->error_msg.c_str());
754 }
755 }
756 compiler_options_->instruction_set_features_ =
757 compiler_options_->instruction_set_features_->AddFeaturesFromString(
758 option, &parser_options->error_msg);
759 if (compiler_options_->instruction_set_features_ == nullptr) {
760 Usage("Error parsing '%s': %s", option.c_str(), parser_options->error_msg.c_str());
761 }
762 }
763
ProcessOptions(ParserOptions * parser_options)764 void ProcessOptions(ParserOptions* parser_options) {
765 compiler_options_->compile_pic_ = true; // All AOT compilation is PIC.
766 DCHECK(compiler_options_->image_type_ == CompilerOptions::ImageType::kNone);
767 if (!image_filenames_.empty()) {
768 if (android::base::EndsWith(image_filenames_[0], "apex.art")) {
769 compiler_options_->image_type_ = CompilerOptions::ImageType::kApexBootImage;
770 } else {
771 compiler_options_->image_type_ = CompilerOptions::ImageType::kBootImage;
772 }
773 }
774 if (app_image_fd_ != -1 || !app_image_file_name_.empty()) {
775 if (compiler_options_->IsBootImage()) {
776 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
777 }
778 compiler_options_->image_type_ = CompilerOptions::ImageType::kAppImage;
779 }
780
781 if (oat_filenames_.empty() && oat_fd_ == -1) {
782 Usage("Output must be supplied with either --oat-file or --oat-fd");
783 }
784
785 if (input_vdex_fd_ != -1 && !input_vdex_.empty()) {
786 Usage("Can't have both --input-vdex-fd and --input-vdex");
787 }
788
789 if (output_vdex_fd_ != -1 && !output_vdex_.empty()) {
790 Usage("Can't have both --output-vdex-fd and --output-vdex");
791 }
792
793 if (!oat_filenames_.empty() && oat_fd_ != -1) {
794 Usage("--oat-file should not be used with --oat-fd");
795 }
796
797 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
798 Usage("VDEX and OAT output must be specified either with one --oat-file "
799 "or with --oat-fd and --output-vdex-fd file descriptors");
800 }
801
802 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
803 Usage("--oat-symbols should not be used with --oat-fd");
804 }
805
806 if (!parser_options->oat_symbols.empty() && is_host_) {
807 Usage("--oat-symbols should not be used with --host");
808 }
809
810 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
811 Usage("--output-vdex-fd should not be used with --image");
812 }
813
814 if (oat_fd_ != -1 && !image_filenames_.empty()) {
815 Usage("--oat-fd should not be used with --image");
816 }
817
818 if ((input_vdex_fd_ != -1 || !input_vdex_.empty()) &&
819 (dm_fd_ != -1 || !dm_file_location_.empty())) {
820 Usage("An input vdex should not be passed with a .dm file");
821 }
822
823 if (!parser_options->oat_symbols.empty() &&
824 parser_options->oat_symbols.size() != oat_filenames_.size()) {
825 Usage("--oat-file arguments do not match --oat-symbols arguments");
826 }
827
828 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
829 Usage("--oat-file arguments do not match --image arguments");
830 }
831
832 if (android_root_.empty()) {
833 const char* android_root_env_var = getenv("ANDROID_ROOT");
834 if (android_root_env_var == nullptr) {
835 Usage("--android-root unspecified and ANDROID_ROOT not set");
836 }
837 android_root_ += android_root_env_var;
838 }
839
840 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
841 parser_options->boot_image_filename = GetDefaultBootImageLocation(android_root_);
842 }
843 if (!parser_options->boot_image_filename.empty()) {
844 boot_image_filename_ = parser_options->boot_image_filename;
845 }
846
847 if (image_classes_filename_ != nullptr && !IsBootImage()) {
848 Usage("--image-classes should only be used with --image");
849 }
850
851 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
852 Usage("--image-classes should not be used with --boot-image");
853 }
854
855 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
856 Usage("--image-classes-zip should be used with --image-classes");
857 }
858
859 if (dex_filenames_.empty() && zip_fd_ == -1) {
860 Usage("Input must be supplied with either --dex-file or --zip-fd");
861 }
862
863 if (!dex_filenames_.empty() && zip_fd_ != -1) {
864 Usage("--dex-file should not be used with --zip-fd");
865 }
866
867 if (!dex_filenames_.empty() && !zip_location_.empty()) {
868 Usage("--dex-file should not be used with --zip-location");
869 }
870
871 if (dex_locations_.empty()) {
872 dex_locations_ = dex_filenames_;
873 } else if (dex_locations_.size() != dex_filenames_.size()) {
874 Usage("--dex-location arguments do not match --dex-file arguments");
875 }
876
877 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
878 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
879 Usage("--oat-file arguments must be singular or match --dex-file arguments");
880 }
881 }
882
883 if (zip_fd_ != -1 && zip_location_.empty()) {
884 Usage("--zip-location should be supplied with --zip-fd");
885 }
886
887 if (boot_image_filename_.empty()) {
888 if (image_base_ == 0) {
889 Usage("Non-zero --base not specified");
890 }
891 }
892
893 const bool have_profile_file = !profile_file_.empty();
894 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
895 if (have_profile_file && have_profile_fd) {
896 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
897 }
898
899 if (have_profile_file || have_profile_fd) {
900 if (image_classes_filename_ != nullptr ||
901 image_classes_zip_filename_ != nullptr) {
902 Usage("Profile based image creation is not supported with image or compiled classes");
903 }
904 }
905
906 if (!parser_options->oat_symbols.empty()) {
907 oat_unstripped_ = std::move(parser_options->oat_symbols);
908 }
909
910 if (compiler_options_->instruction_set_features_ == nullptr) {
911 // '--instruction-set-features/--instruction-set-variant' were not used.
912 // Use features for the 'default' variant.
913 compiler_options_->instruction_set_features_ = InstructionSetFeatures::FromVariant(
914 compiler_options_->instruction_set_, "default", &parser_options->error_msg);
915 if (compiler_options_->instruction_set_features_ == nullptr) {
916 Usage("Problem initializing default instruction set features variant: %s",
917 parser_options->error_msg.c_str());
918 }
919 }
920
921 if (compiler_options_->instruction_set_ == kRuntimeISA) {
922 std::unique_ptr<const InstructionSetFeatures> runtime_features(
923 InstructionSetFeatures::FromCppDefines());
924 if (!compiler_options_->GetInstructionSetFeatures()->Equals(runtime_features.get())) {
925 LOG(WARNING) << "Mismatch between dex2oat instruction set features to use ("
926 << *compiler_options_->GetInstructionSetFeatures()
927 << ") and those from CPP defines (" << *runtime_features
928 << ") for the command line:\n" << CommandLine();
929 }
930 }
931
932 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
933 compiler_options_->inline_max_code_units_ = CompilerOptions::kDefaultInlineMaxCodeUnits;
934 }
935
936 // Checks are all explicit until we know the architecture.
937 // Set the compilation target's implicit checks options.
938 switch (compiler_options_->GetInstructionSet()) {
939 case InstructionSet::kArm:
940 case InstructionSet::kThumb2:
941 case InstructionSet::kArm64:
942 case InstructionSet::kX86:
943 case InstructionSet::kX86_64:
944 case InstructionSet::kMips:
945 case InstructionSet::kMips64:
946 compiler_options_->implicit_null_checks_ = true;
947 compiler_options_->implicit_so_checks_ = true;
948 break;
949
950 default:
951 // Defaults are correct.
952 break;
953 }
954
955 // Done with usage checks, enable watchdog if requested
956 if (parser_options->watch_dog_enabled) {
957 int64_t timeout = parser_options->watch_dog_timeout_in_ms > 0
958 ? parser_options->watch_dog_timeout_in_ms
959 : WatchDog::kDefaultWatchdogTimeoutInMS;
960 watchdog_.reset(new WatchDog(timeout));
961 }
962
963 // Fill some values into the key-value store for the oat header.
964 key_value_store_.reset(new SafeMap<std::string, std::string>());
965
966 // Automatically force determinism for the boot image in a host build if read barriers
967 // are enabled, or if the default GC is CMS or MS. When the default GC is CMS
968 // (Concurrent Mark-Sweep), the GC is switched to a non-concurrent one by passing the
969 // option `-Xgc:nonconcurrent` (see below).
970 if (!kIsTargetBuild && IsBootImage()) {
971 if (SupportsDeterministicCompilation()) {
972 force_determinism_ = true;
973 } else {
974 LOG(WARNING) << "Deterministic compilation is disabled.";
975 }
976 }
977 compiler_options_->force_determinism_ = force_determinism_;
978
979 if (passes_to_run_filename_ != nullptr) {
980 passes_to_run_ = ReadCommentedInputFromFile<std::vector<std::string>>(
981 passes_to_run_filename_,
982 nullptr); // No post-processing.
983 if (passes_to_run_.get() == nullptr) {
984 Usage("Failed to read list of passes to run.");
985 }
986 }
987 compiler_options_->passes_to_run_ = passes_to_run_.get();
988 compiler_options_->compiling_with_core_image_ =
989 !boot_image_filename_.empty() &&
990 CompilerOptions::IsCoreImageFilename(boot_image_filename_);
991 }
992
SupportsDeterministicCompilation()993 static bool SupportsDeterministicCompilation() {
994 return (kUseReadBarrier ||
995 gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
996 gc::kCollectorTypeDefault == gc::kCollectorTypeMS);
997 }
998
ExpandOatAndImageFilenames()999 void ExpandOatAndImageFilenames() {
1000 if (image_filenames_[0].rfind('/') == std::string::npos) {
1001 Usage("Unusable boot image filename %s", image_filenames_[0].c_str());
1002 }
1003 image_filenames_ = ImageSpace::ExpandMultiImageLocations(dex_locations_, image_filenames_[0]);
1004
1005 if (oat_filenames_[0].rfind('/') == std::string::npos) {
1006 Usage("Unusable boot image oat filename %s", oat_filenames_[0].c_str());
1007 }
1008 oat_filenames_ = ImageSpace::ExpandMultiImageLocations(dex_locations_, oat_filenames_[0]);
1009
1010 if (!oat_unstripped_.empty()) {
1011 if (oat_unstripped_[0].rfind('/') == std::string::npos) {
1012 Usage("Unusable boot image symbol filename %s", oat_unstripped_[0].c_str());
1013 }
1014 oat_unstripped_ = ImageSpace::ExpandMultiImageLocations(dex_locations_, oat_unstripped_[0]);
1015 }
1016 }
1017
InsertCompileOptions(int argc,char ** argv)1018 void InsertCompileOptions(int argc, char** argv) {
1019 if (!avoid_storing_invocation_) {
1020 std::ostringstream oss;
1021 for (int i = 0; i < argc; ++i) {
1022 if (i > 0) {
1023 oss << ' ';
1024 }
1025 oss << argv[i];
1026 }
1027 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1028 }
1029 key_value_store_->Put(
1030 OatHeader::kDebuggableKey,
1031 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
1032 key_value_store_->Put(
1033 OatHeader::kNativeDebuggableKey,
1034 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
1035 key_value_store_->Put(OatHeader::kCompilerFilter,
1036 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
1037 key_value_store_->Put(OatHeader::kConcurrentCopying,
1038 kUseReadBarrier ? OatHeader::kTrueValue : OatHeader::kFalseValue);
1039 if (invocation_file_.get() != -1) {
1040 std::ostringstream oss;
1041 for (int i = 0; i < argc; ++i) {
1042 if (i > 0) {
1043 oss << std::endl;
1044 }
1045 oss << argv[i];
1046 }
1047 std::string invocation(oss.str());
1048 if (TEMP_FAILURE_RETRY(write(invocation_file_.get(),
1049 invocation.c_str(),
1050 invocation.size())) == -1) {
1051 Usage("Unable to write invocation file");
1052 }
1053 }
1054 }
1055
1056 // This simple forward is here so the string specializations below don't look out of place.
1057 template <typename T, typename U>
AssignIfExists(Dex2oatArgumentMap & map,const Dex2oatArgumentMap::Key<T> & key,U * out)1058 void AssignIfExists(Dex2oatArgumentMap& map,
1059 const Dex2oatArgumentMap::Key<T>& key,
1060 U* out) {
1061 map.AssignIfExists(key, out);
1062 }
1063
1064 // Specializations to handle const char* vs std::string.
AssignIfExists(Dex2oatArgumentMap & map,const Dex2oatArgumentMap::Key<std::string> & key,const char ** out)1065 void AssignIfExists(Dex2oatArgumentMap& map,
1066 const Dex2oatArgumentMap::Key<std::string>& key,
1067 const char** out) {
1068 if (map.Exists(key)) {
1069 char_backing_storage_.push_front(std::move(*map.Get(key)));
1070 *out = char_backing_storage_.front().c_str();
1071 }
1072 }
AssignIfExists(Dex2oatArgumentMap & map,const Dex2oatArgumentMap::Key<std::vector<std::string>> & key,std::vector<const char * > * out)1073 void AssignIfExists(Dex2oatArgumentMap& map,
1074 const Dex2oatArgumentMap::Key<std::vector<std::string>>& key,
1075 std::vector<const char*>* out) {
1076 if (map.Exists(key)) {
1077 for (auto& val : *map.Get(key)) {
1078 char_backing_storage_.push_front(std::move(val));
1079 out->push_back(char_backing_storage_.front().c_str());
1080 }
1081 }
1082 }
1083
1084 template <typename T>
AssignTrueIfExists(Dex2oatArgumentMap & map,const Dex2oatArgumentMap::Key<T> & key,bool * out)1085 void AssignTrueIfExists(Dex2oatArgumentMap& map,
1086 const Dex2oatArgumentMap::Key<T>& key,
1087 bool* out) {
1088 if (map.Exists(key)) {
1089 *out = true;
1090 }
1091 }
1092
1093 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1094 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1095 // returns, arguments have been successfully parsed.
ParseArgs(int argc,char ** argv)1096 void ParseArgs(int argc, char** argv) {
1097 original_argc = argc;
1098 original_argv = argv;
1099
1100 Locks::Init();
1101 InitLogging(argv, Runtime::Abort);
1102
1103 compiler_options_.reset(new CompilerOptions());
1104
1105 using M = Dex2oatArgumentMap;
1106 std::string error_msg;
1107 std::unique_ptr<M> args_uptr = M::Parse(argc, const_cast<const char**>(argv), &error_msg);
1108 if (args_uptr == nullptr) {
1109 Usage("Failed to parse command line: %s", error_msg.c_str());
1110 UNREACHABLE();
1111 }
1112
1113 M& args = *args_uptr;
1114
1115 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
1116
1117 AssignIfExists(args, M::CompactDexLevel, &compact_dex_level_);
1118 AssignIfExists(args, M::DexFiles, &dex_filenames_);
1119 AssignIfExists(args, M::DexLocations, &dex_locations_);
1120 AssignIfExists(args, M::OatFiles, &oat_filenames_);
1121 AssignIfExists(args, M::OatSymbols, &parser_options->oat_symbols);
1122 AssignTrueIfExists(args, M::Strip, &strip_);
1123 AssignIfExists(args, M::ImageFilenames, &image_filenames_);
1124 AssignIfExists(args, M::ZipFd, &zip_fd_);
1125 AssignIfExists(args, M::ZipLocation, &zip_location_);
1126 AssignIfExists(args, M::InputVdexFd, &input_vdex_fd_);
1127 AssignIfExists(args, M::OutputVdexFd, &output_vdex_fd_);
1128 AssignIfExists(args, M::InputVdex, &input_vdex_);
1129 AssignIfExists(args, M::OutputVdex, &output_vdex_);
1130 AssignIfExists(args, M::DmFd, &dm_fd_);
1131 AssignIfExists(args, M::DmFile, &dm_file_location_);
1132 AssignIfExists(args, M::OatFd, &oat_fd_);
1133 AssignIfExists(args, M::OatLocation, &oat_location_);
1134 AssignIfExists(args, M::Watchdog, &parser_options->watch_dog_enabled);
1135 AssignIfExists(args, M::WatchdogTimeout, &parser_options->watch_dog_timeout_in_ms);
1136 AssignIfExists(args, M::Threads, &thread_count_);
1137 AssignIfExists(args, M::ImageClasses, &image_classes_filename_);
1138 AssignIfExists(args, M::ImageClassesZip, &image_classes_zip_filename_);
1139 AssignIfExists(args, M::Passes, &passes_to_run_filename_);
1140 AssignIfExists(args, M::BootImage, &parser_options->boot_image_filename);
1141 AssignIfExists(args, M::AndroidRoot, &android_root_);
1142 AssignIfExists(args, M::Profile, &profile_file_);
1143 AssignIfExists(args, M::ProfileFd, &profile_file_fd_);
1144 AssignIfExists(args, M::RuntimeOptions, &runtime_args_);
1145 AssignIfExists(args, M::SwapFile, &swap_file_name_);
1146 AssignIfExists(args, M::SwapFileFd, &swap_fd_);
1147 AssignIfExists(args, M::SwapDexSizeThreshold, &min_dex_file_cumulative_size_for_swap_);
1148 AssignIfExists(args, M::SwapDexCountThreshold, &min_dex_files_for_swap_);
1149 AssignIfExists(args, M::VeryLargeAppThreshold, &very_large_threshold_);
1150 AssignIfExists(args, M::AppImageFile, &app_image_file_name_);
1151 AssignIfExists(args, M::AppImageFileFd, &app_image_fd_);
1152 AssignIfExists(args, M::NoInlineFrom, &no_inline_from_string_);
1153 AssignIfExists(args, M::ClasspathDir, &classpath_dir_);
1154 AssignIfExists(args, M::DirtyImageObjects, &dirty_image_objects_filename_);
1155 AssignIfExists(args, M::ImageFormat, &image_storage_mode_);
1156 AssignIfExists(args, M::CompilationReason, &compilation_reason_);
1157
1158 AssignIfExists(args, M::Backend, &compiler_kind_);
1159 parser_options->requested_specific_compiler = args.Exists(M::Backend);
1160
1161 AssignIfExists(args, M::TargetInstructionSet, &compiler_options_->instruction_set_);
1162 // arm actually means thumb2.
1163 if (compiler_options_->instruction_set_ == InstructionSet::kArm) {
1164 compiler_options_->instruction_set_ = InstructionSet::kThumb2;
1165 }
1166
1167 AssignTrueIfExists(args, M::Host, &is_host_);
1168 AssignTrueIfExists(args, M::AvoidStoringInvocation, &avoid_storing_invocation_);
1169 if (args.Exists(M::InvocationFile)) {
1170 invocation_file_.reset(open(args.Get(M::InvocationFile)->c_str(),
1171 O_CREAT|O_WRONLY|O_TRUNC|O_CLOEXEC,
1172 S_IRUSR|S_IWUSR));
1173 if (invocation_file_.get() == -1) {
1174 int err = errno;
1175 Usage("Unable to open invocation file '%s' for writing due to %s.",
1176 args.Get(M::InvocationFile)->c_str(), strerror(err));
1177 }
1178 }
1179 AssignIfExists(args, M::CopyDexFiles, ©_dex_files_);
1180
1181 if (args.Exists(M::ForceDeterminism)) {
1182 if (!SupportsDeterministicCompilation()) {
1183 Usage("Option --force-determinism requires read barriers or a CMS/MS garbage collector");
1184 }
1185 force_determinism_ = true;
1186 }
1187
1188 if (args.Exists(M::Base)) {
1189 ParseBase(*args.Get(M::Base));
1190 }
1191 if (args.Exists(M::TargetInstructionSetVariant)) {
1192 ParseInstructionSetVariant(*args.Get(M::TargetInstructionSetVariant), parser_options.get());
1193 }
1194 if (args.Exists(M::TargetInstructionSetFeatures)) {
1195 ParseInstructionSetFeatures(*args.Get(M::TargetInstructionSetFeatures), parser_options.get());
1196 }
1197 if (args.Exists(M::ClassLoaderContext)) {
1198 std::string class_loader_context_arg = *args.Get(M::ClassLoaderContext);
1199 class_loader_context_ = ClassLoaderContext::Create(class_loader_context_arg);
1200 if (class_loader_context_ == nullptr) {
1201 Usage("Option --class-loader-context has an incorrect format: %s",
1202 class_loader_context_arg.c_str());
1203 }
1204 if (args.Exists(M::ClassLoaderContextFds)) {
1205 std::string str_fds_arg = *args.Get(M::ClassLoaderContextFds);
1206 std::vector<std::string> str_fds = android::base::Split(str_fds_arg, ":");
1207 for (const std::string& str_fd : str_fds) {
1208 class_loader_context_fds_.push_back(std::stoi(str_fd, nullptr, 0));
1209 if (class_loader_context_fds_.back() < 0) {
1210 Usage("Option --class-loader-context-fds has incorrect format: %s",
1211 str_fds_arg.c_str());
1212 }
1213 }
1214 }
1215 if (args.Exists(M::StoredClassLoaderContext)) {
1216 const std::string stored_context_arg = *args.Get(M::StoredClassLoaderContext);
1217 stored_class_loader_context_ = ClassLoaderContext::Create(stored_context_arg);
1218 if (stored_class_loader_context_ == nullptr) {
1219 Usage("Option --stored-class-loader-context has an incorrect format: %s",
1220 stored_context_arg.c_str());
1221 } else if (class_loader_context_->VerifyClassLoaderContextMatch(
1222 stored_context_arg,
1223 /*verify_names*/ false,
1224 /*verify_checksums*/ false) != ClassLoaderContext::VerificationResult::kVerifies) {
1225 Usage(
1226 "Option --stored-class-loader-context '%s' mismatches --class-loader-context '%s'",
1227 stored_context_arg.c_str(),
1228 class_loader_context_arg.c_str());
1229 }
1230 }
1231 } else if (args.Exists(M::StoredClassLoaderContext)) {
1232 Usage("Option --stored-class-loader-context should only be used if "
1233 "--class-loader-context is also specified");
1234 }
1235
1236 if (!ReadCompilerOptions(args, compiler_options_.get(), &error_msg)) {
1237 Usage(error_msg.c_str());
1238 }
1239
1240 ProcessOptions(parser_options.get());
1241
1242 // Insert some compiler things.
1243 InsertCompileOptions(argc, argv);
1244 }
1245
1246 // Check whether the oat output files are writable, and open them for later. Also open a swap
1247 // file, if a name is given.
OpenFile()1248 bool OpenFile() {
1249 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1250 PruneNonExistentDexFiles();
1251
1252 // Expand oat and image filenames for multi image.
1253 if (IsBootImage() && image_filenames_.size() == 1) {
1254 ExpandOatAndImageFilenames();
1255 }
1256
1257 // OAT and VDEX file handling
1258 if (oat_fd_ == -1) {
1259 DCHECK(!oat_filenames_.empty());
1260 for (const std::string& oat_filename : oat_filenames_) {
1261 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename.c_str()));
1262 if (oat_file == nullptr) {
1263 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1264 return false;
1265 }
1266 if (fchmod(oat_file->Fd(), 0644) != 0) {
1267 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1268 oat_file->Erase();
1269 return false;
1270 }
1271 oat_files_.push_back(std::move(oat_file));
1272 DCHECK_EQ(input_vdex_fd_, -1);
1273 if (!input_vdex_.empty()) {
1274 std::string error_msg;
1275 input_vdex_file_ = VdexFile::Open(input_vdex_,
1276 /* writable */ false,
1277 /* low_4gb */ false,
1278 DoEagerUnquickeningOfVdex(),
1279 &error_msg);
1280 }
1281
1282 DCHECK_EQ(output_vdex_fd_, -1);
1283 std::string vdex_filename = output_vdex_.empty()
1284 ? ReplaceFileExtension(oat_filename, "vdex")
1285 : output_vdex_;
1286 if (vdex_filename == input_vdex_ && output_vdex_.empty()) {
1287 update_input_vdex_ = true;
1288 std::unique_ptr<File> vdex_file(OS::OpenFileReadWrite(vdex_filename.c_str()));
1289 vdex_files_.push_back(std::move(vdex_file));
1290 } else {
1291 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
1292 if (vdex_file == nullptr) {
1293 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1294 return false;
1295 }
1296 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1297 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1298 vdex_file->Erase();
1299 return false;
1300 }
1301 vdex_files_.push_back(std::move(vdex_file));
1302 }
1303 }
1304 } else {
1305 std::unique_ptr<File> oat_file(
1306 new File(DupCloexec(oat_fd_), oat_location_, /* check_usage */ true));
1307 if (!oat_file->IsOpened()) {
1308 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1309 return false;
1310 }
1311 if (oat_file->SetLength(0) != 0) {
1312 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1313 oat_file->Erase();
1314 return false;
1315 }
1316 oat_files_.push_back(std::move(oat_file));
1317
1318 if (input_vdex_fd_ != -1) {
1319 struct stat s;
1320 int rc = TEMP_FAILURE_RETRY(fstat(input_vdex_fd_, &s));
1321 if (rc == -1) {
1322 PLOG(WARNING) << "Failed getting length of vdex file";
1323 } else {
1324 std::string error_msg;
1325 input_vdex_file_ = VdexFile::Open(input_vdex_fd_,
1326 s.st_size,
1327 "vdex",
1328 /* writable */ false,
1329 /* low_4gb */ false,
1330 DoEagerUnquickeningOfVdex(),
1331 &error_msg);
1332 // If there's any problem with the passed vdex, just warn and proceed
1333 // without it.
1334 if (input_vdex_file_ == nullptr) {
1335 PLOG(WARNING) << "Failed opening vdex file: " << error_msg;
1336 }
1337 }
1338 }
1339
1340 DCHECK_NE(output_vdex_fd_, -1);
1341 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
1342 std::unique_ptr<File> vdex_file(new File(
1343 DupCloexec(output_vdex_fd_), vdex_location, /* check_usage */ true));
1344 if (!vdex_file->IsOpened()) {
1345 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
1346 return false;
1347 }
1348 if (input_vdex_file_ != nullptr && output_vdex_fd_ == input_vdex_fd_) {
1349 update_input_vdex_ = true;
1350 } else {
1351 if (vdex_file->SetLength(0) != 0) {
1352 PLOG(ERROR) << "Truncating vdex file " << vdex_location << " failed.";
1353 vdex_file->Erase();
1354 return false;
1355 }
1356 }
1357 vdex_files_.push_back(std::move(vdex_file));
1358
1359 oat_filenames_.push_back(oat_location_);
1360 }
1361
1362 // If we're updating in place a vdex file, be defensive and put an invalid vdex magic in case
1363 // dex2oat gets killed.
1364 // Note: we're only invalidating the magic data in the file, as dex2oat needs the rest of
1365 // the information to remain valid.
1366 if (update_input_vdex_) {
1367 std::unique_ptr<BufferedOutputStream> vdex_out =
1368 std::make_unique<BufferedOutputStream>(
1369 std::make_unique<FileOutputStream>(vdex_files_.back().get()));
1370 if (!vdex_out->WriteFully(&VdexFile::VerifierDepsHeader::kVdexInvalidMagic,
1371 arraysize(VdexFile::VerifierDepsHeader::kVdexInvalidMagic))) {
1372 PLOG(ERROR) << "Failed to invalidate vdex header. File: " << vdex_out->GetLocation();
1373 return false;
1374 }
1375
1376 if (!vdex_out->Flush()) {
1377 PLOG(ERROR) << "Failed to flush stream after invalidating header of vdex file."
1378 << " File: " << vdex_out->GetLocation();
1379 return false;
1380 }
1381 }
1382
1383 if (dm_fd_ != -1 || !dm_file_location_.empty()) {
1384 std::string error_msg;
1385 if (dm_fd_ != -1) {
1386 dm_file_.reset(ZipArchive::OpenFromFd(dm_fd_, "DexMetadata", &error_msg));
1387 } else {
1388 dm_file_.reset(ZipArchive::Open(dm_file_location_.c_str(), &error_msg));
1389 }
1390 if (dm_file_ == nullptr) {
1391 LOG(WARNING) << "Could not open DexMetadata archive " << error_msg;
1392 }
1393 }
1394
1395 if (dm_file_ != nullptr) {
1396 DCHECK(input_vdex_file_ == nullptr);
1397 std::string error_msg;
1398 static const char* kDexMetadata = "DexMetadata";
1399 std::unique_ptr<ZipEntry> zip_entry(dm_file_->Find(VdexFile::kVdexNameInDmFile, &error_msg));
1400 if (zip_entry == nullptr) {
1401 LOG(INFO) << "No " << VdexFile::kVdexNameInDmFile << " file in DexMetadata archive. "
1402 << "Not doing fast verification.";
1403 } else {
1404 MemMap input_file = zip_entry->MapDirectlyOrExtract(
1405 VdexFile::kVdexNameInDmFile,
1406 kDexMetadata,
1407 &error_msg,
1408 alignof(VdexFile));
1409 if (!input_file.IsValid()) {
1410 LOG(WARNING) << "Could not open vdex file in DexMetadata archive: " << error_msg;
1411 } else {
1412 input_vdex_file_ = std::make_unique<VdexFile>(std::move(input_file));
1413 VLOG(verifier) << "Doing fast verification with vdex from DexMetadata archive";
1414 }
1415 }
1416 }
1417
1418 // Swap file handling
1419 //
1420 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1421 // that we can use for swap.
1422 //
1423 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1424 // will immediately unlink to satisfy the swap fd assumption.
1425 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1426 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1427 if (swap_file.get() == nullptr) {
1428 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1429 return false;
1430 }
1431 swap_fd_ = swap_file->Release();
1432 unlink(swap_file_name_.c_str());
1433 }
1434
1435 return true;
1436 }
1437
EraseOutputFiles()1438 void EraseOutputFiles() {
1439 for (auto& files : { &vdex_files_, &oat_files_ }) {
1440 for (size_t i = 0; i < files->size(); ++i) {
1441 if ((*files)[i].get() != nullptr) {
1442 (*files)[i]->Erase();
1443 (*files)[i].reset();
1444 }
1445 }
1446 }
1447 }
1448
LoadClassProfileDescriptors()1449 void LoadClassProfileDescriptors() {
1450 if (!IsImage()) {
1451 return;
1452 }
1453 if (profile_compilation_info_ != nullptr) {
1454 // TODO: The following comment looks outdated or misplaced.
1455 // Filter out class path classes since we don't want to include these in the image.
1456 HashSet<std::string> image_classes = profile_compilation_info_->GetClassDescriptors(
1457 compiler_options_->dex_files_for_oat_file_);
1458 VLOG(compiler) << "Loaded " << image_classes.size()
1459 << " image class descriptors from profile";
1460 if (VLOG_IS_ON(compiler)) {
1461 for (const std::string& s : image_classes) {
1462 LOG(INFO) << "Image class " << s;
1463 }
1464 }
1465 // Note: If we have a profile, classes previously loaded for the --image-classes
1466 // option are overwritten here.
1467 compiler_options_->image_classes_.swap(image_classes);
1468 }
1469 }
1470
1471 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1472 // boot class path.
Setup()1473 dex2oat::ReturnCode Setup() {
1474 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
1475
1476 if (!PrepareImageClasses() || !PrepareDirtyObjects()) {
1477 return dex2oat::ReturnCode::kOther;
1478 }
1479
1480 // Verification results are null since we don't know if we will need them yet as the compler
1481 // filter may change.
1482 callbacks_.reset(new QuickCompilerCallbacks(
1483 IsBootImage() ?
1484 CompilerCallbacks::CallbackMode::kCompileBootImage :
1485 CompilerCallbacks::CallbackMode::kCompileApp));
1486
1487 RuntimeArgumentMap runtime_options;
1488 if (!PrepareRuntimeOptions(&runtime_options, callbacks_.get())) {
1489 return dex2oat::ReturnCode::kOther;
1490 }
1491
1492 CreateOatWriters();
1493 if (!AddDexFileSources()) {
1494 return dex2oat::ReturnCode::kOther;
1495 }
1496
1497 if (!compilation_reason_.empty()) {
1498 key_value_store_->Put(OatHeader::kCompilationReasonKey, compilation_reason_);
1499 }
1500
1501 if (IsBootImage()) {
1502 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1503 // We use this when loading the boot image.
1504 key_value_store_->Put(OatHeader::kBootClassPathKey, android::base::Join(dex_locations_, ':'));
1505 }
1506
1507 if (!IsBootImage()) {
1508 // When compiling an app, create the runtime early to retrieve
1509 // the boot image checksums needed for the oat header.
1510 if (!CreateRuntime(std::move(runtime_options))) {
1511 return dex2oat::ReturnCode::kCreateRuntime;
1512 }
1513
1514 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
1515 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1516 Runtime* runtime = Runtime::Current();
1517 key_value_store_->Put(OatHeader::kBootClassPathKey,
1518 android::base::Join(runtime->GetBootClassPathLocations(), ':'));
1519 std::vector<ImageSpace*> image_spaces = runtime->GetHeap()->GetBootImageSpaces();
1520 const std::vector<const DexFile*>& bcp_dex_files =
1521 runtime->GetClassLinker()->GetBootClassPath();
1522 key_value_store_->Put(
1523 OatHeader::kBootClassPathChecksumsKey,
1524 gc::space::ImageSpace::GetBootClassPathChecksums(image_spaces, bcp_dex_files));
1525 }
1526
1527 // Open dex files for class path.
1528
1529 if (class_loader_context_ == nullptr) {
1530 // If no context was specified use the default one (which is an empty PathClassLoader).
1531 class_loader_context_ = ClassLoaderContext::Default();
1532 }
1533
1534 DCHECK_EQ(oat_writers_.size(), 1u);
1535
1536 // Note: Ideally we would reject context where the source dex files are also
1537 // specified in the classpath (as it doesn't make sense). However this is currently
1538 // needed for non-prebuild tests and benchmarks which expects on the fly compilation.
1539 // Also, for secondary dex files we do not have control on the actual classpath.
1540 // Instead of aborting, remove all the source location from the context classpaths.
1541 if (class_loader_context_->RemoveLocationsFromClassPaths(
1542 oat_writers_[0]->GetSourceLocations())) {
1543 LOG(WARNING) << "The source files to be compiled are also in the classpath.";
1544 }
1545
1546 // We need to open the dex files before encoding the context in the oat file.
1547 // (because the encoding adds the dex checksum...)
1548 // TODO(calin): consider redesigning this so we don't have to open the dex files before
1549 // creating the actual class loader.
1550 if (!class_loader_context_->OpenDexFiles(runtime_->GetInstructionSet(),
1551 classpath_dir_,
1552 class_loader_context_fds_)) {
1553 // Do not abort if we couldn't open files from the classpath. They might be
1554 // apks without dex files and right now are opening flow will fail them.
1555 LOG(WARNING) << "Failed to open classpath dex files";
1556 }
1557
1558 // Store the class loader context in the oat header.
1559 // TODO: deprecate this since store_class_loader_context should be enough to cover the users
1560 // of classpath_dir as well.
1561 std::string class_path_key =
1562 class_loader_context_->EncodeContextForOatFile(classpath_dir_,
1563 stored_class_loader_context_.get());
1564 key_value_store_->Put(OatHeader::kClassPathKey, class_path_key);
1565 }
1566
1567 // Now that we have finalized key_value_store_, start writing the oat file.
1568 {
1569 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1570 rodata_.reserve(oat_writers_.size());
1571 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1572 rodata_.push_back(elf_writers_[i]->StartRoData());
1573 // Unzip or copy dex files straight to the oat file.
1574 std::vector<MemMap> opened_dex_files_map;
1575 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
1576 // No need to verify the dex file when we have a vdex file, which means it was already
1577 // verified.
1578 const bool verify = (input_vdex_file_ == nullptr);
1579 if (!oat_writers_[i]->WriteAndOpenDexFiles(
1580 vdex_files_[i].get(),
1581 rodata_.back(),
1582 (i == 0u) ? key_value_store_.get() : nullptr,
1583 verify,
1584 update_input_vdex_,
1585 copy_dex_files_,
1586 &opened_dex_files_map,
1587 &opened_dex_files)) {
1588 return dex2oat::ReturnCode::kOther;
1589 }
1590 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1591 if (opened_dex_files_map.empty()) {
1592 DCHECK(opened_dex_files.empty());
1593 } else {
1594 for (MemMap& map : opened_dex_files_map) {
1595 opened_dex_files_maps_.push_back(std::move(map));
1596 }
1597 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
1598 dex_file_oat_index_map_.emplace(dex_file.get(), i);
1599 opened_dex_files_.push_back(std::move(dex_file));
1600 }
1601 }
1602 }
1603 }
1604
1605 compiler_options_->dex_files_for_oat_file_ = MakeNonOwningPointerVector(opened_dex_files_);
1606 const std::vector<const DexFile*>& dex_files = compiler_options_->dex_files_for_oat_file_;
1607
1608 // If we need to downgrade the compiler-filter for size reasons.
1609 if (!IsBootImage() && IsVeryLarge(dex_files)) {
1610 // Disable app image to make sure dex2oat unloading is enabled.
1611 compiler_options_->image_type_ = CompilerOptions::ImageType::kNone;
1612
1613 // If we need to downgrade the compiler-filter for size reasons, do that early before we read
1614 // it below for creating verification callbacks.
1615 if (!CompilerFilter::IsAsGoodAs(kLargeAppFilter, compiler_options_->GetCompilerFilter())) {
1616 LOG(INFO) << "Very large app, downgrading to verify.";
1617 // Note: this change won't be reflected in the key-value store, as that had to be
1618 // finalized before loading the dex files. This setup is currently required
1619 // to get the size from the DexFile objects.
1620 // TODO: refactor. b/29790079
1621 compiler_options_->SetCompilerFilter(kLargeAppFilter);
1622 }
1623 }
1624
1625 if (CompilerFilter::IsAnyCompilationEnabled(compiler_options_->GetCompilerFilter())) {
1626 // Only modes with compilation require verification results, do this here instead of when we
1627 // create the compilation callbacks since the compilation mode may have been changed by the
1628 // very large app logic.
1629 // Avoiding setting the verification results saves RAM by not adding the dex files later in
1630 // the function.
1631 verification_results_.reset(new VerificationResults(compiler_options_.get()));
1632 callbacks_->SetVerificationResults(verification_results_.get());
1633 }
1634
1635 // We had to postpone the swap decision till now, as this is the point when we actually
1636 // know about the dex files we're going to use.
1637
1638 // Make sure that we didn't create the driver, yet.
1639 CHECK(driver_ == nullptr);
1640 // If we use a swap file, ensure we are above the threshold to make it necessary.
1641 if (swap_fd_ != -1) {
1642 if (!UseSwap(IsBootImage(), dex_files)) {
1643 close(swap_fd_);
1644 swap_fd_ = -1;
1645 VLOG(compiler) << "Decided to run without swap.";
1646 } else {
1647 LOG(INFO) << "Large app, accepted running with swap.";
1648 }
1649 }
1650 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
1651 if (IsBootImage()) {
1652 // For boot image, pass opened dex files to the Runtime::Create().
1653 // Note: Runtime acquires ownership of these dex files.
1654 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
1655 if (!CreateRuntime(std::move(runtime_options))) {
1656 return dex2oat::ReturnCode::kOther;
1657 }
1658 }
1659
1660 // If we're doing the image, override the compiler filter to force full compilation. Must be
1661 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1662 // compilation of class initializers.
1663 // Whilst we're in native take the opportunity to initialize well known classes.
1664 Thread* self = Thread::Current();
1665 WellKnownClasses::Init(self->GetJniEnv());
1666
1667 if (!IsBootImage()) {
1668 constexpr bool kSaveDexInput = false;
1669 if (kSaveDexInput) {
1670 SaveDexInput();
1671 }
1672 }
1673
1674 // Ensure opened dex files are writable for dex-to-dex transformations.
1675 for (MemMap& map : opened_dex_files_maps_) {
1676 if (!map.Protect(PROT_READ | PROT_WRITE)) {
1677 PLOG(ERROR) << "Failed to make .dex files writeable.";
1678 return dex2oat::ReturnCode::kOther;
1679 }
1680 }
1681
1682 // Verification results are only required for modes that have any compilation. Avoid
1683 // adding the dex files if possible to prevent allocating large arrays.
1684 if (verification_results_ != nullptr) {
1685 for (const auto& dex_file : dex_files) {
1686 // Pre-register dex files so that we can access verification results without locks during
1687 // compilation and verification.
1688 verification_results_->AddDexFile(dex_file);
1689 }
1690 }
1691
1692 return dex2oat::ReturnCode::kNoFailure;
1693 }
1694
1695 // If we need to keep the oat file open for the image writer.
ShouldKeepOatFileOpen() const1696 bool ShouldKeepOatFileOpen() const {
1697 return IsImage() && oat_fd_ != kInvalidFd;
1698 }
1699
1700 // Doesn't return the class loader since it's not meant to be used for image compilation.
CompileDexFilesIndividually()1701 void CompileDexFilesIndividually() {
1702 CHECK(!IsImage()) << "Not supported with image";
1703 for (const DexFile* dex_file : compiler_options_->dex_files_for_oat_file_) {
1704 std::vector<const DexFile*> dex_files(1u, dex_file);
1705 VLOG(compiler) << "Compiling " << dex_file->GetLocation();
1706 jobject class_loader = CompileDexFiles(dex_files);
1707 CHECK(class_loader != nullptr);
1708 ScopedObjectAccess soa(Thread::Current());
1709 // Unload class loader to free RAM.
1710 jweak weak_class_loader = soa.Env()->GetVm()->AddWeakGlobalRef(
1711 soa.Self(),
1712 soa.Decode<mirror::ClassLoader>(class_loader));
1713 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), class_loader);
1714 runtime_->GetHeap()->CollectGarbage(/* clear_soft_references */ true);
1715 ObjPtr<mirror::ClassLoader> decoded_weak = soa.Decode<mirror::ClassLoader>(weak_class_loader);
1716 if (decoded_weak != nullptr) {
1717 LOG(FATAL) << "Failed to unload class loader, path from root set: "
1718 << runtime_->GetHeap()->GetVerification()->FirstPathFromRootSet(decoded_weak);
1719 }
1720 VLOG(compiler) << "Unloaded classloader";
1721 }
1722 }
1723
ShouldCompileDexFilesIndividually() const1724 bool ShouldCompileDexFilesIndividually() const {
1725 // Compile individually if we are:
1726 // 1. not building an image,
1727 // 2. not verifying a vdex file,
1728 // 3. using multidex,
1729 // 4. not doing any AOT compilation.
1730 // This means extract, no-vdex verify, and quicken, will use the individual compilation
1731 // mode (to reduce RAM used by the compiler).
1732 return !IsImage() &&
1733 !update_input_vdex_ &&
1734 compiler_options_->dex_files_for_oat_file_.size() > 1 &&
1735 !CompilerFilter::IsAotCompilationEnabled(compiler_options_->GetCompilerFilter());
1736 }
1737
1738 // Set up and create the compiler driver and then invoke it to compile all the dex files.
Compile()1739 jobject Compile() {
1740 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1741
1742 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1743
1744 // Find the dex files we should not inline from.
1745 std::vector<std::string> no_inline_filters;
1746 Split(no_inline_from_string_, ',', &no_inline_filters);
1747
1748 // For now, on the host always have core-oj removed.
1749 const std::string core_oj = "core-oj";
1750 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1751 no_inline_filters.push_back(core_oj);
1752 }
1753
1754 if (!no_inline_filters.empty()) {
1755 std::vector<const DexFile*> class_path_files;
1756 if (!IsBootImage()) {
1757 // The class loader context is used only for apps.
1758 class_path_files = class_loader_context_->FlattenOpenedDexFiles();
1759 }
1760
1761 const std::vector<const DexFile*>& dex_files = compiler_options_->dex_files_for_oat_file_;
1762 std::vector<const DexFile*> no_inline_from_dex_files;
1763 const std::vector<const DexFile*>* dex_file_vectors[] = {
1764 &class_linker->GetBootClassPath(),
1765 &class_path_files,
1766 &dex_files
1767 };
1768 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
1769 for (const DexFile* dex_file : *dex_file_vector) {
1770 for (const std::string& filter : no_inline_filters) {
1771 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
1772 // allows tests to specify <test-dexfile>!classes2.dex if needed but if the
1773 // base location passes the StartsWith() test, so do all extra locations.
1774 std::string dex_location = dex_file->GetLocation();
1775 if (filter.find('/') == std::string::npos) {
1776 // The filter does not contain the path. Remove the path from dex_location as well.
1777 size_t last_slash = dex_file->GetLocation().rfind('/');
1778 if (last_slash != std::string::npos) {
1779 dex_location = dex_location.substr(last_slash + 1);
1780 }
1781 }
1782
1783 if (android::base::StartsWith(dex_location, filter.c_str())) {
1784 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1785 no_inline_from_dex_files.push_back(dex_file);
1786 break;
1787 }
1788 }
1789 }
1790 }
1791 if (!no_inline_from_dex_files.empty()) {
1792 compiler_options_->no_inline_from_.swap(no_inline_from_dex_files);
1793 }
1794 }
1795 compiler_options_->profile_compilation_info_ = profile_compilation_info_.get();
1796
1797 driver_.reset(new CompilerDriver(compiler_options_.get(),
1798 compiler_kind_,
1799 thread_count_,
1800 swap_fd_));
1801 if (!IsBootImage()) {
1802 driver_->SetClasspathDexFiles(class_loader_context_->FlattenOpenedDexFiles());
1803 }
1804
1805 const bool compile_individually = ShouldCompileDexFilesIndividually();
1806 if (compile_individually) {
1807 // Set the compiler driver in the callbacks so that we can avoid re-verification. This not
1808 // only helps performance but also prevents reverifying quickened bytecodes. Attempting
1809 // verify quickened bytecode causes verification failures.
1810 // Only set the compiler filter if we are doing separate compilation since there is a bit
1811 // of overhead when checking if a class was previously verified.
1812 callbacks_->SetDoesClassUnloading(true, driver_.get());
1813 }
1814
1815 // Setup vdex for compilation.
1816 const std::vector<const DexFile*>& dex_files = compiler_options_->dex_files_for_oat_file_;
1817 if (!DoEagerUnquickeningOfVdex() && input_vdex_file_ != nullptr) {
1818 callbacks_->SetVerifierDeps(
1819 new verifier::VerifierDeps(dex_files, input_vdex_file_->GetVerifierDepsData()));
1820
1821 // TODO: we unquicken unconditionally, as we don't know
1822 // if the boot image has changed. How exactly we'll know is under
1823 // experimentation.
1824 TimingLogger::ScopedTiming time_unquicken("Unquicken", timings_);
1825
1826 // We do not decompile a RETURN_VOID_NO_BARRIER into a RETURN_VOID, as the quickening
1827 // optimization does not depend on the boot image (the optimization relies on not
1828 // having final fields in a class, which does not change for an app).
1829 input_vdex_file_->Unquicken(dex_files, /* decompile_return_instruction */ false);
1830 } else {
1831 // Create the main VerifierDeps, here instead of in the compiler since we want to aggregate
1832 // the results for all the dex files, not just the results for the current dex file.
1833 callbacks_->SetVerifierDeps(new verifier::VerifierDeps(dex_files));
1834 }
1835 // Invoke the compilation.
1836 if (compile_individually) {
1837 CompileDexFilesIndividually();
1838 // Return a null classloader since we already freed released it.
1839 return nullptr;
1840 }
1841 return CompileDexFiles(dex_files);
1842 }
1843
1844 // Create the class loader, use it to compile, and return.
CompileDexFiles(const std::vector<const DexFile * > & dex_files)1845 jobject CompileDexFiles(const std::vector<const DexFile*>& dex_files) {
1846 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1847
1848 jobject class_loader = nullptr;
1849 if (!IsBootImage()) {
1850 class_loader =
1851 class_loader_context_->CreateClassLoader(compiler_options_->dex_files_for_oat_file_);
1852 callbacks_->SetDexFiles(&dex_files);
1853 }
1854
1855 // Register dex caches and key them to the class loader so that they only unload when the
1856 // class loader unloads.
1857 for (const auto& dex_file : dex_files) {
1858 ScopedObjectAccess soa(Thread::Current());
1859 // Registering the dex cache adds a strong root in the class loader that prevents the dex
1860 // cache from being unloaded early.
1861 ObjPtr<mirror::DexCache> dex_cache = class_linker->RegisterDexFile(
1862 *dex_file,
1863 soa.Decode<mirror::ClassLoader>(class_loader));
1864 if (dex_cache == nullptr) {
1865 soa.Self()->AssertPendingException();
1866 LOG(FATAL) << "Failed to register dex file " << dex_file->GetLocation() << " "
1867 << soa.Self()->GetException()->Dump();
1868 }
1869 }
1870 driver_->InitializeThreadPools();
1871 driver_->PreCompile(class_loader,
1872 dex_files,
1873 timings_,
1874 &compiler_options_->image_classes_,
1875 verification_results_.get());
1876 callbacks_->SetVerificationResults(nullptr); // Should not be needed anymore.
1877 compiler_options_->verification_results_ = verification_results_.get();
1878 driver_->CompileAll(class_loader, dex_files, timings_);
1879 driver_->FreeThreadPools();
1880 return class_loader;
1881 }
1882
1883 // Notes on the interleaving of creating the images and oat files to
1884 // ensure the references between the two are correct.
1885 //
1886 // Currently we have a memory layout that looks something like this:
1887 //
1888 // +--------------+
1889 // | images |
1890 // +--------------+
1891 // | oat files |
1892 // +--------------+
1893 // | alloc spaces |
1894 // +--------------+
1895 //
1896 // There are several constraints on the loading of the images and oat files.
1897 //
1898 // 1. The images are expected to be loaded at an absolute address and
1899 // contain Objects with absolute pointers within the images.
1900 //
1901 // 2. There are absolute pointers from Methods in the images to their
1902 // code in the oat files.
1903 //
1904 // 3. There are absolute pointers from the code in the oat files to Methods
1905 // in the images.
1906 //
1907 // 4. There are absolute pointers from code in the oat files to other code
1908 // in the oat files.
1909 //
1910 // To get this all correct, we go through several steps.
1911 //
1912 // 1. We prepare offsets for all data in the oat files and calculate
1913 // the oat data size and code size. During this stage, we also set
1914 // oat code offsets in methods for use by the image writer.
1915 //
1916 // 2. We prepare offsets for the objects in the images and calculate
1917 // the image sizes.
1918 //
1919 // 3. We create the oat files. Originally this was just our own proprietary
1920 // file but now it is contained within an ELF dynamic object (aka an .so
1921 // file). Since we know the image sizes and oat data sizes and code sizes we
1922 // can prepare the ELF headers and we then know the ELF memory segment
1923 // layout and we can now resolve all references. The compiler provides
1924 // LinkerPatch information in each CompiledMethod and we resolve these,
1925 // using the layout information and image object locations provided by
1926 // image writer, as we're writing the method code.
1927 //
1928 // 4. We create the image files. They need to know where the oat files
1929 // will be loaded after itself. Originally oat files were simply
1930 // memory mapped so we could predict where their contents were based
1931 // on the file size. Now that they are ELF files, we need to inspect
1932 // the ELF files to understand the in memory segment layout including
1933 // where the oat header is located within.
1934 // TODO: We could just remember this information from step 3.
1935 //
1936 // 5. We fixup the ELF program headers so that dlopen will try to
1937 // load the .so at the desired location at runtime by offsetting the
1938 // Elf32_Phdr.p_vaddr values by the desired base address.
1939 // TODO: Do this in step 3. We already know the layout there.
1940 //
1941 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1942 // are done by the CreateImageFile() below.
1943
1944 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1945 // ImageWriter, if necessary.
1946 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1947 // case (when the file will be explicitly erased).
WriteOutputFiles(jobject class_loader)1948 bool WriteOutputFiles(jobject class_loader) {
1949 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1950
1951 // Sync the data to the file, in case we did dex2dex transformations.
1952 for (MemMap& map : opened_dex_files_maps_) {
1953 if (!map.Sync()) {
1954 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map.GetName();
1955 return false;
1956 }
1957 }
1958
1959 if (IsImage()) {
1960 if (IsAppImage() && image_base_ == 0) {
1961 gc::Heap* const heap = Runtime::Current()->GetHeap();
1962 for (ImageSpace* image_space : heap->GetBootImageSpaces()) {
1963 image_base_ = std::max(image_base_, RoundUp(
1964 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1965 kPageSize));
1966 }
1967 // The non moving space is right after the oat file. Put the preferred app image location
1968 // right after the non moving space so that we ideally get a continuous immune region for
1969 // the GC.
1970 // Use the default non moving space capacity since dex2oat does not have a separate non-
1971 // moving space. This means the runtime's non moving space space size will be as large
1972 // as the growth limit for dex2oat, but smaller in the zygote.
1973 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
1974 image_base_ += non_moving_space_capacity;
1975 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1976 }
1977
1978 image_writer_.reset(new linker::ImageWriter(*compiler_options_,
1979 image_base_,
1980 image_storage_mode_,
1981 oat_filenames_,
1982 dex_file_oat_index_map_,
1983 class_loader,
1984 dirty_image_objects_.get()));
1985
1986 // We need to prepare method offsets in the image address space for direct method patching.
1987 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1988 if (!image_writer_->PrepareImageAddressSpace(timings_)) {
1989 LOG(ERROR) << "Failed to prepare image address space.";
1990 return false;
1991 }
1992 }
1993
1994 // Initialize the writers with the compiler driver, image writer, and their
1995 // dex files. The writers were created without those being there yet.
1996 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1997 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
1998 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1999 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
2000 }
2001
2002 {
2003 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
2004 DCHECK(IsBootImage() || oat_files_.size() == 1u);
2005 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
2006 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
2007 File* vdex_file = vdex_files_[i].get();
2008 std::unique_ptr<BufferedOutputStream> vdex_out =
2009 std::make_unique<BufferedOutputStream>(
2010 std::make_unique<FileOutputStream>(vdex_file));
2011
2012 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
2013 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
2014 return false;
2015 }
2016
2017 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
2018 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
2019 return false;
2020 }
2021
2022 // VDEX finalized, seek back to the beginning and write checksums and the header.
2023 if (!oat_writers_[i]->WriteChecksumsAndVdexHeader(vdex_out.get())) {
2024 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
2025 return false;
2026 }
2027 }
2028 }
2029
2030 {
2031 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
2032 linker::MultiOatRelativePatcher patcher(compiler_options_->GetInstructionSet(),
2033 compiler_options_->GetInstructionSetFeatures(),
2034 driver_->GetCompiledMethodStorage());
2035 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
2036 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2037 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
2038
2039 oat_writer->PrepareLayout(&patcher);
2040 elf_writer->PrepareDynamicSection(oat_writer->GetOatHeader().GetExecutableOffset(),
2041 oat_writer->GetCodeSize(),
2042 oat_writer->GetDataBimgRelRoSize(),
2043 oat_writer->GetBssSize(),
2044 oat_writer->GetBssMethodsOffset(),
2045 oat_writer->GetBssRootsOffset(),
2046 oat_writer->GetVdexSize());
2047 if (IsImage()) {
2048 // Update oat layout.
2049 DCHECK(image_writer_ != nullptr);
2050 DCHECK_LT(i, oat_filenames_.size());
2051 image_writer_->UpdateOatFileLayout(i,
2052 elf_writer->GetLoadedSize(),
2053 oat_writer->GetOatDataOffset(),
2054 oat_writer->GetOatSize());
2055 }
2056 }
2057
2058 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
2059 std::unique_ptr<File>& oat_file = oat_files_[i];
2060 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2061 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
2062
2063 // We need to mirror the layout of the ELF file in the compressed debug-info.
2064 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
2065 debug::DebugInfo debug_info = oat_writer->GetDebugInfo(); // Keep the variable alive.
2066 elf_writer->PrepareDebugInfo(debug_info); // Processes the data on background thread.
2067
2068 OutputStream*& rodata = rodata_[i];
2069 DCHECK(rodata != nullptr);
2070 if (!oat_writer->WriteRodata(rodata)) {
2071 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
2072 return false;
2073 }
2074 elf_writer->EndRoData(rodata);
2075 rodata = nullptr;
2076
2077 OutputStream* text = elf_writer->StartText();
2078 if (!oat_writer->WriteCode(text)) {
2079 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
2080 return false;
2081 }
2082 elf_writer->EndText(text);
2083
2084 if (oat_writer->GetDataBimgRelRoSize() != 0u) {
2085 OutputStream* data_bimg_rel_ro = elf_writer->StartDataBimgRelRo();
2086 if (!oat_writer->WriteDataBimgRelRo(data_bimg_rel_ro)) {
2087 LOG(ERROR) << "Failed to write .data.bimg.rel.ro section to the ELF file "
2088 << oat_file->GetPath();
2089 return false;
2090 }
2091 elf_writer->EndDataBimgRelRo(data_bimg_rel_ro);
2092 }
2093
2094 if (!oat_writer->WriteHeader(elf_writer->GetStream())) {
2095 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
2096 return false;
2097 }
2098
2099 if (IsImage()) {
2100 // Update oat header information.
2101 DCHECK(image_writer_ != nullptr);
2102 DCHECK_LT(i, oat_filenames_.size());
2103 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
2104 }
2105
2106 elf_writer->WriteDynamicSection();
2107 elf_writer->WriteDebugInfo(oat_writer->GetDebugInfo());
2108
2109 if (!elf_writer->End()) {
2110 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
2111 return false;
2112 }
2113
2114 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
2115 return false;
2116 }
2117
2118 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
2119
2120 oat_writer.reset();
2121 // We may still need the ELF writer later for stripping.
2122 }
2123 }
2124
2125 return true;
2126 }
2127
2128 // If we are compiling an image, invoke the image creation routine. Else just skip.
HandleImage()2129 bool HandleImage() {
2130 if (IsImage()) {
2131 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
2132 if (!CreateImageFile()) {
2133 return false;
2134 }
2135 VLOG(compiler) << "Images written successfully";
2136 }
2137 return true;
2138 }
2139
2140 // Copy the full oat files to symbols directory and then strip the originals.
CopyOatFilesToSymbolsDirectoryAndStrip()2141 bool CopyOatFilesToSymbolsDirectoryAndStrip() {
2142 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
2143 // If we don't want to strip in place, copy from stripped location to unstripped location.
2144 // We need to strip after image creation because FixupElf needs to use .strtab.
2145 if (oat_unstripped_[i] != oat_filenames_[i]) {
2146 DCHECK(oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened());
2147
2148 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
2149 std::unique_ptr<File>& in = oat_files_[i];
2150 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i].c_str()));
2151 int64_t in_length = in->GetLength();
2152 if (in_length < 0) {
2153 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
2154 return false;
2155 }
2156 if (!out->Copy(in.get(), 0, in_length)) {
2157 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
2158 return false;
2159 }
2160 if (out->FlushCloseOrErase() != 0) {
2161 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
2162 return false;
2163 }
2164 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
2165
2166 if (strip_) {
2167 TimingLogger::ScopedTiming t2("dex2oat OatFile strip", timings_);
2168 if (!elf_writers_[i]->StripDebugInfo()) {
2169 PLOG(ERROR) << "Failed strip oat file: " << in->GetPath();
2170 return false;
2171 }
2172 }
2173 }
2174 }
2175 return true;
2176 }
2177
FlushOutputFile(std::unique_ptr<File> * file)2178 bool FlushOutputFile(std::unique_ptr<File>* file) {
2179 if (file->get() != nullptr) {
2180 if (file->get()->Flush() != 0) {
2181 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
2182 return false;
2183 }
2184 }
2185 return true;
2186 }
2187
FlushCloseOutputFile(File * file)2188 bool FlushCloseOutputFile(File* file) {
2189 if (file != nullptr) {
2190 if (file->FlushCloseOrErase() != 0) {
2191 PLOG(ERROR) << "Failed to flush and close output file: " << file->GetPath();
2192 return false;
2193 }
2194 }
2195 return true;
2196 }
2197
FlushOutputFiles()2198 bool FlushOutputFiles() {
2199 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
2200 for (auto& files : { &vdex_files_, &oat_files_ }) {
2201 for (size_t i = 0; i < files->size(); ++i) {
2202 if (!FlushOutputFile(&(*files)[i])) {
2203 return false;
2204 }
2205 }
2206 }
2207 return true;
2208 }
2209
FlushCloseOutputFiles()2210 bool FlushCloseOutputFiles() {
2211 bool result = true;
2212 for (auto& files : { &vdex_files_, &oat_files_ }) {
2213 for (size_t i = 0; i < files->size(); ++i) {
2214 result &= FlushCloseOutputFile((*files)[i].get());
2215 }
2216 }
2217 return result;
2218 }
2219
DumpTiming()2220 void DumpTiming() {
2221 if (compiler_options_->GetDumpTimings() ||
2222 (kIsDebugBuild && timings_->GetTotalNs() > MsToNs(1000))) {
2223 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2224 }
2225 }
2226
IsImage() const2227 bool IsImage() const {
2228 return IsAppImage() || IsBootImage();
2229 }
2230
IsAppImage() const2231 bool IsAppImage() const {
2232 return compiler_options_->IsAppImage();
2233 }
2234
IsBootImage() const2235 bool IsBootImage() const {
2236 return compiler_options_->IsBootImage();
2237 }
2238
IsHost() const2239 bool IsHost() const {
2240 return is_host_;
2241 }
2242
UseProfile() const2243 bool UseProfile() const {
2244 return profile_file_fd_ != -1 || !profile_file_.empty();
2245 }
2246
DoProfileGuidedOptimizations() const2247 bool DoProfileGuidedOptimizations() const {
2248 return UseProfile();
2249 }
2250
DoGenerateCompactDex() const2251 bool DoGenerateCompactDex() const {
2252 return compact_dex_level_ != CompactDexLevel::kCompactDexLevelNone;
2253 }
2254
DoDexLayoutOptimizations() const2255 bool DoDexLayoutOptimizations() const {
2256 return DoProfileGuidedOptimizations() || DoGenerateCompactDex();
2257 }
2258
DoOatLayoutOptimizations() const2259 bool DoOatLayoutOptimizations() const {
2260 return DoProfileGuidedOptimizations();
2261 }
2262
MayInvalidateVdexMetadata() const2263 bool MayInvalidateVdexMetadata() const {
2264 // DexLayout can invalidate the vdex metadata if changing the class def order is enabled, so
2265 // we need to unquicken the vdex file eagerly, before passing it to dexlayout.
2266 return DoDexLayoutOptimizations();
2267 }
2268
DoEagerUnquickeningOfVdex() const2269 bool DoEagerUnquickeningOfVdex() const {
2270 return MayInvalidateVdexMetadata() && dm_file_ == nullptr;
2271 }
2272
LoadProfile()2273 bool LoadProfile() {
2274 DCHECK(UseProfile());
2275 // TODO(calin): We should be using the runtime arena pool (instead of the
2276 // default profile arena). However the setup logic is messy and needs
2277 // cleaning up before that (e.g. the oat writers are created before the
2278 // runtime).
2279 profile_compilation_info_.reset(new ProfileCompilationInfo());
2280 ScopedFlock profile_file;
2281 std::string error;
2282 if (profile_file_fd_ != -1) {
2283 profile_file = LockedFile::DupOf(profile_file_fd_, "profile",
2284 true /* read_only_mode */, &error);
2285 } else if (profile_file_ != "") {
2286 profile_file = LockedFile::Open(profile_file_.c_str(), O_RDONLY, true, &error);
2287 }
2288
2289 // Return early if we're unable to obtain a lock on the profile.
2290 if (profile_file.get() == nullptr) {
2291 LOG(ERROR) << "Cannot lock profiles: " << error;
2292 return false;
2293 }
2294
2295 if (!profile_compilation_info_->Load(profile_file->Fd())) {
2296 profile_compilation_info_.reset(nullptr);
2297 return false;
2298 }
2299
2300 return true;
2301 }
2302
2303 private:
UseSwap(bool is_image,const std::vector<const DexFile * > & dex_files)2304 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2305 if (is_image) {
2306 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2307 return false;
2308 }
2309 if (dex_files.size() < min_dex_files_for_swap_) {
2310 // If there are less dex files than the threshold, assume it's gonna be fine.
2311 return false;
2312 }
2313 size_t dex_files_size = 0;
2314 for (const auto* dex_file : dex_files) {
2315 dex_files_size += dex_file->GetHeader().file_size_;
2316 }
2317 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2318 }
2319
IsVeryLarge(const std::vector<const DexFile * > & dex_files)2320 bool IsVeryLarge(const std::vector<const DexFile*>& dex_files) {
2321 size_t dex_files_size = 0;
2322 for (const auto* dex_file : dex_files) {
2323 dex_files_size += dex_file->GetHeader().file_size_;
2324 }
2325 return dex_files_size >= very_large_threshold_;
2326 }
2327
PrepareImageClasses()2328 bool PrepareImageClasses() {
2329 // If --image-classes was specified, calculate the full list of classes to include in the image.
2330 DCHECK(compiler_options_->image_classes_.empty());
2331 if (image_classes_filename_ != nullptr) {
2332 std::unique_ptr<HashSet<std::string>> image_classes =
2333 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2334 if (image_classes == nullptr) {
2335 return false;
2336 }
2337 compiler_options_->image_classes_.swap(*image_classes);
2338 }
2339 return true;
2340 }
2341
ReadClasses(const char * zip_filename,const char * classes_filename,const char * tag)2342 static std::unique_ptr<HashSet<std::string>> ReadClasses(const char* zip_filename,
2343 const char* classes_filename,
2344 const char* tag) {
2345 std::unique_ptr<HashSet<std::string>> classes;
2346 std::string error_msg;
2347 if (zip_filename != nullptr) {
2348 classes = ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg);
2349 } else {
2350 classes = ReadImageClassesFromFile(classes_filename);
2351 }
2352 if (classes == nullptr) {
2353 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2354 << classes_filename << "': " << error_msg;
2355 }
2356 return classes;
2357 }
2358
PrepareDirtyObjects()2359 bool PrepareDirtyObjects() {
2360 if (dirty_image_objects_filename_ != nullptr) {
2361 dirty_image_objects_ = ReadCommentedInputFromFile<HashSet<std::string>>(
2362 dirty_image_objects_filename_,
2363 nullptr);
2364 if (dirty_image_objects_ == nullptr) {
2365 LOG(ERROR) << "Failed to create list of dirty objects from '"
2366 << dirty_image_objects_filename_ << "'";
2367 return false;
2368 }
2369 } else {
2370 dirty_image_objects_.reset(nullptr);
2371 }
2372 return true;
2373 }
2374
PruneNonExistentDexFiles()2375 void PruneNonExistentDexFiles() {
2376 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2377 size_t kept = 0u;
2378 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2379 if (!OS::FileExists(dex_filenames_[i].c_str())) {
2380 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2381 } else {
2382 if (kept != i) {
2383 dex_filenames_[kept] = dex_filenames_[i];
2384 dex_locations_[kept] = dex_locations_[i];
2385 }
2386 ++kept;
2387 }
2388 }
2389 dex_filenames_.resize(kept);
2390 dex_locations_.resize(kept);
2391 }
2392
AddDexFileSources()2393 bool AddDexFileSources() {
2394 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
2395 if (input_vdex_file_ != nullptr && input_vdex_file_->HasDexSection()) {
2396 DCHECK_EQ(oat_writers_.size(), 1u);
2397 const std::string& name = zip_location_.empty() ? dex_locations_[0] : zip_location_;
2398 DCHECK(!name.empty());
2399 if (!oat_writers_[0]->AddVdexDexFilesSource(*input_vdex_file_.get(), name.c_str())) {
2400 return false;
2401 }
2402 } else if (zip_fd_ != -1) {
2403 DCHECK_EQ(oat_writers_.size(), 1u);
2404 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2405 zip_location_.c_str())) {
2406 return false;
2407 }
2408 } else if (oat_writers_.size() > 1u) {
2409 // Multi-image.
2410 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2411 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2412 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2413 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i].c_str(),
2414 dex_locations_[i].c_str())) {
2415 return false;
2416 }
2417 }
2418 } else {
2419 DCHECK_EQ(oat_writers_.size(), 1u);
2420 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2421 DCHECK_NE(dex_filenames_.size(), 0u);
2422 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2423 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i].c_str(),
2424 dex_locations_[i].c_str())) {
2425 return false;
2426 }
2427 }
2428 }
2429 return true;
2430 }
2431
CreateOatWriters()2432 void CreateOatWriters() {
2433 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2434 elf_writers_.reserve(oat_files_.size());
2435 oat_writers_.reserve(oat_files_.size());
2436 for (const std::unique_ptr<File>& oat_file : oat_files_) {
2437 elf_writers_.emplace_back(linker::CreateElfWriterQuick(*compiler_options_, oat_file.get()));
2438 elf_writers_.back()->Start();
2439 bool do_oat_writer_layout = DoDexLayoutOptimizations() || DoOatLayoutOptimizations();
2440 if (profile_compilation_info_ != nullptr && profile_compilation_info_->IsEmpty()) {
2441 do_oat_writer_layout = false;
2442 }
2443 oat_writers_.emplace_back(new linker::OatWriter(
2444 *compiler_options_,
2445 timings_,
2446 do_oat_writer_layout ? profile_compilation_info_.get() : nullptr,
2447 compact_dex_level_));
2448 }
2449 }
2450
SaveDexInput()2451 void SaveDexInput() {
2452 const std::vector<const DexFile*>& dex_files = compiler_options_->dex_files_for_oat_file_;
2453 for (size_t i = 0, size = dex_files.size(); i != size; ++i) {
2454 const DexFile* dex_file = dex_files[i];
2455 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2456 getpid(), i));
2457 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2458 if (tmp_file.get() == nullptr) {
2459 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2460 << ". Try: adb shell chmod 777 /data/local/tmp";
2461 continue;
2462 }
2463 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2464 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2465 UNUSED(tmp_file->Flush());
2466 UNUSED(tmp_file->Close());
2467 LOG(INFO) << "Wrote input to " << tmp_file_name;
2468 }
2469 }
2470
PrepareRuntimeOptions(RuntimeArgumentMap * runtime_options,QuickCompilerCallbacks * callbacks)2471 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options,
2472 QuickCompilerCallbacks* callbacks) {
2473 RuntimeOptions raw_options;
2474 if (boot_image_filename_.empty()) {
2475 std::string boot_class_path = "-Xbootclasspath:";
2476 boot_class_path += android::base::Join(dex_filenames_, ':');
2477 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2478 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
2479 boot_class_path_locations += android::base::Join(dex_locations_, ':');
2480 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2481 } else {
2482 std::string boot_image_option = "-Ximage:";
2483 boot_image_option += boot_image_filename_;
2484 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2485 }
2486 for (size_t i = 0; i < runtime_args_.size(); i++) {
2487 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2488 }
2489
2490 raw_options.push_back(std::make_pair("compilercallbacks", callbacks));
2491 raw_options.push_back(
2492 std::make_pair("imageinstructionset",
2493 GetInstructionSetString(compiler_options_->GetInstructionSet())));
2494
2495 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2496 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2497 // have been stripped in preopting, anyways).
2498 if (!IsBootImage()) {
2499 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2500 }
2501 // Never allow implicit image compilation.
2502 raw_options.push_back(std::make_pair("-Xnoimage-dex2oat", nullptr));
2503 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2504 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2505 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
2506 // Disable Hspace compaction to save heap size virtual space.
2507 // Only need disable Hspace for OOM becasue background collector is equal to
2508 // foreground collector by default for dex2oat.
2509 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
2510
2511 if (compiler_options_->IsForceDeterminism()) {
2512 // If we're asked to be deterministic, ensure non-concurrent GC for determinism.
2513 //
2514 // Note that with read barriers, this option is ignored, because Runtime::Init
2515 // overrides the foreground GC to be gc::kCollectorTypeCC when instantiating
2516 // gc::Heap. This is fine, as concurrent GC requests are not honored in dex2oat,
2517 // which uses an unstarted runtime.
2518 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
2519
2520 // The default LOS implementation (map) is not deterministic. So disable it.
2521 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=disabled", nullptr));
2522
2523 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2524 // compaction (done above) and ensure that neither foreground nor background collectors
2525 // are concurrent.
2526 //
2527 // Likewise, this option is ignored with read barriers because Runtime::Init
2528 // overrides the background GC to be gc::kCollectorTypeCCBackground, but that's
2529 // fine too, for the same reason (see above).
2530 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2531
2532 // To make identity hashcode deterministic, set a known seed.
2533 mirror::Object::SetHashCodeSeed(987654321U);
2534 }
2535
2536 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2537 LOG(ERROR) << "Failed to parse runtime options";
2538 return false;
2539 }
2540 return true;
2541 }
2542
2543 // Create a runtime necessary for compilation.
CreateRuntime(RuntimeArgumentMap && runtime_options)2544 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2545 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
2546 if (!Runtime::Create(std::move(runtime_options))) {
2547 LOG(ERROR) << "Failed to create runtime";
2548 return false;
2549 }
2550
2551 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2552 // "ps -a" don't change to non-descript "main."
2553 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2554
2555 runtime_.reset(Runtime::Current());
2556 runtime_->SetInstructionSet(compiler_options_->GetInstructionSet());
2557 for (uint32_t i = 0; i < static_cast<uint32_t>(CalleeSaveType::kLastCalleeSaveType); ++i) {
2558 CalleeSaveType type = CalleeSaveType(i);
2559 if (!runtime_->HasCalleeSaveMethod(type)) {
2560 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
2561 }
2562 }
2563
2564 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2565 // set up.
2566 interpreter::UnstartedRuntime::Initialize();
2567
2568 Thread* self = Thread::Current();
2569 runtime_->RunRootClinits(self);
2570
2571 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2572 // Runtime::Start, give it away now so that we don't starve GC.
2573 self->TransitionFromRunnableToSuspended(kNative);
2574
2575 WatchDog::SetRuntime(runtime_.get());
2576
2577 return true;
2578 }
2579
2580 // Let the ImageWriter write the image files. If we do not compile PIC, also fix up the oat files.
CreateImageFile()2581 bool CreateImageFile()
2582 REQUIRES(!Locks::mutator_lock_) {
2583 CHECK(image_writer_ != nullptr);
2584 if (!IsBootImage()) {
2585 CHECK(image_filenames_.empty());
2586 image_filenames_.push_back(app_image_file_name_);
2587 }
2588 if (!image_writer_->Write(app_image_fd_,
2589 image_filenames_,
2590 oat_filenames_)) {
2591 LOG(ERROR) << "Failure during image file creation";
2592 return false;
2593 }
2594
2595 // We need the OatDataBegin entries.
2596 dchecked_vector<uintptr_t> oat_data_begins;
2597 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2598 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
2599 }
2600 // Destroy ImageWriter.
2601 image_writer_.reset();
2602
2603 return true;
2604 }
2605
2606 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
ReadImageClassesFromFile(const char * image_classes_filename)2607 static std::unique_ptr<HashSet<std::string>> ReadImageClassesFromFile(
2608 const char* image_classes_filename) {
2609 std::function<std::string(const char*)> process = DotToDescriptor;
2610 return ReadCommentedInputFromFile<HashSet<std::string>>(image_classes_filename, &process);
2611 }
2612
2613 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
ReadImageClassesFromZip(const char * zip_filename,const char * image_classes_filename,std::string * error_msg)2614 static std::unique_ptr<HashSet<std::string>> ReadImageClassesFromZip(
2615 const char* zip_filename,
2616 const char* image_classes_filename,
2617 std::string* error_msg) {
2618 std::function<std::string(const char*)> process = DotToDescriptor;
2619 return ReadCommentedInputFromZip<HashSet<std::string>>(zip_filename,
2620 image_classes_filename,
2621 &process,
2622 error_msg);
2623 }
2624
2625 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2626 // the given function.
2627 template <typename T>
ReadCommentedInputFromFile(const char * input_filename,std::function<std::string (const char *)> * process)2628 static std::unique_ptr<T> ReadCommentedInputFromFile(
2629 const char* input_filename, std::function<std::string(const char*)>* process) {
2630 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2631 if (input_file.get() == nullptr) {
2632 LOG(ERROR) << "Failed to open input file " << input_filename;
2633 return nullptr;
2634 }
2635 std::unique_ptr<T> result = ReadCommentedInputStream<T>(*input_file, process);
2636 input_file->close();
2637 return result;
2638 }
2639
2640 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2641 // Post-process each line with the given function.
2642 template <typename T>
ReadCommentedInputFromZip(const char * zip_filename,const char * input_filename,std::function<std::string (const char *)> * process,std::string * error_msg)2643 static std::unique_ptr<T> ReadCommentedInputFromZip(
2644 const char* zip_filename,
2645 const char* input_filename,
2646 std::function<std::string(const char*)>* process,
2647 std::string* error_msg) {
2648 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2649 if (zip_archive.get() == nullptr) {
2650 return nullptr;
2651 }
2652 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
2653 if (zip_entry.get() == nullptr) {
2654 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
2655 zip_filename, error_msg->c_str());
2656 return nullptr;
2657 }
2658 MemMap input_file = zip_entry->ExtractToMemMap(zip_filename, input_filename, error_msg);
2659 if (!input_file.IsValid()) {
2660 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
2661 zip_filename, error_msg->c_str());
2662 return nullptr;
2663 }
2664 const std::string input_string(reinterpret_cast<char*>(input_file.Begin()), input_file.Size());
2665 std::istringstream input_stream(input_string);
2666 return ReadCommentedInputStream<T>(input_stream, process);
2667 }
2668
2669 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2670 // with the given function.
2671 template <typename T>
ReadCommentedInputStream(std::istream & in_stream,std::function<std::string (const char *)> * process)2672 static std::unique_ptr<T> ReadCommentedInputStream(
2673 std::istream& in_stream,
2674 std::function<std::string(const char*)>* process) {
2675 std::unique_ptr<T> output(new T());
2676 while (in_stream.good()) {
2677 std::string dot;
2678 std::getline(in_stream, dot);
2679 if (android::base::StartsWith(dot, "#") || dot.empty()) {
2680 continue;
2681 }
2682 if (process != nullptr) {
2683 std::string descriptor((*process)(dot.c_str()));
2684 output->insert(output->end(), descriptor);
2685 } else {
2686 output->insert(output->end(), dot);
2687 }
2688 }
2689 return output;
2690 }
2691
LogCompletionTime()2692 void LogCompletionTime() {
2693 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2694 // is no image, there won't be a Runtime::Current().
2695 // Note: driver creation can fail when loading an invalid dex file.
2696 LOG(INFO) << "dex2oat took "
2697 << PrettyDuration(NanoTime() - start_ns_)
2698 << " (" << PrettyDuration(ProcessCpuNanoTime() - start_cputime_ns_) << " cpu)"
2699 << " (threads: " << thread_count_ << ") "
2700 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
2701 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2702 "");
2703 }
2704
StripIsaFrom(const char * image_filename,InstructionSet isa)2705 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2706 std::string res(image_filename);
2707 size_t last_slash = res.rfind('/');
2708 if (last_slash == std::string::npos || last_slash == 0) {
2709 return res;
2710 }
2711 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2712 if (penultimate_slash == std::string::npos) {
2713 return res;
2714 }
2715 // Check that the string in-between is the expected one.
2716 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2717 GetInstructionSetString(isa)) {
2718 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2719 return res;
2720 }
2721 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2722 }
2723
2724 std::unique_ptr<CompilerOptions> compiler_options_;
2725 Compiler::Kind compiler_kind_;
2726
2727 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2728
2729 std::unique_ptr<VerificationResults> verification_results_;
2730
2731 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2732
2733 std::unique_ptr<Runtime> runtime_;
2734
2735 // The spec describing how the class loader should be setup for compilation.
2736 std::unique_ptr<ClassLoaderContext> class_loader_context_;
2737
2738 // Optional list of file descriptors corresponding to dex file locations in
2739 // flattened `class_loader_context_`.
2740 std::vector<int> class_loader_context_fds_;
2741
2742 // The class loader context stored in the oat file. May be equal to class_loader_context_.
2743 std::unique_ptr<ClassLoaderContext> stored_class_loader_context_;
2744
2745 size_t thread_count_;
2746 uint64_t start_ns_;
2747 uint64_t start_cputime_ns_;
2748 std::unique_ptr<WatchDog> watchdog_;
2749 std::vector<std::unique_ptr<File>> oat_files_;
2750 std::vector<std::unique_ptr<File>> vdex_files_;
2751 std::string oat_location_;
2752 std::vector<std::string> oat_filenames_;
2753 std::vector<std::string> oat_unstripped_;
2754 bool strip_;
2755 int oat_fd_;
2756 int input_vdex_fd_;
2757 int output_vdex_fd_;
2758 std::string input_vdex_;
2759 std::string output_vdex_;
2760 std::unique_ptr<VdexFile> input_vdex_file_;
2761 int dm_fd_;
2762 std::string dm_file_location_;
2763 std::unique_ptr<ZipArchive> dm_file_;
2764 std::vector<std::string> dex_filenames_;
2765 std::vector<std::string> dex_locations_;
2766 int zip_fd_;
2767 std::string zip_location_;
2768 std::string boot_image_filename_;
2769 std::vector<const char*> runtime_args_;
2770 std::vector<std::string> image_filenames_;
2771 uintptr_t image_base_;
2772 const char* image_classes_zip_filename_;
2773 const char* image_classes_filename_;
2774 ImageHeader::StorageMode image_storage_mode_;
2775 const char* passes_to_run_filename_;
2776 const char* dirty_image_objects_filename_;
2777 std::unique_ptr<HashSet<std::string>> dirty_image_objects_;
2778 std::unique_ptr<std::vector<std::string>> passes_to_run_;
2779 bool is_host_;
2780 std::string android_root_;
2781 std::string no_inline_from_string_;
2782 CompactDexLevel compact_dex_level_ = kDefaultCompactDexLevel;
2783
2784 std::vector<std::unique_ptr<linker::ElfWriter>> elf_writers_;
2785 std::vector<std::unique_ptr<linker::OatWriter>> oat_writers_;
2786 std::vector<OutputStream*> rodata_;
2787 std::vector<std::unique_ptr<OutputStream>> vdex_out_;
2788 std::unique_ptr<linker::ImageWriter> image_writer_;
2789 std::unique_ptr<CompilerDriver> driver_;
2790
2791 std::vector<MemMap> opened_dex_files_maps_;
2792 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2793
2794 bool avoid_storing_invocation_;
2795 android::base::unique_fd invocation_file_;
2796 std::string swap_file_name_;
2797 int swap_fd_;
2798 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2799 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
2800 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
2801 std::string app_image_file_name_;
2802 int app_image_fd_;
2803 std::string profile_file_;
2804 int profile_file_fd_;
2805 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
2806 TimingLogger* timings_;
2807 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
2808 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
2809
2810 // Backing storage.
2811 std::forward_list<std::string> char_backing_storage_;
2812
2813 // See CompilerOptions.force_determinism_.
2814 bool force_determinism_;
2815
2816 // Directory of relative classpaths.
2817 std::string classpath_dir_;
2818
2819 // Whether the given input vdex is also the output.
2820 bool update_input_vdex_ = false;
2821
2822 // By default, copy the dex to the vdex file only if dex files are
2823 // compressed in APK.
2824 linker::CopyOption copy_dex_files_ = linker::CopyOption::kOnlyIfCompressed;
2825
2826 // The reason for invoking the compiler.
2827 std::string compilation_reason_;
2828
2829 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2830 };
2831
b13564922()2832 static void b13564922() {
2833 #if defined(__linux__) && defined(__arm__)
2834 int major, minor;
2835 struct utsname uts;
2836 if (uname(&uts) != -1 &&
2837 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2838 ((major < 3) || ((major == 3) && (minor < 4)))) {
2839 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2840 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2841 int old_personality = personality(0xffffffff);
2842 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2843 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2844 if (new_personality == -1) {
2845 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2846 }
2847 }
2848 }
2849 #endif
2850 }
2851
2852 class ScopedGlobalRef {
2853 public:
ScopedGlobalRef(jobject obj)2854 explicit ScopedGlobalRef(jobject obj) : obj_(obj) {}
~ScopedGlobalRef()2855 ~ScopedGlobalRef() {
2856 if (obj_ != nullptr) {
2857 ScopedObjectAccess soa(Thread::Current());
2858 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), obj_);
2859 }
2860 }
2861
2862 private:
2863 jobject obj_;
2864 };
2865
CompileImage(Dex2Oat & dex2oat)2866 static dex2oat::ReturnCode CompileImage(Dex2Oat& dex2oat) {
2867 dex2oat.LoadClassProfileDescriptors();
2868 jobject class_loader = dex2oat.Compile();
2869 // Keep the class loader that was used for compilation live for the rest of the compilation
2870 // process.
2871 ScopedGlobalRef global_ref(class_loader);
2872
2873 if (!dex2oat.WriteOutputFiles(class_loader)) {
2874 dex2oat.EraseOutputFiles();
2875 return dex2oat::ReturnCode::kOther;
2876 }
2877
2878 // Flush boot.oat. Keep it open as we might still modify it later (strip it).
2879 if (!dex2oat.FlushOutputFiles()) {
2880 dex2oat.EraseOutputFiles();
2881 return dex2oat::ReturnCode::kOther;
2882 }
2883
2884 // Creates the boot.art and patches the oat files.
2885 if (!dex2oat.HandleImage()) {
2886 return dex2oat::ReturnCode::kOther;
2887 }
2888
2889 // When given --host, finish early without stripping.
2890 if (dex2oat.IsHost()) {
2891 if (!dex2oat.FlushCloseOutputFiles()) {
2892 return dex2oat::ReturnCode::kOther;
2893 }
2894 dex2oat.DumpTiming();
2895 return dex2oat::ReturnCode::kNoFailure;
2896 }
2897
2898 // Copy stripped to unstripped location, if necessary.
2899 if (!dex2oat.CopyOatFilesToSymbolsDirectoryAndStrip()) {
2900 return dex2oat::ReturnCode::kOther;
2901 }
2902
2903 // FlushClose again, as stripping might have re-opened the oat files.
2904 if (!dex2oat.FlushCloseOutputFiles()) {
2905 return dex2oat::ReturnCode::kOther;
2906 }
2907
2908 dex2oat.DumpTiming();
2909 return dex2oat::ReturnCode::kNoFailure;
2910 }
2911
CompileApp(Dex2Oat & dex2oat)2912 static dex2oat::ReturnCode CompileApp(Dex2Oat& dex2oat) {
2913 jobject class_loader = dex2oat.Compile();
2914 // Keep the class loader that was used for compilation live for the rest of the compilation
2915 // process.
2916 ScopedGlobalRef global_ref(class_loader);
2917
2918 if (!dex2oat.WriteOutputFiles(class_loader)) {
2919 dex2oat.EraseOutputFiles();
2920 return dex2oat::ReturnCode::kOther;
2921 }
2922
2923 // Do not close the oat files here. We might have gotten the output file by file descriptor,
2924 // which we would lose.
2925
2926 // When given --host, finish early without stripping.
2927 if (dex2oat.IsHost()) {
2928 if (!dex2oat.FlushCloseOutputFiles()) {
2929 return dex2oat::ReturnCode::kOther;
2930 }
2931
2932 dex2oat.DumpTiming();
2933 return dex2oat::ReturnCode::kNoFailure;
2934 }
2935
2936 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2937 // stripped versions. If this is given, we expect to be able to open writable files by name.
2938 if (!dex2oat.CopyOatFilesToSymbolsDirectoryAndStrip()) {
2939 return dex2oat::ReturnCode::kOther;
2940 }
2941
2942 // Flush and close the files.
2943 if (!dex2oat.FlushCloseOutputFiles()) {
2944 return dex2oat::ReturnCode::kOther;
2945 }
2946
2947 dex2oat.DumpTiming();
2948 return dex2oat::ReturnCode::kNoFailure;
2949 }
2950
Dex2oat(int argc,char ** argv)2951 static dex2oat::ReturnCode Dex2oat(int argc, char** argv) {
2952 b13564922();
2953
2954 TimingLogger timings("compiler", false, false);
2955
2956 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
2957 // might produce a stack frame too large for this function or for
2958 // functions inlining it (such as main), that would not fit the
2959 // requirements of the `-Wframe-larger-than` option.
2960 std::unique_ptr<Dex2Oat> dex2oat = std::make_unique<Dex2Oat>(&timings);
2961
2962 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
2963 dex2oat->ParseArgs(argc, argv);
2964
2965 // If needed, process profile information for profile guided compilation.
2966 // This operation involves I/O.
2967 if (dex2oat->UseProfile()) {
2968 if (!dex2oat->LoadProfile()) {
2969 LOG(ERROR) << "Failed to process profile file";
2970 return dex2oat::ReturnCode::kOther;
2971 }
2972 }
2973
2974 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap, and vdex.
2975
2976 // Check early that the result of compilation can be written
2977 if (!dex2oat->OpenFile()) {
2978 return dex2oat::ReturnCode::kOther;
2979 }
2980
2981 // Print the complete line when any of the following is true:
2982 // 1) Debug build
2983 // 2) Compiling an image
2984 // 3) Compiling with --host
2985 // 4) Compiling on the host (not a target build)
2986 // Otherwise, print a stripped command line.
2987 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
2988 LOG(INFO) << CommandLine();
2989 } else {
2990 LOG(INFO) << StrippedCommandLine();
2991 }
2992
2993 dex2oat::ReturnCode setup_code = dex2oat->Setup();
2994 if (setup_code != dex2oat::ReturnCode::kNoFailure) {
2995 dex2oat->EraseOutputFiles();
2996 return setup_code;
2997 }
2998
2999 // TODO: Due to the cyclic dependencies, profile loading and verifying are
3000 // being done separately. Refactor and place the two next to each other.
3001 // If verification fails, we don't abort the compilation and instead log an
3002 // error.
3003 // TODO(b/62602192, b/65260586): We should consider aborting compilation when
3004 // the profile verification fails.
3005 // Note: If dex2oat fails, installd will remove the oat files causing the app
3006 // to fallback to apk with possible in-memory extraction. We want to avoid
3007 // that, and thus we're lenient towards profile corruptions.
3008 if (dex2oat->UseProfile()) {
3009 dex2oat->VerifyProfileData();
3010 }
3011
3012 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
3013 // instance. Used by tools/bisection_search/bisection_search.py.
3014 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
3015
3016 dex2oat::ReturnCode result;
3017 if (dex2oat->IsImage()) {
3018 result = CompileImage(*dex2oat);
3019 } else {
3020 result = CompileApp(*dex2oat);
3021 }
3022
3023 return result;
3024 }
3025 } // namespace art
3026
main(int argc,char ** argv)3027 int main(int argc, char** argv) {
3028 int result = static_cast<int>(art::Dex2oat(argc, argv));
3029 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
3030 // time (bug 10645725) unless we're a debug or instrumented build or running on a memory tool.
3031 // Note: The Dex2Oat class should not destruct the runtime in this case.
3032 if (!art::kIsDebugBuild && !art::kIsPGOInstrumentation && !art::kRunningOnMemoryTool) {
3033 _exit(result);
3034 }
3035 return result;
3036 }
3037