blob: e23bedf918f226a97c5284346369027dc21b8249 [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>
Brian Carlstrom7940e442013-07-12 13:46:57 -070030#include <vector>
31
Orion Hodsonffc791c2019-11-14 19:19:28 +000032#if defined(__linux__)
33#include <sched.h>
34#if defined(__arm__)
Vladimir Markof94b7812014-06-05 15:48:04 +010035#include <sys/personality.h>
36#include <sys/utsname.h>
Orion Hodsonffc791c2019-11-14 19:19:28 +000037#endif // __arm__
Vladimir Markof94b7812014-06-05 15:48:04 +010038#endif
39
Orion Hodsonffc791c2019-11-14 19:19:28 +000040#include "android-base/parseint.h"
Andreas Gampe46ee31b2016-12-14 10:11:49 -080041#include "android-base/stringprintf.h"
Andreas Gampe9186ced2016-12-12 14:28:21 -080042#include "android-base/strings.h"
43
Ian Rogersd582fa42014-11-05 23:46:43 -080044#include "arch/instruction_set_features.h"
Andreas Gampec5a3ea72015-01-13 16:41:53 -080045#include "arch/mips/instruction_set_features_mips.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000046#include "art_method-inl.h"
Andreas Gampe8228cdf2017-05-30 15:03:54 -070047#include "base/callee_save_type.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070048#include "base/dumpable.h"
David Sehr891a50e2017-10-27 17:01:07 -070049#include "base/file_utils.h"
David Sehr67bf42e2018-02-26 16:43:04 -080050#include "base/leb128.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080051#include "base/macros.h"
David Sehrc431b9d2018-03-02 12:01:51 -080052#include "base/mutex.h"
53#include "base/os.h"
Calin Juravle2e2db782016-02-23 12:00:03 +000054#include "base/scoped_flock.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070055#include "base/stl_util.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010056#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070057#include "base/timing_logger.h"
58#include "base/unix_file/fd_file.h"
David Sehrc431b9d2018-03-02 12:01:51 -080059#include "base/utils.h"
David Sehr79e26072018-04-06 17:58:50 -070060#include "base/zip_archive.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070061#include "class_linker.h"
Calin Juravle1ce70852017-06-28 10:59:03 -070062#include "class_loader_context.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070063#include "cmdline_parser.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000064#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000065#include "compiler_callbacks.h"
David Srbecky09c2a6b2016-03-11 17:11:44 +000066#include "debug/elf_debug_writer.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000067#include "debug/method_debug_info.h"
David Sehrb2ec9f52018-02-21 13:20:31 -080068#include "dex/descriptors_names.h"
David Sehr9e734c72018-01-04 17:56:19 -080069#include "dex/dex_file-inl.h"
Vladimir Marko21910692019-11-06 13:27:03 +000070#include "dex/dex_file_loader.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000071#include "dex/quick_compiler_callbacks.h"
72#include "dex/verification_results.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070073#include "dex2oat_options.h"
Andreas Gampe7b565912017-03-20 15:48:52 -070074#include "dex2oat_return_codes.h"
David Srbecky2faab002019-02-12 16:35:48 +000075#include "dexlayout.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070076#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080077#include "driver/compiler_options.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070078#include "driver/compiler_options_map-inl.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080079#include "elf_file.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070080#include "gc/space/image_space.h"
81#include "gc/space/space-inl.h"
Mathieu Chartier72041a02017-07-14 18:23:25 -070082#include "gc/verification.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070083#include "interpreter/unstarted_runtime.h"
Vladimir Markoa3ad0cd2018-05-04 10:06:38 +010084#include "jni/java_vm_ext.h"
Vladimir Marko74527972016-11-29 15:57:32 +000085#include "linker/elf_writer.h"
86#include "linker/elf_writer_quick.h"
Vladimir Marko74527972016-11-29 15:57:32 +000087#include "linker/image_writer.h"
Vladimir Marko944da602016-02-19 12:27:55 +000088#include "linker/multi_oat_relative_patcher.h"
Vladimir Marko74527972016-11-29 15:57:32 +000089#include "linker/oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070090#include "mirror/class-inl.h"
91#include "mirror/class_loader.h"
92#include "mirror/object-inl.h"
93#include "mirror/object_array-inl.h"
Vladimir Markod3d00c02019-11-07 15:09:07 +000094#include "oat.h"
Andreas Gampe2ff3b972017-06-05 18:14:53 -070095#include "oat_file.h"
Jeff Haob11ffb72016-04-07 15:40:54 -070096#include "oat_file_assistant.h"
David Sehr82d046e2018-04-23 08:14:19 -070097#include "profile/profile_compilation_info.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070098#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000099#include "runtime_options.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -0700100#include "scoped_thread_state_change-inl.h"
David Srbecky2faab002019-02-12 16:35:48 +0000101#include "stream/buffered_output_stream.h"
102#include "stream/file_output_stream.h"
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000103#include "vdex_file.h"
David Brazdilca3c8c32016-09-06 14:04:48 +0100104#include "verifier/verifier_deps.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -0700105#include "well_known_classes.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -0700106
107namespace art {
108
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800109using android::base::StringAppendV;
110using android::base::StringPrintf;
Vladimir Marko91f10322018-12-07 18:04:10 +0000111using gc::space::ImageSpace;
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800112
Andreas Gampee1459ae2016-06-29 09:36:30 -0700113static constexpr size_t kDefaultMinDexFilesForSwap = 2;
114static constexpr size_t kDefaultMinDexFileCumulativeSizeForSwap = 20 * MB;
115
Mathieu Chartier010126f2017-07-15 15:44:18 -0700116// Compiler filter override for very large apps.
117static constexpr CompilerFilter::Filter kLargeAppFilter = CompilerFilter::kVerify;
118
Brian Carlstrom6449c622014-02-10 23:48:36 -0800119static int original_argc;
120static char** original_argv;
121
122static std::string CommandLine() {
123 std::vector<std::string> command;
Andreas Gampe2a487eb2018-11-19 11:41:22 -0800124 command.reserve(original_argc);
Brian Carlstrom6449c622014-02-10 23:48:36 -0800125 for (int i = 0; i < original_argc; ++i) {
126 command.push_back(original_argv[i]);
127 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800128 return android::base::Join(command, ' ');
Brian Carlstrom6449c622014-02-10 23:48:36 -0800129}
130
Andreas Gampe046c7062015-05-18 23:22:54 -0700131// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
132// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
133// locations are all staged).
134static std::string StrippedCommandLine() {
135 std::vector<std::string> command;
136
Calin Juravle07c6d722017-06-07 17:06:12 +0000137 // Do a pre-pass to look for zip-fd and the compiler filter.
Andreas Gampe046c7062015-05-18 23:22:54 -0700138 bool saw_zip_fd = false;
Calin Juravle07c6d722017-06-07 17:06:12 +0000139 bool saw_compiler_filter = false;
Andreas Gampe046c7062015-05-18 23:22:54 -0700140 for (int i = 0; i < original_argc; ++i) {
Andreas Gampe9186ced2016-12-12 14:28:21 -0800141 if (android::base::StartsWith(original_argv[i], "--zip-fd=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700142 saw_zip_fd = true;
Andreas Gampe046c7062015-05-18 23:22:54 -0700143 }
Calin Juravle07c6d722017-06-07 17:06:12 +0000144 if (android::base::StartsWith(original_argv[i], "--compiler-filter=")) {
145 saw_compiler_filter = true;
Calin Juravle07c6d722017-06-07 17:06:12 +0000146 }
Andreas Gampe046c7062015-05-18 23:22:54 -0700147 }
148
149 // Now filter out things.
150 for (int i = 0; i < original_argc; ++i) {
151 // All runtime-arg parameters are dropped.
152 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
153 i++; // Drop the next part, too.
154 continue;
155 }
156
157 // Any instruction-setXXX is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800158 if (android::base::StartsWith(original_argv[i], "--instruction-set")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700159 continue;
160 }
161
162 // The boot image is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800163 if (android::base::StartsWith(original_argv[i], "--boot-image=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700164 continue;
165 }
166
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800167 // The image format is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800168 if (android::base::StartsWith(original_argv[i], "--image-format=")) {
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800169 continue;
170 }
171
Andreas Gampe046c7062015-05-18 23:22:54 -0700172 // This should leave any dex-file and oat-file options, describing what we compiled.
173
174 // However, we prefer to drop this when we saw --zip-fd.
175 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700176 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe9186ced2016-12-12 14:28:21 -0800177 if (android::base::StartsWith(original_argv[i], "--zip-") ||
178 android::base::StartsWith(original_argv[i], "--dex-") ||
179 android::base::StartsWith(original_argv[i], "--oat-") ||
180 android::base::StartsWith(original_argv[i], "--swap-") ||
181 android::base::StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700182 continue;
183 }
184 }
185
186 command.push_back(original_argv[i]);
187 }
188
Calin Juravle07c6d722017-06-07 17:06:12 +0000189 if (!saw_compiler_filter) {
190 command.push_back("--compiler-filter=" +
191 CompilerFilter::NameOfFilter(CompilerFilter::kDefaultCompilerFilter));
192 }
193
Andreas Gampe046c7062015-05-18 23:22:54 -0700194 // Construct the final output.
195 if (command.size() <= 1U) {
Martin Stjernholmad909af2019-07-16 17:02:44 +0100196 // It seems only "/apex/com.android.art/bin/dex2oat" is left, or not
Roland Levillain38a938e2018-09-21 10:55:51 +0100197 // even that. Use a pretty line.
Andreas Gampe046c7062015-05-18 23:22:54 -0700198 return "Starting dex2oat.";
199 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800200 return android::base::Join(command, ' ');
Andreas Gampe046c7062015-05-18 23:22:54 -0700201}
202
Brian Carlstrom7940e442013-07-12 13:46:57 -0700203static void UsageErrorV(const char* fmt, va_list ap) {
204 std::string error;
205 StringAppendV(&error, fmt, ap);
206 LOG(ERROR) << error;
207}
208
209static void UsageError(const char* fmt, ...) {
210 va_list ap;
211 va_start(ap, fmt);
212 UsageErrorV(fmt, ap);
213 va_end(ap);
214}
215
Andreas Gampe794ad762015-02-23 08:12:24 -0800216NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700217 va_list ap;
218 va_start(ap, fmt);
219 UsageErrorV(fmt, ap);
220 va_end(ap);
221
Brian Carlstrom6449c622014-02-10 23:48:36 -0800222 UsageError("Command: %s", CommandLine().c_str());
223
Brian Carlstrom7940e442013-07-12 13:46:57 -0700224 UsageError("Usage: dex2oat [options]...");
225 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100226 UsageError(" -j<number>: specifies the number of threads used for compilation.");
227 UsageError(" Default is the number of detected hardware threads available on the");
228 UsageError(" host system.");
229 UsageError(" Example: -j12");
230 UsageError("");
Orion Hodsonffc791c2019-11-14 19:19:28 +0000231 UsageError(" --cpu-set=<set>: sets the cpu affinity to <set>. The <set> argument is a comma");
232 UsageError(" separated list of CPUs.");
233 UsageError(" Example: --cpu-set=0,1,2,3");
234 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700235 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700236 UsageError(" Example: --dex-file=/system/framework/core.jar");
237 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700238 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
239 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
240 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
241 UsageError(" --dex-location=/system/framework/core.jar");
242 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700243 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
244 UsageError(" containing a classes.dex file to compile.");
245 UsageError(" Example: --zip-fd=5");
246 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700247 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
248 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700249 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
250 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800251 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700252 UsageError(" Example: --oat-file=/system/framework/boot.oat");
253 UsageError("");
254 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900255 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700256 UsageError("");
Shubham Ajmera66205322017-10-06 11:18:51 -0700257 UsageError(" --input-vdex-fd=<number>: specifies the vdex input source via a file descriptor.");
258 UsageError(" Example: --input-vdex-fd=6");
259 UsageError("");
260 UsageError(" --output-vdex-fd=<number>: specifies the vdex output destination via a file");
261 UsageError(" descriptor.");
262 UsageError(" Example: --output-vdex-fd=6");
263 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700264 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
265 UsageError(" to the file descriptor specified by --oat-fd.");
266 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
267 UsageError("");
David Srbeckyde91fd42018-07-05 22:27:08 +0100268 UsageError(" --oat-symbols=<file.oat>: specifies a destination where the oat file is copied.");
269 UsageError(" This is equivalent to file copy as build post-processing step.");
270 UsageError(" It is intended to be used with --strip and it happens before it.");
271 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
272 UsageError("");
273 UsageError(" --strip: remove all debugging sections at the end (but keep mini-debug-info).");
274 UsageError(" This is equivalent to the \"strip\" command as build post-processing step.");
275 UsageError(" It is intended to be used with --oat-symbols and it happens after it.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700276 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
277 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800278 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700279 UsageError(" Example: --image=/system/framework/boot.art");
280 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800281 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800282 UsageError(" Which format to store the image.");
283 UsageError(" Example: --image-format=lz4");
284 UsageError(" Default: uncompressed");
285 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700286 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
287 UsageError(" Example: --base=0x50000000");
288 UsageError("");
289 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000290 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700291 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000292 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Vladimir Marko21910692019-11-06 13:27:03 +0000293 UsageError(" Example: --boot-image=boot.art:boot-framework.art");
294 UsageError(" (specifies <bcp-path1>/<arch>/boot.art as the image file and");
295 UsageError(" <bcp-path2>/<arch>/boot-framework.art as the image extension file");
296 UsageError(" with paths taken from corresponding boot class path components)");
297 UsageError(" Example: --boot-image=/apex/com.android.art/boot.art:/system/framework/*:*");
298 UsageError(" (specifies /apex/com.android.art/<arch>/boot.art as the image");
299 UsageError(" file and search for extensions in /framework/system and boot");
300 UsageError(" class path components' paths)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000301 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700302 UsageError("");
303 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
304 UsageError(" Example: --android-root=out/host/linux-x86");
305 UsageError(" Default: $ANDROID_ROOT");
306 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800307 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700308 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700309 UsageError(" Example: --instruction-set=x86");
310 UsageError(" Default: arm");
311 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700312 UsageError(" --instruction-set-features=...,: Specify instruction set features");
xueliang.zhong7f88c1a2018-11-06 11:42:41 +0000313 UsageError(" On target the value 'runtime' can be used to detect features at run time.");
314 UsageError(" If target does not support run-time detection the value 'runtime'");
315 UsageError(" has the same effect as the value 'default'.");
316 UsageError(" Note: the value 'runtime' has no effect if it is used on host.");
Dave Allison70202782013-10-22 17:52:19 -0700317 UsageError(" Example: --instruction-set-features=div");
318 UsageError(" Default: default");
319 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800320 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700321 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800322 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100323 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700324 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100325 UsageError(" --compiler-filter="
Nicolas Geoffray49cda062017-04-21 13:08:25 +0100326 "(assume-verified"
327 "|extract"
328 "|verify"
329 "|quicken"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000330 "|space-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100331 "|space"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000332 "|speed-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100333 "|speed"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000334 "|everything-profile"
335 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700336 UsageError(" select compiler filter.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800337 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800338 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800339 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800340 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
341 UsageError(" method for compiler filter tuning.");
342 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
343 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
344 UsageError("");
345 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
346 UsageError(" method for compiler filter tuning.");
347 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
348 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
349 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800350 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
351 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700352 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
353 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800354 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
355 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
356 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100357 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
358 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100359 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
360 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100361 UsageError(" Example: --inline-max-code-units=%d",
362 CompilerOptions::kDefaultInlineMaxCodeUnits);
363 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
364 UsageError("");
Nicolas Geoffraye82b60f2017-12-10 21:50:10 +0000365 UsageError(" --dump-timings: display a breakdown of where time was spent");
Ian Rogers46398602013-08-20 07:50:36 -0700366 UsageError("");
Vladimir Marko2da52b02018-05-08 16:31:34 +0100367 UsageError(" --dump-pass-timings: display a breakdown of time spent in optimization");
368 UsageError(" passes for each compiled method.");
369 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100370 UsageError(" -g");
371 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
372 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000373 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000374 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700375 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100376 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100377 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000378 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
379 UsageError(" debug information necessary to print backtraces. (disabled by default)");
380 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000381 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000382 UsageError("");
Alexey Alexandrovab40c112016-09-19 09:33:49 -0700383 UsageError(" --generate-build-id: Generate GNU-compatible linker build ID ELF section with");
384 UsageError(" SHA-1 of the file content (and thus stable across identical builds)");
385 UsageError("");
386 UsageError(" --no-generate-build-id: Do not generate the build ID ELF section.");
387 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000388 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000389 UsageError("");
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700390 UsageError(" --avoid-storing-invocation: Avoid storing the invocation args in the key value");
391 UsageError(" store. Used to test determinism with different args.");
392 UsageError("");
Alex Light62afcf52018-12-18 14:19:25 -0800393 UsageError(" --write-invocation-to=<file>: Write the invocation commandline to the given file");
394 UsageError(" for later use. Used to test determinism with different host architectures.");
395 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700396 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
397 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
398 UsageError(" Use a separate --runtime-arg switch for each argument.");
399 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700400 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000401 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700402 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000403 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
404 UsageError(" Cannot be used together with --profile-file.");
405 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100406 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800407 UsageError(" Example: --swap-file=/data/tmp/swap.001");
408 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100409 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800410 UsageError(" Example: --swap-fd=10");
411 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100412 UsageError(" --swap-dex-size-threshold=<size>: specifies the minimum total dex file size in");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700413 UsageError(" bytes to allow the use of swap.");
414 UsageError(" Example: --swap-dex-size-threshold=1000000");
415 UsageError(" Default: %zu", kDefaultMinDexFileCumulativeSizeForSwap);
416 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100417 UsageError(" --swap-dex-count-threshold=<count>: specifies the minimum number of dex files to");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700418 UsageError(" allow the use of swap.");
419 UsageError(" Example: --swap-dex-count-threshold=10");
420 UsageError(" Default: %zu", kDefaultMinDexFilesForSwap);
421 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100422 UsageError(" --very-large-app-threshold=<size>: specifies the minimum total dex file size in");
Mathieu Chartier010126f2017-07-15 15:44:18 -0700423 UsageError(" bytes to consider the input \"very large\" and reduce compilation done.");
Andreas Gampe67f02822016-06-24 21:05:23 -0700424 UsageError(" Example: --very-large-app-threshold=100000000");
425 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700426 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
Mathieu Chartierf85b3db2018-04-02 18:16:21 -0700427 UsageError(" The image is non-empty only if a profile is passed in.");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700428 UsageError(" Example: --app-image-fd=10");
429 UsageError("");
430 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
431 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
432 UsageError("");
Vladimir Marko4519b9d2018-10-10 15:21:21 +0100433 UsageError(" --multi-image: obsolete, ignored");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800434 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000435 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000436 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100437 UsageError(" --dump-cfg=<cfg-file>: dump control-flow graphs (CFGs) to specified file.");
438 UsageError(" Example: --dump-cfg=output.cfg");
439 UsageError("");
440 UsageError(" --dump-cfg-append: when dumping CFGs to an existing file, append new CFG data to");
441 UsageError(" existing data (instead of overwriting existing data with new data, which is");
442 UsageError(" the default behavior). This option is only meaningful when used with");
443 UsageError(" --dump-cfg.");
444 UsageError("");
Roland Levillaine1de95c2019-06-05 15:26:20 +0100445 UsageError(" --verbose-methods=<method-names>: Restrict dumped CFG data to methods whose name");
446 UsageError(" contain one of the method names passed as argument");
447 UsageError(" Example: --verbose-methods=toString,hashCode");
448 UsageError("");
Jeff Hao16d48432017-04-05 17:05:46 -0700449 UsageError(" --classpath-dir=<directory-path>: directory used to resolve relative class paths.");
450 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700451 UsageError(" --class-loader-context=<string spec>: a string specifying the intended");
452 UsageError(" runtime loading context for the compiled dex files.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700453 UsageError("");
Mathieu Chartierf5abfc42018-03-23 21:51:54 -0700454 UsageError(" --stored-class-loader-context=<string spec>: a string specifying the intended");
455 UsageError(" runtime loading context that is stored in the oat file. Overrides");
456 UsageError(" --class-loader-context. Note that this ignores the classpath_dir arg.");
457 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700458 UsageError(" It describes how the class loader chain should be built in order to ensure");
459 UsageError(" classes are resolved during dex2aot as they would be resolved at runtime.");
460 UsageError(" This spec will be encoded in the oat file. If at runtime the dex file is");
461 UsageError(" loaded in a different context, the oat file will be rejected.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700462 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700463 UsageError(" The chain is interpreted in the natural 'parent order', meaning that class");
464 UsageError(" loader 'i+1' will be the parent of class loader 'i'.");
Calin Juravlec79470d2017-07-12 17:37:42 -0700465 UsageError(" The compilation sources will be appended to the classpath of the first class");
466 UsageError(" loader.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700467 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700468 UsageError(" E.g. if the context is 'PCL[lib1.dex];DLC[lib2.dex]' and ");
469 UsageError(" --dex-file=src.dex then dex2oat will setup a PathClassLoader with classpath ");
470 UsageError(" 'lib1.dex:src.dex' and set its parent to a DelegateLastClassLoader with ");
471 UsageError(" classpath 'lib2.dex'.");
David Brazdil89821862019-03-19 13:57:43 +0000472 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700473 UsageError(" Note that the compiler will be tolerant if the source dex files specified");
474 UsageError(" with --dex-file are found in the classpath. The source dex files will be");
475 UsageError(" removed from any class loader's classpath possibly resulting in empty");
476 UsageError(" class loaders.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700477 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700478 UsageError(" Example: --class-loader-context=PCL[lib1.dex:lib2.dex];DLC[lib3.dex]");
Calin Juravle1ce70852017-06-28 10:59:03 -0700479 UsageError("");
David Brazdil89821862019-03-19 13:57:43 +0000480 UsageError(" --class-loader-context-fds=<fds>: a colon-separated list of file descriptors");
481 UsageError(" for dex files in --class-loader-context. Their order must be the same as");
482 UsageError(" dex files in flattened class loader context.");
483 UsageError("");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700484 UsageError(" --dirty-image-objects=<directory-path>: list of known dirty objects in the image.");
485 UsageError(" The image writer will group them together.");
486 UsageError("");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700487 UsageError(" --compact-dex-level=none|fast: None avoids generating compact dex, fast");
Mathieu Chartierddf39552018-04-03 10:22:27 -0700488 UsageError(" generates compact dex with low compile time. If speed-profile is specified as");
489 UsageError(" the compiler filter and the profile is not empty, the default compact dex");
490 UsageError(" level is always used.");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700491 UsageError("");
Andreas Gampee20ff6f2017-11-07 15:00:35 -0800492 UsageError(" --deduplicate-code=true|false: enable|disable code deduplication. Deduplicated");
493 UsageError(" code will have an arbitrary symbol tagged with [DEDUPED].");
Andreas Gampecac31ad2017-11-06 20:01:17 -0800494 UsageError("");
Nicolas Geoffray66ff8a82018-02-28 13:27:55 +0000495 UsageError(" --copy-dex-files=true|false: enable|disable copying the dex files into the");
Mathieu Chartier792111c2018-02-15 13:02:15 -0800496 UsageError(" output vdex.");
497 UsageError("");
Calin Juravle0e09dfc2018-02-12 19:01:09 -0800498 UsageError(" --compilation-reason=<string>: optional metadata specifying the reason for");
499 UsageError(" compiling the apk. If specified, the string will be embedded verbatim in");
500 UsageError(" the key value store of the oat file.");
Mathieu Chartier19667a02018-12-21 15:26:19 -0800501 UsageError(" Example: --compilation-reason=install");
Calin Juravle0e09dfc2018-02-12 19:01:09 -0800502 UsageError("");
Mathieu Chartiercd0f38f2018-10-15 09:44:35 -0700503 UsageError(" --resolve-startup-const-strings=true|false: If true, the compiler eagerly");
504 UsageError(" resolves strings referenced from const-string of startup methods.");
505 UsageError("");
Mathieu Chartier1a842962018-11-13 15:09:51 -0800506 UsageError(" --max-image-block-size=<size>: Maximum solid block size for compressed images.");
507 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700508 std::cerr << "See log for usage error information\n";
509 exit(EXIT_FAILURE);
510}
511
Orion Hodsonffc791c2019-11-14 19:19:28 +0000512
513// Set CPU affinity from a string containing a comma-separated list of numeric CPU identifiers.
514static void SetCpuAffinity(const std::vector<int32_t>& cpu_list) {
515#ifdef __linux__
516 int cpu_count = sysconf(_SC_NPROCESSORS_CONF);
517 cpu_set_t target_cpu_set;
518 CPU_ZERO(&target_cpu_set);
519
520 for (int32_t cpu : cpu_list) {
521 if (cpu >= 0 && cpu < cpu_count) {
522 CPU_SET(cpu, &target_cpu_set);
523 } else {
524 // Argument error is considered fatal, suggests misconfigured system properties.
525 Usage("Invalid cpu \"d\" specified in --cpu-set argument (nprocessors = %d)",
526 cpu, cpu_count);
527 }
528 }
529
530 if (sched_setaffinity(getpid(), sizeof(target_cpu_set), &target_cpu_set) == -1) {
531 // Failure to set affinity may be outside control of requestor, log warning rather than
532 // treating as fatal.
533 PLOG(WARNING) << "Failed to set CPU affinity.";
534 }
535#else
536 LOG(WARNING) << "--cpu-set not supported on this platform.";
537#endif // __linux__
538}
539
540
541
Brian Carlstrom7940e442013-07-12 13:46:57 -0700542// The primary goal of the watchdog is to prevent stuck build servers
543// during development when fatal aborts lead to a cascade of failures
544// that result in a deadlock.
545class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800546// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700547#undef CHECK_PTHREAD_CALL
548#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
549 do { \
550 int rc = call args; \
551 if (rc != 0) { \
552 errno = rc; \
553 std::string message(# call); \
554 message += " failed for "; \
555 message += reason; \
556 Fatal(message); \
557 } \
558 } while (false)
559
560 public:
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800561 explicit WatchDog(int64_t timeout_in_milliseconds)
Andreas Gampe0f54b0d2017-12-27 08:37:02 -0800562 : timeout_in_milliseconds_(timeout_in_milliseconds),
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800563 shutting_down_(false) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700564 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700565 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800566#ifndef __APPLE__
567 pthread_condattr_t condattr;
liulvping8f7101e2017-01-16 15:14:43 +0800568 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_init, (&condattr), reason);
569 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_setclock, (&condattr, CLOCK_MONOTONIC), reason);
570 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, &condattr), reason);
571 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_destroy, (&condattr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800572#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700573 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
574 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
575 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
576 }
577 ~WatchDog() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700578 const char* reason = "dex2oat watch dog thread shutdown";
579 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
580 shutting_down_ = true;
581 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
582 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
583
Kenny Root51316382014-05-13 14:59:37 -0700584 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700585
586 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
587 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
588 }
589
Koji Fukuia72ca6c2019-03-25 17:39:07 +0900590 static void SetRuntime(Runtime* runtime) {
591 const char* reason = "dex2oat watch dog set runtime";
592 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&runtime_mutex_), reason);
593 runtime_ = runtime;
594 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&runtime_mutex_), reason);
595 }
596
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800597 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
598 // large.
599 static constexpr int64_t kWatchdogVerifyMultiplier =
600 kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
601
602 // When setting timeouts, keep in mind that the build server may not be as fast as your
603 // desktop. Debug builds are slower so they have larger timeouts.
604 static constexpr int64_t kWatchdogSlowdownFactor = kIsDebugBuild ? 5U : 1U;
605
606 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
607 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
608 // itself before that watchdog would take down the system server.
609 static constexpr int64_t kWatchDogTimeoutSeconds = kWatchdogSlowdownFactor * (9 * 60 + 30);
610
611 static constexpr int64_t kDefaultWatchdogTimeoutInMS =
612 kWatchdogVerifyMultiplier * kWatchDogTimeoutSeconds * 1000;
613
Brian Carlstrom7940e442013-07-12 13:46:57 -0700614 private:
615 static void* CallBack(void* arg) {
616 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
617 ::art::SetThreadName("dex2oat watch dog");
618 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700619 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700620 }
621
Andreas Gampe794ad762015-02-23 08:12:24 -0800622 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700623 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
624 // it's rather easy to hang in unwinding.
625 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
626 // logcat logging or stderr output.
Tomasz Wasilczyk8d840902017-12-20 08:19:53 -0800627 LogHelper::LogLineLowStack(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
628
Andreas Gampe48fde372017-06-06 07:43:46 -0700629 // If we're on the host, try to dump all threads to get a sense of what's going on. This is
630 // restricted to the host as the dump may itself go bad.
631 // TODO: Use a double watchdog timeout, so we can enable this on-device.
Koji Fukuia72ca6c2019-03-25 17:39:07 +0900632 Runtime* runtime = GetRuntime();
633 if (!kIsTargetBuild && runtime != nullptr) {
634 runtime->AttachCurrentThread("Watchdog thread attached for dumping",
635 true,
636 nullptr,
637 false);
638 runtime->DumpForSigQuit(std::cerr);
Andreas Gampecd607312017-06-05 17:03:05 -0700639 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700640 exit(1);
641 }
642
643 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700644 timespec timeout_ts;
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800645#if defined(__APPLE__)
646 InitTimeSpec(true, CLOCK_REALTIME, timeout_in_milliseconds_, 0, &timeout_ts);
647#else
liulvping8f7101e2017-01-16 15:14:43 +0800648 InitTimeSpec(true, CLOCK_MONOTONIC, timeout_in_milliseconds_, 0, &timeout_ts);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800649#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700650 const char* reason = "dex2oat watch dog thread waiting";
651 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
652 while (!shutting_down_) {
Josh Gao2d899c42018-10-17 16:03:42 -0700653 int rc = pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts);
654 if (rc == EINTR) {
655 continue;
656 } else if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700657 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800658 timeout_in_milliseconds_/1000));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700659 } else if (rc != 0) {
Roland Levillaind6f8c8b2018-12-18 15:27:28 +0000660 std::string message(StringPrintf("pthread_cond_timedwait failed: %s", strerror(rc)));
Greg Kaiserf276f952019-03-26 08:15:44 -0700661 Fatal(message);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700662 }
663 }
664 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
665 }
666
Koji Fukuia72ca6c2019-03-25 17:39:07 +0900667 static Runtime* GetRuntime() {
668 const char* reason = "dex2oat watch dog get runtime";
669 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&runtime_mutex_), reason);
670 Runtime* runtime = runtime_;
671 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&runtime_mutex_), reason);
672 return runtime;
673 }
674
675 static pthread_mutex_t runtime_mutex_;
676 static Runtime* runtime_;
677
Brian Carlstrom7940e442013-07-12 13:46:57 -0700678 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
679 pthread_mutex_t mutex_;
680 pthread_cond_t cond_;
681 pthread_attr_t attr_;
682 pthread_t pthread_;
Andreas Gampef45d61c2017-06-07 10:29:33 -0700683
684 const int64_t timeout_in_milliseconds_;
685 bool shutting_down_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700686};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700687
Koji Fukuia72ca6c2019-03-25 17:39:07 +0900688pthread_mutex_t WatchDog::runtime_mutex_ = PTHREAD_MUTEX_INITIALIZER;
689Runtime* WatchDog::runtime_ = nullptr;
690
Roland Levillainbbc6e7e2018-08-24 16:58:47 +0100691class Dex2Oat final {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800692 public:
693 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100694 compiler_kind_(Compiler::kOptimizing),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800695 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000696 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700697 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800698 runtime_(nullptr),
699 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
700 start_ns_(NanoTime()),
Andreas Gampec560fc02014-07-16 09:57:39 -0700701 start_cputime_ns_(ProcessCpuNanoTime()),
Vladimir Marko2afaff72018-11-30 17:01:50 +0000702 strip_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800703 oat_fd_(-1),
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000704 input_vdex_fd_(-1),
705 output_vdex_fd_(-1),
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000706 input_vdex_file_(nullptr),
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +0000707 dm_fd_(-1),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800708 zip_fd_(-1),
709 image_base_(0U),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800710 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700711 passes_to_run_filename_(nullptr),
Mathieu Chartierff0baff2017-08-02 23:04:19 -0700712 dirty_image_objects_filename_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800713 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000714 elf_writers_(),
715 oat_writers_(),
716 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000717 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700718 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000719 opened_dex_files_maps_(),
720 opened_dex_files_(),
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700721 avoid_storing_invocation_(false),
Calin Juravle2e2db782016-02-23 12:00:03 +0000722 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800723 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000724 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800725 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000726 force_determinism_(false)
727 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800728
729 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800730 // Log completion time before deleting the runtime_, because this accesses
731 // the runtime.
732 LogCompletionTime();
733
Roland Levillain05e34f42018-05-24 13:19:05 +0000734 if (!kIsDebugBuild && !(kRunningOnMemoryTool && kMemoryToolDetectsLeaks)) {
Vladimir Marko307dac92015-10-20 11:20:09 +0100735 // We want to just exit on non-debug builds, not bringing the runtime down
736 // in an orderly fashion. So release the following fields.
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700737 driver_.release(); // NOLINT
738 image_writer_.release(); // NOLINT
Vladimir Marko307dac92015-10-20 11:20:09 +0100739 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700740 dex_file.release(); // NOLINT
Vladimir Marko307dac92015-10-20 11:20:09 +0100741 }
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100742 new std::vector<MemMap>(std::move(opened_dex_files_maps_)); // Leak MemMaps.
David Brazdil7b49e6c2016-09-01 11:06:18 +0100743 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700744 vdex_file.release(); // NOLINT
David Brazdil7b49e6c2016-09-01 11:06:18 +0100745 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800746 for (std::unique_ptr<File>& oat_file : oat_files_) {
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700747 oat_file.release(); // NOLINT
Jeff Haodcdc85b2015-12-04 14:06:18 -0800748 }
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700749 runtime_.release(); // NOLINT
750 verification_results_.release(); // NOLINT
751 key_value_store_.release(); // NOLINT
Vladimir Markof94b7812014-06-05 15:48:04 +0100752 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700753 }
754
Roland Levillain9ec5e222015-08-17 20:18:41 +0100755 struct ParserOptions {
Vladimir Markod011d812018-11-29 12:35:24 +0000756 std::vector<std::string> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800757 std::string boot_image_filename;
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800758 int64_t watch_dog_timeout_in_ms = -1;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800759 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000760 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800761 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100762 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800763
Andreas Gampe097f34c2017-08-23 08:57:51 -0700764 void ParseBase(const std::string& option) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100765 char* end;
Andreas Gampe097f34c2017-08-23 08:57:51 -0700766 image_base_ = strtoul(option.c_str(), &end, 16);
767 if (end == option.c_str() || *end != '\0') {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100768 Usage("Failed to parse hexadecimal value for option %s", option.data());
769 }
770 }
771
Shubham Ajmera188b2bf2017-09-20 15:53:35 -0700772 bool VerifyProfileData() {
Vladimir Marko213ee2d2018-06-22 11:56:34 +0100773 return profile_compilation_info_->VerifyProfileData(compiler_options_->dex_files_for_oat_file_);
Shubham Ajmera188b2bf2017-09-20 15:53:35 -0700774 }
775
Andreas Gampe097f34c2017-08-23 08:57:51 -0700776 void ParseInstructionSetVariant(const std::string& option, ParserOptions* parser_options) {
Vladimir Markoa0431112018-06-25 09:32:54 +0100777 compiler_options_->instruction_set_features_ = InstructionSetFeatures::FromVariant(
778 compiler_options_->instruction_set_, option, &parser_options->error_msg);
779 if (compiler_options_->instruction_set_features_ == nullptr) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100780 Usage("%s", parser_options->error_msg.c_str());
781 }
782 }
783
Andreas Gampe097f34c2017-08-23 08:57:51 -0700784 void ParseInstructionSetFeatures(const std::string& option, ParserOptions* parser_options) {
Vladimir Markoa0431112018-06-25 09:32:54 +0100785 if (compiler_options_->instruction_set_features_ == nullptr) {
786 compiler_options_->instruction_set_features_ = InstructionSetFeatures::FromVariant(
787 compiler_options_->instruction_set_, "default", &parser_options->error_msg);
788 if (compiler_options_->instruction_set_features_ == nullptr) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100789 Usage("Problem initializing default instruction set features variant: %s",
790 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700791 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800792 }
Vladimir Markoa0431112018-06-25 09:32:54 +0100793 compiler_options_->instruction_set_features_ =
794 compiler_options_->instruction_set_features_->AddFeaturesFromString(
795 option, &parser_options->error_msg);
796 if (compiler_options_->instruction_set_features_ == nullptr) {
Andreas Gampe097f34c2017-08-23 08:57:51 -0700797 Usage("Error parsing '%s': %s", option.c_str(), parser_options->error_msg.c_str());
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800798 }
799 }
800
Jeff Hao436183f2016-01-12 16:36:50 -0800801 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoa2da9b92018-10-10 14:21:55 +0100802 compiler_options_->compile_pic_ = true; // All AOT compilation is PIC.
Vladimir Marko21910692019-11-06 13:27:03 +0000803
804 if (android_root_.empty()) {
805 const char* android_root_env_var = getenv("ANDROID_ROOT");
806 if (android_root_env_var == nullptr) {
807 Usage("--android-root unspecified and ANDROID_ROOT not set");
808 }
809 android_root_ += android_root_env_var;
810 }
811
812 if (!parser_options->boot_image_filename.empty()) {
813 boot_image_filename_ = parser_options->boot_image_filename;
814 }
815
Vladimir Marko9c4b9702018-11-14 15:09:02 +0000816 DCHECK(compiler_options_->image_type_ == CompilerOptions::ImageType::kNone);
817 if (!image_filenames_.empty()) {
Vladimir Marko21910692019-11-06 13:27:03 +0000818 if (!boot_image_filename_.empty()) {
819 compiler_options_->image_type_ = CompilerOptions::ImageType::kBootImageExtension;
820 } else if (android::base::EndsWith(image_filenames_[0], "apex.art")) {
Nicolas Geoffrayc5e3a522019-04-30 09:47:55 +0100821 compiler_options_->image_type_ = CompilerOptions::ImageType::kApexBootImage;
822 } else {
823 compiler_options_->image_type_ = CompilerOptions::ImageType::kBootImage;
824 }
Vladimir Marko9c4b9702018-11-14 15:09:02 +0000825 }
826 if (app_image_fd_ != -1 || !app_image_file_name_.empty()) {
Vladimir Marko21910692019-11-06 13:27:03 +0000827 if (compiler_options_->IsBootImage() || compiler_options_->IsBootImageExtension()) {
Vladimir Marko9c4b9702018-11-14 15:09:02 +0000828 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
829 }
830 compiler_options_->image_type_ = CompilerOptions::ImageType::kAppImage;
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700831 }
832
Jeff Haodcdc85b2015-12-04 14:06:18 -0800833 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800834 Usage("Output must be supplied with either --oat-file or --oat-fd");
835 }
836
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000837 if (input_vdex_fd_ != -1 && !input_vdex_.empty()) {
838 Usage("Can't have both --input-vdex-fd and --input-vdex");
839 }
840
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +0100841 if (output_vdex_fd_ != -1 && !output_vdex_.empty()) {
842 Usage("Can't have both --output-vdex-fd and --output-vdex");
843 }
844
Jeff Haodcdc85b2015-12-04 14:06:18 -0800845 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800846 Usage("--oat-file should not be used with --oat-fd");
847 }
848
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000849 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
Sascha Roth5f71c652018-04-10 00:27:15 +0200850 Usage("VDEX and OAT output must be specified either with one --oat-file "
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000851 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100852 }
853
Roland Levillain9ec5e222015-08-17 20:18:41 +0100854 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800855 Usage("--oat-symbols should not be used with --oat-fd");
856 }
857
Roland Levillain9ec5e222015-08-17 20:18:41 +0100858 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800859 Usage("--oat-symbols should not be used with --host");
860 }
861
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000862 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
863 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100864 }
865
Jeff Haodcdc85b2015-12-04 14:06:18 -0800866 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800867 Usage("--oat-fd should not be used with --image");
868 }
869
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +0000870 if ((input_vdex_fd_ != -1 || !input_vdex_.empty()) &&
871 (dm_fd_ != -1 || !dm_file_location_.empty())) {
872 Usage("An input vdex should not be passed with a .dm file");
873 }
874
Jeff Haodcdc85b2015-12-04 14:06:18 -0800875 if (!parser_options->oat_symbols.empty() &&
876 parser_options->oat_symbols.size() != oat_filenames_.size()) {
877 Usage("--oat-file arguments do not match --oat-symbols arguments");
878 }
879
880 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
881 Usage("--oat-file arguments do not match --image arguments");
882 }
883
Vladimir Marko21910692019-11-06 13:27:03 +0000884 if (!IsBootImage() && boot_image_filename_.empty()) {
885 DCHECK(!IsBootImageExtension());
886 boot_image_filename_ = GetDefaultBootImageLocation(android_root_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800887 }
888
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800889 if (dex_filenames_.empty() && zip_fd_ == -1) {
890 Usage("Input must be supplied with either --dex-file or --zip-fd");
891 }
892
893 if (!dex_filenames_.empty() && zip_fd_ != -1) {
894 Usage("--dex-file should not be used with --zip-fd");
895 }
896
897 if (!dex_filenames_.empty() && !zip_location_.empty()) {
898 Usage("--dex-file should not be used with --zip-location");
899 }
900
901 if (dex_locations_.empty()) {
Vladimir Markod011d812018-11-29 12:35:24 +0000902 dex_locations_ = dex_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800903 } else if (dex_locations_.size() != dex_filenames_.size()) {
904 Usage("--dex-location arguments do not match --dex-file arguments");
905 }
906
Jeff Haodcdc85b2015-12-04 14:06:18 -0800907 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
908 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
909 Usage("--oat-file arguments must be singular or match --dex-file arguments");
910 }
911 }
912
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800913 if (zip_fd_ != -1 && zip_location_.empty()) {
914 Usage("--zip-location should be supplied with --zip-fd");
915 }
916
Vladimir Marko49b0f452015-12-10 13:49:19 +0000917 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800918 if (image_base_ == 0) {
Vladimir Marko66235942019-06-03 16:05:17 +0100919 Usage("Non-zero --base not specified for boot image");
920 }
921 } else {
922 if (image_base_ != 0) {
923 Usage("Non-zero --base specified for app image or boot image extension");
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800924 }
925 }
926
Mathieu Chartiera8077802016-03-16 19:08:31 -0700927 const bool have_profile_file = !profile_file_.empty();
928 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
929 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000930 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200931 }
932
Roland Levillain9ec5e222015-08-17 20:18:41 +0100933 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800934 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800935 }
936
xueliang.zhong7f88c1a2018-11-06 11:42:41 +0000937 if (compiler_options_->instruction_set_features_ == nullptr) {
938 // '--instruction-set-features/--instruction-set-variant' were not used.
939 // Use features for the 'default' variant.
Vladimir Markoa0431112018-06-25 09:32:54 +0100940 compiler_options_->instruction_set_features_ = InstructionSetFeatures::FromVariant(
941 compiler_options_->instruction_set_, "default", &parser_options->error_msg);
942 if (compiler_options_->instruction_set_features_ == nullptr) {
Ian Rogersd582fa42014-11-05 23:46:43 -0800943 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100944 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800945 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800946 }
947
Vladimir Markoa0431112018-06-25 09:32:54 +0100948 if (compiler_options_->instruction_set_ == kRuntimeISA) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800949 std::unique_ptr<const InstructionSetFeatures> runtime_features(
950 InstructionSetFeatures::FromCppDefines());
Vladimir Markoa0431112018-06-25 09:32:54 +0100951 if (!compiler_options_->GetInstructionSetFeatures()->Equals(runtime_features.get())) {
xueliang.zhong7f88c1a2018-11-06 11:42:41 +0000952 LOG(WARNING) << "Mismatch between dex2oat instruction set features to use ("
Vladimir Markoa0431112018-06-25 09:32:54 +0100953 << *compiler_options_->GetInstructionSetFeatures()
xueliang.zhong7f88c1a2018-11-06 11:42:41 +0000954 << ") and those from CPP defines (" << *runtime_features
Vladimir Markoa0431112018-06-25 09:32:54 +0100955 << ") for the command line:\n" << CommandLine();
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800956 }
957 }
958
Orion Hodsonffc791c2019-11-14 19:19:28 +0000959 if (!cpu_set_.empty()) {
960 SetCpuAffinity(cpu_set_);
961 }
962
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000963 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +0000964 compiler_options_->inline_max_code_units_ = CompilerOptions::kDefaultInlineMaxCodeUnits;
Roland Levillaina215b952015-08-07 11:38:32 +0100965 }
966
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800967 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800968 // Set the compilation target's implicit checks options.
Vladimir Markoa0431112018-06-25 09:32:54 +0100969 switch (compiler_options_->GetInstructionSet()) {
Vladimir Marko33bff252017-11-01 14:35:42 +0000970 case InstructionSet::kArm:
971 case InstructionSet::kThumb2:
972 case InstructionSet::kArm64:
973 case InstructionSet::kX86:
974 case InstructionSet::kX86_64:
975 case InstructionSet::kMips:
976 case InstructionSet::kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000977 compiler_options_->implicit_null_checks_ = true;
978 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800979 break;
980
981 default:
982 // Defaults are correct.
983 break;
984 }
985
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800986 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100987 if (parser_options->watch_dog_enabled) {
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800988 int64_t timeout = parser_options->watch_dog_timeout_in_ms > 0
989 ? parser_options->watch_dog_timeout_in_ms
990 : WatchDog::kDefaultWatchdogTimeoutInMS;
991 watchdog_.reset(new WatchDog(timeout));
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800992 }
993
994 // Fill some values into the key-value store for the oat header.
995 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800996
Vladimir Marko21910692019-11-06 13:27:03 +0000997 // Automatically force determinism for the boot image and boot image extensions in a host build.
998 if (!kIsTargetBuild && (IsBootImage() || IsBootImageExtension())) {
Vladimir Marko78342412019-07-25 17:28:02 +0100999 force_determinism_ = true;
Andreas Gampeace0dc12016-01-20 13:33:13 -08001000 }
1001 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07001002
1003 if (passes_to_run_filename_ != nullptr) {
Vladimir Marko54159c62018-06-20 14:30:08 +01001004 passes_to_run_ = ReadCommentedInputFromFile<std::vector<std::string>>(
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07001005 passes_to_run_filename_,
Vladimir Marko54159c62018-06-20 14:30:08 +01001006 nullptr); // No post-processing.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07001007 if (passes_to_run_.get() == nullptr) {
1008 Usage("Failed to read list of passes to run.");
1009 }
1010 }
1011 compiler_options_->passes_to_run_ = passes_to_run_.get();
Vladimir Marko6be1dbd2018-11-13 13:09:51 +00001012 compiler_options_->compiling_with_core_image_ =
1013 !boot_image_filename_.empty() &&
Vladimir Marko038924b2019-02-19 15:09:35 +00001014 CompilerOptions::IsCoreImageFilename(boot_image_filename_);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001015 }
1016
Jeff Hao436183f2016-01-12 16:36:50 -08001017 void ExpandOatAndImageFilenames() {
Vladimir Marko91f10322018-12-07 18:04:10 +00001018 if (image_filenames_[0].rfind('/') == std::string::npos) {
1019 Usage("Unusable boot image filename %s", image_filenames_[0].c_str());
Jeff Hao436183f2016-01-12 16:36:50 -08001020 }
Vladimir Marko21910692019-11-06 13:27:03 +00001021 image_filenames_ = ImageSpace::ExpandMultiImageLocations(
1022 ArrayRef<const std::string>(dex_locations_), image_filenames_[0], IsBootImageExtension());
Jeff Hao436183f2016-01-12 16:36:50 -08001023
Vladimir Marko91f10322018-12-07 18:04:10 +00001024 if (oat_filenames_[0].rfind('/') == std::string::npos) {
1025 Usage("Unusable boot image oat filename %s", oat_filenames_[0].c_str());
Vladimir Markodb4b1de2018-12-07 17:18:07 +00001026 }
Vladimir Marko21910692019-11-06 13:27:03 +00001027 oat_filenames_ = ImageSpace::ExpandMultiImageLocations(
1028 ArrayRef<const std::string>(dex_locations_), oat_filenames_[0], IsBootImageExtension());
Vladimir Markodb4b1de2018-12-07 17:18:07 +00001029
bowen_lai8bd36c02016-10-12 13:28:55 +08001030 if (!oat_unstripped_.empty()) {
Vladimir Marko91f10322018-12-07 18:04:10 +00001031 if (oat_unstripped_[0].rfind('/') == std::string::npos) {
1032 Usage("Unusable boot image symbol filename %s", oat_unstripped_[0].c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001033 }
Vladimir Marko21910692019-11-06 13:27:03 +00001034 oat_unstripped_ = ImageSpace::ExpandMultiImageLocations(
1035 ArrayRef<const std::string>(dex_locations_), oat_unstripped_[0], IsBootImageExtension());
bowen_lai8bd36c02016-10-12 13:28:55 +08001036 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001037 }
1038
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001039 void InsertCompileOptions(int argc, char** argv) {
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001040 if (!avoid_storing_invocation_) {
Vladimir Marko56581d82018-11-07 12:30:52 +00001041 std::ostringstream oss;
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001042 for (int i = 0; i < argc; ++i) {
1043 if (i > 0) {
1044 oss << ' ';
1045 }
1046 oss << argv[i];
Roland Levillain9ec5e222015-08-17 20:18:41 +01001047 }
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001048 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001049 }
Roland Levillain9ec5e222015-08-17 20:18:41 +01001050 key_value_store_->Put(
Roland Levillain9ec5e222015-08-17 20:18:41 +01001051 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001052 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001053 key_value_store_->Put(
1054 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001055 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001056 key_value_store_->Put(OatHeader::kCompilerFilter,
1057 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Andreas Gampef8cd8902017-01-18 16:05:01 -08001058 key_value_store_->Put(OatHeader::kConcurrentCopying,
1059 kUseReadBarrier ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Alex Light62afcf52018-12-18 14:19:25 -08001060 if (invocation_file_.get() != -1) {
1061 std::ostringstream oss;
1062 for (int i = 0; i < argc; ++i) {
1063 if (i > 0) {
1064 oss << std::endl;
1065 }
1066 oss << argv[i];
1067 }
1068 std::string invocation(oss.str());
1069 if (TEMP_FAILURE_RETRY(write(invocation_file_.get(),
1070 invocation.c_str(),
1071 invocation.size())) == -1) {
1072 Usage("Unable to write invocation file");
1073 }
1074 }
Roland Levillain9ec5e222015-08-17 20:18:41 +01001075 }
1076
Andreas Gampe097f34c2017-08-23 08:57:51 -07001077 // This simple forward is here so the string specializations below don't look out of place.
1078 template <typename T, typename U>
1079 void AssignIfExists(Dex2oatArgumentMap& map,
1080 const Dex2oatArgumentMap::Key<T>& key,
1081 U* out) {
1082 map.AssignIfExists(key, out);
1083 }
1084
1085 // Specializations to handle const char* vs std::string.
1086 void AssignIfExists(Dex2oatArgumentMap& map,
1087 const Dex2oatArgumentMap::Key<std::string>& key,
1088 const char** out) {
1089 if (map.Exists(key)) {
1090 char_backing_storage_.push_front(std::move(*map.Get(key)));
1091 *out = char_backing_storage_.front().c_str();
1092 }
1093 }
1094 void AssignIfExists(Dex2oatArgumentMap& map,
1095 const Dex2oatArgumentMap::Key<std::vector<std::string>>& key,
1096 std::vector<const char*>* out) {
1097 if (map.Exists(key)) {
1098 for (auto& val : *map.Get(key)) {
1099 char_backing_storage_.push_front(std::move(val));
1100 out->push_back(char_backing_storage_.front().c_str());
1101 }
1102 }
1103 }
1104
1105 template <typename T>
1106 void AssignTrueIfExists(Dex2oatArgumentMap& map,
1107 const Dex2oatArgumentMap::Key<T>& key,
1108 bool* out) {
1109 if (map.Exists(key)) {
1110 *out = true;
1111 }
1112 }
1113
Roland Levillain9ec5e222015-08-17 20:18:41 +01001114 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1115 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1116 // returns, arguments have been successfully parsed.
1117 void ParseArgs(int argc, char** argv) {
1118 original_argc = argc;
1119 original_argv = argv;
1120
David Sehrc431b9d2018-03-02 12:01:51 -08001121 Locks::Init();
Andreas Gampe51d80cc2017-06-21 21:05:13 -07001122 InitLogging(argv, Runtime::Abort);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001123
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001124 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001125
Andreas Gampe097f34c2017-08-23 08:57:51 -07001126 using M = Dex2oatArgumentMap;
1127 std::string error_msg;
1128 std::unique_ptr<M> args_uptr = M::Parse(argc, const_cast<const char**>(argv), &error_msg);
1129 if (args_uptr == nullptr) {
1130 Usage("Failed to parse command line: %s", error_msg.c_str());
1131 UNREACHABLE();
1132 }
1133
1134 M& args = *args_uptr;
1135
1136 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
1137
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07001138 AssignIfExists(args, M::CompactDexLevel, &compact_dex_level_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001139 AssignIfExists(args, M::DexFiles, &dex_filenames_);
1140 AssignIfExists(args, M::DexLocations, &dex_locations_);
1141 AssignIfExists(args, M::OatFiles, &oat_filenames_);
1142 AssignIfExists(args, M::OatSymbols, &parser_options->oat_symbols);
David Srbeckyde91fd42018-07-05 22:27:08 +01001143 AssignTrueIfExists(args, M::Strip, &strip_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001144 AssignIfExists(args, M::ImageFilenames, &image_filenames_);
1145 AssignIfExists(args, M::ZipFd, &zip_fd_);
1146 AssignIfExists(args, M::ZipLocation, &zip_location_);
1147 AssignIfExists(args, M::InputVdexFd, &input_vdex_fd_);
1148 AssignIfExists(args, M::OutputVdexFd, &output_vdex_fd_);
1149 AssignIfExists(args, M::InputVdex, &input_vdex_);
1150 AssignIfExists(args, M::OutputVdex, &output_vdex_);
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001151 AssignIfExists(args, M::DmFd, &dm_fd_);
1152 AssignIfExists(args, M::DmFile, &dm_file_location_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001153 AssignIfExists(args, M::OatFd, &oat_fd_);
1154 AssignIfExists(args, M::OatLocation, &oat_location_);
1155 AssignIfExists(args, M::Watchdog, &parser_options->watch_dog_enabled);
1156 AssignIfExists(args, M::WatchdogTimeout, &parser_options->watch_dog_timeout_in_ms);
1157 AssignIfExists(args, M::Threads, &thread_count_);
Orion Hodsonffc791c2019-11-14 19:19:28 +00001158 AssignIfExists(args, M::CpuSet, &cpu_set_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001159 AssignIfExists(args, M::Passes, &passes_to_run_filename_);
1160 AssignIfExists(args, M::BootImage, &parser_options->boot_image_filename);
1161 AssignIfExists(args, M::AndroidRoot, &android_root_);
1162 AssignIfExists(args, M::Profile, &profile_file_);
1163 AssignIfExists(args, M::ProfileFd, &profile_file_fd_);
1164 AssignIfExists(args, M::RuntimeOptions, &runtime_args_);
1165 AssignIfExists(args, M::SwapFile, &swap_file_name_);
1166 AssignIfExists(args, M::SwapFileFd, &swap_fd_);
1167 AssignIfExists(args, M::SwapDexSizeThreshold, &min_dex_file_cumulative_size_for_swap_);
1168 AssignIfExists(args, M::SwapDexCountThreshold, &min_dex_files_for_swap_);
1169 AssignIfExists(args, M::VeryLargeAppThreshold, &very_large_threshold_);
1170 AssignIfExists(args, M::AppImageFile, &app_image_file_name_);
1171 AssignIfExists(args, M::AppImageFileFd, &app_image_fd_);
1172 AssignIfExists(args, M::NoInlineFrom, &no_inline_from_string_);
1173 AssignIfExists(args, M::ClasspathDir, &classpath_dir_);
1174 AssignIfExists(args, M::DirtyImageObjects, &dirty_image_objects_filename_);
1175 AssignIfExists(args, M::ImageFormat, &image_storage_mode_);
Calin Juravle0e09dfc2018-02-12 19:01:09 -08001176 AssignIfExists(args, M::CompilationReason, &compilation_reason_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001177
1178 AssignIfExists(args, M::Backend, &compiler_kind_);
1179 parser_options->requested_specific_compiler = args.Exists(M::Backend);
1180
Vladimir Markoa0431112018-06-25 09:32:54 +01001181 AssignIfExists(args, M::TargetInstructionSet, &compiler_options_->instruction_set_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001182 // arm actually means thumb2.
Vladimir Markoa0431112018-06-25 09:32:54 +01001183 if (compiler_options_->instruction_set_ == InstructionSet::kArm) {
1184 compiler_options_->instruction_set_ = InstructionSet::kThumb2;
Andreas Gampe097f34c2017-08-23 08:57:51 -07001185 }
1186
1187 AssignTrueIfExists(args, M::Host, &is_host_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001188 AssignTrueIfExists(args, M::AvoidStoringInvocation, &avoid_storing_invocation_);
Alex Light62afcf52018-12-18 14:19:25 -08001189 if (args.Exists(M::InvocationFile)) {
1190 invocation_file_.reset(open(args.Get(M::InvocationFile)->c_str(),
1191 O_CREAT|O_WRONLY|O_TRUNC|O_CLOEXEC,
1192 S_IRUSR|S_IWUSR));
1193 if (invocation_file_.get() == -1) {
1194 int err = errno;
1195 Usage("Unable to open invocation file '%s' for writing due to %s.",
1196 args.Get(M::InvocationFile)->c_str(), strerror(err));
1197 }
1198 }
Mathieu Chartier792111c2018-02-15 13:02:15 -08001199 AssignIfExists(args, M::CopyDexFiles, &copy_dex_files_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001200
1201 if (args.Exists(M::ForceDeterminism)) {
Andreas Gampe097f34c2017-08-23 08:57:51 -07001202 force_determinism_ = true;
1203 }
1204
1205 if (args.Exists(M::Base)) {
1206 ParseBase(*args.Get(M::Base));
1207 }
1208 if (args.Exists(M::TargetInstructionSetVariant)) {
1209 ParseInstructionSetVariant(*args.Get(M::TargetInstructionSetVariant), parser_options.get());
1210 }
1211 if (args.Exists(M::TargetInstructionSetFeatures)) {
1212 ParseInstructionSetFeatures(*args.Get(M::TargetInstructionSetFeatures), parser_options.get());
1213 }
1214 if (args.Exists(M::ClassLoaderContext)) {
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001215 std::string class_loader_context_arg = *args.Get(M::ClassLoaderContext);
1216 class_loader_context_ = ClassLoaderContext::Create(class_loader_context_arg);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001217 if (class_loader_context_ == nullptr) {
1218 Usage("Option --class-loader-context has an incorrect format: %s",
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001219 class_loader_context_arg.c_str());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001220 }
David Brazdil89821862019-03-19 13:57:43 +00001221 if (args.Exists(M::ClassLoaderContextFds)) {
1222 std::string str_fds_arg = *args.Get(M::ClassLoaderContextFds);
1223 std::vector<std::string> str_fds = android::base::Split(str_fds_arg, ":");
1224 for (const std::string& str_fd : str_fds) {
1225 class_loader_context_fds_.push_back(std::stoi(str_fd, nullptr, 0));
1226 if (class_loader_context_fds_.back() < 0) {
1227 Usage("Option --class-loader-context-fds has incorrect format: %s",
1228 str_fds_arg.c_str());
1229 }
1230 }
1231 }
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001232 if (args.Exists(M::StoredClassLoaderContext)) {
Mathieu Chartierc4440772018-04-16 14:40:56 -07001233 const std::string stored_context_arg = *args.Get(M::StoredClassLoaderContext);
1234 stored_class_loader_context_ = ClassLoaderContext::Create(stored_context_arg);
1235 if (stored_class_loader_context_ == nullptr) {
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001236 Usage("Option --stored-class-loader-context has an incorrect format: %s",
Mathieu Chartierc4440772018-04-16 14:40:56 -07001237 stored_context_arg.c_str());
Vladimir Markod8860b42018-05-02 14:58:12 +01001238 } else if (class_loader_context_->VerifyClassLoaderContextMatch(
Mathieu Chartierc4440772018-04-16 14:40:56 -07001239 stored_context_arg,
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001240 /*verify_names*/ false,
Vladimir Markod8860b42018-05-02 14:58:12 +01001241 /*verify_checksums*/ false) != ClassLoaderContext::VerificationResult::kVerifies) {
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001242 Usage(
1243 "Option --stored-class-loader-context '%s' mismatches --class-loader-context '%s'",
Mathieu Chartierc4440772018-04-16 14:40:56 -07001244 stored_context_arg.c_str(),
1245 class_loader_context_arg.c_str());
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001246 }
1247 }
1248 } else if (args.Exists(M::StoredClassLoaderContext)) {
1249 Usage("Option --stored-class-loader-context should only be used if "
1250 "--class-loader-context is also specified");
Roland Levillain9ec5e222015-08-17 20:18:41 +01001251 }
1252
Andreas Gampe097f34c2017-08-23 08:57:51 -07001253 if (!ReadCompilerOptions(args, compiler_options_.get(), &error_msg)) {
1254 Usage(error_msg.c_str());
1255 }
1256
Jeff Hao436183f2016-01-12 16:36:50 -08001257 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001258
1259 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001260 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001261 }
1262
Jeff Haodcdc85b2015-12-04 14:06:18 -08001263 // Check whether the oat output files are writable, and open them for later. Also open a swap
1264 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001265 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001266 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1267 PruneNonExistentDexFiles();
1268
Jeff Hao436183f2016-01-12 16:36:50 -08001269 // Expand oat and image filenames for multi image.
Vladimir Marko21910692019-11-06 13:27:03 +00001270 if ((IsBootImage() || IsBootImageExtension()) && image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -08001271 ExpandOatAndImageFilenames();
1272 }
1273
David Brazdil7b49e6c2016-09-01 11:06:18 +01001274 // OAT and VDEX file handling
David Brazdil7b49e6c2016-09-01 11:06:18 +01001275 if (oat_fd_ == -1) {
1276 DCHECK(!oat_filenames_.empty());
Vladimir Markod011d812018-11-29 12:35:24 +00001277 for (const std::string& oat_filename : oat_filenames_) {
1278 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename.c_str()));
Calin Juravleb09be722017-09-25 16:42:48 -07001279 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001280 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1281 return false;
1282 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001283 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001284 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1285 oat_file->Erase();
1286 return false;
1287 }
1288 oat_files_.push_back(std::move(oat_file));
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001289 DCHECK_EQ(input_vdex_fd_, -1);
1290 if (!input_vdex_.empty()) {
1291 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001292 input_vdex_file_ = VdexFile::Open(input_vdex_,
1293 /* writable */ false,
1294 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001295 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001296 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001297 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001298
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001299 DCHECK_EQ(output_vdex_fd_, -1);
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001300 std::string vdex_filename = output_vdex_.empty()
1301 ? ReplaceFileExtension(oat_filename, "vdex")
1302 : output_vdex_;
1303 if (vdex_filename == input_vdex_ && output_vdex_.empty()) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001304 update_input_vdex_ = true;
1305 std::unique_ptr<File> vdex_file(OS::OpenFileReadWrite(vdex_filename.c_str()));
1306 vdex_files_.push_back(std::move(vdex_file));
1307 } else {
1308 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
Calin Juravleb09be722017-09-25 16:42:48 -07001309 if (vdex_file == nullptr) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001310 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1311 return false;
1312 }
1313 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1314 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1315 vdex_file->Erase();
1316 return false;
1317 }
1318 vdex_files_.push_back(std::move(vdex_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001319 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001320 }
1321 } else {
Josh Gaoafeec9f2018-08-30 14:05:56 -07001322 std::unique_ptr<File> oat_file(
1323 new File(DupCloexec(oat_fd_), oat_location_, /* check_usage */ true));
1324 if (!oat_file->IsOpened()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001325 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1326 return false;
1327 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001328 if (oat_file->SetLength(0) != 0) {
1329 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001330 oat_file->Erase();
1331 return false;
David Brazdil7b49e6c2016-09-01 11:06:18 +01001332 }
1333 oat_files_.push_back(std::move(oat_file));
1334
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001335 if (input_vdex_fd_ != -1) {
1336 struct stat s;
1337 int rc = TEMP_FAILURE_RETRY(fstat(input_vdex_fd_, &s));
1338 if (rc == -1) {
1339 PLOG(WARNING) << "Failed getting length of vdex file";
1340 } else {
1341 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001342 input_vdex_file_ = VdexFile::Open(input_vdex_fd_,
1343 s.st_size,
1344 "vdex",
1345 /* writable */ false,
1346 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001347 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001348 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001349 // If there's any problem with the passed vdex, just warn and proceed
1350 // without it.
1351 if (input_vdex_file_ == nullptr) {
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001352 PLOG(WARNING) << "Failed opening vdex file: " << error_msg;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001353 }
1354 }
1355 }
1356
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001357 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001358 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Josh Gaoafeec9f2018-08-30 14:05:56 -07001359 std::unique_ptr<File> vdex_file(new File(
1360 DupCloexec(output_vdex_fd_), vdex_location, /* check_usage */ true));
1361 if (!vdex_file->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001362 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001363 return false;
1364 }
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001365 if (input_vdex_file_ != nullptr && output_vdex_fd_ == input_vdex_fd_) {
1366 update_input_vdex_ = true;
1367 } else {
1368 if (vdex_file->SetLength(0) != 0) {
1369 PLOG(ERROR) << "Truncating vdex file " << vdex_location << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001370 vdex_file->Erase();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001371 return false;
1372 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001373 }
1374 vdex_files_.push_back(std::move(vdex_file));
1375
Vladimir Markod011d812018-11-29 12:35:24 +00001376 oat_filenames_.push_back(oat_location_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001377 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001378
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001379 // If we're updating in place a vdex file, be defensive and put an invalid vdex magic in case
1380 // dex2oat gets killed.
1381 // Note: we're only invalidating the magic data in the file, as dex2oat needs the rest of
1382 // the information to remain valid.
1383 if (update_input_vdex_) {
David Srbecky2faab002019-02-12 16:35:48 +00001384 std::unique_ptr<BufferedOutputStream> vdex_out =
1385 std::make_unique<BufferedOutputStream>(
1386 std::make_unique<FileOutputStream>(vdex_files_.back().get()));
Nicolas Geoffray3a293552018-03-02 10:52:16 +00001387 if (!vdex_out->WriteFully(&VdexFile::VerifierDepsHeader::kVdexInvalidMagic,
1388 arraysize(VdexFile::VerifierDepsHeader::kVdexInvalidMagic))) {
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001389 PLOG(ERROR) << "Failed to invalidate vdex header. File: " << vdex_out->GetLocation();
1390 return false;
1391 }
1392
1393 if (!vdex_out->Flush()) {
1394 PLOG(ERROR) << "Failed to flush stream after invalidating header of vdex file."
1395 << " File: " << vdex_out->GetLocation();
1396 return false;
1397 }
1398 }
1399
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001400 if (dm_fd_ != -1 || !dm_file_location_.empty()) {
1401 std::string error_msg;
1402 if (dm_fd_ != -1) {
1403 dm_file_.reset(ZipArchive::OpenFromFd(dm_fd_, "DexMetadata", &error_msg));
1404 } else {
1405 dm_file_.reset(ZipArchive::Open(dm_file_location_.c_str(), &error_msg));
1406 }
1407 if (dm_file_ == nullptr) {
1408 LOG(WARNING) << "Could not open DexMetadata archive " << error_msg;
1409 }
1410 }
1411
1412 if (dm_file_ != nullptr) {
1413 DCHECK(input_vdex_file_ == nullptr);
1414 std::string error_msg;
1415 static const char* kDexMetadata = "DexMetadata";
1416 std::unique_ptr<ZipEntry> zip_entry(dm_file_->Find(VdexFile::kVdexNameInDmFile, &error_msg));
1417 if (zip_entry == nullptr) {
1418 LOG(INFO) << "No " << VdexFile::kVdexNameInDmFile << " file in DexMetadata archive. "
1419 << "Not doing fast verification.";
1420 } else {
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001421 MemMap input_file = zip_entry->MapDirectlyOrExtract(
Mathieu Chartier792111c2018-02-15 13:02:15 -08001422 VdexFile::kVdexNameInDmFile,
1423 kDexMetadata,
Colin Cross2b41cca2018-11-16 22:43:41 -08001424 &error_msg,
1425 alignof(VdexFile));
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001426 if (!input_file.IsValid()) {
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001427 LOG(WARNING) << "Could not open vdex file in DexMetadata archive: " << error_msg;
1428 } else {
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001429 input_vdex_file_ = std::make_unique<VdexFile>(std::move(input_file));
Calin Juravle5ffefaa2019-01-25 01:04:54 -08001430 VLOG(verifier) << "Doing fast verification with vdex from DexMetadata archive";
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001431 }
1432 }
1433 }
1434
David Brazdil7b49e6c2016-09-01 11:06:18 +01001435 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001436 //
1437 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1438 // that we can use for swap.
1439 //
1440 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1441 // will immediately unlink to satisfy the swap fd assumption.
1442 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1443 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1444 if (swap_file.get() == nullptr) {
1445 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1446 return false;
1447 }
Josh Gaoafeec9f2018-08-30 14:05:56 -07001448 swap_fd_ = swap_file->Release();
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001449 unlink(swap_file_name_.c_str());
1450 }
Jeff Hao436183f2016-01-12 16:36:50 -08001451
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001452 return true;
1453 }
1454
David Brazdil7b49e6c2016-09-01 11:06:18 +01001455 void EraseOutputFiles() {
1456 for (auto& files : { &vdex_files_, &oat_files_ }) {
1457 for (size_t i = 0; i < files->size(); ++i) {
1458 if ((*files)[i].get() != nullptr) {
1459 (*files)[i]->Erase();
1460 (*files)[i].reset();
1461 }
1462 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001463 }
Andreas Gampea650e702014-12-03 14:28:02 -08001464 }
1465
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001466 void LoadClassProfileDescriptors() {
Mathieu Chartierf85b3db2018-04-02 18:16:21 -07001467 if (!IsImage()) {
1468 return;
1469 }
Mathieu Chartierf85b3db2018-04-02 18:16:21 -07001470 if (profile_compilation_info_ != nullptr) {
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001471 // TODO: The following comment looks outdated or misplaced.
Mathieu Chartier0b490842016-05-25 15:05:59 -07001472 // Filter out class path classes since we don't want to include these in the image.
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001473 HashSet<std::string> image_classes = profile_compilation_info_->GetClassDescriptors(
1474 compiler_options_->dex_files_for_oat_file_);
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001475 VLOG(compiler) << "Loaded " << image_classes.size()
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001476 << " image class descriptors from profile";
1477 if (VLOG_IS_ON(compiler)) {
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001478 for (const std::string& s : image_classes) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001479 LOG(INFO) << "Image class " << s;
1480 }
1481 }
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001482 compiler_options_->image_classes_.swap(image_classes);
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001483 }
1484 }
1485
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001486 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1487 // boot class path.
Andreas Gampef7882972017-03-20 16:35:24 -07001488 dex2oat::ReturnCode Setup() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001489 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001490
Mathieu Chartierf68b6982019-06-27 09:40:20 -07001491 if (!PrepareDirtyObjects()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001492 return dex2oat::ReturnCode::kOther;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001493 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001494
Vladimir Marko21910692019-11-06 13:27:03 +00001495 // Verification results are null since we don't know if we will need them yet as the compiler
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001496 // filter may change.
Andreas Gampe4585f872015-03-27 23:45:15 -07001497 callbacks_.reset(new QuickCompilerCallbacks(
Vladimir Marko21910692019-11-06 13:27:03 +00001498 // For class verification purposes, boot image extension is the same as boot image.
1499 (IsBootImage() || IsBootImageExtension())
1500 ? CompilerCallbacks::CallbackMode::kCompileBootImage
1501 : CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001502
Vladimir Marko49b0f452015-12-10 13:49:19 +00001503 RuntimeArgumentMap runtime_options;
Mathieu Chartier46331a62017-07-21 09:49:10 -07001504 if (!PrepareRuntimeOptions(&runtime_options, callbacks_.get())) {
Andreas Gampef7882972017-03-20 16:35:24 -07001505 return dex2oat::ReturnCode::kOther;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001506 }
1507
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001508 CreateOatWriters();
1509 if (!AddDexFileSources()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001510 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001511 }
1512
Vladimir Marko0866ea42019-10-15 12:04:17 +00001513 {
1514 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1515 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1516 // Unzip or copy dex files straight to the oat file.
1517 std::vector<MemMap> opened_dex_files_map;
1518 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
1519 // No need to verify the dex file when we have a vdex file, which means it was already
1520 // verified.
1521 const bool verify = (input_vdex_file_ == nullptr);
1522 if (!oat_writers_[i]->WriteAndOpenDexFiles(
1523 vdex_files_[i].get(),
1524 verify,
1525 update_input_vdex_,
1526 copy_dex_files_,
1527 &opened_dex_files_map,
1528 &opened_dex_files)) {
1529 return dex2oat::ReturnCode::kOther;
1530 }
1531 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1532 if (opened_dex_files_map.empty()) {
1533 DCHECK(opened_dex_files.empty());
1534 } else {
1535 for (MemMap& map : opened_dex_files_map) {
1536 opened_dex_files_maps_.push_back(std::move(map));
1537 }
1538 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
1539 dex_file_oat_index_map_.emplace(dex_file.get(), i);
1540 opened_dex_files_.push_back(std::move(dex_file));
1541 }
1542 }
1543 }
1544 }
1545
1546 compiler_options_->dex_files_for_oat_file_ = MakeNonOwningPointerVector(opened_dex_files_);
1547 const std::vector<const DexFile*>& dex_files = compiler_options_->dex_files_for_oat_file_;
1548
1549 // Check if we need to downgrade the compiler-filter for size reasons.
1550 // Note: This does not affect the compiler filter already stored in the key-value
1551 // store which is used for determining whether the oat file is up to date,
1552 // together with the boot class path locations and checksums stored below.
1553 CompilerFilter::Filter original_compiler_filter = compiler_options_->GetCompilerFilter();
Vladimir Marko21910692019-11-06 13:27:03 +00001554 if (!IsBootImage() && !IsBootImageExtension() && IsVeryLarge(dex_files)) {
Vladimir Marko0866ea42019-10-15 12:04:17 +00001555 // Disable app image to make sure dex2oat unloading is enabled.
1556 compiler_options_->image_type_ = CompilerOptions::ImageType::kNone;
1557
1558 // If we need to downgrade the compiler-filter for size reasons, do that early before we read
1559 // it below for creating verification callbacks.
1560 if (!CompilerFilter::IsAsGoodAs(kLargeAppFilter, compiler_options_->GetCompilerFilter())) {
1561 LOG(INFO) << "Very large app, downgrading to verify.";
1562 compiler_options_->SetCompilerFilter(kLargeAppFilter);
1563 }
1564 }
1565
1566 if (CompilerFilter::IsAnyCompilationEnabled(compiler_options_->GetCompilerFilter())) {
1567 // Only modes with compilation require verification results, do this here instead of when we
1568 // create the compilation callbacks since the compilation mode may have been changed by the
1569 // very large app logic.
1570 // Avoiding setting the verification results saves RAM by not adding the dex files later in
1571 // the function.
1572 // Note: When compiling boot image, this must be done before creating the Runtime.
1573 verification_results_.reset(new VerificationResults(compiler_options_.get()));
1574 callbacks_->SetVerificationResults(verification_results_.get());
1575 }
1576
Vladimir Marko21910692019-11-06 13:27:03 +00001577 if (IsBootImage() || IsBootImageExtension()) {
1578 // For boot image or boot image extension, pass opened dex files to the Runtime::Create().
Vladimir Marko0866ea42019-10-15 12:04:17 +00001579 // Note: Runtime acquires ownership of these dex files.
1580 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
1581 }
1582 if (!CreateRuntime(std::move(runtime_options))) {
1583 return dex2oat::ReturnCode::kCreateRuntime;
1584 }
Vladimir Marko21910692019-11-06 13:27:03 +00001585 ArrayRef<const DexFile* const> bcp_dex_files(runtime_->GetClassLinker()->GetBootClassPath());
1586 if (IsBootImage() || IsBootImageExtension()) {
1587 // Check boot class path dex files and, if compiling an extension, the images it depends on.
1588 if ((IsBootImage() && bcp_dex_files.size() != dex_files.size()) ||
1589 (IsBootImageExtension() && bcp_dex_files.size() <= dex_files.size())) {
1590 LOG(ERROR) << "Unexpected number of boot class path dex files for boot image or extension, "
1591 << bcp_dex_files.size() << (IsBootImage() ? " != " : " <= ") << dex_files.size();
1592 return dex2oat::ReturnCode::kOther;
1593 }
1594 if (!std::equal(dex_files.begin(), dex_files.end(), bcp_dex_files.end() - dex_files.size())) {
1595 LOG(ERROR) << "Boot class path dex files do not end with the compiled dex files.";
1596 return dex2oat::ReturnCode::kOther;
1597 }
1598 size_t bcp_df_pos = 0u;
1599 size_t bcp_df_end = bcp_dex_files.size();
1600 for (const std::string& bcp_location : runtime_->GetBootClassPathLocations()) {
1601 if (bcp_df_pos == bcp_df_end || bcp_dex_files[bcp_df_pos]->GetLocation() != bcp_location) {
1602 LOG(ERROR) << "Missing dex file for boot class component " << bcp_location;
1603 return dex2oat::ReturnCode::kOther;
1604 }
1605 CHECK(!DexFileLoader::IsMultiDexLocation(bcp_dex_files[bcp_df_pos]->GetLocation().c_str()));
1606 ++bcp_df_pos;
1607 while (bcp_df_pos != bcp_df_end &&
1608 DexFileLoader::IsMultiDexLocation(bcp_dex_files[bcp_df_pos]->GetLocation().c_str())) {
1609 ++bcp_df_pos;
1610 }
1611 }
1612 if (bcp_df_pos != bcp_df_end) {
1613 LOG(ERROR) << "Unexpected dex file in boot class path "
1614 << bcp_dex_files[bcp_df_pos]->GetLocation();
1615 return dex2oat::ReturnCode::kOther;
1616 }
1617 auto lacks_image = [](const DexFile* df) {
1618 if (kIsDebugBuild && df->GetOatDexFile() != nullptr) {
1619 const OatFile* oat_file = df->GetOatDexFile()->GetOatFile();
1620 CHECK(oat_file != nullptr);
1621 const auto& image_spaces = Runtime::Current()->GetHeap()->GetBootImageSpaces();
1622 CHECK(std::any_of(image_spaces.begin(),
1623 image_spaces.end(),
1624 [=](const ImageSpace* space) {
1625 return oat_file == space->GetOatFile();
1626 }));
1627 }
1628 return df->GetOatDexFile() == nullptr;
1629 };
1630 if (std::any_of(bcp_dex_files.begin(), bcp_dex_files.end() - dex_files.size(), lacks_image)) {
1631 LOG(ERROR) << "Missing required boot image(s) for boot image extension.";
1632 return dex2oat::ReturnCode::kOther;
1633 }
1634 }
Vladimir Marko0866ea42019-10-15 12:04:17 +00001635
Calin Juravle0e09dfc2018-02-12 19:01:09 -08001636 if (!compilation_reason_.empty()) {
1637 key_value_store_->Put(OatHeader::kCompilationReasonKey, compilation_reason_);
1638 }
1639
Vladimir Markoc10a0c62018-11-16 11:39:22 +00001640 if (IsBootImage()) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001641 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
Vladimir Marko91f10322018-12-07 18:04:10 +00001642 // We use this when loading the boot image.
1643 key_value_store_->Put(OatHeader::kBootClassPathKey, android::base::Join(dex_locations_, ':'));
Vladimir Marko21910692019-11-06 13:27:03 +00001644 } else if (IsBootImageExtension()) {
1645 // Validate the boot class path and record the dependency on the loaded boot images.
1646 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1647 Runtime* runtime = Runtime::Current();
1648 std::string full_bcp = android::base::Join(runtime->GetBootClassPathLocations(), ':');
1649 std::string extension_part = ":" + android::base::Join(dex_locations_, ':');
1650 if (!android::base::EndsWith(full_bcp, extension_part)) {
1651 LOG(ERROR) << "Full boot class path does not end with extension parts, full: " << full_bcp
1652 << ", extension: " << extension_part.substr(1u);
1653 return dex2oat::ReturnCode::kOther;
1654 }
1655 std::string bcp_dependency = full_bcp.substr(0u, full_bcp.size() - extension_part.size());
1656 key_value_store_->Put(OatHeader::kBootClassPathKey, bcp_dependency);
1657 ArrayRef<const DexFile* const> bcp_dex_files_dependency =
1658 bcp_dex_files.SubArray(/*pos=*/ 0u, bcp_dex_files.size() - dex_files.size());
1659 ArrayRef<ImageSpace* const> image_spaces(runtime->GetHeap()->GetBootImageSpaces());
1660 key_value_store_->Put(
1661 OatHeader::kBootClassPathChecksumsKey,
1662 gc::space::ImageSpace::GetBootClassPathChecksums(image_spaces, bcp_dex_files_dependency));
1663 } else {
Vladimir Marko0866ea42019-10-15 12:04:17 +00001664 if (CompilerFilter::DependsOnImageChecksum(original_compiler_filter)) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001665 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
Vladimir Marko0ace5632018-12-14 11:11:47 +00001666 Runtime* runtime = Runtime::Current();
1667 key_value_store_->Put(OatHeader::kBootClassPathKey,
1668 android::base::Join(runtime->GetBootClassPathLocations(), ':'));
Vladimir Marko436c6f52019-07-25 14:50:14 +01001669 ArrayRef<ImageSpace* const> image_spaces(runtime->GetHeap()->GetBootImageSpaces());
Vladimir Marko0ace5632018-12-14 11:11:47 +00001670 key_value_store_->Put(
1671 OatHeader::kBootClassPathChecksumsKey,
1672 gc::space::ImageSpace::GetBootClassPathChecksums(image_spaces, bcp_dex_files));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001673 }
1674
1675 // Open dex files for class path.
Calin Juravle19915892017-08-03 17:10:36 +00001676
Calin Juravle1ce70852017-06-28 10:59:03 -07001677 if (class_loader_context_ == nullptr) {
Calin Juravle19915892017-08-03 17:10:36 +00001678 // If no context was specified use the default one (which is an empty PathClassLoader).
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001679 class_loader_context_ = ClassLoaderContext::Default();
Jeff Haof0192c82016-03-28 20:39:50 -07001680 }
Calin Juravle19915892017-08-03 17:10:36 +00001681
Calin Juravle1ce70852017-06-28 10:59:03 -07001682 DCHECK_EQ(oat_writers_.size(), 1u);
1683
1684 // Note: Ideally we would reject context where the source dex files are also
1685 // specified in the classpath (as it doesn't make sense). However this is currently
1686 // needed for non-prebuild tests and benchmarks which expects on the fly compilation.
1687 // Also, for secondary dex files we do not have control on the actual classpath.
1688 // Instead of aborting, remove all the source location from the context classpaths.
1689 if (class_loader_context_->RemoveLocationsFromClassPaths(
1690 oat_writers_[0]->GetSourceLocations())) {
1691 LOG(WARNING) << "The source files to be compiled are also in the classpath.";
1692 }
1693
1694 // We need to open the dex files before encoding the context in the oat file.
1695 // (because the encoding adds the dex checksum...)
1696 // TODO(calin): consider redesigning this so we don't have to open the dex files before
1697 // creating the actual class loader.
David Brazdil89821862019-03-19 13:57:43 +00001698 if (!class_loader_context_->OpenDexFiles(runtime_->GetInstructionSet(),
1699 classpath_dir_,
1700 class_loader_context_fds_)) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001701 // Do not abort if we couldn't open files from the classpath. They might be
1702 // apks without dex files and right now are opening flow will fail them.
1703 LOG(WARNING) << "Failed to open classpath dex files";
1704 }
1705
1706 // Store the class loader context in the oat header.
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001707 // TODO: deprecate this since store_class_loader_context should be enough to cover the users
1708 // of classpath_dir as well.
Mathieu Chartierc4440772018-04-16 14:40:56 -07001709 std::string class_path_key =
1710 class_loader_context_->EncodeContextForOatFile(classpath_dir_,
1711 stored_class_loader_context_.get());
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001712 key_value_store_->Put(OatHeader::kClassPathKey, class_path_key);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001713 }
1714
Vladimir Marko4e6abea2019-10-23 10:20:20 +01001715 // Now that we have finalized key_value_store_, start writing the .rodata section.
1716 // Among other things, this creates type lookup tables that speed up the compilation.
1717 {
1718 TimingLogger::ScopedTiming t_dex("Starting .rodata", timings_);
1719 rodata_.reserve(oat_writers_.size());
1720 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1721 rodata_.push_back(elf_writers_[i]->StartRoData());
1722 if (!oat_writers_[i]->StartRoData(dex_files_per_oat_file_[i],
1723 rodata_.back(),
1724 (i == 0u) ? key_value_store_.get() : nullptr)) {
1725 return dex2oat::ReturnCode::kOther;
1726 }
1727 }
1728 }
1729
Andreas Gampe7386da42016-06-08 18:18:47 -07001730 // We had to postpone the swap decision till now, as this is the point when we actually
1731 // know about the dex files we're going to use.
1732
1733 // Make sure that we didn't create the driver, yet.
1734 CHECK(driver_ == nullptr);
1735 // If we use a swap file, ensure we are above the threshold to make it necessary.
1736 if (swap_fd_ != -1) {
Vladimir Marko21910692019-11-06 13:27:03 +00001737 if (!UseSwap(IsBootImage() || IsBootImageExtension(), dex_files)) {
Andreas Gampe7386da42016-06-08 18:18:47 -07001738 close(swap_fd_);
1739 swap_fd_ = -1;
1740 VLOG(compiler) << "Decided to run without swap.";
1741 } else {
1742 LOG(INFO) << "Large app, accepted running with swap.";
1743 }
1744 }
1745 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001746
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001747 // If we're doing the image, override the compiler filter to force full compilation. Must be
1748 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1749 // compilation of class initializers.
1750 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001751 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001752 WellKnownClasses::Init(self->GetJniEnv());
1753
Vladimir Marko21910692019-11-06 13:27:03 +00001754 if (!IsBootImage() && !IsBootImageExtension()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001755 constexpr bool kSaveDexInput = false;
1756 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001757 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001758 }
1759 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001760
1761 // Ensure opened dex files are writable for dex-to-dex transformations.
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001762 for (MemMap& map : opened_dex_files_maps_) {
1763 if (!map.Protect(PROT_READ | PROT_WRITE)) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001764 PLOG(ERROR) << "Failed to make .dex files writeable.";
Andreas Gampef7882972017-03-20 16:35:24 -07001765 return dex2oat::ReturnCode::kOther;
Vladimir Marko919f5532016-01-20 19:13:01 +00001766 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001767 }
1768
Mathieu Chartier72041a02017-07-14 18:23:25 -07001769 // Verification results are only required for modes that have any compilation. Avoid
1770 // adding the dex files if possible to prevent allocating large arrays.
1771 if (verification_results_ != nullptr) {
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001772 for (const auto& dex_file : dex_files) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001773 // Pre-register dex files so that we can access verification results without locks during
1774 // compilation and verification.
Mathieu Chartier0733dc82017-07-17 14:05:28 -07001775 verification_results_->AddDexFile(dex_file);
1776 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001777 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001778
Andreas Gampef7882972017-03-20 16:35:24 -07001779 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001780 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001781
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001782 // If we need to keep the oat file open for the image writer.
1783 bool ShouldKeepOatFileOpen() const {
1784 return IsImage() && oat_fd_ != kInvalidFd;
1785 }
1786
Mathieu Chartier72041a02017-07-14 18:23:25 -07001787 // Doesn't return the class loader since it's not meant to be used for image compilation.
1788 void CompileDexFilesIndividually() {
1789 CHECK(!IsImage()) << "Not supported with image";
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001790 for (const DexFile* dex_file : compiler_options_->dex_files_for_oat_file_) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001791 std::vector<const DexFile*> dex_files(1u, dex_file);
1792 VLOG(compiler) << "Compiling " << dex_file->GetLocation();
1793 jobject class_loader = CompileDexFiles(dex_files);
1794 CHECK(class_loader != nullptr);
1795 ScopedObjectAccess soa(Thread::Current());
1796 // Unload class loader to free RAM.
Ian Rogers55256cb2017-12-21 17:07:11 -08001797 jweak weak_class_loader = soa.Env()->GetVm()->AddWeakGlobalRef(
Mathieu Chartier72041a02017-07-14 18:23:25 -07001798 soa.Self(),
1799 soa.Decode<mirror::ClassLoader>(class_loader));
Ian Rogers55256cb2017-12-21 17:07:11 -08001800 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), class_loader);
Roland Levillainaf290312018-02-27 20:02:17 +00001801 runtime_->GetHeap()->CollectGarbage(/* clear_soft_references */ true);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001802 ObjPtr<mirror::ClassLoader> decoded_weak = soa.Decode<mirror::ClassLoader>(weak_class_loader);
1803 if (decoded_weak != nullptr) {
1804 LOG(FATAL) << "Failed to unload class loader, path from root set: "
1805 << runtime_->GetHeap()->GetVerification()->FirstPathFromRootSet(decoded_weak);
1806 }
1807 VLOG(compiler) << "Unloaded classloader";
1808 }
1809 }
1810
1811 bool ShouldCompileDexFilesIndividually() const {
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001812 // Compile individually if we are:
1813 // 1. not building an image,
1814 // 2. not verifying a vdex file,
1815 // 3. using multidex,
1816 // 4. not doing any AOT compilation.
1817 // This means extract, no-vdex verify, and quicken, will use the individual compilation
1818 // mode (to reduce RAM used by the compiler).
Mathieu Chartier72041a02017-07-14 18:23:25 -07001819 return !IsImage() &&
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001820 !update_input_vdex_ &&
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001821 compiler_options_->dex_files_for_oat_file_.size() > 1 &&
Mathieu Chartier6a2b67b2017-08-08 15:09:29 -07001822 !CompilerFilter::IsAotCompilationEnabled(compiler_options_->GetCompilerFilter());
Mathieu Chartier72041a02017-07-14 18:23:25 -07001823 }
1824
1825 // Set up and create the compiler driver and then invoke it to compile all the dex files.
1826 jobject Compile() {
1827 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1828
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001829 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001830
Vladimir Marko47496c22016-01-27 16:15:08 +00001831 // Find the dex files we should not inline from.
Vladimir Marko47496c22016-01-27 16:15:08 +00001832 std::vector<std::string> no_inline_filters;
1833 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001834
1835 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001836 const std::string core_oj = "core-oj";
1837 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1838 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001839 }
1840
Vladimir Marko47496c22016-01-27 16:15:08 +00001841 if (!no_inline_filters.empty()) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001842 std::vector<const DexFile*> class_path_files;
Vladimir Marko21910692019-11-06 13:27:03 +00001843 if (!IsBootImage() && !IsBootImageExtension()) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001844 // The class loader context is used only for apps.
1845 class_path_files = class_loader_context_->FlattenOpenedDexFiles();
1846 }
1847
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001848 const std::vector<const DexFile*>& dex_files = compiler_options_->dex_files_for_oat_file_;
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001849 std::vector<const DexFile*> no_inline_from_dex_files;
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001850 const std::vector<const DexFile*>* dex_file_vectors[] = {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001851 &class_linker->GetBootClassPath(),
1852 &class_path_files,
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001853 &dex_files
Jeff Haodcdc85b2015-12-04 14:06:18 -08001854 };
1855 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001856 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001857 for (const std::string& filter : no_inline_filters) {
1858 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
Calin Juravlea308a322017-07-18 16:51:51 -07001859 // allows tests to specify <test-dexfile>!classes2.dex if needed but if the
Vladimir Marko47496c22016-01-27 16:15:08 +00001860 // base location passes the StartsWith() test, so do all extra locations.
1861 std::string dex_location = dex_file->GetLocation();
1862 if (filter.find('/') == std::string::npos) {
1863 // The filter does not contain the path. Remove the path from dex_location as well.
1864 size_t last_slash = dex_file->GetLocation().rfind('/');
1865 if (last_slash != std::string::npos) {
1866 dex_location = dex_location.substr(last_slash + 1);
1867 }
1868 }
1869
Andreas Gampe9186ced2016-12-12 14:28:21 -08001870 if (android::base::StartsWith(dex_location, filter.c_str())) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001871 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001872 no_inline_from_dex_files.push_back(dex_file);
Vladimir Marko47496c22016-01-27 16:15:08 +00001873 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001874 }
1875 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001876 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001877 }
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001878 if (!no_inline_from_dex_files.empty()) {
1879 compiler_options_->no_inline_from_.swap(no_inline_from_dex_files);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001880 }
1881 }
Vladimir Marko1a2a5cd2018-11-07 15:39:48 +00001882 compiler_options_->profile_compilation_info_ = profile_compilation_info_.get();
Jeff Haodcdc85b2015-12-04 14:06:18 -08001883
Vladimir Marko307dac92015-10-20 11:20:09 +01001884 driver_.reset(new CompilerDriver(compiler_options_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001885 compiler_kind_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001886 thread_count_,
Vladimir Marko1a2a5cd2018-11-07 15:39:48 +00001887 swap_fd_));
Vladimir Marko21910692019-11-06 13:27:03 +00001888 if (!IsBootImage() && !IsBootImageExtension()) {
Nicolas Geoffray486dda02017-09-11 14:15:52 +01001889 driver_->SetClasspathDexFiles(class_loader_context_->FlattenOpenedDexFiles());
1890 }
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001891
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001892 const bool compile_individually = ShouldCompileDexFilesIndividually();
1893 if (compile_individually) {
1894 // Set the compiler driver in the callbacks so that we can avoid re-verification. This not
1895 // only helps performance but also prevents reverifying quickened bytecodes. Attempting
1896 // verify quickened bytecode causes verification failures.
1897 // Only set the compiler filter if we are doing separate compilation since there is a bit
1898 // of overhead when checking if a class was previously verified.
1899 callbacks_->SetDoesClassUnloading(true, driver_.get());
1900 }
1901
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001902 // Setup vdex for compilation.
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001903 const std::vector<const DexFile*>& dex_files = compiler_options_->dex_files_for_oat_file_;
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001904 if (!DoEagerUnquickeningOfVdex() && input_vdex_file_ != nullptr) {
1905 callbacks_->SetVerifierDeps(
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001906 new verifier::VerifierDeps(dex_files, input_vdex_file_->GetVerifierDepsData()));
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001907
1908 // TODO: we unquicken unconditionally, as we don't know
1909 // if the boot image has changed. How exactly we'll know is under
1910 // experimentation.
1911 TimingLogger::ScopedTiming time_unquicken("Unquicken", timings_);
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +03001912
1913 // We do not decompile a RETURN_VOID_NO_BARRIER into a RETURN_VOID, as the quickening
1914 // optimization does not depend on the boot image (the optimization relies on not
1915 // having final fields in a class, which does not change for an app).
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001916 input_vdex_file_->Unquicken(dex_files, /* decompile_return_instruction */ false);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001917 } else {
1918 // Create the main VerifierDeps, here instead of in the compiler since we want to aggregate
1919 // the results for all the dex files, not just the results for the current dex file.
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001920 callbacks_->SetVerifierDeps(new verifier::VerifierDeps(dex_files));
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001921 }
Mathieu Chartier72041a02017-07-14 18:23:25 -07001922 // Invoke the compilation.
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001923 if (compile_individually) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001924 CompileDexFilesIndividually();
1925 // Return a null classloader since we already freed released it.
1926 return nullptr;
1927 }
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001928 return CompileDexFiles(dex_files);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001929 }
1930
1931 // Create the class loader, use it to compile, and return.
1932 jobject CompileDexFiles(const std::vector<const DexFile*>& dex_files) {
1933 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1934
1935 jobject class_loader = nullptr;
Vladimir Marko21910692019-11-06 13:27:03 +00001936 if (!IsBootImage() && !IsBootImageExtension()) {
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001937 class_loader =
1938 class_loader_context_->CreateClassLoader(compiler_options_->dex_files_for_oat_file_);
Vladimir Markoa879bdf2019-11-19 16:25:47 +00001939 }
1940 if (!IsBootImage()) {
Andreas Gampee9934582018-01-19 21:23:04 -08001941 callbacks_->SetDexFiles(&dex_files);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001942 }
1943
1944 // Register dex caches and key them to the class loader so that they only unload when the
1945 // class loader unloads.
1946 for (const auto& dex_file : dex_files) {
1947 ScopedObjectAccess soa(Thread::Current());
1948 // Registering the dex cache adds a strong root in the class loader that prevents the dex
1949 // cache from being unloaded early.
1950 ObjPtr<mirror::DexCache> dex_cache = class_linker->RegisterDexFile(
1951 *dex_file,
1952 soa.Decode<mirror::ClassLoader>(class_loader));
1953 if (dex_cache == nullptr) {
1954 soa.Self()->AssertPendingException();
1955 LOG(FATAL) << "Failed to register dex file " << dex_file->GetLocation() << " "
1956 << soa.Self()->GetException()->Dump();
1957 }
1958 }
Vladimir Marko2afaff72018-11-30 17:01:50 +00001959 driver_->InitializeThreadPools();
1960 driver_->PreCompile(class_loader,
1961 dex_files,
1962 timings_,
1963 &compiler_options_->image_classes_,
1964 verification_results_.get());
1965 callbacks_->SetVerificationResults(nullptr); // Should not be needed anymore.
1966 compiler_options_->verification_results_ = verification_results_.get();
Mathieu Chartier72041a02017-07-14 18:23:25 -07001967 driver_->CompileAll(class_loader, dex_files, timings_);
Vladimir Marko2afaff72018-11-30 17:01:50 +00001968 driver_->FreeThreadPools();
Mathieu Chartier72041a02017-07-14 18:23:25 -07001969 return class_loader;
Vladimir Markof4da6752014-08-01 19:04:18 +01001970 }
1971
Jeff Hao436183f2016-01-12 16:36:50 -08001972 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001973 // ensure the references between the two are correct.
1974 //
1975 // Currently we have a memory layout that looks something like this:
1976 //
1977 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001978 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001979 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001980 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001981 // +--------------+
1982 // | alloc spaces |
1983 // +--------------+
1984 //
Jeff Hao436183f2016-01-12 16:36:50 -08001985 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001986 //
Jeff Hao436183f2016-01-12 16:36:50 -08001987 // 1. The images are expected to be loaded at an absolute address and
1988 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001989 //
Jeff Hao436183f2016-01-12 16:36:50 -08001990 // 2. There are absolute pointers from Methods in the images to their
1991 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001992 //
Jeff Hao436183f2016-01-12 16:36:50 -08001993 // 3. There are absolute pointers from the code in the oat files to Methods
1994 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001995 //
Jeff Hao436183f2016-01-12 16:36:50 -08001996 // 4. There are absolute pointers from code in the oat files to other code
1997 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001998 //
1999 // To get this all correct, we go through several steps.
2000 //
Jeff Hao436183f2016-01-12 16:36:50 -08002001 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01002002 // the oat data size and code size. During this stage, we also set
2003 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07002004 //
Jeff Hao436183f2016-01-12 16:36:50 -08002005 // 2. We prepare offsets for the objects in the images and calculate
2006 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01002007 //
Jeff Hao436183f2016-01-12 16:36:50 -08002008 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01002009 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08002010 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01002011 // can prepare the ELF headers and we then know the ELF memory segment
2012 // layout and we can now resolve all references. The compiler provides
2013 // LinkerPatch information in each CompiledMethod and we resolve these,
2014 // using the layout information and image object locations provided by
2015 // image writer, as we're writing the method code.
2016 //
Jeff Hao436183f2016-01-12 16:36:50 -08002017 // 4. We create the image files. They need to know where the oat files
2018 // will be loaded after itself. Originally oat files were simply
2019 // memory mapped so we could predict where their contents were based
2020 // on the file size. Now that they are ELF files, we need to inspect
2021 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01002022 // where the oat header is located within.
2023 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07002024 //
Vladimir Markof4da6752014-08-01 19:04:18 +01002025 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07002026 // load the .so at the desired location at runtime by offsetting the
2027 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01002028 // TODO: Do this in step 3. We already know the layout there.
2029 //
2030 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
2031 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002032
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002033 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
2034 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002035 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
2036 // case (when the file will be explicitly erased).
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002037 bool WriteOutputFiles(jobject class_loader) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002038 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
2039
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002040 // Sync the data to the file, in case we did dex2dex transformations.
Vladimir Markoc34bebf2018-08-16 16:12:49 +01002041 for (MemMap& map : opened_dex_files_maps_) {
2042 if (!map.Sync()) {
2043 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map.GetName();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002044 return false;
2045 }
2046 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002047
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002048 if (IsImage()) {
Vladimir Marko66235942019-06-03 16:05:17 +01002049 if (!IsBootImage()) {
2050 DCHECK_EQ(image_base_, 0u);
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002051 gc::Heap* const heap = Runtime::Current()->GetHeap();
Vladimir Marko66235942019-06-03 16:05:17 +01002052 image_base_ = heap->GetBootImagesStartAddress() + heap->GetBootImagesSize();
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002053 }
Vladimir Marko66235942019-06-03 16:05:17 +01002054 VLOG(compiler) << "Image base=" << reinterpret_cast<void*>(image_base_);
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002055
Vladimir Markoa0431112018-06-25 09:32:54 +01002056 image_writer_.reset(new linker::ImageWriter(*compiler_options_,
Vladimir Marko74527972016-11-29 15:57:32 +00002057 image_base_,
Vladimir Marko74527972016-11-29 15:57:32 +00002058 image_storage_mode_,
2059 oat_filenames_,
2060 dex_file_oat_index_map_,
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002061 class_loader,
Vladimir Marko74527972016-11-29 15:57:32 +00002062 dirty_image_objects_.get()));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002063
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002064 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002065 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
Mathieu Chartier703b82a2018-04-10 15:52:32 -07002066 if (!image_writer_->PrepareImageAddressSpace(timings_)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002067 LOG(ERROR) << "Failed to prepare image address space.";
2068 return false;
2069 }
2070 }
2071
Vladimir Marko4e6abea2019-10-23 10:20:20 +01002072 // Initialize the writers with the compiler driver, image writer, and their
2073 // dex files. The writers were created without those being there yet.
2074 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
2075 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
2076 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
2077 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002078 }
2079
David Brazdil5d5a36b2016-09-14 15:34:10 +01002080 {
2081 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
Vladimir Marko21910692019-11-06 13:27:03 +00002082 DCHECK(IsBootImage() || IsBootImageExtension() || oat_files_.size() == 1u);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00002083 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
David Brazdil5d5a36b2016-09-14 15:34:10 +01002084 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
2085 File* vdex_file = vdex_files_[i].get();
David Srbecky2faab002019-02-12 16:35:48 +00002086 std::unique_ptr<BufferedOutputStream> vdex_out =
2087 std::make_unique<BufferedOutputStream>(
2088 std::make_unique<FileOutputStream>(vdex_file));
David Brazdil5d5a36b2016-09-14 15:34:10 +01002089
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00002090 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002091 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
2092 return false;
2093 }
2094
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002095 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
2096 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
2097 return false;
2098 }
2099
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +00002100 // VDEX finalized, seek back to the beginning and write checksums and the header.
2101 if (!oat_writers_[i]->WriteChecksumsAndVdexHeader(vdex_out.get())) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002102 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
2103 return false;
2104 }
2105 }
2106 }
2107
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002108 {
2109 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Vladimir Markoa0431112018-06-25 09:32:54 +01002110 linker::MultiOatRelativePatcher patcher(compiler_options_->GetInstructionSet(),
2111 compiler_options_->GetInstructionSetFeatures(),
Vladimir Markoca1e0382018-04-11 09:58:41 +00002112 driver_->GetCompiledMethodStorage());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002113 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00002114 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2115 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko944da602016-02-19 12:27:55 +00002116
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002117 oat_writer->PrepareLayout(&patcher);
Vladimir Markob066d432018-01-03 13:14:37 +00002118 elf_writer->PrepareDynamicSection(oat_writer->GetOatHeader().GetExecutableOffset(),
2119 oat_writer->GetCodeSize(),
2120 oat_writer->GetDataBimgRelRoSize(),
Vladimir Markoaad75c62016-10-03 08:46:48 +00002121 oat_writer->GetBssSize(),
Vladimir Marko0eb882b2017-05-15 13:39:18 +01002122 oat_writer->GetBssMethodsOffset(),
David Srbeckyec2cdf42017-12-08 16:21:25 +00002123 oat_writer->GetBssRootsOffset(),
2124 oat_writer->GetVdexSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002125 if (IsImage()) {
2126 // Update oat layout.
2127 DCHECK(image_writer_ != nullptr);
2128 DCHECK_LT(i, oat_filenames_.size());
2129 image_writer_->UpdateOatFileLayout(i,
2130 elf_writer->GetLoadedSize(),
2131 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01002132 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002133 }
2134 }
2135
2136 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002137 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko74527972016-11-29 15:57:32 +00002138 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2139 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00002140
David Srbecky0c4572e2016-01-22 19:19:25 +00002141 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00002142 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
David Srbecky32210b92017-12-04 14:39:21 +00002143 debug::DebugInfo debug_info = oat_writer->GetDebugInfo(); // Keep the variable alive.
2144 elf_writer->PrepareDebugInfo(debug_info); // Processes the data on background thread.
David Srbecky0c4572e2016-01-22 19:19:25 +00002145
Vladimir Marko0866ea42019-10-15 12:04:17 +00002146 OutputStream* rodata = rodata_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002147 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002148 if (!oat_writer->WriteRodata(rodata)) {
2149 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
2150 return false;
2151 }
2152 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002153 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00002154
David Srbecky2faab002019-02-12 16:35:48 +00002155 OutputStream* text = elf_writer->StartText();
Jeff Haodcdc85b2015-12-04 14:06:18 -08002156 if (!oat_writer->WriteCode(text)) {
2157 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
2158 return false;
2159 }
2160 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00002161
Vladimir Markob066d432018-01-03 13:14:37 +00002162 if (oat_writer->GetDataBimgRelRoSize() != 0u) {
David Srbecky2faab002019-02-12 16:35:48 +00002163 OutputStream* data_bimg_rel_ro = elf_writer->StartDataBimgRelRo();
Vladimir Markob066d432018-01-03 13:14:37 +00002164 if (!oat_writer->WriteDataBimgRelRo(data_bimg_rel_ro)) {
2165 LOG(ERROR) << "Failed to write .data.bimg.rel.ro section to the ELF file "
2166 << oat_file->GetPath();
2167 return false;
2168 }
2169 elf_writer->EndDataBimgRelRo(data_bimg_rel_ro);
2170 }
2171
Vladimir Marko0ace5632018-12-14 11:11:47 +00002172 if (!oat_writer->WriteHeader(elf_writer->GetStream())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002173 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
2174 return false;
2175 }
2176
Vladimir Marko944da602016-02-19 12:27:55 +00002177 if (IsImage()) {
2178 // Update oat header information.
2179 DCHECK(image_writer_ != nullptr);
2180 DCHECK_LT(i, oat_filenames_.size());
2181 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
2182 }
2183
Jeff Haodcdc85b2015-12-04 14:06:18 -08002184 elf_writer->WriteDynamicSection();
David Srbecky32210b92017-12-04 14:39:21 +00002185 elf_writer->WriteDebugInfo(oat_writer->GetDebugInfo());
Vladimir Marko10c13562015-11-25 14:33:36 +00002186
Jeff Haodcdc85b2015-12-04 14:06:18 -08002187 if (!elf_writer->End()) {
2188 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
2189 return false;
2190 }
2191
David Brazdil7b49e6c2016-09-01 11:06:18 +01002192 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
2193 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002194 }
2195
Jeff Haodcdc85b2015-12-04 14:06:18 -08002196 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002197
2198 oat_writer.reset();
David Srbeckyde91fd42018-07-05 22:27:08 +01002199 // We may still need the ELF writer later for stripping.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002200 }
2201 }
2202
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002203 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002204 }
2205
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002206 // If we are compiling an image, invoke the image creation routine. Else just skip.
2207 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002208 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002209 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
2210 if (!CreateImageFile()) {
2211 return false;
2212 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002213 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07002214 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002215 return true;
2216 }
2217
David Srbeckyde91fd42018-07-05 22:27:08 +01002218 // Copy the full oat files to symbols directory and then strip the originals.
2219 bool CopyOatFilesToSymbolsDirectoryAndStrip() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002220 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
2221 // If we don't want to strip in place, copy from stripped location to unstripped location.
2222 // We need to strip after image creation because FixupElf needs to use .strtab.
Vladimir Markod011d812018-11-29 12:35:24 +00002223 if (oat_unstripped_[i] != oat_filenames_[i]) {
David Srbeckyde91fd42018-07-05 22:27:08 +01002224 DCHECK(oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002225
2226 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
David Srbeckyde91fd42018-07-05 22:27:08 +01002227 std::unique_ptr<File>& in = oat_files_[i];
Vladimir Markod011d812018-11-29 12:35:24 +00002228 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i].c_str()));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01002229 int64_t in_length = in->GetLength();
2230 if (in_length < 0) {
2231 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
2232 return false;
2233 }
2234 if (!out->Copy(in.get(), 0, in_length)) {
2235 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
2236 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002237 }
2238 if (out->FlushCloseOrErase() != 0) {
2239 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
2240 return false;
2241 }
2242 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
David Srbeckyde91fd42018-07-05 22:27:08 +01002243
2244 if (strip_) {
2245 TimingLogger::ScopedTiming t2("dex2oat OatFile strip", timings_);
2246 if (!elf_writers_[i]->StripDebugInfo()) {
2247 PLOG(ERROR) << "Failed strip oat file: " << in->GetPath();
2248 return false;
2249 }
2250 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002251 }
2252 }
2253 return true;
2254 }
2255
David Brazdil7b49e6c2016-09-01 11:06:18 +01002256 bool FlushOutputFile(std::unique_ptr<File>* file) {
2257 if (file->get() != nullptr) {
2258 if (file->get()->Flush() != 0) {
2259 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
2260 return false;
2261 }
2262 }
2263 return true;
2264 }
2265
David Srbeckyde91fd42018-07-05 22:27:08 +01002266 bool FlushCloseOutputFile(File* file) {
2267 if (file != nullptr) {
2268 if (file->FlushCloseOrErase() != 0) {
2269 PLOG(ERROR) << "Failed to flush and close output file: " << file->GetPath();
David Brazdil7b49e6c2016-09-01 11:06:18 +01002270 return false;
2271 }
2272 }
2273 return true;
2274 }
2275
2276 bool FlushOutputFiles() {
2277 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
2278 for (auto& files : { &vdex_files_, &oat_files_ }) {
2279 for (size_t i = 0; i < files->size(); ++i) {
2280 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002281 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08002282 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002283 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00002284 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002285 return true;
2286 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002287
David Brazdil7b49e6c2016-09-01 11:06:18 +01002288 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002289 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002290 for (auto& files : { &vdex_files_, &oat_files_ }) {
2291 for (size_t i = 0; i < files->size(); ++i) {
David Srbeckyde91fd42018-07-05 22:27:08 +01002292 result &= FlushCloseOutputFile((*files)[i].get());
David Brazdil7b49e6c2016-09-01 11:06:18 +01002293 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002294 }
2295 return result;
2296 }
2297
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002298 void DumpTiming() {
Nicolas Geoffray2d8801f2017-11-28 15:50:07 +00002299 if (compiler_options_->GetDumpTimings() ||
2300 (kIsDebugBuild && timings_->GetTotalNs() > MsToNs(1000))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002301 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2302 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002303 }
2304
Andreas Gampe10e477d2014-11-19 12:57:42 -08002305 bool IsImage() const {
Vladimir Marko21910692019-11-06 13:27:03 +00002306 return IsAppImage() || IsBootImage() || IsBootImageExtension();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002307 }
2308
2309 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002310 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002311 }
2312
2313 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002314 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002315 }
2316
Vladimir Marko21910692019-11-06 13:27:03 +00002317 bool IsBootImageExtension() const {
2318 return compiler_options_->IsBootImageExtension();
2319 }
2320
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002321 bool IsHost() const {
2322 return is_host_;
2323 }
2324
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002325 bool UseProfile() const {
Mathieu Chartierd0af56c2017-02-17 12:56:25 -08002326 return profile_file_fd_ != -1 || !profile_file_.empty();
Calin Juravle998c2162015-12-21 15:39:33 +02002327 }
2328
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002329 bool DoProfileGuidedOptimizations() const {
Nicolas Geoffray49cda062017-04-21 13:08:25 +01002330 return UseProfile();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002331 }
2332
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002333 bool DoGenerateCompactDex() const {
2334 return compact_dex_level_ != CompactDexLevel::kCompactDexLevelNone;
2335 }
2336
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002337 bool DoDexLayoutOptimizations() const {
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002338 return DoProfileGuidedOptimizations() || DoGenerateCompactDex();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002339 }
2340
Igor Murashkin545412b2017-08-17 15:26:54 -07002341 bool DoOatLayoutOptimizations() const {
2342 return DoProfileGuidedOptimizations();
2343 }
2344
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002345 bool MayInvalidateVdexMetadata() const {
2346 // DexLayout can invalidate the vdex metadata if changing the class def order is enabled, so
2347 // we need to unquicken the vdex file eagerly, before passing it to dexlayout.
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01002348 return DoDexLayoutOptimizations();
2349 }
2350
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002351 bool DoEagerUnquickeningOfVdex() const {
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00002352 return MayInvalidateVdexMetadata() && dm_file_ == nullptr;
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002353 }
2354
Calin Juravle2e2db782016-02-23 12:00:03 +00002355 bool LoadProfile() {
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002356 DCHECK(UseProfile());
Calin Juravlee6f87cc2017-05-24 17:41:05 -07002357 // TODO(calin): We should be using the runtime arena pool (instead of the
2358 // default profile arena). However the setup logic is messy and needs
2359 // cleaning up before that (e.g. the oat writers are created before the
2360 // runtime).
Calin Juravle2e2db782016-02-23 12:00:03 +00002361 profile_compilation_info_.reset(new ProfileCompilationInfo());
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002362 ScopedFlock profile_file;
Calin Juravle2e2db782016-02-23 12:00:03 +00002363 std::string error;
2364 if (profile_file_fd_ != -1) {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002365 profile_file = LockedFile::DupOf(profile_file_fd_, "profile",
2366 true /* read_only_mode */, &error);
Andreas Gampe29d38e72016-03-23 15:31:51 +00002367 } else if (profile_file_ != "") {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002368 profile_file = LockedFile::Open(profile_file_.c_str(), O_RDONLY, true, &error);
Calin Juravle998c2162015-12-21 15:39:33 +02002369 }
Calin Juravle877fd962016-01-05 14:29:29 +00002370
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002371 // Return early if we're unable to obtain a lock on the profile.
2372 if (profile_file.get() == nullptr) {
2373 LOG(ERROR) << "Cannot lock profiles: " << error;
2374 return false;
2375 }
2376
2377 if (!profile_compilation_info_->Load(profile_file->Fd())) {
Calin Juravle2e2db782016-02-23 12:00:03 +00002378 profile_compilation_info_.reset(nullptr);
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002379 return false;
Calin Juravle2e2db782016-02-23 12:00:03 +00002380 }
Calin Juravle877fd962016-01-05 14:29:29 +00002381
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002382 return true;
Calin Juravle998c2162015-12-21 15:39:33 +02002383 }
2384
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002385 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002386 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2387 if (is_image) {
2388 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2389 return false;
2390 }
2391 if (dex_files.size() < min_dex_files_for_swap_) {
2392 // If there are less dex files than the threshold, assume it's gonna be fine.
2393 return false;
2394 }
2395 size_t dex_files_size = 0;
2396 for (const auto* dex_file : dex_files) {
2397 dex_files_size += dex_file->GetHeader().file_size_;
2398 }
2399 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2400 }
2401
Vladimir Marko213ee2d2018-06-22 11:56:34 +01002402 bool IsVeryLarge(const std::vector<const DexFile*>& dex_files) {
Andreas Gampe67f02822016-06-24 21:05:23 -07002403 size_t dex_files_size = 0;
2404 for (const auto* dex_file : dex_files) {
2405 dex_files_size += dex_file->GetHeader().file_size_;
2406 }
2407 return dex_files_size >= very_large_threshold_;
2408 }
2409
Jeff Haoc23b0c02017-07-27 18:19:38 -07002410 bool PrepareDirtyObjects() {
2411 if (dirty_image_objects_filename_ != nullptr) {
Vladimir Marko54159c62018-06-20 14:30:08 +01002412 dirty_image_objects_ = ReadCommentedInputFromFile<HashSet<std::string>>(
Jeff Haoc23b0c02017-07-27 18:19:38 -07002413 dirty_image_objects_filename_,
Vladimir Marko54159c62018-06-20 14:30:08 +01002414 nullptr);
Jeff Haoc23b0c02017-07-27 18:19:38 -07002415 if (dirty_image_objects_ == nullptr) {
2416 LOG(ERROR) << "Failed to create list of dirty objects from '"
2417 << dirty_image_objects_filename_ << "'";
2418 return false;
2419 }
2420 } else {
2421 dirty_image_objects_.reset(nullptr);
2422 }
2423 return true;
2424 }
2425
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002426 void PruneNonExistentDexFiles() {
2427 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2428 size_t kept = 0u;
2429 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
Vladimir Markod011d812018-11-29 12:35:24 +00002430 if (!OS::FileExists(dex_filenames_[i].c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002431 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2432 } else {
Vladimir Markod011d812018-11-29 12:35:24 +00002433 if (kept != i) {
2434 dex_filenames_[kept] = dex_filenames_[i];
2435 dex_locations_[kept] = dex_locations_[i];
2436 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002437 ++kept;
2438 }
2439 }
2440 dex_filenames_.resize(kept);
2441 dex_locations_.resize(kept);
2442 }
2443
2444 bool AddDexFileSources() {
2445 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
Nicolas Geoffraybc177272018-01-24 14:55:32 +00002446 if (input_vdex_file_ != nullptr && input_vdex_file_->HasDexSection()) {
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002447 DCHECK_EQ(oat_writers_.size(), 1u);
2448 const std::string& name = zip_location_.empty() ? dex_locations_[0] : zip_location_;
2449 DCHECK(!name.empty());
2450 if (!oat_writers_[0]->AddVdexDexFilesSource(*input_vdex_file_.get(), name.c_str())) {
2451 return false;
2452 }
2453 } else if (zip_fd_ != -1) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002454 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002455 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2456 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002457 return false;
2458 }
2459 } else if (oat_writers_.size() > 1u) {
2460 // Multi-image.
2461 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2462 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2463 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
Vladimir Markod011d812018-11-29 12:35:24 +00002464 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i].c_str(),
2465 dex_locations_[i].c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002466 return false;
2467 }
2468 }
2469 } else {
2470 DCHECK_EQ(oat_writers_.size(), 1u);
2471 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2472 DCHECK_NE(dex_filenames_.size(), 0u);
2473 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
Vladimir Markod011d812018-11-29 12:35:24 +00002474 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i].c_str(),
2475 dex_locations_[i].c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002476 return false;
2477 }
2478 }
2479 }
2480 return true;
2481 }
2482
2483 void CreateOatWriters() {
2484 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2485 elf_writers_.reserve(oat_files_.size());
2486 oat_writers_.reserve(oat_files_.size());
2487 for (const std::unique_ptr<File>& oat_file : oat_files_) {
Vladimir Markoa0431112018-06-25 09:32:54 +01002488 elf_writers_.emplace_back(linker::CreateElfWriterQuick(*compiler_options_, oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002489 elf_writers_.back()->Start();
Mathieu Chartier4a265c22018-04-09 14:25:14 -07002490 bool do_oat_writer_layout = DoDexLayoutOptimizations() || DoOatLayoutOptimizations();
2491 if (profile_compilation_info_ != nullptr && profile_compilation_info_->IsEmpty()) {
2492 do_oat_writer_layout = false;
2493 }
Vladimir Marko74527972016-11-29 15:57:32 +00002494 oat_writers_.emplace_back(new linker::OatWriter(
Vladimir Markoa0431112018-06-25 09:32:54 +01002495 *compiler_options_,
Igor Murashkin545412b2017-08-17 15:26:54 -07002496 timings_,
Mathieu Chartier603ccab2017-10-20 14:34:28 -07002497 do_oat_writer_layout ? profile_compilation_info_.get() : nullptr,
2498 compact_dex_level_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002499 }
2500 }
2501
Vladimir Marko49b0f452015-12-10 13:49:19 +00002502 void SaveDexInput() {
Vladimir Marko213ee2d2018-06-22 11:56:34 +01002503 const std::vector<const DexFile*>& dex_files = compiler_options_->dex_files_for_oat_file_;
2504 for (size_t i = 0, size = dex_files.size(); i != size; ++i) {
2505 const DexFile* dex_file = dex_files[i];
Vladimir Marko49b0f452015-12-10 13:49:19 +00002506 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2507 getpid(), i));
2508 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2509 if (tmp_file.get() == nullptr) {
2510 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2511 << ". Try: adb shell chmod 777 /data/local/tmp";
2512 continue;
2513 }
2514 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2515 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2516 UNUSED(tmp_file->Flush());
2517 UNUSED(tmp_file->Close());
2518 LOG(INFO) << "Wrote input to " << tmp_file_name;
2519 }
2520 }
2521
Mathieu Chartier46331a62017-07-21 09:49:10 -07002522 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options,
2523 QuickCompilerCallbacks* callbacks) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00002524 RuntimeOptions raw_options;
Vladimir Marko21910692019-11-06 13:27:03 +00002525 if (IsBootImage()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00002526 std::string boot_class_path = "-Xbootclasspath:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002527 boot_class_path += android::base::Join(dex_filenames_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002528 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2529 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002530 boot_class_path_locations += android::base::Join(dex_locations_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002531 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2532 } else {
2533 std::string boot_image_option = "-Ximage:";
2534 boot_image_option += boot_image_filename_;
2535 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2536 }
2537 for (size_t i = 0; i < runtime_args_.size(); i++) {
2538 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2539 }
2540
Mathieu Chartier46331a62017-07-21 09:49:10 -07002541 raw_options.push_back(std::make_pair("compilercallbacks", callbacks));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002542 raw_options.push_back(
Vladimir Markoa0431112018-06-25 09:32:54 +01002543 std::make_pair("imageinstructionset",
2544 GetInstructionSetString(compiler_options_->GetInstructionSet())));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002545
2546 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2547 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2548 // have been stripped in preopting, anyways).
2549 if (!IsBootImage()) {
2550 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2551 }
Andreas Gampec8e35202017-04-28 15:47:12 -07002552 // Never allow implicit image compilation.
2553 raw_options.push_back(std::make_pair("-Xnoimage-dex2oat", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002554 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2555 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2556 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002557 // Disable Hspace compaction to save heap size virtual space.
2558 // Only need disable Hspace for OOM becasue background collector is equal to
2559 // foreground collector by default for dex2oat.
2560 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002561
Andreas Gampeace0dc12016-01-20 13:33:13 -08002562 if (compiler_options_->IsForceDeterminism()) {
Andreas Gampeace0dc12016-01-20 13:33:13 -08002563 // To make identity hashcode deterministic, set a known seed.
2564 mirror::Object::SetHashCodeSeed(987654321U);
2565 }
2566
Vladimir Marko49b0f452015-12-10 13:49:19 +00002567 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2568 LOG(ERROR) << "Failed to parse runtime options";
2569 return false;
2570 }
2571 return true;
2572 }
2573
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002574 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002575 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2576 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002577 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002578 LOG(ERROR) << "Failed to create runtime";
2579 return false;
2580 }
Andreas Gampe49c144d2016-11-14 10:11:16 -08002581
2582 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2583 // "ps -a" don't change to non-descript "main."
2584 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2585
Vladimir Marko307dac92015-10-20 11:20:09 +01002586 runtime_.reset(Runtime::Current());
Vladimir Markoa0431112018-06-25 09:32:54 +01002587 runtime_->SetInstructionSet(compiler_options_->GetInstructionSet());
Andreas Gampe8228cdf2017-05-30 15:03:54 -07002588 for (uint32_t i = 0; i < static_cast<uint32_t>(CalleeSaveType::kLastCalleeSaveType); ++i) {
2589 CalleeSaveType type = CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002590 if (!runtime_->HasCalleeSaveMethod(type)) {
2591 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002592 }
2593 }
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002594
2595 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2596 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002597 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002598
Vladimir Markodcfcce42018-06-27 10:00:28 +00002599 Thread* self = Thread::Current();
2600 runtime_->RunRootClinits(self);
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002601
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002602 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2603 // Runtime::Start, give it away now so that we don't starve GC.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002604 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002605
Koji Fukuia72ca6c2019-03-25 17:39:07 +09002606 WatchDog::SetRuntime(runtime_.get());
2607
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002608 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002609 }
2610
Jeff Haodcdc85b2015-12-04 14:06:18 -08002611 // 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 -08002612 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002613 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002614 CHECK(image_writer_ != nullptr);
Vladimir Marko21910692019-11-06 13:27:03 +00002615 if (!IsBootImage() && !IsBootImageExtension()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002616 CHECK(image_filenames_.empty());
Vladimir Markod011d812018-11-29 12:35:24 +00002617 image_filenames_.push_back(app_image_file_name_);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002618 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002619 if (!image_writer_->Write(app_image_fd_,
2620 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002621 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002622 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002623 return false;
2624 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002625
Jeff Haodcdc85b2015-12-04 14:06:18 -08002626 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002627 dchecked_vector<uintptr_t> oat_data_begins;
2628 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2629 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002630 }
Vladimir Markoa2da9b92018-10-10 14:21:55 +01002631 // Destroy ImageWriter.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002632 image_writer_.reset();
2633
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002634 return true;
2635 }
2636
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002637 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2638 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002639 template <typename T>
Vladimir Marko54159c62018-06-20 14:30:08 +01002640 static std::unique_ptr<T> ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002641 const char* input_filename, std::function<std::string(const char*)>* process) {
2642 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2643 if (input_file.get() == nullptr) {
2644 LOG(ERROR) << "Failed to open input file " << input_filename;
2645 return nullptr;
2646 }
Vladimir Markodc4bcce2018-06-21 16:15:42 +01002647 std::unique_ptr<T> result = ReadCommentedInputStream<T>(*input_file, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002648 input_file->close();
Vladimir Marko54159c62018-06-20 14:30:08 +01002649 return result;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002650 }
2651
2652 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2653 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002654 template <typename T>
Vladimir Marko54159c62018-06-20 14:30:08 +01002655 static std::unique_ptr<T> ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002656 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002657 const char* input_filename,
2658 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002659 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002660 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2661 if (zip_archive.get() == nullptr) {
2662 return nullptr;
2663 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002664 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002665 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002666 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002667 zip_filename, error_msg->c_str());
2668 return nullptr;
2669 }
Vladimir Markoc34bebf2018-08-16 16:12:49 +01002670 MemMap input_file = zip_entry->ExtractToMemMap(zip_filename, input_filename, error_msg);
2671 if (!input_file.IsValid()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002672 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002673 zip_filename, error_msg->c_str());
2674 return nullptr;
2675 }
Vladimir Markoc34bebf2018-08-16 16:12:49 +01002676 const std::string input_string(reinterpret_cast<char*>(input_file.Begin()), input_file.Size());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002677 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002678 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002679 }
2680
2681 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2682 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002683 template <typename T>
Vladimir Marko54159c62018-06-20 14:30:08 +01002684 static std::unique_ptr<T> ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002685 std::istream& in_stream,
2686 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002687 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002688 while (in_stream.good()) {
2689 std::string dot;
2690 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08002691 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002692 continue;
2693 }
2694 if (process != nullptr) {
2695 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002696 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002697 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002698 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002699 }
2700 }
Vladimir Marko54159c62018-06-20 14:30:08 +01002701 return output;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002702 }
2703
Mathieu Chartier49285c52014-12-02 15:43:48 -08002704 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002705 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2706 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002707 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampec560fc02014-07-16 09:57:39 -07002708 LOG(INFO) << "dex2oat took "
2709 << PrettyDuration(NanoTime() - start_ns_)
Andreas Gampecc967752016-12-12 13:49:00 -08002710 << " (" << PrettyDuration(ProcessCpuNanoTime() - start_cputime_ns_) << " cpu)"
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002711 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002712 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002713 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2714 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002715 }
2716
Jeff Haodcdc85b2015-12-04 14:06:18 -08002717 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2718 std::string res(image_filename);
2719 size_t last_slash = res.rfind('/');
2720 if (last_slash == std::string::npos || last_slash == 0) {
2721 return res;
2722 }
2723 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2724 if (penultimate_slash == std::string::npos) {
2725 return res;
2726 }
2727 // Check that the string in-between is the expected one.
2728 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2729 GetInstructionSetString(isa)) {
2730 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2731 return res;
2732 }
2733 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2734 }
2735
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002736 std::unique_ptr<CompilerOptions> compiler_options_;
2737 Compiler::Kind compiler_kind_;
2738
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002739 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2740
Vladimir Marko307dac92015-10-20 11:20:09 +01002741 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002742
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002743 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2744
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002745 std::unique_ptr<Runtime> runtime_;
2746
Calin Juravle1ce70852017-06-28 10:59:03 -07002747 // The spec describing how the class loader should be setup for compilation.
2748 std::unique_ptr<ClassLoaderContext> class_loader_context_;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002749
David Brazdil89821862019-03-19 13:57:43 +00002750 // Optional list of file descriptors corresponding to dex file locations in
2751 // flattened `class_loader_context_`.
2752 std::vector<int> class_loader_context_fds_;
2753
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07002754 // The class loader context stored in the oat file. May be equal to class_loader_context_.
Mathieu Chartierc4440772018-04-16 14:40:56 -07002755 std::unique_ptr<ClassLoaderContext> stored_class_loader_context_;
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07002756
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002757 size_t thread_count_;
Orion Hodsonffc791c2019-11-14 19:19:28 +00002758 std::vector<int32_t> cpu_set_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002759 uint64_t start_ns_;
Andreas Gampec560fc02014-07-16 09:57:39 -07002760 uint64_t start_cputime_ns_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002761 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002762 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002763 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002764 std::string oat_location_;
Vladimir Markod011d812018-11-29 12:35:24 +00002765 std::vector<std::string> oat_filenames_;
2766 std::vector<std::string> oat_unstripped_;
David Srbeckyde91fd42018-07-05 22:27:08 +01002767 bool strip_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002768 int oat_fd_;
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00002769 int input_vdex_fd_;
2770 int output_vdex_fd_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002771 std::string input_vdex_;
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01002772 std::string output_vdex_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002773 std::unique_ptr<VdexFile> input_vdex_file_;
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00002774 int dm_fd_;
2775 std::string dm_file_location_;
2776 std::unique_ptr<ZipArchive> dm_file_;
Vladimir Markod011d812018-11-29 12:35:24 +00002777 std::vector<std::string> dex_filenames_;
2778 std::vector<std::string> dex_locations_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002779 int zip_fd_;
2780 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002781 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002782 std::vector<const char*> runtime_args_;
Vladimir Markod011d812018-11-29 12:35:24 +00002783 std::vector<std::string> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002784 uintptr_t image_base_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002785 ImageHeader::StorageMode image_storage_mode_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002786 const char* passes_to_run_filename_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002787 const char* dirty_image_objects_filename_;
Vladimir Marko54159c62018-06-20 14:30:08 +01002788 std::unique_ptr<HashSet<std::string>> dirty_image_objects_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002789 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002790 bool is_host_;
2791 std::string android_root_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002792 std::string no_inline_from_string_;
Mathieu Chartiera7f6b812017-12-11 13:34:29 -08002793 CompactDexLevel compact_dex_level_ = kDefaultCompactDexLevel;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002794
Vladimir Marko74527972016-11-29 15:57:32 +00002795 std::vector<std::unique_ptr<linker::ElfWriter>> elf_writers_;
2796 std::vector<std::unique_ptr<linker::OatWriter>> oat_writers_;
David Srbecky2faab002019-02-12 16:35:48 +00002797 std::vector<OutputStream*> rodata_;
2798 std::vector<std::unique_ptr<OutputStream>> vdex_out_;
Vladimir Marko74527972016-11-29 15:57:32 +00002799 std::unique_ptr<linker::ImageWriter> image_writer_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002800 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002801
Vladimir Markoc34bebf2018-08-16 16:12:49 +01002802 std::vector<MemMap> opened_dex_files_maps_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002803 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2804
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07002805 bool avoid_storing_invocation_;
Alex Light62afcf52018-12-18 14:19:25 -08002806 android::base::unique_fd invocation_file_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002807 std::string swap_file_name_;
2808 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002809 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2810 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002811 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002812 std::string app_image_file_name_;
2813 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002814 std::string profile_file_;
2815 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002816 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002817 TimingLogger* timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002818 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002819 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002820
2821 // Backing storage.
Andreas Gampe097f34c2017-08-23 08:57:51 -07002822 std::forward_list<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002823
Andreas Gampeace0dc12016-01-20 13:33:13 -08002824 // See CompilerOptions.force_determinism_.
2825 bool force_determinism_;
2826
Jeff Hao16d48432017-04-05 17:05:46 -07002827 // Directory of relative classpaths.
2828 std::string classpath_dir_;
2829
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00002830 // Whether the given input vdex is also the output.
2831 bool update_input_vdex_ = false;
2832
Nicolas Geoffray66ff8a82018-02-28 13:27:55 +00002833 // By default, copy the dex to the vdex file only if dex files are
2834 // compressed in APK.
Andreas Gampe15544172018-06-25 15:09:06 -07002835 linker::CopyOption copy_dex_files_ = linker::CopyOption::kOnlyIfCompressed;
Mathieu Chartier792111c2018-02-15 13:02:15 -08002836
Calin Juravle0e09dfc2018-02-12 19:01:09 -08002837 // The reason for invoking the compiler.
2838 std::string compilation_reason_;
2839
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002840 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2841};
2842
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002843static void b13564922() {
2844#if defined(__linux__) && defined(__arm__)
2845 int major, minor;
2846 struct utsname uts;
2847 if (uname(&uts) != -1 &&
2848 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2849 ((major < 3) || ((major == 3) && (minor < 4)))) {
2850 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2851 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2852 int old_personality = personality(0xffffffff);
2853 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2854 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2855 if (new_personality == -1) {
2856 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2857 }
2858 }
2859 }
2860#endif
2861}
2862
Mathieu Chartier72041a02017-07-14 18:23:25 -07002863class ScopedGlobalRef {
2864 public:
2865 explicit ScopedGlobalRef(jobject obj) : obj_(obj) {}
2866 ~ScopedGlobalRef() {
2867 if (obj_ != nullptr) {
2868 ScopedObjectAccess soa(Thread::Current());
Ian Rogers55256cb2017-12-21 17:07:11 -08002869 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), obj_);
Mathieu Chartier72041a02017-07-14 18:23:25 -07002870 }
2871 }
2872
2873 private:
2874 jobject obj_;
2875};
2876
Andreas Gampe7b565912017-03-20 15:48:52 -07002877static dex2oat::ReturnCode CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002878 dex2oat.LoadClassProfileDescriptors();
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002879 jobject class_loader = dex2oat.Compile();
Mathieu Chartier9e050df2017-08-09 10:05:47 -07002880 // Keep the class loader that was used for compilation live for the rest of the compilation
2881 // process.
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002882 ScopedGlobalRef global_ref(class_loader);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002883
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002884 if (!dex2oat.WriteOutputFiles(class_loader)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002885 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002886 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002887 }
2888
David Srbeckyde91fd42018-07-05 22:27:08 +01002889 // Flush boot.oat. Keep it open as we might still modify it later (strip it).
2890 if (!dex2oat.FlushOutputFiles()) {
2891 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002892 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002893 }
2894
Jeff Haodcdc85b2015-12-04 14:06:18 -08002895 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002896 if (!dex2oat.HandleImage()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002897 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002898 }
2899
2900 // When given --host, finish early without stripping.
2901 if (dex2oat.IsHost()) {
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002902 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002903 return dex2oat::ReturnCode::kOther;
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002904 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002905 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002906 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002907 }
2908
Jeff Haodcdc85b2015-12-04 14:06:18 -08002909 // Copy stripped to unstripped location, if necessary.
David Srbeckyde91fd42018-07-05 22:27:08 +01002910 if (!dex2oat.CopyOatFilesToSymbolsDirectoryAndStrip()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002911 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002912 }
2913
Jeff Haodcdc85b2015-12-04 14:06:18 -08002914 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002915 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002916 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002917 }
2918
2919 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002920 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002921}
2922
Andreas Gampe7b565912017-03-20 15:48:52 -07002923static dex2oat::ReturnCode CompileApp(Dex2Oat& dex2oat) {
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002924 jobject class_loader = dex2oat.Compile();
Mathieu Chartier9e050df2017-08-09 10:05:47 -07002925 // Keep the class loader that was used for compilation live for the rest of the compilation
2926 // process.
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002927 ScopedGlobalRef global_ref(class_loader);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002928
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002929 if (!dex2oat.WriteOutputFiles(class_loader)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002930 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002931 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002932 }
2933
Jeff Haodcdc85b2015-12-04 14:06:18 -08002934 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002935 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002936
2937 // When given --host, finish early without stripping.
2938 if (dex2oat.IsHost()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002939 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002940 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002941 }
2942
2943 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002944 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002945 }
2946
Jeff Haodcdc85b2015-12-04 14:06:18 -08002947 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2948 // stripped versions. If this is given, we expect to be able to open writable files by name.
David Srbeckyde91fd42018-07-05 22:27:08 +01002949 if (!dex2oat.CopyOatFilesToSymbolsDirectoryAndStrip()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002950 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002951 }
2952
Jeff Haodcdc85b2015-12-04 14:06:18 -08002953 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002954 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002955 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002956 }
2957
2958 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002959 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002960}
2961
Andreas Gampe7b565912017-03-20 15:48:52 -07002962static dex2oat::ReturnCode Dex2oat(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002963 b13564922();
2964
2965 TimingLogger timings("compiler", false, false);
2966
Roland Levillain5c7e2602016-02-23 18:08:53 +00002967 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
2968 // might produce a stack frame too large for this function or for
2969 // functions inlining it (such as main), that would not fit the
2970 // requirements of the `-Wframe-larger-than` option.
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07002971 std::unique_ptr<Dex2Oat> dex2oat = std::make_unique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002972
2973 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002974 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002975
Calin Juravle814a80f2019-06-26 15:01:10 -07002976 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap, vdex and profiles.
2977
Calin Juravleb077e152016-02-18 18:47:37 +00002978 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02002979 // This operation involves I/O.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002980 if (dex2oat->UseProfile()) {
Calin Juravleb077e152016-02-18 18:47:37 +00002981 if (!dex2oat->LoadProfile()) {
2982 LOG(ERROR) << "Failed to process profile file";
Andreas Gampe7b565912017-03-20 15:48:52 -07002983 return dex2oat::ReturnCode::kOther;
Calin Juravle998c2162015-12-21 15:39:33 +02002984 }
2985 }
2986
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002987
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002988 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00002989 if (!dex2oat->OpenFile()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002990 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002991 }
2992
Andreas Gampe046c7062015-05-18 23:22:54 -07002993 // Print the complete line when any of the following is true:
2994 // 1) Debug build
2995 // 2) Compiling an image
2996 // 3) Compiling with --host
2997 // 4) Compiling on the host (not a target build)
2998 // Otherwise, print a stripped command line.
Vladimir Marko21910692019-11-06 13:27:03 +00002999 if (kIsDebugBuild ||
3000 dex2oat->IsBootImage() || dex2oat->IsBootImageExtension() ||
3001 dex2oat->IsHost() ||
3002 !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07003003 LOG(INFO) << CommandLine();
3004 } else {
3005 LOG(INFO) << StrippedCommandLine();
3006 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003007
Andreas Gampef7882972017-03-20 16:35:24 -07003008 dex2oat::ReturnCode setup_code = dex2oat->Setup();
3009 if (setup_code != dex2oat::ReturnCode::kNoFailure) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003010 dex2oat->EraseOutputFiles();
Andreas Gampef7882972017-03-20 16:35:24 -07003011 return setup_code;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003012 }
3013
Shubham Ajmera188b2bf2017-09-20 15:53:35 -07003014 // TODO: Due to the cyclic dependencies, profile loading and verifying are
3015 // being done separately. Refactor and place the two next to each other.
3016 // If verification fails, we don't abort the compilation and instead log an
3017 // error.
3018 // TODO(b/62602192, b/65260586): We should consider aborting compilation when
3019 // the profile verification fails.
3020 // Note: If dex2oat fails, installd will remove the oat files causing the app
3021 // to fallback to apk with possible in-memory extraction. We want to avoid
3022 // that, and thus we're lenient towards profile corruptions.
3023 if (dex2oat->UseProfile()) {
3024 dex2oat->VerifyProfileData();
3025 }
3026
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07003027 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
3028 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07003029 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
3030
Andreas Gampe7b565912017-03-20 15:48:52 -07003031 dex2oat::ReturnCode result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00003032 if (dex2oat->IsImage()) {
3033 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08003034 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00003035 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003036 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003037
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003038 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003039}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003040} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07003041
3042int main(int argc, char** argv) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003043 int result = static_cast<int>(art::Dex2oat(argc, argv));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003044 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
Roland Levillain05e34f42018-05-24 13:19:05 +00003045 // time (bug 10645725) unless we're a debug or instrumented build or running on a memory tool.
3046 // Note: The Dex2Oat class should not destruct the runtime in this case.
3047 if (!art::kIsDebugBuild && !art::kIsPGOInstrumentation && !art::kRunningOnMemoryTool) {
Andreas Gampee286b642017-04-13 12:20:42 -07003048 _exit(result);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003049 }
3050 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07003051}