blob: 3fe9c477d5b0493d6cafadab95386d7c6ebcd25c [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"
David Sehr79e26072018-04-06 17:58:50 -070058#include "base/zip_archive.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070059#include "class_linker.h"
Calin Juravle1ce70852017-06-28 10:59:03 -070060#include "class_loader_context.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070061#include "cmdline_parser.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000062#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000063#include "compiler_callbacks.h"
David Srbecky09c2a6b2016-03-11 17:11:44 +000064#include "debug/elf_debug_writer.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000065#include "debug/method_debug_info.h"
Mathieu Chartier2c4b0842017-12-13 11:49:51 -080066#include "dexlayout.h"
David Sehrb2ec9f52018-02-21 13:20:31 -080067#include "dex/descriptors_names.h"
David Sehr9e734c72018-01-04 17:56:19 -080068#include "dex/dex_file-inl.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000069#include "dex/quick_compiler_callbacks.h"
70#include "dex/verification_results.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070071#include "dex2oat_options.h"
Andreas Gampe7b565912017-03-20 15:48:52 -070072#include "dex2oat_return_codes.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070073#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080074#include "driver/compiler_options.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070075#include "driver/compiler_options_map-inl.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080076#include "elf_file.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070077#include "gc/space/image_space.h"
78#include "gc/space/space-inl.h"
Mathieu Chartier72041a02017-07-14 18:23:25 -070079#include "gc/verification.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070080#include "interpreter/unstarted_runtime.h"
Mathieu Chartier72041a02017-07-14 18:23:25 -070081#include "java_vm_ext.h"
Calin Juravle33083d62017-01-18 15:29:12 -080082#include "jit/profile_compilation_info.h"
David Brazdil5d5a36b2016-09-14 15:34:10 +010083#include "linker/buffered_output_stream.h"
Vladimir Marko74527972016-11-29 15:57:32 +000084#include "linker/elf_writer.h"
85#include "linker/elf_writer_quick.h"
David Brazdil5d5a36b2016-09-14 15:34:10 +010086#include "linker/file_output_stream.h"
Vladimir Marko74527972016-11-29 15:57:32 +000087#include "linker/image_writer.h"
Vladimir Marko944da602016-02-19 12:27:55 +000088#include "linker/multi_oat_relative_patcher.h"
Vladimir Marko74527972016-11-29 15:57:32 +000089#include "linker/oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070090#include "mirror/class-inl.h"
91#include "mirror/class_loader.h"
92#include "mirror/object-inl.h"
93#include "mirror/object_array-inl.h"
Andreas Gampe2ff3b972017-06-05 18:14:53 -070094#include "oat_file.h"
Jeff Haob11ffb72016-04-07 15:40:54 -070095#include "oat_file_assistant.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070096#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000097#include "runtime_options.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070098#include "scoped_thread_state_change-inl.h"
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +000099#include "vdex_file.h"
David Brazdilca3c8c32016-09-06 14:04:48 +0100100#include "verifier/verifier_deps.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -0700101#include "well_known_classes.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -0700102
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.");
Mathieu Chartierf85b3db2018-04-02 18:16:21 -0700407 UsageError(" The image is non-empty only if a profile is passed in.");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700408 UsageError(" Example: --app-image-fd=10");
409 UsageError("");
410 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
411 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
412 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800413 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
414 "input dex file.");
415 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000416 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000417 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100418 UsageError(" --dump-cfg=<cfg-file>: dump control-flow graphs (CFGs) to specified file.");
419 UsageError(" Example: --dump-cfg=output.cfg");
420 UsageError("");
421 UsageError(" --dump-cfg-append: when dumping CFGs to an existing file, append new CFG data to");
422 UsageError(" existing data (instead of overwriting existing data with new data, which is");
423 UsageError(" the default behavior). This option is only meaningful when used with");
424 UsageError(" --dump-cfg.");
425 UsageError("");
Jeff Hao16d48432017-04-05 17:05:46 -0700426 UsageError(" --classpath-dir=<directory-path>: directory used to resolve relative class paths.");
427 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700428 UsageError(" --class-loader-context=<string spec>: a string specifying the intended");
429 UsageError(" runtime loading context for the compiled dex files.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700430 UsageError("");
Mathieu Chartierf5abfc42018-03-23 21:51:54 -0700431 UsageError(" --stored-class-loader-context=<string spec>: a string specifying the intended");
432 UsageError(" runtime loading context that is stored in the oat file. Overrides");
433 UsageError(" --class-loader-context. Note that this ignores the classpath_dir arg.");
434 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700435 UsageError(" It describes how the class loader chain should be built in order to ensure");
436 UsageError(" classes are resolved during dex2aot as they would be resolved at runtime.");
437 UsageError(" This spec will be encoded in the oat file. If at runtime the dex file is");
438 UsageError(" loaded in a different context, the oat file will be rejected.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700439 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700440 UsageError(" The chain is interpreted in the natural 'parent order', meaning that class");
441 UsageError(" loader 'i+1' will be the parent of class loader 'i'.");
Calin Juravlec79470d2017-07-12 17:37:42 -0700442 UsageError(" The compilation sources will be appended to the classpath of the first class");
443 UsageError(" loader.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700444 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700445 UsageError(" E.g. if the context is 'PCL[lib1.dex];DLC[lib2.dex]' and ");
446 UsageError(" --dex-file=src.dex then dex2oat will setup a PathClassLoader with classpath ");
447 UsageError(" 'lib1.dex:src.dex' and set its parent to a DelegateLastClassLoader with ");
448 UsageError(" classpath 'lib2.dex'.");
Calin Juravle1ce70852017-06-28 10:59:03 -0700449 UsageError(" ");
450 UsageError(" Note that the compiler will be tolerant if the source dex files specified");
451 UsageError(" with --dex-file are found in the classpath. The source dex files will be");
452 UsageError(" removed from any class loader's classpath possibly resulting in empty");
453 UsageError(" class loaders.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700454 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700455 UsageError(" Example: --class-loader-context=PCL[lib1.dex:lib2.dex];DLC[lib3.dex]");
Calin Juravle1ce70852017-06-28 10:59:03 -0700456 UsageError("");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700457 UsageError(" --dirty-image-objects=<directory-path>: list of known dirty objects in the image.");
458 UsageError(" The image writer will group them together.");
459 UsageError("");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700460 UsageError(" --compact-dex-level=none|fast: None avoids generating compact dex, fast");
Mathieu Chartierddf39552018-04-03 10:22:27 -0700461 UsageError(" generates compact dex with low compile time. If speed-profile is specified as");
462 UsageError(" the compiler filter and the profile is not empty, the default compact dex");
463 UsageError(" level is always used.");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700464 UsageError("");
Andreas Gampee20ff6f2017-11-07 15:00:35 -0800465 UsageError(" --deduplicate-code=true|false: enable|disable code deduplication. Deduplicated");
466 UsageError(" code will have an arbitrary symbol tagged with [DEDUPED].");
Andreas Gampecac31ad2017-11-06 20:01:17 -0800467 UsageError("");
Nicolas Geoffray66ff8a82018-02-28 13:27:55 +0000468 UsageError(" --copy-dex-files=true|false: enable|disable copying the dex files into the");
Mathieu Chartier792111c2018-02-15 13:02:15 -0800469 UsageError(" output vdex.");
470 UsageError("");
Calin Juravle0e09dfc2018-02-12 19:01:09 -0800471 UsageError(" --compilation-reason=<string>: optional metadata specifying the reason for");
472 UsageError(" compiling the apk. If specified, the string will be embedded verbatim in");
473 UsageError(" the key value store of the oat file.");
474 UsageError("");
475 UsageError(" Example: --compilation-reason=install");
476 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700477 std::cerr << "See log for usage error information\n";
478 exit(EXIT_FAILURE);
479}
480
Brian Carlstrom7940e442013-07-12 13:46:57 -0700481// The primary goal of the watchdog is to prevent stuck build servers
482// during development when fatal aborts lead to a cascade of failures
483// that result in a deadlock.
484class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800485// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700486#undef CHECK_PTHREAD_CALL
487#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
488 do { \
489 int rc = call args; \
490 if (rc != 0) { \
491 errno = rc; \
492 std::string message(# call); \
493 message += " failed for "; \
494 message += reason; \
495 Fatal(message); \
496 } \
497 } while (false)
498
499 public:
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800500 explicit WatchDog(int64_t timeout_in_milliseconds)
Andreas Gampe0f54b0d2017-12-27 08:37:02 -0800501 : timeout_in_milliseconds_(timeout_in_milliseconds),
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800502 shutting_down_(false) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700503 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700504 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800505#ifndef __APPLE__
506 pthread_condattr_t condattr;
liulvping8f7101e2017-01-16 15:14:43 +0800507 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_init, (&condattr), reason);
508 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_setclock, (&condattr, CLOCK_MONOTONIC), reason);
509 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, &condattr), reason);
510 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_destroy, (&condattr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800511#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700512 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
513 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
514 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
515 }
516 ~WatchDog() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700517 const char* reason = "dex2oat watch dog thread shutdown";
518 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
519 shutting_down_ = true;
520 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
521 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
522
Kenny Root51316382014-05-13 14:59:37 -0700523 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700524
525 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
526 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
527 }
528
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800529 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
530 // large.
531 static constexpr int64_t kWatchdogVerifyMultiplier =
532 kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
533
534 // When setting timeouts, keep in mind that the build server may not be as fast as your
535 // desktop. Debug builds are slower so they have larger timeouts.
536 static constexpr int64_t kWatchdogSlowdownFactor = kIsDebugBuild ? 5U : 1U;
537
538 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
539 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
540 // itself before that watchdog would take down the system server.
541 static constexpr int64_t kWatchDogTimeoutSeconds = kWatchdogSlowdownFactor * (9 * 60 + 30);
542
543 static constexpr int64_t kDefaultWatchdogTimeoutInMS =
544 kWatchdogVerifyMultiplier * kWatchDogTimeoutSeconds * 1000;
545
Brian Carlstrom7940e442013-07-12 13:46:57 -0700546 private:
547 static void* CallBack(void* arg) {
548 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
549 ::art::SetThreadName("dex2oat watch dog");
550 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700551 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700552 }
553
Andreas Gampe794ad762015-02-23 08:12:24 -0800554 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700555 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
556 // it's rather easy to hang in unwinding.
557 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
558 // logcat logging or stderr output.
Tomasz Wasilczyk8d840902017-12-20 08:19:53 -0800559 LogHelper::LogLineLowStack(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
560
Andreas Gampe48fde372017-06-06 07:43:46 -0700561 // If we're on the host, try to dump all threads to get a sense of what's going on. This is
562 // restricted to the host as the dump may itself go bad.
563 // TODO: Use a double watchdog timeout, so we can enable this on-device.
564 if (!kIsTargetBuild && Runtime::Current() != nullptr) {
Andreas Gampecd607312017-06-05 17:03:05 -0700565 Runtime::Current()->AttachCurrentThread("Watchdog thread attached for dumping",
566 true,
567 nullptr,
568 false);
569 Runtime::Current()->DumpForSigQuit(std::cerr);
570 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700571 exit(1);
572 }
573
574 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700575 timespec timeout_ts;
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800576#if defined(__APPLE__)
577 InitTimeSpec(true, CLOCK_REALTIME, timeout_in_milliseconds_, 0, &timeout_ts);
578#else
liulvping8f7101e2017-01-16 15:14:43 +0800579 InitTimeSpec(true, CLOCK_MONOTONIC, timeout_in_milliseconds_, 0, &timeout_ts);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800580#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700581 const char* reason = "dex2oat watch dog thread waiting";
582 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
583 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800584 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700585 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700586 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800587 timeout_in_milliseconds_/1000));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700588 } else if (rc != 0) {
589 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
590 strerror(errno)));
591 Fatal(message.c_str());
592 }
593 }
594 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
595 }
596
Brian Carlstrom7940e442013-07-12 13:46:57 -0700597 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
598 pthread_mutex_t mutex_;
599 pthread_cond_t cond_;
600 pthread_attr_t attr_;
601 pthread_t pthread_;
Andreas Gampef45d61c2017-06-07 10:29:33 -0700602
603 const int64_t timeout_in_milliseconds_;
604 bool shutting_down_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700605};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700606
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800607class Dex2Oat FINAL {
608 public:
609 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100610 compiler_kind_(Compiler::kOptimizing),
Vladimir Marko33bff252017-11-01 14:35:42 +0000611 instruction_set_(kRuntimeISA == InstructionSet::kArm ? InstructionSet::kThumb2 : kRuntimeISA),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800612 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000613 image_file_location_oat_checksum_(0),
614 image_file_location_oat_data_begin_(0),
615 image_patch_delta_(0),
616 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700617 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800618 runtime_(nullptr),
619 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
620 start_ns_(NanoTime()),
Andreas Gampec560fc02014-07-16 09:57:39 -0700621 start_cputime_ns_(ProcessCpuNanoTime()),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800622 oat_fd_(-1),
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000623 input_vdex_fd_(-1),
624 output_vdex_fd_(-1),
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000625 input_vdex_file_(nullptr),
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +0000626 dm_fd_(-1),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800627 zip_fd_(-1),
628 image_base_(0U),
629 image_classes_zip_filename_(nullptr),
630 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800631 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700632 passes_to_run_filename_(nullptr),
Mathieu Chartierff0baff2017-08-02 23:04:19 -0700633 dirty_image_objects_filename_(nullptr),
Jeff Hao436183f2016-01-12 16:36:50 -0800634 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800635 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000636 elf_writers_(),
637 oat_writers_(),
638 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000639 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700640 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000641 opened_dex_files_maps_(),
642 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000643 no_inline_from_dex_files_(),
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700644 avoid_storing_invocation_(false),
Calin Juravle2e2db782016-02-23 12:00:03 +0000645 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800646 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000647 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800648 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000649 force_determinism_(false)
650 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800651
652 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800653 // Log completion time before deleting the runtime_, because this accesses
654 // the runtime.
655 LogCompletionTime();
656
Vladimir Marko307dac92015-10-20 11:20:09 +0100657 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
658 // We want to just exit on non-debug builds, not bringing the runtime down
659 // in an orderly fashion. So release the following fields.
660 driver_.release();
661 image_writer_.release();
662 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
663 dex_file.release();
664 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000665 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
666 map.release();
667 }
David Brazdil7b49e6c2016-09-01 11:06:18 +0100668 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
669 vdex_file.release();
670 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800671 for (std::unique_ptr<File>& oat_file : oat_files_) {
672 oat_file.release();
673 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100674 runtime_.release();
675 verification_results_.release();
676 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100677 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700678 }
679
Roland Levillain9ec5e222015-08-17 20:18:41 +0100680 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800681 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800682 std::string boot_image_filename;
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800683 int64_t watch_dog_timeout_in_ms = -1;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800684 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000685 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800686 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100687 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800688
Andreas Gampe097f34c2017-08-23 08:57:51 -0700689 void ParseBase(const std::string& option) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100690 char* end;
Andreas Gampe097f34c2017-08-23 08:57:51 -0700691 image_base_ = strtoul(option.c_str(), &end, 16);
692 if (end == option.c_str() || *end != '\0') {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100693 Usage("Failed to parse hexadecimal value for option %s", option.data());
694 }
695 }
696
Shubham Ajmera188b2bf2017-09-20 15:53:35 -0700697 bool VerifyProfileData() {
698 return profile_compilation_info_->VerifyProfileData(dex_files_);
699 }
700
Andreas Gampe097f34c2017-08-23 08:57:51 -0700701 void ParseInstructionSetVariant(const std::string& option, ParserOptions* parser_options) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800702 instruction_set_features_ = InstructionSetFeatures::FromVariant(
Andreas Gampe097f34c2017-08-23 08:57:51 -0700703 instruction_set_, option, &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100704 if (instruction_set_features_.get() == nullptr) {
705 Usage("%s", parser_options->error_msg.c_str());
706 }
707 }
708
Andreas Gampe097f34c2017-08-23 08:57:51 -0700709 void ParseInstructionSetFeatures(const std::string& option, ParserOptions* parser_options) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800710 if (instruction_set_features_ == nullptr) {
711 instruction_set_features_ = InstructionSetFeatures::FromVariant(
712 instruction_set_, "default", &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100713 if (instruction_set_features_.get() == nullptr) {
714 Usage("Problem initializing default instruction set features variant: %s",
715 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700716 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800717 }
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800718 instruction_set_features_ =
Andreas Gampe097f34c2017-08-23 08:57:51 -0700719 instruction_set_features_->AddFeaturesFromString(option, &parser_options->error_msg);
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800720 if (instruction_set_features_ == nullptr) {
Andreas Gampe097f34c2017-08-23 08:57:51 -0700721 Usage("Error parsing '%s': %s", option.c_str(), parser_options->error_msg.c_str());
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800722 }
723 }
724
Jeff Hao436183f2016-01-12 16:36:50 -0800725 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoaad75c62016-10-03 08:46:48 +0000726 compiler_options_->boot_image_ = !image_filenames_.empty();
727 compiler_options_->app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700728
Roland Levillain2b03a1f2017-06-06 16:09:59 +0100729 if (IsBootImage() && image_filenames_.size() == 1) {
730 const std::string& boot_image_filename = image_filenames_[0];
731 compiler_options_->core_image_ = CompilerDriver::IsCoreImageFilename(boot_image_filename);
732 }
733
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700734 if (IsAppImage() && IsBootImage()) {
735 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
736 }
737
Jeff Haodcdc85b2015-12-04 14:06:18 -0800738 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800739 Usage("Output must be supplied with either --oat-file or --oat-fd");
740 }
741
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000742 if (input_vdex_fd_ != -1 && !input_vdex_.empty()) {
743 Usage("Can't have both --input-vdex-fd and --input-vdex");
744 }
745
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +0100746 if (output_vdex_fd_ != -1 && !output_vdex_.empty()) {
747 Usage("Can't have both --output-vdex-fd and --output-vdex");
748 }
749
Jeff Haodcdc85b2015-12-04 14:06:18 -0800750 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800751 Usage("--oat-file should not be used with --oat-fd");
752 }
753
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000754 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
Sascha Roth5f71c652018-04-10 00:27:15 +0200755 Usage("VDEX and OAT output must be specified either with one --oat-file "
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000756 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100757 }
758
Roland Levillain9ec5e222015-08-17 20:18:41 +0100759 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800760 Usage("--oat-symbols should not be used with --oat-fd");
761 }
762
Roland Levillain9ec5e222015-08-17 20:18:41 +0100763 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800764 Usage("--oat-symbols should not be used with --host");
765 }
766
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000767 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
768 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100769 }
770
Jeff Haodcdc85b2015-12-04 14:06:18 -0800771 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800772 Usage("--oat-fd should not be used with --image");
773 }
774
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +0000775 if ((input_vdex_fd_ != -1 || !input_vdex_.empty()) &&
776 (dm_fd_ != -1 || !dm_file_location_.empty())) {
777 Usage("An input vdex should not be passed with a .dm file");
778 }
779
Jeff Haodcdc85b2015-12-04 14:06:18 -0800780 if (!parser_options->oat_symbols.empty() &&
781 parser_options->oat_symbols.size() != oat_filenames_.size()) {
782 Usage("--oat-file arguments do not match --oat-symbols arguments");
783 }
784
785 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
786 Usage("--oat-file arguments do not match --image arguments");
787 }
788
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800789 if (android_root_.empty()) {
790 const char* android_root_env_var = getenv("ANDROID_ROOT");
791 if (android_root_env_var == nullptr) {
792 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700793 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800794 android_root_ += android_root_env_var;
795 }
796
Vladimir Markoaad75c62016-10-03 08:46:48 +0000797 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100798 parser_options->boot_image_filename += android_root_;
799 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800800 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100801 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000802 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800803 }
804
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700805 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800806 Usage("--image-classes should only be used with --image");
807 }
808
Vladimir Marko49b0f452015-12-10 13:49:19 +0000809 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800810 Usage("--image-classes should not be used with --boot-image");
811 }
812
813 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
814 Usage("--image-classes-zip should be used with --image-classes");
815 }
816
817 if (dex_filenames_.empty() && zip_fd_ == -1) {
818 Usage("Input must be supplied with either --dex-file or --zip-fd");
819 }
820
821 if (!dex_filenames_.empty() && zip_fd_ != -1) {
822 Usage("--dex-file should not be used with --zip-fd");
823 }
824
825 if (!dex_filenames_.empty() && !zip_location_.empty()) {
826 Usage("--dex-file should not be used with --zip-location");
827 }
828
829 if (dex_locations_.empty()) {
830 for (const char* dex_file_name : dex_filenames_) {
831 dex_locations_.push_back(dex_file_name);
832 }
833 } else if (dex_locations_.size() != dex_filenames_.size()) {
834 Usage("--dex-location arguments do not match --dex-file arguments");
835 }
836
Jeff Haodcdc85b2015-12-04 14:06:18 -0800837 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
838 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
839 Usage("--oat-file arguments must be singular or match --dex-file arguments");
840 }
841 }
842
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800843 if (zip_fd_ != -1 && zip_location_.empty()) {
844 Usage("--zip-location should be supplied with --zip-fd");
845 }
846
Vladimir Marko49b0f452015-12-10 13:49:19 +0000847 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800848 if (image_base_ == 0) {
849 Usage("Non-zero --base not specified");
850 }
851 }
852
Mathieu Chartiera8077802016-03-16 19:08:31 -0700853 const bool have_profile_file = !profile_file_.empty();
854 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
855 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000856 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200857 }
858
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -0700859 if (have_profile_file || have_profile_fd) {
Andreas Gampebd600e32018-04-12 14:25:39 -0700860 if (image_classes_filename_ != nullptr ||
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -0700861 image_classes_zip_filename_ != nullptr) {
862 Usage("Profile based image creation is not supported with image or compiled classes");
863 }
864 }
865
Roland Levillain9ec5e222015-08-17 20:18:41 +0100866 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800867 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800868 }
869
870 // If no instruction set feature was given, use the default one for the target
871 // instruction set.
872 if (instruction_set_features_.get() == nullptr) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800873 instruction_set_features_ = InstructionSetFeatures::FromVariant(
874 instruction_set_, "default", &parser_options->error_msg);
Ian Rogersd582fa42014-11-05 23:46:43 -0800875 if (instruction_set_features_.get() == nullptr) {
876 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100877 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800878 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800879 }
880
881 if (instruction_set_ == kRuntimeISA) {
882 std::unique_ptr<const InstructionSetFeatures> runtime_features(
883 InstructionSetFeatures::FromCppDefines());
884 if (!instruction_set_features_->Equals(runtime_features.get())) {
885 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
886 << *instruction_set_features_ << ") and those of dex2oat executable ("
887 << *runtime_features <<") for the command line:\n"
888 << CommandLine();
889 }
890 }
891
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000892 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +0000893 compiler_options_->inline_max_code_units_ = CompilerOptions::kDefaultInlineMaxCodeUnits;
Roland Levillaina215b952015-08-07 11:38:32 +0100894 }
895
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800896 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800897 // Set the compilation target's implicit checks options.
898 switch (instruction_set_) {
Vladimir Marko33bff252017-11-01 14:35:42 +0000899 case InstructionSet::kArm:
900 case InstructionSet::kThumb2:
901 case InstructionSet::kArm64:
902 case InstructionSet::kX86:
903 case InstructionSet::kX86_64:
904 case InstructionSet::kMips:
905 case InstructionSet::kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000906 compiler_options_->implicit_null_checks_ = true;
907 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800908 break;
909
910 default:
911 // Defaults are correct.
912 break;
913 }
914
Jeff Hao436183f2016-01-12 16:36:50 -0800915 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800916 Usage("--multi-image can only be used when creating boot images");
917 }
Jeff Hao436183f2016-01-12 16:36:50 -0800918 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800919 Usage("--multi-image cannot be used with multiple image names");
920 }
921
922 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
923 if (!kIsTargetBuild && IsBootImage()) {
924 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800925 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800926 }
927 }
928
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800929 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100930 if (parser_options->watch_dog_enabled) {
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800931 int64_t timeout = parser_options->watch_dog_timeout_in_ms > 0
932 ? parser_options->watch_dog_timeout_in_ms
933 : WatchDog::kDefaultWatchdogTimeoutInMS;
934 watchdog_.reset(new WatchDog(timeout));
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800935 }
936
937 // Fill some values into the key-value store for the oat header.
938 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800939
Roland Levillainb81e9e92017-04-20 17:35:32 +0100940 // Automatically force determinism for the boot image in a host build if read barriers
941 // are enabled, or if the default GC is CMS or MS. When the default GC is CMS
942 // (Concurrent Mark-Sweep), the GC is switched to a non-concurrent one by passing the
943 // option `-Xgc:nonconcurrent` (see below).
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800944 if (!kIsTargetBuild && IsBootImage()) {
945 if (SupportsDeterministicCompilation()) {
946 force_determinism_ = true;
947 } else {
948 LOG(WARNING) << "Deterministic compilation is disabled.";
949 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800950 }
951 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700952
953 if (passes_to_run_filename_ != nullptr) {
954 passes_to_run_.reset(ReadCommentedInputFromFile<std::vector<std::string>>(
955 passes_to_run_filename_,
956 nullptr)); // No post-processing.
957 if (passes_to_run_.get() == nullptr) {
958 Usage("Failed to read list of passes to run.");
959 }
960 }
961 compiler_options_->passes_to_run_ = passes_to_run_.get();
Roland Levillain9ec5e222015-08-17 20:18:41 +0100962 }
963
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800964 static bool SupportsDeterministicCompilation() {
Roland Levillainb81e9e92017-04-20 17:35:32 +0100965 return (kUseReadBarrier ||
966 gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
967 gc::kCollectorTypeDefault == gc::kCollectorTypeMS);
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800968 }
969
Jeff Hao436183f2016-01-12 16:36:50 -0800970 void ExpandOatAndImageFilenames() {
971 std::string base_oat = oat_filenames_[0];
972 size_t last_oat_slash = base_oat.rfind('/');
973 if (last_oat_slash == std::string::npos) {
974 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
975 }
976 // We also need to honor path components that were encoded through '@'. Otherwise the loading
977 // code won't be able to find the images.
978 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
979 last_oat_slash = base_oat.rfind('@');
980 }
981 base_oat = base_oat.substr(0, last_oat_slash + 1);
982
983 std::string base_img = image_filenames_[0];
984 size_t last_img_slash = base_img.rfind('/');
985 if (last_img_slash == std::string::npos) {
986 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
987 }
988 // We also need to honor path components that were encoded through '@'. Otherwise the loading
989 // code won't be able to find the images.
990 if (base_img.find('@', last_img_slash) != std::string::npos) {
991 last_img_slash = base_img.rfind('@');
992 }
993
994 // Get the prefix, which is the primary image name (without path components). Strip the
995 // extension.
996 std::string prefix = base_img.substr(last_img_slash + 1);
997 if (prefix.rfind('.') != std::string::npos) {
998 prefix = prefix.substr(0, prefix.rfind('.'));
999 }
1000 if (!prefix.empty()) {
1001 prefix = prefix + "-";
1002 }
1003
1004 base_img = base_img.substr(0, last_img_slash + 1);
1005
1006 // Note: we have some special case here for our testing. We have to inject the differentiating
1007 // parts for the different core images.
1008 std::string infix; // Empty infix by default.
1009 {
1010 // Check the first name.
1011 std::string dex_file = oat_filenames_[0];
1012 size_t last_dex_slash = dex_file.rfind('/');
1013 if (last_dex_slash != std::string::npos) {
1014 dex_file = dex_file.substr(last_dex_slash + 1);
1015 }
1016 size_t last_dex_dot = dex_file.rfind('.');
1017 if (last_dex_dot != std::string::npos) {
1018 dex_file = dex_file.substr(0, last_dex_dot);
1019 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001020 if (android::base::StartsWith(dex_file, "core-")) {
Jeff Hao436183f2016-01-12 16:36:50 -08001021 infix = dex_file.substr(strlen("core"));
1022 }
1023 }
1024
bowen_lai8bd36c02016-10-12 13:28:55 +08001025 std::string base_symbol_oat;
1026 if (!oat_unstripped_.empty()) {
1027 base_symbol_oat = oat_unstripped_[0];
1028 size_t last_symbol_oat_slash = base_symbol_oat.rfind('/');
1029 if (last_symbol_oat_slash == std::string::npos) {
1030 Usage("--multi-image used with unusable symbol filename %s", base_symbol_oat.c_str());
1031 }
1032 base_symbol_oat = base_symbol_oat.substr(0, last_symbol_oat_slash + 1);
1033 }
1034
Jeff Hao436183f2016-01-12 16:36:50 -08001035 // Now create the other names. Use a counted loop to skip the first one.
1036 for (size_t i = 1; i < dex_locations_.size(); ++i) {
1037 // TODO: Make everything properly std::string.
1038 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
Andreas Gampe097f34c2017-08-23 08:57:51 -07001039 char_backing_storage_.push_front(base_img + image_name);
1040 image_filenames_.push_back(char_backing_storage_.front().c_str());
Jeff Hao436183f2016-01-12 16:36:50 -08001041
1042 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
Andreas Gampe097f34c2017-08-23 08:57:51 -07001043 char_backing_storage_.push_front(base_oat + oat_name);
1044 oat_filenames_.push_back(char_backing_storage_.front().c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001045
1046 if (!base_symbol_oat.empty()) {
Andreas Gampe097f34c2017-08-23 08:57:51 -07001047 char_backing_storage_.push_front(base_symbol_oat + oat_name);
1048 oat_unstripped_.push_back(char_backing_storage_.front().c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001049 }
Jeff Hao436183f2016-01-12 16:36:50 -08001050 }
1051 }
1052
Andreas Gampe8994a042015-12-30 19:03:17 +00001053 // Modify the input string in the following way:
1054 // 0) Assume input is /a/b/c.d
1055 // 1) Strip the path -> c.d
1056 // 2) Inject prefix p -> pc.d
1057 // 3) Inject infix i -> pci.d
1058 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -08001059 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +00001060 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001061 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +00001062 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001063 size_t last_dex_slash = in.rfind('/');
1064 if (last_dex_slash != std::string::npos) {
1065 in = in.substr(last_dex_slash + 1);
1066 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001067 if (!prefix.empty()) {
1068 in = prefix + in;
1069 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001070 if (!infix.empty()) {
1071 // Inject infix.
1072 size_t last_dot = in.rfind('.');
1073 if (last_dot != std::string::npos) {
1074 in.insert(last_dot, infix);
1075 }
1076 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001077 if (android::base::EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001078 in = in.substr(0, in.length() - strlen(".jar")) +
1079 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001080 }
1081 return in;
1082 }
1083
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001084 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001085 std::ostringstream oss;
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001086 if (!avoid_storing_invocation_) {
1087 for (int i = 0; i < argc; ++i) {
1088 if (i > 0) {
1089 oss << ' ';
1090 }
1091 oss << argv[i];
Roland Levillain9ec5e222015-08-17 20:18:41 +01001092 }
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001093 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1094 oss.str(""); // Reset.
Roland Levillain9ec5e222015-08-17 20:18:41 +01001095 }
Roland Levillain9ec5e222015-08-17 20:18:41 +01001096 oss << kRuntimeISA;
1097 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1098 key_value_store_->Put(
1099 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001100 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001101 key_value_store_->Put(
1102 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001103 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001104 key_value_store_->Put(
1105 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001106 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001107 key_value_store_->Put(OatHeader::kCompilerFilter,
1108 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Andreas Gampef8cd8902017-01-18 16:05:01 -08001109 key_value_store_->Put(OatHeader::kConcurrentCopying,
1110 kUseReadBarrier ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001111 }
1112
Andreas Gampe097f34c2017-08-23 08:57:51 -07001113 // This simple forward is here so the string specializations below don't look out of place.
1114 template <typename T, typename U>
1115 void AssignIfExists(Dex2oatArgumentMap& map,
1116 const Dex2oatArgumentMap::Key<T>& key,
1117 U* out) {
1118 map.AssignIfExists(key, out);
1119 }
1120
1121 // Specializations to handle const char* vs std::string.
1122 void AssignIfExists(Dex2oatArgumentMap& map,
1123 const Dex2oatArgumentMap::Key<std::string>& key,
1124 const char** out) {
1125 if (map.Exists(key)) {
1126 char_backing_storage_.push_front(std::move(*map.Get(key)));
1127 *out = char_backing_storage_.front().c_str();
1128 }
1129 }
1130 void AssignIfExists(Dex2oatArgumentMap& map,
1131 const Dex2oatArgumentMap::Key<std::vector<std::string>>& key,
1132 std::vector<const char*>* out) {
1133 if (map.Exists(key)) {
1134 for (auto& val : *map.Get(key)) {
1135 char_backing_storage_.push_front(std::move(val));
1136 out->push_back(char_backing_storage_.front().c_str());
1137 }
1138 }
1139 }
1140
1141 template <typename T>
1142 void AssignTrueIfExists(Dex2oatArgumentMap& map,
1143 const Dex2oatArgumentMap::Key<T>& key,
1144 bool* out) {
1145 if (map.Exists(key)) {
1146 *out = true;
1147 }
1148 }
1149
Roland Levillain9ec5e222015-08-17 20:18:41 +01001150 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1151 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1152 // returns, arguments have been successfully parsed.
1153 void ParseArgs(int argc, char** argv) {
1154 original_argc = argc;
1155 original_argv = argv;
1156
David Sehrc431b9d2018-03-02 12:01:51 -08001157 Locks::Init();
Andreas Gampe51d80cc2017-06-21 21:05:13 -07001158 InitLogging(argv, Runtime::Abort);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001159
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001160 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001161
Andreas Gampe097f34c2017-08-23 08:57:51 -07001162 using M = Dex2oatArgumentMap;
1163 std::string error_msg;
1164 std::unique_ptr<M> args_uptr = M::Parse(argc, const_cast<const char**>(argv), &error_msg);
1165 if (args_uptr == nullptr) {
1166 Usage("Failed to parse command line: %s", error_msg.c_str());
1167 UNREACHABLE();
1168 }
1169
1170 M& args = *args_uptr;
1171
1172 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
1173
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07001174 AssignIfExists(args, M::CompactDexLevel, &compact_dex_level_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001175 AssignIfExists(args, M::DexFiles, &dex_filenames_);
1176 AssignIfExists(args, M::DexLocations, &dex_locations_);
1177 AssignIfExists(args, M::OatFiles, &oat_filenames_);
1178 AssignIfExists(args, M::OatSymbols, &parser_options->oat_symbols);
1179 AssignIfExists(args, M::ImageFilenames, &image_filenames_);
1180 AssignIfExists(args, M::ZipFd, &zip_fd_);
1181 AssignIfExists(args, M::ZipLocation, &zip_location_);
1182 AssignIfExists(args, M::InputVdexFd, &input_vdex_fd_);
1183 AssignIfExists(args, M::OutputVdexFd, &output_vdex_fd_);
1184 AssignIfExists(args, M::InputVdex, &input_vdex_);
1185 AssignIfExists(args, M::OutputVdex, &output_vdex_);
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001186 AssignIfExists(args, M::DmFd, &dm_fd_);
1187 AssignIfExists(args, M::DmFile, &dm_file_location_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001188 AssignIfExists(args, M::OatFd, &oat_fd_);
1189 AssignIfExists(args, M::OatLocation, &oat_location_);
1190 AssignIfExists(args, M::Watchdog, &parser_options->watch_dog_enabled);
1191 AssignIfExists(args, M::WatchdogTimeout, &parser_options->watch_dog_timeout_in_ms);
1192 AssignIfExists(args, M::Threads, &thread_count_);
1193 AssignIfExists(args, M::ImageClasses, &image_classes_filename_);
1194 AssignIfExists(args, M::ImageClassesZip, &image_classes_zip_filename_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001195 AssignIfExists(args, M::Passes, &passes_to_run_filename_);
1196 AssignIfExists(args, M::BootImage, &parser_options->boot_image_filename);
1197 AssignIfExists(args, M::AndroidRoot, &android_root_);
1198 AssignIfExists(args, M::Profile, &profile_file_);
1199 AssignIfExists(args, M::ProfileFd, &profile_file_fd_);
1200 AssignIfExists(args, M::RuntimeOptions, &runtime_args_);
1201 AssignIfExists(args, M::SwapFile, &swap_file_name_);
1202 AssignIfExists(args, M::SwapFileFd, &swap_fd_);
1203 AssignIfExists(args, M::SwapDexSizeThreshold, &min_dex_file_cumulative_size_for_swap_);
1204 AssignIfExists(args, M::SwapDexCountThreshold, &min_dex_files_for_swap_);
1205 AssignIfExists(args, M::VeryLargeAppThreshold, &very_large_threshold_);
1206 AssignIfExists(args, M::AppImageFile, &app_image_file_name_);
1207 AssignIfExists(args, M::AppImageFileFd, &app_image_fd_);
1208 AssignIfExists(args, M::NoInlineFrom, &no_inline_from_string_);
1209 AssignIfExists(args, M::ClasspathDir, &classpath_dir_);
1210 AssignIfExists(args, M::DirtyImageObjects, &dirty_image_objects_filename_);
1211 AssignIfExists(args, M::ImageFormat, &image_storage_mode_);
Calin Juravle0e09dfc2018-02-12 19:01:09 -08001212 AssignIfExists(args, M::CompilationReason, &compilation_reason_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001213
1214 AssignIfExists(args, M::Backend, &compiler_kind_);
1215 parser_options->requested_specific_compiler = args.Exists(M::Backend);
1216
1217 AssignIfExists(args, M::TargetInstructionSet, &instruction_set_);
1218 // arm actually means thumb2.
1219 if (instruction_set_ == InstructionSet::kArm) {
1220 instruction_set_ = InstructionSet::kThumb2;
1221 }
1222
1223 AssignTrueIfExists(args, M::Host, &is_host_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001224 AssignTrueIfExists(args, M::AvoidStoringInvocation, &avoid_storing_invocation_);
1225 AssignTrueIfExists(args, M::MultiImage, &multi_image_);
Mathieu Chartier792111c2018-02-15 13:02:15 -08001226 AssignIfExists(args, M::CopyDexFiles, &copy_dex_files_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001227
1228 if (args.Exists(M::ForceDeterminism)) {
1229 if (!SupportsDeterministicCompilation()) {
1230 Usage("Option --force-determinism requires read barriers or a CMS/MS garbage collector");
Roland Levillain9ec5e222015-08-17 20:18:41 +01001231 }
Andreas Gampe097f34c2017-08-23 08:57:51 -07001232 force_determinism_ = true;
1233 }
1234
1235 if (args.Exists(M::Base)) {
1236 ParseBase(*args.Get(M::Base));
1237 }
1238 if (args.Exists(M::TargetInstructionSetVariant)) {
1239 ParseInstructionSetVariant(*args.Get(M::TargetInstructionSetVariant), parser_options.get());
1240 }
1241 if (args.Exists(M::TargetInstructionSetFeatures)) {
1242 ParseInstructionSetFeatures(*args.Get(M::TargetInstructionSetFeatures), parser_options.get());
1243 }
1244 if (args.Exists(M::ClassLoaderContext)) {
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001245 std::string class_loader_context_arg = *args.Get(M::ClassLoaderContext);
1246 class_loader_context_ = ClassLoaderContext::Create(class_loader_context_arg);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001247 if (class_loader_context_ == nullptr) {
1248 Usage("Option --class-loader-context has an incorrect format: %s",
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001249 class_loader_context_arg.c_str());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001250 }
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001251 if (args.Exists(M::StoredClassLoaderContext)) {
Mathieu Chartierc4440772018-04-16 14:40:56 -07001252 const std::string stored_context_arg = *args.Get(M::StoredClassLoaderContext);
1253 stored_class_loader_context_ = ClassLoaderContext::Create(stored_context_arg);
1254 if (stored_class_loader_context_ == nullptr) {
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001255 Usage("Option --stored-class-loader-context has an incorrect format: %s",
Mathieu Chartierc4440772018-04-16 14:40:56 -07001256 stored_context_arg.c_str());
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001257 } else if (!class_loader_context_->VerifyClassLoaderContextMatch(
Mathieu Chartierc4440772018-04-16 14:40:56 -07001258 stored_context_arg,
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001259 /*verify_names*/ false,
1260 /*verify_checksums*/ false)) {
1261 Usage(
1262 "Option --stored-class-loader-context '%s' mismatches --class-loader-context '%s'",
Mathieu Chartierc4440772018-04-16 14:40:56 -07001263 stored_context_arg.c_str(),
1264 class_loader_context_arg.c_str());
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001265 }
1266 }
1267 } else if (args.Exists(M::StoredClassLoaderContext)) {
1268 Usage("Option --stored-class-loader-context should only be used if "
1269 "--class-loader-context is also specified");
Roland Levillain9ec5e222015-08-17 20:18:41 +01001270 }
1271
Andreas Gampe097f34c2017-08-23 08:57:51 -07001272 if (!ReadCompilerOptions(args, compiler_options_.get(), &error_msg)) {
1273 Usage(error_msg.c_str());
1274 }
1275
Jeff Hao436183f2016-01-12 16:36:50 -08001276 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001277
1278 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001279 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001280 }
1281
Jeff Haodcdc85b2015-12-04 14:06:18 -08001282 // Check whether the oat output files are writable, and open them for later. Also open a swap
1283 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001284 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001285 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1286 PruneNonExistentDexFiles();
1287
Jeff Hao436183f2016-01-12 16:36:50 -08001288 // Expand oat and image filenames for multi image.
1289 if (IsBootImage() && multi_image_) {
1290 ExpandOatAndImageFilenames();
1291 }
1292
David Brazdil7b49e6c2016-09-01 11:06:18 +01001293 // OAT and VDEX file handling
David Brazdil7b49e6c2016-09-01 11:06:18 +01001294 if (oat_fd_ == -1) {
1295 DCHECK(!oat_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08001296 for (const char* oat_filename : oat_filenames_) {
1297 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
Calin Juravleb09be722017-09-25 16:42:48 -07001298 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001299 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1300 return false;
1301 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001302 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001303 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1304 oat_file->Erase();
1305 return false;
1306 }
1307 oat_files_.push_back(std::move(oat_file));
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001308 DCHECK_EQ(input_vdex_fd_, -1);
1309 if (!input_vdex_.empty()) {
1310 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001311 input_vdex_file_ = VdexFile::Open(input_vdex_,
1312 /* writable */ false,
1313 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001314 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001315 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001316 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001317
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001318 DCHECK_EQ(output_vdex_fd_, -1);
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001319 std::string vdex_filename = output_vdex_.empty()
1320 ? ReplaceFileExtension(oat_filename, "vdex")
1321 : output_vdex_;
1322 if (vdex_filename == input_vdex_ && output_vdex_.empty()) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001323 update_input_vdex_ = true;
1324 std::unique_ptr<File> vdex_file(OS::OpenFileReadWrite(vdex_filename.c_str()));
1325 vdex_files_.push_back(std::move(vdex_file));
1326 } else {
1327 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
Calin Juravleb09be722017-09-25 16:42:48 -07001328 if (vdex_file == nullptr) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001329 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1330 return false;
1331 }
1332 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1333 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1334 vdex_file->Erase();
1335 return false;
1336 }
1337 vdex_files_.push_back(std::move(vdex_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001338 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001339 }
1340 } else {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001341 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, /* check_usage */ true));
Calin Juravleb09be722017-09-25 16:42:48 -07001342 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001343 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1344 return false;
1345 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001346 oat_file->DisableAutoClose();
1347 if (oat_file->SetLength(0) != 0) {
1348 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001349 oat_file->Erase();
1350 return false;
David Brazdil7b49e6c2016-09-01 11:06:18 +01001351 }
1352 oat_files_.push_back(std::move(oat_file));
1353
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001354 if (input_vdex_fd_ != -1) {
1355 struct stat s;
1356 int rc = TEMP_FAILURE_RETRY(fstat(input_vdex_fd_, &s));
1357 if (rc == -1) {
1358 PLOG(WARNING) << "Failed getting length of vdex file";
1359 } else {
1360 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001361 input_vdex_file_ = VdexFile::Open(input_vdex_fd_,
1362 s.st_size,
1363 "vdex",
1364 /* writable */ false,
1365 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001366 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001367 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001368 // If there's any problem with the passed vdex, just warn and proceed
1369 // without it.
1370 if (input_vdex_file_ == nullptr) {
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001371 PLOG(WARNING) << "Failed opening vdex file: " << error_msg;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001372 }
1373 }
1374 }
1375
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001376 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001377 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001378 std::unique_ptr<File> vdex_file(new File(output_vdex_fd_, vdex_location, /* check_usage */ true));
Calin Juravleb09be722017-09-25 16:42:48 -07001379 if (vdex_file == nullptr) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001380 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001381 return false;
1382 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001383 vdex_file->DisableAutoClose();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001384 if (input_vdex_file_ != nullptr && output_vdex_fd_ == input_vdex_fd_) {
1385 update_input_vdex_ = true;
1386 } else {
1387 if (vdex_file->SetLength(0) != 0) {
1388 PLOG(ERROR) << "Truncating vdex file " << vdex_location << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001389 vdex_file->Erase();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001390 return false;
1391 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001392 }
1393 vdex_files_.push_back(std::move(vdex_file));
1394
Jeff Haodcdc85b2015-12-04 14:06:18 -08001395 oat_filenames_.push_back(oat_location_.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001396 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001397
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001398 // If we're updating in place a vdex file, be defensive and put an invalid vdex magic in case
1399 // dex2oat gets killed.
1400 // Note: we're only invalidating the magic data in the file, as dex2oat needs the rest of
1401 // the information to remain valid.
1402 if (update_input_vdex_) {
Vladimir Marko74527972016-11-29 15:57:32 +00001403 std::unique_ptr<linker::BufferedOutputStream> vdex_out =
1404 std::make_unique<linker::BufferedOutputStream>(
1405 std::make_unique<linker::FileOutputStream>(vdex_files_.back().get()));
Nicolas Geoffray3a293552018-03-02 10:52:16 +00001406 if (!vdex_out->WriteFully(&VdexFile::VerifierDepsHeader::kVdexInvalidMagic,
1407 arraysize(VdexFile::VerifierDepsHeader::kVdexInvalidMagic))) {
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001408 PLOG(ERROR) << "Failed to invalidate vdex header. File: " << vdex_out->GetLocation();
1409 return false;
1410 }
1411
1412 if (!vdex_out->Flush()) {
1413 PLOG(ERROR) << "Failed to flush stream after invalidating header of vdex file."
1414 << " File: " << vdex_out->GetLocation();
1415 return false;
1416 }
1417 }
1418
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001419 if (dm_fd_ != -1 || !dm_file_location_.empty()) {
1420 std::string error_msg;
1421 if (dm_fd_ != -1) {
1422 dm_file_.reset(ZipArchive::OpenFromFd(dm_fd_, "DexMetadata", &error_msg));
1423 } else {
1424 dm_file_.reset(ZipArchive::Open(dm_file_location_.c_str(), &error_msg));
1425 }
1426 if (dm_file_ == nullptr) {
1427 LOG(WARNING) << "Could not open DexMetadata archive " << error_msg;
1428 }
1429 }
1430
1431 if (dm_file_ != nullptr) {
1432 DCHECK(input_vdex_file_ == nullptr);
1433 std::string error_msg;
1434 static const char* kDexMetadata = "DexMetadata";
1435 std::unique_ptr<ZipEntry> zip_entry(dm_file_->Find(VdexFile::kVdexNameInDmFile, &error_msg));
1436 if (zip_entry == nullptr) {
1437 LOG(INFO) << "No " << VdexFile::kVdexNameInDmFile << " file in DexMetadata archive. "
1438 << "Not doing fast verification.";
1439 } else {
Mathieu Chartier792111c2018-02-15 13:02:15 -08001440 std::unique_ptr<MemMap> input_file(zip_entry->MapDirectlyOrExtract(
1441 VdexFile::kVdexNameInDmFile,
1442 kDexMetadata,
1443 &error_msg));
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00001444 if (input_file == nullptr) {
1445 LOG(WARNING) << "Could not open vdex file in DexMetadata archive: " << error_msg;
1446 } else {
1447 input_vdex_file_ = std::make_unique<VdexFile>(input_file.release());
1448 }
1449 }
1450 }
1451
David Brazdil7b49e6c2016-09-01 11:06:18 +01001452 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001453 //
1454 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1455 // that we can use for swap.
1456 //
1457 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1458 // will immediately unlink to satisfy the swap fd assumption.
1459 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1460 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1461 if (swap_file.get() == nullptr) {
1462 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1463 return false;
1464 }
1465 swap_fd_ = swap_file->Fd();
1466 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1467 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1468 // released immediately.
1469 unlink(swap_file_name_.c_str());
1470 }
Jeff Hao436183f2016-01-12 16:36:50 -08001471
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001472 return true;
1473 }
1474
David Brazdil7b49e6c2016-09-01 11:06:18 +01001475 void EraseOutputFiles() {
1476 for (auto& files : { &vdex_files_, &oat_files_ }) {
1477 for (size_t i = 0; i < files->size(); ++i) {
1478 if ((*files)[i].get() != nullptr) {
1479 (*files)[i]->Erase();
1480 (*files)[i].reset();
1481 }
1482 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001483 }
Andreas Gampea650e702014-12-03 14:28:02 -08001484 }
1485
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001486 void LoadClassProfileDescriptors() {
Mathieu Chartierf85b3db2018-04-02 18:16:21 -07001487 if (!IsImage()) {
1488 return;
1489 }
1490 // If we don't have a profile, treat it as an empty set of classes. b/77340429
1491 if (image_classes_ == nullptr) {
1492 // May be non-null when --image-classes is passed in, in that case avoid clearing the list.
1493 image_classes_.reset(new std::unordered_set<std::string>());
1494 }
1495 if (profile_compilation_info_ != nullptr) {
Mathieu Chartier0b490842016-05-25 15:05:59 -07001496 // Filter out class path classes since we don't want to include these in the image.
Mathieu Chartier4f342b02017-07-21 17:12:39 -07001497 image_classes_.reset(
1498 new std::unordered_set<std::string>(
1499 profile_compilation_info_->GetClassDescriptors(dex_files_)));
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001500 VLOG(compiler) << "Loaded " << image_classes_->size()
1501 << " image class descriptors from profile";
1502 if (VLOG_IS_ON(compiler)) {
1503 for (const std::string& s : *image_classes_) {
1504 LOG(INFO) << "Image class " << s;
1505 }
1506 }
1507 }
1508 }
1509
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001510 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1511 // boot class path.
Andreas Gampef7882972017-03-20 16:35:24 -07001512 dex2oat::ReturnCode Setup() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001513 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001514
Andreas Gampebd600e32018-04-12 14:25:39 -07001515 if (!PrepareImageClasses() || !PrepareDirtyObjects()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001516 return dex2oat::ReturnCode::kOther;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001517 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001518
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001519 // Verification results are null since we don't know if we will need them yet as the compler
1520 // filter may change.
Andreas Gampe4585f872015-03-27 23:45:15 -07001521 callbacks_.reset(new QuickCompilerCallbacks(
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001522 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001523 CompilerCallbacks::CallbackMode::kCompileBootImage :
1524 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001525
Vladimir Marko49b0f452015-12-10 13:49:19 +00001526 RuntimeArgumentMap runtime_options;
Mathieu Chartier46331a62017-07-21 09:49:10 -07001527 if (!PrepareRuntimeOptions(&runtime_options, callbacks_.get())) {
Andreas Gampef7882972017-03-20 16:35:24 -07001528 return dex2oat::ReturnCode::kOther;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001529 }
1530
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001531 CreateOatWriters();
1532 if (!AddDexFileSources()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001533 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001534 }
1535
Calin Juravle0e09dfc2018-02-12 19:01:09 -08001536 if (!compilation_reason_.empty()) {
1537 key_value_store_->Put(OatHeader::kCompilationReasonKey, compilation_reason_);
1538 }
1539
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001540 if (IsBootImage() && image_filenames_.size() > 1) {
1541 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1542 // We need this for the multi-image case.
Mathieu Chartier866d8742016-09-21 15:24:18 -07001543 key_value_store_->Put(OatHeader::kBootClassPathKey,
1544 gc::space::ImageSpace::GetMultiImageBootClassPath(dex_locations_,
1545 oat_filenames_,
1546 image_filenames_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001547 }
1548
1549 if (!IsBootImage()) {
1550 // When compiling an app, create the runtime early to retrieve
1551 // the image location key needed for the oat header.
1552 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001553 return dex2oat::ReturnCode::kCreateRuntime;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001554 }
1555
Andreas Gampe29d38e72016-03-23 15:31:51 +00001556 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001557 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1558 std::vector<gc::space::ImageSpace*> image_spaces =
1559 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Richard Uhlerbc26b722017-03-10 14:27:10 +00001560 image_file_location_oat_checksum_ = image_spaces[0]->GetImageHeader().GetOatChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001561 image_file_location_oat_data_begin_ =
1562 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1563 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1564 // Store the boot image filename(s).
1565 std::vector<std::string> image_filenames;
1566 for (const gc::space::ImageSpace* image_space : image_spaces) {
1567 image_filenames.push_back(image_space->GetImageFilename());
1568 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001569 std::string image_file_location = android::base::Join(image_filenames, ':');
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001570 if (!image_file_location.empty()) {
1571 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1572 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001573 } else {
1574 image_file_location_oat_checksum_ = 0u;
1575 image_file_location_oat_data_begin_ = 0u;
1576 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001577 }
1578
1579 // Open dex files for class path.
Calin Juravle19915892017-08-03 17:10:36 +00001580
Calin Juravle1ce70852017-06-28 10:59:03 -07001581 if (class_loader_context_ == nullptr) {
Calin Juravle19915892017-08-03 17:10:36 +00001582 // If no context was specified use the default one (which is an empty PathClassLoader).
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001583 class_loader_context_ = ClassLoaderContext::Default();
Jeff Haof0192c82016-03-28 20:39:50 -07001584 }
Calin Juravle19915892017-08-03 17:10:36 +00001585
Calin Juravle1ce70852017-06-28 10:59:03 -07001586 DCHECK_EQ(oat_writers_.size(), 1u);
1587
1588 // Note: Ideally we would reject context where the source dex files are also
1589 // specified in the classpath (as it doesn't make sense). However this is currently
1590 // needed for non-prebuild tests and benchmarks which expects on the fly compilation.
1591 // Also, for secondary dex files we do not have control on the actual classpath.
1592 // Instead of aborting, remove all the source location from the context classpaths.
1593 if (class_loader_context_->RemoveLocationsFromClassPaths(
1594 oat_writers_[0]->GetSourceLocations())) {
1595 LOG(WARNING) << "The source files to be compiled are also in the classpath.";
1596 }
1597
1598 // We need to open the dex files before encoding the context in the oat file.
1599 // (because the encoding adds the dex checksum...)
1600 // TODO(calin): consider redesigning this so we don't have to open the dex files before
1601 // creating the actual class loader.
1602 if (!class_loader_context_->OpenDexFiles(runtime_->GetInstructionSet(), classpath_dir_)) {
1603 // Do not abort if we couldn't open files from the classpath. They might be
1604 // apks without dex files and right now are opening flow will fail them.
1605 LOG(WARNING) << "Failed to open classpath dex files";
1606 }
1607
1608 // Store the class loader context in the oat header.
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001609 // TODO: deprecate this since store_class_loader_context should be enough to cover the users
1610 // of classpath_dir as well.
Mathieu Chartierc4440772018-04-16 14:40:56 -07001611 std::string class_path_key =
1612 class_loader_context_->EncodeContextForOatFile(classpath_dir_,
1613 stored_class_loader_context_.get());
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07001614 key_value_store_->Put(OatHeader::kClassPathKey, class_path_key);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001615 }
1616
1617 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001618 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001619 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1620 rodata_.reserve(oat_writers_.size());
1621 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1622 rodata_.push_back(elf_writers_[i]->StartRoData());
1623 // Unzip or copy dex files straight to the oat file.
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00001624 std::vector<std::unique_ptr<MemMap>> opened_dex_files_map;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001625 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
Mathieu Chartierd45863a2018-03-21 18:16:36 -07001626 // No need to verify the dex file when we have a vdex file, which means it was already
1627 // verified.
1628 const bool verify = (input_vdex_file_ == nullptr);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001629 if (!oat_writers_[i]->WriteAndOpenDexFiles(
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +00001630 vdex_files_[i].get(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01001631 rodata_.back(),
1632 instruction_set_,
1633 instruction_set_features_.get(),
1634 key_value_store_.get(),
Jeff Hao042e8982016-10-19 11:17:11 -07001635 verify,
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001636 update_input_vdex_,
Mathieu Chartier792111c2018-02-15 13:02:15 -08001637 copy_dex_files_,
David Brazdil7b49e6c2016-09-01 11:06:18 +01001638 &opened_dex_files_map,
1639 &opened_dex_files)) {
Andreas Gampef7882972017-03-20 16:35:24 -07001640 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001641 }
1642 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00001643 if (opened_dex_files_map.empty()) {
1644 DCHECK(opened_dex_files.empty());
1645 } else {
1646 for (std::unique_ptr<MemMap>& map : opened_dex_files_map) {
1647 opened_dex_files_maps_.push_back(std::move(map));
1648 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001649 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001650 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001651 opened_dex_files_.push_back(std::move(dex_file));
1652 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001653 }
1654 }
1655 }
1656
1657 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
Andreas Gampe7386da42016-06-08 18:18:47 -07001658
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001659 // If we need to downgrade the compiler-filter for size reasons.
1660 if (!IsBootImage() && IsVeryLarge(dex_files_)) {
Mathieu Chartier8cce65a2017-08-17 00:06:39 -07001661 // Disable app image to make sure dex2oat unloading is enabled.
1662 compiler_options_->DisableAppImage();
1663
Mathieu Chartier72041a02017-07-14 18:23:25 -07001664 // If we need to downgrade the compiler-filter for size reasons, do that early before we read
1665 // it below for creating verification callbacks.
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001666 if (!CompilerFilter::IsAsGoodAs(kLargeAppFilter, compiler_options_->GetCompilerFilter())) {
1667 LOG(INFO) << "Very large app, downgrading to verify.";
1668 // Note: this change won't be reflected in the key-value store, as that had to be
1669 // finalized before loading the dex files. This setup is currently required
1670 // to get the size from the DexFile objects.
1671 // TODO: refactor. b/29790079
1672 compiler_options_->SetCompilerFilter(kLargeAppFilter);
1673 }
1674 }
1675
1676 if (CompilerFilter::IsAnyCompilationEnabled(compiler_options_->GetCompilerFilter())) {
1677 // Only modes with compilation require verification results, do this here instead of when we
1678 // create the compilation callbacks since the compilation mode may have been changed by the
1679 // very large app logic.
1680 // Avoiding setting the verification results saves RAM by not adding the dex files later in
1681 // the function.
1682 verification_results_.reset(new VerificationResults(compiler_options_.get()));
1683 callbacks_->SetVerificationResults(verification_results_.get());
1684 }
1685
Andreas Gampe7386da42016-06-08 18:18:47 -07001686 // We had to postpone the swap decision till now, as this is the point when we actually
1687 // know about the dex files we're going to use.
1688
1689 // Make sure that we didn't create the driver, yet.
1690 CHECK(driver_ == nullptr);
1691 // If we use a swap file, ensure we are above the threshold to make it necessary.
1692 if (swap_fd_ != -1) {
1693 if (!UseSwap(IsBootImage(), dex_files_)) {
1694 close(swap_fd_);
1695 swap_fd_ = -1;
1696 VLOG(compiler) << "Decided to run without swap.";
1697 } else {
1698 LOG(INFO) << "Large app, accepted running with swap.";
1699 }
1700 }
1701 // 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 +00001702 if (IsBootImage()) {
1703 // For boot image, pass opened dex files to the Runtime::Create().
1704 // Note: Runtime acquires ownership of these dex files.
1705 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001706 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001707 return dex2oat::ReturnCode::kOther;
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001708 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001709 }
1710
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001711 // If we're doing the image, override the compiler filter to force full compilation. Must be
1712 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1713 // compilation of class initializers.
1714 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001715 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001716 WellKnownClasses::Init(self->GetJniEnv());
1717
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001718 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001719 constexpr bool kSaveDexInput = false;
1720 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001721 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001722 }
1723 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001724
1725 // Ensure opened dex files are writable for dex-to-dex transformations.
1726 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1727 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1728 PLOG(ERROR) << "Failed to make .dex files writeable.";
Andreas Gampef7882972017-03-20 16:35:24 -07001729 return dex2oat::ReturnCode::kOther;
Vladimir Marko919f5532016-01-20 19:13:01 +00001730 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001731 }
1732
Mathieu Chartier72041a02017-07-14 18:23:25 -07001733 // Verification results are only required for modes that have any compilation. Avoid
1734 // adding the dex files if possible to prevent allocating large arrays.
1735 if (verification_results_ != nullptr) {
1736 for (const auto& dex_file : dex_files_) {
1737 // Pre-register dex files so that we can access verification results without locks during
1738 // compilation and verification.
Mathieu Chartier0733dc82017-07-17 14:05:28 -07001739 verification_results_->AddDexFile(dex_file);
1740 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001741 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001742
Andreas Gampef7882972017-03-20 16:35:24 -07001743 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001744 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001745
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001746 // If we need to keep the oat file open for the image writer.
1747 bool ShouldKeepOatFileOpen() const {
1748 return IsImage() && oat_fd_ != kInvalidFd;
1749 }
1750
Mathieu Chartier72041a02017-07-14 18:23:25 -07001751 // Doesn't return the class loader since it's not meant to be used for image compilation.
1752 void CompileDexFilesIndividually() {
1753 CHECK(!IsImage()) << "Not supported with image";
1754 for (const DexFile* dex_file : dex_files_) {
1755 std::vector<const DexFile*> dex_files(1u, dex_file);
1756 VLOG(compiler) << "Compiling " << dex_file->GetLocation();
1757 jobject class_loader = CompileDexFiles(dex_files);
1758 CHECK(class_loader != nullptr);
1759 ScopedObjectAccess soa(Thread::Current());
1760 // Unload class loader to free RAM.
Ian Rogers55256cb2017-12-21 17:07:11 -08001761 jweak weak_class_loader = soa.Env()->GetVm()->AddWeakGlobalRef(
Mathieu Chartier72041a02017-07-14 18:23:25 -07001762 soa.Self(),
1763 soa.Decode<mirror::ClassLoader>(class_loader));
Ian Rogers55256cb2017-12-21 17:07:11 -08001764 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), class_loader);
Roland Levillainaf290312018-02-27 20:02:17 +00001765 runtime_->GetHeap()->CollectGarbage(/* clear_soft_references */ true);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001766 ObjPtr<mirror::ClassLoader> decoded_weak = soa.Decode<mirror::ClassLoader>(weak_class_loader);
1767 if (decoded_weak != nullptr) {
1768 LOG(FATAL) << "Failed to unload class loader, path from root set: "
1769 << runtime_->GetHeap()->GetVerification()->FirstPathFromRootSet(decoded_weak);
1770 }
1771 VLOG(compiler) << "Unloaded classloader";
1772 }
1773 }
1774
1775 bool ShouldCompileDexFilesIndividually() const {
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001776 // Compile individually if we are:
1777 // 1. not building an image,
1778 // 2. not verifying a vdex file,
1779 // 3. using multidex,
1780 // 4. not doing any AOT compilation.
1781 // This means extract, no-vdex verify, and quicken, will use the individual compilation
1782 // mode (to reduce RAM used by the compiler).
Mathieu Chartier72041a02017-07-14 18:23:25 -07001783 return !IsImage() &&
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001784 !update_input_vdex_ &&
Mathieu Chartier72041a02017-07-14 18:23:25 -07001785 dex_files_.size() > 1 &&
Mathieu Chartier6a2b67b2017-08-08 15:09:29 -07001786 !CompilerFilter::IsAotCompilationEnabled(compiler_options_->GetCompilerFilter());
Mathieu Chartier72041a02017-07-14 18:23:25 -07001787 }
1788
1789 // Set up and create the compiler driver and then invoke it to compile all the dex files.
1790 jobject Compile() {
1791 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1792
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001793 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001794
Vladimir Marko47496c22016-01-27 16:15:08 +00001795 // Find the dex files we should not inline from.
Vladimir Marko47496c22016-01-27 16:15:08 +00001796 std::vector<std::string> no_inline_filters;
1797 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001798
1799 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001800 const std::string core_oj = "core-oj";
1801 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1802 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001803 }
1804
Vladimir Marko47496c22016-01-27 16:15:08 +00001805 if (!no_inline_filters.empty()) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001806 std::vector<const DexFile*> class_path_files;
1807 if (!IsBootImage()) {
1808 // The class loader context is used only for apps.
1809 class_path_files = class_loader_context_->FlattenOpenedDexFiles();
1810 }
1811
Jeff Haodcdc85b2015-12-04 14:06:18 -08001812 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1813 &class_linker->GetBootClassPath(),
1814 &class_path_files,
1815 &dex_files_
1816 };
1817 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001818 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001819 for (const std::string& filter : no_inline_filters) {
1820 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
Calin Juravlea308a322017-07-18 16:51:51 -07001821 // allows tests to specify <test-dexfile>!classes2.dex if needed but if the
Vladimir Marko47496c22016-01-27 16:15:08 +00001822 // base location passes the StartsWith() test, so do all extra locations.
1823 std::string dex_location = dex_file->GetLocation();
1824 if (filter.find('/') == std::string::npos) {
1825 // The filter does not contain the path. Remove the path from dex_location as well.
1826 size_t last_slash = dex_file->GetLocation().rfind('/');
1827 if (last_slash != std::string::npos) {
1828 dex_location = dex_location.substr(last_slash + 1);
1829 }
1830 }
1831
Andreas Gampe9186ced2016-12-12 14:28:21 -08001832 if (android::base::StartsWith(dex_location, filter.c_str())) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001833 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1834 no_inline_from_dex_files_.push_back(dex_file);
1835 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001836 }
1837 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001838 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001839 }
1840 if (!no_inline_from_dex_files_.empty()) {
1841 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001842 }
1843 }
1844
Vladimir Marko307dac92015-10-20 11:20:09 +01001845 driver_.reset(new CompilerDriver(compiler_options_.get(),
1846 verification_results_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001847 compiler_kind_,
1848 instruction_set_,
1849 instruction_set_features_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001850 image_classes_.release(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001851 thread_count_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001852 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001853 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001854 driver_->SetDexFilesForOatFile(dex_files_);
Nicolas Geoffray486dda02017-09-11 14:15:52 +01001855 if (!IsBootImage()) {
1856 driver_->SetClasspathDexFiles(class_loader_context_->FlattenOpenedDexFiles());
1857 }
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001858
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001859 const bool compile_individually = ShouldCompileDexFilesIndividually();
1860 if (compile_individually) {
1861 // Set the compiler driver in the callbacks so that we can avoid re-verification. This not
1862 // only helps performance but also prevents reverifying quickened bytecodes. Attempting
1863 // verify quickened bytecode causes verification failures.
1864 // Only set the compiler filter if we are doing separate compilation since there is a bit
1865 // of overhead when checking if a class was previously verified.
1866 callbacks_->SetDoesClassUnloading(true, driver_.get());
1867 }
1868
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001869 // Setup vdex for compilation.
1870 if (!DoEagerUnquickeningOfVdex() && input_vdex_file_ != nullptr) {
1871 callbacks_->SetVerifierDeps(
1872 new verifier::VerifierDeps(dex_files_, input_vdex_file_->GetVerifierDepsData()));
1873
1874 // TODO: we unquicken unconditionally, as we don't know
1875 // if the boot image has changed. How exactly we'll know is under
1876 // experimentation.
1877 TimingLogger::ScopedTiming time_unquicken("Unquicken", timings_);
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +03001878
1879 // We do not decompile a RETURN_VOID_NO_BARRIER into a RETURN_VOID, as the quickening
1880 // optimization does not depend on the boot image (the optimization relies on not
1881 // having final fields in a class, which does not change for an app).
Mathieu Chartier210531f2018-01-12 10:15:51 -08001882 input_vdex_file_->Unquicken(dex_files_, /* decompile_return_instruction */ false);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001883 } else {
1884 // Create the main VerifierDeps, here instead of in the compiler since we want to aggregate
1885 // the results for all the dex files, not just the results for the current dex file.
1886 callbacks_->SetVerifierDeps(new verifier::VerifierDeps(dex_files_));
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001887 }
Mathieu Chartier72041a02017-07-14 18:23:25 -07001888 // Invoke the compilation.
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001889 if (compile_individually) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001890 CompileDexFilesIndividually();
1891 // Return a null classloader since we already freed released it.
1892 return nullptr;
1893 }
1894 return CompileDexFiles(dex_files_);
1895 }
1896
1897 // Create the class loader, use it to compile, and return.
1898 jobject CompileDexFiles(const std::vector<const DexFile*>& dex_files) {
1899 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1900
1901 jobject class_loader = nullptr;
1902 if (!IsBootImage()) {
1903 class_loader = class_loader_context_->CreateClassLoader(dex_files_);
Andreas Gampee9934582018-01-19 21:23:04 -08001904 callbacks_->SetDexFiles(&dex_files);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001905 }
1906
1907 // Register dex caches and key them to the class loader so that they only unload when the
1908 // class loader unloads.
1909 for (const auto& dex_file : dex_files) {
1910 ScopedObjectAccess soa(Thread::Current());
1911 // Registering the dex cache adds a strong root in the class loader that prevents the dex
1912 // cache from being unloaded early.
1913 ObjPtr<mirror::DexCache> dex_cache = class_linker->RegisterDexFile(
1914 *dex_file,
1915 soa.Decode<mirror::ClassLoader>(class_loader));
1916 if (dex_cache == nullptr) {
1917 soa.Self()->AssertPendingException();
1918 LOG(FATAL) << "Failed to register dex file " << dex_file->GetLocation() << " "
1919 << soa.Self()->GetException()->Dump();
1920 }
1921 }
1922 driver_->CompileAll(class_loader, dex_files, timings_);
1923 return class_loader;
Vladimir Markof4da6752014-08-01 19:04:18 +01001924 }
1925
Jeff Hao436183f2016-01-12 16:36:50 -08001926 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001927 // ensure the references between the two are correct.
1928 //
1929 // Currently we have a memory layout that looks something like this:
1930 //
1931 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001932 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001933 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001934 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001935 // +--------------+
1936 // | alloc spaces |
1937 // +--------------+
1938 //
Jeff Hao436183f2016-01-12 16:36:50 -08001939 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001940 //
Jeff Hao436183f2016-01-12 16:36:50 -08001941 // 1. The images are expected to be loaded at an absolute address and
1942 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001943 //
Jeff Hao436183f2016-01-12 16:36:50 -08001944 // 2. There are absolute pointers from Methods in the images to their
1945 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001946 //
Jeff Hao436183f2016-01-12 16:36:50 -08001947 // 3. There are absolute pointers from the code in the oat files to Methods
1948 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001949 //
Jeff Hao436183f2016-01-12 16:36:50 -08001950 // 4. There are absolute pointers from code in the oat files to other code
1951 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001952 //
1953 // To get this all correct, we go through several steps.
1954 //
Jeff Hao436183f2016-01-12 16:36:50 -08001955 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001956 // the oat data size and code size. During this stage, we also set
1957 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001958 //
Jeff Hao436183f2016-01-12 16:36:50 -08001959 // 2. We prepare offsets for the objects in the images and calculate
1960 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001961 //
Jeff Hao436183f2016-01-12 16:36:50 -08001962 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001963 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001964 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001965 // can prepare the ELF headers and we then know the ELF memory segment
1966 // layout and we can now resolve all references. The compiler provides
1967 // LinkerPatch information in each CompiledMethod and we resolve these,
1968 // using the layout information and image object locations provided by
1969 // image writer, as we're writing the method code.
1970 //
Jeff Hao436183f2016-01-12 16:36:50 -08001971 // 4. We create the image files. They need to know where the oat files
1972 // will be loaded after itself. Originally oat files were simply
1973 // memory mapped so we could predict where their contents were based
1974 // on the file size. Now that they are ELF files, we need to inspect
1975 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001976 // where the oat header is located within.
1977 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001978 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001979 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001980 // load the .so at the desired location at runtime by offsetting the
1981 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001982 // TODO: Do this in step 3. We already know the layout there.
1983 //
1984 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1985 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001986
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001987 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1988 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001989 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1990 // case (when the file will be explicitly erased).
David Brazdil7b49e6c2016-09-01 11:06:18 +01001991 bool WriteOutputFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001992 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1993
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001994 // Sync the data to the file, in case we did dex2dex transformations.
1995 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1996 if (!map->Sync()) {
1997 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1998 return false;
1999 }
2000 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002001
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002002 if (IsImage()) {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002003 if (IsAppImage() && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002004 gc::Heap* const heap = Runtime::Current()->GetHeap();
2005 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002006 image_base_ = std::max(image_base_, RoundUp(
2007 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
2008 kPageSize));
2009 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002010 // The non moving space is right after the oat file. Put the preferred app image location
2011 // right after the non moving space so that we ideally get a continuous immune region for
2012 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002013 // Use the default non moving space capacity since dex2oat does not have a separate non-
2014 // moving space. This means the runtime's non moving space space size will be as large
2015 // as the growth limit for dex2oat, but smaller in the zygote.
2016 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002017 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002018 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
2019 }
2020
Vladimir Marko74527972016-11-29 15:57:32 +00002021 image_writer_.reset(new linker::ImageWriter(*driver_,
2022 image_base_,
2023 compiler_options_->GetCompilePic(),
2024 IsAppImage(),
2025 image_storage_mode_,
2026 oat_filenames_,
2027 dex_file_oat_index_map_,
2028 dirty_image_objects_.get()));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002029
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002030 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002031 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
Mathieu Chartier703b82a2018-04-10 15:52:32 -07002032 if (!image_writer_->PrepareImageAddressSpace(timings_)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002033 LOG(ERROR) << "Failed to prepare image address space.";
2034 return false;
2035 }
2036 }
2037
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002038 // Initialize the writers with the compiler driver, image writer, and their
2039 // dex files. The writers were created without those being there yet.
2040 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00002041 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002042 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
2043 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
2044 }
2045
David Brazdil5d5a36b2016-09-14 15:34:10 +01002046 {
2047 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
2048 DCHECK(IsBootImage() || oat_files_.size() == 1u);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00002049 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
David Brazdil5d5a36b2016-09-14 15:34:10 +01002050 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
2051 File* vdex_file = vdex_files_[i].get();
Vladimir Marko74527972016-11-29 15:57:32 +00002052 std::unique_ptr<linker::BufferedOutputStream> vdex_out =
2053 std::make_unique<linker::BufferedOutputStream>(
2054 std::make_unique<linker::FileOutputStream>(vdex_file));
David Brazdil5d5a36b2016-09-14 15:34:10 +01002055
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00002056 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002057 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
2058 return false;
2059 }
2060
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002061 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
2062 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
2063 return false;
2064 }
2065
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +00002066 // VDEX finalized, seek back to the beginning and write checksums and the header.
2067 if (!oat_writers_[i]->WriteChecksumsAndVdexHeader(vdex_out.get())) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002068 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
2069 return false;
2070 }
2071 }
2072 }
2073
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002074 {
2075 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Vladimir Markoca1e0382018-04-11 09:58:41 +00002076 linker::MultiOatRelativePatcher patcher(instruction_set_,
2077 instruction_set_features_.get(),
2078 driver_->GetCompiledMethodStorage());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002079 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00002080 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2081 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko944da602016-02-19 12:27:55 +00002082
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002083 oat_writer->PrepareLayout(&patcher);
Vladimir Markob066d432018-01-03 13:14:37 +00002084 elf_writer->PrepareDynamicSection(oat_writer->GetOatHeader().GetExecutableOffset(),
2085 oat_writer->GetCodeSize(),
2086 oat_writer->GetDataBimgRelRoSize(),
Vladimir Markoaad75c62016-10-03 08:46:48 +00002087 oat_writer->GetBssSize(),
Vladimir Marko0eb882b2017-05-15 13:39:18 +01002088 oat_writer->GetBssMethodsOffset(),
David Srbeckyec2cdf42017-12-08 16:21:25 +00002089 oat_writer->GetBssRootsOffset(),
2090 oat_writer->GetVdexSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002091 if (IsImage()) {
2092 // Update oat layout.
2093 DCHECK(image_writer_ != nullptr);
2094 DCHECK_LT(i, oat_filenames_.size());
2095 image_writer_->UpdateOatFileLayout(i,
2096 elf_writer->GetLoadedSize(),
2097 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01002098 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002099 }
Richard Uhlerbc26b722017-03-10 14:27:10 +00002100
2101 if (IsBootImage()) {
2102 // Have the image_file_location_oat_checksum_ for boot oat files
2103 // depend on the contents of all the boot oat files. This way only
2104 // the primary image checksum needs to be checked to determine
2105 // whether any of the images are out of date.
2106 image_file_location_oat_checksum_ ^= oat_writer->GetOatHeader().GetChecksum();
2107 }
Vladimir Marko944da602016-02-19 12:27:55 +00002108 }
2109
2110 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002111 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko74527972016-11-29 15:57:32 +00002112 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2113 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00002114
David Srbecky0c4572e2016-01-22 19:19:25 +00002115 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00002116 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
David Srbecky32210b92017-12-04 14:39:21 +00002117 debug::DebugInfo debug_info = oat_writer->GetDebugInfo(); // Keep the variable alive.
2118 elf_writer->PrepareDebugInfo(debug_info); // Processes the data on background thread.
David Srbecky0c4572e2016-01-22 19:19:25 +00002119
Vladimir Marko74527972016-11-29 15:57:32 +00002120 linker::OutputStream*& rodata = rodata_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002121 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002122 if (!oat_writer->WriteRodata(rodata)) {
2123 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
2124 return false;
2125 }
2126 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002127 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00002128
Vladimir Marko74527972016-11-29 15:57:32 +00002129 linker::OutputStream* text = elf_writer->StartText();
Jeff Haodcdc85b2015-12-04 14:06:18 -08002130 if (!oat_writer->WriteCode(text)) {
2131 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
2132 return false;
2133 }
2134 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00002135
Vladimir Markob066d432018-01-03 13:14:37 +00002136 if (oat_writer->GetDataBimgRelRoSize() != 0u) {
2137 linker::OutputStream* data_bimg_rel_ro = elf_writer->StartDataBimgRelRo();
2138 if (!oat_writer->WriteDataBimgRelRo(data_bimg_rel_ro)) {
2139 LOG(ERROR) << "Failed to write .data.bimg.rel.ro section to the ELF file "
2140 << oat_file->GetPath();
2141 return false;
2142 }
2143 elf_writer->EndDataBimgRelRo(data_bimg_rel_ro);
2144 }
2145
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002146 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
2147 image_file_location_oat_checksum_,
2148 image_file_location_oat_data_begin_,
2149 image_patch_delta_)) {
2150 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
2151 return false;
2152 }
2153
Vladimir Marko944da602016-02-19 12:27:55 +00002154 if (IsImage()) {
2155 // Update oat header information.
2156 DCHECK(image_writer_ != nullptr);
2157 DCHECK_LT(i, oat_filenames_.size());
2158 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
2159 }
2160
Jeff Haodcdc85b2015-12-04 14:06:18 -08002161 elf_writer->WriteDynamicSection();
David Srbecky32210b92017-12-04 14:39:21 +00002162 elf_writer->WriteDebugInfo(oat_writer->GetDebugInfo());
Vladimir Marko10c13562015-11-25 14:33:36 +00002163
Jeff Haodcdc85b2015-12-04 14:06:18 -08002164 if (!elf_writer->End()) {
2165 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
2166 return false;
2167 }
2168
David Brazdil7b49e6c2016-09-01 11:06:18 +01002169 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
2170 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002171 }
2172
Jeff Haodcdc85b2015-12-04 14:06:18 -08002173 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002174
2175 oat_writer.reset();
2176 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002177 }
2178 }
2179
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002180 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002181 }
2182
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002183 // If we are compiling an image, invoke the image creation routine. Else just skip.
2184 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002185 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002186 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
2187 if (!CreateImageFile()) {
2188 return false;
2189 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002190 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07002191 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002192 return true;
2193 }
2194
Jeff Haodcdc85b2015-12-04 14:06:18 -08002195 // Create a copy from stripped to unstripped.
2196 bool CopyStrippedToUnstripped() {
2197 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
2198 // If we don't want to strip in place, copy from stripped location to unstripped location.
2199 // We need to strip after image creation because FixupElf needs to use .strtab.
2200 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
2201 // If the oat file is still open, flush it.
2202 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002203 if (!FlushCloseOutputFile(&oat_files_[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002204 return false;
2205 }
2206 }
2207
2208 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
2209 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
2210 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01002211 int64_t in_length = in->GetLength();
2212 if (in_length < 0) {
2213 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
2214 return false;
2215 }
2216 if (!out->Copy(in.get(), 0, in_length)) {
2217 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
2218 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002219 }
2220 if (out->FlushCloseOrErase() != 0) {
2221 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
2222 return false;
2223 }
2224 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
2225 }
2226 }
2227 return true;
2228 }
2229
David Brazdil7b49e6c2016-09-01 11:06:18 +01002230 bool FlushOutputFile(std::unique_ptr<File>* file) {
2231 if (file->get() != nullptr) {
2232 if (file->get()->Flush() != 0) {
2233 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
2234 return false;
2235 }
2236 }
2237 return true;
2238 }
2239
2240 bool FlushCloseOutputFile(std::unique_ptr<File>* file) {
2241 if (file->get() != nullptr) {
2242 std::unique_ptr<File> tmp(file->release());
2243 if (tmp->FlushCloseOrErase() != 0) {
2244 PLOG(ERROR) << "Failed to flush and close output file: " << tmp->GetPath();
2245 return false;
2246 }
2247 }
2248 return true;
2249 }
2250
2251 bool FlushOutputFiles() {
2252 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
2253 for (auto& files : { &vdex_files_, &oat_files_ }) {
2254 for (size_t i = 0; i < files->size(); ++i) {
2255 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002256 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08002257 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002258 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00002259 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002260 return true;
2261 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002262
David Brazdil7b49e6c2016-09-01 11:06:18 +01002263 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002264 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002265 for (auto& files : { &vdex_files_, &oat_files_ }) {
2266 for (size_t i = 0; i < files->size(); ++i) {
2267 result &= FlushCloseOutputFile(&(*files)[i]);
2268 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002269 }
2270 return result;
2271 }
2272
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002273 void DumpTiming() {
Nicolas Geoffray2d8801f2017-11-28 15:50:07 +00002274 if (compiler_options_->GetDumpTimings() ||
2275 (kIsDebugBuild && timings_->GetTotalNs() > MsToNs(1000))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002276 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2277 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002278 }
2279
Andreas Gampe10e477d2014-11-19 12:57:42 -08002280 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002281 return IsAppImage() || IsBootImage();
2282 }
2283
2284 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002285 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002286 }
2287
2288 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002289 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002290 }
2291
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002292 bool IsHost() const {
2293 return is_host_;
2294 }
2295
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002296 bool UseProfile() const {
Mathieu Chartierd0af56c2017-02-17 12:56:25 -08002297 return profile_file_fd_ != -1 || !profile_file_.empty();
Calin Juravle998c2162015-12-21 15:39:33 +02002298 }
2299
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002300 bool DoProfileGuidedOptimizations() const {
Nicolas Geoffray49cda062017-04-21 13:08:25 +01002301 return UseProfile();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002302 }
2303
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002304 bool DoGenerateCompactDex() const {
2305 return compact_dex_level_ != CompactDexLevel::kCompactDexLevelNone;
2306 }
2307
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002308 bool DoDexLayoutOptimizations() const {
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002309 return DoProfileGuidedOptimizations() || DoGenerateCompactDex();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002310 }
2311
Igor Murashkin545412b2017-08-17 15:26:54 -07002312 bool DoOatLayoutOptimizations() const {
2313 return DoProfileGuidedOptimizations();
2314 }
2315
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002316 bool MayInvalidateVdexMetadata() const {
2317 // DexLayout can invalidate the vdex metadata if changing the class def order is enabled, so
2318 // we need to unquicken the vdex file eagerly, before passing it to dexlayout.
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01002319 return DoDexLayoutOptimizations();
2320 }
2321
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002322 bool DoEagerUnquickeningOfVdex() const {
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00002323 return MayInvalidateVdexMetadata() && dm_file_ == nullptr;
Mathieu Chartier2c4b0842017-12-13 11:49:51 -08002324 }
2325
Calin Juravle2e2db782016-02-23 12:00:03 +00002326 bool LoadProfile() {
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002327 DCHECK(UseProfile());
Calin Juravlee6f87cc2017-05-24 17:41:05 -07002328 // TODO(calin): We should be using the runtime arena pool (instead of the
2329 // default profile arena). However the setup logic is messy and needs
2330 // cleaning up before that (e.g. the oat writers are created before the
2331 // runtime).
Calin Juravle2e2db782016-02-23 12:00:03 +00002332 profile_compilation_info_.reset(new ProfileCompilationInfo());
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002333 ScopedFlock profile_file;
Calin Juravle2e2db782016-02-23 12:00:03 +00002334 std::string error;
2335 if (profile_file_fd_ != -1) {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002336 profile_file = LockedFile::DupOf(profile_file_fd_, "profile",
2337 true /* read_only_mode */, &error);
Andreas Gampe29d38e72016-03-23 15:31:51 +00002338 } else if (profile_file_ != "") {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002339 profile_file = LockedFile::Open(profile_file_.c_str(), O_RDONLY, true, &error);
Calin Juravle998c2162015-12-21 15:39:33 +02002340 }
Calin Juravle877fd962016-01-05 14:29:29 +00002341
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002342 // Return early if we're unable to obtain a lock on the profile.
2343 if (profile_file.get() == nullptr) {
2344 LOG(ERROR) << "Cannot lock profiles: " << error;
2345 return false;
2346 }
2347
2348 if (!profile_compilation_info_->Load(profile_file->Fd())) {
Calin Juravle2e2db782016-02-23 12:00:03 +00002349 profile_compilation_info_.reset(nullptr);
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002350 return false;
Calin Juravle2e2db782016-02-23 12:00:03 +00002351 }
Calin Juravle877fd962016-01-05 14:29:29 +00002352
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002353 return true;
Calin Juravle998c2162015-12-21 15:39:33 +02002354 }
2355
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002356 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002357 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2358 if (is_image) {
2359 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2360 return false;
2361 }
2362 if (dex_files.size() < min_dex_files_for_swap_) {
2363 // If there are less dex files than the threshold, assume it's gonna be fine.
2364 return false;
2365 }
2366 size_t dex_files_size = 0;
2367 for (const auto* dex_file : dex_files) {
2368 dex_files_size += dex_file->GetHeader().file_size_;
2369 }
2370 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2371 }
2372
Andreas Gampe67f02822016-06-24 21:05:23 -07002373 bool IsVeryLarge(std::vector<const DexFile*>& dex_files) {
2374 size_t dex_files_size = 0;
2375 for (const auto* dex_file : dex_files) {
2376 dex_files_size += dex_file->GetHeader().file_size_;
2377 }
2378 return dex_files_size >= very_large_threshold_;
2379 }
2380
Vladimir Marko49b0f452015-12-10 13:49:19 +00002381 bool PrepareImageClasses() {
2382 // If --image-classes was specified, calculate the full list of classes to include in the image.
2383 if (image_classes_filename_ != nullptr) {
2384 image_classes_ =
2385 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2386 if (image_classes_ == nullptr) {
2387 return false;
2388 }
2389 } else if (IsBootImage()) {
2390 image_classes_.reset(new std::unordered_set<std::string>);
2391 }
2392 return true;
2393 }
2394
Vladimir Marko49b0f452015-12-10 13:49:19 +00002395 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2396 const char* classes_filename,
2397 const char* tag) {
2398 std::unique_ptr<std::unordered_set<std::string>> classes;
2399 std::string error_msg;
2400 if (zip_filename != nullptr) {
2401 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2402 } else {
2403 classes.reset(ReadImageClassesFromFile(classes_filename));
2404 }
2405 if (classes == nullptr) {
2406 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2407 << classes_filename << "': " << error_msg;
2408 }
2409 return classes;
2410 }
2411
Jeff Haoc23b0c02017-07-27 18:19:38 -07002412 bool PrepareDirtyObjects() {
2413 if (dirty_image_objects_filename_ != nullptr) {
2414 dirty_image_objects_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2415 dirty_image_objects_filename_,
2416 nullptr));
2417 if (dirty_image_objects_ == nullptr) {
2418 LOG(ERROR) << "Failed to create list of dirty objects from '"
2419 << dirty_image_objects_filename_ << "'";
2420 return false;
2421 }
2422 } else {
2423 dirty_image_objects_.reset(nullptr);
2424 }
2425 return true;
2426 }
2427
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002428 void PruneNonExistentDexFiles() {
2429 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2430 size_t kept = 0u;
2431 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2432 if (!OS::FileExists(dex_filenames_[i])) {
2433 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2434 } else {
2435 dex_filenames_[kept] = dex_filenames_[i];
2436 dex_locations_[kept] = dex_locations_[i];
2437 ++kept;
2438 }
2439 }
2440 dex_filenames_.resize(kept);
2441 dex_locations_.resize(kept);
2442 }
2443
2444 bool AddDexFileSources() {
2445 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
Nicolas Geoffraybc177272018-01-24 14:55:32 +00002446 if (input_vdex_file_ != nullptr && input_vdex_file_->HasDexSection()) {
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002447 DCHECK_EQ(oat_writers_.size(), 1u);
2448 const std::string& name = zip_location_.empty() ? dex_locations_[0] : zip_location_;
2449 DCHECK(!name.empty());
2450 if (!oat_writers_[0]->AddVdexDexFilesSource(*input_vdex_file_.get(), name.c_str())) {
2451 return false;
2452 }
2453 } else if (zip_fd_ != -1) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002454 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002455 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2456 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002457 return false;
2458 }
2459 } else if (oat_writers_.size() > 1u) {
2460 // Multi-image.
2461 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2462 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2463 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2464 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2465 return false;
2466 }
2467 }
2468 } else {
2469 DCHECK_EQ(oat_writers_.size(), 1u);
2470 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2471 DCHECK_NE(dex_filenames_.size(), 0u);
2472 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2473 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2474 return false;
2475 }
2476 }
2477 }
2478 return true;
2479 }
2480
2481 void CreateOatWriters() {
2482 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2483 elf_writers_.reserve(oat_files_.size());
2484 oat_writers_.reserve(oat_files_.size());
2485 for (const std::unique_ptr<File>& oat_file : oat_files_) {
Vladimir Marko74527972016-11-29 15:57:32 +00002486 elf_writers_.emplace_back(linker::CreateElfWriterQuick(instruction_set_,
2487 instruction_set_features_.get(),
2488 compiler_options_.get(),
2489 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002490 elf_writers_.back()->Start();
Mathieu Chartier4a265c22018-04-09 14:25:14 -07002491 bool do_oat_writer_layout = DoDexLayoutOptimizations() || DoOatLayoutOptimizations();
2492 if (profile_compilation_info_ != nullptr && profile_compilation_info_->IsEmpty()) {
2493 do_oat_writer_layout = false;
2494 }
Vladimir Marko74527972016-11-29 15:57:32 +00002495 oat_writers_.emplace_back(new linker::OatWriter(
Igor Murashkin545412b2017-08-17 15:26:54 -07002496 IsBootImage(),
2497 timings_,
Mathieu Chartier603ccab2017-10-20 14:34:28 -07002498 do_oat_writer_layout ? profile_compilation_info_.get() : nullptr,
2499 compact_dex_level_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002500 }
2501 }
2502
Vladimir Marko49b0f452015-12-10 13:49:19 +00002503 void SaveDexInput() {
2504 for (size_t i = 0; i < dex_files_.size(); ++i) {
2505 const DexFile* dex_file = dex_files_[i];
2506 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2507 getpid(), i));
2508 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2509 if (tmp_file.get() == nullptr) {
2510 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2511 << ". Try: adb shell chmod 777 /data/local/tmp";
2512 continue;
2513 }
2514 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2515 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2516 UNUSED(tmp_file->Flush());
2517 UNUSED(tmp_file->Close());
2518 LOG(INFO) << "Wrote input to " << tmp_file_name;
2519 }
2520 }
2521
Mathieu Chartier46331a62017-07-21 09:49:10 -07002522 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options,
2523 QuickCompilerCallbacks* callbacks) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00002524 RuntimeOptions raw_options;
2525 if (boot_image_filename_.empty()) {
2526 std::string boot_class_path = "-Xbootclasspath:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002527 boot_class_path += android::base::Join(dex_filenames_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002528 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2529 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002530 boot_class_path_locations += android::base::Join(dex_locations_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002531 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2532 } else {
2533 std::string boot_image_option = "-Ximage:";
2534 boot_image_option += boot_image_filename_;
2535 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2536 }
2537 for (size_t i = 0; i < runtime_args_.size(); i++) {
2538 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2539 }
2540
Mathieu Chartier46331a62017-07-21 09:49:10 -07002541 raw_options.push_back(std::make_pair("compilercallbacks", callbacks));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002542 raw_options.push_back(
2543 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2544
2545 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2546 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2547 // have been stripped in preopting, anyways).
2548 if (!IsBootImage()) {
2549 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2550 }
Andreas Gampec8e35202017-04-28 15:47:12 -07002551 // Never allow implicit image compilation.
2552 raw_options.push_back(std::make_pair("-Xnoimage-dex2oat", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002553 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2554 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2555 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002556 // Disable Hspace compaction to save heap size virtual space.
2557 // Only need disable Hspace for OOM becasue background collector is equal to
2558 // foreground collector by default for dex2oat.
2559 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002560
Andreas Gampeace0dc12016-01-20 13:33:13 -08002561 if (compiler_options_->IsForceDeterminism()) {
Roland Levillainb81e9e92017-04-20 17:35:32 +01002562 // If we're asked to be deterministic, ensure non-concurrent GC for determinism.
2563 //
2564 // Note that with read barriers, this option is ignored, because Runtime::Init
2565 // overrides the foreground GC to be gc::kCollectorTypeCC when instantiating
2566 // gc::Heap. This is fine, as concurrent GC requests are not honored in dex2oat,
2567 // which uses an unstarted runtime.
Andreas Gampeace0dc12016-01-20 13:33:13 -08002568 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
Roland Levillainb81e9e92017-04-20 17:35:32 +01002569
Nicolas Geoffray7acddd82017-05-03 15:04:55 +01002570 // The default LOS implementation (map) is not deterministic. So disable it.
2571 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=disabled", nullptr));
Andreas Gampeace0dc12016-01-20 13:33:13 -08002572
2573 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2574 // compaction (done above) and ensure that neither foreground nor background collectors
2575 // are concurrent.
Roland Levillainb81e9e92017-04-20 17:35:32 +01002576 //
2577 // Likewise, this option is ignored with read barriers because Runtime::Init
2578 // overrides the background GC to be gc::kCollectorTypeCCBackground, but that's
2579 // fine too, for the same reason (see above).
Andreas Gampeace0dc12016-01-20 13:33:13 -08002580 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2581
2582 // To make identity hashcode deterministic, set a known seed.
2583 mirror::Object::SetHashCodeSeed(987654321U);
2584 }
2585
Vladimir Marko49b0f452015-12-10 13:49:19 +00002586 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2587 LOG(ERROR) << "Failed to parse runtime options";
2588 return false;
2589 }
2590 return true;
2591 }
2592
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002593 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002594 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2595 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002596 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002597 LOG(ERROR) << "Failed to create runtime";
2598 return false;
2599 }
Andreas Gampe49c144d2016-11-14 10:11:16 -08002600
2601 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2602 // "ps -a" don't change to non-descript "main."
2603 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2604
Vladimir Marko307dac92015-10-20 11:20:09 +01002605 runtime_.reset(Runtime::Current());
2606 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe8228cdf2017-05-30 15:03:54 -07002607 for (uint32_t i = 0; i < static_cast<uint32_t>(CalleeSaveType::kLastCalleeSaveType); ++i) {
2608 CalleeSaveType type = CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002609 if (!runtime_->HasCalleeSaveMethod(type)) {
2610 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002611 }
2612 }
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002613
2614 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2615 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002616 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002617
Vladimir Marko307dac92015-10-20 11:20:09 +01002618 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002619
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002620 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2621 // Runtime::Start, give it away now so that we don't starve GC.
2622 Thread* self = Thread::Current();
2623 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002624
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002625 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002626 }
2627
Jeff Haodcdc85b2015-12-04 14:06:18 -08002628 // 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 -08002629 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002630 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002631 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002632 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002633 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002634 image_filenames_.push_back(app_image_file_name_.c_str());
2635 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002636 if (!image_writer_->Write(app_image_fd_,
2637 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002638 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002639 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002640 return false;
2641 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002642
Jeff Haodcdc85b2015-12-04 14:06:18 -08002643 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002644 dchecked_vector<uintptr_t> oat_data_begins;
2645 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2646 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002647 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002648 // Destroy ImageWriter before doing FixupElf.
2649 image_writer_.reset();
2650
Vladimir Marko944da602016-02-19 12:27:55 +00002651 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2652 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002653 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2654 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2655 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2656 if (oat_file.get() == nullptr) {
2657 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2658 return false;
2659 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002660
Vladimir Marko74527972016-11-29 15:57:32 +00002661 if (!linker::ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002662 oat_file->Erase();
2663 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2664 return false;
2665 }
2666
2667 if (oat_file->FlushCloseOrErase()) {
2668 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2669 return false;
2670 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002671 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002672 }
2673
2674 return true;
2675 }
2676
2677 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002678 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2679 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002680 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002681 return ReadCommentedInputFromFile<std::unordered_set<std::string>>(image_classes_filename,
2682 &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002683 }
2684
2685 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002686 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002687 const char* zip_filename,
2688 const char* image_classes_filename,
2689 std::string* error_msg) {
2690 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002691 return ReadCommentedInputFromZip<std::unordered_set<std::string>>(zip_filename,
2692 image_classes_filename,
2693 &process,
2694 error_msg);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002695 }
2696
2697 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2698 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002699 template <typename T>
2700 static T* ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002701 const char* input_filename, std::function<std::string(const char*)>* process) {
2702 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2703 if (input_file.get() == nullptr) {
2704 LOG(ERROR) << "Failed to open input file " << input_filename;
2705 return nullptr;
2706 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002707 std::unique_ptr<T> result(
2708 ReadCommentedInputStream<T>(*input_file, process));
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002709 input_file->close();
2710 return result.release();
2711 }
2712
2713 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2714 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002715 template <typename T>
2716 static T* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002717 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002718 const char* input_filename,
2719 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002720 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002721 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2722 if (zip_archive.get() == nullptr) {
2723 return nullptr;
2724 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002725 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002726 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002727 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002728 zip_filename, error_msg->c_str());
2729 return nullptr;
2730 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002731 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2732 input_filename,
2733 error_msg));
2734 if (input_file.get() == nullptr) {
2735 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002736 zip_filename, error_msg->c_str());
2737 return nullptr;
2738 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002739 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2740 input_file->Size());
2741 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002742 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002743 }
2744
2745 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2746 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002747 template <typename T>
2748 static T* ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002749 std::istream& in_stream,
2750 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002751 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002752 while (in_stream.good()) {
2753 std::string dot;
2754 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08002755 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002756 continue;
2757 }
2758 if (process != nullptr) {
2759 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002760 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002761 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002762 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002763 }
2764 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002765 return output.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002766 }
2767
Mathieu Chartier49285c52014-12-02 15:43:48 -08002768 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002769 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2770 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002771 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampec560fc02014-07-16 09:57:39 -07002772 LOG(INFO) << "dex2oat took "
2773 << PrettyDuration(NanoTime() - start_ns_)
Andreas Gampecc967752016-12-12 13:49:00 -08002774 << " (" << PrettyDuration(ProcessCpuNanoTime() - start_cputime_ns_) << " cpu)"
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002775 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002776 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002777 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2778 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002779 }
2780
Jeff Haodcdc85b2015-12-04 14:06:18 -08002781 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2782 std::string res(image_filename);
2783 size_t last_slash = res.rfind('/');
2784 if (last_slash == std::string::npos || last_slash == 0) {
2785 return res;
2786 }
2787 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2788 if (penultimate_slash == std::string::npos) {
2789 return res;
2790 }
2791 // Check that the string in-between is the expected one.
2792 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2793 GetInstructionSetString(isa)) {
2794 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2795 return res;
2796 }
2797 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2798 }
2799
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002800 std::unique_ptr<CompilerOptions> compiler_options_;
2801 Compiler::Kind compiler_kind_;
2802
2803 InstructionSet instruction_set_;
2804 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2805
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002806 uint32_t image_file_location_oat_checksum_;
2807 uintptr_t image_file_location_oat_data_begin_;
2808 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002809 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2810
Vladimir Marko307dac92015-10-20 11:20:09 +01002811 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002812
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002813 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2814
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002815 std::unique_ptr<Runtime> runtime_;
2816
Calin Juravle1ce70852017-06-28 10:59:03 -07002817 // The spec describing how the class loader should be setup for compilation.
2818 std::unique_ptr<ClassLoaderContext> class_loader_context_;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002819
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07002820 // The class loader context stored in the oat file. May be equal to class_loader_context_.
Mathieu Chartierc4440772018-04-16 14:40:56 -07002821 std::unique_ptr<ClassLoaderContext> stored_class_loader_context_;
Mathieu Chartierf5abfc42018-03-23 21:51:54 -07002822
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002823 size_t thread_count_;
2824 uint64_t start_ns_;
Andreas Gampec560fc02014-07-16 09:57:39 -07002825 uint64_t start_cputime_ns_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002826 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002827 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002828 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002829 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002830 std::vector<const char*> oat_filenames_;
2831 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002832 int oat_fd_;
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00002833 int input_vdex_fd_;
2834 int output_vdex_fd_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002835 std::string input_vdex_;
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01002836 std::string output_vdex_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002837 std::unique_ptr<VdexFile> input_vdex_file_;
Nicolas Geoffraybaeaa9b2018-01-26 14:31:17 +00002838 int dm_fd_;
2839 std::string dm_file_location_;
2840 std::unique_ptr<ZipArchive> dm_file_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002841 std::vector<const char*> dex_filenames_;
2842 std::vector<const char*> dex_locations_;
2843 int zip_fd_;
2844 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002845 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002846 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002847 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002848 uintptr_t image_base_;
2849 const char* image_classes_zip_filename_;
2850 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002851 ImageHeader::StorageMode image_storage_mode_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002852 const char* passes_to_run_filename_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002853 const char* dirty_image_objects_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002854 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2855 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002856 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002857 std::unique_ptr<std::unordered_set<std::string>> dirty_image_objects_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002858 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Jeff Hao436183f2016-01-12 16:36:50 -08002859 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002860 bool is_host_;
2861 std::string android_root_;
Mathieu Chartier0b490842016-05-25 15:05:59 -07002862 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002863 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002864 std::string no_inline_from_string_;
Mathieu Chartiera7f6b812017-12-11 13:34:29 -08002865 CompactDexLevel compact_dex_level_ = kDefaultCompactDexLevel;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002866
Vladimir Marko74527972016-11-29 15:57:32 +00002867 std::vector<std::unique_ptr<linker::ElfWriter>> elf_writers_;
2868 std::vector<std::unique_ptr<linker::OatWriter>> oat_writers_;
2869 std::vector<linker::OutputStream*> rodata_;
2870 std::vector<std::unique_ptr<linker::OutputStream>> vdex_out_;
2871 std::unique_ptr<linker::ImageWriter> image_writer_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002872 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002873
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002874 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
2875 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2876
Calin Juravle1ce70852017-06-28 10:59:03 -07002877 // Note that this might contain pointers owned by class_loader_context_.
Vladimir Marko47496c22016-01-27 16:15:08 +00002878 std::vector<const DexFile*> no_inline_from_dex_files_;
2879
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07002880 bool avoid_storing_invocation_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002881 std::string swap_file_name_;
2882 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002883 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2884 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002885 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002886 std::string app_image_file_name_;
2887 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002888 std::string profile_file_;
2889 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002890 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002891 TimingLogger* timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002892 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002893 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002894
2895 // Backing storage.
Andreas Gampe097f34c2017-08-23 08:57:51 -07002896 std::forward_list<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002897
Andreas Gampeace0dc12016-01-20 13:33:13 -08002898 // See CompilerOptions.force_determinism_.
2899 bool force_determinism_;
2900
Jeff Hao16d48432017-04-05 17:05:46 -07002901 // Directory of relative classpaths.
2902 std::string classpath_dir_;
2903
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00002904 // Whether the given input vdex is also the output.
2905 bool update_input_vdex_ = false;
2906
Nicolas Geoffray66ff8a82018-02-28 13:27:55 +00002907 // By default, copy the dex to the vdex file only if dex files are
2908 // compressed in APK.
2909 CopyOption copy_dex_files_ = CopyOption::kOnlyIfCompressed;
Mathieu Chartier792111c2018-02-15 13:02:15 -08002910
Calin Juravle0e09dfc2018-02-12 19:01:09 -08002911 // The reason for invoking the compiler.
2912 std::string compilation_reason_;
2913
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002914 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2915};
2916
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002917static void b13564922() {
2918#if defined(__linux__) && defined(__arm__)
2919 int major, minor;
2920 struct utsname uts;
2921 if (uname(&uts) != -1 &&
2922 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2923 ((major < 3) || ((major == 3) && (minor < 4)))) {
2924 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2925 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2926 int old_personality = personality(0xffffffff);
2927 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2928 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2929 if (new_personality == -1) {
2930 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2931 }
2932 }
2933 }
2934#endif
2935}
2936
Mathieu Chartier72041a02017-07-14 18:23:25 -07002937class ScopedGlobalRef {
2938 public:
2939 explicit ScopedGlobalRef(jobject obj) : obj_(obj) {}
2940 ~ScopedGlobalRef() {
2941 if (obj_ != nullptr) {
2942 ScopedObjectAccess soa(Thread::Current());
Ian Rogers55256cb2017-12-21 17:07:11 -08002943 soa.Env()->GetVm()->DeleteGlobalRef(soa.Self(), obj_);
Mathieu Chartier72041a02017-07-14 18:23:25 -07002944 }
2945 }
2946
2947 private:
2948 jobject obj_;
2949};
2950
Andreas Gampe7b565912017-03-20 15:48:52 -07002951static dex2oat::ReturnCode CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002952 dex2oat.LoadClassProfileDescriptors();
Mathieu Chartier9e050df2017-08-09 10:05:47 -07002953 // Keep the class loader that was used for compilation live for the rest of the compilation
2954 // process.
Mathieu Chartier72041a02017-07-14 18:23:25 -07002955 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08002956
David Brazdil7b49e6c2016-09-01 11:06:18 +01002957 if (!dex2oat.WriteOutputFiles()) {
2958 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002959 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002960 }
2961
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002962 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2963 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2964 // image writer will require this fd to generate the image.
2965 if (dex2oat.ShouldKeepOatFileOpen()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002966 if (!dex2oat.FlushOutputFiles()) {
2967 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002968 return dex2oat::ReturnCode::kOther;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002969 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01002970 } else if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002971 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002972 }
2973
Jeff Haodcdc85b2015-12-04 14:06:18 -08002974 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002975 if (!dex2oat.HandleImage()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002976 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002977 }
2978
2979 // When given --host, finish early without stripping.
2980 if (dex2oat.IsHost()) {
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002981 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002982 return dex2oat::ReturnCode::kOther;
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002983 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002984 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002985 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002986 }
2987
Jeff Haodcdc85b2015-12-04 14:06:18 -08002988 // Copy stripped to unstripped location, if necessary.
2989 if (!dex2oat.CopyStrippedToUnstripped()) {
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 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002994 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002995 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002996 }
2997
2998 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002999 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003000}
3001
Andreas Gampe7b565912017-03-20 15:48:52 -07003002static dex2oat::ReturnCode CompileApp(Dex2Oat& dex2oat) {
Mathieu Chartier9e050df2017-08-09 10:05:47 -07003003 // Keep the class loader that was used for compilation live for the rest of the compilation
3004 // process.
Mathieu Chartier72041a02017-07-14 18:23:25 -07003005 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08003006
David Brazdil7b49e6c2016-09-01 11:06:18 +01003007 if (!dex2oat.WriteOutputFiles()) {
3008 dex2oat.EraseOutputFiles();
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 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08003013 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08003014
3015 // When given --host, finish early without stripping.
3016 if (dex2oat.IsHost()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003017 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003018 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003019 }
3020
3021 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003022 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003023 }
3024
Jeff Haodcdc85b2015-12-04 14:06:18 -08003025 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
3026 // stripped versions. If this is given, we expect to be able to open writable files by name.
3027 if (!dex2oat.CopyStrippedToUnstripped()) {
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 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01003032 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003033 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003034 }
3035
3036 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07003037 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08003038}
3039
Andreas Gampe7b565912017-03-20 15:48:52 -07003040static dex2oat::ReturnCode Dex2oat(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003041 b13564922();
3042
3043 TimingLogger timings("compiler", false, false);
3044
Roland Levillain5c7e2602016-02-23 18:08:53 +00003045 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
3046 // might produce a stack frame too large for this function or for
3047 // functions inlining it (such as main), that would not fit the
3048 // requirements of the `-Wframe-larger-than` option.
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07003049 std::unique_ptr<Dex2Oat> dex2oat = std::make_unique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003050
3051 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003052 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003053
Calin Juravleb077e152016-02-18 18:47:37 +00003054 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02003055 // This operation involves I/O.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08003056 if (dex2oat->UseProfile()) {
Calin Juravleb077e152016-02-18 18:47:37 +00003057 if (!dex2oat->LoadProfile()) {
3058 LOG(ERROR) << "Failed to process profile file";
Andreas Gampe7b565912017-03-20 15:48:52 -07003059 return dex2oat::ReturnCode::kOther;
Calin Juravle998c2162015-12-21 15:39:33 +02003060 }
3061 }
3062
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00003063 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap, and vdex.
3064
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003065 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00003066 if (!dex2oat->OpenFile()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003067 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003068 }
3069
Andreas Gampe046c7062015-05-18 23:22:54 -07003070 // Print the complete line when any of the following is true:
3071 // 1) Debug build
3072 // 2) Compiling an image
3073 // 3) Compiling with --host
3074 // 4) Compiling on the host (not a target build)
3075 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003076 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07003077 LOG(INFO) << CommandLine();
3078 } else {
3079 LOG(INFO) << StrippedCommandLine();
3080 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003081
Andreas Gampef7882972017-03-20 16:35:24 -07003082 dex2oat::ReturnCode setup_code = dex2oat->Setup();
3083 if (setup_code != dex2oat::ReturnCode::kNoFailure) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003084 dex2oat->EraseOutputFiles();
Andreas Gampef7882972017-03-20 16:35:24 -07003085 return setup_code;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003086 }
3087
Shubham Ajmera188b2bf2017-09-20 15:53:35 -07003088 // TODO: Due to the cyclic dependencies, profile loading and verifying are
3089 // being done separately. Refactor and place the two next to each other.
3090 // If verification fails, we don't abort the compilation and instead log an
3091 // error.
3092 // TODO(b/62602192, b/65260586): We should consider aborting compilation when
3093 // the profile verification fails.
3094 // Note: If dex2oat fails, installd will remove the oat files causing the app
3095 // to fallback to apk with possible in-memory extraction. We want to avoid
3096 // that, and thus we're lenient towards profile corruptions.
3097 if (dex2oat->UseProfile()) {
3098 dex2oat->VerifyProfileData();
3099 }
3100
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07003101 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
3102 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07003103 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
3104
Andreas Gampe7b565912017-03-20 15:48:52 -07003105 dex2oat::ReturnCode result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00003106 if (dex2oat->IsImage()) {
3107 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08003108 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00003109 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003110 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003111
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003112 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003113}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003114} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07003115
3116int main(int argc, char** argv) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003117 int result = static_cast<int>(art::Dex2oat(argc, argv));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003118 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
Pirama Arumuga Nainarab898922018-01-04 10:37:48 -08003119 // time (bug 10645725) unless we're a debug or instrumented build or running on valgrind. Note:
3120 // The Dex2Oat class should not destruct the runtime in this case.
3121 if (!art::kIsDebugBuild && !art::kIsPGOInstrumentation && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampee286b642017-04-13 12:20:42 -07003122 _exit(result);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003123 }
3124 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07003125}