blob: 3db85c1842be0fc3b4e507385ff0ed6ce34c05fe [file] [log] [blame]
Brian Carlstrom7940e442013-07-12 13:46:57 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Andreas Gamped687e372015-04-28 23:16:03 -070017#include <inttypes.h>
Brian Carlstrom7940e442013-07-12 13:46:57 -070018#include <stdio.h>
19#include <stdlib.h>
20#include <sys/stat.h>
Evgenii Stepanov1e133742015-05-20 12:30:59 -070021#include "base/memory_tool.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070022
23#include <fstream>
24#include <iostream>
25#include <sstream>
26#include <string>
Andreas Gampeb1fcead2015-04-20 18:53:51 -070027#include <unordered_set>
Brian Carlstrom7940e442013-07-12 13:46:57 -070028#include <vector>
29
Vladimir Markof94b7812014-06-05 15:48:04 +010030#if defined(__linux__) && defined(__arm__)
31#include <sys/personality.h>
32#include <sys/utsname.h>
33#endif
34
Ian Rogersd582fa42014-11-05 23:46:43 -080035#include "arch/instruction_set_features.h"
Andreas Gampec5a3ea72015-01-13 16:41:53 -080036#include "arch/mips/instruction_set_features_mips.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000037#include "art_method-inl.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070038#include "base/dumpable.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080039#include "base/macros.h"
Calin Juravle2e2db782016-02-23 12:00:03 +000040#include "base/scoped_flock.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070041#include "base/stl_util.h"
42#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010043#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070044#include "base/timing_logger.h"
45#include "base/unix_file/fd_file.h"
46#include "class_linker.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000047#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000048#include "compiler_callbacks.h"
David Srbecky09c2a6b2016-03-11 17:11:44 +000049#include "debug/elf_debug_writer.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000050#include "debug/method_debug_info.h"
Ian Rogerse63db272014-07-15 15:36:11 -070051#include "dex/quick/dex_file_to_method_inliner_map.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000052#include "dex/quick_compiler_callbacks.h"
53#include "dex/verification_results.h"
54#include "dex_file-inl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070055#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080056#include "driver/compiler_options.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080057#include "elf_file.h"
Tong Shen62d1ca32014-09-03 17:24:56 -070058#include "elf_writer.h"
Vladimir Marko10c13562015-11-25 14:33:36 +000059#include "elf_writer_quick.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070060#include "gc/space/image_space.h"
61#include "gc/space/space-inl.h"
62#include "image_writer.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070063#include "interpreter/unstarted_runtime.h"
Calin Juravle998c2162015-12-21 15:39:33 +020064#include "jit/offline_profiling_info.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070065#include "leb128.h"
Vladimir Marko944da602016-02-19 12:27:55 +000066#include "linker/multi_oat_relative_patcher.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070067#include "mirror/class-inl.h"
68#include "mirror/class_loader.h"
69#include "mirror/object-inl.h"
70#include "mirror/object_array-inl.h"
Jeff Haob11ffb72016-04-07 15:40:54 -070071#include "oat_file_assistant.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070072#include "oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070073#include "os.h"
74#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000075#include "runtime_options.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070076#include "ScopedLocalRef.h"
77#include "scoped_thread_state_change.h"
Alex Light53cb16b2014-06-12 11:26:29 -070078#include "utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070079#include "well_known_classes.h"
80#include "zip_archive.h"
81
82namespace art {
83
Brian Carlstrom6449c622014-02-10 23:48:36 -080084static int original_argc;
85static char** original_argv;
86
87static std::string CommandLine() {
88 std::vector<std::string> command;
89 for (int i = 0; i < original_argc; ++i) {
90 command.push_back(original_argv[i]);
91 }
92 return Join(command, ' ');
93}
94
Andreas Gampe046c7062015-05-18 23:22:54 -070095// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
96// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
97// locations are all staged).
98static std::string StrippedCommandLine() {
99 std::vector<std::string> command;
100
101 // Do a pre-pass to look for zip-fd.
102 bool saw_zip_fd = false;
103 for (int i = 0; i < original_argc; ++i) {
104 if (StartsWith(original_argv[i], "--zip-fd=")) {
105 saw_zip_fd = true;
106 break;
107 }
108 }
109
110 // Now filter out things.
111 for (int i = 0; i < original_argc; ++i) {
112 // All runtime-arg parameters are dropped.
113 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
114 i++; // Drop the next part, too.
115 continue;
116 }
117
118 // Any instruction-setXXX is dropped.
119 if (StartsWith(original_argv[i], "--instruction-set")) {
120 continue;
121 }
122
123 // The boot image is dropped.
124 if (StartsWith(original_argv[i], "--boot-image=")) {
125 continue;
126 }
127
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800128 // The image format is dropped.
129 if (StartsWith(original_argv[i], "--image-format=")) {
130 continue;
131 }
132
Andreas Gampe046c7062015-05-18 23:22:54 -0700133 // This should leave any dex-file and oat-file options, describing what we compiled.
134
135 // However, we prefer to drop this when we saw --zip-fd.
136 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700137 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe046c7062015-05-18 23:22:54 -0700138 if (StartsWith(original_argv[i], "--zip-") ||
139 StartsWith(original_argv[i], "--dex-") ||
140 StartsWith(original_argv[i], "--oat-") ||
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700141 StartsWith(original_argv[i], "--swap-") ||
142 StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700143 continue;
144 }
145 }
146
147 command.push_back(original_argv[i]);
148 }
149
150 // Construct the final output.
151 if (command.size() <= 1U) {
152 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
153 return "Starting dex2oat.";
154 }
155 return Join(command, ' ');
156}
157
Brian Carlstrom7940e442013-07-12 13:46:57 -0700158static void UsageErrorV(const char* fmt, va_list ap) {
159 std::string error;
160 StringAppendV(&error, fmt, ap);
161 LOG(ERROR) << error;
162}
163
164static void UsageError(const char* fmt, ...) {
165 va_list ap;
166 va_start(ap, fmt);
167 UsageErrorV(fmt, ap);
168 va_end(ap);
169}
170
Andreas Gampe794ad762015-02-23 08:12:24 -0800171NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700172 va_list ap;
173 va_start(ap, fmt);
174 UsageErrorV(fmt, ap);
175 va_end(ap);
176
Brian Carlstrom6449c622014-02-10 23:48:36 -0800177 UsageError("Command: %s", CommandLine().c_str());
178
Brian Carlstrom7940e442013-07-12 13:46:57 -0700179 UsageError("Usage: dex2oat [options]...");
180 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100181 UsageError(" -j<number>: specifies the number of threads used for compilation.");
182 UsageError(" Default is the number of detected hardware threads available on the");
183 UsageError(" host system.");
184 UsageError(" Example: -j12");
185 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700186 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700187 UsageError(" Example: --dex-file=/system/framework/core.jar");
188 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700189 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
190 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
191 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
192 UsageError(" --dex-location=/system/framework/core.jar");
193 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700194 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
195 UsageError(" containing a classes.dex file to compile.");
196 UsageError(" Example: --zip-fd=5");
197 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700198 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
199 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700200 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
201 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800202 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700203 UsageError(" Example: --oat-file=/system/framework/boot.oat");
204 UsageError("");
205 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900206 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700207 UsageError("");
208 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
209 UsageError(" to the file descriptor specified by --oat-fd.");
210 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
211 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800212 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700213 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
214 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800215 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700216 UsageError(" Example: --image=/system/framework/boot.art");
217 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800218 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800219 UsageError(" Which format to store the image.");
220 UsageError(" Example: --image-format=lz4");
221 UsageError(" Default: uncompressed");
222 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700223 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
224 UsageError(" Example: --image=frameworks/base/preloaded-classes");
225 UsageError("");
226 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
227 UsageError(" Example: --base=0x50000000");
228 UsageError("");
229 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000230 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700231 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000232 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000233 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700234 UsageError("");
235 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
236 UsageError(" Example: --android-root=out/host/linux-x86");
237 UsageError(" Default: $ANDROID_ROOT");
238 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800239 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700240 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700241 UsageError(" Example: --instruction-set=x86");
242 UsageError(" Default: arm");
243 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700244 UsageError(" --instruction-set-features=...,: Specify instruction set features");
245 UsageError(" Example: --instruction-set-features=div");
246 UsageError(" Default: default");
247 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700248 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
249 UsageError(" Default: disabled");
250 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800251 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700252 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800253 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100254 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700255 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100256 UsageError(" --compiler-filter="
257 "(verify-none"
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700258 "|verify-at-runtime"
Mathieu Chartiera8077802016-03-16 19:08:31 -0700259 "|verify-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100260 "|interpret-only"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000261 "|time"
262 "|space-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100263 "|space"
264 "|balanced"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000265 "|speed-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100266 "|speed"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000267 "|everything-profile"
268 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700269 UsageError(" select compiler filter.");
Mathieu Chartiera8077802016-03-16 19:08:31 -0700270 UsageError(" verify-profile requires a --profile(-fd) to also be passed in.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800271 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800272 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800273 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800274 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
275 UsageError(" method for compiler filter tuning.");
276 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
277 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
278 UsageError("");
279 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
280 UsageError(" method for compiler filter tuning.");
281 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
282 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
283 UsageError("");
284 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
285 UsageError(" method for compiler filter tuning.");
286 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
287 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
288 UsageError("");
289 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
290 UsageError(" method for compiler filter tuning.");
291 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
292 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
293 UsageError("");
294 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
295 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700296 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
297 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800298 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
299 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
300 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100301 UsageError(" --inline-depth-limit=<depth-limit>: the depth limit of inlining for fine tuning");
302 UsageError(" the compiler. A zero value will disable inlining. Honored only by Optimizing.");
Roland Levillaina215b952015-08-07 11:38:32 +0100303 UsageError(" Has priority over the --compiler-filter option. Intended for ");
304 UsageError(" development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100305 UsageError(" Example: --inline-depth-limit=%d", CompilerOptions::kDefaultInlineDepthLimit);
306 UsageError(" Default: %d", CompilerOptions::kDefaultInlineDepthLimit);
307 UsageError("");
308 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
309 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100310 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
311 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100312 UsageError(" Example: --inline-max-code-units=%d",
313 CompilerOptions::kDefaultInlineMaxCodeUnits);
314 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
315 UsageError("");
Ian Rogers46398602013-08-20 07:50:36 -0700316 UsageError(" --dump-timing: display a breakdown of where time was spent");
317 UsageError("");
Alex Light53cb16b2014-06-12 11:26:29 -0700318 UsageError(" --include-patch-information: Include patching information so the generated code");
319 UsageError(" can have its base address moved without full recompilation.");
320 UsageError("");
321 UsageError(" --no-include-patch-information: Do not include patching information.");
322 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100323 UsageError(" -g");
324 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
325 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000326 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000327 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700328 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100329 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100330 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000331 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
332 UsageError(" debug information necessary to print backtraces. (disabled by default)");
333 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000334 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000335 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000336 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000337 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700338 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
339 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
340 UsageError(" Use a separate --runtime-arg switch for each argument.");
341 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700342 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000343 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700344 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000345 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
346 UsageError(" Cannot be used together with --profile-file.");
347 UsageError("");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800348 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
349 UsageError(" Example: --swap-file=/data/tmp/swap.001");
350 UsageError("");
351 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
352 UsageError(" Example: --swap-fd=10");
353 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700354 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
355 UsageError(" Example: --app-image-fd=10");
356 UsageError("");
357 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
358 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
359 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800360 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
361 "input dex file.");
362 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000363 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
364 UsageError(" This option is incompatible with read barriers (e.g., if dex2oat has been");
365 UsageError(" built with the environment variable `ART_USE_READ_BARRIER` set to `true`).");
366 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700367 std::cerr << "See log for usage error information\n";
368 exit(EXIT_FAILURE);
369}
370
Brian Carlstrom7940e442013-07-12 13:46:57 -0700371// The primary goal of the watchdog is to prevent stuck build servers
372// during development when fatal aborts lead to a cascade of failures
373// that result in a deadlock.
374class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800375// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700376#undef CHECK_PTHREAD_CALL
377#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
378 do { \
379 int rc = call args; \
380 if (rc != 0) { \
381 errno = rc; \
382 std::string message(# call); \
383 message += " failed for "; \
384 message += reason; \
385 Fatal(message); \
386 } \
387 } while (false)
388
389 public:
Brian Carlstrom93ba8932013-07-17 21:31:49 -0700390 explicit WatchDog(bool is_watch_dog_enabled) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700391 is_watch_dog_enabled_ = is_watch_dog_enabled;
392 if (!is_watch_dog_enabled_) {
393 return;
394 }
395 shutting_down_ = false;
396 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700397 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
398 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700399 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
400 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
401 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
402 }
403 ~WatchDog() {
404 if (!is_watch_dog_enabled_) {
405 return;
406 }
407 const char* reason = "dex2oat watch dog thread shutdown";
408 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
409 shutting_down_ = true;
410 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
411 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
412
Kenny Root51316382014-05-13 14:59:37 -0700413 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700414
415 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
416 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
417 }
418
419 private:
420 static void* CallBack(void* arg) {
421 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
422 ::art::SetThreadName("dex2oat watch dog");
423 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700424 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700425 }
426
Andreas Gampe794ad762015-02-23 08:12:24 -0800427 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700428 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
429 // it's rather easy to hang in unwinding.
430 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
431 // logcat logging or stderr output.
432 LogMessage::LogLine(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700433 exit(1);
434 }
435
436 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700437 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
438 // large.
Andreas Gamped687e372015-04-28 23:16:03 -0700439 constexpr int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700440 timespec timeout_ts;
441 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts);
442 const char* reason = "dex2oat watch dog thread waiting";
443 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
444 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800445 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700446 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700447 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
448 kWatchDogTimeoutSeconds));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700449 } else if (rc != 0) {
450 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
451 strerror(errno)));
452 Fatal(message.c_str());
453 }
454 }
455 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
456 }
457
458 // 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 -0700459 // Debug builds are slower so they have larger timeouts.
Andreas Gamped687e372015-04-28 23:16:03 -0700460 static constexpr int64_t kSlowdownFactor = kIsDebugBuild ? 5U : 1U;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800461
Andreas Gampe540138a2015-09-14 15:34:38 -0700462 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
463 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
464 // itself before that watchdog would take down the system server.
465 static constexpr int64_t kWatchDogTimeoutSeconds = kSlowdownFactor * (9 * 60 + 30);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700466
467 bool is_watch_dog_enabled_;
468 bool shutting_down_;
469 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
470 pthread_mutex_t mutex_;
471 pthread_cond_t cond_;
472 pthread_attr_t attr_;
473 pthread_t pthread_;
474};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700475
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800476static constexpr size_t kMinDexFilesForSwap = 2;
477static constexpr size_t kMinDexFileCumulativeSizeForSwap = 20 * MB;
478
479static bool UseSwap(bool is_image, std::vector<const DexFile*>& dex_files) {
480 if (is_image) {
481 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
482 return false;
483 }
484 if (dex_files.size() < kMinDexFilesForSwap) {
485 // If there are less dex files than the threshold, assume it's gonna be fine.
486 return false;
487 }
488 size_t dex_files_size = 0;
489 for (const auto* dex_file : dex_files) {
490 dex_files_size += dex_file->GetHeader().file_size_;
491 }
492 return dex_files_size >= kMinDexFileCumulativeSizeForSwap;
493}
494
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800495class Dex2Oat FINAL {
496 public:
497 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100498 compiler_kind_(Compiler::kOptimizing),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800499 instruction_set_(kRuntimeISA),
500 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000501 image_file_location_oat_checksum_(0),
502 image_file_location_oat_data_begin_(0),
503 image_patch_delta_(0),
504 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700505 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800506 method_inliner_map_(),
507 runtime_(nullptr),
508 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
509 start_ns_(NanoTime()),
510 oat_fd_(-1),
511 zip_fd_(-1),
512 image_base_(0U),
513 image_classes_zip_filename_(nullptr),
514 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800515 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800516 compiled_classes_zip_filename_(nullptr),
517 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700518 compiled_methods_zip_filename_(nullptr),
519 compiled_methods_filename_(nullptr),
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700520 app_image_(false),
521 boot_image_(false),
Jeff Hao436183f2016-01-12 16:36:50 -0800522 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800523 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000524 class_loader_(nullptr),
525 elf_writers_(),
526 oat_writers_(),
527 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000528 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700529 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000530 opened_dex_files_maps_(),
531 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000532 no_inline_from_dex_files_(),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800533 dump_stats_(false),
534 dump_passes_(false),
535 dump_timing_(false),
536 dump_slow_timing_(kIsDebugBuild),
Calin Juravle2e2db782016-02-23 12:00:03 +0000537 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800538 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000539 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800540 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000541 force_determinism_(false)
542 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800543
544 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800545 // Log completion time before deleting the runtime_, because this accesses
546 // the runtime.
547 LogCompletionTime();
548
Vladimir Marko307dac92015-10-20 11:20:09 +0100549 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
550 // We want to just exit on non-debug builds, not bringing the runtime down
551 // in an orderly fashion. So release the following fields.
552 driver_.release();
553 image_writer_.release();
554 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
555 dex_file.release();
556 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000557 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
558 map.release();
559 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800560 for (std::unique_ptr<File>& oat_file : oat_files_) {
561 oat_file.release();
562 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100563 runtime_.release();
564 verification_results_.release();
565 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100566 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700567 }
568
Roland Levillain9ec5e222015-08-17 20:18:41 +0100569 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800570 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800571 std::string boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800572 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000573 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800574 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100575 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800576
Roland Levillain9ec5e222015-08-17 20:18:41 +0100577 void ParseZipFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000578 ParseUintOption(option, "--zip-fd", &zip_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100579 }
580
581 void ParseOatFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000582 ParseUintOption(option, "--oat-fd", &oat_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100583 }
584
Calin Juravle877fd962016-01-05 14:29:29 +0000585 void ParseFdForCollection(const StringPiece& option,
586 const char* arg_name,
587 std::vector<uint32_t>* fds) {
588 uint32_t fd;
589 ParseUintOption(option, arg_name, &fd, Usage);
590 fds->push_back(fd);
591 }
592
Roland Levillain9ec5e222015-08-17 20:18:41 +0100593 void ParseJ(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000594 ParseUintOption(option, "-j", &thread_count_, Usage, /* is_long_option */ false);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100595 }
596
597 void ParseBase(const StringPiece& option) {
598 DCHECK(option.starts_with("--base="));
599 const char* image_base_str = option.substr(strlen("--base=")).data();
600 char* end;
601 image_base_ = strtoul(image_base_str, &end, 16);
602 if (end == image_base_str || *end != '\0') {
603 Usage("Failed to parse hexadecimal value for option %s", option.data());
604 }
605 }
606
607 void ParseInstructionSet(const StringPiece& option) {
608 DCHECK(option.starts_with("--instruction-set="));
609 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
610 // StringPiece is not necessarily zero-terminated, so need to make a copy and ensure it.
611 std::unique_ptr<char[]> buf(new char[instruction_set_str.length() + 1]);
612 strncpy(buf.get(), instruction_set_str.data(), instruction_set_str.length());
613 buf.get()[instruction_set_str.length()] = 0;
614 instruction_set_ = GetInstructionSetFromString(buf.get());
615 // arm actually means thumb2.
616 if (instruction_set_ == InstructionSet::kArm) {
617 instruction_set_ = InstructionSet::kThumb2;
618 }
619 }
620
621 void ParseInstructionSetVariant(const StringPiece& option, ParserOptions* parser_options) {
622 DCHECK(option.starts_with("--instruction-set-variant="));
623 StringPiece str = option.substr(strlen("--instruction-set-variant=")).data();
624 instruction_set_features_.reset(
625 InstructionSetFeatures::FromVariant(
626 instruction_set_, str.as_string(), &parser_options->error_msg));
627 if (instruction_set_features_.get() == nullptr) {
628 Usage("%s", parser_options->error_msg.c_str());
629 }
630 }
631
632 void ParseInstructionSetFeatures(const StringPiece& option, ParserOptions* parser_options) {
633 DCHECK(option.starts_with("--instruction-set-features="));
634 StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
635 if (instruction_set_features_.get() == nullptr) {
636 instruction_set_features_.reset(
637 InstructionSetFeatures::FromVariant(
638 instruction_set_, "default", &parser_options->error_msg));
639 if (instruction_set_features_.get() == nullptr) {
640 Usage("Problem initializing default instruction set features variant: %s",
641 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700642 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800643 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100644 instruction_set_features_.reset(
645 instruction_set_features_->AddFeaturesFromString(str.as_string(),
646 &parser_options->error_msg));
647 if (instruction_set_features_.get() == nullptr) {
648 Usage("Error parsing '%s': %s", option.data(), parser_options->error_msg.c_str());
649 }
650 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800651
Roland Levillain9ec5e222015-08-17 20:18:41 +0100652 void ParseCompilerBackend(const StringPiece& option, ParserOptions* parser_options) {
653 DCHECK(option.starts_with("--compiler-backend="));
654 parser_options->requested_specific_compiler = true;
655 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
656 if (backend_str == "Quick") {
657 compiler_kind_ = Compiler::kQuick;
658 } else if (backend_str == "Optimizing") {
659 compiler_kind_ = Compiler::kOptimizing;
660 } else {
661 Usage("Unknown compiler backend: %s", backend_str.data());
662 }
663 }
664
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800665 void ParseImageFormat(const StringPiece& option) {
666 const StringPiece substr("--image-format=");
667 DCHECK(option.starts_with(substr));
668 const StringPiece format_str = option.substr(substr.length());
669 if (format_str == "lz4") {
670 image_storage_mode_ = ImageHeader::kStorageModeLZ4;
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800671 } else if (format_str == "lz4hc") {
672 image_storage_mode_ = ImageHeader::kStorageModeLZ4HC;
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800673 } else if (format_str == "uncompressed") {
674 image_storage_mode_ = ImageHeader::kStorageModeUncompressed;
675 } else {
676 Usage("Unknown image format: %s", format_str.data());
677 }
678 }
679
Jeff Hao436183f2016-01-12 16:36:50 -0800680 void ProcessOptions(ParserOptions* parser_options) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800681 boot_image_ = !image_filenames_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700682 app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
683
684 if (IsAppImage() && IsBootImage()) {
685 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
686 }
687
Jeff Haodcdc85b2015-12-04 14:06:18 -0800688 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800689 Usage("Output must be supplied with either --oat-file or --oat-fd");
690 }
691
Jeff Haodcdc85b2015-12-04 14:06:18 -0800692 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800693 Usage("--oat-file should not be used with --oat-fd");
694 }
695
Roland Levillain9ec5e222015-08-17 20:18:41 +0100696 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800697 Usage("--oat-symbols should not be used with --oat-fd");
698 }
699
Roland Levillain9ec5e222015-08-17 20:18:41 +0100700 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800701 Usage("--oat-symbols should not be used with --host");
702 }
703
Jeff Haodcdc85b2015-12-04 14:06:18 -0800704 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800705 Usage("--oat-fd should not be used with --image");
706 }
707
Jeff Haodcdc85b2015-12-04 14:06:18 -0800708 if (!parser_options->oat_symbols.empty() &&
709 parser_options->oat_symbols.size() != oat_filenames_.size()) {
710 Usage("--oat-file arguments do not match --oat-symbols arguments");
711 }
712
713 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
714 Usage("--oat-file arguments do not match --image arguments");
715 }
716
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800717 if (android_root_.empty()) {
718 const char* android_root_env_var = getenv("ANDROID_ROOT");
719 if (android_root_env_var == nullptr) {
720 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700721 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800722 android_root_ += android_root_env_var;
723 }
724
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700725 if (!boot_image_ && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100726 parser_options->boot_image_filename += android_root_;
727 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800728 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100729 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000730 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800731 }
732
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700733 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800734 Usage("--image-classes should only be used with --image");
735 }
736
Vladimir Marko49b0f452015-12-10 13:49:19 +0000737 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800738 Usage("--image-classes should not be used with --boot-image");
739 }
740
741 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
742 Usage("--image-classes-zip should be used with --image-classes");
743 }
744
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700745 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800746 Usage("--compiled-classes should only be used with --image");
747 }
748
Vladimir Marko49b0f452015-12-10 13:49:19 +0000749 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800750 Usage("--compiled-classes should not be used with --boot-image");
751 }
752
753 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
754 Usage("--compiled-classes-zip should be used with --compiled-classes");
755 }
756
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800757 if (dex_filenames_.empty() && zip_fd_ == -1) {
758 Usage("Input must be supplied with either --dex-file or --zip-fd");
759 }
760
761 if (!dex_filenames_.empty() && zip_fd_ != -1) {
762 Usage("--dex-file should not be used with --zip-fd");
763 }
764
765 if (!dex_filenames_.empty() && !zip_location_.empty()) {
766 Usage("--dex-file should not be used with --zip-location");
767 }
768
769 if (dex_locations_.empty()) {
770 for (const char* dex_file_name : dex_filenames_) {
771 dex_locations_.push_back(dex_file_name);
772 }
773 } else if (dex_locations_.size() != dex_filenames_.size()) {
774 Usage("--dex-location arguments do not match --dex-file arguments");
775 }
776
Jeff Haodcdc85b2015-12-04 14:06:18 -0800777 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
778 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
779 Usage("--oat-file arguments must be singular or match --dex-file arguments");
780 }
781 }
782
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800783 if (zip_fd_ != -1 && zip_location_.empty()) {
784 Usage("--zip-location should be supplied with --zip-fd");
785 }
786
Vladimir Marko49b0f452015-12-10 13:49:19 +0000787 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800788 if (image_base_ == 0) {
789 Usage("Non-zero --base not specified");
790 }
791 }
792
Mathieu Chartiera8077802016-03-16 19:08:31 -0700793 const bool have_profile_file = !profile_file_.empty();
794 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
795 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000796 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200797 }
798
Roland Levillain9ec5e222015-08-17 20:18:41 +0100799 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800800 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800801 }
802
803 // If no instruction set feature was given, use the default one for the target
804 // instruction set.
805 if (instruction_set_features_.get() == nullptr) {
806 instruction_set_features_.reset(
Roland Levillain9ec5e222015-08-17 20:18:41 +0100807 InstructionSetFeatures::FromVariant(
808 instruction_set_, "default", &parser_options->error_msg));
Ian Rogersd582fa42014-11-05 23:46:43 -0800809 if (instruction_set_features_.get() == nullptr) {
810 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100811 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800812 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800813 }
814
815 if (instruction_set_ == kRuntimeISA) {
816 std::unique_ptr<const InstructionSetFeatures> runtime_features(
817 InstructionSetFeatures::FromCppDefines());
818 if (!instruction_set_features_->Equals(runtime_features.get())) {
819 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
820 << *instruction_set_features_ << ") and those of dex2oat executable ("
821 << *runtime_features <<") for the command line:\n"
822 << CommandLine();
823 }
824 }
825
Roland Levillaina215b952015-08-07 11:38:32 +0100826 // It they are not set, use default values for inlining settings.
827 // TODO: We should rethink the compiler filter. We mostly save
828 // time here, which is orthogonal to space.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000829 if (compiler_options_->inline_depth_limit_ == CompilerOptions::kUnsetInlineDepthLimit) {
830 compiler_options_->inline_depth_limit_ =
Andreas Gampe29d38e72016-03-23 15:31:51 +0000831 (compiler_options_->compiler_filter_ == CompilerFilter::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100832 // Implementation of the space filter: limit inlining depth.
833 ? CompilerOptions::kSpaceFilterInlineDepthLimit
834 : CompilerOptions::kDefaultInlineDepthLimit;
835 }
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000836 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
837 compiler_options_->inline_max_code_units_ =
Andreas Gampe29d38e72016-03-23 15:31:51 +0000838 (compiler_options_->compiler_filter_ == CompilerFilter::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100839 // Implementation of the space filter: limit inlining max code units.
840 ? CompilerOptions::kSpaceFilterInlineMaxCodeUnits
841 : CompilerOptions::kDefaultInlineMaxCodeUnits;
842 }
843
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800844 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800845 // Set the compilation target's implicit checks options.
846 switch (instruction_set_) {
847 case kArm:
848 case kThumb2:
849 case kArm64:
850 case kX86:
851 case kX86_64:
Douglas Leung22bb5a22015-07-02 16:42:08 -0700852 case kMips:
853 case kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000854 compiler_options_->implicit_null_checks_ = true;
855 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800856 break;
857
858 default:
859 // Defaults are correct.
860 break;
861 }
862
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000863 compiler_options_->verbose_methods_ = verbose_methods_.empty() ? nullptr : &verbose_methods_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800864
Jeff Hao436183f2016-01-12 16:36:50 -0800865 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800866 Usage("--multi-image can only be used when creating boot images");
867 }
Jeff Hao436183f2016-01-12 16:36:50 -0800868 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800869 Usage("--multi-image cannot be used with multiple image names");
870 }
871
872 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
873 if (!kIsTargetBuild && IsBootImage()) {
874 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800875 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800876 }
877 }
878
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800879 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100880 if (parser_options->watch_dog_enabled) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800881 watchdog_.reset(new WatchDog(true));
882 }
883
884 // Fill some values into the key-value store for the oat header.
885 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800886
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800887 // Automatically force determinism for the boot image in a host build if the default GC is CMS
888 // or MS and read barriers are not enabled, as the former switches the GC to a non-concurrent
889 // one by passing the option `-Xgc:nonconcurrent` (see below).
890 if (!kIsTargetBuild && IsBootImage()) {
891 if (SupportsDeterministicCompilation()) {
892 force_determinism_ = true;
893 } else {
894 LOG(WARNING) << "Deterministic compilation is disabled.";
895 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800896 }
897 compiler_options_->force_determinism_ = force_determinism_;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100898 }
899
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800900 static bool SupportsDeterministicCompilation() {
901 return (gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
902 gc::kCollectorTypeDefault == gc::kCollectorTypeMS) &&
903 !kEmitCompilerReadBarrier;
904 }
905
Jeff Hao436183f2016-01-12 16:36:50 -0800906 void ExpandOatAndImageFilenames() {
907 std::string base_oat = oat_filenames_[0];
908 size_t last_oat_slash = base_oat.rfind('/');
909 if (last_oat_slash == std::string::npos) {
910 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
911 }
912 // We also need to honor path components that were encoded through '@'. Otherwise the loading
913 // code won't be able to find the images.
914 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
915 last_oat_slash = base_oat.rfind('@');
916 }
917 base_oat = base_oat.substr(0, last_oat_slash + 1);
918
919 std::string base_img = image_filenames_[0];
920 size_t last_img_slash = base_img.rfind('/');
921 if (last_img_slash == std::string::npos) {
922 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
923 }
924 // We also need to honor path components that were encoded through '@'. Otherwise the loading
925 // code won't be able to find the images.
926 if (base_img.find('@', last_img_slash) != std::string::npos) {
927 last_img_slash = base_img.rfind('@');
928 }
929
930 // Get the prefix, which is the primary image name (without path components). Strip the
931 // extension.
932 std::string prefix = base_img.substr(last_img_slash + 1);
933 if (prefix.rfind('.') != std::string::npos) {
934 prefix = prefix.substr(0, prefix.rfind('.'));
935 }
936 if (!prefix.empty()) {
937 prefix = prefix + "-";
938 }
939
940 base_img = base_img.substr(0, last_img_slash + 1);
941
942 // Note: we have some special case here for our testing. We have to inject the differentiating
943 // parts for the different core images.
944 std::string infix; // Empty infix by default.
945 {
946 // Check the first name.
947 std::string dex_file = oat_filenames_[0];
948 size_t last_dex_slash = dex_file.rfind('/');
949 if (last_dex_slash != std::string::npos) {
950 dex_file = dex_file.substr(last_dex_slash + 1);
951 }
952 size_t last_dex_dot = dex_file.rfind('.');
953 if (last_dex_dot != std::string::npos) {
954 dex_file = dex_file.substr(0, last_dex_dot);
955 }
956 if (StartsWith(dex_file, "core-")) {
957 infix = dex_file.substr(strlen("core"));
958 }
959 }
960
961 // Now create the other names. Use a counted loop to skip the first one.
962 for (size_t i = 1; i < dex_locations_.size(); ++i) {
963 // TODO: Make everything properly std::string.
964 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
965 char_backing_storage_.push_back(base_img + image_name);
966 image_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
967
968 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
969 char_backing_storage_.push_back(base_oat + oat_name);
970 oat_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
971 }
972 }
973
Andreas Gampe8994a042015-12-30 19:03:17 +0000974 // Modify the input string in the following way:
975 // 0) Assume input is /a/b/c.d
976 // 1) Strip the path -> c.d
977 // 2) Inject prefix p -> pc.d
978 // 3) Inject infix i -> pci.d
979 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -0800980 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +0000981 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -0800982 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +0000983 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800984 size_t last_dex_slash = in.rfind('/');
985 if (last_dex_slash != std::string::npos) {
986 in = in.substr(last_dex_slash + 1);
987 }
Andreas Gampe8994a042015-12-30 19:03:17 +0000988 if (!prefix.empty()) {
989 in = prefix + in;
990 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800991 if (!infix.empty()) {
992 // Inject infix.
993 size_t last_dot = in.rfind('.');
994 if (last_dot != std::string::npos) {
995 in.insert(last_dot, infix);
996 }
997 }
998 if (EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +0000999 in = in.substr(0, in.length() - strlen(".jar")) +
1000 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001001 }
1002 return in;
1003 }
1004
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001005 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001006 std::ostringstream oss;
1007 for (int i = 0; i < argc; ++i) {
1008 if (i > 0) {
1009 oss << ' ';
1010 }
1011 oss << argv[i];
1012 }
1013 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1014 oss.str(""); // Reset.
1015 oss << kRuntimeISA;
1016 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1017 key_value_store_->Put(
1018 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001019 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001020 key_value_store_->Put(
1021 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001022 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001023 key_value_store_->Put(
1024 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001025 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001026 key_value_store_->Put(OatHeader::kCompilerFilter,
1027 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Richard Uhlerd1537b52016-03-29 13:27:41 -07001028 key_value_store_->Put(OatHeader::kHasPatchInfoKey,
1029 compiler_options_->GetIncludePatchInformation() ? OatHeader::kTrueValue
1030 : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001031 }
1032
1033 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1034 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1035 // returns, arguments have been successfully parsed.
1036 void ParseArgs(int argc, char** argv) {
1037 original_argc = argc;
1038 original_argv = argv;
1039
1040 InitLogging(argv);
1041
1042 // Skip over argv[0].
1043 argv++;
1044 argc--;
1045
1046 if (argc == 0) {
1047 Usage("No arguments specified");
1048 }
1049
1050 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001051 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001052
1053 for (int i = 0; i < argc; i++) {
1054 const StringPiece option(argv[i]);
1055 const bool log_options = false;
1056 if (log_options) {
1057 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1058 }
1059 if (option.starts_with("--dex-file=")) {
1060 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data());
1061 } else if (option.starts_with("--dex-location=")) {
1062 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data());
1063 } else if (option.starts_with("--zip-fd=")) {
1064 ParseZipFd(option);
1065 } else if (option.starts_with("--zip-location=")) {
1066 zip_location_ = option.substr(strlen("--zip-location=")).data();
1067 } else if (option.starts_with("--oat-file=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001068 oat_filenames_.push_back(option.substr(strlen("--oat-file=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001069 } else if (option.starts_with("--oat-symbols=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001070 parser_options->oat_symbols.push_back(option.substr(strlen("--oat-symbols=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001071 } else if (option.starts_with("--oat-fd=")) {
1072 ParseOatFd(option);
1073 } else if (option == "--watch-dog") {
1074 parser_options->watch_dog_enabled = true;
1075 } else if (option == "--no-watch-dog") {
1076 parser_options->watch_dog_enabled = false;
1077 } else if (option.starts_with("-j")) {
1078 ParseJ(option);
1079 } else if (option.starts_with("--oat-location=")) {
1080 oat_location_ = option.substr(strlen("--oat-location=")).data();
1081 } else if (option.starts_with("--image=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001082 image_filenames_.push_back(option.substr(strlen("--image=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001083 } else if (option.starts_with("--image-classes=")) {
1084 image_classes_filename_ = option.substr(strlen("--image-classes=")).data();
1085 } else if (option.starts_with("--image-classes-zip=")) {
1086 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data();
Mathieu Chartierceb07b32015-12-10 09:33:21 -08001087 } else if (option.starts_with("--image-format=")) {
1088 ParseImageFormat(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001089 } else if (option.starts_with("--compiled-classes=")) {
1090 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data();
1091 } else if (option.starts_with("--compiled-classes-zip=")) {
1092 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data();
1093 } else if (option.starts_with("--compiled-methods=")) {
1094 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data();
1095 } else if (option.starts_with("--compiled-methods-zip=")) {
1096 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data();
1097 } else if (option.starts_with("--base=")) {
1098 ParseBase(option);
1099 } else if (option.starts_with("--boot-image=")) {
1100 parser_options->boot_image_filename = option.substr(strlen("--boot-image=")).data();
1101 } else if (option.starts_with("--android-root=")) {
1102 android_root_ = option.substr(strlen("--android-root=")).data();
1103 } else if (option.starts_with("--instruction-set=")) {
1104 ParseInstructionSet(option);
1105 } else if (option.starts_with("--instruction-set-variant=")) {
1106 ParseInstructionSetVariant(option, parser_options.get());
1107 } else if (option.starts_with("--instruction-set-features=")) {
1108 ParseInstructionSetFeatures(option, parser_options.get());
1109 } else if (option.starts_with("--compiler-backend=")) {
1110 ParseCompilerBackend(option, parser_options.get());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001111 } else if (option.starts_with("--profile-file=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001112 profile_file_ = option.substr(strlen("--profile-file=")).ToString();
Calin Juravle877fd962016-01-05 14:29:29 +00001113 } else if (option.starts_with("--profile-file-fd=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001114 ParseUintOption(option, "--profile-file-fd", &profile_file_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001115 } else if (option == "--host") {
1116 is_host_ = true;
1117 } else if (option == "--runtime-arg") {
1118 if (++i >= argc) {
1119 Usage("Missing required argument for --runtime-arg");
1120 }
1121 if (log_options) {
1122 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1123 }
1124 runtime_args_.push_back(argv[i]);
1125 } else if (option == "--dump-timing") {
1126 dump_timing_ = true;
1127 } else if (option == "--dump-passes") {
1128 dump_passes_ = true;
Roland Levillain9ec5e222015-08-17 20:18:41 +01001129 } else if (option == "--dump-stats") {
1130 dump_stats_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001131 } else if (option.starts_with("--swap-file=")) {
1132 swap_file_name_ = option.substr(strlen("--swap-file=")).data();
1133 } else if (option.starts_with("--swap-fd=")) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001134 ParseUintOption(option, "--swap-fd", &swap_fd_, Usage);
1135 } else if (option.starts_with("--app-image-file=")) {
1136 app_image_file_name_ = option.substr(strlen("--app-image-file=")).data();
1137 } else if (option.starts_with("--app-image-fd=")) {
1138 ParseUintOption(option, "--app-image-fd", &app_image_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001139 } else if (option.starts_with("--verbose-methods=")) {
1140 // TODO: rather than switch off compiler logging, make all VLOG(compiler) messages
1141 // conditional on having verbost methods.
1142 gLogVerbosity.compiler = false;
1143 Split(option.substr(strlen("--verbose-methods=")).ToString(), ',', &verbose_methods_);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001144 } else if (option == "--multi-image") {
Jeff Hao436183f2016-01-12 16:36:50 -08001145 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001146 } else if (option.starts_with("--no-inline-from=")) {
1147 no_inline_from_string_ = option.substr(strlen("--no-inline-from=")).data();
Andreas Gampeace0dc12016-01-20 13:33:13 -08001148 } else if (option == "--force-determinism") {
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001149 if (!SupportsDeterministicCompilation()) {
1150 Usage("Cannot use --force-determinism with read barriers or non-CMS garbage collector");
Roland Levillaineb2c7412016-01-28 14:37:01 +00001151 }
Andreas Gampeace0dc12016-01-20 13:33:13 -08001152 force_determinism_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001153 } else if (!compiler_options_->ParseCompilerOption(option, Usage)) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001154 Usage("Unknown argument %s", option.data());
1155 }
1156 }
1157
Jeff Hao436183f2016-01-12 16:36:50 -08001158 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001159
1160 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001161 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001162 }
1163
Jeff Haodcdc85b2015-12-04 14:06:18 -08001164 // Check whether the oat output files are writable, and open them for later. Also open a swap
1165 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001166 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001167 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1168 PruneNonExistentDexFiles();
1169
Jeff Hao436183f2016-01-12 16:36:50 -08001170 // Expand oat and image filenames for multi image.
1171 if (IsBootImage() && multi_image_) {
1172 ExpandOatAndImageFilenames();
1173 }
1174
Jeff Haodcdc85b2015-12-04 14:06:18 -08001175 bool create_file = oat_fd_ == -1; // as opposed to using open file descriptor
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001176 if (create_file) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001177 for (const char* oat_filename : oat_filenames_) {
1178 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
1179 if (oat_file.get() == nullptr) {
1180 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1181 return false;
1182 }
1183 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) {
1184 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1185 oat_file->Erase();
1186 return false;
1187 }
1188 oat_files_.push_back(std::move(oat_file));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001189 }
1190 } else {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001191 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, true));
1192 oat_file->DisableAutoClose();
1193 if (oat_file->SetLength(0) != 0) {
Andreas Gampe4303ba92014-11-06 01:00:46 -08001194 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1195 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001196 if (oat_file.get() == nullptr) {
1197 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1198 return false;
1199 }
1200 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) {
1201 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_location_;
1202 oat_file->Erase();
1203 return false;
1204 }
1205 oat_filenames_.push_back(oat_location_.c_str());
1206 oat_files_.push_back(std::move(oat_file));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001207 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001208
1209 // Swap file handling.
1210 //
1211 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1212 // that we can use for swap.
1213 //
1214 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1215 // will immediately unlink to satisfy the swap fd assumption.
1216 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1217 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1218 if (swap_file.get() == nullptr) {
1219 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1220 return false;
1221 }
1222 swap_fd_ = swap_file->Fd();
1223 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1224 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1225 // released immediately.
1226 unlink(swap_file_name_.c_str());
1227 }
Jeff Hao436183f2016-01-12 16:36:50 -08001228
1229 // If we use a swap file, ensure we are above the threshold to make it necessary.
1230 if (swap_fd_ != -1) {
1231 if (!UseSwap(IsBootImage(), dex_files_)) {
1232 close(swap_fd_);
1233 swap_fd_ = -1;
1234 VLOG(compiler) << "Decided to run without swap.";
1235 } else {
1236 LOG(INFO) << "Large app, accepted running with swap.";
1237 }
1238 }
1239 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
1240
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001241 return true;
1242 }
1243
Jeff Haodcdc85b2015-12-04 14:06:18 -08001244 void EraseOatFiles() {
1245 for (size_t i = 0; i < oat_files_.size(); ++i) {
1246 DCHECK(oat_files_[i].get() != nullptr);
1247 oat_files_[i]->Erase();
1248 oat_files_[i].reset();
1249 }
Andreas Gampea650e702014-12-03 14:28:02 -08001250 }
1251
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001252 void Shutdown() {
1253 ScopedObjectAccess soa(Thread::Current());
1254 for (jobject dex_cache : dex_caches_) {
1255 soa.Env()->DeleteLocalRef(dex_cache);
1256 }
1257 dex_caches_.clear();
1258 }
1259
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001260 void LoadClassProfileDescriptors() {
1261 if (profile_compilation_info_ != nullptr && app_image_) {
1262 Runtime* runtime = Runtime::Current();
1263 CHECK(runtime != nullptr);
1264 std::set<DexCacheResolvedClasses> resolved_classes(
1265 profile_compilation_info_->GetResolvedClasses());
Mathieu Chartier0b490842016-05-25 15:05:59 -07001266
1267 // Filter out class path classes since we don't want to include these in the image.
1268 std::unordered_set<std::string> dex_files_locations;
1269 for (const DexFile* dex_file : dex_files_) {
1270 dex_files_locations.insert(dex_file->GetLocation());
1271 }
1272 for (auto it = resolved_classes.begin(); it != resolved_classes.end(); ) {
1273 if (dex_files_locations.find(it->GetDexLocation()) == dex_files_locations.end()) {
1274 VLOG(compiler) << "Removed profile samples for non-app dex file " << it->GetDexLocation();
1275 it = resolved_classes.erase(it);
1276 } else {
1277 ++it;
1278 }
1279 }
1280
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001281 image_classes_.reset(new std::unordered_set<std::string>(
1282 runtime->GetClassLinker()->GetClassDescriptorsForProfileKeys(resolved_classes)));
1283 VLOG(compiler) << "Loaded " << image_classes_->size()
1284 << " image class descriptors from profile";
1285 if (VLOG_IS_ON(compiler)) {
1286 for (const std::string& s : *image_classes_) {
1287 LOG(INFO) << "Image class " << s;
1288 }
1289 }
1290 }
1291 }
1292
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001293 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1294 // boot class path.
1295 bool Setup() {
1296 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001297 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap.
Vladimir Marko49b0f452015-12-10 13:49:19 +00001298
1299 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods()) {
1300 return false;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001301 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001302
Vladimir Marko307dac92015-10-20 11:20:09 +01001303 verification_results_.reset(new VerificationResults(compiler_options_.get()));
Andreas Gampe4585f872015-03-27 23:45:15 -07001304 callbacks_.reset(new QuickCompilerCallbacks(
Vladimir Marko307dac92015-10-20 11:20:09 +01001305 verification_results_.get(),
Andreas Gampe4585f872015-03-27 23:45:15 -07001306 &method_inliner_map_,
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001307 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001308 CompilerCallbacks::CallbackMode::kCompileBootImage :
1309 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001310
Vladimir Marko49b0f452015-12-10 13:49:19 +00001311 RuntimeArgumentMap runtime_options;
1312 if (!PrepareRuntimeOptions(&runtime_options)) {
1313 return false;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001314 }
1315
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001316 CreateOatWriters();
1317 if (!AddDexFileSources()) {
1318 return false;
1319 }
1320
1321 if (IsBootImage() && image_filenames_.size() > 1) {
1322 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1323 // We need this for the multi-image case.
Jeff Haof0192c82016-03-28 20:39:50 -07001324 key_value_store_->Put(OatHeader::kBootClassPathKey, GetMultiImageBootClassPath());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001325 }
1326
1327 if (!IsBootImage()) {
1328 // When compiling an app, create the runtime early to retrieve
1329 // the image location key needed for the oat header.
1330 if (!CreateRuntime(std::move(runtime_options))) {
1331 return false;
1332 }
1333
Andreas Gampe29d38e72016-03-23 15:31:51 +00001334 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001335 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1336 std::vector<gc::space::ImageSpace*> image_spaces =
1337 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Jeff Haob11ffb72016-04-07 15:40:54 -07001338 image_file_location_oat_checksum_ = OatFileAssistant::CalculateCombinedImageChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001339 image_file_location_oat_data_begin_ =
1340 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1341 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1342 // Store the boot image filename(s).
1343 std::vector<std::string> image_filenames;
1344 for (const gc::space::ImageSpace* image_space : image_spaces) {
1345 image_filenames.push_back(image_space->GetImageFilename());
1346 }
1347 std::string image_file_location = Join(image_filenames, ':');
1348 if (!image_file_location.empty()) {
1349 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1350 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001351 } else {
1352 image_file_location_oat_checksum_ = 0u;
1353 image_file_location_oat_data_begin_ = 0u;
1354 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001355 }
1356
1357 // Open dex files for class path.
1358 const std::vector<std::string> class_path_locations =
1359 GetClassPathLocations(runtime_->GetClassPathString());
Jeff Haofbeb1322016-04-26 14:27:31 -07001360 OpenClassPathFiles(class_path_locations,
1361 &class_path_files_,
1362 &opened_oat_files_,
1363 runtime_->GetInstructionSet());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001364
1365 // Store the classpath we have right now.
1366 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
Jeff Haof0192c82016-03-28 20:39:50 -07001367 std::string encoded_class_path;
1368 if (class_path_locations.size() == 1 &&
1369 class_path_locations[0] == OatFile::kSpecialSharedLibrary) {
1370 // When passing the special shared library as the classpath, it is the only path.
1371 encoded_class_path = OatFile::kSpecialSharedLibrary;
1372 } else {
1373 encoded_class_path = OatFile::EncodeDexFileDependencies(class_path_files);
1374 }
1375 key_value_store_->Put(OatHeader::kClassPathKey, encoded_class_path);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001376 }
1377
1378 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001379 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001380 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1381 rodata_.reserve(oat_writers_.size());
1382 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1383 rodata_.push_back(elf_writers_[i]->StartRoData());
1384 // Unzip or copy dex files straight to the oat file.
1385 std::unique_ptr<MemMap> opened_dex_files_map;
1386 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
1387 if (!oat_writers_[i]->WriteAndOpenDexFiles(rodata_.back(),
1388 oat_files_[i].get(),
1389 instruction_set_,
1390 instruction_set_features_.get(),
1391 key_value_store_.get(),
Andreas Gampe3a2bd292016-01-26 17:23:47 -08001392 /* verify */ true,
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001393 &opened_dex_files_map,
1394 &opened_dex_files)) {
1395 return false;
1396 }
1397 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1398 if (opened_dex_files_map != nullptr) {
1399 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
1400 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001401 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001402 opened_dex_files_.push_back(std::move(dex_file));
1403 }
1404 } else {
1405 DCHECK(opened_dex_files.empty());
1406 }
1407 }
1408 }
1409
1410 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
1411 if (IsBootImage()) {
1412 // For boot image, pass opened dex files to the Runtime::Create().
1413 // Note: Runtime acquires ownership of these dex files.
1414 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001415 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001416 return false;
1417 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001418 }
1419
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001420 // If we're doing the image, override the compiler filter to force full compilation. Must be
1421 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1422 // compilation of class initializers.
1423 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001424 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001425 WellKnownClasses::Init(self->GetJniEnv());
1426
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001427 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001428 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001429 constexpr bool kSaveDexInput = false;
1430 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001431 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001432 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001433
1434 // Handle and ClassLoader creation needs to come after Runtime::Create.
1435 ScopedObjectAccess soa(self);
1436
1437 // Classpath: first the class-path given.
1438 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1439
1440 // Then the dex files we'll compile. Thus we'll resolve the class-path first.
1441 class_path_files.insert(class_path_files.end(), dex_files_.begin(), dex_files_.end());
1442
1443 class_loader_ = class_linker->CreatePathClassLoader(self, class_path_files);
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001444 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001445
1446 // Ensure opened dex files are writable for dex-to-dex transformations.
1447 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1448 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1449 PLOG(ERROR) << "Failed to make .dex files writeable.";
1450 return false;
Vladimir Marko919f5532016-01-20 19:13:01 +00001451 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001452 }
1453
1454 // Ensure that the dex caches stay live since we don't want class unloading
1455 // to occur during compilation.
1456 for (const auto& dex_file : dex_files_) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001457 ScopedObjectAccess soa(self);
1458 dex_caches_.push_back(soa.AddLocalReference<jobject>(
Mathieu Chartierf284d442016-06-02 11:48:30 -07001459 class_linker->RegisterDexFile(*dex_file,
1460 soa.Decode<mirror::ClassLoader*>(class_loader_))));
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001461 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001462
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001463 return true;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001464 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001465
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001466 // If we need to keep the oat file open for the image writer.
1467 bool ShouldKeepOatFileOpen() const {
1468 return IsImage() && oat_fd_ != kInvalidFd;
1469 }
1470
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001471 // Create and invoke the compiler driver. This will compile all the dex files.
1472 void Compile() {
1473 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1474 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001475
Vladimir Marko47496c22016-01-27 16:15:08 +00001476 // Find the dex files we should not inline from.
1477
1478 std::vector<std::string> no_inline_filters;
1479 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001480
1481 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001482 const std::string core_oj = "core-oj";
1483 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1484 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001485 }
1486
Vladimir Marko47496c22016-01-27 16:15:08 +00001487 if (!no_inline_filters.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001488 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1489 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1490 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1491 &class_linker->GetBootClassPath(),
1492 &class_path_files,
1493 &dex_files_
1494 };
1495 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001496 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001497 for (const std::string& filter : no_inline_filters) {
1498 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
1499 // allows tests to specify <test-dexfile>:classes2.dex if needed but if the
1500 // base location passes the StartsWith() test, so do all extra locations.
1501 std::string dex_location = dex_file->GetLocation();
1502 if (filter.find('/') == std::string::npos) {
1503 // The filter does not contain the path. Remove the path from dex_location as well.
1504 size_t last_slash = dex_file->GetLocation().rfind('/');
1505 if (last_slash != std::string::npos) {
1506 dex_location = dex_location.substr(last_slash + 1);
1507 }
1508 }
1509
1510 if (StartsWith(dex_location, filter.c_str())) {
1511 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1512 no_inline_from_dex_files_.push_back(dex_file);
1513 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001514 }
1515 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001516 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001517 }
1518 if (!no_inline_from_dex_files_.empty()) {
1519 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001520 }
1521 }
1522
Vladimir Marko307dac92015-10-20 11:20:09 +01001523 driver_.reset(new CompilerDriver(compiler_options_.get(),
1524 verification_results_.get(),
1525 &method_inliner_map_,
1526 compiler_kind_,
1527 instruction_set_,
1528 instruction_set_features_.get(),
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001529 IsBootImage(),
Mathieu Chartier91288d82016-04-28 09:44:54 -07001530 IsAppImage(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001531 image_classes_.release(),
1532 compiled_classes_.release(),
Vladimir Marko944da602016-02-19 12:27:55 +00001533 /* compiled_methods */ nullptr,
Vladimir Marko307dac92015-10-20 11:20:09 +01001534 thread_count_,
1535 dump_stats_,
1536 dump_passes_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001537 compiler_phases_timings_.get(),
1538 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001539 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001540 driver_->SetDexFilesForOatFile(dex_files_);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001541 driver_->CompileAll(class_loader_, dex_files_, timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001542 }
1543
Jeff Hao436183f2016-01-12 16:36:50 -08001544 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001545 // ensure the references between the two are correct.
1546 //
1547 // Currently we have a memory layout that looks something like this:
1548 //
1549 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001550 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001551 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001552 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001553 // +--------------+
1554 // | alloc spaces |
1555 // +--------------+
1556 //
Jeff Hao436183f2016-01-12 16:36:50 -08001557 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001558 //
Jeff Hao436183f2016-01-12 16:36:50 -08001559 // 1. The images are expected to be loaded at an absolute address and
1560 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001561 //
Jeff Hao436183f2016-01-12 16:36:50 -08001562 // 2. There are absolute pointers from Methods in the images to their
1563 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001564 //
Jeff Hao436183f2016-01-12 16:36:50 -08001565 // 3. There are absolute pointers from the code in the oat files to Methods
1566 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001567 //
Jeff Hao436183f2016-01-12 16:36:50 -08001568 // 4. There are absolute pointers from code in the oat files to other code
1569 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001570 //
1571 // To get this all correct, we go through several steps.
1572 //
Jeff Hao436183f2016-01-12 16:36:50 -08001573 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001574 // the oat data size and code size. During this stage, we also set
1575 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001576 //
Jeff Hao436183f2016-01-12 16:36:50 -08001577 // 2. We prepare offsets for the objects in the images and calculate
1578 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001579 //
Jeff Hao436183f2016-01-12 16:36:50 -08001580 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001581 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001582 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001583 // can prepare the ELF headers and we then know the ELF memory segment
1584 // layout and we can now resolve all references. The compiler provides
1585 // LinkerPatch information in each CompiledMethod and we resolve these,
1586 // using the layout information and image object locations provided by
1587 // image writer, as we're writing the method code.
1588 //
Jeff Hao436183f2016-01-12 16:36:50 -08001589 // 4. We create the image files. They need to know where the oat files
1590 // will be loaded after itself. Originally oat files were simply
1591 // memory mapped so we could predict where their contents were based
1592 // on the file size. Now that they are ELF files, we need to inspect
1593 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001594 // where the oat header is located within.
1595 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001596 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001597 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001598 // load the .so at the desired location at runtime by offsetting the
1599 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001600 // TODO: Do this in step 3. We already know the layout there.
1601 //
1602 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1603 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001604
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001605 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1606 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001607 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1608 // case (when the file will be explicitly erased).
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001609 bool WriteOatFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001610 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1611
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001612 // Sync the data to the file, in case we did dex2dex transformations.
1613 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1614 if (!map->Sync()) {
1615 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1616 return false;
1617 }
1618 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001619
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001620 if (IsImage()) {
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001621 if (app_image_ && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001622 gc::Heap* const heap = Runtime::Current()->GetHeap();
1623 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001624 image_base_ = std::max(image_base_, RoundUp(
1625 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1626 kPageSize));
1627 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001628 // The non moving space is right after the oat file. Put the preferred app image location
1629 // right after the non moving space so that we ideally get a continuous immune region for
1630 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001631 // Use the default non moving space capacity since dex2oat does not have a separate non-
1632 // moving space. This means the runtime's non moving space space size will be as large
1633 // as the growth limit for dex2oat, but smaller in the zygote.
1634 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001635 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001636 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1637 }
1638
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001639 image_writer_.reset(new ImageWriter(*driver_,
1640 image_base_,
1641 compiler_options_->GetCompilePic(),
1642 IsAppImage(),
1643 image_storage_mode_,
1644 oat_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00001645 dex_file_oat_index_map_));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001646
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001647 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001648 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1649 if (!image_writer_->PrepareImageAddressSpace()) {
1650 LOG(ERROR) << "Failed to prepare image address space.";
1651 return false;
1652 }
1653 }
1654
Vladimir Marko944da602016-02-19 12:27:55 +00001655 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001656 {
1657 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001658 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko944da602016-02-19 12:27:55 +00001659 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1660 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
1661
1662 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1663 oat_writer->PrepareLayout(driver_.get(), image_writer_.get(), dex_files, &patcher);
1664
1665 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
1666 size_t text_size = oat_writer->GetSize() - rodata_size;
1667 elf_writer->SetLoadedSectionSizes(rodata_size, text_size, oat_writer->GetBssSize());
1668
1669 if (IsImage()) {
1670 // Update oat layout.
1671 DCHECK(image_writer_ != nullptr);
1672 DCHECK_LT(i, oat_filenames_.size());
1673 image_writer_->UpdateOatFileLayout(i,
1674 elf_writer->GetLoadedSize(),
1675 oat_writer->GetOatDataOffset(),
1676 oat_writer->GetSize());
1677 }
1678 }
1679
1680 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001681 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001682 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1683 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00001684
David Srbecky09c2a6b2016-03-11 17:11:44 +00001685 oat_writer->AddMethodDebugInfos(debug::MakeTrampolineInfos(oat_writer->GetOatHeader()));
1686
David Srbecky0c4572e2016-01-22 19:19:25 +00001687 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00001688 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
1689 elf_writer->PrepareDebugInfo(oat_writer->GetMethodDebugInfo());
David Srbecky0c4572e2016-01-22 19:19:25 +00001690
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001691 OutputStream*& rodata = rodata_[i];
1692 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001693 if (!oat_writer->WriteRodata(rodata)) {
1694 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
1695 return false;
1696 }
1697 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001698 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00001699
Jeff Haodcdc85b2015-12-04 14:06:18 -08001700 OutputStream* text = elf_writer->StartText();
1701 if (!oat_writer->WriteCode(text)) {
1702 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
1703 return false;
1704 }
1705 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00001706
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001707 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
1708 image_file_location_oat_checksum_,
1709 image_file_location_oat_data_begin_,
1710 image_patch_delta_)) {
1711 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
1712 return false;
1713 }
1714
Vladimir Marko944da602016-02-19 12:27:55 +00001715 if (IsImage()) {
1716 // Update oat header information.
1717 DCHECK(image_writer_ != nullptr);
1718 DCHECK_LT(i, oat_filenames_.size());
1719 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
1720 }
1721
Jeff Haodcdc85b2015-12-04 14:06:18 -08001722 elf_writer->WriteDynamicSection();
1723 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
1724 elf_writer->WritePatchLocations(oat_writer->GetAbsolutePatchLocations());
Vladimir Marko10c13562015-11-25 14:33:36 +00001725
Jeff Haodcdc85b2015-12-04 14:06:18 -08001726 if (!elf_writer->End()) {
1727 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
1728 return false;
1729 }
1730
1731 // Flush the oat file.
1732 if (oat_files_[i] != nullptr) {
1733 if (oat_files_[i]->Flush() != 0) {
1734 PLOG(ERROR) << "Failed to flush oat file: " << oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08001735 return false;
1736 }
1737 }
1738
Jeff Haodcdc85b2015-12-04 14:06:18 -08001739 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001740
1741 oat_writer.reset();
1742 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001743 }
1744 }
1745
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001746 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001747 }
1748
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001749 // If we are compiling an image, invoke the image creation routine. Else just skip.
1750 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001751 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001752 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
1753 if (!CreateImageFile()) {
1754 return false;
1755 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001756 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07001757 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001758 return true;
1759 }
1760
Jeff Haodcdc85b2015-12-04 14:06:18 -08001761 // Create a copy from stripped to unstripped.
1762 bool CopyStrippedToUnstripped() {
1763 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
1764 // If we don't want to strip in place, copy from stripped location to unstripped location.
1765 // We need to strip after image creation because FixupElf needs to use .strtab.
1766 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
1767 // If the oat file is still open, flush it.
1768 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
1769 if (!FlushCloseOatFile(i)) {
1770 return false;
1771 }
1772 }
1773
1774 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
1775 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
1776 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
1777 size_t buffer_size = 8192;
1778 std::unique_ptr<uint8_t[]> buffer(new uint8_t[buffer_size]);
1779 while (true) {
1780 int bytes_read = TEMP_FAILURE_RETRY(read(in->Fd(), buffer.get(), buffer_size));
1781 if (bytes_read <= 0) {
1782 break;
1783 }
1784 bool write_ok = out->WriteFully(buffer.get(), bytes_read);
1785 CHECK(write_ok);
1786 }
1787 if (out->FlushCloseOrErase() != 0) {
1788 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
1789 return false;
1790 }
1791 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
1792 }
1793 }
1794 return true;
1795 }
1796
1797 bool FlushOatFiles() {
1798 TimingLogger::ScopedTiming t2("dex2oat Flush ELF", timings_);
1799 for (size_t i = 0; i < oat_files_.size(); ++i) {
1800 if (oat_files_[i].get() != nullptr) {
1801 if (oat_files_[i]->Flush() != 0) {
1802 PLOG(ERROR) << "Failed to flush oat file: " << oat_filenames_[i];
1803 oat_files_[i]->Erase();
Andreas Gampe10e477d2014-11-19 12:57:42 -08001804 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001805 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001806 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00001807 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08001808 return true;
1809 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001810
Jeff Haodcdc85b2015-12-04 14:06:18 -08001811 bool FlushCloseOatFile(size_t i) {
1812 if (oat_files_[i].get() != nullptr) {
1813 std::unique_ptr<File> tmp(oat_files_[i].release());
Andreas Gampe10e477d2014-11-19 12:57:42 -08001814 if (tmp->FlushCloseOrErase() != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001815 PLOG(ERROR) << "Failed to flush and close oat file: " << oat_filenames_[i];
Andreas Gampe10e477d2014-11-19 12:57:42 -08001816 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001817 }
1818 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001819 return true;
1820 }
1821
Jeff Haodcdc85b2015-12-04 14:06:18 -08001822 bool FlushCloseOatFiles() {
1823 bool result = true;
1824 for (size_t i = 0; i < oat_files_.size(); ++i) {
1825 result &= FlushCloseOatFile(i);
1826 }
1827 return result;
1828 }
1829
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001830 void DumpTiming() {
1831 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
1832 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
1833 }
1834 if (dump_passes_) {
1835 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
1836 }
1837 }
1838
1839 CompilerOptions* GetCompilerOptions() const {
1840 return compiler_options_.get();
1841 }
1842
Andreas Gampe10e477d2014-11-19 12:57:42 -08001843 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001844 return IsAppImage() || IsBootImage();
1845 }
1846
1847 bool IsAppImage() const {
1848 return app_image_;
1849 }
1850
1851 bool IsBootImage() const {
1852 return boot_image_;
Andreas Gampe10e477d2014-11-19 12:57:42 -08001853 }
1854
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001855 bool IsHost() const {
1856 return is_host_;
1857 }
1858
Calin Juravle998c2162015-12-21 15:39:33 +02001859 bool UseProfileGuidedCompilation() const {
Andreas Gampe29d38e72016-03-23 15:31:51 +00001860 return CompilerFilter::DependsOnProfile(compiler_options_->GetCompilerFilter());
Calin Juravle998c2162015-12-21 15:39:33 +02001861 }
1862
Calin Juravle2e2db782016-02-23 12:00:03 +00001863 bool LoadProfile() {
Calin Juravle998c2162015-12-21 15:39:33 +02001864 DCHECK(UseProfileGuidedCompilation());
Calin Juravle2e2db782016-02-23 12:00:03 +00001865
1866 profile_compilation_info_.reset(new ProfileCompilationInfo());
1867 ScopedFlock flock;
Andreas Gampe29d38e72016-03-23 15:31:51 +00001868 bool success = true;
Calin Juravle2e2db782016-02-23 12:00:03 +00001869 std::string error;
1870 if (profile_file_fd_ != -1) {
1871 // The file doesn't need to be flushed so don't check the usage.
1872 // Pass a bogus path so that we can easily attribute any reported error.
1873 File file(profile_file_fd_, "profile", /*check_usage*/ false, /*read_only_mode*/ true);
1874 if (flock.Init(&file, &error)) {
1875 success = profile_compilation_info_->Load(profile_file_fd_);
1876 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001877 } else if (profile_file_ != "") {
Calin Juravle2e2db782016-02-23 12:00:03 +00001878 if (flock.Init(profile_file_.c_str(), O_RDONLY, /* block */ true, &error)) {
1879 success = profile_compilation_info_->Load(flock.GetFile()->Fd());
1880 }
1881 }
1882 if (!error.empty()) {
1883 LOG(WARNING) << "Cannot lock profiles: " << error;
Calin Juravle998c2162015-12-21 15:39:33 +02001884 }
Calin Juravle877fd962016-01-05 14:29:29 +00001885
Calin Juravle2e2db782016-02-23 12:00:03 +00001886 if (!success) {
1887 profile_compilation_info_.reset(nullptr);
1888 }
Calin Juravle877fd962016-01-05 14:29:29 +00001889
Calin Juravle2e2db782016-02-23 12:00:03 +00001890 return success;
Calin Juravle998c2162015-12-21 15:39:33 +02001891 }
1892
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001893 private:
Vladimir Marko49b0f452015-12-10 13:49:19 +00001894 template <typename T>
1895 static std::vector<T*> MakeNonOwningPointerVector(const std::vector<std::unique_ptr<T>>& src) {
1896 std::vector<T*> result;
1897 result.reserve(src.size());
1898 for (const std::unique_ptr<T>& t : src) {
1899 result.push_back(t.get());
1900 }
1901 return result;
1902 }
1903
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001904 std::string GetMultiImageBootClassPath() {
1905 DCHECK(IsBootImage());
1906 DCHECK_GT(oat_filenames_.size(), 1u);
1907 // If the image filename was adapted (e.g., for our tests), we need to change this here,
1908 // too, but need to strip all path components (they will be re-established when loading).
1909 std::ostringstream bootcp_oss;
1910 bool first_bootcp = true;
1911 for (size_t i = 0; i < dex_locations_.size(); ++i) {
1912 if (!first_bootcp) {
1913 bootcp_oss << ":";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001914 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001915
1916 std::string dex_loc = dex_locations_[i];
1917 std::string image_filename = image_filenames_[i];
1918
1919 // Use the dex_loc path, but the image_filename name (without path elements).
1920 size_t dex_last_slash = dex_loc.rfind('/');
1921
1922 // npos is max(size_t). That makes this a bit ugly.
1923 size_t image_last_slash = image_filename.rfind('/');
1924 size_t image_last_at = image_filename.rfind('@');
1925 size_t image_last_sep = (image_last_slash == std::string::npos)
1926 ? image_last_at
1927 : (image_last_at == std::string::npos)
1928 ? std::string::npos
1929 : std::max(image_last_slash, image_last_at);
1930 // Note: whenever image_last_sep == npos, +1 overflow means using the full string.
1931
1932 if (dex_last_slash == std::string::npos) {
1933 dex_loc = image_filename.substr(image_last_sep + 1);
1934 } else {
1935 dex_loc = dex_loc.substr(0, dex_last_slash + 1) +
1936 image_filename.substr(image_last_sep + 1);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001937 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001938
1939 // Image filenames already end with .art, no need to replace.
1940
1941 bootcp_oss << dex_loc;
1942 first_bootcp = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001943 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001944 return bootcp_oss.str();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001945 }
1946
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001947 std::vector<std::string> GetClassPathLocations(const std::string& class_path) {
1948 // This function is used only for apps and for an app we have exactly one oat file.
1949 DCHECK(!IsBootImage());
1950 DCHECK_EQ(oat_writers_.size(), 1u);
1951 std::vector<std::string> dex_files_canonical_locations;
1952 for (const char* location : oat_writers_[0]->GetSourceLocations()) {
1953 dex_files_canonical_locations.push_back(DexFile::GetDexCanonicalLocation(location));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001954 }
Vladimir Marko625a64a2015-11-26 14:44:16 +00001955
Vladimir Marko919f5532016-01-20 19:13:01 +00001956 std::vector<std::string> parsed;
1957 Split(class_path, ':', &parsed);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001958 auto kept_it = std::remove_if(parsed.begin(),
1959 parsed.end(),
1960 [dex_files_canonical_locations](const std::string& location) {
1961 return ContainsElement(dex_files_canonical_locations,
1962 DexFile::GetDexCanonicalLocation(location.c_str()));
1963 });
1964 parsed.erase(kept_it, parsed.end());
1965 return parsed;
1966 }
1967
Jeff Haofbeb1322016-04-26 14:27:31 -07001968 // Opens requested class path files and appends them to opened_dex_files. If the dex files have
1969 // been stripped, this opens them from their oat files and appends them to opened_oat_files.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001970 static void OpenClassPathFiles(const std::vector<std::string>& class_path_locations,
Jeff Haof0192c82016-03-28 20:39:50 -07001971 std::vector<std::unique_ptr<const DexFile>>* opened_dex_files,
Jeff Haofbeb1322016-04-26 14:27:31 -07001972 std::vector<std::unique_ptr<OatFile>>* opened_oat_files,
Jeff Haof0192c82016-03-28 20:39:50 -07001973 InstructionSet isa) {
Jeff Haofbeb1322016-04-26 14:27:31 -07001974 DCHECK(opened_dex_files != nullptr) << "OpenClassPathFiles dex out-param is nullptr";
1975 DCHECK(opened_oat_files != nullptr) << "OpenClassPathFiles oat out-param is nullptr";
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001976 for (const std::string& location : class_path_locations) {
Jeff Haof0192c82016-03-28 20:39:50 -07001977 // Stop early if we detect the special shared library, which may be passed as the classpath
1978 // for dex2oat when we want to skip the shared libraries check.
1979 if (location == OatFile::kSpecialSharedLibrary) {
1980 break;
1981 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001982 std::string error_msg;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001983 if (!DexFile::Open(location.c_str(), location.c_str(), &error_msg, opened_dex_files)) {
Jeff Haof0192c82016-03-28 20:39:50 -07001984 // If we fail to open the dex file because it's been stripped, try to open the dex file
1985 // from its corresponding oat file.
1986 OatFileAssistant oat_file_assistant(location.c_str(), isa, false, false);
1987 std::unique_ptr<OatFile> oat_file(oat_file_assistant.GetBestOatFile());
1988 if (oat_file == nullptr) {
1989 LOG(WARNING) << "Failed to open dex file and associated oat file for '" << location
1990 << "': " << error_msg;
1991 } else {
1992 std::vector<std::unique_ptr<const DexFile>> oat_dex_files =
1993 oat_file_assistant.LoadDexFiles(*oat_file, location.c_str());
Jeff Haofbeb1322016-04-26 14:27:31 -07001994 opened_oat_files->push_back(std::move(oat_file));
Jeff Haof0192c82016-03-28 20:39:50 -07001995 opened_dex_files->insert(opened_dex_files->end(),
1996 std::make_move_iterator(oat_dex_files.begin()),
1997 std::make_move_iterator(oat_dex_files.end()));
1998 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001999 }
2000 }
2001 }
2002
Vladimir Marko49b0f452015-12-10 13:49:19 +00002003 bool PrepareImageClasses() {
2004 // If --image-classes was specified, calculate the full list of classes to include in the image.
2005 if (image_classes_filename_ != nullptr) {
2006 image_classes_ =
2007 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2008 if (image_classes_ == nullptr) {
2009 return false;
2010 }
2011 } else if (IsBootImage()) {
2012 image_classes_.reset(new std::unordered_set<std::string>);
2013 }
2014 return true;
2015 }
2016
2017 bool PrepareCompiledClasses() {
2018 // If --compiled-classes was specified, calculate the full list of classes to compile in the
2019 // image.
2020 if (compiled_classes_filename_ != nullptr) {
2021 compiled_classes_ =
2022 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
2023 if (compiled_classes_ == nullptr) {
2024 return false;
2025 }
2026 } else {
2027 compiled_classes_.reset(nullptr); // By default compile everything.
2028 }
2029 return true;
2030 }
2031
2032 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2033 const char* classes_filename,
2034 const char* tag) {
2035 std::unique_ptr<std::unordered_set<std::string>> classes;
2036 std::string error_msg;
2037 if (zip_filename != nullptr) {
2038 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2039 } else {
2040 classes.reset(ReadImageClassesFromFile(classes_filename));
2041 }
2042 if (classes == nullptr) {
2043 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2044 << classes_filename << "': " << error_msg;
2045 }
2046 return classes;
2047 }
2048
2049 bool PrepareCompiledMethods() {
2050 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2051 if (compiled_methods_filename_ != nullptr) {
2052 std::string error_msg;
2053 if (compiled_methods_zip_filename_ != nullptr) {
2054 compiled_methods_.reset(ReadCommentedInputFromZip(compiled_methods_zip_filename_,
2055 compiled_methods_filename_,
2056 nullptr, // No post-processing.
2057 &error_msg));
2058 } else {
2059 compiled_methods_.reset(ReadCommentedInputFromFile(compiled_methods_filename_,
2060 nullptr)); // No post-processing.
2061 }
2062 if (compiled_methods_.get() == nullptr) {
2063 LOG(ERROR) << "Failed to create list of compiled methods from '"
2064 << compiled_methods_filename_ << "': " << error_msg;
2065 return false;
2066 }
2067 } else {
2068 compiled_methods_.reset(nullptr); // By default compile everything.
2069 }
2070 return true;
2071 }
2072
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002073 void PruneNonExistentDexFiles() {
2074 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2075 size_t kept = 0u;
2076 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2077 if (!OS::FileExists(dex_filenames_[i])) {
2078 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2079 } else {
2080 dex_filenames_[kept] = dex_filenames_[i];
2081 dex_locations_[kept] = dex_locations_[i];
2082 ++kept;
2083 }
2084 }
2085 dex_filenames_.resize(kept);
2086 dex_locations_.resize(kept);
2087 }
2088
2089 bool AddDexFileSources() {
2090 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
2091 if (zip_fd_ != -1) {
2092 DCHECK_EQ(oat_writers_.size(), 1u);
2093 if (!oat_writers_[0]->AddZippedDexFilesSource(ScopedFd(zip_fd_), zip_location_.c_str())) {
2094 return false;
2095 }
2096 } else if (oat_writers_.size() > 1u) {
2097 // Multi-image.
2098 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2099 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2100 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2101 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2102 return false;
2103 }
2104 }
2105 } else {
2106 DCHECK_EQ(oat_writers_.size(), 1u);
2107 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2108 DCHECK_NE(dex_filenames_.size(), 0u);
2109 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2110 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2111 return false;
2112 }
2113 }
2114 }
2115 return true;
2116 }
2117
2118 void CreateOatWriters() {
2119 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2120 elf_writers_.reserve(oat_files_.size());
2121 oat_writers_.reserve(oat_files_.size());
2122 for (const std::unique_ptr<File>& oat_file : oat_files_) {
David Srbecky5d811202016-03-08 13:21:22 +00002123 elf_writers_.emplace_back(CreateElfWriterQuick(instruction_set_,
2124 instruction_set_features_.get(),
2125 compiler_options_.get(),
2126 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002127 elf_writers_.back()->Start();
2128 oat_writers_.emplace_back(new OatWriter(IsBootImage(), timings_));
2129 }
2130 }
2131
Vladimir Marko49b0f452015-12-10 13:49:19 +00002132 void SaveDexInput() {
2133 for (size_t i = 0; i < dex_files_.size(); ++i) {
2134 const DexFile* dex_file = dex_files_[i];
2135 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2136 getpid(), i));
2137 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2138 if (tmp_file.get() == nullptr) {
2139 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2140 << ". Try: adb shell chmod 777 /data/local/tmp";
2141 continue;
2142 }
2143 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2144 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2145 UNUSED(tmp_file->Flush());
2146 UNUSED(tmp_file->Close());
2147 LOG(INFO) << "Wrote input to " << tmp_file_name;
2148 }
2149 }
2150
2151 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options) {
2152 RuntimeOptions raw_options;
2153 if (boot_image_filename_.empty()) {
2154 std::string boot_class_path = "-Xbootclasspath:";
2155 boot_class_path += Join(dex_filenames_, ':');
2156 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2157 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
2158 boot_class_path_locations += Join(dex_locations_, ':');
2159 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2160 } else {
2161 std::string boot_image_option = "-Ximage:";
2162 boot_image_option += boot_image_filename_;
2163 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2164 }
2165 for (size_t i = 0; i < runtime_args_.size(); i++) {
2166 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2167 }
2168
2169 raw_options.push_back(std::make_pair("compilercallbacks", callbacks_.get()));
2170 raw_options.push_back(
2171 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2172
2173 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2174 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2175 // have been stripped in preopting, anyways).
2176 if (!IsBootImage()) {
2177 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2178 }
2179 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2180 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2181 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002182 // Disable Hspace compaction to save heap size virtual space.
2183 // Only need disable Hspace for OOM becasue background collector is equal to
2184 // foreground collector by default for dex2oat.
2185 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002186
Andreas Gampeace0dc12016-01-20 13:33:13 -08002187 // If we're asked to be deterministic, ensure non-concurrent GC for determinism. Also
2188 // force the free-list implementation for large objects.
2189 if (compiler_options_->IsForceDeterminism()) {
2190 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
2191 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=freelist", nullptr));
2192
2193 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2194 // compaction (done above) and ensure that neither foreground nor background collectors
2195 // are concurrent.
2196 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2197
2198 // To make identity hashcode deterministic, set a known seed.
2199 mirror::Object::SetHashCodeSeed(987654321U);
2200 }
2201
Vladimir Marko49b0f452015-12-10 13:49:19 +00002202 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2203 LOG(ERROR) << "Failed to parse runtime options";
2204 return false;
2205 }
2206 return true;
2207 }
2208
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002209 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002210 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2211 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002212 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002213 LOG(ERROR) << "Failed to create runtime";
2214 return false;
2215 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002216 runtime_.reset(Runtime::Current());
2217 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002218 for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) {
2219 Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002220 if (!runtime_->HasCalleeSaveMethod(type)) {
2221 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002222 }
2223 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002224 runtime_->GetClassLinker()->FixupDexCaches(runtime_->GetResolutionMethod());
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002225
2226 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2227 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002228 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002229
Vladimir Marko307dac92015-10-20 11:20:09 +01002230 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002231
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002232 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2233 // Runtime::Start, give it away now so that we don't starve GC.
2234 Thread* self = Thread::Current();
2235 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002236
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002237 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002238 }
2239
Jeff Haodcdc85b2015-12-04 14:06:18 -08002240 // 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 -08002241 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002242 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002243 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002244 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002245 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002246 image_filenames_.push_back(app_image_file_name_.c_str());
2247 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002248 if (!image_writer_->Write(app_image_fd_,
2249 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002250 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002251 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002252 return false;
2253 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002254
Jeff Haodcdc85b2015-12-04 14:06:18 -08002255 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002256 dchecked_vector<uintptr_t> oat_data_begins;
2257 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2258 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002259 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002260 // Destroy ImageWriter before doing FixupElf.
2261 image_writer_.reset();
2262
Vladimir Marko944da602016-02-19 12:27:55 +00002263 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2264 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002265 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2266 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2267 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2268 if (oat_file.get() == nullptr) {
2269 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2270 return false;
2271 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002272
Vladimir Marko944da602016-02-19 12:27:55 +00002273 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002274 oat_file->Erase();
2275 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2276 return false;
2277 }
2278
2279 if (oat_file->FlushCloseOrErase()) {
2280 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2281 return false;
2282 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002283 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002284 }
2285
2286 return true;
2287 }
2288
2289 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002290 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2291 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002292 std::function<std::string(const char*)> process = DotToDescriptor;
2293 return ReadCommentedInputFromFile(image_classes_filename, &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002294 }
2295
2296 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002297 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002298 const char* zip_filename,
2299 const char* image_classes_filename,
2300 std::string* error_msg) {
2301 std::function<std::string(const char*)> process = DotToDescriptor;
2302 return ReadCommentedInputFromZip(zip_filename, image_classes_filename, &process, error_msg);
2303 }
2304
2305 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2306 // the given function.
2307 static std::unordered_set<std::string>* ReadCommentedInputFromFile(
2308 const char* input_filename, std::function<std::string(const char*)>* process) {
2309 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2310 if (input_file.get() == nullptr) {
2311 LOG(ERROR) << "Failed to open input file " << input_filename;
2312 return nullptr;
2313 }
2314 std::unique_ptr<std::unordered_set<std::string>> result(
2315 ReadCommentedInputStream(*input_file, process));
2316 input_file->close();
2317 return result.release();
2318 }
2319
2320 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2321 // Post-process each line with the given function.
2322 static std::unordered_set<std::string>* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002323 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002324 const char* input_filename,
2325 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002326 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002327 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2328 if (zip_archive.get() == nullptr) {
2329 return nullptr;
2330 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002331 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002332 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002333 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002334 zip_filename, error_msg->c_str());
2335 return nullptr;
2336 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002337 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2338 input_filename,
2339 error_msg));
2340 if (input_file.get() == nullptr) {
2341 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002342 zip_filename, error_msg->c_str());
2343 return nullptr;
2344 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002345 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2346 input_file->Size());
2347 std::istringstream input_stream(input_string);
2348 return ReadCommentedInputStream(input_stream, process);
2349 }
2350
2351 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2352 // with the given function.
2353 static std::unordered_set<std::string>* ReadCommentedInputStream(
2354 std::istream& in_stream,
2355 std::function<std::string(const char*)>* process) {
2356 std::unique_ptr<std::unordered_set<std::string>> image_classes(
2357 new std::unordered_set<std::string>);
2358 while (in_stream.good()) {
2359 std::string dot;
2360 std::getline(in_stream, dot);
2361 if (StartsWith(dot, "#") || dot.empty()) {
2362 continue;
2363 }
2364 if (process != nullptr) {
2365 std::string descriptor((*process)(dot.c_str()));
2366 image_classes->insert(descriptor);
2367 } else {
2368 image_classes->insert(dot);
2369 }
2370 }
2371 return image_classes.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002372 }
2373
Mathieu Chartier49285c52014-12-02 15:43:48 -08002374 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002375 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2376 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002377 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002378 LOG(INFO) << "dex2oat took " << PrettyDuration(NanoTime() - start_ns_)
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002379 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002380 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002381 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2382 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002383 }
2384
Jeff Haodcdc85b2015-12-04 14:06:18 -08002385 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2386 std::string res(image_filename);
2387 size_t last_slash = res.rfind('/');
2388 if (last_slash == std::string::npos || last_slash == 0) {
2389 return res;
2390 }
2391 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2392 if (penultimate_slash == std::string::npos) {
2393 return res;
2394 }
2395 // Check that the string in-between is the expected one.
2396 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2397 GetInstructionSetString(isa)) {
2398 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2399 return res;
2400 }
2401 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2402 }
2403
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002404 std::unique_ptr<CompilerOptions> compiler_options_;
2405 Compiler::Kind compiler_kind_;
2406
2407 InstructionSet instruction_set_;
2408 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2409
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002410 uint32_t image_file_location_oat_checksum_;
2411 uintptr_t image_file_location_oat_data_begin_;
2412 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002413 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2414
Vladimir Marko307dac92015-10-20 11:20:09 +01002415 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002416
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002417 DexFileToMethodInlinerMap method_inliner_map_;
2418 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2419
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002420 std::unique_ptr<Runtime> runtime_;
2421
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002422 // Ownership for the class path files.
2423 std::vector<std::unique_ptr<const DexFile>> class_path_files_;
2424
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002425 size_t thread_count_;
2426 uint64_t start_ns_;
2427 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002428 std::vector<std::unique_ptr<File>> oat_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002429 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002430 std::vector<const char*> oat_filenames_;
2431 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002432 int oat_fd_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002433 std::vector<const char*> dex_filenames_;
2434 std::vector<const char*> dex_locations_;
2435 int zip_fd_;
2436 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002437 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002438 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002439 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002440 uintptr_t image_base_;
2441 const char* image_classes_zip_filename_;
2442 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002443 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002444 const char* compiled_classes_zip_filename_;
2445 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002446 const char* compiled_methods_zip_filename_;
2447 const char* compiled_methods_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002448 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2449 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002450 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002451 bool app_image_;
2452 bool boot_image_;
Jeff Hao436183f2016-01-12 16:36:50 -08002453 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002454 bool is_host_;
2455 std::string android_root_;
Mathieu Chartier0b490842016-05-25 15:05:59 -07002456 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002457 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002458 std::string no_inline_from_string_;
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002459 std::vector<jobject> dex_caches_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002460 jobject class_loader_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002461
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002462 std::vector<std::unique_ptr<ElfWriter>> elf_writers_;
2463 std::vector<std::unique_ptr<OatWriter>> oat_writers_;
2464 std::vector<OutputStream*> rodata_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002465 std::unique_ptr<ImageWriter> image_writer_;
2466 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002467
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002468 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
Jeff Haofbeb1322016-04-26 14:27:31 -07002469 std::vector<std::unique_ptr<OatFile>> opened_oat_files_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002470 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2471
Vladimir Marko47496c22016-01-27 16:15:08 +00002472 std::vector<const DexFile*> no_inline_from_dex_files_;
2473
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002474 std::vector<std::string> verbose_methods_;
2475 bool dump_stats_;
2476 bool dump_passes_;
2477 bool dump_timing_;
2478 bool dump_slow_timing_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002479 std::string swap_file_name_;
2480 int swap_fd_;
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002481 std::string app_image_file_name_;
2482 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002483 std::string profile_file_;
2484 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002485 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002486 TimingLogger* timings_;
2487 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002488 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002489 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002490
2491 // Backing storage.
2492 std::vector<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002493
Andreas Gampeace0dc12016-01-20 13:33:13 -08002494 // See CompilerOptions.force_determinism_.
2495 bool force_determinism_;
2496
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002497 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2498};
2499
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002500static void b13564922() {
2501#if defined(__linux__) && defined(__arm__)
2502 int major, minor;
2503 struct utsname uts;
2504 if (uname(&uts) != -1 &&
2505 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2506 ((major < 3) || ((major == 3) && (minor < 4)))) {
2507 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2508 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2509 int old_personality = personality(0xffffffff);
2510 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2511 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2512 if (new_personality == -1) {
2513 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2514 }
2515 }
2516 }
2517#endif
2518}
2519
Andreas Gampe10e477d2014-11-19 12:57:42 -08002520static int CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002521 dex2oat.LoadClassProfileDescriptors();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002522 dex2oat.Compile();
2523
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002524 if (!dex2oat.WriteOatFiles()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002525 dex2oat.EraseOatFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002526 return EXIT_FAILURE;
2527 }
2528
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002529 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2530 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2531 // image writer will require this fd to generate the image.
2532 if (dex2oat.ShouldKeepOatFileOpen()) {
2533 if (!dex2oat.FlushOatFiles()) {
2534 return EXIT_FAILURE;
2535 }
2536 } else if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002537 return EXIT_FAILURE;
2538 }
2539
Jeff Haodcdc85b2015-12-04 14:06:18 -08002540 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002541 if (!dex2oat.HandleImage()) {
2542 return EXIT_FAILURE;
2543 }
2544
2545 // When given --host, finish early without stripping.
2546 if (dex2oat.IsHost()) {
2547 dex2oat.DumpTiming();
2548 return EXIT_SUCCESS;
2549 }
2550
Jeff Haodcdc85b2015-12-04 14:06:18 -08002551 // Copy stripped to unstripped location, if necessary.
2552 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002553 return EXIT_FAILURE;
2554 }
2555
Jeff Haodcdc85b2015-12-04 14:06:18 -08002556 // FlushClose again, as stripping might have re-opened the oat files.
2557 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002558 return EXIT_FAILURE;
2559 }
2560
2561 dex2oat.DumpTiming();
2562 return EXIT_SUCCESS;
2563}
2564
2565static int CompileApp(Dex2Oat& dex2oat) {
2566 dex2oat.Compile();
2567
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002568 if (!dex2oat.WriteOatFiles()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002569 dex2oat.EraseOatFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002570 return EXIT_FAILURE;
2571 }
2572
Jeff Haodcdc85b2015-12-04 14:06:18 -08002573 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002574 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002575
2576 // When given --host, finish early without stripping.
2577 if (dex2oat.IsHost()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002578 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002579 return EXIT_FAILURE;
2580 }
2581
2582 dex2oat.DumpTiming();
2583 return EXIT_SUCCESS;
2584 }
2585
Jeff Haodcdc85b2015-12-04 14:06:18 -08002586 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2587 // stripped versions. If this is given, we expect to be able to open writable files by name.
2588 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002589 return EXIT_FAILURE;
2590 }
2591
Jeff Haodcdc85b2015-12-04 14:06:18 -08002592 // Flush and close the files.
2593 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002594 return EXIT_FAILURE;
2595 }
2596
2597 dex2oat.DumpTiming();
2598 return EXIT_SUCCESS;
2599}
2600
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002601static int dex2oat(int argc, char** argv) {
2602 b13564922();
2603
2604 TimingLogger timings("compiler", false, false);
2605
Roland Levillain5c7e2602016-02-23 18:08:53 +00002606 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
2607 // might produce a stack frame too large for this function or for
2608 // functions inlining it (such as main), that would not fit the
2609 // requirements of the `-Wframe-larger-than` option.
2610 std::unique_ptr<Dex2Oat> dex2oat = MakeUnique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002611
2612 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002613 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002614
Calin Juravleb077e152016-02-18 18:47:37 +00002615 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02002616 // This operation involves I/O.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002617 if (dex2oat->UseProfileGuidedCompilation()) {
Calin Juravleb077e152016-02-18 18:47:37 +00002618 if (!dex2oat->LoadProfile()) {
2619 LOG(ERROR) << "Failed to process profile file";
Calin Juravle998c2162015-12-21 15:39:33 +02002620 return EXIT_FAILURE;
2621 }
2622 }
2623
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002624 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00002625 if (!dex2oat->OpenFile()) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002626 return EXIT_FAILURE;
2627 }
2628
Andreas Gampe046c7062015-05-18 23:22:54 -07002629 // Print the complete line when any of the following is true:
2630 // 1) Debug build
2631 // 2) Compiling an image
2632 // 3) Compiling with --host
2633 // 4) Compiling on the host (not a target build)
2634 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002635 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07002636 LOG(INFO) << CommandLine();
2637 } else {
2638 LOG(INFO) << StrippedCommandLine();
2639 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002640
Roland Levillain5c7e2602016-02-23 18:08:53 +00002641 if (!dex2oat->Setup()) {
2642 dex2oat->EraseOatFiles();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002643 return EXIT_FAILURE;
2644 }
2645
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002646 bool result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00002647 if (dex2oat->IsImage()) {
2648 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002649 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00002650 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002651 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002652
Roland Levillain5c7e2602016-02-23 18:08:53 +00002653 dex2oat->Shutdown();
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002654 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002655}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002656} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07002657
2658int main(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002659 int result = art::dex2oat(argc, argv);
2660 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
2661 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
2662 // should not destruct the runtime in this case.
Evgenii Stepanov1e133742015-05-20 12:30:59 -07002663 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002664 exit(result);
2665 }
2666 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002667}