blob: faa68c108a9b8858a8a74b9e31c4357b29c00054 [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 Hodsonbd53ee42019-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 Hodsonbd53ee42019-11-14 19:19:28 +000037#endif // __arm__
Vladimir Markof94b7812014-06-05 15:48:04 +010038#endif
39
Orion Hodsonbd53ee42019-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"
David Srbecky4fda4eb2016-02-05 13:34:46 +000070#include "dex/quick_compiler_callbacks.h"
71#include "dex/verification_results.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070072#include "dex2oat_options.h"
Andreas Gampe7b565912017-03-20 15:48:52 -070073#include "dex2oat_return_codes.h"
David Srbecky2faab002019-02-12 16:35:48 +000074#include "dexlayout.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070075#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080076#include "driver/compiler_options.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070077#include "driver/compiler_options_map-inl.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080078#include "elf_file.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070079#include "gc/space/image_space.h"
80#include "gc/space/space-inl.h"
Mathieu Chartier72041a02017-07-14 18:23:25 -070081#include "gc/verification.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070082#include "interpreter/unstarted_runtime.h"
Vladimir Markoa3ad0cd2018-05-04 10:06:38 +010083#include "jni/java_vm_ext.h"
Vladimir Marko74527972016-11-29 15:57:32 +000084#include "linker/elf_writer.h"
85#include "linker/elf_writer_quick.h"
Vladimir Marko74527972016-11-29 15:57:32 +000086#include "linker/image_writer.h"
Vladimir Marko944da602016-02-19 12:27:55 +000087#include "linker/multi_oat_relative_patcher.h"
Vladimir Marko74527972016-11-29 15:57:32 +000088#include "linker/oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070089#include "mirror/class-inl.h"
90#include "mirror/class_loader.h"
91#include "mirror/object-inl.h"
92#include "mirror/object_array-inl.h"
Andreas Gampe2ff3b972017-06-05 18:14:53 -070093#include "oat_file.h"
Jeff Haob11ffb72016-04-07 15:40:54 -070094#include "oat_file_assistant.h"
David Sehr82d046e2018-04-23 08:14:19 -070095#include "profile/profile_compilation_info.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070096#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000097#include "runtime_options.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070098#include "scoped_thread_state_change-inl.h"
David Srbecky2faab002019-02-12 16:35:48 +000099#include "stream/buffered_output_stream.h"
100#include "stream/file_output_stream.h"
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000101#include "vdex_file.h"
David Brazdilca3c8c32016-09-06 14:04:48 +0100102#include "verifier/verifier_deps.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -0700103#include "well_known_classes.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -0700104
105namespace art {
106
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800107using android::base::StringAppendV;
108using android::base::StringPrintf;
Vladimir Marko91f10322018-12-07 18:04:10 +0000109using gc::space::ImageSpace;
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800110
Andreas Gampee1459ae2016-06-29 09:36:30 -0700111static constexpr size_t kDefaultMinDexFilesForSwap = 2;
112static constexpr size_t kDefaultMinDexFileCumulativeSizeForSwap = 20 * MB;
113
Mathieu Chartier010126f2017-07-15 15:44:18 -0700114// Compiler filter override for very large apps.
115static constexpr CompilerFilter::Filter kLargeAppFilter = CompilerFilter::kVerify;
116
Brian Carlstrom6449c622014-02-10 23:48:36 -0800117static int original_argc;
118static char** original_argv;
119
120static std::string CommandLine() {
121 std::vector<std::string> command;
Andreas Gampe2a487eb2018-11-19 11:41:22 -0800122 command.reserve(original_argc);
Brian Carlstrom6449c622014-02-10 23:48:36 -0800123 for (int i = 0; i < original_argc; ++i) {
124 command.push_back(original_argv[i]);
125 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800126 return android::base::Join(command, ' ');
Brian Carlstrom6449c622014-02-10 23:48:36 -0800127}
128
Andreas Gampe046c7062015-05-18 23:22:54 -0700129// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
130// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
131// locations are all staged).
132static std::string StrippedCommandLine() {
133 std::vector<std::string> command;
134
Calin Juravle07c6d722017-06-07 17:06:12 +0000135 // Do a pre-pass to look for zip-fd and the compiler filter.
Andreas Gampe046c7062015-05-18 23:22:54 -0700136 bool saw_zip_fd = false;
Calin Juravle07c6d722017-06-07 17:06:12 +0000137 bool saw_compiler_filter = false;
Andreas Gampe046c7062015-05-18 23:22:54 -0700138 for (int i = 0; i < original_argc; ++i) {
Andreas Gampe9186ced2016-12-12 14:28:21 -0800139 if (android::base::StartsWith(original_argv[i], "--zip-fd=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700140 saw_zip_fd = true;
Andreas Gampe046c7062015-05-18 23:22:54 -0700141 }
Calin Juravle07c6d722017-06-07 17:06:12 +0000142 if (android::base::StartsWith(original_argv[i], "--compiler-filter=")) {
143 saw_compiler_filter = true;
Calin Juravle07c6d722017-06-07 17:06:12 +0000144 }
Andreas Gampe046c7062015-05-18 23:22:54 -0700145 }
146
147 // Now filter out things.
148 for (int i = 0; i < original_argc; ++i) {
149 // All runtime-arg parameters are dropped.
150 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
151 i++; // Drop the next part, too.
152 continue;
153 }
154
155 // Any instruction-setXXX is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800156 if (android::base::StartsWith(original_argv[i], "--instruction-set")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700157 continue;
158 }
159
160 // The boot image is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800161 if (android::base::StartsWith(original_argv[i], "--boot-image=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700162 continue;
163 }
164
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800165 // The image format is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800166 if (android::base::StartsWith(original_argv[i], "--image-format=")) {
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800167 continue;
168 }
169
Andreas Gampe046c7062015-05-18 23:22:54 -0700170 // This should leave any dex-file and oat-file options, describing what we compiled.
171
172 // However, we prefer to drop this when we saw --zip-fd.
173 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700174 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe9186ced2016-12-12 14:28:21 -0800175 if (android::base::StartsWith(original_argv[i], "--zip-") ||
176 android::base::StartsWith(original_argv[i], "--dex-") ||
177 android::base::StartsWith(original_argv[i], "--oat-") ||
178 android::base::StartsWith(original_argv[i], "--swap-") ||
179 android::base::StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700180 continue;
181 }
182 }
183
184 command.push_back(original_argv[i]);
185 }
186
Calin Juravle07c6d722017-06-07 17:06:12 +0000187 if (!saw_compiler_filter) {
188 command.push_back("--compiler-filter=" +
189 CompilerFilter::NameOfFilter(CompilerFilter::kDefaultCompilerFilter));
190 }
191
Andreas Gampe046c7062015-05-18 23:22:54 -0700192 // Construct the final output.
193 if (command.size() <= 1U) {
Roland Levillain38a938e2018-09-21 10:55:51 +0100194 // It seems only "/apex/com.android.runtime/bin/dex2oat" is left, or not
195 // even that. Use a pretty line.
Andreas Gampe046c7062015-05-18 23:22:54 -0700196 return "Starting dex2oat.";
197 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800198 return android::base::Join(command, ' ');
Andreas Gampe046c7062015-05-18 23:22:54 -0700199}
200
Brian Carlstrom7940e442013-07-12 13:46:57 -0700201static void UsageErrorV(const char* fmt, va_list ap) {
202 std::string error;
203 StringAppendV(&error, fmt, ap);
204 LOG(ERROR) << error;
205}
206
207static void UsageError(const char* fmt, ...) {
208 va_list ap;
209 va_start(ap, fmt);
210 UsageErrorV(fmt, ap);
211 va_end(ap);
212}
213
Andreas Gampe794ad762015-02-23 08:12:24 -0800214NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700215 va_list ap;
216 va_start(ap, fmt);
217 UsageErrorV(fmt, ap);
218 va_end(ap);
219
Brian Carlstrom6449c622014-02-10 23:48:36 -0800220 UsageError("Command: %s", CommandLine().c_str());
221
Brian Carlstrom7940e442013-07-12 13:46:57 -0700222 UsageError("Usage: dex2oat [options]...");
223 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100224 UsageError(" -j<number>: specifies the number of threads used for compilation.");
225 UsageError(" Default is the number of detected hardware threads available on the");
226 UsageError(" host system.");
227 UsageError(" Example: -j12");
228 UsageError("");
Orion Hodsonbd53ee42019-11-14 19:19:28 +0000229 UsageError(" --cpu-set=<set>: sets the cpu affinity to <set>. The <set> argument is a comma");
230 UsageError(" separated list of CPUs.");
231 UsageError(" Example: --cpu-set=0,1,2,3");
232 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700233 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700234 UsageError(" Example: --dex-file=/system/framework/core.jar");
235 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700236 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
237 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
238 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
239 UsageError(" --dex-location=/system/framework/core.jar");
240 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700241 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
242 UsageError(" containing a classes.dex file to compile.");
243 UsageError(" Example: --zip-fd=5");
244 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700245 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
246 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700247 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
248 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800249 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700250 UsageError(" Example: --oat-file=/system/framework/boot.oat");
251 UsageError("");
252 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900253 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700254 UsageError("");
Shubham Ajmera66205322017-10-06 11:18:51 -0700255 UsageError(" --input-vdex-fd=<number>: specifies the vdex input source via a file descriptor.");
256 UsageError(" Example: --input-vdex-fd=6");
257 UsageError("");
258 UsageError(" --output-vdex-fd=<number>: specifies the vdex output destination via a file");
259 UsageError(" descriptor.");
260 UsageError(" Example: --output-vdex-fd=6");
261 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700262 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
263 UsageError(" to the file descriptor specified by --oat-fd.");
264 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
265 UsageError("");
David Srbeckyde91fd42018-07-05 22:27:08 +0100266 UsageError(" --oat-symbols=<file.oat>: specifies a destination where the oat file is copied.");
267 UsageError(" This is equivalent to file copy as build post-processing step.");
268 UsageError(" It is intended to be used with --strip and it happens before it.");
269 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
270 UsageError("");
271 UsageError(" --strip: remove all debugging sections at the end (but keep mini-debug-info).");
272 UsageError(" This is equivalent to the \"strip\" command as build post-processing step.");
273 UsageError(" It is intended to be used with --oat-symbols and it happens after it.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700274 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
275 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800276 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700277 UsageError(" Example: --image=/system/framework/boot.art");
278 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800279 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800280 UsageError(" Which format to store the image.");
281 UsageError(" Example: --image-format=lz4");
282 UsageError(" Default: uncompressed");
283 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700284 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
285 UsageError(" Example: --image=frameworks/base/preloaded-classes");
286 UsageError("");
287 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
288 UsageError(" Example: --base=0x50000000");
289 UsageError("");
290 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000291 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700292 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000293 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000294 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700295 UsageError("");
296 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
297 UsageError(" Example: --android-root=out/host/linux-x86");
298 UsageError(" Default: $ANDROID_ROOT");
299 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800300 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700301 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700302 UsageError(" Example: --instruction-set=x86");
303 UsageError(" Default: arm");
304 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700305 UsageError(" --instruction-set-features=...,: Specify instruction set features");
xueliang.zhong7f88c1a2018-11-06 11:42:41 +0000306 UsageError(" On target the value 'runtime' can be used to detect features at run time.");
307 UsageError(" If target does not support run-time detection the value 'runtime'");
308 UsageError(" has the same effect as the value 'default'.");
309 UsageError(" Note: the value 'runtime' has no effect if it is used on host.");
Dave Allison70202782013-10-22 17:52:19 -0700310 UsageError(" Example: --instruction-set-features=div");
311 UsageError(" Default: default");
312 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800313 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700314 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800315 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100316 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700317 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100318 UsageError(" --compiler-filter="
Nicolas Geoffray49cda062017-04-21 13:08:25 +0100319 "(assume-verified"
320 "|extract"
321 "|verify"
322 "|quicken"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000323 "|space-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100324 "|space"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000325 "|speed-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100326 "|speed"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000327 "|everything-profile"
328 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700329 UsageError(" select compiler filter.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800330 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800331 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800332 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800333 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
334 UsageError(" method for compiler filter tuning.");
335 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
336 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
337 UsageError("");
338 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
339 UsageError(" method for compiler filter tuning.");
340 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
341 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
342 UsageError("");
343 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
344 UsageError(" method for compiler filter tuning.");
345 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
346 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
347 UsageError("");
348 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
349 UsageError(" method for compiler filter tuning.");
350 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
351 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
352 UsageError("");
353 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
354 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700355 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
356 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800357 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
358 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
359 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100360 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
361 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100362 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
363 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100364 UsageError(" Example: --inline-max-code-units=%d",
365 CompilerOptions::kDefaultInlineMaxCodeUnits);
366 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
367 UsageError("");
Nicolas Geoffraye82b60f2017-12-10 21:50:10 +0000368 UsageError(" --dump-timings: display a breakdown of where time was spent");
Ian Rogers46398602013-08-20 07:50:36 -0700369 UsageError("");
Vladimir Marko2da52b02018-05-08 16:31:34 +0100370 UsageError(" --dump-pass-timings: display a breakdown of time spent in optimization");
371 UsageError(" passes for each compiled method.");
372 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100373 UsageError(" -g");
374 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
375 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000376 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000377 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700378 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100379 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100380 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000381 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
382 UsageError(" debug information necessary to print backtraces. (disabled by default)");
383 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000384 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000385 UsageError("");
Alexey Alexandrovab40c112016-09-19 09:33:49 -0700386 UsageError(" --generate-build-id: Generate GNU-compatible linker build ID ELF section with");
387 UsageError(" SHA-1 of the file content (and thus stable across identical builds)");
388 UsageError("");
389 UsageError(" --no-generate-build-id: Do not generate the build ID ELF section.");
390 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000391 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000392 UsageError("");
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700393 UsageError(" --avoid-storing-invocation: Avoid storing the invocation args in the key value");
394 UsageError(" store. Used to test determinism with different args.");
395 UsageError("");
Alex Light62afcf52018-12-18 14:19:25 -0800396 UsageError(" --write-invocation-to=<file>: Write the invocation commandline to the given file");
397 UsageError(" for later use. Used to test determinism with different host architectures.");
398 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700399 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
400 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
401 UsageError(" Use a separate --runtime-arg switch for each argument.");
402 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700403 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000404 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700405 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000406 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
407 UsageError(" Cannot be used together with --profile-file.");
408 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100409 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800410 UsageError(" Example: --swap-file=/data/tmp/swap.001");
411 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100412 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800413 UsageError(" Example: --swap-fd=10");
414 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100415 UsageError(" --swap-dex-size-threshold=<size>: specifies the minimum total dex file size in");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700416 UsageError(" bytes to allow the use of swap.");
417 UsageError(" Example: --swap-dex-size-threshold=1000000");
418 UsageError(" Default: %zu", kDefaultMinDexFileCumulativeSizeForSwap);
419 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100420 UsageError(" --swap-dex-count-threshold=<count>: specifies the minimum number of dex files to");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700421 UsageError(" allow the use of swap.");
422 UsageError(" Example: --swap-dex-count-threshold=10");
423 UsageError(" Default: %zu", kDefaultMinDexFilesForSwap);
424 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100425 UsageError(" --very-large-app-threshold=<size>: specifies the minimum total dex file size in");
Mathieu Chartier010126f2017-07-15 15:44:18 -0700426 UsageError(" bytes to consider the input \"very large\" and reduce compilation done.");
Andreas Gampe67f02822016-06-24 21:05:23 -0700427 UsageError(" Example: --very-large-app-threshold=100000000");
428 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700429 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
Mathieu Chartierf85b3db2018-04-02 18:16:21 -0700430 UsageError(" The image is non-empty only if a profile is passed in.");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700431 UsageError(" Example: --app-image-fd=10");
432 UsageError("");
433 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
434 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
435 UsageError("");
Vladimir Marko4519b9d2018-10-10 15:21:21 +0100436 UsageError(" --multi-image: obsolete, ignored");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800437 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000438 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000439 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100440 UsageError(" --dump-cfg=<cfg-file>: dump control-flow graphs (CFGs) to specified file.");
441 UsageError(" Example: --dump-cfg=output.cfg");
442 UsageError("");
443 UsageError(" --dump-cfg-append: when dumping CFGs to an existing file, append new CFG data to");
444 UsageError(" existing data (instead of overwriting existing data with new data, which is");
445 UsageError(" the default behavior). This option is only meaningful when used with");
446 UsageError(" --dump-cfg.");
447 UsageError("");
Jeff Hao16d48432017-04-05 17:05:46 -0700448 UsageError(" --classpath-dir=<directory-path>: directory used to resolve relative class paths.");
449 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700450 UsageError(" --class-loader-context=<string spec>: a string specifying the intended");
451 UsageError(" runtime loading context for the compiled dex files.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700452 UsageError("");
Mathieu Chartierf5abfc42018-03-23 21:51:54 -0700453 UsageError(" --stored-class-loader-context=<string spec>: a string specifying the intended");
454 UsageError(" runtime loading context that is stored in the oat file. Overrides");
455 UsageError(" --class-loader-context. Note that this ignores the classpath_dir arg.");
456 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700457 UsageError(" It describes how the class loader chain should be built in order to ensure");
458 UsageError(" classes are resolved during dex2aot as they would be resolved at runtime.");
459 UsageError(" This spec will be encoded in the oat file. If at runtime the dex file is");
460 UsageError(" loaded in a different context, the oat file will be rejected.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700461 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700462 UsageError(" The chain is interpreted in the natural 'parent order', meaning that class");
463 UsageError(" loader 'i+1' will be the parent of class loader 'i'.");
Calin Juravlec79470d2017-07-12 17:37:42 -0700464 UsageError(" The compilation sources will be appended to the classpath of the first class");
465 UsageError(" loader.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700466 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700467 UsageError(" E.g. if the context is 'PCL[lib1.dex];DLC[lib2.dex]' and ");
468 UsageError(" --dex-file=src.dex then dex2oat will setup a PathClassLoader with classpath ");
469 UsageError(" 'lib1.dex:src.dex' and set its parent to a DelegateLastClassLoader with ");
470 UsageError(" classpath 'lib2.dex'.");
David Brazdil89821862019-03-19 13:57:43 +0000471 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700472 UsageError(" Note that the compiler will be tolerant if the source dex files specified");
473 UsageError(" with --dex-file are found in the classpath. The source dex files will be");
474 UsageError(" removed from any class loader's classpath possibly resulting in empty");
475 UsageError(" class loaders.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700476 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700477 UsageError(" Example: --class-loader-context=PCL[lib1.dex:lib2.dex];DLC[lib3.dex]");
Calin Juravle1ce70852017-06-28 10:59:03 -0700478 UsageError("");
David Brazdil89821862019-03-19 13:57:43 +0000479 UsageError(" --class-loader-context-fds=<fds>: a colon-separated list of file descriptors");
480 UsageError(" for dex files in --class-loader-context. Their order must be the same as");
481 UsageError(" dex files in flattened class loader context.");
482 UsageError("");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700483 UsageError(" --dirty-image-objects=<directory-path>: list of known dirty objects in the image.");
484 UsageError(" The image writer will group them together.");
485 UsageError("");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700486 UsageError(" --compact-dex-level=none|fast: None avoids generating compact dex, fast");
Mathieu Chartierddf39552018-04-03 10:22:27 -0700487 UsageError(" generates compact dex with low compile time. If speed-profile is specified as");
488 UsageError(" the compiler filter and the profile is not empty, the default compact dex");
489 UsageError(" level is always used.");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700490 UsageError("");
Andreas Gampee20ff6f2017-11-07 15:00:35 -0800491 UsageError(" --deduplicate-code=true|false: enable|disable code deduplication. Deduplicated");
492 UsageError(" code will have an arbitrary symbol tagged with [DEDUPED].");
Andreas Gampecac31ad2017-11-06 20:01:17 -0800493 UsageError("");
Nicolas Geoffray66ff8a82018-02-28 13:27:55 +0000494 UsageError(" --copy-dex-files=true|false: enable|disable copying the dex files into the");
Mathieu Chartier792111c2018-02-15 13:02:15 -0800495 UsageError(" output vdex.");
496 UsageError("");
Calin Juravle0e09dfc2018-02-12 19:01:09 -0800497 UsageError(" --compilation-reason=<string>: optional metadata specifying the reason for");
498 UsageError(" compiling the apk. If specified, the string will be embedded verbatim in");
499 UsageError(" the key value store of the oat file.");
Mathieu Chartier19667a02018-12-21 15:26:19 -0800500 UsageError(" Example: --compilation-reason=install");
Calin Juravle0e09dfc2018-02-12 19:01:09 -0800501 UsageError("");
Mathieu Chartiercd0f38f2018-10-15 09:44:35 -0700502 UsageError(" --resolve-startup-const-strings=true|false: If true, the compiler eagerly");
503 UsageError(" resolves strings referenced from const-string of startup methods.");
504 UsageError("");
Mathieu Chartier1a842962018-11-13 15:09:51 -0800505 UsageError(" --max-image-block-size=<size>: Maximum solid block size for compressed images.");
506 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700507 std::cerr << "See log for usage error information\n";
508 exit(EXIT_FAILURE);
509}
510
Orion Hodsonbd53ee42019-11-14 19:19:28 +0000511
512// Set CPU affinity from a string containing a comma-separated list of numeric CPU identifiers.
513static void SetCpuAffinity(const std::vector<int32_t>& cpu_list) {
514#ifdef __linux__
515 int cpu_count = sysconf(_SC_NPROCESSORS_CONF);
516 cpu_set_t target_cpu_set;
517 CPU_ZERO(&target_cpu_set);
518
519 for (int32_t cpu : cpu_list) {
520 if (cpu >= 0 && cpu < cpu_count) {
521 CPU_SET(cpu, &target_cpu_set);
522 } else {
523 // Argument error is considered fatal, suggests misconfigured system properties.
524 Usage("Invalid cpu \"d\" specified in --cpu-set argument (nprocessors = %d)",
525 cpu, cpu_count);
526 }
527 }
528
529 if (sched_setaffinity(getpid(), sizeof(target_cpu_set), &target_cpu_set) == -1) {
530 // Failure to set affinity may be outside control of requestor, log warning rather than
531 // treating as fatal.
532 PLOG(WARNING) << "Failed to set CPU affinity.";
533 }
534#else
535 LOG(WARNING) << "--cpu-set not supported on this platform.";
536#endif // __linux__
537}
538
539
540
Brian Carlstrom7940e442013-07-12 13:46:57 -0700541// The primary goal of the watchdog is to prevent stuck build servers
542// during development when fatal aborts lead to a cascade of failures
543// that result in a deadlock.
544class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800545// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700546#undef CHECK_PTHREAD_CALL
547#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
548 do { \
549 int rc = call args; \
550 if (rc != 0) { \
551 errno = rc; \
552 std::string message(# call); \
553 message += " failed for "; \
554 message += reason; \
555 Fatal(message); \
556 } \
557 } while (false)
558
559 public:
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800560 explicit WatchDog(int64_t timeout_in_milliseconds)
Andreas Gampe0f54b0d2017-12-27 08:37:02 -0800561 : timeout_in_milliseconds_(timeout_in_milliseconds),
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800562 shutting_down_(false) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700563 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700564 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800565#ifndef __APPLE__
566 pthread_condattr_t condattr;
liulvping8f7101e2017-01-16 15:14:43 +0800567 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_init, (&condattr), reason);
568 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_setclock, (&condattr, CLOCK_MONOTONIC), reason);
569 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, &condattr), reason);
570 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_destroy, (&condattr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800571#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700572 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
573 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
574 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
575 }
576 ~WatchDog() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700577 const char* reason = "dex2oat watch dog thread shutdown";
578 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
579 shutting_down_ = true;
580 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
581 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
582
Kenny Root51316382014-05-13 14:59:37 -0700583 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700584
585 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
586 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
587 }
588
Koji Fukuia72ca6c2019-03-25 17:39:07 +0900589 static void SetRuntime(Runtime* runtime) {
590 const char* reason = "dex2oat watch dog set runtime";
591 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&runtime_mutex_), reason);
592 runtime_ = runtime;
593 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&runtime_mutex_), reason);
594 }
595
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800596 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
597 // large.
598 static constexpr int64_t kWatchdogVerifyMultiplier =
599 kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
600
601 // When setting timeouts, keep in mind that the build server may not be as fast as your
602 // desktop. Debug builds are slower so they have larger timeouts.
603 static constexpr int64_t kWatchdogSlowdownFactor = kIsDebugBuild ? 5U : 1U;
604
605 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
606 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
607 // itself before that watchdog would take down the system server.
608 static constexpr int64_t kWatchDogTimeoutSeconds = kWatchdogSlowdownFactor * (9 * 60 + 30);
609
610 static constexpr int64_t kDefaultWatchdogTimeoutInMS =
611 kWatchdogVerifyMultiplier * kWatchDogTimeoutSeconds * 1000;
612
Brian Carlstrom7940e442013-07-12 13:46:57 -0700613 private:
614 static void* CallBack(void* arg) {
615 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
616 ::art::SetThreadName("dex2oat watch dog");
617 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700618 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700619 }
620
Andreas Gampe794ad762015-02-23 08:12:24 -0800621 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700622 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
623 // it's rather easy to hang in unwinding.
624 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
625 // logcat logging or stderr output.
Tomasz Wasilczyk8d840902017-12-20 08:19:53 -0800626 LogHelper::LogLineLowStack(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
627
Andreas Gampe48fde372017-06-06 07:43:46 -0700628 // If we're on the host, try to dump all threads to get a sense of what's going on. This is
629 // restricted to the host as the dump may itself go bad.
630 // TODO: Use a double watchdog timeout, so we can enable this on-device.
Koji Fukuia72ca6c2019-03-25 17:39:07 +0900631 Runtime* runtime = GetRuntime();
632 if (!kIsTargetBuild && runtime != nullptr) {
633 runtime->AttachCurrentThread("Watchdog thread attached for dumping",
634 true,
635 nullptr,
636 false);
637 runtime->DumpForSigQuit(std::cerr);
Andreas Gampecd607312017-06-05 17:03:05 -0700638 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700639 exit(1);
640 }
641
642 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700643 timespec timeout_ts;
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800644#if defined(__APPLE__)
645 InitTimeSpec(true, CLOCK_REALTIME, timeout_in_milliseconds_, 0, &timeout_ts);
646#else
liulvping8f7101e2017-01-16 15:14:43 +0800647 InitTimeSpec(true, CLOCK_MONOTONIC, timeout_in_milliseconds_, 0, &timeout_ts);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800648#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700649 const char* reason = "dex2oat watch dog thread waiting";
650 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
651 while (!shutting_down_) {
Josh Gao2d899c42018-10-17 16:03:42 -0700652 int rc = pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts);
653 if (rc == EINTR) {
654 continue;
655 } else if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700656 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800657 timeout_in_milliseconds_/1000));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700658 } else if (rc != 0) {
Roland Levillaind6f8c8b2018-12-18 15:27:28 +0000659 std::string message(StringPrintf("pthread_cond_timedwait failed: %s", strerror(rc)));
Greg Kaiserf276f952019-03-26 08:15:44 -0700660 Fatal(message);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700661 }
662 }
663 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
664 }
665
Koji Fukuia72ca6c2019-03-25 17:39:07 +0900666 static Runtime* GetRuntime() {
667 const char* reason = "dex2oat watch dog get runtime";
668 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&runtime_mutex_), reason);
669 Runtime* runtime = runtime_;
670 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&runtime_mutex_), reason);
671 return runtime;
672 }
673
674 static pthread_mutex_t runtime_mutex_;
675 static Runtime* runtime_;
676
Brian Carlstrom7940e442013-07-12 13:46:57 -0700677 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
678 pthread_mutex_t mutex_;
679 pthread_cond_t cond_;
680 pthread_attr_t attr_;
681 pthread_t pthread_;
Andreas Gampef45d61c2017-06-07 10:29:33 -0700682
683 const int64_t timeout_in_milliseconds_;
684 bool shutting_down_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700685};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700686
Koji Fukuia72ca6c2019-03-25 17:39:07 +0900687pthread_mutex_t WatchDog::runtime_mutex_ = PTHREAD_MUTEX_INITIALIZER;
688Runtime* WatchDog::runtime_ = nullptr;
689
Roland Levillainbbc6e7e2018-08-24 16:58:47 +0100690class Dex2Oat final {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800691 public:
692 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100693 compiler_kind_(Compiler::kOptimizing),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800694 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000695 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700696 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800697 runtime_(nullptr),
698 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
699 start_ns_(NanoTime()),
Andreas Gampec560fc02014-07-16 09:57:39 -0700700 start_cputime_ns_(ProcessCpuNanoTime()),
Vladimir Marko2afaff72018-11-30 17:01:50 +0000701 strip_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800702 oat_fd_(-1),
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000703 input_vdex_fd_(-1),
704 output_vdex_fd_(-1),
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000705 input_vdex_file_(nullptr),
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +0000706 dm_fd_(-1),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800707 zip_fd_(-1),
708 image_base_(0U),
709 image_classes_zip_filename_(nullptr),
710 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800711 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700712 passes_to_run_filename_(nullptr),
Mathieu Chartierff0baff2017-08-02 23:04:19 -0700713 dirty_image_objects_filename_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800714 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000715 elf_writers_(),
716 oat_writers_(),
717 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000718 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700719 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000720 opened_dex_files_maps_(),
721 opened_dex_files_(),
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700722 avoid_storing_invocation_(false),
Calin Juravle2e2db782016-02-23 12:00:03 +0000723 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800724 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000725 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800726 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000727 force_determinism_(false)
728 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800729
730 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800731 // Log completion time before deleting the runtime_, because this accesses
732 // the runtime.
733 LogCompletionTime();
734
Roland Levillain05e34f42018-05-24 13:19:05 +0000735 if (!kIsDebugBuild && !(kRunningOnMemoryTool && kMemoryToolDetectsLeaks)) {
Vladimir Marko307dac92015-10-20 11:20:09 +0100736 // We want to just exit on non-debug builds, not bringing the runtime down
737 // in an orderly fashion. So release the following fields.
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700738 driver_.release(); // NOLINT
739 image_writer_.release(); // NOLINT
Vladimir Marko307dac92015-10-20 11:20:09 +0100740 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700741 dex_file.release(); // NOLINT
Vladimir Marko307dac92015-10-20 11:20:09 +0100742 }
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100743 new std::vector<MemMap>(std::move(opened_dex_files_maps_)); // Leak MemMaps.
David Brazdil7b49e6c2016-09-01 11:06:18 +0100744 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700745 vdex_file.release(); // NOLINT
David Brazdil7b49e6c2016-09-01 11:06:18 +0100746 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800747 for (std::unique_ptr<File>& oat_file : oat_files_) {
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700748 oat_file.release(); // NOLINT
Jeff Haodcdc85b2015-12-04 14:06:18 -0800749 }
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700750 runtime_.release(); // NOLINT
751 verification_results_.release(); // NOLINT
752 key_value_store_.release(); // NOLINT
Vladimir Markof94b7812014-06-05 15:48:04 +0100753 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700754 }
755
Roland Levillain9ec5e222015-08-17 20:18:41 +0100756 struct ParserOptions {
Vladimir Markod011d812018-11-29 12:35:24 +0000757 std::vector<std::string> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800758 std::string boot_image_filename;
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800759 int64_t watch_dog_timeout_in_ms = -1;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800760 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000761 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800762 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100763 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800764
Andreas Gampe097f34c2017-08-23 08:57:51 -0700765 void ParseBase(const std::string& option) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100766 char* end;
Andreas Gampe097f34c2017-08-23 08:57:51 -0700767 image_base_ = strtoul(option.c_str(), &end, 16);
768 if (end == option.c_str() || *end != '\0') {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100769 Usage("Failed to parse hexadecimal value for option %s", option.data());
770 }
771 }
772
Shubham Ajmera188b2bf2017-09-20 15:53:35 -0700773 bool VerifyProfileData() {
Vladimir Marko213ee2d2018-06-22 11:56:34 +0100774 return profile_compilation_info_->VerifyProfileData(compiler_options_->dex_files_for_oat_file_);
Shubham Ajmera188b2bf2017-09-20 15:53:35 -0700775 }
776
Andreas Gampe097f34c2017-08-23 08:57:51 -0700777 void ParseInstructionSetVariant(const std::string& option, ParserOptions* parser_options) {
Vladimir Markoa0431112018-06-25 09:32:54 +0100778 compiler_options_->instruction_set_features_ = InstructionSetFeatures::FromVariant(
779 compiler_options_->instruction_set_, option, &parser_options->error_msg);
780 if (compiler_options_->instruction_set_features_ == nullptr) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100781 Usage("%s", parser_options->error_msg.c_str());
782 }
783 }
784
Andreas Gampe097f34c2017-08-23 08:57:51 -0700785 void ParseInstructionSetFeatures(const std::string& option, ParserOptions* parser_options) {
Vladimir Markoa0431112018-06-25 09:32:54 +0100786 if (compiler_options_->instruction_set_features_ == nullptr) {
787 compiler_options_->instruction_set_features_ = InstructionSetFeatures::FromVariant(
788 compiler_options_->instruction_set_, "default", &parser_options->error_msg);
789 if (compiler_options_->instruction_set_features_ == nullptr) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100790 Usage("Problem initializing default instruction set features variant: %s",
791 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700792 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800793 }
Vladimir Markoa0431112018-06-25 09:32:54 +0100794 compiler_options_->instruction_set_features_ =
795 compiler_options_->instruction_set_features_->AddFeaturesFromString(
796 option, &parser_options->error_msg);
797 if (compiler_options_->instruction_set_features_ == nullptr) {
Andreas Gampe097f34c2017-08-23 08:57:51 -0700798 Usage("Error parsing '%s': %s", option.c_str(), parser_options->error_msg.c_str());
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800799 }
800 }
801
Jeff Hao436183f2016-01-12 16:36:50 -0800802 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoa2da9b92018-10-10 14:21:55 +0100803 compiler_options_->compile_pic_ = true; // All AOT compilation is PIC.
Vladimir Marko9c4b9702018-11-14 15:09:02 +0000804 DCHECK(compiler_options_->image_type_ == CompilerOptions::ImageType::kNone);
805 if (!image_filenames_.empty()) {
Nicolas Geoffray73bdad52019-04-30 09:47:55 +0100806 if (android::base::EndsWith(image_filenames_[0], "apex.art")) {
807 compiler_options_->image_type_ = CompilerOptions::ImageType::kApexBootImage;
808 } else {
809 compiler_options_->image_type_ = CompilerOptions::ImageType::kBootImage;
810 }
Vladimir Marko9c4b9702018-11-14 15:09:02 +0000811 }
812 if (app_image_fd_ != -1 || !app_image_file_name_.empty()) {
813 if (compiler_options_->IsBootImage()) {
814 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
815 }
816 compiler_options_->image_type_ = CompilerOptions::ImageType::kAppImage;
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700817 }
818
Jeff Haodcdc85b2015-12-04 14:06:18 -0800819 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800820 Usage("Output must be supplied with either --oat-file or --oat-fd");
821 }
822
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000823 if (input_vdex_fd_ != -1 && !input_vdex_.empty()) {
824 Usage("Can't have both --input-vdex-fd and --input-vdex");
825 }
826
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +0100827 if (output_vdex_fd_ != -1 && !output_vdex_.empty()) {
828 Usage("Can't have both --output-vdex-fd and --output-vdex");
829 }
830
Jeff Haodcdc85b2015-12-04 14:06:18 -0800831 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800832 Usage("--oat-file should not be used with --oat-fd");
833 }
834
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000835 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
Sascha Roth5f71c652018-04-10 00:27:15 +0200836 Usage("VDEX and OAT output must be specified either with one --oat-file "
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000837 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100838 }
839
Roland Levillain9ec5e222015-08-17 20:18:41 +0100840 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800841 Usage("--oat-symbols should not be used with --oat-fd");
842 }
843
Roland Levillain9ec5e222015-08-17 20:18:41 +0100844 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800845 Usage("--oat-symbols should not be used with --host");
846 }
847
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000848 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
849 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100850 }
851
Jeff Haodcdc85b2015-12-04 14:06:18 -0800852 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800853 Usage("--oat-fd should not be used with --image");
854 }
855
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +0000856 if ((input_vdex_fd_ != -1 || !input_vdex_.empty()) &&
857 (dm_fd_ != -1 || !dm_file_location_.empty())) {
858 Usage("An input vdex should not be passed with a .dm file");
859 }
860
Jeff Haodcdc85b2015-12-04 14:06:18 -0800861 if (!parser_options->oat_symbols.empty() &&
862 parser_options->oat_symbols.size() != oat_filenames_.size()) {
863 Usage("--oat-file arguments do not match --oat-symbols arguments");
864 }
865
866 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
867 Usage("--oat-file arguments do not match --image arguments");
868 }
869
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800870 if (android_root_.empty()) {
871 const char* android_root_env_var = getenv("ANDROID_ROOT");
872 if (android_root_env_var == nullptr) {
873 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700874 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800875 android_root_ += android_root_env_var;
876 }
877
Vladimir Markoaad75c62016-10-03 08:46:48 +0000878 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Nicolas Geoffrayde1b2a22019-02-27 09:10:57 +0000879 parser_options->boot_image_filename = GetDefaultBootImageLocation(android_root_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800880 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100881 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000882 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800883 }
884
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700885 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800886 Usage("--image-classes should only be used with --image");
887 }
888
Vladimir Marko49b0f452015-12-10 13:49:19 +0000889 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800890 Usage("--image-classes should not be used with --boot-image");
891 }
892
893 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
894 Usage("--image-classes-zip should be used with --image-classes");
895 }
896
897 if (dex_filenames_.empty() && zip_fd_ == -1) {
898 Usage("Input must be supplied with either --dex-file or --zip-fd");
899 }
900
901 if (!dex_filenames_.empty() && zip_fd_ != -1) {
902 Usage("--dex-file should not be used with --zip-fd");
903 }
904
905 if (!dex_filenames_.empty() && !zip_location_.empty()) {
906 Usage("--dex-file should not be used with --zip-location");
907 }
908
909 if (dex_locations_.empty()) {
Vladimir Markod011d812018-11-29 12:35:24 +0000910 dex_locations_ = dex_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800911 } else if (dex_locations_.size() != dex_filenames_.size()) {
912 Usage("--dex-location arguments do not match --dex-file arguments");
913 }
914
Jeff Haodcdc85b2015-12-04 14:06:18 -0800915 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
916 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
917 Usage("--oat-file arguments must be singular or match --dex-file arguments");
918 }
919 }
920
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800921 if (zip_fd_ != -1 && zip_location_.empty()) {
922 Usage("--zip-location should be supplied with --zip-fd");
923 }
924
Vladimir Marko49b0f452015-12-10 13:49:19 +0000925 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800926 if (image_base_ == 0) {
927 Usage("Non-zero --base not specified");
928 }
929 }
930
Mathieu Chartiera8077802016-03-16 19:08:31 -0700931 const bool have_profile_file = !profile_file_.empty();
932 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
933 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000934 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200935 }
936
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -0700937 if (have_profile_file || have_profile_fd) {
Andreas Gampebd600e32018-04-12 14:25:39 -0700938 if (image_classes_filename_ != nullptr ||
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -0700939 image_classes_zip_filename_ != nullptr) {
940 Usage("Profile based image creation is not supported with image or compiled classes");
941 }
942 }
943
Roland Levillain9ec5e222015-08-17 20:18:41 +0100944 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800945 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800946 }
947
xueliang.zhong7f88c1a2018-11-06 11:42:41 +0000948 if (compiler_options_->instruction_set_features_ == nullptr) {
949 // '--instruction-set-features/--instruction-set-variant' were not used.
950 // Use features for the 'default' variant.
Vladimir Markoa0431112018-06-25 09:32:54 +0100951 compiler_options_->instruction_set_features_ = InstructionSetFeatures::FromVariant(
952 compiler_options_->instruction_set_, "default", &parser_options->error_msg);
953 if (compiler_options_->instruction_set_features_ == nullptr) {
Ian Rogersd582fa42014-11-05 23:46:43 -0800954 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100955 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800956 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800957 }
958
Vladimir Markoa0431112018-06-25 09:32:54 +0100959 if (compiler_options_->instruction_set_ == kRuntimeISA) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800960 std::unique_ptr<const InstructionSetFeatures> runtime_features(
961 InstructionSetFeatures::FromCppDefines());
Vladimir Markoa0431112018-06-25 09:32:54 +0100962 if (!compiler_options_->GetInstructionSetFeatures()->Equals(runtime_features.get())) {
xueliang.zhong7f88c1a2018-11-06 11:42:41 +0000963 LOG(WARNING) << "Mismatch between dex2oat instruction set features to use ("
Vladimir Markoa0431112018-06-25 09:32:54 +0100964 << *compiler_options_->GetInstructionSetFeatures()
xueliang.zhong7f88c1a2018-11-06 11:42:41 +0000965 << ") and those from CPP defines (" << *runtime_features
Vladimir Markoa0431112018-06-25 09:32:54 +0100966 << ") for the command line:\n" << CommandLine();
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800967 }
968 }
969
Orion Hodsonbd53ee42019-11-14 19:19:28 +0000970 if (!cpu_set_.empty()) {
971 SetCpuAffinity(cpu_set_);
972 }
973
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000974 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +0000975 compiler_options_->inline_max_code_units_ = CompilerOptions::kDefaultInlineMaxCodeUnits;
Roland Levillaina215b952015-08-07 11:38:32 +0100976 }
977
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800978 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800979 // Set the compilation target's implicit checks options.
Vladimir Markoa0431112018-06-25 09:32:54 +0100980 switch (compiler_options_->GetInstructionSet()) {
Vladimir Marko33bff252017-11-01 14:35:42 +0000981 case InstructionSet::kArm:
982 case InstructionSet::kThumb2:
983 case InstructionSet::kArm64:
984 case InstructionSet::kX86:
985 case InstructionSet::kX86_64:
986 case InstructionSet::kMips:
987 case InstructionSet::kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000988 compiler_options_->implicit_null_checks_ = true;
989 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800990 break;
991
992 default:
993 // Defaults are correct.
994 break;
995 }
996
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800997 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100998 if (parser_options->watch_dog_enabled) {
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800999 int64_t timeout = parser_options->watch_dog_timeout_in_ms > 0
1000 ? parser_options->watch_dog_timeout_in_ms
1001 : WatchDog::kDefaultWatchdogTimeoutInMS;
1002 watchdog_.reset(new WatchDog(timeout));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001003 }
1004
1005 // Fill some values into the key-value store for the oat header.
1006 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -08001007
Roland Levillainb81e9e92017-04-20 17:35:32 +01001008 // Automatically force determinism for the boot image in a host build if read barriers
1009 // are enabled, or if the default GC is CMS or MS. When the default GC is CMS
1010 // (Concurrent Mark-Sweep), the GC is switched to a non-concurrent one by passing the
1011 // option `-Xgc:nonconcurrent` (see below).
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001012 if (!kIsTargetBuild && IsBootImage()) {
1013 if (SupportsDeterministicCompilation()) {
1014 force_determinism_ = true;
1015 } else {
1016 LOG(WARNING) << "Deterministic compilation is disabled.";
1017 }
Andreas Gampeace0dc12016-01-20 13:33:13 -08001018 }
1019 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07001020
1021 if (passes_to_run_filename_ != nullptr) {
Vladimir Marko54159c62018-06-20 14:30:08 +01001022 passes_to_run_ = ReadCommentedInputFromFile<std::vector<std::string>>(
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07001023 passes_to_run_filename_,
Vladimir Marko54159c62018-06-20 14:30:08 +01001024 nullptr); // No post-processing.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07001025 if (passes_to_run_.get() == nullptr) {
1026 Usage("Failed to read list of passes to run.");
1027 }
1028 }
1029 compiler_options_->passes_to_run_ = passes_to_run_.get();
Vladimir Marko6be1dbd2018-11-13 13:09:51 +00001030 compiler_options_->compiling_with_core_image_ =
1031 !boot_image_filename_.empty() &&
Vladimir Marko038924b2019-02-19 15:09:35 +00001032 CompilerOptions::IsCoreImageFilename(boot_image_filename_);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001033 }
1034
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001035 static bool SupportsDeterministicCompilation() {
Roland Levillainb81e9e92017-04-20 17:35:32 +01001036 return (kUseReadBarrier ||
1037 gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
1038 gc::kCollectorTypeDefault == gc::kCollectorTypeMS);
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001039 }
1040
Jeff Hao436183f2016-01-12 16:36:50 -08001041 void ExpandOatAndImageFilenames() {
Vladimir Marko91f10322018-12-07 18:04:10 +00001042 if (image_filenames_[0].rfind('/') == std::string::npos) {
1043 Usage("Unusable boot image filename %s", image_filenames_[0].c_str());
Jeff Hao436183f2016-01-12 16:36:50 -08001044 }
Vladimir Marko91f10322018-12-07 18:04:10 +00001045 image_filenames_ = ImageSpace::ExpandMultiImageLocations(dex_locations_, image_filenames_[0]);
Jeff Hao436183f2016-01-12 16:36:50 -08001046
Vladimir Marko91f10322018-12-07 18:04:10 +00001047 if (oat_filenames_[0].rfind('/') == std::string::npos) {
1048 Usage("Unusable boot image oat filename %s", oat_filenames_[0].c_str());
Vladimir Markodb4b1de2018-12-07 17:18:07 +00001049 }
Vladimir Marko91f10322018-12-07 18:04:10 +00001050 oat_filenames_ = ImageSpace::ExpandMultiImageLocations(dex_locations_, oat_filenames_[0]);
Vladimir Markodb4b1de2018-12-07 17:18:07 +00001051
bowen_lai8bd36c02016-10-12 13:28:55 +08001052 if (!oat_unstripped_.empty()) {
Vladimir Marko91f10322018-12-07 18:04:10 +00001053 if (oat_unstripped_[0].rfind('/') == std::string::npos) {
1054 Usage("Unusable boot image symbol filename %s", oat_unstripped_[0].c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001055 }
Vladimir Marko91f10322018-12-07 18:04:10 +00001056 oat_unstripped_ = ImageSpace::ExpandMultiImageLocations(dex_locations_, oat_unstripped_[0]);
bowen_lai8bd36c02016-10-12 13:28:55 +08001057 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001058 }
1059
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001060 void InsertCompileOptions(int argc, char** argv) {
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001061 if (!avoid_storing_invocation_) {
Vladimir Marko56581d82018-11-07 12:30:52 +00001062 std::ostringstream oss;
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001063 for (int i = 0; i < argc; ++i) {
1064 if (i > 0) {
1065 oss << ' ';
1066 }
1067 oss << argv[i];
Roland Levillain9ec5e222015-08-17 20:18:41 +01001068 }
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001069 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001070 }
Roland Levillain9ec5e222015-08-17 20:18:41 +01001071 key_value_store_->Put(
Roland Levillain9ec5e222015-08-17 20:18:41 +01001072 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001073 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001074 key_value_store_->Put(
1075 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001076 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001077 key_value_store_->Put(OatHeader::kCompilerFilter,
1078 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Andreas Gampef8cd8902017-01-18 16:05:01 -08001079 key_value_store_->Put(OatHeader::kConcurrentCopying,
1080 kUseReadBarrier ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Alex Light62afcf52018-12-18 14:19:25 -08001081 if (invocation_file_.get() != -1) {
1082 std::ostringstream oss;
1083 for (int i = 0; i < argc; ++i) {
1084 if (i > 0) {
1085 oss << std::endl;
1086 }
1087 oss << argv[i];
1088 }
1089 std::string invocation(oss.str());
1090 if (TEMP_FAILURE_RETRY(write(invocation_file_.get(),
1091 invocation.c_str(),
1092 invocation.size())) == -1) {
1093 Usage("Unable to write invocation file");
1094 }
1095 }
Roland Levillain9ec5e222015-08-17 20:18:41 +01001096 }
1097
Andreas Gampe097f34c2017-08-23 08:57:51 -07001098 // This simple forward is here so the string specializations below don't look out of place.
1099 template <typename T, typename U>
1100 void AssignIfExists(Dex2oatArgumentMap& map,
1101 const Dex2oatArgumentMap::Key<T>& key,
1102 U* out) {
1103 map.AssignIfExists(key, out);
1104 }
1105
1106 // Specializations to handle const char* vs std::string.
1107 void AssignIfExists(Dex2oatArgumentMap& map,
1108 const Dex2oatArgumentMap::Key<std::string>& key,
1109 const char** out) {
1110 if (map.Exists(key)) {
1111 char_backing_storage_.push_front(std::move(*map.Get(key)));
1112 *out = char_backing_storage_.front().c_str();
1113 }
1114 }
1115 void AssignIfExists(Dex2oatArgumentMap& map,
1116 const Dex2oatArgumentMap::Key<std::vector<std::string>>& key,
1117 std::vector<const char*>* out) {
1118 if (map.Exists(key)) {
1119 for (auto& val : *map.Get(key)) {
1120 char_backing_storage_.push_front(std::move(val));
1121 out->push_back(char_backing_storage_.front().c_str());
1122 }
1123 }
1124 }
1125
1126 template <typename T>
1127 void AssignTrueIfExists(Dex2oatArgumentMap& map,
1128 const Dex2oatArgumentMap::Key<T>& key,
1129 bool* out) {
1130 if (map.Exists(key)) {
1131 *out = true;
1132 }
1133 }
1134
Roland Levillain9ec5e222015-08-17 20:18:41 +01001135 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1136 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1137 // returns, arguments have been successfully parsed.
1138 void ParseArgs(int argc, char** argv) {
1139 original_argc = argc;
1140 original_argv = argv;
1141
David Sehrc431b9d2018-03-02 12:01:51 -08001142 Locks::Init();
Andreas Gampe51d80cc2017-06-21 21:05:13 -07001143 InitLogging(argv, Runtime::Abort);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001144
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001145 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001146
Andreas Gampe097f34c2017-08-23 08:57:51 -07001147 using M = Dex2oatArgumentMap;
1148 std::string error_msg;
1149 std::unique_ptr<M> args_uptr = M::Parse(argc, const_cast<const char**>(argv), &error_msg);
1150 if (args_uptr == nullptr) {
1151 Usage("Failed to parse command line: %s", error_msg.c_str());
1152 UNREACHABLE();
1153 }
1154
1155 M& args = *args_uptr;
1156
1157 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
1158
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07001159 AssignIfExists(args, M::CompactDexLevel, &compact_dex_level_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001160 AssignIfExists(args, M::DexFiles, &dex_filenames_);
1161 AssignIfExists(args, M::DexLocations, &dex_locations_);
1162 AssignIfExists(args, M::OatFiles, &oat_filenames_);
1163 AssignIfExists(args, M::OatSymbols, &parser_options->oat_symbols);
David Srbeckyde91fd42018-07-05 22:27:08 +01001164 AssignTrueIfExists(args, M::Strip, &strip_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001165 AssignIfExists(args, M::ImageFilenames, &image_filenames_);
1166 AssignIfExists(args, M::ZipFd, &zip_fd_);
1167 AssignIfExists(args, M::ZipLocation, &zip_location_);
1168 AssignIfExists(args, M::InputVdexFd, &input_vdex_fd_);
1169 AssignIfExists(args, M::OutputVdexFd, &output_vdex_fd_);
1170 AssignIfExists(args, M::InputVdex, &input_vdex_);
1171 AssignIfExists(args, M::OutputVdex, &output_vdex_);
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001172 AssignIfExists(args, M::DmFd, &dm_fd_);
1173 AssignIfExists(args, M::DmFile, &dm_file_location_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001174 AssignIfExists(args, M::OatFd, &oat_fd_);
1175 AssignIfExists(args, M::OatLocation, &oat_location_);
1176 AssignIfExists(args, M::Watchdog, &parser_options->watch_dog_enabled);
1177 AssignIfExists(args, M::WatchdogTimeout, &parser_options->watch_dog_timeout_in_ms);
1178 AssignIfExists(args, M::Threads, &thread_count_);
1179 AssignIfExists(args, M::ImageClasses, &image_classes_filename_);
1180 AssignIfExists(args, M::ImageClassesZip, &image_classes_zip_filename_);
Orion Hodsonbd53ee42019-11-14 19:19:28 +00001181 AssignIfExists(args, M::CpuSet, &cpu_set_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001182 AssignIfExists(args, M::Passes, &passes_to_run_filename_);
1183 AssignIfExists(args, M::BootImage, &parser_options->boot_image_filename);
1184 AssignIfExists(args, M::AndroidRoot, &android_root_);
1185 AssignIfExists(args, M::Profile, &profile_file_);
1186 AssignIfExists(args, M::ProfileFd, &profile_file_fd_);
1187 AssignIfExists(args, M::RuntimeOptions, &runtime_args_);
1188 AssignIfExists(args, M::SwapFile, &swap_file_name_);
1189 AssignIfExists(args, M::SwapFileFd, &swap_fd_);
1190 AssignIfExists(args, M::SwapDexSizeThreshold, &min_dex_file_cumulative_size_for_swap_);
1191 AssignIfExists(args, M::SwapDexCountThreshold, &min_dex_files_for_swap_);
1192 AssignIfExists(args, M::VeryLargeAppThreshold, &very_large_threshold_);
1193 AssignIfExists(args, M::AppImageFile, &app_image_file_name_);
1194 AssignIfExists(args, M::AppImageFileFd, &app_image_fd_);
1195 AssignIfExists(args, M::NoInlineFrom, &no_inline_from_string_);
1196 AssignIfExists(args, M::ClasspathDir, &classpath_dir_);
1197 AssignIfExists(args, M::DirtyImageObjects, &dirty_image_objects_filename_);
1198 AssignIfExists(args, M::ImageFormat, &image_storage_mode_);
Calin Juravle0e09dfc2018-02-12 19:01:09 -08001199 AssignIfExists(args, M::CompilationReason, &compilation_reason_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001200
1201 AssignIfExists(args, M::Backend, &compiler_kind_);
1202 parser_options->requested_specific_compiler = args.Exists(M::Backend);
1203
Vladimir Markoa0431112018-06-25 09:32:54 +01001204 AssignIfExists(args, M::TargetInstructionSet, &compiler_options_->instruction_set_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001205 // arm actually means thumb2.
Vladimir Markoa0431112018-06-25 09:32:54 +01001206 if (compiler_options_->instruction_set_ == InstructionSet::kArm) {
1207 compiler_options_->instruction_set_ = InstructionSet::kThumb2;
Andreas Gampe097f34c2017-08-23 08:57:51 -07001208 }
1209
1210 AssignTrueIfExists(args, M::Host, &is_host_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001211 AssignTrueIfExists(args, M::AvoidStoringInvocation, &avoid_storing_invocation_);
Alex Light62afcf52018-12-18 14:19:25 -08001212 if (args.Exists(M::InvocationFile)) {
1213 invocation_file_.reset(open(args.Get(M::InvocationFile)->c_str(),
1214 O_CREAT|O_WRONLY|O_TRUNC|O_CLOEXEC,
1215 S_IRUSR|S_IWUSR));
1216 if (invocation_file_.get() == -1) {
1217 int err = errno;
1218 Usage("Unable to open invocation file '%s' for writing due to %s.",
1219 args.Get(M::InvocationFile)->c_str(), strerror(err));
1220 }
1221 }
Mathieu Chartier792111c2018-02-15 13:02:15 -08001222 AssignIfExists(args, M::CopyDexFiles, &copy_dex_files_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001223
1224 if (args.Exists(M::ForceDeterminism)) {
1225 if (!SupportsDeterministicCompilation()) {
1226 Usage("Option --force-determinism requires read barriers or a CMS/MS garbage collector");
Roland Levillain9ec5e222015-08-17 20:18:41 +01001227 }
Andreas Gampe097f34c2017-08-23 08:57:51 -07001228 force_determinism_ = true;
1229 }
1230
1231 if (args.Exists(M::Base)) {
1232 ParseBase(*args.Get(M::Base));
1233 }
1234 if (args.Exists(M::TargetInstructionSetVariant)) {
1235 ParseInstructionSetVariant(*args.Get(M::TargetInstructionSetVariant), parser_options.get());
1236 }
1237 if (args.Exists(M::TargetInstructionSetFeatures)) {
1238 ParseInstructionSetFeatures(*args.Get(M::TargetInstructionSetFeatures), parser_options.get());
1239 }
1240 if (args.Exists(M::ClassLoaderContext)) {
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001241 std::string class_loader_context_arg = *args.Get(M::ClassLoaderContext);
1242 class_loader_context_ = ClassLoaderContext::Create(class_loader_context_arg);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001243 if (class_loader_context_ == nullptr) {
1244 Usage("Option --class-loader-context has an incorrect format: %s",
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001245 class_loader_context_arg.c_str());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001246 }
David Brazdil89821862019-03-19 13:57:43 +00001247 if (args.Exists(M::ClassLoaderContextFds)) {
1248 std::string str_fds_arg = *args.Get(M::ClassLoaderContextFds);
1249 std::vector<std::string> str_fds = android::base::Split(str_fds_arg, ":");
1250 for (const std::string& str_fd : str_fds) {
1251 class_loader_context_fds_.push_back(std::stoi(str_fd, nullptr, 0));
1252 if (class_loader_context_fds_.back() < 0) {
1253 Usage("Option --class-loader-context-fds has incorrect format: %s",
1254 str_fds_arg.c_str());
1255 }
1256 }
1257 }
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001258 if (args.Exists(M::StoredClassLoaderContext)) {
Mathieu Chartierc4440772018-04-16 14:40:56 -07001259 const std::string stored_context_arg = *args.Get(M::StoredClassLoaderContext);
1260 stored_class_loader_context_ = ClassLoaderContext::Create(stored_context_arg);
1261 if (stored_class_loader_context_ == nullptr) {
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001262 Usage("Option --stored-class-loader-context has an incorrect format: %s",
Mathieu Chartierc4440772018-04-16 14:40:56 -07001263 stored_context_arg.c_str());
Vladimir Markod8860b42018-05-02 14:58:12 +01001264 } else if (class_loader_context_->VerifyClassLoaderContextMatch(
Mathieu Chartierc4440772018-04-16 14:40:56 -07001265 stored_context_arg,
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001266 /*verify_names*/ false,
Vladimir Markod8860b42018-05-02 14:58:12 +01001267 /*verify_checksums*/ false) != ClassLoaderContext::VerificationResult::kVerifies) {
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001268 Usage(
1269 "Option --stored-class-loader-context '%s' mismatches --class-loader-context '%s'",
Mathieu Chartierc4440772018-04-16 14:40:56 -07001270 stored_context_arg.c_str(),
1271 class_loader_context_arg.c_str());
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001272 }
1273 }
1274 } else if (args.Exists(M::StoredClassLoaderContext)) {
1275 Usage("Option --stored-class-loader-context should only be used if "
1276 "--class-loader-context is also specified");
Roland Levillain9ec5e222015-08-17 20:18:41 +01001277 }
1278
Andreas Gampe097f34c2017-08-23 08:57:51 -07001279 if (!ReadCompilerOptions(args, compiler_options_.get(), &error_msg)) {
1280 Usage(error_msg.c_str());
1281 }
1282
Jeff Hao436183f2016-01-12 16:36:50 -08001283 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001284
1285 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001286 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001287 }
1288
Jeff Haodcdc85b2015-12-04 14:06:18 -08001289 // Check whether the oat output files are writable, and open them for later. Also open a swap
1290 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001291 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001292 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1293 PruneNonExistentDexFiles();
1294
Jeff Hao436183f2016-01-12 16:36:50 -08001295 // Expand oat and image filenames for multi image.
Vladimir Marko4519b9d2018-10-10 15:21:21 +01001296 if (IsBootImage() && image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -08001297 ExpandOatAndImageFilenames();
1298 }
1299
David Brazdil7b49e6c2016-09-01 11:06:18 +01001300 // OAT and VDEX file handling
David Brazdil7b49e6c2016-09-01 11:06:18 +01001301 if (oat_fd_ == -1) {
1302 DCHECK(!oat_filenames_.empty());
Vladimir Markod011d812018-11-29 12:35:24 +00001303 for (const std::string& oat_filename : oat_filenames_) {
1304 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename.c_str()));
Calin Juravleb09be722017-09-25 16:42:48 -07001305 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001306 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1307 return false;
1308 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001309 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001310 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1311 oat_file->Erase();
1312 return false;
1313 }
1314 oat_files_.push_back(std::move(oat_file));
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001315 DCHECK_EQ(input_vdex_fd_, -1);
1316 if (!input_vdex_.empty()) {
1317 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001318 input_vdex_file_ = VdexFile::Open(input_vdex_,
1319 /* writable */ false,
1320 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001321 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001322 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001323 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001324
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001325 DCHECK_EQ(output_vdex_fd_, -1);
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001326 std::string vdex_filename = output_vdex_.empty()
1327 ? ReplaceFileExtension(oat_filename, "vdex")
1328 : output_vdex_;
1329 if (vdex_filename == input_vdex_ && output_vdex_.empty()) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001330 update_input_vdex_ = true;
1331 std::unique_ptr<File> vdex_file(OS::OpenFileReadWrite(vdex_filename.c_str()));
1332 vdex_files_.push_back(std::move(vdex_file));
1333 } else {
1334 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
Calin Juravleb09be722017-09-25 16:42:48 -07001335 if (vdex_file == nullptr) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001336 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1337 return false;
1338 }
1339 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1340 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1341 vdex_file->Erase();
1342 return false;
1343 }
1344 vdex_files_.push_back(std::move(vdex_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001345 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001346 }
1347 } else {
Josh Gaoafeec9f2018-08-30 14:05:56 -07001348 std::unique_ptr<File> oat_file(
1349 new File(DupCloexec(oat_fd_), oat_location_, /* check_usage */ true));
1350 if (!oat_file->IsOpened()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001351 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1352 return false;
1353 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001354 if (oat_file->SetLength(0) != 0) {
1355 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001356 oat_file->Erase();
1357 return false;
David Brazdil7b49e6c2016-09-01 11:06:18 +01001358 }
1359 oat_files_.push_back(std::move(oat_file));
1360
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001361 if (input_vdex_fd_ != -1) {
1362 struct stat s;
1363 int rc = TEMP_FAILURE_RETRY(fstat(input_vdex_fd_, &s));
1364 if (rc == -1) {
1365 PLOG(WARNING) << "Failed getting length of vdex file";
1366 } else {
1367 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001368 input_vdex_file_ = VdexFile::Open(input_vdex_fd_,
1369 s.st_size,
1370 "vdex",
1371 /* writable */ false,
1372 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001373 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001374 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001375 // If there's any problem with the passed vdex, just warn and proceed
1376 // without it.
1377 if (input_vdex_file_ == nullptr) {
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001378 PLOG(WARNING) << "Failed opening vdex file: " << error_msg;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001379 }
1380 }
1381 }
1382
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001383 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001384 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Josh Gaoafeec9f2018-08-30 14:05:56 -07001385 std::unique_ptr<File> vdex_file(new File(
1386 DupCloexec(output_vdex_fd_), vdex_location, /* check_usage */ true));
1387 if (!vdex_file->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001388 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001389 return false;
1390 }
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001391 if (input_vdex_file_ != nullptr && output_vdex_fd_ == input_vdex_fd_) {
1392 update_input_vdex_ = true;
1393 } else {
1394 if (vdex_file->SetLength(0) != 0) {
1395 PLOG(ERROR) << "Truncating vdex file " << vdex_location << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001396 vdex_file->Erase();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001397 return false;
1398 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001399 }
1400 vdex_files_.push_back(std::move(vdex_file));
1401
Vladimir Markod011d812018-11-29 12:35:24 +00001402 oat_filenames_.push_back(oat_location_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001403 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001404
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001405 // If we're updating in place a vdex file, be defensive and put an invalid vdex magic in case
1406 // dex2oat gets killed.
1407 // Note: we're only invalidating the magic data in the file, as dex2oat needs the rest of
1408 // the information to remain valid.
1409 if (update_input_vdex_) {
David Srbecky2faab002019-02-12 16:35:48 +00001410 std::unique_ptr<BufferedOutputStream> vdex_out =
1411 std::make_unique<BufferedOutputStream>(
1412 std::make_unique<FileOutputStream>(vdex_files_.back().get()));
Nicolas Geoffray3a293552018-03-02 10:52:16 +00001413 if (!vdex_out->WriteFully(&VdexFile::VerifierDepsHeader::kVdexInvalidMagic,
1414 arraysize(VdexFile::VerifierDepsHeader::kVdexInvalidMagic))) {
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001415 PLOG(ERROR) << "Failed to invalidate vdex header. File: " << vdex_out->GetLocation();
1416 return false;
1417 }
1418
1419 if (!vdex_out->Flush()) {
1420 PLOG(ERROR) << "Failed to flush stream after invalidating header of vdex file."
1421 << " File: " << vdex_out->GetLocation();
1422 return false;
1423 }
1424 }
1425
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001426 if (dm_fd_ != -1 || !dm_file_location_.empty()) {
1427 std::string error_msg;
1428 if (dm_fd_ != -1) {
1429 dm_file_.reset(ZipArchive::OpenFromFd(dm_fd_, "DexMetadata", &error_msg));
1430 } else {
1431 dm_file_.reset(ZipArchive::Open(dm_file_location_.c_str(), &error_msg));
1432 }
1433 if (dm_file_ == nullptr) {
1434 LOG(WARNING) << "Could not open DexMetadata archive " << error_msg;
1435 }
1436 }
1437
1438 if (dm_file_ != nullptr) {
1439 DCHECK(input_vdex_file_ == nullptr);
1440 std::string error_msg;
1441 static const char* kDexMetadata = "DexMetadata";
1442 std::unique_ptr<ZipEntry> zip_entry(dm_file_->Find(VdexFile::kVdexNameInDmFile, &error_msg));
1443 if (zip_entry == nullptr) {
1444 LOG(INFO) << "No " << VdexFile::kVdexNameInDmFile << " file in DexMetadata archive. "
1445 << "Not doing fast verification.";
1446 } else {
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001447 MemMap input_file = zip_entry->MapDirectlyOrExtract(
Mathieu Chartier792111c2018-02-15 13:02:15 -08001448 VdexFile::kVdexNameInDmFile,
1449 kDexMetadata,
Colin Cross2b41cca2018-11-16 22:43:41 -08001450 &error_msg,
1451 alignof(VdexFile));
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001452 if (!input_file.IsValid()) {
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001453 LOG(WARNING) << "Could not open vdex file in DexMetadata archive: " << error_msg;
1454 } else {
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001455 input_vdex_file_ = std::make_unique<VdexFile>(std::move(input_file));
Calin Juravlea6ff9932020-11-23 19:21:09 -08001456 if (input_vdex_file_->HasDexSection()) {
1457 LOG(ERROR) << "The dex metadata is not allowed to contain dex files";
1458 return false;
1459 }
Calin Juravle5ffefaa2019-01-25 01:04:54 -08001460 VLOG(verifier) << "Doing fast verification with vdex from DexMetadata archive";
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001461 }
1462 }
1463 }
1464
David Brazdil7b49e6c2016-09-01 11:06:18 +01001465 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001466 //
1467 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1468 // that we can use for swap.
1469 //
1470 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1471 // will immediately unlink to satisfy the swap fd assumption.
1472 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1473 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1474 if (swap_file.get() == nullptr) {
1475 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1476 return false;
1477 }
Josh Gaoafeec9f2018-08-30 14:05:56 -07001478 swap_fd_ = swap_file->Release();
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001479 unlink(swap_file_name_.c_str());
1480 }
Jeff Hao436183f2016-01-12 16:36:50 -08001481
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001482 return true;
1483 }
1484
David Brazdil7b49e6c2016-09-01 11:06:18 +01001485 void EraseOutputFiles() {
1486 for (auto& files : { &vdex_files_, &oat_files_ }) {
1487 for (size_t i = 0; i < files->size(); ++i) {
1488 if ((*files)[i].get() != nullptr) {
1489 (*files)[i]->Erase();
1490 (*files)[i].reset();
1491 }
1492 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001493 }
Andreas Gampea650e702014-12-03 14:28:02 -08001494 }
1495
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001496 void LoadClassProfileDescriptors() {
Mathieu Chartierf85b3db2018-04-02 18:16:21 -07001497 if (!IsImage()) {
1498 return;
1499 }
Mathieu Chartierf85b3db2018-04-02 18:16:21 -07001500 if (profile_compilation_info_ != nullptr) {
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001501 // TODO: The following comment looks outdated or misplaced.
Mathieu Chartier0b490842016-05-25 15:05:59 -07001502 // Filter out class path classes since we don't want to include these in the image.
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001503 HashSet<std::string> image_classes = profile_compilation_info_->GetClassDescriptors(
1504 compiler_options_->dex_files_for_oat_file_);
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001505 VLOG(compiler) << "Loaded " << image_classes.size()
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001506 << " image class descriptors from profile";
1507 if (VLOG_IS_ON(compiler)) {
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001508 for (const std::string& s : image_classes) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001509 LOG(INFO) << "Image class " << s;
1510 }
1511 }
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001512 // Note: If we have a profile, classes previously loaded for the --image-classes
1513 // option are overwritten here.
1514 compiler_options_->image_classes_.swap(image_classes);
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001515 }
1516 }
1517
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001518 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1519 // boot class path.
Andreas Gampef7882972017-03-20 16:35:24 -07001520 dex2oat::ReturnCode Setup() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001521 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001522
Andreas Gampebd600e32018-04-12 14:25:39 -07001523 if (!PrepareImageClasses() || !PrepareDirtyObjects()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001524 return dex2oat::ReturnCode::kOther;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001525 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001526
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001527 // Verification results are null since we don't know if we will need them yet as the compler
1528 // filter may change.
Andreas Gampe4585f872015-03-27 23:45:15 -07001529 callbacks_.reset(new QuickCompilerCallbacks(
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001530 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001531 CompilerCallbacks::CallbackMode::kCompileBootImage :
1532 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001533
Vladimir Marko49b0f452015-12-10 13:49:19 +00001534 RuntimeArgumentMap runtime_options;
Mathieu Chartier46331a62017-07-21 09:49:10 -07001535 if (!PrepareRuntimeOptions(&runtime_options, callbacks_.get())) {
Andreas Gampef7882972017-03-20 16:35:24 -07001536 return dex2oat::ReturnCode::kOther;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001537 }
1538
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001539 CreateOatWriters();
1540 if (!AddDexFileSources()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001541 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001542 }
1543
Calin Juravle0e09dfc2018-02-12 19:01:09 -08001544 if (!compilation_reason_.empty()) {
1545 key_value_store_->Put(OatHeader::kCompilationReasonKey, compilation_reason_);
1546 }
1547
Vladimir Markoc10a0c62018-11-16 11:39:22 +00001548 if (IsBootImage()) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001549 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
Vladimir Marko91f10322018-12-07 18:04:10 +00001550 // We use this when loading the boot image.
1551 key_value_store_->Put(OatHeader::kBootClassPathKey, android::base::Join(dex_locations_, ':'));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001552 }
1553
1554 if (!IsBootImage()) {
1555 // When compiling an app, create the runtime early to retrieve
Vladimir Marko0ace5632018-12-14 11:11:47 +00001556 // the boot image checksums needed for the oat header.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001557 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001558 return dex2oat::ReturnCode::kCreateRuntime;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001559 }
1560
Andreas Gampe29d38e72016-03-23 15:31:51 +00001561 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001562 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
Vladimir Marko0ace5632018-12-14 11:11:47 +00001563 Runtime* runtime = Runtime::Current();
1564 key_value_store_->Put(OatHeader::kBootClassPathKey,
1565 android::base::Join(runtime->GetBootClassPathLocations(), ':'));
1566 std::vector<ImageSpace*> image_spaces = runtime->GetHeap()->GetBootImageSpaces();
1567 const std::vector<const DexFile*>& bcp_dex_files =
1568 runtime->GetClassLinker()->GetBootClassPath();
1569 key_value_store_->Put(
1570 OatHeader::kBootClassPathChecksumsKey,
1571 gc::space::ImageSpace::GetBootClassPathChecksums(image_spaces, bcp_dex_files));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001572 }
1573
1574 // Open dex files for class path.
Calin Juravle19915892017-08-03 17:10:36 +00001575
Calin Juravle1ce70852017-06-28 10:59:03 -07001576 if (class_loader_context_ == nullptr) {
Calin Juravle19915892017-08-03 17:10:36 +00001577 // If no context was specified use the default one (which is an empty PathClassLoader).
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001578 class_loader_context_ = ClassLoaderContext::Default();
Jeff Haof0192c82016-03-28 20:39:50 -07001579 }
Calin Juravle19915892017-08-03 17:10:36 +00001580
Calin Juravle1ce70852017-06-28 10:59:03 -07001581 DCHECK_EQ(oat_writers_.size(), 1u);
1582
1583 // Note: Ideally we would reject context where the source dex files are also
1584 // specified in the classpath (as it doesn't make sense). However this is currently
1585 // needed for non-prebuild tests and benchmarks which expects on the fly compilation.
1586 // Also, for secondary dex files we do not have control on the actual classpath.
1587 // Instead of aborting, remove all the source location from the context classpaths.
1588 if (class_loader_context_->RemoveLocationsFromClassPaths(
1589 oat_writers_[0]->GetSourceLocations())) {
1590 LOG(WARNING) << "The source files to be compiled are also in the classpath.";
1591 }
1592
1593 // We need to open the dex files before encoding the context in the oat file.
1594 // (because the encoding adds the dex checksum...)
1595 // TODO(calin): consider redesigning this so we don't have to open the dex files before
1596 // creating the actual class loader.
David Brazdil89821862019-03-19 13:57:43 +00001597 if (!class_loader_context_->OpenDexFiles(runtime_->GetInstructionSet(),
1598 classpath_dir_,
1599 class_loader_context_fds_)) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001600 // Do not abort if we couldn't open files from the classpath. They might be
1601 // apks without dex files and right now are opening flow will fail them.
1602 LOG(WARNING) << "Failed to open classpath dex files";
1603 }
1604
1605 // Store the class loader context in the oat header.
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001606 // TODO: deprecate this since store_class_loader_context should be enough to cover the users
1607 // of classpath_dir as well.
Mathieu Chartierc4440772018-04-16 14:40:56 -07001608 std::string class_path_key =
1609 class_loader_context_->EncodeContextForOatFile(classpath_dir_,
1610 stored_class_loader_context_.get());
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001611 key_value_store_->Put(OatHeader::kClassPathKey, class_path_key);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001612 }
1613
1614 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001615 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001616 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1617 rodata_.reserve(oat_writers_.size());
1618 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1619 rodata_.push_back(elf_writers_[i]->StartRoData());
1620 // Unzip or copy dex files straight to the oat file.
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001621 std::vector<MemMap> opened_dex_files_map;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001622 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
Mathieu Chartierd45863a2018-03-21 18:16:36 -07001623 // No need to verify the dex file when we have a vdex file, which means it was already
1624 // verified.
1625 const bool verify = (input_vdex_file_ == nullptr);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001626 if (!oat_writers_[i]->WriteAndOpenDexFiles(
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +00001627 vdex_files_[i].get(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01001628 rodata_.back(),
Vladimir Markoc10a0c62018-11-16 11:39:22 +00001629 (i == 0u) ? key_value_store_.get() : nullptr,
Jeff Hao042e8982016-10-19 11:17:11 -07001630 verify,
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001631 update_input_vdex_,
Mathieu Chartier792111c2018-02-15 13:02:15 -08001632 copy_dex_files_,
David Brazdil7b49e6c2016-09-01 11:06:18 +01001633 &opened_dex_files_map,
1634 &opened_dex_files)) {
Andreas Gampef7882972017-03-20 16:35:24 -07001635 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001636 }
1637 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00001638 if (opened_dex_files_map.empty()) {
1639 DCHECK(opened_dex_files.empty());
1640 } else {
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001641 for (MemMap& map : opened_dex_files_map) {
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00001642 opened_dex_files_maps_.push_back(std::move(map));
1643 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001644 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001645 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001646 opened_dex_files_.push_back(std::move(dex_file));
1647 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001648 }
1649 }
1650 }
1651
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001652 compiler_options_->dex_files_for_oat_file_ = MakeNonOwningPointerVector(opened_dex_files_);
1653 const std::vector<const DexFile*>& dex_files = compiler_options_->dex_files_for_oat_file_;
Andreas Gampe7386da42016-06-08 18:18:47 -07001654
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001655 // If we need to downgrade the compiler-filter for size reasons.
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001656 if (!IsBootImage() && IsVeryLarge(dex_files)) {
Mathieu Chartier8cce65a2017-08-17 00:06:39 -07001657 // Disable app image to make sure dex2oat unloading is enabled.
Vladimir Marko9c4b9702018-11-14 15:09:02 +00001658 compiler_options_->image_type_ = CompilerOptions::ImageType::kNone;
Mathieu Chartier8cce65a2017-08-17 00:06:39 -07001659
Mathieu Chartier72041a02017-07-14 18:23:25 -07001660 // If we need to downgrade the compiler-filter for size reasons, do that early before we read
1661 // it below for creating verification callbacks.
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001662 if (!CompilerFilter::IsAsGoodAs(kLargeAppFilter, compiler_options_->GetCompilerFilter())) {
1663 LOG(INFO) << "Very large app, downgrading to verify.";
1664 // Note: this change won't be reflected in the key-value store, as that had to be
1665 // finalized before loading the dex files. This setup is currently required
1666 // to get the size from the DexFile objects.
1667 // TODO: refactor. b/29790079
1668 compiler_options_->SetCompilerFilter(kLargeAppFilter);
1669 }
1670 }
1671
1672 if (CompilerFilter::IsAnyCompilationEnabled(compiler_options_->GetCompilerFilter())) {
1673 // Only modes with compilation require verification results, do this here instead of when we
1674 // create the compilation callbacks since the compilation mode may have been changed by the
1675 // very large app logic.
1676 // Avoiding setting the verification results saves RAM by not adding the dex files later in
1677 // the function.
1678 verification_results_.reset(new VerificationResults(compiler_options_.get()));
1679 callbacks_->SetVerificationResults(verification_results_.get());
1680 }
1681
Andreas Gampe7386da42016-06-08 18:18:47 -07001682 // We had to postpone the swap decision till now, as this is the point when we actually
1683 // know about the dex files we're going to use.
1684
1685 // Make sure that we didn't create the driver, yet.
1686 CHECK(driver_ == nullptr);
1687 // If we use a swap file, ensure we are above the threshold to make it necessary.
1688 if (swap_fd_ != -1) {
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001689 if (!UseSwap(IsBootImage(), dex_files)) {
Andreas Gampe7386da42016-06-08 18:18:47 -07001690 close(swap_fd_);
1691 swap_fd_ = -1;
1692 VLOG(compiler) << "Decided to run without swap.";
1693 } else {
1694 LOG(INFO) << "Large app, accepted running with swap.";
1695 }
1696 }
1697 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001698 if (IsBootImage()) {
1699 // For boot image, pass opened dex files to the Runtime::Create().
1700 // Note: Runtime acquires ownership of these dex files.
1701 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001702 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001703 return dex2oat::ReturnCode::kOther;
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001704 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001705 }
1706
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001707 // If we're doing the image, override the compiler filter to force full compilation. Must be
1708 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1709 // compilation of class initializers.
1710 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001711 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001712 WellKnownClasses::Init(self->GetJniEnv());
1713
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001714 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001715 constexpr bool kSaveDexInput = false;
1716 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001717 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001718 }
1719 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001720
1721 // Ensure opened dex files are writable for dex-to-dex transformations.
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001722 for (MemMap& map : opened_dex_files_maps_) {
1723 if (!map.Protect(PROT_READ | PROT_WRITE)) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001724 PLOG(ERROR) << "Failed to make .dex files writeable.";
Andreas Gampef7882972017-03-20 16:35:24 -07001725 return dex2oat::ReturnCode::kOther;
Vladimir Marko919f5532016-01-20 19:13:01 +00001726 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001727 }
1728
Mathieu Chartier72041a02017-07-14 18:23:25 -07001729 // Verification results are only required for modes that have any compilation. Avoid
1730 // adding the dex files if possible to prevent allocating large arrays.
1731 if (verification_results_ != nullptr) {
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001732 for (const auto& dex_file : dex_files) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001733 // Pre-register dex files so that we can access verification results without locks during
1734 // compilation and verification.
Mathieu Chartier0733dc82017-07-17 14:05:28 -07001735 verification_results_->AddDexFile(dex_file);
1736 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001737 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001738
Andreas Gampef7882972017-03-20 16:35:24 -07001739 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001740 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001741
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001742 // If we need to keep the oat file open for the image writer.
1743 bool ShouldKeepOatFileOpen() const {
1744 return IsImage() && oat_fd_ != kInvalidFd;
1745 }
1746
Mathieu Chartier72041a02017-07-14 18:23:25 -07001747 // Doesn't return the class loader since it's not meant to be used for image compilation.
1748 void CompileDexFilesIndividually() {
1749 CHECK(!IsImage()) << "Not supported with image";
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001750 for (const DexFile* dex_file : compiler_options_->dex_files_for_oat_file_) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001751 std::vector<const DexFile*> dex_files(1u, dex_file);
1752 VLOG(compiler) << "Compiling " << dex_file->GetLocation();
1753 jobject class_loader = CompileDexFiles(dex_files);
1754 CHECK(class_loader != nullptr);
1755 ScopedObjectAccess soa(Thread::Current());
1756 // Unload class loader to free RAM.
Ian Rogers55256cb2017-12-21 17:07:11 -08001757 jweak weak_class_loader = soa.Env()->GetVm()->AddWeakGlobalRef(
Mathieu Chartier72041a02017-07-14 18:23:25 -07001758 soa.Self(),
1759 soa.Decode<mirror::ClassLoader>(class_loader));
Ian Rogers55256cb2017-12-21 17:07:11 -08001760 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), class_loader);
Roland Levillainaf290312018-02-27 20:02:17 +00001761 runtime_->GetHeap()->CollectGarbage(/* clear_soft_references */ true);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001762 ObjPtr<mirror::ClassLoader> decoded_weak = soa.Decode<mirror::ClassLoader>(weak_class_loader);
1763 if (decoded_weak != nullptr) {
1764 LOG(FATAL) << "Failed to unload class loader, path from root set: "
1765 << runtime_->GetHeap()->GetVerification()->FirstPathFromRootSet(decoded_weak);
1766 }
1767 VLOG(compiler) << "Unloaded classloader";
1768 }
1769 }
1770
1771 bool ShouldCompileDexFilesIndividually() const {
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001772 // Compile individually if we are:
1773 // 1. not building an image,
1774 // 2. not verifying a vdex file,
1775 // 3. using multidex,
1776 // 4. not doing any AOT compilation.
1777 // This means extract, no-vdex verify, and quicken, will use the individual compilation
1778 // mode (to reduce RAM used by the compiler).
Mathieu Chartier72041a02017-07-14 18:23:25 -07001779 return !IsImage() &&
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001780 !update_input_vdex_ &&
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001781 compiler_options_->dex_files_for_oat_file_.size() > 1 &&
Mathieu Chartier6a2b67b2017-08-08 15:09:29 -07001782 !CompilerFilter::IsAotCompilationEnabled(compiler_options_->GetCompilerFilter());
Mathieu Chartier72041a02017-07-14 18:23:25 -07001783 }
1784
1785 // Set up and create the compiler driver and then invoke it to compile all the dex files.
1786 jobject Compile() {
1787 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1788
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001789 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001790
Vladimir Marko47496c22016-01-27 16:15:08 +00001791 // Find the dex files we should not inline from.
Vladimir Marko47496c22016-01-27 16:15:08 +00001792 std::vector<std::string> no_inline_filters;
1793 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001794
1795 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001796 const std::string core_oj = "core-oj";
1797 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1798 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001799 }
1800
Vladimir Marko47496c22016-01-27 16:15:08 +00001801 if (!no_inline_filters.empty()) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001802 std::vector<const DexFile*> class_path_files;
1803 if (!IsBootImage()) {
1804 // The class loader context is used only for apps.
1805 class_path_files = class_loader_context_->FlattenOpenedDexFiles();
1806 }
1807
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001808 const std::vector<const DexFile*>& dex_files = compiler_options_->dex_files_for_oat_file_;
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001809 std::vector<const DexFile*> no_inline_from_dex_files;
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001810 const std::vector<const DexFile*>* dex_file_vectors[] = {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001811 &class_linker->GetBootClassPath(),
1812 &class_path_files,
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001813 &dex_files
Jeff Haodcdc85b2015-12-04 14:06:18 -08001814 };
1815 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001816 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001817 for (const std::string& filter : no_inline_filters) {
1818 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
Calin Juravlea308a322017-07-18 16:51:51 -07001819 // allows tests to specify <test-dexfile>!classes2.dex if needed but if the
Vladimir Marko47496c22016-01-27 16:15:08 +00001820 // base location passes the StartsWith() test, so do all extra locations.
1821 std::string dex_location = dex_file->GetLocation();
1822 if (filter.find('/') == std::string::npos) {
1823 // The filter does not contain the path. Remove the path from dex_location as well.
1824 size_t last_slash = dex_file->GetLocation().rfind('/');
1825 if (last_slash != std::string::npos) {
1826 dex_location = dex_location.substr(last_slash + 1);
1827 }
1828 }
1829
Andreas Gampe9186ced2016-12-12 14:28:21 -08001830 if (android::base::StartsWith(dex_location, filter.c_str())) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001831 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001832 no_inline_from_dex_files.push_back(dex_file);
Vladimir Marko47496c22016-01-27 16:15:08 +00001833 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001834 }
1835 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001836 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001837 }
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001838 if (!no_inline_from_dex_files.empty()) {
1839 compiler_options_->no_inline_from_.swap(no_inline_from_dex_files);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001840 }
1841 }
Vladimir Marko1a2a5cd2018-11-07 15:39:48 +00001842 compiler_options_->profile_compilation_info_ = profile_compilation_info_.get();
Jeff Haodcdc85b2015-12-04 14:06:18 -08001843
Vladimir Marko307dac92015-10-20 11:20:09 +01001844 driver_.reset(new CompilerDriver(compiler_options_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001845 compiler_kind_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001846 thread_count_,
Vladimir Marko1a2a5cd2018-11-07 15:39:48 +00001847 swap_fd_));
Nicolas Geoffray486dda02017-09-11 14:15:52 +01001848 if (!IsBootImage()) {
1849 driver_->SetClasspathDexFiles(class_loader_context_->FlattenOpenedDexFiles());
1850 }
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001851
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001852 const bool compile_individually = ShouldCompileDexFilesIndividually();
1853 if (compile_individually) {
1854 // Set the compiler driver in the callbacks so that we can avoid re-verification. This not
1855 // only helps performance but also prevents reverifying quickened bytecodes. Attempting
1856 // verify quickened bytecode causes verification failures.
1857 // Only set the compiler filter if we are doing separate compilation since there is a bit
1858 // of overhead when checking if a class was previously verified.
1859 callbacks_->SetDoesClassUnloading(true, driver_.get());
1860 }
1861
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001862 // Setup vdex for compilation.
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001863 const std::vector<const DexFile*>& dex_files = compiler_options_->dex_files_for_oat_file_;
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001864 if (!DoEagerUnquickeningOfVdex() && input_vdex_file_ != nullptr) {
1865 callbacks_->SetVerifierDeps(
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001866 new verifier::VerifierDeps(dex_files, input_vdex_file_->GetVerifierDepsData()));
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001867
1868 // TODO: we unquicken unconditionally, as we don't know
1869 // if the boot image has changed. How exactly we'll know is under
1870 // experimentation.
1871 TimingLogger::ScopedTiming time_unquicken("Unquicken", timings_);
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +03001872
1873 // We do not decompile a RETURN_VOID_NO_BARRIER into a RETURN_VOID, as the quickening
1874 // optimization does not depend on the boot image (the optimization relies on not
1875 // having final fields in a class, which does not change for an app).
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001876 input_vdex_file_->Unquicken(dex_files, /* decompile_return_instruction */ false);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001877 } else {
1878 // Create the main VerifierDeps, here instead of in the compiler since we want to aggregate
1879 // the results for all the dex files, not just the results for the current dex file.
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001880 callbacks_->SetVerifierDeps(new verifier::VerifierDeps(dex_files));
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001881 }
Mathieu Chartier72041a02017-07-14 18:23:25 -07001882 // Invoke the compilation.
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001883 if (compile_individually) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001884 CompileDexFilesIndividually();
1885 // Return a null classloader since we already freed released it.
1886 return nullptr;
1887 }
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001888 return CompileDexFiles(dex_files);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001889 }
1890
1891 // Create the class loader, use it to compile, and return.
1892 jobject CompileDexFiles(const std::vector<const DexFile*>& dex_files) {
1893 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1894
1895 jobject class_loader = nullptr;
1896 if (!IsBootImage()) {
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001897 class_loader =
1898 class_loader_context_->CreateClassLoader(compiler_options_->dex_files_for_oat_file_);
Andreas Gampee9934582018-01-19 21:23:04 -08001899 callbacks_->SetDexFiles(&dex_files);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001900 }
1901
1902 // Register dex caches and key them to the class loader so that they only unload when the
1903 // class loader unloads.
1904 for (const auto& dex_file : dex_files) {
1905 ScopedObjectAccess soa(Thread::Current());
1906 // Registering the dex cache adds a strong root in the class loader that prevents the dex
1907 // cache from being unloaded early.
1908 ObjPtr<mirror::DexCache> dex_cache = class_linker->RegisterDexFile(
1909 *dex_file,
1910 soa.Decode<mirror::ClassLoader>(class_loader));
1911 if (dex_cache == nullptr) {
1912 soa.Self()->AssertPendingException();
1913 LOG(FATAL) << "Failed to register dex file " << dex_file->GetLocation() << " "
1914 << soa.Self()->GetException()->Dump();
1915 }
1916 }
Vladimir Marko2afaff72018-11-30 17:01:50 +00001917 driver_->InitializeThreadPools();
1918 driver_->PreCompile(class_loader,
1919 dex_files,
1920 timings_,
1921 &compiler_options_->image_classes_,
1922 verification_results_.get());
1923 callbacks_->SetVerificationResults(nullptr); // Should not be needed anymore.
1924 compiler_options_->verification_results_ = verification_results_.get();
Mathieu Chartier72041a02017-07-14 18:23:25 -07001925 driver_->CompileAll(class_loader, dex_files, timings_);
Vladimir Marko2afaff72018-11-30 17:01:50 +00001926 driver_->FreeThreadPools();
Mathieu Chartier72041a02017-07-14 18:23:25 -07001927 return class_loader;
Vladimir Markof4da6752014-08-01 19:04:18 +01001928 }
1929
Jeff Hao436183f2016-01-12 16:36:50 -08001930 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001931 // ensure the references between the two are correct.
1932 //
1933 // Currently we have a memory layout that looks something like this:
1934 //
1935 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001936 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001937 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001938 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001939 // +--------------+
1940 // | alloc spaces |
1941 // +--------------+
1942 //
Jeff Hao436183f2016-01-12 16:36:50 -08001943 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001944 //
Jeff Hao436183f2016-01-12 16:36:50 -08001945 // 1. The images are expected to be loaded at an absolute address and
1946 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001947 //
Jeff Hao436183f2016-01-12 16:36:50 -08001948 // 2. There are absolute pointers from Methods in the images to their
1949 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001950 //
Jeff Hao436183f2016-01-12 16:36:50 -08001951 // 3. There are absolute pointers from the code in the oat files to Methods
1952 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001953 //
Jeff Hao436183f2016-01-12 16:36:50 -08001954 // 4. There are absolute pointers from code in the oat files to other code
1955 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001956 //
1957 // To get this all correct, we go through several steps.
1958 //
Jeff Hao436183f2016-01-12 16:36:50 -08001959 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001960 // the oat data size and code size. During this stage, we also set
1961 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001962 //
Jeff Hao436183f2016-01-12 16:36:50 -08001963 // 2. We prepare offsets for the objects in the images and calculate
1964 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001965 //
Jeff Hao436183f2016-01-12 16:36:50 -08001966 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001967 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001968 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001969 // can prepare the ELF headers and we then know the ELF memory segment
1970 // layout and we can now resolve all references. The compiler provides
1971 // LinkerPatch information in each CompiledMethod and we resolve these,
1972 // using the layout information and image object locations provided by
1973 // image writer, as we're writing the method code.
1974 //
Jeff Hao436183f2016-01-12 16:36:50 -08001975 // 4. We create the image files. They need to know where the oat files
1976 // will be loaded after itself. Originally oat files were simply
1977 // memory mapped so we could predict where their contents were based
1978 // on the file size. Now that they are ELF files, we need to inspect
1979 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001980 // where the oat header is located within.
1981 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001982 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001983 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001984 // load the .so at the desired location at runtime by offsetting the
1985 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001986 // TODO: Do this in step 3. We already know the layout there.
1987 //
1988 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1989 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001990
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001991 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1992 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001993 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1994 // case (when the file will be explicitly erased).
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00001995 bool WriteOutputFiles(jobject class_loader) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001996 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1997
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001998 // Sync the data to the file, in case we did dex2dex transformations.
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001999 for (MemMap& map : opened_dex_files_maps_) {
2000 if (!map.Sync()) {
2001 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map.GetName();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002002 return false;
2003 }
2004 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002005
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002006 if (IsImage()) {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002007 if (IsAppImage() && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002008 gc::Heap* const heap = Runtime::Current()->GetHeap();
Vladimir Marko91f10322018-12-07 18:04:10 +00002009 for (ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002010 image_base_ = std::max(image_base_, RoundUp(
2011 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
2012 kPageSize));
2013 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002014 // The non moving space is right after the oat file. Put the preferred app image location
2015 // right after the non moving space so that we ideally get a continuous immune region for
2016 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002017 // Use the default non moving space capacity since dex2oat does not have a separate non-
2018 // moving space. This means the runtime's non moving space space size will be as large
2019 // as the growth limit for dex2oat, but smaller in the zygote.
2020 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002021 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002022 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
2023 }
2024
Vladimir Markoa0431112018-06-25 09:32:54 +01002025 image_writer_.reset(new linker::ImageWriter(*compiler_options_,
Vladimir Marko74527972016-11-29 15:57:32 +00002026 image_base_,
Vladimir Marko74527972016-11-29 15:57:32 +00002027 image_storage_mode_,
2028 oat_filenames_,
2029 dex_file_oat_index_map_,
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002030 class_loader,
Vladimir Marko74527972016-11-29 15:57:32 +00002031 dirty_image_objects_.get()));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002032
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002033 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002034 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
Mathieu Chartier703b82a2018-04-10 15:52:32 -07002035 if (!image_writer_->PrepareImageAddressSpace(timings_)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002036 LOG(ERROR) << "Failed to prepare image address space.";
2037 return false;
2038 }
2039 }
2040
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002041 // Initialize the writers with the compiler driver, image writer, and their
2042 // dex files. The writers were created without those being there yet.
2043 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00002044 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002045 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
2046 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
2047 }
2048
David Brazdil5d5a36b2016-09-14 15:34:10 +01002049 {
2050 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
2051 DCHECK(IsBootImage() || oat_files_.size() == 1u);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00002052 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
David Brazdil5d5a36b2016-09-14 15:34:10 +01002053 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
2054 File* vdex_file = vdex_files_[i].get();
David Srbecky2faab002019-02-12 16:35:48 +00002055 std::unique_ptr<BufferedOutputStream> vdex_out =
2056 std::make_unique<BufferedOutputStream>(
2057 std::make_unique<FileOutputStream>(vdex_file));
David Brazdil5d5a36b2016-09-14 15:34:10 +01002058
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00002059 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002060 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
2061 return false;
2062 }
2063
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002064 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
2065 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
2066 return false;
2067 }
2068
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +00002069 // VDEX finalized, seek back to the beginning and write checksums and the header.
2070 if (!oat_writers_[i]->WriteChecksumsAndVdexHeader(vdex_out.get())) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002071 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
2072 return false;
2073 }
2074 }
2075 }
2076
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002077 {
2078 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Vladimir Markoa0431112018-06-25 09:32:54 +01002079 linker::MultiOatRelativePatcher patcher(compiler_options_->GetInstructionSet(),
2080 compiler_options_->GetInstructionSetFeatures(),
Vladimir Markoca1e0382018-04-11 09:58:41 +00002081 driver_->GetCompiledMethodStorage());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002082 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00002083 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2084 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko944da602016-02-19 12:27:55 +00002085
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002086 oat_writer->PrepareLayout(&patcher);
Vladimir Markob066d432018-01-03 13:14:37 +00002087 elf_writer->PrepareDynamicSection(oat_writer->GetOatHeader().GetExecutableOffset(),
2088 oat_writer->GetCodeSize(),
2089 oat_writer->GetDataBimgRelRoSize(),
Vladimir Markoaad75c62016-10-03 08:46:48 +00002090 oat_writer->GetBssSize(),
Vladimir Marko0eb882b2017-05-15 13:39:18 +01002091 oat_writer->GetBssMethodsOffset(),
David Srbeckyec2cdf42017-12-08 16:21:25 +00002092 oat_writer->GetBssRootsOffset(),
2093 oat_writer->GetVdexSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002094 if (IsImage()) {
2095 // Update oat layout.
2096 DCHECK(image_writer_ != nullptr);
2097 DCHECK_LT(i, oat_filenames_.size());
2098 image_writer_->UpdateOatFileLayout(i,
2099 elf_writer->GetLoadedSize(),
2100 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01002101 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002102 }
2103 }
2104
2105 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002106 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko74527972016-11-29 15:57:32 +00002107 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2108 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00002109
David Srbecky0c4572e2016-01-22 19:19:25 +00002110 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00002111 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
David Srbecky32210b92017-12-04 14:39:21 +00002112 debug::DebugInfo debug_info = oat_writer->GetDebugInfo(); // Keep the variable alive.
2113 elf_writer->PrepareDebugInfo(debug_info); // Processes the data on background thread.
David Srbecky0c4572e2016-01-22 19:19:25 +00002114
David Srbecky2faab002019-02-12 16:35:48 +00002115 OutputStream*& rodata = rodata_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002116 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002117 if (!oat_writer->WriteRodata(rodata)) {
2118 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
2119 return false;
2120 }
2121 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002122 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00002123
David Srbecky2faab002019-02-12 16:35:48 +00002124 OutputStream* text = elf_writer->StartText();
Jeff Haodcdc85b2015-12-04 14:06:18 -08002125 if (!oat_writer->WriteCode(text)) {
2126 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
2127 return false;
2128 }
2129 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00002130
Vladimir Markob066d432018-01-03 13:14:37 +00002131 if (oat_writer->GetDataBimgRelRoSize() != 0u) {
David Srbecky2faab002019-02-12 16:35:48 +00002132 OutputStream* data_bimg_rel_ro = elf_writer->StartDataBimgRelRo();
Vladimir Markob066d432018-01-03 13:14:37 +00002133 if (!oat_writer->WriteDataBimgRelRo(data_bimg_rel_ro)) {
2134 LOG(ERROR) << "Failed to write .data.bimg.rel.ro section to the ELF file "
2135 << oat_file->GetPath();
2136 return false;
2137 }
2138 elf_writer->EndDataBimgRelRo(data_bimg_rel_ro);
2139 }
2140
Vladimir Marko0ace5632018-12-14 11:11:47 +00002141 if (!oat_writer->WriteHeader(elf_writer->GetStream())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002142 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
2143 return false;
2144 }
2145
Vladimir Marko944da602016-02-19 12:27:55 +00002146 if (IsImage()) {
2147 // Update oat header information.
2148 DCHECK(image_writer_ != nullptr);
2149 DCHECK_LT(i, oat_filenames_.size());
2150 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
2151 }
2152
Jeff Haodcdc85b2015-12-04 14:06:18 -08002153 elf_writer->WriteDynamicSection();
David Srbecky32210b92017-12-04 14:39:21 +00002154 elf_writer->WriteDebugInfo(oat_writer->GetDebugInfo());
Vladimir Marko10c13562015-11-25 14:33:36 +00002155
Jeff Haodcdc85b2015-12-04 14:06:18 -08002156 if (!elf_writer->End()) {
2157 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
2158 return false;
2159 }
2160
David Brazdil7b49e6c2016-09-01 11:06:18 +01002161 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
2162 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002163 }
2164
Jeff Haodcdc85b2015-12-04 14:06:18 -08002165 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002166
2167 oat_writer.reset();
David Srbeckyde91fd42018-07-05 22:27:08 +01002168 // We may still need the ELF writer later for stripping.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002169 }
2170 }
2171
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002172 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002173 }
2174
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002175 // If we are compiling an image, invoke the image creation routine. Else just skip.
2176 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002177 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002178 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
2179 if (!CreateImageFile()) {
2180 return false;
2181 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002182 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07002183 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002184 return true;
2185 }
2186
David Srbeckyde91fd42018-07-05 22:27:08 +01002187 // Copy the full oat files to symbols directory and then strip the originals.
2188 bool CopyOatFilesToSymbolsDirectoryAndStrip() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002189 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
2190 // If we don't want to strip in place, copy from stripped location to unstripped location.
2191 // We need to strip after image creation because FixupElf needs to use .strtab.
Vladimir Markod011d812018-11-29 12:35:24 +00002192 if (oat_unstripped_[i] != oat_filenames_[i]) {
David Srbeckyde91fd42018-07-05 22:27:08 +01002193 DCHECK(oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002194
2195 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
David Srbeckyde91fd42018-07-05 22:27:08 +01002196 std::unique_ptr<File>& in = oat_files_[i];
Vladimir Markod011d812018-11-29 12:35:24 +00002197 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i].c_str()));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01002198 int64_t in_length = in->GetLength();
2199 if (in_length < 0) {
2200 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
2201 return false;
2202 }
2203 if (!out->Copy(in.get(), 0, in_length)) {
2204 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
2205 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002206 }
2207 if (out->FlushCloseOrErase() != 0) {
2208 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
2209 return false;
2210 }
2211 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
David Srbeckyde91fd42018-07-05 22:27:08 +01002212
2213 if (strip_) {
2214 TimingLogger::ScopedTiming t2("dex2oat OatFile strip", timings_);
2215 if (!elf_writers_[i]->StripDebugInfo()) {
2216 PLOG(ERROR) << "Failed strip oat file: " << in->GetPath();
2217 return false;
2218 }
2219 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002220 }
2221 }
2222 return true;
2223 }
2224
David Brazdil7b49e6c2016-09-01 11:06:18 +01002225 bool FlushOutputFile(std::unique_ptr<File>* file) {
2226 if (file->get() != nullptr) {
2227 if (file->get()->Flush() != 0) {
2228 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
2229 return false;
2230 }
2231 }
2232 return true;
2233 }
2234
David Srbeckyde91fd42018-07-05 22:27:08 +01002235 bool FlushCloseOutputFile(File* file) {
2236 if (file != nullptr) {
2237 if (file->FlushCloseOrErase() != 0) {
2238 PLOG(ERROR) << "Failed to flush and close output file: " << file->GetPath();
David Brazdil7b49e6c2016-09-01 11:06:18 +01002239 return false;
2240 }
2241 }
2242 return true;
2243 }
2244
2245 bool FlushOutputFiles() {
2246 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
2247 for (auto& files : { &vdex_files_, &oat_files_ }) {
2248 for (size_t i = 0; i < files->size(); ++i) {
2249 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002250 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08002251 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002252 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00002253 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002254 return true;
2255 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002256
David Brazdil7b49e6c2016-09-01 11:06:18 +01002257 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002258 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002259 for (auto& files : { &vdex_files_, &oat_files_ }) {
2260 for (size_t i = 0; i < files->size(); ++i) {
David Srbeckyde91fd42018-07-05 22:27:08 +01002261 result &= FlushCloseOutputFile((*files)[i].get());
David Brazdil7b49e6c2016-09-01 11:06:18 +01002262 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002263 }
2264 return result;
2265 }
2266
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002267 void DumpTiming() {
Nicolas Geoffray2d8801f2017-11-28 15:50:07 +00002268 if (compiler_options_->GetDumpTimings() ||
2269 (kIsDebugBuild && timings_->GetTotalNs() > MsToNs(1000))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002270 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2271 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002272 }
2273
Andreas Gampe10e477d2014-11-19 12:57:42 -08002274 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002275 return IsAppImage() || IsBootImage();
2276 }
2277
2278 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002279 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002280 }
2281
2282 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002283 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002284 }
2285
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002286 bool IsHost() const {
2287 return is_host_;
2288 }
2289
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002290 bool UseProfile() const {
Mathieu Chartierd0af56c2017-02-17 12:56:25 -08002291 return profile_file_fd_ != -1 || !profile_file_.empty();
Calin Juravle998c2162015-12-21 15:39:33 +02002292 }
2293
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002294 bool DoProfileGuidedOptimizations() const {
Nicolas Geoffray49cda062017-04-21 13:08:25 +01002295 return UseProfile();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002296 }
2297
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002298 bool DoGenerateCompactDex() const {
2299 return compact_dex_level_ != CompactDexLevel::kCompactDexLevelNone;
2300 }
2301
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002302 bool DoDexLayoutOptimizations() const {
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002303 return DoProfileGuidedOptimizations() || DoGenerateCompactDex();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002304 }
2305
Igor Murashkin545412b2017-08-17 15:26:54 -07002306 bool DoOatLayoutOptimizations() const {
2307 return DoProfileGuidedOptimizations();
2308 }
2309
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002310 bool MayInvalidateVdexMetadata() const {
2311 // DexLayout can invalidate the vdex metadata if changing the class def order is enabled, so
2312 // we need to unquicken the vdex file eagerly, before passing it to dexlayout.
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01002313 return DoDexLayoutOptimizations();
2314 }
2315
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002316 bool DoEagerUnquickeningOfVdex() const {
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00002317 return MayInvalidateVdexMetadata() && dm_file_ == nullptr;
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002318 }
2319
Calin Juravle2e2db782016-02-23 12:00:03 +00002320 bool LoadProfile() {
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002321 DCHECK(UseProfile());
Calin Juravlee6f87cc2017-05-24 17:41:05 -07002322 // TODO(calin): We should be using the runtime arena pool (instead of the
2323 // default profile arena). However the setup logic is messy and needs
2324 // cleaning up before that (e.g. the oat writers are created before the
2325 // runtime).
Calin Juravle2e2db782016-02-23 12:00:03 +00002326 profile_compilation_info_.reset(new ProfileCompilationInfo());
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002327 ScopedFlock profile_file;
Calin Juravle2e2db782016-02-23 12:00:03 +00002328 std::string error;
2329 if (profile_file_fd_ != -1) {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002330 profile_file = LockedFile::DupOf(profile_file_fd_, "profile",
2331 true /* read_only_mode */, &error);
Andreas Gampe29d38e72016-03-23 15:31:51 +00002332 } else if (profile_file_ != "") {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002333 profile_file = LockedFile::Open(profile_file_.c_str(), O_RDONLY, true, &error);
Calin Juravle998c2162015-12-21 15:39:33 +02002334 }
Calin Juravle877fd962016-01-05 14:29:29 +00002335
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002336 // Return early if we're unable to obtain a lock on the profile.
2337 if (profile_file.get() == nullptr) {
2338 LOG(ERROR) << "Cannot lock profiles: " << error;
2339 return false;
2340 }
2341
2342 if (!profile_compilation_info_->Load(profile_file->Fd())) {
Calin Juravle2e2db782016-02-23 12:00:03 +00002343 profile_compilation_info_.reset(nullptr);
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002344 return false;
Calin Juravle2e2db782016-02-23 12:00:03 +00002345 }
Calin Juravle877fd962016-01-05 14:29:29 +00002346
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002347 return true;
Calin Juravle998c2162015-12-21 15:39:33 +02002348 }
2349
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002350 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002351 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2352 if (is_image) {
2353 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2354 return false;
2355 }
2356 if (dex_files.size() < min_dex_files_for_swap_) {
2357 // If there are less dex files than the threshold, assume it's gonna be fine.
2358 return false;
2359 }
2360 size_t dex_files_size = 0;
2361 for (const auto* dex_file : dex_files) {
2362 dex_files_size += dex_file->GetHeader().file_size_;
2363 }
2364 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2365 }
2366
Vladimir Marko213ee2d2018-06-22 11:56:34 +01002367 bool IsVeryLarge(const std::vector<const DexFile*>& dex_files) {
Andreas Gampe67f02822016-06-24 21:05:23 -07002368 size_t dex_files_size = 0;
2369 for (const auto* dex_file : dex_files) {
2370 dex_files_size += dex_file->GetHeader().file_size_;
2371 }
2372 return dex_files_size >= very_large_threshold_;
2373 }
2374
Vladimir Marko49b0f452015-12-10 13:49:19 +00002375 bool PrepareImageClasses() {
2376 // If --image-classes was specified, calculate the full list of classes to include in the image.
Vladimir Markodc4bcce2018-06-21 16:15:42 +01002377 DCHECK(compiler_options_->image_classes_.empty());
Vladimir Marko49b0f452015-12-10 13:49:19 +00002378 if (image_classes_filename_ != nullptr) {
Vladimir Markodc4bcce2018-06-21 16:15:42 +01002379 std::unique_ptr<HashSet<std::string>> image_classes =
Vladimir Marko49b0f452015-12-10 13:49:19 +00002380 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
Vladimir Markodc4bcce2018-06-21 16:15:42 +01002381 if (image_classes == nullptr) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00002382 return false;
2383 }
Vladimir Markodc4bcce2018-06-21 16:15:42 +01002384 compiler_options_->image_classes_.swap(*image_classes);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002385 }
2386 return true;
2387 }
2388
Vladimir Marko54159c62018-06-20 14:30:08 +01002389 static std::unique_ptr<HashSet<std::string>> ReadClasses(const char* zip_filename,
2390 const char* classes_filename,
2391 const char* tag) {
2392 std::unique_ptr<HashSet<std::string>> classes;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002393 std::string error_msg;
2394 if (zip_filename != nullptr) {
Vladimir Marko54159c62018-06-20 14:30:08 +01002395 classes = ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002396 } else {
Vladimir Marko54159c62018-06-20 14:30:08 +01002397 classes = ReadImageClassesFromFile(classes_filename);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002398 }
2399 if (classes == nullptr) {
2400 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2401 << classes_filename << "': " << error_msg;
2402 }
2403 return classes;
2404 }
2405
Jeff Haoc23b0c02017-07-27 18:19:38 -07002406 bool PrepareDirtyObjects() {
2407 if (dirty_image_objects_filename_ != nullptr) {
Vladimir Marko54159c62018-06-20 14:30:08 +01002408 dirty_image_objects_ = ReadCommentedInputFromFile<HashSet<std::string>>(
Jeff Haoc23b0c02017-07-27 18:19:38 -07002409 dirty_image_objects_filename_,
Vladimir Marko54159c62018-06-20 14:30:08 +01002410 nullptr);
Jeff Haoc23b0c02017-07-27 18:19:38 -07002411 if (dirty_image_objects_ == nullptr) {
2412 LOG(ERROR) << "Failed to create list of dirty objects from '"
2413 << dirty_image_objects_filename_ << "'";
2414 return false;
2415 }
2416 } else {
2417 dirty_image_objects_.reset(nullptr);
2418 }
2419 return true;
2420 }
2421
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002422 void PruneNonExistentDexFiles() {
2423 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2424 size_t kept = 0u;
2425 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
Vladimir Markod011d812018-11-29 12:35:24 +00002426 if (!OS::FileExists(dex_filenames_[i].c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002427 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2428 } else {
Vladimir Markod011d812018-11-29 12:35:24 +00002429 if (kept != i) {
2430 dex_filenames_[kept] = dex_filenames_[i];
2431 dex_locations_[kept] = dex_locations_[i];
2432 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002433 ++kept;
2434 }
2435 }
2436 dex_filenames_.resize(kept);
2437 dex_locations_.resize(kept);
2438 }
2439
2440 bool AddDexFileSources() {
2441 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
Nicolas Geoffraybc177272018-01-24 14:55:32 +00002442 if (input_vdex_file_ != nullptr && input_vdex_file_->HasDexSection()) {
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002443 DCHECK_EQ(oat_writers_.size(), 1u);
2444 const std::string& name = zip_location_.empty() ? dex_locations_[0] : zip_location_;
2445 DCHECK(!name.empty());
2446 if (!oat_writers_[0]->AddVdexDexFilesSource(*input_vdex_file_.get(), name.c_str())) {
2447 return false;
2448 }
2449 } else if (zip_fd_ != -1) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002450 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002451 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2452 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002453 return false;
2454 }
2455 } else if (oat_writers_.size() > 1u) {
2456 // Multi-image.
2457 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2458 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2459 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
Vladimir Markod011d812018-11-29 12:35:24 +00002460 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i].c_str(),
2461 dex_locations_[i].c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002462 return false;
2463 }
2464 }
2465 } else {
2466 DCHECK_EQ(oat_writers_.size(), 1u);
2467 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2468 DCHECK_NE(dex_filenames_.size(), 0u);
2469 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
Vladimir Markod011d812018-11-29 12:35:24 +00002470 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i].c_str(),
2471 dex_locations_[i].c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002472 return false;
2473 }
2474 }
2475 }
2476 return true;
2477 }
2478
2479 void CreateOatWriters() {
2480 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2481 elf_writers_.reserve(oat_files_.size());
2482 oat_writers_.reserve(oat_files_.size());
2483 for (const std::unique_ptr<File>& oat_file : oat_files_) {
Vladimir Markoa0431112018-06-25 09:32:54 +01002484 elf_writers_.emplace_back(linker::CreateElfWriterQuick(*compiler_options_, oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002485 elf_writers_.back()->Start();
Mathieu Chartier4a265c22018-04-09 14:25:14 -07002486 bool do_oat_writer_layout = DoDexLayoutOptimizations() || DoOatLayoutOptimizations();
2487 if (profile_compilation_info_ != nullptr && profile_compilation_info_->IsEmpty()) {
2488 do_oat_writer_layout = false;
2489 }
Vladimir Marko74527972016-11-29 15:57:32 +00002490 oat_writers_.emplace_back(new linker::OatWriter(
Vladimir Markoa0431112018-06-25 09:32:54 +01002491 *compiler_options_,
Igor Murashkin545412b2017-08-17 15:26:54 -07002492 timings_,
Mathieu Chartier603ccab2017-10-20 14:34:28 -07002493 do_oat_writer_layout ? profile_compilation_info_.get() : nullptr,
2494 compact_dex_level_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002495 }
2496 }
2497
Vladimir Marko49b0f452015-12-10 13:49:19 +00002498 void SaveDexInput() {
Vladimir Marko213ee2d2018-06-22 11:56:34 +01002499 const std::vector<const DexFile*>& dex_files = compiler_options_->dex_files_for_oat_file_;
2500 for (size_t i = 0, size = dex_files.size(); i != size; ++i) {
2501 const DexFile* dex_file = dex_files[i];
Vladimir Marko49b0f452015-12-10 13:49:19 +00002502 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2503 getpid(), i));
2504 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2505 if (tmp_file.get() == nullptr) {
2506 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2507 << ". Try: adb shell chmod 777 /data/local/tmp";
2508 continue;
2509 }
2510 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2511 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2512 UNUSED(tmp_file->Flush());
2513 UNUSED(tmp_file->Close());
2514 LOG(INFO) << "Wrote input to " << tmp_file_name;
2515 }
2516 }
2517
Mathieu Chartier46331a62017-07-21 09:49:10 -07002518 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options,
2519 QuickCompilerCallbacks* callbacks) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00002520 RuntimeOptions raw_options;
2521 if (boot_image_filename_.empty()) {
2522 std::string boot_class_path = "-Xbootclasspath:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002523 boot_class_path += android::base::Join(dex_filenames_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002524 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2525 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002526 boot_class_path_locations += android::base::Join(dex_locations_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002527 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2528 } else {
2529 std::string boot_image_option = "-Ximage:";
2530 boot_image_option += boot_image_filename_;
2531 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2532 }
2533 for (size_t i = 0; i < runtime_args_.size(); i++) {
2534 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2535 }
2536
Mathieu Chartier46331a62017-07-21 09:49:10 -07002537 raw_options.push_back(std::make_pair("compilercallbacks", callbacks));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002538 raw_options.push_back(
Vladimir Markoa0431112018-06-25 09:32:54 +01002539 std::make_pair("imageinstructionset",
2540 GetInstructionSetString(compiler_options_->GetInstructionSet())));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002541
2542 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2543 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2544 // have been stripped in preopting, anyways).
2545 if (!IsBootImage()) {
2546 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2547 }
Andreas Gampec8e35202017-04-28 15:47:12 -07002548 // Never allow implicit image compilation.
2549 raw_options.push_back(std::make_pair("-Xnoimage-dex2oat", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002550 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2551 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2552 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002553 // Disable Hspace compaction to save heap size virtual space.
2554 // Only need disable Hspace for OOM becasue background collector is equal to
2555 // foreground collector by default for dex2oat.
2556 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002557
Andreas Gampeace0dc12016-01-20 13:33:13 -08002558 if (compiler_options_->IsForceDeterminism()) {
Roland Levillainb81e9e92017-04-20 17:35:32 +01002559 // If we're asked to be deterministic, ensure non-concurrent GC for determinism.
2560 //
2561 // Note that with read barriers, this option is ignored, because Runtime::Init
2562 // overrides the foreground GC to be gc::kCollectorTypeCC when instantiating
2563 // gc::Heap. This is fine, as concurrent GC requests are not honored in dex2oat,
2564 // which uses an unstarted runtime.
Andreas Gampeace0dc12016-01-20 13:33:13 -08002565 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
Roland Levillainb81e9e92017-04-20 17:35:32 +01002566
Nicolas Geoffray7acddd82017-05-03 15:04:55 +01002567 // The default LOS implementation (map) is not deterministic. So disable it.
2568 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=disabled", nullptr));
Andreas Gampeace0dc12016-01-20 13:33:13 -08002569
2570 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2571 // compaction (done above) and ensure that neither foreground nor background collectors
2572 // are concurrent.
Roland Levillainb81e9e92017-04-20 17:35:32 +01002573 //
2574 // Likewise, this option is ignored with read barriers because Runtime::Init
2575 // overrides the background GC to be gc::kCollectorTypeCCBackground, but that's
2576 // fine too, for the same reason (see above).
Andreas Gampeace0dc12016-01-20 13:33:13 -08002577 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2578
2579 // To make identity hashcode deterministic, set a known seed.
2580 mirror::Object::SetHashCodeSeed(987654321U);
2581 }
2582
Vladimir Marko49b0f452015-12-10 13:49:19 +00002583 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2584 LOG(ERROR) << "Failed to parse runtime options";
2585 return false;
2586 }
2587 return true;
2588 }
2589
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002590 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002591 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2592 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002593 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002594 LOG(ERROR) << "Failed to create runtime";
2595 return false;
2596 }
Andreas Gampe49c144d2016-11-14 10:11:16 -08002597
2598 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2599 // "ps -a" don't change to non-descript "main."
2600 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2601
Vladimir Marko307dac92015-10-20 11:20:09 +01002602 runtime_.reset(Runtime::Current());
Vladimir Markoa0431112018-06-25 09:32:54 +01002603 runtime_->SetInstructionSet(compiler_options_->GetInstructionSet());
Andreas Gampe8228cdf2017-05-30 15:03:54 -07002604 for (uint32_t i = 0; i < static_cast<uint32_t>(CalleeSaveType::kLastCalleeSaveType); ++i) {
2605 CalleeSaveType type = CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002606 if (!runtime_->HasCalleeSaveMethod(type)) {
2607 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002608 }
2609 }
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002610
2611 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2612 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002613 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002614
Vladimir Markodcfcce42018-06-27 10:00:28 +00002615 Thread* self = Thread::Current();
2616 runtime_->RunRootClinits(self);
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002617
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002618 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2619 // Runtime::Start, give it away now so that we don't starve GC.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002620 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002621
Koji Fukuia72ca6c2019-03-25 17:39:07 +09002622 WatchDog::SetRuntime(runtime_.get());
2623
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002624 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002625 }
2626
Jeff Haodcdc85b2015-12-04 14:06:18 -08002627 // 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 -08002628 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002629 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002630 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002631 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002632 CHECK(image_filenames_.empty());
Vladimir Markod011d812018-11-29 12:35:24 +00002633 image_filenames_.push_back(app_image_file_name_);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002634 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002635 if (!image_writer_->Write(app_image_fd_,
2636 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002637 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002638 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002639 return false;
2640 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002641
Jeff Haodcdc85b2015-12-04 14:06:18 -08002642 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002643 dchecked_vector<uintptr_t> oat_data_begins;
2644 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2645 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002646 }
Vladimir Markoa2da9b92018-10-10 14:21:55 +01002647 // Destroy ImageWriter.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002648 image_writer_.reset();
2649
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002650 return true;
2651 }
2652
2653 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Vladimir Marko54159c62018-06-20 14:30:08 +01002654 static std::unique_ptr<HashSet<std::string>> ReadImageClassesFromFile(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002655 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002656 std::function<std::string(const char*)> process = DotToDescriptor;
Vladimir Marko54159c62018-06-20 14:30:08 +01002657 return ReadCommentedInputFromFile<HashSet<std::string>>(image_classes_filename, &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002658 }
2659
2660 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Vladimir Marko54159c62018-06-20 14:30:08 +01002661 static std::unique_ptr<HashSet<std::string>> ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002662 const char* zip_filename,
2663 const char* image_classes_filename,
2664 std::string* error_msg) {
2665 std::function<std::string(const char*)> process = DotToDescriptor;
Vladimir Marko54159c62018-06-20 14:30:08 +01002666 return ReadCommentedInputFromZip<HashSet<std::string>>(zip_filename,
2667 image_classes_filename,
2668 &process,
2669 error_msg);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002670 }
2671
2672 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2673 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002674 template <typename T>
Vladimir Marko54159c62018-06-20 14:30:08 +01002675 static std::unique_ptr<T> ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002676 const char* input_filename, std::function<std::string(const char*)>* process) {
2677 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2678 if (input_file.get() == nullptr) {
2679 LOG(ERROR) << "Failed to open input file " << input_filename;
2680 return nullptr;
2681 }
Vladimir Markodc4bcce2018-06-21 16:15:42 +01002682 std::unique_ptr<T> result = ReadCommentedInputStream<T>(*input_file, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002683 input_file->close();
Vladimir Marko54159c62018-06-20 14:30:08 +01002684 return result;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002685 }
2686
2687 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2688 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002689 template <typename T>
Vladimir Marko54159c62018-06-20 14:30:08 +01002690 static std::unique_ptr<T> ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002691 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002692 const char* input_filename,
2693 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002694 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002695 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2696 if (zip_archive.get() == nullptr) {
2697 return nullptr;
2698 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002699 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002700 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002701 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002702 zip_filename, error_msg->c_str());
2703 return nullptr;
2704 }
Vladimir Markoc34bebf2018-08-16 16:12:49 +01002705 MemMap input_file = zip_entry->ExtractToMemMap(zip_filename, input_filename, error_msg);
2706 if (!input_file.IsValid()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002707 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002708 zip_filename, error_msg->c_str());
2709 return nullptr;
2710 }
Vladimir Markoc34bebf2018-08-16 16:12:49 +01002711 const std::string input_string(reinterpret_cast<char*>(input_file.Begin()), input_file.Size());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002712 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002713 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002714 }
2715
2716 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2717 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002718 template <typename T>
Vladimir Marko54159c62018-06-20 14:30:08 +01002719 static std::unique_ptr<T> ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002720 std::istream& in_stream,
2721 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002722 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002723 while (in_stream.good()) {
2724 std::string dot;
2725 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08002726 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002727 continue;
2728 }
2729 if (process != nullptr) {
2730 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002731 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002732 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002733 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002734 }
2735 }
Vladimir Marko54159c62018-06-20 14:30:08 +01002736 return output;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002737 }
2738
Mathieu Chartier49285c52014-12-02 15:43:48 -08002739 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002740 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2741 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002742 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampec560fc02014-07-16 09:57:39 -07002743 LOG(INFO) << "dex2oat took "
2744 << PrettyDuration(NanoTime() - start_ns_)
Andreas Gampecc967752016-12-12 13:49:00 -08002745 << " (" << PrettyDuration(ProcessCpuNanoTime() - start_cputime_ns_) << " cpu)"
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002746 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002747 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002748 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2749 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002750 }
2751
Jeff Haodcdc85b2015-12-04 14:06:18 -08002752 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2753 std::string res(image_filename);
2754 size_t last_slash = res.rfind('/');
2755 if (last_slash == std::string::npos || last_slash == 0) {
2756 return res;
2757 }
2758 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2759 if (penultimate_slash == std::string::npos) {
2760 return res;
2761 }
2762 // Check that the string in-between is the expected one.
2763 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2764 GetInstructionSetString(isa)) {
2765 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2766 return res;
2767 }
2768 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2769 }
2770
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002771 std::unique_ptr<CompilerOptions> compiler_options_;
2772 Compiler::Kind compiler_kind_;
2773
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002774 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2775
Vladimir Marko307dac92015-10-20 11:20:09 +01002776 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002777
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002778 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2779
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002780 std::unique_ptr<Runtime> runtime_;
2781
Calin Juravle1ce70852017-06-28 10:59:03 -07002782 // The spec describing how the class loader should be setup for compilation.
2783 std::unique_ptr<ClassLoaderContext> class_loader_context_;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002784
David Brazdil89821862019-03-19 13:57:43 +00002785 // Optional list of file descriptors corresponding to dex file locations in
2786 // flattened `class_loader_context_`.
2787 std::vector<int> class_loader_context_fds_;
2788
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07002789 // The class loader context stored in the oat file. May be equal to class_loader_context_.
Mathieu Chartierc4440772018-04-16 14:40:56 -07002790 std::unique_ptr<ClassLoaderContext> stored_class_loader_context_;
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07002791
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002792 size_t thread_count_;
Orion Hodsonbd53ee42019-11-14 19:19:28 +00002793 std::vector<int32_t> cpu_set_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002794 uint64_t start_ns_;
Andreas Gampec560fc02014-07-16 09:57:39 -07002795 uint64_t start_cputime_ns_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002796 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002797 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002798 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002799 std::string oat_location_;
Vladimir Markod011d812018-11-29 12:35:24 +00002800 std::vector<std::string> oat_filenames_;
2801 std::vector<std::string> oat_unstripped_;
David Srbeckyde91fd42018-07-05 22:27:08 +01002802 bool strip_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002803 int oat_fd_;
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00002804 int input_vdex_fd_;
2805 int output_vdex_fd_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002806 std::string input_vdex_;
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01002807 std::string output_vdex_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002808 std::unique_ptr<VdexFile> input_vdex_file_;
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00002809 int dm_fd_;
2810 std::string dm_file_location_;
2811 std::unique_ptr<ZipArchive> dm_file_;
Vladimir Markod011d812018-11-29 12:35:24 +00002812 std::vector<std::string> dex_filenames_;
2813 std::vector<std::string> dex_locations_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002814 int zip_fd_;
2815 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002816 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002817 std::vector<const char*> runtime_args_;
Vladimir Markod011d812018-11-29 12:35:24 +00002818 std::vector<std::string> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002819 uintptr_t image_base_;
2820 const char* image_classes_zip_filename_;
2821 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002822 ImageHeader::StorageMode image_storage_mode_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002823 const char* passes_to_run_filename_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002824 const char* dirty_image_objects_filename_;
Vladimir Marko54159c62018-06-20 14:30:08 +01002825 std::unique_ptr<HashSet<std::string>> dirty_image_objects_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002826 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002827 bool is_host_;
2828 std::string android_root_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002829 std::string no_inline_from_string_;
Mathieu Chartiera7f6b812017-12-11 13:34:29 -08002830 CompactDexLevel compact_dex_level_ = kDefaultCompactDexLevel;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002831
Vladimir Marko74527972016-11-29 15:57:32 +00002832 std::vector<std::unique_ptr<linker::ElfWriter>> elf_writers_;
2833 std::vector<std::unique_ptr<linker::OatWriter>> oat_writers_;
David Srbecky2faab002019-02-12 16:35:48 +00002834 std::vector<OutputStream*> rodata_;
2835 std::vector<std::unique_ptr<OutputStream>> vdex_out_;
Vladimir Marko74527972016-11-29 15:57:32 +00002836 std::unique_ptr<linker::ImageWriter> image_writer_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002837 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002838
Vladimir Markoc34bebf2018-08-16 16:12:49 +01002839 std::vector<MemMap> opened_dex_files_maps_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002840 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2841
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07002842 bool avoid_storing_invocation_;
Alex Light62afcf52018-12-18 14:19:25 -08002843 android::base::unique_fd invocation_file_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002844 std::string swap_file_name_;
2845 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002846 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2847 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002848 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002849 std::string app_image_file_name_;
2850 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002851 std::string profile_file_;
2852 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002853 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002854 TimingLogger* timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002855 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002856 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002857
2858 // Backing storage.
Andreas Gampe097f34c2017-08-23 08:57:51 -07002859 std::forward_list<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002860
Andreas Gampeace0dc12016-01-20 13:33:13 -08002861 // See CompilerOptions.force_determinism_.
2862 bool force_determinism_;
2863
Jeff Hao16d48432017-04-05 17:05:46 -07002864 // Directory of relative classpaths.
2865 std::string classpath_dir_;
2866
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00002867 // Whether the given input vdex is also the output.
2868 bool update_input_vdex_ = false;
2869
Nicolas Geoffray66ff8a82018-02-28 13:27:55 +00002870 // By default, copy the dex to the vdex file only if dex files are
2871 // compressed in APK.
Andreas Gampe15544172018-06-25 15:09:06 -07002872 linker::CopyOption copy_dex_files_ = linker::CopyOption::kOnlyIfCompressed;
Mathieu Chartier792111c2018-02-15 13:02:15 -08002873
Calin Juravle0e09dfc2018-02-12 19:01:09 -08002874 // The reason for invoking the compiler.
2875 std::string compilation_reason_;
2876
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002877 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2878};
2879
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002880static void b13564922() {
2881#if defined(__linux__) && defined(__arm__)
2882 int major, minor;
2883 struct utsname uts;
2884 if (uname(&uts) != -1 &&
2885 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2886 ((major < 3) || ((major == 3) && (minor < 4)))) {
2887 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2888 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2889 int old_personality = personality(0xffffffff);
2890 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2891 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2892 if (new_personality == -1) {
2893 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2894 }
2895 }
2896 }
2897#endif
2898}
2899
Mathieu Chartier72041a02017-07-14 18:23:25 -07002900class ScopedGlobalRef {
2901 public:
2902 explicit ScopedGlobalRef(jobject obj) : obj_(obj) {}
2903 ~ScopedGlobalRef() {
2904 if (obj_ != nullptr) {
2905 ScopedObjectAccess soa(Thread::Current());
Ian Rogers55256cb2017-12-21 17:07:11 -08002906 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), obj_);
Mathieu Chartier72041a02017-07-14 18:23:25 -07002907 }
2908 }
2909
2910 private:
2911 jobject obj_;
2912};
2913
Andreas Gampe7b565912017-03-20 15:48:52 -07002914static dex2oat::ReturnCode CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002915 dex2oat.LoadClassProfileDescriptors();
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002916 jobject class_loader = dex2oat.Compile();
Mathieu Chartier9e050df2017-08-09 10:05:47 -07002917 // Keep the class loader that was used for compilation live for the rest of the compilation
2918 // process.
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002919 ScopedGlobalRef global_ref(class_loader);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002920
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002921 if (!dex2oat.WriteOutputFiles(class_loader)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002922 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002923 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002924 }
2925
David Srbeckyde91fd42018-07-05 22:27:08 +01002926 // Flush boot.oat. Keep it open as we might still modify it later (strip it).
2927 if (!dex2oat.FlushOutputFiles()) {
2928 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002929 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002930 }
2931
Jeff Haodcdc85b2015-12-04 14:06:18 -08002932 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002933 if (!dex2oat.HandleImage()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002934 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002935 }
2936
2937 // When given --host, finish early without stripping.
2938 if (dex2oat.IsHost()) {
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002939 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002940 return dex2oat::ReturnCode::kOther;
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002941 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002942 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002943 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002944 }
2945
Jeff Haodcdc85b2015-12-04 14:06:18 -08002946 // Copy stripped to unstripped location, if necessary.
David Srbeckyde91fd42018-07-05 22:27:08 +01002947 if (!dex2oat.CopyOatFilesToSymbolsDirectoryAndStrip()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002948 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002949 }
2950
Jeff Haodcdc85b2015-12-04 14:06:18 -08002951 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002952 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002953 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002954 }
2955
2956 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002957 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002958}
2959
Andreas Gampe7b565912017-03-20 15:48:52 -07002960static dex2oat::ReturnCode CompileApp(Dex2Oat& dex2oat) {
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002961 jobject class_loader = dex2oat.Compile();
Mathieu Chartier9e050df2017-08-09 10:05:47 -07002962 // Keep the class loader that was used for compilation live for the rest of the compilation
2963 // process.
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002964 ScopedGlobalRef global_ref(class_loader);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002965
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002966 if (!dex2oat.WriteOutputFiles(class_loader)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002967 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002968 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002969 }
2970
Jeff Haodcdc85b2015-12-04 14:06:18 -08002971 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002972 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002973
2974 // When given --host, finish early without stripping.
2975 if (dex2oat.IsHost()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002976 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002977 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002978 }
2979
2980 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002981 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002982 }
2983
Jeff Haodcdc85b2015-12-04 14:06:18 -08002984 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2985 // stripped versions. If this is given, we expect to be able to open writable files by name.
David Srbeckyde91fd42018-07-05 22:27:08 +01002986 if (!dex2oat.CopyOatFilesToSymbolsDirectoryAndStrip()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002987 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002988 }
2989
Jeff Haodcdc85b2015-12-04 14:06:18 -08002990 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002991 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002992 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002993 }
2994
2995 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002996 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002997}
2998
Andreas Gampe7b565912017-03-20 15:48:52 -07002999static dex2oat::ReturnCode Dex2oat(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003000 b13564922();
3001
3002 TimingLogger timings("compiler", false, false);
3003
Roland Levillain5c7e2602016-02-23 18:08:53 +00003004 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
3005 // might produce a stack frame too large for this function or for
3006 // functions inlining it (such as main), that would not fit the
3007 // requirements of the `-Wframe-larger-than` option.
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07003008 std::unique_ptr<Dex2Oat> dex2oat = std::make_unique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003009
3010 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003011 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003012
Calin Juravleb077e152016-02-18 18:47:37 +00003013 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02003014 // This operation involves I/O.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08003015 if (dex2oat->UseProfile()) {
Calin Juravleb077e152016-02-18 18:47:37 +00003016 if (!dex2oat->LoadProfile()) {
3017 LOG(ERROR) << "Failed to process profile file";
Andreas Gampe7b565912017-03-20 15:48:52 -07003018 return dex2oat::ReturnCode::kOther;
Calin Juravle998c2162015-12-21 15:39:33 +02003019 }
3020 }
3021
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00003022 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap, and vdex.
3023
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003024 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00003025 if (!dex2oat->OpenFile()) {
Calin Juravlea6ff9932020-11-23 19:21:09 -08003026 // Flush close so that the File Guard checks don't fail the assertions.
3027 dex2oat->FlushCloseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07003028 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003029 }
3030
Andreas Gampe046c7062015-05-18 23:22:54 -07003031 // Print the complete line when any of the following is true:
3032 // 1) Debug build
3033 // 2) Compiling an image
3034 // 3) Compiling with --host
3035 // 4) Compiling on the host (not a target build)
3036 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003037 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07003038 LOG(INFO) << CommandLine();
3039 } else {
3040 LOG(INFO) << StrippedCommandLine();
3041 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003042
Andreas Gampef7882972017-03-20 16:35:24 -07003043 dex2oat::ReturnCode setup_code = dex2oat->Setup();
3044 if (setup_code != dex2oat::ReturnCode::kNoFailure) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003045 dex2oat->EraseOutputFiles();
Andreas Gampef7882972017-03-20 16:35:24 -07003046 return setup_code;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003047 }
3048
Shubham Ajmera188b2bf2017-09-20 15:53:35 -07003049 // TODO: Due to the cyclic dependencies, profile loading and verifying are
3050 // being done separately. Refactor and place the two next to each other.
3051 // If verification fails, we don't abort the compilation and instead log an
3052 // error.
3053 // TODO(b/62602192, b/65260586): We should consider aborting compilation when
3054 // the profile verification fails.
3055 // Note: If dex2oat fails, installd will remove the oat files causing the app
3056 // to fallback to apk with possible in-memory extraction. We want to avoid
3057 // that, and thus we're lenient towards profile corruptions.
3058 if (dex2oat->UseProfile()) {
3059 dex2oat->VerifyProfileData();
3060 }
3061
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07003062 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
3063 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07003064 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
3065
Andreas Gampe7b565912017-03-20 15:48:52 -07003066 dex2oat::ReturnCode result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00003067 if (dex2oat->IsImage()) {
3068 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08003069 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00003070 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003071 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003072
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003073 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003074}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003075} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07003076
3077int main(int argc, char** argv) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003078 int result = static_cast<int>(art::Dex2oat(argc, argv));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003079 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
Roland Levillain05e34f42018-05-24 13:19:05 +00003080 // time (bug 10645725) unless we're a debug or instrumented build or running on a memory tool.
3081 // Note: The Dex2Oat class should not destruct the runtime in this case.
3082 if (!art::kIsDebugBuild && !art::kIsPGOInstrumentation && !art::kRunningOnMemoryTool) {
Andreas Gampee286b642017-04-13 12:20:42 -07003083 _exit(result);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003084 }
3085 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07003086}