blob: ff193e933a7b88264db291f850212d315aa3feda [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
Andreas Gampe46ee31b2016-12-14 10:11:49 -080036#include "android-base/stringprintf.h"
Andreas Gampe9186ced2016-12-12 14:28:21 -080037#include "android-base/strings.h"
38
Ian Rogersd582fa42014-11-05 23:46:43 -080039#include "arch/instruction_set_features.h"
Andreas Gampec5a3ea72015-01-13 16:41:53 -080040#include "arch/mips/instruction_set_features_mips.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000041#include "art_method-inl.h"
Andreas Gampe8228cdf2017-05-30 15:03:54 -070042#include "base/callee_save_type.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070043#include "base/dumpable.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080044#include "base/macros.h"
Calin Juravle2e2db782016-02-23 12:00:03 +000045#include "base/scoped_flock.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070046#include "base/stl_util.h"
47#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010048#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070049#include "base/timing_logger.h"
50#include "base/unix_file/fd_file.h"
51#include "class_linker.h"
Calin Juravle1ce70852017-06-28 10:59:03 -070052#include "class_loader_context.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000053#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000054#include "compiler_callbacks.h"
David Srbecky09c2a6b2016-03-11 17:11:44 +000055#include "debug/elf_debug_writer.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000056#include "debug/method_debug_info.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000057#include "dex/quick_compiler_callbacks.h"
58#include "dex/verification_results.h"
Andreas Gampe7b565912017-03-20 15:48:52 -070059#include "dex2oat_return_codes.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000060#include "dex_file-inl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070061#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080062#include "driver/compiler_options.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080063#include "elf_file.h"
Tong Shen62d1ca32014-09-03 17:24:56 -070064#include "elf_writer.h"
Vladimir Marko10c13562015-11-25 14:33:36 +000065#include "elf_writer_quick.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070066#include "gc/space/image_space.h"
67#include "gc/space/space-inl.h"
Mathieu Chartier72041a02017-07-14 18:23:25 -070068#include "gc/verification.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070069#include "image_writer.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070070#include "interpreter/unstarted_runtime.h"
Mathieu Chartier72041a02017-07-14 18:23:25 -070071#include "java_vm_ext.h"
Calin Juravle33083d62017-01-18 15:29:12 -080072#include "jit/profile_compilation_info.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070073#include "leb128.h"
David Brazdil5d5a36b2016-09-14 15:34:10 +010074#include "linker/buffered_output_stream.h"
75#include "linker/file_output_stream.h"
Vladimir Marko944da602016-02-19 12:27:55 +000076#include "linker/multi_oat_relative_patcher.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070077#include "mirror/class-inl.h"
78#include "mirror/class_loader.h"
79#include "mirror/object-inl.h"
80#include "mirror/object_array-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070081#include "nativehelper/ScopedLocalRef.h"
Andreas Gampe2ff3b972017-06-05 18:14:53 -070082#include "oat_file.h"
Jeff Haob11ffb72016-04-07 15:40:54 -070083#include "oat_file_assistant.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070084#include "oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070085#include "os.h"
86#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000087#include "runtime_options.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070088#include "scoped_thread_state_change-inl.h"
Alex Light53cb16b2014-06-12 11:26:29 -070089#include "utils.h"
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +000090#include "vdex_file.h"
David Brazdilca3c8c32016-09-06 14:04:48 +010091#include "verifier/verifier_deps.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070092#include "well_known_classes.h"
93#include "zip_archive.h"
94
95namespace art {
96
Andreas Gampe46ee31b2016-12-14 10:11:49 -080097using android::base::StringAppendV;
98using android::base::StringPrintf;
99
Andreas Gampee1459ae2016-06-29 09:36:30 -0700100static constexpr size_t kDefaultMinDexFilesForSwap = 2;
101static constexpr size_t kDefaultMinDexFileCumulativeSizeForSwap = 20 * MB;
102
Mathieu Chartier010126f2017-07-15 15:44:18 -0700103// Compiler filter override for very large apps.
104static constexpr CompilerFilter::Filter kLargeAppFilter = CompilerFilter::kVerify;
105
Brian Carlstrom6449c622014-02-10 23:48:36 -0800106static int original_argc;
107static char** original_argv;
108
109static std::string CommandLine() {
110 std::vector<std::string> command;
111 for (int i = 0; i < original_argc; ++i) {
112 command.push_back(original_argv[i]);
113 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800114 return android::base::Join(command, ' ');
Brian Carlstrom6449c622014-02-10 23:48:36 -0800115}
116
Andreas Gampe046c7062015-05-18 23:22:54 -0700117// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
118// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
119// locations are all staged).
120static std::string StrippedCommandLine() {
121 std::vector<std::string> command;
122
Calin Juravle07c6d722017-06-07 17:06:12 +0000123 // Do a pre-pass to look for zip-fd and the compiler filter.
Andreas Gampe046c7062015-05-18 23:22:54 -0700124 bool saw_zip_fd = false;
Calin Juravle07c6d722017-06-07 17:06:12 +0000125 bool saw_compiler_filter = false;
Andreas Gampe046c7062015-05-18 23:22:54 -0700126 for (int i = 0; i < original_argc; ++i) {
Andreas Gampe9186ced2016-12-12 14:28:21 -0800127 if (android::base::StartsWith(original_argv[i], "--zip-fd=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700128 saw_zip_fd = true;
Andreas Gampe046c7062015-05-18 23:22:54 -0700129 }
Calin Juravle07c6d722017-06-07 17:06:12 +0000130 if (android::base::StartsWith(original_argv[i], "--compiler-filter=")) {
131 saw_compiler_filter = true;
Calin Juravle07c6d722017-06-07 17:06:12 +0000132 }
Andreas Gampe046c7062015-05-18 23:22:54 -0700133 }
134
135 // Now filter out things.
136 for (int i = 0; i < original_argc; ++i) {
137 // All runtime-arg parameters are dropped.
138 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
139 i++; // Drop the next part, too.
140 continue;
141 }
142
143 // Any instruction-setXXX is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800144 if (android::base::StartsWith(original_argv[i], "--instruction-set")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700145 continue;
146 }
147
148 // The boot image is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800149 if (android::base::StartsWith(original_argv[i], "--boot-image=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700150 continue;
151 }
152
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800153 // The image format is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800154 if (android::base::StartsWith(original_argv[i], "--image-format=")) {
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800155 continue;
156 }
157
Andreas Gampe046c7062015-05-18 23:22:54 -0700158 // This should leave any dex-file and oat-file options, describing what we compiled.
159
160 // However, we prefer to drop this when we saw --zip-fd.
161 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700162 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe9186ced2016-12-12 14:28:21 -0800163 if (android::base::StartsWith(original_argv[i], "--zip-") ||
164 android::base::StartsWith(original_argv[i], "--dex-") ||
165 android::base::StartsWith(original_argv[i], "--oat-") ||
166 android::base::StartsWith(original_argv[i], "--swap-") ||
167 android::base::StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700168 continue;
169 }
170 }
171
172 command.push_back(original_argv[i]);
173 }
174
Calin Juravle07c6d722017-06-07 17:06:12 +0000175 if (!saw_compiler_filter) {
176 command.push_back("--compiler-filter=" +
177 CompilerFilter::NameOfFilter(CompilerFilter::kDefaultCompilerFilter));
178 }
179
Andreas Gampe046c7062015-05-18 23:22:54 -0700180 // Construct the final output.
181 if (command.size() <= 1U) {
182 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
183 return "Starting dex2oat.";
184 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800185 return android::base::Join(command, ' ');
Andreas Gampe046c7062015-05-18 23:22:54 -0700186}
187
Brian Carlstrom7940e442013-07-12 13:46:57 -0700188static void UsageErrorV(const char* fmt, va_list ap) {
189 std::string error;
190 StringAppendV(&error, fmt, ap);
191 LOG(ERROR) << error;
192}
193
194static void UsageError(const char* fmt, ...) {
195 va_list ap;
196 va_start(ap, fmt);
197 UsageErrorV(fmt, ap);
198 va_end(ap);
199}
200
Andreas Gampe794ad762015-02-23 08:12:24 -0800201NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700202 va_list ap;
203 va_start(ap, fmt);
204 UsageErrorV(fmt, ap);
205 va_end(ap);
206
Brian Carlstrom6449c622014-02-10 23:48:36 -0800207 UsageError("Command: %s", CommandLine().c_str());
208
Brian Carlstrom7940e442013-07-12 13:46:57 -0700209 UsageError("Usage: dex2oat [options]...");
210 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100211 UsageError(" -j<number>: specifies the number of threads used for compilation.");
212 UsageError(" Default is the number of detected hardware threads available on the");
213 UsageError(" host system.");
214 UsageError(" Example: -j12");
215 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700216 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700217 UsageError(" Example: --dex-file=/system/framework/core.jar");
218 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700219 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
220 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
221 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
222 UsageError(" --dex-location=/system/framework/core.jar");
223 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700224 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
225 UsageError(" containing a classes.dex file to compile.");
226 UsageError(" Example: --zip-fd=5");
227 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700228 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
229 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700230 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
231 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800232 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700233 UsageError(" Example: --oat-file=/system/framework/boot.oat");
234 UsageError("");
235 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900236 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700237 UsageError("");
238 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
239 UsageError(" to the file descriptor specified by --oat-fd.");
240 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
241 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800242 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700243 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
244 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800245 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700246 UsageError(" Example: --image=/system/framework/boot.art");
247 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800248 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800249 UsageError(" Which format to store the image.");
250 UsageError(" Example: --image-format=lz4");
251 UsageError(" Default: uncompressed");
252 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700253 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
254 UsageError(" Example: --image=frameworks/base/preloaded-classes");
255 UsageError("");
256 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
257 UsageError(" Example: --base=0x50000000");
258 UsageError("");
259 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000260 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700261 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000262 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000263 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700264 UsageError("");
265 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
266 UsageError(" Example: --android-root=out/host/linux-x86");
267 UsageError(" Default: $ANDROID_ROOT");
268 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800269 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700270 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700271 UsageError(" Example: --instruction-set=x86");
272 UsageError(" Default: arm");
273 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700274 UsageError(" --instruction-set-features=...,: Specify instruction set features");
275 UsageError(" Example: --instruction-set-features=div");
276 UsageError(" Default: default");
277 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700278 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
279 UsageError(" Default: disabled");
280 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800281 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700282 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800283 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100284 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700285 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100286 UsageError(" --compiler-filter="
Nicolas Geoffray49cda062017-04-21 13:08:25 +0100287 "(assume-verified"
288 "|extract"
289 "|verify"
290 "|quicken"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000291 "|space-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100292 "|space"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000293 "|speed-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100294 "|speed"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000295 "|everything-profile"
296 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700297 UsageError(" select compiler filter.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800298 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800299 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800300 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800301 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
302 UsageError(" method for compiler filter tuning.");
303 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
304 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
305 UsageError("");
306 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
307 UsageError(" method for compiler filter tuning.");
308 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
309 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
310 UsageError("");
311 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
312 UsageError(" method for compiler filter tuning.");
313 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
314 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
315 UsageError("");
316 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
317 UsageError(" method for compiler filter tuning.");
318 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
319 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
320 UsageError("");
321 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
322 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700323 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
324 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800325 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
326 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
327 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100328 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
329 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100330 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
331 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100332 UsageError(" Example: --inline-max-code-units=%d",
333 CompilerOptions::kDefaultInlineMaxCodeUnits);
334 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
335 UsageError("");
Ian Rogers46398602013-08-20 07:50:36 -0700336 UsageError(" --dump-timing: display a breakdown of where time was spent");
337 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100338 UsageError(" -g");
339 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
340 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000341 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000342 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700343 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100344 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100345 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000346 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
347 UsageError(" debug information necessary to print backtraces. (disabled by default)");
348 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000349 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000350 UsageError("");
Alexey Alexandrovab40c112016-09-19 09:33:49 -0700351 UsageError(" --generate-build-id: Generate GNU-compatible linker build ID ELF section with");
352 UsageError(" SHA-1 of the file content (and thus stable across identical builds)");
353 UsageError("");
354 UsageError(" --no-generate-build-id: Do not generate the build ID ELF section.");
355 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000356 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000357 UsageError("");
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700358 UsageError(" --avoid-storing-invocation: Avoid storing the invocation args in the key value");
359 UsageError(" store. Used to test determinism with different args.");
360 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700361 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
362 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
363 UsageError(" Use a separate --runtime-arg switch for each argument.");
364 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700365 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000366 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700367 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000368 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
369 UsageError(" Cannot be used together with --profile-file.");
370 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100371 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800372 UsageError(" Example: --swap-file=/data/tmp/swap.001");
373 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100374 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800375 UsageError(" Example: --swap-fd=10");
376 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100377 UsageError(" --swap-dex-size-threshold=<size>: specifies the minimum total dex file size in");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700378 UsageError(" bytes to allow the use of swap.");
379 UsageError(" Example: --swap-dex-size-threshold=1000000");
380 UsageError(" Default: %zu", kDefaultMinDexFileCumulativeSizeForSwap);
381 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100382 UsageError(" --swap-dex-count-threshold=<count>: specifies the minimum number of dex files to");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700383 UsageError(" allow the use of swap.");
384 UsageError(" Example: --swap-dex-count-threshold=10");
385 UsageError(" Default: %zu", kDefaultMinDexFilesForSwap);
386 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100387 UsageError(" --very-large-app-threshold=<size>: specifies the minimum total dex file size in");
Mathieu Chartier010126f2017-07-15 15:44:18 -0700388 UsageError(" bytes to consider the input \"very large\" and reduce compilation done.");
Andreas Gampe67f02822016-06-24 21:05:23 -0700389 UsageError(" Example: --very-large-app-threshold=100000000");
390 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700391 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
392 UsageError(" Example: --app-image-fd=10");
393 UsageError("");
394 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
395 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
396 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800397 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
398 "input dex file.");
399 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000400 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000401 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100402 UsageError(" --dump-cfg=<cfg-file>: dump control-flow graphs (CFGs) to specified file.");
403 UsageError(" Example: --dump-cfg=output.cfg");
404 UsageError("");
405 UsageError(" --dump-cfg-append: when dumping CFGs to an existing file, append new CFG data to");
406 UsageError(" existing data (instead of overwriting existing data with new data, which is");
407 UsageError(" the default behavior). This option is only meaningful when used with");
408 UsageError(" --dump-cfg.");
409 UsageError("");
Jeff Hao16d48432017-04-05 17:05:46 -0700410 UsageError(" --classpath-dir=<directory-path>: directory used to resolve relative class paths.");
411 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700412 UsageError(" --class-loader-context=<string spec>: a string specifying the intended");
413 UsageError(" runtime loading context for the compiled dex files.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700414 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700415 UsageError(" It describes how the class loader chain should be built in order to ensure");
416 UsageError(" classes are resolved during dex2aot as they would be resolved at runtime.");
417 UsageError(" This spec will be encoded in the oat file. If at runtime the dex file is");
418 UsageError(" loaded in a different context, the oat file will be rejected.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700419 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700420 UsageError(" The chain is interpreted in the natural 'parent order', meaning that class");
421 UsageError(" loader 'i+1' will be the parent of class loader 'i'.");
Calin Juravlec79470d2017-07-12 17:37:42 -0700422 UsageError(" The compilation sources will be appended to the classpath of the first class");
423 UsageError(" loader.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700424 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700425 UsageError(" E.g. if the context is 'PCL[lib1.dex];DLC[lib2.dex]' and ");
426 UsageError(" --dex-file=src.dex then dex2oat will setup a PathClassLoader with classpath ");
427 UsageError(" 'lib1.dex:src.dex' and set its parent to a DelegateLastClassLoader with ");
428 UsageError(" classpath 'lib2.dex'.");
Calin Juravle1ce70852017-06-28 10:59:03 -0700429 UsageError(" ");
430 UsageError(" Note that the compiler will be tolerant if the source dex files specified");
431 UsageError(" with --dex-file are found in the classpath. The source dex files will be");
432 UsageError(" removed from any class loader's classpath possibly resulting in empty");
433 UsageError(" class loaders.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700434 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700435 UsageError(" Example: --class-loader-context=PCL[lib1.dex:lib2.dex];DLC[lib3.dex]");
Calin Juravle1ce70852017-06-28 10:59:03 -0700436 UsageError("");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700437 UsageError(" --dirty-image-objects=<directory-path>: list of known dirty objects in the image.");
438 UsageError(" The image writer will group them together.");
439 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700440 std::cerr << "See log for usage error information\n";
441 exit(EXIT_FAILURE);
442}
443
Brian Carlstrom7940e442013-07-12 13:46:57 -0700444// The primary goal of the watchdog is to prevent stuck build servers
445// during development when fatal aborts lead to a cascade of failures
446// that result in a deadlock.
447class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800448// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700449#undef CHECK_PTHREAD_CALL
450#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
451 do { \
452 int rc = call args; \
453 if (rc != 0) { \
454 errno = rc; \
455 std::string message(# call); \
456 message += " failed for "; \
457 message += reason; \
458 Fatal(message); \
459 } \
460 } while (false)
461
462 public:
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800463 explicit WatchDog(int64_t timeout_in_milliseconds)
464 : timeout_in_milliseconds_(timeout_in_milliseconds),
465 shutting_down_(false) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700466 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700467 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800468#ifndef __APPLE__
469 pthread_condattr_t condattr;
liulvping8f7101e2017-01-16 15:14:43 +0800470 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_init, (&condattr), reason);
471 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_setclock, (&condattr, CLOCK_MONOTONIC), reason);
472 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, &condattr), reason);
473 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_destroy, (&condattr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800474#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700475 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
476 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
477 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
478 }
479 ~WatchDog() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700480 const char* reason = "dex2oat watch dog thread shutdown";
481 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
482 shutting_down_ = true;
483 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
484 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
485
Kenny Root51316382014-05-13 14:59:37 -0700486 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700487
488 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
489 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
490 }
491
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800492 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
493 // large.
494 static constexpr int64_t kWatchdogVerifyMultiplier =
495 kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
496
497 // When setting timeouts, keep in mind that the build server may not be as fast as your
498 // desktop. Debug builds are slower so they have larger timeouts.
499 static constexpr int64_t kWatchdogSlowdownFactor = kIsDebugBuild ? 5U : 1U;
500
501 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
502 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
503 // itself before that watchdog would take down the system server.
504 static constexpr int64_t kWatchDogTimeoutSeconds = kWatchdogSlowdownFactor * (9 * 60 + 30);
505
506 static constexpr int64_t kDefaultWatchdogTimeoutInMS =
507 kWatchdogVerifyMultiplier * kWatchDogTimeoutSeconds * 1000;
508
Brian Carlstrom7940e442013-07-12 13:46:57 -0700509 private:
510 static void* CallBack(void* arg) {
511 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
512 ::art::SetThreadName("dex2oat watch dog");
513 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700514 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700515 }
516
Andreas Gampe794ad762015-02-23 08:12:24 -0800517 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700518 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
519 // it's rather easy to hang in unwinding.
520 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
521 // logcat logging or stderr output.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700522 android::base::LogMessage::LogLine(__FILE__,
523 __LINE__,
524 android::base::LogId::DEFAULT,
525 LogSeverity::FATAL,
526 message.c_str());
Andreas Gampe48fde372017-06-06 07:43:46 -0700527 // If we're on the host, try to dump all threads to get a sense of what's going on. This is
528 // restricted to the host as the dump may itself go bad.
529 // TODO: Use a double watchdog timeout, so we can enable this on-device.
530 if (!kIsTargetBuild && Runtime::Current() != nullptr) {
Andreas Gampecd607312017-06-05 17:03:05 -0700531 Runtime::Current()->AttachCurrentThread("Watchdog thread attached for dumping",
532 true,
533 nullptr,
534 false);
535 Runtime::Current()->DumpForSigQuit(std::cerr);
536 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700537 exit(1);
538 }
539
540 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700541 timespec timeout_ts;
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800542#if defined(__APPLE__)
543 InitTimeSpec(true, CLOCK_REALTIME, timeout_in_milliseconds_, 0, &timeout_ts);
544#else
liulvping8f7101e2017-01-16 15:14:43 +0800545 InitTimeSpec(true, CLOCK_MONOTONIC, timeout_in_milliseconds_, 0, &timeout_ts);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800546#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700547 const char* reason = "dex2oat watch dog thread waiting";
548 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
549 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800550 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700551 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700552 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800553 timeout_in_milliseconds_/1000));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700554 } else if (rc != 0) {
555 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
556 strerror(errno)));
557 Fatal(message.c_str());
558 }
559 }
560 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
561 }
562
Brian Carlstrom7940e442013-07-12 13:46:57 -0700563 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
564 pthread_mutex_t mutex_;
565 pthread_cond_t cond_;
566 pthread_attr_t attr_;
567 pthread_t pthread_;
Andreas Gampef45d61c2017-06-07 10:29:33 -0700568
569 const int64_t timeout_in_milliseconds_;
570 bool shutting_down_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700571};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700572
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800573class Dex2Oat FINAL {
574 public:
575 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100576 compiler_kind_(Compiler::kOptimizing),
Artem Serovba6b6792016-08-15 14:22:07 +0100577 instruction_set_(kRuntimeISA == kArm ? kThumb2 : kRuntimeISA),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800578 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000579 image_file_location_oat_checksum_(0),
580 image_file_location_oat_data_begin_(0),
581 image_patch_delta_(0),
582 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700583 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800584 runtime_(nullptr),
585 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
586 start_ns_(NanoTime()),
Andreas Gampec560fc02014-07-16 09:57:39 -0700587 start_cputime_ns_(ProcessCpuNanoTime()),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800588 oat_fd_(-1),
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000589 input_vdex_fd_(-1),
590 output_vdex_fd_(-1),
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000591 input_vdex_file_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800592 zip_fd_(-1),
593 image_base_(0U),
594 image_classes_zip_filename_(nullptr),
595 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800596 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800597 compiled_classes_zip_filename_(nullptr),
598 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700599 compiled_methods_zip_filename_(nullptr),
600 compiled_methods_filename_(nullptr),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700601 passes_to_run_filename_(nullptr),
Mathieu Chartierff0baff2017-08-02 23:04:19 -0700602 dirty_image_objects_filename_(nullptr),
Jeff Hao436183f2016-01-12 16:36:50 -0800603 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800604 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000605 elf_writers_(),
606 oat_writers_(),
607 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000608 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700609 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000610 opened_dex_files_maps_(),
611 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000612 no_inline_from_dex_files_(),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800613 dump_stats_(false),
614 dump_passes_(false),
615 dump_timing_(false),
616 dump_slow_timing_(kIsDebugBuild),
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700617 avoid_storing_invocation_(false),
Calin Juravle2e2db782016-02-23 12:00:03 +0000618 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800619 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000620 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800621 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000622 force_determinism_(false)
623 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800624
625 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800626 // Log completion time before deleting the runtime_, because this accesses
627 // the runtime.
628 LogCompletionTime();
629
Vladimir Marko307dac92015-10-20 11:20:09 +0100630 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
631 // We want to just exit on non-debug builds, not bringing the runtime down
632 // in an orderly fashion. So release the following fields.
633 driver_.release();
634 image_writer_.release();
635 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
636 dex_file.release();
637 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000638 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
639 map.release();
640 }
David Brazdil7b49e6c2016-09-01 11:06:18 +0100641 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
642 vdex_file.release();
643 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800644 for (std::unique_ptr<File>& oat_file : oat_files_) {
645 oat_file.release();
646 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100647 runtime_.release();
648 verification_results_.release();
649 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100650 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700651 }
652
Roland Levillain9ec5e222015-08-17 20:18:41 +0100653 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800654 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800655 std::string boot_image_filename;
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800656 int64_t watch_dog_timeout_in_ms = -1;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800657 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000658 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800659 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100660 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800661
Roland Levillain9ec5e222015-08-17 20:18:41 +0100662 void ParseZipFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000663 ParseUintOption(option, "--zip-fd", &zip_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100664 }
665
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000666 void ParseInputVdexFd(const StringPiece& option) {
667 // Note that the input vdex fd might be -1.
668 ParseIntOption(option, "--input-vdex-fd", &input_vdex_fd_, Usage);
669 }
670
671 void ParseOutputVdexFd(const StringPiece& option) {
672 ParseUintOption(option, "--output-vdex-fd", &output_vdex_fd_, Usage);
David Brazdil7b49e6c2016-09-01 11:06:18 +0100673 }
674
Roland Levillain9ec5e222015-08-17 20:18:41 +0100675 void ParseOatFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000676 ParseUintOption(option, "--oat-fd", &oat_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100677 }
678
Calin Juravle877fd962016-01-05 14:29:29 +0000679 void ParseFdForCollection(const StringPiece& option,
680 const char* arg_name,
681 std::vector<uint32_t>* fds) {
682 uint32_t fd;
683 ParseUintOption(option, arg_name, &fd, Usage);
684 fds->push_back(fd);
685 }
686
Roland Levillain9ec5e222015-08-17 20:18:41 +0100687 void ParseJ(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000688 ParseUintOption(option, "-j", &thread_count_, Usage, /* is_long_option */ false);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100689 }
690
691 void ParseBase(const StringPiece& option) {
692 DCHECK(option.starts_with("--base="));
693 const char* image_base_str = option.substr(strlen("--base=")).data();
694 char* end;
695 image_base_ = strtoul(image_base_str, &end, 16);
696 if (end == image_base_str || *end != '\0') {
697 Usage("Failed to parse hexadecimal value for option %s", option.data());
698 }
699 }
700
701 void ParseInstructionSet(const StringPiece& option) {
702 DCHECK(option.starts_with("--instruction-set="));
703 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
704 // StringPiece is not necessarily zero-terminated, so need to make a copy and ensure it.
705 std::unique_ptr<char[]> buf(new char[instruction_set_str.length() + 1]);
706 strncpy(buf.get(), instruction_set_str.data(), instruction_set_str.length());
707 buf.get()[instruction_set_str.length()] = 0;
708 instruction_set_ = GetInstructionSetFromString(buf.get());
709 // arm actually means thumb2.
710 if (instruction_set_ == InstructionSet::kArm) {
711 instruction_set_ = InstructionSet::kThumb2;
712 }
713 }
714
715 void ParseInstructionSetVariant(const StringPiece& option, ParserOptions* parser_options) {
716 DCHECK(option.starts_with("--instruction-set-variant="));
717 StringPiece str = option.substr(strlen("--instruction-set-variant=")).data();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800718 instruction_set_features_ = InstructionSetFeatures::FromVariant(
719 instruction_set_, str.as_string(), &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100720 if (instruction_set_features_.get() == nullptr) {
721 Usage("%s", parser_options->error_msg.c_str());
722 }
723 }
724
725 void ParseInstructionSetFeatures(const StringPiece& option, ParserOptions* parser_options) {
726 DCHECK(option.starts_with("--instruction-set-features="));
727 StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800728 if (instruction_set_features_ == nullptr) {
729 instruction_set_features_ = InstructionSetFeatures::FromVariant(
730 instruction_set_, "default", &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100731 if (instruction_set_features_.get() == nullptr) {
732 Usage("Problem initializing default instruction set features variant: %s",
733 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700734 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800735 }
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800736 instruction_set_features_ =
Roland Levillain9ec5e222015-08-17 20:18:41 +0100737 instruction_set_features_->AddFeaturesFromString(str.as_string(),
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800738 &parser_options->error_msg);
739 if (instruction_set_features_ == nullptr) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100740 Usage("Error parsing '%s': %s", option.data(), parser_options->error_msg.c_str());
741 }
742 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800743
Roland Levillain9ec5e222015-08-17 20:18:41 +0100744 void ParseCompilerBackend(const StringPiece& option, ParserOptions* parser_options) {
745 DCHECK(option.starts_with("--compiler-backend="));
746 parser_options->requested_specific_compiler = true;
747 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
748 if (backend_str == "Quick") {
749 compiler_kind_ = Compiler::kQuick;
750 } else if (backend_str == "Optimizing") {
751 compiler_kind_ = Compiler::kOptimizing;
752 } else {
753 Usage("Unknown compiler backend: %s", backend_str.data());
754 }
755 }
756
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800757 void ParseImageFormat(const StringPiece& option) {
758 const StringPiece substr("--image-format=");
759 DCHECK(option.starts_with(substr));
760 const StringPiece format_str = option.substr(substr.length());
761 if (format_str == "lz4") {
762 image_storage_mode_ = ImageHeader::kStorageModeLZ4;
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800763 } else if (format_str == "lz4hc") {
764 image_storage_mode_ = ImageHeader::kStorageModeLZ4HC;
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800765 } else if (format_str == "uncompressed") {
766 image_storage_mode_ = ImageHeader::kStorageModeUncompressed;
767 } else {
768 Usage("Unknown image format: %s", format_str.data());
769 }
770 }
771
Jeff Hao436183f2016-01-12 16:36:50 -0800772 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoaad75c62016-10-03 08:46:48 +0000773 compiler_options_->boot_image_ = !image_filenames_.empty();
774 compiler_options_->app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700775
776 if (IsAppImage() && IsBootImage()) {
777 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
778 }
779
Jeff Haodcdc85b2015-12-04 14:06:18 -0800780 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800781 Usage("Output must be supplied with either --oat-file or --oat-fd");
782 }
783
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000784 if (input_vdex_fd_ != -1 && !input_vdex_.empty()) {
785 Usage("Can't have both --input-vdex-fd and --input-vdex");
786 }
787
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +0100788 if (output_vdex_fd_ != -1 && !output_vdex_.empty()) {
789 Usage("Can't have both --output-vdex-fd and --output-vdex");
790 }
791
Jeff Haodcdc85b2015-12-04 14:06:18 -0800792 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800793 Usage("--oat-file should not be used with --oat-fd");
794 }
795
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000796 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +0100797 Usage("VDEX and OAT output must be specified either with one --oat-filename "
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000798 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100799 }
800
Roland Levillain9ec5e222015-08-17 20:18:41 +0100801 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800802 Usage("--oat-symbols should not be used with --oat-fd");
803 }
804
Roland Levillain9ec5e222015-08-17 20:18:41 +0100805 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800806 Usage("--oat-symbols should not be used with --host");
807 }
808
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000809 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
810 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100811 }
812
Jeff Haodcdc85b2015-12-04 14:06:18 -0800813 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800814 Usage("--oat-fd should not be used with --image");
815 }
816
Jeff Haodcdc85b2015-12-04 14:06:18 -0800817 if (!parser_options->oat_symbols.empty() &&
818 parser_options->oat_symbols.size() != oat_filenames_.size()) {
819 Usage("--oat-file arguments do not match --oat-symbols arguments");
820 }
821
822 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
823 Usage("--oat-file arguments do not match --image arguments");
824 }
825
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800826 if (android_root_.empty()) {
827 const char* android_root_env_var = getenv("ANDROID_ROOT");
828 if (android_root_env_var == nullptr) {
829 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700830 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800831 android_root_ += android_root_env_var;
832 }
833
Vladimir Markoaad75c62016-10-03 08:46:48 +0000834 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100835 parser_options->boot_image_filename += android_root_;
836 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800837 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100838 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000839 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800840 }
841
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700842 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800843 Usage("--image-classes should only be used with --image");
844 }
845
Vladimir Marko49b0f452015-12-10 13:49:19 +0000846 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800847 Usage("--image-classes should not be used with --boot-image");
848 }
849
850 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
851 Usage("--image-classes-zip should be used with --image-classes");
852 }
853
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700854 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800855 Usage("--compiled-classes should only be used with --image");
856 }
857
Vladimir Marko49b0f452015-12-10 13:49:19 +0000858 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800859 Usage("--compiled-classes should not be used with --boot-image");
860 }
861
862 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
863 Usage("--compiled-classes-zip should be used with --compiled-classes");
864 }
865
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800866 if (dex_filenames_.empty() && zip_fd_ == -1) {
867 Usage("Input must be supplied with either --dex-file or --zip-fd");
868 }
869
870 if (!dex_filenames_.empty() && zip_fd_ != -1) {
871 Usage("--dex-file should not be used with --zip-fd");
872 }
873
874 if (!dex_filenames_.empty() && !zip_location_.empty()) {
875 Usage("--dex-file should not be used with --zip-location");
876 }
877
878 if (dex_locations_.empty()) {
879 for (const char* dex_file_name : dex_filenames_) {
880 dex_locations_.push_back(dex_file_name);
881 }
882 } else if (dex_locations_.size() != dex_filenames_.size()) {
883 Usage("--dex-location arguments do not match --dex-file arguments");
884 }
885
Jeff Haodcdc85b2015-12-04 14:06:18 -0800886 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
887 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
888 Usage("--oat-file arguments must be singular or match --dex-file arguments");
889 }
890 }
891
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800892 if (zip_fd_ != -1 && zip_location_.empty()) {
893 Usage("--zip-location should be supplied with --zip-fd");
894 }
895
Vladimir Marko49b0f452015-12-10 13:49:19 +0000896 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800897 if (image_base_ == 0) {
898 Usage("Non-zero --base not specified");
899 }
900 }
901
Mathieu Chartiera8077802016-03-16 19:08:31 -0700902 const bool have_profile_file = !profile_file_.empty();
903 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
904 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000905 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200906 }
907
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -0700908 if (have_profile_file || have_profile_fd) {
909 if (compiled_classes_filename_ != nullptr ||
910 compiled_classes_zip_filename_ != nullptr ||
911 image_classes_filename_ != nullptr ||
912 image_classes_zip_filename_ != nullptr) {
913 Usage("Profile based image creation is not supported with image or compiled classes");
914 }
915 }
916
Roland Levillain9ec5e222015-08-17 20:18:41 +0100917 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800918 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800919 }
920
921 // If no instruction set feature was given, use the default one for the target
922 // instruction set.
923 if (instruction_set_features_.get() == nullptr) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800924 instruction_set_features_ = InstructionSetFeatures::FromVariant(
925 instruction_set_, "default", &parser_options->error_msg);
Ian Rogersd582fa42014-11-05 23:46:43 -0800926 if (instruction_set_features_.get() == nullptr) {
927 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100928 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800929 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800930 }
931
932 if (instruction_set_ == kRuntimeISA) {
933 std::unique_ptr<const InstructionSetFeatures> runtime_features(
934 InstructionSetFeatures::FromCppDefines());
935 if (!instruction_set_features_->Equals(runtime_features.get())) {
936 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
937 << *instruction_set_features_ << ") and those of dex2oat executable ("
938 << *runtime_features <<") for the command line:\n"
939 << CommandLine();
940 }
941 }
942
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000943 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +0000944 compiler_options_->inline_max_code_units_ = CompilerOptions::kDefaultInlineMaxCodeUnits;
Roland Levillaina215b952015-08-07 11:38:32 +0100945 }
946
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800947 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800948 // Set the compilation target's implicit checks options.
949 switch (instruction_set_) {
950 case kArm:
951 case kThumb2:
952 case kArm64:
953 case kX86:
954 case kX86_64:
Douglas Leung22bb5a22015-07-02 16:42:08 -0700955 case kMips:
956 case kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000957 compiler_options_->implicit_null_checks_ = true;
958 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800959 break;
960
961 default:
962 // Defaults are correct.
963 break;
964 }
965
Jeff Hao436183f2016-01-12 16:36:50 -0800966 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800967 Usage("--multi-image can only be used when creating boot images");
968 }
Jeff Hao436183f2016-01-12 16:36:50 -0800969 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800970 Usage("--multi-image cannot be used with multiple image names");
971 }
972
973 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
974 if (!kIsTargetBuild && IsBootImage()) {
975 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800976 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800977 }
978 }
979
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800980 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100981 if (parser_options->watch_dog_enabled) {
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800982 int64_t timeout = parser_options->watch_dog_timeout_in_ms > 0
983 ? parser_options->watch_dog_timeout_in_ms
984 : WatchDog::kDefaultWatchdogTimeoutInMS;
985 watchdog_.reset(new WatchDog(timeout));
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800986 }
987
988 // Fill some values into the key-value store for the oat header.
989 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800990
Roland Levillainb81e9e92017-04-20 17:35:32 +0100991 // Automatically force determinism for the boot image in a host build if read barriers
992 // are enabled, or if the default GC is CMS or MS. When the default GC is CMS
993 // (Concurrent Mark-Sweep), the GC is switched to a non-concurrent one by passing the
994 // option `-Xgc:nonconcurrent` (see below).
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800995 if (!kIsTargetBuild && IsBootImage()) {
996 if (SupportsDeterministicCompilation()) {
997 force_determinism_ = true;
998 } else {
999 LOG(WARNING) << "Deterministic compilation is disabled.";
1000 }
Andreas Gampeace0dc12016-01-20 13:33:13 -08001001 }
1002 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07001003
1004 if (passes_to_run_filename_ != nullptr) {
1005 passes_to_run_.reset(ReadCommentedInputFromFile<std::vector<std::string>>(
1006 passes_to_run_filename_,
1007 nullptr)); // No post-processing.
1008 if (passes_to_run_.get() == nullptr) {
1009 Usage("Failed to read list of passes to run.");
1010 }
1011 }
1012 compiler_options_->passes_to_run_ = passes_to_run_.get();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001013 }
1014
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001015 static bool SupportsDeterministicCompilation() {
Roland Levillainb81e9e92017-04-20 17:35:32 +01001016 return (kUseReadBarrier ||
1017 gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
1018 gc::kCollectorTypeDefault == gc::kCollectorTypeMS);
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001019 }
1020
Jeff Hao436183f2016-01-12 16:36:50 -08001021 void ExpandOatAndImageFilenames() {
1022 std::string base_oat = oat_filenames_[0];
1023 size_t last_oat_slash = base_oat.rfind('/');
1024 if (last_oat_slash == std::string::npos) {
1025 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
1026 }
1027 // We also need to honor path components that were encoded through '@'. Otherwise the loading
1028 // code won't be able to find the images.
1029 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
1030 last_oat_slash = base_oat.rfind('@');
1031 }
1032 base_oat = base_oat.substr(0, last_oat_slash + 1);
1033
1034 std::string base_img = image_filenames_[0];
1035 size_t last_img_slash = base_img.rfind('/');
1036 if (last_img_slash == std::string::npos) {
1037 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
1038 }
1039 // We also need to honor path components that were encoded through '@'. Otherwise the loading
1040 // code won't be able to find the images.
1041 if (base_img.find('@', last_img_slash) != std::string::npos) {
1042 last_img_slash = base_img.rfind('@');
1043 }
1044
1045 // Get the prefix, which is the primary image name (without path components). Strip the
1046 // extension.
1047 std::string prefix = base_img.substr(last_img_slash + 1);
1048 if (prefix.rfind('.') != std::string::npos) {
1049 prefix = prefix.substr(0, prefix.rfind('.'));
1050 }
1051 if (!prefix.empty()) {
1052 prefix = prefix + "-";
1053 }
1054
1055 base_img = base_img.substr(0, last_img_slash + 1);
1056
1057 // Note: we have some special case here for our testing. We have to inject the differentiating
1058 // parts for the different core images.
1059 std::string infix; // Empty infix by default.
1060 {
1061 // Check the first name.
1062 std::string dex_file = oat_filenames_[0];
1063 size_t last_dex_slash = dex_file.rfind('/');
1064 if (last_dex_slash != std::string::npos) {
1065 dex_file = dex_file.substr(last_dex_slash + 1);
1066 }
1067 size_t last_dex_dot = dex_file.rfind('.');
1068 if (last_dex_dot != std::string::npos) {
1069 dex_file = dex_file.substr(0, last_dex_dot);
1070 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001071 if (android::base::StartsWith(dex_file, "core-")) {
Jeff Hao436183f2016-01-12 16:36:50 -08001072 infix = dex_file.substr(strlen("core"));
1073 }
1074 }
1075
bowen_lai8bd36c02016-10-12 13:28:55 +08001076 std::string base_symbol_oat;
1077 if (!oat_unstripped_.empty()) {
1078 base_symbol_oat = oat_unstripped_[0];
1079 size_t last_symbol_oat_slash = base_symbol_oat.rfind('/');
1080 if (last_symbol_oat_slash == std::string::npos) {
1081 Usage("--multi-image used with unusable symbol filename %s", base_symbol_oat.c_str());
1082 }
1083 base_symbol_oat = base_symbol_oat.substr(0, last_symbol_oat_slash + 1);
1084 }
1085
1086 const size_t num_expanded_files = 2 + (base_symbol_oat.empty() ? 0 : 1);
1087 char_backing_storage_.reserve((dex_locations_.size() - 1) * num_expanded_files);
Ben Gruvera0fc3262016-09-30 13:10:42 -07001088
Jeff Hao436183f2016-01-12 16:36:50 -08001089 // Now create the other names. Use a counted loop to skip the first one.
1090 for (size_t i = 1; i < dex_locations_.size(); ++i) {
1091 // TODO: Make everything properly std::string.
1092 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
1093 char_backing_storage_.push_back(base_img + image_name);
1094 image_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
1095
1096 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
1097 char_backing_storage_.push_back(base_oat + oat_name);
1098 oat_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001099
1100 if (!base_symbol_oat.empty()) {
1101 char_backing_storage_.push_back(base_symbol_oat + oat_name);
1102 oat_unstripped_.push_back((char_backing_storage_.end() - 1)->c_str());
1103 }
Jeff Hao436183f2016-01-12 16:36:50 -08001104 }
1105 }
1106
Andreas Gampe8994a042015-12-30 19:03:17 +00001107 // Modify the input string in the following way:
1108 // 0) Assume input is /a/b/c.d
1109 // 1) Strip the path -> c.d
1110 // 2) Inject prefix p -> pc.d
1111 // 3) Inject infix i -> pci.d
1112 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -08001113 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +00001114 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001115 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +00001116 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001117 size_t last_dex_slash = in.rfind('/');
1118 if (last_dex_slash != std::string::npos) {
1119 in = in.substr(last_dex_slash + 1);
1120 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001121 if (!prefix.empty()) {
1122 in = prefix + in;
1123 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001124 if (!infix.empty()) {
1125 // Inject infix.
1126 size_t last_dot = in.rfind('.');
1127 if (last_dot != std::string::npos) {
1128 in.insert(last_dot, infix);
1129 }
1130 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001131 if (android::base::EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001132 in = in.substr(0, in.length() - strlen(".jar")) +
1133 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001134 }
1135 return in;
1136 }
1137
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001138 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001139 std::ostringstream oss;
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001140 if (!avoid_storing_invocation_) {
1141 for (int i = 0; i < argc; ++i) {
1142 if (i > 0) {
1143 oss << ' ';
1144 }
1145 oss << argv[i];
Roland Levillain9ec5e222015-08-17 20:18:41 +01001146 }
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001147 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1148 oss.str(""); // Reset.
Roland Levillain9ec5e222015-08-17 20:18:41 +01001149 }
Roland Levillain9ec5e222015-08-17 20:18:41 +01001150 oss << kRuntimeISA;
1151 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1152 key_value_store_->Put(
1153 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001154 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001155 key_value_store_->Put(
1156 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001157 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001158 key_value_store_->Put(
1159 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001160 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001161 key_value_store_->Put(OatHeader::kCompilerFilter,
1162 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Andreas Gampef8cd8902017-01-18 16:05:01 -08001163 key_value_store_->Put(OatHeader::kConcurrentCopying,
1164 kUseReadBarrier ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001165 }
1166
1167 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1168 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1169 // returns, arguments have been successfully parsed.
1170 void ParseArgs(int argc, char** argv) {
1171 original_argc = argc;
1172 original_argv = argv;
1173
Andreas Gampe51d80cc2017-06-21 21:05:13 -07001174 InitLogging(argv, Runtime::Abort);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001175
1176 // Skip over argv[0].
1177 argv++;
1178 argc--;
1179
1180 if (argc == 0) {
1181 Usage("No arguments specified");
1182 }
1183
1184 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001185 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001186
1187 for (int i = 0; i < argc; i++) {
1188 const StringPiece option(argv[i]);
1189 const bool log_options = false;
1190 if (log_options) {
1191 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1192 }
1193 if (option.starts_with("--dex-file=")) {
1194 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data());
1195 } else if (option.starts_with("--dex-location=")) {
1196 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data());
1197 } else if (option.starts_with("--zip-fd=")) {
1198 ParseZipFd(option);
1199 } else if (option.starts_with("--zip-location=")) {
1200 zip_location_ = option.substr(strlen("--zip-location=")).data();
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001201 } else if (option.starts_with("--input-vdex-fd=")) {
1202 ParseInputVdexFd(option);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001203 } else if (option.starts_with("--input-vdex=")) {
1204 input_vdex_ = option.substr(strlen("--input-vdex=")).data();
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001205 } else if (option.starts_with("--output-vdex=")) {
1206 output_vdex_ = option.substr(strlen("--output-vdex=")).data();
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001207 } else if (option.starts_with("--output-vdex-fd=")) {
1208 ParseOutputVdexFd(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001209 } else if (option.starts_with("--oat-file=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001210 oat_filenames_.push_back(option.substr(strlen("--oat-file=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001211 } else if (option.starts_with("--oat-symbols=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001212 parser_options->oat_symbols.push_back(option.substr(strlen("--oat-symbols=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001213 } else if (option.starts_with("--oat-fd=")) {
1214 ParseOatFd(option);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001215 } else if (option.starts_with("--oat-location=")) {
1216 oat_location_ = option.substr(strlen("--oat-location=")).data();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001217 } else if (option == "--watch-dog") {
1218 parser_options->watch_dog_enabled = true;
1219 } else if (option == "--no-watch-dog") {
1220 parser_options->watch_dog_enabled = false;
Andreas Gampe2e8a2562017-01-18 20:39:02 -08001221 } else if (option.starts_with("--watchdog-timeout=")) {
1222 ParseIntOption(option,
1223 "--watchdog-timeout",
1224 &parser_options->watch_dog_timeout_in_ms,
1225 Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001226 } else if (option.starts_with("-j")) {
1227 ParseJ(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001228 } else if (option.starts_with("--image=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001229 image_filenames_.push_back(option.substr(strlen("--image=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001230 } else if (option.starts_with("--image-classes=")) {
1231 image_classes_filename_ = option.substr(strlen("--image-classes=")).data();
1232 } else if (option.starts_with("--image-classes-zip=")) {
1233 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data();
Mathieu Chartierceb07b32015-12-10 09:33:21 -08001234 } else if (option.starts_with("--image-format=")) {
1235 ParseImageFormat(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001236 } else if (option.starts_with("--compiled-classes=")) {
1237 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data();
1238 } else if (option.starts_with("--compiled-classes-zip=")) {
1239 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data();
1240 } else if (option.starts_with("--compiled-methods=")) {
1241 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data();
1242 } else if (option.starts_with("--compiled-methods-zip=")) {
1243 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data();
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07001244 } else if (option.starts_with("--run-passes=")) {
1245 passes_to_run_filename_ = option.substr(strlen("--run-passes=")).data();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001246 } else if (option.starts_with("--base=")) {
1247 ParseBase(option);
1248 } else if (option.starts_with("--boot-image=")) {
1249 parser_options->boot_image_filename = option.substr(strlen("--boot-image=")).data();
1250 } else if (option.starts_with("--android-root=")) {
1251 android_root_ = option.substr(strlen("--android-root=")).data();
1252 } else if (option.starts_with("--instruction-set=")) {
1253 ParseInstructionSet(option);
1254 } else if (option.starts_with("--instruction-set-variant=")) {
1255 ParseInstructionSetVariant(option, parser_options.get());
1256 } else if (option.starts_with("--instruction-set-features=")) {
1257 ParseInstructionSetFeatures(option, parser_options.get());
1258 } else if (option.starts_with("--compiler-backend=")) {
1259 ParseCompilerBackend(option, parser_options.get());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001260 } else if (option.starts_with("--profile-file=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001261 profile_file_ = option.substr(strlen("--profile-file=")).ToString();
Calin Juravle877fd962016-01-05 14:29:29 +00001262 } else if (option.starts_with("--profile-file-fd=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001263 ParseUintOption(option, "--profile-file-fd", &profile_file_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001264 } else if (option == "--host") {
1265 is_host_ = true;
1266 } else if (option == "--runtime-arg") {
1267 if (++i >= argc) {
1268 Usage("Missing required argument for --runtime-arg");
1269 }
1270 if (log_options) {
1271 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1272 }
1273 runtime_args_.push_back(argv[i]);
1274 } else if (option == "--dump-timing") {
1275 dump_timing_ = true;
1276 } else if (option == "--dump-passes") {
1277 dump_passes_ = true;
Roland Levillain9ec5e222015-08-17 20:18:41 +01001278 } else if (option == "--dump-stats") {
1279 dump_stats_ = true;
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001280 } else if (option == "--avoid-storing-invocation") {
1281 avoid_storing_invocation_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001282 } else if (option.starts_with("--swap-file=")) {
1283 swap_file_name_ = option.substr(strlen("--swap-file=")).data();
1284 } else if (option.starts_with("--swap-fd=")) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001285 ParseUintOption(option, "--swap-fd", &swap_fd_, Usage);
Andreas Gampee1459ae2016-06-29 09:36:30 -07001286 } else if (option.starts_with("--swap-dex-size-threshold=")) {
1287 ParseUintOption(option,
1288 "--swap-dex-size-threshold",
1289 &min_dex_file_cumulative_size_for_swap_,
1290 Usage);
1291 } else if (option.starts_with("--swap-dex-count-threshold=")) {
1292 ParseUintOption(option,
1293 "--swap-dex-count-threshold",
1294 &min_dex_files_for_swap_,
1295 Usage);
Andreas Gampe67f02822016-06-24 21:05:23 -07001296 } else if (option.starts_with("--very-large-app-threshold=")) {
1297 ParseUintOption(option,
1298 "--very-large-app-threshold",
1299 &very_large_threshold_,
1300 Usage);
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001301 } else if (option.starts_with("--app-image-file=")) {
1302 app_image_file_name_ = option.substr(strlen("--app-image-file=")).data();
1303 } else if (option.starts_with("--app-image-fd=")) {
1304 ParseUintOption(option, "--app-image-fd", &app_image_fd_, Usage);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001305 } else if (option == "--multi-image") {
Jeff Hao436183f2016-01-12 16:36:50 -08001306 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001307 } else if (option.starts_with("--no-inline-from=")) {
1308 no_inline_from_string_ = option.substr(strlen("--no-inline-from=")).data();
Andreas Gampeace0dc12016-01-20 13:33:13 -08001309 } else if (option == "--force-determinism") {
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001310 if (!SupportsDeterministicCompilation()) {
Roland Levillainb81e9e92017-04-20 17:35:32 +01001311 Usage("Option --force-determinism requires read barriers or a CMS/MS garbage collector");
Roland Levillaineb2c7412016-01-28 14:37:01 +00001312 }
Andreas Gampeace0dc12016-01-20 13:33:13 -08001313 force_determinism_ = true;
Jeff Hao16d48432017-04-05 17:05:46 -07001314 } else if (option.starts_with("--classpath-dir=")) {
1315 classpath_dir_ = option.substr(strlen("--classpath-dir=")).data();
Calin Juravle1ce70852017-06-28 10:59:03 -07001316 } else if (option.starts_with("--class-loader-context=")) {
1317 class_loader_context_ = ClassLoaderContext::Create(
1318 option.substr(strlen("--class-loader-context=")).data());
Calin Juravle19915892017-08-03 17:10:36 +00001319 if (class_loader_context_ == nullptr) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001320 Usage("Option --class-loader-context has an incorrect format: %s", option.data());
1321 }
Jeff Haoc23b0c02017-07-27 18:19:38 -07001322 } else if (option.starts_with("--dirty-image-objects=")) {
1323 dirty_image_objects_filename_ = option.substr(strlen("--dirty-image-objects=")).data();
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001324 } else if (!compiler_options_->ParseCompilerOption(option, Usage)) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001325 Usage("Unknown argument %s", option.data());
1326 }
1327 }
1328
Jeff Hao436183f2016-01-12 16:36:50 -08001329 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001330
1331 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001332 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001333 }
1334
Jeff Haodcdc85b2015-12-04 14:06:18 -08001335 // Check whether the oat output files are writable, and open them for later. Also open a swap
1336 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001337 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001338 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1339 PruneNonExistentDexFiles();
1340
Jeff Hao436183f2016-01-12 16:36:50 -08001341 // Expand oat and image filenames for multi image.
1342 if (IsBootImage() && multi_image_) {
1343 ExpandOatAndImageFilenames();
1344 }
1345
David Brazdil7b49e6c2016-09-01 11:06:18 +01001346 // OAT and VDEX file handling
David Brazdil7b49e6c2016-09-01 11:06:18 +01001347 if (oat_fd_ == -1) {
1348 DCHECK(!oat_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08001349 for (const char* oat_filename : oat_filenames_) {
1350 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
1351 if (oat_file.get() == nullptr) {
1352 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1353 return false;
1354 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001355 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001356 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1357 oat_file->Erase();
1358 return false;
1359 }
1360 oat_files_.push_back(std::move(oat_file));
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001361 DCHECK_EQ(input_vdex_fd_, -1);
1362 if (!input_vdex_.empty()) {
1363 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001364 input_vdex_file_ = VdexFile::Open(input_vdex_,
1365 /* writable */ false,
1366 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001367 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001368 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001369 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001370
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001371 DCHECK_EQ(output_vdex_fd_, -1);
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001372 std::string vdex_filename = output_vdex_.empty()
1373 ? ReplaceFileExtension(oat_filename, "vdex")
1374 : output_vdex_;
1375 if (vdex_filename == input_vdex_ && output_vdex_.empty()) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001376 update_input_vdex_ = true;
1377 std::unique_ptr<File> vdex_file(OS::OpenFileReadWrite(vdex_filename.c_str()));
1378 vdex_files_.push_back(std::move(vdex_file));
1379 } else {
1380 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
1381 if (vdex_file.get() == nullptr) {
1382 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1383 return false;
1384 }
1385 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1386 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1387 vdex_file->Erase();
1388 return false;
1389 }
1390 vdex_files_.push_back(std::move(vdex_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001391 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001392 }
1393 } else {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001394 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, /* check_usage */ true));
Jeff Haodcdc85b2015-12-04 14:06:18 -08001395 if (oat_file.get() == nullptr) {
1396 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1397 return false;
1398 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001399 oat_file->DisableAutoClose();
1400 if (oat_file->SetLength(0) != 0) {
1401 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1402 }
1403 oat_files_.push_back(std::move(oat_file));
1404
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001405 if (input_vdex_fd_ != -1) {
1406 struct stat s;
1407 int rc = TEMP_FAILURE_RETRY(fstat(input_vdex_fd_, &s));
1408 if (rc == -1) {
1409 PLOG(WARNING) << "Failed getting length of vdex file";
1410 } else {
1411 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001412 input_vdex_file_ = VdexFile::Open(input_vdex_fd_,
1413 s.st_size,
1414 "vdex",
1415 /* writable */ false,
1416 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001417 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001418 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001419 // If there's any problem with the passed vdex, just warn and proceed
1420 // without it.
1421 if (input_vdex_file_ == nullptr) {
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001422 PLOG(WARNING) << "Failed opening vdex file: " << error_msg;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001423 }
1424 }
1425 }
1426
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001427 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001428 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001429 std::unique_ptr<File> vdex_file(new File(output_vdex_fd_, vdex_location, /* check_usage */ true));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001430 if (vdex_file.get() == nullptr) {
1431 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001432 return false;
1433 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001434 vdex_file->DisableAutoClose();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001435 if (input_vdex_file_ != nullptr && output_vdex_fd_ == input_vdex_fd_) {
1436 update_input_vdex_ = true;
1437 } else {
1438 if (vdex_file->SetLength(0) != 0) {
1439 PLOG(ERROR) << "Truncating vdex file " << vdex_location << " failed.";
1440 return false;
1441 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001442 }
1443 vdex_files_.push_back(std::move(vdex_file));
1444
Jeff Haodcdc85b2015-12-04 14:06:18 -08001445 oat_filenames_.push_back(oat_location_.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001446 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001447
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001448 // If we're updating in place a vdex file, be defensive and put an invalid vdex magic in case
1449 // dex2oat gets killed.
1450 // Note: we're only invalidating the magic data in the file, as dex2oat needs the rest of
1451 // the information to remain valid.
1452 if (update_input_vdex_) {
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07001453 std::unique_ptr<BufferedOutputStream> vdex_out = std::make_unique<BufferedOutputStream>(
1454 std::make_unique<FileOutputStream>(vdex_files_.back().get()));
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001455 if (!vdex_out->WriteFully(&VdexFile::Header::kVdexInvalidMagic,
1456 arraysize(VdexFile::Header::kVdexInvalidMagic))) {
1457 PLOG(ERROR) << "Failed to invalidate vdex header. File: " << vdex_out->GetLocation();
1458 return false;
1459 }
1460
1461 if (!vdex_out->Flush()) {
1462 PLOG(ERROR) << "Failed to flush stream after invalidating header of vdex file."
1463 << " File: " << vdex_out->GetLocation();
1464 return false;
1465 }
1466 }
1467
David Brazdil7b49e6c2016-09-01 11:06:18 +01001468 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001469 //
1470 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1471 // that we can use for swap.
1472 //
1473 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1474 // will immediately unlink to satisfy the swap fd assumption.
1475 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1476 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1477 if (swap_file.get() == nullptr) {
1478 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1479 return false;
1480 }
1481 swap_fd_ = swap_file->Fd();
1482 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1483 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1484 // released immediately.
1485 unlink(swap_file_name_.c_str());
1486 }
Jeff Hao436183f2016-01-12 16:36:50 -08001487
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001488 return true;
1489 }
1490
David Brazdil7b49e6c2016-09-01 11:06:18 +01001491 void EraseOutputFiles() {
1492 for (auto& files : { &vdex_files_, &oat_files_ }) {
1493 for (size_t i = 0; i < files->size(); ++i) {
1494 if ((*files)[i].get() != nullptr) {
1495 (*files)[i]->Erase();
1496 (*files)[i].reset();
1497 }
1498 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001499 }
Andreas Gampea650e702014-12-03 14:28:02 -08001500 }
1501
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001502 void LoadClassProfileDescriptors() {
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -07001503 if (profile_compilation_info_ != nullptr && IsImage()) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001504 Runtime* runtime = Runtime::Current();
1505 CHECK(runtime != nullptr);
Mathieu Chartier0b490842016-05-25 15:05:59 -07001506 // Filter out class path classes since we don't want to include these in the image.
Mathieu Chartier4f342b02017-07-21 17:12:39 -07001507 image_classes_.reset(
1508 new std::unordered_set<std::string>(
1509 profile_compilation_info_->GetClassDescriptors(dex_files_)));
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001510 VLOG(compiler) << "Loaded " << image_classes_->size()
1511 << " image class descriptors from profile";
1512 if (VLOG_IS_ON(compiler)) {
1513 for (const std::string& s : *image_classes_) {
1514 LOG(INFO) << "Image class " << s;
1515 }
1516 }
1517 }
1518 }
1519
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001520 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1521 // boot class path.
Andreas Gampef7882972017-03-20 16:35:24 -07001522 dex2oat::ReturnCode Setup() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001523 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001524
Jeff Haoc23b0c02017-07-27 18:19:38 -07001525 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods() ||
1526 !PrepareDirtyObjects()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001527 return dex2oat::ReturnCode::kOther;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001528 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001529
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001530 // Verification results are null since we don't know if we will need them yet as the compler
1531 // filter may change.
Andreas Gampe4585f872015-03-27 23:45:15 -07001532 callbacks_.reset(new QuickCompilerCallbacks(
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001533 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001534 CompilerCallbacks::CallbackMode::kCompileBootImage :
1535 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001536
Vladimir Marko49b0f452015-12-10 13:49:19 +00001537 RuntimeArgumentMap runtime_options;
Mathieu Chartier46331a62017-07-21 09:49:10 -07001538 if (!PrepareRuntimeOptions(&runtime_options, callbacks_.get())) {
Andreas Gampef7882972017-03-20 16:35:24 -07001539 return dex2oat::ReturnCode::kOther;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001540 }
1541
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001542 CreateOatWriters();
1543 if (!AddDexFileSources()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001544 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001545 }
1546
1547 if (IsBootImage() && image_filenames_.size() > 1) {
1548 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1549 // We need this for the multi-image case.
Mathieu Chartier866d8742016-09-21 15:24:18 -07001550 key_value_store_->Put(OatHeader::kBootClassPathKey,
1551 gc::space::ImageSpace::GetMultiImageBootClassPath(dex_locations_,
1552 oat_filenames_,
1553 image_filenames_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001554 }
1555
1556 if (!IsBootImage()) {
1557 // When compiling an app, create the runtime early to retrieve
1558 // the image location key needed for the oat header.
1559 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001560 return dex2oat::ReturnCode::kCreateRuntime;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001561 }
1562
Andreas Gampe29d38e72016-03-23 15:31:51 +00001563 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001564 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1565 std::vector<gc::space::ImageSpace*> image_spaces =
1566 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Richard Uhlerbc26b722017-03-10 14:27:10 +00001567 image_file_location_oat_checksum_ = image_spaces[0]->GetImageHeader().GetOatChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001568 image_file_location_oat_data_begin_ =
1569 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1570 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1571 // Store the boot image filename(s).
1572 std::vector<std::string> image_filenames;
1573 for (const gc::space::ImageSpace* image_space : image_spaces) {
1574 image_filenames.push_back(image_space->GetImageFilename());
1575 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001576 std::string image_file_location = android::base::Join(image_filenames, ':');
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001577 if (!image_file_location.empty()) {
1578 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1579 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001580 } else {
1581 image_file_location_oat_checksum_ = 0u;
1582 image_file_location_oat_data_begin_ = 0u;
1583 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001584 }
1585
1586 // Open dex files for class path.
Calin Juravle19915892017-08-03 17:10:36 +00001587
Calin Juravle1ce70852017-06-28 10:59:03 -07001588 if (class_loader_context_ == nullptr) {
Calin Juravle19915892017-08-03 17:10:36 +00001589 // If no context was specified use the default one (which is an empty PathClassLoader).
1590 class_loader_context_ = std::unique_ptr<ClassLoaderContext>(ClassLoaderContext::Default());
Jeff Haof0192c82016-03-28 20:39:50 -07001591 }
Calin Juravle19915892017-08-03 17:10:36 +00001592
Calin Juravle1ce70852017-06-28 10:59:03 -07001593 DCHECK_EQ(oat_writers_.size(), 1u);
1594
1595 // Note: Ideally we would reject context where the source dex files are also
1596 // specified in the classpath (as it doesn't make sense). However this is currently
1597 // needed for non-prebuild tests and benchmarks which expects on the fly compilation.
1598 // Also, for secondary dex files we do not have control on the actual classpath.
1599 // Instead of aborting, remove all the source location from the context classpaths.
1600 if (class_loader_context_->RemoveLocationsFromClassPaths(
1601 oat_writers_[0]->GetSourceLocations())) {
1602 LOG(WARNING) << "The source files to be compiled are also in the classpath.";
1603 }
1604
1605 // We need to open the dex files before encoding the context in the oat file.
1606 // (because the encoding adds the dex checksum...)
1607 // TODO(calin): consider redesigning this so we don't have to open the dex files before
1608 // creating the actual class loader.
1609 if (!class_loader_context_->OpenDexFiles(runtime_->GetInstructionSet(), classpath_dir_)) {
1610 // Do not abort if we couldn't open files from the classpath. They might be
1611 // apks without dex files and right now are opening flow will fail them.
1612 LOG(WARNING) << "Failed to open classpath dex files";
1613 }
1614
1615 // Store the class loader context in the oat header.
1616 key_value_store_->Put(OatHeader::kClassPathKey,
1617 class_loader_context_->EncodeContextForOatFile(classpath_dir_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001618 }
1619
1620 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001621 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001622 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1623 rodata_.reserve(oat_writers_.size());
1624 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1625 rodata_.push_back(elf_writers_[i]->StartRoData());
1626 // Unzip or copy dex files straight to the oat file.
1627 std::unique_ptr<MemMap> opened_dex_files_map;
1628 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001629 // No need to verify the dex file for:
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001630 // 1) Dexlayout since it does the verification. It also may not pass the verification since
1631 // we don't update the dex checksum.
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001632 // 2) when we have a vdex file, which means it was already verified.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001633 const bool verify = !DoDexLayoutOptimizations() && (input_vdex_file_ == nullptr);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001634 if (!oat_writers_[i]->WriteAndOpenDexFiles(
1635 kIsVdexEnabled ? vdex_files_[i].get() : oat_files_[i].get(),
1636 rodata_.back(),
1637 instruction_set_,
1638 instruction_set_features_.get(),
1639 key_value_store_.get(),
Jeff Hao042e8982016-10-19 11:17:11 -07001640 verify,
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001641 update_input_vdex_,
David Brazdil7b49e6c2016-09-01 11:06:18 +01001642 &opened_dex_files_map,
1643 &opened_dex_files)) {
Andreas Gampef7882972017-03-20 16:35:24 -07001644 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001645 }
1646 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1647 if (opened_dex_files_map != nullptr) {
1648 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
1649 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001650 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001651 opened_dex_files_.push_back(std::move(dex_file));
1652 }
1653 } else {
1654 DCHECK(opened_dex_files.empty());
1655 }
1656 }
1657 }
1658
1659 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
Andreas Gampe7386da42016-06-08 18:18:47 -07001660
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001661 // If we need to downgrade the compiler-filter for size reasons.
1662 if (!IsBootImage() && IsVeryLarge(dex_files_)) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001663 // If we need to downgrade the compiler-filter for size reasons, do that early before we read
1664 // it below for creating verification callbacks.
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001665 if (!CompilerFilter::IsAsGoodAs(kLargeAppFilter, compiler_options_->GetCompilerFilter())) {
1666 LOG(INFO) << "Very large app, downgrading to verify.";
1667 // Note: this change won't be reflected in the key-value store, as that had to be
1668 // finalized before loading the dex files. This setup is currently required
1669 // to get the size from the DexFile objects.
1670 // TODO: refactor. b/29790079
1671 compiler_options_->SetCompilerFilter(kLargeAppFilter);
1672 }
1673 }
1674
1675 if (CompilerFilter::IsAnyCompilationEnabled(compiler_options_->GetCompilerFilter())) {
1676 // Only modes with compilation require verification results, do this here instead of when we
1677 // create the compilation callbacks since the compilation mode may have been changed by the
1678 // very large app logic.
1679 // Avoiding setting the verification results saves RAM by not adding the dex files later in
1680 // the function.
1681 verification_results_.reset(new VerificationResults(compiler_options_.get()));
1682 callbacks_->SetVerificationResults(verification_results_.get());
1683 }
1684
Andreas Gampe7386da42016-06-08 18:18:47 -07001685 // We had to postpone the swap decision till now, as this is the point when we actually
1686 // know about the dex files we're going to use.
1687
1688 // Make sure that we didn't create the driver, yet.
1689 CHECK(driver_ == nullptr);
1690 // If we use a swap file, ensure we are above the threshold to make it necessary.
1691 if (swap_fd_ != -1) {
1692 if (!UseSwap(IsBootImage(), dex_files_)) {
1693 close(swap_fd_);
1694 swap_fd_ = -1;
1695 VLOG(compiler) << "Decided to run without swap.";
1696 } else {
1697 LOG(INFO) << "Large app, accepted running with swap.";
1698 }
1699 }
1700 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001701 if (IsBootImage()) {
1702 // For boot image, pass opened dex files to the Runtime::Create().
1703 // Note: Runtime acquires ownership of these dex files.
1704 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001705 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001706 return dex2oat::ReturnCode::kOther;
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001707 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001708 }
1709
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001710 // If we're doing the image, override the compiler filter to force full compilation. Must be
1711 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1712 // compilation of class initializers.
1713 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001714 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001715 WellKnownClasses::Init(self->GetJniEnv());
1716
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001717 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001718 constexpr bool kSaveDexInput = false;
1719 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001720 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001721 }
1722 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001723
1724 // Ensure opened dex files are writable for dex-to-dex transformations.
1725 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1726 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1727 PLOG(ERROR) << "Failed to make .dex files writeable.";
Andreas Gampef7882972017-03-20 16:35:24 -07001728 return dex2oat::ReturnCode::kOther;
Vladimir Marko919f5532016-01-20 19:13:01 +00001729 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001730 }
1731
Mathieu Chartier72041a02017-07-14 18:23:25 -07001732 // Verification results are only required for modes that have any compilation. Avoid
1733 // adding the dex files if possible to prevent allocating large arrays.
1734 if (verification_results_ != nullptr) {
1735 for (const auto& dex_file : dex_files_) {
1736 // Pre-register dex files so that we can access verification results without locks during
1737 // compilation and verification.
Mathieu Chartier0733dc82017-07-17 14:05:28 -07001738 verification_results_->AddDexFile(dex_file);
1739 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001740 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001741
Andreas Gampef7882972017-03-20 16:35:24 -07001742 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001743 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001744
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001745 // If we need to keep the oat file open for the image writer.
1746 bool ShouldKeepOatFileOpen() const {
1747 return IsImage() && oat_fd_ != kInvalidFd;
1748 }
1749
Mathieu Chartier72041a02017-07-14 18:23:25 -07001750 // Doesn't return the class loader since it's not meant to be used for image compilation.
1751 void CompileDexFilesIndividually() {
1752 CHECK(!IsImage()) << "Not supported with image";
1753 for (const DexFile* dex_file : dex_files_) {
1754 std::vector<const DexFile*> dex_files(1u, dex_file);
1755 VLOG(compiler) << "Compiling " << dex_file->GetLocation();
1756 jobject class_loader = CompileDexFiles(dex_files);
1757 CHECK(class_loader != nullptr);
1758 ScopedObjectAccess soa(Thread::Current());
1759 // Unload class loader to free RAM.
1760 jweak weak_class_loader = soa.Env()->vm->AddWeakGlobalRef(
1761 soa.Self(),
1762 soa.Decode<mirror::ClassLoader>(class_loader));
1763 soa.Env()->vm->DeleteGlobalRef(soa.Self(), class_loader);
1764 runtime_->GetHeap()->CollectGarbage(/*clear_soft_references*/ true);
1765 ObjPtr<mirror::ClassLoader> decoded_weak = soa.Decode<mirror::ClassLoader>(weak_class_loader);
1766 if (decoded_weak != nullptr) {
1767 LOG(FATAL) << "Failed to unload class loader, path from root set: "
1768 << runtime_->GetHeap()->GetVerification()->FirstPathFromRootSet(decoded_weak);
1769 }
1770 VLOG(compiler) << "Unloaded classloader";
1771 }
1772 }
1773
1774 bool ShouldCompileDexFilesIndividually() const {
1775 // Compile individually if we are not building an image, not using any compilation, and are
1776 // using multidex.
1777 // This means extract, verify, and quicken will use the individual compilation mode (to reduce
1778 // RAM used by the compiler).
1779 // TODO: Still do it for app images to get testing coverage. Note that this will generate empty
1780 // app images.
1781 return !IsImage() &&
1782 dex_files_.size() > 1 &&
1783 !CompilerFilter::IsAnyCompilationEnabled(compiler_options_->GetCompilerFilter());
1784 }
1785
1786 // Set up and create the compiler driver and then invoke it to compile all the dex files.
1787 jobject Compile() {
1788 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1789
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001790 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1791 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001792
Vladimir Marko47496c22016-01-27 16:15:08 +00001793 // Find the dex files we should not inline from.
Vladimir Marko47496c22016-01-27 16:15:08 +00001794 std::vector<std::string> no_inline_filters;
1795 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001796
1797 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001798 const std::string core_oj = "core-oj";
1799 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1800 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001801 }
1802
Vladimir Marko47496c22016-01-27 16:15:08 +00001803 if (!no_inline_filters.empty()) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001804 std::vector<const DexFile*> class_path_files;
1805 if (!IsBootImage()) {
1806 // The class loader context is used only for apps.
1807 class_path_files = class_loader_context_->FlattenOpenedDexFiles();
1808 }
1809
Jeff Haodcdc85b2015-12-04 14:06:18 -08001810 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1811 &class_linker->GetBootClassPath(),
1812 &class_path_files,
1813 &dex_files_
1814 };
1815 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001816 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001817 for (const std::string& filter : no_inline_filters) {
1818 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
Calin Juravlea308a322017-07-18 16:51:51 -07001819 // allows tests to specify <test-dexfile>!classes2.dex if needed but if the
Vladimir Marko47496c22016-01-27 16:15:08 +00001820 // base location passes the StartsWith() test, so do all extra locations.
1821 std::string dex_location = dex_file->GetLocation();
1822 if (filter.find('/') == std::string::npos) {
1823 // The filter does not contain the path. Remove the path from dex_location as well.
1824 size_t last_slash = dex_file->GetLocation().rfind('/');
1825 if (last_slash != std::string::npos) {
1826 dex_location = dex_location.substr(last_slash + 1);
1827 }
1828 }
1829
Andreas Gampe9186ced2016-12-12 14:28:21 -08001830 if (android::base::StartsWith(dex_location, filter.c_str())) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001831 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1832 no_inline_from_dex_files_.push_back(dex_file);
1833 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001834 }
1835 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001836 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001837 }
1838 if (!no_inline_from_dex_files_.empty()) {
1839 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001840 }
1841 }
1842
Vladimir Marko307dac92015-10-20 11:20:09 +01001843 driver_.reset(new CompilerDriver(compiler_options_.get(),
1844 verification_results_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001845 compiler_kind_,
1846 instruction_set_,
1847 instruction_set_features_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001848 image_classes_.release(),
1849 compiled_classes_.release(),
Wojciech Staszkiewicz62534792016-08-09 14:30:55 -07001850 compiled_methods_.release(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001851 thread_count_,
1852 dump_stats_,
1853 dump_passes_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001854 compiler_phases_timings_.get(),
1855 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001856 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001857 driver_->SetDexFilesForOatFile(dex_files_);
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001858
1859 // Setup vdex for compilation.
1860 if (!DoEagerUnquickeningOfVdex() && input_vdex_file_ != nullptr) {
1861 callbacks_->SetVerifierDeps(
1862 new verifier::VerifierDeps(dex_files_, input_vdex_file_->GetVerifierDepsData()));
1863
1864 // TODO: we unquicken unconditionally, as we don't know
1865 // if the boot image has changed. How exactly we'll know is under
1866 // experimentation.
1867 TimingLogger::ScopedTiming time_unquicken("Unquicken", timings_);
1868 VdexFile::Unquicken(dex_files_, input_vdex_file_->GetQuickeningInfo());
Mathieu Chartier72041a02017-07-14 18:23:25 -07001869 } else {
1870 // Create the main VerifierDeps, here instead of in the compiler since we want to aggregate
1871 // the results for all the dex files, not just the results for the current dex file.
1872 callbacks_->SetVerifierDeps(new verifier::VerifierDeps(dex_files_));
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001873 }
Mathieu Chartier72041a02017-07-14 18:23:25 -07001874 // Invoke the compilation.
1875 if (ShouldCompileDexFilesIndividually()) {
1876 CompileDexFilesIndividually();
1877 // Return a null classloader since we already freed released it.
1878 return nullptr;
1879 }
1880 return CompileDexFiles(dex_files_);
1881 }
1882
1883 // Create the class loader, use it to compile, and return.
1884 jobject CompileDexFiles(const std::vector<const DexFile*>& dex_files) {
1885 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1886
1887 jobject class_loader = nullptr;
1888 if (!IsBootImage()) {
1889 class_loader = class_loader_context_->CreateClassLoader(dex_files_);
1890 }
1891
1892 // Register dex caches and key them to the class loader so that they only unload when the
1893 // class loader unloads.
1894 for (const auto& dex_file : dex_files) {
1895 ScopedObjectAccess soa(Thread::Current());
1896 // Registering the dex cache adds a strong root in the class loader that prevents the dex
1897 // cache from being unloaded early.
1898 ObjPtr<mirror::DexCache> dex_cache = class_linker->RegisterDexFile(
1899 *dex_file,
1900 soa.Decode<mirror::ClassLoader>(class_loader));
1901 if (dex_cache == nullptr) {
1902 soa.Self()->AssertPendingException();
1903 LOG(FATAL) << "Failed to register dex file " << dex_file->GetLocation() << " "
1904 << soa.Self()->GetException()->Dump();
1905 }
1906 }
1907 driver_->CompileAll(class_loader, dex_files, timings_);
1908 return class_loader;
Vladimir Markof4da6752014-08-01 19:04:18 +01001909 }
1910
Jeff Hao436183f2016-01-12 16:36:50 -08001911 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001912 // ensure the references between the two are correct.
1913 //
1914 // Currently we have a memory layout that looks something like this:
1915 //
1916 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001917 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001918 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001919 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001920 // +--------------+
1921 // | alloc spaces |
1922 // +--------------+
1923 //
Jeff Hao436183f2016-01-12 16:36:50 -08001924 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001925 //
Jeff Hao436183f2016-01-12 16:36:50 -08001926 // 1. The images are expected to be loaded at an absolute address and
1927 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001928 //
Jeff Hao436183f2016-01-12 16:36:50 -08001929 // 2. There are absolute pointers from Methods in the images to their
1930 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001931 //
Jeff Hao436183f2016-01-12 16:36:50 -08001932 // 3. There are absolute pointers from the code in the oat files to Methods
1933 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001934 //
Jeff Hao436183f2016-01-12 16:36:50 -08001935 // 4. There are absolute pointers from code in the oat files to other code
1936 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001937 //
1938 // To get this all correct, we go through several steps.
1939 //
Jeff Hao436183f2016-01-12 16:36:50 -08001940 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001941 // the oat data size and code size. During this stage, we also set
1942 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001943 //
Jeff Hao436183f2016-01-12 16:36:50 -08001944 // 2. We prepare offsets for the objects in the images and calculate
1945 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001946 //
Jeff Hao436183f2016-01-12 16:36:50 -08001947 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001948 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001949 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001950 // can prepare the ELF headers and we then know the ELF memory segment
1951 // layout and we can now resolve all references. The compiler provides
1952 // LinkerPatch information in each CompiledMethod and we resolve these,
1953 // using the layout information and image object locations provided by
1954 // image writer, as we're writing the method code.
1955 //
Jeff Hao436183f2016-01-12 16:36:50 -08001956 // 4. We create the image files. They need to know where the oat files
1957 // will be loaded after itself. Originally oat files were simply
1958 // memory mapped so we could predict where their contents were based
1959 // on the file size. Now that they are ELF files, we need to inspect
1960 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001961 // where the oat header is located within.
1962 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001963 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001964 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001965 // load the .so at the desired location at runtime by offsetting the
1966 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001967 // TODO: Do this in step 3. We already know the layout there.
1968 //
1969 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1970 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001971
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001972 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1973 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001974 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1975 // case (when the file will be explicitly erased).
David Brazdil7b49e6c2016-09-01 11:06:18 +01001976 bool WriteOutputFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001977 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1978
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001979 // Sync the data to the file, in case we did dex2dex transformations.
1980 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1981 if (!map->Sync()) {
1982 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1983 return false;
1984 }
1985 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001986
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001987 if (IsImage()) {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001988 if (IsAppImage() && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001989 gc::Heap* const heap = Runtime::Current()->GetHeap();
1990 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001991 image_base_ = std::max(image_base_, RoundUp(
1992 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1993 kPageSize));
1994 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001995 // The non moving space is right after the oat file. Put the preferred app image location
1996 // right after the non moving space so that we ideally get a continuous immune region for
1997 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001998 // Use the default non moving space capacity since dex2oat does not have a separate non-
1999 // moving space. This means the runtime's non moving space space size will be as large
2000 // as the growth limit for dex2oat, but smaller in the zygote.
2001 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002002 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002003 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
2004 }
2005
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002006 image_writer_.reset(new ImageWriter(*driver_,
2007 image_base_,
2008 compiler_options_->GetCompilePic(),
2009 IsAppImage(),
2010 image_storage_mode_,
2011 oat_filenames_,
Jeff Haoc23b0c02017-07-27 18:19:38 -07002012 dex_file_oat_index_map_,
2013 dirty_image_objects_.get()));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002014
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002015 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002016 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
2017 if (!image_writer_->PrepareImageAddressSpace()) {
2018 LOG(ERROR) << "Failed to prepare image address space.";
2019 return false;
2020 }
2021 }
2022
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002023 // Initialize the writers with the compiler driver, image writer, and their
2024 // dex files. The writers were created without those being there yet.
2025 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
2026 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
2027 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
2028 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
2029 }
2030
David Brazdil5d5a36b2016-09-14 15:34:10 +01002031 {
2032 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
2033 DCHECK(IsBootImage() || oat_files_.size() == 1u);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00002034 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
David Brazdil5d5a36b2016-09-14 15:34:10 +01002035 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
2036 File* vdex_file = vdex_files_[i].get();
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07002037 std::unique_ptr<BufferedOutputStream> vdex_out =
2038 std::make_unique<BufferedOutputStream>(std::make_unique<FileOutputStream>(vdex_file));
David Brazdil5d5a36b2016-09-14 15:34:10 +01002039
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00002040 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002041 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
2042 return false;
2043 }
2044
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002045 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
2046 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
2047 return false;
2048 }
2049
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +00002050 // VDEX finalized, seek back to the beginning and write checksums and the header.
2051 if (!oat_writers_[i]->WriteChecksumsAndVdexHeader(vdex_out.get())) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002052 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
2053 return false;
2054 }
2055 }
2056 }
2057
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002058 {
2059 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002060 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002061 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko944da602016-02-19 12:27:55 +00002062 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
2063 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
2064
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002065 oat_writer->PrepareLayout(&patcher);
Vladimir Marko944da602016-02-19 12:27:55 +00002066
2067 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
David Brazdil7b49e6c2016-09-01 11:06:18 +01002068 size_t text_size = oat_writer->GetOatSize() - rodata_size;
Vladimir Markoaad75c62016-10-03 08:46:48 +00002069 elf_writer->PrepareDynamicSection(rodata_size,
2070 text_size,
2071 oat_writer->GetBssSize(),
Vladimir Marko0eb882b2017-05-15 13:39:18 +01002072 oat_writer->GetBssMethodsOffset(),
Vladimir Markoaad75c62016-10-03 08:46:48 +00002073 oat_writer->GetBssRootsOffset());
Vladimir Marko944da602016-02-19 12:27:55 +00002074
2075 if (IsImage()) {
2076 // Update oat layout.
2077 DCHECK(image_writer_ != nullptr);
2078 DCHECK_LT(i, oat_filenames_.size());
2079 image_writer_->UpdateOatFileLayout(i,
2080 elf_writer->GetLoadedSize(),
2081 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01002082 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002083 }
Richard Uhlerbc26b722017-03-10 14:27:10 +00002084
2085 if (IsBootImage()) {
2086 // Have the image_file_location_oat_checksum_ for boot oat files
2087 // depend on the contents of all the boot oat files. This way only
2088 // the primary image checksum needs to be checked to determine
2089 // whether any of the images are out of date.
2090 image_file_location_oat_checksum_ ^= oat_writer->GetOatHeader().GetChecksum();
2091 }
Vladimir Marko944da602016-02-19 12:27:55 +00002092 }
2093
2094 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002095 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002096 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
2097 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00002098
David Srbecky09c2a6b2016-03-11 17:11:44 +00002099 oat_writer->AddMethodDebugInfos(debug::MakeTrampolineInfos(oat_writer->GetOatHeader()));
2100
David Srbecky0c4572e2016-01-22 19:19:25 +00002101 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00002102 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
2103 elf_writer->PrepareDebugInfo(oat_writer->GetMethodDebugInfo());
David Srbecky0c4572e2016-01-22 19:19:25 +00002104
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002105 OutputStream*& rodata = rodata_[i];
2106 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002107 if (!oat_writer->WriteRodata(rodata)) {
2108 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
2109 return false;
2110 }
2111 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002112 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00002113
Jeff Haodcdc85b2015-12-04 14:06:18 -08002114 OutputStream* text = elf_writer->StartText();
2115 if (!oat_writer->WriteCode(text)) {
2116 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
2117 return false;
2118 }
2119 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00002120
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002121 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
2122 image_file_location_oat_checksum_,
2123 image_file_location_oat_data_begin_,
2124 image_patch_delta_)) {
2125 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
2126 return false;
2127 }
2128
Vladimir Marko944da602016-02-19 12:27:55 +00002129 if (IsImage()) {
2130 // Update oat header information.
2131 DCHECK(image_writer_ != nullptr);
2132 DCHECK_LT(i, oat_filenames_.size());
2133 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
2134 }
2135
Jeff Haodcdc85b2015-12-04 14:06:18 -08002136 elf_writer->WriteDynamicSection();
2137 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
Vladimir Marko10c13562015-11-25 14:33:36 +00002138
Jeff Haodcdc85b2015-12-04 14:06:18 -08002139 if (!elf_writer->End()) {
2140 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
2141 return false;
2142 }
2143
David Brazdil7b49e6c2016-09-01 11:06:18 +01002144 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
2145 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002146 }
2147
Jeff Haodcdc85b2015-12-04 14:06:18 -08002148 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002149
2150 oat_writer.reset();
2151 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002152 }
2153 }
2154
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002155 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002156 }
2157
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002158 // If we are compiling an image, invoke the image creation routine. Else just skip.
2159 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002160 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002161 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
2162 if (!CreateImageFile()) {
2163 return false;
2164 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002165 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07002166 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002167 return true;
2168 }
2169
Jeff Haodcdc85b2015-12-04 14:06:18 -08002170 // Create a copy from stripped to unstripped.
2171 bool CopyStrippedToUnstripped() {
2172 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
2173 // If we don't want to strip in place, copy from stripped location to unstripped location.
2174 // We need to strip after image creation because FixupElf needs to use .strtab.
2175 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
2176 // If the oat file is still open, flush it.
2177 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002178 if (!FlushCloseOutputFile(&oat_files_[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002179 return false;
2180 }
2181 }
2182
2183 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
2184 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
2185 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01002186 int64_t in_length = in->GetLength();
2187 if (in_length < 0) {
2188 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
2189 return false;
2190 }
2191 if (!out->Copy(in.get(), 0, in_length)) {
2192 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
2193 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002194 }
2195 if (out->FlushCloseOrErase() != 0) {
2196 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
2197 return false;
2198 }
2199 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
2200 }
2201 }
2202 return true;
2203 }
2204
David Brazdil7b49e6c2016-09-01 11:06:18 +01002205 bool FlushOutputFile(std::unique_ptr<File>* file) {
2206 if (file->get() != nullptr) {
2207 if (file->get()->Flush() != 0) {
2208 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
2209 return false;
2210 }
2211 }
2212 return true;
2213 }
2214
2215 bool FlushCloseOutputFile(std::unique_ptr<File>* file) {
2216 if (file->get() != nullptr) {
2217 std::unique_ptr<File> tmp(file->release());
2218 if (tmp->FlushCloseOrErase() != 0) {
2219 PLOG(ERROR) << "Failed to flush and close output file: " << tmp->GetPath();
2220 return false;
2221 }
2222 }
2223 return true;
2224 }
2225
2226 bool FlushOutputFiles() {
2227 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
2228 for (auto& files : { &vdex_files_, &oat_files_ }) {
2229 for (size_t i = 0; i < files->size(); ++i) {
2230 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002231 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08002232 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002233 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00002234 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002235 return true;
2236 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002237
David Brazdil7b49e6c2016-09-01 11:06:18 +01002238 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002239 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002240 for (auto& files : { &vdex_files_, &oat_files_ }) {
2241 for (size_t i = 0; i < files->size(); ++i) {
2242 result &= FlushCloseOutputFile(&(*files)[i]);
2243 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002244 }
2245 return result;
2246 }
2247
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002248 void DumpTiming() {
2249 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
2250 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2251 }
2252 if (dump_passes_) {
2253 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
2254 }
2255 }
2256
Andreas Gampe10e477d2014-11-19 12:57:42 -08002257 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002258 return IsAppImage() || IsBootImage();
2259 }
2260
2261 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002262 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002263 }
2264
2265 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002266 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002267 }
2268
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002269 bool IsHost() const {
2270 return is_host_;
2271 }
2272
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002273 bool UseProfile() const {
Mathieu Chartierd0af56c2017-02-17 12:56:25 -08002274 return profile_file_fd_ != -1 || !profile_file_.empty();
Calin Juravle998c2162015-12-21 15:39:33 +02002275 }
2276
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002277 bool DoProfileGuidedOptimizations() const {
Nicolas Geoffray49cda062017-04-21 13:08:25 +01002278 return UseProfile();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002279 }
2280
2281 bool DoDexLayoutOptimizations() const {
2282 return DoProfileGuidedOptimizations();
2283 }
2284
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01002285 bool DoEagerUnquickeningOfVdex() const {
2286 // DexLayout can invalidate the vdex metadata, so we need to unquicken
2287 // the vdex file eagerly, before passing it to dexlayout.
2288 return DoDexLayoutOptimizations();
2289 }
2290
Calin Juravle2e2db782016-02-23 12:00:03 +00002291 bool LoadProfile() {
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002292 DCHECK(UseProfile());
Calin Juravlee6f87cc2017-05-24 17:41:05 -07002293 // TODO(calin): We should be using the runtime arena pool (instead of the
2294 // default profile arena). However the setup logic is messy and needs
2295 // cleaning up before that (e.g. the oat writers are created before the
2296 // runtime).
Calin Juravle2e2db782016-02-23 12:00:03 +00002297 profile_compilation_info_.reset(new ProfileCompilationInfo());
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002298 ScopedFlock profile_file;
Calin Juravle2e2db782016-02-23 12:00:03 +00002299 std::string error;
2300 if (profile_file_fd_ != -1) {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002301 profile_file = LockedFile::DupOf(profile_file_fd_, "profile",
2302 true /* read_only_mode */, &error);
Andreas Gampe29d38e72016-03-23 15:31:51 +00002303 } else if (profile_file_ != "") {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002304 profile_file = LockedFile::Open(profile_file_.c_str(), O_RDONLY, true, &error);
Calin Juravle998c2162015-12-21 15:39:33 +02002305 }
Calin Juravle877fd962016-01-05 14:29:29 +00002306
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002307 // Return early if we're unable to obtain a lock on the profile.
2308 if (profile_file.get() == nullptr) {
2309 LOG(ERROR) << "Cannot lock profiles: " << error;
2310 return false;
2311 }
2312
2313 if (!profile_compilation_info_->Load(profile_file->Fd())) {
Calin Juravle2e2db782016-02-23 12:00:03 +00002314 profile_compilation_info_.reset(nullptr);
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002315 return false;
Calin Juravle2e2db782016-02-23 12:00:03 +00002316 }
Calin Juravle877fd962016-01-05 14:29:29 +00002317
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002318 return true;
Calin Juravle998c2162015-12-21 15:39:33 +02002319 }
2320
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002321 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002322 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2323 if (is_image) {
2324 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2325 return false;
2326 }
2327 if (dex_files.size() < min_dex_files_for_swap_) {
2328 // If there are less dex files than the threshold, assume it's gonna be fine.
2329 return false;
2330 }
2331 size_t dex_files_size = 0;
2332 for (const auto* dex_file : dex_files) {
2333 dex_files_size += dex_file->GetHeader().file_size_;
2334 }
2335 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2336 }
2337
Andreas Gampe67f02822016-06-24 21:05:23 -07002338 bool IsVeryLarge(std::vector<const DexFile*>& dex_files) {
2339 size_t dex_files_size = 0;
2340 for (const auto* dex_file : dex_files) {
2341 dex_files_size += dex_file->GetHeader().file_size_;
2342 }
2343 return dex_files_size >= very_large_threshold_;
2344 }
2345
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002346 std::vector<std::string> GetClassPathLocations(const std::string& class_path) {
2347 // This function is used only for apps and for an app we have exactly one oat file.
2348 DCHECK(!IsBootImage());
2349 DCHECK_EQ(oat_writers_.size(), 1u);
2350 std::vector<std::string> dex_files_canonical_locations;
Calin Juravle1ce70852017-06-28 10:59:03 -07002351 for (const std::string& location : oat_writers_[0]->GetSourceLocations()) {
2352 dex_files_canonical_locations.push_back(DexFile::GetDexCanonicalLocation(location.c_str()));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002353 }
Vladimir Marko625a64a2015-11-26 14:44:16 +00002354
Vladimir Marko919f5532016-01-20 19:13:01 +00002355 std::vector<std::string> parsed;
2356 Split(class_path, ':', &parsed);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002357 auto kept_it = std::remove_if(parsed.begin(),
2358 parsed.end(),
2359 [dex_files_canonical_locations](const std::string& location) {
2360 return ContainsElement(dex_files_canonical_locations,
2361 DexFile::GetDexCanonicalLocation(location.c_str()));
2362 });
2363 parsed.erase(kept_it, parsed.end());
2364 return parsed;
2365 }
2366
Vladimir Marko49b0f452015-12-10 13:49:19 +00002367 bool PrepareImageClasses() {
2368 // If --image-classes was specified, calculate the full list of classes to include in the image.
2369 if (image_classes_filename_ != nullptr) {
2370 image_classes_ =
2371 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2372 if (image_classes_ == nullptr) {
2373 return false;
2374 }
2375 } else if (IsBootImage()) {
2376 image_classes_.reset(new std::unordered_set<std::string>);
2377 }
2378 return true;
2379 }
2380
2381 bool PrepareCompiledClasses() {
2382 // If --compiled-classes was specified, calculate the full list of classes to compile in the
2383 // image.
2384 if (compiled_classes_filename_ != nullptr) {
2385 compiled_classes_ =
2386 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
2387 if (compiled_classes_ == nullptr) {
2388 return false;
2389 }
2390 } else {
2391 compiled_classes_.reset(nullptr); // By default compile everything.
2392 }
2393 return true;
2394 }
2395
2396 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2397 const char* classes_filename,
2398 const char* tag) {
2399 std::unique_ptr<std::unordered_set<std::string>> classes;
2400 std::string error_msg;
2401 if (zip_filename != nullptr) {
2402 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2403 } else {
2404 classes.reset(ReadImageClassesFromFile(classes_filename));
2405 }
2406 if (classes == nullptr) {
2407 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2408 << classes_filename << "': " << error_msg;
2409 }
2410 return classes;
2411 }
2412
2413 bool PrepareCompiledMethods() {
2414 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2415 if (compiled_methods_filename_ != nullptr) {
2416 std::string error_msg;
2417 if (compiled_methods_zip_filename_ != nullptr) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002418 compiled_methods_.reset(ReadCommentedInputFromZip<std::unordered_set<std::string>>(
2419 compiled_methods_zip_filename_,
2420 compiled_methods_filename_,
2421 nullptr, // No post-processing.
2422 &error_msg));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002423 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002424 compiled_methods_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2425 compiled_methods_filename_,
2426 nullptr)); // No post-processing.
Vladimir Marko49b0f452015-12-10 13:49:19 +00002427 }
2428 if (compiled_methods_.get() == nullptr) {
2429 LOG(ERROR) << "Failed to create list of compiled methods from '"
2430 << compiled_methods_filename_ << "': " << error_msg;
2431 return false;
2432 }
2433 } else {
2434 compiled_methods_.reset(nullptr); // By default compile everything.
2435 }
2436 return true;
2437 }
2438
Jeff Haoc23b0c02017-07-27 18:19:38 -07002439 bool PrepareDirtyObjects() {
2440 if (dirty_image_objects_filename_ != nullptr) {
2441 dirty_image_objects_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2442 dirty_image_objects_filename_,
2443 nullptr));
2444 if (dirty_image_objects_ == nullptr) {
2445 LOG(ERROR) << "Failed to create list of dirty objects from '"
2446 << dirty_image_objects_filename_ << "'";
2447 return false;
2448 }
2449 } else {
2450 dirty_image_objects_.reset(nullptr);
2451 }
2452 return true;
2453 }
2454
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002455 void PruneNonExistentDexFiles() {
2456 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2457 size_t kept = 0u;
2458 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2459 if (!OS::FileExists(dex_filenames_[i])) {
2460 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2461 } else {
2462 dex_filenames_[kept] = dex_filenames_[i];
2463 dex_locations_[kept] = dex_locations_[i];
2464 ++kept;
2465 }
2466 }
2467 dex_filenames_.resize(kept);
2468 dex_locations_.resize(kept);
2469 }
2470
2471 bool AddDexFileSources() {
2472 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002473 if (input_vdex_file_ != nullptr) {
2474 DCHECK_EQ(oat_writers_.size(), 1u);
2475 const std::string& name = zip_location_.empty() ? dex_locations_[0] : zip_location_;
2476 DCHECK(!name.empty());
2477 if (!oat_writers_[0]->AddVdexDexFilesSource(*input_vdex_file_.get(), name.c_str())) {
2478 return false;
2479 }
2480 } else if (zip_fd_ != -1) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002481 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002482 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2483 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002484 return false;
2485 }
2486 } else if (oat_writers_.size() > 1u) {
2487 // Multi-image.
2488 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2489 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2490 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2491 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2492 return false;
2493 }
2494 }
2495 } else {
2496 DCHECK_EQ(oat_writers_.size(), 1u);
2497 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2498 DCHECK_NE(dex_filenames_.size(), 0u);
2499 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2500 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2501 return false;
2502 }
2503 }
2504 }
2505 return true;
2506 }
2507
2508 void CreateOatWriters() {
2509 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2510 elf_writers_.reserve(oat_files_.size());
2511 oat_writers_.reserve(oat_files_.size());
2512 for (const std::unique_ptr<File>& oat_file : oat_files_) {
David Srbecky5d811202016-03-08 13:21:22 +00002513 elf_writers_.emplace_back(CreateElfWriterQuick(instruction_set_,
2514 instruction_set_features_.get(),
2515 compiler_options_.get(),
2516 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002517 elf_writers_.back()->Start();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002518 const bool do_dexlayout = DoDexLayoutOptimizations();
Jeff Hao608f2ce2016-10-19 11:17:11 -07002519 oat_writers_.emplace_back(new OatWriter(
2520 IsBootImage(), timings_, do_dexlayout ? profile_compilation_info_.get() : nullptr));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002521 }
2522 }
2523
Vladimir Marko49b0f452015-12-10 13:49:19 +00002524 void SaveDexInput() {
2525 for (size_t i = 0; i < dex_files_.size(); ++i) {
2526 const DexFile* dex_file = dex_files_[i];
2527 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2528 getpid(), i));
2529 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2530 if (tmp_file.get() == nullptr) {
2531 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2532 << ". Try: adb shell chmod 777 /data/local/tmp";
2533 continue;
2534 }
2535 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2536 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2537 UNUSED(tmp_file->Flush());
2538 UNUSED(tmp_file->Close());
2539 LOG(INFO) << "Wrote input to " << tmp_file_name;
2540 }
2541 }
2542
Mathieu Chartier46331a62017-07-21 09:49:10 -07002543 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options,
2544 QuickCompilerCallbacks* callbacks) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00002545 RuntimeOptions raw_options;
2546 if (boot_image_filename_.empty()) {
2547 std::string boot_class_path = "-Xbootclasspath:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002548 boot_class_path += android::base::Join(dex_filenames_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002549 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2550 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002551 boot_class_path_locations += android::base::Join(dex_locations_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002552 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2553 } else {
2554 std::string boot_image_option = "-Ximage:";
2555 boot_image_option += boot_image_filename_;
2556 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2557 }
2558 for (size_t i = 0; i < runtime_args_.size(); i++) {
2559 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2560 }
2561
Mathieu Chartier46331a62017-07-21 09:49:10 -07002562 raw_options.push_back(std::make_pair("compilercallbacks", callbacks));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002563 raw_options.push_back(
2564 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2565
2566 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2567 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2568 // have been stripped in preopting, anyways).
2569 if (!IsBootImage()) {
2570 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2571 }
Andreas Gampec8e35202017-04-28 15:47:12 -07002572 // Never allow implicit image compilation.
2573 raw_options.push_back(std::make_pair("-Xnoimage-dex2oat", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002574 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2575 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2576 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002577 // Disable Hspace compaction to save heap size virtual space.
2578 // Only need disable Hspace for OOM becasue background collector is equal to
2579 // foreground collector by default for dex2oat.
2580 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002581
Andreas Gampeace0dc12016-01-20 13:33:13 -08002582 if (compiler_options_->IsForceDeterminism()) {
Roland Levillainb81e9e92017-04-20 17:35:32 +01002583 // If we're asked to be deterministic, ensure non-concurrent GC for determinism.
2584 //
2585 // Note that with read barriers, this option is ignored, because Runtime::Init
2586 // overrides the foreground GC to be gc::kCollectorTypeCC when instantiating
2587 // gc::Heap. This is fine, as concurrent GC requests are not honored in dex2oat,
2588 // which uses an unstarted runtime.
Andreas Gampeace0dc12016-01-20 13:33:13 -08002589 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
Roland Levillainb81e9e92017-04-20 17:35:32 +01002590
Nicolas Geoffray7acddd82017-05-03 15:04:55 +01002591 // The default LOS implementation (map) is not deterministic. So disable it.
2592 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=disabled", nullptr));
Andreas Gampeace0dc12016-01-20 13:33:13 -08002593
2594 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2595 // compaction (done above) and ensure that neither foreground nor background collectors
2596 // are concurrent.
Roland Levillainb81e9e92017-04-20 17:35:32 +01002597 //
2598 // Likewise, this option is ignored with read barriers because Runtime::Init
2599 // overrides the background GC to be gc::kCollectorTypeCCBackground, but that's
2600 // fine too, for the same reason (see above).
Andreas Gampeace0dc12016-01-20 13:33:13 -08002601 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2602
2603 // To make identity hashcode deterministic, set a known seed.
2604 mirror::Object::SetHashCodeSeed(987654321U);
2605 }
2606
Vladimir Marko49b0f452015-12-10 13:49:19 +00002607 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2608 LOG(ERROR) << "Failed to parse runtime options";
2609 return false;
2610 }
2611 return true;
2612 }
2613
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002614 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002615 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2616 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002617 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002618 LOG(ERROR) << "Failed to create runtime";
2619 return false;
2620 }
Andreas Gampe49c144d2016-11-14 10:11:16 -08002621
2622 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2623 // "ps -a" don't change to non-descript "main."
2624 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2625
Vladimir Marko307dac92015-10-20 11:20:09 +01002626 runtime_.reset(Runtime::Current());
2627 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe8228cdf2017-05-30 15:03:54 -07002628 for (uint32_t i = 0; i < static_cast<uint32_t>(CalleeSaveType::kLastCalleeSaveType); ++i) {
2629 CalleeSaveType type = CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002630 if (!runtime_->HasCalleeSaveMethod(type)) {
2631 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002632 }
2633 }
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002634
2635 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2636 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002637 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002638
Vladimir Marko307dac92015-10-20 11:20:09 +01002639 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002640
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002641 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2642 // Runtime::Start, give it away now so that we don't starve GC.
2643 Thread* self = Thread::Current();
2644 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002645
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002646 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002647 }
2648
Jeff Haodcdc85b2015-12-04 14:06:18 -08002649 // 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 -08002650 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002651 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002652 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002653 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002654 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002655 image_filenames_.push_back(app_image_file_name_.c_str());
2656 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002657 if (!image_writer_->Write(app_image_fd_,
2658 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002659 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002660 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002661 return false;
2662 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002663
Jeff Haodcdc85b2015-12-04 14:06:18 -08002664 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002665 dchecked_vector<uintptr_t> oat_data_begins;
2666 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2667 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002668 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002669 // Destroy ImageWriter before doing FixupElf.
2670 image_writer_.reset();
2671
Vladimir Marko944da602016-02-19 12:27:55 +00002672 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2673 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002674 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2675 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2676 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2677 if (oat_file.get() == nullptr) {
2678 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2679 return false;
2680 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002681
Vladimir Marko944da602016-02-19 12:27:55 +00002682 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002683 oat_file->Erase();
2684 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2685 return false;
2686 }
2687
2688 if (oat_file->FlushCloseOrErase()) {
2689 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2690 return false;
2691 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002692 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002693 }
2694
2695 return true;
2696 }
2697
2698 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002699 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2700 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002701 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002702 return ReadCommentedInputFromFile<std::unordered_set<std::string>>(image_classes_filename,
2703 &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002704 }
2705
2706 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002707 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002708 const char* zip_filename,
2709 const char* image_classes_filename,
2710 std::string* error_msg) {
2711 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002712 return ReadCommentedInputFromZip<std::unordered_set<std::string>>(zip_filename,
2713 image_classes_filename,
2714 &process,
2715 error_msg);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002716 }
2717
2718 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2719 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002720 template <typename T>
2721 static T* ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002722 const char* input_filename, std::function<std::string(const char*)>* process) {
2723 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2724 if (input_file.get() == nullptr) {
2725 LOG(ERROR) << "Failed to open input file " << input_filename;
2726 return nullptr;
2727 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002728 std::unique_ptr<T> result(
2729 ReadCommentedInputStream<T>(*input_file, process));
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002730 input_file->close();
2731 return result.release();
2732 }
2733
2734 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2735 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002736 template <typename T>
2737 static T* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002738 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002739 const char* input_filename,
2740 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002741 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002742 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2743 if (zip_archive.get() == nullptr) {
2744 return nullptr;
2745 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002746 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002747 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002748 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002749 zip_filename, error_msg->c_str());
2750 return nullptr;
2751 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002752 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2753 input_filename,
2754 error_msg));
2755 if (input_file.get() == nullptr) {
2756 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002757 zip_filename, error_msg->c_str());
2758 return nullptr;
2759 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002760 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2761 input_file->Size());
2762 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002763 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002764 }
2765
2766 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2767 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002768 template <typename T>
2769 static T* ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002770 std::istream& in_stream,
2771 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002772 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002773 while (in_stream.good()) {
2774 std::string dot;
2775 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08002776 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002777 continue;
2778 }
2779 if (process != nullptr) {
2780 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002781 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002782 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002783 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002784 }
2785 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002786 return output.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002787 }
2788
Mathieu Chartier49285c52014-12-02 15:43:48 -08002789 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002790 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2791 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002792 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampec560fc02014-07-16 09:57:39 -07002793 LOG(INFO) << "dex2oat took "
2794 << PrettyDuration(NanoTime() - start_ns_)
Andreas Gampecc967752016-12-12 13:49:00 -08002795 << " (" << PrettyDuration(ProcessCpuNanoTime() - start_cputime_ns_) << " cpu)"
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002796 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002797 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002798 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2799 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002800 }
2801
Jeff Haodcdc85b2015-12-04 14:06:18 -08002802 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2803 std::string res(image_filename);
2804 size_t last_slash = res.rfind('/');
2805 if (last_slash == std::string::npos || last_slash == 0) {
2806 return res;
2807 }
2808 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2809 if (penultimate_slash == std::string::npos) {
2810 return res;
2811 }
2812 // Check that the string in-between is the expected one.
2813 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2814 GetInstructionSetString(isa)) {
2815 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2816 return res;
2817 }
2818 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2819 }
2820
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002821 std::unique_ptr<CompilerOptions> compiler_options_;
2822 Compiler::Kind compiler_kind_;
2823
2824 InstructionSet instruction_set_;
2825 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2826
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002827 uint32_t image_file_location_oat_checksum_;
2828 uintptr_t image_file_location_oat_data_begin_;
2829 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002830 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2831
Vladimir Marko307dac92015-10-20 11:20:09 +01002832 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002833
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002834 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2835
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002836 std::unique_ptr<Runtime> runtime_;
2837
Calin Juravle1ce70852017-06-28 10:59:03 -07002838 // The spec describing how the class loader should be setup for compilation.
2839 std::unique_ptr<ClassLoaderContext> class_loader_context_;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002840
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002841 size_t thread_count_;
2842 uint64_t start_ns_;
Andreas Gampec560fc02014-07-16 09:57:39 -07002843 uint64_t start_cputime_ns_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002844 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002845 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002846 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002847 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002848 std::vector<const char*> oat_filenames_;
2849 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002850 int oat_fd_;
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00002851 int input_vdex_fd_;
2852 int output_vdex_fd_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002853 std::string input_vdex_;
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01002854 std::string output_vdex_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002855 std::unique_ptr<VdexFile> input_vdex_file_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002856 std::vector<const char*> dex_filenames_;
2857 std::vector<const char*> dex_locations_;
2858 int zip_fd_;
2859 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002860 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002861 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002862 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002863 uintptr_t image_base_;
2864 const char* image_classes_zip_filename_;
2865 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002866 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002867 const char* compiled_classes_zip_filename_;
2868 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002869 const char* compiled_methods_zip_filename_;
2870 const char* compiled_methods_filename_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002871 const char* passes_to_run_filename_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002872 const char* dirty_image_objects_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002873 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2874 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002875 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002876 std::unique_ptr<std::unordered_set<std::string>> dirty_image_objects_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002877 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Jeff Hao436183f2016-01-12 16:36:50 -08002878 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002879 bool is_host_;
2880 std::string android_root_;
Mathieu Chartier0b490842016-05-25 15:05:59 -07002881 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002882 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002883 std::string no_inline_from_string_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002884
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002885 std::vector<std::unique_ptr<ElfWriter>> elf_writers_;
2886 std::vector<std::unique_ptr<OatWriter>> oat_writers_;
2887 std::vector<OutputStream*> rodata_;
David Brazdil5d5a36b2016-09-14 15:34:10 +01002888 std::vector<std::unique_ptr<OutputStream>> vdex_out_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002889 std::unique_ptr<ImageWriter> image_writer_;
2890 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002891
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002892 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
2893 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2894
Calin Juravle1ce70852017-06-28 10:59:03 -07002895 // Note that this might contain pointers owned by class_loader_context_.
Vladimir Marko47496c22016-01-27 16:15:08 +00002896 std::vector<const DexFile*> no_inline_from_dex_files_;
2897
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002898 bool dump_stats_;
2899 bool dump_passes_;
2900 bool dump_timing_;
2901 bool dump_slow_timing_;
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07002902 bool avoid_storing_invocation_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002903 std::string swap_file_name_;
2904 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002905 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2906 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002907 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002908 std::string app_image_file_name_;
2909 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002910 std::string profile_file_;
2911 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002912 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002913 TimingLogger* timings_;
2914 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002915 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002916 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002917
2918 // Backing storage.
2919 std::vector<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002920
Andreas Gampeace0dc12016-01-20 13:33:13 -08002921 // See CompilerOptions.force_determinism_.
2922 bool force_determinism_;
2923
Jeff Hao16d48432017-04-05 17:05:46 -07002924 // Directory of relative classpaths.
2925 std::string classpath_dir_;
2926
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00002927 // Whether the given input vdex is also the output.
2928 bool update_input_vdex_ = false;
2929
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002930 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2931};
2932
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002933static void b13564922() {
2934#if defined(__linux__) && defined(__arm__)
2935 int major, minor;
2936 struct utsname uts;
2937 if (uname(&uts) != -1 &&
2938 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2939 ((major < 3) || ((major == 3) && (minor < 4)))) {
2940 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2941 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2942 int old_personality = personality(0xffffffff);
2943 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2944 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2945 if (new_personality == -1) {
2946 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2947 }
2948 }
2949 }
2950#endif
2951}
2952
Mathieu Chartier72041a02017-07-14 18:23:25 -07002953class ScopedGlobalRef {
2954 public:
2955 explicit ScopedGlobalRef(jobject obj) : obj_(obj) {}
2956 ~ScopedGlobalRef() {
2957 if (obj_ != nullptr) {
2958 ScopedObjectAccess soa(Thread::Current());
2959 soa.Env()->vm->DeleteGlobalRef(soa.Self(), obj_);
2960 }
2961 }
2962
2963 private:
2964 jobject obj_;
2965};
2966
Andreas Gampe7b565912017-03-20 15:48:52 -07002967static dex2oat::ReturnCode CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002968 dex2oat.LoadClassProfileDescriptors();
Mathieu Chartier72041a02017-07-14 18:23:25 -07002969 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08002970
David Brazdil7b49e6c2016-09-01 11:06:18 +01002971 if (!dex2oat.WriteOutputFiles()) {
2972 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002973 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002974 }
2975
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002976 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2977 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2978 // image writer will require this fd to generate the image.
2979 if (dex2oat.ShouldKeepOatFileOpen()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002980 if (!dex2oat.FlushOutputFiles()) {
2981 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002982 return dex2oat::ReturnCode::kOther;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002983 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01002984 } else if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002985 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002986 }
2987
Jeff Haodcdc85b2015-12-04 14:06:18 -08002988 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002989 if (!dex2oat.HandleImage()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002990 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002991 }
2992
2993 // When given --host, finish early without stripping.
2994 if (dex2oat.IsHost()) {
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002995 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002996 return dex2oat::ReturnCode::kOther;
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002997 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002998 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002999 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003000 }
3001
Jeff Haodcdc85b2015-12-04 14:06:18 -08003002 // Copy stripped to unstripped location, if necessary.
3003 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003004 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003005 }
3006
Jeff Haodcdc85b2015-12-04 14:06:18 -08003007 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01003008 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003009 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003010 }
3011
3012 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003013 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003014}
3015
Andreas Gampe7b565912017-03-20 15:48:52 -07003016static dex2oat::ReturnCode CompileApp(Dex2Oat& dex2oat) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07003017 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08003018
David Brazdil7b49e6c2016-09-01 11:06:18 +01003019 if (!dex2oat.WriteOutputFiles()) {
3020 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07003021 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003022 }
3023
Jeff Haodcdc85b2015-12-04 14:06:18 -08003024 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08003025 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08003026
3027 // When given --host, finish early without stripping.
3028 if (dex2oat.IsHost()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003029 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003030 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003031 }
3032
3033 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003034 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003035 }
3036
Jeff Haodcdc85b2015-12-04 14:06:18 -08003037 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
3038 // stripped versions. If this is given, we expect to be able to open writable files by name.
3039 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003040 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003041 }
3042
Jeff Haodcdc85b2015-12-04 14:06:18 -08003043 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01003044 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003045 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003046 }
3047
3048 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003049 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003050}
3051
Andreas Gampe7b565912017-03-20 15:48:52 -07003052static dex2oat::ReturnCode Dex2oat(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003053 b13564922();
3054
3055 TimingLogger timings("compiler", false, false);
3056
Roland Levillain5c7e2602016-02-23 18:08:53 +00003057 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
3058 // might produce a stack frame too large for this function or for
3059 // functions inlining it (such as main), that would not fit the
3060 // requirements of the `-Wframe-larger-than` option.
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07003061 std::unique_ptr<Dex2Oat> dex2oat = std::make_unique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003062
3063 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003064 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003065
Calin Juravleb077e152016-02-18 18:47:37 +00003066 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02003067 // This operation involves I/O.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08003068 if (dex2oat->UseProfile()) {
Calin Juravleb077e152016-02-18 18:47:37 +00003069 if (!dex2oat->LoadProfile()) {
3070 LOG(ERROR) << "Failed to process profile file";
Andreas Gampe7b565912017-03-20 15:48:52 -07003071 return dex2oat::ReturnCode::kOther;
Calin Juravle998c2162015-12-21 15:39:33 +02003072 }
3073 }
3074
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00003075 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap, and vdex.
3076
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003077 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00003078 if (!dex2oat->OpenFile()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003079 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003080 }
3081
Andreas Gampe046c7062015-05-18 23:22:54 -07003082 // Print the complete line when any of the following is true:
3083 // 1) Debug build
3084 // 2) Compiling an image
3085 // 3) Compiling with --host
3086 // 4) Compiling on the host (not a target build)
3087 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003088 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07003089 LOG(INFO) << CommandLine();
3090 } else {
3091 LOG(INFO) << StrippedCommandLine();
3092 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003093
Andreas Gampef7882972017-03-20 16:35:24 -07003094 dex2oat::ReturnCode setup_code = dex2oat->Setup();
3095 if (setup_code != dex2oat::ReturnCode::kNoFailure) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003096 dex2oat->EraseOutputFiles();
Andreas Gampef7882972017-03-20 16:35:24 -07003097 return setup_code;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003098 }
3099
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07003100 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
3101 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07003102 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
3103
Andreas Gampe7b565912017-03-20 15:48:52 -07003104 dex2oat::ReturnCode result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00003105 if (dex2oat->IsImage()) {
3106 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08003107 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00003108 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003109 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003110
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003111 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003112}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003113} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07003114
3115int main(int argc, char** argv) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003116 int result = static_cast<int>(art::Dex2oat(argc, argv));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003117 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
3118 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
3119 // should not destruct the runtime in this case.
Evgenii Stepanov1e133742015-05-20 12:30:59 -07003120 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampee286b642017-04-13 12:20:42 -07003121 _exit(result);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003122 }
3123 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07003124}