blob: 1cd9142464f8ceb48950b4f0adcaf537646d87ae [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("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700455 std::cerr << "See log for usage error information\n";
456 exit(EXIT_FAILURE);
457}
458
Brian Carlstrom7940e442013-07-12 13:46:57 -0700459// The primary goal of the watchdog is to prevent stuck build servers
460// during development when fatal aborts lead to a cascade of failures
461// that result in a deadlock.
462class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800463// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700464#undef CHECK_PTHREAD_CALL
465#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
466 do { \
467 int rc = call args; \
468 if (rc != 0) { \
469 errno = rc; \
470 std::string message(# call); \
471 message += " failed for "; \
472 message += reason; \
473 Fatal(message); \
474 } \
475 } while (false)
476
477 public:
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800478 explicit WatchDog(int64_t timeout_in_milliseconds)
479 : timeout_in_milliseconds_(timeout_in_milliseconds),
480 shutting_down_(false) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700481 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700482 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800483#ifndef __APPLE__
484 pthread_condattr_t condattr;
liulvping8f7101e2017-01-16 15:14:43 +0800485 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_init, (&condattr), reason);
486 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_setclock, (&condattr, CLOCK_MONOTONIC), reason);
487 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, &condattr), reason);
488 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_destroy, (&condattr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800489#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700490 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
491 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
492 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
493 }
494 ~WatchDog() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700495 const char* reason = "dex2oat watch dog thread shutdown";
496 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
497 shutting_down_ = true;
498 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
499 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
500
Kenny Root51316382014-05-13 14:59:37 -0700501 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700502
503 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
504 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
505 }
506
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800507 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
508 // large.
509 static constexpr int64_t kWatchdogVerifyMultiplier =
510 kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
511
512 // When setting timeouts, keep in mind that the build server may not be as fast as your
513 // desktop. Debug builds are slower so they have larger timeouts.
514 static constexpr int64_t kWatchdogSlowdownFactor = kIsDebugBuild ? 5U : 1U;
515
516 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
517 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
518 // itself before that watchdog would take down the system server.
519 static constexpr int64_t kWatchDogTimeoutSeconds = kWatchdogSlowdownFactor * (9 * 60 + 30);
520
521 static constexpr int64_t kDefaultWatchdogTimeoutInMS =
522 kWatchdogVerifyMultiplier * kWatchDogTimeoutSeconds * 1000;
523
Brian Carlstrom7940e442013-07-12 13:46:57 -0700524 private:
525 static void* CallBack(void* arg) {
526 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
527 ::art::SetThreadName("dex2oat watch dog");
528 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700529 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700530 }
531
Andreas Gampe794ad762015-02-23 08:12:24 -0800532 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700533 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
534 // it's rather easy to hang in unwinding.
535 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
536 // logcat logging or stderr output.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700537 android::base::LogMessage::LogLine(__FILE__,
538 __LINE__,
539 android::base::LogId::DEFAULT,
540 LogSeverity::FATAL,
541 message.c_str());
Andreas Gampe48fde372017-06-06 07:43:46 -0700542 // If we're on the host, try to dump all threads to get a sense of what's going on. This is
543 // restricted to the host as the dump may itself go bad.
544 // TODO: Use a double watchdog timeout, so we can enable this on-device.
545 if (!kIsTargetBuild && Runtime::Current() != nullptr) {
Andreas Gampecd607312017-06-05 17:03:05 -0700546 Runtime::Current()->AttachCurrentThread("Watchdog thread attached for dumping",
547 true,
548 nullptr,
549 false);
550 Runtime::Current()->DumpForSigQuit(std::cerr);
551 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700552 exit(1);
553 }
554
555 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700556 timespec timeout_ts;
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800557#if defined(__APPLE__)
558 InitTimeSpec(true, CLOCK_REALTIME, timeout_in_milliseconds_, 0, &timeout_ts);
559#else
liulvping8f7101e2017-01-16 15:14:43 +0800560 InitTimeSpec(true, CLOCK_MONOTONIC, timeout_in_milliseconds_, 0, &timeout_ts);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800561#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700562 const char* reason = "dex2oat watch dog thread waiting";
563 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
564 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800565 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700566 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700567 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800568 timeout_in_milliseconds_/1000));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700569 } else if (rc != 0) {
570 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
571 strerror(errno)));
572 Fatal(message.c_str());
573 }
574 }
575 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
576 }
577
Brian Carlstrom7940e442013-07-12 13:46:57 -0700578 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
579 pthread_mutex_t mutex_;
580 pthread_cond_t cond_;
581 pthread_attr_t attr_;
582 pthread_t pthread_;
Andreas Gampef45d61c2017-06-07 10:29:33 -0700583
584 const int64_t timeout_in_milliseconds_;
585 bool shutting_down_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700586};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700587
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800588class Dex2Oat FINAL {
589 public:
590 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100591 compiler_kind_(Compiler::kOptimizing),
Artem Serovba6b6792016-08-15 14:22:07 +0100592 instruction_set_(kRuntimeISA == kArm ? kThumb2 : kRuntimeISA),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800593 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000594 image_file_location_oat_checksum_(0),
595 image_file_location_oat_data_begin_(0),
596 image_patch_delta_(0),
597 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700598 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800599 runtime_(nullptr),
600 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
601 start_ns_(NanoTime()),
Andreas Gampec560fc02014-07-16 09:57:39 -0700602 start_cputime_ns_(ProcessCpuNanoTime()),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800603 oat_fd_(-1),
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000604 input_vdex_fd_(-1),
605 output_vdex_fd_(-1),
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000606 input_vdex_file_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800607 zip_fd_(-1),
608 image_base_(0U),
609 image_classes_zip_filename_(nullptr),
610 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800611 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800612 compiled_classes_zip_filename_(nullptr),
613 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700614 compiled_methods_zip_filename_(nullptr),
615 compiled_methods_filename_(nullptr),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700616 passes_to_run_filename_(nullptr),
Mathieu Chartierff0baff2017-08-02 23:04:19 -0700617 dirty_image_objects_filename_(nullptr),
Jeff Hao436183f2016-01-12 16:36:50 -0800618 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800619 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000620 elf_writers_(),
621 oat_writers_(),
622 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000623 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700624 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000625 opened_dex_files_maps_(),
626 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000627 no_inline_from_dex_files_(),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800628 dump_stats_(false),
629 dump_passes_(false),
630 dump_timing_(false),
631 dump_slow_timing_(kIsDebugBuild),
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -0700632 avoid_storing_invocation_(false),
Calin Juravle2e2db782016-02-23 12:00:03 +0000633 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800634 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000635 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800636 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000637 force_determinism_(false)
638 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800639
640 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800641 // Log completion time before deleting the runtime_, because this accesses
642 // the runtime.
643 LogCompletionTime();
644
Vladimir Marko307dac92015-10-20 11:20:09 +0100645 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
646 // We want to just exit on non-debug builds, not bringing the runtime down
647 // in an orderly fashion. So release the following fields.
648 driver_.release();
649 image_writer_.release();
650 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
651 dex_file.release();
652 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000653 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
654 map.release();
655 }
David Brazdil7b49e6c2016-09-01 11:06:18 +0100656 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
657 vdex_file.release();
658 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800659 for (std::unique_ptr<File>& oat_file : oat_files_) {
660 oat_file.release();
661 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100662 runtime_.release();
663 verification_results_.release();
664 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100665 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700666 }
667
Roland Levillain9ec5e222015-08-17 20:18:41 +0100668 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800669 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800670 std::string boot_image_filename;
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800671 int64_t watch_dog_timeout_in_ms = -1;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800672 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000673 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800674 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100675 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800676
Andreas Gampe097f34c2017-08-23 08:57:51 -0700677 void ParseBase(const std::string& option) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100678 char* end;
Andreas Gampe097f34c2017-08-23 08:57:51 -0700679 image_base_ = strtoul(option.c_str(), &end, 16);
680 if (end == option.c_str() || *end != '\0') {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100681 Usage("Failed to parse hexadecimal value for option %s", option.data());
682 }
683 }
684
Shubham Ajmera188b2bf2017-09-20 15:53:35 -0700685 bool VerifyProfileData() {
686 return profile_compilation_info_->VerifyProfileData(dex_files_);
687 }
688
Andreas Gampe097f34c2017-08-23 08:57:51 -0700689 void ParseInstructionSetVariant(const std::string& option, ParserOptions* parser_options) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800690 instruction_set_features_ = InstructionSetFeatures::FromVariant(
Andreas Gampe097f34c2017-08-23 08:57:51 -0700691 instruction_set_, option, &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100692 if (instruction_set_features_.get() == nullptr) {
693 Usage("%s", parser_options->error_msg.c_str());
694 }
695 }
696
Andreas Gampe097f34c2017-08-23 08:57:51 -0700697 void ParseInstructionSetFeatures(const std::string& option, ParserOptions* parser_options) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800698 if (instruction_set_features_ == nullptr) {
699 instruction_set_features_ = InstructionSetFeatures::FromVariant(
700 instruction_set_, "default", &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100701 if (instruction_set_features_.get() == nullptr) {
702 Usage("Problem initializing default instruction set features variant: %s",
703 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700704 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800705 }
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800706 instruction_set_features_ =
Andreas Gampe097f34c2017-08-23 08:57:51 -0700707 instruction_set_features_->AddFeaturesFromString(option, &parser_options->error_msg);
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800708 if (instruction_set_features_ == nullptr) {
Andreas Gampe097f34c2017-08-23 08:57:51 -0700709 Usage("Error parsing '%s': %s", option.c_str(), parser_options->error_msg.c_str());
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800710 }
711 }
712
Jeff Hao436183f2016-01-12 16:36:50 -0800713 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoaad75c62016-10-03 08:46:48 +0000714 compiler_options_->boot_image_ = !image_filenames_.empty();
715 compiler_options_->app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700716
Roland Levillain2b03a1f2017-06-06 16:09:59 +0100717 if (IsBootImage() && image_filenames_.size() == 1) {
718 const std::string& boot_image_filename = image_filenames_[0];
719 compiler_options_->core_image_ = CompilerDriver::IsCoreImageFilename(boot_image_filename);
720 }
721
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700722 if (IsAppImage() && IsBootImage()) {
723 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
724 }
725
Jeff Haodcdc85b2015-12-04 14:06:18 -0800726 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800727 Usage("Output must be supplied with either --oat-file or --oat-fd");
728 }
729
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000730 if (input_vdex_fd_ != -1 && !input_vdex_.empty()) {
731 Usage("Can't have both --input-vdex-fd and --input-vdex");
732 }
733
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +0100734 if (output_vdex_fd_ != -1 && !output_vdex_.empty()) {
735 Usage("Can't have both --output-vdex-fd and --output-vdex");
736 }
737
Jeff Haodcdc85b2015-12-04 14:06:18 -0800738 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800739 Usage("--oat-file should not be used with --oat-fd");
740 }
741
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000742 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +0100743 Usage("VDEX and OAT output must be specified either with one --oat-filename "
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000744 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100745 }
746
Roland Levillain9ec5e222015-08-17 20:18:41 +0100747 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800748 Usage("--oat-symbols should not be used with --oat-fd");
749 }
750
Roland Levillain9ec5e222015-08-17 20:18:41 +0100751 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800752 Usage("--oat-symbols should not be used with --host");
753 }
754
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000755 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
756 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100757 }
758
Jeff Haodcdc85b2015-12-04 14:06:18 -0800759 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800760 Usage("--oat-fd should not be used with --image");
761 }
762
Jeff Haodcdc85b2015-12-04 14:06:18 -0800763 if (!parser_options->oat_symbols.empty() &&
764 parser_options->oat_symbols.size() != oat_filenames_.size()) {
765 Usage("--oat-file arguments do not match --oat-symbols arguments");
766 }
767
768 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
769 Usage("--oat-file arguments do not match --image arguments");
770 }
771
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800772 if (android_root_.empty()) {
773 const char* android_root_env_var = getenv("ANDROID_ROOT");
774 if (android_root_env_var == nullptr) {
775 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700776 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800777 android_root_ += android_root_env_var;
778 }
779
Vladimir Markoaad75c62016-10-03 08:46:48 +0000780 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100781 parser_options->boot_image_filename += android_root_;
782 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800783 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100784 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000785 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800786 }
787
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700788 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800789 Usage("--image-classes should only be used with --image");
790 }
791
Vladimir Marko49b0f452015-12-10 13:49:19 +0000792 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800793 Usage("--image-classes should not be used with --boot-image");
794 }
795
796 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
797 Usage("--image-classes-zip should be used with --image-classes");
798 }
799
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700800 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800801 Usage("--compiled-classes should only be used with --image");
802 }
803
Vladimir Marko49b0f452015-12-10 13:49:19 +0000804 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800805 Usage("--compiled-classes should not be used with --boot-image");
806 }
807
808 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
809 Usage("--compiled-classes-zip should be used with --compiled-classes");
810 }
811
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800812 if (dex_filenames_.empty() && zip_fd_ == -1) {
813 Usage("Input must be supplied with either --dex-file or --zip-fd");
814 }
815
816 if (!dex_filenames_.empty() && zip_fd_ != -1) {
817 Usage("--dex-file should not be used with --zip-fd");
818 }
819
820 if (!dex_filenames_.empty() && !zip_location_.empty()) {
821 Usage("--dex-file should not be used with --zip-location");
822 }
823
824 if (dex_locations_.empty()) {
825 for (const char* dex_file_name : dex_filenames_) {
826 dex_locations_.push_back(dex_file_name);
827 }
828 } else if (dex_locations_.size() != dex_filenames_.size()) {
829 Usage("--dex-location arguments do not match --dex-file arguments");
830 }
831
Jeff Haodcdc85b2015-12-04 14:06:18 -0800832 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
833 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
834 Usage("--oat-file arguments must be singular or match --dex-file arguments");
835 }
836 }
837
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800838 if (zip_fd_ != -1 && zip_location_.empty()) {
839 Usage("--zip-location should be supplied with --zip-fd");
840 }
841
Vladimir Marko49b0f452015-12-10 13:49:19 +0000842 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800843 if (image_base_ == 0) {
844 Usage("Non-zero --base not specified");
845 }
846 }
847
Mathieu Chartiera8077802016-03-16 19:08:31 -0700848 const bool have_profile_file = !profile_file_.empty();
849 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
850 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000851 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200852 }
853
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -0700854 if (have_profile_file || have_profile_fd) {
855 if (compiled_classes_filename_ != nullptr ||
856 compiled_classes_zip_filename_ != nullptr ||
857 image_classes_filename_ != nullptr ||
858 image_classes_zip_filename_ != nullptr) {
859 Usage("Profile based image creation is not supported with image or compiled classes");
860 }
861 }
862
Roland Levillain9ec5e222015-08-17 20:18:41 +0100863 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800864 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800865 }
866
867 // If no instruction set feature was given, use the default one for the target
868 // instruction set.
869 if (instruction_set_features_.get() == nullptr) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800870 instruction_set_features_ = InstructionSetFeatures::FromVariant(
871 instruction_set_, "default", &parser_options->error_msg);
Ian Rogersd582fa42014-11-05 23:46:43 -0800872 if (instruction_set_features_.get() == nullptr) {
873 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100874 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800875 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800876 }
877
878 if (instruction_set_ == kRuntimeISA) {
879 std::unique_ptr<const InstructionSetFeatures> runtime_features(
880 InstructionSetFeatures::FromCppDefines());
881 if (!instruction_set_features_->Equals(runtime_features.get())) {
882 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
883 << *instruction_set_features_ << ") and those of dex2oat executable ("
884 << *runtime_features <<") for the command line:\n"
885 << CommandLine();
886 }
887 }
888
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000889 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +0000890 compiler_options_->inline_max_code_units_ = CompilerOptions::kDefaultInlineMaxCodeUnits;
Roland Levillaina215b952015-08-07 11:38:32 +0100891 }
892
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800893 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800894 // Set the compilation target's implicit checks options.
895 switch (instruction_set_) {
896 case kArm:
897 case kThumb2:
898 case kArm64:
899 case kX86:
900 case kX86_64:
Douglas Leung22bb5a22015-07-02 16:42:08 -0700901 case kMips:
902 case kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000903 compiler_options_->implicit_null_checks_ = true;
904 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800905 break;
906
907 default:
908 // Defaults are correct.
909 break;
910 }
911
Jeff Hao436183f2016-01-12 16:36:50 -0800912 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800913 Usage("--multi-image can only be used when creating boot images");
914 }
Jeff Hao436183f2016-01-12 16:36:50 -0800915 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800916 Usage("--multi-image cannot be used with multiple image names");
917 }
918
919 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
920 if (!kIsTargetBuild && IsBootImage()) {
921 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800922 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800923 }
924 }
925
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800926 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100927 if (parser_options->watch_dog_enabled) {
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800928 int64_t timeout = parser_options->watch_dog_timeout_in_ms > 0
929 ? parser_options->watch_dog_timeout_in_ms
930 : WatchDog::kDefaultWatchdogTimeoutInMS;
931 watchdog_.reset(new WatchDog(timeout));
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800932 }
933
934 // Fill some values into the key-value store for the oat header.
935 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800936
Roland Levillainb81e9e92017-04-20 17:35:32 +0100937 // Automatically force determinism for the boot image in a host build if read barriers
938 // are enabled, or if the default GC is CMS or MS. When the default GC is CMS
939 // (Concurrent Mark-Sweep), the GC is switched to a non-concurrent one by passing the
940 // option `-Xgc:nonconcurrent` (see below).
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800941 if (!kIsTargetBuild && IsBootImage()) {
942 if (SupportsDeterministicCompilation()) {
943 force_determinism_ = true;
944 } else {
945 LOG(WARNING) << "Deterministic compilation is disabled.";
946 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800947 }
948 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700949
950 if (passes_to_run_filename_ != nullptr) {
951 passes_to_run_.reset(ReadCommentedInputFromFile<std::vector<std::string>>(
952 passes_to_run_filename_,
953 nullptr)); // No post-processing.
954 if (passes_to_run_.get() == nullptr) {
955 Usage("Failed to read list of passes to run.");
956 }
957 }
958 compiler_options_->passes_to_run_ = passes_to_run_.get();
Roland Levillain9ec5e222015-08-17 20:18:41 +0100959 }
960
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800961 static bool SupportsDeterministicCompilation() {
Roland Levillainb81e9e92017-04-20 17:35:32 +0100962 return (kUseReadBarrier ||
963 gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
964 gc::kCollectorTypeDefault == gc::kCollectorTypeMS);
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800965 }
966
Jeff Hao436183f2016-01-12 16:36:50 -0800967 void ExpandOatAndImageFilenames() {
968 std::string base_oat = oat_filenames_[0];
969 size_t last_oat_slash = base_oat.rfind('/');
970 if (last_oat_slash == std::string::npos) {
971 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
972 }
973 // We also need to honor path components that were encoded through '@'. Otherwise the loading
974 // code won't be able to find the images.
975 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
976 last_oat_slash = base_oat.rfind('@');
977 }
978 base_oat = base_oat.substr(0, last_oat_slash + 1);
979
980 std::string base_img = image_filenames_[0];
981 size_t last_img_slash = base_img.rfind('/');
982 if (last_img_slash == std::string::npos) {
983 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
984 }
985 // We also need to honor path components that were encoded through '@'. Otherwise the loading
986 // code won't be able to find the images.
987 if (base_img.find('@', last_img_slash) != std::string::npos) {
988 last_img_slash = base_img.rfind('@');
989 }
990
991 // Get the prefix, which is the primary image name (without path components). Strip the
992 // extension.
993 std::string prefix = base_img.substr(last_img_slash + 1);
994 if (prefix.rfind('.') != std::string::npos) {
995 prefix = prefix.substr(0, prefix.rfind('.'));
996 }
997 if (!prefix.empty()) {
998 prefix = prefix + "-";
999 }
1000
1001 base_img = base_img.substr(0, last_img_slash + 1);
1002
1003 // Note: we have some special case here for our testing. We have to inject the differentiating
1004 // parts for the different core images.
1005 std::string infix; // Empty infix by default.
1006 {
1007 // Check the first name.
1008 std::string dex_file = oat_filenames_[0];
1009 size_t last_dex_slash = dex_file.rfind('/');
1010 if (last_dex_slash != std::string::npos) {
1011 dex_file = dex_file.substr(last_dex_slash + 1);
1012 }
1013 size_t last_dex_dot = dex_file.rfind('.');
1014 if (last_dex_dot != std::string::npos) {
1015 dex_file = dex_file.substr(0, last_dex_dot);
1016 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001017 if (android::base::StartsWith(dex_file, "core-")) {
Jeff Hao436183f2016-01-12 16:36:50 -08001018 infix = dex_file.substr(strlen("core"));
1019 }
1020 }
1021
bowen_lai8bd36c02016-10-12 13:28:55 +08001022 std::string base_symbol_oat;
1023 if (!oat_unstripped_.empty()) {
1024 base_symbol_oat = oat_unstripped_[0];
1025 size_t last_symbol_oat_slash = base_symbol_oat.rfind('/');
1026 if (last_symbol_oat_slash == std::string::npos) {
1027 Usage("--multi-image used with unusable symbol filename %s", base_symbol_oat.c_str());
1028 }
1029 base_symbol_oat = base_symbol_oat.substr(0, last_symbol_oat_slash + 1);
1030 }
1031
Jeff Hao436183f2016-01-12 16:36:50 -08001032 // Now create the other names. Use a counted loop to skip the first one.
1033 for (size_t i = 1; i < dex_locations_.size(); ++i) {
1034 // TODO: Make everything properly std::string.
1035 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
Andreas Gampe097f34c2017-08-23 08:57:51 -07001036 char_backing_storage_.push_front(base_img + image_name);
1037 image_filenames_.push_back(char_backing_storage_.front().c_str());
Jeff Hao436183f2016-01-12 16:36:50 -08001038
1039 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
Andreas Gampe097f34c2017-08-23 08:57:51 -07001040 char_backing_storage_.push_front(base_oat + oat_name);
1041 oat_filenames_.push_back(char_backing_storage_.front().c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001042
1043 if (!base_symbol_oat.empty()) {
Andreas Gampe097f34c2017-08-23 08:57:51 -07001044 char_backing_storage_.push_front(base_symbol_oat + oat_name);
1045 oat_unstripped_.push_back(char_backing_storage_.front().c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001046 }
Jeff Hao436183f2016-01-12 16:36:50 -08001047 }
1048 }
1049
Andreas Gampe8994a042015-12-30 19:03:17 +00001050 // Modify the input string in the following way:
1051 // 0) Assume input is /a/b/c.d
1052 // 1) Strip the path -> c.d
1053 // 2) Inject prefix p -> pc.d
1054 // 3) Inject infix i -> pci.d
1055 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -08001056 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +00001057 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001058 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +00001059 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001060 size_t last_dex_slash = in.rfind('/');
1061 if (last_dex_slash != std::string::npos) {
1062 in = in.substr(last_dex_slash + 1);
1063 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001064 if (!prefix.empty()) {
1065 in = prefix + in;
1066 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001067 if (!infix.empty()) {
1068 // Inject infix.
1069 size_t last_dot = in.rfind('.');
1070 if (last_dot != std::string::npos) {
1071 in.insert(last_dot, infix);
1072 }
1073 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001074 if (android::base::EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001075 in = in.substr(0, in.length() - strlen(".jar")) +
1076 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001077 }
1078 return in;
1079 }
1080
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001081 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001082 std::ostringstream oss;
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001083 if (!avoid_storing_invocation_) {
1084 for (int i = 0; i < argc; ++i) {
1085 if (i > 0) {
1086 oss << ' ';
1087 }
1088 oss << argv[i];
Roland Levillain9ec5e222015-08-17 20:18:41 +01001089 }
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07001090 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1091 oss.str(""); // Reset.
Roland Levillain9ec5e222015-08-17 20:18:41 +01001092 }
Roland Levillain9ec5e222015-08-17 20:18:41 +01001093 oss << kRuntimeISA;
1094 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1095 key_value_store_->Put(
1096 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001097 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001098 key_value_store_->Put(
1099 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001100 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001101 key_value_store_->Put(
1102 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001103 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001104 key_value_store_->Put(OatHeader::kCompilerFilter,
1105 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Andreas Gampef8cd8902017-01-18 16:05:01 -08001106 key_value_store_->Put(OatHeader::kConcurrentCopying,
1107 kUseReadBarrier ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001108 }
1109
Andreas Gampe097f34c2017-08-23 08:57:51 -07001110 // This simple forward is here so the string specializations below don't look out of place.
1111 template <typename T, typename U>
1112 void AssignIfExists(Dex2oatArgumentMap& map,
1113 const Dex2oatArgumentMap::Key<T>& key,
1114 U* out) {
1115 map.AssignIfExists(key, out);
1116 }
1117
1118 // Specializations to handle const char* vs std::string.
1119 void AssignIfExists(Dex2oatArgumentMap& map,
1120 const Dex2oatArgumentMap::Key<std::string>& key,
1121 const char** out) {
1122 if (map.Exists(key)) {
1123 char_backing_storage_.push_front(std::move(*map.Get(key)));
1124 *out = char_backing_storage_.front().c_str();
1125 }
1126 }
1127 void AssignIfExists(Dex2oatArgumentMap& map,
1128 const Dex2oatArgumentMap::Key<std::vector<std::string>>& key,
1129 std::vector<const char*>* out) {
1130 if (map.Exists(key)) {
1131 for (auto& val : *map.Get(key)) {
1132 char_backing_storage_.push_front(std::move(val));
1133 out->push_back(char_backing_storage_.front().c_str());
1134 }
1135 }
1136 }
1137
1138 template <typename T>
1139 void AssignTrueIfExists(Dex2oatArgumentMap& map,
1140 const Dex2oatArgumentMap::Key<T>& key,
1141 bool* out) {
1142 if (map.Exists(key)) {
1143 *out = true;
1144 }
1145 }
1146
Roland Levillain9ec5e222015-08-17 20:18:41 +01001147 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1148 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1149 // returns, arguments have been successfully parsed.
1150 void ParseArgs(int argc, char** argv) {
1151 original_argc = argc;
1152 original_argv = argv;
1153
Andreas Gampe51d80cc2017-06-21 21:05:13 -07001154 InitLogging(argv, Runtime::Abort);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001155
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001156 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001157
Andreas Gampe097f34c2017-08-23 08:57:51 -07001158 using M = Dex2oatArgumentMap;
1159 std::string error_msg;
1160 std::unique_ptr<M> args_uptr = M::Parse(argc, const_cast<const char**>(argv), &error_msg);
1161 if (args_uptr == nullptr) {
1162 Usage("Failed to parse command line: %s", error_msg.c_str());
1163 UNREACHABLE();
1164 }
1165
1166 M& args = *args_uptr;
1167
1168 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
1169
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07001170 AssignIfExists(args, M::CompactDexLevel, &compact_dex_level_);
Andreas Gampe097f34c2017-08-23 08:57:51 -07001171 AssignIfExists(args, M::DexFiles, &dex_filenames_);
1172 AssignIfExists(args, M::DexLocations, &dex_locations_);
1173 AssignIfExists(args, M::OatFiles, &oat_filenames_);
1174 AssignIfExists(args, M::OatSymbols, &parser_options->oat_symbols);
1175 AssignIfExists(args, M::ImageFilenames, &image_filenames_);
1176 AssignIfExists(args, M::ZipFd, &zip_fd_);
1177 AssignIfExists(args, M::ZipLocation, &zip_location_);
1178 AssignIfExists(args, M::InputVdexFd, &input_vdex_fd_);
1179 AssignIfExists(args, M::OutputVdexFd, &output_vdex_fd_);
1180 AssignIfExists(args, M::InputVdex, &input_vdex_);
1181 AssignIfExists(args, M::OutputVdex, &output_vdex_);
1182 AssignIfExists(args, M::OatFd, &oat_fd_);
1183 AssignIfExists(args, M::OatLocation, &oat_location_);
1184 AssignIfExists(args, M::Watchdog, &parser_options->watch_dog_enabled);
1185 AssignIfExists(args, M::WatchdogTimeout, &parser_options->watch_dog_timeout_in_ms);
1186 AssignIfExists(args, M::Threads, &thread_count_);
1187 AssignIfExists(args, M::ImageClasses, &image_classes_filename_);
1188 AssignIfExists(args, M::ImageClassesZip, &image_classes_zip_filename_);
1189 AssignIfExists(args, M::CompiledClasses, &compiled_classes_filename_);
1190 AssignIfExists(args, M::CompiledClassesZip, &compiled_classes_zip_filename_);
1191 AssignIfExists(args, M::CompiledMethods, &compiled_methods_filename_);
1192 AssignIfExists(args, M::CompiledMethodsZip, &compiled_methods_zip_filename_);
1193 AssignIfExists(args, M::Passes, &passes_to_run_filename_);
1194 AssignIfExists(args, M::BootImage, &parser_options->boot_image_filename);
1195 AssignIfExists(args, M::AndroidRoot, &android_root_);
1196 AssignIfExists(args, M::Profile, &profile_file_);
1197 AssignIfExists(args, M::ProfileFd, &profile_file_fd_);
1198 AssignIfExists(args, M::RuntimeOptions, &runtime_args_);
1199 AssignIfExists(args, M::SwapFile, &swap_file_name_);
1200 AssignIfExists(args, M::SwapFileFd, &swap_fd_);
1201 AssignIfExists(args, M::SwapDexSizeThreshold, &min_dex_file_cumulative_size_for_swap_);
1202 AssignIfExists(args, M::SwapDexCountThreshold, &min_dex_files_for_swap_);
1203 AssignIfExists(args, M::VeryLargeAppThreshold, &very_large_threshold_);
1204 AssignIfExists(args, M::AppImageFile, &app_image_file_name_);
1205 AssignIfExists(args, M::AppImageFileFd, &app_image_fd_);
1206 AssignIfExists(args, M::NoInlineFrom, &no_inline_from_string_);
1207 AssignIfExists(args, M::ClasspathDir, &classpath_dir_);
1208 AssignIfExists(args, M::DirtyImageObjects, &dirty_image_objects_filename_);
1209 AssignIfExists(args, M::ImageFormat, &image_storage_mode_);
1210
1211 AssignIfExists(args, M::Backend, &compiler_kind_);
1212 parser_options->requested_specific_compiler = args.Exists(M::Backend);
1213
1214 AssignIfExists(args, M::TargetInstructionSet, &instruction_set_);
1215 // arm actually means thumb2.
1216 if (instruction_set_ == InstructionSet::kArm) {
1217 instruction_set_ = InstructionSet::kThumb2;
1218 }
1219
1220 AssignTrueIfExists(args, M::Host, &is_host_);
1221 AssignTrueIfExists(args, M::DumpTiming, &dump_timing_);
1222 AssignTrueIfExists(args, M::DumpPasses, &dump_passes_);
1223 AssignTrueIfExists(args, M::DumpStats, &dump_stats_);
1224 AssignTrueIfExists(args, M::AvoidStoringInvocation, &avoid_storing_invocation_);
1225 AssignTrueIfExists(args, M::MultiImage, &multi_image_);
1226
1227 if (args.Exists(M::ForceDeterminism)) {
1228 if (!SupportsDeterministicCompilation()) {
1229 Usage("Option --force-determinism requires read barriers or a CMS/MS garbage collector");
Roland Levillain9ec5e222015-08-17 20:18:41 +01001230 }
Andreas Gampe097f34c2017-08-23 08:57:51 -07001231 force_determinism_ = true;
1232 }
1233
1234 if (args.Exists(M::Base)) {
1235 ParseBase(*args.Get(M::Base));
1236 }
1237 if (args.Exists(M::TargetInstructionSetVariant)) {
1238 ParseInstructionSetVariant(*args.Get(M::TargetInstructionSetVariant), parser_options.get());
1239 }
1240 if (args.Exists(M::TargetInstructionSetFeatures)) {
1241 ParseInstructionSetFeatures(*args.Get(M::TargetInstructionSetFeatures), parser_options.get());
1242 }
1243 if (args.Exists(M::ClassLoaderContext)) {
1244 class_loader_context_ = ClassLoaderContext::Create(*args.Get(M::ClassLoaderContext));
1245 if (class_loader_context_ == nullptr) {
1246 Usage("Option --class-loader-context has an incorrect format: %s",
1247 args.Get(M::ClassLoaderContext)->c_str());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001248 }
1249 }
1250
Andreas Gampe097f34c2017-08-23 08:57:51 -07001251 if (!ReadCompilerOptions(args, compiler_options_.get(), &error_msg)) {
1252 Usage(error_msg.c_str());
1253 }
1254
Jeff Hao436183f2016-01-12 16:36:50 -08001255 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001256
1257 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001258 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001259 }
1260
Jeff Haodcdc85b2015-12-04 14:06:18 -08001261 // Check whether the oat output files are writable, and open them for later. Also open a swap
1262 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001263 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001264 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1265 PruneNonExistentDexFiles();
1266
Jeff Hao436183f2016-01-12 16:36:50 -08001267 // Expand oat and image filenames for multi image.
1268 if (IsBootImage() && multi_image_) {
1269 ExpandOatAndImageFilenames();
1270 }
1271
David Brazdil7b49e6c2016-09-01 11:06:18 +01001272 // OAT and VDEX file handling
David Brazdil7b49e6c2016-09-01 11:06:18 +01001273 if (oat_fd_ == -1) {
1274 DCHECK(!oat_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08001275 for (const char* oat_filename : oat_filenames_) {
1276 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
Calin Juravleb09be722017-09-25 16:42:48 -07001277 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001278 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1279 return false;
1280 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001281 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001282 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1283 oat_file->Erase();
1284 return false;
1285 }
1286 oat_files_.push_back(std::move(oat_file));
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001287 DCHECK_EQ(input_vdex_fd_, -1);
1288 if (!input_vdex_.empty()) {
1289 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001290 input_vdex_file_ = VdexFile::Open(input_vdex_,
1291 /* writable */ false,
1292 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001293 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001294 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001295 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001296
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001297 DCHECK_EQ(output_vdex_fd_, -1);
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001298 std::string vdex_filename = output_vdex_.empty()
1299 ? ReplaceFileExtension(oat_filename, "vdex")
1300 : output_vdex_;
1301 if (vdex_filename == input_vdex_ && output_vdex_.empty()) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001302 update_input_vdex_ = true;
1303 std::unique_ptr<File> vdex_file(OS::OpenFileReadWrite(vdex_filename.c_str()));
1304 vdex_files_.push_back(std::move(vdex_file));
1305 } else {
1306 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
Calin Juravleb09be722017-09-25 16:42:48 -07001307 if (vdex_file == nullptr) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001308 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1309 return false;
1310 }
1311 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1312 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1313 vdex_file->Erase();
1314 return false;
1315 }
1316 vdex_files_.push_back(std::move(vdex_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001317 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001318 }
1319 } else {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001320 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, /* check_usage */ true));
Calin Juravleb09be722017-09-25 16:42:48 -07001321 if (oat_file == nullptr) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001322 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1323 return false;
1324 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001325 oat_file->DisableAutoClose();
1326 if (oat_file->SetLength(0) != 0) {
1327 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001328 oat_file->Erase();
1329 return false;
David Brazdil7b49e6c2016-09-01 11:06:18 +01001330 }
1331 oat_files_.push_back(std::move(oat_file));
1332
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001333 if (input_vdex_fd_ != -1) {
1334 struct stat s;
1335 int rc = TEMP_FAILURE_RETRY(fstat(input_vdex_fd_, &s));
1336 if (rc == -1) {
1337 PLOG(WARNING) << "Failed getting length of vdex file";
1338 } else {
1339 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001340 input_vdex_file_ = VdexFile::Open(input_vdex_fd_,
1341 s.st_size,
1342 "vdex",
1343 /* writable */ false,
1344 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001345 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001346 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001347 // If there's any problem with the passed vdex, just warn and proceed
1348 // without it.
1349 if (input_vdex_file_ == nullptr) {
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001350 PLOG(WARNING) << "Failed opening vdex file: " << error_msg;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001351 }
1352 }
1353 }
1354
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001355 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001356 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001357 std::unique_ptr<File> vdex_file(new File(output_vdex_fd_, vdex_location, /* check_usage */ true));
Calin Juravleb09be722017-09-25 16:42:48 -07001358 if (vdex_file == nullptr) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001359 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001360 return false;
1361 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001362 vdex_file->DisableAutoClose();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001363 if (input_vdex_file_ != nullptr && output_vdex_fd_ == input_vdex_fd_) {
1364 update_input_vdex_ = true;
1365 } else {
1366 if (vdex_file->SetLength(0) != 0) {
1367 PLOG(ERROR) << "Truncating vdex file " << vdex_location << " failed.";
Calin Juravleb09be722017-09-25 16:42:48 -07001368 vdex_file->Erase();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001369 return false;
1370 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001371 }
1372 vdex_files_.push_back(std::move(vdex_file));
1373
Jeff Haodcdc85b2015-12-04 14:06:18 -08001374 oat_filenames_.push_back(oat_location_.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001375 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001376
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001377 // If we're updating in place a vdex file, be defensive and put an invalid vdex magic in case
1378 // dex2oat gets killed.
1379 // Note: we're only invalidating the magic data in the file, as dex2oat needs the rest of
1380 // the information to remain valid.
1381 if (update_input_vdex_) {
Vladimir Marko74527972016-11-29 15:57:32 +00001382 std::unique_ptr<linker::BufferedOutputStream> vdex_out =
1383 std::make_unique<linker::BufferedOutputStream>(
1384 std::make_unique<linker::FileOutputStream>(vdex_files_.back().get()));
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001385 if (!vdex_out->WriteFully(&VdexFile::Header::kVdexInvalidMagic,
1386 arraysize(VdexFile::Header::kVdexInvalidMagic))) {
1387 PLOG(ERROR) << "Failed to invalidate vdex header. File: " << vdex_out->GetLocation();
1388 return false;
1389 }
1390
1391 if (!vdex_out->Flush()) {
1392 PLOG(ERROR) << "Failed to flush stream after invalidating header of vdex file."
1393 << " File: " << vdex_out->GetLocation();
1394 return false;
1395 }
1396 }
1397
David Brazdil7b49e6c2016-09-01 11:06:18 +01001398 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001399 //
1400 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1401 // that we can use for swap.
1402 //
1403 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1404 // will immediately unlink to satisfy the swap fd assumption.
1405 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1406 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1407 if (swap_file.get() == nullptr) {
1408 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1409 return false;
1410 }
1411 swap_fd_ = swap_file->Fd();
1412 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1413 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1414 // released immediately.
1415 unlink(swap_file_name_.c_str());
1416 }
Jeff Hao436183f2016-01-12 16:36:50 -08001417
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001418 return true;
1419 }
1420
David Brazdil7b49e6c2016-09-01 11:06:18 +01001421 void EraseOutputFiles() {
1422 for (auto& files : { &vdex_files_, &oat_files_ }) {
1423 for (size_t i = 0; i < files->size(); ++i) {
1424 if ((*files)[i].get() != nullptr) {
1425 (*files)[i]->Erase();
1426 (*files)[i].reset();
1427 }
1428 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001429 }
Andreas Gampea650e702014-12-03 14:28:02 -08001430 }
1431
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001432 void LoadClassProfileDescriptors() {
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -07001433 if (profile_compilation_info_ != nullptr && IsImage()) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001434 Runtime* runtime = Runtime::Current();
1435 CHECK(runtime != nullptr);
Mathieu Chartier0b490842016-05-25 15:05:59 -07001436 // Filter out class path classes since we don't want to include these in the image.
Mathieu Chartier4f342b02017-07-21 17:12:39 -07001437 image_classes_.reset(
1438 new std::unordered_set<std::string>(
1439 profile_compilation_info_->GetClassDescriptors(dex_files_)));
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001440 VLOG(compiler) << "Loaded " << image_classes_->size()
1441 << " image class descriptors from profile";
1442 if (VLOG_IS_ON(compiler)) {
1443 for (const std::string& s : *image_classes_) {
1444 LOG(INFO) << "Image class " << s;
1445 }
1446 }
1447 }
1448 }
1449
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001450 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1451 // boot class path.
Andreas Gampef7882972017-03-20 16:35:24 -07001452 dex2oat::ReturnCode Setup() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001453 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001454
Jeff Haoc23b0c02017-07-27 18:19:38 -07001455 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods() ||
1456 !PrepareDirtyObjects()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001457 return dex2oat::ReturnCode::kOther;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001458 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001459
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001460 // Verification results are null since we don't know if we will need them yet as the compler
1461 // filter may change.
Andreas Gampe4585f872015-03-27 23:45:15 -07001462 callbacks_.reset(new QuickCompilerCallbacks(
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001463 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001464 CompilerCallbacks::CallbackMode::kCompileBootImage :
1465 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001466
Vladimir Marko49b0f452015-12-10 13:49:19 +00001467 RuntimeArgumentMap runtime_options;
Mathieu Chartier46331a62017-07-21 09:49:10 -07001468 if (!PrepareRuntimeOptions(&runtime_options, callbacks_.get())) {
Andreas Gampef7882972017-03-20 16:35:24 -07001469 return dex2oat::ReturnCode::kOther;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001470 }
1471
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001472 CreateOatWriters();
1473 if (!AddDexFileSources()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001474 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001475 }
1476
1477 if (IsBootImage() && image_filenames_.size() > 1) {
1478 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1479 // We need this for the multi-image case.
Mathieu Chartier866d8742016-09-21 15:24:18 -07001480 key_value_store_->Put(OatHeader::kBootClassPathKey,
1481 gc::space::ImageSpace::GetMultiImageBootClassPath(dex_locations_,
1482 oat_filenames_,
1483 image_filenames_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001484 }
1485
1486 if (!IsBootImage()) {
1487 // When compiling an app, create the runtime early to retrieve
1488 // the image location key needed for the oat header.
1489 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001490 return dex2oat::ReturnCode::kCreateRuntime;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001491 }
1492
Andreas Gampe29d38e72016-03-23 15:31:51 +00001493 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001494 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1495 std::vector<gc::space::ImageSpace*> image_spaces =
1496 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Richard Uhlerbc26b722017-03-10 14:27:10 +00001497 image_file_location_oat_checksum_ = image_spaces[0]->GetImageHeader().GetOatChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001498 image_file_location_oat_data_begin_ =
1499 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1500 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1501 // Store the boot image filename(s).
1502 std::vector<std::string> image_filenames;
1503 for (const gc::space::ImageSpace* image_space : image_spaces) {
1504 image_filenames.push_back(image_space->GetImageFilename());
1505 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001506 std::string image_file_location = android::base::Join(image_filenames, ':');
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001507 if (!image_file_location.empty()) {
1508 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1509 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001510 } else {
1511 image_file_location_oat_checksum_ = 0u;
1512 image_file_location_oat_data_begin_ = 0u;
1513 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001514 }
1515
1516 // Open dex files for class path.
Calin Juravle19915892017-08-03 17:10:36 +00001517
Calin Juravle1ce70852017-06-28 10:59:03 -07001518 if (class_loader_context_ == nullptr) {
Calin Juravle19915892017-08-03 17:10:36 +00001519 // If no context was specified use the default one (which is an empty PathClassLoader).
1520 class_loader_context_ = std::unique_ptr<ClassLoaderContext>(ClassLoaderContext::Default());
Jeff Haof0192c82016-03-28 20:39:50 -07001521 }
Calin Juravle19915892017-08-03 17:10:36 +00001522
Calin Juravle1ce70852017-06-28 10:59:03 -07001523 DCHECK_EQ(oat_writers_.size(), 1u);
1524
1525 // Note: Ideally we would reject context where the source dex files are also
1526 // specified in the classpath (as it doesn't make sense). However this is currently
1527 // needed for non-prebuild tests and benchmarks which expects on the fly compilation.
1528 // Also, for secondary dex files we do not have control on the actual classpath.
1529 // Instead of aborting, remove all the source location from the context classpaths.
1530 if (class_loader_context_->RemoveLocationsFromClassPaths(
1531 oat_writers_[0]->GetSourceLocations())) {
1532 LOG(WARNING) << "The source files to be compiled are also in the classpath.";
1533 }
1534
1535 // We need to open the dex files before encoding the context in the oat file.
1536 // (because the encoding adds the dex checksum...)
1537 // TODO(calin): consider redesigning this so we don't have to open the dex files before
1538 // creating the actual class loader.
1539 if (!class_loader_context_->OpenDexFiles(runtime_->GetInstructionSet(), classpath_dir_)) {
1540 // Do not abort if we couldn't open files from the classpath. They might be
1541 // apks without dex files and right now are opening flow will fail them.
1542 LOG(WARNING) << "Failed to open classpath dex files";
1543 }
1544
1545 // Store the class loader context in the oat header.
1546 key_value_store_->Put(OatHeader::kClassPathKey,
1547 class_loader_context_->EncodeContextForOatFile(classpath_dir_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001548 }
1549
1550 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001551 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001552 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1553 rodata_.reserve(oat_writers_.size());
1554 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1555 rodata_.push_back(elf_writers_[i]->StartRoData());
1556 // Unzip or copy dex files straight to the oat file.
1557 std::unique_ptr<MemMap> opened_dex_files_map;
1558 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001559 // No need to verify the dex file for:
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001560 // 1) Dexlayout since it does the verification. It also may not pass the verification since
1561 // we don't update the dex checksum.
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001562 // 2) when we have a vdex file, which means it was already verified.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001563 const bool verify = !DoDexLayoutOptimizations() && (input_vdex_file_ == nullptr);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001564 if (!oat_writers_[i]->WriteAndOpenDexFiles(
1565 kIsVdexEnabled ? vdex_files_[i].get() : oat_files_[i].get(),
1566 rodata_.back(),
1567 instruction_set_,
1568 instruction_set_features_.get(),
1569 key_value_store_.get(),
Jeff Hao042e8982016-10-19 11:17:11 -07001570 verify,
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001571 update_input_vdex_,
David Brazdil7b49e6c2016-09-01 11:06:18 +01001572 &opened_dex_files_map,
1573 &opened_dex_files)) {
Andreas Gampef7882972017-03-20 16:35:24 -07001574 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001575 }
1576 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1577 if (opened_dex_files_map != nullptr) {
1578 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
1579 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001580 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001581 opened_dex_files_.push_back(std::move(dex_file));
1582 }
1583 } else {
1584 DCHECK(opened_dex_files.empty());
1585 }
1586 }
1587 }
1588
1589 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
Andreas Gampe7386da42016-06-08 18:18:47 -07001590
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001591 // If we need to downgrade the compiler-filter for size reasons.
1592 if (!IsBootImage() && IsVeryLarge(dex_files_)) {
Mathieu Chartier8cce65a2017-08-17 00:06:39 -07001593 // Disable app image to make sure dex2oat unloading is enabled.
1594 compiler_options_->DisableAppImage();
1595
Mathieu Chartier72041a02017-07-14 18:23:25 -07001596 // If we need to downgrade the compiler-filter for size reasons, do that early before we read
1597 // it below for creating verification callbacks.
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001598 if (!CompilerFilter::IsAsGoodAs(kLargeAppFilter, compiler_options_->GetCompilerFilter())) {
1599 LOG(INFO) << "Very large app, downgrading to verify.";
1600 // Note: this change won't be reflected in the key-value store, as that had to be
1601 // finalized before loading the dex files. This setup is currently required
1602 // to get the size from the DexFile objects.
1603 // TODO: refactor. b/29790079
1604 compiler_options_->SetCompilerFilter(kLargeAppFilter);
1605 }
1606 }
1607
1608 if (CompilerFilter::IsAnyCompilationEnabled(compiler_options_->GetCompilerFilter())) {
1609 // Only modes with compilation require verification results, do this here instead of when we
1610 // create the compilation callbacks since the compilation mode may have been changed by the
1611 // very large app logic.
1612 // Avoiding setting the verification results saves RAM by not adding the dex files later in
1613 // the function.
1614 verification_results_.reset(new VerificationResults(compiler_options_.get()));
1615 callbacks_->SetVerificationResults(verification_results_.get());
1616 }
1617
Andreas Gampe7386da42016-06-08 18:18:47 -07001618 // We had to postpone the swap decision till now, as this is the point when we actually
1619 // know about the dex files we're going to use.
1620
1621 // Make sure that we didn't create the driver, yet.
1622 CHECK(driver_ == nullptr);
1623 // If we use a swap file, ensure we are above the threshold to make it necessary.
1624 if (swap_fd_ != -1) {
1625 if (!UseSwap(IsBootImage(), dex_files_)) {
1626 close(swap_fd_);
1627 swap_fd_ = -1;
1628 VLOG(compiler) << "Decided to run without swap.";
1629 } else {
1630 LOG(INFO) << "Large app, accepted running with swap.";
1631 }
1632 }
1633 // 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 +00001634 if (IsBootImage()) {
1635 // For boot image, pass opened dex files to the Runtime::Create().
1636 // Note: Runtime acquires ownership of these dex files.
1637 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001638 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001639 return dex2oat::ReturnCode::kOther;
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001640 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001641 }
1642
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001643 // If we're doing the image, override the compiler filter to force full compilation. Must be
1644 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1645 // compilation of class initializers.
1646 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001647 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001648 WellKnownClasses::Init(self->GetJniEnv());
1649
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001650 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001651 constexpr bool kSaveDexInput = false;
1652 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001653 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001654 }
1655 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001656
1657 // Ensure opened dex files are writable for dex-to-dex transformations.
1658 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1659 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1660 PLOG(ERROR) << "Failed to make .dex files writeable.";
Andreas Gampef7882972017-03-20 16:35:24 -07001661 return dex2oat::ReturnCode::kOther;
Vladimir Marko919f5532016-01-20 19:13:01 +00001662 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001663 }
1664
Mathieu Chartier72041a02017-07-14 18:23:25 -07001665 // Verification results are only required for modes that have any compilation. Avoid
1666 // adding the dex files if possible to prevent allocating large arrays.
1667 if (verification_results_ != nullptr) {
1668 for (const auto& dex_file : dex_files_) {
1669 // Pre-register dex files so that we can access verification results without locks during
1670 // compilation and verification.
Mathieu Chartier0733dc82017-07-17 14:05:28 -07001671 verification_results_->AddDexFile(dex_file);
1672 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001673 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001674
Andreas Gampef7882972017-03-20 16:35:24 -07001675 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001676 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001677
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001678 // If we need to keep the oat file open for the image writer.
1679 bool ShouldKeepOatFileOpen() const {
1680 return IsImage() && oat_fd_ != kInvalidFd;
1681 }
1682
Mathieu Chartier72041a02017-07-14 18:23:25 -07001683 // Doesn't return the class loader since it's not meant to be used for image compilation.
1684 void CompileDexFilesIndividually() {
1685 CHECK(!IsImage()) << "Not supported with image";
1686 for (const DexFile* dex_file : dex_files_) {
1687 std::vector<const DexFile*> dex_files(1u, dex_file);
1688 VLOG(compiler) << "Compiling " << dex_file->GetLocation();
1689 jobject class_loader = CompileDexFiles(dex_files);
1690 CHECK(class_loader != nullptr);
1691 ScopedObjectAccess soa(Thread::Current());
1692 // Unload class loader to free RAM.
1693 jweak weak_class_loader = soa.Env()->vm->AddWeakGlobalRef(
1694 soa.Self(),
1695 soa.Decode<mirror::ClassLoader>(class_loader));
1696 soa.Env()->vm->DeleteGlobalRef(soa.Self(), class_loader);
1697 runtime_->GetHeap()->CollectGarbage(/*clear_soft_references*/ true);
1698 ObjPtr<mirror::ClassLoader> decoded_weak = soa.Decode<mirror::ClassLoader>(weak_class_loader);
1699 if (decoded_weak != nullptr) {
1700 LOG(FATAL) << "Failed to unload class loader, path from root set: "
1701 << runtime_->GetHeap()->GetVerification()->FirstPathFromRootSet(decoded_weak);
1702 }
1703 VLOG(compiler) << "Unloaded classloader";
1704 }
1705 }
1706
1707 bool ShouldCompileDexFilesIndividually() const {
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001708 // Compile individually if we are:
1709 // 1. not building an image,
1710 // 2. not verifying a vdex file,
1711 // 3. using multidex,
1712 // 4. not doing any AOT compilation.
1713 // This means extract, no-vdex verify, and quicken, will use the individual compilation
1714 // mode (to reduce RAM used by the compiler).
Mathieu Chartier72041a02017-07-14 18:23:25 -07001715 return !IsImage() &&
Nicolas Geoffraya6fc7872017-08-14 11:29:22 +01001716 !update_input_vdex_ &&
Mathieu Chartier72041a02017-07-14 18:23:25 -07001717 dex_files_.size() > 1 &&
Mathieu Chartier6a2b67b2017-08-08 15:09:29 -07001718 !CompilerFilter::IsAotCompilationEnabled(compiler_options_->GetCompilerFilter());
Mathieu Chartier72041a02017-07-14 18:23:25 -07001719 }
1720
1721 // Set up and create the compiler driver and then invoke it to compile all the dex files.
1722 jobject Compile() {
1723 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1724
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001725 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1726 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001727
Vladimir Marko47496c22016-01-27 16:15:08 +00001728 // Find the dex files we should not inline from.
Vladimir Marko47496c22016-01-27 16:15:08 +00001729 std::vector<std::string> no_inline_filters;
1730 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001731
1732 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001733 const std::string core_oj = "core-oj";
1734 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1735 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001736 }
1737
Vladimir Marko47496c22016-01-27 16:15:08 +00001738 if (!no_inline_filters.empty()) {
Calin Juravle1ce70852017-06-28 10:59:03 -07001739 std::vector<const DexFile*> class_path_files;
1740 if (!IsBootImage()) {
1741 // The class loader context is used only for apps.
1742 class_path_files = class_loader_context_->FlattenOpenedDexFiles();
1743 }
1744
Jeff Haodcdc85b2015-12-04 14:06:18 -08001745 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1746 &class_linker->GetBootClassPath(),
1747 &class_path_files,
1748 &dex_files_
1749 };
1750 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001751 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001752 for (const std::string& filter : no_inline_filters) {
1753 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
Calin Juravlea308a322017-07-18 16:51:51 -07001754 // allows tests to specify <test-dexfile>!classes2.dex if needed but if the
Vladimir Marko47496c22016-01-27 16:15:08 +00001755 // base location passes the StartsWith() test, so do all extra locations.
1756 std::string dex_location = dex_file->GetLocation();
1757 if (filter.find('/') == std::string::npos) {
1758 // The filter does not contain the path. Remove the path from dex_location as well.
1759 size_t last_slash = dex_file->GetLocation().rfind('/');
1760 if (last_slash != std::string::npos) {
1761 dex_location = dex_location.substr(last_slash + 1);
1762 }
1763 }
1764
Andreas Gampe9186ced2016-12-12 14:28:21 -08001765 if (android::base::StartsWith(dex_location, filter.c_str())) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001766 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1767 no_inline_from_dex_files_.push_back(dex_file);
1768 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001769 }
1770 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001771 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001772 }
1773 if (!no_inline_from_dex_files_.empty()) {
1774 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001775 }
1776 }
1777
Vladimir Marko307dac92015-10-20 11:20:09 +01001778 driver_.reset(new CompilerDriver(compiler_options_.get(),
1779 verification_results_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001780 compiler_kind_,
1781 instruction_set_,
1782 instruction_set_features_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001783 image_classes_.release(),
1784 compiled_classes_.release(),
Wojciech Staszkiewicz62534792016-08-09 14:30:55 -07001785 compiled_methods_.release(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001786 thread_count_,
1787 dump_stats_,
1788 dump_passes_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001789 compiler_phases_timings_.get(),
1790 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001791 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001792 driver_->SetDexFilesForOatFile(dex_files_);
Nicolas Geoffray486dda02017-09-11 14:15:52 +01001793 if (!IsBootImage()) {
1794 driver_->SetClasspathDexFiles(class_loader_context_->FlattenOpenedDexFiles());
1795 }
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001796
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001797 const bool compile_individually = ShouldCompileDexFilesIndividually();
1798 if (compile_individually) {
1799 // Set the compiler driver in the callbacks so that we can avoid re-verification. This not
1800 // only helps performance but also prevents reverifying quickened bytecodes. Attempting
1801 // verify quickened bytecode causes verification failures.
1802 // Only set the compiler filter if we are doing separate compilation since there is a bit
1803 // of overhead when checking if a class was previously verified.
1804 callbacks_->SetDoesClassUnloading(true, driver_.get());
1805 }
1806
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001807 // Setup vdex for compilation.
1808 if (!DoEagerUnquickeningOfVdex() && input_vdex_file_ != nullptr) {
1809 callbacks_->SetVerifierDeps(
1810 new verifier::VerifierDeps(dex_files_, input_vdex_file_->GetVerifierDepsData()));
1811
1812 // TODO: we unquicken unconditionally, as we don't know
1813 // if the boot image has changed. How exactly we'll know is under
1814 // experimentation.
1815 TimingLogger::ScopedTiming time_unquicken("Unquicken", timings_);
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +03001816
1817 // We do not decompile a RETURN_VOID_NO_BARRIER into a RETURN_VOID, as the quickening
1818 // optimization does not depend on the boot image (the optimization relies on not
1819 // having final fields in a class, which does not change for an app).
1820 VdexFile::Unquicken(dex_files_,
1821 input_vdex_file_->GetQuickeningInfo(),
1822 /* decompile_return_instruction */ false);
Mathieu Chartier72041a02017-07-14 18:23:25 -07001823 } else {
1824 // Create the main VerifierDeps, here instead of in the compiler since we want to aggregate
1825 // the results for all the dex files, not just the results for the current dex file.
1826 callbacks_->SetVerifierDeps(new verifier::VerifierDeps(dex_files_));
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001827 }
Mathieu Chartier72041a02017-07-14 18:23:25 -07001828 // Invoke the compilation.
Mathieu Chartier9e050df2017-08-09 10:05:47 -07001829 if (compile_individually) {
Mathieu Chartier72041a02017-07-14 18:23:25 -07001830 CompileDexFilesIndividually();
1831 // Return a null classloader since we already freed released it.
1832 return nullptr;
1833 }
1834 return CompileDexFiles(dex_files_);
1835 }
1836
1837 // Create the class loader, use it to compile, and return.
1838 jobject CompileDexFiles(const std::vector<const DexFile*>& dex_files) {
1839 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
1840
1841 jobject class_loader = nullptr;
1842 if (!IsBootImage()) {
1843 class_loader = class_loader_context_->CreateClassLoader(dex_files_);
1844 }
1845
1846 // Register dex caches and key them to the class loader so that they only unload when the
1847 // class loader unloads.
1848 for (const auto& dex_file : dex_files) {
1849 ScopedObjectAccess soa(Thread::Current());
1850 // Registering the dex cache adds a strong root in the class loader that prevents the dex
1851 // cache from being unloaded early.
1852 ObjPtr<mirror::DexCache> dex_cache = class_linker->RegisterDexFile(
1853 *dex_file,
1854 soa.Decode<mirror::ClassLoader>(class_loader));
1855 if (dex_cache == nullptr) {
1856 soa.Self()->AssertPendingException();
1857 LOG(FATAL) << "Failed to register dex file " << dex_file->GetLocation() << " "
1858 << soa.Self()->GetException()->Dump();
1859 }
1860 }
1861 driver_->CompileAll(class_loader, dex_files, timings_);
1862 return class_loader;
Vladimir Markof4da6752014-08-01 19:04:18 +01001863 }
1864
Jeff Hao436183f2016-01-12 16:36:50 -08001865 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001866 // ensure the references between the two are correct.
1867 //
1868 // Currently we have a memory layout that looks something like this:
1869 //
1870 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001871 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001872 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001873 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001874 // +--------------+
1875 // | alloc spaces |
1876 // +--------------+
1877 //
Jeff Hao436183f2016-01-12 16:36:50 -08001878 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001879 //
Jeff Hao436183f2016-01-12 16:36:50 -08001880 // 1. The images are expected to be loaded at an absolute address and
1881 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001882 //
Jeff Hao436183f2016-01-12 16:36:50 -08001883 // 2. There are absolute pointers from Methods in the images to their
1884 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001885 //
Jeff Hao436183f2016-01-12 16:36:50 -08001886 // 3. There are absolute pointers from the code in the oat files to Methods
1887 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001888 //
Jeff Hao436183f2016-01-12 16:36:50 -08001889 // 4. There are absolute pointers from code in the oat files to other code
1890 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001891 //
1892 // To get this all correct, we go through several steps.
1893 //
Jeff Hao436183f2016-01-12 16:36:50 -08001894 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001895 // the oat data size and code size. During this stage, we also set
1896 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001897 //
Jeff Hao436183f2016-01-12 16:36:50 -08001898 // 2. We prepare offsets for the objects in the images and calculate
1899 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001900 //
Jeff Hao436183f2016-01-12 16:36:50 -08001901 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001902 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001903 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001904 // can prepare the ELF headers and we then know the ELF memory segment
1905 // layout and we can now resolve all references. The compiler provides
1906 // LinkerPatch information in each CompiledMethod and we resolve these,
1907 // using the layout information and image object locations provided by
1908 // image writer, as we're writing the method code.
1909 //
Jeff Hao436183f2016-01-12 16:36:50 -08001910 // 4. We create the image files. They need to know where the oat files
1911 // will be loaded after itself. Originally oat files were simply
1912 // memory mapped so we could predict where their contents were based
1913 // on the file size. Now that they are ELF files, we need to inspect
1914 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001915 // where the oat header is located within.
1916 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001917 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001918 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001919 // load the .so at the desired location at runtime by offsetting the
1920 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001921 // TODO: Do this in step 3. We already know the layout there.
1922 //
1923 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1924 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001925
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001926 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1927 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001928 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1929 // case (when the file will be explicitly erased).
David Brazdil7b49e6c2016-09-01 11:06:18 +01001930 bool WriteOutputFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001931 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1932
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001933 // Sync the data to the file, in case we did dex2dex transformations.
1934 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1935 if (!map->Sync()) {
1936 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1937 return false;
1938 }
1939 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001940
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001941 if (IsImage()) {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001942 if (IsAppImage() && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001943 gc::Heap* const heap = Runtime::Current()->GetHeap();
1944 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001945 image_base_ = std::max(image_base_, RoundUp(
1946 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1947 kPageSize));
1948 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001949 // The non moving space is right after the oat file. Put the preferred app image location
1950 // right after the non moving space so that we ideally get a continuous immune region for
1951 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001952 // Use the default non moving space capacity since dex2oat does not have a separate non-
1953 // moving space. This means the runtime's non moving space space size will be as large
1954 // as the growth limit for dex2oat, but smaller in the zygote.
1955 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001956 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001957 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1958 }
1959
Vladimir Marko74527972016-11-29 15:57:32 +00001960 image_writer_.reset(new linker::ImageWriter(*driver_,
1961 image_base_,
1962 compiler_options_->GetCompilePic(),
1963 IsAppImage(),
1964 image_storage_mode_,
1965 oat_filenames_,
1966 dex_file_oat_index_map_,
1967 dirty_image_objects_.get()));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001968
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001969 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001970 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1971 if (!image_writer_->PrepareImageAddressSpace()) {
1972 LOG(ERROR) << "Failed to prepare image address space.";
1973 return false;
1974 }
1975 }
1976
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001977 // Initialize the writers with the compiler driver, image writer, and their
1978 // dex files. The writers were created without those being there yet.
1979 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00001980 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001981 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1982 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
1983 }
1984
David Brazdil5d5a36b2016-09-14 15:34:10 +01001985 {
1986 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
1987 DCHECK(IsBootImage() || oat_files_.size() == 1u);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001988 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
David Brazdil5d5a36b2016-09-14 15:34:10 +01001989 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1990 File* vdex_file = vdex_files_[i].get();
Vladimir Marko74527972016-11-29 15:57:32 +00001991 std::unique_ptr<linker::BufferedOutputStream> vdex_out =
1992 std::make_unique<linker::BufferedOutputStream>(
1993 std::make_unique<linker::FileOutputStream>(vdex_file));
David Brazdil5d5a36b2016-09-14 15:34:10 +01001994
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001995 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01001996 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
1997 return false;
1998 }
1999
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002000 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
2001 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
2002 return false;
2003 }
2004
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +00002005 // VDEX finalized, seek back to the beginning and write checksums and the header.
2006 if (!oat_writers_[i]->WriteChecksumsAndVdexHeader(vdex_out.get())) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01002007 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
2008 return false;
2009 }
2010 }
2011 }
2012
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002013 {
2014 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002015 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002016 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko74527972016-11-29 15:57:32 +00002017 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2018 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko944da602016-02-19 12:27:55 +00002019
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002020 oat_writer->PrepareLayout(&patcher);
Vladimir Marko944da602016-02-19 12:27:55 +00002021
2022 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
David Brazdil7b49e6c2016-09-01 11:06:18 +01002023 size_t text_size = oat_writer->GetOatSize() - rodata_size;
Vladimir Markoaad75c62016-10-03 08:46:48 +00002024 elf_writer->PrepareDynamicSection(rodata_size,
2025 text_size,
2026 oat_writer->GetBssSize(),
Vladimir Marko0eb882b2017-05-15 13:39:18 +01002027 oat_writer->GetBssMethodsOffset(),
Vladimir Markoaad75c62016-10-03 08:46:48 +00002028 oat_writer->GetBssRootsOffset());
Vladimir Marko944da602016-02-19 12:27:55 +00002029
2030 if (IsImage()) {
2031 // Update oat layout.
2032 DCHECK(image_writer_ != nullptr);
2033 DCHECK_LT(i, oat_filenames_.size());
2034 image_writer_->UpdateOatFileLayout(i,
2035 elf_writer->GetLoadedSize(),
2036 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01002037 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002038 }
Richard Uhlerbc26b722017-03-10 14:27:10 +00002039
2040 if (IsBootImage()) {
2041 // Have the image_file_location_oat_checksum_ for boot oat files
2042 // depend on the contents of all the boot oat files. This way only
2043 // the primary image checksum needs to be checked to determine
2044 // whether any of the images are out of date.
2045 image_file_location_oat_checksum_ ^= oat_writer->GetOatHeader().GetChecksum();
2046 }
Vladimir Marko944da602016-02-19 12:27:55 +00002047 }
2048
2049 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002050 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko74527972016-11-29 15:57:32 +00002051 std::unique_ptr<linker::ElfWriter>& elf_writer = elf_writers_[i];
2052 std::unique_ptr<linker::OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00002053
David Srbecky0c4572e2016-01-22 19:19:25 +00002054 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00002055 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
2056 elf_writer->PrepareDebugInfo(oat_writer->GetMethodDebugInfo());
David Srbecky0c4572e2016-01-22 19:19:25 +00002057
Vladimir Marko74527972016-11-29 15:57:32 +00002058 linker::OutputStream*& rodata = rodata_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002059 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002060 if (!oat_writer->WriteRodata(rodata)) {
2061 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
2062 return false;
2063 }
2064 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002065 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00002066
Vladimir Marko74527972016-11-29 15:57:32 +00002067 linker::OutputStream* text = elf_writer->StartText();
Jeff Haodcdc85b2015-12-04 14:06:18 -08002068 if (!oat_writer->WriteCode(text)) {
2069 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
2070 return false;
2071 }
2072 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00002073
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002074 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
2075 image_file_location_oat_checksum_,
2076 image_file_location_oat_data_begin_,
2077 image_patch_delta_)) {
2078 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
2079 return false;
2080 }
2081
Vladimir Marko944da602016-02-19 12:27:55 +00002082 if (IsImage()) {
2083 // Update oat header information.
2084 DCHECK(image_writer_ != nullptr);
2085 DCHECK_LT(i, oat_filenames_.size());
2086 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
2087 }
2088
Jeff Haodcdc85b2015-12-04 14:06:18 -08002089 elf_writer->WriteDynamicSection();
2090 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
Vladimir Marko10c13562015-11-25 14:33:36 +00002091
Jeff Haodcdc85b2015-12-04 14:06:18 -08002092 if (!elf_writer->End()) {
2093 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
2094 return false;
2095 }
2096
David Brazdil7b49e6c2016-09-01 11:06:18 +01002097 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
2098 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002099 }
2100
Jeff Haodcdc85b2015-12-04 14:06:18 -08002101 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002102
2103 oat_writer.reset();
2104 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002105 }
2106 }
2107
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002108 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002109 }
2110
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002111 // If we are compiling an image, invoke the image creation routine. Else just skip.
2112 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002113 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002114 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
2115 if (!CreateImageFile()) {
2116 return false;
2117 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002118 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07002119 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002120 return true;
2121 }
2122
Jeff Haodcdc85b2015-12-04 14:06:18 -08002123 // Create a copy from stripped to unstripped.
2124 bool CopyStrippedToUnstripped() {
2125 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
2126 // If we don't want to strip in place, copy from stripped location to unstripped location.
2127 // We need to strip after image creation because FixupElf needs to use .strtab.
2128 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
2129 // If the oat file is still open, flush it.
2130 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002131 if (!FlushCloseOutputFile(&oat_files_[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002132 return false;
2133 }
2134 }
2135
2136 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
2137 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
2138 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01002139 int64_t in_length = in->GetLength();
2140 if (in_length < 0) {
2141 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
2142 return false;
2143 }
2144 if (!out->Copy(in.get(), 0, in_length)) {
2145 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
2146 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002147 }
2148 if (out->FlushCloseOrErase() != 0) {
2149 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
2150 return false;
2151 }
2152 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
2153 }
2154 }
2155 return true;
2156 }
2157
David Brazdil7b49e6c2016-09-01 11:06:18 +01002158 bool FlushOutputFile(std::unique_ptr<File>* file) {
2159 if (file->get() != nullptr) {
2160 if (file->get()->Flush() != 0) {
2161 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
2162 return false;
2163 }
2164 }
2165 return true;
2166 }
2167
2168 bool FlushCloseOutputFile(std::unique_ptr<File>* file) {
2169 if (file->get() != nullptr) {
2170 std::unique_ptr<File> tmp(file->release());
2171 if (tmp->FlushCloseOrErase() != 0) {
2172 PLOG(ERROR) << "Failed to flush and close output file: " << tmp->GetPath();
2173 return false;
2174 }
2175 }
2176 return true;
2177 }
2178
2179 bool FlushOutputFiles() {
2180 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
2181 for (auto& files : { &vdex_files_, &oat_files_ }) {
2182 for (size_t i = 0; i < files->size(); ++i) {
2183 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002184 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08002185 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002186 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00002187 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002188 return true;
2189 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002190
David Brazdil7b49e6c2016-09-01 11:06:18 +01002191 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002192 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002193 for (auto& files : { &vdex_files_, &oat_files_ }) {
2194 for (size_t i = 0; i < files->size(); ++i) {
2195 result &= FlushCloseOutputFile(&(*files)[i]);
2196 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002197 }
2198 return result;
2199 }
2200
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002201 void DumpTiming() {
2202 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
2203 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2204 }
2205 if (dump_passes_) {
2206 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
2207 }
2208 }
2209
Andreas Gampe10e477d2014-11-19 12:57:42 -08002210 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002211 return IsAppImage() || IsBootImage();
2212 }
2213
2214 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002215 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002216 }
2217
2218 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002219 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002220 }
2221
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002222 bool IsHost() const {
2223 return is_host_;
2224 }
2225
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002226 bool UseProfile() const {
Mathieu Chartierd0af56c2017-02-17 12:56:25 -08002227 return profile_file_fd_ != -1 || !profile_file_.empty();
Calin Juravle998c2162015-12-21 15:39:33 +02002228 }
2229
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002230 bool DoProfileGuidedOptimizations() const {
Nicolas Geoffray49cda062017-04-21 13:08:25 +01002231 return UseProfile();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002232 }
2233
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002234 bool DoGenerateCompactDex() const {
2235 return compact_dex_level_ != CompactDexLevel::kCompactDexLevelNone;
2236 }
2237
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002238 bool DoDexLayoutOptimizations() const {
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002239 return DoProfileGuidedOptimizations() || DoGenerateCompactDex();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002240 }
2241
Igor Murashkin545412b2017-08-17 15:26:54 -07002242 bool DoOatLayoutOptimizations() const {
2243 return DoProfileGuidedOptimizations();
2244 }
2245
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01002246 bool DoEagerUnquickeningOfVdex() const {
2247 // DexLayout can invalidate the vdex metadata, so we need to unquicken
2248 // the vdex file eagerly, before passing it to dexlayout.
2249 return DoDexLayoutOptimizations();
2250 }
2251
Calin Juravle2e2db782016-02-23 12:00:03 +00002252 bool LoadProfile() {
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002253 DCHECK(UseProfile());
Calin Juravlee6f87cc2017-05-24 17:41:05 -07002254 // TODO(calin): We should be using the runtime arena pool (instead of the
2255 // default profile arena). However the setup logic is messy and needs
2256 // cleaning up before that (e.g. the oat writers are created before the
2257 // runtime).
Calin Juravle2e2db782016-02-23 12:00:03 +00002258 profile_compilation_info_.reset(new ProfileCompilationInfo());
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002259 ScopedFlock profile_file;
Calin Juravle2e2db782016-02-23 12:00:03 +00002260 std::string error;
2261 if (profile_file_fd_ != -1) {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002262 profile_file = LockedFile::DupOf(profile_file_fd_, "profile",
2263 true /* read_only_mode */, &error);
Andreas Gampe29d38e72016-03-23 15:31:51 +00002264 } else if (profile_file_ != "") {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002265 profile_file = LockedFile::Open(profile_file_.c_str(), O_RDONLY, true, &error);
Calin Juravle998c2162015-12-21 15:39:33 +02002266 }
Calin Juravle877fd962016-01-05 14:29:29 +00002267
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002268 // Return early if we're unable to obtain a lock on the profile.
2269 if (profile_file.get() == nullptr) {
2270 LOG(ERROR) << "Cannot lock profiles: " << error;
2271 return false;
2272 }
2273
2274 if (!profile_compilation_info_->Load(profile_file->Fd())) {
Calin Juravle2e2db782016-02-23 12:00:03 +00002275 profile_compilation_info_.reset(nullptr);
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002276 return false;
Calin Juravle2e2db782016-02-23 12:00:03 +00002277 }
Calin Juravle877fd962016-01-05 14:29:29 +00002278
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002279 return true;
Calin Juravle998c2162015-12-21 15:39:33 +02002280 }
2281
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002282 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002283 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2284 if (is_image) {
2285 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2286 return false;
2287 }
2288 if (dex_files.size() < min_dex_files_for_swap_) {
2289 // If there are less dex files than the threshold, assume it's gonna be fine.
2290 return false;
2291 }
2292 size_t dex_files_size = 0;
2293 for (const auto* dex_file : dex_files) {
2294 dex_files_size += dex_file->GetHeader().file_size_;
2295 }
2296 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2297 }
2298
Andreas Gampe67f02822016-06-24 21:05:23 -07002299 bool IsVeryLarge(std::vector<const DexFile*>& dex_files) {
2300 size_t dex_files_size = 0;
2301 for (const auto* dex_file : dex_files) {
2302 dex_files_size += dex_file->GetHeader().file_size_;
2303 }
2304 return dex_files_size >= very_large_threshold_;
2305 }
2306
Vladimir Marko49b0f452015-12-10 13:49:19 +00002307 bool PrepareImageClasses() {
2308 // If --image-classes was specified, calculate the full list of classes to include in the image.
2309 if (image_classes_filename_ != nullptr) {
2310 image_classes_ =
2311 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2312 if (image_classes_ == nullptr) {
2313 return false;
2314 }
2315 } else if (IsBootImage()) {
2316 image_classes_.reset(new std::unordered_set<std::string>);
2317 }
2318 return true;
2319 }
2320
2321 bool PrepareCompiledClasses() {
2322 // If --compiled-classes was specified, calculate the full list of classes to compile in the
2323 // image.
2324 if (compiled_classes_filename_ != nullptr) {
2325 compiled_classes_ =
2326 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
2327 if (compiled_classes_ == nullptr) {
2328 return false;
2329 }
2330 } else {
2331 compiled_classes_.reset(nullptr); // By default compile everything.
2332 }
2333 return true;
2334 }
2335
2336 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2337 const char* classes_filename,
2338 const char* tag) {
2339 std::unique_ptr<std::unordered_set<std::string>> classes;
2340 std::string error_msg;
2341 if (zip_filename != nullptr) {
2342 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2343 } else {
2344 classes.reset(ReadImageClassesFromFile(classes_filename));
2345 }
2346 if (classes == nullptr) {
2347 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2348 << classes_filename << "': " << error_msg;
2349 }
2350 return classes;
2351 }
2352
2353 bool PrepareCompiledMethods() {
2354 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2355 if (compiled_methods_filename_ != nullptr) {
2356 std::string error_msg;
2357 if (compiled_methods_zip_filename_ != nullptr) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002358 compiled_methods_.reset(ReadCommentedInputFromZip<std::unordered_set<std::string>>(
2359 compiled_methods_zip_filename_,
2360 compiled_methods_filename_,
2361 nullptr, // No post-processing.
2362 &error_msg));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002363 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002364 compiled_methods_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2365 compiled_methods_filename_,
2366 nullptr)); // No post-processing.
Vladimir Marko49b0f452015-12-10 13:49:19 +00002367 }
2368 if (compiled_methods_.get() == nullptr) {
2369 LOG(ERROR) << "Failed to create list of compiled methods from '"
2370 << compiled_methods_filename_ << "': " << error_msg;
2371 return false;
2372 }
2373 } else {
2374 compiled_methods_.reset(nullptr); // By default compile everything.
2375 }
2376 return true;
2377 }
2378
Jeff Haoc23b0c02017-07-27 18:19:38 -07002379 bool PrepareDirtyObjects() {
2380 if (dirty_image_objects_filename_ != nullptr) {
2381 dirty_image_objects_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2382 dirty_image_objects_filename_,
2383 nullptr));
2384 if (dirty_image_objects_ == nullptr) {
2385 LOG(ERROR) << "Failed to create list of dirty objects from '"
2386 << dirty_image_objects_filename_ << "'";
2387 return false;
2388 }
2389 } else {
2390 dirty_image_objects_.reset(nullptr);
2391 }
2392 return true;
2393 }
2394
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002395 void PruneNonExistentDexFiles() {
2396 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2397 size_t kept = 0u;
2398 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2399 if (!OS::FileExists(dex_filenames_[i])) {
2400 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2401 } else {
2402 dex_filenames_[kept] = dex_filenames_[i];
2403 dex_locations_[kept] = dex_locations_[i];
2404 ++kept;
2405 }
2406 }
2407 dex_filenames_.resize(kept);
2408 dex_locations_.resize(kept);
2409 }
2410
2411 bool AddDexFileSources() {
2412 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002413 if (input_vdex_file_ != nullptr) {
2414 DCHECK_EQ(oat_writers_.size(), 1u);
2415 const std::string& name = zip_location_.empty() ? dex_locations_[0] : zip_location_;
2416 DCHECK(!name.empty());
2417 if (!oat_writers_[0]->AddVdexDexFilesSource(*input_vdex_file_.get(), name.c_str())) {
2418 return false;
2419 }
2420 } else if (zip_fd_ != -1) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002421 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002422 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2423 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002424 return false;
2425 }
2426 } else if (oat_writers_.size() > 1u) {
2427 // Multi-image.
2428 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2429 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2430 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2431 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2432 return false;
2433 }
2434 }
2435 } else {
2436 DCHECK_EQ(oat_writers_.size(), 1u);
2437 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2438 DCHECK_NE(dex_filenames_.size(), 0u);
2439 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2440 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2441 return false;
2442 }
2443 }
2444 }
2445 return true;
2446 }
2447
2448 void CreateOatWriters() {
2449 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2450 elf_writers_.reserve(oat_files_.size());
2451 oat_writers_.reserve(oat_files_.size());
2452 for (const std::unique_ptr<File>& oat_file : oat_files_) {
Vladimir Marko74527972016-11-29 15:57:32 +00002453 elf_writers_.emplace_back(linker::CreateElfWriterQuick(instruction_set_,
2454 instruction_set_features_.get(),
2455 compiler_options_.get(),
2456 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002457 elf_writers_.back()->Start();
Igor Murashkin545412b2017-08-17 15:26:54 -07002458 const bool do_oat_writer_layout = DoDexLayoutOptimizations() || DoOatLayoutOptimizations();
Vladimir Marko74527972016-11-29 15:57:32 +00002459 oat_writers_.emplace_back(new linker::OatWriter(
Igor Murashkin545412b2017-08-17 15:26:54 -07002460 IsBootImage(),
2461 timings_,
Mathieu Chartier603ccab2017-10-20 14:34:28 -07002462 do_oat_writer_layout ? profile_compilation_info_.get() : nullptr,
2463 compact_dex_level_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002464 }
2465 }
2466
Vladimir Marko49b0f452015-12-10 13:49:19 +00002467 void SaveDexInput() {
2468 for (size_t i = 0; i < dex_files_.size(); ++i) {
2469 const DexFile* dex_file = dex_files_[i];
2470 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2471 getpid(), i));
2472 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2473 if (tmp_file.get() == nullptr) {
2474 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2475 << ". Try: adb shell chmod 777 /data/local/tmp";
2476 continue;
2477 }
2478 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2479 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2480 UNUSED(tmp_file->Flush());
2481 UNUSED(tmp_file->Close());
2482 LOG(INFO) << "Wrote input to " << tmp_file_name;
2483 }
2484 }
2485
Mathieu Chartier46331a62017-07-21 09:49:10 -07002486 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options,
2487 QuickCompilerCallbacks* callbacks) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00002488 RuntimeOptions raw_options;
2489 if (boot_image_filename_.empty()) {
2490 std::string boot_class_path = "-Xbootclasspath:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002491 boot_class_path += android::base::Join(dex_filenames_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002492 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2493 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002494 boot_class_path_locations += android::base::Join(dex_locations_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002495 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2496 } else {
2497 std::string boot_image_option = "-Ximage:";
2498 boot_image_option += boot_image_filename_;
2499 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2500 }
2501 for (size_t i = 0; i < runtime_args_.size(); i++) {
2502 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2503 }
2504
Mathieu Chartier46331a62017-07-21 09:49:10 -07002505 raw_options.push_back(std::make_pair("compilercallbacks", callbacks));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002506 raw_options.push_back(
2507 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2508
2509 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2510 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2511 // have been stripped in preopting, anyways).
2512 if (!IsBootImage()) {
2513 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2514 }
Andreas Gampec8e35202017-04-28 15:47:12 -07002515 // Never allow implicit image compilation.
2516 raw_options.push_back(std::make_pair("-Xnoimage-dex2oat", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002517 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2518 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2519 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002520 // Disable Hspace compaction to save heap size virtual space.
2521 // Only need disable Hspace for OOM becasue background collector is equal to
2522 // foreground collector by default for dex2oat.
2523 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002524
Andreas Gampeace0dc12016-01-20 13:33:13 -08002525 if (compiler_options_->IsForceDeterminism()) {
Roland Levillainb81e9e92017-04-20 17:35:32 +01002526 // If we're asked to be deterministic, ensure non-concurrent GC for determinism.
2527 //
2528 // Note that with read barriers, this option is ignored, because Runtime::Init
2529 // overrides the foreground GC to be gc::kCollectorTypeCC when instantiating
2530 // gc::Heap. This is fine, as concurrent GC requests are not honored in dex2oat,
2531 // which uses an unstarted runtime.
Andreas Gampeace0dc12016-01-20 13:33:13 -08002532 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
Roland Levillainb81e9e92017-04-20 17:35:32 +01002533
Nicolas Geoffray7acddd82017-05-03 15:04:55 +01002534 // The default LOS implementation (map) is not deterministic. So disable it.
2535 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=disabled", nullptr));
Andreas Gampeace0dc12016-01-20 13:33:13 -08002536
2537 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2538 // compaction (done above) and ensure that neither foreground nor background collectors
2539 // are concurrent.
Roland Levillainb81e9e92017-04-20 17:35:32 +01002540 //
2541 // Likewise, this option is ignored with read barriers because Runtime::Init
2542 // overrides the background GC to be gc::kCollectorTypeCCBackground, but that's
2543 // fine too, for the same reason (see above).
Andreas Gampeace0dc12016-01-20 13:33:13 -08002544 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2545
2546 // To make identity hashcode deterministic, set a known seed.
2547 mirror::Object::SetHashCodeSeed(987654321U);
2548 }
2549
Vladimir Marko49b0f452015-12-10 13:49:19 +00002550 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2551 LOG(ERROR) << "Failed to parse runtime options";
2552 return false;
2553 }
2554 return true;
2555 }
2556
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002557 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002558 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2559 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002560 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002561 LOG(ERROR) << "Failed to create runtime";
2562 return false;
2563 }
Andreas Gampe49c144d2016-11-14 10:11:16 -08002564
2565 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2566 // "ps -a" don't change to non-descript "main."
2567 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2568
Vladimir Marko307dac92015-10-20 11:20:09 +01002569 runtime_.reset(Runtime::Current());
2570 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe8228cdf2017-05-30 15:03:54 -07002571 for (uint32_t i = 0; i < static_cast<uint32_t>(CalleeSaveType::kLastCalleeSaveType); ++i) {
2572 CalleeSaveType type = CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002573 if (!runtime_->HasCalleeSaveMethod(type)) {
2574 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002575 }
2576 }
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002577
2578 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2579 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002580 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002581
Vladimir Marko307dac92015-10-20 11:20:09 +01002582 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002583
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002584 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2585 // Runtime::Start, give it away now so that we don't starve GC.
2586 Thread* self = Thread::Current();
2587 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002588
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002589 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002590 }
2591
Jeff Haodcdc85b2015-12-04 14:06:18 -08002592 // 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 -08002593 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002594 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002595 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002596 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002597 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002598 image_filenames_.push_back(app_image_file_name_.c_str());
2599 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002600 if (!image_writer_->Write(app_image_fd_,
2601 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002602 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002603 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002604 return false;
2605 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002606
Jeff Haodcdc85b2015-12-04 14:06:18 -08002607 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002608 dchecked_vector<uintptr_t> oat_data_begins;
2609 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2610 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002611 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002612 // Destroy ImageWriter before doing FixupElf.
2613 image_writer_.reset();
2614
Vladimir Marko944da602016-02-19 12:27:55 +00002615 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2616 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002617 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2618 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2619 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2620 if (oat_file.get() == nullptr) {
2621 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2622 return false;
2623 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002624
Vladimir Marko74527972016-11-29 15:57:32 +00002625 if (!linker::ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002626 oat_file->Erase();
2627 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2628 return false;
2629 }
2630
2631 if (oat_file->FlushCloseOrErase()) {
2632 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2633 return false;
2634 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002635 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002636 }
2637
2638 return true;
2639 }
2640
2641 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002642 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2643 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002644 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002645 return ReadCommentedInputFromFile<std::unordered_set<std::string>>(image_classes_filename,
2646 &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002647 }
2648
2649 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002650 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002651 const char* zip_filename,
2652 const char* image_classes_filename,
2653 std::string* error_msg) {
2654 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002655 return ReadCommentedInputFromZip<std::unordered_set<std::string>>(zip_filename,
2656 image_classes_filename,
2657 &process,
2658 error_msg);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002659 }
2660
2661 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2662 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002663 template <typename T>
2664 static T* ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002665 const char* input_filename, std::function<std::string(const char*)>* process) {
2666 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2667 if (input_file.get() == nullptr) {
2668 LOG(ERROR) << "Failed to open input file " << input_filename;
2669 return nullptr;
2670 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002671 std::unique_ptr<T> result(
2672 ReadCommentedInputStream<T>(*input_file, process));
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002673 input_file->close();
2674 return result.release();
2675 }
2676
2677 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2678 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002679 template <typename T>
2680 static T* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002681 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002682 const char* input_filename,
2683 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002684 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002685 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2686 if (zip_archive.get() == nullptr) {
2687 return nullptr;
2688 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002689 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002690 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002691 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002692 zip_filename, error_msg->c_str());
2693 return nullptr;
2694 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002695 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2696 input_filename,
2697 error_msg));
2698 if (input_file.get() == nullptr) {
2699 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002700 zip_filename, error_msg->c_str());
2701 return nullptr;
2702 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002703 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2704 input_file->Size());
2705 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002706 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002707 }
2708
2709 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2710 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002711 template <typename T>
2712 static T* ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002713 std::istream& in_stream,
2714 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002715 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002716 while (in_stream.good()) {
2717 std::string dot;
2718 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08002719 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002720 continue;
2721 }
2722 if (process != nullptr) {
2723 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002724 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002725 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002726 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002727 }
2728 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002729 return output.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002730 }
2731
Mathieu Chartier49285c52014-12-02 15:43:48 -08002732 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002733 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2734 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002735 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampec560fc02014-07-16 09:57:39 -07002736 LOG(INFO) << "dex2oat took "
2737 << PrettyDuration(NanoTime() - start_ns_)
Andreas Gampecc967752016-12-12 13:49:00 -08002738 << " (" << PrettyDuration(ProcessCpuNanoTime() - start_cputime_ns_) << " cpu)"
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002739 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002740 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002741 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2742 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002743 }
2744
Jeff Haodcdc85b2015-12-04 14:06:18 -08002745 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2746 std::string res(image_filename);
2747 size_t last_slash = res.rfind('/');
2748 if (last_slash == std::string::npos || last_slash == 0) {
2749 return res;
2750 }
2751 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2752 if (penultimate_slash == std::string::npos) {
2753 return res;
2754 }
2755 // Check that the string in-between is the expected one.
2756 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2757 GetInstructionSetString(isa)) {
2758 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2759 return res;
2760 }
2761 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2762 }
2763
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002764 std::unique_ptr<CompilerOptions> compiler_options_;
2765 Compiler::Kind compiler_kind_;
2766
2767 InstructionSet instruction_set_;
2768 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2769
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002770 uint32_t image_file_location_oat_checksum_;
2771 uintptr_t image_file_location_oat_data_begin_;
2772 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002773 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2774
Vladimir Marko307dac92015-10-20 11:20:09 +01002775 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002776
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002777 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2778
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002779 std::unique_ptr<Runtime> runtime_;
2780
Calin Juravle1ce70852017-06-28 10:59:03 -07002781 // The spec describing how the class loader should be setup for compilation.
2782 std::unique_ptr<ClassLoaderContext> class_loader_context_;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002783
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002784 size_t thread_count_;
2785 uint64_t start_ns_;
Andreas Gampec560fc02014-07-16 09:57:39 -07002786 uint64_t start_cputime_ns_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002787 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002788 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002789 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002790 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002791 std::vector<const char*> oat_filenames_;
2792 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002793 int oat_fd_;
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00002794 int input_vdex_fd_;
2795 int output_vdex_fd_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002796 std::string input_vdex_;
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01002797 std::string output_vdex_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002798 std::unique_ptr<VdexFile> input_vdex_file_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002799 std::vector<const char*> dex_filenames_;
2800 std::vector<const char*> dex_locations_;
2801 int zip_fd_;
2802 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002803 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002804 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002805 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002806 uintptr_t image_base_;
2807 const char* image_classes_zip_filename_;
2808 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002809 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002810 const char* compiled_classes_zip_filename_;
2811 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002812 const char* compiled_methods_zip_filename_;
2813 const char* compiled_methods_filename_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002814 const char* passes_to_run_filename_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002815 const char* dirty_image_objects_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002816 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2817 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002818 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Jeff Haoc23b0c02017-07-27 18:19:38 -07002819 std::unique_ptr<std::unordered_set<std::string>> dirty_image_objects_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002820 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Jeff Hao436183f2016-01-12 16:36:50 -08002821 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002822 bool is_host_;
2823 std::string android_root_;
Mathieu Chartier0b490842016-05-25 15:05:59 -07002824 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002825 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002826 std::string no_inline_from_string_;
Mathieu Chartiereafe2a52017-10-19 15:29:42 -07002827 CompactDexLevel compact_dex_level_ = CompactDexLevel::kCompactDexLevelNone;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002828
Vladimir Marko74527972016-11-29 15:57:32 +00002829 std::vector<std::unique_ptr<linker::ElfWriter>> elf_writers_;
2830 std::vector<std::unique_ptr<linker::OatWriter>> oat_writers_;
2831 std::vector<linker::OutputStream*> rodata_;
2832 std::vector<std::unique_ptr<linker::OutputStream>> vdex_out_;
2833 std::unique_ptr<linker::ImageWriter> image_writer_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002834 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002835
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002836 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
2837 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2838
Calin Juravle1ce70852017-06-28 10:59:03 -07002839 // Note that this might contain pointers owned by class_loader_context_.
Vladimir Marko47496c22016-01-27 16:15:08 +00002840 std::vector<const DexFile*> no_inline_from_dex_files_;
2841
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002842 bool dump_stats_;
2843 bool dump_passes_;
2844 bool dump_timing_;
2845 bool dump_slow_timing_;
Mathieu Chartierd1ab1bd2017-08-04 10:21:50 -07002846 bool avoid_storing_invocation_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002847 std::string swap_file_name_;
2848 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002849 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2850 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002851 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002852 std::string app_image_file_name_;
2853 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002854 std::string profile_file_;
2855 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002856 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002857 TimingLogger* timings_;
2858 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002859 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002860 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002861
2862 // Backing storage.
Andreas Gampe097f34c2017-08-23 08:57:51 -07002863 std::forward_list<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002864
Andreas Gampeace0dc12016-01-20 13:33:13 -08002865 // See CompilerOptions.force_determinism_.
2866 bool force_determinism_;
2867
Jeff Hao16d48432017-04-05 17:05:46 -07002868 // Directory of relative classpaths.
2869 std::string classpath_dir_;
2870
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00002871 // Whether the given input vdex is also the output.
2872 bool update_input_vdex_ = false;
2873
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002874 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2875};
2876
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002877static void b13564922() {
2878#if defined(__linux__) && defined(__arm__)
2879 int major, minor;
2880 struct utsname uts;
2881 if (uname(&uts) != -1 &&
2882 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2883 ((major < 3) || ((major == 3) && (minor < 4)))) {
2884 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2885 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2886 int old_personality = personality(0xffffffff);
2887 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2888 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2889 if (new_personality == -1) {
2890 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2891 }
2892 }
2893 }
2894#endif
2895}
2896
Mathieu Chartier72041a02017-07-14 18:23:25 -07002897class ScopedGlobalRef {
2898 public:
2899 explicit ScopedGlobalRef(jobject obj) : obj_(obj) {}
2900 ~ScopedGlobalRef() {
2901 if (obj_ != nullptr) {
2902 ScopedObjectAccess soa(Thread::Current());
2903 soa.Env()->vm->DeleteGlobalRef(soa.Self(), obj_);
2904 }
2905 }
2906
2907 private:
2908 jobject obj_;
2909};
2910
Andreas Gampe7b565912017-03-20 15:48:52 -07002911static dex2oat::ReturnCode CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002912 dex2oat.LoadClassProfileDescriptors();
Mathieu Chartier9e050df2017-08-09 10:05:47 -07002913 // Keep the class loader that was used for compilation live for the rest of the compilation
2914 // process.
Mathieu Chartier72041a02017-07-14 18:23:25 -07002915 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08002916
David Brazdil7b49e6c2016-09-01 11:06:18 +01002917 if (!dex2oat.WriteOutputFiles()) {
2918 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002919 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002920 }
2921
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002922 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2923 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2924 // image writer will require this fd to generate the image.
2925 if (dex2oat.ShouldKeepOatFileOpen()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002926 if (!dex2oat.FlushOutputFiles()) {
2927 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002928 return dex2oat::ReturnCode::kOther;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002929 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01002930 } else if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002931 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002932 }
2933
Jeff Haodcdc85b2015-12-04 14:06:18 -08002934 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002935 if (!dex2oat.HandleImage()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002936 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002937 }
2938
2939 // When given --host, finish early without stripping.
2940 if (dex2oat.IsHost()) {
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002941 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002942 return dex2oat::ReturnCode::kOther;
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002943 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002944 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002945 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002946 }
2947
Jeff Haodcdc85b2015-12-04 14:06:18 -08002948 // Copy stripped to unstripped location, if necessary.
2949 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002950 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002951 }
2952
Jeff Haodcdc85b2015-12-04 14:06:18 -08002953 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002954 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002955 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002956 }
2957
2958 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002959 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002960}
2961
Andreas Gampe7b565912017-03-20 15:48:52 -07002962static dex2oat::ReturnCode CompileApp(Dex2Oat& dex2oat) {
Mathieu Chartier9e050df2017-08-09 10:05:47 -07002963 // Keep the class loader that was used for compilation live for the rest of the compilation
2964 // process.
Mathieu Chartier72041a02017-07-14 18:23:25 -07002965 ScopedGlobalRef class_loader(dex2oat.Compile());
Andreas Gampe10e477d2014-11-19 12:57:42 -08002966
David Brazdil7b49e6c2016-09-01 11:06:18 +01002967 if (!dex2oat.WriteOutputFiles()) {
2968 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002969 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002970 }
2971
Jeff Haodcdc85b2015-12-04 14:06:18 -08002972 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002973 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002974
2975 // When given --host, finish early without stripping.
2976 if (dex2oat.IsHost()) {
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
Jeff Haodcdc85b2015-12-04 14:06:18 -08002985 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2986 // stripped versions. If this is given, we expect to be able to open writable files by name.
2987 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002988 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002989 }
2990
Jeff Haodcdc85b2015-12-04 14:06:18 -08002991 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002992 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002993 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002994 }
2995
2996 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002997 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002998}
2999
Andreas Gampe7b565912017-03-20 15:48:52 -07003000static dex2oat::ReturnCode Dex2oat(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003001 b13564922();
3002
3003 TimingLogger timings("compiler", false, false);
3004
Roland Levillain5c7e2602016-02-23 18:08:53 +00003005 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
3006 // might produce a stack frame too large for this function or for
3007 // functions inlining it (such as main), that would not fit the
3008 // requirements of the `-Wframe-larger-than` option.
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07003009 std::unique_ptr<Dex2Oat> dex2oat = std::make_unique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003010
3011 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003012 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003013
Calin Juravleb077e152016-02-18 18:47:37 +00003014 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02003015 // This operation involves I/O.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08003016 if (dex2oat->UseProfile()) {
Calin Juravleb077e152016-02-18 18:47:37 +00003017 if (!dex2oat->LoadProfile()) {
3018 LOG(ERROR) << "Failed to process profile file";
Andreas Gampe7b565912017-03-20 15:48:52 -07003019 return dex2oat::ReturnCode::kOther;
Calin Juravle998c2162015-12-21 15:39:33 +02003020 }
3021 }
3022
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00003023 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap, and vdex.
3024
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003025 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00003026 if (!dex2oat->OpenFile()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003027 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00003028 }
3029
Andreas Gampe046c7062015-05-18 23:22:54 -07003030 // Print the complete line when any of the following is true:
3031 // 1) Debug build
3032 // 2) Compiling an image
3033 // 3) Compiling with --host
3034 // 4) Compiling on the host (not a target build)
3035 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00003036 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07003037 LOG(INFO) << CommandLine();
3038 } else {
3039 LOG(INFO) << StrippedCommandLine();
3040 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003041
Andreas Gampef7882972017-03-20 16:35:24 -07003042 dex2oat::ReturnCode setup_code = dex2oat->Setup();
3043 if (setup_code != dex2oat::ReturnCode::kNoFailure) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003044 dex2oat->EraseOutputFiles();
Andreas Gampef7882972017-03-20 16:35:24 -07003045 return setup_code;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003046 }
3047
Shubham Ajmera188b2bf2017-09-20 15:53:35 -07003048 // TODO: Due to the cyclic dependencies, profile loading and verifying are
3049 // being done separately. Refactor and place the two next to each other.
3050 // If verification fails, we don't abort the compilation and instead log an
3051 // error.
3052 // TODO(b/62602192, b/65260586): We should consider aborting compilation when
3053 // the profile verification fails.
3054 // Note: If dex2oat fails, installd will remove the oat files causing the app
3055 // to fallback to apk with possible in-memory extraction. We want to avoid
3056 // that, and thus we're lenient towards profile corruptions.
3057 if (dex2oat->UseProfile()) {
3058 dex2oat->VerifyProfileData();
3059 }
3060
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07003061 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
3062 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07003063 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
3064
Andreas Gampe7b565912017-03-20 15:48:52 -07003065 dex2oat::ReturnCode result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00003066 if (dex2oat->IsImage()) {
3067 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08003068 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00003069 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003070 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003071
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003072 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003073}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003074} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07003075
3076int main(int argc, char** argv) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003077 int result = static_cast<int>(art::Dex2oat(argc, argv));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003078 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
3079 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
3080 // should not destruct the runtime in this case.
Evgenii Stepanov1e133742015-05-20 12:30:59 -07003081 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampee286b642017-04-13 12:20:42 -07003082 _exit(result);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003083 }
3084 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07003085}