blob: e52e502eccdce8ffdebcba342be3e4cad6a2cd56 [file] [log] [blame]
Brian Carlstrom7940e442013-07-12 13:46:57 -07001/*
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
Andreas Gamped687e372015-04-28 23:16:03 -070017#include <inttypes.h>
Brian Carlstrom7940e442013-07-12 13:46:57 -070018#include <stdio.h>
19#include <stdlib.h>
20#include <sys/stat.h>
Evgenii Stepanov1e133742015-05-20 12:30:59 -070021#include "base/memory_tool.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070022
23#include <fstream>
24#include <iostream>
Andreas Gampe67f02822016-06-24 21:05:23 -070025#include <limits>
Brian Carlstrom7940e442013-07-12 13:46:57 -070026#include <sstream>
27#include <string>
Andreas Gampeb1fcead2015-04-20 18:53:51 -070028#include <unordered_set>
Brian Carlstrom7940e442013-07-12 13:46:57 -070029#include <vector>
30
Vladimir Markof94b7812014-06-05 15:48:04 +010031#if defined(__linux__) && defined(__arm__)
32#include <sys/personality.h>
33#include <sys/utsname.h>
34#endif
35
Ian Rogersd582fa42014-11-05 23:46:43 -080036#include "arch/instruction_set_features.h"
Andreas Gampec5a3ea72015-01-13 16:41:53 -080037#include "arch/mips/instruction_set_features_mips.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000038#include "art_method-inl.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070039#include "base/dumpable.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080040#include "base/macros.h"
Calin Juravle2e2db782016-02-23 12:00:03 +000041#include "base/scoped_flock.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070042#include "base/stl_util.h"
43#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010044#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070045#include "base/timing_logger.h"
46#include "base/unix_file/fd_file.h"
47#include "class_linker.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000048#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000049#include "compiler_callbacks.h"
David Srbecky09c2a6b2016-03-11 17:11:44 +000050#include "debug/elf_debug_writer.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000051#include "debug/method_debug_info.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000052#include "dex/quick_compiler_callbacks.h"
53#include "dex/verification_results.h"
54#include "dex_file-inl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070055#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080056#include "driver/compiler_options.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080057#include "elf_file.h"
Tong Shen62d1ca32014-09-03 17:24:56 -070058#include "elf_writer.h"
Vladimir Marko10c13562015-11-25 14:33:36 +000059#include "elf_writer_quick.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070060#include "gc/space/image_space.h"
61#include "gc/space/space-inl.h"
62#include "image_writer.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070063#include "interpreter/unstarted_runtime.h"
Calin Juravle998c2162015-12-21 15:39:33 +020064#include "jit/offline_profiling_info.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070065#include "leb128.h"
David Brazdil5d5a36b2016-09-14 15:34:10 +010066#include "linker/buffered_output_stream.h"
67#include "linker/file_output_stream.h"
Vladimir Marko944da602016-02-19 12:27:55 +000068#include "linker/multi_oat_relative_patcher.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070069#include "mirror/class-inl.h"
70#include "mirror/class_loader.h"
71#include "mirror/object-inl.h"
72#include "mirror/object_array-inl.h"
Jeff Haob11ffb72016-04-07 15:40:54 -070073#include "oat_file_assistant.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070074#include "oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070075#include "os.h"
76#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000077#include "runtime_options.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070078#include "ScopedLocalRef.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070079#include "scoped_thread_state_change-inl.h"
Alex Light53cb16b2014-06-12 11:26:29 -070080#include "utils.h"
David Brazdilca3c8c32016-09-06 14:04:48 +010081#include "verifier/verifier_deps.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070082#include "well_known_classes.h"
83#include "zip_archive.h"
84
85namespace art {
86
Andreas Gampee1459ae2016-06-29 09:36:30 -070087static constexpr size_t kDefaultMinDexFilesForSwap = 2;
88static constexpr size_t kDefaultMinDexFileCumulativeSizeForSwap = 20 * MB;
89
Brian Carlstrom6449c622014-02-10 23:48:36 -080090static int original_argc;
91static char** original_argv;
92
93static std::string CommandLine() {
94 std::vector<std::string> command;
95 for (int i = 0; i < original_argc; ++i) {
96 command.push_back(original_argv[i]);
97 }
98 return Join(command, ' ');
99}
100
Andreas Gampe046c7062015-05-18 23:22:54 -0700101// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
102// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
103// locations are all staged).
104static std::string StrippedCommandLine() {
105 std::vector<std::string> command;
106
107 // Do a pre-pass to look for zip-fd.
108 bool saw_zip_fd = false;
109 for (int i = 0; i < original_argc; ++i) {
110 if (StartsWith(original_argv[i], "--zip-fd=")) {
111 saw_zip_fd = true;
112 break;
113 }
114 }
115
116 // Now filter out things.
117 for (int i = 0; i < original_argc; ++i) {
118 // All runtime-arg parameters are dropped.
119 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
120 i++; // Drop the next part, too.
121 continue;
122 }
123
124 // Any instruction-setXXX is dropped.
125 if (StartsWith(original_argv[i], "--instruction-set")) {
126 continue;
127 }
128
129 // The boot image is dropped.
130 if (StartsWith(original_argv[i], "--boot-image=")) {
131 continue;
132 }
133
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800134 // The image format is dropped.
135 if (StartsWith(original_argv[i], "--image-format=")) {
136 continue;
137 }
138
Andreas Gampe046c7062015-05-18 23:22:54 -0700139 // This should leave any dex-file and oat-file options, describing what we compiled.
140
141 // However, we prefer to drop this when we saw --zip-fd.
142 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700143 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe046c7062015-05-18 23:22:54 -0700144 if (StartsWith(original_argv[i], "--zip-") ||
145 StartsWith(original_argv[i], "--dex-") ||
146 StartsWith(original_argv[i], "--oat-") ||
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700147 StartsWith(original_argv[i], "--swap-") ||
148 StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700149 continue;
150 }
151 }
152
153 command.push_back(original_argv[i]);
154 }
155
156 // Construct the final output.
157 if (command.size() <= 1U) {
158 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
159 return "Starting dex2oat.";
160 }
161 return Join(command, ' ');
162}
163
Brian Carlstrom7940e442013-07-12 13:46:57 -0700164static void UsageErrorV(const char* fmt, va_list ap) {
165 std::string error;
166 StringAppendV(&error, fmt, ap);
167 LOG(ERROR) << error;
168}
169
170static void UsageError(const char* fmt, ...) {
171 va_list ap;
172 va_start(ap, fmt);
173 UsageErrorV(fmt, ap);
174 va_end(ap);
175}
176
Andreas Gampe794ad762015-02-23 08:12:24 -0800177NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700178 va_list ap;
179 va_start(ap, fmt);
180 UsageErrorV(fmt, ap);
181 va_end(ap);
182
Brian Carlstrom6449c622014-02-10 23:48:36 -0800183 UsageError("Command: %s", CommandLine().c_str());
184
Brian Carlstrom7940e442013-07-12 13:46:57 -0700185 UsageError("Usage: dex2oat [options]...");
186 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100187 UsageError(" -j<number>: specifies the number of threads used for compilation.");
188 UsageError(" Default is the number of detected hardware threads available on the");
189 UsageError(" host system.");
190 UsageError(" Example: -j12");
191 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700192 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700193 UsageError(" Example: --dex-file=/system/framework/core.jar");
194 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700195 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
196 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
197 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
198 UsageError(" --dex-location=/system/framework/core.jar");
199 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700200 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
201 UsageError(" containing a classes.dex file to compile.");
202 UsageError(" Example: --zip-fd=5");
203 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700204 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
205 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700206 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
207 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800208 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700209 UsageError(" Example: --oat-file=/system/framework/boot.oat");
210 UsageError("");
211 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900212 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700213 UsageError("");
214 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
215 UsageError(" to the file descriptor specified by --oat-fd.");
216 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
217 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800218 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700219 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
220 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800221 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700222 UsageError(" Example: --image=/system/framework/boot.art");
223 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800224 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800225 UsageError(" Which format to store the image.");
226 UsageError(" Example: --image-format=lz4");
227 UsageError(" Default: uncompressed");
228 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700229 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
230 UsageError(" Example: --image=frameworks/base/preloaded-classes");
231 UsageError("");
232 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
233 UsageError(" Example: --base=0x50000000");
234 UsageError("");
235 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000236 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700237 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000238 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000239 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700240 UsageError("");
241 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
242 UsageError(" Example: --android-root=out/host/linux-x86");
243 UsageError(" Default: $ANDROID_ROOT");
244 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800245 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700246 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700247 UsageError(" Example: --instruction-set=x86");
248 UsageError(" Default: arm");
249 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700250 UsageError(" --instruction-set-features=...,: Specify instruction set features");
251 UsageError(" Example: --instruction-set-features=div");
252 UsageError(" Default: default");
253 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700254 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
255 UsageError(" Default: disabled");
256 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800257 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700258 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800259 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100260 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700261 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100262 UsageError(" --compiler-filter="
263 "(verify-none"
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700264 "|verify-at-runtime"
Mathieu Chartiera8077802016-03-16 19:08:31 -0700265 "|verify-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100266 "|interpret-only"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000267 "|time"
268 "|space-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100269 "|space"
270 "|balanced"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000271 "|speed-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100272 "|speed"
Jeff Hao608f2ce2016-10-19 11:17:11 -0700273 "|layout-profile"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000274 "|everything-profile"
275 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700276 UsageError(" select compiler filter.");
Mathieu Chartiera8077802016-03-16 19:08:31 -0700277 UsageError(" verify-profile requires a --profile(-fd) to also be passed in.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800278 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800279 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800280 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800281 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
282 UsageError(" method for compiler filter tuning.");
283 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
284 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
285 UsageError("");
286 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
287 UsageError(" method for compiler filter tuning.");
288 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
289 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
290 UsageError("");
291 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
292 UsageError(" method for compiler filter tuning.");
293 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
294 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
295 UsageError("");
296 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
297 UsageError(" method for compiler filter tuning.");
298 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
299 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
300 UsageError("");
301 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
302 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700303 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
304 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800305 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
306 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
307 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100308 UsageError(" --inline-depth-limit=<depth-limit>: the depth limit of inlining for fine tuning");
309 UsageError(" the compiler. A zero value will disable inlining. Honored only by Optimizing.");
Roland Levillaina215b952015-08-07 11:38:32 +0100310 UsageError(" Has priority over the --compiler-filter option. Intended for ");
311 UsageError(" development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100312 UsageError(" Example: --inline-depth-limit=%d", CompilerOptions::kDefaultInlineDepthLimit);
313 UsageError(" Default: %d", CompilerOptions::kDefaultInlineDepthLimit);
314 UsageError("");
315 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
316 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100317 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
318 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100319 UsageError(" Example: --inline-max-code-units=%d",
320 CompilerOptions::kDefaultInlineMaxCodeUnits);
321 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
322 UsageError("");
Ian Rogers46398602013-08-20 07:50:36 -0700323 UsageError(" --dump-timing: display a breakdown of where time was spent");
324 UsageError("");
Alex Light53cb16b2014-06-12 11:26:29 -0700325 UsageError(" --include-patch-information: Include patching information so the generated code");
326 UsageError(" can have its base address moved without full recompilation.");
327 UsageError("");
328 UsageError(" --no-include-patch-information: Do not include patching information.");
329 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100330 UsageError(" -g");
331 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
332 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000333 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000334 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700335 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100336 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100337 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000338 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
339 UsageError(" debug information necessary to print backtraces. (disabled by default)");
340 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000341 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000342 UsageError("");
Alexey Alexandrovab40c112016-09-19 09:33:49 -0700343 UsageError(" --generate-build-id: Generate GNU-compatible linker build ID ELF section with");
344 UsageError(" SHA-1 of the file content (and thus stable across identical builds)");
345 UsageError("");
346 UsageError(" --no-generate-build-id: Do not generate the build ID ELF section.");
347 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000348 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000349 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700350 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
351 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
352 UsageError(" Use a separate --runtime-arg switch for each argument.");
353 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700354 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000355 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700356 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000357 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
358 UsageError(" Cannot be used together with --profile-file.");
359 UsageError("");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800360 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
361 UsageError(" Example: --swap-file=/data/tmp/swap.001");
362 UsageError("");
363 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
364 UsageError(" Example: --swap-fd=10");
365 UsageError("");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700366 UsageError(" --swap-dex-size-threshold=<size>: specifies the minimum total dex file size in");
367 UsageError(" bytes to allow the use of swap.");
368 UsageError(" Example: --swap-dex-size-threshold=1000000");
369 UsageError(" Default: %zu", kDefaultMinDexFileCumulativeSizeForSwap);
370 UsageError("");
371 UsageError(" --swap-dex-count-threshold=<count>: specifies the minimum number of dex files to");
372 UsageError(" allow the use of swap.");
373 UsageError(" Example: --swap-dex-count-threshold=10");
374 UsageError(" Default: %zu", kDefaultMinDexFilesForSwap);
375 UsageError("");
Andreas Gampe67f02822016-06-24 21:05:23 -0700376 UsageError(" --very-large-app-threshold=<size>: specifies the minimum total dex file size in");
377 UsageError(" bytes to consider the input \"very large\" and punt on the compilation.");
378 UsageError(" Example: --very-large-app-threshold=100000000");
379 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700380 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
381 UsageError(" Example: --app-image-fd=10");
382 UsageError("");
383 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
384 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
385 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800386 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
387 "input dex file.");
388 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000389 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
390 UsageError(" This option is incompatible with read barriers (e.g., if dex2oat has been");
391 UsageError(" built with the environment variable `ART_USE_READ_BARRIER` set to `true`).");
392 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700393 std::cerr << "See log for usage error information\n";
394 exit(EXIT_FAILURE);
395}
396
Brian Carlstrom7940e442013-07-12 13:46:57 -0700397// The primary goal of the watchdog is to prevent stuck build servers
398// during development when fatal aborts lead to a cascade of failures
399// that result in a deadlock.
400class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800401// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700402#undef CHECK_PTHREAD_CALL
403#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
404 do { \
405 int rc = call args; \
406 if (rc != 0) { \
407 errno = rc; \
408 std::string message(# call); \
409 message += " failed for "; \
410 message += reason; \
411 Fatal(message); \
412 } \
413 } while (false)
414
415 public:
Brian Carlstrom93ba8932013-07-17 21:31:49 -0700416 explicit WatchDog(bool is_watch_dog_enabled) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700417 is_watch_dog_enabled_ = is_watch_dog_enabled;
418 if (!is_watch_dog_enabled_) {
419 return;
420 }
421 shutting_down_ = false;
422 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700423 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
424 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700425 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
426 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
427 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
428 }
429 ~WatchDog() {
430 if (!is_watch_dog_enabled_) {
431 return;
432 }
433 const char* reason = "dex2oat watch dog thread shutdown";
434 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
435 shutting_down_ = true;
436 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
437 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
438
Kenny Root51316382014-05-13 14:59:37 -0700439 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700440
441 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
442 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
443 }
444
445 private:
446 static void* CallBack(void* arg) {
447 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
448 ::art::SetThreadName("dex2oat watch dog");
449 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700450 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700451 }
452
Andreas Gampe794ad762015-02-23 08:12:24 -0800453 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700454 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
455 // it's rather easy to hang in unwinding.
456 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
457 // logcat logging or stderr output.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700458 android::base::LogMessage::LogLine(__FILE__,
459 __LINE__,
460 android::base::LogId::DEFAULT,
461 LogSeverity::FATAL,
462 message.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700463 exit(1);
464 }
465
466 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700467 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
468 // large.
Andreas Gamped687e372015-04-28 23:16:03 -0700469 constexpr int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700470 timespec timeout_ts;
471 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts);
472 const char* reason = "dex2oat watch dog thread waiting";
473 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
474 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800475 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700476 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700477 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
478 kWatchDogTimeoutSeconds));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700479 } else if (rc != 0) {
480 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
481 strerror(errno)));
482 Fatal(message.c_str());
483 }
484 }
485 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
486 }
487
488 // When setting timeouts, keep in mind that the build server may not be as fast as your desktop.
Mathieu Chartier13b9f432014-09-09 17:26:58 -0700489 // Debug builds are slower so they have larger timeouts.
Andreas Gamped687e372015-04-28 23:16:03 -0700490 static constexpr int64_t kSlowdownFactor = kIsDebugBuild ? 5U : 1U;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800491
Andreas Gampe540138a2015-09-14 15:34:38 -0700492 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
493 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
494 // itself before that watchdog would take down the system server.
495 static constexpr int64_t kWatchDogTimeoutSeconds = kSlowdownFactor * (9 * 60 + 30);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700496
497 bool is_watch_dog_enabled_;
498 bool shutting_down_;
499 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
500 pthread_mutex_t mutex_;
501 pthread_cond_t cond_;
502 pthread_attr_t attr_;
503 pthread_t pthread_;
504};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700505
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800506class Dex2Oat FINAL {
507 public:
508 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100509 compiler_kind_(Compiler::kOptimizing),
Artem Serovba6b6792016-08-15 14:22:07 +0100510 instruction_set_(kRuntimeISA == kArm ? kThumb2 : kRuntimeISA),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800511 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000512 image_file_location_oat_checksum_(0),
513 image_file_location_oat_data_begin_(0),
514 image_patch_delta_(0),
515 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700516 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800517 runtime_(nullptr),
518 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
519 start_ns_(NanoTime()),
520 oat_fd_(-1),
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000521 input_vdex_fd_(-1),
522 output_vdex_fd_(-1),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800523 zip_fd_(-1),
524 image_base_(0U),
525 image_classes_zip_filename_(nullptr),
526 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800527 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800528 compiled_classes_zip_filename_(nullptr),
529 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700530 compiled_methods_zip_filename_(nullptr),
531 compiled_methods_filename_(nullptr),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700532 passes_to_run_filename_(nullptr),
Jeff Hao436183f2016-01-12 16:36:50 -0800533 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800534 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000535 class_loader_(nullptr),
536 elf_writers_(),
537 oat_writers_(),
538 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000539 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700540 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000541 opened_dex_files_maps_(),
542 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000543 no_inline_from_dex_files_(),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800544 dump_stats_(false),
545 dump_passes_(false),
546 dump_timing_(false),
547 dump_slow_timing_(kIsDebugBuild),
Calin Juravle2e2db782016-02-23 12:00:03 +0000548 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800549 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000550 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800551 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000552 force_determinism_(false)
553 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800554
555 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800556 // Log completion time before deleting the runtime_, because this accesses
557 // the runtime.
558 LogCompletionTime();
559
Vladimir Marko307dac92015-10-20 11:20:09 +0100560 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
561 // We want to just exit on non-debug builds, not bringing the runtime down
562 // in an orderly fashion. So release the following fields.
563 driver_.release();
564 image_writer_.release();
565 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
566 dex_file.release();
567 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000568 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
569 map.release();
570 }
David Brazdil7b49e6c2016-09-01 11:06:18 +0100571 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
572 vdex_file.release();
573 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800574 for (std::unique_ptr<File>& oat_file : oat_files_) {
575 oat_file.release();
576 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100577 runtime_.release();
578 verification_results_.release();
579 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100580 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700581 }
582
Roland Levillain9ec5e222015-08-17 20:18:41 +0100583 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800584 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800585 std::string boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800586 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000587 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800588 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100589 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800590
Roland Levillain9ec5e222015-08-17 20:18:41 +0100591 void ParseZipFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000592 ParseUintOption(option, "--zip-fd", &zip_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100593 }
594
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000595 void ParseInputVdexFd(const StringPiece& option) {
596 // Note that the input vdex fd might be -1.
597 ParseIntOption(option, "--input-vdex-fd", &input_vdex_fd_, Usage);
598 }
599
600 void ParseOutputVdexFd(const StringPiece& option) {
601 ParseUintOption(option, "--output-vdex-fd", &output_vdex_fd_, Usage);
David Brazdil7b49e6c2016-09-01 11:06:18 +0100602 }
603
Roland Levillain9ec5e222015-08-17 20:18:41 +0100604 void ParseOatFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000605 ParseUintOption(option, "--oat-fd", &oat_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100606 }
607
Calin Juravle877fd962016-01-05 14:29:29 +0000608 void ParseFdForCollection(const StringPiece& option,
609 const char* arg_name,
610 std::vector<uint32_t>* fds) {
611 uint32_t fd;
612 ParseUintOption(option, arg_name, &fd, Usage);
613 fds->push_back(fd);
614 }
615
Roland Levillain9ec5e222015-08-17 20:18:41 +0100616 void ParseJ(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000617 ParseUintOption(option, "-j", &thread_count_, Usage, /* is_long_option */ false);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100618 }
619
620 void ParseBase(const StringPiece& option) {
621 DCHECK(option.starts_with("--base="));
622 const char* image_base_str = option.substr(strlen("--base=")).data();
623 char* end;
624 image_base_ = strtoul(image_base_str, &end, 16);
625 if (end == image_base_str || *end != '\0') {
626 Usage("Failed to parse hexadecimal value for option %s", option.data());
627 }
628 }
629
630 void ParseInstructionSet(const StringPiece& option) {
631 DCHECK(option.starts_with("--instruction-set="));
632 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
633 // StringPiece is not necessarily zero-terminated, so need to make a copy and ensure it.
634 std::unique_ptr<char[]> buf(new char[instruction_set_str.length() + 1]);
635 strncpy(buf.get(), instruction_set_str.data(), instruction_set_str.length());
636 buf.get()[instruction_set_str.length()] = 0;
637 instruction_set_ = GetInstructionSetFromString(buf.get());
638 // arm actually means thumb2.
639 if (instruction_set_ == InstructionSet::kArm) {
640 instruction_set_ = InstructionSet::kThumb2;
641 }
642 }
643
644 void ParseInstructionSetVariant(const StringPiece& option, ParserOptions* parser_options) {
645 DCHECK(option.starts_with("--instruction-set-variant="));
646 StringPiece str = option.substr(strlen("--instruction-set-variant=")).data();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800647 instruction_set_features_ = InstructionSetFeatures::FromVariant(
648 instruction_set_, str.as_string(), &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100649 if (instruction_set_features_.get() == nullptr) {
650 Usage("%s", parser_options->error_msg.c_str());
651 }
652 }
653
654 void ParseInstructionSetFeatures(const StringPiece& option, ParserOptions* parser_options) {
655 DCHECK(option.starts_with("--instruction-set-features="));
656 StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800657 if (instruction_set_features_ == nullptr) {
658 instruction_set_features_ = InstructionSetFeatures::FromVariant(
659 instruction_set_, "default", &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100660 if (instruction_set_features_.get() == nullptr) {
661 Usage("Problem initializing default instruction set features variant: %s",
662 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700663 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800664 }
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800665 instruction_set_features_ =
Roland Levillain9ec5e222015-08-17 20:18:41 +0100666 instruction_set_features_->AddFeaturesFromString(str.as_string(),
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800667 &parser_options->error_msg);
668 if (instruction_set_features_ == nullptr) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100669 Usage("Error parsing '%s': %s", option.data(), parser_options->error_msg.c_str());
670 }
671 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800672
Roland Levillain9ec5e222015-08-17 20:18:41 +0100673 void ParseCompilerBackend(const StringPiece& option, ParserOptions* parser_options) {
674 DCHECK(option.starts_with("--compiler-backend="));
675 parser_options->requested_specific_compiler = true;
676 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
677 if (backend_str == "Quick") {
678 compiler_kind_ = Compiler::kQuick;
679 } else if (backend_str == "Optimizing") {
680 compiler_kind_ = Compiler::kOptimizing;
681 } else {
682 Usage("Unknown compiler backend: %s", backend_str.data());
683 }
684 }
685
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800686 void ParseImageFormat(const StringPiece& option) {
687 const StringPiece substr("--image-format=");
688 DCHECK(option.starts_with(substr));
689 const StringPiece format_str = option.substr(substr.length());
690 if (format_str == "lz4") {
691 image_storage_mode_ = ImageHeader::kStorageModeLZ4;
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800692 } else if (format_str == "lz4hc") {
693 image_storage_mode_ = ImageHeader::kStorageModeLZ4HC;
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800694 } else if (format_str == "uncompressed") {
695 image_storage_mode_ = ImageHeader::kStorageModeUncompressed;
696 } else {
697 Usage("Unknown image format: %s", format_str.data());
698 }
699 }
700
Jeff Hao436183f2016-01-12 16:36:50 -0800701 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoaad75c62016-10-03 08:46:48 +0000702 compiler_options_->boot_image_ = !image_filenames_.empty();
703 compiler_options_->app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700704
705 if (IsAppImage() && IsBootImage()) {
706 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
707 }
708
Jeff Haodcdc85b2015-12-04 14:06:18 -0800709 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800710 Usage("Output must be supplied with either --oat-file or --oat-fd");
711 }
712
Jeff Haodcdc85b2015-12-04 14:06:18 -0800713 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800714 Usage("--oat-file should not be used with --oat-fd");
715 }
716
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000717 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +0100718 Usage("VDEX and OAT output must be specified either with one --oat-filename "
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000719 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100720 }
721
Roland Levillain9ec5e222015-08-17 20:18:41 +0100722 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800723 Usage("--oat-symbols should not be used with --oat-fd");
724 }
725
Roland Levillain9ec5e222015-08-17 20:18:41 +0100726 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800727 Usage("--oat-symbols should not be used with --host");
728 }
729
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000730 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
731 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100732 }
733
Jeff Haodcdc85b2015-12-04 14:06:18 -0800734 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800735 Usage("--oat-fd should not be used with --image");
736 }
737
Jeff Haodcdc85b2015-12-04 14:06:18 -0800738 if (!parser_options->oat_symbols.empty() &&
739 parser_options->oat_symbols.size() != oat_filenames_.size()) {
740 Usage("--oat-file arguments do not match --oat-symbols arguments");
741 }
742
743 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
744 Usage("--oat-file arguments do not match --image arguments");
745 }
746
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800747 if (android_root_.empty()) {
748 const char* android_root_env_var = getenv("ANDROID_ROOT");
749 if (android_root_env_var == nullptr) {
750 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700751 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800752 android_root_ += android_root_env_var;
753 }
754
Vladimir Markoaad75c62016-10-03 08:46:48 +0000755 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100756 parser_options->boot_image_filename += android_root_;
757 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800758 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100759 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000760 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800761 }
762
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700763 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800764 Usage("--image-classes should only be used with --image");
765 }
766
Vladimir Marko49b0f452015-12-10 13:49:19 +0000767 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800768 Usage("--image-classes should not be used with --boot-image");
769 }
770
771 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
772 Usage("--image-classes-zip should be used with --image-classes");
773 }
774
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700775 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800776 Usage("--compiled-classes should only be used with --image");
777 }
778
Vladimir Marko49b0f452015-12-10 13:49:19 +0000779 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800780 Usage("--compiled-classes should not be used with --boot-image");
781 }
782
783 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
784 Usage("--compiled-classes-zip should be used with --compiled-classes");
785 }
786
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800787 if (dex_filenames_.empty() && zip_fd_ == -1) {
788 Usage("Input must be supplied with either --dex-file or --zip-fd");
789 }
790
791 if (!dex_filenames_.empty() && zip_fd_ != -1) {
792 Usage("--dex-file should not be used with --zip-fd");
793 }
794
795 if (!dex_filenames_.empty() && !zip_location_.empty()) {
796 Usage("--dex-file should not be used with --zip-location");
797 }
798
799 if (dex_locations_.empty()) {
800 for (const char* dex_file_name : dex_filenames_) {
801 dex_locations_.push_back(dex_file_name);
802 }
803 } else if (dex_locations_.size() != dex_filenames_.size()) {
804 Usage("--dex-location arguments do not match --dex-file arguments");
805 }
806
Jeff Haodcdc85b2015-12-04 14:06:18 -0800807 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
808 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
809 Usage("--oat-file arguments must be singular or match --dex-file arguments");
810 }
811 }
812
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800813 if (zip_fd_ != -1 && zip_location_.empty()) {
814 Usage("--zip-location should be supplied with --zip-fd");
815 }
816
Vladimir Marko49b0f452015-12-10 13:49:19 +0000817 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800818 if (image_base_ == 0) {
819 Usage("Non-zero --base not specified");
820 }
821 }
822
Mathieu Chartiera8077802016-03-16 19:08:31 -0700823 const bool have_profile_file = !profile_file_.empty();
824 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
825 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000826 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200827 }
828
Roland Levillain9ec5e222015-08-17 20:18:41 +0100829 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800830 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800831 }
832
833 // If no instruction set feature was given, use the default one for the target
834 // instruction set.
835 if (instruction_set_features_.get() == nullptr) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800836 instruction_set_features_ = InstructionSetFeatures::FromVariant(
837 instruction_set_, "default", &parser_options->error_msg);
Ian Rogersd582fa42014-11-05 23:46:43 -0800838 if (instruction_set_features_.get() == nullptr) {
839 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100840 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800841 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800842 }
843
844 if (instruction_set_ == kRuntimeISA) {
845 std::unique_ptr<const InstructionSetFeatures> runtime_features(
846 InstructionSetFeatures::FromCppDefines());
847 if (!instruction_set_features_->Equals(runtime_features.get())) {
848 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
849 << *instruction_set_features_ << ") and those of dex2oat executable ("
850 << *runtime_features <<") for the command line:\n"
851 << CommandLine();
852 }
853 }
854
Roland Levillaina215b952015-08-07 11:38:32 +0100855 // It they are not set, use default values for inlining settings.
856 // TODO: We should rethink the compiler filter. We mostly save
857 // time here, which is orthogonal to space.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000858 if (compiler_options_->inline_depth_limit_ == CompilerOptions::kUnsetInlineDepthLimit) {
859 compiler_options_->inline_depth_limit_ =
Andreas Gampe29d38e72016-03-23 15:31:51 +0000860 (compiler_options_->compiler_filter_ == CompilerFilter::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100861 // Implementation of the space filter: limit inlining depth.
862 ? CompilerOptions::kSpaceFilterInlineDepthLimit
863 : CompilerOptions::kDefaultInlineDepthLimit;
864 }
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000865 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
866 compiler_options_->inline_max_code_units_ =
Andreas Gampe29d38e72016-03-23 15:31:51 +0000867 (compiler_options_->compiler_filter_ == CompilerFilter::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100868 // Implementation of the space filter: limit inlining max code units.
869 ? CompilerOptions::kSpaceFilterInlineMaxCodeUnits
870 : CompilerOptions::kDefaultInlineMaxCodeUnits;
871 }
872
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800873 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800874 // Set the compilation target's implicit checks options.
875 switch (instruction_set_) {
876 case kArm:
877 case kThumb2:
878 case kArm64:
879 case kX86:
880 case kX86_64:
Douglas Leung22bb5a22015-07-02 16:42:08 -0700881 case kMips:
882 case kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000883 compiler_options_->implicit_null_checks_ = true;
884 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800885 break;
886
887 default:
888 // Defaults are correct.
889 break;
890 }
891
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000892 compiler_options_->verbose_methods_ = verbose_methods_.empty() ? nullptr : &verbose_methods_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800893
Jeff Hao436183f2016-01-12 16:36:50 -0800894 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800895 Usage("--multi-image can only be used when creating boot images");
896 }
Jeff Hao436183f2016-01-12 16:36:50 -0800897 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800898 Usage("--multi-image cannot be used with multiple image names");
899 }
900
901 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
902 if (!kIsTargetBuild && IsBootImage()) {
903 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800904 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800905 }
906 }
907
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800908 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100909 if (parser_options->watch_dog_enabled) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800910 watchdog_.reset(new WatchDog(true));
911 }
912
913 // Fill some values into the key-value store for the oat header.
914 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800915
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800916 // Automatically force determinism for the boot image in a host build if the default GC is CMS
917 // or MS and read barriers are not enabled, as the former switches the GC to a non-concurrent
918 // one by passing the option `-Xgc:nonconcurrent` (see below).
919 if (!kIsTargetBuild && IsBootImage()) {
920 if (SupportsDeterministicCompilation()) {
921 force_determinism_ = true;
922 } else {
923 LOG(WARNING) << "Deterministic compilation is disabled.";
924 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800925 }
926 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700927
928 if (passes_to_run_filename_ != nullptr) {
929 passes_to_run_.reset(ReadCommentedInputFromFile<std::vector<std::string>>(
930 passes_to_run_filename_,
931 nullptr)); // No post-processing.
932 if (passes_to_run_.get() == nullptr) {
933 Usage("Failed to read list of passes to run.");
934 }
935 }
936 compiler_options_->passes_to_run_ = passes_to_run_.get();
Roland Levillain9ec5e222015-08-17 20:18:41 +0100937 }
938
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800939 static bool SupportsDeterministicCompilation() {
940 return (gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
941 gc::kCollectorTypeDefault == gc::kCollectorTypeMS) &&
942 !kEmitCompilerReadBarrier;
943 }
944
Jeff Hao436183f2016-01-12 16:36:50 -0800945 void ExpandOatAndImageFilenames() {
946 std::string base_oat = oat_filenames_[0];
947 size_t last_oat_slash = base_oat.rfind('/');
948 if (last_oat_slash == std::string::npos) {
949 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
950 }
951 // We also need to honor path components that were encoded through '@'. Otherwise the loading
952 // code won't be able to find the images.
953 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
954 last_oat_slash = base_oat.rfind('@');
955 }
956 base_oat = base_oat.substr(0, last_oat_slash + 1);
957
958 std::string base_img = image_filenames_[0];
959 size_t last_img_slash = base_img.rfind('/');
960 if (last_img_slash == std::string::npos) {
961 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
962 }
963 // We also need to honor path components that were encoded through '@'. Otherwise the loading
964 // code won't be able to find the images.
965 if (base_img.find('@', last_img_slash) != std::string::npos) {
966 last_img_slash = base_img.rfind('@');
967 }
968
969 // Get the prefix, which is the primary image name (without path components). Strip the
970 // extension.
971 std::string prefix = base_img.substr(last_img_slash + 1);
972 if (prefix.rfind('.') != std::string::npos) {
973 prefix = prefix.substr(0, prefix.rfind('.'));
974 }
975 if (!prefix.empty()) {
976 prefix = prefix + "-";
977 }
978
979 base_img = base_img.substr(0, last_img_slash + 1);
980
981 // Note: we have some special case here for our testing. We have to inject the differentiating
982 // parts for the different core images.
983 std::string infix; // Empty infix by default.
984 {
985 // Check the first name.
986 std::string dex_file = oat_filenames_[0];
987 size_t last_dex_slash = dex_file.rfind('/');
988 if (last_dex_slash != std::string::npos) {
989 dex_file = dex_file.substr(last_dex_slash + 1);
990 }
991 size_t last_dex_dot = dex_file.rfind('.');
992 if (last_dex_dot != std::string::npos) {
993 dex_file = dex_file.substr(0, last_dex_dot);
994 }
995 if (StartsWith(dex_file, "core-")) {
996 infix = dex_file.substr(strlen("core"));
997 }
998 }
999
bowen_lai8bd36c02016-10-12 13:28:55 +08001000 std::string base_symbol_oat;
1001 if (!oat_unstripped_.empty()) {
1002 base_symbol_oat = oat_unstripped_[0];
1003 size_t last_symbol_oat_slash = base_symbol_oat.rfind('/');
1004 if (last_symbol_oat_slash == std::string::npos) {
1005 Usage("--multi-image used with unusable symbol filename %s", base_symbol_oat.c_str());
1006 }
1007 base_symbol_oat = base_symbol_oat.substr(0, last_symbol_oat_slash + 1);
1008 }
1009
1010 const size_t num_expanded_files = 2 + (base_symbol_oat.empty() ? 0 : 1);
1011 char_backing_storage_.reserve((dex_locations_.size() - 1) * num_expanded_files);
Ben Gruvera0fc3262016-09-30 13:10:42 -07001012
Jeff Hao436183f2016-01-12 16:36:50 -08001013 // Now create the other names. Use a counted loop to skip the first one.
1014 for (size_t i = 1; i < dex_locations_.size(); ++i) {
1015 // TODO: Make everything properly std::string.
1016 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
1017 char_backing_storage_.push_back(base_img + image_name);
1018 image_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
1019
1020 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
1021 char_backing_storage_.push_back(base_oat + oat_name);
1022 oat_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001023
1024 if (!base_symbol_oat.empty()) {
1025 char_backing_storage_.push_back(base_symbol_oat + oat_name);
1026 oat_unstripped_.push_back((char_backing_storage_.end() - 1)->c_str());
1027 }
Jeff Hao436183f2016-01-12 16:36:50 -08001028 }
1029 }
1030
Andreas Gampe8994a042015-12-30 19:03:17 +00001031 // Modify the input string in the following way:
1032 // 0) Assume input is /a/b/c.d
1033 // 1) Strip the path -> c.d
1034 // 2) Inject prefix p -> pc.d
1035 // 3) Inject infix i -> pci.d
1036 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -08001037 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +00001038 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001039 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +00001040 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001041 size_t last_dex_slash = in.rfind('/');
1042 if (last_dex_slash != std::string::npos) {
1043 in = in.substr(last_dex_slash + 1);
1044 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001045 if (!prefix.empty()) {
1046 in = prefix + in;
1047 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001048 if (!infix.empty()) {
1049 // Inject infix.
1050 size_t last_dot = in.rfind('.');
1051 if (last_dot != std::string::npos) {
1052 in.insert(last_dot, infix);
1053 }
1054 }
1055 if (EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001056 in = in.substr(0, in.length() - strlen(".jar")) +
1057 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001058 }
1059 return in;
1060 }
1061
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001062 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001063 std::ostringstream oss;
1064 for (int i = 0; i < argc; ++i) {
1065 if (i > 0) {
1066 oss << ' ';
1067 }
1068 oss << argv[i];
1069 }
1070 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1071 oss.str(""); // Reset.
1072 oss << kRuntimeISA;
1073 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1074 key_value_store_->Put(
1075 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001076 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001077 key_value_store_->Put(
1078 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001079 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001080 key_value_store_->Put(
1081 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001082 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001083 key_value_store_->Put(OatHeader::kCompilerFilter,
1084 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Richard Uhlerd1537b52016-03-29 13:27:41 -07001085 key_value_store_->Put(OatHeader::kHasPatchInfoKey,
1086 compiler_options_->GetIncludePatchInformation() ? OatHeader::kTrueValue
1087 : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001088 }
1089
1090 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1091 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1092 // returns, arguments have been successfully parsed.
1093 void ParseArgs(int argc, char** argv) {
1094 original_argc = argc;
1095 original_argv = argv;
1096
David Sehrf57589f2016-10-17 10:09:33 -07001097 InitLogging(argv, Runtime::Aborter);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001098
1099 // Skip over argv[0].
1100 argv++;
1101 argc--;
1102
1103 if (argc == 0) {
1104 Usage("No arguments specified");
1105 }
1106
1107 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001108 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001109
1110 for (int i = 0; i < argc; i++) {
1111 const StringPiece option(argv[i]);
1112 const bool log_options = false;
1113 if (log_options) {
1114 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1115 }
1116 if (option.starts_with("--dex-file=")) {
1117 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data());
1118 } else if (option.starts_with("--dex-location=")) {
1119 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data());
1120 } else if (option.starts_with("--zip-fd=")) {
1121 ParseZipFd(option);
1122 } else if (option.starts_with("--zip-location=")) {
1123 zip_location_ = option.substr(strlen("--zip-location=")).data();
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001124 } else if (option.starts_with("--input-vdex-fd=")) {
1125 ParseInputVdexFd(option);
1126 } else if (option.starts_with("--output-vdex-fd=")) {
1127 ParseOutputVdexFd(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001128 } else if (option.starts_with("--oat-file=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001129 oat_filenames_.push_back(option.substr(strlen("--oat-file=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001130 } else if (option.starts_with("--oat-symbols=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001131 parser_options->oat_symbols.push_back(option.substr(strlen("--oat-symbols=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001132 } else if (option.starts_with("--oat-fd=")) {
1133 ParseOatFd(option);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001134 } else if (option.starts_with("--oat-location=")) {
1135 oat_location_ = option.substr(strlen("--oat-location=")).data();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001136 } else if (option == "--watch-dog") {
1137 parser_options->watch_dog_enabled = true;
1138 } else if (option == "--no-watch-dog") {
1139 parser_options->watch_dog_enabled = false;
1140 } else if (option.starts_with("-j")) {
1141 ParseJ(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001142 } else if (option.starts_with("--image=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001143 image_filenames_.push_back(option.substr(strlen("--image=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001144 } else if (option.starts_with("--image-classes=")) {
1145 image_classes_filename_ = option.substr(strlen("--image-classes=")).data();
1146 } else if (option.starts_with("--image-classes-zip=")) {
1147 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data();
Mathieu Chartierceb07b32015-12-10 09:33:21 -08001148 } else if (option.starts_with("--image-format=")) {
1149 ParseImageFormat(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001150 } else if (option.starts_with("--compiled-classes=")) {
1151 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data();
1152 } else if (option.starts_with("--compiled-classes-zip=")) {
1153 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data();
1154 } else if (option.starts_with("--compiled-methods=")) {
1155 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data();
1156 } else if (option.starts_with("--compiled-methods-zip=")) {
1157 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data();
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07001158 } else if (option.starts_with("--run-passes=")) {
1159 passes_to_run_filename_ = option.substr(strlen("--run-passes=")).data();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001160 } else if (option.starts_with("--base=")) {
1161 ParseBase(option);
1162 } else if (option.starts_with("--boot-image=")) {
1163 parser_options->boot_image_filename = option.substr(strlen("--boot-image=")).data();
1164 } else if (option.starts_with("--android-root=")) {
1165 android_root_ = option.substr(strlen("--android-root=")).data();
1166 } else if (option.starts_with("--instruction-set=")) {
1167 ParseInstructionSet(option);
1168 } else if (option.starts_with("--instruction-set-variant=")) {
1169 ParseInstructionSetVariant(option, parser_options.get());
1170 } else if (option.starts_with("--instruction-set-features=")) {
1171 ParseInstructionSetFeatures(option, parser_options.get());
1172 } else if (option.starts_with("--compiler-backend=")) {
1173 ParseCompilerBackend(option, parser_options.get());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001174 } else if (option.starts_with("--profile-file=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001175 profile_file_ = option.substr(strlen("--profile-file=")).ToString();
Calin Juravle877fd962016-01-05 14:29:29 +00001176 } else if (option.starts_with("--profile-file-fd=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001177 ParseUintOption(option, "--profile-file-fd", &profile_file_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001178 } else if (option == "--host") {
1179 is_host_ = true;
1180 } else if (option == "--runtime-arg") {
1181 if (++i >= argc) {
1182 Usage("Missing required argument for --runtime-arg");
1183 }
1184 if (log_options) {
1185 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1186 }
1187 runtime_args_.push_back(argv[i]);
1188 } else if (option == "--dump-timing") {
1189 dump_timing_ = true;
1190 } else if (option == "--dump-passes") {
1191 dump_passes_ = true;
Roland Levillain9ec5e222015-08-17 20:18:41 +01001192 } else if (option == "--dump-stats") {
1193 dump_stats_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001194 } else if (option.starts_with("--swap-file=")) {
1195 swap_file_name_ = option.substr(strlen("--swap-file=")).data();
1196 } else if (option.starts_with("--swap-fd=")) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001197 ParseUintOption(option, "--swap-fd", &swap_fd_, Usage);
Andreas Gampee1459ae2016-06-29 09:36:30 -07001198 } else if (option.starts_with("--swap-dex-size-threshold=")) {
1199 ParseUintOption(option,
1200 "--swap-dex-size-threshold",
1201 &min_dex_file_cumulative_size_for_swap_,
1202 Usage);
1203 } else if (option.starts_with("--swap-dex-count-threshold=")) {
1204 ParseUintOption(option,
1205 "--swap-dex-count-threshold",
1206 &min_dex_files_for_swap_,
1207 Usage);
Andreas Gampe67f02822016-06-24 21:05:23 -07001208 } else if (option.starts_with("--very-large-app-threshold=")) {
1209 ParseUintOption(option,
1210 "--very-large-app-threshold",
1211 &very_large_threshold_,
1212 Usage);
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001213 } else if (option.starts_with("--app-image-file=")) {
1214 app_image_file_name_ = option.substr(strlen("--app-image-file=")).data();
1215 } else if (option.starts_with("--app-image-fd=")) {
1216 ParseUintOption(option, "--app-image-fd", &app_image_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001217 } else if (option.starts_with("--verbose-methods=")) {
1218 // TODO: rather than switch off compiler logging, make all VLOG(compiler) messages
1219 // conditional on having verbost methods.
1220 gLogVerbosity.compiler = false;
1221 Split(option.substr(strlen("--verbose-methods=")).ToString(), ',', &verbose_methods_);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001222 } else if (option == "--multi-image") {
Jeff Hao436183f2016-01-12 16:36:50 -08001223 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001224 } else if (option.starts_with("--no-inline-from=")) {
1225 no_inline_from_string_ = option.substr(strlen("--no-inline-from=")).data();
Andreas Gampeace0dc12016-01-20 13:33:13 -08001226 } else if (option == "--force-determinism") {
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001227 if (!SupportsDeterministicCompilation()) {
1228 Usage("Cannot use --force-determinism with read barriers or non-CMS garbage collector");
Roland Levillaineb2c7412016-01-28 14:37:01 +00001229 }
Andreas Gampeace0dc12016-01-20 13:33:13 -08001230 force_determinism_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001231 } else if (!compiler_options_->ParseCompilerOption(option, Usage)) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001232 Usage("Unknown argument %s", option.data());
1233 }
1234 }
1235
Jeff Hao436183f2016-01-12 16:36:50 -08001236 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001237
1238 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001239 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001240 }
1241
Jeff Haodcdc85b2015-12-04 14:06:18 -08001242 // Check whether the oat output files are writable, and open them for later. Also open a swap
1243 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001244 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001245 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1246 PruneNonExistentDexFiles();
1247
Jeff Hao436183f2016-01-12 16:36:50 -08001248 // Expand oat and image filenames for multi image.
1249 if (IsBootImage() && multi_image_) {
1250 ExpandOatAndImageFilenames();
1251 }
1252
David Brazdil7b49e6c2016-09-01 11:06:18 +01001253 // OAT and VDEX file handling
1254
1255 if (oat_fd_ == -1) {
1256 DCHECK(!oat_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08001257 for (const char* oat_filename : oat_filenames_) {
1258 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
1259 if (oat_file.get() == nullptr) {
1260 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1261 return false;
1262 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001263 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001264 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1265 oat_file->Erase();
1266 return false;
1267 }
1268 oat_files_.push_back(std::move(oat_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001269
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001270 DCHECK_EQ(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001271 std::string vdex_filename = ReplaceFileExtension(oat_filename, "vdex");
1272 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
1273 if (vdex_file.get() == nullptr) {
1274 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1275 return false;
1276 }
1277 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1278 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1279 vdex_file->Erase();
1280 return false;
1281 }
1282 vdex_files_.push_back(std::move(vdex_file));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001283 }
1284 } else {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001285 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, /* check_usage */ true));
Jeff Haodcdc85b2015-12-04 14:06:18 -08001286 if (oat_file.get() == nullptr) {
1287 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1288 return false;
1289 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001290 oat_file->DisableAutoClose();
1291 if (oat_file->SetLength(0) != 0) {
1292 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1293 }
1294 oat_files_.push_back(std::move(oat_file));
1295
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001296 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001297 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001298 std::unique_ptr<File> vdex_file(new File(output_vdex_fd_, vdex_location, /* check_usage */ true));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001299 if (vdex_file.get() == nullptr) {
1300 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001301 return false;
1302 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001303 vdex_file->DisableAutoClose();
1304 if (vdex_file->SetLength(0) != 0) {
1305 PLOG(WARNING) << "Truncating vdex file " << vdex_location << " failed.";
1306 }
1307 vdex_files_.push_back(std::move(vdex_file));
1308
Jeff Haodcdc85b2015-12-04 14:06:18 -08001309 oat_filenames_.push_back(oat_location_.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001310 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001311
David Brazdil7b49e6c2016-09-01 11:06:18 +01001312 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001313 //
1314 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1315 // that we can use for swap.
1316 //
1317 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1318 // will immediately unlink to satisfy the swap fd assumption.
1319 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1320 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1321 if (swap_file.get() == nullptr) {
1322 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1323 return false;
1324 }
1325 swap_fd_ = swap_file->Fd();
1326 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1327 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1328 // released immediately.
1329 unlink(swap_file_name_.c_str());
1330 }
Jeff Hao436183f2016-01-12 16:36:50 -08001331
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001332 return true;
1333 }
1334
David Brazdil7b49e6c2016-09-01 11:06:18 +01001335 void EraseOutputFiles() {
1336 for (auto& files : { &vdex_files_, &oat_files_ }) {
1337 for (size_t i = 0; i < files->size(); ++i) {
1338 if ((*files)[i].get() != nullptr) {
1339 (*files)[i]->Erase();
1340 (*files)[i].reset();
1341 }
1342 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001343 }
Andreas Gampea650e702014-12-03 14:28:02 -08001344 }
1345
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001346 void Shutdown() {
1347 ScopedObjectAccess soa(Thread::Current());
1348 for (jobject dex_cache : dex_caches_) {
1349 soa.Env()->DeleteLocalRef(dex_cache);
1350 }
1351 dex_caches_.clear();
1352 }
1353
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001354 void LoadClassProfileDescriptors() {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001355 if (profile_compilation_info_ != nullptr && IsAppImage()) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001356 Runtime* runtime = Runtime::Current();
1357 CHECK(runtime != nullptr);
1358 std::set<DexCacheResolvedClasses> resolved_classes(
1359 profile_compilation_info_->GetResolvedClasses());
Mathieu Chartier0b490842016-05-25 15:05:59 -07001360
1361 // Filter out class path classes since we don't want to include these in the image.
1362 std::unordered_set<std::string> dex_files_locations;
1363 for (const DexFile* dex_file : dex_files_) {
1364 dex_files_locations.insert(dex_file->GetLocation());
1365 }
1366 for (auto it = resolved_classes.begin(); it != resolved_classes.end(); ) {
1367 if (dex_files_locations.find(it->GetDexLocation()) == dex_files_locations.end()) {
1368 VLOG(compiler) << "Removed profile samples for non-app dex file " << it->GetDexLocation();
1369 it = resolved_classes.erase(it);
1370 } else {
1371 ++it;
1372 }
1373 }
1374
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001375 image_classes_.reset(new std::unordered_set<std::string>(
1376 runtime->GetClassLinker()->GetClassDescriptorsForProfileKeys(resolved_classes)));
1377 VLOG(compiler) << "Loaded " << image_classes_->size()
1378 << " image class descriptors from profile";
1379 if (VLOG_IS_ON(compiler)) {
1380 for (const std::string& s : *image_classes_) {
1381 LOG(INFO) << "Image class " << s;
1382 }
1383 }
1384 }
1385 }
1386
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001387 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1388 // boot class path.
1389 bool Setup() {
1390 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001391 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap.
Vladimir Marko49b0f452015-12-10 13:49:19 +00001392
1393 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods()) {
1394 return false;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001395 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001396
Vladimir Marko307dac92015-10-20 11:20:09 +01001397 verification_results_.reset(new VerificationResults(compiler_options_.get()));
Andreas Gampe4585f872015-03-27 23:45:15 -07001398 callbacks_.reset(new QuickCompilerCallbacks(
Vladimir Marko307dac92015-10-20 11:20:09 +01001399 verification_results_.get(),
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001400 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001401 CompilerCallbacks::CallbackMode::kCompileBootImage :
1402 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001403
Vladimir Marko49b0f452015-12-10 13:49:19 +00001404 RuntimeArgumentMap runtime_options;
1405 if (!PrepareRuntimeOptions(&runtime_options)) {
1406 return false;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001407 }
1408
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001409 CreateOatWriters();
1410 if (!AddDexFileSources()) {
1411 return false;
1412 }
1413
1414 if (IsBootImage() && image_filenames_.size() > 1) {
1415 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1416 // We need this for the multi-image case.
Mathieu Chartier866d8742016-09-21 15:24:18 -07001417 key_value_store_->Put(OatHeader::kBootClassPathKey,
1418 gc::space::ImageSpace::GetMultiImageBootClassPath(dex_locations_,
1419 oat_filenames_,
1420 image_filenames_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001421 }
1422
1423 if (!IsBootImage()) {
1424 // When compiling an app, create the runtime early to retrieve
1425 // the image location key needed for the oat header.
1426 if (!CreateRuntime(std::move(runtime_options))) {
1427 return false;
1428 }
1429
Andreas Gampe29d38e72016-03-23 15:31:51 +00001430 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001431 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1432 std::vector<gc::space::ImageSpace*> image_spaces =
1433 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Jeff Haob11ffb72016-04-07 15:40:54 -07001434 image_file_location_oat_checksum_ = OatFileAssistant::CalculateCombinedImageChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001435 image_file_location_oat_data_begin_ =
1436 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1437 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1438 // Store the boot image filename(s).
1439 std::vector<std::string> image_filenames;
1440 for (const gc::space::ImageSpace* image_space : image_spaces) {
1441 image_filenames.push_back(image_space->GetImageFilename());
1442 }
1443 std::string image_file_location = Join(image_filenames, ':');
1444 if (!image_file_location.empty()) {
1445 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1446 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001447 } else {
1448 image_file_location_oat_checksum_ = 0u;
1449 image_file_location_oat_data_begin_ = 0u;
1450 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001451 }
1452
1453 // Open dex files for class path.
1454 const std::vector<std::string> class_path_locations =
1455 GetClassPathLocations(runtime_->GetClassPathString());
Jeff Haofbeb1322016-04-26 14:27:31 -07001456 OpenClassPathFiles(class_path_locations,
1457 &class_path_files_,
1458 &opened_oat_files_,
1459 runtime_->GetInstructionSet());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001460
1461 // Store the classpath we have right now.
1462 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
Jeff Haof0192c82016-03-28 20:39:50 -07001463 std::string encoded_class_path;
1464 if (class_path_locations.size() == 1 &&
1465 class_path_locations[0] == OatFile::kSpecialSharedLibrary) {
1466 // When passing the special shared library as the classpath, it is the only path.
1467 encoded_class_path = OatFile::kSpecialSharedLibrary;
1468 } else {
1469 encoded_class_path = OatFile::EncodeDexFileDependencies(class_path_files);
1470 }
1471 key_value_store_->Put(OatHeader::kClassPathKey, encoded_class_path);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001472 }
1473
1474 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001475 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001476 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1477 rodata_.reserve(oat_writers_.size());
1478 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1479 rodata_.push_back(elf_writers_[i]->StartRoData());
1480 // Unzip or copy dex files straight to the oat file.
1481 std::unique_ptr<MemMap> opened_dex_files_map;
1482 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
David Brazdil7b49e6c2016-09-01 11:06:18 +01001483 if (!oat_writers_[i]->WriteAndOpenDexFiles(
1484 kIsVdexEnabled ? vdex_files_[i].get() : oat_files_[i].get(),
1485 rodata_.back(),
1486 instruction_set_,
1487 instruction_set_features_.get(),
1488 key_value_store_.get(),
1489 /* verify */ true,
1490 &opened_dex_files_map,
1491 &opened_dex_files)) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001492 return false;
1493 }
1494 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1495 if (opened_dex_files_map != nullptr) {
1496 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
1497 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001498 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001499 opened_dex_files_.push_back(std::move(dex_file));
1500 }
1501 } else {
1502 DCHECK(opened_dex_files.empty());
1503 }
1504 }
1505 }
1506
1507 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
Andreas Gampe7386da42016-06-08 18:18:47 -07001508
1509 // We had to postpone the swap decision till now, as this is the point when we actually
1510 // know about the dex files we're going to use.
1511
1512 // Make sure that we didn't create the driver, yet.
1513 CHECK(driver_ == nullptr);
1514 // If we use a swap file, ensure we are above the threshold to make it necessary.
1515 if (swap_fd_ != -1) {
1516 if (!UseSwap(IsBootImage(), dex_files_)) {
1517 close(swap_fd_);
1518 swap_fd_ = -1;
1519 VLOG(compiler) << "Decided to run without swap.";
1520 } else {
1521 LOG(INFO) << "Large app, accepted running with swap.";
1522 }
1523 }
1524 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
1525
Andreas Gampe67f02822016-06-24 21:05:23 -07001526 // If we need to downgrade the compiler-filter for size reasons, do that check now.
1527 if (!IsBootImage() && IsVeryLarge(dex_files_)) {
1528 if (!CompilerFilter::IsAsGoodAs(CompilerFilter::kVerifyAtRuntime,
1529 compiler_options_->GetCompilerFilter())) {
1530 LOG(INFO) << "Very large app, downgrading to verify-at-runtime.";
1531 // Note: this change won't be reflected in the key-value store, as that had to be
1532 // finalized before loading the dex files. This setup is currently required
1533 // to get the size from the DexFile objects.
1534 // TODO: refactor. b/29790079
1535 compiler_options_->SetCompilerFilter(CompilerFilter::kVerifyAtRuntime);
1536 }
1537 }
1538
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001539 if (IsBootImage()) {
1540 // For boot image, pass opened dex files to the Runtime::Create().
1541 // Note: Runtime acquires ownership of these dex files.
1542 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001543 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001544 return false;
1545 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001546 }
1547
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001548 // If we're doing the image, override the compiler filter to force full compilation. Must be
1549 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1550 // compilation of class initializers.
1551 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001552 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001553 WellKnownClasses::Init(self->GetJniEnv());
1554
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001555 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001556 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001557 constexpr bool kSaveDexInput = false;
1558 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001559 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001560 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001561
1562 // Handle and ClassLoader creation needs to come after Runtime::Create.
1563 ScopedObjectAccess soa(self);
1564
1565 // Classpath: first the class-path given.
1566 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1567
1568 // Then the dex files we'll compile. Thus we'll resolve the class-path first.
1569 class_path_files.insert(class_path_files.end(), dex_files_.begin(), dex_files_.end());
1570
1571 class_loader_ = class_linker->CreatePathClassLoader(self, class_path_files);
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001572 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001573
1574 // Ensure opened dex files are writable for dex-to-dex transformations.
1575 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1576 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1577 PLOG(ERROR) << "Failed to make .dex files writeable.";
1578 return false;
Vladimir Marko919f5532016-01-20 19:13:01 +00001579 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001580 }
1581
1582 // Ensure that the dex caches stay live since we don't want class unloading
1583 // to occur during compilation.
1584 for (const auto& dex_file : dex_files_) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001585 ScopedObjectAccess soa(self);
1586 dex_caches_.push_back(soa.AddLocalReference<jobject>(
Mathieu Chartierf284d442016-06-02 11:48:30 -07001587 class_linker->RegisterDexFile(*dex_file,
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001588 soa.Decode<mirror::ClassLoader>(class_loader_).Ptr())));
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001589 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001590
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001591 return true;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001592 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001593
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001594 // If we need to keep the oat file open for the image writer.
1595 bool ShouldKeepOatFileOpen() const {
1596 return IsImage() && oat_fd_ != kInvalidFd;
1597 }
1598
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001599 // Create and invoke the compiler driver. This will compile all the dex files.
1600 void Compile() {
1601 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1602 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001603
Vladimir Marko47496c22016-01-27 16:15:08 +00001604 // Find the dex files we should not inline from.
1605
1606 std::vector<std::string> no_inline_filters;
1607 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001608
1609 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001610 const std::string core_oj = "core-oj";
1611 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1612 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001613 }
1614
Vladimir Marko47496c22016-01-27 16:15:08 +00001615 if (!no_inline_filters.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001616 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1617 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1618 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1619 &class_linker->GetBootClassPath(),
1620 &class_path_files,
1621 &dex_files_
1622 };
1623 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001624 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001625 for (const std::string& filter : no_inline_filters) {
1626 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
1627 // allows tests to specify <test-dexfile>:classes2.dex if needed but if the
1628 // base location passes the StartsWith() test, so do all extra locations.
1629 std::string dex_location = dex_file->GetLocation();
1630 if (filter.find('/') == std::string::npos) {
1631 // The filter does not contain the path. Remove the path from dex_location as well.
1632 size_t last_slash = dex_file->GetLocation().rfind('/');
1633 if (last_slash != std::string::npos) {
1634 dex_location = dex_location.substr(last_slash + 1);
1635 }
1636 }
1637
1638 if (StartsWith(dex_location, filter.c_str())) {
1639 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1640 no_inline_from_dex_files_.push_back(dex_file);
1641 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001642 }
1643 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001644 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001645 }
1646 if (!no_inline_from_dex_files_.empty()) {
1647 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001648 }
1649 }
1650
Vladimir Marko307dac92015-10-20 11:20:09 +01001651 driver_.reset(new CompilerDriver(compiler_options_.get(),
1652 verification_results_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001653 compiler_kind_,
1654 instruction_set_,
1655 instruction_set_features_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001656 image_classes_.release(),
1657 compiled_classes_.release(),
Wojciech Staszkiewicz62534792016-08-09 14:30:55 -07001658 compiled_methods_.release(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001659 thread_count_,
1660 dump_stats_,
1661 dump_passes_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001662 compiler_phases_timings_.get(),
1663 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001664 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001665 driver_->SetDexFilesForOatFile(dex_files_);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001666 driver_->CompileAll(class_loader_, dex_files_, /* verifier_deps */ nullptr, timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001667 }
1668
Jeff Hao436183f2016-01-12 16:36:50 -08001669 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001670 // ensure the references between the two are correct.
1671 //
1672 // Currently we have a memory layout that looks something like this:
1673 //
1674 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001675 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001676 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001677 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001678 // +--------------+
1679 // | alloc spaces |
1680 // +--------------+
1681 //
Jeff Hao436183f2016-01-12 16:36:50 -08001682 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001683 //
Jeff Hao436183f2016-01-12 16:36:50 -08001684 // 1. The images are expected to be loaded at an absolute address and
1685 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001686 //
Jeff Hao436183f2016-01-12 16:36:50 -08001687 // 2. There are absolute pointers from Methods in the images to their
1688 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001689 //
Jeff Hao436183f2016-01-12 16:36:50 -08001690 // 3. There are absolute pointers from the code in the oat files to Methods
1691 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001692 //
Jeff Hao436183f2016-01-12 16:36:50 -08001693 // 4. There are absolute pointers from code in the oat files to other code
1694 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001695 //
1696 // To get this all correct, we go through several steps.
1697 //
Jeff Hao436183f2016-01-12 16:36:50 -08001698 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001699 // the oat data size and code size. During this stage, we also set
1700 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001701 //
Jeff Hao436183f2016-01-12 16:36:50 -08001702 // 2. We prepare offsets for the objects in the images and calculate
1703 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001704 //
Jeff Hao436183f2016-01-12 16:36:50 -08001705 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001706 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001707 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001708 // can prepare the ELF headers and we then know the ELF memory segment
1709 // layout and we can now resolve all references. The compiler provides
1710 // LinkerPatch information in each CompiledMethod and we resolve these,
1711 // using the layout information and image object locations provided by
1712 // image writer, as we're writing the method code.
1713 //
Jeff Hao436183f2016-01-12 16:36:50 -08001714 // 4. We create the image files. They need to know where the oat files
1715 // will be loaded after itself. Originally oat files were simply
1716 // memory mapped so we could predict where their contents were based
1717 // on the file size. Now that they are ELF files, we need to inspect
1718 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001719 // where the oat header is located within.
1720 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001721 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001722 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001723 // load the .so at the desired location at runtime by offsetting the
1724 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001725 // TODO: Do this in step 3. We already know the layout there.
1726 //
1727 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1728 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001729
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001730 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1731 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001732 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1733 // case (when the file will be explicitly erased).
David Brazdil7b49e6c2016-09-01 11:06:18 +01001734 bool WriteOutputFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001735 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1736
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001737 // Sync the data to the file, in case we did dex2dex transformations.
1738 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1739 if (!map->Sync()) {
1740 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1741 return false;
1742 }
1743 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001744
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001745 if (IsImage()) {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001746 if (IsAppImage() && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001747 gc::Heap* const heap = Runtime::Current()->GetHeap();
1748 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001749 image_base_ = std::max(image_base_, RoundUp(
1750 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1751 kPageSize));
1752 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001753 // The non moving space is right after the oat file. Put the preferred app image location
1754 // right after the non moving space so that we ideally get a continuous immune region for
1755 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001756 // Use the default non moving space capacity since dex2oat does not have a separate non-
1757 // moving space. This means the runtime's non moving space space size will be as large
1758 // as the growth limit for dex2oat, but smaller in the zygote.
1759 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001760 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001761 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1762 }
1763
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001764 image_writer_.reset(new ImageWriter(*driver_,
1765 image_base_,
1766 compiler_options_->GetCompilePic(),
1767 IsAppImage(),
1768 image_storage_mode_,
1769 oat_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00001770 dex_file_oat_index_map_));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001771
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001772 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001773 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1774 if (!image_writer_->PrepareImageAddressSpace()) {
1775 LOG(ERROR) << "Failed to prepare image address space.";
1776 return false;
1777 }
1778 }
1779
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001780 // Initialize the writers with the compiler driver, image writer, and their
1781 // dex files. The writers were created without those being there yet.
1782 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1783 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
1784 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1785 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
1786 }
1787
David Brazdil5d5a36b2016-09-14 15:34:10 +01001788 {
1789 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
1790 DCHECK(IsBootImage() || oat_files_.size() == 1u);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001791 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
David Brazdil5d5a36b2016-09-14 15:34:10 +01001792 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1793 File* vdex_file = vdex_files_[i].get();
1794 std::unique_ptr<BufferedOutputStream> vdex_out(
1795 MakeUnique<BufferedOutputStream>(MakeUnique<FileOutputStream>(vdex_file)));
1796
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001797 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01001798 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
1799 return false;
1800 }
1801
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001802 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
1803 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
1804 return false;
1805 }
1806
David Brazdil5d5a36b2016-09-14 15:34:10 +01001807 // VDEX finalized, seek back to the beginning and write the header.
1808 if (!oat_writers_[i]->WriteVdexHeader(vdex_out.get())) {
1809 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
1810 return false;
1811 }
1812 }
1813 }
1814
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001815 {
1816 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001817 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001818 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko944da602016-02-19 12:27:55 +00001819 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1820 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
1821
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001822 oat_writer->PrepareLayout(&patcher);
Vladimir Marko944da602016-02-19 12:27:55 +00001823
1824 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
David Brazdil7b49e6c2016-09-01 11:06:18 +01001825 size_t text_size = oat_writer->GetOatSize() - rodata_size;
Vladimir Markoaad75c62016-10-03 08:46:48 +00001826 elf_writer->PrepareDynamicSection(rodata_size,
1827 text_size,
1828 oat_writer->GetBssSize(),
1829 oat_writer->GetBssRootsOffset());
Vladimir Marko944da602016-02-19 12:27:55 +00001830
1831 if (IsImage()) {
1832 // Update oat layout.
1833 DCHECK(image_writer_ != nullptr);
1834 DCHECK_LT(i, oat_filenames_.size());
1835 image_writer_->UpdateOatFileLayout(i,
1836 elf_writer->GetLoadedSize(),
1837 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01001838 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00001839 }
1840 }
1841
1842 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001843 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001844 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1845 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00001846
David Srbecky09c2a6b2016-03-11 17:11:44 +00001847 oat_writer->AddMethodDebugInfos(debug::MakeTrampolineInfos(oat_writer->GetOatHeader()));
1848
David Srbecky0c4572e2016-01-22 19:19:25 +00001849 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00001850 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
1851 elf_writer->PrepareDebugInfo(oat_writer->GetMethodDebugInfo());
David Srbecky0c4572e2016-01-22 19:19:25 +00001852
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001853 OutputStream*& rodata = rodata_[i];
1854 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001855 if (!oat_writer->WriteRodata(rodata)) {
1856 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
1857 return false;
1858 }
1859 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001860 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00001861
Jeff Haodcdc85b2015-12-04 14:06:18 -08001862 OutputStream* text = elf_writer->StartText();
1863 if (!oat_writer->WriteCode(text)) {
1864 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
1865 return false;
1866 }
1867 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00001868
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001869 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
1870 image_file_location_oat_checksum_,
1871 image_file_location_oat_data_begin_,
1872 image_patch_delta_)) {
1873 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
1874 return false;
1875 }
1876
Vladimir Marko944da602016-02-19 12:27:55 +00001877 if (IsImage()) {
1878 // Update oat header information.
1879 DCHECK(image_writer_ != nullptr);
1880 DCHECK_LT(i, oat_filenames_.size());
1881 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
1882 }
1883
Jeff Haodcdc85b2015-12-04 14:06:18 -08001884 elf_writer->WriteDynamicSection();
1885 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
1886 elf_writer->WritePatchLocations(oat_writer->GetAbsolutePatchLocations());
Vladimir Marko10c13562015-11-25 14:33:36 +00001887
Jeff Haodcdc85b2015-12-04 14:06:18 -08001888 if (!elf_writer->End()) {
1889 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
1890 return false;
1891 }
1892
David Brazdil7b49e6c2016-09-01 11:06:18 +01001893 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
1894 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001895 }
1896
Jeff Haodcdc85b2015-12-04 14:06:18 -08001897 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001898
1899 oat_writer.reset();
1900 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001901 }
1902 }
1903
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001904 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001905 }
1906
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001907 // If we are compiling an image, invoke the image creation routine. Else just skip.
1908 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001909 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001910 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
1911 if (!CreateImageFile()) {
1912 return false;
1913 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001914 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07001915 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001916 return true;
1917 }
1918
Jeff Haodcdc85b2015-12-04 14:06:18 -08001919 // Create a copy from stripped to unstripped.
1920 bool CopyStrippedToUnstripped() {
1921 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
1922 // If we don't want to strip in place, copy from stripped location to unstripped location.
1923 // We need to strip after image creation because FixupElf needs to use .strtab.
1924 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
1925 // If the oat file is still open, flush it.
1926 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001927 if (!FlushCloseOutputFile(&oat_files_[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001928 return false;
1929 }
1930 }
1931
1932 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
1933 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
1934 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01001935 int64_t in_length = in->GetLength();
1936 if (in_length < 0) {
1937 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
1938 return false;
1939 }
1940 if (!out->Copy(in.get(), 0, in_length)) {
1941 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
1942 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001943 }
1944 if (out->FlushCloseOrErase() != 0) {
1945 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
1946 return false;
1947 }
1948 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
1949 }
1950 }
1951 return true;
1952 }
1953
David Brazdil7b49e6c2016-09-01 11:06:18 +01001954 bool FlushOutputFile(std::unique_ptr<File>* file) {
1955 if (file->get() != nullptr) {
1956 if (file->get()->Flush() != 0) {
1957 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
1958 return false;
1959 }
1960 }
1961 return true;
1962 }
1963
1964 bool FlushCloseOutputFile(std::unique_ptr<File>* file) {
1965 if (file->get() != nullptr) {
1966 std::unique_ptr<File> tmp(file->release());
1967 if (tmp->FlushCloseOrErase() != 0) {
1968 PLOG(ERROR) << "Failed to flush and close output file: " << tmp->GetPath();
1969 return false;
1970 }
1971 }
1972 return true;
1973 }
1974
1975 bool FlushOutputFiles() {
1976 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
1977 for (auto& files : { &vdex_files_, &oat_files_ }) {
1978 for (size_t i = 0; i < files->size(); ++i) {
1979 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08001980 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001981 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001982 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00001983 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08001984 return true;
1985 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001986
David Brazdil7b49e6c2016-09-01 11:06:18 +01001987 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001988 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01001989 for (auto& files : { &vdex_files_, &oat_files_ }) {
1990 for (size_t i = 0; i < files->size(); ++i) {
1991 result &= FlushCloseOutputFile(&(*files)[i]);
1992 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001993 }
1994 return result;
1995 }
1996
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001997 void DumpTiming() {
1998 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
1999 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2000 }
2001 if (dump_passes_) {
2002 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
2003 }
2004 }
2005
Andreas Gampe10e477d2014-11-19 12:57:42 -08002006 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002007 return IsAppImage() || IsBootImage();
2008 }
2009
2010 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002011 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002012 }
2013
2014 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002015 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002016 }
2017
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002018 bool IsHost() const {
2019 return is_host_;
2020 }
2021
Calin Juravle998c2162015-12-21 15:39:33 +02002022 bool UseProfileGuidedCompilation() const {
Andreas Gampe29d38e72016-03-23 15:31:51 +00002023 return CompilerFilter::DependsOnProfile(compiler_options_->GetCompilerFilter());
Calin Juravle998c2162015-12-21 15:39:33 +02002024 }
2025
Calin Juravle2e2db782016-02-23 12:00:03 +00002026 bool LoadProfile() {
Calin Juravle998c2162015-12-21 15:39:33 +02002027 DCHECK(UseProfileGuidedCompilation());
Calin Juravle2e2db782016-02-23 12:00:03 +00002028
2029 profile_compilation_info_.reset(new ProfileCompilationInfo());
2030 ScopedFlock flock;
Andreas Gampe29d38e72016-03-23 15:31:51 +00002031 bool success = true;
Calin Juravle2e2db782016-02-23 12:00:03 +00002032 std::string error;
2033 if (profile_file_fd_ != -1) {
2034 // The file doesn't need to be flushed so don't check the usage.
2035 // Pass a bogus path so that we can easily attribute any reported error.
2036 File file(profile_file_fd_, "profile", /*check_usage*/ false, /*read_only_mode*/ true);
2037 if (flock.Init(&file, &error)) {
2038 success = profile_compilation_info_->Load(profile_file_fd_);
2039 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00002040 } else if (profile_file_ != "") {
Calin Juravle2e2db782016-02-23 12:00:03 +00002041 if (flock.Init(profile_file_.c_str(), O_RDONLY, /* block */ true, &error)) {
2042 success = profile_compilation_info_->Load(flock.GetFile()->Fd());
2043 }
2044 }
2045 if (!error.empty()) {
2046 LOG(WARNING) << "Cannot lock profiles: " << error;
Calin Juravle998c2162015-12-21 15:39:33 +02002047 }
Calin Juravle877fd962016-01-05 14:29:29 +00002048
Calin Juravle2e2db782016-02-23 12:00:03 +00002049 if (!success) {
2050 profile_compilation_info_.reset(nullptr);
2051 }
Calin Juravle877fd962016-01-05 14:29:29 +00002052
Calin Juravle2e2db782016-02-23 12:00:03 +00002053 return success;
Calin Juravle998c2162015-12-21 15:39:33 +02002054 }
2055
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002056 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002057 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2058 if (is_image) {
2059 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2060 return false;
2061 }
2062 if (dex_files.size() < min_dex_files_for_swap_) {
2063 // If there are less dex files than the threshold, assume it's gonna be fine.
2064 return false;
2065 }
2066 size_t dex_files_size = 0;
2067 for (const auto* dex_file : dex_files) {
2068 dex_files_size += dex_file->GetHeader().file_size_;
2069 }
2070 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2071 }
2072
Andreas Gampe67f02822016-06-24 21:05:23 -07002073 bool IsVeryLarge(std::vector<const DexFile*>& dex_files) {
2074 size_t dex_files_size = 0;
2075 for (const auto* dex_file : dex_files) {
2076 dex_files_size += dex_file->GetHeader().file_size_;
2077 }
2078 return dex_files_size >= very_large_threshold_;
2079 }
2080
Vladimir Marko49b0f452015-12-10 13:49:19 +00002081 template <typename T>
2082 static std::vector<T*> MakeNonOwningPointerVector(const std::vector<std::unique_ptr<T>>& src) {
2083 std::vector<T*> result;
2084 result.reserve(src.size());
2085 for (const std::unique_ptr<T>& t : src) {
2086 result.push_back(t.get());
2087 }
2088 return result;
2089 }
2090
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002091 std::vector<std::string> GetClassPathLocations(const std::string& class_path) {
2092 // This function is used only for apps and for an app we have exactly one oat file.
2093 DCHECK(!IsBootImage());
2094 DCHECK_EQ(oat_writers_.size(), 1u);
2095 std::vector<std::string> dex_files_canonical_locations;
2096 for (const char* location : oat_writers_[0]->GetSourceLocations()) {
2097 dex_files_canonical_locations.push_back(DexFile::GetDexCanonicalLocation(location));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002098 }
Vladimir Marko625a64a2015-11-26 14:44:16 +00002099
Vladimir Marko919f5532016-01-20 19:13:01 +00002100 std::vector<std::string> parsed;
2101 Split(class_path, ':', &parsed);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002102 auto kept_it = std::remove_if(parsed.begin(),
2103 parsed.end(),
2104 [dex_files_canonical_locations](const std::string& location) {
2105 return ContainsElement(dex_files_canonical_locations,
2106 DexFile::GetDexCanonicalLocation(location.c_str()));
2107 });
2108 parsed.erase(kept_it, parsed.end());
2109 return parsed;
2110 }
2111
Jeff Haofbeb1322016-04-26 14:27:31 -07002112 // Opens requested class path files and appends them to opened_dex_files. If the dex files have
2113 // been stripped, this opens them from their oat files and appends them to opened_oat_files.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002114 static void OpenClassPathFiles(const std::vector<std::string>& class_path_locations,
Jeff Haof0192c82016-03-28 20:39:50 -07002115 std::vector<std::unique_ptr<const DexFile>>* opened_dex_files,
Jeff Haofbeb1322016-04-26 14:27:31 -07002116 std::vector<std::unique_ptr<OatFile>>* opened_oat_files,
Jeff Haof0192c82016-03-28 20:39:50 -07002117 InstructionSet isa) {
Jeff Haofbeb1322016-04-26 14:27:31 -07002118 DCHECK(opened_dex_files != nullptr) << "OpenClassPathFiles dex out-param is nullptr";
2119 DCHECK(opened_oat_files != nullptr) << "OpenClassPathFiles oat out-param is nullptr";
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002120 for (const std::string& location : class_path_locations) {
Jeff Haof0192c82016-03-28 20:39:50 -07002121 // Stop early if we detect the special shared library, which may be passed as the classpath
2122 // for dex2oat when we want to skip the shared libraries check.
2123 if (location == OatFile::kSpecialSharedLibrary) {
2124 break;
2125 }
Aart Bik37d6a3b2016-06-21 18:30:10 -07002126 static constexpr bool kVerifyChecksum = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002127 std::string error_msg;
Aart Bik37d6a3b2016-06-21 18:30:10 -07002128 if (!DexFile::Open(
2129 location.c_str(), location.c_str(), kVerifyChecksum, &error_msg, opened_dex_files)) {
Jeff Haof0192c82016-03-28 20:39:50 -07002130 // If we fail to open the dex file because it's been stripped, try to open the dex file
2131 // from its corresponding oat file.
Richard Uhlerd1472a22016-04-15 15:18:56 -07002132 OatFileAssistant oat_file_assistant(location.c_str(), isa, false);
Jeff Haof0192c82016-03-28 20:39:50 -07002133 std::unique_ptr<OatFile> oat_file(oat_file_assistant.GetBestOatFile());
2134 if (oat_file == nullptr) {
2135 LOG(WARNING) << "Failed to open dex file and associated oat file for '" << location
2136 << "': " << error_msg;
2137 } else {
2138 std::vector<std::unique_ptr<const DexFile>> oat_dex_files =
2139 oat_file_assistant.LoadDexFiles(*oat_file, location.c_str());
Jeff Haofbeb1322016-04-26 14:27:31 -07002140 opened_oat_files->push_back(std::move(oat_file));
Jeff Haof0192c82016-03-28 20:39:50 -07002141 opened_dex_files->insert(opened_dex_files->end(),
2142 std::make_move_iterator(oat_dex_files.begin()),
2143 std::make_move_iterator(oat_dex_files.end()));
2144 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002145 }
2146 }
2147 }
2148
Vladimir Marko49b0f452015-12-10 13:49:19 +00002149 bool PrepareImageClasses() {
2150 // If --image-classes was specified, calculate the full list of classes to include in the image.
2151 if (image_classes_filename_ != nullptr) {
2152 image_classes_ =
2153 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2154 if (image_classes_ == nullptr) {
2155 return false;
2156 }
2157 } else if (IsBootImage()) {
2158 image_classes_.reset(new std::unordered_set<std::string>);
2159 }
2160 return true;
2161 }
2162
2163 bool PrepareCompiledClasses() {
2164 // If --compiled-classes was specified, calculate the full list of classes to compile in the
2165 // image.
2166 if (compiled_classes_filename_ != nullptr) {
2167 compiled_classes_ =
2168 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
2169 if (compiled_classes_ == nullptr) {
2170 return false;
2171 }
2172 } else {
2173 compiled_classes_.reset(nullptr); // By default compile everything.
2174 }
2175 return true;
2176 }
2177
2178 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2179 const char* classes_filename,
2180 const char* tag) {
2181 std::unique_ptr<std::unordered_set<std::string>> classes;
2182 std::string error_msg;
2183 if (zip_filename != nullptr) {
2184 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2185 } else {
2186 classes.reset(ReadImageClassesFromFile(classes_filename));
2187 }
2188 if (classes == nullptr) {
2189 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2190 << classes_filename << "': " << error_msg;
2191 }
2192 return classes;
2193 }
2194
2195 bool PrepareCompiledMethods() {
2196 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2197 if (compiled_methods_filename_ != nullptr) {
2198 std::string error_msg;
2199 if (compiled_methods_zip_filename_ != nullptr) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002200 compiled_methods_.reset(ReadCommentedInputFromZip<std::unordered_set<std::string>>(
2201 compiled_methods_zip_filename_,
2202 compiled_methods_filename_,
2203 nullptr, // No post-processing.
2204 &error_msg));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002205 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002206 compiled_methods_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2207 compiled_methods_filename_,
2208 nullptr)); // No post-processing.
Vladimir Marko49b0f452015-12-10 13:49:19 +00002209 }
2210 if (compiled_methods_.get() == nullptr) {
2211 LOG(ERROR) << "Failed to create list of compiled methods from '"
2212 << compiled_methods_filename_ << "': " << error_msg;
2213 return false;
2214 }
2215 } else {
2216 compiled_methods_.reset(nullptr); // By default compile everything.
2217 }
2218 return true;
2219 }
2220
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002221 void PruneNonExistentDexFiles() {
2222 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2223 size_t kept = 0u;
2224 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2225 if (!OS::FileExists(dex_filenames_[i])) {
2226 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2227 } else {
2228 dex_filenames_[kept] = dex_filenames_[i];
2229 dex_locations_[kept] = dex_locations_[i];
2230 ++kept;
2231 }
2232 }
2233 dex_filenames_.resize(kept);
2234 dex_locations_.resize(kept);
2235 }
2236
2237 bool AddDexFileSources() {
2238 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
2239 if (zip_fd_ != -1) {
2240 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002241 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2242 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002243 return false;
2244 }
2245 } else if (oat_writers_.size() > 1u) {
2246 // Multi-image.
2247 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2248 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2249 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2250 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2251 return false;
2252 }
2253 }
2254 } else {
2255 DCHECK_EQ(oat_writers_.size(), 1u);
2256 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2257 DCHECK_NE(dex_filenames_.size(), 0u);
2258 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2259 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2260 return false;
2261 }
2262 }
2263 }
2264 return true;
2265 }
2266
2267 void CreateOatWriters() {
2268 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2269 elf_writers_.reserve(oat_files_.size());
2270 oat_writers_.reserve(oat_files_.size());
2271 for (const std::unique_ptr<File>& oat_file : oat_files_) {
David Srbecky5d811202016-03-08 13:21:22 +00002272 elf_writers_.emplace_back(CreateElfWriterQuick(instruction_set_,
2273 instruction_set_features_.get(),
2274 compiler_options_.get(),
2275 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002276 elf_writers_.back()->Start();
Jeff Hao608f2ce2016-10-19 11:17:11 -07002277 bool do_dexlayout = compiler_options_->GetCompilerFilter() == CompilerFilter::kLayoutProfile;
2278 oat_writers_.emplace_back(new OatWriter(
2279 IsBootImage(), timings_, do_dexlayout ? profile_compilation_info_.get() : nullptr));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002280 }
2281 }
2282
Vladimir Marko49b0f452015-12-10 13:49:19 +00002283 void SaveDexInput() {
2284 for (size_t i = 0; i < dex_files_.size(); ++i) {
2285 const DexFile* dex_file = dex_files_[i];
2286 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2287 getpid(), i));
2288 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2289 if (tmp_file.get() == nullptr) {
2290 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2291 << ". Try: adb shell chmod 777 /data/local/tmp";
2292 continue;
2293 }
2294 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2295 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2296 UNUSED(tmp_file->Flush());
2297 UNUSED(tmp_file->Close());
2298 LOG(INFO) << "Wrote input to " << tmp_file_name;
2299 }
2300 }
2301
2302 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options) {
2303 RuntimeOptions raw_options;
2304 if (boot_image_filename_.empty()) {
2305 std::string boot_class_path = "-Xbootclasspath:";
2306 boot_class_path += Join(dex_filenames_, ':');
2307 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2308 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
2309 boot_class_path_locations += Join(dex_locations_, ':');
2310 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2311 } else {
2312 std::string boot_image_option = "-Ximage:";
2313 boot_image_option += boot_image_filename_;
2314 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2315 }
2316 for (size_t i = 0; i < runtime_args_.size(); i++) {
2317 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2318 }
2319
2320 raw_options.push_back(std::make_pair("compilercallbacks", callbacks_.get()));
2321 raw_options.push_back(
2322 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2323
2324 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2325 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2326 // have been stripped in preopting, anyways).
2327 if (!IsBootImage()) {
2328 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2329 }
2330 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2331 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2332 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002333 // Disable Hspace compaction to save heap size virtual space.
2334 // Only need disable Hspace for OOM becasue background collector is equal to
2335 // foreground collector by default for dex2oat.
2336 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002337
Andreas Gampeace0dc12016-01-20 13:33:13 -08002338 // If we're asked to be deterministic, ensure non-concurrent GC for determinism. Also
2339 // force the free-list implementation for large objects.
2340 if (compiler_options_->IsForceDeterminism()) {
2341 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
2342 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=freelist", nullptr));
2343
2344 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2345 // compaction (done above) and ensure that neither foreground nor background collectors
2346 // are concurrent.
2347 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2348
2349 // To make identity hashcode deterministic, set a known seed.
2350 mirror::Object::SetHashCodeSeed(987654321U);
2351 }
2352
Vladimir Marko49b0f452015-12-10 13:49:19 +00002353 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2354 LOG(ERROR) << "Failed to parse runtime options";
2355 return false;
2356 }
2357 return true;
2358 }
2359
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002360 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002361 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2362 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002363 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002364 LOG(ERROR) << "Failed to create runtime";
2365 return false;
2366 }
Andreas Gampe49c144d2016-11-14 10:11:16 -08002367
2368 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2369 // "ps -a" don't change to non-descript "main."
2370 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2371
Vladimir Marko307dac92015-10-20 11:20:09 +01002372 runtime_.reset(Runtime::Current());
2373 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002374 for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) {
2375 Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002376 if (!runtime_->HasCalleeSaveMethod(type)) {
2377 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002378 }
2379 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002380 runtime_->GetClassLinker()->FixupDexCaches(runtime_->GetResolutionMethod());
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002381
2382 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2383 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002384 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002385
Vladimir Marko307dac92015-10-20 11:20:09 +01002386 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002387
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002388 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2389 // Runtime::Start, give it away now so that we don't starve GC.
2390 Thread* self = Thread::Current();
2391 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002392
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002393 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002394 }
2395
Jeff Haodcdc85b2015-12-04 14:06:18 -08002396 // Let the ImageWriter write the image files. If we do not compile PIC, also fix up the oat files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002397 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002398 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002399 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002400 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002401 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002402 image_filenames_.push_back(app_image_file_name_.c_str());
2403 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002404 if (!image_writer_->Write(app_image_fd_,
2405 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002406 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002407 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002408 return false;
2409 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002410
Jeff Haodcdc85b2015-12-04 14:06:18 -08002411 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002412 dchecked_vector<uintptr_t> oat_data_begins;
2413 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2414 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002415 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002416 // Destroy ImageWriter before doing FixupElf.
2417 image_writer_.reset();
2418
Vladimir Marko944da602016-02-19 12:27:55 +00002419 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2420 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002421 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2422 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2423 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2424 if (oat_file.get() == nullptr) {
2425 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2426 return false;
2427 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002428
Vladimir Marko944da602016-02-19 12:27:55 +00002429 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002430 oat_file->Erase();
2431 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2432 return false;
2433 }
2434
2435 if (oat_file->FlushCloseOrErase()) {
2436 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2437 return false;
2438 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002439 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002440 }
2441
2442 return true;
2443 }
2444
2445 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002446 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2447 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002448 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002449 return ReadCommentedInputFromFile<std::unordered_set<std::string>>(image_classes_filename,
2450 &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002451 }
2452
2453 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002454 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002455 const char* zip_filename,
2456 const char* image_classes_filename,
2457 std::string* error_msg) {
2458 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002459 return ReadCommentedInputFromZip<std::unordered_set<std::string>>(zip_filename,
2460 image_classes_filename,
2461 &process,
2462 error_msg);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002463 }
2464
2465 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2466 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002467 template <typename T>
2468 static T* ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002469 const char* input_filename, std::function<std::string(const char*)>* process) {
2470 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2471 if (input_file.get() == nullptr) {
2472 LOG(ERROR) << "Failed to open input file " << input_filename;
2473 return nullptr;
2474 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002475 std::unique_ptr<T> result(
2476 ReadCommentedInputStream<T>(*input_file, process));
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002477 input_file->close();
2478 return result.release();
2479 }
2480
2481 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2482 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002483 template <typename T>
2484 static T* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002485 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002486 const char* input_filename,
2487 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002488 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002489 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2490 if (zip_archive.get() == nullptr) {
2491 return nullptr;
2492 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002493 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002494 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002495 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002496 zip_filename, error_msg->c_str());
2497 return nullptr;
2498 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002499 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2500 input_filename,
2501 error_msg));
2502 if (input_file.get() == nullptr) {
2503 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002504 zip_filename, error_msg->c_str());
2505 return nullptr;
2506 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002507 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2508 input_file->Size());
2509 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002510 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002511 }
2512
2513 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2514 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002515 template <typename T>
2516 static T* ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002517 std::istream& in_stream,
2518 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002519 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002520 while (in_stream.good()) {
2521 std::string dot;
2522 std::getline(in_stream, dot);
2523 if (StartsWith(dot, "#") || dot.empty()) {
2524 continue;
2525 }
2526 if (process != nullptr) {
2527 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002528 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002529 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002530 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002531 }
2532 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002533 return output.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002534 }
2535
Mathieu Chartier49285c52014-12-02 15:43:48 -08002536 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002537 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2538 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002539 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002540 LOG(INFO) << "dex2oat took " << PrettyDuration(NanoTime() - start_ns_)
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002541 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002542 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002543 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2544 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002545 }
2546
Jeff Haodcdc85b2015-12-04 14:06:18 -08002547 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2548 std::string res(image_filename);
2549 size_t last_slash = res.rfind('/');
2550 if (last_slash == std::string::npos || last_slash == 0) {
2551 return res;
2552 }
2553 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2554 if (penultimate_slash == std::string::npos) {
2555 return res;
2556 }
2557 // Check that the string in-between is the expected one.
2558 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2559 GetInstructionSetString(isa)) {
2560 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2561 return res;
2562 }
2563 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2564 }
2565
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002566 std::unique_ptr<CompilerOptions> compiler_options_;
2567 Compiler::Kind compiler_kind_;
2568
2569 InstructionSet instruction_set_;
2570 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2571
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002572 uint32_t image_file_location_oat_checksum_;
2573 uintptr_t image_file_location_oat_data_begin_;
2574 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002575 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2576
Vladimir Marko307dac92015-10-20 11:20:09 +01002577 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002578
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002579 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2580
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002581 std::unique_ptr<Runtime> runtime_;
2582
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002583 // Ownership for the class path files.
2584 std::vector<std::unique_ptr<const DexFile>> class_path_files_;
2585
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002586 size_t thread_count_;
2587 uint64_t start_ns_;
2588 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002589 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002590 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002591 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002592 std::vector<const char*> oat_filenames_;
2593 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002594 int oat_fd_;
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00002595 int input_vdex_fd_;
2596 int output_vdex_fd_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002597 std::vector<const char*> dex_filenames_;
2598 std::vector<const char*> dex_locations_;
2599 int zip_fd_;
2600 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002601 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002602 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002603 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002604 uintptr_t image_base_;
2605 const char* image_classes_zip_filename_;
2606 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002607 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002608 const char* compiled_classes_zip_filename_;
2609 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002610 const char* compiled_methods_zip_filename_;
2611 const char* compiled_methods_filename_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002612 const char* passes_to_run_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002613 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2614 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002615 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002616 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Jeff Hao436183f2016-01-12 16:36:50 -08002617 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002618 bool is_host_;
2619 std::string android_root_;
Mathieu Chartier0b490842016-05-25 15:05:59 -07002620 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002621 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002622 std::string no_inline_from_string_;
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002623 std::vector<jobject> dex_caches_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002624 jobject class_loader_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002625
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002626 std::vector<std::unique_ptr<ElfWriter>> elf_writers_;
2627 std::vector<std::unique_ptr<OatWriter>> oat_writers_;
2628 std::vector<OutputStream*> rodata_;
David Brazdil5d5a36b2016-09-14 15:34:10 +01002629 std::vector<std::unique_ptr<OutputStream>> vdex_out_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002630 std::unique_ptr<ImageWriter> image_writer_;
2631 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002632
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002633 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
Jeff Haofbeb1322016-04-26 14:27:31 -07002634 std::vector<std::unique_ptr<OatFile>> opened_oat_files_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002635 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2636
Vladimir Marko47496c22016-01-27 16:15:08 +00002637 std::vector<const DexFile*> no_inline_from_dex_files_;
2638
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002639 std::vector<std::string> verbose_methods_;
2640 bool dump_stats_;
2641 bool dump_passes_;
2642 bool dump_timing_;
2643 bool dump_slow_timing_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002644 std::string swap_file_name_;
2645 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002646 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2647 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002648 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002649 std::string app_image_file_name_;
2650 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002651 std::string profile_file_;
2652 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002653 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002654 TimingLogger* timings_;
2655 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002656 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002657 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002658
2659 // Backing storage.
2660 std::vector<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002661
Andreas Gampeace0dc12016-01-20 13:33:13 -08002662 // See CompilerOptions.force_determinism_.
2663 bool force_determinism_;
2664
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002665 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2666};
2667
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002668static void b13564922() {
2669#if defined(__linux__) && defined(__arm__)
2670 int major, minor;
2671 struct utsname uts;
2672 if (uname(&uts) != -1 &&
2673 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2674 ((major < 3) || ((major == 3) && (minor < 4)))) {
2675 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2676 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2677 int old_personality = personality(0xffffffff);
2678 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2679 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2680 if (new_personality == -1) {
2681 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2682 }
2683 }
2684 }
2685#endif
2686}
2687
Andreas Gampe10e477d2014-11-19 12:57:42 -08002688static int CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002689 dex2oat.LoadClassProfileDescriptors();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002690 dex2oat.Compile();
2691
David Brazdil7b49e6c2016-09-01 11:06:18 +01002692 if (!dex2oat.WriteOutputFiles()) {
2693 dex2oat.EraseOutputFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002694 return EXIT_FAILURE;
2695 }
2696
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002697 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2698 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2699 // image writer will require this fd to generate the image.
2700 if (dex2oat.ShouldKeepOatFileOpen()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002701 if (!dex2oat.FlushOutputFiles()) {
2702 dex2oat.EraseOutputFiles();
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002703 return EXIT_FAILURE;
2704 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01002705 } else if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002706 return EXIT_FAILURE;
2707 }
2708
Jeff Haodcdc85b2015-12-04 14:06:18 -08002709 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002710 if (!dex2oat.HandleImage()) {
2711 return EXIT_FAILURE;
2712 }
2713
2714 // When given --host, finish early without stripping.
2715 if (dex2oat.IsHost()) {
2716 dex2oat.DumpTiming();
2717 return EXIT_SUCCESS;
2718 }
2719
Jeff Haodcdc85b2015-12-04 14:06:18 -08002720 // Copy stripped to unstripped location, if necessary.
2721 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002722 return EXIT_FAILURE;
2723 }
2724
Jeff Haodcdc85b2015-12-04 14:06:18 -08002725 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002726 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002727 return EXIT_FAILURE;
2728 }
2729
2730 dex2oat.DumpTiming();
2731 return EXIT_SUCCESS;
2732}
2733
2734static int CompileApp(Dex2Oat& dex2oat) {
2735 dex2oat.Compile();
2736
David Brazdil7b49e6c2016-09-01 11:06:18 +01002737 if (!dex2oat.WriteOutputFiles()) {
2738 dex2oat.EraseOutputFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002739 return EXIT_FAILURE;
2740 }
2741
Jeff Haodcdc85b2015-12-04 14:06:18 -08002742 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002743 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002744
2745 // When given --host, finish early without stripping.
2746 if (dex2oat.IsHost()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002747 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002748 return EXIT_FAILURE;
2749 }
2750
2751 dex2oat.DumpTiming();
2752 return EXIT_SUCCESS;
2753 }
2754
Jeff Haodcdc85b2015-12-04 14:06:18 -08002755 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2756 // stripped versions. If this is given, we expect to be able to open writable files by name.
2757 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002758 return EXIT_FAILURE;
2759 }
2760
Jeff Haodcdc85b2015-12-04 14:06:18 -08002761 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002762 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002763 return EXIT_FAILURE;
2764 }
2765
2766 dex2oat.DumpTiming();
2767 return EXIT_SUCCESS;
2768}
2769
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002770static int dex2oat(int argc, char** argv) {
2771 b13564922();
2772
2773 TimingLogger timings("compiler", false, false);
2774
Roland Levillain5c7e2602016-02-23 18:08:53 +00002775 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
2776 // might produce a stack frame too large for this function or for
2777 // functions inlining it (such as main), that would not fit the
2778 // requirements of the `-Wframe-larger-than` option.
2779 std::unique_ptr<Dex2Oat> dex2oat = MakeUnique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002780
2781 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002782 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002783
Calin Juravleb077e152016-02-18 18:47:37 +00002784 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02002785 // This operation involves I/O.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002786 if (dex2oat->UseProfileGuidedCompilation()) {
Calin Juravleb077e152016-02-18 18:47:37 +00002787 if (!dex2oat->LoadProfile()) {
2788 LOG(ERROR) << "Failed to process profile file";
Calin Juravle998c2162015-12-21 15:39:33 +02002789 return EXIT_FAILURE;
2790 }
2791 }
2792
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002793 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00002794 if (!dex2oat->OpenFile()) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002795 return EXIT_FAILURE;
2796 }
2797
Andreas Gampe046c7062015-05-18 23:22:54 -07002798 // Print the complete line when any of the following is true:
2799 // 1) Debug build
2800 // 2) Compiling an image
2801 // 3) Compiling with --host
2802 // 4) Compiling on the host (not a target build)
2803 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002804 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07002805 LOG(INFO) << CommandLine();
2806 } else {
2807 LOG(INFO) << StrippedCommandLine();
2808 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002809
Roland Levillain5c7e2602016-02-23 18:08:53 +00002810 if (!dex2oat->Setup()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002811 dex2oat->EraseOutputFiles();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002812 return EXIT_FAILURE;
2813 }
2814
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07002815 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
2816 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07002817 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
2818
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002819 bool result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00002820 if (dex2oat->IsImage()) {
2821 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002822 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00002823 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002824 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002825
Roland Levillain5c7e2602016-02-23 18:08:53 +00002826 dex2oat->Shutdown();
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002827 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002828}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002829} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07002830
2831int main(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002832 int result = art::dex2oat(argc, argv);
2833 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
2834 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
2835 // should not destruct the runtime in this case.
Evgenii Stepanov1e133742015-05-20 12:30:59 -07002836 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002837 exit(result);
2838 }
2839 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002840}