blob: 0826fa14880754d434f1ec24c9d91e683f5f2670 [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("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700358 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
359 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
360 UsageError(" Use a separate --runtime-arg switch for each argument.");
361 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700362 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000363 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700364 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000365 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
366 UsageError(" Cannot be used together with --profile-file.");
367 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100368 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800369 UsageError(" Example: --swap-file=/data/tmp/swap.001");
370 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100371 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800372 UsageError(" Example: --swap-fd=10");
373 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100374 UsageError(" --swap-dex-size-threshold=<size>: specifies the minimum total dex file size in");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700375 UsageError(" bytes to allow the use of swap.");
376 UsageError(" Example: --swap-dex-size-threshold=1000000");
377 UsageError(" Default: %zu", kDefaultMinDexFileCumulativeSizeForSwap);
378 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100379 UsageError(" --swap-dex-count-threshold=<count>: specifies the minimum number of dex files to");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700380 UsageError(" allow the use of swap.");
381 UsageError(" Example: --swap-dex-count-threshold=10");
382 UsageError(" Default: %zu", kDefaultMinDexFilesForSwap);
383 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100384 UsageError(" --very-large-app-threshold=<size>: specifies the minimum total dex file size in");
Mathieu Chartier010126f2017-07-15 15:44:18 -0700385 UsageError(" bytes to consider the input \"very large\" and reduce compilation done.");
Andreas Gampe67f02822016-06-24 21:05:23 -0700386 UsageError(" Example: --very-large-app-threshold=100000000");
387 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700388 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
389 UsageError(" Example: --app-image-fd=10");
390 UsageError("");
391 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
392 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
393 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800394 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
395 "input dex file.");
396 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000397 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000398 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100399 UsageError(" --dump-cfg=<cfg-file>: dump control-flow graphs (CFGs) to specified file.");
400 UsageError(" Example: --dump-cfg=output.cfg");
401 UsageError("");
402 UsageError(" --dump-cfg-append: when dumping CFGs to an existing file, append new CFG data to");
403 UsageError(" existing data (instead of overwriting existing data with new data, which is");
404 UsageError(" the default behavior). This option is only meaningful when used with");
405 UsageError(" --dump-cfg.");
406 UsageError("");
Jeff Hao16d48432017-04-05 17:05:46 -0700407 UsageError(" --classpath-dir=<directory-path>: directory used to resolve relative class paths.");
408 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700409 UsageError(" --class-loader-context=<string spec>: a string specifying the intended");
410 UsageError(" runtime loading context for the compiled dex files.");
411 UsageError(" ");
412 UsageError(" It describes how the class loader chain should be built in order to ensure");
413 UsageError(" classes are resolved during dex2aot as they would be resolved at runtime.");
414 UsageError(" This spec will be encoded in the oat file. If at runtime the dex file is");
415 UsageError(" loaded in a different context, the oat file will be rejected.");
416 UsageError(" ");
417 UsageError(" The chain is interpreted in the natural 'parent order', meaning that class");
418 UsageError(" loader 'i+1' will be the parent of class loader 'i'.");
Calin Juravlec79470d2017-07-12 17:37:42 -0700419 UsageError(" The compilation sources will be appended to the classpath of the first class");
420 UsageError(" loader.");
421 UsageError(" ");
422 UsageError(" E.g. if the context is 'PCL[lib1.dex];DLC[lib2.dex]' and ");
423 UsageError(" --dex-file=src.dex then dex2oat will setup a PathClassLoader with classpath ");
424 UsageError(" 'lib1.dex:src.dex' and set its parent to a DelegateLastClassLoader with ");
425 UsageError(" classpath 'lib2.dex'.");
Calin Juravle1ce70852017-06-28 10:59:03 -0700426 UsageError(" ");
427 UsageError(" Note that the compiler will be tolerant if the source dex files specified");
428 UsageError(" with --dex-file are found in the classpath. The source dex files will be");
429 UsageError(" removed from any class loader's classpath possibly resulting in empty");
430 UsageError(" class loaders.");
431 UsageError(" ");
Calin Juravlec79470d2017-07-12 17:37:42 -0700432 UsageError(" Example: --class-loader-context=PCL[lib1.dex:lib2.dex];DLC[lib3.dex]");
Calin Juravle1ce70852017-06-28 10:59:03 -0700433 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700434 std::cerr << "See log for usage error information\n";
435 exit(EXIT_FAILURE);
436}
437
Brian Carlstrom7940e442013-07-12 13:46:57 -0700438// The primary goal of the watchdog is to prevent stuck build servers
439// during development when fatal aborts lead to a cascade of failures
440// that result in a deadlock.
441class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800442// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700443#undef CHECK_PTHREAD_CALL
444#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
445 do { \
446 int rc = call args; \
447 if (rc != 0) { \
448 errno = rc; \
449 std::string message(# call); \
450 message += " failed for "; \
451 message += reason; \
452 Fatal(message); \
453 } \
454 } while (false)
455
456 public:
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800457 explicit WatchDog(int64_t timeout_in_milliseconds)
458 : timeout_in_milliseconds_(timeout_in_milliseconds),
459 shutting_down_(false) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700460 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700461 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800462#ifndef __APPLE__
463 pthread_condattr_t condattr;
liulvping8f7101e2017-01-16 15:14:43 +0800464 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_init, (&condattr), reason);
465 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_setclock, (&condattr, CLOCK_MONOTONIC), reason);
466 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, &condattr), reason);
467 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_destroy, (&condattr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800468#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700469 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
470 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
471 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
472 }
473 ~WatchDog() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700474 const char* reason = "dex2oat watch dog thread shutdown";
475 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
476 shutting_down_ = true;
477 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
478 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
479
Kenny Root51316382014-05-13 14:59:37 -0700480 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700481
482 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
483 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
484 }
485
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800486 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
487 // large.
488 static constexpr int64_t kWatchdogVerifyMultiplier =
489 kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
490
491 // When setting timeouts, keep in mind that the build server may not be as fast as your
492 // desktop. Debug builds are slower so they have larger timeouts.
493 static constexpr int64_t kWatchdogSlowdownFactor = kIsDebugBuild ? 5U : 1U;
494
495 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
496 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
497 // itself before that watchdog would take down the system server.
498 static constexpr int64_t kWatchDogTimeoutSeconds = kWatchdogSlowdownFactor * (9 * 60 + 30);
499
500 static constexpr int64_t kDefaultWatchdogTimeoutInMS =
501 kWatchdogVerifyMultiplier * kWatchDogTimeoutSeconds * 1000;
502
Brian Carlstrom7940e442013-07-12 13:46:57 -0700503 private:
504 static void* CallBack(void* arg) {
505 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
506 ::art::SetThreadName("dex2oat watch dog");
507 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700508 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700509 }
510
Andreas Gampe794ad762015-02-23 08:12:24 -0800511 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700512 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
513 // it's rather easy to hang in unwinding.
514 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
515 // logcat logging or stderr output.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700516 android::base::LogMessage::LogLine(__FILE__,
517 __LINE__,
518 android::base::LogId::DEFAULT,
519 LogSeverity::FATAL,
520 message.c_str());
Andreas Gampe48fde372017-06-06 07:43:46 -0700521 // If we're on the host, try to dump all threads to get a sense of what's going on. This is
522 // restricted to the host as the dump may itself go bad.
523 // TODO: Use a double watchdog timeout, so we can enable this on-device.
524 if (!kIsTargetBuild && Runtime::Current() != nullptr) {
Andreas Gampecd607312017-06-05 17:03:05 -0700525 Runtime::Current()->AttachCurrentThread("Watchdog thread attached for dumping",
526 true,
527 nullptr,
528 false);
529 Runtime::Current()->DumpForSigQuit(std::cerr);
530 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700531 exit(1);
532 }
533
534 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700535 timespec timeout_ts;
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800536#if defined(__APPLE__)
537 InitTimeSpec(true, CLOCK_REALTIME, timeout_in_milliseconds_, 0, &timeout_ts);
538#else
liulvping8f7101e2017-01-16 15:14:43 +0800539 InitTimeSpec(true, CLOCK_MONOTONIC, timeout_in_milliseconds_, 0, &timeout_ts);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800540#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700541 const char* reason = "dex2oat watch dog thread waiting";
542 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
543 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800544 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700545 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700546 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800547 timeout_in_milliseconds_/1000));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700548 } else if (rc != 0) {
549 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
550 strerror(errno)));
551 Fatal(message.c_str());
552 }
553 }
554 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
555 }
556
Brian Carlstrom7940e442013-07-12 13:46:57 -0700557 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
558 pthread_mutex_t mutex_;
559 pthread_cond_t cond_;
560 pthread_attr_t attr_;
561 pthread_t pthread_;
Andreas Gampef45d61c2017-06-07 10:29:33 -0700562
563 const int64_t timeout_in_milliseconds_;
564 bool shutting_down_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700565};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700566
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800567class Dex2Oat FINAL {
568 public:
569 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100570 compiler_kind_(Compiler::kOptimizing),
Artem Serovba6b6792016-08-15 14:22:07 +0100571 instruction_set_(kRuntimeISA == kArm ? kThumb2 : kRuntimeISA),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800572 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000573 image_file_location_oat_checksum_(0),
574 image_file_location_oat_data_begin_(0),
575 image_patch_delta_(0),
576 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700577 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800578 runtime_(nullptr),
579 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
580 start_ns_(NanoTime()),
Andreas Gampec560fc02014-07-16 09:57:39 -0700581 start_cputime_ns_(ProcessCpuNanoTime()),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800582 oat_fd_(-1),
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000583 input_vdex_fd_(-1),
584 output_vdex_fd_(-1),
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000585 input_vdex_file_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800586 zip_fd_(-1),
587 image_base_(0U),
588 image_classes_zip_filename_(nullptr),
589 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800590 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800591 compiled_classes_zip_filename_(nullptr),
592 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700593 compiled_methods_zip_filename_(nullptr),
594 compiled_methods_filename_(nullptr),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700595 passes_to_run_filename_(nullptr),
Jeff Hao436183f2016-01-12 16:36:50 -0800596 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800597 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000598 elf_writers_(),
599 oat_writers_(),
600 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000601 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700602 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000603 opened_dex_files_maps_(),
604 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000605 no_inline_from_dex_files_(),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800606 dump_stats_(false),
607 dump_passes_(false),
608 dump_timing_(false),
609 dump_slow_timing_(kIsDebugBuild),
Calin Juravle2e2db782016-02-23 12:00:03 +0000610 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800611 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000612 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800613 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000614 force_determinism_(false)
615 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800616
617 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800618 // Log completion time before deleting the runtime_, because this accesses
619 // the runtime.
620 LogCompletionTime();
621
Vladimir Marko307dac92015-10-20 11:20:09 +0100622 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
623 // We want to just exit on non-debug builds, not bringing the runtime down
624 // in an orderly fashion. So release the following fields.
625 driver_.release();
626 image_writer_.release();
627 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
628 dex_file.release();
629 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000630 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
631 map.release();
632 }
David Brazdil7b49e6c2016-09-01 11:06:18 +0100633 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
634 vdex_file.release();
635 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800636 for (std::unique_ptr<File>& oat_file : oat_files_) {
637 oat_file.release();
638 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100639 runtime_.release();
640 verification_results_.release();
641 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100642 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700643 }
644
Roland Levillain9ec5e222015-08-17 20:18:41 +0100645 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800646 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800647 std::string boot_image_filename;
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800648 int64_t watch_dog_timeout_in_ms = -1;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800649 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000650 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800651 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100652 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800653
Roland Levillain9ec5e222015-08-17 20:18:41 +0100654 void ParseZipFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000655 ParseUintOption(option, "--zip-fd", &zip_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100656 }
657
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000658 void ParseInputVdexFd(const StringPiece& option) {
659 // Note that the input vdex fd might be -1.
660 ParseIntOption(option, "--input-vdex-fd", &input_vdex_fd_, Usage);
661 }
662
663 void ParseOutputVdexFd(const StringPiece& option) {
664 ParseUintOption(option, "--output-vdex-fd", &output_vdex_fd_, Usage);
David Brazdil7b49e6c2016-09-01 11:06:18 +0100665 }
666
Roland Levillain9ec5e222015-08-17 20:18:41 +0100667 void ParseOatFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000668 ParseUintOption(option, "--oat-fd", &oat_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100669 }
670
Calin Juravle877fd962016-01-05 14:29:29 +0000671 void ParseFdForCollection(const StringPiece& option,
672 const char* arg_name,
673 std::vector<uint32_t>* fds) {
674 uint32_t fd;
675 ParseUintOption(option, arg_name, &fd, Usage);
676 fds->push_back(fd);
677 }
678
Roland Levillain9ec5e222015-08-17 20:18:41 +0100679 void ParseJ(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000680 ParseUintOption(option, "-j", &thread_count_, Usage, /* is_long_option */ false);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100681 }
682
683 void ParseBase(const StringPiece& option) {
684 DCHECK(option.starts_with("--base="));
685 const char* image_base_str = option.substr(strlen("--base=")).data();
686 char* end;
687 image_base_ = strtoul(image_base_str, &end, 16);
688 if (end == image_base_str || *end != '\0') {
689 Usage("Failed to parse hexadecimal value for option %s", option.data());
690 }
691 }
692
693 void ParseInstructionSet(const StringPiece& option) {
694 DCHECK(option.starts_with("--instruction-set="));
695 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
696 // StringPiece is not necessarily zero-terminated, so need to make a copy and ensure it.
697 std::unique_ptr<char[]> buf(new char[instruction_set_str.length() + 1]);
698 strncpy(buf.get(), instruction_set_str.data(), instruction_set_str.length());
699 buf.get()[instruction_set_str.length()] = 0;
700 instruction_set_ = GetInstructionSetFromString(buf.get());
701 // arm actually means thumb2.
702 if (instruction_set_ == InstructionSet::kArm) {
703 instruction_set_ = InstructionSet::kThumb2;
704 }
705 }
706
707 void ParseInstructionSetVariant(const StringPiece& option, ParserOptions* parser_options) {
708 DCHECK(option.starts_with("--instruction-set-variant="));
709 StringPiece str = option.substr(strlen("--instruction-set-variant=")).data();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800710 instruction_set_features_ = InstructionSetFeatures::FromVariant(
711 instruction_set_, str.as_string(), &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100712 if (instruction_set_features_.get() == nullptr) {
713 Usage("%s", parser_options->error_msg.c_str());
714 }
715 }
716
717 void ParseInstructionSetFeatures(const StringPiece& option, ParserOptions* parser_options) {
718 DCHECK(option.starts_with("--instruction-set-features="));
719 StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800720 if (instruction_set_features_ == nullptr) {
721 instruction_set_features_ = InstructionSetFeatures::FromVariant(
722 instruction_set_, "default", &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100723 if (instruction_set_features_.get() == nullptr) {
724 Usage("Problem initializing default instruction set features variant: %s",
725 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700726 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800727 }
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800728 instruction_set_features_ =
Roland Levillain9ec5e222015-08-17 20:18:41 +0100729 instruction_set_features_->AddFeaturesFromString(str.as_string(),
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800730 &parser_options->error_msg);
731 if (instruction_set_features_ == nullptr) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100732 Usage("Error parsing '%s': %s", option.data(), parser_options->error_msg.c_str());
733 }
734 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800735
Roland Levillain9ec5e222015-08-17 20:18:41 +0100736 void ParseCompilerBackend(const StringPiece& option, ParserOptions* parser_options) {
737 DCHECK(option.starts_with("--compiler-backend="));
738 parser_options->requested_specific_compiler = true;
739 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
740 if (backend_str == "Quick") {
741 compiler_kind_ = Compiler::kQuick;
742 } else if (backend_str == "Optimizing") {
743 compiler_kind_ = Compiler::kOptimizing;
744 } else {
745 Usage("Unknown compiler backend: %s", backend_str.data());
746 }
747 }
748
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800749 void ParseImageFormat(const StringPiece& option) {
750 const StringPiece substr("--image-format=");
751 DCHECK(option.starts_with(substr));
752 const StringPiece format_str = option.substr(substr.length());
753 if (format_str == "lz4") {
754 image_storage_mode_ = ImageHeader::kStorageModeLZ4;
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800755 } else if (format_str == "lz4hc") {
756 image_storage_mode_ = ImageHeader::kStorageModeLZ4HC;
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800757 } else if (format_str == "uncompressed") {
758 image_storage_mode_ = ImageHeader::kStorageModeUncompressed;
759 } else {
760 Usage("Unknown image format: %s", format_str.data());
761 }
762 }
763
Jeff Hao436183f2016-01-12 16:36:50 -0800764 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoaad75c62016-10-03 08:46:48 +0000765 compiler_options_->boot_image_ = !image_filenames_.empty();
766 compiler_options_->app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700767
768 if (IsAppImage() && IsBootImage()) {
769 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
770 }
771
Jeff Haodcdc85b2015-12-04 14:06:18 -0800772 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800773 Usage("Output must be supplied with either --oat-file or --oat-fd");
774 }
775
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000776 if (input_vdex_fd_ != -1 && !input_vdex_.empty()) {
777 Usage("Can't have both --input-vdex-fd and --input-vdex");
778 }
779
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +0100780 if (output_vdex_fd_ != -1 && !output_vdex_.empty()) {
781 Usage("Can't have both --output-vdex-fd and --output-vdex");
782 }
783
Jeff Haodcdc85b2015-12-04 14:06:18 -0800784 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800785 Usage("--oat-file should not be used with --oat-fd");
786 }
787
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000788 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +0100789 Usage("VDEX and OAT output must be specified either with one --oat-filename "
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000790 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100791 }
792
Roland Levillain9ec5e222015-08-17 20:18:41 +0100793 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800794 Usage("--oat-symbols should not be used with --oat-fd");
795 }
796
Roland Levillain9ec5e222015-08-17 20:18:41 +0100797 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800798 Usage("--oat-symbols should not be used with --host");
799 }
800
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000801 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
802 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100803 }
804
Jeff Haodcdc85b2015-12-04 14:06:18 -0800805 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800806 Usage("--oat-fd should not be used with --image");
807 }
808
Jeff Haodcdc85b2015-12-04 14:06:18 -0800809 if (!parser_options->oat_symbols.empty() &&
810 parser_options->oat_symbols.size() != oat_filenames_.size()) {
811 Usage("--oat-file arguments do not match --oat-symbols arguments");
812 }
813
814 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
815 Usage("--oat-file arguments do not match --image arguments");
816 }
817
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800818 if (android_root_.empty()) {
819 const char* android_root_env_var = getenv("ANDROID_ROOT");
820 if (android_root_env_var == nullptr) {
821 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700822 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800823 android_root_ += android_root_env_var;
824 }
825
Vladimir Markoaad75c62016-10-03 08:46:48 +0000826 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100827 parser_options->boot_image_filename += android_root_;
828 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800829 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100830 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000831 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800832 }
833
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700834 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800835 Usage("--image-classes should only be used with --image");
836 }
837
Vladimir Marko49b0f452015-12-10 13:49:19 +0000838 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800839 Usage("--image-classes should not be used with --boot-image");
840 }
841
842 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
843 Usage("--image-classes-zip should be used with --image-classes");
844 }
845
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700846 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800847 Usage("--compiled-classes should only be used with --image");
848 }
849
Vladimir Marko49b0f452015-12-10 13:49:19 +0000850 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800851 Usage("--compiled-classes should not be used with --boot-image");
852 }
853
854 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
855 Usage("--compiled-classes-zip should be used with --compiled-classes");
856 }
857
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800858 if (dex_filenames_.empty() && zip_fd_ == -1) {
859 Usage("Input must be supplied with either --dex-file or --zip-fd");
860 }
861
862 if (!dex_filenames_.empty() && zip_fd_ != -1) {
863 Usage("--dex-file should not be used with --zip-fd");
864 }
865
866 if (!dex_filenames_.empty() && !zip_location_.empty()) {
867 Usage("--dex-file should not be used with --zip-location");
868 }
869
870 if (dex_locations_.empty()) {
871 for (const char* dex_file_name : dex_filenames_) {
872 dex_locations_.push_back(dex_file_name);
873 }
874 } else if (dex_locations_.size() != dex_filenames_.size()) {
875 Usage("--dex-location arguments do not match --dex-file arguments");
876 }
877
Jeff Haodcdc85b2015-12-04 14:06:18 -0800878 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
879 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
880 Usage("--oat-file arguments must be singular or match --dex-file arguments");
881 }
882 }
883
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800884 if (zip_fd_ != -1 && zip_location_.empty()) {
885 Usage("--zip-location should be supplied with --zip-fd");
886 }
887
Vladimir Marko49b0f452015-12-10 13:49:19 +0000888 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800889 if (image_base_ == 0) {
890 Usage("Non-zero --base not specified");
891 }
892 }
893
Mathieu Chartiera8077802016-03-16 19:08:31 -0700894 const bool have_profile_file = !profile_file_.empty();
895 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
896 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000897 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200898 }
899
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -0700900 if (have_profile_file || have_profile_fd) {
901 if (compiled_classes_filename_ != nullptr ||
902 compiled_classes_zip_filename_ != nullptr ||
903 image_classes_filename_ != nullptr ||
904 image_classes_zip_filename_ != nullptr) {
905 Usage("Profile based image creation is not supported with image or compiled classes");
906 }
907 }
908
Roland Levillain9ec5e222015-08-17 20:18:41 +0100909 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800910 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800911 }
912
913 // If no instruction set feature was given, use the default one for the target
914 // instruction set.
915 if (instruction_set_features_.get() == nullptr) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800916 instruction_set_features_ = InstructionSetFeatures::FromVariant(
917 instruction_set_, "default", &parser_options->error_msg);
Ian Rogersd582fa42014-11-05 23:46:43 -0800918 if (instruction_set_features_.get() == nullptr) {
919 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100920 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800921 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800922 }
923
924 if (instruction_set_ == kRuntimeISA) {
925 std::unique_ptr<const InstructionSetFeatures> runtime_features(
926 InstructionSetFeatures::FromCppDefines());
927 if (!instruction_set_features_->Equals(runtime_features.get())) {
928 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
929 << *instruction_set_features_ << ") and those of dex2oat executable ("
930 << *runtime_features <<") for the command line:\n"
931 << CommandLine();
932 }
933 }
934
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000935 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +0000936 compiler_options_->inline_max_code_units_ = CompilerOptions::kDefaultInlineMaxCodeUnits;
Roland Levillaina215b952015-08-07 11:38:32 +0100937 }
938
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800939 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800940 // Set the compilation target's implicit checks options.
941 switch (instruction_set_) {
942 case kArm:
943 case kThumb2:
944 case kArm64:
945 case kX86:
946 case kX86_64:
Douglas Leung22bb5a22015-07-02 16:42:08 -0700947 case kMips:
948 case kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000949 compiler_options_->implicit_null_checks_ = true;
950 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800951 break;
952
953 default:
954 // Defaults are correct.
955 break;
956 }
957
Jeff Hao436183f2016-01-12 16:36:50 -0800958 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800959 Usage("--multi-image can only be used when creating boot images");
960 }
Jeff Hao436183f2016-01-12 16:36:50 -0800961 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800962 Usage("--multi-image cannot be used with multiple image names");
963 }
964
965 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
966 if (!kIsTargetBuild && IsBootImage()) {
967 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800968 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800969 }
970 }
971
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800972 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100973 if (parser_options->watch_dog_enabled) {
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800974 int64_t timeout = parser_options->watch_dog_timeout_in_ms > 0
975 ? parser_options->watch_dog_timeout_in_ms
976 : WatchDog::kDefaultWatchdogTimeoutInMS;
977 watchdog_.reset(new WatchDog(timeout));
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800978 }
979
980 // Fill some values into the key-value store for the oat header.
981 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800982
Roland Levillainb81e9e92017-04-20 17:35:32 +0100983 // Automatically force determinism for the boot image in a host build if read barriers
984 // are enabled, or if the default GC is CMS or MS. When the default GC is CMS
985 // (Concurrent Mark-Sweep), the GC is switched to a non-concurrent one by passing the
986 // option `-Xgc:nonconcurrent` (see below).
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800987 if (!kIsTargetBuild && IsBootImage()) {
988 if (SupportsDeterministicCompilation()) {
989 force_determinism_ = true;
990 } else {
991 LOG(WARNING) << "Deterministic compilation is disabled.";
992 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800993 }
994 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700995
996 if (passes_to_run_filename_ != nullptr) {
997 passes_to_run_.reset(ReadCommentedInputFromFile<std::vector<std::string>>(
998 passes_to_run_filename_,
999 nullptr)); // No post-processing.
1000 if (passes_to_run_.get() == nullptr) {
1001 Usage("Failed to read list of passes to run.");
1002 }
1003 }
1004 compiler_options_->passes_to_run_ = passes_to_run_.get();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001005 }
1006
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001007 static bool SupportsDeterministicCompilation() {
Roland Levillainb81e9e92017-04-20 17:35:32 +01001008 return (kUseReadBarrier ||
1009 gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
1010 gc::kCollectorTypeDefault == gc::kCollectorTypeMS);
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001011 }
1012
Jeff Hao436183f2016-01-12 16:36:50 -08001013 void ExpandOatAndImageFilenames() {
1014 std::string base_oat = oat_filenames_[0];
1015 size_t last_oat_slash = base_oat.rfind('/');
1016 if (last_oat_slash == std::string::npos) {
1017 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
1018 }
1019 // We also need to honor path components that were encoded through '@'. Otherwise the loading
1020 // code won't be able to find the images.
1021 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
1022 last_oat_slash = base_oat.rfind('@');
1023 }
1024 base_oat = base_oat.substr(0, last_oat_slash + 1);
1025
1026 std::string base_img = image_filenames_[0];
1027 size_t last_img_slash = base_img.rfind('/');
1028 if (last_img_slash == std::string::npos) {
1029 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
1030 }
1031 // We also need to honor path components that were encoded through '@'. Otherwise the loading
1032 // code won't be able to find the images.
1033 if (base_img.find('@', last_img_slash) != std::string::npos) {
1034 last_img_slash = base_img.rfind('@');
1035 }
1036
1037 // Get the prefix, which is the primary image name (without path components). Strip the
1038 // extension.
1039 std::string prefix = base_img.substr(last_img_slash + 1);
1040 if (prefix.rfind('.') != std::string::npos) {
1041 prefix = prefix.substr(0, prefix.rfind('.'));
1042 }
1043 if (!prefix.empty()) {
1044 prefix = prefix + "-";
1045 }
1046
1047 base_img = base_img.substr(0, last_img_slash + 1);
1048
1049 // Note: we have some special case here for our testing. We have to inject the differentiating
1050 // parts for the different core images.
1051 std::string infix; // Empty infix by default.
1052 {
1053 // Check the first name.
1054 std::string dex_file = oat_filenames_[0];
1055 size_t last_dex_slash = dex_file.rfind('/');
1056 if (last_dex_slash != std::string::npos) {
1057 dex_file = dex_file.substr(last_dex_slash + 1);
1058 }
1059 size_t last_dex_dot = dex_file.rfind('.');
1060 if (last_dex_dot != std::string::npos) {
1061 dex_file = dex_file.substr(0, last_dex_dot);
1062 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001063 if (android::base::StartsWith(dex_file, "core-")) {
Jeff Hao436183f2016-01-12 16:36:50 -08001064 infix = dex_file.substr(strlen("core"));
1065 }
1066 }
1067
bowen_lai8bd36c02016-10-12 13:28:55 +08001068 std::string base_symbol_oat;
1069 if (!oat_unstripped_.empty()) {
1070 base_symbol_oat = oat_unstripped_[0];
1071 size_t last_symbol_oat_slash = base_symbol_oat.rfind('/');
1072 if (last_symbol_oat_slash == std::string::npos) {
1073 Usage("--multi-image used with unusable symbol filename %s", base_symbol_oat.c_str());
1074 }
1075 base_symbol_oat = base_symbol_oat.substr(0, last_symbol_oat_slash + 1);
1076 }
1077
1078 const size_t num_expanded_files = 2 + (base_symbol_oat.empty() ? 0 : 1);
1079 char_backing_storage_.reserve((dex_locations_.size() - 1) * num_expanded_files);
Ben Gruvera0fc3262016-09-30 13:10:42 -07001080
Jeff Hao436183f2016-01-12 16:36:50 -08001081 // Now create the other names. Use a counted loop to skip the first one.
1082 for (size_t i = 1; i < dex_locations_.size(); ++i) {
1083 // TODO: Make everything properly std::string.
1084 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
1085 char_backing_storage_.push_back(base_img + image_name);
1086 image_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
1087
1088 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
1089 char_backing_storage_.push_back(base_oat + oat_name);
1090 oat_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001091
1092 if (!base_symbol_oat.empty()) {
1093 char_backing_storage_.push_back(base_symbol_oat + oat_name);
1094 oat_unstripped_.push_back((char_backing_storage_.end() - 1)->c_str());
1095 }
Jeff Hao436183f2016-01-12 16:36:50 -08001096 }
1097 }
1098
Andreas Gampe8994a042015-12-30 19:03:17 +00001099 // Modify the input string in the following way:
1100 // 0) Assume input is /a/b/c.d
1101 // 1) Strip the path -> c.d
1102 // 2) Inject prefix p -> pc.d
1103 // 3) Inject infix i -> pci.d
1104 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -08001105 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +00001106 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001107 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +00001108 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001109 size_t last_dex_slash = in.rfind('/');
1110 if (last_dex_slash != std::string::npos) {
1111 in = in.substr(last_dex_slash + 1);
1112 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001113 if (!prefix.empty()) {
1114 in = prefix + in;
1115 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001116 if (!infix.empty()) {
1117 // Inject infix.
1118 size_t last_dot = in.rfind('.');
1119 if (last_dot != std::string::npos) {
1120 in.insert(last_dot, infix);
1121 }
1122 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001123 if (android::base::EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001124 in = in.substr(0, in.length() - strlen(".jar")) +
1125 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001126 }
1127 return in;
1128 }
1129
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001130 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001131 std::ostringstream oss;
1132 for (int i = 0; i < argc; ++i) {
1133 if (i > 0) {
1134 oss << ' ';
1135 }
1136 oss << argv[i];
1137 }
1138 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1139 oss.str(""); // Reset.
1140 oss << kRuntimeISA;
1141 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1142 key_value_store_->Put(
1143 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001144 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001145 key_value_store_->Put(
1146 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001147 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001148 key_value_store_->Put(
1149 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001150 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001151 key_value_store_->Put(OatHeader::kCompilerFilter,
1152 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Andreas Gampef8cd8902017-01-18 16:05:01 -08001153 key_value_store_->Put(OatHeader::kConcurrentCopying,
1154 kUseReadBarrier ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001155 }
1156
1157 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1158 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1159 // returns, arguments have been successfully parsed.
1160 void ParseArgs(int argc, char** argv) {
1161 original_argc = argc;
1162 original_argv = argv;
1163
Andreas Gampe51d80cc2017-06-21 21:05:13 -07001164 InitLogging(argv, Runtime::Abort);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001165
1166 // Skip over argv[0].
1167 argv++;
1168 argc--;
1169
1170 if (argc == 0) {
1171 Usage("No arguments specified");
1172 }
1173
1174 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001175 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001176
1177 for (int i = 0; i < argc; i++) {
1178 const StringPiece option(argv[i]);
1179 const bool log_options = false;
1180 if (log_options) {
1181 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1182 }
1183 if (option.starts_with("--dex-file=")) {
1184 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data());
1185 } else if (option.starts_with("--dex-location=")) {
1186 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data());
1187 } else if (option.starts_with("--zip-fd=")) {
1188 ParseZipFd(option);
1189 } else if (option.starts_with("--zip-location=")) {
1190 zip_location_ = option.substr(strlen("--zip-location=")).data();
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001191 } else if (option.starts_with("--input-vdex-fd=")) {
1192 ParseInputVdexFd(option);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001193 } else if (option.starts_with("--input-vdex=")) {
1194 input_vdex_ = option.substr(strlen("--input-vdex=")).data();
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001195 } else if (option.starts_with("--output-vdex=")) {
1196 output_vdex_ = option.substr(strlen("--output-vdex=")).data();
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001197 } else if (option.starts_with("--output-vdex-fd=")) {
1198 ParseOutputVdexFd(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001199 } else if (option.starts_with("--oat-file=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001200 oat_filenames_.push_back(option.substr(strlen("--oat-file=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001201 } else if (option.starts_with("--oat-symbols=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001202 parser_options->oat_symbols.push_back(option.substr(strlen("--oat-symbols=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001203 } else if (option.starts_with("--oat-fd=")) {
1204 ParseOatFd(option);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001205 } else if (option.starts_with("--oat-location=")) {
1206 oat_location_ = option.substr(strlen("--oat-location=")).data();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001207 } else if (option == "--watch-dog") {
1208 parser_options->watch_dog_enabled = true;
1209 } else if (option == "--no-watch-dog") {
1210 parser_options->watch_dog_enabled = false;
Andreas Gampe2e8a2562017-01-18 20:39:02 -08001211 } else if (option.starts_with("--watchdog-timeout=")) {
1212 ParseIntOption(option,
1213 "--watchdog-timeout",
1214 &parser_options->watch_dog_timeout_in_ms,
1215 Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001216 } else if (option.starts_with("-j")) {
1217 ParseJ(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001218 } else if (option.starts_with("--image=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001219 image_filenames_.push_back(option.substr(strlen("--image=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001220 } else if (option.starts_with("--image-classes=")) {
1221 image_classes_filename_ = option.substr(strlen("--image-classes=")).data();
1222 } else if (option.starts_with("--image-classes-zip=")) {
1223 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data();
Mathieu Chartierceb07b32015-12-10 09:33:21 -08001224 } else if (option.starts_with("--image-format=")) {
1225 ParseImageFormat(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001226 } else if (option.starts_with("--compiled-classes=")) {
1227 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data();
1228 } else if (option.starts_with("--compiled-classes-zip=")) {
1229 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data();
1230 } else if (option.starts_with("--compiled-methods=")) {
1231 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data();
1232 } else if (option.starts_with("--compiled-methods-zip=")) {
1233 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data();
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07001234 } else if (option.starts_with("--run-passes=")) {
1235 passes_to_run_filename_ = option.substr(strlen("--run-passes=")).data();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001236 } else if (option.starts_with("--base=")) {
1237 ParseBase(option);
1238 } else if (option.starts_with("--boot-image=")) {
1239 parser_options->boot_image_filename = option.substr(strlen("--boot-image=")).data();
1240 } else if (option.starts_with("--android-root=")) {
1241 android_root_ = option.substr(strlen("--android-root=")).data();
1242 } else if (option.starts_with("--instruction-set=")) {
1243 ParseInstructionSet(option);
1244 } else if (option.starts_with("--instruction-set-variant=")) {
1245 ParseInstructionSetVariant(option, parser_options.get());
1246 } else if (option.starts_with("--instruction-set-features=")) {
1247 ParseInstructionSetFeatures(option, parser_options.get());
1248 } else if (option.starts_with("--compiler-backend=")) {
1249 ParseCompilerBackend(option, parser_options.get());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001250 } else if (option.starts_with("--profile-file=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001251 profile_file_ = option.substr(strlen("--profile-file=")).ToString();
Calin Juravle877fd962016-01-05 14:29:29 +00001252 } else if (option.starts_with("--profile-file-fd=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001253 ParseUintOption(option, "--profile-file-fd", &profile_file_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001254 } else if (option == "--host") {
1255 is_host_ = true;
1256 } else if (option == "--runtime-arg") {
1257 if (++i >= argc) {
1258 Usage("Missing required argument for --runtime-arg");
1259 }
1260 if (log_options) {
1261 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1262 }
1263 runtime_args_.push_back(argv[i]);
1264 } else if (option == "--dump-timing") {
1265 dump_timing_ = true;
1266 } else if (option == "--dump-passes") {
1267 dump_passes_ = true;
Roland Levillain9ec5e222015-08-17 20:18:41 +01001268 } else if (option == "--dump-stats") {
1269 dump_stats_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001270 } else if (option.starts_with("--swap-file=")) {
1271 swap_file_name_ = option.substr(strlen("--swap-file=")).data();
1272 } else if (option.starts_with("--swap-fd=")) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001273 ParseUintOption(option, "--swap-fd", &swap_fd_, Usage);
Andreas Gampee1459ae2016-06-29 09:36:30 -07001274 } else if (option.starts_with("--swap-dex-size-threshold=")) {
1275 ParseUintOption(option,
1276 "--swap-dex-size-threshold",
1277 &min_dex_file_cumulative_size_for_swap_,
1278 Usage);
1279 } else if (option.starts_with("--swap-dex-count-threshold=")) {
1280 ParseUintOption(option,
1281 "--swap-dex-count-threshold",
1282 &min_dex_files_for_swap_,
1283 Usage);
Andreas Gampe67f02822016-06-24 21:05:23 -07001284 } else if (option.starts_with("--very-large-app-threshold=")) {
1285 ParseUintOption(option,
1286 "--very-large-app-threshold",
1287 &very_large_threshold_,
1288 Usage);
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001289 } else if (option.starts_with("--app-image-file=")) {
1290 app_image_file_name_ = option.substr(strlen("--app-image-file=")).data();
1291 } else if (option.starts_with("--app-image-fd=")) {
1292 ParseUintOption(option, "--app-image-fd", &app_image_fd_, Usage);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001293 } else if (option == "--multi-image") {
Jeff Hao436183f2016-01-12 16:36:50 -08001294 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001295 } else if (option.starts_with("--no-inline-from=")) {
1296 no_inline_from_string_ = option.substr(strlen("--no-inline-from=")).data();
Andreas Gampeace0dc12016-01-20 13:33:13 -08001297 } else if (option == "--force-determinism") {
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001298 if (!SupportsDeterministicCompilation()) {
Roland Levillainb81e9e92017-04-20 17:35:32 +01001299 Usage("Option --force-determinism requires read barriers or a CMS/MS garbage collector");
Roland Levillaineb2c7412016-01-28 14:37:01 +00001300 }
Andreas Gampeace0dc12016-01-20 13:33:13 -08001301 force_determinism_ = true;
Jeff Hao16d48432017-04-05 17:05:46 -07001302 } else if (option.starts_with("--classpath-dir=")) {
1303 classpath_dir_ = option.substr(strlen("--classpath-dir=")).data();
Calin Juravle1ce70852017-06-28 10:59:03 -07001304 } else if (option.starts_with("--class-loader-context=")) {
1305 class_loader_context_ = ClassLoaderContext::Create(
1306 option.substr(strlen("--class-loader-context=")).data());
1307 if (class_loader_context_== nullptr) {
1308 Usage("Option --class-loader-context has an incorrect format: %s", option.data());
1309 }
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001310 } else if (!compiler_options_->ParseCompilerOption(option, Usage)) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001311 Usage("Unknown argument %s", option.data());
1312 }
1313 }
1314
Jeff Hao436183f2016-01-12 16:36:50 -08001315 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001316
1317 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001318 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001319 }
1320
Jeff Haodcdc85b2015-12-04 14:06:18 -08001321 // Check whether the oat output files are writable, and open them for later. Also open a swap
1322 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001323 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001324 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1325 PruneNonExistentDexFiles();
1326
Jeff Hao436183f2016-01-12 16:36:50 -08001327 // Expand oat and image filenames for multi image.
1328 if (IsBootImage() && multi_image_) {
1329 ExpandOatAndImageFilenames();
1330 }
1331
David Brazdil7b49e6c2016-09-01 11:06:18 +01001332 // OAT and VDEX file handling
David Brazdil7b49e6c2016-09-01 11:06:18 +01001333 if (oat_fd_ == -1) {
1334 DCHECK(!oat_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08001335 for (const char* oat_filename : oat_filenames_) {
1336 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
1337 if (oat_file.get() == nullptr) {
1338 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1339 return false;
1340 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001341 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001342 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1343 oat_file->Erase();
1344 return false;
1345 }
1346 oat_files_.push_back(std::move(oat_file));
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001347 DCHECK_EQ(input_vdex_fd_, -1);
1348 if (!input_vdex_.empty()) {
1349 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001350 input_vdex_file_ = VdexFile::Open(input_vdex_,
1351 /* writable */ false,
1352 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001353 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001354 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001355 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001356
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001357 DCHECK_EQ(output_vdex_fd_, -1);
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001358 std::string vdex_filename = output_vdex_.empty()
1359 ? ReplaceFileExtension(oat_filename, "vdex")
1360 : output_vdex_;
1361 if (vdex_filename == input_vdex_ && output_vdex_.empty()) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001362 update_input_vdex_ = true;
1363 std::unique_ptr<File> vdex_file(OS::OpenFileReadWrite(vdex_filename.c_str()));
1364 vdex_files_.push_back(std::move(vdex_file));
1365 } else {
1366 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
1367 if (vdex_file.get() == nullptr) {
1368 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1369 return false;
1370 }
1371 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1372 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1373 vdex_file->Erase();
1374 return false;
1375 }
1376 vdex_files_.push_back(std::move(vdex_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001377 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001378 }
1379 } else {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001380 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, /* check_usage */ true));
Jeff Haodcdc85b2015-12-04 14:06:18 -08001381 if (oat_file.get() == nullptr) {
1382 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1383 return false;
1384 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001385 oat_file->DisableAutoClose();
1386 if (oat_file->SetLength(0) != 0) {
1387 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1388 }
1389 oat_files_.push_back(std::move(oat_file));
1390
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001391 if (input_vdex_fd_ != -1) {
1392 struct stat s;
1393 int rc = TEMP_FAILURE_RETRY(fstat(input_vdex_fd_, &s));
1394 if (rc == -1) {
1395 PLOG(WARNING) << "Failed getting length of vdex file";
1396 } else {
1397 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001398 input_vdex_file_ = VdexFile::Open(input_vdex_fd_,
1399 s.st_size,
1400 "vdex",
1401 /* writable */ false,
1402 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001403 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001404 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001405 // If there's any problem with the passed vdex, just warn and proceed
1406 // without it.
1407 if (input_vdex_file_ == nullptr) {
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001408 PLOG(WARNING) << "Failed opening vdex file: " << error_msg;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001409 }
1410 }
1411 }
1412
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001413 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001414 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001415 std::unique_ptr<File> vdex_file(new File(output_vdex_fd_, vdex_location, /* check_usage */ true));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001416 if (vdex_file.get() == nullptr) {
1417 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001418 return false;
1419 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001420 vdex_file->DisableAutoClose();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001421 if (input_vdex_file_ != nullptr && output_vdex_fd_ == input_vdex_fd_) {
1422 update_input_vdex_ = true;
1423 } else {
1424 if (vdex_file->SetLength(0) != 0) {
1425 PLOG(ERROR) << "Truncating vdex file " << vdex_location << " failed.";
1426 return false;
1427 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001428 }
1429 vdex_files_.push_back(std::move(vdex_file));
1430
Jeff Haodcdc85b2015-12-04 14:06:18 -08001431 oat_filenames_.push_back(oat_location_.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001432 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001433
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001434 // If we're updating in place a vdex file, be defensive and put an invalid vdex magic in case
1435 // dex2oat gets killed.
1436 // Note: we're only invalidating the magic data in the file, as dex2oat needs the rest of
1437 // the information to remain valid.
1438 if (update_input_vdex_) {
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07001439 std::unique_ptr<BufferedOutputStream> vdex_out = std::make_unique<BufferedOutputStream>(
1440 std::make_unique<FileOutputStream>(vdex_files_.back().get()));
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001441 if (!vdex_out->WriteFully(&VdexFile::Header::kVdexInvalidMagic,
1442 arraysize(VdexFile::Header::kVdexInvalidMagic))) {
1443 PLOG(ERROR) << "Failed to invalidate vdex header. File: " << vdex_out->GetLocation();
1444 return false;
1445 }
1446
1447 if (!vdex_out->Flush()) {
1448 PLOG(ERROR) << "Failed to flush stream after invalidating header of vdex file."
1449 << " File: " << vdex_out->GetLocation();
1450 return false;
1451 }
1452 }
1453
David Brazdil7b49e6c2016-09-01 11:06:18 +01001454 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001455 //
1456 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1457 // that we can use for swap.
1458 //
1459 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1460 // will immediately unlink to satisfy the swap fd assumption.
1461 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1462 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1463 if (swap_file.get() == nullptr) {
1464 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1465 return false;
1466 }
1467 swap_fd_ = swap_file->Fd();
1468 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1469 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1470 // released immediately.
1471 unlink(swap_file_name_.c_str());
1472 }
Jeff Hao436183f2016-01-12 16:36:50 -08001473
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001474 return true;
1475 }
1476
David Brazdil7b49e6c2016-09-01 11:06:18 +01001477 void EraseOutputFiles() {
1478 for (auto& files : { &vdex_files_, &oat_files_ }) {
1479 for (size_t i = 0; i < files->size(); ++i) {
1480 if ((*files)[i].get() != nullptr) {
1481 (*files)[i]->Erase();
1482 (*files)[i].reset();
1483 }
1484 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001485 }
Andreas Gampea650e702014-12-03 14:28:02 -08001486 }
1487
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001488 void LoadClassProfileDescriptors() {
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -07001489 if (profile_compilation_info_ != nullptr && IsImage()) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001490 Runtime* runtime = Runtime::Current();
1491 CHECK(runtime != nullptr);
Mathieu Chartier0b490842016-05-25 15:05:59 -07001492 // Filter out class path classes since we don't want to include these in the image.
Mathieu Chartier4f342b02017-07-21 17:12:39 -07001493 image_classes_.reset(
1494 new std::unordered_set<std::string>(
1495 profile_compilation_info_->GetClassDescriptors(dex_files_)));
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001496 VLOG(compiler) << "Loaded " << image_classes_->size()
1497 << " image class descriptors from profile";
1498 if (VLOG_IS_ON(compiler)) {
1499 for (const std::string& s : *image_classes_) {
1500 LOG(INFO) << "Image class " << s;
1501 }
1502 }
1503 }
1504 }
1505
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001506 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1507 // boot class path.
Andreas Gampef7882972017-03-20 16:35:24 -07001508 dex2oat::ReturnCode Setup() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001509 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001510
1511 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001512 return dex2oat::ReturnCode::kOther;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001513 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001514
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001515 // Verification results are null since we don't know if we will need them yet as the compler
1516 // filter may change.
Andreas Gampe4585f872015-03-27 23:45:15 -07001517 callbacks_.reset(new QuickCompilerCallbacks(
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001518 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001519 CompilerCallbacks::CallbackMode::kCompileBootImage :
1520 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001521
Vladimir Marko49b0f452015-12-10 13:49:19 +00001522 RuntimeArgumentMap runtime_options;
Mathieu Chartier46331a62017-07-21 09:49:10 -07001523 if (!PrepareRuntimeOptions(&runtime_options, callbacks_.get())) {
Andreas Gampef7882972017-03-20 16:35:24 -07001524 return dex2oat::ReturnCode::kOther;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001525 }
1526
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001527 CreateOatWriters();
1528 if (!AddDexFileSources()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001529 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001530 }
1531
1532 if (IsBootImage() && image_filenames_.size() > 1) {
1533 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1534 // We need this for the multi-image case.
Mathieu Chartier866d8742016-09-21 15:24:18 -07001535 key_value_store_->Put(OatHeader::kBootClassPathKey,
1536 gc::space::ImageSpace::GetMultiImageBootClassPath(dex_locations_,
1537 oat_filenames_,
1538 image_filenames_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001539 }
1540
1541 if (!IsBootImage()) {
1542 // When compiling an app, create the runtime early to retrieve
1543 // the image location key needed for the oat header.
1544 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001545 return dex2oat::ReturnCode::kCreateRuntime;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001546 }
1547
Andreas Gampe29d38e72016-03-23 15:31:51 +00001548 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001549 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1550 std::vector<gc::space::ImageSpace*> image_spaces =
1551 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Richard Uhlerbc26b722017-03-10 14:27:10 +00001552 image_file_location_oat_checksum_ = image_spaces[0]->GetImageHeader().GetOatChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001553 image_file_location_oat_data_begin_ =
1554 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1555 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1556 // Store the boot image filename(s).
1557 std::vector<std::string> image_filenames;
1558 for (const gc::space::ImageSpace* image_space : image_spaces) {
1559 image_filenames.push_back(image_space->GetImageFilename());
1560 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001561 std::string image_file_location = android::base::Join(image_filenames, ':');
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001562 if (!image_file_location.empty()) {
1563 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1564 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001565 } else {
1566 image_file_location_oat_checksum_ = 0u;
1567 image_file_location_oat_data_begin_ = 0u;
1568 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001569 }
1570
1571 // Open dex files for class path.
Calin Juravle1ce70852017-06-28 10:59:03 -07001572 if (class_loader_context_ == nullptr) {
1573 // TODO(calin): Temporary workaround while we transition to use
1574 // --class-loader-context instead of --runtime-arg -cp
1575 if (runtime_->GetClassPathString().empty()) {
1576 class_loader_context_ = std::unique_ptr<ClassLoaderContext>(
1577 new ClassLoaderContext());
1578 } else {
1579 std::string spec = runtime_->GetClassPathString() == OatFile::kSpecialSharedLibrary
1580 ? OatFile::kSpecialSharedLibrary
1581 : "PCL[" + runtime_->GetClassPathString() + "]";
1582 class_loader_context_ = ClassLoaderContext::Create(spec);
1583 }
Jeff Haof0192c82016-03-28 20:39:50 -07001584 }
Calin Juravle1ce70852017-06-28 10:59:03 -07001585 CHECK(class_loader_context_ != nullptr);
1586 DCHECK_EQ(oat_writers_.size(), 1u);
1587
1588 // Note: Ideally we would reject context where the source dex files are also
1589 // specified in the classpath (as it doesn't make sense). However this is currently
1590 // needed for non-prebuild tests and benchmarks which expects on the fly compilation.
1591 // Also, for secondary dex files we do not have control on the actual classpath.
1592 // Instead of aborting, remove all the source location from the context classpaths.
1593 if (class_loader_context_->RemoveLocationsFromClassPaths(
1594 oat_writers_[0]->GetSourceLocations())) {
1595 LOG(WARNING) << "The source files to be compiled are also in the classpath.";
1596 }
1597
1598 // We need to open the dex files before encoding the context in the oat file.
1599 // (because the encoding adds the dex checksum...)
1600 // TODO(calin): consider redesigning this so we don't have to open the dex files before
1601 // creating the actual class loader.
1602 if (!class_loader_context_->OpenDexFiles(runtime_->GetInstructionSet(), classpath_dir_)) {
1603 // Do not abort if we couldn't open files from the classpath. They might be
1604 // apks without dex files and right now are opening flow will fail them.
1605 LOG(WARNING) << "Failed to open classpath dex files";
1606 }
1607
1608 // Store the class loader context in the oat header.
1609 key_value_store_->Put(OatHeader::kClassPathKey,
1610 class_loader_context_->EncodeContextForOatFile(classpath_dir_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001611 }
1612
1613 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001614 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001615 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1616 rodata_.reserve(oat_writers_.size());
1617 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1618 rodata_.push_back(elf_writers_[i]->StartRoData());
1619 // Unzip or copy dex files straight to the oat file.
1620 std::unique_ptr<MemMap> opened_dex_files_map;
1621 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001622 // No need to verify the dex file for:
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001623 // 1) Dexlayout since it does the verification. It also may not pass the verification since
1624 // we don't update the dex checksum.
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001625 // 2) when we have a vdex file, which means it was already verified.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001626 const bool verify = !DoDexLayoutOptimizations() && (input_vdex_file_ == nullptr);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001627 if (!oat_writers_[i]->WriteAndOpenDexFiles(
1628 kIsVdexEnabled ? vdex_files_[i].get() : oat_files_[i].get(),
1629 rodata_.back(),
1630 instruction_set_,
1631 instruction_set_features_.get(),
1632 key_value_store_.get(),
Jeff Hao042e8982016-10-19 11:17:11 -07001633 verify,
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001634 update_input_vdex_,
David Brazdil7b49e6c2016-09-01 11:06:18 +01001635 &opened_dex_files_map,
1636 &opened_dex_files)) {
Andreas Gampef7882972017-03-20 16:35:24 -07001637 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001638 }
1639 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1640 if (opened_dex_files_map != nullptr) {
1641 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
1642 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001643 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001644 opened_dex_files_.push_back(std::move(dex_file));
1645 }
1646 } else {
1647 DCHECK(opened_dex_files.empty());
1648 }
1649 }
1650 }
1651
1652 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
Andreas Gampe7386da42016-06-08 18:18:47 -07001653
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001654 // If we need to downgrade the compiler-filter for size reasons.
1655 if (!IsBootImage() && IsVeryLarge(dex_files_)) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001656 // If we need to downgrade the compiler-filter for size reasons, do that early before we read
1657 // it below for creating verification callbacks.
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001658 if (!CompilerFilter::IsAsGoodAs(kLargeAppFilter, compiler_options_->GetCompilerFilter())) {
1659 LOG(INFO) << "Very large app, downgrading to verify.";
1660 // Note: this change won't be reflected in the key-value store, as that had to be
1661 // finalized before loading the dex files. This setup is currently required
1662 // to get the size from the DexFile objects.
1663 // TODO: refactor. b/29790079
1664 compiler_options_->SetCompilerFilter(kLargeAppFilter);
1665 }
1666 }
1667
1668 if (CompilerFilter::IsAnyCompilationEnabled(compiler_options_->GetCompilerFilter())) {
1669 // Only modes with compilation require verification results, do this here instead of when we
1670 // create the compilation callbacks since the compilation mode may have been changed by the
1671 // very large app logic.
1672 // Avoiding setting the verification results saves RAM by not adding the dex files later in
1673 // the function.
1674 verification_results_.reset(new VerificationResults(compiler_options_.get()));
1675 callbacks_->SetVerificationResults(verification_results_.get());
1676 }
1677
Andreas Gampe7386da42016-06-08 18:18:47 -07001678 // We had to postpone the swap decision till now, as this is the point when we actually
1679 // know about the dex files we're going to use.
1680
1681 // Make sure that we didn't create the driver, yet.
1682 CHECK(driver_ == nullptr);
1683 // If we use a swap file, ensure we are above the threshold to make it necessary.
1684 if (swap_fd_ != -1) {
1685 if (!UseSwap(IsBootImage(), dex_files_)) {
1686 close(swap_fd_);
1687 swap_fd_ = -1;
1688 VLOG(compiler) << "Decided to run without swap.";
1689 } else {
1690 LOG(INFO) << "Large app, accepted running with swap.";
1691 }
1692 }
1693 // 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 +00001694 if (IsBootImage()) {
1695 // For boot image, pass opened dex files to the Runtime::Create().
1696 // Note: Runtime acquires ownership of these dex files.
1697 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001698 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001699 return dex2oat::ReturnCode::kOther;
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001700 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001701 }
1702
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001703 // If we're doing the image, override the compiler filter to force full compilation. Must be
1704 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1705 // compilation of class initializers.
1706 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001707 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001708 WellKnownClasses::Init(self->GetJniEnv());
1709
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001710 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001711 constexpr bool kSaveDexInput = false;
1712 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001713 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001714 }
1715 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001716
1717 // Ensure opened dex files are writable for dex-to-dex transformations.
1718 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1719 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1720 PLOG(ERROR) << "Failed to make .dex files writeable.";
Andreas Gampef7882972017-03-20 16:35:24 -07001721 return dex2oat::ReturnCode::kOther;
Vladimir Marko919f5532016-01-20 19:13:01 +00001722 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001723 }
1724
Mathieu Chartier72041a02017-07-14 18:23:25 -07001725 // Verification results are only required for modes that have any compilation. Avoid
1726 // adding the dex files if possible to prevent allocating large arrays.
1727 if (verification_results_ != nullptr) {
1728 for (const auto& dex_file : dex_files_) {
1729 // Pre-register dex files so that we can access verification results without locks during
1730 // compilation and verification.
Mathieu Chartier0733dc82017-07-17 14:05:28 -07001731 verification_results_->AddDexFile(dex_file);
1732 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001733 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001734
Andreas Gampef7882972017-03-20 16:35:24 -07001735 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001736 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001737
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001738 // If we need to keep the oat file open for the image writer.
1739 bool ShouldKeepOatFileOpen() const {
1740 return IsImage() && oat_fd_ != kInvalidFd;
1741 }
1742
Mathieu Chartier72041a02017-07-14 18:23:25 -07001743 // Doesn't return the class loader since it's not meant to be used for image compilation.
1744 void CompileDexFilesIndividually() {
1745 CHECK(!IsImage()) << "Not supported with image";
1746 for (const DexFile* dex_file : dex_files_) {
1747 std::vector<const DexFile*> dex_files(1u, dex_file);
1748 VLOG(compiler) << "Compiling " << dex_file->GetLocation();
1749 jobject class_loader = CompileDexFiles(dex_files);
1750 CHECK(class_loader != nullptr);
1751 ScopedObjectAccess soa(Thread::Current());
1752 // Unload class loader to free RAM.
1753 jweak weak_class_loader = soa.Env()->vm->AddWeakGlobalRef(
1754 soa.Self(),
1755 soa.Decode<mirror::ClassLoader>(class_loader));
1756 soa.Env()->vm->DeleteGlobalRef(soa.Self(), class_loader);
1757 runtime_->GetHeap()->CollectGarbage(/*clear_soft_references*/ true);
1758 ObjPtr<mirror::ClassLoader> decoded_weak = soa.Decode<mirror::ClassLoader>(weak_class_loader);
1759 if (decoded_weak != nullptr) {
1760 LOG(FATAL) << "Failed to unload class loader, path from root set: "
1761 << runtime_->GetHeap()->GetVerification()->FirstPathFromRootSet(decoded_weak);
1762 }
1763 VLOG(compiler) << "Unloaded classloader";
1764 }
1765 }
1766
1767 bool ShouldCompileDexFilesIndividually() const {
1768 // Compile individually if we are not building an image, not using any compilation, and are
1769 // using multidex.
1770 // This means extract, verify, and quicken will use the individual compilation mode (to reduce
1771 // RAM used by the compiler).
1772 // TODO: Still do it for app images to get testing coverage. Note that this will generate empty
1773 // app images.
1774 return !IsImage() &&
1775 dex_files_.size() > 1 &&
1776 !CompilerFilter::IsAnyCompilationEnabled(compiler_options_->GetCompilerFilter());
1777 }
1778
1779 // Set up and create the compiler driver and then invoke it to compile all the dex files.
1780 jobject Compile() {
1781 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1782
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001783 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1784 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001785
Vladimir Marko47496c22016-01-27 16:15:08 +00001786 // Find the dex files we should not inline from.
Vladimir Marko47496c22016-01-27 16:15:08 +00001787 std::vector<std::string> no_inline_filters;
1788 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001789
1790 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001791 const std::string core_oj = "core-oj";
1792 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1793 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001794 }
1795
Vladimir Marko47496c22016-01-27 16:15:08 +00001796 if (!no_inline_filters.empty()) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001797 std::vector<const DexFile*> class_path_files;
1798 if (!IsBootImage()) {
1799 // The class loader context is used only for apps.
1800 class_path_files = class_loader_context_->FlattenOpenedDexFiles();
1801 }
1802
Jeff Haodcdc85b2015-12-04 14:06:18 -08001803 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1804 &class_linker->GetBootClassPath(),
1805 &class_path_files,
1806 &dex_files_
1807 };
1808 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001809 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001810 for (const std::string& filter : no_inline_filters) {
1811 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
Calin Juravlea308a322017-07-18 16:51:51 -07001812 // allows tests to specify <test-dexfile>!classes2.dex if needed but if the
Vladimir Marko47496c22016-01-27 16:15:08 +00001813 // base location passes the StartsWith() test, so do all extra locations.
1814 std::string dex_location = dex_file->GetLocation();
1815 if (filter.find('/') == std::string::npos) {
1816 // The filter does not contain the path. Remove the path from dex_location as well.
1817 size_t last_slash = dex_file->GetLocation().rfind('/');
1818 if (last_slash != std::string::npos) {
1819 dex_location = dex_location.substr(last_slash + 1);
1820 }
1821 }
1822
Andreas Gampe9186ced2016-12-12 14:28:21 -08001823 if (android::base::StartsWith(dex_location, filter.c_str())) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001824 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1825 no_inline_from_dex_files_.push_back(dex_file);
1826 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001827 }
1828 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001829 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001830 }
1831 if (!no_inline_from_dex_files_.empty()) {
1832 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001833 }
1834 }
1835
Vladimir Marko307dac92015-10-20 11:20:09 +01001836 driver_.reset(new CompilerDriver(compiler_options_.get(),
1837 verification_results_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001838 compiler_kind_,
1839 instruction_set_,
1840 instruction_set_features_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001841 image_classes_.release(),
1842 compiled_classes_.release(),
Wojciech Staszkiewicz62534792016-08-09 14:30:55 -07001843 compiled_methods_.release(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001844 thread_count_,
1845 dump_stats_,
1846 dump_passes_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001847 compiler_phases_timings_.get(),
1848 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001849 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001850 driver_->SetDexFilesForOatFile(dex_files_);
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001851
1852 // Setup vdex for compilation.
1853 if (!DoEagerUnquickeningOfVdex() && input_vdex_file_ != nullptr) {
1854 callbacks_->SetVerifierDeps(
1855 new verifier::VerifierDeps(dex_files_, input_vdex_file_->GetVerifierDepsData()));
1856
1857 // TODO: we unquicken unconditionally, as we don't know
1858 // if the boot image has changed. How exactly we'll know is under
1859 // experimentation.
1860 TimingLogger::ScopedTiming time_unquicken("Unquicken", timings_);
1861 VdexFile::Unquicken(dex_files_, input_vdex_file_->GetQuickeningInfo());
Mathieu Chartier72041a02017-07-14 18:23:25 -07001862 } else {
1863 // Create the main VerifierDeps, here instead of in the compiler since we want to aggregate
1864 // the results for all the dex files, not just the results for the current dex file.
1865 callbacks_->SetVerifierDeps(new verifier::VerifierDeps(dex_files_));
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001866 }
Mathieu Chartier72041a02017-07-14 18:23:25 -07001867 // Invoke the compilation.
1868 if (ShouldCompileDexFilesIndividually()) {
1869 CompileDexFilesIndividually();
1870 // Return a null classloader since we already freed released it.
1871 return nullptr;
1872 }
1873 return CompileDexFiles(dex_files_);
1874 }
1875
1876 // Create the class loader, use it to compile, and return.
1877 jobject CompileDexFiles(const std::vector<const DexFile*>& dex_files) {
1878 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1879
1880 jobject class_loader = nullptr;
1881 if (!IsBootImage()) {
1882 class_loader = class_loader_context_->CreateClassLoader(dex_files_);
1883 }
1884
1885 // Register dex caches and key them to the class loader so that they only unload when the
1886 // class loader unloads.
1887 for (const auto& dex_file : dex_files) {
1888 ScopedObjectAccess soa(Thread::Current());
1889 // Registering the dex cache adds a strong root in the class loader that prevents the dex
1890 // cache from being unloaded early.
1891 ObjPtr<mirror::DexCache> dex_cache = class_linker->RegisterDexFile(
1892 *dex_file,
1893 soa.Decode<mirror::ClassLoader>(class_loader));
1894 if (dex_cache == nullptr) {
1895 soa.Self()->AssertPendingException();
1896 LOG(FATAL) << "Failed to register dex file " << dex_file->GetLocation() << " "
1897 << soa.Self()->GetException()->Dump();
1898 }
1899 }
1900 driver_->CompileAll(class_loader, dex_files, timings_);
1901 return class_loader;
Vladimir Markof4da6752014-08-01 19:04:18 +01001902 }
1903
Jeff Hao436183f2016-01-12 16:36:50 -08001904 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001905 // ensure the references between the two are correct.
1906 //
1907 // Currently we have a memory layout that looks something like this:
1908 //
1909 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001910 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001911 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001912 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001913 // +--------------+
1914 // | alloc spaces |
1915 // +--------------+
1916 //
Jeff Hao436183f2016-01-12 16:36:50 -08001917 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001918 //
Jeff Hao436183f2016-01-12 16:36:50 -08001919 // 1. The images are expected to be loaded at an absolute address and
1920 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001921 //
Jeff Hao436183f2016-01-12 16:36:50 -08001922 // 2. There are absolute pointers from Methods in the images to their
1923 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001924 //
Jeff Hao436183f2016-01-12 16:36:50 -08001925 // 3. There are absolute pointers from the code in the oat files to Methods
1926 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001927 //
Jeff Hao436183f2016-01-12 16:36:50 -08001928 // 4. There are absolute pointers from code in the oat files to other code
1929 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001930 //
1931 // To get this all correct, we go through several steps.
1932 //
Jeff Hao436183f2016-01-12 16:36:50 -08001933 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001934 // the oat data size and code size. During this stage, we also set
1935 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001936 //
Jeff Hao436183f2016-01-12 16:36:50 -08001937 // 2. We prepare offsets for the objects in the images and calculate
1938 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001939 //
Jeff Hao436183f2016-01-12 16:36:50 -08001940 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001941 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001942 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001943 // can prepare the ELF headers and we then know the ELF memory segment
1944 // layout and we can now resolve all references. The compiler provides
1945 // LinkerPatch information in each CompiledMethod and we resolve these,
1946 // using the layout information and image object locations provided by
1947 // image writer, as we're writing the method code.
1948 //
Jeff Hao436183f2016-01-12 16:36:50 -08001949 // 4. We create the image files. They need to know where the oat files
1950 // will be loaded after itself. Originally oat files were simply
1951 // memory mapped so we could predict where their contents were based
1952 // on the file size. Now that they are ELF files, we need to inspect
1953 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001954 // where the oat header is located within.
1955 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001956 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001957 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001958 // load the .so at the desired location at runtime by offsetting the
1959 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001960 // TODO: Do this in step 3. We already know the layout there.
1961 //
1962 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1963 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001964
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001965 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1966 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001967 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1968 // case (when the file will be explicitly erased).
David Brazdil7b49e6c2016-09-01 11:06:18 +01001969 bool WriteOutputFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001970 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1971
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001972 // Sync the data to the file, in case we did dex2dex transformations.
1973 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1974 if (!map->Sync()) {
1975 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1976 return false;
1977 }
1978 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001979
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001980 if (IsImage()) {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001981 if (IsAppImage() && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001982 gc::Heap* const heap = Runtime::Current()->GetHeap();
1983 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001984 image_base_ = std::max(image_base_, RoundUp(
1985 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1986 kPageSize));
1987 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001988 // The non moving space is right after the oat file. Put the preferred app image location
1989 // right after the non moving space so that we ideally get a continuous immune region for
1990 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001991 // Use the default non moving space capacity since dex2oat does not have a separate non-
1992 // moving space. This means the runtime's non moving space space size will be as large
1993 // as the growth limit for dex2oat, but smaller in the zygote.
1994 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001995 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001996 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1997 }
1998
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001999 image_writer_.reset(new ImageWriter(*driver_,
2000 image_base_,
2001 compiler_options_->GetCompilePic(),
2002 IsAppImage(),
2003 image_storage_mode_,
2004 oat_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002005 dex_file_oat_index_map_));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002006
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002007 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002008 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
2009 if (!image_writer_->PrepareImageAddressSpace()) {
2010 LOG(ERROR) << "Failed to prepare image address space.";
2011 return false;
2012 }
2013 }
2014
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002015 // Initialize the writers with the compiler driver, image writer, and their
2016 // dex files. The writers were created without those being there yet.
2017 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
2018 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
2019 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
2020 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
2021 }
2022
David Brazdil5d5a36b2016-09-14 15:34:10 +01002023 {
2024 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
2025 DCHECK(IsBootImage() || oat_files_.size() == 1u);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00002026 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
David Brazdil5d5a36b2016-09-14 15:34:10 +01002027 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
2028 File* vdex_file = vdex_files_[i].get();
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07002029 std::unique_ptr<BufferedOutputStream> vdex_out =
2030 std::make_unique<BufferedOutputStream>(std::make_unique<FileOutputStream>(vdex_file));
David Brazdil5d5a36b2016-09-14 15:34:10 +01002031
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00002032 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002033 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
2034 return false;
2035 }
2036
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002037 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
2038 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
2039 return false;
2040 }
2041
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +00002042 // VDEX finalized, seek back to the beginning and write checksums and the header.
2043 if (!oat_writers_[i]->WriteChecksumsAndVdexHeader(vdex_out.get())) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002044 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
2045 return false;
2046 }
2047 }
2048 }
2049
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002050 {
2051 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002052 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002053 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko944da602016-02-19 12:27:55 +00002054 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
2055 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
2056
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002057 oat_writer->PrepareLayout(&patcher);
Vladimir Marko944da602016-02-19 12:27:55 +00002058
2059 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
David Brazdil7b49e6c2016-09-01 11:06:18 +01002060 size_t text_size = oat_writer->GetOatSize() - rodata_size;
Vladimir Markoaad75c62016-10-03 08:46:48 +00002061 elf_writer->PrepareDynamicSection(rodata_size,
2062 text_size,
2063 oat_writer->GetBssSize(),
Vladimir Marko0eb882b2017-05-15 13:39:18 +01002064 oat_writer->GetBssMethodsOffset(),
Vladimir Markoaad75c62016-10-03 08:46:48 +00002065 oat_writer->GetBssRootsOffset());
Vladimir Marko944da602016-02-19 12:27:55 +00002066
2067 if (IsImage()) {
2068 // Update oat layout.
2069 DCHECK(image_writer_ != nullptr);
2070 DCHECK_LT(i, oat_filenames_.size());
2071 image_writer_->UpdateOatFileLayout(i,
2072 elf_writer->GetLoadedSize(),
2073 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01002074 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002075 }
Richard Uhlerbc26b722017-03-10 14:27:10 +00002076
2077 if (IsBootImage()) {
2078 // Have the image_file_location_oat_checksum_ for boot oat files
2079 // depend on the contents of all the boot oat files. This way only
2080 // the primary image checksum needs to be checked to determine
2081 // whether any of the images are out of date.
2082 image_file_location_oat_checksum_ ^= oat_writer->GetOatHeader().GetChecksum();
2083 }
Vladimir Marko944da602016-02-19 12:27:55 +00002084 }
2085
2086 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002087 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002088 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
2089 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00002090
David Srbecky09c2a6b2016-03-11 17:11:44 +00002091 oat_writer->AddMethodDebugInfos(debug::MakeTrampolineInfos(oat_writer->GetOatHeader()));
2092
David Srbecky0c4572e2016-01-22 19:19:25 +00002093 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00002094 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
2095 elf_writer->PrepareDebugInfo(oat_writer->GetMethodDebugInfo());
David Srbecky0c4572e2016-01-22 19:19:25 +00002096
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002097 OutputStream*& rodata = rodata_[i];
2098 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002099 if (!oat_writer->WriteRodata(rodata)) {
2100 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
2101 return false;
2102 }
2103 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002104 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00002105
Jeff Haodcdc85b2015-12-04 14:06:18 -08002106 OutputStream* text = elf_writer->StartText();
2107 if (!oat_writer->WriteCode(text)) {
2108 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
2109 return false;
2110 }
2111 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00002112
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002113 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
2114 image_file_location_oat_checksum_,
2115 image_file_location_oat_data_begin_,
2116 image_patch_delta_)) {
2117 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
2118 return false;
2119 }
2120
Vladimir Marko944da602016-02-19 12:27:55 +00002121 if (IsImage()) {
2122 // Update oat header information.
2123 DCHECK(image_writer_ != nullptr);
2124 DCHECK_LT(i, oat_filenames_.size());
2125 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
2126 }
2127
Jeff Haodcdc85b2015-12-04 14:06:18 -08002128 elf_writer->WriteDynamicSection();
2129 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
Vladimir Marko10c13562015-11-25 14:33:36 +00002130
Jeff Haodcdc85b2015-12-04 14:06:18 -08002131 if (!elf_writer->End()) {
2132 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
2133 return false;
2134 }
2135
David Brazdil7b49e6c2016-09-01 11:06:18 +01002136 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
2137 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002138 }
2139
Jeff Haodcdc85b2015-12-04 14:06:18 -08002140 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002141
2142 oat_writer.reset();
2143 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002144 }
2145 }
2146
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002147 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002148 }
2149
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002150 // If we are compiling an image, invoke the image creation routine. Else just skip.
2151 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002152 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002153 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
2154 if (!CreateImageFile()) {
2155 return false;
2156 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002157 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07002158 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002159 return true;
2160 }
2161
Jeff Haodcdc85b2015-12-04 14:06:18 -08002162 // Create a copy from stripped to unstripped.
2163 bool CopyStrippedToUnstripped() {
2164 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
2165 // If we don't want to strip in place, copy from stripped location to unstripped location.
2166 // We need to strip after image creation because FixupElf needs to use .strtab.
2167 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
2168 // If the oat file is still open, flush it.
2169 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002170 if (!FlushCloseOutputFile(&oat_files_[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002171 return false;
2172 }
2173 }
2174
2175 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
2176 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
2177 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01002178 int64_t in_length = in->GetLength();
2179 if (in_length < 0) {
2180 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
2181 return false;
2182 }
2183 if (!out->Copy(in.get(), 0, in_length)) {
2184 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
2185 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002186 }
2187 if (out->FlushCloseOrErase() != 0) {
2188 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
2189 return false;
2190 }
2191 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
2192 }
2193 }
2194 return true;
2195 }
2196
David Brazdil7b49e6c2016-09-01 11:06:18 +01002197 bool FlushOutputFile(std::unique_ptr<File>* file) {
2198 if (file->get() != nullptr) {
2199 if (file->get()->Flush() != 0) {
2200 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
2201 return false;
2202 }
2203 }
2204 return true;
2205 }
2206
2207 bool FlushCloseOutputFile(std::unique_ptr<File>* file) {
2208 if (file->get() != nullptr) {
2209 std::unique_ptr<File> tmp(file->release());
2210 if (tmp->FlushCloseOrErase() != 0) {
2211 PLOG(ERROR) << "Failed to flush and close output file: " << tmp->GetPath();
2212 return false;
2213 }
2214 }
2215 return true;
2216 }
2217
2218 bool FlushOutputFiles() {
2219 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
2220 for (auto& files : { &vdex_files_, &oat_files_ }) {
2221 for (size_t i = 0; i < files->size(); ++i) {
2222 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002223 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08002224 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002225 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00002226 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002227 return true;
2228 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002229
David Brazdil7b49e6c2016-09-01 11:06:18 +01002230 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002231 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002232 for (auto& files : { &vdex_files_, &oat_files_ }) {
2233 for (size_t i = 0; i < files->size(); ++i) {
2234 result &= FlushCloseOutputFile(&(*files)[i]);
2235 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002236 }
2237 return result;
2238 }
2239
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002240 void DumpTiming() {
2241 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
2242 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2243 }
2244 if (dump_passes_) {
2245 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
2246 }
2247 }
2248
Andreas Gampe10e477d2014-11-19 12:57:42 -08002249 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002250 return IsAppImage() || IsBootImage();
2251 }
2252
2253 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002254 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002255 }
2256
2257 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002258 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002259 }
2260
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002261 bool IsHost() const {
2262 return is_host_;
2263 }
2264
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002265 bool UseProfile() const {
Mathieu Chartierd0af56c2017-02-17 12:56:25 -08002266 return profile_file_fd_ != -1 || !profile_file_.empty();
Calin Juravle998c2162015-12-21 15:39:33 +02002267 }
2268
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002269 bool DoProfileGuidedOptimizations() const {
Nicolas Geoffray49cda062017-04-21 13:08:25 +01002270 return UseProfile();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002271 }
2272
2273 bool DoDexLayoutOptimizations() const {
2274 return DoProfileGuidedOptimizations();
2275 }
2276
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01002277 bool DoEagerUnquickeningOfVdex() const {
2278 // DexLayout can invalidate the vdex metadata, so we need to unquicken
2279 // the vdex file eagerly, before passing it to dexlayout.
2280 return DoDexLayoutOptimizations();
2281 }
2282
Calin Juravle2e2db782016-02-23 12:00:03 +00002283 bool LoadProfile() {
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002284 DCHECK(UseProfile());
Calin Juravlee6f87cc2017-05-24 17:41:05 -07002285 // TODO(calin): We should be using the runtime arena pool (instead of the
2286 // default profile arena). However the setup logic is messy and needs
2287 // cleaning up before that (e.g. the oat writers are created before the
2288 // runtime).
Calin Juravle2e2db782016-02-23 12:00:03 +00002289 profile_compilation_info_.reset(new ProfileCompilationInfo());
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002290 ScopedFlock profile_file;
Calin Juravle2e2db782016-02-23 12:00:03 +00002291 std::string error;
2292 if (profile_file_fd_ != -1) {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002293 profile_file = LockedFile::DupOf(profile_file_fd_, "profile",
2294 true /* read_only_mode */, &error);
Andreas Gampe29d38e72016-03-23 15:31:51 +00002295 } else if (profile_file_ != "") {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002296 profile_file = LockedFile::Open(profile_file_.c_str(), O_RDONLY, true, &error);
Calin Juravle998c2162015-12-21 15:39:33 +02002297 }
Calin Juravle877fd962016-01-05 14:29:29 +00002298
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002299 // Return early if we're unable to obtain a lock on the profile.
2300 if (profile_file.get() == nullptr) {
2301 LOG(ERROR) << "Cannot lock profiles: " << error;
2302 return false;
2303 }
2304
2305 if (!profile_compilation_info_->Load(profile_file->Fd())) {
Calin Juravle2e2db782016-02-23 12:00:03 +00002306 profile_compilation_info_.reset(nullptr);
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002307 return false;
Calin Juravle2e2db782016-02-23 12:00:03 +00002308 }
Calin Juravle877fd962016-01-05 14:29:29 +00002309
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002310 return true;
Calin Juravle998c2162015-12-21 15:39:33 +02002311 }
2312
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002313 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002314 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2315 if (is_image) {
2316 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2317 return false;
2318 }
2319 if (dex_files.size() < min_dex_files_for_swap_) {
2320 // If there are less dex files than the threshold, assume it's gonna be fine.
2321 return false;
2322 }
2323 size_t dex_files_size = 0;
2324 for (const auto* dex_file : dex_files) {
2325 dex_files_size += dex_file->GetHeader().file_size_;
2326 }
2327 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2328 }
2329
Andreas Gampe67f02822016-06-24 21:05:23 -07002330 bool IsVeryLarge(std::vector<const DexFile*>& dex_files) {
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 >= very_large_threshold_;
2336 }
2337
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002338 std::vector<std::string> GetClassPathLocations(const std::string& class_path) {
2339 // This function is used only for apps and for an app we have exactly one oat file.
2340 DCHECK(!IsBootImage());
2341 DCHECK_EQ(oat_writers_.size(), 1u);
2342 std::vector<std::string> dex_files_canonical_locations;
Calin Juravle1ce70852017-06-28 10:59:03 -07002343 for (const std::string& location : oat_writers_[0]->GetSourceLocations()) {
2344 dex_files_canonical_locations.push_back(DexFile::GetDexCanonicalLocation(location.c_str()));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002345 }
Vladimir Marko625a64a2015-11-26 14:44:16 +00002346
Vladimir Marko919f5532016-01-20 19:13:01 +00002347 std::vector<std::string> parsed;
2348 Split(class_path, ':', &parsed);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002349 auto kept_it = std::remove_if(parsed.begin(),
2350 parsed.end(),
2351 [dex_files_canonical_locations](const std::string& location) {
2352 return ContainsElement(dex_files_canonical_locations,
2353 DexFile::GetDexCanonicalLocation(location.c_str()));
2354 });
2355 parsed.erase(kept_it, parsed.end());
2356 return parsed;
2357 }
2358
Vladimir Marko49b0f452015-12-10 13:49:19 +00002359 bool PrepareImageClasses() {
2360 // If --image-classes was specified, calculate the full list of classes to include in the image.
2361 if (image_classes_filename_ != nullptr) {
2362 image_classes_ =
2363 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2364 if (image_classes_ == nullptr) {
2365 return false;
2366 }
2367 } else if (IsBootImage()) {
2368 image_classes_.reset(new std::unordered_set<std::string>);
2369 }
2370 return true;
2371 }
2372
2373 bool PrepareCompiledClasses() {
2374 // If --compiled-classes was specified, calculate the full list of classes to compile in the
2375 // image.
2376 if (compiled_classes_filename_ != nullptr) {
2377 compiled_classes_ =
2378 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
2379 if (compiled_classes_ == nullptr) {
2380 return false;
2381 }
2382 } else {
2383 compiled_classes_.reset(nullptr); // By default compile everything.
2384 }
2385 return true;
2386 }
2387
2388 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2389 const char* classes_filename,
2390 const char* tag) {
2391 std::unique_ptr<std::unordered_set<std::string>> classes;
2392 std::string error_msg;
2393 if (zip_filename != nullptr) {
2394 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2395 } else {
2396 classes.reset(ReadImageClassesFromFile(classes_filename));
2397 }
2398 if (classes == nullptr) {
2399 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2400 << classes_filename << "': " << error_msg;
2401 }
2402 return classes;
2403 }
2404
2405 bool PrepareCompiledMethods() {
2406 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2407 if (compiled_methods_filename_ != nullptr) {
2408 std::string error_msg;
2409 if (compiled_methods_zip_filename_ != nullptr) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002410 compiled_methods_.reset(ReadCommentedInputFromZip<std::unordered_set<std::string>>(
2411 compiled_methods_zip_filename_,
2412 compiled_methods_filename_,
2413 nullptr, // No post-processing.
2414 &error_msg));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002415 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002416 compiled_methods_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2417 compiled_methods_filename_,
2418 nullptr)); // No post-processing.
Vladimir Marko49b0f452015-12-10 13:49:19 +00002419 }
2420 if (compiled_methods_.get() == nullptr) {
2421 LOG(ERROR) << "Failed to create list of compiled methods from '"
2422 << compiled_methods_filename_ << "': " << error_msg;
2423 return false;
2424 }
2425 } else {
2426 compiled_methods_.reset(nullptr); // By default compile everything.
2427 }
2428 return true;
2429 }
2430
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002431 void PruneNonExistentDexFiles() {
2432 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2433 size_t kept = 0u;
2434 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2435 if (!OS::FileExists(dex_filenames_[i])) {
2436 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2437 } else {
2438 dex_filenames_[kept] = dex_filenames_[i];
2439 dex_locations_[kept] = dex_locations_[i];
2440 ++kept;
2441 }
2442 }
2443 dex_filenames_.resize(kept);
2444 dex_locations_.resize(kept);
2445 }
2446
2447 bool AddDexFileSources() {
2448 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002449 if (input_vdex_file_ != nullptr) {
2450 DCHECK_EQ(oat_writers_.size(), 1u);
2451 const std::string& name = zip_location_.empty() ? dex_locations_[0] : zip_location_;
2452 DCHECK(!name.empty());
2453 if (!oat_writers_[0]->AddVdexDexFilesSource(*input_vdex_file_.get(), name.c_str())) {
2454 return false;
2455 }
2456 } else if (zip_fd_ != -1) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002457 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002458 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2459 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002460 return false;
2461 }
2462 } else if (oat_writers_.size() > 1u) {
2463 // Multi-image.
2464 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2465 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2466 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2467 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2468 return false;
2469 }
2470 }
2471 } else {
2472 DCHECK_EQ(oat_writers_.size(), 1u);
2473 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2474 DCHECK_NE(dex_filenames_.size(), 0u);
2475 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2476 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2477 return false;
2478 }
2479 }
2480 }
2481 return true;
2482 }
2483
2484 void CreateOatWriters() {
2485 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2486 elf_writers_.reserve(oat_files_.size());
2487 oat_writers_.reserve(oat_files_.size());
2488 for (const std::unique_ptr<File>& oat_file : oat_files_) {
David Srbecky5d811202016-03-08 13:21:22 +00002489 elf_writers_.emplace_back(CreateElfWriterQuick(instruction_set_,
2490 instruction_set_features_.get(),
2491 compiler_options_.get(),
2492 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002493 elf_writers_.back()->Start();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002494 const bool do_dexlayout = DoDexLayoutOptimizations();
Jeff Hao608f2ce2016-10-19 11:17:11 -07002495 oat_writers_.emplace_back(new OatWriter(
2496 IsBootImage(), timings_, do_dexlayout ? profile_compilation_info_.get() : nullptr));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002497 }
2498 }
2499
Vladimir Marko49b0f452015-12-10 13:49:19 +00002500 void SaveDexInput() {
2501 for (size_t i = 0; i < dex_files_.size(); ++i) {
2502 const DexFile* dex_file = dex_files_[i];
2503 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2504 getpid(), i));
2505 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2506 if (tmp_file.get() == nullptr) {
2507 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2508 << ". Try: adb shell chmod 777 /data/local/tmp";
2509 continue;
2510 }
2511 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2512 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2513 UNUSED(tmp_file->Flush());
2514 UNUSED(tmp_file->Close());
2515 LOG(INFO) << "Wrote input to " << tmp_file_name;
2516 }
2517 }
2518
Mathieu Chartier46331a62017-07-21 09:49:10 -07002519 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options,
2520 QuickCompilerCallbacks* callbacks) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00002521 RuntimeOptions raw_options;
2522 if (boot_image_filename_.empty()) {
2523 std::string boot_class_path = "-Xbootclasspath:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002524 boot_class_path += android::base::Join(dex_filenames_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002525 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2526 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002527 boot_class_path_locations += android::base::Join(dex_locations_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002528 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2529 } else {
2530 std::string boot_image_option = "-Ximage:";
2531 boot_image_option += boot_image_filename_;
2532 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2533 }
2534 for (size_t i = 0; i < runtime_args_.size(); i++) {
2535 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2536 }
2537
Mathieu Chartier46331a62017-07-21 09:49:10 -07002538 raw_options.push_back(std::make_pair("compilercallbacks", callbacks));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002539 raw_options.push_back(
2540 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2541
2542 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2543 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2544 // have been stripped in preopting, anyways).
2545 if (!IsBootImage()) {
2546 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2547 }
Andreas Gampec8e35202017-04-28 15:47:12 -07002548 // Never allow implicit image compilation.
2549 raw_options.push_back(std::make_pair("-Xnoimage-dex2oat", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002550 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2551 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2552 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002553 // Disable Hspace compaction to save heap size virtual space.
2554 // Only need disable Hspace for OOM becasue background collector is equal to
2555 // foreground collector by default for dex2oat.
2556 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002557
Andreas Gampeace0dc12016-01-20 13:33:13 -08002558 if (compiler_options_->IsForceDeterminism()) {
Roland Levillainb81e9e92017-04-20 17:35:32 +01002559 // If we're asked to be deterministic, ensure non-concurrent GC for determinism.
2560 //
2561 // Note that with read barriers, this option is ignored, because Runtime::Init
2562 // overrides the foreground GC to be gc::kCollectorTypeCC when instantiating
2563 // gc::Heap. This is fine, as concurrent GC requests are not honored in dex2oat,
2564 // which uses an unstarted runtime.
Andreas Gampeace0dc12016-01-20 13:33:13 -08002565 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
Roland Levillainb81e9e92017-04-20 17:35:32 +01002566
Nicolas Geoffray7acddd82017-05-03 15:04:55 +01002567 // The default LOS implementation (map) is not deterministic. So disable it.
2568 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=disabled", nullptr));
Andreas Gampeace0dc12016-01-20 13:33:13 -08002569
2570 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2571 // compaction (done above) and ensure that neither foreground nor background collectors
2572 // are concurrent.
Roland Levillainb81e9e92017-04-20 17:35:32 +01002573 //
2574 // Likewise, this option is ignored with read barriers because Runtime::Init
2575 // overrides the background GC to be gc::kCollectorTypeCCBackground, but that's
2576 // fine too, for the same reason (see above).
Andreas Gampeace0dc12016-01-20 13:33:13 -08002577 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2578
2579 // To make identity hashcode deterministic, set a known seed.
2580 mirror::Object::SetHashCodeSeed(987654321U);
2581 }
2582
Vladimir Marko49b0f452015-12-10 13:49:19 +00002583 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2584 LOG(ERROR) << "Failed to parse runtime options";
2585 return false;
2586 }
2587 return true;
2588 }
2589
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002590 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002591 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2592 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002593 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002594 LOG(ERROR) << "Failed to create runtime";
2595 return false;
2596 }
Andreas Gampe49c144d2016-11-14 10:11:16 -08002597
2598 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2599 // "ps -a" don't change to non-descript "main."
2600 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2601
Vladimir Marko307dac92015-10-20 11:20:09 +01002602 runtime_.reset(Runtime::Current());
2603 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe8228cdf2017-05-30 15:03:54 -07002604 for (uint32_t i = 0; i < static_cast<uint32_t>(CalleeSaveType::kLastCalleeSaveType); ++i) {
2605 CalleeSaveType type = CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002606 if (!runtime_->HasCalleeSaveMethod(type)) {
2607 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002608 }
2609 }
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002610
2611 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2612 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002613 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002614
Vladimir Marko307dac92015-10-20 11:20:09 +01002615 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002616
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002617 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2618 // Runtime::Start, give it away now so that we don't starve GC.
2619 Thread* self = Thread::Current();
2620 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002621
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002622 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002623 }
2624
Jeff Haodcdc85b2015-12-04 14:06:18 -08002625 // 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 -08002626 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002627 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002628 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002629 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002630 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002631 image_filenames_.push_back(app_image_file_name_.c_str());
2632 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002633 if (!image_writer_->Write(app_image_fd_,
2634 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002635 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002636 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002637 return false;
2638 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002639
Jeff Haodcdc85b2015-12-04 14:06:18 -08002640 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002641 dchecked_vector<uintptr_t> oat_data_begins;
2642 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2643 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002644 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002645 // Destroy ImageWriter before doing FixupElf.
2646 image_writer_.reset();
2647
Vladimir Marko944da602016-02-19 12:27:55 +00002648 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2649 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002650 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2651 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2652 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2653 if (oat_file.get() == nullptr) {
2654 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2655 return false;
2656 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002657
Vladimir Marko944da602016-02-19 12:27:55 +00002658 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002659 oat_file->Erase();
2660 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2661 return false;
2662 }
2663
2664 if (oat_file->FlushCloseOrErase()) {
2665 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2666 return false;
2667 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002668 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002669 }
2670
2671 return true;
2672 }
2673
2674 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002675 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2676 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002677 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002678 return ReadCommentedInputFromFile<std::unordered_set<std::string>>(image_classes_filename,
2679 &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002680 }
2681
2682 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002683 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002684 const char* zip_filename,
2685 const char* image_classes_filename,
2686 std::string* error_msg) {
2687 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002688 return ReadCommentedInputFromZip<std::unordered_set<std::string>>(zip_filename,
2689 image_classes_filename,
2690 &process,
2691 error_msg);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002692 }
2693
2694 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2695 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002696 template <typename T>
2697 static T* ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002698 const char* input_filename, std::function<std::string(const char*)>* process) {
2699 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2700 if (input_file.get() == nullptr) {
2701 LOG(ERROR) << "Failed to open input file " << input_filename;
2702 return nullptr;
2703 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002704 std::unique_ptr<T> result(
2705 ReadCommentedInputStream<T>(*input_file, process));
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002706 input_file->close();
2707 return result.release();
2708 }
2709
2710 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2711 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002712 template <typename T>
2713 static T* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002714 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002715 const char* input_filename,
2716 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002717 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002718 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2719 if (zip_archive.get() == nullptr) {
2720 return nullptr;
2721 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002722 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002723 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002724 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002725 zip_filename, error_msg->c_str());
2726 return nullptr;
2727 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002728 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2729 input_filename,
2730 error_msg));
2731 if (input_file.get() == nullptr) {
2732 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002733 zip_filename, error_msg->c_str());
2734 return nullptr;
2735 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002736 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2737 input_file->Size());
2738 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002739 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002740 }
2741
2742 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2743 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002744 template <typename T>
2745 static T* ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002746 std::istream& in_stream,
2747 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002748 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002749 while (in_stream.good()) {
2750 std::string dot;
2751 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08002752 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002753 continue;
2754 }
2755 if (process != nullptr) {
2756 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002757 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002758 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002759 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002760 }
2761 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002762 return output.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002763 }
2764
Mathieu Chartier49285c52014-12-02 15:43:48 -08002765 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002766 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2767 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002768 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampec560fc02014-07-16 09:57:39 -07002769 LOG(INFO) << "dex2oat took "
2770 << PrettyDuration(NanoTime() - start_ns_)
Andreas Gampecc967752016-12-12 13:49:00 -08002771 << " (" << PrettyDuration(ProcessCpuNanoTime() - start_cputime_ns_) << " cpu)"
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002772 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002773 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002774 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2775 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002776 }
2777
Jeff Haodcdc85b2015-12-04 14:06:18 -08002778 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2779 std::string res(image_filename);
2780 size_t last_slash = res.rfind('/');
2781 if (last_slash == std::string::npos || last_slash == 0) {
2782 return res;
2783 }
2784 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2785 if (penultimate_slash == std::string::npos) {
2786 return res;
2787 }
2788 // Check that the string in-between is the expected one.
2789 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2790 GetInstructionSetString(isa)) {
2791 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2792 return res;
2793 }
2794 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2795 }
2796
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002797 std::unique_ptr<CompilerOptions> compiler_options_;
2798 Compiler::Kind compiler_kind_;
2799
2800 InstructionSet instruction_set_;
2801 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2802
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002803 uint32_t image_file_location_oat_checksum_;
2804 uintptr_t image_file_location_oat_data_begin_;
2805 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002806 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2807
Vladimir Marko307dac92015-10-20 11:20:09 +01002808 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002809
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002810 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2811
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002812 std::unique_ptr<Runtime> runtime_;
2813
Calin Juravle1ce70852017-06-28 10:59:03 -07002814 // The spec describing how the class loader should be setup for compilation.
2815 std::unique_ptr<ClassLoaderContext> class_loader_context_;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002816
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002817 size_t thread_count_;
2818 uint64_t start_ns_;
Andreas Gampec560fc02014-07-16 09:57:39 -07002819 uint64_t start_cputime_ns_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002820 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002821 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002822 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002823 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002824 std::vector<const char*> oat_filenames_;
2825 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002826 int oat_fd_;
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00002827 int input_vdex_fd_;
2828 int output_vdex_fd_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002829 std::string input_vdex_;
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01002830 std::string output_vdex_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002831 std::unique_ptr<VdexFile> input_vdex_file_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002832 std::vector<const char*> dex_filenames_;
2833 std::vector<const char*> dex_locations_;
2834 int zip_fd_;
2835 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002836 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002837 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002838 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002839 uintptr_t image_base_;
2840 const char* image_classes_zip_filename_;
2841 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002842 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002843 const char* compiled_classes_zip_filename_;
2844 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002845 const char* compiled_methods_zip_filename_;
2846 const char* compiled_methods_filename_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002847 const char* passes_to_run_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002848 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2849 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002850 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002851 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Jeff Hao436183f2016-01-12 16:36:50 -08002852 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002853 bool is_host_;
2854 std::string android_root_;
Mathieu Chartier0b490842016-05-25 15:05:59 -07002855 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002856 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002857 std::string no_inline_from_string_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002858
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002859 std::vector<std::unique_ptr<ElfWriter>> elf_writers_;
2860 std::vector<std::unique_ptr<OatWriter>> oat_writers_;
2861 std::vector<OutputStream*> rodata_;
David Brazdil5d5a36b2016-09-14 15:34:10 +01002862 std::vector<std::unique_ptr<OutputStream>> vdex_out_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002863 std::unique_ptr<ImageWriter> image_writer_;
2864 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002865
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002866 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
2867 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2868
Calin Juravle1ce70852017-06-28 10:59:03 -07002869 // Note that this might contain pointers owned by class_loader_context_.
Vladimir Marko47496c22016-01-27 16:15:08 +00002870 std::vector<const DexFile*> no_inline_from_dex_files_;
2871
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002872 bool dump_stats_;
2873 bool dump_passes_;
2874 bool dump_timing_;
2875 bool dump_slow_timing_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002876 std::string swap_file_name_;
2877 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002878 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2879 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002880 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002881 std::string app_image_file_name_;
2882 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002883 std::string profile_file_;
2884 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002885 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002886 TimingLogger* timings_;
2887 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002888 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002889 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002890
2891 // Backing storage.
2892 std::vector<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002893
Andreas Gampeace0dc12016-01-20 13:33:13 -08002894 // See CompilerOptions.force_determinism_.
2895 bool force_determinism_;
2896
Jeff Hao16d48432017-04-05 17:05:46 -07002897 // Directory of relative classpaths.
2898 std::string classpath_dir_;
2899
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00002900 // Whether the given input vdex is also the output.
2901 bool update_input_vdex_ = false;
2902
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002903 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2904};
2905
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002906static void b13564922() {
2907#if defined(__linux__) && defined(__arm__)
2908 int major, minor;
2909 struct utsname uts;
2910 if (uname(&uts) != -1 &&
2911 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2912 ((major < 3) || ((major == 3) && (minor < 4)))) {
2913 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2914 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2915 int old_personality = personality(0xffffffff);
2916 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2917 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2918 if (new_personality == -1) {
2919 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2920 }
2921 }
2922 }
2923#endif
2924}
2925
Mathieu Chartier72041a02017-07-14 18:23:25 -07002926class ScopedGlobalRef {
2927 public:
2928 explicit ScopedGlobalRef(jobject obj) : obj_(obj) {}
2929 ~ScopedGlobalRef() {
2930 if (obj_ != nullptr) {
2931 ScopedObjectAccess soa(Thread::Current());
2932 soa.Env()->vm->DeleteGlobalRef(soa.Self(), obj_);
2933 }
2934 }
2935
2936 private:
2937 jobject obj_;
2938};
2939
Andreas Gampe7b565912017-03-20 15:48:52 -07002940static dex2oat::ReturnCode CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002941 dex2oat.LoadClassProfileDescriptors();
Mathieu Chartier72041a02017-07-14 18:23:25 -07002942 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08002943
David Brazdil7b49e6c2016-09-01 11:06:18 +01002944 if (!dex2oat.WriteOutputFiles()) {
2945 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002946 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002947 }
2948
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002949 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2950 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2951 // image writer will require this fd to generate the image.
2952 if (dex2oat.ShouldKeepOatFileOpen()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002953 if (!dex2oat.FlushOutputFiles()) {
2954 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002955 return dex2oat::ReturnCode::kOther;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002956 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01002957 } else if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002958 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002959 }
2960
Jeff Haodcdc85b2015-12-04 14:06:18 -08002961 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002962 if (!dex2oat.HandleImage()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002963 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002964 }
2965
2966 // When given --host, finish early without stripping.
2967 if (dex2oat.IsHost()) {
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002968 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002969 return dex2oat::ReturnCode::kOther;
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002970 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002971 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002972 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002973 }
2974
Jeff Haodcdc85b2015-12-04 14:06:18 -08002975 // Copy stripped to unstripped location, if necessary.
2976 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002977 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002978 }
2979
Jeff Haodcdc85b2015-12-04 14:06:18 -08002980 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002981 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002982 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002983 }
2984
2985 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002986 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002987}
2988
Andreas Gampe7b565912017-03-20 15:48:52 -07002989static dex2oat::ReturnCode CompileApp(Dex2Oat& dex2oat) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07002990 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08002991
David Brazdil7b49e6c2016-09-01 11:06:18 +01002992 if (!dex2oat.WriteOutputFiles()) {
2993 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002994 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002995 }
2996
Jeff Haodcdc85b2015-12-04 14:06:18 -08002997 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002998 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002999
3000 // When given --host, finish early without stripping.
3001 if (dex2oat.IsHost()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003002 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003003 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003004 }
3005
3006 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003007 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003008 }
3009
Jeff Haodcdc85b2015-12-04 14:06:18 -08003010 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
3011 // stripped versions. If this is given, we expect to be able to open writable files by name.
3012 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003013 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003014 }
3015
Jeff Haodcdc85b2015-12-04 14:06:18 -08003016 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01003017 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003018 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003019 }
3020
3021 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003022 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003023}
3024
Andreas Gampe7b565912017-03-20 15:48:52 -07003025static dex2oat::ReturnCode Dex2oat(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003026 b13564922();
3027
3028 TimingLogger timings("compiler", false, false);
3029
Roland Levillain5c7e2602016-02-23 18:08:53 +00003030 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
3031 // might produce a stack frame too large for this function or for
3032 // functions inlining it (such as main), that would not fit the
3033 // requirements of the `-Wframe-larger-than` option.
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07003034 std::unique_ptr<Dex2Oat> dex2oat = std::make_unique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003035
3036 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003037 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003038
Calin Juravleb077e152016-02-18 18:47:37 +00003039 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02003040 // This operation involves I/O.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08003041 if (dex2oat->UseProfile()) {
Calin Juravleb077e152016-02-18 18:47:37 +00003042 if (!dex2oat->LoadProfile()) {
3043 LOG(ERROR) << "Failed to process profile file";
Andreas Gampe7b565912017-03-20 15:48:52 -07003044 return dex2oat::ReturnCode::kOther;
Calin Juravle998c2162015-12-21 15:39:33 +02003045 }
3046 }
3047
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00003048 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap, and vdex.
3049
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003050 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00003051 if (!dex2oat->OpenFile()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003052 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003053 }
3054
Andreas Gampe046c7062015-05-18 23:22:54 -07003055 // Print the complete line when any of the following is true:
3056 // 1) Debug build
3057 // 2) Compiling an image
3058 // 3) Compiling with --host
3059 // 4) Compiling on the host (not a target build)
3060 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003061 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07003062 LOG(INFO) << CommandLine();
3063 } else {
3064 LOG(INFO) << StrippedCommandLine();
3065 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003066
Andreas Gampef7882972017-03-20 16:35:24 -07003067 dex2oat::ReturnCode setup_code = dex2oat->Setup();
3068 if (setup_code != dex2oat::ReturnCode::kNoFailure) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003069 dex2oat->EraseOutputFiles();
Andreas Gampef7882972017-03-20 16:35:24 -07003070 return setup_code;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003071 }
3072
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07003073 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
3074 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07003075 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
3076
Andreas Gampe7b565912017-03-20 15:48:52 -07003077 dex2oat::ReturnCode result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00003078 if (dex2oat->IsImage()) {
3079 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08003080 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00003081 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003082 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003083
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003084 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003085}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003086} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07003087
3088int main(int argc, char** argv) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003089 int result = static_cast<int>(art::Dex2oat(argc, argv));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003090 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
3091 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
3092 // should not destruct the runtime in this case.
Evgenii Stepanov1e133742015-05-20 12:30:59 -07003093 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampee286b642017-04-13 12:20:42 -07003094 _exit(result);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003095 }
3096 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07003097}