blob: 729d712a54d2081e39fc991d116aa7dcaf609c06 [file] [log] [blame]
Brian Carlstrom7940e442013-07-12 13:46:57 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Andreas Gamped687e372015-04-28 23:16:03 -070017#include <inttypes.h>
Brian Carlstrom7940e442013-07-12 13:46:57 -070018#include <stdio.h>
19#include <stdlib.h>
20#include <sys/stat.h>
Evgenii Stepanov1e133742015-05-20 12:30:59 -070021#include "base/memory_tool.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070022
23#include <fstream>
24#include <iostream>
Andreas Gampe338a1d22016-06-24 21:05:23 -070025#include <limits>
Brian Carlstrom7940e442013-07-12 13:46:57 -070026#include <sstream>
27#include <string>
Andreas Gampeb1fcead2015-04-20 18:53:51 -070028#include <unordered_set>
Brian Carlstrom7940e442013-07-12 13:46:57 -070029#include <vector>
30
Vladimir Markof94b7812014-06-05 15:48:04 +010031#if defined(__linux__) && defined(__arm__)
32#include <sys/personality.h>
33#include <sys/utsname.h>
34#endif
35
Ian Rogersd582fa42014-11-05 23:46:43 -080036#include "arch/instruction_set_features.h"
Andreas Gampec5a3ea72015-01-13 16:41:53 -080037#include "arch/mips/instruction_set_features_mips.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000038#include "art_method-inl.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070039#include "base/dumpable.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080040#include "base/macros.h"
Calin Juravle2e2db782016-02-23 12:00:03 +000041#include "base/scoped_flock.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070042#include "base/stl_util.h"
43#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010044#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070045#include "base/timing_logger.h"
46#include "base/unix_file/fd_file.h"
47#include "class_linker.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000048#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000049#include "compiler_callbacks.h"
David Srbecky09c2a6b2016-03-11 17:11:44 +000050#include "debug/elf_debug_writer.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000051#include "debug/method_debug_info.h"
Ian Rogerse63db272014-07-15 15:36:11 -070052#include "dex/quick/dex_file_to_method_inliner_map.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000053#include "dex/quick_compiler_callbacks.h"
54#include "dex/verification_results.h"
55#include "dex_file-inl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070056#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080057#include "driver/compiler_options.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080058#include "elf_file.h"
Tong Shen62d1ca32014-09-03 17:24:56 -070059#include "elf_writer.h"
Vladimir Marko10c13562015-11-25 14:33:36 +000060#include "elf_writer_quick.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070061#include "gc/space/image_space.h"
62#include "gc/space/space-inl.h"
63#include "image_writer.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070064#include "interpreter/unstarted_runtime.h"
Calin Juravle998c2162015-12-21 15:39:33 +020065#include "jit/offline_profiling_info.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070066#include "leb128.h"
Vladimir Marko944da602016-02-19 12:27:55 +000067#include "linker/multi_oat_relative_patcher.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070068#include "mirror/class-inl.h"
69#include "mirror/class_loader.h"
70#include "mirror/object-inl.h"
71#include "mirror/object_array-inl.h"
Jeff Hao4f351aa2016-04-07 15:40:54 -070072#include "oat_file_assistant.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070073#include "oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070074#include "os.h"
75#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000076#include "runtime_options.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070077#include "ScopedLocalRef.h"
78#include "scoped_thread_state_change.h"
Alex Light53cb16b2014-06-12 11:26:29 -070079#include "utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070080#include "well_known_classes.h"
81#include "zip_archive.h"
82
83namespace art {
84
Andreas Gampe25a9abe2016-06-24 14:55:38 -070085static constexpr size_t kDefaultMinDexFilesForSwap = 2;
86static constexpr size_t kDefaultMinDexFileCumulativeSizeForSwap = 20 * MB;
87
Brian Carlstrom6449c622014-02-10 23:48:36 -080088static int original_argc;
89static char** original_argv;
90
91static std::string CommandLine() {
92 std::vector<std::string> command;
93 for (int i = 0; i < original_argc; ++i) {
94 command.push_back(original_argv[i]);
95 }
96 return Join(command, ' ');
97}
98
Andreas Gampe046c7062015-05-18 23:22:54 -070099// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
100// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
101// locations are all staged).
102static std::string StrippedCommandLine() {
103 std::vector<std::string> command;
104
105 // Do a pre-pass to look for zip-fd.
106 bool saw_zip_fd = false;
107 for (int i = 0; i < original_argc; ++i) {
108 if (StartsWith(original_argv[i], "--zip-fd=")) {
109 saw_zip_fd = true;
110 break;
111 }
112 }
113
114 // Now filter out things.
115 for (int i = 0; i < original_argc; ++i) {
116 // All runtime-arg parameters are dropped.
117 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
118 i++; // Drop the next part, too.
119 continue;
120 }
121
122 // Any instruction-setXXX is dropped.
123 if (StartsWith(original_argv[i], "--instruction-set")) {
124 continue;
125 }
126
127 // The boot image is dropped.
128 if (StartsWith(original_argv[i], "--boot-image=")) {
129 continue;
130 }
131
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800132 // The image format is dropped.
133 if (StartsWith(original_argv[i], "--image-format=")) {
134 continue;
135 }
136
Andreas Gampe046c7062015-05-18 23:22:54 -0700137 // This should leave any dex-file and oat-file options, describing what we compiled.
138
139 // However, we prefer to drop this when we saw --zip-fd.
140 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700141 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe046c7062015-05-18 23:22:54 -0700142 if (StartsWith(original_argv[i], "--zip-") ||
143 StartsWith(original_argv[i], "--dex-") ||
144 StartsWith(original_argv[i], "--oat-") ||
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700145 StartsWith(original_argv[i], "--swap-") ||
146 StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700147 continue;
148 }
149 }
150
151 command.push_back(original_argv[i]);
152 }
153
154 // Construct the final output.
155 if (command.size() <= 1U) {
156 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
157 return "Starting dex2oat.";
158 }
159 return Join(command, ' ');
160}
161
Brian Carlstrom7940e442013-07-12 13:46:57 -0700162static void UsageErrorV(const char* fmt, va_list ap) {
163 std::string error;
164 StringAppendV(&error, fmt, ap);
165 LOG(ERROR) << error;
166}
167
168static void UsageError(const char* fmt, ...) {
169 va_list ap;
170 va_start(ap, fmt);
171 UsageErrorV(fmt, ap);
172 va_end(ap);
173}
174
Andreas Gampe794ad762015-02-23 08:12:24 -0800175NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700176 va_list ap;
177 va_start(ap, fmt);
178 UsageErrorV(fmt, ap);
179 va_end(ap);
180
Brian Carlstrom6449c622014-02-10 23:48:36 -0800181 UsageError("Command: %s", CommandLine().c_str());
182
Brian Carlstrom7940e442013-07-12 13:46:57 -0700183 UsageError("Usage: dex2oat [options]...");
184 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100185 UsageError(" -j<number>: specifies the number of threads used for compilation.");
186 UsageError(" Default is the number of detected hardware threads available on the");
187 UsageError(" host system.");
188 UsageError(" Example: -j12");
189 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700190 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700191 UsageError(" Example: --dex-file=/system/framework/core.jar");
192 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700193 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
194 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
195 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
196 UsageError(" --dex-location=/system/framework/core.jar");
197 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700198 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
199 UsageError(" containing a classes.dex file to compile.");
200 UsageError(" Example: --zip-fd=5");
201 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700202 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
203 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700204 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
205 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800206 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700207 UsageError(" Example: --oat-file=/system/framework/boot.oat");
208 UsageError("");
209 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900210 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700211 UsageError("");
212 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
213 UsageError(" to the file descriptor specified by --oat-fd.");
214 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
215 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800216 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700217 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
218 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800219 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700220 UsageError(" Example: --image=/system/framework/boot.art");
221 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800222 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800223 UsageError(" Which format to store the image.");
224 UsageError(" Example: --image-format=lz4");
225 UsageError(" Default: uncompressed");
226 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700227 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
228 UsageError(" Example: --image=frameworks/base/preloaded-classes");
229 UsageError("");
230 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
231 UsageError(" Example: --base=0x50000000");
232 UsageError("");
233 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000234 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700235 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000236 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000237 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700238 UsageError("");
239 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
240 UsageError(" Example: --android-root=out/host/linux-x86");
241 UsageError(" Default: $ANDROID_ROOT");
242 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800243 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700244 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700245 UsageError(" Example: --instruction-set=x86");
246 UsageError(" Default: arm");
247 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700248 UsageError(" --instruction-set-features=...,: Specify instruction set features");
249 UsageError(" Example: --instruction-set-features=div");
250 UsageError(" Default: default");
251 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700252 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
253 UsageError(" Default: disabled");
254 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800255 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700256 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800257 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100258 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700259 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100260 UsageError(" --compiler-filter="
261 "(verify-none"
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700262 "|verify-at-runtime"
Mathieu Chartiera8077802016-03-16 19:08:31 -0700263 "|verify-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100264 "|interpret-only"
Andreas Gampe7bcfcb82016-03-23 15:31:51 +0000265 "|time"
266 "|space-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100267 "|space"
268 "|balanced"
Andreas Gampe7bcfcb82016-03-23 15:31:51 +0000269 "|speed-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100270 "|speed"
Andreas Gampe7bcfcb82016-03-23 15:31:51 +0000271 "|everything-profile"
272 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700273 UsageError(" select compiler filter.");
Mathieu Chartiera8077802016-03-16 19:08:31 -0700274 UsageError(" verify-profile requires a --profile(-fd) to also be passed in.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800275 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800276 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800277 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800278 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
279 UsageError(" method for compiler filter tuning.");
280 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
281 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
282 UsageError("");
283 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
284 UsageError(" method for compiler filter tuning.");
285 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
286 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
287 UsageError("");
288 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
289 UsageError(" method for compiler filter tuning.");
290 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
291 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
292 UsageError("");
293 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
294 UsageError(" method for compiler filter tuning.");
295 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
296 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
297 UsageError("");
298 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
299 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700300 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
301 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800302 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
303 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
304 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100305 UsageError(" --inline-depth-limit=<depth-limit>: the depth limit of inlining for fine tuning");
306 UsageError(" the compiler. A zero value will disable inlining. Honored only by Optimizing.");
Roland Levillaina215b952015-08-07 11:38:32 +0100307 UsageError(" Has priority over the --compiler-filter option. Intended for ");
308 UsageError(" development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100309 UsageError(" Example: --inline-depth-limit=%d", CompilerOptions::kDefaultInlineDepthLimit);
310 UsageError(" Default: %d", CompilerOptions::kDefaultInlineDepthLimit);
311 UsageError("");
312 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
313 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100314 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
315 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100316 UsageError(" Example: --inline-max-code-units=%d",
317 CompilerOptions::kDefaultInlineMaxCodeUnits);
318 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
319 UsageError("");
Ian Rogers46398602013-08-20 07:50:36 -0700320 UsageError(" --dump-timing: display a breakdown of where time was spent");
321 UsageError("");
Alex Light53cb16b2014-06-12 11:26:29 -0700322 UsageError(" --include-patch-information: Include patching information so the generated code");
323 UsageError(" can have its base address moved without full recompilation.");
324 UsageError("");
325 UsageError(" --no-include-patch-information: Do not include patching information.");
326 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100327 UsageError(" -g");
328 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
329 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000330 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000331 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700332 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100333 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100334 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000335 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
336 UsageError(" debug information necessary to print backtraces. (disabled by default)");
337 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000338 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000339 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000340 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000341 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700342 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
343 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
344 UsageError(" Use a separate --runtime-arg switch for each argument.");
345 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700346 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000347 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700348 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000349 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
350 UsageError(" Cannot be used together with --profile-file.");
351 UsageError("");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800352 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
353 UsageError(" Example: --swap-file=/data/tmp/swap.001");
354 UsageError("");
355 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
356 UsageError(" Example: --swap-fd=10");
357 UsageError("");
Andreas Gampe25a9abe2016-06-24 14:55:38 -0700358 UsageError(" --swap-dex-size-threshold=<size>: specifies the minimum total dex file size in");
359 UsageError(" bytes to allow the use of swap.");
360 UsageError(" Example: --swap-dex-size-threshold=1000000");
361 UsageError(" Default: %zu", kDefaultMinDexFileCumulativeSizeForSwap);
362 UsageError("");
363 UsageError(" --swap-dex-count-threshold=<count>: specifies the minimum number of dex files to");
364 UsageError(" allow the use of swap.");
365 UsageError(" Example: --swap-dex-count-threshold=10");
366 UsageError(" Default: %zu", kDefaultMinDexFilesForSwap);
367 UsageError("");
Andreas Gampe338a1d22016-06-24 21:05:23 -0700368 UsageError(" --very-large-app-threshold=<size>: specifies the minimum total dex file size in");
369 UsageError(" bytes to consider the input \"very large\" and punt on the compilation.");
370 UsageError(" Example: --very-large-app-threshold=100000000");
371 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700372 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
373 UsageError(" Example: --app-image-fd=10");
374 UsageError("");
375 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
376 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
377 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800378 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
379 "input dex file.");
380 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000381 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
382 UsageError(" This option is incompatible with read barriers (e.g., if dex2oat has been");
383 UsageError(" built with the environment variable `ART_USE_READ_BARRIER` set to `true`).");
384 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700385 std::cerr << "See log for usage error information\n";
386 exit(EXIT_FAILURE);
387}
388
Brian Carlstrom7940e442013-07-12 13:46:57 -0700389// The primary goal of the watchdog is to prevent stuck build servers
390// during development when fatal aborts lead to a cascade of failures
391// that result in a deadlock.
392class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800393// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700394#undef CHECK_PTHREAD_CALL
395#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
396 do { \
397 int rc = call args; \
398 if (rc != 0) { \
399 errno = rc; \
400 std::string message(# call); \
401 message += " failed for "; \
402 message += reason; \
403 Fatal(message); \
404 } \
405 } while (false)
406
407 public:
Brian Carlstrom93ba8932013-07-17 21:31:49 -0700408 explicit WatchDog(bool is_watch_dog_enabled) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700409 is_watch_dog_enabled_ = is_watch_dog_enabled;
410 if (!is_watch_dog_enabled_) {
411 return;
412 }
413 shutting_down_ = false;
414 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700415 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
416 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700417 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
418 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
419 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
420 }
421 ~WatchDog() {
422 if (!is_watch_dog_enabled_) {
423 return;
424 }
425 const char* reason = "dex2oat watch dog thread shutdown";
426 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
427 shutting_down_ = true;
428 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
429 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
430
Kenny Root51316382014-05-13 14:59:37 -0700431 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700432
433 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
434 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
435 }
436
437 private:
438 static void* CallBack(void* arg) {
439 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
440 ::art::SetThreadName("dex2oat watch dog");
441 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700442 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700443 }
444
Andreas Gampe794ad762015-02-23 08:12:24 -0800445 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700446 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
447 // it's rather easy to hang in unwinding.
448 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
449 // logcat logging or stderr output.
450 LogMessage::LogLine(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700451 exit(1);
452 }
453
454 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700455 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
456 // large.
Andreas Gamped687e372015-04-28 23:16:03 -0700457 constexpr int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700458 timespec timeout_ts;
459 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts);
460 const char* reason = "dex2oat watch dog thread waiting";
461 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
462 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800463 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700464 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700465 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
466 kWatchDogTimeoutSeconds));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700467 } else if (rc != 0) {
468 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
469 strerror(errno)));
470 Fatal(message.c_str());
471 }
472 }
473 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
474 }
475
476 // 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 -0700477 // Debug builds are slower so they have larger timeouts.
Andreas Gamped687e372015-04-28 23:16:03 -0700478 static constexpr int64_t kSlowdownFactor = kIsDebugBuild ? 5U : 1U;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800479
Andreas Gampe540138a2015-09-14 15:34:38 -0700480 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
481 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
482 // itself before that watchdog would take down the system server.
483 static constexpr int64_t kWatchDogTimeoutSeconds = kSlowdownFactor * (9 * 60 + 30);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700484
485 bool is_watch_dog_enabled_;
486 bool shutting_down_;
487 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
488 pthread_mutex_t mutex_;
489 pthread_cond_t cond_;
490 pthread_attr_t attr_;
491 pthread_t pthread_;
492};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700493
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 Gampe7bcfcb82016-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 Gampe7bcfcb82016-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 Gampe7bcfcb82016-03-23 15:31:51 +00001031 key_value_store_->Put(OatHeader::kCompilerFilter,
1032 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Richard Uhler1c4eb042016-03-29 13:27:41 -07001033 key_value_store_->Put(OatHeader::kHasPatchInfoKey,
1034 compiler_options_->GetIncludePatchInformation() ? OatHeader::kTrueValue
1035 : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001036 }
1037
1038 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1039 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1040 // returns, arguments have been successfully parsed.
1041 void ParseArgs(int argc, char** argv) {
1042 original_argc = argc;
1043 original_argv = argv;
1044
1045 InitLogging(argv);
1046
1047 // Skip over argv[0].
1048 argv++;
1049 argc--;
1050
1051 if (argc == 0) {
1052 Usage("No arguments specified");
1053 }
1054
1055 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001056 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001057
1058 for (int i = 0; i < argc; i++) {
1059 const StringPiece option(argv[i]);
1060 const bool log_options = false;
1061 if (log_options) {
1062 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1063 }
1064 if (option.starts_with("--dex-file=")) {
1065 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data());
1066 } else if (option.starts_with("--dex-location=")) {
1067 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data());
1068 } else if (option.starts_with("--zip-fd=")) {
1069 ParseZipFd(option);
1070 } else if (option.starts_with("--zip-location=")) {
1071 zip_location_ = option.substr(strlen("--zip-location=")).data();
1072 } else if (option.starts_with("--oat-file=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001073 oat_filenames_.push_back(option.substr(strlen("--oat-file=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001074 } else if (option.starts_with("--oat-symbols=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001075 parser_options->oat_symbols.push_back(option.substr(strlen("--oat-symbols=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001076 } else if (option.starts_with("--oat-fd=")) {
1077 ParseOatFd(option);
1078 } else if (option == "--watch-dog") {
1079 parser_options->watch_dog_enabled = true;
1080 } else if (option == "--no-watch-dog") {
1081 parser_options->watch_dog_enabled = false;
1082 } else if (option.starts_with("-j")) {
1083 ParseJ(option);
1084 } else if (option.starts_with("--oat-location=")) {
1085 oat_location_ = option.substr(strlen("--oat-location=")).data();
1086 } else if (option.starts_with("--image=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001087 image_filenames_.push_back(option.substr(strlen("--image=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001088 } else if (option.starts_with("--image-classes=")) {
1089 image_classes_filename_ = option.substr(strlen("--image-classes=")).data();
1090 } else if (option.starts_with("--image-classes-zip=")) {
1091 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data();
Mathieu Chartierceb07b32015-12-10 09:33:21 -08001092 } else if (option.starts_with("--image-format=")) {
1093 ParseImageFormat(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001094 } else if (option.starts_with("--compiled-classes=")) {
1095 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data();
1096 } else if (option.starts_with("--compiled-classes-zip=")) {
1097 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data();
1098 } else if (option.starts_with("--compiled-methods=")) {
1099 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data();
1100 } else if (option.starts_with("--compiled-methods-zip=")) {
1101 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data();
1102 } else if (option.starts_with("--base=")) {
1103 ParseBase(option);
1104 } else if (option.starts_with("--boot-image=")) {
1105 parser_options->boot_image_filename = option.substr(strlen("--boot-image=")).data();
1106 } else if (option.starts_with("--android-root=")) {
1107 android_root_ = option.substr(strlen("--android-root=")).data();
1108 } else if (option.starts_with("--instruction-set=")) {
1109 ParseInstructionSet(option);
1110 } else if (option.starts_with("--instruction-set-variant=")) {
1111 ParseInstructionSetVariant(option, parser_options.get());
1112 } else if (option.starts_with("--instruction-set-features=")) {
1113 ParseInstructionSetFeatures(option, parser_options.get());
1114 } else if (option.starts_with("--compiler-backend=")) {
1115 ParseCompilerBackend(option, parser_options.get());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001116 } else if (option.starts_with("--profile-file=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001117 profile_file_ = option.substr(strlen("--profile-file=")).ToString();
Calin Juravle877fd962016-01-05 14:29:29 +00001118 } else if (option.starts_with("--profile-file-fd=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001119 ParseUintOption(option, "--profile-file-fd", &profile_file_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001120 } else if (option == "--host") {
1121 is_host_ = true;
1122 } else if (option == "--runtime-arg") {
1123 if (++i >= argc) {
1124 Usage("Missing required argument for --runtime-arg");
1125 }
1126 if (log_options) {
1127 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1128 }
1129 runtime_args_.push_back(argv[i]);
1130 } else if (option == "--dump-timing") {
1131 dump_timing_ = true;
1132 } else if (option == "--dump-passes") {
1133 dump_passes_ = true;
Roland Levillain9ec5e222015-08-17 20:18:41 +01001134 } else if (option == "--dump-stats") {
1135 dump_stats_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001136 } else if (option.starts_with("--swap-file=")) {
1137 swap_file_name_ = option.substr(strlen("--swap-file=")).data();
1138 } else if (option.starts_with("--swap-fd=")) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001139 ParseUintOption(option, "--swap-fd", &swap_fd_, Usage);
Andreas Gampe25a9abe2016-06-24 14:55:38 -07001140 } else if (option.starts_with("--swap-dex-size-threshold=")) {
1141 ParseUintOption(option,
1142 "--swap-dex-size-threshold",
1143 &min_dex_file_cumulative_size_for_swap_,
1144 Usage);
1145 } else if (option.starts_with("--swap-dex-count-threshold=")) {
1146 ParseUintOption(option,
1147 "--swap-dex-count-threshold",
1148 &min_dex_files_for_swap_,
1149 Usage);
Andreas Gampe338a1d22016-06-24 21:05:23 -07001150 } else if (option.starts_with("--very-large-app-threshold=")) {
1151 ParseUintOption(option,
1152 "--very-large-app-threshold",
1153 &very_large_threshold_,
1154 Usage);
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001155 } else if (option.starts_with("--app-image-file=")) {
1156 app_image_file_name_ = option.substr(strlen("--app-image-file=")).data();
1157 } else if (option.starts_with("--app-image-fd=")) {
1158 ParseUintOption(option, "--app-image-fd", &app_image_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001159 } else if (option.starts_with("--verbose-methods=")) {
1160 // TODO: rather than switch off compiler logging, make all VLOG(compiler) messages
1161 // conditional on having verbost methods.
1162 gLogVerbosity.compiler = false;
1163 Split(option.substr(strlen("--verbose-methods=")).ToString(), ',', &verbose_methods_);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001164 } else if (option == "--multi-image") {
Jeff Hao436183f2016-01-12 16:36:50 -08001165 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001166 } else if (option.starts_with("--no-inline-from=")) {
1167 no_inline_from_string_ = option.substr(strlen("--no-inline-from=")).data();
Andreas Gampeace0dc12016-01-20 13:33:13 -08001168 } else if (option == "--force-determinism") {
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001169 if (!SupportsDeterministicCompilation()) {
1170 Usage("Cannot use --force-determinism with read barriers or non-CMS garbage collector");
Roland Levillaineb2c7412016-01-28 14:37:01 +00001171 }
Andreas Gampeace0dc12016-01-20 13:33:13 -08001172 force_determinism_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001173 } else if (!compiler_options_->ParseCompilerOption(option, Usage)) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001174 Usage("Unknown argument %s", option.data());
1175 }
1176 }
1177
Jeff Hao436183f2016-01-12 16:36:50 -08001178 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001179
1180 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001181 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001182 }
1183
Jeff Haodcdc85b2015-12-04 14:06:18 -08001184 // Check whether the oat output files are writable, and open them for later. Also open a swap
1185 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001186 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001187 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1188 PruneNonExistentDexFiles();
1189
Jeff Hao436183f2016-01-12 16:36:50 -08001190 // Expand oat and image filenames for multi image.
1191 if (IsBootImage() && multi_image_) {
1192 ExpandOatAndImageFilenames();
1193 }
1194
Jeff Haodcdc85b2015-12-04 14:06:18 -08001195 bool create_file = oat_fd_ == -1; // as opposed to using open file descriptor
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001196 if (create_file) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001197 for (const char* oat_filename : oat_filenames_) {
1198 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
1199 if (oat_file.get() == nullptr) {
1200 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1201 return false;
1202 }
1203 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) {
1204 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1205 oat_file->Erase();
1206 return false;
1207 }
1208 oat_files_.push_back(std::move(oat_file));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001209 }
1210 } else {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001211 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, true));
1212 oat_file->DisableAutoClose();
1213 if (oat_file->SetLength(0) != 0) {
Andreas Gampe4303ba92014-11-06 01:00:46 -08001214 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1215 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001216 if (oat_file.get() == nullptr) {
1217 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1218 return false;
1219 }
1220 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) {
1221 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_location_;
1222 oat_file->Erase();
1223 return false;
1224 }
1225 oat_filenames_.push_back(oat_location_.c_str());
1226 oat_files_.push_back(std::move(oat_file));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001227 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001228
1229 // Swap file handling.
1230 //
1231 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1232 // that we can use for swap.
1233 //
1234 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1235 // will immediately unlink to satisfy the swap fd assumption.
1236 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1237 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1238 if (swap_file.get() == nullptr) {
1239 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1240 return false;
1241 }
1242 swap_fd_ = swap_file->Fd();
1243 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1244 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1245 // released immediately.
1246 unlink(swap_file_name_.c_str());
1247 }
Jeff Hao436183f2016-01-12 16:36:50 -08001248
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001249 return true;
1250 }
1251
Jeff Haodcdc85b2015-12-04 14:06:18 -08001252 void EraseOatFiles() {
1253 for (size_t i = 0; i < oat_files_.size(); ++i) {
1254 DCHECK(oat_files_[i].get() != nullptr);
1255 oat_files_[i]->Erase();
1256 oat_files_[i].reset();
1257 }
Andreas Gampea650e702014-12-03 14:28:02 -08001258 }
1259
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001260 void Shutdown() {
1261 ScopedObjectAccess soa(Thread::Current());
1262 for (jobject dex_cache : dex_caches_) {
1263 soa.Env()->DeleteLocalRef(dex_cache);
1264 }
1265 dex_caches_.clear();
1266 }
1267
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001268 void LoadClassProfileDescriptors() {
1269 if (profile_compilation_info_ != nullptr && app_image_) {
1270 Runtime* runtime = Runtime::Current();
1271 CHECK(runtime != nullptr);
1272 std::set<DexCacheResolvedClasses> resolved_classes(
1273 profile_compilation_info_->GetResolvedClasses());
Mathieu Chartier8d26c592016-05-25 15:05:59 -07001274
1275 // Filter out class path classes since we don't want to include these in the image.
1276 std::unordered_set<std::string> dex_files_locations;
1277 for (const DexFile* dex_file : dex_files_) {
1278 dex_files_locations.insert(dex_file->GetLocation());
1279 }
1280 for (auto it = resolved_classes.begin(); it != resolved_classes.end(); ) {
1281 if (dex_files_locations.find(it->GetDexLocation()) == dex_files_locations.end()) {
1282 VLOG(compiler) << "Removed profile samples for non-app dex file " << it->GetDexLocation();
1283 it = resolved_classes.erase(it);
1284 } else {
1285 ++it;
1286 }
1287 }
1288
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001289 image_classes_.reset(new std::unordered_set<std::string>(
1290 runtime->GetClassLinker()->GetClassDescriptorsForProfileKeys(resolved_classes)));
1291 VLOG(compiler) << "Loaded " << image_classes_->size()
1292 << " image class descriptors from profile";
1293 if (VLOG_IS_ON(compiler)) {
1294 for (const std::string& s : *image_classes_) {
1295 LOG(INFO) << "Image class " << s;
1296 }
1297 }
1298 }
1299 }
1300
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001301 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1302 // boot class path.
1303 bool Setup() {
1304 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001305 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap.
Vladimir Marko49b0f452015-12-10 13:49:19 +00001306
1307 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods()) {
1308 return false;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001309 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001310
Vladimir Marko307dac92015-10-20 11:20:09 +01001311 verification_results_.reset(new VerificationResults(compiler_options_.get()));
Andreas Gampe4585f872015-03-27 23:45:15 -07001312 callbacks_.reset(new QuickCompilerCallbacks(
Vladimir Marko307dac92015-10-20 11:20:09 +01001313 verification_results_.get(),
Andreas Gampe4585f872015-03-27 23:45:15 -07001314 &method_inliner_map_,
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001315 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001316 CompilerCallbacks::CallbackMode::kCompileBootImage :
1317 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001318
Vladimir Marko49b0f452015-12-10 13:49:19 +00001319 RuntimeArgumentMap runtime_options;
1320 if (!PrepareRuntimeOptions(&runtime_options)) {
1321 return false;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001322 }
1323
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001324 CreateOatWriters();
1325 if (!AddDexFileSources()) {
1326 return false;
1327 }
1328
1329 if (IsBootImage() && image_filenames_.size() > 1) {
1330 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1331 // We need this for the multi-image case.
Mathieu Chartier25adcfb2016-09-21 15:24:18 -07001332 key_value_store_->Put(OatHeader::kBootClassPathKey,
1333 gc::space::ImageSpace::GetMultiImageBootClassPath(dex_locations_,
1334 oat_filenames_,
1335 image_filenames_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001336 }
1337
1338 if (!IsBootImage()) {
1339 // When compiling an app, create the runtime early to retrieve
1340 // the image location key needed for the oat header.
1341 if (!CreateRuntime(std::move(runtime_options))) {
1342 return false;
1343 }
1344
Andreas Gampe7bcfcb82016-03-23 15:31:51 +00001345 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001346 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1347 std::vector<gc::space::ImageSpace*> image_spaces =
1348 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Jeff Hao4f351aa2016-04-07 15:40:54 -07001349 image_file_location_oat_checksum_ = OatFileAssistant::CalculateCombinedImageChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001350 image_file_location_oat_data_begin_ =
1351 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1352 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1353 // Store the boot image filename(s).
1354 std::vector<std::string> image_filenames;
1355 for (const gc::space::ImageSpace* image_space : image_spaces) {
1356 image_filenames.push_back(image_space->GetImageFilename());
1357 }
1358 std::string image_file_location = Join(image_filenames, ':');
1359 if (!image_file_location.empty()) {
1360 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1361 }
Andreas Gampe7bcfcb82016-03-23 15:31:51 +00001362 } else {
1363 image_file_location_oat_checksum_ = 0u;
1364 image_file_location_oat_data_begin_ = 0u;
1365 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001366 }
1367
1368 // Open dex files for class path.
1369 const std::vector<std::string> class_path_locations =
1370 GetClassPathLocations(runtime_->GetClassPathString());
Jeff Hao5872d7c2016-04-27 11:07:41 -07001371 OpenClassPathFiles(class_path_locations,
1372 &class_path_files_,
1373 &opened_oat_files_,
1374 runtime_->GetInstructionSet());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001375
1376 // Store the classpath we have right now.
1377 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
Jeff Hao5872d7c2016-04-27 11:07:41 -07001378 std::string encoded_class_path;
1379 if (class_path_locations.size() == 1 &&
1380 class_path_locations[0] == OatFile::kSpecialSharedLibrary) {
1381 // When passing the special shared library as the classpath, it is the only path.
1382 encoded_class_path = OatFile::kSpecialSharedLibrary;
1383 } else {
1384 encoded_class_path = OatFile::EncodeDexFileDependencies(class_path_files);
1385 }
1386 key_value_store_->Put(OatHeader::kClassPathKey, encoded_class_path);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001387 }
1388
1389 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001390 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001391 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1392 rodata_.reserve(oat_writers_.size());
1393 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1394 rodata_.push_back(elf_writers_[i]->StartRoData());
1395 // Unzip or copy dex files straight to the oat file.
1396 std::unique_ptr<MemMap> opened_dex_files_map;
1397 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
1398 if (!oat_writers_[i]->WriteAndOpenDexFiles(rodata_.back(),
1399 oat_files_[i].get(),
1400 instruction_set_,
1401 instruction_set_features_.get(),
1402 key_value_store_.get(),
Andreas Gampe3a2bd292016-01-26 17:23:47 -08001403 /* verify */ true,
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001404 &opened_dex_files_map,
1405 &opened_dex_files)) {
1406 return false;
1407 }
1408 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1409 if (opened_dex_files_map != nullptr) {
1410 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
1411 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001412 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001413 opened_dex_files_.push_back(std::move(dex_file));
1414 }
1415 } else {
1416 DCHECK(opened_dex_files.empty());
1417 }
1418 }
1419 }
1420
1421 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
Andreas Gampece55f0d2016-06-08 18:18:47 -07001422
1423 // We had to postpone the swap decision till now, as this is the point when we actually
1424 // know about the dex files we're going to use.
1425
1426 // Make sure that we didn't create the driver, yet.
1427 CHECK(driver_ == nullptr);
1428 // If we use a swap file, ensure we are above the threshold to make it necessary.
1429 if (swap_fd_ != -1) {
1430 if (!UseSwap(IsBootImage(), dex_files_)) {
1431 close(swap_fd_);
1432 swap_fd_ = -1;
1433 VLOG(compiler) << "Decided to run without swap.";
1434 } else {
1435 LOG(INFO) << "Large app, accepted running with swap.";
1436 }
1437 }
1438 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
1439
Andreas Gampe338a1d22016-06-24 21:05:23 -07001440 // If we need to downgrade the compiler-filter for size reasons, do that check now.
1441 if (!IsBootImage() && IsVeryLarge(dex_files_)) {
1442 if (!CompilerFilter::IsAsGoodAs(CompilerFilter::kVerifyAtRuntime,
1443 compiler_options_->GetCompilerFilter())) {
1444 LOG(INFO) << "Very large app, downgrading to verify-at-runtime.";
1445 // Note: this change won't be reflected in the key-value store, as that had to be
1446 // finalized before loading the dex files. This setup is currently required
1447 // to get the size from the DexFile objects.
1448 // TODO: refactor. b/29790079
1449 compiler_options_->SetCompilerFilter(CompilerFilter::kVerifyAtRuntime);
1450 }
1451 }
1452
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001453 if (IsBootImage()) {
1454 // For boot image, pass opened dex files to the Runtime::Create().
1455 // Note: Runtime acquires ownership of these dex files.
1456 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001457 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001458 return false;
1459 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001460 }
1461
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001462 // If we're doing the image, override the compiler filter to force full compilation. Must be
1463 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1464 // compilation of class initializers.
1465 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001466 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001467 WellKnownClasses::Init(self->GetJniEnv());
1468
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001469 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001470 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001471 constexpr bool kSaveDexInput = false;
1472 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001473 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001474 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001475
1476 // Handle and ClassLoader creation needs to come after Runtime::Create.
1477 ScopedObjectAccess soa(self);
1478
1479 // Classpath: first the class-path given.
1480 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1481
1482 // Then the dex files we'll compile. Thus we'll resolve the class-path first.
1483 class_path_files.insert(class_path_files.end(), dex_files_.begin(), dex_files_.end());
1484
1485 class_loader_ = class_linker->CreatePathClassLoader(self, class_path_files);
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001486 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001487
1488 // Ensure opened dex files are writable for dex-to-dex transformations.
1489 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1490 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1491 PLOG(ERROR) << "Failed to make .dex files writeable.";
1492 return false;
Vladimir Marko919f5532016-01-20 19:13:01 +00001493 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001494 }
1495
1496 // Ensure that the dex caches stay live since we don't want class unloading
1497 // to occur during compilation.
1498 for (const auto& dex_file : dex_files_) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001499 ScopedObjectAccess soa(self);
1500 dex_caches_.push_back(soa.AddLocalReference<jobject>(
Mathieu Chartierc9dbb1d2016-06-03 17:47:32 -07001501 class_linker->RegisterDexFile(*dex_file,
1502 soa.Decode<mirror::ClassLoader*>(class_loader_))));
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001503 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001504
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001505 return true;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001506 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001507
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001508 // If we need to keep the oat file open for the image writer.
1509 bool ShouldKeepOatFileOpen() const {
1510 return IsImage() && oat_fd_ != kInvalidFd;
1511 }
1512
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001513 // Create and invoke the compiler driver. This will compile all the dex files.
1514 void Compile() {
1515 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1516 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001517
Vladimir Marko47496c22016-01-27 16:15:08 +00001518 // Find the dex files we should not inline from.
1519
1520 std::vector<std::string> no_inline_filters;
1521 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001522
1523 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001524 const std::string core_oj = "core-oj";
1525 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1526 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001527 }
1528
Vladimir Marko47496c22016-01-27 16:15:08 +00001529 if (!no_inline_filters.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001530 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1531 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1532 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1533 &class_linker->GetBootClassPath(),
1534 &class_path_files,
1535 &dex_files_
1536 };
1537 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001538 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001539 for (const std::string& filter : no_inline_filters) {
1540 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
1541 // allows tests to specify <test-dexfile>:classes2.dex if needed but if the
1542 // base location passes the StartsWith() test, so do all extra locations.
1543 std::string dex_location = dex_file->GetLocation();
1544 if (filter.find('/') == std::string::npos) {
1545 // The filter does not contain the path. Remove the path from dex_location as well.
1546 size_t last_slash = dex_file->GetLocation().rfind('/');
1547 if (last_slash != std::string::npos) {
1548 dex_location = dex_location.substr(last_slash + 1);
1549 }
1550 }
1551
1552 if (StartsWith(dex_location, filter.c_str())) {
1553 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1554 no_inline_from_dex_files_.push_back(dex_file);
1555 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001556 }
1557 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001558 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001559 }
1560 if (!no_inline_from_dex_files_.empty()) {
1561 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001562 }
1563 }
1564
Vladimir Marko307dac92015-10-20 11:20:09 +01001565 driver_.reset(new CompilerDriver(compiler_options_.get(),
1566 verification_results_.get(),
1567 &method_inliner_map_,
1568 compiler_kind_,
1569 instruction_set_,
1570 instruction_set_features_.get(),
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001571 IsBootImage(),
Mathieu Chartiercdca4762016-04-28 09:44:54 -07001572 IsAppImage(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001573 image_classes_.release(),
1574 compiled_classes_.release(),
Vladimir Marko944da602016-02-19 12:27:55 +00001575 /* compiled_methods */ nullptr,
Vladimir Marko307dac92015-10-20 11:20:09 +01001576 thread_count_,
1577 dump_stats_,
1578 dump_passes_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001579 compiler_phases_timings_.get(),
1580 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001581 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001582 driver_->SetDexFilesForOatFile(dex_files_);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001583 driver_->CompileAll(class_loader_, dex_files_, timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001584 }
1585
Jeff Hao436183f2016-01-12 16:36:50 -08001586 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001587 // ensure the references between the two are correct.
1588 //
1589 // Currently we have a memory layout that looks something like this:
1590 //
1591 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001592 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001593 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001594 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001595 // +--------------+
1596 // | alloc spaces |
1597 // +--------------+
1598 //
Jeff Hao436183f2016-01-12 16:36:50 -08001599 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001600 //
Jeff Hao436183f2016-01-12 16:36:50 -08001601 // 1. The images are expected to be loaded at an absolute address and
1602 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001603 //
Jeff Hao436183f2016-01-12 16:36:50 -08001604 // 2. There are absolute pointers from Methods in the images to their
1605 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001606 //
Jeff Hao436183f2016-01-12 16:36:50 -08001607 // 3. There are absolute pointers from the code in the oat files to Methods
1608 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001609 //
Jeff Hao436183f2016-01-12 16:36:50 -08001610 // 4. There are absolute pointers from code in the oat files to other code
1611 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001612 //
1613 // To get this all correct, we go through several steps.
1614 //
Jeff Hao436183f2016-01-12 16:36:50 -08001615 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001616 // the oat data size and code size. During this stage, we also set
1617 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001618 //
Jeff Hao436183f2016-01-12 16:36:50 -08001619 // 2. We prepare offsets for the objects in the images and calculate
1620 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001621 //
Jeff Hao436183f2016-01-12 16:36:50 -08001622 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001623 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001624 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001625 // can prepare the ELF headers and we then know the ELF memory segment
1626 // layout and we can now resolve all references. The compiler provides
1627 // LinkerPatch information in each CompiledMethod and we resolve these,
1628 // using the layout information and image object locations provided by
1629 // image writer, as we're writing the method code.
1630 //
Jeff Hao436183f2016-01-12 16:36:50 -08001631 // 4. We create the image files. They need to know where the oat files
1632 // will be loaded after itself. Originally oat files were simply
1633 // memory mapped so we could predict where their contents were based
1634 // on the file size. Now that they are ELF files, we need to inspect
1635 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001636 // where the oat header is located within.
1637 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001638 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001639 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001640 // load the .so at the desired location at runtime by offsetting the
1641 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001642 // TODO: Do this in step 3. We already know the layout there.
1643 //
1644 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1645 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001646
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001647 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1648 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001649 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1650 // case (when the file will be explicitly erased).
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001651 bool WriteOatFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001652 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1653
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001654 // Sync the data to the file, in case we did dex2dex transformations.
1655 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1656 if (!map->Sync()) {
1657 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1658 return false;
1659 }
1660 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001661
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001662 if (IsImage()) {
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001663 if (app_image_ && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001664 gc::Heap* const heap = Runtime::Current()->GetHeap();
1665 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001666 image_base_ = std::max(image_base_, RoundUp(
1667 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1668 kPageSize));
1669 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001670 // The non moving space is right after the oat file. Put the preferred app image location
1671 // right after the non moving space so that we ideally get a continuous immune region for
1672 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001673 // Use the default non moving space capacity since dex2oat does not have a separate non-
1674 // moving space. This means the runtime's non moving space space size will be as large
1675 // as the growth limit for dex2oat, but smaller in the zygote.
1676 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001677 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001678 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1679 }
1680
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001681 image_writer_.reset(new ImageWriter(*driver_,
1682 image_base_,
1683 compiler_options_->GetCompilePic(),
1684 IsAppImage(),
1685 image_storage_mode_,
1686 oat_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00001687 dex_file_oat_index_map_));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001688
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001689 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001690 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1691 if (!image_writer_->PrepareImageAddressSpace()) {
1692 LOG(ERROR) << "Failed to prepare image address space.";
1693 return false;
1694 }
1695 }
1696
Vladimir Marko944da602016-02-19 12:27:55 +00001697 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001698 {
1699 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001700 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko944da602016-02-19 12:27:55 +00001701 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1702 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
1703
1704 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1705 oat_writer->PrepareLayout(driver_.get(), image_writer_.get(), dex_files, &patcher);
1706
1707 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
1708 size_t text_size = oat_writer->GetSize() - rodata_size;
1709 elf_writer->SetLoadedSectionSizes(rodata_size, text_size, oat_writer->GetBssSize());
1710
1711 if (IsImage()) {
1712 // Update oat layout.
1713 DCHECK(image_writer_ != nullptr);
1714 DCHECK_LT(i, oat_filenames_.size());
1715 image_writer_->UpdateOatFileLayout(i,
1716 elf_writer->GetLoadedSize(),
1717 oat_writer->GetOatDataOffset(),
1718 oat_writer->GetSize());
1719 }
1720 }
1721
1722 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001723 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001724 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1725 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00001726
David Srbecky09c2a6b2016-03-11 17:11:44 +00001727 oat_writer->AddMethodDebugInfos(debug::MakeTrampolineInfos(oat_writer->GetOatHeader()));
1728
David Srbecky0c4572e2016-01-22 19:19:25 +00001729 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00001730 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
1731 elf_writer->PrepareDebugInfo(oat_writer->GetMethodDebugInfo());
David Srbecky0c4572e2016-01-22 19:19:25 +00001732
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001733 OutputStream*& rodata = rodata_[i];
1734 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001735 if (!oat_writer->WriteRodata(rodata)) {
1736 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
1737 return false;
1738 }
1739 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001740 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00001741
Jeff Haodcdc85b2015-12-04 14:06:18 -08001742 OutputStream* text = elf_writer->StartText();
1743 if (!oat_writer->WriteCode(text)) {
1744 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
1745 return false;
1746 }
1747 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00001748
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001749 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
1750 image_file_location_oat_checksum_,
1751 image_file_location_oat_data_begin_,
1752 image_patch_delta_)) {
1753 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
1754 return false;
1755 }
1756
Vladimir Marko944da602016-02-19 12:27:55 +00001757 if (IsImage()) {
1758 // Update oat header information.
1759 DCHECK(image_writer_ != nullptr);
1760 DCHECK_LT(i, oat_filenames_.size());
1761 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
1762 }
1763
Jeff Haodcdc85b2015-12-04 14:06:18 -08001764 elf_writer->WriteDynamicSection();
1765 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
1766 elf_writer->WritePatchLocations(oat_writer->GetAbsolutePatchLocations());
Vladimir Marko10c13562015-11-25 14:33:36 +00001767
Jeff Haodcdc85b2015-12-04 14:06:18 -08001768 if (!elf_writer->End()) {
1769 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
1770 return false;
1771 }
1772
1773 // Flush the oat file.
1774 if (oat_files_[i] != nullptr) {
1775 if (oat_files_[i]->Flush() != 0) {
1776 PLOG(ERROR) << "Failed to flush oat file: " << oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08001777 return false;
1778 }
1779 }
1780
Jeff Haodcdc85b2015-12-04 14:06:18 -08001781 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001782
1783 oat_writer.reset();
1784 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001785 }
1786 }
1787
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001788 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001789 }
1790
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001791 // If we are compiling an image, invoke the image creation routine. Else just skip.
1792 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001793 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001794 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
1795 if (!CreateImageFile()) {
1796 return false;
1797 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001798 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07001799 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001800 return true;
1801 }
1802
Jeff Haodcdc85b2015-12-04 14:06:18 -08001803 // Create a copy from stripped to unstripped.
1804 bool CopyStrippedToUnstripped() {
1805 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
1806 // If we don't want to strip in place, copy from stripped location to unstripped location.
1807 // We need to strip after image creation because FixupElf needs to use .strtab.
1808 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
1809 // If the oat file is still open, flush it.
1810 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
1811 if (!FlushCloseOatFile(i)) {
1812 return false;
1813 }
1814 }
1815
1816 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
1817 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
1818 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
1819 size_t buffer_size = 8192;
1820 std::unique_ptr<uint8_t[]> buffer(new uint8_t[buffer_size]);
1821 while (true) {
1822 int bytes_read = TEMP_FAILURE_RETRY(read(in->Fd(), buffer.get(), buffer_size));
1823 if (bytes_read <= 0) {
1824 break;
1825 }
1826 bool write_ok = out->WriteFully(buffer.get(), bytes_read);
1827 CHECK(write_ok);
1828 }
1829 if (out->FlushCloseOrErase() != 0) {
1830 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
1831 return false;
1832 }
1833 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
1834 }
1835 }
1836 return true;
1837 }
1838
1839 bool FlushOatFiles() {
1840 TimingLogger::ScopedTiming t2("dex2oat Flush ELF", timings_);
1841 for (size_t i = 0; i < oat_files_.size(); ++i) {
1842 if (oat_files_[i].get() != nullptr) {
1843 if (oat_files_[i]->Flush() != 0) {
1844 PLOG(ERROR) << "Failed to flush oat file: " << oat_filenames_[i];
1845 oat_files_[i]->Erase();
Andreas Gampe10e477d2014-11-19 12:57:42 -08001846 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001847 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001848 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00001849 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08001850 return true;
1851 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001852
Jeff Haodcdc85b2015-12-04 14:06:18 -08001853 bool FlushCloseOatFile(size_t i) {
1854 if (oat_files_[i].get() != nullptr) {
1855 std::unique_ptr<File> tmp(oat_files_[i].release());
Andreas Gampe10e477d2014-11-19 12:57:42 -08001856 if (tmp->FlushCloseOrErase() != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001857 PLOG(ERROR) << "Failed to flush and close oat file: " << oat_filenames_[i];
Andreas Gampe10e477d2014-11-19 12:57:42 -08001858 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001859 }
1860 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001861 return true;
1862 }
1863
Jeff Haodcdc85b2015-12-04 14:06:18 -08001864 bool FlushCloseOatFiles() {
1865 bool result = true;
1866 for (size_t i = 0; i < oat_files_.size(); ++i) {
1867 result &= FlushCloseOatFile(i);
1868 }
1869 return result;
1870 }
1871
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001872 void DumpTiming() {
1873 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
1874 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
1875 }
1876 if (dump_passes_) {
1877 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
1878 }
1879 }
1880
Andreas Gampe10e477d2014-11-19 12:57:42 -08001881 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001882 return IsAppImage() || IsBootImage();
1883 }
1884
1885 bool IsAppImage() const {
1886 return app_image_;
1887 }
1888
1889 bool IsBootImage() const {
1890 return boot_image_;
Andreas Gampe10e477d2014-11-19 12:57:42 -08001891 }
1892
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001893 bool IsHost() const {
1894 return is_host_;
1895 }
1896
Calin Juravle998c2162015-12-21 15:39:33 +02001897 bool UseProfileGuidedCompilation() const {
Andreas Gampe7bcfcb82016-03-23 15:31:51 +00001898 return CompilerFilter::DependsOnProfile(compiler_options_->GetCompilerFilter());
Calin Juravle998c2162015-12-21 15:39:33 +02001899 }
1900
Calin Juravle2e2db782016-02-23 12:00:03 +00001901 bool LoadProfile() {
Calin Juravle998c2162015-12-21 15:39:33 +02001902 DCHECK(UseProfileGuidedCompilation());
Calin Juravle2e2db782016-02-23 12:00:03 +00001903
1904 profile_compilation_info_.reset(new ProfileCompilationInfo());
1905 ScopedFlock flock;
Andreas Gampe7bcfcb82016-03-23 15:31:51 +00001906 bool success = true;
Calin Juravle2e2db782016-02-23 12:00:03 +00001907 std::string error;
1908 if (profile_file_fd_ != -1) {
1909 // The file doesn't need to be flushed so don't check the usage.
1910 // Pass a bogus path so that we can easily attribute any reported error.
1911 File file(profile_file_fd_, "profile", /*check_usage*/ false, /*read_only_mode*/ true);
1912 if (flock.Init(&file, &error)) {
1913 success = profile_compilation_info_->Load(profile_file_fd_);
1914 }
Andreas Gampe7bcfcb82016-03-23 15:31:51 +00001915 } else if (profile_file_ != "") {
Calin Juravle2e2db782016-02-23 12:00:03 +00001916 if (flock.Init(profile_file_.c_str(), O_RDONLY, /* block */ true, &error)) {
1917 success = profile_compilation_info_->Load(flock.GetFile()->Fd());
1918 }
1919 }
1920 if (!error.empty()) {
1921 LOG(WARNING) << "Cannot lock profiles: " << error;
Calin Juravle998c2162015-12-21 15:39:33 +02001922 }
Calin Juravle877fd962016-01-05 14:29:29 +00001923
Calin Juravle2e2db782016-02-23 12:00:03 +00001924 if (!success) {
1925 profile_compilation_info_.reset(nullptr);
1926 }
Calin Juravle877fd962016-01-05 14:29:29 +00001927
Calin Juravle2e2db782016-02-23 12:00:03 +00001928 return success;
Calin Juravle998c2162015-12-21 15:39:33 +02001929 }
1930
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001931 private:
Andreas Gampe25a9abe2016-06-24 14:55:38 -07001932 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
1933 if (is_image) {
1934 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
1935 return false;
1936 }
1937 if (dex_files.size() < min_dex_files_for_swap_) {
1938 // If there are less dex files than the threshold, assume it's gonna be fine.
1939 return false;
1940 }
1941 size_t dex_files_size = 0;
1942 for (const auto* dex_file : dex_files) {
1943 dex_files_size += dex_file->GetHeader().file_size_;
1944 }
1945 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
1946 }
1947
Andreas Gampe338a1d22016-06-24 21:05:23 -07001948 bool IsVeryLarge(std::vector<const DexFile*>& dex_files) {
1949 size_t dex_files_size = 0;
1950 for (const auto* dex_file : dex_files) {
1951 dex_files_size += dex_file->GetHeader().file_size_;
1952 }
1953 return dex_files_size >= very_large_threshold_;
1954 }
1955
Vladimir Marko49b0f452015-12-10 13:49:19 +00001956 template <typename T>
1957 static std::vector<T*> MakeNonOwningPointerVector(const std::vector<std::unique_ptr<T>>& src) {
1958 std::vector<T*> result;
1959 result.reserve(src.size());
1960 for (const std::unique_ptr<T>& t : src) {
1961 result.push_back(t.get());
1962 }
1963 return result;
1964 }
1965
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001966 std::vector<std::string> GetClassPathLocations(const std::string& class_path) {
1967 // This function is used only for apps and for an app we have exactly one oat file.
1968 DCHECK(!IsBootImage());
1969 DCHECK_EQ(oat_writers_.size(), 1u);
1970 std::vector<std::string> dex_files_canonical_locations;
1971 for (const char* location : oat_writers_[0]->GetSourceLocations()) {
1972 dex_files_canonical_locations.push_back(DexFile::GetDexCanonicalLocation(location));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001973 }
Vladimir Marko625a64a2015-11-26 14:44:16 +00001974
Vladimir Marko919f5532016-01-20 19:13:01 +00001975 std::vector<std::string> parsed;
1976 Split(class_path, ':', &parsed);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001977 auto kept_it = std::remove_if(parsed.begin(),
1978 parsed.end(),
1979 [dex_files_canonical_locations](const std::string& location) {
1980 return ContainsElement(dex_files_canonical_locations,
1981 DexFile::GetDexCanonicalLocation(location.c_str()));
1982 });
1983 parsed.erase(kept_it, parsed.end());
1984 return parsed;
1985 }
1986
Jeff Hao5872d7c2016-04-27 11:07:41 -07001987 // Opens requested class path files and appends them to opened_dex_files. If the dex files have
1988 // been stripped, this opens them from their oat files and appends them to opened_oat_files.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001989 static void OpenClassPathFiles(const std::vector<std::string>& class_path_locations,
Jeff Hao5872d7c2016-04-27 11:07:41 -07001990 std::vector<std::unique_ptr<const DexFile>>* opened_dex_files,
1991 std::vector<std::unique_ptr<OatFile>>* opened_oat_files,
1992 InstructionSet isa) {
1993 DCHECK(opened_dex_files != nullptr) << "OpenClassPathFiles dex out-param is nullptr";
1994 DCHECK(opened_oat_files != nullptr) << "OpenClassPathFiles oat out-param is nullptr";
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001995 for (const std::string& location : class_path_locations) {
Jeff Hao5872d7c2016-04-27 11:07:41 -07001996 // Stop early if we detect the special shared library, which may be passed as the classpath
1997 // for dex2oat when we want to skip the shared libraries check.
1998 if (location == OatFile::kSpecialSharedLibrary) {
1999 break;
2000 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002001 std::string error_msg;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002002 if (!DexFile::Open(location.c_str(), location.c_str(), &error_msg, opened_dex_files)) {
Jeff Hao5872d7c2016-04-27 11:07:41 -07002003 // If we fail to open the dex file because it's been stripped, try to open the dex file
2004 // from its corresponding oat file.
2005 OatFileAssistant oat_file_assistant(location.c_str(), isa, false, false);
2006 std::unique_ptr<OatFile> oat_file(oat_file_assistant.GetBestOatFile());
2007 if (oat_file == nullptr) {
2008 LOG(WARNING) << "Failed to open dex file and associated oat file for '" << location
2009 << "': " << error_msg;
2010 } else {
2011 std::vector<std::unique_ptr<const DexFile>> oat_dex_files =
2012 oat_file_assistant.LoadDexFiles(*oat_file, location.c_str());
2013 opened_oat_files->push_back(std::move(oat_file));
2014 opened_dex_files->insert(opened_dex_files->end(),
2015 std::make_move_iterator(oat_dex_files.begin()),
2016 std::make_move_iterator(oat_dex_files.end()));
2017 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002018 }
2019 }
2020 }
2021
Vladimir Marko49b0f452015-12-10 13:49:19 +00002022 bool PrepareImageClasses() {
2023 // If --image-classes was specified, calculate the full list of classes to include in the image.
2024 if (image_classes_filename_ != nullptr) {
2025 image_classes_ =
2026 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2027 if (image_classes_ == nullptr) {
2028 return false;
2029 }
2030 } else if (IsBootImage()) {
2031 image_classes_.reset(new std::unordered_set<std::string>);
2032 }
2033 return true;
2034 }
2035
2036 bool PrepareCompiledClasses() {
2037 // If --compiled-classes was specified, calculate the full list of classes to compile in the
2038 // image.
2039 if (compiled_classes_filename_ != nullptr) {
2040 compiled_classes_ =
2041 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
2042 if (compiled_classes_ == nullptr) {
2043 return false;
2044 }
2045 } else {
2046 compiled_classes_.reset(nullptr); // By default compile everything.
2047 }
2048 return true;
2049 }
2050
2051 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2052 const char* classes_filename,
2053 const char* tag) {
2054 std::unique_ptr<std::unordered_set<std::string>> classes;
2055 std::string error_msg;
2056 if (zip_filename != nullptr) {
2057 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2058 } else {
2059 classes.reset(ReadImageClassesFromFile(classes_filename));
2060 }
2061 if (classes == nullptr) {
2062 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2063 << classes_filename << "': " << error_msg;
2064 }
2065 return classes;
2066 }
2067
2068 bool PrepareCompiledMethods() {
2069 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2070 if (compiled_methods_filename_ != nullptr) {
2071 std::string error_msg;
2072 if (compiled_methods_zip_filename_ != nullptr) {
2073 compiled_methods_.reset(ReadCommentedInputFromZip(compiled_methods_zip_filename_,
2074 compiled_methods_filename_,
2075 nullptr, // No post-processing.
2076 &error_msg));
2077 } else {
2078 compiled_methods_.reset(ReadCommentedInputFromFile(compiled_methods_filename_,
2079 nullptr)); // No post-processing.
2080 }
2081 if (compiled_methods_.get() == nullptr) {
2082 LOG(ERROR) << "Failed to create list of compiled methods from '"
2083 << compiled_methods_filename_ << "': " << error_msg;
2084 return false;
2085 }
2086 } else {
2087 compiled_methods_.reset(nullptr); // By default compile everything.
2088 }
2089 return true;
2090 }
2091
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002092 void PruneNonExistentDexFiles() {
2093 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2094 size_t kept = 0u;
2095 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2096 if (!OS::FileExists(dex_filenames_[i])) {
2097 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2098 } else {
2099 dex_filenames_[kept] = dex_filenames_[i];
2100 dex_locations_[kept] = dex_locations_[i];
2101 ++kept;
2102 }
2103 }
2104 dex_filenames_.resize(kept);
2105 dex_locations_.resize(kept);
2106 }
2107
2108 bool AddDexFileSources() {
2109 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
2110 if (zip_fd_ != -1) {
2111 DCHECK_EQ(oat_writers_.size(), 1u);
2112 if (!oat_writers_[0]->AddZippedDexFilesSource(ScopedFd(zip_fd_), zip_location_.c_str())) {
2113 return false;
2114 }
2115 } else if (oat_writers_.size() > 1u) {
2116 // Multi-image.
2117 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2118 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2119 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2120 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2121 return false;
2122 }
2123 }
2124 } else {
2125 DCHECK_EQ(oat_writers_.size(), 1u);
2126 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2127 DCHECK_NE(dex_filenames_.size(), 0u);
2128 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2129 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2130 return false;
2131 }
2132 }
2133 }
2134 return true;
2135 }
2136
2137 void CreateOatWriters() {
2138 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2139 elf_writers_.reserve(oat_files_.size());
2140 oat_writers_.reserve(oat_files_.size());
2141 for (const std::unique_ptr<File>& oat_file : oat_files_) {
David Srbecky5d811202016-03-08 13:21:22 +00002142 elf_writers_.emplace_back(CreateElfWriterQuick(instruction_set_,
2143 instruction_set_features_.get(),
2144 compiler_options_.get(),
2145 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002146 elf_writers_.back()->Start();
2147 oat_writers_.emplace_back(new OatWriter(IsBootImage(), timings_));
2148 }
2149 }
2150
Vladimir Marko49b0f452015-12-10 13:49:19 +00002151 void SaveDexInput() {
2152 for (size_t i = 0; i < dex_files_.size(); ++i) {
2153 const DexFile* dex_file = dex_files_[i];
2154 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2155 getpid(), i));
2156 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2157 if (tmp_file.get() == nullptr) {
2158 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2159 << ". Try: adb shell chmod 777 /data/local/tmp";
2160 continue;
2161 }
2162 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2163 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2164 UNUSED(tmp_file->Flush());
2165 UNUSED(tmp_file->Close());
2166 LOG(INFO) << "Wrote input to " << tmp_file_name;
2167 }
2168 }
2169
2170 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options) {
2171 RuntimeOptions raw_options;
2172 if (boot_image_filename_.empty()) {
2173 std::string boot_class_path = "-Xbootclasspath:";
2174 boot_class_path += Join(dex_filenames_, ':');
2175 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2176 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
2177 boot_class_path_locations += Join(dex_locations_, ':');
2178 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2179 } else {
2180 std::string boot_image_option = "-Ximage:";
2181 boot_image_option += boot_image_filename_;
2182 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2183 }
2184 for (size_t i = 0; i < runtime_args_.size(); i++) {
2185 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2186 }
2187
2188 raw_options.push_back(std::make_pair("compilercallbacks", callbacks_.get()));
2189 raw_options.push_back(
2190 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2191
2192 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2193 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2194 // have been stripped in preopting, anyways).
2195 if (!IsBootImage()) {
2196 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2197 }
2198 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2199 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2200 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002201 // Disable Hspace compaction to save heap size virtual space.
2202 // Only need disable Hspace for OOM becasue background collector is equal to
2203 // foreground collector by default for dex2oat.
2204 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002205
Andreas Gampeace0dc12016-01-20 13:33:13 -08002206 // If we're asked to be deterministic, ensure non-concurrent GC for determinism. Also
2207 // force the free-list implementation for large objects.
2208 if (compiler_options_->IsForceDeterminism()) {
2209 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
2210 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=freelist", nullptr));
2211
2212 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2213 // compaction (done above) and ensure that neither foreground nor background collectors
2214 // are concurrent.
2215 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2216
2217 // To make identity hashcode deterministic, set a known seed.
2218 mirror::Object::SetHashCodeSeed(987654321U);
2219 }
2220
Vladimir Marko49b0f452015-12-10 13:49:19 +00002221 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2222 LOG(ERROR) << "Failed to parse runtime options";
2223 return false;
2224 }
2225 return true;
2226 }
2227
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002228 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002229 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2230 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002231 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002232 LOG(ERROR) << "Failed to create runtime";
2233 return false;
2234 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002235 runtime_.reset(Runtime::Current());
2236 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002237 for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) {
2238 Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002239 if (!runtime_->HasCalleeSaveMethod(type)) {
2240 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002241 }
2242 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002243 runtime_->GetClassLinker()->FixupDexCaches(runtime_->GetResolutionMethod());
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002244
2245 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2246 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002247 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002248
Vladimir Marko307dac92015-10-20 11:20:09 +01002249 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002250
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002251 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2252 // Runtime::Start, give it away now so that we don't starve GC.
2253 Thread* self = Thread::Current();
2254 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002255
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002256 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002257 }
2258
Jeff Haodcdc85b2015-12-04 14:06:18 -08002259 // 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 -08002260 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002261 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002262 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002263 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002264 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002265 image_filenames_.push_back(app_image_file_name_.c_str());
2266 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002267 if (!image_writer_->Write(app_image_fd_,
2268 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002269 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002270 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002271 return false;
2272 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002273
Jeff Haodcdc85b2015-12-04 14:06:18 -08002274 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002275 dchecked_vector<uintptr_t> oat_data_begins;
2276 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2277 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002278 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002279 // Destroy ImageWriter before doing FixupElf.
2280 image_writer_.reset();
2281
Vladimir Marko944da602016-02-19 12:27:55 +00002282 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2283 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002284 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2285 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2286 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2287 if (oat_file.get() == nullptr) {
2288 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2289 return false;
2290 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002291
Vladimir Marko944da602016-02-19 12:27:55 +00002292 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002293 oat_file->Erase();
2294 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2295 return false;
2296 }
2297
2298 if (oat_file->FlushCloseOrErase()) {
2299 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2300 return false;
2301 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002302 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002303 }
2304
2305 return true;
2306 }
2307
2308 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002309 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2310 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002311 std::function<std::string(const char*)> process = DotToDescriptor;
2312 return ReadCommentedInputFromFile(image_classes_filename, &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002313 }
2314
2315 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002316 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002317 const char* zip_filename,
2318 const char* image_classes_filename,
2319 std::string* error_msg) {
2320 std::function<std::string(const char*)> process = DotToDescriptor;
2321 return ReadCommentedInputFromZip(zip_filename, image_classes_filename, &process, error_msg);
2322 }
2323
2324 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2325 // the given function.
2326 static std::unordered_set<std::string>* ReadCommentedInputFromFile(
2327 const char* input_filename, std::function<std::string(const char*)>* process) {
2328 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2329 if (input_file.get() == nullptr) {
2330 LOG(ERROR) << "Failed to open input file " << input_filename;
2331 return nullptr;
2332 }
2333 std::unique_ptr<std::unordered_set<std::string>> result(
2334 ReadCommentedInputStream(*input_file, process));
2335 input_file->close();
2336 return result.release();
2337 }
2338
2339 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2340 // Post-process each line with the given function.
2341 static std::unordered_set<std::string>* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002342 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002343 const char* input_filename,
2344 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002345 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002346 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2347 if (zip_archive.get() == nullptr) {
2348 return nullptr;
2349 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002350 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002351 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002352 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002353 zip_filename, error_msg->c_str());
2354 return nullptr;
2355 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002356 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2357 input_filename,
2358 error_msg));
2359 if (input_file.get() == nullptr) {
2360 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002361 zip_filename, error_msg->c_str());
2362 return nullptr;
2363 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002364 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2365 input_file->Size());
2366 std::istringstream input_stream(input_string);
2367 return ReadCommentedInputStream(input_stream, process);
2368 }
2369
2370 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2371 // with the given function.
2372 static std::unordered_set<std::string>* ReadCommentedInputStream(
2373 std::istream& in_stream,
2374 std::function<std::string(const char*)>* process) {
2375 std::unique_ptr<std::unordered_set<std::string>> image_classes(
2376 new std::unordered_set<std::string>);
2377 while (in_stream.good()) {
2378 std::string dot;
2379 std::getline(in_stream, dot);
2380 if (StartsWith(dot, "#") || dot.empty()) {
2381 continue;
2382 }
2383 if (process != nullptr) {
2384 std::string descriptor((*process)(dot.c_str()));
2385 image_classes->insert(descriptor);
2386 } else {
2387 image_classes->insert(dot);
2388 }
2389 }
2390 return image_classes.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002391 }
2392
Mathieu Chartier49285c52014-12-02 15:43:48 -08002393 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002394 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2395 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002396 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002397 LOG(INFO) << "dex2oat took " << PrettyDuration(NanoTime() - start_ns_)
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002398 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002399 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002400 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2401 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002402 }
2403
Jeff Haodcdc85b2015-12-04 14:06:18 -08002404 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2405 std::string res(image_filename);
2406 size_t last_slash = res.rfind('/');
2407 if (last_slash == std::string::npos || last_slash == 0) {
2408 return res;
2409 }
2410 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2411 if (penultimate_slash == std::string::npos) {
2412 return res;
2413 }
2414 // Check that the string in-between is the expected one.
2415 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2416 GetInstructionSetString(isa)) {
2417 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2418 return res;
2419 }
2420 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2421 }
2422
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002423 std::unique_ptr<CompilerOptions> compiler_options_;
2424 Compiler::Kind compiler_kind_;
2425
2426 InstructionSet instruction_set_;
2427 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2428
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002429 uint32_t image_file_location_oat_checksum_;
2430 uintptr_t image_file_location_oat_data_begin_;
2431 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002432 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2433
Vladimir Marko307dac92015-10-20 11:20:09 +01002434 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002435
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002436 DexFileToMethodInlinerMap method_inliner_map_;
2437 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2438
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002439 std::unique_ptr<Runtime> runtime_;
2440
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002441 // Ownership for the class path files.
2442 std::vector<std::unique_ptr<const DexFile>> class_path_files_;
2443
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002444 size_t thread_count_;
2445 uint64_t start_ns_;
2446 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002447 std::vector<std::unique_ptr<File>> oat_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002448 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002449 std::vector<const char*> oat_filenames_;
2450 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002451 int oat_fd_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002452 std::vector<const char*> dex_filenames_;
2453 std::vector<const char*> dex_locations_;
2454 int zip_fd_;
2455 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002456 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002457 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002458 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002459 uintptr_t image_base_;
2460 const char* image_classes_zip_filename_;
2461 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002462 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002463 const char* compiled_classes_zip_filename_;
2464 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002465 const char* compiled_methods_zip_filename_;
2466 const char* compiled_methods_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002467 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2468 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002469 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002470 bool app_image_;
2471 bool boot_image_;
Jeff Hao436183f2016-01-12 16:36:50 -08002472 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002473 bool is_host_;
2474 std::string android_root_;
Mathieu Chartier8d26c592016-05-25 15:05:59 -07002475 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002476 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002477 std::string no_inline_from_string_;
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002478 std::vector<jobject> dex_caches_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002479 jobject class_loader_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002480
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002481 std::vector<std::unique_ptr<ElfWriter>> elf_writers_;
2482 std::vector<std::unique_ptr<OatWriter>> oat_writers_;
2483 std::vector<OutputStream*> rodata_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002484 std::unique_ptr<ImageWriter> image_writer_;
2485 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002486
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002487 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
Jeff Hao5872d7c2016-04-27 11:07:41 -07002488 std::vector<std::unique_ptr<OatFile>> opened_oat_files_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002489 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2490
Vladimir Marko47496c22016-01-27 16:15:08 +00002491 std::vector<const DexFile*> no_inline_from_dex_files_;
2492
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002493 std::vector<std::string> verbose_methods_;
2494 bool dump_stats_;
2495 bool dump_passes_;
2496 bool dump_timing_;
2497 bool dump_slow_timing_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002498 std::string swap_file_name_;
2499 int swap_fd_;
Andreas Gampe25a9abe2016-06-24 14:55:38 -07002500 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2501 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe338a1d22016-06-24 21:05:23 -07002502 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002503 std::string app_image_file_name_;
2504 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002505 std::string profile_file_;
2506 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002507 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002508 TimingLogger* timings_;
2509 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002510 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002511 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002512
2513 // Backing storage.
2514 std::vector<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002515
Andreas Gampeace0dc12016-01-20 13:33:13 -08002516 // See CompilerOptions.force_determinism_.
2517 bool force_determinism_;
2518
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002519 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2520};
2521
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002522static void b13564922() {
2523#if defined(__linux__) && defined(__arm__)
2524 int major, minor;
2525 struct utsname uts;
2526 if (uname(&uts) != -1 &&
2527 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2528 ((major < 3) || ((major == 3) && (minor < 4)))) {
2529 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2530 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2531 int old_personality = personality(0xffffffff);
2532 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2533 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2534 if (new_personality == -1) {
2535 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2536 }
2537 }
2538 }
2539#endif
2540}
2541
Andreas Gampe10e477d2014-11-19 12:57:42 -08002542static int CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002543 dex2oat.LoadClassProfileDescriptors();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002544 dex2oat.Compile();
2545
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002546 if (!dex2oat.WriteOatFiles()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002547 dex2oat.EraseOatFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002548 return EXIT_FAILURE;
2549 }
2550
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002551 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2552 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2553 // image writer will require this fd to generate the image.
2554 if (dex2oat.ShouldKeepOatFileOpen()) {
2555 if (!dex2oat.FlushOatFiles()) {
2556 return EXIT_FAILURE;
2557 }
2558 } else if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002559 return EXIT_FAILURE;
2560 }
2561
Jeff Haodcdc85b2015-12-04 14:06:18 -08002562 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002563 if (!dex2oat.HandleImage()) {
2564 return EXIT_FAILURE;
2565 }
2566
2567 // When given --host, finish early without stripping.
2568 if (dex2oat.IsHost()) {
2569 dex2oat.DumpTiming();
2570 return EXIT_SUCCESS;
2571 }
2572
Jeff Haodcdc85b2015-12-04 14:06:18 -08002573 // Copy stripped to unstripped location, if necessary.
2574 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002575 return EXIT_FAILURE;
2576 }
2577
Jeff Haodcdc85b2015-12-04 14:06:18 -08002578 // FlushClose again, as stripping might have re-opened the oat files.
2579 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002580 return EXIT_FAILURE;
2581 }
2582
2583 dex2oat.DumpTiming();
2584 return EXIT_SUCCESS;
2585}
2586
2587static int CompileApp(Dex2Oat& dex2oat) {
2588 dex2oat.Compile();
2589
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002590 if (!dex2oat.WriteOatFiles()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002591 dex2oat.EraseOatFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002592 return EXIT_FAILURE;
2593 }
2594
Jeff Haodcdc85b2015-12-04 14:06:18 -08002595 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002596 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002597
2598 // When given --host, finish early without stripping.
2599 if (dex2oat.IsHost()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002600 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002601 return EXIT_FAILURE;
2602 }
2603
2604 dex2oat.DumpTiming();
2605 return EXIT_SUCCESS;
2606 }
2607
Jeff Haodcdc85b2015-12-04 14:06:18 -08002608 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2609 // stripped versions. If this is given, we expect to be able to open writable files by name.
2610 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002611 return EXIT_FAILURE;
2612 }
2613
Jeff Haodcdc85b2015-12-04 14:06:18 -08002614 // Flush and close the files.
2615 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002616 return EXIT_FAILURE;
2617 }
2618
2619 dex2oat.DumpTiming();
2620 return EXIT_SUCCESS;
2621}
2622
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002623static int dex2oat(int argc, char** argv) {
2624 b13564922();
2625
2626 TimingLogger timings("compiler", false, false);
2627
Roland Levillain5c7e2602016-02-23 18:08:53 +00002628 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
2629 // might produce a stack frame too large for this function or for
2630 // functions inlining it (such as main), that would not fit the
2631 // requirements of the `-Wframe-larger-than` option.
2632 std::unique_ptr<Dex2Oat> dex2oat = MakeUnique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002633
2634 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002635 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002636
Calin Juravleb077e152016-02-18 18:47:37 +00002637 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02002638 // This operation involves I/O.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002639 if (dex2oat->UseProfileGuidedCompilation()) {
Calin Juravleb077e152016-02-18 18:47:37 +00002640 if (!dex2oat->LoadProfile()) {
2641 LOG(ERROR) << "Failed to process profile file";
Calin Juravle998c2162015-12-21 15:39:33 +02002642 return EXIT_FAILURE;
2643 }
2644 }
2645
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002646 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00002647 if (!dex2oat->OpenFile()) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002648 return EXIT_FAILURE;
2649 }
2650
Andreas Gampe046c7062015-05-18 23:22:54 -07002651 // Print the complete line when any of the following is true:
2652 // 1) Debug build
2653 // 2) Compiling an image
2654 // 3) Compiling with --host
2655 // 4) Compiling on the host (not a target build)
2656 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002657 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07002658 LOG(INFO) << CommandLine();
2659 } else {
2660 LOG(INFO) << StrippedCommandLine();
2661 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002662
Roland Levillain5c7e2602016-02-23 18:08:53 +00002663 if (!dex2oat->Setup()) {
2664 dex2oat->EraseOatFiles();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002665 return EXIT_FAILURE;
2666 }
2667
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002668 bool result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00002669 if (dex2oat->IsImage()) {
2670 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002671 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00002672 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002673 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002674
Roland Levillain5c7e2602016-02-23 18:08:53 +00002675 dex2oat->Shutdown();
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002676 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002677}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002678} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07002679
2680int main(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002681 int result = art::dex2oat(argc, argv);
2682 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
2683 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
2684 // should not destruct the runtime in this case.
Evgenii Stepanov1e133742015-05-20 12:30:59 -07002685 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002686 exit(result);
2687 }
2688 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002689}