blob: 298101115dbf6f9d71c6462eeeae21ead4fdef1c [file] [log] [blame]
Brian Carlstrom7940e442013-07-12 13:46:57 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Andreas Gamped687e372015-04-28 23:16:03 -070017#include <inttypes.h>
Brian Carlstrom7940e442013-07-12 13:46:57 -070018#include <stdio.h>
19#include <stdlib.h>
20#include <sys/stat.h>
Evgenii Stepanov1e133742015-05-20 12:30:59 -070021#include "base/memory_tool.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070022
23#include <fstream>
24#include <iostream>
25#include <sstream>
26#include <string>
Andreas Gampeb1fcead2015-04-20 18:53:51 -070027#include <unordered_set>
Brian Carlstrom7940e442013-07-12 13:46:57 -070028#include <vector>
29
Vladimir Markof94b7812014-06-05 15:48:04 +010030#if defined(__linux__) && defined(__arm__)
31#include <sys/personality.h>
32#include <sys/utsname.h>
33#endif
34
Ian Rogersd582fa42014-11-05 23:46:43 -080035#include "arch/instruction_set_features.h"
Andreas Gampec5a3ea72015-01-13 16:41:53 -080036#include "arch/mips/instruction_set_features_mips.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000037#include "art_method-inl.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070038#include "base/dumpable.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080039#include "base/macros.h"
Calin Juravle2e2db782016-02-23 12:00:03 +000040#include "base/scoped_flock.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070041#include "base/stl_util.h"
42#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010043#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070044#include "base/timing_logger.h"
45#include "base/unix_file/fd_file.h"
46#include "class_linker.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000047#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000048#include "compiler_callbacks.h"
David Srbecky09c2a6b2016-03-11 17:11:44 +000049#include "debug/elf_debug_writer.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000050#include "debug/method_debug_info.h"
Mathieu Chartier5bdab122015-01-26 18:30:19 -080051#include "dex/pass_manager.h"
Ian Rogerse63db272014-07-15 15:36:11 -070052#include "dex/quick/dex_file_to_method_inliner_map.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000053#include "dex/quick_compiler_callbacks.h"
54#include "dex/verification_results.h"
55#include "dex_file-inl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070056#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080057#include "driver/compiler_options.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080058#include "elf_file.h"
Tong Shen62d1ca32014-09-03 17:24:56 -070059#include "elf_writer.h"
Vladimir Marko10c13562015-11-25 14:33:36 +000060#include "elf_writer_quick.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070061#include "gc/space/image_space.h"
62#include "gc/space/space-inl.h"
63#include "image_writer.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070064#include "interpreter/unstarted_runtime.h"
Calin Juravle998c2162015-12-21 15:39:33 +020065#include "jit/offline_profiling_info.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070066#include "leb128.h"
Vladimir Marko944da602016-02-19 12:27:55 +000067#include "linker/multi_oat_relative_patcher.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070068#include "mirror/class-inl.h"
69#include "mirror/class_loader.h"
70#include "mirror/object-inl.h"
71#include "mirror/object_array-inl.h"
72#include "oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070073#include "os.h"
74#include "runtime.h"
Vladimir Marko49b0f452015-12-10 13:49:19 +000075#include "runtime_options.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070076#include "ScopedLocalRef.h"
77#include "scoped_thread_state_change.h"
Alex Light53cb16b2014-06-12 11:26:29 -070078#include "utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070079#include "well_known_classes.h"
80#include "zip_archive.h"
81
82namespace art {
83
Brian Carlstrom6449c622014-02-10 23:48:36 -080084static int original_argc;
85static char** original_argv;
86
87static std::string CommandLine() {
88 std::vector<std::string> command;
89 for (int i = 0; i < original_argc; ++i) {
90 command.push_back(original_argv[i]);
91 }
92 return Join(command, ' ');
93}
94
Andreas Gampe046c7062015-05-18 23:22:54 -070095// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
96// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
97// locations are all staged).
98static std::string StrippedCommandLine() {
99 std::vector<std::string> command;
100
101 // Do a pre-pass to look for zip-fd.
102 bool saw_zip_fd = false;
103 for (int i = 0; i < original_argc; ++i) {
104 if (StartsWith(original_argv[i], "--zip-fd=")) {
105 saw_zip_fd = true;
106 break;
107 }
108 }
109
110 // Now filter out things.
111 for (int i = 0; i < original_argc; ++i) {
112 // All runtime-arg parameters are dropped.
113 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
114 i++; // Drop the next part, too.
115 continue;
116 }
117
118 // Any instruction-setXXX is dropped.
119 if (StartsWith(original_argv[i], "--instruction-set")) {
120 continue;
121 }
122
123 // The boot image is dropped.
124 if (StartsWith(original_argv[i], "--boot-image=")) {
125 continue;
126 }
127
Mathieu Chartier97590cc2016-02-03 15:50:29 -0800128 // The image format is dropped.
129 if (StartsWith(original_argv[i], "--image-format=")) {
130 continue;
131 }
132
Andreas Gampe046c7062015-05-18 23:22:54 -0700133 // This should leave any dex-file and oat-file options, describing what we compiled.
134
135 // However, we prefer to drop this when we saw --zip-fd.
136 if (saw_zip_fd) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700137 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X, or --app-image-X
Andreas Gampe046c7062015-05-18 23:22:54 -0700138 if (StartsWith(original_argv[i], "--zip-") ||
139 StartsWith(original_argv[i], "--dex-") ||
140 StartsWith(original_argv[i], "--oat-") ||
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700141 StartsWith(original_argv[i], "--swap-") ||
142 StartsWith(original_argv[i], "--app-image-")) {
Andreas Gampe046c7062015-05-18 23:22:54 -0700143 continue;
144 }
145 }
146
147 command.push_back(original_argv[i]);
148 }
149
150 // Construct the final output.
151 if (command.size() <= 1U) {
152 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
153 return "Starting dex2oat.";
154 }
155 return Join(command, ' ');
156}
157
Brian Carlstrom7940e442013-07-12 13:46:57 -0700158static void UsageErrorV(const char* fmt, va_list ap) {
159 std::string error;
160 StringAppendV(&error, fmt, ap);
161 LOG(ERROR) << error;
162}
163
164static void UsageError(const char* fmt, ...) {
165 va_list ap;
166 va_start(ap, fmt);
167 UsageErrorV(fmt, ap);
168 va_end(ap);
169}
170
Andreas Gampe794ad762015-02-23 08:12:24 -0800171NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700172 va_list ap;
173 va_start(ap, fmt);
174 UsageErrorV(fmt, ap);
175 va_end(ap);
176
Brian Carlstrom6449c622014-02-10 23:48:36 -0800177 UsageError("Command: %s", CommandLine().c_str());
178
Brian Carlstrom7940e442013-07-12 13:46:57 -0700179 UsageError("Usage: dex2oat [options]...");
180 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100181 UsageError(" -j<number>: specifies the number of threads used for compilation.");
182 UsageError(" Default is the number of detected hardware threads available on the");
183 UsageError(" host system.");
184 UsageError(" Example: -j12");
185 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700186 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700187 UsageError(" Example: --dex-file=/system/framework/core.jar");
188 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700189 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
190 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
191 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
192 UsageError(" --dex-location=/system/framework/core.jar");
193 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700194 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
195 UsageError(" containing a classes.dex file to compile.");
196 UsageError(" Example: --zip-fd=5");
197 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700198 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
199 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700200 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
201 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800202 UsageError(" --oat-file=<file.oat>: specifies an oat output destination via a filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700203 UsageError(" Example: --oat-file=/system/framework/boot.oat");
204 UsageError("");
205 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900206 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700207 UsageError("");
208 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
209 UsageError(" to the file descriptor specified by --oat-fd.");
210 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
211 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800212 UsageError(" --oat-symbols=<file.oat>: specifies an oat output destination with full symbols.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700213 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
214 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800215 UsageError(" --image=<file.art>: specifies an output image filename.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700216 UsageError(" Example: --image=/system/framework/boot.art");
217 UsageError("");
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800218 UsageError(" --image-format=(uncompressed|lz4|lz4hc):");
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800219 UsageError(" Which format to store the image.");
220 UsageError(" Example: --image-format=lz4");
221 UsageError(" Default: uncompressed");
222 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700223 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
224 UsageError(" Example: --image=frameworks/base/preloaded-classes");
225 UsageError("");
226 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
227 UsageError(" Example: --base=0x50000000");
228 UsageError("");
229 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000230 UsageError(" Do not include the arch as part of the name, it is added automatically.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700231 UsageError(" Example: --boot-image=/system/framework/boot.art");
Kevin Brodsky64fff412015-11-24 14:24:34 +0000232 UsageError(" (specifies /system/framework/<arch>/boot.art as the image file)");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000233 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700234 UsageError("");
235 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
236 UsageError(" Example: --android-root=out/host/linux-x86");
237 UsageError(" Default: $ANDROID_ROOT");
238 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800239 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700240 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700241 UsageError(" Example: --instruction-set=x86");
242 UsageError(" Default: arm");
243 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700244 UsageError(" --instruction-set-features=...,: Specify instruction set features");
245 UsageError(" Example: --instruction-set-features=div");
246 UsageError(" Default: default");
247 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700248 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
249 UsageError(" Default: disabled");
250 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800251 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700252 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800253 UsageError(" Example: --compiler-backend=Optimizing");
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100254 UsageError(" Default: Optimizing");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700255 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100256 UsageError(" --compiler-filter="
257 "(verify-none"
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700258 "|verify-at-runtime"
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100259 "|interpret-only"
260 "|space"
261 "|balanced"
262 "|speed"
263 "|everything"
264 "|time):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700265 UsageError(" select compiler filter.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800266 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800267 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800268 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800269 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
270 UsageError(" method for compiler filter tuning.");
271 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
272 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
273 UsageError("");
274 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
275 UsageError(" method for compiler filter tuning.");
276 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
277 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
278 UsageError("");
279 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
280 UsageError(" method for compiler filter tuning.");
281 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
282 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
283 UsageError("");
284 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
285 UsageError(" method for compiler filter tuning.");
286 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
287 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
288 UsageError("");
289 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
290 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -0700291 UsageError(" and the filter is not interpret-only or verify-none or verify-at-runtime, ");
292 UsageError(" overrides the filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800293 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
294 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
295 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100296 UsageError(" --inline-depth-limit=<depth-limit>: the depth limit of inlining for fine tuning");
297 UsageError(" the compiler. A zero value will disable inlining. Honored only by Optimizing.");
Roland Levillaina215b952015-08-07 11:38:32 +0100298 UsageError(" Has priority over the --compiler-filter option. Intended for ");
299 UsageError(" development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100300 UsageError(" Example: --inline-depth-limit=%d", CompilerOptions::kDefaultInlineDepthLimit);
301 UsageError(" Default: %d", CompilerOptions::kDefaultInlineDepthLimit);
302 UsageError("");
303 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
304 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100305 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
306 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100307 UsageError(" Example: --inline-max-code-units=%d",
308 CompilerOptions::kDefaultInlineMaxCodeUnits);
309 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
310 UsageError("");
Ian Rogers46398602013-08-20 07:50:36 -0700311 UsageError(" --dump-timing: display a breakdown of where time was spent");
312 UsageError("");
Alex Light53cb16b2014-06-12 11:26:29 -0700313 UsageError(" --include-patch-information: Include patching information so the generated code");
314 UsageError(" can have its base address moved without full recompilation.");
315 UsageError("");
316 UsageError(" --no-include-patch-information: Do not include patching information.");
317 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100318 UsageError(" -g");
319 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
320 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
David Srbecky346dc992016-03-13 22:00:07 +0000321 UsageError(" If used without --debuggable, it will be best-effort only.");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000322 UsageError(" This option does not affect the generated code. (disabled by default)");
Alex Light78382fa2014-06-06 15:45:32 -0700323 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100324 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100325 UsageError("");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000326 UsageError(" --generate-mini-debug-info: Generate minimal amount of LZMA-compressed");
327 UsageError(" debug information necessary to print backtraces. (disabled by default)");
328 UsageError("");
David Srbecky346dc992016-03-13 22:00:07 +0000329 UsageError(" --no-generate-mini-debug-info: Do not generate backtrace info.");
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000330 UsageError("");
David Srbecky3e09eeb2016-01-12 14:54:03 +0000331 UsageError(" --debuggable: Produce code debuggable with Java debugger.");
David Srbecky0cf44932015-12-09 14:09:59 +0000332 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700333 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
334 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
335 UsageError(" Use a separate --runtime-arg switch for each argument.");
336 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700337 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000338 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700339 UsageError("");
Calin Juravle877fd962016-01-05 14:29:29 +0000340 UsageError(" --profile-file-fd=<number>: same as --profile-file but accepts a file descriptor.");
341 UsageError(" Cannot be used together with --profile-file.");
342 UsageError("");
Chao-ying Fucd8ce662014-03-11 14:57:19 -0700343 UsageError(" --print-pass-names: print a list of pass names");
344 UsageError("");
345 UsageError(" --disable-passes=<pass-names>: disable one or more passes separated by comma.");
346 UsageError(" Example: --disable-passes=UseCount,BBOptimizations");
347 UsageError("");
Razvan A Lupusorubd25d4b2014-07-02 18:16:51 -0700348 UsageError(" --print-pass-options: print a list of passes that have configurable options along "
349 "with the setting.");
350 UsageError(" Will print default if no overridden setting exists.");
351 UsageError("");
352 UsageError(" --pass-options=Pass1Name:Pass1OptionName:Pass1Option#,"
353 "Pass2Name:Pass2OptionName:Pass2Option#");
354 UsageError(" Used to specify a pass specific option. The setting itself must be integer.");
355 UsageError(" Separator used between options is a comma.");
356 UsageError("");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800357 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
358 UsageError(" Example: --swap-file=/data/tmp/swap.001");
359 UsageError("");
360 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
361 UsageError(" Example: --swap-fd=10");
362 UsageError("");
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700363 UsageError(" --app-image-fd=<file-descriptor>: specify output file descriptor for app image.");
364 UsageError(" Example: --app-image-fd=10");
365 UsageError("");
366 UsageError(" --app-image-file=<file-name>: specify a file name for app image.");
367 UsageError(" Example: --app-image-file=/data/dalvik-cache/system@app@Calculator.apk.art");
368 UsageError("");
Jeff Haodcdc85b2015-12-04 14:06:18 -0800369 UsageError(" --multi-image: specify that separate oat and image files be generated for each "
370 "input dex file.");
371 UsageError("");
Roland Levillaineb2c7412016-01-28 14:37:01 +0000372 UsageError(" --force-determinism: force the compiler to emit a deterministic output.");
373 UsageError(" This option is incompatible with read barriers (e.g., if dex2oat has been");
374 UsageError(" built with the environment variable `ART_USE_READ_BARRIER` set to `true`).");
375 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700376 std::cerr << "See log for usage error information\n";
377 exit(EXIT_FAILURE);
378}
379
Brian Carlstrom7940e442013-07-12 13:46:57 -0700380// The primary goal of the watchdog is to prevent stuck build servers
381// during development when fatal aborts lead to a cascade of failures
382// that result in a deadlock.
383class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800384// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700385#undef CHECK_PTHREAD_CALL
386#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
387 do { \
388 int rc = call args; \
389 if (rc != 0) { \
390 errno = rc; \
391 std::string message(# call); \
392 message += " failed for "; \
393 message += reason; \
394 Fatal(message); \
395 } \
396 } while (false)
397
398 public:
Brian Carlstrom93ba8932013-07-17 21:31:49 -0700399 explicit WatchDog(bool is_watch_dog_enabled) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700400 is_watch_dog_enabled_ = is_watch_dog_enabled;
401 if (!is_watch_dog_enabled_) {
402 return;
403 }
404 shutting_down_ = false;
405 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700406 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
407 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700408 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
409 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
410 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
411 }
412 ~WatchDog() {
413 if (!is_watch_dog_enabled_) {
414 return;
415 }
416 const char* reason = "dex2oat watch dog thread shutdown";
417 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
418 shutting_down_ = true;
419 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
420 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
421
Kenny Root51316382014-05-13 14:59:37 -0700422 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700423
424 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
425 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
426 }
427
428 private:
429 static void* CallBack(void* arg) {
430 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
431 ::art::SetThreadName("dex2oat watch dog");
432 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700433 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700434 }
435
Andreas Gampe794ad762015-02-23 08:12:24 -0800436 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700437 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
438 // it's rather easy to hang in unwinding.
439 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
440 // logcat logging or stderr output.
441 LogMessage::LogLine(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700442 exit(1);
443 }
444
445 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700446 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
447 // large.
Andreas Gamped687e372015-04-28 23:16:03 -0700448 constexpr int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700449 timespec timeout_ts;
450 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts);
451 const char* reason = "dex2oat watch dog thread waiting";
452 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
453 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800454 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700455 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700456 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
457 kWatchDogTimeoutSeconds));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700458 } else if (rc != 0) {
459 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
460 strerror(errno)));
461 Fatal(message.c_str());
462 }
463 }
464 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
465 }
466
467 // 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 -0700468 // Debug builds are slower so they have larger timeouts.
Andreas Gamped687e372015-04-28 23:16:03 -0700469 static constexpr int64_t kSlowdownFactor = kIsDebugBuild ? 5U : 1U;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800470
Andreas Gampe540138a2015-09-14 15:34:38 -0700471 // 9.5 minutes scaled by kSlowdownFactor. This is slightly smaller than the Package Manager
472 // watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that dex2oat will abort
473 // itself before that watchdog would take down the system server.
474 static constexpr int64_t kWatchDogTimeoutSeconds = kSlowdownFactor * (9 * 60 + 30);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700475
476 bool is_watch_dog_enabled_;
477 bool shutting_down_;
478 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
479 pthread_mutex_t mutex_;
480 pthread_cond_t cond_;
481 pthread_attr_t attr_;
482 pthread_t pthread_;
483};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700484
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800485static constexpr size_t kMinDexFilesForSwap = 2;
486static constexpr size_t kMinDexFileCumulativeSizeForSwap = 20 * MB;
487
488static bool UseSwap(bool is_image, std::vector<const DexFile*>& dex_files) {
489 if (is_image) {
490 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
491 return false;
492 }
493 if (dex_files.size() < kMinDexFilesForSwap) {
494 // If there are less dex files than the threshold, assume it's gonna be fine.
495 return false;
496 }
497 size_t dex_files_size = 0;
498 for (const auto* dex_file : dex_files) {
499 dex_files_size += dex_file->GetHeader().file_size_;
500 }
501 return dex_files_size >= kMinDexFileCumulativeSizeForSwap;
502}
503
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800504class Dex2Oat FINAL {
505 public:
506 explicit Dex2Oat(TimingLogger* timings) :
Nicolas Geoffray409e8092015-10-01 10:32:19 +0100507 compiler_kind_(Compiler::kOptimizing),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800508 instruction_set_(kRuntimeISA),
509 // Take the default set of instruction features from the build.
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000510 image_file_location_oat_checksum_(0),
511 image_file_location_oat_data_begin_(0),
512 image_patch_delta_(0),
513 key_value_store_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700514 verification_results_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800515 method_inliner_map_(),
516 runtime_(nullptr),
517 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
518 start_ns_(NanoTime()),
519 oat_fd_(-1),
520 zip_fd_(-1),
521 image_base_(0U),
522 image_classes_zip_filename_(nullptr),
523 image_classes_filename_(nullptr),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800524 image_storage_mode_(ImageHeader::kStorageModeUncompressed),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800525 compiled_classes_zip_filename_(nullptr),
526 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700527 compiled_methods_zip_filename_(nullptr),
528 compiled_methods_filename_(nullptr),
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700529 app_image_(false),
530 boot_image_(false),
Jeff Hao436183f2016-01-12 16:36:50 -0800531 multi_image_(false),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800532 is_host_(false),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000533 class_loader_(nullptr),
534 elf_writers_(),
535 oat_writers_(),
536 rodata_(),
Vladimir Marko10c13562015-11-25 14:33:36 +0000537 image_writer_(nullptr),
Andreas Gampe3f30e122015-09-17 14:03:21 -0700538 driver_(nullptr),
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000539 opened_dex_files_maps_(),
540 opened_dex_files_(),
Vladimir Marko47496c22016-01-27 16:15:08 +0000541 no_inline_from_dex_files_(),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800542 dump_stats_(false),
543 dump_passes_(false),
544 dump_timing_(false),
545 dump_slow_timing_(kIsDebugBuild),
Calin Juravle2e2db782016-02-23 12:00:03 +0000546 swap_fd_(kInvalidFd),
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800547 app_image_fd_(kInvalidFd),
Calin Juravle2e2db782016-02-23 12:00:03 +0000548 profile_file_fd_(kInvalidFd),
Andreas Gampeace0dc12016-01-20 13:33:13 -0800549 timings_(timings),
Calin Juravle2e2db782016-02-23 12:00:03 +0000550 force_determinism_(false)
551 {}
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800552
553 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800554 // Log completion time before deleting the runtime_, because this accesses
555 // the runtime.
556 LogCompletionTime();
557
Vladimir Marko307dac92015-10-20 11:20:09 +0100558 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
559 // We want to just exit on non-debug builds, not bringing the runtime down
560 // in an orderly fashion. So release the following fields.
561 driver_.release();
562 image_writer_.release();
563 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files_) {
564 dex_file.release();
565 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000566 for (std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
567 map.release();
568 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800569 for (std::unique_ptr<File>& oat_file : oat_files_) {
570 oat_file.release();
571 }
Vladimir Marko307dac92015-10-20 11:20:09 +0100572 runtime_.release();
573 verification_results_.release();
574 key_value_store_.release();
Vladimir Markof94b7812014-06-05 15:48:04 +0100575 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700576 }
577
Roland Levillain9ec5e222015-08-17 20:18:41 +0100578 struct ParserOptions {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800579 std::vector<const char*> oat_symbols;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800580 std::string boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800581 bool watch_dog_enabled = true;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000582 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800583 std::string error_msg;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100584 };
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800585
Roland Levillain9ec5e222015-08-17 20:18:41 +0100586 void ParseZipFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000587 ParseUintOption(option, "--zip-fd", &zip_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100588 }
589
590 void ParseOatFd(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000591 ParseUintOption(option, "--oat-fd", &oat_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100592 }
593
Calin Juravle877fd962016-01-05 14:29:29 +0000594 void ParseFdForCollection(const StringPiece& option,
595 const char* arg_name,
596 std::vector<uint32_t>* fds) {
597 uint32_t fd;
598 ParseUintOption(option, arg_name, &fd, Usage);
599 fds->push_back(fd);
600 }
601
Roland Levillain9ec5e222015-08-17 20:18:41 +0100602 void ParseJ(const StringPiece& option) {
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000603 ParseUintOption(option, "-j", &thread_count_, Usage, /* is_long_option */ false);
Roland Levillain9ec5e222015-08-17 20:18:41 +0100604 }
605
606 void ParseBase(const StringPiece& option) {
607 DCHECK(option.starts_with("--base="));
608 const char* image_base_str = option.substr(strlen("--base=")).data();
609 char* end;
610 image_base_ = strtoul(image_base_str, &end, 16);
611 if (end == image_base_str || *end != '\0') {
612 Usage("Failed to parse hexadecimal value for option %s", option.data());
613 }
614 }
615
616 void ParseInstructionSet(const StringPiece& option) {
617 DCHECK(option.starts_with("--instruction-set="));
618 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
619 // StringPiece is not necessarily zero-terminated, so need to make a copy and ensure it.
620 std::unique_ptr<char[]> buf(new char[instruction_set_str.length() + 1]);
621 strncpy(buf.get(), instruction_set_str.data(), instruction_set_str.length());
622 buf.get()[instruction_set_str.length()] = 0;
623 instruction_set_ = GetInstructionSetFromString(buf.get());
624 // arm actually means thumb2.
625 if (instruction_set_ == InstructionSet::kArm) {
626 instruction_set_ = InstructionSet::kThumb2;
627 }
628 }
629
630 void ParseInstructionSetVariant(const StringPiece& option, ParserOptions* parser_options) {
631 DCHECK(option.starts_with("--instruction-set-variant="));
632 StringPiece str = option.substr(strlen("--instruction-set-variant=")).data();
633 instruction_set_features_.reset(
634 InstructionSetFeatures::FromVariant(
635 instruction_set_, str.as_string(), &parser_options->error_msg));
636 if (instruction_set_features_.get() == nullptr) {
637 Usage("%s", parser_options->error_msg.c_str());
638 }
639 }
640
641 void ParseInstructionSetFeatures(const StringPiece& option, ParserOptions* parser_options) {
642 DCHECK(option.starts_with("--instruction-set-features="));
643 StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
644 if (instruction_set_features_.get() == nullptr) {
645 instruction_set_features_.reset(
646 InstructionSetFeatures::FromVariant(
647 instruction_set_, "default", &parser_options->error_msg));
648 if (instruction_set_features_.get() == nullptr) {
649 Usage("Problem initializing default instruction set features variant: %s",
650 parser_options->error_msg.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700651 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800652 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100653 instruction_set_features_.reset(
654 instruction_set_features_->AddFeaturesFromString(str.as_string(),
655 &parser_options->error_msg));
656 if (instruction_set_features_.get() == nullptr) {
657 Usage("Error parsing '%s': %s", option.data(), parser_options->error_msg.c_str());
658 }
659 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800660
Roland Levillain9ec5e222015-08-17 20:18:41 +0100661 void ParseCompilerBackend(const StringPiece& option, ParserOptions* parser_options) {
662 DCHECK(option.starts_with("--compiler-backend="));
663 parser_options->requested_specific_compiler = true;
664 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
665 if (backend_str == "Quick") {
666 compiler_kind_ = Compiler::kQuick;
667 } else if (backend_str == "Optimizing") {
668 compiler_kind_ = Compiler::kOptimizing;
669 } else {
670 Usage("Unknown compiler backend: %s", backend_str.data());
671 }
672 }
673
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800674 void ParseImageFormat(const StringPiece& option) {
675 const StringPiece substr("--image-format=");
676 DCHECK(option.starts_with(substr));
677 const StringPiece format_str = option.substr(substr.length());
678 if (format_str == "lz4") {
679 image_storage_mode_ = ImageHeader::kStorageModeLZ4;
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800680 } else if (format_str == "lz4hc") {
681 image_storage_mode_ = ImageHeader::kStorageModeLZ4HC;
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800682 } else if (format_str == "uncompressed") {
683 image_storage_mode_ = ImageHeader::kStorageModeUncompressed;
684 } else {
685 Usage("Unknown image format: %s", format_str.data());
686 }
687 }
688
Jeff Hao436183f2016-01-12 16:36:50 -0800689 void ProcessOptions(ParserOptions* parser_options) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800690 boot_image_ = !image_filenames_.empty();
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700691 app_image_ = app_image_fd_ != -1 || !app_image_file_name_.empty();
692
693 if (IsAppImage() && IsBootImage()) {
694 Usage("Can't have both --image and (--app-image-fd or --app-image-file)");
695 }
696
Nicolas Geoffray0c6e3342016-03-04 11:38:14 +0000697 if (IsBootImage()) {
698 // We need the boot image to always be debuggable.
699 // TODO: Remove this once we better deal with full frame deoptimization.
700 compiler_options_->debuggable_ = true;
701 }
702
Jeff Haodcdc85b2015-12-04 14:06:18 -0800703 if (oat_filenames_.empty() && oat_fd_ == -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800704 Usage("Output must be supplied with either --oat-file or --oat-fd");
705 }
706
Jeff Haodcdc85b2015-12-04 14:06:18 -0800707 if (!oat_filenames_.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800708 Usage("--oat-file should not be used with --oat-fd");
709 }
710
Roland Levillain9ec5e222015-08-17 20:18:41 +0100711 if (!parser_options->oat_symbols.empty() && oat_fd_ != -1) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800712 Usage("--oat-symbols should not be used with --oat-fd");
713 }
714
Roland Levillain9ec5e222015-08-17 20:18:41 +0100715 if (!parser_options->oat_symbols.empty() && is_host_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800716 Usage("--oat-symbols should not be used with --host");
717 }
718
Jeff Haodcdc85b2015-12-04 14:06:18 -0800719 if (oat_fd_ != -1 && !image_filenames_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800720 Usage("--oat-fd should not be used with --image");
721 }
722
Jeff Haodcdc85b2015-12-04 14:06:18 -0800723 if (!parser_options->oat_symbols.empty() &&
724 parser_options->oat_symbols.size() != oat_filenames_.size()) {
725 Usage("--oat-file arguments do not match --oat-symbols arguments");
726 }
727
728 if (!image_filenames_.empty() && image_filenames_.size() != oat_filenames_.size()) {
729 Usage("--oat-file arguments do not match --image arguments");
730 }
731
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800732 if (android_root_.empty()) {
733 const char* android_root_env_var = getenv("ANDROID_ROOT");
734 if (android_root_env_var == nullptr) {
735 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700736 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800737 android_root_ += android_root_env_var;
738 }
739
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700740 if (!boot_image_ && parser_options->boot_image_filename.empty()) {
Roland Levillain9ec5e222015-08-17 20:18:41 +0100741 parser_options->boot_image_filename += android_root_;
742 parser_options->boot_image_filename += "/framework/boot.art";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800743 }
Roland Levillain9ec5e222015-08-17 20:18:41 +0100744 if (!parser_options->boot_image_filename.empty()) {
Vladimir Marko49b0f452015-12-10 13:49:19 +0000745 boot_image_filename_ = parser_options->boot_image_filename;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800746 }
747
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700748 if (image_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800749 Usage("--image-classes should only be used with --image");
750 }
751
Vladimir Marko49b0f452015-12-10 13:49:19 +0000752 if (image_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800753 Usage("--image-classes should not be used with --boot-image");
754 }
755
756 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
757 Usage("--image-classes-zip should be used with --image-classes");
758 }
759
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700760 if (compiled_classes_filename_ != nullptr && !IsBootImage()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800761 Usage("--compiled-classes should only be used with --image");
762 }
763
Vladimir Marko49b0f452015-12-10 13:49:19 +0000764 if (compiled_classes_filename_ != nullptr && !boot_image_filename_.empty()) {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800765 Usage("--compiled-classes should not be used with --boot-image");
766 }
767
768 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
769 Usage("--compiled-classes-zip should be used with --compiled-classes");
770 }
771
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800772 if (dex_filenames_.empty() && zip_fd_ == -1) {
773 Usage("Input must be supplied with either --dex-file or --zip-fd");
774 }
775
776 if (!dex_filenames_.empty() && zip_fd_ != -1) {
777 Usage("--dex-file should not be used with --zip-fd");
778 }
779
780 if (!dex_filenames_.empty() && !zip_location_.empty()) {
781 Usage("--dex-file should not be used with --zip-location");
782 }
783
784 if (dex_locations_.empty()) {
785 for (const char* dex_file_name : dex_filenames_) {
786 dex_locations_.push_back(dex_file_name);
787 }
788 } else if (dex_locations_.size() != dex_filenames_.size()) {
789 Usage("--dex-location arguments do not match --dex-file arguments");
790 }
791
Jeff Haodcdc85b2015-12-04 14:06:18 -0800792 if (!dex_filenames_.empty() && !oat_filenames_.empty()) {
793 if (oat_filenames_.size() != 1 && oat_filenames_.size() != dex_filenames_.size()) {
794 Usage("--oat-file arguments must be singular or match --dex-file arguments");
795 }
796 }
797
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800798 if (zip_fd_ != -1 && zip_location_.empty()) {
799 Usage("--zip-location should be supplied with --zip-fd");
800 }
801
Vladimir Marko49b0f452015-12-10 13:49:19 +0000802 if (boot_image_filename_.empty()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800803 if (image_base_ == 0) {
804 Usage("Non-zero --base not specified");
805 }
806 }
807
Calin Juravle2e2db782016-02-23 12:00:03 +0000808 if (!profile_file_.empty() && (profile_file_fd_ != kInvalidFd)) {
809 Usage("Profile file should not be specified with both --profile-file-fd and --profile-file");
Calin Juravle998c2162015-12-21 15:39:33 +0200810 }
811
Roland Levillain9ec5e222015-08-17 20:18:41 +0100812 if (!parser_options->oat_symbols.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800813 oat_unstripped_ = std::move(parser_options->oat_symbols);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800814 }
815
816 // If no instruction set feature was given, use the default one for the target
817 // instruction set.
818 if (instruction_set_features_.get() == nullptr) {
819 instruction_set_features_.reset(
Roland Levillain9ec5e222015-08-17 20:18:41 +0100820 InstructionSetFeatures::FromVariant(
821 instruction_set_, "default", &parser_options->error_msg));
Ian Rogersd582fa42014-11-05 23:46:43 -0800822 if (instruction_set_features_.get() == nullptr) {
823 Usage("Problem initializing default instruction set features variant: %s",
Roland Levillain9ec5e222015-08-17 20:18:41 +0100824 parser_options->error_msg.c_str());
Ian Rogersd582fa42014-11-05 23:46:43 -0800825 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800826 }
827
828 if (instruction_set_ == kRuntimeISA) {
829 std::unique_ptr<const InstructionSetFeatures> runtime_features(
830 InstructionSetFeatures::FromCppDefines());
831 if (!instruction_set_features_->Equals(runtime_features.get())) {
832 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
833 << *instruction_set_features_ << ") and those of dex2oat executable ("
834 << *runtime_features <<") for the command line:\n"
835 << CommandLine();
836 }
837 }
838
Roland Levillaina215b952015-08-07 11:38:32 +0100839 // It they are not set, use default values for inlining settings.
840 // TODO: We should rethink the compiler filter. We mostly save
841 // time here, which is orthogonal to space.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000842 if (compiler_options_->inline_depth_limit_ == CompilerOptions::kUnsetInlineDepthLimit) {
843 compiler_options_->inline_depth_limit_ =
844 (compiler_options_->compiler_filter_ == CompilerOptions::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100845 // Implementation of the space filter: limit inlining depth.
846 ? CompilerOptions::kSpaceFilterInlineDepthLimit
847 : CompilerOptions::kDefaultInlineDepthLimit;
848 }
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000849 if (compiler_options_->inline_max_code_units_ == CompilerOptions::kUnsetInlineMaxCodeUnits) {
850 compiler_options_->inline_max_code_units_ =
851 (compiler_options_->compiler_filter_ == CompilerOptions::kSpace)
Roland Levillaina215b952015-08-07 11:38:32 +0100852 // Implementation of the space filter: limit inlining max code units.
853 ? CompilerOptions::kSpaceFilterInlineMaxCodeUnits
854 : CompilerOptions::kDefaultInlineMaxCodeUnits;
855 }
856
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800857 // Checks are all explicit until we know the architecture.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800858 // Set the compilation target's implicit checks options.
859 switch (instruction_set_) {
860 case kArm:
861 case kThumb2:
862 case kArm64:
863 case kX86:
864 case kX86_64:
Douglas Leung22bb5a22015-07-02 16:42:08 -0700865 case kMips:
866 case kMips64:
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000867 compiler_options_->implicit_null_checks_ = true;
868 compiler_options_->implicit_so_checks_ = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800869 break;
870
871 default:
872 // Defaults are correct.
873 break;
874 }
875
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +0000876 compiler_options_->verbose_methods_ = verbose_methods_.empty() ? nullptr : &verbose_methods_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800877
Jeff Hao436183f2016-01-12 16:36:50 -0800878 if (!IsBootImage() && multi_image_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800879 Usage("--multi-image can only be used when creating boot images");
880 }
Jeff Hao436183f2016-01-12 16:36:50 -0800881 if (IsBootImage() && multi_image_ && image_filenames_.size() > 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800882 Usage("--multi-image cannot be used with multiple image names");
883 }
884
885 // For now, if we're on the host and compile the boot image, *always* use multiple image files.
886 if (!kIsTargetBuild && IsBootImage()) {
887 if (image_filenames_.size() == 1) {
Jeff Hao436183f2016-01-12 16:36:50 -0800888 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -0800889 }
890 }
891
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800892 // Done with usage checks, enable watchdog if requested
Roland Levillain9ec5e222015-08-17 20:18:41 +0100893 if (parser_options->watch_dog_enabled) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800894 watchdog_.reset(new WatchDog(true));
895 }
896
897 // Fill some values into the key-value store for the oat header.
898 key_value_store_.reset(new SafeMap<std::string, std::string>());
Andreas Gampeace0dc12016-01-20 13:33:13 -0800899
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800900 // Automatically force determinism for the boot image in a host build if the default GC is CMS
901 // or MS and read barriers are not enabled, as the former switches the GC to a non-concurrent
902 // one by passing the option `-Xgc:nonconcurrent` (see below).
903 if (!kIsTargetBuild && IsBootImage()) {
904 if (SupportsDeterministicCompilation()) {
905 force_determinism_ = true;
906 } else {
907 LOG(WARNING) << "Deterministic compilation is disabled.";
908 }
Andreas Gampeace0dc12016-01-20 13:33:13 -0800909 }
910 compiler_options_->force_determinism_ = force_determinism_;
Roland Levillain9ec5e222015-08-17 20:18:41 +0100911 }
912
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -0800913 static bool SupportsDeterministicCompilation() {
914 return (gc::kCollectorTypeDefault == gc::kCollectorTypeCMS ||
915 gc::kCollectorTypeDefault == gc::kCollectorTypeMS) &&
916 !kEmitCompilerReadBarrier;
917 }
918
Jeff Hao436183f2016-01-12 16:36:50 -0800919 void ExpandOatAndImageFilenames() {
920 std::string base_oat = oat_filenames_[0];
921 size_t last_oat_slash = base_oat.rfind('/');
922 if (last_oat_slash == std::string::npos) {
923 Usage("--multi-image used with unusable oat filename %s", base_oat.c_str());
924 }
925 // We also need to honor path components that were encoded through '@'. Otherwise the loading
926 // code won't be able to find the images.
927 if (base_oat.find('@', last_oat_slash) != std::string::npos) {
928 last_oat_slash = base_oat.rfind('@');
929 }
930 base_oat = base_oat.substr(0, last_oat_slash + 1);
931
932 std::string base_img = image_filenames_[0];
933 size_t last_img_slash = base_img.rfind('/');
934 if (last_img_slash == std::string::npos) {
935 Usage("--multi-image used with unusable image filename %s", base_img.c_str());
936 }
937 // We also need to honor path components that were encoded through '@'. Otherwise the loading
938 // code won't be able to find the images.
939 if (base_img.find('@', last_img_slash) != std::string::npos) {
940 last_img_slash = base_img.rfind('@');
941 }
942
943 // Get the prefix, which is the primary image name (without path components). Strip the
944 // extension.
945 std::string prefix = base_img.substr(last_img_slash + 1);
946 if (prefix.rfind('.') != std::string::npos) {
947 prefix = prefix.substr(0, prefix.rfind('.'));
948 }
949 if (!prefix.empty()) {
950 prefix = prefix + "-";
951 }
952
953 base_img = base_img.substr(0, last_img_slash + 1);
954
955 // Note: we have some special case here for our testing. We have to inject the differentiating
956 // parts for the different core images.
957 std::string infix; // Empty infix by default.
958 {
959 // Check the first name.
960 std::string dex_file = oat_filenames_[0];
961 size_t last_dex_slash = dex_file.rfind('/');
962 if (last_dex_slash != std::string::npos) {
963 dex_file = dex_file.substr(last_dex_slash + 1);
964 }
965 size_t last_dex_dot = dex_file.rfind('.');
966 if (last_dex_dot != std::string::npos) {
967 dex_file = dex_file.substr(0, last_dex_dot);
968 }
969 if (StartsWith(dex_file, "core-")) {
970 infix = dex_file.substr(strlen("core"));
971 }
972 }
973
974 // Now create the other names. Use a counted loop to skip the first one.
975 for (size_t i = 1; i < dex_locations_.size(); ++i) {
976 // TODO: Make everything properly std::string.
977 std::string image_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".art");
978 char_backing_storage_.push_back(base_img + image_name);
979 image_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
980
981 std::string oat_name = CreateMultiImageName(dex_locations_[i], prefix, infix, ".oat");
982 char_backing_storage_.push_back(base_oat + oat_name);
983 oat_filenames_.push_back((char_backing_storage_.end() - 1)->c_str());
984 }
985 }
986
Andreas Gampe8994a042015-12-30 19:03:17 +0000987 // Modify the input string in the following way:
988 // 0) Assume input is /a/b/c.d
989 // 1) Strip the path -> c.d
990 // 2) Inject prefix p -> pc.d
991 // 3) Inject infix i -> pci.d
992 // 4) Replace suffix with s if it's "jar" -> d == "jar" -> pci.s
Jeff Haodcdc85b2015-12-04 14:06:18 -0800993 static std::string CreateMultiImageName(std::string in,
Andreas Gampe8994a042015-12-30 19:03:17 +0000994 const std::string& prefix,
Jeff Haodcdc85b2015-12-04 14:06:18 -0800995 const std::string& infix,
Andreas Gampe8994a042015-12-30 19:03:17 +0000996 const char* replace_suffix) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800997 size_t last_dex_slash = in.rfind('/');
998 if (last_dex_slash != std::string::npos) {
999 in = in.substr(last_dex_slash + 1);
1000 }
Andreas Gampe8994a042015-12-30 19:03:17 +00001001 if (!prefix.empty()) {
1002 in = prefix + in;
1003 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001004 if (!infix.empty()) {
1005 // Inject infix.
1006 size_t last_dot = in.rfind('.');
1007 if (last_dot != std::string::npos) {
1008 in.insert(last_dot, infix);
1009 }
1010 }
1011 if (EndsWith(in, ".jar")) {
Andreas Gampe8994a042015-12-30 19:03:17 +00001012 in = in.substr(0, in.length() - strlen(".jar")) +
1013 (replace_suffix != nullptr ? replace_suffix : "");
Jeff Haodcdc85b2015-12-04 14:06:18 -08001014 }
1015 return in;
1016 }
1017
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001018 void InsertCompileOptions(int argc, char** argv) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001019 std::ostringstream oss;
1020 for (int i = 0; i < argc; ++i) {
1021 if (i > 0) {
1022 oss << ' ';
1023 }
1024 oss << argv[i];
1025 }
1026 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1027 oss.str(""); // Reset.
1028 oss << kRuntimeISA;
1029 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
1030 key_value_store_->Put(
1031 OatHeader::kPicKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001032 compiler_options_->compile_pic_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001033 key_value_store_->Put(
1034 OatHeader::kDebuggableKey,
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001035 compiler_options_->debuggable_ ? OatHeader::kTrueValue : OatHeader::kFalseValue);
David Srbecky5d950762016-03-07 20:47:29 +00001036 key_value_store_->Put(
1037 OatHeader::kNativeDebuggableKey,
David Srbecky346dc992016-03-13 22:00:07 +00001038 compiler_options_->GetNativeDebuggable() ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Calin Juravleb077e152016-02-18 18:47:37 +00001039 if (compiler_options_->IsExtractOnly()) {
1040 key_value_store_->Put(OatHeader::kCompilationType, OatHeader::kExtractOnlyValue);
1041 } else if (UseProfileGuidedCompilation()) {
1042 key_value_store_->Put(OatHeader::kCompilationType, OatHeader::kProfileGuideCompiledValue);
1043 }
Roland Levillain9ec5e222015-08-17 20:18:41 +01001044 }
1045
1046 // Parse the arguments from the command line. In case of an unrecognized option or impossible
1047 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
1048 // returns, arguments have been successfully parsed.
1049 void ParseArgs(int argc, char** argv) {
1050 original_argc = argc;
1051 original_argv = argv;
1052
1053 InitLogging(argv);
1054
1055 // Skip over argv[0].
1056 argv++;
1057 argc--;
1058
1059 if (argc == 0) {
1060 Usage("No arguments specified");
1061 }
1062
1063 std::unique_ptr<ParserOptions> parser_options(new ParserOptions());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001064 compiler_options_.reset(new CompilerOptions());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001065
1066 for (int i = 0; i < argc; i++) {
1067 const StringPiece option(argv[i]);
1068 const bool log_options = false;
1069 if (log_options) {
1070 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1071 }
1072 if (option.starts_with("--dex-file=")) {
1073 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data());
1074 } else if (option.starts_with("--dex-location=")) {
1075 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data());
1076 } else if (option.starts_with("--zip-fd=")) {
1077 ParseZipFd(option);
1078 } else if (option.starts_with("--zip-location=")) {
1079 zip_location_ = option.substr(strlen("--zip-location=")).data();
1080 } else if (option.starts_with("--oat-file=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001081 oat_filenames_.push_back(option.substr(strlen("--oat-file=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001082 } else if (option.starts_with("--oat-symbols=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001083 parser_options->oat_symbols.push_back(option.substr(strlen("--oat-symbols=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001084 } else if (option.starts_with("--oat-fd=")) {
1085 ParseOatFd(option);
1086 } else if (option == "--watch-dog") {
1087 parser_options->watch_dog_enabled = true;
1088 } else if (option == "--no-watch-dog") {
1089 parser_options->watch_dog_enabled = false;
1090 } else if (option.starts_with("-j")) {
1091 ParseJ(option);
1092 } else if (option.starts_with("--oat-location=")) {
1093 oat_location_ = option.substr(strlen("--oat-location=")).data();
1094 } else if (option.starts_with("--image=")) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001095 image_filenames_.push_back(option.substr(strlen("--image=")).data());
Roland Levillain9ec5e222015-08-17 20:18:41 +01001096 } else if (option.starts_with("--image-classes=")) {
1097 image_classes_filename_ = option.substr(strlen("--image-classes=")).data();
1098 } else if (option.starts_with("--image-classes-zip=")) {
1099 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data();
Mathieu Chartierceb07b32015-12-10 09:33:21 -08001100 } else if (option.starts_with("--image-format=")) {
1101 ParseImageFormat(option);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001102 } else if (option.starts_with("--compiled-classes=")) {
1103 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data();
1104 } else if (option.starts_with("--compiled-classes-zip=")) {
1105 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data();
1106 } else if (option.starts_with("--compiled-methods=")) {
1107 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data();
1108 } else if (option.starts_with("--compiled-methods-zip=")) {
1109 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data();
1110 } else if (option.starts_with("--base=")) {
1111 ParseBase(option);
1112 } else if (option.starts_with("--boot-image=")) {
1113 parser_options->boot_image_filename = option.substr(strlen("--boot-image=")).data();
1114 } else if (option.starts_with("--android-root=")) {
1115 android_root_ = option.substr(strlen("--android-root=")).data();
1116 } else if (option.starts_with("--instruction-set=")) {
1117 ParseInstructionSet(option);
1118 } else if (option.starts_with("--instruction-set-variant=")) {
1119 ParseInstructionSetVariant(option, parser_options.get());
1120 } else if (option.starts_with("--instruction-set-features=")) {
1121 ParseInstructionSetFeatures(option, parser_options.get());
1122 } else if (option.starts_with("--compiler-backend=")) {
1123 ParseCompilerBackend(option, parser_options.get());
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001124 } else if (option.starts_with("--profile-file=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001125 profile_file_ = option.substr(strlen("--profile-file=")).ToString();
Calin Juravle877fd962016-01-05 14:29:29 +00001126 } else if (option.starts_with("--profile-file-fd=")) {
Calin Juravle2e2db782016-02-23 12:00:03 +00001127 ParseUintOption(option, "--profile-file-fd", &profile_file_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001128 } else if (option == "--host") {
1129 is_host_ = true;
1130 } else if (option == "--runtime-arg") {
1131 if (++i >= argc) {
1132 Usage("Missing required argument for --runtime-arg");
1133 }
1134 if (log_options) {
1135 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1136 }
1137 runtime_args_.push_back(argv[i]);
1138 } else if (option == "--dump-timing") {
1139 dump_timing_ = true;
1140 } else if (option == "--dump-passes") {
1141 dump_passes_ = true;
Roland Levillain9ec5e222015-08-17 20:18:41 +01001142 } else if (option == "--dump-stats") {
1143 dump_stats_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001144 } else if (option.starts_with("--swap-file=")) {
1145 swap_file_name_ = option.substr(strlen("--swap-file=")).data();
1146 } else if (option.starts_with("--swap-fd=")) {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001147 ParseUintOption(option, "--swap-fd", &swap_fd_, Usage);
1148 } else if (option.starts_with("--app-image-file=")) {
1149 app_image_file_name_ = option.substr(strlen("--app-image-file=")).data();
1150 } else if (option.starts_with("--app-image-fd=")) {
1151 ParseUintOption(option, "--app-image-fd", &app_image_fd_, Usage);
Roland Levillain9ec5e222015-08-17 20:18:41 +01001152 } else if (option.starts_with("--verbose-methods=")) {
1153 // TODO: rather than switch off compiler logging, make all VLOG(compiler) messages
1154 // conditional on having verbost methods.
1155 gLogVerbosity.compiler = false;
1156 Split(option.substr(strlen("--verbose-methods=")).ToString(), ',', &verbose_methods_);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001157 } else if (option == "--multi-image") {
Jeff Hao436183f2016-01-12 16:36:50 -08001158 multi_image_ = true;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001159 } else if (option.starts_with("--no-inline-from=")) {
1160 no_inline_from_string_ = option.substr(strlen("--no-inline-from=")).data();
Andreas Gampeace0dc12016-01-20 13:33:13 -08001161 } else if (option == "--force-determinism") {
Hiroshi Yamauchi6af53482016-01-29 15:38:58 -08001162 if (!SupportsDeterministicCompilation()) {
1163 Usage("Cannot use --force-determinism with read barriers or non-CMS garbage collector");
Roland Levillaineb2c7412016-01-28 14:37:01 +00001164 }
Andreas Gampeace0dc12016-01-20 13:33:13 -08001165 force_determinism_ = true;
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001166 } else if (!compiler_options_->ParseCompilerOption(option, Usage)) {
Roland Levillain9ec5e222015-08-17 20:18:41 +01001167 Usage("Unknown argument %s", option.data());
1168 }
1169 }
1170
Jeff Hao436183f2016-01-12 16:36:50 -08001171 ProcessOptions(parser_options.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001172
1173 // Insert some compiler things.
Nicolas Geoffrayabbb0f72015-10-29 18:55:58 +00001174 InsertCompileOptions(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001175 }
1176
Jeff Haodcdc85b2015-12-04 14:06:18 -08001177 // Check whether the oat output files are writable, and open them for later. Also open a swap
1178 // file, if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001179 bool OpenFile() {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001180 // Prune non-existent dex files now so that we don't create empty oat files for multi-image.
1181 PruneNonExistentDexFiles();
1182
Jeff Hao436183f2016-01-12 16:36:50 -08001183 // Expand oat and image filenames for multi image.
1184 if (IsBootImage() && multi_image_) {
1185 ExpandOatAndImageFilenames();
1186 }
1187
Jeff Haodcdc85b2015-12-04 14:06:18 -08001188 bool create_file = oat_fd_ == -1; // as opposed to using open file descriptor
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001189 if (create_file) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001190 for (const char* oat_filename : oat_filenames_) {
1191 std::unique_ptr<File> oat_file(OS::CreateEmptyFile(oat_filename));
1192 if (oat_file.get() == nullptr) {
1193 PLOG(ERROR) << "Failed to create oat file: " << oat_filename;
1194 return false;
1195 }
1196 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) {
1197 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_filename;
1198 oat_file->Erase();
1199 return false;
1200 }
1201 oat_files_.push_back(std::move(oat_file));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001202 }
1203 } else {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001204 std::unique_ptr<File> oat_file(new File(oat_fd_, oat_location_, true));
1205 oat_file->DisableAutoClose();
1206 if (oat_file->SetLength(0) != 0) {
Andreas Gampe4303ba92014-11-06 01:00:46 -08001207 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1208 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001209 if (oat_file.get() == nullptr) {
1210 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1211 return false;
1212 }
1213 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) {
1214 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_location_;
1215 oat_file->Erase();
1216 return false;
1217 }
1218 oat_filenames_.push_back(oat_location_.c_str());
1219 oat_files_.push_back(std::move(oat_file));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001220 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001221
1222 // Swap file handling.
1223 //
1224 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1225 // that we can use for swap.
1226 //
1227 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1228 // will immediately unlink to satisfy the swap fd assumption.
1229 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1230 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1231 if (swap_file.get() == nullptr) {
1232 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1233 return false;
1234 }
1235 swap_fd_ = swap_file->Fd();
1236 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1237 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1238 // released immediately.
1239 unlink(swap_file_name_.c_str());
1240 }
Jeff Hao436183f2016-01-12 16:36:50 -08001241
1242 // If we use a swap file, ensure we are above the threshold to make it necessary.
1243 if (swap_fd_ != -1) {
1244 if (!UseSwap(IsBootImage(), dex_files_)) {
1245 close(swap_fd_);
1246 swap_fd_ = -1;
1247 VLOG(compiler) << "Decided to run without swap.";
1248 } else {
1249 LOG(INFO) << "Large app, accepted running with swap.";
1250 }
1251 }
1252 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
1253
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001254 return true;
1255 }
1256
Jeff Haodcdc85b2015-12-04 14:06:18 -08001257 void EraseOatFiles() {
1258 for (size_t i = 0; i < oat_files_.size(); ++i) {
1259 DCHECK(oat_files_[i].get() != nullptr);
1260 oat_files_[i]->Erase();
1261 oat_files_[i].reset();
1262 }
Andreas Gampea650e702014-12-03 14:28:02 -08001263 }
1264
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001265 void Shutdown() {
1266 ScopedObjectAccess soa(Thread::Current());
1267 for (jobject dex_cache : dex_caches_) {
1268 soa.Env()->DeleteLocalRef(dex_cache);
1269 }
1270 dex_caches_.clear();
1271 }
1272
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001273 void LoadClassProfileDescriptors() {
1274 if (profile_compilation_info_ != nullptr && app_image_) {
1275 Runtime* runtime = Runtime::Current();
1276 CHECK(runtime != nullptr);
1277 std::set<DexCacheResolvedClasses> resolved_classes(
1278 profile_compilation_info_->GetResolvedClasses());
1279 image_classes_.reset(new std::unordered_set<std::string>(
1280 runtime->GetClassLinker()->GetClassDescriptorsForProfileKeys(resolved_classes)));
1281 VLOG(compiler) << "Loaded " << image_classes_->size()
1282 << " image class descriptors from profile";
1283 if (VLOG_IS_ON(compiler)) {
1284 for (const std::string& s : *image_classes_) {
1285 LOG(INFO) << "Image class " << s;
1286 }
1287 }
1288 }
1289 }
1290
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001291 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1292 // boot class path.
1293 bool Setup() {
1294 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001295 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap.
Vladimir Marko49b0f452015-12-10 13:49:19 +00001296
1297 if (!PrepareImageClasses() || !PrepareCompiledClasses() || !PrepareCompiledMethods()) {
1298 return false;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001299 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001300
Vladimir Marko307dac92015-10-20 11:20:09 +01001301 verification_results_.reset(new VerificationResults(compiler_options_.get()));
Andreas Gampe4585f872015-03-27 23:45:15 -07001302 callbacks_.reset(new QuickCompilerCallbacks(
Vladimir Marko307dac92015-10-20 11:20:09 +01001303 verification_results_.get(),
Andreas Gampe4585f872015-03-27 23:45:15 -07001304 &method_inliner_map_,
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001305 IsBootImage() ?
Andreas Gampe4585f872015-03-27 23:45:15 -07001306 CompilerCallbacks::CallbackMode::kCompileBootImage :
1307 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001308
Vladimir Marko49b0f452015-12-10 13:49:19 +00001309 RuntimeArgumentMap runtime_options;
1310 if (!PrepareRuntimeOptions(&runtime_options)) {
1311 return false;
Andreas Gampe1d00add2015-02-27 19:35:46 -08001312 }
1313
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001314 CreateOatWriters();
1315 if (!AddDexFileSources()) {
1316 return false;
1317 }
1318
1319 if (IsBootImage() && image_filenames_.size() > 1) {
1320 // If we're compiling the boot image, store the boot classpath into the Key-Value store.
1321 // We need this for the multi-image case.
1322 key_value_store_->Put(OatHeader::kBootClassPath, GetMultiImageBootClassPath());
1323 }
1324
1325 if (!IsBootImage()) {
1326 // When compiling an app, create the runtime early to retrieve
1327 // the image location key needed for the oat header.
1328 if (!CreateRuntime(std::move(runtime_options))) {
1329 return false;
1330 }
1331
David Brazdilce4b0ba2016-01-28 15:05:49 +00001332 if (compiler_options_->IsExtractOnly()) {
1333 // ExtractOnly oat files only contain non-quickened DEX code and are
1334 // therefore independent of the image file.
1335 image_file_location_oat_checksum_ = 0u;
1336 image_file_location_oat_data_begin_ = 0u;
1337 image_patch_delta_ = 0;
1338 } else {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001339 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1340 std::vector<gc::space::ImageSpace*> image_spaces =
1341 Runtime::Current()->GetHeap()->GetBootImageSpaces();
1342 image_file_location_oat_checksum_ = image_spaces[0]->GetImageHeader().GetOatChecksum();
1343 image_file_location_oat_data_begin_ =
1344 reinterpret_cast<uintptr_t>(image_spaces[0]->GetImageHeader().GetOatDataBegin());
1345 image_patch_delta_ = image_spaces[0]->GetImageHeader().GetPatchDelta();
1346 // Store the boot image filename(s).
1347 std::vector<std::string> image_filenames;
1348 for (const gc::space::ImageSpace* image_space : image_spaces) {
1349 image_filenames.push_back(image_space->GetImageFilename());
1350 }
1351 std::string image_file_location = Join(image_filenames, ':');
1352 if (!image_file_location.empty()) {
1353 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1354 }
1355 }
1356
1357 // Open dex files for class path.
1358 const std::vector<std::string> class_path_locations =
1359 GetClassPathLocations(runtime_->GetClassPathString());
1360 OpenClassPathFiles(class_path_locations, &class_path_files_);
1361
1362 // Store the classpath we have right now.
1363 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1364 key_value_store_->Put(OatHeader::kClassPathKey,
1365 OatFile::EncodeDexFileDependencies(class_path_files));
1366 }
1367
1368 // Now that we have finalized key_value_store_, start writing the oat file.
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001369 {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001370 TimingLogger::ScopedTiming t_dex("Writing and opening dex files", timings_);
1371 rodata_.reserve(oat_writers_.size());
1372 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
1373 rodata_.push_back(elf_writers_[i]->StartRoData());
1374 // Unzip or copy dex files straight to the oat file.
1375 std::unique_ptr<MemMap> opened_dex_files_map;
1376 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
1377 if (!oat_writers_[i]->WriteAndOpenDexFiles(rodata_.back(),
1378 oat_files_[i].get(),
1379 instruction_set_,
1380 instruction_set_features_.get(),
1381 key_value_store_.get(),
Andreas Gampe3a2bd292016-01-26 17:23:47 -08001382 /* verify */ true,
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001383 &opened_dex_files_map,
1384 &opened_dex_files)) {
1385 return false;
1386 }
1387 dex_files_per_oat_file_.push_back(MakeNonOwningPointerVector(opened_dex_files));
1388 if (opened_dex_files_map != nullptr) {
1389 opened_dex_files_maps_.push_back(std::move(opened_dex_files_map));
1390 for (std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
Vladimir Marko944da602016-02-19 12:27:55 +00001391 dex_file_oat_index_map_.emplace(dex_file.get(), i);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001392 opened_dex_files_.push_back(std::move(dex_file));
1393 }
1394 } else {
1395 DCHECK(opened_dex_files.empty());
1396 }
1397 }
1398 }
1399
1400 dex_files_ = MakeNonOwningPointerVector(opened_dex_files_);
1401 if (IsBootImage()) {
1402 // For boot image, pass opened dex files to the Runtime::Create().
1403 // Note: Runtime acquires ownership of these dex files.
1404 runtime_options.Set(RuntimeArgumentMap::BootClassPathDexList, &opened_dex_files_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00001405 if (!CreateRuntime(std::move(runtime_options))) {
Andreas Gampec7ae55d2015-09-15 20:04:54 -07001406 return false;
1407 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001408 }
1409
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001410 // If we're doing the image, override the compiler filter to force full compilation. Must be
1411 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1412 // compilation of class initializers.
1413 // Whilst we're in native take the opportunity to initialize well known classes.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001414 Thread* self = Thread::Current();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001415 WellKnownClasses::Init(self->GetJniEnv());
1416
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001417 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001418 if (!IsBootImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001419 constexpr bool kSaveDexInput = false;
1420 if (kSaveDexInput) {
Vladimir Marko49b0f452015-12-10 13:49:19 +00001421 SaveDexInput();
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001422 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001423
1424 // Handle and ClassLoader creation needs to come after Runtime::Create.
1425 ScopedObjectAccess soa(self);
1426
1427 // Classpath: first the class-path given.
1428 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1429
1430 // Then the dex files we'll compile. Thus we'll resolve the class-path first.
1431 class_path_files.insert(class_path_files.end(), dex_files_.begin(), dex_files_.end());
1432
1433 class_loader_ = class_linker->CreatePathClassLoader(self, class_path_files);
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001434 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001435
1436 // Ensure opened dex files are writable for dex-to-dex transformations.
1437 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1438 if (!map->Protect(PROT_READ | PROT_WRITE)) {
1439 PLOG(ERROR) << "Failed to make .dex files writeable.";
1440 return false;
Vladimir Marko919f5532016-01-20 19:13:01 +00001441 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001442 }
1443
1444 // Ensure that the dex caches stay live since we don't want class unloading
1445 // to occur during compilation.
1446 for (const auto& dex_file : dex_files_) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001447 ScopedObjectAccess soa(self);
1448 dex_caches_.push_back(soa.AddLocalReference<jobject>(
Mathieu Chartierd57d4542015-10-14 10:55:30 -07001449 class_linker->RegisterDexFile(*dex_file, Runtime::Current()->GetLinearAlloc())));
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001450 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001451
1452 /*
Mathieu Chartier1cc7e8b2016-03-16 14:29:17 -07001453 * If we're not in interpret-only or verify-none or verify-at-runtime mode, go ahead and
1454 * compile small applications. Don't bother to check if we're doing the image.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001455 */
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001456 if (!IsBootImage() &&
Brian Carlstrom95b033b2014-12-03 22:29:37 -08001457 compiler_options_->IsCompilationEnabled() &&
1458 compiler_kind_ == Compiler::kQuick) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001459 size_t num_methods = 0;
1460 for (size_t i = 0; i != dex_files_.size(); ++i) {
1461 const DexFile* dex_file = dex_files_[i];
1462 CHECK(dex_file != nullptr);
1463 num_methods += dex_file->NumMethodIds();
1464 }
1465 if (num_methods <= compiler_options_->GetNumDexMethodsThreshold()) {
1466 compiler_options_->SetCompilerFilter(CompilerOptions::kSpeed);
1467 VLOG(compiler) << "Below method threshold, compiling anyways";
1468 }
1469 }
1470
1471 return true;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001472 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001473
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001474 // If we need to keep the oat file open for the image writer.
1475 bool ShouldKeepOatFileOpen() const {
1476 return IsImage() && oat_fd_ != kInvalidFd;
1477 }
1478
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001479 // Create and invoke the compiler driver. This will compile all the dex files.
1480 void Compile() {
1481 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1482 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001483
Vladimir Marko47496c22016-01-27 16:15:08 +00001484 // Find the dex files we should not inline from.
1485
1486 std::vector<std::string> no_inline_filters;
1487 Split(no_inline_from_string_, ',', &no_inline_filters);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001488
1489 // For now, on the host always have core-oj removed.
Vladimir Marko47496c22016-01-27 16:15:08 +00001490 const std::string core_oj = "core-oj";
1491 if (!kIsTargetBuild && !ContainsElement(no_inline_filters, core_oj)) {
1492 no_inline_filters.push_back(core_oj);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001493 }
1494
Vladimir Marko47496c22016-01-27 16:15:08 +00001495 if (!no_inline_filters.empty()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001496 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1497 std::vector<const DexFile*> class_path_files = MakeNonOwningPointerVector(class_path_files_);
1498 std::vector<const std::vector<const DexFile*>*> dex_file_vectors = {
1499 &class_linker->GetBootClassPath(),
1500 &class_path_files,
1501 &dex_files_
1502 };
1503 for (const std::vector<const DexFile*>* dex_file_vector : dex_file_vectors) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001504 for (const DexFile* dex_file : *dex_file_vector) {
Vladimir Marko47496c22016-01-27 16:15:08 +00001505 for (const std::string& filter : no_inline_filters) {
1506 // Use dex_file->GetLocation() rather than dex_file->GetBaseLocation(). This
1507 // allows tests to specify <test-dexfile>:classes2.dex if needed but if the
1508 // base location passes the StartsWith() test, so do all extra locations.
1509 std::string dex_location = dex_file->GetLocation();
1510 if (filter.find('/') == std::string::npos) {
1511 // The filter does not contain the path. Remove the path from dex_location as well.
1512 size_t last_slash = dex_file->GetLocation().rfind('/');
1513 if (last_slash != std::string::npos) {
1514 dex_location = dex_location.substr(last_slash + 1);
1515 }
1516 }
1517
1518 if (StartsWith(dex_location, filter.c_str())) {
1519 VLOG(compiler) << "Disabling inlining from " << dex_file->GetLocation();
1520 no_inline_from_dex_files_.push_back(dex_file);
1521 break;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001522 }
1523 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001524 }
Vladimir Marko47496c22016-01-27 16:15:08 +00001525 }
1526 if (!no_inline_from_dex_files_.empty()) {
1527 compiler_options_->no_inline_from_ = &no_inline_from_dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001528 }
1529 }
1530
Vladimir Marko307dac92015-10-20 11:20:09 +01001531 driver_.reset(new CompilerDriver(compiler_options_.get(),
1532 verification_results_.get(),
1533 &method_inliner_map_,
1534 compiler_kind_,
1535 instruction_set_,
1536 instruction_set_features_.get(),
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001537 IsBootImage(),
Vladimir Marko307dac92015-10-20 11:20:09 +01001538 image_classes_.release(),
1539 compiled_classes_.release(),
Vladimir Marko944da602016-02-19 12:27:55 +00001540 /* compiled_methods */ nullptr,
Vladimir Marko307dac92015-10-20 11:20:09 +01001541 thread_count_,
1542 dump_stats_,
1543 dump_passes_,
Vladimir Marko307dac92015-10-20 11:20:09 +01001544 compiler_phases_timings_.get(),
1545 swap_fd_,
Calin Juravle998c2162015-12-21 15:39:33 +02001546 profile_compilation_info_.get()));
Vladimir Markod1eaf0d2015-10-29 12:18:29 +00001547 driver_->SetDexFilesForOatFile(dex_files_);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001548 driver_->CompileAll(class_loader_, dex_files_, timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001549 }
1550
Jeff Hao436183f2016-01-12 16:36:50 -08001551 // Notes on the interleaving of creating the images and oat files to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001552 // ensure the references between the two are correct.
1553 //
1554 // Currently we have a memory layout that looks something like this:
1555 //
1556 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001557 // | images |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001558 // +--------------+
Jeff Hao436183f2016-01-12 16:36:50 -08001559 // | oat files |
Brian Carlstrom7940e442013-07-12 13:46:57 -07001560 // +--------------+
1561 // | alloc spaces |
1562 // +--------------+
1563 //
Jeff Hao436183f2016-01-12 16:36:50 -08001564 // There are several constraints on the loading of the images and oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001565 //
Jeff Hao436183f2016-01-12 16:36:50 -08001566 // 1. The images are expected to be loaded at an absolute address and
1567 // contain Objects with absolute pointers within the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001568 //
Jeff Hao436183f2016-01-12 16:36:50 -08001569 // 2. There are absolute pointers from Methods in the images to their
1570 // code in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001571 //
Jeff Hao436183f2016-01-12 16:36:50 -08001572 // 3. There are absolute pointers from the code in the oat files to Methods
1573 // in the images.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001574 //
Jeff Hao436183f2016-01-12 16:36:50 -08001575 // 4. There are absolute pointers from code in the oat files to other code
1576 // in the oat files.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001577 //
1578 // To get this all correct, we go through several steps.
1579 //
Jeff Hao436183f2016-01-12 16:36:50 -08001580 // 1. We prepare offsets for all data in the oat files and calculate
Vladimir Markof4da6752014-08-01 19:04:18 +01001581 // the oat data size and code size. During this stage, we also set
1582 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001583 //
Jeff Hao436183f2016-01-12 16:36:50 -08001584 // 2. We prepare offsets for the objects in the images and calculate
1585 // the image sizes.
Vladimir Markof4da6752014-08-01 19:04:18 +01001586 //
Jeff Hao436183f2016-01-12 16:36:50 -08001587 // 3. We create the oat files. Originally this was just our own proprietary
Vladimir Markof4da6752014-08-01 19:04:18 +01001588 // file but now it is contained within an ELF dynamic object (aka an .so
Jeff Hao436183f2016-01-12 16:36:50 -08001589 // file). Since we know the image sizes and oat data sizes and code sizes we
Vladimir Markof4da6752014-08-01 19:04:18 +01001590 // can prepare the ELF headers and we then know the ELF memory segment
1591 // layout and we can now resolve all references. The compiler provides
1592 // LinkerPatch information in each CompiledMethod and we resolve these,
1593 // using the layout information and image object locations provided by
1594 // image writer, as we're writing the method code.
1595 //
Jeff Hao436183f2016-01-12 16:36:50 -08001596 // 4. We create the image files. They need to know where the oat files
1597 // will be loaded after itself. Originally oat files were simply
1598 // memory mapped so we could predict where their contents were based
1599 // on the file size. Now that they are ELF files, we need to inspect
1600 // the ELF files to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001601 // where the oat header is located within.
1602 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001603 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001604 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001605 // load the .so at the desired location at runtime by offsetting the
1606 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001607 // TODO: Do this in step 3. We already know the layout there.
1608 //
1609 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1610 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001611
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001612 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1613 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001614 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1615 // case (when the file will be explicitly erased).
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001616 bool WriteOatFiles() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001617 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1618
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001619 // Sync the data to the file, in case we did dex2dex transformations.
1620 for (const std::unique_ptr<MemMap>& map : opened_dex_files_maps_) {
1621 if (!map->Sync()) {
1622 PLOG(ERROR) << "Failed to Sync() dex2dex output. Map: " << map->GetName();
1623 return false;
1624 }
1625 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001626
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001627 if (IsImage()) {
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001628 if (app_image_ && image_base_ == 0) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001629 gc::Heap* const heap = Runtime::Current()->GetHeap();
1630 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001631 image_base_ = std::max(image_base_, RoundUp(
1632 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatFileEnd()),
1633 kPageSize));
1634 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001635 // The non moving space is right after the oat file. Put the preferred app image location
1636 // right after the non moving space so that we ideally get a continuous immune region for
1637 // the GC.
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08001638 // Use the default non moving space capacity since dex2oat does not have a separate non-
1639 // moving space. This means the runtime's non moving space space size will be as large
1640 // as the growth limit for dex2oat, but smaller in the zygote.
1641 const size_t non_moving_space_capacity = gc::Heap::kDefaultNonMovingSpaceCapacity;
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001642 image_base_ += non_moving_space_capacity;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001643 VLOG(compiler) << "App image base=" << reinterpret_cast<void*>(image_base_);
1644 }
1645
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001646 image_writer_.reset(new ImageWriter(*driver_,
1647 image_base_,
1648 compiler_options_->GetCompilePic(),
1649 IsAppImage(),
1650 image_storage_mode_,
1651 oat_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00001652 dex_file_oat_index_map_));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001653
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001654 // We need to prepare method offsets in the image address space for direct method patching.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001655 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1656 if (!image_writer_->PrepareImageAddressSpace()) {
1657 LOG(ERROR) << "Failed to prepare image address space.";
1658 return false;
1659 }
1660 }
1661
Vladimir Marko944da602016-02-19 12:27:55 +00001662 linker::MultiOatRelativePatcher patcher(instruction_set_, instruction_set_features_.get());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001663 {
1664 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001665 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Vladimir Marko944da602016-02-19 12:27:55 +00001666 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1667 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
1668
1669 std::vector<const DexFile*>& dex_files = dex_files_per_oat_file_[i];
1670 oat_writer->PrepareLayout(driver_.get(), image_writer_.get(), dex_files, &patcher);
1671
1672 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
1673 size_t text_size = oat_writer->GetSize() - rodata_size;
1674 elf_writer->SetLoadedSectionSizes(rodata_size, text_size, oat_writer->GetBssSize());
1675
1676 if (IsImage()) {
1677 // Update oat layout.
1678 DCHECK(image_writer_ != nullptr);
1679 DCHECK_LT(i, oat_filenames_.size());
1680 image_writer_->UpdateOatFileLayout(i,
1681 elf_writer->GetLoadedSize(),
1682 oat_writer->GetOatDataOffset(),
1683 oat_writer->GetSize());
1684 }
1685 }
1686
1687 for (size_t i = 0, size = oat_files_.size(); i != size; ++i) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001688 std::unique_ptr<File>& oat_file = oat_files_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001689 std::unique_ptr<ElfWriter>& elf_writer = elf_writers_[i];
1690 std::unique_ptr<OatWriter>& oat_writer = oat_writers_[i];
Vladimir Marko10c13562015-11-25 14:33:36 +00001691
David Srbecky09c2a6b2016-03-11 17:11:44 +00001692 oat_writer->AddMethodDebugInfos(debug::MakeTrampolineInfos(oat_writer->GetOatHeader()));
1693
David Srbecky0c4572e2016-01-22 19:19:25 +00001694 // We need to mirror the layout of the ELF file in the compressed debug-info.
Vladimir Marko944da602016-02-19 12:27:55 +00001695 // Therefore PrepareDebugInfo() relies on the SetLoadedSectionSizes() call further above.
1696 elf_writer->PrepareDebugInfo(oat_writer->GetMethodDebugInfo());
David Srbecky0c4572e2016-01-22 19:19:25 +00001697
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001698 OutputStream*& rodata = rodata_[i];
1699 DCHECK(rodata != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001700 if (!oat_writer->WriteRodata(rodata)) {
1701 LOG(ERROR) << "Failed to write .rodata section to the ELF file " << oat_file->GetPath();
1702 return false;
1703 }
1704 elf_writer->EndRoData(rodata);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001705 rodata = nullptr;
Vladimir Marko10c13562015-11-25 14:33:36 +00001706
Jeff Haodcdc85b2015-12-04 14:06:18 -08001707 OutputStream* text = elf_writer->StartText();
1708 if (!oat_writer->WriteCode(text)) {
1709 LOG(ERROR) << "Failed to write .text section to the ELF file " << oat_file->GetPath();
1710 return false;
1711 }
1712 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +00001713
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001714 if (!oat_writer->WriteHeader(elf_writer->GetStream(),
1715 image_file_location_oat_checksum_,
1716 image_file_location_oat_data_begin_,
1717 image_patch_delta_)) {
1718 LOG(ERROR) << "Failed to write oat header to the ELF file " << oat_file->GetPath();
1719 return false;
1720 }
1721
Vladimir Marko944da602016-02-19 12:27:55 +00001722 if (IsImage()) {
1723 // Update oat header information.
1724 DCHECK(image_writer_ != nullptr);
1725 DCHECK_LT(i, oat_filenames_.size());
1726 image_writer_->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
1727 }
1728
Jeff Haodcdc85b2015-12-04 14:06:18 -08001729 elf_writer->WriteDynamicSection();
1730 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
1731 elf_writer->WritePatchLocations(oat_writer->GetAbsolutePatchLocations());
Vladimir Marko10c13562015-11-25 14:33:36 +00001732
Jeff Haodcdc85b2015-12-04 14:06:18 -08001733 if (!elf_writer->End()) {
1734 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
1735 return false;
1736 }
1737
1738 // Flush the oat file.
1739 if (oat_files_[i] != nullptr) {
1740 if (oat_files_[i]->Flush() != 0) {
1741 PLOG(ERROR) << "Failed to flush oat file: " << oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08001742 return false;
1743 }
1744 }
1745
Jeff Haodcdc85b2015-12-04 14:06:18 -08001746 VLOG(compiler) << "Oat file written successfully: " << oat_filenames_[i];
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001747
1748 oat_writer.reset();
1749 elf_writer.reset();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001750 }
1751 }
1752
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001753 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001754 }
1755
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001756 // If we are compiling an image, invoke the image creation routine. Else just skip.
1757 bool HandleImage() {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001758 if (IsImage()) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001759 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
1760 if (!CreateImageFile()) {
1761 return false;
1762 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001763 VLOG(compiler) << "Images written successfully";
Brian Carlstrom45602482013-07-21 22:07:55 -07001764 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001765 return true;
1766 }
1767
Jeff Haodcdc85b2015-12-04 14:06:18 -08001768 // Create a copy from stripped to unstripped.
1769 bool CopyStrippedToUnstripped() {
1770 for (size_t i = 0; i < oat_unstripped_.size(); ++i) {
1771 // If we don't want to strip in place, copy from stripped location to unstripped location.
1772 // We need to strip after image creation because FixupElf needs to use .strtab.
1773 if (strcmp(oat_unstripped_[i], oat_filenames_[i]) != 0) {
1774 // If the oat file is still open, flush it.
1775 if (oat_files_[i].get() != nullptr && oat_files_[i]->IsOpened()) {
1776 if (!FlushCloseOatFile(i)) {
1777 return false;
1778 }
1779 }
1780
1781 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
1782 std::unique_ptr<File> in(OS::OpenFileForReading(oat_filenames_[i]));
1783 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_unstripped_[i]));
1784 size_t buffer_size = 8192;
1785 std::unique_ptr<uint8_t[]> buffer(new uint8_t[buffer_size]);
1786 while (true) {
1787 int bytes_read = TEMP_FAILURE_RETRY(read(in->Fd(), buffer.get(), buffer_size));
1788 if (bytes_read <= 0) {
1789 break;
1790 }
1791 bool write_ok = out->WriteFully(buffer.get(), bytes_read);
1792 CHECK(write_ok);
1793 }
1794 if (out->FlushCloseOrErase() != 0) {
1795 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_unstripped_[i];
1796 return false;
1797 }
1798 VLOG(compiler) << "Oat file copied successfully (unstripped): " << oat_unstripped_[i];
1799 }
1800 }
1801 return true;
1802 }
1803
1804 bool FlushOatFiles() {
1805 TimingLogger::ScopedTiming t2("dex2oat Flush ELF", timings_);
1806 for (size_t i = 0; i < oat_files_.size(); ++i) {
1807 if (oat_files_[i].get() != nullptr) {
1808 if (oat_files_[i]->Flush() != 0) {
1809 PLOG(ERROR) << "Failed to flush oat file: " << oat_filenames_[i];
1810 oat_files_[i]->Erase();
Andreas Gampe10e477d2014-11-19 12:57:42 -08001811 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001812 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001813 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00001814 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08001815 return true;
1816 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001817
Jeff Haodcdc85b2015-12-04 14:06:18 -08001818 bool FlushCloseOatFile(size_t i) {
1819 if (oat_files_[i].get() != nullptr) {
1820 std::unique_ptr<File> tmp(oat_files_[i].release());
Andreas Gampe10e477d2014-11-19 12:57:42 -08001821 if (tmp->FlushCloseOrErase() != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001822 PLOG(ERROR) << "Failed to flush and close oat file: " << oat_filenames_[i];
Andreas Gampe10e477d2014-11-19 12:57:42 -08001823 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001824 }
1825 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001826 return true;
1827 }
1828
Jeff Haodcdc85b2015-12-04 14:06:18 -08001829 bool FlushCloseOatFiles() {
1830 bool result = true;
1831 for (size_t i = 0; i < oat_files_.size(); ++i) {
1832 result &= FlushCloseOatFile(i);
1833 }
1834 return result;
1835 }
1836
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001837 void DumpTiming() {
1838 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
1839 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
1840 }
1841 if (dump_passes_) {
1842 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
1843 }
1844 }
1845
1846 CompilerOptions* GetCompilerOptions() const {
1847 return compiler_options_.get();
1848 }
1849
Andreas Gampe10e477d2014-11-19 12:57:42 -08001850 bool IsImage() const {
Mathieu Chartiera90c7722015-10-29 15:41:36 -07001851 return IsAppImage() || IsBootImage();
1852 }
1853
1854 bool IsAppImage() const {
1855 return app_image_;
1856 }
1857
1858 bool IsBootImage() const {
1859 return boot_image_;
Andreas Gampe10e477d2014-11-19 12:57:42 -08001860 }
1861
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001862 bool IsHost() const {
1863 return is_host_;
1864 }
1865
Calin Juravle998c2162015-12-21 15:39:33 +02001866 bool UseProfileGuidedCompilation() const {
Calin Juravle2e2db782016-02-23 12:00:03 +00001867 return !profile_file_.empty() || (profile_file_fd_ != kInvalidFd);
Calin Juravle998c2162015-12-21 15:39:33 +02001868 }
1869
Calin Juravle2e2db782016-02-23 12:00:03 +00001870 bool LoadProfile() {
Calin Juravle998c2162015-12-21 15:39:33 +02001871 DCHECK(UseProfileGuidedCompilation());
Calin Juravle2e2db782016-02-23 12:00:03 +00001872
1873 profile_compilation_info_.reset(new ProfileCompilationInfo());
1874 ScopedFlock flock;
1875 bool success = false;
1876 std::string error;
1877 if (profile_file_fd_ != -1) {
1878 // The file doesn't need to be flushed so don't check the usage.
1879 // Pass a bogus path so that we can easily attribute any reported error.
1880 File file(profile_file_fd_, "profile", /*check_usage*/ false, /*read_only_mode*/ true);
1881 if (flock.Init(&file, &error)) {
1882 success = profile_compilation_info_->Load(profile_file_fd_);
1883 }
Calin Juravle877fd962016-01-05 14:29:29 +00001884 } else {
Calin Juravle2e2db782016-02-23 12:00:03 +00001885 if (flock.Init(profile_file_.c_str(), O_RDONLY, /* block */ true, &error)) {
1886 success = profile_compilation_info_->Load(flock.GetFile()->Fd());
1887 }
1888 }
1889 if (!error.empty()) {
1890 LOG(WARNING) << "Cannot lock profiles: " << error;
Calin Juravle998c2162015-12-21 15:39:33 +02001891 }
Calin Juravle877fd962016-01-05 14:29:29 +00001892
Calin Juravle2e2db782016-02-23 12:00:03 +00001893 if (!success) {
1894 profile_compilation_info_.reset(nullptr);
1895 }
Calin Juravle877fd962016-01-05 14:29:29 +00001896
Calin Juravle2e2db782016-02-23 12:00:03 +00001897 return success;
Calin Juravle998c2162015-12-21 15:39:33 +02001898 }
1899
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001900 private:
Vladimir Marko49b0f452015-12-10 13:49:19 +00001901 template <typename T>
1902 static std::vector<T*> MakeNonOwningPointerVector(const std::vector<std::unique_ptr<T>>& src) {
1903 std::vector<T*> result;
1904 result.reserve(src.size());
1905 for (const std::unique_ptr<T>& t : src) {
1906 result.push_back(t.get());
1907 }
1908 return result;
1909 }
1910
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001911 std::string GetMultiImageBootClassPath() {
1912 DCHECK(IsBootImage());
1913 DCHECK_GT(oat_filenames_.size(), 1u);
1914 // If the image filename was adapted (e.g., for our tests), we need to change this here,
1915 // too, but need to strip all path components (they will be re-established when loading).
1916 std::ostringstream bootcp_oss;
1917 bool first_bootcp = true;
1918 for (size_t i = 0; i < dex_locations_.size(); ++i) {
1919 if (!first_bootcp) {
1920 bootcp_oss << ":";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001921 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001922
1923 std::string dex_loc = dex_locations_[i];
1924 std::string image_filename = image_filenames_[i];
1925
1926 // Use the dex_loc path, but the image_filename name (without path elements).
1927 size_t dex_last_slash = dex_loc.rfind('/');
1928
1929 // npos is max(size_t). That makes this a bit ugly.
1930 size_t image_last_slash = image_filename.rfind('/');
1931 size_t image_last_at = image_filename.rfind('@');
1932 size_t image_last_sep = (image_last_slash == std::string::npos)
1933 ? image_last_at
1934 : (image_last_at == std::string::npos)
1935 ? std::string::npos
1936 : std::max(image_last_slash, image_last_at);
1937 // Note: whenever image_last_sep == npos, +1 overflow means using the full string.
1938
1939 if (dex_last_slash == std::string::npos) {
1940 dex_loc = image_filename.substr(image_last_sep + 1);
1941 } else {
1942 dex_loc = dex_loc.substr(0, dex_last_slash + 1) +
1943 image_filename.substr(image_last_sep + 1);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001944 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001945
1946 // Image filenames already end with .art, no need to replace.
1947
1948 bootcp_oss << dex_loc;
1949 first_bootcp = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001950 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001951 return bootcp_oss.str();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001952 }
1953
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001954 std::vector<std::string> GetClassPathLocations(const std::string& class_path) {
1955 // This function is used only for apps and for an app we have exactly one oat file.
1956 DCHECK(!IsBootImage());
1957 DCHECK_EQ(oat_writers_.size(), 1u);
1958 std::vector<std::string> dex_files_canonical_locations;
1959 for (const char* location : oat_writers_[0]->GetSourceLocations()) {
1960 dex_files_canonical_locations.push_back(DexFile::GetDexCanonicalLocation(location));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001961 }
Vladimir Marko625a64a2015-11-26 14:44:16 +00001962
Vladimir Marko919f5532016-01-20 19:13:01 +00001963 std::vector<std::string> parsed;
1964 Split(class_path, ':', &parsed);
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001965 auto kept_it = std::remove_if(parsed.begin(),
1966 parsed.end(),
1967 [dex_files_canonical_locations](const std::string& location) {
1968 return ContainsElement(dex_files_canonical_locations,
1969 DexFile::GetDexCanonicalLocation(location.c_str()));
1970 });
1971 parsed.erase(kept_it, parsed.end());
1972 return parsed;
1973 }
1974
1975 // Opens requested class path files and appends them to opened_dex_files.
1976 static void OpenClassPathFiles(const std::vector<std::string>& class_path_locations,
1977 std::vector<std::unique_ptr<const DexFile>>* opened_dex_files) {
1978 DCHECK(opened_dex_files != nullptr) << "OpenClassPathFiles out-param is nullptr";
1979 for (const std::string& location : class_path_locations) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001980 std::string error_msg;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00001981 if (!DexFile::Open(location.c_str(), location.c_str(), &error_msg, opened_dex_files)) {
1982 LOG(WARNING) << "Failed to open dex file '" << location << "': " << error_msg;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001983 }
1984 }
1985 }
1986
Vladimir Marko49b0f452015-12-10 13:49:19 +00001987 bool PrepareImageClasses() {
1988 // If --image-classes was specified, calculate the full list of classes to include in the image.
1989 if (image_classes_filename_ != nullptr) {
1990 image_classes_ =
1991 ReadClasses(image_classes_zip_filename_, image_classes_filename_, "image");
1992 if (image_classes_ == nullptr) {
1993 return false;
1994 }
1995 } else if (IsBootImage()) {
1996 image_classes_.reset(new std::unordered_set<std::string>);
1997 }
1998 return true;
1999 }
2000
2001 bool PrepareCompiledClasses() {
2002 // If --compiled-classes was specified, calculate the full list of classes to compile in the
2003 // image.
2004 if (compiled_classes_filename_ != nullptr) {
2005 compiled_classes_ =
2006 ReadClasses(compiled_classes_zip_filename_, compiled_classes_filename_, "compiled");
2007 if (compiled_classes_ == nullptr) {
2008 return false;
2009 }
2010 } else {
2011 compiled_classes_.reset(nullptr); // By default compile everything.
2012 }
2013 return true;
2014 }
2015
2016 static std::unique_ptr<std::unordered_set<std::string>> ReadClasses(const char* zip_filename,
2017 const char* classes_filename,
2018 const char* tag) {
2019 std::unique_ptr<std::unordered_set<std::string>> classes;
2020 std::string error_msg;
2021 if (zip_filename != nullptr) {
2022 classes.reset(ReadImageClassesFromZip(zip_filename, classes_filename, &error_msg));
2023 } else {
2024 classes.reset(ReadImageClassesFromFile(classes_filename));
2025 }
2026 if (classes == nullptr) {
2027 LOG(ERROR) << "Failed to create list of " << tag << " classes from '"
2028 << classes_filename << "': " << error_msg;
2029 }
2030 return classes;
2031 }
2032
2033 bool PrepareCompiledMethods() {
2034 // If --compiled-methods was specified, read the methods to compile from the given file(s).
2035 if (compiled_methods_filename_ != nullptr) {
2036 std::string error_msg;
2037 if (compiled_methods_zip_filename_ != nullptr) {
2038 compiled_methods_.reset(ReadCommentedInputFromZip(compiled_methods_zip_filename_,
2039 compiled_methods_filename_,
2040 nullptr, // No post-processing.
2041 &error_msg));
2042 } else {
2043 compiled_methods_.reset(ReadCommentedInputFromFile(compiled_methods_filename_,
2044 nullptr)); // No post-processing.
2045 }
2046 if (compiled_methods_.get() == nullptr) {
2047 LOG(ERROR) << "Failed to create list of compiled methods from '"
2048 << compiled_methods_filename_ << "': " << error_msg;
2049 return false;
2050 }
2051 } else {
2052 compiled_methods_.reset(nullptr); // By default compile everything.
2053 }
2054 return true;
2055 }
2056
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002057 void PruneNonExistentDexFiles() {
2058 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2059 size_t kept = 0u;
2060 for (size_t i = 0, size = dex_filenames_.size(); i != size; ++i) {
2061 if (!OS::FileExists(dex_filenames_[i])) {
2062 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filenames_[i] << "'";
2063 } else {
2064 dex_filenames_[kept] = dex_filenames_[i];
2065 dex_locations_[kept] = dex_locations_[i];
2066 ++kept;
2067 }
2068 }
2069 dex_filenames_.resize(kept);
2070 dex_locations_.resize(kept);
2071 }
2072
2073 bool AddDexFileSources() {
2074 TimingLogger::ScopedTiming t2("AddDexFileSources", timings_);
2075 if (zip_fd_ != -1) {
2076 DCHECK_EQ(oat_writers_.size(), 1u);
2077 if (!oat_writers_[0]->AddZippedDexFilesSource(ScopedFd(zip_fd_), zip_location_.c_str())) {
2078 return false;
2079 }
2080 } else if (oat_writers_.size() > 1u) {
2081 // Multi-image.
2082 DCHECK_EQ(oat_writers_.size(), dex_filenames_.size());
2083 DCHECK_EQ(oat_writers_.size(), dex_locations_.size());
2084 for (size_t i = 0, size = oat_writers_.size(); i != size; ++i) {
2085 if (!oat_writers_[i]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2086 return false;
2087 }
2088 }
2089 } else {
2090 DCHECK_EQ(oat_writers_.size(), 1u);
2091 DCHECK_EQ(dex_filenames_.size(), dex_locations_.size());
2092 DCHECK_NE(dex_filenames_.size(), 0u);
2093 for (size_t i = 0; i != dex_filenames_.size(); ++i) {
2094 if (!oat_writers_[0]->AddDexFileSource(dex_filenames_[i], dex_locations_[i])) {
2095 return false;
2096 }
2097 }
2098 }
2099 return true;
2100 }
2101
2102 void CreateOatWriters() {
2103 TimingLogger::ScopedTiming t2("CreateOatWriters", timings_);
2104 elf_writers_.reserve(oat_files_.size());
2105 oat_writers_.reserve(oat_files_.size());
2106 for (const std::unique_ptr<File>& oat_file : oat_files_) {
David Srbecky5d811202016-03-08 13:21:22 +00002107 elf_writers_.emplace_back(CreateElfWriterQuick(instruction_set_,
2108 instruction_set_features_.get(),
2109 compiler_options_.get(),
2110 oat_file.get()));
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002111 elf_writers_.back()->Start();
2112 oat_writers_.emplace_back(new OatWriter(IsBootImage(), timings_));
2113 }
2114 }
2115
Vladimir Marko49b0f452015-12-10 13:49:19 +00002116 void SaveDexInput() {
2117 for (size_t i = 0; i < dex_files_.size(); ++i) {
2118 const DexFile* dex_file = dex_files_[i];
2119 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
2120 getpid(), i));
2121 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
2122 if (tmp_file.get() == nullptr) {
2123 PLOG(ERROR) << "Failed to open file " << tmp_file_name
2124 << ". Try: adb shell chmod 777 /data/local/tmp";
2125 continue;
2126 }
2127 // This is just dumping files for debugging. Ignore errors, and leave remnants.
2128 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
2129 UNUSED(tmp_file->Flush());
2130 UNUSED(tmp_file->Close());
2131 LOG(INFO) << "Wrote input to " << tmp_file_name;
2132 }
2133 }
2134
2135 bool PrepareRuntimeOptions(RuntimeArgumentMap* runtime_options) {
2136 RuntimeOptions raw_options;
2137 if (boot_image_filename_.empty()) {
2138 std::string boot_class_path = "-Xbootclasspath:";
2139 boot_class_path += Join(dex_filenames_, ':');
2140 raw_options.push_back(std::make_pair(boot_class_path, nullptr));
2141 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
2142 boot_class_path_locations += Join(dex_locations_, ':');
2143 raw_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
2144 } else {
2145 std::string boot_image_option = "-Ximage:";
2146 boot_image_option += boot_image_filename_;
2147 raw_options.push_back(std::make_pair(boot_image_option, nullptr));
2148 }
2149 for (size_t i = 0; i < runtime_args_.size(); i++) {
2150 raw_options.push_back(std::make_pair(runtime_args_[i], nullptr));
2151 }
2152
2153 raw_options.push_back(std::make_pair("compilercallbacks", callbacks_.get()));
2154 raw_options.push_back(
2155 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
2156
2157 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
2158 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
2159 // have been stripped in preopting, anyways).
2160 if (!IsBootImage()) {
2161 raw_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
2162 }
2163 // Disable libsigchain. We don't don't need it during compilation and it prevents us
2164 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
2165 raw_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Lin Zang97f3f7d2016-01-13 10:25:00 +08002166 // Disable Hspace compaction to save heap size virtual space.
2167 // Only need disable Hspace for OOM becasue background collector is equal to
2168 // foreground collector by default for dex2oat.
2169 raw_options.push_back(std::make_pair("-XX:DisableHSpaceCompactForOOM", nullptr));
Vladimir Marko49b0f452015-12-10 13:49:19 +00002170
Andreas Gampeace0dc12016-01-20 13:33:13 -08002171 // If we're asked to be deterministic, ensure non-concurrent GC for determinism. Also
2172 // force the free-list implementation for large objects.
2173 if (compiler_options_->IsForceDeterminism()) {
2174 raw_options.push_back(std::make_pair("-Xgc:nonconcurrent", nullptr));
2175 raw_options.push_back(std::make_pair("-XX:LargeObjectSpace=freelist", nullptr));
2176
2177 // We also need to turn off the nonmoving space. For that, we need to disable HSpace
2178 // compaction (done above) and ensure that neither foreground nor background collectors
2179 // are concurrent.
2180 raw_options.push_back(std::make_pair("-XX:BackgroundGC=nonconcurrent", nullptr));
2181
2182 // To make identity hashcode deterministic, set a known seed.
2183 mirror::Object::SetHashCodeSeed(987654321U);
2184 }
2185
Vladimir Marko49b0f452015-12-10 13:49:19 +00002186 if (!Runtime::ParseOptions(raw_options, false, runtime_options)) {
2187 LOG(ERROR) << "Failed to parse runtime options";
2188 return false;
2189 }
2190 return true;
2191 }
2192
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002193 // Create a runtime necessary for compilation.
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002194 bool CreateRuntime(RuntimeArgumentMap&& runtime_options) {
2195 TimingLogger::ScopedTiming t_runtime("Create runtime", timings_);
Vladimir Marko49b0f452015-12-10 13:49:19 +00002196 if (!Runtime::Create(std::move(runtime_options))) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002197 LOG(ERROR) << "Failed to create runtime";
2198 return false;
2199 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002200 runtime_.reset(Runtime::Current());
2201 runtime_->SetInstructionSet(instruction_set_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002202 for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) {
2203 Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i);
Vladimir Marko307dac92015-10-20 11:20:09 +01002204 if (!runtime_->HasCalleeSaveMethod(type)) {
2205 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002206 }
2207 }
Vladimir Marko307dac92015-10-20 11:20:09 +01002208 runtime_->GetClassLinker()->FixupDexCaches(runtime_->GetResolutionMethod());
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002209
2210 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
2211 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07002212 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002213
Vladimir Marko307dac92015-10-20 11:20:09 +01002214 runtime_->GetClassLinker()->RunRootClinits();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07002215
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002216 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
2217 // Runtime::Start, give it away now so that we don't starve GC.
2218 Thread* self = Thread::Current();
2219 self->TransitionFromRunnableToSuspended(kNative);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002220
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002221 return true;
Vladimir Marko919f5532016-01-20 19:13:01 +00002222 }
2223
Jeff Haodcdc85b2015-12-04 14:06:18 -08002224 // 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 -08002225 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07002226 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002227 CHECK(image_writer_ != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002228 if (!IsBootImage()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002229 CHECK(image_filenames_.empty());
Jeff Haodcdc85b2015-12-04 14:06:18 -08002230 image_filenames_.push_back(app_image_file_name_.c_str());
2231 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002232 if (!image_writer_->Write(app_image_fd_,
2233 image_filenames_,
Vladimir Marko944da602016-02-19 12:27:55 +00002234 oat_filenames_)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002235 LOG(ERROR) << "Failure during image file creation";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002236 return false;
2237 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002238
Jeff Haodcdc85b2015-12-04 14:06:18 -08002239 // We need the OatDataBegin entries.
Vladimir Marko944da602016-02-19 12:27:55 +00002240 dchecked_vector<uintptr_t> oat_data_begins;
2241 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2242 oat_data_begins.push_back(image_writer_->GetOatDataBegin(i));
Jeff Haodcdc85b2015-12-04 14:06:18 -08002243 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002244 // Destroy ImageWriter before doing FixupElf.
2245 image_writer_.reset();
2246
Vladimir Marko944da602016-02-19 12:27:55 +00002247 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
2248 const char* oat_filename = oat_filenames_[i];
Jeff Haodcdc85b2015-12-04 14:06:18 -08002249 // Do not fix up the ELF file if we are --compile-pic or compiling the app image
2250 if (!compiler_options_->GetCompilePic() && IsBootImage()) {
2251 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
2252 if (oat_file.get() == nullptr) {
2253 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
2254 return false;
2255 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002256
Vladimir Marko944da602016-02-19 12:27:55 +00002257 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begins[i])) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002258 oat_file->Erase();
2259 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
2260 return false;
2261 }
2262
2263 if (oat_file->FlushCloseOrErase()) {
2264 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
2265 return false;
2266 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08002267 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002268 }
2269
2270 return true;
2271 }
2272
2273 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002274 static std::unordered_set<std::string>* ReadImageClassesFromFile(
2275 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002276 std::function<std::string(const char*)> process = DotToDescriptor;
2277 return ReadCommentedInputFromFile(image_classes_filename, &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002278 }
2279
2280 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002281 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002282 const char* zip_filename,
2283 const char* image_classes_filename,
2284 std::string* error_msg) {
2285 std::function<std::string(const char*)> process = DotToDescriptor;
2286 return ReadCommentedInputFromZip(zip_filename, image_classes_filename, &process, error_msg);
2287 }
2288
2289 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
2290 // the given function.
2291 static std::unordered_set<std::string>* ReadCommentedInputFromFile(
2292 const char* input_filename, std::function<std::string(const char*)>* process) {
2293 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
2294 if (input_file.get() == nullptr) {
2295 LOG(ERROR) << "Failed to open input file " << input_filename;
2296 return nullptr;
2297 }
2298 std::unique_ptr<std::unordered_set<std::string>> result(
2299 ReadCommentedInputStream(*input_file, process));
2300 input_file->close();
2301 return result.release();
2302 }
2303
2304 // Read lines from the given file from the given zip file, dropping comments and empty lines.
2305 // Post-process each line with the given function.
2306 static std::unordered_set<std::string>* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002307 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002308 const char* input_filename,
2309 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002310 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002311 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
2312 if (zip_archive.get() == nullptr) {
2313 return nullptr;
2314 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002315 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002316 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002317 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002318 zip_filename, error_msg->c_str());
2319 return nullptr;
2320 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002321 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
2322 input_filename,
2323 error_msg));
2324 if (input_file.get() == nullptr) {
2325 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002326 zip_filename, error_msg->c_str());
2327 return nullptr;
2328 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002329 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
2330 input_file->Size());
2331 std::istringstream input_stream(input_string);
2332 return ReadCommentedInputStream(input_stream, process);
2333 }
2334
2335 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
2336 // with the given function.
2337 static std::unordered_set<std::string>* ReadCommentedInputStream(
2338 std::istream& in_stream,
2339 std::function<std::string(const char*)>* process) {
2340 std::unique_ptr<std::unordered_set<std::string>> image_classes(
2341 new std::unordered_set<std::string>);
2342 while (in_stream.good()) {
2343 std::string dot;
2344 std::getline(in_stream, dot);
2345 if (StartsWith(dot, "#") || dot.empty()) {
2346 continue;
2347 }
2348 if (process != nullptr) {
2349 std::string descriptor((*process)(dot.c_str()));
2350 image_classes->insert(descriptor);
2351 } else {
2352 image_classes->insert(dot);
2353 }
2354 }
2355 return image_classes.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002356 }
2357
Mathieu Chartier49285c52014-12-02 15:43:48 -08002358 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08002359 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
2360 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08002361 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002362 LOG(INFO) << "dex2oat took " << PrettyDuration(NanoTime() - start_ns_)
Mathieu Chartierab972ef2014-12-03 17:38:22 -08002363 << " (threads: " << thread_count_ << ") "
Andreas Gampe3f30e122015-09-17 14:03:21 -07002364 << ((Runtime::Current() != nullptr && driver_ != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08002365 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
2366 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002367 }
2368
Jeff Haodcdc85b2015-12-04 14:06:18 -08002369 std::string StripIsaFrom(const char* image_filename, InstructionSet isa) {
2370 std::string res(image_filename);
2371 size_t last_slash = res.rfind('/');
2372 if (last_slash == std::string::npos || last_slash == 0) {
2373 return res;
2374 }
2375 size_t penultimate_slash = res.rfind('/', last_slash - 1);
2376 if (penultimate_slash == std::string::npos) {
2377 return res;
2378 }
2379 // Check that the string in-between is the expected one.
2380 if (res.substr(penultimate_slash + 1, last_slash - penultimate_slash - 1) !=
2381 GetInstructionSetString(isa)) {
2382 LOG(WARNING) << "Unexpected string when trying to strip isa: " << res;
2383 return res;
2384 }
2385 return res.substr(0, penultimate_slash) + res.substr(last_slash);
2386 }
2387
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002388 std::unique_ptr<CompilerOptions> compiler_options_;
2389 Compiler::Kind compiler_kind_;
2390
2391 InstructionSet instruction_set_;
2392 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
2393
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002394 uint32_t image_file_location_oat_checksum_;
2395 uintptr_t image_file_location_oat_data_begin_;
2396 int32_t image_patch_delta_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002397 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
2398
Vladimir Marko307dac92015-10-20 11:20:09 +01002399 std::unique_ptr<VerificationResults> verification_results_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002400
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002401 DexFileToMethodInlinerMap method_inliner_map_;
2402 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
2403
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002404 std::unique_ptr<Runtime> runtime_;
2405
Richard Uhlerfbef44d2014-12-23 09:48:51 -08002406 // Ownership for the class path files.
2407 std::vector<std::unique_ptr<const DexFile>> class_path_files_;
2408
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002409 size_t thread_count_;
2410 uint64_t start_ns_;
2411 std::unique_ptr<WatchDog> watchdog_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002412 std::vector<std::unique_ptr<File>> oat_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002413 std::string oat_location_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002414 std::vector<const char*> oat_filenames_;
2415 std::vector<const char*> oat_unstripped_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002416 int oat_fd_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002417 std::vector<const char*> dex_filenames_;
2418 std::vector<const char*> dex_locations_;
2419 int zip_fd_;
2420 std::string zip_location_;
Vladimir Marko49b0f452015-12-10 13:49:19 +00002421 std::string boot_image_filename_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002422 std::vector<const char*> runtime_args_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002423 std::vector<const char*> image_filenames_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002424 uintptr_t image_base_;
2425 const char* image_classes_zip_filename_;
2426 const char* image_classes_filename_;
Mathieu Chartierceb07b32015-12-10 09:33:21 -08002427 ImageHeader::StorageMode image_storage_mode_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08002428 const char* compiled_classes_zip_filename_;
2429 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002430 const char* compiled_methods_zip_filename_;
2431 const char* compiled_methods_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07002432 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
2433 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07002434 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002435 bool app_image_;
2436 bool boot_image_;
Jeff Hao436183f2016-01-12 16:36:50 -08002437 bool multi_image_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002438 bool is_host_;
2439 std::string android_root_;
2440 std::vector<const DexFile*> dex_files_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002441 std::string no_inline_from_string_;
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002442 std::vector<jobject> dex_caches_;
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002443 jobject class_loader_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002444
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002445 std::vector<std::unique_ptr<ElfWriter>> elf_writers_;
2446 std::vector<std::unique_ptr<OatWriter>> oat_writers_;
2447 std::vector<OutputStream*> rodata_;
Vladimir Marko307dac92015-10-20 11:20:09 +01002448 std::unique_ptr<ImageWriter> image_writer_;
2449 std::unique_ptr<CompilerDriver> driver_;
Andreas Gampe3f30e122015-09-17 14:03:21 -07002450
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002451 std::vector<std::unique_ptr<MemMap>> opened_dex_files_maps_;
2452 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
2453
Vladimir Marko47496c22016-01-27 16:15:08 +00002454 std::vector<const DexFile*> no_inline_from_dex_files_;
2455
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002456 std::vector<std::string> verbose_methods_;
2457 bool dump_stats_;
2458 bool dump_passes_;
2459 bool dump_timing_;
2460 bool dump_slow_timing_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08002461 std::string swap_file_name_;
2462 int swap_fd_;
Mathieu Chartiera90c7722015-10-29 15:41:36 -07002463 std::string app_image_file_name_;
2464 int app_image_fd_;
Calin Juravle2e2db782016-02-23 12:00:03 +00002465 std::string profile_file_;
2466 int profile_file_fd_;
Calin Juravle998c2162015-12-21 15:39:33 +02002467 std::unique_ptr<ProfileCompilationInfo> profile_compilation_info_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002468 TimingLogger* timings_;
2469 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002470 std::vector<std::vector<const DexFile*>> dex_files_per_oat_file_;
Vladimir Marko944da602016-02-19 12:27:55 +00002471 std::unordered_map<const DexFile*, size_t> dex_file_oat_index_map_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002472
2473 // Backing storage.
2474 std::vector<std::string> char_backing_storage_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002475
Andreas Gampeace0dc12016-01-20 13:33:13 -08002476 // See CompilerOptions.force_determinism_.
2477 bool force_determinism_;
2478
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002479 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
2480};
2481
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002482static void b13564922() {
2483#if defined(__linux__) && defined(__arm__)
2484 int major, minor;
2485 struct utsname uts;
2486 if (uname(&uts) != -1 &&
2487 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
2488 ((major < 3) || ((major == 3) && (minor < 4)))) {
2489 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
2490 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
2491 int old_personality = personality(0xffffffff);
2492 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
2493 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
2494 if (new_personality == -1) {
2495 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
2496 }
2497 }
2498 }
2499#endif
2500}
2501
Andreas Gampe10e477d2014-11-19 12:57:42 -08002502static int CompileImage(Dex2Oat& dex2oat) {
Mathieu Chartierc5dd3192015-12-09 16:38:30 -08002503 dex2oat.LoadClassProfileDescriptors();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002504 dex2oat.Compile();
2505
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002506 if (!dex2oat.WriteOatFiles()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002507 dex2oat.EraseOatFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002508 return EXIT_FAILURE;
2509 }
2510
Mathieu Chartierfbc31082016-01-24 11:59:56 -08002511 // Flush boot.oat. We always expect the output file by name, and it will be re-opened from the
2512 // unstripped name. Do not close the file if we are compiling the image with an oat fd since the
2513 // image writer will require this fd to generate the image.
2514 if (dex2oat.ShouldKeepOatFileOpen()) {
2515 if (!dex2oat.FlushOatFiles()) {
2516 return EXIT_FAILURE;
2517 }
2518 } else if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002519 return EXIT_FAILURE;
2520 }
2521
Jeff Haodcdc85b2015-12-04 14:06:18 -08002522 // Creates the boot.art and patches the oat files.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002523 if (!dex2oat.HandleImage()) {
2524 return EXIT_FAILURE;
2525 }
2526
2527 // When given --host, finish early without stripping.
2528 if (dex2oat.IsHost()) {
2529 dex2oat.DumpTiming();
2530 return EXIT_SUCCESS;
2531 }
2532
Jeff Haodcdc85b2015-12-04 14:06:18 -08002533 // Copy stripped to unstripped location, if necessary.
2534 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002535 return EXIT_FAILURE;
2536 }
2537
Jeff Haodcdc85b2015-12-04 14:06:18 -08002538 // FlushClose again, as stripping might have re-opened the oat files.
2539 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002540 return EXIT_FAILURE;
2541 }
2542
2543 dex2oat.DumpTiming();
2544 return EXIT_SUCCESS;
2545}
2546
2547static int CompileApp(Dex2Oat& dex2oat) {
2548 dex2oat.Compile();
2549
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002550 if (!dex2oat.WriteOatFiles()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002551 dex2oat.EraseOatFiles();
Andreas Gampe10e477d2014-11-19 12:57:42 -08002552 return EXIT_FAILURE;
2553 }
2554
Jeff Haodcdc85b2015-12-04 14:06:18 -08002555 // Do not close the oat files here. We might have gotten the output file by file descriptor,
Andreas Gampe10e477d2014-11-19 12:57:42 -08002556 // which we would lose.
Andreas Gampe10e477d2014-11-19 12:57:42 -08002557
2558 // When given --host, finish early without stripping.
2559 if (dex2oat.IsHost()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002560 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002561 return EXIT_FAILURE;
2562 }
2563
2564 dex2oat.DumpTiming();
2565 return EXIT_SUCCESS;
2566 }
2567
Jeff Haodcdc85b2015-12-04 14:06:18 -08002568 // Copy stripped to unstripped location, if necessary. This will implicitly flush & close the
2569 // stripped versions. If this is given, we expect to be able to open writable files by name.
2570 if (!dex2oat.CopyStrippedToUnstripped()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002571 return EXIT_FAILURE;
2572 }
2573
Jeff Haodcdc85b2015-12-04 14:06:18 -08002574 // Flush and close the files.
2575 if (!dex2oat.FlushCloseOatFiles()) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08002576 return EXIT_FAILURE;
2577 }
2578
2579 dex2oat.DumpTiming();
2580 return EXIT_SUCCESS;
2581}
2582
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002583static int dex2oat(int argc, char** argv) {
2584 b13564922();
2585
2586 TimingLogger timings("compiler", false, false);
2587
Roland Levillain5c7e2602016-02-23 18:08:53 +00002588 // Allocate `dex2oat` on the heap instead of on the stack, as Clang
2589 // might produce a stack frame too large for this function or for
2590 // functions inlining it (such as main), that would not fit the
2591 // requirements of the `-Wframe-larger-than` option.
2592 std::unique_ptr<Dex2Oat> dex2oat = MakeUnique<Dex2Oat>(&timings);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002593
2594 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002595 dex2oat->ParseArgs(argc, argv);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002596
Calin Juravleb077e152016-02-18 18:47:37 +00002597 // If needed, process profile information for profile guided compilation.
Calin Juravle998c2162015-12-21 15:39:33 +02002598 // This operation involves I/O.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002599 if (dex2oat->UseProfileGuidedCompilation()) {
Calin Juravleb077e152016-02-18 18:47:37 +00002600 if (!dex2oat->LoadProfile()) {
2601 LOG(ERROR) << "Failed to process profile file";
Calin Juravle998c2162015-12-21 15:39:33 +02002602 return EXIT_FAILURE;
2603 }
2604 }
2605
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002606 // Check early that the result of compilation can be written
Roland Levillain5c7e2602016-02-23 18:08:53 +00002607 if (!dex2oat->OpenFile()) {
Vladimir Marko9bdf1082016-01-21 12:15:52 +00002608 return EXIT_FAILURE;
2609 }
2610
Andreas Gampe046c7062015-05-18 23:22:54 -07002611 // Print the complete line when any of the following is true:
2612 // 1) Debug build
2613 // 2) Compiling an image
2614 // 3) Compiling with --host
2615 // 4) Compiling on the host (not a target build)
2616 // Otherwise, print a stripped command line.
Roland Levillain5c7e2602016-02-23 18:08:53 +00002617 if (kIsDebugBuild || dex2oat->IsBootImage() || dex2oat->IsHost() || !kIsTargetBuild) {
Andreas Gampe046c7062015-05-18 23:22:54 -07002618 LOG(INFO) << CommandLine();
2619 } else {
2620 LOG(INFO) << StrippedCommandLine();
2621 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002622
Roland Levillain5c7e2602016-02-23 18:08:53 +00002623 if (!dex2oat->Setup()) {
2624 dex2oat->EraseOatFiles();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002625 return EXIT_FAILURE;
2626 }
2627
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002628 bool result;
Roland Levillain5c7e2602016-02-23 18:08:53 +00002629 if (dex2oat->IsImage()) {
2630 result = CompileImage(*dex2oat);
Andreas Gampe10e477d2014-11-19 12:57:42 -08002631 } else {
Roland Levillain5c7e2602016-02-23 18:08:53 +00002632 result = CompileApp(*dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002633 }
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002634
Roland Levillain5c7e2602016-02-23 18:08:53 +00002635 dex2oat->Shutdown();
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002636 return result;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002637}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002638} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07002639
2640int main(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002641 int result = art::dex2oat(argc, argv);
2642 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
2643 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
2644 // should not destruct the runtime in this case.
Evgenii Stepanov1e133742015-05-20 12:30:59 -07002645 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002646 exit(result);
2647 }
2648 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002649}