blob: dfcb4bcaec2e53256f66df27c85b14cfef141e51 [file] [log] [blame]
Brian Carlstrom7940e442013-07-12 13:46:57 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Andreas Gamped687e372015-04-28 23:16:03 -070017#include <inttypes.h>
Brian Carlstrom7940e442013-07-12 13:46:57 -070018#include <stdio.h>
19#include <stdlib.h>
20#include <sys/stat.h>
Evgenii Stepanov1e133742015-05-20 12:30:59 -070021#include "base/memory_tool.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070022
23#include <fstream>
24#include <iostream>
25#include <sstream>
26#include <string>
Andreas Gampeb1fcead2015-04-20 18:53:51 -070027#include <unordered_set>
Brian Carlstrom7940e442013-07-12 13:46:57 -070028#include <vector>
29
Vladimir Markof94b7812014-06-05 15:48:04 +010030#if defined(__linux__) && defined(__arm__)
31#include <sys/personality.h>
32#include <sys/utsname.h>
33#endif
34
Ian Rogerscf7f1912014-10-22 22:06:39 -070035#define ATRACE_TAG ATRACE_TAG_DALVIK
Ian Rogersd582fa42014-11-05 23:46:43 -080036#include <cutils/trace.h>
Ian Rogerscf7f1912014-10-22 22:06:39 -070037
Ian Rogersd582fa42014-11-05 23:46:43 -080038#include "arch/instruction_set_features.h"
Andreas Gampec5a3ea72015-01-13 16:41:53 -080039#include "arch/mips/instruction_set_features_mips.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000040#include "art_method-inl.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070041#include "base/dumpable.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080042#include "base/macros.h"
Calin Juravle2e2db782016-02-23 12:00:03 +000043#include "base/scoped_flock.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070044#include "base/stl_util.h"
45#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010046#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070047#include "base/timing_logger.h"
48#include "base/unix_file/fd_file.h"
49#include "class_linker.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000050#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000051#include "compiler_callbacks.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000052#include "debug/method_debug_info.h"
Mathieu Chartier5bdab122015-01-26 18:30:19 -080053#include "dex/pass_manager.h"
Ian Rogerse63db272014-07-15 15:36:11 -070054#include "dex/quick/dex_file_to_method_inliner_map.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000055#include "dex/quick_compiler_callbacks.h"
56#include "dex/verification_results.h"
57#include "dex_file-inl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070058#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080059#include "driver/compiler_options.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080060#include "elf_file.h"
Tong Shen62d1ca32014-09-03 17:24:56 -070061#include "elf_writer.h"
Vladimir Marko10c13562015-11-25 14:33:36 +000062#include "elf_writer_quick.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070063#include "gc/space/image_space.h"
64#include "gc/space/space-inl.h"
65#include "image_writer.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070066#include "interpreter/unstarted_runtime.h"
Calin Juravle998c2162015-12-21 15:39:33 +020067#include "jit/offline_profiling_info.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070068#include "leb128.h"
Vladimir Marko944da602016-02-19 12:27:55 +000069#include "linker/multi_oat_relative_patcher.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070070#include "mirror/class-inl.h"
71#include "mirror/class_loader.h"
72#include "mirror/object-inl.h"
73#include "mirror/object_array-inl.h"
74#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"
79#include "scoped_thread_state_change.h"
Alex Light53cb16b2014-06-12 11:26:29 -070080#include "utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070081#include "well_known_classes.h"
82#include "zip_archive.h"
83
84namespace art {
85
Brian Carlstrom6449c622014-02-10 23:48:36 -080086static int original_argc;
87static char** original_argv;
88
89static std::string CommandLine() {
90 std::vector<std::string> command;
91 for (int i = 0; i < original_argc; ++i) {
92 command.push_back(original_argv[i]);
93 }
94 return Join(command, ' ');
95}
96
Andreas Gampe046c7062015-05-18 23:22:54 -070097// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
98// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
99// locations are all staged).
100static std::string StrippedCommandLine() {
101 std::vector<std::string> command;
102
103 // Do a pre-pass to look for zip-fd.
104 bool saw_zip_fd = false;
105 for (int i = 0; i < original_argc; ++i) {
106 if (StartsWith(original_argv[i], "--zip-fd=")) {
107 saw_zip_fd = true;
108 break;
109 }
110 }
111
112 // Now filter out things.
113 for (int i = 0; i < original_argc; ++i) {
114 // All runtime-arg parameters are dropped.
115 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
116 i++; // Drop the next part, too.
117 continue;
118 }
119
120 // Any instruction-setXXX is dropped.
121 if (StartsWith(original_argv[i], "--instruction-set")) {
122 continue;
123 }
124
125 // The boot image is dropped.
126 if (StartsWith(original_argv[i], "--boot-image=")) {
127 continue;
128 }
129
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800130 // The image format is dropped.
131 if (StartsWith(original_argv[i], "--image-format=")) {
132 continue;
133 }
134
Andreas Gampe046c7062015-05-18 23:22:54 -0700135 // This should leave any dex-file and oat-file options, describing what we compiled.
136
137 // However, we prefer to drop this when we saw --zip-fd.
138 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700139 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe046c7062015-05-18 23:22:54 -0700140 if (StartsWith(original_argv[i], "--zip-") ||
141 StartsWith(original_argv[i], "--dex-") ||
142 StartsWith(original_argv[i], "--oat-") ||
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700143 StartsWith(original_argv[i], "--swap-") ||
144 StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700145 continue;
146 }
147 }
148
149 command.push_back(original_argv[i]);
150 }
151
152 // Construct the final output.
153 if (command.size() <= 1U) {
154 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
155 return "Starting dex2oat.";
156 }
157 return Join(command, ' ');
158}
159
Brian Carlstrom7940e442013-07-12 13:46:57 -0700160static void UsageErrorV(const char* fmt, va_list ap) {
161 std::string error;
162 StringAppendV(&error, fmt, ap);
163 LOG(ERROR) << error;
164}
165
166static void UsageError(const char* fmt, ...) {
167 va_list ap;
168 va_start(ap, fmt);
169 UsageErrorV(fmt, ap);
170 va_end(ap);
171}
172
Andreas Gampe794ad762015-02-23 08:12:24 -0800173NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700174 va_list ap;
175 va_start(ap, fmt);
176 UsageErrorV(fmt, ap);
177 va_end(ap);
178
Brian Carlstrom6449c622014-02-10 23:48:36 -0800179 UsageError("Command: %s", CommandLine().c_str());
180
Brian Carlstrom7940e442013-07-12 13:46:57 -0700181 UsageError("Usage: dex2oat [options]...");
182 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100183 UsageError(" -j<number>: specifies the number of threads used for compilation.");
184 UsageError(" Default is the number of detected hardware threads available on the");
185 UsageError(" host system.");
186 UsageError(" Example: -j12");
187 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700188 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700189 UsageError(" Example: --dex-file=/system/framework/core.jar");
190 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700191 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
192 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
193 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
194 UsageError(" --dex-location=/system/framework/core.jar");
195 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700196 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
197 UsageError(" containing a classes.dex file to compile.");
198 UsageError(" Example: --zip-fd=5");
199 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700200 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
201 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700202 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
203 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800204 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700205 UsageError(" Example: --oat-file=/system/framework/boot.oat");
206 UsageError("");
207 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900208 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700209 UsageError("");
210 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
211 UsageError(" to the file descriptor specified by --oat-fd.");
212 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
213 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800214 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700215 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
216 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800217 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700218 UsageError(" Example: --image=/system/framework/boot.art");
219 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800220 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800221 UsageError(" Which format to store the image.");
222 UsageError(" Example: --image-format=lz4");
223 UsageError(" Default: uncompressed");
224 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700225 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
226 UsageError(" Example: --image=frameworks/base/preloaded-classes");
227 UsageError("");
228 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
229 UsageError(" Example: --base=0x50000000");
230 UsageError("");
231 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000232 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700233 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000234 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000235 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700236 UsageError("");
237 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
238 UsageError(" Example: --android-root=out/host/linux-x86");
239 UsageError(" Default: $ANDROID_ROOT");
240 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800241 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700242 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700243 UsageError(" Example: --instruction-set=x86");
244 UsageError(" Default: arm");
245 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700246 UsageError(" --instruction-set-features=...,: Specify instruction set features");
247 UsageError(" Example: --instruction-set-features=div");
248 UsageError(" Default: default");
249 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700250 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
251 UsageError(" Default: disabled");
252 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800253 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700254 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800255 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100256 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700257 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100258 UsageError(" --compiler-filter="
259 "(verify-none"
260 "|interpret-only"
261 "|space"
262 "|balanced"
263 "|speed"
264 "|everything"
265 "|time):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700266 UsageError(" select compiler filter.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800267 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800268 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800269 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800270 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
271 UsageError(" method for compiler filter tuning.");
272 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
273 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
274 UsageError("");
275 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
276 UsageError(" method for compiler filter tuning.");
277 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
278 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
279 UsageError("");
280 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
281 UsageError(" method for compiler filter tuning.");
282 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
283 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
284 UsageError("");
285 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
286 UsageError(" method for compiler filter tuning.");
287 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
288 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
289 UsageError("");
290 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
291 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Jeff Hao4a200f52014-04-01 14:58:49 -0700292 UsageError(" and the filter is not interpret-only or verify-none, overrides the");
293 UsageError(" filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800294 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
295 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
296 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100297 UsageError(" --inline-depth-limit=<depth-limit>: the depth limit of inlining for fine tuning");
298 UsageError(" the compiler. A zero value will disable inlining. Honored only by Optimizing.");
Roland Levillaina215b952015-08-07 11:38:32 +0100299 UsageError(" Has priority over the --compiler-filter option. Intended for ");
300 UsageError(" development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100301 UsageError(" Example: --inline-depth-limit=%d", CompilerOptions::kDefaultInlineDepthLimit);
302 UsageError(" Default: %d", CompilerOptions::kDefaultInlineDepthLimit);
303 UsageError("");
304 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
305 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100306 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
307 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100308 UsageError(" Example: --inline-max-code-units=%d",
309 CompilerOptions::kDefaultInlineMaxCodeUnits);
310 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
311 UsageError("");
Ian Rogers46398602013-08-20 07:50:36 -0700312 UsageError(" --dump-timing: display a breakdown of where time was spent");
313 UsageError("");
Alex Light53cb16b2014-06-12 11:26:29 -0700314 UsageError(" --include-patch-information: Include patching information so the generated code");
315 UsageError(" can have its base address moved without full recompilation.");
316 UsageError("");
317 UsageError(" --no-include-patch-information: Do not include patching information.");
318 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100319 UsageError(" -g");
320 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
321 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000322 UsageError(" If used without --native-debuggable, it will be best-effort only.");
323 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700324 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100325 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100326 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000327 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
328 UsageError(" debug information necessary to print backtraces. (disabled by default)");
329 UsageError("");
330 UsageError(" --no-generate-mini-debug-info: Do do generated backtrace info.");
331 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000332 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000333 UsageError("");
334 UsageError(" --native-debuggable: Produce code debuggable with native debugger (like LLDB).");
335 UsageError(" Implies --debuggable.");
336 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700337 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
338 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
339 UsageError(" Use a separate --runtime-arg switch for each argument.");
340 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700341 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000342 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700343 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000344 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
345 UsageError(" Cannot be used together with --profile-file.");
346 UsageError("");
Chao-ying Fucd8ce662014-03-11 14:57:19 -0700347 UsageError(" --print-pass-names: print a list of pass names");
348 UsageError("");
349 UsageError(" --disable-passes=<pass-names>: disable one or more passes separated by comma.");
350 UsageError(" Example: --disable-passes=UseCount,BBOptimizations");
351 UsageError("");
Razvan A Lupusorubd25d4b2014-07-02 18:16:51 -0700352 UsageError(" --print-pass-options: print a list of passes that have configurable options along "
353 "with the setting.");
354 UsageError(" Will print default if no overridden setting exists.");
355 UsageError("");
356 UsageError(" --pass-options=Pass1Name:Pass1OptionName:Pass1Option#,"
357 "Pass2Name:Pass2OptionName:Pass2Option#");
358 UsageError(" Used to specify a pass specific option. The setting itself must be integer.");
359 UsageError(" Separator used between options is a comma.");
360 UsageError("");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800361 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
362 UsageError(" Example: --swap-file=/data/tmp/swap.001");
363 UsageError("");
364 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
365 UsageError(" Example: --swap-fd=10");
366 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700367 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
368 UsageError(" Example: --app-image-fd=10");
369 UsageError("");
370 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
371 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
372 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800373 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
374 "input dex file.");
375 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000376 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
377 UsageError(" This option is incompatible with read barriers (e.g., if dex2oat has been");
378 UsageError(" built with the environment variable `ART_USE_READ_BARRIER` set to `true`).");
379 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700380 std::cerr << "See log for usage error information\n";
381 exit(EXIT_FAILURE);
382}
383
Brian Carlstrom7940e442013-07-12 13:46:57 -0700384// The primary goal of the watchdog is to prevent stuck build servers
385// during development when fatal aborts lead to a cascade of failures
386// that result in a deadlock.
387class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800388// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700389#undef CHECK_PTHREAD_CALL
390#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
391 do { \
392 int rc = call args; \
393 if (rc != 0) { \
394 errno = rc; \
395 std::string message(# call); \
396 message += " failed for "; \
397 message += reason; \
398 Fatal(message); \
399 } \
400 } while (false)
401
402 public:
Brian Carlstrom93ba8932013-07-17 21:31:49 -0700403 explicit WatchDog(bool is_watch_dog_enabled) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700404 is_watch_dog_enabled_ = is_watch_dog_enabled;
405 if (!is_watch_dog_enabled_) {
406 return;
407 }
408 shutting_down_ = false;
409 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700410 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
411 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700412 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
413 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
414 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
415 }
416 ~WatchDog() {
417 if (!is_watch_dog_enabled_) {
418 return;
419 }
420 const char* reason = "dex2oat watch dog thread shutdown";
421 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
422 shutting_down_ = true;
423 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
424 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
425
Kenny Root51316382014-05-13 14:59:37 -0700426 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700427
428 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
429 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
430 }
431
432 private:
433 static void* CallBack(void* arg) {
434 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
435 ::art::SetThreadName("dex2oat watch dog");
436 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700437 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700438 }
439
Andreas Gampe794ad762015-02-23 08:12:24 -0800440 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700441 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
442 // it's rather easy to hang in unwinding.
443 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
444 // logcat logging or stderr output.
445 LogMessage::LogLine(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700446 exit(1);
447 }
448
449 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700450 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
451 // large.
Andreas Gamped687e372015-04-28 23:16:03 -0700452 constexpr int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700453 timespec timeout_ts;
454 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts);
455 const char* reason = "dex2oat watch dog thread waiting";
456 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
457 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800458 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700459 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700460 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
461 kWatchDogTimeoutSeconds));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700462 } else if (rc != 0) {
463 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
464 strerror(errno)));
465 Fatal(message.c_str());
466 }
467 }
468 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
469 }
470
471 // 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 -0700472 // Debug builds are slower so they have larger timeouts.
Andreas Gamped687e372015-04-28 23:16:03 -0700473 static constexpr int64_t kSlowdownFactor = kIsDebugBuild ? 5U : 1U;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800474
Andreas Gampe540138a2015-09-14 15:34:38 -0700475 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
476 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
477 // itself before that watchdog would take down the system server.
478 static constexpr int64_t kWatchDogTimeoutSeconds = kSlowdownFactor * (9 * 60 + 30);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700479
480 bool is_watch_dog_enabled_;
481 bool shutting_down_;
482 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
483 pthread_mutex_t mutex_;
484 pthread_cond_t cond_;
485 pthread_attr_t attr_;
486 pthread_t pthread_;
487};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700488
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800489static constexpr size_t kMinDexFilesForSwap = 2;
490static constexpr size_t kMinDexFileCumulativeSizeForSwap = 20 * MB;
491
492static bool UseSwap(bool is_image, std::vector<const DexFile*>& dex_files) {
493 if (is_image) {
494 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
495 return false;
496 }
497 if (dex_files.size() < kMinDexFilesForSwap) {
498 // If there are less dex files than the threshold, assume it's gonna be fine.
499 return false;
500 }
501 size_t dex_files_size = 0;
502 for (const auto* dex_file : dex_files) {
503 dex_files_size += dex_file->GetHeader().file_size_;
504 }
505 return dex_files_size >= kMinDexFileCumulativeSizeForSwap;
506}
507
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800508class Dex2Oat FINAL {
509 public:
510 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100511 compiler_kind_(Compiler::kOptimizing),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800512 instruction_set_(kRuntimeISA),
513 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000514 image_file_location_oat_checksum_(0),
515 image_file_location_oat_data_begin_(0),
516 image_patch_delta_(0),
517 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700518 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800519 method_inliner_map_(),
520 runtime_(nullptr),
521 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
522 start_ns_(NanoTime()),
523 oat_fd_(-1),
524 zip_fd_(-1),
525 image_base_(0U),
526 image_classes_zip_filename_(nullptr),
527 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800528 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800529 compiled_classes_zip_filename_(nullptr),
530 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700531 compiled_methods_zip_filename_(nullptr),
532 compiled_methods_filename_(nullptr),
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700533 app_image_(false),
534 boot_image_(false),
Jeff Hao436183f2016-01-12 16:36:50 -0800535 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800536 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000537 class_loader_(nullptr),
538 elf_writers_(),
539 oat_writers_(),
540 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000541 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700542 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000543 opened_dex_files_maps_(),
544 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000545 no_inline_from_dex_files_(),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800546 dump_stats_(false),
547 dump_passes_(false),
548 dump_timing_(false),
549 dump_slow_timing_(kIsDebugBuild),
Calin Juravle2e2db782016-02-23 12:00:03 +0000550 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800551 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000552 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800553 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000554 force_determinism_(false)
555 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800556
557 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800558 // Log completion time before deleting the runtime_, because this accesses
559 // the runtime.
560 LogCompletionTime();
561
Vladimir Marko307dac92015-10-20 11:20:09 +0100562 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
563 // We want to just exit on non-debug builds, not bringing the runtime down
564 // in an orderly fashion. So release the following fields.
565 driver_.release();
566 image_writer_.release();
567 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
568 dex_file.release();
569 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000570 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
571 map.release();
572 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800573 for (std::unique_ptr<File>& oat_file : oat_files_) {
574 oat_file.release();
575 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100576 runtime_.release();
577 verification_results_.release();
578 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100579 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700580 }
581
Roland Levillain9ec5e222015-08-17 20:18:41 +0100582 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800583 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800584 std::string boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800585 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000586 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800587 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100588 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800589
Roland Levillain9ec5e222015-08-17 20:18:41 +0100590 void ParseZipFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000591 ParseUintOption(option, "--zip-fd", &zip_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100592 }
593
594 void ParseOatFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000595 ParseUintOption(option, "--oat-fd", &oat_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100596 }
597
Calin Juravle877fd962016-01-05 14:29:29 +0000598 void ParseFdForCollection(const StringPiece& option,
599 const char* arg_name,
600 std::vector<uint32_t>* fds) {
601 uint32_t fd;
602 ParseUintOption(option, arg_name, &fd, Usage);
603 fds->push_back(fd);
604 }
605
Roland Levillain9ec5e222015-08-17 20:18:41 +0100606 void ParseJ(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000607 ParseUintOption(option, "-j", &thread_count_, Usage, /* is_long_option */ false);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100608 }
609
610 void ParseBase(const StringPiece& option) {
611 DCHECK(option.starts_with("--base="));
612 const char* image_base_str = option.substr(strlen("--base=")).data();
613 char* end;
614 image_base_ = strtoul(image_base_str, &end, 16);
615 if (end == image_base_str || *end != '\0') {
616 Usage("Failed to parse hexadecimal value for option %s", option.data());
617 }
618 }
619
620 void ParseInstructionSet(const StringPiece& option) {
621 DCHECK(option.starts_with("--instruction-set="));
622 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
623 // StringPiece is not necessarily zero-terminated, so need to make a copy and ensure it.
624 std::unique_ptr<char[]> buf(new char[instruction_set_str.length() + 1]);
625 strncpy(buf.get(), instruction_set_str.data(), instruction_set_str.length());
626 buf.get()[instruction_set_str.length()] = 0;
627 instruction_set_ = GetInstructionSetFromString(buf.get());
628 // arm actually means thumb2.
629 if (instruction_set_ == InstructionSet::kArm) {
630 instruction_set_ = InstructionSet::kThumb2;
631 }
632 }
633
634 void ParseInstructionSetVariant(const StringPiece& option, ParserOptions* parser_options) {
635 DCHECK(option.starts_with("--instruction-set-variant="));
636 StringPiece str = option.substr(strlen("--instruction-set-variant=")).data();
637 instruction_set_features_.reset(
638 InstructionSetFeatures::FromVariant(
639 instruction_set_, str.as_string(), &parser_options->error_msg));
640 if (instruction_set_features_.get() == nullptr) {
641 Usage("%s", parser_options->error_msg.c_str());
642 }
643 }
644
645 void ParseInstructionSetFeatures(const StringPiece& option, ParserOptions* parser_options) {
646 DCHECK(option.starts_with("--instruction-set-features="));
647 StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
648 if (instruction_set_features_.get() == nullptr) {
649 instruction_set_features_.reset(
650 InstructionSetFeatures::FromVariant(
651 instruction_set_, "default", &parser_options->error_msg));
652 if (instruction_set_features_.get() == nullptr) {
653 Usage("Problem initializing default instruction set features variant: %s",
654 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700655 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800656 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100657 instruction_set_features_.reset(
658 instruction_set_features_->AddFeaturesFromString(str.as_string(),
659 &parser_options->error_msg));
660 if (instruction_set_features_.get() == nullptr) {
661 Usage("Error parsing '%s': %s", option.data(), parser_options->error_msg.c_str());
662 }
663 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800664
Roland Levillain9ec5e222015-08-17 20:18:41 +0100665 void ParseCompilerBackend(const StringPiece& option, ParserOptions* parser_options) {
666 DCHECK(option.starts_with("--compiler-backend="));
667 parser_options->requested_specific_compiler = true;
668 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
669 if (backend_str == "Quick") {
670 compiler_kind_ = Compiler::kQuick;
671 } else if (backend_str == "Optimizing") {
672 compiler_kind_ = Compiler::kOptimizing;
673 } else {
674 Usage("Unknown compiler backend: %s", backend_str.data());
675 }
676 }
677
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800678 void ParseImageFormat(const StringPiece& option) {
679 const StringPiece substr("--image-format=");
680 DCHECK(option.starts_with(substr));
681 const StringPiece format_str = option.substr(substr.length());
682 if (format_str == "lz4") {
683 image_storage_mode_ = ImageHeader::kStorageModeLZ4;
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800684 } else if (format_str == "lz4hc") {
685 image_storage_mode_ = ImageHeader::kStorageModeLZ4HC;
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800686 } else if (format_str == "uncompressed") {
687 image_storage_mode_ = ImageHeader::kStorageModeUncompressed;
688 } else {
689 Usage("Unknown image format: %s", format_str.data());
690 }
691 }
692
Jeff Hao436183f2016-01-12 16:36:50 -0800693 void ProcessOptions(ParserOptions* parser_options) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800694 boot_image_ = !image_filenames_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700695 app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
696
697 if (IsAppImage() && IsBootImage()) {
698 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
699 }
700
Jeff Haodcdc85b2015-12-04 14:06:18 -0800701 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800702 Usage("Output must be supplied with either --oat-file or --oat-fd");
703 }
704
Jeff Haodcdc85b2015-12-04 14:06:18 -0800705 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800706 Usage("--oat-file should not be used with --oat-fd");
707 }
708
Roland Levillain9ec5e222015-08-17 20:18:41 +0100709 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800710 Usage("--oat-symbols should not be used with --oat-fd");
711 }
712
Roland Levillain9ec5e222015-08-17 20:18:41 +0100713 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800714 Usage("--oat-symbols should not be used with --host");
715 }
716
Jeff Haodcdc85b2015-12-04 14:06:18 -0800717 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800718 Usage("--oat-fd should not be used with --image");
719 }
720
Jeff Haodcdc85b2015-12-04 14:06:18 -0800721 if (!parser_options->oat_symbols.empty() &&
722 parser_options->oat_symbols.size() != oat_filenames_.size()) {
723 Usage("--oat-file arguments do not match --oat-symbols arguments");
724 }
725
726 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
727 Usage("--oat-file arguments do not match --image arguments");
728 }
729
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800730 if (android_root_.empty()) {
731 const char* android_root_env_var = getenv("ANDROID_ROOT");
732 if (android_root_env_var == nullptr) {
733 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700734 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800735 android_root_ += android_root_env_var;
736 }
737
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700738 if (!boot_image_ && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100739 parser_options->boot_image_filename += android_root_;
740 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800741 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100742 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000743 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800744 }
745
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700746 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800747 Usage("--image-classes should only be used with --image");
748 }
749
Vladimir Marko49b0f452015-12-10 13:49:19 +0000750 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800751 Usage("--image-classes should not be used with --boot-image");
752 }
753
754 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
755 Usage("--image-classes-zip should be used with --image-classes");
756 }
757
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700758 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800759 Usage("--compiled-classes should only be used with --image");
760 }
761
Vladimir Marko49b0f452015-12-10 13:49:19 +0000762 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800763 Usage("--compiled-classes should not be used with --boot-image");
764 }
765
766 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
767 Usage("--compiled-classes-zip should be used with --compiled-classes");
768 }
769
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800770 if (dex_filenames_.empty() && zip_fd_ == -1) {
771 Usage("Input must be supplied with either --dex-file or --zip-fd");
772 }
773
774 if (!dex_filenames_.empty() && zip_fd_ != -1) {
775 Usage("--dex-file should not be used with --zip-fd");
776 }
777
778 if (!dex_filenames_.empty() && !zip_location_.empty()) {
779 Usage("--dex-file should not be used with --zip-location");
780 }
781
782 if (dex_locations_.empty()) {
783 for (const char* dex_file_name : dex_filenames_) {
784 dex_locations_.push_back(dex_file_name);
785 }
786 } else if (dex_locations_.size() != dex_filenames_.size()) {
787 Usage("--dex-location arguments do not match --dex-file arguments");
788 }
789
Jeff Haodcdc85b2015-12-04 14:06:18 -0800790 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
791 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
792 Usage("--oat-file arguments must be singular or match --dex-file arguments");
793 }
794 }
795
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800796 if (zip_fd_ != -1 && zip_location_.empty()) {
797 Usage("--zip-location should be supplied with --zip-fd");
798 }
799
Vladimir Marko49b0f452015-12-10 13:49:19 +0000800 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800801 if (image_base_ == 0) {
802 Usage("Non-zero --base not specified");
803 }
804 }
805
Calin Juravle2e2db782016-02-23 12:00:03 +0000806 if (!profile_file_.empty() && (profile_file_fd_ != kInvalidFd)) {
807 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200808 }
809
Roland Levillain9ec5e222015-08-17 20:18:41 +0100810 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800811 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800812 }
813
814 // If no instruction set feature was given, use the default one for the target
815 // instruction set.
816 if (instruction_set_features_.get() == nullptr) {
817 instruction_set_features_.reset(
Roland Levillain9ec5e222015-08-17 20:18:41 +0100818 InstructionSetFeatures::FromVariant(
819 instruction_set_, "default", &parser_options->error_msg));
Ian Rogersd582fa42014-11-05 23:46:43 -0800820 if (instruction_set_features_.get() == nullptr) {
821 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100822 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800823 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800824 }
825
826 if (instruction_set_ == kRuntimeISA) {
827 std::unique_ptr<const InstructionSetFeatures> runtime_features(
828 InstructionSetFeatures::FromCppDefines());
829 if (!instruction_set_features_->Equals(runtime_features.get())) {
830 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
831 << *instruction_set_features_ << ") and those of dex2oat executable ("
832 << *runtime_features <<") for the command line:\n"
833 << CommandLine();
834 }
835 }
836
Roland Levillaina215b952015-08-07 11:38:32 +0100837 // It they are not set, use default values for inlining settings.
838 // TODO: We should rethink the compiler filter. We mostly save
839 // time here, which is orthogonal to space.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000840 if (compiler_options_->inline_depth_limit_ == CompilerOptions::kUnsetInlineDepthLimit) {
841 compiler_options_->inline_depth_limit_ =
842 (compiler_options_->compiler_filter_ == CompilerOptions::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100843 // Implementation of the space filter: limit inlining depth.
844 ? CompilerOptions::kSpaceFilterInlineDepthLimit
845 : CompilerOptions::kDefaultInlineDepthLimit;
846 }
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000847 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
848 compiler_options_->inline_max_code_units_ =
849 (compiler_options_->compiler_filter_ == CompilerOptions::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100850 // Implementation of the space filter: limit inlining max code units.
851 ? CompilerOptions::kSpaceFilterInlineMaxCodeUnits
852 : CompilerOptions::kDefaultInlineMaxCodeUnits;
853 }
854
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800855 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800856 // Set the compilation target's implicit checks options.
857 switch (instruction_set_) {
858 case kArm:
859 case kThumb2:
860 case kArm64:
861 case kX86:
862 case kX86_64:
Douglas Leung22bb5a22015-07-02 16:42:08 -0700863 case kMips:
864 case kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000865 compiler_options_->implicit_null_checks_ = true;
866 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800867 break;
868
869 default:
870 // Defaults are correct.
871 break;
872 }
873
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000874 compiler_options_->verbose_methods_ = verbose_methods_.empty() ? nullptr : &verbose_methods_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800875
Jeff Hao436183f2016-01-12 16:36:50 -0800876 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800877 Usage("--multi-image can only be used when creating boot images");
878 }
Jeff Hao436183f2016-01-12 16:36:50 -0800879 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800880 Usage("--multi-image cannot be used with multiple image names");
881 }
882
883 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
884 if (!kIsTargetBuild && IsBootImage()) {
885 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800886 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800887 }
888 }
889
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800890 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100891 if (parser_options->watch_dog_enabled) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800892 watchdog_.reset(new WatchDog(true));
893 }
894
895 // Fill some values into the key-value store for the oat header.
896 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800897
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800898 // Automatically force determinism for the boot image in a host build if the default GC is CMS
899 // or MS and read barriers are not enabled, as the former switches the GC to a non-concurrent
900 // one by passing the option `-Xgc:nonconcurrent` (see below).
901 if (!kIsTargetBuild && IsBootImage()) {
902 if (SupportsDeterministicCompilation()) {
903 force_determinism_ = true;
904 } else {
905 LOG(WARNING) << "Deterministic compilation is disabled.";
906 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800907 }
908 compiler_options_->force_determinism_ = force_determinism_;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100909 }
910
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800911 static bool SupportsDeterministicCompilation() {
912 return (gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
913 gc::kCollectorTypeDefault == gc::kCollectorTypeMS) &&
914 !kEmitCompilerReadBarrier;
915 }
916
Jeff Hao436183f2016-01-12 16:36:50 -0800917 void ExpandOatAndImageFilenames() {
918 std::string base_oat = oat_filenames_[0];
919 size_t last_oat_slash = base_oat.rfind('/');
920 if (last_oat_slash == std::string::npos) {
921 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
922 }
923 // We also need to honor path components that were encoded through '@'. Otherwise the loading
924 // code won't be able to find the images.
925 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
926 last_oat_slash = base_oat.rfind('@');
927 }
928 base_oat = base_oat.substr(0, last_oat_slash + 1);
929
930 std::string base_img = image_filenames_[0];
931 size_t last_img_slash = base_img.rfind('/');
932 if (last_img_slash == std::string::npos) {
933 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
934 }
935 // We also need to honor path components that were encoded through '@'. Otherwise the loading
936 // code won't be able to find the images.
937 if (base_img.find('@', last_img_slash) != std::string::npos) {
938 last_img_slash = base_img.rfind('@');
939 }
940
941 // Get the prefix, which is the primary image name (without path components). Strip the
942 // extension.
943 std::string prefix = base_img.substr(last_img_slash + 1);
944 if (prefix.rfind('.') != std::string::npos) {
945 prefix = prefix.substr(0, prefix.rfind('.'));
946 }
947 if (!prefix.empty()) {
948 prefix = prefix + "-";
949 }
950
951 base_img = base_img.substr(0, last_img_slash + 1);
952
953 // Note: we have some special case here for our testing. We have to inject the differentiating
954 // parts for the different core images.
955 std::string infix; // Empty infix by default.
956 {
957 // Check the first name.
958 std::string dex_file = oat_filenames_[0];
959 size_t last_dex_slash = dex_file.rfind('/');
960 if (last_dex_slash != std::string::npos) {
961 dex_file = dex_file.substr(last_dex_slash + 1);
962 }
963 size_t last_dex_dot = dex_file.rfind('.');
964 if (last_dex_dot != std::string::npos) {
965 dex_file = dex_file.substr(0, last_dex_dot);
966 }
967 if (StartsWith(dex_file, "core-")) {
968 infix = dex_file.substr(strlen("core"));
969 }
970 }
971
972 // Now create the other names. Use a counted loop to skip the first one.
973 for (size_t i = 1; i < dex_locations_.size(); ++i) {
974 // TODO: Make everything properly std::string.
975 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
976 char_backing_storage_.push_back(base_img + image_name);
977 image_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
978
979 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
980 char_backing_storage_.push_back(base_oat + oat_name);
981 oat_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
982 }
983 }
984
Andreas Gampe8994a042015-12-30 19:03:17 +0000985 // Modify the input string in the following way:
986 // 0) Assume input is /a/b/c.d
987 // 1) Strip the path -> c.d
988 // 2) Inject prefix p -> pc.d
989 // 3) Inject infix i -> pci.d
990 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -0800991 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +0000992 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -0800993 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +0000994 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800995 size_t last_dex_slash = in.rfind('/');
996 if (last_dex_slash != std::string::npos) {
997 in = in.substr(last_dex_slash + 1);
998 }
Andreas Gampe8994a042015-12-30 19:03:17 +0000999 if (!prefix.empty()) {
1000 in = prefix + in;
1001 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001002 if (!infix.empty()) {
1003 // Inject infix.
1004 size_t last_dot = in.rfind('.');
1005 if (last_dot != std::string::npos) {
1006 in.insert(last_dot, infix);
1007 }
1008 }
1009 if (EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001010 in = in.substr(0, in.length() - strlen(".jar")) +
1011 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001012 }
1013 return in;
1014 }
1015
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001016 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001017 std::ostringstream oss;
1018 for (int i = 0; i < argc; ++i) {
1019 if (i > 0) {
1020 oss << ' ';
1021 }
1022 oss << argv[i];
1023 }
1024 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1025 oss.str(""); // Reset.
1026 oss << kRuntimeISA;
1027 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1028 key_value_store_->Put(
1029 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001030 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001031 key_value_store_->Put(
1032 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001033 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Brazdilce4b0ba2016-01-28 15:05:49 +00001034 key_value_store_->Put(
1035 OatHeader::kExtractOnlyKey,
1036 compiler_options_->IsExtractOnly() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001037 }
1038
1039 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1040 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1041 // returns, arguments have been successfully parsed.
1042 void ParseArgs(int argc, char** argv) {
1043 original_argc = argc;
1044 original_argv = argv;
1045
1046 InitLogging(argv);
1047
1048 // Skip over argv[0].
1049 argv++;
1050 argc--;
1051
1052 if (argc == 0) {
1053 Usage("No arguments specified");
1054 }
1055
1056 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001057 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001058
1059 for (int i = 0; i < argc; i++) {
1060 const StringPiece option(argv[i]);
1061 const bool log_options = false;
1062 if (log_options) {
1063 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1064 }
1065 if (option.starts_with("--dex-file=")) {
1066 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data());
1067 } else if (option.starts_with("--dex-location=")) {
1068 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data());
1069 } else if (option.starts_with("--zip-fd=")) {
1070 ParseZipFd(option);
1071 } else if (option.starts_with("--zip-location=")) {
1072 zip_location_ = option.substr(strlen("--zip-location=")).data();
1073 } else if (option.starts_with("--oat-file=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001074 oat_filenames_.push_back(option.substr(strlen("--oat-file=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001075 } else if (option.starts_with("--oat-symbols=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001076 parser_options->oat_symbols.push_back(option.substr(strlen("--oat-symbols=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001077 } else if (option.starts_with("--oat-fd=")) {
1078 ParseOatFd(option);
1079 } else if (option == "--watch-dog") {
1080 parser_options->watch_dog_enabled = true;
1081 } else if (option == "--no-watch-dog") {
1082 parser_options->watch_dog_enabled = false;
1083 } else if (option.starts_with("-j")) {
1084 ParseJ(option);
1085 } else if (option.starts_with("--oat-location=")) {
1086 oat_location_ = option.substr(strlen("--oat-location=")).data();
1087 } else if (option.starts_with("--image=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001088 image_filenames_.push_back(option.substr(strlen("--image=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001089 } else if (option.starts_with("--image-classes=")) {
1090 image_classes_filename_ = option.substr(strlen("--image-classes=")).data();
1091 } else if (option.starts_with("--image-classes-zip=")) {
1092 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data();
Mathieu Chartierceb07b32015-12-10 09:33:21 -08001093 } else if (option.starts_with("--image-format=")) {
1094 ParseImageFormat(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001095 } else if (option.starts_with("--compiled-classes=")) {
1096 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data();
1097 } else if (option.starts_with("--compiled-classes-zip=")) {
1098 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data();
1099 } else if (option.starts_with("--compiled-methods=")) {
1100 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data();
1101 } else if (option.starts_with("--compiled-methods-zip=")) {
1102 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data();
1103 } else if (option.starts_with("--base=")) {
1104 ParseBase(option);
1105 } else if (option.starts_with("--boot-image=")) {
1106 parser_options->boot_image_filename = option.substr(strlen("--boot-image=")).data();
1107 } else if (option.starts_with("--android-root=")) {
1108 android_root_ = option.substr(strlen("--android-root=")).data();
1109 } else if (option.starts_with("--instruction-set=")) {
1110 ParseInstructionSet(option);
1111 } else if (option.starts_with("--instruction-set-variant=")) {
1112 ParseInstructionSetVariant(option, parser_options.get());
1113 } else if (option.starts_with("--instruction-set-features=")) {
1114 ParseInstructionSetFeatures(option, parser_options.get());
1115 } else if (option.starts_with("--compiler-backend=")) {
1116 ParseCompilerBackend(option, parser_options.get());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001117 } else if (option.starts_with("--profile-file=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001118 profile_file_ = option.substr(strlen("--profile-file=")).ToString();
Calin Juravle877fd962016-01-05 14:29:29 +00001119 } else if (option.starts_with("--profile-file-fd=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001120 ParseUintOption(option, "--profile-file-fd", &profile_file_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001121 } else if (option == "--host") {
1122 is_host_ = true;
1123 } else if (option == "--runtime-arg") {
1124 if (++i >= argc) {
1125 Usage("Missing required argument for --runtime-arg");
1126 }
1127 if (log_options) {
1128 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1129 }
1130 runtime_args_.push_back(argv[i]);
1131 } else if (option == "--dump-timing") {
1132 dump_timing_ = true;
1133 } else if (option == "--dump-passes") {
1134 dump_passes_ = true;
Roland Levillain9ec5e222015-08-17 20:18:41 +01001135 } else if (option == "--dump-stats") {
1136 dump_stats_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001137 } else if (option.starts_with("--swap-file=")) {
1138 swap_file_name_ = option.substr(strlen("--swap-file=")).data();
1139 } else if (option.starts_with("--swap-fd=")) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001140 ParseUintOption(option, "--swap-fd", &swap_fd_, Usage);
1141 } else if (option.starts_with("--app-image-file=")) {
1142 app_image_file_name_ = option.substr(strlen("--app-image-file=")).data();
1143 } else if (option.starts_with("--app-image-fd=")) {
1144 ParseUintOption(option, "--app-image-fd", &app_image_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001145 } else if (option.starts_with("--verbose-methods=")) {
1146 // TODO: rather than switch off compiler logging, make all VLOG(compiler) messages
1147 // conditional on having verbost methods.
1148 gLogVerbosity.compiler = false;
1149 Split(option.substr(strlen("--verbose-methods=")).ToString(), ',', &verbose_methods_);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001150 } else if (option == "--multi-image") {
Jeff Hao436183f2016-01-12 16:36:50 -08001151 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001152 } else if (option.starts_with("--no-inline-from=")) {
1153 no_inline_from_string_ = option.substr(strlen("--no-inline-from=")).data();
Andreas Gampeace0dc12016-01-20 13:33:13 -08001154 } else if (option == "--force-determinism") {
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001155 if (!SupportsDeterministicCompilation()) {
1156 Usage("Cannot use --force-determinism with read barriers or non-CMS garbage collector");
Roland Levillaineb2c7412016-01-28 14:37:01 +00001157 }
Andreas Gampeace0dc12016-01-20 13:33:13 -08001158 force_determinism_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001159 } else if (!compiler_options_->ParseCompilerOption(option, Usage)) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001160 Usage("Unknown argument %s", option.data());
1161 }
1162 }
1163
Jeff Hao436183f2016-01-12 16:36:50 -08001164 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001165
1166 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001167 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001168 }
1169
Jeff Haodcdc85b2015-12-04 14:06:18 -08001170 // Check whether the oat output files are writable, and open them for later. Also open a swap
1171 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001172 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001173 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1174 PruneNonExistentDexFiles();
1175
Jeff Hao436183f2016-01-12 16:36:50 -08001176 // Expand oat and image filenames for multi image.
1177 if (IsBootImage() && multi_image_) {
1178 ExpandOatAndImageFilenames();
1179 }
1180
Jeff Haodcdc85b2015-12-04 14:06:18 -08001181 bool create_file = oat_fd_ == -1; // as opposed to using open file descriptor
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001182 if (create_file) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001183 for (const char* oat_filename : oat_filenames_) {
1184 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
1185 if (oat_file.get() == nullptr) {
1186 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1187 return false;
1188 }
1189 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) {
1190 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1191 oat_file->Erase();
1192 return false;
1193 }
1194 oat_files_.push_back(std::move(oat_file));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001195 }
1196 } else {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001197 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, true));
1198 oat_file->DisableAutoClose();
1199 if (oat_file->SetLength(0) != 0) {
Andreas Gampe4303ba92014-11-06 01:00:46 -08001200 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1201 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001202 if (oat_file.get() == nullptr) {
1203 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1204 return false;
1205 }
1206 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) {
1207 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_location_;
1208 oat_file->Erase();
1209 return false;
1210 }
1211 oat_filenames_.push_back(oat_location_.c_str());
1212 oat_files_.push_back(std::move(oat_file));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001213 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001214
1215 // Swap file handling.
1216 //
1217 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1218 // that we can use for swap.
1219 //
1220 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1221 // will immediately unlink to satisfy the swap fd assumption.
1222 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1223 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1224 if (swap_file.get() == nullptr) {
1225 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1226 return false;
1227 }
1228 swap_fd_ = swap_file->Fd();
1229 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1230 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1231 // released immediately.
1232 unlink(swap_file_name_.c_str());
1233 }
Jeff Hao436183f2016-01-12 16:36:50 -08001234
1235 // If we use a swap file, ensure we are above the threshold to make it necessary.
1236 if (swap_fd_ != -1) {
1237 if (!UseSwap(IsBootImage(), dex_files_)) {
1238 close(swap_fd_);
1239 swap_fd_ = -1;
1240 VLOG(compiler) << "Decided to run without swap.";
1241 } else {
1242 LOG(INFO) << "Large app, accepted running with swap.";
1243 }
1244 }
1245 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
1246
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001247 return true;
1248 }
1249
Jeff Haodcdc85b2015-12-04 14:06:18 -08001250 void EraseOatFiles() {
1251 for (size_t i = 0; i < oat_files_.size(); ++i) {
1252 DCHECK(oat_files_[i].get() != nullptr);
1253 oat_files_[i]->Erase();
1254 oat_files_[i].reset();
1255 }
Andreas Gampea650e702014-12-03 14:28:02 -08001256 }
1257
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001258 void Shutdown() {
1259 ScopedObjectAccess soa(Thread::Current());
1260 for (jobject dex_cache : dex_caches_) {
1261 soa.Env()->DeleteLocalRef(dex_cache);
1262 }
1263 dex_caches_.clear();
1264 }
1265
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001266 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1267 // boot class path.
1268 bool Setup() {
1269 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001270 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap.
Vladimir Marko49b0f452015-12-10 13:49:19 +00001271
1272 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods()) {
1273 return false;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001274 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001275
Vladimir Marko307dac92015-10-20 11:20:09 +01001276 verification_results_.reset(new VerificationResults(compiler_options_.get()));
Andreas Gampe4585f872015-03-27 23:45:15 -07001277 callbacks_.reset(new QuickCompilerCallbacks(
Vladimir Marko307dac92015-10-20 11:20:09 +01001278 verification_results_.get(),
Andreas Gampe4585f872015-03-27 23:45:15 -07001279 &method_inliner_map_,
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001280 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001281 CompilerCallbacks::CallbackMode::kCompileBootImage :
1282 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001283
Vladimir Marko49b0f452015-12-10 13:49:19 +00001284 RuntimeArgumentMap runtime_options;
1285 if (!PrepareRuntimeOptions(&runtime_options)) {
1286 return false;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001287 }
1288
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001289 CreateOatWriters();
1290 if (!AddDexFileSources()) {
1291 return false;
1292 }
1293
1294 if (IsBootImage() && image_filenames_.size() > 1) {
1295 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1296 // We need this for the multi-image case.
1297 key_value_store_->Put(OatHeader::kBootClassPath, GetMultiImageBootClassPath());
1298 }
1299
1300 if (!IsBootImage()) {
1301 // When compiling an app, create the runtime early to retrieve
1302 // the image location key needed for the oat header.
1303 if (!CreateRuntime(std::move(runtime_options))) {
1304 return false;
1305 }
1306
David Brazdilce4b0ba2016-01-28 15:05:49 +00001307 if (compiler_options_->IsExtractOnly()) {
1308 // ExtractOnly oat files only contain non-quickened DEX code and are
1309 // therefore independent of the image file.
1310 image_file_location_oat_checksum_ = 0u;
1311 image_file_location_oat_data_begin_ = 0u;
1312 image_patch_delta_ = 0;
1313 } else {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001314 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1315 std::vector<gc::space::ImageSpace*> image_spaces =
1316 Runtime::Current()->GetHeap()->GetBootImageSpaces();
1317 image_file_location_oat_checksum_ = image_spaces[0]->GetImageHeader().GetOatChecksum();
1318 image_file_location_oat_data_begin_ =
1319 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1320 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1321 // Store the boot image filename(s).
1322 std::vector<std::string> image_filenames;
1323 for (const gc::space::ImageSpace* image_space : image_spaces) {
1324 image_filenames.push_back(image_space->GetImageFilename());
1325 }
1326 std::string image_file_location = Join(image_filenames, ':');
1327 if (!image_file_location.empty()) {
1328 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1329 }
1330 }
1331
1332 // Open dex files for class path.
1333 const std::vector<std::string> class_path_locations =
1334 GetClassPathLocations(runtime_->GetClassPathString());
1335 OpenClassPathFiles(class_path_locations, &class_path_files_);
1336
1337 // Store the classpath we have right now.
1338 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1339 key_value_store_->Put(OatHeader::kClassPathKey,
1340 OatFile::EncodeDexFileDependencies(class_path_files));
1341 }
1342
1343 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001344 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001345 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1346 rodata_.reserve(oat_writers_.size());
1347 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1348 rodata_.push_back(elf_writers_[i]->StartRoData());
1349 // Unzip or copy dex files straight to the oat file.
1350 std::unique_ptr<MemMap> opened_dex_files_map;
1351 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
1352 if (!oat_writers_[i]->WriteAndOpenDexFiles(rodata_.back(),
1353 oat_files_[i].get(),
1354 instruction_set_,
1355 instruction_set_features_.get(),
1356 key_value_store_.get(),
Andreas Gampe3a2bd292016-01-26 17:23:47 -08001357 /* verify */ true,
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001358 &opened_dex_files_map,
1359 &opened_dex_files)) {
1360 return false;
1361 }
1362 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1363 if (opened_dex_files_map != nullptr) {
1364 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
1365 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001366 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001367 opened_dex_files_.push_back(std::move(dex_file));
1368 }
1369 } else {
1370 DCHECK(opened_dex_files.empty());
1371 }
1372 }
1373 }
1374
1375 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
1376 if (IsBootImage()) {
1377 // For boot image, pass opened dex files to the Runtime::Create().
1378 // Note: Runtime acquires ownership of these dex files.
1379 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001380 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001381 return false;
1382 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001383 }
1384
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001385 // If we're doing the image, override the compiler filter to force full compilation. Must be
1386 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1387 // compilation of class initializers.
1388 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001389 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001390 WellKnownClasses::Init(self->GetJniEnv());
1391
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001392 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001393 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001394 constexpr bool kSaveDexInput = false;
1395 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001396 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001397 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001398
1399 // Handle and ClassLoader creation needs to come after Runtime::Create.
1400 ScopedObjectAccess soa(self);
1401
1402 // Classpath: first the class-path given.
1403 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1404
1405 // Then the dex files we'll compile. Thus we'll resolve the class-path first.
1406 class_path_files.insert(class_path_files.end(), dex_files_.begin(), dex_files_.end());
1407
1408 class_loader_ = class_linker->CreatePathClassLoader(self, class_path_files);
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001409 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001410
1411 // Ensure opened dex files are writable for dex-to-dex transformations.
1412 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1413 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1414 PLOG(ERROR) << "Failed to make .dex files writeable.";
1415 return false;
Vladimir Marko919f5532016-01-20 19:13:01 +00001416 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001417 }
1418
1419 // Ensure that the dex caches stay live since we don't want class unloading
1420 // to occur during compilation.
1421 for (const auto& dex_file : dex_files_) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001422 ScopedObjectAccess soa(self);
1423 dex_caches_.push_back(soa.AddLocalReference<jobject>(
Mathieu Chartierd57d4542015-10-14 10:55:30 -07001424 class_linker->RegisterDexFile(*dex_file, Runtime::Current()->GetLinearAlloc())));
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001425 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001426
1427 /*
1428 * If we're not in interpret-only or verify-none mode, go ahead and compile small applications.
1429 * Don't bother to check if we're doing the image.
1430 */
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001431 if (!IsBootImage() &&
Brian Carlstrom95b033b2014-12-03 22:29:37 -08001432 compiler_options_->IsCompilationEnabled() &&
1433 compiler_kind_ == Compiler::kQuick) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001434 size_t num_methods = 0;
1435 for (size_t i = 0; i != dex_files_.size(); ++i) {
1436 const DexFile* dex_file = dex_files_[i];
1437 CHECK(dex_file != nullptr);
1438 num_methods += dex_file->NumMethodIds();
1439 }
1440 if (num_methods <= compiler_options_->GetNumDexMethodsThreshold()) {
1441 compiler_options_->SetCompilerFilter(CompilerOptions::kSpeed);
1442 VLOG(compiler) << "Below method threshold, compiling anyways";
1443 }
1444 }
1445
1446 return true;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001447 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001448
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001449 // If we need to keep the oat file open for the image writer.
1450 bool ShouldKeepOatFileOpen() const {
1451 return IsImage() && oat_fd_ != kInvalidFd;
1452 }
1453
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001454 // Create and invoke the compiler driver. This will compile all the dex files.
1455 void Compile() {
1456 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1457 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001458
Vladimir Marko47496c22016-01-27 16:15:08 +00001459 // Find the dex files we should not inline from.
1460
1461 std::vector<std::string> no_inline_filters;
1462 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001463
1464 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001465 const std::string core_oj = "core-oj";
1466 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1467 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001468 }
1469
Vladimir Marko47496c22016-01-27 16:15:08 +00001470 if (!no_inline_filters.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001471 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1472 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1473 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1474 &class_linker->GetBootClassPath(),
1475 &class_path_files,
1476 &dex_files_
1477 };
1478 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001479 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001480 for (const std::string& filter : no_inline_filters) {
1481 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
1482 // allows tests to specify <test-dexfile>:classes2.dex if needed but if the
1483 // base location passes the StartsWith() test, so do all extra locations.
1484 std::string dex_location = dex_file->GetLocation();
1485 if (filter.find('/') == std::string::npos) {
1486 // The filter does not contain the path. Remove the path from dex_location as well.
1487 size_t last_slash = dex_file->GetLocation().rfind('/');
1488 if (last_slash != std::string::npos) {
1489 dex_location = dex_location.substr(last_slash + 1);
1490 }
1491 }
1492
1493 if (StartsWith(dex_location, filter.c_str())) {
1494 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1495 no_inline_from_dex_files_.push_back(dex_file);
1496 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001497 }
1498 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001499 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001500 }
1501 if (!no_inline_from_dex_files_.empty()) {
1502 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001503 }
1504 }
1505
Vladimir Marko307dac92015-10-20 11:20:09 +01001506 driver_.reset(new CompilerDriver(compiler_options_.get(),
1507 verification_results_.get(),
1508 &method_inliner_map_,
1509 compiler_kind_,
1510 instruction_set_,
1511 instruction_set_features_.get(),
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001512 IsBootImage(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001513 image_classes_.release(),
1514 compiled_classes_.release(),
Vladimir Marko944da602016-02-19 12:27:55 +00001515 /* compiled_methods */ nullptr,
Vladimir Marko307dac92015-10-20 11:20:09 +01001516 thread_count_,
1517 dump_stats_,
1518 dump_passes_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001519 compiler_phases_timings_.get(),
1520 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001521 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001522 driver_->SetDexFilesForOatFile(dex_files_);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001523 driver_->CompileAll(class_loader_, dex_files_, timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001524 }
1525
Jeff Hao436183f2016-01-12 16:36:50 -08001526 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001527 // ensure the references between the two are correct.
1528 //
1529 // Currently we have a memory layout that looks something like this:
1530 //
1531 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001532 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001533 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001534 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001535 // +--------------+
1536 // | alloc spaces |
1537 // +--------------+
1538 //
Jeff Hao436183f2016-01-12 16:36:50 -08001539 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001540 //
Jeff Hao436183f2016-01-12 16:36:50 -08001541 // 1. The images are expected to be loaded at an absolute address and
1542 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001543 //
Jeff Hao436183f2016-01-12 16:36:50 -08001544 // 2. There are absolute pointers from Methods in the images to their
1545 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001546 //
Jeff Hao436183f2016-01-12 16:36:50 -08001547 // 3. There are absolute pointers from the code in the oat files to Methods
1548 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001549 //
Jeff Hao436183f2016-01-12 16:36:50 -08001550 // 4. There are absolute pointers from code in the oat files to other code
1551 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001552 //
1553 // To get this all correct, we go through several steps.
1554 //
Jeff Hao436183f2016-01-12 16:36:50 -08001555 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001556 // the oat data size and code size. During this stage, we also set
1557 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001558 //
Jeff Hao436183f2016-01-12 16:36:50 -08001559 // 2. We prepare offsets for the objects in the images and calculate
1560 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001561 //
Jeff Hao436183f2016-01-12 16:36:50 -08001562 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001563 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001564 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001565 // can prepare the ELF headers and we then know the ELF memory segment
1566 // layout and we can now resolve all references. The compiler provides
1567 // LinkerPatch information in each CompiledMethod and we resolve these,
1568 // using the layout information and image object locations provided by
1569 // image writer, as we're writing the method code.
1570 //
Jeff Hao436183f2016-01-12 16:36:50 -08001571 // 4. We create the image files. They need to know where the oat files
1572 // will be loaded after itself. Originally oat files were simply
1573 // memory mapped so we could predict where their contents were based
1574 // on the file size. Now that they are ELF files, we need to inspect
1575 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001576 // where the oat header is located within.
1577 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001578 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001579 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001580 // load the .so at the desired location at runtime by offsetting the
1581 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001582 // TODO: Do this in step 3. We already know the layout there.
1583 //
1584 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1585 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001586
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001587 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1588 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001589 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1590 // case (when the file will be explicitly erased).
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001591 bool WriteOatFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001592 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1593
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001594 // Sync the data to the file, in case we did dex2dex transformations.
1595 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1596 if (!map->Sync()) {
1597 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1598 return false;
1599 }
1600 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001601
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001602 if (IsImage()) {
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001603 if (app_image_ && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001604 gc::Heap* const heap = Runtime::Current()->GetHeap();
1605 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001606 image_base_ = std::max(image_base_, RoundUp(
1607 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1608 kPageSize));
1609 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001610 // The non moving space is right after the oat file. Put the preferred app image location
1611 // right after the non moving space so that we ideally get a continuous immune region for
1612 // the GC.
1613 const size_t non_moving_space_capacity = heap->GetNonMovingSpace()->Capacity();
1614 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001615 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1616 }
1617
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001618 image_writer_.reset(new ImageWriter(*driver_,
1619 image_base_,
1620 compiler_options_->GetCompilePic(),
1621 IsAppImage(),
1622 image_storage_mode_,
1623 oat_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00001624 dex_file_oat_index_map_));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001625
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001626 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001627 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1628 if (!image_writer_->PrepareImageAddressSpace()) {
1629 LOG(ERROR) << "Failed to prepare image address space.";
1630 return false;
1631 }
1632 }
1633
Vladimir Marko944da602016-02-19 12:27:55 +00001634 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001635 {
1636 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001637 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko944da602016-02-19 12:27:55 +00001638 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1639 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
1640
1641 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1642 oat_writer->PrepareLayout(driver_.get(), image_writer_.get(), dex_files, &patcher);
1643
1644 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
1645 size_t text_size = oat_writer->GetSize() - rodata_size;
1646 elf_writer->SetLoadedSectionSizes(rodata_size, text_size, oat_writer->GetBssSize());
1647
1648 if (IsImage()) {
1649 // Update oat layout.
1650 DCHECK(image_writer_ != nullptr);
1651 DCHECK_LT(i, oat_filenames_.size());
1652 image_writer_->UpdateOatFileLayout(i,
1653 elf_writer->GetLoadedSize(),
1654 oat_writer->GetOatDataOffset(),
1655 oat_writer->GetSize());
1656 }
1657 }
1658
1659 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001660 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001661 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1662 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00001663
David Srbecky0c4572e2016-01-22 19:19:25 +00001664 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00001665 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
1666 elf_writer->PrepareDebugInfo(oat_writer->GetMethodDebugInfo());
David Srbecky0c4572e2016-01-22 19:19:25 +00001667
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001668 OutputStream*& rodata = rodata_[i];
1669 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001670 if (!oat_writer->WriteRodata(rodata)) {
1671 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
1672 return false;
1673 }
1674 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001675 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00001676
Jeff Haodcdc85b2015-12-04 14:06:18 -08001677 OutputStream* text = elf_writer->StartText();
1678 if (!oat_writer->WriteCode(text)) {
1679 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
1680 return false;
1681 }
1682 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00001683
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001684 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
1685 image_file_location_oat_checksum_,
1686 image_file_location_oat_data_begin_,
1687 image_patch_delta_)) {
1688 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
1689 return false;
1690 }
1691
Vladimir Marko944da602016-02-19 12:27:55 +00001692 if (IsImage()) {
1693 // Update oat header information.
1694 DCHECK(image_writer_ != nullptr);
1695 DCHECK_LT(i, oat_filenames_.size());
1696 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
1697 }
1698
Jeff Haodcdc85b2015-12-04 14:06:18 -08001699 elf_writer->WriteDynamicSection();
1700 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
1701 elf_writer->WritePatchLocations(oat_writer->GetAbsolutePatchLocations());
Vladimir Marko10c13562015-11-25 14:33:36 +00001702
Jeff Haodcdc85b2015-12-04 14:06:18 -08001703 if (!elf_writer->End()) {
1704 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
1705 return false;
1706 }
1707
1708 // Flush the oat file.
1709 if (oat_files_[i] != nullptr) {
1710 if (oat_files_[i]->Flush() != 0) {
1711 PLOG(ERROR) << "Failed to flush oat file: " << oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08001712 return false;
1713 }
1714 }
1715
Jeff Haodcdc85b2015-12-04 14:06:18 -08001716 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001717
1718 oat_writer.reset();
1719 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001720 }
1721 }
1722
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001723 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001724 }
1725
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001726 // If we are compiling an image, invoke the image creation routine. Else just skip.
1727 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001728 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001729 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
1730 if (!CreateImageFile()) {
1731 return false;
1732 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001733 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07001734 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001735 return true;
1736 }
1737
Jeff Haodcdc85b2015-12-04 14:06:18 -08001738 // Create a copy from stripped to unstripped.
1739 bool CopyStrippedToUnstripped() {
1740 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
1741 // If we don't want to strip in place, copy from stripped location to unstripped location.
1742 // We need to strip after image creation because FixupElf needs to use .strtab.
1743 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
1744 // If the oat file is still open, flush it.
1745 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
1746 if (!FlushCloseOatFile(i)) {
1747 return false;
1748 }
1749 }
1750
1751 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
1752 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
1753 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
1754 size_t buffer_size = 8192;
1755 std::unique_ptr<uint8_t[]> buffer(new uint8_t[buffer_size]);
1756 while (true) {
1757 int bytes_read = TEMP_FAILURE_RETRY(read(in->Fd(), buffer.get(), buffer_size));
1758 if (bytes_read <= 0) {
1759 break;
1760 }
1761 bool write_ok = out->WriteFully(buffer.get(), bytes_read);
1762 CHECK(write_ok);
1763 }
1764 if (out->FlushCloseOrErase() != 0) {
1765 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
1766 return false;
1767 }
1768 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
1769 }
1770 }
1771 return true;
1772 }
1773
1774 bool FlushOatFiles() {
1775 TimingLogger::ScopedTiming t2("dex2oat Flush ELF", timings_);
1776 for (size_t i = 0; i < oat_files_.size(); ++i) {
1777 if (oat_files_[i].get() != nullptr) {
1778 if (oat_files_[i]->Flush() != 0) {
1779 PLOG(ERROR) << "Failed to flush oat file: " << oat_filenames_[i];
1780 oat_files_[i]->Erase();
Andreas Gampe10e477d2014-11-19 12:57:42 -08001781 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001782 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001783 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00001784 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08001785 return true;
1786 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001787
Jeff Haodcdc85b2015-12-04 14:06:18 -08001788 bool FlushCloseOatFile(size_t i) {
1789 if (oat_files_[i].get() != nullptr) {
1790 std::unique_ptr<File> tmp(oat_files_[i].release());
Andreas Gampe10e477d2014-11-19 12:57:42 -08001791 if (tmp->FlushCloseOrErase() != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001792 PLOG(ERROR) << "Failed to flush and close oat file: " << oat_filenames_[i];
Andreas Gampe10e477d2014-11-19 12:57:42 -08001793 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001794 }
1795 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001796 return true;
1797 }
1798
Jeff Haodcdc85b2015-12-04 14:06:18 -08001799 bool FlushCloseOatFiles() {
1800 bool result = true;
1801 for (size_t i = 0; i < oat_files_.size(); ++i) {
1802 result &= FlushCloseOatFile(i);
1803 }
1804 return result;
1805 }
1806
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001807 void DumpTiming() {
1808 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
1809 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
1810 }
1811 if (dump_passes_) {
1812 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
1813 }
1814 }
1815
1816 CompilerOptions* GetCompilerOptions() const {
1817 return compiler_options_.get();
1818 }
1819
Andreas Gampe10e477d2014-11-19 12:57:42 -08001820 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001821 return IsAppImage() || IsBootImage();
1822 }
1823
1824 bool IsAppImage() const {
1825 return app_image_;
1826 }
1827
1828 bool IsBootImage() const {
1829 return boot_image_;
Andreas Gampe10e477d2014-11-19 12:57:42 -08001830 }
1831
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001832 bool IsHost() const {
1833 return is_host_;
1834 }
1835
Calin Juravle998c2162015-12-21 15:39:33 +02001836 bool UseProfileGuidedCompilation() const {
Calin Juravle2e2db782016-02-23 12:00:03 +00001837 return !profile_file_.empty() || (profile_file_fd_ != kInvalidFd);
Calin Juravle998c2162015-12-21 15:39:33 +02001838 }
1839
Calin Juravle2e2db782016-02-23 12:00:03 +00001840 bool LoadProfile() {
Calin Juravle998c2162015-12-21 15:39:33 +02001841 DCHECK(UseProfileGuidedCompilation());
Calin Juravle2e2db782016-02-23 12:00:03 +00001842
1843 profile_compilation_info_.reset(new ProfileCompilationInfo());
1844 ScopedFlock flock;
1845 bool success = false;
1846 std::string error;
1847 if (profile_file_fd_ != -1) {
1848 // The file doesn't need to be flushed so don't check the usage.
1849 // Pass a bogus path so that we can easily attribute any reported error.
1850 File file(profile_file_fd_, "profile", /*check_usage*/ false, /*read_only_mode*/ true);
1851 if (flock.Init(&file, &error)) {
1852 success = profile_compilation_info_->Load(profile_file_fd_);
1853 }
Calin Juravle877fd962016-01-05 14:29:29 +00001854 } else {
Calin Juravle2e2db782016-02-23 12:00:03 +00001855 if (flock.Init(profile_file_.c_str(), O_RDONLY, /* block */ true, &error)) {
1856 success = profile_compilation_info_->Load(flock.GetFile()->Fd());
1857 }
1858 }
1859 if (!error.empty()) {
1860 LOG(WARNING) << "Cannot lock profiles: " << error;
Calin Juravle998c2162015-12-21 15:39:33 +02001861 }
Calin Juravle877fd962016-01-05 14:29:29 +00001862
Calin Juravle2e2db782016-02-23 12:00:03 +00001863 if (!success) {
1864 profile_compilation_info_.reset(nullptr);
1865 }
Calin Juravle877fd962016-01-05 14:29:29 +00001866
Calin Juravle2e2db782016-02-23 12:00:03 +00001867 return success;
Calin Juravle998c2162015-12-21 15:39:33 +02001868 }
1869
1870 bool ShouldCompileBasedOnProfiles() const {
1871 DCHECK(UseProfileGuidedCompilation());
Calin Juravle2e2db782016-02-23 12:00:03 +00001872 // If we are given a profile, compile only if we have some data in it.
1873 return (profile_compilation_info_ != nullptr) &&
1874 (profile_compilation_info_->GetNumberOfMethods() != 0);
Calin Juravle998c2162015-12-21 15:39:33 +02001875 }
1876
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001877 private:
Vladimir Marko49b0f452015-12-10 13:49:19 +00001878 template <typename T>
1879 static std::vector<T*> MakeNonOwningPointerVector(const std::vector<std::unique_ptr<T>>& src) {
1880 std::vector<T*> result;
1881 result.reserve(src.size());
1882 for (const std::unique_ptr<T>& t : src) {
1883 result.push_back(t.get());
1884 }
1885 return result;
1886 }
1887
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001888 std::string GetMultiImageBootClassPath() {
1889 DCHECK(IsBootImage());
1890 DCHECK_GT(oat_filenames_.size(), 1u);
1891 // If the image filename was adapted (e.g., for our tests), we need to change this here,
1892 // too, but need to strip all path components (they will be re-established when loading).
1893 std::ostringstream bootcp_oss;
1894 bool first_bootcp = true;
1895 for (size_t i = 0; i < dex_locations_.size(); ++i) {
1896 if (!first_bootcp) {
1897 bootcp_oss << ":";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001898 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001899
1900 std::string dex_loc = dex_locations_[i];
1901 std::string image_filename = image_filenames_[i];
1902
1903 // Use the dex_loc path, but the image_filename name (without path elements).
1904 size_t dex_last_slash = dex_loc.rfind('/');
1905
1906 // npos is max(size_t). That makes this a bit ugly.
1907 size_t image_last_slash = image_filename.rfind('/');
1908 size_t image_last_at = image_filename.rfind('@');
1909 size_t image_last_sep = (image_last_slash == std::string::npos)
1910 ? image_last_at
1911 : (image_last_at == std::string::npos)
1912 ? std::string::npos
1913 : std::max(image_last_slash, image_last_at);
1914 // Note: whenever image_last_sep == npos, +1 overflow means using the full string.
1915
1916 if (dex_last_slash == std::string::npos) {
1917 dex_loc = image_filename.substr(image_last_sep + 1);
1918 } else {
1919 dex_loc = dex_loc.substr(0, dex_last_slash + 1) +
1920 image_filename.substr(image_last_sep + 1);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001921 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001922
1923 // Image filenames already end with .art, no need to replace.
1924
1925 bootcp_oss << dex_loc;
1926 first_bootcp = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001927 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001928 return bootcp_oss.str();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001929 }
1930
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001931 std::vector<std::string> GetClassPathLocations(const std::string& class_path) {
1932 // This function is used only for apps and for an app we have exactly one oat file.
1933 DCHECK(!IsBootImage());
1934 DCHECK_EQ(oat_writers_.size(), 1u);
1935 std::vector<std::string> dex_files_canonical_locations;
1936 for (const char* location : oat_writers_[0]->GetSourceLocations()) {
1937 dex_files_canonical_locations.push_back(DexFile::GetDexCanonicalLocation(location));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001938 }
Vladimir Marko625a64a2015-11-26 14:44:16 +00001939
Vladimir Marko919f5532016-01-20 19:13:01 +00001940 std::vector<std::string> parsed;
1941 Split(class_path, ':', &parsed);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001942 auto kept_it = std::remove_if(parsed.begin(),
1943 parsed.end(),
1944 [dex_files_canonical_locations](const std::string& location) {
1945 return ContainsElement(dex_files_canonical_locations,
1946 DexFile::GetDexCanonicalLocation(location.c_str()));
1947 });
1948 parsed.erase(kept_it, parsed.end());
1949 return parsed;
1950 }
1951
1952 // Opens requested class path files and appends them to opened_dex_files.
1953 static void OpenClassPathFiles(const std::vector<std::string>& class_path_locations,
1954 std::vector<std::unique_ptr<const DexFile>>* opened_dex_files) {
1955 DCHECK(opened_dex_files != nullptr) << "OpenClassPathFiles out-param is nullptr";
1956 for (const std::string& location : class_path_locations) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001957 std::string error_msg;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001958 if (!DexFile::Open(location.c_str(), location.c_str(), &error_msg, opened_dex_files)) {
1959 LOG(WARNING) << "Failed to open dex file '" << location << "': " << error_msg;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001960 }
1961 }
1962 }
1963
Vladimir Marko49b0f452015-12-10 13:49:19 +00001964 bool PrepareImageClasses() {
1965 // If --image-classes was specified, calculate the full list of classes to include in the image.
1966 if (image_classes_filename_ != nullptr) {
1967 image_classes_ =
1968 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
1969 if (image_classes_ == nullptr) {
1970 return false;
1971 }
1972 } else if (IsBootImage()) {
1973 image_classes_.reset(new std::unordered_set<std::string>);
1974 }
1975 return true;
1976 }
1977
1978 bool PrepareCompiledClasses() {
1979 // If --compiled-classes was specified, calculate the full list of classes to compile in the
1980 // image.
1981 if (compiled_classes_filename_ != nullptr) {
1982 compiled_classes_ =
1983 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
1984 if (compiled_classes_ == nullptr) {
1985 return false;
1986 }
1987 } else {
1988 compiled_classes_.reset(nullptr); // By default compile everything.
1989 }
1990 return true;
1991 }
1992
1993 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
1994 const char* classes_filename,
1995 const char* tag) {
1996 std::unique_ptr<std::unordered_set<std::string>> classes;
1997 std::string error_msg;
1998 if (zip_filename != nullptr) {
1999 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2000 } else {
2001 classes.reset(ReadImageClassesFromFile(classes_filename));
2002 }
2003 if (classes == nullptr) {
2004 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2005 << classes_filename << "': " << error_msg;
2006 }
2007 return classes;
2008 }
2009
2010 bool PrepareCompiledMethods() {
2011 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2012 if (compiled_methods_filename_ != nullptr) {
2013 std::string error_msg;
2014 if (compiled_methods_zip_filename_ != nullptr) {
2015 compiled_methods_.reset(ReadCommentedInputFromZip(compiled_methods_zip_filename_,
2016 compiled_methods_filename_,
2017 nullptr, // No post-processing.
2018 &error_msg));
2019 } else {
2020 compiled_methods_.reset(ReadCommentedInputFromFile(compiled_methods_filename_,
2021 nullptr)); // No post-processing.
2022 }
2023 if (compiled_methods_.get() == nullptr) {
2024 LOG(ERROR) << "Failed to create list of compiled methods from '"
2025 << compiled_methods_filename_ << "': " << error_msg;
2026 return false;
2027 }
2028 } else {
2029 compiled_methods_.reset(nullptr); // By default compile everything.
2030 }
2031 return true;
2032 }
2033
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002034 void PruneNonExistentDexFiles() {
2035 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2036 size_t kept = 0u;
2037 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2038 if (!OS::FileExists(dex_filenames_[i])) {
2039 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2040 } else {
2041 dex_filenames_[kept] = dex_filenames_[i];
2042 dex_locations_[kept] = dex_locations_[i];
2043 ++kept;
2044 }
2045 }
2046 dex_filenames_.resize(kept);
2047 dex_locations_.resize(kept);
2048 }
2049
2050 bool AddDexFileSources() {
2051 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
2052 if (zip_fd_ != -1) {
2053 DCHECK_EQ(oat_writers_.size(), 1u);
2054 if (!oat_writers_[0]->AddZippedDexFilesSource(ScopedFd(zip_fd_), zip_location_.c_str())) {
2055 return false;
2056 }
2057 } else if (oat_writers_.size() > 1u) {
2058 // Multi-image.
2059 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2060 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2061 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2062 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2063 return false;
2064 }
2065 }
2066 } else {
2067 DCHECK_EQ(oat_writers_.size(), 1u);
2068 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2069 DCHECK_NE(dex_filenames_.size(), 0u);
2070 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2071 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2072 return false;
2073 }
2074 }
2075 }
2076 return true;
2077 }
2078
2079 void CreateOatWriters() {
2080 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2081 elf_writers_.reserve(oat_files_.size());
2082 oat_writers_.reserve(oat_files_.size());
2083 for (const std::unique_ptr<File>& oat_file : oat_files_) {
2084 elf_writers_.emplace_back(
2085 CreateElfWriterQuick(instruction_set_, compiler_options_.get(), oat_file.get()));
2086 elf_writers_.back()->Start();
2087 oat_writers_.emplace_back(new OatWriter(IsBootImage(), timings_));
2088 }
2089 }
2090
Vladimir Marko49b0f452015-12-10 13:49:19 +00002091 void SaveDexInput() {
2092 for (size_t i = 0; i < dex_files_.size(); ++i) {
2093 const DexFile* dex_file = dex_files_[i];
2094 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2095 getpid(), i));
2096 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2097 if (tmp_file.get() == nullptr) {
2098 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2099 << ". Try: adb shell chmod 777 /data/local/tmp";
2100 continue;
2101 }
2102 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2103 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2104 UNUSED(tmp_file->Flush());
2105 UNUSED(tmp_file->Close());
2106 LOG(INFO) << "Wrote input to " << tmp_file_name;
2107 }
2108 }
2109
2110 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options) {
2111 RuntimeOptions raw_options;
2112 if (boot_image_filename_.empty()) {
2113 std::string boot_class_path = "-Xbootclasspath:";
2114 boot_class_path += Join(dex_filenames_, ':');
2115 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2116 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
2117 boot_class_path_locations += Join(dex_locations_, ':');
2118 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2119 } else {
2120 std::string boot_image_option = "-Ximage:";
2121 boot_image_option += boot_image_filename_;
2122 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2123 }
2124 for (size_t i = 0; i < runtime_args_.size(); i++) {
2125 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2126 }
2127
2128 raw_options.push_back(std::make_pair("compilercallbacks", callbacks_.get()));
2129 raw_options.push_back(
2130 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2131
2132 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2133 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2134 // have been stripped in preopting, anyways).
2135 if (!IsBootImage()) {
2136 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2137 }
2138 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2139 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2140 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002141 // Disable Hspace compaction to save heap size virtual space.
2142 // Only need disable Hspace for OOM becasue background collector is equal to
2143 // foreground collector by default for dex2oat.
2144 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002145
Andreas Gampeace0dc12016-01-20 13:33:13 -08002146 // If we're asked to be deterministic, ensure non-concurrent GC for determinism. Also
2147 // force the free-list implementation for large objects.
2148 if (compiler_options_->IsForceDeterminism()) {
2149 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
2150 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=freelist", nullptr));
2151
2152 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2153 // compaction (done above) and ensure that neither foreground nor background collectors
2154 // are concurrent.
2155 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2156
2157 // To make identity hashcode deterministic, set a known seed.
2158 mirror::Object::SetHashCodeSeed(987654321U);
2159 }
2160
Vladimir Marko49b0f452015-12-10 13:49:19 +00002161 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2162 LOG(ERROR) << "Failed to parse runtime options";
2163 return false;
2164 }
2165 return true;
2166 }
2167
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002168 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002169 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2170 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002171 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002172 LOG(ERROR) << "Failed to create runtime";
2173 return false;
2174 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002175 runtime_.reset(Runtime::Current());
2176 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002177 for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) {
2178 Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002179 if (!runtime_->HasCalleeSaveMethod(type)) {
2180 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002181 }
2182 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002183 runtime_->GetClassLinker()->FixupDexCaches(runtime_->GetResolutionMethod());
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002184
2185 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2186 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002187 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002188
Vladimir Marko307dac92015-10-20 11:20:09 +01002189 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002190
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002191 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2192 // Runtime::Start, give it away now so that we don't starve GC.
2193 Thread* self = Thread::Current();
2194 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002195
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002196 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002197 }
2198
Jeff Haodcdc85b2015-12-04 14:06:18 -08002199 // 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 -08002200 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002201 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002202 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002203 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002204 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002205 image_filenames_.push_back(app_image_file_name_.c_str());
2206 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002207 if (!image_writer_->Write(app_image_fd_,
2208 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002209 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002210 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002211 return false;
2212 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002213
Jeff Haodcdc85b2015-12-04 14:06:18 -08002214 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002215 dchecked_vector<uintptr_t> oat_data_begins;
2216 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2217 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002218 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002219 // Destroy ImageWriter before doing FixupElf.
2220 image_writer_.reset();
2221
Vladimir Marko944da602016-02-19 12:27:55 +00002222 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2223 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002224 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2225 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2226 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2227 if (oat_file.get() == nullptr) {
2228 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2229 return false;
2230 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002231
Vladimir Marko944da602016-02-19 12:27:55 +00002232 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002233 oat_file->Erase();
2234 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2235 return false;
2236 }
2237
2238 if (oat_file->FlushCloseOrErase()) {
2239 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2240 return false;
2241 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002242 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002243 }
2244
2245 return true;
2246 }
2247
2248 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002249 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2250 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002251 std::function<std::string(const char*)> process = DotToDescriptor;
2252 return ReadCommentedInputFromFile(image_classes_filename, &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002253 }
2254
2255 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002256 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002257 const char* zip_filename,
2258 const char* image_classes_filename,
2259 std::string* error_msg) {
2260 std::function<std::string(const char*)> process = DotToDescriptor;
2261 return ReadCommentedInputFromZip(zip_filename, image_classes_filename, &process, error_msg);
2262 }
2263
2264 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2265 // the given function.
2266 static std::unordered_set<std::string>* ReadCommentedInputFromFile(
2267 const char* input_filename, std::function<std::string(const char*)>* process) {
2268 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2269 if (input_file.get() == nullptr) {
2270 LOG(ERROR) << "Failed to open input file " << input_filename;
2271 return nullptr;
2272 }
2273 std::unique_ptr<std::unordered_set<std::string>> result(
2274 ReadCommentedInputStream(*input_file, process));
2275 input_file->close();
2276 return result.release();
2277 }
2278
2279 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2280 // Post-process each line with the given function.
2281 static std::unordered_set<std::string>* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002282 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002283 const char* input_filename,
2284 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002285 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002286 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2287 if (zip_archive.get() == nullptr) {
2288 return nullptr;
2289 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002290 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002291 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002292 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002293 zip_filename, error_msg->c_str());
2294 return nullptr;
2295 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002296 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2297 input_filename,
2298 error_msg));
2299 if (input_file.get() == nullptr) {
2300 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002301 zip_filename, error_msg->c_str());
2302 return nullptr;
2303 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002304 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2305 input_file->Size());
2306 std::istringstream input_stream(input_string);
2307 return ReadCommentedInputStream(input_stream, process);
2308 }
2309
2310 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2311 // with the given function.
2312 static std::unordered_set<std::string>* ReadCommentedInputStream(
2313 std::istream& in_stream,
2314 std::function<std::string(const char*)>* process) {
2315 std::unique_ptr<std::unordered_set<std::string>> image_classes(
2316 new std::unordered_set<std::string>);
2317 while (in_stream.good()) {
2318 std::string dot;
2319 std::getline(in_stream, dot);
2320 if (StartsWith(dot, "#") || dot.empty()) {
2321 continue;
2322 }
2323 if (process != nullptr) {
2324 std::string descriptor((*process)(dot.c_str()));
2325 image_classes->insert(descriptor);
2326 } else {
2327 image_classes->insert(dot);
2328 }
2329 }
2330 return image_classes.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002331 }
2332
Mathieu Chartier49285c52014-12-02 15:43:48 -08002333 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002334 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2335 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002336 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002337 LOG(INFO) << "dex2oat took " << PrettyDuration(NanoTime() - start_ns_)
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002338 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002339 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002340 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2341 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002342 }
2343
Jeff Haodcdc85b2015-12-04 14:06:18 -08002344 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2345 std::string res(image_filename);
2346 size_t last_slash = res.rfind('/');
2347 if (last_slash == std::string::npos || last_slash == 0) {
2348 return res;
2349 }
2350 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2351 if (penultimate_slash == std::string::npos) {
2352 return res;
2353 }
2354 // Check that the string in-between is the expected one.
2355 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2356 GetInstructionSetString(isa)) {
2357 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2358 return res;
2359 }
2360 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2361 }
2362
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002363 std::unique_ptr<CompilerOptions> compiler_options_;
2364 Compiler::Kind compiler_kind_;
2365
2366 InstructionSet instruction_set_;
2367 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2368
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002369 uint32_t image_file_location_oat_checksum_;
2370 uintptr_t image_file_location_oat_data_begin_;
2371 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002372 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2373
Vladimir Marko307dac92015-10-20 11:20:09 +01002374 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002375
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002376 DexFileToMethodInlinerMap method_inliner_map_;
2377 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2378
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002379 std::unique_ptr<Runtime> runtime_;
2380
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002381 // Ownership for the class path files.
2382 std::vector<std::unique_ptr<const DexFile>> class_path_files_;
2383
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002384 size_t thread_count_;
2385 uint64_t start_ns_;
2386 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002387 std::vector<std::unique_ptr<File>> oat_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002388 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002389 std::vector<const char*> oat_filenames_;
2390 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002391 int oat_fd_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002392 std::vector<const char*> dex_filenames_;
2393 std::vector<const char*> dex_locations_;
2394 int zip_fd_;
2395 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002396 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002397 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002398 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002399 uintptr_t image_base_;
2400 const char* image_classes_zip_filename_;
2401 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002402 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002403 const char* compiled_classes_zip_filename_;
2404 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002405 const char* compiled_methods_zip_filename_;
2406 const char* compiled_methods_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002407 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2408 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002409 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002410 bool app_image_;
2411 bool boot_image_;
Jeff Hao436183f2016-01-12 16:36:50 -08002412 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002413 bool is_host_;
2414 std::string android_root_;
2415 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002416 std::string no_inline_from_string_;
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002417 std::vector<jobject> dex_caches_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002418 jobject class_loader_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002419
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002420 std::vector<std::unique_ptr<ElfWriter>> elf_writers_;
2421 std::vector<std::unique_ptr<OatWriter>> oat_writers_;
2422 std::vector<OutputStream*> rodata_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002423 std::unique_ptr<ImageWriter> image_writer_;
2424 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002425
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002426 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
2427 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2428
Vladimir Marko47496c22016-01-27 16:15:08 +00002429 std::vector<const DexFile*> no_inline_from_dex_files_;
2430
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002431 std::vector<std::string> verbose_methods_;
2432 bool dump_stats_;
2433 bool dump_passes_;
2434 bool dump_timing_;
2435 bool dump_slow_timing_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002436 std::string swap_file_name_;
2437 int swap_fd_;
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002438 std::string app_image_file_name_;
2439 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002440 std::string profile_file_;
2441 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002442 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002443 TimingLogger* timings_;
2444 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002445 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002446 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002447
2448 // Backing storage.
2449 std::vector<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002450
Andreas Gampeace0dc12016-01-20 13:33:13 -08002451 // See CompilerOptions.force_determinism_.
2452 bool force_determinism_;
2453
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002454 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2455};
2456
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002457static void b13564922() {
2458#if defined(__linux__) && defined(__arm__)
2459 int major, minor;
2460 struct utsname uts;
2461 if (uname(&uts) != -1 &&
2462 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2463 ((major < 3) || ((major == 3) && (minor < 4)))) {
2464 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2465 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2466 int old_personality = personality(0xffffffff);
2467 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2468 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2469 if (new_personality == -1) {
2470 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2471 }
2472 }
2473 }
2474#endif
2475}
2476
Andreas Gampe10e477d2014-11-19 12:57:42 -08002477static int CompileImage(Dex2Oat& dex2oat) {
2478 dex2oat.Compile();
2479
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002480 if (!dex2oat.WriteOatFiles()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002481 dex2oat.EraseOatFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002482 return EXIT_FAILURE;
2483 }
2484
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002485 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2486 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2487 // image writer will require this fd to generate the image.
2488 if (dex2oat.ShouldKeepOatFileOpen()) {
2489 if (!dex2oat.FlushOatFiles()) {
2490 return EXIT_FAILURE;
2491 }
2492 } else if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002493 return EXIT_FAILURE;
2494 }
2495
Jeff Haodcdc85b2015-12-04 14:06:18 -08002496 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002497 if (!dex2oat.HandleImage()) {
2498 return EXIT_FAILURE;
2499 }
2500
2501 // When given --host, finish early without stripping.
2502 if (dex2oat.IsHost()) {
2503 dex2oat.DumpTiming();
2504 return EXIT_SUCCESS;
2505 }
2506
Jeff Haodcdc85b2015-12-04 14:06:18 -08002507 // Copy stripped to unstripped location, if necessary.
2508 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002509 return EXIT_FAILURE;
2510 }
2511
Jeff Haodcdc85b2015-12-04 14:06:18 -08002512 // FlushClose again, as stripping might have re-opened the oat files.
2513 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002514 return EXIT_FAILURE;
2515 }
2516
2517 dex2oat.DumpTiming();
2518 return EXIT_SUCCESS;
2519}
2520
2521static int CompileApp(Dex2Oat& dex2oat) {
2522 dex2oat.Compile();
2523
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002524 if (!dex2oat.WriteOatFiles()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002525 dex2oat.EraseOatFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002526 return EXIT_FAILURE;
2527 }
2528
Jeff Haodcdc85b2015-12-04 14:06:18 -08002529 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002530 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002531
2532 // When given --host, finish early without stripping.
2533 if (dex2oat.IsHost()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002534 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002535 return EXIT_FAILURE;
2536 }
2537
2538 dex2oat.DumpTiming();
2539 return EXIT_SUCCESS;
2540 }
2541
Jeff Haodcdc85b2015-12-04 14:06:18 -08002542 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2543 // stripped versions. If this is given, we expect to be able to open writable files by name.
2544 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002545 return EXIT_FAILURE;
2546 }
2547
Jeff Haodcdc85b2015-12-04 14:06:18 -08002548 // Flush and close the files.
2549 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002550 return EXIT_FAILURE;
2551 }
2552
2553 dex2oat.DumpTiming();
2554 return EXIT_SUCCESS;
2555}
2556
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002557static int dex2oat(int argc, char** argv) {
2558 b13564922();
2559
2560 TimingLogger timings("compiler", false, false);
2561
Roland Levillain5c7e2602016-02-23 18:08:53 +00002562 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
2563 // might produce a stack frame too large for this function or for
2564 // functions inlining it (such as main), that would not fit the
2565 // requirements of the `-Wframe-larger-than` option.
2566 std::unique_ptr<Dex2Oat> dex2oat = MakeUnique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002567
2568 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002569 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002570
Calin Juravle998c2162015-12-21 15:39:33 +02002571 // Process profile information and assess if we need to do a profile guided compilation.
2572 // This operation involves I/O.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002573 if (dex2oat->UseProfileGuidedCompilation()) {
2574 if (dex2oat->LoadProfile()) {
2575 if (!dex2oat->ShouldCompileBasedOnProfiles()) {
Calin Juravle998c2162015-12-21 15:39:33 +02002576 LOG(INFO) << "Skipped compilation because of insignificant profile delta";
2577 return EXIT_SUCCESS;
2578 }
2579 } else {
2580 LOG(WARNING) << "Failed to process profile files";
2581 return EXIT_FAILURE;
2582 }
2583 }
2584
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002585 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00002586 if (!dex2oat->OpenFile()) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002587 return EXIT_FAILURE;
2588 }
2589
Andreas Gampe046c7062015-05-18 23:22:54 -07002590 // Print the complete line when any of the following is true:
2591 // 1) Debug build
2592 // 2) Compiling an image
2593 // 3) Compiling with --host
2594 // 4) Compiling on the host (not a target build)
2595 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002596 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07002597 LOG(INFO) << CommandLine();
2598 } else {
2599 LOG(INFO) << StrippedCommandLine();
2600 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002601
Roland Levillain5c7e2602016-02-23 18:08:53 +00002602 if (!dex2oat->Setup()) {
2603 dex2oat->EraseOatFiles();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002604 return EXIT_FAILURE;
2605 }
2606
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002607 bool result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00002608 if (dex2oat->IsImage()) {
2609 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002610 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00002611 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002612 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002613
Roland Levillain5c7e2602016-02-23 18:08:53 +00002614 dex2oat->Shutdown();
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002615 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002616}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002617} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07002618
2619int main(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002620 int result = art::dex2oat(argc, argv);
2621 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
2622 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
2623 // should not destruct the runtime in this case.
Evgenii Stepanov1e133742015-05-20 12:30:59 -07002624 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002625 exit(result);
2626 }
2627 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002628}