blob: bbed09ce146a5397efccabb9ad962b764369ec70 [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
Mathieu Chartiere401d142015-04-22 13:56:20 -070038#include "art_method-inl.h"
Ian Rogersd582fa42014-11-05 23:46:43 -080039#include "arch/instruction_set_features.h"
Andreas Gampec5a3ea72015-01-13 16:41:53 -080040#include "arch/mips/instruction_set_features_mips.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"
Brian Carlstrom7940e442013-07-12 13:46:57 -070043#include "base/stl_util.h"
44#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010045#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070046#include "base/timing_logger.h"
47#include "base/unix_file/fd_file.h"
48#include "class_linker.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000049#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000050#include "compiler_callbacks.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070051#include "dex_file-inl.h"
Mathieu Chartier5bdab122015-01-26 18:30:19 -080052#include "dex/pass_manager.h"
Vladimir Markoc7f83202014-01-24 17:55:18 +000053#include "dex/verification_results.h"
Ian Rogerse63db272014-07-15 15:36:11 -070054#include "dex/quick_compiler_callbacks.h"
55#include "dex/quick/dex_file_to_method_inliner_map.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070056#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080057#include "driver/compiler_options.h"
Vladimir Marko10c13562015-11-25 14:33:36 +000058#include "dwarf/method_debug_info.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080059#include "elf_file.h"
Tong Shen62d1ca32014-09-03 17:24:56 -070060#include "elf_writer.h"
Vladimir Marko10c13562015-11-25 14:33:36 +000061#include "elf_writer_quick.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070062#include "gc/space/image_space.h"
63#include "gc/space/space-inl.h"
64#include "image_writer.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070065#include "interpreter/unstarted_runtime.h"
Calin Juravle998c2162015-12-21 15:39:33 +020066#include "jit/offline_profiling_info.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070067#include "leb128.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070068#include "mirror/class-inl.h"
69#include "mirror/class_loader.h"
70#include "mirror/object-inl.h"
71#include "mirror/object_array-inl.h"
72#include "oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070073#include "os.h"
Calin Juravle998c2162015-12-21 15:39:33 +020074#include "profile_assistant.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070075#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000076#include "runtime_options.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070077#include "ScopedLocalRef.h"
78#include "scoped_thread_state_change.h"
Alex Light53cb16b2014-06-12 11:26:29 -070079#include "utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070080#include "well_known_classes.h"
81#include "zip_archive.h"
82
83namespace art {
84
Brian Carlstrom6449c622014-02-10 23:48:36 -080085static int original_argc;
86static char** original_argv;
87
88static std::string CommandLine() {
89 std::vector<std::string> command;
90 for (int i = 0; i < original_argc; ++i) {
91 command.push_back(original_argv[i]);
92 }
93 return Join(command, ' ');
94}
95
Andreas Gampe046c7062015-05-18 23:22:54 -070096// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
97// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
98// locations are all staged).
99static std::string StrippedCommandLine() {
100 std::vector<std::string> command;
101
102 // Do a pre-pass to look for zip-fd.
103 bool saw_zip_fd = false;
104 for (int i = 0; i < original_argc; ++i) {
105 if (StartsWith(original_argv[i], "--zip-fd=")) {
106 saw_zip_fd = true;
107 break;
108 }
109 }
110
111 // Now filter out things.
112 for (int i = 0; i < original_argc; ++i) {
113 // All runtime-arg parameters are dropped.
114 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
115 i++; // Drop the next part, too.
116 continue;
117 }
118
119 // Any instruction-setXXX is dropped.
120 if (StartsWith(original_argv[i], "--instruction-set")) {
121 continue;
122 }
123
124 // The boot image is dropped.
125 if (StartsWith(original_argv[i], "--boot-image=")) {
126 continue;
127 }
128
129 // This should leave any dex-file and oat-file options, describing what we compiled.
130
131 // However, we prefer to drop this when we saw --zip-fd.
132 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700133 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe046c7062015-05-18 23:22:54 -0700134 if (StartsWith(original_argv[i], "--zip-") ||
135 StartsWith(original_argv[i], "--dex-") ||
136 StartsWith(original_argv[i], "--oat-") ||
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700137 StartsWith(original_argv[i], "--swap-") ||
138 StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700139 continue;
140 }
141 }
142
143 command.push_back(original_argv[i]);
144 }
145
146 // Construct the final output.
147 if (command.size() <= 1U) {
148 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
149 return "Starting dex2oat.";
150 }
151 return Join(command, ' ');
152}
153
Brian Carlstrom7940e442013-07-12 13:46:57 -0700154static void UsageErrorV(const char* fmt, va_list ap) {
155 std::string error;
156 StringAppendV(&error, fmt, ap);
157 LOG(ERROR) << error;
158}
159
160static void UsageError(const char* fmt, ...) {
161 va_list ap;
162 va_start(ap, fmt);
163 UsageErrorV(fmt, ap);
164 va_end(ap);
165}
166
Andreas Gampe794ad762015-02-23 08:12:24 -0800167NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700168 va_list ap;
169 va_start(ap, fmt);
170 UsageErrorV(fmt, ap);
171 va_end(ap);
172
Brian Carlstrom6449c622014-02-10 23:48:36 -0800173 UsageError("Command: %s", CommandLine().c_str());
174
Brian Carlstrom7940e442013-07-12 13:46:57 -0700175 UsageError("Usage: dex2oat [options]...");
176 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100177 UsageError(" -j<number>: specifies the number of threads used for compilation.");
178 UsageError(" Default is the number of detected hardware threads available on the");
179 UsageError(" host system.");
180 UsageError(" Example: -j12");
181 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700182 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700183 UsageError(" Example: --dex-file=/system/framework/core.jar");
184 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700185 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
186 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
187 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
188 UsageError(" --dex-location=/system/framework/core.jar");
189 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700190 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
191 UsageError(" containing a classes.dex file to compile.");
192 UsageError(" Example: --zip-fd=5");
193 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700194 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
195 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700196 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
197 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800198 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700199 UsageError(" Example: --oat-file=/system/framework/boot.oat");
200 UsageError("");
201 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900202 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700203 UsageError("");
204 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
205 UsageError(" to the file descriptor specified by --oat-fd.");
206 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
207 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800208 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700209 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
210 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800211 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700212 UsageError(" Example: --image=/system/framework/boot.art");
213 UsageError("");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800214 UsageError(" --image-format=(uncompressed|lz4):");
215 UsageError(" Which format to store the image.");
216 UsageError(" Example: --image-format=lz4");
217 UsageError(" Default: uncompressed");
218 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700219 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
220 UsageError(" Example: --image=frameworks/base/preloaded-classes");
221 UsageError("");
222 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
223 UsageError(" Example: --base=0x50000000");
224 UsageError("");
225 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000226 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700227 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000228 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000229 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700230 UsageError("");
231 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
232 UsageError(" Example: --android-root=out/host/linux-x86");
233 UsageError(" Default: $ANDROID_ROOT");
234 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800235 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700236 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700237 UsageError(" Example: --instruction-set=x86");
238 UsageError(" Default: arm");
239 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700240 UsageError(" --instruction-set-features=...,: Specify instruction set features");
241 UsageError(" Example: --instruction-set-features=div");
242 UsageError(" Default: default");
243 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700244 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
245 UsageError(" Default: disabled");
246 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800247 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700248 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800249 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100250 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700251 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100252 UsageError(" --compiler-filter="
253 "(verify-none"
254 "|interpret-only"
255 "|space"
256 "|balanced"
257 "|speed"
258 "|everything"
259 "|time):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700260 UsageError(" select compiler filter.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800261 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800262 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800263 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800264 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
265 UsageError(" method for compiler filter tuning.");
266 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
267 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
268 UsageError("");
269 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
270 UsageError(" method for compiler filter tuning.");
271 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
272 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
273 UsageError("");
274 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
275 UsageError(" method for compiler filter tuning.");
276 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
277 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
278 UsageError("");
279 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
280 UsageError(" method for compiler filter tuning.");
281 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
282 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
283 UsageError("");
284 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
285 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Jeff Hao4a200f52014-04-01 14:58:49 -0700286 UsageError(" and the filter is not interpret-only or verify-none, overrides the");
287 UsageError(" filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800288 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
289 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
290 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100291 UsageError(" --inline-depth-limit=<depth-limit>: the depth limit of inlining for fine tuning");
292 UsageError(" the compiler. A zero value will disable inlining. Honored only by Optimizing.");
Roland Levillaina215b952015-08-07 11:38:32 +0100293 UsageError(" Has priority over the --compiler-filter option. Intended for ");
294 UsageError(" development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100295 UsageError(" Example: --inline-depth-limit=%d", CompilerOptions::kDefaultInlineDepthLimit);
296 UsageError(" Default: %d", CompilerOptions::kDefaultInlineDepthLimit);
297 UsageError("");
298 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
299 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100300 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
301 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100302 UsageError(" Example: --inline-max-code-units=%d",
303 CompilerOptions::kDefaultInlineMaxCodeUnits);
304 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
305 UsageError("");
Ian Rogers46398602013-08-20 07:50:36 -0700306 UsageError(" --dump-timing: display a breakdown of where time was spent");
307 UsageError("");
Alex Light53cb16b2014-06-12 11:26:29 -0700308 UsageError(" --include-patch-information: Include patching information so the generated code");
309 UsageError(" can have its base address moved without full recompilation.");
310 UsageError("");
311 UsageError(" --no-include-patch-information: Do not include patching information.");
312 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100313 UsageError(" -g");
314 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
315 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000316 UsageError(" If used without --native-debuggable, it will be best-effort only.");
317 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700318 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100319 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100320 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000321 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
322 UsageError(" debug information necessary to print backtraces. (disabled by default)");
323 UsageError("");
324 UsageError(" --no-generate-mini-debug-info: Do do generated backtrace info.");
325 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000326 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000327 UsageError("");
328 UsageError(" --native-debuggable: Produce code debuggable with native debugger (like LLDB).");
329 UsageError(" Implies --debuggable.");
330 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700331 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
332 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
333 UsageError(" Use a separate --runtime-arg switch for each argument.");
334 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700335 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000336 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Calin Juravle998c2162015-12-21 15:39:33 +0200337 UsageError(" Can be specified multiple time, in which case the data from the different");
338 UsageError(" profiles will be aggregated.");
339 UsageError("");
340 UsageError(" --reference-profile-file=<filename>: specify a reference profile file to use when");
341 UsageError(" compiling. The data in this file will be compared with the data in the");
342 UsageError(" associated --profile-file and the compilation will proceed only if there is");
343 UsageError(" a significant difference (--reference-profile-file is paired with");
344 UsageError(" --profile-file in the natural order). If the compilation was attempted then");
345 UsageError(" --profile-file will be merged into --reference-profile-file. Valid only when");
346 UsageError(" specified together with --profile-file.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700347 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000348 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
349 UsageError(" Cannot be used together with --profile-file.");
350 UsageError("");
351 UsageError(" --reference-profile-file-fd=<number>: same as --reference-profile-file but");
352 UsageError(" accepts a file descriptor. Cannot be used together with");
353 UsageError(" --reference-profile-file.");
Chao-ying Fucd8ce662014-03-11 14:57:19 -0700354 UsageError(" --print-pass-names: print a list of pass names");
355 UsageError("");
356 UsageError(" --disable-passes=<pass-names>: disable one or more passes separated by comma.");
357 UsageError(" Example: --disable-passes=UseCount,BBOptimizations");
358 UsageError("");
Razvan A Lupusorubd25d4b2014-07-02 18:16:51 -0700359 UsageError(" --print-pass-options: print a list of passes that have configurable options along "
360 "with the setting.");
361 UsageError(" Will print default if no overridden setting exists.");
362 UsageError("");
363 UsageError(" --pass-options=Pass1Name:Pass1OptionName:Pass1Option#,"
364 "Pass2Name:Pass2OptionName:Pass2Option#");
365 UsageError(" Used to specify a pass specific option. The setting itself must be integer.");
366 UsageError(" Separator used between options is a comma.");
367 UsageError("");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800368 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
369 UsageError(" Example: --swap-file=/data/tmp/swap.001");
370 UsageError("");
371 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
372 UsageError(" Example: --swap-fd=10");
373 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700374 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
375 UsageError(" Example: --app-image-fd=10");
376 UsageError("");
377 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
378 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
379 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800380 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
381 "input dex file.");
382 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700383 std::cerr << "See log for usage error information\n";
384 exit(EXIT_FAILURE);
385}
386
Brian Carlstrom7940e442013-07-12 13:46:57 -0700387// The primary goal of the watchdog is to prevent stuck build servers
388// during development when fatal aborts lead to a cascade of failures
389// that result in a deadlock.
390class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800391// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700392#undef CHECK_PTHREAD_CALL
393#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
394 do { \
395 int rc = call args; \
396 if (rc != 0) { \
397 errno = rc; \
398 std::string message(# call); \
399 message += " failed for "; \
400 message += reason; \
401 Fatal(message); \
402 } \
403 } while (false)
404
405 public:
Brian Carlstrom93ba8932013-07-17 21:31:49 -0700406 explicit WatchDog(bool is_watch_dog_enabled) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700407 is_watch_dog_enabled_ = is_watch_dog_enabled;
408 if (!is_watch_dog_enabled_) {
409 return;
410 }
411 shutting_down_ = false;
412 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700413 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
414 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700415 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
416 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
417 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
418 }
419 ~WatchDog() {
420 if (!is_watch_dog_enabled_) {
421 return;
422 }
423 const char* reason = "dex2oat watch dog thread shutdown";
424 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
425 shutting_down_ = true;
426 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
427 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
428
Kenny Root51316382014-05-13 14:59:37 -0700429 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700430
431 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
432 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
433 }
434
435 private:
436 static void* CallBack(void* arg) {
437 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
438 ::art::SetThreadName("dex2oat watch dog");
439 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700440 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700441 }
442
Andreas Gampe794ad762015-02-23 08:12:24 -0800443 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700444 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
445 // it's rather easy to hang in unwinding.
446 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
447 // logcat logging or stderr output.
448 LogMessage::LogLine(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700449 exit(1);
450 }
451
452 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700453 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
454 // large.
Andreas Gamped687e372015-04-28 23:16:03 -0700455 constexpr int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700456 timespec timeout_ts;
457 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts);
458 const char* reason = "dex2oat watch dog thread waiting";
459 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
460 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800461 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700462 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700463 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
464 kWatchDogTimeoutSeconds));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700465 } else if (rc != 0) {
466 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
467 strerror(errno)));
468 Fatal(message.c_str());
469 }
470 }
471 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
472 }
473
474 // 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 -0700475 // Debug builds are slower so they have larger timeouts.
Andreas Gamped687e372015-04-28 23:16:03 -0700476 static constexpr int64_t kSlowdownFactor = kIsDebugBuild ? 5U : 1U;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800477
Andreas Gampe540138a2015-09-14 15:34:38 -0700478 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
479 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
480 // itself before that watchdog would take down the system server.
481 static constexpr int64_t kWatchDogTimeoutSeconds = kSlowdownFactor * (9 * 60 + 30);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700482
483 bool is_watch_dog_enabled_;
484 bool shutting_down_;
485 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
486 pthread_mutex_t mutex_;
487 pthread_cond_t cond_;
488 pthread_attr_t attr_;
489 pthread_t pthread_;
490};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700491
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800492static constexpr size_t kMinDexFilesForSwap = 2;
493static constexpr size_t kMinDexFileCumulativeSizeForSwap = 20 * MB;
494
495static bool UseSwap(bool is_image, std::vector<const DexFile*>& dex_files) {
496 if (is_image) {
497 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
498 return false;
499 }
500 if (dex_files.size() < kMinDexFilesForSwap) {
501 // If there are less dex files than the threshold, assume it's gonna be fine.
502 return false;
503 }
504 size_t dex_files_size = 0;
505 for (const auto* dex_file : dex_files) {
506 dex_files_size += dex_file->GetHeader().file_size_;
507 }
508 return dex_files_size >= kMinDexFileCumulativeSizeForSwap;
509}
510
Calin Juravle877fd962016-01-05 14:29:29 +0000511static void CloseAllFds(const std::vector<uint32_t>& fds, const char* descriptor) {
512 for (size_t i = 0; i < fds.size(); i++) {
513 if (close(fds[i]) < 0) {
514 PLOG(WARNING) << "Failed to close descriptor for " << descriptor << " at index " << i;
515 }
516 }
517}
518
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800519class Dex2Oat FINAL {
520 public:
521 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100522 compiler_kind_(Compiler::kOptimizing),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800523 instruction_set_(kRuntimeISA),
524 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000525 image_file_location_oat_checksum_(0),
526 image_file_location_oat_data_begin_(0),
527 image_patch_delta_(0),
528 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700529 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800530 method_inliner_map_(),
531 runtime_(nullptr),
532 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
533 start_ns_(NanoTime()),
534 oat_fd_(-1),
535 zip_fd_(-1),
536 image_base_(0U),
537 image_classes_zip_filename_(nullptr),
538 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800539 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800540 compiled_classes_zip_filename_(nullptr),
541 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700542 compiled_methods_zip_filename_(nullptr),
543 compiled_methods_filename_(nullptr),
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700544 app_image_(false),
545 boot_image_(false),
Jeff Hao436183f2016-01-12 16:36:50 -0800546 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800547 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000548 class_loader_(nullptr),
549 elf_writers_(),
550 oat_writers_(),
551 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000552 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700553 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000554 opened_dex_files_maps_(),
555 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000556 no_inline_from_dex_files_(),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800557 dump_stats_(false),
558 dump_passes_(false),
559 dump_timing_(false),
560 dump_slow_timing_(kIsDebugBuild),
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800561 swap_fd_(-1),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800562 app_image_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800563 timings_(timings),
564 force_determinism_(false) {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800565
566 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800567 // Log completion time before deleting the runtime_, because this accesses
568 // the runtime.
569 LogCompletionTime();
570
Vladimir Marko307dac92015-10-20 11:20:09 +0100571 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
572 // We want to just exit on non-debug builds, not bringing the runtime down
573 // in an orderly fashion. So release the following fields.
574 driver_.release();
575 image_writer_.release();
576 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
577 dex_file.release();
578 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000579 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
580 map.release();
581 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800582 for (std::unique_ptr<File>& oat_file : oat_files_) {
583 oat_file.release();
584 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100585 runtime_.release();
586 verification_results_.release();
587 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100588 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700589 }
590
Roland Levillain9ec5e222015-08-17 20:18:41 +0100591 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800592 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800593 std::string boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800594 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000595 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800596 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100597 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800598
Roland Levillain9ec5e222015-08-17 20:18:41 +0100599 void ParseZipFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000600 ParseUintOption(option, "--zip-fd", &zip_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100601 }
602
603 void ParseOatFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000604 ParseUintOption(option, "--oat-fd", &oat_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100605 }
606
Calin Juravle877fd962016-01-05 14:29:29 +0000607 void ParseFdForCollection(const StringPiece& option,
608 const char* arg_name,
609 std::vector<uint32_t>* fds) {
610 uint32_t fd;
611 ParseUintOption(option, arg_name, &fd, Usage);
612 fds->push_back(fd);
613 }
614
Roland Levillain9ec5e222015-08-17 20:18:41 +0100615 void ParseJ(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000616 ParseUintOption(option, "-j", &thread_count_, Usage, /* is_long_option */ false);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100617 }
618
619 void ParseBase(const StringPiece& option) {
620 DCHECK(option.starts_with("--base="));
621 const char* image_base_str = option.substr(strlen("--base=")).data();
622 char* end;
623 image_base_ = strtoul(image_base_str, &end, 16);
624 if (end == image_base_str || *end != '\0') {
625 Usage("Failed to parse hexadecimal value for option %s", option.data());
626 }
627 }
628
629 void ParseInstructionSet(const StringPiece& option) {
630 DCHECK(option.starts_with("--instruction-set="));
631 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
632 // StringPiece is not necessarily zero-terminated, so need to make a copy and ensure it.
633 std::unique_ptr<char[]> buf(new char[instruction_set_str.length() + 1]);
634 strncpy(buf.get(), instruction_set_str.data(), instruction_set_str.length());
635 buf.get()[instruction_set_str.length()] = 0;
636 instruction_set_ = GetInstructionSetFromString(buf.get());
637 // arm actually means thumb2.
638 if (instruction_set_ == InstructionSet::kArm) {
639 instruction_set_ = InstructionSet::kThumb2;
640 }
641 }
642
643 void ParseInstructionSetVariant(const StringPiece& option, ParserOptions* parser_options) {
644 DCHECK(option.starts_with("--instruction-set-variant="));
645 StringPiece str = option.substr(strlen("--instruction-set-variant=")).data();
646 instruction_set_features_.reset(
647 InstructionSetFeatures::FromVariant(
648 instruction_set_, str.as_string(), &parser_options->error_msg));
649 if (instruction_set_features_.get() == nullptr) {
650 Usage("%s", parser_options->error_msg.c_str());
651 }
652 }
653
654 void ParseInstructionSetFeatures(const StringPiece& option, ParserOptions* parser_options) {
655 DCHECK(option.starts_with("--instruction-set-features="));
656 StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
657 if (instruction_set_features_.get() == nullptr) {
658 instruction_set_features_.reset(
659 InstructionSetFeatures::FromVariant(
660 instruction_set_, "default", &parser_options->error_msg));
661 if (instruction_set_features_.get() == nullptr) {
662 Usage("Problem initializing default instruction set features variant: %s",
663 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700664 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800665 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100666 instruction_set_features_.reset(
667 instruction_set_features_->AddFeaturesFromString(str.as_string(),
668 &parser_options->error_msg));
669 if (instruction_set_features_.get() == nullptr) {
670 Usage("Error parsing '%s': %s", option.data(), parser_options->error_msg.c_str());
671 }
672 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800673
Roland Levillain9ec5e222015-08-17 20:18:41 +0100674 void ParseCompilerBackend(const StringPiece& option, ParserOptions* parser_options) {
675 DCHECK(option.starts_with("--compiler-backend="));
676 parser_options->requested_specific_compiler = true;
677 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
678 if (backend_str == "Quick") {
679 compiler_kind_ = Compiler::kQuick;
680 } else if (backend_str == "Optimizing") {
681 compiler_kind_ = Compiler::kOptimizing;
682 } else {
683 Usage("Unknown compiler backend: %s", backend_str.data());
684 }
685 }
686
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800687 void ParseImageFormat(const StringPiece& option) {
688 const StringPiece substr("--image-format=");
689 DCHECK(option.starts_with(substr));
690 const StringPiece format_str = option.substr(substr.length());
691 if (format_str == "lz4") {
692 image_storage_mode_ = ImageHeader::kStorageModeLZ4;
693 } else if (format_str == "uncompressed") {
694 image_storage_mode_ = ImageHeader::kStorageModeUncompressed;
695 } else {
696 Usage("Unknown image format: %s", format_str.data());
697 }
698 }
699
Jeff Hao436183f2016-01-12 16:36:50 -0800700 void ProcessOptions(ParserOptions* parser_options) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800701 boot_image_ = !image_filenames_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700702 app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
703
704 if (IsAppImage() && IsBootImage()) {
705 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
706 }
707
708 if (IsBootImage()) {
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100709 // We need the boot image to always be debuggable.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000710 compiler_options_->debuggable_ = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000711 }
Nicolas Geoffray9bb492a2014-11-25 23:42:00 +0000712
Jeff Haodcdc85b2015-12-04 14:06:18 -0800713 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800714 Usage("Output must be supplied with either --oat-file or --oat-fd");
715 }
716
Jeff Haodcdc85b2015-12-04 14:06:18 -0800717 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800718 Usage("--oat-file should not be used with --oat-fd");
719 }
720
Roland Levillain9ec5e222015-08-17 20:18:41 +0100721 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800722 Usage("--oat-symbols should not be used with --oat-fd");
723 }
724
Roland Levillain9ec5e222015-08-17 20:18:41 +0100725 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800726 Usage("--oat-symbols should not be used with --host");
727 }
728
Jeff Haodcdc85b2015-12-04 14:06:18 -0800729 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800730 Usage("--oat-fd should not be used with --image");
731 }
732
Jeff Haodcdc85b2015-12-04 14:06:18 -0800733 if (!parser_options->oat_symbols.empty() &&
734 parser_options->oat_symbols.size() != oat_filenames_.size()) {
735 Usage("--oat-file arguments do not match --oat-symbols arguments");
736 }
737
738 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
739 Usage("--oat-file arguments do not match --image arguments");
740 }
741
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800742 if (android_root_.empty()) {
743 const char* android_root_env_var = getenv("ANDROID_ROOT");
744 if (android_root_env_var == nullptr) {
745 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700746 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800747 android_root_ += android_root_env_var;
748 }
749
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700750 if (!boot_image_ && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100751 parser_options->boot_image_filename += android_root_;
752 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800753 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100754 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000755 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800756 }
757
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700758 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800759 Usage("--image-classes should only be used with --image");
760 }
761
Vladimir Marko49b0f452015-12-10 13:49:19 +0000762 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800763 Usage("--image-classes should not be used with --boot-image");
764 }
765
766 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
767 Usage("--image-classes-zip should be used with --image-classes");
768 }
769
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700770 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800771 Usage("--compiled-classes should only be used with --image");
772 }
773
Vladimir Marko49b0f452015-12-10 13:49:19 +0000774 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800775 Usage("--compiled-classes should not be used with --boot-image");
776 }
777
778 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
779 Usage("--compiled-classes-zip should be used with --compiled-classes");
780 }
781
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800782 if (dex_filenames_.empty() && zip_fd_ == -1) {
783 Usage("Input must be supplied with either --dex-file or --zip-fd");
784 }
785
786 if (!dex_filenames_.empty() && zip_fd_ != -1) {
787 Usage("--dex-file should not be used with --zip-fd");
788 }
789
790 if (!dex_filenames_.empty() && !zip_location_.empty()) {
791 Usage("--dex-file should not be used with --zip-location");
792 }
793
794 if (dex_locations_.empty()) {
795 for (const char* dex_file_name : dex_filenames_) {
796 dex_locations_.push_back(dex_file_name);
797 }
798 } else if (dex_locations_.size() != dex_filenames_.size()) {
799 Usage("--dex-location arguments do not match --dex-file arguments");
800 }
801
Jeff Haodcdc85b2015-12-04 14:06:18 -0800802 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
803 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
804 Usage("--oat-file arguments must be singular or match --dex-file arguments");
805 }
806 }
807
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800808 if (zip_fd_ != -1 && zip_location_.empty()) {
809 Usage("--zip-location should be supplied with --zip-fd");
810 }
811
Vladimir Marko49b0f452015-12-10 13:49:19 +0000812 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800813 if (image_base_ == 0) {
814 Usage("Non-zero --base not specified");
815 }
816 }
817
Calin Juravle877fd962016-01-05 14:29:29 +0000818 if (!profile_files_.empty() && !profile_files_fd_.empty()) {
819 Usage("Profile files should not be specified with both --profile-file-fd and --profile-file");
820 }
Calin Juravle998c2162015-12-21 15:39:33 +0200821 if (!profile_files_.empty()) {
822 if (!reference_profile_files_.empty() &&
823 (reference_profile_files_.size() != profile_files_.size())) {
824 Usage("If specified, --reference-profile-file should match the number of --profile-file.");
825 }
Calin Juravle877fd962016-01-05 14:29:29 +0000826 } else if (!reference_profile_files_.empty()) {
827 Usage("--reference-profile-file should only be supplied with --profile-file");
828 }
829 if (!profile_files_fd_.empty()) {
830 if (!reference_profile_files_fd_.empty() &&
831 (reference_profile_files_fd_.size() != profile_files_fd_.size())) {
832 Usage("If specified, --reference-profile-file-fd should match the number",
833 " of --profile-file-fd.");
834 }
835 } else if (!reference_profile_files_fd_.empty()) {
836 Usage("--reference-profile-file-fd should only be supplied with --profile-file-fd");
Calin Juravle998c2162015-12-21 15:39:33 +0200837 }
838
Roland Levillain9ec5e222015-08-17 20:18:41 +0100839 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800840 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800841 }
842
843 // If no instruction set feature was given, use the default one for the target
844 // instruction set.
845 if (instruction_set_features_.get() == nullptr) {
846 instruction_set_features_.reset(
Roland Levillain9ec5e222015-08-17 20:18:41 +0100847 InstructionSetFeatures::FromVariant(
848 instruction_set_, "default", &parser_options->error_msg));
Ian Rogersd582fa42014-11-05 23:46:43 -0800849 if (instruction_set_features_.get() == nullptr) {
850 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100851 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800852 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800853 }
854
855 if (instruction_set_ == kRuntimeISA) {
856 std::unique_ptr<const InstructionSetFeatures> runtime_features(
857 InstructionSetFeatures::FromCppDefines());
858 if (!instruction_set_features_->Equals(runtime_features.get())) {
859 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
860 << *instruction_set_features_ << ") and those of dex2oat executable ("
861 << *runtime_features <<") for the command line:\n"
862 << CommandLine();
863 }
864 }
865
Roland Levillaina215b952015-08-07 11:38:32 +0100866 // It they are not set, use default values for inlining settings.
867 // TODO: We should rethink the compiler filter. We mostly save
868 // time here, which is orthogonal to space.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000869 if (compiler_options_->inline_depth_limit_ == CompilerOptions::kUnsetInlineDepthLimit) {
870 compiler_options_->inline_depth_limit_ =
871 (compiler_options_->compiler_filter_ == CompilerOptions::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100872 // Implementation of the space filter: limit inlining depth.
873 ? CompilerOptions::kSpaceFilterInlineDepthLimit
874 : CompilerOptions::kDefaultInlineDepthLimit;
875 }
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000876 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
877 compiler_options_->inline_max_code_units_ =
878 (compiler_options_->compiler_filter_ == CompilerOptions::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100879 // Implementation of the space filter: limit inlining max code units.
880 ? CompilerOptions::kSpaceFilterInlineMaxCodeUnits
881 : CompilerOptions::kDefaultInlineMaxCodeUnits;
882 }
883
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800884 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800885 // Set the compilation target's implicit checks options.
886 switch (instruction_set_) {
887 case kArm:
888 case kThumb2:
889 case kArm64:
890 case kX86:
891 case kX86_64:
Douglas Leung22bb5a22015-07-02 16:42:08 -0700892 case kMips:
893 case kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000894 compiler_options_->implicit_null_checks_ = true;
895 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800896 break;
897
898 default:
899 // Defaults are correct.
900 break;
901 }
902
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000903 compiler_options_->verbose_methods_ = verbose_methods_.empty() ? nullptr : &verbose_methods_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800904
Jeff Hao436183f2016-01-12 16:36:50 -0800905 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800906 Usage("--multi-image can only be used when creating boot images");
907 }
Jeff Hao436183f2016-01-12 16:36:50 -0800908 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800909 Usage("--multi-image cannot be used with multiple image names");
910 }
911
912 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
913 if (!kIsTargetBuild && IsBootImage()) {
914 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800915 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800916 }
917 }
918
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800919 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100920 if (parser_options->watch_dog_enabled) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800921 watchdog_.reset(new WatchDog(true));
922 }
923
924 // Fill some values into the key-value store for the oat header.
925 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800926
927 // Automatically force determinism for the boot image in a host build.
928 if (!kIsTargetBuild && IsBootImage()) {
929 force_determinism_ = true;
930 }
931 compiler_options_->force_determinism_ = force_determinism_;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100932 }
933
Jeff Hao436183f2016-01-12 16:36:50 -0800934 void ExpandOatAndImageFilenames() {
935 std::string base_oat = oat_filenames_[0];
936 size_t last_oat_slash = base_oat.rfind('/');
937 if (last_oat_slash == std::string::npos) {
938 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
939 }
940 // We also need to honor path components that were encoded through '@'. Otherwise the loading
941 // code won't be able to find the images.
942 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
943 last_oat_slash = base_oat.rfind('@');
944 }
945 base_oat = base_oat.substr(0, last_oat_slash + 1);
946
947 std::string base_img = image_filenames_[0];
948 size_t last_img_slash = base_img.rfind('/');
949 if (last_img_slash == std::string::npos) {
950 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
951 }
952 // We also need to honor path components that were encoded through '@'. Otherwise the loading
953 // code won't be able to find the images.
954 if (base_img.find('@', last_img_slash) != std::string::npos) {
955 last_img_slash = base_img.rfind('@');
956 }
957
958 // Get the prefix, which is the primary image name (without path components). Strip the
959 // extension.
960 std::string prefix = base_img.substr(last_img_slash + 1);
961 if (prefix.rfind('.') != std::string::npos) {
962 prefix = prefix.substr(0, prefix.rfind('.'));
963 }
964 if (!prefix.empty()) {
965 prefix = prefix + "-";
966 }
967
968 base_img = base_img.substr(0, last_img_slash + 1);
969
970 // Note: we have some special case here for our testing. We have to inject the differentiating
971 // parts for the different core images.
972 std::string infix; // Empty infix by default.
973 {
974 // Check the first name.
975 std::string dex_file = oat_filenames_[0];
976 size_t last_dex_slash = dex_file.rfind('/');
977 if (last_dex_slash != std::string::npos) {
978 dex_file = dex_file.substr(last_dex_slash + 1);
979 }
980 size_t last_dex_dot = dex_file.rfind('.');
981 if (last_dex_dot != std::string::npos) {
982 dex_file = dex_file.substr(0, last_dex_dot);
983 }
984 if (StartsWith(dex_file, "core-")) {
985 infix = dex_file.substr(strlen("core"));
986 }
987 }
988
989 // Now create the other names. Use a counted loop to skip the first one.
990 for (size_t i = 1; i < dex_locations_.size(); ++i) {
991 // TODO: Make everything properly std::string.
992 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
993 char_backing_storage_.push_back(base_img + image_name);
994 image_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
995
996 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
997 char_backing_storage_.push_back(base_oat + oat_name);
998 oat_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
999 }
1000 }
1001
Andreas Gampe8994a042015-12-30 19:03:17 +00001002 // Modify the input string in the following way:
1003 // 0) Assume input is /a/b/c.d
1004 // 1) Strip the path -> c.d
1005 // 2) Inject prefix p -> pc.d
1006 // 3) Inject infix i -> pci.d
1007 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -08001008 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +00001009 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001010 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +00001011 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001012 size_t last_dex_slash = in.rfind('/');
1013 if (last_dex_slash != std::string::npos) {
1014 in = in.substr(last_dex_slash + 1);
1015 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001016 if (!prefix.empty()) {
1017 in = prefix + in;
1018 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001019 if (!infix.empty()) {
1020 // Inject infix.
1021 size_t last_dot = in.rfind('.');
1022 if (last_dot != std::string::npos) {
1023 in.insert(last_dot, infix);
1024 }
1025 }
1026 if (EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001027 in = in.substr(0, in.length() - strlen(".jar")) +
1028 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001029 }
1030 return in;
1031 }
1032
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001033 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001034 std::ostringstream oss;
1035 for (int i = 0; i < argc; ++i) {
1036 if (i > 0) {
1037 oss << ' ';
1038 }
1039 oss << argv[i];
1040 }
1041 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1042 oss.str(""); // Reset.
1043 oss << kRuntimeISA;
1044 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1045 key_value_store_->Put(
1046 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001047 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001048 key_value_store_->Put(
1049 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001050 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001051 }
1052
1053 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1054 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1055 // returns, arguments have been successfully parsed.
1056 void ParseArgs(int argc, char** argv) {
1057 original_argc = argc;
1058 original_argv = argv;
1059
1060 InitLogging(argv);
1061
1062 // Skip over argv[0].
1063 argv++;
1064 argc--;
1065
1066 if (argc == 0) {
1067 Usage("No arguments specified");
1068 }
1069
1070 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001071 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001072
1073 for (int i = 0; i < argc; i++) {
1074 const StringPiece option(argv[i]);
1075 const bool log_options = false;
1076 if (log_options) {
1077 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1078 }
1079 if (option.starts_with("--dex-file=")) {
1080 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data());
1081 } else if (option.starts_with("--dex-location=")) {
1082 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data());
1083 } else if (option.starts_with("--zip-fd=")) {
1084 ParseZipFd(option);
1085 } else if (option.starts_with("--zip-location=")) {
1086 zip_location_ = option.substr(strlen("--zip-location=")).data();
1087 } else if (option.starts_with("--oat-file=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001088 oat_filenames_.push_back(option.substr(strlen("--oat-file=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001089 } else if (option.starts_with("--oat-symbols=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001090 parser_options->oat_symbols.push_back(option.substr(strlen("--oat-symbols=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001091 } else if (option.starts_with("--oat-fd=")) {
1092 ParseOatFd(option);
1093 } else if (option == "--watch-dog") {
1094 parser_options->watch_dog_enabled = true;
1095 } else if (option == "--no-watch-dog") {
1096 parser_options->watch_dog_enabled = false;
1097 } else if (option.starts_with("-j")) {
1098 ParseJ(option);
1099 } else if (option.starts_with("--oat-location=")) {
1100 oat_location_ = option.substr(strlen("--oat-location=")).data();
1101 } else if (option.starts_with("--image=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001102 image_filenames_.push_back(option.substr(strlen("--image=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001103 } else if (option.starts_with("--image-classes=")) {
1104 image_classes_filename_ = option.substr(strlen("--image-classes=")).data();
1105 } else if (option.starts_with("--image-classes-zip=")) {
1106 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data();
Mathieu Chartierceb07b32015-12-10 09:33:21 -08001107 } else if (option.starts_with("--image-format=")) {
1108 ParseImageFormat(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001109 } else if (option.starts_with("--compiled-classes=")) {
1110 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data();
1111 } else if (option.starts_with("--compiled-classes-zip=")) {
1112 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data();
1113 } else if (option.starts_with("--compiled-methods=")) {
1114 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data();
1115 } else if (option.starts_with("--compiled-methods-zip=")) {
1116 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data();
1117 } else if (option.starts_with("--base=")) {
1118 ParseBase(option);
1119 } else if (option.starts_with("--boot-image=")) {
1120 parser_options->boot_image_filename = option.substr(strlen("--boot-image=")).data();
1121 } else if (option.starts_with("--android-root=")) {
1122 android_root_ = option.substr(strlen("--android-root=")).data();
1123 } else if (option.starts_with("--instruction-set=")) {
1124 ParseInstructionSet(option);
1125 } else if (option.starts_with("--instruction-set-variant=")) {
1126 ParseInstructionSetVariant(option, parser_options.get());
1127 } else if (option.starts_with("--instruction-set-features=")) {
1128 ParseInstructionSetFeatures(option, parser_options.get());
1129 } else if (option.starts_with("--compiler-backend=")) {
1130 ParseCompilerBackend(option, parser_options.get());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001131 } else if (option.starts_with("--profile-file=")) {
Calin Juravle998c2162015-12-21 15:39:33 +02001132 profile_files_.push_back(option.substr(strlen("--profile-file=")).ToString());
1133 } else if (option.starts_with("--reference-profile-file=")) {
1134 reference_profile_files_.push_back(
1135 option.substr(strlen("--reference-profile-file=")).ToString());
Calin Juravle877fd962016-01-05 14:29:29 +00001136 } else if (option.starts_with("--profile-file-fd=")) {
1137 ParseFdForCollection(option, "--profile-file-fd", &profile_files_fd_);
1138 } else if (option.starts_with("--reference-profile-file-fd=")) {
1139 ParseFdForCollection(option, "--reference_profile-file-fd", &reference_profile_files_fd_);
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001140 } else if (option == "--no-profile-file") {
1141 // No profile
Roland Levillain9ec5e222015-08-17 20:18:41 +01001142 } else if (option == "--host") {
1143 is_host_ = true;
1144 } else if (option == "--runtime-arg") {
1145 if (++i >= argc) {
1146 Usage("Missing required argument for --runtime-arg");
1147 }
1148 if (log_options) {
1149 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1150 }
1151 runtime_args_.push_back(argv[i]);
1152 } else if (option == "--dump-timing") {
1153 dump_timing_ = true;
1154 } else if (option == "--dump-passes") {
1155 dump_passes_ = true;
Roland Levillain9ec5e222015-08-17 20:18:41 +01001156 } else if (option == "--dump-stats") {
1157 dump_stats_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001158 } else if (option.starts_with("--swap-file=")) {
1159 swap_file_name_ = option.substr(strlen("--swap-file=")).data();
1160 } else if (option.starts_with("--swap-fd=")) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001161 ParseUintOption(option, "--swap-fd", &swap_fd_, Usage);
1162 } else if (option.starts_with("--app-image-file=")) {
1163 app_image_file_name_ = option.substr(strlen("--app-image-file=")).data();
1164 } else if (option.starts_with("--app-image-fd=")) {
1165 ParseUintOption(option, "--app-image-fd", &app_image_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001166 } else if (option.starts_with("--verbose-methods=")) {
1167 // TODO: rather than switch off compiler logging, make all VLOG(compiler) messages
1168 // conditional on having verbost methods.
1169 gLogVerbosity.compiler = false;
1170 Split(option.substr(strlen("--verbose-methods=")).ToString(), ',', &verbose_methods_);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001171 } else if (option == "--multi-image") {
Jeff Hao436183f2016-01-12 16:36:50 -08001172 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001173 } else if (option.starts_with("--no-inline-from=")) {
1174 no_inline_from_string_ = option.substr(strlen("--no-inline-from=")).data();
Andreas Gampeace0dc12016-01-20 13:33:13 -08001175 } else if (option == "--force-determinism") {
1176 force_determinism_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001177 } else if (!compiler_options_->ParseCompilerOption(option, Usage)) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001178 Usage("Unknown argument %s", option.data());
1179 }
1180 }
1181
Jeff Hao436183f2016-01-12 16:36:50 -08001182 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001183
1184 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001185 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001186 }
1187
Jeff Haodcdc85b2015-12-04 14:06:18 -08001188 // Check whether the oat output files are writable, and open them for later. Also open a swap
1189 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001190 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001191 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1192 PruneNonExistentDexFiles();
1193
Jeff Hao436183f2016-01-12 16:36:50 -08001194 // Expand oat and image filenames for multi image.
1195 if (IsBootImage() && multi_image_) {
1196 ExpandOatAndImageFilenames();
1197 }
1198
Jeff Haodcdc85b2015-12-04 14:06:18 -08001199 bool create_file = oat_fd_ == -1; // as opposed to using open file descriptor
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001200 if (create_file) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001201 for (const char* oat_filename : oat_filenames_) {
1202 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
1203 if (oat_file.get() == nullptr) {
1204 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1205 return false;
1206 }
1207 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) {
1208 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1209 oat_file->Erase();
1210 return false;
1211 }
1212 oat_files_.push_back(std::move(oat_file));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001213 }
1214 } else {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001215 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, true));
1216 oat_file->DisableAutoClose();
1217 if (oat_file->SetLength(0) != 0) {
Andreas Gampe4303ba92014-11-06 01:00:46 -08001218 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1219 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001220 if (oat_file.get() == nullptr) {
1221 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1222 return false;
1223 }
1224 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) {
1225 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_location_;
1226 oat_file->Erase();
1227 return false;
1228 }
1229 oat_filenames_.push_back(oat_location_.c_str());
1230 oat_files_.push_back(std::move(oat_file));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001231 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001232
1233 // Swap file handling.
1234 //
1235 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1236 // that we can use for swap.
1237 //
1238 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1239 // will immediately unlink to satisfy the swap fd assumption.
1240 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1241 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1242 if (swap_file.get() == nullptr) {
1243 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1244 return false;
1245 }
1246 swap_fd_ = swap_file->Fd();
1247 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1248 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1249 // released immediately.
1250 unlink(swap_file_name_.c_str());
1251 }
Jeff Hao436183f2016-01-12 16:36:50 -08001252
1253 // If we use a swap file, ensure we are above the threshold to make it necessary.
1254 if (swap_fd_ != -1) {
1255 if (!UseSwap(IsBootImage(), dex_files_)) {
1256 close(swap_fd_);
1257 swap_fd_ = -1;
1258 VLOG(compiler) << "Decided to run without swap.";
1259 } else {
1260 LOG(INFO) << "Large app, accepted running with swap.";
1261 }
1262 }
1263 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
1264
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001265 return true;
1266 }
1267
Jeff Haodcdc85b2015-12-04 14:06:18 -08001268 void EraseOatFiles() {
1269 for (size_t i = 0; i < oat_files_.size(); ++i) {
1270 DCHECK(oat_files_[i].get() != nullptr);
1271 oat_files_[i]->Erase();
1272 oat_files_[i].reset();
1273 }
Andreas Gampea650e702014-12-03 14:28:02 -08001274 }
1275
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001276 void Shutdown() {
1277 ScopedObjectAccess soa(Thread::Current());
1278 for (jobject dex_cache : dex_caches_) {
1279 soa.Env()->DeleteLocalRef(dex_cache);
1280 }
1281 dex_caches_.clear();
1282 }
1283
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001284 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1285 // boot class path.
1286 bool Setup() {
1287 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001288 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap.
Vladimir Marko49b0f452015-12-10 13:49:19 +00001289
1290 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods()) {
1291 return false;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001292 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001293
Vladimir Marko307dac92015-10-20 11:20:09 +01001294 verification_results_.reset(new VerificationResults(compiler_options_.get()));
Andreas Gampe4585f872015-03-27 23:45:15 -07001295 callbacks_.reset(new QuickCompilerCallbacks(
Vladimir Marko307dac92015-10-20 11:20:09 +01001296 verification_results_.get(),
Andreas Gampe4585f872015-03-27 23:45:15 -07001297 &method_inliner_map_,
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001298 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001299 CompilerCallbacks::CallbackMode::kCompileBootImage :
1300 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001301
Vladimir Marko49b0f452015-12-10 13:49:19 +00001302 RuntimeArgumentMap runtime_options;
1303 if (!PrepareRuntimeOptions(&runtime_options)) {
1304 return false;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001305 }
1306
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001307 CreateOatWriters();
1308 if (!AddDexFileSources()) {
1309 return false;
1310 }
1311
1312 if (IsBootImage() && image_filenames_.size() > 1) {
1313 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1314 // We need this for the multi-image case.
1315 key_value_store_->Put(OatHeader::kBootClassPath, GetMultiImageBootClassPath());
1316 }
1317
1318 if (!IsBootImage()) {
1319 // When compiling an app, create the runtime early to retrieve
1320 // the image location key needed for the oat header.
1321 if (!CreateRuntime(std::move(runtime_options))) {
1322 return false;
1323 }
1324
1325 {
1326 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1327 std::vector<gc::space::ImageSpace*> image_spaces =
1328 Runtime::Current()->GetHeap()->GetBootImageSpaces();
1329 image_file_location_oat_checksum_ = image_spaces[0]->GetImageHeader().GetOatChecksum();
1330 image_file_location_oat_data_begin_ =
1331 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1332 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1333 // Store the boot image filename(s).
1334 std::vector<std::string> image_filenames;
1335 for (const gc::space::ImageSpace* image_space : image_spaces) {
1336 image_filenames.push_back(image_space->GetImageFilename());
1337 }
1338 std::string image_file_location = Join(image_filenames, ':');
1339 if (!image_file_location.empty()) {
1340 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1341 }
1342 }
1343
1344 // Open dex files for class path.
1345 const std::vector<std::string> class_path_locations =
1346 GetClassPathLocations(runtime_->GetClassPathString());
1347 OpenClassPathFiles(class_path_locations, &class_path_files_);
1348
1349 // Store the classpath we have right now.
1350 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1351 key_value_store_->Put(OatHeader::kClassPathKey,
1352 OatFile::EncodeDexFileDependencies(class_path_files));
1353 }
1354
1355 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001356 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001357 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1358 rodata_.reserve(oat_writers_.size());
1359 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1360 rodata_.push_back(elf_writers_[i]->StartRoData());
1361 // Unzip or copy dex files straight to the oat file.
1362 std::unique_ptr<MemMap> opened_dex_files_map;
1363 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
1364 if (!oat_writers_[i]->WriteAndOpenDexFiles(rodata_.back(),
1365 oat_files_[i].get(),
1366 instruction_set_,
1367 instruction_set_features_.get(),
1368 key_value_store_.get(),
Andreas Gampe3a2bd292016-01-26 17:23:47 -08001369 /* verify */ true,
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001370 &opened_dex_files_map,
1371 &opened_dex_files)) {
1372 return false;
1373 }
1374 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1375 if (opened_dex_files_map != nullptr) {
1376 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
1377 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
1378 dex_file_oat_filename_map_.emplace(dex_file.get(), oat_filenames_[i]);
1379 opened_dex_files_.push_back(std::move(dex_file));
1380 }
1381 } else {
1382 DCHECK(opened_dex_files.empty());
1383 }
1384 }
1385 }
1386
1387 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
1388 if (IsBootImage()) {
1389 // For boot image, pass opened dex files to the Runtime::Create().
1390 // Note: Runtime acquires ownership of these dex files.
1391 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001392 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001393 return false;
1394 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001395 }
1396
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001397 // If we're doing the image, override the compiler filter to force full compilation. Must be
1398 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1399 // compilation of class initializers.
1400 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001401 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001402 WellKnownClasses::Init(self->GetJniEnv());
1403
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001404 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001405 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001406 constexpr bool kSaveDexInput = false;
1407 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001408 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001409 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001410
1411 // Handle and ClassLoader creation needs to come after Runtime::Create.
1412 ScopedObjectAccess soa(self);
1413
1414 // Classpath: first the class-path given.
1415 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1416
1417 // Then the dex files we'll compile. Thus we'll resolve the class-path first.
1418 class_path_files.insert(class_path_files.end(), dex_files_.begin(), dex_files_.end());
1419
1420 class_loader_ = class_linker->CreatePathClassLoader(self, class_path_files);
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001421 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001422
1423 // Ensure opened dex files are writable for dex-to-dex transformations.
1424 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1425 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1426 PLOG(ERROR) << "Failed to make .dex files writeable.";
1427 return false;
Vladimir Marko919f5532016-01-20 19:13:01 +00001428 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001429 }
1430
1431 // Ensure that the dex caches stay live since we don't want class unloading
1432 // to occur during compilation.
1433 for (const auto& dex_file : dex_files_) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001434 ScopedObjectAccess soa(self);
1435 dex_caches_.push_back(soa.AddLocalReference<jobject>(
Mathieu Chartierd57d4542015-10-14 10:55:30 -07001436 class_linker->RegisterDexFile(*dex_file, Runtime::Current()->GetLinearAlloc())));
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001437 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001438
1439 /*
1440 * If we're not in interpret-only or verify-none mode, go ahead and compile small applications.
1441 * Don't bother to check if we're doing the image.
1442 */
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001443 if (!IsBootImage() &&
Brian Carlstrom95b033b2014-12-03 22:29:37 -08001444 compiler_options_->IsCompilationEnabled() &&
1445 compiler_kind_ == Compiler::kQuick) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001446 size_t num_methods = 0;
1447 for (size_t i = 0; i != dex_files_.size(); ++i) {
1448 const DexFile* dex_file = dex_files_[i];
1449 CHECK(dex_file != nullptr);
1450 num_methods += dex_file->NumMethodIds();
1451 }
1452 if (num_methods <= compiler_options_->GetNumDexMethodsThreshold()) {
1453 compiler_options_->SetCompilerFilter(CompilerOptions::kSpeed);
1454 VLOG(compiler) << "Below method threshold, compiling anyways";
1455 }
1456 }
1457
1458 return true;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001459 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001460
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001461 // If we need to keep the oat file open for the image writer.
1462 bool ShouldKeepOatFileOpen() const {
1463 return IsImage() && oat_fd_ != kInvalidFd;
1464 }
1465
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001466 // Create and invoke the compiler driver. This will compile all the dex files.
1467 void Compile() {
1468 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1469 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001470
Vladimir Marko47496c22016-01-27 16:15:08 +00001471 // Find the dex files we should not inline from.
1472
1473 std::vector<std::string> no_inline_filters;
1474 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001475
1476 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001477 const std::string core_oj = "core-oj";
1478 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1479 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001480 }
1481
Vladimir Marko47496c22016-01-27 16:15:08 +00001482 if (!no_inline_filters.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001483 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1484 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1485 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1486 &class_linker->GetBootClassPath(),
1487 &class_path_files,
1488 &dex_files_
1489 };
1490 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001491 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001492 for (const std::string& filter : no_inline_filters) {
1493 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
1494 // allows tests to specify <test-dexfile>:classes2.dex if needed but if the
1495 // base location passes the StartsWith() test, so do all extra locations.
1496 std::string dex_location = dex_file->GetLocation();
1497 if (filter.find('/') == std::string::npos) {
1498 // The filter does not contain the path. Remove the path from dex_location as well.
1499 size_t last_slash = dex_file->GetLocation().rfind('/');
1500 if (last_slash != std::string::npos) {
1501 dex_location = dex_location.substr(last_slash + 1);
1502 }
1503 }
1504
1505 if (StartsWith(dex_location, filter.c_str())) {
1506 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1507 no_inline_from_dex_files_.push_back(dex_file);
1508 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001509 }
1510 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001511 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001512 }
1513 if (!no_inline_from_dex_files_.empty()) {
1514 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001515 }
1516 }
1517
Vladimir Marko307dac92015-10-20 11:20:09 +01001518 driver_.reset(new CompilerDriver(compiler_options_.get(),
1519 verification_results_.get(),
1520 &method_inliner_map_,
1521 compiler_kind_,
1522 instruction_set_,
1523 instruction_set_features_.get(),
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001524 IsBootImage(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001525 image_classes_.release(),
1526 compiled_classes_.release(),
1527 nullptr,
1528 thread_count_,
1529 dump_stats_,
1530 dump_passes_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001531 compiler_phases_timings_.get(),
1532 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001533 &dex_file_oat_filename_map_,
1534 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001535 driver_->SetDexFilesForOatFile(dex_files_);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001536 driver_->CompileAll(class_loader_, dex_files_, timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001537 }
1538
Jeff Hao436183f2016-01-12 16:36:50 -08001539 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001540 // ensure the references between the two are correct.
1541 //
1542 // Currently we have a memory layout that looks something like this:
1543 //
1544 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001545 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001546 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001547 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001548 // +--------------+
1549 // | alloc spaces |
1550 // +--------------+
1551 //
Jeff Hao436183f2016-01-12 16:36:50 -08001552 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001553 //
Jeff Hao436183f2016-01-12 16:36:50 -08001554 // 1. The images are expected to be loaded at an absolute address and
1555 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001556 //
Jeff Hao436183f2016-01-12 16:36:50 -08001557 // 2. There are absolute pointers from Methods in the images to their
1558 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001559 //
Jeff Hao436183f2016-01-12 16:36:50 -08001560 // 3. There are absolute pointers from the code in the oat files to Methods
1561 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001562 //
Jeff Hao436183f2016-01-12 16:36:50 -08001563 // 4. There are absolute pointers from code in the oat files to other code
1564 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001565 //
1566 // To get this all correct, we go through several steps.
1567 //
Jeff Hao436183f2016-01-12 16:36:50 -08001568 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001569 // the oat data size and code size. During this stage, we also set
1570 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001571 //
Jeff Hao436183f2016-01-12 16:36:50 -08001572 // 2. We prepare offsets for the objects in the images and calculate
1573 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001574 //
Jeff Hao436183f2016-01-12 16:36:50 -08001575 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001576 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001577 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001578 // can prepare the ELF headers and we then know the ELF memory segment
1579 // layout and we can now resolve all references. The compiler provides
1580 // LinkerPatch information in each CompiledMethod and we resolve these,
1581 // using the layout information and image object locations provided by
1582 // image writer, as we're writing the method code.
1583 //
Jeff Hao436183f2016-01-12 16:36:50 -08001584 // 4. We create the image files. They need to know where the oat files
1585 // will be loaded after itself. Originally oat files were simply
1586 // memory mapped so we could predict where their contents were based
1587 // on the file size. Now that they are ELF files, we need to inspect
1588 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001589 // where the oat header is located within.
1590 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001591 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001592 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001593 // load the .so at the desired location at runtime by offsetting the
1594 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001595 // TODO: Do this in step 3. We already know the layout there.
1596 //
1597 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1598 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001599
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001600 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1601 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001602 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1603 // case (when the file will be explicitly erased).
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001604 bool WriteOatFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001605 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1606
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001607 // Sync the data to the file, in case we did dex2dex transformations.
1608 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1609 if (!map->Sync()) {
1610 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1611 return false;
1612 }
1613 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001614
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001615 if (IsImage()) {
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001616 if (app_image_ && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001617 gc::Heap* const heap = Runtime::Current()->GetHeap();
1618 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001619 image_base_ = std::max(image_base_, RoundUp(
1620 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1621 kPageSize));
1622 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001623 // The non moving space is right after the oat file. Put the preferred app image location
1624 // right after the non moving space so that we ideally get a continuous immune region for
1625 // the GC.
1626 const size_t non_moving_space_capacity = heap->GetNonMovingSpace()->Capacity();
1627 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001628 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1629 }
1630
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001631 image_writer_.reset(new ImageWriter(*driver_,
1632 image_base_,
1633 compiler_options_->GetCompilePic(),
1634 IsAppImage(),
1635 image_storage_mode_,
1636 oat_filenames_,
1637 dex_file_oat_filename_map_));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001638
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001639 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001640 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1641 if (!image_writer_->PrepareImageAddressSpace()) {
1642 LOG(ERROR) << "Failed to prepare image address space.";
1643 return false;
1644 }
1645 }
1646
1647 {
1648 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001649 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001650 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001651 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1652 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00001653
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001654 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1655 oat_writer->PrepareLayout(driver_.get(), image_writer_.get(), dex_files);
Vladimir Marko10c13562015-11-25 14:33:36 +00001656
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001657 OutputStream*& rodata = rodata_[i];
1658 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001659 if (!oat_writer->WriteRodata(rodata)) {
1660 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
1661 return false;
1662 }
1663 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001664 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00001665
Jeff Haodcdc85b2015-12-04 14:06:18 -08001666 OutputStream* text = elf_writer->StartText();
1667 if (!oat_writer->WriteCode(text)) {
1668 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
1669 return false;
1670 }
1671 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00001672
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001673 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
1674 image_file_location_oat_checksum_,
1675 image_file_location_oat_data_begin_,
1676 image_patch_delta_)) {
1677 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
1678 return false;
1679 }
1680
Jeff Haodcdc85b2015-12-04 14:06:18 -08001681 elf_writer->SetBssSize(oat_writer->GetBssSize());
1682 elf_writer->WriteDynamicSection();
1683 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
1684 elf_writer->WritePatchLocations(oat_writer->GetAbsolutePatchLocations());
Vladimir Marko10c13562015-11-25 14:33:36 +00001685
Jeff Haodcdc85b2015-12-04 14:06:18 -08001686 if (!elf_writer->End()) {
1687 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
1688 return false;
1689 }
1690
1691 // Flush the oat file.
1692 if (oat_files_[i] != nullptr) {
1693 if (oat_files_[i]->Flush() != 0) {
1694 PLOG(ERROR) << "Failed to flush oat file: " << oat_filenames_[i];
1695 oat_files_[i]->Erase();
1696 return false;
1697 }
1698 }
1699
1700 if (IsImage()) {
1701 // Update oat estimates.
1702 UpdateImageWriter(i);
1703 }
1704
1705 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001706
1707 oat_writer.reset();
1708 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001709 }
1710 }
1711
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001712 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001713 }
1714
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001715 // If we are compiling an image, invoke the image creation routine. Else just skip.
1716 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001717 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001718 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
1719 if (!CreateImageFile()) {
1720 return false;
1721 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001722 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07001723 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001724 return true;
1725 }
1726
Jeff Haodcdc85b2015-12-04 14:06:18 -08001727 // Create a copy from stripped to unstripped.
1728 bool CopyStrippedToUnstripped() {
1729 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
1730 // If we don't want to strip in place, copy from stripped location to unstripped location.
1731 // We need to strip after image creation because FixupElf needs to use .strtab.
1732 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
1733 // If the oat file is still open, flush it.
1734 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
1735 if (!FlushCloseOatFile(i)) {
1736 return false;
1737 }
1738 }
1739
1740 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
1741 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
1742 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
1743 size_t buffer_size = 8192;
1744 std::unique_ptr<uint8_t[]> buffer(new uint8_t[buffer_size]);
1745 while (true) {
1746 int bytes_read = TEMP_FAILURE_RETRY(read(in->Fd(), buffer.get(), buffer_size));
1747 if (bytes_read <= 0) {
1748 break;
1749 }
1750 bool write_ok = out->WriteFully(buffer.get(), bytes_read);
1751 CHECK(write_ok);
1752 }
1753 if (out->FlushCloseOrErase() != 0) {
1754 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
1755 return false;
1756 }
1757 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
1758 }
1759 }
1760 return true;
1761 }
1762
1763 bool FlushOatFiles() {
1764 TimingLogger::ScopedTiming t2("dex2oat Flush ELF", timings_);
1765 for (size_t i = 0; i < oat_files_.size(); ++i) {
1766 if (oat_files_[i].get() != nullptr) {
1767 if (oat_files_[i]->Flush() != 0) {
1768 PLOG(ERROR) << "Failed to flush oat file: " << oat_filenames_[i];
1769 oat_files_[i]->Erase();
Andreas Gampe10e477d2014-11-19 12:57:42 -08001770 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001771 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001772 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00001773 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08001774 return true;
1775 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001776
Jeff Haodcdc85b2015-12-04 14:06:18 -08001777 bool FlushCloseOatFile(size_t i) {
1778 if (oat_files_[i].get() != nullptr) {
1779 std::unique_ptr<File> tmp(oat_files_[i].release());
Andreas Gampe10e477d2014-11-19 12:57:42 -08001780 if (tmp->FlushCloseOrErase() != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001781 PLOG(ERROR) << "Failed to flush and close oat file: " << oat_filenames_[i];
Andreas Gampe10e477d2014-11-19 12:57:42 -08001782 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001783 }
1784 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001785 return true;
1786 }
1787
Jeff Haodcdc85b2015-12-04 14:06:18 -08001788 bool FlushCloseOatFiles() {
1789 bool result = true;
1790 for (size_t i = 0; i < oat_files_.size(); ++i) {
1791 result &= FlushCloseOatFile(i);
1792 }
1793 return result;
1794 }
1795
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001796 void DumpTiming() {
1797 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
1798 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
1799 }
1800 if (dump_passes_) {
1801 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
1802 }
1803 }
1804
1805 CompilerOptions* GetCompilerOptions() const {
1806 return compiler_options_.get();
1807 }
1808
Andreas Gampe10e477d2014-11-19 12:57:42 -08001809 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001810 return IsAppImage() || IsBootImage();
1811 }
1812
1813 bool IsAppImage() const {
1814 return app_image_;
1815 }
1816
1817 bool IsBootImage() const {
1818 return boot_image_;
Andreas Gampe10e477d2014-11-19 12:57:42 -08001819 }
1820
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001821 bool IsHost() const {
1822 return is_host_;
1823 }
1824
Calin Juravle998c2162015-12-21 15:39:33 +02001825 bool UseProfileGuidedCompilation() const {
Calin Juravle877fd962016-01-05 14:29:29 +00001826 return !profile_files_.empty() || !profile_files_fd_.empty();
Calin Juravle998c2162015-12-21 15:39:33 +02001827 }
1828
1829 bool ProcessProfiles() {
1830 DCHECK(UseProfileGuidedCompilation());
1831 ProfileCompilationInfo* info = nullptr;
Calin Juravle877fd962016-01-05 14:29:29 +00001832 bool result = false;
1833 if (profile_files_.empty()) {
1834 DCHECK(!profile_files_fd_.empty());
1835 result = ProfileAssistant::ProcessProfiles(
1836 profile_files_fd_, reference_profile_files_fd_, &info);
1837 CloseAllFds(profile_files_fd_, "profile_files_fd_");
1838 CloseAllFds(reference_profile_files_fd_, "reference_profile_files_fd_");
1839 } else {
1840 result = ProfileAssistant::ProcessProfiles(
1841 profile_files_, reference_profile_files_, &info);
Calin Juravle998c2162015-12-21 15:39:33 +02001842 }
Calin Juravle877fd962016-01-05 14:29:29 +00001843
1844 profile_compilation_info_.reset(info);
1845
1846 return result;
Calin Juravle998c2162015-12-21 15:39:33 +02001847 }
1848
1849 bool ShouldCompileBasedOnProfiles() const {
1850 DCHECK(UseProfileGuidedCompilation());
1851 // If we are given profiles, compile only if we have new information.
1852 return profile_compilation_info_ != nullptr;
1853 }
1854
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001855 private:
Vladimir Marko49b0f452015-12-10 13:49:19 +00001856 template <typename T>
1857 static std::vector<T*> MakeNonOwningPointerVector(const std::vector<std::unique_ptr<T>>& src) {
1858 std::vector<T*> result;
1859 result.reserve(src.size());
1860 for (const std::unique_ptr<T>& t : src) {
1861 result.push_back(t.get());
1862 }
1863 return result;
1864 }
1865
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001866 std::string GetMultiImageBootClassPath() {
1867 DCHECK(IsBootImage());
1868 DCHECK_GT(oat_filenames_.size(), 1u);
1869 // If the image filename was adapted (e.g., for our tests), we need to change this here,
1870 // too, but need to strip all path components (they will be re-established when loading).
1871 std::ostringstream bootcp_oss;
1872 bool first_bootcp = true;
1873 for (size_t i = 0; i < dex_locations_.size(); ++i) {
1874 if (!first_bootcp) {
1875 bootcp_oss << ":";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001876 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001877
1878 std::string dex_loc = dex_locations_[i];
1879 std::string image_filename = image_filenames_[i];
1880
1881 // Use the dex_loc path, but the image_filename name (without path elements).
1882 size_t dex_last_slash = dex_loc.rfind('/');
1883
1884 // npos is max(size_t). That makes this a bit ugly.
1885 size_t image_last_slash = image_filename.rfind('/');
1886 size_t image_last_at = image_filename.rfind('@');
1887 size_t image_last_sep = (image_last_slash == std::string::npos)
1888 ? image_last_at
1889 : (image_last_at == std::string::npos)
1890 ? std::string::npos
1891 : std::max(image_last_slash, image_last_at);
1892 // Note: whenever image_last_sep == npos, +1 overflow means using the full string.
1893
1894 if (dex_last_slash == std::string::npos) {
1895 dex_loc = image_filename.substr(image_last_sep + 1);
1896 } else {
1897 dex_loc = dex_loc.substr(0, dex_last_slash + 1) +
1898 image_filename.substr(image_last_sep + 1);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001899 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001900
1901 // Image filenames already end with .art, no need to replace.
1902
1903 bootcp_oss << dex_loc;
1904 first_bootcp = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001905 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001906 return bootcp_oss.str();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001907 }
1908
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001909 std::vector<std::string> GetClassPathLocations(const std::string& class_path) {
1910 // This function is used only for apps and for an app we have exactly one oat file.
1911 DCHECK(!IsBootImage());
1912 DCHECK_EQ(oat_writers_.size(), 1u);
1913 std::vector<std::string> dex_files_canonical_locations;
1914 for (const char* location : oat_writers_[0]->GetSourceLocations()) {
1915 dex_files_canonical_locations.push_back(DexFile::GetDexCanonicalLocation(location));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001916 }
Vladimir Marko625a64a2015-11-26 14:44:16 +00001917
Vladimir Marko919f5532016-01-20 19:13:01 +00001918 std::vector<std::string> parsed;
1919 Split(class_path, ':', &parsed);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001920 auto kept_it = std::remove_if(parsed.begin(),
1921 parsed.end(),
1922 [dex_files_canonical_locations](const std::string& location) {
1923 return ContainsElement(dex_files_canonical_locations,
1924 DexFile::GetDexCanonicalLocation(location.c_str()));
1925 });
1926 parsed.erase(kept_it, parsed.end());
1927 return parsed;
1928 }
1929
1930 // Opens requested class path files and appends them to opened_dex_files.
1931 static void OpenClassPathFiles(const std::vector<std::string>& class_path_locations,
1932 std::vector<std::unique_ptr<const DexFile>>* opened_dex_files) {
1933 DCHECK(opened_dex_files != nullptr) << "OpenClassPathFiles out-param is nullptr";
1934 for (const std::string& location : class_path_locations) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001935 std::string error_msg;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001936 if (!DexFile::Open(location.c_str(), location.c_str(), &error_msg, opened_dex_files)) {
1937 LOG(WARNING) << "Failed to open dex file '" << location << "': " << error_msg;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001938 }
1939 }
1940 }
1941
Vladimir Marko49b0f452015-12-10 13:49:19 +00001942 bool PrepareImageClasses() {
1943 // If --image-classes was specified, calculate the full list of classes to include in the image.
1944 if (image_classes_filename_ != nullptr) {
1945 image_classes_ =
1946 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
1947 if (image_classes_ == nullptr) {
1948 return false;
1949 }
1950 } else if (IsBootImage()) {
1951 image_classes_.reset(new std::unordered_set<std::string>);
1952 }
1953 return true;
1954 }
1955
1956 bool PrepareCompiledClasses() {
1957 // If --compiled-classes was specified, calculate the full list of classes to compile in the
1958 // image.
1959 if (compiled_classes_filename_ != nullptr) {
1960 compiled_classes_ =
1961 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
1962 if (compiled_classes_ == nullptr) {
1963 return false;
1964 }
1965 } else {
1966 compiled_classes_.reset(nullptr); // By default compile everything.
1967 }
1968 return true;
1969 }
1970
1971 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
1972 const char* classes_filename,
1973 const char* tag) {
1974 std::unique_ptr<std::unordered_set<std::string>> classes;
1975 std::string error_msg;
1976 if (zip_filename != nullptr) {
1977 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
1978 } else {
1979 classes.reset(ReadImageClassesFromFile(classes_filename));
1980 }
1981 if (classes == nullptr) {
1982 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
1983 << classes_filename << "': " << error_msg;
1984 }
1985 return classes;
1986 }
1987
1988 bool PrepareCompiledMethods() {
1989 // If --compiled-methods was specified, read the methods to compile from the given file(s).
1990 if (compiled_methods_filename_ != nullptr) {
1991 std::string error_msg;
1992 if (compiled_methods_zip_filename_ != nullptr) {
1993 compiled_methods_.reset(ReadCommentedInputFromZip(compiled_methods_zip_filename_,
1994 compiled_methods_filename_,
1995 nullptr, // No post-processing.
1996 &error_msg));
1997 } else {
1998 compiled_methods_.reset(ReadCommentedInputFromFile(compiled_methods_filename_,
1999 nullptr)); // No post-processing.
2000 }
2001 if (compiled_methods_.get() == nullptr) {
2002 LOG(ERROR) << "Failed to create list of compiled methods from '"
2003 << compiled_methods_filename_ << "': " << error_msg;
2004 return false;
2005 }
2006 } else {
2007 compiled_methods_.reset(nullptr); // By default compile everything.
2008 }
2009 return true;
2010 }
2011
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002012 void PruneNonExistentDexFiles() {
2013 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2014 size_t kept = 0u;
2015 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2016 if (!OS::FileExists(dex_filenames_[i])) {
2017 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2018 } else {
2019 dex_filenames_[kept] = dex_filenames_[i];
2020 dex_locations_[kept] = dex_locations_[i];
2021 ++kept;
2022 }
2023 }
2024 dex_filenames_.resize(kept);
2025 dex_locations_.resize(kept);
2026 }
2027
2028 bool AddDexFileSources() {
2029 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
2030 if (zip_fd_ != -1) {
2031 DCHECK_EQ(oat_writers_.size(), 1u);
2032 if (!oat_writers_[0]->AddZippedDexFilesSource(ScopedFd(zip_fd_), zip_location_.c_str())) {
2033 return false;
2034 }
2035 } else if (oat_writers_.size() > 1u) {
2036 // Multi-image.
2037 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2038 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2039 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2040 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2041 return false;
2042 }
2043 }
2044 } else {
2045 DCHECK_EQ(oat_writers_.size(), 1u);
2046 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2047 DCHECK_NE(dex_filenames_.size(), 0u);
2048 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2049 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2050 return false;
2051 }
2052 }
2053 }
2054 return true;
2055 }
2056
2057 void CreateOatWriters() {
2058 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2059 elf_writers_.reserve(oat_files_.size());
2060 oat_writers_.reserve(oat_files_.size());
2061 for (const std::unique_ptr<File>& oat_file : oat_files_) {
2062 elf_writers_.emplace_back(
2063 CreateElfWriterQuick(instruction_set_, compiler_options_.get(), oat_file.get()));
2064 elf_writers_.back()->Start();
2065 oat_writers_.emplace_back(new OatWriter(IsBootImage(), timings_));
2066 }
2067 }
2068
Vladimir Marko49b0f452015-12-10 13:49:19 +00002069 void SaveDexInput() {
2070 for (size_t i = 0; i < dex_files_.size(); ++i) {
2071 const DexFile* dex_file = dex_files_[i];
2072 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2073 getpid(), i));
2074 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2075 if (tmp_file.get() == nullptr) {
2076 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2077 << ". Try: adb shell chmod 777 /data/local/tmp";
2078 continue;
2079 }
2080 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2081 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2082 UNUSED(tmp_file->Flush());
2083 UNUSED(tmp_file->Close());
2084 LOG(INFO) << "Wrote input to " << tmp_file_name;
2085 }
2086 }
2087
2088 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options) {
2089 RuntimeOptions raw_options;
2090 if (boot_image_filename_.empty()) {
2091 std::string boot_class_path = "-Xbootclasspath:";
2092 boot_class_path += Join(dex_filenames_, ':');
2093 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2094 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
2095 boot_class_path_locations += Join(dex_locations_, ':');
2096 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2097 } else {
2098 std::string boot_image_option = "-Ximage:";
2099 boot_image_option += boot_image_filename_;
2100 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2101 }
2102 for (size_t i = 0; i < runtime_args_.size(); i++) {
2103 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2104 }
2105
2106 raw_options.push_back(std::make_pair("compilercallbacks", callbacks_.get()));
2107 raw_options.push_back(
2108 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2109
2110 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2111 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2112 // have been stripped in preopting, anyways).
2113 if (!IsBootImage()) {
2114 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2115 }
2116 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2117 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2118 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002119 // Disable Hspace compaction to save heap size virtual space.
2120 // Only need disable Hspace for OOM becasue background collector is equal to
2121 // foreground collector by default for dex2oat.
2122 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002123
Andreas Gampeace0dc12016-01-20 13:33:13 -08002124 // If we're asked to be deterministic, ensure non-concurrent GC for determinism. Also
2125 // force the free-list implementation for large objects.
2126 if (compiler_options_->IsForceDeterminism()) {
2127 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
2128 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=freelist", nullptr));
2129
2130 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2131 // compaction (done above) and ensure that neither foreground nor background collectors
2132 // are concurrent.
2133 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2134
2135 // To make identity hashcode deterministic, set a known seed.
2136 mirror::Object::SetHashCodeSeed(987654321U);
2137 }
2138
Vladimir Marko49b0f452015-12-10 13:49:19 +00002139 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2140 LOG(ERROR) << "Failed to parse runtime options";
2141 return false;
2142 }
2143 return true;
2144 }
2145
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002146 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002147 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2148 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002149 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002150 LOG(ERROR) << "Failed to create runtime";
2151 return false;
2152 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002153 runtime_.reset(Runtime::Current());
2154 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002155 for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) {
2156 Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002157 if (!runtime_->HasCalleeSaveMethod(type)) {
2158 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002159 }
2160 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002161 runtime_->GetClassLinker()->FixupDexCaches(runtime_->GetResolutionMethod());
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002162
2163 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2164 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002165 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002166
Vladimir Marko307dac92015-10-20 11:20:09 +01002167 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002168
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002169 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2170 // Runtime::Start, give it away now so that we don't starve GC.
2171 Thread* self = Thread::Current();
2172 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002173
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002174 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002175 }
2176
Jeff Haodcdc85b2015-12-04 14:06:18 -08002177 // 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 -08002178 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002179 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002180 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002181 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002182 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002183 image_filenames_.push_back(app_image_file_name_.c_str());
2184 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002185 if (!image_writer_->Write(app_image_fd_,
2186 image_filenames_,
2187 oat_fd_,
2188 oat_filenames_,
2189 oat_location_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002190 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002191 return false;
2192 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002193
Jeff Haodcdc85b2015-12-04 14:06:18 -08002194 // We need the OatDataBegin entries.
2195 std::map<const char*, uintptr_t> oat_data_begins;
2196 for (const char* oat_filename : oat_filenames_) {
2197 oat_data_begins.emplace(oat_filename, image_writer_->GetOatDataBegin(oat_filename));
2198 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002199 // Destroy ImageWriter before doing FixupElf.
2200 image_writer_.reset();
2201
Jeff Haodcdc85b2015-12-04 14:06:18 -08002202 for (const char* oat_filename : oat_filenames_) {
2203 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2204 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2205 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2206 if (oat_file.get() == nullptr) {
2207 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2208 return false;
2209 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002210
Jeff Haodcdc85b2015-12-04 14:06:18 -08002211 uintptr_t oat_data_begin = oat_data_begins.find(oat_filename)->second;
Andreas Gampe4303ba92014-11-06 01:00:46 -08002212
Jeff Haodcdc85b2015-12-04 14:06:18 -08002213 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begin)) {
2214 oat_file->Erase();
2215 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2216 return false;
2217 }
2218
2219 if (oat_file->FlushCloseOrErase()) {
2220 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2221 return false;
2222 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002223 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002224 }
2225
2226 return true;
2227 }
2228
2229 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002230 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2231 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002232 std::function<std::string(const char*)> process = DotToDescriptor;
2233 return ReadCommentedInputFromFile(image_classes_filename, &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002234 }
2235
2236 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002237 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002238 const char* zip_filename,
2239 const char* image_classes_filename,
2240 std::string* error_msg) {
2241 std::function<std::string(const char*)> process = DotToDescriptor;
2242 return ReadCommentedInputFromZip(zip_filename, image_classes_filename, &process, error_msg);
2243 }
2244
2245 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2246 // the given function.
2247 static std::unordered_set<std::string>* ReadCommentedInputFromFile(
2248 const char* input_filename, std::function<std::string(const char*)>* process) {
2249 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2250 if (input_file.get() == nullptr) {
2251 LOG(ERROR) << "Failed to open input file " << input_filename;
2252 return nullptr;
2253 }
2254 std::unique_ptr<std::unordered_set<std::string>> result(
2255 ReadCommentedInputStream(*input_file, process));
2256 input_file->close();
2257 return result.release();
2258 }
2259
2260 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2261 // Post-process each line with the given function.
2262 static std::unordered_set<std::string>* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002263 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002264 const char* input_filename,
2265 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002266 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002267 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2268 if (zip_archive.get() == nullptr) {
2269 return nullptr;
2270 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002271 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002272 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002273 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002274 zip_filename, error_msg->c_str());
2275 return nullptr;
2276 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002277 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2278 input_filename,
2279 error_msg));
2280 if (input_file.get() == nullptr) {
2281 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002282 zip_filename, error_msg->c_str());
2283 return nullptr;
2284 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002285 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2286 input_file->Size());
2287 std::istringstream input_stream(input_string);
2288 return ReadCommentedInputStream(input_stream, process);
2289 }
2290
2291 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2292 // with the given function.
2293 static std::unordered_set<std::string>* ReadCommentedInputStream(
2294 std::istream& in_stream,
2295 std::function<std::string(const char*)>* process) {
2296 std::unique_ptr<std::unordered_set<std::string>> image_classes(
2297 new std::unordered_set<std::string>);
2298 while (in_stream.good()) {
2299 std::string dot;
2300 std::getline(in_stream, dot);
2301 if (StartsWith(dot, "#") || dot.empty()) {
2302 continue;
2303 }
2304 if (process != nullptr) {
2305 std::string descriptor((*process)(dot.c_str()));
2306 image_classes->insert(descriptor);
2307 } else {
2308 image_classes->insert(dot);
2309 }
2310 }
2311 return image_classes.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002312 }
2313
Mathieu Chartier49285c52014-12-02 15:43:48 -08002314 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002315 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2316 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002317 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002318 LOG(INFO) << "dex2oat took " << PrettyDuration(NanoTime() - start_ns_)
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002319 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002320 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002321 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2322 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002323 }
2324
Jeff Haodcdc85b2015-12-04 14:06:18 -08002325 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2326 std::string res(image_filename);
2327 size_t last_slash = res.rfind('/');
2328 if (last_slash == std::string::npos || last_slash == 0) {
2329 return res;
2330 }
2331 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2332 if (penultimate_slash == std::string::npos) {
2333 return res;
2334 }
2335 // Check that the string in-between is the expected one.
2336 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2337 GetInstructionSetString(isa)) {
2338 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2339 return res;
2340 }
2341 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2342 }
2343
2344 // Update the estimate for the oat file with the given index.
2345 void UpdateImageWriter(size_t index) {
2346 DCHECK(image_writer_ != nullptr);
2347 DCHECK_LT(index, oat_filenames_.size());
2348
2349 image_writer_->UpdateOatFile(oat_filenames_[index]);
2350 }
2351
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002352 std::unique_ptr<CompilerOptions> compiler_options_;
2353 Compiler::Kind compiler_kind_;
2354
2355 InstructionSet instruction_set_;
2356 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2357
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002358 uint32_t image_file_location_oat_checksum_;
2359 uintptr_t image_file_location_oat_data_begin_;
2360 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002361 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2362
Vladimir Marko307dac92015-10-20 11:20:09 +01002363 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002364
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002365 DexFileToMethodInlinerMap method_inliner_map_;
2366 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2367
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002368 std::unique_ptr<Runtime> runtime_;
2369
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002370 // Ownership for the class path files.
2371 std::vector<std::unique_ptr<const DexFile>> class_path_files_;
2372
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002373 size_t thread_count_;
2374 uint64_t start_ns_;
2375 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002376 std::vector<std::unique_ptr<File>> oat_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002377 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002378 std::vector<const char*> oat_filenames_;
2379 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002380 int oat_fd_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002381 std::vector<const char*> dex_filenames_;
2382 std::vector<const char*> dex_locations_;
2383 int zip_fd_;
2384 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002385 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002386 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002387 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002388 uintptr_t image_base_;
2389 const char* image_classes_zip_filename_;
2390 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002391 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002392 const char* compiled_classes_zip_filename_;
2393 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002394 const char* compiled_methods_zip_filename_;
2395 const char* compiled_methods_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002396 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2397 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002398 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002399 bool app_image_;
2400 bool boot_image_;
Jeff Hao436183f2016-01-12 16:36:50 -08002401 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002402 bool is_host_;
2403 std::string android_root_;
2404 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002405 std::string no_inline_from_string_;
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002406 std::vector<jobject> dex_caches_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002407 jobject class_loader_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002408
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002409 std::vector<std::unique_ptr<ElfWriter>> elf_writers_;
2410 std::vector<std::unique_ptr<OatWriter>> oat_writers_;
2411 std::vector<OutputStream*> rodata_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002412 std::unique_ptr<ImageWriter> image_writer_;
2413 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002414
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002415 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
2416 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2417
Vladimir Marko47496c22016-01-27 16:15:08 +00002418 std::vector<const DexFile*> no_inline_from_dex_files_;
2419
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002420 std::vector<std::string> verbose_methods_;
2421 bool dump_stats_;
2422 bool dump_passes_;
2423 bool dump_timing_;
2424 bool dump_slow_timing_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002425 std::string swap_file_name_;
2426 int swap_fd_;
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002427 std::string app_image_file_name_;
2428 int app_image_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002429 std::vector<std::string> profile_files_;
2430 std::vector<std::string> reference_profile_files_;
Calin Juravle877fd962016-01-05 14:29:29 +00002431 std::vector<uint32_t> profile_files_fd_;
2432 std::vector<uint32_t> reference_profile_files_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002433 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002434 TimingLogger* timings_;
2435 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002436 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
2437 std::unordered_map<const DexFile*, const char*> dex_file_oat_filename_map_;
2438
2439 // Backing storage.
2440 std::vector<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002441
Andreas Gampeace0dc12016-01-20 13:33:13 -08002442 // See CompilerOptions.force_determinism_.
2443 bool force_determinism_;
2444
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002445 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2446};
2447
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002448static void b13564922() {
2449#if defined(__linux__) && defined(__arm__)
2450 int major, minor;
2451 struct utsname uts;
2452 if (uname(&uts) != -1 &&
2453 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2454 ((major < 3) || ((major == 3) && (minor < 4)))) {
2455 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2456 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2457 int old_personality = personality(0xffffffff);
2458 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2459 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2460 if (new_personality == -1) {
2461 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2462 }
2463 }
2464 }
2465#endif
2466}
2467
Andreas Gampe10e477d2014-11-19 12:57:42 -08002468static int CompileImage(Dex2Oat& dex2oat) {
2469 dex2oat.Compile();
2470
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002471 if (!dex2oat.WriteOatFiles()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002472 dex2oat.EraseOatFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002473 return EXIT_FAILURE;
2474 }
2475
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002476 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2477 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2478 // image writer will require this fd to generate the image.
2479 if (dex2oat.ShouldKeepOatFileOpen()) {
2480 if (!dex2oat.FlushOatFiles()) {
2481 return EXIT_FAILURE;
2482 }
2483 } else if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002484 return EXIT_FAILURE;
2485 }
2486
Jeff Haodcdc85b2015-12-04 14:06:18 -08002487 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002488 if (!dex2oat.HandleImage()) {
2489 return EXIT_FAILURE;
2490 }
2491
2492 // When given --host, finish early without stripping.
2493 if (dex2oat.IsHost()) {
2494 dex2oat.DumpTiming();
2495 return EXIT_SUCCESS;
2496 }
2497
Jeff Haodcdc85b2015-12-04 14:06:18 -08002498 // Copy stripped to unstripped location, if necessary.
2499 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002500 return EXIT_FAILURE;
2501 }
2502
Jeff Haodcdc85b2015-12-04 14:06:18 -08002503 // FlushClose again, as stripping might have re-opened the oat files.
2504 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002505 return EXIT_FAILURE;
2506 }
2507
2508 dex2oat.DumpTiming();
2509 return EXIT_SUCCESS;
2510}
2511
2512static int CompileApp(Dex2Oat& dex2oat) {
2513 dex2oat.Compile();
2514
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002515 if (!dex2oat.WriteOatFiles()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002516 dex2oat.EraseOatFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002517 return EXIT_FAILURE;
2518 }
2519
Jeff Haodcdc85b2015-12-04 14:06:18 -08002520 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002521 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002522
2523 // When given --host, finish early without stripping.
2524 if (dex2oat.IsHost()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002525 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002526 return EXIT_FAILURE;
2527 }
2528
2529 dex2oat.DumpTiming();
2530 return EXIT_SUCCESS;
2531 }
2532
Jeff Haodcdc85b2015-12-04 14:06:18 -08002533 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2534 // stripped versions. If this is given, we expect to be able to open writable files by name.
2535 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002536 return EXIT_FAILURE;
2537 }
2538
Jeff Haodcdc85b2015-12-04 14:06:18 -08002539 // Flush and close the files.
2540 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002541 return EXIT_FAILURE;
2542 }
2543
2544 dex2oat.DumpTiming();
2545 return EXIT_SUCCESS;
2546}
2547
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002548static int dex2oat(int argc, char** argv) {
2549 b13564922();
2550
2551 TimingLogger timings("compiler", false, false);
2552
2553 Dex2Oat dex2oat(&timings);
2554
2555 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
2556 dex2oat.ParseArgs(argc, argv);
2557
Calin Juravle998c2162015-12-21 15:39:33 +02002558 // Process profile information and assess if we need to do a profile guided compilation.
2559 // This operation involves I/O.
2560 if (dex2oat.UseProfileGuidedCompilation()) {
2561 if (dex2oat.ProcessProfiles()) {
2562 if (!dex2oat.ShouldCompileBasedOnProfiles()) {
2563 LOG(INFO) << "Skipped compilation because of insignificant profile delta";
2564 return EXIT_SUCCESS;
2565 }
2566 } else {
2567 LOG(WARNING) << "Failed to process profile files";
2568 return EXIT_FAILURE;
2569 }
2570 }
2571
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002572 // Check early that the result of compilation can be written
2573 if (!dex2oat.OpenFile()) {
2574 return EXIT_FAILURE;
2575 }
2576
Andreas Gampe046c7062015-05-18 23:22:54 -07002577 // Print the complete line when any of the following is true:
2578 // 1) Debug build
2579 // 2) Compiling an image
2580 // 3) Compiling with --host
2581 // 4) Compiling on the host (not a target build)
2582 // Otherwise, print a stripped command line.
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002583 if (kIsDebugBuild || dex2oat.IsBootImage() || dex2oat.IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07002584 LOG(INFO) << CommandLine();
2585 } else {
2586 LOG(INFO) << StrippedCommandLine();
2587 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002588
2589 if (!dex2oat.Setup()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002590 dex2oat.EraseOatFiles();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002591 return EXIT_FAILURE;
2592 }
2593
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002594 bool result;
Andreas Gampe10e477d2014-11-19 12:57:42 -08002595 if (dex2oat.IsImage()) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002596 result = CompileImage(dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002597 } else {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002598 result = CompileApp(dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002599 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002600
2601 dex2oat.Shutdown();
2602 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002603}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002604} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07002605
2606int main(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002607 int result = art::dex2oat(argc, argv);
2608 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
2609 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
2610 // should not destruct the runtime in this case.
Evgenii Stepanov1e133742015-05-20 12:30:59 -07002611 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002612 exit(result);
2613 }
2614 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002615}