blob: 3cc41a6b29a69117d5bc500da6a21932a6590047 [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
23#include <fstream>
24#include <iostream>
Andreas Gampe67f02822016-06-24 21:05:23 -070025#include <limits>
Brian Carlstrom7940e442013-07-12 13:46:57 -070026#include <sstream>
27#include <string>
Andreas Gampeb1fcead2015-04-20 18:53:51 -070028#include <unordered_set>
Brian Carlstrom7940e442013-07-12 13:46:57 -070029#include <vector>
30
Vladimir Markof94b7812014-06-05 15:48:04 +010031#if defined(__linux__) && defined(__arm__)
32#include <sys/personality.h>
33#include <sys/utsname.h>
34#endif
35
Andreas Gampe46ee31b2016-12-14 10:11:49 -080036#include "android-base/stringprintf.h"
Andreas Gampe9186ced2016-12-12 14:28:21 -080037#include "android-base/strings.h"
38
Ian Rogersd582fa42014-11-05 23:46:43 -080039#include "arch/instruction_set_features.h"
Andreas Gampec5a3ea72015-01-13 16:41:53 -080040#include "arch/mips/instruction_set_features_mips.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000041#include "art_method-inl.h"
Andreas Gampe8228cdf2017-05-30 15:03:54 -070042#include "base/callee_save_type.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070043#include "base/dumpable.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080044#include "base/macros.h"
Calin Juravle2e2db782016-02-23 12:00:03 +000045#include "base/scoped_flock.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070046#include "base/stl_util.h"
47#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010048#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070049#include "base/timing_logger.h"
50#include "base/unix_file/fd_file.h"
51#include "class_linker.h"
Calin Juravle1ce70852017-06-28 10:59:03 -070052#include "class_loader_context.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000053#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000054#include "compiler_callbacks.h"
David Srbecky09c2a6b2016-03-11 17:11:44 +000055#include "debug/elf_debug_writer.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000056#include "debug/method_debug_info.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000057#include "dex/quick_compiler_callbacks.h"
58#include "dex/verification_results.h"
Andreas Gampe7b565912017-03-20 15:48:52 -070059#include "dex2oat_return_codes.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000060#include "dex_file-inl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070061#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080062#include "driver/compiler_options.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080063#include "elf_file.h"
Tong Shen62d1ca32014-09-03 17:24:56 -070064#include "elf_writer.h"
Vladimir Marko10c13562015-11-25 14:33:36 +000065#include "elf_writer_quick.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070066#include "gc/space/image_space.h"
67#include "gc/space/space-inl.h"
68#include "image_writer.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070069#include "interpreter/unstarted_runtime.h"
Calin Juravle33083d62017-01-18 15:29:12 -080070#include "jit/profile_compilation_info.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070071#include "leb128.h"
David Brazdil5d5a36b2016-09-14 15:34:10 +010072#include "linker/buffered_output_stream.h"
73#include "linker/file_output_stream.h"
Vladimir Marko944da602016-02-19 12:27:55 +000074#include "linker/multi_oat_relative_patcher.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070075#include "mirror/class-inl.h"
76#include "mirror/class_loader.h"
77#include "mirror/object-inl.h"
78#include "mirror/object_array-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070079#include "nativehelper/ScopedLocalRef.h"
Andreas Gampe2ff3b972017-06-05 18:14:53 -070080#include "oat_file.h"
Jeff Haob11ffb72016-04-07 15:40:54 -070081#include "oat_file_assistant.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070082#include "oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070083#include "os.h"
84#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000085#include "runtime_options.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070086#include "scoped_thread_state_change-inl.h"
Alex Light53cb16b2014-06-12 11:26:29 -070087#include "utils.h"
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +000088#include "vdex_file.h"
David Brazdilca3c8c32016-09-06 14:04:48 +010089#include "verifier/verifier_deps.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070090#include "well_known_classes.h"
91#include "zip_archive.h"
92
93namespace art {
94
Andreas Gampe46ee31b2016-12-14 10:11:49 -080095using android::base::StringAppendV;
96using android::base::StringPrintf;
97
Andreas Gampee1459ae2016-06-29 09:36:30 -070098static constexpr size_t kDefaultMinDexFilesForSwap = 2;
99static constexpr size_t kDefaultMinDexFileCumulativeSizeForSwap = 20 * MB;
100
Mathieu Chartier010126f2017-07-15 15:44:18 -0700101// Compiler filter override for very large apps.
102static constexpr CompilerFilter::Filter kLargeAppFilter = CompilerFilter::kVerify;
103
Brian Carlstrom6449c622014-02-10 23:48:36 -0800104static int original_argc;
105static char** original_argv;
106
107static std::string CommandLine() {
108 std::vector<std::string> command;
109 for (int i = 0; i < original_argc; ++i) {
110 command.push_back(original_argv[i]);
111 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800112 return android::base::Join(command, ' ');
Brian Carlstrom6449c622014-02-10 23:48:36 -0800113}
114
Andreas Gampe046c7062015-05-18 23:22:54 -0700115// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
116// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
117// locations are all staged).
118static std::string StrippedCommandLine() {
119 std::vector<std::string> command;
120
Calin Juravle07c6d722017-06-07 17:06:12 +0000121 // Do a pre-pass to look for zip-fd and the compiler filter.
Andreas Gampe046c7062015-05-18 23:22:54 -0700122 bool saw_zip_fd = false;
Calin Juravle07c6d722017-06-07 17:06:12 +0000123 bool saw_compiler_filter = false;
Andreas Gampe046c7062015-05-18 23:22:54 -0700124 for (int i = 0; i < original_argc; ++i) {
Andreas Gampe9186ced2016-12-12 14:28:21 -0800125 if (android::base::StartsWith(original_argv[i], "--zip-fd=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700126 saw_zip_fd = true;
Andreas Gampe046c7062015-05-18 23:22:54 -0700127 }
Calin Juravle07c6d722017-06-07 17:06:12 +0000128 if (android::base::StartsWith(original_argv[i], "--compiler-filter=")) {
129 saw_compiler_filter = true;
Calin Juravle07c6d722017-06-07 17:06:12 +0000130 }
Andreas Gampe046c7062015-05-18 23:22:54 -0700131 }
132
133 // Now filter out things.
134 for (int i = 0; i < original_argc; ++i) {
135 // All runtime-arg parameters are dropped.
136 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
137 i++; // Drop the next part, too.
138 continue;
139 }
140
141 // Any instruction-setXXX is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800142 if (android::base::StartsWith(original_argv[i], "--instruction-set")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700143 continue;
144 }
145
146 // The boot image is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800147 if (android::base::StartsWith(original_argv[i], "--boot-image=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700148 continue;
149 }
150
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800151 // The image format is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800152 if (android::base::StartsWith(original_argv[i], "--image-format=")) {
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800153 continue;
154 }
155
Andreas Gampe046c7062015-05-18 23:22:54 -0700156 // This should leave any dex-file and oat-file options, describing what we compiled.
157
158 // However, we prefer to drop this when we saw --zip-fd.
159 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700160 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe9186ced2016-12-12 14:28:21 -0800161 if (android::base::StartsWith(original_argv[i], "--zip-") ||
162 android::base::StartsWith(original_argv[i], "--dex-") ||
163 android::base::StartsWith(original_argv[i], "--oat-") ||
164 android::base::StartsWith(original_argv[i], "--swap-") ||
165 android::base::StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700166 continue;
167 }
168 }
169
170 command.push_back(original_argv[i]);
171 }
172
Calin Juravle07c6d722017-06-07 17:06:12 +0000173 if (!saw_compiler_filter) {
174 command.push_back("--compiler-filter=" +
175 CompilerFilter::NameOfFilter(CompilerFilter::kDefaultCompilerFilter));
176 }
177
Andreas Gampe046c7062015-05-18 23:22:54 -0700178 // Construct the final output.
179 if (command.size() <= 1U) {
180 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
181 return "Starting dex2oat.";
182 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800183 return android::base::Join(command, ' ');
Andreas Gampe046c7062015-05-18 23:22:54 -0700184}
185
Brian Carlstrom7940e442013-07-12 13:46:57 -0700186static void UsageErrorV(const char* fmt, va_list ap) {
187 std::string error;
188 StringAppendV(&error, fmt, ap);
189 LOG(ERROR) << error;
190}
191
192static void UsageError(const char* fmt, ...) {
193 va_list ap;
194 va_start(ap, fmt);
195 UsageErrorV(fmt, ap);
196 va_end(ap);
197}
198
Andreas Gampe794ad762015-02-23 08:12:24 -0800199NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700200 va_list ap;
201 va_start(ap, fmt);
202 UsageErrorV(fmt, ap);
203 va_end(ap);
204
Brian Carlstrom6449c622014-02-10 23:48:36 -0800205 UsageError("Command: %s", CommandLine().c_str());
206
Brian Carlstrom7940e442013-07-12 13:46:57 -0700207 UsageError("Usage: dex2oat [options]...");
208 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100209 UsageError(" -j<number>: specifies the number of threads used for compilation.");
210 UsageError(" Default is the number of detected hardware threads available on the");
211 UsageError(" host system.");
212 UsageError(" Example: -j12");
213 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700214 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700215 UsageError(" Example: --dex-file=/system/framework/core.jar");
216 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700217 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
218 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
219 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
220 UsageError(" --dex-location=/system/framework/core.jar");
221 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700222 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
223 UsageError(" containing a classes.dex file to compile.");
224 UsageError(" Example: --zip-fd=5");
225 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700226 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
227 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700228 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
229 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800230 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700231 UsageError(" Example: --oat-file=/system/framework/boot.oat");
232 UsageError("");
233 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900234 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700235 UsageError("");
236 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
237 UsageError(" to the file descriptor specified by --oat-fd.");
238 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
239 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800240 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700241 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
242 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800243 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700244 UsageError(" Example: --image=/system/framework/boot.art");
245 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800246 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800247 UsageError(" Which format to store the image.");
248 UsageError(" Example: --image-format=lz4");
249 UsageError(" Default: uncompressed");
250 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700251 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
252 UsageError(" Example: --image=frameworks/base/preloaded-classes");
253 UsageError("");
254 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
255 UsageError(" Example: --base=0x50000000");
256 UsageError("");
257 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000258 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700259 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000260 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000261 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700262 UsageError("");
263 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
264 UsageError(" Example: --android-root=out/host/linux-x86");
265 UsageError(" Default: $ANDROID_ROOT");
266 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800267 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700268 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700269 UsageError(" Example: --instruction-set=x86");
270 UsageError(" Default: arm");
271 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700272 UsageError(" --instruction-set-features=...,: Specify instruction set features");
273 UsageError(" Example: --instruction-set-features=div");
274 UsageError(" Default: default");
275 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700276 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
277 UsageError(" Default: disabled");
278 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800279 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700280 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800281 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100282 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700283 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100284 UsageError(" --compiler-filter="
Nicolas Geoffray49cda062017-04-21 13:08:25 +0100285 "(assume-verified"
286 "|extract"
287 "|verify"
288 "|quicken"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000289 "|space-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100290 "|space"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000291 "|speed-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100292 "|speed"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000293 "|everything-profile"
294 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700295 UsageError(" select compiler filter.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800296 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800297 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800298 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800299 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
300 UsageError(" method for compiler filter tuning.");
301 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
302 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
303 UsageError("");
304 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
305 UsageError(" method for compiler filter tuning.");
306 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
307 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
308 UsageError("");
309 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
310 UsageError(" method for compiler filter tuning.");
311 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
312 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
313 UsageError("");
314 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
315 UsageError(" method for compiler filter tuning.");
316 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
317 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
318 UsageError("");
319 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
320 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700321 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
322 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800323 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
324 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
325 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100326 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
327 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100328 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
329 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100330 UsageError(" Example: --inline-max-code-units=%d",
331 CompilerOptions::kDefaultInlineMaxCodeUnits);
332 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
333 UsageError("");
Ian Rogers46398602013-08-20 07:50:36 -0700334 UsageError(" --dump-timing: display a breakdown of where time was spent");
335 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100336 UsageError(" -g");
337 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
338 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000339 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000340 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700341 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100342 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100343 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000344 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
345 UsageError(" debug information necessary to print backtraces. (disabled by default)");
346 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000347 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000348 UsageError("");
Alexey Alexandrovab40c112016-09-19 09:33:49 -0700349 UsageError(" --generate-build-id: Generate GNU-compatible linker build ID ELF section with");
350 UsageError(" SHA-1 of the file content (and thus stable across identical builds)");
351 UsageError("");
352 UsageError(" --no-generate-build-id: Do not generate the build ID ELF section.");
353 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000354 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000355 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700356 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
357 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
358 UsageError(" Use a separate --runtime-arg switch for each argument.");
359 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700360 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000361 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700362 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000363 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
364 UsageError(" Cannot be used together with --profile-file.");
365 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100366 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800367 UsageError(" Example: --swap-file=/data/tmp/swap.001");
368 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100369 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800370 UsageError(" Example: --swap-fd=10");
371 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100372 UsageError(" --swap-dex-size-threshold=<size>: specifies the minimum total dex file size in");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700373 UsageError(" bytes to allow the use of swap.");
374 UsageError(" Example: --swap-dex-size-threshold=1000000");
375 UsageError(" Default: %zu", kDefaultMinDexFileCumulativeSizeForSwap);
376 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100377 UsageError(" --swap-dex-count-threshold=<count>: specifies the minimum number of dex files to");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700378 UsageError(" allow the use of swap.");
379 UsageError(" Example: --swap-dex-count-threshold=10");
380 UsageError(" Default: %zu", kDefaultMinDexFilesForSwap);
381 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100382 UsageError(" --very-large-app-threshold=<size>: specifies the minimum total dex file size in");
Mathieu Chartier010126f2017-07-15 15:44:18 -0700383 UsageError(" bytes to consider the input \"very large\" and reduce compilation done.");
Andreas Gampe67f02822016-06-24 21:05:23 -0700384 UsageError(" Example: --very-large-app-threshold=100000000");
385 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700386 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
387 UsageError(" Example: --app-image-fd=10");
388 UsageError("");
389 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
390 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
391 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800392 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
393 "input dex file.");
394 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000395 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000396 UsageError("");
Roland Levillainf5bea5e2017-05-02 12:46:07 +0100397 UsageError(" --dump-cfg=<cfg-file>: dump control-flow graphs (CFGs) to specified file.");
398 UsageError(" Example: --dump-cfg=output.cfg");
399 UsageError("");
400 UsageError(" --dump-cfg-append: when dumping CFGs to an existing file, append new CFG data to");
401 UsageError(" existing data (instead of overwriting existing data with new data, which is");
402 UsageError(" the default behavior). This option is only meaningful when used with");
403 UsageError(" --dump-cfg.");
404 UsageError("");
Jeff Hao16d48432017-04-05 17:05:46 -0700405 UsageError(" --classpath-dir=<directory-path>: directory used to resolve relative class paths.");
406 UsageError("");
Calin Juravle1ce70852017-06-28 10:59:03 -0700407 UsageError(" --class-loader-context=<string spec>: a string specifying the intended");
408 UsageError(" runtime loading context for the compiled dex files.");
409 UsageError(" ");
410 UsageError(" It describes how the class loader chain should be built in order to ensure");
411 UsageError(" classes are resolved during dex2aot as they would be resolved at runtime.");
412 UsageError(" This spec will be encoded in the oat file. If at runtime the dex file is");
413 UsageError(" loaded in a different context, the oat file will be rejected.");
414 UsageError(" ");
415 UsageError(" The chain is interpreted in the natural 'parent order', meaning that class");
416 UsageError(" loader 'i+1' will be the parent of class loader 'i'.");
Calin Juravlec79470d2017-07-12 17:37:42 -0700417 UsageError(" The compilation sources will be appended to the classpath of the first class");
418 UsageError(" loader.");
419 UsageError(" ");
420 UsageError(" E.g. if the context is 'PCL[lib1.dex];DLC[lib2.dex]' and ");
421 UsageError(" --dex-file=src.dex then dex2oat will setup a PathClassLoader with classpath ");
422 UsageError(" 'lib1.dex:src.dex' and set its parent to a DelegateLastClassLoader with ");
423 UsageError(" classpath 'lib2.dex'.");
Calin Juravle1ce70852017-06-28 10:59:03 -0700424 UsageError(" ");
425 UsageError(" Note that the compiler will be tolerant if the source dex files specified");
426 UsageError(" with --dex-file are found in the classpath. The source dex files will be");
427 UsageError(" removed from any class loader's classpath possibly resulting in empty");
428 UsageError(" class loaders.");
429 UsageError(" ");
Calin Juravlec79470d2017-07-12 17:37:42 -0700430 UsageError(" Example: --class-loader-context=PCL[lib1.dex:lib2.dex];DLC[lib3.dex]");
Calin Juravle1ce70852017-06-28 10:59:03 -0700431 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700432 std::cerr << "See log for usage error information\n";
433 exit(EXIT_FAILURE);
434}
435
Brian Carlstrom7940e442013-07-12 13:46:57 -0700436// The primary goal of the watchdog is to prevent stuck build servers
437// during development when fatal aborts lead to a cascade of failures
438// that result in a deadlock.
439class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800440// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700441#undef CHECK_PTHREAD_CALL
442#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
443 do { \
444 int rc = call args; \
445 if (rc != 0) { \
446 errno = rc; \
447 std::string message(# call); \
448 message += " failed for "; \
449 message += reason; \
450 Fatal(message); \
451 } \
452 } while (false)
453
454 public:
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800455 explicit WatchDog(int64_t timeout_in_milliseconds)
456 : timeout_in_milliseconds_(timeout_in_milliseconds),
457 shutting_down_(false) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700458 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700459 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800460#ifndef __APPLE__
461 pthread_condattr_t condattr;
liulvping8f7101e2017-01-16 15:14:43 +0800462 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_init, (&condattr), reason);
463 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_setclock, (&condattr, CLOCK_MONOTONIC), reason);
464 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, &condattr), reason);
465 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_destroy, (&condattr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800466#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700467 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
468 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
469 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
470 }
471 ~WatchDog() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700472 const char* reason = "dex2oat watch dog thread shutdown";
473 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
474 shutting_down_ = true;
475 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
476 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
477
Kenny Root51316382014-05-13 14:59:37 -0700478 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700479
480 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
481 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
482 }
483
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800484 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
485 // large.
486 static constexpr int64_t kWatchdogVerifyMultiplier =
487 kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
488
489 // When setting timeouts, keep in mind that the build server may not be as fast as your
490 // desktop. Debug builds are slower so they have larger timeouts.
491 static constexpr int64_t kWatchdogSlowdownFactor = kIsDebugBuild ? 5U : 1U;
492
493 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
494 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
495 // itself before that watchdog would take down the system server.
496 static constexpr int64_t kWatchDogTimeoutSeconds = kWatchdogSlowdownFactor * (9 * 60 + 30);
497
498 static constexpr int64_t kDefaultWatchdogTimeoutInMS =
499 kWatchdogVerifyMultiplier * kWatchDogTimeoutSeconds * 1000;
500
Brian Carlstrom7940e442013-07-12 13:46:57 -0700501 private:
502 static void* CallBack(void* arg) {
503 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
504 ::art::SetThreadName("dex2oat watch dog");
505 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700506 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700507 }
508
Andreas Gampe794ad762015-02-23 08:12:24 -0800509 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700510 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
511 // it's rather easy to hang in unwinding.
512 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
513 // logcat logging or stderr output.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700514 android::base::LogMessage::LogLine(__FILE__,
515 __LINE__,
516 android::base::LogId::DEFAULT,
517 LogSeverity::FATAL,
518 message.c_str());
Andreas Gampe48fde372017-06-06 07:43:46 -0700519 // If we're on the host, try to dump all threads to get a sense of what's going on. This is
520 // restricted to the host as the dump may itself go bad.
521 // TODO: Use a double watchdog timeout, so we can enable this on-device.
522 if (!kIsTargetBuild && Runtime::Current() != nullptr) {
Andreas Gampecd607312017-06-05 17:03:05 -0700523 Runtime::Current()->AttachCurrentThread("Watchdog thread attached for dumping",
524 true,
525 nullptr,
526 false);
527 Runtime::Current()->DumpForSigQuit(std::cerr);
528 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700529 exit(1);
530 }
531
532 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700533 timespec timeout_ts;
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800534#if defined(__APPLE__)
535 InitTimeSpec(true, CLOCK_REALTIME, timeout_in_milliseconds_, 0, &timeout_ts);
536#else
liulvping8f7101e2017-01-16 15:14:43 +0800537 InitTimeSpec(true, CLOCK_MONOTONIC, timeout_in_milliseconds_, 0, &timeout_ts);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800538#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700539 const char* reason = "dex2oat watch dog thread waiting";
540 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
541 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800542 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700543 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700544 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800545 timeout_in_milliseconds_/1000));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700546 } else if (rc != 0) {
547 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
548 strerror(errno)));
549 Fatal(message.c_str());
550 }
551 }
552 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
553 }
554
Brian Carlstrom7940e442013-07-12 13:46:57 -0700555 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
556 pthread_mutex_t mutex_;
557 pthread_cond_t cond_;
558 pthread_attr_t attr_;
559 pthread_t pthread_;
Andreas Gampef45d61c2017-06-07 10:29:33 -0700560
561 const int64_t timeout_in_milliseconds_;
562 bool shutting_down_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700563};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700564
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800565class Dex2Oat FINAL {
566 public:
567 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100568 compiler_kind_(Compiler::kOptimizing),
Artem Serovba6b6792016-08-15 14:22:07 +0100569 instruction_set_(kRuntimeISA == kArm ? kThumb2 : kRuntimeISA),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800570 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000571 image_file_location_oat_checksum_(0),
572 image_file_location_oat_data_begin_(0),
573 image_patch_delta_(0),
574 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700575 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800576 runtime_(nullptr),
577 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
578 start_ns_(NanoTime()),
Andreas Gampec560fc02014-07-16 09:57:39 -0700579 start_cputime_ns_(ProcessCpuNanoTime()),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800580 oat_fd_(-1),
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000581 input_vdex_fd_(-1),
582 output_vdex_fd_(-1),
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000583 input_vdex_file_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800584 zip_fd_(-1),
585 image_base_(0U),
586 image_classes_zip_filename_(nullptr),
587 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800588 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800589 compiled_classes_zip_filename_(nullptr),
590 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700591 compiled_methods_zip_filename_(nullptr),
592 compiled_methods_filename_(nullptr),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700593 passes_to_run_filename_(nullptr),
Jeff Hao436183f2016-01-12 16:36:50 -0800594 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800595 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000596 class_loader_(nullptr),
597 elf_writers_(),
598 oat_writers_(),
599 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000600 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700601 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000602 opened_dex_files_maps_(),
603 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000604 no_inline_from_dex_files_(),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800605 dump_stats_(false),
606 dump_passes_(false),
607 dump_timing_(false),
608 dump_slow_timing_(kIsDebugBuild),
Calin Juravle2e2db782016-02-23 12:00:03 +0000609 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800610 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000611 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800612 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000613 force_determinism_(false)
614 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800615
616 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800617 // Log completion time before deleting the runtime_, because this accesses
618 // the runtime.
619 LogCompletionTime();
620
Vladimir Marko307dac92015-10-20 11:20:09 +0100621 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
622 // We want to just exit on non-debug builds, not bringing the runtime down
623 // in an orderly fashion. So release the following fields.
624 driver_.release();
625 image_writer_.release();
626 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
627 dex_file.release();
628 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000629 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
630 map.release();
631 }
David Brazdil7b49e6c2016-09-01 11:06:18 +0100632 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
633 vdex_file.release();
634 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800635 for (std::unique_ptr<File>& oat_file : oat_files_) {
636 oat_file.release();
637 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100638 runtime_.release();
639 verification_results_.release();
640 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100641 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700642 }
643
Roland Levillain9ec5e222015-08-17 20:18:41 +0100644 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800645 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800646 std::string boot_image_filename;
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800647 int64_t watch_dog_timeout_in_ms = -1;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800648 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000649 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800650 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100651 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800652
Roland Levillain9ec5e222015-08-17 20:18:41 +0100653 void ParseZipFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000654 ParseUintOption(option, "--zip-fd", &zip_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100655 }
656
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000657 void ParseInputVdexFd(const StringPiece& option) {
658 // Note that the input vdex fd might be -1.
659 ParseIntOption(option, "--input-vdex-fd", &input_vdex_fd_, Usage);
660 }
661
662 void ParseOutputVdexFd(const StringPiece& option) {
663 ParseUintOption(option, "--output-vdex-fd", &output_vdex_fd_, Usage);
David Brazdil7b49e6c2016-09-01 11:06:18 +0100664 }
665
Roland Levillain9ec5e222015-08-17 20:18:41 +0100666 void ParseOatFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000667 ParseUintOption(option, "--oat-fd", &oat_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100668 }
669
Calin Juravle877fd962016-01-05 14:29:29 +0000670 void ParseFdForCollection(const StringPiece& option,
671 const char* arg_name,
672 std::vector<uint32_t>* fds) {
673 uint32_t fd;
674 ParseUintOption(option, arg_name, &fd, Usage);
675 fds->push_back(fd);
676 }
677
Roland Levillain9ec5e222015-08-17 20:18:41 +0100678 void ParseJ(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000679 ParseUintOption(option, "-j", &thread_count_, Usage, /* is_long_option */ false);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100680 }
681
682 void ParseBase(const StringPiece& option) {
683 DCHECK(option.starts_with("--base="));
684 const char* image_base_str = option.substr(strlen("--base=")).data();
685 char* end;
686 image_base_ = strtoul(image_base_str, &end, 16);
687 if (end == image_base_str || *end != '\0') {
688 Usage("Failed to parse hexadecimal value for option %s", option.data());
689 }
690 }
691
692 void ParseInstructionSet(const StringPiece& option) {
693 DCHECK(option.starts_with("--instruction-set="));
694 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
695 // StringPiece is not necessarily zero-terminated, so need to make a copy and ensure it.
696 std::unique_ptr<char[]> buf(new char[instruction_set_str.length() + 1]);
697 strncpy(buf.get(), instruction_set_str.data(), instruction_set_str.length());
698 buf.get()[instruction_set_str.length()] = 0;
699 instruction_set_ = GetInstructionSetFromString(buf.get());
700 // arm actually means thumb2.
701 if (instruction_set_ == InstructionSet::kArm) {
702 instruction_set_ = InstructionSet::kThumb2;
703 }
704 }
705
706 void ParseInstructionSetVariant(const StringPiece& option, ParserOptions* parser_options) {
707 DCHECK(option.starts_with("--instruction-set-variant="));
708 StringPiece str = option.substr(strlen("--instruction-set-variant=")).data();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800709 instruction_set_features_ = InstructionSetFeatures::FromVariant(
710 instruction_set_, str.as_string(), &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100711 if (instruction_set_features_.get() == nullptr) {
712 Usage("%s", parser_options->error_msg.c_str());
713 }
714 }
715
716 void ParseInstructionSetFeatures(const StringPiece& option, ParserOptions* parser_options) {
717 DCHECK(option.starts_with("--instruction-set-features="));
718 StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800719 if (instruction_set_features_ == nullptr) {
720 instruction_set_features_ = InstructionSetFeatures::FromVariant(
721 instruction_set_, "default", &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100722 if (instruction_set_features_.get() == nullptr) {
723 Usage("Problem initializing default instruction set features variant: %s",
724 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700725 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800726 }
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800727 instruction_set_features_ =
Roland Levillain9ec5e222015-08-17 20:18:41 +0100728 instruction_set_features_->AddFeaturesFromString(str.as_string(),
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800729 &parser_options->error_msg);
730 if (instruction_set_features_ == nullptr) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100731 Usage("Error parsing '%s': %s", option.data(), parser_options->error_msg.c_str());
732 }
733 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800734
Roland Levillain9ec5e222015-08-17 20:18:41 +0100735 void ParseCompilerBackend(const StringPiece& option, ParserOptions* parser_options) {
736 DCHECK(option.starts_with("--compiler-backend="));
737 parser_options->requested_specific_compiler = true;
738 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
739 if (backend_str == "Quick") {
740 compiler_kind_ = Compiler::kQuick;
741 } else if (backend_str == "Optimizing") {
742 compiler_kind_ = Compiler::kOptimizing;
743 } else {
744 Usage("Unknown compiler backend: %s", backend_str.data());
745 }
746 }
747
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800748 void ParseImageFormat(const StringPiece& option) {
749 const StringPiece substr("--image-format=");
750 DCHECK(option.starts_with(substr));
751 const StringPiece format_str = option.substr(substr.length());
752 if (format_str == "lz4") {
753 image_storage_mode_ = ImageHeader::kStorageModeLZ4;
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800754 } else if (format_str == "lz4hc") {
755 image_storage_mode_ = ImageHeader::kStorageModeLZ4HC;
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800756 } else if (format_str == "uncompressed") {
757 image_storage_mode_ = ImageHeader::kStorageModeUncompressed;
758 } else {
759 Usage("Unknown image format: %s", format_str.data());
760 }
761 }
762
Jeff Hao436183f2016-01-12 16:36:50 -0800763 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoaad75c62016-10-03 08:46:48 +0000764 compiler_options_->boot_image_ = !image_filenames_.empty();
765 compiler_options_->app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700766
767 if (IsAppImage() && IsBootImage()) {
768 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
769 }
770
Jeff Haodcdc85b2015-12-04 14:06:18 -0800771 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800772 Usage("Output must be supplied with either --oat-file or --oat-fd");
773 }
774
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000775 if (input_vdex_fd_ != -1 && !input_vdex_.empty()) {
776 Usage("Can't have both --input-vdex-fd and --input-vdex");
777 }
778
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +0100779 if (output_vdex_fd_ != -1 && !output_vdex_.empty()) {
780 Usage("Can't have both --output-vdex-fd and --output-vdex");
781 }
782
Jeff Haodcdc85b2015-12-04 14:06:18 -0800783 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800784 Usage("--oat-file should not be used with --oat-fd");
785 }
786
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000787 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +0100788 Usage("VDEX and OAT output must be specified either with one --oat-filename "
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000789 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100790 }
791
Roland Levillain9ec5e222015-08-17 20:18:41 +0100792 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800793 Usage("--oat-symbols should not be used with --oat-fd");
794 }
795
Roland Levillain9ec5e222015-08-17 20:18:41 +0100796 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800797 Usage("--oat-symbols should not be used with --host");
798 }
799
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000800 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
801 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100802 }
803
Jeff Haodcdc85b2015-12-04 14:06:18 -0800804 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800805 Usage("--oat-fd should not be used with --image");
806 }
807
Jeff Haodcdc85b2015-12-04 14:06:18 -0800808 if (!parser_options->oat_symbols.empty() &&
809 parser_options->oat_symbols.size() != oat_filenames_.size()) {
810 Usage("--oat-file arguments do not match --oat-symbols arguments");
811 }
812
813 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
814 Usage("--oat-file arguments do not match --image arguments");
815 }
816
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800817 if (android_root_.empty()) {
818 const char* android_root_env_var = getenv("ANDROID_ROOT");
819 if (android_root_env_var == nullptr) {
820 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700821 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800822 android_root_ += android_root_env_var;
823 }
824
Vladimir Markoaad75c62016-10-03 08:46:48 +0000825 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100826 parser_options->boot_image_filename += android_root_;
827 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800828 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100829 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000830 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800831 }
832
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700833 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800834 Usage("--image-classes should only be used with --image");
835 }
836
Vladimir Marko49b0f452015-12-10 13:49:19 +0000837 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800838 Usage("--image-classes should not be used with --boot-image");
839 }
840
841 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
842 Usage("--image-classes-zip should be used with --image-classes");
843 }
844
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700845 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800846 Usage("--compiled-classes should only be used with --image");
847 }
848
Vladimir Marko49b0f452015-12-10 13:49:19 +0000849 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800850 Usage("--compiled-classes should not be used with --boot-image");
851 }
852
853 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
854 Usage("--compiled-classes-zip should be used with --compiled-classes");
855 }
856
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800857 if (dex_filenames_.empty() && zip_fd_ == -1) {
858 Usage("Input must be supplied with either --dex-file or --zip-fd");
859 }
860
861 if (!dex_filenames_.empty() && zip_fd_ != -1) {
862 Usage("--dex-file should not be used with --zip-fd");
863 }
864
865 if (!dex_filenames_.empty() && !zip_location_.empty()) {
866 Usage("--dex-file should not be used with --zip-location");
867 }
868
869 if (dex_locations_.empty()) {
870 for (const char* dex_file_name : dex_filenames_) {
871 dex_locations_.push_back(dex_file_name);
872 }
873 } else if (dex_locations_.size() != dex_filenames_.size()) {
874 Usage("--dex-location arguments do not match --dex-file arguments");
875 }
876
Jeff Haodcdc85b2015-12-04 14:06:18 -0800877 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
878 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
879 Usage("--oat-file arguments must be singular or match --dex-file arguments");
880 }
881 }
882
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800883 if (zip_fd_ != -1 && zip_location_.empty()) {
884 Usage("--zip-location should be supplied with --zip-fd");
885 }
886
Vladimir Marko49b0f452015-12-10 13:49:19 +0000887 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800888 if (image_base_ == 0) {
889 Usage("Non-zero --base not specified");
890 }
891 }
892
Mathieu Chartiera8077802016-03-16 19:08:31 -0700893 const bool have_profile_file = !profile_file_.empty();
894 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
895 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000896 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200897 }
898
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -0700899 if (have_profile_file || have_profile_fd) {
900 if (compiled_classes_filename_ != nullptr ||
901 compiled_classes_zip_filename_ != nullptr ||
902 image_classes_filename_ != nullptr ||
903 image_classes_zip_filename_ != nullptr) {
904 Usage("Profile based image creation is not supported with image or compiled classes");
905 }
906 }
907
Roland Levillain9ec5e222015-08-17 20:18:41 +0100908 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800909 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800910 }
911
912 // If no instruction set feature was given, use the default one for the target
913 // instruction set.
914 if (instruction_set_features_.get() == nullptr) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800915 instruction_set_features_ = InstructionSetFeatures::FromVariant(
916 instruction_set_, "default", &parser_options->error_msg);
Ian Rogersd582fa42014-11-05 23:46:43 -0800917 if (instruction_set_features_.get() == nullptr) {
918 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100919 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800920 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800921 }
922
923 if (instruction_set_ == kRuntimeISA) {
924 std::unique_ptr<const InstructionSetFeatures> runtime_features(
925 InstructionSetFeatures::FromCppDefines());
926 if (!instruction_set_features_->Equals(runtime_features.get())) {
927 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
928 << *instruction_set_features_ << ") and those of dex2oat executable ("
929 << *runtime_features <<") for the command line:\n"
930 << CommandLine();
931 }
932 }
933
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000934 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +0000935 compiler_options_->inline_max_code_units_ = CompilerOptions::kDefaultInlineMaxCodeUnits;
Roland Levillaina215b952015-08-07 11:38:32 +0100936 }
937
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800938 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800939 // Set the compilation target's implicit checks options.
940 switch (instruction_set_) {
941 case kArm:
942 case kThumb2:
943 case kArm64:
944 case kX86:
945 case kX86_64:
Douglas Leung22bb5a22015-07-02 16:42:08 -0700946 case kMips:
947 case kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000948 compiler_options_->implicit_null_checks_ = true;
949 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800950 break;
951
952 default:
953 // Defaults are correct.
954 break;
955 }
956
Jeff Hao436183f2016-01-12 16:36:50 -0800957 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800958 Usage("--multi-image can only be used when creating boot images");
959 }
Jeff Hao436183f2016-01-12 16:36:50 -0800960 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800961 Usage("--multi-image cannot be used with multiple image names");
962 }
963
964 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
965 if (!kIsTargetBuild && IsBootImage()) {
966 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800967 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800968 }
969 }
970
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800971 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100972 if (parser_options->watch_dog_enabled) {
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800973 int64_t timeout = parser_options->watch_dog_timeout_in_ms > 0
974 ? parser_options->watch_dog_timeout_in_ms
975 : WatchDog::kDefaultWatchdogTimeoutInMS;
976 watchdog_.reset(new WatchDog(timeout));
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800977 }
978
979 // Fill some values into the key-value store for the oat header.
980 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800981
Roland Levillainb81e9e92017-04-20 17:35:32 +0100982 // Automatically force determinism for the boot image in a host build if read barriers
983 // are enabled, or if the default GC is CMS or MS. When the default GC is CMS
984 // (Concurrent Mark-Sweep), the GC is switched to a non-concurrent one by passing the
985 // option `-Xgc:nonconcurrent` (see below).
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800986 if (!kIsTargetBuild && IsBootImage()) {
987 if (SupportsDeterministicCompilation()) {
988 force_determinism_ = true;
989 } else {
990 LOG(WARNING) << "Deterministic compilation is disabled.";
991 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800992 }
993 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700994
995 if (passes_to_run_filename_ != nullptr) {
996 passes_to_run_.reset(ReadCommentedInputFromFile<std::vector<std::string>>(
997 passes_to_run_filename_,
998 nullptr)); // No post-processing.
999 if (passes_to_run_.get() == nullptr) {
1000 Usage("Failed to read list of passes to run.");
1001 }
1002 }
1003 compiler_options_->passes_to_run_ = passes_to_run_.get();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001004 }
1005
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001006 static bool SupportsDeterministicCompilation() {
Roland Levillainb81e9e92017-04-20 17:35:32 +01001007 return (kUseReadBarrier ||
1008 gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
1009 gc::kCollectorTypeDefault == gc::kCollectorTypeMS);
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001010 }
1011
Jeff Hao436183f2016-01-12 16:36:50 -08001012 void ExpandOatAndImageFilenames() {
1013 std::string base_oat = oat_filenames_[0];
1014 size_t last_oat_slash = base_oat.rfind('/');
1015 if (last_oat_slash == std::string::npos) {
1016 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
1017 }
1018 // We also need to honor path components that were encoded through '@'. Otherwise the loading
1019 // code won't be able to find the images.
1020 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
1021 last_oat_slash = base_oat.rfind('@');
1022 }
1023 base_oat = base_oat.substr(0, last_oat_slash + 1);
1024
1025 std::string base_img = image_filenames_[0];
1026 size_t last_img_slash = base_img.rfind('/');
1027 if (last_img_slash == std::string::npos) {
1028 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
1029 }
1030 // We also need to honor path components that were encoded through '@'. Otherwise the loading
1031 // code won't be able to find the images.
1032 if (base_img.find('@', last_img_slash) != std::string::npos) {
1033 last_img_slash = base_img.rfind('@');
1034 }
1035
1036 // Get the prefix, which is the primary image name (without path components). Strip the
1037 // extension.
1038 std::string prefix = base_img.substr(last_img_slash + 1);
1039 if (prefix.rfind('.') != std::string::npos) {
1040 prefix = prefix.substr(0, prefix.rfind('.'));
1041 }
1042 if (!prefix.empty()) {
1043 prefix = prefix + "-";
1044 }
1045
1046 base_img = base_img.substr(0, last_img_slash + 1);
1047
1048 // Note: we have some special case here for our testing. We have to inject the differentiating
1049 // parts for the different core images.
1050 std::string infix; // Empty infix by default.
1051 {
1052 // Check the first name.
1053 std::string dex_file = oat_filenames_[0];
1054 size_t last_dex_slash = dex_file.rfind('/');
1055 if (last_dex_slash != std::string::npos) {
1056 dex_file = dex_file.substr(last_dex_slash + 1);
1057 }
1058 size_t last_dex_dot = dex_file.rfind('.');
1059 if (last_dex_dot != std::string::npos) {
1060 dex_file = dex_file.substr(0, last_dex_dot);
1061 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001062 if (android::base::StartsWith(dex_file, "core-")) {
Jeff Hao436183f2016-01-12 16:36:50 -08001063 infix = dex_file.substr(strlen("core"));
1064 }
1065 }
1066
bowen_lai8bd36c02016-10-12 13:28:55 +08001067 std::string base_symbol_oat;
1068 if (!oat_unstripped_.empty()) {
1069 base_symbol_oat = oat_unstripped_[0];
1070 size_t last_symbol_oat_slash = base_symbol_oat.rfind('/');
1071 if (last_symbol_oat_slash == std::string::npos) {
1072 Usage("--multi-image used with unusable symbol filename %s", base_symbol_oat.c_str());
1073 }
1074 base_symbol_oat = base_symbol_oat.substr(0, last_symbol_oat_slash + 1);
1075 }
1076
1077 const size_t num_expanded_files = 2 + (base_symbol_oat.empty() ? 0 : 1);
1078 char_backing_storage_.reserve((dex_locations_.size() - 1) * num_expanded_files);
Ben Gruvera0fc3262016-09-30 13:10:42 -07001079
Jeff Hao436183f2016-01-12 16:36:50 -08001080 // Now create the other names. Use a counted loop to skip the first one.
1081 for (size_t i = 1; i < dex_locations_.size(); ++i) {
1082 // TODO: Make everything properly std::string.
1083 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
1084 char_backing_storage_.push_back(base_img + image_name);
1085 image_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
1086
1087 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
1088 char_backing_storage_.push_back(base_oat + oat_name);
1089 oat_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001090
1091 if (!base_symbol_oat.empty()) {
1092 char_backing_storage_.push_back(base_symbol_oat + oat_name);
1093 oat_unstripped_.push_back((char_backing_storage_.end() - 1)->c_str());
1094 }
Jeff Hao436183f2016-01-12 16:36:50 -08001095 }
1096 }
1097
Andreas Gampe8994a042015-12-30 19:03:17 +00001098 // Modify the input string in the following way:
1099 // 0) Assume input is /a/b/c.d
1100 // 1) Strip the path -> c.d
1101 // 2) Inject prefix p -> pc.d
1102 // 3) Inject infix i -> pci.d
1103 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -08001104 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +00001105 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001106 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +00001107 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001108 size_t last_dex_slash = in.rfind('/');
1109 if (last_dex_slash != std::string::npos) {
1110 in = in.substr(last_dex_slash + 1);
1111 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001112 if (!prefix.empty()) {
1113 in = prefix + in;
1114 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001115 if (!infix.empty()) {
1116 // Inject infix.
1117 size_t last_dot = in.rfind('.');
1118 if (last_dot != std::string::npos) {
1119 in.insert(last_dot, infix);
1120 }
1121 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001122 if (android::base::EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001123 in = in.substr(0, in.length() - strlen(".jar")) +
1124 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001125 }
1126 return in;
1127 }
1128
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001129 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001130 std::ostringstream oss;
1131 for (int i = 0; i < argc; ++i) {
1132 if (i > 0) {
1133 oss << ' ';
1134 }
1135 oss << argv[i];
1136 }
1137 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1138 oss.str(""); // Reset.
1139 oss << kRuntimeISA;
1140 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1141 key_value_store_->Put(
1142 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001143 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001144 key_value_store_->Put(
1145 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001146 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001147 key_value_store_->Put(
1148 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001149 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001150 key_value_store_->Put(OatHeader::kCompilerFilter,
1151 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Andreas Gampef8cd8902017-01-18 16:05:01 -08001152 key_value_store_->Put(OatHeader::kConcurrentCopying,
1153 kUseReadBarrier ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001154 }
1155
1156 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1157 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1158 // returns, arguments have been successfully parsed.
1159 void ParseArgs(int argc, char** argv) {
1160 original_argc = argc;
1161 original_argv = argv;
1162
Andreas Gampe51d80cc2017-06-21 21:05:13 -07001163 InitLogging(argv, Runtime::Abort);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001164
1165 // Skip over argv[0].
1166 argv++;
1167 argc--;
1168
1169 if (argc == 0) {
1170 Usage("No arguments specified");
1171 }
1172
1173 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001174 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001175
1176 for (int i = 0; i < argc; i++) {
1177 const StringPiece option(argv[i]);
1178 const bool log_options = false;
1179 if (log_options) {
1180 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1181 }
1182 if (option.starts_with("--dex-file=")) {
1183 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data());
1184 } else if (option.starts_with("--dex-location=")) {
1185 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data());
1186 } else if (option.starts_with("--zip-fd=")) {
1187 ParseZipFd(option);
1188 } else if (option.starts_with("--zip-location=")) {
1189 zip_location_ = option.substr(strlen("--zip-location=")).data();
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001190 } else if (option.starts_with("--input-vdex-fd=")) {
1191 ParseInputVdexFd(option);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001192 } else if (option.starts_with("--input-vdex=")) {
1193 input_vdex_ = option.substr(strlen("--input-vdex=")).data();
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001194 } else if (option.starts_with("--output-vdex=")) {
1195 output_vdex_ = option.substr(strlen("--output-vdex=")).data();
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001196 } else if (option.starts_with("--output-vdex-fd=")) {
1197 ParseOutputVdexFd(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001198 } else if (option.starts_with("--oat-file=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001199 oat_filenames_.push_back(option.substr(strlen("--oat-file=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001200 } else if (option.starts_with("--oat-symbols=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001201 parser_options->oat_symbols.push_back(option.substr(strlen("--oat-symbols=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001202 } else if (option.starts_with("--oat-fd=")) {
1203 ParseOatFd(option);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001204 } else if (option.starts_with("--oat-location=")) {
1205 oat_location_ = option.substr(strlen("--oat-location=")).data();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001206 } else if (option == "--watch-dog") {
1207 parser_options->watch_dog_enabled = true;
1208 } else if (option == "--no-watch-dog") {
1209 parser_options->watch_dog_enabled = false;
Andreas Gampe2e8a2562017-01-18 20:39:02 -08001210 } else if (option.starts_with("--watchdog-timeout=")) {
1211 ParseIntOption(option,
1212 "--watchdog-timeout",
1213 &parser_options->watch_dog_timeout_in_ms,
1214 Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001215 } else if (option.starts_with("-j")) {
1216 ParseJ(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001217 } else if (option.starts_with("--image=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001218 image_filenames_.push_back(option.substr(strlen("--image=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001219 } else if (option.starts_with("--image-classes=")) {
1220 image_classes_filename_ = option.substr(strlen("--image-classes=")).data();
1221 } else if (option.starts_with("--image-classes-zip=")) {
1222 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data();
Mathieu Chartierceb07b32015-12-10 09:33:21 -08001223 } else if (option.starts_with("--image-format=")) {
1224 ParseImageFormat(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001225 } else if (option.starts_with("--compiled-classes=")) {
1226 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data();
1227 } else if (option.starts_with("--compiled-classes-zip=")) {
1228 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data();
1229 } else if (option.starts_with("--compiled-methods=")) {
1230 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data();
1231 } else if (option.starts_with("--compiled-methods-zip=")) {
1232 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data();
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07001233 } else if (option.starts_with("--run-passes=")) {
1234 passes_to_run_filename_ = option.substr(strlen("--run-passes=")).data();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001235 } else if (option.starts_with("--base=")) {
1236 ParseBase(option);
1237 } else if (option.starts_with("--boot-image=")) {
1238 parser_options->boot_image_filename = option.substr(strlen("--boot-image=")).data();
1239 } else if (option.starts_with("--android-root=")) {
1240 android_root_ = option.substr(strlen("--android-root=")).data();
1241 } else if (option.starts_with("--instruction-set=")) {
1242 ParseInstructionSet(option);
1243 } else if (option.starts_with("--instruction-set-variant=")) {
1244 ParseInstructionSetVariant(option, parser_options.get());
1245 } else if (option.starts_with("--instruction-set-features=")) {
1246 ParseInstructionSetFeatures(option, parser_options.get());
1247 } else if (option.starts_with("--compiler-backend=")) {
1248 ParseCompilerBackend(option, parser_options.get());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001249 } else if (option.starts_with("--profile-file=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001250 profile_file_ = option.substr(strlen("--profile-file=")).ToString();
Calin Juravle877fd962016-01-05 14:29:29 +00001251 } else if (option.starts_with("--profile-file-fd=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001252 ParseUintOption(option, "--profile-file-fd", &profile_file_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001253 } else if (option == "--host") {
1254 is_host_ = true;
1255 } else if (option == "--runtime-arg") {
1256 if (++i >= argc) {
1257 Usage("Missing required argument for --runtime-arg");
1258 }
1259 if (log_options) {
1260 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1261 }
1262 runtime_args_.push_back(argv[i]);
1263 } else if (option == "--dump-timing") {
1264 dump_timing_ = true;
1265 } else if (option == "--dump-passes") {
1266 dump_passes_ = true;
Roland Levillain9ec5e222015-08-17 20:18:41 +01001267 } else if (option == "--dump-stats") {
1268 dump_stats_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001269 } else if (option.starts_with("--swap-file=")) {
1270 swap_file_name_ = option.substr(strlen("--swap-file=")).data();
1271 } else if (option.starts_with("--swap-fd=")) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001272 ParseUintOption(option, "--swap-fd", &swap_fd_, Usage);
Andreas Gampee1459ae2016-06-29 09:36:30 -07001273 } else if (option.starts_with("--swap-dex-size-threshold=")) {
1274 ParseUintOption(option,
1275 "--swap-dex-size-threshold",
1276 &min_dex_file_cumulative_size_for_swap_,
1277 Usage);
1278 } else if (option.starts_with("--swap-dex-count-threshold=")) {
1279 ParseUintOption(option,
1280 "--swap-dex-count-threshold",
1281 &min_dex_files_for_swap_,
1282 Usage);
Andreas Gampe67f02822016-06-24 21:05:23 -07001283 } else if (option.starts_with("--very-large-app-threshold=")) {
1284 ParseUintOption(option,
1285 "--very-large-app-threshold",
1286 &very_large_threshold_,
1287 Usage);
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001288 } else if (option.starts_with("--app-image-file=")) {
1289 app_image_file_name_ = option.substr(strlen("--app-image-file=")).data();
1290 } else if (option.starts_with("--app-image-fd=")) {
1291 ParseUintOption(option, "--app-image-fd", &app_image_fd_, Usage);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001292 } else if (option == "--multi-image") {
Jeff Hao436183f2016-01-12 16:36:50 -08001293 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001294 } else if (option.starts_with("--no-inline-from=")) {
1295 no_inline_from_string_ = option.substr(strlen("--no-inline-from=")).data();
Andreas Gampeace0dc12016-01-20 13:33:13 -08001296 } else if (option == "--force-determinism") {
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001297 if (!SupportsDeterministicCompilation()) {
Roland Levillainb81e9e92017-04-20 17:35:32 +01001298 Usage("Option --force-determinism requires read barriers or a CMS/MS garbage collector");
Roland Levillaineb2c7412016-01-28 14:37:01 +00001299 }
Andreas Gampeace0dc12016-01-20 13:33:13 -08001300 force_determinism_ = true;
Jeff Hao16d48432017-04-05 17:05:46 -07001301 } else if (option.starts_with("--classpath-dir=")) {
1302 classpath_dir_ = option.substr(strlen("--classpath-dir=")).data();
Calin Juravle1ce70852017-06-28 10:59:03 -07001303 } else if (option.starts_with("--class-loader-context=")) {
1304 class_loader_context_ = ClassLoaderContext::Create(
1305 option.substr(strlen("--class-loader-context=")).data());
1306 if (class_loader_context_== nullptr) {
1307 Usage("Option --class-loader-context has an incorrect format: %s", option.data());
1308 }
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001309 } else if (!compiler_options_->ParseCompilerOption(option, Usage)) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001310 Usage("Unknown argument %s", option.data());
1311 }
1312 }
1313
Jeff Hao436183f2016-01-12 16:36:50 -08001314 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001315
1316 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001317 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001318 }
1319
Jeff Haodcdc85b2015-12-04 14:06:18 -08001320 // Check whether the oat output files are writable, and open them for later. Also open a swap
1321 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001322 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001323 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1324 PruneNonExistentDexFiles();
1325
Jeff Hao436183f2016-01-12 16:36:50 -08001326 // Expand oat and image filenames for multi image.
1327 if (IsBootImage() && multi_image_) {
1328 ExpandOatAndImageFilenames();
1329 }
1330
David Brazdil7b49e6c2016-09-01 11:06:18 +01001331 // OAT and VDEX file handling
David Brazdil7b49e6c2016-09-01 11:06:18 +01001332 if (oat_fd_ == -1) {
1333 DCHECK(!oat_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08001334 for (const char* oat_filename : oat_filenames_) {
1335 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
1336 if (oat_file.get() == nullptr) {
1337 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1338 return false;
1339 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001340 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001341 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1342 oat_file->Erase();
1343 return false;
1344 }
1345 oat_files_.push_back(std::move(oat_file));
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001346 DCHECK_EQ(input_vdex_fd_, -1);
1347 if (!input_vdex_.empty()) {
1348 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001349 input_vdex_file_ = VdexFile::Open(input_vdex_,
1350 /* writable */ false,
1351 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001352 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001353 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001354 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001355
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001356 DCHECK_EQ(output_vdex_fd_, -1);
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001357 std::string vdex_filename = output_vdex_.empty()
1358 ? ReplaceFileExtension(oat_filename, "vdex")
1359 : output_vdex_;
1360 if (vdex_filename == input_vdex_ && output_vdex_.empty()) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001361 update_input_vdex_ = true;
1362 std::unique_ptr<File> vdex_file(OS::OpenFileReadWrite(vdex_filename.c_str()));
1363 vdex_files_.push_back(std::move(vdex_file));
1364 } else {
1365 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
1366 if (vdex_file.get() == nullptr) {
1367 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1368 return false;
1369 }
1370 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1371 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1372 vdex_file->Erase();
1373 return false;
1374 }
1375 vdex_files_.push_back(std::move(vdex_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001376 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001377 }
1378 } else {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001379 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, /* check_usage */ true));
Jeff Haodcdc85b2015-12-04 14:06:18 -08001380 if (oat_file.get() == nullptr) {
1381 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1382 return false;
1383 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001384 oat_file->DisableAutoClose();
1385 if (oat_file->SetLength(0) != 0) {
1386 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1387 }
1388 oat_files_.push_back(std::move(oat_file));
1389
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001390 if (input_vdex_fd_ != -1) {
1391 struct stat s;
1392 int rc = TEMP_FAILURE_RETRY(fstat(input_vdex_fd_, &s));
1393 if (rc == -1) {
1394 PLOG(WARNING) << "Failed getting length of vdex file";
1395 } else {
1396 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001397 input_vdex_file_ = VdexFile::Open(input_vdex_fd_,
1398 s.st_size,
1399 "vdex",
1400 /* writable */ false,
1401 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001402 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001403 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001404 // If there's any problem with the passed vdex, just warn and proceed
1405 // without it.
1406 if (input_vdex_file_ == nullptr) {
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001407 PLOG(WARNING) << "Failed opening vdex file: " << error_msg;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001408 }
1409 }
1410 }
1411
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001412 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001413 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001414 std::unique_ptr<File> vdex_file(new File(output_vdex_fd_, vdex_location, /* check_usage */ true));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001415 if (vdex_file.get() == nullptr) {
1416 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001417 return false;
1418 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001419 vdex_file->DisableAutoClose();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001420 if (input_vdex_file_ != nullptr && output_vdex_fd_ == input_vdex_fd_) {
1421 update_input_vdex_ = true;
1422 } else {
1423 if (vdex_file->SetLength(0) != 0) {
1424 PLOG(ERROR) << "Truncating vdex file " << vdex_location << " failed.";
1425 return false;
1426 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001427 }
1428 vdex_files_.push_back(std::move(vdex_file));
1429
Jeff Haodcdc85b2015-12-04 14:06:18 -08001430 oat_filenames_.push_back(oat_location_.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001431 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001432
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001433 // If we're updating in place a vdex file, be defensive and put an invalid vdex magic in case
1434 // dex2oat gets killed.
1435 // Note: we're only invalidating the magic data in the file, as dex2oat needs the rest of
1436 // the information to remain valid.
1437 if (update_input_vdex_) {
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07001438 std::unique_ptr<BufferedOutputStream> vdex_out = std::make_unique<BufferedOutputStream>(
1439 std::make_unique<FileOutputStream>(vdex_files_.back().get()));
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001440 if (!vdex_out->WriteFully(&VdexFile::Header::kVdexInvalidMagic,
1441 arraysize(VdexFile::Header::kVdexInvalidMagic))) {
1442 PLOG(ERROR) << "Failed to invalidate vdex header. File: " << vdex_out->GetLocation();
1443 return false;
1444 }
1445
1446 if (!vdex_out->Flush()) {
1447 PLOG(ERROR) << "Failed to flush stream after invalidating header of vdex file."
1448 << " File: " << vdex_out->GetLocation();
1449 return false;
1450 }
1451 }
1452
David Brazdil7b49e6c2016-09-01 11:06:18 +01001453 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001454 //
1455 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1456 // that we can use for swap.
1457 //
1458 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1459 // will immediately unlink to satisfy the swap fd assumption.
1460 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1461 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1462 if (swap_file.get() == nullptr) {
1463 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1464 return false;
1465 }
1466 swap_fd_ = swap_file->Fd();
1467 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1468 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1469 // released immediately.
1470 unlink(swap_file_name_.c_str());
1471 }
Jeff Hao436183f2016-01-12 16:36:50 -08001472
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001473 return true;
1474 }
1475
David Brazdil7b49e6c2016-09-01 11:06:18 +01001476 void EraseOutputFiles() {
1477 for (auto& files : { &vdex_files_, &oat_files_ }) {
1478 for (size_t i = 0; i < files->size(); ++i) {
1479 if ((*files)[i].get() != nullptr) {
1480 (*files)[i]->Erase();
1481 (*files)[i].reset();
1482 }
1483 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001484 }
Andreas Gampea650e702014-12-03 14:28:02 -08001485 }
1486
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001487 void Shutdown() {
1488 ScopedObjectAccess soa(Thread::Current());
1489 for (jobject dex_cache : dex_caches_) {
1490 soa.Env()->DeleteLocalRef(dex_cache);
1491 }
1492 dex_caches_.clear();
1493 }
1494
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001495 void LoadClassProfileDescriptors() {
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -07001496 if (profile_compilation_info_ != nullptr && IsImage()) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001497 Runtime* runtime = Runtime::Current();
1498 CHECK(runtime != nullptr);
Mathieu Chartier0b490842016-05-25 15:05:59 -07001499 // Filter out class path classes since we don't want to include these in the image.
Mathieu Chartier4f342b02017-07-21 17:12:39 -07001500 image_classes_.reset(
1501 new std::unordered_set<std::string>(
1502 profile_compilation_info_->GetClassDescriptors(dex_files_)));
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001503 VLOG(compiler) << "Loaded " << image_classes_->size()
1504 << " image class descriptors from profile";
1505 if (VLOG_IS_ON(compiler)) {
1506 for (const std::string& s : *image_classes_) {
1507 LOG(INFO) << "Image class " << s;
1508 }
1509 }
1510 }
1511 }
1512
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001513 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1514 // boot class path.
Andreas Gampef7882972017-03-20 16:35:24 -07001515 dex2oat::ReturnCode Setup() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001516 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001517
1518 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001519 return dex2oat::ReturnCode::kOther;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001520 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001521
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001522 // Verification results are null since we don't know if we will need them yet as the compler
1523 // filter may change.
Andreas Gampe4585f872015-03-27 23:45:15 -07001524 callbacks_.reset(new QuickCompilerCallbacks(
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001525 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001526 CompilerCallbacks::CallbackMode::kCompileBootImage :
1527 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001528
Vladimir Marko49b0f452015-12-10 13:49:19 +00001529 RuntimeArgumentMap runtime_options;
Mathieu Chartier46331a62017-07-21 09:49:10 -07001530 if (!PrepareRuntimeOptions(&runtime_options, callbacks_.get())) {
Andreas Gampef7882972017-03-20 16:35:24 -07001531 return dex2oat::ReturnCode::kOther;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001532 }
1533
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001534 CreateOatWriters();
1535 if (!AddDexFileSources()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001536 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001537 }
1538
1539 if (IsBootImage() && image_filenames_.size() > 1) {
1540 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1541 // We need this for the multi-image case.
Mathieu Chartier866d8742016-09-21 15:24:18 -07001542 key_value_store_->Put(OatHeader::kBootClassPathKey,
1543 gc::space::ImageSpace::GetMultiImageBootClassPath(dex_locations_,
1544 oat_filenames_,
1545 image_filenames_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001546 }
1547
1548 if (!IsBootImage()) {
1549 // When compiling an app, create the runtime early to retrieve
1550 // the image location key needed for the oat header.
1551 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001552 return dex2oat::ReturnCode::kCreateRuntime;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001553 }
1554
Andreas Gampe29d38e72016-03-23 15:31:51 +00001555 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001556 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1557 std::vector<gc::space::ImageSpace*> image_spaces =
1558 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Richard Uhlerbc26b722017-03-10 14:27:10 +00001559 image_file_location_oat_checksum_ = image_spaces[0]->GetImageHeader().GetOatChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001560 image_file_location_oat_data_begin_ =
1561 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1562 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1563 // Store the boot image filename(s).
1564 std::vector<std::string> image_filenames;
1565 for (const gc::space::ImageSpace* image_space : image_spaces) {
1566 image_filenames.push_back(image_space->GetImageFilename());
1567 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001568 std::string image_file_location = android::base::Join(image_filenames, ':');
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001569 if (!image_file_location.empty()) {
1570 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1571 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001572 } else {
1573 image_file_location_oat_checksum_ = 0u;
1574 image_file_location_oat_data_begin_ = 0u;
1575 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001576 }
1577
1578 // Open dex files for class path.
Calin Juravle1ce70852017-06-28 10:59:03 -07001579 if (class_loader_context_ == nullptr) {
1580 // TODO(calin): Temporary workaround while we transition to use
1581 // --class-loader-context instead of --runtime-arg -cp
1582 if (runtime_->GetClassPathString().empty()) {
1583 class_loader_context_ = std::unique_ptr<ClassLoaderContext>(
1584 new ClassLoaderContext());
1585 } else {
1586 std::string spec = runtime_->GetClassPathString() == OatFile::kSpecialSharedLibrary
1587 ? OatFile::kSpecialSharedLibrary
1588 : "PCL[" + runtime_->GetClassPathString() + "]";
1589 class_loader_context_ = ClassLoaderContext::Create(spec);
1590 }
Jeff Haof0192c82016-03-28 20:39:50 -07001591 }
Calin Juravle1ce70852017-06-28 10:59:03 -07001592 CHECK(class_loader_context_ != nullptr);
1593 DCHECK_EQ(oat_writers_.size(), 1u);
1594
1595 // Note: Ideally we would reject context where the source dex files are also
1596 // specified in the classpath (as it doesn't make sense). However this is currently
1597 // needed for non-prebuild tests and benchmarks which expects on the fly compilation.
1598 // Also, for secondary dex files we do not have control on the actual classpath.
1599 // Instead of aborting, remove all the source location from the context classpaths.
1600 if (class_loader_context_->RemoveLocationsFromClassPaths(
1601 oat_writers_[0]->GetSourceLocations())) {
1602 LOG(WARNING) << "The source files to be compiled are also in the classpath.";
1603 }
1604
1605 // We need to open the dex files before encoding the context in the oat file.
1606 // (because the encoding adds the dex checksum...)
1607 // TODO(calin): consider redesigning this so we don't have to open the dex files before
1608 // creating the actual class loader.
1609 if (!class_loader_context_->OpenDexFiles(runtime_->GetInstructionSet(), classpath_dir_)) {
1610 // Do not abort if we couldn't open files from the classpath. They might be
1611 // apks without dex files and right now are opening flow will fail them.
1612 LOG(WARNING) << "Failed to open classpath dex files";
1613 }
1614
1615 // Store the class loader context in the oat header.
1616 key_value_store_->Put(OatHeader::kClassPathKey,
1617 class_loader_context_->EncodeContextForOatFile(classpath_dir_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001618 }
1619
1620 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001621 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001622 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1623 rodata_.reserve(oat_writers_.size());
1624 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1625 rodata_.push_back(elf_writers_[i]->StartRoData());
1626 // Unzip or copy dex files straight to the oat file.
1627 std::unique_ptr<MemMap> opened_dex_files_map;
1628 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001629 // No need to verify the dex file for:
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001630 // 1) Dexlayout since it does the verification. It also may not pass the verification since
1631 // we don't update the dex checksum.
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001632 // 2) when we have a vdex file, which means it was already verified.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001633 const bool verify = !DoDexLayoutOptimizations() && (input_vdex_file_ == nullptr);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001634 if (!oat_writers_[i]->WriteAndOpenDexFiles(
1635 kIsVdexEnabled ? vdex_files_[i].get() : oat_files_[i].get(),
1636 rodata_.back(),
1637 instruction_set_,
1638 instruction_set_features_.get(),
1639 key_value_store_.get(),
Jeff Hao042e8982016-10-19 11:17:11 -07001640 verify,
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001641 update_input_vdex_,
David Brazdil7b49e6c2016-09-01 11:06:18 +01001642 &opened_dex_files_map,
1643 &opened_dex_files)) {
Andreas Gampef7882972017-03-20 16:35:24 -07001644 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001645 }
1646 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1647 if (opened_dex_files_map != nullptr) {
1648 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
1649 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001650 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001651 opened_dex_files_.push_back(std::move(dex_file));
1652 }
1653 } else {
1654 DCHECK(opened_dex_files.empty());
1655 }
1656 }
1657 }
1658
1659 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
Andreas Gampe7386da42016-06-08 18:18:47 -07001660
Mathieu Chartiere01b6f62017-07-19 16:55:04 -07001661 // If we need to downgrade the compiler-filter for size reasons.
1662 if (!IsBootImage() && IsVeryLarge(dex_files_)) {
1663 if (!CompilerFilter::IsAsGoodAs(kLargeAppFilter, compiler_options_->GetCompilerFilter())) {
1664 LOG(INFO) << "Very large app, downgrading to verify.";
1665 // Note: this change won't be reflected in the key-value store, as that had to be
1666 // finalized before loading the dex files. This setup is currently required
1667 // to get the size from the DexFile objects.
1668 // TODO: refactor. b/29790079
1669 compiler_options_->SetCompilerFilter(kLargeAppFilter);
1670 }
1671 }
1672
1673 if (CompilerFilter::IsAnyCompilationEnabled(compiler_options_->GetCompilerFilter())) {
1674 // Only modes with compilation require verification results, do this here instead of when we
1675 // create the compilation callbacks since the compilation mode may have been changed by the
1676 // very large app logic.
1677 // Avoiding setting the verification results saves RAM by not adding the dex files later in
1678 // the function.
1679 verification_results_.reset(new VerificationResults(compiler_options_.get()));
1680 callbacks_->SetVerificationResults(verification_results_.get());
1681 }
1682
Andreas Gampe7386da42016-06-08 18:18:47 -07001683 // We had to postpone the swap decision till now, as this is the point when we actually
1684 // know about the dex files we're going to use.
1685
1686 // Make sure that we didn't create the driver, yet.
1687 CHECK(driver_ == nullptr);
1688 // If we use a swap file, ensure we are above the threshold to make it necessary.
1689 if (swap_fd_ != -1) {
1690 if (!UseSwap(IsBootImage(), dex_files_)) {
1691 close(swap_fd_);
1692 swap_fd_ = -1;
1693 VLOG(compiler) << "Decided to run without swap.";
1694 } else {
1695 LOG(INFO) << "Large app, accepted running with swap.";
1696 }
1697 }
1698 // 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 +00001699 if (IsBootImage()) {
1700 // For boot image, pass opened dex files to the Runtime::Create().
1701 // Note: Runtime acquires ownership of these dex files.
1702 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001703 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001704 return dex2oat::ReturnCode::kOther;
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001705 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001706 }
1707
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001708 // If we're doing the image, override the compiler filter to force full compilation. Must be
1709 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1710 // compilation of class initializers.
1711 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001712 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001713 WellKnownClasses::Init(self->GetJniEnv());
1714
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001715 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001716 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001717 constexpr bool kSaveDexInput = false;
1718 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001719 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001720 }
Calin Juravle1ce70852017-06-28 10:59:03 -07001721 class_loader_ = class_loader_context_->CreateClassLoader(dex_files_);
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001722 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001723
1724 // Ensure opened dex files are writable for dex-to-dex transformations.
1725 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1726 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1727 PLOG(ERROR) << "Failed to make .dex files writeable.";
Andreas Gampef7882972017-03-20 16:35:24 -07001728 return dex2oat::ReturnCode::kOther;
Vladimir Marko919f5532016-01-20 19:13:01 +00001729 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001730 }
1731
1732 // Ensure that the dex caches stay live since we don't want class unloading
1733 // to occur during compilation.
1734 for (const auto& dex_file : dex_files_) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001735 ScopedObjectAccess soa(self);
1736 dex_caches_.push_back(soa.AddLocalReference<jobject>(
Mathieu Chartierf284d442016-06-02 11:48:30 -07001737 class_linker->RegisterDexFile(*dex_file,
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001738 soa.Decode<mirror::ClassLoader>(class_loader_).Ptr())));
Vladimir Markocd556b02017-02-03 11:47:34 +00001739 if (dex_caches_.back() == nullptr) {
1740 soa.Self()->AssertPendingException();
1741 soa.Self()->ClearException();
1742 PLOG(ERROR) << "Failed to register dex file.";
Andreas Gampef7882972017-03-20 16:35:24 -07001743 return dex2oat::ReturnCode::kOther;
Vladimir Markocd556b02017-02-03 11:47:34 +00001744 }
Mathieu Chartierfc2dd612016-11-21 15:05:23 -08001745 // Pre-register dex files so that we can access verification results without locks during
1746 // compilation and verification.
Mathieu Chartier0733dc82017-07-17 14:05:28 -07001747 if (verification_results_ != nullptr) {
1748 // Verification results are only required for modes that have any compilation. Avoid
1749 // adding the dex files if possible to prevent allocating large arrays.
1750 verification_results_->AddDexFile(dex_file);
1751 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001752 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001753
Andreas Gampef7882972017-03-20 16:35:24 -07001754 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001755 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001756
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001757 // If we need to keep the oat file open for the image writer.
1758 bool ShouldKeepOatFileOpen() const {
1759 return IsImage() && oat_fd_ != kInvalidFd;
1760 }
1761
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001762 // Create and invoke the compiler driver. This will compile all the dex files.
1763 void Compile() {
1764 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1765 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001766
Vladimir Marko47496c22016-01-27 16:15:08 +00001767 // Find the dex files we should not inline from.
1768
1769 std::vector<std::string> no_inline_filters;
1770 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001771
1772 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001773 const std::string core_oj = "core-oj";
1774 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1775 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001776 }
1777
Vladimir Marko47496c22016-01-27 16:15:08 +00001778 if (!no_inline_filters.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001779 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
Calin Juravle1ce70852017-06-28 10:59:03 -07001780 std::vector<const DexFile*> class_path_files;
1781 if (!IsBootImage()) {
1782 // The class loader context is used only for apps.
1783 class_path_files = class_loader_context_->FlattenOpenedDexFiles();
1784 }
1785
Jeff Haodcdc85b2015-12-04 14:06:18 -08001786 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1787 &class_linker->GetBootClassPath(),
1788 &class_path_files,
1789 &dex_files_
1790 };
1791 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001792 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001793 for (const std::string& filter : no_inline_filters) {
1794 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
Calin Juravlea308a322017-07-18 16:51:51 -07001795 // allows tests to specify <test-dexfile>!classes2.dex if needed but if the
Vladimir Marko47496c22016-01-27 16:15:08 +00001796 // base location passes the StartsWith() test, so do all extra locations.
1797 std::string dex_location = dex_file->GetLocation();
1798 if (filter.find('/') == std::string::npos) {
1799 // The filter does not contain the path. Remove the path from dex_location as well.
1800 size_t last_slash = dex_file->GetLocation().rfind('/');
1801 if (last_slash != std::string::npos) {
1802 dex_location = dex_location.substr(last_slash + 1);
1803 }
1804 }
1805
Andreas Gampe9186ced2016-12-12 14:28:21 -08001806 if (android::base::StartsWith(dex_location, filter.c_str())) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001807 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1808 no_inline_from_dex_files_.push_back(dex_file);
1809 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001810 }
1811 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001812 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001813 }
1814 if (!no_inline_from_dex_files_.empty()) {
1815 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001816 }
1817 }
1818
Vladimir Marko307dac92015-10-20 11:20:09 +01001819 driver_.reset(new CompilerDriver(compiler_options_.get(),
1820 verification_results_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001821 compiler_kind_,
1822 instruction_set_,
1823 instruction_set_features_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001824 image_classes_.release(),
1825 compiled_classes_.release(),
Wojciech Staszkiewicz62534792016-08-09 14:30:55 -07001826 compiled_methods_.release(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001827 thread_count_,
1828 dump_stats_,
1829 dump_passes_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001830 compiler_phases_timings_.get(),
1831 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001832 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001833 driver_->SetDexFilesForOatFile(dex_files_);
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001834
1835 // Setup vdex for compilation.
1836 if (!DoEagerUnquickeningOfVdex() && input_vdex_file_ != nullptr) {
1837 callbacks_->SetVerifierDeps(
1838 new verifier::VerifierDeps(dex_files_, input_vdex_file_->GetVerifierDepsData()));
1839
1840 // TODO: we unquicken unconditionally, as we don't know
1841 // if the boot image has changed. How exactly we'll know is under
1842 // experimentation.
1843 TimingLogger::ScopedTiming time_unquicken("Unquicken", timings_);
1844 VdexFile::Unquicken(dex_files_, input_vdex_file_->GetQuickeningInfo());
1845 }
1846 driver_->CompileAll(class_loader_, dex_files_, timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001847 }
1848
Jeff Hao436183f2016-01-12 16:36:50 -08001849 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001850 // ensure the references between the two are correct.
1851 //
1852 // Currently we have a memory layout that looks something like this:
1853 //
1854 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001855 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001856 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001857 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001858 // +--------------+
1859 // | alloc spaces |
1860 // +--------------+
1861 //
Jeff Hao436183f2016-01-12 16:36:50 -08001862 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001863 //
Jeff Hao436183f2016-01-12 16:36:50 -08001864 // 1. The images are expected to be loaded at an absolute address and
1865 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001866 //
Jeff Hao436183f2016-01-12 16:36:50 -08001867 // 2. There are absolute pointers from Methods in the images to their
1868 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001869 //
Jeff Hao436183f2016-01-12 16:36:50 -08001870 // 3. There are absolute pointers from the code in the oat files to Methods
1871 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001872 //
Jeff Hao436183f2016-01-12 16:36:50 -08001873 // 4. There are absolute pointers from code in the oat files to other code
1874 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001875 //
1876 // To get this all correct, we go through several steps.
1877 //
Jeff Hao436183f2016-01-12 16:36:50 -08001878 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001879 // the oat data size and code size. During this stage, we also set
1880 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001881 //
Jeff Hao436183f2016-01-12 16:36:50 -08001882 // 2. We prepare offsets for the objects in the images and calculate
1883 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001884 //
Jeff Hao436183f2016-01-12 16:36:50 -08001885 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001886 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001887 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001888 // can prepare the ELF headers and we then know the ELF memory segment
1889 // layout and we can now resolve all references. The compiler provides
1890 // LinkerPatch information in each CompiledMethod and we resolve these,
1891 // using the layout information and image object locations provided by
1892 // image writer, as we're writing the method code.
1893 //
Jeff Hao436183f2016-01-12 16:36:50 -08001894 // 4. We create the image files. They need to know where the oat files
1895 // will be loaded after itself. Originally oat files were simply
1896 // memory mapped so we could predict where their contents were based
1897 // on the file size. Now that they are ELF files, we need to inspect
1898 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001899 // where the oat header is located within.
1900 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001901 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001902 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001903 // load the .so at the desired location at runtime by offsetting the
1904 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001905 // TODO: Do this in step 3. We already know the layout there.
1906 //
1907 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1908 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001909
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001910 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1911 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001912 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1913 // case (when the file will be explicitly erased).
David Brazdil7b49e6c2016-09-01 11:06:18 +01001914 bool WriteOutputFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001915 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1916
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001917 // Sync the data to the file, in case we did dex2dex transformations.
1918 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1919 if (!map->Sync()) {
1920 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1921 return false;
1922 }
1923 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001924
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001925 if (IsImage()) {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001926 if (IsAppImage() && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001927 gc::Heap* const heap = Runtime::Current()->GetHeap();
1928 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001929 image_base_ = std::max(image_base_, RoundUp(
1930 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1931 kPageSize));
1932 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001933 // The non moving space is right after the oat file. Put the preferred app image location
1934 // right after the non moving space so that we ideally get a continuous immune region for
1935 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001936 // Use the default non moving space capacity since dex2oat does not have a separate non-
1937 // moving space. This means the runtime's non moving space space size will be as large
1938 // as the growth limit for dex2oat, but smaller in the zygote.
1939 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001940 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001941 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1942 }
1943
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001944 image_writer_.reset(new ImageWriter(*driver_,
1945 image_base_,
1946 compiler_options_->GetCompilePic(),
1947 IsAppImage(),
1948 image_storage_mode_,
1949 oat_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00001950 dex_file_oat_index_map_));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001951
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001952 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001953 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1954 if (!image_writer_->PrepareImageAddressSpace()) {
1955 LOG(ERROR) << "Failed to prepare image address space.";
1956 return false;
1957 }
1958 }
1959
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001960 // Initialize the writers with the compiler driver, image writer, and their
1961 // dex files. The writers were created without those being there yet.
1962 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1963 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
1964 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1965 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
1966 }
1967
David Brazdil5d5a36b2016-09-14 15:34:10 +01001968 {
1969 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
1970 DCHECK(IsBootImage() || oat_files_.size() == 1u);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001971 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
David Brazdil5d5a36b2016-09-14 15:34:10 +01001972 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1973 File* vdex_file = vdex_files_[i].get();
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07001974 std::unique_ptr<BufferedOutputStream> vdex_out =
1975 std::make_unique<BufferedOutputStream>(std::make_unique<FileOutputStream>(vdex_file));
David Brazdil5d5a36b2016-09-14 15:34:10 +01001976
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001977 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01001978 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
1979 return false;
1980 }
1981
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001982 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
1983 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
1984 return false;
1985 }
1986
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +00001987 // VDEX finalized, seek back to the beginning and write checksums and the header.
1988 if (!oat_writers_[i]->WriteChecksumsAndVdexHeader(vdex_out.get())) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01001989 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
1990 return false;
1991 }
1992 }
1993 }
1994
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001995 {
1996 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001997 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001998 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko944da602016-02-19 12:27:55 +00001999 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
2000 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
2001
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01002002 oat_writer->PrepareLayout(&patcher);
Vladimir Marko944da602016-02-19 12:27:55 +00002003
2004 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
David Brazdil7b49e6c2016-09-01 11:06:18 +01002005 size_t text_size = oat_writer->GetOatSize() - rodata_size;
Vladimir Markoaad75c62016-10-03 08:46:48 +00002006 elf_writer->PrepareDynamicSection(rodata_size,
2007 text_size,
2008 oat_writer->GetBssSize(),
Vladimir Marko0eb882b2017-05-15 13:39:18 +01002009 oat_writer->GetBssMethodsOffset(),
Vladimir Markoaad75c62016-10-03 08:46:48 +00002010 oat_writer->GetBssRootsOffset());
Vladimir Marko944da602016-02-19 12:27:55 +00002011
2012 if (IsImage()) {
2013 // Update oat layout.
2014 DCHECK(image_writer_ != nullptr);
2015 DCHECK_LT(i, oat_filenames_.size());
2016 image_writer_->UpdateOatFileLayout(i,
2017 elf_writer->GetLoadedSize(),
2018 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01002019 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002020 }
Richard Uhlerbc26b722017-03-10 14:27:10 +00002021
2022 if (IsBootImage()) {
2023 // Have the image_file_location_oat_checksum_ for boot oat files
2024 // depend on the contents of all the boot oat files. This way only
2025 // the primary image checksum needs to be checked to determine
2026 // whether any of the images are out of date.
2027 image_file_location_oat_checksum_ ^= oat_writer->GetOatHeader().GetChecksum();
2028 }
Vladimir Marko944da602016-02-19 12:27:55 +00002029 }
2030
2031 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002032 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002033 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
2034 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00002035
David Srbecky09c2a6b2016-03-11 17:11:44 +00002036 oat_writer->AddMethodDebugInfos(debug::MakeTrampolineInfos(oat_writer->GetOatHeader()));
2037
David Srbecky0c4572e2016-01-22 19:19:25 +00002038 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00002039 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
2040 elf_writer->PrepareDebugInfo(oat_writer->GetMethodDebugInfo());
David Srbecky0c4572e2016-01-22 19:19:25 +00002041
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002042 OutputStream*& rodata = rodata_[i];
2043 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002044 if (!oat_writer->WriteRodata(rodata)) {
2045 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
2046 return false;
2047 }
2048 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002049 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00002050
Jeff Haodcdc85b2015-12-04 14:06:18 -08002051 OutputStream* text = elf_writer->StartText();
2052 if (!oat_writer->WriteCode(text)) {
2053 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
2054 return false;
2055 }
2056 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00002057
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002058 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
2059 image_file_location_oat_checksum_,
2060 image_file_location_oat_data_begin_,
2061 image_patch_delta_)) {
2062 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
2063 return false;
2064 }
2065
Vladimir Marko944da602016-02-19 12:27:55 +00002066 if (IsImage()) {
2067 // Update oat header information.
2068 DCHECK(image_writer_ != nullptr);
2069 DCHECK_LT(i, oat_filenames_.size());
2070 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
2071 }
2072
Jeff Haodcdc85b2015-12-04 14:06:18 -08002073 elf_writer->WriteDynamicSection();
2074 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
Vladimir Marko10c13562015-11-25 14:33:36 +00002075
Jeff Haodcdc85b2015-12-04 14:06:18 -08002076 if (!elf_writer->End()) {
2077 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
2078 return false;
2079 }
2080
David Brazdil7b49e6c2016-09-01 11:06:18 +01002081 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
2082 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002083 }
2084
Jeff Haodcdc85b2015-12-04 14:06:18 -08002085 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002086
2087 oat_writer.reset();
2088 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002089 }
2090 }
2091
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002092 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002093 }
2094
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002095 // If we are compiling an image, invoke the image creation routine. Else just skip.
2096 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002097 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002098 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
2099 if (!CreateImageFile()) {
2100 return false;
2101 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002102 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07002103 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002104 return true;
2105 }
2106
Jeff Haodcdc85b2015-12-04 14:06:18 -08002107 // Create a copy from stripped to unstripped.
2108 bool CopyStrippedToUnstripped() {
2109 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
2110 // If we don't want to strip in place, copy from stripped location to unstripped location.
2111 // We need to strip after image creation because FixupElf needs to use .strtab.
2112 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
2113 // If the oat file is still open, flush it.
2114 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002115 if (!FlushCloseOutputFile(&oat_files_[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002116 return false;
2117 }
2118 }
2119
2120 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
2121 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
2122 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01002123 int64_t in_length = in->GetLength();
2124 if (in_length < 0) {
2125 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
2126 return false;
2127 }
2128 if (!out->Copy(in.get(), 0, in_length)) {
2129 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
2130 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002131 }
2132 if (out->FlushCloseOrErase() != 0) {
2133 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
2134 return false;
2135 }
2136 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
2137 }
2138 }
2139 return true;
2140 }
2141
David Brazdil7b49e6c2016-09-01 11:06:18 +01002142 bool FlushOutputFile(std::unique_ptr<File>* file) {
2143 if (file->get() != nullptr) {
2144 if (file->get()->Flush() != 0) {
2145 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
2146 return false;
2147 }
2148 }
2149 return true;
2150 }
2151
2152 bool FlushCloseOutputFile(std::unique_ptr<File>* file) {
2153 if (file->get() != nullptr) {
2154 std::unique_ptr<File> tmp(file->release());
2155 if (tmp->FlushCloseOrErase() != 0) {
2156 PLOG(ERROR) << "Failed to flush and close output file: " << tmp->GetPath();
2157 return false;
2158 }
2159 }
2160 return true;
2161 }
2162
2163 bool FlushOutputFiles() {
2164 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
2165 for (auto& files : { &vdex_files_, &oat_files_ }) {
2166 for (size_t i = 0; i < files->size(); ++i) {
2167 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002168 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08002169 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002170 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00002171 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002172 return true;
2173 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002174
David Brazdil7b49e6c2016-09-01 11:06:18 +01002175 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002176 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002177 for (auto& files : { &vdex_files_, &oat_files_ }) {
2178 for (size_t i = 0; i < files->size(); ++i) {
2179 result &= FlushCloseOutputFile(&(*files)[i]);
2180 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002181 }
2182 return result;
2183 }
2184
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002185 void DumpTiming() {
2186 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
2187 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2188 }
2189 if (dump_passes_) {
2190 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
2191 }
2192 }
2193
Andreas Gampe10e477d2014-11-19 12:57:42 -08002194 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002195 return IsAppImage() || IsBootImage();
2196 }
2197
2198 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002199 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002200 }
2201
2202 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002203 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002204 }
2205
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002206 bool IsHost() const {
2207 return is_host_;
2208 }
2209
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002210 bool UseProfile() const {
Mathieu Chartierd0af56c2017-02-17 12:56:25 -08002211 return profile_file_fd_ != -1 || !profile_file_.empty();
Calin Juravle998c2162015-12-21 15:39:33 +02002212 }
2213
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002214 bool DoProfileGuidedOptimizations() const {
Nicolas Geoffray49cda062017-04-21 13:08:25 +01002215 return UseProfile();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002216 }
2217
2218 bool DoDexLayoutOptimizations() const {
2219 return DoProfileGuidedOptimizations();
2220 }
2221
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01002222 bool DoEagerUnquickeningOfVdex() const {
2223 // DexLayout can invalidate the vdex metadata, so we need to unquicken
2224 // the vdex file eagerly, before passing it to dexlayout.
2225 return DoDexLayoutOptimizations();
2226 }
2227
Calin Juravle2e2db782016-02-23 12:00:03 +00002228 bool LoadProfile() {
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002229 DCHECK(UseProfile());
Calin Juravlee6f87cc2017-05-24 17:41:05 -07002230 // TODO(calin): We should be using the runtime arena pool (instead of the
2231 // default profile arena). However the setup logic is messy and needs
2232 // cleaning up before that (e.g. the oat writers are created before the
2233 // runtime).
Calin Juravle2e2db782016-02-23 12:00:03 +00002234 profile_compilation_info_.reset(new ProfileCompilationInfo());
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002235 ScopedFlock profile_file;
Calin Juravle2e2db782016-02-23 12:00:03 +00002236 std::string error;
2237 if (profile_file_fd_ != -1) {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002238 profile_file = LockedFile::DupOf(profile_file_fd_, "profile",
2239 true /* read_only_mode */, &error);
Andreas Gampe29d38e72016-03-23 15:31:51 +00002240 } else if (profile_file_ != "") {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002241 profile_file = LockedFile::Open(profile_file_.c_str(), O_RDONLY, true, &error);
Calin Juravle998c2162015-12-21 15:39:33 +02002242 }
Calin Juravle877fd962016-01-05 14:29:29 +00002243
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002244 // Return early if we're unable to obtain a lock on the profile.
2245 if (profile_file.get() == nullptr) {
2246 LOG(ERROR) << "Cannot lock profiles: " << error;
2247 return false;
2248 }
2249
2250 if (!profile_compilation_info_->Load(profile_file->Fd())) {
Calin Juravle2e2db782016-02-23 12:00:03 +00002251 profile_compilation_info_.reset(nullptr);
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002252 return false;
Calin Juravle2e2db782016-02-23 12:00:03 +00002253 }
Calin Juravle877fd962016-01-05 14:29:29 +00002254
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002255 return true;
Calin Juravle998c2162015-12-21 15:39:33 +02002256 }
2257
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002258 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002259 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2260 if (is_image) {
2261 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2262 return false;
2263 }
2264 if (dex_files.size() < min_dex_files_for_swap_) {
2265 // If there are less dex files than the threshold, assume it's gonna be fine.
2266 return false;
2267 }
2268 size_t dex_files_size = 0;
2269 for (const auto* dex_file : dex_files) {
2270 dex_files_size += dex_file->GetHeader().file_size_;
2271 }
2272 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2273 }
2274
Andreas Gampe67f02822016-06-24 21:05:23 -07002275 bool IsVeryLarge(std::vector<const DexFile*>& dex_files) {
2276 size_t dex_files_size = 0;
2277 for (const auto* dex_file : dex_files) {
2278 dex_files_size += dex_file->GetHeader().file_size_;
2279 }
2280 return dex_files_size >= very_large_threshold_;
2281 }
2282
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002283 std::vector<std::string> GetClassPathLocations(const std::string& class_path) {
2284 // This function is used only for apps and for an app we have exactly one oat file.
2285 DCHECK(!IsBootImage());
2286 DCHECK_EQ(oat_writers_.size(), 1u);
2287 std::vector<std::string> dex_files_canonical_locations;
Calin Juravle1ce70852017-06-28 10:59:03 -07002288 for (const std::string& location : oat_writers_[0]->GetSourceLocations()) {
2289 dex_files_canonical_locations.push_back(DexFile::GetDexCanonicalLocation(location.c_str()));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002290 }
Vladimir Marko625a64a2015-11-26 14:44:16 +00002291
Vladimir Marko919f5532016-01-20 19:13:01 +00002292 std::vector<std::string> parsed;
2293 Split(class_path, ':', &parsed);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002294 auto kept_it = std::remove_if(parsed.begin(),
2295 parsed.end(),
2296 [dex_files_canonical_locations](const std::string& location) {
2297 return ContainsElement(dex_files_canonical_locations,
2298 DexFile::GetDexCanonicalLocation(location.c_str()));
2299 });
2300 parsed.erase(kept_it, parsed.end());
2301 return parsed;
2302 }
2303
Vladimir Marko49b0f452015-12-10 13:49:19 +00002304 bool PrepareImageClasses() {
2305 // If --image-classes was specified, calculate the full list of classes to include in the image.
2306 if (image_classes_filename_ != nullptr) {
2307 image_classes_ =
2308 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2309 if (image_classes_ == nullptr) {
2310 return false;
2311 }
2312 } else if (IsBootImage()) {
2313 image_classes_.reset(new std::unordered_set<std::string>);
2314 }
2315 return true;
2316 }
2317
2318 bool PrepareCompiledClasses() {
2319 // If --compiled-classes was specified, calculate the full list of classes to compile in the
2320 // image.
2321 if (compiled_classes_filename_ != nullptr) {
2322 compiled_classes_ =
2323 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
2324 if (compiled_classes_ == nullptr) {
2325 return false;
2326 }
2327 } else {
2328 compiled_classes_.reset(nullptr); // By default compile everything.
2329 }
2330 return true;
2331 }
2332
2333 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2334 const char* classes_filename,
2335 const char* tag) {
2336 std::unique_ptr<std::unordered_set<std::string>> classes;
2337 std::string error_msg;
2338 if (zip_filename != nullptr) {
2339 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2340 } else {
2341 classes.reset(ReadImageClassesFromFile(classes_filename));
2342 }
2343 if (classes == nullptr) {
2344 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2345 << classes_filename << "': " << error_msg;
2346 }
2347 return classes;
2348 }
2349
2350 bool PrepareCompiledMethods() {
2351 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2352 if (compiled_methods_filename_ != nullptr) {
2353 std::string error_msg;
2354 if (compiled_methods_zip_filename_ != nullptr) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002355 compiled_methods_.reset(ReadCommentedInputFromZip<std::unordered_set<std::string>>(
2356 compiled_methods_zip_filename_,
2357 compiled_methods_filename_,
2358 nullptr, // No post-processing.
2359 &error_msg));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002360 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002361 compiled_methods_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2362 compiled_methods_filename_,
2363 nullptr)); // No post-processing.
Vladimir Marko49b0f452015-12-10 13:49:19 +00002364 }
2365 if (compiled_methods_.get() == nullptr) {
2366 LOG(ERROR) << "Failed to create list of compiled methods from '"
2367 << compiled_methods_filename_ << "': " << error_msg;
2368 return false;
2369 }
2370 } else {
2371 compiled_methods_.reset(nullptr); // By default compile everything.
2372 }
2373 return true;
2374 }
2375
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002376 void PruneNonExistentDexFiles() {
2377 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2378 size_t kept = 0u;
2379 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2380 if (!OS::FileExists(dex_filenames_[i])) {
2381 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2382 } else {
2383 dex_filenames_[kept] = dex_filenames_[i];
2384 dex_locations_[kept] = dex_locations_[i];
2385 ++kept;
2386 }
2387 }
2388 dex_filenames_.resize(kept);
2389 dex_locations_.resize(kept);
2390 }
2391
2392 bool AddDexFileSources() {
2393 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002394 if (input_vdex_file_ != nullptr) {
2395 DCHECK_EQ(oat_writers_.size(), 1u);
2396 const std::string& name = zip_location_.empty() ? dex_locations_[0] : zip_location_;
2397 DCHECK(!name.empty());
2398 if (!oat_writers_[0]->AddVdexDexFilesSource(*input_vdex_file_.get(), name.c_str())) {
2399 return false;
2400 }
2401 } else if (zip_fd_ != -1) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002402 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002403 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2404 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002405 return false;
2406 }
2407 } else if (oat_writers_.size() > 1u) {
2408 // Multi-image.
2409 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2410 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2411 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2412 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2413 return false;
2414 }
2415 }
2416 } else {
2417 DCHECK_EQ(oat_writers_.size(), 1u);
2418 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2419 DCHECK_NE(dex_filenames_.size(), 0u);
2420 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2421 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2422 return false;
2423 }
2424 }
2425 }
2426 return true;
2427 }
2428
2429 void CreateOatWriters() {
2430 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2431 elf_writers_.reserve(oat_files_.size());
2432 oat_writers_.reserve(oat_files_.size());
2433 for (const std::unique_ptr<File>& oat_file : oat_files_) {
David Srbecky5d811202016-03-08 13:21:22 +00002434 elf_writers_.emplace_back(CreateElfWriterQuick(instruction_set_,
2435 instruction_set_features_.get(),
2436 compiler_options_.get(),
2437 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002438 elf_writers_.back()->Start();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002439 const bool do_dexlayout = DoDexLayoutOptimizations();
Jeff Hao608f2ce2016-10-19 11:17:11 -07002440 oat_writers_.emplace_back(new OatWriter(
2441 IsBootImage(), timings_, do_dexlayout ? profile_compilation_info_.get() : nullptr));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002442 }
2443 }
2444
Vladimir Marko49b0f452015-12-10 13:49:19 +00002445 void SaveDexInput() {
2446 for (size_t i = 0; i < dex_files_.size(); ++i) {
2447 const DexFile* dex_file = dex_files_[i];
2448 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2449 getpid(), i));
2450 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2451 if (tmp_file.get() == nullptr) {
2452 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2453 << ". Try: adb shell chmod 777 /data/local/tmp";
2454 continue;
2455 }
2456 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2457 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2458 UNUSED(tmp_file->Flush());
2459 UNUSED(tmp_file->Close());
2460 LOG(INFO) << "Wrote input to " << tmp_file_name;
2461 }
2462 }
2463
Mathieu Chartier46331a62017-07-21 09:49:10 -07002464 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options,
2465 QuickCompilerCallbacks* callbacks) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00002466 RuntimeOptions raw_options;
2467 if (boot_image_filename_.empty()) {
2468 std::string boot_class_path = "-Xbootclasspath:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002469 boot_class_path += android::base::Join(dex_filenames_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002470 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2471 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002472 boot_class_path_locations += android::base::Join(dex_locations_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002473 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2474 } else {
2475 std::string boot_image_option = "-Ximage:";
2476 boot_image_option += boot_image_filename_;
2477 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2478 }
2479 for (size_t i = 0; i < runtime_args_.size(); i++) {
2480 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2481 }
2482
Mathieu Chartier46331a62017-07-21 09:49:10 -07002483 raw_options.push_back(std::make_pair("compilercallbacks", callbacks));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002484 raw_options.push_back(
2485 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2486
2487 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2488 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2489 // have been stripped in preopting, anyways).
2490 if (!IsBootImage()) {
2491 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2492 }
Andreas Gampec8e35202017-04-28 15:47:12 -07002493 // Never allow implicit image compilation.
2494 raw_options.push_back(std::make_pair("-Xnoimage-dex2oat", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002495 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2496 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2497 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002498 // Disable Hspace compaction to save heap size virtual space.
2499 // Only need disable Hspace for OOM becasue background collector is equal to
2500 // foreground collector by default for dex2oat.
2501 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002502
Andreas Gampeace0dc12016-01-20 13:33:13 -08002503 if (compiler_options_->IsForceDeterminism()) {
Roland Levillainb81e9e92017-04-20 17:35:32 +01002504 // If we're asked to be deterministic, ensure non-concurrent GC for determinism.
2505 //
2506 // Note that with read barriers, this option is ignored, because Runtime::Init
2507 // overrides the foreground GC to be gc::kCollectorTypeCC when instantiating
2508 // gc::Heap. This is fine, as concurrent GC requests are not honored in dex2oat,
2509 // which uses an unstarted runtime.
Andreas Gampeace0dc12016-01-20 13:33:13 -08002510 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
Roland Levillainb81e9e92017-04-20 17:35:32 +01002511
Nicolas Geoffray7acddd82017-05-03 15:04:55 +01002512 // The default LOS implementation (map) is not deterministic. So disable it.
2513 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=disabled", nullptr));
Andreas Gampeace0dc12016-01-20 13:33:13 -08002514
2515 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2516 // compaction (done above) and ensure that neither foreground nor background collectors
2517 // are concurrent.
Roland Levillainb81e9e92017-04-20 17:35:32 +01002518 //
2519 // Likewise, this option is ignored with read barriers because Runtime::Init
2520 // overrides the background GC to be gc::kCollectorTypeCCBackground, but that's
2521 // fine too, for the same reason (see above).
Andreas Gampeace0dc12016-01-20 13:33:13 -08002522 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2523
2524 // To make identity hashcode deterministic, set a known seed.
2525 mirror::Object::SetHashCodeSeed(987654321U);
2526 }
2527
Vladimir Marko49b0f452015-12-10 13:49:19 +00002528 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2529 LOG(ERROR) << "Failed to parse runtime options";
2530 return false;
2531 }
2532 return true;
2533 }
2534
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002535 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002536 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2537 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002538 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002539 LOG(ERROR) << "Failed to create runtime";
2540 return false;
2541 }
Andreas Gampe49c144d2016-11-14 10:11:16 -08002542
2543 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2544 // "ps -a" don't change to non-descript "main."
2545 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2546
Vladimir Marko307dac92015-10-20 11:20:09 +01002547 runtime_.reset(Runtime::Current());
2548 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe8228cdf2017-05-30 15:03:54 -07002549 for (uint32_t i = 0; i < static_cast<uint32_t>(CalleeSaveType::kLastCalleeSaveType); ++i) {
2550 CalleeSaveType type = CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002551 if (!runtime_->HasCalleeSaveMethod(type)) {
2552 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002553 }
2554 }
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002555
2556 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2557 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002558 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002559
Vladimir Marko307dac92015-10-20 11:20:09 +01002560 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002561
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002562 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2563 // Runtime::Start, give it away now so that we don't starve GC.
2564 Thread* self = Thread::Current();
2565 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002566
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002567 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002568 }
2569
Jeff Haodcdc85b2015-12-04 14:06:18 -08002570 // 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 -08002571 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002572 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002573 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002574 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002575 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002576 image_filenames_.push_back(app_image_file_name_.c_str());
2577 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002578 if (!image_writer_->Write(app_image_fd_,
2579 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002580 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002581 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002582 return false;
2583 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002584
Jeff Haodcdc85b2015-12-04 14:06:18 -08002585 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002586 dchecked_vector<uintptr_t> oat_data_begins;
2587 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2588 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002589 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002590 // Destroy ImageWriter before doing FixupElf.
2591 image_writer_.reset();
2592
Vladimir Marko944da602016-02-19 12:27:55 +00002593 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2594 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002595 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2596 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2597 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2598 if (oat_file.get() == nullptr) {
2599 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2600 return false;
2601 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002602
Vladimir Marko944da602016-02-19 12:27:55 +00002603 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002604 oat_file->Erase();
2605 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2606 return false;
2607 }
2608
2609 if (oat_file->FlushCloseOrErase()) {
2610 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2611 return false;
2612 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002613 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002614 }
2615
2616 return true;
2617 }
2618
2619 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002620 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2621 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002622 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002623 return ReadCommentedInputFromFile<std::unordered_set<std::string>>(image_classes_filename,
2624 &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002625 }
2626
2627 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002628 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002629 const char* zip_filename,
2630 const char* image_classes_filename,
2631 std::string* error_msg) {
2632 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002633 return ReadCommentedInputFromZip<std::unordered_set<std::string>>(zip_filename,
2634 image_classes_filename,
2635 &process,
2636 error_msg);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002637 }
2638
2639 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2640 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002641 template <typename T>
2642 static T* ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002643 const char* input_filename, std::function<std::string(const char*)>* process) {
2644 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2645 if (input_file.get() == nullptr) {
2646 LOG(ERROR) << "Failed to open input file " << input_filename;
2647 return nullptr;
2648 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002649 std::unique_ptr<T> result(
2650 ReadCommentedInputStream<T>(*input_file, process));
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002651 input_file->close();
2652 return result.release();
2653 }
2654
2655 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2656 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002657 template <typename T>
2658 static T* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002659 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002660 const char* input_filename,
2661 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002662 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002663 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2664 if (zip_archive.get() == nullptr) {
2665 return nullptr;
2666 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002667 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002668 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002669 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002670 zip_filename, error_msg->c_str());
2671 return nullptr;
2672 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002673 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2674 input_filename,
2675 error_msg));
2676 if (input_file.get() == nullptr) {
2677 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002678 zip_filename, error_msg->c_str());
2679 return nullptr;
2680 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002681 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2682 input_file->Size());
2683 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002684 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002685 }
2686
2687 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2688 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002689 template <typename T>
2690 static T* ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002691 std::istream& in_stream,
2692 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002693 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002694 while (in_stream.good()) {
2695 std::string dot;
2696 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08002697 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002698 continue;
2699 }
2700 if (process != nullptr) {
2701 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002702 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002703 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002704 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002705 }
2706 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002707 return output.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002708 }
2709
Mathieu Chartier49285c52014-12-02 15:43:48 -08002710 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002711 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2712 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002713 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampec560fc02014-07-16 09:57:39 -07002714 LOG(INFO) << "dex2oat took "
2715 << PrettyDuration(NanoTime() - start_ns_)
Andreas Gampecc967752016-12-12 13:49:00 -08002716 << " (" << PrettyDuration(ProcessCpuNanoTime() - start_cputime_ns_) << " cpu)"
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002717 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002718 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002719 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2720 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002721 }
2722
Jeff Haodcdc85b2015-12-04 14:06:18 -08002723 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2724 std::string res(image_filename);
2725 size_t last_slash = res.rfind('/');
2726 if (last_slash == std::string::npos || last_slash == 0) {
2727 return res;
2728 }
2729 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2730 if (penultimate_slash == std::string::npos) {
2731 return res;
2732 }
2733 // Check that the string in-between is the expected one.
2734 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2735 GetInstructionSetString(isa)) {
2736 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2737 return res;
2738 }
2739 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2740 }
2741
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002742 std::unique_ptr<CompilerOptions> compiler_options_;
2743 Compiler::Kind compiler_kind_;
2744
2745 InstructionSet instruction_set_;
2746 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2747
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002748 uint32_t image_file_location_oat_checksum_;
2749 uintptr_t image_file_location_oat_data_begin_;
2750 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002751 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2752
Vladimir Marko307dac92015-10-20 11:20:09 +01002753 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002754
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002755 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2756
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002757 std::unique_ptr<Runtime> runtime_;
2758
Calin Juravle1ce70852017-06-28 10:59:03 -07002759 // The spec describing how the class loader should be setup for compilation.
2760 std::unique_ptr<ClassLoaderContext> class_loader_context_;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002761
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002762 size_t thread_count_;
2763 uint64_t start_ns_;
Andreas Gampec560fc02014-07-16 09:57:39 -07002764 uint64_t start_cputime_ns_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002765 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002766 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002767 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002768 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002769 std::vector<const char*> oat_filenames_;
2770 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002771 int oat_fd_;
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00002772 int input_vdex_fd_;
2773 int output_vdex_fd_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002774 std::string input_vdex_;
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01002775 std::string output_vdex_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002776 std::unique_ptr<VdexFile> input_vdex_file_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002777 std::vector<const char*> dex_filenames_;
2778 std::vector<const char*> dex_locations_;
2779 int zip_fd_;
2780 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002781 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002782 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002783 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002784 uintptr_t image_base_;
2785 const char* image_classes_zip_filename_;
2786 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002787 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002788 const char* compiled_classes_zip_filename_;
2789 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002790 const char* compiled_methods_zip_filename_;
2791 const char* compiled_methods_filename_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002792 const char* passes_to_run_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002793 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2794 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002795 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002796 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Jeff Hao436183f2016-01-12 16:36:50 -08002797 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002798 bool is_host_;
2799 std::string android_root_;
Mathieu Chartier0b490842016-05-25 15:05:59 -07002800 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002801 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002802 std::string no_inline_from_string_;
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002803 std::vector<jobject> dex_caches_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002804 jobject class_loader_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002805
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002806 std::vector<std::unique_ptr<ElfWriter>> elf_writers_;
2807 std::vector<std::unique_ptr<OatWriter>> oat_writers_;
2808 std::vector<OutputStream*> rodata_;
David Brazdil5d5a36b2016-09-14 15:34:10 +01002809 std::vector<std::unique_ptr<OutputStream>> vdex_out_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002810 std::unique_ptr<ImageWriter> image_writer_;
2811 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002812
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002813 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
2814 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2815
Calin Juravle1ce70852017-06-28 10:59:03 -07002816 // Note that this might contain pointers owned by class_loader_context_.
Vladimir Marko47496c22016-01-27 16:15:08 +00002817 std::vector<const DexFile*> no_inline_from_dex_files_;
2818
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002819 bool dump_stats_;
2820 bool dump_passes_;
2821 bool dump_timing_;
2822 bool dump_slow_timing_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002823 std::string swap_file_name_;
2824 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002825 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2826 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002827 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002828 std::string app_image_file_name_;
2829 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002830 std::string profile_file_;
2831 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002832 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002833 TimingLogger* timings_;
2834 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002835 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002836 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002837
2838 // Backing storage.
2839 std::vector<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002840
Andreas Gampeace0dc12016-01-20 13:33:13 -08002841 // See CompilerOptions.force_determinism_.
2842 bool force_determinism_;
2843
Jeff Hao16d48432017-04-05 17:05:46 -07002844 // Directory of relative classpaths.
2845 std::string classpath_dir_;
2846
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00002847 // Whether the given input vdex is also the output.
2848 bool update_input_vdex_ = false;
2849
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002850 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2851};
2852
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002853static void b13564922() {
2854#if defined(__linux__) && defined(__arm__)
2855 int major, minor;
2856 struct utsname uts;
2857 if (uname(&uts) != -1 &&
2858 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2859 ((major < 3) || ((major == 3) && (minor < 4)))) {
2860 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2861 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2862 int old_personality = personality(0xffffffff);
2863 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2864 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2865 if (new_personality == -1) {
2866 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2867 }
2868 }
2869 }
2870#endif
2871}
2872
Andreas Gampe7b565912017-03-20 15:48:52 -07002873static dex2oat::ReturnCode CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002874 dex2oat.LoadClassProfileDescriptors();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002875 dex2oat.Compile();
2876
David Brazdil7b49e6c2016-09-01 11:06:18 +01002877 if (!dex2oat.WriteOutputFiles()) {
2878 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002879 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002880 }
2881
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002882 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2883 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2884 // image writer will require this fd to generate the image.
2885 if (dex2oat.ShouldKeepOatFileOpen()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002886 if (!dex2oat.FlushOutputFiles()) {
2887 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002888 return dex2oat::ReturnCode::kOther;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002889 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01002890 } else if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002891 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002892 }
2893
Jeff Haodcdc85b2015-12-04 14:06:18 -08002894 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002895 if (!dex2oat.HandleImage()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002896 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002897 }
2898
2899 // When given --host, finish early without stripping.
2900 if (dex2oat.IsHost()) {
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002901 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002902 return dex2oat::ReturnCode::kOther;
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002903 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002904 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002905 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002906 }
2907
Jeff Haodcdc85b2015-12-04 14:06:18 -08002908 // Copy stripped to unstripped location, if necessary.
2909 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002910 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002911 }
2912
Jeff Haodcdc85b2015-12-04 14:06:18 -08002913 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002914 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002915 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002916 }
2917
2918 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002919 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002920}
2921
Andreas Gampe7b565912017-03-20 15:48:52 -07002922static dex2oat::ReturnCode CompileApp(Dex2Oat& dex2oat) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002923 dex2oat.Compile();
2924
David Brazdil7b49e6c2016-09-01 11:06:18 +01002925 if (!dex2oat.WriteOutputFiles()) {
2926 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002927 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002928 }
2929
Jeff Haodcdc85b2015-12-04 14:06:18 -08002930 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002931 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002932
2933 // When given --host, finish early without stripping.
2934 if (dex2oat.IsHost()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002935 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002936 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002937 }
2938
2939 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002940 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002941 }
2942
Jeff Haodcdc85b2015-12-04 14:06:18 -08002943 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2944 // stripped versions. If this is given, we expect to be able to open writable files by name.
2945 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002946 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002947 }
2948
Jeff Haodcdc85b2015-12-04 14:06:18 -08002949 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002950 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002951 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002952 }
2953
2954 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002955 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002956}
2957
Andreas Gampe7b565912017-03-20 15:48:52 -07002958static dex2oat::ReturnCode Dex2oat(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002959 b13564922();
2960
2961 TimingLogger timings("compiler", false, false);
2962
Roland Levillain5c7e2602016-02-23 18:08:53 +00002963 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
2964 // might produce a stack frame too large for this function or for
2965 // functions inlining it (such as main), that would not fit the
2966 // requirements of the `-Wframe-larger-than` option.
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07002967 std::unique_ptr<Dex2Oat> dex2oat = std::make_unique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002968
2969 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002970 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002971
Calin Juravleb077e152016-02-18 18:47:37 +00002972 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02002973 // This operation involves I/O.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002974 if (dex2oat->UseProfile()) {
Calin Juravleb077e152016-02-18 18:47:37 +00002975 if (!dex2oat->LoadProfile()) {
2976 LOG(ERROR) << "Failed to process profile file";
Andreas Gampe7b565912017-03-20 15:48:52 -07002977 return dex2oat::ReturnCode::kOther;
Calin Juravle998c2162015-12-21 15:39:33 +02002978 }
2979 }
2980
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002981 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap, and vdex.
2982
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002983 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00002984 if (!dex2oat->OpenFile()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002985 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002986 }
2987
Andreas Gampe046c7062015-05-18 23:22:54 -07002988 // Print the complete line when any of the following is true:
2989 // 1) Debug build
2990 // 2) Compiling an image
2991 // 3) Compiling with --host
2992 // 4) Compiling on the host (not a target build)
2993 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002994 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07002995 LOG(INFO) << CommandLine();
2996 } else {
2997 LOG(INFO) << StrippedCommandLine();
2998 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002999
Andreas Gampef7882972017-03-20 16:35:24 -07003000 dex2oat::ReturnCode setup_code = dex2oat->Setup();
3001 if (setup_code != dex2oat::ReturnCode::kNoFailure) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01003002 dex2oat->EraseOutputFiles();
Andreas Gampef7882972017-03-20 16:35:24 -07003003 return setup_code;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003004 }
3005
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07003006 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
3007 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07003008 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
3009
Andreas Gampe7b565912017-03-20 15:48:52 -07003010 dex2oat::ReturnCode result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00003011 if (dex2oat->IsImage()) {
3012 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08003013 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00003014 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003015 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003016
Roland Levillain5c7e2602016-02-23 18:08:53 +00003017 dex2oat->Shutdown();
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003018 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003019}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003020} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07003021
3022int main(int argc, char** argv) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003023 int result = static_cast<int>(art::Dex2oat(argc, argv));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003024 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
3025 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
3026 // should not destruct the runtime in this case.
Evgenii Stepanov1e133742015-05-20 12:30:59 -07003027 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampee286b642017-04-13 12:20:42 -07003028 _exit(result);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003029 }
3030 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07003031}