blob: 926575e10c36fa670b3762e87fc621e1739a9100 [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"
David Sehr67bf42e2018-02-26 16:43:04 -080047#include "base/leb128.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080048#include "base/macros.h"
Calin Juravle2e2db782016-02-23 12:00:03 +000049#include "base/scoped_flock.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070050#include "base/stl_util.h"
51#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010052#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070053#include "base/timing_logger.h"
54#include "base/unix_file/fd_file.h"
55#include "class_linker.h"
Calin Juravle1ce70852017-06-28 10:59:03 -070056#include "class_loader_context.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070057#include "cmdline_parser.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000058#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000059#include "compiler_callbacks.h"
David Srbecky09c2a6b2016-03-11 17:11:44 +000060#include "debug/elf_debug_writer.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000061#include "debug/method_debug_info.h"
Mathieu Chartier2c4b0842017-12-13 11:49:51 -080062#include "dexlayout.h"
David Sehrb2ec9f52018-02-21 13:20:31 -080063#include "dex/descriptors_names.h"
David Sehr9e734c72018-01-04 17:56:19 -080064#include "dex/dex_file-inl.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000065#include "dex/quick_compiler_callbacks.h"
66#include "dex/verification_results.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070067#include "dex2oat_options.h"
Andreas Gampe7b565912017-03-20 15:48:52 -070068#include "dex2oat_return_codes.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070069#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080070#include "driver/compiler_options.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070071#include "driver/compiler_options_map-inl.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080072#include "elf_file.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070073#include "gc/space/image_space.h"
74#include "gc/space/space-inl.h"
Mathieu Chartier72041a02017-07-14 18:23:25 -070075#include "gc/verification.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070076#include "interpreter/unstarted_runtime.h"
Mathieu Chartier72041a02017-07-14 18:23:25 -070077#include "java_vm_ext.h"
Calin Juravle33083d62017-01-18 15:29:12 -080078#include "jit/profile_compilation_info.h"
David Brazdil5d5a36b2016-09-14 15:34:10 +010079#include "linker/buffered_output_stream.h"
Vladimir Marko74527972016-11-29 15:57:32 +000080#include "linker/elf_writer.h"
81#include "linker/elf_writer_quick.h"
David Brazdil5d5a36b2016-09-14 15:34:10 +010082#include "linker/file_output_stream.h"
Vladimir Marko74527972016-11-29 15:57:32 +000083#include "linker/image_writer.h"
Vladimir Marko944da602016-02-19 12:27:55 +000084#include "linker/multi_oat_relative_patcher.h"
Vladimir Marko74527972016-11-29 15:57:32 +000085#include "linker/oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070086#include "mirror/class-inl.h"
87#include "mirror/class_loader.h"
88#include "mirror/object-inl.h"
89#include "mirror/object_array-inl.h"
Andreas Gampe2ff3b972017-06-05 18:14:53 -070090#include "oat_file.h"
Jeff Haob11ffb72016-04-07 15:40:54 -070091#include "oat_file_assistant.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070092#include "os.h"
93#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000094#include "runtime_options.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070095#include "scoped_thread_state_change-inl.h"
Alex Light53cb16b2014-06-12 11:26:29 -070096#include "utils.h"
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +000097#include "vdex_file.h"
David Brazdilca3c8c32016-09-06 14:04:48 +010098#include "verifier/verifier_deps.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070099#include "well_known_classes.h"
100#include "zip_archive.h"
101
102namespace art {
103
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800104using android::base::StringAppendV;
105using android::base::StringPrintf;
106
Andreas Gampee1459ae2016-06-29 09:36:30 -0700107static constexpr size_t kDefaultMinDexFilesForSwap = 2;
108static constexpr size_t kDefaultMinDexFileCumulativeSizeForSwap = 20 * MB;
109
Mathieu Chartier010126f2017-07-15 15:44:18 -0700110// Compiler filter override for very large apps.
111static constexpr CompilerFilter::Filter kLargeAppFilter = CompilerFilter::kVerify;
112
Brian Carlstrom6449c622014-02-10 23:48:36 -0800113static int original_argc;
114static char** original_argv;
115
116static std::string CommandLine() {
117 std::vector<std::string> command;
118 for (int i = 0; i < original_argc; ++i) {
119 command.push_back(original_argv[i]);
120 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800121 return android::base::Join(command, ' ');
Brian Carlstrom6449c622014-02-10 23:48:36 -0800122}
123
Andreas Gampe046c7062015-05-18 23:22:54 -0700124// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
125// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
126// locations are all staged).
127static std::string StrippedCommandLine() {
128 std::vector<std::string> command;
129
Calin Juravle07c6d722017-06-07 17:06:12 +0000130 // Do a pre-pass to look for zip-fd and the compiler filter.
Andreas Gampe046c7062015-05-18 23:22:54 -0700131 bool saw_zip_fd = false;
Calin Juravle07c6d722017-06-07 17:06:12 +0000132 bool saw_compiler_filter = false;
Andreas Gampe046c7062015-05-18 23:22:54 -0700133 for (int i = 0; i < original_argc; ++i) {
Andreas Gampe9186ced2016-12-12 14:28:21 -0800134 if (android::base::StartsWith(original_argv[i], "--zip-fd=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700135 saw_zip_fd = true;
Andreas Gampe046c7062015-05-18 23:22:54 -0700136 }
Calin Juravle07c6d722017-06-07 17:06:12 +0000137 if (android::base::StartsWith(original_argv[i], "--compiler-filter=")) {
138 saw_compiler_filter = true;
Calin Juravle07c6d722017-06-07 17:06:12 +0000139 }
Andreas Gampe046c7062015-05-18 23:22:54 -0700140 }
141
142 // Now filter out things.
143 for (int i = 0; i < original_argc; ++i) {
144 // All runtime-arg parameters are dropped.
145 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
146 i++; // Drop the next part, too.
147 continue;
148 }
149
150 // Any instruction-setXXX is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800151 if (android::base::StartsWith(original_argv[i], "--instruction-set")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700152 continue;
153 }
154
155 // The boot image is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800156 if (android::base::StartsWith(original_argv[i], "--boot-image=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700157 continue;
158 }
159
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800160 // The image format is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800161 if (android::base::StartsWith(original_argv[i], "--image-format=")) {
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800162 continue;
163 }
164
Andreas Gampe046c7062015-05-18 23:22:54 -0700165 // This should leave any dex-file and oat-file options, describing what we compiled.
166
167 // However, we prefer to drop this when we saw --zip-fd.
168 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700169 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe9186ced2016-12-12 14:28:21 -0800170 if (android::base::StartsWith(original_argv[i], "--zip-") ||
171 android::base::StartsWith(original_argv[i], "--dex-") ||
172 android::base::StartsWith(original_argv[i], "--oat-") ||
173 android::base::StartsWith(original_argv[i], "--swap-") ||
174 android::base::StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700175 continue;
176 }
177 }
178
179 command.push_back(original_argv[i]);
180 }
181
Calin Juravle07c6d722017-06-07 17:06:12 +0000182 if (!saw_compiler_filter) {
183 command.push_back("--compiler-filter=" +
184 CompilerFilter::NameOfFilter(CompilerFilter::kDefaultCompilerFilter));
185 }
186
Andreas Gampe046c7062015-05-18 23:22:54 -0700187 // Construct the final output.
188 if (command.size() <= 1U) {
189 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
190 return "Starting dex2oat.";
191 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800192 return android::base::Join(command, ' ');
Andreas Gampe046c7062015-05-18 23:22:54 -0700193}
194
Brian Carlstrom7940e442013-07-12 13:46:57 -0700195static void UsageErrorV(const char* fmt, va_list ap) {
196 std::string error;
197 StringAppendV(&error, fmt, ap);
198 LOG(ERROR) << error;
199}
200
201static void UsageError(const char* fmt, ...) {
202 va_list ap;
203 va_start(ap, fmt);
204 UsageErrorV(fmt, ap);
205 va_end(ap);
206}
207
Andreas Gampe794ad762015-02-23 08:12:24 -0800208NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700209 va_list ap;
210 va_start(ap, fmt);
211 UsageErrorV(fmt, ap);
212 va_end(ap);
213
Brian Carlstrom6449c622014-02-10 23:48:36 -0800214 UsageError("Command: %s", CommandLine().c_str());
215
Brian Carlstrom7940e442013-07-12 13:46:57 -0700216 UsageError("Usage: dex2oat [options]...");
217 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100218 UsageError(" -j<number>: specifies the number of threads used for compilation.");
219 UsageError(" Default is the number of detected hardware threads available on the");
220 UsageError(" host system.");
221 UsageError(" Example: -j12");
222 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700223 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700224 UsageError(" Example: --dex-file=/system/framework/core.jar");
225 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700226 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
227 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
228 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
229 UsageError(" --dex-location=/system/framework/core.jar");
230 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700231 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
232 UsageError(" containing a classes.dex file to compile.");
233 UsageError(" Example: --zip-fd=5");
234 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700235 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
236 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700237 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
238 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800239 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700240 UsageError(" Example: --oat-file=/system/framework/boot.oat");
241 UsageError("");
242 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900243 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700244 UsageError("");
Shubham Ajmera66205322017-10-06 11:18:51 -0700245 UsageError(" --input-vdex-fd=<number>: specifies the vdex input source via a file descriptor.");
246 UsageError(" Example: --input-vdex-fd=6");
247 UsageError("");
248 UsageError(" --output-vdex-fd=<number>: specifies the vdex output destination via a file");
249 UsageError(" descriptor.");
250 UsageError(" Example: --output-vdex-fd=6");
251 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700252 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
253 UsageError(" to the file descriptor specified by --oat-fd.");
254 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
255 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800256 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700257 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
258 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800259 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700260 UsageError(" Example: --image=/system/framework/boot.art");
261 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800262 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800263 UsageError(" Which format to store the image.");
264 UsageError(" Example: --image-format=lz4");
265 UsageError(" Default: uncompressed");
266 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700267 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
268 UsageError(" Example: --image=frameworks/base/preloaded-classes");
269 UsageError("");
270 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
271 UsageError(" Example: --base=0x50000000");
272 UsageError("");
273 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000274 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700275 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000276 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000277 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700278 UsageError("");
279 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
280 UsageError(" Example: --android-root=out/host/linux-x86");
281 UsageError(" Default: $ANDROID_ROOT");
282 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800283 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700284 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700285 UsageError(" Example: --instruction-set=x86");
286 UsageError(" Default: arm");
287 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700288 UsageError(" --instruction-set-features=...,: Specify instruction set features");
289 UsageError(" Example: --instruction-set-features=div");
290 UsageError(" Default: default");
291 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700292 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
293 UsageError(" Default: disabled");
294 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800295 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700296 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800297 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100298 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700299 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100300 UsageError(" --compiler-filter="
Nicolas Geoffray49cda062017-04-21 13:08:25 +0100301 "(assume-verified"
302 "|extract"
303 "|verify"
304 "|quicken"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000305 "|space-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100306 "|space"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000307 "|speed-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100308 "|speed"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000309 "|everything-profile"
310 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700311 UsageError(" select compiler filter.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800312 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800313 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800314 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800315 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
316 UsageError(" method for compiler filter tuning.");
317 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
318 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
319 UsageError("");
320 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
321 UsageError(" method for compiler filter tuning.");
322 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
323 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
324 UsageError("");
325 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
326 UsageError(" method for compiler filter tuning.");
327 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
328 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
329 UsageError("");
330 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
331 UsageError(" method for compiler filter tuning.");
332 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
333 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
334 UsageError("");
335 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
336 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700337 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
338 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800339 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
340 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
341 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100342 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
343 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100344 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
345 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100346 UsageError(" Example: --inline-max-code-units=%d",
347 CompilerOptions::kDefaultInlineMaxCodeUnits);
348 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
349 UsageError("");
Nicolas Geoffraye82b60f2017-12-10 21:50:10 +0000350 UsageError(" --dump-timings: display a breakdown of where time was spent");
Ian Rogers46398602013-08-20 07:50:36 -0700351 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100352 UsageError(" -g");
353 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
354 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000355 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000356 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700357 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100358 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100359 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000360 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
361 UsageError(" debug information necessary to print backtraces. (disabled by default)");
362 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000363 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000364 UsageError("");
Alexey Alexandrovab40c112016-09-19 09:33:49 -0700365 UsageError(" --generate-build-id: Generate GNU-compatible linker build ID ELF section with");
366 UsageError(" SHA-1 of the file content (and thus stable across identical builds)");
367 UsageError("");
368 UsageError(" --no-generate-build-id: Do not generate the build ID ELF section.");
369 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000370 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000371 UsageError("");
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700372 UsageError(" --avoid-storing-invocation: Avoid storing the invocation args in the key value");
373 UsageError(" store. Used to test determinism with different args.");
374 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700375 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
376 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
377 UsageError(" Use a separate --runtime-arg switch for each argument.");
378 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700379 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000380 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700381 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000382 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
383 UsageError(" Cannot be used together with --profile-file.");
384 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100385 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800386 UsageError(" Example: --swap-file=/data/tmp/swap.001");
387 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100388 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800389 UsageError(" Example: --swap-fd=10");
390 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100391 UsageError(" --swap-dex-size-threshold=<size>: specifies the minimum total dex file size in");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700392 UsageError(" bytes to allow the use of swap.");
393 UsageError(" Example: --swap-dex-size-threshold=1000000");
394 UsageError(" Default: %zu", kDefaultMinDexFileCumulativeSizeForSwap);
395 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100396 UsageError(" --swap-dex-count-threshold=<count>: specifies the minimum number of dex files to");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700397 UsageError(" allow the use of swap.");
398 UsageError(" Example: --swap-dex-count-threshold=10");
399 UsageError(" Default: %zu", kDefaultMinDexFilesForSwap);
400 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100401 UsageError(" --very-large-app-threshold=<size>: specifies the minimum total dex file size in");
Mathieu Chartier010126f2017-07-15 15:44:18 -0700402 UsageError(" bytes to consider the input \"very large\" and reduce compilation done.");
Andreas Gampe67f02822016-06-24 21:05:23 -0700403 UsageError(" Example: --very-large-app-threshold=100000000");
404 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700405 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
406 UsageError(" Example: --app-image-fd=10");
407 UsageError("");
408 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
409 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
410 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800411 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
412 "input dex file.");
413 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000414 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000415 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100416 UsageError(" --dump-cfg=<cfg-file>: dump control-flow graphs (CFGs) to specified file.");
417 UsageError(" Example: --dump-cfg=output.cfg");
418 UsageError("");
419 UsageError(" --dump-cfg-append: when dumping CFGs to an existing file, append new CFG data to");
420 UsageError(" existing data (instead of overwriting existing data with new data, which is");
421 UsageError(" the default behavior). This option is only meaningful when used with");
422 UsageError(" --dump-cfg.");
423 UsageError("");
Jeff Hao16d48432017-04-05 17:05:46 -0700424 UsageError(" --classpath-dir=<directory-path>: directory used to resolve relative class paths.");
425 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700426 UsageError(" --class-loader-context=<string spec>: a string specifying the intended");
427 UsageError(" runtime loading context for the compiled dex files.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700428 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700429 UsageError(" It describes how the class loader chain should be built in order to ensure");
430 UsageError(" classes are resolved during dex2aot as they would be resolved at runtime.");
431 UsageError(" This spec will be encoded in the oat file. If at runtime the dex file is");
432 UsageError(" loaded in a different context, the oat file will be rejected.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700433 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700434 UsageError(" The chain is interpreted in the natural 'parent order', meaning that class");
435 UsageError(" loader 'i+1' will be the parent of class loader 'i'.");
Calin Juravlec79470d2017-07-12 17:37:42 -0700436 UsageError(" The compilation sources will be appended to the classpath of the first class");
437 UsageError(" loader.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700438 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700439 UsageError(" E.g. if the context is 'PCL[lib1.dex];DLC[lib2.dex]' and ");
440 UsageError(" --dex-file=src.dex then dex2oat will setup a PathClassLoader with classpath ");
441 UsageError(" 'lib1.dex:src.dex' and set its parent to a DelegateLastClassLoader with ");
442 UsageError(" classpath 'lib2.dex'.");
Calin Juravle1ce70852017-06-28 10:59:03 -0700443 UsageError(" ");
444 UsageError(" Note that the compiler will be tolerant if the source dex files specified");
445 UsageError(" with --dex-file are found in the classpath. The source dex files will be");
446 UsageError(" removed from any class loader's classpath possibly resulting in empty");
447 UsageError(" class loaders.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700448 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700449 UsageError(" Example: --class-loader-context=PCL[lib1.dex:lib2.dex];DLC[lib3.dex]");
Calin Juravle1ce70852017-06-28 10:59:03 -0700450 UsageError("");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700451 UsageError(" --dirty-image-objects=<directory-path>: list of known dirty objects in the image.");
452 UsageError(" The image writer will group them together.");
453 UsageError("");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700454 UsageError(" --compact-dex-level=none|fast: None avoids generating compact dex, fast");
Mathieu Chartier24066ec2017-10-21 16:01:08 -0700455 UsageError(" generates compact dex with low compile time.");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700456 UsageError("");
Andreas Gampee20ff6f2017-11-07 15:00:35 -0800457 UsageError(" --deduplicate-code=true|false: enable|disable code deduplication. Deduplicated");
458 UsageError(" code will have an arbitrary symbol tagged with [DEDUPED].");
Andreas Gampecac31ad2017-11-06 20:01:17 -0800459 UsageError("");
Nicolas Geoffray66ff8a82018-02-28 13:27:55 +0000460 UsageError(" --copy-dex-files=true|false: enable|disable copying the dex files into the");
Mathieu Chartier792111c2018-02-15 13:02:15 -0800461 UsageError(" output vdex.");
462 UsageError("");
Calin Juravle0e09dfc2018-02-12 19:01:09 -0800463 UsageError(" --compilation-reason=<string>: optional metadata specifying the reason for");
464 UsageError(" compiling the apk. If specified, the string will be embedded verbatim in");
465 UsageError(" the key value store of the oat file.");
466 UsageError("");
467 UsageError(" Example: --compilation-reason=install");
468 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700469 std::cerr << "See log for usage error information\n";
470 exit(EXIT_FAILURE);
471}
472
Brian Carlstrom7940e442013-07-12 13:46:57 -0700473// The primary goal of the watchdog is to prevent stuck build servers
474// during development when fatal aborts lead to a cascade of failures
475// that result in a deadlock.
476class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800477// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700478#undef CHECK_PTHREAD_CALL
479#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
480 do { \
481 int rc = call args; \
482 if (rc != 0) { \
483 errno = rc; \
484 std::string message(# call); \
485 message += " failed for "; \
486 message += reason; \
487 Fatal(message); \
488 } \
489 } while (false)
490
491 public:
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800492 explicit WatchDog(int64_t timeout_in_milliseconds)
Andreas Gampe0f54b0d2017-12-27 08:37:02 -0800493 : timeout_in_milliseconds_(timeout_in_milliseconds),
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800494 shutting_down_(false) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700495 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700496 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800497#ifndef __APPLE__
498 pthread_condattr_t condattr;
liulvping8f7101e2017-01-16 15:14:43 +0800499 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_init, (&condattr), reason);
500 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_setclock, (&condattr, CLOCK_MONOTONIC), reason);
501 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, &condattr), reason);
502 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_destroy, (&condattr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800503#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700504 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
505 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
506 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
507 }
508 ~WatchDog() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700509 const char* reason = "dex2oat watch dog thread shutdown";
510 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
511 shutting_down_ = true;
512 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
513 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
514
Kenny Root51316382014-05-13 14:59:37 -0700515 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700516
517 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
518 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
519 }
520
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800521 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
522 // large.
523 static constexpr int64_t kWatchdogVerifyMultiplier =
524 kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
525
526 // When setting timeouts, keep in mind that the build server may not be as fast as your
527 // desktop. Debug builds are slower so they have larger timeouts.
528 static constexpr int64_t kWatchdogSlowdownFactor = kIsDebugBuild ? 5U : 1U;
529
530 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
531 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
532 // itself before that watchdog would take down the system server.
533 static constexpr int64_t kWatchDogTimeoutSeconds = kWatchdogSlowdownFactor * (9 * 60 + 30);
534
535 static constexpr int64_t kDefaultWatchdogTimeoutInMS =
536 kWatchdogVerifyMultiplier * kWatchDogTimeoutSeconds * 1000;
537
Brian Carlstrom7940e442013-07-12 13:46:57 -0700538 private:
539 static void* CallBack(void* arg) {
540 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
541 ::art::SetThreadName("dex2oat watch dog");
542 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700543 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700544 }
545
Andreas Gampe794ad762015-02-23 08:12:24 -0800546 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700547 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
548 // it's rather easy to hang in unwinding.
549 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
550 // logcat logging or stderr output.
Tomasz Wasilczyk8d840902017-12-20 08:19:53 -0800551 LogHelper::LogLineLowStack(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
552
Andreas Gampe48fde372017-06-06 07:43:46 -0700553 // If we're on the host, try to dump all threads to get a sense of what's going on. This is
554 // restricted to the host as the dump may itself go bad.
555 // TODO: Use a double watchdog timeout, so we can enable this on-device.
556 if (!kIsTargetBuild && Runtime::Current() != nullptr) {
Andreas Gampecd607312017-06-05 17:03:05 -0700557 Runtime::Current()->AttachCurrentThread("Watchdog thread attached for dumping",
558 true,
559 nullptr,
560 false);
561 Runtime::Current()->DumpForSigQuit(std::cerr);
562 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700563 exit(1);
564 }
565
566 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700567 timespec timeout_ts;
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800568#if defined(__APPLE__)
569 InitTimeSpec(true, CLOCK_REALTIME, timeout_in_milliseconds_, 0, &timeout_ts);
570#else
liulvping8f7101e2017-01-16 15:14:43 +0800571 InitTimeSpec(true, CLOCK_MONOTONIC, timeout_in_milliseconds_, 0, &timeout_ts);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800572#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700573 const char* reason = "dex2oat watch dog thread waiting";
574 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
575 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800576 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700577 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700578 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800579 timeout_in_milliseconds_/1000));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700580 } else if (rc != 0) {
581 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
582 strerror(errno)));
583 Fatal(message.c_str());
584 }
585 }
586 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
587 }
588
Brian Carlstrom7940e442013-07-12 13:46:57 -0700589 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
590 pthread_mutex_t mutex_;
591 pthread_cond_t cond_;
592 pthread_attr_t attr_;
593 pthread_t pthread_;
Andreas Gampef45d61c2017-06-07 10:29:33 -0700594
595 const int64_t timeout_in_milliseconds_;
596 bool shutting_down_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700597};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700598
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800599class Dex2Oat FINAL {
600 public:
601 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100602 compiler_kind_(Compiler::kOptimizing),
Vladimir Marko33bff252017-11-01 14:35:42 +0000603 instruction_set_(kRuntimeISA == InstructionSet::kArm ? InstructionSet::kThumb2 : kRuntimeISA),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800604 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000605 image_file_location_oat_checksum_(0),
606 image_file_location_oat_data_begin_(0),
607 image_patch_delta_(0),
608 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700609 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800610 runtime_(nullptr),
611 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
612 start_ns_(NanoTime()),
Andreas Gampec560fc02014-07-16 09:57:39 -0700613 start_cputime_ns_(ProcessCpuNanoTime()),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800614 oat_fd_(-1),
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000615 input_vdex_fd_(-1),
616 output_vdex_fd_(-1),
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000617 input_vdex_file_(nullptr),
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +0000618 dm_fd_(-1),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800619 zip_fd_(-1),
620 image_base_(0U),
621 image_classes_zip_filename_(nullptr),
622 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800623 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800624 compiled_classes_zip_filename_(nullptr),
625 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700626 compiled_methods_zip_filename_(nullptr),
627 compiled_methods_filename_(nullptr),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700628 passes_to_run_filename_(nullptr),
Mathieu Chartierff0baff2017-08-02 23:04:19 -0700629 dirty_image_objects_filename_(nullptr),
Jeff Hao436183f2016-01-12 16:36:50 -0800630 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800631 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000632 elf_writers_(),
633 oat_writers_(),
634 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000635 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700636 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000637 opened_dex_files_maps_(),
638 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000639 no_inline_from_dex_files_(),
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700640 avoid_storing_invocation_(false),
Calin Juravle2e2db782016-02-23 12:00:03 +0000641 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800642 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000643 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800644 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000645 force_determinism_(false)
646 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800647
648 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800649 // Log completion time before deleting the runtime_, because this accesses
650 // the runtime.
651 LogCompletionTime();
652
Vladimir Marko307dac92015-10-20 11:20:09 +0100653 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
654 // We want to just exit on non-debug builds, not bringing the runtime down
655 // in an orderly fashion. So release the following fields.
656 driver_.release();
657 image_writer_.release();
658 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
659 dex_file.release();
660 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000661 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
662 map.release();
663 }
David Brazdil7b49e6c2016-09-01 11:06:18 +0100664 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
665 vdex_file.release();
666 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800667 for (std::unique_ptr<File>& oat_file : oat_files_) {
668 oat_file.release();
669 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100670 runtime_.release();
671 verification_results_.release();
672 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100673 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700674 }
675
Roland Levillain9ec5e222015-08-17 20:18:41 +0100676 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800677 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800678 std::string boot_image_filename;
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800679 int64_t watch_dog_timeout_in_ms = -1;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800680 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000681 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800682 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100683 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800684
Andreas Gampe097f34c2017-08-23 08:57:51 -0700685 void ParseBase(const std::string& option) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100686 char* end;
Andreas Gampe097f34c2017-08-23 08:57:51 -0700687 image_base_ = strtoul(option.c_str(), &end, 16);
688 if (end == option.c_str() || *end != '\0') {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100689 Usage("Failed to parse hexadecimal value for option %s", option.data());
690 }
691 }
692
Shubham Ajmera188b2bf2017-09-20 15:53:35 -0700693 bool VerifyProfileData() {
694 return profile_compilation_info_->VerifyProfileData(dex_files_);
695 }
696
Andreas Gampe097f34c2017-08-23 08:57:51 -0700697 void ParseInstructionSetVariant(const std::string& option, ParserOptions* parser_options) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800698 instruction_set_features_ = InstructionSetFeatures::FromVariant(
Andreas Gampe097f34c2017-08-23 08:57:51 -0700699 instruction_set_, option, &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100700 if (instruction_set_features_.get() == nullptr) {
701 Usage("%s", parser_options->error_msg.c_str());
702 }
703 }
704
Andreas Gampe097f34c2017-08-23 08:57:51 -0700705 void ParseInstructionSetFeatures(const std::string& option, ParserOptions* parser_options) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800706 if (instruction_set_features_ == nullptr) {
707 instruction_set_features_ = InstructionSetFeatures::FromVariant(
708 instruction_set_, "default", &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100709 if (instruction_set_features_.get() == nullptr) {
710 Usage("Problem initializing default instruction set features variant: %s",
711 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700712 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800713 }
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800714 instruction_set_features_ =
Andreas Gampe097f34c2017-08-23 08:57:51 -0700715 instruction_set_features_->AddFeaturesFromString(option, &parser_options->error_msg);
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800716 if (instruction_set_features_ == nullptr) {
Andreas Gampe097f34c2017-08-23 08:57:51 -0700717 Usage("Error parsing '%s': %s", option.c_str(), parser_options->error_msg.c_str());
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800718 }
719 }
720
Jeff Hao436183f2016-01-12 16:36:50 -0800721 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoaad75c62016-10-03 08:46:48 +0000722 compiler_options_->boot_image_ = !image_filenames_.empty();
723 compiler_options_->app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700724
Roland Levillain2b03a1f2017-06-06 16:09:59 +0100725 if (IsBootImage() && image_filenames_.size() == 1) {
726 const std::string& boot_image_filename = image_filenames_[0];
727 compiler_options_->core_image_ = CompilerDriver::IsCoreImageFilename(boot_image_filename);
728 }
729
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700730 if (IsAppImage() && IsBootImage()) {
731 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
732 }
733
Jeff Haodcdc85b2015-12-04 14:06:18 -0800734 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800735 Usage("Output must be supplied with either --oat-file or --oat-fd");
736 }
737
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000738 if (input_vdex_fd_ != -1 && !input_vdex_.empty()) {
739 Usage("Can't have both --input-vdex-fd and --input-vdex");
740 }
741
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +0100742 if (output_vdex_fd_ != -1 && !output_vdex_.empty()) {
743 Usage("Can't have both --output-vdex-fd and --output-vdex");
744 }
745
Jeff Haodcdc85b2015-12-04 14:06:18 -0800746 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800747 Usage("--oat-file should not be used with --oat-fd");
748 }
749
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000750 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +0100751 Usage("VDEX and OAT output must be specified either with one --oat-filename "
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000752 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100753 }
754
Roland Levillain9ec5e222015-08-17 20:18:41 +0100755 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800756 Usage("--oat-symbols should not be used with --oat-fd");
757 }
758
Roland Levillain9ec5e222015-08-17 20:18:41 +0100759 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800760 Usage("--oat-symbols should not be used with --host");
761 }
762
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000763 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
764 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100765 }
766
Jeff Haodcdc85b2015-12-04 14:06:18 -0800767 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800768 Usage("--oat-fd should not be used with --image");
769 }
770
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +0000771 if ((input_vdex_fd_ != -1 || !input_vdex_.empty()) &&
772 (dm_fd_ != -1 || !dm_file_location_.empty())) {
773 Usage("An input vdex should not be passed with a .dm file");
774 }
775
Jeff Haodcdc85b2015-12-04 14:06:18 -0800776 if (!parser_options->oat_symbols.empty() &&
777 parser_options->oat_symbols.size() != oat_filenames_.size()) {
778 Usage("--oat-file arguments do not match --oat-symbols arguments");
779 }
780
781 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
782 Usage("--oat-file arguments do not match --image arguments");
783 }
784
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800785 if (android_root_.empty()) {
786 const char* android_root_env_var = getenv("ANDROID_ROOT");
787 if (android_root_env_var == nullptr) {
788 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700789 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800790 android_root_ += android_root_env_var;
791 }
792
Vladimir Markoaad75c62016-10-03 08:46:48 +0000793 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100794 parser_options->boot_image_filename += android_root_;
795 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800796 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100797 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000798 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800799 }
800
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700801 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800802 Usage("--image-classes should only be used with --image");
803 }
804
Vladimir Marko49b0f452015-12-10 13:49:19 +0000805 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800806 Usage("--image-classes should not be used with --boot-image");
807 }
808
809 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
810 Usage("--image-classes-zip should be used with --image-classes");
811 }
812
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700813 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800814 Usage("--compiled-classes should only be used with --image");
815 }
816
Vladimir Marko49b0f452015-12-10 13:49:19 +0000817 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800818 Usage("--compiled-classes should not be used with --boot-image");
819 }
820
821 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
822 Usage("--compiled-classes-zip should be used with --compiled-classes");
823 }
824
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800825 if (dex_filenames_.empty() && zip_fd_ == -1) {
826 Usage("Input must be supplied with either --dex-file or --zip-fd");
827 }
828
829 if (!dex_filenames_.empty() && zip_fd_ != -1) {
830 Usage("--dex-file should not be used with --zip-fd");
831 }
832
833 if (!dex_filenames_.empty() && !zip_location_.empty()) {
834 Usage("--dex-file should not be used with --zip-location");
835 }
836
837 if (dex_locations_.empty()) {
838 for (const char* dex_file_name : dex_filenames_) {
839 dex_locations_.push_back(dex_file_name);
840 }
841 } else if (dex_locations_.size() != dex_filenames_.size()) {
842 Usage("--dex-location arguments do not match --dex-file arguments");
843 }
844
Jeff Haodcdc85b2015-12-04 14:06:18 -0800845 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
846 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
847 Usage("--oat-file arguments must be singular or match --dex-file arguments");
848 }
849 }
850
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800851 if (zip_fd_ != -1 && zip_location_.empty()) {
852 Usage("--zip-location should be supplied with --zip-fd");
853 }
854
Vladimir Marko49b0f452015-12-10 13:49:19 +0000855 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800856 if (image_base_ == 0) {
857 Usage("Non-zero --base not specified");
858 }
859 }
860
Mathieu Chartiera8077802016-03-16 19:08:31 -0700861 const bool have_profile_file = !profile_file_.empty();
862 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
863 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000864 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200865 }
866
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -0700867 if (have_profile_file || have_profile_fd) {
868 if (compiled_classes_filename_ != nullptr ||
869 compiled_classes_zip_filename_ != nullptr ||
870 image_classes_filename_ != nullptr ||
871 image_classes_zip_filename_ != nullptr) {
872 Usage("Profile based image creation is not supported with image or compiled classes");
873 }
874 }
875
Roland Levillain9ec5e222015-08-17 20:18:41 +0100876 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800877 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800878 }
879
880 // If no instruction set feature was given, use the default one for the target
881 // instruction set.
882 if (instruction_set_features_.get() == nullptr) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800883 instruction_set_features_ = InstructionSetFeatures::FromVariant(
884 instruction_set_, "default", &parser_options->error_msg);
Ian Rogersd582fa42014-11-05 23:46:43 -0800885 if (instruction_set_features_.get() == nullptr) {
886 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100887 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800888 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800889 }
890
891 if (instruction_set_ == kRuntimeISA) {
892 std::unique_ptr<const InstructionSetFeatures> runtime_features(
893 InstructionSetFeatures::FromCppDefines());
894 if (!instruction_set_features_->Equals(runtime_features.get())) {
895 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
896 << *instruction_set_features_ << ") and those of dex2oat executable ("
897 << *runtime_features <<") for the command line:\n"
898 << CommandLine();
899 }
900 }
901
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000902 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +0000903 compiler_options_->inline_max_code_units_ = CompilerOptions::kDefaultInlineMaxCodeUnits;
Roland Levillaina215b952015-08-07 11:38:32 +0100904 }
905
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800906 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800907 // Set the compilation target's implicit checks options.
908 switch (instruction_set_) {
Vladimir Marko33bff252017-11-01 14:35:42 +0000909 case InstructionSet::kArm:
910 case InstructionSet::kThumb2:
911 case InstructionSet::kArm64:
912 case InstructionSet::kX86:
913 case InstructionSet::kX86_64:
914 case InstructionSet::kMips:
915 case InstructionSet::kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000916 compiler_options_->implicit_null_checks_ = true;
917 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800918 break;
919
920 default:
921 // Defaults are correct.
922 break;
923 }
924
Jeff Hao436183f2016-01-12 16:36:50 -0800925 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800926 Usage("--multi-image can only be used when creating boot images");
927 }
Jeff Hao436183f2016-01-12 16:36:50 -0800928 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800929 Usage("--multi-image cannot be used with multiple image names");
930 }
931
932 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
933 if (!kIsTargetBuild && IsBootImage()) {
934 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800935 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800936 }
937 }
938
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800939 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100940 if (parser_options->watch_dog_enabled) {
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800941 int64_t timeout = parser_options->watch_dog_timeout_in_ms > 0
942 ? parser_options->watch_dog_timeout_in_ms
943 : WatchDog::kDefaultWatchdogTimeoutInMS;
944 watchdog_.reset(new WatchDog(timeout));
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800945 }
946
947 // Fill some values into the key-value store for the oat header.
948 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800949
Roland Levillainb81e9e92017-04-20 17:35:32 +0100950 // Automatically force determinism for the boot image in a host build if read barriers
951 // are enabled, or if the default GC is CMS or MS. When the default GC is CMS
952 // (Concurrent Mark-Sweep), the GC is switched to a non-concurrent one by passing the
953 // option `-Xgc:nonconcurrent` (see below).
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800954 if (!kIsTargetBuild && IsBootImage()) {
955 if (SupportsDeterministicCompilation()) {
956 force_determinism_ = true;
957 } else {
958 LOG(WARNING) << "Deterministic compilation is disabled.";
959 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800960 }
961 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700962
963 if (passes_to_run_filename_ != nullptr) {
964 passes_to_run_.reset(ReadCommentedInputFromFile<std::vector<std::string>>(
965 passes_to_run_filename_,
966 nullptr)); // No post-processing.
967 if (passes_to_run_.get() == nullptr) {
968 Usage("Failed to read list of passes to run.");
969 }
970 }
971 compiler_options_->passes_to_run_ = passes_to_run_.get();
Roland Levillain9ec5e222015-08-17 20:18:41 +0100972 }
973
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800974 static bool SupportsDeterministicCompilation() {
Roland Levillainb81e9e92017-04-20 17:35:32 +0100975 return (kUseReadBarrier ||
976 gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
977 gc::kCollectorTypeDefault == gc::kCollectorTypeMS);
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800978 }
979
Jeff Hao436183f2016-01-12 16:36:50 -0800980 void ExpandOatAndImageFilenames() {
981 std::string base_oat = oat_filenames_[0];
982 size_t last_oat_slash = base_oat.rfind('/');
983 if (last_oat_slash == std::string::npos) {
984 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
985 }
986 // We also need to honor path components that were encoded through '@'. Otherwise the loading
987 // code won't be able to find the images.
988 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
989 last_oat_slash = base_oat.rfind('@');
990 }
991 base_oat = base_oat.substr(0, last_oat_slash + 1);
992
993 std::string base_img = image_filenames_[0];
994 size_t last_img_slash = base_img.rfind('/');
995 if (last_img_slash == std::string::npos) {
996 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
997 }
998 // We also need to honor path components that were encoded through '@'. Otherwise the loading
999 // code won't be able to find the images.
1000 if (base_img.find('@', last_img_slash) != std::string::npos) {
1001 last_img_slash = base_img.rfind('@');
1002 }
1003
1004 // Get the prefix, which is the primary image name (without path components). Strip the
1005 // extension.
1006 std::string prefix = base_img.substr(last_img_slash + 1);
1007 if (prefix.rfind('.') != std::string::npos) {
1008 prefix = prefix.substr(0, prefix.rfind('.'));
1009 }
1010 if (!prefix.empty()) {
1011 prefix = prefix + "-";
1012 }
1013
1014 base_img = base_img.substr(0, last_img_slash + 1);
1015
1016 // Note: we have some special case here for our testing. We have to inject the differentiating
1017 // parts for the different core images.
1018 std::string infix; // Empty infix by default.
1019 {
1020 // Check the first name.
1021 std::string dex_file = oat_filenames_[0];
1022 size_t last_dex_slash = dex_file.rfind('/');
1023 if (last_dex_slash != std::string::npos) {
1024 dex_file = dex_file.substr(last_dex_slash + 1);
1025 }
1026 size_t last_dex_dot = dex_file.rfind('.');
1027 if (last_dex_dot != std::string::npos) {
1028 dex_file = dex_file.substr(0, last_dex_dot);
1029 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001030 if (android::base::StartsWith(dex_file, "core-")) {
Jeff Hao436183f2016-01-12 16:36:50 -08001031 infix = dex_file.substr(strlen("core"));
1032 }
1033 }
1034
bowen_lai8bd36c02016-10-12 13:28:55 +08001035 std::string base_symbol_oat;
1036 if (!oat_unstripped_.empty()) {
1037 base_symbol_oat = oat_unstripped_[0];
1038 size_t last_symbol_oat_slash = base_symbol_oat.rfind('/');
1039 if (last_symbol_oat_slash == std::string::npos) {
1040 Usage("--multi-image used with unusable symbol filename %s", base_symbol_oat.c_str());
1041 }
1042 base_symbol_oat = base_symbol_oat.substr(0, last_symbol_oat_slash + 1);
1043 }
1044
Jeff Hao436183f2016-01-12 16:36:50 -08001045 // Now create the other names. Use a counted loop to skip the first one.
1046 for (size_t i = 1; i < dex_locations_.size(); ++i) {
1047 // TODO: Make everything properly std::string.
1048 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
Andreas Gampe097f34c2017-08-23 08:57:51 -07001049 char_backing_storage_.push_front(base_img + image_name);
1050 image_filenames_.push_back(char_backing_storage_.front().c_str());
Jeff Hao436183f2016-01-12 16:36:50 -08001051
1052 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
Andreas Gampe097f34c2017-08-23 08:57:51 -07001053 char_backing_storage_.push_front(base_oat + oat_name);
1054 oat_filenames_.push_back(char_backing_storage_.front().c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001055
1056 if (!base_symbol_oat.empty()) {
Andreas Gampe097f34c2017-08-23 08:57:51 -07001057 char_backing_storage_.push_front(base_symbol_oat + oat_name);
1058 oat_unstripped_.push_back(char_backing_storage_.front().c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001059 }
Jeff Hao436183f2016-01-12 16:36:50 -08001060 }
1061 }
1062
Andreas Gampe8994a042015-12-30 19:03:17 +00001063 // Modify the input string in the following way:
1064 // 0) Assume input is /a/b/c.d
1065 // 1) Strip the path -> c.d
1066 // 2) Inject prefix p -> pc.d
1067 // 3) Inject infix i -> pci.d
1068 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -08001069 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +00001070 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001071 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +00001072 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001073 size_t last_dex_slash = in.rfind('/');
1074 if (last_dex_slash != std::string::npos) {
1075 in = in.substr(last_dex_slash + 1);
1076 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001077 if (!prefix.empty()) {
1078 in = prefix + in;
1079 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001080 if (!infix.empty()) {
1081 // Inject infix.
1082 size_t last_dot = in.rfind('.');
1083 if (last_dot != std::string::npos) {
1084 in.insert(last_dot, infix);
1085 }
1086 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001087 if (android::base::EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001088 in = in.substr(0, in.length() - strlen(".jar")) +
1089 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001090 }
1091 return in;
1092 }
1093
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001094 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001095 std::ostringstream oss;
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001096 if (!avoid_storing_invocation_) {
1097 for (int i = 0; i < argc; ++i) {
1098 if (i > 0) {
1099 oss << ' ';
1100 }
1101 oss << argv[i];
Roland Levillain9ec5e222015-08-17 20:18:41 +01001102 }
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001103 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1104 oss.str(""); // Reset.
Roland Levillain9ec5e222015-08-17 20:18:41 +01001105 }
Roland Levillain9ec5e222015-08-17 20:18:41 +01001106 oss << kRuntimeISA;
1107 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1108 key_value_store_->Put(
1109 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001110 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001111 key_value_store_->Put(
1112 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001113 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001114 key_value_store_->Put(
1115 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001116 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001117 key_value_store_->Put(OatHeader::kCompilerFilter,
1118 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Andreas Gampef8cd8902017-01-18 16:05:01 -08001119 key_value_store_->Put(OatHeader::kConcurrentCopying,
1120 kUseReadBarrier ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001121 }
1122
Andreas Gampe097f34c2017-08-23 08:57:51 -07001123 // This simple forward is here so the string specializations below don't look out of place.
1124 template <typename T, typename U>
1125 void AssignIfExists(Dex2oatArgumentMap& map,
1126 const Dex2oatArgumentMap::Key<T>& key,
1127 U* out) {
1128 map.AssignIfExists(key, out);
1129 }
1130
1131 // Specializations to handle const char* vs std::string.
1132 void AssignIfExists(Dex2oatArgumentMap& map,
1133 const Dex2oatArgumentMap::Key<std::string>& key,
1134 const char** out) {
1135 if (map.Exists(key)) {
1136 char_backing_storage_.push_front(std::move(*map.Get(key)));
1137 *out = char_backing_storage_.front().c_str();
1138 }
1139 }
1140 void AssignIfExists(Dex2oatArgumentMap& map,
1141 const Dex2oatArgumentMap::Key<std::vector<std::string>>& key,
1142 std::vector<const char*>* out) {
1143 if (map.Exists(key)) {
1144 for (auto& val : *map.Get(key)) {
1145 char_backing_storage_.push_front(std::move(val));
1146 out->push_back(char_backing_storage_.front().c_str());
1147 }
1148 }
1149 }
1150
1151 template <typename T>
1152 void AssignTrueIfExists(Dex2oatArgumentMap& map,
1153 const Dex2oatArgumentMap::Key<T>& key,
1154 bool* out) {
1155 if (map.Exists(key)) {
1156 *out = true;
1157 }
1158 }
1159
Roland Levillain9ec5e222015-08-17 20:18:41 +01001160 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1161 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1162 // returns, arguments have been successfully parsed.
1163 void ParseArgs(int argc, char** argv) {
1164 original_argc = argc;
1165 original_argv = argv;
1166
Andreas Gampe51d80cc2017-06-21 21:05:13 -07001167 InitLogging(argv, Runtime::Abort);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001168
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001169 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001170
Andreas Gampe097f34c2017-08-23 08:57:51 -07001171 using M = Dex2oatArgumentMap;
1172 std::string error_msg;
1173 std::unique_ptr<M> args_uptr = M::Parse(argc, const_cast<const char**>(argv), &error_msg);
1174 if (args_uptr == nullptr) {
1175 Usage("Failed to parse command line: %s", error_msg.c_str());
1176 UNREACHABLE();
1177 }
1178
1179 M& args = *args_uptr;
1180
1181 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
1182
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07001183 AssignIfExists(args, M::CompactDexLevel, &compact_dex_level_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001184 AssignIfExists(args, M::DexFiles, &dex_filenames_);
1185 AssignIfExists(args, M::DexLocations, &dex_locations_);
1186 AssignIfExists(args, M::OatFiles, &oat_filenames_);
1187 AssignIfExists(args, M::OatSymbols, &parser_options->oat_symbols);
1188 AssignIfExists(args, M::ImageFilenames, &image_filenames_);
1189 AssignIfExists(args, M::ZipFd, &zip_fd_);
1190 AssignIfExists(args, M::ZipLocation, &zip_location_);
1191 AssignIfExists(args, M::InputVdexFd, &input_vdex_fd_);
1192 AssignIfExists(args, M::OutputVdexFd, &output_vdex_fd_);
1193 AssignIfExists(args, M::InputVdex, &input_vdex_);
1194 AssignIfExists(args, M::OutputVdex, &output_vdex_);
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001195 AssignIfExists(args, M::DmFd, &dm_fd_);
1196 AssignIfExists(args, M::DmFile, &dm_file_location_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001197 AssignIfExists(args, M::OatFd, &oat_fd_);
1198 AssignIfExists(args, M::OatLocation, &oat_location_);
1199 AssignIfExists(args, M::Watchdog, &parser_options->watch_dog_enabled);
1200 AssignIfExists(args, M::WatchdogTimeout, &parser_options->watch_dog_timeout_in_ms);
1201 AssignIfExists(args, M::Threads, &thread_count_);
1202 AssignIfExists(args, M::ImageClasses, &image_classes_filename_);
1203 AssignIfExists(args, M::ImageClassesZip, &image_classes_zip_filename_);
1204 AssignIfExists(args, M::CompiledClasses, &compiled_classes_filename_);
1205 AssignIfExists(args, M::CompiledClassesZip, &compiled_classes_zip_filename_);
1206 AssignIfExists(args, M::CompiledMethods, &compiled_methods_filename_);
1207 AssignIfExists(args, M::CompiledMethodsZip, &compiled_methods_zip_filename_);
1208 AssignIfExists(args, M::Passes, &passes_to_run_filename_);
1209 AssignIfExists(args, M::BootImage, &parser_options->boot_image_filename);
1210 AssignIfExists(args, M::AndroidRoot, &android_root_);
1211 AssignIfExists(args, M::Profile, &profile_file_);
1212 AssignIfExists(args, M::ProfileFd, &profile_file_fd_);
1213 AssignIfExists(args, M::RuntimeOptions, &runtime_args_);
1214 AssignIfExists(args, M::SwapFile, &swap_file_name_);
1215 AssignIfExists(args, M::SwapFileFd, &swap_fd_);
1216 AssignIfExists(args, M::SwapDexSizeThreshold, &min_dex_file_cumulative_size_for_swap_);
1217 AssignIfExists(args, M::SwapDexCountThreshold, &min_dex_files_for_swap_);
1218 AssignIfExists(args, M::VeryLargeAppThreshold, &very_large_threshold_);
1219 AssignIfExists(args, M::AppImageFile, &app_image_file_name_);
1220 AssignIfExists(args, M::AppImageFileFd, &app_image_fd_);
1221 AssignIfExists(args, M::NoInlineFrom, &no_inline_from_string_);
1222 AssignIfExists(args, M::ClasspathDir, &classpath_dir_);
1223 AssignIfExists(args, M::DirtyImageObjects, &dirty_image_objects_filename_);
1224 AssignIfExists(args, M::ImageFormat, &image_storage_mode_);
Calin Juravle0e09dfc2018-02-12 19:01:09 -08001225 AssignIfExists(args, M::CompilationReason, &compilation_reason_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001226
1227 AssignIfExists(args, M::Backend, &compiler_kind_);
1228 parser_options->requested_specific_compiler = args.Exists(M::Backend);
1229
1230 AssignIfExists(args, M::TargetInstructionSet, &instruction_set_);
1231 // arm actually means thumb2.
1232 if (instruction_set_ == InstructionSet::kArm) {
1233 instruction_set_ = InstructionSet::kThumb2;
1234 }
1235
1236 AssignTrueIfExists(args, M::Host, &is_host_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001237 AssignTrueIfExists(args, M::AvoidStoringInvocation, &avoid_storing_invocation_);
1238 AssignTrueIfExists(args, M::MultiImage, &multi_image_);
Mathieu Chartier792111c2018-02-15 13:02:15 -08001239 AssignIfExists(args, M::CopyDexFiles, &copy_dex_files_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001240
1241 if (args.Exists(M::ForceDeterminism)) {
1242 if (!SupportsDeterministicCompilation()) {
1243 Usage("Option --force-determinism requires read barriers or a CMS/MS garbage collector");
Roland Levillain9ec5e222015-08-17 20:18:41 +01001244 }
Andreas Gampe097f34c2017-08-23 08:57:51 -07001245 force_determinism_ = true;
1246 }
1247
1248 if (args.Exists(M::Base)) {
1249 ParseBase(*args.Get(M::Base));
1250 }
1251 if (args.Exists(M::TargetInstructionSetVariant)) {
1252 ParseInstructionSetVariant(*args.Get(M::TargetInstructionSetVariant), parser_options.get());
1253 }
1254 if (args.Exists(M::TargetInstructionSetFeatures)) {
1255 ParseInstructionSetFeatures(*args.Get(M::TargetInstructionSetFeatures), parser_options.get());
1256 }
1257 if (args.Exists(M::ClassLoaderContext)) {
1258 class_loader_context_ = ClassLoaderContext::Create(*args.Get(M::ClassLoaderContext));
1259 if (class_loader_context_ == nullptr) {
1260 Usage("Option --class-loader-context has an incorrect format: %s",
1261 args.Get(M::ClassLoaderContext)->c_str());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001262 }
1263 }
1264
Andreas Gampe097f34c2017-08-23 08:57:51 -07001265 if (!ReadCompilerOptions(args, compiler_options_.get(), &error_msg)) {
1266 Usage(error_msg.c_str());
1267 }
1268
Jeff Hao436183f2016-01-12 16:36:50 -08001269 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001270
1271 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001272 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001273 }
1274
Jeff Haodcdc85b2015-12-04 14:06:18 -08001275 // Check whether the oat output files are writable, and open them for later. Also open a swap
1276 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001277 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001278 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1279 PruneNonExistentDexFiles();
1280
Jeff Hao436183f2016-01-12 16:36:50 -08001281 // Expand oat and image filenames for multi image.
1282 if (IsBootImage() && multi_image_) {
1283 ExpandOatAndImageFilenames();
1284 }
1285
David Brazdil7b49e6c2016-09-01 11:06:18 +01001286 // OAT and VDEX file handling
David Brazdil7b49e6c2016-09-01 11:06:18 +01001287 if (oat_fd_ == -1) {
1288 DCHECK(!oat_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08001289 for (const char* oat_filename : oat_filenames_) {
1290 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
Calin Juravleb09be722017-09-25 16:42:48 -07001291 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001292 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1293 return false;
1294 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001295 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001296 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1297 oat_file->Erase();
1298 return false;
1299 }
1300 oat_files_.push_back(std::move(oat_file));
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001301 DCHECK_EQ(input_vdex_fd_, -1);
1302 if (!input_vdex_.empty()) {
1303 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001304 input_vdex_file_ = VdexFile::Open(input_vdex_,
1305 /* writable */ false,
1306 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001307 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001308 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001309 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001310
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001311 DCHECK_EQ(output_vdex_fd_, -1);
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001312 std::string vdex_filename = output_vdex_.empty()
1313 ? ReplaceFileExtension(oat_filename, "vdex")
1314 : output_vdex_;
1315 if (vdex_filename == input_vdex_ && output_vdex_.empty()) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001316 update_input_vdex_ = true;
1317 std::unique_ptr<File> vdex_file(OS::OpenFileReadWrite(vdex_filename.c_str()));
1318 vdex_files_.push_back(std::move(vdex_file));
1319 } else {
1320 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
Calin Juravleb09be722017-09-25 16:42:48 -07001321 if (vdex_file == nullptr) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001322 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1323 return false;
1324 }
1325 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1326 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1327 vdex_file->Erase();
1328 return false;
1329 }
1330 vdex_files_.push_back(std::move(vdex_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001331 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001332 }
1333 } else {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001334 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, /* check_usage */ true));
Calin Juravleb09be722017-09-25 16:42:48 -07001335 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001336 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1337 return false;
1338 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001339 oat_file->DisableAutoClose();
1340 if (oat_file->SetLength(0) != 0) {
1341 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001342 oat_file->Erase();
1343 return false;
David Brazdil7b49e6c2016-09-01 11:06:18 +01001344 }
1345 oat_files_.push_back(std::move(oat_file));
1346
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001347 if (input_vdex_fd_ != -1) {
1348 struct stat s;
1349 int rc = TEMP_FAILURE_RETRY(fstat(input_vdex_fd_, &s));
1350 if (rc == -1) {
1351 PLOG(WARNING) << "Failed getting length of vdex file";
1352 } else {
1353 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001354 input_vdex_file_ = VdexFile::Open(input_vdex_fd_,
1355 s.st_size,
1356 "vdex",
1357 /* writable */ false,
1358 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001359 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001360 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001361 // If there's any problem with the passed vdex, just warn and proceed
1362 // without it.
1363 if (input_vdex_file_ == nullptr) {
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001364 PLOG(WARNING) << "Failed opening vdex file: " << error_msg;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001365 }
1366 }
1367 }
1368
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001369 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001370 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001371 std::unique_ptr<File> vdex_file(new File(output_vdex_fd_, vdex_location, /* check_usage */ true));
Calin Juravleb09be722017-09-25 16:42:48 -07001372 if (vdex_file == nullptr) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001373 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001374 return false;
1375 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001376 vdex_file->DisableAutoClose();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001377 if (input_vdex_file_ != nullptr && output_vdex_fd_ == input_vdex_fd_) {
1378 update_input_vdex_ = true;
1379 } else {
1380 if (vdex_file->SetLength(0) != 0) {
1381 PLOG(ERROR) << "Truncating vdex file " << vdex_location << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001382 vdex_file->Erase();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001383 return false;
1384 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001385 }
1386 vdex_files_.push_back(std::move(vdex_file));
1387
Jeff Haodcdc85b2015-12-04 14:06:18 -08001388 oat_filenames_.push_back(oat_location_.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001389 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001390
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001391 // If we're updating in place a vdex file, be defensive and put an invalid vdex magic in case
1392 // dex2oat gets killed.
1393 // Note: we're only invalidating the magic data in the file, as dex2oat needs the rest of
1394 // the information to remain valid.
1395 if (update_input_vdex_) {
Vladimir Marko74527972016-11-29 15:57:32 +00001396 std::unique_ptr<linker::BufferedOutputStream> vdex_out =
1397 std::make_unique<linker::BufferedOutputStream>(
1398 std::make_unique<linker::FileOutputStream>(vdex_files_.back().get()));
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001399 if (!vdex_out->WriteFully(&VdexFile::Header::kVdexInvalidMagic,
1400 arraysize(VdexFile::Header::kVdexInvalidMagic))) {
1401 PLOG(ERROR) << "Failed to invalidate vdex header. File: " << vdex_out->GetLocation();
1402 return false;
1403 }
1404
1405 if (!vdex_out->Flush()) {
1406 PLOG(ERROR) << "Failed to flush stream after invalidating header of vdex file."
1407 << " File: " << vdex_out->GetLocation();
1408 return false;
1409 }
1410 }
1411
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001412 if (dm_fd_ != -1 || !dm_file_location_.empty()) {
1413 std::string error_msg;
1414 if (dm_fd_ != -1) {
1415 dm_file_.reset(ZipArchive::OpenFromFd(dm_fd_, "DexMetadata", &error_msg));
1416 } else {
1417 dm_file_.reset(ZipArchive::Open(dm_file_location_.c_str(), &error_msg));
1418 }
1419 if (dm_file_ == nullptr) {
1420 LOG(WARNING) << "Could not open DexMetadata archive " << error_msg;
1421 }
1422 }
1423
1424 if (dm_file_ != nullptr) {
1425 DCHECK(input_vdex_file_ == nullptr);
1426 std::string error_msg;
1427 static const char* kDexMetadata = "DexMetadata";
1428 std::unique_ptr<ZipEntry> zip_entry(dm_file_->Find(VdexFile::kVdexNameInDmFile, &error_msg));
1429 if (zip_entry == nullptr) {
1430 LOG(INFO) << "No " << VdexFile::kVdexNameInDmFile << " file in DexMetadata archive. "
1431 << "Not doing fast verification.";
1432 } else {
Mathieu Chartier792111c2018-02-15 13:02:15 -08001433 std::unique_ptr<MemMap> input_file(zip_entry->MapDirectlyOrExtract(
1434 VdexFile::kVdexNameInDmFile,
1435 kDexMetadata,
1436 &error_msg));
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001437 if (input_file == nullptr) {
1438 LOG(WARNING) << "Could not open vdex file in DexMetadata archive: " << error_msg;
1439 } else {
1440 input_vdex_file_ = std::make_unique<VdexFile>(input_file.release());
1441 }
1442 }
1443 }
1444
David Brazdil7b49e6c2016-09-01 11:06:18 +01001445 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001446 //
1447 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1448 // that we can use for swap.
1449 //
1450 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1451 // will immediately unlink to satisfy the swap fd assumption.
1452 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1453 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1454 if (swap_file.get() == nullptr) {
1455 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1456 return false;
1457 }
1458 swap_fd_ = swap_file->Fd();
1459 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1460 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1461 // released immediately.
1462 unlink(swap_file_name_.c_str());
1463 }
Jeff Hao436183f2016-01-12 16:36:50 -08001464
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001465 return true;
1466 }
1467
David Brazdil7b49e6c2016-09-01 11:06:18 +01001468 void EraseOutputFiles() {
1469 for (auto& files : { &vdex_files_, &oat_files_ }) {
1470 for (size_t i = 0; i < files->size(); ++i) {
1471 if ((*files)[i].get() != nullptr) {
1472 (*files)[i]->Erase();
1473 (*files)[i].reset();
1474 }
1475 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001476 }
Andreas Gampea650e702014-12-03 14:28:02 -08001477 }
1478
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001479 void LoadClassProfileDescriptors() {
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -07001480 if (profile_compilation_info_ != nullptr && IsImage()) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001481 Runtime* runtime = Runtime::Current();
1482 CHECK(runtime != nullptr);
Mathieu Chartier0b490842016-05-25 15:05:59 -07001483 // Filter out class path classes since we don't want to include these in the image.
Mathieu Chartier4f342b02017-07-21 17:12:39 -07001484 image_classes_.reset(
1485 new std::unordered_set<std::string>(
1486 profile_compilation_info_->GetClassDescriptors(dex_files_)));
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001487 VLOG(compiler) << "Loaded " << image_classes_->size()
1488 << " image class descriptors from profile";
1489 if (VLOG_IS_ON(compiler)) {
1490 for (const std::string& s : *image_classes_) {
1491 LOG(INFO) << "Image class " << s;
1492 }
1493 }
1494 }
1495 }
1496
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001497 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1498 // boot class path.
Andreas Gampef7882972017-03-20 16:35:24 -07001499 dex2oat::ReturnCode Setup() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001500 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001501
Jeff Haoc23b0c02017-07-27 18:19:38 -07001502 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods() ||
1503 !PrepareDirtyObjects()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001504 return dex2oat::ReturnCode::kOther;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001505 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001506
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001507 // Verification results are null since we don't know if we will need them yet as the compler
1508 // filter may change.
Andreas Gampe4585f872015-03-27 23:45:15 -07001509 callbacks_.reset(new QuickCompilerCallbacks(
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001510 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001511 CompilerCallbacks::CallbackMode::kCompileBootImage :
1512 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001513
Vladimir Marko49b0f452015-12-10 13:49:19 +00001514 RuntimeArgumentMap runtime_options;
Mathieu Chartier46331a62017-07-21 09:49:10 -07001515 if (!PrepareRuntimeOptions(&runtime_options, callbacks_.get())) {
Andreas Gampef7882972017-03-20 16:35:24 -07001516 return dex2oat::ReturnCode::kOther;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001517 }
1518
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001519 CreateOatWriters();
1520 if (!AddDexFileSources()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001521 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001522 }
1523
Calin Juravle0e09dfc2018-02-12 19:01:09 -08001524 if (!compilation_reason_.empty()) {
1525 key_value_store_->Put(OatHeader::kCompilationReasonKey, compilation_reason_);
1526 }
1527
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001528 if (IsBootImage() && image_filenames_.size() > 1) {
1529 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1530 // We need this for the multi-image case.
Mathieu Chartier866d8742016-09-21 15:24:18 -07001531 key_value_store_->Put(OatHeader::kBootClassPathKey,
1532 gc::space::ImageSpace::GetMultiImageBootClassPath(dex_locations_,
1533 oat_filenames_,
1534 image_filenames_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001535 }
1536
1537 if (!IsBootImage()) {
1538 // When compiling an app, create the runtime early to retrieve
1539 // the image location key needed for the oat header.
1540 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001541 return dex2oat::ReturnCode::kCreateRuntime;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001542 }
1543
Andreas Gampe29d38e72016-03-23 15:31:51 +00001544 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001545 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1546 std::vector<gc::space::ImageSpace*> image_spaces =
1547 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Richard Uhlerbc26b722017-03-10 14:27:10 +00001548 image_file_location_oat_checksum_ = image_spaces[0]->GetImageHeader().GetOatChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001549 image_file_location_oat_data_begin_ =
1550 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1551 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1552 // Store the boot image filename(s).
1553 std::vector<std::string> image_filenames;
1554 for (const gc::space::ImageSpace* image_space : image_spaces) {
1555 image_filenames.push_back(image_space->GetImageFilename());
1556 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001557 std::string image_file_location = android::base::Join(image_filenames, ':');
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001558 if (!image_file_location.empty()) {
1559 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1560 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001561 } else {
1562 image_file_location_oat_checksum_ = 0u;
1563 image_file_location_oat_data_begin_ = 0u;
1564 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001565 }
1566
1567 // Open dex files for class path.
Calin Juravle19915892017-08-03 17:10:36 +00001568
Calin Juravle1ce70852017-06-28 10:59:03 -07001569 if (class_loader_context_ == nullptr) {
Calin Juravle19915892017-08-03 17:10:36 +00001570 // If no context was specified use the default one (which is an empty PathClassLoader).
1571 class_loader_context_ = std::unique_ptr<ClassLoaderContext>(ClassLoaderContext::Default());
Jeff Haof0192c82016-03-28 20:39:50 -07001572 }
Calin Juravle19915892017-08-03 17:10:36 +00001573
Calin Juravle1ce70852017-06-28 10:59:03 -07001574 DCHECK_EQ(oat_writers_.size(), 1u);
1575
1576 // Note: Ideally we would reject context where the source dex files are also
1577 // specified in the classpath (as it doesn't make sense). However this is currently
1578 // needed for non-prebuild tests and benchmarks which expects on the fly compilation.
1579 // Also, for secondary dex files we do not have control on the actual classpath.
1580 // Instead of aborting, remove all the source location from the context classpaths.
1581 if (class_loader_context_->RemoveLocationsFromClassPaths(
1582 oat_writers_[0]->GetSourceLocations())) {
1583 LOG(WARNING) << "The source files to be compiled are also in the classpath.";
1584 }
1585
1586 // We need to open the dex files before encoding the context in the oat file.
1587 // (because the encoding adds the dex checksum...)
1588 // TODO(calin): consider redesigning this so we don't have to open the dex files before
1589 // creating the actual class loader.
1590 if (!class_loader_context_->OpenDexFiles(runtime_->GetInstructionSet(), classpath_dir_)) {
1591 // Do not abort if we couldn't open files from the classpath. They might be
1592 // apks without dex files and right now are opening flow will fail them.
1593 LOG(WARNING) << "Failed to open classpath dex files";
1594 }
1595
1596 // Store the class loader context in the oat header.
1597 key_value_store_->Put(OatHeader::kClassPathKey,
1598 class_loader_context_->EncodeContextForOatFile(classpath_dir_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001599 }
1600
1601 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001602 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001603 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1604 rodata_.reserve(oat_writers_.size());
1605 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1606 rodata_.push_back(elf_writers_[i]->StartRoData());
1607 // Unzip or copy dex files straight to the oat file.
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00001608 std::vector<std::unique_ptr<MemMap>> opened_dex_files_map;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001609 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001610 // No need to verify the dex file for:
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001611 // 1) Dexlayout since it does the verification. It also may not pass the verification since
1612 // we don't update the dex checksum.
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001613 // 2) when we have a vdex file, which means it was already verified.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001614 const bool verify = !DoDexLayoutOptimizations() && (input_vdex_file_ == nullptr);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001615 if (!oat_writers_[i]->WriteAndOpenDexFiles(
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +00001616 vdex_files_[i].get(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01001617 rodata_.back(),
1618 instruction_set_,
1619 instruction_set_features_.get(),
1620 key_value_store_.get(),
Jeff Hao042e8982016-10-19 11:17:11 -07001621 verify,
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001622 update_input_vdex_,
Mathieu Chartier792111c2018-02-15 13:02:15 -08001623 copy_dex_files_,
David Brazdil7b49e6c2016-09-01 11:06:18 +01001624 &opened_dex_files_map,
1625 &opened_dex_files)) {
Andreas Gampef7882972017-03-20 16:35:24 -07001626 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001627 }
1628 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00001629 if (opened_dex_files_map.empty()) {
1630 DCHECK(opened_dex_files.empty());
1631 } else {
1632 for (std::unique_ptr<MemMap>& map : opened_dex_files_map) {
1633 opened_dex_files_maps_.push_back(std::move(map));
1634 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001635 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001636 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001637 opened_dex_files_.push_back(std::move(dex_file));
1638 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001639 }
1640 }
1641 }
1642
1643 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
Andreas Gampe7386da42016-06-08 18:18:47 -07001644
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001645 // If we need to downgrade the compiler-filter for size reasons.
1646 if (!IsBootImage() && IsVeryLarge(dex_files_)) {
Mathieu Chartier8cce65a2017-08-17 00:06:39 -07001647 // Disable app image to make sure dex2oat unloading is enabled.
1648 compiler_options_->DisableAppImage();
1649
Mathieu Chartier72041a02017-07-14 18:23:25 -07001650 // If we need to downgrade the compiler-filter for size reasons, do that early before we read
1651 // it below for creating verification callbacks.
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001652 if (!CompilerFilter::IsAsGoodAs(kLargeAppFilter, compiler_options_->GetCompilerFilter())) {
1653 LOG(INFO) << "Very large app, downgrading to verify.";
1654 // Note: this change won't be reflected in the key-value store, as that had to be
1655 // finalized before loading the dex files. This setup is currently required
1656 // to get the size from the DexFile objects.
1657 // TODO: refactor. b/29790079
1658 compiler_options_->SetCompilerFilter(kLargeAppFilter);
1659 }
1660 }
1661
1662 if (CompilerFilter::IsAnyCompilationEnabled(compiler_options_->GetCompilerFilter())) {
1663 // Only modes with compilation require verification results, do this here instead of when we
1664 // create the compilation callbacks since the compilation mode may have been changed by the
1665 // very large app logic.
1666 // Avoiding setting the verification results saves RAM by not adding the dex files later in
1667 // the function.
1668 verification_results_.reset(new VerificationResults(compiler_options_.get()));
1669 callbacks_->SetVerificationResults(verification_results_.get());
1670 }
1671
Andreas Gampe7386da42016-06-08 18:18:47 -07001672 // We had to postpone the swap decision till now, as this is the point when we actually
1673 // know about the dex files we're going to use.
1674
1675 // Make sure that we didn't create the driver, yet.
1676 CHECK(driver_ == nullptr);
1677 // If we use a swap file, ensure we are above the threshold to make it necessary.
1678 if (swap_fd_ != -1) {
1679 if (!UseSwap(IsBootImage(), dex_files_)) {
1680 close(swap_fd_);
1681 swap_fd_ = -1;
1682 VLOG(compiler) << "Decided to run without swap.";
1683 } else {
1684 LOG(INFO) << "Large app, accepted running with swap.";
1685 }
1686 }
1687 // 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 +00001688 if (IsBootImage()) {
1689 // For boot image, pass opened dex files to the Runtime::Create().
1690 // Note: Runtime acquires ownership of these dex files.
1691 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001692 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001693 return dex2oat::ReturnCode::kOther;
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001694 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001695 }
1696
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001697 // If we're doing the image, override the compiler filter to force full compilation. Must be
1698 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1699 // compilation of class initializers.
1700 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001701 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001702 WellKnownClasses::Init(self->GetJniEnv());
1703
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001704 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001705 constexpr bool kSaveDexInput = false;
1706 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001707 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001708 }
1709 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001710
1711 // Ensure opened dex files are writable for dex-to-dex transformations.
1712 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1713 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1714 PLOG(ERROR) << "Failed to make .dex files writeable.";
Andreas Gampef7882972017-03-20 16:35:24 -07001715 return dex2oat::ReturnCode::kOther;
Vladimir Marko919f5532016-01-20 19:13:01 +00001716 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001717 }
1718
Mathieu Chartier72041a02017-07-14 18:23:25 -07001719 // Verification results are only required for modes that have any compilation. Avoid
1720 // adding the dex files if possible to prevent allocating large arrays.
1721 if (verification_results_ != nullptr) {
1722 for (const auto& dex_file : dex_files_) {
1723 // Pre-register dex files so that we can access verification results without locks during
1724 // compilation and verification.
Mathieu Chartier0733dc82017-07-17 14:05:28 -07001725 verification_results_->AddDexFile(dex_file);
1726 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001727 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001728
Andreas Gampef7882972017-03-20 16:35:24 -07001729 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001730 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001731
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001732 // If we need to keep the oat file open for the image writer.
1733 bool ShouldKeepOatFileOpen() const {
1734 return IsImage() && oat_fd_ != kInvalidFd;
1735 }
1736
Mathieu Chartier72041a02017-07-14 18:23:25 -07001737 // Doesn't return the class loader since it's not meant to be used for image compilation.
1738 void CompileDexFilesIndividually() {
1739 CHECK(!IsImage()) << "Not supported with image";
1740 for (const DexFile* dex_file : dex_files_) {
1741 std::vector<const DexFile*> dex_files(1u, dex_file);
1742 VLOG(compiler) << "Compiling " << dex_file->GetLocation();
1743 jobject class_loader = CompileDexFiles(dex_files);
1744 CHECK(class_loader != nullptr);
1745 ScopedObjectAccess soa(Thread::Current());
1746 // Unload class loader to free RAM.
Ian Rogers55256cb2017-12-21 17:07:11 -08001747 jweak weak_class_loader = soa.Env()->GetVm()->AddWeakGlobalRef(
Mathieu Chartier72041a02017-07-14 18:23:25 -07001748 soa.Self(),
1749 soa.Decode<mirror::ClassLoader>(class_loader));
Ian Rogers55256cb2017-12-21 17:07:11 -08001750 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), class_loader);
Roland Levillainaf290312018-02-27 20:02:17 +00001751 runtime_->GetHeap()->CollectGarbage(/* clear_soft_references */ true);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001752 ObjPtr<mirror::ClassLoader> decoded_weak = soa.Decode<mirror::ClassLoader>(weak_class_loader);
1753 if (decoded_weak != nullptr) {
1754 LOG(FATAL) << "Failed to unload class loader, path from root set: "
1755 << runtime_->GetHeap()->GetVerification()->FirstPathFromRootSet(decoded_weak);
1756 }
1757 VLOG(compiler) << "Unloaded classloader";
1758 }
1759 }
1760
1761 bool ShouldCompileDexFilesIndividually() const {
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001762 // Compile individually if we are:
1763 // 1. not building an image,
1764 // 2. not verifying a vdex file,
1765 // 3. using multidex,
1766 // 4. not doing any AOT compilation.
1767 // This means extract, no-vdex verify, and quicken, will use the individual compilation
1768 // mode (to reduce RAM used by the compiler).
Mathieu Chartier72041a02017-07-14 18:23:25 -07001769 return !IsImage() &&
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001770 !update_input_vdex_ &&
Mathieu Chartier72041a02017-07-14 18:23:25 -07001771 dex_files_.size() > 1 &&
Mathieu Chartier6a2b67b2017-08-08 15:09:29 -07001772 !CompilerFilter::IsAotCompilationEnabled(compiler_options_->GetCompilerFilter());
Mathieu Chartier72041a02017-07-14 18:23:25 -07001773 }
1774
1775 // Set up and create the compiler driver and then invoke it to compile all the dex files.
1776 jobject Compile() {
1777 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1778
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001779 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001780
Vladimir Marko47496c22016-01-27 16:15:08 +00001781 // Find the dex files we should not inline from.
Vladimir Marko47496c22016-01-27 16:15:08 +00001782 std::vector<std::string> no_inline_filters;
1783 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001784
1785 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001786 const std::string core_oj = "core-oj";
1787 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1788 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001789 }
1790
Vladimir Marko47496c22016-01-27 16:15:08 +00001791 if (!no_inline_filters.empty()) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001792 std::vector<const DexFile*> class_path_files;
1793 if (!IsBootImage()) {
1794 // The class loader context is used only for apps.
1795 class_path_files = class_loader_context_->FlattenOpenedDexFiles();
1796 }
1797
Jeff Haodcdc85b2015-12-04 14:06:18 -08001798 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1799 &class_linker->GetBootClassPath(),
1800 &class_path_files,
1801 &dex_files_
1802 };
1803 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001804 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001805 for (const std::string& filter : no_inline_filters) {
1806 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
Calin Juravlea308a322017-07-18 16:51:51 -07001807 // allows tests to specify <test-dexfile>!classes2.dex if needed but if the
Vladimir Marko47496c22016-01-27 16:15:08 +00001808 // base location passes the StartsWith() test, so do all extra locations.
1809 std::string dex_location = dex_file->GetLocation();
1810 if (filter.find('/') == std::string::npos) {
1811 // The filter does not contain the path. Remove the path from dex_location as well.
1812 size_t last_slash = dex_file->GetLocation().rfind('/');
1813 if (last_slash != std::string::npos) {
1814 dex_location = dex_location.substr(last_slash + 1);
1815 }
1816 }
1817
Andreas Gampe9186ced2016-12-12 14:28:21 -08001818 if (android::base::StartsWith(dex_location, filter.c_str())) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001819 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1820 no_inline_from_dex_files_.push_back(dex_file);
1821 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001822 }
1823 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001824 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001825 }
1826 if (!no_inline_from_dex_files_.empty()) {
1827 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001828 }
1829 }
1830
Vladimir Marko307dac92015-10-20 11:20:09 +01001831 driver_.reset(new CompilerDriver(compiler_options_.get(),
1832 verification_results_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001833 compiler_kind_,
1834 instruction_set_,
1835 instruction_set_features_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001836 image_classes_.release(),
1837 compiled_classes_.release(),
Wojciech Staszkiewicz62534792016-08-09 14:30:55 -07001838 compiled_methods_.release(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001839 thread_count_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001840 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001841 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001842 driver_->SetDexFilesForOatFile(dex_files_);
Nicolas Geoffray486dda02017-09-11 14:15:52 +01001843 if (!IsBootImage()) {
1844 driver_->SetClasspathDexFiles(class_loader_context_->FlattenOpenedDexFiles());
1845 }
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001846
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001847 const bool compile_individually = ShouldCompileDexFilesIndividually();
1848 if (compile_individually) {
1849 // Set the compiler driver in the callbacks so that we can avoid re-verification. This not
1850 // only helps performance but also prevents reverifying quickened bytecodes. Attempting
1851 // verify quickened bytecode causes verification failures.
1852 // Only set the compiler filter if we are doing separate compilation since there is a bit
1853 // of overhead when checking if a class was previously verified.
1854 callbacks_->SetDoesClassUnloading(true, driver_.get());
1855 }
1856
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001857 // Setup vdex for compilation.
1858 if (!DoEagerUnquickeningOfVdex() && input_vdex_file_ != nullptr) {
1859 callbacks_->SetVerifierDeps(
1860 new verifier::VerifierDeps(dex_files_, input_vdex_file_->GetVerifierDepsData()));
1861
1862 // TODO: we unquicken unconditionally, as we don't know
1863 // if the boot image has changed. How exactly we'll know is under
1864 // experimentation.
1865 TimingLogger::ScopedTiming time_unquicken("Unquicken", timings_);
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +03001866
1867 // We do not decompile a RETURN_VOID_NO_BARRIER into a RETURN_VOID, as the quickening
1868 // optimization does not depend on the boot image (the optimization relies on not
1869 // having final fields in a class, which does not change for an app).
Mathieu Chartier210531f2018-01-12 10:15:51 -08001870 input_vdex_file_->Unquicken(dex_files_, /* decompile_return_instruction */ false);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001871 } else {
1872 // Create the main VerifierDeps, here instead of in the compiler since we want to aggregate
1873 // the results for all the dex files, not just the results for the current dex file.
1874 callbacks_->SetVerifierDeps(new verifier::VerifierDeps(dex_files_));
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001875 }
Mathieu Chartier72041a02017-07-14 18:23:25 -07001876 // Invoke the compilation.
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001877 if (compile_individually) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001878 CompileDexFilesIndividually();
1879 // Return a null classloader since we already freed released it.
1880 return nullptr;
1881 }
1882 return CompileDexFiles(dex_files_);
1883 }
1884
1885 // Create the class loader, use it to compile, and return.
1886 jobject CompileDexFiles(const std::vector<const DexFile*>& dex_files) {
1887 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1888
1889 jobject class_loader = nullptr;
1890 if (!IsBootImage()) {
1891 class_loader = class_loader_context_->CreateClassLoader(dex_files_);
Andreas Gampee9934582018-01-19 21:23:04 -08001892 callbacks_->SetDexFiles(&dex_files);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001893 }
1894
1895 // Register dex caches and key them to the class loader so that they only unload when the
1896 // class loader unloads.
1897 for (const auto& dex_file : dex_files) {
1898 ScopedObjectAccess soa(Thread::Current());
1899 // Registering the dex cache adds a strong root in the class loader that prevents the dex
1900 // cache from being unloaded early.
1901 ObjPtr<mirror::DexCache> dex_cache = class_linker->RegisterDexFile(
1902 *dex_file,
1903 soa.Decode<mirror::ClassLoader>(class_loader));
1904 if (dex_cache == nullptr) {
1905 soa.Self()->AssertPendingException();
1906 LOG(FATAL) << "Failed to register dex file " << dex_file->GetLocation() << " "
1907 << soa.Self()->GetException()->Dump();
1908 }
1909 }
1910 driver_->CompileAll(class_loader, dex_files, timings_);
1911 return class_loader;
Vladimir Markof4da6752014-08-01 19:04:18 +01001912 }
1913
Jeff Hao436183f2016-01-12 16:36:50 -08001914 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001915 // ensure the references between the two are correct.
1916 //
1917 // Currently we have a memory layout that looks something like this:
1918 //
1919 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001920 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001921 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001922 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001923 // +--------------+
1924 // | alloc spaces |
1925 // +--------------+
1926 //
Jeff Hao436183f2016-01-12 16:36:50 -08001927 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001928 //
Jeff Hao436183f2016-01-12 16:36:50 -08001929 // 1. The images are expected to be loaded at an absolute address and
1930 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001931 //
Jeff Hao436183f2016-01-12 16:36:50 -08001932 // 2. There are absolute pointers from Methods in the images to their
1933 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001934 //
Jeff Hao436183f2016-01-12 16:36:50 -08001935 // 3. There are absolute pointers from the code in the oat files to Methods
1936 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001937 //
Jeff Hao436183f2016-01-12 16:36:50 -08001938 // 4. There are absolute pointers from code in the oat files to other code
1939 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001940 //
1941 // To get this all correct, we go through several steps.
1942 //
Jeff Hao436183f2016-01-12 16:36:50 -08001943 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001944 // the oat data size and code size. During this stage, we also set
1945 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001946 //
Jeff Hao436183f2016-01-12 16:36:50 -08001947 // 2. We prepare offsets for the objects in the images and calculate
1948 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001949 //
Jeff Hao436183f2016-01-12 16:36:50 -08001950 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001951 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001952 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001953 // can prepare the ELF headers and we then know the ELF memory segment
1954 // layout and we can now resolve all references. The compiler provides
1955 // LinkerPatch information in each CompiledMethod and we resolve these,
1956 // using the layout information and image object locations provided by
1957 // image writer, as we're writing the method code.
1958 //
Jeff Hao436183f2016-01-12 16:36:50 -08001959 // 4. We create the image files. They need to know where the oat files
1960 // will be loaded after itself. Originally oat files were simply
1961 // memory mapped so we could predict where their contents were based
1962 // on the file size. Now that they are ELF files, we need to inspect
1963 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001964 // where the oat header is located within.
1965 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001966 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001967 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001968 // load the .so at the desired location at runtime by offsetting the
1969 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001970 // TODO: Do this in step 3. We already know the layout there.
1971 //
1972 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1973 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001974
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001975 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1976 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001977 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1978 // case (when the file will be explicitly erased).
David Brazdil7b49e6c2016-09-01 11:06:18 +01001979 bool WriteOutputFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001980 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1981
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001982 // Sync the data to the file, in case we did dex2dex transformations.
1983 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1984 if (!map->Sync()) {
1985 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1986 return false;
1987 }
1988 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001989
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001990 if (IsImage()) {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001991 if (IsAppImage() && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001992 gc::Heap* const heap = Runtime::Current()->GetHeap();
1993 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001994 image_base_ = std::max(image_base_, RoundUp(
1995 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1996 kPageSize));
1997 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001998 // The non moving space is right after the oat file. Put the preferred app image location
1999 // right after the non moving space so that we ideally get a continuous immune region for
2000 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002001 // Use the default non moving space capacity since dex2oat does not have a separate non-
2002 // moving space. This means the runtime's non moving space space size will be as large
2003 // as the growth limit for dex2oat, but smaller in the zygote.
2004 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002005 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002006 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
2007 }
2008
Vladimir Marko74527972016-11-29 15:57:32 +00002009 image_writer_.reset(new linker::ImageWriter(*driver_,
2010 image_base_,
2011 compiler_options_->GetCompilePic(),
2012 IsAppImage(),
2013 image_storage_mode_,
2014 oat_filenames_,
2015 dex_file_oat_index_map_,
2016 dirty_image_objects_.get()));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002017
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002018 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002019 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
2020 if (!image_writer_->PrepareImageAddressSpace()) {
2021 LOG(ERROR) << "Failed to prepare image address space.";
2022 return false;
2023 }
2024 }
2025
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002026 // Initialize the writers with the compiler driver, image writer, and their
2027 // dex files. The writers were created without those being there yet.
2028 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00002029 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002030 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
2031 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
2032 }
2033
David Brazdil5d5a36b2016-09-14 15:34:10 +01002034 {
2035 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
2036 DCHECK(IsBootImage() || oat_files_.size() == 1u);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00002037 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
David Brazdil5d5a36b2016-09-14 15:34:10 +01002038 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
2039 File* vdex_file = vdex_files_[i].get();
Vladimir Marko74527972016-11-29 15:57:32 +00002040 std::unique_ptr<linker::BufferedOutputStream> vdex_out =
2041 std::make_unique<linker::BufferedOutputStream>(
2042 std::make_unique<linker::FileOutputStream>(vdex_file));
David Brazdil5d5a36b2016-09-14 15:34:10 +01002043
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00002044 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002045 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
2046 return false;
2047 }
2048
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002049 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
2050 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
2051 return false;
2052 }
2053
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +00002054 // VDEX finalized, seek back to the beginning and write checksums and the header.
2055 if (!oat_writers_[i]->WriteChecksumsAndVdexHeader(vdex_out.get())) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002056 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
2057 return false;
2058 }
2059 }
2060 }
2061
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002062 {
2063 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002064 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002065 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00002066 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2067 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko944da602016-02-19 12:27:55 +00002068
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002069 oat_writer->PrepareLayout(&patcher);
Vladimir Marko944da602016-02-19 12:27:55 +00002070
2071 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
David Brazdil7b49e6c2016-09-01 11:06:18 +01002072 size_t text_size = oat_writer->GetOatSize() - rodata_size;
Vladimir Markoaad75c62016-10-03 08:46:48 +00002073 elf_writer->PrepareDynamicSection(rodata_size,
2074 text_size,
2075 oat_writer->GetBssSize(),
Vladimir Marko0eb882b2017-05-15 13:39:18 +01002076 oat_writer->GetBssMethodsOffset(),
David Srbeckyec2cdf42017-12-08 16:21:25 +00002077 oat_writer->GetBssRootsOffset(),
2078 oat_writer->GetVdexSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002079 if (IsImage()) {
2080 // Update oat layout.
2081 DCHECK(image_writer_ != nullptr);
2082 DCHECK_LT(i, oat_filenames_.size());
2083 image_writer_->UpdateOatFileLayout(i,
2084 elf_writer->GetLoadedSize(),
2085 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01002086 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002087 }
Richard Uhlerbc26b722017-03-10 14:27:10 +00002088
2089 if (IsBootImage()) {
2090 // Have the image_file_location_oat_checksum_ for boot oat files
2091 // depend on the contents of all the boot oat files. This way only
2092 // the primary image checksum needs to be checked to determine
2093 // whether any of the images are out of date.
2094 image_file_location_oat_checksum_ ^= oat_writer->GetOatHeader().GetChecksum();
2095 }
Vladimir Marko944da602016-02-19 12:27:55 +00002096 }
2097
2098 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002099 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko74527972016-11-29 15:57:32 +00002100 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2101 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00002102
David Srbecky0c4572e2016-01-22 19:19:25 +00002103 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00002104 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
David Srbecky32210b92017-12-04 14:39:21 +00002105 debug::DebugInfo debug_info = oat_writer->GetDebugInfo(); // Keep the variable alive.
2106 elf_writer->PrepareDebugInfo(debug_info); // Processes the data on background thread.
David Srbecky0c4572e2016-01-22 19:19:25 +00002107
Vladimir Marko74527972016-11-29 15:57:32 +00002108 linker::OutputStream*& rodata = rodata_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002109 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002110 if (!oat_writer->WriteRodata(rodata)) {
2111 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
2112 return false;
2113 }
2114 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002115 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00002116
Vladimir Marko74527972016-11-29 15:57:32 +00002117 linker::OutputStream* text = elf_writer->StartText();
Jeff Haodcdc85b2015-12-04 14:06:18 -08002118 if (!oat_writer->WriteCode(text)) {
2119 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
2120 return false;
2121 }
2122 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00002123
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002124 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
2125 image_file_location_oat_checksum_,
2126 image_file_location_oat_data_begin_,
2127 image_patch_delta_)) {
2128 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
2129 return false;
2130 }
2131
Vladimir Marko944da602016-02-19 12:27:55 +00002132 if (IsImage()) {
2133 // Update oat header information.
2134 DCHECK(image_writer_ != nullptr);
2135 DCHECK_LT(i, oat_filenames_.size());
2136 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
2137 }
2138
Jeff Haodcdc85b2015-12-04 14:06:18 -08002139 elf_writer->WriteDynamicSection();
David Srbecky32210b92017-12-04 14:39:21 +00002140 elf_writer->WriteDebugInfo(oat_writer->GetDebugInfo());
Vladimir Marko10c13562015-11-25 14:33:36 +00002141
Jeff Haodcdc85b2015-12-04 14:06:18 -08002142 if (!elf_writer->End()) {
2143 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
2144 return false;
2145 }
2146
David Brazdil7b49e6c2016-09-01 11:06:18 +01002147 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
2148 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002149 }
2150
Jeff Haodcdc85b2015-12-04 14:06:18 -08002151 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002152
2153 oat_writer.reset();
2154 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002155 }
2156 }
2157
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002158 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002159 }
2160
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002161 // If we are compiling an image, invoke the image creation routine. Else just skip.
2162 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002163 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002164 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
2165 if (!CreateImageFile()) {
2166 return false;
2167 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002168 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07002169 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002170 return true;
2171 }
2172
Jeff Haodcdc85b2015-12-04 14:06:18 -08002173 // Create a copy from stripped to unstripped.
2174 bool CopyStrippedToUnstripped() {
2175 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
2176 // If we don't want to strip in place, copy from stripped location to unstripped location.
2177 // We need to strip after image creation because FixupElf needs to use .strtab.
2178 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
2179 // If the oat file is still open, flush it.
2180 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002181 if (!FlushCloseOutputFile(&oat_files_[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002182 return false;
2183 }
2184 }
2185
2186 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
2187 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
2188 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01002189 int64_t in_length = in->GetLength();
2190 if (in_length < 0) {
2191 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
2192 return false;
2193 }
2194 if (!out->Copy(in.get(), 0, in_length)) {
2195 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
2196 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002197 }
2198 if (out->FlushCloseOrErase() != 0) {
2199 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
2200 return false;
2201 }
2202 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
2203 }
2204 }
2205 return true;
2206 }
2207
David Brazdil7b49e6c2016-09-01 11:06:18 +01002208 bool FlushOutputFile(std::unique_ptr<File>* file) {
2209 if (file->get() != nullptr) {
2210 if (file->get()->Flush() != 0) {
2211 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
2212 return false;
2213 }
2214 }
2215 return true;
2216 }
2217
2218 bool FlushCloseOutputFile(std::unique_ptr<File>* file) {
2219 if (file->get() != nullptr) {
2220 std::unique_ptr<File> tmp(file->release());
2221 if (tmp->FlushCloseOrErase() != 0) {
2222 PLOG(ERROR) << "Failed to flush and close output file: " << tmp->GetPath();
2223 return false;
2224 }
2225 }
2226 return true;
2227 }
2228
2229 bool FlushOutputFiles() {
2230 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
2231 for (auto& files : { &vdex_files_, &oat_files_ }) {
2232 for (size_t i = 0; i < files->size(); ++i) {
2233 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002234 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08002235 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002236 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00002237 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002238 return true;
2239 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002240
David Brazdil7b49e6c2016-09-01 11:06:18 +01002241 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002242 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002243 for (auto& files : { &vdex_files_, &oat_files_ }) {
2244 for (size_t i = 0; i < files->size(); ++i) {
2245 result &= FlushCloseOutputFile(&(*files)[i]);
2246 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002247 }
2248 return result;
2249 }
2250
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002251 void DumpTiming() {
Nicolas Geoffray2d8801f2017-11-28 15:50:07 +00002252 if (compiler_options_->GetDumpTimings() ||
2253 (kIsDebugBuild && timings_->GetTotalNs() > MsToNs(1000))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002254 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2255 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002256 }
2257
Andreas Gampe10e477d2014-11-19 12:57:42 -08002258 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002259 return IsAppImage() || IsBootImage();
2260 }
2261
2262 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002263 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002264 }
2265
2266 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002267 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002268 }
2269
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002270 bool IsHost() const {
2271 return is_host_;
2272 }
2273
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002274 bool UseProfile() const {
Mathieu Chartierd0af56c2017-02-17 12:56:25 -08002275 return profile_file_fd_ != -1 || !profile_file_.empty();
Calin Juravle998c2162015-12-21 15:39:33 +02002276 }
2277
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002278 bool DoProfileGuidedOptimizations() const {
Nicolas Geoffray49cda062017-04-21 13:08:25 +01002279 return UseProfile();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002280 }
2281
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002282 bool DoGenerateCompactDex() const {
2283 return compact_dex_level_ != CompactDexLevel::kCompactDexLevelNone;
2284 }
2285
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002286 bool DoDexLayoutOptimizations() const {
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002287 return DoProfileGuidedOptimizations() || DoGenerateCompactDex();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002288 }
2289
Igor Murashkin545412b2017-08-17 15:26:54 -07002290 bool DoOatLayoutOptimizations() const {
2291 return DoProfileGuidedOptimizations();
2292 }
2293
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002294 bool MayInvalidateVdexMetadata() const {
2295 // DexLayout can invalidate the vdex metadata if changing the class def order is enabled, so
2296 // we need to unquicken the vdex file eagerly, before passing it to dexlayout.
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01002297 return DoDexLayoutOptimizations();
2298 }
2299
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002300 bool DoEagerUnquickeningOfVdex() const {
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00002301 return MayInvalidateVdexMetadata() && dm_file_ == nullptr;
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002302 }
2303
Calin Juravle2e2db782016-02-23 12:00:03 +00002304 bool LoadProfile() {
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002305 DCHECK(UseProfile());
Calin Juravlee6f87cc2017-05-24 17:41:05 -07002306 // TODO(calin): We should be using the runtime arena pool (instead of the
2307 // default profile arena). However the setup logic is messy and needs
2308 // cleaning up before that (e.g. the oat writers are created before the
2309 // runtime).
Calin Juravle2e2db782016-02-23 12:00:03 +00002310 profile_compilation_info_.reset(new ProfileCompilationInfo());
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002311 ScopedFlock profile_file;
Calin Juravle2e2db782016-02-23 12:00:03 +00002312 std::string error;
2313 if (profile_file_fd_ != -1) {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002314 profile_file = LockedFile::DupOf(profile_file_fd_, "profile",
2315 true /* read_only_mode */, &error);
Andreas Gampe29d38e72016-03-23 15:31:51 +00002316 } else if (profile_file_ != "") {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002317 profile_file = LockedFile::Open(profile_file_.c_str(), O_RDONLY, true, &error);
Calin Juravle998c2162015-12-21 15:39:33 +02002318 }
Calin Juravle877fd962016-01-05 14:29:29 +00002319
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002320 // Return early if we're unable to obtain a lock on the profile.
2321 if (profile_file.get() == nullptr) {
2322 LOG(ERROR) << "Cannot lock profiles: " << error;
2323 return false;
2324 }
2325
2326 if (!profile_compilation_info_->Load(profile_file->Fd())) {
Calin Juravle2e2db782016-02-23 12:00:03 +00002327 profile_compilation_info_.reset(nullptr);
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002328 return false;
Calin Juravle2e2db782016-02-23 12:00:03 +00002329 }
Calin Juravle877fd962016-01-05 14:29:29 +00002330
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002331 return true;
Calin Juravle998c2162015-12-21 15:39:33 +02002332 }
2333
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002334 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002335 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2336 if (is_image) {
2337 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2338 return false;
2339 }
2340 if (dex_files.size() < min_dex_files_for_swap_) {
2341 // If there are less dex files than the threshold, assume it's gonna be fine.
2342 return false;
2343 }
2344 size_t dex_files_size = 0;
2345 for (const auto* dex_file : dex_files) {
2346 dex_files_size += dex_file->GetHeader().file_size_;
2347 }
2348 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2349 }
2350
Andreas Gampe67f02822016-06-24 21:05:23 -07002351 bool IsVeryLarge(std::vector<const DexFile*>& dex_files) {
2352 size_t dex_files_size = 0;
2353 for (const auto* dex_file : dex_files) {
2354 dex_files_size += dex_file->GetHeader().file_size_;
2355 }
2356 return dex_files_size >= very_large_threshold_;
2357 }
2358
Vladimir Marko49b0f452015-12-10 13:49:19 +00002359 bool PrepareImageClasses() {
2360 // If --image-classes was specified, calculate the full list of classes to include in the image.
2361 if (image_classes_filename_ != nullptr) {
2362 image_classes_ =
2363 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2364 if (image_classes_ == nullptr) {
2365 return false;
2366 }
2367 } else if (IsBootImage()) {
2368 image_classes_.reset(new std::unordered_set<std::string>);
2369 }
2370 return true;
2371 }
2372
2373 bool PrepareCompiledClasses() {
2374 // If --compiled-classes was specified, calculate the full list of classes to compile in the
2375 // image.
2376 if (compiled_classes_filename_ != nullptr) {
2377 compiled_classes_ =
2378 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
2379 if (compiled_classes_ == nullptr) {
2380 return false;
2381 }
2382 } else {
2383 compiled_classes_.reset(nullptr); // By default compile everything.
2384 }
2385 return true;
2386 }
2387
2388 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2389 const char* classes_filename,
2390 const char* tag) {
2391 std::unique_ptr<std::unordered_set<std::string>> classes;
2392 std::string error_msg;
2393 if (zip_filename != nullptr) {
2394 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2395 } else {
2396 classes.reset(ReadImageClassesFromFile(classes_filename));
2397 }
2398 if (classes == nullptr) {
2399 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2400 << classes_filename << "': " << error_msg;
2401 }
2402 return classes;
2403 }
2404
2405 bool PrepareCompiledMethods() {
2406 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2407 if (compiled_methods_filename_ != nullptr) {
2408 std::string error_msg;
2409 if (compiled_methods_zip_filename_ != nullptr) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002410 compiled_methods_.reset(ReadCommentedInputFromZip<std::unordered_set<std::string>>(
2411 compiled_methods_zip_filename_,
2412 compiled_methods_filename_,
2413 nullptr, // No post-processing.
2414 &error_msg));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002415 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002416 compiled_methods_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2417 compiled_methods_filename_,
2418 nullptr)); // No post-processing.
Vladimir Marko49b0f452015-12-10 13:49:19 +00002419 }
2420 if (compiled_methods_.get() == nullptr) {
2421 LOG(ERROR) << "Failed to create list of compiled methods from '"
2422 << compiled_methods_filename_ << "': " << error_msg;
2423 return false;
2424 }
2425 } else {
2426 compiled_methods_.reset(nullptr); // By default compile everything.
2427 }
2428 return true;
2429 }
2430
Jeff Haoc23b0c02017-07-27 18:19:38 -07002431 bool PrepareDirtyObjects() {
2432 if (dirty_image_objects_filename_ != nullptr) {
2433 dirty_image_objects_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2434 dirty_image_objects_filename_,
2435 nullptr));
2436 if (dirty_image_objects_ == nullptr) {
2437 LOG(ERROR) << "Failed to create list of dirty objects from '"
2438 << dirty_image_objects_filename_ << "'";
2439 return false;
2440 }
2441 } else {
2442 dirty_image_objects_.reset(nullptr);
2443 }
2444 return true;
2445 }
2446
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002447 void PruneNonExistentDexFiles() {
2448 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2449 size_t kept = 0u;
2450 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2451 if (!OS::FileExists(dex_filenames_[i])) {
2452 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2453 } else {
2454 dex_filenames_[kept] = dex_filenames_[i];
2455 dex_locations_[kept] = dex_locations_[i];
2456 ++kept;
2457 }
2458 }
2459 dex_filenames_.resize(kept);
2460 dex_locations_.resize(kept);
2461 }
2462
2463 bool AddDexFileSources() {
2464 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
Nicolas Geoffraybc177272018-01-24 14:55:32 +00002465 if (input_vdex_file_ != nullptr && input_vdex_file_->HasDexSection()) {
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002466 DCHECK_EQ(oat_writers_.size(), 1u);
2467 const std::string& name = zip_location_.empty() ? dex_locations_[0] : zip_location_;
2468 DCHECK(!name.empty());
2469 if (!oat_writers_[0]->AddVdexDexFilesSource(*input_vdex_file_.get(), name.c_str())) {
2470 return false;
2471 }
2472 } else if (zip_fd_ != -1) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002473 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002474 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2475 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002476 return false;
2477 }
2478 } else if (oat_writers_.size() > 1u) {
2479 // Multi-image.
2480 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2481 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2482 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2483 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2484 return false;
2485 }
2486 }
2487 } else {
2488 DCHECK_EQ(oat_writers_.size(), 1u);
2489 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2490 DCHECK_NE(dex_filenames_.size(), 0u);
2491 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2492 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2493 return false;
2494 }
2495 }
2496 }
2497 return true;
2498 }
2499
2500 void CreateOatWriters() {
2501 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2502 elf_writers_.reserve(oat_files_.size());
2503 oat_writers_.reserve(oat_files_.size());
2504 for (const std::unique_ptr<File>& oat_file : oat_files_) {
Vladimir Marko74527972016-11-29 15:57:32 +00002505 elf_writers_.emplace_back(linker::CreateElfWriterQuick(instruction_set_,
2506 instruction_set_features_.get(),
2507 compiler_options_.get(),
2508 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002509 elf_writers_.back()->Start();
Igor Murashkin545412b2017-08-17 15:26:54 -07002510 const bool do_oat_writer_layout = DoDexLayoutOptimizations() || DoOatLayoutOptimizations();
Vladimir Marko74527972016-11-29 15:57:32 +00002511 oat_writers_.emplace_back(new linker::OatWriter(
Igor Murashkin545412b2017-08-17 15:26:54 -07002512 IsBootImage(),
2513 timings_,
Mathieu Chartier603ccab2017-10-20 14:34:28 -07002514 do_oat_writer_layout ? profile_compilation_info_.get() : nullptr,
2515 compact_dex_level_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002516 }
2517 }
2518
Vladimir Marko49b0f452015-12-10 13:49:19 +00002519 void SaveDexInput() {
2520 for (size_t i = 0; i < dex_files_.size(); ++i) {
2521 const DexFile* dex_file = dex_files_[i];
2522 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2523 getpid(), i));
2524 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2525 if (tmp_file.get() == nullptr) {
2526 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2527 << ". Try: adb shell chmod 777 /data/local/tmp";
2528 continue;
2529 }
2530 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2531 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2532 UNUSED(tmp_file->Flush());
2533 UNUSED(tmp_file->Close());
2534 LOG(INFO) << "Wrote input to " << tmp_file_name;
2535 }
2536 }
2537
Mathieu Chartier46331a62017-07-21 09:49:10 -07002538 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options,
2539 QuickCompilerCallbacks* callbacks) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00002540 RuntimeOptions raw_options;
2541 if (boot_image_filename_.empty()) {
2542 std::string boot_class_path = "-Xbootclasspath:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002543 boot_class_path += android::base::Join(dex_filenames_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002544 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2545 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002546 boot_class_path_locations += android::base::Join(dex_locations_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002547 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2548 } else {
2549 std::string boot_image_option = "-Ximage:";
2550 boot_image_option += boot_image_filename_;
2551 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2552 }
2553 for (size_t i = 0; i < runtime_args_.size(); i++) {
2554 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2555 }
2556
Mathieu Chartier46331a62017-07-21 09:49:10 -07002557 raw_options.push_back(std::make_pair("compilercallbacks", callbacks));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002558 raw_options.push_back(
2559 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2560
2561 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2562 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2563 // have been stripped in preopting, anyways).
2564 if (!IsBootImage()) {
2565 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2566 }
Andreas Gampec8e35202017-04-28 15:47:12 -07002567 // Never allow implicit image compilation.
2568 raw_options.push_back(std::make_pair("-Xnoimage-dex2oat", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002569 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2570 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2571 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002572 // Disable Hspace compaction to save heap size virtual space.
2573 // Only need disable Hspace for OOM becasue background collector is equal to
2574 // foreground collector by default for dex2oat.
2575 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002576
Andreas Gampeace0dc12016-01-20 13:33:13 -08002577 if (compiler_options_->IsForceDeterminism()) {
Roland Levillainb81e9e92017-04-20 17:35:32 +01002578 // If we're asked to be deterministic, ensure non-concurrent GC for determinism.
2579 //
2580 // Note that with read barriers, this option is ignored, because Runtime::Init
2581 // overrides the foreground GC to be gc::kCollectorTypeCC when instantiating
2582 // gc::Heap. This is fine, as concurrent GC requests are not honored in dex2oat,
2583 // which uses an unstarted runtime.
Andreas Gampeace0dc12016-01-20 13:33:13 -08002584 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
Roland Levillainb81e9e92017-04-20 17:35:32 +01002585
Nicolas Geoffray7acddd82017-05-03 15:04:55 +01002586 // The default LOS implementation (map) is not deterministic. So disable it.
2587 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=disabled", nullptr));
Andreas Gampeace0dc12016-01-20 13:33:13 -08002588
2589 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2590 // compaction (done above) and ensure that neither foreground nor background collectors
2591 // are concurrent.
Roland Levillainb81e9e92017-04-20 17:35:32 +01002592 //
2593 // Likewise, this option is ignored with read barriers because Runtime::Init
2594 // overrides the background GC to be gc::kCollectorTypeCCBackground, but that's
2595 // fine too, for the same reason (see above).
Andreas Gampeace0dc12016-01-20 13:33:13 -08002596 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2597
2598 // To make identity hashcode deterministic, set a known seed.
2599 mirror::Object::SetHashCodeSeed(987654321U);
2600 }
2601
Vladimir Marko49b0f452015-12-10 13:49:19 +00002602 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2603 LOG(ERROR) << "Failed to parse runtime options";
2604 return false;
2605 }
2606 return true;
2607 }
2608
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002609 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002610 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2611 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002612 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002613 LOG(ERROR) << "Failed to create runtime";
2614 return false;
2615 }
Andreas Gampe49c144d2016-11-14 10:11:16 -08002616
2617 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2618 // "ps -a" don't change to non-descript "main."
2619 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2620
Vladimir Marko307dac92015-10-20 11:20:09 +01002621 runtime_.reset(Runtime::Current());
2622 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe8228cdf2017-05-30 15:03:54 -07002623 for (uint32_t i = 0; i < static_cast<uint32_t>(CalleeSaveType::kLastCalleeSaveType); ++i) {
2624 CalleeSaveType type = CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002625 if (!runtime_->HasCalleeSaveMethod(type)) {
2626 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002627 }
2628 }
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002629
2630 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2631 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002632 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002633
Vladimir Marko307dac92015-10-20 11:20:09 +01002634 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002635
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002636 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2637 // Runtime::Start, give it away now so that we don't starve GC.
2638 Thread* self = Thread::Current();
2639 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002640
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002641 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002642 }
2643
Jeff Haodcdc85b2015-12-04 14:06:18 -08002644 // 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 -08002645 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002646 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002647 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002648 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002649 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002650 image_filenames_.push_back(app_image_file_name_.c_str());
2651 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002652 if (!image_writer_->Write(app_image_fd_,
2653 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002654 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002655 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002656 return false;
2657 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002658
Jeff Haodcdc85b2015-12-04 14:06:18 -08002659 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002660 dchecked_vector<uintptr_t> oat_data_begins;
2661 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2662 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002663 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002664 // Destroy ImageWriter before doing FixupElf.
2665 image_writer_.reset();
2666
Vladimir Marko944da602016-02-19 12:27:55 +00002667 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2668 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002669 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2670 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2671 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2672 if (oat_file.get() == nullptr) {
2673 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2674 return false;
2675 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002676
Vladimir Marko74527972016-11-29 15:57:32 +00002677 if (!linker::ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002678 oat_file->Erase();
2679 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2680 return false;
2681 }
2682
2683 if (oat_file->FlushCloseOrErase()) {
2684 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2685 return false;
2686 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002687 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002688 }
2689
2690 return true;
2691 }
2692
2693 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002694 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2695 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002696 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002697 return ReadCommentedInputFromFile<std::unordered_set<std::string>>(image_classes_filename,
2698 &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002699 }
2700
2701 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002702 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002703 const char* zip_filename,
2704 const char* image_classes_filename,
2705 std::string* error_msg) {
2706 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002707 return ReadCommentedInputFromZip<std::unordered_set<std::string>>(zip_filename,
2708 image_classes_filename,
2709 &process,
2710 error_msg);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002711 }
2712
2713 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2714 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002715 template <typename T>
2716 static T* ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002717 const char* input_filename, std::function<std::string(const char*)>* process) {
2718 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2719 if (input_file.get() == nullptr) {
2720 LOG(ERROR) << "Failed to open input file " << input_filename;
2721 return nullptr;
2722 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002723 std::unique_ptr<T> result(
2724 ReadCommentedInputStream<T>(*input_file, process));
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002725 input_file->close();
2726 return result.release();
2727 }
2728
2729 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2730 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002731 template <typename T>
2732 static T* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002733 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002734 const char* input_filename,
2735 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002736 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002737 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2738 if (zip_archive.get() == nullptr) {
2739 return nullptr;
2740 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002741 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002742 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002743 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002744 zip_filename, error_msg->c_str());
2745 return nullptr;
2746 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002747 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2748 input_filename,
2749 error_msg));
2750 if (input_file.get() == nullptr) {
2751 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002752 zip_filename, error_msg->c_str());
2753 return nullptr;
2754 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002755 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2756 input_file->Size());
2757 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002758 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002759 }
2760
2761 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2762 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002763 template <typename T>
2764 static T* ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002765 std::istream& in_stream,
2766 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002767 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002768 while (in_stream.good()) {
2769 std::string dot;
2770 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08002771 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002772 continue;
2773 }
2774 if (process != nullptr) {
2775 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002776 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002777 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002778 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002779 }
2780 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002781 return output.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002782 }
2783
Mathieu Chartier49285c52014-12-02 15:43:48 -08002784 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002785 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2786 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002787 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampec560fc02014-07-16 09:57:39 -07002788 LOG(INFO) << "dex2oat took "
2789 << PrettyDuration(NanoTime() - start_ns_)
Andreas Gampecc967752016-12-12 13:49:00 -08002790 << " (" << PrettyDuration(ProcessCpuNanoTime() - start_cputime_ns_) << " cpu)"
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002791 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002792 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002793 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2794 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002795 }
2796
Jeff Haodcdc85b2015-12-04 14:06:18 -08002797 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2798 std::string res(image_filename);
2799 size_t last_slash = res.rfind('/');
2800 if (last_slash == std::string::npos || last_slash == 0) {
2801 return res;
2802 }
2803 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2804 if (penultimate_slash == std::string::npos) {
2805 return res;
2806 }
2807 // Check that the string in-between is the expected one.
2808 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2809 GetInstructionSetString(isa)) {
2810 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2811 return res;
2812 }
2813 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2814 }
2815
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002816 std::unique_ptr<CompilerOptions> compiler_options_;
2817 Compiler::Kind compiler_kind_;
2818
2819 InstructionSet instruction_set_;
2820 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2821
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002822 uint32_t image_file_location_oat_checksum_;
2823 uintptr_t image_file_location_oat_data_begin_;
2824 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002825 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2826
Vladimir Marko307dac92015-10-20 11:20:09 +01002827 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002828
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002829 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2830
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002831 std::unique_ptr<Runtime> runtime_;
2832
Calin Juravle1ce70852017-06-28 10:59:03 -07002833 // The spec describing how the class loader should be setup for compilation.
2834 std::unique_ptr<ClassLoaderContext> class_loader_context_;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002835
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002836 size_t thread_count_;
2837 uint64_t start_ns_;
Andreas Gampec560fc02014-07-16 09:57:39 -07002838 uint64_t start_cputime_ns_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002839 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002840 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002841 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002842 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002843 std::vector<const char*> oat_filenames_;
2844 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002845 int oat_fd_;
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00002846 int input_vdex_fd_;
2847 int output_vdex_fd_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002848 std::string input_vdex_;
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01002849 std::string output_vdex_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002850 std::unique_ptr<VdexFile> input_vdex_file_;
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00002851 int dm_fd_;
2852 std::string dm_file_location_;
2853 std::unique_ptr<ZipArchive> dm_file_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002854 std::vector<const char*> dex_filenames_;
2855 std::vector<const char*> dex_locations_;
2856 int zip_fd_;
2857 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002858 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002859 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002860 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002861 uintptr_t image_base_;
2862 const char* image_classes_zip_filename_;
2863 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002864 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002865 const char* compiled_classes_zip_filename_;
2866 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002867 const char* compiled_methods_zip_filename_;
2868 const char* compiled_methods_filename_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002869 const char* passes_to_run_filename_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002870 const char* dirty_image_objects_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002871 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2872 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002873 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002874 std::unique_ptr<std::unordered_set<std::string>> dirty_image_objects_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002875 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Jeff Hao436183f2016-01-12 16:36:50 -08002876 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002877 bool is_host_;
2878 std::string android_root_;
Mathieu Chartier0b490842016-05-25 15:05:59 -07002879 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002880 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002881 std::string no_inline_from_string_;
Mathieu Chartiera7f6b812017-12-11 13:34:29 -08002882 CompactDexLevel compact_dex_level_ = kDefaultCompactDexLevel;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002883
Vladimir Marko74527972016-11-29 15:57:32 +00002884 std::vector<std::unique_ptr<linker::ElfWriter>> elf_writers_;
2885 std::vector<std::unique_ptr<linker::OatWriter>> oat_writers_;
2886 std::vector<linker::OutputStream*> rodata_;
2887 std::vector<std::unique_ptr<linker::OutputStream>> vdex_out_;
2888 std::unique_ptr<linker::ImageWriter> image_writer_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002889 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002890
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002891 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
2892 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2893
Calin Juravle1ce70852017-06-28 10:59:03 -07002894 // Note that this might contain pointers owned by class_loader_context_.
Vladimir Marko47496c22016-01-27 16:15:08 +00002895 std::vector<const DexFile*> no_inline_from_dex_files_;
2896
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07002897 bool avoid_storing_invocation_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002898 std::string swap_file_name_;
2899 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002900 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2901 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002902 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002903 std::string app_image_file_name_;
2904 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002905 std::string profile_file_;
2906 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002907 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002908 TimingLogger* timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002909 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002910 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002911
2912 // Backing storage.
Andreas Gampe097f34c2017-08-23 08:57:51 -07002913 std::forward_list<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002914
Andreas Gampeace0dc12016-01-20 13:33:13 -08002915 // See CompilerOptions.force_determinism_.
2916 bool force_determinism_;
2917
Jeff Hao16d48432017-04-05 17:05:46 -07002918 // Directory of relative classpaths.
2919 std::string classpath_dir_;
2920
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00002921 // Whether the given input vdex is also the output.
2922 bool update_input_vdex_ = false;
2923
Nicolas Geoffray66ff8a82018-02-28 13:27:55 +00002924 // By default, copy the dex to the vdex file only if dex files are
2925 // compressed in APK.
2926 CopyOption copy_dex_files_ = CopyOption::kOnlyIfCompressed;
Mathieu Chartier792111c2018-02-15 13:02:15 -08002927
Calin Juravle0e09dfc2018-02-12 19:01:09 -08002928 // The reason for invoking the compiler.
2929 std::string compilation_reason_;
2930
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002931 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2932};
2933
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002934static void b13564922() {
2935#if defined(__linux__) && defined(__arm__)
2936 int major, minor;
2937 struct utsname uts;
2938 if (uname(&uts) != -1 &&
2939 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2940 ((major < 3) || ((major == 3) && (minor < 4)))) {
2941 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2942 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2943 int old_personality = personality(0xffffffff);
2944 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2945 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2946 if (new_personality == -1) {
2947 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2948 }
2949 }
2950 }
2951#endif
2952}
2953
Mathieu Chartier72041a02017-07-14 18:23:25 -07002954class ScopedGlobalRef {
2955 public:
2956 explicit ScopedGlobalRef(jobject obj) : obj_(obj) {}
2957 ~ScopedGlobalRef() {
2958 if (obj_ != nullptr) {
2959 ScopedObjectAccess soa(Thread::Current());
Ian Rogers55256cb2017-12-21 17:07:11 -08002960 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), obj_);
Mathieu Chartier72041a02017-07-14 18:23:25 -07002961 }
2962 }
2963
2964 private:
2965 jobject obj_;
2966};
2967
Andreas Gampe7b565912017-03-20 15:48:52 -07002968static dex2oat::ReturnCode CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002969 dex2oat.LoadClassProfileDescriptors();
Mathieu Chartier9e050df2017-08-09 10:05:47 -07002970 // Keep the class loader that was used for compilation live for the rest of the compilation
2971 // process.
Mathieu Chartier72041a02017-07-14 18:23:25 -07002972 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08002973
David Brazdil7b49e6c2016-09-01 11:06:18 +01002974 if (!dex2oat.WriteOutputFiles()) {
2975 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002976 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002977 }
2978
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002979 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2980 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2981 // image writer will require this fd to generate the image.
2982 if (dex2oat.ShouldKeepOatFileOpen()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002983 if (!dex2oat.FlushOutputFiles()) {
2984 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002985 return dex2oat::ReturnCode::kOther;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002986 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01002987 } else if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002988 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002989 }
2990
Jeff Haodcdc85b2015-12-04 14:06:18 -08002991 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002992 if (!dex2oat.HandleImage()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002993 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002994 }
2995
2996 // When given --host, finish early without stripping.
2997 if (dex2oat.IsHost()) {
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002998 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002999 return dex2oat::ReturnCode::kOther;
Mathieu Chartier00bf2602017-03-02 10:14:08 -08003000 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08003001 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003002 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003003 }
3004
Jeff Haodcdc85b2015-12-04 14:06:18 -08003005 // Copy stripped to unstripped location, if necessary.
3006 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003007 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003008 }
3009
Jeff Haodcdc85b2015-12-04 14:06:18 -08003010 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01003011 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003012 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003013 }
3014
3015 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003016 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003017}
3018
Andreas Gampe7b565912017-03-20 15:48:52 -07003019static dex2oat::ReturnCode CompileApp(Dex2Oat& dex2oat) {
Mathieu Chartier9e050df2017-08-09 10:05:47 -07003020 // Keep the class loader that was used for compilation live for the rest of the compilation
3021 // process.
Mathieu Chartier72041a02017-07-14 18:23:25 -07003022 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08003023
David Brazdil7b49e6c2016-09-01 11:06:18 +01003024 if (!dex2oat.WriteOutputFiles()) {
3025 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07003026 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003027 }
3028
Jeff Haodcdc85b2015-12-04 14:06:18 -08003029 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08003030 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08003031
3032 // When given --host, finish early without stripping.
3033 if (dex2oat.IsHost()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003034 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003035 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003036 }
3037
3038 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003039 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003040 }
3041
Jeff Haodcdc85b2015-12-04 14:06:18 -08003042 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
3043 // stripped versions. If this is given, we expect to be able to open writable files by name.
3044 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003045 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003046 }
3047
Jeff Haodcdc85b2015-12-04 14:06:18 -08003048 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01003049 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003050 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003051 }
3052
3053 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003054 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003055}
3056
Andreas Gampe7b565912017-03-20 15:48:52 -07003057static dex2oat::ReturnCode Dex2oat(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003058 b13564922();
3059
3060 TimingLogger timings("compiler", false, false);
3061
Roland Levillain5c7e2602016-02-23 18:08:53 +00003062 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
3063 // might produce a stack frame too large for this function or for
3064 // functions inlining it (such as main), that would not fit the
3065 // requirements of the `-Wframe-larger-than` option.
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07003066 std::unique_ptr<Dex2Oat> dex2oat = std::make_unique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003067
3068 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003069 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003070
Calin Juravleb077e152016-02-18 18:47:37 +00003071 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02003072 // This operation involves I/O.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08003073 if (dex2oat->UseProfile()) {
Calin Juravleb077e152016-02-18 18:47:37 +00003074 if (!dex2oat->LoadProfile()) {
3075 LOG(ERROR) << "Failed to process profile file";
Andreas Gampe7b565912017-03-20 15:48:52 -07003076 return dex2oat::ReturnCode::kOther;
Calin Juravle998c2162015-12-21 15:39:33 +02003077 }
3078 }
3079
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00003080 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap, and vdex.
3081
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003082 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00003083 if (!dex2oat->OpenFile()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003084 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003085 }
3086
Andreas Gampe046c7062015-05-18 23:22:54 -07003087 // Print the complete line when any of the following is true:
3088 // 1) Debug build
3089 // 2) Compiling an image
3090 // 3) Compiling with --host
3091 // 4) Compiling on the host (not a target build)
3092 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003093 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07003094 LOG(INFO) << CommandLine();
3095 } else {
3096 LOG(INFO) << StrippedCommandLine();
3097 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003098
Andreas Gampef7882972017-03-20 16:35:24 -07003099 dex2oat::ReturnCode setup_code = dex2oat->Setup();
3100 if (setup_code != dex2oat::ReturnCode::kNoFailure) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003101 dex2oat->EraseOutputFiles();
Andreas Gampef7882972017-03-20 16:35:24 -07003102 return setup_code;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003103 }
3104
Shubham Ajmera188b2bf2017-09-20 15:53:35 -07003105 // TODO: Due to the cyclic dependencies, profile loading and verifying are
3106 // being done separately. Refactor and place the two next to each other.
3107 // If verification fails, we don't abort the compilation and instead log an
3108 // error.
3109 // TODO(b/62602192, b/65260586): We should consider aborting compilation when
3110 // the profile verification fails.
3111 // Note: If dex2oat fails, installd will remove the oat files causing the app
3112 // to fallback to apk with possible in-memory extraction. We want to avoid
3113 // that, and thus we're lenient towards profile corruptions.
3114 if (dex2oat->UseProfile()) {
3115 dex2oat->VerifyProfileData();
3116 }
3117
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07003118 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
3119 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07003120 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
3121
Andreas Gampe7b565912017-03-20 15:48:52 -07003122 dex2oat::ReturnCode result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00003123 if (dex2oat->IsImage()) {
3124 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08003125 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00003126 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003127 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003128
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003129 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003130}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003131} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07003132
3133int main(int argc, char** argv) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003134 int result = static_cast<int>(art::Dex2oat(argc, argv));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003135 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
Pirama Arumuga Nainarab898922018-01-04 10:37:48 -08003136 // time (bug 10645725) unless we're a debug or instrumented build or running on valgrind. Note:
3137 // The Dex2Oat class should not destruct the runtime in this case.
3138 if (!art::kIsDebugBuild && !art::kIsPGOInstrumentation && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampee286b642017-04-13 12:20:42 -07003139 _exit(result);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003140 }
3141 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07003142}