blob: 21b03eb8bacf62906a7240d00baec336a5542d7e [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"
Ian Rogersc7dd2952014-10-21 23:31:19 -070042#include "base/dumpable.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080043#include "base/macros.h"
Calin Juravle2e2db782016-02-23 12:00:03 +000044#include "base/scoped_flock.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070045#include "base/stl_util.h"
46#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010047#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070048#include "base/timing_logger.h"
49#include "base/unix_file/fd_file.h"
50#include "class_linker.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000051#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000052#include "compiler_callbacks.h"
David Srbecky09c2a6b2016-03-11 17:11:44 +000053#include "debug/elf_debug_writer.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000054#include "debug/method_debug_info.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000055#include "dex/quick_compiler_callbacks.h"
56#include "dex/verification_results.h"
57#include "dex_file-inl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070058#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080059#include "driver/compiler_options.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080060#include "elf_file.h"
Tong Shen62d1ca32014-09-03 17:24:56 -070061#include "elf_writer.h"
Vladimir Marko10c13562015-11-25 14:33:36 +000062#include "elf_writer_quick.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070063#include "gc/space/image_space.h"
64#include "gc/space/space-inl.h"
65#include "image_writer.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070066#include "interpreter/unstarted_runtime.h"
Calin Juravle998c2162015-12-21 15:39:33 +020067#include "jit/offline_profiling_info.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070068#include "leb128.h"
David Brazdil5d5a36b2016-09-14 15:34:10 +010069#include "linker/buffered_output_stream.h"
70#include "linker/file_output_stream.h"
Vladimir Marko944da602016-02-19 12:27:55 +000071#include "linker/multi_oat_relative_patcher.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070072#include "mirror/class-inl.h"
73#include "mirror/class_loader.h"
74#include "mirror/object-inl.h"
75#include "mirror/object_array-inl.h"
Jeff Haob11ffb72016-04-07 15:40:54 -070076#include "oat_file_assistant.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070077#include "oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070078#include "os.h"
79#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000080#include "runtime_options.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070081#include "ScopedLocalRef.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070082#include "scoped_thread_state_change-inl.h"
Alex Light53cb16b2014-06-12 11:26:29 -070083#include "utils.h"
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +000084#include "vdex_file.h"
David Brazdilca3c8c32016-09-06 14:04:48 +010085#include "verifier/verifier_deps.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070086#include "well_known_classes.h"
87#include "zip_archive.h"
88
89namespace art {
90
Andreas Gampe46ee31b2016-12-14 10:11:49 -080091using android::base::StringAppendV;
92using android::base::StringPrintf;
93
Andreas Gampee1459ae2016-06-29 09:36:30 -070094static constexpr size_t kDefaultMinDexFilesForSwap = 2;
95static constexpr size_t kDefaultMinDexFileCumulativeSizeForSwap = 20 * MB;
96
Brian Carlstrom6449c622014-02-10 23:48:36 -080097static int original_argc;
98static char** original_argv;
99
100static std::string CommandLine() {
101 std::vector<std::string> command;
102 for (int i = 0; i < original_argc; ++i) {
103 command.push_back(original_argv[i]);
104 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800105 return android::base::Join(command, ' ');
Brian Carlstrom6449c622014-02-10 23:48:36 -0800106}
107
Andreas Gampe046c7062015-05-18 23:22:54 -0700108// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
109// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
110// locations are all staged).
111static std::string StrippedCommandLine() {
112 std::vector<std::string> command;
113
114 // Do a pre-pass to look for zip-fd.
115 bool saw_zip_fd = false;
116 for (int i = 0; i < original_argc; ++i) {
Andreas Gampe9186ced2016-12-12 14:28:21 -0800117 if (android::base::StartsWith(original_argv[i], "--zip-fd=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700118 saw_zip_fd = true;
119 break;
120 }
121 }
122
123 // Now filter out things.
124 for (int i = 0; i < original_argc; ++i) {
125 // All runtime-arg parameters are dropped.
126 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
127 i++; // Drop the next part, too.
128 continue;
129 }
130
131 // Any instruction-setXXX is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800132 if (android::base::StartsWith(original_argv[i], "--instruction-set")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700133 continue;
134 }
135
136 // The boot image is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800137 if (android::base::StartsWith(original_argv[i], "--boot-image=")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700138 continue;
139 }
140
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800141 // The image format is dropped.
Andreas Gampe9186ced2016-12-12 14:28:21 -0800142 if (android::base::StartsWith(original_argv[i], "--image-format=")) {
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800143 continue;
144 }
145
Andreas Gampe046c7062015-05-18 23:22:54 -0700146 // This should leave any dex-file and oat-file options, describing what we compiled.
147
148 // However, we prefer to drop this when we saw --zip-fd.
149 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700150 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe9186ced2016-12-12 14:28:21 -0800151 if (android::base::StartsWith(original_argv[i], "--zip-") ||
152 android::base::StartsWith(original_argv[i], "--dex-") ||
153 android::base::StartsWith(original_argv[i], "--oat-") ||
154 android::base::StartsWith(original_argv[i], "--swap-") ||
155 android::base::StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700156 continue;
157 }
158 }
159
160 command.push_back(original_argv[i]);
161 }
162
163 // Construct the final output.
164 if (command.size() <= 1U) {
165 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
166 return "Starting dex2oat.";
167 }
Andreas Gampe9186ced2016-12-12 14:28:21 -0800168 return android::base::Join(command, ' ');
Andreas Gampe046c7062015-05-18 23:22:54 -0700169}
170
Brian Carlstrom7940e442013-07-12 13:46:57 -0700171static void UsageErrorV(const char* fmt, va_list ap) {
172 std::string error;
173 StringAppendV(&error, fmt, ap);
174 LOG(ERROR) << error;
175}
176
177static void UsageError(const char* fmt, ...) {
178 va_list ap;
179 va_start(ap, fmt);
180 UsageErrorV(fmt, ap);
181 va_end(ap);
182}
183
Andreas Gampe794ad762015-02-23 08:12:24 -0800184NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700185 va_list ap;
186 va_start(ap, fmt);
187 UsageErrorV(fmt, ap);
188 va_end(ap);
189
Brian Carlstrom6449c622014-02-10 23:48:36 -0800190 UsageError("Command: %s", CommandLine().c_str());
191
Brian Carlstrom7940e442013-07-12 13:46:57 -0700192 UsageError("Usage: dex2oat [options]...");
193 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100194 UsageError(" -j<number>: specifies the number of threads used for compilation.");
195 UsageError(" Default is the number of detected hardware threads available on the");
196 UsageError(" host system.");
197 UsageError(" Example: -j12");
198 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700199 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700200 UsageError(" Example: --dex-file=/system/framework/core.jar");
201 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700202 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
203 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
204 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
205 UsageError(" --dex-location=/system/framework/core.jar");
206 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700207 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
208 UsageError(" containing a classes.dex file to compile.");
209 UsageError(" Example: --zip-fd=5");
210 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700211 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
212 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700213 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
214 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800215 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700216 UsageError(" Example: --oat-file=/system/framework/boot.oat");
217 UsageError("");
218 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900219 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700220 UsageError("");
221 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
222 UsageError(" to the file descriptor specified by --oat-fd.");
223 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
224 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800225 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700226 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
227 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800228 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700229 UsageError(" Example: --image=/system/framework/boot.art");
230 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800231 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800232 UsageError(" Which format to store the image.");
233 UsageError(" Example: --image-format=lz4");
234 UsageError(" Default: uncompressed");
235 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700236 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
237 UsageError(" Example: --image=frameworks/base/preloaded-classes");
238 UsageError("");
239 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
240 UsageError(" Example: --base=0x50000000");
241 UsageError("");
242 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000243 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700244 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000245 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000246 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700247 UsageError("");
248 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
249 UsageError(" Example: --android-root=out/host/linux-x86");
250 UsageError(" Default: $ANDROID_ROOT");
251 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800252 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700253 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700254 UsageError(" Example: --instruction-set=x86");
255 UsageError(" Default: arm");
256 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700257 UsageError(" --instruction-set-features=...,: Specify instruction set features");
258 UsageError(" Example: --instruction-set-features=div");
259 UsageError(" Default: default");
260 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700261 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
262 UsageError(" Default: disabled");
263 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800264 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700265 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800266 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100267 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700268 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100269 UsageError(" --compiler-filter="
270 "(verify-none"
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700271 "|verify-at-runtime"
Mathieu Chartiera8077802016-03-16 19:08:31 -0700272 "|verify-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100273 "|interpret-only"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000274 "|time"
275 "|space-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100276 "|space"
277 "|balanced"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000278 "|speed-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100279 "|speed"
Jeff Hao608f2ce2016-10-19 11:17:11 -0700280 "|layout-profile"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000281 "|everything-profile"
282 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700283 UsageError(" select compiler filter.");
Mathieu Chartiera8077802016-03-16 19:08:31 -0700284 UsageError(" verify-profile requires a --profile(-fd) to also be passed in.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800285 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800286 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800287 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800288 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
289 UsageError(" method for compiler filter tuning.");
290 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
291 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
292 UsageError("");
293 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
294 UsageError(" method for compiler filter tuning.");
295 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
296 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
297 UsageError("");
298 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
299 UsageError(" method for compiler filter tuning.");
300 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
301 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
302 UsageError("");
303 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
304 UsageError(" method for compiler filter tuning.");
305 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
306 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
307 UsageError("");
308 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
309 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700310 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
311 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800312 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
313 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
314 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100315 UsageError(" --inline-depth-limit=<depth-limit>: the depth limit of inlining for fine tuning");
316 UsageError(" the compiler. A zero value will disable inlining. Honored only by Optimizing.");
Roland Levillaina215b952015-08-07 11:38:32 +0100317 UsageError(" Has priority over the --compiler-filter option. Intended for ");
318 UsageError(" development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100319 UsageError(" Example: --inline-depth-limit=%d", CompilerOptions::kDefaultInlineDepthLimit);
320 UsageError(" Default: %d", CompilerOptions::kDefaultInlineDepthLimit);
321 UsageError("");
322 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
323 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100324 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
325 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100326 UsageError(" Example: --inline-max-code-units=%d",
327 CompilerOptions::kDefaultInlineMaxCodeUnits);
328 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
329 UsageError("");
Ian Rogers46398602013-08-20 07:50:36 -0700330 UsageError(" --dump-timing: display a breakdown of where time was spent");
331 UsageError("");
Alex Light53cb16b2014-06-12 11:26:29 -0700332 UsageError(" --include-patch-information: Include patching information so the generated code");
333 UsageError(" can have its base address moved without full recompilation.");
334 UsageError("");
335 UsageError(" --no-include-patch-information: Do not include patching information.");
336 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100337 UsageError(" -g");
338 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
339 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000340 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000341 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700342 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100343 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100344 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000345 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
346 UsageError(" debug information necessary to print backtraces. (disabled by default)");
347 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000348 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000349 UsageError("");
Alexey Alexandrovab40c112016-09-19 09:33:49 -0700350 UsageError(" --generate-build-id: Generate GNU-compatible linker build ID ELF section with");
351 UsageError(" SHA-1 of the file content (and thus stable across identical builds)");
352 UsageError("");
353 UsageError(" --no-generate-build-id: Do not generate the build ID ELF section.");
354 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000355 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000356 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700357 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
358 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
359 UsageError(" Use a separate --runtime-arg switch for each argument.");
360 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700361 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000362 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700363 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000364 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
365 UsageError(" Cannot be used together with --profile-file.");
366 UsageError("");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800367 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
368 UsageError(" Example: --swap-file=/data/tmp/swap.001");
369 UsageError("");
370 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
371 UsageError(" Example: --swap-fd=10");
372 UsageError("");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700373 UsageError(" --swap-dex-size-threshold=<size>: specifies the minimum total dex file size in");
374 UsageError(" bytes to allow the use of swap.");
375 UsageError(" Example: --swap-dex-size-threshold=1000000");
376 UsageError(" Default: %zu", kDefaultMinDexFileCumulativeSizeForSwap);
377 UsageError("");
378 UsageError(" --swap-dex-count-threshold=<count>: specifies the minimum number of dex files to");
379 UsageError(" allow the use of swap.");
380 UsageError(" Example: --swap-dex-count-threshold=10");
381 UsageError(" Default: %zu", kDefaultMinDexFilesForSwap);
382 UsageError("");
Andreas Gampe67f02822016-06-24 21:05:23 -0700383 UsageError(" --very-large-app-threshold=<size>: specifies the minimum total dex file size in");
384 UsageError(" bytes to consider the input \"very large\" and punt on the compilation.");
385 UsageError(" Example: --very-large-app-threshold=100000000");
386 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700387 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
388 UsageError(" Example: --app-image-fd=10");
389 UsageError("");
390 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
391 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
392 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800393 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
394 "input dex file.");
395 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000396 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
397 UsageError(" This option is incompatible with read barriers (e.g., if dex2oat has been");
398 UsageError(" built with the environment variable `ART_USE_READ_BARRIER` set to `true`).");
399 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700400 std::cerr << "See log for usage error information\n";
401 exit(EXIT_FAILURE);
402}
403
Brian Carlstrom7940e442013-07-12 13:46:57 -0700404// The primary goal of the watchdog is to prevent stuck build servers
405// during development when fatal aborts lead to a cascade of failures
406// that result in a deadlock.
407class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800408// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700409#undef CHECK_PTHREAD_CALL
410#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
411 do { \
412 int rc = call args; \
413 if (rc != 0) { \
414 errno = rc; \
415 std::string message(# call); \
416 message += " failed for "; \
417 message += reason; \
418 Fatal(message); \
419 } \
420 } while (false)
421
422 public:
Brian Carlstrom93ba8932013-07-17 21:31:49 -0700423 explicit WatchDog(bool is_watch_dog_enabled) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700424 is_watch_dog_enabled_ = is_watch_dog_enabled;
425 if (!is_watch_dog_enabled_) {
426 return;
427 }
428 shutting_down_ = false;
429 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700430 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
431 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700432 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
433 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
434 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
435 }
436 ~WatchDog() {
437 if (!is_watch_dog_enabled_) {
438 return;
439 }
440 const char* reason = "dex2oat watch dog thread shutdown";
441 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
442 shutting_down_ = true;
443 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
444 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
445
Kenny Root51316382014-05-13 14:59:37 -0700446 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700447
448 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
449 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
450 }
451
452 private:
453 static void* CallBack(void* arg) {
454 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
455 ::art::SetThreadName("dex2oat watch dog");
456 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700457 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700458 }
459
Andreas Gampe794ad762015-02-23 08:12:24 -0800460 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700461 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
462 // it's rather easy to hang in unwinding.
463 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
464 // logcat logging or stderr output.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700465 android::base::LogMessage::LogLine(__FILE__,
466 __LINE__,
467 android::base::LogId::DEFAULT,
468 LogSeverity::FATAL,
469 message.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700470 exit(1);
471 }
472
473 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700474 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
475 // large.
Andreas Gamped687e372015-04-28 23:16:03 -0700476 constexpr int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700477 timespec timeout_ts;
478 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts);
479 const char* reason = "dex2oat watch dog thread waiting";
480 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
481 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800482 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700483 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700484 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
485 kWatchDogTimeoutSeconds));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700486 } else if (rc != 0) {
487 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
488 strerror(errno)));
489 Fatal(message.c_str());
490 }
491 }
492 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
493 }
494
495 // When setting timeouts, keep in mind that the build server may not be as fast as your desktop.
Mathieu Chartier13b9f432014-09-09 17:26:58 -0700496 // Debug builds are slower so they have larger timeouts.
Andreas Gamped687e372015-04-28 23:16:03 -0700497 static constexpr int64_t kSlowdownFactor = kIsDebugBuild ? 5U : 1U;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800498
Andreas Gampe540138a2015-09-14 15:34:38 -0700499 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
500 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
501 // itself before that watchdog would take down the system server.
502 static constexpr int64_t kWatchDogTimeoutSeconds = kSlowdownFactor * (9 * 60 + 30);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700503
504 bool is_watch_dog_enabled_;
505 bool shutting_down_;
506 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
507 pthread_mutex_t mutex_;
508 pthread_cond_t cond_;
509 pthread_attr_t attr_;
510 pthread_t pthread_;
511};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700512
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800513class Dex2Oat FINAL {
514 public:
515 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100516 compiler_kind_(Compiler::kOptimizing),
Artem Serovba6b6792016-08-15 14:22:07 +0100517 instruction_set_(kRuntimeISA == kArm ? kThumb2 : kRuntimeISA),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800518 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000519 image_file_location_oat_checksum_(0),
520 image_file_location_oat_data_begin_(0),
521 image_patch_delta_(0),
522 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700523 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800524 runtime_(nullptr),
525 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
526 start_ns_(NanoTime()),
Andreas Gampec560fc02014-07-16 09:57:39 -0700527 start_cputime_ns_(ProcessCpuNanoTime()),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800528 oat_fd_(-1),
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000529 input_vdex_fd_(-1),
530 output_vdex_fd_(-1),
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000531 input_vdex_file_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800532 zip_fd_(-1),
533 image_base_(0U),
534 image_classes_zip_filename_(nullptr),
535 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800536 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800537 compiled_classes_zip_filename_(nullptr),
538 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700539 compiled_methods_zip_filename_(nullptr),
540 compiled_methods_filename_(nullptr),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700541 passes_to_run_filename_(nullptr),
Jeff Hao436183f2016-01-12 16:36:50 -0800542 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800543 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000544 class_loader_(nullptr),
545 elf_writers_(),
546 oat_writers_(),
547 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000548 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700549 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000550 opened_dex_files_maps_(),
551 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000552 no_inline_from_dex_files_(),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800553 dump_stats_(false),
554 dump_passes_(false),
555 dump_timing_(false),
556 dump_slow_timing_(kIsDebugBuild),
Calin Juravle2e2db782016-02-23 12:00:03 +0000557 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800558 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000559 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800560 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000561 force_determinism_(false)
562 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800563
564 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800565 // Log completion time before deleting the runtime_, because this accesses
566 // the runtime.
567 LogCompletionTime();
568
Vladimir Marko307dac92015-10-20 11:20:09 +0100569 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
570 // We want to just exit on non-debug builds, not bringing the runtime down
571 // in an orderly fashion. So release the following fields.
572 driver_.release();
573 image_writer_.release();
574 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
575 dex_file.release();
576 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000577 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
578 map.release();
579 }
David Brazdil7b49e6c2016-09-01 11:06:18 +0100580 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
581 vdex_file.release();
582 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800583 for (std::unique_ptr<File>& oat_file : oat_files_) {
584 oat_file.release();
585 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100586 runtime_.release();
587 verification_results_.release();
588 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100589 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700590 }
591
Roland Levillain9ec5e222015-08-17 20:18:41 +0100592 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800593 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800594 std::string boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800595 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000596 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800597 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100598 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800599
Roland Levillain9ec5e222015-08-17 20:18:41 +0100600 void ParseZipFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000601 ParseUintOption(option, "--zip-fd", &zip_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100602 }
603
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000604 void ParseInputVdexFd(const StringPiece& option) {
605 // Note that the input vdex fd might be -1.
606 ParseIntOption(option, "--input-vdex-fd", &input_vdex_fd_, Usage);
607 }
608
609 void ParseOutputVdexFd(const StringPiece& option) {
610 ParseUintOption(option, "--output-vdex-fd", &output_vdex_fd_, Usage);
David Brazdil7b49e6c2016-09-01 11:06:18 +0100611 }
612
Roland Levillain9ec5e222015-08-17 20:18:41 +0100613 void ParseOatFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000614 ParseUintOption(option, "--oat-fd", &oat_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100615 }
616
Calin Juravle877fd962016-01-05 14:29:29 +0000617 void ParseFdForCollection(const StringPiece& option,
618 const char* arg_name,
619 std::vector<uint32_t>* fds) {
620 uint32_t fd;
621 ParseUintOption(option, arg_name, &fd, Usage);
622 fds->push_back(fd);
623 }
624
Roland Levillain9ec5e222015-08-17 20:18:41 +0100625 void ParseJ(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000626 ParseUintOption(option, "-j", &thread_count_, Usage, /* is_long_option */ false);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100627 }
628
629 void ParseBase(const StringPiece& option) {
630 DCHECK(option.starts_with("--base="));
631 const char* image_base_str = option.substr(strlen("--base=")).data();
632 char* end;
633 image_base_ = strtoul(image_base_str, &end, 16);
634 if (end == image_base_str || *end != '\0') {
635 Usage("Failed to parse hexadecimal value for option %s", option.data());
636 }
637 }
638
639 void ParseInstructionSet(const StringPiece& option) {
640 DCHECK(option.starts_with("--instruction-set="));
641 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
642 // StringPiece is not necessarily zero-terminated, so need to make a copy and ensure it.
643 std::unique_ptr<char[]> buf(new char[instruction_set_str.length() + 1]);
644 strncpy(buf.get(), instruction_set_str.data(), instruction_set_str.length());
645 buf.get()[instruction_set_str.length()] = 0;
646 instruction_set_ = GetInstructionSetFromString(buf.get());
647 // arm actually means thumb2.
648 if (instruction_set_ == InstructionSet::kArm) {
649 instruction_set_ = InstructionSet::kThumb2;
650 }
651 }
652
653 void ParseInstructionSetVariant(const StringPiece& option, ParserOptions* parser_options) {
654 DCHECK(option.starts_with("--instruction-set-variant="));
655 StringPiece str = option.substr(strlen("--instruction-set-variant=")).data();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800656 instruction_set_features_ = InstructionSetFeatures::FromVariant(
657 instruction_set_, str.as_string(), &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100658 if (instruction_set_features_.get() == nullptr) {
659 Usage("%s", parser_options->error_msg.c_str());
660 }
661 }
662
663 void ParseInstructionSetFeatures(const StringPiece& option, ParserOptions* parser_options) {
664 DCHECK(option.starts_with("--instruction-set-features="));
665 StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800666 if (instruction_set_features_ == nullptr) {
667 instruction_set_features_ = InstructionSetFeatures::FromVariant(
668 instruction_set_, "default", &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100669 if (instruction_set_features_.get() == nullptr) {
670 Usage("Problem initializing default instruction set features variant: %s",
671 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700672 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800673 }
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800674 instruction_set_features_ =
Roland Levillain9ec5e222015-08-17 20:18:41 +0100675 instruction_set_features_->AddFeaturesFromString(str.as_string(),
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800676 &parser_options->error_msg);
677 if (instruction_set_features_ == nullptr) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100678 Usage("Error parsing '%s': %s", option.data(), parser_options->error_msg.c_str());
679 }
680 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800681
Roland Levillain9ec5e222015-08-17 20:18:41 +0100682 void ParseCompilerBackend(const StringPiece& option, ParserOptions* parser_options) {
683 DCHECK(option.starts_with("--compiler-backend="));
684 parser_options->requested_specific_compiler = true;
685 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
686 if (backend_str == "Quick") {
687 compiler_kind_ = Compiler::kQuick;
688 } else if (backend_str == "Optimizing") {
689 compiler_kind_ = Compiler::kOptimizing;
690 } else {
691 Usage("Unknown compiler backend: %s", backend_str.data());
692 }
693 }
694
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800695 void ParseImageFormat(const StringPiece& option) {
696 const StringPiece substr("--image-format=");
697 DCHECK(option.starts_with(substr));
698 const StringPiece format_str = option.substr(substr.length());
699 if (format_str == "lz4") {
700 image_storage_mode_ = ImageHeader::kStorageModeLZ4;
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800701 } else if (format_str == "lz4hc") {
702 image_storage_mode_ = ImageHeader::kStorageModeLZ4HC;
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800703 } else if (format_str == "uncompressed") {
704 image_storage_mode_ = ImageHeader::kStorageModeUncompressed;
705 } else {
706 Usage("Unknown image format: %s", format_str.data());
707 }
708 }
709
Jeff Hao436183f2016-01-12 16:36:50 -0800710 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoaad75c62016-10-03 08:46:48 +0000711 compiler_options_->boot_image_ = !image_filenames_.empty();
712 compiler_options_->app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700713
714 if (IsAppImage() && IsBootImage()) {
715 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
716 }
717
Jeff Haodcdc85b2015-12-04 14:06:18 -0800718 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800719 Usage("Output must be supplied with either --oat-file or --oat-fd");
720 }
721
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +0000722 if (input_vdex_fd_ != -1 && !input_vdex_.empty()) {
723 Usage("Can't have both --input-vdex-fd and --input-vdex");
724 }
725
Jeff Haodcdc85b2015-12-04 14:06:18 -0800726 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800727 Usage("--oat-file should not be used with --oat-fd");
728 }
729
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000730 if ((output_vdex_fd_ == -1) != (oat_fd_ == -1)) {
David Brazdil7b49e6c2016-09-01 11:06:18 +0100731 Usage("VDEX and OAT output must be specified either with one --oat-filename "
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000732 "or with --oat-fd and --output-vdex-fd file descriptors");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100733 }
734
Roland Levillain9ec5e222015-08-17 20:18:41 +0100735 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800736 Usage("--oat-symbols should not be used with --oat-fd");
737 }
738
Roland Levillain9ec5e222015-08-17 20:18:41 +0100739 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800740 Usage("--oat-symbols should not be used with --host");
741 }
742
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000743 if (output_vdex_fd_ != -1 && !image_filenames_.empty()) {
744 Usage("--output-vdex-fd should not be used with --image");
David Brazdil7b49e6c2016-09-01 11:06:18 +0100745 }
746
Jeff Haodcdc85b2015-12-04 14:06:18 -0800747 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800748 Usage("--oat-fd should not be used with --image");
749 }
750
Jeff Haodcdc85b2015-12-04 14:06:18 -0800751 if (!parser_options->oat_symbols.empty() &&
752 parser_options->oat_symbols.size() != oat_filenames_.size()) {
753 Usage("--oat-file arguments do not match --oat-symbols arguments");
754 }
755
756 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
757 Usage("--oat-file arguments do not match --image arguments");
758 }
759
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800760 if (android_root_.empty()) {
761 const char* android_root_env_var = getenv("ANDROID_ROOT");
762 if (android_root_env_var == nullptr) {
763 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700764 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800765 android_root_ += android_root_env_var;
766 }
767
Vladimir Markoaad75c62016-10-03 08:46:48 +0000768 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100769 parser_options->boot_image_filename += android_root_;
770 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800771 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100772 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000773 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800774 }
775
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700776 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800777 Usage("--image-classes should only be used with --image");
778 }
779
Vladimir Marko49b0f452015-12-10 13:49:19 +0000780 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800781 Usage("--image-classes should not be used with --boot-image");
782 }
783
784 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
785 Usage("--image-classes-zip should be used with --image-classes");
786 }
787
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700788 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800789 Usage("--compiled-classes should only be used with --image");
790 }
791
Vladimir Marko49b0f452015-12-10 13:49:19 +0000792 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800793 Usage("--compiled-classes should not be used with --boot-image");
794 }
795
796 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
797 Usage("--compiled-classes-zip should be used with --compiled-classes");
798 }
799
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800800 if (dex_filenames_.empty() && zip_fd_ == -1) {
801 Usage("Input must be supplied with either --dex-file or --zip-fd");
802 }
803
804 if (!dex_filenames_.empty() && zip_fd_ != -1) {
805 Usage("--dex-file should not be used with --zip-fd");
806 }
807
808 if (!dex_filenames_.empty() && !zip_location_.empty()) {
809 Usage("--dex-file should not be used with --zip-location");
810 }
811
812 if (dex_locations_.empty()) {
813 for (const char* dex_file_name : dex_filenames_) {
814 dex_locations_.push_back(dex_file_name);
815 }
816 } else if (dex_locations_.size() != dex_filenames_.size()) {
817 Usage("--dex-location arguments do not match --dex-file arguments");
818 }
819
Jeff Haodcdc85b2015-12-04 14:06:18 -0800820 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
821 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
822 Usage("--oat-file arguments must be singular or match --dex-file arguments");
823 }
824 }
825
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800826 if (zip_fd_ != -1 && zip_location_.empty()) {
827 Usage("--zip-location should be supplied with --zip-fd");
828 }
829
Vladimir Marko49b0f452015-12-10 13:49:19 +0000830 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800831 if (image_base_ == 0) {
832 Usage("Non-zero --base not specified");
833 }
834 }
835
Mathieu Chartiera8077802016-03-16 19:08:31 -0700836 const bool have_profile_file = !profile_file_.empty();
837 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
838 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000839 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200840 }
841
Roland Levillain9ec5e222015-08-17 20:18:41 +0100842 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800843 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800844 }
845
846 // If no instruction set feature was given, use the default one for the target
847 // instruction set.
848 if (instruction_set_features_.get() == nullptr) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800849 instruction_set_features_ = InstructionSetFeatures::FromVariant(
850 instruction_set_, "default", &parser_options->error_msg);
Ian Rogersd582fa42014-11-05 23:46:43 -0800851 if (instruction_set_features_.get() == nullptr) {
852 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100853 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800854 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800855 }
856
857 if (instruction_set_ == kRuntimeISA) {
858 std::unique_ptr<const InstructionSetFeatures> runtime_features(
859 InstructionSetFeatures::FromCppDefines());
860 if (!instruction_set_features_->Equals(runtime_features.get())) {
861 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
862 << *instruction_set_features_ << ") and those of dex2oat executable ("
863 << *runtime_features <<") for the command line:\n"
864 << CommandLine();
865 }
866 }
867
Roland Levillaina215b952015-08-07 11:38:32 +0100868 // It they are not set, use default values for inlining settings.
869 // TODO: We should rethink the compiler filter. We mostly save
870 // time here, which is orthogonal to space.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000871 if (compiler_options_->inline_depth_limit_ == CompilerOptions::kUnsetInlineDepthLimit) {
872 compiler_options_->inline_depth_limit_ =
Andreas Gampe29d38e72016-03-23 15:31:51 +0000873 (compiler_options_->compiler_filter_ == CompilerFilter::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100874 // Implementation of the space filter: limit inlining depth.
875 ? CompilerOptions::kSpaceFilterInlineDepthLimit
876 : CompilerOptions::kDefaultInlineDepthLimit;
877 }
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000878 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
879 compiler_options_->inline_max_code_units_ =
Andreas Gampe29d38e72016-03-23 15:31:51 +0000880 (compiler_options_->compiler_filter_ == CompilerFilter::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100881 // Implementation of the space filter: limit inlining max code units.
882 ? CompilerOptions::kSpaceFilterInlineMaxCodeUnits
883 : CompilerOptions::kDefaultInlineMaxCodeUnits;
884 }
885
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800886 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800887 // Set the compilation target's implicit checks options.
888 switch (instruction_set_) {
889 case kArm:
890 case kThumb2:
891 case kArm64:
892 case kX86:
893 case kX86_64:
Douglas Leung22bb5a22015-07-02 16:42:08 -0700894 case kMips:
895 case kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000896 compiler_options_->implicit_null_checks_ = true;
897 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800898 break;
899
900 default:
901 // Defaults are correct.
902 break;
903 }
904
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000905 compiler_options_->verbose_methods_ = verbose_methods_.empty() ? nullptr : &verbose_methods_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800906
Jeff Hao436183f2016-01-12 16:36:50 -0800907 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800908 Usage("--multi-image can only be used when creating boot images");
909 }
Jeff Hao436183f2016-01-12 16:36:50 -0800910 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800911 Usage("--multi-image cannot be used with multiple image names");
912 }
913
914 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
915 if (!kIsTargetBuild && IsBootImage()) {
916 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800917 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800918 }
919 }
920
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800921 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100922 if (parser_options->watch_dog_enabled) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800923 watchdog_.reset(new WatchDog(true));
924 }
925
926 // Fill some values into the key-value store for the oat header.
927 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800928
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800929 // Automatically force determinism for the boot image in a host build if the default GC is CMS
930 // or MS and read barriers are not enabled, as the former switches the GC to a non-concurrent
931 // one by passing the option `-Xgc:nonconcurrent` (see below).
932 if (!kIsTargetBuild && IsBootImage()) {
933 if (SupportsDeterministicCompilation()) {
934 force_determinism_ = true;
935 } else {
936 LOG(WARNING) << "Deterministic compilation is disabled.";
937 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800938 }
939 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700940
941 if (passes_to_run_filename_ != nullptr) {
942 passes_to_run_.reset(ReadCommentedInputFromFile<std::vector<std::string>>(
943 passes_to_run_filename_,
944 nullptr)); // No post-processing.
945 if (passes_to_run_.get() == nullptr) {
946 Usage("Failed to read list of passes to run.");
947 }
948 }
949 compiler_options_->passes_to_run_ = passes_to_run_.get();
Roland Levillain9ec5e222015-08-17 20:18:41 +0100950 }
951
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800952 static bool SupportsDeterministicCompilation() {
953 return (gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
954 gc::kCollectorTypeDefault == gc::kCollectorTypeMS) &&
955 !kEmitCompilerReadBarrier;
956 }
957
Jeff Hao436183f2016-01-12 16:36:50 -0800958 void ExpandOatAndImageFilenames() {
959 std::string base_oat = oat_filenames_[0];
960 size_t last_oat_slash = base_oat.rfind('/');
961 if (last_oat_slash == std::string::npos) {
962 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
963 }
964 // We also need to honor path components that were encoded through '@'. Otherwise the loading
965 // code won't be able to find the images.
966 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
967 last_oat_slash = base_oat.rfind('@');
968 }
969 base_oat = base_oat.substr(0, last_oat_slash + 1);
970
971 std::string base_img = image_filenames_[0];
972 size_t last_img_slash = base_img.rfind('/');
973 if (last_img_slash == std::string::npos) {
974 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
975 }
976 // We also need to honor path components that were encoded through '@'. Otherwise the loading
977 // code won't be able to find the images.
978 if (base_img.find('@', last_img_slash) != std::string::npos) {
979 last_img_slash = base_img.rfind('@');
980 }
981
982 // Get the prefix, which is the primary image name (without path components). Strip the
983 // extension.
984 std::string prefix = base_img.substr(last_img_slash + 1);
985 if (prefix.rfind('.') != std::string::npos) {
986 prefix = prefix.substr(0, prefix.rfind('.'));
987 }
988 if (!prefix.empty()) {
989 prefix = prefix + "-";
990 }
991
992 base_img = base_img.substr(0, last_img_slash + 1);
993
994 // Note: we have some special case here for our testing. We have to inject the differentiating
995 // parts for the different core images.
996 std::string infix; // Empty infix by default.
997 {
998 // Check the first name.
999 std::string dex_file = oat_filenames_[0];
1000 size_t last_dex_slash = dex_file.rfind('/');
1001 if (last_dex_slash != std::string::npos) {
1002 dex_file = dex_file.substr(last_dex_slash + 1);
1003 }
1004 size_t last_dex_dot = dex_file.rfind('.');
1005 if (last_dex_dot != std::string::npos) {
1006 dex_file = dex_file.substr(0, last_dex_dot);
1007 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001008 if (android::base::StartsWith(dex_file, "core-")) {
Jeff Hao436183f2016-01-12 16:36:50 -08001009 infix = dex_file.substr(strlen("core"));
1010 }
1011 }
1012
bowen_lai8bd36c02016-10-12 13:28:55 +08001013 std::string base_symbol_oat;
1014 if (!oat_unstripped_.empty()) {
1015 base_symbol_oat = oat_unstripped_[0];
1016 size_t last_symbol_oat_slash = base_symbol_oat.rfind('/');
1017 if (last_symbol_oat_slash == std::string::npos) {
1018 Usage("--multi-image used with unusable symbol filename %s", base_symbol_oat.c_str());
1019 }
1020 base_symbol_oat = base_symbol_oat.substr(0, last_symbol_oat_slash + 1);
1021 }
1022
1023 const size_t num_expanded_files = 2 + (base_symbol_oat.empty() ? 0 : 1);
1024 char_backing_storage_.reserve((dex_locations_.size() - 1) * num_expanded_files);
Ben Gruvera0fc3262016-09-30 13:10:42 -07001025
Jeff Hao436183f2016-01-12 16:36:50 -08001026 // Now create the other names. Use a counted loop to skip the first one.
1027 for (size_t i = 1; i < dex_locations_.size(); ++i) {
1028 // TODO: Make everything properly std::string.
1029 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
1030 char_backing_storage_.push_back(base_img + image_name);
1031 image_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
1032
1033 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
1034 char_backing_storage_.push_back(base_oat + oat_name);
1035 oat_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001036
1037 if (!base_symbol_oat.empty()) {
1038 char_backing_storage_.push_back(base_symbol_oat + oat_name);
1039 oat_unstripped_.push_back((char_backing_storage_.end() - 1)->c_str());
1040 }
Jeff Hao436183f2016-01-12 16:36:50 -08001041 }
1042 }
1043
Andreas Gampe8994a042015-12-30 19:03:17 +00001044 // Modify the input string in the following way:
1045 // 0) Assume input is /a/b/c.d
1046 // 1) Strip the path -> c.d
1047 // 2) Inject prefix p -> pc.d
1048 // 3) Inject infix i -> pci.d
1049 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -08001050 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +00001051 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001052 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +00001053 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001054 size_t last_dex_slash = in.rfind('/');
1055 if (last_dex_slash != std::string::npos) {
1056 in = in.substr(last_dex_slash + 1);
1057 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001058 if (!prefix.empty()) {
1059 in = prefix + in;
1060 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001061 if (!infix.empty()) {
1062 // Inject infix.
1063 size_t last_dot = in.rfind('.');
1064 if (last_dot != std::string::npos) {
1065 in.insert(last_dot, infix);
1066 }
1067 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001068 if (android::base::EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001069 in = in.substr(0, in.length() - strlen(".jar")) +
1070 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001071 }
1072 return in;
1073 }
1074
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001075 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001076 std::ostringstream oss;
1077 for (int i = 0; i < argc; ++i) {
1078 if (i > 0) {
1079 oss << ' ';
1080 }
1081 oss << argv[i];
1082 }
1083 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1084 oss.str(""); // Reset.
1085 oss << kRuntimeISA;
1086 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1087 key_value_store_->Put(
1088 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001089 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001090 key_value_store_->Put(
1091 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001092 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001093 key_value_store_->Put(
1094 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001095 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001096 key_value_store_->Put(OatHeader::kCompilerFilter,
1097 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Roland Levillain9ec5e222015-08-17 20:18:41 +01001098 }
1099
1100 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1101 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1102 // returns, arguments have been successfully parsed.
1103 void ParseArgs(int argc, char** argv) {
1104 original_argc = argc;
1105 original_argv = argv;
1106
David Sehrf57589f2016-10-17 10:09:33 -07001107 InitLogging(argv, Runtime::Aborter);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001108
1109 // Skip over argv[0].
1110 argv++;
1111 argc--;
1112
1113 if (argc == 0) {
1114 Usage("No arguments specified");
1115 }
1116
1117 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001118 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001119
1120 for (int i = 0; i < argc; i++) {
1121 const StringPiece option(argv[i]);
1122 const bool log_options = false;
1123 if (log_options) {
1124 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1125 }
1126 if (option.starts_with("--dex-file=")) {
1127 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data());
1128 } else if (option.starts_with("--dex-location=")) {
1129 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data());
1130 } else if (option.starts_with("--zip-fd=")) {
1131 ParseZipFd(option);
1132 } else if (option.starts_with("--zip-location=")) {
1133 zip_location_ = option.substr(strlen("--zip-location=")).data();
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001134 } else if (option.starts_with("--input-vdex-fd=")) {
1135 ParseInputVdexFd(option);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001136 } else if (option.starts_with("--input-vdex=")) {
1137 input_vdex_ = option.substr(strlen("--input-vdex=")).data();
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001138 } else if (option.starts_with("--output-vdex-fd=")) {
1139 ParseOutputVdexFd(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001140 } else if (option.starts_with("--oat-file=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001141 oat_filenames_.push_back(option.substr(strlen("--oat-file=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001142 } else if (option.starts_with("--oat-symbols=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001143 parser_options->oat_symbols.push_back(option.substr(strlen("--oat-symbols=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001144 } else if (option.starts_with("--oat-fd=")) {
1145 ParseOatFd(option);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001146 } else if (option.starts_with("--oat-location=")) {
1147 oat_location_ = option.substr(strlen("--oat-location=")).data();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001148 } else if (option == "--watch-dog") {
1149 parser_options->watch_dog_enabled = true;
1150 } else if (option == "--no-watch-dog") {
1151 parser_options->watch_dog_enabled = false;
1152 } else if (option.starts_with("-j")) {
1153 ParseJ(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001154 } else if (option.starts_with("--image=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001155 image_filenames_.push_back(option.substr(strlen("--image=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001156 } else if (option.starts_with("--image-classes=")) {
1157 image_classes_filename_ = option.substr(strlen("--image-classes=")).data();
1158 } else if (option.starts_with("--image-classes-zip=")) {
1159 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data();
Mathieu Chartierceb07b32015-12-10 09:33:21 -08001160 } else if (option.starts_with("--image-format=")) {
1161 ParseImageFormat(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001162 } else if (option.starts_with("--compiled-classes=")) {
1163 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data();
1164 } else if (option.starts_with("--compiled-classes-zip=")) {
1165 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data();
1166 } else if (option.starts_with("--compiled-methods=")) {
1167 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data();
1168 } else if (option.starts_with("--compiled-methods-zip=")) {
1169 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data();
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07001170 } else if (option.starts_with("--run-passes=")) {
1171 passes_to_run_filename_ = option.substr(strlen("--run-passes=")).data();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001172 } else if (option.starts_with("--base=")) {
1173 ParseBase(option);
1174 } else if (option.starts_with("--boot-image=")) {
1175 parser_options->boot_image_filename = option.substr(strlen("--boot-image=")).data();
1176 } else if (option.starts_with("--android-root=")) {
1177 android_root_ = option.substr(strlen("--android-root=")).data();
1178 } else if (option.starts_with("--instruction-set=")) {
1179 ParseInstructionSet(option);
1180 } else if (option.starts_with("--instruction-set-variant=")) {
1181 ParseInstructionSetVariant(option, parser_options.get());
1182 } else if (option.starts_with("--instruction-set-features=")) {
1183 ParseInstructionSetFeatures(option, parser_options.get());
1184 } else if (option.starts_with("--compiler-backend=")) {
1185 ParseCompilerBackend(option, parser_options.get());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001186 } else if (option.starts_with("--profile-file=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001187 profile_file_ = option.substr(strlen("--profile-file=")).ToString();
Calin Juravle877fd962016-01-05 14:29:29 +00001188 } else if (option.starts_with("--profile-file-fd=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001189 ParseUintOption(option, "--profile-file-fd", &profile_file_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001190 } else if (option == "--host") {
1191 is_host_ = true;
1192 } else if (option == "--runtime-arg") {
1193 if (++i >= argc) {
1194 Usage("Missing required argument for --runtime-arg");
1195 }
1196 if (log_options) {
1197 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1198 }
1199 runtime_args_.push_back(argv[i]);
1200 } else if (option == "--dump-timing") {
1201 dump_timing_ = true;
1202 } else if (option == "--dump-passes") {
1203 dump_passes_ = true;
Roland Levillain9ec5e222015-08-17 20:18:41 +01001204 } else if (option == "--dump-stats") {
1205 dump_stats_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001206 } else if (option.starts_with("--swap-file=")) {
1207 swap_file_name_ = option.substr(strlen("--swap-file=")).data();
1208 } else if (option.starts_with("--swap-fd=")) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001209 ParseUintOption(option, "--swap-fd", &swap_fd_, Usage);
Andreas Gampee1459ae2016-06-29 09:36:30 -07001210 } else if (option.starts_with("--swap-dex-size-threshold=")) {
1211 ParseUintOption(option,
1212 "--swap-dex-size-threshold",
1213 &min_dex_file_cumulative_size_for_swap_,
1214 Usage);
1215 } else if (option.starts_with("--swap-dex-count-threshold=")) {
1216 ParseUintOption(option,
1217 "--swap-dex-count-threshold",
1218 &min_dex_files_for_swap_,
1219 Usage);
Andreas Gampe67f02822016-06-24 21:05:23 -07001220 } else if (option.starts_with("--very-large-app-threshold=")) {
1221 ParseUintOption(option,
1222 "--very-large-app-threshold",
1223 &very_large_threshold_,
1224 Usage);
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001225 } else if (option.starts_with("--app-image-file=")) {
1226 app_image_file_name_ = option.substr(strlen("--app-image-file=")).data();
1227 } else if (option.starts_with("--app-image-fd=")) {
1228 ParseUintOption(option, "--app-image-fd", &app_image_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001229 } else if (option.starts_with("--verbose-methods=")) {
1230 // TODO: rather than switch off compiler logging, make all VLOG(compiler) messages
1231 // conditional on having verbost methods.
1232 gLogVerbosity.compiler = false;
1233 Split(option.substr(strlen("--verbose-methods=")).ToString(), ',', &verbose_methods_);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001234 } else if (option == "--multi-image") {
Jeff Hao436183f2016-01-12 16:36:50 -08001235 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001236 } else if (option.starts_with("--no-inline-from=")) {
1237 no_inline_from_string_ = option.substr(strlen("--no-inline-from=")).data();
Andreas Gampeace0dc12016-01-20 13:33:13 -08001238 } else if (option == "--force-determinism") {
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001239 if (!SupportsDeterministicCompilation()) {
1240 Usage("Cannot use --force-determinism with read barriers or non-CMS garbage collector");
Roland Levillaineb2c7412016-01-28 14:37:01 +00001241 }
Andreas Gampeace0dc12016-01-20 13:33:13 -08001242 force_determinism_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001243 } else if (!compiler_options_->ParseCompilerOption(option, Usage)) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001244 Usage("Unknown argument %s", option.data());
1245 }
1246 }
1247
Jeff Hao436183f2016-01-12 16:36:50 -08001248 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001249
1250 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001251 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001252 }
1253
Jeff Haodcdc85b2015-12-04 14:06:18 -08001254 // Check whether the oat output files are writable, and open them for later. Also open a swap
1255 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001256 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001257 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1258 PruneNonExistentDexFiles();
1259
Jeff Hao436183f2016-01-12 16:36:50 -08001260 // Expand oat and image filenames for multi image.
1261 if (IsBootImage() && multi_image_) {
1262 ExpandOatAndImageFilenames();
1263 }
1264
David Brazdil7b49e6c2016-09-01 11:06:18 +01001265 // OAT and VDEX file handling
1266
1267 if (oat_fd_ == -1) {
1268 DCHECK(!oat_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08001269 for (const char* oat_filename : oat_filenames_) {
1270 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
1271 if (oat_file.get() == nullptr) {
1272 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1273 return false;
1274 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001275 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001276 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1277 oat_file->Erase();
1278 return false;
1279 }
1280 oat_files_.push_back(std::move(oat_file));
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001281 DCHECK_EQ(input_vdex_fd_, -1);
1282 if (!input_vdex_.empty()) {
1283 std::string error_msg;
1284 input_vdex_file_.reset(VdexFile::Open(input_vdex_,
1285 /* writable */ false,
1286 /* low_4gb */ false,
1287 &error_msg));
1288 if (input_vdex_file_ != nullptr && !input_vdex_file_->IsValid()) {
1289 input_vdex_file_.reset(nullptr);
1290 }
1291 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001292
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001293 DCHECK_EQ(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001294 std::string vdex_filename = ReplaceFileExtension(oat_filename, "vdex");
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001295 if (vdex_filename == input_vdex_) {
1296 update_input_vdex_ = true;
1297 std::unique_ptr<File> vdex_file(OS::OpenFileReadWrite(vdex_filename.c_str()));
1298 vdex_files_.push_back(std::move(vdex_file));
1299 } else {
1300 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
1301 if (vdex_file.get() == nullptr) {
1302 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1303 return false;
1304 }
1305 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1306 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1307 vdex_file->Erase();
1308 return false;
1309 }
1310 vdex_files_.push_back(std::move(vdex_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001311 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001312 }
1313 } else {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001314 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, /* check_usage */ true));
Jeff Haodcdc85b2015-12-04 14:06:18 -08001315 if (oat_file.get() == nullptr) {
1316 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1317 return false;
1318 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001319 oat_file->DisableAutoClose();
1320 if (oat_file->SetLength(0) != 0) {
1321 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1322 }
1323 oat_files_.push_back(std::move(oat_file));
1324
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001325 if (input_vdex_fd_ != -1) {
1326 struct stat s;
1327 int rc = TEMP_FAILURE_RETRY(fstat(input_vdex_fd_, &s));
1328 if (rc == -1) {
1329 PLOG(WARNING) << "Failed getting length of vdex file";
1330 } else {
1331 std::string error_msg;
1332 input_vdex_file_.reset(VdexFile::Open(input_vdex_fd_,
1333 s.st_size,
1334 "vdex",
1335 /* writable */ false,
1336 /* low_4gb */ false,
1337 &error_msg));
1338 // If there's any problem with the passed vdex, just warn and proceed
1339 // without it.
1340 if (input_vdex_file_ == nullptr) {
1341 PLOG(WARNING) << "Failed opening vdex file " << error_msg;
1342 } else if (!input_vdex_file_->IsValid()) {
1343 PLOG(WARNING) << "Existing vdex file is invalid";
1344 input_vdex_file_.reset(nullptr);
1345 }
1346 }
1347 }
1348
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001349 DCHECK_NE(output_vdex_fd_, -1);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001350 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00001351 std::unique_ptr<File> vdex_file(new File(output_vdex_fd_, vdex_location, /* check_usage */ true));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001352 if (vdex_file.get() == nullptr) {
1353 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001354 return false;
1355 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001356 vdex_file->DisableAutoClose();
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001357 if (input_vdex_file_ != nullptr && output_vdex_fd_ == input_vdex_fd_) {
1358 update_input_vdex_ = true;
1359 } else {
1360 if (vdex_file->SetLength(0) != 0) {
1361 PLOG(ERROR) << "Truncating vdex file " << vdex_location << " failed.";
1362 return false;
1363 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001364 }
1365 vdex_files_.push_back(std::move(vdex_file));
1366
Jeff Haodcdc85b2015-12-04 14:06:18 -08001367 oat_filenames_.push_back(oat_location_.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001368 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001369
David Brazdil7b49e6c2016-09-01 11:06:18 +01001370 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001371 //
1372 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1373 // that we can use for swap.
1374 //
1375 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1376 // will immediately unlink to satisfy the swap fd assumption.
1377 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1378 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1379 if (swap_file.get() == nullptr) {
1380 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1381 return false;
1382 }
1383 swap_fd_ = swap_file->Fd();
1384 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1385 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1386 // released immediately.
1387 unlink(swap_file_name_.c_str());
1388 }
Jeff Hao436183f2016-01-12 16:36:50 -08001389
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001390 return true;
1391 }
1392
David Brazdil7b49e6c2016-09-01 11:06:18 +01001393 void EraseOutputFiles() {
1394 for (auto& files : { &vdex_files_, &oat_files_ }) {
1395 for (size_t i = 0; i < files->size(); ++i) {
1396 if ((*files)[i].get() != nullptr) {
1397 (*files)[i]->Erase();
1398 (*files)[i].reset();
1399 }
1400 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001401 }
Andreas Gampea650e702014-12-03 14:28:02 -08001402 }
1403
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001404 void Shutdown() {
1405 ScopedObjectAccess soa(Thread::Current());
1406 for (jobject dex_cache : dex_caches_) {
1407 soa.Env()->DeleteLocalRef(dex_cache);
1408 }
1409 dex_caches_.clear();
1410 }
1411
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001412 void LoadClassProfileDescriptors() {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001413 if (profile_compilation_info_ != nullptr && IsAppImage()) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001414 Runtime* runtime = Runtime::Current();
1415 CHECK(runtime != nullptr);
1416 std::set<DexCacheResolvedClasses> resolved_classes(
1417 profile_compilation_info_->GetResolvedClasses());
Mathieu Chartier0b490842016-05-25 15:05:59 -07001418
1419 // Filter out class path classes since we don't want to include these in the image.
1420 std::unordered_set<std::string> dex_files_locations;
1421 for (const DexFile* dex_file : dex_files_) {
1422 dex_files_locations.insert(dex_file->GetLocation());
1423 }
1424 for (auto it = resolved_classes.begin(); it != resolved_classes.end(); ) {
1425 if (dex_files_locations.find(it->GetDexLocation()) == dex_files_locations.end()) {
1426 VLOG(compiler) << "Removed profile samples for non-app dex file " << it->GetDexLocation();
1427 it = resolved_classes.erase(it);
1428 } else {
1429 ++it;
1430 }
1431 }
1432
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001433 image_classes_.reset(new std::unordered_set<std::string>(
1434 runtime->GetClassLinker()->GetClassDescriptorsForProfileKeys(resolved_classes)));
1435 VLOG(compiler) << "Loaded " << image_classes_->size()
1436 << " image class descriptors from profile";
1437 if (VLOG_IS_ON(compiler)) {
1438 for (const std::string& s : *image_classes_) {
1439 LOG(INFO) << "Image class " << s;
1440 }
1441 }
1442 }
1443 }
1444
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001445 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1446 // boot class path.
1447 bool Setup() {
1448 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001449
1450 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods()) {
1451 return false;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001452 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001453
Vladimir Marko307dac92015-10-20 11:20:09 +01001454 verification_results_.reset(new VerificationResults(compiler_options_.get()));
Andreas Gampe4585f872015-03-27 23:45:15 -07001455 callbacks_.reset(new QuickCompilerCallbacks(
Vladimir Marko307dac92015-10-20 11:20:09 +01001456 verification_results_.get(),
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001457 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001458 CompilerCallbacks::CallbackMode::kCompileBootImage :
1459 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001460
Vladimir Marko49b0f452015-12-10 13:49:19 +00001461 RuntimeArgumentMap runtime_options;
1462 if (!PrepareRuntimeOptions(&runtime_options)) {
1463 return false;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001464 }
1465
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001466 CreateOatWriters();
1467 if (!AddDexFileSources()) {
1468 return false;
1469 }
1470
1471 if (IsBootImage() && image_filenames_.size() > 1) {
1472 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1473 // We need this for the multi-image case.
Mathieu Chartier866d8742016-09-21 15:24:18 -07001474 key_value_store_->Put(OatHeader::kBootClassPathKey,
1475 gc::space::ImageSpace::GetMultiImageBootClassPath(dex_locations_,
1476 oat_filenames_,
1477 image_filenames_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001478 }
1479
1480 if (!IsBootImage()) {
1481 // When compiling an app, create the runtime early to retrieve
1482 // the image location key needed for the oat header.
1483 if (!CreateRuntime(std::move(runtime_options))) {
1484 return false;
1485 }
1486
Andreas Gampe29d38e72016-03-23 15:31:51 +00001487 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001488 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1489 std::vector<gc::space::ImageSpace*> image_spaces =
1490 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Jeff Haob11ffb72016-04-07 15:40:54 -07001491 image_file_location_oat_checksum_ = OatFileAssistant::CalculateCombinedImageChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001492 image_file_location_oat_data_begin_ =
1493 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1494 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1495 // Store the boot image filename(s).
1496 std::vector<std::string> image_filenames;
1497 for (const gc::space::ImageSpace* image_space : image_spaces) {
1498 image_filenames.push_back(image_space->GetImageFilename());
1499 }
Andreas Gampe9186ced2016-12-12 14:28:21 -08001500 std::string image_file_location = android::base::Join(image_filenames, ':');
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001501 if (!image_file_location.empty()) {
1502 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1503 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001504 } else {
1505 image_file_location_oat_checksum_ = 0u;
1506 image_file_location_oat_data_begin_ = 0u;
1507 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001508 }
1509
1510 // Open dex files for class path.
1511 const std::vector<std::string> class_path_locations =
1512 GetClassPathLocations(runtime_->GetClassPathString());
Jeff Haofbeb1322016-04-26 14:27:31 -07001513 OpenClassPathFiles(class_path_locations,
1514 &class_path_files_,
1515 &opened_oat_files_,
1516 runtime_->GetInstructionSet());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001517
1518 // Store the classpath we have right now.
1519 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
Jeff Haof0192c82016-03-28 20:39:50 -07001520 std::string encoded_class_path;
1521 if (class_path_locations.size() == 1 &&
1522 class_path_locations[0] == OatFile::kSpecialSharedLibrary) {
1523 // When passing the special shared library as the classpath, it is the only path.
1524 encoded_class_path = OatFile::kSpecialSharedLibrary;
1525 } else {
1526 encoded_class_path = OatFile::EncodeDexFileDependencies(class_path_files);
1527 }
1528 key_value_store_->Put(OatHeader::kClassPathKey, encoded_class_path);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001529 }
1530
1531 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001532 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001533 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1534 rodata_.reserve(oat_writers_.size());
1535 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1536 rodata_.push_back(elf_writers_[i]->StartRoData());
1537 // Unzip or copy dex files straight to the oat file.
1538 std::unique_ptr<MemMap> opened_dex_files_map;
1539 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001540 // No need to verify the dex file for:
1541 // 1) dexlayout, which already verified it
1542 // 2) when we have a vdex file, which means it was already verified.
1543 bool verify = compiler_options_->GetCompilerFilter() != CompilerFilter::kLayoutProfile &&
1544 (input_vdex_file_ == nullptr);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001545 if (!oat_writers_[i]->WriteAndOpenDexFiles(
1546 kIsVdexEnabled ? vdex_files_[i].get() : oat_files_[i].get(),
1547 rodata_.back(),
1548 instruction_set_,
1549 instruction_set_features_.get(),
1550 key_value_store_.get(),
Jeff Hao042e8982016-10-19 11:17:11 -07001551 verify,
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00001552 update_input_vdex_,
David Brazdil7b49e6c2016-09-01 11:06:18 +01001553 &opened_dex_files_map,
1554 &opened_dex_files)) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001555 return false;
1556 }
1557 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1558 if (opened_dex_files_map != nullptr) {
1559 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
1560 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001561 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001562 opened_dex_files_.push_back(std::move(dex_file));
1563 }
1564 } else {
1565 DCHECK(opened_dex_files.empty());
1566 }
1567 }
1568 }
1569
1570 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
Andreas Gampe7386da42016-06-08 18:18:47 -07001571
1572 // We had to postpone the swap decision till now, as this is the point when we actually
1573 // know about the dex files we're going to use.
1574
1575 // Make sure that we didn't create the driver, yet.
1576 CHECK(driver_ == nullptr);
1577 // If we use a swap file, ensure we are above the threshold to make it necessary.
1578 if (swap_fd_ != -1) {
1579 if (!UseSwap(IsBootImage(), dex_files_)) {
1580 close(swap_fd_);
1581 swap_fd_ = -1;
1582 VLOG(compiler) << "Decided to run without swap.";
1583 } else {
1584 LOG(INFO) << "Large app, accepted running with swap.";
1585 }
1586 }
1587 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
1588
Andreas Gampe67f02822016-06-24 21:05:23 -07001589 // If we need to downgrade the compiler-filter for size reasons, do that check now.
1590 if (!IsBootImage() && IsVeryLarge(dex_files_)) {
1591 if (!CompilerFilter::IsAsGoodAs(CompilerFilter::kVerifyAtRuntime,
1592 compiler_options_->GetCompilerFilter())) {
1593 LOG(INFO) << "Very large app, downgrading to verify-at-runtime.";
1594 // Note: this change won't be reflected in the key-value store, as that had to be
1595 // finalized before loading the dex files. This setup is currently required
1596 // to get the size from the DexFile objects.
1597 // TODO: refactor. b/29790079
1598 compiler_options_->SetCompilerFilter(CompilerFilter::kVerifyAtRuntime);
1599 }
1600 }
1601
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001602 if (IsBootImage()) {
1603 // For boot image, pass opened dex files to the Runtime::Create().
1604 // Note: Runtime acquires ownership of these dex files.
1605 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001606 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001607 return false;
1608 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001609 }
1610
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001611 // If we're doing the image, override the compiler filter to force full compilation. Must be
1612 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1613 // compilation of class initializers.
1614 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001615 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001616 WellKnownClasses::Init(self->GetJniEnv());
1617
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001618 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001619 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001620 constexpr bool kSaveDexInput = false;
1621 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001622 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001623 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001624
1625 // Handle and ClassLoader creation needs to come after Runtime::Create.
1626 ScopedObjectAccess soa(self);
1627
1628 // Classpath: first the class-path given.
1629 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1630
1631 // Then the dex files we'll compile. Thus we'll resolve the class-path first.
1632 class_path_files.insert(class_path_files.end(), dex_files_.begin(), dex_files_.end());
1633
1634 class_loader_ = class_linker->CreatePathClassLoader(self, class_path_files);
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001635 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001636
1637 // Ensure opened dex files are writable for dex-to-dex transformations.
1638 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1639 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1640 PLOG(ERROR) << "Failed to make .dex files writeable.";
1641 return false;
Vladimir Marko919f5532016-01-20 19:13:01 +00001642 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001643 }
1644
1645 // Ensure that the dex caches stay live since we don't want class unloading
1646 // to occur during compilation.
1647 for (const auto& dex_file : dex_files_) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001648 ScopedObjectAccess soa(self);
1649 dex_caches_.push_back(soa.AddLocalReference<jobject>(
Mathieu Chartierf284d442016-06-02 11:48:30 -07001650 class_linker->RegisterDexFile(*dex_file,
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001651 soa.Decode<mirror::ClassLoader>(class_loader_).Ptr())));
Mathieu Chartierfc2dd612016-11-21 15:05:23 -08001652 // Pre-register dex files so that we can access verification results without locks during
1653 // compilation and verification.
Mathieu Chartier9df89312016-11-23 13:28:16 -08001654 verification_results_->AddDexFile(dex_file);
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001655 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001656
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001657 return true;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001658 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001659
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001660 // If we need to keep the oat file open for the image writer.
1661 bool ShouldKeepOatFileOpen() const {
1662 return IsImage() && oat_fd_ != kInvalidFd;
1663 }
1664
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001665 // Create and invoke the compiler driver. This will compile all the dex files.
1666 void Compile() {
1667 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1668 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001669
Vladimir Marko47496c22016-01-27 16:15:08 +00001670 // Find the dex files we should not inline from.
1671
1672 std::vector<std::string> no_inline_filters;
1673 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001674
1675 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001676 const std::string core_oj = "core-oj";
1677 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1678 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001679 }
1680
Vladimir Marko47496c22016-01-27 16:15:08 +00001681 if (!no_inline_filters.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001682 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1683 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1684 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1685 &class_linker->GetBootClassPath(),
1686 &class_path_files,
1687 &dex_files_
1688 };
1689 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001690 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001691 for (const std::string& filter : no_inline_filters) {
1692 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
1693 // allows tests to specify <test-dexfile>:classes2.dex if needed but if the
1694 // base location passes the StartsWith() test, so do all extra locations.
1695 std::string dex_location = dex_file->GetLocation();
1696 if (filter.find('/') == std::string::npos) {
1697 // The filter does not contain the path. Remove the path from dex_location as well.
1698 size_t last_slash = dex_file->GetLocation().rfind('/');
1699 if (last_slash != std::string::npos) {
1700 dex_location = dex_location.substr(last_slash + 1);
1701 }
1702 }
1703
Andreas Gampe9186ced2016-12-12 14:28:21 -08001704 if (android::base::StartsWith(dex_location, filter.c_str())) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001705 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1706 no_inline_from_dex_files_.push_back(dex_file);
1707 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001708 }
1709 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001710 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001711 }
1712 if (!no_inline_from_dex_files_.empty()) {
1713 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001714 }
1715 }
1716
Vladimir Marko307dac92015-10-20 11:20:09 +01001717 driver_.reset(new CompilerDriver(compiler_options_.get(),
1718 verification_results_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001719 compiler_kind_,
1720 instruction_set_,
1721 instruction_set_features_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001722 image_classes_.release(),
1723 compiled_classes_.release(),
Wojciech Staszkiewicz62534792016-08-09 14:30:55 -07001724 compiled_methods_.release(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001725 thread_count_,
1726 dump_stats_,
1727 dump_passes_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001728 compiler_phases_timings_.get(),
1729 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001730 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001731 driver_->SetDexFilesForOatFile(dex_files_);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00001732 driver_->CompileAll(class_loader_, dex_files_, input_vdex_file_.get(), timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001733 }
1734
Jeff Hao436183f2016-01-12 16:36:50 -08001735 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001736 // ensure the references between the two are correct.
1737 //
1738 // Currently we have a memory layout that looks something like this:
1739 //
1740 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001741 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001742 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001743 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001744 // +--------------+
1745 // | alloc spaces |
1746 // +--------------+
1747 //
Jeff Hao436183f2016-01-12 16:36:50 -08001748 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001749 //
Jeff Hao436183f2016-01-12 16:36:50 -08001750 // 1. The images are expected to be loaded at an absolute address and
1751 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001752 //
Jeff Hao436183f2016-01-12 16:36:50 -08001753 // 2. There are absolute pointers from Methods in the images to their
1754 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001755 //
Jeff Hao436183f2016-01-12 16:36:50 -08001756 // 3. There are absolute pointers from the code in the oat files to Methods
1757 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001758 //
Jeff Hao436183f2016-01-12 16:36:50 -08001759 // 4. There are absolute pointers from code in the oat files to other code
1760 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001761 //
1762 // To get this all correct, we go through several steps.
1763 //
Jeff Hao436183f2016-01-12 16:36:50 -08001764 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001765 // the oat data size and code size. During this stage, we also set
1766 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001767 //
Jeff Hao436183f2016-01-12 16:36:50 -08001768 // 2. We prepare offsets for the objects in the images and calculate
1769 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001770 //
Jeff Hao436183f2016-01-12 16:36:50 -08001771 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001772 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001773 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001774 // can prepare the ELF headers and we then know the ELF memory segment
1775 // layout and we can now resolve all references. The compiler provides
1776 // LinkerPatch information in each CompiledMethod and we resolve these,
1777 // using the layout information and image object locations provided by
1778 // image writer, as we're writing the method code.
1779 //
Jeff Hao436183f2016-01-12 16:36:50 -08001780 // 4. We create the image files. They need to know where the oat files
1781 // will be loaded after itself. Originally oat files were simply
1782 // memory mapped so we could predict where their contents were based
1783 // on the file size. Now that they are ELF files, we need to inspect
1784 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001785 // where the oat header is located within.
1786 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001787 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001788 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001789 // load the .so at the desired location at runtime by offsetting the
1790 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001791 // TODO: Do this in step 3. We already know the layout there.
1792 //
1793 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1794 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001795
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001796 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1797 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001798 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1799 // case (when the file will be explicitly erased).
David Brazdil7b49e6c2016-09-01 11:06:18 +01001800 bool WriteOutputFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001801 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1802
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001803 // Sync the data to the file, in case we did dex2dex transformations.
1804 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1805 if (!map->Sync()) {
1806 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1807 return false;
1808 }
1809 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001810
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001811 if (IsImage()) {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001812 if (IsAppImage() && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001813 gc::Heap* const heap = Runtime::Current()->GetHeap();
1814 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001815 image_base_ = std::max(image_base_, RoundUp(
1816 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1817 kPageSize));
1818 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001819 // The non moving space is right after the oat file. Put the preferred app image location
1820 // right after the non moving space so that we ideally get a continuous immune region for
1821 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001822 // Use the default non moving space capacity since dex2oat does not have a separate non-
1823 // moving space. This means the runtime's non moving space space size will be as large
1824 // as the growth limit for dex2oat, but smaller in the zygote.
1825 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001826 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001827 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1828 }
1829
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001830 image_writer_.reset(new ImageWriter(*driver_,
1831 image_base_,
1832 compiler_options_->GetCompilePic(),
1833 IsAppImage(),
1834 image_storage_mode_,
1835 oat_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00001836 dex_file_oat_index_map_));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001837
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001838 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001839 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1840 if (!image_writer_->PrepareImageAddressSpace()) {
1841 LOG(ERROR) << "Failed to prepare image address space.";
1842 return false;
1843 }
1844 }
1845
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001846 // Initialize the writers with the compiler driver, image writer, and their
1847 // dex files. The writers were created without those being there yet.
1848 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1849 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
1850 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1851 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
1852 }
1853
David Brazdil5d5a36b2016-09-14 15:34:10 +01001854 {
1855 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
1856 DCHECK(IsBootImage() || oat_files_.size() == 1u);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001857 verifier::VerifierDeps* verifier_deps = callbacks_->GetVerifierDeps();
David Brazdil5d5a36b2016-09-14 15:34:10 +01001858 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1859 File* vdex_file = vdex_files_[i].get();
1860 std::unique_ptr<BufferedOutputStream> vdex_out(
1861 MakeUnique<BufferedOutputStream>(MakeUnique<FileOutputStream>(vdex_file)));
1862
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +00001863 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps)) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01001864 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
1865 return false;
1866 }
1867
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001868 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
1869 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
1870 return false;
1871 }
1872
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +00001873 // VDEX finalized, seek back to the beginning and write checksums and the header.
1874 if (!oat_writers_[i]->WriteChecksumsAndVdexHeader(vdex_out.get())) {
David Brazdil5d5a36b2016-09-14 15:34:10 +01001875 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
1876 return false;
1877 }
1878 }
1879 }
1880
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001881 {
1882 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001883 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001884 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko944da602016-02-19 12:27:55 +00001885 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1886 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
1887
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001888 oat_writer->PrepareLayout(&patcher);
Vladimir Marko944da602016-02-19 12:27:55 +00001889
1890 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
David Brazdil7b49e6c2016-09-01 11:06:18 +01001891 size_t text_size = oat_writer->GetOatSize() - rodata_size;
Vladimir Markoaad75c62016-10-03 08:46:48 +00001892 elf_writer->PrepareDynamicSection(rodata_size,
1893 text_size,
1894 oat_writer->GetBssSize(),
1895 oat_writer->GetBssRootsOffset());
Vladimir Marko944da602016-02-19 12:27:55 +00001896
1897 if (IsImage()) {
1898 // Update oat layout.
1899 DCHECK(image_writer_ != nullptr);
1900 DCHECK_LT(i, oat_filenames_.size());
1901 image_writer_->UpdateOatFileLayout(i,
1902 elf_writer->GetLoadedSize(),
1903 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01001904 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00001905 }
1906 }
1907
1908 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001909 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001910 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1911 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00001912
David Srbecky09c2a6b2016-03-11 17:11:44 +00001913 oat_writer->AddMethodDebugInfos(debug::MakeTrampolineInfos(oat_writer->GetOatHeader()));
1914
David Srbecky0c4572e2016-01-22 19:19:25 +00001915 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00001916 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
1917 elf_writer->PrepareDebugInfo(oat_writer->GetMethodDebugInfo());
David Srbecky0c4572e2016-01-22 19:19:25 +00001918
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001919 OutputStream*& rodata = rodata_[i];
1920 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001921 if (!oat_writer->WriteRodata(rodata)) {
1922 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
1923 return false;
1924 }
1925 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001926 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00001927
Jeff Haodcdc85b2015-12-04 14:06:18 -08001928 OutputStream* text = elf_writer->StartText();
1929 if (!oat_writer->WriteCode(text)) {
1930 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
1931 return false;
1932 }
1933 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00001934
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001935 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
1936 image_file_location_oat_checksum_,
1937 image_file_location_oat_data_begin_,
1938 image_patch_delta_)) {
1939 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
1940 return false;
1941 }
1942
Vladimir Marko944da602016-02-19 12:27:55 +00001943 if (IsImage()) {
1944 // Update oat header information.
1945 DCHECK(image_writer_ != nullptr);
1946 DCHECK_LT(i, oat_filenames_.size());
1947 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
1948 }
1949
Jeff Haodcdc85b2015-12-04 14:06:18 -08001950 elf_writer->WriteDynamicSection();
1951 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
1952 elf_writer->WritePatchLocations(oat_writer->GetAbsolutePatchLocations());
Vladimir Marko10c13562015-11-25 14:33:36 +00001953
Jeff Haodcdc85b2015-12-04 14:06:18 -08001954 if (!elf_writer->End()) {
1955 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
1956 return false;
1957 }
1958
David Brazdil7b49e6c2016-09-01 11:06:18 +01001959 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
1960 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001961 }
1962
Jeff Haodcdc85b2015-12-04 14:06:18 -08001963 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001964
1965 oat_writer.reset();
1966 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001967 }
1968 }
1969
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001970 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001971 }
1972
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001973 // If we are compiling an image, invoke the image creation routine. Else just skip.
1974 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001975 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001976 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
1977 if (!CreateImageFile()) {
1978 return false;
1979 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001980 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07001981 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001982 return true;
1983 }
1984
Jeff Haodcdc85b2015-12-04 14:06:18 -08001985 // Create a copy from stripped to unstripped.
1986 bool CopyStrippedToUnstripped() {
1987 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
1988 // If we don't want to strip in place, copy from stripped location to unstripped location.
1989 // We need to strip after image creation because FixupElf needs to use .strtab.
1990 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
1991 // If the oat file is still open, flush it.
1992 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001993 if (!FlushCloseOutputFile(&oat_files_[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001994 return false;
1995 }
1996 }
1997
1998 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
1999 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
2000 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01002001 int64_t in_length = in->GetLength();
2002 if (in_length < 0) {
2003 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
2004 return false;
2005 }
2006 if (!out->Copy(in.get(), 0, in_length)) {
2007 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
2008 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002009 }
2010 if (out->FlushCloseOrErase() != 0) {
2011 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
2012 return false;
2013 }
2014 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
2015 }
2016 }
2017 return true;
2018 }
2019
David Brazdil7b49e6c2016-09-01 11:06:18 +01002020 bool FlushOutputFile(std::unique_ptr<File>* file) {
2021 if (file->get() != nullptr) {
2022 if (file->get()->Flush() != 0) {
2023 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
2024 return false;
2025 }
2026 }
2027 return true;
2028 }
2029
2030 bool FlushCloseOutputFile(std::unique_ptr<File>* file) {
2031 if (file->get() != nullptr) {
2032 std::unique_ptr<File> tmp(file->release());
2033 if (tmp->FlushCloseOrErase() != 0) {
2034 PLOG(ERROR) << "Failed to flush and close output file: " << tmp->GetPath();
2035 return false;
2036 }
2037 }
2038 return true;
2039 }
2040
2041 bool FlushOutputFiles() {
2042 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
2043 for (auto& files : { &vdex_files_, &oat_files_ }) {
2044 for (size_t i = 0; i < files->size(); ++i) {
2045 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002046 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08002047 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002048 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00002049 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08002050 return true;
2051 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002052
David Brazdil7b49e6c2016-09-01 11:06:18 +01002053 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002054 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002055 for (auto& files : { &vdex_files_, &oat_files_ }) {
2056 for (size_t i = 0; i < files->size(); ++i) {
2057 result &= FlushCloseOutputFile(&(*files)[i]);
2058 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002059 }
2060 return result;
2061 }
2062
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002063 void DumpTiming() {
2064 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
2065 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
2066 }
2067 if (dump_passes_) {
2068 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
2069 }
2070 }
2071
Andreas Gampe10e477d2014-11-19 12:57:42 -08002072 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002073 return IsAppImage() || IsBootImage();
2074 }
2075
2076 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002077 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002078 }
2079
2080 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002081 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002082 }
2083
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002084 bool IsHost() const {
2085 return is_host_;
2086 }
2087
Calin Juravle998c2162015-12-21 15:39:33 +02002088 bool UseProfileGuidedCompilation() const {
Andreas Gampe29d38e72016-03-23 15:31:51 +00002089 return CompilerFilter::DependsOnProfile(compiler_options_->GetCompilerFilter());
Calin Juravle998c2162015-12-21 15:39:33 +02002090 }
2091
Calin Juravle2e2db782016-02-23 12:00:03 +00002092 bool LoadProfile() {
Calin Juravle998c2162015-12-21 15:39:33 +02002093 DCHECK(UseProfileGuidedCompilation());
Calin Juravle2e2db782016-02-23 12:00:03 +00002094
2095 profile_compilation_info_.reset(new ProfileCompilationInfo());
2096 ScopedFlock flock;
Andreas Gampe29d38e72016-03-23 15:31:51 +00002097 bool success = true;
Calin Juravle2e2db782016-02-23 12:00:03 +00002098 std::string error;
2099 if (profile_file_fd_ != -1) {
2100 // The file doesn't need to be flushed so don't check the usage.
2101 // Pass a bogus path so that we can easily attribute any reported error.
2102 File file(profile_file_fd_, "profile", /*check_usage*/ false, /*read_only_mode*/ true);
2103 if (flock.Init(&file, &error)) {
2104 success = profile_compilation_info_->Load(profile_file_fd_);
2105 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00002106 } else if (profile_file_ != "") {
Calin Juravle2e2db782016-02-23 12:00:03 +00002107 if (flock.Init(profile_file_.c_str(), O_RDONLY, /* block */ true, &error)) {
2108 success = profile_compilation_info_->Load(flock.GetFile()->Fd());
2109 }
2110 }
2111 if (!error.empty()) {
2112 LOG(WARNING) << "Cannot lock profiles: " << error;
Calin Juravle998c2162015-12-21 15:39:33 +02002113 }
Calin Juravle877fd962016-01-05 14:29:29 +00002114
Calin Juravle2e2db782016-02-23 12:00:03 +00002115 if (!success) {
2116 profile_compilation_info_.reset(nullptr);
2117 }
Calin Juravle877fd962016-01-05 14:29:29 +00002118
Calin Juravle2e2db782016-02-23 12:00:03 +00002119 return success;
Calin Juravle998c2162015-12-21 15:39:33 +02002120 }
2121
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002122 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002123 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2124 if (is_image) {
2125 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2126 return false;
2127 }
2128 if (dex_files.size() < min_dex_files_for_swap_) {
2129 // If there are less dex files than the threshold, assume it's gonna be fine.
2130 return false;
2131 }
2132 size_t dex_files_size = 0;
2133 for (const auto* dex_file : dex_files) {
2134 dex_files_size += dex_file->GetHeader().file_size_;
2135 }
2136 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2137 }
2138
Andreas Gampe67f02822016-06-24 21:05:23 -07002139 bool IsVeryLarge(std::vector<const DexFile*>& dex_files) {
2140 size_t dex_files_size = 0;
2141 for (const auto* dex_file : dex_files) {
2142 dex_files_size += dex_file->GetHeader().file_size_;
2143 }
2144 return dex_files_size >= very_large_threshold_;
2145 }
2146
Vladimir Marko49b0f452015-12-10 13:49:19 +00002147 template <typename T>
2148 static std::vector<T*> MakeNonOwningPointerVector(const std::vector<std::unique_ptr<T>>& src) {
2149 std::vector<T*> result;
2150 result.reserve(src.size());
2151 for (const std::unique_ptr<T>& t : src) {
2152 result.push_back(t.get());
2153 }
2154 return result;
2155 }
2156
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002157 std::vector<std::string> GetClassPathLocations(const std::string& class_path) {
2158 // This function is used only for apps and for an app we have exactly one oat file.
2159 DCHECK(!IsBootImage());
2160 DCHECK_EQ(oat_writers_.size(), 1u);
2161 std::vector<std::string> dex_files_canonical_locations;
2162 for (const char* location : oat_writers_[0]->GetSourceLocations()) {
2163 dex_files_canonical_locations.push_back(DexFile::GetDexCanonicalLocation(location));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002164 }
Vladimir Marko625a64a2015-11-26 14:44:16 +00002165
Vladimir Marko919f5532016-01-20 19:13:01 +00002166 std::vector<std::string> parsed;
2167 Split(class_path, ':', &parsed);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002168 auto kept_it = std::remove_if(parsed.begin(),
2169 parsed.end(),
2170 [dex_files_canonical_locations](const std::string& location) {
2171 return ContainsElement(dex_files_canonical_locations,
2172 DexFile::GetDexCanonicalLocation(location.c_str()));
2173 });
2174 parsed.erase(kept_it, parsed.end());
2175 return parsed;
2176 }
2177
Jeff Haofbeb1322016-04-26 14:27:31 -07002178 // Opens requested class path files and appends them to opened_dex_files. If the dex files have
2179 // been stripped, this opens them from their oat files and appends them to opened_oat_files.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002180 static void OpenClassPathFiles(const std::vector<std::string>& class_path_locations,
Jeff Haof0192c82016-03-28 20:39:50 -07002181 std::vector<std::unique_ptr<const DexFile>>* opened_dex_files,
Jeff Haofbeb1322016-04-26 14:27:31 -07002182 std::vector<std::unique_ptr<OatFile>>* opened_oat_files,
Jeff Haof0192c82016-03-28 20:39:50 -07002183 InstructionSet isa) {
Jeff Haofbeb1322016-04-26 14:27:31 -07002184 DCHECK(opened_dex_files != nullptr) << "OpenClassPathFiles dex out-param is nullptr";
2185 DCHECK(opened_oat_files != nullptr) << "OpenClassPathFiles oat out-param is nullptr";
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002186 for (const std::string& location : class_path_locations) {
Jeff Haof0192c82016-03-28 20:39:50 -07002187 // Stop early if we detect the special shared library, which may be passed as the classpath
2188 // for dex2oat when we want to skip the shared libraries check.
2189 if (location == OatFile::kSpecialSharedLibrary) {
2190 break;
2191 }
Aart Bik37d6a3b2016-06-21 18:30:10 -07002192 static constexpr bool kVerifyChecksum = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002193 std::string error_msg;
Aart Bik37d6a3b2016-06-21 18:30:10 -07002194 if (!DexFile::Open(
2195 location.c_str(), location.c_str(), kVerifyChecksum, &error_msg, opened_dex_files)) {
Jeff Haof0192c82016-03-28 20:39:50 -07002196 // If we fail to open the dex file because it's been stripped, try to open the dex file
2197 // from its corresponding oat file.
Richard Uhlerd1472a22016-04-15 15:18:56 -07002198 OatFileAssistant oat_file_assistant(location.c_str(), isa, false);
Jeff Haof0192c82016-03-28 20:39:50 -07002199 std::unique_ptr<OatFile> oat_file(oat_file_assistant.GetBestOatFile());
2200 if (oat_file == nullptr) {
2201 LOG(WARNING) << "Failed to open dex file and associated oat file for '" << location
2202 << "': " << error_msg;
2203 } else {
2204 std::vector<std::unique_ptr<const DexFile>> oat_dex_files =
2205 oat_file_assistant.LoadDexFiles(*oat_file, location.c_str());
Jeff Haofbeb1322016-04-26 14:27:31 -07002206 opened_oat_files->push_back(std::move(oat_file));
Jeff Haof0192c82016-03-28 20:39:50 -07002207 opened_dex_files->insert(opened_dex_files->end(),
2208 std::make_move_iterator(oat_dex_files.begin()),
2209 std::make_move_iterator(oat_dex_files.end()));
2210 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002211 }
2212 }
2213 }
2214
Vladimir Marko49b0f452015-12-10 13:49:19 +00002215 bool PrepareImageClasses() {
2216 // If --image-classes was specified, calculate the full list of classes to include in the image.
2217 if (image_classes_filename_ != nullptr) {
2218 image_classes_ =
2219 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2220 if (image_classes_ == nullptr) {
2221 return false;
2222 }
2223 } else if (IsBootImage()) {
2224 image_classes_.reset(new std::unordered_set<std::string>);
2225 }
2226 return true;
2227 }
2228
2229 bool PrepareCompiledClasses() {
2230 // If --compiled-classes was specified, calculate the full list of classes to compile in the
2231 // image.
2232 if (compiled_classes_filename_ != nullptr) {
2233 compiled_classes_ =
2234 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
2235 if (compiled_classes_ == nullptr) {
2236 return false;
2237 }
2238 } else {
2239 compiled_classes_.reset(nullptr); // By default compile everything.
2240 }
2241 return true;
2242 }
2243
2244 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2245 const char* classes_filename,
2246 const char* tag) {
2247 std::unique_ptr<std::unordered_set<std::string>> classes;
2248 std::string error_msg;
2249 if (zip_filename != nullptr) {
2250 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2251 } else {
2252 classes.reset(ReadImageClassesFromFile(classes_filename));
2253 }
2254 if (classes == nullptr) {
2255 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2256 << classes_filename << "': " << error_msg;
2257 }
2258 return classes;
2259 }
2260
2261 bool PrepareCompiledMethods() {
2262 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2263 if (compiled_methods_filename_ != nullptr) {
2264 std::string error_msg;
2265 if (compiled_methods_zip_filename_ != nullptr) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002266 compiled_methods_.reset(ReadCommentedInputFromZip<std::unordered_set<std::string>>(
2267 compiled_methods_zip_filename_,
2268 compiled_methods_filename_,
2269 nullptr, // No post-processing.
2270 &error_msg));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002271 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002272 compiled_methods_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2273 compiled_methods_filename_,
2274 nullptr)); // No post-processing.
Vladimir Marko49b0f452015-12-10 13:49:19 +00002275 }
2276 if (compiled_methods_.get() == nullptr) {
2277 LOG(ERROR) << "Failed to create list of compiled methods from '"
2278 << compiled_methods_filename_ << "': " << error_msg;
2279 return false;
2280 }
2281 } else {
2282 compiled_methods_.reset(nullptr); // By default compile everything.
2283 }
2284 return true;
2285 }
2286
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002287 void PruneNonExistentDexFiles() {
2288 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2289 size_t kept = 0u;
2290 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2291 if (!OS::FileExists(dex_filenames_[i])) {
2292 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2293 } else {
2294 dex_filenames_[kept] = dex_filenames_[i];
2295 dex_locations_[kept] = dex_locations_[i];
2296 ++kept;
2297 }
2298 }
2299 dex_filenames_.resize(kept);
2300 dex_locations_.resize(kept);
2301 }
2302
2303 bool AddDexFileSources() {
2304 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002305 if (input_vdex_file_ != nullptr) {
2306 DCHECK_EQ(oat_writers_.size(), 1u);
2307 const std::string& name = zip_location_.empty() ? dex_locations_[0] : zip_location_;
2308 DCHECK(!name.empty());
2309 if (!oat_writers_[0]->AddVdexDexFilesSource(*input_vdex_file_.get(), name.c_str())) {
2310 return false;
2311 }
2312 } else if (zip_fd_ != -1) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002313 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002314 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2315 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002316 return false;
2317 }
2318 } else if (oat_writers_.size() > 1u) {
2319 // Multi-image.
2320 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2321 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2322 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2323 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2324 return false;
2325 }
2326 }
2327 } else {
2328 DCHECK_EQ(oat_writers_.size(), 1u);
2329 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2330 DCHECK_NE(dex_filenames_.size(), 0u);
2331 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2332 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2333 return false;
2334 }
2335 }
2336 }
2337 return true;
2338 }
2339
2340 void CreateOatWriters() {
2341 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2342 elf_writers_.reserve(oat_files_.size());
2343 oat_writers_.reserve(oat_files_.size());
2344 for (const std::unique_ptr<File>& oat_file : oat_files_) {
David Srbecky5d811202016-03-08 13:21:22 +00002345 elf_writers_.emplace_back(CreateElfWriterQuick(instruction_set_,
2346 instruction_set_features_.get(),
2347 compiler_options_.get(),
2348 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002349 elf_writers_.back()->Start();
Jeff Hao608f2ce2016-10-19 11:17:11 -07002350 bool do_dexlayout = compiler_options_->GetCompilerFilter() == CompilerFilter::kLayoutProfile;
2351 oat_writers_.emplace_back(new OatWriter(
2352 IsBootImage(), timings_, do_dexlayout ? profile_compilation_info_.get() : nullptr));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002353 }
2354 }
2355
Vladimir Marko49b0f452015-12-10 13:49:19 +00002356 void SaveDexInput() {
2357 for (size_t i = 0; i < dex_files_.size(); ++i) {
2358 const DexFile* dex_file = dex_files_[i];
2359 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2360 getpid(), i));
2361 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2362 if (tmp_file.get() == nullptr) {
2363 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2364 << ". Try: adb shell chmod 777 /data/local/tmp";
2365 continue;
2366 }
2367 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2368 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2369 UNUSED(tmp_file->Flush());
2370 UNUSED(tmp_file->Close());
2371 LOG(INFO) << "Wrote input to " << tmp_file_name;
2372 }
2373 }
2374
2375 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options) {
2376 RuntimeOptions raw_options;
2377 if (boot_image_filename_.empty()) {
2378 std::string boot_class_path = "-Xbootclasspath:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002379 boot_class_path += android::base::Join(dex_filenames_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002380 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2381 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
Andreas Gampe9186ced2016-12-12 14:28:21 -08002382 boot_class_path_locations += android::base::Join(dex_locations_, ':');
Vladimir Marko49b0f452015-12-10 13:49:19 +00002383 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2384 } else {
2385 std::string boot_image_option = "-Ximage:";
2386 boot_image_option += boot_image_filename_;
2387 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2388 }
2389 for (size_t i = 0; i < runtime_args_.size(); i++) {
2390 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2391 }
2392
2393 raw_options.push_back(std::make_pair("compilercallbacks", callbacks_.get()));
2394 raw_options.push_back(
2395 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2396
2397 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2398 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2399 // have been stripped in preopting, anyways).
2400 if (!IsBootImage()) {
2401 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2402 }
2403 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2404 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2405 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002406 // Disable Hspace compaction to save heap size virtual space.
2407 // Only need disable Hspace for OOM becasue background collector is equal to
2408 // foreground collector by default for dex2oat.
2409 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002410
Andreas Gampeace0dc12016-01-20 13:33:13 -08002411 // If we're asked to be deterministic, ensure non-concurrent GC for determinism. Also
2412 // force the free-list implementation for large objects.
2413 if (compiler_options_->IsForceDeterminism()) {
2414 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
2415 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=freelist", nullptr));
2416
2417 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2418 // compaction (done above) and ensure that neither foreground nor background collectors
2419 // are concurrent.
2420 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2421
2422 // To make identity hashcode deterministic, set a known seed.
2423 mirror::Object::SetHashCodeSeed(987654321U);
2424 }
2425
Vladimir Marko49b0f452015-12-10 13:49:19 +00002426 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2427 LOG(ERROR) << "Failed to parse runtime options";
2428 return false;
2429 }
2430 return true;
2431 }
2432
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002433 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002434 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2435 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002436 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002437 LOG(ERROR) << "Failed to create runtime";
2438 return false;
2439 }
Andreas Gampe49c144d2016-11-14 10:11:16 -08002440
2441 // Runtime::Init will rename this thread to be "main". Prefer "dex2oat" so that "top" and
2442 // "ps -a" don't change to non-descript "main."
2443 SetThreadName(kIsDebugBuild ? "dex2oatd" : "dex2oat");
2444
Vladimir Marko307dac92015-10-20 11:20:09 +01002445 runtime_.reset(Runtime::Current());
2446 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002447 for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) {
2448 Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002449 if (!runtime_->HasCalleeSaveMethod(type)) {
2450 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002451 }
2452 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002453 runtime_->GetClassLinker()->FixupDexCaches(runtime_->GetResolutionMethod());
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002454
2455 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2456 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002457 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002458
Vladimir Marko307dac92015-10-20 11:20:09 +01002459 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002460
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002461 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2462 // Runtime::Start, give it away now so that we don't starve GC.
2463 Thread* self = Thread::Current();
2464 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002465
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002466 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002467 }
2468
Jeff Haodcdc85b2015-12-04 14:06:18 -08002469 // 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 -08002470 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002471 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002472 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002473 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002474 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002475 image_filenames_.push_back(app_image_file_name_.c_str());
2476 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002477 if (!image_writer_->Write(app_image_fd_,
2478 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002479 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002480 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002481 return false;
2482 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002483
Jeff Haodcdc85b2015-12-04 14:06:18 -08002484 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002485 dchecked_vector<uintptr_t> oat_data_begins;
2486 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2487 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002488 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002489 // Destroy ImageWriter before doing FixupElf.
2490 image_writer_.reset();
2491
Vladimir Marko944da602016-02-19 12:27:55 +00002492 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2493 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002494 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2495 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2496 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2497 if (oat_file.get() == nullptr) {
2498 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2499 return false;
2500 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002501
Vladimir Marko944da602016-02-19 12:27:55 +00002502 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002503 oat_file->Erase();
2504 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2505 return false;
2506 }
2507
2508 if (oat_file->FlushCloseOrErase()) {
2509 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2510 return false;
2511 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002512 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002513 }
2514
2515 return true;
2516 }
2517
2518 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002519 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2520 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002521 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002522 return ReadCommentedInputFromFile<std::unordered_set<std::string>>(image_classes_filename,
2523 &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002524 }
2525
2526 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002527 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002528 const char* zip_filename,
2529 const char* image_classes_filename,
2530 std::string* error_msg) {
2531 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002532 return ReadCommentedInputFromZip<std::unordered_set<std::string>>(zip_filename,
2533 image_classes_filename,
2534 &process,
2535 error_msg);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002536 }
2537
2538 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2539 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002540 template <typename T>
2541 static T* ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002542 const char* input_filename, std::function<std::string(const char*)>* process) {
2543 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2544 if (input_file.get() == nullptr) {
2545 LOG(ERROR) << "Failed to open input file " << input_filename;
2546 return nullptr;
2547 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002548 std::unique_ptr<T> result(
2549 ReadCommentedInputStream<T>(*input_file, process));
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002550 input_file->close();
2551 return result.release();
2552 }
2553
2554 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2555 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002556 template <typename T>
2557 static T* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002558 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002559 const char* input_filename,
2560 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002561 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002562 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2563 if (zip_archive.get() == nullptr) {
2564 return nullptr;
2565 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002566 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002567 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002568 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002569 zip_filename, error_msg->c_str());
2570 return nullptr;
2571 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002572 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2573 input_filename,
2574 error_msg));
2575 if (input_file.get() == nullptr) {
2576 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002577 zip_filename, error_msg->c_str());
2578 return nullptr;
2579 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002580 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2581 input_file->Size());
2582 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002583 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002584 }
2585
2586 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2587 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002588 template <typename T>
2589 static T* ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002590 std::istream& in_stream,
2591 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002592 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002593 while (in_stream.good()) {
2594 std::string dot;
2595 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08002596 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002597 continue;
2598 }
2599 if (process != nullptr) {
2600 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002601 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002602 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002603 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002604 }
2605 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002606 return output.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002607 }
2608
Mathieu Chartier49285c52014-12-02 15:43:48 -08002609 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002610 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2611 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002612 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampec560fc02014-07-16 09:57:39 -07002613 LOG(INFO) << "dex2oat took "
2614 << PrettyDuration(NanoTime() - start_ns_)
Andreas Gampecc967752016-12-12 13:49:00 -08002615 << " (" << PrettyDuration(ProcessCpuNanoTime() - start_cputime_ns_) << " cpu)"
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002616 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002617 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002618 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2619 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002620 }
2621
Jeff Haodcdc85b2015-12-04 14:06:18 -08002622 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2623 std::string res(image_filename);
2624 size_t last_slash = res.rfind('/');
2625 if (last_slash == std::string::npos || last_slash == 0) {
2626 return res;
2627 }
2628 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2629 if (penultimate_slash == std::string::npos) {
2630 return res;
2631 }
2632 // Check that the string in-between is the expected one.
2633 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2634 GetInstructionSetString(isa)) {
2635 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2636 return res;
2637 }
2638 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2639 }
2640
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002641 std::unique_ptr<CompilerOptions> compiler_options_;
2642 Compiler::Kind compiler_kind_;
2643
2644 InstructionSet instruction_set_;
2645 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2646
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002647 uint32_t image_file_location_oat_checksum_;
2648 uintptr_t image_file_location_oat_data_begin_;
2649 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002650 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2651
Vladimir Marko307dac92015-10-20 11:20:09 +01002652 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002653
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002654 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2655
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002656 std::unique_ptr<Runtime> runtime_;
2657
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002658 // Ownership for the class path files.
2659 std::vector<std::unique_ptr<const DexFile>> class_path_files_;
2660
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002661 size_t thread_count_;
2662 uint64_t start_ns_;
Andreas Gampec560fc02014-07-16 09:57:39 -07002663 uint64_t start_cputime_ns_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002664 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002665 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002666 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002667 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002668 std::vector<const char*> oat_filenames_;
2669 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002670 int oat_fd_;
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +00002671 int input_vdex_fd_;
2672 int output_vdex_fd_;
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002673 std::string input_vdex_;
2674 std::unique_ptr<VdexFile> input_vdex_file_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002675 std::vector<const char*> dex_filenames_;
2676 std::vector<const char*> dex_locations_;
2677 int zip_fd_;
2678 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002679 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002680 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002681 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002682 uintptr_t image_base_;
2683 const char* image_classes_zip_filename_;
2684 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002685 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002686 const char* compiled_classes_zip_filename_;
2687 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002688 const char* compiled_methods_zip_filename_;
2689 const char* compiled_methods_filename_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002690 const char* passes_to_run_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002691 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2692 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002693 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002694 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Jeff Hao436183f2016-01-12 16:36:50 -08002695 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002696 bool is_host_;
2697 std::string android_root_;
Mathieu Chartier0b490842016-05-25 15:05:59 -07002698 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002699 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002700 std::string no_inline_from_string_;
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002701 std::vector<jobject> dex_caches_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002702 jobject class_loader_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002703
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002704 std::vector<std::unique_ptr<ElfWriter>> elf_writers_;
2705 std::vector<std::unique_ptr<OatWriter>> oat_writers_;
2706 std::vector<OutputStream*> rodata_;
David Brazdil5d5a36b2016-09-14 15:34:10 +01002707 std::vector<std::unique_ptr<OutputStream>> vdex_out_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002708 std::unique_ptr<ImageWriter> image_writer_;
2709 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002710
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002711 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
Jeff Haofbeb1322016-04-26 14:27:31 -07002712 std::vector<std::unique_ptr<OatFile>> opened_oat_files_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002713 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2714
Vladimir Marko47496c22016-01-27 16:15:08 +00002715 std::vector<const DexFile*> no_inline_from_dex_files_;
2716
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002717 std::vector<std::string> verbose_methods_;
2718 bool dump_stats_;
2719 bool dump_passes_;
2720 bool dump_timing_;
2721 bool dump_slow_timing_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002722 std::string swap_file_name_;
2723 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002724 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2725 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002726 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002727 std::string app_image_file_name_;
2728 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002729 std::string profile_file_;
2730 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002731 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002732 TimingLogger* timings_;
2733 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002734 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002735 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002736
2737 // Backing storage.
2738 std::vector<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002739
Andreas Gampeace0dc12016-01-20 13:33:13 -08002740 // See CompilerOptions.force_determinism_.
2741 bool force_determinism_;
2742
Nicolas Geoffray81f57d12016-12-20 13:17:09 +00002743 // Whether the given input vdex is also the output.
2744 bool update_input_vdex_ = false;
2745
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002746 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2747};
2748
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002749static void b13564922() {
2750#if defined(__linux__) && defined(__arm__)
2751 int major, minor;
2752 struct utsname uts;
2753 if (uname(&uts) != -1 &&
2754 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2755 ((major < 3) || ((major == 3) && (minor < 4)))) {
2756 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2757 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2758 int old_personality = personality(0xffffffff);
2759 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2760 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2761 if (new_personality == -1) {
2762 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2763 }
2764 }
2765 }
2766#endif
2767}
2768
Andreas Gampe10e477d2014-11-19 12:57:42 -08002769static int CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002770 dex2oat.LoadClassProfileDescriptors();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002771 dex2oat.Compile();
2772
David Brazdil7b49e6c2016-09-01 11:06:18 +01002773 if (!dex2oat.WriteOutputFiles()) {
2774 dex2oat.EraseOutputFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002775 return EXIT_FAILURE;
2776 }
2777
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002778 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2779 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2780 // image writer will require this fd to generate the image.
2781 if (dex2oat.ShouldKeepOatFileOpen()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002782 if (!dex2oat.FlushOutputFiles()) {
2783 dex2oat.EraseOutputFiles();
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002784 return EXIT_FAILURE;
2785 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01002786 } else if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002787 return EXIT_FAILURE;
2788 }
2789
Jeff Haodcdc85b2015-12-04 14:06:18 -08002790 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002791 if (!dex2oat.HandleImage()) {
2792 return EXIT_FAILURE;
2793 }
2794
2795 // When given --host, finish early without stripping.
2796 if (dex2oat.IsHost()) {
2797 dex2oat.DumpTiming();
2798 return EXIT_SUCCESS;
2799 }
2800
Jeff Haodcdc85b2015-12-04 14:06:18 -08002801 // Copy stripped to unstripped location, if necessary.
2802 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002803 return EXIT_FAILURE;
2804 }
2805
Jeff Haodcdc85b2015-12-04 14:06:18 -08002806 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002807 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002808 return EXIT_FAILURE;
2809 }
2810
2811 dex2oat.DumpTiming();
2812 return EXIT_SUCCESS;
2813}
2814
2815static int CompileApp(Dex2Oat& dex2oat) {
2816 dex2oat.Compile();
2817
David Brazdil7b49e6c2016-09-01 11:06:18 +01002818 if (!dex2oat.WriteOutputFiles()) {
2819 dex2oat.EraseOutputFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002820 return EXIT_FAILURE;
2821 }
2822
Jeff Haodcdc85b2015-12-04 14:06:18 -08002823 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002824 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002825
2826 // When given --host, finish early without stripping.
2827 if (dex2oat.IsHost()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002828 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002829 return EXIT_FAILURE;
2830 }
2831
2832 dex2oat.DumpTiming();
2833 return EXIT_SUCCESS;
2834 }
2835
Jeff Haodcdc85b2015-12-04 14:06:18 -08002836 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2837 // stripped versions. If this is given, we expect to be able to open writable files by name.
2838 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002839 return EXIT_FAILURE;
2840 }
2841
Jeff Haodcdc85b2015-12-04 14:06:18 -08002842 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002843 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002844 return EXIT_FAILURE;
2845 }
2846
2847 dex2oat.DumpTiming();
2848 return EXIT_SUCCESS;
2849}
2850
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002851static int dex2oat(int argc, char** argv) {
2852 b13564922();
2853
2854 TimingLogger timings("compiler", false, false);
2855
Roland Levillain5c7e2602016-02-23 18:08:53 +00002856 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
2857 // might produce a stack frame too large for this function or for
2858 // functions inlining it (such as main), that would not fit the
2859 // requirements of the `-Wframe-larger-than` option.
2860 std::unique_ptr<Dex2Oat> dex2oat = MakeUnique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002861
2862 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002863 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002864
Calin Juravleb077e152016-02-18 18:47:37 +00002865 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02002866 // This operation involves I/O.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002867 if (dex2oat->UseProfileGuidedCompilation()) {
Calin Juravleb077e152016-02-18 18:47:37 +00002868 if (!dex2oat->LoadProfile()) {
2869 LOG(ERROR) << "Failed to process profile file";
Calin Juravle998c2162015-12-21 15:39:33 +02002870 return EXIT_FAILURE;
2871 }
2872 }
2873
Nicolas Geoffrayb0bbe8e2016-11-19 10:42:37 +00002874 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap, and vdex.
2875
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002876 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00002877 if (!dex2oat->OpenFile()) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002878 return EXIT_FAILURE;
2879 }
2880
Andreas Gampe046c7062015-05-18 23:22:54 -07002881 // Print the complete line when any of the following is true:
2882 // 1) Debug build
2883 // 2) Compiling an image
2884 // 3) Compiling with --host
2885 // 4) Compiling on the host (not a target build)
2886 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002887 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07002888 LOG(INFO) << CommandLine();
2889 } else {
2890 LOG(INFO) << StrippedCommandLine();
2891 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002892
Roland Levillain5c7e2602016-02-23 18:08:53 +00002893 if (!dex2oat->Setup()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002894 dex2oat->EraseOutputFiles();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002895 return EXIT_FAILURE;
2896 }
2897
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07002898 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
2899 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07002900 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
2901
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002902 bool result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00002903 if (dex2oat->IsImage()) {
2904 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002905 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00002906 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002907 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002908
Roland Levillain5c7e2602016-02-23 18:08:53 +00002909 dex2oat->Shutdown();
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002910 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002911}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002912} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07002913
2914int main(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002915 int result = art::dex2oat(argc, argv);
2916 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
2917 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
2918 // should not destruct the runtime in this case.
Evgenii Stepanov1e133742015-05-20 12:30:59 -07002919 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002920 exit(result);
2921 }
2922 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002923}