blob: 6cd947c8cfd4045f5f63a77576834d20c8e49003 [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"
52#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010053#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070054#include "base/timing_logger.h"
55#include "base/unix_file/fd_file.h"
David Sehrc431b9d2018-03-02 12:01:51 -080056#include "base/utils.h"
David Sehr79e26072018-04-06 17:58:50 -070057#include "base/zip_archive.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070058#include "class_linker.h"
Calin Juravle1ce70852017-06-28 10:59:03 -070059#include "class_loader_context.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070060#include "cmdline_parser.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000061#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000062#include "compiler_callbacks.h"
David Srbecky09c2a6b2016-03-11 17:11:44 +000063#include "debug/elf_debug_writer.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000064#include "debug/method_debug_info.h"
Mathieu Chartier2c4b0842017-12-13 11:49:51 -080065#include "dexlayout.h"
David Sehrb2ec9f52018-02-21 13:20:31 -080066#include "dex/descriptors_names.h"
David Sehr9e734c72018-01-04 17:56:19 -080067#include "dex/dex_file-inl.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000068#include "dex/quick_compiler_callbacks.h"
69#include "dex/verification_results.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070070#include "dex2oat_options.h"
Andreas Gampe7b565912017-03-20 15:48:52 -070071#include "dex2oat_return_codes.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070072#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080073#include "driver/compiler_options.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070074#include "driver/compiler_options_map-inl.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080075#include "elf_file.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070076#include "gc/space/image_space.h"
77#include "gc/space/space-inl.h"
Mathieu Chartier72041a02017-07-14 18:23:25 -070078#include "gc/verification.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070079#include "interpreter/unstarted_runtime.h"
Vladimir Markoa3ad0cd2018-05-04 10:06:38 +010080#include "jni/java_vm_ext.h"
David Brazdil5d5a36b2016-09-14 15:34:10 +010081#include "linker/buffered_output_stream.h"
Vladimir Marko74527972016-11-29 15:57:32 +000082#include "linker/elf_writer.h"
83#include "linker/elf_writer_quick.h"
David Brazdil5d5a36b2016-09-14 15:34:10 +010084#include "linker/file_output_stream.h"
Vladimir Marko74527972016-11-29 15:57:32 +000085#include "linker/image_writer.h"
Vladimir Marko944da602016-02-19 12:27:55 +000086#include "linker/multi_oat_relative_patcher.h"
Vladimir Marko74527972016-11-29 15:57:32 +000087#include "linker/oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070088#include "mirror/class-inl.h"
89#include "mirror/class_loader.h"
90#include "mirror/object-inl.h"
91#include "mirror/object_array-inl.h"
Andreas Gampe2ff3b972017-06-05 18:14:53 -070092#include "oat_file.h"
Jeff Haob11ffb72016-04-07 15:40:54 -070093#include "oat_file_assistant.h"
David Sehr82d046e2018-04-23 08:14:19 -070094#include "profile/profile_compilation_info.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070095#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000096#include "runtime_options.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070097#include "scoped_thread_state_change-inl.h"
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +000098#include "vdex_file.h"
David Brazdilca3c8c32016-09-06 14:04:48 +010099#include "verifier/verifier_deps.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -0700100#include "well_known_classes.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -0700101
102namespace art {
103
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800104using android::base::StringAppendV;
105using android::base::StringPrintf;
106
Andreas Gampee1459ae2016-06-29 09:36:30 -0700107static constexpr size_t kDefaultMinDexFilesForSwap = 2;
108static constexpr size_t kDefaultMinDexFileCumulativeSizeForSwap = 20 * MB;
109
Mathieu Chartier010126f2017-07-15 15:44:18 -0700110// Compiler filter override for very large apps.
111static constexpr CompilerFilter::Filter kLargeAppFilter = CompilerFilter::kVerify;
112
Brian Carlstrom6449c622014-02-10 23:48:36 -0800113static int original_argc;
114static char** original_argv;
115
116static std::string CommandLine() {
117 std::vector<std::string> command;
118 for (int i = 0; i < original_argc; ++i) {
119 command.push_back(original_argv[i]);
120 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800121 return android::base::Join(command, ' ');
Brian Carlstrom6449c622014-02-10 23:48:36 -0800122}
123
Andreas Gampe046c7062015-05-18 23:22:54 -0700124// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
125// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
126// locations are all staged).
127static std::string StrippedCommandLine() {
128 std::vector<std::string> command;
129
Calin Juravle07c6d722017-06-07 17:06:12 +0000130 // Do a pre-pass to look for zip-fd and the compiler filter.
Andreas Gampe046c7062015-05-18 23:22:54 -0700131 bool saw_zip_fd = false;
Calin Juravle07c6d722017-06-07 17:06:12 +0000132 bool saw_compiler_filter = false;
Andreas Gampe046c7062015-05-18 23:22:54 -0700133 for (int i = 0; i < original_argc; ++i) {
Andreas Gampe9186ced2016-12-12 14:28:21 -0800134 if (android::base::StartsWith(original_argv[i], "--zip-fd=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700135 saw_zip_fd = true;
Andreas Gampe046c7062015-05-18 23:22:54 -0700136 }
Calin Juravle07c6d722017-06-07 17:06:12 +0000137 if (android::base::StartsWith(original_argv[i], "--compiler-filter=")) {
138 saw_compiler_filter = true;
Calin Juravle07c6d722017-06-07 17:06:12 +0000139 }
Andreas Gampe046c7062015-05-18 23:22:54 -0700140 }
141
142 // Now filter out things.
143 for (int i = 0; i < original_argc; ++i) {
144 // All runtime-arg parameters are dropped.
145 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
146 i++; // Drop the next part, too.
147 continue;
148 }
149
150 // Any instruction-setXXX is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800151 if (android::base::StartsWith(original_argv[i], "--instruction-set")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700152 continue;
153 }
154
155 // The boot image is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800156 if (android::base::StartsWith(original_argv[i], "--boot-image=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700157 continue;
158 }
159
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800160 // The image format is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800161 if (android::base::StartsWith(original_argv[i], "--image-format=")) {
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800162 continue;
163 }
164
Andreas Gampe046c7062015-05-18 23:22:54 -0700165 // This should leave any dex-file and oat-file options, describing what we compiled.
166
167 // However, we prefer to drop this when we saw --zip-fd.
168 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700169 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe9186ced2016-12-12 14:28:21 -0800170 if (android::base::StartsWith(original_argv[i], "--zip-") ||
171 android::base::StartsWith(original_argv[i], "--dex-") ||
172 android::base::StartsWith(original_argv[i], "--oat-") ||
173 android::base::StartsWith(original_argv[i], "--swap-") ||
174 android::base::StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700175 continue;
176 }
177 }
178
179 command.push_back(original_argv[i]);
180 }
181
Calin Juravle07c6d722017-06-07 17:06:12 +0000182 if (!saw_compiler_filter) {
183 command.push_back("--compiler-filter=" +
184 CompilerFilter::NameOfFilter(CompilerFilter::kDefaultCompilerFilter));
185 }
186
Andreas Gampe046c7062015-05-18 23:22:54 -0700187 // Construct the final output.
188 if (command.size() <= 1U) {
189 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
190 return "Starting dex2oat.";
191 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800192 return android::base::Join(command, ' ');
Andreas Gampe046c7062015-05-18 23:22:54 -0700193}
194
Brian Carlstrom7940e442013-07-12 13:46:57 -0700195static void UsageErrorV(const char* fmt, va_list ap) {
196 std::string error;
197 StringAppendV(&error, fmt, ap);
198 LOG(ERROR) << error;
199}
200
201static void UsageError(const char* fmt, ...) {
202 va_list ap;
203 va_start(ap, fmt);
204 UsageErrorV(fmt, ap);
205 va_end(ap);
206}
207
Andreas Gampe794ad762015-02-23 08:12:24 -0800208NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700209 va_list ap;
210 va_start(ap, fmt);
211 UsageErrorV(fmt, ap);
212 va_end(ap);
213
Brian Carlstrom6449c622014-02-10 23:48:36 -0800214 UsageError("Command: %s", CommandLine().c_str());
215
Brian Carlstrom7940e442013-07-12 13:46:57 -0700216 UsageError("Usage: dex2oat [options]...");
217 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100218 UsageError(" -j<number>: specifies the number of threads used for compilation.");
219 UsageError(" Default is the number of detected hardware threads available on the");
220 UsageError(" host system.");
221 UsageError(" Example: -j12");
222 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700223 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700224 UsageError(" Example: --dex-file=/system/framework/core.jar");
225 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700226 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
227 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
228 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
229 UsageError(" --dex-location=/system/framework/core.jar");
230 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700231 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
232 UsageError(" containing a classes.dex file to compile.");
233 UsageError(" Example: --zip-fd=5");
234 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700235 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
236 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700237 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
238 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800239 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700240 UsageError(" Example: --oat-file=/system/framework/boot.oat");
241 UsageError("");
242 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900243 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700244 UsageError("");
Shubham Ajmera66205322017-10-06 11:18:51 -0700245 UsageError(" --input-vdex-fd=<number>: specifies the vdex input source via a file descriptor.");
246 UsageError(" Example: --input-vdex-fd=6");
247 UsageError("");
248 UsageError(" --output-vdex-fd=<number>: specifies the vdex output destination via a file");
249 UsageError(" descriptor.");
250 UsageError(" Example: --output-vdex-fd=6");
251 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700252 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
253 UsageError(" to the file descriptor specified by --oat-fd.");
254 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
255 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800256 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700257 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
258 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800259 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700260 UsageError(" Example: --image=/system/framework/boot.art");
261 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800262 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800263 UsageError(" Which format to store the image.");
264 UsageError(" Example: --image-format=lz4");
265 UsageError(" Default: uncompressed");
266 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700267 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
268 UsageError(" Example: --image=frameworks/base/preloaded-classes");
269 UsageError("");
270 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
271 UsageError(" Example: --base=0x50000000");
272 UsageError("");
273 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000274 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700275 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000276 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000277 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700278 UsageError("");
279 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
280 UsageError(" Example: --android-root=out/host/linux-x86");
281 UsageError(" Default: $ANDROID_ROOT");
282 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800283 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700284 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700285 UsageError(" Example: --instruction-set=x86");
286 UsageError(" Default: arm");
287 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700288 UsageError(" --instruction-set-features=...,: Specify instruction set features");
289 UsageError(" Example: --instruction-set-features=div");
290 UsageError(" Default: default");
291 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700292 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
293 UsageError(" Default: disabled");
294 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800295 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700296 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800297 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100298 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700299 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100300 UsageError(" --compiler-filter="
Nicolas Geoffray49cda062017-04-21 13:08:25 +0100301 "(assume-verified"
302 "|extract"
303 "|verify"
304 "|quicken"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000305 "|space-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100306 "|space"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000307 "|speed-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100308 "|speed"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000309 "|everything-profile"
310 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700311 UsageError(" select compiler filter.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800312 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800313 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800314 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800315 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
316 UsageError(" method for compiler filter tuning.");
317 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
318 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
319 UsageError("");
320 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
321 UsageError(" method for compiler filter tuning.");
322 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
323 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
324 UsageError("");
325 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
326 UsageError(" method for compiler filter tuning.");
327 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
328 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
329 UsageError("");
330 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
331 UsageError(" method for compiler filter tuning.");
332 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
333 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
334 UsageError("");
335 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
336 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700337 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
338 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800339 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
340 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
341 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100342 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
343 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100344 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
345 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100346 UsageError(" Example: --inline-max-code-units=%d",
347 CompilerOptions::kDefaultInlineMaxCodeUnits);
348 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
349 UsageError("");
Nicolas Geoffraye82b60f2017-12-10 21:50:10 +0000350 UsageError(" --dump-timings: display a breakdown of where time was spent");
Ian Rogers46398602013-08-20 07:50:36 -0700351 UsageError("");
Vladimir Marko2da52b02018-05-08 16:31:34 +0100352 UsageError(" --dump-pass-timings: display a breakdown of time spent in optimization");
353 UsageError(" passes for each compiled method.");
354 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100355 UsageError(" -g");
356 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
357 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000358 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000359 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700360 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100361 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100362 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000363 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
364 UsageError(" debug information necessary to print backtraces. (disabled by default)");
365 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000366 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000367 UsageError("");
Alexey Alexandrovab40c112016-09-19 09:33:49 -0700368 UsageError(" --generate-build-id: Generate GNU-compatible linker build ID ELF section with");
369 UsageError(" SHA-1 of the file content (and thus stable across identical builds)");
370 UsageError("");
371 UsageError(" --no-generate-build-id: Do not generate the build ID ELF section.");
372 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000373 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000374 UsageError("");
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700375 UsageError(" --avoid-storing-invocation: Avoid storing the invocation args in the key value");
376 UsageError(" store. Used to test determinism with different args.");
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("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800415 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
416 "input dex file.");
417 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000418 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000419 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100420 UsageError(" --dump-cfg=<cfg-file>: dump control-flow graphs (CFGs) to specified file.");
421 UsageError(" Example: --dump-cfg=output.cfg");
422 UsageError("");
423 UsageError(" --dump-cfg-append: when dumping CFGs to an existing file, append new CFG data to");
424 UsageError(" existing data (instead of overwriting existing data with new data, which is");
425 UsageError(" the default behavior). This option is only meaningful when used with");
426 UsageError(" --dump-cfg.");
427 UsageError("");
Jeff Hao16d48432017-04-05 17:05:46 -0700428 UsageError(" --classpath-dir=<directory-path>: directory used to resolve relative class paths.");
429 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700430 UsageError(" --class-loader-context=<string spec>: a string specifying the intended");
431 UsageError(" runtime loading context for the compiled dex files.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700432 UsageError("");
Mathieu Chartierf5abfc42018-03-23 21:51:54 -0700433 UsageError(" --stored-class-loader-context=<string spec>: a string specifying the intended");
434 UsageError(" runtime loading context that is stored in the oat file. Overrides");
435 UsageError(" --class-loader-context. Note that this ignores the classpath_dir arg.");
436 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700437 UsageError(" It describes how the class loader chain should be built in order to ensure");
438 UsageError(" classes are resolved during dex2aot as they would be resolved at runtime.");
439 UsageError(" This spec will be encoded in the oat file. If at runtime the dex file is");
440 UsageError(" loaded in a different context, the oat file will be rejected.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700441 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700442 UsageError(" The chain is interpreted in the natural 'parent order', meaning that class");
443 UsageError(" loader 'i+1' will be the parent of class loader 'i'.");
Calin Juravlec79470d2017-07-12 17:37:42 -0700444 UsageError(" The compilation sources will be appended to the classpath of the first class");
445 UsageError(" loader.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700446 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700447 UsageError(" E.g. if the context is 'PCL[lib1.dex];DLC[lib2.dex]' and ");
448 UsageError(" --dex-file=src.dex then dex2oat will setup a PathClassLoader with classpath ");
449 UsageError(" 'lib1.dex:src.dex' and set its parent to a DelegateLastClassLoader with ");
450 UsageError(" classpath 'lib2.dex'.");
Calin Juravle1ce70852017-06-28 10:59:03 -0700451 UsageError(" ");
452 UsageError(" Note that the compiler will be tolerant if the source dex files specified");
453 UsageError(" with --dex-file are found in the classpath. The source dex files will be");
454 UsageError(" removed from any class loader's classpath possibly resulting in empty");
455 UsageError(" class loaders.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700456 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700457 UsageError(" Example: --class-loader-context=PCL[lib1.dex:lib2.dex];DLC[lib3.dex]");
Calin Juravle1ce70852017-06-28 10:59:03 -0700458 UsageError("");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700459 UsageError(" --dirty-image-objects=<directory-path>: list of known dirty objects in the image.");
460 UsageError(" The image writer will group them together.");
461 UsageError("");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700462 UsageError(" --compact-dex-level=none|fast: None avoids generating compact dex, fast");
Mathieu Chartierddf39552018-04-03 10:22:27 -0700463 UsageError(" generates compact dex with low compile time. If speed-profile is specified as");
464 UsageError(" the compiler filter and the profile is not empty, the default compact dex");
465 UsageError(" level is always used.");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700466 UsageError("");
Andreas Gampee20ff6f2017-11-07 15:00:35 -0800467 UsageError(" --deduplicate-code=true|false: enable|disable code deduplication. Deduplicated");
468 UsageError(" code will have an arbitrary symbol tagged with [DEDUPED].");
Andreas Gampecac31ad2017-11-06 20:01:17 -0800469 UsageError("");
Nicolas Geoffray66ff8a82018-02-28 13:27:55 +0000470 UsageError(" --copy-dex-files=true|false: enable|disable copying the dex files into the");
Mathieu Chartier792111c2018-02-15 13:02:15 -0800471 UsageError(" output vdex.");
472 UsageError("");
Calin Juravle0e09dfc2018-02-12 19:01:09 -0800473 UsageError(" --compilation-reason=<string>: optional metadata specifying the reason for");
474 UsageError(" compiling the apk. If specified, the string will be embedded verbatim in");
475 UsageError(" the key value store of the oat file.");
476 UsageError("");
477 UsageError(" Example: --compilation-reason=install");
478 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700479 std::cerr << "See log for usage error information\n";
480 exit(EXIT_FAILURE);
481}
482
Brian Carlstrom7940e442013-07-12 13:46:57 -0700483// The primary goal of the watchdog is to prevent stuck build servers
484// during development when fatal aborts lead to a cascade of failures
485// that result in a deadlock.
486class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800487// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700488#undef CHECK_PTHREAD_CALL
489#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
490 do { \
491 int rc = call args; \
492 if (rc != 0) { \
493 errno = rc; \
494 std::string message(# call); \
495 message += " failed for "; \
496 message += reason; \
497 Fatal(message); \
498 } \
499 } while (false)
500
501 public:
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800502 explicit WatchDog(int64_t timeout_in_milliseconds)
Andreas Gampe0f54b0d2017-12-27 08:37:02 -0800503 : timeout_in_milliseconds_(timeout_in_milliseconds),
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800504 shutting_down_(false) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700505 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700506 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800507#ifndef __APPLE__
508 pthread_condattr_t condattr;
liulvping8f7101e2017-01-16 15:14:43 +0800509 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_init, (&condattr), reason);
510 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_setclock, (&condattr, CLOCK_MONOTONIC), reason);
511 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, &condattr), reason);
512 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_destroy, (&condattr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800513#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700514 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
515 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
516 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
517 }
518 ~WatchDog() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700519 const char* reason = "dex2oat watch dog thread shutdown";
520 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
521 shutting_down_ = true;
522 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
523 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
524
Kenny Root51316382014-05-13 14:59:37 -0700525 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700526
527 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
528 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
529 }
530
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800531 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
532 // large.
533 static constexpr int64_t kWatchdogVerifyMultiplier =
534 kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
535
536 // When setting timeouts, keep in mind that the build server may not be as fast as your
537 // desktop. Debug builds are slower so they have larger timeouts.
538 static constexpr int64_t kWatchdogSlowdownFactor = kIsDebugBuild ? 5U : 1U;
539
540 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
541 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
542 // itself before that watchdog would take down the system server.
543 static constexpr int64_t kWatchDogTimeoutSeconds = kWatchdogSlowdownFactor * (9 * 60 + 30);
544
545 static constexpr int64_t kDefaultWatchdogTimeoutInMS =
546 kWatchdogVerifyMultiplier * kWatchDogTimeoutSeconds * 1000;
547
Brian Carlstrom7940e442013-07-12 13:46:57 -0700548 private:
549 static void* CallBack(void* arg) {
550 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
551 ::art::SetThreadName("dex2oat watch dog");
552 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700553 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700554 }
555
Andreas Gampe794ad762015-02-23 08:12:24 -0800556 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700557 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
558 // it's rather easy to hang in unwinding.
559 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
560 // logcat logging or stderr output.
Tomasz Wasilczyk8d840902017-12-20 08:19:53 -0800561 LogHelper::LogLineLowStack(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
562
Andreas Gampe48fde372017-06-06 07:43:46 -0700563 // If we're on the host, try to dump all threads to get a sense of what's going on. This is
564 // restricted to the host as the dump may itself go bad.
565 // TODO: Use a double watchdog timeout, so we can enable this on-device.
566 if (!kIsTargetBuild && Runtime::Current() != nullptr) {
Andreas Gampecd607312017-06-05 17:03:05 -0700567 Runtime::Current()->AttachCurrentThread("Watchdog thread attached for dumping",
568 true,
569 nullptr,
570 false);
571 Runtime::Current()->DumpForSigQuit(std::cerr);
572 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700573 exit(1);
574 }
575
576 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700577 timespec timeout_ts;
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800578#if defined(__APPLE__)
579 InitTimeSpec(true, CLOCK_REALTIME, timeout_in_milliseconds_, 0, &timeout_ts);
580#else
liulvping8f7101e2017-01-16 15:14:43 +0800581 InitTimeSpec(true, CLOCK_MONOTONIC, timeout_in_milliseconds_, 0, &timeout_ts);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800582#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700583 const char* reason = "dex2oat watch dog thread waiting";
584 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
585 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800586 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700587 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700588 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800589 timeout_in_milliseconds_/1000));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700590 } else if (rc != 0) {
591 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
592 strerror(errno)));
593 Fatal(message.c_str());
594 }
595 }
596 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
597 }
598
Brian Carlstrom7940e442013-07-12 13:46:57 -0700599 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
600 pthread_mutex_t mutex_;
601 pthread_cond_t cond_;
602 pthread_attr_t attr_;
603 pthread_t pthread_;
Andreas Gampef45d61c2017-06-07 10:29:33 -0700604
605 const int64_t timeout_in_milliseconds_;
606 bool shutting_down_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700607};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700608
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800609class Dex2Oat FINAL {
610 public:
611 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100612 compiler_kind_(Compiler::kOptimizing),
Vladimir Marko33bff252017-11-01 14:35:42 +0000613 instruction_set_(kRuntimeISA == InstructionSet::kArm ? InstructionSet::kThumb2 : kRuntimeISA),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800614 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000615 image_file_location_oat_checksum_(0),
616 image_file_location_oat_data_begin_(0),
617 image_patch_delta_(0),
618 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700619 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800620 runtime_(nullptr),
621 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
622 start_ns_(NanoTime()),
Andreas Gampec560fc02014-07-16 09:57:39 -0700623 start_cputime_ns_(ProcessCpuNanoTime()),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800624 oat_fd_(-1),
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000625 input_vdex_fd_(-1),
626 output_vdex_fd_(-1),
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000627 input_vdex_file_(nullptr),
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +0000628 dm_fd_(-1),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800629 zip_fd_(-1),
630 image_base_(0U),
631 image_classes_zip_filename_(nullptr),
632 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800633 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700634 passes_to_run_filename_(nullptr),
Mathieu Chartierff0baff2017-08-02 23:04:19 -0700635 dirty_image_objects_filename_(nullptr),
Jeff Hao436183f2016-01-12 16:36:50 -0800636 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800637 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000638 elf_writers_(),
639 oat_writers_(),
640 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000641 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700642 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000643 opened_dex_files_maps_(),
644 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000645 no_inline_from_dex_files_(),
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700646 avoid_storing_invocation_(false),
Calin Juravle2e2db782016-02-23 12:00:03 +0000647 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800648 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000649 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800650 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000651 force_determinism_(false)
652 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800653
654 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800655 // Log completion time before deleting the runtime_, because this accesses
656 // the runtime.
657 LogCompletionTime();
658
Roland Levillain05e34f42018-05-24 13:19:05 +0000659 if (!kIsDebugBuild && !(kRunningOnMemoryTool && kMemoryToolDetectsLeaks)) {
Vladimir Marko307dac92015-10-20 11:20:09 +0100660 // We want to just exit on non-debug builds, not bringing the runtime down
661 // in an orderly fashion. So release the following fields.
662 driver_.release();
663 image_writer_.release();
664 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
665 dex_file.release();
666 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000667 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
668 map.release();
669 }
David Brazdil7b49e6c2016-09-01 11:06:18 +0100670 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
671 vdex_file.release();
672 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800673 for (std::unique_ptr<File>& oat_file : oat_files_) {
674 oat_file.release();
675 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100676 runtime_.release();
677 verification_results_.release();
678 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100679 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700680 }
681
Roland Levillain9ec5e222015-08-17 20:18:41 +0100682 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800683 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800684 std::string boot_image_filename;
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800685 int64_t watch_dog_timeout_in_ms = -1;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800686 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000687 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800688 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100689 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800690
Andreas Gampe097f34c2017-08-23 08:57:51 -0700691 void ParseBase(const std::string& option) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100692 char* end;
Andreas Gampe097f34c2017-08-23 08:57:51 -0700693 image_base_ = strtoul(option.c_str(), &end, 16);
694 if (end == option.c_str() || *end != '\0') {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100695 Usage("Failed to parse hexadecimal value for option %s", option.data());
696 }
697 }
698
Shubham Ajmera188b2bf2017-09-20 15:53:35 -0700699 bool VerifyProfileData() {
700 return profile_compilation_info_->VerifyProfileData(dex_files_);
701 }
702
Andreas Gampe097f34c2017-08-23 08:57:51 -0700703 void ParseInstructionSetVariant(const std::string& option, ParserOptions* parser_options) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800704 instruction_set_features_ = InstructionSetFeatures::FromVariant(
Andreas Gampe097f34c2017-08-23 08:57:51 -0700705 instruction_set_, option, &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100706 if (instruction_set_features_.get() == nullptr) {
707 Usage("%s", parser_options->error_msg.c_str());
708 }
709 }
710
Andreas Gampe097f34c2017-08-23 08:57:51 -0700711 void ParseInstructionSetFeatures(const std::string& option, ParserOptions* parser_options) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800712 if (instruction_set_features_ == nullptr) {
713 instruction_set_features_ = InstructionSetFeatures::FromVariant(
714 instruction_set_, "default", &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100715 if (instruction_set_features_.get() == nullptr) {
716 Usage("Problem initializing default instruction set features variant: %s",
717 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700718 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800719 }
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800720 instruction_set_features_ =
Andreas Gampe097f34c2017-08-23 08:57:51 -0700721 instruction_set_features_->AddFeaturesFromString(option, &parser_options->error_msg);
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800722 if (instruction_set_features_ == nullptr) {
Andreas Gampe097f34c2017-08-23 08:57:51 -0700723 Usage("Error parsing '%s': %s", option.c_str(), parser_options->error_msg.c_str());
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800724 }
725 }
726
Jeff Hao436183f2016-01-12 16:36:50 -0800727 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoaad75c62016-10-03 08:46:48 +0000728 compiler_options_->boot_image_ = !image_filenames_.empty();
729 compiler_options_->app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700730
Roland Levillain2b03a1f2017-06-06 16:09:59 +0100731 if (IsBootImage() && image_filenames_.size() == 1) {
732 const std::string& boot_image_filename = image_filenames_[0];
733 compiler_options_->core_image_ = CompilerDriver::IsCoreImageFilename(boot_image_filename);
734 }
735
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700736 if (IsAppImage() && IsBootImage()) {
737 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
738 }
739
Jeff Haodcdc85b2015-12-04 14:06:18 -0800740 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800741 Usage("Output must be supplied with either --oat-file or --oat-fd");
742 }
743
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000744 if (input_vdex_fd_ != -1 && !input_vdex_.empty()) {
745 Usage("Can't have both --input-vdex-fd and --input-vdex");
746 }
747
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +0100748 if (output_vdex_fd_ != -1 && !output_vdex_.empty()) {
749 Usage("Can't have both --output-vdex-fd and --output-vdex");
750 }
751
Jeff Haodcdc85b2015-12-04 14:06:18 -0800752 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800753 Usage("--oat-file should not be used with --oat-fd");
754 }
755
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000756 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
Sascha Roth5f71c652018-04-10 00:27:15 +0200757 Usage("VDEX and OAT output must be specified either with one --oat-file "
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000758 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100759 }
760
Roland Levillain9ec5e222015-08-17 20:18:41 +0100761 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800762 Usage("--oat-symbols should not be used with --oat-fd");
763 }
764
Roland Levillain9ec5e222015-08-17 20:18:41 +0100765 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800766 Usage("--oat-symbols should not be used with --host");
767 }
768
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000769 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
770 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100771 }
772
Jeff Haodcdc85b2015-12-04 14:06:18 -0800773 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800774 Usage("--oat-fd should not be used with --image");
775 }
776
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +0000777 if ((input_vdex_fd_ != -1 || !input_vdex_.empty()) &&
778 (dm_fd_ != -1 || !dm_file_location_.empty())) {
779 Usage("An input vdex should not be passed with a .dm file");
780 }
781
Jeff Haodcdc85b2015-12-04 14:06:18 -0800782 if (!parser_options->oat_symbols.empty() &&
783 parser_options->oat_symbols.size() != oat_filenames_.size()) {
784 Usage("--oat-file arguments do not match --oat-symbols arguments");
785 }
786
787 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
788 Usage("--oat-file arguments do not match --image arguments");
789 }
790
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800791 if (android_root_.empty()) {
792 const char* android_root_env_var = getenv("ANDROID_ROOT");
793 if (android_root_env_var == nullptr) {
794 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700795 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800796 android_root_ += android_root_env_var;
797 }
798
Vladimir Markoaad75c62016-10-03 08:46:48 +0000799 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100800 parser_options->boot_image_filename += android_root_;
801 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800802 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100803 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000804 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800805 }
806
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700807 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800808 Usage("--image-classes should only be used with --image");
809 }
810
Vladimir Marko49b0f452015-12-10 13:49:19 +0000811 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800812 Usage("--image-classes should not be used with --boot-image");
813 }
814
815 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
816 Usage("--image-classes-zip should be used with --image-classes");
817 }
818
819 if (dex_filenames_.empty() && zip_fd_ == -1) {
820 Usage("Input must be supplied with either --dex-file or --zip-fd");
821 }
822
823 if (!dex_filenames_.empty() && zip_fd_ != -1) {
824 Usage("--dex-file should not be used with --zip-fd");
825 }
826
827 if (!dex_filenames_.empty() && !zip_location_.empty()) {
828 Usage("--dex-file should not be used with --zip-location");
829 }
830
831 if (dex_locations_.empty()) {
832 for (const char* dex_file_name : dex_filenames_) {
833 dex_locations_.push_back(dex_file_name);
834 }
835 } else if (dex_locations_.size() != dex_filenames_.size()) {
836 Usage("--dex-location arguments do not match --dex-file arguments");
837 }
838
Jeff Haodcdc85b2015-12-04 14:06:18 -0800839 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
840 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
841 Usage("--oat-file arguments must be singular or match --dex-file arguments");
842 }
843 }
844
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800845 if (zip_fd_ != -1 && zip_location_.empty()) {
846 Usage("--zip-location should be supplied with --zip-fd");
847 }
848
Vladimir Marko49b0f452015-12-10 13:49:19 +0000849 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800850 if (image_base_ == 0) {
851 Usage("Non-zero --base not specified");
852 }
853 }
854
Mathieu Chartiera8077802016-03-16 19:08:31 -0700855 const bool have_profile_file = !profile_file_.empty();
856 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
857 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000858 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200859 }
860
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -0700861 if (have_profile_file || have_profile_fd) {
Andreas Gampebd600e32018-04-12 14:25:39 -0700862 if (image_classes_filename_ != nullptr ||
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -0700863 image_classes_zip_filename_ != nullptr) {
864 Usage("Profile based image creation is not supported with image or compiled classes");
865 }
866 }
867
Roland Levillain9ec5e222015-08-17 20:18:41 +0100868 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800869 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800870 }
871
872 // If no instruction set feature was given, use the default one for the target
873 // instruction set.
874 if (instruction_set_features_.get() == nullptr) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800875 instruction_set_features_ = InstructionSetFeatures::FromVariant(
876 instruction_set_, "default", &parser_options->error_msg);
Ian Rogersd582fa42014-11-05 23:46:43 -0800877 if (instruction_set_features_.get() == nullptr) {
878 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100879 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800880 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800881 }
882
883 if (instruction_set_ == kRuntimeISA) {
884 std::unique_ptr<const InstructionSetFeatures> runtime_features(
885 InstructionSetFeatures::FromCppDefines());
886 if (!instruction_set_features_->Equals(runtime_features.get())) {
887 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
888 << *instruction_set_features_ << ") and those of dex2oat executable ("
889 << *runtime_features <<") for the command line:\n"
890 << CommandLine();
891 }
892 }
893
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000894 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +0000895 compiler_options_->inline_max_code_units_ = CompilerOptions::kDefaultInlineMaxCodeUnits;
Roland Levillaina215b952015-08-07 11:38:32 +0100896 }
897
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800898 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800899 // Set the compilation target's implicit checks options.
900 switch (instruction_set_) {
Vladimir Marko33bff252017-11-01 14:35:42 +0000901 case InstructionSet::kArm:
902 case InstructionSet::kThumb2:
903 case InstructionSet::kArm64:
904 case InstructionSet::kX86:
905 case InstructionSet::kX86_64:
906 case InstructionSet::kMips:
907 case InstructionSet::kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000908 compiler_options_->implicit_null_checks_ = true;
909 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800910 break;
911
912 default:
913 // Defaults are correct.
914 break;
915 }
916
Jeff Hao436183f2016-01-12 16:36:50 -0800917 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800918 Usage("--multi-image can only be used when creating boot images");
919 }
Jeff Hao436183f2016-01-12 16:36:50 -0800920 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800921 Usage("--multi-image cannot be used with multiple image names");
922 }
923
924 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
925 if (!kIsTargetBuild && IsBootImage()) {
926 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800927 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800928 }
929 }
930
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800931 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100932 if (parser_options->watch_dog_enabled) {
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800933 int64_t timeout = parser_options->watch_dog_timeout_in_ms > 0
934 ? parser_options->watch_dog_timeout_in_ms
935 : WatchDog::kDefaultWatchdogTimeoutInMS;
936 watchdog_.reset(new WatchDog(timeout));
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800937 }
938
939 // Fill some values into the key-value store for the oat header.
940 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800941
Roland Levillainb81e9e92017-04-20 17:35:32 +0100942 // Automatically force determinism for the boot image in a host build if read barriers
943 // are enabled, or if the default GC is CMS or MS. When the default GC is CMS
944 // (Concurrent Mark-Sweep), the GC is switched to a non-concurrent one by passing the
945 // option `-Xgc:nonconcurrent` (see below).
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800946 if (!kIsTargetBuild && IsBootImage()) {
947 if (SupportsDeterministicCompilation()) {
948 force_determinism_ = true;
949 } else {
950 LOG(WARNING) << "Deterministic compilation is disabled.";
951 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800952 }
953 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700954
955 if (passes_to_run_filename_ != nullptr) {
Vladimir Marko54159c62018-06-20 14:30:08 +0100956 passes_to_run_ = ReadCommentedInputFromFile<std::vector<std::string>>(
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700957 passes_to_run_filename_,
Vladimir Marko54159c62018-06-20 14:30:08 +0100958 nullptr); // No post-processing.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700959 if (passes_to_run_.get() == nullptr) {
960 Usage("Failed to read list of passes to run.");
961 }
962 }
963 compiler_options_->passes_to_run_ = passes_to_run_.get();
Roland Levillain9ec5e222015-08-17 20:18:41 +0100964 }
965
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800966 static bool SupportsDeterministicCompilation() {
Roland Levillainb81e9e92017-04-20 17:35:32 +0100967 return (kUseReadBarrier ||
968 gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
969 gc::kCollectorTypeDefault == gc::kCollectorTypeMS);
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800970 }
971
Jeff Hao436183f2016-01-12 16:36:50 -0800972 void ExpandOatAndImageFilenames() {
973 std::string base_oat = oat_filenames_[0];
974 size_t last_oat_slash = base_oat.rfind('/');
975 if (last_oat_slash == std::string::npos) {
976 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
977 }
978 // We also need to honor path components that were encoded through '@'. Otherwise the loading
979 // code won't be able to find the images.
980 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
981 last_oat_slash = base_oat.rfind('@');
982 }
983 base_oat = base_oat.substr(0, last_oat_slash + 1);
984
985 std::string base_img = image_filenames_[0];
986 size_t last_img_slash = base_img.rfind('/');
987 if (last_img_slash == std::string::npos) {
988 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
989 }
990 // We also need to honor path components that were encoded through '@'. Otherwise the loading
991 // code won't be able to find the images.
992 if (base_img.find('@', last_img_slash) != std::string::npos) {
993 last_img_slash = base_img.rfind('@');
994 }
995
996 // Get the prefix, which is the primary image name (without path components). Strip the
997 // extension.
998 std::string prefix = base_img.substr(last_img_slash + 1);
999 if (prefix.rfind('.') != std::string::npos) {
1000 prefix = prefix.substr(0, prefix.rfind('.'));
1001 }
1002 if (!prefix.empty()) {
1003 prefix = prefix + "-";
1004 }
1005
1006 base_img = base_img.substr(0, last_img_slash + 1);
1007
1008 // Note: we have some special case here for our testing. We have to inject the differentiating
1009 // parts for the different core images.
1010 std::string infix; // Empty infix by default.
1011 {
1012 // Check the first name.
1013 std::string dex_file = oat_filenames_[0];
1014 size_t last_dex_slash = dex_file.rfind('/');
1015 if (last_dex_slash != std::string::npos) {
1016 dex_file = dex_file.substr(last_dex_slash + 1);
1017 }
1018 size_t last_dex_dot = dex_file.rfind('.');
1019 if (last_dex_dot != std::string::npos) {
1020 dex_file = dex_file.substr(0, last_dex_dot);
1021 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001022 if (android::base::StartsWith(dex_file, "core-")) {
Jeff Hao436183f2016-01-12 16:36:50 -08001023 infix = dex_file.substr(strlen("core"));
1024 }
1025 }
1026
bowen_lai8bd36c02016-10-12 13:28:55 +08001027 std::string base_symbol_oat;
1028 if (!oat_unstripped_.empty()) {
1029 base_symbol_oat = oat_unstripped_[0];
1030 size_t last_symbol_oat_slash = base_symbol_oat.rfind('/');
1031 if (last_symbol_oat_slash == std::string::npos) {
1032 Usage("--multi-image used with unusable symbol filename %s", base_symbol_oat.c_str());
1033 }
1034 base_symbol_oat = base_symbol_oat.substr(0, last_symbol_oat_slash + 1);
1035 }
1036
Jeff Hao436183f2016-01-12 16:36:50 -08001037 // Now create the other names. Use a counted loop to skip the first one.
1038 for (size_t i = 1; i < dex_locations_.size(); ++i) {
1039 // TODO: Make everything properly std::string.
1040 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
Andreas Gampe097f34c2017-08-23 08:57:51 -07001041 char_backing_storage_.push_front(base_img + image_name);
1042 image_filenames_.push_back(char_backing_storage_.front().c_str());
Jeff Hao436183f2016-01-12 16:36:50 -08001043
1044 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
Andreas Gampe097f34c2017-08-23 08:57:51 -07001045 char_backing_storage_.push_front(base_oat + oat_name);
1046 oat_filenames_.push_back(char_backing_storage_.front().c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001047
1048 if (!base_symbol_oat.empty()) {
Andreas Gampe097f34c2017-08-23 08:57:51 -07001049 char_backing_storage_.push_front(base_symbol_oat + oat_name);
1050 oat_unstripped_.push_back(char_backing_storage_.front().c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001051 }
Jeff Hao436183f2016-01-12 16:36:50 -08001052 }
1053 }
1054
Andreas Gampe8994a042015-12-30 19:03:17 +00001055 // Modify the input string in the following way:
1056 // 0) Assume input is /a/b/c.d
1057 // 1) Strip the path -> c.d
1058 // 2) Inject prefix p -> pc.d
1059 // 3) Inject infix i -> pci.d
1060 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -08001061 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +00001062 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001063 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +00001064 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001065 size_t last_dex_slash = in.rfind('/');
1066 if (last_dex_slash != std::string::npos) {
1067 in = in.substr(last_dex_slash + 1);
1068 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001069 if (!prefix.empty()) {
1070 in = prefix + in;
1071 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001072 if (!infix.empty()) {
1073 // Inject infix.
1074 size_t last_dot = in.rfind('.');
1075 if (last_dot != std::string::npos) {
1076 in.insert(last_dot, infix);
1077 }
1078 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001079 if (android::base::EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001080 in = in.substr(0, in.length() - strlen(".jar")) +
1081 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001082 }
1083 return in;
1084 }
1085
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001086 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001087 std::ostringstream oss;
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001088 if (!avoid_storing_invocation_) {
1089 for (int i = 0; i < argc; ++i) {
1090 if (i > 0) {
1091 oss << ' ';
1092 }
1093 oss << argv[i];
Roland Levillain9ec5e222015-08-17 20:18:41 +01001094 }
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001095 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1096 oss.str(""); // Reset.
Roland Levillain9ec5e222015-08-17 20:18:41 +01001097 }
Roland Levillain9ec5e222015-08-17 20:18:41 +01001098 oss << kRuntimeISA;
1099 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1100 key_value_store_->Put(
1101 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001102 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001103 key_value_store_->Put(
1104 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001105 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001106 key_value_store_->Put(
1107 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001108 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001109 key_value_store_->Put(OatHeader::kCompilerFilter,
1110 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Andreas Gampef8cd8902017-01-18 16:05:01 -08001111 key_value_store_->Put(OatHeader::kConcurrentCopying,
1112 kUseReadBarrier ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001113 }
1114
Andreas Gampe097f34c2017-08-23 08:57:51 -07001115 // This simple forward is here so the string specializations below don't look out of place.
1116 template <typename T, typename U>
1117 void AssignIfExists(Dex2oatArgumentMap& map,
1118 const Dex2oatArgumentMap::Key<T>& key,
1119 U* out) {
1120 map.AssignIfExists(key, out);
1121 }
1122
1123 // Specializations to handle const char* vs std::string.
1124 void AssignIfExists(Dex2oatArgumentMap& map,
1125 const Dex2oatArgumentMap::Key<std::string>& key,
1126 const char** out) {
1127 if (map.Exists(key)) {
1128 char_backing_storage_.push_front(std::move(*map.Get(key)));
1129 *out = char_backing_storage_.front().c_str();
1130 }
1131 }
1132 void AssignIfExists(Dex2oatArgumentMap& map,
1133 const Dex2oatArgumentMap::Key<std::vector<std::string>>& key,
1134 std::vector<const char*>* out) {
1135 if (map.Exists(key)) {
1136 for (auto& val : *map.Get(key)) {
1137 char_backing_storage_.push_front(std::move(val));
1138 out->push_back(char_backing_storage_.front().c_str());
1139 }
1140 }
1141 }
1142
1143 template <typename T>
1144 void AssignTrueIfExists(Dex2oatArgumentMap& map,
1145 const Dex2oatArgumentMap::Key<T>& key,
1146 bool* out) {
1147 if (map.Exists(key)) {
1148 *out = true;
1149 }
1150 }
1151
Roland Levillain9ec5e222015-08-17 20:18:41 +01001152 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1153 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1154 // returns, arguments have been successfully parsed.
1155 void ParseArgs(int argc, char** argv) {
1156 original_argc = argc;
1157 original_argv = argv;
1158
David Sehrc431b9d2018-03-02 12:01:51 -08001159 Locks::Init();
Andreas Gampe51d80cc2017-06-21 21:05:13 -07001160 InitLogging(argv, Runtime::Abort);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001161
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001162 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001163
Andreas Gampe097f34c2017-08-23 08:57:51 -07001164 using M = Dex2oatArgumentMap;
1165 std::string error_msg;
1166 std::unique_ptr<M> args_uptr = M::Parse(argc, const_cast<const char**>(argv), &error_msg);
1167 if (args_uptr == nullptr) {
1168 Usage("Failed to parse command line: %s", error_msg.c_str());
1169 UNREACHABLE();
1170 }
1171
1172 M& args = *args_uptr;
1173
1174 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
1175
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07001176 AssignIfExists(args, M::CompactDexLevel, &compact_dex_level_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001177 AssignIfExists(args, M::DexFiles, &dex_filenames_);
1178 AssignIfExists(args, M::DexLocations, &dex_locations_);
1179 AssignIfExists(args, M::OatFiles, &oat_filenames_);
1180 AssignIfExists(args, M::OatSymbols, &parser_options->oat_symbols);
1181 AssignIfExists(args, M::ImageFilenames, &image_filenames_);
1182 AssignIfExists(args, M::ZipFd, &zip_fd_);
1183 AssignIfExists(args, M::ZipLocation, &zip_location_);
1184 AssignIfExists(args, M::InputVdexFd, &input_vdex_fd_);
1185 AssignIfExists(args, M::OutputVdexFd, &output_vdex_fd_);
1186 AssignIfExists(args, M::InputVdex, &input_vdex_);
1187 AssignIfExists(args, M::OutputVdex, &output_vdex_);
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001188 AssignIfExists(args, M::DmFd, &dm_fd_);
1189 AssignIfExists(args, M::DmFile, &dm_file_location_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001190 AssignIfExists(args, M::OatFd, &oat_fd_);
1191 AssignIfExists(args, M::OatLocation, &oat_location_);
1192 AssignIfExists(args, M::Watchdog, &parser_options->watch_dog_enabled);
1193 AssignIfExists(args, M::WatchdogTimeout, &parser_options->watch_dog_timeout_in_ms);
1194 AssignIfExists(args, M::Threads, &thread_count_);
1195 AssignIfExists(args, M::ImageClasses, &image_classes_filename_);
1196 AssignIfExists(args, M::ImageClassesZip, &image_classes_zip_filename_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001197 AssignIfExists(args, M::Passes, &passes_to_run_filename_);
1198 AssignIfExists(args, M::BootImage, &parser_options->boot_image_filename);
1199 AssignIfExists(args, M::AndroidRoot, &android_root_);
1200 AssignIfExists(args, M::Profile, &profile_file_);
1201 AssignIfExists(args, M::ProfileFd, &profile_file_fd_);
1202 AssignIfExists(args, M::RuntimeOptions, &runtime_args_);
1203 AssignIfExists(args, M::SwapFile, &swap_file_name_);
1204 AssignIfExists(args, M::SwapFileFd, &swap_fd_);
1205 AssignIfExists(args, M::SwapDexSizeThreshold, &min_dex_file_cumulative_size_for_swap_);
1206 AssignIfExists(args, M::SwapDexCountThreshold, &min_dex_files_for_swap_);
1207 AssignIfExists(args, M::VeryLargeAppThreshold, &very_large_threshold_);
1208 AssignIfExists(args, M::AppImageFile, &app_image_file_name_);
1209 AssignIfExists(args, M::AppImageFileFd, &app_image_fd_);
1210 AssignIfExists(args, M::NoInlineFrom, &no_inline_from_string_);
1211 AssignIfExists(args, M::ClasspathDir, &classpath_dir_);
1212 AssignIfExists(args, M::DirtyImageObjects, &dirty_image_objects_filename_);
1213 AssignIfExists(args, M::ImageFormat, &image_storage_mode_);
Calin Juravle0e09dfc2018-02-12 19:01:09 -08001214 AssignIfExists(args, M::CompilationReason, &compilation_reason_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001215
1216 AssignIfExists(args, M::Backend, &compiler_kind_);
1217 parser_options->requested_specific_compiler = args.Exists(M::Backend);
1218
1219 AssignIfExists(args, M::TargetInstructionSet, &instruction_set_);
1220 // arm actually means thumb2.
1221 if (instruction_set_ == InstructionSet::kArm) {
1222 instruction_set_ = InstructionSet::kThumb2;
1223 }
1224
1225 AssignTrueIfExists(args, M::Host, &is_host_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001226 AssignTrueIfExists(args, M::AvoidStoringInvocation, &avoid_storing_invocation_);
1227 AssignTrueIfExists(args, M::MultiImage, &multi_image_);
Mathieu Chartier792111c2018-02-15 13:02:15 -08001228 AssignIfExists(args, M::CopyDexFiles, &copy_dex_files_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001229
1230 if (args.Exists(M::ForceDeterminism)) {
1231 if (!SupportsDeterministicCompilation()) {
1232 Usage("Option --force-determinism requires read barriers or a CMS/MS garbage collector");
Roland Levillain9ec5e222015-08-17 20:18:41 +01001233 }
Andreas Gampe097f34c2017-08-23 08:57:51 -07001234 force_determinism_ = true;
1235 }
1236
1237 if (args.Exists(M::Base)) {
1238 ParseBase(*args.Get(M::Base));
1239 }
1240 if (args.Exists(M::TargetInstructionSetVariant)) {
1241 ParseInstructionSetVariant(*args.Get(M::TargetInstructionSetVariant), parser_options.get());
1242 }
1243 if (args.Exists(M::TargetInstructionSetFeatures)) {
1244 ParseInstructionSetFeatures(*args.Get(M::TargetInstructionSetFeatures), parser_options.get());
1245 }
1246 if (args.Exists(M::ClassLoaderContext)) {
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001247 std::string class_loader_context_arg = *args.Get(M::ClassLoaderContext);
1248 class_loader_context_ = ClassLoaderContext::Create(class_loader_context_arg);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001249 if (class_loader_context_ == nullptr) {
1250 Usage("Option --class-loader-context has an incorrect format: %s",
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001251 class_loader_context_arg.c_str());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001252 }
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001253 if (args.Exists(M::StoredClassLoaderContext)) {
Mathieu Chartierc4440772018-04-16 14:40:56 -07001254 const std::string stored_context_arg = *args.Get(M::StoredClassLoaderContext);
1255 stored_class_loader_context_ = ClassLoaderContext::Create(stored_context_arg);
1256 if (stored_class_loader_context_ == nullptr) {
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001257 Usage("Option --stored-class-loader-context has an incorrect format: %s",
Mathieu Chartierc4440772018-04-16 14:40:56 -07001258 stored_context_arg.c_str());
Vladimir Markod8860b42018-05-02 14:58:12 +01001259 } else if (class_loader_context_->VerifyClassLoaderContextMatch(
Mathieu Chartierc4440772018-04-16 14:40:56 -07001260 stored_context_arg,
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001261 /*verify_names*/ false,
Vladimir Markod8860b42018-05-02 14:58:12 +01001262 /*verify_checksums*/ false) != ClassLoaderContext::VerificationResult::kVerifies) {
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001263 Usage(
1264 "Option --stored-class-loader-context '%s' mismatches --class-loader-context '%s'",
Mathieu Chartierc4440772018-04-16 14:40:56 -07001265 stored_context_arg.c_str(),
1266 class_loader_context_arg.c_str());
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001267 }
1268 }
1269 } else if (args.Exists(M::StoredClassLoaderContext)) {
1270 Usage("Option --stored-class-loader-context should only be used if "
1271 "--class-loader-context is also specified");
Roland Levillain9ec5e222015-08-17 20:18:41 +01001272 }
1273
Andreas Gampe097f34c2017-08-23 08:57:51 -07001274 if (!ReadCompilerOptions(args, compiler_options_.get(), &error_msg)) {
1275 Usage(error_msg.c_str());
1276 }
1277
Jeff Hao436183f2016-01-12 16:36:50 -08001278 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001279
1280 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001281 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001282 }
1283
Jeff Haodcdc85b2015-12-04 14:06:18 -08001284 // Check whether the oat output files are writable, and open them for later. Also open a swap
1285 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001286 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001287 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1288 PruneNonExistentDexFiles();
1289
Jeff Hao436183f2016-01-12 16:36:50 -08001290 // Expand oat and image filenames for multi image.
1291 if (IsBootImage() && multi_image_) {
1292 ExpandOatAndImageFilenames();
1293 }
1294
David Brazdil7b49e6c2016-09-01 11:06:18 +01001295 // OAT and VDEX file handling
David Brazdil7b49e6c2016-09-01 11:06:18 +01001296 if (oat_fd_ == -1) {
1297 DCHECK(!oat_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08001298 for (const char* oat_filename : oat_filenames_) {
1299 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
Calin Juravleb09be722017-09-25 16:42:48 -07001300 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001301 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1302 return false;
1303 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001304 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001305 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1306 oat_file->Erase();
1307 return false;
1308 }
1309 oat_files_.push_back(std::move(oat_file));
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001310 DCHECK_EQ(input_vdex_fd_, -1);
1311 if (!input_vdex_.empty()) {
1312 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001313 input_vdex_file_ = VdexFile::Open(input_vdex_,
1314 /* writable */ false,
1315 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001316 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001317 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001318 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001319
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001320 DCHECK_EQ(output_vdex_fd_, -1);
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001321 std::string vdex_filename = output_vdex_.empty()
1322 ? ReplaceFileExtension(oat_filename, "vdex")
1323 : output_vdex_;
1324 if (vdex_filename == input_vdex_ && output_vdex_.empty()) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001325 update_input_vdex_ = true;
1326 std::unique_ptr<File> vdex_file(OS::OpenFileReadWrite(vdex_filename.c_str()));
1327 vdex_files_.push_back(std::move(vdex_file));
1328 } else {
1329 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
Calin Juravleb09be722017-09-25 16:42:48 -07001330 if (vdex_file == nullptr) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001331 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1332 return false;
1333 }
1334 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1335 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1336 vdex_file->Erase();
1337 return false;
1338 }
1339 vdex_files_.push_back(std::move(vdex_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001340 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001341 }
1342 } else {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001343 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, /* check_usage */ true));
Calin Juravleb09be722017-09-25 16:42:48 -07001344 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001345 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1346 return false;
1347 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001348 oat_file->DisableAutoClose();
1349 if (oat_file->SetLength(0) != 0) {
1350 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001351 oat_file->Erase();
1352 return false;
David Brazdil7b49e6c2016-09-01 11:06:18 +01001353 }
1354 oat_files_.push_back(std::move(oat_file));
1355
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001356 if (input_vdex_fd_ != -1) {
1357 struct stat s;
1358 int rc = TEMP_FAILURE_RETRY(fstat(input_vdex_fd_, &s));
1359 if (rc == -1) {
1360 PLOG(WARNING) << "Failed getting length of vdex file";
1361 } else {
1362 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001363 input_vdex_file_ = VdexFile::Open(input_vdex_fd_,
1364 s.st_size,
1365 "vdex",
1366 /* writable */ false,
1367 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001368 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001369 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001370 // If there's any problem with the passed vdex, just warn and proceed
1371 // without it.
1372 if (input_vdex_file_ == nullptr) {
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001373 PLOG(WARNING) << "Failed opening vdex file: " << error_msg;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001374 }
1375 }
1376 }
1377
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001378 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001379 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001380 std::unique_ptr<File> vdex_file(new File(output_vdex_fd_, vdex_location, /* check_usage */ true));
Calin Juravleb09be722017-09-25 16:42:48 -07001381 if (vdex_file == nullptr) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001382 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001383 return false;
1384 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001385 vdex_file->DisableAutoClose();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001386 if (input_vdex_file_ != nullptr && output_vdex_fd_ == input_vdex_fd_) {
1387 update_input_vdex_ = true;
1388 } else {
1389 if (vdex_file->SetLength(0) != 0) {
1390 PLOG(ERROR) << "Truncating vdex file " << vdex_location << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001391 vdex_file->Erase();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001392 return false;
1393 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001394 }
1395 vdex_files_.push_back(std::move(vdex_file));
1396
Jeff Haodcdc85b2015-12-04 14:06:18 -08001397 oat_filenames_.push_back(oat_location_.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001398 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001399
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001400 // If we're updating in place a vdex file, be defensive and put an invalid vdex magic in case
1401 // dex2oat gets killed.
1402 // Note: we're only invalidating the magic data in the file, as dex2oat needs the rest of
1403 // the information to remain valid.
1404 if (update_input_vdex_) {
Vladimir Marko74527972016-11-29 15:57:32 +00001405 std::unique_ptr<linker::BufferedOutputStream> vdex_out =
1406 std::make_unique<linker::BufferedOutputStream>(
1407 std::make_unique<linker::FileOutputStream>(vdex_files_.back().get()));
Nicolas Geoffray3a293552018-03-02 10:52:16 +00001408 if (!vdex_out->WriteFully(&VdexFile::VerifierDepsHeader::kVdexInvalidMagic,
1409 arraysize(VdexFile::VerifierDepsHeader::kVdexInvalidMagic))) {
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001410 PLOG(ERROR) << "Failed to invalidate vdex header. File: " << vdex_out->GetLocation();
1411 return false;
1412 }
1413
1414 if (!vdex_out->Flush()) {
1415 PLOG(ERROR) << "Failed to flush stream after invalidating header of vdex file."
1416 << " File: " << vdex_out->GetLocation();
1417 return false;
1418 }
1419 }
1420
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001421 if (dm_fd_ != -1 || !dm_file_location_.empty()) {
1422 std::string error_msg;
1423 if (dm_fd_ != -1) {
1424 dm_file_.reset(ZipArchive::OpenFromFd(dm_fd_, "DexMetadata", &error_msg));
1425 } else {
1426 dm_file_.reset(ZipArchive::Open(dm_file_location_.c_str(), &error_msg));
1427 }
1428 if (dm_file_ == nullptr) {
1429 LOG(WARNING) << "Could not open DexMetadata archive " << error_msg;
1430 }
1431 }
1432
1433 if (dm_file_ != nullptr) {
1434 DCHECK(input_vdex_file_ == nullptr);
1435 std::string error_msg;
1436 static const char* kDexMetadata = "DexMetadata";
1437 std::unique_ptr<ZipEntry> zip_entry(dm_file_->Find(VdexFile::kVdexNameInDmFile, &error_msg));
1438 if (zip_entry == nullptr) {
1439 LOG(INFO) << "No " << VdexFile::kVdexNameInDmFile << " file in DexMetadata archive. "
1440 << "Not doing fast verification.";
1441 } else {
Mathieu Chartier792111c2018-02-15 13:02:15 -08001442 std::unique_ptr<MemMap> input_file(zip_entry->MapDirectlyOrExtract(
1443 VdexFile::kVdexNameInDmFile,
1444 kDexMetadata,
1445 &error_msg));
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001446 if (input_file == nullptr) {
1447 LOG(WARNING) << "Could not open vdex file in DexMetadata archive: " << error_msg;
1448 } else {
1449 input_vdex_file_ = std::make_unique<VdexFile>(input_file.release());
1450 }
1451 }
1452 }
1453
David Brazdil7b49e6c2016-09-01 11:06:18 +01001454 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001455 //
1456 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1457 // that we can use for swap.
1458 //
1459 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1460 // will immediately unlink to satisfy the swap fd assumption.
1461 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1462 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1463 if (swap_file.get() == nullptr) {
1464 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1465 return false;
1466 }
1467 swap_fd_ = swap_file->Fd();
1468 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1469 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1470 // released immediately.
1471 unlink(swap_file_name_.c_str());
1472 }
Jeff Hao436183f2016-01-12 16:36:50 -08001473
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001474 return true;
1475 }
1476
David Brazdil7b49e6c2016-09-01 11:06:18 +01001477 void EraseOutputFiles() {
1478 for (auto& files : { &vdex_files_, &oat_files_ }) {
1479 for (size_t i = 0; i < files->size(); ++i) {
1480 if ((*files)[i].get() != nullptr) {
1481 (*files)[i]->Erase();
1482 (*files)[i].reset();
1483 }
1484 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001485 }
Andreas Gampea650e702014-12-03 14:28:02 -08001486 }
1487
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001488 void LoadClassProfileDescriptors() {
Mathieu Chartierf85b3db2018-04-02 18:16:21 -07001489 if (!IsImage()) {
1490 return;
1491 }
1492 // If we don't have a profile, treat it as an empty set of classes. b/77340429
1493 if (image_classes_ == nullptr) {
1494 // May be non-null when --image-classes is passed in, in that case avoid clearing the list.
Vladimir Marko54159c62018-06-20 14:30:08 +01001495 image_classes_.reset(new HashSet<std::string>());
Mathieu Chartierf85b3db2018-04-02 18:16:21 -07001496 }
1497 if (profile_compilation_info_ != nullptr) {
Mathieu Chartier0b490842016-05-25 15:05:59 -07001498 // Filter out class path classes since we don't want to include these in the image.
Mathieu Chartier4f342b02017-07-21 17:12:39 -07001499 image_classes_.reset(
Vladimir Marko54159c62018-06-20 14:30:08 +01001500 new HashSet<std::string>(profile_compilation_info_->GetClassDescriptors(dex_files_)));
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001501 VLOG(compiler) << "Loaded " << image_classes_->size()
1502 << " image class descriptors from profile";
1503 if (VLOG_IS_ON(compiler)) {
1504 for (const std::string& s : *image_classes_) {
1505 LOG(INFO) << "Image class " << s;
1506 }
1507 }
1508 }
1509 }
1510
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001511 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1512 // boot class path.
Andreas Gampef7882972017-03-20 16:35:24 -07001513 dex2oat::ReturnCode Setup() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001514 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001515
Andreas Gampebd600e32018-04-12 14:25:39 -07001516 if (!PrepareImageClasses() || !PrepareDirtyObjects()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001517 return dex2oat::ReturnCode::kOther;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001518 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001519
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001520 // Verification results are null since we don't know if we will need them yet as the compler
1521 // filter may change.
Andreas Gampe4585f872015-03-27 23:45:15 -07001522 callbacks_.reset(new QuickCompilerCallbacks(
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001523 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001524 CompilerCallbacks::CallbackMode::kCompileBootImage :
1525 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001526
Vladimir Marko49b0f452015-12-10 13:49:19 +00001527 RuntimeArgumentMap runtime_options;
Mathieu Chartier46331a62017-07-21 09:49:10 -07001528 if (!PrepareRuntimeOptions(&runtime_options, callbacks_.get())) {
Andreas Gampef7882972017-03-20 16:35:24 -07001529 return dex2oat::ReturnCode::kOther;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001530 }
1531
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001532 CreateOatWriters();
1533 if (!AddDexFileSources()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001534 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001535 }
1536
Calin Juravle0e09dfc2018-02-12 19:01:09 -08001537 if (!compilation_reason_.empty()) {
1538 key_value_store_->Put(OatHeader::kCompilationReasonKey, compilation_reason_);
1539 }
1540
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001541 if (IsBootImage() && image_filenames_.size() > 1) {
1542 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1543 // We need this for the multi-image case.
Mathieu Chartier866d8742016-09-21 15:24:18 -07001544 key_value_store_->Put(OatHeader::kBootClassPathKey,
1545 gc::space::ImageSpace::GetMultiImageBootClassPath(dex_locations_,
1546 oat_filenames_,
1547 image_filenames_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001548 }
1549
1550 if (!IsBootImage()) {
1551 // When compiling an app, create the runtime early to retrieve
1552 // the image location key needed for the oat header.
1553 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001554 return dex2oat::ReturnCode::kCreateRuntime;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001555 }
1556
Andreas Gampe29d38e72016-03-23 15:31:51 +00001557 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001558 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1559 std::vector<gc::space::ImageSpace*> image_spaces =
1560 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Richard Uhlerbc26b722017-03-10 14:27:10 +00001561 image_file_location_oat_checksum_ = image_spaces[0]->GetImageHeader().GetOatChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001562 image_file_location_oat_data_begin_ =
1563 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1564 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1565 // Store the boot image filename(s).
1566 std::vector<std::string> image_filenames;
1567 for (const gc::space::ImageSpace* image_space : image_spaces) {
1568 image_filenames.push_back(image_space->GetImageFilename());
1569 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001570 std::string image_file_location = android::base::Join(image_filenames, ':');
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001571 if (!image_file_location.empty()) {
1572 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1573 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001574 } else {
1575 image_file_location_oat_checksum_ = 0u;
1576 image_file_location_oat_data_begin_ = 0u;
1577 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001578 }
1579
1580 // Open dex files for class path.
Calin Juravle19915892017-08-03 17:10:36 +00001581
Calin Juravle1ce70852017-06-28 10:59:03 -07001582 if (class_loader_context_ == nullptr) {
Calin Juravle19915892017-08-03 17:10:36 +00001583 // If no context was specified use the default one (which is an empty PathClassLoader).
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001584 class_loader_context_ = ClassLoaderContext::Default();
Jeff Haof0192c82016-03-28 20:39:50 -07001585 }
Calin Juravle19915892017-08-03 17:10:36 +00001586
Calin Juravle1ce70852017-06-28 10:59:03 -07001587 DCHECK_EQ(oat_writers_.size(), 1u);
1588
1589 // Note: Ideally we would reject context where the source dex files are also
1590 // specified in the classpath (as it doesn't make sense). However this is currently
1591 // needed for non-prebuild tests and benchmarks which expects on the fly compilation.
1592 // Also, for secondary dex files we do not have control on the actual classpath.
1593 // Instead of aborting, remove all the source location from the context classpaths.
1594 if (class_loader_context_->RemoveLocationsFromClassPaths(
1595 oat_writers_[0]->GetSourceLocations())) {
1596 LOG(WARNING) << "The source files to be compiled are also in the classpath.";
1597 }
1598
1599 // We need to open the dex files before encoding the context in the oat file.
1600 // (because the encoding adds the dex checksum...)
1601 // TODO(calin): consider redesigning this so we don't have to open the dex files before
1602 // creating the actual class loader.
1603 if (!class_loader_context_->OpenDexFiles(runtime_->GetInstructionSet(), classpath_dir_)) {
1604 // Do not abort if we couldn't open files from the classpath. They might be
1605 // apks without dex files and right now are opening flow will fail them.
1606 LOG(WARNING) << "Failed to open classpath dex files";
1607 }
1608
1609 // Store the class loader context in the oat header.
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001610 // TODO: deprecate this since store_class_loader_context should be enough to cover the users
1611 // of classpath_dir as well.
Mathieu Chartierc4440772018-04-16 14:40:56 -07001612 std::string class_path_key =
1613 class_loader_context_->EncodeContextForOatFile(classpath_dir_,
1614 stored_class_loader_context_.get());
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001615 key_value_store_->Put(OatHeader::kClassPathKey, class_path_key);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001616 }
1617
1618 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001619 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001620 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1621 rodata_.reserve(oat_writers_.size());
1622 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1623 rodata_.push_back(elf_writers_[i]->StartRoData());
1624 // Unzip or copy dex files straight to the oat file.
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00001625 std::vector<std::unique_ptr<MemMap>> opened_dex_files_map;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001626 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
Mathieu Chartierd45863a2018-03-21 18:16:36 -07001627 // No need to verify the dex file when we have a vdex file, which means it was already
1628 // verified.
1629 const bool verify = (input_vdex_file_ == nullptr);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001630 if (!oat_writers_[i]->WriteAndOpenDexFiles(
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +00001631 vdex_files_[i].get(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01001632 rodata_.back(),
1633 instruction_set_,
1634 instruction_set_features_.get(),
1635 key_value_store_.get(),
Jeff Hao042e8982016-10-19 11:17:11 -07001636 verify,
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001637 update_input_vdex_,
Mathieu Chartier792111c2018-02-15 13:02:15 -08001638 copy_dex_files_,
David Brazdil7b49e6c2016-09-01 11:06:18 +01001639 &opened_dex_files_map,
1640 &opened_dex_files)) {
Andreas Gampef7882972017-03-20 16:35:24 -07001641 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001642 }
1643 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00001644 if (opened_dex_files_map.empty()) {
1645 DCHECK(opened_dex_files.empty());
1646 } else {
1647 for (std::unique_ptr<MemMap>& map : opened_dex_files_map) {
1648 opened_dex_files_maps_.push_back(std::move(map));
1649 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001650 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001651 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001652 opened_dex_files_.push_back(std::move(dex_file));
1653 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001654 }
1655 }
1656 }
1657
1658 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
Andreas Gampe7386da42016-06-08 18:18:47 -07001659
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001660 // If we need to downgrade the compiler-filter for size reasons.
1661 if (!IsBootImage() && IsVeryLarge(dex_files_)) {
Mathieu Chartier8cce65a2017-08-17 00:06:39 -07001662 // Disable app image to make sure dex2oat unloading is enabled.
1663 compiler_options_->DisableAppImage();
1664
Mathieu Chartier72041a02017-07-14 18:23:25 -07001665 // If we need to downgrade the compiler-filter for size reasons, do that early before we read
1666 // it below for creating verification callbacks.
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001667 if (!CompilerFilter::IsAsGoodAs(kLargeAppFilter, compiler_options_->GetCompilerFilter())) {
1668 LOG(INFO) << "Very large app, downgrading to verify.";
1669 // Note: this change won't be reflected in the key-value store, as that had to be
1670 // finalized before loading the dex files. This setup is currently required
1671 // to get the size from the DexFile objects.
1672 // TODO: refactor. b/29790079
1673 compiler_options_->SetCompilerFilter(kLargeAppFilter);
1674 }
1675 }
1676
1677 if (CompilerFilter::IsAnyCompilationEnabled(compiler_options_->GetCompilerFilter())) {
1678 // Only modes with compilation require verification results, do this here instead of when we
1679 // create the compilation callbacks since the compilation mode may have been changed by the
1680 // very large app logic.
1681 // Avoiding setting the verification results saves RAM by not adding the dex files later in
1682 // the function.
1683 verification_results_.reset(new VerificationResults(compiler_options_.get()));
1684 callbacks_->SetVerificationResults(verification_results_.get());
1685 }
1686
Andreas Gampe7386da42016-06-08 18:18:47 -07001687 // We had to postpone the swap decision till now, as this is the point when we actually
1688 // know about the dex files we're going to use.
1689
1690 // Make sure that we didn't create the driver, yet.
1691 CHECK(driver_ == nullptr);
1692 // If we use a swap file, ensure we are above the threshold to make it necessary.
1693 if (swap_fd_ != -1) {
1694 if (!UseSwap(IsBootImage(), dex_files_)) {
1695 close(swap_fd_);
1696 swap_fd_ = -1;
1697 VLOG(compiler) << "Decided to run without swap.";
1698 } else {
1699 LOG(INFO) << "Large app, accepted running with swap.";
1700 }
1701 }
1702 // 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 +00001703 if (IsBootImage()) {
1704 // For boot image, pass opened dex files to the Runtime::Create().
1705 // Note: Runtime acquires ownership of these dex files.
1706 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001707 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001708 return dex2oat::ReturnCode::kOther;
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001709 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001710 }
1711
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001712 // If we're doing the image, override the compiler filter to force full compilation. Must be
1713 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1714 // compilation of class initializers.
1715 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001716 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001717 WellKnownClasses::Init(self->GetJniEnv());
1718
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001719 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001720 constexpr bool kSaveDexInput = false;
1721 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001722 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001723 }
1724 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001725
1726 // Ensure opened dex files are writable for dex-to-dex transformations.
1727 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1728 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1729 PLOG(ERROR) << "Failed to make .dex files writeable.";
Andreas Gampef7882972017-03-20 16:35:24 -07001730 return dex2oat::ReturnCode::kOther;
Vladimir Marko919f5532016-01-20 19:13:01 +00001731 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001732 }
1733
Mathieu Chartier72041a02017-07-14 18:23:25 -07001734 // Verification results are only required for modes that have any compilation. Avoid
1735 // adding the dex files if possible to prevent allocating large arrays.
1736 if (verification_results_ != nullptr) {
1737 for (const auto& dex_file : dex_files_) {
1738 // Pre-register dex files so that we can access verification results without locks during
1739 // compilation and verification.
Mathieu Chartier0733dc82017-07-17 14:05:28 -07001740 verification_results_->AddDexFile(dex_file);
1741 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001742 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001743
Andreas Gampef7882972017-03-20 16:35:24 -07001744 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001745 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001746
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001747 // If we need to keep the oat file open for the image writer.
1748 bool ShouldKeepOatFileOpen() const {
1749 return IsImage() && oat_fd_ != kInvalidFd;
1750 }
1751
Mathieu Chartier72041a02017-07-14 18:23:25 -07001752 // Doesn't return the class loader since it's not meant to be used for image compilation.
1753 void CompileDexFilesIndividually() {
1754 CHECK(!IsImage()) << "Not supported with image";
1755 for (const DexFile* dex_file : dex_files_) {
1756 std::vector<const DexFile*> dex_files(1u, dex_file);
1757 VLOG(compiler) << "Compiling " << dex_file->GetLocation();
1758 jobject class_loader = CompileDexFiles(dex_files);
1759 CHECK(class_loader != nullptr);
1760 ScopedObjectAccess soa(Thread::Current());
1761 // Unload class loader to free RAM.
Ian Rogers55256cb2017-12-21 17:07:11 -08001762 jweak weak_class_loader = soa.Env()->GetVm()->AddWeakGlobalRef(
Mathieu Chartier72041a02017-07-14 18:23:25 -07001763 soa.Self(),
1764 soa.Decode<mirror::ClassLoader>(class_loader));
Ian Rogers55256cb2017-12-21 17:07:11 -08001765 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), class_loader);
Roland Levillainaf290312018-02-27 20:02:17 +00001766 runtime_->GetHeap()->CollectGarbage(/* clear_soft_references */ true);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001767 ObjPtr<mirror::ClassLoader> decoded_weak = soa.Decode<mirror::ClassLoader>(weak_class_loader);
1768 if (decoded_weak != nullptr) {
1769 LOG(FATAL) << "Failed to unload class loader, path from root set: "
1770 << runtime_->GetHeap()->GetVerification()->FirstPathFromRootSet(decoded_weak);
1771 }
1772 VLOG(compiler) << "Unloaded classloader";
1773 }
1774 }
1775
1776 bool ShouldCompileDexFilesIndividually() const {
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001777 // Compile individually if we are:
1778 // 1. not building an image,
1779 // 2. not verifying a vdex file,
1780 // 3. using multidex,
1781 // 4. not doing any AOT compilation.
1782 // This means extract, no-vdex verify, and quicken, will use the individual compilation
1783 // mode (to reduce RAM used by the compiler).
Mathieu Chartier72041a02017-07-14 18:23:25 -07001784 return !IsImage() &&
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001785 !update_input_vdex_ &&
Mathieu Chartier72041a02017-07-14 18:23:25 -07001786 dex_files_.size() > 1 &&
Mathieu Chartier6a2b67b2017-08-08 15:09:29 -07001787 !CompilerFilter::IsAotCompilationEnabled(compiler_options_->GetCompilerFilter());
Mathieu Chartier72041a02017-07-14 18:23:25 -07001788 }
1789
1790 // Set up and create the compiler driver and then invoke it to compile all the dex files.
1791 jobject Compile() {
1792 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1793
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001794 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001795
Vladimir Marko47496c22016-01-27 16:15:08 +00001796 // Find the dex files we should not inline from.
Vladimir Marko47496c22016-01-27 16:15:08 +00001797 std::vector<std::string> no_inline_filters;
1798 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001799
1800 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001801 const std::string core_oj = "core-oj";
1802 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1803 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001804 }
1805
Vladimir Marko47496c22016-01-27 16:15:08 +00001806 if (!no_inline_filters.empty()) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001807 std::vector<const DexFile*> class_path_files;
1808 if (!IsBootImage()) {
1809 // The class loader context is used only for apps.
1810 class_path_files = class_loader_context_->FlattenOpenedDexFiles();
1811 }
1812
Jeff Haodcdc85b2015-12-04 14:06:18 -08001813 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1814 &class_linker->GetBootClassPath(),
1815 &class_path_files,
1816 &dex_files_
1817 };
1818 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001819 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001820 for (const std::string& filter : no_inline_filters) {
1821 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
Calin Juravlea308a322017-07-18 16:51:51 -07001822 // allows tests to specify <test-dexfile>!classes2.dex if needed but if the
Vladimir Marko47496c22016-01-27 16:15:08 +00001823 // base location passes the StartsWith() test, so do all extra locations.
1824 std::string dex_location = dex_file->GetLocation();
1825 if (filter.find('/') == std::string::npos) {
1826 // The filter does not contain the path. Remove the path from dex_location as well.
1827 size_t last_slash = dex_file->GetLocation().rfind('/');
1828 if (last_slash != std::string::npos) {
1829 dex_location = dex_location.substr(last_slash + 1);
1830 }
1831 }
1832
Andreas Gampe9186ced2016-12-12 14:28:21 -08001833 if (android::base::StartsWith(dex_location, filter.c_str())) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001834 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1835 no_inline_from_dex_files_.push_back(dex_file);
1836 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001837 }
1838 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001839 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001840 }
1841 if (!no_inline_from_dex_files_.empty()) {
1842 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001843 }
1844 }
1845
Vladimir Marko307dac92015-10-20 11:20:09 +01001846 driver_.reset(new CompilerDriver(compiler_options_.get(),
1847 verification_results_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001848 compiler_kind_,
1849 instruction_set_,
1850 instruction_set_features_.get(),
Vladimir Marko54159c62018-06-20 14:30:08 +01001851 std::move(image_classes_),
Vladimir Marko307dac92015-10-20 11:20:09 +01001852 thread_count_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001853 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001854 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001855 driver_->SetDexFilesForOatFile(dex_files_);
Nicolas Geoffray486dda02017-09-11 14:15:52 +01001856 if (!IsBootImage()) {
1857 driver_->SetClasspathDexFiles(class_loader_context_->FlattenOpenedDexFiles());
1858 }
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001859
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001860 const bool compile_individually = ShouldCompileDexFilesIndividually();
1861 if (compile_individually) {
1862 // Set the compiler driver in the callbacks so that we can avoid re-verification. This not
1863 // only helps performance but also prevents reverifying quickened bytecodes. Attempting
1864 // verify quickened bytecode causes verification failures.
1865 // Only set the compiler filter if we are doing separate compilation since there is a bit
1866 // of overhead when checking if a class was previously verified.
1867 callbacks_->SetDoesClassUnloading(true, driver_.get());
1868 }
1869
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001870 // Setup vdex for compilation.
1871 if (!DoEagerUnquickeningOfVdex() && input_vdex_file_ != nullptr) {
1872 callbacks_->SetVerifierDeps(
1873 new verifier::VerifierDeps(dex_files_, input_vdex_file_->GetVerifierDepsData()));
1874
1875 // TODO: we unquicken unconditionally, as we don't know
1876 // if the boot image has changed. How exactly we'll know is under
1877 // experimentation.
1878 TimingLogger::ScopedTiming time_unquicken("Unquicken", timings_);
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +03001879
1880 // We do not decompile a RETURN_VOID_NO_BARRIER into a RETURN_VOID, as the quickening
1881 // optimization does not depend on the boot image (the optimization relies on not
1882 // having final fields in a class, which does not change for an app).
Mathieu Chartier210531f2018-01-12 10:15:51 -08001883 input_vdex_file_->Unquicken(dex_files_, /* decompile_return_instruction */ false);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001884 } else {
1885 // Create the main VerifierDeps, here instead of in the compiler since we want to aggregate
1886 // the results for all the dex files, not just the results for the current dex file.
1887 callbacks_->SetVerifierDeps(new verifier::VerifierDeps(dex_files_));
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001888 }
Mathieu Chartier72041a02017-07-14 18:23:25 -07001889 // Invoke the compilation.
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001890 if (compile_individually) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001891 CompileDexFilesIndividually();
1892 // Return a null classloader since we already freed released it.
1893 return nullptr;
1894 }
1895 return CompileDexFiles(dex_files_);
1896 }
1897
1898 // Create the class loader, use it to compile, and return.
1899 jobject CompileDexFiles(const std::vector<const DexFile*>& dex_files) {
1900 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1901
1902 jobject class_loader = nullptr;
1903 if (!IsBootImage()) {
1904 class_loader = class_loader_context_->CreateClassLoader(dex_files_);
Andreas Gampee9934582018-01-19 21:23:04 -08001905 callbacks_->SetDexFiles(&dex_files);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001906 }
1907
1908 // Register dex caches and key them to the class loader so that they only unload when the
1909 // class loader unloads.
1910 for (const auto& dex_file : dex_files) {
1911 ScopedObjectAccess soa(Thread::Current());
1912 // Registering the dex cache adds a strong root in the class loader that prevents the dex
1913 // cache from being unloaded early.
1914 ObjPtr<mirror::DexCache> dex_cache = class_linker->RegisterDexFile(
1915 *dex_file,
1916 soa.Decode<mirror::ClassLoader>(class_loader));
1917 if (dex_cache == nullptr) {
1918 soa.Self()->AssertPendingException();
1919 LOG(FATAL) << "Failed to register dex file " << dex_file->GetLocation() << " "
1920 << soa.Self()->GetException()->Dump();
1921 }
1922 }
1923 driver_->CompileAll(class_loader, dex_files, timings_);
1924 return class_loader;
Vladimir Markof4da6752014-08-01 19:04:18 +01001925 }
1926
Jeff Hao436183f2016-01-12 16:36:50 -08001927 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001928 // ensure the references between the two are correct.
1929 //
1930 // Currently we have a memory layout that looks something like this:
1931 //
1932 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001933 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001934 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001935 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001936 // +--------------+
1937 // | alloc spaces |
1938 // +--------------+
1939 //
Jeff Hao436183f2016-01-12 16:36:50 -08001940 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001941 //
Jeff Hao436183f2016-01-12 16:36:50 -08001942 // 1. The images are expected to be loaded at an absolute address and
1943 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001944 //
Jeff Hao436183f2016-01-12 16:36:50 -08001945 // 2. There are absolute pointers from Methods in the images to their
1946 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001947 //
Jeff Hao436183f2016-01-12 16:36:50 -08001948 // 3. There are absolute pointers from the code in the oat files to Methods
1949 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001950 //
Jeff Hao436183f2016-01-12 16:36:50 -08001951 // 4. There are absolute pointers from code in the oat files to other code
1952 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001953 //
1954 // To get this all correct, we go through several steps.
1955 //
Jeff Hao436183f2016-01-12 16:36:50 -08001956 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001957 // the oat data size and code size. During this stage, we also set
1958 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001959 //
Jeff Hao436183f2016-01-12 16:36:50 -08001960 // 2. We prepare offsets for the objects in the images and calculate
1961 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001962 //
Jeff Hao436183f2016-01-12 16:36:50 -08001963 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001964 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001965 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001966 // can prepare the ELF headers and we then know the ELF memory segment
1967 // layout and we can now resolve all references. The compiler provides
1968 // LinkerPatch information in each CompiledMethod and we resolve these,
1969 // using the layout information and image object locations provided by
1970 // image writer, as we're writing the method code.
1971 //
Jeff Hao436183f2016-01-12 16:36:50 -08001972 // 4. We create the image files. They need to know where the oat files
1973 // will be loaded after itself. Originally oat files were simply
1974 // memory mapped so we could predict where their contents were based
1975 // on the file size. Now that they are ELF files, we need to inspect
1976 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001977 // where the oat header is located within.
1978 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001979 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001980 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001981 // load the .so at the desired location at runtime by offsetting the
1982 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001983 // TODO: Do this in step 3. We already know the layout there.
1984 //
1985 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1986 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001987
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001988 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1989 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001990 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1991 // case (when the file will be explicitly erased).
David Brazdil7b49e6c2016-09-01 11:06:18 +01001992 bool WriteOutputFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001993 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1994
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001995 // Sync the data to the file, in case we did dex2dex transformations.
1996 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1997 if (!map->Sync()) {
1998 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1999 return false;
2000 }
2001 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002002
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002003 if (IsImage()) {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002004 if (IsAppImage() && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002005 gc::Heap* const heap = Runtime::Current()->GetHeap();
2006 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002007 image_base_ = std::max(image_base_, RoundUp(
2008 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
2009 kPageSize));
2010 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002011 // The non moving space is right after the oat file. Put the preferred app image location
2012 // right after the non moving space so that we ideally get a continuous immune region for
2013 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002014 // Use the default non moving space capacity since dex2oat does not have a separate non-
2015 // moving space. This means the runtime's non moving space space size will be as large
2016 // as the growth limit for dex2oat, but smaller in the zygote.
2017 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002018 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002019 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
2020 }
2021
Vladimir Marko74527972016-11-29 15:57:32 +00002022 image_writer_.reset(new linker::ImageWriter(*driver_,
2023 image_base_,
2024 compiler_options_->GetCompilePic(),
2025 IsAppImage(),
2026 image_storage_mode_,
2027 oat_filenames_,
2028 dex_file_oat_index_map_,
2029 dirty_image_objects_.get()));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002030
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002031 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002032 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
Mathieu Chartier703b82a2018-04-10 15:52:32 -07002033 if (!image_writer_->PrepareImageAddressSpace(timings_)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002034 LOG(ERROR) << "Failed to prepare image address space.";
2035 return false;
2036 }
2037 }
2038
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002039 // Initialize the writers with the compiler driver, image writer, and their
2040 // dex files. The writers were created without those being there yet.
2041 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00002042 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002043 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
2044 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
2045 }
2046
David Brazdil5d5a36b2016-09-14 15:34:10 +01002047 {
2048 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
2049 DCHECK(IsBootImage() || oat_files_.size() == 1u);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00002050 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
David Brazdil5d5a36b2016-09-14 15:34:10 +01002051 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
2052 File* vdex_file = vdex_files_[i].get();
Vladimir Marko74527972016-11-29 15:57:32 +00002053 std::unique_ptr<linker::BufferedOutputStream> vdex_out =
2054 std::make_unique<linker::BufferedOutputStream>(
2055 std::make_unique<linker::FileOutputStream>(vdex_file));
David Brazdil5d5a36b2016-09-14 15:34:10 +01002056
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00002057 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002058 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
2059 return false;
2060 }
2061
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002062 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
2063 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
2064 return false;
2065 }
2066
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +00002067 // VDEX finalized, seek back to the beginning and write checksums and the header.
2068 if (!oat_writers_[i]->WriteChecksumsAndVdexHeader(vdex_out.get())) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002069 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
2070 return false;
2071 }
2072 }
2073 }
2074
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002075 {
2076 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Vladimir Markoca1e0382018-04-11 09:58:41 +00002077 linker::MultiOatRelativePatcher patcher(instruction_set_,
2078 instruction_set_features_.get(),
2079 driver_->GetCompiledMethodStorage());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002080 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00002081 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2082 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko944da602016-02-19 12:27:55 +00002083
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002084 oat_writer->PrepareLayout(&patcher);
Vladimir Markob066d432018-01-03 13:14:37 +00002085 elf_writer->PrepareDynamicSection(oat_writer->GetOatHeader().GetExecutableOffset(),
2086 oat_writer->GetCodeSize(),
2087 oat_writer->GetDataBimgRelRoSize(),
Vladimir Markoaad75c62016-10-03 08:46:48 +00002088 oat_writer->GetBssSize(),
Vladimir Marko0eb882b2017-05-15 13:39:18 +01002089 oat_writer->GetBssMethodsOffset(),
David Srbeckyec2cdf42017-12-08 16:21:25 +00002090 oat_writer->GetBssRootsOffset(),
2091 oat_writer->GetVdexSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002092 if (IsImage()) {
2093 // Update oat layout.
2094 DCHECK(image_writer_ != nullptr);
2095 DCHECK_LT(i, oat_filenames_.size());
2096 image_writer_->UpdateOatFileLayout(i,
2097 elf_writer->GetLoadedSize(),
2098 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01002099 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002100 }
Richard Uhlerbc26b722017-03-10 14:27:10 +00002101
2102 if (IsBootImage()) {
2103 // Have the image_file_location_oat_checksum_ for boot oat files
2104 // depend on the contents of all the boot oat files. This way only
2105 // the primary image checksum needs to be checked to determine
2106 // whether any of the images are out of date.
2107 image_file_location_oat_checksum_ ^= oat_writer->GetOatHeader().GetChecksum();
2108 }
Vladimir Marko944da602016-02-19 12:27:55 +00002109 }
2110
2111 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002112 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko74527972016-11-29 15:57:32 +00002113 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2114 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00002115
David Srbecky0c4572e2016-01-22 19:19:25 +00002116 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00002117 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
David Srbecky32210b92017-12-04 14:39:21 +00002118 debug::DebugInfo debug_info = oat_writer->GetDebugInfo(); // Keep the variable alive.
2119 elf_writer->PrepareDebugInfo(debug_info); // Processes the data on background thread.
David Srbecky0c4572e2016-01-22 19:19:25 +00002120
Vladimir Marko74527972016-11-29 15:57:32 +00002121 linker::OutputStream*& rodata = rodata_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002122 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002123 if (!oat_writer->WriteRodata(rodata)) {
2124 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
2125 return false;
2126 }
2127 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002128 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00002129
Vladimir Marko74527972016-11-29 15:57:32 +00002130 linker::OutputStream* text = elf_writer->StartText();
Jeff Haodcdc85b2015-12-04 14:06:18 -08002131 if (!oat_writer->WriteCode(text)) {
2132 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
2133 return false;
2134 }
2135 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00002136
Vladimir Markob066d432018-01-03 13:14:37 +00002137 if (oat_writer->GetDataBimgRelRoSize() != 0u) {
2138 linker::OutputStream* data_bimg_rel_ro = elf_writer->StartDataBimgRelRo();
2139 if (!oat_writer->WriteDataBimgRelRo(data_bimg_rel_ro)) {
2140 LOG(ERROR) << "Failed to write .data.bimg.rel.ro section to the ELF file "
2141 << oat_file->GetPath();
2142 return false;
2143 }
2144 elf_writer->EndDataBimgRelRo(data_bimg_rel_ro);
2145 }
2146
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002147 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
2148 image_file_location_oat_checksum_,
2149 image_file_location_oat_data_begin_,
2150 image_patch_delta_)) {
2151 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
2152 return false;
2153 }
2154
Vladimir Marko944da602016-02-19 12:27:55 +00002155 if (IsImage()) {
2156 // Update oat header information.
2157 DCHECK(image_writer_ != nullptr);
2158 DCHECK_LT(i, oat_filenames_.size());
2159 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
2160 }
2161
Jeff Haodcdc85b2015-12-04 14:06:18 -08002162 elf_writer->WriteDynamicSection();
David Srbecky32210b92017-12-04 14:39:21 +00002163 elf_writer->WriteDebugInfo(oat_writer->GetDebugInfo());
Vladimir Marko10c13562015-11-25 14:33:36 +00002164
Jeff Haodcdc85b2015-12-04 14:06:18 -08002165 if (!elf_writer->End()) {
2166 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
2167 return false;
2168 }
2169
David Brazdil7b49e6c2016-09-01 11:06:18 +01002170 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
2171 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002172 }
2173
Jeff Haodcdc85b2015-12-04 14:06:18 -08002174 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002175
2176 oat_writer.reset();
2177 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002178 }
2179 }
2180
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002181 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002182 }
2183
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002184 // If we are compiling an image, invoke the image creation routine. Else just skip.
2185 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002186 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002187 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
2188 if (!CreateImageFile()) {
2189 return false;
2190 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002191 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07002192 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002193 return true;
2194 }
2195
Jeff Haodcdc85b2015-12-04 14:06:18 -08002196 // Create a copy from stripped to unstripped.
2197 bool CopyStrippedToUnstripped() {
2198 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
2199 // If we don't want to strip in place, copy from stripped location to unstripped location.
2200 // We need to strip after image creation because FixupElf needs to use .strtab.
2201 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
2202 // If the oat file is still open, flush it.
2203 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002204 if (!FlushCloseOutputFile(&oat_files_[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002205 return false;
2206 }
2207 }
2208
2209 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
2210 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
2211 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01002212 int64_t in_length = in->GetLength();
2213 if (in_length < 0) {
2214 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
2215 return false;
2216 }
2217 if (!out->Copy(in.get(), 0, in_length)) {
2218 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
2219 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002220 }
2221 if (out->FlushCloseOrErase() != 0) {
2222 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
2223 return false;
2224 }
2225 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
2226 }
2227 }
2228 return true;
2229 }
2230
David Brazdil7b49e6c2016-09-01 11:06:18 +01002231 bool FlushOutputFile(std::unique_ptr<File>* file) {
2232 if (file->get() != nullptr) {
2233 if (file->get()->Flush() != 0) {
2234 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
2235 return false;
2236 }
2237 }
2238 return true;
2239 }
2240
2241 bool FlushCloseOutputFile(std::unique_ptr<File>* file) {
2242 if (file->get() != nullptr) {
2243 std::unique_ptr<File> tmp(file->release());
2244 if (tmp->FlushCloseOrErase() != 0) {
2245 PLOG(ERROR) << "Failed to flush and close output file: " << tmp->GetPath();
2246 return false;
2247 }
2248 }
2249 return true;
2250 }
2251
2252 bool FlushOutputFiles() {
2253 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
2254 for (auto& files : { &vdex_files_, &oat_files_ }) {
2255 for (size_t i = 0; i < files->size(); ++i) {
2256 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002257 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08002258 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002259 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00002260 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002261 return true;
2262 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002263
David Brazdil7b49e6c2016-09-01 11:06:18 +01002264 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002265 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002266 for (auto& files : { &vdex_files_, &oat_files_ }) {
2267 for (size_t i = 0; i < files->size(); ++i) {
2268 result &= FlushCloseOutputFile(&(*files)[i]);
2269 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002270 }
2271 return result;
2272 }
2273
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002274 void DumpTiming() {
Nicolas Geoffray2d8801f2017-11-28 15:50:07 +00002275 if (compiler_options_->GetDumpTimings() ||
2276 (kIsDebugBuild && timings_->GetTotalNs() > MsToNs(1000))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002277 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2278 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002279 }
2280
Andreas Gampe10e477d2014-11-19 12:57:42 -08002281 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002282 return IsAppImage() || IsBootImage();
2283 }
2284
2285 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002286 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002287 }
2288
2289 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002290 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002291 }
2292
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002293 bool IsHost() const {
2294 return is_host_;
2295 }
2296
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002297 bool UseProfile() const {
Mathieu Chartierd0af56c2017-02-17 12:56:25 -08002298 return profile_file_fd_ != -1 || !profile_file_.empty();
Calin Juravle998c2162015-12-21 15:39:33 +02002299 }
2300
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002301 bool DoProfileGuidedOptimizations() const {
Nicolas Geoffray49cda062017-04-21 13:08:25 +01002302 return UseProfile();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002303 }
2304
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002305 bool DoGenerateCompactDex() const {
2306 return compact_dex_level_ != CompactDexLevel::kCompactDexLevelNone;
2307 }
2308
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002309 bool DoDexLayoutOptimizations() const {
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002310 return DoProfileGuidedOptimizations() || DoGenerateCompactDex();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002311 }
2312
Igor Murashkin545412b2017-08-17 15:26:54 -07002313 bool DoOatLayoutOptimizations() const {
2314 return DoProfileGuidedOptimizations();
2315 }
2316
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002317 bool MayInvalidateVdexMetadata() const {
2318 // DexLayout can invalidate the vdex metadata if changing the class def order is enabled, so
2319 // we need to unquicken the vdex file eagerly, before passing it to dexlayout.
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01002320 return DoDexLayoutOptimizations();
2321 }
2322
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002323 bool DoEagerUnquickeningOfVdex() const {
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00002324 return MayInvalidateVdexMetadata() && dm_file_ == nullptr;
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002325 }
2326
Calin Juravle2e2db782016-02-23 12:00:03 +00002327 bool LoadProfile() {
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002328 DCHECK(UseProfile());
Calin Juravlee6f87cc2017-05-24 17:41:05 -07002329 // TODO(calin): We should be using the runtime arena pool (instead of the
2330 // default profile arena). However the setup logic is messy and needs
2331 // cleaning up before that (e.g. the oat writers are created before the
2332 // runtime).
Calin Juravle2e2db782016-02-23 12:00:03 +00002333 profile_compilation_info_.reset(new ProfileCompilationInfo());
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002334 ScopedFlock profile_file;
Calin Juravle2e2db782016-02-23 12:00:03 +00002335 std::string error;
2336 if (profile_file_fd_ != -1) {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002337 profile_file = LockedFile::DupOf(profile_file_fd_, "profile",
2338 true /* read_only_mode */, &error);
Andreas Gampe29d38e72016-03-23 15:31:51 +00002339 } else if (profile_file_ != "") {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002340 profile_file = LockedFile::Open(profile_file_.c_str(), O_RDONLY, true, &error);
Calin Juravle998c2162015-12-21 15:39:33 +02002341 }
Calin Juravle877fd962016-01-05 14:29:29 +00002342
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002343 // Return early if we're unable to obtain a lock on the profile.
2344 if (profile_file.get() == nullptr) {
2345 LOG(ERROR) << "Cannot lock profiles: " << error;
2346 return false;
2347 }
2348
2349 if (!profile_compilation_info_->Load(profile_file->Fd())) {
Calin Juravle2e2db782016-02-23 12:00:03 +00002350 profile_compilation_info_.reset(nullptr);
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002351 return false;
Calin Juravle2e2db782016-02-23 12:00:03 +00002352 }
Calin Juravle877fd962016-01-05 14:29:29 +00002353
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002354 return true;
Calin Juravle998c2162015-12-21 15:39:33 +02002355 }
2356
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002357 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002358 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2359 if (is_image) {
2360 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2361 return false;
2362 }
2363 if (dex_files.size() < min_dex_files_for_swap_) {
2364 // If there are less dex files than the threshold, assume it's gonna be fine.
2365 return false;
2366 }
2367 size_t dex_files_size = 0;
2368 for (const auto* dex_file : dex_files) {
2369 dex_files_size += dex_file->GetHeader().file_size_;
2370 }
2371 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2372 }
2373
Andreas Gampe67f02822016-06-24 21:05:23 -07002374 bool IsVeryLarge(std::vector<const DexFile*>& dex_files) {
2375 size_t dex_files_size = 0;
2376 for (const auto* dex_file : dex_files) {
2377 dex_files_size += dex_file->GetHeader().file_size_;
2378 }
2379 return dex_files_size >= very_large_threshold_;
2380 }
2381
Vladimir Marko49b0f452015-12-10 13:49:19 +00002382 bool PrepareImageClasses() {
2383 // If --image-classes was specified, calculate the full list of classes to include in the image.
2384 if (image_classes_filename_ != nullptr) {
2385 image_classes_ =
2386 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2387 if (image_classes_ == nullptr) {
2388 return false;
2389 }
2390 } else if (IsBootImage()) {
Vladimir Marko54159c62018-06-20 14:30:08 +01002391 image_classes_.reset(new HashSet<std::string>);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002392 }
2393 return true;
2394 }
2395
Vladimir Marko54159c62018-06-20 14:30:08 +01002396 static std::unique_ptr<HashSet<std::string>> ReadClasses(const char* zip_filename,
2397 const char* classes_filename,
2398 const char* tag) {
2399 std::unique_ptr<HashSet<std::string>> classes;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002400 std::string error_msg;
2401 if (zip_filename != nullptr) {
Vladimir Marko54159c62018-06-20 14:30:08 +01002402 classes = ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002403 } else {
Vladimir Marko54159c62018-06-20 14:30:08 +01002404 classes = ReadImageClassesFromFile(classes_filename);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002405 }
2406 if (classes == nullptr) {
2407 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2408 << classes_filename << "': " << error_msg;
2409 }
2410 return classes;
2411 }
2412
Jeff Haoc23b0c02017-07-27 18:19:38 -07002413 bool PrepareDirtyObjects() {
2414 if (dirty_image_objects_filename_ != nullptr) {
Vladimir Marko54159c62018-06-20 14:30:08 +01002415 dirty_image_objects_ = ReadCommentedInputFromFile<HashSet<std::string>>(
Jeff Haoc23b0c02017-07-27 18:19:38 -07002416 dirty_image_objects_filename_,
Vladimir Marko54159c62018-06-20 14:30:08 +01002417 nullptr);
Jeff Haoc23b0c02017-07-27 18:19:38 -07002418 if (dirty_image_objects_ == nullptr) {
2419 LOG(ERROR) << "Failed to create list of dirty objects from '"
2420 << dirty_image_objects_filename_ << "'";
2421 return false;
2422 }
2423 } else {
2424 dirty_image_objects_.reset(nullptr);
2425 }
2426 return true;
2427 }
2428
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002429 void PruneNonExistentDexFiles() {
2430 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2431 size_t kept = 0u;
2432 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2433 if (!OS::FileExists(dex_filenames_[i])) {
2434 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2435 } else {
2436 dex_filenames_[kept] = dex_filenames_[i];
2437 dex_locations_[kept] = dex_locations_[i];
2438 ++kept;
2439 }
2440 }
2441 dex_filenames_.resize(kept);
2442 dex_locations_.resize(kept);
2443 }
2444
2445 bool AddDexFileSources() {
2446 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
Nicolas Geoffraybc177272018-01-24 14:55:32 +00002447 if (input_vdex_file_ != nullptr && input_vdex_file_->HasDexSection()) {
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002448 DCHECK_EQ(oat_writers_.size(), 1u);
2449 const std::string& name = zip_location_.empty() ? dex_locations_[0] : zip_location_;
2450 DCHECK(!name.empty());
2451 if (!oat_writers_[0]->AddVdexDexFilesSource(*input_vdex_file_.get(), name.c_str())) {
2452 return false;
2453 }
2454 } else if (zip_fd_ != -1) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002455 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002456 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2457 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002458 return false;
2459 }
2460 } else if (oat_writers_.size() > 1u) {
2461 // Multi-image.
2462 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2463 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2464 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2465 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2466 return false;
2467 }
2468 }
2469 } else {
2470 DCHECK_EQ(oat_writers_.size(), 1u);
2471 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2472 DCHECK_NE(dex_filenames_.size(), 0u);
2473 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2474 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2475 return false;
2476 }
2477 }
2478 }
2479 return true;
2480 }
2481
2482 void CreateOatWriters() {
2483 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2484 elf_writers_.reserve(oat_files_.size());
2485 oat_writers_.reserve(oat_files_.size());
2486 for (const std::unique_ptr<File>& oat_file : oat_files_) {
Vladimir Marko74527972016-11-29 15:57:32 +00002487 elf_writers_.emplace_back(linker::CreateElfWriterQuick(instruction_set_,
2488 instruction_set_features_.get(),
2489 compiler_options_.get(),
2490 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002491 elf_writers_.back()->Start();
Mathieu Chartier4a265c22018-04-09 14:25:14 -07002492 bool do_oat_writer_layout = DoDexLayoutOptimizations() || DoOatLayoutOptimizations();
2493 if (profile_compilation_info_ != nullptr && profile_compilation_info_->IsEmpty()) {
2494 do_oat_writer_layout = false;
2495 }
Vladimir Marko74527972016-11-29 15:57:32 +00002496 oat_writers_.emplace_back(new linker::OatWriter(
Igor Murashkin545412b2017-08-17 15:26:54 -07002497 IsBootImage(),
2498 timings_,
Mathieu Chartier603ccab2017-10-20 14:34:28 -07002499 do_oat_writer_layout ? profile_compilation_info_.get() : nullptr,
2500 compact_dex_level_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002501 }
2502 }
2503
Vladimir Marko49b0f452015-12-10 13:49:19 +00002504 void SaveDexInput() {
2505 for (size_t i = 0; i < dex_files_.size(); ++i) {
2506 const DexFile* dex_file = dex_files_[i];
2507 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2508 getpid(), i));
2509 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2510 if (tmp_file.get() == nullptr) {
2511 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2512 << ". Try: adb shell chmod 777 /data/local/tmp";
2513 continue;
2514 }
2515 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2516 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2517 UNUSED(tmp_file->Flush());
2518 UNUSED(tmp_file->Close());
2519 LOG(INFO) << "Wrote input to " << tmp_file_name;
2520 }
2521 }
2522
Mathieu Chartier46331a62017-07-21 09:49:10 -07002523 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options,
2524 QuickCompilerCallbacks* callbacks) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00002525 RuntimeOptions raw_options;
2526 if (boot_image_filename_.empty()) {
2527 std::string boot_class_path = "-Xbootclasspath:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002528 boot_class_path += android::base::Join(dex_filenames_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002529 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2530 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002531 boot_class_path_locations += android::base::Join(dex_locations_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002532 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2533 } else {
2534 std::string boot_image_option = "-Ximage:";
2535 boot_image_option += boot_image_filename_;
2536 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2537 }
2538 for (size_t i = 0; i < runtime_args_.size(); i++) {
2539 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2540 }
2541
Mathieu Chartier46331a62017-07-21 09:49:10 -07002542 raw_options.push_back(std::make_pair("compilercallbacks", callbacks));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002543 raw_options.push_back(
2544 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2545
2546 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2547 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2548 // have been stripped in preopting, anyways).
2549 if (!IsBootImage()) {
2550 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2551 }
Andreas Gampec8e35202017-04-28 15:47:12 -07002552 // Never allow implicit image compilation.
2553 raw_options.push_back(std::make_pair("-Xnoimage-dex2oat", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002554 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2555 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2556 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002557 // Disable Hspace compaction to save heap size virtual space.
2558 // Only need disable Hspace for OOM becasue background collector is equal to
2559 // foreground collector by default for dex2oat.
2560 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002561
Andreas Gampeace0dc12016-01-20 13:33:13 -08002562 if (compiler_options_->IsForceDeterminism()) {
Roland Levillainb81e9e92017-04-20 17:35:32 +01002563 // If we're asked to be deterministic, ensure non-concurrent GC for determinism.
2564 //
2565 // Note that with read barriers, this option is ignored, because Runtime::Init
2566 // overrides the foreground GC to be gc::kCollectorTypeCC when instantiating
2567 // gc::Heap. This is fine, as concurrent GC requests are not honored in dex2oat,
2568 // which uses an unstarted runtime.
Andreas Gampeace0dc12016-01-20 13:33:13 -08002569 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
Roland Levillainb81e9e92017-04-20 17:35:32 +01002570
Nicolas Geoffray7acddd82017-05-03 15:04:55 +01002571 // The default LOS implementation (map) is not deterministic. So disable it.
2572 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=disabled", nullptr));
Andreas Gampeace0dc12016-01-20 13:33:13 -08002573
2574 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2575 // compaction (done above) and ensure that neither foreground nor background collectors
2576 // are concurrent.
Roland Levillainb81e9e92017-04-20 17:35:32 +01002577 //
2578 // Likewise, this option is ignored with read barriers because Runtime::Init
2579 // overrides the background GC to be gc::kCollectorTypeCCBackground, but that's
2580 // fine too, for the same reason (see above).
Andreas Gampeace0dc12016-01-20 13:33:13 -08002581 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2582
2583 // To make identity hashcode deterministic, set a known seed.
2584 mirror::Object::SetHashCodeSeed(987654321U);
2585 }
2586
Vladimir Marko49b0f452015-12-10 13:49:19 +00002587 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2588 LOG(ERROR) << "Failed to parse runtime options";
2589 return false;
2590 }
2591 return true;
2592 }
2593
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002594 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002595 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2596 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002597 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002598 LOG(ERROR) << "Failed to create runtime";
2599 return false;
2600 }
Andreas Gampe49c144d2016-11-14 10:11:16 -08002601
2602 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2603 // "ps -a" don't change to non-descript "main."
2604 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2605
Vladimir Marko307dac92015-10-20 11:20:09 +01002606 runtime_.reset(Runtime::Current());
2607 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe8228cdf2017-05-30 15:03:54 -07002608 for (uint32_t i = 0; i < static_cast<uint32_t>(CalleeSaveType::kLastCalleeSaveType); ++i) {
2609 CalleeSaveType type = CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002610 if (!runtime_->HasCalleeSaveMethod(type)) {
2611 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002612 }
2613 }
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002614
2615 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2616 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002617 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002618
Vladimir Marko307dac92015-10-20 11:20:09 +01002619 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002620
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002621 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2622 // Runtime::Start, give it away now so that we don't starve GC.
2623 Thread* self = Thread::Current();
2624 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002625
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002626 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002627 }
2628
Jeff Haodcdc85b2015-12-04 14:06:18 -08002629 // 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 -08002630 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002631 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002632 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002633 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002634 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002635 image_filenames_.push_back(app_image_file_name_.c_str());
2636 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002637 if (!image_writer_->Write(app_image_fd_,
2638 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002639 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002640 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002641 return false;
2642 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002643
Jeff Haodcdc85b2015-12-04 14:06:18 -08002644 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002645 dchecked_vector<uintptr_t> oat_data_begins;
2646 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2647 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002648 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002649 // Destroy ImageWriter before doing FixupElf.
2650 image_writer_.reset();
2651
Vladimir Marko944da602016-02-19 12:27:55 +00002652 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2653 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002654 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2655 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2656 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2657 if (oat_file.get() == nullptr) {
2658 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2659 return false;
2660 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002661
Vladimir Marko74527972016-11-29 15:57:32 +00002662 if (!linker::ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002663 oat_file->Erase();
2664 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2665 return false;
2666 }
2667
2668 if (oat_file->FlushCloseOrErase()) {
2669 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2670 return false;
2671 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002672 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002673 }
2674
2675 return true;
2676 }
2677
2678 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Vladimir Marko54159c62018-06-20 14:30:08 +01002679 static std::unique_ptr<HashSet<std::string>> ReadImageClassesFromFile(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002680 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002681 std::function<std::string(const char*)> process = DotToDescriptor;
Vladimir Marko54159c62018-06-20 14:30:08 +01002682 return ReadCommentedInputFromFile<HashSet<std::string>>(image_classes_filename, &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002683 }
2684
2685 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Vladimir Marko54159c62018-06-20 14:30:08 +01002686 static std::unique_ptr<HashSet<std::string>> ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002687 const char* zip_filename,
2688 const char* image_classes_filename,
2689 std::string* error_msg) {
2690 std::function<std::string(const char*)> process = DotToDescriptor;
Vladimir Marko54159c62018-06-20 14:30:08 +01002691 return ReadCommentedInputFromZip<HashSet<std::string>>(zip_filename,
2692 image_classes_filename,
2693 &process,
2694 error_msg);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002695 }
2696
2697 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2698 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002699 template <typename T>
Vladimir Marko54159c62018-06-20 14:30:08 +01002700 static std::unique_ptr<T> ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002701 const char* input_filename, std::function<std::string(const char*)>* process) {
2702 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2703 if (input_file.get() == nullptr) {
2704 LOG(ERROR) << "Failed to open input file " << input_filename;
2705 return nullptr;
2706 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002707 std::unique_ptr<T> result(
2708 ReadCommentedInputStream<T>(*input_file, process));
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002709 input_file->close();
Vladimir Marko54159c62018-06-20 14:30:08 +01002710 return result;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002711 }
2712
2713 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2714 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002715 template <typename T>
Vladimir Marko54159c62018-06-20 14:30:08 +01002716 static std::unique_ptr<T> ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002717 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002718 const char* input_filename,
2719 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002720 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002721 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2722 if (zip_archive.get() == nullptr) {
2723 return nullptr;
2724 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002725 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002726 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002727 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002728 zip_filename, error_msg->c_str());
2729 return nullptr;
2730 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002731 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2732 input_filename,
2733 error_msg));
2734 if (input_file.get() == nullptr) {
2735 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002736 zip_filename, error_msg->c_str());
2737 return nullptr;
2738 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002739 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2740 input_file->Size());
2741 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002742 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002743 }
2744
2745 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2746 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002747 template <typename T>
Vladimir Marko54159c62018-06-20 14:30:08 +01002748 static std::unique_ptr<T> ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002749 std::istream& in_stream,
2750 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002751 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002752 while (in_stream.good()) {
2753 std::string dot;
2754 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08002755 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002756 continue;
2757 }
2758 if (process != nullptr) {
2759 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002760 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002761 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002762 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002763 }
2764 }
Vladimir Marko54159c62018-06-20 14:30:08 +01002765 return output;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002766 }
2767
Mathieu Chartier49285c52014-12-02 15:43:48 -08002768 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002769 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2770 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002771 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampec560fc02014-07-16 09:57:39 -07002772 LOG(INFO) << "dex2oat took "
2773 << PrettyDuration(NanoTime() - start_ns_)
Andreas Gampecc967752016-12-12 13:49:00 -08002774 << " (" << PrettyDuration(ProcessCpuNanoTime() - start_cputime_ns_) << " cpu)"
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002775 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002776 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002777 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2778 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002779 }
2780
Jeff Haodcdc85b2015-12-04 14:06:18 -08002781 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2782 std::string res(image_filename);
2783 size_t last_slash = res.rfind('/');
2784 if (last_slash == std::string::npos || last_slash == 0) {
2785 return res;
2786 }
2787 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2788 if (penultimate_slash == std::string::npos) {
2789 return res;
2790 }
2791 // Check that the string in-between is the expected one.
2792 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2793 GetInstructionSetString(isa)) {
2794 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2795 return res;
2796 }
2797 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2798 }
2799
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002800 std::unique_ptr<CompilerOptions> compiler_options_;
2801 Compiler::Kind compiler_kind_;
2802
2803 InstructionSet instruction_set_;
2804 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2805
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002806 uint32_t image_file_location_oat_checksum_;
2807 uintptr_t image_file_location_oat_data_begin_;
2808 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002809 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2810
Vladimir Marko307dac92015-10-20 11:20:09 +01002811 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002812
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002813 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2814
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002815 std::unique_ptr<Runtime> runtime_;
2816
Calin Juravle1ce70852017-06-28 10:59:03 -07002817 // The spec describing how the class loader should be setup for compilation.
2818 std::unique_ptr<ClassLoaderContext> class_loader_context_;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002819
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07002820 // The class loader context stored in the oat file. May be equal to class_loader_context_.
Mathieu Chartierc4440772018-04-16 14:40:56 -07002821 std::unique_ptr<ClassLoaderContext> stored_class_loader_context_;
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07002822
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002823 size_t thread_count_;
2824 uint64_t start_ns_;
Andreas Gampec560fc02014-07-16 09:57:39 -07002825 uint64_t start_cputime_ns_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002826 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002827 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002828 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002829 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002830 std::vector<const char*> oat_filenames_;
2831 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002832 int oat_fd_;
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00002833 int input_vdex_fd_;
2834 int output_vdex_fd_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002835 std::string input_vdex_;
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01002836 std::string output_vdex_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002837 std::unique_ptr<VdexFile> input_vdex_file_;
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00002838 int dm_fd_;
2839 std::string dm_file_location_;
2840 std::unique_ptr<ZipArchive> dm_file_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002841 std::vector<const char*> dex_filenames_;
2842 std::vector<const char*> dex_locations_;
2843 int zip_fd_;
2844 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002845 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002846 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002847 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002848 uintptr_t image_base_;
2849 const char* image_classes_zip_filename_;
2850 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002851 ImageHeader::StorageMode image_storage_mode_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002852 const char* passes_to_run_filename_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002853 const char* dirty_image_objects_filename_;
Vladimir Marko54159c62018-06-20 14:30:08 +01002854 std::unique_ptr<HashSet<std::string>> image_classes_;
2855 std::unique_ptr<HashSet<std::string>> dirty_image_objects_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002856 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Jeff Hao436183f2016-01-12 16:36:50 -08002857 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002858 bool is_host_;
2859 std::string android_root_;
Mathieu Chartier0b490842016-05-25 15:05:59 -07002860 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002861 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002862 std::string no_inline_from_string_;
Mathieu Chartiera7f6b812017-12-11 13:34:29 -08002863 CompactDexLevel compact_dex_level_ = kDefaultCompactDexLevel;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002864
Vladimir Marko74527972016-11-29 15:57:32 +00002865 std::vector<std::unique_ptr<linker::ElfWriter>> elf_writers_;
2866 std::vector<std::unique_ptr<linker::OatWriter>> oat_writers_;
2867 std::vector<linker::OutputStream*> rodata_;
2868 std::vector<std::unique_ptr<linker::OutputStream>> vdex_out_;
2869 std::unique_ptr<linker::ImageWriter> image_writer_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002870 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002871
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002872 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
2873 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2874
Calin Juravle1ce70852017-06-28 10:59:03 -07002875 // Note that this might contain pointers owned by class_loader_context_.
Vladimir Marko47496c22016-01-27 16:15:08 +00002876 std::vector<const DexFile*> no_inline_from_dex_files_;
2877
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07002878 bool avoid_storing_invocation_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002879 std::string swap_file_name_;
2880 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002881 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2882 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002883 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002884 std::string app_image_file_name_;
2885 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002886 std::string profile_file_;
2887 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002888 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002889 TimingLogger* timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002890 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002891 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002892
2893 // Backing storage.
Andreas Gampe097f34c2017-08-23 08:57:51 -07002894 std::forward_list<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002895
Andreas Gampeace0dc12016-01-20 13:33:13 -08002896 // See CompilerOptions.force_determinism_.
2897 bool force_determinism_;
2898
Jeff Hao16d48432017-04-05 17:05:46 -07002899 // Directory of relative classpaths.
2900 std::string classpath_dir_;
2901
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00002902 // Whether the given input vdex is also the output.
2903 bool update_input_vdex_ = false;
2904
Nicolas Geoffray66ff8a82018-02-28 13:27:55 +00002905 // By default, copy the dex to the vdex file only if dex files are
2906 // compressed in APK.
2907 CopyOption copy_dex_files_ = CopyOption::kOnlyIfCompressed;
Mathieu Chartier792111c2018-02-15 13:02:15 -08002908
Calin Juravle0e09dfc2018-02-12 19:01:09 -08002909 // The reason for invoking the compiler.
2910 std::string compilation_reason_;
2911
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002912 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2913};
2914
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002915static void b13564922() {
2916#if defined(__linux__) && defined(__arm__)
2917 int major, minor;
2918 struct utsname uts;
2919 if (uname(&uts) != -1 &&
2920 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2921 ((major < 3) || ((major == 3) && (minor < 4)))) {
2922 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2923 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2924 int old_personality = personality(0xffffffff);
2925 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2926 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2927 if (new_personality == -1) {
2928 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2929 }
2930 }
2931 }
2932#endif
2933}
2934
Mathieu Chartier72041a02017-07-14 18:23:25 -07002935class ScopedGlobalRef {
2936 public:
2937 explicit ScopedGlobalRef(jobject obj) : obj_(obj) {}
2938 ~ScopedGlobalRef() {
2939 if (obj_ != nullptr) {
2940 ScopedObjectAccess soa(Thread::Current());
Ian Rogers55256cb2017-12-21 17:07:11 -08002941 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), obj_);
Mathieu Chartier72041a02017-07-14 18:23:25 -07002942 }
2943 }
2944
2945 private:
2946 jobject obj_;
2947};
2948
Andreas Gampe7b565912017-03-20 15:48:52 -07002949static dex2oat::ReturnCode CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002950 dex2oat.LoadClassProfileDescriptors();
Mathieu Chartier9e050df2017-08-09 10:05:47 -07002951 // Keep the class loader that was used for compilation live for the rest of the compilation
2952 // process.
Mathieu Chartier72041a02017-07-14 18:23:25 -07002953 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08002954
David Brazdil7b49e6c2016-09-01 11:06:18 +01002955 if (!dex2oat.WriteOutputFiles()) {
2956 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002957 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002958 }
2959
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002960 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2961 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2962 // image writer will require this fd to generate the image.
2963 if (dex2oat.ShouldKeepOatFileOpen()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002964 if (!dex2oat.FlushOutputFiles()) {
2965 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002966 return dex2oat::ReturnCode::kOther;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002967 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01002968 } else if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002969 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002970 }
2971
Jeff Haodcdc85b2015-12-04 14:06:18 -08002972 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002973 if (!dex2oat.HandleImage()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002974 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002975 }
2976
2977 // When given --host, finish early without stripping.
2978 if (dex2oat.IsHost()) {
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002979 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002980 return dex2oat::ReturnCode::kOther;
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002981 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002982 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002983 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002984 }
2985
Jeff Haodcdc85b2015-12-04 14:06:18 -08002986 // Copy stripped to unstripped location, if necessary.
2987 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002988 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002989 }
2990
Jeff Haodcdc85b2015-12-04 14:06:18 -08002991 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002992 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002993 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002994 }
2995
2996 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002997 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002998}
2999
Andreas Gampe7b565912017-03-20 15:48:52 -07003000static dex2oat::ReturnCode CompileApp(Dex2Oat& dex2oat) {
Mathieu Chartier9e050df2017-08-09 10:05:47 -07003001 // Keep the class loader that was used for compilation live for the rest of the compilation
3002 // process.
Mathieu Chartier72041a02017-07-14 18:23:25 -07003003 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08003004
David Brazdil7b49e6c2016-09-01 11:06:18 +01003005 if (!dex2oat.WriteOutputFiles()) {
3006 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07003007 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003008 }
3009
Jeff Haodcdc85b2015-12-04 14:06:18 -08003010 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08003011 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08003012
3013 // When given --host, finish early without stripping.
3014 if (dex2oat.IsHost()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003015 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003016 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003017 }
3018
3019 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003020 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003021 }
3022
Jeff Haodcdc85b2015-12-04 14:06:18 -08003023 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
3024 // stripped versions. If this is given, we expect to be able to open writable files by name.
3025 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003026 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003027 }
3028
Jeff Haodcdc85b2015-12-04 14:06:18 -08003029 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01003030 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003031 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003032 }
3033
3034 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003035 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003036}
3037
Andreas Gampe7b565912017-03-20 15:48:52 -07003038static dex2oat::ReturnCode Dex2oat(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003039 b13564922();
3040
3041 TimingLogger timings("compiler", false, false);
3042
Roland Levillain5c7e2602016-02-23 18:08:53 +00003043 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
3044 // might produce a stack frame too large for this function or for
3045 // functions inlining it (such as main), that would not fit the
3046 // requirements of the `-Wframe-larger-than` option.
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07003047 std::unique_ptr<Dex2Oat> dex2oat = std::make_unique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003048
3049 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003050 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003051
Calin Juravleb077e152016-02-18 18:47:37 +00003052 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02003053 // This operation involves I/O.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08003054 if (dex2oat->UseProfile()) {
Calin Juravleb077e152016-02-18 18:47:37 +00003055 if (!dex2oat->LoadProfile()) {
3056 LOG(ERROR) << "Failed to process profile file";
Andreas Gampe7b565912017-03-20 15:48:52 -07003057 return dex2oat::ReturnCode::kOther;
Calin Juravle998c2162015-12-21 15:39:33 +02003058 }
3059 }
3060
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00003061 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap, and vdex.
3062
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003063 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00003064 if (!dex2oat->OpenFile()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003065 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003066 }
3067
Andreas Gampe046c7062015-05-18 23:22:54 -07003068 // Print the complete line when any of the following is true:
3069 // 1) Debug build
3070 // 2) Compiling an image
3071 // 3) Compiling with --host
3072 // 4) Compiling on the host (not a target build)
3073 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003074 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07003075 LOG(INFO) << CommandLine();
3076 } else {
3077 LOG(INFO) << StrippedCommandLine();
3078 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003079
Andreas Gampef7882972017-03-20 16:35:24 -07003080 dex2oat::ReturnCode setup_code = dex2oat->Setup();
3081 if (setup_code != dex2oat::ReturnCode::kNoFailure) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003082 dex2oat->EraseOutputFiles();
Andreas Gampef7882972017-03-20 16:35:24 -07003083 return setup_code;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003084 }
3085
Shubham Ajmera188b2bf2017-09-20 15:53:35 -07003086 // TODO: Due to the cyclic dependencies, profile loading and verifying are
3087 // being done separately. Refactor and place the two next to each other.
3088 // If verification fails, we don't abort the compilation and instead log an
3089 // error.
3090 // TODO(b/62602192, b/65260586): We should consider aborting compilation when
3091 // the profile verification fails.
3092 // Note: If dex2oat fails, installd will remove the oat files causing the app
3093 // to fallback to apk with possible in-memory extraction. We want to avoid
3094 // that, and thus we're lenient towards profile corruptions.
3095 if (dex2oat->UseProfile()) {
3096 dex2oat->VerifyProfileData();
3097 }
3098
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07003099 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
3100 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07003101 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
3102
Andreas Gampe7b565912017-03-20 15:48:52 -07003103 dex2oat::ReturnCode result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00003104 if (dex2oat->IsImage()) {
3105 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08003106 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00003107 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003108 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003109
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003110 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003111}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003112} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07003113
3114int main(int argc, char** argv) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003115 int result = static_cast<int>(art::Dex2oat(argc, argv));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003116 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
Roland Levillain05e34f42018-05-24 13:19:05 +00003117 // time (bug 10645725) unless we're a debug or instrumented build or running on a memory tool.
3118 // Note: The Dex2Oat class should not destruct the runtime in this case.
3119 if (!art::kIsDebugBuild && !art::kIsPGOInstrumentation && !art::kRunningOnMemoryTool) {
Andreas Gampee286b642017-04-13 12:20:42 -07003120 _exit(result);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003121 }
3122 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07003123}