blob: 9b6771d3b571cf91f5f01766e11cc7559d368eef [file] [log] [blame]
Brian Carlstrom7940e442013-07-12 13:46:57 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Andreas Gamped687e372015-04-28 23:16:03 -070017#include <inttypes.h>
Brian Carlstrom7940e442013-07-12 13:46:57 -070018#include <stdio.h>
19#include <stdlib.h>
20#include <sys/stat.h>
Evgenii Stepanov1e133742015-05-20 12:30:59 -070021#include "base/memory_tool.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070022
Andreas Gampe097f34c2017-08-23 08:57:51 -070023#include <forward_list>
Brian Carlstrom7940e442013-07-12 13:46:57 -070024#include <fstream>
25#include <iostream>
Andreas Gampe67f02822016-06-24 21:05:23 -070026#include <limits>
Brian Carlstrom7940e442013-07-12 13:46:57 -070027#include <sstream>
28#include <string>
Andreas Gampe097f34c2017-08-23 08:57:51 -070029#include <type_traits>
Andreas Gampeb1fcead2015-04-20 18:53:51 -070030#include <unordered_set>
Brian Carlstrom7940e442013-07-12 13:46:57 -070031#include <vector>
32
Vladimir Markof94b7812014-06-05 15:48:04 +010033#if defined(__linux__) && defined(__arm__)
34#include <sys/personality.h>
35#include <sys/utsname.h>
36#endif
37
Andreas Gampe46ee31b2016-12-14 10:11:49 -080038#include "android-base/stringprintf.h"
Andreas Gampe9186ced2016-12-12 14:28:21 -080039#include "android-base/strings.h"
40
Ian Rogersd582fa42014-11-05 23:46:43 -080041#include "arch/instruction_set_features.h"
Andreas Gampec5a3ea72015-01-13 16:41:53 -080042#include "arch/mips/instruction_set_features_mips.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000043#include "art_method-inl.h"
Andreas Gampe8228cdf2017-05-30 15:03:54 -070044#include "base/callee_save_type.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070045#include "base/dumpable.h"
David Sehr891a50e2017-10-27 17:01:07 -070046#include "base/file_utils.h"
David Sehr67bf42e2018-02-26 16:43:04 -080047#include "base/leb128.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080048#include "base/macros.h"
David Sehrc431b9d2018-03-02 12:01:51 -080049#include "base/mutex.h"
50#include "base/os.h"
Calin Juravle2e2db782016-02-23 12:00:03 +000051#include "base/scoped_flock.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070052#include "base/stl_util.h"
53#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010054#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070055#include "base/timing_logger.h"
56#include "base/unix_file/fd_file.h"
David Sehrc431b9d2018-03-02 12:01:51 -080057#include "base/utils.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"
Mathieu Chartier72041a02017-07-14 18:23:25 -070080#include "java_vm_ext.h"
Calin Juravle33083d62017-01-18 15:29:12 -080081#include "jit/profile_compilation_info.h"
David Brazdil5d5a36b2016-09-14 15:34:10 +010082#include "linker/buffered_output_stream.h"
Vladimir Marko74527972016-11-29 15:57:32 +000083#include "linker/elf_writer.h"
84#include "linker/elf_writer_quick.h"
David Brazdil5d5a36b2016-09-14 15:34:10 +010085#include "linker/file_output_stream.h"
Vladimir Marko74527972016-11-29 15:57:32 +000086#include "linker/image_writer.h"
Vladimir Marko944da602016-02-19 12:27:55 +000087#include "linker/multi_oat_relative_patcher.h"
Vladimir Marko74527972016-11-29 15:57:32 +000088#include "linker/oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070089#include "mirror/class-inl.h"
90#include "mirror/class_loader.h"
91#include "mirror/object-inl.h"
92#include "mirror/object_array-inl.h"
Andreas Gampe2ff3b972017-06-05 18:14:53 -070093#include "oat_file.h"
Jeff Haob11ffb72016-04-07 15:40:54 -070094#include "oat_file_assistant.h"
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"
101#include "zip_archive.h"
102
103namespace art {
104
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800105using android::base::StringAppendV;
106using android::base::StringPrintf;
107
Andreas Gampee1459ae2016-06-29 09:36:30 -0700108static constexpr size_t kDefaultMinDexFilesForSwap = 2;
109static constexpr size_t kDefaultMinDexFileCumulativeSizeForSwap = 20 * MB;
110
Mathieu Chartier010126f2017-07-15 15:44:18 -0700111// Compiler filter override for very large apps.
112static constexpr CompilerFilter::Filter kLargeAppFilter = CompilerFilter::kVerify;
113
Brian Carlstrom6449c622014-02-10 23:48:36 -0800114static int original_argc;
115static char** original_argv;
116
117static std::string CommandLine() {
118 std::vector<std::string> command;
119 for (int i = 0; i < original_argc; ++i) {
120 command.push_back(original_argv[i]);
121 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800122 return android::base::Join(command, ' ');
Brian Carlstrom6449c622014-02-10 23:48:36 -0800123}
124
Andreas Gampe046c7062015-05-18 23:22:54 -0700125// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
126// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
127// locations are all staged).
128static std::string StrippedCommandLine() {
129 std::vector<std::string> command;
130
Calin Juravle07c6d722017-06-07 17:06:12 +0000131 // Do a pre-pass to look for zip-fd and the compiler filter.
Andreas Gampe046c7062015-05-18 23:22:54 -0700132 bool saw_zip_fd = false;
Calin Juravle07c6d722017-06-07 17:06:12 +0000133 bool saw_compiler_filter = false;
Andreas Gampe046c7062015-05-18 23:22:54 -0700134 for (int i = 0; i < original_argc; ++i) {
Andreas Gampe9186ced2016-12-12 14:28:21 -0800135 if (android::base::StartsWith(original_argv[i], "--zip-fd=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700136 saw_zip_fd = true;
Andreas Gampe046c7062015-05-18 23:22:54 -0700137 }
Calin Juravle07c6d722017-06-07 17:06:12 +0000138 if (android::base::StartsWith(original_argv[i], "--compiler-filter=")) {
139 saw_compiler_filter = true;
Calin Juravle07c6d722017-06-07 17:06:12 +0000140 }
Andreas Gampe046c7062015-05-18 23:22:54 -0700141 }
142
143 // Now filter out things.
144 for (int i = 0; i < original_argc; ++i) {
145 // All runtime-arg parameters are dropped.
146 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
147 i++; // Drop the next part, too.
148 continue;
149 }
150
151 // Any instruction-setXXX is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800152 if (android::base::StartsWith(original_argv[i], "--instruction-set")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700153 continue;
154 }
155
156 // The boot image is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800157 if (android::base::StartsWith(original_argv[i], "--boot-image=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700158 continue;
159 }
160
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800161 // The image format is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800162 if (android::base::StartsWith(original_argv[i], "--image-format=")) {
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800163 continue;
164 }
165
Andreas Gampe046c7062015-05-18 23:22:54 -0700166 // This should leave any dex-file and oat-file options, describing what we compiled.
167
168 // However, we prefer to drop this when we saw --zip-fd.
169 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700170 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe9186ced2016-12-12 14:28:21 -0800171 if (android::base::StartsWith(original_argv[i], "--zip-") ||
172 android::base::StartsWith(original_argv[i], "--dex-") ||
173 android::base::StartsWith(original_argv[i], "--oat-") ||
174 android::base::StartsWith(original_argv[i], "--swap-") ||
175 android::base::StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700176 continue;
177 }
178 }
179
180 command.push_back(original_argv[i]);
181 }
182
Calin Juravle07c6d722017-06-07 17:06:12 +0000183 if (!saw_compiler_filter) {
184 command.push_back("--compiler-filter=" +
185 CompilerFilter::NameOfFilter(CompilerFilter::kDefaultCompilerFilter));
186 }
187
Andreas Gampe046c7062015-05-18 23:22:54 -0700188 // Construct the final output.
189 if (command.size() <= 1U) {
190 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
191 return "Starting dex2oat.";
192 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800193 return android::base::Join(command, ' ');
Andreas Gampe046c7062015-05-18 23:22:54 -0700194}
195
Brian Carlstrom7940e442013-07-12 13:46:57 -0700196static void UsageErrorV(const char* fmt, va_list ap) {
197 std::string error;
198 StringAppendV(&error, fmt, ap);
199 LOG(ERROR) << error;
200}
201
202static void UsageError(const char* fmt, ...) {
203 va_list ap;
204 va_start(ap, fmt);
205 UsageErrorV(fmt, ap);
206 va_end(ap);
207}
208
Andreas Gampe794ad762015-02-23 08:12:24 -0800209NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700210 va_list ap;
211 va_start(ap, fmt);
212 UsageErrorV(fmt, ap);
213 va_end(ap);
214
Brian Carlstrom6449c622014-02-10 23:48:36 -0800215 UsageError("Command: %s", CommandLine().c_str());
216
Brian Carlstrom7940e442013-07-12 13:46:57 -0700217 UsageError("Usage: dex2oat [options]...");
218 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100219 UsageError(" -j<number>: specifies the number of threads used for compilation.");
220 UsageError(" Default is the number of detected hardware threads available on the");
221 UsageError(" host system.");
222 UsageError(" Example: -j12");
223 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700224 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700225 UsageError(" Example: --dex-file=/system/framework/core.jar");
226 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700227 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
228 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
229 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
230 UsageError(" --dex-location=/system/framework/core.jar");
231 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700232 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
233 UsageError(" containing a classes.dex file to compile.");
234 UsageError(" Example: --zip-fd=5");
235 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700236 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
237 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700238 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
239 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800240 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700241 UsageError(" Example: --oat-file=/system/framework/boot.oat");
242 UsageError("");
243 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900244 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700245 UsageError("");
Shubham Ajmera66205322017-10-06 11:18:51 -0700246 UsageError(" --input-vdex-fd=<number>: specifies the vdex input source via a file descriptor.");
247 UsageError(" Example: --input-vdex-fd=6");
248 UsageError("");
249 UsageError(" --output-vdex-fd=<number>: specifies the vdex output destination via a file");
250 UsageError(" descriptor.");
251 UsageError(" Example: --output-vdex-fd=6");
252 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700253 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
254 UsageError(" to the file descriptor specified by --oat-fd.");
255 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
256 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800257 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700258 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
259 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800260 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700261 UsageError(" Example: --image=/system/framework/boot.art");
262 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800263 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800264 UsageError(" Which format to store the image.");
265 UsageError(" Example: --image-format=lz4");
266 UsageError(" Default: uncompressed");
267 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700268 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
269 UsageError(" Example: --image=frameworks/base/preloaded-classes");
270 UsageError("");
271 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
272 UsageError(" Example: --base=0x50000000");
273 UsageError("");
274 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000275 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700276 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000277 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000278 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700279 UsageError("");
280 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
281 UsageError(" Example: --android-root=out/host/linux-x86");
282 UsageError(" Default: $ANDROID_ROOT");
283 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800284 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700285 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700286 UsageError(" Example: --instruction-set=x86");
287 UsageError(" Default: arm");
288 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700289 UsageError(" --instruction-set-features=...,: Specify instruction set features");
290 UsageError(" Example: --instruction-set-features=div");
291 UsageError(" Default: default");
292 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700293 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
294 UsageError(" Default: disabled");
295 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800296 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700297 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800298 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100299 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700300 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100301 UsageError(" --compiler-filter="
Nicolas Geoffray49cda062017-04-21 13:08:25 +0100302 "(assume-verified"
303 "|extract"
304 "|verify"
305 "|quicken"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000306 "|space-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100307 "|space"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000308 "|speed-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100309 "|speed"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000310 "|everything-profile"
311 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700312 UsageError(" select compiler filter.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800313 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800314 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800315 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800316 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
317 UsageError(" method for compiler filter tuning.");
318 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
319 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
320 UsageError("");
321 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
322 UsageError(" method for compiler filter tuning.");
323 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
324 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
325 UsageError("");
326 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
327 UsageError(" method for compiler filter tuning.");
328 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
329 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
330 UsageError("");
331 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
332 UsageError(" method for compiler filter tuning.");
333 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
334 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
335 UsageError("");
336 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
337 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700338 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
339 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800340 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
341 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
342 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100343 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
344 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100345 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
346 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100347 UsageError(" Example: --inline-max-code-units=%d",
348 CompilerOptions::kDefaultInlineMaxCodeUnits);
349 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
350 UsageError("");
Nicolas Geoffraye82b60f2017-12-10 21:50:10 +0000351 UsageError(" --dump-timings: display a breakdown of where time was spent");
Ian Rogers46398602013-08-20 07:50:36 -0700352 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100353 UsageError(" -g");
354 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
355 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000356 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000357 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700358 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100359 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100360 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000361 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
362 UsageError(" debug information necessary to print backtraces. (disabled by default)");
363 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000364 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000365 UsageError("");
Alexey Alexandrovab40c112016-09-19 09:33:49 -0700366 UsageError(" --generate-build-id: Generate GNU-compatible linker build ID ELF section with");
367 UsageError(" SHA-1 of the file content (and thus stable across identical builds)");
368 UsageError("");
369 UsageError(" --no-generate-build-id: Do not generate the build ID ELF section.");
370 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000371 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000372 UsageError("");
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700373 UsageError(" --avoid-storing-invocation: Avoid storing the invocation args in the key value");
374 UsageError(" store. Used to test determinism with different args.");
375 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700376 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
377 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
378 UsageError(" Use a separate --runtime-arg switch for each argument.");
379 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700380 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000381 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700382 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000383 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
384 UsageError(" Cannot be used together with --profile-file.");
385 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100386 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800387 UsageError(" Example: --swap-file=/data/tmp/swap.001");
388 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100389 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800390 UsageError(" Example: --swap-fd=10");
391 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100392 UsageError(" --swap-dex-size-threshold=<size>: specifies the minimum total dex file size in");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700393 UsageError(" bytes to allow the use of swap.");
394 UsageError(" Example: --swap-dex-size-threshold=1000000");
395 UsageError(" Default: %zu", kDefaultMinDexFileCumulativeSizeForSwap);
396 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100397 UsageError(" --swap-dex-count-threshold=<count>: specifies the minimum number of dex files to");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700398 UsageError(" allow the use of swap.");
399 UsageError(" Example: --swap-dex-count-threshold=10");
400 UsageError(" Default: %zu", kDefaultMinDexFilesForSwap);
401 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100402 UsageError(" --very-large-app-threshold=<size>: specifies the minimum total dex file size in");
Mathieu Chartier010126f2017-07-15 15:44:18 -0700403 UsageError(" bytes to consider the input \"very large\" and reduce compilation done.");
Andreas Gampe67f02822016-06-24 21:05:23 -0700404 UsageError(" Example: --very-large-app-threshold=100000000");
405 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700406 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
407 UsageError(" Example: --app-image-fd=10");
408 UsageError("");
409 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
410 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
411 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800412 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
413 "input dex file.");
414 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000415 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000416 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100417 UsageError(" --dump-cfg=<cfg-file>: dump control-flow graphs (CFGs) to specified file.");
418 UsageError(" Example: --dump-cfg=output.cfg");
419 UsageError("");
420 UsageError(" --dump-cfg-append: when dumping CFGs to an existing file, append new CFG data to");
421 UsageError(" existing data (instead of overwriting existing data with new data, which is");
422 UsageError(" the default behavior). This option is only meaningful when used with");
423 UsageError(" --dump-cfg.");
424 UsageError("");
Jeff Hao16d48432017-04-05 17:05:46 -0700425 UsageError(" --classpath-dir=<directory-path>: directory used to resolve relative class paths.");
426 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700427 UsageError(" --class-loader-context=<string spec>: a string specifying the intended");
428 UsageError(" runtime loading context for the compiled dex files.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700429 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700430 UsageError(" It describes how the class loader chain should be built in order to ensure");
431 UsageError(" classes are resolved during dex2aot as they would be resolved at runtime.");
432 UsageError(" This spec will be encoded in the oat file. If at runtime the dex file is");
433 UsageError(" loaded in a different context, the oat file will be rejected.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700434 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700435 UsageError(" The chain is interpreted in the natural 'parent order', meaning that class");
436 UsageError(" loader 'i+1' will be the parent of class loader 'i'.");
Calin Juravlec79470d2017-07-12 17:37:42 -0700437 UsageError(" The compilation sources will be appended to the classpath of the first class");
438 UsageError(" loader.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700439 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700440 UsageError(" E.g. if the context is 'PCL[lib1.dex];DLC[lib2.dex]' and ");
441 UsageError(" --dex-file=src.dex then dex2oat will setup a PathClassLoader with classpath ");
442 UsageError(" 'lib1.dex:src.dex' and set its parent to a DelegateLastClassLoader with ");
443 UsageError(" classpath 'lib2.dex'.");
Calin Juravle1ce70852017-06-28 10:59:03 -0700444 UsageError(" ");
445 UsageError(" Note that the compiler will be tolerant if the source dex files specified");
446 UsageError(" with --dex-file are found in the classpath. The source dex files will be");
447 UsageError(" removed from any class loader's classpath possibly resulting in empty");
448 UsageError(" class loaders.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700449 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700450 UsageError(" Example: --class-loader-context=PCL[lib1.dex:lib2.dex];DLC[lib3.dex]");
Calin Juravle1ce70852017-06-28 10:59:03 -0700451 UsageError("");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700452 UsageError(" --dirty-image-objects=<directory-path>: list of known dirty objects in the image.");
453 UsageError(" The image writer will group them together.");
454 UsageError("");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700455 UsageError(" --compact-dex-level=none|fast: None avoids generating compact dex, fast");
Mathieu Chartier24066ec2017-10-21 16:01:08 -0700456 UsageError(" generates compact dex with low compile time.");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700457 UsageError("");
Andreas Gampee20ff6f2017-11-07 15:00:35 -0800458 UsageError(" --deduplicate-code=true|false: enable|disable code deduplication. Deduplicated");
459 UsageError(" code will have an arbitrary symbol tagged with [DEDUPED].");
Andreas Gampecac31ad2017-11-06 20:01:17 -0800460 UsageError("");
Nicolas Geoffray66ff8a82018-02-28 13:27:55 +0000461 UsageError(" --copy-dex-files=true|false: enable|disable copying the dex files into the");
Mathieu Chartier792111c2018-02-15 13:02:15 -0800462 UsageError(" output vdex.");
463 UsageError("");
Calin Juravle0e09dfc2018-02-12 19:01:09 -0800464 UsageError(" --compilation-reason=<string>: optional metadata specifying the reason for");
465 UsageError(" compiling the apk. If specified, the string will be embedded verbatim in");
466 UsageError(" the key value store of the oat file.");
467 UsageError("");
468 UsageError(" Example: --compilation-reason=install");
469 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700470 std::cerr << "See log for usage error information\n";
471 exit(EXIT_FAILURE);
472}
473
Brian Carlstrom7940e442013-07-12 13:46:57 -0700474// The primary goal of the watchdog is to prevent stuck build servers
475// during development when fatal aborts lead to a cascade of failures
476// that result in a deadlock.
477class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800478// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700479#undef CHECK_PTHREAD_CALL
480#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
481 do { \
482 int rc = call args; \
483 if (rc != 0) { \
484 errno = rc; \
485 std::string message(# call); \
486 message += " failed for "; \
487 message += reason; \
488 Fatal(message); \
489 } \
490 } while (false)
491
492 public:
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800493 explicit WatchDog(int64_t timeout_in_milliseconds)
Andreas Gampe0f54b0d2017-12-27 08:37:02 -0800494 : timeout_in_milliseconds_(timeout_in_milliseconds),
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800495 shutting_down_(false) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700496 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700497 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800498#ifndef __APPLE__
499 pthread_condattr_t condattr;
liulvping8f7101e2017-01-16 15:14:43 +0800500 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_init, (&condattr), reason);
501 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_setclock, (&condattr, CLOCK_MONOTONIC), reason);
502 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, &condattr), reason);
503 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_destroy, (&condattr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800504#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700505 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
506 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
507 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
508 }
509 ~WatchDog() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700510 const char* reason = "dex2oat watch dog thread shutdown";
511 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
512 shutting_down_ = true;
513 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
514 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
515
Kenny Root51316382014-05-13 14:59:37 -0700516 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700517
518 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
519 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
520 }
521
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800522 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
523 // large.
524 static constexpr int64_t kWatchdogVerifyMultiplier =
525 kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
526
527 // When setting timeouts, keep in mind that the build server may not be as fast as your
528 // desktop. Debug builds are slower so they have larger timeouts.
529 static constexpr int64_t kWatchdogSlowdownFactor = kIsDebugBuild ? 5U : 1U;
530
531 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
532 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
533 // itself before that watchdog would take down the system server.
534 static constexpr int64_t kWatchDogTimeoutSeconds = kWatchdogSlowdownFactor * (9 * 60 + 30);
535
536 static constexpr int64_t kDefaultWatchdogTimeoutInMS =
537 kWatchdogVerifyMultiplier * kWatchDogTimeoutSeconds * 1000;
538
Brian Carlstrom7940e442013-07-12 13:46:57 -0700539 private:
540 static void* CallBack(void* arg) {
541 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
542 ::art::SetThreadName("dex2oat watch dog");
543 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700544 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700545 }
546
Andreas Gampe794ad762015-02-23 08:12:24 -0800547 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700548 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
549 // it's rather easy to hang in unwinding.
550 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
551 // logcat logging or stderr output.
Tomasz Wasilczyk8d840902017-12-20 08:19:53 -0800552 LogHelper::LogLineLowStack(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
553
Andreas Gampe48fde372017-06-06 07:43:46 -0700554 // If we're on the host, try to dump all threads to get a sense of what's going on. This is
555 // restricted to the host as the dump may itself go bad.
556 // TODO: Use a double watchdog timeout, so we can enable this on-device.
557 if (!kIsTargetBuild && Runtime::Current() != nullptr) {
Andreas Gampecd607312017-06-05 17:03:05 -0700558 Runtime::Current()->AttachCurrentThread("Watchdog thread attached for dumping",
559 true,
560 nullptr,
561 false);
562 Runtime::Current()->DumpForSigQuit(std::cerr);
563 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700564 exit(1);
565 }
566
567 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700568 timespec timeout_ts;
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800569#if defined(__APPLE__)
570 InitTimeSpec(true, CLOCK_REALTIME, timeout_in_milliseconds_, 0, &timeout_ts);
571#else
liulvping8f7101e2017-01-16 15:14:43 +0800572 InitTimeSpec(true, CLOCK_MONOTONIC, timeout_in_milliseconds_, 0, &timeout_ts);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800573#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700574 const char* reason = "dex2oat watch dog thread waiting";
575 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
576 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800577 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700578 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700579 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800580 timeout_in_milliseconds_/1000));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700581 } else if (rc != 0) {
582 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
583 strerror(errno)));
584 Fatal(message.c_str());
585 }
586 }
587 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
588 }
589
Brian Carlstrom7940e442013-07-12 13:46:57 -0700590 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
591 pthread_mutex_t mutex_;
592 pthread_cond_t cond_;
593 pthread_attr_t attr_;
594 pthread_t pthread_;
Andreas Gampef45d61c2017-06-07 10:29:33 -0700595
596 const int64_t timeout_in_milliseconds_;
597 bool shutting_down_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700598};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700599
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800600class Dex2Oat FINAL {
601 public:
602 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100603 compiler_kind_(Compiler::kOptimizing),
Vladimir Marko33bff252017-11-01 14:35:42 +0000604 instruction_set_(kRuntimeISA == InstructionSet::kArm ? InstructionSet::kThumb2 : kRuntimeISA),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800605 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000606 image_file_location_oat_checksum_(0),
607 image_file_location_oat_data_begin_(0),
608 image_patch_delta_(0),
609 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700610 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800611 runtime_(nullptr),
612 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
613 start_ns_(NanoTime()),
Andreas Gampec560fc02014-07-16 09:57:39 -0700614 start_cputime_ns_(ProcessCpuNanoTime()),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800615 oat_fd_(-1),
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000616 input_vdex_fd_(-1),
617 output_vdex_fd_(-1),
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000618 input_vdex_file_(nullptr),
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +0000619 dm_fd_(-1),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800620 zip_fd_(-1),
621 image_base_(0U),
622 image_classes_zip_filename_(nullptr),
623 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800624 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800625 compiled_classes_zip_filename_(nullptr),
626 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700627 compiled_methods_zip_filename_(nullptr),
628 compiled_methods_filename_(nullptr),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700629 passes_to_run_filename_(nullptr),
Mathieu Chartierff0baff2017-08-02 23:04:19 -0700630 dirty_image_objects_filename_(nullptr),
Jeff Hao436183f2016-01-12 16:36:50 -0800631 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800632 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000633 elf_writers_(),
634 oat_writers_(),
635 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000636 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700637 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000638 opened_dex_files_maps_(),
639 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000640 no_inline_from_dex_files_(),
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700641 avoid_storing_invocation_(false),
Calin Juravle2e2db782016-02-23 12:00:03 +0000642 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800643 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000644 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800645 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000646 force_determinism_(false)
647 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800648
649 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800650 // Log completion time before deleting the runtime_, because this accesses
651 // the runtime.
652 LogCompletionTime();
653
Vladimir Marko307dac92015-10-20 11:20:09 +0100654 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
655 // We want to just exit on non-debug builds, not bringing the runtime down
656 // in an orderly fashion. So release the following fields.
657 driver_.release();
658 image_writer_.release();
659 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
660 dex_file.release();
661 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000662 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
663 map.release();
664 }
David Brazdil7b49e6c2016-09-01 11:06:18 +0100665 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
666 vdex_file.release();
667 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800668 for (std::unique_ptr<File>& oat_file : oat_files_) {
669 oat_file.release();
670 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100671 runtime_.release();
672 verification_results_.release();
673 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100674 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700675 }
676
Roland Levillain9ec5e222015-08-17 20:18:41 +0100677 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800678 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800679 std::string boot_image_filename;
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800680 int64_t watch_dog_timeout_in_ms = -1;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800681 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000682 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800683 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100684 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800685
Andreas Gampe097f34c2017-08-23 08:57:51 -0700686 void ParseBase(const std::string& option) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100687 char* end;
Andreas Gampe097f34c2017-08-23 08:57:51 -0700688 image_base_ = strtoul(option.c_str(), &end, 16);
689 if (end == option.c_str() || *end != '\0') {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100690 Usage("Failed to parse hexadecimal value for option %s", option.data());
691 }
692 }
693
Shubham Ajmera188b2bf2017-09-20 15:53:35 -0700694 bool VerifyProfileData() {
695 return profile_compilation_info_->VerifyProfileData(dex_files_);
696 }
697
Andreas Gampe097f34c2017-08-23 08:57:51 -0700698 void ParseInstructionSetVariant(const std::string& option, ParserOptions* parser_options) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800699 instruction_set_features_ = InstructionSetFeatures::FromVariant(
Andreas Gampe097f34c2017-08-23 08:57:51 -0700700 instruction_set_, option, &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100701 if (instruction_set_features_.get() == nullptr) {
702 Usage("%s", parser_options->error_msg.c_str());
703 }
704 }
705
Andreas Gampe097f34c2017-08-23 08:57:51 -0700706 void ParseInstructionSetFeatures(const std::string& option, ParserOptions* parser_options) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800707 if (instruction_set_features_ == nullptr) {
708 instruction_set_features_ = InstructionSetFeatures::FromVariant(
709 instruction_set_, "default", &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100710 if (instruction_set_features_.get() == nullptr) {
711 Usage("Problem initializing default instruction set features variant: %s",
712 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700713 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800714 }
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800715 instruction_set_features_ =
Andreas Gampe097f34c2017-08-23 08:57:51 -0700716 instruction_set_features_->AddFeaturesFromString(option, &parser_options->error_msg);
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800717 if (instruction_set_features_ == nullptr) {
Andreas Gampe097f34c2017-08-23 08:57:51 -0700718 Usage("Error parsing '%s': %s", option.c_str(), parser_options->error_msg.c_str());
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800719 }
720 }
721
Jeff Hao436183f2016-01-12 16:36:50 -0800722 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoaad75c62016-10-03 08:46:48 +0000723 compiler_options_->boot_image_ = !image_filenames_.empty();
724 compiler_options_->app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700725
Roland Levillain2b03a1f2017-06-06 16:09:59 +0100726 if (IsBootImage() && image_filenames_.size() == 1) {
727 const std::string& boot_image_filename = image_filenames_[0];
728 compiler_options_->core_image_ = CompilerDriver::IsCoreImageFilename(boot_image_filename);
729 }
730
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700731 if (IsAppImage() && IsBootImage()) {
732 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
733 }
734
Jeff Haodcdc85b2015-12-04 14:06:18 -0800735 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800736 Usage("Output must be supplied with either --oat-file or --oat-fd");
737 }
738
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000739 if (input_vdex_fd_ != -1 && !input_vdex_.empty()) {
740 Usage("Can't have both --input-vdex-fd and --input-vdex");
741 }
742
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +0100743 if (output_vdex_fd_ != -1 && !output_vdex_.empty()) {
744 Usage("Can't have both --output-vdex-fd and --output-vdex");
745 }
746
Jeff Haodcdc85b2015-12-04 14:06:18 -0800747 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800748 Usage("--oat-file should not be used with --oat-fd");
749 }
750
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000751 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +0100752 Usage("VDEX and OAT output must be specified either with one --oat-filename "
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000753 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100754 }
755
Roland Levillain9ec5e222015-08-17 20:18:41 +0100756 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800757 Usage("--oat-symbols should not be used with --oat-fd");
758 }
759
Roland Levillain9ec5e222015-08-17 20:18:41 +0100760 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800761 Usage("--oat-symbols should not be used with --host");
762 }
763
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000764 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
765 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100766 }
767
Jeff Haodcdc85b2015-12-04 14:06:18 -0800768 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800769 Usage("--oat-fd should not be used with --image");
770 }
771
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +0000772 if ((input_vdex_fd_ != -1 || !input_vdex_.empty()) &&
773 (dm_fd_ != -1 || !dm_file_location_.empty())) {
774 Usage("An input vdex should not be passed with a .dm file");
775 }
776
Jeff Haodcdc85b2015-12-04 14:06:18 -0800777 if (!parser_options->oat_symbols.empty() &&
778 parser_options->oat_symbols.size() != oat_filenames_.size()) {
779 Usage("--oat-file arguments do not match --oat-symbols arguments");
780 }
781
782 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
783 Usage("--oat-file arguments do not match --image arguments");
784 }
785
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800786 if (android_root_.empty()) {
787 const char* android_root_env_var = getenv("ANDROID_ROOT");
788 if (android_root_env_var == nullptr) {
789 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700790 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800791 android_root_ += android_root_env_var;
792 }
793
Vladimir Markoaad75c62016-10-03 08:46:48 +0000794 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100795 parser_options->boot_image_filename += android_root_;
796 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800797 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100798 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000799 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800800 }
801
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700802 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800803 Usage("--image-classes should only be used with --image");
804 }
805
Vladimir Marko49b0f452015-12-10 13:49:19 +0000806 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800807 Usage("--image-classes should not be used with --boot-image");
808 }
809
810 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
811 Usage("--image-classes-zip should be used with --image-classes");
812 }
813
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700814 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800815 Usage("--compiled-classes should only be used with --image");
816 }
817
Vladimir Marko49b0f452015-12-10 13:49:19 +0000818 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800819 Usage("--compiled-classes should not be used with --boot-image");
820 }
821
822 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
823 Usage("--compiled-classes-zip should be used with --compiled-classes");
824 }
825
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800826 if (dex_filenames_.empty() && zip_fd_ == -1) {
827 Usage("Input must be supplied with either --dex-file or --zip-fd");
828 }
829
830 if (!dex_filenames_.empty() && zip_fd_ != -1) {
831 Usage("--dex-file should not be used with --zip-fd");
832 }
833
834 if (!dex_filenames_.empty() && !zip_location_.empty()) {
835 Usage("--dex-file should not be used with --zip-location");
836 }
837
838 if (dex_locations_.empty()) {
839 for (const char* dex_file_name : dex_filenames_) {
840 dex_locations_.push_back(dex_file_name);
841 }
842 } else if (dex_locations_.size() != dex_filenames_.size()) {
843 Usage("--dex-location arguments do not match --dex-file arguments");
844 }
845
Jeff Haodcdc85b2015-12-04 14:06:18 -0800846 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
847 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
848 Usage("--oat-file arguments must be singular or match --dex-file arguments");
849 }
850 }
851
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800852 if (zip_fd_ != -1 && zip_location_.empty()) {
853 Usage("--zip-location should be supplied with --zip-fd");
854 }
855
Vladimir Marko49b0f452015-12-10 13:49:19 +0000856 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800857 if (image_base_ == 0) {
858 Usage("Non-zero --base not specified");
859 }
860 }
861
Mathieu Chartiera8077802016-03-16 19:08:31 -0700862 const bool have_profile_file = !profile_file_.empty();
863 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
864 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000865 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200866 }
867
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -0700868 if (have_profile_file || have_profile_fd) {
869 if (compiled_classes_filename_ != nullptr ||
870 compiled_classes_zip_filename_ != nullptr ||
871 image_classes_filename_ != nullptr ||
872 image_classes_zip_filename_ != nullptr) {
873 Usage("Profile based image creation is not supported with image or compiled classes");
874 }
875 }
876
Roland Levillain9ec5e222015-08-17 20:18:41 +0100877 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800878 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800879 }
880
881 // If no instruction set feature was given, use the default one for the target
882 // instruction set.
883 if (instruction_set_features_.get() == nullptr) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800884 instruction_set_features_ = InstructionSetFeatures::FromVariant(
885 instruction_set_, "default", &parser_options->error_msg);
Ian Rogersd582fa42014-11-05 23:46:43 -0800886 if (instruction_set_features_.get() == nullptr) {
887 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100888 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800889 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800890 }
891
892 if (instruction_set_ == kRuntimeISA) {
893 std::unique_ptr<const InstructionSetFeatures> runtime_features(
894 InstructionSetFeatures::FromCppDefines());
895 if (!instruction_set_features_->Equals(runtime_features.get())) {
896 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
897 << *instruction_set_features_ << ") and those of dex2oat executable ("
898 << *runtime_features <<") for the command line:\n"
899 << CommandLine();
900 }
901 }
902
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000903 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +0000904 compiler_options_->inline_max_code_units_ = CompilerOptions::kDefaultInlineMaxCodeUnits;
Roland Levillaina215b952015-08-07 11:38:32 +0100905 }
906
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800907 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800908 // Set the compilation target's implicit checks options.
909 switch (instruction_set_) {
Vladimir Marko33bff252017-11-01 14:35:42 +0000910 case InstructionSet::kArm:
911 case InstructionSet::kThumb2:
912 case InstructionSet::kArm64:
913 case InstructionSet::kX86:
914 case InstructionSet::kX86_64:
915 case InstructionSet::kMips:
916 case InstructionSet::kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000917 compiler_options_->implicit_null_checks_ = true;
918 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800919 break;
920
921 default:
922 // Defaults are correct.
923 break;
924 }
925
Jeff Hao436183f2016-01-12 16:36:50 -0800926 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800927 Usage("--multi-image can only be used when creating boot images");
928 }
Jeff Hao436183f2016-01-12 16:36:50 -0800929 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800930 Usage("--multi-image cannot be used with multiple image names");
931 }
932
933 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
934 if (!kIsTargetBuild && IsBootImage()) {
935 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800936 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800937 }
938 }
939
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800940 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100941 if (parser_options->watch_dog_enabled) {
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800942 int64_t timeout = parser_options->watch_dog_timeout_in_ms > 0
943 ? parser_options->watch_dog_timeout_in_ms
944 : WatchDog::kDefaultWatchdogTimeoutInMS;
945 watchdog_.reset(new WatchDog(timeout));
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800946 }
947
948 // Fill some values into the key-value store for the oat header.
949 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800950
Roland Levillainb81e9e92017-04-20 17:35:32 +0100951 // Automatically force determinism for the boot image in a host build if read barriers
952 // are enabled, or if the default GC is CMS or MS. When the default GC is CMS
953 // (Concurrent Mark-Sweep), the GC is switched to a non-concurrent one by passing the
954 // option `-Xgc:nonconcurrent` (see below).
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800955 if (!kIsTargetBuild && IsBootImage()) {
956 if (SupportsDeterministicCompilation()) {
957 force_determinism_ = true;
958 } else {
959 LOG(WARNING) << "Deterministic compilation is disabled.";
960 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800961 }
962 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700963
964 if (passes_to_run_filename_ != nullptr) {
965 passes_to_run_.reset(ReadCommentedInputFromFile<std::vector<std::string>>(
966 passes_to_run_filename_,
967 nullptr)); // No post-processing.
968 if (passes_to_run_.get() == nullptr) {
969 Usage("Failed to read list of passes to run.");
970 }
971 }
972 compiler_options_->passes_to_run_ = passes_to_run_.get();
Roland Levillain9ec5e222015-08-17 20:18:41 +0100973 }
974
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800975 static bool SupportsDeterministicCompilation() {
Roland Levillainb81e9e92017-04-20 17:35:32 +0100976 return (kUseReadBarrier ||
977 gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
978 gc::kCollectorTypeDefault == gc::kCollectorTypeMS);
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800979 }
980
Jeff Hao436183f2016-01-12 16:36:50 -0800981 void ExpandOatAndImageFilenames() {
982 std::string base_oat = oat_filenames_[0];
983 size_t last_oat_slash = base_oat.rfind('/');
984 if (last_oat_slash == std::string::npos) {
985 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
986 }
987 // We also need to honor path components that were encoded through '@'. Otherwise the loading
988 // code won't be able to find the images.
989 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
990 last_oat_slash = base_oat.rfind('@');
991 }
992 base_oat = base_oat.substr(0, last_oat_slash + 1);
993
994 std::string base_img = image_filenames_[0];
995 size_t last_img_slash = base_img.rfind('/');
996 if (last_img_slash == std::string::npos) {
997 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
998 }
999 // We also need to honor path components that were encoded through '@'. Otherwise the loading
1000 // code won't be able to find the images.
1001 if (base_img.find('@', last_img_slash) != std::string::npos) {
1002 last_img_slash = base_img.rfind('@');
1003 }
1004
1005 // Get the prefix, which is the primary image name (without path components). Strip the
1006 // extension.
1007 std::string prefix = base_img.substr(last_img_slash + 1);
1008 if (prefix.rfind('.') != std::string::npos) {
1009 prefix = prefix.substr(0, prefix.rfind('.'));
1010 }
1011 if (!prefix.empty()) {
1012 prefix = prefix + "-";
1013 }
1014
1015 base_img = base_img.substr(0, last_img_slash + 1);
1016
1017 // Note: we have some special case here for our testing. We have to inject the differentiating
1018 // parts for the different core images.
1019 std::string infix; // Empty infix by default.
1020 {
1021 // Check the first name.
1022 std::string dex_file = oat_filenames_[0];
1023 size_t last_dex_slash = dex_file.rfind('/');
1024 if (last_dex_slash != std::string::npos) {
1025 dex_file = dex_file.substr(last_dex_slash + 1);
1026 }
1027 size_t last_dex_dot = dex_file.rfind('.');
1028 if (last_dex_dot != std::string::npos) {
1029 dex_file = dex_file.substr(0, last_dex_dot);
1030 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001031 if (android::base::StartsWith(dex_file, "core-")) {
Jeff Hao436183f2016-01-12 16:36:50 -08001032 infix = dex_file.substr(strlen("core"));
1033 }
1034 }
1035
bowen_lai8bd36c02016-10-12 13:28:55 +08001036 std::string base_symbol_oat;
1037 if (!oat_unstripped_.empty()) {
1038 base_symbol_oat = oat_unstripped_[0];
1039 size_t last_symbol_oat_slash = base_symbol_oat.rfind('/');
1040 if (last_symbol_oat_slash == std::string::npos) {
1041 Usage("--multi-image used with unusable symbol filename %s", base_symbol_oat.c_str());
1042 }
1043 base_symbol_oat = base_symbol_oat.substr(0, last_symbol_oat_slash + 1);
1044 }
1045
Jeff Hao436183f2016-01-12 16:36:50 -08001046 // Now create the other names. Use a counted loop to skip the first one.
1047 for (size_t i = 1; i < dex_locations_.size(); ++i) {
1048 // TODO: Make everything properly std::string.
1049 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
Andreas Gampe097f34c2017-08-23 08:57:51 -07001050 char_backing_storage_.push_front(base_img + image_name);
1051 image_filenames_.push_back(char_backing_storage_.front().c_str());
Jeff Hao436183f2016-01-12 16:36:50 -08001052
1053 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
Andreas Gampe097f34c2017-08-23 08:57:51 -07001054 char_backing_storage_.push_front(base_oat + oat_name);
1055 oat_filenames_.push_back(char_backing_storage_.front().c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001056
1057 if (!base_symbol_oat.empty()) {
Andreas Gampe097f34c2017-08-23 08:57:51 -07001058 char_backing_storage_.push_front(base_symbol_oat + oat_name);
1059 oat_unstripped_.push_back(char_backing_storage_.front().c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001060 }
Jeff Hao436183f2016-01-12 16:36:50 -08001061 }
1062 }
1063
Andreas Gampe8994a042015-12-30 19:03:17 +00001064 // Modify the input string in the following way:
1065 // 0) Assume input is /a/b/c.d
1066 // 1) Strip the path -> c.d
1067 // 2) Inject prefix p -> pc.d
1068 // 3) Inject infix i -> pci.d
1069 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -08001070 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +00001071 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001072 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +00001073 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001074 size_t last_dex_slash = in.rfind('/');
1075 if (last_dex_slash != std::string::npos) {
1076 in = in.substr(last_dex_slash + 1);
1077 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001078 if (!prefix.empty()) {
1079 in = prefix + in;
1080 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001081 if (!infix.empty()) {
1082 // Inject infix.
1083 size_t last_dot = in.rfind('.');
1084 if (last_dot != std::string::npos) {
1085 in.insert(last_dot, infix);
1086 }
1087 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001088 if (android::base::EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001089 in = in.substr(0, in.length() - strlen(".jar")) +
1090 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001091 }
1092 return in;
1093 }
1094
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001095 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001096 std::ostringstream oss;
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001097 if (!avoid_storing_invocation_) {
1098 for (int i = 0; i < argc; ++i) {
1099 if (i > 0) {
1100 oss << ' ';
1101 }
1102 oss << argv[i];
Roland Levillain9ec5e222015-08-17 20:18:41 +01001103 }
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001104 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1105 oss.str(""); // Reset.
Roland Levillain9ec5e222015-08-17 20:18:41 +01001106 }
Roland Levillain9ec5e222015-08-17 20:18:41 +01001107 oss << kRuntimeISA;
1108 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1109 key_value_store_->Put(
1110 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001111 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001112 key_value_store_->Put(
1113 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001114 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001115 key_value_store_->Put(
1116 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001117 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001118 key_value_store_->Put(OatHeader::kCompilerFilter,
1119 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Andreas Gampef8cd8902017-01-18 16:05:01 -08001120 key_value_store_->Put(OatHeader::kConcurrentCopying,
1121 kUseReadBarrier ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001122 }
1123
Andreas Gampe097f34c2017-08-23 08:57:51 -07001124 // This simple forward is here so the string specializations below don't look out of place.
1125 template <typename T, typename U>
1126 void AssignIfExists(Dex2oatArgumentMap& map,
1127 const Dex2oatArgumentMap::Key<T>& key,
1128 U* out) {
1129 map.AssignIfExists(key, out);
1130 }
1131
1132 // Specializations to handle const char* vs std::string.
1133 void AssignIfExists(Dex2oatArgumentMap& map,
1134 const Dex2oatArgumentMap::Key<std::string>& key,
1135 const char** out) {
1136 if (map.Exists(key)) {
1137 char_backing_storage_.push_front(std::move(*map.Get(key)));
1138 *out = char_backing_storage_.front().c_str();
1139 }
1140 }
1141 void AssignIfExists(Dex2oatArgumentMap& map,
1142 const Dex2oatArgumentMap::Key<std::vector<std::string>>& key,
1143 std::vector<const char*>* out) {
1144 if (map.Exists(key)) {
1145 for (auto& val : *map.Get(key)) {
1146 char_backing_storage_.push_front(std::move(val));
1147 out->push_back(char_backing_storage_.front().c_str());
1148 }
1149 }
1150 }
1151
1152 template <typename T>
1153 void AssignTrueIfExists(Dex2oatArgumentMap& map,
1154 const Dex2oatArgumentMap::Key<T>& key,
1155 bool* out) {
1156 if (map.Exists(key)) {
1157 *out = true;
1158 }
1159 }
1160
Roland Levillain9ec5e222015-08-17 20:18:41 +01001161 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1162 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1163 // returns, arguments have been successfully parsed.
1164 void ParseArgs(int argc, char** argv) {
1165 original_argc = argc;
1166 original_argv = argv;
1167
David Sehrc431b9d2018-03-02 12:01:51 -08001168 Locks::Init();
Andreas Gampe51d80cc2017-06-21 21:05:13 -07001169 InitLogging(argv, Runtime::Abort);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001170
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001171 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001172
Andreas Gampe097f34c2017-08-23 08:57:51 -07001173 using M = Dex2oatArgumentMap;
1174 std::string error_msg;
1175 std::unique_ptr<M> args_uptr = M::Parse(argc, const_cast<const char**>(argv), &error_msg);
1176 if (args_uptr == nullptr) {
1177 Usage("Failed to parse command line: %s", error_msg.c_str());
1178 UNREACHABLE();
1179 }
1180
1181 M& args = *args_uptr;
1182
1183 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
1184
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07001185 AssignIfExists(args, M::CompactDexLevel, &compact_dex_level_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001186 AssignIfExists(args, M::DexFiles, &dex_filenames_);
1187 AssignIfExists(args, M::DexLocations, &dex_locations_);
1188 AssignIfExists(args, M::OatFiles, &oat_filenames_);
1189 AssignIfExists(args, M::OatSymbols, &parser_options->oat_symbols);
1190 AssignIfExists(args, M::ImageFilenames, &image_filenames_);
1191 AssignIfExists(args, M::ZipFd, &zip_fd_);
1192 AssignIfExists(args, M::ZipLocation, &zip_location_);
1193 AssignIfExists(args, M::InputVdexFd, &input_vdex_fd_);
1194 AssignIfExists(args, M::OutputVdexFd, &output_vdex_fd_);
1195 AssignIfExists(args, M::InputVdex, &input_vdex_);
1196 AssignIfExists(args, M::OutputVdex, &output_vdex_);
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001197 AssignIfExists(args, M::DmFd, &dm_fd_);
1198 AssignIfExists(args, M::DmFile, &dm_file_location_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001199 AssignIfExists(args, M::OatFd, &oat_fd_);
1200 AssignIfExists(args, M::OatLocation, &oat_location_);
1201 AssignIfExists(args, M::Watchdog, &parser_options->watch_dog_enabled);
1202 AssignIfExists(args, M::WatchdogTimeout, &parser_options->watch_dog_timeout_in_ms);
1203 AssignIfExists(args, M::Threads, &thread_count_);
1204 AssignIfExists(args, M::ImageClasses, &image_classes_filename_);
1205 AssignIfExists(args, M::ImageClassesZip, &image_classes_zip_filename_);
1206 AssignIfExists(args, M::CompiledClasses, &compiled_classes_filename_);
1207 AssignIfExists(args, M::CompiledClassesZip, &compiled_classes_zip_filename_);
1208 AssignIfExists(args, M::CompiledMethods, &compiled_methods_filename_);
1209 AssignIfExists(args, M::CompiledMethodsZip, &compiled_methods_zip_filename_);
1210 AssignIfExists(args, M::Passes, &passes_to_run_filename_);
1211 AssignIfExists(args, M::BootImage, &parser_options->boot_image_filename);
1212 AssignIfExists(args, M::AndroidRoot, &android_root_);
1213 AssignIfExists(args, M::Profile, &profile_file_);
1214 AssignIfExists(args, M::ProfileFd, &profile_file_fd_);
1215 AssignIfExists(args, M::RuntimeOptions, &runtime_args_);
1216 AssignIfExists(args, M::SwapFile, &swap_file_name_);
1217 AssignIfExists(args, M::SwapFileFd, &swap_fd_);
1218 AssignIfExists(args, M::SwapDexSizeThreshold, &min_dex_file_cumulative_size_for_swap_);
1219 AssignIfExists(args, M::SwapDexCountThreshold, &min_dex_files_for_swap_);
1220 AssignIfExists(args, M::VeryLargeAppThreshold, &very_large_threshold_);
1221 AssignIfExists(args, M::AppImageFile, &app_image_file_name_);
1222 AssignIfExists(args, M::AppImageFileFd, &app_image_fd_);
1223 AssignIfExists(args, M::NoInlineFrom, &no_inline_from_string_);
1224 AssignIfExists(args, M::ClasspathDir, &classpath_dir_);
1225 AssignIfExists(args, M::DirtyImageObjects, &dirty_image_objects_filename_);
1226 AssignIfExists(args, M::ImageFormat, &image_storage_mode_);
Calin Juravle0e09dfc2018-02-12 19:01:09 -08001227 AssignIfExists(args, M::CompilationReason, &compilation_reason_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001228
1229 AssignIfExists(args, M::Backend, &compiler_kind_);
1230 parser_options->requested_specific_compiler = args.Exists(M::Backend);
1231
1232 AssignIfExists(args, M::TargetInstructionSet, &instruction_set_);
1233 // arm actually means thumb2.
1234 if (instruction_set_ == InstructionSet::kArm) {
1235 instruction_set_ = InstructionSet::kThumb2;
1236 }
1237
1238 AssignTrueIfExists(args, M::Host, &is_host_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001239 AssignTrueIfExists(args, M::AvoidStoringInvocation, &avoid_storing_invocation_);
1240 AssignTrueIfExists(args, M::MultiImage, &multi_image_);
Mathieu Chartier792111c2018-02-15 13:02:15 -08001241 AssignIfExists(args, M::CopyDexFiles, &copy_dex_files_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001242
1243 if (args.Exists(M::ForceDeterminism)) {
1244 if (!SupportsDeterministicCompilation()) {
1245 Usage("Option --force-determinism requires read barriers or a CMS/MS garbage collector");
Roland Levillain9ec5e222015-08-17 20:18:41 +01001246 }
Andreas Gampe097f34c2017-08-23 08:57:51 -07001247 force_determinism_ = true;
1248 }
1249
1250 if (args.Exists(M::Base)) {
1251 ParseBase(*args.Get(M::Base));
1252 }
1253 if (args.Exists(M::TargetInstructionSetVariant)) {
1254 ParseInstructionSetVariant(*args.Get(M::TargetInstructionSetVariant), parser_options.get());
1255 }
1256 if (args.Exists(M::TargetInstructionSetFeatures)) {
1257 ParseInstructionSetFeatures(*args.Get(M::TargetInstructionSetFeatures), parser_options.get());
1258 }
1259 if (args.Exists(M::ClassLoaderContext)) {
1260 class_loader_context_ = ClassLoaderContext::Create(*args.Get(M::ClassLoaderContext));
1261 if (class_loader_context_ == nullptr) {
1262 Usage("Option --class-loader-context has an incorrect format: %s",
1263 args.Get(M::ClassLoaderContext)->c_str());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001264 }
1265 }
1266
Andreas Gampe097f34c2017-08-23 08:57:51 -07001267 if (!ReadCompilerOptions(args, compiler_options_.get(), &error_msg)) {
1268 Usage(error_msg.c_str());
1269 }
1270
Jeff Hao436183f2016-01-12 16:36:50 -08001271 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001272
1273 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001274 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001275 }
1276
Jeff Haodcdc85b2015-12-04 14:06:18 -08001277 // Check whether the oat output files are writable, and open them for later. Also open a swap
1278 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001279 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001280 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1281 PruneNonExistentDexFiles();
1282
Jeff Hao436183f2016-01-12 16:36:50 -08001283 // Expand oat and image filenames for multi image.
1284 if (IsBootImage() && multi_image_) {
1285 ExpandOatAndImageFilenames();
1286 }
1287
David Brazdil7b49e6c2016-09-01 11:06:18 +01001288 // OAT and VDEX file handling
David Brazdil7b49e6c2016-09-01 11:06:18 +01001289 if (oat_fd_ == -1) {
1290 DCHECK(!oat_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08001291 for (const char* oat_filename : oat_filenames_) {
1292 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
Calin Juravleb09be722017-09-25 16:42:48 -07001293 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001294 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1295 return false;
1296 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001297 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001298 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1299 oat_file->Erase();
1300 return false;
1301 }
1302 oat_files_.push_back(std::move(oat_file));
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001303 DCHECK_EQ(input_vdex_fd_, -1);
1304 if (!input_vdex_.empty()) {
1305 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001306 input_vdex_file_ = VdexFile::Open(input_vdex_,
1307 /* writable */ false,
1308 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001309 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001310 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001311 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001312
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001313 DCHECK_EQ(output_vdex_fd_, -1);
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001314 std::string vdex_filename = output_vdex_.empty()
1315 ? ReplaceFileExtension(oat_filename, "vdex")
1316 : output_vdex_;
1317 if (vdex_filename == input_vdex_ && output_vdex_.empty()) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001318 update_input_vdex_ = true;
1319 std::unique_ptr<File> vdex_file(OS::OpenFileReadWrite(vdex_filename.c_str()));
1320 vdex_files_.push_back(std::move(vdex_file));
1321 } else {
1322 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
Calin Juravleb09be722017-09-25 16:42:48 -07001323 if (vdex_file == nullptr) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001324 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1325 return false;
1326 }
1327 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1328 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1329 vdex_file->Erase();
1330 return false;
1331 }
1332 vdex_files_.push_back(std::move(vdex_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001333 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001334 }
1335 } else {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001336 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, /* check_usage */ true));
Calin Juravleb09be722017-09-25 16:42:48 -07001337 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001338 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1339 return false;
1340 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001341 oat_file->DisableAutoClose();
1342 if (oat_file->SetLength(0) != 0) {
1343 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001344 oat_file->Erase();
1345 return false;
David Brazdil7b49e6c2016-09-01 11:06:18 +01001346 }
1347 oat_files_.push_back(std::move(oat_file));
1348
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001349 if (input_vdex_fd_ != -1) {
1350 struct stat s;
1351 int rc = TEMP_FAILURE_RETRY(fstat(input_vdex_fd_, &s));
1352 if (rc == -1) {
1353 PLOG(WARNING) << "Failed getting length of vdex file";
1354 } else {
1355 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001356 input_vdex_file_ = VdexFile::Open(input_vdex_fd_,
1357 s.st_size,
1358 "vdex",
1359 /* writable */ false,
1360 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001361 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001362 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001363 // If there's any problem with the passed vdex, just warn and proceed
1364 // without it.
1365 if (input_vdex_file_ == nullptr) {
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001366 PLOG(WARNING) << "Failed opening vdex file: " << error_msg;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001367 }
1368 }
1369 }
1370
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001371 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001372 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001373 std::unique_ptr<File> vdex_file(new File(output_vdex_fd_, vdex_location, /* check_usage */ true));
Calin Juravleb09be722017-09-25 16:42:48 -07001374 if (vdex_file == nullptr) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001375 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001376 return false;
1377 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001378 vdex_file->DisableAutoClose();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001379 if (input_vdex_file_ != nullptr && output_vdex_fd_ == input_vdex_fd_) {
1380 update_input_vdex_ = true;
1381 } else {
1382 if (vdex_file->SetLength(0) != 0) {
1383 PLOG(ERROR) << "Truncating vdex file " << vdex_location << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001384 vdex_file->Erase();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001385 return false;
1386 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001387 }
1388 vdex_files_.push_back(std::move(vdex_file));
1389
Jeff Haodcdc85b2015-12-04 14:06:18 -08001390 oat_filenames_.push_back(oat_location_.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001391 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001392
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001393 // If we're updating in place a vdex file, be defensive and put an invalid vdex magic in case
1394 // dex2oat gets killed.
1395 // Note: we're only invalidating the magic data in the file, as dex2oat needs the rest of
1396 // the information to remain valid.
1397 if (update_input_vdex_) {
Vladimir Marko74527972016-11-29 15:57:32 +00001398 std::unique_ptr<linker::BufferedOutputStream> vdex_out =
1399 std::make_unique<linker::BufferedOutputStream>(
1400 std::make_unique<linker::FileOutputStream>(vdex_files_.back().get()));
Nicolas Geoffray3a293552018-03-02 10:52:16 +00001401 if (!vdex_out->WriteFully(&VdexFile::VerifierDepsHeader::kVdexInvalidMagic,
1402 arraysize(VdexFile::VerifierDepsHeader::kVdexInvalidMagic))) {
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001403 PLOG(ERROR) << "Failed to invalidate vdex header. File: " << vdex_out->GetLocation();
1404 return false;
1405 }
1406
1407 if (!vdex_out->Flush()) {
1408 PLOG(ERROR) << "Failed to flush stream after invalidating header of vdex file."
1409 << " File: " << vdex_out->GetLocation();
1410 return false;
1411 }
1412 }
1413
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001414 if (dm_fd_ != -1 || !dm_file_location_.empty()) {
1415 std::string error_msg;
1416 if (dm_fd_ != -1) {
1417 dm_file_.reset(ZipArchive::OpenFromFd(dm_fd_, "DexMetadata", &error_msg));
1418 } else {
1419 dm_file_.reset(ZipArchive::Open(dm_file_location_.c_str(), &error_msg));
1420 }
1421 if (dm_file_ == nullptr) {
1422 LOG(WARNING) << "Could not open DexMetadata archive " << error_msg;
1423 }
1424 }
1425
1426 if (dm_file_ != nullptr) {
1427 DCHECK(input_vdex_file_ == nullptr);
1428 std::string error_msg;
1429 static const char* kDexMetadata = "DexMetadata";
1430 std::unique_ptr<ZipEntry> zip_entry(dm_file_->Find(VdexFile::kVdexNameInDmFile, &error_msg));
1431 if (zip_entry == nullptr) {
1432 LOG(INFO) << "No " << VdexFile::kVdexNameInDmFile << " file in DexMetadata archive. "
1433 << "Not doing fast verification.";
1434 } else {
Mathieu Chartier792111c2018-02-15 13:02:15 -08001435 std::unique_ptr<MemMap> input_file(zip_entry->MapDirectlyOrExtract(
1436 VdexFile::kVdexNameInDmFile,
1437 kDexMetadata,
1438 &error_msg));
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001439 if (input_file == nullptr) {
1440 LOG(WARNING) << "Could not open vdex file in DexMetadata archive: " << error_msg;
1441 } else {
1442 input_vdex_file_ = std::make_unique<VdexFile>(input_file.release());
1443 }
1444 }
1445 }
1446
David Brazdil7b49e6c2016-09-01 11:06:18 +01001447 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001448 //
1449 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1450 // that we can use for swap.
1451 //
1452 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1453 // will immediately unlink to satisfy the swap fd assumption.
1454 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1455 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1456 if (swap_file.get() == nullptr) {
1457 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1458 return false;
1459 }
1460 swap_fd_ = swap_file->Fd();
1461 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1462 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1463 // released immediately.
1464 unlink(swap_file_name_.c_str());
1465 }
Jeff Hao436183f2016-01-12 16:36:50 -08001466
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001467 return true;
1468 }
1469
David Brazdil7b49e6c2016-09-01 11:06:18 +01001470 void EraseOutputFiles() {
1471 for (auto& files : { &vdex_files_, &oat_files_ }) {
1472 for (size_t i = 0; i < files->size(); ++i) {
1473 if ((*files)[i].get() != nullptr) {
1474 (*files)[i]->Erase();
1475 (*files)[i].reset();
1476 }
1477 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001478 }
Andreas Gampea650e702014-12-03 14:28:02 -08001479 }
1480
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001481 void LoadClassProfileDescriptors() {
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -07001482 if (profile_compilation_info_ != nullptr && IsImage()) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001483 Runtime* runtime = Runtime::Current();
1484 CHECK(runtime != nullptr);
Mathieu Chartier0b490842016-05-25 15:05:59 -07001485 // Filter out class path classes since we don't want to include these in the image.
Mathieu Chartier4f342b02017-07-21 17:12:39 -07001486 image_classes_.reset(
1487 new std::unordered_set<std::string>(
1488 profile_compilation_info_->GetClassDescriptors(dex_files_)));
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001489 VLOG(compiler) << "Loaded " << image_classes_->size()
1490 << " image class descriptors from profile";
1491 if (VLOG_IS_ON(compiler)) {
1492 for (const std::string& s : *image_classes_) {
1493 LOG(INFO) << "Image class " << s;
1494 }
1495 }
1496 }
1497 }
1498
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001499 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1500 // boot class path.
Andreas Gampef7882972017-03-20 16:35:24 -07001501 dex2oat::ReturnCode Setup() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001502 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001503
Jeff Haoc23b0c02017-07-27 18:19:38 -07001504 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods() ||
1505 !PrepareDirtyObjects()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001506 return dex2oat::ReturnCode::kOther;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001507 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001508
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001509 // Verification results are null since we don't know if we will need them yet as the compler
1510 // filter may change.
Andreas Gampe4585f872015-03-27 23:45:15 -07001511 callbacks_.reset(new QuickCompilerCallbacks(
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001512 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001513 CompilerCallbacks::CallbackMode::kCompileBootImage :
1514 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001515
Vladimir Marko49b0f452015-12-10 13:49:19 +00001516 RuntimeArgumentMap runtime_options;
Mathieu Chartier46331a62017-07-21 09:49:10 -07001517 if (!PrepareRuntimeOptions(&runtime_options, callbacks_.get())) {
Andreas Gampef7882972017-03-20 16:35:24 -07001518 return dex2oat::ReturnCode::kOther;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001519 }
1520
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001521 CreateOatWriters();
1522 if (!AddDexFileSources()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001523 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001524 }
1525
Calin Juravle0e09dfc2018-02-12 19:01:09 -08001526 if (!compilation_reason_.empty()) {
1527 key_value_store_->Put(OatHeader::kCompilationReasonKey, compilation_reason_);
1528 }
1529
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001530 if (IsBootImage() && image_filenames_.size() > 1) {
1531 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1532 // We need this for the multi-image case.
Mathieu Chartier866d8742016-09-21 15:24:18 -07001533 key_value_store_->Put(OatHeader::kBootClassPathKey,
1534 gc::space::ImageSpace::GetMultiImageBootClassPath(dex_locations_,
1535 oat_filenames_,
1536 image_filenames_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001537 }
1538
1539 if (!IsBootImage()) {
1540 // When compiling an app, create the runtime early to retrieve
1541 // the image location key needed for the oat header.
1542 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001543 return dex2oat::ReturnCode::kCreateRuntime;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001544 }
1545
Andreas Gampe29d38e72016-03-23 15:31:51 +00001546 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001547 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1548 std::vector<gc::space::ImageSpace*> image_spaces =
1549 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Richard Uhlerbc26b722017-03-10 14:27:10 +00001550 image_file_location_oat_checksum_ = image_spaces[0]->GetImageHeader().GetOatChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001551 image_file_location_oat_data_begin_ =
1552 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1553 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1554 // Store the boot image filename(s).
1555 std::vector<std::string> image_filenames;
1556 for (const gc::space::ImageSpace* image_space : image_spaces) {
1557 image_filenames.push_back(image_space->GetImageFilename());
1558 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001559 std::string image_file_location = android::base::Join(image_filenames, ':');
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001560 if (!image_file_location.empty()) {
1561 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1562 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001563 } else {
1564 image_file_location_oat_checksum_ = 0u;
1565 image_file_location_oat_data_begin_ = 0u;
1566 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001567 }
1568
1569 // Open dex files for class path.
Calin Juravle19915892017-08-03 17:10:36 +00001570
Calin Juravle1ce70852017-06-28 10:59:03 -07001571 if (class_loader_context_ == nullptr) {
Calin Juravle19915892017-08-03 17:10:36 +00001572 // If no context was specified use the default one (which is an empty PathClassLoader).
1573 class_loader_context_ = std::unique_ptr<ClassLoaderContext>(ClassLoaderContext::Default());
Jeff Haof0192c82016-03-28 20:39:50 -07001574 }
Calin Juravle19915892017-08-03 17:10:36 +00001575
Calin Juravle1ce70852017-06-28 10:59:03 -07001576 DCHECK_EQ(oat_writers_.size(), 1u);
1577
1578 // Note: Ideally we would reject context where the source dex files are also
1579 // specified in the classpath (as it doesn't make sense). However this is currently
1580 // needed for non-prebuild tests and benchmarks which expects on the fly compilation.
1581 // Also, for secondary dex files we do not have control on the actual classpath.
1582 // Instead of aborting, remove all the source location from the context classpaths.
1583 if (class_loader_context_->RemoveLocationsFromClassPaths(
1584 oat_writers_[0]->GetSourceLocations())) {
1585 LOG(WARNING) << "The source files to be compiled are also in the classpath.";
1586 }
1587
1588 // We need to open the dex files before encoding the context in the oat file.
1589 // (because the encoding adds the dex checksum...)
1590 // TODO(calin): consider redesigning this so we don't have to open the dex files before
1591 // creating the actual class loader.
1592 if (!class_loader_context_->OpenDexFiles(runtime_->GetInstructionSet(), classpath_dir_)) {
1593 // Do not abort if we couldn't open files from the classpath. They might be
1594 // apks without dex files and right now are opening flow will fail them.
1595 LOG(WARNING) << "Failed to open classpath dex files";
1596 }
1597
1598 // Store the class loader context in the oat header.
1599 key_value_store_->Put(OatHeader::kClassPathKey,
1600 class_loader_context_->EncodeContextForOatFile(classpath_dir_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001601 }
1602
1603 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001604 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001605 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1606 rodata_.reserve(oat_writers_.size());
1607 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1608 rodata_.push_back(elf_writers_[i]->StartRoData());
1609 // Unzip or copy dex files straight to the oat file.
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00001610 std::vector<std::unique_ptr<MemMap>> opened_dex_files_map;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001611 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001612 // No need to verify the dex file for:
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001613 // 1) Dexlayout since it does the verification. It also may not pass the verification since
1614 // we don't update the dex checksum.
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001615 // 2) when we have a vdex file, which means it was already verified.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001616 const bool verify = !DoDexLayoutOptimizations() && (input_vdex_file_ == nullptr);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001617 if (!oat_writers_[i]->WriteAndOpenDexFiles(
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +00001618 vdex_files_[i].get(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01001619 rodata_.back(),
1620 instruction_set_,
1621 instruction_set_features_.get(),
1622 key_value_store_.get(),
Jeff Hao042e8982016-10-19 11:17:11 -07001623 verify,
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001624 update_input_vdex_,
Mathieu Chartier792111c2018-02-15 13:02:15 -08001625 copy_dex_files_,
David Brazdil7b49e6c2016-09-01 11:06:18 +01001626 &opened_dex_files_map,
1627 &opened_dex_files)) {
Andreas Gampef7882972017-03-20 16:35:24 -07001628 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001629 }
1630 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00001631 if (opened_dex_files_map.empty()) {
1632 DCHECK(opened_dex_files.empty());
1633 } else {
1634 for (std::unique_ptr<MemMap>& map : opened_dex_files_map) {
1635 opened_dex_files_maps_.push_back(std::move(map));
1636 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001637 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001638 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001639 opened_dex_files_.push_back(std::move(dex_file));
1640 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001641 }
1642 }
1643 }
1644
1645 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
Andreas Gampe7386da42016-06-08 18:18:47 -07001646
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001647 // If we need to downgrade the compiler-filter for size reasons.
1648 if (!IsBootImage() && IsVeryLarge(dex_files_)) {
Mathieu Chartier8cce65a2017-08-17 00:06:39 -07001649 // Disable app image to make sure dex2oat unloading is enabled.
1650 compiler_options_->DisableAppImage();
1651
Mathieu Chartier72041a02017-07-14 18:23:25 -07001652 // If we need to downgrade the compiler-filter for size reasons, do that early before we read
1653 // it below for creating verification callbacks.
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001654 if (!CompilerFilter::IsAsGoodAs(kLargeAppFilter, compiler_options_->GetCompilerFilter())) {
1655 LOG(INFO) << "Very large app, downgrading to verify.";
1656 // Note: this change won't be reflected in the key-value store, as that had to be
1657 // finalized before loading the dex files. This setup is currently required
1658 // to get the size from the DexFile objects.
1659 // TODO: refactor. b/29790079
1660 compiler_options_->SetCompilerFilter(kLargeAppFilter);
1661 }
1662 }
1663
1664 if (CompilerFilter::IsAnyCompilationEnabled(compiler_options_->GetCompilerFilter())) {
1665 // Only modes with compilation require verification results, do this here instead of when we
1666 // create the compilation callbacks since the compilation mode may have been changed by the
1667 // very large app logic.
1668 // Avoiding setting the verification results saves RAM by not adding the dex files later in
1669 // the function.
1670 verification_results_.reset(new VerificationResults(compiler_options_.get()));
1671 callbacks_->SetVerificationResults(verification_results_.get());
1672 }
1673
Andreas Gampe7386da42016-06-08 18:18:47 -07001674 // We had to postpone the swap decision till now, as this is the point when we actually
1675 // know about the dex files we're going to use.
1676
1677 // Make sure that we didn't create the driver, yet.
1678 CHECK(driver_ == nullptr);
1679 // If we use a swap file, ensure we are above the threshold to make it necessary.
1680 if (swap_fd_ != -1) {
1681 if (!UseSwap(IsBootImage(), dex_files_)) {
1682 close(swap_fd_);
1683 swap_fd_ = -1;
1684 VLOG(compiler) << "Decided to run without swap.";
1685 } else {
1686 LOG(INFO) << "Large app, accepted running with swap.";
1687 }
1688 }
1689 // 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 +00001690 if (IsBootImage()) {
1691 // For boot image, pass opened dex files to the Runtime::Create().
1692 // Note: Runtime acquires ownership of these dex files.
1693 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001694 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001695 return dex2oat::ReturnCode::kOther;
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001696 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001697 }
1698
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001699 // If we're doing the image, override the compiler filter to force full compilation. Must be
1700 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1701 // compilation of class initializers.
1702 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001703 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001704 WellKnownClasses::Init(self->GetJniEnv());
1705
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001706 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001707 constexpr bool kSaveDexInput = false;
1708 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001709 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001710 }
1711 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001712
1713 // Ensure opened dex files are writable for dex-to-dex transformations.
1714 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1715 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1716 PLOG(ERROR) << "Failed to make .dex files writeable.";
Andreas Gampef7882972017-03-20 16:35:24 -07001717 return dex2oat::ReturnCode::kOther;
Vladimir Marko919f5532016-01-20 19:13:01 +00001718 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001719 }
1720
Mathieu Chartier72041a02017-07-14 18:23:25 -07001721 // Verification results are only required for modes that have any compilation. Avoid
1722 // adding the dex files if possible to prevent allocating large arrays.
1723 if (verification_results_ != nullptr) {
1724 for (const auto& dex_file : dex_files_) {
1725 // Pre-register dex files so that we can access verification results without locks during
1726 // compilation and verification.
Mathieu Chartier0733dc82017-07-17 14:05:28 -07001727 verification_results_->AddDexFile(dex_file);
1728 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001729 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001730
Andreas Gampef7882972017-03-20 16:35:24 -07001731 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001732 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001733
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001734 // If we need to keep the oat file open for the image writer.
1735 bool ShouldKeepOatFileOpen() const {
1736 return IsImage() && oat_fd_ != kInvalidFd;
1737 }
1738
Mathieu Chartier72041a02017-07-14 18:23:25 -07001739 // Doesn't return the class loader since it's not meant to be used for image compilation.
1740 void CompileDexFilesIndividually() {
1741 CHECK(!IsImage()) << "Not supported with image";
1742 for (const DexFile* dex_file : dex_files_) {
1743 std::vector<const DexFile*> dex_files(1u, dex_file);
1744 VLOG(compiler) << "Compiling " << dex_file->GetLocation();
1745 jobject class_loader = CompileDexFiles(dex_files);
1746 CHECK(class_loader != nullptr);
1747 ScopedObjectAccess soa(Thread::Current());
1748 // Unload class loader to free RAM.
Ian Rogers55256cb2017-12-21 17:07:11 -08001749 jweak weak_class_loader = soa.Env()->GetVm()->AddWeakGlobalRef(
Mathieu Chartier72041a02017-07-14 18:23:25 -07001750 soa.Self(),
1751 soa.Decode<mirror::ClassLoader>(class_loader));
Ian Rogers55256cb2017-12-21 17:07:11 -08001752 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), class_loader);
Roland Levillainaf290312018-02-27 20:02:17 +00001753 runtime_->GetHeap()->CollectGarbage(/* clear_soft_references */ true);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001754 ObjPtr<mirror::ClassLoader> decoded_weak = soa.Decode<mirror::ClassLoader>(weak_class_loader);
1755 if (decoded_weak != nullptr) {
1756 LOG(FATAL) << "Failed to unload class loader, path from root set: "
1757 << runtime_->GetHeap()->GetVerification()->FirstPathFromRootSet(decoded_weak);
1758 }
1759 VLOG(compiler) << "Unloaded classloader";
1760 }
1761 }
1762
1763 bool ShouldCompileDexFilesIndividually() const {
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001764 // Compile individually if we are:
1765 // 1. not building an image,
1766 // 2. not verifying a vdex file,
1767 // 3. using multidex,
1768 // 4. not doing any AOT compilation.
1769 // This means extract, no-vdex verify, and quicken, will use the individual compilation
1770 // mode (to reduce RAM used by the compiler).
Mathieu Chartier72041a02017-07-14 18:23:25 -07001771 return !IsImage() &&
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001772 !update_input_vdex_ &&
Mathieu Chartier72041a02017-07-14 18:23:25 -07001773 dex_files_.size() > 1 &&
Mathieu Chartier6a2b67b2017-08-08 15:09:29 -07001774 !CompilerFilter::IsAotCompilationEnabled(compiler_options_->GetCompilerFilter());
Mathieu Chartier72041a02017-07-14 18:23:25 -07001775 }
1776
1777 // Set up and create the compiler driver and then invoke it to compile all the dex files.
1778 jobject Compile() {
1779 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1780
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001781 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001782
Vladimir Marko47496c22016-01-27 16:15:08 +00001783 // Find the dex files we should not inline from.
Vladimir Marko47496c22016-01-27 16:15:08 +00001784 std::vector<std::string> no_inline_filters;
1785 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001786
1787 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001788 const std::string core_oj = "core-oj";
1789 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1790 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001791 }
1792
Vladimir Marko47496c22016-01-27 16:15:08 +00001793 if (!no_inline_filters.empty()) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001794 std::vector<const DexFile*> class_path_files;
1795 if (!IsBootImage()) {
1796 // The class loader context is used only for apps.
1797 class_path_files = class_loader_context_->FlattenOpenedDexFiles();
1798 }
1799
Jeff Haodcdc85b2015-12-04 14:06:18 -08001800 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1801 &class_linker->GetBootClassPath(),
1802 &class_path_files,
1803 &dex_files_
1804 };
1805 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001806 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001807 for (const std::string& filter : no_inline_filters) {
1808 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
Calin Juravlea308a322017-07-18 16:51:51 -07001809 // allows tests to specify <test-dexfile>!classes2.dex if needed but if the
Vladimir Marko47496c22016-01-27 16:15:08 +00001810 // base location passes the StartsWith() test, so do all extra locations.
1811 std::string dex_location = dex_file->GetLocation();
1812 if (filter.find('/') == std::string::npos) {
1813 // The filter does not contain the path. Remove the path from dex_location as well.
1814 size_t last_slash = dex_file->GetLocation().rfind('/');
1815 if (last_slash != std::string::npos) {
1816 dex_location = dex_location.substr(last_slash + 1);
1817 }
1818 }
1819
Andreas Gampe9186ced2016-12-12 14:28:21 -08001820 if (android::base::StartsWith(dex_location, filter.c_str())) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001821 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1822 no_inline_from_dex_files_.push_back(dex_file);
1823 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001824 }
1825 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001826 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001827 }
1828 if (!no_inline_from_dex_files_.empty()) {
1829 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001830 }
1831 }
1832
Vladimir Marko307dac92015-10-20 11:20:09 +01001833 driver_.reset(new CompilerDriver(compiler_options_.get(),
1834 verification_results_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001835 compiler_kind_,
1836 instruction_set_,
1837 instruction_set_features_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001838 image_classes_.release(),
1839 compiled_classes_.release(),
Wojciech Staszkiewicz62534792016-08-09 14:30:55 -07001840 compiled_methods_.release(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001841 thread_count_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001842 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001843 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001844 driver_->SetDexFilesForOatFile(dex_files_);
Nicolas Geoffray486dda02017-09-11 14:15:52 +01001845 if (!IsBootImage()) {
1846 driver_->SetClasspathDexFiles(class_loader_context_->FlattenOpenedDexFiles());
1847 }
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001848
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001849 const bool compile_individually = ShouldCompileDexFilesIndividually();
1850 if (compile_individually) {
1851 // Set the compiler driver in the callbacks so that we can avoid re-verification. This not
1852 // only helps performance but also prevents reverifying quickened bytecodes. Attempting
1853 // verify quickened bytecode causes verification failures.
1854 // Only set the compiler filter if we are doing separate compilation since there is a bit
1855 // of overhead when checking if a class was previously verified.
1856 callbacks_->SetDoesClassUnloading(true, driver_.get());
1857 }
1858
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001859 // Setup vdex for compilation.
1860 if (!DoEagerUnquickeningOfVdex() && input_vdex_file_ != nullptr) {
1861 callbacks_->SetVerifierDeps(
1862 new verifier::VerifierDeps(dex_files_, input_vdex_file_->GetVerifierDepsData()));
1863
1864 // TODO: we unquicken unconditionally, as we don't know
1865 // if the boot image has changed. How exactly we'll know is under
1866 // experimentation.
1867 TimingLogger::ScopedTiming time_unquicken("Unquicken", timings_);
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +03001868
1869 // We do not decompile a RETURN_VOID_NO_BARRIER into a RETURN_VOID, as the quickening
1870 // optimization does not depend on the boot image (the optimization relies on not
1871 // having final fields in a class, which does not change for an app).
Mathieu Chartier210531f2018-01-12 10:15:51 -08001872 input_vdex_file_->Unquicken(dex_files_, /* decompile_return_instruction */ false);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001873 } else {
1874 // Create the main VerifierDeps, here instead of in the compiler since we want to aggregate
1875 // the results for all the dex files, not just the results for the current dex file.
1876 callbacks_->SetVerifierDeps(new verifier::VerifierDeps(dex_files_));
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001877 }
Mathieu Chartier72041a02017-07-14 18:23:25 -07001878 // Invoke the compilation.
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001879 if (compile_individually) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001880 CompileDexFilesIndividually();
1881 // Return a null classloader since we already freed released it.
1882 return nullptr;
1883 }
1884 return CompileDexFiles(dex_files_);
1885 }
1886
1887 // Create the class loader, use it to compile, and return.
1888 jobject CompileDexFiles(const std::vector<const DexFile*>& dex_files) {
1889 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1890
1891 jobject class_loader = nullptr;
1892 if (!IsBootImage()) {
1893 class_loader = class_loader_context_->CreateClassLoader(dex_files_);
Andreas Gampee9934582018-01-19 21:23:04 -08001894 callbacks_->SetDexFiles(&dex_files);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001895 }
1896
1897 // Register dex caches and key them to the class loader so that they only unload when the
1898 // class loader unloads.
1899 for (const auto& dex_file : dex_files) {
1900 ScopedObjectAccess soa(Thread::Current());
1901 // Registering the dex cache adds a strong root in the class loader that prevents the dex
1902 // cache from being unloaded early.
1903 ObjPtr<mirror::DexCache> dex_cache = class_linker->RegisterDexFile(
1904 *dex_file,
1905 soa.Decode<mirror::ClassLoader>(class_loader));
1906 if (dex_cache == nullptr) {
1907 soa.Self()->AssertPendingException();
1908 LOG(FATAL) << "Failed to register dex file " << dex_file->GetLocation() << " "
1909 << soa.Self()->GetException()->Dump();
1910 }
1911 }
1912 driver_->CompileAll(class_loader, dex_files, timings_);
1913 return class_loader;
Vladimir Markof4da6752014-08-01 19:04:18 +01001914 }
1915
Jeff Hao436183f2016-01-12 16:36:50 -08001916 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001917 // ensure the references between the two are correct.
1918 //
1919 // Currently we have a memory layout that looks something like this:
1920 //
1921 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001922 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001923 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001924 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001925 // +--------------+
1926 // | alloc spaces |
1927 // +--------------+
1928 //
Jeff Hao436183f2016-01-12 16:36:50 -08001929 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001930 //
Jeff Hao436183f2016-01-12 16:36:50 -08001931 // 1. The images are expected to be loaded at an absolute address and
1932 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001933 //
Jeff Hao436183f2016-01-12 16:36:50 -08001934 // 2. There are absolute pointers from Methods in the images to their
1935 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001936 //
Jeff Hao436183f2016-01-12 16:36:50 -08001937 // 3. There are absolute pointers from the code in the oat files to Methods
1938 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001939 //
Jeff Hao436183f2016-01-12 16:36:50 -08001940 // 4. There are absolute pointers from code in the oat files to other code
1941 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001942 //
1943 // To get this all correct, we go through several steps.
1944 //
Jeff Hao436183f2016-01-12 16:36:50 -08001945 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001946 // the oat data size and code size. During this stage, we also set
1947 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001948 //
Jeff Hao436183f2016-01-12 16:36:50 -08001949 // 2. We prepare offsets for the objects in the images and calculate
1950 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001951 //
Jeff Hao436183f2016-01-12 16:36:50 -08001952 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001953 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001954 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001955 // can prepare the ELF headers and we then know the ELF memory segment
1956 // layout and we can now resolve all references. The compiler provides
1957 // LinkerPatch information in each CompiledMethod and we resolve these,
1958 // using the layout information and image object locations provided by
1959 // image writer, as we're writing the method code.
1960 //
Jeff Hao436183f2016-01-12 16:36:50 -08001961 // 4. We create the image files. They need to know where the oat files
1962 // will be loaded after itself. Originally oat files were simply
1963 // memory mapped so we could predict where their contents were based
1964 // on the file size. Now that they are ELF files, we need to inspect
1965 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001966 // where the oat header is located within.
1967 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001968 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001969 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001970 // load the .so at the desired location at runtime by offsetting the
1971 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001972 // TODO: Do this in step 3. We already know the layout there.
1973 //
1974 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1975 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001976
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001977 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1978 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001979 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1980 // case (when the file will be explicitly erased).
David Brazdil7b49e6c2016-09-01 11:06:18 +01001981 bool WriteOutputFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001982 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1983
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001984 // Sync the data to the file, in case we did dex2dex transformations.
1985 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1986 if (!map->Sync()) {
1987 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1988 return false;
1989 }
1990 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001991
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001992 if (IsImage()) {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001993 if (IsAppImage() && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001994 gc::Heap* const heap = Runtime::Current()->GetHeap();
1995 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001996 image_base_ = std::max(image_base_, RoundUp(
1997 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1998 kPageSize));
1999 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002000 // The non moving space is right after the oat file. Put the preferred app image location
2001 // right after the non moving space so that we ideally get a continuous immune region for
2002 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002003 // Use the default non moving space capacity since dex2oat does not have a separate non-
2004 // moving space. This means the runtime's non moving space space size will be as large
2005 // as the growth limit for dex2oat, but smaller in the zygote.
2006 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002007 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002008 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
2009 }
2010
Vladimir Marko74527972016-11-29 15:57:32 +00002011 image_writer_.reset(new linker::ImageWriter(*driver_,
2012 image_base_,
2013 compiler_options_->GetCompilePic(),
2014 IsAppImage(),
2015 image_storage_mode_,
2016 oat_filenames_,
2017 dex_file_oat_index_map_,
2018 dirty_image_objects_.get()));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002019
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002020 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002021 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
2022 if (!image_writer_->PrepareImageAddressSpace()) {
2023 LOG(ERROR) << "Failed to prepare image address space.";
2024 return false;
2025 }
2026 }
2027
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002028 // Initialize the writers with the compiler driver, image writer, and their
2029 // dex files. The writers were created without those being there yet.
2030 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00002031 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002032 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
2033 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
2034 }
2035
David Brazdil5d5a36b2016-09-14 15:34:10 +01002036 {
2037 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
2038 DCHECK(IsBootImage() || oat_files_.size() == 1u);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00002039 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
David Brazdil5d5a36b2016-09-14 15:34:10 +01002040 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
2041 File* vdex_file = vdex_files_[i].get();
Vladimir Marko74527972016-11-29 15:57:32 +00002042 std::unique_ptr<linker::BufferedOutputStream> vdex_out =
2043 std::make_unique<linker::BufferedOutputStream>(
2044 std::make_unique<linker::FileOutputStream>(vdex_file));
David Brazdil5d5a36b2016-09-14 15:34:10 +01002045
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00002046 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002047 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
2048 return false;
2049 }
2050
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002051 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
2052 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
2053 return false;
2054 }
2055
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +00002056 // VDEX finalized, seek back to the beginning and write checksums and the header.
2057 if (!oat_writers_[i]->WriteChecksumsAndVdexHeader(vdex_out.get())) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002058 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
2059 return false;
2060 }
2061 }
2062 }
2063
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002064 {
2065 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002066 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002067 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00002068 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2069 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko944da602016-02-19 12:27:55 +00002070
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002071 oat_writer->PrepareLayout(&patcher);
Vladimir Marko944da602016-02-19 12:27:55 +00002072
2073 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
David Brazdil7b49e6c2016-09-01 11:06:18 +01002074 size_t text_size = oat_writer->GetOatSize() - rodata_size;
Vladimir Markoaad75c62016-10-03 08:46:48 +00002075 elf_writer->PrepareDynamicSection(rodata_size,
2076 text_size,
2077 oat_writer->GetBssSize(),
Vladimir Marko0eb882b2017-05-15 13:39:18 +01002078 oat_writer->GetBssMethodsOffset(),
David Srbeckyec2cdf42017-12-08 16:21:25 +00002079 oat_writer->GetBssRootsOffset(),
2080 oat_writer->GetVdexSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002081 if (IsImage()) {
2082 // Update oat layout.
2083 DCHECK(image_writer_ != nullptr);
2084 DCHECK_LT(i, oat_filenames_.size());
2085 image_writer_->UpdateOatFileLayout(i,
2086 elf_writer->GetLoadedSize(),
2087 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01002088 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002089 }
Richard Uhlerbc26b722017-03-10 14:27:10 +00002090
2091 if (IsBootImage()) {
2092 // Have the image_file_location_oat_checksum_ for boot oat files
2093 // depend on the contents of all the boot oat files. This way only
2094 // the primary image checksum needs to be checked to determine
2095 // whether any of the images are out of date.
2096 image_file_location_oat_checksum_ ^= oat_writer->GetOatHeader().GetChecksum();
2097 }
Vladimir Marko944da602016-02-19 12:27:55 +00002098 }
2099
2100 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002101 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko74527972016-11-29 15:57:32 +00002102 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2103 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00002104
David Srbecky0c4572e2016-01-22 19:19:25 +00002105 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00002106 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
David Srbecky32210b92017-12-04 14:39:21 +00002107 debug::DebugInfo debug_info = oat_writer->GetDebugInfo(); // Keep the variable alive.
2108 elf_writer->PrepareDebugInfo(debug_info); // Processes the data on background thread.
David Srbecky0c4572e2016-01-22 19:19:25 +00002109
Vladimir Marko74527972016-11-29 15:57:32 +00002110 linker::OutputStream*& rodata = rodata_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002111 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002112 if (!oat_writer->WriteRodata(rodata)) {
2113 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
2114 return false;
2115 }
2116 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002117 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00002118
Vladimir Marko74527972016-11-29 15:57:32 +00002119 linker::OutputStream* text = elf_writer->StartText();
Jeff Haodcdc85b2015-12-04 14:06:18 -08002120 if (!oat_writer->WriteCode(text)) {
2121 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
2122 return false;
2123 }
2124 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00002125
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002126 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
2127 image_file_location_oat_checksum_,
2128 image_file_location_oat_data_begin_,
2129 image_patch_delta_)) {
2130 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
2131 return false;
2132 }
2133
Vladimir Marko944da602016-02-19 12:27:55 +00002134 if (IsImage()) {
2135 // Update oat header information.
2136 DCHECK(image_writer_ != nullptr);
2137 DCHECK_LT(i, oat_filenames_.size());
2138 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
2139 }
2140
Jeff Haodcdc85b2015-12-04 14:06:18 -08002141 elf_writer->WriteDynamicSection();
David Srbecky32210b92017-12-04 14:39:21 +00002142 elf_writer->WriteDebugInfo(oat_writer->GetDebugInfo());
Vladimir Marko10c13562015-11-25 14:33:36 +00002143
Jeff Haodcdc85b2015-12-04 14:06:18 -08002144 if (!elf_writer->End()) {
2145 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
2146 return false;
2147 }
2148
David Brazdil7b49e6c2016-09-01 11:06:18 +01002149 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
2150 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002151 }
2152
Jeff Haodcdc85b2015-12-04 14:06:18 -08002153 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002154
2155 oat_writer.reset();
2156 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002157 }
2158 }
2159
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002160 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002161 }
2162
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002163 // If we are compiling an image, invoke the image creation routine. Else just skip.
2164 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002165 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002166 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
2167 if (!CreateImageFile()) {
2168 return false;
2169 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002170 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07002171 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002172 return true;
2173 }
2174
Jeff Haodcdc85b2015-12-04 14:06:18 -08002175 // Create a copy from stripped to unstripped.
2176 bool CopyStrippedToUnstripped() {
2177 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
2178 // If we don't want to strip in place, copy from stripped location to unstripped location.
2179 // We need to strip after image creation because FixupElf needs to use .strtab.
2180 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
2181 // If the oat file is still open, flush it.
2182 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002183 if (!FlushCloseOutputFile(&oat_files_[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002184 return false;
2185 }
2186 }
2187
2188 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
2189 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
2190 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01002191 int64_t in_length = in->GetLength();
2192 if (in_length < 0) {
2193 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
2194 return false;
2195 }
2196 if (!out->Copy(in.get(), 0, in_length)) {
2197 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
2198 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002199 }
2200 if (out->FlushCloseOrErase() != 0) {
2201 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
2202 return false;
2203 }
2204 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
2205 }
2206 }
2207 return true;
2208 }
2209
David Brazdil7b49e6c2016-09-01 11:06:18 +01002210 bool FlushOutputFile(std::unique_ptr<File>* file) {
2211 if (file->get() != nullptr) {
2212 if (file->get()->Flush() != 0) {
2213 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
2214 return false;
2215 }
2216 }
2217 return true;
2218 }
2219
2220 bool FlushCloseOutputFile(std::unique_ptr<File>* file) {
2221 if (file->get() != nullptr) {
2222 std::unique_ptr<File> tmp(file->release());
2223 if (tmp->FlushCloseOrErase() != 0) {
2224 PLOG(ERROR) << "Failed to flush and close output file: " << tmp->GetPath();
2225 return false;
2226 }
2227 }
2228 return true;
2229 }
2230
2231 bool FlushOutputFiles() {
2232 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
2233 for (auto& files : { &vdex_files_, &oat_files_ }) {
2234 for (size_t i = 0; i < files->size(); ++i) {
2235 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002236 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08002237 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002238 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00002239 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002240 return true;
2241 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002242
David Brazdil7b49e6c2016-09-01 11:06:18 +01002243 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002244 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002245 for (auto& files : { &vdex_files_, &oat_files_ }) {
2246 for (size_t i = 0; i < files->size(); ++i) {
2247 result &= FlushCloseOutputFile(&(*files)[i]);
2248 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002249 }
2250 return result;
2251 }
2252
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002253 void DumpTiming() {
Nicolas Geoffray2d8801f2017-11-28 15:50:07 +00002254 if (compiler_options_->GetDumpTimings() ||
2255 (kIsDebugBuild && timings_->GetTotalNs() > MsToNs(1000))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002256 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2257 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002258 }
2259
Andreas Gampe10e477d2014-11-19 12:57:42 -08002260 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002261 return IsAppImage() || IsBootImage();
2262 }
2263
2264 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002265 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002266 }
2267
2268 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002269 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002270 }
2271
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002272 bool IsHost() const {
2273 return is_host_;
2274 }
2275
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002276 bool UseProfile() const {
Mathieu Chartierd0af56c2017-02-17 12:56:25 -08002277 return profile_file_fd_ != -1 || !profile_file_.empty();
Calin Juravle998c2162015-12-21 15:39:33 +02002278 }
2279
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002280 bool DoProfileGuidedOptimizations() const {
Nicolas Geoffray49cda062017-04-21 13:08:25 +01002281 return UseProfile();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002282 }
2283
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002284 bool DoGenerateCompactDex() const {
2285 return compact_dex_level_ != CompactDexLevel::kCompactDexLevelNone;
2286 }
2287
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002288 bool DoDexLayoutOptimizations() const {
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002289 return DoProfileGuidedOptimizations() || DoGenerateCompactDex();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002290 }
2291
Igor Murashkin545412b2017-08-17 15:26:54 -07002292 bool DoOatLayoutOptimizations() const {
2293 return DoProfileGuidedOptimizations();
2294 }
2295
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002296 bool MayInvalidateVdexMetadata() const {
2297 // DexLayout can invalidate the vdex metadata if changing the class def order is enabled, so
2298 // we need to unquicken the vdex file eagerly, before passing it to dexlayout.
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01002299 return DoDexLayoutOptimizations();
2300 }
2301
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002302 bool DoEagerUnquickeningOfVdex() const {
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00002303 return MayInvalidateVdexMetadata() && dm_file_ == nullptr;
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002304 }
2305
Calin Juravle2e2db782016-02-23 12:00:03 +00002306 bool LoadProfile() {
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002307 DCHECK(UseProfile());
Calin Juravlee6f87cc2017-05-24 17:41:05 -07002308 // TODO(calin): We should be using the runtime arena pool (instead of the
2309 // default profile arena). However the setup logic is messy and needs
2310 // cleaning up before that (e.g. the oat writers are created before the
2311 // runtime).
Calin Juravle2e2db782016-02-23 12:00:03 +00002312 profile_compilation_info_.reset(new ProfileCompilationInfo());
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002313 ScopedFlock profile_file;
Calin Juravle2e2db782016-02-23 12:00:03 +00002314 std::string error;
2315 if (profile_file_fd_ != -1) {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002316 profile_file = LockedFile::DupOf(profile_file_fd_, "profile",
2317 true /* read_only_mode */, &error);
Andreas Gampe29d38e72016-03-23 15:31:51 +00002318 } else if (profile_file_ != "") {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002319 profile_file = LockedFile::Open(profile_file_.c_str(), O_RDONLY, true, &error);
Calin Juravle998c2162015-12-21 15:39:33 +02002320 }
Calin Juravle877fd962016-01-05 14:29:29 +00002321
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002322 // Return early if we're unable to obtain a lock on the profile.
2323 if (profile_file.get() == nullptr) {
2324 LOG(ERROR) << "Cannot lock profiles: " << error;
2325 return false;
2326 }
2327
2328 if (!profile_compilation_info_->Load(profile_file->Fd())) {
Calin Juravle2e2db782016-02-23 12:00:03 +00002329 profile_compilation_info_.reset(nullptr);
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002330 return false;
Calin Juravle2e2db782016-02-23 12:00:03 +00002331 }
Calin Juravle877fd962016-01-05 14:29:29 +00002332
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002333 return true;
Calin Juravle998c2162015-12-21 15:39:33 +02002334 }
2335
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002336 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002337 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2338 if (is_image) {
2339 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2340 return false;
2341 }
2342 if (dex_files.size() < min_dex_files_for_swap_) {
2343 // If there are less dex files than the threshold, assume it's gonna be fine.
2344 return false;
2345 }
2346 size_t dex_files_size = 0;
2347 for (const auto* dex_file : dex_files) {
2348 dex_files_size += dex_file->GetHeader().file_size_;
2349 }
2350 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2351 }
2352
Andreas Gampe67f02822016-06-24 21:05:23 -07002353 bool IsVeryLarge(std::vector<const DexFile*>& dex_files) {
2354 size_t dex_files_size = 0;
2355 for (const auto* dex_file : dex_files) {
2356 dex_files_size += dex_file->GetHeader().file_size_;
2357 }
2358 return dex_files_size >= very_large_threshold_;
2359 }
2360
Vladimir Marko49b0f452015-12-10 13:49:19 +00002361 bool PrepareImageClasses() {
2362 // If --image-classes was specified, calculate the full list of classes to include in the image.
2363 if (image_classes_filename_ != nullptr) {
2364 image_classes_ =
2365 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2366 if (image_classes_ == nullptr) {
2367 return false;
2368 }
2369 } else if (IsBootImage()) {
2370 image_classes_.reset(new std::unordered_set<std::string>);
2371 }
2372 return true;
2373 }
2374
2375 bool PrepareCompiledClasses() {
2376 // If --compiled-classes was specified, calculate the full list of classes to compile in the
2377 // image.
2378 if (compiled_classes_filename_ != nullptr) {
2379 compiled_classes_ =
2380 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
2381 if (compiled_classes_ == nullptr) {
2382 return false;
2383 }
2384 } else {
2385 compiled_classes_.reset(nullptr); // By default compile everything.
2386 }
2387 return true;
2388 }
2389
2390 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2391 const char* classes_filename,
2392 const char* tag) {
2393 std::unique_ptr<std::unordered_set<std::string>> classes;
2394 std::string error_msg;
2395 if (zip_filename != nullptr) {
2396 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2397 } else {
2398 classes.reset(ReadImageClassesFromFile(classes_filename));
2399 }
2400 if (classes == nullptr) {
2401 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2402 << classes_filename << "': " << error_msg;
2403 }
2404 return classes;
2405 }
2406
2407 bool PrepareCompiledMethods() {
2408 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2409 if (compiled_methods_filename_ != nullptr) {
2410 std::string error_msg;
2411 if (compiled_methods_zip_filename_ != nullptr) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002412 compiled_methods_.reset(ReadCommentedInputFromZip<std::unordered_set<std::string>>(
2413 compiled_methods_zip_filename_,
2414 compiled_methods_filename_,
2415 nullptr, // No post-processing.
2416 &error_msg));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002417 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002418 compiled_methods_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2419 compiled_methods_filename_,
2420 nullptr)); // No post-processing.
Vladimir Marko49b0f452015-12-10 13:49:19 +00002421 }
2422 if (compiled_methods_.get() == nullptr) {
2423 LOG(ERROR) << "Failed to create list of compiled methods from '"
2424 << compiled_methods_filename_ << "': " << error_msg;
2425 return false;
2426 }
2427 } else {
2428 compiled_methods_.reset(nullptr); // By default compile everything.
2429 }
2430 return true;
2431 }
2432
Jeff Haoc23b0c02017-07-27 18:19:38 -07002433 bool PrepareDirtyObjects() {
2434 if (dirty_image_objects_filename_ != nullptr) {
2435 dirty_image_objects_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2436 dirty_image_objects_filename_,
2437 nullptr));
2438 if (dirty_image_objects_ == nullptr) {
2439 LOG(ERROR) << "Failed to create list of dirty objects from '"
2440 << dirty_image_objects_filename_ << "'";
2441 return false;
2442 }
2443 } else {
2444 dirty_image_objects_.reset(nullptr);
2445 }
2446 return true;
2447 }
2448
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002449 void PruneNonExistentDexFiles() {
2450 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2451 size_t kept = 0u;
2452 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2453 if (!OS::FileExists(dex_filenames_[i])) {
2454 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2455 } else {
2456 dex_filenames_[kept] = dex_filenames_[i];
2457 dex_locations_[kept] = dex_locations_[i];
2458 ++kept;
2459 }
2460 }
2461 dex_filenames_.resize(kept);
2462 dex_locations_.resize(kept);
2463 }
2464
2465 bool AddDexFileSources() {
2466 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
Nicolas Geoffraybc177272018-01-24 14:55:32 +00002467 if (input_vdex_file_ != nullptr && input_vdex_file_->HasDexSection()) {
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002468 DCHECK_EQ(oat_writers_.size(), 1u);
2469 const std::string& name = zip_location_.empty() ? dex_locations_[0] : zip_location_;
2470 DCHECK(!name.empty());
2471 if (!oat_writers_[0]->AddVdexDexFilesSource(*input_vdex_file_.get(), name.c_str())) {
2472 return false;
2473 }
2474 } else if (zip_fd_ != -1) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002475 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002476 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2477 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002478 return false;
2479 }
2480 } else if (oat_writers_.size() > 1u) {
2481 // Multi-image.
2482 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2483 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2484 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2485 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2486 return false;
2487 }
2488 }
2489 } else {
2490 DCHECK_EQ(oat_writers_.size(), 1u);
2491 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2492 DCHECK_NE(dex_filenames_.size(), 0u);
2493 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2494 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2495 return false;
2496 }
2497 }
2498 }
2499 return true;
2500 }
2501
2502 void CreateOatWriters() {
2503 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2504 elf_writers_.reserve(oat_files_.size());
2505 oat_writers_.reserve(oat_files_.size());
2506 for (const std::unique_ptr<File>& oat_file : oat_files_) {
Vladimir Marko74527972016-11-29 15:57:32 +00002507 elf_writers_.emplace_back(linker::CreateElfWriterQuick(instruction_set_,
2508 instruction_set_features_.get(),
2509 compiler_options_.get(),
2510 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002511 elf_writers_.back()->Start();
Igor Murashkin545412b2017-08-17 15:26:54 -07002512 const bool do_oat_writer_layout = DoDexLayoutOptimizations() || DoOatLayoutOptimizations();
Vladimir Marko74527972016-11-29 15:57:32 +00002513 oat_writers_.emplace_back(new linker::OatWriter(
Igor Murashkin545412b2017-08-17 15:26:54 -07002514 IsBootImage(),
2515 timings_,
Mathieu Chartier603ccab2017-10-20 14:34:28 -07002516 do_oat_writer_layout ? profile_compilation_info_.get() : nullptr,
2517 compact_dex_level_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002518 }
2519 }
2520
Vladimir Marko49b0f452015-12-10 13:49:19 +00002521 void SaveDexInput() {
2522 for (size_t i = 0; i < dex_files_.size(); ++i) {
2523 const DexFile* dex_file = dex_files_[i];
2524 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2525 getpid(), i));
2526 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2527 if (tmp_file.get() == nullptr) {
2528 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2529 << ". Try: adb shell chmod 777 /data/local/tmp";
2530 continue;
2531 }
2532 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2533 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2534 UNUSED(tmp_file->Flush());
2535 UNUSED(tmp_file->Close());
2536 LOG(INFO) << "Wrote input to " << tmp_file_name;
2537 }
2538 }
2539
Mathieu Chartier46331a62017-07-21 09:49:10 -07002540 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options,
2541 QuickCompilerCallbacks* callbacks) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00002542 RuntimeOptions raw_options;
2543 if (boot_image_filename_.empty()) {
2544 std::string boot_class_path = "-Xbootclasspath:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002545 boot_class_path += android::base::Join(dex_filenames_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002546 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2547 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002548 boot_class_path_locations += android::base::Join(dex_locations_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002549 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2550 } else {
2551 std::string boot_image_option = "-Ximage:";
2552 boot_image_option += boot_image_filename_;
2553 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2554 }
2555 for (size_t i = 0; i < runtime_args_.size(); i++) {
2556 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2557 }
2558
Mathieu Chartier46331a62017-07-21 09:49:10 -07002559 raw_options.push_back(std::make_pair("compilercallbacks", callbacks));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002560 raw_options.push_back(
2561 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2562
2563 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2564 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2565 // have been stripped in preopting, anyways).
2566 if (!IsBootImage()) {
2567 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2568 }
Andreas Gampec8e35202017-04-28 15:47:12 -07002569 // Never allow implicit image compilation.
2570 raw_options.push_back(std::make_pair("-Xnoimage-dex2oat", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002571 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2572 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2573 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002574 // Disable Hspace compaction to save heap size virtual space.
2575 // Only need disable Hspace for OOM becasue background collector is equal to
2576 // foreground collector by default for dex2oat.
2577 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002578
Andreas Gampeace0dc12016-01-20 13:33:13 -08002579 if (compiler_options_->IsForceDeterminism()) {
Roland Levillainb81e9e92017-04-20 17:35:32 +01002580 // If we're asked to be deterministic, ensure non-concurrent GC for determinism.
2581 //
2582 // Note that with read barriers, this option is ignored, because Runtime::Init
2583 // overrides the foreground GC to be gc::kCollectorTypeCC when instantiating
2584 // gc::Heap. This is fine, as concurrent GC requests are not honored in dex2oat,
2585 // which uses an unstarted runtime.
Andreas Gampeace0dc12016-01-20 13:33:13 -08002586 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
Roland Levillainb81e9e92017-04-20 17:35:32 +01002587
Nicolas Geoffray7acddd82017-05-03 15:04:55 +01002588 // The default LOS implementation (map) is not deterministic. So disable it.
2589 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=disabled", nullptr));
Andreas Gampeace0dc12016-01-20 13:33:13 -08002590
2591 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2592 // compaction (done above) and ensure that neither foreground nor background collectors
2593 // are concurrent.
Roland Levillainb81e9e92017-04-20 17:35:32 +01002594 //
2595 // Likewise, this option is ignored with read barriers because Runtime::Init
2596 // overrides the background GC to be gc::kCollectorTypeCCBackground, but that's
2597 // fine too, for the same reason (see above).
Andreas Gampeace0dc12016-01-20 13:33:13 -08002598 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2599
2600 // To make identity hashcode deterministic, set a known seed.
2601 mirror::Object::SetHashCodeSeed(987654321U);
2602 }
2603
Vladimir Marko49b0f452015-12-10 13:49:19 +00002604 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2605 LOG(ERROR) << "Failed to parse runtime options";
2606 return false;
2607 }
2608 return true;
2609 }
2610
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002611 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002612 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2613 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002614 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002615 LOG(ERROR) << "Failed to create runtime";
2616 return false;
2617 }
Andreas Gampe49c144d2016-11-14 10:11:16 -08002618
2619 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2620 // "ps -a" don't change to non-descript "main."
2621 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2622
Vladimir Marko307dac92015-10-20 11:20:09 +01002623 runtime_.reset(Runtime::Current());
2624 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe8228cdf2017-05-30 15:03:54 -07002625 for (uint32_t i = 0; i < static_cast<uint32_t>(CalleeSaveType::kLastCalleeSaveType); ++i) {
2626 CalleeSaveType type = CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002627 if (!runtime_->HasCalleeSaveMethod(type)) {
2628 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002629 }
2630 }
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002631
2632 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2633 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002634 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002635
Vladimir Marko307dac92015-10-20 11:20:09 +01002636 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002637
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002638 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2639 // Runtime::Start, give it away now so that we don't starve GC.
2640 Thread* self = Thread::Current();
2641 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002642
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002643 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002644 }
2645
Jeff Haodcdc85b2015-12-04 14:06:18 -08002646 // 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 -08002647 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002648 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002649 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002650 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002651 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002652 image_filenames_.push_back(app_image_file_name_.c_str());
2653 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002654 if (!image_writer_->Write(app_image_fd_,
2655 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002656 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002657 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002658 return false;
2659 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002660
Jeff Haodcdc85b2015-12-04 14:06:18 -08002661 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002662 dchecked_vector<uintptr_t> oat_data_begins;
2663 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2664 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002665 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002666 // Destroy ImageWriter before doing FixupElf.
2667 image_writer_.reset();
2668
Vladimir Marko944da602016-02-19 12:27:55 +00002669 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2670 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002671 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2672 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2673 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2674 if (oat_file.get() == nullptr) {
2675 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2676 return false;
2677 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002678
Vladimir Marko74527972016-11-29 15:57:32 +00002679 if (!linker::ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002680 oat_file->Erase();
2681 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2682 return false;
2683 }
2684
2685 if (oat_file->FlushCloseOrErase()) {
2686 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2687 return false;
2688 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002689 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002690 }
2691
2692 return true;
2693 }
2694
2695 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002696 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2697 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002698 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002699 return ReadCommentedInputFromFile<std::unordered_set<std::string>>(image_classes_filename,
2700 &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002701 }
2702
2703 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002704 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002705 const char* zip_filename,
2706 const char* image_classes_filename,
2707 std::string* error_msg) {
2708 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002709 return ReadCommentedInputFromZip<std::unordered_set<std::string>>(zip_filename,
2710 image_classes_filename,
2711 &process,
2712 error_msg);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002713 }
2714
2715 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2716 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002717 template <typename T>
2718 static T* ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002719 const char* input_filename, std::function<std::string(const char*)>* process) {
2720 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2721 if (input_file.get() == nullptr) {
2722 LOG(ERROR) << "Failed to open input file " << input_filename;
2723 return nullptr;
2724 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002725 std::unique_ptr<T> result(
2726 ReadCommentedInputStream<T>(*input_file, process));
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002727 input_file->close();
2728 return result.release();
2729 }
2730
2731 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2732 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002733 template <typename T>
2734 static T* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002735 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002736 const char* input_filename,
2737 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002738 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002739 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2740 if (zip_archive.get() == nullptr) {
2741 return nullptr;
2742 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002743 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002744 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002745 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002746 zip_filename, error_msg->c_str());
2747 return nullptr;
2748 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002749 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2750 input_filename,
2751 error_msg));
2752 if (input_file.get() == nullptr) {
2753 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002754 zip_filename, error_msg->c_str());
2755 return nullptr;
2756 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002757 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2758 input_file->Size());
2759 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002760 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002761 }
2762
2763 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2764 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002765 template <typename T>
2766 static T* ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002767 std::istream& in_stream,
2768 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002769 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002770 while (in_stream.good()) {
2771 std::string dot;
2772 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08002773 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002774 continue;
2775 }
2776 if (process != nullptr) {
2777 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002778 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002779 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002780 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002781 }
2782 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002783 return output.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002784 }
2785
Mathieu Chartier49285c52014-12-02 15:43:48 -08002786 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002787 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2788 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002789 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampec560fc02014-07-16 09:57:39 -07002790 LOG(INFO) << "dex2oat took "
2791 << PrettyDuration(NanoTime() - start_ns_)
Andreas Gampecc967752016-12-12 13:49:00 -08002792 << " (" << PrettyDuration(ProcessCpuNanoTime() - start_cputime_ns_) << " cpu)"
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002793 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002794 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002795 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2796 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002797 }
2798
Jeff Haodcdc85b2015-12-04 14:06:18 -08002799 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2800 std::string res(image_filename);
2801 size_t last_slash = res.rfind('/');
2802 if (last_slash == std::string::npos || last_slash == 0) {
2803 return res;
2804 }
2805 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2806 if (penultimate_slash == std::string::npos) {
2807 return res;
2808 }
2809 // Check that the string in-between is the expected one.
2810 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2811 GetInstructionSetString(isa)) {
2812 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2813 return res;
2814 }
2815 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2816 }
2817
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002818 std::unique_ptr<CompilerOptions> compiler_options_;
2819 Compiler::Kind compiler_kind_;
2820
2821 InstructionSet instruction_set_;
2822 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2823
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002824 uint32_t image_file_location_oat_checksum_;
2825 uintptr_t image_file_location_oat_data_begin_;
2826 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002827 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2828
Vladimir Marko307dac92015-10-20 11:20:09 +01002829 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002830
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002831 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2832
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002833 std::unique_ptr<Runtime> runtime_;
2834
Calin Juravle1ce70852017-06-28 10:59:03 -07002835 // The spec describing how the class loader should be setup for compilation.
2836 std::unique_ptr<ClassLoaderContext> class_loader_context_;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002837
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002838 size_t thread_count_;
2839 uint64_t start_ns_;
Andreas Gampec560fc02014-07-16 09:57:39 -07002840 uint64_t start_cputime_ns_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002841 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002842 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002843 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002844 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002845 std::vector<const char*> oat_filenames_;
2846 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002847 int oat_fd_;
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00002848 int input_vdex_fd_;
2849 int output_vdex_fd_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002850 std::string input_vdex_;
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01002851 std::string output_vdex_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002852 std::unique_ptr<VdexFile> input_vdex_file_;
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00002853 int dm_fd_;
2854 std::string dm_file_location_;
2855 std::unique_ptr<ZipArchive> dm_file_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002856 std::vector<const char*> dex_filenames_;
2857 std::vector<const char*> dex_locations_;
2858 int zip_fd_;
2859 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002860 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002861 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002862 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002863 uintptr_t image_base_;
2864 const char* image_classes_zip_filename_;
2865 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002866 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002867 const char* compiled_classes_zip_filename_;
2868 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002869 const char* compiled_methods_zip_filename_;
2870 const char* compiled_methods_filename_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002871 const char* passes_to_run_filename_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002872 const char* dirty_image_objects_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002873 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2874 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002875 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002876 std::unique_ptr<std::unordered_set<std::string>> dirty_image_objects_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002877 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Jeff Hao436183f2016-01-12 16:36:50 -08002878 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002879 bool is_host_;
2880 std::string android_root_;
Mathieu Chartier0b490842016-05-25 15:05:59 -07002881 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002882 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002883 std::string no_inline_from_string_;
Mathieu Chartiera7f6b812017-12-11 13:34:29 -08002884 CompactDexLevel compact_dex_level_ = kDefaultCompactDexLevel;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002885
Vladimir Marko74527972016-11-29 15:57:32 +00002886 std::vector<std::unique_ptr<linker::ElfWriter>> elf_writers_;
2887 std::vector<std::unique_ptr<linker::OatWriter>> oat_writers_;
2888 std::vector<linker::OutputStream*> rodata_;
2889 std::vector<std::unique_ptr<linker::OutputStream>> vdex_out_;
2890 std::unique_ptr<linker::ImageWriter> image_writer_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002891 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002892
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002893 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
2894 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2895
Calin Juravle1ce70852017-06-28 10:59:03 -07002896 // Note that this might contain pointers owned by class_loader_context_.
Vladimir Marko47496c22016-01-27 16:15:08 +00002897 std::vector<const DexFile*> no_inline_from_dex_files_;
2898
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07002899 bool avoid_storing_invocation_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002900 std::string swap_file_name_;
2901 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002902 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2903 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002904 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002905 std::string app_image_file_name_;
2906 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002907 std::string profile_file_;
2908 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002909 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002910 TimingLogger* timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002911 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002912 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002913
2914 // Backing storage.
Andreas Gampe097f34c2017-08-23 08:57:51 -07002915 std::forward_list<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002916
Andreas Gampeace0dc12016-01-20 13:33:13 -08002917 // See CompilerOptions.force_determinism_.
2918 bool force_determinism_;
2919
Jeff Hao16d48432017-04-05 17:05:46 -07002920 // Directory of relative classpaths.
2921 std::string classpath_dir_;
2922
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00002923 // Whether the given input vdex is also the output.
2924 bool update_input_vdex_ = false;
2925
Nicolas Geoffray66ff8a82018-02-28 13:27:55 +00002926 // By default, copy the dex to the vdex file only if dex files are
2927 // compressed in APK.
2928 CopyOption copy_dex_files_ = CopyOption::kOnlyIfCompressed;
Mathieu Chartier792111c2018-02-15 13:02:15 -08002929
Calin Juravle0e09dfc2018-02-12 19:01:09 -08002930 // The reason for invoking the compiler.
2931 std::string compilation_reason_;
2932
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002933 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2934};
2935
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002936static void b13564922() {
2937#if defined(__linux__) && defined(__arm__)
2938 int major, minor;
2939 struct utsname uts;
2940 if (uname(&uts) != -1 &&
2941 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2942 ((major < 3) || ((major == 3) && (minor < 4)))) {
2943 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2944 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2945 int old_personality = personality(0xffffffff);
2946 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2947 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2948 if (new_personality == -1) {
2949 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2950 }
2951 }
2952 }
2953#endif
2954}
2955
Mathieu Chartier72041a02017-07-14 18:23:25 -07002956class ScopedGlobalRef {
2957 public:
2958 explicit ScopedGlobalRef(jobject obj) : obj_(obj) {}
2959 ~ScopedGlobalRef() {
2960 if (obj_ != nullptr) {
2961 ScopedObjectAccess soa(Thread::Current());
Ian Rogers55256cb2017-12-21 17:07:11 -08002962 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), obj_);
Mathieu Chartier72041a02017-07-14 18:23:25 -07002963 }
2964 }
2965
2966 private:
2967 jobject obj_;
2968};
2969
Andreas Gampe7b565912017-03-20 15:48:52 -07002970static dex2oat::ReturnCode CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002971 dex2oat.LoadClassProfileDescriptors();
Mathieu Chartier9e050df2017-08-09 10:05:47 -07002972 // Keep the class loader that was used for compilation live for the rest of the compilation
2973 // process.
Mathieu Chartier72041a02017-07-14 18:23:25 -07002974 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08002975
David Brazdil7b49e6c2016-09-01 11:06:18 +01002976 if (!dex2oat.WriteOutputFiles()) {
2977 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002978 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002979 }
2980
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002981 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2982 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2983 // image writer will require this fd to generate the image.
2984 if (dex2oat.ShouldKeepOatFileOpen()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002985 if (!dex2oat.FlushOutputFiles()) {
2986 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002987 return dex2oat::ReturnCode::kOther;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002988 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01002989 } else if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002990 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002991 }
2992
Jeff Haodcdc85b2015-12-04 14:06:18 -08002993 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002994 if (!dex2oat.HandleImage()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002995 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002996 }
2997
2998 // When given --host, finish early without stripping.
2999 if (dex2oat.IsHost()) {
Mathieu Chartier00bf2602017-03-02 10:14:08 -08003000 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003001 return dex2oat::ReturnCode::kOther;
Mathieu Chartier00bf2602017-03-02 10:14:08 -08003002 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08003003 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003004 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003005 }
3006
Jeff Haodcdc85b2015-12-04 14:06:18 -08003007 // Copy stripped to unstripped location, if necessary.
3008 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003009 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003010 }
3011
Jeff Haodcdc85b2015-12-04 14:06:18 -08003012 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01003013 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003014 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003015 }
3016
3017 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003018 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003019}
3020
Andreas Gampe7b565912017-03-20 15:48:52 -07003021static dex2oat::ReturnCode CompileApp(Dex2Oat& dex2oat) {
Mathieu Chartier9e050df2017-08-09 10:05:47 -07003022 // Keep the class loader that was used for compilation live for the rest of the compilation
3023 // process.
Mathieu Chartier72041a02017-07-14 18:23:25 -07003024 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08003025
David Brazdil7b49e6c2016-09-01 11:06:18 +01003026 if (!dex2oat.WriteOutputFiles()) {
3027 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07003028 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003029 }
3030
Jeff Haodcdc85b2015-12-04 14:06:18 -08003031 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08003032 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08003033
3034 // When given --host, finish early without stripping.
3035 if (dex2oat.IsHost()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003036 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003037 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003038 }
3039
3040 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003041 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003042 }
3043
Jeff Haodcdc85b2015-12-04 14:06:18 -08003044 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
3045 // stripped versions. If this is given, we expect to be able to open writable files by name.
3046 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003047 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003048 }
3049
Jeff Haodcdc85b2015-12-04 14:06:18 -08003050 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01003051 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003052 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003053 }
3054
3055 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003056 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003057}
3058
Andreas Gampe7b565912017-03-20 15:48:52 -07003059static dex2oat::ReturnCode Dex2oat(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003060 b13564922();
3061
3062 TimingLogger timings("compiler", false, false);
3063
Roland Levillain5c7e2602016-02-23 18:08:53 +00003064 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
3065 // might produce a stack frame too large for this function or for
3066 // functions inlining it (such as main), that would not fit the
3067 // requirements of the `-Wframe-larger-than` option.
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07003068 std::unique_ptr<Dex2Oat> dex2oat = std::make_unique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003069
3070 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003071 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003072
Calin Juravleb077e152016-02-18 18:47:37 +00003073 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02003074 // This operation involves I/O.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08003075 if (dex2oat->UseProfile()) {
Calin Juravleb077e152016-02-18 18:47:37 +00003076 if (!dex2oat->LoadProfile()) {
3077 LOG(ERROR) << "Failed to process profile file";
Andreas Gampe7b565912017-03-20 15:48:52 -07003078 return dex2oat::ReturnCode::kOther;
Calin Juravle998c2162015-12-21 15:39:33 +02003079 }
3080 }
3081
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00003082 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap, and vdex.
3083
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003084 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00003085 if (!dex2oat->OpenFile()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003086 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003087 }
3088
Andreas Gampe046c7062015-05-18 23:22:54 -07003089 // Print the complete line when any of the following is true:
3090 // 1) Debug build
3091 // 2) Compiling an image
3092 // 3) Compiling with --host
3093 // 4) Compiling on the host (not a target build)
3094 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003095 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07003096 LOG(INFO) << CommandLine();
3097 } else {
3098 LOG(INFO) << StrippedCommandLine();
3099 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003100
Andreas Gampef7882972017-03-20 16:35:24 -07003101 dex2oat::ReturnCode setup_code = dex2oat->Setup();
3102 if (setup_code != dex2oat::ReturnCode::kNoFailure) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003103 dex2oat->EraseOutputFiles();
Andreas Gampef7882972017-03-20 16:35:24 -07003104 return setup_code;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003105 }
3106
Shubham Ajmera188b2bf2017-09-20 15:53:35 -07003107 // TODO: Due to the cyclic dependencies, profile loading and verifying are
3108 // being done separately. Refactor and place the two next to each other.
3109 // If verification fails, we don't abort the compilation and instead log an
3110 // error.
3111 // TODO(b/62602192, b/65260586): We should consider aborting compilation when
3112 // the profile verification fails.
3113 // Note: If dex2oat fails, installd will remove the oat files causing the app
3114 // to fallback to apk with possible in-memory extraction. We want to avoid
3115 // that, and thus we're lenient towards profile corruptions.
3116 if (dex2oat->UseProfile()) {
3117 dex2oat->VerifyProfileData();
3118 }
3119
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07003120 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
3121 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07003122 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
3123
Andreas Gampe7b565912017-03-20 15:48:52 -07003124 dex2oat::ReturnCode result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00003125 if (dex2oat->IsImage()) {
3126 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08003127 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00003128 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003129 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003130
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003131 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003132}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003133} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07003134
3135int main(int argc, char** argv) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003136 int result = static_cast<int>(art::Dex2oat(argc, argv));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003137 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
Pirama Arumuga Nainarab898922018-01-04 10:37:48 -08003138 // time (bug 10645725) unless we're a debug or instrumented build or running on valgrind. Note:
3139 // The Dex2Oat class should not destruct the runtime in this case.
3140 if (!art::kIsDebugBuild && !art::kIsPGOInstrumentation && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampee286b642017-04-13 12:20:42 -07003141 _exit(result);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003142 }
3143 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07003144}