blob: 28d628920c74f4bbdd490bde57535358d8f93807 [file] [log] [blame]
Brian Carlstrom7940e442013-07-12 13:46:57 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Andreas Gamped687e372015-04-28 23:16:03 -070017#include <inttypes.h>
Brian Carlstrom7940e442013-07-12 13:46:57 -070018#include <stdio.h>
19#include <stdlib.h>
20#include <sys/stat.h>
Evgenii Stepanov1e133742015-05-20 12:30:59 -070021#include "base/memory_tool.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070022
23#include <fstream>
24#include <iostream>
Andreas Gampe67f02822016-06-24 21:05:23 -070025#include <limits>
Brian Carlstrom7940e442013-07-12 13:46:57 -070026#include <sstream>
27#include <string>
Andreas Gampeb1fcead2015-04-20 18:53:51 -070028#include <unordered_set>
Brian Carlstrom7940e442013-07-12 13:46:57 -070029#include <vector>
30
Vladimir Markof94b7812014-06-05 15:48:04 +010031#if defined(__linux__) && defined(__arm__)
32#include <sys/personality.h>
33#include <sys/utsname.h>
34#endif
35
Ian Rogersd582fa42014-11-05 23:46:43 -080036#include "arch/instruction_set_features.h"
Andreas Gampec5a3ea72015-01-13 16:41:53 -080037#include "arch/mips/instruction_set_features_mips.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000038#include "art_method-inl.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070039#include "base/dumpable.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080040#include "base/macros.h"
Calin Juravle2e2db782016-02-23 12:00:03 +000041#include "base/scoped_flock.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070042#include "base/stl_util.h"
43#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010044#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070045#include "base/timing_logger.h"
46#include "base/unix_file/fd_file.h"
47#include "class_linker.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000048#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000049#include "compiler_callbacks.h"
David Srbecky09c2a6b2016-03-11 17:11:44 +000050#include "debug/elf_debug_writer.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000051#include "debug/method_debug_info.h"
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"
David Brazdil5d5a36b2016-09-14 15:34:10 +010066#include "linker/buffered_output_stream.h"
67#include "linker/file_output_stream.h"
Vladimir Marko944da602016-02-19 12:27:55 +000068#include "linker/multi_oat_relative_patcher.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070069#include "mirror/class-inl.h"
70#include "mirror/class_loader.h"
71#include "mirror/object-inl.h"
72#include "mirror/object_array-inl.h"
Jeff Haob11ffb72016-04-07 15:40:54 -070073#include "oat_file_assistant.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070074#include "oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070075#include "os.h"
76#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000077#include "runtime_options.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070078#include "ScopedLocalRef.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070079#include "scoped_thread_state_change-inl.h"
Alex Light53cb16b2014-06-12 11:26:29 -070080#include "utils.h"
David Brazdilca3c8c32016-09-06 14:04:48 +010081#include "verifier/verifier_deps.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070082#include "well_known_classes.h"
83#include "zip_archive.h"
84
85namespace art {
86
Andreas Gampee1459ae2016-06-29 09:36:30 -070087static constexpr size_t kDefaultMinDexFilesForSwap = 2;
88static constexpr size_t kDefaultMinDexFileCumulativeSizeForSwap = 20 * MB;
89
Brian Carlstrom6449c622014-02-10 23:48:36 -080090static int original_argc;
91static char** original_argv;
92
93static std::string CommandLine() {
94 std::vector<std::string> command;
95 for (int i = 0; i < original_argc; ++i) {
96 command.push_back(original_argv[i]);
97 }
98 return Join(command, ' ');
99}
100
Andreas Gampe046c7062015-05-18 23:22:54 -0700101// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
102// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
103// locations are all staged).
104static std::string StrippedCommandLine() {
105 std::vector<std::string> command;
106
107 // Do a pre-pass to look for zip-fd.
108 bool saw_zip_fd = false;
109 for (int i = 0; i < original_argc; ++i) {
110 if (StartsWith(original_argv[i], "--zip-fd=")) {
111 saw_zip_fd = true;
112 break;
113 }
114 }
115
116 // Now filter out things.
117 for (int i = 0; i < original_argc; ++i) {
118 // All runtime-arg parameters are dropped.
119 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
120 i++; // Drop the next part, too.
121 continue;
122 }
123
124 // Any instruction-setXXX is dropped.
125 if (StartsWith(original_argv[i], "--instruction-set")) {
126 continue;
127 }
128
129 // The boot image is dropped.
130 if (StartsWith(original_argv[i], "--boot-image=")) {
131 continue;
132 }
133
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800134 // The image format is dropped.
135 if (StartsWith(original_argv[i], "--image-format=")) {
136 continue;
137 }
138
Andreas Gampe046c7062015-05-18 23:22:54 -0700139 // This should leave any dex-file and oat-file options, describing what we compiled.
140
141 // However, we prefer to drop this when we saw --zip-fd.
142 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700143 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe046c7062015-05-18 23:22:54 -0700144 if (StartsWith(original_argv[i], "--zip-") ||
145 StartsWith(original_argv[i], "--dex-") ||
146 StartsWith(original_argv[i], "--oat-") ||
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700147 StartsWith(original_argv[i], "--swap-") ||
148 StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700149 continue;
150 }
151 }
152
153 command.push_back(original_argv[i]);
154 }
155
156 // Construct the final output.
157 if (command.size() <= 1U) {
158 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
159 return "Starting dex2oat.";
160 }
161 return Join(command, ' ');
162}
163
Brian Carlstrom7940e442013-07-12 13:46:57 -0700164static void UsageErrorV(const char* fmt, va_list ap) {
165 std::string error;
166 StringAppendV(&error, fmt, ap);
167 LOG(ERROR) << error;
168}
169
170static void UsageError(const char* fmt, ...) {
171 va_list ap;
172 va_start(ap, fmt);
173 UsageErrorV(fmt, ap);
174 va_end(ap);
175}
176
Andreas Gampe794ad762015-02-23 08:12:24 -0800177NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700178 va_list ap;
179 va_start(ap, fmt);
180 UsageErrorV(fmt, ap);
181 va_end(ap);
182
Brian Carlstrom6449c622014-02-10 23:48:36 -0800183 UsageError("Command: %s", CommandLine().c_str());
184
Brian Carlstrom7940e442013-07-12 13:46:57 -0700185 UsageError("Usage: dex2oat [options]...");
186 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100187 UsageError(" -j<number>: specifies the number of threads used for compilation.");
188 UsageError(" Default is the number of detected hardware threads available on the");
189 UsageError(" host system.");
190 UsageError(" Example: -j12");
191 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700192 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700193 UsageError(" Example: --dex-file=/system/framework/core.jar");
194 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700195 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
196 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
197 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
198 UsageError(" --dex-location=/system/framework/core.jar");
199 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700200 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
201 UsageError(" containing a classes.dex file to compile.");
202 UsageError(" Example: --zip-fd=5");
203 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700204 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
205 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700206 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
207 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800208 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700209 UsageError(" Example: --oat-file=/system/framework/boot.oat");
210 UsageError("");
211 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900212 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700213 UsageError("");
214 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
215 UsageError(" to the file descriptor specified by --oat-fd.");
216 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
217 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800218 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700219 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
220 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800221 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700222 UsageError(" Example: --image=/system/framework/boot.art");
223 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800224 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800225 UsageError(" Which format to store the image.");
226 UsageError(" Example: --image-format=lz4");
227 UsageError(" Default: uncompressed");
228 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700229 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
230 UsageError(" Example: --image=frameworks/base/preloaded-classes");
231 UsageError("");
232 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
233 UsageError(" Example: --base=0x50000000");
234 UsageError("");
235 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000236 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700237 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000238 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000239 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700240 UsageError("");
241 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
242 UsageError(" Example: --android-root=out/host/linux-x86");
243 UsageError(" Default: $ANDROID_ROOT");
244 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800245 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700246 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700247 UsageError(" Example: --instruction-set=x86");
248 UsageError(" Default: arm");
249 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700250 UsageError(" --instruction-set-features=...,: Specify instruction set features");
251 UsageError(" Example: --instruction-set-features=div");
252 UsageError(" Default: default");
253 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700254 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
255 UsageError(" Default: disabled");
256 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800257 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700258 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800259 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100260 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700261 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100262 UsageError(" --compiler-filter="
263 "(verify-none"
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700264 "|verify-at-runtime"
Mathieu Chartiera8077802016-03-16 19:08:31 -0700265 "|verify-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100266 "|interpret-only"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000267 "|time"
268 "|space-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100269 "|space"
270 "|balanced"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000271 "|speed-profile"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100272 "|speed"
Andreas Gampe29d38e72016-03-23 15:31:51 +0000273 "|everything-profile"
274 "|everything):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700275 UsageError(" select compiler filter.");
Mathieu Chartiera8077802016-03-16 19:08:31 -0700276 UsageError(" verify-profile requires a --profile(-fd) to also be passed in.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800277 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800278 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800279 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800280 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
281 UsageError(" method for compiler filter tuning.");
282 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
283 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
284 UsageError("");
285 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
286 UsageError(" method for compiler filter tuning.");
287 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
288 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
289 UsageError("");
290 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
291 UsageError(" method for compiler filter tuning.");
292 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
293 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
294 UsageError("");
295 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
296 UsageError(" method for compiler filter tuning.");
297 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
298 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
299 UsageError("");
300 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
301 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700302 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
303 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800304 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
305 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
306 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100307 UsageError(" --inline-depth-limit=<depth-limit>: the depth limit of inlining for fine tuning");
308 UsageError(" the compiler. A zero value will disable inlining. Honored only by Optimizing.");
Roland Levillaina215b952015-08-07 11:38:32 +0100309 UsageError(" Has priority over the --compiler-filter option. Intended for ");
310 UsageError(" development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100311 UsageError(" Example: --inline-depth-limit=%d", CompilerOptions::kDefaultInlineDepthLimit);
312 UsageError(" Default: %d", CompilerOptions::kDefaultInlineDepthLimit);
313 UsageError("");
314 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
315 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100316 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
317 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100318 UsageError(" Example: --inline-max-code-units=%d",
319 CompilerOptions::kDefaultInlineMaxCodeUnits);
320 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
321 UsageError("");
Ian Rogers46398602013-08-20 07:50:36 -0700322 UsageError(" --dump-timing: display a breakdown of where time was spent");
323 UsageError("");
Alex Light53cb16b2014-06-12 11:26:29 -0700324 UsageError(" --include-patch-information: Include patching information so the generated code");
325 UsageError(" can have its base address moved without full recompilation.");
326 UsageError("");
327 UsageError(" --no-include-patch-information: Do not include patching information.");
328 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100329 UsageError(" -g");
330 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
331 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000332 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000333 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700334 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100335 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100336 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000337 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
338 UsageError(" debug information necessary to print backtraces. (disabled by default)");
339 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000340 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000341 UsageError("");
Alexey Alexandrovab40c112016-09-19 09:33:49 -0700342 UsageError(" --generate-build-id: Generate GNU-compatible linker build ID ELF section with");
343 UsageError(" SHA-1 of the file content (and thus stable across identical builds)");
344 UsageError("");
345 UsageError(" --no-generate-build-id: Do not generate the build ID ELF section.");
346 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000347 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000348 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700349 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
350 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
351 UsageError(" Use a separate --runtime-arg switch for each argument.");
352 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700353 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000354 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700355 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000356 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
357 UsageError(" Cannot be used together with --profile-file.");
358 UsageError("");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800359 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
360 UsageError(" Example: --swap-file=/data/tmp/swap.001");
361 UsageError("");
362 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
363 UsageError(" Example: --swap-fd=10");
364 UsageError("");
Andreas Gampee1459ae2016-06-29 09:36:30 -0700365 UsageError(" --swap-dex-size-threshold=<size>: specifies the minimum total dex file size in");
366 UsageError(" bytes to allow the use of swap.");
367 UsageError(" Example: --swap-dex-size-threshold=1000000");
368 UsageError(" Default: %zu", kDefaultMinDexFileCumulativeSizeForSwap);
369 UsageError("");
370 UsageError(" --swap-dex-count-threshold=<count>: specifies the minimum number of dex files to");
371 UsageError(" allow the use of swap.");
372 UsageError(" Example: --swap-dex-count-threshold=10");
373 UsageError(" Default: %zu", kDefaultMinDexFilesForSwap);
374 UsageError("");
Andreas Gampe67f02822016-06-24 21:05:23 -0700375 UsageError(" --very-large-app-threshold=<size>: specifies the minimum total dex file size in");
376 UsageError(" bytes to consider the input \"very large\" and punt on the compilation.");
377 UsageError(" Example: --very-large-app-threshold=100000000");
378 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700379 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
380 UsageError(" Example: --app-image-fd=10");
381 UsageError("");
382 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
383 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
384 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800385 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
386 "input dex file.");
387 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000388 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
389 UsageError(" This option is incompatible with read barriers (e.g., if dex2oat has been");
390 UsageError(" built with the environment variable `ART_USE_READ_BARRIER` set to `true`).");
391 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700392 std::cerr << "See log for usage error information\n";
393 exit(EXIT_FAILURE);
394}
395
Brian Carlstrom7940e442013-07-12 13:46:57 -0700396// The primary goal of the watchdog is to prevent stuck build servers
397// during development when fatal aborts lead to a cascade of failures
398// that result in a deadlock.
399class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800400// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700401#undef CHECK_PTHREAD_CALL
402#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
403 do { \
404 int rc = call args; \
405 if (rc != 0) { \
406 errno = rc; \
407 std::string message(# call); \
408 message += " failed for "; \
409 message += reason; \
410 Fatal(message); \
411 } \
412 } while (false)
413
414 public:
Brian Carlstrom93ba8932013-07-17 21:31:49 -0700415 explicit WatchDog(bool is_watch_dog_enabled) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700416 is_watch_dog_enabled_ = is_watch_dog_enabled;
417 if (!is_watch_dog_enabled_) {
418 return;
419 }
420 shutting_down_ = false;
421 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700422 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
423 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700424 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
425 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
426 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
427 }
428 ~WatchDog() {
429 if (!is_watch_dog_enabled_) {
430 return;
431 }
432 const char* reason = "dex2oat watch dog thread shutdown";
433 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
434 shutting_down_ = true;
435 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
436 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
437
Kenny Root51316382014-05-13 14:59:37 -0700438 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700439
440 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
441 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
442 }
443
444 private:
445 static void* CallBack(void* arg) {
446 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
447 ::art::SetThreadName("dex2oat watch dog");
448 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700449 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700450 }
451
Andreas Gampe794ad762015-02-23 08:12:24 -0800452 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700453 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
454 // it's rather easy to hang in unwinding.
455 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
456 // logcat logging or stderr output.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700457 android::base::LogMessage::LogLine(__FILE__,
458 __LINE__,
459 android::base::LogId::DEFAULT,
460 LogSeverity::FATAL,
461 message.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700462 exit(1);
463 }
464
465 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700466 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
467 // large.
Andreas Gamped687e372015-04-28 23:16:03 -0700468 constexpr int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700469 timespec timeout_ts;
470 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts);
471 const char* reason = "dex2oat watch dog thread waiting";
472 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
473 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800474 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700475 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700476 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
477 kWatchDogTimeoutSeconds));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700478 } else if (rc != 0) {
479 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
480 strerror(errno)));
481 Fatal(message.c_str());
482 }
483 }
484 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
485 }
486
487 // 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 -0700488 // Debug builds are slower so they have larger timeouts.
Andreas Gamped687e372015-04-28 23:16:03 -0700489 static constexpr int64_t kSlowdownFactor = kIsDebugBuild ? 5U : 1U;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800490
Andreas Gampe540138a2015-09-14 15:34:38 -0700491 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
492 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
493 // itself before that watchdog would take down the system server.
494 static constexpr int64_t kWatchDogTimeoutSeconds = kSlowdownFactor * (9 * 60 + 30);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700495
496 bool is_watch_dog_enabled_;
497 bool shutting_down_;
498 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
499 pthread_mutex_t mutex_;
500 pthread_cond_t cond_;
501 pthread_attr_t attr_;
502 pthread_t pthread_;
503};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700504
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800505class Dex2Oat FINAL {
506 public:
507 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100508 compiler_kind_(Compiler::kOptimizing),
Artem Serovba6b6792016-08-15 14:22:07 +0100509 instruction_set_(kRuntimeISA == kArm ? kThumb2 : kRuntimeISA),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800510 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000511 image_file_location_oat_checksum_(0),
512 image_file_location_oat_data_begin_(0),
513 image_patch_delta_(0),
514 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700515 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800516 runtime_(nullptr),
517 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
518 start_ns_(NanoTime()),
519 oat_fd_(-1),
David Brazdil7b49e6c2016-09-01 11:06:18 +0100520 vdex_fd_(-1),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800521 zip_fd_(-1),
522 image_base_(0U),
523 image_classes_zip_filename_(nullptr),
524 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800525 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800526 compiled_classes_zip_filename_(nullptr),
527 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700528 compiled_methods_zip_filename_(nullptr),
529 compiled_methods_filename_(nullptr),
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700530 passes_to_run_filename_(nullptr),
Jeff Hao436183f2016-01-12 16:36:50 -0800531 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800532 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000533 class_loader_(nullptr),
534 elf_writers_(),
535 oat_writers_(),
536 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000537 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700538 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000539 opened_dex_files_maps_(),
540 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000541 no_inline_from_dex_files_(),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800542 dump_stats_(false),
543 dump_passes_(false),
544 dump_timing_(false),
545 dump_slow_timing_(kIsDebugBuild),
Calin Juravle2e2db782016-02-23 12:00:03 +0000546 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800547 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000548 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800549 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000550 force_determinism_(false)
551 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800552
553 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800554 // Log completion time before deleting the runtime_, because this accesses
555 // the runtime.
556 LogCompletionTime();
557
Vladimir Marko307dac92015-10-20 11:20:09 +0100558 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
559 // We want to just exit on non-debug builds, not bringing the runtime down
560 // in an orderly fashion. So release the following fields.
561 driver_.release();
562 image_writer_.release();
563 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
564 dex_file.release();
565 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000566 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
567 map.release();
568 }
David Brazdil7b49e6c2016-09-01 11:06:18 +0100569 for (std::unique_ptr<File>& vdex_file : vdex_files_) {
570 vdex_file.release();
571 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800572 for (std::unique_ptr<File>& oat_file : oat_files_) {
573 oat_file.release();
574 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100575 runtime_.release();
576 verification_results_.release();
577 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100578 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700579 }
580
Roland Levillain9ec5e222015-08-17 20:18:41 +0100581 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800582 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800583 std::string boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800584 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000585 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800586 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100587 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800588
Roland Levillain9ec5e222015-08-17 20:18:41 +0100589 void ParseZipFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000590 ParseUintOption(option, "--zip-fd", &zip_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100591 }
592
David Brazdil7b49e6c2016-09-01 11:06:18 +0100593 void ParseVdexFd(const StringPiece& option) {
594 ParseUintOption(option, "--vdex-fd", &vdex_fd_, Usage);
595 }
596
Roland Levillain9ec5e222015-08-17 20:18:41 +0100597 void ParseOatFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000598 ParseUintOption(option, "--oat-fd", &oat_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100599 }
600
Calin Juravle877fd962016-01-05 14:29:29 +0000601 void ParseFdForCollection(const StringPiece& option,
602 const char* arg_name,
603 std::vector<uint32_t>* fds) {
604 uint32_t fd;
605 ParseUintOption(option, arg_name, &fd, Usage);
606 fds->push_back(fd);
607 }
608
Roland Levillain9ec5e222015-08-17 20:18:41 +0100609 void ParseJ(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000610 ParseUintOption(option, "-j", &thread_count_, Usage, /* is_long_option */ false);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100611 }
612
613 void ParseBase(const StringPiece& option) {
614 DCHECK(option.starts_with("--base="));
615 const char* image_base_str = option.substr(strlen("--base=")).data();
616 char* end;
617 image_base_ = strtoul(image_base_str, &end, 16);
618 if (end == image_base_str || *end != '\0') {
619 Usage("Failed to parse hexadecimal value for option %s", option.data());
620 }
621 }
622
623 void ParseInstructionSet(const StringPiece& option) {
624 DCHECK(option.starts_with("--instruction-set="));
625 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
626 // StringPiece is not necessarily zero-terminated, so need to make a copy and ensure it.
627 std::unique_ptr<char[]> buf(new char[instruction_set_str.length() + 1]);
628 strncpy(buf.get(), instruction_set_str.data(), instruction_set_str.length());
629 buf.get()[instruction_set_str.length()] = 0;
630 instruction_set_ = GetInstructionSetFromString(buf.get());
631 // arm actually means thumb2.
632 if (instruction_set_ == InstructionSet::kArm) {
633 instruction_set_ = InstructionSet::kThumb2;
634 }
635 }
636
637 void ParseInstructionSetVariant(const StringPiece& option, ParserOptions* parser_options) {
638 DCHECK(option.starts_with("--instruction-set-variant="));
639 StringPiece str = option.substr(strlen("--instruction-set-variant=")).data();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800640 instruction_set_features_ = InstructionSetFeatures::FromVariant(
641 instruction_set_, str.as_string(), &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100642 if (instruction_set_features_.get() == nullptr) {
643 Usage("%s", parser_options->error_msg.c_str());
644 }
645 }
646
647 void ParseInstructionSetFeatures(const StringPiece& option, ParserOptions* parser_options) {
648 DCHECK(option.starts_with("--instruction-set-features="));
649 StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800650 if (instruction_set_features_ == nullptr) {
651 instruction_set_features_ = InstructionSetFeatures::FromVariant(
652 instruction_set_, "default", &parser_options->error_msg);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100653 if (instruction_set_features_.get() == nullptr) {
654 Usage("Problem initializing default instruction set features variant: %s",
655 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700656 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800657 }
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800658 instruction_set_features_ =
Roland Levillain9ec5e222015-08-17 20:18:41 +0100659 instruction_set_features_->AddFeaturesFromString(str.as_string(),
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800660 &parser_options->error_msg);
661 if (instruction_set_features_ == nullptr) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100662 Usage("Error parsing '%s': %s", option.data(), parser_options->error_msg.c_str());
663 }
664 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800665
Roland Levillain9ec5e222015-08-17 20:18:41 +0100666 void ParseCompilerBackend(const StringPiece& option, ParserOptions* parser_options) {
667 DCHECK(option.starts_with("--compiler-backend="));
668 parser_options->requested_specific_compiler = true;
669 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
670 if (backend_str == "Quick") {
671 compiler_kind_ = Compiler::kQuick;
672 } else if (backend_str == "Optimizing") {
673 compiler_kind_ = Compiler::kOptimizing;
674 } else {
675 Usage("Unknown compiler backend: %s", backend_str.data());
676 }
677 }
678
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800679 void ParseImageFormat(const StringPiece& option) {
680 const StringPiece substr("--image-format=");
681 DCHECK(option.starts_with(substr));
682 const StringPiece format_str = option.substr(substr.length());
683 if (format_str == "lz4") {
684 image_storage_mode_ = ImageHeader::kStorageModeLZ4;
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800685 } else if (format_str == "lz4hc") {
686 image_storage_mode_ = ImageHeader::kStorageModeLZ4HC;
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800687 } else if (format_str == "uncompressed") {
688 image_storage_mode_ = ImageHeader::kStorageModeUncompressed;
689 } else {
690 Usage("Unknown image format: %s", format_str.data());
691 }
692 }
693
Jeff Hao436183f2016-01-12 16:36:50 -0800694 void ProcessOptions(ParserOptions* parser_options) {
Vladimir Markoaad75c62016-10-03 08:46:48 +0000695 compiler_options_->boot_image_ = !image_filenames_.empty();
696 compiler_options_->app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700697
698 if (IsAppImage() && IsBootImage()) {
699 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
700 }
701
Jeff Haodcdc85b2015-12-04 14:06:18 -0800702 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800703 Usage("Output must be supplied with either --oat-file or --oat-fd");
704 }
705
Jeff Haodcdc85b2015-12-04 14:06:18 -0800706 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800707 Usage("--oat-file should not be used with --oat-fd");
708 }
709
David Brazdil7b49e6c2016-09-01 11:06:18 +0100710 if ((vdex_fd_ == -1) != (oat_fd_ == -1)) {
711 Usage("VDEX and OAT output must be specified either with one --oat-filename "
712 "or with --oat-fd and --vdex-fd file descriptors");
713 }
714
Roland Levillain9ec5e222015-08-17 20:18:41 +0100715 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800716 Usage("--oat-symbols should not be used with --oat-fd");
717 }
718
Roland Levillain9ec5e222015-08-17 20:18:41 +0100719 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800720 Usage("--oat-symbols should not be used with --host");
721 }
722
David Brazdil7b49e6c2016-09-01 11:06:18 +0100723 if (vdex_fd_ != -1 && !image_filenames_.empty()) {
724 Usage("--vdex-fd should not be used with --image");
725 }
726
Jeff Haodcdc85b2015-12-04 14:06:18 -0800727 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800728 Usage("--oat-fd should not be used with --image");
729 }
730
Jeff Haodcdc85b2015-12-04 14:06:18 -0800731 if (!parser_options->oat_symbols.empty() &&
732 parser_options->oat_symbols.size() != oat_filenames_.size()) {
733 Usage("--oat-file arguments do not match --oat-symbols arguments");
734 }
735
736 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
737 Usage("--oat-file arguments do not match --image arguments");
738 }
739
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800740 if (android_root_.empty()) {
741 const char* android_root_env_var = getenv("ANDROID_ROOT");
742 if (android_root_env_var == nullptr) {
743 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700744 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800745 android_root_ += android_root_env_var;
746 }
747
Vladimir Markoaad75c62016-10-03 08:46:48 +0000748 if (!IsBootImage() && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100749 parser_options->boot_image_filename += android_root_;
750 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800751 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100752 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000753 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800754 }
755
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700756 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800757 Usage("--image-classes should only be used with --image");
758 }
759
Vladimir Marko49b0f452015-12-10 13:49:19 +0000760 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800761 Usage("--image-classes should not be used with --boot-image");
762 }
763
764 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
765 Usage("--image-classes-zip should be used with --image-classes");
766 }
767
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700768 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800769 Usage("--compiled-classes should only be used with --image");
770 }
771
Vladimir Marko49b0f452015-12-10 13:49:19 +0000772 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800773 Usage("--compiled-classes should not be used with --boot-image");
774 }
775
776 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
777 Usage("--compiled-classes-zip should be used with --compiled-classes");
778 }
779
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800780 if (dex_filenames_.empty() && zip_fd_ == -1) {
781 Usage("Input must be supplied with either --dex-file or --zip-fd");
782 }
783
784 if (!dex_filenames_.empty() && zip_fd_ != -1) {
785 Usage("--dex-file should not be used with --zip-fd");
786 }
787
788 if (!dex_filenames_.empty() && !zip_location_.empty()) {
789 Usage("--dex-file should not be used with --zip-location");
790 }
791
792 if (dex_locations_.empty()) {
793 for (const char* dex_file_name : dex_filenames_) {
794 dex_locations_.push_back(dex_file_name);
795 }
796 } else if (dex_locations_.size() != dex_filenames_.size()) {
797 Usage("--dex-location arguments do not match --dex-file arguments");
798 }
799
Jeff Haodcdc85b2015-12-04 14:06:18 -0800800 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
801 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
802 Usage("--oat-file arguments must be singular or match --dex-file arguments");
803 }
804 }
805
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800806 if (zip_fd_ != -1 && zip_location_.empty()) {
807 Usage("--zip-location should be supplied with --zip-fd");
808 }
809
Vladimir Marko49b0f452015-12-10 13:49:19 +0000810 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800811 if (image_base_ == 0) {
812 Usage("Non-zero --base not specified");
813 }
814 }
815
Mathieu Chartiera8077802016-03-16 19:08:31 -0700816 const bool have_profile_file = !profile_file_.empty();
817 const bool have_profile_fd = profile_file_fd_ != kInvalidFd;
818 if (have_profile_file && have_profile_fd) {
Calin Juravle2e2db782016-02-23 12:00:03 +0000819 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200820 }
821
Roland Levillain9ec5e222015-08-17 20:18:41 +0100822 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800823 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800824 }
825
826 // If no instruction set feature was given, use the default one for the target
827 // instruction set.
828 if (instruction_set_features_.get() == nullptr) {
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800829 instruction_set_features_ = InstructionSetFeatures::FromVariant(
830 instruction_set_, "default", &parser_options->error_msg);
Ian Rogersd582fa42014-11-05 23:46:43 -0800831 if (instruction_set_features_.get() == nullptr) {
832 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100833 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800834 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800835 }
836
837 if (instruction_set_ == kRuntimeISA) {
838 std::unique_ptr<const InstructionSetFeatures> runtime_features(
839 InstructionSetFeatures::FromCppDefines());
840 if (!instruction_set_features_->Equals(runtime_features.get())) {
841 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
842 << *instruction_set_features_ << ") and those of dex2oat executable ("
843 << *runtime_features <<") for the command line:\n"
844 << CommandLine();
845 }
846 }
847
Roland Levillaina215b952015-08-07 11:38:32 +0100848 // It they are not set, use default values for inlining settings.
849 // TODO: We should rethink the compiler filter. We mostly save
850 // time here, which is orthogonal to space.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000851 if (compiler_options_->inline_depth_limit_ == CompilerOptions::kUnsetInlineDepthLimit) {
852 compiler_options_->inline_depth_limit_ =
Andreas Gampe29d38e72016-03-23 15:31:51 +0000853 (compiler_options_->compiler_filter_ == CompilerFilter::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100854 // Implementation of the space filter: limit inlining depth.
855 ? CompilerOptions::kSpaceFilterInlineDepthLimit
856 : CompilerOptions::kDefaultInlineDepthLimit;
857 }
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000858 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
859 compiler_options_->inline_max_code_units_ =
Andreas Gampe29d38e72016-03-23 15:31:51 +0000860 (compiler_options_->compiler_filter_ == CompilerFilter::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100861 // Implementation of the space filter: limit inlining max code units.
862 ? CompilerOptions::kSpaceFilterInlineMaxCodeUnits
863 : CompilerOptions::kDefaultInlineMaxCodeUnits;
864 }
865
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800866 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800867 // Set the compilation target's implicit checks options.
868 switch (instruction_set_) {
869 case kArm:
870 case kThumb2:
871 case kArm64:
872 case kX86:
873 case kX86_64:
Douglas Leung22bb5a22015-07-02 16:42:08 -0700874 case kMips:
875 case kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000876 compiler_options_->implicit_null_checks_ = true;
877 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800878 break;
879
880 default:
881 // Defaults are correct.
882 break;
883 }
884
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000885 compiler_options_->verbose_methods_ = verbose_methods_.empty() ? nullptr : &verbose_methods_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800886
Jeff Hao436183f2016-01-12 16:36:50 -0800887 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800888 Usage("--multi-image can only be used when creating boot images");
889 }
Jeff Hao436183f2016-01-12 16:36:50 -0800890 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800891 Usage("--multi-image cannot be used with multiple image names");
892 }
893
894 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
895 if (!kIsTargetBuild && IsBootImage()) {
896 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800897 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800898 }
899 }
900
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800901 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100902 if (parser_options->watch_dog_enabled) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800903 watchdog_.reset(new WatchDog(true));
904 }
905
906 // Fill some values into the key-value store for the oat header.
907 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800908
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800909 // Automatically force determinism for the boot image in a host build if the default GC is CMS
910 // or MS and read barriers are not enabled, as the former switches the GC to a non-concurrent
911 // one by passing the option `-Xgc:nonconcurrent` (see below).
912 if (!kIsTargetBuild && IsBootImage()) {
913 if (SupportsDeterministicCompilation()) {
914 force_determinism_ = true;
915 } else {
916 LOG(WARNING) << "Deterministic compilation is disabled.";
917 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800918 }
919 compiler_options_->force_determinism_ = force_determinism_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -0700920
921 if (passes_to_run_filename_ != nullptr) {
922 passes_to_run_.reset(ReadCommentedInputFromFile<std::vector<std::string>>(
923 passes_to_run_filename_,
924 nullptr)); // No post-processing.
925 if (passes_to_run_.get() == nullptr) {
926 Usage("Failed to read list of passes to run.");
927 }
928 }
929 compiler_options_->passes_to_run_ = passes_to_run_.get();
Roland Levillain9ec5e222015-08-17 20:18:41 +0100930 }
931
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800932 static bool SupportsDeterministicCompilation() {
933 return (gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
934 gc::kCollectorTypeDefault == gc::kCollectorTypeMS) &&
935 !kEmitCompilerReadBarrier;
936 }
937
Jeff Hao436183f2016-01-12 16:36:50 -0800938 void ExpandOatAndImageFilenames() {
939 std::string base_oat = oat_filenames_[0];
940 size_t last_oat_slash = base_oat.rfind('/');
941 if (last_oat_slash == std::string::npos) {
942 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
943 }
944 // We also need to honor path components that were encoded through '@'. Otherwise the loading
945 // code won't be able to find the images.
946 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
947 last_oat_slash = base_oat.rfind('@');
948 }
949 base_oat = base_oat.substr(0, last_oat_slash + 1);
950
951 std::string base_img = image_filenames_[0];
952 size_t last_img_slash = base_img.rfind('/');
953 if (last_img_slash == std::string::npos) {
954 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
955 }
956 // We also need to honor path components that were encoded through '@'. Otherwise the loading
957 // code won't be able to find the images.
958 if (base_img.find('@', last_img_slash) != std::string::npos) {
959 last_img_slash = base_img.rfind('@');
960 }
961
962 // Get the prefix, which is the primary image name (without path components). Strip the
963 // extension.
964 std::string prefix = base_img.substr(last_img_slash + 1);
965 if (prefix.rfind('.') != std::string::npos) {
966 prefix = prefix.substr(0, prefix.rfind('.'));
967 }
968 if (!prefix.empty()) {
969 prefix = prefix + "-";
970 }
971
972 base_img = base_img.substr(0, last_img_slash + 1);
973
974 // Note: we have some special case here for our testing. We have to inject the differentiating
975 // parts for the different core images.
976 std::string infix; // Empty infix by default.
977 {
978 // Check the first name.
979 std::string dex_file = oat_filenames_[0];
980 size_t last_dex_slash = dex_file.rfind('/');
981 if (last_dex_slash != std::string::npos) {
982 dex_file = dex_file.substr(last_dex_slash + 1);
983 }
984 size_t last_dex_dot = dex_file.rfind('.');
985 if (last_dex_dot != std::string::npos) {
986 dex_file = dex_file.substr(0, last_dex_dot);
987 }
988 if (StartsWith(dex_file, "core-")) {
989 infix = dex_file.substr(strlen("core"));
990 }
991 }
992
bowen_lai8bd36c02016-10-12 13:28:55 +0800993 std::string base_symbol_oat;
994 if (!oat_unstripped_.empty()) {
995 base_symbol_oat = oat_unstripped_[0];
996 size_t last_symbol_oat_slash = base_symbol_oat.rfind('/');
997 if (last_symbol_oat_slash == std::string::npos) {
998 Usage("--multi-image used with unusable symbol filename %s", base_symbol_oat.c_str());
999 }
1000 base_symbol_oat = base_symbol_oat.substr(0, last_symbol_oat_slash + 1);
1001 }
1002
1003 const size_t num_expanded_files = 2 + (base_symbol_oat.empty() ? 0 : 1);
1004 char_backing_storage_.reserve((dex_locations_.size() - 1) * num_expanded_files);
Ben Gruvera0fc3262016-09-30 13:10:42 -07001005
Jeff Hao436183f2016-01-12 16:36:50 -08001006 // Now create the other names. Use a counted loop to skip the first one.
1007 for (size_t i = 1; i < dex_locations_.size(); ++i) {
1008 // TODO: Make everything properly std::string.
1009 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
1010 char_backing_storage_.push_back(base_img + image_name);
1011 image_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
1012
1013 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
1014 char_backing_storage_.push_back(base_oat + oat_name);
1015 oat_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
bowen_lai8bd36c02016-10-12 13:28:55 +08001016
1017 if (!base_symbol_oat.empty()) {
1018 char_backing_storage_.push_back(base_symbol_oat + oat_name);
1019 oat_unstripped_.push_back((char_backing_storage_.end() - 1)->c_str());
1020 }
Jeff Hao436183f2016-01-12 16:36:50 -08001021 }
1022 }
1023
Andreas Gampe8994a042015-12-30 19:03:17 +00001024 // Modify the input string in the following way:
1025 // 0) Assume input is /a/b/c.d
1026 // 1) Strip the path -> c.d
1027 // 2) Inject prefix p -> pc.d
1028 // 3) Inject infix i -> pci.d
1029 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -08001030 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +00001031 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001032 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +00001033 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001034 size_t last_dex_slash = in.rfind('/');
1035 if (last_dex_slash != std::string::npos) {
1036 in = in.substr(last_dex_slash + 1);
1037 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001038 if (!prefix.empty()) {
1039 in = prefix + in;
1040 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001041 if (!infix.empty()) {
1042 // Inject infix.
1043 size_t last_dot = in.rfind('.');
1044 if (last_dot != std::string::npos) {
1045 in.insert(last_dot, infix);
1046 }
1047 }
1048 if (EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001049 in = in.substr(0, in.length() - strlen(".jar")) +
1050 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001051 }
1052 return in;
1053 }
1054
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001055 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001056 std::ostringstream oss;
1057 for (int i = 0; i < argc; ++i) {
1058 if (i > 0) {
1059 oss << ' ';
1060 }
1061 oss << argv[i];
1062 }
1063 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1064 oss.str(""); // Reset.
1065 oss << kRuntimeISA;
1066 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1067 key_value_store_->Put(
1068 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001069 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001070 key_value_store_->Put(
1071 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001072 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001073 key_value_store_->Put(
1074 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001075 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe29d38e72016-03-23 15:31:51 +00001076 key_value_store_->Put(OatHeader::kCompilerFilter,
1077 CompilerFilter::NameOfFilter(compiler_options_->GetCompilerFilter()));
Richard Uhlerd1537b52016-03-29 13:27:41 -07001078 key_value_store_->Put(OatHeader::kHasPatchInfoKey,
1079 compiler_options_->GetIncludePatchInformation() ? OatHeader::kTrueValue
1080 : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001081 }
1082
1083 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1084 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1085 // returns, arguments have been successfully parsed.
1086 void ParseArgs(int argc, char** argv) {
1087 original_argc = argc;
1088 original_argv = argv;
1089
David Sehrf57589f2016-10-17 10:09:33 -07001090 InitLogging(argv, Runtime::Aborter);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001091
1092 // Skip over argv[0].
1093 argv++;
1094 argc--;
1095
1096 if (argc == 0) {
1097 Usage("No arguments specified");
1098 }
1099
1100 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001101 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001102
1103 for (int i = 0; i < argc; i++) {
1104 const StringPiece option(argv[i]);
1105 const bool log_options = false;
1106 if (log_options) {
1107 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1108 }
1109 if (option.starts_with("--dex-file=")) {
1110 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data());
1111 } else if (option.starts_with("--dex-location=")) {
1112 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data());
1113 } else if (option.starts_with("--zip-fd=")) {
1114 ParseZipFd(option);
1115 } else if (option.starts_with("--zip-location=")) {
1116 zip_location_ = option.substr(strlen("--zip-location=")).data();
David Brazdil7b49e6c2016-09-01 11:06:18 +01001117 } else if (option.starts_with("--vdex-fd=")) {
1118 ParseVdexFd(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001119 } else if (option.starts_with("--oat-file=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001120 oat_filenames_.push_back(option.substr(strlen("--oat-file=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001121 } else if (option.starts_with("--oat-symbols=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001122 parser_options->oat_symbols.push_back(option.substr(strlen("--oat-symbols=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001123 } else if (option.starts_with("--oat-fd=")) {
1124 ParseOatFd(option);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001125 } else if (option.starts_with("--oat-location=")) {
1126 oat_location_ = option.substr(strlen("--oat-location=")).data();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001127 } else if (option == "--watch-dog") {
1128 parser_options->watch_dog_enabled = true;
1129 } else if (option == "--no-watch-dog") {
1130 parser_options->watch_dog_enabled = false;
1131 } else if (option.starts_with("-j")) {
1132 ParseJ(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001133 } else if (option.starts_with("--image=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001134 image_filenames_.push_back(option.substr(strlen("--image=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001135 } else if (option.starts_with("--image-classes=")) {
1136 image_classes_filename_ = option.substr(strlen("--image-classes=")).data();
1137 } else if (option.starts_with("--image-classes-zip=")) {
1138 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data();
Mathieu Chartierceb07b32015-12-10 09:33:21 -08001139 } else if (option.starts_with("--image-format=")) {
1140 ParseImageFormat(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001141 } else if (option.starts_with("--compiled-classes=")) {
1142 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data();
1143 } else if (option.starts_with("--compiled-classes-zip=")) {
1144 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data();
1145 } else if (option.starts_with("--compiled-methods=")) {
1146 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data();
1147 } else if (option.starts_with("--compiled-methods-zip=")) {
1148 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data();
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07001149 } else if (option.starts_with("--run-passes=")) {
1150 passes_to_run_filename_ = option.substr(strlen("--run-passes=")).data();
Roland Levillain9ec5e222015-08-17 20:18:41 +01001151 } else if (option.starts_with("--base=")) {
1152 ParseBase(option);
1153 } else if (option.starts_with("--boot-image=")) {
1154 parser_options->boot_image_filename = option.substr(strlen("--boot-image=")).data();
1155 } else if (option.starts_with("--android-root=")) {
1156 android_root_ = option.substr(strlen("--android-root=")).data();
1157 } else if (option.starts_with("--instruction-set=")) {
1158 ParseInstructionSet(option);
1159 } else if (option.starts_with("--instruction-set-variant=")) {
1160 ParseInstructionSetVariant(option, parser_options.get());
1161 } else if (option.starts_with("--instruction-set-features=")) {
1162 ParseInstructionSetFeatures(option, parser_options.get());
1163 } else if (option.starts_with("--compiler-backend=")) {
1164 ParseCompilerBackend(option, parser_options.get());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001165 } else if (option.starts_with("--profile-file=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001166 profile_file_ = option.substr(strlen("--profile-file=")).ToString();
Calin Juravle877fd962016-01-05 14:29:29 +00001167 } else if (option.starts_with("--profile-file-fd=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001168 ParseUintOption(option, "--profile-file-fd", &profile_file_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001169 } else if (option == "--host") {
1170 is_host_ = true;
1171 } else if (option == "--runtime-arg") {
1172 if (++i >= argc) {
1173 Usage("Missing required argument for --runtime-arg");
1174 }
1175 if (log_options) {
1176 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1177 }
1178 runtime_args_.push_back(argv[i]);
1179 } else if (option == "--dump-timing") {
1180 dump_timing_ = true;
1181 } else if (option == "--dump-passes") {
1182 dump_passes_ = true;
Roland Levillain9ec5e222015-08-17 20:18:41 +01001183 } else if (option == "--dump-stats") {
1184 dump_stats_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001185 } else if (option.starts_with("--swap-file=")) {
1186 swap_file_name_ = option.substr(strlen("--swap-file=")).data();
1187 } else if (option.starts_with("--swap-fd=")) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001188 ParseUintOption(option, "--swap-fd", &swap_fd_, Usage);
Andreas Gampee1459ae2016-06-29 09:36:30 -07001189 } else if (option.starts_with("--swap-dex-size-threshold=")) {
1190 ParseUintOption(option,
1191 "--swap-dex-size-threshold",
1192 &min_dex_file_cumulative_size_for_swap_,
1193 Usage);
1194 } else if (option.starts_with("--swap-dex-count-threshold=")) {
1195 ParseUintOption(option,
1196 "--swap-dex-count-threshold",
1197 &min_dex_files_for_swap_,
1198 Usage);
Andreas Gampe67f02822016-06-24 21:05:23 -07001199 } else if (option.starts_with("--very-large-app-threshold=")) {
1200 ParseUintOption(option,
1201 "--very-large-app-threshold",
1202 &very_large_threshold_,
1203 Usage);
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001204 } else if (option.starts_with("--app-image-file=")) {
1205 app_image_file_name_ = option.substr(strlen("--app-image-file=")).data();
1206 } else if (option.starts_with("--app-image-fd=")) {
1207 ParseUintOption(option, "--app-image-fd", &app_image_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001208 } else if (option.starts_with("--verbose-methods=")) {
1209 // TODO: rather than switch off compiler logging, make all VLOG(compiler) messages
1210 // conditional on having verbost methods.
1211 gLogVerbosity.compiler = false;
1212 Split(option.substr(strlen("--verbose-methods=")).ToString(), ',', &verbose_methods_);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001213 } else if (option == "--multi-image") {
Jeff Hao436183f2016-01-12 16:36:50 -08001214 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001215 } else if (option.starts_with("--no-inline-from=")) {
1216 no_inline_from_string_ = option.substr(strlen("--no-inline-from=")).data();
Andreas Gampeace0dc12016-01-20 13:33:13 -08001217 } else if (option == "--force-determinism") {
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001218 if (!SupportsDeterministicCompilation()) {
1219 Usage("Cannot use --force-determinism with read barriers or non-CMS garbage collector");
Roland Levillaineb2c7412016-01-28 14:37:01 +00001220 }
Andreas Gampeace0dc12016-01-20 13:33:13 -08001221 force_determinism_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001222 } else if (!compiler_options_->ParseCompilerOption(option, Usage)) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001223 Usage("Unknown argument %s", option.data());
1224 }
1225 }
1226
Jeff Hao436183f2016-01-12 16:36:50 -08001227 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001228
1229 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001230 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001231 }
1232
Jeff Haodcdc85b2015-12-04 14:06:18 -08001233 // Check whether the oat output files are writable, and open them for later. Also open a swap
1234 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001235 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001236 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1237 PruneNonExistentDexFiles();
1238
Jeff Hao436183f2016-01-12 16:36:50 -08001239 // Expand oat and image filenames for multi image.
1240 if (IsBootImage() && multi_image_) {
1241 ExpandOatAndImageFilenames();
1242 }
1243
David Brazdil7b49e6c2016-09-01 11:06:18 +01001244 // OAT and VDEX file handling
1245
1246 if (oat_fd_ == -1) {
1247 DCHECK(!oat_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08001248 for (const char* oat_filename : oat_filenames_) {
1249 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
1250 if (oat_file.get() == nullptr) {
1251 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1252 return false;
1253 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001254 if (fchmod(oat_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001255 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1256 oat_file->Erase();
1257 return false;
1258 }
1259 oat_files_.push_back(std::move(oat_file));
David Brazdil7b49e6c2016-09-01 11:06:18 +01001260
1261 DCHECK_EQ(vdex_fd_, -1);
1262 std::string vdex_filename = ReplaceFileExtension(oat_filename, "vdex");
1263 std::unique_ptr<File> vdex_file(OS::CreateEmptyFile(vdex_filename.c_str()));
1264 if (vdex_file.get() == nullptr) {
1265 PLOG(ERROR) << "Failed to open vdex file: " << vdex_filename;
1266 return false;
1267 }
1268 if (fchmod(vdex_file->Fd(), 0644) != 0) {
1269 PLOG(ERROR) << "Failed to make vdex file world readable: " << vdex_filename;
1270 vdex_file->Erase();
1271 return false;
1272 }
1273 vdex_files_.push_back(std::move(vdex_file));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001274 }
1275 } else {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001276 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, /* check_usage */ true));
Jeff Haodcdc85b2015-12-04 14:06:18 -08001277 if (oat_file.get() == nullptr) {
1278 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1279 return false;
1280 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001281 oat_file->DisableAutoClose();
1282 if (oat_file->SetLength(0) != 0) {
1283 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1284 }
1285 oat_files_.push_back(std::move(oat_file));
1286
1287 DCHECK_NE(vdex_fd_, -1);
1288 std::string vdex_location = ReplaceFileExtension(oat_location_, "vdex");
1289 std::unique_ptr<File> vdex_file(new File(vdex_fd_, vdex_location, /* check_usage */ true));
1290 if (vdex_file.get() == nullptr) {
1291 PLOG(ERROR) << "Failed to create vdex file: " << vdex_location;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001292 return false;
1293 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01001294 vdex_file->DisableAutoClose();
1295 if (vdex_file->SetLength(0) != 0) {
1296 PLOG(WARNING) << "Truncating vdex file " << vdex_location << " failed.";
1297 }
1298 vdex_files_.push_back(std::move(vdex_file));
1299
Jeff Haodcdc85b2015-12-04 14:06:18 -08001300 oat_filenames_.push_back(oat_location_.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001301 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001302
David Brazdil7b49e6c2016-09-01 11:06:18 +01001303 // Swap file handling
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001304 //
1305 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1306 // that we can use for swap.
1307 //
1308 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1309 // will immediately unlink to satisfy the swap fd assumption.
1310 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1311 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1312 if (swap_file.get() == nullptr) {
1313 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1314 return false;
1315 }
1316 swap_fd_ = swap_file->Fd();
1317 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1318 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1319 // released immediately.
1320 unlink(swap_file_name_.c_str());
1321 }
Jeff Hao436183f2016-01-12 16:36:50 -08001322
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001323 return true;
1324 }
1325
David Brazdil7b49e6c2016-09-01 11:06:18 +01001326 void EraseOutputFiles() {
1327 for (auto& files : { &vdex_files_, &oat_files_ }) {
1328 for (size_t i = 0; i < files->size(); ++i) {
1329 if ((*files)[i].get() != nullptr) {
1330 (*files)[i]->Erase();
1331 (*files)[i].reset();
1332 }
1333 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001334 }
Andreas Gampea650e702014-12-03 14:28:02 -08001335 }
1336
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001337 void Shutdown() {
1338 ScopedObjectAccess soa(Thread::Current());
1339 for (jobject dex_cache : dex_caches_) {
1340 soa.Env()->DeleteLocalRef(dex_cache);
1341 }
1342 dex_caches_.clear();
1343 }
1344
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001345 void LoadClassProfileDescriptors() {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001346 if (profile_compilation_info_ != nullptr && IsAppImage()) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001347 Runtime* runtime = Runtime::Current();
1348 CHECK(runtime != nullptr);
1349 std::set<DexCacheResolvedClasses> resolved_classes(
1350 profile_compilation_info_->GetResolvedClasses());
Mathieu Chartier0b490842016-05-25 15:05:59 -07001351
1352 // Filter out class path classes since we don't want to include these in the image.
1353 std::unordered_set<std::string> dex_files_locations;
1354 for (const DexFile* dex_file : dex_files_) {
1355 dex_files_locations.insert(dex_file->GetLocation());
1356 }
1357 for (auto it = resolved_classes.begin(); it != resolved_classes.end(); ) {
1358 if (dex_files_locations.find(it->GetDexLocation()) == dex_files_locations.end()) {
1359 VLOG(compiler) << "Removed profile samples for non-app dex file " << it->GetDexLocation();
1360 it = resolved_classes.erase(it);
1361 } else {
1362 ++it;
1363 }
1364 }
1365
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001366 image_classes_.reset(new std::unordered_set<std::string>(
1367 runtime->GetClassLinker()->GetClassDescriptorsForProfileKeys(resolved_classes)));
1368 VLOG(compiler) << "Loaded " << image_classes_->size()
1369 << " image class descriptors from profile";
1370 if (VLOG_IS_ON(compiler)) {
1371 for (const std::string& s : *image_classes_) {
1372 LOG(INFO) << "Image class " << s;
1373 }
1374 }
1375 }
1376 }
1377
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001378 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1379 // boot class path.
1380 bool Setup() {
1381 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001382 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap.
Vladimir Marko49b0f452015-12-10 13:49:19 +00001383
1384 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods()) {
1385 return false;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001386 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001387
Vladimir Marko307dac92015-10-20 11:20:09 +01001388 verification_results_.reset(new VerificationResults(compiler_options_.get()));
Andreas Gampe4585f872015-03-27 23:45:15 -07001389 callbacks_.reset(new QuickCompilerCallbacks(
Vladimir Marko307dac92015-10-20 11:20:09 +01001390 verification_results_.get(),
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001391 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001392 CompilerCallbacks::CallbackMode::kCompileBootImage :
1393 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001394
Vladimir Marko49b0f452015-12-10 13:49:19 +00001395 RuntimeArgumentMap runtime_options;
1396 if (!PrepareRuntimeOptions(&runtime_options)) {
1397 return false;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001398 }
1399
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001400 CreateOatWriters();
1401 if (!AddDexFileSources()) {
1402 return false;
1403 }
1404
1405 if (IsBootImage() && image_filenames_.size() > 1) {
1406 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1407 // We need this for the multi-image case.
Mathieu Chartier866d8742016-09-21 15:24:18 -07001408 key_value_store_->Put(OatHeader::kBootClassPathKey,
1409 gc::space::ImageSpace::GetMultiImageBootClassPath(dex_locations_,
1410 oat_filenames_,
1411 image_filenames_));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001412 }
1413
1414 if (!IsBootImage()) {
1415 // When compiling an app, create the runtime early to retrieve
1416 // the image location key needed for the oat header.
1417 if (!CreateRuntime(std::move(runtime_options))) {
1418 return false;
1419 }
1420
Andreas Gampe29d38e72016-03-23 15:31:51 +00001421 if (CompilerFilter::DependsOnImageChecksum(compiler_options_->GetCompilerFilter())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001422 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1423 std::vector<gc::space::ImageSpace*> image_spaces =
1424 Runtime::Current()->GetHeap()->GetBootImageSpaces();
Jeff Haob11ffb72016-04-07 15:40:54 -07001425 image_file_location_oat_checksum_ = OatFileAssistant::CalculateCombinedImageChecksum();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001426 image_file_location_oat_data_begin_ =
1427 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1428 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1429 // Store the boot image filename(s).
1430 std::vector<std::string> image_filenames;
1431 for (const gc::space::ImageSpace* image_space : image_spaces) {
1432 image_filenames.push_back(image_space->GetImageFilename());
1433 }
1434 std::string image_file_location = Join(image_filenames, ':');
1435 if (!image_file_location.empty()) {
1436 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1437 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00001438 } else {
1439 image_file_location_oat_checksum_ = 0u;
1440 image_file_location_oat_data_begin_ = 0u;
1441 image_patch_delta_ = 0;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001442 }
1443
1444 // Open dex files for class path.
1445 const std::vector<std::string> class_path_locations =
1446 GetClassPathLocations(runtime_->GetClassPathString());
Jeff Haofbeb1322016-04-26 14:27:31 -07001447 OpenClassPathFiles(class_path_locations,
1448 &class_path_files_,
1449 &opened_oat_files_,
1450 runtime_->GetInstructionSet());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001451
1452 // Store the classpath we have right now.
1453 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
Jeff Haof0192c82016-03-28 20:39:50 -07001454 std::string encoded_class_path;
1455 if (class_path_locations.size() == 1 &&
1456 class_path_locations[0] == OatFile::kSpecialSharedLibrary) {
1457 // When passing the special shared library as the classpath, it is the only path.
1458 encoded_class_path = OatFile::kSpecialSharedLibrary;
1459 } else {
1460 encoded_class_path = OatFile::EncodeDexFileDependencies(class_path_files);
1461 }
1462 key_value_store_->Put(OatHeader::kClassPathKey, encoded_class_path);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001463 }
1464
1465 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001466 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001467 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1468 rodata_.reserve(oat_writers_.size());
1469 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1470 rodata_.push_back(elf_writers_[i]->StartRoData());
1471 // Unzip or copy dex files straight to the oat file.
1472 std::unique_ptr<MemMap> opened_dex_files_map;
1473 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
David Brazdil7b49e6c2016-09-01 11:06:18 +01001474 if (!oat_writers_[i]->WriteAndOpenDexFiles(
1475 kIsVdexEnabled ? vdex_files_[i].get() : oat_files_[i].get(),
1476 rodata_.back(),
1477 instruction_set_,
1478 instruction_set_features_.get(),
1479 key_value_store_.get(),
1480 /* verify */ true,
1481 &opened_dex_files_map,
1482 &opened_dex_files)) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001483 return false;
1484 }
1485 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1486 if (opened_dex_files_map != nullptr) {
1487 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
1488 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001489 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001490 opened_dex_files_.push_back(std::move(dex_file));
1491 }
1492 } else {
1493 DCHECK(opened_dex_files.empty());
1494 }
1495 }
1496 }
1497
1498 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
Andreas Gampe7386da42016-06-08 18:18:47 -07001499
David Brazdilca3c8c32016-09-06 14:04:48 +01001500 if (!IsBootImage()) {
1501 // Collect verification dependencies when compiling an app.
1502 verifier_deps_.reset(new verifier::VerifierDeps(dex_files_));
1503 callbacks_->SetVerifierDeps(verifier_deps_.get());
1504 }
1505
Andreas Gampe7386da42016-06-08 18:18:47 -07001506 // We had to postpone the swap decision till now, as this is the point when we actually
1507 // know about the dex files we're going to use.
1508
1509 // Make sure that we didn't create the driver, yet.
1510 CHECK(driver_ == nullptr);
1511 // If we use a swap file, ensure we are above the threshold to make it necessary.
1512 if (swap_fd_ != -1) {
1513 if (!UseSwap(IsBootImage(), dex_files_)) {
1514 close(swap_fd_);
1515 swap_fd_ = -1;
1516 VLOG(compiler) << "Decided to run without swap.";
1517 } else {
1518 LOG(INFO) << "Large app, accepted running with swap.";
1519 }
1520 }
1521 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
1522
Andreas Gampe67f02822016-06-24 21:05:23 -07001523 // If we need to downgrade the compiler-filter for size reasons, do that check now.
1524 if (!IsBootImage() && IsVeryLarge(dex_files_)) {
1525 if (!CompilerFilter::IsAsGoodAs(CompilerFilter::kVerifyAtRuntime,
1526 compiler_options_->GetCompilerFilter())) {
1527 LOG(INFO) << "Very large app, downgrading to verify-at-runtime.";
1528 // Note: this change won't be reflected in the key-value store, as that had to be
1529 // finalized before loading the dex files. This setup is currently required
1530 // to get the size from the DexFile objects.
1531 // TODO: refactor. b/29790079
1532 compiler_options_->SetCompilerFilter(CompilerFilter::kVerifyAtRuntime);
1533 }
1534 }
1535
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001536 if (IsBootImage()) {
1537 // For boot image, pass opened dex files to the Runtime::Create().
1538 // Note: Runtime acquires ownership of these dex files.
1539 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001540 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001541 return false;
1542 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001543 }
1544
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001545 // If we're doing the image, override the compiler filter to force full compilation. Must be
1546 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1547 // compilation of class initializers.
1548 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001549 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001550 WellKnownClasses::Init(self->GetJniEnv());
1551
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001552 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001553 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001554 constexpr bool kSaveDexInput = false;
1555 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001556 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001557 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001558
1559 // Handle and ClassLoader creation needs to come after Runtime::Create.
1560 ScopedObjectAccess soa(self);
1561
1562 // Classpath: first the class-path given.
1563 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1564
1565 // Then the dex files we'll compile. Thus we'll resolve the class-path first.
1566 class_path_files.insert(class_path_files.end(), dex_files_.begin(), dex_files_.end());
1567
1568 class_loader_ = class_linker->CreatePathClassLoader(self, class_path_files);
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001569 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001570
1571 // Ensure opened dex files are writable for dex-to-dex transformations.
1572 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1573 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1574 PLOG(ERROR) << "Failed to make .dex files writeable.";
1575 return false;
Vladimir Marko919f5532016-01-20 19:13:01 +00001576 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001577 }
1578
1579 // Ensure that the dex caches stay live since we don't want class unloading
1580 // to occur during compilation.
1581 for (const auto& dex_file : dex_files_) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001582 ScopedObjectAccess soa(self);
1583 dex_caches_.push_back(soa.AddLocalReference<jobject>(
Mathieu Chartierf284d442016-06-02 11:48:30 -07001584 class_linker->RegisterDexFile(*dex_file,
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001585 soa.Decode<mirror::ClassLoader>(class_loader_).Ptr())));
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001586 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001587
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001588 return true;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001589 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001590
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001591 // If we need to keep the oat file open for the image writer.
1592 bool ShouldKeepOatFileOpen() const {
1593 return IsImage() && oat_fd_ != kInvalidFd;
1594 }
1595
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001596 // Create and invoke the compiler driver. This will compile all the dex files.
1597 void Compile() {
1598 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1599 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001600
Vladimir Marko47496c22016-01-27 16:15:08 +00001601 // Find the dex files we should not inline from.
1602
1603 std::vector<std::string> no_inline_filters;
1604 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001605
1606 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001607 const std::string core_oj = "core-oj";
1608 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1609 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001610 }
1611
Vladimir Marko47496c22016-01-27 16:15:08 +00001612 if (!no_inline_filters.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001613 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1614 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1615 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1616 &class_linker->GetBootClassPath(),
1617 &class_path_files,
1618 &dex_files_
1619 };
1620 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001621 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001622 for (const std::string& filter : no_inline_filters) {
1623 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
1624 // allows tests to specify <test-dexfile>:classes2.dex if needed but if the
1625 // base location passes the StartsWith() test, so do all extra locations.
1626 std::string dex_location = dex_file->GetLocation();
1627 if (filter.find('/') == std::string::npos) {
1628 // The filter does not contain the path. Remove the path from dex_location as well.
1629 size_t last_slash = dex_file->GetLocation().rfind('/');
1630 if (last_slash != std::string::npos) {
1631 dex_location = dex_location.substr(last_slash + 1);
1632 }
1633 }
1634
1635 if (StartsWith(dex_location, filter.c_str())) {
1636 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1637 no_inline_from_dex_files_.push_back(dex_file);
1638 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001639 }
1640 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001641 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001642 }
1643 if (!no_inline_from_dex_files_.empty()) {
1644 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001645 }
1646 }
1647
Vladimir Marko307dac92015-10-20 11:20:09 +01001648 driver_.reset(new CompilerDriver(compiler_options_.get(),
1649 verification_results_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001650 compiler_kind_,
1651 instruction_set_,
1652 instruction_set_features_.get(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001653 image_classes_.release(),
1654 compiled_classes_.release(),
Wojciech Staszkiewicz62534792016-08-09 14:30:55 -07001655 compiled_methods_.release(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001656 thread_count_,
1657 dump_stats_,
1658 dump_passes_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001659 compiler_phases_timings_.get(),
1660 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001661 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001662 driver_->SetDexFilesForOatFile(dex_files_);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001663 driver_->CompileAll(class_loader_, dex_files_, timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001664 }
1665
Jeff Hao436183f2016-01-12 16:36:50 -08001666 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001667 // ensure the references between the two are correct.
1668 //
1669 // Currently we have a memory layout that looks something like this:
1670 //
1671 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001672 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001673 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001674 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001675 // +--------------+
1676 // | alloc spaces |
1677 // +--------------+
1678 //
Jeff Hao436183f2016-01-12 16:36:50 -08001679 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001680 //
Jeff Hao436183f2016-01-12 16:36:50 -08001681 // 1. The images are expected to be loaded at an absolute address and
1682 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001683 //
Jeff Hao436183f2016-01-12 16:36:50 -08001684 // 2. There are absolute pointers from Methods in the images to their
1685 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001686 //
Jeff Hao436183f2016-01-12 16:36:50 -08001687 // 3. There are absolute pointers from the code in the oat files to Methods
1688 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001689 //
Jeff Hao436183f2016-01-12 16:36:50 -08001690 // 4. There are absolute pointers from code in the oat files to other code
1691 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001692 //
1693 // To get this all correct, we go through several steps.
1694 //
Jeff Hao436183f2016-01-12 16:36:50 -08001695 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001696 // the oat data size and code size. During this stage, we also set
1697 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001698 //
Jeff Hao436183f2016-01-12 16:36:50 -08001699 // 2. We prepare offsets for the objects in the images and calculate
1700 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001701 //
Jeff Hao436183f2016-01-12 16:36:50 -08001702 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001703 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001704 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001705 // can prepare the ELF headers and we then know the ELF memory segment
1706 // layout and we can now resolve all references. The compiler provides
1707 // LinkerPatch information in each CompiledMethod and we resolve these,
1708 // using the layout information and image object locations provided by
1709 // image writer, as we're writing the method code.
1710 //
Jeff Hao436183f2016-01-12 16:36:50 -08001711 // 4. We create the image files. They need to know where the oat files
1712 // will be loaded after itself. Originally oat files were simply
1713 // memory mapped so we could predict where their contents were based
1714 // on the file size. Now that they are ELF files, we need to inspect
1715 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001716 // where the oat header is located within.
1717 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001718 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001719 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001720 // load the .so at the desired location at runtime by offsetting the
1721 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001722 // TODO: Do this in step 3. We already know the layout there.
1723 //
1724 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1725 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001726
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001727 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1728 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001729 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1730 // case (when the file will be explicitly erased).
David Brazdil7b49e6c2016-09-01 11:06:18 +01001731 bool WriteOutputFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001732 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1733
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001734 // Sync the data to the file, in case we did dex2dex transformations.
1735 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1736 if (!map->Sync()) {
1737 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1738 return false;
1739 }
1740 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001741
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001742 if (IsImage()) {
Vladimir Markoaad75c62016-10-03 08:46:48 +00001743 if (IsAppImage() && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001744 gc::Heap* const heap = Runtime::Current()->GetHeap();
1745 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001746 image_base_ = std::max(image_base_, RoundUp(
1747 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1748 kPageSize));
1749 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001750 // The non moving space is right after the oat file. Put the preferred app image location
1751 // right after the non moving space so that we ideally get a continuous immune region for
1752 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001753 // Use the default non moving space capacity since dex2oat does not have a separate non-
1754 // moving space. This means the runtime's non moving space space size will be as large
1755 // as the growth limit for dex2oat, but smaller in the zygote.
1756 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001757 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001758 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1759 }
1760
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001761 image_writer_.reset(new ImageWriter(*driver_,
1762 image_base_,
1763 compiler_options_->GetCompilePic(),
1764 IsAppImage(),
1765 image_storage_mode_,
1766 oat_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00001767 dex_file_oat_index_map_));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001768
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001769 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001770 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1771 if (!image_writer_->PrepareImageAddressSpace()) {
1772 LOG(ERROR) << "Failed to prepare image address space.";
1773 return false;
1774 }
1775 }
1776
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001777 // Initialize the writers with the compiler driver, image writer, and their
1778 // dex files. The writers were created without those being there yet.
1779 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1780 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
1781 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1782 oat_writer->Initialize(driver_.get(), image_writer_.get(), dex_files);
1783 }
1784
David Brazdil5d5a36b2016-09-14 15:34:10 +01001785 {
1786 TimingLogger::ScopedTiming t2("dex2oat Write VDEX", timings_);
1787 DCHECK(IsBootImage() || oat_files_.size() == 1u);
1788 DCHECK_EQ(IsBootImage(), verifier_deps_ == nullptr);
1789 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
1790 File* vdex_file = vdex_files_[i].get();
1791 std::unique_ptr<BufferedOutputStream> vdex_out(
1792 MakeUnique<BufferedOutputStream>(MakeUnique<FileOutputStream>(vdex_file)));
1793
1794 if (!oat_writers_[i]->WriteVerifierDeps(vdex_out.get(), verifier_deps_.get())) {
1795 LOG(ERROR) << "Failed to write verifier dependencies into VDEX " << vdex_file->GetPath();
1796 return false;
1797 }
1798
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001799 if (!oat_writers_[i]->WriteQuickeningInfo(vdex_out.get())) {
1800 LOG(ERROR) << "Failed to write quickening info into VDEX " << vdex_file->GetPath();
1801 return false;
1802 }
1803
David Brazdil5d5a36b2016-09-14 15:34:10 +01001804 // VDEX finalized, seek back to the beginning and write the header.
1805 if (!oat_writers_[i]->WriteVdexHeader(vdex_out.get())) {
1806 LOG(ERROR) << "Failed to write vdex header into VDEX " << vdex_file->GetPath();
1807 return false;
1808 }
1809 }
1810 }
1811
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001812 {
1813 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001814 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001815 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko944da602016-02-19 12:27:55 +00001816 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1817 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
1818
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001819 oat_writer->PrepareLayout(&patcher);
Vladimir Marko944da602016-02-19 12:27:55 +00001820
1821 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
David Brazdil7b49e6c2016-09-01 11:06:18 +01001822 size_t text_size = oat_writer->GetOatSize() - rodata_size;
Vladimir Markoaad75c62016-10-03 08:46:48 +00001823 elf_writer->PrepareDynamicSection(rodata_size,
1824 text_size,
1825 oat_writer->GetBssSize(),
1826 oat_writer->GetBssRootsOffset());
Vladimir Marko944da602016-02-19 12:27:55 +00001827
1828 if (IsImage()) {
1829 // Update oat layout.
1830 DCHECK(image_writer_ != nullptr);
1831 DCHECK_LT(i, oat_filenames_.size());
1832 image_writer_->UpdateOatFileLayout(i,
1833 elf_writer->GetLoadedSize(),
1834 oat_writer->GetOatDataOffset(),
David Brazdil7b49e6c2016-09-01 11:06:18 +01001835 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +00001836 }
1837 }
1838
1839 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001840 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001841 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1842 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00001843
David Srbecky09c2a6b2016-03-11 17:11:44 +00001844 oat_writer->AddMethodDebugInfos(debug::MakeTrampolineInfos(oat_writer->GetOatHeader()));
1845
David Srbecky0c4572e2016-01-22 19:19:25 +00001846 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00001847 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
1848 elf_writer->PrepareDebugInfo(oat_writer->GetMethodDebugInfo());
David Srbecky0c4572e2016-01-22 19:19:25 +00001849
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001850 OutputStream*& rodata = rodata_[i];
1851 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001852 if (!oat_writer->WriteRodata(rodata)) {
1853 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
1854 return false;
1855 }
1856 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001857 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00001858
Jeff Haodcdc85b2015-12-04 14:06:18 -08001859 OutputStream* text = elf_writer->StartText();
1860 if (!oat_writer->WriteCode(text)) {
1861 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
1862 return false;
1863 }
1864 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00001865
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001866 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
1867 image_file_location_oat_checksum_,
1868 image_file_location_oat_data_begin_,
1869 image_patch_delta_)) {
1870 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
1871 return false;
1872 }
1873
Vladimir Marko944da602016-02-19 12:27:55 +00001874 if (IsImage()) {
1875 // Update oat header information.
1876 DCHECK(image_writer_ != nullptr);
1877 DCHECK_LT(i, oat_filenames_.size());
1878 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
1879 }
1880
Jeff Haodcdc85b2015-12-04 14:06:18 -08001881 elf_writer->WriteDynamicSection();
1882 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
1883 elf_writer->WritePatchLocations(oat_writer->GetAbsolutePatchLocations());
Vladimir Marko10c13562015-11-25 14:33:36 +00001884
Jeff Haodcdc85b2015-12-04 14:06:18 -08001885 if (!elf_writer->End()) {
1886 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
1887 return false;
1888 }
1889
David Brazdil7b49e6c2016-09-01 11:06:18 +01001890 if (!FlushOutputFile(&vdex_files_[i]) || !FlushOutputFile(&oat_files_[i])) {
1891 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001892 }
1893
Jeff Haodcdc85b2015-12-04 14:06:18 -08001894 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001895
1896 oat_writer.reset();
1897 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001898 }
1899 }
1900
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001901 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001902 }
1903
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001904 // If we are compiling an image, invoke the image creation routine. Else just skip.
1905 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001906 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001907 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
1908 if (!CreateImageFile()) {
1909 return false;
1910 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001911 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07001912 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001913 return true;
1914 }
1915
Jeff Haodcdc85b2015-12-04 14:06:18 -08001916 // Create a copy from stripped to unstripped.
1917 bool CopyStrippedToUnstripped() {
1918 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
1919 // If we don't want to strip in place, copy from stripped location to unstripped location.
1920 // We need to strip after image creation because FixupElf needs to use .strtab.
1921 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
1922 // If the oat file is still open, flush it.
1923 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01001924 if (!FlushCloseOutputFile(&oat_files_[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001925 return false;
1926 }
1927 }
1928
1929 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
1930 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
1931 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
Vladimir Markob55cc6d2016-10-17 15:25:10 +01001932 int64_t in_length = in->GetLength();
1933 if (in_length < 0) {
1934 PLOG(ERROR) << "Failed to get the length of oat file: " << in->GetPath();
1935 return false;
1936 }
1937 if (!out->Copy(in.get(), 0, in_length)) {
1938 PLOG(ERROR) << "Failed to copy oat file to file: " << out->GetPath();
1939 return false;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001940 }
1941 if (out->FlushCloseOrErase() != 0) {
1942 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
1943 return false;
1944 }
1945 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
1946 }
1947 }
1948 return true;
1949 }
1950
David Brazdil7b49e6c2016-09-01 11:06:18 +01001951 bool FlushOutputFile(std::unique_ptr<File>* file) {
1952 if (file->get() != nullptr) {
1953 if (file->get()->Flush() != 0) {
1954 PLOG(ERROR) << "Failed to flush output file: " << file->get()->GetPath();
1955 return false;
1956 }
1957 }
1958 return true;
1959 }
1960
1961 bool FlushCloseOutputFile(std::unique_ptr<File>* file) {
1962 if (file->get() != nullptr) {
1963 std::unique_ptr<File> tmp(file->release());
1964 if (tmp->FlushCloseOrErase() != 0) {
1965 PLOG(ERROR) << "Failed to flush and close output file: " << tmp->GetPath();
1966 return false;
1967 }
1968 }
1969 return true;
1970 }
1971
1972 bool FlushOutputFiles() {
1973 TimingLogger::ScopedTiming t2("dex2oat Flush Output Files", timings_);
1974 for (auto& files : { &vdex_files_, &oat_files_ }) {
1975 for (size_t i = 0; i < files->size(); ++i) {
1976 if (!FlushOutputFile(&(*files)[i])) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08001977 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001978 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001979 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00001980 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08001981 return true;
1982 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001983
David Brazdil7b49e6c2016-09-01 11:06:18 +01001984 bool FlushCloseOutputFiles() {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001985 bool result = true;
David Brazdil7b49e6c2016-09-01 11:06:18 +01001986 for (auto& files : { &vdex_files_, &oat_files_ }) {
1987 for (size_t i = 0; i < files->size(); ++i) {
1988 result &= FlushCloseOutputFile(&(*files)[i]);
1989 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001990 }
1991 return result;
1992 }
1993
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001994 void DumpTiming() {
1995 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
1996 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
1997 }
1998 if (dump_passes_) {
1999 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
2000 }
2001 }
2002
Andreas Gampe10e477d2014-11-19 12:57:42 -08002003 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002004 return IsAppImage() || IsBootImage();
2005 }
2006
2007 bool IsAppImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002008 return compiler_options_->IsAppImage();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002009 }
2010
2011 bool IsBootImage() const {
Vladimir Markoaad75c62016-10-03 08:46:48 +00002012 return compiler_options_->IsBootImage();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002013 }
2014
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002015 bool IsHost() const {
2016 return is_host_;
2017 }
2018
Calin Juravle998c2162015-12-21 15:39:33 +02002019 bool UseProfileGuidedCompilation() const {
Andreas Gampe29d38e72016-03-23 15:31:51 +00002020 return CompilerFilter::DependsOnProfile(compiler_options_->GetCompilerFilter());
Calin Juravle998c2162015-12-21 15:39:33 +02002021 }
2022
Calin Juravle2e2db782016-02-23 12:00:03 +00002023 bool LoadProfile() {
Calin Juravle998c2162015-12-21 15:39:33 +02002024 DCHECK(UseProfileGuidedCompilation());
Calin Juravle2e2db782016-02-23 12:00:03 +00002025
2026 profile_compilation_info_.reset(new ProfileCompilationInfo());
2027 ScopedFlock flock;
Andreas Gampe29d38e72016-03-23 15:31:51 +00002028 bool success = true;
Calin Juravle2e2db782016-02-23 12:00:03 +00002029 std::string error;
2030 if (profile_file_fd_ != -1) {
2031 // The file doesn't need to be flushed so don't check the usage.
2032 // Pass a bogus path so that we can easily attribute any reported error.
2033 File file(profile_file_fd_, "profile", /*check_usage*/ false, /*read_only_mode*/ true);
2034 if (flock.Init(&file, &error)) {
2035 success = profile_compilation_info_->Load(profile_file_fd_);
2036 }
Andreas Gampe29d38e72016-03-23 15:31:51 +00002037 } else if (profile_file_ != "") {
Calin Juravle2e2db782016-02-23 12:00:03 +00002038 if (flock.Init(profile_file_.c_str(), O_RDONLY, /* block */ true, &error)) {
2039 success = profile_compilation_info_->Load(flock.GetFile()->Fd());
2040 }
2041 }
2042 if (!error.empty()) {
2043 LOG(WARNING) << "Cannot lock profiles: " << error;
Calin Juravle998c2162015-12-21 15:39:33 +02002044 }
Calin Juravle877fd962016-01-05 14:29:29 +00002045
Calin Juravle2e2db782016-02-23 12:00:03 +00002046 if (!success) {
2047 profile_compilation_info_.reset(nullptr);
2048 }
Calin Juravle877fd962016-01-05 14:29:29 +00002049
Calin Juravle2e2db782016-02-23 12:00:03 +00002050 return success;
Calin Juravle998c2162015-12-21 15:39:33 +02002051 }
2052
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002053 private:
Andreas Gampee1459ae2016-06-29 09:36:30 -07002054 bool UseSwap(bool is_image, const std::vector<const DexFile*>& dex_files) {
2055 if (is_image) {
2056 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
2057 return false;
2058 }
2059 if (dex_files.size() < min_dex_files_for_swap_) {
2060 // If there are less dex files than the threshold, assume it's gonna be fine.
2061 return false;
2062 }
2063 size_t dex_files_size = 0;
2064 for (const auto* dex_file : dex_files) {
2065 dex_files_size += dex_file->GetHeader().file_size_;
2066 }
2067 return dex_files_size >= min_dex_file_cumulative_size_for_swap_;
2068 }
2069
Andreas Gampe67f02822016-06-24 21:05:23 -07002070 bool IsVeryLarge(std::vector<const DexFile*>& dex_files) {
2071 size_t dex_files_size = 0;
2072 for (const auto* dex_file : dex_files) {
2073 dex_files_size += dex_file->GetHeader().file_size_;
2074 }
2075 return dex_files_size >= very_large_threshold_;
2076 }
2077
Vladimir Marko49b0f452015-12-10 13:49:19 +00002078 template <typename T>
2079 static std::vector<T*> MakeNonOwningPointerVector(const std::vector<std::unique_ptr<T>>& src) {
2080 std::vector<T*> result;
2081 result.reserve(src.size());
2082 for (const std::unique_ptr<T>& t : src) {
2083 result.push_back(t.get());
2084 }
2085 return result;
2086 }
2087
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002088 std::vector<std::string> GetClassPathLocations(const std::string& class_path) {
2089 // This function is used only for apps and for an app we have exactly one oat file.
2090 DCHECK(!IsBootImage());
2091 DCHECK_EQ(oat_writers_.size(), 1u);
2092 std::vector<std::string> dex_files_canonical_locations;
2093 for (const char* location : oat_writers_[0]->GetSourceLocations()) {
2094 dex_files_canonical_locations.push_back(DexFile::GetDexCanonicalLocation(location));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002095 }
Vladimir Marko625a64a2015-11-26 14:44:16 +00002096
Vladimir Marko919f5532016-01-20 19:13:01 +00002097 std::vector<std::string> parsed;
2098 Split(class_path, ':', &parsed);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002099 auto kept_it = std::remove_if(parsed.begin(),
2100 parsed.end(),
2101 [dex_files_canonical_locations](const std::string& location) {
2102 return ContainsElement(dex_files_canonical_locations,
2103 DexFile::GetDexCanonicalLocation(location.c_str()));
2104 });
2105 parsed.erase(kept_it, parsed.end());
2106 return parsed;
2107 }
2108
Jeff Haofbeb1322016-04-26 14:27:31 -07002109 // Opens requested class path files and appends them to opened_dex_files. If the dex files have
2110 // been stripped, this opens them from their oat files and appends them to opened_oat_files.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002111 static void OpenClassPathFiles(const std::vector<std::string>& class_path_locations,
Jeff Haof0192c82016-03-28 20:39:50 -07002112 std::vector<std::unique_ptr<const DexFile>>* opened_dex_files,
Jeff Haofbeb1322016-04-26 14:27:31 -07002113 std::vector<std::unique_ptr<OatFile>>* opened_oat_files,
Jeff Haof0192c82016-03-28 20:39:50 -07002114 InstructionSet isa) {
Jeff Haofbeb1322016-04-26 14:27:31 -07002115 DCHECK(opened_dex_files != nullptr) << "OpenClassPathFiles dex out-param is nullptr";
2116 DCHECK(opened_oat_files != nullptr) << "OpenClassPathFiles oat out-param is nullptr";
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002117 for (const std::string& location : class_path_locations) {
Jeff Haof0192c82016-03-28 20:39:50 -07002118 // Stop early if we detect the special shared library, which may be passed as the classpath
2119 // for dex2oat when we want to skip the shared libraries check.
2120 if (location == OatFile::kSpecialSharedLibrary) {
2121 break;
2122 }
Aart Bik37d6a3b2016-06-21 18:30:10 -07002123 static constexpr bool kVerifyChecksum = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002124 std::string error_msg;
Aart Bik37d6a3b2016-06-21 18:30:10 -07002125 if (!DexFile::Open(
2126 location.c_str(), location.c_str(), kVerifyChecksum, &error_msg, opened_dex_files)) {
Jeff Haof0192c82016-03-28 20:39:50 -07002127 // If we fail to open the dex file because it's been stripped, try to open the dex file
2128 // from its corresponding oat file.
Richard Uhlerd1472a22016-04-15 15:18:56 -07002129 OatFileAssistant oat_file_assistant(location.c_str(), isa, false);
Jeff Haof0192c82016-03-28 20:39:50 -07002130 std::unique_ptr<OatFile> oat_file(oat_file_assistant.GetBestOatFile());
2131 if (oat_file == nullptr) {
2132 LOG(WARNING) << "Failed to open dex file and associated oat file for '" << location
2133 << "': " << error_msg;
2134 } else {
2135 std::vector<std::unique_ptr<const DexFile>> oat_dex_files =
2136 oat_file_assistant.LoadDexFiles(*oat_file, location.c_str());
Jeff Haofbeb1322016-04-26 14:27:31 -07002137 opened_oat_files->push_back(std::move(oat_file));
Jeff Haof0192c82016-03-28 20:39:50 -07002138 opened_dex_files->insert(opened_dex_files->end(),
2139 std::make_move_iterator(oat_dex_files.begin()),
2140 std::make_move_iterator(oat_dex_files.end()));
2141 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002142 }
2143 }
2144 }
2145
Vladimir Marko49b0f452015-12-10 13:49:19 +00002146 bool PrepareImageClasses() {
2147 // If --image-classes was specified, calculate the full list of classes to include in the image.
2148 if (image_classes_filename_ != nullptr) {
2149 image_classes_ =
2150 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
2151 if (image_classes_ == nullptr) {
2152 return false;
2153 }
2154 } else if (IsBootImage()) {
2155 image_classes_.reset(new std::unordered_set<std::string>);
2156 }
2157 return true;
2158 }
2159
2160 bool PrepareCompiledClasses() {
2161 // If --compiled-classes was specified, calculate the full list of classes to compile in the
2162 // image.
2163 if (compiled_classes_filename_ != nullptr) {
2164 compiled_classes_ =
2165 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
2166 if (compiled_classes_ == nullptr) {
2167 return false;
2168 }
2169 } else {
2170 compiled_classes_.reset(nullptr); // By default compile everything.
2171 }
2172 return true;
2173 }
2174
2175 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2176 const char* classes_filename,
2177 const char* tag) {
2178 std::unique_ptr<std::unordered_set<std::string>> classes;
2179 std::string error_msg;
2180 if (zip_filename != nullptr) {
2181 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2182 } else {
2183 classes.reset(ReadImageClassesFromFile(classes_filename));
2184 }
2185 if (classes == nullptr) {
2186 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2187 << classes_filename << "': " << error_msg;
2188 }
2189 return classes;
2190 }
2191
2192 bool PrepareCompiledMethods() {
2193 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2194 if (compiled_methods_filename_ != nullptr) {
2195 std::string error_msg;
2196 if (compiled_methods_zip_filename_ != nullptr) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002197 compiled_methods_.reset(ReadCommentedInputFromZip<std::unordered_set<std::string>>(
2198 compiled_methods_zip_filename_,
2199 compiled_methods_filename_,
2200 nullptr, // No post-processing.
2201 &error_msg));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002202 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002203 compiled_methods_.reset(ReadCommentedInputFromFile<std::unordered_set<std::string>>(
2204 compiled_methods_filename_,
2205 nullptr)); // No post-processing.
Vladimir Marko49b0f452015-12-10 13:49:19 +00002206 }
2207 if (compiled_methods_.get() == nullptr) {
2208 LOG(ERROR) << "Failed to create list of compiled methods from '"
2209 << compiled_methods_filename_ << "': " << error_msg;
2210 return false;
2211 }
2212 } else {
2213 compiled_methods_.reset(nullptr); // By default compile everything.
2214 }
2215 return true;
2216 }
2217
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002218 void PruneNonExistentDexFiles() {
2219 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2220 size_t kept = 0u;
2221 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2222 if (!OS::FileExists(dex_filenames_[i])) {
2223 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2224 } else {
2225 dex_filenames_[kept] = dex_filenames_[i];
2226 dex_locations_[kept] = dex_locations_[i];
2227 ++kept;
2228 }
2229 }
2230 dex_filenames_.resize(kept);
2231 dex_locations_.resize(kept);
2232 }
2233
2234 bool AddDexFileSources() {
2235 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
2236 if (zip_fd_ != -1) {
2237 DCHECK_EQ(oat_writers_.size(), 1u);
Andreas Gampe43e10b02016-07-15 17:17:34 -07002238 if (!oat_writers_[0]->AddZippedDexFilesSource(File(zip_fd_, /* check_usage */ false),
2239 zip_location_.c_str())) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002240 return false;
2241 }
2242 } else if (oat_writers_.size() > 1u) {
2243 // Multi-image.
2244 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2245 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2246 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2247 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2248 return false;
2249 }
2250 }
2251 } else {
2252 DCHECK_EQ(oat_writers_.size(), 1u);
2253 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2254 DCHECK_NE(dex_filenames_.size(), 0u);
2255 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2256 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2257 return false;
2258 }
2259 }
2260 }
2261 return true;
2262 }
2263
2264 void CreateOatWriters() {
2265 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2266 elf_writers_.reserve(oat_files_.size());
2267 oat_writers_.reserve(oat_files_.size());
2268 for (const std::unique_ptr<File>& oat_file : oat_files_) {
David Srbecky5d811202016-03-08 13:21:22 +00002269 elf_writers_.emplace_back(CreateElfWriterQuick(instruction_set_,
2270 instruction_set_features_.get(),
2271 compiler_options_.get(),
2272 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002273 elf_writers_.back()->Start();
2274 oat_writers_.emplace_back(new OatWriter(IsBootImage(), timings_));
2275 }
2276 }
2277
Vladimir Marko49b0f452015-12-10 13:49:19 +00002278 void SaveDexInput() {
2279 for (size_t i = 0; i < dex_files_.size(); ++i) {
2280 const DexFile* dex_file = dex_files_[i];
2281 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2282 getpid(), i));
2283 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2284 if (tmp_file.get() == nullptr) {
2285 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2286 << ". Try: adb shell chmod 777 /data/local/tmp";
2287 continue;
2288 }
2289 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2290 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2291 UNUSED(tmp_file->Flush());
2292 UNUSED(tmp_file->Close());
2293 LOG(INFO) << "Wrote input to " << tmp_file_name;
2294 }
2295 }
2296
2297 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options) {
2298 RuntimeOptions raw_options;
2299 if (boot_image_filename_.empty()) {
2300 std::string boot_class_path = "-Xbootclasspath:";
2301 boot_class_path += Join(dex_filenames_, ':');
2302 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2303 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
2304 boot_class_path_locations += Join(dex_locations_, ':');
2305 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2306 } else {
2307 std::string boot_image_option = "-Ximage:";
2308 boot_image_option += boot_image_filename_;
2309 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2310 }
2311 for (size_t i = 0; i < runtime_args_.size(); i++) {
2312 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2313 }
2314
2315 raw_options.push_back(std::make_pair("compilercallbacks", callbacks_.get()));
2316 raw_options.push_back(
2317 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2318
2319 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2320 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2321 // have been stripped in preopting, anyways).
2322 if (!IsBootImage()) {
2323 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2324 }
2325 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2326 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2327 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002328 // Disable Hspace compaction to save heap size virtual space.
2329 // Only need disable Hspace for OOM becasue background collector is equal to
2330 // foreground collector by default for dex2oat.
2331 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002332
Andreas Gampeace0dc12016-01-20 13:33:13 -08002333 // If we're asked to be deterministic, ensure non-concurrent GC for determinism. Also
2334 // force the free-list implementation for large objects.
2335 if (compiler_options_->IsForceDeterminism()) {
2336 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
2337 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=freelist", nullptr));
2338
2339 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2340 // compaction (done above) and ensure that neither foreground nor background collectors
2341 // are concurrent.
2342 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2343
2344 // To make identity hashcode deterministic, set a known seed.
2345 mirror::Object::SetHashCodeSeed(987654321U);
2346 }
2347
Vladimir Marko49b0f452015-12-10 13:49:19 +00002348 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2349 LOG(ERROR) << "Failed to parse runtime options";
2350 return false;
2351 }
2352 return true;
2353 }
2354
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002355 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002356 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2357 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002358 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002359 LOG(ERROR) << "Failed to create runtime";
2360 return false;
2361 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002362 runtime_.reset(Runtime::Current());
2363 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002364 for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) {
2365 Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002366 if (!runtime_->HasCalleeSaveMethod(type)) {
2367 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002368 }
2369 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002370 runtime_->GetClassLinker()->FixupDexCaches(runtime_->GetResolutionMethod());
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002371
2372 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2373 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002374 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002375
Vladimir Marko307dac92015-10-20 11:20:09 +01002376 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002377
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002378 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2379 // Runtime::Start, give it away now so that we don't starve GC.
2380 Thread* self = Thread::Current();
2381 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002382
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002383 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002384 }
2385
Jeff Haodcdc85b2015-12-04 14:06:18 -08002386 // 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 -08002387 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002388 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002389 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002390 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002391 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002392 image_filenames_.push_back(app_image_file_name_.c_str());
2393 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002394 if (!image_writer_->Write(app_image_fd_,
2395 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002396 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002397 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002398 return false;
2399 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002400
Jeff Haodcdc85b2015-12-04 14:06:18 -08002401 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002402 dchecked_vector<uintptr_t> oat_data_begins;
2403 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2404 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002405 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002406 // Destroy ImageWriter before doing FixupElf.
2407 image_writer_.reset();
2408
Vladimir Marko944da602016-02-19 12:27:55 +00002409 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2410 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002411 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2412 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2413 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2414 if (oat_file.get() == nullptr) {
2415 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2416 return false;
2417 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002418
Vladimir Marko944da602016-02-19 12:27:55 +00002419 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002420 oat_file->Erase();
2421 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2422 return false;
2423 }
2424
2425 if (oat_file->FlushCloseOrErase()) {
2426 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2427 return false;
2428 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002429 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002430 }
2431
2432 return true;
2433 }
2434
2435 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002436 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2437 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002438 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002439 return ReadCommentedInputFromFile<std::unordered_set<std::string>>(image_classes_filename,
2440 &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002441 }
2442
2443 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002444 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002445 const char* zip_filename,
2446 const char* image_classes_filename,
2447 std::string* error_msg) {
2448 std::function<std::string(const char*)> process = DotToDescriptor;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002449 return ReadCommentedInputFromZip<std::unordered_set<std::string>>(zip_filename,
2450 image_classes_filename,
2451 &process,
2452 error_msg);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002453 }
2454
2455 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2456 // the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002457 template <typename T>
2458 static T* ReadCommentedInputFromFile(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002459 const char* input_filename, std::function<std::string(const char*)>* process) {
2460 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2461 if (input_file.get() == nullptr) {
2462 LOG(ERROR) << "Failed to open input file " << input_filename;
2463 return nullptr;
2464 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002465 std::unique_ptr<T> result(
2466 ReadCommentedInputStream<T>(*input_file, process));
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002467 input_file->close();
2468 return result.release();
2469 }
2470
2471 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2472 // Post-process each line with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002473 template <typename T>
2474 static T* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002475 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002476 const char* input_filename,
2477 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002478 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002479 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2480 if (zip_archive.get() == nullptr) {
2481 return nullptr;
2482 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002483 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002484 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002485 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002486 zip_filename, error_msg->c_str());
2487 return nullptr;
2488 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002489 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2490 input_filename,
2491 error_msg));
2492 if (input_file.get() == nullptr) {
2493 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002494 zip_filename, error_msg->c_str());
2495 return nullptr;
2496 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002497 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2498 input_file->Size());
2499 std::istringstream input_stream(input_string);
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002500 return ReadCommentedInputStream<T>(input_stream, process);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002501 }
2502
2503 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2504 // with the given function.
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002505 template <typename T>
2506 static T* ReadCommentedInputStream(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002507 std::istream& in_stream,
2508 std::function<std::string(const char*)>* process) {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002509 std::unique_ptr<T> output(new T());
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002510 while (in_stream.good()) {
2511 std::string dot;
2512 std::getline(in_stream, dot);
2513 if (StartsWith(dot, "#") || dot.empty()) {
2514 continue;
2515 }
2516 if (process != nullptr) {
2517 std::string descriptor((*process)(dot.c_str()));
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002518 output->insert(output->end(), descriptor);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002519 } else {
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002520 output->insert(output->end(), dot);
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002521 }
2522 }
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002523 return output.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002524 }
2525
Mathieu Chartier49285c52014-12-02 15:43:48 -08002526 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002527 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2528 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002529 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002530 LOG(INFO) << "dex2oat took " << PrettyDuration(NanoTime() - start_ns_)
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002531 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002532 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002533 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2534 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002535 }
2536
Jeff Haodcdc85b2015-12-04 14:06:18 -08002537 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2538 std::string res(image_filename);
2539 size_t last_slash = res.rfind('/');
2540 if (last_slash == std::string::npos || last_slash == 0) {
2541 return res;
2542 }
2543 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2544 if (penultimate_slash == std::string::npos) {
2545 return res;
2546 }
2547 // Check that the string in-between is the expected one.
2548 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2549 GetInstructionSetString(isa)) {
2550 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2551 return res;
2552 }
2553 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2554 }
2555
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002556 std::unique_ptr<CompilerOptions> compiler_options_;
2557 Compiler::Kind compiler_kind_;
2558
2559 InstructionSet instruction_set_;
2560 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2561
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002562 uint32_t image_file_location_oat_checksum_;
2563 uintptr_t image_file_location_oat_data_begin_;
2564 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002565 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2566
Vladimir Marko307dac92015-10-20 11:20:09 +01002567 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002568
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002569 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2570
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002571 std::unique_ptr<Runtime> runtime_;
2572
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002573 // Ownership for the class path files.
2574 std::vector<std::unique_ptr<const DexFile>> class_path_files_;
2575
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002576 size_t thread_count_;
2577 uint64_t start_ns_;
2578 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002579 std::vector<std::unique_ptr<File>> oat_files_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002580 std::vector<std::unique_ptr<File>> vdex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002581 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002582 std::vector<const char*> oat_filenames_;
2583 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002584 int oat_fd_;
David Brazdil7b49e6c2016-09-01 11:06:18 +01002585 int vdex_fd_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002586 std::vector<const char*> dex_filenames_;
2587 std::vector<const char*> dex_locations_;
2588 int zip_fd_;
2589 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002590 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002591 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002592 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002593 uintptr_t image_base_;
2594 const char* image_classes_zip_filename_;
2595 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002596 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002597 const char* compiled_classes_zip_filename_;
2598 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002599 const char* compiled_methods_zip_filename_;
2600 const char* compiled_methods_filename_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002601 const char* passes_to_run_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002602 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2603 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002604 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Wojciech Staszkiewicz5319d3c2016-08-01 17:48:59 -07002605 std::unique_ptr<std::vector<std::string>> passes_to_run_;
Jeff Hao436183f2016-01-12 16:36:50 -08002606 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002607 bool is_host_;
2608 std::string android_root_;
Mathieu Chartier0b490842016-05-25 15:05:59 -07002609 // Dex files we are compiling, does not include the class path dex files.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002610 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002611 std::string no_inline_from_string_;
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002612 std::vector<jobject> dex_caches_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002613 jobject class_loader_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002614
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002615 std::vector<std::unique_ptr<ElfWriter>> elf_writers_;
2616 std::vector<std::unique_ptr<OatWriter>> oat_writers_;
2617 std::vector<OutputStream*> rodata_;
David Brazdil5d5a36b2016-09-14 15:34:10 +01002618 std::vector<std::unique_ptr<OutputStream>> vdex_out_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002619 std::unique_ptr<ImageWriter> image_writer_;
2620 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002621
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002622 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
Jeff Haofbeb1322016-04-26 14:27:31 -07002623 std::vector<std::unique_ptr<OatFile>> opened_oat_files_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002624 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2625
Vladimir Marko47496c22016-01-27 16:15:08 +00002626 std::vector<const DexFile*> no_inline_from_dex_files_;
2627
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002628 std::vector<std::string> verbose_methods_;
2629 bool dump_stats_;
2630 bool dump_passes_;
2631 bool dump_timing_;
2632 bool dump_slow_timing_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002633 std::string swap_file_name_;
2634 int swap_fd_;
Andreas Gampee1459ae2016-06-29 09:36:30 -07002635 size_t min_dex_files_for_swap_ = kDefaultMinDexFilesForSwap;
2636 size_t min_dex_file_cumulative_size_for_swap_ = kDefaultMinDexFileCumulativeSizeForSwap;
Andreas Gampe67f02822016-06-24 21:05:23 -07002637 size_t very_large_threshold_ = std::numeric_limits<size_t>::max();
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002638 std::string app_image_file_name_;
2639 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002640 std::string profile_file_;
2641 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002642 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002643 TimingLogger* timings_;
2644 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002645 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002646 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002647
David Brazdilca3c8c32016-09-06 14:04:48 +01002648 // Collector of verifier dependencies.
2649 std::unique_ptr<verifier::VerifierDeps> verifier_deps_;
2650
Jeff Haodcdc85b2015-12-04 14:06:18 -08002651 // Backing storage.
2652 std::vector<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002653
Andreas Gampeace0dc12016-01-20 13:33:13 -08002654 // See CompilerOptions.force_determinism_.
2655 bool force_determinism_;
2656
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002657 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2658};
2659
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002660static void b13564922() {
2661#if defined(__linux__) && defined(__arm__)
2662 int major, minor;
2663 struct utsname uts;
2664 if (uname(&uts) != -1 &&
2665 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2666 ((major < 3) || ((major == 3) && (minor < 4)))) {
2667 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2668 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2669 int old_personality = personality(0xffffffff);
2670 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2671 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2672 if (new_personality == -1) {
2673 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2674 }
2675 }
2676 }
2677#endif
2678}
2679
Andreas Gampe10e477d2014-11-19 12:57:42 -08002680static int CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002681 dex2oat.LoadClassProfileDescriptors();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002682 dex2oat.Compile();
2683
David Brazdil7b49e6c2016-09-01 11:06:18 +01002684 if (!dex2oat.WriteOutputFiles()) {
2685 dex2oat.EraseOutputFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002686 return EXIT_FAILURE;
2687 }
2688
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002689 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2690 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2691 // image writer will require this fd to generate the image.
2692 if (dex2oat.ShouldKeepOatFileOpen()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002693 if (!dex2oat.FlushOutputFiles()) {
2694 dex2oat.EraseOutputFiles();
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002695 return EXIT_FAILURE;
2696 }
David Brazdil7b49e6c2016-09-01 11:06:18 +01002697 } else if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002698 return EXIT_FAILURE;
2699 }
2700
Jeff Haodcdc85b2015-12-04 14:06:18 -08002701 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002702 if (!dex2oat.HandleImage()) {
2703 return EXIT_FAILURE;
2704 }
2705
2706 // When given --host, finish early without stripping.
2707 if (dex2oat.IsHost()) {
2708 dex2oat.DumpTiming();
2709 return EXIT_SUCCESS;
2710 }
2711
Jeff Haodcdc85b2015-12-04 14:06:18 -08002712 // Copy stripped to unstripped location, if necessary.
2713 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002714 return EXIT_FAILURE;
2715 }
2716
Jeff Haodcdc85b2015-12-04 14:06:18 -08002717 // FlushClose again, as stripping might have re-opened the oat files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002718 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002719 return EXIT_FAILURE;
2720 }
2721
2722 dex2oat.DumpTiming();
2723 return EXIT_SUCCESS;
2724}
2725
2726static int CompileApp(Dex2Oat& dex2oat) {
2727 dex2oat.Compile();
2728
David Brazdil7b49e6c2016-09-01 11:06:18 +01002729 if (!dex2oat.WriteOutputFiles()) {
2730 dex2oat.EraseOutputFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002731 return EXIT_FAILURE;
2732 }
2733
Jeff Haodcdc85b2015-12-04 14:06:18 -08002734 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002735 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002736
2737 // When given --host, finish early without stripping.
2738 if (dex2oat.IsHost()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002739 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002740 return EXIT_FAILURE;
2741 }
2742
2743 dex2oat.DumpTiming();
2744 return EXIT_SUCCESS;
2745 }
2746
Jeff Haodcdc85b2015-12-04 14:06:18 -08002747 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2748 // stripped versions. If this is given, we expect to be able to open writable files by name.
2749 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002750 return EXIT_FAILURE;
2751 }
2752
Jeff Haodcdc85b2015-12-04 14:06:18 -08002753 // Flush and close the files.
David Brazdil7b49e6c2016-09-01 11:06:18 +01002754 if (!dex2oat.FlushCloseOutputFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002755 return EXIT_FAILURE;
2756 }
2757
2758 dex2oat.DumpTiming();
2759 return EXIT_SUCCESS;
2760}
2761
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002762static int dex2oat(int argc, char** argv) {
2763 b13564922();
2764
2765 TimingLogger timings("compiler", false, false);
2766
Roland Levillain5c7e2602016-02-23 18:08:53 +00002767 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
2768 // might produce a stack frame too large for this function or for
2769 // functions inlining it (such as main), that would not fit the
2770 // requirements of the `-Wframe-larger-than` option.
2771 std::unique_ptr<Dex2Oat> dex2oat = MakeUnique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002772
2773 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002774 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002775
Calin Juravleb077e152016-02-18 18:47:37 +00002776 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02002777 // This operation involves I/O.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002778 if (dex2oat->UseProfileGuidedCompilation()) {
Calin Juravleb077e152016-02-18 18:47:37 +00002779 if (!dex2oat->LoadProfile()) {
2780 LOG(ERROR) << "Failed to process profile file";
Calin Juravle998c2162015-12-21 15:39:33 +02002781 return EXIT_FAILURE;
2782 }
2783 }
2784
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002785 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00002786 if (!dex2oat->OpenFile()) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002787 return EXIT_FAILURE;
2788 }
2789
Andreas Gampe046c7062015-05-18 23:22:54 -07002790 // Print the complete line when any of the following is true:
2791 // 1) Debug build
2792 // 2) Compiling an image
2793 // 3) Compiling with --host
2794 // 4) Compiling on the host (not a target build)
2795 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002796 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07002797 LOG(INFO) << CommandLine();
2798 } else {
2799 LOG(INFO) << StrippedCommandLine();
2800 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002801
Roland Levillain5c7e2602016-02-23 18:08:53 +00002802 if (!dex2oat->Setup()) {
David Brazdil7b49e6c2016-09-01 11:06:18 +01002803 dex2oat->EraseOutputFiles();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002804 return EXIT_FAILURE;
2805 }
2806
Wojciech Staszkiewicz529827d2016-09-15 10:30:30 -07002807 // Helps debugging on device. Can be used to determine which dalvikvm instance invoked a dex2oat
2808 // instance. Used by tools/bisection_search/bisection_search.py.
Wojciech Staszkiewicz0a4c75f2016-09-13 12:06:36 -07002809 VLOG(compiler) << "Running dex2oat (parent PID = " << getppid() << ")";
2810
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002811 bool result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00002812 if (dex2oat->IsImage()) {
2813 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002814 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00002815 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002816 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002817
Roland Levillain5c7e2602016-02-23 18:08:53 +00002818 dex2oat->Shutdown();
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002819 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002820}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002821} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07002822
2823int main(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002824 int result = art::dex2oat(argc, argv);
2825 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
2826 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
2827 // should not destruct the runtime in this case.
Evgenii Stepanov1e133742015-05-20 12:30:59 -07002828 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002829 exit(result);
2830 }
2831 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002832}