blob: 27bec1d3e18d16470af460736929a96e9a3e95ea [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"
Andreas Gampe794ad762015-02-23 08:12:24 -080047#include "base/macros.h"
Calin Juravle2e2db782016-02-23 12:00:03 +000048#include "base/scoped_flock.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070049#include "base/stl_util.h"
50#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010051#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070052#include "base/timing_logger.h"
53#include "base/unix_file/fd_file.h"
54#include "class_linker.h"
Calin Juravle1ce70852017-06-28 10:59:03 -070055#include "class_loader_context.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070056#include "cmdline_parser.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000057#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000058#include "compiler_callbacks.h"
David Srbecky09c2a6b2016-03-11 17:11:44 +000059#include "debug/elf_debug_writer.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000060#include "debug/method_debug_info.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000061#include "dex/quick_compiler_callbacks.h"
62#include "dex/verification_results.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070063#include "dex2oat_options.h"
Andreas Gampe7b565912017-03-20 15:48:52 -070064#include "dex2oat_return_codes.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000065#include "dex_file-inl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070066#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080067#include "driver/compiler_options.h"
Andreas Gampe097f34c2017-08-23 08:57:51 -070068#include "driver/compiler_options_map-inl.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080069#include "elf_file.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070070#include "gc/space/image_space.h"
71#include "gc/space/space-inl.h"
Mathieu Chartier72041a02017-07-14 18:23:25 -070072#include "gc/verification.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070073#include "interpreter/unstarted_runtime.h"
Mathieu Chartier72041a02017-07-14 18:23:25 -070074#include "java_vm_ext.h"
Calin Juravle33083d62017-01-18 15:29:12 -080075#include "jit/profile_compilation_info.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070076#include "leb128.h"
David Brazdil5d5a36b2016-09-14 15:34:10 +010077#include "linker/buffered_output_stream.h"
Vladimir Marko74527972016-11-29 15:57:32 +000078#include "linker/elf_writer.h"
79#include "linker/elf_writer_quick.h"
David Brazdil5d5a36b2016-09-14 15:34:10 +010080#include "linker/file_output_stream.h"
Vladimir Marko74527972016-11-29 15:57:32 +000081#include "linker/image_writer.h"
Vladimir Marko944da602016-02-19 12:27:55 +000082#include "linker/multi_oat_relative_patcher.h"
Vladimir Marko74527972016-11-29 15:57:32 +000083#include "linker/oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070084#include "mirror/class-inl.h"
85#include "mirror/class_loader.h"
86#include "mirror/object-inl.h"
87#include "mirror/object_array-inl.h"
Andreas Gampe2ff3b972017-06-05 18:14:53 -070088#include "oat_file.h"
Jeff Haob11ffb72016-04-07 15:40:54 -070089#include "oat_file_assistant.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070090#include "os.h"
91#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000092#include "runtime_options.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070093#include "scoped_thread_state_change-inl.h"
Alex Light53cb16b2014-06-12 11:26:29 -070094#include "utils.h"
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +000095#include "vdex_file.h"
David Brazdilca3c8c32016-09-06 14:04:48 +010096#include "verifier/verifier_deps.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070097#include "well_known_classes.h"
98#include "zip_archive.h"
99
100namespace art {
101
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800102using android::base::StringAppendV;
103using android::base::StringPrintf;
104
Andreas Gampee1459ae2016-06-29 09:36:30 -0700105static constexpr size_t kDefaultMinDexFilesForSwap = 2;
106static constexpr size_t kDefaultMinDexFileCumulativeSizeForSwap = 20 * MB;
107
Mathieu Chartier010126f2017-07-15 15:44:18 -0700108// Compiler filter override for very large apps.
109static constexpr CompilerFilter::Filter kLargeAppFilter = CompilerFilter::kVerify;
110
Brian Carlstrom6449c622014-02-10 23:48:36 -0800111static int original_argc;
112static char** original_argv;
113
114static std::string CommandLine() {
115 std::vector<std::string> command;
116 for (int i = 0; i < original_argc; ++i) {
117 command.push_back(original_argv[i]);
118 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800119 return android::base::Join(command, ' ');
Brian Carlstrom6449c622014-02-10 23:48:36 -0800120}
121
Andreas Gampe046c7062015-05-18 23:22:54 -0700122// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
123// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
124// locations are all staged).
125static std::string StrippedCommandLine() {
126 std::vector<std::string> command;
127
Calin Juravle07c6d722017-06-07 17:06:12 +0000128 // Do a pre-pass to look for zip-fd and the compiler filter.
Andreas Gampe046c7062015-05-18 23:22:54 -0700129 bool saw_zip_fd = false;
Calin Juravle07c6d722017-06-07 17:06:12 +0000130 bool saw_compiler_filter = false;
Andreas Gampe046c7062015-05-18 23:22:54 -0700131 for (int i = 0; i < original_argc; ++i) {
Andreas Gampe9186ced2016-12-12 14:28:21 -0800132 if (android::base::StartsWith(original_argv[i], "--zip-fd=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700133 saw_zip_fd = true;
Andreas Gampe046c7062015-05-18 23:22:54 -0700134 }
Calin Juravle07c6d722017-06-07 17:06:12 +0000135 if (android::base::StartsWith(original_argv[i], "--compiler-filter=")) {
136 saw_compiler_filter = true;
Calin Juravle07c6d722017-06-07 17:06:12 +0000137 }
Andreas Gampe046c7062015-05-18 23:22:54 -0700138 }
139
140 // Now filter out things.
141 for (int i = 0; i < original_argc; ++i) {
142 // All runtime-arg parameters are dropped.
143 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
144 i++; // Drop the next part, too.
145 continue;
146 }
147
148 // Any instruction-setXXX is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800149 if (android::base::StartsWith(original_argv[i], "--instruction-set")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700150 continue;
151 }
152
153 // The boot image is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800154 if (android::base::StartsWith(original_argv[i], "--boot-image=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700155 continue;
156 }
157
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800158 // The image format is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800159 if (android::base::StartsWith(original_argv[i], "--image-format=")) {
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800160 continue;
161 }
162
Andreas Gampe046c7062015-05-18 23:22:54 -0700163 // This should leave any dex-file and oat-file options, describing what we compiled.
164
165 // However, we prefer to drop this when we saw --zip-fd.
166 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700167 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe9186ced2016-12-12 14:28:21 -0800168 if (android::base::StartsWith(original_argv[i], "--zip-") ||
169 android::base::StartsWith(original_argv[i], "--dex-") ||
170 android::base::StartsWith(original_argv[i], "--oat-") ||
171 android::base::StartsWith(original_argv[i], "--swap-") ||
172 android::base::StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700173 continue;
174 }
175 }
176
177 command.push_back(original_argv[i]);
178 }
179
Calin Juravle07c6d722017-06-07 17:06:12 +0000180 if (!saw_compiler_filter) {
181 command.push_back("--compiler-filter=" +
182 CompilerFilter::NameOfFilter(CompilerFilter::kDefaultCompilerFilter));
183 }
184
Andreas Gampe046c7062015-05-18 23:22:54 -0700185 // Construct the final output.
186 if (command.size() <= 1U) {
187 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
188 return "Starting dex2oat.";
189 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800190 return android::base::Join(command, ' ');
Andreas Gampe046c7062015-05-18 23:22:54 -0700191}
192
Brian Carlstrom7940e442013-07-12 13:46:57 -0700193static void UsageErrorV(const char* fmt, va_list ap) {
194 std::string error;
195 StringAppendV(&error, fmt, ap);
196 LOG(ERROR) << error;
197}
198
199static void UsageError(const char* fmt, ...) {
200 va_list ap;
201 va_start(ap, fmt);
202 UsageErrorV(fmt, ap);
203 va_end(ap);
204}
205
Andreas Gampe794ad762015-02-23 08:12:24 -0800206NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700207 va_list ap;
208 va_start(ap, fmt);
209 UsageErrorV(fmt, ap);
210 va_end(ap);
211
Brian Carlstrom6449c622014-02-10 23:48:36 -0800212 UsageError("Command: %s", CommandLine().c_str());
213
Brian Carlstrom7940e442013-07-12 13:46:57 -0700214 UsageError("Usage: dex2oat [options]...");
215 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100216 UsageError(" -j<number>: specifies the number of threads used for compilation.");
217 UsageError(" Default is the number of detected hardware threads available on the");
218 UsageError(" host system.");
219 UsageError(" Example: -j12");
220 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700221 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700222 UsageError(" Example: --dex-file=/system/framework/core.jar");
223 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700224 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
225 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
226 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
227 UsageError(" --dex-location=/system/framework/core.jar");
228 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700229 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
230 UsageError(" containing a classes.dex file to compile.");
231 UsageError(" Example: --zip-fd=5");
232 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700233 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
234 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700235 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
236 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800237 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700238 UsageError(" Example: --oat-file=/system/framework/boot.oat");
239 UsageError("");
240 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900241 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700242 UsageError("");
Shubham Ajmera66205322017-10-06 11:18:51 -0700243 UsageError(" --input-vdex-fd=<number>: specifies the vdex input source via a file descriptor.");
244 UsageError(" Example: --input-vdex-fd=6");
245 UsageError("");
246 UsageError(" --output-vdex-fd=<number>: specifies the vdex output destination via a file");
247 UsageError(" descriptor.");
248 UsageError(" Example: --output-vdex-fd=6");
249 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700250 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
251 UsageError(" to the file descriptor specified by --oat-fd.");
252 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
253 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800254 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700255 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
256 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800257 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700258 UsageError(" Example: --image=/system/framework/boot.art");
259 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800260 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800261 UsageError(" Which format to store the image.");
262 UsageError(" Example: --image-format=lz4");
263 UsageError(" Default: uncompressed");
264 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700265 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
266 UsageError(" Example: --image=frameworks/base/preloaded-classes");
267 UsageError("");
268 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
269 UsageError(" Example: --base=0x50000000");
270 UsageError("");
271 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000272 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700273 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000274 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000275 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700276 UsageError("");
277 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
278 UsageError(" Example: --android-root=out/host/linux-x86");
279 UsageError(" Default: $ANDROID_ROOT");
280 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800281 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700282 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700283 UsageError(" Example: --instruction-set=x86");
284 UsageError(" Default: arm");
285 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700286 UsageError(" --instruction-set-features=...,: Specify instruction set features");
287 UsageError(" Example: --instruction-set-features=div");
288 UsageError(" Default: default");
289 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700290 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
291 UsageError(" Default: disabled");
292 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800293 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700294 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800295 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100296 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700297 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100298 UsageError(" --compiler-filter="
Nicolas Geoffray49cda062017-04-21 13:08:25 +0100299 "(assume-verified"
300 "|extract"
301 "|verify"
302 "|quicken"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000303 "|space-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100304 "|space"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000305 "|speed-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100306 "|speed"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000307 "|everything-profile"
308 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700309 UsageError(" select compiler filter.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800310 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800311 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800312 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800313 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
314 UsageError(" method for compiler filter tuning.");
315 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
316 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
317 UsageError("");
318 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
319 UsageError(" method for compiler filter tuning.");
320 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
321 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
322 UsageError("");
323 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
324 UsageError(" method for compiler filter tuning.");
325 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
326 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
327 UsageError("");
328 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
329 UsageError(" method for compiler filter tuning.");
330 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
331 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
332 UsageError("");
333 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
334 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700335 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
336 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800337 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
338 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
339 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100340 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
341 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100342 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
343 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100344 UsageError(" Example: --inline-max-code-units=%d",
345 CompilerOptions::kDefaultInlineMaxCodeUnits);
346 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
347 UsageError("");
Ian Rogers46398602013-08-20 07:50:36 -0700348 UsageError(" --dump-timing: display a breakdown of where time was spent");
349 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100350 UsageError(" -g");
351 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
352 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000353 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000354 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700355 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100356 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100357 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000358 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
359 UsageError(" debug information necessary to print backtraces. (disabled by default)");
360 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000361 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000362 UsageError("");
Alexey Alexandrovab40c112016-09-19 09:33:49 -0700363 UsageError(" --generate-build-id: Generate GNU-compatible linker build ID ELF section with");
364 UsageError(" SHA-1 of the file content (and thus stable across identical builds)");
365 UsageError("");
366 UsageError(" --no-generate-build-id: Do not generate the build ID ELF section.");
367 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000368 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000369 UsageError("");
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700370 UsageError(" --avoid-storing-invocation: Avoid storing the invocation args in the key value");
371 UsageError(" store. Used to test determinism with different args.");
372 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700373 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
374 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
375 UsageError(" Use a separate --runtime-arg switch for each argument.");
376 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700377 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000378 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700379 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000380 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
381 UsageError(" Cannot be used together with --profile-file.");
382 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100383 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800384 UsageError(" Example: --swap-file=/data/tmp/swap.001");
385 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100386 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800387 UsageError(" Example: --swap-fd=10");
388 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100389 UsageError(" --swap-dex-size-threshold=<size>: specifies the minimum total dex file size in");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700390 UsageError(" bytes to allow the use of swap.");
391 UsageError(" Example: --swap-dex-size-threshold=1000000");
392 UsageError(" Default: %zu", kDefaultMinDexFileCumulativeSizeForSwap);
393 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100394 UsageError(" --swap-dex-count-threshold=<count>: specifies the minimum number of dex files to");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700395 UsageError(" allow the use of swap.");
396 UsageError(" Example: --swap-dex-count-threshold=10");
397 UsageError(" Default: %zu", kDefaultMinDexFilesForSwap);
398 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100399 UsageError(" --very-large-app-threshold=<size>: specifies the minimum total dex file size in");
Mathieu Chartier010126f2017-07-15 15:44:18 -0700400 UsageError(" bytes to consider the input \"very large\" and reduce compilation done.");
Andreas Gampe67f02822016-06-24 21:05:23 -0700401 UsageError(" Example: --very-large-app-threshold=100000000");
402 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700403 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
404 UsageError(" Example: --app-image-fd=10");
405 UsageError("");
406 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
407 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
408 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800409 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
410 "input dex file.");
411 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000412 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000413 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100414 UsageError(" --dump-cfg=<cfg-file>: dump control-flow graphs (CFGs) to specified file.");
415 UsageError(" Example: --dump-cfg=output.cfg");
416 UsageError("");
417 UsageError(" --dump-cfg-append: when dumping CFGs to an existing file, append new CFG data to");
418 UsageError(" existing data (instead of overwriting existing data with new data, which is");
419 UsageError(" the default behavior). This option is only meaningful when used with");
420 UsageError(" --dump-cfg.");
421 UsageError("");
Jeff Hao16d48432017-04-05 17:05:46 -0700422 UsageError(" --classpath-dir=<directory-path>: directory used to resolve relative class paths.");
423 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700424 UsageError(" --class-loader-context=<string spec>: a string specifying the intended");
425 UsageError(" runtime loading context for the compiled dex files.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700426 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700427 UsageError(" It describes how the class loader chain should be built in order to ensure");
428 UsageError(" classes are resolved during dex2aot as they would be resolved at runtime.");
429 UsageError(" This spec will be encoded in the oat file. If at runtime the dex file is");
430 UsageError(" loaded in a different context, the oat file will be rejected.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700431 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700432 UsageError(" The chain is interpreted in the natural 'parent order', meaning that class");
433 UsageError(" loader 'i+1' will be the parent of class loader 'i'.");
Calin Juravlec79470d2017-07-12 17:37:42 -0700434 UsageError(" The compilation sources will be appended to the classpath of the first class");
435 UsageError(" loader.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700436 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700437 UsageError(" E.g. if the context is 'PCL[lib1.dex];DLC[lib2.dex]' and ");
438 UsageError(" --dex-file=src.dex then dex2oat will setup a PathClassLoader with classpath ");
439 UsageError(" 'lib1.dex:src.dex' and set its parent to a DelegateLastClassLoader with ");
440 UsageError(" classpath 'lib2.dex'.");
Calin Juravle1ce70852017-06-28 10:59:03 -0700441 UsageError(" ");
442 UsageError(" Note that the compiler will be tolerant if the source dex files specified");
443 UsageError(" with --dex-file are found in the classpath. The source dex files will be");
444 UsageError(" removed from any class loader's classpath possibly resulting in empty");
445 UsageError(" class loaders.");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700446 UsageError("");
Calin Juravlec79470d2017-07-12 17:37:42 -0700447 UsageError(" Example: --class-loader-context=PCL[lib1.dex:lib2.dex];DLC[lib3.dex]");
Calin Juravle1ce70852017-06-28 10:59:03 -0700448 UsageError("");
Jeff Haoc23b0c02017-07-27 18:19:38 -0700449 UsageError(" --dirty-image-objects=<directory-path>: list of known dirty objects in the image.");
450 UsageError(" The image writer will group them together.");
451 UsageError("");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700452 UsageError(" --compact-dex-level=none|fast: None avoids generating compact dex, fast");
Mathieu Chartier24066ec2017-10-21 16:01:08 -0700453 UsageError(" generates compact dex with low compile time.");
Mathieu Chartiereafe2a52017-10-19 15:29:42 -0700454 UsageError("");
Andreas Gampee20ff6f2017-11-07 15:00:35 -0800455 UsageError(" --deduplicate-code=true|false: enable|disable code deduplication. Deduplicated");
456 UsageError(" code will have an arbitrary symbol tagged with [DEDUPED].");
Andreas Gampecac31ad2017-11-06 20:01:17 -0800457 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700458 std::cerr << "See log for usage error information\n";
459 exit(EXIT_FAILURE);
460}
461
Brian Carlstrom7940e442013-07-12 13:46:57 -0700462// The primary goal of the watchdog is to prevent stuck build servers
463// during development when fatal aborts lead to a cascade of failures
464// that result in a deadlock.
465class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800466// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700467#undef CHECK_PTHREAD_CALL
468#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
469 do { \
470 int rc = call args; \
471 if (rc != 0) { \
472 errno = rc; \
473 std::string message(# call); \
474 message += " failed for "; \
475 message += reason; \
476 Fatal(message); \
477 } \
478 } while (false)
479
480 public:
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800481 explicit WatchDog(int64_t timeout_in_milliseconds)
482 : timeout_in_milliseconds_(timeout_in_milliseconds),
483 shutting_down_(false) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700484 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700485 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800486#ifndef __APPLE__
487 pthread_condattr_t condattr;
liulvping8f7101e2017-01-16 15:14:43 +0800488 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_init, (&condattr), reason);
489 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_setclock, (&condattr, CLOCK_MONOTONIC), reason);
490 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, &condattr), reason);
491 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_destroy, (&condattr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800492#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700493 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
494 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
495 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
496 }
497 ~WatchDog() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700498 const char* reason = "dex2oat watch dog thread shutdown";
499 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
500 shutting_down_ = true;
501 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
502 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
503
Kenny Root51316382014-05-13 14:59:37 -0700504 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700505
506 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
507 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
508 }
509
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800510 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
511 // large.
512 static constexpr int64_t kWatchdogVerifyMultiplier =
513 kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
514
515 // When setting timeouts, keep in mind that the build server may not be as fast as your
516 // desktop. Debug builds are slower so they have larger timeouts.
517 static constexpr int64_t kWatchdogSlowdownFactor = kIsDebugBuild ? 5U : 1U;
518
519 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
520 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
521 // itself before that watchdog would take down the system server.
522 static constexpr int64_t kWatchDogTimeoutSeconds = kWatchdogSlowdownFactor * (9 * 60 + 30);
523
524 static constexpr int64_t kDefaultWatchdogTimeoutInMS =
525 kWatchdogVerifyMultiplier * kWatchDogTimeoutSeconds * 1000;
526
Brian Carlstrom7940e442013-07-12 13:46:57 -0700527 private:
528 static void* CallBack(void* arg) {
529 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
530 ::art::SetThreadName("dex2oat watch dog");
531 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700532 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700533 }
534
Andreas Gampe794ad762015-02-23 08:12:24 -0800535 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700536 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
537 // it's rather easy to hang in unwinding.
538 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
539 // logcat logging or stderr output.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700540 android::base::LogMessage::LogLine(__FILE__,
541 __LINE__,
542 android::base::LogId::DEFAULT,
543 LogSeverity::FATAL,
544 message.c_str());
Andreas Gampe48fde372017-06-06 07:43:46 -0700545 // If we're on the host, try to dump all threads to get a sense of what's going on. This is
546 // restricted to the host as the dump may itself go bad.
547 // TODO: Use a double watchdog timeout, so we can enable this on-device.
548 if (!kIsTargetBuild && Runtime::Current() != nullptr) {
Andreas Gampecd607312017-06-05 17:03:05 -0700549 Runtime::Current()->AttachCurrentThread("Watchdog thread attached for dumping",
550 true,
551 nullptr,
552 false);
553 Runtime::Current()->DumpForSigQuit(std::cerr);
554 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700555 exit(1);
556 }
557
558 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700559 timespec timeout_ts;
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800560#if defined(__APPLE__)
561 InitTimeSpec(true, CLOCK_REALTIME, timeout_in_milliseconds_, 0, &timeout_ts);
562#else
liulvping8f7101e2017-01-16 15:14:43 +0800563 InitTimeSpec(true, CLOCK_MONOTONIC, timeout_in_milliseconds_, 0, &timeout_ts);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800564#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700565 const char* reason = "dex2oat watch dog thread waiting";
566 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
567 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800568 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700569 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700570 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800571 timeout_in_milliseconds_/1000));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700572 } else if (rc != 0) {
573 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
574 strerror(errno)));
575 Fatal(message.c_str());
576 }
577 }
578 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
579 }
580
Brian Carlstrom7940e442013-07-12 13:46:57 -0700581 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
582 pthread_mutex_t mutex_;
583 pthread_cond_t cond_;
584 pthread_attr_t attr_;
585 pthread_t pthread_;
Andreas Gampef45d61c2017-06-07 10:29:33 -0700586
587 const int64_t timeout_in_milliseconds_;
588 bool shutting_down_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700589};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700590
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800591class Dex2Oat FINAL {
592 public:
593 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100594 compiler_kind_(Compiler::kOptimizing),
Vladimir Marko33bff252017-11-01 14:35:42 +0000595 instruction_set_(kRuntimeISA == InstructionSet::kArm ? InstructionSet::kThumb2 : kRuntimeISA),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800596 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000597 image_file_location_oat_checksum_(0),
598 image_file_location_oat_data_begin_(0),
599 image_patch_delta_(0),
600 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700601 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800602 runtime_(nullptr),
603 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
604 start_ns_(NanoTime()),
Andreas Gampec560fc02014-07-16 09:57:39 -0700605 start_cputime_ns_(ProcessCpuNanoTime()),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800606 oat_fd_(-1),
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000607 input_vdex_fd_(-1),
608 output_vdex_fd_(-1),
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000609 input_vdex_file_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800610 zip_fd_(-1),
611 image_base_(0U),
612 image_classes_zip_filename_(nullptr),
613 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800614 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800615 compiled_classes_zip_filename_(nullptr),
616 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700617 compiled_methods_zip_filename_(nullptr),
618 compiled_methods_filename_(nullptr),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700619 passes_to_run_filename_(nullptr),
Mathieu Chartierff0baff2017-08-02 23:04:19 -0700620 dirty_image_objects_filename_(nullptr),
Jeff Hao436183f2016-01-12 16:36:50 -0800621 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800622 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000623 elf_writers_(),
624 oat_writers_(),
625 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000626 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700627 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000628 opened_dex_files_maps_(),
629 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000630 no_inline_from_dex_files_(),
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700631 avoid_storing_invocation_(false),
Calin Juravle2e2db782016-02-23 12:00:03 +0000632 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800633 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000634 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800635 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000636 force_determinism_(false)
637 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800638
639 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800640 // Log completion time before deleting the runtime_, because this accesses
641 // the runtime.
642 LogCompletionTime();
643
Vladimir Marko307dac92015-10-20 11:20:09 +0100644 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
645 // We want to just exit on non-debug builds, not bringing the runtime down
646 // in an orderly fashion. So release the following fields.
647 driver_.release();
648 image_writer_.release();
649 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
650 dex_file.release();
651 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000652 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
653 map.release();
654 }
David Brazdil7b49e6c2016-09-01 11:06:18 +0100655 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
656 vdex_file.release();
657 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800658 for (std::unique_ptr<File>& oat_file : oat_files_) {
659 oat_file.release();
660 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100661 runtime_.release();
662 verification_results_.release();
663 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100664 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700665 }
666
Roland Levillain9ec5e222015-08-17 20:18:41 +0100667 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800668 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800669 std::string boot_image_filename;
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800670 int64_t watch_dog_timeout_in_ms = -1;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800671 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000672 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800673 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100674 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800675
Andreas Gampe097f34c2017-08-23 08:57:51 -0700676 void ParseBase(const std::string& option) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100677 char* end;
Andreas Gampe097f34c2017-08-23 08:57:51 -0700678 image_base_ = strtoul(option.c_str(), &end, 16);
679 if (end == option.c_str() || *end != '\0') {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100680 Usage("Failed to parse hexadecimal value for option %s", option.data());
681 }
682 }
683
Shubham Ajmera188b2bf2017-09-20 15:53:35 -0700684 bool VerifyProfileData() {
685 return profile_compilation_info_->VerifyProfileData(dex_files_);
686 }
687
Andreas Gampe097f34c2017-08-23 08:57:51 -0700688 void ParseInstructionSetVariant(const std::string& option, ParserOptions* parser_options) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800689 instruction_set_features_ = InstructionSetFeatures::FromVariant(
Andreas Gampe097f34c2017-08-23 08:57:51 -0700690 instruction_set_, option, &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100691 if (instruction_set_features_.get() == nullptr) {
692 Usage("%s", parser_options->error_msg.c_str());
693 }
694 }
695
Andreas Gampe097f34c2017-08-23 08:57:51 -0700696 void ParseInstructionSetFeatures(const std::string& option, ParserOptions* parser_options) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800697 if (instruction_set_features_ == nullptr) {
698 instruction_set_features_ = InstructionSetFeatures::FromVariant(
699 instruction_set_, "default", &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100700 if (instruction_set_features_.get() == nullptr) {
701 Usage("Problem initializing default instruction set features variant: %s",
702 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700703 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800704 }
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800705 instruction_set_features_ =
Andreas Gampe097f34c2017-08-23 08:57:51 -0700706 instruction_set_features_->AddFeaturesFromString(option, &parser_options->error_msg);
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800707 if (instruction_set_features_ == nullptr) {
Andreas Gampe097f34c2017-08-23 08:57:51 -0700708 Usage("Error parsing '%s': %s", option.c_str(), parser_options->error_msg.c_str());
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800709 }
710 }
711
Jeff Hao436183f2016-01-12 16:36:50 -0800712 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoaad75c62016-10-03 08:46:48 +0000713 compiler_options_->boot_image_ = !image_filenames_.empty();
714 compiler_options_->app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700715
Roland Levillain2b03a1f2017-06-06 16:09:59 +0100716 if (IsBootImage() && image_filenames_.size() == 1) {
717 const std::string& boot_image_filename = image_filenames_[0];
718 compiler_options_->core_image_ = CompilerDriver::IsCoreImageFilename(boot_image_filename);
719 }
720
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700721 if (IsAppImage() && IsBootImage()) {
722 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
723 }
724
Jeff Haodcdc85b2015-12-04 14:06:18 -0800725 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800726 Usage("Output must be supplied with either --oat-file or --oat-fd");
727 }
728
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000729 if (input_vdex_fd_ != -1 && !input_vdex_.empty()) {
730 Usage("Can't have both --input-vdex-fd and --input-vdex");
731 }
732
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +0100733 if (output_vdex_fd_ != -1 && !output_vdex_.empty()) {
734 Usage("Can't have both --output-vdex-fd and --output-vdex");
735 }
736
Jeff Haodcdc85b2015-12-04 14:06:18 -0800737 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800738 Usage("--oat-file should not be used with --oat-fd");
739 }
740
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000741 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +0100742 Usage("VDEX and OAT output must be specified either with one --oat-filename "
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000743 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100744 }
745
Roland Levillain9ec5e222015-08-17 20:18:41 +0100746 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800747 Usage("--oat-symbols should not be used with --oat-fd");
748 }
749
Roland Levillain9ec5e222015-08-17 20:18:41 +0100750 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800751 Usage("--oat-symbols should not be used with --host");
752 }
753
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000754 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
755 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100756 }
757
Jeff Haodcdc85b2015-12-04 14:06:18 -0800758 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800759 Usage("--oat-fd should not be used with --image");
760 }
761
Jeff Haodcdc85b2015-12-04 14:06:18 -0800762 if (!parser_options->oat_symbols.empty() &&
763 parser_options->oat_symbols.size() != oat_filenames_.size()) {
764 Usage("--oat-file arguments do not match --oat-symbols arguments");
765 }
766
767 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
768 Usage("--oat-file arguments do not match --image arguments");
769 }
770
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800771 if (android_root_.empty()) {
772 const char* android_root_env_var = getenv("ANDROID_ROOT");
773 if (android_root_env_var == nullptr) {
774 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700775 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800776 android_root_ += android_root_env_var;
777 }
778
Vladimir Markoaad75c62016-10-03 08:46:48 +0000779 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100780 parser_options->boot_image_filename += android_root_;
781 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800782 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100783 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000784 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800785 }
786
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700787 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800788 Usage("--image-classes should only be used with --image");
789 }
790
Vladimir Marko49b0f452015-12-10 13:49:19 +0000791 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800792 Usage("--image-classes should not be used with --boot-image");
793 }
794
795 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
796 Usage("--image-classes-zip should be used with --image-classes");
797 }
798
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700799 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800800 Usage("--compiled-classes should only be used with --image");
801 }
802
Vladimir Marko49b0f452015-12-10 13:49:19 +0000803 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800804 Usage("--compiled-classes should not be used with --boot-image");
805 }
806
807 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
808 Usage("--compiled-classes-zip should be used with --compiled-classes");
809 }
810
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800811 if (dex_filenames_.empty() && zip_fd_ == -1) {
812 Usage("Input must be supplied with either --dex-file or --zip-fd");
813 }
814
815 if (!dex_filenames_.empty() && zip_fd_ != -1) {
816 Usage("--dex-file should not be used with --zip-fd");
817 }
818
819 if (!dex_filenames_.empty() && !zip_location_.empty()) {
820 Usage("--dex-file should not be used with --zip-location");
821 }
822
823 if (dex_locations_.empty()) {
824 for (const char* dex_file_name : dex_filenames_) {
825 dex_locations_.push_back(dex_file_name);
826 }
827 } else if (dex_locations_.size() != dex_filenames_.size()) {
828 Usage("--dex-location arguments do not match --dex-file arguments");
829 }
830
Jeff Haodcdc85b2015-12-04 14:06:18 -0800831 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
832 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
833 Usage("--oat-file arguments must be singular or match --dex-file arguments");
834 }
835 }
836
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800837 if (zip_fd_ != -1 && zip_location_.empty()) {
838 Usage("--zip-location should be supplied with --zip-fd");
839 }
840
Vladimir Marko49b0f452015-12-10 13:49:19 +0000841 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800842 if (image_base_ == 0) {
843 Usage("Non-zero --base not specified");
844 }
845 }
846
Mathieu Chartiera8077802016-03-16 19:08:31 -0700847 const bool have_profile_file = !profile_file_.empty();
848 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
849 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000850 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200851 }
852
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -0700853 if (have_profile_file || have_profile_fd) {
854 if (compiled_classes_filename_ != nullptr ||
855 compiled_classes_zip_filename_ != nullptr ||
856 image_classes_filename_ != nullptr ||
857 image_classes_zip_filename_ != nullptr) {
858 Usage("Profile based image creation is not supported with image or compiled classes");
859 }
860 }
861
Roland Levillain9ec5e222015-08-17 20:18:41 +0100862 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800863 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800864 }
865
866 // If no instruction set feature was given, use the default one for the target
867 // instruction set.
868 if (instruction_set_features_.get() == nullptr) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800869 instruction_set_features_ = InstructionSetFeatures::FromVariant(
870 instruction_set_, "default", &parser_options->error_msg);
Ian Rogersd582fa42014-11-05 23:46:43 -0800871 if (instruction_set_features_.get() == nullptr) {
872 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100873 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800874 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800875 }
876
877 if (instruction_set_ == kRuntimeISA) {
878 std::unique_ptr<const InstructionSetFeatures> runtime_features(
879 InstructionSetFeatures::FromCppDefines());
880 if (!instruction_set_features_->Equals(runtime_features.get())) {
881 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
882 << *instruction_set_features_ << ") and those of dex2oat executable ("
883 << *runtime_features <<") for the command line:\n"
884 << CommandLine();
885 }
886 }
887
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000888 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +0000889 compiler_options_->inline_max_code_units_ = CompilerOptions::kDefaultInlineMaxCodeUnits;
Roland Levillaina215b952015-08-07 11:38:32 +0100890 }
891
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800892 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800893 // Set the compilation target's implicit checks options.
894 switch (instruction_set_) {
Vladimir Marko33bff252017-11-01 14:35:42 +0000895 case InstructionSet::kArm:
896 case InstructionSet::kThumb2:
897 case InstructionSet::kArm64:
898 case InstructionSet::kX86:
899 case InstructionSet::kX86_64:
900 case InstructionSet::kMips:
901 case InstructionSet::kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000902 compiler_options_->implicit_null_checks_ = true;
903 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800904 break;
905
906 default:
907 // Defaults are correct.
908 break;
909 }
910
Jeff Hao436183f2016-01-12 16:36:50 -0800911 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800912 Usage("--multi-image can only be used when creating boot images");
913 }
Jeff Hao436183f2016-01-12 16:36:50 -0800914 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800915 Usage("--multi-image cannot be used with multiple image names");
916 }
917
918 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
919 if (!kIsTargetBuild && IsBootImage()) {
920 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800921 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800922 }
923 }
924
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800925 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100926 if (parser_options->watch_dog_enabled) {
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800927 int64_t timeout = parser_options->watch_dog_timeout_in_ms > 0
928 ? parser_options->watch_dog_timeout_in_ms
929 : WatchDog::kDefaultWatchdogTimeoutInMS;
930 watchdog_.reset(new WatchDog(timeout));
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800931 }
932
933 // Fill some values into the key-value store for the oat header.
934 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800935
Roland Levillainb81e9e92017-04-20 17:35:32 +0100936 // Automatically force determinism for the boot image in a host build if read barriers
937 // are enabled, or if the default GC is CMS or MS. When the default GC is CMS
938 // (Concurrent Mark-Sweep), the GC is switched to a non-concurrent one by passing the
939 // option `-Xgc:nonconcurrent` (see below).
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800940 if (!kIsTargetBuild && IsBootImage()) {
941 if (SupportsDeterministicCompilation()) {
942 force_determinism_ = true;
943 } else {
944 LOG(WARNING) << "Deterministic compilation is disabled.";
945 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800946 }
947 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700948
949 if (passes_to_run_filename_ != nullptr) {
950 passes_to_run_.reset(ReadCommentedInputFromFile<std::vector<std::string>>(
951 passes_to_run_filename_,
952 nullptr)); // No post-processing.
953 if (passes_to_run_.get() == nullptr) {
954 Usage("Failed to read list of passes to run.");
955 }
956 }
957 compiler_options_->passes_to_run_ = passes_to_run_.get();
Roland Levillain9ec5e222015-08-17 20:18:41 +0100958 }
959
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800960 static bool SupportsDeterministicCompilation() {
Roland Levillainb81e9e92017-04-20 17:35:32 +0100961 return (kUseReadBarrier ||
962 gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
963 gc::kCollectorTypeDefault == gc::kCollectorTypeMS);
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800964 }
965
Jeff Hao436183f2016-01-12 16:36:50 -0800966 void ExpandOatAndImageFilenames() {
967 std::string base_oat = oat_filenames_[0];
968 size_t last_oat_slash = base_oat.rfind('/');
969 if (last_oat_slash == std::string::npos) {
970 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
971 }
972 // We also need to honor path components that were encoded through '@'. Otherwise the loading
973 // code won't be able to find the images.
974 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
975 last_oat_slash = base_oat.rfind('@');
976 }
977 base_oat = base_oat.substr(0, last_oat_slash + 1);
978
979 std::string base_img = image_filenames_[0];
980 size_t last_img_slash = base_img.rfind('/');
981 if (last_img_slash == std::string::npos) {
982 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
983 }
984 // We also need to honor path components that were encoded through '@'. Otherwise the loading
985 // code won't be able to find the images.
986 if (base_img.find('@', last_img_slash) != std::string::npos) {
987 last_img_slash = base_img.rfind('@');
988 }
989
990 // Get the prefix, which is the primary image name (without path components). Strip the
991 // extension.
992 std::string prefix = base_img.substr(last_img_slash + 1);
993 if (prefix.rfind('.') != std::string::npos) {
994 prefix = prefix.substr(0, prefix.rfind('.'));
995 }
996 if (!prefix.empty()) {
997 prefix = prefix + "-";
998 }
999
1000 base_img = base_img.substr(0, last_img_slash + 1);
1001
1002 // Note: we have some special case here for our testing. We have to inject the differentiating
1003 // parts for the different core images.
1004 std::string infix; // Empty infix by default.
1005 {
1006 // Check the first name.
1007 std::string dex_file = oat_filenames_[0];
1008 size_t last_dex_slash = dex_file.rfind('/');
1009 if (last_dex_slash != std::string::npos) {
1010 dex_file = dex_file.substr(last_dex_slash + 1);
1011 }
1012 size_t last_dex_dot = dex_file.rfind('.');
1013 if (last_dex_dot != std::string::npos) {
1014 dex_file = dex_file.substr(0, last_dex_dot);
1015 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001016 if (android::base::StartsWith(dex_file, "core-")) {
Jeff Hao436183f2016-01-12 16:36:50 -08001017 infix = dex_file.substr(strlen("core"));
1018 }
1019 }
1020
bowen_lai8bd36c02016-10-12 13:28:55 +08001021 std::string base_symbol_oat;
1022 if (!oat_unstripped_.empty()) {
1023 base_symbol_oat = oat_unstripped_[0];
1024 size_t last_symbol_oat_slash = base_symbol_oat.rfind('/');
1025 if (last_symbol_oat_slash == std::string::npos) {
1026 Usage("--multi-image used with unusable symbol filename %s", base_symbol_oat.c_str());
1027 }
1028 base_symbol_oat = base_symbol_oat.substr(0, last_symbol_oat_slash + 1);
1029 }
1030
Jeff Hao436183f2016-01-12 16:36:50 -08001031 // Now create the other names. Use a counted loop to skip the first one.
1032 for (size_t i = 1; i < dex_locations_.size(); ++i) {
1033 // TODO: Make everything properly std::string.
1034 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
Andreas Gampe097f34c2017-08-23 08:57:51 -07001035 char_backing_storage_.push_front(base_img + image_name);
1036 image_filenames_.push_back(char_backing_storage_.front().c_str());
Jeff Hao436183f2016-01-12 16:36:50 -08001037
1038 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
Andreas Gampe097f34c2017-08-23 08:57:51 -07001039 char_backing_storage_.push_front(base_oat + oat_name);
1040 oat_filenames_.push_back(char_backing_storage_.front().c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001041
1042 if (!base_symbol_oat.empty()) {
Andreas Gampe097f34c2017-08-23 08:57:51 -07001043 char_backing_storage_.push_front(base_symbol_oat + oat_name);
1044 oat_unstripped_.push_back(char_backing_storage_.front().c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001045 }
Jeff Hao436183f2016-01-12 16:36:50 -08001046 }
1047 }
1048
Andreas Gampe8994a042015-12-30 19:03:17 +00001049 // Modify the input string in the following way:
1050 // 0) Assume input is /a/b/c.d
1051 // 1) Strip the path -> c.d
1052 // 2) Inject prefix p -> pc.d
1053 // 3) Inject infix i -> pci.d
1054 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -08001055 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +00001056 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001057 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +00001058 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001059 size_t last_dex_slash = in.rfind('/');
1060 if (last_dex_slash != std::string::npos) {
1061 in = in.substr(last_dex_slash + 1);
1062 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001063 if (!prefix.empty()) {
1064 in = prefix + in;
1065 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001066 if (!infix.empty()) {
1067 // Inject infix.
1068 size_t last_dot = in.rfind('.');
1069 if (last_dot != std::string::npos) {
1070 in.insert(last_dot, infix);
1071 }
1072 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001073 if (android::base::EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001074 in = in.substr(0, in.length() - strlen(".jar")) +
1075 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001076 }
1077 return in;
1078 }
1079
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001080 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001081 std::ostringstream oss;
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001082 if (!avoid_storing_invocation_) {
1083 for (int i = 0; i < argc; ++i) {
1084 if (i > 0) {
1085 oss << ' ';
1086 }
1087 oss << argv[i];
Roland Levillain9ec5e222015-08-17 20:18:41 +01001088 }
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001089 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1090 oss.str(""); // Reset.
Roland Levillain9ec5e222015-08-17 20:18:41 +01001091 }
Roland Levillain9ec5e222015-08-17 20:18:41 +01001092 oss << kRuntimeISA;
1093 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1094 key_value_store_->Put(
1095 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001096 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001097 key_value_store_->Put(
1098 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001099 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001100 key_value_store_->Put(
1101 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001102 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001103 key_value_store_->Put(OatHeader::kCompilerFilter,
1104 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Andreas Gampef8cd8902017-01-18 16:05:01 -08001105 key_value_store_->Put(OatHeader::kConcurrentCopying,
1106 kUseReadBarrier ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001107 }
1108
Andreas Gampe097f34c2017-08-23 08:57:51 -07001109 // This simple forward is here so the string specializations below don't look out of place.
1110 template <typename T, typename U>
1111 void AssignIfExists(Dex2oatArgumentMap& map,
1112 const Dex2oatArgumentMap::Key<T>& key,
1113 U* out) {
1114 map.AssignIfExists(key, out);
1115 }
1116
1117 // Specializations to handle const char* vs std::string.
1118 void AssignIfExists(Dex2oatArgumentMap& map,
1119 const Dex2oatArgumentMap::Key<std::string>& key,
1120 const char** out) {
1121 if (map.Exists(key)) {
1122 char_backing_storage_.push_front(std::move(*map.Get(key)));
1123 *out = char_backing_storage_.front().c_str();
1124 }
1125 }
1126 void AssignIfExists(Dex2oatArgumentMap& map,
1127 const Dex2oatArgumentMap::Key<std::vector<std::string>>& key,
1128 std::vector<const char*>* out) {
1129 if (map.Exists(key)) {
1130 for (auto& val : *map.Get(key)) {
1131 char_backing_storage_.push_front(std::move(val));
1132 out->push_back(char_backing_storage_.front().c_str());
1133 }
1134 }
1135 }
1136
1137 template <typename T>
1138 void AssignTrueIfExists(Dex2oatArgumentMap& map,
1139 const Dex2oatArgumentMap::Key<T>& key,
1140 bool* out) {
1141 if (map.Exists(key)) {
1142 *out = true;
1143 }
1144 }
1145
Roland Levillain9ec5e222015-08-17 20:18:41 +01001146 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1147 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1148 // returns, arguments have been successfully parsed.
1149 void ParseArgs(int argc, char** argv) {
1150 original_argc = argc;
1151 original_argv = argv;
1152
Andreas Gampe51d80cc2017-06-21 21:05:13 -07001153 InitLogging(argv, Runtime::Abort);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001154
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001155 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001156
Andreas Gampe097f34c2017-08-23 08:57:51 -07001157 using M = Dex2oatArgumentMap;
1158 std::string error_msg;
1159 std::unique_ptr<M> args_uptr = M::Parse(argc, const_cast<const char**>(argv), &error_msg);
1160 if (args_uptr == nullptr) {
1161 Usage("Failed to parse command line: %s", error_msg.c_str());
1162 UNREACHABLE();
1163 }
1164
1165 M& args = *args_uptr;
1166
1167 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
1168
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07001169 AssignIfExists(args, M::CompactDexLevel, &compact_dex_level_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001170 AssignIfExists(args, M::DexFiles, &dex_filenames_);
1171 AssignIfExists(args, M::DexLocations, &dex_locations_);
1172 AssignIfExists(args, M::OatFiles, &oat_filenames_);
1173 AssignIfExists(args, M::OatSymbols, &parser_options->oat_symbols);
1174 AssignIfExists(args, M::ImageFilenames, &image_filenames_);
1175 AssignIfExists(args, M::ZipFd, &zip_fd_);
1176 AssignIfExists(args, M::ZipLocation, &zip_location_);
1177 AssignIfExists(args, M::InputVdexFd, &input_vdex_fd_);
1178 AssignIfExists(args, M::OutputVdexFd, &output_vdex_fd_);
1179 AssignIfExists(args, M::InputVdex, &input_vdex_);
1180 AssignIfExists(args, M::OutputVdex, &output_vdex_);
1181 AssignIfExists(args, M::OatFd, &oat_fd_);
1182 AssignIfExists(args, M::OatLocation, &oat_location_);
1183 AssignIfExists(args, M::Watchdog, &parser_options->watch_dog_enabled);
1184 AssignIfExists(args, M::WatchdogTimeout, &parser_options->watch_dog_timeout_in_ms);
1185 AssignIfExists(args, M::Threads, &thread_count_);
1186 AssignIfExists(args, M::ImageClasses, &image_classes_filename_);
1187 AssignIfExists(args, M::ImageClassesZip, &image_classes_zip_filename_);
1188 AssignIfExists(args, M::CompiledClasses, &compiled_classes_filename_);
1189 AssignIfExists(args, M::CompiledClassesZip, &compiled_classes_zip_filename_);
1190 AssignIfExists(args, M::CompiledMethods, &compiled_methods_filename_);
1191 AssignIfExists(args, M::CompiledMethodsZip, &compiled_methods_zip_filename_);
1192 AssignIfExists(args, M::Passes, &passes_to_run_filename_);
1193 AssignIfExists(args, M::BootImage, &parser_options->boot_image_filename);
1194 AssignIfExists(args, M::AndroidRoot, &android_root_);
1195 AssignIfExists(args, M::Profile, &profile_file_);
1196 AssignIfExists(args, M::ProfileFd, &profile_file_fd_);
1197 AssignIfExists(args, M::RuntimeOptions, &runtime_args_);
1198 AssignIfExists(args, M::SwapFile, &swap_file_name_);
1199 AssignIfExists(args, M::SwapFileFd, &swap_fd_);
1200 AssignIfExists(args, M::SwapDexSizeThreshold, &min_dex_file_cumulative_size_for_swap_);
1201 AssignIfExists(args, M::SwapDexCountThreshold, &min_dex_files_for_swap_);
1202 AssignIfExists(args, M::VeryLargeAppThreshold, &very_large_threshold_);
1203 AssignIfExists(args, M::AppImageFile, &app_image_file_name_);
1204 AssignIfExists(args, M::AppImageFileFd, &app_image_fd_);
1205 AssignIfExists(args, M::NoInlineFrom, &no_inline_from_string_);
1206 AssignIfExists(args, M::ClasspathDir, &classpath_dir_);
1207 AssignIfExists(args, M::DirtyImageObjects, &dirty_image_objects_filename_);
1208 AssignIfExists(args, M::ImageFormat, &image_storage_mode_);
1209
1210 AssignIfExists(args, M::Backend, &compiler_kind_);
1211 parser_options->requested_specific_compiler = args.Exists(M::Backend);
1212
1213 AssignIfExists(args, M::TargetInstructionSet, &instruction_set_);
1214 // arm actually means thumb2.
1215 if (instruction_set_ == InstructionSet::kArm) {
1216 instruction_set_ = InstructionSet::kThumb2;
1217 }
1218
1219 AssignTrueIfExists(args, M::Host, &is_host_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001220 AssignTrueIfExists(args, M::AvoidStoringInvocation, &avoid_storing_invocation_);
1221 AssignTrueIfExists(args, M::MultiImage, &multi_image_);
1222
1223 if (args.Exists(M::ForceDeterminism)) {
1224 if (!SupportsDeterministicCompilation()) {
1225 Usage("Option --force-determinism requires read barriers or a CMS/MS garbage collector");
Roland Levillain9ec5e222015-08-17 20:18:41 +01001226 }
Andreas Gampe097f34c2017-08-23 08:57:51 -07001227 force_determinism_ = true;
1228 }
1229
1230 if (args.Exists(M::Base)) {
1231 ParseBase(*args.Get(M::Base));
1232 }
1233 if (args.Exists(M::TargetInstructionSetVariant)) {
1234 ParseInstructionSetVariant(*args.Get(M::TargetInstructionSetVariant), parser_options.get());
1235 }
1236 if (args.Exists(M::TargetInstructionSetFeatures)) {
1237 ParseInstructionSetFeatures(*args.Get(M::TargetInstructionSetFeatures), parser_options.get());
1238 }
1239 if (args.Exists(M::ClassLoaderContext)) {
1240 class_loader_context_ = ClassLoaderContext::Create(*args.Get(M::ClassLoaderContext));
1241 if (class_loader_context_ == nullptr) {
1242 Usage("Option --class-loader-context has an incorrect format: %s",
1243 args.Get(M::ClassLoaderContext)->c_str());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001244 }
1245 }
1246
Andreas Gampe097f34c2017-08-23 08:57:51 -07001247 if (!ReadCompilerOptions(args, compiler_options_.get(), &error_msg)) {
1248 Usage(error_msg.c_str());
1249 }
1250
Jeff Hao436183f2016-01-12 16:36:50 -08001251 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001252
1253 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001254 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001255 }
1256
Jeff Haodcdc85b2015-12-04 14:06:18 -08001257 // Check whether the oat output files are writable, and open them for later. Also open a swap
1258 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001259 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001260 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1261 PruneNonExistentDexFiles();
1262
Jeff Hao436183f2016-01-12 16:36:50 -08001263 // Expand oat and image filenames for multi image.
1264 if (IsBootImage() && multi_image_) {
1265 ExpandOatAndImageFilenames();
1266 }
1267
David Brazdil7b49e6c2016-09-01 11:06:18 +01001268 // OAT and VDEX file handling
David Brazdil7b49e6c2016-09-01 11:06:18 +01001269 if (oat_fd_ == -1) {
1270 DCHECK(!oat_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08001271 for (const char* oat_filename : oat_filenames_) {
1272 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
Calin Juravleb09be722017-09-25 16:42:48 -07001273 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001274 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1275 return false;
1276 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001277 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001278 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1279 oat_file->Erase();
1280 return false;
1281 }
1282 oat_files_.push_back(std::move(oat_file));
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001283 DCHECK_EQ(input_vdex_fd_, -1);
1284 if (!input_vdex_.empty()) {
1285 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001286 input_vdex_file_ = VdexFile::Open(input_vdex_,
1287 /* writable */ false,
1288 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001289 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001290 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001291 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001292
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001293 DCHECK_EQ(output_vdex_fd_, -1);
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001294 std::string vdex_filename = output_vdex_.empty()
1295 ? ReplaceFileExtension(oat_filename, "vdex")
1296 : output_vdex_;
1297 if (vdex_filename == input_vdex_ && output_vdex_.empty()) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001298 update_input_vdex_ = true;
1299 std::unique_ptr<File> vdex_file(OS::OpenFileReadWrite(vdex_filename.c_str()));
1300 vdex_files_.push_back(std::move(vdex_file));
1301 } else {
1302 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
Calin Juravleb09be722017-09-25 16:42:48 -07001303 if (vdex_file == nullptr) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001304 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1305 return false;
1306 }
1307 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1308 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1309 vdex_file->Erase();
1310 return false;
1311 }
1312 vdex_files_.push_back(std::move(vdex_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001313 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001314 }
1315 } else {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001316 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, /* check_usage */ true));
Calin Juravleb09be722017-09-25 16:42:48 -07001317 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001318 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1319 return false;
1320 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001321 oat_file->DisableAutoClose();
1322 if (oat_file->SetLength(0) != 0) {
1323 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001324 oat_file->Erase();
1325 return false;
David Brazdil7b49e6c2016-09-01 11:06:18 +01001326 }
1327 oat_files_.push_back(std::move(oat_file));
1328
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001329 if (input_vdex_fd_ != -1) {
1330 struct stat s;
1331 int rc = TEMP_FAILURE_RETRY(fstat(input_vdex_fd_, &s));
1332 if (rc == -1) {
1333 PLOG(WARNING) << "Failed getting length of vdex file";
1334 } else {
1335 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001336 input_vdex_file_ = VdexFile::Open(input_vdex_fd_,
1337 s.st_size,
1338 "vdex",
1339 /* writable */ false,
1340 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001341 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001342 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001343 // If there's any problem with the passed vdex, just warn and proceed
1344 // without it.
1345 if (input_vdex_file_ == nullptr) {
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001346 PLOG(WARNING) << "Failed opening vdex file: " << error_msg;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001347 }
1348 }
1349 }
1350
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001351 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001352 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001353 std::unique_ptr<File> vdex_file(new File(output_vdex_fd_, vdex_location, /* check_usage */ true));
Calin Juravleb09be722017-09-25 16:42:48 -07001354 if (vdex_file == nullptr) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001355 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001356 return false;
1357 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001358 vdex_file->DisableAutoClose();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001359 if (input_vdex_file_ != nullptr && output_vdex_fd_ == input_vdex_fd_) {
1360 update_input_vdex_ = true;
1361 } else {
1362 if (vdex_file->SetLength(0) != 0) {
1363 PLOG(ERROR) << "Truncating vdex file " << vdex_location << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001364 vdex_file->Erase();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001365 return false;
1366 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001367 }
1368 vdex_files_.push_back(std::move(vdex_file));
1369
Jeff Haodcdc85b2015-12-04 14:06:18 -08001370 oat_filenames_.push_back(oat_location_.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001371 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001372
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001373 // If we're updating in place a vdex file, be defensive and put an invalid vdex magic in case
1374 // dex2oat gets killed.
1375 // Note: we're only invalidating the magic data in the file, as dex2oat needs the rest of
1376 // the information to remain valid.
1377 if (update_input_vdex_) {
Vladimir Marko74527972016-11-29 15:57:32 +00001378 std::unique_ptr<linker::BufferedOutputStream> vdex_out =
1379 std::make_unique<linker::BufferedOutputStream>(
1380 std::make_unique<linker::FileOutputStream>(vdex_files_.back().get()));
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001381 if (!vdex_out->WriteFully(&VdexFile::Header::kVdexInvalidMagic,
1382 arraysize(VdexFile::Header::kVdexInvalidMagic))) {
1383 PLOG(ERROR) << "Failed to invalidate vdex header. File: " << vdex_out->GetLocation();
1384 return false;
1385 }
1386
1387 if (!vdex_out->Flush()) {
1388 PLOG(ERROR) << "Failed to flush stream after invalidating header of vdex file."
1389 << " File: " << vdex_out->GetLocation();
1390 return false;
1391 }
1392 }
1393
David Brazdil7b49e6c2016-09-01 11:06:18 +01001394 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001395 //
1396 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1397 // that we can use for swap.
1398 //
1399 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1400 // will immediately unlink to satisfy the swap fd assumption.
1401 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1402 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1403 if (swap_file.get() == nullptr) {
1404 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1405 return false;
1406 }
1407 swap_fd_ = swap_file->Fd();
1408 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1409 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1410 // released immediately.
1411 unlink(swap_file_name_.c_str());
1412 }
Jeff Hao436183f2016-01-12 16:36:50 -08001413
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001414 return true;
1415 }
1416
David Brazdil7b49e6c2016-09-01 11:06:18 +01001417 void EraseOutputFiles() {
1418 for (auto& files : { &vdex_files_, &oat_files_ }) {
1419 for (size_t i = 0; i < files->size(); ++i) {
1420 if ((*files)[i].get() != nullptr) {
1421 (*files)[i]->Erase();
1422 (*files)[i].reset();
1423 }
1424 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001425 }
Andreas Gampea650e702014-12-03 14:28:02 -08001426 }
1427
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001428 void LoadClassProfileDescriptors() {
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -07001429 if (profile_compilation_info_ != nullptr && IsImage()) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001430 Runtime* runtime = Runtime::Current();
1431 CHECK(runtime != nullptr);
Mathieu Chartier0b490842016-05-25 15:05:59 -07001432 // Filter out class path classes since we don't want to include these in the image.
Mathieu Chartier4f342b02017-07-21 17:12:39 -07001433 image_classes_.reset(
1434 new std::unordered_set<std::string>(
1435 profile_compilation_info_->GetClassDescriptors(dex_files_)));
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001436 VLOG(compiler) << "Loaded " << image_classes_->size()
1437 << " image class descriptors from profile";
1438 if (VLOG_IS_ON(compiler)) {
1439 for (const std::string& s : *image_classes_) {
1440 LOG(INFO) << "Image class " << s;
1441 }
1442 }
1443 }
1444 }
1445
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001446 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1447 // boot class path.
Andreas Gampef7882972017-03-20 16:35:24 -07001448 dex2oat::ReturnCode Setup() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001449 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001450
Jeff Haoc23b0c02017-07-27 18:19:38 -07001451 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods() ||
1452 !PrepareDirtyObjects()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001453 return dex2oat::ReturnCode::kOther;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001454 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001455
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001456 // Verification results are null since we don't know if we will need them yet as the compler
1457 // filter may change.
Andreas Gampe4585f872015-03-27 23:45:15 -07001458 callbacks_.reset(new QuickCompilerCallbacks(
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001459 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001460 CompilerCallbacks::CallbackMode::kCompileBootImage :
1461 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001462
Vladimir Marko49b0f452015-12-10 13:49:19 +00001463 RuntimeArgumentMap runtime_options;
Mathieu Chartier46331a62017-07-21 09:49:10 -07001464 if (!PrepareRuntimeOptions(&runtime_options, callbacks_.get())) {
Andreas Gampef7882972017-03-20 16:35:24 -07001465 return dex2oat::ReturnCode::kOther;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001466 }
1467
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001468 CreateOatWriters();
1469 if (!AddDexFileSources()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001470 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001471 }
1472
1473 if (IsBootImage() && image_filenames_.size() > 1) {
1474 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1475 // We need this for the multi-image case.
Mathieu Chartier866d8742016-09-21 15:24:18 -07001476 key_value_store_->Put(OatHeader::kBootClassPathKey,
1477 gc::space::ImageSpace::GetMultiImageBootClassPath(dex_locations_,
1478 oat_filenames_,
1479 image_filenames_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001480 }
1481
1482 if (!IsBootImage()) {
1483 // When compiling an app, create the runtime early to retrieve
1484 // the image location key needed for the oat header.
1485 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001486 return dex2oat::ReturnCode::kCreateRuntime;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001487 }
1488
Andreas Gampe29d38e72016-03-23 15:31:51 +00001489 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001490 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1491 std::vector<gc::space::ImageSpace*> image_spaces =
1492 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Richard Uhlerbc26b722017-03-10 14:27:10 +00001493 image_file_location_oat_checksum_ = image_spaces[0]->GetImageHeader().GetOatChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001494 image_file_location_oat_data_begin_ =
1495 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1496 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1497 // Store the boot image filename(s).
1498 std::vector<std::string> image_filenames;
1499 for (const gc::space::ImageSpace* image_space : image_spaces) {
1500 image_filenames.push_back(image_space->GetImageFilename());
1501 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001502 std::string image_file_location = android::base::Join(image_filenames, ':');
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001503 if (!image_file_location.empty()) {
1504 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1505 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001506 } else {
1507 image_file_location_oat_checksum_ = 0u;
1508 image_file_location_oat_data_begin_ = 0u;
1509 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001510 }
1511
1512 // Open dex files for class path.
Calin Juravle19915892017-08-03 17:10:36 +00001513
Calin Juravle1ce70852017-06-28 10:59:03 -07001514 if (class_loader_context_ == nullptr) {
Calin Juravle19915892017-08-03 17:10:36 +00001515 // If no context was specified use the default one (which is an empty PathClassLoader).
1516 class_loader_context_ = std::unique_ptr<ClassLoaderContext>(ClassLoaderContext::Default());
Jeff Haof0192c82016-03-28 20:39:50 -07001517 }
Calin Juravle19915892017-08-03 17:10:36 +00001518
Calin Juravle1ce70852017-06-28 10:59:03 -07001519 DCHECK_EQ(oat_writers_.size(), 1u);
1520
1521 // Note: Ideally we would reject context where the source dex files are also
1522 // specified in the classpath (as it doesn't make sense). However this is currently
1523 // needed for non-prebuild tests and benchmarks which expects on the fly compilation.
1524 // Also, for secondary dex files we do not have control on the actual classpath.
1525 // Instead of aborting, remove all the source location from the context classpaths.
1526 if (class_loader_context_->RemoveLocationsFromClassPaths(
1527 oat_writers_[0]->GetSourceLocations())) {
1528 LOG(WARNING) << "The source files to be compiled are also in the classpath.";
1529 }
1530
1531 // We need to open the dex files before encoding the context in the oat file.
1532 // (because the encoding adds the dex checksum...)
1533 // TODO(calin): consider redesigning this so we don't have to open the dex files before
1534 // creating the actual class loader.
1535 if (!class_loader_context_->OpenDexFiles(runtime_->GetInstructionSet(), classpath_dir_)) {
1536 // Do not abort if we couldn't open files from the classpath. They might be
1537 // apks without dex files and right now are opening flow will fail them.
1538 LOG(WARNING) << "Failed to open classpath dex files";
1539 }
1540
1541 // Store the class loader context in the oat header.
1542 key_value_store_->Put(OatHeader::kClassPathKey,
1543 class_loader_context_->EncodeContextForOatFile(classpath_dir_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001544 }
1545
1546 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001547 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001548 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1549 rodata_.reserve(oat_writers_.size());
1550 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1551 rodata_.push_back(elf_writers_[i]->StartRoData());
1552 // Unzip or copy dex files straight to the oat file.
1553 std::unique_ptr<MemMap> opened_dex_files_map;
1554 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001555 // No need to verify the dex file for:
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001556 // 1) Dexlayout since it does the verification. It also may not pass the verification since
1557 // we don't update the dex checksum.
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001558 // 2) when we have a vdex file, which means it was already verified.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001559 const bool verify = !DoDexLayoutOptimizations() && (input_vdex_file_ == nullptr);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001560 if (!oat_writers_[i]->WriteAndOpenDexFiles(
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +00001561 vdex_files_[i].get(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01001562 rodata_.back(),
1563 instruction_set_,
1564 instruction_set_features_.get(),
1565 key_value_store_.get(),
Jeff Hao042e8982016-10-19 11:17:11 -07001566 verify,
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001567 update_input_vdex_,
David Brazdil7b49e6c2016-09-01 11:06:18 +01001568 &opened_dex_files_map,
1569 &opened_dex_files)) {
Andreas Gampef7882972017-03-20 16:35:24 -07001570 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001571 }
1572 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1573 if (opened_dex_files_map != nullptr) {
1574 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
1575 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001576 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001577 opened_dex_files_.push_back(std::move(dex_file));
1578 }
1579 } else {
1580 DCHECK(opened_dex_files.empty());
1581 }
1582 }
1583 }
1584
1585 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
Andreas Gampe7386da42016-06-08 18:18:47 -07001586
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001587 // If we need to downgrade the compiler-filter for size reasons.
1588 if (!IsBootImage() && IsVeryLarge(dex_files_)) {
Mathieu Chartier8cce65a2017-08-17 00:06:39 -07001589 // Disable app image to make sure dex2oat unloading is enabled.
1590 compiler_options_->DisableAppImage();
1591
Mathieu Chartier72041a02017-07-14 18:23:25 -07001592 // If we need to downgrade the compiler-filter for size reasons, do that early before we read
1593 // it below for creating verification callbacks.
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001594 if (!CompilerFilter::IsAsGoodAs(kLargeAppFilter, compiler_options_->GetCompilerFilter())) {
1595 LOG(INFO) << "Very large app, downgrading to verify.";
1596 // Note: this change won't be reflected in the key-value store, as that had to be
1597 // finalized before loading the dex files. This setup is currently required
1598 // to get the size from the DexFile objects.
1599 // TODO: refactor. b/29790079
1600 compiler_options_->SetCompilerFilter(kLargeAppFilter);
1601 }
1602 }
1603
1604 if (CompilerFilter::IsAnyCompilationEnabled(compiler_options_->GetCompilerFilter())) {
1605 // Only modes with compilation require verification results, do this here instead of when we
1606 // create the compilation callbacks since the compilation mode may have been changed by the
1607 // very large app logic.
1608 // Avoiding setting the verification results saves RAM by not adding the dex files later in
1609 // the function.
1610 verification_results_.reset(new VerificationResults(compiler_options_.get()));
1611 callbacks_->SetVerificationResults(verification_results_.get());
1612 }
1613
Andreas Gampe7386da42016-06-08 18:18:47 -07001614 // We had to postpone the swap decision till now, as this is the point when we actually
1615 // know about the dex files we're going to use.
1616
1617 // Make sure that we didn't create the driver, yet.
1618 CHECK(driver_ == nullptr);
1619 // If we use a swap file, ensure we are above the threshold to make it necessary.
1620 if (swap_fd_ != -1) {
1621 if (!UseSwap(IsBootImage(), dex_files_)) {
1622 close(swap_fd_);
1623 swap_fd_ = -1;
1624 VLOG(compiler) << "Decided to run without swap.";
1625 } else {
1626 LOG(INFO) << "Large app, accepted running with swap.";
1627 }
1628 }
1629 // 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 +00001630 if (IsBootImage()) {
1631 // For boot image, pass opened dex files to the Runtime::Create().
1632 // Note: Runtime acquires ownership of these dex files.
1633 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001634 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001635 return dex2oat::ReturnCode::kOther;
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001636 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001637 }
1638
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001639 // If we're doing the image, override the compiler filter to force full compilation. Must be
1640 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1641 // compilation of class initializers.
1642 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001643 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001644 WellKnownClasses::Init(self->GetJniEnv());
1645
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001646 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001647 constexpr bool kSaveDexInput = false;
1648 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001649 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001650 }
1651 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001652
1653 // Ensure opened dex files are writable for dex-to-dex transformations.
1654 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1655 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1656 PLOG(ERROR) << "Failed to make .dex files writeable.";
Andreas Gampef7882972017-03-20 16:35:24 -07001657 return dex2oat::ReturnCode::kOther;
Vladimir Marko919f5532016-01-20 19:13:01 +00001658 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001659 }
1660
Mathieu Chartier72041a02017-07-14 18:23:25 -07001661 // Verification results are only required for modes that have any compilation. Avoid
1662 // adding the dex files if possible to prevent allocating large arrays.
1663 if (verification_results_ != nullptr) {
1664 for (const auto& dex_file : dex_files_) {
1665 // Pre-register dex files so that we can access verification results without locks during
1666 // compilation and verification.
Mathieu Chartier0733dc82017-07-17 14:05:28 -07001667 verification_results_->AddDexFile(dex_file);
1668 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001669 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001670
Andreas Gampef7882972017-03-20 16:35:24 -07001671 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001672 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001673
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001674 // If we need to keep the oat file open for the image writer.
1675 bool ShouldKeepOatFileOpen() const {
1676 return IsImage() && oat_fd_ != kInvalidFd;
1677 }
1678
Mathieu Chartier72041a02017-07-14 18:23:25 -07001679 // Doesn't return the class loader since it's not meant to be used for image compilation.
1680 void CompileDexFilesIndividually() {
1681 CHECK(!IsImage()) << "Not supported with image";
1682 for (const DexFile* dex_file : dex_files_) {
1683 std::vector<const DexFile*> dex_files(1u, dex_file);
1684 VLOG(compiler) << "Compiling " << dex_file->GetLocation();
1685 jobject class_loader = CompileDexFiles(dex_files);
1686 CHECK(class_loader != nullptr);
1687 ScopedObjectAccess soa(Thread::Current());
1688 // Unload class loader to free RAM.
1689 jweak weak_class_loader = soa.Env()->vm->AddWeakGlobalRef(
1690 soa.Self(),
1691 soa.Decode<mirror::ClassLoader>(class_loader));
1692 soa.Env()->vm->DeleteGlobalRef(soa.Self(), class_loader);
1693 runtime_->GetHeap()->CollectGarbage(/*clear_soft_references*/ true);
1694 ObjPtr<mirror::ClassLoader> decoded_weak = soa.Decode<mirror::ClassLoader>(weak_class_loader);
1695 if (decoded_weak != nullptr) {
1696 LOG(FATAL) << "Failed to unload class loader, path from root set: "
1697 << runtime_->GetHeap()->GetVerification()->FirstPathFromRootSet(decoded_weak);
1698 }
1699 VLOG(compiler) << "Unloaded classloader";
1700 }
1701 }
1702
1703 bool ShouldCompileDexFilesIndividually() const {
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001704 // Compile individually if we are:
1705 // 1. not building an image,
1706 // 2. not verifying a vdex file,
1707 // 3. using multidex,
1708 // 4. not doing any AOT compilation.
1709 // This means extract, no-vdex verify, and quicken, will use the individual compilation
1710 // mode (to reduce RAM used by the compiler).
Mathieu Chartier72041a02017-07-14 18:23:25 -07001711 return !IsImage() &&
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001712 !update_input_vdex_ &&
Mathieu Chartier72041a02017-07-14 18:23:25 -07001713 dex_files_.size() > 1 &&
Mathieu Chartier6a2b67b2017-08-08 15:09:29 -07001714 !CompilerFilter::IsAotCompilationEnabled(compiler_options_->GetCompilerFilter());
Mathieu Chartier72041a02017-07-14 18:23:25 -07001715 }
1716
1717 // Set up and create the compiler driver and then invoke it to compile all the dex files.
1718 jobject Compile() {
1719 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1720
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001721 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001722
Vladimir Marko47496c22016-01-27 16:15:08 +00001723 // Find the dex files we should not inline from.
Vladimir Marko47496c22016-01-27 16:15:08 +00001724 std::vector<std::string> no_inline_filters;
1725 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001726
1727 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001728 const std::string core_oj = "core-oj";
1729 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1730 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001731 }
1732
Vladimir Marko47496c22016-01-27 16:15:08 +00001733 if (!no_inline_filters.empty()) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001734 std::vector<const DexFile*> class_path_files;
1735 if (!IsBootImage()) {
1736 // The class loader context is used only for apps.
1737 class_path_files = class_loader_context_->FlattenOpenedDexFiles();
1738 }
1739
Jeff Haodcdc85b2015-12-04 14:06:18 -08001740 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1741 &class_linker->GetBootClassPath(),
1742 &class_path_files,
1743 &dex_files_
1744 };
1745 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001746 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001747 for (const std::string& filter : no_inline_filters) {
1748 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
Calin Juravlea308a322017-07-18 16:51:51 -07001749 // allows tests to specify <test-dexfile>!classes2.dex if needed but if the
Vladimir Marko47496c22016-01-27 16:15:08 +00001750 // base location passes the StartsWith() test, so do all extra locations.
1751 std::string dex_location = dex_file->GetLocation();
1752 if (filter.find('/') == std::string::npos) {
1753 // The filter does not contain the path. Remove the path from dex_location as well.
1754 size_t last_slash = dex_file->GetLocation().rfind('/');
1755 if (last_slash != std::string::npos) {
1756 dex_location = dex_location.substr(last_slash + 1);
1757 }
1758 }
1759
Andreas Gampe9186ced2016-12-12 14:28:21 -08001760 if (android::base::StartsWith(dex_location, filter.c_str())) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001761 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1762 no_inline_from_dex_files_.push_back(dex_file);
1763 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001764 }
1765 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001766 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001767 }
1768 if (!no_inline_from_dex_files_.empty()) {
1769 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001770 }
1771 }
1772
Vladimir Marko307dac92015-10-20 11:20:09 +01001773 driver_.reset(new CompilerDriver(compiler_options_.get(),
1774 verification_results_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001775 compiler_kind_,
1776 instruction_set_,
1777 instruction_set_features_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001778 image_classes_.release(),
1779 compiled_classes_.release(),
Wojciech Staszkiewicz62534792016-08-09 14:30:55 -07001780 compiled_methods_.release(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001781 thread_count_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001782 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001783 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001784 driver_->SetDexFilesForOatFile(dex_files_);
Nicolas Geoffray486dda02017-09-11 14:15:52 +01001785 if (!IsBootImage()) {
1786 driver_->SetClasspathDexFiles(class_loader_context_->FlattenOpenedDexFiles());
1787 }
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001788
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001789 const bool compile_individually = ShouldCompileDexFilesIndividually();
1790 if (compile_individually) {
1791 // Set the compiler driver in the callbacks so that we can avoid re-verification. This not
1792 // only helps performance but also prevents reverifying quickened bytecodes. Attempting
1793 // verify quickened bytecode causes verification failures.
1794 // Only set the compiler filter if we are doing separate compilation since there is a bit
1795 // of overhead when checking if a class was previously verified.
1796 callbacks_->SetDoesClassUnloading(true, driver_.get());
1797 }
1798
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001799 // Setup vdex for compilation.
1800 if (!DoEagerUnquickeningOfVdex() && input_vdex_file_ != nullptr) {
1801 callbacks_->SetVerifierDeps(
1802 new verifier::VerifierDeps(dex_files_, input_vdex_file_->GetVerifierDepsData()));
1803
1804 // TODO: we unquicken unconditionally, as we don't know
1805 // if the boot image has changed. How exactly we'll know is under
1806 // experimentation.
1807 TimingLogger::ScopedTiming time_unquicken("Unquicken", timings_);
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +03001808
1809 // We do not decompile a RETURN_VOID_NO_BARRIER into a RETURN_VOID, as the quickening
1810 // optimization does not depend on the boot image (the optimization relies on not
1811 // having final fields in a class, which does not change for an app).
1812 VdexFile::Unquicken(dex_files_,
1813 input_vdex_file_->GetQuickeningInfo(),
1814 /* decompile_return_instruction */ false);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001815 } else {
1816 // Create the main VerifierDeps, here instead of in the compiler since we want to aggregate
1817 // the results for all the dex files, not just the results for the current dex file.
1818 callbacks_->SetVerifierDeps(new verifier::VerifierDeps(dex_files_));
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001819 }
Mathieu Chartier72041a02017-07-14 18:23:25 -07001820 // Invoke the compilation.
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001821 if (compile_individually) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001822 CompileDexFilesIndividually();
1823 // Return a null classloader since we already freed released it.
1824 return nullptr;
1825 }
1826 return CompileDexFiles(dex_files_);
1827 }
1828
1829 // Create the class loader, use it to compile, and return.
1830 jobject CompileDexFiles(const std::vector<const DexFile*>& dex_files) {
1831 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1832
1833 jobject class_loader = nullptr;
1834 if (!IsBootImage()) {
1835 class_loader = class_loader_context_->CreateClassLoader(dex_files_);
1836 }
1837
1838 // Register dex caches and key them to the class loader so that they only unload when the
1839 // class loader unloads.
1840 for (const auto& dex_file : dex_files) {
1841 ScopedObjectAccess soa(Thread::Current());
1842 // Registering the dex cache adds a strong root in the class loader that prevents the dex
1843 // cache from being unloaded early.
1844 ObjPtr<mirror::DexCache> dex_cache = class_linker->RegisterDexFile(
1845 *dex_file,
1846 soa.Decode<mirror::ClassLoader>(class_loader));
1847 if (dex_cache == nullptr) {
1848 soa.Self()->AssertPendingException();
1849 LOG(FATAL) << "Failed to register dex file " << dex_file->GetLocation() << " "
1850 << soa.Self()->GetException()->Dump();
1851 }
1852 }
1853 driver_->CompileAll(class_loader, dex_files, timings_);
1854 return class_loader;
Vladimir Markof4da6752014-08-01 19:04:18 +01001855 }
1856
Jeff Hao436183f2016-01-12 16:36:50 -08001857 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001858 // ensure the references between the two are correct.
1859 //
1860 // Currently we have a memory layout that looks something like this:
1861 //
1862 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001863 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001864 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001865 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001866 // +--------------+
1867 // | alloc spaces |
1868 // +--------------+
1869 //
Jeff Hao436183f2016-01-12 16:36:50 -08001870 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001871 //
Jeff Hao436183f2016-01-12 16:36:50 -08001872 // 1. The images are expected to be loaded at an absolute address and
1873 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001874 //
Jeff Hao436183f2016-01-12 16:36:50 -08001875 // 2. There are absolute pointers from Methods in the images to their
1876 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001877 //
Jeff Hao436183f2016-01-12 16:36:50 -08001878 // 3. There are absolute pointers from the code in the oat files to Methods
1879 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001880 //
Jeff Hao436183f2016-01-12 16:36:50 -08001881 // 4. There are absolute pointers from code in the oat files to other code
1882 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001883 //
1884 // To get this all correct, we go through several steps.
1885 //
Jeff Hao436183f2016-01-12 16:36:50 -08001886 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001887 // the oat data size and code size. During this stage, we also set
1888 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001889 //
Jeff Hao436183f2016-01-12 16:36:50 -08001890 // 2. We prepare offsets for the objects in the images and calculate
1891 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001892 //
Jeff Hao436183f2016-01-12 16:36:50 -08001893 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001894 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001895 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001896 // can prepare the ELF headers and we then know the ELF memory segment
1897 // layout and we can now resolve all references. The compiler provides
1898 // LinkerPatch information in each CompiledMethod and we resolve these,
1899 // using the layout information and image object locations provided by
1900 // image writer, as we're writing the method code.
1901 //
Jeff Hao436183f2016-01-12 16:36:50 -08001902 // 4. We create the image files. They need to know where the oat files
1903 // will be loaded after itself. Originally oat files were simply
1904 // memory mapped so we could predict where their contents were based
1905 // on the file size. Now that they are ELF files, we need to inspect
1906 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001907 // where the oat header is located within.
1908 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001909 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001910 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001911 // load the .so at the desired location at runtime by offsetting the
1912 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001913 // TODO: Do this in step 3. We already know the layout there.
1914 //
1915 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1916 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001917
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001918 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1919 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001920 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1921 // case (when the file will be explicitly erased).
David Brazdil7b49e6c2016-09-01 11:06:18 +01001922 bool WriteOutputFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001923 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1924
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001925 // Sync the data to the file, in case we did dex2dex transformations.
1926 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1927 if (!map->Sync()) {
1928 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1929 return false;
1930 }
1931 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001932
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001933 if (IsImage()) {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001934 if (IsAppImage() && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001935 gc::Heap* const heap = Runtime::Current()->GetHeap();
1936 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001937 image_base_ = std::max(image_base_, RoundUp(
1938 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1939 kPageSize));
1940 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001941 // The non moving space is right after the oat file. Put the preferred app image location
1942 // right after the non moving space so that we ideally get a continuous immune region for
1943 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001944 // Use the default non moving space capacity since dex2oat does not have a separate non-
1945 // moving space. This means the runtime's non moving space space size will be as large
1946 // as the growth limit for dex2oat, but smaller in the zygote.
1947 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001948 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001949 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1950 }
1951
Vladimir Marko74527972016-11-29 15:57:32 +00001952 image_writer_.reset(new linker::ImageWriter(*driver_,
1953 image_base_,
1954 compiler_options_->GetCompilePic(),
1955 IsAppImage(),
1956 image_storage_mode_,
1957 oat_filenames_,
1958 dex_file_oat_index_map_,
1959 dirty_image_objects_.get()));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001960
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001961 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001962 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1963 if (!image_writer_->PrepareImageAddressSpace()) {
1964 LOG(ERROR) << "Failed to prepare image address space.";
1965 return false;
1966 }
1967 }
1968
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001969 // Initialize the writers with the compiler driver, image writer, and their
1970 // dex files. The writers were created without those being there yet.
1971 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00001972 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001973 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1974 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
1975 }
1976
David Brazdil5d5a36b2016-09-14 15:34:10 +01001977 {
1978 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
1979 DCHECK(IsBootImage() || oat_files_.size() == 1u);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001980 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
David Brazdil5d5a36b2016-09-14 15:34:10 +01001981 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1982 File* vdex_file = vdex_files_[i].get();
Vladimir Marko74527972016-11-29 15:57:32 +00001983 std::unique_ptr<linker::BufferedOutputStream> vdex_out =
1984 std::make_unique<linker::BufferedOutputStream>(
1985 std::make_unique<linker::FileOutputStream>(vdex_file));
David Brazdil5d5a36b2016-09-14 15:34:10 +01001986
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001987 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01001988 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
1989 return false;
1990 }
1991
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001992 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
1993 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
1994 return false;
1995 }
1996
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +00001997 // VDEX finalized, seek back to the beginning and write checksums and the header.
1998 if (!oat_writers_[i]->WriteChecksumsAndVdexHeader(vdex_out.get())) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01001999 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
2000 return false;
2001 }
2002 }
2003 }
2004
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002005 {
2006 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002007 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002008 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00002009 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2010 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko944da602016-02-19 12:27:55 +00002011
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002012 oat_writer->PrepareLayout(&patcher);
Vladimir Marko944da602016-02-19 12:27:55 +00002013
2014 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
David Brazdil7b49e6c2016-09-01 11:06:18 +01002015 size_t text_size = oat_writer->GetOatSize() - rodata_size;
Vladimir Markoaad75c62016-10-03 08:46:48 +00002016 elf_writer->PrepareDynamicSection(rodata_size,
2017 text_size,
2018 oat_writer->GetBssSize(),
Vladimir Marko0eb882b2017-05-15 13:39:18 +01002019 oat_writer->GetBssMethodsOffset(),
Vladimir Markoaad75c62016-10-03 08:46:48 +00002020 oat_writer->GetBssRootsOffset());
Vladimir Marko944da602016-02-19 12:27:55 +00002021
2022 if (IsImage()) {
2023 // Update oat layout.
2024 DCHECK(image_writer_ != nullptr);
2025 DCHECK_LT(i, oat_filenames_.size());
2026 image_writer_->UpdateOatFileLayout(i,
2027 elf_writer->GetLoadedSize(),
2028 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01002029 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002030 }
Richard Uhlerbc26b722017-03-10 14:27:10 +00002031
2032 if (IsBootImage()) {
2033 // Have the image_file_location_oat_checksum_ for boot oat files
2034 // depend on the contents of all the boot oat files. This way only
2035 // the primary image checksum needs to be checked to determine
2036 // whether any of the images are out of date.
2037 image_file_location_oat_checksum_ ^= oat_writer->GetOatHeader().GetChecksum();
2038 }
Vladimir Marko944da602016-02-19 12:27:55 +00002039 }
2040
2041 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002042 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko74527972016-11-29 15:57:32 +00002043 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2044 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00002045
David Srbecky0c4572e2016-01-22 19:19:25 +00002046 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00002047 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
2048 elf_writer->PrepareDebugInfo(oat_writer->GetMethodDebugInfo());
David Srbecky0c4572e2016-01-22 19:19:25 +00002049
Vladimir Marko74527972016-11-29 15:57:32 +00002050 linker::OutputStream*& rodata = rodata_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002051 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002052 if (!oat_writer->WriteRodata(rodata)) {
2053 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
2054 return false;
2055 }
2056 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002057 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00002058
Vladimir Marko74527972016-11-29 15:57:32 +00002059 linker::OutputStream* text = elf_writer->StartText();
Jeff Haodcdc85b2015-12-04 14:06:18 -08002060 if (!oat_writer->WriteCode(text)) {
2061 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
2062 return false;
2063 }
2064 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00002065
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002066 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
2067 image_file_location_oat_checksum_,
2068 image_file_location_oat_data_begin_,
2069 image_patch_delta_)) {
2070 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
2071 return false;
2072 }
2073
Vladimir Marko944da602016-02-19 12:27:55 +00002074 if (IsImage()) {
2075 // Update oat header information.
2076 DCHECK(image_writer_ != nullptr);
2077 DCHECK_LT(i, oat_filenames_.size());
2078 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
2079 }
2080
Jeff Haodcdc85b2015-12-04 14:06:18 -08002081 elf_writer->WriteDynamicSection();
2082 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
Vladimir Marko10c13562015-11-25 14:33:36 +00002083
Jeff Haodcdc85b2015-12-04 14:06:18 -08002084 if (!elf_writer->End()) {
2085 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
2086 return false;
2087 }
2088
David Brazdil7b49e6c2016-09-01 11:06:18 +01002089 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
2090 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002091 }
2092
Jeff Haodcdc85b2015-12-04 14:06:18 -08002093 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002094
2095 oat_writer.reset();
2096 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002097 }
2098 }
2099
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002100 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002101 }
2102
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002103 // If we are compiling an image, invoke the image creation routine. Else just skip.
2104 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002105 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002106 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
2107 if (!CreateImageFile()) {
2108 return false;
2109 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002110 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07002111 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002112 return true;
2113 }
2114
Jeff Haodcdc85b2015-12-04 14:06:18 -08002115 // Create a copy from stripped to unstripped.
2116 bool CopyStrippedToUnstripped() {
2117 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
2118 // If we don't want to strip in place, copy from stripped location to unstripped location.
2119 // We need to strip after image creation because FixupElf needs to use .strtab.
2120 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
2121 // If the oat file is still open, flush it.
2122 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002123 if (!FlushCloseOutputFile(&oat_files_[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002124 return false;
2125 }
2126 }
2127
2128 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
2129 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
2130 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01002131 int64_t in_length = in->GetLength();
2132 if (in_length < 0) {
2133 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
2134 return false;
2135 }
2136 if (!out->Copy(in.get(), 0, in_length)) {
2137 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
2138 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002139 }
2140 if (out->FlushCloseOrErase() != 0) {
2141 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
2142 return false;
2143 }
2144 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
2145 }
2146 }
2147 return true;
2148 }
2149
David Brazdil7b49e6c2016-09-01 11:06:18 +01002150 bool FlushOutputFile(std::unique_ptr<File>* file) {
2151 if (file->get() != nullptr) {
2152 if (file->get()->Flush() != 0) {
2153 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
2154 return false;
2155 }
2156 }
2157 return true;
2158 }
2159
2160 bool FlushCloseOutputFile(std::unique_ptr<File>* file) {
2161 if (file->get() != nullptr) {
2162 std::unique_ptr<File> tmp(file->release());
2163 if (tmp->FlushCloseOrErase() != 0) {
2164 PLOG(ERROR) << "Failed to flush and close output file: " << tmp->GetPath();
2165 return false;
2166 }
2167 }
2168 return true;
2169 }
2170
2171 bool FlushOutputFiles() {
2172 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
2173 for (auto& files : { &vdex_files_, &oat_files_ }) {
2174 for (size_t i = 0; i < files->size(); ++i) {
2175 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002176 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08002177 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002178 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00002179 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002180 return true;
2181 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002182
David Brazdil7b49e6c2016-09-01 11:06:18 +01002183 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002184 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002185 for (auto& files : { &vdex_files_, &oat_files_ }) {
2186 for (size_t i = 0; i < files->size(); ++i) {
2187 result &= FlushCloseOutputFile(&(*files)[i]);
2188 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002189 }
2190 return result;
2191 }
2192
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002193 void DumpTiming() {
Nicolas Geoffray2d8801f2017-11-28 15:50:07 +00002194 if (compiler_options_->GetDumpTimings() ||
2195 (kIsDebugBuild && timings_->GetTotalNs() > MsToNs(1000))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002196 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2197 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002198 }
2199
Andreas Gampe10e477d2014-11-19 12:57:42 -08002200 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002201 return IsAppImage() || IsBootImage();
2202 }
2203
2204 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002205 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002206 }
2207
2208 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002209 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002210 }
2211
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002212 bool IsHost() const {
2213 return is_host_;
2214 }
2215
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002216 bool UseProfile() const {
Mathieu Chartierd0af56c2017-02-17 12:56:25 -08002217 return profile_file_fd_ != -1 || !profile_file_.empty();
Calin Juravle998c2162015-12-21 15:39:33 +02002218 }
2219
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002220 bool DoProfileGuidedOptimizations() const {
Nicolas Geoffray49cda062017-04-21 13:08:25 +01002221 return UseProfile();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002222 }
2223
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002224 bool DoGenerateCompactDex() const {
2225 return compact_dex_level_ != CompactDexLevel::kCompactDexLevelNone;
2226 }
2227
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002228 bool DoDexLayoutOptimizations() const {
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002229 return DoProfileGuidedOptimizations() || DoGenerateCompactDex();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002230 }
2231
Igor Murashkin545412b2017-08-17 15:26:54 -07002232 bool DoOatLayoutOptimizations() const {
2233 return DoProfileGuidedOptimizations();
2234 }
2235
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01002236 bool DoEagerUnquickeningOfVdex() const {
2237 // DexLayout can invalidate the vdex metadata, so we need to unquicken
2238 // the vdex file eagerly, before passing it to dexlayout.
2239 return DoDexLayoutOptimizations();
2240 }
2241
Calin Juravle2e2db782016-02-23 12:00:03 +00002242 bool LoadProfile() {
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002243 DCHECK(UseProfile());
Calin Juravlee6f87cc2017-05-24 17:41:05 -07002244 // TODO(calin): We should be using the runtime arena pool (instead of the
2245 // default profile arena). However the setup logic is messy and needs
2246 // cleaning up before that (e.g. the oat writers are created before the
2247 // runtime).
Calin Juravle2e2db782016-02-23 12:00:03 +00002248 profile_compilation_info_.reset(new ProfileCompilationInfo());
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002249 ScopedFlock profile_file;
Calin Juravle2e2db782016-02-23 12:00:03 +00002250 std::string error;
2251 if (profile_file_fd_ != -1) {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002252 profile_file = LockedFile::DupOf(profile_file_fd_, "profile",
2253 true /* read_only_mode */, &error);
Andreas Gampe29d38e72016-03-23 15:31:51 +00002254 } else if (profile_file_ != "") {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002255 profile_file = LockedFile::Open(profile_file_.c_str(), O_RDONLY, true, &error);
Calin Juravle998c2162015-12-21 15:39:33 +02002256 }
Calin Juravle877fd962016-01-05 14:29:29 +00002257
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002258 // Return early if we're unable to obtain a lock on the profile.
2259 if (profile_file.get() == nullptr) {
2260 LOG(ERROR) << "Cannot lock profiles: " << error;
2261 return false;
2262 }
2263
2264 if (!profile_compilation_info_->Load(profile_file->Fd())) {
Calin Juravle2e2db782016-02-23 12:00:03 +00002265 profile_compilation_info_.reset(nullptr);
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002266 return false;
Calin Juravle2e2db782016-02-23 12:00:03 +00002267 }
Calin Juravle877fd962016-01-05 14:29:29 +00002268
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002269 return true;
Calin Juravle998c2162015-12-21 15:39:33 +02002270 }
2271
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002272 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002273 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2274 if (is_image) {
2275 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2276 return false;
2277 }
2278 if (dex_files.size() < min_dex_files_for_swap_) {
2279 // If there are less dex files than the threshold, assume it's gonna be fine.
2280 return false;
2281 }
2282 size_t dex_files_size = 0;
2283 for (const auto* dex_file : dex_files) {
2284 dex_files_size += dex_file->GetHeader().file_size_;
2285 }
2286 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2287 }
2288
Andreas Gampe67f02822016-06-24 21:05:23 -07002289 bool IsVeryLarge(std::vector<const DexFile*>& dex_files) {
2290 size_t dex_files_size = 0;
2291 for (const auto* dex_file : dex_files) {
2292 dex_files_size += dex_file->GetHeader().file_size_;
2293 }
2294 return dex_files_size >= very_large_threshold_;
2295 }
2296
Vladimir Marko49b0f452015-12-10 13:49:19 +00002297 bool PrepareImageClasses() {
2298 // If --image-classes was specified, calculate the full list of classes to include in the image.
2299 if (image_classes_filename_ != nullptr) {
2300 image_classes_ =
2301 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2302 if (image_classes_ == nullptr) {
2303 return false;
2304 }
2305 } else if (IsBootImage()) {
2306 image_classes_.reset(new std::unordered_set<std::string>);
2307 }
2308 return true;
2309 }
2310
2311 bool PrepareCompiledClasses() {
2312 // If --compiled-classes was specified, calculate the full list of classes to compile in the
2313 // image.
2314 if (compiled_classes_filename_ != nullptr) {
2315 compiled_classes_ =
2316 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
2317 if (compiled_classes_ == nullptr) {
2318 return false;
2319 }
2320 } else {
2321 compiled_classes_.reset(nullptr); // By default compile everything.
2322 }
2323 return true;
2324 }
2325
2326 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2327 const char* classes_filename,
2328 const char* tag) {
2329 std::unique_ptr<std::unordered_set<std::string>> classes;
2330 std::string error_msg;
2331 if (zip_filename != nullptr) {
2332 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2333 } else {
2334 classes.reset(ReadImageClassesFromFile(classes_filename));
2335 }
2336 if (classes == nullptr) {
2337 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2338 << classes_filename << "': " << error_msg;
2339 }
2340 return classes;
2341 }
2342
2343 bool PrepareCompiledMethods() {
2344 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2345 if (compiled_methods_filename_ != nullptr) {
2346 std::string error_msg;
2347 if (compiled_methods_zip_filename_ != nullptr) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002348 compiled_methods_.reset(ReadCommentedInputFromZip<std::unordered_set<std::string>>(
2349 compiled_methods_zip_filename_,
2350 compiled_methods_filename_,
2351 nullptr, // No post-processing.
2352 &error_msg));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002353 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002354 compiled_methods_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2355 compiled_methods_filename_,
2356 nullptr)); // No post-processing.
Vladimir Marko49b0f452015-12-10 13:49:19 +00002357 }
2358 if (compiled_methods_.get() == nullptr) {
2359 LOG(ERROR) << "Failed to create list of compiled methods from '"
2360 << compiled_methods_filename_ << "': " << error_msg;
2361 return false;
2362 }
2363 } else {
2364 compiled_methods_.reset(nullptr); // By default compile everything.
2365 }
2366 return true;
2367 }
2368
Jeff Haoc23b0c02017-07-27 18:19:38 -07002369 bool PrepareDirtyObjects() {
2370 if (dirty_image_objects_filename_ != nullptr) {
2371 dirty_image_objects_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2372 dirty_image_objects_filename_,
2373 nullptr));
2374 if (dirty_image_objects_ == nullptr) {
2375 LOG(ERROR) << "Failed to create list of dirty objects from '"
2376 << dirty_image_objects_filename_ << "'";
2377 return false;
2378 }
2379 } else {
2380 dirty_image_objects_.reset(nullptr);
2381 }
2382 return true;
2383 }
2384
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002385 void PruneNonExistentDexFiles() {
2386 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2387 size_t kept = 0u;
2388 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2389 if (!OS::FileExists(dex_filenames_[i])) {
2390 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2391 } else {
2392 dex_filenames_[kept] = dex_filenames_[i];
2393 dex_locations_[kept] = dex_locations_[i];
2394 ++kept;
2395 }
2396 }
2397 dex_filenames_.resize(kept);
2398 dex_locations_.resize(kept);
2399 }
2400
2401 bool AddDexFileSources() {
2402 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002403 if (input_vdex_file_ != nullptr) {
2404 DCHECK_EQ(oat_writers_.size(), 1u);
2405 const std::string& name = zip_location_.empty() ? dex_locations_[0] : zip_location_;
2406 DCHECK(!name.empty());
2407 if (!oat_writers_[0]->AddVdexDexFilesSource(*input_vdex_file_.get(), name.c_str())) {
2408 return false;
2409 }
2410 } else if (zip_fd_ != -1) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002411 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002412 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2413 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002414 return false;
2415 }
2416 } else if (oat_writers_.size() > 1u) {
2417 // Multi-image.
2418 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2419 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2420 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2421 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2422 return false;
2423 }
2424 }
2425 } else {
2426 DCHECK_EQ(oat_writers_.size(), 1u);
2427 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2428 DCHECK_NE(dex_filenames_.size(), 0u);
2429 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2430 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2431 return false;
2432 }
2433 }
2434 }
2435 return true;
2436 }
2437
2438 void CreateOatWriters() {
2439 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2440 elf_writers_.reserve(oat_files_.size());
2441 oat_writers_.reserve(oat_files_.size());
2442 for (const std::unique_ptr<File>& oat_file : oat_files_) {
Vladimir Marko74527972016-11-29 15:57:32 +00002443 elf_writers_.emplace_back(linker::CreateElfWriterQuick(instruction_set_,
2444 instruction_set_features_.get(),
2445 compiler_options_.get(),
2446 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002447 elf_writers_.back()->Start();
Igor Murashkin545412b2017-08-17 15:26:54 -07002448 const bool do_oat_writer_layout = DoDexLayoutOptimizations() || DoOatLayoutOptimizations();
Vladimir Marko74527972016-11-29 15:57:32 +00002449 oat_writers_.emplace_back(new linker::OatWriter(
Igor Murashkin545412b2017-08-17 15:26:54 -07002450 IsBootImage(),
2451 timings_,
Mathieu Chartier603ccab2017-10-20 14:34:28 -07002452 do_oat_writer_layout ? profile_compilation_info_.get() : nullptr,
2453 compact_dex_level_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002454 }
2455 }
2456
Vladimir Marko49b0f452015-12-10 13:49:19 +00002457 void SaveDexInput() {
2458 for (size_t i = 0; i < dex_files_.size(); ++i) {
2459 const DexFile* dex_file = dex_files_[i];
2460 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2461 getpid(), i));
2462 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2463 if (tmp_file.get() == nullptr) {
2464 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2465 << ". Try: adb shell chmod 777 /data/local/tmp";
2466 continue;
2467 }
2468 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2469 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2470 UNUSED(tmp_file->Flush());
2471 UNUSED(tmp_file->Close());
2472 LOG(INFO) << "Wrote input to " << tmp_file_name;
2473 }
2474 }
2475
Mathieu Chartier46331a62017-07-21 09:49:10 -07002476 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options,
2477 QuickCompilerCallbacks* callbacks) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00002478 RuntimeOptions raw_options;
2479 if (boot_image_filename_.empty()) {
2480 std::string boot_class_path = "-Xbootclasspath:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002481 boot_class_path += android::base::Join(dex_filenames_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002482 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2483 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002484 boot_class_path_locations += android::base::Join(dex_locations_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002485 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2486 } else {
2487 std::string boot_image_option = "-Ximage:";
2488 boot_image_option += boot_image_filename_;
2489 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2490 }
2491 for (size_t i = 0; i < runtime_args_.size(); i++) {
2492 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2493 }
2494
Mathieu Chartier46331a62017-07-21 09:49:10 -07002495 raw_options.push_back(std::make_pair("compilercallbacks", callbacks));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002496 raw_options.push_back(
2497 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2498
2499 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2500 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2501 // have been stripped in preopting, anyways).
2502 if (!IsBootImage()) {
2503 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2504 }
Andreas Gampec8e35202017-04-28 15:47:12 -07002505 // Never allow implicit image compilation.
2506 raw_options.push_back(std::make_pair("-Xnoimage-dex2oat", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002507 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2508 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2509 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002510 // Disable Hspace compaction to save heap size virtual space.
2511 // Only need disable Hspace for OOM becasue background collector is equal to
2512 // foreground collector by default for dex2oat.
2513 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002514
Andreas Gampeace0dc12016-01-20 13:33:13 -08002515 if (compiler_options_->IsForceDeterminism()) {
Roland Levillainb81e9e92017-04-20 17:35:32 +01002516 // If we're asked to be deterministic, ensure non-concurrent GC for determinism.
2517 //
2518 // Note that with read barriers, this option is ignored, because Runtime::Init
2519 // overrides the foreground GC to be gc::kCollectorTypeCC when instantiating
2520 // gc::Heap. This is fine, as concurrent GC requests are not honored in dex2oat,
2521 // which uses an unstarted runtime.
Andreas Gampeace0dc12016-01-20 13:33:13 -08002522 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
Roland Levillainb81e9e92017-04-20 17:35:32 +01002523
Nicolas Geoffray7acddd82017-05-03 15:04:55 +01002524 // The default LOS implementation (map) is not deterministic. So disable it.
2525 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=disabled", nullptr));
Andreas Gampeace0dc12016-01-20 13:33:13 -08002526
2527 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2528 // compaction (done above) and ensure that neither foreground nor background collectors
2529 // are concurrent.
Roland Levillainb81e9e92017-04-20 17:35:32 +01002530 //
2531 // Likewise, this option is ignored with read barriers because Runtime::Init
2532 // overrides the background GC to be gc::kCollectorTypeCCBackground, but that's
2533 // fine too, for the same reason (see above).
Andreas Gampeace0dc12016-01-20 13:33:13 -08002534 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2535
2536 // To make identity hashcode deterministic, set a known seed.
2537 mirror::Object::SetHashCodeSeed(987654321U);
2538 }
2539
Vladimir Marko49b0f452015-12-10 13:49:19 +00002540 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2541 LOG(ERROR) << "Failed to parse runtime options";
2542 return false;
2543 }
2544 return true;
2545 }
2546
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002547 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002548 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2549 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002550 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002551 LOG(ERROR) << "Failed to create runtime";
2552 return false;
2553 }
Andreas Gampe49c144d2016-11-14 10:11:16 -08002554
2555 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2556 // "ps -a" don't change to non-descript "main."
2557 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2558
Vladimir Marko307dac92015-10-20 11:20:09 +01002559 runtime_.reset(Runtime::Current());
2560 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe8228cdf2017-05-30 15:03:54 -07002561 for (uint32_t i = 0; i < static_cast<uint32_t>(CalleeSaveType::kLastCalleeSaveType); ++i) {
2562 CalleeSaveType type = CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002563 if (!runtime_->HasCalleeSaveMethod(type)) {
2564 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002565 }
2566 }
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002567
2568 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2569 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002570 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002571
Vladimir Marko307dac92015-10-20 11:20:09 +01002572 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002573
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002574 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2575 // Runtime::Start, give it away now so that we don't starve GC.
2576 Thread* self = Thread::Current();
2577 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002578
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002579 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002580 }
2581
Jeff Haodcdc85b2015-12-04 14:06:18 -08002582 // 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 -08002583 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002584 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002585 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002586 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002587 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002588 image_filenames_.push_back(app_image_file_name_.c_str());
2589 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002590 if (!image_writer_->Write(app_image_fd_,
2591 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002592 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002593 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002594 return false;
2595 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002596
Jeff Haodcdc85b2015-12-04 14:06:18 -08002597 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002598 dchecked_vector<uintptr_t> oat_data_begins;
2599 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2600 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002601 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002602 // Destroy ImageWriter before doing FixupElf.
2603 image_writer_.reset();
2604
Vladimir Marko944da602016-02-19 12:27:55 +00002605 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2606 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002607 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2608 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2609 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2610 if (oat_file.get() == nullptr) {
2611 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2612 return false;
2613 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002614
Vladimir Marko74527972016-11-29 15:57:32 +00002615 if (!linker::ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002616 oat_file->Erase();
2617 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2618 return false;
2619 }
2620
2621 if (oat_file->FlushCloseOrErase()) {
2622 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2623 return false;
2624 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002625 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002626 }
2627
2628 return true;
2629 }
2630
2631 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002632 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2633 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002634 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002635 return ReadCommentedInputFromFile<std::unordered_set<std::string>>(image_classes_filename,
2636 &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002637 }
2638
2639 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002640 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002641 const char* zip_filename,
2642 const char* image_classes_filename,
2643 std::string* error_msg) {
2644 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002645 return ReadCommentedInputFromZip<std::unordered_set<std::string>>(zip_filename,
2646 image_classes_filename,
2647 &process,
2648 error_msg);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002649 }
2650
2651 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2652 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002653 template <typename T>
2654 static T* ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002655 const char* input_filename, std::function<std::string(const char*)>* process) {
2656 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2657 if (input_file.get() == nullptr) {
2658 LOG(ERROR) << "Failed to open input file " << input_filename;
2659 return nullptr;
2660 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002661 std::unique_ptr<T> result(
2662 ReadCommentedInputStream<T>(*input_file, process));
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002663 input_file->close();
2664 return result.release();
2665 }
2666
2667 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2668 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002669 template <typename T>
2670 static T* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002671 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002672 const char* input_filename,
2673 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002674 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002675 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2676 if (zip_archive.get() == nullptr) {
2677 return nullptr;
2678 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002679 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002680 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002681 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002682 zip_filename, error_msg->c_str());
2683 return nullptr;
2684 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002685 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2686 input_filename,
2687 error_msg));
2688 if (input_file.get() == nullptr) {
2689 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002690 zip_filename, error_msg->c_str());
2691 return nullptr;
2692 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002693 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2694 input_file->Size());
2695 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002696 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002697 }
2698
2699 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2700 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002701 template <typename T>
2702 static T* ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002703 std::istream& in_stream,
2704 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002705 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002706 while (in_stream.good()) {
2707 std::string dot;
2708 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08002709 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002710 continue;
2711 }
2712 if (process != nullptr) {
2713 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002714 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002715 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002716 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002717 }
2718 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002719 return output.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002720 }
2721
Mathieu Chartier49285c52014-12-02 15:43:48 -08002722 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002723 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2724 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002725 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampec560fc02014-07-16 09:57:39 -07002726 LOG(INFO) << "dex2oat took "
2727 << PrettyDuration(NanoTime() - start_ns_)
Andreas Gampecc967752016-12-12 13:49:00 -08002728 << " (" << PrettyDuration(ProcessCpuNanoTime() - start_cputime_ns_) << " cpu)"
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002729 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002730 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002731 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2732 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002733 }
2734
Jeff Haodcdc85b2015-12-04 14:06:18 -08002735 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2736 std::string res(image_filename);
2737 size_t last_slash = res.rfind('/');
2738 if (last_slash == std::string::npos || last_slash == 0) {
2739 return res;
2740 }
2741 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2742 if (penultimate_slash == std::string::npos) {
2743 return res;
2744 }
2745 // Check that the string in-between is the expected one.
2746 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2747 GetInstructionSetString(isa)) {
2748 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2749 return res;
2750 }
2751 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2752 }
2753
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002754 std::unique_ptr<CompilerOptions> compiler_options_;
2755 Compiler::Kind compiler_kind_;
2756
2757 InstructionSet instruction_set_;
2758 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2759
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002760 uint32_t image_file_location_oat_checksum_;
2761 uintptr_t image_file_location_oat_data_begin_;
2762 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002763 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2764
Vladimir Marko307dac92015-10-20 11:20:09 +01002765 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002766
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002767 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2768
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002769 std::unique_ptr<Runtime> runtime_;
2770
Calin Juravle1ce70852017-06-28 10:59:03 -07002771 // The spec describing how the class loader should be setup for compilation.
2772 std::unique_ptr<ClassLoaderContext> class_loader_context_;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002773
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002774 size_t thread_count_;
2775 uint64_t start_ns_;
Andreas Gampec560fc02014-07-16 09:57:39 -07002776 uint64_t start_cputime_ns_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002777 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002778 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002779 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002780 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002781 std::vector<const char*> oat_filenames_;
2782 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002783 int oat_fd_;
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00002784 int input_vdex_fd_;
2785 int output_vdex_fd_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002786 std::string input_vdex_;
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01002787 std::string output_vdex_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002788 std::unique_ptr<VdexFile> input_vdex_file_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002789 std::vector<const char*> dex_filenames_;
2790 std::vector<const char*> dex_locations_;
2791 int zip_fd_;
2792 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002793 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002794 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002795 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002796 uintptr_t image_base_;
2797 const char* image_classes_zip_filename_;
2798 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002799 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002800 const char* compiled_classes_zip_filename_;
2801 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002802 const char* compiled_methods_zip_filename_;
2803 const char* compiled_methods_filename_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002804 const char* passes_to_run_filename_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002805 const char* dirty_image_objects_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002806 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2807 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002808 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002809 std::unique_ptr<std::unordered_set<std::string>> dirty_image_objects_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002810 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Jeff Hao436183f2016-01-12 16:36:50 -08002811 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002812 bool is_host_;
2813 std::string android_root_;
Mathieu Chartier0b490842016-05-25 15:05:59 -07002814 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002815 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002816 std::string no_inline_from_string_;
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002817 CompactDexLevel compact_dex_level_ = CompactDexLevel::kCompactDexLevelNone;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002818
Vladimir Marko74527972016-11-29 15:57:32 +00002819 std::vector<std::unique_ptr<linker::ElfWriter>> elf_writers_;
2820 std::vector<std::unique_ptr<linker::OatWriter>> oat_writers_;
2821 std::vector<linker::OutputStream*> rodata_;
2822 std::vector<std::unique_ptr<linker::OutputStream>> vdex_out_;
2823 std::unique_ptr<linker::ImageWriter> image_writer_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002824 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002825
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002826 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
2827 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2828
Calin Juravle1ce70852017-06-28 10:59:03 -07002829 // Note that this might contain pointers owned by class_loader_context_.
Vladimir Marko47496c22016-01-27 16:15:08 +00002830 std::vector<const DexFile*> no_inline_from_dex_files_;
2831
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07002832 bool avoid_storing_invocation_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002833 std::string swap_file_name_;
2834 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002835 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2836 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002837 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002838 std::string app_image_file_name_;
2839 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002840 std::string profile_file_;
2841 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002842 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002843 TimingLogger* timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002844 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002845 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002846
2847 // Backing storage.
Andreas Gampe097f34c2017-08-23 08:57:51 -07002848 std::forward_list<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002849
Andreas Gampeace0dc12016-01-20 13:33:13 -08002850 // See CompilerOptions.force_determinism_.
2851 bool force_determinism_;
2852
Jeff Hao16d48432017-04-05 17:05:46 -07002853 // Directory of relative classpaths.
2854 std::string classpath_dir_;
2855
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00002856 // Whether the given input vdex is also the output.
2857 bool update_input_vdex_ = false;
2858
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002859 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2860};
2861
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002862static void b13564922() {
2863#if defined(__linux__) && defined(__arm__)
2864 int major, minor;
2865 struct utsname uts;
2866 if (uname(&uts) != -1 &&
2867 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2868 ((major < 3) || ((major == 3) && (minor < 4)))) {
2869 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2870 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2871 int old_personality = personality(0xffffffff);
2872 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2873 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2874 if (new_personality == -1) {
2875 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2876 }
2877 }
2878 }
2879#endif
2880}
2881
Mathieu Chartier72041a02017-07-14 18:23:25 -07002882class ScopedGlobalRef {
2883 public:
2884 explicit ScopedGlobalRef(jobject obj) : obj_(obj) {}
2885 ~ScopedGlobalRef() {
2886 if (obj_ != nullptr) {
2887 ScopedObjectAccess soa(Thread::Current());
2888 soa.Env()->vm->DeleteGlobalRef(soa.Self(), obj_);
2889 }
2890 }
2891
2892 private:
2893 jobject obj_;
2894};
2895
Andreas Gampe7b565912017-03-20 15:48:52 -07002896static dex2oat::ReturnCode CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002897 dex2oat.LoadClassProfileDescriptors();
Mathieu Chartier9e050df2017-08-09 10:05:47 -07002898 // Keep the class loader that was used for compilation live for the rest of the compilation
2899 // process.
Mathieu Chartier72041a02017-07-14 18:23:25 -07002900 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08002901
David Brazdil7b49e6c2016-09-01 11:06:18 +01002902 if (!dex2oat.WriteOutputFiles()) {
2903 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002904 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002905 }
2906
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002907 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2908 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2909 // image writer will require this fd to generate the image.
2910 if (dex2oat.ShouldKeepOatFileOpen()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002911 if (!dex2oat.FlushOutputFiles()) {
2912 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002913 return dex2oat::ReturnCode::kOther;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002914 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01002915 } else if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002916 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002917 }
2918
Jeff Haodcdc85b2015-12-04 14:06:18 -08002919 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002920 if (!dex2oat.HandleImage()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002921 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002922 }
2923
2924 // When given --host, finish early without stripping.
2925 if (dex2oat.IsHost()) {
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002926 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002927 return dex2oat::ReturnCode::kOther;
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002928 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002929 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002930 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002931 }
2932
Jeff Haodcdc85b2015-12-04 14:06:18 -08002933 // Copy stripped to unstripped location, if necessary.
2934 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002935 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002936 }
2937
Jeff Haodcdc85b2015-12-04 14:06:18 -08002938 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002939 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002940 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002941 }
2942
2943 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002944 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002945}
2946
Andreas Gampe7b565912017-03-20 15:48:52 -07002947static dex2oat::ReturnCode CompileApp(Dex2Oat& dex2oat) {
Mathieu Chartier9e050df2017-08-09 10:05:47 -07002948 // Keep the class loader that was used for compilation live for the rest of the compilation
2949 // process.
Mathieu Chartier72041a02017-07-14 18:23:25 -07002950 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08002951
David Brazdil7b49e6c2016-09-01 11:06:18 +01002952 if (!dex2oat.WriteOutputFiles()) {
2953 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002954 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002955 }
2956
Jeff Haodcdc85b2015-12-04 14:06:18 -08002957 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002958 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002959
2960 // When given --host, finish early without stripping.
2961 if (dex2oat.IsHost()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002962 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002963 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002964 }
2965
2966 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002967 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002968 }
2969
Jeff Haodcdc85b2015-12-04 14:06:18 -08002970 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2971 // stripped versions. If this is given, we expect to be able to open writable files by name.
2972 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002973 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002974 }
2975
Jeff Haodcdc85b2015-12-04 14:06:18 -08002976 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002977 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002978 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002979 }
2980
2981 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002982 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002983}
2984
Andreas Gampe7b565912017-03-20 15:48:52 -07002985static dex2oat::ReturnCode Dex2oat(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002986 b13564922();
2987
2988 TimingLogger timings("compiler", false, false);
2989
Roland Levillain5c7e2602016-02-23 18:08:53 +00002990 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
2991 // might produce a stack frame too large for this function or for
2992 // functions inlining it (such as main), that would not fit the
2993 // requirements of the `-Wframe-larger-than` option.
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07002994 std::unique_ptr<Dex2Oat> dex2oat = std::make_unique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002995
2996 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002997 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002998
Calin Juravleb077e152016-02-18 18:47:37 +00002999 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02003000 // This operation involves I/O.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08003001 if (dex2oat->UseProfile()) {
Calin Juravleb077e152016-02-18 18:47:37 +00003002 if (!dex2oat->LoadProfile()) {
3003 LOG(ERROR) << "Failed to process profile file";
Andreas Gampe7b565912017-03-20 15:48:52 -07003004 return dex2oat::ReturnCode::kOther;
Calin Juravle998c2162015-12-21 15:39:33 +02003005 }
3006 }
3007
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00003008 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap, and vdex.
3009
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003010 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00003011 if (!dex2oat->OpenFile()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003012 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003013 }
3014
Andreas Gampe046c7062015-05-18 23:22:54 -07003015 // Print the complete line when any of the following is true:
3016 // 1) Debug build
3017 // 2) Compiling an image
3018 // 3) Compiling with --host
3019 // 4) Compiling on the host (not a target build)
3020 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003021 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07003022 LOG(INFO) << CommandLine();
3023 } else {
3024 LOG(INFO) << StrippedCommandLine();
3025 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003026
Andreas Gampef7882972017-03-20 16:35:24 -07003027 dex2oat::ReturnCode setup_code = dex2oat->Setup();
3028 if (setup_code != dex2oat::ReturnCode::kNoFailure) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003029 dex2oat->EraseOutputFiles();
Andreas Gampef7882972017-03-20 16:35:24 -07003030 return setup_code;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003031 }
3032
Shubham Ajmera188b2bf2017-09-20 15:53:35 -07003033 // TODO: Due to the cyclic dependencies, profile loading and verifying are
3034 // being done separately. Refactor and place the two next to each other.
3035 // If verification fails, we don't abort the compilation and instead log an
3036 // error.
3037 // TODO(b/62602192, b/65260586): We should consider aborting compilation when
3038 // the profile verification fails.
3039 // Note: If dex2oat fails, installd will remove the oat files causing the app
3040 // to fallback to apk with possible in-memory extraction. We want to avoid
3041 // that, and thus we're lenient towards profile corruptions.
3042 if (dex2oat->UseProfile()) {
3043 dex2oat->VerifyProfileData();
3044 }
3045
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07003046 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
3047 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07003048 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
3049
Andreas Gampe7b565912017-03-20 15:48:52 -07003050 dex2oat::ReturnCode result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00003051 if (dex2oat->IsImage()) {
3052 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08003053 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00003054 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003055 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003056
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003057 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003058}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003059} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07003060
3061int main(int argc, char** argv) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003062 int result = static_cast<int>(art::Dex2oat(argc, argv));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003063 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
3064 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
3065 // should not destruct the runtime in this case.
Evgenii Stepanov1e133742015-05-20 12:30:59 -07003066 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampee286b642017-04-13 12:20:42 -07003067 _exit(result);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003068 }
3069 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07003070}