blob: ec6f96f599ff559b194b60227d6aff3ab6101969 [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>
25#include <sstream>
26#include <string>
Andreas Gampeb1fcead2015-04-20 18:53:51 -070027#include <unordered_set>
Brian Carlstrom7940e442013-07-12 13:46:57 -070028#include <vector>
29
Vladimir Markof94b7812014-06-05 15:48:04 +010030#if defined(__linux__) && defined(__arm__)
31#include <sys/personality.h>
32#include <sys/utsname.h>
33#endif
34
Ian Rogersd582fa42014-11-05 23:46:43 -080035#include "arch/instruction_set_features.h"
Andreas Gampec5a3ea72015-01-13 16:41:53 -080036#include "arch/mips/instruction_set_features_mips.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000037#include "art_method-inl.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070038#include "base/dumpable.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080039#include "base/macros.h"
Calin Juravle2e2db782016-02-23 12:00:03 +000040#include "base/scoped_flock.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070041#include "base/stl_util.h"
42#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010043#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070044#include "base/timing_logger.h"
45#include "base/unix_file/fd_file.h"
46#include "class_linker.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000047#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000048#include "compiler_callbacks.h"
David Srbecky09c2a6b2016-03-11 17:11:44 +000049#include "debug/elf_debug_writer.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000050#include "debug/method_debug_info.h"
Ian Rogerse63db272014-07-15 15:36:11 -070051#include "dex/quick/dex_file_to_method_inliner_map.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000052#include "dex/quick_compiler_callbacks.h"
53#include "dex/verification_results.h"
54#include "dex_file-inl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070055#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080056#include "driver/compiler_options.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080057#include "elf_file.h"
Tong Shen62d1ca32014-09-03 17:24:56 -070058#include "elf_writer.h"
Vladimir Marko10c13562015-11-25 14:33:36 +000059#include "elf_writer_quick.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070060#include "gc/space/image_space.h"
61#include "gc/space/space-inl.h"
62#include "image_writer.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070063#include "interpreter/unstarted_runtime.h"
Calin Juravle998c2162015-12-21 15:39:33 +020064#include "jit/offline_profiling_info.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070065#include "leb128.h"
Vladimir Marko944da602016-02-19 12:27:55 +000066#include "linker/multi_oat_relative_patcher.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070067#include "mirror/class-inl.h"
68#include "mirror/class_loader.h"
69#include "mirror/object-inl.h"
70#include "mirror/object_array-inl.h"
71#include "oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070072#include "os.h"
73#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000074#include "runtime_options.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070075#include "ScopedLocalRef.h"
76#include "scoped_thread_state_change.h"
Alex Light53cb16b2014-06-12 11:26:29 -070077#include "utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070078#include "well_known_classes.h"
79#include "zip_archive.h"
80
81namespace art {
82
Brian Carlstrom6449c622014-02-10 23:48:36 -080083static int original_argc;
84static char** original_argv;
85
86static std::string CommandLine() {
87 std::vector<std::string> command;
88 for (int i = 0; i < original_argc; ++i) {
89 command.push_back(original_argv[i]);
90 }
91 return Join(command, ' ');
92}
93
Andreas Gampe046c7062015-05-18 23:22:54 -070094// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
95// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
96// locations are all staged).
97static std::string StrippedCommandLine() {
98 std::vector<std::string> command;
99
100 // Do a pre-pass to look for zip-fd.
101 bool saw_zip_fd = false;
102 for (int i = 0; i < original_argc; ++i) {
103 if (StartsWith(original_argv[i], "--zip-fd=")) {
104 saw_zip_fd = true;
105 break;
106 }
107 }
108
109 // Now filter out things.
110 for (int i = 0; i < original_argc; ++i) {
111 // All runtime-arg parameters are dropped.
112 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
113 i++; // Drop the next part, too.
114 continue;
115 }
116
117 // Any instruction-setXXX is dropped.
118 if (StartsWith(original_argv[i], "--instruction-set")) {
119 continue;
120 }
121
122 // The boot image is dropped.
123 if (StartsWith(original_argv[i], "--boot-image=")) {
124 continue;
125 }
126
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800127 // The image format is dropped.
128 if (StartsWith(original_argv[i], "--image-format=")) {
129 continue;
130 }
131
Andreas Gampe046c7062015-05-18 23:22:54 -0700132 // This should leave any dex-file and oat-file options, describing what we compiled.
133
134 // However, we prefer to drop this when we saw --zip-fd.
135 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700136 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe046c7062015-05-18 23:22:54 -0700137 if (StartsWith(original_argv[i], "--zip-") ||
138 StartsWith(original_argv[i], "--dex-") ||
139 StartsWith(original_argv[i], "--oat-") ||
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700140 StartsWith(original_argv[i], "--swap-") ||
141 StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700142 continue;
143 }
144 }
145
146 command.push_back(original_argv[i]);
147 }
148
149 // Construct the final output.
150 if (command.size() <= 1U) {
151 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
152 return "Starting dex2oat.";
153 }
154 return Join(command, ' ');
155}
156
Brian Carlstrom7940e442013-07-12 13:46:57 -0700157static void UsageErrorV(const char* fmt, va_list ap) {
158 std::string error;
159 StringAppendV(&error, fmt, ap);
160 LOG(ERROR) << error;
161}
162
163static void UsageError(const char* fmt, ...) {
164 va_list ap;
165 va_start(ap, fmt);
166 UsageErrorV(fmt, ap);
167 va_end(ap);
168}
169
Andreas Gampe794ad762015-02-23 08:12:24 -0800170NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700171 va_list ap;
172 va_start(ap, fmt);
173 UsageErrorV(fmt, ap);
174 va_end(ap);
175
Brian Carlstrom6449c622014-02-10 23:48:36 -0800176 UsageError("Command: %s", CommandLine().c_str());
177
Brian Carlstrom7940e442013-07-12 13:46:57 -0700178 UsageError("Usage: dex2oat [options]...");
179 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100180 UsageError(" -j<number>: specifies the number of threads used for compilation.");
181 UsageError(" Default is the number of detected hardware threads available on the");
182 UsageError(" host system.");
183 UsageError(" Example: -j12");
184 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700185 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700186 UsageError(" Example: --dex-file=/system/framework/core.jar");
187 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700188 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
189 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
190 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
191 UsageError(" --dex-location=/system/framework/core.jar");
192 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700193 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
194 UsageError(" containing a classes.dex file to compile.");
195 UsageError(" Example: --zip-fd=5");
196 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700197 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
198 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700199 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
200 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800201 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700202 UsageError(" Example: --oat-file=/system/framework/boot.oat");
203 UsageError("");
204 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900205 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700206 UsageError("");
207 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
208 UsageError(" to the file descriptor specified by --oat-fd.");
209 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
210 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800211 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700212 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
213 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800214 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700215 UsageError(" Example: --image=/system/framework/boot.art");
216 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800217 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800218 UsageError(" Which format to store the image.");
219 UsageError(" Example: --image-format=lz4");
220 UsageError(" Default: uncompressed");
221 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700222 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
223 UsageError(" Example: --image=frameworks/base/preloaded-classes");
224 UsageError("");
225 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
226 UsageError(" Example: --base=0x50000000");
227 UsageError("");
228 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000229 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700230 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000231 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000232 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700233 UsageError("");
234 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
235 UsageError(" Example: --android-root=out/host/linux-x86");
236 UsageError(" Default: $ANDROID_ROOT");
237 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800238 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700239 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700240 UsageError(" Example: --instruction-set=x86");
241 UsageError(" Default: arm");
242 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700243 UsageError(" --instruction-set-features=...,: Specify instruction set features");
244 UsageError(" Example: --instruction-set-features=div");
245 UsageError(" Default: default");
246 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700247 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
248 UsageError(" Default: disabled");
249 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800250 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700251 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800252 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100253 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700254 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100255 UsageError(" --compiler-filter="
256 "(verify-none"
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700257 "|verify-at-runtime"
Mathieu Chartiera8077802016-03-16 19:08:31 -0700258 "|verify-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100259 "|interpret-only"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000260 "|time"
261 "|space-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100262 "|space"
263 "|balanced"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000264 "|speed-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100265 "|speed"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000266 "|everything-profile"
267 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700268 UsageError(" select compiler filter.");
Mathieu Chartiera8077802016-03-16 19:08:31 -0700269 UsageError(" verify-profile requires a --profile(-fd) to also be passed in.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800270 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800271 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800272 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800273 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
274 UsageError(" method for compiler filter tuning.");
275 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
276 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
277 UsageError("");
278 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
279 UsageError(" method for compiler filter tuning.");
280 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
281 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
282 UsageError("");
283 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
284 UsageError(" method for compiler filter tuning.");
285 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
286 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
287 UsageError("");
288 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
289 UsageError(" method for compiler filter tuning.");
290 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
291 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
292 UsageError("");
293 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
294 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700295 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
296 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800297 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
298 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
299 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100300 UsageError(" --inline-depth-limit=<depth-limit>: the depth limit of inlining for fine tuning");
301 UsageError(" the compiler. A zero value will disable inlining. Honored only by Optimizing.");
Roland Levillaina215b952015-08-07 11:38:32 +0100302 UsageError(" Has priority over the --compiler-filter option. Intended for ");
303 UsageError(" development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100304 UsageError(" Example: --inline-depth-limit=%d", CompilerOptions::kDefaultInlineDepthLimit);
305 UsageError(" Default: %d", CompilerOptions::kDefaultInlineDepthLimit);
306 UsageError("");
307 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
308 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100309 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
310 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100311 UsageError(" Example: --inline-max-code-units=%d",
312 CompilerOptions::kDefaultInlineMaxCodeUnits);
313 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
314 UsageError("");
Ian Rogers46398602013-08-20 07:50:36 -0700315 UsageError(" --dump-timing: display a breakdown of where time was spent");
316 UsageError("");
Alex Light53cb16b2014-06-12 11:26:29 -0700317 UsageError(" --include-patch-information: Include patching information so the generated code");
318 UsageError(" can have its base address moved without full recompilation.");
319 UsageError("");
320 UsageError(" --no-include-patch-information: Do not include patching information.");
321 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100322 UsageError(" -g");
323 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
324 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000325 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000326 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700327 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100328 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100329 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000330 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
331 UsageError(" debug information necessary to print backtraces. (disabled by default)");
332 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000333 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000334 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000335 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000336 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700337 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
338 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
339 UsageError(" Use a separate --runtime-arg switch for each argument.");
340 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700341 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000342 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700343 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000344 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
345 UsageError(" Cannot be used together with --profile-file.");
346 UsageError("");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800347 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
348 UsageError(" Example: --swap-file=/data/tmp/swap.001");
349 UsageError("");
350 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
351 UsageError(" Example: --swap-fd=10");
352 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700353 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
354 UsageError(" Example: --app-image-fd=10");
355 UsageError("");
356 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
357 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
358 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800359 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
360 "input dex file.");
361 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000362 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
363 UsageError(" This option is incompatible with read barriers (e.g., if dex2oat has been");
364 UsageError(" built with the environment variable `ART_USE_READ_BARRIER` set to `true`).");
365 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700366 std::cerr << "See log for usage error information\n";
367 exit(EXIT_FAILURE);
368}
369
Brian Carlstrom7940e442013-07-12 13:46:57 -0700370// The primary goal of the watchdog is to prevent stuck build servers
371// during development when fatal aborts lead to a cascade of failures
372// that result in a deadlock.
373class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800374// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700375#undef CHECK_PTHREAD_CALL
376#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
377 do { \
378 int rc = call args; \
379 if (rc != 0) { \
380 errno = rc; \
381 std::string message(# call); \
382 message += " failed for "; \
383 message += reason; \
384 Fatal(message); \
385 } \
386 } while (false)
387
388 public:
Brian Carlstrom93ba8932013-07-17 21:31:49 -0700389 explicit WatchDog(bool is_watch_dog_enabled) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700390 is_watch_dog_enabled_ = is_watch_dog_enabled;
391 if (!is_watch_dog_enabled_) {
392 return;
393 }
394 shutting_down_ = false;
395 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700396 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
397 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700398 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
399 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
400 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
401 }
402 ~WatchDog() {
403 if (!is_watch_dog_enabled_) {
404 return;
405 }
406 const char* reason = "dex2oat watch dog thread shutdown";
407 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
408 shutting_down_ = true;
409 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
410 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
411
Kenny Root51316382014-05-13 14:59:37 -0700412 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700413
414 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
415 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
416 }
417
418 private:
419 static void* CallBack(void* arg) {
420 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
421 ::art::SetThreadName("dex2oat watch dog");
422 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700423 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700424 }
425
Andreas Gampe794ad762015-02-23 08:12:24 -0800426 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700427 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
428 // it's rather easy to hang in unwinding.
429 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
430 // logcat logging or stderr output.
431 LogMessage::LogLine(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700432 exit(1);
433 }
434
435 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700436 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
437 // large.
Andreas Gamped687e372015-04-28 23:16:03 -0700438 constexpr int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700439 timespec timeout_ts;
440 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts);
441 const char* reason = "dex2oat watch dog thread waiting";
442 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
443 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800444 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700445 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700446 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
447 kWatchDogTimeoutSeconds));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700448 } else if (rc != 0) {
449 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
450 strerror(errno)));
451 Fatal(message.c_str());
452 }
453 }
454 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
455 }
456
457 // 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 -0700458 // Debug builds are slower so they have larger timeouts.
Andreas Gamped687e372015-04-28 23:16:03 -0700459 static constexpr int64_t kSlowdownFactor = kIsDebugBuild ? 5U : 1U;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800460
Andreas Gampe540138a2015-09-14 15:34:38 -0700461 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
462 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
463 // itself before that watchdog would take down the system server.
464 static constexpr int64_t kWatchDogTimeoutSeconds = kSlowdownFactor * (9 * 60 + 30);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700465
466 bool is_watch_dog_enabled_;
467 bool shutting_down_;
468 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
469 pthread_mutex_t mutex_;
470 pthread_cond_t cond_;
471 pthread_attr_t attr_;
472 pthread_t pthread_;
473};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700474
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800475static constexpr size_t kMinDexFilesForSwap = 2;
476static constexpr size_t kMinDexFileCumulativeSizeForSwap = 20 * MB;
477
478static bool UseSwap(bool is_image, std::vector<const DexFile*>& dex_files) {
479 if (is_image) {
480 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
481 return false;
482 }
483 if (dex_files.size() < kMinDexFilesForSwap) {
484 // If there are less dex files than the threshold, assume it's gonna be fine.
485 return false;
486 }
487 size_t dex_files_size = 0;
488 for (const auto* dex_file : dex_files) {
489 dex_files_size += dex_file->GetHeader().file_size_;
490 }
491 return dex_files_size >= kMinDexFileCumulativeSizeForSwap;
492}
493
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800494class Dex2Oat FINAL {
495 public:
496 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100497 compiler_kind_(Compiler::kOptimizing),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800498 instruction_set_(kRuntimeISA),
499 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000500 image_file_location_oat_checksum_(0),
501 image_file_location_oat_data_begin_(0),
502 image_patch_delta_(0),
503 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700504 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800505 method_inliner_map_(),
506 runtime_(nullptr),
507 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
508 start_ns_(NanoTime()),
509 oat_fd_(-1),
510 zip_fd_(-1),
511 image_base_(0U),
512 image_classes_zip_filename_(nullptr),
513 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800514 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800515 compiled_classes_zip_filename_(nullptr),
516 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700517 compiled_methods_zip_filename_(nullptr),
518 compiled_methods_filename_(nullptr),
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700519 app_image_(false),
520 boot_image_(false),
Jeff Hao436183f2016-01-12 16:36:50 -0800521 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800522 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000523 class_loader_(nullptr),
524 elf_writers_(),
525 oat_writers_(),
526 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000527 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700528 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000529 opened_dex_files_maps_(),
530 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000531 no_inline_from_dex_files_(),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800532 dump_stats_(false),
533 dump_passes_(false),
534 dump_timing_(false),
535 dump_slow_timing_(kIsDebugBuild),
Calin Juravle2e2db782016-02-23 12:00:03 +0000536 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800537 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000538 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800539 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000540 force_determinism_(false)
541 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800542
543 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800544 // Log completion time before deleting the runtime_, because this accesses
545 // the runtime.
546 LogCompletionTime();
547
Vladimir Marko307dac92015-10-20 11:20:09 +0100548 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
549 // We want to just exit on non-debug builds, not bringing the runtime down
550 // in an orderly fashion. So release the following fields.
551 driver_.release();
552 image_writer_.release();
553 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
554 dex_file.release();
555 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000556 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
557 map.release();
558 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800559 for (std::unique_ptr<File>& oat_file : oat_files_) {
560 oat_file.release();
561 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100562 runtime_.release();
563 verification_results_.release();
564 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100565 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700566 }
567
Roland Levillain9ec5e222015-08-17 20:18:41 +0100568 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800569 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800570 std::string boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800571 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000572 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800573 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100574 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800575
Roland Levillain9ec5e222015-08-17 20:18:41 +0100576 void ParseZipFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000577 ParseUintOption(option, "--zip-fd", &zip_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100578 }
579
580 void ParseOatFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000581 ParseUintOption(option, "--oat-fd", &oat_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100582 }
583
Calin Juravle877fd962016-01-05 14:29:29 +0000584 void ParseFdForCollection(const StringPiece& option,
585 const char* arg_name,
586 std::vector<uint32_t>* fds) {
587 uint32_t fd;
588 ParseUintOption(option, arg_name, &fd, Usage);
589 fds->push_back(fd);
590 }
591
Roland Levillain9ec5e222015-08-17 20:18:41 +0100592 void ParseJ(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000593 ParseUintOption(option, "-j", &thread_count_, Usage, /* is_long_option */ false);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100594 }
595
596 void ParseBase(const StringPiece& option) {
597 DCHECK(option.starts_with("--base="));
598 const char* image_base_str = option.substr(strlen("--base=")).data();
599 char* end;
600 image_base_ = strtoul(image_base_str, &end, 16);
601 if (end == image_base_str || *end != '\0') {
602 Usage("Failed to parse hexadecimal value for option %s", option.data());
603 }
604 }
605
606 void ParseInstructionSet(const StringPiece& option) {
607 DCHECK(option.starts_with("--instruction-set="));
608 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
609 // StringPiece is not necessarily zero-terminated, so need to make a copy and ensure it.
610 std::unique_ptr<char[]> buf(new char[instruction_set_str.length() + 1]);
611 strncpy(buf.get(), instruction_set_str.data(), instruction_set_str.length());
612 buf.get()[instruction_set_str.length()] = 0;
613 instruction_set_ = GetInstructionSetFromString(buf.get());
614 // arm actually means thumb2.
615 if (instruction_set_ == InstructionSet::kArm) {
616 instruction_set_ = InstructionSet::kThumb2;
617 }
618 }
619
620 void ParseInstructionSetVariant(const StringPiece& option, ParserOptions* parser_options) {
621 DCHECK(option.starts_with("--instruction-set-variant="));
622 StringPiece str = option.substr(strlen("--instruction-set-variant=")).data();
623 instruction_set_features_.reset(
624 InstructionSetFeatures::FromVariant(
625 instruction_set_, str.as_string(), &parser_options->error_msg));
626 if (instruction_set_features_.get() == nullptr) {
627 Usage("%s", parser_options->error_msg.c_str());
628 }
629 }
630
631 void ParseInstructionSetFeatures(const StringPiece& option, ParserOptions* parser_options) {
632 DCHECK(option.starts_with("--instruction-set-features="));
633 StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
634 if (instruction_set_features_.get() == nullptr) {
635 instruction_set_features_.reset(
636 InstructionSetFeatures::FromVariant(
637 instruction_set_, "default", &parser_options->error_msg));
638 if (instruction_set_features_.get() == nullptr) {
639 Usage("Problem initializing default instruction set features variant: %s",
640 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700641 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800642 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100643 instruction_set_features_.reset(
644 instruction_set_features_->AddFeaturesFromString(str.as_string(),
645 &parser_options->error_msg));
646 if (instruction_set_features_.get() == nullptr) {
647 Usage("Error parsing '%s': %s", option.data(), parser_options->error_msg.c_str());
648 }
649 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800650
Roland Levillain9ec5e222015-08-17 20:18:41 +0100651 void ParseCompilerBackend(const StringPiece& option, ParserOptions* parser_options) {
652 DCHECK(option.starts_with("--compiler-backend="));
653 parser_options->requested_specific_compiler = true;
654 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
655 if (backend_str == "Quick") {
656 compiler_kind_ = Compiler::kQuick;
657 } else if (backend_str == "Optimizing") {
658 compiler_kind_ = Compiler::kOptimizing;
659 } else {
660 Usage("Unknown compiler backend: %s", backend_str.data());
661 }
662 }
663
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800664 void ParseImageFormat(const StringPiece& option) {
665 const StringPiece substr("--image-format=");
666 DCHECK(option.starts_with(substr));
667 const StringPiece format_str = option.substr(substr.length());
668 if (format_str == "lz4") {
669 image_storage_mode_ = ImageHeader::kStorageModeLZ4;
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800670 } else if (format_str == "lz4hc") {
671 image_storage_mode_ = ImageHeader::kStorageModeLZ4HC;
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800672 } else if (format_str == "uncompressed") {
673 image_storage_mode_ = ImageHeader::kStorageModeUncompressed;
674 } else {
675 Usage("Unknown image format: %s", format_str.data());
676 }
677 }
678
Jeff Hao436183f2016-01-12 16:36:50 -0800679 void ProcessOptions(ParserOptions* parser_options) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800680 boot_image_ = !image_filenames_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700681 app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
682
683 if (IsAppImage() && IsBootImage()) {
684 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
685 }
686
Nicolas Geoffray0c6e3342016-03-04 11:38:14 +0000687 if (IsBootImage()) {
688 // We need the boot image to always be debuggable.
689 // TODO: Remove this once we better deal with full frame deoptimization.
690 compiler_options_->debuggable_ = true;
691 }
692
Jeff Haodcdc85b2015-12-04 14:06:18 -0800693 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800694 Usage("Output must be supplied with either --oat-file or --oat-fd");
695 }
696
Jeff Haodcdc85b2015-12-04 14:06:18 -0800697 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800698 Usage("--oat-file should not be used with --oat-fd");
699 }
700
Roland Levillain9ec5e222015-08-17 20:18:41 +0100701 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800702 Usage("--oat-symbols should not be used with --oat-fd");
703 }
704
Roland Levillain9ec5e222015-08-17 20:18:41 +0100705 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800706 Usage("--oat-symbols should not be used with --host");
707 }
708
Jeff Haodcdc85b2015-12-04 14:06:18 -0800709 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800710 Usage("--oat-fd should not be used with --image");
711 }
712
Jeff Haodcdc85b2015-12-04 14:06:18 -0800713 if (!parser_options->oat_symbols.empty() &&
714 parser_options->oat_symbols.size() != oat_filenames_.size()) {
715 Usage("--oat-file arguments do not match --oat-symbols arguments");
716 }
717
718 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
719 Usage("--oat-file arguments do not match --image arguments");
720 }
721
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800722 if (android_root_.empty()) {
723 const char* android_root_env_var = getenv("ANDROID_ROOT");
724 if (android_root_env_var == nullptr) {
725 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700726 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800727 android_root_ += android_root_env_var;
728 }
729
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700730 if (!boot_image_ && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100731 parser_options->boot_image_filename += android_root_;
732 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800733 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100734 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000735 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800736 }
737
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700738 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800739 Usage("--image-classes should only be used with --image");
740 }
741
Vladimir Marko49b0f452015-12-10 13:49:19 +0000742 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800743 Usage("--image-classes should not be used with --boot-image");
744 }
745
746 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
747 Usage("--image-classes-zip should be used with --image-classes");
748 }
749
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700750 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800751 Usage("--compiled-classes should only be used with --image");
752 }
753
Vladimir Marko49b0f452015-12-10 13:49:19 +0000754 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800755 Usage("--compiled-classes should not be used with --boot-image");
756 }
757
758 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
759 Usage("--compiled-classes-zip should be used with --compiled-classes");
760 }
761
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800762 if (dex_filenames_.empty() && zip_fd_ == -1) {
763 Usage("Input must be supplied with either --dex-file or --zip-fd");
764 }
765
766 if (!dex_filenames_.empty() && zip_fd_ != -1) {
767 Usage("--dex-file should not be used with --zip-fd");
768 }
769
770 if (!dex_filenames_.empty() && !zip_location_.empty()) {
771 Usage("--dex-file should not be used with --zip-location");
772 }
773
774 if (dex_locations_.empty()) {
775 for (const char* dex_file_name : dex_filenames_) {
776 dex_locations_.push_back(dex_file_name);
777 }
778 } else if (dex_locations_.size() != dex_filenames_.size()) {
779 Usage("--dex-location arguments do not match --dex-file arguments");
780 }
781
Jeff Haodcdc85b2015-12-04 14:06:18 -0800782 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
783 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
784 Usage("--oat-file arguments must be singular or match --dex-file arguments");
785 }
786 }
787
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800788 if (zip_fd_ != -1 && zip_location_.empty()) {
789 Usage("--zip-location should be supplied with --zip-fd");
790 }
791
Vladimir Marko49b0f452015-12-10 13:49:19 +0000792 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800793 if (image_base_ == 0) {
794 Usage("Non-zero --base not specified");
795 }
796 }
797
Mathieu Chartiera8077802016-03-16 19:08:31 -0700798 const bool have_profile_file = !profile_file_.empty();
799 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
800 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000801 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200802 }
803
Roland Levillain9ec5e222015-08-17 20:18:41 +0100804 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800805 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800806 }
807
808 // If no instruction set feature was given, use the default one for the target
809 // instruction set.
810 if (instruction_set_features_.get() == nullptr) {
811 instruction_set_features_.reset(
Roland Levillain9ec5e222015-08-17 20:18:41 +0100812 InstructionSetFeatures::FromVariant(
813 instruction_set_, "default", &parser_options->error_msg));
Ian Rogersd582fa42014-11-05 23:46:43 -0800814 if (instruction_set_features_.get() == nullptr) {
815 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100816 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800817 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800818 }
819
820 if (instruction_set_ == kRuntimeISA) {
821 std::unique_ptr<const InstructionSetFeatures> runtime_features(
822 InstructionSetFeatures::FromCppDefines());
823 if (!instruction_set_features_->Equals(runtime_features.get())) {
824 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
825 << *instruction_set_features_ << ") and those of dex2oat executable ("
826 << *runtime_features <<") for the command line:\n"
827 << CommandLine();
828 }
829 }
830
Roland Levillaina215b952015-08-07 11:38:32 +0100831 // It they are not set, use default values for inlining settings.
832 // TODO: We should rethink the compiler filter. We mostly save
833 // time here, which is orthogonal to space.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000834 if (compiler_options_->inline_depth_limit_ == CompilerOptions::kUnsetInlineDepthLimit) {
835 compiler_options_->inline_depth_limit_ =
Andreas Gampe29d38e72016-03-23 15:31:51 +0000836 (compiler_options_->compiler_filter_ == CompilerFilter::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100837 // Implementation of the space filter: limit inlining depth.
838 ? CompilerOptions::kSpaceFilterInlineDepthLimit
839 : CompilerOptions::kDefaultInlineDepthLimit;
840 }
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000841 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
842 compiler_options_->inline_max_code_units_ =
Andreas Gampe29d38e72016-03-23 15:31:51 +0000843 (compiler_options_->compiler_filter_ == CompilerFilter::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100844 // Implementation of the space filter: limit inlining max code units.
845 ? CompilerOptions::kSpaceFilterInlineMaxCodeUnits
846 : CompilerOptions::kDefaultInlineMaxCodeUnits;
847 }
848
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800849 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800850 // Set the compilation target's implicit checks options.
851 switch (instruction_set_) {
852 case kArm:
853 case kThumb2:
854 case kArm64:
855 case kX86:
856 case kX86_64:
Douglas Leung22bb5a22015-07-02 16:42:08 -0700857 case kMips:
858 case kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000859 compiler_options_->implicit_null_checks_ = true;
860 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800861 break;
862
863 default:
864 // Defaults are correct.
865 break;
866 }
867
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000868 compiler_options_->verbose_methods_ = verbose_methods_.empty() ? nullptr : &verbose_methods_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800869
Jeff Hao436183f2016-01-12 16:36:50 -0800870 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800871 Usage("--multi-image can only be used when creating boot images");
872 }
Jeff Hao436183f2016-01-12 16:36:50 -0800873 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800874 Usage("--multi-image cannot be used with multiple image names");
875 }
876
877 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
878 if (!kIsTargetBuild && IsBootImage()) {
879 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800880 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800881 }
882 }
883
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800884 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100885 if (parser_options->watch_dog_enabled) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800886 watchdog_.reset(new WatchDog(true));
887 }
888
889 // Fill some values into the key-value store for the oat header.
890 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800891
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800892 // Automatically force determinism for the boot image in a host build if the default GC is CMS
893 // or MS and read barriers are not enabled, as the former switches the GC to a non-concurrent
894 // one by passing the option `-Xgc:nonconcurrent` (see below).
895 if (!kIsTargetBuild && IsBootImage()) {
896 if (SupportsDeterministicCompilation()) {
897 force_determinism_ = true;
898 } else {
899 LOG(WARNING) << "Deterministic compilation is disabled.";
900 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800901 }
902 compiler_options_->force_determinism_ = force_determinism_;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100903 }
904
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800905 static bool SupportsDeterministicCompilation() {
906 return (gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
907 gc::kCollectorTypeDefault == gc::kCollectorTypeMS) &&
908 !kEmitCompilerReadBarrier;
909 }
910
Jeff Hao436183f2016-01-12 16:36:50 -0800911 void ExpandOatAndImageFilenames() {
912 std::string base_oat = oat_filenames_[0];
913 size_t last_oat_slash = base_oat.rfind('/');
914 if (last_oat_slash == std::string::npos) {
915 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
916 }
917 // We also need to honor path components that were encoded through '@'. Otherwise the loading
918 // code won't be able to find the images.
919 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
920 last_oat_slash = base_oat.rfind('@');
921 }
922 base_oat = base_oat.substr(0, last_oat_slash + 1);
923
924 std::string base_img = image_filenames_[0];
925 size_t last_img_slash = base_img.rfind('/');
926 if (last_img_slash == std::string::npos) {
927 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
928 }
929 // We also need to honor path components that were encoded through '@'. Otherwise the loading
930 // code won't be able to find the images.
931 if (base_img.find('@', last_img_slash) != std::string::npos) {
932 last_img_slash = base_img.rfind('@');
933 }
934
935 // Get the prefix, which is the primary image name (without path components). Strip the
936 // extension.
937 std::string prefix = base_img.substr(last_img_slash + 1);
938 if (prefix.rfind('.') != std::string::npos) {
939 prefix = prefix.substr(0, prefix.rfind('.'));
940 }
941 if (!prefix.empty()) {
942 prefix = prefix + "-";
943 }
944
945 base_img = base_img.substr(0, last_img_slash + 1);
946
947 // Note: we have some special case here for our testing. We have to inject the differentiating
948 // parts for the different core images.
949 std::string infix; // Empty infix by default.
950 {
951 // Check the first name.
952 std::string dex_file = oat_filenames_[0];
953 size_t last_dex_slash = dex_file.rfind('/');
954 if (last_dex_slash != std::string::npos) {
955 dex_file = dex_file.substr(last_dex_slash + 1);
956 }
957 size_t last_dex_dot = dex_file.rfind('.');
958 if (last_dex_dot != std::string::npos) {
959 dex_file = dex_file.substr(0, last_dex_dot);
960 }
961 if (StartsWith(dex_file, "core-")) {
962 infix = dex_file.substr(strlen("core"));
963 }
964 }
965
966 // Now create the other names. Use a counted loop to skip the first one.
967 for (size_t i = 1; i < dex_locations_.size(); ++i) {
968 // TODO: Make everything properly std::string.
969 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
970 char_backing_storage_.push_back(base_img + image_name);
971 image_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
972
973 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
974 char_backing_storage_.push_back(base_oat + oat_name);
975 oat_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
976 }
977 }
978
Andreas Gampe8994a042015-12-30 19:03:17 +0000979 // Modify the input string in the following way:
980 // 0) Assume input is /a/b/c.d
981 // 1) Strip the path -> c.d
982 // 2) Inject prefix p -> pc.d
983 // 3) Inject infix i -> pci.d
984 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -0800985 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +0000986 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -0800987 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +0000988 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800989 size_t last_dex_slash = in.rfind('/');
990 if (last_dex_slash != std::string::npos) {
991 in = in.substr(last_dex_slash + 1);
992 }
Andreas Gampe8994a042015-12-30 19:03:17 +0000993 if (!prefix.empty()) {
994 in = prefix + in;
995 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800996 if (!infix.empty()) {
997 // Inject infix.
998 size_t last_dot = in.rfind('.');
999 if (last_dot != std::string::npos) {
1000 in.insert(last_dot, infix);
1001 }
1002 }
1003 if (EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001004 in = in.substr(0, in.length() - strlen(".jar")) +
1005 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001006 }
1007 return in;
1008 }
1009
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001010 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001011 std::ostringstream oss;
1012 for (int i = 0; i < argc; ++i) {
1013 if (i > 0) {
1014 oss << ' ';
1015 }
1016 oss << argv[i];
1017 }
1018 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1019 oss.str(""); // Reset.
1020 oss << kRuntimeISA;
1021 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1022 key_value_store_->Put(
1023 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001024 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001025 key_value_store_->Put(
1026 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001027 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001028 key_value_store_->Put(
1029 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001030 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001031 key_value_store_->Put(OatHeader::kCompilerFilter,
1032 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Roland Levillain9ec5e222015-08-17 20:18:41 +01001033 }
1034
1035 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1036 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1037 // returns, arguments have been successfully parsed.
1038 void ParseArgs(int argc, char** argv) {
1039 original_argc = argc;
1040 original_argv = argv;
1041
1042 InitLogging(argv);
1043
1044 // Skip over argv[0].
1045 argv++;
1046 argc--;
1047
1048 if (argc == 0) {
1049 Usage("No arguments specified");
1050 }
1051
1052 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001053 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001054
1055 for (int i = 0; i < argc; i++) {
1056 const StringPiece option(argv[i]);
1057 const bool log_options = false;
1058 if (log_options) {
1059 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1060 }
1061 if (option.starts_with("--dex-file=")) {
1062 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data());
1063 } else if (option.starts_with("--dex-location=")) {
1064 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data());
1065 } else if (option.starts_with("--zip-fd=")) {
1066 ParseZipFd(option);
1067 } else if (option.starts_with("--zip-location=")) {
1068 zip_location_ = option.substr(strlen("--zip-location=")).data();
1069 } else if (option.starts_with("--oat-file=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001070 oat_filenames_.push_back(option.substr(strlen("--oat-file=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001071 } else if (option.starts_with("--oat-symbols=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001072 parser_options->oat_symbols.push_back(option.substr(strlen("--oat-symbols=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001073 } else if (option.starts_with("--oat-fd=")) {
1074 ParseOatFd(option);
1075 } else if (option == "--watch-dog") {
1076 parser_options->watch_dog_enabled = true;
1077 } else if (option == "--no-watch-dog") {
1078 parser_options->watch_dog_enabled = false;
1079 } else if (option.starts_with("-j")) {
1080 ParseJ(option);
1081 } else if (option.starts_with("--oat-location=")) {
1082 oat_location_ = option.substr(strlen("--oat-location=")).data();
1083 } else if (option.starts_with("--image=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001084 image_filenames_.push_back(option.substr(strlen("--image=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001085 } else if (option.starts_with("--image-classes=")) {
1086 image_classes_filename_ = option.substr(strlen("--image-classes=")).data();
1087 } else if (option.starts_with("--image-classes-zip=")) {
1088 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data();
Mathieu Chartierceb07b32015-12-10 09:33:21 -08001089 } else if (option.starts_with("--image-format=")) {
1090 ParseImageFormat(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001091 } else if (option.starts_with("--compiled-classes=")) {
1092 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data();
1093 } else if (option.starts_with("--compiled-classes-zip=")) {
1094 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data();
1095 } else if (option.starts_with("--compiled-methods=")) {
1096 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data();
1097 } else if (option.starts_with("--compiled-methods-zip=")) {
1098 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data();
1099 } else if (option.starts_with("--base=")) {
1100 ParseBase(option);
1101 } else if (option.starts_with("--boot-image=")) {
1102 parser_options->boot_image_filename = option.substr(strlen("--boot-image=")).data();
1103 } else if (option.starts_with("--android-root=")) {
1104 android_root_ = option.substr(strlen("--android-root=")).data();
1105 } else if (option.starts_with("--instruction-set=")) {
1106 ParseInstructionSet(option);
1107 } else if (option.starts_with("--instruction-set-variant=")) {
1108 ParseInstructionSetVariant(option, parser_options.get());
1109 } else if (option.starts_with("--instruction-set-features=")) {
1110 ParseInstructionSetFeatures(option, parser_options.get());
1111 } else if (option.starts_with("--compiler-backend=")) {
1112 ParseCompilerBackend(option, parser_options.get());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001113 } else if (option.starts_with("--profile-file=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001114 profile_file_ = option.substr(strlen("--profile-file=")).ToString();
Calin Juravle877fd962016-01-05 14:29:29 +00001115 } else if (option.starts_with("--profile-file-fd=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001116 ParseUintOption(option, "--profile-file-fd", &profile_file_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001117 } else if (option == "--host") {
1118 is_host_ = true;
1119 } else if (option == "--runtime-arg") {
1120 if (++i >= argc) {
1121 Usage("Missing required argument for --runtime-arg");
1122 }
1123 if (log_options) {
1124 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1125 }
1126 runtime_args_.push_back(argv[i]);
1127 } else if (option == "--dump-timing") {
1128 dump_timing_ = true;
1129 } else if (option == "--dump-passes") {
1130 dump_passes_ = true;
Roland Levillain9ec5e222015-08-17 20:18:41 +01001131 } else if (option == "--dump-stats") {
1132 dump_stats_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001133 } else if (option.starts_with("--swap-file=")) {
1134 swap_file_name_ = option.substr(strlen("--swap-file=")).data();
1135 } else if (option.starts_with("--swap-fd=")) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001136 ParseUintOption(option, "--swap-fd", &swap_fd_, Usage);
1137 } else if (option.starts_with("--app-image-file=")) {
1138 app_image_file_name_ = option.substr(strlen("--app-image-file=")).data();
1139 } else if (option.starts_with("--app-image-fd=")) {
1140 ParseUintOption(option, "--app-image-fd", &app_image_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001141 } else if (option.starts_with("--verbose-methods=")) {
1142 // TODO: rather than switch off compiler logging, make all VLOG(compiler) messages
1143 // conditional on having verbost methods.
1144 gLogVerbosity.compiler = false;
1145 Split(option.substr(strlen("--verbose-methods=")).ToString(), ',', &verbose_methods_);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001146 } else if (option == "--multi-image") {
Jeff Hao436183f2016-01-12 16:36:50 -08001147 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001148 } else if (option.starts_with("--no-inline-from=")) {
1149 no_inline_from_string_ = option.substr(strlen("--no-inline-from=")).data();
Andreas Gampeace0dc12016-01-20 13:33:13 -08001150 } else if (option == "--force-determinism") {
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001151 if (!SupportsDeterministicCompilation()) {
1152 Usage("Cannot use --force-determinism with read barriers or non-CMS garbage collector");
Roland Levillaineb2c7412016-01-28 14:37:01 +00001153 }
Andreas Gampeace0dc12016-01-20 13:33:13 -08001154 force_determinism_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001155 } else if (!compiler_options_->ParseCompilerOption(option, Usage)) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001156 Usage("Unknown argument %s", option.data());
1157 }
1158 }
1159
Jeff Hao436183f2016-01-12 16:36:50 -08001160 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001161
1162 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001163 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001164 }
1165
Jeff Haodcdc85b2015-12-04 14:06:18 -08001166 // Check whether the oat output files are writable, and open them for later. Also open a swap
1167 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001168 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001169 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1170 PruneNonExistentDexFiles();
1171
Jeff Hao436183f2016-01-12 16:36:50 -08001172 // Expand oat and image filenames for multi image.
1173 if (IsBootImage() && multi_image_) {
1174 ExpandOatAndImageFilenames();
1175 }
1176
Jeff Haodcdc85b2015-12-04 14:06:18 -08001177 bool create_file = oat_fd_ == -1; // as opposed to using open file descriptor
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001178 if (create_file) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001179 for (const char* oat_filename : oat_filenames_) {
1180 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
1181 if (oat_file.get() == nullptr) {
1182 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1183 return false;
1184 }
1185 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) {
1186 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1187 oat_file->Erase();
1188 return false;
1189 }
1190 oat_files_.push_back(std::move(oat_file));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001191 }
1192 } else {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001193 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, true));
1194 oat_file->DisableAutoClose();
1195 if (oat_file->SetLength(0) != 0) {
Andreas Gampe4303ba92014-11-06 01:00:46 -08001196 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1197 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001198 if (oat_file.get() == nullptr) {
1199 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1200 return false;
1201 }
1202 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) {
1203 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_location_;
1204 oat_file->Erase();
1205 return false;
1206 }
1207 oat_filenames_.push_back(oat_location_.c_str());
1208 oat_files_.push_back(std::move(oat_file));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001209 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001210
1211 // Swap file handling.
1212 //
1213 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1214 // that we can use for swap.
1215 //
1216 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1217 // will immediately unlink to satisfy the swap fd assumption.
1218 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1219 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1220 if (swap_file.get() == nullptr) {
1221 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1222 return false;
1223 }
1224 swap_fd_ = swap_file->Fd();
1225 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1226 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1227 // released immediately.
1228 unlink(swap_file_name_.c_str());
1229 }
Jeff Hao436183f2016-01-12 16:36:50 -08001230
1231 // If we use a swap file, ensure we are above the threshold to make it necessary.
1232 if (swap_fd_ != -1) {
1233 if (!UseSwap(IsBootImage(), dex_files_)) {
1234 close(swap_fd_);
1235 swap_fd_ = -1;
1236 VLOG(compiler) << "Decided to run without swap.";
1237 } else {
1238 LOG(INFO) << "Large app, accepted running with swap.";
1239 }
1240 }
1241 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
1242
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001243 return true;
1244 }
1245
Jeff Haodcdc85b2015-12-04 14:06:18 -08001246 void EraseOatFiles() {
1247 for (size_t i = 0; i < oat_files_.size(); ++i) {
1248 DCHECK(oat_files_[i].get() != nullptr);
1249 oat_files_[i]->Erase();
1250 oat_files_[i].reset();
1251 }
Andreas Gampea650e702014-12-03 14:28:02 -08001252 }
1253
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001254 void Shutdown() {
1255 ScopedObjectAccess soa(Thread::Current());
1256 for (jobject dex_cache : dex_caches_) {
1257 soa.Env()->DeleteLocalRef(dex_cache);
1258 }
1259 dex_caches_.clear();
1260 }
1261
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001262 void LoadClassProfileDescriptors() {
1263 if (profile_compilation_info_ != nullptr && app_image_) {
1264 Runtime* runtime = Runtime::Current();
1265 CHECK(runtime != nullptr);
1266 std::set<DexCacheResolvedClasses> resolved_classes(
1267 profile_compilation_info_->GetResolvedClasses());
1268 image_classes_.reset(new std::unordered_set<std::string>(
1269 runtime->GetClassLinker()->GetClassDescriptorsForProfileKeys(resolved_classes)));
1270 VLOG(compiler) << "Loaded " << image_classes_->size()
1271 << " image class descriptors from profile";
1272 if (VLOG_IS_ON(compiler)) {
1273 for (const std::string& s : *image_classes_) {
1274 LOG(INFO) << "Image class " << s;
1275 }
1276 }
1277 }
1278 }
1279
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001280 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1281 // boot class path.
1282 bool Setup() {
1283 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001284 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap.
Vladimir Marko49b0f452015-12-10 13:49:19 +00001285
1286 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods()) {
1287 return false;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001288 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001289
Vladimir Marko307dac92015-10-20 11:20:09 +01001290 verification_results_.reset(new VerificationResults(compiler_options_.get()));
Andreas Gampe4585f872015-03-27 23:45:15 -07001291 callbacks_.reset(new QuickCompilerCallbacks(
Vladimir Marko307dac92015-10-20 11:20:09 +01001292 verification_results_.get(),
Andreas Gampe4585f872015-03-27 23:45:15 -07001293 &method_inliner_map_,
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001294 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001295 CompilerCallbacks::CallbackMode::kCompileBootImage :
1296 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001297
Vladimir Marko49b0f452015-12-10 13:49:19 +00001298 RuntimeArgumentMap runtime_options;
1299 if (!PrepareRuntimeOptions(&runtime_options)) {
1300 return false;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001301 }
1302
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001303 CreateOatWriters();
1304 if (!AddDexFileSources()) {
1305 return false;
1306 }
1307
1308 if (IsBootImage() && image_filenames_.size() > 1) {
1309 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1310 // We need this for the multi-image case.
1311 key_value_store_->Put(OatHeader::kBootClassPath, GetMultiImageBootClassPath());
1312 }
1313
1314 if (!IsBootImage()) {
1315 // When compiling an app, create the runtime early to retrieve
1316 // the image location key needed for the oat header.
1317 if (!CreateRuntime(std::move(runtime_options))) {
1318 return false;
1319 }
1320
Andreas Gampe29d38e72016-03-23 15:31:51 +00001321 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001322 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1323 std::vector<gc::space::ImageSpace*> image_spaces =
1324 Runtime::Current()->GetHeap()->GetBootImageSpaces();
1325 image_file_location_oat_checksum_ = image_spaces[0]->GetImageHeader().GetOatChecksum();
1326 image_file_location_oat_data_begin_ =
1327 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1328 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1329 // Store the boot image filename(s).
1330 std::vector<std::string> image_filenames;
1331 for (const gc::space::ImageSpace* image_space : image_spaces) {
1332 image_filenames.push_back(image_space->GetImageFilename());
1333 }
1334 std::string image_file_location = Join(image_filenames, ':');
1335 if (!image_file_location.empty()) {
1336 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1337 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001338 } else {
1339 image_file_location_oat_checksum_ = 0u;
1340 image_file_location_oat_data_begin_ = 0u;
1341 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001342 }
1343
1344 // Open dex files for class path.
1345 const std::vector<std::string> class_path_locations =
1346 GetClassPathLocations(runtime_->GetClassPathString());
1347 OpenClassPathFiles(class_path_locations, &class_path_files_);
1348
1349 // Store the classpath we have right now.
1350 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1351 key_value_store_->Put(OatHeader::kClassPathKey,
1352 OatFile::EncodeDexFileDependencies(class_path_files));
1353 }
1354
1355 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001356 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001357 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1358 rodata_.reserve(oat_writers_.size());
1359 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1360 rodata_.push_back(elf_writers_[i]->StartRoData());
1361 // Unzip or copy dex files straight to the oat file.
1362 std::unique_ptr<MemMap> opened_dex_files_map;
1363 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
1364 if (!oat_writers_[i]->WriteAndOpenDexFiles(rodata_.back(),
1365 oat_files_[i].get(),
1366 instruction_set_,
1367 instruction_set_features_.get(),
1368 key_value_store_.get(),
Andreas Gampe3a2bd292016-01-26 17:23:47 -08001369 /* verify */ true,
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001370 &opened_dex_files_map,
1371 &opened_dex_files)) {
1372 return false;
1373 }
1374 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1375 if (opened_dex_files_map != nullptr) {
1376 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
1377 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001378 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001379 opened_dex_files_.push_back(std::move(dex_file));
1380 }
1381 } else {
1382 DCHECK(opened_dex_files.empty());
1383 }
1384 }
1385 }
1386
1387 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
1388 if (IsBootImage()) {
1389 // For boot image, pass opened dex files to the Runtime::Create().
1390 // Note: Runtime acquires ownership of these dex files.
1391 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001392 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001393 return false;
1394 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001395 }
1396
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001397 // If we're doing the image, override the compiler filter to force full compilation. Must be
1398 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1399 // compilation of class initializers.
1400 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001401 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001402 WellKnownClasses::Init(self->GetJniEnv());
1403
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001404 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001405 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001406 constexpr bool kSaveDexInput = false;
1407 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001408 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001409 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001410
1411 // Handle and ClassLoader creation needs to come after Runtime::Create.
1412 ScopedObjectAccess soa(self);
1413
1414 // Classpath: first the class-path given.
1415 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1416
1417 // Then the dex files we'll compile. Thus we'll resolve the class-path first.
1418 class_path_files.insert(class_path_files.end(), dex_files_.begin(), dex_files_.end());
1419
1420 class_loader_ = class_linker->CreatePathClassLoader(self, class_path_files);
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001421 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001422
1423 // Ensure opened dex files are writable for dex-to-dex transformations.
1424 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1425 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1426 PLOG(ERROR) << "Failed to make .dex files writeable.";
1427 return false;
Vladimir Marko919f5532016-01-20 19:13:01 +00001428 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001429 }
1430
1431 // Ensure that the dex caches stay live since we don't want class unloading
1432 // to occur during compilation.
1433 for (const auto& dex_file : dex_files_) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001434 ScopedObjectAccess soa(self);
1435 dex_caches_.push_back(soa.AddLocalReference<jobject>(
Mathieu Chartierd57d4542015-10-14 10:55:30 -07001436 class_linker->RegisterDexFile(*dex_file, Runtime::Current()->GetLinearAlloc())));
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001437 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001438
1439 /*
Mathieu Chartiera8077802016-03-16 19:08:31 -07001440 * If we're not in interpret-only or verify-none or verify-at-runtime or verify-profile mode,
1441 * go ahead and compile small applications. Don't bother to check if we're doing the image.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001442 */
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001443 if (!IsBootImage() &&
Brian Carlstrom95b033b2014-12-03 22:29:37 -08001444 compiler_options_->IsCompilationEnabled() &&
1445 compiler_kind_ == Compiler::kQuick) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001446 size_t num_methods = 0;
1447 for (size_t i = 0; i != dex_files_.size(); ++i) {
1448 const DexFile* dex_file = dex_files_[i];
1449 CHECK(dex_file != nullptr);
1450 num_methods += dex_file->NumMethodIds();
1451 }
1452 if (num_methods <= compiler_options_->GetNumDexMethodsThreshold()) {
Andreas Gampe29d38e72016-03-23 15:31:51 +00001453 compiler_options_->SetCompilerFilter(CompilerFilter::kSpeed);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001454 VLOG(compiler) << "Below method threshold, compiling anyways";
1455 }
1456 }
1457
1458 return true;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001459 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001460
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001461 // If we need to keep the oat file open for the image writer.
1462 bool ShouldKeepOatFileOpen() const {
1463 return IsImage() && oat_fd_ != kInvalidFd;
1464 }
1465
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001466 // Create and invoke the compiler driver. This will compile all the dex files.
1467 void Compile() {
1468 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1469 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001470
Vladimir Marko47496c22016-01-27 16:15:08 +00001471 // Find the dex files we should not inline from.
1472
1473 std::vector<std::string> no_inline_filters;
1474 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001475
1476 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001477 const std::string core_oj = "core-oj";
1478 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1479 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001480 }
1481
Vladimir Marko47496c22016-01-27 16:15:08 +00001482 if (!no_inline_filters.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001483 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1484 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1485 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1486 &class_linker->GetBootClassPath(),
1487 &class_path_files,
1488 &dex_files_
1489 };
1490 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001491 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001492 for (const std::string& filter : no_inline_filters) {
1493 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
1494 // allows tests to specify <test-dexfile>:classes2.dex if needed but if the
1495 // base location passes the StartsWith() test, so do all extra locations.
1496 std::string dex_location = dex_file->GetLocation();
1497 if (filter.find('/') == std::string::npos) {
1498 // The filter does not contain the path. Remove the path from dex_location as well.
1499 size_t last_slash = dex_file->GetLocation().rfind('/');
1500 if (last_slash != std::string::npos) {
1501 dex_location = dex_location.substr(last_slash + 1);
1502 }
1503 }
1504
1505 if (StartsWith(dex_location, filter.c_str())) {
1506 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1507 no_inline_from_dex_files_.push_back(dex_file);
1508 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001509 }
1510 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001511 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001512 }
1513 if (!no_inline_from_dex_files_.empty()) {
1514 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001515 }
1516 }
1517
Vladimir Marko307dac92015-10-20 11:20:09 +01001518 driver_.reset(new CompilerDriver(compiler_options_.get(),
1519 verification_results_.get(),
1520 &method_inliner_map_,
1521 compiler_kind_,
1522 instruction_set_,
1523 instruction_set_features_.get(),
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001524 IsBootImage(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001525 image_classes_.release(),
1526 compiled_classes_.release(),
Vladimir Marko944da602016-02-19 12:27:55 +00001527 /* compiled_methods */ nullptr,
Vladimir Marko307dac92015-10-20 11:20:09 +01001528 thread_count_,
1529 dump_stats_,
1530 dump_passes_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001531 compiler_phases_timings_.get(),
1532 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001533 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001534 driver_->SetDexFilesForOatFile(dex_files_);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001535 driver_->CompileAll(class_loader_, dex_files_, timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001536 }
1537
Jeff Hao436183f2016-01-12 16:36:50 -08001538 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001539 // ensure the references between the two are correct.
1540 //
1541 // Currently we have a memory layout that looks something like this:
1542 //
1543 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001544 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001545 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001546 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001547 // +--------------+
1548 // | alloc spaces |
1549 // +--------------+
1550 //
Jeff Hao436183f2016-01-12 16:36:50 -08001551 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001552 //
Jeff Hao436183f2016-01-12 16:36:50 -08001553 // 1. The images are expected to be loaded at an absolute address and
1554 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001555 //
Jeff Hao436183f2016-01-12 16:36:50 -08001556 // 2. There are absolute pointers from Methods in the images to their
1557 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001558 //
Jeff Hao436183f2016-01-12 16:36:50 -08001559 // 3. There are absolute pointers from the code in the oat files to Methods
1560 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001561 //
Jeff Hao436183f2016-01-12 16:36:50 -08001562 // 4. There are absolute pointers from code in the oat files to other code
1563 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001564 //
1565 // To get this all correct, we go through several steps.
1566 //
Jeff Hao436183f2016-01-12 16:36:50 -08001567 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001568 // the oat data size and code size. During this stage, we also set
1569 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001570 //
Jeff Hao436183f2016-01-12 16:36:50 -08001571 // 2. We prepare offsets for the objects in the images and calculate
1572 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001573 //
Jeff Hao436183f2016-01-12 16:36:50 -08001574 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001575 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001576 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001577 // can prepare the ELF headers and we then know the ELF memory segment
1578 // layout and we can now resolve all references. The compiler provides
1579 // LinkerPatch information in each CompiledMethod and we resolve these,
1580 // using the layout information and image object locations provided by
1581 // image writer, as we're writing the method code.
1582 //
Jeff Hao436183f2016-01-12 16:36:50 -08001583 // 4. We create the image files. They need to know where the oat files
1584 // will be loaded after itself. Originally oat files were simply
1585 // memory mapped so we could predict where their contents were based
1586 // on the file size. Now that they are ELF files, we need to inspect
1587 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001588 // where the oat header is located within.
1589 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001590 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001591 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001592 // load the .so at the desired location at runtime by offsetting the
1593 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001594 // TODO: Do this in step 3. We already know the layout there.
1595 //
1596 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1597 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001598
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001599 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1600 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001601 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1602 // case (when the file will be explicitly erased).
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001603 bool WriteOatFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001604 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1605
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001606 // Sync the data to the file, in case we did dex2dex transformations.
1607 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1608 if (!map->Sync()) {
1609 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1610 return false;
1611 }
1612 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001613
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001614 if (IsImage()) {
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001615 if (app_image_ && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001616 gc::Heap* const heap = Runtime::Current()->GetHeap();
1617 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001618 image_base_ = std::max(image_base_, RoundUp(
1619 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1620 kPageSize));
1621 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001622 // The non moving space is right after the oat file. Put the preferred app image location
1623 // right after the non moving space so that we ideally get a continuous immune region for
1624 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001625 // Use the default non moving space capacity since dex2oat does not have a separate non-
1626 // moving space. This means the runtime's non moving space space size will be as large
1627 // as the growth limit for dex2oat, but smaller in the zygote.
1628 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001629 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001630 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1631 }
1632
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001633 image_writer_.reset(new ImageWriter(*driver_,
1634 image_base_,
1635 compiler_options_->GetCompilePic(),
1636 IsAppImage(),
1637 image_storage_mode_,
1638 oat_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00001639 dex_file_oat_index_map_));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001640
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001641 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001642 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1643 if (!image_writer_->PrepareImageAddressSpace()) {
1644 LOG(ERROR) << "Failed to prepare image address space.";
1645 return false;
1646 }
1647 }
1648
Vladimir Marko944da602016-02-19 12:27:55 +00001649 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001650 {
1651 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001652 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko944da602016-02-19 12:27:55 +00001653 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1654 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
1655
1656 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1657 oat_writer->PrepareLayout(driver_.get(), image_writer_.get(), dex_files, &patcher);
1658
1659 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
1660 size_t text_size = oat_writer->GetSize() - rodata_size;
1661 elf_writer->SetLoadedSectionSizes(rodata_size, text_size, oat_writer->GetBssSize());
1662
1663 if (IsImage()) {
1664 // Update oat layout.
1665 DCHECK(image_writer_ != nullptr);
1666 DCHECK_LT(i, oat_filenames_.size());
1667 image_writer_->UpdateOatFileLayout(i,
1668 elf_writer->GetLoadedSize(),
1669 oat_writer->GetOatDataOffset(),
1670 oat_writer->GetSize());
1671 }
1672 }
1673
1674 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001675 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001676 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1677 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00001678
David Srbecky09c2a6b2016-03-11 17:11:44 +00001679 oat_writer->AddMethodDebugInfos(debug::MakeTrampolineInfos(oat_writer->GetOatHeader()));
1680
David Srbecky0c4572e2016-01-22 19:19:25 +00001681 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00001682 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
1683 elf_writer->PrepareDebugInfo(oat_writer->GetMethodDebugInfo());
David Srbecky0c4572e2016-01-22 19:19:25 +00001684
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001685 OutputStream*& rodata = rodata_[i];
1686 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001687 if (!oat_writer->WriteRodata(rodata)) {
1688 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
1689 return false;
1690 }
1691 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001692 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00001693
Jeff Haodcdc85b2015-12-04 14:06:18 -08001694 OutputStream* text = elf_writer->StartText();
1695 if (!oat_writer->WriteCode(text)) {
1696 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
1697 return false;
1698 }
1699 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00001700
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001701 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
1702 image_file_location_oat_checksum_,
1703 image_file_location_oat_data_begin_,
1704 image_patch_delta_)) {
1705 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
1706 return false;
1707 }
1708
Vladimir Marko944da602016-02-19 12:27:55 +00001709 if (IsImage()) {
1710 // Update oat header information.
1711 DCHECK(image_writer_ != nullptr);
1712 DCHECK_LT(i, oat_filenames_.size());
1713 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
1714 }
1715
Jeff Haodcdc85b2015-12-04 14:06:18 -08001716 elf_writer->WriteDynamicSection();
1717 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
1718 elf_writer->WritePatchLocations(oat_writer->GetAbsolutePatchLocations());
Vladimir Marko10c13562015-11-25 14:33:36 +00001719
Jeff Haodcdc85b2015-12-04 14:06:18 -08001720 if (!elf_writer->End()) {
1721 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
1722 return false;
1723 }
1724
1725 // Flush the oat file.
1726 if (oat_files_[i] != nullptr) {
1727 if (oat_files_[i]->Flush() != 0) {
1728 PLOG(ERROR) << "Failed to flush oat file: " << oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08001729 return false;
1730 }
1731 }
1732
Jeff Haodcdc85b2015-12-04 14:06:18 -08001733 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001734
1735 oat_writer.reset();
1736 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001737 }
1738 }
1739
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001740 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001741 }
1742
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001743 // If we are compiling an image, invoke the image creation routine. Else just skip.
1744 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001745 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001746 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
1747 if (!CreateImageFile()) {
1748 return false;
1749 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001750 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07001751 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001752 return true;
1753 }
1754
Jeff Haodcdc85b2015-12-04 14:06:18 -08001755 // Create a copy from stripped to unstripped.
1756 bool CopyStrippedToUnstripped() {
1757 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
1758 // If we don't want to strip in place, copy from stripped location to unstripped location.
1759 // We need to strip after image creation because FixupElf needs to use .strtab.
1760 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
1761 // If the oat file is still open, flush it.
1762 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
1763 if (!FlushCloseOatFile(i)) {
1764 return false;
1765 }
1766 }
1767
1768 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
1769 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
1770 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
1771 size_t buffer_size = 8192;
1772 std::unique_ptr<uint8_t[]> buffer(new uint8_t[buffer_size]);
1773 while (true) {
1774 int bytes_read = TEMP_FAILURE_RETRY(read(in->Fd(), buffer.get(), buffer_size));
1775 if (bytes_read <= 0) {
1776 break;
1777 }
1778 bool write_ok = out->WriteFully(buffer.get(), bytes_read);
1779 CHECK(write_ok);
1780 }
1781 if (out->FlushCloseOrErase() != 0) {
1782 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
1783 return false;
1784 }
1785 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
1786 }
1787 }
1788 return true;
1789 }
1790
1791 bool FlushOatFiles() {
1792 TimingLogger::ScopedTiming t2("dex2oat Flush ELF", timings_);
1793 for (size_t i = 0; i < oat_files_.size(); ++i) {
1794 if (oat_files_[i].get() != nullptr) {
1795 if (oat_files_[i]->Flush() != 0) {
1796 PLOG(ERROR) << "Failed to flush oat file: " << oat_filenames_[i];
1797 oat_files_[i]->Erase();
Andreas Gampe10e477d2014-11-19 12:57:42 -08001798 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001799 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001800 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00001801 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08001802 return true;
1803 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001804
Jeff Haodcdc85b2015-12-04 14:06:18 -08001805 bool FlushCloseOatFile(size_t i) {
1806 if (oat_files_[i].get() != nullptr) {
1807 std::unique_ptr<File> tmp(oat_files_[i].release());
Andreas Gampe10e477d2014-11-19 12:57:42 -08001808 if (tmp->FlushCloseOrErase() != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001809 PLOG(ERROR) << "Failed to flush and close oat file: " << oat_filenames_[i];
Andreas Gampe10e477d2014-11-19 12:57:42 -08001810 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001811 }
1812 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001813 return true;
1814 }
1815
Jeff Haodcdc85b2015-12-04 14:06:18 -08001816 bool FlushCloseOatFiles() {
1817 bool result = true;
1818 for (size_t i = 0; i < oat_files_.size(); ++i) {
1819 result &= FlushCloseOatFile(i);
1820 }
1821 return result;
1822 }
1823
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001824 void DumpTiming() {
1825 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
1826 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
1827 }
1828 if (dump_passes_) {
1829 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
1830 }
1831 }
1832
1833 CompilerOptions* GetCompilerOptions() const {
1834 return compiler_options_.get();
1835 }
1836
Andreas Gampe10e477d2014-11-19 12:57:42 -08001837 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001838 return IsAppImage() || IsBootImage();
1839 }
1840
1841 bool IsAppImage() const {
1842 return app_image_;
1843 }
1844
1845 bool IsBootImage() const {
1846 return boot_image_;
Andreas Gampe10e477d2014-11-19 12:57:42 -08001847 }
1848
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001849 bool IsHost() const {
1850 return is_host_;
1851 }
1852
Calin Juravle998c2162015-12-21 15:39:33 +02001853 bool UseProfileGuidedCompilation() const {
Andreas Gampe29d38e72016-03-23 15:31:51 +00001854 return CompilerFilter::DependsOnProfile(compiler_options_->GetCompilerFilter());
Calin Juravle998c2162015-12-21 15:39:33 +02001855 }
1856
Calin Juravle2e2db782016-02-23 12:00:03 +00001857 bool LoadProfile() {
Calin Juravle998c2162015-12-21 15:39:33 +02001858 DCHECK(UseProfileGuidedCompilation());
Calin Juravle2e2db782016-02-23 12:00:03 +00001859
1860 profile_compilation_info_.reset(new ProfileCompilationInfo());
1861 ScopedFlock flock;
Andreas Gampe29d38e72016-03-23 15:31:51 +00001862 bool success = true;
Calin Juravle2e2db782016-02-23 12:00:03 +00001863 std::string error;
1864 if (profile_file_fd_ != -1) {
1865 // The file doesn't need to be flushed so don't check the usage.
1866 // Pass a bogus path so that we can easily attribute any reported error.
1867 File file(profile_file_fd_, "profile", /*check_usage*/ false, /*read_only_mode*/ true);
1868 if (flock.Init(&file, &error)) {
1869 success = profile_compilation_info_->Load(profile_file_fd_);
1870 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001871 } else if (profile_file_ != "") {
Calin Juravle2e2db782016-02-23 12:00:03 +00001872 if (flock.Init(profile_file_.c_str(), O_RDONLY, /* block */ true, &error)) {
1873 success = profile_compilation_info_->Load(flock.GetFile()->Fd());
1874 }
1875 }
1876 if (!error.empty()) {
1877 LOG(WARNING) << "Cannot lock profiles: " << error;
Calin Juravle998c2162015-12-21 15:39:33 +02001878 }
Calin Juravle877fd962016-01-05 14:29:29 +00001879
Calin Juravle2e2db782016-02-23 12:00:03 +00001880 if (!success) {
1881 profile_compilation_info_.reset(nullptr);
1882 }
Calin Juravle877fd962016-01-05 14:29:29 +00001883
Calin Juravle2e2db782016-02-23 12:00:03 +00001884 return success;
Calin Juravle998c2162015-12-21 15:39:33 +02001885 }
1886
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001887 private:
Vladimir Marko49b0f452015-12-10 13:49:19 +00001888 template <typename T>
1889 static std::vector<T*> MakeNonOwningPointerVector(const std::vector<std::unique_ptr<T>>& src) {
1890 std::vector<T*> result;
1891 result.reserve(src.size());
1892 for (const std::unique_ptr<T>& t : src) {
1893 result.push_back(t.get());
1894 }
1895 return result;
1896 }
1897
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001898 std::string GetMultiImageBootClassPath() {
1899 DCHECK(IsBootImage());
1900 DCHECK_GT(oat_filenames_.size(), 1u);
1901 // If the image filename was adapted (e.g., for our tests), we need to change this here,
1902 // too, but need to strip all path components (they will be re-established when loading).
1903 std::ostringstream bootcp_oss;
1904 bool first_bootcp = true;
1905 for (size_t i = 0; i < dex_locations_.size(); ++i) {
1906 if (!first_bootcp) {
1907 bootcp_oss << ":";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001908 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001909
1910 std::string dex_loc = dex_locations_[i];
1911 std::string image_filename = image_filenames_[i];
1912
1913 // Use the dex_loc path, but the image_filename name (without path elements).
1914 size_t dex_last_slash = dex_loc.rfind('/');
1915
1916 // npos is max(size_t). That makes this a bit ugly.
1917 size_t image_last_slash = image_filename.rfind('/');
1918 size_t image_last_at = image_filename.rfind('@');
1919 size_t image_last_sep = (image_last_slash == std::string::npos)
1920 ? image_last_at
1921 : (image_last_at == std::string::npos)
1922 ? std::string::npos
1923 : std::max(image_last_slash, image_last_at);
1924 // Note: whenever image_last_sep == npos, +1 overflow means using the full string.
1925
1926 if (dex_last_slash == std::string::npos) {
1927 dex_loc = image_filename.substr(image_last_sep + 1);
1928 } else {
1929 dex_loc = dex_loc.substr(0, dex_last_slash + 1) +
1930 image_filename.substr(image_last_sep + 1);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001931 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001932
1933 // Image filenames already end with .art, no need to replace.
1934
1935 bootcp_oss << dex_loc;
1936 first_bootcp = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001937 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001938 return bootcp_oss.str();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001939 }
1940
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001941 std::vector<std::string> GetClassPathLocations(const std::string& class_path) {
1942 // This function is used only for apps and for an app we have exactly one oat file.
1943 DCHECK(!IsBootImage());
1944 DCHECK_EQ(oat_writers_.size(), 1u);
1945 std::vector<std::string> dex_files_canonical_locations;
1946 for (const char* location : oat_writers_[0]->GetSourceLocations()) {
1947 dex_files_canonical_locations.push_back(DexFile::GetDexCanonicalLocation(location));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001948 }
Vladimir Marko625a64a2015-11-26 14:44:16 +00001949
Vladimir Marko919f5532016-01-20 19:13:01 +00001950 std::vector<std::string> parsed;
1951 Split(class_path, ':', &parsed);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001952 auto kept_it = std::remove_if(parsed.begin(),
1953 parsed.end(),
1954 [dex_files_canonical_locations](const std::string& location) {
1955 return ContainsElement(dex_files_canonical_locations,
1956 DexFile::GetDexCanonicalLocation(location.c_str()));
1957 });
1958 parsed.erase(kept_it, parsed.end());
1959 return parsed;
1960 }
1961
1962 // Opens requested class path files and appends them to opened_dex_files.
1963 static void OpenClassPathFiles(const std::vector<std::string>& class_path_locations,
1964 std::vector<std::unique_ptr<const DexFile>>* opened_dex_files) {
1965 DCHECK(opened_dex_files != nullptr) << "OpenClassPathFiles out-param is nullptr";
1966 for (const std::string& location : class_path_locations) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001967 std::string error_msg;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001968 if (!DexFile::Open(location.c_str(), location.c_str(), &error_msg, opened_dex_files)) {
1969 LOG(WARNING) << "Failed to open dex file '" << location << "': " << error_msg;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001970 }
1971 }
1972 }
1973
Vladimir Marko49b0f452015-12-10 13:49:19 +00001974 bool PrepareImageClasses() {
1975 // If --image-classes was specified, calculate the full list of classes to include in the image.
1976 if (image_classes_filename_ != nullptr) {
1977 image_classes_ =
1978 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
1979 if (image_classes_ == nullptr) {
1980 return false;
1981 }
1982 } else if (IsBootImage()) {
1983 image_classes_.reset(new std::unordered_set<std::string>);
1984 }
1985 return true;
1986 }
1987
1988 bool PrepareCompiledClasses() {
1989 // If --compiled-classes was specified, calculate the full list of classes to compile in the
1990 // image.
1991 if (compiled_classes_filename_ != nullptr) {
1992 compiled_classes_ =
1993 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
1994 if (compiled_classes_ == nullptr) {
1995 return false;
1996 }
1997 } else {
1998 compiled_classes_.reset(nullptr); // By default compile everything.
1999 }
2000 return true;
2001 }
2002
2003 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2004 const char* classes_filename,
2005 const char* tag) {
2006 std::unique_ptr<std::unordered_set<std::string>> classes;
2007 std::string error_msg;
2008 if (zip_filename != nullptr) {
2009 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2010 } else {
2011 classes.reset(ReadImageClassesFromFile(classes_filename));
2012 }
2013 if (classes == nullptr) {
2014 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2015 << classes_filename << "': " << error_msg;
2016 }
2017 return classes;
2018 }
2019
2020 bool PrepareCompiledMethods() {
2021 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2022 if (compiled_methods_filename_ != nullptr) {
2023 std::string error_msg;
2024 if (compiled_methods_zip_filename_ != nullptr) {
2025 compiled_methods_.reset(ReadCommentedInputFromZip(compiled_methods_zip_filename_,
2026 compiled_methods_filename_,
2027 nullptr, // No post-processing.
2028 &error_msg));
2029 } else {
2030 compiled_methods_.reset(ReadCommentedInputFromFile(compiled_methods_filename_,
2031 nullptr)); // No post-processing.
2032 }
2033 if (compiled_methods_.get() == nullptr) {
2034 LOG(ERROR) << "Failed to create list of compiled methods from '"
2035 << compiled_methods_filename_ << "': " << error_msg;
2036 return false;
2037 }
2038 } else {
2039 compiled_methods_.reset(nullptr); // By default compile everything.
2040 }
2041 return true;
2042 }
2043
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002044 void PruneNonExistentDexFiles() {
2045 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2046 size_t kept = 0u;
2047 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2048 if (!OS::FileExists(dex_filenames_[i])) {
2049 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2050 } else {
2051 dex_filenames_[kept] = dex_filenames_[i];
2052 dex_locations_[kept] = dex_locations_[i];
2053 ++kept;
2054 }
2055 }
2056 dex_filenames_.resize(kept);
2057 dex_locations_.resize(kept);
2058 }
2059
2060 bool AddDexFileSources() {
2061 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
2062 if (zip_fd_ != -1) {
2063 DCHECK_EQ(oat_writers_.size(), 1u);
2064 if (!oat_writers_[0]->AddZippedDexFilesSource(ScopedFd(zip_fd_), zip_location_.c_str())) {
2065 return false;
2066 }
2067 } else if (oat_writers_.size() > 1u) {
2068 // Multi-image.
2069 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2070 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2071 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2072 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2073 return false;
2074 }
2075 }
2076 } else {
2077 DCHECK_EQ(oat_writers_.size(), 1u);
2078 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2079 DCHECK_NE(dex_filenames_.size(), 0u);
2080 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2081 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2082 return false;
2083 }
2084 }
2085 }
2086 return true;
2087 }
2088
2089 void CreateOatWriters() {
2090 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2091 elf_writers_.reserve(oat_files_.size());
2092 oat_writers_.reserve(oat_files_.size());
2093 for (const std::unique_ptr<File>& oat_file : oat_files_) {
David Srbecky5d811202016-03-08 13:21:22 +00002094 elf_writers_.emplace_back(CreateElfWriterQuick(instruction_set_,
2095 instruction_set_features_.get(),
2096 compiler_options_.get(),
2097 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002098 elf_writers_.back()->Start();
2099 oat_writers_.emplace_back(new OatWriter(IsBootImage(), timings_));
2100 }
2101 }
2102
Vladimir Marko49b0f452015-12-10 13:49:19 +00002103 void SaveDexInput() {
2104 for (size_t i = 0; i < dex_files_.size(); ++i) {
2105 const DexFile* dex_file = dex_files_[i];
2106 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2107 getpid(), i));
2108 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2109 if (tmp_file.get() == nullptr) {
2110 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2111 << ". Try: adb shell chmod 777 /data/local/tmp";
2112 continue;
2113 }
2114 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2115 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2116 UNUSED(tmp_file->Flush());
2117 UNUSED(tmp_file->Close());
2118 LOG(INFO) << "Wrote input to " << tmp_file_name;
2119 }
2120 }
2121
2122 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options) {
2123 RuntimeOptions raw_options;
2124 if (boot_image_filename_.empty()) {
2125 std::string boot_class_path = "-Xbootclasspath:";
2126 boot_class_path += Join(dex_filenames_, ':');
2127 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2128 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
2129 boot_class_path_locations += Join(dex_locations_, ':');
2130 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2131 } else {
2132 std::string boot_image_option = "-Ximage:";
2133 boot_image_option += boot_image_filename_;
2134 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2135 }
2136 for (size_t i = 0; i < runtime_args_.size(); i++) {
2137 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2138 }
2139
2140 raw_options.push_back(std::make_pair("compilercallbacks", callbacks_.get()));
2141 raw_options.push_back(
2142 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2143
2144 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2145 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2146 // have been stripped in preopting, anyways).
2147 if (!IsBootImage()) {
2148 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2149 }
2150 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2151 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2152 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002153 // Disable Hspace compaction to save heap size virtual space.
2154 // Only need disable Hspace for OOM becasue background collector is equal to
2155 // foreground collector by default for dex2oat.
2156 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002157
Andreas Gampeace0dc12016-01-20 13:33:13 -08002158 // If we're asked to be deterministic, ensure non-concurrent GC for determinism. Also
2159 // force the free-list implementation for large objects.
2160 if (compiler_options_->IsForceDeterminism()) {
2161 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
2162 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=freelist", nullptr));
2163
2164 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2165 // compaction (done above) and ensure that neither foreground nor background collectors
2166 // are concurrent.
2167 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2168
2169 // To make identity hashcode deterministic, set a known seed.
2170 mirror::Object::SetHashCodeSeed(987654321U);
2171 }
2172
Vladimir Marko49b0f452015-12-10 13:49:19 +00002173 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2174 LOG(ERROR) << "Failed to parse runtime options";
2175 return false;
2176 }
2177 return true;
2178 }
2179
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002180 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002181 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2182 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002183 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002184 LOG(ERROR) << "Failed to create runtime";
2185 return false;
2186 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002187 runtime_.reset(Runtime::Current());
2188 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002189 for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) {
2190 Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002191 if (!runtime_->HasCalleeSaveMethod(type)) {
2192 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002193 }
2194 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002195 runtime_->GetClassLinker()->FixupDexCaches(runtime_->GetResolutionMethod());
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002196
2197 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2198 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002199 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002200
Vladimir Marko307dac92015-10-20 11:20:09 +01002201 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002202
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002203 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2204 // Runtime::Start, give it away now so that we don't starve GC.
2205 Thread* self = Thread::Current();
2206 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002207
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002208 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002209 }
2210
Jeff Haodcdc85b2015-12-04 14:06:18 -08002211 // 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 -08002212 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002213 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002214 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002215 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002216 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002217 image_filenames_.push_back(app_image_file_name_.c_str());
2218 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002219 if (!image_writer_->Write(app_image_fd_,
2220 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002221 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002222 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002223 return false;
2224 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002225
Jeff Haodcdc85b2015-12-04 14:06:18 -08002226 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002227 dchecked_vector<uintptr_t> oat_data_begins;
2228 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2229 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002230 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002231 // Destroy ImageWriter before doing FixupElf.
2232 image_writer_.reset();
2233
Vladimir Marko944da602016-02-19 12:27:55 +00002234 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2235 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002236 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2237 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2238 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2239 if (oat_file.get() == nullptr) {
2240 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2241 return false;
2242 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002243
Vladimir Marko944da602016-02-19 12:27:55 +00002244 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002245 oat_file->Erase();
2246 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2247 return false;
2248 }
2249
2250 if (oat_file->FlushCloseOrErase()) {
2251 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2252 return false;
2253 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002254 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002255 }
2256
2257 return true;
2258 }
2259
2260 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002261 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2262 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002263 std::function<std::string(const char*)> process = DotToDescriptor;
2264 return ReadCommentedInputFromFile(image_classes_filename, &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002265 }
2266
2267 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002268 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002269 const char* zip_filename,
2270 const char* image_classes_filename,
2271 std::string* error_msg) {
2272 std::function<std::string(const char*)> process = DotToDescriptor;
2273 return ReadCommentedInputFromZip(zip_filename, image_classes_filename, &process, error_msg);
2274 }
2275
2276 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2277 // the given function.
2278 static std::unordered_set<std::string>* ReadCommentedInputFromFile(
2279 const char* input_filename, std::function<std::string(const char*)>* process) {
2280 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2281 if (input_file.get() == nullptr) {
2282 LOG(ERROR) << "Failed to open input file " << input_filename;
2283 return nullptr;
2284 }
2285 std::unique_ptr<std::unordered_set<std::string>> result(
2286 ReadCommentedInputStream(*input_file, process));
2287 input_file->close();
2288 return result.release();
2289 }
2290
2291 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2292 // Post-process each line with the given function.
2293 static std::unordered_set<std::string>* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002294 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002295 const char* input_filename,
2296 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002297 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002298 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2299 if (zip_archive.get() == nullptr) {
2300 return nullptr;
2301 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002302 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002303 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002304 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002305 zip_filename, error_msg->c_str());
2306 return nullptr;
2307 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002308 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2309 input_filename,
2310 error_msg));
2311 if (input_file.get() == nullptr) {
2312 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002313 zip_filename, error_msg->c_str());
2314 return nullptr;
2315 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002316 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2317 input_file->Size());
2318 std::istringstream input_stream(input_string);
2319 return ReadCommentedInputStream(input_stream, process);
2320 }
2321
2322 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2323 // with the given function.
2324 static std::unordered_set<std::string>* ReadCommentedInputStream(
2325 std::istream& in_stream,
2326 std::function<std::string(const char*)>* process) {
2327 std::unique_ptr<std::unordered_set<std::string>> image_classes(
2328 new std::unordered_set<std::string>);
2329 while (in_stream.good()) {
2330 std::string dot;
2331 std::getline(in_stream, dot);
2332 if (StartsWith(dot, "#") || dot.empty()) {
2333 continue;
2334 }
2335 if (process != nullptr) {
2336 std::string descriptor((*process)(dot.c_str()));
2337 image_classes->insert(descriptor);
2338 } else {
2339 image_classes->insert(dot);
2340 }
2341 }
2342 return image_classes.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002343 }
2344
Mathieu Chartier49285c52014-12-02 15:43:48 -08002345 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002346 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2347 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002348 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002349 LOG(INFO) << "dex2oat took " << PrettyDuration(NanoTime() - start_ns_)
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002350 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002351 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002352 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2353 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002354 }
2355
Jeff Haodcdc85b2015-12-04 14:06:18 -08002356 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2357 std::string res(image_filename);
2358 size_t last_slash = res.rfind('/');
2359 if (last_slash == std::string::npos || last_slash == 0) {
2360 return res;
2361 }
2362 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2363 if (penultimate_slash == std::string::npos) {
2364 return res;
2365 }
2366 // Check that the string in-between is the expected one.
2367 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2368 GetInstructionSetString(isa)) {
2369 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2370 return res;
2371 }
2372 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2373 }
2374
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002375 std::unique_ptr<CompilerOptions> compiler_options_;
2376 Compiler::Kind compiler_kind_;
2377
2378 InstructionSet instruction_set_;
2379 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2380
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002381 uint32_t image_file_location_oat_checksum_;
2382 uintptr_t image_file_location_oat_data_begin_;
2383 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002384 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2385
Vladimir Marko307dac92015-10-20 11:20:09 +01002386 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002387
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002388 DexFileToMethodInlinerMap method_inliner_map_;
2389 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2390
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002391 std::unique_ptr<Runtime> runtime_;
2392
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002393 // Ownership for the class path files.
2394 std::vector<std::unique_ptr<const DexFile>> class_path_files_;
2395
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002396 size_t thread_count_;
2397 uint64_t start_ns_;
2398 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002399 std::vector<std::unique_ptr<File>> oat_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002400 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002401 std::vector<const char*> oat_filenames_;
2402 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002403 int oat_fd_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002404 std::vector<const char*> dex_filenames_;
2405 std::vector<const char*> dex_locations_;
2406 int zip_fd_;
2407 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002408 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002409 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002410 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002411 uintptr_t image_base_;
2412 const char* image_classes_zip_filename_;
2413 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002414 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002415 const char* compiled_classes_zip_filename_;
2416 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002417 const char* compiled_methods_zip_filename_;
2418 const char* compiled_methods_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002419 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2420 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002421 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002422 bool app_image_;
2423 bool boot_image_;
Jeff Hao436183f2016-01-12 16:36:50 -08002424 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002425 bool is_host_;
2426 std::string android_root_;
2427 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002428 std::string no_inline_from_string_;
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002429 std::vector<jobject> dex_caches_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002430 jobject class_loader_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002431
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002432 std::vector<std::unique_ptr<ElfWriter>> elf_writers_;
2433 std::vector<std::unique_ptr<OatWriter>> oat_writers_;
2434 std::vector<OutputStream*> rodata_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002435 std::unique_ptr<ImageWriter> image_writer_;
2436 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002437
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002438 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
2439 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2440
Vladimir Marko47496c22016-01-27 16:15:08 +00002441 std::vector<const DexFile*> no_inline_from_dex_files_;
2442
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002443 std::vector<std::string> verbose_methods_;
2444 bool dump_stats_;
2445 bool dump_passes_;
2446 bool dump_timing_;
2447 bool dump_slow_timing_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002448 std::string swap_file_name_;
2449 int swap_fd_;
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002450 std::string app_image_file_name_;
2451 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002452 std::string profile_file_;
2453 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002454 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002455 TimingLogger* timings_;
2456 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002457 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002458 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002459
2460 // Backing storage.
2461 std::vector<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002462
Andreas Gampeace0dc12016-01-20 13:33:13 -08002463 // See CompilerOptions.force_determinism_.
2464 bool force_determinism_;
2465
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002466 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2467};
2468
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002469static void b13564922() {
2470#if defined(__linux__) && defined(__arm__)
2471 int major, minor;
2472 struct utsname uts;
2473 if (uname(&uts) != -1 &&
2474 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2475 ((major < 3) || ((major == 3) && (minor < 4)))) {
2476 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2477 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2478 int old_personality = personality(0xffffffff);
2479 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2480 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2481 if (new_personality == -1) {
2482 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2483 }
2484 }
2485 }
2486#endif
2487}
2488
Andreas Gampe10e477d2014-11-19 12:57:42 -08002489static int CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002490 dex2oat.LoadClassProfileDescriptors();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002491 dex2oat.Compile();
2492
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002493 if (!dex2oat.WriteOatFiles()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002494 dex2oat.EraseOatFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002495 return EXIT_FAILURE;
2496 }
2497
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002498 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2499 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2500 // image writer will require this fd to generate the image.
2501 if (dex2oat.ShouldKeepOatFileOpen()) {
2502 if (!dex2oat.FlushOatFiles()) {
2503 return EXIT_FAILURE;
2504 }
2505 } else if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002506 return EXIT_FAILURE;
2507 }
2508
Jeff Haodcdc85b2015-12-04 14:06:18 -08002509 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002510 if (!dex2oat.HandleImage()) {
2511 return EXIT_FAILURE;
2512 }
2513
2514 // When given --host, finish early without stripping.
2515 if (dex2oat.IsHost()) {
2516 dex2oat.DumpTiming();
2517 return EXIT_SUCCESS;
2518 }
2519
Jeff Haodcdc85b2015-12-04 14:06:18 -08002520 // Copy stripped to unstripped location, if necessary.
2521 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002522 return EXIT_FAILURE;
2523 }
2524
Jeff Haodcdc85b2015-12-04 14:06:18 -08002525 // FlushClose again, as stripping might have re-opened the oat files.
2526 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002527 return EXIT_FAILURE;
2528 }
2529
2530 dex2oat.DumpTiming();
2531 return EXIT_SUCCESS;
2532}
2533
2534static int CompileApp(Dex2Oat& dex2oat) {
2535 dex2oat.Compile();
2536
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002537 if (!dex2oat.WriteOatFiles()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002538 dex2oat.EraseOatFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002539 return EXIT_FAILURE;
2540 }
2541
Jeff Haodcdc85b2015-12-04 14:06:18 -08002542 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002543 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002544
2545 // When given --host, finish early without stripping.
2546 if (dex2oat.IsHost()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002547 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002548 return EXIT_FAILURE;
2549 }
2550
2551 dex2oat.DumpTiming();
2552 return EXIT_SUCCESS;
2553 }
2554
Jeff Haodcdc85b2015-12-04 14:06:18 -08002555 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2556 // stripped versions. If this is given, we expect to be able to open writable files by name.
2557 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002558 return EXIT_FAILURE;
2559 }
2560
Jeff Haodcdc85b2015-12-04 14:06:18 -08002561 // Flush and close the files.
2562 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002563 return EXIT_FAILURE;
2564 }
2565
2566 dex2oat.DumpTiming();
2567 return EXIT_SUCCESS;
2568}
2569
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002570static int dex2oat(int argc, char** argv) {
2571 b13564922();
2572
2573 TimingLogger timings("compiler", false, false);
2574
Roland Levillain5c7e2602016-02-23 18:08:53 +00002575 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
2576 // might produce a stack frame too large for this function or for
2577 // functions inlining it (such as main), that would not fit the
2578 // requirements of the `-Wframe-larger-than` option.
2579 std::unique_ptr<Dex2Oat> dex2oat = MakeUnique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002580
2581 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002582 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002583
Calin Juravleb077e152016-02-18 18:47:37 +00002584 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02002585 // This operation involves I/O.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002586 if (dex2oat->UseProfileGuidedCompilation()) {
Calin Juravleb077e152016-02-18 18:47:37 +00002587 if (!dex2oat->LoadProfile()) {
2588 LOG(ERROR) << "Failed to process profile file";
Calin Juravle998c2162015-12-21 15:39:33 +02002589 return EXIT_FAILURE;
2590 }
2591 }
2592
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002593 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00002594 if (!dex2oat->OpenFile()) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002595 return EXIT_FAILURE;
2596 }
2597
Andreas Gampe046c7062015-05-18 23:22:54 -07002598 // Print the complete line when any of the following is true:
2599 // 1) Debug build
2600 // 2) Compiling an image
2601 // 3) Compiling with --host
2602 // 4) Compiling on the host (not a target build)
2603 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002604 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07002605 LOG(INFO) << CommandLine();
2606 } else {
2607 LOG(INFO) << StrippedCommandLine();
2608 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002609
Roland Levillain5c7e2602016-02-23 18:08:53 +00002610 if (!dex2oat->Setup()) {
2611 dex2oat->EraseOatFiles();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002612 return EXIT_FAILURE;
2613 }
2614
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002615 bool result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00002616 if (dex2oat->IsImage()) {
2617 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002618 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00002619 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002620 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002621
Roland Levillain5c7e2602016-02-23 18:08:53 +00002622 dex2oat->Shutdown();
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002623 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002624}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002625} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07002626
2627int main(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002628 int result = art::dex2oat(argc, argv);
2629 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
2630 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
2631 // should not destruct the runtime in this case.
Evgenii Stepanov1e133742015-05-20 12:30:59 -07002632 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002633 exit(result);
2634 }
2635 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002636}