blob: 976c00281211de1551b95dc625dd66fc1f828a9e [file] [log] [blame]
Brian Carlstrom7940e442013-07-12 13:46:57 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Andreas Gamped687e372015-04-28 23:16:03 -070017#include <inttypes.h>
Brian Carlstrom7940e442013-07-12 13:46:57 -070018#include <stdio.h>
19#include <stdlib.h>
20#include <sys/stat.h>
Evgenii Stepanov1e133742015-05-20 12:30:59 -070021#include "base/memory_tool.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070022
23#include <fstream>
24#include <iostream>
25#include <sstream>
26#include <string>
Andreas Gampeb1fcead2015-04-20 18:53:51 -070027#include <unordered_set>
Brian Carlstrom7940e442013-07-12 13:46:57 -070028#include <vector>
29
Vladimir Markof94b7812014-06-05 15:48:04 +010030#if defined(__linux__) && defined(__arm__)
31#include <sys/personality.h>
32#include <sys/utsname.h>
33#endif
34
Ian Rogerscf7f1912014-10-22 22:06:39 -070035#define ATRACE_TAG ATRACE_TAG_DALVIK
Ian Rogersd582fa42014-11-05 23:46:43 -080036#include <cutils/trace.h>
Ian Rogerscf7f1912014-10-22 22:06:39 -070037
Mathieu Chartiere401d142015-04-22 13:56:20 -070038#include "art_method-inl.h"
Ian Rogersd582fa42014-11-05 23:46:43 -080039#include "arch/instruction_set_features.h"
Andreas Gampec5a3ea72015-01-13 16:41:53 -080040#include "arch/mips/instruction_set_features_mips.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070041#include "base/dumpable.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080042#include "base/macros.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070043#include "base/stl_util.h"
44#include "base/stringpiece.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010045#include "base/time_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070046#include "base/timing_logger.h"
47#include "base/unix_file/fd_file.h"
48#include "class_linker.h"
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000049#include "compiler.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000050#include "compiler_callbacks.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070051#include "dex_file-inl.h"
Mathieu Chartier5bdab122015-01-26 18:30:19 -080052#include "dex/pass_manager.h"
Vladimir Markoc7f83202014-01-24 17:55:18 +000053#include "dex/verification_results.h"
Ian Rogerse63db272014-07-15 15:36:11 -070054#include "dex/quick_compiler_callbacks.h"
55#include "dex/quick/dex_file_to_method_inliner_map.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070056#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080057#include "driver/compiler_options.h"
Andreas Gampe88ec7f42014-11-05 10:18:32 -080058#include "elf_file.h"
Tong Shen62d1ca32014-09-03 17:24:56 -070059#include "elf_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070060#include "gc/space/image_space.h"
61#include "gc/space/space-inl.h"
62#include "image_writer.h"
Andreas Gampe2969bcd2015-03-09 12:57:41 -070063#include "interpreter/unstarted_runtime.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070064#include "leb128.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070065#include "mirror/class-inl.h"
66#include "mirror/class_loader.h"
67#include "mirror/object-inl.h"
68#include "mirror/object_array-inl.h"
69#include "oat_writer.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070070#include "os.h"
71#include "runtime.h"
72#include "ScopedLocalRef.h"
73#include "scoped_thread_state_change.h"
Alex Light53cb16b2014-06-12 11:26:29 -070074#include "utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070075#include "vector_output_stream.h"
76#include "well_known_classes.h"
77#include "zip_archive.h"
78
79namespace art {
80
Brian Carlstrom6449c622014-02-10 23:48:36 -080081static int original_argc;
82static char** original_argv;
83
84static std::string CommandLine() {
85 std::vector<std::string> command;
86 for (int i = 0; i < original_argc; ++i) {
87 command.push_back(original_argv[i]);
88 }
89 return Join(command, ' ');
90}
91
Andreas Gampe046c7062015-05-18 23:22:54 -070092// A stripped version. Remove some less essential parameters. If we see a "--zip-fd=" parameter, be
93// even more aggressive. There won't be much reasonable data here for us in that case anyways (the
94// locations are all staged).
95static std::string StrippedCommandLine() {
96 std::vector<std::string> command;
97
98 // Do a pre-pass to look for zip-fd.
99 bool saw_zip_fd = false;
100 for (int i = 0; i < original_argc; ++i) {
101 if (StartsWith(original_argv[i], "--zip-fd=")) {
102 saw_zip_fd = true;
103 break;
104 }
105 }
106
107 // Now filter out things.
108 for (int i = 0; i < original_argc; ++i) {
109 // All runtime-arg parameters are dropped.
110 if (strcmp(original_argv[i], "--runtime-arg") == 0) {
111 i++; // Drop the next part, too.
112 continue;
113 }
114
115 // Any instruction-setXXX is dropped.
116 if (StartsWith(original_argv[i], "--instruction-set")) {
117 continue;
118 }
119
120 // The boot image is dropped.
121 if (StartsWith(original_argv[i], "--boot-image=")) {
122 continue;
123 }
124
125 // This should leave any dex-file and oat-file options, describing what we compiled.
126
127 // However, we prefer to drop this when we saw --zip-fd.
128 if (saw_zip_fd) {
129 // Drop anything --zip-X, --dex-X, --oat-X, --swap-X.
130 if (StartsWith(original_argv[i], "--zip-") ||
131 StartsWith(original_argv[i], "--dex-") ||
132 StartsWith(original_argv[i], "--oat-") ||
133 StartsWith(original_argv[i], "--swap-")) {
134 continue;
135 }
136 }
137
138 command.push_back(original_argv[i]);
139 }
140
141 // Construct the final output.
142 if (command.size() <= 1U) {
143 // It seems only "/system/bin/dex2oat" is left, or not even that. Use a pretty line.
144 return "Starting dex2oat.";
145 }
146 return Join(command, ' ');
147}
148
Brian Carlstrom7940e442013-07-12 13:46:57 -0700149static void UsageErrorV(const char* fmt, va_list ap) {
150 std::string error;
151 StringAppendV(&error, fmt, ap);
152 LOG(ERROR) << error;
153}
154
155static void UsageError(const char* fmt, ...) {
156 va_list ap;
157 va_start(ap, fmt);
158 UsageErrorV(fmt, ap);
159 va_end(ap);
160}
161
Andreas Gampe794ad762015-02-23 08:12:24 -0800162NO_RETURN static void Usage(const char* fmt, ...) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700163 va_list ap;
164 va_start(ap, fmt);
165 UsageErrorV(fmt, ap);
166 va_end(ap);
167
Brian Carlstrom6449c622014-02-10 23:48:36 -0800168 UsageError("Command: %s", CommandLine().c_str());
169
Brian Carlstrom7940e442013-07-12 13:46:57 -0700170 UsageError("Usage: dex2oat [options]...");
171 UsageError("");
Jean-Philippe Halimi3d329d72015-03-23 14:09:48 +0100172 UsageError(" -j<number>: specifies the number of threads used for compilation.");
173 UsageError(" Default is the number of detected hardware threads available on the");
174 UsageError(" host system.");
175 UsageError(" Example: -j12");
176 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700177 UsageError(" --dex-file=<dex-file>: specifies a .dex, .jar, or .apk file to compile.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700178 UsageError(" Example: --dex-file=/system/framework/core.jar");
179 UsageError("");
Richard Uhlere934df22015-03-17 11:26:16 -0700180 UsageError(" --dex-location=<dex-location>: specifies an alternative dex location to");
181 UsageError(" encode in the oat file for the corresponding --dex-file argument.");
182 UsageError(" Example: --dex-file=/home/build/out/system/framework/core.jar");
183 UsageError(" --dex-location=/system/framework/core.jar");
184 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700185 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
186 UsageError(" containing a classes.dex file to compile.");
187 UsageError(" Example: --zip-fd=5");
188 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700189 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
190 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700191 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
192 UsageError("");
193 UsageError(" --oat-file=<file.oat>: specifies the oat output destination via a filename.");
194 UsageError(" Example: --oat-file=/system/framework/boot.oat");
195 UsageError("");
196 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
Wonil Kim9cb554a2014-04-28 11:26:55 +0900197 UsageError(" Example: --oat-fd=6");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700198 UsageError("");
199 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
200 UsageError(" to the file descriptor specified by --oat-fd.");
201 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
202 UsageError("");
203 UsageError(" --oat-symbols=<file.oat>: specifies the oat output destination with full symbols.");
204 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
205 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700206 UsageError(" --image=<file.art>: specifies the output image filename.");
207 UsageError(" Example: --image=/system/framework/boot.art");
208 UsageError("");
209 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
210 UsageError(" Example: --image=frameworks/base/preloaded-classes");
211 UsageError("");
212 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
213 UsageError(" Example: --base=0x50000000");
214 UsageError("");
215 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
216 UsageError(" Example: --boot-image=/system/framework/boot.art");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000217 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700218 UsageError("");
219 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
220 UsageError(" Example: --android-root=out/host/linux-x86");
221 UsageError(" Default: $ANDROID_ROOT");
222 UsageError("");
Andreas Gampe57b34292015-01-14 15:45:59 -0800223 UsageError(" --instruction-set=(arm|arm64|mips|mips64|x86|x86_64): compile for a particular");
Alex Light53cb16b2014-06-12 11:26:29 -0700224 UsageError(" instruction set.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700225 UsageError(" Example: --instruction-set=x86");
226 UsageError(" Default: arm");
227 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700228 UsageError(" --instruction-set-features=...,: Specify instruction set features");
229 UsageError(" Example: --instruction-set-features=div");
230 UsageError(" Default: default");
231 UsageError("");
Igor Murashkin46774762014-10-22 11:37:02 -0700232 UsageError(" --compile-pic: Force indirect use of code, methods, and classes");
233 UsageError(" Default: disabled");
234 UsageError("");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800235 UsageError(" --compiler-backend=(Quick|Optimizing): select compiler backend");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700236 UsageError(" set.");
Elliott Hughes956af0f2014-12-11 14:34:28 -0800237 UsageError(" Example: --compiler-backend=Optimizing");
238 if (kUseOptimizingCompiler) {
Nicolas Geoffray4586fb62014-11-28 16:22:11 +0000239 UsageError(" Default: Optimizing");
240 } else {
241 UsageError(" Default: Quick");
242 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700243 UsageError("");
Nicolas Geoffray88157ef2014-09-12 10:29:53 +0100244 UsageError(" --compiler-filter="
245 "(verify-none"
246 "|interpret-only"
247 "|space"
248 "|balanced"
249 "|speed"
250 "|everything"
251 "|time):");
Jeff Hao4a200f52014-04-01 14:58:49 -0700252 UsageError(" select compiler filter.");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800253 UsageError(" Example: --compiler-filter=everything");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800254 UsageError(" Default: speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800255 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800256 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
257 UsageError(" method for compiler filter tuning.");
258 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
259 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
260 UsageError("");
261 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
262 UsageError(" method for compiler filter tuning.");
263 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
264 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
265 UsageError("");
266 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
267 UsageError(" method for compiler filter tuning.");
268 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
269 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
270 UsageError("");
271 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
272 UsageError(" method for compiler filter tuning.");
273 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
274 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
275 UsageError("");
276 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
277 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
Jeff Hao4a200f52014-04-01 14:58:49 -0700278 UsageError(" and the filter is not interpret-only or verify-none, overrides the");
279 UsageError(" filter to use speed");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800280 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
281 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
282 UsageError("");
Calin Juravleec748352015-07-29 13:52:12 +0100283 UsageError(" --inline-depth-limit=<depth-limit>: the depth limit of inlining for fine tuning");
284 UsageError(" the compiler. A zero value will disable inlining. Honored only by Optimizing.");
Roland Levillaina215b952015-08-07 11:38:32 +0100285 UsageError(" Has priority over the --compiler-filter option. Intended for ");
286 UsageError(" development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100287 UsageError(" Example: --inline-depth-limit=%d", CompilerOptions::kDefaultInlineDepthLimit);
288 UsageError(" Default: %d", CompilerOptions::kDefaultInlineDepthLimit);
289 UsageError("");
290 UsageError(" --inline-max-code-units=<code-units-count>: the maximum code units that a method");
291 UsageError(" can have to be considered for inlining. A zero value will disable inlining.");
Roland Levillaina215b952015-08-07 11:38:32 +0100292 UsageError(" Honored only by Optimizing. Has priority over the --compiler-filter option.");
293 UsageError(" Intended for development/experimental use.");
Calin Juravleec748352015-07-29 13:52:12 +0100294 UsageError(" Example: --inline-max-code-units=%d",
295 CompilerOptions::kDefaultInlineMaxCodeUnits);
296 UsageError(" Default: %d", CompilerOptions::kDefaultInlineMaxCodeUnits);
297 UsageError("");
Ian Rogers46398602013-08-20 07:50:36 -0700298 UsageError(" --dump-timing: display a breakdown of where time was spent");
299 UsageError("");
Alex Light53cb16b2014-06-12 11:26:29 -0700300 UsageError(" --include-patch-information: Include patching information so the generated code");
301 UsageError(" can have its base address moved without full recompilation.");
302 UsageError("");
303 UsageError(" --no-include-patch-information: Do not include patching information.");
304 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100305 UsageError(" -g");
306 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
307 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
308 UsageError(" This generates all the available information. Unneeded parts can be");
309 UsageError(" stripped using standard command line tools such as strip or objcopy.");
310 UsageError(" (enabled by default in debug builds, disabled by default otherwise)");
Alex Light78382fa2014-06-06 15:45:32 -0700311 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100312 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100313 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700314 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
315 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
316 UsageError(" Use a separate --runtime-arg switch for each argument.");
317 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700318 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000319 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700320 UsageError("");
Chao-ying Fucd8ce662014-03-11 14:57:19 -0700321 UsageError(" --print-pass-names: print a list of pass names");
322 UsageError("");
323 UsageError(" --disable-passes=<pass-names>: disable one or more passes separated by comma.");
324 UsageError(" Example: --disable-passes=UseCount,BBOptimizations");
325 UsageError("");
Razvan A Lupusorubd25d4b2014-07-02 18:16:51 -0700326 UsageError(" --print-pass-options: print a list of passes that have configurable options along "
327 "with the setting.");
328 UsageError(" Will print default if no overridden setting exists.");
329 UsageError("");
330 UsageError(" --pass-options=Pass1Name:Pass1OptionName:Pass1Option#,"
331 "Pass2Name:Pass2OptionName:Pass2Option#");
332 UsageError(" Used to specify a pass specific option. The setting itself must be integer.");
333 UsageError(" Separator used between options is a comma.");
334 UsageError("");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800335 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
336 UsageError(" Example: --swap-file=/data/tmp/swap.001");
337 UsageError("");
338 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
339 UsageError(" Example: --swap-fd=10");
340 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700341 std::cerr << "See log for usage error information\n";
342 exit(EXIT_FAILURE);
343}
344
Brian Carlstrom7940e442013-07-12 13:46:57 -0700345// The primary goal of the watchdog is to prevent stuck build servers
346// during development when fatal aborts lead to a cascade of failures
347// that result in a deadlock.
348class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800349// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700350#undef CHECK_PTHREAD_CALL
351#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
352 do { \
353 int rc = call args; \
354 if (rc != 0) { \
355 errno = rc; \
356 std::string message(# call); \
357 message += " failed for "; \
358 message += reason; \
359 Fatal(message); \
360 } \
361 } while (false)
362
363 public:
Brian Carlstrom93ba8932013-07-17 21:31:49 -0700364 explicit WatchDog(bool is_watch_dog_enabled) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700365 is_watch_dog_enabled_ = is_watch_dog_enabled;
366 if (!is_watch_dog_enabled_) {
367 return;
368 }
369 shutting_down_ = false;
370 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700371 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
372 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700373 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
374 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
375 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
376 }
377 ~WatchDog() {
378 if (!is_watch_dog_enabled_) {
379 return;
380 }
381 const char* reason = "dex2oat watch dog thread shutdown";
382 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
383 shutting_down_ = true;
384 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
385 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
386
Kenny Root51316382014-05-13 14:59:37 -0700387 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700388
389 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
390 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
391 }
392
393 private:
394 static void* CallBack(void* arg) {
395 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
396 ::art::SetThreadName("dex2oat watch dog");
397 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700398 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700399 }
400
Andreas Gampe794ad762015-02-23 08:12:24 -0800401 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700402 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
403 // it's rather easy to hang in unwinding.
404 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
405 // logcat logging or stderr output.
406 LogMessage::LogLine(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700407 exit(1);
408 }
409
410 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700411 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
412 // large.
Andreas Gamped687e372015-04-28 23:16:03 -0700413 constexpr int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700414 timespec timeout_ts;
415 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts);
416 const char* reason = "dex2oat watch dog thread waiting";
417 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
418 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800419 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700420 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700421 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
422 kWatchDogTimeoutSeconds));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700423 } else if (rc != 0) {
424 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
425 strerror(errno)));
426 Fatal(message.c_str());
427 }
428 }
429 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
430 }
431
432 // 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 -0700433 // Debug builds are slower so they have larger timeouts.
Andreas Gamped687e372015-04-28 23:16:03 -0700434 static constexpr int64_t kSlowdownFactor = kIsDebugBuild ? 5U : 1U;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800435
Andreas Gamped687e372015-04-28 23:16:03 -0700436 // 10 minutes scaled by kSlowdownFactor.
437 static constexpr int64_t kWatchDogTimeoutSeconds = kSlowdownFactor * 10 * 60;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700438
439 bool is_watch_dog_enabled_;
440 bool shutting_down_;
441 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
442 pthread_mutex_t mutex_;
443 pthread_cond_t cond_;
444 pthread_attr_t attr_;
445 pthread_t pthread_;
446};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700447
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800448static void ParseStringAfterChar(const std::string& s, char c, std::string* parsed_value) {
Calin Juravlec1b643c2014-05-30 23:44:11 +0100449 std::string::size_type colon = s.find(c);
450 if (colon == std::string::npos) {
451 Usage("Missing char %c in option %s\n", c, s.c_str());
452 }
453 // Add one to remove the char we were trimming until.
454 *parsed_value = s.substr(colon + 1);
455}
456
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800457static void ParseDouble(const std::string& option, char after_char, double min, double max,
458 double* parsed_value) {
Calin Juravlec1b643c2014-05-30 23:44:11 +0100459 std::string substring;
460 ParseStringAfterChar(option, after_char, &substring);
461 bool sane_val = true;
462 double value;
463 if (false) {
464 // TODO: this doesn't seem to work on the emulator. b/15114595
465 std::stringstream iss(substring);
466 iss >> value;
467 // Ensure that we have a value, there was no cruft after it and it satisfies a sensible range.
468 sane_val = iss.eof() && (value >= min) && (value <= max);
469 } else {
470 char* end = nullptr;
471 value = strtod(substring.c_str(), &end);
472 sane_val = *end == '\0' && value >= min && value <= max;
473 }
474 if (!sane_val) {
475 Usage("Invalid double value %s for option %s\n", substring.c_str(), option.c_str());
476 }
477 *parsed_value = value;
478}
479
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800480static constexpr size_t kMinDexFilesForSwap = 2;
481static constexpr size_t kMinDexFileCumulativeSizeForSwap = 20 * MB;
482
483static bool UseSwap(bool is_image, std::vector<const DexFile*>& dex_files) {
484 if (is_image) {
485 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
486 return false;
487 }
488 if (dex_files.size() < kMinDexFilesForSwap) {
489 // If there are less dex files than the threshold, assume it's gonna be fine.
490 return false;
491 }
492 size_t dex_files_size = 0;
493 for (const auto* dex_file : dex_files) {
494 dex_files_size += dex_file->GetHeader().file_size_;
495 }
496 return dex_files_size >= kMinDexFileCumulativeSizeForSwap;
497}
498
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800499class Dex2Oat FINAL {
500 public:
501 explicit Dex2Oat(TimingLogger* timings) :
Elliott Hughes956af0f2014-12-11 14:34:28 -0800502 compiler_kind_(kUseOptimizingCompiler ? Compiler::kOptimizing : Compiler::kQuick),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800503 instruction_set_(kRuntimeISA),
504 // Take the default set of instruction features from the build.
505 method_inliner_map_(),
506 runtime_(nullptr),
507 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
508 start_ns_(NanoTime()),
509 oat_fd_(-1),
510 zip_fd_(-1),
511 image_base_(0U),
512 image_classes_zip_filename_(nullptr),
513 image_classes_filename_(nullptr),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800514 compiled_classes_zip_filename_(nullptr),
515 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700516 compiled_methods_zip_filename_(nullptr),
517 compiled_methods_filename_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800518 image_(false),
519 is_host_(false),
520 dump_stats_(false),
521 dump_passes_(false),
522 dump_timing_(false),
523 dump_slow_timing_(kIsDebugBuild),
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800524 swap_fd_(-1),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800525 timings_(timings) {}
526
527 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800528 // Free opened dex files before deleting the runtime_, because ~DexFile
529 // uses MemMap, which is shut down by ~Runtime.
530 class_path_files_.clear();
531 opened_dex_files_.clear();
532
533 // Log completion time before deleting the runtime_, because this accesses
534 // the runtime.
535 LogCompletionTime();
536
Evgenii Stepanov1e133742015-05-20 12:30:59 -0700537 if (kIsDebugBuild || (RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800538 delete runtime_; // See field declaration for why this is manual.
Vladimir Markof94b7812014-06-05 15:48:04 +0100539 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700540 }
541
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800542 // Parse the arguments from the command line. In case of an unrecognized option or impossible
543 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
544 // returns, arguments have been successfully parsed.
545 void ParseArgs(int argc, char** argv) {
546 original_argc = argc;
547 original_argv = argv;
Dave Allison70202782013-10-22 17:52:19 -0700548
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800549 InitLogging(argv);
Dave Allison70202782013-10-22 17:52:19 -0700550
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800551 // Skip over argv[0].
552 argv++;
553 argc--;
Dave Allison70202782013-10-22 17:52:19 -0700554
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800555 if (argc == 0) {
556 Usage("No arguments specified");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700557 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800558
559 std::string oat_symbols;
560 std::string boot_image_filename;
561 const char* compiler_filter_string = nullptr;
562 bool compile_pic = false;
563 int huge_method_threshold = CompilerOptions::kDefaultHugeMethodThreshold;
564 int large_method_threshold = CompilerOptions::kDefaultLargeMethodThreshold;
565 int small_method_threshold = CompilerOptions::kDefaultSmallMethodThreshold;
566 int tiny_method_threshold = CompilerOptions::kDefaultTinyMethodThreshold;
567 int num_dex_methods_threshold = CompilerOptions::kDefaultNumDexMethodsThreshold;
Roland Levillaina215b952015-08-07 11:38:32 +0100568 static constexpr int kUnsetInlineDepthLimit = -1;
569 int inline_depth_limit = kUnsetInlineDepthLimit;
570 static constexpr int kUnsetInlineMaxCodeUnits = -1;
571 int inline_max_code_units = kUnsetInlineMaxCodeUnits;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800572
573 // Profile file to use
574 double top_k_profile_threshold = CompilerOptions::kDefaultTopKProfileThreshold;
575
Andreas Gampe7b2f09e2015-03-02 14:07:33 -0800576 bool debuggable = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800577 bool include_patch_information = CompilerOptions::kDefaultIncludePatchInformation;
David Srbecky8363c772015-05-28 16:12:43 +0100578 bool generate_debug_info = kIsDebugBuild;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800579 bool watch_dog_enabled = true;
Andreas Gampe6cf49e52015-03-05 13:08:45 -0800580 bool abort_on_hard_verifier_error = false;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000581 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800582
Mathieu Chartier5bdab122015-01-26 18:30:19 -0800583 PassManagerOptions pass_manager_options;
584
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800585 std::string error_msg;
586
587 for (int i = 0; i < argc; i++) {
588 const StringPiece option(argv[i]);
589 const bool log_options = false;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700590 if (log_options) {
591 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
592 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800593 if (option.starts_with("--dex-file=")) {
594 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data());
595 } else if (option.starts_with("--dex-location=")) {
596 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data());
597 } else if (option.starts_with("--zip-fd=")) {
598 const char* zip_fd_str = option.substr(strlen("--zip-fd=")).data();
599 if (!ParseInt(zip_fd_str, &zip_fd_)) {
600 Usage("Failed to parse --zip-fd argument '%s' as an integer", zip_fd_str);
601 }
602 if (zip_fd_ < 0) {
603 Usage("--zip-fd passed a negative value %d", zip_fd_);
604 }
605 } else if (option.starts_with("--zip-location=")) {
606 zip_location_ = option.substr(strlen("--zip-location=")).data();
607 } else if (option.starts_with("--oat-file=")) {
608 oat_filename_ = option.substr(strlen("--oat-file=")).data();
609 } else if (option.starts_with("--oat-symbols=")) {
610 oat_symbols = option.substr(strlen("--oat-symbols=")).data();
611 } else if (option.starts_with("--oat-fd=")) {
612 const char* oat_fd_str = option.substr(strlen("--oat-fd=")).data();
613 if (!ParseInt(oat_fd_str, &oat_fd_)) {
614 Usage("Failed to parse --oat-fd argument '%s' as an integer", oat_fd_str);
615 }
616 if (oat_fd_ < 0) {
617 Usage("--oat-fd passed a negative value %d", oat_fd_);
618 }
619 } else if (option == "--watch-dog") {
620 watch_dog_enabled = true;
621 } else if (option == "--no-watch-dog") {
622 watch_dog_enabled = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800623 } else if (option.starts_with("-j")) {
624 const char* thread_count_str = option.substr(strlen("-j")).data();
625 if (!ParseUint(thread_count_str, &thread_count_)) {
626 Usage("Failed to parse -j argument '%s' as an integer", thread_count_str);
627 }
628 } else if (option.starts_with("--oat-location=")) {
629 oat_location_ = option.substr(strlen("--oat-location=")).data();
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800630 } else if (option.starts_with("--image=")) {
631 image_filename_ = option.substr(strlen("--image=")).data();
632 } else if (option.starts_with("--image-classes=")) {
633 image_classes_filename_ = option.substr(strlen("--image-classes=")).data();
634 } else if (option.starts_with("--image-classes-zip=")) {
635 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data();
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800636 } else if (option.starts_with("--compiled-classes=")) {
637 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data();
638 } else if (option.starts_with("--compiled-classes-zip=")) {
639 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data();
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700640 } else if (option.starts_with("--compiled-methods=")) {
641 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data();
642 } else if (option.starts_with("--compiled-methods-zip=")) {
643 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data();
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800644 } else if (option.starts_with("--base=")) {
645 const char* image_base_str = option.substr(strlen("--base=")).data();
646 char* end;
647 image_base_ = strtoul(image_base_str, &end, 16);
648 if (end == image_base_str || *end != '\0') {
649 Usage("Failed to parse hexadecimal value for option %s", option.data());
650 }
651 } else if (option.starts_with("--boot-image=")) {
652 boot_image_filename = option.substr(strlen("--boot-image=")).data();
653 } else if (option.starts_with("--android-root=")) {
654 android_root_ = option.substr(strlen("--android-root=")).data();
655 } else if (option.starts_with("--instruction-set=")) {
656 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
657 // StringPiece is not necessarily zero-terminated, so need to make a copy and ensure it.
Dan Albert6fc59ab2014-12-11 14:09:51 -0800658 std::unique_ptr<char[]> buf(new char[instruction_set_str.length() + 1]);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800659 strncpy(buf.get(), instruction_set_str.data(), instruction_set_str.length());
660 buf.get()[instruction_set_str.length()] = 0;
661 instruction_set_ = GetInstructionSetFromString(buf.get());
662 // arm actually means thumb2.
663 if (instruction_set_ == InstructionSet::kArm) {
664 instruction_set_ = InstructionSet::kThumb2;
665 }
666 } else if (option.starts_with("--instruction-set-variant=")) {
667 StringPiece str = option.substr(strlen("--instruction-set-variant=")).data();
668 instruction_set_features_.reset(
669 InstructionSetFeatures::FromVariant(instruction_set_, str.as_string(), &error_msg));
670 if (instruction_set_features_.get() == nullptr) {
671 Usage("%s", error_msg.c_str());
672 }
673 } else if (option.starts_with("--instruction-set-features=")) {
674 StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800675 if (instruction_set_features_.get() == nullptr) {
Ian Rogersd582fa42014-11-05 23:46:43 -0800676 instruction_set_features_.reset(
677 InstructionSetFeatures::FromVariant(instruction_set_, "default", &error_msg));
678 if (instruction_set_features_.get() == nullptr) {
679 Usage("Problem initializing default instruction set features variant: %s",
680 error_msg.c_str());
681 }
682 }
683 instruction_set_features_.reset(
684 instruction_set_features_->AddFeaturesFromString(str.as_string(), &error_msg));
685 if (instruction_set_features_.get() == nullptr) {
686 Usage("Error parsing '%s': %s", option.data(), error_msg.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800687 }
688 } else if (option.starts_with("--compiler-backend=")) {
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000689 requested_specific_compiler = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800690 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
691 if (backend_str == "Quick") {
692 compiler_kind_ = Compiler::kQuick;
693 } else if (backend_str == "Optimizing") {
694 compiler_kind_ = Compiler::kOptimizing;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800695 } else {
696 Usage("Unknown compiler backend: %s", backend_str.data());
697 }
698 } else if (option.starts_with("--compiler-filter=")) {
699 compiler_filter_string = option.substr(strlen("--compiler-filter=")).data();
700 } else if (option == "--compile-pic") {
701 compile_pic = true;
702 } else if (option.starts_with("--huge-method-max=")) {
703 const char* threshold = option.substr(strlen("--huge-method-max=")).data();
704 if (!ParseInt(threshold, &huge_method_threshold)) {
705 Usage("Failed to parse --huge-method-max '%s' as an integer", threshold);
706 }
707 if (huge_method_threshold < 0) {
708 Usage("--huge-method-max passed a negative value %s", huge_method_threshold);
709 }
710 } else if (option.starts_with("--large-method-max=")) {
711 const char* threshold = option.substr(strlen("--large-method-max=")).data();
712 if (!ParseInt(threshold, &large_method_threshold)) {
713 Usage("Failed to parse --large-method-max '%s' as an integer", threshold);
714 }
715 if (large_method_threshold < 0) {
716 Usage("--large-method-max passed a negative value %s", large_method_threshold);
717 }
718 } else if (option.starts_with("--small-method-max=")) {
719 const char* threshold = option.substr(strlen("--small-method-max=")).data();
720 if (!ParseInt(threshold, &small_method_threshold)) {
721 Usage("Failed to parse --small-method-max '%s' as an integer", threshold);
722 }
723 if (small_method_threshold < 0) {
724 Usage("--small-method-max passed a negative value %s", small_method_threshold);
725 }
726 } else if (option.starts_with("--tiny-method-max=")) {
727 const char* threshold = option.substr(strlen("--tiny-method-max=")).data();
728 if (!ParseInt(threshold, &tiny_method_threshold)) {
729 Usage("Failed to parse --tiny-method-max '%s' as an integer", threshold);
730 }
731 if (tiny_method_threshold < 0) {
732 Usage("--tiny-method-max passed a negative value %s", tiny_method_threshold);
733 }
734 } else if (option.starts_with("--num-dex-methods=")) {
735 const char* threshold = option.substr(strlen("--num-dex-methods=")).data();
736 if (!ParseInt(threshold, &num_dex_methods_threshold)) {
737 Usage("Failed to parse --num-dex-methods '%s' as an integer", threshold);
738 }
739 if (num_dex_methods_threshold < 0) {
740 Usage("--num-dex-methods passed a negative value %s", num_dex_methods_threshold);
741 }
Calin Juravleec748352015-07-29 13:52:12 +0100742 } else if (option.starts_with("--inline-depth-limit=")) {
743 const char* limit = option.substr(strlen("--inline-depth-limit=")).data();
744 if (!ParseInt(limit, &inline_depth_limit)) {
745 Usage("Failed to parse --inline-depth-limit '%s' as an integer", limit);
746 }
747 if (inline_depth_limit < 0) {
748 Usage("--inline-depth-limit passed a negative value %s", inline_depth_limit);
749 }
750 } else if (option.starts_with("--inline-max-code-units=")) {
751 const char* code_units = option.substr(strlen("--inline-max-code-units=")).data();
752 if (!ParseInt(code_units, &inline_max_code_units)) {
753 Usage("Failed to parse --inline-max-code-units '%s' as an integer", code_units);
754 }
755 if (inline_max_code_units < 0) {
756 Usage("--inline-max-code-units passed a negative value %s", inline_max_code_units);
757 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800758 } else if (option == "--host") {
759 is_host_ = true;
760 } else if (option == "--runtime-arg") {
761 if (++i >= argc) {
762 Usage("Missing required argument for --runtime-arg");
763 }
764 if (log_options) {
765 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
766 }
767 runtime_args_.push_back(argv[i]);
768 } else if (option == "--dump-timing") {
769 dump_timing_ = true;
770 } else if (option == "--dump-passes") {
771 dump_passes_ = true;
David Brazdil866c0312015-01-13 21:21:31 +0000772 } else if (option.starts_with("--dump-cfg=")) {
773 dump_cfg_file_name_ = option.substr(strlen("--dump-cfg=")).data();
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800774 } else if (option == "--dump-stats") {
775 dump_stats_ = true;
David Srbecky8363c772015-05-28 16:12:43 +0100776 } else if (option == "--generate-debug-info" || option == "-g") {
777 generate_debug_info = true;
778 } else if (option == "--no-generate-debug-info") {
779 generate_debug_info = false;
Andreas Gampe7b2f09e2015-03-02 14:07:33 -0800780 } else if (option == "--debuggable") {
781 debuggable = true;
David Srbecky8363c772015-05-28 16:12:43 +0100782 generate_debug_info = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800783 } else if (option.starts_with("--profile-file=")) {
784 profile_file_ = option.substr(strlen("--profile-file=")).data();
785 VLOG(compiler) << "dex2oat: profile file is " << profile_file_;
786 } else if (option == "--no-profile-file") {
787 // No profile
788 } else if (option.starts_with("--top-k-profile-threshold=")) {
789 ParseDouble(option.data(), '=', 0.0, 100.0, &top_k_profile_threshold);
790 } else if (option == "--print-pass-names") {
Mathieu Chartier5bdab122015-01-26 18:30:19 -0800791 pass_manager_options.SetPrintPassNames(true);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800792 } else if (option.starts_with("--disable-passes=")) {
Mathieu Chartier5bdab122015-01-26 18:30:19 -0800793 const std::string disable_passes = option.substr(strlen("--disable-passes=")).data();
794 pass_manager_options.SetDisablePassList(disable_passes);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800795 } else if (option.starts_with("--print-passes=")) {
Mathieu Chartier5bdab122015-01-26 18:30:19 -0800796 const std::string print_passes = option.substr(strlen("--print-passes=")).data();
797 pass_manager_options.SetPrintPassList(print_passes);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800798 } else if (option == "--print-all-passes") {
Mathieu Chartier5bdab122015-01-26 18:30:19 -0800799 pass_manager_options.SetPrintAllPasses();
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800800 } else if (option.starts_with("--dump-cfg-passes=")) {
Mathieu Chartier5bdab122015-01-26 18:30:19 -0800801 const std::string dump_passes_string = option.substr(strlen("--dump-cfg-passes=")).data();
802 pass_manager_options.SetDumpPassList(dump_passes_string);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800803 } else if (option == "--print-pass-options") {
Mathieu Chartier5bdab122015-01-26 18:30:19 -0800804 pass_manager_options.SetPrintPassOptions(true);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800805 } else if (option.starts_with("--pass-options=")) {
Mathieu Chartier5bdab122015-01-26 18:30:19 -0800806 const std::string options = option.substr(strlen("--pass-options=")).data();
807 pass_manager_options.SetOverriddenPassOptions(options);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800808 } else if (option == "--include-patch-information") {
809 include_patch_information = true;
810 } else if (option == "--no-include-patch-information") {
811 include_patch_information = false;
812 } else if (option.starts_with("--verbose-methods=")) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800813 // TODO: rather than switch off compiler logging, make all VLOG(compiler) messages
814 // conditional on having verbost methods.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800815 gLogVerbosity.compiler = false;
816 Split(option.substr(strlen("--verbose-methods=")).ToString(), ',', &verbose_methods_);
Andreas Gampedbfe2542014-11-25 22:21:42 -0800817 } else if (option.starts_with("--dump-init-failures=")) {
818 std::string file_name = option.substr(strlen("--dump-init-failures=")).data();
819 init_failure_output_.reset(new std::ofstream(file_name));
820 if (init_failure_output_.get() == nullptr) {
821 LOG(ERROR) << "Failed to allocate ofstream";
822 } else if (init_failure_output_->fail()) {
823 LOG(ERROR) << "Failed to open " << file_name << " for writing the initialization "
824 << "failures.";
825 init_failure_output_.reset();
826 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800827 } else if (option.starts_with("--swap-file=")) {
828 swap_file_name_ = option.substr(strlen("--swap-file=")).data();
829 } else if (option.starts_with("--swap-fd=")) {
830 const char* swap_fd_str = option.substr(strlen("--swap-fd=")).data();
831 if (!ParseInt(swap_fd_str, &swap_fd_)) {
832 Usage("Failed to parse --swap-fd argument '%s' as an integer", swap_fd_str);
833 }
834 if (swap_fd_ < 0) {
835 Usage("--swap-fd passed a negative value %d", swap_fd_);
836 }
Andreas Gampe6cf49e52015-03-05 13:08:45 -0800837 } else if (option == "--abort-on-hard-verifier-error") {
838 abort_on_hard_verifier_error = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800839 } else {
840 Usage("Unknown argument %s", option.data());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700841 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800842 }
843
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000844 image_ = (!image_filename_.empty());
845 if (!requested_specific_compiler && !kUseOptimizingCompiler) {
846 // If no specific compiler is requested, the current behavior is
847 // to compile the boot image with Quick, and the rest with Optimizing.
848 compiler_kind_ = image_ ? Compiler::kQuick : Compiler::kOptimizing;
849 }
850
Nicolas Geoffray9bb492a2014-11-25 23:42:00 +0000851 if (compiler_kind_ == Compiler::kOptimizing) {
852 // Optimizing only supports PIC mode.
853 compile_pic = true;
854 }
855
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800856 if (oat_filename_.empty() && oat_fd_ == -1) {
857 Usage("Output must be supplied with either --oat-file or --oat-fd");
858 }
859
860 if (!oat_filename_.empty() && oat_fd_ != -1) {
861 Usage("--oat-file should not be used with --oat-fd");
862 }
863
864 if (!oat_symbols.empty() && oat_fd_ != -1) {
865 Usage("--oat-symbols should not be used with --oat-fd");
866 }
867
868 if (!oat_symbols.empty() && is_host_) {
869 Usage("--oat-symbols should not be used with --host");
870 }
871
872 if (oat_fd_ != -1 && !image_filename_.empty()) {
873 Usage("--oat-fd should not be used with --image");
874 }
875
876 if (android_root_.empty()) {
877 const char* android_root_env_var = getenv("ANDROID_ROOT");
878 if (android_root_env_var == nullptr) {
879 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700880 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800881 android_root_ += android_root_env_var;
882 }
883
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800884 if (!image_ && boot_image_filename.empty()) {
885 boot_image_filename += android_root_;
886 boot_image_filename += "/framework/boot.art";
887 }
888 if (!boot_image_filename.empty()) {
889 boot_image_option_ += "-Ximage:";
890 boot_image_option_ += boot_image_filename;
891 }
892
893 if (image_classes_filename_ != nullptr && !image_) {
894 Usage("--image-classes should only be used with --image");
895 }
896
897 if (image_classes_filename_ != nullptr && !boot_image_option_.empty()) {
898 Usage("--image-classes should not be used with --boot-image");
899 }
900
901 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
902 Usage("--image-classes-zip should be used with --image-classes");
903 }
904
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800905 if (compiled_classes_filename_ != nullptr && !image_) {
906 Usage("--compiled-classes should only be used with --image");
907 }
908
909 if (compiled_classes_filename_ != nullptr && !boot_image_option_.empty()) {
910 Usage("--compiled-classes should not be used with --boot-image");
911 }
912
913 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
914 Usage("--compiled-classes-zip should be used with --compiled-classes");
915 }
916
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800917 if (dex_filenames_.empty() && zip_fd_ == -1) {
918 Usage("Input must be supplied with either --dex-file or --zip-fd");
919 }
920
921 if (!dex_filenames_.empty() && zip_fd_ != -1) {
922 Usage("--dex-file should not be used with --zip-fd");
923 }
924
925 if (!dex_filenames_.empty() && !zip_location_.empty()) {
926 Usage("--dex-file should not be used with --zip-location");
927 }
928
929 if (dex_locations_.empty()) {
930 for (const char* dex_file_name : dex_filenames_) {
931 dex_locations_.push_back(dex_file_name);
932 }
933 } else if (dex_locations_.size() != dex_filenames_.size()) {
934 Usage("--dex-location arguments do not match --dex-file arguments");
935 }
936
937 if (zip_fd_ != -1 && zip_location_.empty()) {
938 Usage("--zip-location should be supplied with --zip-fd");
939 }
940
941 if (boot_image_option_.empty()) {
942 if (image_base_ == 0) {
943 Usage("Non-zero --base not specified");
944 }
945 }
946
947 oat_stripped_ = oat_filename_;
948 if (!oat_symbols.empty()) {
949 oat_unstripped_ = oat_symbols;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700950 } else {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800951 oat_unstripped_ = oat_filename_;
952 }
953
954 // If no instruction set feature was given, use the default one for the target
955 // instruction set.
956 if (instruction_set_features_.get() == nullptr) {
957 instruction_set_features_.reset(
Ian Rogersd582fa42014-11-05 23:46:43 -0800958 InstructionSetFeatures::FromVariant(instruction_set_, "default", &error_msg));
959 if (instruction_set_features_.get() == nullptr) {
960 Usage("Problem initializing default instruction set features variant: %s",
961 error_msg.c_str());
962 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800963 }
964
965 if (instruction_set_ == kRuntimeISA) {
966 std::unique_ptr<const InstructionSetFeatures> runtime_features(
967 InstructionSetFeatures::FromCppDefines());
968 if (!instruction_set_features_->Equals(runtime_features.get())) {
969 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
970 << *instruction_set_features_ << ") and those of dex2oat executable ("
971 << *runtime_features <<") for the command line:\n"
972 << CommandLine();
973 }
974 }
975
976 if (compiler_filter_string == nullptr) {
Douglas Leung027f0ff2015-02-27 19:05:03 -0800977 compiler_filter_string = "speed";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800978 }
Maja Gagic6ea651f2015-02-24 16:55:04 +0100979
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800980 CHECK(compiler_filter_string != nullptr);
981 CompilerOptions::CompilerFilter compiler_filter = CompilerOptions::kDefaultCompilerFilter;
982 if (strcmp(compiler_filter_string, "verify-none") == 0) {
983 compiler_filter = CompilerOptions::kVerifyNone;
984 } else if (strcmp(compiler_filter_string, "interpret-only") == 0) {
985 compiler_filter = CompilerOptions::kInterpretOnly;
Mathieu Chartiere86deef2015-03-19 13:43:37 -0700986 } else if (strcmp(compiler_filter_string, "verify-at-runtime") == 0) {
987 compiler_filter = CompilerOptions::kVerifyAtRuntime;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800988 } else if (strcmp(compiler_filter_string, "space") == 0) {
989 compiler_filter = CompilerOptions::kSpace;
990 } else if (strcmp(compiler_filter_string, "balanced") == 0) {
991 compiler_filter = CompilerOptions::kBalanced;
992 } else if (strcmp(compiler_filter_string, "speed") == 0) {
993 compiler_filter = CompilerOptions::kSpeed;
994 } else if (strcmp(compiler_filter_string, "everything") == 0) {
995 compiler_filter = CompilerOptions::kEverything;
996 } else if (strcmp(compiler_filter_string, "time") == 0) {
997 compiler_filter = CompilerOptions::kTime;
998 } else {
999 Usage("Unknown --compiler-filter value %s", compiler_filter_string);
1000 }
1001
Roland Levillaina215b952015-08-07 11:38:32 +01001002 // It they are not set, use default values for inlining settings.
1003 // TODO: We should rethink the compiler filter. We mostly save
1004 // time here, which is orthogonal to space.
1005 if (inline_depth_limit == kUnsetInlineDepthLimit) {
1006 inline_depth_limit = (compiler_filter == CompilerOptions::kSpace)
1007 // Implementation of the space filter: limit inlining depth.
1008 ? CompilerOptions::kSpaceFilterInlineDepthLimit
1009 : CompilerOptions::kDefaultInlineDepthLimit;
1010 }
1011 if (inline_max_code_units == kUnsetInlineMaxCodeUnits) {
1012 inline_max_code_units = (compiler_filter == CompilerOptions::kSpace)
1013 // Implementation of the space filter: limit inlining max code units.
1014 ? CompilerOptions::kSpaceFilterInlineMaxCodeUnits
1015 : CompilerOptions::kDefaultInlineMaxCodeUnits;
1016 }
1017
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001018 // Checks are all explicit until we know the architecture.
1019 bool implicit_null_checks = false;
1020 bool implicit_so_checks = false;
1021 bool implicit_suspend_checks = false;
1022 // Set the compilation target's implicit checks options.
1023 switch (instruction_set_) {
1024 case kArm:
1025 case kThumb2:
1026 case kArm64:
1027 case kX86:
1028 case kX86_64:
Douglas Leung22bb5a22015-07-02 16:42:08 -07001029 case kMips:
1030 case kMips64:
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001031 implicit_null_checks = true;
1032 implicit_so_checks = true;
1033 break;
1034
1035 default:
1036 // Defaults are correct.
1037 break;
1038 }
1039
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001040 compiler_options_.reset(new CompilerOptions(compiler_filter,
1041 huge_method_threshold,
1042 large_method_threshold,
1043 small_method_threshold,
1044 tiny_method_threshold,
1045 num_dex_methods_threshold,
Calin Juravleec748352015-07-29 13:52:12 +01001046 inline_depth_limit,
1047 inline_max_code_units,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001048 include_patch_information,
1049 top_k_profile_threshold,
Andreas Gampe7b2f09e2015-03-02 14:07:33 -08001050 debuggable,
David Srbecky8363c772015-05-28 16:12:43 +01001051 generate_debug_info,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001052 implicit_null_checks,
1053 implicit_so_checks,
1054 implicit_suspend_checks,
1055 compile_pic,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001056 verbose_methods_.empty() ?
1057 nullptr :
Andreas Gampedbfe2542014-11-25 22:21:42 -08001058 &verbose_methods_,
Mathieu Chartier5bdab122015-01-26 18:30:19 -08001059 new PassManagerOptions(pass_manager_options),
Andreas Gampe6cf49e52015-03-05 13:08:45 -08001060 init_failure_output_.get(),
1061 abort_on_hard_verifier_error));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001062
1063 // Done with usage checks, enable watchdog if requested
1064 if (watch_dog_enabled) {
1065 watchdog_.reset(new WatchDog(true));
1066 }
1067
1068 // Fill some values into the key-value store for the oat header.
1069 key_value_store_.reset(new SafeMap<std::string, std::string>());
1070
1071 // Insert some compiler things.
1072 {
1073 std::ostringstream oss;
1074 for (int i = 0; i < argc; ++i) {
1075 if (i > 0) {
1076 oss << ' ';
1077 }
1078 oss << argv[i];
1079 }
1080 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1081 oss.str(""); // Reset.
1082 oss << kRuntimeISA;
1083 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
Sebastien Hertz0de11332015-05-13 12:14:05 +02001084 key_value_store_->Put(OatHeader::kPicKey,
1085 compile_pic ? OatHeader::kTrueValue : OatHeader::kFalseValue);
1086 key_value_store_->Put(OatHeader::kDebuggableKey,
1087 debuggable ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001088 }
1089 }
1090
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001091 // Check whether the oat output file is writable, and open it for later. Also open a swap file,
1092 // if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001093 bool OpenFile() {
1094 bool create_file = !oat_unstripped_.empty(); // as opposed to using open file descriptor
1095 if (create_file) {
1096 oat_file_.reset(OS::CreateEmptyFile(oat_unstripped_.c_str()));
1097 if (oat_location_.empty()) {
1098 oat_location_ = oat_filename_;
1099 }
1100 } else {
Andreas Gampe4303ba92014-11-06 01:00:46 -08001101 oat_file_.reset(new File(oat_fd_, oat_location_, true));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001102 oat_file_->DisableAutoClose();
Andreas Gampe4303ba92014-11-06 01:00:46 -08001103 if (oat_file_->SetLength(0) != 0) {
1104 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1105 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001106 }
1107 if (oat_file_.get() == nullptr) {
1108 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1109 return false;
1110 }
1111 if (create_file && fchmod(oat_file_->Fd(), 0644) != 0) {
1112 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_location_;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001113 oat_file_->Erase();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001114 return false;
1115 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001116
1117 // Swap file handling.
1118 //
1119 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1120 // that we can use for swap.
1121 //
1122 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1123 // will immediately unlink to satisfy the swap fd assumption.
1124 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1125 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1126 if (swap_file.get() == nullptr) {
1127 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1128 return false;
1129 }
1130 swap_fd_ = swap_file->Fd();
1131 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1132 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1133 // released immediately.
1134 unlink(swap_file_name_.c_str());
1135 }
1136
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001137 return true;
1138 }
1139
Andreas Gampea650e702014-12-03 14:28:02 -08001140 void EraseOatFile() {
1141 DCHECK(oat_file_.get() != nullptr);
1142 oat_file_->Erase();
1143 oat_file_.reset();
1144 }
1145
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001146 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1147 // boot class path.
1148 bool Setup() {
1149 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
1150 RuntimeOptions runtime_options;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001151 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap.
1152 if (boot_image_option_.empty()) {
Richard Uhlerc2752592015-01-02 13:28:22 -08001153 std::string boot_class_path = "-Xbootclasspath:";
1154 boot_class_path += Join(dex_filenames_, ':');
1155 runtime_options.push_back(std::make_pair(boot_class_path, nullptr));
1156 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
1157 boot_class_path_locations += Join(dex_locations_, ':');
1158 runtime_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001159 } else {
Richard Uhlerc2752592015-01-02 13:28:22 -08001160 runtime_options.push_back(std::make_pair(boot_image_option_, nullptr));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001161 }
1162 for (size_t i = 0; i < runtime_args_.size(); i++) {
1163 runtime_options.push_back(std::make_pair(runtime_args_[i], nullptr));
Brian Carlstrom7940e442013-07-12 13:46:57 -07001164 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001165
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001166 verification_results_.reset(new VerificationResults(compiler_options_.get()));
Andreas Gampe4585f872015-03-27 23:45:15 -07001167 callbacks_.reset(new QuickCompilerCallbacks(
1168 verification_results_.get(),
1169 &method_inliner_map_,
1170 image_ ?
1171 CompilerCallbacks::CallbackMode::kCompileBootImage :
1172 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001173 runtime_options.push_back(std::make_pair("compilercallbacks", callbacks_.get()));
1174 runtime_options.push_back(
1175 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
1176
Andreas Gampe1d00add2015-02-27 19:35:46 -08001177 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
1178 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
1179 // have been stripped in preopting, anyways).
1180 if (!image_) {
1181 runtime_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
1182 }
Calin Juravle01aaf6e2015-06-19 22:05:39 +01001183 // Disable libsigchain. We don't don't need it during compilation and it prevents us
1184 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
1185 runtime_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Andreas Gampe1d00add2015-02-27 19:35:46 -08001186
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001187 if (!CreateRuntime(runtime_options)) {
1188 return false;
1189 }
1190
1191 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
1192 // Runtime::Start, give it away now so that we don't starve GC.
1193 Thread* self = Thread::Current();
1194 self->TransitionFromRunnableToSuspended(kNative);
1195 // If we're doing the image, override the compiler filter to force full compilation. Must be
1196 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1197 // compilation of class initializers.
1198 // Whilst we're in native take the opportunity to initialize well known classes.
1199 WellKnownClasses::Init(self->GetJniEnv());
1200
1201 // If --image-classes was specified, calculate the full list of classes to include in the image
1202 if (image_classes_filename_ != nullptr) {
1203 std::string error_msg;
1204 if (image_classes_zip_filename_ != nullptr) {
1205 image_classes_.reset(ReadImageClassesFromZip(image_classes_zip_filename_,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001206 image_classes_filename_,
1207 &error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001208 } else {
1209 image_classes_.reset(ReadImageClassesFromFile(image_classes_filename_));
1210 }
1211 if (image_classes_.get() == nullptr) {
1212 LOG(ERROR) << "Failed to create list of image classes from '" << image_classes_filename_ <<
1213 "': " << error_msg;
1214 return false;
1215 }
1216 } else if (image_) {
Andreas Gampeb1fcead2015-04-20 18:53:51 -07001217 image_classes_.reset(new std::unordered_set<std::string>);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001218 }
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08001219 // If --compiled-classes was specified, calculate the full list of classes to compile in the
1220 // image.
1221 if (compiled_classes_filename_ != nullptr) {
1222 std::string error_msg;
1223 if (compiled_classes_zip_filename_ != nullptr) {
1224 compiled_classes_.reset(ReadImageClassesFromZip(compiled_classes_zip_filename_,
1225 compiled_classes_filename_,
1226 &error_msg));
1227 } else {
1228 compiled_classes_.reset(ReadImageClassesFromFile(compiled_classes_filename_));
1229 }
1230 if (compiled_classes_.get() == nullptr) {
1231 LOG(ERROR) << "Failed to create list of compiled classes from '"
1232 << compiled_classes_filename_ << "': " << error_msg;
1233 return false;
1234 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001235 } else {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08001236 compiled_classes_.reset(nullptr); // By default compile everything.
1237 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001238 // If --compiled-methods was specified, read the methods to compile from the given file(s).
1239 if (compiled_methods_filename_ != nullptr) {
1240 std::string error_msg;
1241 if (compiled_methods_zip_filename_ != nullptr) {
1242 compiled_methods_.reset(ReadCommentedInputFromZip(compiled_methods_zip_filename_,
1243 compiled_methods_filename_,
1244 nullptr, // No post-processing.
1245 &error_msg));
1246 } else {
1247 compiled_methods_.reset(ReadCommentedInputFromFile(compiled_methods_filename_,
1248 nullptr)); // No post-processing.
1249 }
1250 if (compiled_methods_.get() == nullptr) {
1251 LOG(ERROR) << "Failed to create list of compiled methods from '"
1252 << compiled_methods_filename_ << "': " << error_msg;
1253 return false;
1254 }
1255 } else {
1256 compiled_methods_.reset(nullptr); // By default compile everything.
1257 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001258
1259 if (boot_image_option_.empty()) {
1260 dex_files_ = Runtime::Current()->GetClassLinker()->GetBootClassPath();
1261 } else {
1262 if (dex_filenames_.empty()) {
1263 ATRACE_BEGIN("Opening zip archive from file descriptor");
1264 std::string error_msg;
1265 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::OpenFromFd(zip_fd_,
1266 zip_location_.c_str(),
1267 &error_msg));
1268 if (zip_archive.get() == nullptr) {
1269 LOG(ERROR) << "Failed to open zip from file descriptor for '" << zip_location_ << "': "
1270 << error_msg;
1271 return false;
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001272 }
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001273 if (!DexFile::OpenFromZip(*zip_archive.get(), zip_location_, &error_msg, &opened_dex_files_)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001274 LOG(ERROR) << "Failed to open dex from file descriptor for zip file '" << zip_location_
1275 << "': " << error_msg;
1276 return false;
1277 }
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001278 for (auto& dex_file : opened_dex_files_) {
1279 dex_files_.push_back(dex_file.get());
1280 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001281 ATRACE_END();
1282 } else {
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001283 size_t failure_count = OpenDexFiles(dex_filenames_, dex_locations_, &opened_dex_files_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001284 if (failure_count > 0) {
1285 LOG(ERROR) << "Failed to open some dex files: " << failure_count;
1286 return false;
1287 }
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001288 for (auto& dex_file : opened_dex_files_) {
1289 dex_files_.push_back(dex_file.get());
1290 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001291 }
1292
1293 constexpr bool kSaveDexInput = false;
1294 if (kSaveDexInput) {
1295 for (size_t i = 0; i < dex_files_.size(); ++i) {
1296 const DexFile* dex_file = dex_files_[i];
Brian Carlstrom95b033b2014-12-03 22:29:37 -08001297 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
1298 getpid(), i));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001299 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
1300 if (tmp_file.get() == nullptr) {
1301 PLOG(ERROR) << "Failed to open file " << tmp_file_name
1302 << ". Try: adb shell chmod 777 /data/local/tmp";
1303 continue;
1304 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001305 // This is just dumping files for debugging. Ignore errors, and leave remnants.
1306 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
1307 UNUSED(tmp_file->Flush());
1308 UNUSED(tmp_file->Close());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001309 LOG(INFO) << "Wrote input to " << tmp_file_name;
1310 }
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001311 }
1312 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001313 // Ensure opened dex files are writable for dex-to-dex transformations.
1314 for (const auto& dex_file : dex_files_) {
1315 if (!dex_file->EnableWrite()) {
1316 PLOG(ERROR) << "Failed to make .dex file writeable '" << dex_file->GetLocation() << "'\n";
Andreas Gampe7ba64962014-10-23 11:37:40 -07001317 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001318 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001319
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001320 // If we use a swap file, ensure we are above the threshold to make it necessary.
1321 if (swap_fd_ != -1) {
1322 if (!UseSwap(image_, dex_files_)) {
1323 close(swap_fd_);
1324 swap_fd_ = -1;
Andreas Gampef99bcd22015-04-24 16:22:18 -07001325 VLOG(compiler) << "Decided to run without swap.";
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001326 } else {
Andreas Gampef99bcd22015-04-24 16:22:18 -07001327 LOG(INFO) << "Large app, accepted running with swap.";
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001328 }
1329 }
1330 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
1331
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001332 /*
1333 * If we're not in interpret-only or verify-none mode, go ahead and compile small applications.
1334 * Don't bother to check if we're doing the image.
1335 */
Brian Carlstrom95b033b2014-12-03 22:29:37 -08001336 if (!image_ &&
1337 compiler_options_->IsCompilationEnabled() &&
1338 compiler_kind_ == Compiler::kQuick) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001339 size_t num_methods = 0;
1340 for (size_t i = 0; i != dex_files_.size(); ++i) {
1341 const DexFile* dex_file = dex_files_[i];
1342 CHECK(dex_file != nullptr);
1343 num_methods += dex_file->NumMethodIds();
1344 }
1345 if (num_methods <= compiler_options_->GetNumDexMethodsThreshold()) {
1346 compiler_options_->SetCompilerFilter(CompilerOptions::kSpeed);
1347 VLOG(compiler) << "Below method threshold, compiling anyways";
1348 }
1349 }
1350
1351 return true;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001352 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001353
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001354 // Create and invoke the compiler driver. This will compile all the dex files.
1355 void Compile() {
1356 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1357 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001358
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001359 // Handle and ClassLoader creation needs to come after Runtime::Create
1360 jobject class_loader = nullptr;
1361 Thread* self = Thread::Current();
1362 if (!boot_image_option_.empty()) {
1363 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001364 OpenClassPathFiles(runtime_->GetClassPathString(), dex_files_, &class_path_files_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001365 ScopedObjectAccess soa(self);
Andreas Gampe81c6f8d2015-03-25 17:19:53 -07001366
1367 // Classpath: first the class-path given.
1368 std::vector<const DexFile*> class_path_files;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001369 for (auto& class_path_file : class_path_files_) {
1370 class_path_files.push_back(class_path_file.get());
1371 }
Andreas Gampe7848da42015-04-09 11:15:04 -07001372
1373 // Store the classpath we have right now.
1374 key_value_store_->Put(OatHeader::kClassPathKey,
1375 OatFile::EncodeDexFileDependencies(class_path_files));
1376
Andreas Gampe81c6f8d2015-03-25 17:19:53 -07001377 // Then the dex files we'll compile. Thus we'll resolve the class-path first.
1378 class_path_files.insert(class_path_files.end(), dex_files_.begin(), dex_files_.end());
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001379
Andreas Gampe81c6f8d2015-03-25 17:19:53 -07001380 class_loader = class_linker->CreatePathClassLoader(self, class_path_files);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001381 }
1382
1383 driver_.reset(new CompilerDriver(compiler_options_.get(),
1384 verification_results_.get(),
1385 &method_inliner_map_,
1386 compiler_kind_,
1387 instruction_set_,
1388 instruction_set_features_.get(),
1389 image_,
1390 image_classes_.release(),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08001391 compiled_classes_.release(),
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001392 nullptr,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001393 thread_count_,
1394 dump_stats_,
1395 dump_passes_,
David Brazdil866c0312015-01-13 21:21:31 +00001396 dump_cfg_file_name_,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001397 compiler_phases_timings_.get(),
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001398 swap_fd_,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001399 profile_file_));
1400
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001401 driver_->CompileAll(class_loader, dex_files_, timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001402 }
1403
Brian Carlstrom7940e442013-07-12 13:46:57 -07001404 // Notes on the interleaving of creating the image and oat file to
1405 // ensure the references between the two are correct.
1406 //
1407 // Currently we have a memory layout that looks something like this:
1408 //
1409 // +--------------+
1410 // | image |
1411 // +--------------+
1412 // | boot oat |
1413 // +--------------+
1414 // | alloc spaces |
1415 // +--------------+
1416 //
Brian Carlstrom45602482013-07-21 22:07:55 -07001417 // There are several constraints on the loading of the image and boot.oat.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001418 //
1419 // 1. The image is expected to be loaded at an absolute address and
1420 // contains Objects with absolute pointers within the image.
1421 //
1422 // 2. There are absolute pointers from Methods in the image to their
1423 // code in the oat.
1424 //
1425 // 3. There are absolute pointers from the code in the oat to Methods
1426 // in the image.
1427 //
1428 // 4. There are absolute pointers from code in the oat to other code
1429 // in the oat.
1430 //
1431 // To get this all correct, we go through several steps.
1432 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001433 // 1. We prepare offsets for all data in the oat file and calculate
1434 // the oat data size and code size. During this stage, we also set
1435 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001436 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001437 // 2. We prepare offsets for the objects in the image and calculate
1438 // the image size.
1439 //
1440 // 3. We create the oat file. Originally this was just our own proprietary
1441 // file but now it is contained within an ELF dynamic object (aka an .so
1442 // file). Since we know the image size and oat data size and code size we
1443 // can prepare the ELF headers and we then know the ELF memory segment
1444 // layout and we can now resolve all references. The compiler provides
1445 // LinkerPatch information in each CompiledMethod and we resolve these,
1446 // using the layout information and image object locations provided by
1447 // image writer, as we're writing the method code.
1448 //
1449 // 4. We create the image file. It needs to know where the oat file
Brian Carlstrom7940e442013-07-12 13:46:57 -07001450 // will be loaded after itself. Originally when oat file was simply
1451 // memory mapped so we could predict where its contents were based
1452 // on the file size. Now that it is an ELF file, we need to inspect
1453 // the ELF file to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001454 // where the oat header is located within.
1455 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001456 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001457 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001458 // load the .so at the desired location at runtime by offsetting the
1459 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001460 // TODO: Do this in step 3. We already know the layout there.
1461 //
1462 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1463 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001464
1465
1466 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1467 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001468 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1469 // case (when the file will be explicitly erased).
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001470 bool CreateOatFile() {
1471 CHECK(key_value_store_.get() != nullptr);
1472
1473 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1474
1475 std::unique_ptr<OatWriter> oat_writer;
1476 {
1477 TimingLogger::ScopedTiming t2("dex2oat OatWriter", timings_);
1478 std::string image_file_location;
1479 uint32_t image_file_location_oat_checksum = 0;
1480 uintptr_t image_file_location_oat_data_begin = 0;
1481 int32_t image_patch_delta = 0;
1482 if (image_) {
1483 PrepareImageWriter(image_base_);
1484 } else {
1485 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1486 gc::space::ImageSpace* image_space = Runtime::Current()->GetHeap()->GetImageSpace();
1487 image_file_location_oat_checksum = image_space->GetImageHeader().GetOatChecksum();
1488 image_file_location_oat_data_begin =
1489 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatDataBegin());
1490 image_file_location = image_space->GetImageFilename();
1491 image_patch_delta = image_space->GetImageHeader().GetPatchDelta();
1492 }
1493
1494 if (!image_file_location.empty()) {
1495 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1496 }
1497
1498 oat_writer.reset(new OatWriter(dex_files_, image_file_location_oat_checksum,
1499 image_file_location_oat_data_begin,
1500 image_patch_delta,
1501 driver_.get(),
1502 image_writer_.get(),
1503 timings_,
1504 key_value_store_.get()));
Brian Carlstrom7940e442013-07-12 13:46:57 -07001505 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001506
1507 if (image_) {
1508 // The OatWriter constructor has already updated offsets in methods and we need to
1509 // prepare method offsets in the image address space for direct method patching.
1510 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1511 if (!image_writer_->PrepareImageAddressSpace()) {
1512 LOG(ERROR) << "Failed to prepare image address space.";
1513 return false;
1514 }
1515 }
1516
1517 {
1518 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
1519 if (!driver_->WriteElf(android_root_, is_host_, dex_files_, oat_writer.get(),
1520 oat_file_.get())) {
1521 LOG(ERROR) << "Failed to write ELF file " << oat_file_->GetPath();
1522 return false;
1523 }
1524 }
1525
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001526 VLOG(compiler) << "Oat file written successfully (unstripped): " << oat_location_;
1527 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001528 }
1529
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001530 // If we are compiling an image, invoke the image creation routine. Else just skip.
1531 bool HandleImage() {
1532 if (image_) {
1533 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
1534 if (!CreateImageFile()) {
1535 return false;
1536 }
1537 VLOG(compiler) << "Image written successfully: " << image_filename_;
Brian Carlstrom45602482013-07-21 22:07:55 -07001538 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001539 return true;
1540 }
1541
Andreas Gampe10e477d2014-11-19 12:57:42 -08001542 // Create a copy from unstripped to stripped.
1543 bool CopyUnstrippedToStripped() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001544 // If we don't want to strip in place, copy from unstripped location to stripped location.
1545 // We need to strip after image creation because FixupElf needs to use .strtab.
1546 if (oat_unstripped_ != oat_stripped_) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08001547 // If the oat file is still open, flush it.
1548 if (oat_file_.get() != nullptr && oat_file_->IsOpened()) {
1549 if (!FlushCloseOatFile()) {
1550 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001551 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001552 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08001553
1554 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001555 std::unique_ptr<File> in(OS::OpenFileForReading(oat_unstripped_.c_str()));
1556 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_stripped_.c_str()));
1557 size_t buffer_size = 8192;
Dan Albert6fc59ab2014-12-11 14:09:51 -08001558 std::unique_ptr<uint8_t[]> buffer(new uint8_t[buffer_size]);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001559 while (true) {
1560 int bytes_read = TEMP_FAILURE_RETRY(read(in->Fd(), buffer.get(), buffer_size));
1561 if (bytes_read <= 0) {
1562 break;
1563 }
1564 bool write_ok = out->WriteFully(buffer.get(), bytes_read);
1565 CHECK(write_ok);
1566 }
Elliott Hughes956af0f2014-12-11 14:34:28 -08001567 if (out->FlushCloseOrErase() != 0) {
1568 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_stripped_;
1569 return false;
Andreas Gampe10e477d2014-11-19 12:57:42 -08001570 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001571 VLOG(compiler) << "Oat file copied successfully (stripped): " << oat_stripped_;
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00001572 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08001573 return true;
1574 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001575
Andreas Gampe10e477d2014-11-19 12:57:42 -08001576 bool FlushOatFile() {
Andreas Gampe4303ba92014-11-06 01:00:46 -08001577 if (oat_file_.get() != nullptr) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08001578 TimingLogger::ScopedTiming t2("dex2oat Flush ELF", timings_);
1579 if (oat_file_->Flush() != 0) {
1580 PLOG(ERROR) << "Failed to flush oat file: " << oat_location_ << " / "
1581 << oat_filename_;
1582 oat_file_->Erase();
1583 return false;
1584 }
1585 }
1586 return true;
1587 }
1588
1589 bool FlushCloseOatFile() {
1590 if (oat_file_.get() != nullptr) {
1591 std::unique_ptr<File> tmp(oat_file_.release());
1592 if (tmp->FlushCloseOrErase() != 0) {
1593 PLOG(ERROR) << "Failed to flush and close oat file: " << oat_location_ << " / "
1594 << oat_filename_;
1595 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001596 }
1597 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001598 return true;
1599 }
1600
1601 void DumpTiming() {
1602 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
1603 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
1604 }
1605 if (dump_passes_) {
1606 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
1607 }
1608 }
1609
1610 CompilerOptions* GetCompilerOptions() const {
1611 return compiler_options_.get();
1612 }
1613
Andreas Gampe10e477d2014-11-19 12:57:42 -08001614 bool IsImage() const {
1615 return image_;
1616 }
1617
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001618 bool IsHost() const {
1619 return is_host_;
1620 }
1621
1622 private:
1623 static size_t OpenDexFiles(const std::vector<const char*>& dex_filenames,
1624 const std::vector<const char*>& dex_locations,
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001625 std::vector<std::unique_ptr<const DexFile>>* dex_files) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001626 DCHECK(dex_files != nullptr) << "OpenDexFiles out-param is nullptr";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001627 size_t failure_count = 0;
1628 for (size_t i = 0; i < dex_filenames.size(); i++) {
1629 const char* dex_filename = dex_filenames[i];
1630 const char* dex_location = dex_locations[i];
1631 ATRACE_BEGIN(StringPrintf("Opening dex file '%s'", dex_filenames[i]).c_str());
1632 std::string error_msg;
1633 if (!OS::FileExists(dex_filename)) {
1634 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filename << "'";
1635 continue;
1636 }
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001637 if (!DexFile::Open(dex_filename, dex_location, &error_msg, dex_files)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001638 LOG(WARNING) << "Failed to open .dex from file '" << dex_filename << "': " << error_msg;
1639 ++failure_count;
1640 }
1641 ATRACE_END();
1642 }
1643 return failure_count;
1644 }
1645
Andreas Gampee3712d02015-04-09 14:46:31 -07001646 // Returns true if dex_files has a dex with the named location. We compare canonical locations,
1647 // so that relative and absolute paths will match. Not caching for the dex_files isn't very
1648 // efficient, but under normal circumstances the list is neither large nor is this part too
1649 // sensitive.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001650 static bool DexFilesContains(const std::vector<const DexFile*>& dex_files,
1651 const std::string& location) {
Andreas Gampee3712d02015-04-09 14:46:31 -07001652 std::string canonical_location(DexFile::GetDexCanonicalLocation(location.c_str()));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001653 for (size_t i = 0; i < dex_files.size(); ++i) {
Andreas Gampee3712d02015-04-09 14:46:31 -07001654 if (DexFile::GetDexCanonicalLocation(dex_files[i]->GetLocation().c_str()) ==
1655 canonical_location) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001656 return true;
1657 }
1658 }
1659 return false;
1660 }
1661
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001662 // Appends to opened_dex_files any elements of class_path that dex_files
1663 // doesn't already contain. This will open those dex files as necessary.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001664 static void OpenClassPathFiles(const std::string& class_path,
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001665 std::vector<const DexFile*> dex_files,
1666 std::vector<std::unique_ptr<const DexFile>>* opened_dex_files) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001667 DCHECK(opened_dex_files != nullptr) << "OpenClassPathFiles out-param is nullptr";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001668 std::vector<std::string> parsed;
1669 Split(class_path, ':', &parsed);
1670 // Take Locks::mutator_lock_ so that lock ordering on the ClassLinker::dex_lock_ is maintained.
1671 ScopedObjectAccess soa(Thread::Current());
1672 for (size_t i = 0; i < parsed.size(); ++i) {
1673 if (DexFilesContains(dex_files, parsed[i])) {
1674 continue;
1675 }
1676 std::string error_msg;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001677 if (!DexFile::Open(parsed[i].c_str(), parsed[i].c_str(), &error_msg, opened_dex_files)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001678 LOG(WARNING) << "Failed to open dex file '" << parsed[i] << "': " << error_msg;
1679 }
1680 }
1681 }
1682
1683 // Create a runtime necessary for compilation.
1684 bool CreateRuntime(const RuntimeOptions& runtime_options)
1685 SHARED_TRYLOCK_FUNCTION(true, Locks::mutator_lock_) {
1686 if (!Runtime::Create(runtime_options, false)) {
1687 LOG(ERROR) << "Failed to create runtime";
1688 return false;
1689 }
1690 Runtime* runtime = Runtime::Current();
1691 runtime->SetInstructionSet(instruction_set_);
1692 for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) {
1693 Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i);
1694 if (!runtime->HasCalleeSaveMethod(type)) {
1695 runtime->SetCalleeSaveMethod(runtime->CreateCalleeSaveMethod(), type);
1696 }
1697 }
1698 runtime->GetClassLinker()->FixupDexCaches(runtime->GetResolutionMethod());
Andreas Gampe2969bcd2015-03-09 12:57:41 -07001699
1700 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
1701 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07001702 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07001703
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001704 runtime->GetClassLinker()->RunRootClinits();
1705 runtime_ = runtime;
Andreas Gampe2969bcd2015-03-09 12:57:41 -07001706
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001707 return true;
1708 }
1709
1710 void PrepareImageWriter(uintptr_t image_base) {
1711 image_writer_.reset(new ImageWriter(*driver_, image_base, compiler_options_->GetCompilePic()));
1712 }
1713
1714 // Let the ImageWriter write the image file. If we do not compile PIC, also fix up the oat file.
1715 bool CreateImageFile()
Mathieu Chartier90443472015-07-16 20:32:27 -07001716 REQUIRES(!Locks::mutator_lock_) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001717 CHECK(image_writer_ != nullptr);
1718 if (!image_writer_->Write(image_filename_, oat_unstripped_, oat_location_)) {
1719 LOG(ERROR) << "Failed to create image file " << image_filename_;
1720 return false;
1721 }
1722 uintptr_t oat_data_begin = image_writer_->GetOatDataBegin();
1723
1724 // Destroy ImageWriter before doing FixupElf.
1725 image_writer_.reset();
1726
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001727 // Do not fix up the ELF file if we are --compile-pic
1728 if (!compiler_options_->GetCompilePic()) {
Andreas Gampe4303ba92014-11-06 01:00:46 -08001729 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_unstripped_.c_str()));
1730 if (oat_file.get() == nullptr) {
1731 PLOG(ERROR) << "Failed to open ELF file: " << oat_unstripped_;
1732 return false;
1733 }
1734
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001735 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begin)) {
Andreas Gampe4303ba92014-11-06 01:00:46 -08001736 oat_file->Erase();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001737 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
1738 return false;
1739 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001740
1741 if (oat_file->FlushCloseOrErase()) {
1742 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
1743 return false;
1744 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001745 }
1746
1747 return true;
1748 }
1749
1750 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07001751 static std::unordered_set<std::string>* ReadImageClassesFromFile(
1752 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001753 std::function<std::string(const char*)> process = DotToDescriptor;
1754 return ReadCommentedInputFromFile(image_classes_filename, &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001755 }
1756
1757 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07001758 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001759 const char* zip_filename,
1760 const char* image_classes_filename,
1761 std::string* error_msg) {
1762 std::function<std::string(const char*)> process = DotToDescriptor;
1763 return ReadCommentedInputFromZip(zip_filename, image_classes_filename, &process, error_msg);
1764 }
1765
1766 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
1767 // the given function.
1768 static std::unordered_set<std::string>* ReadCommentedInputFromFile(
1769 const char* input_filename, std::function<std::string(const char*)>* process) {
1770 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
1771 if (input_file.get() == nullptr) {
1772 LOG(ERROR) << "Failed to open input file " << input_filename;
1773 return nullptr;
1774 }
1775 std::unique_ptr<std::unordered_set<std::string>> result(
1776 ReadCommentedInputStream(*input_file, process));
1777 input_file->close();
1778 return result.release();
1779 }
1780
1781 // Read lines from the given file from the given zip file, dropping comments and empty lines.
1782 // Post-process each line with the given function.
1783 static std::unordered_set<std::string>* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07001784 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001785 const char* input_filename,
1786 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07001787 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001788 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
1789 if (zip_archive.get() == nullptr) {
1790 return nullptr;
1791 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001792 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001793 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001794 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001795 zip_filename, error_msg->c_str());
1796 return nullptr;
1797 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001798 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
1799 input_filename,
1800 error_msg));
1801 if (input_file.get() == nullptr) {
1802 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001803 zip_filename, error_msg->c_str());
1804 return nullptr;
1805 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001806 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
1807 input_file->Size());
1808 std::istringstream input_stream(input_string);
1809 return ReadCommentedInputStream(input_stream, process);
1810 }
1811
1812 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
1813 // with the given function.
1814 static std::unordered_set<std::string>* ReadCommentedInputStream(
1815 std::istream& in_stream,
1816 std::function<std::string(const char*)>* process) {
1817 std::unique_ptr<std::unordered_set<std::string>> image_classes(
1818 new std::unordered_set<std::string>);
1819 while (in_stream.good()) {
1820 std::string dot;
1821 std::getline(in_stream, dot);
1822 if (StartsWith(dot, "#") || dot.empty()) {
1823 continue;
1824 }
1825 if (process != nullptr) {
1826 std::string descriptor((*process)(dot.c_str()));
1827 image_classes->insert(descriptor);
1828 } else {
1829 image_classes->insert(dot);
1830 }
1831 }
1832 return image_classes.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001833 }
1834
Mathieu Chartier49285c52014-12-02 15:43:48 -08001835 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08001836 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
1837 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08001838 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001839 LOG(INFO) << "dex2oat took " << PrettyDuration(NanoTime() - start_ns_)
Mathieu Chartierab972ef2014-12-03 17:38:22 -08001840 << " (threads: " << thread_count_ << ") "
Brian Carlstroma11a34c2015-03-06 08:44:45 -08001841 << ((Runtime::Current() != nullptr && driver_.get() != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08001842 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
1843 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001844 }
1845
1846 std::unique_ptr<CompilerOptions> compiler_options_;
1847 Compiler::Kind compiler_kind_;
1848
1849 InstructionSet instruction_set_;
1850 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
1851
1852 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
1853
1854 std::unique_ptr<VerificationResults> verification_results_;
1855 DexFileToMethodInlinerMap method_inliner_map_;
1856 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
1857
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001858 // Ownership for the class path files.
1859 std::vector<std::unique_ptr<const DexFile>> class_path_files_;
1860
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001861 // Not a unique_ptr as we want to just exit on non-debug builds, not bringing the runtime down
1862 // in an orderly fashion. The destructor takes care of deleting this.
1863 Runtime* runtime_;
1864
1865 size_t thread_count_;
1866 uint64_t start_ns_;
1867 std::unique_ptr<WatchDog> watchdog_;
1868 std::unique_ptr<File> oat_file_;
1869 std::string oat_stripped_;
1870 std::string oat_unstripped_;
1871 std::string oat_location_;
1872 std::string oat_filename_;
1873 int oat_fd_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001874 std::vector<const char*> dex_filenames_;
1875 std::vector<const char*> dex_locations_;
1876 int zip_fd_;
1877 std::string zip_location_;
1878 std::string boot_image_option_;
1879 std::vector<const char*> runtime_args_;
1880 std::string image_filename_;
1881 uintptr_t image_base_;
1882 const char* image_classes_zip_filename_;
1883 const char* image_classes_filename_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08001884 const char* compiled_classes_zip_filename_;
1885 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001886 const char* compiled_methods_zip_filename_;
1887 const char* compiled_methods_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07001888 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
1889 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001890 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001891 bool image_;
1892 std::unique_ptr<ImageWriter> image_writer_;
1893 bool is_host_;
1894 std::string android_root_;
1895 std::vector<const DexFile*> dex_files_;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001896 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001897 std::unique_ptr<CompilerDriver> driver_;
1898 std::vector<std::string> verbose_methods_;
1899 bool dump_stats_;
1900 bool dump_passes_;
1901 bool dump_timing_;
1902 bool dump_slow_timing_;
David Brazdil866c0312015-01-13 21:21:31 +00001903 std::string dump_cfg_file_name_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001904 std::string swap_file_name_;
1905 int swap_fd_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001906 std::string profile_file_; // Profile file to use
1907 TimingLogger* timings_;
1908 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Andreas Gampedbfe2542014-11-25 22:21:42 -08001909 std::unique_ptr<std::ostream> init_failure_output_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001910
1911 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
1912};
1913
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001914static void b13564922() {
1915#if defined(__linux__) && defined(__arm__)
1916 int major, minor;
1917 struct utsname uts;
1918 if (uname(&uts) != -1 &&
1919 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
1920 ((major < 3) || ((major == 3) && (minor < 4)))) {
1921 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
1922 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
1923 int old_personality = personality(0xffffffff);
1924 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
1925 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
1926 if (new_personality == -1) {
1927 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
1928 }
1929 }
1930 }
1931#endif
1932}
1933
Andreas Gampe10e477d2014-11-19 12:57:42 -08001934static int CompileImage(Dex2Oat& dex2oat) {
1935 dex2oat.Compile();
1936
1937 // Create the boot.oat.
1938 if (!dex2oat.CreateOatFile()) {
Andreas Gampea650e702014-12-03 14:28:02 -08001939 dex2oat.EraseOatFile();
Andreas Gampe10e477d2014-11-19 12:57:42 -08001940 return EXIT_FAILURE;
1941 }
1942
1943 // Flush and close the boot.oat. We always expect the output file by name, and it will be
1944 // re-opened from the unstripped name.
1945 if (!dex2oat.FlushCloseOatFile()) {
1946 return EXIT_FAILURE;
1947 }
1948
1949 // Creates the boot.art and patches the boot.oat.
1950 if (!dex2oat.HandleImage()) {
1951 return EXIT_FAILURE;
1952 }
1953
1954 // When given --host, finish early without stripping.
1955 if (dex2oat.IsHost()) {
1956 dex2oat.DumpTiming();
1957 return EXIT_SUCCESS;
1958 }
1959
1960 // Copy unstripped to stripped location, if necessary.
1961 if (!dex2oat.CopyUnstrippedToStripped()) {
1962 return EXIT_FAILURE;
1963 }
1964
Andreas Gampe10e477d2014-11-19 12:57:42 -08001965 // FlushClose again, as stripping might have re-opened the oat file.
1966 if (!dex2oat.FlushCloseOatFile()) {
1967 return EXIT_FAILURE;
1968 }
1969
1970 dex2oat.DumpTiming();
1971 return EXIT_SUCCESS;
1972}
1973
1974static int CompileApp(Dex2Oat& dex2oat) {
1975 dex2oat.Compile();
1976
1977 // Create the app oat.
1978 if (!dex2oat.CreateOatFile()) {
Andreas Gampea650e702014-12-03 14:28:02 -08001979 dex2oat.EraseOatFile();
Andreas Gampe10e477d2014-11-19 12:57:42 -08001980 return EXIT_FAILURE;
1981 }
1982
1983 // Do not close the oat file here. We might haven gotten the output file by file descriptor,
1984 // which we would lose.
1985 if (!dex2oat.FlushOatFile()) {
1986 return EXIT_FAILURE;
1987 }
1988
1989 // When given --host, finish early without stripping.
1990 if (dex2oat.IsHost()) {
1991 if (!dex2oat.FlushCloseOatFile()) {
1992 return EXIT_FAILURE;
1993 }
1994
1995 dex2oat.DumpTiming();
1996 return EXIT_SUCCESS;
1997 }
1998
1999 // Copy unstripped to stripped location, if necessary. This will implicitly flush & close the
2000 // unstripped version. If this is given, we expect to be able to open writable files by name.
2001 if (!dex2oat.CopyUnstrippedToStripped()) {
2002 return EXIT_FAILURE;
2003 }
2004
Andreas Gampe10e477d2014-11-19 12:57:42 -08002005 // Flush and close the file.
2006 if (!dex2oat.FlushCloseOatFile()) {
2007 return EXIT_FAILURE;
2008 }
2009
2010 dex2oat.DumpTiming();
2011 return EXIT_SUCCESS;
2012}
2013
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002014static int dex2oat(int argc, char** argv) {
2015 b13564922();
2016
2017 TimingLogger timings("compiler", false, false);
2018
2019 Dex2Oat dex2oat(&timings);
2020
2021 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
2022 dex2oat.ParseArgs(argc, argv);
2023
2024 // Check early that the result of compilation can be written
2025 if (!dex2oat.OpenFile()) {
2026 return EXIT_FAILURE;
2027 }
2028
Andreas Gampe046c7062015-05-18 23:22:54 -07002029 // Print the complete line when any of the following is true:
2030 // 1) Debug build
2031 // 2) Compiling an image
2032 // 3) Compiling with --host
2033 // 4) Compiling on the host (not a target build)
2034 // Otherwise, print a stripped command line.
2035 if (kIsDebugBuild || dex2oat.IsImage() || dex2oat.IsHost() || !kIsTargetBuild) {
2036 LOG(INFO) << CommandLine();
2037 } else {
2038 LOG(INFO) << StrippedCommandLine();
2039 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002040
2041 if (!dex2oat.Setup()) {
Andreas Gampea650e702014-12-03 14:28:02 -08002042 dex2oat.EraseOatFile();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002043 return EXIT_FAILURE;
2044 }
2045
Andreas Gampe10e477d2014-11-19 12:57:42 -08002046 if (dex2oat.IsImage()) {
2047 return CompileImage(dex2oat);
2048 } else {
2049 return CompileApp(dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002050 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002051}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002052} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07002053
2054int main(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002055 int result = art::dex2oat(argc, argv);
2056 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
2057 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
2058 // should not destruct the runtime in this case.
Evgenii Stepanov1e133742015-05-20 12:30:59 -07002059 if (!art::kIsDebugBuild && (RUNNING_ON_MEMORY_TOOL == 0)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002060 exit(result);
2061 }
2062 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002063}