blob: 746a9407ca9e08296a1867cdf5b331ab78772ed0 [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"
Andreas Gampe2ff3b972017-06-05 18:14:53 -070079#include "oat_file.h"
Jeff Haob11ffb72016-04-07 15:40:54 -070080#include "oat_file_assistant.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070081#include "oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070082#include "os.h"
83#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000084#include "runtime_options.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070085#include "ScopedLocalRef.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'.");
417 UsageError(" The compilation sources will be added to the classpath of the last class");
418 UsageError(" loader. This allows the compiled dex files to be loaded at runtime in");
419 UsageError(" a class loader that contains other dex files as well (e.g. shared libraries).");
420 UsageError(" ");
421 UsageError(" Note that the compiler will be tolerant if the source dex files specified");
422 UsageError(" with --dex-file are found in the classpath. The source dex files will be");
423 UsageError(" removed from any class loader's classpath possibly resulting in empty");
424 UsageError(" class loaders.");
425 UsageError(" ");
426 UsageError(" Example: --classloader-spec=PCL[lib1.dex:lib2.dex];DLC[lib3.dex]");
427 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700428 std::cerr << "See log for usage error information\n";
429 exit(EXIT_FAILURE);
430}
431
Brian Carlstrom7940e442013-07-12 13:46:57 -0700432// The primary goal of the watchdog is to prevent stuck build servers
433// during development when fatal aborts lead to a cascade of failures
434// that result in a deadlock.
435class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800436// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700437#undef CHECK_PTHREAD_CALL
438#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
439 do { \
440 int rc = call args; \
441 if (rc != 0) { \
442 errno = rc; \
443 std::string message(# call); \
444 message += " failed for "; \
445 message += reason; \
446 Fatal(message); \
447 } \
448 } while (false)
449
450 public:
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800451 explicit WatchDog(int64_t timeout_in_milliseconds)
452 : timeout_in_milliseconds_(timeout_in_milliseconds),
453 shutting_down_(false) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700454 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700455 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800456#ifndef __APPLE__
457 pthread_condattr_t condattr;
liulvping8f7101e2017-01-16 15:14:43 +0800458 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_init, (&condattr), reason);
459 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_setclock, (&condattr, CLOCK_MONOTONIC), reason);
460 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, &condattr), reason);
461 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_condattr_destroy, (&condattr), reason);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800462#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700463 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
464 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
465 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
466 }
467 ~WatchDog() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700468 const char* reason = "dex2oat watch dog thread shutdown";
469 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
470 shutting_down_ = true;
471 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
472 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
473
Kenny Root51316382014-05-13 14:59:37 -0700474 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700475
476 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
477 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
478 }
479
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800480 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
481 // large.
482 static constexpr int64_t kWatchdogVerifyMultiplier =
483 kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
484
485 // When setting timeouts, keep in mind that the build server may not be as fast as your
486 // desktop. Debug builds are slower so they have larger timeouts.
487 static constexpr int64_t kWatchdogSlowdownFactor = kIsDebugBuild ? 5U : 1U;
488
489 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
490 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
491 // itself before that watchdog would take down the system server.
492 static constexpr int64_t kWatchDogTimeoutSeconds = kWatchdogSlowdownFactor * (9 * 60 + 30);
493
494 static constexpr int64_t kDefaultWatchdogTimeoutInMS =
495 kWatchdogVerifyMultiplier * kWatchDogTimeoutSeconds * 1000;
496
Brian Carlstrom7940e442013-07-12 13:46:57 -0700497 private:
498 static void* CallBack(void* arg) {
499 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
500 ::art::SetThreadName("dex2oat watch dog");
501 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700502 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700503 }
504
Andreas Gampe794ad762015-02-23 08:12:24 -0800505 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700506 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
507 // it's rather easy to hang in unwinding.
508 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
509 // logcat logging or stderr output.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700510 android::base::LogMessage::LogLine(__FILE__,
511 __LINE__,
512 android::base::LogId::DEFAULT,
513 LogSeverity::FATAL,
514 message.c_str());
Andreas Gampe48fde372017-06-06 07:43:46 -0700515 // If we're on the host, try to dump all threads to get a sense of what's going on. This is
516 // restricted to the host as the dump may itself go bad.
517 // TODO: Use a double watchdog timeout, so we can enable this on-device.
518 if (!kIsTargetBuild && Runtime::Current() != nullptr) {
Andreas Gampecd607312017-06-05 17:03:05 -0700519 Runtime::Current()->AttachCurrentThread("Watchdog thread attached for dumping",
520 true,
521 nullptr,
522 false);
523 Runtime::Current()->DumpForSigQuit(std::cerr);
524 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700525 exit(1);
526 }
527
528 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700529 timespec timeout_ts;
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800530#if defined(__APPLE__)
531 InitTimeSpec(true, CLOCK_REALTIME, timeout_in_milliseconds_, 0, &timeout_ts);
532#else
liulvping8f7101e2017-01-16 15:14:43 +0800533 InitTimeSpec(true, CLOCK_MONOTONIC, timeout_in_milliseconds_, 0, &timeout_ts);
Mathieu Chartierdbf44402017-02-22 16:07:23 -0800534#endif
Brian Carlstrom7940e442013-07-12 13:46:57 -0700535 const char* reason = "dex2oat watch dog thread waiting";
536 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
537 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800538 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700539 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700540 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800541 timeout_in_milliseconds_/1000));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700542 } else if (rc != 0) {
543 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
544 strerror(errno)));
545 Fatal(message.c_str());
546 }
547 }
548 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
549 }
550
Brian Carlstrom7940e442013-07-12 13:46:57 -0700551 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
552 pthread_mutex_t mutex_;
553 pthread_cond_t cond_;
554 pthread_attr_t attr_;
555 pthread_t pthread_;
Andreas Gampef45d61c2017-06-07 10:29:33 -0700556
557 const int64_t timeout_in_milliseconds_;
558 bool shutting_down_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700559};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700560
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800561class Dex2Oat FINAL {
562 public:
563 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100564 compiler_kind_(Compiler::kOptimizing),
Artem Serovba6b6792016-08-15 14:22:07 +0100565 instruction_set_(kRuntimeISA == kArm ? kThumb2 : kRuntimeISA),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800566 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000567 image_file_location_oat_checksum_(0),
568 image_file_location_oat_data_begin_(0),
569 image_patch_delta_(0),
570 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700571 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800572 runtime_(nullptr),
573 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
574 start_ns_(NanoTime()),
Andreas Gampec560fc02014-07-16 09:57:39 -0700575 start_cputime_ns_(ProcessCpuNanoTime()),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800576 oat_fd_(-1),
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000577 input_vdex_fd_(-1),
578 output_vdex_fd_(-1),
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000579 input_vdex_file_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800580 zip_fd_(-1),
581 image_base_(0U),
582 image_classes_zip_filename_(nullptr),
583 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800584 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800585 compiled_classes_zip_filename_(nullptr),
586 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700587 compiled_methods_zip_filename_(nullptr),
588 compiled_methods_filename_(nullptr),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700589 passes_to_run_filename_(nullptr),
Jeff Hao436183f2016-01-12 16:36:50 -0800590 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800591 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000592 class_loader_(nullptr),
593 elf_writers_(),
594 oat_writers_(),
595 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000596 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700597 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000598 opened_dex_files_maps_(),
599 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000600 no_inline_from_dex_files_(),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800601 dump_stats_(false),
602 dump_passes_(false),
603 dump_timing_(false),
604 dump_slow_timing_(kIsDebugBuild),
Calin Juravle2e2db782016-02-23 12:00:03 +0000605 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800606 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000607 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800608 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000609 force_determinism_(false)
610 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800611
612 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800613 // Log completion time before deleting the runtime_, because this accesses
614 // the runtime.
615 LogCompletionTime();
616
Vladimir Marko307dac92015-10-20 11:20:09 +0100617 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
618 // We want to just exit on non-debug builds, not bringing the runtime down
619 // in an orderly fashion. So release the following fields.
620 driver_.release();
621 image_writer_.release();
622 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
623 dex_file.release();
624 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000625 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
626 map.release();
627 }
David Brazdil7b49e6c2016-09-01 11:06:18 +0100628 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
629 vdex_file.release();
630 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800631 for (std::unique_ptr<File>& oat_file : oat_files_) {
632 oat_file.release();
633 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100634 runtime_.release();
635 verification_results_.release();
636 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100637 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700638 }
639
Roland Levillain9ec5e222015-08-17 20:18:41 +0100640 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800641 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800642 std::string boot_image_filename;
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800643 int64_t watch_dog_timeout_in_ms = -1;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800644 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000645 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800646 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100647 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800648
Roland Levillain9ec5e222015-08-17 20:18:41 +0100649 void ParseZipFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000650 ParseUintOption(option, "--zip-fd", &zip_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100651 }
652
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000653 void ParseInputVdexFd(const StringPiece& option) {
654 // Note that the input vdex fd might be -1.
655 ParseIntOption(option, "--input-vdex-fd", &input_vdex_fd_, Usage);
656 }
657
658 void ParseOutputVdexFd(const StringPiece& option) {
659 ParseUintOption(option, "--output-vdex-fd", &output_vdex_fd_, Usage);
David Brazdil7b49e6c2016-09-01 11:06:18 +0100660 }
661
Roland Levillain9ec5e222015-08-17 20:18:41 +0100662 void ParseOatFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000663 ParseUintOption(option, "--oat-fd", &oat_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100664 }
665
Calin Juravle877fd962016-01-05 14:29:29 +0000666 void ParseFdForCollection(const StringPiece& option,
667 const char* arg_name,
668 std::vector<uint32_t>* fds) {
669 uint32_t fd;
670 ParseUintOption(option, arg_name, &fd, Usage);
671 fds->push_back(fd);
672 }
673
Roland Levillain9ec5e222015-08-17 20:18:41 +0100674 void ParseJ(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000675 ParseUintOption(option, "-j", &thread_count_, Usage, /* is_long_option */ false);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100676 }
677
678 void ParseBase(const StringPiece& option) {
679 DCHECK(option.starts_with("--base="));
680 const char* image_base_str = option.substr(strlen("--base=")).data();
681 char* end;
682 image_base_ = strtoul(image_base_str, &end, 16);
683 if (end == image_base_str || *end != '\0') {
684 Usage("Failed to parse hexadecimal value for option %s", option.data());
685 }
686 }
687
688 void ParseInstructionSet(const StringPiece& option) {
689 DCHECK(option.starts_with("--instruction-set="));
690 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
691 // StringPiece is not necessarily zero-terminated, so need to make a copy and ensure it.
692 std::unique_ptr<char[]> buf(new char[instruction_set_str.length() + 1]);
693 strncpy(buf.get(), instruction_set_str.data(), instruction_set_str.length());
694 buf.get()[instruction_set_str.length()] = 0;
695 instruction_set_ = GetInstructionSetFromString(buf.get());
696 // arm actually means thumb2.
697 if (instruction_set_ == InstructionSet::kArm) {
698 instruction_set_ = InstructionSet::kThumb2;
699 }
700 }
701
702 void ParseInstructionSetVariant(const StringPiece& option, ParserOptions* parser_options) {
703 DCHECK(option.starts_with("--instruction-set-variant="));
704 StringPiece str = option.substr(strlen("--instruction-set-variant=")).data();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800705 instruction_set_features_ = InstructionSetFeatures::FromVariant(
706 instruction_set_, str.as_string(), &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100707 if (instruction_set_features_.get() == nullptr) {
708 Usage("%s", parser_options->error_msg.c_str());
709 }
710 }
711
712 void ParseInstructionSetFeatures(const StringPiece& option, ParserOptions* parser_options) {
713 DCHECK(option.starts_with("--instruction-set-features="));
714 StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800715 if (instruction_set_features_ == nullptr) {
716 instruction_set_features_ = InstructionSetFeatures::FromVariant(
717 instruction_set_, "default", &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100718 if (instruction_set_features_.get() == nullptr) {
719 Usage("Problem initializing default instruction set features variant: %s",
720 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700721 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800722 }
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800723 instruction_set_features_ =
Roland Levillain9ec5e222015-08-17 20:18:41 +0100724 instruction_set_features_->AddFeaturesFromString(str.as_string(),
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800725 &parser_options->error_msg);
726 if (instruction_set_features_ == nullptr) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100727 Usage("Error parsing '%s': %s", option.data(), parser_options->error_msg.c_str());
728 }
729 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800730
Roland Levillain9ec5e222015-08-17 20:18:41 +0100731 void ParseCompilerBackend(const StringPiece& option, ParserOptions* parser_options) {
732 DCHECK(option.starts_with("--compiler-backend="));
733 parser_options->requested_specific_compiler = true;
734 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
735 if (backend_str == "Quick") {
736 compiler_kind_ = Compiler::kQuick;
737 } else if (backend_str == "Optimizing") {
738 compiler_kind_ = Compiler::kOptimizing;
739 } else {
740 Usage("Unknown compiler backend: %s", backend_str.data());
741 }
742 }
743
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800744 void ParseImageFormat(const StringPiece& option) {
745 const StringPiece substr("--image-format=");
746 DCHECK(option.starts_with(substr));
747 const StringPiece format_str = option.substr(substr.length());
748 if (format_str == "lz4") {
749 image_storage_mode_ = ImageHeader::kStorageModeLZ4;
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800750 } else if (format_str == "lz4hc") {
751 image_storage_mode_ = ImageHeader::kStorageModeLZ4HC;
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800752 } else if (format_str == "uncompressed") {
753 image_storage_mode_ = ImageHeader::kStorageModeUncompressed;
754 } else {
755 Usage("Unknown image format: %s", format_str.data());
756 }
757 }
758
Jeff Hao436183f2016-01-12 16:36:50 -0800759 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoaad75c62016-10-03 08:46:48 +0000760 compiler_options_->boot_image_ = !image_filenames_.empty();
761 compiler_options_->app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700762
763 if (IsAppImage() && IsBootImage()) {
764 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
765 }
766
Jeff Haodcdc85b2015-12-04 14:06:18 -0800767 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800768 Usage("Output must be supplied with either --oat-file or --oat-fd");
769 }
770
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000771 if (input_vdex_fd_ != -1 && !input_vdex_.empty()) {
772 Usage("Can't have both --input-vdex-fd and --input-vdex");
773 }
774
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +0100775 if (output_vdex_fd_ != -1 && !output_vdex_.empty()) {
776 Usage("Can't have both --output-vdex-fd and --output-vdex");
777 }
778
Jeff Haodcdc85b2015-12-04 14:06:18 -0800779 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800780 Usage("--oat-file should not be used with --oat-fd");
781 }
782
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000783 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +0100784 Usage("VDEX and OAT output must be specified either with one --oat-filename "
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000785 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100786 }
787
Roland Levillain9ec5e222015-08-17 20:18:41 +0100788 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800789 Usage("--oat-symbols should not be used with --oat-fd");
790 }
791
Roland Levillain9ec5e222015-08-17 20:18:41 +0100792 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800793 Usage("--oat-symbols should not be used with --host");
794 }
795
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000796 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
797 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100798 }
799
Jeff Haodcdc85b2015-12-04 14:06:18 -0800800 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800801 Usage("--oat-fd should not be used with --image");
802 }
803
Jeff Haodcdc85b2015-12-04 14:06:18 -0800804 if (!parser_options->oat_symbols.empty() &&
805 parser_options->oat_symbols.size() != oat_filenames_.size()) {
806 Usage("--oat-file arguments do not match --oat-symbols arguments");
807 }
808
809 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
810 Usage("--oat-file arguments do not match --image arguments");
811 }
812
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800813 if (android_root_.empty()) {
814 const char* android_root_env_var = getenv("ANDROID_ROOT");
815 if (android_root_env_var == nullptr) {
816 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700817 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800818 android_root_ += android_root_env_var;
819 }
820
Vladimir Markoaad75c62016-10-03 08:46:48 +0000821 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100822 parser_options->boot_image_filename += android_root_;
823 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800824 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100825 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000826 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800827 }
828
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700829 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800830 Usage("--image-classes should only be used with --image");
831 }
832
Vladimir Marko49b0f452015-12-10 13:49:19 +0000833 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800834 Usage("--image-classes should not be used with --boot-image");
835 }
836
837 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
838 Usage("--image-classes-zip should be used with --image-classes");
839 }
840
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700841 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800842 Usage("--compiled-classes should only be used with --image");
843 }
844
Vladimir Marko49b0f452015-12-10 13:49:19 +0000845 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800846 Usage("--compiled-classes should not be used with --boot-image");
847 }
848
849 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
850 Usage("--compiled-classes-zip should be used with --compiled-classes");
851 }
852
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800853 if (dex_filenames_.empty() && zip_fd_ == -1) {
854 Usage("Input must be supplied with either --dex-file or --zip-fd");
855 }
856
857 if (!dex_filenames_.empty() && zip_fd_ != -1) {
858 Usage("--dex-file should not be used with --zip-fd");
859 }
860
861 if (!dex_filenames_.empty() && !zip_location_.empty()) {
862 Usage("--dex-file should not be used with --zip-location");
863 }
864
865 if (dex_locations_.empty()) {
866 for (const char* dex_file_name : dex_filenames_) {
867 dex_locations_.push_back(dex_file_name);
868 }
869 } else if (dex_locations_.size() != dex_filenames_.size()) {
870 Usage("--dex-location arguments do not match --dex-file arguments");
871 }
872
Jeff Haodcdc85b2015-12-04 14:06:18 -0800873 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
874 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
875 Usage("--oat-file arguments must be singular or match --dex-file arguments");
876 }
877 }
878
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800879 if (zip_fd_ != -1 && zip_location_.empty()) {
880 Usage("--zip-location should be supplied with --zip-fd");
881 }
882
Vladimir Marko49b0f452015-12-10 13:49:19 +0000883 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800884 if (image_base_ == 0) {
885 Usage("Non-zero --base not specified");
886 }
887 }
888
Mathieu Chartiera8077802016-03-16 19:08:31 -0700889 const bool have_profile_file = !profile_file_.empty();
890 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
891 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000892 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200893 }
894
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -0700895 if (have_profile_file || have_profile_fd) {
896 if (compiled_classes_filename_ != nullptr ||
897 compiled_classes_zip_filename_ != nullptr ||
898 image_classes_filename_ != nullptr ||
899 image_classes_zip_filename_ != nullptr) {
900 Usage("Profile based image creation is not supported with image or compiled classes");
901 }
902 }
903
Roland Levillain9ec5e222015-08-17 20:18:41 +0100904 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800905 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800906 }
907
908 // If no instruction set feature was given, use the default one for the target
909 // instruction set.
910 if (instruction_set_features_.get() == nullptr) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800911 instruction_set_features_ = InstructionSetFeatures::FromVariant(
912 instruction_set_, "default", &parser_options->error_msg);
Ian Rogersd582fa42014-11-05 23:46:43 -0800913 if (instruction_set_features_.get() == nullptr) {
914 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100915 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800916 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800917 }
918
919 if (instruction_set_ == kRuntimeISA) {
920 std::unique_ptr<const InstructionSetFeatures> runtime_features(
921 InstructionSetFeatures::FromCppDefines());
922 if (!instruction_set_features_->Equals(runtime_features.get())) {
923 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
924 << *instruction_set_features_ << ") and those of dex2oat executable ("
925 << *runtime_features <<") for the command line:\n"
926 << CommandLine();
927 }
928 }
929
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000930 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
Nicolas Geoffrayf6d46682017-02-28 17:41:45 +0000931 compiler_options_->inline_max_code_units_ = CompilerOptions::kDefaultInlineMaxCodeUnits;
Roland Levillaina215b952015-08-07 11:38:32 +0100932 }
933
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800934 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800935 // Set the compilation target's implicit checks options.
936 switch (instruction_set_) {
937 case kArm:
938 case kThumb2:
939 case kArm64:
940 case kX86:
941 case kX86_64:
Douglas Leung22bb5a22015-07-02 16:42:08 -0700942 case kMips:
943 case kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000944 compiler_options_->implicit_null_checks_ = true;
945 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800946 break;
947
948 default:
949 // Defaults are correct.
950 break;
951 }
952
Jeff Hao436183f2016-01-12 16:36:50 -0800953 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800954 Usage("--multi-image can only be used when creating boot images");
955 }
Jeff Hao436183f2016-01-12 16:36:50 -0800956 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800957 Usage("--multi-image cannot be used with multiple image names");
958 }
959
960 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
961 if (!kIsTargetBuild && IsBootImage()) {
962 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800963 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800964 }
965 }
966
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800967 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100968 if (parser_options->watch_dog_enabled) {
Andreas Gampe2e8a2562017-01-18 20:39:02 -0800969 int64_t timeout = parser_options->watch_dog_timeout_in_ms > 0
970 ? parser_options->watch_dog_timeout_in_ms
971 : WatchDog::kDefaultWatchdogTimeoutInMS;
972 watchdog_.reset(new WatchDog(timeout));
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800973 }
974
975 // Fill some values into the key-value store for the oat header.
976 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800977
Roland Levillainb81e9e92017-04-20 17:35:32 +0100978 // Automatically force determinism for the boot image in a host build if read barriers
979 // are enabled, or if the default GC is CMS or MS. When the default GC is CMS
980 // (Concurrent Mark-Sweep), the GC is switched to a non-concurrent one by passing the
981 // option `-Xgc:nonconcurrent` (see below).
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800982 if (!kIsTargetBuild && IsBootImage()) {
983 if (SupportsDeterministicCompilation()) {
984 force_determinism_ = true;
985 } else {
986 LOG(WARNING) << "Deterministic compilation is disabled.";
987 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800988 }
989 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700990
991 if (passes_to_run_filename_ != nullptr) {
992 passes_to_run_.reset(ReadCommentedInputFromFile<std::vector<std::string>>(
993 passes_to_run_filename_,
994 nullptr)); // No post-processing.
995 if (passes_to_run_.get() == nullptr) {
996 Usage("Failed to read list of passes to run.");
997 }
998 }
999 compiler_options_->passes_to_run_ = passes_to_run_.get();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001000 }
1001
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001002 static bool SupportsDeterministicCompilation() {
Roland Levillainb81e9e92017-04-20 17:35:32 +01001003 return (kUseReadBarrier ||
1004 gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
1005 gc::kCollectorTypeDefault == gc::kCollectorTypeMS);
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001006 }
1007
Jeff Hao436183f2016-01-12 16:36:50 -08001008 void ExpandOatAndImageFilenames() {
1009 std::string base_oat = oat_filenames_[0];
1010 size_t last_oat_slash = base_oat.rfind('/');
1011 if (last_oat_slash == std::string::npos) {
1012 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
1013 }
1014 // We also need to honor path components that were encoded through '@'. Otherwise the loading
1015 // code won't be able to find the images.
1016 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
1017 last_oat_slash = base_oat.rfind('@');
1018 }
1019 base_oat = base_oat.substr(0, last_oat_slash + 1);
1020
1021 std::string base_img = image_filenames_[0];
1022 size_t last_img_slash = base_img.rfind('/');
1023 if (last_img_slash == std::string::npos) {
1024 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
1025 }
1026 // We also need to honor path components that were encoded through '@'. Otherwise the loading
1027 // code won't be able to find the images.
1028 if (base_img.find('@', last_img_slash) != std::string::npos) {
1029 last_img_slash = base_img.rfind('@');
1030 }
1031
1032 // Get the prefix, which is the primary image name (without path components). Strip the
1033 // extension.
1034 std::string prefix = base_img.substr(last_img_slash + 1);
1035 if (prefix.rfind('.') != std::string::npos) {
1036 prefix = prefix.substr(0, prefix.rfind('.'));
1037 }
1038 if (!prefix.empty()) {
1039 prefix = prefix + "-";
1040 }
1041
1042 base_img = base_img.substr(0, last_img_slash + 1);
1043
1044 // Note: we have some special case here for our testing. We have to inject the differentiating
1045 // parts for the different core images.
1046 std::string infix; // Empty infix by default.
1047 {
1048 // Check the first name.
1049 std::string dex_file = oat_filenames_[0];
1050 size_t last_dex_slash = dex_file.rfind('/');
1051 if (last_dex_slash != std::string::npos) {
1052 dex_file = dex_file.substr(last_dex_slash + 1);
1053 }
1054 size_t last_dex_dot = dex_file.rfind('.');
1055 if (last_dex_dot != std::string::npos) {
1056 dex_file = dex_file.substr(0, last_dex_dot);
1057 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001058 if (android::base::StartsWith(dex_file, "core-")) {
Jeff Hao436183f2016-01-12 16:36:50 -08001059 infix = dex_file.substr(strlen("core"));
1060 }
1061 }
1062
bowen_lai8bd36c02016-10-12 13:28:55 +08001063 std::string base_symbol_oat;
1064 if (!oat_unstripped_.empty()) {
1065 base_symbol_oat = oat_unstripped_[0];
1066 size_t last_symbol_oat_slash = base_symbol_oat.rfind('/');
1067 if (last_symbol_oat_slash == std::string::npos) {
1068 Usage("--multi-image used with unusable symbol filename %s", base_symbol_oat.c_str());
1069 }
1070 base_symbol_oat = base_symbol_oat.substr(0, last_symbol_oat_slash + 1);
1071 }
1072
1073 const size_t num_expanded_files = 2 + (base_symbol_oat.empty() ? 0 : 1);
1074 char_backing_storage_.reserve((dex_locations_.size() - 1) * num_expanded_files);
Ben Gruvera0fc3262016-09-30 13:10:42 -07001075
Jeff Hao436183f2016-01-12 16:36:50 -08001076 // Now create the other names. Use a counted loop to skip the first one.
1077 for (size_t i = 1; i < dex_locations_.size(); ++i) {
1078 // TODO: Make everything properly std::string.
1079 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
1080 char_backing_storage_.push_back(base_img + image_name);
1081 image_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
1082
1083 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
1084 char_backing_storage_.push_back(base_oat + oat_name);
1085 oat_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001086
1087 if (!base_symbol_oat.empty()) {
1088 char_backing_storage_.push_back(base_symbol_oat + oat_name);
1089 oat_unstripped_.push_back((char_backing_storage_.end() - 1)->c_str());
1090 }
Jeff Hao436183f2016-01-12 16:36:50 -08001091 }
1092 }
1093
Andreas Gampe8994a042015-12-30 19:03:17 +00001094 // Modify the input string in the following way:
1095 // 0) Assume input is /a/b/c.d
1096 // 1) Strip the path -> c.d
1097 // 2) Inject prefix p -> pc.d
1098 // 3) Inject infix i -> pci.d
1099 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -08001100 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +00001101 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001102 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +00001103 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001104 size_t last_dex_slash = in.rfind('/');
1105 if (last_dex_slash != std::string::npos) {
1106 in = in.substr(last_dex_slash + 1);
1107 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001108 if (!prefix.empty()) {
1109 in = prefix + in;
1110 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001111 if (!infix.empty()) {
1112 // Inject infix.
1113 size_t last_dot = in.rfind('.');
1114 if (last_dot != std::string::npos) {
1115 in.insert(last_dot, infix);
1116 }
1117 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001118 if (android::base::EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001119 in = in.substr(0, in.length() - strlen(".jar")) +
1120 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001121 }
1122 return in;
1123 }
1124
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001125 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001126 std::ostringstream oss;
1127 for (int i = 0; i < argc; ++i) {
1128 if (i > 0) {
1129 oss << ' ';
1130 }
1131 oss << argv[i];
1132 }
1133 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1134 oss.str(""); // Reset.
1135 oss << kRuntimeISA;
1136 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1137 key_value_store_->Put(
1138 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001139 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001140 key_value_store_->Put(
1141 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001142 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001143 key_value_store_->Put(
1144 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001145 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001146 key_value_store_->Put(OatHeader::kCompilerFilter,
1147 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Andreas Gampef8cd8902017-01-18 16:05:01 -08001148 key_value_store_->Put(OatHeader::kConcurrentCopying,
1149 kUseReadBarrier ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001150 }
1151
1152 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1153 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1154 // returns, arguments have been successfully parsed.
1155 void ParseArgs(int argc, char** argv) {
1156 original_argc = argc;
1157 original_argv = argv;
1158
Andreas Gampe51d80cc2017-06-21 21:05:13 -07001159 InitLogging(argv, Runtime::Abort);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001160
1161 // Skip over argv[0].
1162 argv++;
1163 argc--;
1164
1165 if (argc == 0) {
1166 Usage("No arguments specified");
1167 }
1168
1169 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001170 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001171
1172 for (int i = 0; i < argc; i++) {
1173 const StringPiece option(argv[i]);
1174 const bool log_options = false;
1175 if (log_options) {
1176 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1177 }
1178 if (option.starts_with("--dex-file=")) {
1179 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data());
1180 } else if (option.starts_with("--dex-location=")) {
1181 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data());
1182 } else if (option.starts_with("--zip-fd=")) {
1183 ParseZipFd(option);
1184 } else if (option.starts_with("--zip-location=")) {
1185 zip_location_ = option.substr(strlen("--zip-location=")).data();
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001186 } else if (option.starts_with("--input-vdex-fd=")) {
1187 ParseInputVdexFd(option);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001188 } else if (option.starts_with("--input-vdex=")) {
1189 input_vdex_ = option.substr(strlen("--input-vdex=")).data();
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001190 } else if (option.starts_with("--output-vdex=")) {
1191 output_vdex_ = option.substr(strlen("--output-vdex=")).data();
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001192 } else if (option.starts_with("--output-vdex-fd=")) {
1193 ParseOutputVdexFd(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001194 } else if (option.starts_with("--oat-file=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001195 oat_filenames_.push_back(option.substr(strlen("--oat-file=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001196 } else if (option.starts_with("--oat-symbols=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001197 parser_options->oat_symbols.push_back(option.substr(strlen("--oat-symbols=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001198 } else if (option.starts_with("--oat-fd=")) {
1199 ParseOatFd(option);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001200 } else if (option.starts_with("--oat-location=")) {
1201 oat_location_ = option.substr(strlen("--oat-location=")).data();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001202 } else if (option == "--watch-dog") {
1203 parser_options->watch_dog_enabled = true;
1204 } else if (option == "--no-watch-dog") {
1205 parser_options->watch_dog_enabled = false;
Andreas Gampe2e8a2562017-01-18 20:39:02 -08001206 } else if (option.starts_with("--watchdog-timeout=")) {
1207 ParseIntOption(option,
1208 "--watchdog-timeout",
1209 &parser_options->watch_dog_timeout_in_ms,
1210 Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001211 } else if (option.starts_with("-j")) {
1212 ParseJ(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001213 } else if (option.starts_with("--image=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001214 image_filenames_.push_back(option.substr(strlen("--image=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001215 } else if (option.starts_with("--image-classes=")) {
1216 image_classes_filename_ = option.substr(strlen("--image-classes=")).data();
1217 } else if (option.starts_with("--image-classes-zip=")) {
1218 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data();
Mathieu Chartierceb07b32015-12-10 09:33:21 -08001219 } else if (option.starts_with("--image-format=")) {
1220 ParseImageFormat(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001221 } else if (option.starts_with("--compiled-classes=")) {
1222 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data();
1223 } else if (option.starts_with("--compiled-classes-zip=")) {
1224 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data();
1225 } else if (option.starts_with("--compiled-methods=")) {
1226 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data();
1227 } else if (option.starts_with("--compiled-methods-zip=")) {
1228 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data();
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07001229 } else if (option.starts_with("--run-passes=")) {
1230 passes_to_run_filename_ = option.substr(strlen("--run-passes=")).data();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001231 } else if (option.starts_with("--base=")) {
1232 ParseBase(option);
1233 } else if (option.starts_with("--boot-image=")) {
1234 parser_options->boot_image_filename = option.substr(strlen("--boot-image=")).data();
1235 } else if (option.starts_with("--android-root=")) {
1236 android_root_ = option.substr(strlen("--android-root=")).data();
1237 } else if (option.starts_with("--instruction-set=")) {
1238 ParseInstructionSet(option);
1239 } else if (option.starts_with("--instruction-set-variant=")) {
1240 ParseInstructionSetVariant(option, parser_options.get());
1241 } else if (option.starts_with("--instruction-set-features=")) {
1242 ParseInstructionSetFeatures(option, parser_options.get());
1243 } else if (option.starts_with("--compiler-backend=")) {
1244 ParseCompilerBackend(option, parser_options.get());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001245 } else if (option.starts_with("--profile-file=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001246 profile_file_ = option.substr(strlen("--profile-file=")).ToString();
Calin Juravle877fd962016-01-05 14:29:29 +00001247 } else if (option.starts_with("--profile-file-fd=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001248 ParseUintOption(option, "--profile-file-fd", &profile_file_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001249 } else if (option == "--host") {
1250 is_host_ = true;
1251 } else if (option == "--runtime-arg") {
1252 if (++i >= argc) {
1253 Usage("Missing required argument for --runtime-arg");
1254 }
1255 if (log_options) {
1256 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1257 }
1258 runtime_args_.push_back(argv[i]);
1259 } else if (option == "--dump-timing") {
1260 dump_timing_ = true;
1261 } else if (option == "--dump-passes") {
1262 dump_passes_ = true;
Roland Levillain9ec5e222015-08-17 20:18:41 +01001263 } else if (option == "--dump-stats") {
1264 dump_stats_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001265 } else if (option.starts_with("--swap-file=")) {
1266 swap_file_name_ = option.substr(strlen("--swap-file=")).data();
1267 } else if (option.starts_with("--swap-fd=")) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001268 ParseUintOption(option, "--swap-fd", &swap_fd_, Usage);
Andreas Gampee1459ae2016-06-29 09:36:30 -07001269 } else if (option.starts_with("--swap-dex-size-threshold=")) {
1270 ParseUintOption(option,
1271 "--swap-dex-size-threshold",
1272 &min_dex_file_cumulative_size_for_swap_,
1273 Usage);
1274 } else if (option.starts_with("--swap-dex-count-threshold=")) {
1275 ParseUintOption(option,
1276 "--swap-dex-count-threshold",
1277 &min_dex_files_for_swap_,
1278 Usage);
Andreas Gampe67f02822016-06-24 21:05:23 -07001279 } else if (option.starts_with("--very-large-app-threshold=")) {
1280 ParseUintOption(option,
1281 "--very-large-app-threshold",
1282 &very_large_threshold_,
1283 Usage);
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001284 } else if (option.starts_with("--app-image-file=")) {
1285 app_image_file_name_ = option.substr(strlen("--app-image-file=")).data();
1286 } else if (option.starts_with("--app-image-fd=")) {
1287 ParseUintOption(option, "--app-image-fd", &app_image_fd_, Usage);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001288 } else if (option == "--multi-image") {
Jeff Hao436183f2016-01-12 16:36:50 -08001289 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001290 } else if (option.starts_with("--no-inline-from=")) {
1291 no_inline_from_string_ = option.substr(strlen("--no-inline-from=")).data();
Andreas Gampeace0dc12016-01-20 13:33:13 -08001292 } else if (option == "--force-determinism") {
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001293 if (!SupportsDeterministicCompilation()) {
Roland Levillainb81e9e92017-04-20 17:35:32 +01001294 Usage("Option --force-determinism requires read barriers or a CMS/MS garbage collector");
Roland Levillaineb2c7412016-01-28 14:37:01 +00001295 }
Andreas Gampeace0dc12016-01-20 13:33:13 -08001296 force_determinism_ = true;
Jeff Hao16d48432017-04-05 17:05:46 -07001297 } else if (option.starts_with("--classpath-dir=")) {
1298 classpath_dir_ = option.substr(strlen("--classpath-dir=")).data();
Calin Juravle1ce70852017-06-28 10:59:03 -07001299 } else if (option.starts_with("--class-loader-context=")) {
1300 class_loader_context_ = ClassLoaderContext::Create(
1301 option.substr(strlen("--class-loader-context=")).data());
1302 if (class_loader_context_== nullptr) {
1303 Usage("Option --class-loader-context has an incorrect format: %s", option.data());
1304 }
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001305 } else if (!compiler_options_->ParseCompilerOption(option, Usage)) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001306 Usage("Unknown argument %s", option.data());
1307 }
1308 }
1309
Jeff Hao436183f2016-01-12 16:36:50 -08001310 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001311
1312 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001313 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001314 }
1315
Jeff Haodcdc85b2015-12-04 14:06:18 -08001316 // Check whether the oat output files are writable, and open them for later. Also open a swap
1317 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001318 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001319 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1320 PruneNonExistentDexFiles();
1321
Jeff Hao436183f2016-01-12 16:36:50 -08001322 // Expand oat and image filenames for multi image.
1323 if (IsBootImage() && multi_image_) {
1324 ExpandOatAndImageFilenames();
1325 }
1326
David Brazdil7b49e6c2016-09-01 11:06:18 +01001327 // OAT and VDEX file handling
David Brazdil7b49e6c2016-09-01 11:06:18 +01001328 if (oat_fd_ == -1) {
1329 DCHECK(!oat_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08001330 for (const char* oat_filename : oat_filenames_) {
1331 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
1332 if (oat_file.get() == nullptr) {
1333 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1334 return false;
1335 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001336 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001337 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1338 oat_file->Erase();
1339 return false;
1340 }
1341 oat_files_.push_back(std::move(oat_file));
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001342 DCHECK_EQ(input_vdex_fd_, -1);
1343 if (!input_vdex_.empty()) {
1344 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001345 input_vdex_file_ = VdexFile::Open(input_vdex_,
1346 /* writable */ false,
1347 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001348 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001349 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001350 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001351
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001352 DCHECK_EQ(output_vdex_fd_, -1);
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01001353 std::string vdex_filename = output_vdex_.empty()
1354 ? ReplaceFileExtension(oat_filename, "vdex")
1355 : output_vdex_;
1356 if (vdex_filename == input_vdex_ && output_vdex_.empty()) {
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001357 update_input_vdex_ = true;
1358 std::unique_ptr<File> vdex_file(OS::OpenFileReadWrite(vdex_filename.c_str()));
1359 vdex_files_.push_back(std::move(vdex_file));
1360 } else {
1361 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
1362 if (vdex_file.get() == nullptr) {
1363 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1364 return false;
1365 }
1366 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1367 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1368 vdex_file->Erase();
1369 return false;
1370 }
1371 vdex_files_.push_back(std::move(vdex_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001372 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001373 }
1374 } else {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001375 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, /* check_usage */ true));
Jeff Haodcdc85b2015-12-04 14:06:18 -08001376 if (oat_file.get() == nullptr) {
1377 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1378 return false;
1379 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001380 oat_file->DisableAutoClose();
1381 if (oat_file->SetLength(0) != 0) {
1382 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1383 }
1384 oat_files_.push_back(std::move(oat_file));
1385
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001386 if (input_vdex_fd_ != -1) {
1387 struct stat s;
1388 int rc = TEMP_FAILURE_RETRY(fstat(input_vdex_fd_, &s));
1389 if (rc == -1) {
1390 PLOG(WARNING) << "Failed getting length of vdex file";
1391 } else {
1392 std::string error_msg;
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001393 input_vdex_file_ = VdexFile::Open(input_vdex_fd_,
1394 s.st_size,
1395 "vdex",
1396 /* writable */ false,
1397 /* low_4gb */ false,
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001398 DoEagerUnquickeningOfVdex(),
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001399 &error_msg);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001400 // If there's any problem with the passed vdex, just warn and proceed
1401 // without it.
1402 if (input_vdex_file_ == nullptr) {
Richard Uhlerb8ab63a2017-01-31 11:27:37 +00001403 PLOG(WARNING) << "Failed opening vdex file: " << error_msg;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001404 }
1405 }
1406 }
1407
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001408 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001409 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001410 std::unique_ptr<File> vdex_file(new File(output_vdex_fd_, vdex_location, /* check_usage */ true));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001411 if (vdex_file.get() == nullptr) {
1412 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001413 return false;
1414 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001415 vdex_file->DisableAutoClose();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001416 if (input_vdex_file_ != nullptr && output_vdex_fd_ == input_vdex_fd_) {
1417 update_input_vdex_ = true;
1418 } else {
1419 if (vdex_file->SetLength(0) != 0) {
1420 PLOG(ERROR) << "Truncating vdex file " << vdex_location << " failed.";
1421 return false;
1422 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001423 }
1424 vdex_files_.push_back(std::move(vdex_file));
1425
Jeff Haodcdc85b2015-12-04 14:06:18 -08001426 oat_filenames_.push_back(oat_location_.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001427 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001428
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001429 // If we're updating in place a vdex file, be defensive and put an invalid vdex magic in case
1430 // dex2oat gets killed.
1431 // Note: we're only invalidating the magic data in the file, as dex2oat needs the rest of
1432 // the information to remain valid.
1433 if (update_input_vdex_) {
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07001434 std::unique_ptr<BufferedOutputStream> vdex_out = std::make_unique<BufferedOutputStream>(
1435 std::make_unique<FileOutputStream>(vdex_files_.back().get()));
Nicolas Geoffray36930ec2017-05-09 13:23:34 +01001436 if (!vdex_out->WriteFully(&VdexFile::Header::kVdexInvalidMagic,
1437 arraysize(VdexFile::Header::kVdexInvalidMagic))) {
1438 PLOG(ERROR) << "Failed to invalidate vdex header. File: " << vdex_out->GetLocation();
1439 return false;
1440 }
1441
1442 if (!vdex_out->Flush()) {
1443 PLOG(ERROR) << "Failed to flush stream after invalidating header of vdex file."
1444 << " File: " << vdex_out->GetLocation();
1445 return false;
1446 }
1447 }
1448
David Brazdil7b49e6c2016-09-01 11:06:18 +01001449 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001450 //
1451 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1452 // that we can use for swap.
1453 //
1454 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1455 // will immediately unlink to satisfy the swap fd assumption.
1456 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1457 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1458 if (swap_file.get() == nullptr) {
1459 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1460 return false;
1461 }
1462 swap_fd_ = swap_file->Fd();
1463 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1464 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1465 // released immediately.
1466 unlink(swap_file_name_.c_str());
1467 }
Jeff Hao436183f2016-01-12 16:36:50 -08001468
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001469 return true;
1470 }
1471
David Brazdil7b49e6c2016-09-01 11:06:18 +01001472 void EraseOutputFiles() {
1473 for (auto& files : { &vdex_files_, &oat_files_ }) {
1474 for (size_t i = 0; i < files->size(); ++i) {
1475 if ((*files)[i].get() != nullptr) {
1476 (*files)[i]->Erase();
1477 (*files)[i].reset();
1478 }
1479 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001480 }
Andreas Gampea650e702014-12-03 14:28:02 -08001481 }
1482
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001483 void Shutdown() {
1484 ScopedObjectAccess soa(Thread::Current());
1485 for (jobject dex_cache : dex_caches_) {
1486 soa.Env()->DeleteLocalRef(dex_cache);
1487 }
1488 dex_caches_.clear();
1489 }
1490
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001491 void LoadClassProfileDescriptors() {
Mathieu Chartierf70fe3d2017-06-21 15:24:02 -07001492 if (profile_compilation_info_ != nullptr && IsImage()) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001493 Runtime* runtime = Runtime::Current();
1494 CHECK(runtime != nullptr);
Mathieu Chartier0b490842016-05-25 15:05:59 -07001495 // Filter out class path classes since we don't want to include these in the image.
Mathieu Chartier046854b2017-03-01 17:16:22 -08001496 std::set<DexCacheResolvedClasses> resolved_classes(
Calin Juravle08556882017-05-26 16:40:45 -07001497 profile_compilation_info_->GetResolvedClasses(dex_files_));
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001498 image_classes_.reset(new std::unordered_set<std::string>(
Mathieu Chartier046854b2017-03-01 17:16:22 -08001499 runtime->GetClassLinker()->GetClassDescriptorsForResolvedClasses(resolved_classes)));
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001500 VLOG(compiler) << "Loaded " << image_classes_->size()
1501 << " image class descriptors from profile";
1502 if (VLOG_IS_ON(compiler)) {
1503 for (const std::string& s : *image_classes_) {
1504 LOG(INFO) << "Image class " << s;
1505 }
1506 }
1507 }
1508 }
1509
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001510 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1511 // boot class path.
Andreas Gampef7882972017-03-20 16:35:24 -07001512 dex2oat::ReturnCode Setup() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001513 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001514
1515 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001516 return dex2oat::ReturnCode::kOther;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001517 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001518
Vladimir Marko307dac92015-10-20 11:20:09 +01001519 verification_results_.reset(new VerificationResults(compiler_options_.get()));
Andreas Gampe4585f872015-03-27 23:45:15 -07001520 callbacks_.reset(new QuickCompilerCallbacks(
Vladimir Marko307dac92015-10-20 11:20:09 +01001521 verification_results_.get(),
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001522 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001523 CompilerCallbacks::CallbackMode::kCompileBootImage :
1524 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001525
Vladimir Marko49b0f452015-12-10 13:49:19 +00001526 RuntimeArgumentMap runtime_options;
1527 if (!PrepareRuntimeOptions(&runtime_options)) {
Andreas Gampef7882972017-03-20 16:35:24 -07001528 return dex2oat::ReturnCode::kOther;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001529 }
1530
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001531 CreateOatWriters();
1532 if (!AddDexFileSources()) {
Andreas Gampef7882972017-03-20 16:35:24 -07001533 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001534 }
1535
1536 if (IsBootImage() && image_filenames_.size() > 1) {
1537 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1538 // We need this for the multi-image case.
Mathieu Chartier866d8742016-09-21 15:24:18 -07001539 key_value_store_->Put(OatHeader::kBootClassPathKey,
1540 gc::space::ImageSpace::GetMultiImageBootClassPath(dex_locations_,
1541 oat_filenames_,
1542 image_filenames_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001543 }
1544
1545 if (!IsBootImage()) {
1546 // When compiling an app, create the runtime early to retrieve
1547 // the image location key needed for the oat header.
1548 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001549 return dex2oat::ReturnCode::kCreateRuntime;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001550 }
1551
Andreas Gampe29d38e72016-03-23 15:31:51 +00001552 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001553 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1554 std::vector<gc::space::ImageSpace*> image_spaces =
1555 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Richard Uhlerbc26b722017-03-10 14:27:10 +00001556 image_file_location_oat_checksum_ = image_spaces[0]->GetImageHeader().GetOatChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001557 image_file_location_oat_data_begin_ =
1558 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1559 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1560 // Store the boot image filename(s).
1561 std::vector<std::string> image_filenames;
1562 for (const gc::space::ImageSpace* image_space : image_spaces) {
1563 image_filenames.push_back(image_space->GetImageFilename());
1564 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001565 std::string image_file_location = android::base::Join(image_filenames, ':');
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001566 if (!image_file_location.empty()) {
1567 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1568 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001569 } else {
1570 image_file_location_oat_checksum_ = 0u;
1571 image_file_location_oat_data_begin_ = 0u;
1572 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001573 }
1574
1575 // Open dex files for class path.
Calin Juravle1ce70852017-06-28 10:59:03 -07001576 if (class_loader_context_ == nullptr) {
1577 // TODO(calin): Temporary workaround while we transition to use
1578 // --class-loader-context instead of --runtime-arg -cp
1579 if (runtime_->GetClassPathString().empty()) {
1580 class_loader_context_ = std::unique_ptr<ClassLoaderContext>(
1581 new ClassLoaderContext());
1582 } else {
1583 std::string spec = runtime_->GetClassPathString() == OatFile::kSpecialSharedLibrary
1584 ? OatFile::kSpecialSharedLibrary
1585 : "PCL[" + runtime_->GetClassPathString() + "]";
1586 class_loader_context_ = ClassLoaderContext::Create(spec);
1587 }
Jeff Haof0192c82016-03-28 20:39:50 -07001588 }
Calin Juravle1ce70852017-06-28 10:59:03 -07001589 CHECK(class_loader_context_ != nullptr);
1590 DCHECK_EQ(oat_writers_.size(), 1u);
1591
1592 // Note: Ideally we would reject context where the source dex files are also
1593 // specified in the classpath (as it doesn't make sense). However this is currently
1594 // needed for non-prebuild tests and benchmarks which expects on the fly compilation.
1595 // Also, for secondary dex files we do not have control on the actual classpath.
1596 // Instead of aborting, remove all the source location from the context classpaths.
1597 if (class_loader_context_->RemoveLocationsFromClassPaths(
1598 oat_writers_[0]->GetSourceLocations())) {
1599 LOG(WARNING) << "The source files to be compiled are also in the classpath.";
1600 }
1601
1602 // We need to open the dex files before encoding the context in the oat file.
1603 // (because the encoding adds the dex checksum...)
1604 // TODO(calin): consider redesigning this so we don't have to open the dex files before
1605 // creating the actual class loader.
1606 if (!class_loader_context_->OpenDexFiles(runtime_->GetInstructionSet(), classpath_dir_)) {
1607 // Do not abort if we couldn't open files from the classpath. They might be
1608 // apks without dex files and right now are opening flow will fail them.
1609 LOG(WARNING) << "Failed to open classpath dex files";
1610 }
1611
1612 // Store the class loader context in the oat header.
1613 key_value_store_->Put(OatHeader::kClassPathKey,
1614 class_loader_context_->EncodeContextForOatFile(classpath_dir_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001615 }
1616
1617 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001618 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001619 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1620 rodata_.reserve(oat_writers_.size());
1621 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1622 rodata_.push_back(elf_writers_[i]->StartRoData());
1623 // Unzip or copy dex files straight to the oat file.
1624 std::unique_ptr<MemMap> opened_dex_files_map;
1625 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001626 // No need to verify the dex file for:
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001627 // 1) Dexlayout since it does the verification. It also may not pass the verification since
1628 // we don't update the dex checksum.
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001629 // 2) when we have a vdex file, which means it was already verified.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08001630 const bool verify = !DoDexLayoutOptimizations() && (input_vdex_file_ == nullptr);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001631 if (!oat_writers_[i]->WriteAndOpenDexFiles(
1632 kIsVdexEnabled ? vdex_files_[i].get() : oat_files_[i].get(),
1633 rodata_.back(),
1634 instruction_set_,
1635 instruction_set_features_.get(),
1636 key_value_store_.get(),
Jeff Hao042e8982016-10-19 11:17:11 -07001637 verify,
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001638 update_input_vdex_,
David Brazdil7b49e6c2016-09-01 11:06:18 +01001639 &opened_dex_files_map,
1640 &opened_dex_files)) {
Andreas Gampef7882972017-03-20 16:35:24 -07001641 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001642 }
1643 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1644 if (opened_dex_files_map != nullptr) {
1645 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
1646 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001647 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001648 opened_dex_files_.push_back(std::move(dex_file));
1649 }
1650 } else {
1651 DCHECK(opened_dex_files.empty());
1652 }
1653 }
1654 }
1655
1656 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
Andreas Gampe7386da42016-06-08 18:18:47 -07001657
1658 // We had to postpone the swap decision till now, as this is the point when we actually
1659 // know about the dex files we're going to use.
1660
1661 // Make sure that we didn't create the driver, yet.
1662 CHECK(driver_ == nullptr);
1663 // If we use a swap file, ensure we are above the threshold to make it necessary.
1664 if (swap_fd_ != -1) {
1665 if (!UseSwap(IsBootImage(), dex_files_)) {
1666 close(swap_fd_);
1667 swap_fd_ = -1;
1668 VLOG(compiler) << "Decided to run without swap.";
1669 } else {
1670 LOG(INFO) << "Large app, accepted running with swap.";
1671 }
1672 }
1673 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
1674
Andreas Gampe67f02822016-06-24 21:05:23 -07001675 // If we need to downgrade the compiler-filter for size reasons, do that check now.
1676 if (!IsBootImage() && IsVeryLarge(dex_files_)) {
Mathieu Chartier010126f2017-07-15 15:44:18 -07001677 if (!CompilerFilter::IsAsGoodAs(kLargeAppFilter, compiler_options_->GetCompilerFilter())) {
1678 LOG(INFO) << "Very large app, downgrading to verify.";
Andreas Gampe67f02822016-06-24 21:05:23 -07001679 // Note: this change won't be reflected in the key-value store, as that had to be
1680 // finalized before loading the dex files. This setup is currently required
1681 // to get the size from the DexFile objects.
1682 // TODO: refactor. b/29790079
Mathieu Chartier010126f2017-07-15 15:44:18 -07001683 compiler_options_->SetCompilerFilter(kLargeAppFilter);
Andreas Gampe67f02822016-06-24 21:05:23 -07001684 }
1685 }
1686
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001687 if (IsBootImage()) {
1688 // For boot image, pass opened dex files to the Runtime::Create().
1689 // Note: Runtime acquires ownership of these dex files.
1690 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001691 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampef7882972017-03-20 16:35:24 -07001692 return dex2oat::ReturnCode::kOther;
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001693 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001694 }
1695
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001696 // If we're doing the image, override the compiler filter to force full compilation. Must be
1697 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1698 // compilation of class initializers.
1699 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001700 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001701 WellKnownClasses::Init(self->GetJniEnv());
1702
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001703 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001704 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001705 constexpr bool kSaveDexInput = false;
1706 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001707 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001708 }
Calin Juravle1ce70852017-06-28 10:59:03 -07001709 class_loader_ = class_loader_context_->CreateClassLoader(dex_files_);
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001710 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001711
1712 // Ensure opened dex files are writable for dex-to-dex transformations.
1713 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1714 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1715 PLOG(ERROR) << "Failed to make .dex files writeable.";
Andreas Gampef7882972017-03-20 16:35:24 -07001716 return dex2oat::ReturnCode::kOther;
Vladimir Marko919f5532016-01-20 19:13:01 +00001717 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001718 }
1719
1720 // Ensure that the dex caches stay live since we don't want class unloading
1721 // to occur during compilation.
1722 for (const auto& dex_file : dex_files_) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001723 ScopedObjectAccess soa(self);
1724 dex_caches_.push_back(soa.AddLocalReference<jobject>(
Mathieu Chartierf284d442016-06-02 11:48:30 -07001725 class_linker->RegisterDexFile(*dex_file,
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001726 soa.Decode<mirror::ClassLoader>(class_loader_).Ptr())));
Vladimir Markocd556b02017-02-03 11:47:34 +00001727 if (dex_caches_.back() == nullptr) {
1728 soa.Self()->AssertPendingException();
1729 soa.Self()->ClearException();
1730 PLOG(ERROR) << "Failed to register dex file.";
Andreas Gampef7882972017-03-20 16:35:24 -07001731 return dex2oat::ReturnCode::kOther;
Vladimir Markocd556b02017-02-03 11:47:34 +00001732 }
Mathieu Chartierfc2dd612016-11-21 15:05:23 -08001733 // Pre-register dex files so that we can access verification results without locks during
1734 // compilation and verification.
Mathieu Chartier9df89312016-11-23 13:28:16 -08001735 verification_results_->AddDexFile(dex_file);
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001736 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001737
Andreas Gampef7882972017-03-20 16:35:24 -07001738 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001739 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001740
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001741 // If we need to keep the oat file open for the image writer.
1742 bool ShouldKeepOatFileOpen() const {
1743 return IsImage() && oat_fd_ != kInvalidFd;
1744 }
1745
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001746 // Create and invoke the compiler driver. This will compile all the dex files.
1747 void Compile() {
1748 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1749 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001750
Vladimir Marko47496c22016-01-27 16:15:08 +00001751 // Find the dex files we should not inline from.
1752
1753 std::vector<std::string> no_inline_filters;
1754 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001755
1756 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001757 const std::string core_oj = "core-oj";
1758 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1759 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001760 }
1761
Vladimir Marko47496c22016-01-27 16:15:08 +00001762 if (!no_inline_filters.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001763 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
Calin Juravle1ce70852017-06-28 10:59:03 -07001764 std::vector<const DexFile*> class_path_files;
1765 if (!IsBootImage()) {
1766 // The class loader context is used only for apps.
1767 class_path_files = class_loader_context_->FlattenOpenedDexFiles();
1768 }
1769
Jeff Haodcdc85b2015-12-04 14:06:18 -08001770 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1771 &class_linker->GetBootClassPath(),
1772 &class_path_files,
1773 &dex_files_
1774 };
1775 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001776 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001777 for (const std::string& filter : no_inline_filters) {
1778 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
1779 // allows tests to specify <test-dexfile>:classes2.dex if needed but if the
1780 // base location passes the StartsWith() test, so do all extra locations.
1781 std::string dex_location = dex_file->GetLocation();
1782 if (filter.find('/') == std::string::npos) {
1783 // The filter does not contain the path. Remove the path from dex_location as well.
1784 size_t last_slash = dex_file->GetLocation().rfind('/');
1785 if (last_slash != std::string::npos) {
1786 dex_location = dex_location.substr(last_slash + 1);
1787 }
1788 }
1789
Andreas Gampe9186ced2016-12-12 14:28:21 -08001790 if (android::base::StartsWith(dex_location, filter.c_str())) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001791 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1792 no_inline_from_dex_files_.push_back(dex_file);
1793 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001794 }
1795 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001796 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001797 }
1798 if (!no_inline_from_dex_files_.empty()) {
1799 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001800 }
1801 }
1802
Vladimir Marko307dac92015-10-20 11:20:09 +01001803 driver_.reset(new CompilerDriver(compiler_options_.get(),
1804 verification_results_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001805 compiler_kind_,
1806 instruction_set_,
1807 instruction_set_features_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001808 image_classes_.release(),
1809 compiled_classes_.release(),
Wojciech Staszkiewicz62534792016-08-09 14:30:55 -07001810 compiled_methods_.release(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001811 thread_count_,
1812 dump_stats_,
1813 dump_passes_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001814 compiler_phases_timings_.get(),
1815 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001816 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001817 driver_->SetDexFilesForOatFile(dex_files_);
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01001818
1819 // Setup vdex for compilation.
1820 if (!DoEagerUnquickeningOfVdex() && input_vdex_file_ != nullptr) {
1821 callbacks_->SetVerifierDeps(
1822 new verifier::VerifierDeps(dex_files_, input_vdex_file_->GetVerifierDepsData()));
1823
1824 // TODO: we unquicken unconditionally, as we don't know
1825 // if the boot image has changed. How exactly we'll know is under
1826 // experimentation.
1827 TimingLogger::ScopedTiming time_unquicken("Unquicken", timings_);
1828 VdexFile::Unquicken(dex_files_, input_vdex_file_->GetQuickeningInfo());
1829 }
1830 driver_->CompileAll(class_loader_, dex_files_, timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001831 }
1832
Jeff Hao436183f2016-01-12 16:36:50 -08001833 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001834 // ensure the references between the two are correct.
1835 //
1836 // Currently we have a memory layout that looks something like this:
1837 //
1838 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001839 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001840 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001841 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001842 // +--------------+
1843 // | alloc spaces |
1844 // +--------------+
1845 //
Jeff Hao436183f2016-01-12 16:36:50 -08001846 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001847 //
Jeff Hao436183f2016-01-12 16:36:50 -08001848 // 1. The images are expected to be loaded at an absolute address and
1849 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001850 //
Jeff Hao436183f2016-01-12 16:36:50 -08001851 // 2. There are absolute pointers from Methods in the images to their
1852 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001853 //
Jeff Hao436183f2016-01-12 16:36:50 -08001854 // 3. There are absolute pointers from the code in the oat files to Methods
1855 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001856 //
Jeff Hao436183f2016-01-12 16:36:50 -08001857 // 4. There are absolute pointers from code in the oat files to other code
1858 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001859 //
1860 // To get this all correct, we go through several steps.
1861 //
Jeff Hao436183f2016-01-12 16:36:50 -08001862 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001863 // the oat data size and code size. During this stage, we also set
1864 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001865 //
Jeff Hao436183f2016-01-12 16:36:50 -08001866 // 2. We prepare offsets for the objects in the images and calculate
1867 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001868 //
Jeff Hao436183f2016-01-12 16:36:50 -08001869 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001870 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001871 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001872 // can prepare the ELF headers and we then know the ELF memory segment
1873 // layout and we can now resolve all references. The compiler provides
1874 // LinkerPatch information in each CompiledMethod and we resolve these,
1875 // using the layout information and image object locations provided by
1876 // image writer, as we're writing the method code.
1877 //
Jeff Hao436183f2016-01-12 16:36:50 -08001878 // 4. We create the image files. They need to know where the oat files
1879 // will be loaded after itself. Originally oat files were simply
1880 // memory mapped so we could predict where their contents were based
1881 // on the file size. Now that they are ELF files, we need to inspect
1882 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001883 // where the oat header is located within.
1884 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001885 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001886 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001887 // load the .so at the desired location at runtime by offsetting the
1888 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001889 // TODO: Do this in step 3. We already know the layout there.
1890 //
1891 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1892 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001893
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001894 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1895 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001896 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1897 // case (when the file will be explicitly erased).
David Brazdil7b49e6c2016-09-01 11:06:18 +01001898 bool WriteOutputFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001899 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1900
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001901 // Sync the data to the file, in case we did dex2dex transformations.
1902 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1903 if (!map->Sync()) {
1904 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1905 return false;
1906 }
1907 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001908
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001909 if (IsImage()) {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001910 if (IsAppImage() && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001911 gc::Heap* const heap = Runtime::Current()->GetHeap();
1912 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001913 image_base_ = std::max(image_base_, RoundUp(
1914 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1915 kPageSize));
1916 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001917 // The non moving space is right after the oat file. Put the preferred app image location
1918 // right after the non moving space so that we ideally get a continuous immune region for
1919 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001920 // Use the default non moving space capacity since dex2oat does not have a separate non-
1921 // moving space. This means the runtime's non moving space space size will be as large
1922 // as the growth limit for dex2oat, but smaller in the zygote.
1923 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001924 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001925 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1926 }
1927
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001928 image_writer_.reset(new ImageWriter(*driver_,
1929 image_base_,
1930 compiler_options_->GetCompilePic(),
1931 IsAppImage(),
1932 image_storage_mode_,
1933 oat_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00001934 dex_file_oat_index_map_));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001935
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001936 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001937 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1938 if (!image_writer_->PrepareImageAddressSpace()) {
1939 LOG(ERROR) << "Failed to prepare image address space.";
1940 return false;
1941 }
1942 }
1943
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001944 // Initialize the writers with the compiler driver, image writer, and their
1945 // dex files. The writers were created without those being there yet.
1946 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1947 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
1948 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1949 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
1950 }
1951
David Brazdil5d5a36b2016-09-14 15:34:10 +01001952 {
1953 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
1954 DCHECK(IsBootImage() || oat_files_.size() == 1u);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001955 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
David Brazdil5d5a36b2016-09-14 15:34:10 +01001956 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1957 File* vdex_file = vdex_files_[i].get();
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07001958 std::unique_ptr<BufferedOutputStream> vdex_out =
1959 std::make_unique<BufferedOutputStream>(std::make_unique<FileOutputStream>(vdex_file));
David Brazdil5d5a36b2016-09-14 15:34:10 +01001960
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001961 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01001962 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
1963 return false;
1964 }
1965
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001966 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
1967 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
1968 return false;
1969 }
1970
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +00001971 // VDEX finalized, seek back to the beginning and write checksums and the header.
1972 if (!oat_writers_[i]->WriteChecksumsAndVdexHeader(vdex_out.get())) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01001973 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
1974 return false;
1975 }
1976 }
1977 }
1978
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001979 {
1980 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001981 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001982 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko944da602016-02-19 12:27:55 +00001983 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1984 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
1985
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001986 oat_writer->PrepareLayout(&patcher);
Vladimir Marko944da602016-02-19 12:27:55 +00001987
1988 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
David Brazdil7b49e6c2016-09-01 11:06:18 +01001989 size_t text_size = oat_writer->GetOatSize() - rodata_size;
Vladimir Markoaad75c62016-10-03 08:46:48 +00001990 elf_writer->PrepareDynamicSection(rodata_size,
1991 text_size,
1992 oat_writer->GetBssSize(),
Vladimir Marko0eb882b2017-05-15 13:39:18 +01001993 oat_writer->GetBssMethodsOffset(),
Vladimir Markoaad75c62016-10-03 08:46:48 +00001994 oat_writer->GetBssRootsOffset());
Vladimir Marko944da602016-02-19 12:27:55 +00001995
1996 if (IsImage()) {
1997 // Update oat layout.
1998 DCHECK(image_writer_ != nullptr);
1999 DCHECK_LT(i, oat_filenames_.size());
2000 image_writer_->UpdateOatFileLayout(i,
2001 elf_writer->GetLoadedSize(),
2002 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01002003 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00002004 }
Richard Uhlerbc26b722017-03-10 14:27:10 +00002005
2006 if (IsBootImage()) {
2007 // Have the image_file_location_oat_checksum_ for boot oat files
2008 // depend on the contents of all the boot oat files. This way only
2009 // the primary image checksum needs to be checked to determine
2010 // whether any of the images are out of date.
2011 image_file_location_oat_checksum_ ^= oat_writer->GetOatHeader().GetChecksum();
2012 }
Vladimir Marko944da602016-02-19 12:27:55 +00002013 }
2014
2015 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002016 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002017 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
2018 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00002019
David Srbecky09c2a6b2016-03-11 17:11:44 +00002020 oat_writer->AddMethodDebugInfos(debug::MakeTrampolineInfos(oat_writer->GetOatHeader()));
2021
David Srbecky0c4572e2016-01-22 19:19:25 +00002022 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00002023 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
2024 elf_writer->PrepareDebugInfo(oat_writer->GetMethodDebugInfo());
David Srbecky0c4572e2016-01-22 19:19:25 +00002025
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002026 OutputStream*& rodata = rodata_[i];
2027 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002028 if (!oat_writer->WriteRodata(rodata)) {
2029 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
2030 return false;
2031 }
2032 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002033 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00002034
Jeff Haodcdc85b2015-12-04 14:06:18 -08002035 OutputStream* text = elf_writer->StartText();
2036 if (!oat_writer->WriteCode(text)) {
2037 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
2038 return false;
2039 }
2040 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00002041
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002042 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
2043 image_file_location_oat_checksum_,
2044 image_file_location_oat_data_begin_,
2045 image_patch_delta_)) {
2046 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
2047 return false;
2048 }
2049
Vladimir Marko944da602016-02-19 12:27:55 +00002050 if (IsImage()) {
2051 // Update oat header information.
2052 DCHECK(image_writer_ != nullptr);
2053 DCHECK_LT(i, oat_filenames_.size());
2054 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
2055 }
2056
Jeff Haodcdc85b2015-12-04 14:06:18 -08002057 elf_writer->WriteDynamicSection();
2058 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
Vladimir Marko10c13562015-11-25 14:33:36 +00002059
Jeff Haodcdc85b2015-12-04 14:06:18 -08002060 if (!elf_writer->End()) {
2061 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
2062 return false;
2063 }
2064
David Brazdil7b49e6c2016-09-01 11:06:18 +01002065 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
2066 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002067 }
2068
Jeff Haodcdc85b2015-12-04 14:06:18 -08002069 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002070
2071 oat_writer.reset();
2072 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002073 }
2074 }
2075
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002076 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002077 }
2078
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002079 // If we are compiling an image, invoke the image creation routine. Else just skip.
2080 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002081 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002082 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
2083 if (!CreateImageFile()) {
2084 return false;
2085 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002086 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07002087 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002088 return true;
2089 }
2090
Jeff Haodcdc85b2015-12-04 14:06:18 -08002091 // Create a copy from stripped to unstripped.
2092 bool CopyStrippedToUnstripped() {
2093 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
2094 // If we don't want to strip in place, copy from stripped location to unstripped location.
2095 // We need to strip after image creation because FixupElf needs to use .strtab.
2096 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
2097 // If the oat file is still open, flush it.
2098 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002099 if (!FlushCloseOutputFile(&oat_files_[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002100 return false;
2101 }
2102 }
2103
2104 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
2105 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
2106 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01002107 int64_t in_length = in->GetLength();
2108 if (in_length < 0) {
2109 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
2110 return false;
2111 }
2112 if (!out->Copy(in.get(), 0, in_length)) {
2113 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
2114 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002115 }
2116 if (out->FlushCloseOrErase() != 0) {
2117 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
2118 return false;
2119 }
2120 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
2121 }
2122 }
2123 return true;
2124 }
2125
David Brazdil7b49e6c2016-09-01 11:06:18 +01002126 bool FlushOutputFile(std::unique_ptr<File>* file) {
2127 if (file->get() != nullptr) {
2128 if (file->get()->Flush() != 0) {
2129 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
2130 return false;
2131 }
2132 }
2133 return true;
2134 }
2135
2136 bool FlushCloseOutputFile(std::unique_ptr<File>* file) {
2137 if (file->get() != nullptr) {
2138 std::unique_ptr<File> tmp(file->release());
2139 if (tmp->FlushCloseOrErase() != 0) {
2140 PLOG(ERROR) << "Failed to flush and close output file: " << tmp->GetPath();
2141 return false;
2142 }
2143 }
2144 return true;
2145 }
2146
2147 bool FlushOutputFiles() {
2148 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
2149 for (auto& files : { &vdex_files_, &oat_files_ }) {
2150 for (size_t i = 0; i < files->size(); ++i) {
2151 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002152 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08002153 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002154 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00002155 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002156 return true;
2157 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002158
David Brazdil7b49e6c2016-09-01 11:06:18 +01002159 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002160 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002161 for (auto& files : { &vdex_files_, &oat_files_ }) {
2162 for (size_t i = 0; i < files->size(); ++i) {
2163 result &= FlushCloseOutputFile(&(*files)[i]);
2164 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002165 }
2166 return result;
2167 }
2168
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002169 void DumpTiming() {
2170 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
2171 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2172 }
2173 if (dump_passes_) {
2174 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
2175 }
2176 }
2177
Andreas Gampe10e477d2014-11-19 12:57:42 -08002178 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002179 return IsAppImage() || IsBootImage();
2180 }
2181
2182 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002183 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002184 }
2185
2186 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002187 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002188 }
2189
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002190 bool IsHost() const {
2191 return is_host_;
2192 }
2193
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002194 bool UseProfile() const {
Mathieu Chartierd0af56c2017-02-17 12:56:25 -08002195 return profile_file_fd_ != -1 || !profile_file_.empty();
Calin Juravle998c2162015-12-21 15:39:33 +02002196 }
2197
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002198 bool DoProfileGuidedOptimizations() const {
Nicolas Geoffray49cda062017-04-21 13:08:25 +01002199 return UseProfile();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002200 }
2201
2202 bool DoDexLayoutOptimizations() const {
2203 return DoProfileGuidedOptimizations();
2204 }
2205
Nicolas Geoffray1cfea7a2017-05-24 14:44:38 +01002206 bool DoEagerUnquickeningOfVdex() const {
2207 // DexLayout can invalidate the vdex metadata, so we need to unquicken
2208 // the vdex file eagerly, before passing it to dexlayout.
2209 return DoDexLayoutOptimizations();
2210 }
2211
Calin Juravle2e2db782016-02-23 12:00:03 +00002212 bool LoadProfile() {
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002213 DCHECK(UseProfile());
Calin Juravlee6f87cc2017-05-24 17:41:05 -07002214 // TODO(calin): We should be using the runtime arena pool (instead of the
2215 // default profile arena). However the setup logic is messy and needs
2216 // cleaning up before that (e.g. the oat writers are created before the
2217 // runtime).
Calin Juravle2e2db782016-02-23 12:00:03 +00002218 profile_compilation_info_.reset(new ProfileCompilationInfo());
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002219 ScopedFlock profile_file;
Calin Juravle2e2db782016-02-23 12:00:03 +00002220 std::string error;
2221 if (profile_file_fd_ != -1) {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002222 profile_file = LockedFile::DupOf(profile_file_fd_, "profile",
2223 true /* read_only_mode */, &error);
Andreas Gampe29d38e72016-03-23 15:31:51 +00002224 } else if (profile_file_ != "") {
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002225 profile_file = LockedFile::Open(profile_file_.c_str(), O_RDONLY, true, &error);
Calin Juravle998c2162015-12-21 15:39:33 +02002226 }
Calin Juravle877fd962016-01-05 14:29:29 +00002227
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002228 // Return early if we're unable to obtain a lock on the profile.
2229 if (profile_file.get() == nullptr) {
2230 LOG(ERROR) << "Cannot lock profiles: " << error;
2231 return false;
2232 }
2233
2234 if (!profile_compilation_info_->Load(profile_file->Fd())) {
Calin Juravle2e2db782016-02-23 12:00:03 +00002235 profile_compilation_info_.reset(nullptr);
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002236 return false;
Calin Juravle2e2db782016-02-23 12:00:03 +00002237 }
Calin Juravle877fd962016-01-05 14:29:29 +00002238
Narayan Kamatha3d27eb2017-05-11 13:50:59 +01002239 return true;
Calin Juravle998c2162015-12-21 15:39:33 +02002240 }
2241
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002242 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002243 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2244 if (is_image) {
2245 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2246 return false;
2247 }
2248 if (dex_files.size() < min_dex_files_for_swap_) {
2249 // If there are less dex files than the threshold, assume it's gonna be fine.
2250 return false;
2251 }
2252 size_t dex_files_size = 0;
2253 for (const auto* dex_file : dex_files) {
2254 dex_files_size += dex_file->GetHeader().file_size_;
2255 }
2256 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2257 }
2258
Andreas Gampe67f02822016-06-24 21:05:23 -07002259 bool IsVeryLarge(std::vector<const DexFile*>& dex_files) {
2260 size_t dex_files_size = 0;
2261 for (const auto* dex_file : dex_files) {
2262 dex_files_size += dex_file->GetHeader().file_size_;
2263 }
2264 return dex_files_size >= very_large_threshold_;
2265 }
2266
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002267 std::vector<std::string> GetClassPathLocations(const std::string& class_path) {
2268 // This function is used only for apps and for an app we have exactly one oat file.
2269 DCHECK(!IsBootImage());
2270 DCHECK_EQ(oat_writers_.size(), 1u);
2271 std::vector<std::string> dex_files_canonical_locations;
Calin Juravle1ce70852017-06-28 10:59:03 -07002272 for (const std::string& location : oat_writers_[0]->GetSourceLocations()) {
2273 dex_files_canonical_locations.push_back(DexFile::GetDexCanonicalLocation(location.c_str()));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002274 }
Vladimir Marko625a64a2015-11-26 14:44:16 +00002275
Vladimir Marko919f5532016-01-20 19:13:01 +00002276 std::vector<std::string> parsed;
2277 Split(class_path, ':', &parsed);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002278 auto kept_it = std::remove_if(parsed.begin(),
2279 parsed.end(),
2280 [dex_files_canonical_locations](const std::string& location) {
2281 return ContainsElement(dex_files_canonical_locations,
2282 DexFile::GetDexCanonicalLocation(location.c_str()));
2283 });
2284 parsed.erase(kept_it, parsed.end());
2285 return parsed;
2286 }
2287
Vladimir Marko49b0f452015-12-10 13:49:19 +00002288 bool PrepareImageClasses() {
2289 // If --image-classes was specified, calculate the full list of classes to include in the image.
2290 if (image_classes_filename_ != nullptr) {
2291 image_classes_ =
2292 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2293 if (image_classes_ == nullptr) {
2294 return false;
2295 }
2296 } else if (IsBootImage()) {
2297 image_classes_.reset(new std::unordered_set<std::string>);
2298 }
2299 return true;
2300 }
2301
2302 bool PrepareCompiledClasses() {
2303 // If --compiled-classes was specified, calculate the full list of classes to compile in the
2304 // image.
2305 if (compiled_classes_filename_ != nullptr) {
2306 compiled_classes_ =
2307 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
2308 if (compiled_classes_ == nullptr) {
2309 return false;
2310 }
2311 } else {
2312 compiled_classes_.reset(nullptr); // By default compile everything.
2313 }
2314 return true;
2315 }
2316
2317 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2318 const char* classes_filename,
2319 const char* tag) {
2320 std::unique_ptr<std::unordered_set<std::string>> classes;
2321 std::string error_msg;
2322 if (zip_filename != nullptr) {
2323 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2324 } else {
2325 classes.reset(ReadImageClassesFromFile(classes_filename));
2326 }
2327 if (classes == nullptr) {
2328 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2329 << classes_filename << "': " << error_msg;
2330 }
2331 return classes;
2332 }
2333
2334 bool PrepareCompiledMethods() {
2335 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2336 if (compiled_methods_filename_ != nullptr) {
2337 std::string error_msg;
2338 if (compiled_methods_zip_filename_ != nullptr) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002339 compiled_methods_.reset(ReadCommentedInputFromZip<std::unordered_set<std::string>>(
2340 compiled_methods_zip_filename_,
2341 compiled_methods_filename_,
2342 nullptr, // No post-processing.
2343 &error_msg));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002344 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002345 compiled_methods_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2346 compiled_methods_filename_,
2347 nullptr)); // No post-processing.
Vladimir Marko49b0f452015-12-10 13:49:19 +00002348 }
2349 if (compiled_methods_.get() == nullptr) {
2350 LOG(ERROR) << "Failed to create list of compiled methods from '"
2351 << compiled_methods_filename_ << "': " << error_msg;
2352 return false;
2353 }
2354 } else {
2355 compiled_methods_.reset(nullptr); // By default compile everything.
2356 }
2357 return true;
2358 }
2359
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002360 void PruneNonExistentDexFiles() {
2361 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2362 size_t kept = 0u;
2363 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2364 if (!OS::FileExists(dex_filenames_[i])) {
2365 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2366 } else {
2367 dex_filenames_[kept] = dex_filenames_[i];
2368 dex_locations_[kept] = dex_locations_[i];
2369 ++kept;
2370 }
2371 }
2372 dex_filenames_.resize(kept);
2373 dex_locations_.resize(kept);
2374 }
2375
2376 bool AddDexFileSources() {
2377 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002378 if (input_vdex_file_ != nullptr) {
2379 DCHECK_EQ(oat_writers_.size(), 1u);
2380 const std::string& name = zip_location_.empty() ? dex_locations_[0] : zip_location_;
2381 DCHECK(!name.empty());
2382 if (!oat_writers_[0]->AddVdexDexFilesSource(*input_vdex_file_.get(), name.c_str())) {
2383 return false;
2384 }
2385 } else if (zip_fd_ != -1) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002386 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002387 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2388 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002389 return false;
2390 }
2391 } else if (oat_writers_.size() > 1u) {
2392 // Multi-image.
2393 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2394 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2395 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2396 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2397 return false;
2398 }
2399 }
2400 } else {
2401 DCHECK_EQ(oat_writers_.size(), 1u);
2402 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2403 DCHECK_NE(dex_filenames_.size(), 0u);
2404 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2405 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2406 return false;
2407 }
2408 }
2409 }
2410 return true;
2411 }
2412
2413 void CreateOatWriters() {
2414 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2415 elf_writers_.reserve(oat_files_.size());
2416 oat_writers_.reserve(oat_files_.size());
2417 for (const std::unique_ptr<File>& oat_file : oat_files_) {
David Srbecky5d811202016-03-08 13:21:22 +00002418 elf_writers_.emplace_back(CreateElfWriterQuick(instruction_set_,
2419 instruction_set_features_.get(),
2420 compiler_options_.get(),
2421 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002422 elf_writers_.back()->Start();
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002423 const bool do_dexlayout = DoDexLayoutOptimizations();
Jeff Hao608f2ce2016-10-19 11:17:11 -07002424 oat_writers_.emplace_back(new OatWriter(
2425 IsBootImage(), timings_, do_dexlayout ? profile_compilation_info_.get() : nullptr));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002426 }
2427 }
2428
Vladimir Marko49b0f452015-12-10 13:49:19 +00002429 void SaveDexInput() {
2430 for (size_t i = 0; i < dex_files_.size(); ++i) {
2431 const DexFile* dex_file = dex_files_[i];
2432 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2433 getpid(), i));
2434 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2435 if (tmp_file.get() == nullptr) {
2436 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2437 << ". Try: adb shell chmod 777 /data/local/tmp";
2438 continue;
2439 }
2440 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2441 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2442 UNUSED(tmp_file->Flush());
2443 UNUSED(tmp_file->Close());
2444 LOG(INFO) << "Wrote input to " << tmp_file_name;
2445 }
2446 }
2447
2448 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options) {
2449 RuntimeOptions raw_options;
2450 if (boot_image_filename_.empty()) {
2451 std::string boot_class_path = "-Xbootclasspath:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002452 boot_class_path += android::base::Join(dex_filenames_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002453 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2454 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002455 boot_class_path_locations += android::base::Join(dex_locations_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002456 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2457 } else {
2458 std::string boot_image_option = "-Ximage:";
2459 boot_image_option += boot_image_filename_;
2460 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2461 }
2462 for (size_t i = 0; i < runtime_args_.size(); i++) {
2463 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2464 }
2465
2466 raw_options.push_back(std::make_pair("compilercallbacks", callbacks_.get()));
2467 raw_options.push_back(
2468 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2469
2470 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2471 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2472 // have been stripped in preopting, anyways).
2473 if (!IsBootImage()) {
2474 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2475 }
Andreas Gampec8e35202017-04-28 15:47:12 -07002476 // Never allow implicit image compilation.
2477 raw_options.push_back(std::make_pair("-Xnoimage-dex2oat", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002478 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2479 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2480 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002481 // Disable Hspace compaction to save heap size virtual space.
2482 // Only need disable Hspace for OOM becasue background collector is equal to
2483 // foreground collector by default for dex2oat.
2484 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002485
Andreas Gampeace0dc12016-01-20 13:33:13 -08002486 if (compiler_options_->IsForceDeterminism()) {
Roland Levillainb81e9e92017-04-20 17:35:32 +01002487 // If we're asked to be deterministic, ensure non-concurrent GC for determinism.
2488 //
2489 // Note that with read barriers, this option is ignored, because Runtime::Init
2490 // overrides the foreground GC to be gc::kCollectorTypeCC when instantiating
2491 // gc::Heap. This is fine, as concurrent GC requests are not honored in dex2oat,
2492 // which uses an unstarted runtime.
Andreas Gampeace0dc12016-01-20 13:33:13 -08002493 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
Roland Levillainb81e9e92017-04-20 17:35:32 +01002494
Nicolas Geoffray7acddd82017-05-03 15:04:55 +01002495 // The default LOS implementation (map) is not deterministic. So disable it.
2496 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=disabled", nullptr));
Andreas Gampeace0dc12016-01-20 13:33:13 -08002497
2498 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2499 // compaction (done above) and ensure that neither foreground nor background collectors
2500 // are concurrent.
Roland Levillainb81e9e92017-04-20 17:35:32 +01002501 //
2502 // Likewise, this option is ignored with read barriers because Runtime::Init
2503 // overrides the background GC to be gc::kCollectorTypeCCBackground, but that's
2504 // fine too, for the same reason (see above).
Andreas Gampeace0dc12016-01-20 13:33:13 -08002505 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2506
2507 // To make identity hashcode deterministic, set a known seed.
2508 mirror::Object::SetHashCodeSeed(987654321U);
2509 }
2510
Vladimir Marko49b0f452015-12-10 13:49:19 +00002511 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2512 LOG(ERROR) << "Failed to parse runtime options";
2513 return false;
2514 }
2515 return true;
2516 }
2517
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002518 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002519 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2520 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002521 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002522 LOG(ERROR) << "Failed to create runtime";
2523 return false;
2524 }
Andreas Gampe49c144d2016-11-14 10:11:16 -08002525
2526 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2527 // "ps -a" don't change to non-descript "main."
2528 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2529
Vladimir Marko307dac92015-10-20 11:20:09 +01002530 runtime_.reset(Runtime::Current());
2531 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe8228cdf2017-05-30 15:03:54 -07002532 for (uint32_t i = 0; i < static_cast<uint32_t>(CalleeSaveType::kLastCalleeSaveType); ++i) {
2533 CalleeSaveType type = CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002534 if (!runtime_->HasCalleeSaveMethod(type)) {
2535 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002536 }
2537 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002538 runtime_->GetClassLinker()->FixupDexCaches(runtime_->GetResolutionMethod());
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002539
2540 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2541 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002542 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002543
Vladimir Marko307dac92015-10-20 11:20:09 +01002544 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002545
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002546 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2547 // Runtime::Start, give it away now so that we don't starve GC.
2548 Thread* self = Thread::Current();
2549 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002550
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002551 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002552 }
2553
Jeff Haodcdc85b2015-12-04 14:06:18 -08002554 // 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 -08002555 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002556 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002557 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002558 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002559 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002560 image_filenames_.push_back(app_image_file_name_.c_str());
2561 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002562 if (!image_writer_->Write(app_image_fd_,
2563 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002564 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002565 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002566 return false;
2567 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002568
Jeff Haodcdc85b2015-12-04 14:06:18 -08002569 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002570 dchecked_vector<uintptr_t> oat_data_begins;
2571 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2572 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002573 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002574 // Destroy ImageWriter before doing FixupElf.
2575 image_writer_.reset();
2576
Vladimir Marko944da602016-02-19 12:27:55 +00002577 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2578 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002579 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2580 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2581 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2582 if (oat_file.get() == nullptr) {
2583 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2584 return false;
2585 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002586
Vladimir Marko944da602016-02-19 12:27:55 +00002587 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002588 oat_file->Erase();
2589 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2590 return false;
2591 }
2592
2593 if (oat_file->FlushCloseOrErase()) {
2594 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2595 return false;
2596 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002597 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002598 }
2599
2600 return true;
2601 }
2602
2603 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002604 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2605 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002606 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002607 return ReadCommentedInputFromFile<std::unordered_set<std::string>>(image_classes_filename,
2608 &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002609 }
2610
2611 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002612 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002613 const char* zip_filename,
2614 const char* image_classes_filename,
2615 std::string* error_msg) {
2616 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002617 return ReadCommentedInputFromZip<std::unordered_set<std::string>>(zip_filename,
2618 image_classes_filename,
2619 &process,
2620 error_msg);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002621 }
2622
2623 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2624 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002625 template <typename T>
2626 static T* ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002627 const char* input_filename, std::function<std::string(const char*)>* process) {
2628 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2629 if (input_file.get() == nullptr) {
2630 LOG(ERROR) << "Failed to open input file " << input_filename;
2631 return nullptr;
2632 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002633 std::unique_ptr<T> result(
2634 ReadCommentedInputStream<T>(*input_file, process));
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002635 input_file->close();
2636 return result.release();
2637 }
2638
2639 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2640 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002641 template <typename T>
2642 static T* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002643 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002644 const char* input_filename,
2645 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002646 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002647 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2648 if (zip_archive.get() == nullptr) {
2649 return nullptr;
2650 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002651 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002652 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002653 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002654 zip_filename, error_msg->c_str());
2655 return nullptr;
2656 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002657 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2658 input_filename,
2659 error_msg));
2660 if (input_file.get() == nullptr) {
2661 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002662 zip_filename, error_msg->c_str());
2663 return nullptr;
2664 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002665 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2666 input_file->Size());
2667 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002668 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002669 }
2670
2671 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2672 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002673 template <typename T>
2674 static T* ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002675 std::istream& in_stream,
2676 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002677 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002678 while (in_stream.good()) {
2679 std::string dot;
2680 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08002681 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002682 continue;
2683 }
2684 if (process != nullptr) {
2685 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002686 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002687 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002688 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002689 }
2690 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002691 return output.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002692 }
2693
Mathieu Chartier49285c52014-12-02 15:43:48 -08002694 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002695 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2696 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002697 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampec560fc02014-07-16 09:57:39 -07002698 LOG(INFO) << "dex2oat took "
2699 << PrettyDuration(NanoTime() - start_ns_)
Andreas Gampecc967752016-12-12 13:49:00 -08002700 << " (" << PrettyDuration(ProcessCpuNanoTime() - start_cputime_ns_) << " cpu)"
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002701 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002702 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002703 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2704 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002705 }
2706
Jeff Haodcdc85b2015-12-04 14:06:18 -08002707 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2708 std::string res(image_filename);
2709 size_t last_slash = res.rfind('/');
2710 if (last_slash == std::string::npos || last_slash == 0) {
2711 return res;
2712 }
2713 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2714 if (penultimate_slash == std::string::npos) {
2715 return res;
2716 }
2717 // Check that the string in-between is the expected one.
2718 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2719 GetInstructionSetString(isa)) {
2720 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2721 return res;
2722 }
2723 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2724 }
2725
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002726 std::unique_ptr<CompilerOptions> compiler_options_;
2727 Compiler::Kind compiler_kind_;
2728
2729 InstructionSet instruction_set_;
2730 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2731
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002732 uint32_t image_file_location_oat_checksum_;
2733 uintptr_t image_file_location_oat_data_begin_;
2734 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002735 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2736
Vladimir Marko307dac92015-10-20 11:20:09 +01002737 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002738
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002739 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2740
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002741 std::unique_ptr<Runtime> runtime_;
2742
Calin Juravle1ce70852017-06-28 10:59:03 -07002743 // The spec describing how the class loader should be setup for compilation.
2744 std::unique_ptr<ClassLoaderContext> class_loader_context_;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002745
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002746 size_t thread_count_;
2747 uint64_t start_ns_;
Andreas Gampec560fc02014-07-16 09:57:39 -07002748 uint64_t start_cputime_ns_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002749 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002750 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002751 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002752 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002753 std::vector<const char*> oat_filenames_;
2754 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002755 int oat_fd_;
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00002756 int input_vdex_fd_;
2757 int output_vdex_fd_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002758 std::string input_vdex_;
Nicolas Geoffray4e868fa2017-04-21 17:16:44 +01002759 std::string output_vdex_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002760 std::unique_ptr<VdexFile> input_vdex_file_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002761 std::vector<const char*> dex_filenames_;
2762 std::vector<const char*> dex_locations_;
2763 int zip_fd_;
2764 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002765 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002766 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002767 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002768 uintptr_t image_base_;
2769 const char* image_classes_zip_filename_;
2770 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002771 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002772 const char* compiled_classes_zip_filename_;
2773 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002774 const char* compiled_methods_zip_filename_;
2775 const char* compiled_methods_filename_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002776 const char* passes_to_run_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002777 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2778 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002779 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002780 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Jeff Hao436183f2016-01-12 16:36:50 -08002781 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002782 bool is_host_;
2783 std::string android_root_;
Mathieu Chartier0b490842016-05-25 15:05:59 -07002784 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002785 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002786 std::string no_inline_from_string_;
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002787 std::vector<jobject> dex_caches_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002788 jobject class_loader_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002789
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002790 std::vector<std::unique_ptr<ElfWriter>> elf_writers_;
2791 std::vector<std::unique_ptr<OatWriter>> oat_writers_;
2792 std::vector<OutputStream*> rodata_;
David Brazdil5d5a36b2016-09-14 15:34:10 +01002793 std::vector<std::unique_ptr<OutputStream>> vdex_out_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002794 std::unique_ptr<ImageWriter> image_writer_;
2795 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002796
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002797 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
2798 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2799
Calin Juravle1ce70852017-06-28 10:59:03 -07002800 // Note that this might contain pointers owned by class_loader_context_.
Vladimir Marko47496c22016-01-27 16:15:08 +00002801 std::vector<const DexFile*> no_inline_from_dex_files_;
2802
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002803 bool dump_stats_;
2804 bool dump_passes_;
2805 bool dump_timing_;
2806 bool dump_slow_timing_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002807 std::string swap_file_name_;
2808 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002809 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2810 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002811 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002812 std::string app_image_file_name_;
2813 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002814 std::string profile_file_;
2815 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002816 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002817 TimingLogger* timings_;
2818 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002819 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002820 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002821
2822 // Backing storage.
2823 std::vector<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002824
Andreas Gampeace0dc12016-01-20 13:33:13 -08002825 // See CompilerOptions.force_determinism_.
2826 bool force_determinism_;
2827
Jeff Hao16d48432017-04-05 17:05:46 -07002828 // Directory of relative classpaths.
2829 std::string classpath_dir_;
2830
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00002831 // Whether the given input vdex is also the output.
2832 bool update_input_vdex_ = false;
2833
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002834 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2835};
2836
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002837static void b13564922() {
2838#if defined(__linux__) && defined(__arm__)
2839 int major, minor;
2840 struct utsname uts;
2841 if (uname(&uts) != -1 &&
2842 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2843 ((major < 3) || ((major == 3) && (minor < 4)))) {
2844 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2845 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2846 int old_personality = personality(0xffffffff);
2847 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2848 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2849 if (new_personality == -1) {
2850 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2851 }
2852 }
2853 }
2854#endif
2855}
2856
Andreas Gampe7b565912017-03-20 15:48:52 -07002857static dex2oat::ReturnCode CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002858 dex2oat.LoadClassProfileDescriptors();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002859 dex2oat.Compile();
2860
David Brazdil7b49e6c2016-09-01 11:06:18 +01002861 if (!dex2oat.WriteOutputFiles()) {
2862 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002863 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002864 }
2865
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002866 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2867 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2868 // image writer will require this fd to generate the image.
2869 if (dex2oat.ShouldKeepOatFileOpen()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002870 if (!dex2oat.FlushOutputFiles()) {
2871 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002872 return dex2oat::ReturnCode::kOther;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002873 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01002874 } else if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002875 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002876 }
2877
Jeff Haodcdc85b2015-12-04 14:06:18 -08002878 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002879 if (!dex2oat.HandleImage()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002880 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002881 }
2882
2883 // When given --host, finish early without stripping.
2884 if (dex2oat.IsHost()) {
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002885 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002886 return dex2oat::ReturnCode::kOther;
Mathieu Chartier00bf2602017-03-02 10:14:08 -08002887 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002888 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002889 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002890 }
2891
Jeff Haodcdc85b2015-12-04 14:06:18 -08002892 // Copy stripped to unstripped location, if necessary.
2893 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002894 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002895 }
2896
Jeff Haodcdc85b2015-12-04 14:06:18 -08002897 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002898 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002899 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002900 }
2901
2902 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002903 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002904}
2905
Andreas Gampe7b565912017-03-20 15:48:52 -07002906static dex2oat::ReturnCode CompileApp(Dex2Oat& dex2oat) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002907 dex2oat.Compile();
2908
David Brazdil7b49e6c2016-09-01 11:06:18 +01002909 if (!dex2oat.WriteOutputFiles()) {
2910 dex2oat.EraseOutputFiles();
Andreas Gampe7b565912017-03-20 15:48:52 -07002911 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002912 }
2913
Jeff Haodcdc85b2015-12-04 14:06:18 -08002914 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002915 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002916
2917 // When given --host, finish early without stripping.
2918 if (dex2oat.IsHost()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002919 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002920 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002921 }
2922
2923 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002924 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002925 }
2926
Jeff Haodcdc85b2015-12-04 14:06:18 -08002927 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2928 // stripped versions. If this is given, we expect to be able to open writable files by name.
2929 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002930 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002931 }
2932
Jeff Haodcdc85b2015-12-04 14:06:18 -08002933 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002934 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002935 return dex2oat::ReturnCode::kOther;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002936 }
2937
2938 dex2oat.DumpTiming();
Andreas Gampe7b565912017-03-20 15:48:52 -07002939 return dex2oat::ReturnCode::kNoFailure;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002940}
2941
Andreas Gampe7b565912017-03-20 15:48:52 -07002942static dex2oat::ReturnCode Dex2oat(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002943 b13564922();
2944
2945 TimingLogger timings("compiler", false, false);
2946
Roland Levillain5c7e2602016-02-23 18:08:53 +00002947 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
2948 // might produce a stack frame too large for this function or for
2949 // functions inlining it (such as main), that would not fit the
2950 // requirements of the `-Wframe-larger-than` option.
Andreas Gampe8bdda5a2017-06-08 15:30:36 -07002951 std::unique_ptr<Dex2Oat> dex2oat = std::make_unique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002952
2953 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002954 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002955
Calin Juravleb077e152016-02-18 18:47:37 +00002956 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02002957 // This operation involves I/O.
Mathieu Chartier11b3df32017-02-21 13:41:54 -08002958 if (dex2oat->UseProfile()) {
Calin Juravleb077e152016-02-18 18:47:37 +00002959 if (!dex2oat->LoadProfile()) {
2960 LOG(ERROR) << "Failed to process profile file";
Andreas Gampe7b565912017-03-20 15:48:52 -07002961 return dex2oat::ReturnCode::kOther;
Calin Juravle998c2162015-12-21 15:39:33 +02002962 }
2963 }
2964
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002965 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap, and vdex.
2966
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002967 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00002968 if (!dex2oat->OpenFile()) {
Andreas Gampe7b565912017-03-20 15:48:52 -07002969 return dex2oat::ReturnCode::kOther;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002970 }
2971
Andreas Gampe046c7062015-05-18 23:22:54 -07002972 // Print the complete line when any of the following is true:
2973 // 1) Debug build
2974 // 2) Compiling an image
2975 // 3) Compiling with --host
2976 // 4) Compiling on the host (not a target build)
2977 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002978 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07002979 LOG(INFO) << CommandLine();
2980 } else {
2981 LOG(INFO) << StrippedCommandLine();
2982 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002983
Andreas Gampef7882972017-03-20 16:35:24 -07002984 dex2oat::ReturnCode setup_code = dex2oat->Setup();
2985 if (setup_code != dex2oat::ReturnCode::kNoFailure) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002986 dex2oat->EraseOutputFiles();
Andreas Gampef7882972017-03-20 16:35:24 -07002987 return setup_code;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002988 }
2989
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07002990 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
2991 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07002992 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
2993
Andreas Gampe7b565912017-03-20 15:48:52 -07002994 dex2oat::ReturnCode result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00002995 if (dex2oat->IsImage()) {
2996 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002997 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00002998 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002999 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003000
Roland Levillain5c7e2602016-02-23 18:08:53 +00003001 dex2oat->Shutdown();
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07003002 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003003}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003004} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07003005
3006int main(int argc, char** argv) {
Andreas Gampe7b565912017-03-20 15:48:52 -07003007 int result = static_cast<int>(art::Dex2oat(argc, argv));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003008 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
3009 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
3010 // should not destruct the runtime in this case.
Evgenii Stepanov1e133742015-05-20 12:30:59 -07003011 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampee286b642017-04-13 12:20:42 -07003012 _exit(result);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08003013 }
3014 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07003015}