blob: 83a86567a3f8bf346c80732c04ec8b4a4395be71 [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
Andreas Gampe097f34c2017-08-23 08:57:51 -070023#include <forward_list>
Brian Carlstrom7940e442013-07-12 13:46:57 -070024#include <fstream>
25#include <iostream>
Andreas Gampe67f02822016-06-24 21:05:23 -070026#include <limits>
Brian Carlstrom7940e442013-07-12 13:46:57 -070027#include <sstream>
28#include <string>
Andreas Gampe097f34c2017-08-23 08:57:51 -070029#include <type_traits>
Andreas Gampeb1fcead2015-04-20 18:53:51 -070030#include <unordered_set>
Brian Carlstrom7940e442013-07-12 13:46:57 -070031#include <vector>
32
Vladimir Markof94b7812014-06-05 15:48:04 +010033#if defined(__linux__) && defined(__arm__)
34#include <sys/personality.h>
35#include <sys/utsname.h>
36#endif
37
Andreas Gampe46ee31b2016-12-14 10:11:49 -080038#include "android-base/stringprintf.h"
Andreas Gampe9186ced2016-12-12 14:28:21 -080039#include "android-base/strings.h"
40
Ian Rogersd582fa42014-11-05 23:46:43 -080041#include "arch/instruction_set_features.h"
Andreas Gampec5a3ea72015-01-13 16:41:53 -080042#include "arch/mips/instruction_set_features_mips.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000043#include "art_method-inl.h"
Andreas Gampe8228cdf2017-05-30 15:03:54 -070044#include "base/callee_save_type.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070045#include "base/dumpable.h"
David Sehr891a50e2017-10-27 17:01:07 -070046#include "base/file_utils.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080047#include "base/macros.h"
Calin Juravle2e2db782016-02-23 12:00:03 +000048#include "base/scoped_flock.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070049#include "base/stl_util.h"
50#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010051#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070052#include "base/timing_logger.h"
53#include "base/unix_file/fd_file.h"
54#include "class_linker.h"
Calin Juravle1ce70852017-06-28 10:59:03 -070055#include "class_loader_context.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070056#include "cmdline_parser.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000057#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000058#include "compiler_callbacks.h"
David Srbecky09c2a6b2016-03-11 17:11:44 +000059#include "debug/elf_debug_writer.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000060#include "debug/method_debug_info.h"
Mathieu Chartier2c4b0842017-12-13 11:49:51 -080061#include "dexlayout.h"
David Sehr9e734c72018-01-04 17:56:19 -080062#include "dex/dex_file-inl.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000063#include "dex/quick_compiler_callbacks.h"
64#include "dex/verification_results.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070065#include "dex2oat_options.h"
Andreas Gampe7b565912017-03-20 15:48:52 -070066#include "dex2oat_return_codes.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070067#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080068#include "driver/compiler_options.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070069#include "driver/compiler_options_map-inl.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080070#include "elf_file.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070071#include "gc/space/image_space.h"
72#include "gc/space/space-inl.h"
Mathieu Chartier72041a02017-07-14 18:23:25 -070073#include "gc/verification.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070074#include "interpreter/unstarted_runtime.h"
Mathieu Chartier72041a02017-07-14 18:23:25 -070075#include "java_vm_ext.h"
Calin Juravle33083d62017-01-18 15:29:12 -080076#include "jit/profile_compilation_info.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070077#include "leb128.h"
David Brazdil5d5a36b2016-09-14 15:34:10 +010078#include "linker/buffered_output_stream.h"
Vladimir Marko74527972016-11-29 15:57:32 +000079#include "linker/elf_writer.h"
80#include "linker/elf_writer_quick.h"
David Brazdil5d5a36b2016-09-14 15:34:10 +010081#include "linker/file_output_stream.h"
Vladimir Marko74527972016-11-29 15:57:32 +000082#include "linker/image_writer.h"
Vladimir Marko944da602016-02-19 12:27:55 +000083#include "linker/multi_oat_relative_patcher.h"
Vladimir Marko74527972016-11-29 15:57:32 +000084#include "linker/oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070085#include "mirror/class-inl.h"
86#include "mirror/class_loader.h"
87#include "mirror/object-inl.h"
88#include "mirror/object_array-inl.h"
Andreas Gampe2ff3b972017-06-05 18:14:53 -070089#include "oat_file.h"
Jeff Haob11ffb72016-04-07 15:40:54 -070090#include "oat_file_assistant.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070091#include "os.h"
92#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000093#include "runtime_options.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070094#include "scoped_thread_state_change-inl.h"
Alex Light53cb16b2014-06-12 11:26:29 -070095#include "utils.h"
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +000096#include "vdex_file.h"
David Brazdilca3c8c32016-09-06 14:04:48 +010097#include "verifier/verifier_deps.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070098#include "well_known_classes.h"
99#include "zip_archive.h"
100
101namespace art {
102
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800103using android::base::StringAppendV;
104using android::base::StringPrintf;
105
Andreas Gampee1459ae2016-06-29 09:36:30 -0700106static constexpr size_t kDefaultMinDexFilesForSwap = 2;
107static constexpr size_t kDefaultMinDexFileCumulativeSizeForSwap = 20 * MB;
108
Mathieu Chartier010126f2017-07-15 15:44:18 -0700109// Compiler filter override for very large apps.
110static constexpr CompilerFilter::Filter kLargeAppFilter = CompilerFilter::kVerify;
111
Brian Carlstrom6449c622014-02-10 23:48:36 -0800112static int original_argc;
113static char** original_argv;
114
115static std::string CommandLine() {
116 std::vector<std::string> command;
117 for (int i = 0; i < original_argc; ++i) {
118 command.push_back(original_argv[i]);
119 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800120 return android::base::Join(command, ' ');
Brian Carlstrom6449c622014-02-10 23:48:36 -0800121}
122
Andreas Gampe046c7062015-05-18 23:22:54 -0700123// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
124// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
125// locations are all staged).
126static std::string StrippedCommandLine() {
127 std::vector<std::string> command;
128
Calin Juravle07c6d722017-06-07 17:06:12 +0000129 // Do a pre-pass to look for zip-fd and the compiler filter.
Andreas Gampe046c7062015-05-18 23:22:54 -0700130 bool saw_zip_fd = false;
Calin Juravle07c6d722017-06-07 17:06:12 +0000131 bool saw_compiler_filter = false;
Andreas Gampe046c7062015-05-18 23:22:54 -0700132 for (int i = 0; i < original_argc; ++i) {
Andreas Gampe9186ced2016-12-12 14:28:21 -0800133 if (android::base::StartsWith(original_argv[i], "--zip-fd=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700134 saw_zip_fd = true;
Andreas Gampe046c7062015-05-18 23:22:54 -0700135 }
Calin Juravle07c6d722017-06-07 17:06:12 +0000136 if (android::base::StartsWith(original_argv[i], "--compiler-filter=")) {
137 saw_compiler_filter = true;
Calin Juravle07c6d722017-06-07 17:06:12 +0000138 }
Andreas Gampe046c7062015-05-18 23:22:54 -0700139 }
140
141 // Now filter out things.
142 for (int i = 0; i < original_argc; ++i) {
143 // All runtime-arg parameters are dropped.
144 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
145 i++; // Drop the next part, too.
146 continue;
147 }
148
149 // Any instruction-setXXX is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800150 if (android::base::StartsWith(original_argv[i], "--instruction-set")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700151 continue;
152 }
153
154 // The boot image is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800155 if (android::base::StartsWith(original_argv[i], "--boot-image=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700156 continue;
157 }
158
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800159 // The image format is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800160 if (android::base::StartsWith(original_argv[i], "--image-format=")) {
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800161 continue;
162 }
163
Andreas Gampe046c7062015-05-18 23:22:54 -0700164 // This should leave any dex-file and oat-file options, describing what we compiled.
165
166 // However, we prefer to drop this when we saw --zip-fd.
167 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700168 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe9186ced2016-12-12 14:28:21 -0800169 if (android::base::StartsWith(original_argv[i], "--zip-") ||
170 android::base::StartsWith(original_argv[i], "--dex-") ||
171 android::base::StartsWith(original_argv[i], "--oat-") ||
172 android::base::StartsWith(original_argv[i], "--swap-") ||
173 android::base::StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700174 continue;
175 }
176 }
177
178 command.push_back(original_argv[i]);
179 }
180
Calin Juravle07c6d722017-06-07 17:06:12 +0000181 if (!saw_compiler_filter) {
182 command.push_back("--compiler-filter=" +
183 CompilerFilter::NameOfFilter(CompilerFilter::kDefaultCompilerFilter));
184 }
185
Andreas Gampe046c7062015-05-18 23:22:54 -0700186 // Construct the final output.
187 if (command.size() <= 1U) {
188 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
189 return "Starting dex2oat.";
190 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800191 return android::base::Join(command, ' ');
Andreas Gampe046c7062015-05-18 23:22:54 -0700192}
193
Brian Carlstrom7940e442013-07-12 13:46:57 -0700194static void UsageErrorV(const char* fmt, va_list ap) {
195 std::string error;
196 StringAppendV(&error, fmt, ap);
197 LOG(ERROR) << error;
198}
199
200static void UsageError(const char* fmt, ...) {
201 va_list ap;
202 va_start(ap, fmt);
203 UsageErrorV(fmt, ap);
204 va_end(ap);
205}
206
Andreas Gampe794ad762015-02-23 08:12:24 -0800207NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700208 va_list ap;
209 va_start(ap, fmt);
210 UsageErrorV(fmt, ap);
211 va_end(ap);
212
Brian Carlstrom6449c622014-02-10 23:48:36 -0800213 UsageError("Command: %s", CommandLine().c_str());
214
Brian Carlstrom7940e442013-07-12 13:46:57 -0700215 UsageError("Usage: dex2oat [options]...");
216 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100217 UsageError(" -j<number>: specifies the number of threads used for compilation.");
218 UsageError(" Default is the number of detected hardware threads available on the");
219 UsageError(" host system.");
220 UsageError(" Example: -j12");
221 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700222 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700223 UsageError(" Example: --dex-file=/system/framework/core.jar");
224 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700225 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
226 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
227 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
228 UsageError(" --dex-location=/system/framework/core.jar");
229 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700230 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
231 UsageError(" containing a classes.dex file to compile.");
232 UsageError(" Example: --zip-fd=5");
233 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700234 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
235 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700236 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
237 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800238 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700239 UsageError(" Example: --oat-file=/system/framework/boot.oat");
240 UsageError("");
241 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900242 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700243 UsageError("");
Shubham Ajmera66205322017-10-06 11:18:51 -0700244 UsageError(" --input-vdex-fd=<number>: specifies the vdex input source via a file descriptor.");
245 UsageError(" Example: --input-vdex-fd=6");
246 UsageError("");
247 UsageError(" --output-vdex-fd=<number>: specifies the vdex output destination via a file");
248 UsageError(" descriptor.");
249 UsageError(" Example: --output-vdex-fd=6");
250 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700251 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
252 UsageError(" to the file descriptor specified by --oat-fd.");
253 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
254 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800255 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700256 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
257 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800258 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700259 UsageError(" Example: --image=/system/framework/boot.art");
260 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800261 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800262 UsageError(" Which format to store the image.");
263 UsageError(" Example: --image-format=lz4");
264 UsageError(" Default: uncompressed");
265 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700266 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
267 UsageError(" Example: --image=frameworks/base/preloaded-classes");
268 UsageError("");
269 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
270 UsageError(" Example: --base=0x50000000");
271 UsageError("");
272 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000273 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700274 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000275 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000276 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700277 UsageError("");
278 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
279 UsageError(" Example: --android-root=out/host/linux-x86");
280 UsageError(" Default: $ANDROID_ROOT");
281 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800282 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700283 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700284 UsageError(" Example: --instruction-set=x86");
285 UsageError(" Default: arm");
286 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700287 UsageError(" --instruction-set-features=...,: Specify instruction set features");
288 UsageError(" Example: --instruction-set-features=div");
289 UsageError(" Default: default");
290 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700291 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
292 UsageError(" Default: disabled");
293 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800294 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700295 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800296 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100297 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700298 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100299 UsageError(" --compiler-filter="
Nicolas Geoffray49cda062017-04-21 13:08:25 +0100300 "(assume-verified"
301 "|extract"
302 "|verify"
303 "|quicken"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000304 "|space-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100305 "|space"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000306 "|speed-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100307 "|speed"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000308 "|everything-profile"
309 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700310 UsageError(" select compiler filter.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800311 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800312 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800313 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800314 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
315 UsageError(" method for compiler filter tuning.");
316 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
317 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
318 UsageError("");
319 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
320 UsageError(" method for compiler filter tuning.");
321 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
322 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
323 UsageError("");
324 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
325 UsageError(" method for compiler filter tuning.");
326 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
327 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
328 UsageError("");
329 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
330 UsageError(" method for compiler filter tuning.");
331 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
332 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
333 UsageError("");
334 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
335 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700336 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
337 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800338 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
339 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
340 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100341 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
342 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100343 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
344 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100345 UsageError(" Example: --inline-max-code-units=%d",
346 CompilerOptions::kDefaultInlineMaxCodeUnits);
347 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
348 UsageError("");
Nicolas Geoffraye82b60f2017-12-10 21:50:10 +0000349 UsageError(" --dump-timings: display a breakdown of where time was spent");
Ian Rogers46398602013-08-20 07:50:36 -0700350 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100351 UsageError(" -g");
352 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
353 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000354 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000355 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700356 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100357 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100358 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000359 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
360 UsageError(" debug information necessary to print backtraces. (disabled by default)");
361 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000362 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000363 UsageError("");
Alexey Alexandrovab40c112016-09-19 09:33:49 -0700364 UsageError(" --generate-build-id: Generate GNU-compatible linker build ID ELF section with");
365 UsageError(" SHA-1 of the file content (and thus stable across identical builds)");
366 UsageError("");
367 UsageError(" --no-generate-build-id: Do not generate the build ID ELF section.");
368 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000369 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000370 UsageError("");
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700371 UsageError(" --avoid-storing-invocation: Avoid storing the invocation args in the key value");
372 UsageError(" store. Used to test determinism with different args.");
373 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700374 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
375 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
376 UsageError(" Use a separate --runtime-arg switch for each argument.");
377 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700378 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000379 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700380 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000381 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
382 UsageError(" Cannot be used together with --profile-file.");
383 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100384 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800385 UsageError(" Example: --swap-file=/data/tmp/swap.001");
386 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100387 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800388 UsageError(" Example: --swap-fd=10");
389 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100390 UsageError(" --swap-dex-size-threshold=<size>: specifies the minimum total dex file size in");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700391 UsageError(" bytes to allow the use of swap.");
392 UsageError(" Example: --swap-dex-size-threshold=1000000");
393 UsageError(" Default: %zu", kDefaultMinDexFileCumulativeSizeForSwap);
394 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100395 UsageError(" --swap-dex-count-threshold=<count>: specifies the minimum number of dex files to");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700396 UsageError(" allow the use of swap.");
397 UsageError(" Example: --swap-dex-count-threshold=10");
398 UsageError(" Default: %zu", kDefaultMinDexFilesForSwap);
399 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100400 UsageError(" --very-large-app-threshold=<size>: specifies the minimum total dex file size in");
Mathieu Chartier010126f2017-07-15 15:44:18 -0700401 UsageError(" bytes to consider the input \"very large\" and reduce compilation done.");
Andreas Gampe67f02822016-06-24 21:05:23 -0700402 UsageError(" Example: --very-large-app-threshold=100000000");
403 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700404 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
405 UsageError(" Example: --app-image-fd=10");
406 UsageError("");
407 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
408 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
409 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800410 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
411 "input dex file.");
412 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000413 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000414 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100415 UsageError(" --dump-cfg=<cfg-file>: dump control-flow graphs (CFGs) to specified file.");
416 UsageError(" Example: --dump-cfg=output.cfg");
417 UsageError("");
418 UsageError(" --dump-cfg-append: when dumping CFGs to an existing file, append new CFG data to");
419 UsageError(" existing data (instead of overwriting existing data with new data, which is");
420 UsageError(" the default behavior). This option is only meaningful when used with");
421 UsageError(" --dump-cfg.");
422 UsageError("");
Jeff Hao16d48432017-04-05 17:05:46 -0700423 UsageError(" --classpath-dir=<directory-path>: directory used to resolve relative class paths.");
424 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700425 UsageError(" --class-loader-context=<string spec>: a string specifying the intended");
426 UsageError(" runtime loading context for the compiled dex files.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700427 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700428 UsageError(" It describes how the class loader chain should be built in order to ensure");
429 UsageError(" classes are resolved during dex2aot as they would be resolved at runtime.");
430 UsageError(" This spec will be encoded in the oat file. If at runtime the dex file is");
431 UsageError(" loaded in a different context, the oat file will be rejected.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700432 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700433 UsageError(" The chain is interpreted in the natural 'parent order', meaning that class");
434 UsageError(" loader 'i+1' will be the parent of class loader 'i'.");
Calin Juravlec79470d2017-07-12 17:37:42 -0700435 UsageError(" The compilation sources will be appended to the classpath of the first class");
436 UsageError(" loader.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700437 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700438 UsageError(" E.g. if the context is 'PCL[lib1.dex];DLC[lib2.dex]' and ");
439 UsageError(" --dex-file=src.dex then dex2oat will setup a PathClassLoader with classpath ");
440 UsageError(" 'lib1.dex:src.dex' and set its parent to a DelegateLastClassLoader with ");
441 UsageError(" classpath 'lib2.dex'.");
Calin Juravle1ce70852017-06-28 10:59:03 -0700442 UsageError(" ");
443 UsageError(" Note that the compiler will be tolerant if the source dex files specified");
444 UsageError(" with --dex-file are found in the classpath. The source dex files will be");
445 UsageError(" removed from any class loader's classpath possibly resulting in empty");
446 UsageError(" class loaders.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700447 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700448 UsageError(" Example: --class-loader-context=PCL[lib1.dex:lib2.dex];DLC[lib3.dex]");
Calin Juravle1ce70852017-06-28 10:59:03 -0700449 UsageError("");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700450 UsageError(" --dirty-image-objects=<directory-path>: list of known dirty objects in the image.");
451 UsageError(" The image writer will group them together.");
452 UsageError("");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700453 UsageError(" --compact-dex-level=none|fast: None avoids generating compact dex, fast");
Mathieu Chartier24066ec2017-10-21 16:01:08 -0700454 UsageError(" generates compact dex with low compile time.");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700455 UsageError("");
Andreas Gampee20ff6f2017-11-07 15:00:35 -0800456 UsageError(" --deduplicate-code=true|false: enable|disable code deduplication. Deduplicated");
457 UsageError(" code will have an arbitrary symbol tagged with [DEDUPED].");
Andreas Gampecac31ad2017-11-06 20:01:17 -0800458 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700459 std::cerr << "See log for usage error information\n";
460 exit(EXIT_FAILURE);
461}
462
Brian Carlstrom7940e442013-07-12 13:46:57 -0700463// The primary goal of the watchdog is to prevent stuck build servers
464// during development when fatal aborts lead to a cascade of failures
465// that result in a deadlock.
466class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800467// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700468#undef CHECK_PTHREAD_CALL
469#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
470 do { \
471 int rc = call args; \
472 if (rc != 0) { \
473 errno = rc; \
474 std::string message(# call); \
475 message += " failed for "; \
476 message += reason; \
477 Fatal(message); \
478 } \
479 } while (false)
480
481 public:
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800482 explicit WatchDog(int64_t timeout_in_milliseconds)
Andreas Gampe0f54b0d2017-12-27 08:37:02 -0800483 : timeout_in_milliseconds_(timeout_in_milliseconds),
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800484 shutting_down_(false) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700485 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700486 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800487#ifndef __APPLE__
488 pthread_condattr_t condattr;
liulvping8f7101e2017-01-16 15:14:43 +0800489 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_init, (&condattr), reason);
490 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_setclock, (&condattr, CLOCK_MONOTONIC), reason);
491 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, &condattr), reason);
492 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_destroy, (&condattr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800493#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700494 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
495 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
496 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
497 }
498 ~WatchDog() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700499 const char* reason = "dex2oat watch dog thread shutdown";
500 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
501 shutting_down_ = true;
502 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
503 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
504
Kenny Root51316382014-05-13 14:59:37 -0700505 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700506
507 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
508 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
509 }
510
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800511 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
512 // large.
513 static constexpr int64_t kWatchdogVerifyMultiplier =
514 kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
515
516 // When setting timeouts, keep in mind that the build server may not be as fast as your
517 // desktop. Debug builds are slower so they have larger timeouts.
518 static constexpr int64_t kWatchdogSlowdownFactor = kIsDebugBuild ? 5U : 1U;
519
520 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
521 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
522 // itself before that watchdog would take down the system server.
523 static constexpr int64_t kWatchDogTimeoutSeconds = kWatchdogSlowdownFactor * (9 * 60 + 30);
524
525 static constexpr int64_t kDefaultWatchdogTimeoutInMS =
526 kWatchdogVerifyMultiplier * kWatchDogTimeoutSeconds * 1000;
527
Brian Carlstrom7940e442013-07-12 13:46:57 -0700528 private:
529 static void* CallBack(void* arg) {
530 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
531 ::art::SetThreadName("dex2oat watch dog");
532 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700533 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700534 }
535
Andreas Gampe794ad762015-02-23 08:12:24 -0800536 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700537 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
538 // it's rather easy to hang in unwinding.
539 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
540 // logcat logging or stderr output.
Tomasz Wasilczyk8d840902017-12-20 08:19:53 -0800541 LogHelper::LogLineLowStack(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
542
Andreas Gampe48fde372017-06-06 07:43:46 -0700543 // If we're on the host, try to dump all threads to get a sense of what's going on. This is
544 // restricted to the host as the dump may itself go bad.
545 // TODO: Use a double watchdog timeout, so we can enable this on-device.
546 if (!kIsTargetBuild && Runtime::Current() != nullptr) {
Andreas Gampecd607312017-06-05 17:03:05 -0700547 Runtime::Current()->AttachCurrentThread("Watchdog thread attached for dumping",
548 true,
549 nullptr,
550 false);
551 Runtime::Current()->DumpForSigQuit(std::cerr);
552 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700553 exit(1);
554 }
555
556 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700557 timespec timeout_ts;
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800558#if defined(__APPLE__)
559 InitTimeSpec(true, CLOCK_REALTIME, timeout_in_milliseconds_, 0, &timeout_ts);
560#else
liulvping8f7101e2017-01-16 15:14:43 +0800561 InitTimeSpec(true, CLOCK_MONOTONIC, timeout_in_milliseconds_, 0, &timeout_ts);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800562#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700563 const char* reason = "dex2oat watch dog thread waiting";
564 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
565 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800566 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700567 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700568 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800569 timeout_in_milliseconds_/1000));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700570 } else if (rc != 0) {
571 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
572 strerror(errno)));
573 Fatal(message.c_str());
574 }
575 }
576 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
577 }
578
Brian Carlstrom7940e442013-07-12 13:46:57 -0700579 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
580 pthread_mutex_t mutex_;
581 pthread_cond_t cond_;
582 pthread_attr_t attr_;
583 pthread_t pthread_;
Andreas Gampef45d61c2017-06-07 10:29:33 -0700584
585 const int64_t timeout_in_milliseconds_;
586 bool shutting_down_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700587};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700588
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800589class Dex2Oat FINAL {
590 public:
591 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100592 compiler_kind_(Compiler::kOptimizing),
Vladimir Marko33bff252017-11-01 14:35:42 +0000593 instruction_set_(kRuntimeISA == InstructionSet::kArm ? InstructionSet::kThumb2 : kRuntimeISA),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800594 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000595 image_file_location_oat_checksum_(0),
596 image_file_location_oat_data_begin_(0),
597 image_patch_delta_(0),
598 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700599 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800600 runtime_(nullptr),
601 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
602 start_ns_(NanoTime()),
Andreas Gampec560fc02014-07-16 09:57:39 -0700603 start_cputime_ns_(ProcessCpuNanoTime()),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800604 oat_fd_(-1),
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000605 input_vdex_fd_(-1),
606 output_vdex_fd_(-1),
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000607 input_vdex_file_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800608 zip_fd_(-1),
609 image_base_(0U),
610 image_classes_zip_filename_(nullptr),
611 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800612 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800613 compiled_classes_zip_filename_(nullptr),
614 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700615 compiled_methods_zip_filename_(nullptr),
616 compiled_methods_filename_(nullptr),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700617 passes_to_run_filename_(nullptr),
Mathieu Chartierff0baff2017-08-02 23:04:19 -0700618 dirty_image_objects_filename_(nullptr),
Jeff Hao436183f2016-01-12 16:36:50 -0800619 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800620 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000621 elf_writers_(),
622 oat_writers_(),
623 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000624 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700625 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000626 opened_dex_files_maps_(),
627 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000628 no_inline_from_dex_files_(),
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700629 avoid_storing_invocation_(false),
Calin Juravle2e2db782016-02-23 12:00:03 +0000630 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800631 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000632 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800633 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000634 force_determinism_(false)
635 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800636
637 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800638 // Log completion time before deleting the runtime_, because this accesses
639 // the runtime.
640 LogCompletionTime();
641
Vladimir Marko307dac92015-10-20 11:20:09 +0100642 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
643 // We want to just exit on non-debug builds, not bringing the runtime down
644 // in an orderly fashion. So release the following fields.
645 driver_.release();
646 image_writer_.release();
647 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
648 dex_file.release();
649 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000650 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
651 map.release();
652 }
David Brazdil7b49e6c2016-09-01 11:06:18 +0100653 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
654 vdex_file.release();
655 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800656 for (std::unique_ptr<File>& oat_file : oat_files_) {
657 oat_file.release();
658 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100659 runtime_.release();
660 verification_results_.release();
661 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100662 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700663 }
664
Roland Levillain9ec5e222015-08-17 20:18:41 +0100665 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800666 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800667 std::string boot_image_filename;
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800668 int64_t watch_dog_timeout_in_ms = -1;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800669 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000670 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800671 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100672 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800673
Andreas Gampe097f34c2017-08-23 08:57:51 -0700674 void ParseBase(const std::string& option) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100675 char* end;
Andreas Gampe097f34c2017-08-23 08:57:51 -0700676 image_base_ = strtoul(option.c_str(), &end, 16);
677 if (end == option.c_str() || *end != '\0') {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100678 Usage("Failed to parse hexadecimal value for option %s", option.data());
679 }
680 }
681
Shubham Ajmera188b2bf2017-09-20 15:53:35 -0700682 bool VerifyProfileData() {
683 return profile_compilation_info_->VerifyProfileData(dex_files_);
684 }
685
Andreas Gampe097f34c2017-08-23 08:57:51 -0700686 void ParseInstructionSetVariant(const std::string& option, ParserOptions* parser_options) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800687 instruction_set_features_ = InstructionSetFeatures::FromVariant(
Andreas Gampe097f34c2017-08-23 08:57:51 -0700688 instruction_set_, option, &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100689 if (instruction_set_features_.get() == nullptr) {
690 Usage("%s", parser_options->error_msg.c_str());
691 }
692 }
693
Andreas Gampe097f34c2017-08-23 08:57:51 -0700694 void ParseInstructionSetFeatures(const std::string& option, ParserOptions* parser_options) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800695 if (instruction_set_features_ == nullptr) {
696 instruction_set_features_ = InstructionSetFeatures::FromVariant(
697 instruction_set_, "default", &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100698 if (instruction_set_features_.get() == nullptr) {
699 Usage("Problem initializing default instruction set features variant: %s",
700 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700701 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800702 }
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800703 instruction_set_features_ =
Andreas Gampe097f34c2017-08-23 08:57:51 -0700704 instruction_set_features_->AddFeaturesFromString(option, &parser_options->error_msg);
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800705 if (instruction_set_features_ == nullptr) {
Andreas Gampe097f34c2017-08-23 08:57:51 -0700706 Usage("Error parsing '%s': %s", option.c_str(), parser_options->error_msg.c_str());
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800707 }
708 }
709
Jeff Hao436183f2016-01-12 16:36:50 -0800710 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoaad75c62016-10-03 08:46:48 +0000711 compiler_options_->boot_image_ = !image_filenames_.empty();
712 compiler_options_->app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700713
Roland Levillain2b03a1f2017-06-06 16:09:59 +0100714 if (IsBootImage() && image_filenames_.size() == 1) {
715 const std::string& boot_image_filename = image_filenames_[0];
716 compiler_options_->core_image_ = CompilerDriver::IsCoreImageFilename(boot_image_filename);
717 }
718
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700719 if (IsAppImage() && IsBootImage()) {
720 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
721 }
722
Jeff Haodcdc85b2015-12-04 14:06:18 -0800723 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800724 Usage("Output must be supplied with either --oat-file or --oat-fd");
725 }
726
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000727 if (input_vdex_fd_ != -1 && !input_vdex_.empty()) {
728 Usage("Can't have both --input-vdex-fd and --input-vdex");
729 }
730
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +0100731 if (output_vdex_fd_ != -1 && !output_vdex_.empty()) {
732 Usage("Can't have both --output-vdex-fd and --output-vdex");
733 }
734
Jeff Haodcdc85b2015-12-04 14:06:18 -0800735 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800736 Usage("--oat-file should not be used with --oat-fd");
737 }
738
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000739 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +0100740 Usage("VDEX and OAT output must be specified either with one --oat-filename "
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000741 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100742 }
743
Roland Levillain9ec5e222015-08-17 20:18:41 +0100744 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800745 Usage("--oat-symbols should not be used with --oat-fd");
746 }
747
Roland Levillain9ec5e222015-08-17 20:18:41 +0100748 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800749 Usage("--oat-symbols should not be used with --host");
750 }
751
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000752 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
753 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100754 }
755
Jeff Haodcdc85b2015-12-04 14:06:18 -0800756 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800757 Usage("--oat-fd should not be used with --image");
758 }
759
Jeff Haodcdc85b2015-12-04 14:06:18 -0800760 if (!parser_options->oat_symbols.empty() &&
761 parser_options->oat_symbols.size() != oat_filenames_.size()) {
762 Usage("--oat-file arguments do not match --oat-symbols arguments");
763 }
764
765 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
766 Usage("--oat-file arguments do not match --image arguments");
767 }
768
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800769 if (android_root_.empty()) {
770 const char* android_root_env_var = getenv("ANDROID_ROOT");
771 if (android_root_env_var == nullptr) {
772 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700773 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800774 android_root_ += android_root_env_var;
775 }
776
Vladimir Markoaad75c62016-10-03 08:46:48 +0000777 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100778 parser_options->boot_image_filename += android_root_;
779 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800780 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100781 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000782 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800783 }
784
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700785 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800786 Usage("--image-classes should only be used with --image");
787 }
788
Vladimir Marko49b0f452015-12-10 13:49:19 +0000789 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800790 Usage("--image-classes should not be used with --boot-image");
791 }
792
793 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
794 Usage("--image-classes-zip should be used with --image-classes");
795 }
796
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700797 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800798 Usage("--compiled-classes should only be used with --image");
799 }
800
Vladimir Marko49b0f452015-12-10 13:49:19 +0000801 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800802 Usage("--compiled-classes should not be used with --boot-image");
803 }
804
805 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
806 Usage("--compiled-classes-zip should be used with --compiled-classes");
807 }
808
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800809 if (dex_filenames_.empty() && zip_fd_ == -1) {
810 Usage("Input must be supplied with either --dex-file or --zip-fd");
811 }
812
813 if (!dex_filenames_.empty() && zip_fd_ != -1) {
814 Usage("--dex-file should not be used with --zip-fd");
815 }
816
817 if (!dex_filenames_.empty() && !zip_location_.empty()) {
818 Usage("--dex-file should not be used with --zip-location");
819 }
820
821 if (dex_locations_.empty()) {
822 for (const char* dex_file_name : dex_filenames_) {
823 dex_locations_.push_back(dex_file_name);
824 }
825 } else if (dex_locations_.size() != dex_filenames_.size()) {
826 Usage("--dex-location arguments do not match --dex-file arguments");
827 }
828
Jeff Haodcdc85b2015-12-04 14:06:18 -0800829 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
830 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
831 Usage("--oat-file arguments must be singular or match --dex-file arguments");
832 }
833 }
834
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800835 if (zip_fd_ != -1 && zip_location_.empty()) {
836 Usage("--zip-location should be supplied with --zip-fd");
837 }
838
Vladimir Marko49b0f452015-12-10 13:49:19 +0000839 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800840 if (image_base_ == 0) {
841 Usage("Non-zero --base not specified");
842 }
843 }
844
Mathieu Chartiera8077802016-03-16 19:08:31 -0700845 const bool have_profile_file = !profile_file_.empty();
846 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
847 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000848 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200849 }
850
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -0700851 if (have_profile_file || have_profile_fd) {
852 if (compiled_classes_filename_ != nullptr ||
853 compiled_classes_zip_filename_ != nullptr ||
854 image_classes_filename_ != nullptr ||
855 image_classes_zip_filename_ != nullptr) {
856 Usage("Profile based image creation is not supported with image or compiled classes");
857 }
858 }
859
Roland Levillain9ec5e222015-08-17 20:18:41 +0100860 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800861 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800862 }
863
864 // If no instruction set feature was given, use the default one for the target
865 // instruction set.
866 if (instruction_set_features_.get() == nullptr) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800867 instruction_set_features_ = InstructionSetFeatures::FromVariant(
868 instruction_set_, "default", &parser_options->error_msg);
Ian Rogersd582fa42014-11-05 23:46:43 -0800869 if (instruction_set_features_.get() == nullptr) {
870 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100871 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800872 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800873 }
874
875 if (instruction_set_ == kRuntimeISA) {
876 std::unique_ptr<const InstructionSetFeatures> runtime_features(
877 InstructionSetFeatures::FromCppDefines());
878 if (!instruction_set_features_->Equals(runtime_features.get())) {
879 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
880 << *instruction_set_features_ << ") and those of dex2oat executable ("
881 << *runtime_features <<") for the command line:\n"
882 << CommandLine();
883 }
884 }
885
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000886 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +0000887 compiler_options_->inline_max_code_units_ = CompilerOptions::kDefaultInlineMaxCodeUnits;
Roland Levillaina215b952015-08-07 11:38:32 +0100888 }
889
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800890 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800891 // Set the compilation target's implicit checks options.
892 switch (instruction_set_) {
Vladimir Marko33bff252017-11-01 14:35:42 +0000893 case InstructionSet::kArm:
894 case InstructionSet::kThumb2:
895 case InstructionSet::kArm64:
896 case InstructionSet::kX86:
897 case InstructionSet::kX86_64:
898 case InstructionSet::kMips:
899 case InstructionSet::kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000900 compiler_options_->implicit_null_checks_ = true;
901 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800902 break;
903
904 default:
905 // Defaults are correct.
906 break;
907 }
908
Jeff Hao436183f2016-01-12 16:36:50 -0800909 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800910 Usage("--multi-image can only be used when creating boot images");
911 }
Jeff Hao436183f2016-01-12 16:36:50 -0800912 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800913 Usage("--multi-image cannot be used with multiple image names");
914 }
915
916 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
917 if (!kIsTargetBuild && IsBootImage()) {
918 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800919 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800920 }
921 }
922
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800923 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100924 if (parser_options->watch_dog_enabled) {
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800925 int64_t timeout = parser_options->watch_dog_timeout_in_ms > 0
926 ? parser_options->watch_dog_timeout_in_ms
927 : WatchDog::kDefaultWatchdogTimeoutInMS;
928 watchdog_.reset(new WatchDog(timeout));
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800929 }
930
931 // Fill some values into the key-value store for the oat header.
932 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800933
Roland Levillainb81e9e92017-04-20 17:35:32 +0100934 // Automatically force determinism for the boot image in a host build if read barriers
935 // are enabled, or if the default GC is CMS or MS. When the default GC is CMS
936 // (Concurrent Mark-Sweep), the GC is switched to a non-concurrent one by passing the
937 // option `-Xgc:nonconcurrent` (see below).
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800938 if (!kIsTargetBuild && IsBootImage()) {
939 if (SupportsDeterministicCompilation()) {
940 force_determinism_ = true;
941 } else {
942 LOG(WARNING) << "Deterministic compilation is disabled.";
943 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800944 }
945 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700946
947 if (passes_to_run_filename_ != nullptr) {
948 passes_to_run_.reset(ReadCommentedInputFromFile<std::vector<std::string>>(
949 passes_to_run_filename_,
950 nullptr)); // No post-processing.
951 if (passes_to_run_.get() == nullptr) {
952 Usage("Failed to read list of passes to run.");
953 }
954 }
955 compiler_options_->passes_to_run_ = passes_to_run_.get();
Roland Levillain9ec5e222015-08-17 20:18:41 +0100956 }
957
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800958 static bool SupportsDeterministicCompilation() {
Roland Levillainb81e9e92017-04-20 17:35:32 +0100959 return (kUseReadBarrier ||
960 gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
961 gc::kCollectorTypeDefault == gc::kCollectorTypeMS);
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800962 }
963
Jeff Hao436183f2016-01-12 16:36:50 -0800964 void ExpandOatAndImageFilenames() {
965 std::string base_oat = oat_filenames_[0];
966 size_t last_oat_slash = base_oat.rfind('/');
967 if (last_oat_slash == std::string::npos) {
968 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
969 }
970 // We also need to honor path components that were encoded through '@'. Otherwise the loading
971 // code won't be able to find the images.
972 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
973 last_oat_slash = base_oat.rfind('@');
974 }
975 base_oat = base_oat.substr(0, last_oat_slash + 1);
976
977 std::string base_img = image_filenames_[0];
978 size_t last_img_slash = base_img.rfind('/');
979 if (last_img_slash == std::string::npos) {
980 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
981 }
982 // We also need to honor path components that were encoded through '@'. Otherwise the loading
983 // code won't be able to find the images.
984 if (base_img.find('@', last_img_slash) != std::string::npos) {
985 last_img_slash = base_img.rfind('@');
986 }
987
988 // Get the prefix, which is the primary image name (without path components). Strip the
989 // extension.
990 std::string prefix = base_img.substr(last_img_slash + 1);
991 if (prefix.rfind('.') != std::string::npos) {
992 prefix = prefix.substr(0, prefix.rfind('.'));
993 }
994 if (!prefix.empty()) {
995 prefix = prefix + "-";
996 }
997
998 base_img = base_img.substr(0, last_img_slash + 1);
999
1000 // Note: we have some special case here for our testing. We have to inject the differentiating
1001 // parts for the different core images.
1002 std::string infix; // Empty infix by default.
1003 {
1004 // Check the first name.
1005 std::string dex_file = oat_filenames_[0];
1006 size_t last_dex_slash = dex_file.rfind('/');
1007 if (last_dex_slash != std::string::npos) {
1008 dex_file = dex_file.substr(last_dex_slash + 1);
1009 }
1010 size_t last_dex_dot = dex_file.rfind('.');
1011 if (last_dex_dot != std::string::npos) {
1012 dex_file = dex_file.substr(0, last_dex_dot);
1013 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001014 if (android::base::StartsWith(dex_file, "core-")) {
Jeff Hao436183f2016-01-12 16:36:50 -08001015 infix = dex_file.substr(strlen("core"));
1016 }
1017 }
1018
bowen_lai8bd36c02016-10-12 13:28:55 +08001019 std::string base_symbol_oat;
1020 if (!oat_unstripped_.empty()) {
1021 base_symbol_oat = oat_unstripped_[0];
1022 size_t last_symbol_oat_slash = base_symbol_oat.rfind('/');
1023 if (last_symbol_oat_slash == std::string::npos) {
1024 Usage("--multi-image used with unusable symbol filename %s", base_symbol_oat.c_str());
1025 }
1026 base_symbol_oat = base_symbol_oat.substr(0, last_symbol_oat_slash + 1);
1027 }
1028
Jeff Hao436183f2016-01-12 16:36:50 -08001029 // Now create the other names. Use a counted loop to skip the first one.
1030 for (size_t i = 1; i < dex_locations_.size(); ++i) {
1031 // TODO: Make everything properly std::string.
1032 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
Andreas Gampe097f34c2017-08-23 08:57:51 -07001033 char_backing_storage_.push_front(base_img + image_name);
1034 image_filenames_.push_back(char_backing_storage_.front().c_str());
Jeff Hao436183f2016-01-12 16:36:50 -08001035
1036 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
Andreas Gampe097f34c2017-08-23 08:57:51 -07001037 char_backing_storage_.push_front(base_oat + oat_name);
1038 oat_filenames_.push_back(char_backing_storage_.front().c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001039
1040 if (!base_symbol_oat.empty()) {
Andreas Gampe097f34c2017-08-23 08:57:51 -07001041 char_backing_storage_.push_front(base_symbol_oat + oat_name);
1042 oat_unstripped_.push_back(char_backing_storage_.front().c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001043 }
Jeff Hao436183f2016-01-12 16:36:50 -08001044 }
1045 }
1046
Andreas Gampe8994a042015-12-30 19:03:17 +00001047 // Modify the input string in the following way:
1048 // 0) Assume input is /a/b/c.d
1049 // 1) Strip the path -> c.d
1050 // 2) Inject prefix p -> pc.d
1051 // 3) Inject infix i -> pci.d
1052 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -08001053 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +00001054 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001055 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +00001056 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001057 size_t last_dex_slash = in.rfind('/');
1058 if (last_dex_slash != std::string::npos) {
1059 in = in.substr(last_dex_slash + 1);
1060 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001061 if (!prefix.empty()) {
1062 in = prefix + in;
1063 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001064 if (!infix.empty()) {
1065 // Inject infix.
1066 size_t last_dot = in.rfind('.');
1067 if (last_dot != std::string::npos) {
1068 in.insert(last_dot, infix);
1069 }
1070 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001071 if (android::base::EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001072 in = in.substr(0, in.length() - strlen(".jar")) +
1073 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001074 }
1075 return in;
1076 }
1077
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001078 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001079 std::ostringstream oss;
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001080 if (!avoid_storing_invocation_) {
1081 for (int i = 0; i < argc; ++i) {
1082 if (i > 0) {
1083 oss << ' ';
1084 }
1085 oss << argv[i];
Roland Levillain9ec5e222015-08-17 20:18:41 +01001086 }
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001087 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1088 oss.str(""); // Reset.
Roland Levillain9ec5e222015-08-17 20:18:41 +01001089 }
Roland Levillain9ec5e222015-08-17 20:18:41 +01001090 oss << kRuntimeISA;
1091 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1092 key_value_store_->Put(
1093 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001094 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001095 key_value_store_->Put(
1096 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001097 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001098 key_value_store_->Put(
1099 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001100 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001101 key_value_store_->Put(OatHeader::kCompilerFilter,
1102 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Andreas Gampef8cd8902017-01-18 16:05:01 -08001103 key_value_store_->Put(OatHeader::kConcurrentCopying,
1104 kUseReadBarrier ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001105 }
1106
Andreas Gampe097f34c2017-08-23 08:57:51 -07001107 // This simple forward is here so the string specializations below don't look out of place.
1108 template <typename T, typename U>
1109 void AssignIfExists(Dex2oatArgumentMap& map,
1110 const Dex2oatArgumentMap::Key<T>& key,
1111 U* out) {
1112 map.AssignIfExists(key, out);
1113 }
1114
1115 // Specializations to handle const char* vs std::string.
1116 void AssignIfExists(Dex2oatArgumentMap& map,
1117 const Dex2oatArgumentMap::Key<std::string>& key,
1118 const char** out) {
1119 if (map.Exists(key)) {
1120 char_backing_storage_.push_front(std::move(*map.Get(key)));
1121 *out = char_backing_storage_.front().c_str();
1122 }
1123 }
1124 void AssignIfExists(Dex2oatArgumentMap& map,
1125 const Dex2oatArgumentMap::Key<std::vector<std::string>>& key,
1126 std::vector<const char*>* out) {
1127 if (map.Exists(key)) {
1128 for (auto& val : *map.Get(key)) {
1129 char_backing_storage_.push_front(std::move(val));
1130 out->push_back(char_backing_storage_.front().c_str());
1131 }
1132 }
1133 }
1134
1135 template <typename T>
1136 void AssignTrueIfExists(Dex2oatArgumentMap& map,
1137 const Dex2oatArgumentMap::Key<T>& key,
1138 bool* out) {
1139 if (map.Exists(key)) {
1140 *out = true;
1141 }
1142 }
1143
Roland Levillain9ec5e222015-08-17 20:18:41 +01001144 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1145 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1146 // returns, arguments have been successfully parsed.
1147 void ParseArgs(int argc, char** argv) {
1148 original_argc = argc;
1149 original_argv = argv;
1150
Andreas Gampe51d80cc2017-06-21 21:05:13 -07001151 InitLogging(argv, Runtime::Abort);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001152
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001153 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001154
Andreas Gampe097f34c2017-08-23 08:57:51 -07001155 using M = Dex2oatArgumentMap;
1156 std::string error_msg;
1157 std::unique_ptr<M> args_uptr = M::Parse(argc, const_cast<const char**>(argv), &error_msg);
1158 if (args_uptr == nullptr) {
1159 Usage("Failed to parse command line: %s", error_msg.c_str());
1160 UNREACHABLE();
1161 }
1162
1163 M& args = *args_uptr;
1164
1165 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
1166
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07001167 AssignIfExists(args, M::CompactDexLevel, &compact_dex_level_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001168 AssignIfExists(args, M::DexFiles, &dex_filenames_);
1169 AssignIfExists(args, M::DexLocations, &dex_locations_);
1170 AssignIfExists(args, M::OatFiles, &oat_filenames_);
1171 AssignIfExists(args, M::OatSymbols, &parser_options->oat_symbols);
1172 AssignIfExists(args, M::ImageFilenames, &image_filenames_);
1173 AssignIfExists(args, M::ZipFd, &zip_fd_);
1174 AssignIfExists(args, M::ZipLocation, &zip_location_);
1175 AssignIfExists(args, M::InputVdexFd, &input_vdex_fd_);
1176 AssignIfExists(args, M::OutputVdexFd, &output_vdex_fd_);
1177 AssignIfExists(args, M::InputVdex, &input_vdex_);
1178 AssignIfExists(args, M::OutputVdex, &output_vdex_);
1179 AssignIfExists(args, M::OatFd, &oat_fd_);
1180 AssignIfExists(args, M::OatLocation, &oat_location_);
1181 AssignIfExists(args, M::Watchdog, &parser_options->watch_dog_enabled);
1182 AssignIfExists(args, M::WatchdogTimeout, &parser_options->watch_dog_timeout_in_ms);
1183 AssignIfExists(args, M::Threads, &thread_count_);
1184 AssignIfExists(args, M::ImageClasses, &image_classes_filename_);
1185 AssignIfExists(args, M::ImageClassesZip, &image_classes_zip_filename_);
1186 AssignIfExists(args, M::CompiledClasses, &compiled_classes_filename_);
1187 AssignIfExists(args, M::CompiledClassesZip, &compiled_classes_zip_filename_);
1188 AssignIfExists(args, M::CompiledMethods, &compiled_methods_filename_);
1189 AssignIfExists(args, M::CompiledMethodsZip, &compiled_methods_zip_filename_);
1190 AssignIfExists(args, M::Passes, &passes_to_run_filename_);
1191 AssignIfExists(args, M::BootImage, &parser_options->boot_image_filename);
1192 AssignIfExists(args, M::AndroidRoot, &android_root_);
1193 AssignIfExists(args, M::Profile, &profile_file_);
1194 AssignIfExists(args, M::ProfileFd, &profile_file_fd_);
1195 AssignIfExists(args, M::RuntimeOptions, &runtime_args_);
1196 AssignIfExists(args, M::SwapFile, &swap_file_name_);
1197 AssignIfExists(args, M::SwapFileFd, &swap_fd_);
1198 AssignIfExists(args, M::SwapDexSizeThreshold, &min_dex_file_cumulative_size_for_swap_);
1199 AssignIfExists(args, M::SwapDexCountThreshold, &min_dex_files_for_swap_);
1200 AssignIfExists(args, M::VeryLargeAppThreshold, &very_large_threshold_);
1201 AssignIfExists(args, M::AppImageFile, &app_image_file_name_);
1202 AssignIfExists(args, M::AppImageFileFd, &app_image_fd_);
1203 AssignIfExists(args, M::NoInlineFrom, &no_inline_from_string_);
1204 AssignIfExists(args, M::ClasspathDir, &classpath_dir_);
1205 AssignIfExists(args, M::DirtyImageObjects, &dirty_image_objects_filename_);
1206 AssignIfExists(args, M::ImageFormat, &image_storage_mode_);
1207
1208 AssignIfExists(args, M::Backend, &compiler_kind_);
1209 parser_options->requested_specific_compiler = args.Exists(M::Backend);
1210
1211 AssignIfExists(args, M::TargetInstructionSet, &instruction_set_);
1212 // arm actually means thumb2.
1213 if (instruction_set_ == InstructionSet::kArm) {
1214 instruction_set_ = InstructionSet::kThumb2;
1215 }
1216
1217 AssignTrueIfExists(args, M::Host, &is_host_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001218 AssignTrueIfExists(args, M::AvoidStoringInvocation, &avoid_storing_invocation_);
1219 AssignTrueIfExists(args, M::MultiImage, &multi_image_);
1220
1221 if (args.Exists(M::ForceDeterminism)) {
1222 if (!SupportsDeterministicCompilation()) {
1223 Usage("Option --force-determinism requires read barriers or a CMS/MS garbage collector");
Roland Levillain9ec5e222015-08-17 20:18:41 +01001224 }
Andreas Gampe097f34c2017-08-23 08:57:51 -07001225 force_determinism_ = true;
1226 }
1227
1228 if (args.Exists(M::Base)) {
1229 ParseBase(*args.Get(M::Base));
1230 }
1231 if (args.Exists(M::TargetInstructionSetVariant)) {
1232 ParseInstructionSetVariant(*args.Get(M::TargetInstructionSetVariant), parser_options.get());
1233 }
1234 if (args.Exists(M::TargetInstructionSetFeatures)) {
1235 ParseInstructionSetFeatures(*args.Get(M::TargetInstructionSetFeatures), parser_options.get());
1236 }
1237 if (args.Exists(M::ClassLoaderContext)) {
1238 class_loader_context_ = ClassLoaderContext::Create(*args.Get(M::ClassLoaderContext));
1239 if (class_loader_context_ == nullptr) {
1240 Usage("Option --class-loader-context has an incorrect format: %s",
1241 args.Get(M::ClassLoaderContext)->c_str());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001242 }
1243 }
1244
Andreas Gampe097f34c2017-08-23 08:57:51 -07001245 if (!ReadCompilerOptions(args, compiler_options_.get(), &error_msg)) {
1246 Usage(error_msg.c_str());
1247 }
1248
Jeff Hao436183f2016-01-12 16:36:50 -08001249 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001250
1251 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001252 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001253 }
1254
Jeff Haodcdc85b2015-12-04 14:06:18 -08001255 // Check whether the oat output files are writable, and open them for later. Also open a swap
1256 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001257 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001258 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1259 PruneNonExistentDexFiles();
1260
Jeff Hao436183f2016-01-12 16:36:50 -08001261 // Expand oat and image filenames for multi image.
1262 if (IsBootImage() && multi_image_) {
1263 ExpandOatAndImageFilenames();
1264 }
1265
David Brazdil7b49e6c2016-09-01 11:06:18 +01001266 // OAT and VDEX file handling
David Brazdil7b49e6c2016-09-01 11:06:18 +01001267 if (oat_fd_ == -1) {
1268 DCHECK(!oat_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08001269 for (const char* oat_filename : oat_filenames_) {
1270 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
Calin Juravleb09be722017-09-25 16:42:48 -07001271 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001272 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1273 return false;
1274 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001275 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001276 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1277 oat_file->Erase();
1278 return false;
1279 }
1280 oat_files_.push_back(std::move(oat_file));
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001281 DCHECK_EQ(input_vdex_fd_, -1);
1282 if (!input_vdex_.empty()) {
1283 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001284 input_vdex_file_ = VdexFile::Open(input_vdex_,
1285 /* writable */ false,
1286 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001287 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001288 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001289 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001290
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001291 DCHECK_EQ(output_vdex_fd_, -1);
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001292 std::string vdex_filename = output_vdex_.empty()
1293 ? ReplaceFileExtension(oat_filename, "vdex")
1294 : output_vdex_;
1295 if (vdex_filename == input_vdex_ && output_vdex_.empty()) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001296 update_input_vdex_ = true;
1297 std::unique_ptr<File> vdex_file(OS::OpenFileReadWrite(vdex_filename.c_str()));
1298 vdex_files_.push_back(std::move(vdex_file));
1299 } else {
1300 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
Calin Juravleb09be722017-09-25 16:42:48 -07001301 if (vdex_file == nullptr) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001302 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1303 return false;
1304 }
1305 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1306 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1307 vdex_file->Erase();
1308 return false;
1309 }
1310 vdex_files_.push_back(std::move(vdex_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001311 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001312 }
1313 } else {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001314 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, /* check_usage */ true));
Calin Juravleb09be722017-09-25 16:42:48 -07001315 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001316 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1317 return false;
1318 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001319 oat_file->DisableAutoClose();
1320 if (oat_file->SetLength(0) != 0) {
1321 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001322 oat_file->Erase();
1323 return false;
David Brazdil7b49e6c2016-09-01 11:06:18 +01001324 }
1325 oat_files_.push_back(std::move(oat_file));
1326
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001327 if (input_vdex_fd_ != -1) {
1328 struct stat s;
1329 int rc = TEMP_FAILURE_RETRY(fstat(input_vdex_fd_, &s));
1330 if (rc == -1) {
1331 PLOG(WARNING) << "Failed getting length of vdex file";
1332 } else {
1333 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001334 input_vdex_file_ = VdexFile::Open(input_vdex_fd_,
1335 s.st_size,
1336 "vdex",
1337 /* writable */ false,
1338 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001339 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001340 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001341 // If there's any problem with the passed vdex, just warn and proceed
1342 // without it.
1343 if (input_vdex_file_ == nullptr) {
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001344 PLOG(WARNING) << "Failed opening vdex file: " << error_msg;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001345 }
1346 }
1347 }
1348
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001349 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001350 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001351 std::unique_ptr<File> vdex_file(new File(output_vdex_fd_, vdex_location, /* check_usage */ true));
Calin Juravleb09be722017-09-25 16:42:48 -07001352 if (vdex_file == nullptr) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001353 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001354 return false;
1355 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001356 vdex_file->DisableAutoClose();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001357 if (input_vdex_file_ != nullptr && output_vdex_fd_ == input_vdex_fd_) {
1358 update_input_vdex_ = true;
1359 } else {
1360 if (vdex_file->SetLength(0) != 0) {
1361 PLOG(ERROR) << "Truncating vdex file " << vdex_location << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001362 vdex_file->Erase();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001363 return false;
1364 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001365 }
1366 vdex_files_.push_back(std::move(vdex_file));
1367
Jeff Haodcdc85b2015-12-04 14:06:18 -08001368 oat_filenames_.push_back(oat_location_.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001369 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001370
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001371 // If we're updating in place a vdex file, be defensive and put an invalid vdex magic in case
1372 // dex2oat gets killed.
1373 // Note: we're only invalidating the magic data in the file, as dex2oat needs the rest of
1374 // the information to remain valid.
1375 if (update_input_vdex_) {
Vladimir Marko74527972016-11-29 15:57:32 +00001376 std::unique_ptr<linker::BufferedOutputStream> vdex_out =
1377 std::make_unique<linker::BufferedOutputStream>(
1378 std::make_unique<linker::FileOutputStream>(vdex_files_.back().get()));
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001379 if (!vdex_out->WriteFully(&VdexFile::Header::kVdexInvalidMagic,
1380 arraysize(VdexFile::Header::kVdexInvalidMagic))) {
1381 PLOG(ERROR) << "Failed to invalidate vdex header. File: " << vdex_out->GetLocation();
1382 return false;
1383 }
1384
1385 if (!vdex_out->Flush()) {
1386 PLOG(ERROR) << "Failed to flush stream after invalidating header of vdex file."
1387 << " File: " << vdex_out->GetLocation();
1388 return false;
1389 }
1390 }
1391
David Brazdil7b49e6c2016-09-01 11:06:18 +01001392 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001393 //
1394 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1395 // that we can use for swap.
1396 //
1397 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1398 // will immediately unlink to satisfy the swap fd assumption.
1399 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1400 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1401 if (swap_file.get() == nullptr) {
1402 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1403 return false;
1404 }
1405 swap_fd_ = swap_file->Fd();
1406 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1407 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1408 // released immediately.
1409 unlink(swap_file_name_.c_str());
1410 }
Jeff Hao436183f2016-01-12 16:36:50 -08001411
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001412 return true;
1413 }
1414
David Brazdil7b49e6c2016-09-01 11:06:18 +01001415 void EraseOutputFiles() {
1416 for (auto& files : { &vdex_files_, &oat_files_ }) {
1417 for (size_t i = 0; i < files->size(); ++i) {
1418 if ((*files)[i].get() != nullptr) {
1419 (*files)[i]->Erase();
1420 (*files)[i].reset();
1421 }
1422 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001423 }
Andreas Gampea650e702014-12-03 14:28:02 -08001424 }
1425
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001426 void LoadClassProfileDescriptors() {
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -07001427 if (profile_compilation_info_ != nullptr && IsImage()) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001428 Runtime* runtime = Runtime::Current();
1429 CHECK(runtime != nullptr);
Mathieu Chartier0b490842016-05-25 15:05:59 -07001430 // Filter out class path classes since we don't want to include these in the image.
Mathieu Chartier4f342b02017-07-21 17:12:39 -07001431 image_classes_.reset(
1432 new std::unordered_set<std::string>(
1433 profile_compilation_info_->GetClassDescriptors(dex_files_)));
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001434 VLOG(compiler) << "Loaded " << image_classes_->size()
1435 << " image class descriptors from profile";
1436 if (VLOG_IS_ON(compiler)) {
1437 for (const std::string& s : *image_classes_) {
1438 LOG(INFO) << "Image class " << s;
1439 }
1440 }
1441 }
1442 }
1443
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001444 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1445 // boot class path.
Andreas Gampef7882972017-03-20 16:35:24 -07001446 dex2oat::ReturnCode Setup() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001447 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001448
Jeff Haoc23b0c02017-07-27 18:19:38 -07001449 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods() ||
1450 !PrepareDirtyObjects()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001451 return dex2oat::ReturnCode::kOther;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001452 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001453
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001454 // Verification results are null since we don't know if we will need them yet as the compler
1455 // filter may change.
Andreas Gampe4585f872015-03-27 23:45:15 -07001456 callbacks_.reset(new QuickCompilerCallbacks(
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001457 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001458 CompilerCallbacks::CallbackMode::kCompileBootImage :
1459 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001460
Vladimir Marko49b0f452015-12-10 13:49:19 +00001461 RuntimeArgumentMap runtime_options;
Mathieu Chartier46331a62017-07-21 09:49:10 -07001462 if (!PrepareRuntimeOptions(&runtime_options, callbacks_.get())) {
Andreas Gampef7882972017-03-20 16:35:24 -07001463 return dex2oat::ReturnCode::kOther;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001464 }
1465
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001466 CreateOatWriters();
1467 if (!AddDexFileSources()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001468 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001469 }
1470
1471 if (IsBootImage() && image_filenames_.size() > 1) {
1472 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1473 // We need this for the multi-image case.
Mathieu Chartier866d8742016-09-21 15:24:18 -07001474 key_value_store_->Put(OatHeader::kBootClassPathKey,
1475 gc::space::ImageSpace::GetMultiImageBootClassPath(dex_locations_,
1476 oat_filenames_,
1477 image_filenames_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001478 }
1479
1480 if (!IsBootImage()) {
1481 // When compiling an app, create the runtime early to retrieve
1482 // the image location key needed for the oat header.
1483 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001484 return dex2oat::ReturnCode::kCreateRuntime;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001485 }
1486
Andreas Gampe29d38e72016-03-23 15:31:51 +00001487 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001488 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1489 std::vector<gc::space::ImageSpace*> image_spaces =
1490 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Richard Uhlerbc26b722017-03-10 14:27:10 +00001491 image_file_location_oat_checksum_ = image_spaces[0]->GetImageHeader().GetOatChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001492 image_file_location_oat_data_begin_ =
1493 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1494 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1495 // Store the boot image filename(s).
1496 std::vector<std::string> image_filenames;
1497 for (const gc::space::ImageSpace* image_space : image_spaces) {
1498 image_filenames.push_back(image_space->GetImageFilename());
1499 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001500 std::string image_file_location = android::base::Join(image_filenames, ':');
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001501 if (!image_file_location.empty()) {
1502 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1503 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001504 } else {
1505 image_file_location_oat_checksum_ = 0u;
1506 image_file_location_oat_data_begin_ = 0u;
1507 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001508 }
1509
1510 // Open dex files for class path.
Calin Juravle19915892017-08-03 17:10:36 +00001511
Calin Juravle1ce70852017-06-28 10:59:03 -07001512 if (class_loader_context_ == nullptr) {
Calin Juravle19915892017-08-03 17:10:36 +00001513 // If no context was specified use the default one (which is an empty PathClassLoader).
1514 class_loader_context_ = std::unique_ptr<ClassLoaderContext>(ClassLoaderContext::Default());
Jeff Haof0192c82016-03-28 20:39:50 -07001515 }
Calin Juravle19915892017-08-03 17:10:36 +00001516
Calin Juravle1ce70852017-06-28 10:59:03 -07001517 DCHECK_EQ(oat_writers_.size(), 1u);
1518
1519 // Note: Ideally we would reject context where the source dex files are also
1520 // specified in the classpath (as it doesn't make sense). However this is currently
1521 // needed for non-prebuild tests and benchmarks which expects on the fly compilation.
1522 // Also, for secondary dex files we do not have control on the actual classpath.
1523 // Instead of aborting, remove all the source location from the context classpaths.
1524 if (class_loader_context_->RemoveLocationsFromClassPaths(
1525 oat_writers_[0]->GetSourceLocations())) {
1526 LOG(WARNING) << "The source files to be compiled are also in the classpath.";
1527 }
1528
1529 // We need to open the dex files before encoding the context in the oat file.
1530 // (because the encoding adds the dex checksum...)
1531 // TODO(calin): consider redesigning this so we don't have to open the dex files before
1532 // creating the actual class loader.
1533 if (!class_loader_context_->OpenDexFiles(runtime_->GetInstructionSet(), classpath_dir_)) {
1534 // Do not abort if we couldn't open files from the classpath. They might be
1535 // apks without dex files and right now are opening flow will fail them.
1536 LOG(WARNING) << "Failed to open classpath dex files";
1537 }
1538
1539 // Store the class loader context in the oat header.
1540 key_value_store_->Put(OatHeader::kClassPathKey,
1541 class_loader_context_->EncodeContextForOatFile(classpath_dir_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001542 }
1543
1544 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001545 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001546 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1547 rodata_.reserve(oat_writers_.size());
1548 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1549 rodata_.push_back(elf_writers_[i]->StartRoData());
1550 // Unzip or copy dex files straight to the oat file.
Andreas Gampee166e672017-12-19 18:59:29 +00001551 std::unique_ptr<MemMap> opened_dex_files_map;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001552 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001553 // No need to verify the dex file for:
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001554 // 1) Dexlayout since it does the verification. It also may not pass the verification since
1555 // we don't update the dex checksum.
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001556 // 2) when we have a vdex file, which means it was already verified.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001557 const bool verify = !DoDexLayoutOptimizations() && (input_vdex_file_ == nullptr);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001558 if (!oat_writers_[i]->WriteAndOpenDexFiles(
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +00001559 vdex_files_[i].get(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01001560 rodata_.back(),
1561 instruction_set_,
1562 instruction_set_features_.get(),
1563 key_value_store_.get(),
Jeff Hao042e8982016-10-19 11:17:11 -07001564 verify,
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001565 update_input_vdex_,
David Brazdil7b49e6c2016-09-01 11:06:18 +01001566 &opened_dex_files_map,
1567 &opened_dex_files)) {
Andreas Gampef7882972017-03-20 16:35:24 -07001568 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001569 }
1570 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
Andreas Gampee166e672017-12-19 18:59:29 +00001571 if (opened_dex_files_map != nullptr) {
1572 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001573 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001574 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001575 opened_dex_files_.push_back(std::move(dex_file));
1576 }
Andreas Gampee166e672017-12-19 18:59:29 +00001577 } else {
1578 DCHECK(opened_dex_files.empty());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001579 }
1580 }
1581 }
1582
1583 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
Andreas Gampe7386da42016-06-08 18:18:47 -07001584
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001585 // If we need to downgrade the compiler-filter for size reasons.
1586 if (!IsBootImage() && IsVeryLarge(dex_files_)) {
Mathieu Chartier8cce65a2017-08-17 00:06:39 -07001587 // Disable app image to make sure dex2oat unloading is enabled.
1588 compiler_options_->DisableAppImage();
1589
Mathieu Chartier72041a02017-07-14 18:23:25 -07001590 // If we need to downgrade the compiler-filter for size reasons, do that early before we read
1591 // it below for creating verification callbacks.
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001592 if (!CompilerFilter::IsAsGoodAs(kLargeAppFilter, compiler_options_->GetCompilerFilter())) {
1593 LOG(INFO) << "Very large app, downgrading to verify.";
1594 // Note: this change won't be reflected in the key-value store, as that had to be
1595 // finalized before loading the dex files. This setup is currently required
1596 // to get the size from the DexFile objects.
1597 // TODO: refactor. b/29790079
1598 compiler_options_->SetCompilerFilter(kLargeAppFilter);
1599 }
1600 }
1601
1602 if (CompilerFilter::IsAnyCompilationEnabled(compiler_options_->GetCompilerFilter())) {
1603 // Only modes with compilation require verification results, do this here instead of when we
1604 // create the compilation callbacks since the compilation mode may have been changed by the
1605 // very large app logic.
1606 // Avoiding setting the verification results saves RAM by not adding the dex files later in
1607 // the function.
1608 verification_results_.reset(new VerificationResults(compiler_options_.get()));
1609 callbacks_->SetVerificationResults(verification_results_.get());
1610 }
1611
Andreas Gampe7386da42016-06-08 18:18:47 -07001612 // We had to postpone the swap decision till now, as this is the point when we actually
1613 // know about the dex files we're going to use.
1614
1615 // Make sure that we didn't create the driver, yet.
1616 CHECK(driver_ == nullptr);
1617 // If we use a swap file, ensure we are above the threshold to make it necessary.
1618 if (swap_fd_ != -1) {
1619 if (!UseSwap(IsBootImage(), dex_files_)) {
1620 close(swap_fd_);
1621 swap_fd_ = -1;
1622 VLOG(compiler) << "Decided to run without swap.";
1623 } else {
1624 LOG(INFO) << "Large app, accepted running with swap.";
1625 }
1626 }
1627 // 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 +00001628 if (IsBootImage()) {
1629 // For boot image, pass opened dex files to the Runtime::Create().
1630 // Note: Runtime acquires ownership of these dex files.
1631 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001632 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001633 return dex2oat::ReturnCode::kOther;
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001634 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001635 }
1636
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001637 // If we're doing the image, override the compiler filter to force full compilation. Must be
1638 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1639 // compilation of class initializers.
1640 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001641 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001642 WellKnownClasses::Init(self->GetJniEnv());
1643
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001644 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001645 constexpr bool kSaveDexInput = false;
1646 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001647 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001648 }
1649 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001650
1651 // Ensure opened dex files are writable for dex-to-dex transformations.
1652 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1653 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1654 PLOG(ERROR) << "Failed to make .dex files writeable.";
Andreas Gampef7882972017-03-20 16:35:24 -07001655 return dex2oat::ReturnCode::kOther;
Vladimir Marko919f5532016-01-20 19:13:01 +00001656 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001657 }
1658
Mathieu Chartier72041a02017-07-14 18:23:25 -07001659 // Verification results are only required for modes that have any compilation. Avoid
1660 // adding the dex files if possible to prevent allocating large arrays.
1661 if (verification_results_ != nullptr) {
1662 for (const auto& dex_file : dex_files_) {
1663 // Pre-register dex files so that we can access verification results without locks during
1664 // compilation and verification.
Mathieu Chartier0733dc82017-07-17 14:05:28 -07001665 verification_results_->AddDexFile(dex_file);
1666 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001667 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001668
Andreas Gampef7882972017-03-20 16:35:24 -07001669 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001670 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001671
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001672 // If we need to keep the oat file open for the image writer.
1673 bool ShouldKeepOatFileOpen() const {
1674 return IsImage() && oat_fd_ != kInvalidFd;
1675 }
1676
Mathieu Chartier72041a02017-07-14 18:23:25 -07001677 // Doesn't return the class loader since it's not meant to be used for image compilation.
1678 void CompileDexFilesIndividually() {
1679 CHECK(!IsImage()) << "Not supported with image";
1680 for (const DexFile* dex_file : dex_files_) {
1681 std::vector<const DexFile*> dex_files(1u, dex_file);
1682 VLOG(compiler) << "Compiling " << dex_file->GetLocation();
1683 jobject class_loader = CompileDexFiles(dex_files);
1684 CHECK(class_loader != nullptr);
1685 ScopedObjectAccess soa(Thread::Current());
1686 // Unload class loader to free RAM.
Ian Rogers55256cb2017-12-21 17:07:11 -08001687 jweak weak_class_loader = soa.Env()->GetVm()->AddWeakGlobalRef(
Mathieu Chartier72041a02017-07-14 18:23:25 -07001688 soa.Self(),
1689 soa.Decode<mirror::ClassLoader>(class_loader));
Ian Rogers55256cb2017-12-21 17:07:11 -08001690 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), class_loader);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001691 runtime_->GetHeap()->CollectGarbage(/*clear_soft_references*/ true);
1692 ObjPtr<mirror::ClassLoader> decoded_weak = soa.Decode<mirror::ClassLoader>(weak_class_loader);
1693 if (decoded_weak != nullptr) {
1694 LOG(FATAL) << "Failed to unload class loader, path from root set: "
1695 << runtime_->GetHeap()->GetVerification()->FirstPathFromRootSet(decoded_weak);
1696 }
1697 VLOG(compiler) << "Unloaded classloader";
1698 }
1699 }
1700
1701 bool ShouldCompileDexFilesIndividually() const {
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001702 // Compile individually if we are:
1703 // 1. not building an image,
1704 // 2. not verifying a vdex file,
1705 // 3. using multidex,
1706 // 4. not doing any AOT compilation.
1707 // This means extract, no-vdex verify, and quicken, will use the individual compilation
1708 // mode (to reduce RAM used by the compiler).
Mathieu Chartier72041a02017-07-14 18:23:25 -07001709 return !IsImage() &&
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001710 !update_input_vdex_ &&
Mathieu Chartier72041a02017-07-14 18:23:25 -07001711 dex_files_.size() > 1 &&
Mathieu Chartier6a2b67b2017-08-08 15:09:29 -07001712 !CompilerFilter::IsAotCompilationEnabled(compiler_options_->GetCompilerFilter());
Mathieu Chartier72041a02017-07-14 18:23:25 -07001713 }
1714
1715 // Set up and create the compiler driver and then invoke it to compile all the dex files.
1716 jobject Compile() {
1717 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1718
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001719 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001720
Vladimir Marko47496c22016-01-27 16:15:08 +00001721 // Find the dex files we should not inline from.
Vladimir Marko47496c22016-01-27 16:15:08 +00001722 std::vector<std::string> no_inline_filters;
1723 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001724
1725 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001726 const std::string core_oj = "core-oj";
1727 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1728 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001729 }
1730
Vladimir Marko47496c22016-01-27 16:15:08 +00001731 if (!no_inline_filters.empty()) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001732 std::vector<const DexFile*> class_path_files;
1733 if (!IsBootImage()) {
1734 // The class loader context is used only for apps.
1735 class_path_files = class_loader_context_->FlattenOpenedDexFiles();
1736 }
1737
Jeff Haodcdc85b2015-12-04 14:06:18 -08001738 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1739 &class_linker->GetBootClassPath(),
1740 &class_path_files,
1741 &dex_files_
1742 };
1743 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001744 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001745 for (const std::string& filter : no_inline_filters) {
1746 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
Calin Juravlea308a322017-07-18 16:51:51 -07001747 // allows tests to specify <test-dexfile>!classes2.dex if needed but if the
Vladimir Marko47496c22016-01-27 16:15:08 +00001748 // base location passes the StartsWith() test, so do all extra locations.
1749 std::string dex_location = dex_file->GetLocation();
1750 if (filter.find('/') == std::string::npos) {
1751 // The filter does not contain the path. Remove the path from dex_location as well.
1752 size_t last_slash = dex_file->GetLocation().rfind('/');
1753 if (last_slash != std::string::npos) {
1754 dex_location = dex_location.substr(last_slash + 1);
1755 }
1756 }
1757
Andreas Gampe9186ced2016-12-12 14:28:21 -08001758 if (android::base::StartsWith(dex_location, filter.c_str())) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001759 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1760 no_inline_from_dex_files_.push_back(dex_file);
1761 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001762 }
1763 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001764 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001765 }
1766 if (!no_inline_from_dex_files_.empty()) {
1767 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001768 }
1769 }
1770
Vladimir Marko307dac92015-10-20 11:20:09 +01001771 driver_.reset(new CompilerDriver(compiler_options_.get(),
1772 verification_results_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001773 compiler_kind_,
1774 instruction_set_,
1775 instruction_set_features_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001776 image_classes_.release(),
1777 compiled_classes_.release(),
Wojciech Staszkiewicz62534792016-08-09 14:30:55 -07001778 compiled_methods_.release(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001779 thread_count_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001780 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001781 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001782 driver_->SetDexFilesForOatFile(dex_files_);
Nicolas Geoffray486dda02017-09-11 14:15:52 +01001783 if (!IsBootImage()) {
1784 driver_->SetClasspathDexFiles(class_loader_context_->FlattenOpenedDexFiles());
1785 }
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001786
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001787 const bool compile_individually = ShouldCompileDexFilesIndividually();
1788 if (compile_individually) {
1789 // Set the compiler driver in the callbacks so that we can avoid re-verification. This not
1790 // only helps performance but also prevents reverifying quickened bytecodes. Attempting
1791 // verify quickened bytecode causes verification failures.
1792 // Only set the compiler filter if we are doing separate compilation since there is a bit
1793 // of overhead when checking if a class was previously verified.
1794 callbacks_->SetDoesClassUnloading(true, driver_.get());
1795 }
1796
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001797 // Setup vdex for compilation.
1798 if (!DoEagerUnquickeningOfVdex() && input_vdex_file_ != nullptr) {
1799 callbacks_->SetVerifierDeps(
1800 new verifier::VerifierDeps(dex_files_, input_vdex_file_->GetVerifierDepsData()));
1801
1802 // TODO: we unquicken unconditionally, as we don't know
1803 // if the boot image has changed. How exactly we'll know is under
1804 // experimentation.
1805 TimingLogger::ScopedTiming time_unquicken("Unquicken", timings_);
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +03001806
1807 // We do not decompile a RETURN_VOID_NO_BARRIER into a RETURN_VOID, as the quickening
1808 // optimization does not depend on the boot image (the optimization relies on not
1809 // having final fields in a class, which does not change for an app).
Mathieu Chartier7a26f942018-01-04 18:23:55 -08001810 input_vdex_file_->Unquicken(dex_files_, /* decompile_return_instruction */ false);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001811 } else {
1812 // Create the main VerifierDeps, here instead of in the compiler since we want to aggregate
1813 // the results for all the dex files, not just the results for the current dex file.
1814 callbacks_->SetVerifierDeps(new verifier::VerifierDeps(dex_files_));
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001815 }
Mathieu Chartier72041a02017-07-14 18:23:25 -07001816 // Invoke the compilation.
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001817 if (compile_individually) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001818 CompileDexFilesIndividually();
1819 // Return a null classloader since we already freed released it.
1820 return nullptr;
1821 }
1822 return CompileDexFiles(dex_files_);
1823 }
1824
1825 // Create the class loader, use it to compile, and return.
1826 jobject CompileDexFiles(const std::vector<const DexFile*>& dex_files) {
1827 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1828
1829 jobject class_loader = nullptr;
1830 if (!IsBootImage()) {
1831 class_loader = class_loader_context_->CreateClassLoader(dex_files_);
1832 }
1833
1834 // Register dex caches and key them to the class loader so that they only unload when the
1835 // class loader unloads.
1836 for (const auto& dex_file : dex_files) {
1837 ScopedObjectAccess soa(Thread::Current());
1838 // Registering the dex cache adds a strong root in the class loader that prevents the dex
1839 // cache from being unloaded early.
1840 ObjPtr<mirror::DexCache> dex_cache = class_linker->RegisterDexFile(
1841 *dex_file,
1842 soa.Decode<mirror::ClassLoader>(class_loader));
1843 if (dex_cache == nullptr) {
1844 soa.Self()->AssertPendingException();
1845 LOG(FATAL) << "Failed to register dex file " << dex_file->GetLocation() << " "
1846 << soa.Self()->GetException()->Dump();
1847 }
1848 }
1849 driver_->CompileAll(class_loader, dex_files, timings_);
1850 return class_loader;
Vladimir Markof4da6752014-08-01 19:04:18 +01001851 }
1852
Jeff Hao436183f2016-01-12 16:36:50 -08001853 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001854 // ensure the references between the two are correct.
1855 //
1856 // Currently we have a memory layout that looks something like this:
1857 //
1858 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001859 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001860 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001861 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001862 // +--------------+
1863 // | alloc spaces |
1864 // +--------------+
1865 //
Jeff Hao436183f2016-01-12 16:36:50 -08001866 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001867 //
Jeff Hao436183f2016-01-12 16:36:50 -08001868 // 1. The images are expected to be loaded at an absolute address and
1869 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001870 //
Jeff Hao436183f2016-01-12 16:36:50 -08001871 // 2. There are absolute pointers from Methods in the images to their
1872 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001873 //
Jeff Hao436183f2016-01-12 16:36:50 -08001874 // 3. There are absolute pointers from the code in the oat files to Methods
1875 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001876 //
Jeff Hao436183f2016-01-12 16:36:50 -08001877 // 4. There are absolute pointers from code in the oat files to other code
1878 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001879 //
1880 // To get this all correct, we go through several steps.
1881 //
Jeff Hao436183f2016-01-12 16:36:50 -08001882 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001883 // the oat data size and code size. During this stage, we also set
1884 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001885 //
Jeff Hao436183f2016-01-12 16:36:50 -08001886 // 2. We prepare offsets for the objects in the images and calculate
1887 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001888 //
Jeff Hao436183f2016-01-12 16:36:50 -08001889 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001890 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001891 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001892 // can prepare the ELF headers and we then know the ELF memory segment
1893 // layout and we can now resolve all references. The compiler provides
1894 // LinkerPatch information in each CompiledMethod and we resolve these,
1895 // using the layout information and image object locations provided by
1896 // image writer, as we're writing the method code.
1897 //
Jeff Hao436183f2016-01-12 16:36:50 -08001898 // 4. We create the image files. They need to know where the oat files
1899 // will be loaded after itself. Originally oat files were simply
1900 // memory mapped so we could predict where their contents were based
1901 // on the file size. Now that they are ELF files, we need to inspect
1902 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001903 // where the oat header is located within.
1904 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001905 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001906 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001907 // load the .so at the desired location at runtime by offsetting the
1908 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001909 // TODO: Do this in step 3. We already know the layout there.
1910 //
1911 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1912 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001913
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001914 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1915 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001916 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1917 // case (when the file will be explicitly erased).
David Brazdil7b49e6c2016-09-01 11:06:18 +01001918 bool WriteOutputFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001919 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1920
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001921 // Sync the data to the file, in case we did dex2dex transformations.
1922 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1923 if (!map->Sync()) {
1924 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1925 return false;
1926 }
1927 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001928
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001929 if (IsImage()) {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001930 if (IsAppImage() && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001931 gc::Heap* const heap = Runtime::Current()->GetHeap();
1932 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001933 image_base_ = std::max(image_base_, RoundUp(
1934 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1935 kPageSize));
1936 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001937 // The non moving space is right after the oat file. Put the preferred app image location
1938 // right after the non moving space so that we ideally get a continuous immune region for
1939 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001940 // Use the default non moving space capacity since dex2oat does not have a separate non-
1941 // moving space. This means the runtime's non moving space space size will be as large
1942 // as the growth limit for dex2oat, but smaller in the zygote.
1943 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001944 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001945 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1946 }
1947
Vladimir Marko74527972016-11-29 15:57:32 +00001948 image_writer_.reset(new linker::ImageWriter(*driver_,
1949 image_base_,
1950 compiler_options_->GetCompilePic(),
1951 IsAppImage(),
1952 image_storage_mode_,
1953 oat_filenames_,
1954 dex_file_oat_index_map_,
1955 dirty_image_objects_.get()));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001956
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001957 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001958 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1959 if (!image_writer_->PrepareImageAddressSpace()) {
1960 LOG(ERROR) << "Failed to prepare image address space.";
1961 return false;
1962 }
1963 }
1964
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001965 // Initialize the writers with the compiler driver, image writer, and their
1966 // dex files. The writers were created without those being there yet.
1967 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00001968 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001969 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1970 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
1971 }
1972
David Brazdil5d5a36b2016-09-14 15:34:10 +01001973 {
1974 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
1975 DCHECK(IsBootImage() || oat_files_.size() == 1u);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001976 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
David Brazdil5d5a36b2016-09-14 15:34:10 +01001977 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1978 File* vdex_file = vdex_files_[i].get();
Vladimir Marko74527972016-11-29 15:57:32 +00001979 std::unique_ptr<linker::BufferedOutputStream> vdex_out =
1980 std::make_unique<linker::BufferedOutputStream>(
1981 std::make_unique<linker::FileOutputStream>(vdex_file));
David Brazdil5d5a36b2016-09-14 15:34:10 +01001982
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001983 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01001984 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
1985 return false;
1986 }
1987
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001988 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
1989 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
1990 return false;
1991 }
1992
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +00001993 // VDEX finalized, seek back to the beginning and write checksums and the header.
1994 if (!oat_writers_[i]->WriteChecksumsAndVdexHeader(vdex_out.get())) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01001995 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
1996 return false;
1997 }
1998 }
1999 }
2000
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002001 {
2002 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002003 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002004 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00002005 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2006 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko944da602016-02-19 12:27:55 +00002007
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002008 oat_writer->PrepareLayout(&patcher);
Vladimir Marko944da602016-02-19 12:27:55 +00002009
2010 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
David Brazdil7b49e6c2016-09-01 11:06:18 +01002011 size_t text_size = oat_writer->GetOatSize() - rodata_size;
Vladimir Markoaad75c62016-10-03 08:46:48 +00002012 elf_writer->PrepareDynamicSection(rodata_size,
2013 text_size,
2014 oat_writer->GetBssSize(),
Vladimir Marko0eb882b2017-05-15 13:39:18 +01002015 oat_writer->GetBssMethodsOffset(),
David Srbeckyec2cdf42017-12-08 16:21:25 +00002016 oat_writer->GetBssRootsOffset(),
2017 oat_writer->GetVdexSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002018 if (IsImage()) {
2019 // Update oat layout.
2020 DCHECK(image_writer_ != nullptr);
2021 DCHECK_LT(i, oat_filenames_.size());
2022 image_writer_->UpdateOatFileLayout(i,
2023 elf_writer->GetLoadedSize(),
2024 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01002025 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002026 }
Richard Uhlerbc26b722017-03-10 14:27:10 +00002027
2028 if (IsBootImage()) {
2029 // Have the image_file_location_oat_checksum_ for boot oat files
2030 // depend on the contents of all the boot oat files. This way only
2031 // the primary image checksum needs to be checked to determine
2032 // whether any of the images are out of date.
2033 image_file_location_oat_checksum_ ^= oat_writer->GetOatHeader().GetChecksum();
2034 }
Vladimir Marko944da602016-02-19 12:27:55 +00002035 }
2036
2037 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002038 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko74527972016-11-29 15:57:32 +00002039 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2040 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00002041
David Srbecky0c4572e2016-01-22 19:19:25 +00002042 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00002043 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
2044 elf_writer->PrepareDebugInfo(oat_writer->GetMethodDebugInfo());
David Srbecky0c4572e2016-01-22 19:19:25 +00002045
Vladimir Marko74527972016-11-29 15:57:32 +00002046 linker::OutputStream*& rodata = rodata_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002047 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002048 if (!oat_writer->WriteRodata(rodata)) {
2049 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
2050 return false;
2051 }
2052 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002053 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00002054
Vladimir Marko74527972016-11-29 15:57:32 +00002055 linker::OutputStream* text = elf_writer->StartText();
Jeff Haodcdc85b2015-12-04 14:06:18 -08002056 if (!oat_writer->WriteCode(text)) {
2057 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
2058 return false;
2059 }
2060 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00002061
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002062 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
2063 image_file_location_oat_checksum_,
2064 image_file_location_oat_data_begin_,
2065 image_patch_delta_)) {
2066 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
2067 return false;
2068 }
2069
Vladimir Marko944da602016-02-19 12:27:55 +00002070 if (IsImage()) {
2071 // Update oat header information.
2072 DCHECK(image_writer_ != nullptr);
2073 DCHECK_LT(i, oat_filenames_.size());
2074 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
2075 }
2076
Jeff Haodcdc85b2015-12-04 14:06:18 -08002077 elf_writer->WriteDynamicSection();
2078 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
Vladimir Marko10c13562015-11-25 14:33:36 +00002079
Jeff Haodcdc85b2015-12-04 14:06:18 -08002080 if (!elf_writer->End()) {
2081 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
2082 return false;
2083 }
2084
David Brazdil7b49e6c2016-09-01 11:06:18 +01002085 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
2086 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002087 }
2088
Jeff Haodcdc85b2015-12-04 14:06:18 -08002089 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002090
2091 oat_writer.reset();
2092 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002093 }
2094 }
2095
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002096 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002097 }
2098
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002099 // If we are compiling an image, invoke the image creation routine. Else just skip.
2100 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002101 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002102 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
2103 if (!CreateImageFile()) {
2104 return false;
2105 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002106 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07002107 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002108 return true;
2109 }
2110
Jeff Haodcdc85b2015-12-04 14:06:18 -08002111 // Create a copy from stripped to unstripped.
2112 bool CopyStrippedToUnstripped() {
2113 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
2114 // If we don't want to strip in place, copy from stripped location to unstripped location.
2115 // We need to strip after image creation because FixupElf needs to use .strtab.
2116 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
2117 // If the oat file is still open, flush it.
2118 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002119 if (!FlushCloseOutputFile(&oat_files_[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002120 return false;
2121 }
2122 }
2123
2124 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
2125 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
2126 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01002127 int64_t in_length = in->GetLength();
2128 if (in_length < 0) {
2129 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
2130 return false;
2131 }
2132 if (!out->Copy(in.get(), 0, in_length)) {
2133 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
2134 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002135 }
2136 if (out->FlushCloseOrErase() != 0) {
2137 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
2138 return false;
2139 }
2140 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
2141 }
2142 }
2143 return true;
2144 }
2145
David Brazdil7b49e6c2016-09-01 11:06:18 +01002146 bool FlushOutputFile(std::unique_ptr<File>* file) {
2147 if (file->get() != nullptr) {
2148 if (file->get()->Flush() != 0) {
2149 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
2150 return false;
2151 }
2152 }
2153 return true;
2154 }
2155
2156 bool FlushCloseOutputFile(std::unique_ptr<File>* file) {
2157 if (file->get() != nullptr) {
2158 std::unique_ptr<File> tmp(file->release());
2159 if (tmp->FlushCloseOrErase() != 0) {
2160 PLOG(ERROR) << "Failed to flush and close output file: " << tmp->GetPath();
2161 return false;
2162 }
2163 }
2164 return true;
2165 }
2166
2167 bool FlushOutputFiles() {
2168 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
2169 for (auto& files : { &vdex_files_, &oat_files_ }) {
2170 for (size_t i = 0; i < files->size(); ++i) {
2171 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002172 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08002173 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002174 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00002175 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002176 return true;
2177 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002178
David Brazdil7b49e6c2016-09-01 11:06:18 +01002179 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002180 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002181 for (auto& files : { &vdex_files_, &oat_files_ }) {
2182 for (size_t i = 0; i < files->size(); ++i) {
2183 result &= FlushCloseOutputFile(&(*files)[i]);
2184 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002185 }
2186 return result;
2187 }
2188
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002189 void DumpTiming() {
Nicolas Geoffray2d8801f2017-11-28 15:50:07 +00002190 if (compiler_options_->GetDumpTimings() ||
2191 (kIsDebugBuild && timings_->GetTotalNs() > MsToNs(1000))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002192 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2193 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002194 }
2195
Andreas Gampe10e477d2014-11-19 12:57:42 -08002196 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002197 return IsAppImage() || IsBootImage();
2198 }
2199
2200 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002201 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002202 }
2203
2204 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002205 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002206 }
2207
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002208 bool IsHost() const {
2209 return is_host_;
2210 }
2211
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002212 bool UseProfile() const {
Mathieu Chartierd0af56c2017-02-17 12:56:25 -08002213 return profile_file_fd_ != -1 || !profile_file_.empty();
Calin Juravle998c2162015-12-21 15:39:33 +02002214 }
2215
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002216 bool DoProfileGuidedOptimizations() const {
Nicolas Geoffray49cda062017-04-21 13:08:25 +01002217 return UseProfile();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002218 }
2219
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002220 bool DoGenerateCompactDex() const {
2221 return compact_dex_level_ != CompactDexLevel::kCompactDexLevelNone;
2222 }
2223
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002224 bool DoDexLayoutOptimizations() const {
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002225 return DoProfileGuidedOptimizations() || DoGenerateCompactDex();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002226 }
2227
Igor Murashkin545412b2017-08-17 15:26:54 -07002228 bool DoOatLayoutOptimizations() const {
2229 return DoProfileGuidedOptimizations();
2230 }
2231
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002232 bool MayInvalidateVdexMetadata() const {
2233 // DexLayout can invalidate the vdex metadata if changing the class def order is enabled, so
2234 // we need to unquicken the vdex file eagerly, before passing it to dexlayout.
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01002235 return DoDexLayoutOptimizations();
2236 }
2237
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002238 bool DoEagerUnquickeningOfVdex() const {
2239 return MayInvalidateVdexMetadata();
2240 }
2241
Calin Juravle2e2db782016-02-23 12:00:03 +00002242 bool LoadProfile() {
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002243 DCHECK(UseProfile());
Calin Juravlee6f87cc2017-05-24 17:41:05 -07002244 // TODO(calin): We should be using the runtime arena pool (instead of the
2245 // default profile arena). However the setup logic is messy and needs
2246 // cleaning up before that (e.g. the oat writers are created before the
2247 // runtime).
Calin Juravle2e2db782016-02-23 12:00:03 +00002248 profile_compilation_info_.reset(new ProfileCompilationInfo());
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002249 ScopedFlock profile_file;
Calin Juravle2e2db782016-02-23 12:00:03 +00002250 std::string error;
2251 if (profile_file_fd_ != -1) {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002252 profile_file = LockedFile::DupOf(profile_file_fd_, "profile",
2253 true /* read_only_mode */, &error);
Andreas Gampe29d38e72016-03-23 15:31:51 +00002254 } else if (profile_file_ != "") {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002255 profile_file = LockedFile::Open(profile_file_.c_str(), O_RDONLY, true, &error);
Calin Juravle998c2162015-12-21 15:39:33 +02002256 }
Calin Juravle877fd962016-01-05 14:29:29 +00002257
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002258 // Return early if we're unable to obtain a lock on the profile.
2259 if (profile_file.get() == nullptr) {
2260 LOG(ERROR) << "Cannot lock profiles: " << error;
2261 return false;
2262 }
2263
2264 if (!profile_compilation_info_->Load(profile_file->Fd())) {
Calin Juravle2e2db782016-02-23 12:00:03 +00002265 profile_compilation_info_.reset(nullptr);
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002266 return false;
Calin Juravle2e2db782016-02-23 12:00:03 +00002267 }
Calin Juravle877fd962016-01-05 14:29:29 +00002268
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002269 return true;
Calin Juravle998c2162015-12-21 15:39:33 +02002270 }
2271
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002272 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002273 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2274 if (is_image) {
2275 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2276 return false;
2277 }
2278 if (dex_files.size() < min_dex_files_for_swap_) {
2279 // If there are less dex files than the threshold, assume it's gonna be fine.
2280 return false;
2281 }
2282 size_t dex_files_size = 0;
2283 for (const auto* dex_file : dex_files) {
2284 dex_files_size += dex_file->GetHeader().file_size_;
2285 }
2286 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2287 }
2288
Andreas Gampe67f02822016-06-24 21:05:23 -07002289 bool IsVeryLarge(std::vector<const DexFile*>& dex_files) {
2290 size_t dex_files_size = 0;
2291 for (const auto* dex_file : dex_files) {
2292 dex_files_size += dex_file->GetHeader().file_size_;
2293 }
2294 return dex_files_size >= very_large_threshold_;
2295 }
2296
Vladimir Marko49b0f452015-12-10 13:49:19 +00002297 bool PrepareImageClasses() {
2298 // If --image-classes was specified, calculate the full list of classes to include in the image.
2299 if (image_classes_filename_ != nullptr) {
2300 image_classes_ =
2301 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2302 if (image_classes_ == nullptr) {
2303 return false;
2304 }
2305 } else if (IsBootImage()) {
2306 image_classes_.reset(new std::unordered_set<std::string>);
2307 }
2308 return true;
2309 }
2310
2311 bool PrepareCompiledClasses() {
2312 // If --compiled-classes was specified, calculate the full list of classes to compile in the
2313 // image.
2314 if (compiled_classes_filename_ != nullptr) {
2315 compiled_classes_ =
2316 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
2317 if (compiled_classes_ == nullptr) {
2318 return false;
2319 }
2320 } else {
2321 compiled_classes_.reset(nullptr); // By default compile everything.
2322 }
2323 return true;
2324 }
2325
2326 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2327 const char* classes_filename,
2328 const char* tag) {
2329 std::unique_ptr<std::unordered_set<std::string>> classes;
2330 std::string error_msg;
2331 if (zip_filename != nullptr) {
2332 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2333 } else {
2334 classes.reset(ReadImageClassesFromFile(classes_filename));
2335 }
2336 if (classes == nullptr) {
2337 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2338 << classes_filename << "': " << error_msg;
2339 }
2340 return classes;
2341 }
2342
2343 bool PrepareCompiledMethods() {
2344 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2345 if (compiled_methods_filename_ != nullptr) {
2346 std::string error_msg;
2347 if (compiled_methods_zip_filename_ != nullptr) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002348 compiled_methods_.reset(ReadCommentedInputFromZip<std::unordered_set<std::string>>(
2349 compiled_methods_zip_filename_,
2350 compiled_methods_filename_,
2351 nullptr, // No post-processing.
2352 &error_msg));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002353 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002354 compiled_methods_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2355 compiled_methods_filename_,
2356 nullptr)); // No post-processing.
Vladimir Marko49b0f452015-12-10 13:49:19 +00002357 }
2358 if (compiled_methods_.get() == nullptr) {
2359 LOG(ERROR) << "Failed to create list of compiled methods from '"
2360 << compiled_methods_filename_ << "': " << error_msg;
2361 return false;
2362 }
2363 } else {
2364 compiled_methods_.reset(nullptr); // By default compile everything.
2365 }
2366 return true;
2367 }
2368
Jeff Haoc23b0c02017-07-27 18:19:38 -07002369 bool PrepareDirtyObjects() {
2370 if (dirty_image_objects_filename_ != nullptr) {
2371 dirty_image_objects_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2372 dirty_image_objects_filename_,
2373 nullptr));
2374 if (dirty_image_objects_ == nullptr) {
2375 LOG(ERROR) << "Failed to create list of dirty objects from '"
2376 << dirty_image_objects_filename_ << "'";
2377 return false;
2378 }
2379 } else {
2380 dirty_image_objects_.reset(nullptr);
2381 }
2382 return true;
2383 }
2384
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002385 void PruneNonExistentDexFiles() {
2386 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2387 size_t kept = 0u;
2388 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2389 if (!OS::FileExists(dex_filenames_[i])) {
2390 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2391 } else {
2392 dex_filenames_[kept] = dex_filenames_[i];
2393 dex_locations_[kept] = dex_locations_[i];
2394 ++kept;
2395 }
2396 }
2397 dex_filenames_.resize(kept);
2398 dex_locations_.resize(kept);
2399 }
2400
2401 bool AddDexFileSources() {
2402 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002403 if (input_vdex_file_ != nullptr) {
2404 DCHECK_EQ(oat_writers_.size(), 1u);
2405 const std::string& name = zip_location_.empty() ? dex_locations_[0] : zip_location_;
2406 DCHECK(!name.empty());
2407 if (!oat_writers_[0]->AddVdexDexFilesSource(*input_vdex_file_.get(), name.c_str())) {
2408 return false;
2409 }
2410 } else if (zip_fd_ != -1) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002411 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002412 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2413 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002414 return false;
2415 }
2416 } else if (oat_writers_.size() > 1u) {
2417 // Multi-image.
2418 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2419 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2420 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2421 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2422 return false;
2423 }
2424 }
2425 } else {
2426 DCHECK_EQ(oat_writers_.size(), 1u);
2427 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2428 DCHECK_NE(dex_filenames_.size(), 0u);
2429 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2430 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2431 return false;
2432 }
2433 }
2434 }
2435 return true;
2436 }
2437
2438 void CreateOatWriters() {
2439 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2440 elf_writers_.reserve(oat_files_.size());
2441 oat_writers_.reserve(oat_files_.size());
2442 for (const std::unique_ptr<File>& oat_file : oat_files_) {
Vladimir Marko74527972016-11-29 15:57:32 +00002443 elf_writers_.emplace_back(linker::CreateElfWriterQuick(instruction_set_,
2444 instruction_set_features_.get(),
2445 compiler_options_.get(),
2446 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002447 elf_writers_.back()->Start();
Igor Murashkin545412b2017-08-17 15:26:54 -07002448 const bool do_oat_writer_layout = DoDexLayoutOptimizations() || DoOatLayoutOptimizations();
Vladimir Marko74527972016-11-29 15:57:32 +00002449 oat_writers_.emplace_back(new linker::OatWriter(
Igor Murashkin545412b2017-08-17 15:26:54 -07002450 IsBootImage(),
2451 timings_,
Mathieu Chartier603ccab2017-10-20 14:34:28 -07002452 do_oat_writer_layout ? profile_compilation_info_.get() : nullptr,
2453 compact_dex_level_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002454 }
2455 }
2456
Vladimir Marko49b0f452015-12-10 13:49:19 +00002457 void SaveDexInput() {
2458 for (size_t i = 0; i < dex_files_.size(); ++i) {
2459 const DexFile* dex_file = dex_files_[i];
2460 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2461 getpid(), i));
2462 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2463 if (tmp_file.get() == nullptr) {
2464 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2465 << ". Try: adb shell chmod 777 /data/local/tmp";
2466 continue;
2467 }
2468 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2469 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2470 UNUSED(tmp_file->Flush());
2471 UNUSED(tmp_file->Close());
2472 LOG(INFO) << "Wrote input to " << tmp_file_name;
2473 }
2474 }
2475
Mathieu Chartier46331a62017-07-21 09:49:10 -07002476 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options,
2477 QuickCompilerCallbacks* callbacks) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00002478 RuntimeOptions raw_options;
2479 if (boot_image_filename_.empty()) {
2480 std::string boot_class_path = "-Xbootclasspath:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002481 boot_class_path += android::base::Join(dex_filenames_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002482 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2483 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002484 boot_class_path_locations += android::base::Join(dex_locations_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002485 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2486 } else {
2487 std::string boot_image_option = "-Ximage:";
2488 boot_image_option += boot_image_filename_;
2489 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2490 }
2491 for (size_t i = 0; i < runtime_args_.size(); i++) {
2492 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2493 }
2494
Mathieu Chartier46331a62017-07-21 09:49:10 -07002495 raw_options.push_back(std::make_pair("compilercallbacks", callbacks));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002496 raw_options.push_back(
2497 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2498
2499 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2500 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2501 // have been stripped in preopting, anyways).
2502 if (!IsBootImage()) {
2503 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2504 }
Andreas Gampec8e35202017-04-28 15:47:12 -07002505 // Never allow implicit image compilation.
2506 raw_options.push_back(std::make_pair("-Xnoimage-dex2oat", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002507 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2508 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2509 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002510 // Disable Hspace compaction to save heap size virtual space.
2511 // Only need disable Hspace for OOM becasue background collector is equal to
2512 // foreground collector by default for dex2oat.
2513 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002514
Andreas Gampeace0dc12016-01-20 13:33:13 -08002515 if (compiler_options_->IsForceDeterminism()) {
Roland Levillainb81e9e92017-04-20 17:35:32 +01002516 // If we're asked to be deterministic, ensure non-concurrent GC for determinism.
2517 //
2518 // Note that with read barriers, this option is ignored, because Runtime::Init
2519 // overrides the foreground GC to be gc::kCollectorTypeCC when instantiating
2520 // gc::Heap. This is fine, as concurrent GC requests are not honored in dex2oat,
2521 // which uses an unstarted runtime.
Andreas Gampeace0dc12016-01-20 13:33:13 -08002522 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
Roland Levillainb81e9e92017-04-20 17:35:32 +01002523
Nicolas Geoffray7acddd82017-05-03 15:04:55 +01002524 // The default LOS implementation (map) is not deterministic. So disable it.
2525 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=disabled", nullptr));
Andreas Gampeace0dc12016-01-20 13:33:13 -08002526
2527 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2528 // compaction (done above) and ensure that neither foreground nor background collectors
2529 // are concurrent.
Roland Levillainb81e9e92017-04-20 17:35:32 +01002530 //
2531 // Likewise, this option is ignored with read barriers because Runtime::Init
2532 // overrides the background GC to be gc::kCollectorTypeCCBackground, but that's
2533 // fine too, for the same reason (see above).
Andreas Gampeace0dc12016-01-20 13:33:13 -08002534 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2535
2536 // To make identity hashcode deterministic, set a known seed.
2537 mirror::Object::SetHashCodeSeed(987654321U);
2538 }
2539
Vladimir Marko49b0f452015-12-10 13:49:19 +00002540 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2541 LOG(ERROR) << "Failed to parse runtime options";
2542 return false;
2543 }
2544 return true;
2545 }
2546
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002547 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002548 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2549 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002550 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002551 LOG(ERROR) << "Failed to create runtime";
2552 return false;
2553 }
Andreas Gampe49c144d2016-11-14 10:11:16 -08002554
2555 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2556 // "ps -a" don't change to non-descript "main."
2557 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2558
Vladimir Marko307dac92015-10-20 11:20:09 +01002559 runtime_.reset(Runtime::Current());
2560 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe8228cdf2017-05-30 15:03:54 -07002561 for (uint32_t i = 0; i < static_cast<uint32_t>(CalleeSaveType::kLastCalleeSaveType); ++i) {
2562 CalleeSaveType type = CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002563 if (!runtime_->HasCalleeSaveMethod(type)) {
2564 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002565 }
2566 }
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002567
2568 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2569 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002570 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002571
Vladimir Marko307dac92015-10-20 11:20:09 +01002572 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002573
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002574 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2575 // Runtime::Start, give it away now so that we don't starve GC.
2576 Thread* self = Thread::Current();
2577 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002578
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002579 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002580 }
2581
Jeff Haodcdc85b2015-12-04 14:06:18 -08002582 // 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 -08002583 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002584 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002585 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002586 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002587 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002588 image_filenames_.push_back(app_image_file_name_.c_str());
2589 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002590 if (!image_writer_->Write(app_image_fd_,
2591 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002592 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002593 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002594 return false;
2595 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002596
Jeff Haodcdc85b2015-12-04 14:06:18 -08002597 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002598 dchecked_vector<uintptr_t> oat_data_begins;
2599 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2600 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002601 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002602 // Destroy ImageWriter before doing FixupElf.
2603 image_writer_.reset();
2604
Vladimir Marko944da602016-02-19 12:27:55 +00002605 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2606 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002607 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2608 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2609 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2610 if (oat_file.get() == nullptr) {
2611 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2612 return false;
2613 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002614
Vladimir Marko74527972016-11-29 15:57:32 +00002615 if (!linker::ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002616 oat_file->Erase();
2617 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2618 return false;
2619 }
2620
2621 if (oat_file->FlushCloseOrErase()) {
2622 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2623 return false;
2624 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002625 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002626 }
2627
2628 return true;
2629 }
2630
2631 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002632 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2633 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002634 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002635 return ReadCommentedInputFromFile<std::unordered_set<std::string>>(image_classes_filename,
2636 &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002637 }
2638
2639 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002640 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002641 const char* zip_filename,
2642 const char* image_classes_filename,
2643 std::string* error_msg) {
2644 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002645 return ReadCommentedInputFromZip<std::unordered_set<std::string>>(zip_filename,
2646 image_classes_filename,
2647 &process,
2648 error_msg);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002649 }
2650
2651 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2652 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002653 template <typename T>
2654 static T* ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002655 const char* input_filename, std::function<std::string(const char*)>* process) {
2656 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2657 if (input_file.get() == nullptr) {
2658 LOG(ERROR) << "Failed to open input file " << input_filename;
2659 return nullptr;
2660 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002661 std::unique_ptr<T> result(
2662 ReadCommentedInputStream<T>(*input_file, process));
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002663 input_file->close();
2664 return result.release();
2665 }
2666
2667 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2668 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002669 template <typename T>
2670 static T* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002671 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002672 const char* input_filename,
2673 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002674 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002675 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2676 if (zip_archive.get() == nullptr) {
2677 return nullptr;
2678 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002679 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002680 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002681 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002682 zip_filename, error_msg->c_str());
2683 return nullptr;
2684 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002685 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2686 input_filename,
2687 error_msg));
2688 if (input_file.get() == nullptr) {
2689 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002690 zip_filename, error_msg->c_str());
2691 return nullptr;
2692 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002693 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2694 input_file->Size());
2695 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002696 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002697 }
2698
2699 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2700 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002701 template <typename T>
2702 static T* ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002703 std::istream& in_stream,
2704 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002705 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002706 while (in_stream.good()) {
2707 std::string dot;
2708 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08002709 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002710 continue;
2711 }
2712 if (process != nullptr) {
2713 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002714 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002715 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002716 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002717 }
2718 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002719 return output.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002720 }
2721
Mathieu Chartier49285c52014-12-02 15:43:48 -08002722 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002723 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2724 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002725 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampec560fc02014-07-16 09:57:39 -07002726 LOG(INFO) << "dex2oat took "
2727 << PrettyDuration(NanoTime() - start_ns_)
Andreas Gampecc967752016-12-12 13:49:00 -08002728 << " (" << PrettyDuration(ProcessCpuNanoTime() - start_cputime_ns_) << " cpu)"
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002729 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002730 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002731 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2732 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002733 }
2734
Jeff Haodcdc85b2015-12-04 14:06:18 -08002735 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2736 std::string res(image_filename);
2737 size_t last_slash = res.rfind('/');
2738 if (last_slash == std::string::npos || last_slash == 0) {
2739 return res;
2740 }
2741 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2742 if (penultimate_slash == std::string::npos) {
2743 return res;
2744 }
2745 // Check that the string in-between is the expected one.
2746 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2747 GetInstructionSetString(isa)) {
2748 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2749 return res;
2750 }
2751 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2752 }
2753
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002754 std::unique_ptr<CompilerOptions> compiler_options_;
2755 Compiler::Kind compiler_kind_;
2756
2757 InstructionSet instruction_set_;
2758 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2759
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002760 uint32_t image_file_location_oat_checksum_;
2761 uintptr_t image_file_location_oat_data_begin_;
2762 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002763 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2764
Vladimir Marko307dac92015-10-20 11:20:09 +01002765 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002766
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002767 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2768
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002769 std::unique_ptr<Runtime> runtime_;
2770
Calin Juravle1ce70852017-06-28 10:59:03 -07002771 // The spec describing how the class loader should be setup for compilation.
2772 std::unique_ptr<ClassLoaderContext> class_loader_context_;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002773
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002774 size_t thread_count_;
2775 uint64_t start_ns_;
Andreas Gampec560fc02014-07-16 09:57:39 -07002776 uint64_t start_cputime_ns_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002777 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002778 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002779 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002780 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002781 std::vector<const char*> oat_filenames_;
2782 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002783 int oat_fd_;
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00002784 int input_vdex_fd_;
2785 int output_vdex_fd_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002786 std::string input_vdex_;
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01002787 std::string output_vdex_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002788 std::unique_ptr<VdexFile> input_vdex_file_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002789 std::vector<const char*> dex_filenames_;
2790 std::vector<const char*> dex_locations_;
2791 int zip_fd_;
2792 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002793 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002794 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002795 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002796 uintptr_t image_base_;
2797 const char* image_classes_zip_filename_;
2798 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002799 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002800 const char* compiled_classes_zip_filename_;
2801 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002802 const char* compiled_methods_zip_filename_;
2803 const char* compiled_methods_filename_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002804 const char* passes_to_run_filename_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002805 const char* dirty_image_objects_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002806 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2807 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002808 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002809 std::unique_ptr<std::unordered_set<std::string>> dirty_image_objects_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002810 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Jeff Hao436183f2016-01-12 16:36:50 -08002811 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002812 bool is_host_;
2813 std::string android_root_;
Mathieu Chartier0b490842016-05-25 15:05:59 -07002814 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002815 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002816 std::string no_inline_from_string_;
Mathieu Chartiera7f6b812017-12-11 13:34:29 -08002817 CompactDexLevel compact_dex_level_ = kDefaultCompactDexLevel;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002818
Vladimir Marko74527972016-11-29 15:57:32 +00002819 std::vector<std::unique_ptr<linker::ElfWriter>> elf_writers_;
2820 std::vector<std::unique_ptr<linker::OatWriter>> oat_writers_;
2821 std::vector<linker::OutputStream*> rodata_;
2822 std::vector<std::unique_ptr<linker::OutputStream>> vdex_out_;
2823 std::unique_ptr<linker::ImageWriter> image_writer_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002824 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002825
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002826 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
2827 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2828
Calin Juravle1ce70852017-06-28 10:59:03 -07002829 // Note that this might contain pointers owned by class_loader_context_.
Vladimir Marko47496c22016-01-27 16:15:08 +00002830 std::vector<const DexFile*> no_inline_from_dex_files_;
2831
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07002832 bool avoid_storing_invocation_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002833 std::string swap_file_name_;
2834 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002835 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2836 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002837 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002838 std::string app_image_file_name_;
2839 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002840 std::string profile_file_;
2841 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002842 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002843 TimingLogger* timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002844 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002845 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002846
2847 // Backing storage.
Andreas Gampe097f34c2017-08-23 08:57:51 -07002848 std::forward_list<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002849
Andreas Gampeace0dc12016-01-20 13:33:13 -08002850 // See CompilerOptions.force_determinism_.
2851 bool force_determinism_;
2852
Jeff Hao16d48432017-04-05 17:05:46 -07002853 // Directory of relative classpaths.
2854 std::string classpath_dir_;
2855
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00002856 // Whether the given input vdex is also the output.
2857 bool update_input_vdex_ = false;
2858
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002859 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2860};
2861
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002862static void b13564922() {
2863#if defined(__linux__) && defined(__arm__)
2864 int major, minor;
2865 struct utsname uts;
2866 if (uname(&uts) != -1 &&
2867 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2868 ((major < 3) || ((major == 3) && (minor < 4)))) {
2869 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2870 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2871 int old_personality = personality(0xffffffff);
2872 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2873 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2874 if (new_personality == -1) {
2875 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2876 }
2877 }
2878 }
2879#endif
2880}
2881
Mathieu Chartier72041a02017-07-14 18:23:25 -07002882class ScopedGlobalRef {
2883 public:
2884 explicit ScopedGlobalRef(jobject obj) : obj_(obj) {}
2885 ~ScopedGlobalRef() {
2886 if (obj_ != nullptr) {
2887 ScopedObjectAccess soa(Thread::Current());
Ian Rogers55256cb2017-12-21 17:07:11 -08002888 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), obj_);
Mathieu Chartier72041a02017-07-14 18:23:25 -07002889 }
2890 }
2891
2892 private:
2893 jobject obj_;
2894};
2895
Andreas Gampe7b565912017-03-20 15:48:52 -07002896static dex2oat::ReturnCode CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002897 dex2oat.LoadClassProfileDescriptors();
Mathieu Chartier9e050df2017-08-09 10:05:47 -07002898 // Keep the class loader that was used for compilation live for the rest of the compilation
2899 // process.
Mathieu Chartier72041a02017-07-14 18:23:25 -07002900 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08002901
David Brazdil7b49e6c2016-09-01 11:06:18 +01002902 if (!dex2oat.WriteOutputFiles()) {
2903 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002904 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002905 }
2906
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002907 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2908 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2909 // image writer will require this fd to generate the image.
2910 if (dex2oat.ShouldKeepOatFileOpen()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002911 if (!dex2oat.FlushOutputFiles()) {
2912 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002913 return dex2oat::ReturnCode::kOther;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002914 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01002915 } else if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002916 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002917 }
2918
Jeff Haodcdc85b2015-12-04 14:06:18 -08002919 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002920 if (!dex2oat.HandleImage()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002921 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002922 }
2923
2924 // When given --host, finish early without stripping.
2925 if (dex2oat.IsHost()) {
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002926 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002927 return dex2oat::ReturnCode::kOther;
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002928 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002929 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002930 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002931 }
2932
Jeff Haodcdc85b2015-12-04 14:06:18 -08002933 // Copy stripped to unstripped location, if necessary.
2934 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002935 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002936 }
2937
Jeff Haodcdc85b2015-12-04 14:06:18 -08002938 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002939 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002940 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002941 }
2942
2943 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002944 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002945}
2946
Andreas Gampe7b565912017-03-20 15:48:52 -07002947static dex2oat::ReturnCode CompileApp(Dex2Oat& dex2oat) {
Mathieu Chartier9e050df2017-08-09 10:05:47 -07002948 // Keep the class loader that was used for compilation live for the rest of the compilation
2949 // process.
Mathieu Chartier72041a02017-07-14 18:23:25 -07002950 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08002951
David Brazdil7b49e6c2016-09-01 11:06:18 +01002952 if (!dex2oat.WriteOutputFiles()) {
2953 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002954 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002955 }
2956
Jeff Haodcdc85b2015-12-04 14:06:18 -08002957 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002958 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002959
2960 // When given --host, finish early without stripping.
2961 if (dex2oat.IsHost()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002962 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002963 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002964 }
2965
2966 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002967 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002968 }
2969
Jeff Haodcdc85b2015-12-04 14:06:18 -08002970 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2971 // stripped versions. If this is given, we expect to be able to open writable files by name.
2972 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002973 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002974 }
2975
Jeff Haodcdc85b2015-12-04 14:06:18 -08002976 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002977 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002978 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002979 }
2980
2981 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002982 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002983}
2984
Andreas Gampe7b565912017-03-20 15:48:52 -07002985static dex2oat::ReturnCode Dex2oat(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002986 b13564922();
2987
2988 TimingLogger timings("compiler", false, false);
2989
Roland Levillain5c7e2602016-02-23 18:08:53 +00002990 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
2991 // might produce a stack frame too large for this function or for
2992 // functions inlining it (such as main), that would not fit the
2993 // requirements of the `-Wframe-larger-than` option.
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07002994 std::unique_ptr<Dex2Oat> dex2oat = std::make_unique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002995
2996 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002997 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002998
Calin Juravleb077e152016-02-18 18:47:37 +00002999 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02003000 // This operation involves I/O.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08003001 if (dex2oat->UseProfile()) {
Calin Juravleb077e152016-02-18 18:47:37 +00003002 if (!dex2oat->LoadProfile()) {
3003 LOG(ERROR) << "Failed to process profile file";
Andreas Gampe7b565912017-03-20 15:48:52 -07003004 return dex2oat::ReturnCode::kOther;
Calin Juravle998c2162015-12-21 15:39:33 +02003005 }
3006 }
3007
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00003008 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap, and vdex.
3009
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003010 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00003011 if (!dex2oat->OpenFile()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003012 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003013 }
3014
Andreas Gampe046c7062015-05-18 23:22:54 -07003015 // Print the complete line when any of the following is true:
3016 // 1) Debug build
3017 // 2) Compiling an image
3018 // 3) Compiling with --host
3019 // 4) Compiling on the host (not a target build)
3020 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003021 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07003022 LOG(INFO) << CommandLine();
3023 } else {
3024 LOG(INFO) << StrippedCommandLine();
3025 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003026
Andreas Gampef7882972017-03-20 16:35:24 -07003027 dex2oat::ReturnCode setup_code = dex2oat->Setup();
3028 if (setup_code != dex2oat::ReturnCode::kNoFailure) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003029 dex2oat->EraseOutputFiles();
Andreas Gampef7882972017-03-20 16:35:24 -07003030 return setup_code;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003031 }
3032
Shubham Ajmera188b2bf2017-09-20 15:53:35 -07003033 // TODO: Due to the cyclic dependencies, profile loading and verifying are
3034 // being done separately. Refactor and place the two next to each other.
3035 // If verification fails, we don't abort the compilation and instead log an
3036 // error.
3037 // TODO(b/62602192, b/65260586): We should consider aborting compilation when
3038 // the profile verification fails.
3039 // Note: If dex2oat fails, installd will remove the oat files causing the app
3040 // to fallback to apk with possible in-memory extraction. We want to avoid
3041 // that, and thus we're lenient towards profile corruptions.
3042 if (dex2oat->UseProfile()) {
3043 dex2oat->VerifyProfileData();
3044 }
3045
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07003046 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
3047 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07003048 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
3049
Andreas Gampe7b565912017-03-20 15:48:52 -07003050 dex2oat::ReturnCode result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00003051 if (dex2oat->IsImage()) {
3052 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08003053 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00003054 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003055 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003056
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003057 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003058}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003059} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07003060
3061int main(int argc, char** argv) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003062 int result = static_cast<int>(art::Dex2oat(argc, argv));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003063 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
Pirama Arumuga Nainarab898922018-01-04 10:37:48 -08003064 // time (bug 10645725) unless we're a debug or instrumented build or running on valgrind. Note:
3065 // The Dex2Oat class should not destruct the runtime in this case.
3066 if (!art::kIsDebugBuild && !art::kIsPGOInstrumentation && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampee286b642017-04-13 12:20:42 -07003067 _exit(result);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003068 }
3069 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07003070}