blob: 91d6513fc81a0d83e5fdfaa0441767cf03c6dfc8 [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
Vladimir Markof94b7812014-06-05 15:48:04 +010032#if defined(__linux__) && defined(__arm__)
33#include <sys/personality.h>
34#include <sys/utsname.h>
35#endif
36
Andreas Gampe46ee31b2016-12-14 10:11:49 -080037#include "android-base/stringprintf.h"
Andreas Gampe9186ced2016-12-12 14:28:21 -080038#include "android-base/strings.h"
39
Ian Rogersd582fa42014-11-05 23:46:43 -080040#include "arch/instruction_set_features.h"
Andreas Gampec5a3ea72015-01-13 16:41:53 -080041#include "arch/mips/instruction_set_features_mips.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000042#include "art_method-inl.h"
Andreas Gampe8228cdf2017-05-30 15:03:54 -070043#include "base/callee_save_type.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070044#include "base/dumpable.h"
David Sehr891a50e2017-10-27 17:01:07 -070045#include "base/file_utils.h"
David Sehr67bf42e2018-02-26 16:43:04 -080046#include "base/leb128.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080047#include "base/macros.h"
David Sehrc431b9d2018-03-02 12:01:51 -080048#include "base/mutex.h"
49#include "base/os.h"
Calin Juravle2e2db782016-02-23 12:00:03 +000050#include "base/scoped_flock.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070051#include "base/stl_util.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010052#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070053#include "base/timing_logger.h"
54#include "base/unix_file/fd_file.h"
David Sehrc431b9d2018-03-02 12:01:51 -080055#include "base/utils.h"
David Sehr79e26072018-04-06 17:58:50 -070056#include "base/zip_archive.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070057#include "class_linker.h"
Calin Juravle1ce70852017-06-28 10:59:03 -070058#include "class_loader_context.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070059#include "cmdline_parser.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000060#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000061#include "compiler_callbacks.h"
David Srbecky09c2a6b2016-03-11 17:11:44 +000062#include "debug/elf_debug_writer.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000063#include "debug/method_debug_info.h"
David Sehrb2ec9f52018-02-21 13:20:31 -080064#include "dex/descriptors_names.h"
David Sehr9e734c72018-01-04 17:56:19 -080065#include "dex/dex_file-inl.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000066#include "dex/quick_compiler_callbacks.h"
67#include "dex/verification_results.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070068#include "dex2oat_options.h"
Andreas Gampe7b565912017-03-20 15:48:52 -070069#include "dex2oat_return_codes.h"
David Srbecky2faab002019-02-12 16:35:48 +000070#include "dexlayout.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070071#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080072#include "driver/compiler_options.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070073#include "driver/compiler_options_map-inl.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080074#include "elf_file.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070075#include "gc/space/image_space.h"
76#include "gc/space/space-inl.h"
Mathieu Chartier72041a02017-07-14 18:23:25 -070077#include "gc/verification.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070078#include "interpreter/unstarted_runtime.h"
Vladimir Markoa3ad0cd2018-05-04 10:06:38 +010079#include "jni/java_vm_ext.h"
Vladimir Marko74527972016-11-29 15:57:32 +000080#include "linker/elf_writer.h"
81#include "linker/elf_writer_quick.h"
Vladimir Marko74527972016-11-29 15:57:32 +000082#include "linker/image_writer.h"
Vladimir Marko944da602016-02-19 12:27:55 +000083#include "linker/multi_oat_relative_patcher.h"
Vladimir Marko74527972016-11-29 15:57:32 +000084#include "linker/oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070085#include "mirror/class-inl.h"
86#include "mirror/class_loader.h"
87#include "mirror/object-inl.h"
88#include "mirror/object_array-inl.h"
Andreas Gampe2ff3b972017-06-05 18:14:53 -070089#include "oat_file.h"
Jeff Haob11ffb72016-04-07 15:40:54 -070090#include "oat_file_assistant.h"
David Sehr82d046e2018-04-23 08:14:19 -070091#include "profile/profile_compilation_info.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070092#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000093#include "runtime_options.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070094#include "scoped_thread_state_change-inl.h"
David Srbecky2faab002019-02-12 16:35:48 +000095#include "stream/buffered_output_stream.h"
96#include "stream/file_output_stream.h"
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +000097#include "vdex_file.h"
David Brazdilca3c8c32016-09-06 14:04:48 +010098#include "verifier/verifier_deps.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070099#include "well_known_classes.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -0700100
101namespace art {
102
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800103using android::base::StringAppendV;
104using android::base::StringPrintf;
Vladimir Marko91f10322018-12-07 18:04:10 +0000105using gc::space::ImageSpace;
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800106
Andreas Gampee1459ae2016-06-29 09:36:30 -0700107static constexpr size_t kDefaultMinDexFilesForSwap = 2;
108static constexpr size_t kDefaultMinDexFileCumulativeSizeForSwap = 20 * MB;
109
Mathieu Chartier010126f2017-07-15 15:44:18 -0700110// Compiler filter override for very large apps.
111static constexpr CompilerFilter::Filter kLargeAppFilter = CompilerFilter::kVerify;
112
Brian Carlstrom6449c622014-02-10 23:48:36 -0800113static int original_argc;
114static char** original_argv;
115
116static std::string CommandLine() {
117 std::vector<std::string> command;
Andreas Gampe2a487eb2018-11-19 11:41:22 -0800118 command.reserve(original_argc);
Brian Carlstrom6449c622014-02-10 23:48:36 -0800119 for (int i = 0; i < original_argc; ++i) {
120 command.push_back(original_argv[i]);
121 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800122 return android::base::Join(command, ' ');
Brian Carlstrom6449c622014-02-10 23:48:36 -0800123}
124
Andreas Gampe046c7062015-05-18 23:22:54 -0700125// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
126// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
127// locations are all staged).
128static std::string StrippedCommandLine() {
129 std::vector<std::string> command;
130
Calin Juravle07c6d722017-06-07 17:06:12 +0000131 // Do a pre-pass to look for zip-fd and the compiler filter.
Andreas Gampe046c7062015-05-18 23:22:54 -0700132 bool saw_zip_fd = false;
Calin Juravle07c6d722017-06-07 17:06:12 +0000133 bool saw_compiler_filter = false;
Andreas Gampe046c7062015-05-18 23:22:54 -0700134 for (int i = 0; i < original_argc; ++i) {
Andreas Gampe9186ced2016-12-12 14:28:21 -0800135 if (android::base::StartsWith(original_argv[i], "--zip-fd=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700136 saw_zip_fd = true;
Andreas Gampe046c7062015-05-18 23:22:54 -0700137 }
Calin Juravle07c6d722017-06-07 17:06:12 +0000138 if (android::base::StartsWith(original_argv[i], "--compiler-filter=")) {
139 saw_compiler_filter = true;
Calin Juravle07c6d722017-06-07 17:06:12 +0000140 }
Andreas Gampe046c7062015-05-18 23:22:54 -0700141 }
142
143 // Now filter out things.
144 for (int i = 0; i < original_argc; ++i) {
145 // All runtime-arg parameters are dropped.
146 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
147 i++; // Drop the next part, too.
148 continue;
149 }
150
151 // Any instruction-setXXX is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800152 if (android::base::StartsWith(original_argv[i], "--instruction-set")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700153 continue;
154 }
155
156 // The boot image is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800157 if (android::base::StartsWith(original_argv[i], "--boot-image=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700158 continue;
159 }
160
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800161 // The image format is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800162 if (android::base::StartsWith(original_argv[i], "--image-format=")) {
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800163 continue;
164 }
165
Andreas Gampe046c7062015-05-18 23:22:54 -0700166 // This should leave any dex-file and oat-file options, describing what we compiled.
167
168 // However, we prefer to drop this when we saw --zip-fd.
169 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700170 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe9186ced2016-12-12 14:28:21 -0800171 if (android::base::StartsWith(original_argv[i], "--zip-") ||
172 android::base::StartsWith(original_argv[i], "--dex-") ||
173 android::base::StartsWith(original_argv[i], "--oat-") ||
174 android::base::StartsWith(original_argv[i], "--swap-") ||
175 android::base::StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700176 continue;
177 }
178 }
179
180 command.push_back(original_argv[i]);
181 }
182
Calin Juravle07c6d722017-06-07 17:06:12 +0000183 if (!saw_compiler_filter) {
184 command.push_back("--compiler-filter=" +
185 CompilerFilter::NameOfFilter(CompilerFilter::kDefaultCompilerFilter));
186 }
187
Andreas Gampe046c7062015-05-18 23:22:54 -0700188 // Construct the final output.
189 if (command.size() <= 1U) {
Martin Stjernholmad909af2019-07-16 17:02:44 +0100190 // It seems only "/apex/com.android.art/bin/dex2oat" is left, or not
Roland Levillain38a938e2018-09-21 10:55:51 +0100191 // even that. Use a pretty line.
Andreas Gampe046c7062015-05-18 23:22:54 -0700192 return "Starting dex2oat.";
193 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800194 return android::base::Join(command, ' ');
Andreas Gampe046c7062015-05-18 23:22:54 -0700195}
196
Brian Carlstrom7940e442013-07-12 13:46:57 -0700197static void UsageErrorV(const char* fmt, va_list ap) {
198 std::string error;
199 StringAppendV(&error, fmt, ap);
200 LOG(ERROR) << error;
201}
202
203static void UsageError(const char* fmt, ...) {
204 va_list ap;
205 va_start(ap, fmt);
206 UsageErrorV(fmt, ap);
207 va_end(ap);
208}
209
Andreas Gampe794ad762015-02-23 08:12:24 -0800210NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700211 va_list ap;
212 va_start(ap, fmt);
213 UsageErrorV(fmt, ap);
214 va_end(ap);
215
Brian Carlstrom6449c622014-02-10 23:48:36 -0800216 UsageError("Command: %s", CommandLine().c_str());
217
Brian Carlstrom7940e442013-07-12 13:46:57 -0700218 UsageError("Usage: dex2oat [options]...");
219 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100220 UsageError(" -j<number>: specifies the number of threads used for compilation.");
221 UsageError(" Default is the number of detected hardware threads available on the");
222 UsageError(" host system.");
223 UsageError(" Example: -j12");
224 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700225 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700226 UsageError(" Example: --dex-file=/system/framework/core.jar");
227 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700228 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
229 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
230 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
231 UsageError(" --dex-location=/system/framework/core.jar");
232 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700233 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
234 UsageError(" containing a classes.dex file to compile.");
235 UsageError(" Example: --zip-fd=5");
236 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700237 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
238 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700239 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
240 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800241 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700242 UsageError(" Example: --oat-file=/system/framework/boot.oat");
243 UsageError("");
244 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900245 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700246 UsageError("");
Shubham Ajmera66205322017-10-06 11:18:51 -0700247 UsageError(" --input-vdex-fd=<number>: specifies the vdex input source via a file descriptor.");
248 UsageError(" Example: --input-vdex-fd=6");
249 UsageError("");
250 UsageError(" --output-vdex-fd=<number>: specifies the vdex output destination via a file");
251 UsageError(" descriptor.");
252 UsageError(" Example: --output-vdex-fd=6");
253 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700254 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
255 UsageError(" to the file descriptor specified by --oat-fd.");
256 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
257 UsageError("");
David Srbeckyde91fd42018-07-05 22:27:08 +0100258 UsageError(" --oat-symbols=<file.oat>: specifies a destination where the oat file is copied.");
259 UsageError(" This is equivalent to file copy as build post-processing step.");
260 UsageError(" It is intended to be used with --strip and it happens before it.");
261 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
262 UsageError("");
263 UsageError(" --strip: remove all debugging sections at the end (but keep mini-debug-info).");
264 UsageError(" This is equivalent to the \"strip\" command as build post-processing step.");
265 UsageError(" It is intended to be used with --oat-symbols and it happens after it.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700266 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
267 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800268 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700269 UsageError(" Example: --image=/system/framework/boot.art");
270 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800271 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800272 UsageError(" Which format to store the image.");
273 UsageError(" Example: --image-format=lz4");
274 UsageError(" Default: uncompressed");
275 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700276 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
277 UsageError(" Example: --base=0x50000000");
278 UsageError("");
279 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000280 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700281 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000282 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000283 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700284 UsageError("");
285 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
286 UsageError(" Example: --android-root=out/host/linux-x86");
287 UsageError(" Default: $ANDROID_ROOT");
288 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800289 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700290 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700291 UsageError(" Example: --instruction-set=x86");
292 UsageError(" Default: arm");
293 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700294 UsageError(" --instruction-set-features=...,: Specify instruction set features");
xueliang.zhong7f88c1a2018-11-06 11:42:41 +0000295 UsageError(" On target the value 'runtime' can be used to detect features at run time.");
296 UsageError(" If target does not support run-time detection the value 'runtime'");
297 UsageError(" has the same effect as the value 'default'.");
298 UsageError(" Note: the value 'runtime' has no effect if it is used on host.");
Dave Allison70202782013-10-22 17:52:19 -0700299 UsageError(" Example: --instruction-set-features=div");
300 UsageError(" Default: default");
301 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800302 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700303 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800304 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100305 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700306 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100307 UsageError(" --compiler-filter="
Nicolas Geoffray49cda062017-04-21 13:08:25 +0100308 "(assume-verified"
309 "|extract"
310 "|verify"
311 "|quicken"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000312 "|space-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100313 "|space"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000314 "|speed-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100315 "|speed"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000316 "|everything-profile"
317 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700318 UsageError(" select compiler filter.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800319 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800320 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800321 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800322 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
323 UsageError(" method for compiler filter tuning.");
324 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
325 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
326 UsageError("");
327 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
328 UsageError(" method for compiler filter tuning.");
329 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
330 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
331 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800332 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
333 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700334 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
335 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800336 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
337 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
338 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100339 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
340 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100341 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
342 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100343 UsageError(" Example: --inline-max-code-units=%d",
344 CompilerOptions::kDefaultInlineMaxCodeUnits);
345 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
346 UsageError("");
Nicolas Geoffraye82b60f2017-12-10 21:50:10 +0000347 UsageError(" --dump-timings: display a breakdown of where time was spent");
Ian Rogers46398602013-08-20 07:50:36 -0700348 UsageError("");
Vladimir Marko2da52b02018-05-08 16:31:34 +0100349 UsageError(" --dump-pass-timings: display a breakdown of time spent in optimization");
350 UsageError(" passes for each compiled method.");
351 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100352 UsageError(" -g");
353 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
354 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000355 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000356 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700357 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100358 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100359 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000360 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
361 UsageError(" debug information necessary to print backtraces. (disabled by default)");
362 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000363 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000364 UsageError("");
Alexey Alexandrovab40c112016-09-19 09:33:49 -0700365 UsageError(" --generate-build-id: Generate GNU-compatible linker build ID ELF section with");
366 UsageError(" SHA-1 of the file content (and thus stable across identical builds)");
367 UsageError("");
368 UsageError(" --no-generate-build-id: Do not generate the build ID ELF section.");
369 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000370 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000371 UsageError("");
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700372 UsageError(" --avoid-storing-invocation: Avoid storing the invocation args in the key value");
373 UsageError(" store. Used to test determinism with different args.");
374 UsageError("");
Alex Light62afcf52018-12-18 14:19:25 -0800375 UsageError(" --write-invocation-to=<file>: Write the invocation commandline to the given file");
376 UsageError(" for later use. Used to test determinism with different host architectures.");
377 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700378 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
379 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
380 UsageError(" Use a separate --runtime-arg switch for each argument.");
381 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700382 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000383 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700384 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000385 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
386 UsageError(" Cannot be used together with --profile-file.");
387 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100388 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800389 UsageError(" Example: --swap-file=/data/tmp/swap.001");
390 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100391 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800392 UsageError(" Example: --swap-fd=10");
393 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100394 UsageError(" --swap-dex-size-threshold=<size>: specifies the minimum total dex file size in");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700395 UsageError(" bytes to allow the use of swap.");
396 UsageError(" Example: --swap-dex-size-threshold=1000000");
397 UsageError(" Default: %zu", kDefaultMinDexFileCumulativeSizeForSwap);
398 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100399 UsageError(" --swap-dex-count-threshold=<count>: specifies the minimum number of dex files to");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700400 UsageError(" allow the use of swap.");
401 UsageError(" Example: --swap-dex-count-threshold=10");
402 UsageError(" Default: %zu", kDefaultMinDexFilesForSwap);
403 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100404 UsageError(" --very-large-app-threshold=<size>: specifies the minimum total dex file size in");
Mathieu Chartier010126f2017-07-15 15:44:18 -0700405 UsageError(" bytes to consider the input \"very large\" and reduce compilation done.");
Andreas Gampe67f02822016-06-24 21:05:23 -0700406 UsageError(" Example: --very-large-app-threshold=100000000");
407 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700408 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
Mathieu Chartierf85b3db2018-04-02 18:16:21 -0700409 UsageError(" The image is non-empty only if a profile is passed in.");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700410 UsageError(" Example: --app-image-fd=10");
411 UsageError("");
412 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
413 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
414 UsageError("");
Vladimir Marko4519b9d2018-10-10 15:21:21 +0100415 UsageError(" --multi-image: obsolete, ignored");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800416 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000417 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000418 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100419 UsageError(" --dump-cfg=<cfg-file>: dump control-flow graphs (CFGs) to specified file.");
420 UsageError(" Example: --dump-cfg=output.cfg");
421 UsageError("");
422 UsageError(" --dump-cfg-append: when dumping CFGs to an existing file, append new CFG data to");
423 UsageError(" existing data (instead of overwriting existing data with new data, which is");
424 UsageError(" the default behavior). This option is only meaningful when used with");
425 UsageError(" --dump-cfg.");
426 UsageError("");
Roland Levillaine1de95c2019-06-05 15:26:20 +0100427 UsageError(" --verbose-methods=<method-names>: Restrict dumped CFG data to methods whose name");
428 UsageError(" contain one of the method names passed as argument");
429 UsageError(" Example: --verbose-methods=toString,hashCode");
430 UsageError("");
Jeff Hao16d48432017-04-05 17:05:46 -0700431 UsageError(" --classpath-dir=<directory-path>: directory used to resolve relative class paths.");
432 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700433 UsageError(" --class-loader-context=<string spec>: a string specifying the intended");
434 UsageError(" runtime loading context for the compiled dex files.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700435 UsageError("");
Mathieu Chartierf5abfc42018-03-23 21:51:54 -0700436 UsageError(" --stored-class-loader-context=<string spec>: a string specifying the intended");
437 UsageError(" runtime loading context that is stored in the oat file. Overrides");
438 UsageError(" --class-loader-context. Note that this ignores the classpath_dir arg.");
439 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700440 UsageError(" It describes how the class loader chain should be built in order to ensure");
441 UsageError(" classes are resolved during dex2aot as they would be resolved at runtime.");
442 UsageError(" This spec will be encoded in the oat file. If at runtime the dex file is");
443 UsageError(" loaded in a different context, the oat file will be rejected.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700444 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700445 UsageError(" The chain is interpreted in the natural 'parent order', meaning that class");
446 UsageError(" loader 'i+1' will be the parent of class loader 'i'.");
Calin Juravlec79470d2017-07-12 17:37:42 -0700447 UsageError(" The compilation sources will be appended to the classpath of the first class");
448 UsageError(" loader.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700449 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700450 UsageError(" E.g. if the context is 'PCL[lib1.dex];DLC[lib2.dex]' and ");
451 UsageError(" --dex-file=src.dex then dex2oat will setup a PathClassLoader with classpath ");
452 UsageError(" 'lib1.dex:src.dex' and set its parent to a DelegateLastClassLoader with ");
453 UsageError(" classpath 'lib2.dex'.");
David Brazdil89821862019-03-19 13:57:43 +0000454 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700455 UsageError(" Note that the compiler will be tolerant if the source dex files specified");
456 UsageError(" with --dex-file are found in the classpath. The source dex files will be");
457 UsageError(" removed from any class loader's classpath possibly resulting in empty");
458 UsageError(" class loaders.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700459 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700460 UsageError(" Example: --class-loader-context=PCL[lib1.dex:lib2.dex];DLC[lib3.dex]");
Calin Juravle1ce70852017-06-28 10:59:03 -0700461 UsageError("");
David Brazdil89821862019-03-19 13:57:43 +0000462 UsageError(" --class-loader-context-fds=<fds>: a colon-separated list of file descriptors");
463 UsageError(" for dex files in --class-loader-context. Their order must be the same as");
464 UsageError(" dex files in flattened class loader context.");
465 UsageError("");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700466 UsageError(" --dirty-image-objects=<directory-path>: list of known dirty objects in the image.");
467 UsageError(" The image writer will group them together.");
468 UsageError("");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700469 UsageError(" --compact-dex-level=none|fast: None avoids generating compact dex, fast");
Mathieu Chartierddf39552018-04-03 10:22:27 -0700470 UsageError(" generates compact dex with low compile time. If speed-profile is specified as");
471 UsageError(" the compiler filter and the profile is not empty, the default compact dex");
472 UsageError(" level is always used.");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700473 UsageError("");
Andreas Gampee20ff6f2017-11-07 15:00:35 -0800474 UsageError(" --deduplicate-code=true|false: enable|disable code deduplication. Deduplicated");
475 UsageError(" code will have an arbitrary symbol tagged with [DEDUPED].");
Andreas Gampecac31ad2017-11-06 20:01:17 -0800476 UsageError("");
Nicolas Geoffray66ff8a82018-02-28 13:27:55 +0000477 UsageError(" --copy-dex-files=true|false: enable|disable copying the dex files into the");
Mathieu Chartier792111c2018-02-15 13:02:15 -0800478 UsageError(" output vdex.");
479 UsageError("");
Calin Juravle0e09dfc2018-02-12 19:01:09 -0800480 UsageError(" --compilation-reason=<string>: optional metadata specifying the reason for");
481 UsageError(" compiling the apk. If specified, the string will be embedded verbatim in");
482 UsageError(" the key value store of the oat file.");
Mathieu Chartier19667a02018-12-21 15:26:19 -0800483 UsageError(" Example: --compilation-reason=install");
Calin Juravle0e09dfc2018-02-12 19:01:09 -0800484 UsageError("");
Mathieu Chartiercd0f38f2018-10-15 09:44:35 -0700485 UsageError(" --resolve-startup-const-strings=true|false: If true, the compiler eagerly");
486 UsageError(" resolves strings referenced from const-string of startup methods.");
487 UsageError("");
Mathieu Chartier1a842962018-11-13 15:09:51 -0800488 UsageError(" --max-image-block-size=<size>: Maximum solid block size for compressed images.");
489 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700490 std::cerr << "See log for usage error information\n";
491 exit(EXIT_FAILURE);
492}
493
Brian Carlstrom7940e442013-07-12 13:46:57 -0700494// The primary goal of the watchdog is to prevent stuck build servers
495// during development when fatal aborts lead to a cascade of failures
496// that result in a deadlock.
497class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800498// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700499#undef CHECK_PTHREAD_CALL
500#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
501 do { \
502 int rc = call args; \
503 if (rc != 0) { \
504 errno = rc; \
505 std::string message(# call); \
506 message += " failed for "; \
507 message += reason; \
508 Fatal(message); \
509 } \
510 } while (false)
511
512 public:
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800513 explicit WatchDog(int64_t timeout_in_milliseconds)
Andreas Gampe0f54b0d2017-12-27 08:37:02 -0800514 : timeout_in_milliseconds_(timeout_in_milliseconds),
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800515 shutting_down_(false) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700516 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700517 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800518#ifndef __APPLE__
519 pthread_condattr_t condattr;
liulvping8f7101e2017-01-16 15:14:43 +0800520 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_init, (&condattr), reason);
521 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_setclock, (&condattr, CLOCK_MONOTONIC), reason);
522 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, &condattr), reason);
523 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_destroy, (&condattr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800524#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700525 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
526 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
527 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
528 }
529 ~WatchDog() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700530 const char* reason = "dex2oat watch dog thread shutdown";
531 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
532 shutting_down_ = true;
533 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
534 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
535
Kenny Root51316382014-05-13 14:59:37 -0700536 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700537
538 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
539 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
540 }
541
Koji Fukuia72ca6c2019-03-25 17:39:07 +0900542 static void SetRuntime(Runtime* runtime) {
543 const char* reason = "dex2oat watch dog set runtime";
544 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&runtime_mutex_), reason);
545 runtime_ = runtime;
546 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&runtime_mutex_), reason);
547 }
548
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800549 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
550 // large.
551 static constexpr int64_t kWatchdogVerifyMultiplier =
552 kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
553
554 // When setting timeouts, keep in mind that the build server may not be as fast as your
555 // desktop. Debug builds are slower so they have larger timeouts.
556 static constexpr int64_t kWatchdogSlowdownFactor = kIsDebugBuild ? 5U : 1U;
557
558 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
559 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
560 // itself before that watchdog would take down the system server.
561 static constexpr int64_t kWatchDogTimeoutSeconds = kWatchdogSlowdownFactor * (9 * 60 + 30);
562
563 static constexpr int64_t kDefaultWatchdogTimeoutInMS =
564 kWatchdogVerifyMultiplier * kWatchDogTimeoutSeconds * 1000;
565
Brian Carlstrom7940e442013-07-12 13:46:57 -0700566 private:
567 static void* CallBack(void* arg) {
568 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
569 ::art::SetThreadName("dex2oat watch dog");
570 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700571 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700572 }
573
Andreas Gampe794ad762015-02-23 08:12:24 -0800574 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700575 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
576 // it's rather easy to hang in unwinding.
577 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
578 // logcat logging or stderr output.
Tomasz Wasilczyk8d840902017-12-20 08:19:53 -0800579 LogHelper::LogLineLowStack(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
580
Andreas Gampe48fde372017-06-06 07:43:46 -0700581 // If we're on the host, try to dump all threads to get a sense of what's going on. This is
582 // restricted to the host as the dump may itself go bad.
583 // TODO: Use a double watchdog timeout, so we can enable this on-device.
Koji Fukuia72ca6c2019-03-25 17:39:07 +0900584 Runtime* runtime = GetRuntime();
585 if (!kIsTargetBuild && runtime != nullptr) {
586 runtime->AttachCurrentThread("Watchdog thread attached for dumping",
587 true,
588 nullptr,
589 false);
590 runtime->DumpForSigQuit(std::cerr);
Andreas Gampecd607312017-06-05 17:03:05 -0700591 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700592 exit(1);
593 }
594
595 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700596 timespec timeout_ts;
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800597#if defined(__APPLE__)
598 InitTimeSpec(true, CLOCK_REALTIME, timeout_in_milliseconds_, 0, &timeout_ts);
599#else
liulvping8f7101e2017-01-16 15:14:43 +0800600 InitTimeSpec(true, CLOCK_MONOTONIC, timeout_in_milliseconds_, 0, &timeout_ts);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800601#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700602 const char* reason = "dex2oat watch dog thread waiting";
603 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
604 while (!shutting_down_) {
Josh Gao2d899c42018-10-17 16:03:42 -0700605 int rc = pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts);
606 if (rc == EINTR) {
607 continue;
608 } else if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700609 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800610 timeout_in_milliseconds_/1000));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700611 } else if (rc != 0) {
Roland Levillaind6f8c8b2018-12-18 15:27:28 +0000612 std::string message(StringPrintf("pthread_cond_timedwait failed: %s", strerror(rc)));
Greg Kaiserf276f952019-03-26 08:15:44 -0700613 Fatal(message);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700614 }
615 }
616 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
617 }
618
Koji Fukuia72ca6c2019-03-25 17:39:07 +0900619 static Runtime* GetRuntime() {
620 const char* reason = "dex2oat watch dog get runtime";
621 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&runtime_mutex_), reason);
622 Runtime* runtime = runtime_;
623 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&runtime_mutex_), reason);
624 return runtime;
625 }
626
627 static pthread_mutex_t runtime_mutex_;
628 static Runtime* runtime_;
629
Brian Carlstrom7940e442013-07-12 13:46:57 -0700630 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
631 pthread_mutex_t mutex_;
632 pthread_cond_t cond_;
633 pthread_attr_t attr_;
634 pthread_t pthread_;
Andreas Gampef45d61c2017-06-07 10:29:33 -0700635
636 const int64_t timeout_in_milliseconds_;
637 bool shutting_down_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700638};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700639
Koji Fukuia72ca6c2019-03-25 17:39:07 +0900640pthread_mutex_t WatchDog::runtime_mutex_ = PTHREAD_MUTEX_INITIALIZER;
641Runtime* WatchDog::runtime_ = nullptr;
642
Roland Levillainbbc6e7e2018-08-24 16:58:47 +0100643class Dex2Oat final {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800644 public:
645 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100646 compiler_kind_(Compiler::kOptimizing),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800647 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000648 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700649 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800650 runtime_(nullptr),
651 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
652 start_ns_(NanoTime()),
Andreas Gampec560fc02014-07-16 09:57:39 -0700653 start_cputime_ns_(ProcessCpuNanoTime()),
Vladimir Marko2afaff72018-11-30 17:01:50 +0000654 strip_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800655 oat_fd_(-1),
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000656 input_vdex_fd_(-1),
657 output_vdex_fd_(-1),
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000658 input_vdex_file_(nullptr),
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +0000659 dm_fd_(-1),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800660 zip_fd_(-1),
661 image_base_(0U),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800662 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700663 passes_to_run_filename_(nullptr),
Mathieu Chartierff0baff2017-08-02 23:04:19 -0700664 dirty_image_objects_filename_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800665 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000666 elf_writers_(),
667 oat_writers_(),
668 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000669 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700670 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000671 opened_dex_files_maps_(),
672 opened_dex_files_(),
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700673 avoid_storing_invocation_(false),
Calin Juravle2e2db782016-02-23 12:00:03 +0000674 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800675 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000676 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800677 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000678 force_determinism_(false)
679 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800680
681 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800682 // Log completion time before deleting the runtime_, because this accesses
683 // the runtime.
684 LogCompletionTime();
685
Roland Levillain05e34f42018-05-24 13:19:05 +0000686 if (!kIsDebugBuild && !(kRunningOnMemoryTool && kMemoryToolDetectsLeaks)) {
Vladimir Marko307dac92015-10-20 11:20:09 +0100687 // We want to just exit on non-debug builds, not bringing the runtime down
688 // in an orderly fashion. So release the following fields.
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700689 driver_.release(); // NOLINT
690 image_writer_.release(); // NOLINT
Vladimir Marko307dac92015-10-20 11:20:09 +0100691 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700692 dex_file.release(); // NOLINT
Vladimir Marko307dac92015-10-20 11:20:09 +0100693 }
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100694 new std::vector<MemMap>(std::move(opened_dex_files_maps_)); // Leak MemMaps.
David Brazdil7b49e6c2016-09-01 11:06:18 +0100695 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700696 vdex_file.release(); // NOLINT
David Brazdil7b49e6c2016-09-01 11:06:18 +0100697 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800698 for (std::unique_ptr<File>& oat_file : oat_files_) {
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700699 oat_file.release(); // NOLINT
Jeff Haodcdc85b2015-12-04 14:06:18 -0800700 }
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700701 runtime_.release(); // NOLINT
702 verification_results_.release(); // NOLINT
703 key_value_store_.release(); // NOLINT
Vladimir Markof94b7812014-06-05 15:48:04 +0100704 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700705 }
706
Roland Levillain9ec5e222015-08-17 20:18:41 +0100707 struct ParserOptions {
Vladimir Markod011d812018-11-29 12:35:24 +0000708 std::vector<std::string> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800709 std::string boot_image_filename;
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800710 int64_t watch_dog_timeout_in_ms = -1;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800711 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000712 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800713 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100714 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800715
Andreas Gampe097f34c2017-08-23 08:57:51 -0700716 void ParseBase(const std::string& option) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100717 char* end;
Andreas Gampe097f34c2017-08-23 08:57:51 -0700718 image_base_ = strtoul(option.c_str(), &end, 16);
719 if (end == option.c_str() || *end != '\0') {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100720 Usage("Failed to parse hexadecimal value for option %s", option.data());
721 }
722 }
723
Shubham Ajmera188b2bf2017-09-20 15:53:35 -0700724 bool VerifyProfileData() {
Vladimir Marko213ee2d2018-06-22 11:56:34 +0100725 return profile_compilation_info_->VerifyProfileData(compiler_options_->dex_files_for_oat_file_);
Shubham Ajmera188b2bf2017-09-20 15:53:35 -0700726 }
727
Andreas Gampe097f34c2017-08-23 08:57:51 -0700728 void ParseInstructionSetVariant(const std::string& option, ParserOptions* parser_options) {
Vladimir Markoa0431112018-06-25 09:32:54 +0100729 compiler_options_->instruction_set_features_ = InstructionSetFeatures::FromVariant(
730 compiler_options_->instruction_set_, option, &parser_options->error_msg);
731 if (compiler_options_->instruction_set_features_ == nullptr) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100732 Usage("%s", parser_options->error_msg.c_str());
733 }
734 }
735
Andreas Gampe097f34c2017-08-23 08:57:51 -0700736 void ParseInstructionSetFeatures(const std::string& option, ParserOptions* parser_options) {
Vladimir Markoa0431112018-06-25 09:32:54 +0100737 if (compiler_options_->instruction_set_features_ == nullptr) {
738 compiler_options_->instruction_set_features_ = InstructionSetFeatures::FromVariant(
739 compiler_options_->instruction_set_, "default", &parser_options->error_msg);
740 if (compiler_options_->instruction_set_features_ == nullptr) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100741 Usage("Problem initializing default instruction set features variant: %s",
742 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700743 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800744 }
Vladimir Markoa0431112018-06-25 09:32:54 +0100745 compiler_options_->instruction_set_features_ =
746 compiler_options_->instruction_set_features_->AddFeaturesFromString(
747 option, &parser_options->error_msg);
748 if (compiler_options_->instruction_set_features_ == nullptr) {
Andreas Gampe097f34c2017-08-23 08:57:51 -0700749 Usage("Error parsing '%s': %s", option.c_str(), parser_options->error_msg.c_str());
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800750 }
751 }
752
Jeff Hao436183f2016-01-12 16:36:50 -0800753 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoa2da9b92018-10-10 14:21:55 +0100754 compiler_options_->compile_pic_ = true; // All AOT compilation is PIC.
Vladimir Marko9c4b9702018-11-14 15:09:02 +0000755 DCHECK(compiler_options_->image_type_ == CompilerOptions::ImageType::kNone);
756 if (!image_filenames_.empty()) {
Nicolas Geoffrayc5e3a522019-04-30 09:47:55 +0100757 if (android::base::EndsWith(image_filenames_[0], "apex.art")) {
758 compiler_options_->image_type_ = CompilerOptions::ImageType::kApexBootImage;
759 } else {
760 compiler_options_->image_type_ = CompilerOptions::ImageType::kBootImage;
761 }
Vladimir Marko9c4b9702018-11-14 15:09:02 +0000762 }
763 if (app_image_fd_ != -1 || !app_image_file_name_.empty()) {
764 if (compiler_options_->IsBootImage()) {
765 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
766 }
767 compiler_options_->image_type_ = CompilerOptions::ImageType::kAppImage;
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700768 }
769
Jeff Haodcdc85b2015-12-04 14:06:18 -0800770 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800771 Usage("Output must be supplied with either --oat-file or --oat-fd");
772 }
773
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000774 if (input_vdex_fd_ != -1 && !input_vdex_.empty()) {
775 Usage("Can't have both --input-vdex-fd and --input-vdex");
776 }
777
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +0100778 if (output_vdex_fd_ != -1 && !output_vdex_.empty()) {
779 Usage("Can't have both --output-vdex-fd and --output-vdex");
780 }
781
Jeff Haodcdc85b2015-12-04 14:06:18 -0800782 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800783 Usage("--oat-file should not be used with --oat-fd");
784 }
785
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000786 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
Sascha Roth5f71c652018-04-10 00:27:15 +0200787 Usage("VDEX and OAT output must be specified either with one --oat-file "
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000788 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100789 }
790
Roland Levillain9ec5e222015-08-17 20:18:41 +0100791 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800792 Usage("--oat-symbols should not be used with --oat-fd");
793 }
794
Roland Levillain9ec5e222015-08-17 20:18:41 +0100795 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800796 Usage("--oat-symbols should not be used with --host");
797 }
798
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000799 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
800 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100801 }
802
Jeff Haodcdc85b2015-12-04 14:06:18 -0800803 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800804 Usage("--oat-fd should not be used with --image");
805 }
806
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +0000807 if ((input_vdex_fd_ != -1 || !input_vdex_.empty()) &&
808 (dm_fd_ != -1 || !dm_file_location_.empty())) {
809 Usage("An input vdex should not be passed with a .dm file");
810 }
811
Jeff Haodcdc85b2015-12-04 14:06:18 -0800812 if (!parser_options->oat_symbols.empty() &&
813 parser_options->oat_symbols.size() != oat_filenames_.size()) {
814 Usage("--oat-file arguments do not match --oat-symbols arguments");
815 }
816
817 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
818 Usage("--oat-file arguments do not match --image arguments");
819 }
820
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800821 if (android_root_.empty()) {
822 const char* android_root_env_var = getenv("ANDROID_ROOT");
823 if (android_root_env_var == nullptr) {
824 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700825 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800826 android_root_ += android_root_env_var;
827 }
828
Vladimir Markoaad75c62016-10-03 08:46:48 +0000829 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Nicolas Geoffrayde1b2a22019-02-27 09:10:57 +0000830 parser_options->boot_image_filename = GetDefaultBootImageLocation(android_root_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800831 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100832 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000833 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800834 }
835
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800836 if (dex_filenames_.empty() && zip_fd_ == -1) {
837 Usage("Input must be supplied with either --dex-file or --zip-fd");
838 }
839
840 if (!dex_filenames_.empty() && zip_fd_ != -1) {
841 Usage("--dex-file should not be used with --zip-fd");
842 }
843
844 if (!dex_filenames_.empty() && !zip_location_.empty()) {
845 Usage("--dex-file should not be used with --zip-location");
846 }
847
848 if (dex_locations_.empty()) {
Vladimir Markod011d812018-11-29 12:35:24 +0000849 dex_locations_ = dex_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800850 } else if (dex_locations_.size() != dex_filenames_.size()) {
851 Usage("--dex-location arguments do not match --dex-file arguments");
852 }
853
Jeff Haodcdc85b2015-12-04 14:06:18 -0800854 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
855 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
856 Usage("--oat-file arguments must be singular or match --dex-file arguments");
857 }
858 }
859
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800860 if (zip_fd_ != -1 && zip_location_.empty()) {
861 Usage("--zip-location should be supplied with --zip-fd");
862 }
863
Vladimir Marko49b0f452015-12-10 13:49:19 +0000864 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800865 if (image_base_ == 0) {
Vladimir Marko66235942019-06-03 16:05:17 +0100866 Usage("Non-zero --base not specified for boot image");
867 }
868 } else {
869 if (image_base_ != 0) {
870 Usage("Non-zero --base specified for app image or boot image extension");
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800871 }
872 }
873
Mathieu Chartiera8077802016-03-16 19:08:31 -0700874 const bool have_profile_file = !profile_file_.empty();
875 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
876 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000877 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200878 }
879
Roland Levillain9ec5e222015-08-17 20:18:41 +0100880 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800881 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800882 }
883
xueliang.zhong7f88c1a2018-11-06 11:42:41 +0000884 if (compiler_options_->instruction_set_features_ == nullptr) {
885 // '--instruction-set-features/--instruction-set-variant' were not used.
886 // Use features for the 'default' variant.
Vladimir Markoa0431112018-06-25 09:32:54 +0100887 compiler_options_->instruction_set_features_ = InstructionSetFeatures::FromVariant(
888 compiler_options_->instruction_set_, "default", &parser_options->error_msg);
889 if (compiler_options_->instruction_set_features_ == nullptr) {
Ian Rogersd582fa42014-11-05 23:46:43 -0800890 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100891 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800892 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800893 }
894
Vladimir Markoa0431112018-06-25 09:32:54 +0100895 if (compiler_options_->instruction_set_ == kRuntimeISA) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800896 std::unique_ptr<const InstructionSetFeatures> runtime_features(
897 InstructionSetFeatures::FromCppDefines());
Vladimir Markoa0431112018-06-25 09:32:54 +0100898 if (!compiler_options_->GetInstructionSetFeatures()->Equals(runtime_features.get())) {
xueliang.zhong7f88c1a2018-11-06 11:42:41 +0000899 LOG(WARNING) << "Mismatch between dex2oat instruction set features to use ("
Vladimir Markoa0431112018-06-25 09:32:54 +0100900 << *compiler_options_->GetInstructionSetFeatures()
xueliang.zhong7f88c1a2018-11-06 11:42:41 +0000901 << ") and those from CPP defines (" << *runtime_features
Vladimir Markoa0431112018-06-25 09:32:54 +0100902 << ") for the command line:\n" << CommandLine();
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800903 }
904 }
905
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000906 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +0000907 compiler_options_->inline_max_code_units_ = CompilerOptions::kDefaultInlineMaxCodeUnits;
Roland Levillaina215b952015-08-07 11:38:32 +0100908 }
909
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800910 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800911 // Set the compilation target's implicit checks options.
Vladimir Markoa0431112018-06-25 09:32:54 +0100912 switch (compiler_options_->GetInstructionSet()) {
Vladimir Marko33bff252017-11-01 14:35:42 +0000913 case InstructionSet::kArm:
914 case InstructionSet::kThumb2:
915 case InstructionSet::kArm64:
916 case InstructionSet::kX86:
917 case InstructionSet::kX86_64:
918 case InstructionSet::kMips:
919 case InstructionSet::kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000920 compiler_options_->implicit_null_checks_ = true;
921 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800922 break;
923
924 default:
925 // Defaults are correct.
926 break;
927 }
928
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800929 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100930 if (parser_options->watch_dog_enabled) {
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800931 int64_t timeout = parser_options->watch_dog_timeout_in_ms > 0
932 ? parser_options->watch_dog_timeout_in_ms
933 : WatchDog::kDefaultWatchdogTimeoutInMS;
934 watchdog_.reset(new WatchDog(timeout));
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800935 }
936
937 // Fill some values into the key-value store for the oat header.
938 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800939
Vladimir Marko78342412019-07-25 17:28:02 +0100940 // Automatically force determinism for the boot image in a host build.
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800941 if (!kIsTargetBuild && IsBootImage()) {
Vladimir Marko78342412019-07-25 17:28:02 +0100942 force_determinism_ = true;
Andreas Gampeace0dc12016-01-20 13:33:13 -0800943 }
944 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700945
946 if (passes_to_run_filename_ != nullptr) {
Vladimir Marko54159c62018-06-20 14:30:08 +0100947 passes_to_run_ = ReadCommentedInputFromFile<std::vector<std::string>>(
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700948 passes_to_run_filename_,
Vladimir Marko54159c62018-06-20 14:30:08 +0100949 nullptr); // No post-processing.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700950 if (passes_to_run_.get() == nullptr) {
951 Usage("Failed to read list of passes to run.");
952 }
953 }
954 compiler_options_->passes_to_run_ = passes_to_run_.get();
Vladimir Marko6be1dbd2018-11-13 13:09:51 +0000955 compiler_options_->compiling_with_core_image_ =
956 !boot_image_filename_.empty() &&
Vladimir Marko038924b2019-02-19 15:09:35 +0000957 CompilerOptions::IsCoreImageFilename(boot_image_filename_);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100958 }
959
Jeff Hao436183f2016-01-12 16:36:50 -0800960 void ExpandOatAndImageFilenames() {
Vladimir Marko91f10322018-12-07 18:04:10 +0000961 if (image_filenames_[0].rfind('/') == std::string::npos) {
962 Usage("Unusable boot image filename %s", image_filenames_[0].c_str());
Jeff Hao436183f2016-01-12 16:36:50 -0800963 }
Vladimir Marko91f10322018-12-07 18:04:10 +0000964 image_filenames_ = ImageSpace::ExpandMultiImageLocations(dex_locations_, image_filenames_[0]);
Jeff Hao436183f2016-01-12 16:36:50 -0800965
Vladimir Marko91f10322018-12-07 18:04:10 +0000966 if (oat_filenames_[0].rfind('/') == std::string::npos) {
967 Usage("Unusable boot image oat filename %s", oat_filenames_[0].c_str());
Vladimir Markodb4b1de2018-12-07 17:18:07 +0000968 }
Vladimir Marko91f10322018-12-07 18:04:10 +0000969 oat_filenames_ = ImageSpace::ExpandMultiImageLocations(dex_locations_, oat_filenames_[0]);
Vladimir Markodb4b1de2018-12-07 17:18:07 +0000970
bowen_lai8bd36c02016-10-12 13:28:55 +0800971 if (!oat_unstripped_.empty()) {
Vladimir Marko91f10322018-12-07 18:04:10 +0000972 if (oat_unstripped_[0].rfind('/') == std::string::npos) {
973 Usage("Unusable boot image symbol filename %s", oat_unstripped_[0].c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +0800974 }
Vladimir Marko91f10322018-12-07 18:04:10 +0000975 oat_unstripped_ = ImageSpace::ExpandMultiImageLocations(dex_locations_, oat_unstripped_[0]);
bowen_lai8bd36c02016-10-12 13:28:55 +0800976 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800977 }
978
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000979 void InsertCompileOptions(int argc, char** argv) {
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700980 if (!avoid_storing_invocation_) {
Vladimir Marko56581d82018-11-07 12:30:52 +0000981 std::ostringstream oss;
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700982 for (int i = 0; i < argc; ++i) {
983 if (i > 0) {
984 oss << ' ';
985 }
986 oss << argv[i];
Roland Levillain9ec5e222015-08-17 20:18:41 +0100987 }
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700988 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
Roland Levillain9ec5e222015-08-17 20:18:41 +0100989 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100990 key_value_store_->Put(
Roland Levillain9ec5e222015-08-17 20:18:41 +0100991 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000992 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +0000993 key_value_store_->Put(
994 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +0000995 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +0000996 key_value_store_->Put(OatHeader::kCompilerFilter,
997 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Andreas Gampef8cd8902017-01-18 16:05:01 -0800998 key_value_store_->Put(OatHeader::kConcurrentCopying,
999 kUseReadBarrier ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Alex Light62afcf52018-12-18 14:19:25 -08001000 if (invocation_file_.get() != -1) {
1001 std::ostringstream oss;
1002 for (int i = 0; i < argc; ++i) {
1003 if (i > 0) {
1004 oss << std::endl;
1005 }
1006 oss << argv[i];
1007 }
1008 std::string invocation(oss.str());
1009 if (TEMP_FAILURE_RETRY(write(invocation_file_.get(),
1010 invocation.c_str(),
1011 invocation.size())) == -1) {
1012 Usage("Unable to write invocation file");
1013 }
1014 }
Roland Levillain9ec5e222015-08-17 20:18:41 +01001015 }
1016
Andreas Gampe097f34c2017-08-23 08:57:51 -07001017 // This simple forward is here so the string specializations below don't look out of place.
1018 template <typename T, typename U>
1019 void AssignIfExists(Dex2oatArgumentMap& map,
1020 const Dex2oatArgumentMap::Key<T>& key,
1021 U* out) {
1022 map.AssignIfExists(key, out);
1023 }
1024
1025 // Specializations to handle const char* vs std::string.
1026 void AssignIfExists(Dex2oatArgumentMap& map,
1027 const Dex2oatArgumentMap::Key<std::string>& key,
1028 const char** out) {
1029 if (map.Exists(key)) {
1030 char_backing_storage_.push_front(std::move(*map.Get(key)));
1031 *out = char_backing_storage_.front().c_str();
1032 }
1033 }
1034 void AssignIfExists(Dex2oatArgumentMap& map,
1035 const Dex2oatArgumentMap::Key<std::vector<std::string>>& key,
1036 std::vector<const char*>* out) {
1037 if (map.Exists(key)) {
1038 for (auto& val : *map.Get(key)) {
1039 char_backing_storage_.push_front(std::move(val));
1040 out->push_back(char_backing_storage_.front().c_str());
1041 }
1042 }
1043 }
1044
1045 template <typename T>
1046 void AssignTrueIfExists(Dex2oatArgumentMap& map,
1047 const Dex2oatArgumentMap::Key<T>& key,
1048 bool* out) {
1049 if (map.Exists(key)) {
1050 *out = true;
1051 }
1052 }
1053
Roland Levillain9ec5e222015-08-17 20:18:41 +01001054 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1055 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1056 // returns, arguments have been successfully parsed.
1057 void ParseArgs(int argc, char** argv) {
1058 original_argc = argc;
1059 original_argv = argv;
1060
David Sehrc431b9d2018-03-02 12:01:51 -08001061 Locks::Init();
Andreas Gampe51d80cc2017-06-21 21:05:13 -07001062 InitLogging(argv, Runtime::Abort);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001063
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001064 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001065
Andreas Gampe097f34c2017-08-23 08:57:51 -07001066 using M = Dex2oatArgumentMap;
1067 std::string error_msg;
1068 std::unique_ptr<M> args_uptr = M::Parse(argc, const_cast<const char**>(argv), &error_msg);
1069 if (args_uptr == nullptr) {
1070 Usage("Failed to parse command line: %s", error_msg.c_str());
1071 UNREACHABLE();
1072 }
1073
1074 M& args = *args_uptr;
1075
1076 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
1077
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07001078 AssignIfExists(args, M::CompactDexLevel, &compact_dex_level_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001079 AssignIfExists(args, M::DexFiles, &dex_filenames_);
1080 AssignIfExists(args, M::DexLocations, &dex_locations_);
1081 AssignIfExists(args, M::OatFiles, &oat_filenames_);
1082 AssignIfExists(args, M::OatSymbols, &parser_options->oat_symbols);
David Srbeckyde91fd42018-07-05 22:27:08 +01001083 AssignTrueIfExists(args, M::Strip, &strip_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001084 AssignIfExists(args, M::ImageFilenames, &image_filenames_);
1085 AssignIfExists(args, M::ZipFd, &zip_fd_);
1086 AssignIfExists(args, M::ZipLocation, &zip_location_);
1087 AssignIfExists(args, M::InputVdexFd, &input_vdex_fd_);
1088 AssignIfExists(args, M::OutputVdexFd, &output_vdex_fd_);
1089 AssignIfExists(args, M::InputVdex, &input_vdex_);
1090 AssignIfExists(args, M::OutputVdex, &output_vdex_);
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001091 AssignIfExists(args, M::DmFd, &dm_fd_);
1092 AssignIfExists(args, M::DmFile, &dm_file_location_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001093 AssignIfExists(args, M::OatFd, &oat_fd_);
1094 AssignIfExists(args, M::OatLocation, &oat_location_);
1095 AssignIfExists(args, M::Watchdog, &parser_options->watch_dog_enabled);
1096 AssignIfExists(args, M::WatchdogTimeout, &parser_options->watch_dog_timeout_in_ms);
1097 AssignIfExists(args, M::Threads, &thread_count_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001098 AssignIfExists(args, M::Passes, &passes_to_run_filename_);
1099 AssignIfExists(args, M::BootImage, &parser_options->boot_image_filename);
1100 AssignIfExists(args, M::AndroidRoot, &android_root_);
1101 AssignIfExists(args, M::Profile, &profile_file_);
1102 AssignIfExists(args, M::ProfileFd, &profile_file_fd_);
1103 AssignIfExists(args, M::RuntimeOptions, &runtime_args_);
1104 AssignIfExists(args, M::SwapFile, &swap_file_name_);
1105 AssignIfExists(args, M::SwapFileFd, &swap_fd_);
1106 AssignIfExists(args, M::SwapDexSizeThreshold, &min_dex_file_cumulative_size_for_swap_);
1107 AssignIfExists(args, M::SwapDexCountThreshold, &min_dex_files_for_swap_);
1108 AssignIfExists(args, M::VeryLargeAppThreshold, &very_large_threshold_);
1109 AssignIfExists(args, M::AppImageFile, &app_image_file_name_);
1110 AssignIfExists(args, M::AppImageFileFd, &app_image_fd_);
1111 AssignIfExists(args, M::NoInlineFrom, &no_inline_from_string_);
1112 AssignIfExists(args, M::ClasspathDir, &classpath_dir_);
1113 AssignIfExists(args, M::DirtyImageObjects, &dirty_image_objects_filename_);
1114 AssignIfExists(args, M::ImageFormat, &image_storage_mode_);
Calin Juravle0e09dfc2018-02-12 19:01:09 -08001115 AssignIfExists(args, M::CompilationReason, &compilation_reason_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001116
1117 AssignIfExists(args, M::Backend, &compiler_kind_);
1118 parser_options->requested_specific_compiler = args.Exists(M::Backend);
1119
Vladimir Markoa0431112018-06-25 09:32:54 +01001120 AssignIfExists(args, M::TargetInstructionSet, &compiler_options_->instruction_set_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001121 // arm actually means thumb2.
Vladimir Markoa0431112018-06-25 09:32:54 +01001122 if (compiler_options_->instruction_set_ == InstructionSet::kArm) {
1123 compiler_options_->instruction_set_ = InstructionSet::kThumb2;
Andreas Gampe097f34c2017-08-23 08:57:51 -07001124 }
1125
1126 AssignTrueIfExists(args, M::Host, &is_host_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001127 AssignTrueIfExists(args, M::AvoidStoringInvocation, &avoid_storing_invocation_);
Alex Light62afcf52018-12-18 14:19:25 -08001128 if (args.Exists(M::InvocationFile)) {
1129 invocation_file_.reset(open(args.Get(M::InvocationFile)->c_str(),
1130 O_CREAT|O_WRONLY|O_TRUNC|O_CLOEXEC,
1131 S_IRUSR|S_IWUSR));
1132 if (invocation_file_.get() == -1) {
1133 int err = errno;
1134 Usage("Unable to open invocation file '%s' for writing due to %s.",
1135 args.Get(M::InvocationFile)->c_str(), strerror(err));
1136 }
1137 }
Mathieu Chartier792111c2018-02-15 13:02:15 -08001138 AssignIfExists(args, M::CopyDexFiles, &copy_dex_files_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001139
1140 if (args.Exists(M::ForceDeterminism)) {
Andreas Gampe097f34c2017-08-23 08:57:51 -07001141 force_determinism_ = true;
1142 }
1143
1144 if (args.Exists(M::Base)) {
1145 ParseBase(*args.Get(M::Base));
1146 }
1147 if (args.Exists(M::TargetInstructionSetVariant)) {
1148 ParseInstructionSetVariant(*args.Get(M::TargetInstructionSetVariant), parser_options.get());
1149 }
1150 if (args.Exists(M::TargetInstructionSetFeatures)) {
1151 ParseInstructionSetFeatures(*args.Get(M::TargetInstructionSetFeatures), parser_options.get());
1152 }
1153 if (args.Exists(M::ClassLoaderContext)) {
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001154 std::string class_loader_context_arg = *args.Get(M::ClassLoaderContext);
1155 class_loader_context_ = ClassLoaderContext::Create(class_loader_context_arg);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001156 if (class_loader_context_ == nullptr) {
1157 Usage("Option --class-loader-context has an incorrect format: %s",
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001158 class_loader_context_arg.c_str());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001159 }
David Brazdil89821862019-03-19 13:57:43 +00001160 if (args.Exists(M::ClassLoaderContextFds)) {
1161 std::string str_fds_arg = *args.Get(M::ClassLoaderContextFds);
1162 std::vector<std::string> str_fds = android::base::Split(str_fds_arg, ":");
1163 for (const std::string& str_fd : str_fds) {
1164 class_loader_context_fds_.push_back(std::stoi(str_fd, nullptr, 0));
1165 if (class_loader_context_fds_.back() < 0) {
1166 Usage("Option --class-loader-context-fds has incorrect format: %s",
1167 str_fds_arg.c_str());
1168 }
1169 }
1170 }
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001171 if (args.Exists(M::StoredClassLoaderContext)) {
Mathieu Chartierc4440772018-04-16 14:40:56 -07001172 const std::string stored_context_arg = *args.Get(M::StoredClassLoaderContext);
1173 stored_class_loader_context_ = ClassLoaderContext::Create(stored_context_arg);
1174 if (stored_class_loader_context_ == nullptr) {
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001175 Usage("Option --stored-class-loader-context has an incorrect format: %s",
Mathieu Chartierc4440772018-04-16 14:40:56 -07001176 stored_context_arg.c_str());
Vladimir Markod8860b42018-05-02 14:58:12 +01001177 } else if (class_loader_context_->VerifyClassLoaderContextMatch(
Mathieu Chartierc4440772018-04-16 14:40:56 -07001178 stored_context_arg,
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001179 /*verify_names*/ false,
Vladimir Markod8860b42018-05-02 14:58:12 +01001180 /*verify_checksums*/ false) != ClassLoaderContext::VerificationResult::kVerifies) {
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001181 Usage(
1182 "Option --stored-class-loader-context '%s' mismatches --class-loader-context '%s'",
Mathieu Chartierc4440772018-04-16 14:40:56 -07001183 stored_context_arg.c_str(),
1184 class_loader_context_arg.c_str());
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001185 }
1186 }
1187 } else if (args.Exists(M::StoredClassLoaderContext)) {
1188 Usage("Option --stored-class-loader-context should only be used if "
1189 "--class-loader-context is also specified");
Roland Levillain9ec5e222015-08-17 20:18:41 +01001190 }
1191
Andreas Gampe097f34c2017-08-23 08:57:51 -07001192 if (!ReadCompilerOptions(args, compiler_options_.get(), &error_msg)) {
1193 Usage(error_msg.c_str());
1194 }
1195
Jeff Hao436183f2016-01-12 16:36:50 -08001196 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001197
1198 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001199 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001200 }
1201
Jeff Haodcdc85b2015-12-04 14:06:18 -08001202 // Check whether the oat output files are writable, and open them for later. Also open a swap
1203 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001204 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001205 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1206 PruneNonExistentDexFiles();
1207
Jeff Hao436183f2016-01-12 16:36:50 -08001208 // Expand oat and image filenames for multi image.
Vladimir Marko4519b9d2018-10-10 15:21:21 +01001209 if (IsBootImage() && image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -08001210 ExpandOatAndImageFilenames();
1211 }
1212
David Brazdil7b49e6c2016-09-01 11:06:18 +01001213 // OAT and VDEX file handling
David Brazdil7b49e6c2016-09-01 11:06:18 +01001214 if (oat_fd_ == -1) {
1215 DCHECK(!oat_filenames_.empty());
Vladimir Markod011d812018-11-29 12:35:24 +00001216 for (const std::string& oat_filename : oat_filenames_) {
1217 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename.c_str()));
Calin Juravleb09be722017-09-25 16:42:48 -07001218 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001219 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1220 return false;
1221 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001222 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001223 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1224 oat_file->Erase();
1225 return false;
1226 }
1227 oat_files_.push_back(std::move(oat_file));
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001228 DCHECK_EQ(input_vdex_fd_, -1);
1229 if (!input_vdex_.empty()) {
1230 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001231 input_vdex_file_ = VdexFile::Open(input_vdex_,
1232 /* writable */ false,
1233 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001234 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001235 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001236 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001237
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001238 DCHECK_EQ(output_vdex_fd_, -1);
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001239 std::string vdex_filename = output_vdex_.empty()
1240 ? ReplaceFileExtension(oat_filename, "vdex")
1241 : output_vdex_;
1242 if (vdex_filename == input_vdex_ && output_vdex_.empty()) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001243 update_input_vdex_ = true;
1244 std::unique_ptr<File> vdex_file(OS::OpenFileReadWrite(vdex_filename.c_str()));
1245 vdex_files_.push_back(std::move(vdex_file));
1246 } else {
1247 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
Calin Juravleb09be722017-09-25 16:42:48 -07001248 if (vdex_file == nullptr) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001249 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1250 return false;
1251 }
1252 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1253 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1254 vdex_file->Erase();
1255 return false;
1256 }
1257 vdex_files_.push_back(std::move(vdex_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001258 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001259 }
1260 } else {
Josh Gaoafeec9f2018-08-30 14:05:56 -07001261 std::unique_ptr<File> oat_file(
1262 new File(DupCloexec(oat_fd_), oat_location_, /* check_usage */ true));
1263 if (!oat_file->IsOpened()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001264 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1265 return false;
1266 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001267 if (oat_file->SetLength(0) != 0) {
1268 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001269 oat_file->Erase();
1270 return false;
David Brazdil7b49e6c2016-09-01 11:06:18 +01001271 }
1272 oat_files_.push_back(std::move(oat_file));
1273
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001274 if (input_vdex_fd_ != -1) {
1275 struct stat s;
1276 int rc = TEMP_FAILURE_RETRY(fstat(input_vdex_fd_, &s));
1277 if (rc == -1) {
1278 PLOG(WARNING) << "Failed getting length of vdex file";
1279 } else {
1280 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001281 input_vdex_file_ = VdexFile::Open(input_vdex_fd_,
1282 s.st_size,
1283 "vdex",
1284 /* writable */ false,
1285 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001286 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001287 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001288 // If there's any problem with the passed vdex, just warn and proceed
1289 // without it.
1290 if (input_vdex_file_ == nullptr) {
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001291 PLOG(WARNING) << "Failed opening vdex file: " << error_msg;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001292 }
1293 }
1294 }
1295
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001296 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001297 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Josh Gaoafeec9f2018-08-30 14:05:56 -07001298 std::unique_ptr<File> vdex_file(new File(
1299 DupCloexec(output_vdex_fd_), vdex_location, /* check_usage */ true));
1300 if (!vdex_file->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001301 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001302 return false;
1303 }
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001304 if (input_vdex_file_ != nullptr && output_vdex_fd_ == input_vdex_fd_) {
1305 update_input_vdex_ = true;
1306 } else {
1307 if (vdex_file->SetLength(0) != 0) {
1308 PLOG(ERROR) << "Truncating vdex file " << vdex_location << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001309 vdex_file->Erase();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001310 return false;
1311 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001312 }
1313 vdex_files_.push_back(std::move(vdex_file));
1314
Vladimir Markod011d812018-11-29 12:35:24 +00001315 oat_filenames_.push_back(oat_location_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001316 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001317
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001318 // If we're updating in place a vdex file, be defensive and put an invalid vdex magic in case
1319 // dex2oat gets killed.
1320 // Note: we're only invalidating the magic data in the file, as dex2oat needs the rest of
1321 // the information to remain valid.
1322 if (update_input_vdex_) {
David Srbecky2faab002019-02-12 16:35:48 +00001323 std::unique_ptr<BufferedOutputStream> vdex_out =
1324 std::make_unique<BufferedOutputStream>(
1325 std::make_unique<FileOutputStream>(vdex_files_.back().get()));
Nicolas Geoffray3a293552018-03-02 10:52:16 +00001326 if (!vdex_out->WriteFully(&VdexFile::VerifierDepsHeader::kVdexInvalidMagic,
1327 arraysize(VdexFile::VerifierDepsHeader::kVdexInvalidMagic))) {
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001328 PLOG(ERROR) << "Failed to invalidate vdex header. File: " << vdex_out->GetLocation();
1329 return false;
1330 }
1331
1332 if (!vdex_out->Flush()) {
1333 PLOG(ERROR) << "Failed to flush stream after invalidating header of vdex file."
1334 << " File: " << vdex_out->GetLocation();
1335 return false;
1336 }
1337 }
1338
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001339 if (dm_fd_ != -1 || !dm_file_location_.empty()) {
1340 std::string error_msg;
1341 if (dm_fd_ != -1) {
1342 dm_file_.reset(ZipArchive::OpenFromFd(dm_fd_, "DexMetadata", &error_msg));
1343 } else {
1344 dm_file_.reset(ZipArchive::Open(dm_file_location_.c_str(), &error_msg));
1345 }
1346 if (dm_file_ == nullptr) {
1347 LOG(WARNING) << "Could not open DexMetadata archive " << error_msg;
1348 }
1349 }
1350
1351 if (dm_file_ != nullptr) {
1352 DCHECK(input_vdex_file_ == nullptr);
1353 std::string error_msg;
1354 static const char* kDexMetadata = "DexMetadata";
1355 std::unique_ptr<ZipEntry> zip_entry(dm_file_->Find(VdexFile::kVdexNameInDmFile, &error_msg));
1356 if (zip_entry == nullptr) {
1357 LOG(INFO) << "No " << VdexFile::kVdexNameInDmFile << " file in DexMetadata archive. "
1358 << "Not doing fast verification.";
1359 } else {
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001360 MemMap input_file = zip_entry->MapDirectlyOrExtract(
Mathieu Chartier792111c2018-02-15 13:02:15 -08001361 VdexFile::kVdexNameInDmFile,
1362 kDexMetadata,
Colin Cross2b41cca2018-11-16 22:43:41 -08001363 &error_msg,
1364 alignof(VdexFile));
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001365 if (!input_file.IsValid()) {
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001366 LOG(WARNING) << "Could not open vdex file in DexMetadata archive: " << error_msg;
1367 } else {
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001368 input_vdex_file_ = std::make_unique<VdexFile>(std::move(input_file));
Calin Juravle5ffefaa2019-01-25 01:04:54 -08001369 VLOG(verifier) << "Doing fast verification with vdex from DexMetadata archive";
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001370 }
1371 }
1372 }
1373
David Brazdil7b49e6c2016-09-01 11:06:18 +01001374 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001375 //
1376 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1377 // that we can use for swap.
1378 //
1379 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1380 // will immediately unlink to satisfy the swap fd assumption.
1381 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1382 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1383 if (swap_file.get() == nullptr) {
1384 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1385 return false;
1386 }
Josh Gaoafeec9f2018-08-30 14:05:56 -07001387 swap_fd_ = swap_file->Release();
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001388 unlink(swap_file_name_.c_str());
1389 }
Jeff Hao436183f2016-01-12 16:36:50 -08001390
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001391 return true;
1392 }
1393
David Brazdil7b49e6c2016-09-01 11:06:18 +01001394 void EraseOutputFiles() {
1395 for (auto& files : { &vdex_files_, &oat_files_ }) {
1396 for (size_t i = 0; i < files->size(); ++i) {
1397 if ((*files)[i].get() != nullptr) {
1398 (*files)[i]->Erase();
1399 (*files)[i].reset();
1400 }
1401 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001402 }
Andreas Gampea650e702014-12-03 14:28:02 -08001403 }
1404
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001405 void LoadClassProfileDescriptors() {
Mathieu Chartierf85b3db2018-04-02 18:16:21 -07001406 if (!IsImage()) {
1407 return;
1408 }
Mathieu Chartierf85b3db2018-04-02 18:16:21 -07001409 if (profile_compilation_info_ != nullptr) {
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001410 // TODO: The following comment looks outdated or misplaced.
Mathieu Chartier0b490842016-05-25 15:05:59 -07001411 // Filter out class path classes since we don't want to include these in the image.
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001412 HashSet<std::string> image_classes = profile_compilation_info_->GetClassDescriptors(
1413 compiler_options_->dex_files_for_oat_file_);
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001414 VLOG(compiler) << "Loaded " << image_classes.size()
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001415 << " image class descriptors from profile";
1416 if (VLOG_IS_ON(compiler)) {
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001417 for (const std::string& s : image_classes) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001418 LOG(INFO) << "Image class " << s;
1419 }
1420 }
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001421 compiler_options_->image_classes_.swap(image_classes);
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001422 }
1423 }
1424
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001425 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1426 // boot class path.
Andreas Gampef7882972017-03-20 16:35:24 -07001427 dex2oat::ReturnCode Setup() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001428 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001429
Mathieu Chartierf68b6982019-06-27 09:40:20 -07001430 if (!PrepareDirtyObjects()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001431 return dex2oat::ReturnCode::kOther;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001432 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001433
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001434 // Verification results are null since we don't know if we will need them yet as the compler
1435 // filter may change.
Andreas Gampe4585f872015-03-27 23:45:15 -07001436 callbacks_.reset(new QuickCompilerCallbacks(
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001437 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001438 CompilerCallbacks::CallbackMode::kCompileBootImage :
1439 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001440
Vladimir Marko49b0f452015-12-10 13:49:19 +00001441 RuntimeArgumentMap runtime_options;
Mathieu Chartier46331a62017-07-21 09:49:10 -07001442 if (!PrepareRuntimeOptions(&runtime_options, callbacks_.get())) {
Andreas Gampef7882972017-03-20 16:35:24 -07001443 return dex2oat::ReturnCode::kOther;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001444 }
1445
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001446 CreateOatWriters();
1447 if (!AddDexFileSources()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001448 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001449 }
1450
Calin Juravle0e09dfc2018-02-12 19:01:09 -08001451 if (!compilation_reason_.empty()) {
1452 key_value_store_->Put(OatHeader::kCompilationReasonKey, compilation_reason_);
1453 }
1454
Vladimir Markoc10a0c62018-11-16 11:39:22 +00001455 if (IsBootImage()) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001456 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
Vladimir Marko91f10322018-12-07 18:04:10 +00001457 // We use this when loading the boot image.
1458 key_value_store_->Put(OatHeader::kBootClassPathKey, android::base::Join(dex_locations_, ':'));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001459 }
1460
1461 if (!IsBootImage()) {
1462 // When compiling an app, create the runtime early to retrieve
Vladimir Marko0ace5632018-12-14 11:11:47 +00001463 // the boot image checksums needed for the oat header.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001464 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001465 return dex2oat::ReturnCode::kCreateRuntime;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001466 }
1467
Andreas Gampe29d38e72016-03-23 15:31:51 +00001468 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001469 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
Vladimir Marko0ace5632018-12-14 11:11:47 +00001470 Runtime* runtime = Runtime::Current();
1471 key_value_store_->Put(OatHeader::kBootClassPathKey,
1472 android::base::Join(runtime->GetBootClassPathLocations(), ':'));
1473 std::vector<ImageSpace*> image_spaces = runtime->GetHeap()->GetBootImageSpaces();
1474 const std::vector<const DexFile*>& bcp_dex_files =
1475 runtime->GetClassLinker()->GetBootClassPath();
1476 key_value_store_->Put(
1477 OatHeader::kBootClassPathChecksumsKey,
1478 gc::space::ImageSpace::GetBootClassPathChecksums(image_spaces, bcp_dex_files));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001479 }
1480
1481 // Open dex files for class path.
Calin Juravle19915892017-08-03 17:10:36 +00001482
Calin Juravle1ce70852017-06-28 10:59:03 -07001483 if (class_loader_context_ == nullptr) {
Calin Juravle19915892017-08-03 17:10:36 +00001484 // If no context was specified use the default one (which is an empty PathClassLoader).
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001485 class_loader_context_ = ClassLoaderContext::Default();
Jeff Haof0192c82016-03-28 20:39:50 -07001486 }
Calin Juravle19915892017-08-03 17:10:36 +00001487
Calin Juravle1ce70852017-06-28 10:59:03 -07001488 DCHECK_EQ(oat_writers_.size(), 1u);
1489
1490 // Note: Ideally we would reject context where the source dex files are also
1491 // specified in the classpath (as it doesn't make sense). However this is currently
1492 // needed for non-prebuild tests and benchmarks which expects on the fly compilation.
1493 // Also, for secondary dex files we do not have control on the actual classpath.
1494 // Instead of aborting, remove all the source location from the context classpaths.
1495 if (class_loader_context_->RemoveLocationsFromClassPaths(
1496 oat_writers_[0]->GetSourceLocations())) {
1497 LOG(WARNING) << "The source files to be compiled are also in the classpath.";
1498 }
1499
1500 // We need to open the dex files before encoding the context in the oat file.
1501 // (because the encoding adds the dex checksum...)
1502 // TODO(calin): consider redesigning this so we don't have to open the dex files before
1503 // creating the actual class loader.
David Brazdil89821862019-03-19 13:57:43 +00001504 if (!class_loader_context_->OpenDexFiles(runtime_->GetInstructionSet(),
1505 classpath_dir_,
1506 class_loader_context_fds_)) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001507 // Do not abort if we couldn't open files from the classpath. They might be
1508 // apks without dex files and right now are opening flow will fail them.
1509 LOG(WARNING) << "Failed to open classpath dex files";
1510 }
1511
1512 // Store the class loader context in the oat header.
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001513 // TODO: deprecate this since store_class_loader_context should be enough to cover the users
1514 // of classpath_dir as well.
Mathieu Chartierc4440772018-04-16 14:40:56 -07001515 std::string class_path_key =
1516 class_loader_context_->EncodeContextForOatFile(classpath_dir_,
1517 stored_class_loader_context_.get());
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001518 key_value_store_->Put(OatHeader::kClassPathKey, class_path_key);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001519 }
1520
1521 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001522 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001523 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1524 rodata_.reserve(oat_writers_.size());
1525 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1526 rodata_.push_back(elf_writers_[i]->StartRoData());
1527 // Unzip or copy dex files straight to the oat file.
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001528 std::vector<MemMap> opened_dex_files_map;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001529 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
Mathieu Chartierd45863a2018-03-21 18:16:36 -07001530 // No need to verify the dex file when we have a vdex file, which means it was already
1531 // verified.
1532 const bool verify = (input_vdex_file_ == nullptr);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001533 if (!oat_writers_[i]->WriteAndOpenDexFiles(
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +00001534 vdex_files_[i].get(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01001535 rodata_.back(),
Vladimir Markoc10a0c62018-11-16 11:39:22 +00001536 (i == 0u) ? key_value_store_.get() : nullptr,
Jeff Hao042e8982016-10-19 11:17:11 -07001537 verify,
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001538 update_input_vdex_,
Mathieu Chartier792111c2018-02-15 13:02:15 -08001539 copy_dex_files_,
David Brazdil7b49e6c2016-09-01 11:06:18 +01001540 &opened_dex_files_map,
1541 &opened_dex_files)) {
Andreas Gampef7882972017-03-20 16:35:24 -07001542 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001543 }
1544 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00001545 if (opened_dex_files_map.empty()) {
1546 DCHECK(opened_dex_files.empty());
1547 } else {
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001548 for (MemMap& map : opened_dex_files_map) {
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00001549 opened_dex_files_maps_.push_back(std::move(map));
1550 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001551 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001552 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001553 opened_dex_files_.push_back(std::move(dex_file));
1554 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001555 }
1556 }
1557 }
1558
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001559 compiler_options_->dex_files_for_oat_file_ = MakeNonOwningPointerVector(opened_dex_files_);
1560 const std::vector<const DexFile*>& dex_files = compiler_options_->dex_files_for_oat_file_;
Andreas Gampe7386da42016-06-08 18:18:47 -07001561
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001562 // If we need to downgrade the compiler-filter for size reasons.
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001563 if (!IsBootImage() && IsVeryLarge(dex_files)) {
Mathieu Chartier8cce65a2017-08-17 00:06:39 -07001564 // Disable app image to make sure dex2oat unloading is enabled.
Vladimir Marko9c4b9702018-11-14 15:09:02 +00001565 compiler_options_->image_type_ = CompilerOptions::ImageType::kNone;
Mathieu Chartier8cce65a2017-08-17 00:06:39 -07001566
Mathieu Chartier72041a02017-07-14 18:23:25 -07001567 // If we need to downgrade the compiler-filter for size reasons, do that early before we read
1568 // it below for creating verification callbacks.
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001569 if (!CompilerFilter::IsAsGoodAs(kLargeAppFilter, compiler_options_->GetCompilerFilter())) {
1570 LOG(INFO) << "Very large app, downgrading to verify.";
1571 // Note: this change won't be reflected in the key-value store, as that had to be
1572 // finalized before loading the dex files. This setup is currently required
1573 // to get the size from the DexFile objects.
1574 // TODO: refactor. b/29790079
1575 compiler_options_->SetCompilerFilter(kLargeAppFilter);
1576 }
1577 }
1578
1579 if (CompilerFilter::IsAnyCompilationEnabled(compiler_options_->GetCompilerFilter())) {
1580 // Only modes with compilation require verification results, do this here instead of when we
1581 // create the compilation callbacks since the compilation mode may have been changed by the
1582 // very large app logic.
1583 // Avoiding setting the verification results saves RAM by not adding the dex files later in
1584 // the function.
1585 verification_results_.reset(new VerificationResults(compiler_options_.get()));
1586 callbacks_->SetVerificationResults(verification_results_.get());
1587 }
1588
Andreas Gampe7386da42016-06-08 18:18:47 -07001589 // We had to postpone the swap decision till now, as this is the point when we actually
1590 // know about the dex files we're going to use.
1591
1592 // Make sure that we didn't create the driver, yet.
1593 CHECK(driver_ == nullptr);
1594 // If we use a swap file, ensure we are above the threshold to make it necessary.
1595 if (swap_fd_ != -1) {
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001596 if (!UseSwap(IsBootImage(), dex_files)) {
Andreas Gampe7386da42016-06-08 18:18:47 -07001597 close(swap_fd_);
1598 swap_fd_ = -1;
1599 VLOG(compiler) << "Decided to run without swap.";
1600 } else {
1601 LOG(INFO) << "Large app, accepted running with swap.";
1602 }
1603 }
1604 // 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 +00001605 if (IsBootImage()) {
1606 // For boot image, pass opened dex files to the Runtime::Create().
1607 // Note: Runtime acquires ownership of these dex files.
1608 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001609 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001610 return dex2oat::ReturnCode::kOther;
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001611 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001612 }
1613
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001614 // If we're doing the image, override the compiler filter to force full compilation. Must be
1615 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1616 // compilation of class initializers.
1617 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001618 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001619 WellKnownClasses::Init(self->GetJniEnv());
1620
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001621 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001622 constexpr bool kSaveDexInput = false;
1623 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001624 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001625 }
1626 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001627
1628 // Ensure opened dex files are writable for dex-to-dex transformations.
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001629 for (MemMap& map : opened_dex_files_maps_) {
1630 if (!map.Protect(PROT_READ | PROT_WRITE)) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001631 PLOG(ERROR) << "Failed to make .dex files writeable.";
Andreas Gampef7882972017-03-20 16:35:24 -07001632 return dex2oat::ReturnCode::kOther;
Vladimir Marko919f5532016-01-20 19:13:01 +00001633 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001634 }
1635
Mathieu Chartier72041a02017-07-14 18:23:25 -07001636 // Verification results are only required for modes that have any compilation. Avoid
1637 // adding the dex files if possible to prevent allocating large arrays.
1638 if (verification_results_ != nullptr) {
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001639 for (const auto& dex_file : dex_files) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001640 // Pre-register dex files so that we can access verification results without locks during
1641 // compilation and verification.
Mathieu Chartier0733dc82017-07-17 14:05:28 -07001642 verification_results_->AddDexFile(dex_file);
1643 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001644 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001645
Andreas Gampef7882972017-03-20 16:35:24 -07001646 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001647 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001648
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001649 // If we need to keep the oat file open for the image writer.
1650 bool ShouldKeepOatFileOpen() const {
1651 return IsImage() && oat_fd_ != kInvalidFd;
1652 }
1653
Mathieu Chartier72041a02017-07-14 18:23:25 -07001654 // Doesn't return the class loader since it's not meant to be used for image compilation.
1655 void CompileDexFilesIndividually() {
1656 CHECK(!IsImage()) << "Not supported with image";
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001657 for (const DexFile* dex_file : compiler_options_->dex_files_for_oat_file_) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001658 std::vector<const DexFile*> dex_files(1u, dex_file);
1659 VLOG(compiler) << "Compiling " << dex_file->GetLocation();
1660 jobject class_loader = CompileDexFiles(dex_files);
1661 CHECK(class_loader != nullptr);
1662 ScopedObjectAccess soa(Thread::Current());
1663 // Unload class loader to free RAM.
Ian Rogers55256cb2017-12-21 17:07:11 -08001664 jweak weak_class_loader = soa.Env()->GetVm()->AddWeakGlobalRef(
Mathieu Chartier72041a02017-07-14 18:23:25 -07001665 soa.Self(),
1666 soa.Decode<mirror::ClassLoader>(class_loader));
Ian Rogers55256cb2017-12-21 17:07:11 -08001667 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), class_loader);
Roland Levillainaf290312018-02-27 20:02:17 +00001668 runtime_->GetHeap()->CollectGarbage(/* clear_soft_references */ true);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001669 ObjPtr<mirror::ClassLoader> decoded_weak = soa.Decode<mirror::ClassLoader>(weak_class_loader);
1670 if (decoded_weak != nullptr) {
1671 LOG(FATAL) << "Failed to unload class loader, path from root set: "
1672 << runtime_->GetHeap()->GetVerification()->FirstPathFromRootSet(decoded_weak);
1673 }
1674 VLOG(compiler) << "Unloaded classloader";
1675 }
1676 }
1677
1678 bool ShouldCompileDexFilesIndividually() const {
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001679 // Compile individually if we are:
1680 // 1. not building an image,
1681 // 2. not verifying a vdex file,
1682 // 3. using multidex,
1683 // 4. not doing any AOT compilation.
1684 // This means extract, no-vdex verify, and quicken, will use the individual compilation
1685 // mode (to reduce RAM used by the compiler).
Mathieu Chartier72041a02017-07-14 18:23:25 -07001686 return !IsImage() &&
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001687 !update_input_vdex_ &&
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001688 compiler_options_->dex_files_for_oat_file_.size() > 1 &&
Mathieu Chartier6a2b67b2017-08-08 15:09:29 -07001689 !CompilerFilter::IsAotCompilationEnabled(compiler_options_->GetCompilerFilter());
Mathieu Chartier72041a02017-07-14 18:23:25 -07001690 }
1691
1692 // Set up and create the compiler driver and then invoke it to compile all the dex files.
1693 jobject Compile() {
1694 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1695
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001696 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001697
Vladimir Marko47496c22016-01-27 16:15:08 +00001698 // Find the dex files we should not inline from.
Vladimir Marko47496c22016-01-27 16:15:08 +00001699 std::vector<std::string> no_inline_filters;
1700 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001701
1702 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001703 const std::string core_oj = "core-oj";
1704 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1705 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001706 }
1707
Vladimir Marko47496c22016-01-27 16:15:08 +00001708 if (!no_inline_filters.empty()) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001709 std::vector<const DexFile*> class_path_files;
1710 if (!IsBootImage()) {
1711 // The class loader context is used only for apps.
1712 class_path_files = class_loader_context_->FlattenOpenedDexFiles();
1713 }
1714
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001715 const std::vector<const DexFile*>& dex_files = compiler_options_->dex_files_for_oat_file_;
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001716 std::vector<const DexFile*> no_inline_from_dex_files;
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001717 const std::vector<const DexFile*>* dex_file_vectors[] = {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001718 &class_linker->GetBootClassPath(),
1719 &class_path_files,
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001720 &dex_files
Jeff Haodcdc85b2015-12-04 14:06:18 -08001721 };
1722 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001723 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001724 for (const std::string& filter : no_inline_filters) {
1725 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
Calin Juravlea308a322017-07-18 16:51:51 -07001726 // allows tests to specify <test-dexfile>!classes2.dex if needed but if the
Vladimir Marko47496c22016-01-27 16:15:08 +00001727 // base location passes the StartsWith() test, so do all extra locations.
1728 std::string dex_location = dex_file->GetLocation();
1729 if (filter.find('/') == std::string::npos) {
1730 // The filter does not contain the path. Remove the path from dex_location as well.
1731 size_t last_slash = dex_file->GetLocation().rfind('/');
1732 if (last_slash != std::string::npos) {
1733 dex_location = dex_location.substr(last_slash + 1);
1734 }
1735 }
1736
Andreas Gampe9186ced2016-12-12 14:28:21 -08001737 if (android::base::StartsWith(dex_location, filter.c_str())) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001738 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001739 no_inline_from_dex_files.push_back(dex_file);
Vladimir Marko47496c22016-01-27 16:15:08 +00001740 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001741 }
1742 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001743 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001744 }
Vladimir Markodc4bcce2018-06-21 16:15:42 +01001745 if (!no_inline_from_dex_files.empty()) {
1746 compiler_options_->no_inline_from_.swap(no_inline_from_dex_files);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001747 }
1748 }
Vladimir Marko1a2a5cd2018-11-07 15:39:48 +00001749 compiler_options_->profile_compilation_info_ = profile_compilation_info_.get();
Jeff Haodcdc85b2015-12-04 14:06:18 -08001750
Vladimir Marko307dac92015-10-20 11:20:09 +01001751 driver_.reset(new CompilerDriver(compiler_options_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001752 compiler_kind_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001753 thread_count_,
Vladimir Marko1a2a5cd2018-11-07 15:39:48 +00001754 swap_fd_));
Nicolas Geoffray486dda02017-09-11 14:15:52 +01001755 if (!IsBootImage()) {
1756 driver_->SetClasspathDexFiles(class_loader_context_->FlattenOpenedDexFiles());
1757 }
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001758
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001759 const bool compile_individually = ShouldCompileDexFilesIndividually();
1760 if (compile_individually) {
1761 // Set the compiler driver in the callbacks so that we can avoid re-verification. This not
1762 // only helps performance but also prevents reverifying quickened bytecodes. Attempting
1763 // verify quickened bytecode causes verification failures.
1764 // Only set the compiler filter if we are doing separate compilation since there is a bit
1765 // of overhead when checking if a class was previously verified.
1766 callbacks_->SetDoesClassUnloading(true, driver_.get());
1767 }
1768
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001769 // Setup vdex for compilation.
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001770 const std::vector<const DexFile*>& dex_files = compiler_options_->dex_files_for_oat_file_;
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001771 if (!DoEagerUnquickeningOfVdex() && input_vdex_file_ != nullptr) {
1772 callbacks_->SetVerifierDeps(
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001773 new verifier::VerifierDeps(dex_files, input_vdex_file_->GetVerifierDepsData()));
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001774
1775 // TODO: we unquicken unconditionally, as we don't know
1776 // if the boot image has changed. How exactly we'll know is under
1777 // experimentation.
1778 TimingLogger::ScopedTiming time_unquicken("Unquicken", timings_);
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +03001779
1780 // We do not decompile a RETURN_VOID_NO_BARRIER into a RETURN_VOID, as the quickening
1781 // optimization does not depend on the boot image (the optimization relies on not
1782 // having final fields in a class, which does not change for an app).
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001783 input_vdex_file_->Unquicken(dex_files, /* decompile_return_instruction */ false);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001784 } else {
1785 // Create the main VerifierDeps, here instead of in the compiler since we want to aggregate
1786 // the results for all the dex files, not just the results for the current dex file.
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001787 callbacks_->SetVerifierDeps(new verifier::VerifierDeps(dex_files));
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001788 }
Mathieu Chartier72041a02017-07-14 18:23:25 -07001789 // Invoke the compilation.
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001790 if (compile_individually) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001791 CompileDexFilesIndividually();
1792 // Return a null classloader since we already freed released it.
1793 return nullptr;
1794 }
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001795 return CompileDexFiles(dex_files);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001796 }
1797
1798 // Create the class loader, use it to compile, and return.
1799 jobject CompileDexFiles(const std::vector<const DexFile*>& dex_files) {
1800 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1801
1802 jobject class_loader = nullptr;
1803 if (!IsBootImage()) {
Vladimir Marko213ee2d2018-06-22 11:56:34 +01001804 class_loader =
1805 class_loader_context_->CreateClassLoader(compiler_options_->dex_files_for_oat_file_);
Andreas Gampee9934582018-01-19 21:23:04 -08001806 callbacks_->SetDexFiles(&dex_files);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001807 }
1808
1809 // Register dex caches and key them to the class loader so that they only unload when the
1810 // class loader unloads.
1811 for (const auto& dex_file : dex_files) {
1812 ScopedObjectAccess soa(Thread::Current());
1813 // Registering the dex cache adds a strong root in the class loader that prevents the dex
1814 // cache from being unloaded early.
1815 ObjPtr<mirror::DexCache> dex_cache = class_linker->RegisterDexFile(
1816 *dex_file,
1817 soa.Decode<mirror::ClassLoader>(class_loader));
1818 if (dex_cache == nullptr) {
1819 soa.Self()->AssertPendingException();
1820 LOG(FATAL) << "Failed to register dex file " << dex_file->GetLocation() << " "
1821 << soa.Self()->GetException()->Dump();
1822 }
1823 }
Vladimir Marko2afaff72018-11-30 17:01:50 +00001824 driver_->InitializeThreadPools();
1825 driver_->PreCompile(class_loader,
1826 dex_files,
1827 timings_,
1828 &compiler_options_->image_classes_,
1829 verification_results_.get());
1830 callbacks_->SetVerificationResults(nullptr); // Should not be needed anymore.
1831 compiler_options_->verification_results_ = verification_results_.get();
Mathieu Chartier72041a02017-07-14 18:23:25 -07001832 driver_->CompileAll(class_loader, dex_files, timings_);
Vladimir Marko2afaff72018-11-30 17:01:50 +00001833 driver_->FreeThreadPools();
Mathieu Chartier72041a02017-07-14 18:23:25 -07001834 return class_loader;
Vladimir Markof4da6752014-08-01 19:04:18 +01001835 }
1836
Jeff Hao436183f2016-01-12 16:36:50 -08001837 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001838 // ensure the references between the two are correct.
1839 //
1840 // Currently we have a memory layout that looks something like this:
1841 //
1842 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001843 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001844 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001845 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001846 // +--------------+
1847 // | alloc spaces |
1848 // +--------------+
1849 //
Jeff Hao436183f2016-01-12 16:36:50 -08001850 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001851 //
Jeff Hao436183f2016-01-12 16:36:50 -08001852 // 1. The images are expected to be loaded at an absolute address and
1853 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001854 //
Jeff Hao436183f2016-01-12 16:36:50 -08001855 // 2. There are absolute pointers from Methods in the images to their
1856 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001857 //
Jeff Hao436183f2016-01-12 16:36:50 -08001858 // 3. There are absolute pointers from the code in the oat files to Methods
1859 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001860 //
Jeff Hao436183f2016-01-12 16:36:50 -08001861 // 4. There are absolute pointers from code in the oat files to other code
1862 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001863 //
1864 // To get this all correct, we go through several steps.
1865 //
Jeff Hao436183f2016-01-12 16:36:50 -08001866 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001867 // the oat data size and code size. During this stage, we also set
1868 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001869 //
Jeff Hao436183f2016-01-12 16:36:50 -08001870 // 2. We prepare offsets for the objects in the images and calculate
1871 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001872 //
Jeff Hao436183f2016-01-12 16:36:50 -08001873 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001874 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001875 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001876 // can prepare the ELF headers and we then know the ELF memory segment
1877 // layout and we can now resolve all references. The compiler provides
1878 // LinkerPatch information in each CompiledMethod and we resolve these,
1879 // using the layout information and image object locations provided by
1880 // image writer, as we're writing the method code.
1881 //
Jeff Hao436183f2016-01-12 16:36:50 -08001882 // 4. We create the image files. They need to know where the oat files
1883 // will be loaded after itself. Originally oat files were simply
1884 // memory mapped so we could predict where their contents were based
1885 // on the file size. Now that they are ELF files, we need to inspect
1886 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001887 // where the oat header is located within.
1888 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001889 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001890 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001891 // load the .so at the desired location at runtime by offsetting the
1892 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001893 // TODO: Do this in step 3. We already know the layout there.
1894 //
1895 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1896 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001897
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001898 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1899 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001900 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1901 // case (when the file will be explicitly erased).
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00001902 bool WriteOutputFiles(jobject class_loader) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001903 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1904
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001905 // Sync the data to the file, in case we did dex2dex transformations.
Vladimir Markoc34bebf2018-08-16 16:12:49 +01001906 for (MemMap& map : opened_dex_files_maps_) {
1907 if (!map.Sync()) {
1908 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map.GetName();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001909 return false;
1910 }
1911 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001912
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001913 if (IsImage()) {
Vladimir Marko66235942019-06-03 16:05:17 +01001914 if (!IsBootImage()) {
1915 DCHECK_EQ(image_base_, 0u);
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001916 gc::Heap* const heap = Runtime::Current()->GetHeap();
Vladimir Marko66235942019-06-03 16:05:17 +01001917 image_base_ = heap->GetBootImagesStartAddress() + heap->GetBootImagesSize();
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001918 }
Vladimir Marko66235942019-06-03 16:05:17 +01001919 VLOG(compiler) << "Image base=" << reinterpret_cast<void*>(image_base_);
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001920
Vladimir Markoa0431112018-06-25 09:32:54 +01001921 image_writer_.reset(new linker::ImageWriter(*compiler_options_,
Vladimir Marko74527972016-11-29 15:57:32 +00001922 image_base_,
Vladimir Marko74527972016-11-29 15:57:32 +00001923 image_storage_mode_,
1924 oat_filenames_,
1925 dex_file_oat_index_map_,
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00001926 class_loader,
Vladimir Marko74527972016-11-29 15:57:32 +00001927 dirty_image_objects_.get()));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001928
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001929 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001930 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
Mathieu Chartier703b82a2018-04-10 15:52:32 -07001931 if (!image_writer_->PrepareImageAddressSpace(timings_)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001932 LOG(ERROR) << "Failed to prepare image address space.";
1933 return false;
1934 }
1935 }
1936
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001937 // Initialize the writers with the compiler driver, image writer, and their
1938 // dex files. The writers were created without those being there yet.
1939 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00001940 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001941 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1942 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
1943 }
1944
David Brazdil5d5a36b2016-09-14 15:34:10 +01001945 {
1946 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
1947 DCHECK(IsBootImage() || oat_files_.size() == 1u);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001948 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
David Brazdil5d5a36b2016-09-14 15:34:10 +01001949 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1950 File* vdex_file = vdex_files_[i].get();
David Srbecky2faab002019-02-12 16:35:48 +00001951 std::unique_ptr<BufferedOutputStream> vdex_out =
1952 std::make_unique<BufferedOutputStream>(
1953 std::make_unique<FileOutputStream>(vdex_file));
David Brazdil5d5a36b2016-09-14 15:34:10 +01001954
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001955 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01001956 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
1957 return false;
1958 }
1959
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001960 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
1961 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
1962 return false;
1963 }
1964
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +00001965 // VDEX finalized, seek back to the beginning and write checksums and the header.
1966 if (!oat_writers_[i]->WriteChecksumsAndVdexHeader(vdex_out.get())) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01001967 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
1968 return false;
1969 }
1970 }
1971 }
1972
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001973 {
1974 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Vladimir Markoa0431112018-06-25 09:32:54 +01001975 linker::MultiOatRelativePatcher patcher(compiler_options_->GetInstructionSet(),
1976 compiler_options_->GetInstructionSetFeatures(),
Vladimir Markoca1e0382018-04-11 09:58:41 +00001977 driver_->GetCompiledMethodStorage());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001978 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00001979 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
1980 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko944da602016-02-19 12:27:55 +00001981
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001982 oat_writer->PrepareLayout(&patcher);
Vladimir Markob066d432018-01-03 13:14:37 +00001983 elf_writer->PrepareDynamicSection(oat_writer->GetOatHeader().GetExecutableOffset(),
1984 oat_writer->GetCodeSize(),
1985 oat_writer->GetDataBimgRelRoSize(),
Vladimir Markoaad75c62016-10-03 08:46:48 +00001986 oat_writer->GetBssSize(),
Vladimir Marko0eb882b2017-05-15 13:39:18 +01001987 oat_writer->GetBssMethodsOffset(),
David Srbeckyec2cdf42017-12-08 16:21:25 +00001988 oat_writer->GetBssRootsOffset(),
1989 oat_writer->GetVdexSize());
Vladimir Marko944da602016-02-19 12:27:55 +00001990 if (IsImage()) {
1991 // Update oat layout.
1992 DCHECK(image_writer_ != nullptr);
1993 DCHECK_LT(i, oat_filenames_.size());
1994 image_writer_->UpdateOatFileLayout(i,
1995 elf_writer->GetLoadedSize(),
1996 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01001997 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00001998 }
1999 }
2000
2001 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002002 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko74527972016-11-29 15:57:32 +00002003 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2004 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00002005
David Srbecky0c4572e2016-01-22 19:19:25 +00002006 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00002007 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
David Srbecky32210b92017-12-04 14:39:21 +00002008 debug::DebugInfo debug_info = oat_writer->GetDebugInfo(); // Keep the variable alive.
2009 elf_writer->PrepareDebugInfo(debug_info); // Processes the data on background thread.
David Srbecky0c4572e2016-01-22 19:19:25 +00002010
David Srbecky2faab002019-02-12 16:35:48 +00002011 OutputStream*& rodata = rodata_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002012 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002013 if (!oat_writer->WriteRodata(rodata)) {
2014 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
2015 return false;
2016 }
2017 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002018 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00002019
David Srbecky2faab002019-02-12 16:35:48 +00002020 OutputStream* text = elf_writer->StartText();
Jeff Haodcdc85b2015-12-04 14:06:18 -08002021 if (!oat_writer->WriteCode(text)) {
2022 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
2023 return false;
2024 }
2025 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00002026
Vladimir Markob066d432018-01-03 13:14:37 +00002027 if (oat_writer->GetDataBimgRelRoSize() != 0u) {
David Srbecky2faab002019-02-12 16:35:48 +00002028 OutputStream* data_bimg_rel_ro = elf_writer->StartDataBimgRelRo();
Vladimir Markob066d432018-01-03 13:14:37 +00002029 if (!oat_writer->WriteDataBimgRelRo(data_bimg_rel_ro)) {
2030 LOG(ERROR) << "Failed to write .data.bimg.rel.ro section to the ELF file "
2031 << oat_file->GetPath();
2032 return false;
2033 }
2034 elf_writer->EndDataBimgRelRo(data_bimg_rel_ro);
2035 }
2036
Vladimir Marko0ace5632018-12-14 11:11:47 +00002037 if (!oat_writer->WriteHeader(elf_writer->GetStream())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002038 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
2039 return false;
2040 }
2041
Vladimir Marko944da602016-02-19 12:27:55 +00002042 if (IsImage()) {
2043 // Update oat header information.
2044 DCHECK(image_writer_ != nullptr);
2045 DCHECK_LT(i, oat_filenames_.size());
2046 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
2047 }
2048
Jeff Haodcdc85b2015-12-04 14:06:18 -08002049 elf_writer->WriteDynamicSection();
David Srbecky32210b92017-12-04 14:39:21 +00002050 elf_writer->WriteDebugInfo(oat_writer->GetDebugInfo());
Vladimir Marko10c13562015-11-25 14:33:36 +00002051
Jeff Haodcdc85b2015-12-04 14:06:18 -08002052 if (!elf_writer->End()) {
2053 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
2054 return false;
2055 }
2056
David Brazdil7b49e6c2016-09-01 11:06:18 +01002057 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
2058 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002059 }
2060
Jeff Haodcdc85b2015-12-04 14:06:18 -08002061 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002062
2063 oat_writer.reset();
David Srbeckyde91fd42018-07-05 22:27:08 +01002064 // We may still need the ELF writer later for stripping.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002065 }
2066 }
2067
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002068 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002069 }
2070
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002071 // If we are compiling an image, invoke the image creation routine. Else just skip.
2072 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002073 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002074 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
2075 if (!CreateImageFile()) {
2076 return false;
2077 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002078 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07002079 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002080 return true;
2081 }
2082
David Srbeckyde91fd42018-07-05 22:27:08 +01002083 // Copy the full oat files to symbols directory and then strip the originals.
2084 bool CopyOatFilesToSymbolsDirectoryAndStrip() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002085 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
2086 // If we don't want to strip in place, copy from stripped location to unstripped location.
2087 // We need to strip after image creation because FixupElf needs to use .strtab.
Vladimir Markod011d812018-11-29 12:35:24 +00002088 if (oat_unstripped_[i] != oat_filenames_[i]) {
David Srbeckyde91fd42018-07-05 22:27:08 +01002089 DCHECK(oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002090
2091 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
David Srbeckyde91fd42018-07-05 22:27:08 +01002092 std::unique_ptr<File>& in = oat_files_[i];
Vladimir Markod011d812018-11-29 12:35:24 +00002093 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i].c_str()));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01002094 int64_t in_length = in->GetLength();
2095 if (in_length < 0) {
2096 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
2097 return false;
2098 }
2099 if (!out->Copy(in.get(), 0, in_length)) {
2100 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
2101 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002102 }
2103 if (out->FlushCloseOrErase() != 0) {
2104 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
2105 return false;
2106 }
2107 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
David Srbeckyde91fd42018-07-05 22:27:08 +01002108
2109 if (strip_) {
2110 TimingLogger::ScopedTiming t2("dex2oat OatFile strip", timings_);
2111 if (!elf_writers_[i]->StripDebugInfo()) {
2112 PLOG(ERROR) << "Failed strip oat file: " << in->GetPath();
2113 return false;
2114 }
2115 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002116 }
2117 }
2118 return true;
2119 }
2120
David Brazdil7b49e6c2016-09-01 11:06:18 +01002121 bool FlushOutputFile(std::unique_ptr<File>* file) {
2122 if (file->get() != nullptr) {
2123 if (file->get()->Flush() != 0) {
2124 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
2125 return false;
2126 }
2127 }
2128 return true;
2129 }
2130
David Srbeckyde91fd42018-07-05 22:27:08 +01002131 bool FlushCloseOutputFile(File* file) {
2132 if (file != nullptr) {
2133 if (file->FlushCloseOrErase() != 0) {
2134 PLOG(ERROR) << "Failed to flush and close output file: " << file->GetPath();
David Brazdil7b49e6c2016-09-01 11:06:18 +01002135 return false;
2136 }
2137 }
2138 return true;
2139 }
2140
2141 bool FlushOutputFiles() {
2142 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
2143 for (auto& files : { &vdex_files_, &oat_files_ }) {
2144 for (size_t i = 0; i < files->size(); ++i) {
2145 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002146 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08002147 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002148 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00002149 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002150 return true;
2151 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002152
David Brazdil7b49e6c2016-09-01 11:06:18 +01002153 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002154 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002155 for (auto& files : { &vdex_files_, &oat_files_ }) {
2156 for (size_t i = 0; i < files->size(); ++i) {
David Srbeckyde91fd42018-07-05 22:27:08 +01002157 result &= FlushCloseOutputFile((*files)[i].get());
David Brazdil7b49e6c2016-09-01 11:06:18 +01002158 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002159 }
2160 return result;
2161 }
2162
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002163 void DumpTiming() {
Nicolas Geoffray2d8801f2017-11-28 15:50:07 +00002164 if (compiler_options_->GetDumpTimings() ||
2165 (kIsDebugBuild && timings_->GetTotalNs() > MsToNs(1000))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002166 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2167 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002168 }
2169
Andreas Gampe10e477d2014-11-19 12:57:42 -08002170 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002171 return IsAppImage() || IsBootImage();
2172 }
2173
2174 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002175 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002176 }
2177
2178 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002179 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002180 }
2181
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002182 bool IsHost() const {
2183 return is_host_;
2184 }
2185
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002186 bool UseProfile() const {
Mathieu Chartierd0af56c2017-02-17 12:56:25 -08002187 return profile_file_fd_ != -1 || !profile_file_.empty();
Calin Juravle998c2162015-12-21 15:39:33 +02002188 }
2189
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002190 bool DoProfileGuidedOptimizations() const {
Nicolas Geoffray49cda062017-04-21 13:08:25 +01002191 return UseProfile();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002192 }
2193
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002194 bool DoGenerateCompactDex() const {
2195 return compact_dex_level_ != CompactDexLevel::kCompactDexLevelNone;
2196 }
2197
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002198 bool DoDexLayoutOptimizations() const {
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002199 return DoProfileGuidedOptimizations() || DoGenerateCompactDex();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002200 }
2201
Igor Murashkin545412b2017-08-17 15:26:54 -07002202 bool DoOatLayoutOptimizations() const {
2203 return DoProfileGuidedOptimizations();
2204 }
2205
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002206 bool MayInvalidateVdexMetadata() const {
2207 // DexLayout can invalidate the vdex metadata if changing the class def order is enabled, so
2208 // we need to unquicken the vdex file eagerly, before passing it to dexlayout.
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01002209 return DoDexLayoutOptimizations();
2210 }
2211
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002212 bool DoEagerUnquickeningOfVdex() const {
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00002213 return MayInvalidateVdexMetadata() && dm_file_ == nullptr;
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002214 }
2215
Calin Juravle2e2db782016-02-23 12:00:03 +00002216 bool LoadProfile() {
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002217 DCHECK(UseProfile());
Calin Juravlee6f87cc2017-05-24 17:41:05 -07002218 // TODO(calin): We should be using the runtime arena pool (instead of the
2219 // default profile arena). However the setup logic is messy and needs
2220 // cleaning up before that (e.g. the oat writers are created before the
2221 // runtime).
Calin Juravle2e2db782016-02-23 12:00:03 +00002222 profile_compilation_info_.reset(new ProfileCompilationInfo());
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002223 ScopedFlock profile_file;
Calin Juravle2e2db782016-02-23 12:00:03 +00002224 std::string error;
2225 if (profile_file_fd_ != -1) {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002226 profile_file = LockedFile::DupOf(profile_file_fd_, "profile",
2227 true /* read_only_mode */, &error);
Andreas Gampe29d38e72016-03-23 15:31:51 +00002228 } else if (profile_file_ != "") {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002229 profile_file = LockedFile::Open(profile_file_.c_str(), O_RDONLY, true, &error);
Calin Juravle998c2162015-12-21 15:39:33 +02002230 }
Calin Juravle877fd962016-01-05 14:29:29 +00002231
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002232 // Return early if we're unable to obtain a lock on the profile.
2233 if (profile_file.get() == nullptr) {
2234 LOG(ERROR) << "Cannot lock profiles: " << error;
2235 return false;
2236 }
2237
2238 if (!profile_compilation_info_->Load(profile_file->Fd())) {
Calin Juravle2e2db782016-02-23 12:00:03 +00002239 profile_compilation_info_.reset(nullptr);
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002240 return false;
Calin Juravle2e2db782016-02-23 12:00:03 +00002241 }
Calin Juravle877fd962016-01-05 14:29:29 +00002242
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002243 return true;
Calin Juravle998c2162015-12-21 15:39:33 +02002244 }
2245
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002246 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002247 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2248 if (is_image) {
2249 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2250 return false;
2251 }
2252 if (dex_files.size() < min_dex_files_for_swap_) {
2253 // If there are less dex files than the threshold, assume it's gonna be fine.
2254 return false;
2255 }
2256 size_t dex_files_size = 0;
2257 for (const auto* dex_file : dex_files) {
2258 dex_files_size += dex_file->GetHeader().file_size_;
2259 }
2260 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2261 }
2262
Vladimir Marko213ee2d2018-06-22 11:56:34 +01002263 bool IsVeryLarge(const std::vector<const DexFile*>& dex_files) {
Andreas Gampe67f02822016-06-24 21:05:23 -07002264 size_t dex_files_size = 0;
2265 for (const auto* dex_file : dex_files) {
2266 dex_files_size += dex_file->GetHeader().file_size_;
2267 }
2268 return dex_files_size >= very_large_threshold_;
2269 }
2270
Jeff Haoc23b0c02017-07-27 18:19:38 -07002271 bool PrepareDirtyObjects() {
2272 if (dirty_image_objects_filename_ != nullptr) {
Vladimir Marko54159c62018-06-20 14:30:08 +01002273 dirty_image_objects_ = ReadCommentedInputFromFile<HashSet<std::string>>(
Jeff Haoc23b0c02017-07-27 18:19:38 -07002274 dirty_image_objects_filename_,
Vladimir Marko54159c62018-06-20 14:30:08 +01002275 nullptr);
Jeff Haoc23b0c02017-07-27 18:19:38 -07002276 if (dirty_image_objects_ == nullptr) {
2277 LOG(ERROR) << "Failed to create list of dirty objects from '"
2278 << dirty_image_objects_filename_ << "'";
2279 return false;
2280 }
2281 } else {
2282 dirty_image_objects_.reset(nullptr);
2283 }
2284 return true;
2285 }
2286
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002287 void PruneNonExistentDexFiles() {
2288 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2289 size_t kept = 0u;
2290 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
Vladimir Markod011d812018-11-29 12:35:24 +00002291 if (!OS::FileExists(dex_filenames_[i].c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002292 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2293 } else {
Vladimir Markod011d812018-11-29 12:35:24 +00002294 if (kept != i) {
2295 dex_filenames_[kept] = dex_filenames_[i];
2296 dex_locations_[kept] = dex_locations_[i];
2297 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002298 ++kept;
2299 }
2300 }
2301 dex_filenames_.resize(kept);
2302 dex_locations_.resize(kept);
2303 }
2304
2305 bool AddDexFileSources() {
2306 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
Nicolas Geoffraybc177272018-01-24 14:55:32 +00002307 if (input_vdex_file_ != nullptr && input_vdex_file_->HasDexSection()) {
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002308 DCHECK_EQ(oat_writers_.size(), 1u);
2309 const std::string& name = zip_location_.empty() ? dex_locations_[0] : zip_location_;
2310 DCHECK(!name.empty());
2311 if (!oat_writers_[0]->AddVdexDexFilesSource(*input_vdex_file_.get(), name.c_str())) {
2312 return false;
2313 }
2314 } else if (zip_fd_ != -1) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002315 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002316 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2317 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002318 return false;
2319 }
2320 } else if (oat_writers_.size() > 1u) {
2321 // Multi-image.
2322 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2323 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2324 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
Vladimir Markod011d812018-11-29 12:35:24 +00002325 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i].c_str(),
2326 dex_locations_[i].c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002327 return false;
2328 }
2329 }
2330 } else {
2331 DCHECK_EQ(oat_writers_.size(), 1u);
2332 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2333 DCHECK_NE(dex_filenames_.size(), 0u);
2334 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
Vladimir Markod011d812018-11-29 12:35:24 +00002335 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i].c_str(),
2336 dex_locations_[i].c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002337 return false;
2338 }
2339 }
2340 }
2341 return true;
2342 }
2343
2344 void CreateOatWriters() {
2345 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2346 elf_writers_.reserve(oat_files_.size());
2347 oat_writers_.reserve(oat_files_.size());
2348 for (const std::unique_ptr<File>& oat_file : oat_files_) {
Vladimir Markoa0431112018-06-25 09:32:54 +01002349 elf_writers_.emplace_back(linker::CreateElfWriterQuick(*compiler_options_, oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002350 elf_writers_.back()->Start();
Mathieu Chartier4a265c22018-04-09 14:25:14 -07002351 bool do_oat_writer_layout = DoDexLayoutOptimizations() || DoOatLayoutOptimizations();
2352 if (profile_compilation_info_ != nullptr && profile_compilation_info_->IsEmpty()) {
2353 do_oat_writer_layout = false;
2354 }
Vladimir Marko74527972016-11-29 15:57:32 +00002355 oat_writers_.emplace_back(new linker::OatWriter(
Vladimir Markoa0431112018-06-25 09:32:54 +01002356 *compiler_options_,
Igor Murashkin545412b2017-08-17 15:26:54 -07002357 timings_,
Mathieu Chartier603ccab2017-10-20 14:34:28 -07002358 do_oat_writer_layout ? profile_compilation_info_.get() : nullptr,
2359 compact_dex_level_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002360 }
2361 }
2362
Vladimir Marko49b0f452015-12-10 13:49:19 +00002363 void SaveDexInput() {
Vladimir Marko213ee2d2018-06-22 11:56:34 +01002364 const std::vector<const DexFile*>& dex_files = compiler_options_->dex_files_for_oat_file_;
2365 for (size_t i = 0, size = dex_files.size(); i != size; ++i) {
2366 const DexFile* dex_file = dex_files[i];
Vladimir Marko49b0f452015-12-10 13:49:19 +00002367 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2368 getpid(), i));
2369 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2370 if (tmp_file.get() == nullptr) {
2371 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2372 << ". Try: adb shell chmod 777 /data/local/tmp";
2373 continue;
2374 }
2375 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2376 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2377 UNUSED(tmp_file->Flush());
2378 UNUSED(tmp_file->Close());
2379 LOG(INFO) << "Wrote input to " << tmp_file_name;
2380 }
2381 }
2382
Mathieu Chartier46331a62017-07-21 09:49:10 -07002383 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options,
2384 QuickCompilerCallbacks* callbacks) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00002385 RuntimeOptions raw_options;
2386 if (boot_image_filename_.empty()) {
2387 std::string boot_class_path = "-Xbootclasspath:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002388 boot_class_path += android::base::Join(dex_filenames_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002389 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2390 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002391 boot_class_path_locations += android::base::Join(dex_locations_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002392 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2393 } else {
2394 std::string boot_image_option = "-Ximage:";
2395 boot_image_option += boot_image_filename_;
2396 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2397 }
2398 for (size_t i = 0; i < runtime_args_.size(); i++) {
2399 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2400 }
2401
Mathieu Chartier46331a62017-07-21 09:49:10 -07002402 raw_options.push_back(std::make_pair("compilercallbacks", callbacks));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002403 raw_options.push_back(
Vladimir Markoa0431112018-06-25 09:32:54 +01002404 std::make_pair("imageinstructionset",
2405 GetInstructionSetString(compiler_options_->GetInstructionSet())));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002406
2407 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2408 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2409 // have been stripped in preopting, anyways).
2410 if (!IsBootImage()) {
2411 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2412 }
Andreas Gampec8e35202017-04-28 15:47:12 -07002413 // Never allow implicit image compilation.
2414 raw_options.push_back(std::make_pair("-Xnoimage-dex2oat", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002415 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2416 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2417 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002418 // Disable Hspace compaction to save heap size virtual space.
2419 // Only need disable Hspace for OOM becasue background collector is equal to
2420 // foreground collector by default for dex2oat.
2421 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002422
Andreas Gampeace0dc12016-01-20 13:33:13 -08002423 if (compiler_options_->IsForceDeterminism()) {
Andreas Gampeace0dc12016-01-20 13:33:13 -08002424 // To make identity hashcode deterministic, set a known seed.
2425 mirror::Object::SetHashCodeSeed(987654321U);
2426 }
2427
Vladimir Marko49b0f452015-12-10 13:49:19 +00002428 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2429 LOG(ERROR) << "Failed to parse runtime options";
2430 return false;
2431 }
2432 return true;
2433 }
2434
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002435 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002436 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2437 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002438 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002439 LOG(ERROR) << "Failed to create runtime";
2440 return false;
2441 }
Andreas Gampe49c144d2016-11-14 10:11:16 -08002442
2443 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2444 // "ps -a" don't change to non-descript "main."
2445 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2446
Vladimir Marko307dac92015-10-20 11:20:09 +01002447 runtime_.reset(Runtime::Current());
Vladimir Markoa0431112018-06-25 09:32:54 +01002448 runtime_->SetInstructionSet(compiler_options_->GetInstructionSet());
Andreas Gampe8228cdf2017-05-30 15:03:54 -07002449 for (uint32_t i = 0; i < static_cast<uint32_t>(CalleeSaveType::kLastCalleeSaveType); ++i) {
2450 CalleeSaveType type = CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002451 if (!runtime_->HasCalleeSaveMethod(type)) {
2452 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002453 }
2454 }
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002455
2456 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2457 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002458 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002459
Vladimir Markodcfcce42018-06-27 10:00:28 +00002460 Thread* self = Thread::Current();
2461 runtime_->RunRootClinits(self);
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002462
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002463 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2464 // Runtime::Start, give it away now so that we don't starve GC.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002465 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002466
Koji Fukuia72ca6c2019-03-25 17:39:07 +09002467 WatchDog::SetRuntime(runtime_.get());
2468
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002469 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002470 }
2471
Jeff Haodcdc85b2015-12-04 14:06:18 -08002472 // 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 -08002473 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002474 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002475 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002476 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002477 CHECK(image_filenames_.empty());
Vladimir Markod011d812018-11-29 12:35:24 +00002478 image_filenames_.push_back(app_image_file_name_);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002479 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002480 if (!image_writer_->Write(app_image_fd_,
2481 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002482 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002483 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002484 return false;
2485 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002486
Jeff Haodcdc85b2015-12-04 14:06:18 -08002487 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002488 dchecked_vector<uintptr_t> oat_data_begins;
2489 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2490 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002491 }
Vladimir Markoa2da9b92018-10-10 14:21:55 +01002492 // Destroy ImageWriter.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002493 image_writer_.reset();
2494
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002495 return true;
2496 }
2497
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002498 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2499 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002500 template <typename T>
Vladimir Marko54159c62018-06-20 14:30:08 +01002501 static std::unique_ptr<T> ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002502 const char* input_filename, std::function<std::string(const char*)>* process) {
2503 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2504 if (input_file.get() == nullptr) {
2505 LOG(ERROR) << "Failed to open input file " << input_filename;
2506 return nullptr;
2507 }
Vladimir Markodc4bcce2018-06-21 16:15:42 +01002508 std::unique_ptr<T> result = ReadCommentedInputStream<T>(*input_file, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002509 input_file->close();
Vladimir Marko54159c62018-06-20 14:30:08 +01002510 return result;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002511 }
2512
2513 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2514 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002515 template <typename T>
Vladimir Marko54159c62018-06-20 14:30:08 +01002516 static std::unique_ptr<T> ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002517 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002518 const char* input_filename,
2519 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002520 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002521 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2522 if (zip_archive.get() == nullptr) {
2523 return nullptr;
2524 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002525 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002526 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002527 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002528 zip_filename, error_msg->c_str());
2529 return nullptr;
2530 }
Vladimir Markoc34bebf2018-08-16 16:12:49 +01002531 MemMap input_file = zip_entry->ExtractToMemMap(zip_filename, input_filename, error_msg);
2532 if (!input_file.IsValid()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002533 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002534 zip_filename, error_msg->c_str());
2535 return nullptr;
2536 }
Vladimir Markoc34bebf2018-08-16 16:12:49 +01002537 const std::string input_string(reinterpret_cast<char*>(input_file.Begin()), input_file.Size());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002538 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002539 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002540 }
2541
2542 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2543 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002544 template <typename T>
Vladimir Marko54159c62018-06-20 14:30:08 +01002545 static std::unique_ptr<T> ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002546 std::istream& in_stream,
2547 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002548 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002549 while (in_stream.good()) {
2550 std::string dot;
2551 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08002552 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002553 continue;
2554 }
2555 if (process != nullptr) {
2556 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002557 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002558 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002559 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002560 }
2561 }
Vladimir Marko54159c62018-06-20 14:30:08 +01002562 return output;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002563 }
2564
Mathieu Chartier49285c52014-12-02 15:43:48 -08002565 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002566 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2567 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002568 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampec560fc02014-07-16 09:57:39 -07002569 LOG(INFO) << "dex2oat took "
2570 << PrettyDuration(NanoTime() - start_ns_)
Andreas Gampecc967752016-12-12 13:49:00 -08002571 << " (" << PrettyDuration(ProcessCpuNanoTime() - start_cputime_ns_) << " cpu)"
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002572 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002573 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002574 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2575 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002576 }
2577
Jeff Haodcdc85b2015-12-04 14:06:18 -08002578 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2579 std::string res(image_filename);
2580 size_t last_slash = res.rfind('/');
2581 if (last_slash == std::string::npos || last_slash == 0) {
2582 return res;
2583 }
2584 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2585 if (penultimate_slash == std::string::npos) {
2586 return res;
2587 }
2588 // Check that the string in-between is the expected one.
2589 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2590 GetInstructionSetString(isa)) {
2591 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2592 return res;
2593 }
2594 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2595 }
2596
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002597 std::unique_ptr<CompilerOptions> compiler_options_;
2598 Compiler::Kind compiler_kind_;
2599
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002600 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2601
Vladimir Marko307dac92015-10-20 11:20:09 +01002602 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002603
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002604 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2605
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002606 std::unique_ptr<Runtime> runtime_;
2607
Calin Juravle1ce70852017-06-28 10:59:03 -07002608 // The spec describing how the class loader should be setup for compilation.
2609 std::unique_ptr<ClassLoaderContext> class_loader_context_;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002610
David Brazdil89821862019-03-19 13:57:43 +00002611 // Optional list of file descriptors corresponding to dex file locations in
2612 // flattened `class_loader_context_`.
2613 std::vector<int> class_loader_context_fds_;
2614
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07002615 // The class loader context stored in the oat file. May be equal to class_loader_context_.
Mathieu Chartierc4440772018-04-16 14:40:56 -07002616 std::unique_ptr<ClassLoaderContext> stored_class_loader_context_;
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07002617
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002618 size_t thread_count_;
2619 uint64_t start_ns_;
Andreas Gampec560fc02014-07-16 09:57:39 -07002620 uint64_t start_cputime_ns_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002621 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002622 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002623 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002624 std::string oat_location_;
Vladimir Markod011d812018-11-29 12:35:24 +00002625 std::vector<std::string> oat_filenames_;
2626 std::vector<std::string> oat_unstripped_;
David Srbeckyde91fd42018-07-05 22:27:08 +01002627 bool strip_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002628 int oat_fd_;
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00002629 int input_vdex_fd_;
2630 int output_vdex_fd_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002631 std::string input_vdex_;
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01002632 std::string output_vdex_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002633 std::unique_ptr<VdexFile> input_vdex_file_;
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00002634 int dm_fd_;
2635 std::string dm_file_location_;
2636 std::unique_ptr<ZipArchive> dm_file_;
Vladimir Markod011d812018-11-29 12:35:24 +00002637 std::vector<std::string> dex_filenames_;
2638 std::vector<std::string> dex_locations_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002639 int zip_fd_;
2640 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002641 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002642 std::vector<const char*> runtime_args_;
Vladimir Markod011d812018-11-29 12:35:24 +00002643 std::vector<std::string> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002644 uintptr_t image_base_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002645 ImageHeader::StorageMode image_storage_mode_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002646 const char* passes_to_run_filename_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002647 const char* dirty_image_objects_filename_;
Vladimir Marko54159c62018-06-20 14:30:08 +01002648 std::unique_ptr<HashSet<std::string>> dirty_image_objects_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002649 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002650 bool is_host_;
2651 std::string android_root_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002652 std::string no_inline_from_string_;
Mathieu Chartiera7f6b812017-12-11 13:34:29 -08002653 CompactDexLevel compact_dex_level_ = kDefaultCompactDexLevel;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002654
Vladimir Marko74527972016-11-29 15:57:32 +00002655 std::vector<std::unique_ptr<linker::ElfWriter>> elf_writers_;
2656 std::vector<std::unique_ptr<linker::OatWriter>> oat_writers_;
David Srbecky2faab002019-02-12 16:35:48 +00002657 std::vector<OutputStream*> rodata_;
2658 std::vector<std::unique_ptr<OutputStream>> vdex_out_;
Vladimir Marko74527972016-11-29 15:57:32 +00002659 std::unique_ptr<linker::ImageWriter> image_writer_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002660 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002661
Vladimir Markoc34bebf2018-08-16 16:12:49 +01002662 std::vector<MemMap> opened_dex_files_maps_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002663 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2664
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07002665 bool avoid_storing_invocation_;
Alex Light62afcf52018-12-18 14:19:25 -08002666 android::base::unique_fd invocation_file_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002667 std::string swap_file_name_;
2668 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002669 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2670 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002671 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002672 std::string app_image_file_name_;
2673 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002674 std::string profile_file_;
2675 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002676 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002677 TimingLogger* timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002678 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002679 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002680
2681 // Backing storage.
Andreas Gampe097f34c2017-08-23 08:57:51 -07002682 std::forward_list<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002683
Andreas Gampeace0dc12016-01-20 13:33:13 -08002684 // See CompilerOptions.force_determinism_.
2685 bool force_determinism_;
2686
Jeff Hao16d48432017-04-05 17:05:46 -07002687 // Directory of relative classpaths.
2688 std::string classpath_dir_;
2689
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00002690 // Whether the given input vdex is also the output.
2691 bool update_input_vdex_ = false;
2692
Nicolas Geoffray66ff8a82018-02-28 13:27:55 +00002693 // By default, copy the dex to the vdex file only if dex files are
2694 // compressed in APK.
Andreas Gampe15544172018-06-25 15:09:06 -07002695 linker::CopyOption copy_dex_files_ = linker::CopyOption::kOnlyIfCompressed;
Mathieu Chartier792111c2018-02-15 13:02:15 -08002696
Calin Juravle0e09dfc2018-02-12 19:01:09 -08002697 // The reason for invoking the compiler.
2698 std::string compilation_reason_;
2699
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002700 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2701};
2702
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002703static void b13564922() {
2704#if defined(__linux__) && defined(__arm__)
2705 int major, minor;
2706 struct utsname uts;
2707 if (uname(&uts) != -1 &&
2708 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2709 ((major < 3) || ((major == 3) && (minor < 4)))) {
2710 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2711 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2712 int old_personality = personality(0xffffffff);
2713 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2714 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2715 if (new_personality == -1) {
2716 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2717 }
2718 }
2719 }
2720#endif
2721}
2722
Mathieu Chartier72041a02017-07-14 18:23:25 -07002723class ScopedGlobalRef {
2724 public:
2725 explicit ScopedGlobalRef(jobject obj) : obj_(obj) {}
2726 ~ScopedGlobalRef() {
2727 if (obj_ != nullptr) {
2728 ScopedObjectAccess soa(Thread::Current());
Ian Rogers55256cb2017-12-21 17:07:11 -08002729 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), obj_);
Mathieu Chartier72041a02017-07-14 18:23:25 -07002730 }
2731 }
2732
2733 private:
2734 jobject obj_;
2735};
2736
Andreas Gampe7b565912017-03-20 15:48:52 -07002737static dex2oat::ReturnCode CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002738 dex2oat.LoadClassProfileDescriptors();
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002739 jobject class_loader = dex2oat.Compile();
Mathieu Chartier9e050df2017-08-09 10:05:47 -07002740 // Keep the class loader that was used for compilation live for the rest of the compilation
2741 // process.
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002742 ScopedGlobalRef global_ref(class_loader);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002743
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002744 if (!dex2oat.WriteOutputFiles(class_loader)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002745 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002746 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002747 }
2748
David Srbeckyde91fd42018-07-05 22:27:08 +01002749 // Flush boot.oat. Keep it open as we might still modify it later (strip it).
2750 if (!dex2oat.FlushOutputFiles()) {
2751 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002752 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002753 }
2754
Jeff Haodcdc85b2015-12-04 14:06:18 -08002755 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002756 if (!dex2oat.HandleImage()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002757 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002758 }
2759
2760 // When given --host, finish early without stripping.
2761 if (dex2oat.IsHost()) {
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002762 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002763 return dex2oat::ReturnCode::kOther;
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002764 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002765 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002766 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002767 }
2768
Jeff Haodcdc85b2015-12-04 14:06:18 -08002769 // Copy stripped to unstripped location, if necessary.
David Srbeckyde91fd42018-07-05 22:27:08 +01002770 if (!dex2oat.CopyOatFilesToSymbolsDirectoryAndStrip()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002771 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002772 }
2773
Jeff Haodcdc85b2015-12-04 14:06:18 -08002774 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002775 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002776 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002777 }
2778
2779 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002780 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002781}
2782
Andreas Gampe7b565912017-03-20 15:48:52 -07002783static dex2oat::ReturnCode CompileApp(Dex2Oat& dex2oat) {
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002784 jobject class_loader = dex2oat.Compile();
Mathieu Chartier9e050df2017-08-09 10:05:47 -07002785 // Keep the class loader that was used for compilation live for the rest of the compilation
2786 // process.
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002787 ScopedGlobalRef global_ref(class_loader);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002788
Nicolas Geoffrayf0d30022018-11-20 17:45:38 +00002789 if (!dex2oat.WriteOutputFiles(class_loader)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002790 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002791 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002792 }
2793
Jeff Haodcdc85b2015-12-04 14:06:18 -08002794 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002795 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002796
2797 // When given --host, finish early without stripping.
2798 if (dex2oat.IsHost()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002799 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002800 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002801 }
2802
2803 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002804 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002805 }
2806
Jeff Haodcdc85b2015-12-04 14:06:18 -08002807 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2808 // stripped versions. If this is given, we expect to be able to open writable files by name.
David Srbeckyde91fd42018-07-05 22:27:08 +01002809 if (!dex2oat.CopyOatFilesToSymbolsDirectoryAndStrip()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002810 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002811 }
2812
Jeff Haodcdc85b2015-12-04 14:06:18 -08002813 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002814 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002815 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002816 }
2817
2818 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002819 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002820}
2821
Andreas Gampe7b565912017-03-20 15:48:52 -07002822static dex2oat::ReturnCode Dex2oat(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002823 b13564922();
2824
2825 TimingLogger timings("compiler", false, false);
2826
Roland Levillain5c7e2602016-02-23 18:08:53 +00002827 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
2828 // might produce a stack frame too large for this function or for
2829 // functions inlining it (such as main), that would not fit the
2830 // requirements of the `-Wframe-larger-than` option.
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07002831 std::unique_ptr<Dex2Oat> dex2oat = std::make_unique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002832
2833 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002834 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002835
Calin Juravle814a80f2019-06-26 15:01:10 -07002836 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap, vdex and profiles.
2837
Calin Juravleb077e152016-02-18 18:47:37 +00002838 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02002839 // This operation involves I/O.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002840 if (dex2oat->UseProfile()) {
Calin Juravleb077e152016-02-18 18:47:37 +00002841 if (!dex2oat->LoadProfile()) {
2842 LOG(ERROR) << "Failed to process profile file";
Andreas Gampe7b565912017-03-20 15:48:52 -07002843 return dex2oat::ReturnCode::kOther;
Calin Juravle998c2162015-12-21 15:39:33 +02002844 }
2845 }
2846
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002847
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002848 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00002849 if (!dex2oat->OpenFile()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002850 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002851 }
2852
Andreas Gampe046c7062015-05-18 23:22:54 -07002853 // Print the complete line when any of the following is true:
2854 // 1) Debug build
2855 // 2) Compiling an image
2856 // 3) Compiling with --host
2857 // 4) Compiling on the host (not a target build)
2858 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002859 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07002860 LOG(INFO) << CommandLine();
2861 } else {
2862 LOG(INFO) << StrippedCommandLine();
2863 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002864
Andreas Gampef7882972017-03-20 16:35:24 -07002865 dex2oat::ReturnCode setup_code = dex2oat->Setup();
2866 if (setup_code != dex2oat::ReturnCode::kNoFailure) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002867 dex2oat->EraseOutputFiles();
Andreas Gampef7882972017-03-20 16:35:24 -07002868 return setup_code;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002869 }
2870
Shubham Ajmera188b2bf2017-09-20 15:53:35 -07002871 // TODO: Due to the cyclic dependencies, profile loading and verifying are
2872 // being done separately. Refactor and place the two next to each other.
2873 // If verification fails, we don't abort the compilation and instead log an
2874 // error.
2875 // TODO(b/62602192, b/65260586): We should consider aborting compilation when
2876 // the profile verification fails.
2877 // Note: If dex2oat fails, installd will remove the oat files causing the app
2878 // to fallback to apk with possible in-memory extraction. We want to avoid
2879 // that, and thus we're lenient towards profile corruptions.
2880 if (dex2oat->UseProfile()) {
2881 dex2oat->VerifyProfileData();
2882 }
2883
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07002884 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
2885 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07002886 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
2887
Andreas Gampe7b565912017-03-20 15:48:52 -07002888 dex2oat::ReturnCode result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00002889 if (dex2oat->IsImage()) {
2890 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002891 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00002892 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002893 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002894
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002895 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002896}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002897} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07002898
2899int main(int argc, char** argv) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002900 int result = static_cast<int>(art::Dex2oat(argc, argv));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002901 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
Roland Levillain05e34f42018-05-24 13:19:05 +00002902 // time (bug 10645725) unless we're a debug or instrumented build or running on a memory tool.
2903 // Note: The Dex2Oat class should not destruct the runtime in this case.
2904 if (!art::kIsDebugBuild && !art::kIsPGOInstrumentation && !art::kRunningOnMemoryTool) {
Andreas Gampee286b642017-04-13 12:20:42 -07002905 _exit(result);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002906 }
2907 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002908}