blob: 492305425915663de1f746d427d6e9e3dc2dd559 [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"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000273 "|everything-profile"
274 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700275 UsageError(" select compiler filter.");
Mathieu Chartiera8077802016-03-16 19:08:31 -0700276 UsageError(" verify-profile requires a --profile(-fd) to also be passed in.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800277 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800278 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800279 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800280 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
281 UsageError(" method for compiler filter tuning.");
282 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
283 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
284 UsageError("");
285 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
286 UsageError(" method for compiler filter tuning.");
287 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
288 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
289 UsageError("");
290 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
291 UsageError(" method for compiler filter tuning.");
292 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
293 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
294 UsageError("");
295 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
296 UsageError(" method for compiler filter tuning.");
297 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
298 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
299 UsageError("");
300 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
301 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700302 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
303 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800304 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
305 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
306 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100307 UsageError(" --inline-depth-limit=<depth-limit>: the depth limit of inlining for fine tuning");
308 UsageError(" the compiler. A zero value will disable inlining. Honored only by Optimizing.");
Roland Levillaina215b952015-08-07 11:38:32 +0100309 UsageError(" Has priority over the --compiler-filter option. Intended for ");
310 UsageError(" development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100311 UsageError(" Example: --inline-depth-limit=%d", CompilerOptions::kDefaultInlineDepthLimit);
312 UsageError(" Default: %d", CompilerOptions::kDefaultInlineDepthLimit);
313 UsageError("");
314 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
315 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100316 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
317 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100318 UsageError(" Example: --inline-max-code-units=%d",
319 CompilerOptions::kDefaultInlineMaxCodeUnits);
320 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
321 UsageError("");
Ian Rogers46398602013-08-20 07:50:36 -0700322 UsageError(" --dump-timing: display a breakdown of where time was spent");
323 UsageError("");
Alex Light53cb16b2014-06-12 11:26:29 -0700324 UsageError(" --include-patch-information: Include patching information so the generated code");
325 UsageError(" can have its base address moved without full recompilation.");
326 UsageError("");
327 UsageError(" --no-include-patch-information: Do not include patching information.");
328 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100329 UsageError(" -g");
330 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
331 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000332 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000333 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700334 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100335 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100336 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000337 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
338 UsageError(" debug information necessary to print backtraces. (disabled by default)");
339 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000340 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000341 UsageError("");
Alexey Alexandrovab40c112016-09-19 09:33:49 -0700342 UsageError(" --generate-build-id: Generate GNU-compatible linker build ID ELF section with");
343 UsageError(" SHA-1 of the file content (and thus stable across identical builds)");
344 UsageError("");
345 UsageError(" --no-generate-build-id: Do not generate the build ID ELF section.");
346 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000347 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000348 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700349 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
350 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
351 UsageError(" Use a separate --runtime-arg switch for each argument.");
352 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700353 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000354 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700355 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000356 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
357 UsageError(" Cannot be used together with --profile-file.");
358 UsageError("");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800359 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
360 UsageError(" Example: --swap-file=/data/tmp/swap.001");
361 UsageError("");
362 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
363 UsageError(" Example: --swap-fd=10");
364 UsageError("");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700365 UsageError(" --swap-dex-size-threshold=<size>: specifies the minimum total dex file size in");
366 UsageError(" bytes to allow the use of swap.");
367 UsageError(" Example: --swap-dex-size-threshold=1000000");
368 UsageError(" Default: %zu", kDefaultMinDexFileCumulativeSizeForSwap);
369 UsageError("");
370 UsageError(" --swap-dex-count-threshold=<count>: specifies the minimum number of dex files to");
371 UsageError(" allow the use of swap.");
372 UsageError(" Example: --swap-dex-count-threshold=10");
373 UsageError(" Default: %zu", kDefaultMinDexFilesForSwap);
374 UsageError("");
Andreas Gampe67f02822016-06-24 21:05:23 -0700375 UsageError(" --very-large-app-threshold=<size>: specifies the minimum total dex file size in");
376 UsageError(" bytes to consider the input \"very large\" and punt on the compilation.");
377 UsageError(" Example: --very-large-app-threshold=100000000");
378 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700379 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
380 UsageError(" Example: --app-image-fd=10");
381 UsageError("");
382 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
383 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
384 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800385 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
386 "input dex file.");
387 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000388 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
389 UsageError(" This option is incompatible with read barriers (e.g., if dex2oat has been");
390 UsageError(" built with the environment variable `ART_USE_READ_BARRIER` set to `true`).");
391 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700392 std::cerr << "See log for usage error information\n";
393 exit(EXIT_FAILURE);
394}
395
Brian Carlstrom7940e442013-07-12 13:46:57 -0700396// The primary goal of the watchdog is to prevent stuck build servers
397// during development when fatal aborts lead to a cascade of failures
398// that result in a deadlock.
399class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800400// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700401#undef CHECK_PTHREAD_CALL
402#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
403 do { \
404 int rc = call args; \
405 if (rc != 0) { \
406 errno = rc; \
407 std::string message(# call); \
408 message += " failed for "; \
409 message += reason; \
410 Fatal(message); \
411 } \
412 } while (false)
413
414 public:
Brian Carlstrom93ba8932013-07-17 21:31:49 -0700415 explicit WatchDog(bool is_watch_dog_enabled) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700416 is_watch_dog_enabled_ = is_watch_dog_enabled;
417 if (!is_watch_dog_enabled_) {
418 return;
419 }
420 shutting_down_ = false;
421 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700422 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
423 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700424 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
425 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
426 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
427 }
428 ~WatchDog() {
429 if (!is_watch_dog_enabled_) {
430 return;
431 }
432 const char* reason = "dex2oat watch dog thread shutdown";
433 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
434 shutting_down_ = true;
435 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
436 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
437
Kenny Root51316382014-05-13 14:59:37 -0700438 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700439
440 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
441 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
442 }
443
444 private:
445 static void* CallBack(void* arg) {
446 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
447 ::art::SetThreadName("dex2oat watch dog");
448 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700449 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700450 }
451
Andreas Gampe794ad762015-02-23 08:12:24 -0800452 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700453 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
454 // it's rather easy to hang in unwinding.
455 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
456 // logcat logging or stderr output.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700457 android::base::LogMessage::LogLine(__FILE__,
458 __LINE__,
459 android::base::LogId::DEFAULT,
460 LogSeverity::FATAL,
461 message.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700462 exit(1);
463 }
464
465 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700466 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
467 // large.
Andreas Gamped687e372015-04-28 23:16:03 -0700468 constexpr int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700469 timespec timeout_ts;
470 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts);
471 const char* reason = "dex2oat watch dog thread waiting";
472 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
473 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800474 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700475 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700476 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
477 kWatchDogTimeoutSeconds));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700478 } else if (rc != 0) {
479 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
480 strerror(errno)));
481 Fatal(message.c_str());
482 }
483 }
484 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
485 }
486
487 // 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 -0700488 // Debug builds are slower so they have larger timeouts.
Andreas Gamped687e372015-04-28 23:16:03 -0700489 static constexpr int64_t kSlowdownFactor = kIsDebugBuild ? 5U : 1U;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800490
Andreas Gampe540138a2015-09-14 15:34:38 -0700491 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
492 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
493 // itself before that watchdog would take down the system server.
494 static constexpr int64_t kWatchDogTimeoutSeconds = kSlowdownFactor * (9 * 60 + 30);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700495
496 bool is_watch_dog_enabled_;
497 bool shutting_down_;
498 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
499 pthread_mutex_t mutex_;
500 pthread_cond_t cond_;
501 pthread_attr_t attr_;
502 pthread_t pthread_;
503};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700504
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800505class Dex2Oat FINAL {
506 public:
507 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100508 compiler_kind_(Compiler::kOptimizing),
Artem Serovba6b6792016-08-15 14:22:07 +0100509 instruction_set_(kRuntimeISA == kArm ? kThumb2 : kRuntimeISA),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800510 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000511 image_file_location_oat_checksum_(0),
512 image_file_location_oat_data_begin_(0),
513 image_patch_delta_(0),
514 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700515 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800516 runtime_(nullptr),
517 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
518 start_ns_(NanoTime()),
519 oat_fd_(-1),
Nicolas Geoffraybc654d02016-11-07 16:23:11 +0000520 input_vdex_fd_(-1),
521 output_vdex_fd_(-1),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800522 zip_fd_(-1),
523 image_base_(0U),
524 image_classes_zip_filename_(nullptr),
525 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800526 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800527 compiled_classes_zip_filename_(nullptr),
528 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700529 compiled_methods_zip_filename_(nullptr),
530 compiled_methods_filename_(nullptr),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700531 passes_to_run_filename_(nullptr),
Jeff Hao436183f2016-01-12 16:36:50 -0800532 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800533 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000534 class_loader_(nullptr),
535 elf_writers_(),
536 oat_writers_(),
537 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000538 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700539 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000540 opened_dex_files_maps_(),
541 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000542 no_inline_from_dex_files_(),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800543 dump_stats_(false),
544 dump_passes_(false),
545 dump_timing_(false),
546 dump_slow_timing_(kIsDebugBuild),
Calin Juravle2e2db782016-02-23 12:00:03 +0000547 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800548 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000549 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800550 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000551 force_determinism_(false)
552 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800553
554 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800555 // Log completion time before deleting the runtime_, because this accesses
556 // the runtime.
557 LogCompletionTime();
558
Vladimir Marko307dac92015-10-20 11:20:09 +0100559 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
560 // We want to just exit on non-debug builds, not bringing the runtime down
561 // in an orderly fashion. So release the following fields.
562 driver_.release();
563 image_writer_.release();
564 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
565 dex_file.release();
566 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000567 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
568 map.release();
569 }
David Brazdil7b49e6c2016-09-01 11:06:18 +0100570 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
571 vdex_file.release();
572 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800573 for (std::unique_ptr<File>& oat_file : oat_files_) {
574 oat_file.release();
575 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100576 runtime_.release();
577 verification_results_.release();
578 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100579 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700580 }
581
Roland Levillain9ec5e222015-08-17 20:18:41 +0100582 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800583 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800584 std::string boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800585 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000586 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800587 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100588 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800589
Roland Levillain9ec5e222015-08-17 20:18:41 +0100590 void ParseZipFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000591 ParseUintOption(option, "--zip-fd", &zip_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100592 }
593
Nicolas Geoffraybc654d02016-11-07 16:23:11 +0000594 void ParseInputVdexFd(const StringPiece& option) {
595 ParseUintOption(option, "--input-vdex-fd", &input_vdex_fd_, Usage);
596 }
597
598 void ParseOutputVdexFd(const StringPiece& option) {
599 ParseUintOption(option, "--output-vdex-fd", &output_vdex_fd_, Usage);
David Brazdil7b49e6c2016-09-01 11:06:18 +0100600 }
601
Roland Levillain9ec5e222015-08-17 20:18:41 +0100602 void ParseOatFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000603 ParseUintOption(option, "--oat-fd", &oat_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100604 }
605
Calin Juravle877fd962016-01-05 14:29:29 +0000606 void ParseFdForCollection(const StringPiece& option,
607 const char* arg_name,
608 std::vector<uint32_t>* fds) {
609 uint32_t fd;
610 ParseUintOption(option, arg_name, &fd, Usage);
611 fds->push_back(fd);
612 }
613
Roland Levillain9ec5e222015-08-17 20:18:41 +0100614 void ParseJ(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000615 ParseUintOption(option, "-j", &thread_count_, Usage, /* is_long_option */ false);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100616 }
617
618 void ParseBase(const StringPiece& option) {
619 DCHECK(option.starts_with("--base="));
620 const char* image_base_str = option.substr(strlen("--base=")).data();
621 char* end;
622 image_base_ = strtoul(image_base_str, &end, 16);
623 if (end == image_base_str || *end != '\0') {
624 Usage("Failed to parse hexadecimal value for option %s", option.data());
625 }
626 }
627
628 void ParseInstructionSet(const StringPiece& option) {
629 DCHECK(option.starts_with("--instruction-set="));
630 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
631 // StringPiece is not necessarily zero-terminated, so need to make a copy and ensure it.
632 std::unique_ptr<char[]> buf(new char[instruction_set_str.length() + 1]);
633 strncpy(buf.get(), instruction_set_str.data(), instruction_set_str.length());
634 buf.get()[instruction_set_str.length()] = 0;
635 instruction_set_ = GetInstructionSetFromString(buf.get());
636 // arm actually means thumb2.
637 if (instruction_set_ == InstructionSet::kArm) {
638 instruction_set_ = InstructionSet::kThumb2;
639 }
640 }
641
642 void ParseInstructionSetVariant(const StringPiece& option, ParserOptions* parser_options) {
643 DCHECK(option.starts_with("--instruction-set-variant="));
644 StringPiece str = option.substr(strlen("--instruction-set-variant=")).data();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800645 instruction_set_features_ = InstructionSetFeatures::FromVariant(
646 instruction_set_, str.as_string(), &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100647 if (instruction_set_features_.get() == nullptr) {
648 Usage("%s", parser_options->error_msg.c_str());
649 }
650 }
651
652 void ParseInstructionSetFeatures(const StringPiece& option, ParserOptions* parser_options) {
653 DCHECK(option.starts_with("--instruction-set-features="));
654 StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800655 if (instruction_set_features_ == nullptr) {
656 instruction_set_features_ = InstructionSetFeatures::FromVariant(
657 instruction_set_, "default", &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100658 if (instruction_set_features_.get() == nullptr) {
659 Usage("Problem initializing default instruction set features variant: %s",
660 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700661 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800662 }
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800663 instruction_set_features_ =
Roland Levillain9ec5e222015-08-17 20:18:41 +0100664 instruction_set_features_->AddFeaturesFromString(str.as_string(),
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800665 &parser_options->error_msg);
666 if (instruction_set_features_ == nullptr) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100667 Usage("Error parsing '%s': %s", option.data(), parser_options->error_msg.c_str());
668 }
669 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800670
Roland Levillain9ec5e222015-08-17 20:18:41 +0100671 void ParseCompilerBackend(const StringPiece& option, ParserOptions* parser_options) {
672 DCHECK(option.starts_with("--compiler-backend="));
673 parser_options->requested_specific_compiler = true;
674 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
675 if (backend_str == "Quick") {
676 compiler_kind_ = Compiler::kQuick;
677 } else if (backend_str == "Optimizing") {
678 compiler_kind_ = Compiler::kOptimizing;
679 } else {
680 Usage("Unknown compiler backend: %s", backend_str.data());
681 }
682 }
683
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800684 void ParseImageFormat(const StringPiece& option) {
685 const StringPiece substr("--image-format=");
686 DCHECK(option.starts_with(substr));
687 const StringPiece format_str = option.substr(substr.length());
688 if (format_str == "lz4") {
689 image_storage_mode_ = ImageHeader::kStorageModeLZ4;
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800690 } else if (format_str == "lz4hc") {
691 image_storage_mode_ = ImageHeader::kStorageModeLZ4HC;
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800692 } else if (format_str == "uncompressed") {
693 image_storage_mode_ = ImageHeader::kStorageModeUncompressed;
694 } else {
695 Usage("Unknown image format: %s", format_str.data());
696 }
697 }
698
Jeff Hao436183f2016-01-12 16:36:50 -0800699 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoaad75c62016-10-03 08:46:48 +0000700 compiler_options_->boot_image_ = !image_filenames_.empty();
701 compiler_options_->app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700702
703 if (IsAppImage() && IsBootImage()) {
704 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
705 }
706
Jeff Haodcdc85b2015-12-04 14:06:18 -0800707 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800708 Usage("Output must be supplied with either --oat-file or --oat-fd");
709 }
710
Jeff Haodcdc85b2015-12-04 14:06:18 -0800711 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800712 Usage("--oat-file should not be used with --oat-fd");
713 }
714
Nicolas Geoffraybc654d02016-11-07 16:23:11 +0000715 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +0100716 Usage("VDEX and OAT output must be specified either with one --oat-filename "
Nicolas Geoffraybc654d02016-11-07 16:23:11 +0000717 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100718 }
719
Roland Levillain9ec5e222015-08-17 20:18:41 +0100720 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800721 Usage("--oat-symbols should not be used with --oat-fd");
722 }
723
Roland Levillain9ec5e222015-08-17 20:18:41 +0100724 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800725 Usage("--oat-symbols should not be used with --host");
726 }
727
Nicolas Geoffraybc654d02016-11-07 16:23:11 +0000728 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
729 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100730 }
731
Jeff Haodcdc85b2015-12-04 14:06:18 -0800732 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800733 Usage("--oat-fd should not be used with --image");
734 }
735
Jeff Haodcdc85b2015-12-04 14:06:18 -0800736 if (!parser_options->oat_symbols.empty() &&
737 parser_options->oat_symbols.size() != oat_filenames_.size()) {
738 Usage("--oat-file arguments do not match --oat-symbols arguments");
739 }
740
741 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
742 Usage("--oat-file arguments do not match --image arguments");
743 }
744
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800745 if (android_root_.empty()) {
746 const char* android_root_env_var = getenv("ANDROID_ROOT");
747 if (android_root_env_var == nullptr) {
748 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700749 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800750 android_root_ += android_root_env_var;
751 }
752
Vladimir Markoaad75c62016-10-03 08:46:48 +0000753 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100754 parser_options->boot_image_filename += android_root_;
755 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800756 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100757 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000758 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800759 }
760
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700761 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800762 Usage("--image-classes should only be used with --image");
763 }
764
Vladimir Marko49b0f452015-12-10 13:49:19 +0000765 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800766 Usage("--image-classes should not be used with --boot-image");
767 }
768
769 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
770 Usage("--image-classes-zip should be used with --image-classes");
771 }
772
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700773 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800774 Usage("--compiled-classes should only be used with --image");
775 }
776
Vladimir Marko49b0f452015-12-10 13:49:19 +0000777 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800778 Usage("--compiled-classes should not be used with --boot-image");
779 }
780
781 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
782 Usage("--compiled-classes-zip should be used with --compiled-classes");
783 }
784
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800785 if (dex_filenames_.empty() && zip_fd_ == -1) {
786 Usage("Input must be supplied with either --dex-file or --zip-fd");
787 }
788
789 if (!dex_filenames_.empty() && zip_fd_ != -1) {
790 Usage("--dex-file should not be used with --zip-fd");
791 }
792
793 if (!dex_filenames_.empty() && !zip_location_.empty()) {
794 Usage("--dex-file should not be used with --zip-location");
795 }
796
797 if (dex_locations_.empty()) {
798 for (const char* dex_file_name : dex_filenames_) {
799 dex_locations_.push_back(dex_file_name);
800 }
801 } else if (dex_locations_.size() != dex_filenames_.size()) {
802 Usage("--dex-location arguments do not match --dex-file arguments");
803 }
804
Jeff Haodcdc85b2015-12-04 14:06:18 -0800805 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
806 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
807 Usage("--oat-file arguments must be singular or match --dex-file arguments");
808 }
809 }
810
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800811 if (zip_fd_ != -1 && zip_location_.empty()) {
812 Usage("--zip-location should be supplied with --zip-fd");
813 }
814
Vladimir Marko49b0f452015-12-10 13:49:19 +0000815 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800816 if (image_base_ == 0) {
817 Usage("Non-zero --base not specified");
818 }
819 }
820
Mathieu Chartiera8077802016-03-16 19:08:31 -0700821 const bool have_profile_file = !profile_file_.empty();
822 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
823 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000824 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200825 }
826
Roland Levillain9ec5e222015-08-17 20:18:41 +0100827 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800828 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800829 }
830
831 // If no instruction set feature was given, use the default one for the target
832 // instruction set.
833 if (instruction_set_features_.get() == nullptr) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800834 instruction_set_features_ = InstructionSetFeatures::FromVariant(
835 instruction_set_, "default", &parser_options->error_msg);
Ian Rogersd582fa42014-11-05 23:46:43 -0800836 if (instruction_set_features_.get() == nullptr) {
837 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100838 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800839 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800840 }
841
842 if (instruction_set_ == kRuntimeISA) {
843 std::unique_ptr<const InstructionSetFeatures> runtime_features(
844 InstructionSetFeatures::FromCppDefines());
845 if (!instruction_set_features_->Equals(runtime_features.get())) {
846 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
847 << *instruction_set_features_ << ") and those of dex2oat executable ("
848 << *runtime_features <<") for the command line:\n"
849 << CommandLine();
850 }
851 }
852
Roland Levillaina215b952015-08-07 11:38:32 +0100853 // It they are not set, use default values for inlining settings.
854 // TODO: We should rethink the compiler filter. We mostly save
855 // time here, which is orthogonal to space.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000856 if (compiler_options_->inline_depth_limit_ == CompilerOptions::kUnsetInlineDepthLimit) {
857 compiler_options_->inline_depth_limit_ =
Andreas Gampe29d38e72016-03-23 15:31:51 +0000858 (compiler_options_->compiler_filter_ == CompilerFilter::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100859 // Implementation of the space filter: limit inlining depth.
860 ? CompilerOptions::kSpaceFilterInlineDepthLimit
861 : CompilerOptions::kDefaultInlineDepthLimit;
862 }
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000863 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
864 compiler_options_->inline_max_code_units_ =
Andreas Gampe29d38e72016-03-23 15:31:51 +0000865 (compiler_options_->compiler_filter_ == CompilerFilter::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100866 // Implementation of the space filter: limit inlining max code units.
867 ? CompilerOptions::kSpaceFilterInlineMaxCodeUnits
868 : CompilerOptions::kDefaultInlineMaxCodeUnits;
869 }
870
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800871 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800872 // Set the compilation target's implicit checks options.
873 switch (instruction_set_) {
874 case kArm:
875 case kThumb2:
876 case kArm64:
877 case kX86:
878 case kX86_64:
Douglas Leung22bb5a22015-07-02 16:42:08 -0700879 case kMips:
880 case kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000881 compiler_options_->implicit_null_checks_ = true;
882 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800883 break;
884
885 default:
886 // Defaults are correct.
887 break;
888 }
889
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000890 compiler_options_->verbose_methods_ = verbose_methods_.empty() ? nullptr : &verbose_methods_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800891
Jeff Hao436183f2016-01-12 16:36:50 -0800892 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800893 Usage("--multi-image can only be used when creating boot images");
894 }
Jeff Hao436183f2016-01-12 16:36:50 -0800895 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800896 Usage("--multi-image cannot be used with multiple image names");
897 }
898
899 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
900 if (!kIsTargetBuild && IsBootImage()) {
901 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800902 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800903 }
904 }
905
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800906 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100907 if (parser_options->watch_dog_enabled) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800908 watchdog_.reset(new WatchDog(true));
909 }
910
911 // Fill some values into the key-value store for the oat header.
912 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800913
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800914 // Automatically force determinism for the boot image in a host build if the default GC is CMS
915 // or MS and read barriers are not enabled, as the former switches the GC to a non-concurrent
916 // one by passing the option `-Xgc:nonconcurrent` (see below).
917 if (!kIsTargetBuild && IsBootImage()) {
918 if (SupportsDeterministicCompilation()) {
919 force_determinism_ = true;
920 } else {
921 LOG(WARNING) << "Deterministic compilation is disabled.";
922 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800923 }
924 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700925
926 if (passes_to_run_filename_ != nullptr) {
927 passes_to_run_.reset(ReadCommentedInputFromFile<std::vector<std::string>>(
928 passes_to_run_filename_,
929 nullptr)); // No post-processing.
930 if (passes_to_run_.get() == nullptr) {
931 Usage("Failed to read list of passes to run.");
932 }
933 }
934 compiler_options_->passes_to_run_ = passes_to_run_.get();
Roland Levillain9ec5e222015-08-17 20:18:41 +0100935 }
936
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800937 static bool SupportsDeterministicCompilation() {
938 return (gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
939 gc::kCollectorTypeDefault == gc::kCollectorTypeMS) &&
940 !kEmitCompilerReadBarrier;
941 }
942
Jeff Hao436183f2016-01-12 16:36:50 -0800943 void ExpandOatAndImageFilenames() {
944 std::string base_oat = oat_filenames_[0];
945 size_t last_oat_slash = base_oat.rfind('/');
946 if (last_oat_slash == std::string::npos) {
947 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
948 }
949 // We also need to honor path components that were encoded through '@'. Otherwise the loading
950 // code won't be able to find the images.
951 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
952 last_oat_slash = base_oat.rfind('@');
953 }
954 base_oat = base_oat.substr(0, last_oat_slash + 1);
955
956 std::string base_img = image_filenames_[0];
957 size_t last_img_slash = base_img.rfind('/');
958 if (last_img_slash == std::string::npos) {
959 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
960 }
961 // We also need to honor path components that were encoded through '@'. Otherwise the loading
962 // code won't be able to find the images.
963 if (base_img.find('@', last_img_slash) != std::string::npos) {
964 last_img_slash = base_img.rfind('@');
965 }
966
967 // Get the prefix, which is the primary image name (without path components). Strip the
968 // extension.
969 std::string prefix = base_img.substr(last_img_slash + 1);
970 if (prefix.rfind('.') != std::string::npos) {
971 prefix = prefix.substr(0, prefix.rfind('.'));
972 }
973 if (!prefix.empty()) {
974 prefix = prefix + "-";
975 }
976
977 base_img = base_img.substr(0, last_img_slash + 1);
978
979 // Note: we have some special case here for our testing. We have to inject the differentiating
980 // parts for the different core images.
981 std::string infix; // Empty infix by default.
982 {
983 // Check the first name.
984 std::string dex_file = oat_filenames_[0];
985 size_t last_dex_slash = dex_file.rfind('/');
986 if (last_dex_slash != std::string::npos) {
987 dex_file = dex_file.substr(last_dex_slash + 1);
988 }
989 size_t last_dex_dot = dex_file.rfind('.');
990 if (last_dex_dot != std::string::npos) {
991 dex_file = dex_file.substr(0, last_dex_dot);
992 }
993 if (StartsWith(dex_file, "core-")) {
994 infix = dex_file.substr(strlen("core"));
995 }
996 }
997
bowen_lai8bd36c02016-10-12 13:28:55 +0800998 std::string base_symbol_oat;
999 if (!oat_unstripped_.empty()) {
1000 base_symbol_oat = oat_unstripped_[0];
1001 size_t last_symbol_oat_slash = base_symbol_oat.rfind('/');
1002 if (last_symbol_oat_slash == std::string::npos) {
1003 Usage("--multi-image used with unusable symbol filename %s", base_symbol_oat.c_str());
1004 }
1005 base_symbol_oat = base_symbol_oat.substr(0, last_symbol_oat_slash + 1);
1006 }
1007
1008 const size_t num_expanded_files = 2 + (base_symbol_oat.empty() ? 0 : 1);
1009 char_backing_storage_.reserve((dex_locations_.size() - 1) * num_expanded_files);
Ben Gruvera0fc3262016-09-30 13:10:42 -07001010
Jeff Hao436183f2016-01-12 16:36:50 -08001011 // Now create the other names. Use a counted loop to skip the first one.
1012 for (size_t i = 1; i < dex_locations_.size(); ++i) {
1013 // TODO: Make everything properly std::string.
1014 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
1015 char_backing_storage_.push_back(base_img + image_name);
1016 image_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
1017
1018 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
1019 char_backing_storage_.push_back(base_oat + oat_name);
1020 oat_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001021
1022 if (!base_symbol_oat.empty()) {
1023 char_backing_storage_.push_back(base_symbol_oat + oat_name);
1024 oat_unstripped_.push_back((char_backing_storage_.end() - 1)->c_str());
1025 }
Jeff Hao436183f2016-01-12 16:36:50 -08001026 }
1027 }
1028
Andreas Gampe8994a042015-12-30 19:03:17 +00001029 // Modify the input string in the following way:
1030 // 0) Assume input is /a/b/c.d
1031 // 1) Strip the path -> c.d
1032 // 2) Inject prefix p -> pc.d
1033 // 3) Inject infix i -> pci.d
1034 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -08001035 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +00001036 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001037 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +00001038 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001039 size_t last_dex_slash = in.rfind('/');
1040 if (last_dex_slash != std::string::npos) {
1041 in = in.substr(last_dex_slash + 1);
1042 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001043 if (!prefix.empty()) {
1044 in = prefix + in;
1045 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001046 if (!infix.empty()) {
1047 // Inject infix.
1048 size_t last_dot = in.rfind('.');
1049 if (last_dot != std::string::npos) {
1050 in.insert(last_dot, infix);
1051 }
1052 }
1053 if (EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001054 in = in.substr(0, in.length() - strlen(".jar")) +
1055 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001056 }
1057 return in;
1058 }
1059
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001060 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001061 std::ostringstream oss;
1062 for (int i = 0; i < argc; ++i) {
1063 if (i > 0) {
1064 oss << ' ';
1065 }
1066 oss << argv[i];
1067 }
1068 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1069 oss.str(""); // Reset.
1070 oss << kRuntimeISA;
1071 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1072 key_value_store_->Put(
1073 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001074 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001075 key_value_store_->Put(
1076 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001077 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001078 key_value_store_->Put(
1079 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001080 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001081 key_value_store_->Put(OatHeader::kCompilerFilter,
1082 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Richard Uhlerd1537b52016-03-29 13:27:41 -07001083 key_value_store_->Put(OatHeader::kHasPatchInfoKey,
1084 compiler_options_->GetIncludePatchInformation() ? OatHeader::kTrueValue
1085 : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001086 }
1087
1088 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1089 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1090 // returns, arguments have been successfully parsed.
1091 void ParseArgs(int argc, char** argv) {
1092 original_argc = argc;
1093 original_argv = argv;
1094
David Sehrf57589f2016-10-17 10:09:33 -07001095 InitLogging(argv, Runtime::Aborter);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001096
1097 // Skip over argv[0].
1098 argv++;
1099 argc--;
1100
1101 if (argc == 0) {
1102 Usage("No arguments specified");
1103 }
1104
1105 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001106 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001107
1108 for (int i = 0; i < argc; i++) {
1109 const StringPiece option(argv[i]);
1110 const bool log_options = false;
1111 if (log_options) {
1112 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1113 }
1114 if (option.starts_with("--dex-file=")) {
1115 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data());
1116 } else if (option.starts_with("--dex-location=")) {
1117 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data());
1118 } else if (option.starts_with("--zip-fd=")) {
1119 ParseZipFd(option);
1120 } else if (option.starts_with("--zip-location=")) {
1121 zip_location_ = option.substr(strlen("--zip-location=")).data();
Nicolas Geoffraybc654d02016-11-07 16:23:11 +00001122 } else if (option.starts_with("--input-vdex-fd=")) {
1123 ParseInputVdexFd(option);
1124 } else if (option.starts_with("--output-vdex-fd=")) {
1125 ParseOutputVdexFd(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001126 } else if (option.starts_with("--oat-file=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001127 oat_filenames_.push_back(option.substr(strlen("--oat-file=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001128 } else if (option.starts_with("--oat-symbols=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001129 parser_options->oat_symbols.push_back(option.substr(strlen("--oat-symbols=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001130 } else if (option.starts_with("--oat-fd=")) {
1131 ParseOatFd(option);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001132 } else if (option.starts_with("--oat-location=")) {
1133 oat_location_ = option.substr(strlen("--oat-location=")).data();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001134 } else if (option == "--watch-dog") {
1135 parser_options->watch_dog_enabled = true;
1136 } else if (option == "--no-watch-dog") {
1137 parser_options->watch_dog_enabled = false;
1138 } else if (option.starts_with("-j")) {
1139 ParseJ(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001140 } else if (option.starts_with("--image=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001141 image_filenames_.push_back(option.substr(strlen("--image=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001142 } else if (option.starts_with("--image-classes=")) {
1143 image_classes_filename_ = option.substr(strlen("--image-classes=")).data();
1144 } else if (option.starts_with("--image-classes-zip=")) {
1145 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data();
Mathieu Chartierceb07b32015-12-10 09:33:21 -08001146 } else if (option.starts_with("--image-format=")) {
1147 ParseImageFormat(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001148 } else if (option.starts_with("--compiled-classes=")) {
1149 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data();
1150 } else if (option.starts_with("--compiled-classes-zip=")) {
1151 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data();
1152 } else if (option.starts_with("--compiled-methods=")) {
1153 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data();
1154 } else if (option.starts_with("--compiled-methods-zip=")) {
1155 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data();
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07001156 } else if (option.starts_with("--run-passes=")) {
1157 passes_to_run_filename_ = option.substr(strlen("--run-passes=")).data();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001158 } else if (option.starts_with("--base=")) {
1159 ParseBase(option);
1160 } else if (option.starts_with("--boot-image=")) {
1161 parser_options->boot_image_filename = option.substr(strlen("--boot-image=")).data();
1162 } else if (option.starts_with("--android-root=")) {
1163 android_root_ = option.substr(strlen("--android-root=")).data();
1164 } else if (option.starts_with("--instruction-set=")) {
1165 ParseInstructionSet(option);
1166 } else if (option.starts_with("--instruction-set-variant=")) {
1167 ParseInstructionSetVariant(option, parser_options.get());
1168 } else if (option.starts_with("--instruction-set-features=")) {
1169 ParseInstructionSetFeatures(option, parser_options.get());
1170 } else if (option.starts_with("--compiler-backend=")) {
1171 ParseCompilerBackend(option, parser_options.get());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001172 } else if (option.starts_with("--profile-file=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001173 profile_file_ = option.substr(strlen("--profile-file=")).ToString();
Calin Juravle877fd962016-01-05 14:29:29 +00001174 } else if (option.starts_with("--profile-file-fd=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001175 ParseUintOption(option, "--profile-file-fd", &profile_file_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001176 } else if (option == "--host") {
1177 is_host_ = true;
1178 } else if (option == "--runtime-arg") {
1179 if (++i >= argc) {
1180 Usage("Missing required argument for --runtime-arg");
1181 }
1182 if (log_options) {
1183 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1184 }
1185 runtime_args_.push_back(argv[i]);
1186 } else if (option == "--dump-timing") {
1187 dump_timing_ = true;
1188 } else if (option == "--dump-passes") {
1189 dump_passes_ = true;
Roland Levillain9ec5e222015-08-17 20:18:41 +01001190 } else if (option == "--dump-stats") {
1191 dump_stats_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001192 } else if (option.starts_with("--swap-file=")) {
1193 swap_file_name_ = option.substr(strlen("--swap-file=")).data();
1194 } else if (option.starts_with("--swap-fd=")) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001195 ParseUintOption(option, "--swap-fd", &swap_fd_, Usage);
Andreas Gampee1459ae2016-06-29 09:36:30 -07001196 } else if (option.starts_with("--swap-dex-size-threshold=")) {
1197 ParseUintOption(option,
1198 "--swap-dex-size-threshold",
1199 &min_dex_file_cumulative_size_for_swap_,
1200 Usage);
1201 } else if (option.starts_with("--swap-dex-count-threshold=")) {
1202 ParseUintOption(option,
1203 "--swap-dex-count-threshold",
1204 &min_dex_files_for_swap_,
1205 Usage);
Andreas Gampe67f02822016-06-24 21:05:23 -07001206 } else if (option.starts_with("--very-large-app-threshold=")) {
1207 ParseUintOption(option,
1208 "--very-large-app-threshold",
1209 &very_large_threshold_,
1210 Usage);
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001211 } else if (option.starts_with("--app-image-file=")) {
1212 app_image_file_name_ = option.substr(strlen("--app-image-file=")).data();
1213 } else if (option.starts_with("--app-image-fd=")) {
1214 ParseUintOption(option, "--app-image-fd", &app_image_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001215 } else if (option.starts_with("--verbose-methods=")) {
1216 // TODO: rather than switch off compiler logging, make all VLOG(compiler) messages
1217 // conditional on having verbost methods.
1218 gLogVerbosity.compiler = false;
1219 Split(option.substr(strlen("--verbose-methods=")).ToString(), ',', &verbose_methods_);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001220 } else if (option == "--multi-image") {
Jeff Hao436183f2016-01-12 16:36:50 -08001221 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001222 } else if (option.starts_with("--no-inline-from=")) {
1223 no_inline_from_string_ = option.substr(strlen("--no-inline-from=")).data();
Andreas Gampeace0dc12016-01-20 13:33:13 -08001224 } else if (option == "--force-determinism") {
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001225 if (!SupportsDeterministicCompilation()) {
1226 Usage("Cannot use --force-determinism with read barriers or non-CMS garbage collector");
Roland Levillaineb2c7412016-01-28 14:37:01 +00001227 }
Andreas Gampeace0dc12016-01-20 13:33:13 -08001228 force_determinism_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001229 } else if (!compiler_options_->ParseCompilerOption(option, Usage)) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001230 Usage("Unknown argument %s", option.data());
1231 }
1232 }
1233
Jeff Hao436183f2016-01-12 16:36:50 -08001234 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001235
1236 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001237 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001238 }
1239
Jeff Haodcdc85b2015-12-04 14:06:18 -08001240 // Check whether the oat output files are writable, and open them for later. Also open a swap
1241 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001242 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001243 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1244 PruneNonExistentDexFiles();
1245
Jeff Hao436183f2016-01-12 16:36:50 -08001246 // Expand oat and image filenames for multi image.
1247 if (IsBootImage() && multi_image_) {
1248 ExpandOatAndImageFilenames();
1249 }
1250
David Brazdil7b49e6c2016-09-01 11:06:18 +01001251 // OAT and VDEX file handling
1252
1253 if (oat_fd_ == -1) {
1254 DCHECK(!oat_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08001255 for (const char* oat_filename : oat_filenames_) {
1256 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
1257 if (oat_file.get() == nullptr) {
1258 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1259 return false;
1260 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001261 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001262 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1263 oat_file->Erase();
1264 return false;
1265 }
1266 oat_files_.push_back(std::move(oat_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001267
Nicolas Geoffraybc654d02016-11-07 16:23:11 +00001268 DCHECK_EQ(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001269 std::string vdex_filename = ReplaceFileExtension(oat_filename, "vdex");
1270 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
1271 if (vdex_file.get() == nullptr) {
1272 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1273 return false;
1274 }
1275 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1276 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1277 vdex_file->Erase();
1278 return false;
1279 }
1280 vdex_files_.push_back(std::move(vdex_file));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001281 }
1282 } else {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001283 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, /* check_usage */ true));
Jeff Haodcdc85b2015-12-04 14:06:18 -08001284 if (oat_file.get() == nullptr) {
1285 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1286 return false;
1287 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001288 oat_file->DisableAutoClose();
1289 if (oat_file->SetLength(0) != 0) {
1290 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1291 }
1292 oat_files_.push_back(std::move(oat_file));
1293
Nicolas Geoffraybc654d02016-11-07 16:23:11 +00001294 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001295 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Nicolas Geoffraybc654d02016-11-07 16:23:11 +00001296 std::unique_ptr<File> vdex_file(new File(output_vdex_fd_, vdex_location, /* check_usage */ true));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001297 if (vdex_file.get() == nullptr) {
1298 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001299 return false;
1300 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001301 vdex_file->DisableAutoClose();
1302 if (vdex_file->SetLength(0) != 0) {
1303 PLOG(WARNING) << "Truncating vdex file " << vdex_location << " failed.";
1304 }
1305 vdex_files_.push_back(std::move(vdex_file));
1306
Jeff Haodcdc85b2015-12-04 14:06:18 -08001307 oat_filenames_.push_back(oat_location_.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001308 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001309
David Brazdil7b49e6c2016-09-01 11:06:18 +01001310 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001311 //
1312 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1313 // that we can use for swap.
1314 //
1315 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1316 // will immediately unlink to satisfy the swap fd assumption.
1317 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1318 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1319 if (swap_file.get() == nullptr) {
1320 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1321 return false;
1322 }
1323 swap_fd_ = swap_file->Fd();
1324 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1325 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1326 // released immediately.
1327 unlink(swap_file_name_.c_str());
1328 }
Jeff Hao436183f2016-01-12 16:36:50 -08001329
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001330 return true;
1331 }
1332
David Brazdil7b49e6c2016-09-01 11:06:18 +01001333 void EraseOutputFiles() {
1334 for (auto& files : { &vdex_files_, &oat_files_ }) {
1335 for (size_t i = 0; i < files->size(); ++i) {
1336 if ((*files)[i].get() != nullptr) {
1337 (*files)[i]->Erase();
1338 (*files)[i].reset();
1339 }
1340 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001341 }
Andreas Gampea650e702014-12-03 14:28:02 -08001342 }
1343
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001344 void Shutdown() {
1345 ScopedObjectAccess soa(Thread::Current());
1346 for (jobject dex_cache : dex_caches_) {
1347 soa.Env()->DeleteLocalRef(dex_cache);
1348 }
1349 dex_caches_.clear();
1350 }
1351
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001352 void LoadClassProfileDescriptors() {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001353 if (profile_compilation_info_ != nullptr && IsAppImage()) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001354 Runtime* runtime = Runtime::Current();
1355 CHECK(runtime != nullptr);
1356 std::set<DexCacheResolvedClasses> resolved_classes(
1357 profile_compilation_info_->GetResolvedClasses());
Mathieu Chartier0b490842016-05-25 15:05:59 -07001358
1359 // Filter out class path classes since we don't want to include these in the image.
1360 std::unordered_set<std::string> dex_files_locations;
1361 for (const DexFile* dex_file : dex_files_) {
1362 dex_files_locations.insert(dex_file->GetLocation());
1363 }
1364 for (auto it = resolved_classes.begin(); it != resolved_classes.end(); ) {
1365 if (dex_files_locations.find(it->GetDexLocation()) == dex_files_locations.end()) {
1366 VLOG(compiler) << "Removed profile samples for non-app dex file " << it->GetDexLocation();
1367 it = resolved_classes.erase(it);
1368 } else {
1369 ++it;
1370 }
1371 }
1372
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001373 image_classes_.reset(new std::unordered_set<std::string>(
1374 runtime->GetClassLinker()->GetClassDescriptorsForProfileKeys(resolved_classes)));
1375 VLOG(compiler) << "Loaded " << image_classes_->size()
1376 << " image class descriptors from profile";
1377 if (VLOG_IS_ON(compiler)) {
1378 for (const std::string& s : *image_classes_) {
1379 LOG(INFO) << "Image class " << s;
1380 }
1381 }
1382 }
1383 }
1384
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001385 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1386 // boot class path.
1387 bool Setup() {
1388 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001389 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap.
Vladimir Marko49b0f452015-12-10 13:49:19 +00001390
1391 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods()) {
1392 return false;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001393 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001394
Vladimir Marko307dac92015-10-20 11:20:09 +01001395 verification_results_.reset(new VerificationResults(compiler_options_.get()));
Andreas Gampe4585f872015-03-27 23:45:15 -07001396 callbacks_.reset(new QuickCompilerCallbacks(
Vladimir Marko307dac92015-10-20 11:20:09 +01001397 verification_results_.get(),
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001398 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001399 CompilerCallbacks::CallbackMode::kCompileBootImage :
1400 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001401
Vladimir Marko49b0f452015-12-10 13:49:19 +00001402 RuntimeArgumentMap runtime_options;
1403 if (!PrepareRuntimeOptions(&runtime_options)) {
1404 return false;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001405 }
1406
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001407 CreateOatWriters();
1408 if (!AddDexFileSources()) {
1409 return false;
1410 }
1411
1412 if (IsBootImage() && image_filenames_.size() > 1) {
1413 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1414 // We need this for the multi-image case.
Mathieu Chartier866d8742016-09-21 15:24:18 -07001415 key_value_store_->Put(OatHeader::kBootClassPathKey,
1416 gc::space::ImageSpace::GetMultiImageBootClassPath(dex_locations_,
1417 oat_filenames_,
1418 image_filenames_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001419 }
1420
1421 if (!IsBootImage()) {
1422 // When compiling an app, create the runtime early to retrieve
1423 // the image location key needed for the oat header.
1424 if (!CreateRuntime(std::move(runtime_options))) {
1425 return false;
1426 }
1427
Andreas Gampe29d38e72016-03-23 15:31:51 +00001428 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001429 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1430 std::vector<gc::space::ImageSpace*> image_spaces =
1431 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Jeff Haob11ffb72016-04-07 15:40:54 -07001432 image_file_location_oat_checksum_ = OatFileAssistant::CalculateCombinedImageChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001433 image_file_location_oat_data_begin_ =
1434 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1435 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1436 // Store the boot image filename(s).
1437 std::vector<std::string> image_filenames;
1438 for (const gc::space::ImageSpace* image_space : image_spaces) {
1439 image_filenames.push_back(image_space->GetImageFilename());
1440 }
1441 std::string image_file_location = Join(image_filenames, ':');
1442 if (!image_file_location.empty()) {
1443 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1444 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001445 } else {
1446 image_file_location_oat_checksum_ = 0u;
1447 image_file_location_oat_data_begin_ = 0u;
1448 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001449 }
1450
1451 // Open dex files for class path.
1452 const std::vector<std::string> class_path_locations =
1453 GetClassPathLocations(runtime_->GetClassPathString());
Jeff Haofbeb1322016-04-26 14:27:31 -07001454 OpenClassPathFiles(class_path_locations,
1455 &class_path_files_,
1456 &opened_oat_files_,
1457 runtime_->GetInstructionSet());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001458
1459 // Store the classpath we have right now.
1460 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
Jeff Haof0192c82016-03-28 20:39:50 -07001461 std::string encoded_class_path;
1462 if (class_path_locations.size() == 1 &&
1463 class_path_locations[0] == OatFile::kSpecialSharedLibrary) {
1464 // When passing the special shared library as the classpath, it is the only path.
1465 encoded_class_path = OatFile::kSpecialSharedLibrary;
1466 } else {
1467 encoded_class_path = OatFile::EncodeDexFileDependencies(class_path_files);
1468 }
1469 key_value_store_->Put(OatHeader::kClassPathKey, encoded_class_path);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001470 }
1471
1472 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001473 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001474 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1475 rodata_.reserve(oat_writers_.size());
1476 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1477 rodata_.push_back(elf_writers_[i]->StartRoData());
1478 // Unzip or copy dex files straight to the oat file.
1479 std::unique_ptr<MemMap> opened_dex_files_map;
1480 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
David Brazdil7b49e6c2016-09-01 11:06:18 +01001481 if (!oat_writers_[i]->WriteAndOpenDexFiles(
1482 kIsVdexEnabled ? vdex_files_[i].get() : oat_files_[i].get(),
1483 rodata_.back(),
1484 instruction_set_,
1485 instruction_set_features_.get(),
1486 key_value_store_.get(),
1487 /* verify */ true,
1488 &opened_dex_files_map,
1489 &opened_dex_files)) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001490 return false;
1491 }
1492 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1493 if (opened_dex_files_map != nullptr) {
1494 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
1495 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001496 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001497 opened_dex_files_.push_back(std::move(dex_file));
1498 }
1499 } else {
1500 DCHECK(opened_dex_files.empty());
1501 }
1502 }
1503 }
1504
1505 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
Andreas Gampe7386da42016-06-08 18:18:47 -07001506
David Brazdilca3c8c32016-09-06 14:04:48 +01001507 if (!IsBootImage()) {
1508 // Collect verification dependencies when compiling an app.
1509 verifier_deps_.reset(new verifier::VerifierDeps(dex_files_));
1510 callbacks_->SetVerifierDeps(verifier_deps_.get());
1511 }
1512
Andreas Gampe7386da42016-06-08 18:18:47 -07001513 // We had to postpone the swap decision till now, as this is the point when we actually
1514 // know about the dex files we're going to use.
1515
1516 // Make sure that we didn't create the driver, yet.
1517 CHECK(driver_ == nullptr);
1518 // If we use a swap file, ensure we are above the threshold to make it necessary.
1519 if (swap_fd_ != -1) {
1520 if (!UseSwap(IsBootImage(), dex_files_)) {
1521 close(swap_fd_);
1522 swap_fd_ = -1;
1523 VLOG(compiler) << "Decided to run without swap.";
1524 } else {
1525 LOG(INFO) << "Large app, accepted running with swap.";
1526 }
1527 }
1528 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
1529
Andreas Gampe67f02822016-06-24 21:05:23 -07001530 // If we need to downgrade the compiler-filter for size reasons, do that check now.
1531 if (!IsBootImage() && IsVeryLarge(dex_files_)) {
1532 if (!CompilerFilter::IsAsGoodAs(CompilerFilter::kVerifyAtRuntime,
1533 compiler_options_->GetCompilerFilter())) {
1534 LOG(INFO) << "Very large app, downgrading to verify-at-runtime.";
1535 // Note: this change won't be reflected in the key-value store, as that had to be
1536 // finalized before loading the dex files. This setup is currently required
1537 // to get the size from the DexFile objects.
1538 // TODO: refactor. b/29790079
1539 compiler_options_->SetCompilerFilter(CompilerFilter::kVerifyAtRuntime);
1540 }
1541 }
1542
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001543 if (IsBootImage()) {
1544 // For boot image, pass opened dex files to the Runtime::Create().
1545 // Note: Runtime acquires ownership of these dex files.
1546 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001547 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001548 return false;
1549 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001550 }
1551
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001552 // If we're doing the image, override the compiler filter to force full compilation. Must be
1553 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1554 // compilation of class initializers.
1555 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001556 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001557 WellKnownClasses::Init(self->GetJniEnv());
1558
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001559 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001560 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001561 constexpr bool kSaveDexInput = false;
1562 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001563 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001564 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001565
1566 // Handle and ClassLoader creation needs to come after Runtime::Create.
1567 ScopedObjectAccess soa(self);
1568
1569 // Classpath: first the class-path given.
1570 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1571
1572 // Then the dex files we'll compile. Thus we'll resolve the class-path first.
1573 class_path_files.insert(class_path_files.end(), dex_files_.begin(), dex_files_.end());
1574
1575 class_loader_ = class_linker->CreatePathClassLoader(self, class_path_files);
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001576 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001577
1578 // Ensure opened dex files are writable for dex-to-dex transformations.
1579 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1580 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1581 PLOG(ERROR) << "Failed to make .dex files writeable.";
1582 return false;
Vladimir Marko919f5532016-01-20 19:13:01 +00001583 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001584 }
1585
1586 // Ensure that the dex caches stay live since we don't want class unloading
1587 // to occur during compilation.
1588 for (const auto& dex_file : dex_files_) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001589 ScopedObjectAccess soa(self);
1590 dex_caches_.push_back(soa.AddLocalReference<jobject>(
Mathieu Chartierf284d442016-06-02 11:48:30 -07001591 class_linker->RegisterDexFile(*dex_file,
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001592 soa.Decode<mirror::ClassLoader>(class_loader_).Ptr())));
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001593 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001594
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001595 return true;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001596 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001597
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001598 // If we need to keep the oat file open for the image writer.
1599 bool ShouldKeepOatFileOpen() const {
1600 return IsImage() && oat_fd_ != kInvalidFd;
1601 }
1602
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001603 // Create and invoke the compiler driver. This will compile all the dex files.
1604 void Compile() {
1605 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1606 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001607
Vladimir Marko47496c22016-01-27 16:15:08 +00001608 // Find the dex files we should not inline from.
1609
1610 std::vector<std::string> no_inline_filters;
1611 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001612
1613 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001614 const std::string core_oj = "core-oj";
1615 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1616 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001617 }
1618
Vladimir Marko47496c22016-01-27 16:15:08 +00001619 if (!no_inline_filters.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001620 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1621 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1622 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1623 &class_linker->GetBootClassPath(),
1624 &class_path_files,
1625 &dex_files_
1626 };
1627 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001628 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001629 for (const std::string& filter : no_inline_filters) {
1630 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
1631 // allows tests to specify <test-dexfile>:classes2.dex if needed but if the
1632 // base location passes the StartsWith() test, so do all extra locations.
1633 std::string dex_location = dex_file->GetLocation();
1634 if (filter.find('/') == std::string::npos) {
1635 // The filter does not contain the path. Remove the path from dex_location as well.
1636 size_t last_slash = dex_file->GetLocation().rfind('/');
1637 if (last_slash != std::string::npos) {
1638 dex_location = dex_location.substr(last_slash + 1);
1639 }
1640 }
1641
1642 if (StartsWith(dex_location, filter.c_str())) {
1643 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1644 no_inline_from_dex_files_.push_back(dex_file);
1645 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001646 }
1647 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001648 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001649 }
1650 if (!no_inline_from_dex_files_.empty()) {
1651 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001652 }
1653 }
1654
Vladimir Marko307dac92015-10-20 11:20:09 +01001655 driver_.reset(new CompilerDriver(compiler_options_.get(),
1656 verification_results_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001657 compiler_kind_,
1658 instruction_set_,
1659 instruction_set_features_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001660 image_classes_.release(),
1661 compiled_classes_.release(),
Wojciech Staszkiewicz62534792016-08-09 14:30:55 -07001662 compiled_methods_.release(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001663 thread_count_,
1664 dump_stats_,
1665 dump_passes_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001666 compiler_phases_timings_.get(),
1667 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001668 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001669 driver_->SetDexFilesForOatFile(dex_files_);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001670 driver_->CompileAll(class_loader_, dex_files_, timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001671 }
1672
Jeff Hao436183f2016-01-12 16:36:50 -08001673 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001674 // ensure the references between the two are correct.
1675 //
1676 // Currently we have a memory layout that looks something like this:
1677 //
1678 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001679 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001680 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001681 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001682 // +--------------+
1683 // | alloc spaces |
1684 // +--------------+
1685 //
Jeff Hao436183f2016-01-12 16:36:50 -08001686 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001687 //
Jeff Hao436183f2016-01-12 16:36:50 -08001688 // 1. The images are expected to be loaded at an absolute address and
1689 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001690 //
Jeff Hao436183f2016-01-12 16:36:50 -08001691 // 2. There are absolute pointers from Methods in the images to their
1692 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001693 //
Jeff Hao436183f2016-01-12 16:36:50 -08001694 // 3. There are absolute pointers from the code in the oat files to Methods
1695 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001696 //
Jeff Hao436183f2016-01-12 16:36:50 -08001697 // 4. There are absolute pointers from code in the oat files to other code
1698 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001699 //
1700 // To get this all correct, we go through several steps.
1701 //
Jeff Hao436183f2016-01-12 16:36:50 -08001702 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001703 // the oat data size and code size. During this stage, we also set
1704 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001705 //
Jeff Hao436183f2016-01-12 16:36:50 -08001706 // 2. We prepare offsets for the objects in the images and calculate
1707 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001708 //
Jeff Hao436183f2016-01-12 16:36:50 -08001709 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001710 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001711 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001712 // can prepare the ELF headers and we then know the ELF memory segment
1713 // layout and we can now resolve all references. The compiler provides
1714 // LinkerPatch information in each CompiledMethod and we resolve these,
1715 // using the layout information and image object locations provided by
1716 // image writer, as we're writing the method code.
1717 //
Jeff Hao436183f2016-01-12 16:36:50 -08001718 // 4. We create the image files. They need to know where the oat files
1719 // will be loaded after itself. Originally oat files were simply
1720 // memory mapped so we could predict where their contents were based
1721 // on the file size. Now that they are ELF files, we need to inspect
1722 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001723 // where the oat header is located within.
1724 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001725 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001726 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001727 // load the .so at the desired location at runtime by offsetting the
1728 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001729 // TODO: Do this in step 3. We already know the layout there.
1730 //
1731 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1732 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001733
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001734 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1735 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001736 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1737 // case (when the file will be explicitly erased).
David Brazdil7b49e6c2016-09-01 11:06:18 +01001738 bool WriteOutputFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001739 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1740
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001741 // Sync the data to the file, in case we did dex2dex transformations.
1742 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1743 if (!map->Sync()) {
1744 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1745 return false;
1746 }
1747 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001748
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001749 if (IsImage()) {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001750 if (IsAppImage() && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001751 gc::Heap* const heap = Runtime::Current()->GetHeap();
1752 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001753 image_base_ = std::max(image_base_, RoundUp(
1754 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1755 kPageSize));
1756 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001757 // The non moving space is right after the oat file. Put the preferred app image location
1758 // right after the non moving space so that we ideally get a continuous immune region for
1759 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001760 // Use the default non moving space capacity since dex2oat does not have a separate non-
1761 // moving space. This means the runtime's non moving space space size will be as large
1762 // as the growth limit for dex2oat, but smaller in the zygote.
1763 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001764 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001765 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1766 }
1767
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001768 image_writer_.reset(new ImageWriter(*driver_,
1769 image_base_,
1770 compiler_options_->GetCompilePic(),
1771 IsAppImage(),
1772 image_storage_mode_,
1773 oat_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00001774 dex_file_oat_index_map_));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001775
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001776 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001777 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1778 if (!image_writer_->PrepareImageAddressSpace()) {
1779 LOG(ERROR) << "Failed to prepare image address space.";
1780 return false;
1781 }
1782 }
1783
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001784 // Initialize the writers with the compiler driver, image writer, and their
1785 // dex files. The writers were created without those being there yet.
1786 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1787 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
1788 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1789 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
1790 }
1791
David Brazdil5d5a36b2016-09-14 15:34:10 +01001792 {
1793 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
1794 DCHECK(IsBootImage() || oat_files_.size() == 1u);
1795 DCHECK_EQ(IsBootImage(), verifier_deps_ == nullptr);
1796 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1797 File* vdex_file = vdex_files_[i].get();
1798 std::unique_ptr<BufferedOutputStream> vdex_out(
1799 MakeUnique<BufferedOutputStream>(MakeUnique<FileOutputStream>(vdex_file)));
1800
1801 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps_.get())) {
1802 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
1803 return false;
1804 }
1805
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001806 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
1807 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
1808 return false;
1809 }
1810
David Brazdil5d5a36b2016-09-14 15:34:10 +01001811 // VDEX finalized, seek back to the beginning and write the header.
1812 if (!oat_writers_[i]->WriteVdexHeader(vdex_out.get())) {
1813 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
1814 return false;
1815 }
1816 }
1817 }
1818
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001819 {
1820 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001821 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001822 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko944da602016-02-19 12:27:55 +00001823 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1824 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
1825
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001826 oat_writer->PrepareLayout(&patcher);
Vladimir Marko944da602016-02-19 12:27:55 +00001827
1828 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
David Brazdil7b49e6c2016-09-01 11:06:18 +01001829 size_t text_size = oat_writer->GetOatSize() - rodata_size;
Vladimir Markoaad75c62016-10-03 08:46:48 +00001830 elf_writer->PrepareDynamicSection(rodata_size,
1831 text_size,
1832 oat_writer->GetBssSize(),
1833 oat_writer->GetBssRootsOffset());
Vladimir Marko944da602016-02-19 12:27:55 +00001834
1835 if (IsImage()) {
1836 // Update oat layout.
1837 DCHECK(image_writer_ != nullptr);
1838 DCHECK_LT(i, oat_filenames_.size());
1839 image_writer_->UpdateOatFileLayout(i,
1840 elf_writer->GetLoadedSize(),
1841 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01001842 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00001843 }
1844 }
1845
1846 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001847 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001848 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1849 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00001850
David Srbecky09c2a6b2016-03-11 17:11:44 +00001851 oat_writer->AddMethodDebugInfos(debug::MakeTrampolineInfos(oat_writer->GetOatHeader()));
1852
David Srbecky0c4572e2016-01-22 19:19:25 +00001853 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00001854 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
1855 elf_writer->PrepareDebugInfo(oat_writer->GetMethodDebugInfo());
David Srbecky0c4572e2016-01-22 19:19:25 +00001856
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001857 OutputStream*& rodata = rodata_[i];
1858 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001859 if (!oat_writer->WriteRodata(rodata)) {
1860 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
1861 return false;
1862 }
1863 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001864 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00001865
Jeff Haodcdc85b2015-12-04 14:06:18 -08001866 OutputStream* text = elf_writer->StartText();
1867 if (!oat_writer->WriteCode(text)) {
1868 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
1869 return false;
1870 }
1871 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00001872
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001873 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
1874 image_file_location_oat_checksum_,
1875 image_file_location_oat_data_begin_,
1876 image_patch_delta_)) {
1877 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
1878 return false;
1879 }
1880
Vladimir Marko944da602016-02-19 12:27:55 +00001881 if (IsImage()) {
1882 // Update oat header information.
1883 DCHECK(image_writer_ != nullptr);
1884 DCHECK_LT(i, oat_filenames_.size());
1885 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
1886 }
1887
Jeff Haodcdc85b2015-12-04 14:06:18 -08001888 elf_writer->WriteDynamicSection();
1889 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
1890 elf_writer->WritePatchLocations(oat_writer->GetAbsolutePatchLocations());
Vladimir Marko10c13562015-11-25 14:33:36 +00001891
Jeff Haodcdc85b2015-12-04 14:06:18 -08001892 if (!elf_writer->End()) {
1893 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
1894 return false;
1895 }
1896
David Brazdil7b49e6c2016-09-01 11:06:18 +01001897 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
1898 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001899 }
1900
Jeff Haodcdc85b2015-12-04 14:06:18 -08001901 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001902
1903 oat_writer.reset();
1904 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001905 }
1906 }
1907
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001908 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001909 }
1910
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001911 // If we are compiling an image, invoke the image creation routine. Else just skip.
1912 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001913 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001914 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
1915 if (!CreateImageFile()) {
1916 return false;
1917 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001918 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07001919 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001920 return true;
1921 }
1922
Jeff Haodcdc85b2015-12-04 14:06:18 -08001923 // Create a copy from stripped to unstripped.
1924 bool CopyStrippedToUnstripped() {
1925 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
1926 // If we don't want to strip in place, copy from stripped location to unstripped location.
1927 // We need to strip after image creation because FixupElf needs to use .strtab.
1928 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
1929 // If the oat file is still open, flush it.
1930 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001931 if (!FlushCloseOutputFile(&oat_files_[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001932 return false;
1933 }
1934 }
1935
1936 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
1937 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
1938 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01001939 int64_t in_length = in->GetLength();
1940 if (in_length < 0) {
1941 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
1942 return false;
1943 }
1944 if (!out->Copy(in.get(), 0, in_length)) {
1945 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
1946 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001947 }
1948 if (out->FlushCloseOrErase() != 0) {
1949 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
1950 return false;
1951 }
1952 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
1953 }
1954 }
1955 return true;
1956 }
1957
David Brazdil7b49e6c2016-09-01 11:06:18 +01001958 bool FlushOutputFile(std::unique_ptr<File>* file) {
1959 if (file->get() != nullptr) {
1960 if (file->get()->Flush() != 0) {
1961 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
1962 return false;
1963 }
1964 }
1965 return true;
1966 }
1967
1968 bool FlushCloseOutputFile(std::unique_ptr<File>* file) {
1969 if (file->get() != nullptr) {
1970 std::unique_ptr<File> tmp(file->release());
1971 if (tmp->FlushCloseOrErase() != 0) {
1972 PLOG(ERROR) << "Failed to flush and close output file: " << tmp->GetPath();
1973 return false;
1974 }
1975 }
1976 return true;
1977 }
1978
1979 bool FlushOutputFiles() {
1980 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
1981 for (auto& files : { &vdex_files_, &oat_files_ }) {
1982 for (size_t i = 0; i < files->size(); ++i) {
1983 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08001984 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001985 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001986 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00001987 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08001988 return true;
1989 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001990
David Brazdil7b49e6c2016-09-01 11:06:18 +01001991 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001992 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01001993 for (auto& files : { &vdex_files_, &oat_files_ }) {
1994 for (size_t i = 0; i < files->size(); ++i) {
1995 result &= FlushCloseOutputFile(&(*files)[i]);
1996 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001997 }
1998 return result;
1999 }
2000
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002001 void DumpTiming() {
2002 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
2003 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2004 }
2005 if (dump_passes_) {
2006 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
2007 }
2008 }
2009
Andreas Gampe10e477d2014-11-19 12:57:42 -08002010 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002011 return IsAppImage() || IsBootImage();
2012 }
2013
2014 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002015 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002016 }
2017
2018 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002019 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002020 }
2021
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002022 bool IsHost() const {
2023 return is_host_;
2024 }
2025
Calin Juravle998c2162015-12-21 15:39:33 +02002026 bool UseProfileGuidedCompilation() const {
Andreas Gampe29d38e72016-03-23 15:31:51 +00002027 return CompilerFilter::DependsOnProfile(compiler_options_->GetCompilerFilter());
Calin Juravle998c2162015-12-21 15:39:33 +02002028 }
2029
Calin Juravle2e2db782016-02-23 12:00:03 +00002030 bool LoadProfile() {
Calin Juravle998c2162015-12-21 15:39:33 +02002031 DCHECK(UseProfileGuidedCompilation());
Calin Juravle2e2db782016-02-23 12:00:03 +00002032
2033 profile_compilation_info_.reset(new ProfileCompilationInfo());
2034 ScopedFlock flock;
Andreas Gampe29d38e72016-03-23 15:31:51 +00002035 bool success = true;
Calin Juravle2e2db782016-02-23 12:00:03 +00002036 std::string error;
2037 if (profile_file_fd_ != -1) {
2038 // The file doesn't need to be flushed so don't check the usage.
2039 // Pass a bogus path so that we can easily attribute any reported error.
2040 File file(profile_file_fd_, "profile", /*check_usage*/ false, /*read_only_mode*/ true);
2041 if (flock.Init(&file, &error)) {
2042 success = profile_compilation_info_->Load(profile_file_fd_);
2043 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00002044 } else if (profile_file_ != "") {
Calin Juravle2e2db782016-02-23 12:00:03 +00002045 if (flock.Init(profile_file_.c_str(), O_RDONLY, /* block */ true, &error)) {
2046 success = profile_compilation_info_->Load(flock.GetFile()->Fd());
2047 }
2048 }
2049 if (!error.empty()) {
2050 LOG(WARNING) << "Cannot lock profiles: " << error;
Calin Juravle998c2162015-12-21 15:39:33 +02002051 }
Calin Juravle877fd962016-01-05 14:29:29 +00002052
Calin Juravle2e2db782016-02-23 12:00:03 +00002053 if (!success) {
2054 profile_compilation_info_.reset(nullptr);
2055 }
Calin Juravle877fd962016-01-05 14:29:29 +00002056
Calin Juravle2e2db782016-02-23 12:00:03 +00002057 return success;
Calin Juravle998c2162015-12-21 15:39:33 +02002058 }
2059
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002060 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002061 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2062 if (is_image) {
2063 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2064 return false;
2065 }
2066 if (dex_files.size() < min_dex_files_for_swap_) {
2067 // If there are less dex files than the threshold, assume it's gonna be fine.
2068 return false;
2069 }
2070 size_t dex_files_size = 0;
2071 for (const auto* dex_file : dex_files) {
2072 dex_files_size += dex_file->GetHeader().file_size_;
2073 }
2074 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2075 }
2076
Andreas Gampe67f02822016-06-24 21:05:23 -07002077 bool IsVeryLarge(std::vector<const DexFile*>& dex_files) {
2078 size_t dex_files_size = 0;
2079 for (const auto* dex_file : dex_files) {
2080 dex_files_size += dex_file->GetHeader().file_size_;
2081 }
2082 return dex_files_size >= very_large_threshold_;
2083 }
2084
Vladimir Marko49b0f452015-12-10 13:49:19 +00002085 template <typename T>
2086 static std::vector<T*> MakeNonOwningPointerVector(const std::vector<std::unique_ptr<T>>& src) {
2087 std::vector<T*> result;
2088 result.reserve(src.size());
2089 for (const std::unique_ptr<T>& t : src) {
2090 result.push_back(t.get());
2091 }
2092 return result;
2093 }
2094
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002095 std::vector<std::string> GetClassPathLocations(const std::string& class_path) {
2096 // This function is used only for apps and for an app we have exactly one oat file.
2097 DCHECK(!IsBootImage());
2098 DCHECK_EQ(oat_writers_.size(), 1u);
2099 std::vector<std::string> dex_files_canonical_locations;
2100 for (const char* location : oat_writers_[0]->GetSourceLocations()) {
2101 dex_files_canonical_locations.push_back(DexFile::GetDexCanonicalLocation(location));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002102 }
Vladimir Marko625a64a2015-11-26 14:44:16 +00002103
Vladimir Marko919f5532016-01-20 19:13:01 +00002104 std::vector<std::string> parsed;
2105 Split(class_path, ':', &parsed);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002106 auto kept_it = std::remove_if(parsed.begin(),
2107 parsed.end(),
2108 [dex_files_canonical_locations](const std::string& location) {
2109 return ContainsElement(dex_files_canonical_locations,
2110 DexFile::GetDexCanonicalLocation(location.c_str()));
2111 });
2112 parsed.erase(kept_it, parsed.end());
2113 return parsed;
2114 }
2115
Jeff Haofbeb1322016-04-26 14:27:31 -07002116 // Opens requested class path files and appends them to opened_dex_files. If the dex files have
2117 // been stripped, this opens them from their oat files and appends them to opened_oat_files.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002118 static void OpenClassPathFiles(const std::vector<std::string>& class_path_locations,
Jeff Haof0192c82016-03-28 20:39:50 -07002119 std::vector<std::unique_ptr<const DexFile>>* opened_dex_files,
Jeff Haofbeb1322016-04-26 14:27:31 -07002120 std::vector<std::unique_ptr<OatFile>>* opened_oat_files,
Jeff Haof0192c82016-03-28 20:39:50 -07002121 InstructionSet isa) {
Jeff Haofbeb1322016-04-26 14:27:31 -07002122 DCHECK(opened_dex_files != nullptr) << "OpenClassPathFiles dex out-param is nullptr";
2123 DCHECK(opened_oat_files != nullptr) << "OpenClassPathFiles oat out-param is nullptr";
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002124 for (const std::string& location : class_path_locations) {
Jeff Haof0192c82016-03-28 20:39:50 -07002125 // Stop early if we detect the special shared library, which may be passed as the classpath
2126 // for dex2oat when we want to skip the shared libraries check.
2127 if (location == OatFile::kSpecialSharedLibrary) {
2128 break;
2129 }
Aart Bik37d6a3b2016-06-21 18:30:10 -07002130 static constexpr bool kVerifyChecksum = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002131 std::string error_msg;
Aart Bik37d6a3b2016-06-21 18:30:10 -07002132 if (!DexFile::Open(
2133 location.c_str(), location.c_str(), kVerifyChecksum, &error_msg, opened_dex_files)) {
Jeff Haof0192c82016-03-28 20:39:50 -07002134 // If we fail to open the dex file because it's been stripped, try to open the dex file
2135 // from its corresponding oat file.
Richard Uhlerd1472a22016-04-15 15:18:56 -07002136 OatFileAssistant oat_file_assistant(location.c_str(), isa, false);
Jeff Haof0192c82016-03-28 20:39:50 -07002137 std::unique_ptr<OatFile> oat_file(oat_file_assistant.GetBestOatFile());
2138 if (oat_file == nullptr) {
2139 LOG(WARNING) << "Failed to open dex file and associated oat file for '" << location
2140 << "': " << error_msg;
2141 } else {
2142 std::vector<std::unique_ptr<const DexFile>> oat_dex_files =
2143 oat_file_assistant.LoadDexFiles(*oat_file, location.c_str());
Jeff Haofbeb1322016-04-26 14:27:31 -07002144 opened_oat_files->push_back(std::move(oat_file));
Jeff Haof0192c82016-03-28 20:39:50 -07002145 opened_dex_files->insert(opened_dex_files->end(),
2146 std::make_move_iterator(oat_dex_files.begin()),
2147 std::make_move_iterator(oat_dex_files.end()));
2148 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002149 }
2150 }
2151 }
2152
Vladimir Marko49b0f452015-12-10 13:49:19 +00002153 bool PrepareImageClasses() {
2154 // If --image-classes was specified, calculate the full list of classes to include in the image.
2155 if (image_classes_filename_ != nullptr) {
2156 image_classes_ =
2157 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2158 if (image_classes_ == nullptr) {
2159 return false;
2160 }
2161 } else if (IsBootImage()) {
2162 image_classes_.reset(new std::unordered_set<std::string>);
2163 }
2164 return true;
2165 }
2166
2167 bool PrepareCompiledClasses() {
2168 // If --compiled-classes was specified, calculate the full list of classes to compile in the
2169 // image.
2170 if (compiled_classes_filename_ != nullptr) {
2171 compiled_classes_ =
2172 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
2173 if (compiled_classes_ == nullptr) {
2174 return false;
2175 }
2176 } else {
2177 compiled_classes_.reset(nullptr); // By default compile everything.
2178 }
2179 return true;
2180 }
2181
2182 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2183 const char* classes_filename,
2184 const char* tag) {
2185 std::unique_ptr<std::unordered_set<std::string>> classes;
2186 std::string error_msg;
2187 if (zip_filename != nullptr) {
2188 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2189 } else {
2190 classes.reset(ReadImageClassesFromFile(classes_filename));
2191 }
2192 if (classes == nullptr) {
2193 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2194 << classes_filename << "': " << error_msg;
2195 }
2196 return classes;
2197 }
2198
2199 bool PrepareCompiledMethods() {
2200 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2201 if (compiled_methods_filename_ != nullptr) {
2202 std::string error_msg;
2203 if (compiled_methods_zip_filename_ != nullptr) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002204 compiled_methods_.reset(ReadCommentedInputFromZip<std::unordered_set<std::string>>(
2205 compiled_methods_zip_filename_,
2206 compiled_methods_filename_,
2207 nullptr, // No post-processing.
2208 &error_msg));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002209 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002210 compiled_methods_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2211 compiled_methods_filename_,
2212 nullptr)); // No post-processing.
Vladimir Marko49b0f452015-12-10 13:49:19 +00002213 }
2214 if (compiled_methods_.get() == nullptr) {
2215 LOG(ERROR) << "Failed to create list of compiled methods from '"
2216 << compiled_methods_filename_ << "': " << error_msg;
2217 return false;
2218 }
2219 } else {
2220 compiled_methods_.reset(nullptr); // By default compile everything.
2221 }
2222 return true;
2223 }
2224
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002225 void PruneNonExistentDexFiles() {
2226 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2227 size_t kept = 0u;
2228 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2229 if (!OS::FileExists(dex_filenames_[i])) {
2230 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2231 } else {
2232 dex_filenames_[kept] = dex_filenames_[i];
2233 dex_locations_[kept] = dex_locations_[i];
2234 ++kept;
2235 }
2236 }
2237 dex_filenames_.resize(kept);
2238 dex_locations_.resize(kept);
2239 }
2240
2241 bool AddDexFileSources() {
2242 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
2243 if (zip_fd_ != -1) {
2244 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002245 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2246 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002247 return false;
2248 }
2249 } else if (oat_writers_.size() > 1u) {
2250 // Multi-image.
2251 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2252 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2253 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2254 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2255 return false;
2256 }
2257 }
2258 } else {
2259 DCHECK_EQ(oat_writers_.size(), 1u);
2260 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2261 DCHECK_NE(dex_filenames_.size(), 0u);
2262 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2263 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2264 return false;
2265 }
2266 }
2267 }
2268 return true;
2269 }
2270
2271 void CreateOatWriters() {
2272 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2273 elf_writers_.reserve(oat_files_.size());
2274 oat_writers_.reserve(oat_files_.size());
2275 for (const std::unique_ptr<File>& oat_file : oat_files_) {
David Srbecky5d811202016-03-08 13:21:22 +00002276 elf_writers_.emplace_back(CreateElfWriterQuick(instruction_set_,
2277 instruction_set_features_.get(),
2278 compiler_options_.get(),
2279 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002280 elf_writers_.back()->Start();
2281 oat_writers_.emplace_back(new OatWriter(IsBootImage(), timings_));
2282 }
2283 }
2284
Vladimir Marko49b0f452015-12-10 13:49:19 +00002285 void SaveDexInput() {
2286 for (size_t i = 0; i < dex_files_.size(); ++i) {
2287 const DexFile* dex_file = dex_files_[i];
2288 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2289 getpid(), i));
2290 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2291 if (tmp_file.get() == nullptr) {
2292 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2293 << ". Try: adb shell chmod 777 /data/local/tmp";
2294 continue;
2295 }
2296 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2297 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2298 UNUSED(tmp_file->Flush());
2299 UNUSED(tmp_file->Close());
2300 LOG(INFO) << "Wrote input to " << tmp_file_name;
2301 }
2302 }
2303
2304 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options) {
2305 RuntimeOptions raw_options;
2306 if (boot_image_filename_.empty()) {
2307 std::string boot_class_path = "-Xbootclasspath:";
2308 boot_class_path += Join(dex_filenames_, ':');
2309 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2310 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
2311 boot_class_path_locations += Join(dex_locations_, ':');
2312 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2313 } else {
2314 std::string boot_image_option = "-Ximage:";
2315 boot_image_option += boot_image_filename_;
2316 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2317 }
2318 for (size_t i = 0; i < runtime_args_.size(); i++) {
2319 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2320 }
2321
2322 raw_options.push_back(std::make_pair("compilercallbacks", callbacks_.get()));
2323 raw_options.push_back(
2324 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2325
2326 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2327 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2328 // have been stripped in preopting, anyways).
2329 if (!IsBootImage()) {
2330 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2331 }
2332 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2333 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2334 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002335 // Disable Hspace compaction to save heap size virtual space.
2336 // Only need disable Hspace for OOM becasue background collector is equal to
2337 // foreground collector by default for dex2oat.
2338 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002339
Andreas Gampeace0dc12016-01-20 13:33:13 -08002340 // If we're asked to be deterministic, ensure non-concurrent GC for determinism. Also
2341 // force the free-list implementation for large objects.
2342 if (compiler_options_->IsForceDeterminism()) {
2343 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
2344 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=freelist", nullptr));
2345
2346 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2347 // compaction (done above) and ensure that neither foreground nor background collectors
2348 // are concurrent.
2349 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2350
2351 // To make identity hashcode deterministic, set a known seed.
2352 mirror::Object::SetHashCodeSeed(987654321U);
2353 }
2354
Vladimir Marko49b0f452015-12-10 13:49:19 +00002355 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2356 LOG(ERROR) << "Failed to parse runtime options";
2357 return false;
2358 }
2359 return true;
2360 }
2361
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002362 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002363 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2364 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002365 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002366 LOG(ERROR) << "Failed to create runtime";
2367 return false;
2368 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002369 runtime_.reset(Runtime::Current());
2370 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002371 for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) {
2372 Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002373 if (!runtime_->HasCalleeSaveMethod(type)) {
2374 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002375 }
2376 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002377 runtime_->GetClassLinker()->FixupDexCaches(runtime_->GetResolutionMethod());
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002378
2379 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2380 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002381 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002382
Vladimir Marko307dac92015-10-20 11:20:09 +01002383 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002384
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002385 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2386 // Runtime::Start, give it away now so that we don't starve GC.
2387 Thread* self = Thread::Current();
2388 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002389
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002390 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002391 }
2392
Jeff Haodcdc85b2015-12-04 14:06:18 -08002393 // 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 -08002394 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002395 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002396 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002397 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002398 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002399 image_filenames_.push_back(app_image_file_name_.c_str());
2400 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002401 if (!image_writer_->Write(app_image_fd_,
2402 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002403 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002404 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002405 return false;
2406 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002407
Jeff Haodcdc85b2015-12-04 14:06:18 -08002408 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002409 dchecked_vector<uintptr_t> oat_data_begins;
2410 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2411 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002412 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002413 // Destroy ImageWriter before doing FixupElf.
2414 image_writer_.reset();
2415
Vladimir Marko944da602016-02-19 12:27:55 +00002416 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2417 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002418 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2419 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2420 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2421 if (oat_file.get() == nullptr) {
2422 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2423 return false;
2424 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002425
Vladimir Marko944da602016-02-19 12:27:55 +00002426 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002427 oat_file->Erase();
2428 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2429 return false;
2430 }
2431
2432 if (oat_file->FlushCloseOrErase()) {
2433 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2434 return false;
2435 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002436 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002437 }
2438
2439 return true;
2440 }
2441
2442 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002443 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2444 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002445 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002446 return ReadCommentedInputFromFile<std::unordered_set<std::string>>(image_classes_filename,
2447 &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002448 }
2449
2450 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002451 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002452 const char* zip_filename,
2453 const char* image_classes_filename,
2454 std::string* error_msg) {
2455 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002456 return ReadCommentedInputFromZip<std::unordered_set<std::string>>(zip_filename,
2457 image_classes_filename,
2458 &process,
2459 error_msg);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002460 }
2461
2462 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2463 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002464 template <typename T>
2465 static T* ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002466 const char* input_filename, std::function<std::string(const char*)>* process) {
2467 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2468 if (input_file.get() == nullptr) {
2469 LOG(ERROR) << "Failed to open input file " << input_filename;
2470 return nullptr;
2471 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002472 std::unique_ptr<T> result(
2473 ReadCommentedInputStream<T>(*input_file, process));
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002474 input_file->close();
2475 return result.release();
2476 }
2477
2478 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2479 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002480 template <typename T>
2481 static T* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002482 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002483 const char* input_filename,
2484 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002485 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002486 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2487 if (zip_archive.get() == nullptr) {
2488 return nullptr;
2489 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002490 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002491 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002492 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002493 zip_filename, error_msg->c_str());
2494 return nullptr;
2495 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002496 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2497 input_filename,
2498 error_msg));
2499 if (input_file.get() == nullptr) {
2500 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002501 zip_filename, error_msg->c_str());
2502 return nullptr;
2503 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002504 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2505 input_file->Size());
2506 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002507 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002508 }
2509
2510 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2511 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002512 template <typename T>
2513 static T* ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002514 std::istream& in_stream,
2515 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002516 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002517 while (in_stream.good()) {
2518 std::string dot;
2519 std::getline(in_stream, dot);
2520 if (StartsWith(dot, "#") || dot.empty()) {
2521 continue;
2522 }
2523 if (process != nullptr) {
2524 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002525 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002526 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002527 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002528 }
2529 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002530 return output.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002531 }
2532
Mathieu Chartier49285c52014-12-02 15:43:48 -08002533 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002534 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2535 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002536 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002537 LOG(INFO) << "dex2oat took " << PrettyDuration(NanoTime() - start_ns_)
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002538 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002539 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002540 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2541 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002542 }
2543
Jeff Haodcdc85b2015-12-04 14:06:18 -08002544 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2545 std::string res(image_filename);
2546 size_t last_slash = res.rfind('/');
2547 if (last_slash == std::string::npos || last_slash == 0) {
2548 return res;
2549 }
2550 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2551 if (penultimate_slash == std::string::npos) {
2552 return res;
2553 }
2554 // Check that the string in-between is the expected one.
2555 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2556 GetInstructionSetString(isa)) {
2557 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2558 return res;
2559 }
2560 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2561 }
2562
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002563 std::unique_ptr<CompilerOptions> compiler_options_;
2564 Compiler::Kind compiler_kind_;
2565
2566 InstructionSet instruction_set_;
2567 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2568
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002569 uint32_t image_file_location_oat_checksum_;
2570 uintptr_t image_file_location_oat_data_begin_;
2571 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002572 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2573
Vladimir Marko307dac92015-10-20 11:20:09 +01002574 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002575
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002576 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2577
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002578 std::unique_ptr<Runtime> runtime_;
2579
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002580 // Ownership for the class path files.
2581 std::vector<std::unique_ptr<const DexFile>> class_path_files_;
2582
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002583 size_t thread_count_;
2584 uint64_t start_ns_;
2585 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002586 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002587 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002588 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002589 std::vector<const char*> oat_filenames_;
2590 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002591 int oat_fd_;
Nicolas Geoffraybc654d02016-11-07 16:23:11 +00002592 int input_vdex_fd_;
2593 int output_vdex_fd_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002594 std::vector<const char*> dex_filenames_;
2595 std::vector<const char*> dex_locations_;
2596 int zip_fd_;
2597 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002598 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002599 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002600 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002601 uintptr_t image_base_;
2602 const char* image_classes_zip_filename_;
2603 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002604 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002605 const char* compiled_classes_zip_filename_;
2606 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002607 const char* compiled_methods_zip_filename_;
2608 const char* compiled_methods_filename_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002609 const char* passes_to_run_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002610 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2611 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002612 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002613 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Jeff Hao436183f2016-01-12 16:36:50 -08002614 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002615 bool is_host_;
2616 std::string android_root_;
Mathieu Chartier0b490842016-05-25 15:05:59 -07002617 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002618 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002619 std::string no_inline_from_string_;
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002620 std::vector<jobject> dex_caches_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002621 jobject class_loader_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002622
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002623 std::vector<std::unique_ptr<ElfWriter>> elf_writers_;
2624 std::vector<std::unique_ptr<OatWriter>> oat_writers_;
2625 std::vector<OutputStream*> rodata_;
David Brazdil5d5a36b2016-09-14 15:34:10 +01002626 std::vector<std::unique_ptr<OutputStream>> vdex_out_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002627 std::unique_ptr<ImageWriter> image_writer_;
2628 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002629
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002630 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
Jeff Haofbeb1322016-04-26 14:27:31 -07002631 std::vector<std::unique_ptr<OatFile>> opened_oat_files_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002632 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2633
Vladimir Marko47496c22016-01-27 16:15:08 +00002634 std::vector<const DexFile*> no_inline_from_dex_files_;
2635
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002636 std::vector<std::string> verbose_methods_;
2637 bool dump_stats_;
2638 bool dump_passes_;
2639 bool dump_timing_;
2640 bool dump_slow_timing_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002641 std::string swap_file_name_;
2642 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002643 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2644 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002645 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002646 std::string app_image_file_name_;
2647 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002648 std::string profile_file_;
2649 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002650 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002651 TimingLogger* timings_;
2652 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002653 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002654 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002655
David Brazdilca3c8c32016-09-06 14:04:48 +01002656 // Collector of verifier dependencies.
2657 std::unique_ptr<verifier::VerifierDeps> verifier_deps_;
2658
Jeff Haodcdc85b2015-12-04 14:06:18 -08002659 // 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}