blob: b4520e92f37bec739bc466d484bbe0a5100905c1 [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>
Ian Rogers2672a9f2013-09-05 17:24:22 -070021#include <valgrind.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("");
Ian Rogers46398602013-08-20 07:50:36 -0700283 UsageError(" --dump-timing: display a breakdown of where time was spent");
284 UsageError("");
Alex Light53cb16b2014-06-12 11:26:29 -0700285 UsageError(" --include-patch-information: Include patching information so the generated code");
286 UsageError(" can have its base address moved without full recompilation.");
287 UsageError("");
288 UsageError(" --no-include-patch-information: Do not include patching information.");
289 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100290 UsageError(" -g");
291 UsageError(" --generate-debug-info: Generate debug information for native debugging,");
292 UsageError(" such as stack unwinding information, ELF symbols and DWARF sections.");
293 UsageError(" This generates all the available information. Unneeded parts can be");
294 UsageError(" stripped using standard command line tools such as strip or objcopy.");
295 UsageError(" (enabled by default in debug builds, disabled by default otherwise)");
Alex Light78382fa2014-06-06 15:45:32 -0700296 UsageError("");
David Srbecky8363c772015-05-28 16:12:43 +0100297 UsageError(" --no-generate-debug-info: Do not generate debug information for native debugging.");
David Srbecky8dc73242015-04-12 11:40:39 +0100298 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700299 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
300 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
301 UsageError(" Use a separate --runtime-arg switch for each argument.");
302 UsageError(" Example: --runtime-arg -Xms256m");
Jeff Hao4a200f52014-04-01 14:58:49 -0700303 UsageError("");
Dave Allisond6ed6422014-04-09 23:36:15 +0000304 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700305 UsageError("");
Chao-ying Fucd8ce662014-03-11 14:57:19 -0700306 UsageError(" --print-pass-names: print a list of pass names");
307 UsageError("");
308 UsageError(" --disable-passes=<pass-names>: disable one or more passes separated by comma.");
309 UsageError(" Example: --disable-passes=UseCount,BBOptimizations");
310 UsageError("");
Razvan A Lupusorubd25d4b2014-07-02 18:16:51 -0700311 UsageError(" --print-pass-options: print a list of passes that have configurable options along "
312 "with the setting.");
313 UsageError(" Will print default if no overridden setting exists.");
314 UsageError("");
315 UsageError(" --pass-options=Pass1Name:Pass1OptionName:Pass1Option#,"
316 "Pass2Name:Pass2OptionName:Pass2Option#");
317 UsageError(" Used to specify a pass specific option. The setting itself must be integer.");
318 UsageError(" Separator used between options is a comma.");
319 UsageError("");
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800320 UsageError(" --swap-file=<file-name>: specifies a file to use for swap.");
321 UsageError(" Example: --swap-file=/data/tmp/swap.001");
322 UsageError("");
323 UsageError(" --swap-fd=<file-descriptor>: specifies a file to use for swap (by descriptor).");
324 UsageError(" Example: --swap-fd=10");
325 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700326 std::cerr << "See log for usage error information\n";
327 exit(EXIT_FAILURE);
328}
329
Brian Carlstrom7940e442013-07-12 13:46:57 -0700330// The primary goal of the watchdog is to prevent stuck build servers
331// during development when fatal aborts lead to a cascade of failures
332// that result in a deadlock.
333class WatchDog {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800334// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using LOG which uses locks
Brian Carlstrom7940e442013-07-12 13:46:57 -0700335#undef CHECK_PTHREAD_CALL
336#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
337 do { \
338 int rc = call args; \
339 if (rc != 0) { \
340 errno = rc; \
341 std::string message(# call); \
342 message += " failed for "; \
343 message += reason; \
344 Fatal(message); \
345 } \
346 } while (false)
347
348 public:
Brian Carlstrom93ba8932013-07-17 21:31:49 -0700349 explicit WatchDog(bool is_watch_dog_enabled) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700350 is_watch_dog_enabled_ = is_watch_dog_enabled;
351 if (!is_watch_dog_enabled_) {
352 return;
353 }
354 shutting_down_ = false;
355 const char* reason = "dex2oat watch dog thread startup";
Kenny Root51316382014-05-13 14:59:37 -0700356 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
357 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700358 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
359 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
360 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
361 }
362 ~WatchDog() {
363 if (!is_watch_dog_enabled_) {
364 return;
365 }
366 const char* reason = "dex2oat watch dog thread shutdown";
367 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
368 shutting_down_ = true;
369 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
370 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
371
Kenny Root51316382014-05-13 14:59:37 -0700372 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700373
374 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
375 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
376 }
377
378 private:
379 static void* CallBack(void* arg) {
380 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
381 ::art::SetThreadName("dex2oat watch dog");
382 self->Wait();
Kenny Root51316382014-05-13 14:59:37 -0700383 return nullptr;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700384 }
385
Andreas Gampe794ad762015-02-23 08:12:24 -0800386 NO_RETURN static void Fatal(const std::string& message) {
Andreas Gamped687e372015-04-28 23:16:03 -0700387 // TODO: When we can guarantee it won't prevent shutdown in error cases, move to LOG. However,
388 // it's rather easy to hang in unwinding.
389 // LogLine also avoids ART logging lock issues, as it's really only a wrapper around
390 // logcat logging or stderr output.
391 LogMessage::LogLine(__FILE__, __LINE__, LogSeverity::FATAL, message.c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700392 exit(1);
393 }
394
395 void Wait() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700396 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
397 // large.
Andreas Gamped687e372015-04-28 23:16:03 -0700398 constexpr int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700399 timespec timeout_ts;
400 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts);
401 const char* reason = "dex2oat watch dog thread waiting";
402 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
403 while (!shutting_down_) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800404 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_, &timeout_ts));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700405 if (rc == ETIMEDOUT) {
Andreas Gamped687e372015-04-28 23:16:03 -0700406 Fatal(StringPrintf("dex2oat did not finish after %" PRId64 " seconds",
407 kWatchDogTimeoutSeconds));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700408 } else if (rc != 0) {
409 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
410 strerror(errno)));
411 Fatal(message.c_str());
412 }
413 }
414 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
415 }
416
417 // 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 -0700418 // Debug builds are slower so they have larger timeouts.
Andreas Gamped687e372015-04-28 23:16:03 -0700419 static constexpr int64_t kSlowdownFactor = kIsDebugBuild ? 5U : 1U;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800420
Andreas Gamped687e372015-04-28 23:16:03 -0700421 // 10 minutes scaled by kSlowdownFactor.
422 static constexpr int64_t kWatchDogTimeoutSeconds = kSlowdownFactor * 10 * 60;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700423
424 bool is_watch_dog_enabled_;
425 bool shutting_down_;
426 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
427 pthread_mutex_t mutex_;
428 pthread_cond_t cond_;
429 pthread_attr_t attr_;
430 pthread_t pthread_;
431};
Brian Carlstrom7940e442013-07-12 13:46:57 -0700432
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800433static void ParseStringAfterChar(const std::string& s, char c, std::string* parsed_value) {
Calin Juravlec1b643c2014-05-30 23:44:11 +0100434 std::string::size_type colon = s.find(c);
435 if (colon == std::string::npos) {
436 Usage("Missing char %c in option %s\n", c, s.c_str());
437 }
438 // Add one to remove the char we were trimming until.
439 *parsed_value = s.substr(colon + 1);
440}
441
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800442static void ParseDouble(const std::string& option, char after_char, double min, double max,
443 double* parsed_value) {
Calin Juravlec1b643c2014-05-30 23:44:11 +0100444 std::string substring;
445 ParseStringAfterChar(option, after_char, &substring);
446 bool sane_val = true;
447 double value;
448 if (false) {
449 // TODO: this doesn't seem to work on the emulator. b/15114595
450 std::stringstream iss(substring);
451 iss >> value;
452 // Ensure that we have a value, there was no cruft after it and it satisfies a sensible range.
453 sane_val = iss.eof() && (value >= min) && (value <= max);
454 } else {
455 char* end = nullptr;
456 value = strtod(substring.c_str(), &end);
457 sane_val = *end == '\0' && value >= min && value <= max;
458 }
459 if (!sane_val) {
460 Usage("Invalid double value %s for option %s\n", substring.c_str(), option.c_str());
461 }
462 *parsed_value = value;
463}
464
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800465static constexpr size_t kMinDexFilesForSwap = 2;
466static constexpr size_t kMinDexFileCumulativeSizeForSwap = 20 * MB;
467
468static bool UseSwap(bool is_image, std::vector<const DexFile*>& dex_files) {
469 if (is_image) {
470 // Don't use swap, we know generation should succeed, and we don't want to slow it down.
471 return false;
472 }
473 if (dex_files.size() < kMinDexFilesForSwap) {
474 // If there are less dex files than the threshold, assume it's gonna be fine.
475 return false;
476 }
477 size_t dex_files_size = 0;
478 for (const auto* dex_file : dex_files) {
479 dex_files_size += dex_file->GetHeader().file_size_;
480 }
481 return dex_files_size >= kMinDexFileCumulativeSizeForSwap;
482}
483
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800484class Dex2Oat FINAL {
485 public:
486 explicit Dex2Oat(TimingLogger* timings) :
Elliott Hughes956af0f2014-12-11 14:34:28 -0800487 compiler_kind_(kUseOptimizingCompiler ? Compiler::kOptimizing : Compiler::kQuick),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800488 instruction_set_(kRuntimeISA),
489 // Take the default set of instruction features from the build.
490 method_inliner_map_(),
491 runtime_(nullptr),
492 thread_count_(sysconf(_SC_NPROCESSORS_CONF)),
493 start_ns_(NanoTime()),
494 oat_fd_(-1),
495 zip_fd_(-1),
496 image_base_(0U),
497 image_classes_zip_filename_(nullptr),
498 image_classes_filename_(nullptr),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800499 compiled_classes_zip_filename_(nullptr),
500 compiled_classes_filename_(nullptr),
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700501 compiled_methods_zip_filename_(nullptr),
502 compiled_methods_filename_(nullptr),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800503 image_(false),
504 is_host_(false),
505 dump_stats_(false),
506 dump_passes_(false),
507 dump_timing_(false),
508 dump_slow_timing_(kIsDebugBuild),
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800509 swap_fd_(-1),
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800510 timings_(timings) {}
511
512 ~Dex2Oat() {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800513 // Free opened dex files before deleting the runtime_, because ~DexFile
514 // uses MemMap, which is shut down by ~Runtime.
515 class_path_files_.clear();
516 opened_dex_files_.clear();
517
518 // Log completion time before deleting the runtime_, because this accesses
519 // the runtime.
520 LogCompletionTime();
521
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800522 if (kIsDebugBuild || (RUNNING_ON_VALGRIND != 0)) {
523 delete runtime_; // See field declaration for why this is manual.
Vladimir Markof94b7812014-06-05 15:48:04 +0100524 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700525 }
526
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800527 // Parse the arguments from the command line. In case of an unrecognized option or impossible
528 // values/combinations, a usage error will be displayed and exit() is called. Thus, if the method
529 // returns, arguments have been successfully parsed.
530 void ParseArgs(int argc, char** argv) {
531 original_argc = argc;
532 original_argv = argv;
Dave Allison70202782013-10-22 17:52:19 -0700533
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800534 InitLogging(argv);
Dave Allison70202782013-10-22 17:52:19 -0700535
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800536 // Skip over argv[0].
537 argv++;
538 argc--;
Dave Allison70202782013-10-22 17:52:19 -0700539
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800540 if (argc == 0) {
541 Usage("No arguments specified");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700542 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800543
544 std::string oat_symbols;
545 std::string boot_image_filename;
546 const char* compiler_filter_string = nullptr;
547 bool compile_pic = false;
548 int huge_method_threshold = CompilerOptions::kDefaultHugeMethodThreshold;
549 int large_method_threshold = CompilerOptions::kDefaultLargeMethodThreshold;
550 int small_method_threshold = CompilerOptions::kDefaultSmallMethodThreshold;
551 int tiny_method_threshold = CompilerOptions::kDefaultTinyMethodThreshold;
552 int num_dex_methods_threshold = CompilerOptions::kDefaultNumDexMethodsThreshold;
553
554 // Profile file to use
555 double top_k_profile_threshold = CompilerOptions::kDefaultTopKProfileThreshold;
556
Andreas Gampe7b2f09e2015-03-02 14:07:33 -0800557 bool debuggable = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800558 bool include_patch_information = CompilerOptions::kDefaultIncludePatchInformation;
David Srbecky8363c772015-05-28 16:12:43 +0100559 bool generate_debug_info = kIsDebugBuild;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800560 bool watch_dog_enabled = true;
Andreas Gampe6cf49e52015-03-05 13:08:45 -0800561 bool abort_on_hard_verifier_error = false;
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000562 bool requested_specific_compiler = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800563
Mathieu Chartier5bdab122015-01-26 18:30:19 -0800564 PassManagerOptions pass_manager_options;
565
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800566 std::string error_msg;
567
568 for (int i = 0; i < argc; i++) {
569 const StringPiece option(argv[i]);
570 const bool log_options = false;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700571 if (log_options) {
572 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
573 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800574 if (option.starts_with("--dex-file=")) {
575 dex_filenames_.push_back(option.substr(strlen("--dex-file=")).data());
576 } else if (option.starts_with("--dex-location=")) {
577 dex_locations_.push_back(option.substr(strlen("--dex-location=")).data());
578 } else if (option.starts_with("--zip-fd=")) {
579 const char* zip_fd_str = option.substr(strlen("--zip-fd=")).data();
580 if (!ParseInt(zip_fd_str, &zip_fd_)) {
581 Usage("Failed to parse --zip-fd argument '%s' as an integer", zip_fd_str);
582 }
583 if (zip_fd_ < 0) {
584 Usage("--zip-fd passed a negative value %d", zip_fd_);
585 }
586 } else if (option.starts_with("--zip-location=")) {
587 zip_location_ = option.substr(strlen("--zip-location=")).data();
588 } else if (option.starts_with("--oat-file=")) {
589 oat_filename_ = option.substr(strlen("--oat-file=")).data();
590 } else if (option.starts_with("--oat-symbols=")) {
591 oat_symbols = option.substr(strlen("--oat-symbols=")).data();
592 } else if (option.starts_with("--oat-fd=")) {
593 const char* oat_fd_str = option.substr(strlen("--oat-fd=")).data();
594 if (!ParseInt(oat_fd_str, &oat_fd_)) {
595 Usage("Failed to parse --oat-fd argument '%s' as an integer", oat_fd_str);
596 }
597 if (oat_fd_ < 0) {
598 Usage("--oat-fd passed a negative value %d", oat_fd_);
599 }
600 } else if (option == "--watch-dog") {
601 watch_dog_enabled = true;
602 } else if (option == "--no-watch-dog") {
603 watch_dog_enabled = false;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800604 } else if (option.starts_with("-j")) {
605 const char* thread_count_str = option.substr(strlen("-j")).data();
606 if (!ParseUint(thread_count_str, &thread_count_)) {
607 Usage("Failed to parse -j argument '%s' as an integer", thread_count_str);
608 }
609 } else if (option.starts_with("--oat-location=")) {
610 oat_location_ = option.substr(strlen("--oat-location=")).data();
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800611 } else if (option.starts_with("--image=")) {
612 image_filename_ = option.substr(strlen("--image=")).data();
613 } else if (option.starts_with("--image-classes=")) {
614 image_classes_filename_ = option.substr(strlen("--image-classes=")).data();
615 } else if (option.starts_with("--image-classes-zip=")) {
616 image_classes_zip_filename_ = option.substr(strlen("--image-classes-zip=")).data();
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800617 } else if (option.starts_with("--compiled-classes=")) {
618 compiled_classes_filename_ = option.substr(strlen("--compiled-classes=")).data();
619 } else if (option.starts_with("--compiled-classes-zip=")) {
620 compiled_classes_zip_filename_ = option.substr(strlen("--compiled-classes-zip=")).data();
Andreas Gampe70bef0d2015-04-15 02:37:28 -0700621 } else if (option.starts_with("--compiled-methods=")) {
622 compiled_methods_filename_ = option.substr(strlen("--compiled-methods=")).data();
623 } else if (option.starts_with("--compiled-methods-zip=")) {
624 compiled_methods_zip_filename_ = option.substr(strlen("--compiled-methods-zip=")).data();
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800625 } else if (option.starts_with("--base=")) {
626 const char* image_base_str = option.substr(strlen("--base=")).data();
627 char* end;
628 image_base_ = strtoul(image_base_str, &end, 16);
629 if (end == image_base_str || *end != '\0') {
630 Usage("Failed to parse hexadecimal value for option %s", option.data());
631 }
632 } else if (option.starts_with("--boot-image=")) {
633 boot_image_filename = option.substr(strlen("--boot-image=")).data();
634 } else if (option.starts_with("--android-root=")) {
635 android_root_ = option.substr(strlen("--android-root=")).data();
636 } else if (option.starts_with("--instruction-set=")) {
637 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
638 // StringPiece is not necessarily zero-terminated, so need to make a copy and ensure it.
Dan Albert6fc59ab2014-12-11 14:09:51 -0800639 std::unique_ptr<char[]> buf(new char[instruction_set_str.length() + 1]);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800640 strncpy(buf.get(), instruction_set_str.data(), instruction_set_str.length());
641 buf.get()[instruction_set_str.length()] = 0;
642 instruction_set_ = GetInstructionSetFromString(buf.get());
643 // arm actually means thumb2.
644 if (instruction_set_ == InstructionSet::kArm) {
645 instruction_set_ = InstructionSet::kThumb2;
646 }
647 } else if (option.starts_with("--instruction-set-variant=")) {
648 StringPiece str = option.substr(strlen("--instruction-set-variant=")).data();
649 instruction_set_features_.reset(
650 InstructionSetFeatures::FromVariant(instruction_set_, str.as_string(), &error_msg));
651 if (instruction_set_features_.get() == nullptr) {
652 Usage("%s", error_msg.c_str());
653 }
654 } else if (option.starts_with("--instruction-set-features=")) {
655 StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800656 if (instruction_set_features_.get() == nullptr) {
Ian Rogersd582fa42014-11-05 23:46:43 -0800657 instruction_set_features_.reset(
658 InstructionSetFeatures::FromVariant(instruction_set_, "default", &error_msg));
659 if (instruction_set_features_.get() == nullptr) {
660 Usage("Problem initializing default instruction set features variant: %s",
661 error_msg.c_str());
662 }
663 }
664 instruction_set_features_.reset(
665 instruction_set_features_->AddFeaturesFromString(str.as_string(), &error_msg));
666 if (instruction_set_features_.get() == nullptr) {
667 Usage("Error parsing '%s': %s", option.data(), error_msg.c_str());
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800668 }
669 } else if (option.starts_with("--compiler-backend=")) {
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000670 requested_specific_compiler = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800671 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
672 if (backend_str == "Quick") {
673 compiler_kind_ = Compiler::kQuick;
674 } else if (backend_str == "Optimizing") {
675 compiler_kind_ = Compiler::kOptimizing;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800676 } else {
677 Usage("Unknown compiler backend: %s", backend_str.data());
678 }
679 } else if (option.starts_with("--compiler-filter=")) {
680 compiler_filter_string = option.substr(strlen("--compiler-filter=")).data();
681 } else if (option == "--compile-pic") {
682 compile_pic = true;
683 } else if (option.starts_with("--huge-method-max=")) {
684 const char* threshold = option.substr(strlen("--huge-method-max=")).data();
685 if (!ParseInt(threshold, &huge_method_threshold)) {
686 Usage("Failed to parse --huge-method-max '%s' as an integer", threshold);
687 }
688 if (huge_method_threshold < 0) {
689 Usage("--huge-method-max passed a negative value %s", huge_method_threshold);
690 }
691 } else if (option.starts_with("--large-method-max=")) {
692 const char* threshold = option.substr(strlen("--large-method-max=")).data();
693 if (!ParseInt(threshold, &large_method_threshold)) {
694 Usage("Failed to parse --large-method-max '%s' as an integer", threshold);
695 }
696 if (large_method_threshold < 0) {
697 Usage("--large-method-max passed a negative value %s", large_method_threshold);
698 }
699 } else if (option.starts_with("--small-method-max=")) {
700 const char* threshold = option.substr(strlen("--small-method-max=")).data();
701 if (!ParseInt(threshold, &small_method_threshold)) {
702 Usage("Failed to parse --small-method-max '%s' as an integer", threshold);
703 }
704 if (small_method_threshold < 0) {
705 Usage("--small-method-max passed a negative value %s", small_method_threshold);
706 }
707 } else if (option.starts_with("--tiny-method-max=")) {
708 const char* threshold = option.substr(strlen("--tiny-method-max=")).data();
709 if (!ParseInt(threshold, &tiny_method_threshold)) {
710 Usage("Failed to parse --tiny-method-max '%s' as an integer", threshold);
711 }
712 if (tiny_method_threshold < 0) {
713 Usage("--tiny-method-max passed a negative value %s", tiny_method_threshold);
714 }
715 } else if (option.starts_with("--num-dex-methods=")) {
716 const char* threshold = option.substr(strlen("--num-dex-methods=")).data();
717 if (!ParseInt(threshold, &num_dex_methods_threshold)) {
718 Usage("Failed to parse --num-dex-methods '%s' as an integer", threshold);
719 }
720 if (num_dex_methods_threshold < 0) {
721 Usage("--num-dex-methods passed a negative value %s", num_dex_methods_threshold);
722 }
723 } else if (option == "--host") {
724 is_host_ = true;
725 } else if (option == "--runtime-arg") {
726 if (++i >= argc) {
727 Usage("Missing required argument for --runtime-arg");
728 }
729 if (log_options) {
730 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
731 }
732 runtime_args_.push_back(argv[i]);
733 } else if (option == "--dump-timing") {
734 dump_timing_ = true;
735 } else if (option == "--dump-passes") {
736 dump_passes_ = true;
David Brazdil866c0312015-01-13 21:21:31 +0000737 } else if (option.starts_with("--dump-cfg=")) {
738 dump_cfg_file_name_ = option.substr(strlen("--dump-cfg=")).data();
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800739 } else if (option == "--dump-stats") {
740 dump_stats_ = true;
David Srbecky8363c772015-05-28 16:12:43 +0100741 } else if (option == "--generate-debug-info" || option == "-g") {
742 generate_debug_info = true;
743 } else if (option == "--no-generate-debug-info") {
744 generate_debug_info = false;
Andreas Gampe7b2f09e2015-03-02 14:07:33 -0800745 } else if (option == "--debuggable") {
746 debuggable = true;
David Srbecky8363c772015-05-28 16:12:43 +0100747 generate_debug_info = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800748 } else if (option.starts_with("--profile-file=")) {
749 profile_file_ = option.substr(strlen("--profile-file=")).data();
750 VLOG(compiler) << "dex2oat: profile file is " << profile_file_;
751 } else if (option == "--no-profile-file") {
752 // No profile
753 } else if (option.starts_with("--top-k-profile-threshold=")) {
754 ParseDouble(option.data(), '=', 0.0, 100.0, &top_k_profile_threshold);
755 } else if (option == "--print-pass-names") {
Mathieu Chartier5bdab122015-01-26 18:30:19 -0800756 pass_manager_options.SetPrintPassNames(true);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800757 } else if (option.starts_with("--disable-passes=")) {
Mathieu Chartier5bdab122015-01-26 18:30:19 -0800758 const std::string disable_passes = option.substr(strlen("--disable-passes=")).data();
759 pass_manager_options.SetDisablePassList(disable_passes);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800760 } else if (option.starts_with("--print-passes=")) {
Mathieu Chartier5bdab122015-01-26 18:30:19 -0800761 const std::string print_passes = option.substr(strlen("--print-passes=")).data();
762 pass_manager_options.SetPrintPassList(print_passes);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800763 } else if (option == "--print-all-passes") {
Mathieu Chartier5bdab122015-01-26 18:30:19 -0800764 pass_manager_options.SetPrintAllPasses();
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800765 } else if (option.starts_with("--dump-cfg-passes=")) {
Mathieu Chartier5bdab122015-01-26 18:30:19 -0800766 const std::string dump_passes_string = option.substr(strlen("--dump-cfg-passes=")).data();
767 pass_manager_options.SetDumpPassList(dump_passes_string);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800768 } else if (option == "--print-pass-options") {
Mathieu Chartier5bdab122015-01-26 18:30:19 -0800769 pass_manager_options.SetPrintPassOptions(true);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800770 } else if (option.starts_with("--pass-options=")) {
Mathieu Chartier5bdab122015-01-26 18:30:19 -0800771 const std::string options = option.substr(strlen("--pass-options=")).data();
772 pass_manager_options.SetOverriddenPassOptions(options);
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800773 } else if (option == "--include-patch-information") {
774 include_patch_information = true;
775 } else if (option == "--no-include-patch-information") {
776 include_patch_information = false;
777 } else if (option.starts_with("--verbose-methods=")) {
Brian Carlstrom95b033b2014-12-03 22:29:37 -0800778 // TODO: rather than switch off compiler logging, make all VLOG(compiler) messages
779 // conditional on having verbost methods.
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800780 gLogVerbosity.compiler = false;
781 Split(option.substr(strlen("--verbose-methods=")).ToString(), ',', &verbose_methods_);
Andreas Gampedbfe2542014-11-25 22:21:42 -0800782 } else if (option.starts_with("--dump-init-failures=")) {
783 std::string file_name = option.substr(strlen("--dump-init-failures=")).data();
784 init_failure_output_.reset(new std::ofstream(file_name));
785 if (init_failure_output_.get() == nullptr) {
786 LOG(ERROR) << "Failed to allocate ofstream";
787 } else if (init_failure_output_->fail()) {
788 LOG(ERROR) << "Failed to open " << file_name << " for writing the initialization "
789 << "failures.";
790 init_failure_output_.reset();
791 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -0800792 } else if (option.starts_with("--swap-file=")) {
793 swap_file_name_ = option.substr(strlen("--swap-file=")).data();
794 } else if (option.starts_with("--swap-fd=")) {
795 const char* swap_fd_str = option.substr(strlen("--swap-fd=")).data();
796 if (!ParseInt(swap_fd_str, &swap_fd_)) {
797 Usage("Failed to parse --swap-fd argument '%s' as an integer", swap_fd_str);
798 }
799 if (swap_fd_ < 0) {
800 Usage("--swap-fd passed a negative value %d", swap_fd_);
801 }
Andreas Gampe6cf49e52015-03-05 13:08:45 -0800802 } else if (option == "--abort-on-hard-verifier-error") {
803 abort_on_hard_verifier_error = true;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800804 } else {
805 Usage("Unknown argument %s", option.data());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700806 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800807 }
808
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +0000809 image_ = (!image_filename_.empty());
810 if (!requested_specific_compiler && !kUseOptimizingCompiler) {
811 // If no specific compiler is requested, the current behavior is
812 // to compile the boot image with Quick, and the rest with Optimizing.
813 compiler_kind_ = image_ ? Compiler::kQuick : Compiler::kOptimizing;
814 }
815
Nicolas Geoffray9bb492a2014-11-25 23:42:00 +0000816 if (compiler_kind_ == Compiler::kOptimizing) {
817 // Optimizing only supports PIC mode.
818 compile_pic = true;
819 }
820
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800821 if (oat_filename_.empty() && oat_fd_ == -1) {
822 Usage("Output must be supplied with either --oat-file or --oat-fd");
823 }
824
825 if (!oat_filename_.empty() && oat_fd_ != -1) {
826 Usage("--oat-file should not be used with --oat-fd");
827 }
828
829 if (!oat_symbols.empty() && oat_fd_ != -1) {
830 Usage("--oat-symbols should not be used with --oat-fd");
831 }
832
833 if (!oat_symbols.empty() && is_host_) {
834 Usage("--oat-symbols should not be used with --host");
835 }
836
837 if (oat_fd_ != -1 && !image_filename_.empty()) {
838 Usage("--oat-fd should not be used with --image");
839 }
840
841 if (android_root_.empty()) {
842 const char* android_root_env_var = getenv("ANDROID_ROOT");
843 if (android_root_env_var == nullptr) {
844 Usage("--android-root unspecified and ANDROID_ROOT not set");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700845 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800846 android_root_ += android_root_env_var;
847 }
848
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800849 if (!image_ && boot_image_filename.empty()) {
850 boot_image_filename += android_root_;
851 boot_image_filename += "/framework/boot.art";
852 }
853 if (!boot_image_filename.empty()) {
854 boot_image_option_ += "-Ximage:";
855 boot_image_option_ += boot_image_filename;
856 }
857
858 if (image_classes_filename_ != nullptr && !image_) {
859 Usage("--image-classes should only be used with --image");
860 }
861
862 if (image_classes_filename_ != nullptr && !boot_image_option_.empty()) {
863 Usage("--image-classes should not be used with --boot-image");
864 }
865
866 if (image_classes_zip_filename_ != nullptr && image_classes_filename_ == nullptr) {
867 Usage("--image-classes-zip should be used with --image-classes");
868 }
869
Andreas Gampe4bf3ae92014-11-11 13:28:29 -0800870 if (compiled_classes_filename_ != nullptr && !image_) {
871 Usage("--compiled-classes should only be used with --image");
872 }
873
874 if (compiled_classes_filename_ != nullptr && !boot_image_option_.empty()) {
875 Usage("--compiled-classes should not be used with --boot-image");
876 }
877
878 if (compiled_classes_zip_filename_ != nullptr && compiled_classes_filename_ == nullptr) {
879 Usage("--compiled-classes-zip should be used with --compiled-classes");
880 }
881
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800882 if (dex_filenames_.empty() && zip_fd_ == -1) {
883 Usage("Input must be supplied with either --dex-file or --zip-fd");
884 }
885
886 if (!dex_filenames_.empty() && zip_fd_ != -1) {
887 Usage("--dex-file should not be used with --zip-fd");
888 }
889
890 if (!dex_filenames_.empty() && !zip_location_.empty()) {
891 Usage("--dex-file should not be used with --zip-location");
892 }
893
894 if (dex_locations_.empty()) {
895 for (const char* dex_file_name : dex_filenames_) {
896 dex_locations_.push_back(dex_file_name);
897 }
898 } else if (dex_locations_.size() != dex_filenames_.size()) {
899 Usage("--dex-location arguments do not match --dex-file arguments");
900 }
901
902 if (zip_fd_ != -1 && zip_location_.empty()) {
903 Usage("--zip-location should be supplied with --zip-fd");
904 }
905
906 if (boot_image_option_.empty()) {
907 if (image_base_ == 0) {
908 Usage("Non-zero --base not specified");
909 }
910 }
911
912 oat_stripped_ = oat_filename_;
913 if (!oat_symbols.empty()) {
914 oat_unstripped_ = oat_symbols;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700915 } else {
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800916 oat_unstripped_ = oat_filename_;
917 }
918
919 // If no instruction set feature was given, use the default one for the target
920 // instruction set.
921 if (instruction_set_features_.get() == nullptr) {
922 instruction_set_features_.reset(
Ian Rogersd582fa42014-11-05 23:46:43 -0800923 InstructionSetFeatures::FromVariant(instruction_set_, "default", &error_msg));
924 if (instruction_set_features_.get() == nullptr) {
925 Usage("Problem initializing default instruction set features variant: %s",
926 error_msg.c_str());
927 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800928 }
929
930 if (instruction_set_ == kRuntimeISA) {
931 std::unique_ptr<const InstructionSetFeatures> runtime_features(
932 InstructionSetFeatures::FromCppDefines());
933 if (!instruction_set_features_->Equals(runtime_features.get())) {
934 LOG(WARNING) << "Mismatch between dex2oat instruction set features ("
935 << *instruction_set_features_ << ") and those of dex2oat executable ("
936 << *runtime_features <<") for the command line:\n"
937 << CommandLine();
938 }
939 }
940
941 if (compiler_filter_string == nullptr) {
Douglas Leung027f0ff2015-02-27 19:05:03 -0800942 compiler_filter_string = "speed";
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800943 }
Maja Gagic6ea651f2015-02-24 16:55:04 +0100944
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800945 CHECK(compiler_filter_string != nullptr);
946 CompilerOptions::CompilerFilter compiler_filter = CompilerOptions::kDefaultCompilerFilter;
947 if (strcmp(compiler_filter_string, "verify-none") == 0) {
948 compiler_filter = CompilerOptions::kVerifyNone;
949 } else if (strcmp(compiler_filter_string, "interpret-only") == 0) {
950 compiler_filter = CompilerOptions::kInterpretOnly;
Mathieu Chartiere86deef2015-03-19 13:43:37 -0700951 } else if (strcmp(compiler_filter_string, "verify-at-runtime") == 0) {
952 compiler_filter = CompilerOptions::kVerifyAtRuntime;
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800953 } else if (strcmp(compiler_filter_string, "space") == 0) {
954 compiler_filter = CompilerOptions::kSpace;
955 } else if (strcmp(compiler_filter_string, "balanced") == 0) {
956 compiler_filter = CompilerOptions::kBalanced;
957 } else if (strcmp(compiler_filter_string, "speed") == 0) {
958 compiler_filter = CompilerOptions::kSpeed;
959 } else if (strcmp(compiler_filter_string, "everything") == 0) {
960 compiler_filter = CompilerOptions::kEverything;
961 } else if (strcmp(compiler_filter_string, "time") == 0) {
962 compiler_filter = CompilerOptions::kTime;
963 } else {
964 Usage("Unknown --compiler-filter value %s", compiler_filter_string);
965 }
966
967 // Checks are all explicit until we know the architecture.
968 bool implicit_null_checks = false;
969 bool implicit_so_checks = false;
970 bool implicit_suspend_checks = false;
971 // Set the compilation target's implicit checks options.
972 switch (instruction_set_) {
973 case kArm:
974 case kThumb2:
975 case kArm64:
976 case kX86:
977 case kX86_64:
978 implicit_null_checks = true;
979 implicit_so_checks = true;
980 break;
981
982 default:
983 // Defaults are correct.
984 break;
985 }
986
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800987 compiler_options_.reset(new CompilerOptions(compiler_filter,
988 huge_method_threshold,
989 large_method_threshold,
990 small_method_threshold,
991 tiny_method_threshold,
992 num_dex_methods_threshold,
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800993 include_patch_information,
994 top_k_profile_threshold,
Andreas Gampe7b2f09e2015-03-02 14:07:33 -0800995 debuggable,
David Srbecky8363c772015-05-28 16:12:43 +0100996 generate_debug_info,
Andreas Gampe88ec7f42014-11-05 10:18:32 -0800997 implicit_null_checks,
998 implicit_so_checks,
999 implicit_suspend_checks,
1000 compile_pic,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001001 verbose_methods_.empty() ?
1002 nullptr :
Andreas Gampedbfe2542014-11-25 22:21:42 -08001003 &verbose_methods_,
Mathieu Chartier5bdab122015-01-26 18:30:19 -08001004 new PassManagerOptions(pass_manager_options),
Andreas Gampe6cf49e52015-03-05 13:08:45 -08001005 init_failure_output_.get(),
1006 abort_on_hard_verifier_error));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001007
1008 // Done with usage checks, enable watchdog if requested
1009 if (watch_dog_enabled) {
1010 watchdog_.reset(new WatchDog(true));
1011 }
1012
1013 // Fill some values into the key-value store for the oat header.
1014 key_value_store_.reset(new SafeMap<std::string, std::string>());
1015
1016 // Insert some compiler things.
1017 {
1018 std::ostringstream oss;
1019 for (int i = 0; i < argc; ++i) {
1020 if (i > 0) {
1021 oss << ' ';
1022 }
1023 oss << argv[i];
1024 }
1025 key_value_store_->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1026 oss.str(""); // Reset.
1027 oss << kRuntimeISA;
1028 key_value_store_->Put(OatHeader::kDex2OatHostKey, oss.str());
Sebastien Hertz0de11332015-05-13 12:14:05 +02001029 key_value_store_->Put(OatHeader::kPicKey,
1030 compile_pic ? OatHeader::kTrueValue : OatHeader::kFalseValue);
1031 key_value_store_->Put(OatHeader::kDebuggableKey,
1032 debuggable ? OatHeader::kTrueValue : OatHeader::kFalseValue);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001033 }
1034 }
1035
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001036 // Check whether the oat output file is writable, and open it for later. Also open a swap file,
1037 // if a name is given.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001038 bool OpenFile() {
1039 bool create_file = !oat_unstripped_.empty(); // as opposed to using open file descriptor
1040 if (create_file) {
Andreas Gampe4591ae22015-06-26 18:58:42 -07001041 // We're supposed to create this file. If the file already exists, it may be in use currently.
1042 // We must not change the content of that file, then. So unlink it first.
1043 unlink(oat_unstripped_.c_str());
1044
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001045 oat_file_.reset(OS::CreateEmptyFile(oat_unstripped_.c_str()));
1046 if (oat_location_.empty()) {
1047 oat_location_ = oat_filename_;
1048 }
1049 } else {
Andreas Gampe4303ba92014-11-06 01:00:46 -08001050 oat_file_.reset(new File(oat_fd_, oat_location_, true));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001051 oat_file_->DisableAutoClose();
Andreas Gampe4303ba92014-11-06 01:00:46 -08001052 if (oat_file_->SetLength(0) != 0) {
1053 PLOG(WARNING) << "Truncating oat file " << oat_location_ << " failed.";
1054 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001055 }
1056 if (oat_file_.get() == nullptr) {
1057 PLOG(ERROR) << "Failed to create oat file: " << oat_location_;
1058 return false;
1059 }
1060 if (create_file && fchmod(oat_file_->Fd(), 0644) != 0) {
1061 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_location_;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001062 oat_file_->Erase();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001063 return false;
1064 }
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001065
1066 // Swap file handling.
1067 //
1068 // If the swap fd is not -1, we assume this is the file descriptor of an open but unlinked file
1069 // that we can use for swap.
1070 //
1071 // If the swap fd is -1 and we have a swap-file string, open the given file as a swap file. We
1072 // will immediately unlink to satisfy the swap fd assumption.
1073 if (swap_fd_ == -1 && !swap_file_name_.empty()) {
1074 std::unique_ptr<File> swap_file(OS::CreateEmptyFile(swap_file_name_.c_str()));
1075 if (swap_file.get() == nullptr) {
1076 PLOG(ERROR) << "Failed to create swap file: " << swap_file_name_;
1077 return false;
1078 }
1079 swap_fd_ = swap_file->Fd();
1080 swap_file->MarkUnchecked(); // We don't we to track this, it will be unlinked immediately.
1081 swap_file->DisableAutoClose(); // We'll handle it ourselves, the File object will be
1082 // released immediately.
1083 unlink(swap_file_name_.c_str());
1084 }
1085
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001086 return true;
1087 }
1088
Andreas Gampea650e702014-12-03 14:28:02 -08001089 void EraseOatFile() {
1090 DCHECK(oat_file_.get() != nullptr);
1091 oat_file_->Erase();
1092 oat_file_.reset();
1093 }
1094
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001095 // Set up the environment for compilation. Includes starting the runtime and loading/opening the
1096 // boot class path.
1097 bool Setup() {
1098 TimingLogger::ScopedTiming t("dex2oat Setup", timings_);
1099 RuntimeOptions runtime_options;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001100 art::MemMap::Init(); // For ZipEntry::ExtractToMemMap.
1101 if (boot_image_option_.empty()) {
Richard Uhlerc2752592015-01-02 13:28:22 -08001102 std::string boot_class_path = "-Xbootclasspath:";
1103 boot_class_path += Join(dex_filenames_, ':');
1104 runtime_options.push_back(std::make_pair(boot_class_path, nullptr));
1105 std::string boot_class_path_locations = "-Xbootclasspath-locations:";
1106 boot_class_path_locations += Join(dex_locations_, ':');
1107 runtime_options.push_back(std::make_pair(boot_class_path_locations, nullptr));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001108 } else {
Richard Uhlerc2752592015-01-02 13:28:22 -08001109 runtime_options.push_back(std::make_pair(boot_image_option_, nullptr));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001110 }
1111 for (size_t i = 0; i < runtime_args_.size(); i++) {
1112 runtime_options.push_back(std::make_pair(runtime_args_[i], nullptr));
Brian Carlstrom7940e442013-07-12 13:46:57 -07001113 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001114
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001115 verification_results_.reset(new VerificationResults(compiler_options_.get()));
Andreas Gampe4585f872015-03-27 23:45:15 -07001116 callbacks_.reset(new QuickCompilerCallbacks(
1117 verification_results_.get(),
1118 &method_inliner_map_,
1119 image_ ?
1120 CompilerCallbacks::CallbackMode::kCompileBootImage :
1121 CompilerCallbacks::CallbackMode::kCompileApp));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001122 runtime_options.push_back(std::make_pair("compilercallbacks", callbacks_.get()));
1123 runtime_options.push_back(
1124 std::make_pair("imageinstructionset", GetInstructionSetString(instruction_set_)));
1125
Andreas Gampe1d00add2015-02-27 19:35:46 -08001126 // Only allow no boot image for the runtime if we're compiling one. When we compile an app,
1127 // we don't want fallback mode, it will abort as we do not push a boot classpath (it might
1128 // have been stripped in preopting, anyways).
1129 if (!image_) {
1130 runtime_options.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr));
1131 }
Calin Juravle01aaf6e2015-06-19 22:05:39 +01001132 // Disable libsigchain. We don't don't need it during compilation and it prevents us
1133 // from getting a statically linked version of dex2oat (because of dlsym and RTLD_NEXT).
1134 runtime_options.push_back(std::make_pair("-Xno-sig-chain", nullptr));
Andreas Gampe1d00add2015-02-27 19:35:46 -08001135
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001136 if (!CreateRuntime(runtime_options)) {
1137 return false;
1138 }
1139
1140 // Runtime::Create acquired the mutator_lock_ that is normally given away when we
1141 // Runtime::Start, give it away now so that we don't starve GC.
1142 Thread* self = Thread::Current();
1143 self->TransitionFromRunnableToSuspended(kNative);
1144 // If we're doing the image, override the compiler filter to force full compilation. Must be
1145 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1146 // compilation of class initializers.
1147 // Whilst we're in native take the opportunity to initialize well known classes.
1148 WellKnownClasses::Init(self->GetJniEnv());
1149
1150 // If --image-classes was specified, calculate the full list of classes to include in the image
1151 if (image_classes_filename_ != nullptr) {
1152 std::string error_msg;
1153 if (image_classes_zip_filename_ != nullptr) {
1154 image_classes_.reset(ReadImageClassesFromZip(image_classes_zip_filename_,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001155 image_classes_filename_,
1156 &error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001157 } else {
1158 image_classes_.reset(ReadImageClassesFromFile(image_classes_filename_));
1159 }
1160 if (image_classes_.get() == nullptr) {
1161 LOG(ERROR) << "Failed to create list of image classes from '" << image_classes_filename_ <<
1162 "': " << error_msg;
1163 return false;
1164 }
1165 } else if (image_) {
Andreas Gampeb1fcead2015-04-20 18:53:51 -07001166 image_classes_.reset(new std::unordered_set<std::string>);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001167 }
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08001168 // If --compiled-classes was specified, calculate the full list of classes to compile in the
1169 // image.
1170 if (compiled_classes_filename_ != nullptr) {
1171 std::string error_msg;
1172 if (compiled_classes_zip_filename_ != nullptr) {
1173 compiled_classes_.reset(ReadImageClassesFromZip(compiled_classes_zip_filename_,
1174 compiled_classes_filename_,
1175 &error_msg));
1176 } else {
1177 compiled_classes_.reset(ReadImageClassesFromFile(compiled_classes_filename_));
1178 }
1179 if (compiled_classes_.get() == nullptr) {
1180 LOG(ERROR) << "Failed to create list of compiled classes from '"
1181 << compiled_classes_filename_ << "': " << error_msg;
1182 return false;
1183 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001184 } else {
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08001185 compiled_classes_.reset(nullptr); // By default compile everything.
1186 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001187 // If --compiled-methods was specified, read the methods to compile from the given file(s).
1188 if (compiled_methods_filename_ != nullptr) {
1189 std::string error_msg;
1190 if (compiled_methods_zip_filename_ != nullptr) {
1191 compiled_methods_.reset(ReadCommentedInputFromZip(compiled_methods_zip_filename_,
1192 compiled_methods_filename_,
1193 nullptr, // No post-processing.
1194 &error_msg));
1195 } else {
1196 compiled_methods_.reset(ReadCommentedInputFromFile(compiled_methods_filename_,
1197 nullptr)); // No post-processing.
1198 }
1199 if (compiled_methods_.get() == nullptr) {
1200 LOG(ERROR) << "Failed to create list of compiled methods from '"
1201 << compiled_methods_filename_ << "': " << error_msg;
1202 return false;
1203 }
1204 } else {
1205 compiled_methods_.reset(nullptr); // By default compile everything.
1206 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001207
1208 if (boot_image_option_.empty()) {
1209 dex_files_ = Runtime::Current()->GetClassLinker()->GetBootClassPath();
1210 } else {
1211 if (dex_filenames_.empty()) {
1212 ATRACE_BEGIN("Opening zip archive from file descriptor");
1213 std::string error_msg;
1214 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::OpenFromFd(zip_fd_,
1215 zip_location_.c_str(),
1216 &error_msg));
1217 if (zip_archive.get() == nullptr) {
1218 LOG(ERROR) << "Failed to open zip from file descriptor for '" << zip_location_ << "': "
1219 << error_msg;
1220 return false;
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001221 }
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001222 if (!DexFile::OpenFromZip(*zip_archive.get(), zip_location_, &error_msg, &opened_dex_files_)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001223 LOG(ERROR) << "Failed to open dex from file descriptor for zip file '" << zip_location_
1224 << "': " << error_msg;
1225 return false;
1226 }
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001227 for (auto& dex_file : opened_dex_files_) {
1228 dex_files_.push_back(dex_file.get());
1229 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001230 ATRACE_END();
1231 } else {
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001232 size_t failure_count = OpenDexFiles(dex_filenames_, dex_locations_, &opened_dex_files_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001233 if (failure_count > 0) {
1234 LOG(ERROR) << "Failed to open some dex files: " << failure_count;
1235 return false;
1236 }
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001237 for (auto& dex_file : opened_dex_files_) {
1238 dex_files_.push_back(dex_file.get());
1239 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001240 }
1241
1242 constexpr bool kSaveDexInput = false;
1243 if (kSaveDexInput) {
1244 for (size_t i = 0; i < dex_files_.size(); ++i) {
1245 const DexFile* dex_file = dex_files_[i];
Brian Carlstrom95b033b2014-12-03 22:29:37 -08001246 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex",
1247 getpid(), i));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001248 std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
1249 if (tmp_file.get() == nullptr) {
1250 PLOG(ERROR) << "Failed to open file " << tmp_file_name
1251 << ". Try: adb shell chmod 777 /data/local/tmp";
1252 continue;
1253 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001254 // This is just dumping files for debugging. Ignore errors, and leave remnants.
1255 UNUSED(tmp_file->WriteFully(dex_file->Begin(), dex_file->Size()));
1256 UNUSED(tmp_file->Flush());
1257 UNUSED(tmp_file->Close());
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001258 LOG(INFO) << "Wrote input to " << tmp_file_name;
1259 }
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001260 }
1261 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001262 // Ensure opened dex files are writable for dex-to-dex transformations.
1263 for (const auto& dex_file : dex_files_) {
1264 if (!dex_file->EnableWrite()) {
1265 PLOG(ERROR) << "Failed to make .dex file writeable '" << dex_file->GetLocation() << "'\n";
Andreas Gampe7ba64962014-10-23 11:37:40 -07001266 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001267 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001268
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001269 // If we use a swap file, ensure we are above the threshold to make it necessary.
1270 if (swap_fd_ != -1) {
1271 if (!UseSwap(image_, dex_files_)) {
1272 close(swap_fd_);
1273 swap_fd_ = -1;
Andreas Gampef99bcd22015-04-24 16:22:18 -07001274 VLOG(compiler) << "Decided to run without swap.";
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001275 } else {
Andreas Gampef99bcd22015-04-24 16:22:18 -07001276 LOG(INFO) << "Large app, accepted running with swap.";
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001277 }
1278 }
1279 // Note that dex2oat won't close the swap_fd_. The compiler driver's swap space will do that.
1280
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001281 /*
1282 * If we're not in interpret-only or verify-none mode, go ahead and compile small applications.
1283 * Don't bother to check if we're doing the image.
1284 */
Brian Carlstrom95b033b2014-12-03 22:29:37 -08001285 if (!image_ &&
1286 compiler_options_->IsCompilationEnabled() &&
1287 compiler_kind_ == Compiler::kQuick) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001288 size_t num_methods = 0;
1289 for (size_t i = 0; i != dex_files_.size(); ++i) {
1290 const DexFile* dex_file = dex_files_[i];
1291 CHECK(dex_file != nullptr);
1292 num_methods += dex_file->NumMethodIds();
1293 }
1294 if (num_methods <= compiler_options_->GetNumDexMethodsThreshold()) {
1295 compiler_options_->SetCompilerFilter(CompilerOptions::kSpeed);
1296 VLOG(compiler) << "Below method threshold, compiling anyways";
1297 }
1298 }
1299
1300 return true;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001301 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -07001302
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001303 // Create and invoke the compiler driver. This will compile all the dex files.
1304 void Compile() {
1305 TimingLogger::ScopedTiming t("dex2oat Compile", timings_);
1306 compiler_phases_timings_.reset(new CumulativeLogger("compilation times"));
Vladimir Markof4da6752014-08-01 19:04:18 +01001307
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001308 // Handle and ClassLoader creation needs to come after Runtime::Create
1309 jobject class_loader = nullptr;
1310 Thread* self = Thread::Current();
1311 if (!boot_image_option_.empty()) {
1312 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001313 OpenClassPathFiles(runtime_->GetClassPathString(), dex_files_, &class_path_files_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001314 ScopedObjectAccess soa(self);
Andreas Gampe81c6f8d2015-03-25 17:19:53 -07001315
1316 // Classpath: first the class-path given.
1317 std::vector<const DexFile*> class_path_files;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001318 for (auto& class_path_file : class_path_files_) {
1319 class_path_files.push_back(class_path_file.get());
1320 }
Andreas Gampe7848da42015-04-09 11:15:04 -07001321
1322 // Store the classpath we have right now.
1323 key_value_store_->Put(OatHeader::kClassPathKey,
1324 OatFile::EncodeDexFileDependencies(class_path_files));
1325
Andreas Gampe81c6f8d2015-03-25 17:19:53 -07001326 // Then the dex files we'll compile. Thus we'll resolve the class-path first.
1327 class_path_files.insert(class_path_files.end(), dex_files_.begin(), dex_files_.end());
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001328
Andreas Gampe81c6f8d2015-03-25 17:19:53 -07001329 class_loader = class_linker->CreatePathClassLoader(self, class_path_files);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001330 }
1331
1332 driver_.reset(new CompilerDriver(compiler_options_.get(),
1333 verification_results_.get(),
1334 &method_inliner_map_,
1335 compiler_kind_,
1336 instruction_set_,
1337 instruction_set_features_.get(),
1338 image_,
1339 image_classes_.release(),
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08001340 compiled_classes_.release(),
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001341 nullptr,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001342 thread_count_,
1343 dump_stats_,
1344 dump_passes_,
David Brazdil866c0312015-01-13 21:21:31 +00001345 dump_cfg_file_name_,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001346 compiler_phases_timings_.get(),
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001347 swap_fd_,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001348 profile_file_));
1349
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001350 driver_->CompileAll(class_loader, dex_files_, timings_);
Vladimir Markof4da6752014-08-01 19:04:18 +01001351 }
1352
Brian Carlstrom7940e442013-07-12 13:46:57 -07001353 // Notes on the interleaving of creating the image and oat file to
1354 // ensure the references between the two are correct.
1355 //
1356 // Currently we have a memory layout that looks something like this:
1357 //
1358 // +--------------+
1359 // | image |
1360 // +--------------+
1361 // | boot oat |
1362 // +--------------+
1363 // | alloc spaces |
1364 // +--------------+
1365 //
Brian Carlstrom45602482013-07-21 22:07:55 -07001366 // There are several constraints on the loading of the image and boot.oat.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001367 //
1368 // 1. The image is expected to be loaded at an absolute address and
1369 // contains Objects with absolute pointers within the image.
1370 //
1371 // 2. There are absolute pointers from Methods in the image to their
1372 // code in the oat.
1373 //
1374 // 3. There are absolute pointers from the code in the oat to Methods
1375 // in the image.
1376 //
1377 // 4. There are absolute pointers from code in the oat to other code
1378 // in the oat.
1379 //
1380 // To get this all correct, we go through several steps.
1381 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001382 // 1. We prepare offsets for all data in the oat file and calculate
1383 // the oat data size and code size. During this stage, we also set
1384 // oat code offsets in methods for use by the image writer.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001385 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001386 // 2. We prepare offsets for the objects in the image and calculate
1387 // the image size.
1388 //
1389 // 3. We create the oat file. Originally this was just our own proprietary
1390 // file but now it is contained within an ELF dynamic object (aka an .so
1391 // file). Since we know the image size and oat data size and code size we
1392 // can prepare the ELF headers and we then know the ELF memory segment
1393 // layout and we can now resolve all references. The compiler provides
1394 // LinkerPatch information in each CompiledMethod and we resolve these,
1395 // using the layout information and image object locations provided by
1396 // image writer, as we're writing the method code.
1397 //
1398 // 4. We create the image file. It needs to know where the oat file
Brian Carlstrom7940e442013-07-12 13:46:57 -07001399 // will be loaded after itself. Originally when oat file was simply
1400 // memory mapped so we could predict where its contents were based
1401 // on the file size. Now that it is an ELF file, we need to inspect
1402 // the ELF file to understand the in memory segment layout including
Vladimir Markof4da6752014-08-01 19:04:18 +01001403 // where the oat header is located within.
1404 // TODO: We could just remember this information from step 3.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001405 //
Vladimir Markof4da6752014-08-01 19:04:18 +01001406 // 5. We fixup the ELF program headers so that dlopen will try to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001407 // load the .so at the desired location at runtime by offsetting the
1408 // Elf32_Phdr.p_vaddr values by the desired base address.
Vladimir Markof4da6752014-08-01 19:04:18 +01001409 // TODO: Do this in step 3. We already know the layout there.
1410 //
1411 // Steps 1.-3. are done by the CreateOatFile() above, steps 4.-5.
1412 // are done by the CreateImageFile() below.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001413
1414
1415 // Write out the generated code part. Calls the OatWriter and ElfBuilder. Also prepares the
1416 // ImageWriter, if necessary.
Andreas Gampe10e477d2014-11-19 12:57:42 -08001417 // Note: Flushing (and closing) the file is the caller's responsibility, except for the failure
1418 // case (when the file will be explicitly erased).
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001419 bool CreateOatFile() {
1420 CHECK(key_value_store_.get() != nullptr);
1421
1422 TimingLogger::ScopedTiming t("dex2oat Oat", timings_);
1423
1424 std::unique_ptr<OatWriter> oat_writer;
1425 {
1426 TimingLogger::ScopedTiming t2("dex2oat OatWriter", timings_);
1427 std::string image_file_location;
1428 uint32_t image_file_location_oat_checksum = 0;
1429 uintptr_t image_file_location_oat_data_begin = 0;
1430 int32_t image_patch_delta = 0;
1431 if (image_) {
1432 PrepareImageWriter(image_base_);
1433 } else {
1434 TimingLogger::ScopedTiming t3("Loading image checksum", timings_);
1435 gc::space::ImageSpace* image_space = Runtime::Current()->GetHeap()->GetImageSpace();
1436 image_file_location_oat_checksum = image_space->GetImageHeader().GetOatChecksum();
1437 image_file_location_oat_data_begin =
1438 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatDataBegin());
1439 image_file_location = image_space->GetImageFilename();
1440 image_patch_delta = image_space->GetImageHeader().GetPatchDelta();
1441 }
1442
1443 if (!image_file_location.empty()) {
1444 key_value_store_->Put(OatHeader::kImageLocationKey, image_file_location);
1445 }
1446
1447 oat_writer.reset(new OatWriter(dex_files_, image_file_location_oat_checksum,
1448 image_file_location_oat_data_begin,
1449 image_patch_delta,
1450 driver_.get(),
1451 image_writer_.get(),
1452 timings_,
1453 key_value_store_.get()));
Brian Carlstrom7940e442013-07-12 13:46:57 -07001454 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001455
1456 if (image_) {
1457 // The OatWriter constructor has already updated offsets in methods and we need to
1458 // prepare method offsets in the image address space for direct method patching.
1459 TimingLogger::ScopedTiming t2("dex2oat Prepare image address space", timings_);
1460 if (!image_writer_->PrepareImageAddressSpace()) {
1461 LOG(ERROR) << "Failed to prepare image address space.";
1462 return false;
1463 }
1464 }
1465
1466 {
1467 TimingLogger::ScopedTiming t2("dex2oat Write ELF", timings_);
1468 if (!driver_->WriteElf(android_root_, is_host_, dex_files_, oat_writer.get(),
1469 oat_file_.get())) {
1470 LOG(ERROR) << "Failed to write ELF file " << oat_file_->GetPath();
1471 return false;
1472 }
1473 }
1474
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001475 VLOG(compiler) << "Oat file written successfully (unstripped): " << oat_location_;
1476 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001477 }
1478
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001479 // If we are compiling an image, invoke the image creation routine. Else just skip.
1480 bool HandleImage() {
1481 if (image_) {
1482 TimingLogger::ScopedTiming t("dex2oat ImageWriter", timings_);
1483 if (!CreateImageFile()) {
1484 return false;
1485 }
1486 VLOG(compiler) << "Image written successfully: " << image_filename_;
Brian Carlstrom45602482013-07-21 22:07:55 -07001487 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001488 return true;
1489 }
1490
Andreas Gampe10e477d2014-11-19 12:57:42 -08001491 // Create a copy from unstripped to stripped.
1492 bool CopyUnstrippedToStripped() {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001493 // If we don't want to strip in place, copy from unstripped location to stripped location.
1494 // We need to strip after image creation because FixupElf needs to use .strtab.
1495 if (oat_unstripped_ != oat_stripped_) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08001496 // If the oat file is still open, flush it.
1497 if (oat_file_.get() != nullptr && oat_file_->IsOpened()) {
1498 if (!FlushCloseOatFile()) {
1499 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001500 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001501 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08001502
1503 TimingLogger::ScopedTiming t("dex2oat OatFile copy", timings_);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001504 std::unique_ptr<File> in(OS::OpenFileForReading(oat_unstripped_.c_str()));
1505 std::unique_ptr<File> out(OS::CreateEmptyFile(oat_stripped_.c_str()));
1506 size_t buffer_size = 8192;
Dan Albert6fc59ab2014-12-11 14:09:51 -08001507 std::unique_ptr<uint8_t[]> buffer(new uint8_t[buffer_size]);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001508 while (true) {
1509 int bytes_read = TEMP_FAILURE_RETRY(read(in->Fd(), buffer.get(), buffer_size));
1510 if (bytes_read <= 0) {
1511 break;
1512 }
1513 bool write_ok = out->WriteFully(buffer.get(), bytes_read);
1514 CHECK(write_ok);
1515 }
Elliott Hughes956af0f2014-12-11 14:34:28 -08001516 if (out->FlushCloseOrErase() != 0) {
1517 PLOG(ERROR) << "Failed to flush and close copied oat file: " << oat_stripped_;
1518 return false;
Andreas Gampe10e477d2014-11-19 12:57:42 -08001519 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001520 VLOG(compiler) << "Oat file copied successfully (stripped): " << oat_stripped_;
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00001521 }
Andreas Gampe10e477d2014-11-19 12:57:42 -08001522 return true;
1523 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001524
Andreas Gampe10e477d2014-11-19 12:57:42 -08001525 bool FlushOatFile() {
Andreas Gampe4303ba92014-11-06 01:00:46 -08001526 if (oat_file_.get() != nullptr) {
Andreas Gampe10e477d2014-11-19 12:57:42 -08001527 TimingLogger::ScopedTiming t2("dex2oat Flush ELF", timings_);
1528 if (oat_file_->Flush() != 0) {
1529 PLOG(ERROR) << "Failed to flush oat file: " << oat_location_ << " / "
1530 << oat_filename_;
1531 oat_file_->Erase();
1532 return false;
1533 }
1534 }
1535 return true;
1536 }
1537
1538 bool FlushCloseOatFile() {
1539 if (oat_file_.get() != nullptr) {
1540 std::unique_ptr<File> tmp(oat_file_.release());
1541 if (tmp->FlushCloseOrErase() != 0) {
1542 PLOG(ERROR) << "Failed to flush and close oat file: " << oat_location_ << " / "
1543 << oat_filename_;
1544 return false;
Andreas Gampe4303ba92014-11-06 01:00:46 -08001545 }
1546 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001547 return true;
1548 }
1549
1550 void DumpTiming() {
1551 if (dump_timing_ || (dump_slow_timing_ && timings_->GetTotalNs() > MsToNs(1000))) {
1552 LOG(INFO) << Dumpable<TimingLogger>(*timings_);
1553 }
1554 if (dump_passes_) {
1555 LOG(INFO) << Dumpable<CumulativeLogger>(*driver_->GetTimingsLogger());
1556 }
1557 }
1558
1559 CompilerOptions* GetCompilerOptions() const {
1560 return compiler_options_.get();
1561 }
1562
Andreas Gampe10e477d2014-11-19 12:57:42 -08001563 bool IsImage() const {
1564 return image_;
1565 }
1566
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001567 bool IsHost() const {
1568 return is_host_;
1569 }
1570
1571 private:
1572 static size_t OpenDexFiles(const std::vector<const char*>& dex_filenames,
1573 const std::vector<const char*>& dex_locations,
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001574 std::vector<std::unique_ptr<const DexFile>>* dex_files) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001575 DCHECK(dex_files != nullptr) << "OpenDexFiles out-param is nullptr";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001576 size_t failure_count = 0;
1577 for (size_t i = 0; i < dex_filenames.size(); i++) {
1578 const char* dex_filename = dex_filenames[i];
1579 const char* dex_location = dex_locations[i];
1580 ATRACE_BEGIN(StringPrintf("Opening dex file '%s'", dex_filenames[i]).c_str());
1581 std::string error_msg;
1582 if (!OS::FileExists(dex_filename)) {
1583 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filename << "'";
1584 continue;
1585 }
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001586 if (!DexFile::Open(dex_filename, dex_location, &error_msg, dex_files)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001587 LOG(WARNING) << "Failed to open .dex from file '" << dex_filename << "': " << error_msg;
1588 ++failure_count;
1589 }
1590 ATRACE_END();
1591 }
1592 return failure_count;
1593 }
1594
Andreas Gampee3712d02015-04-09 14:46:31 -07001595 // Returns true if dex_files has a dex with the named location. We compare canonical locations,
1596 // so that relative and absolute paths will match. Not caching for the dex_files isn't very
1597 // efficient, but under normal circumstances the list is neither large nor is this part too
1598 // sensitive.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001599 static bool DexFilesContains(const std::vector<const DexFile*>& dex_files,
1600 const std::string& location) {
Andreas Gampee3712d02015-04-09 14:46:31 -07001601 std::string canonical_location(DexFile::GetDexCanonicalLocation(location.c_str()));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001602 for (size_t i = 0; i < dex_files.size(); ++i) {
Andreas Gampee3712d02015-04-09 14:46:31 -07001603 if (DexFile::GetDexCanonicalLocation(dex_files[i]->GetLocation().c_str()) ==
1604 canonical_location) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001605 return true;
1606 }
1607 }
1608 return false;
1609 }
1610
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001611 // Appends to opened_dex_files any elements of class_path that dex_files
1612 // doesn't already contain. This will open those dex files as necessary.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001613 static void OpenClassPathFiles(const std::string& class_path,
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001614 std::vector<const DexFile*> dex_files,
1615 std::vector<std::unique_ptr<const DexFile>>* opened_dex_files) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001616 DCHECK(opened_dex_files != nullptr) << "OpenClassPathFiles out-param is nullptr";
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001617 std::vector<std::string> parsed;
1618 Split(class_path, ':', &parsed);
1619 // Take Locks::mutator_lock_ so that lock ordering on the ClassLinker::dex_lock_ is maintained.
1620 ScopedObjectAccess soa(Thread::Current());
1621 for (size_t i = 0; i < parsed.size(); ++i) {
1622 if (DexFilesContains(dex_files, parsed[i])) {
1623 continue;
1624 }
1625 std::string error_msg;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001626 if (!DexFile::Open(parsed[i].c_str(), parsed[i].c_str(), &error_msg, opened_dex_files)) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001627 LOG(WARNING) << "Failed to open dex file '" << parsed[i] << "': " << error_msg;
1628 }
1629 }
1630 }
1631
1632 // Create a runtime necessary for compilation.
1633 bool CreateRuntime(const RuntimeOptions& runtime_options)
1634 SHARED_TRYLOCK_FUNCTION(true, Locks::mutator_lock_) {
1635 if (!Runtime::Create(runtime_options, false)) {
1636 LOG(ERROR) << "Failed to create runtime";
1637 return false;
1638 }
1639 Runtime* runtime = Runtime::Current();
1640 runtime->SetInstructionSet(instruction_set_);
1641 for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) {
1642 Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i);
1643 if (!runtime->HasCalleeSaveMethod(type)) {
1644 runtime->SetCalleeSaveMethod(runtime->CreateCalleeSaveMethod(), type);
1645 }
1646 }
1647 runtime->GetClassLinker()->FixupDexCaches(runtime->GetResolutionMethod());
Andreas Gampe2969bcd2015-03-09 12:57:41 -07001648
1649 // Initialize maps for unstarted runtime. This needs to be here, as running clinits needs this
1650 // set up.
Andreas Gampe799681b2015-05-15 19:24:12 -07001651 interpreter::UnstartedRuntime::Initialize();
Andreas Gampe2969bcd2015-03-09 12:57:41 -07001652
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001653 runtime->GetClassLinker()->RunRootClinits();
1654 runtime_ = runtime;
Andreas Gampe2969bcd2015-03-09 12:57:41 -07001655
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001656 return true;
1657 }
1658
1659 void PrepareImageWriter(uintptr_t image_base) {
1660 image_writer_.reset(new ImageWriter(*driver_, image_base, compiler_options_->GetCompilePic()));
1661 }
1662
1663 // Let the ImageWriter write the image file. If we do not compile PIC, also fix up the oat file.
1664 bool CreateImageFile()
1665 LOCKS_EXCLUDED(Locks::mutator_lock_) {
1666 CHECK(image_writer_ != nullptr);
1667 if (!image_writer_->Write(image_filename_, oat_unstripped_, oat_location_)) {
1668 LOG(ERROR) << "Failed to create image file " << image_filename_;
1669 return false;
1670 }
1671 uintptr_t oat_data_begin = image_writer_->GetOatDataBegin();
1672
1673 // Destroy ImageWriter before doing FixupElf.
1674 image_writer_.reset();
1675
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001676 // Do not fix up the ELF file if we are --compile-pic
1677 if (!compiler_options_->GetCompilePic()) {
Andreas Gampe4303ba92014-11-06 01:00:46 -08001678 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_unstripped_.c_str()));
1679 if (oat_file.get() == nullptr) {
1680 PLOG(ERROR) << "Failed to open ELF file: " << oat_unstripped_;
1681 return false;
1682 }
1683
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001684 if (!ElfWriter::Fixup(oat_file.get(), oat_data_begin)) {
Andreas Gampe4303ba92014-11-06 01:00:46 -08001685 oat_file->Erase();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001686 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
1687 return false;
1688 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001689
1690 if (oat_file->FlushCloseOrErase()) {
1691 PLOG(ERROR) << "Failed to flush and close fixed ELF file " << oat_file->GetPath();
1692 return false;
1693 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001694 }
1695
1696 return true;
1697 }
1698
1699 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07001700 static std::unordered_set<std::string>* ReadImageClassesFromFile(
1701 const char* image_classes_filename) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001702 std::function<std::string(const char*)> process = DotToDescriptor;
1703 return ReadCommentedInputFromFile(image_classes_filename, &process);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001704 }
1705
1706 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Andreas Gampeb1fcead2015-04-20 18:53:51 -07001707 static std::unordered_set<std::string>* ReadImageClassesFromZip(
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001708 const char* zip_filename,
1709 const char* image_classes_filename,
1710 std::string* error_msg) {
1711 std::function<std::string(const char*)> process = DotToDescriptor;
1712 return ReadCommentedInputFromZip(zip_filename, image_classes_filename, &process, error_msg);
1713 }
1714
1715 // Read lines from the given file, dropping comments and empty lines. Post-process each line with
1716 // the given function.
1717 static std::unordered_set<std::string>* ReadCommentedInputFromFile(
1718 const char* input_filename, std::function<std::string(const char*)>* process) {
1719 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
1720 if (input_file.get() == nullptr) {
1721 LOG(ERROR) << "Failed to open input file " << input_filename;
1722 return nullptr;
1723 }
1724 std::unique_ptr<std::unordered_set<std::string>> result(
1725 ReadCommentedInputStream(*input_file, process));
1726 input_file->close();
1727 return result.release();
1728 }
1729
1730 // Read lines from the given file from the given zip file, dropping comments and empty lines.
1731 // Post-process each line with the given function.
1732 static std::unordered_set<std::string>* ReadCommentedInputFromZip(
Andreas Gampeb1fcead2015-04-20 18:53:51 -07001733 const char* zip_filename,
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001734 const char* input_filename,
1735 std::function<std::string(const char*)>* process,
Andreas Gampeb1fcead2015-04-20 18:53:51 -07001736 std::string* error_msg) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001737 std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
1738 if (zip_archive.get() == nullptr) {
1739 return nullptr;
1740 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001741 std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(input_filename, error_msg));
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001742 if (zip_entry.get() == nullptr) {
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001743 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001744 zip_filename, error_msg->c_str());
1745 return nullptr;
1746 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001747 std::unique_ptr<MemMap> input_file(zip_entry->ExtractToMemMap(zip_filename,
1748 input_filename,
1749 error_msg));
1750 if (input_file.get() == nullptr) {
1751 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", input_filename,
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001752 zip_filename, error_msg->c_str());
1753 return nullptr;
1754 }
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001755 const std::string input_string(reinterpret_cast<char*>(input_file->Begin()),
1756 input_file->Size());
1757 std::istringstream input_stream(input_string);
1758 return ReadCommentedInputStream(input_stream, process);
1759 }
1760
1761 // Read lines from the given stream, dropping comments and empty lines. Post-process each line
1762 // with the given function.
1763 static std::unordered_set<std::string>* ReadCommentedInputStream(
1764 std::istream& in_stream,
1765 std::function<std::string(const char*)>* process) {
1766 std::unique_ptr<std::unordered_set<std::string>> image_classes(
1767 new std::unordered_set<std::string>);
1768 while (in_stream.good()) {
1769 std::string dot;
1770 std::getline(in_stream, dot);
1771 if (StartsWith(dot, "#") || dot.empty()) {
1772 continue;
1773 }
1774 if (process != nullptr) {
1775 std::string descriptor((*process)(dot.c_str()));
1776 image_classes->insert(descriptor);
1777 } else {
1778 image_classes->insert(dot);
1779 }
1780 }
1781 return image_classes.release();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001782 }
1783
Mathieu Chartier49285c52014-12-02 15:43:48 -08001784 void LogCompletionTime() {
Andreas Gampe1d00add2015-02-27 19:35:46 -08001785 // Note: when creation of a runtime fails, e.g., when trying to compile an app but when there
1786 // is no image, there won't be a Runtime::Current().
Brian Carlstroma11a34c2015-03-06 08:44:45 -08001787 // Note: driver creation can fail when loading an invalid dex file.
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001788 LOG(INFO) << "dex2oat took " << PrettyDuration(NanoTime() - start_ns_)
Mathieu Chartierab972ef2014-12-03 17:38:22 -08001789 << " (threads: " << thread_count_ << ") "
Brian Carlstroma11a34c2015-03-06 08:44:45 -08001790 << ((Runtime::Current() != nullptr && driver_.get() != nullptr) ?
Andreas Gampe1d00add2015-02-27 19:35:46 -08001791 driver_->GetMemoryUsageString(kIsDebugBuild || VLOG_IS_ON(compiler)) :
1792 "");
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001793 }
1794
1795 std::unique_ptr<CompilerOptions> compiler_options_;
1796 Compiler::Kind compiler_kind_;
1797
1798 InstructionSet instruction_set_;
1799 std::unique_ptr<const InstructionSetFeatures> instruction_set_features_;
1800
1801 std::unique_ptr<SafeMap<std::string, std::string> > key_value_store_;
1802
1803 std::unique_ptr<VerificationResults> verification_results_;
1804 DexFileToMethodInlinerMap method_inliner_map_;
1805 std::unique_ptr<QuickCompilerCallbacks> callbacks_;
1806
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001807 // Ownership for the class path files.
1808 std::vector<std::unique_ptr<const DexFile>> class_path_files_;
1809
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001810 // Not a unique_ptr as we want to just exit on non-debug builds, not bringing the runtime down
1811 // in an orderly fashion. The destructor takes care of deleting this.
1812 Runtime* runtime_;
1813
1814 size_t thread_count_;
1815 uint64_t start_ns_;
1816 std::unique_ptr<WatchDog> watchdog_;
1817 std::unique_ptr<File> oat_file_;
1818 std::string oat_stripped_;
1819 std::string oat_unstripped_;
1820 std::string oat_location_;
1821 std::string oat_filename_;
1822 int oat_fd_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001823 std::vector<const char*> dex_filenames_;
1824 std::vector<const char*> dex_locations_;
1825 int zip_fd_;
1826 std::string zip_location_;
1827 std::string boot_image_option_;
1828 std::vector<const char*> runtime_args_;
1829 std::string image_filename_;
1830 uintptr_t image_base_;
1831 const char* image_classes_zip_filename_;
1832 const char* image_classes_filename_;
Andreas Gampe4bf3ae92014-11-11 13:28:29 -08001833 const char* compiled_classes_zip_filename_;
1834 const char* compiled_classes_filename_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001835 const char* compiled_methods_zip_filename_;
1836 const char* compiled_methods_filename_;
Andreas Gampeb1fcead2015-04-20 18:53:51 -07001837 std::unique_ptr<std::unordered_set<std::string>> image_classes_;
1838 std::unique_ptr<std::unordered_set<std::string>> compiled_classes_;
Andreas Gampe70bef0d2015-04-15 02:37:28 -07001839 std::unique_ptr<std::unordered_set<std::string>> compiled_methods_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001840 bool image_;
1841 std::unique_ptr<ImageWriter> image_writer_;
1842 bool is_host_;
1843 std::string android_root_;
1844 std::vector<const DexFile*> dex_files_;
Richard Uhlerfbef44d2014-12-23 09:48:51 -08001845 std::vector<std::unique_ptr<const DexFile>> opened_dex_files_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001846 std::unique_ptr<CompilerDriver> driver_;
1847 std::vector<std::string> verbose_methods_;
1848 bool dump_stats_;
1849 bool dump_passes_;
1850 bool dump_timing_;
1851 bool dump_slow_timing_;
David Brazdil866c0312015-01-13 21:21:31 +00001852 std::string dump_cfg_file_name_;
Andreas Gampee21dc3d2014-12-08 16:59:43 -08001853 std::string swap_file_name_;
1854 int swap_fd_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001855 std::string profile_file_; // Profile file to use
1856 TimingLogger* timings_;
1857 std::unique_ptr<CumulativeLogger> compiler_phases_timings_;
Andreas Gampedbfe2542014-11-25 22:21:42 -08001858 std::unique_ptr<std::ostream> init_failure_output_;
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001859
1860 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
1861};
1862
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001863static void b13564922() {
1864#if defined(__linux__) && defined(__arm__)
1865 int major, minor;
1866 struct utsname uts;
1867 if (uname(&uts) != -1 &&
1868 sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
1869 ((major < 3) || ((major == 3) && (minor < 4)))) {
1870 // Kernels before 3.4 don't handle the ASLR well and we can run out of address
1871 // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
1872 int old_personality = personality(0xffffffff);
1873 if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
1874 int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
1875 if (new_personality == -1) {
1876 LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
1877 }
1878 }
1879 }
1880#endif
1881}
1882
Andreas Gampe10e477d2014-11-19 12:57:42 -08001883static int CompileImage(Dex2Oat& dex2oat) {
1884 dex2oat.Compile();
1885
1886 // Create the boot.oat.
1887 if (!dex2oat.CreateOatFile()) {
Andreas Gampea650e702014-12-03 14:28:02 -08001888 dex2oat.EraseOatFile();
Andreas Gampe10e477d2014-11-19 12:57:42 -08001889 return EXIT_FAILURE;
1890 }
1891
1892 // Flush and close the boot.oat. We always expect the output file by name, and it will be
1893 // re-opened from the unstripped name.
1894 if (!dex2oat.FlushCloseOatFile()) {
1895 return EXIT_FAILURE;
1896 }
1897
1898 // Creates the boot.art and patches the boot.oat.
1899 if (!dex2oat.HandleImage()) {
1900 return EXIT_FAILURE;
1901 }
1902
1903 // When given --host, finish early without stripping.
1904 if (dex2oat.IsHost()) {
1905 dex2oat.DumpTiming();
1906 return EXIT_SUCCESS;
1907 }
1908
1909 // Copy unstripped to stripped location, if necessary.
1910 if (!dex2oat.CopyUnstrippedToStripped()) {
1911 return EXIT_FAILURE;
1912 }
1913
Andreas Gampe10e477d2014-11-19 12:57:42 -08001914 // FlushClose again, as stripping might have re-opened the oat file.
1915 if (!dex2oat.FlushCloseOatFile()) {
1916 return EXIT_FAILURE;
1917 }
1918
1919 dex2oat.DumpTiming();
1920 return EXIT_SUCCESS;
1921}
1922
1923static int CompileApp(Dex2Oat& dex2oat) {
1924 dex2oat.Compile();
1925
1926 // Create the app oat.
1927 if (!dex2oat.CreateOatFile()) {
Andreas Gampea650e702014-12-03 14:28:02 -08001928 dex2oat.EraseOatFile();
Andreas Gampe10e477d2014-11-19 12:57:42 -08001929 return EXIT_FAILURE;
1930 }
1931
1932 // Do not close the oat file here. We might haven gotten the output file by file descriptor,
1933 // which we would lose.
1934 if (!dex2oat.FlushOatFile()) {
1935 return EXIT_FAILURE;
1936 }
1937
1938 // When given --host, finish early without stripping.
1939 if (dex2oat.IsHost()) {
1940 if (!dex2oat.FlushCloseOatFile()) {
1941 return EXIT_FAILURE;
1942 }
1943
1944 dex2oat.DumpTiming();
1945 return EXIT_SUCCESS;
1946 }
1947
1948 // Copy unstripped to stripped location, if necessary. This will implicitly flush & close the
1949 // unstripped version. If this is given, we expect to be able to open writable files by name.
1950 if (!dex2oat.CopyUnstrippedToStripped()) {
1951 return EXIT_FAILURE;
1952 }
1953
Andreas Gampe10e477d2014-11-19 12:57:42 -08001954 // Flush and close the file.
1955 if (!dex2oat.FlushCloseOatFile()) {
1956 return EXIT_FAILURE;
1957 }
1958
1959 dex2oat.DumpTiming();
1960 return EXIT_SUCCESS;
1961}
1962
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001963static int dex2oat(int argc, char** argv) {
1964 b13564922();
1965
1966 TimingLogger timings("compiler", false, false);
1967
1968 Dex2Oat dex2oat(&timings);
1969
1970 // Parse arguments. Argument mistakes will lead to exit(EXIT_FAILURE) in UsageError.
1971 dex2oat.ParseArgs(argc, argv);
1972
1973 // Check early that the result of compilation can be written
1974 if (!dex2oat.OpenFile()) {
1975 return EXIT_FAILURE;
1976 }
1977
Andreas Gampe046c7062015-05-18 23:22:54 -07001978 // Print the complete line when any of the following is true:
1979 // 1) Debug build
1980 // 2) Compiling an image
1981 // 3) Compiling with --host
1982 // 4) Compiling on the host (not a target build)
1983 // Otherwise, print a stripped command line.
1984 if (kIsDebugBuild || dex2oat.IsImage() || dex2oat.IsHost() || !kIsTargetBuild) {
1985 LOG(INFO) << CommandLine();
1986 } else {
1987 LOG(INFO) << StrippedCommandLine();
1988 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001989
1990 if (!dex2oat.Setup()) {
Andreas Gampea650e702014-12-03 14:28:02 -08001991 dex2oat.EraseOatFile();
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001992 return EXIT_FAILURE;
1993 }
1994
Andreas Gampe10e477d2014-11-19 12:57:42 -08001995 if (dex2oat.IsImage()) {
1996 return CompileImage(dex2oat);
1997 } else {
1998 return CompileApp(dex2oat);
Andreas Gampe88ec7f42014-11-05 10:18:32 -08001999 }
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002000}
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002001} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07002002
2003int main(int argc, char** argv) {
Andreas Gampe88ec7f42014-11-05 10:18:32 -08002004 int result = art::dex2oat(argc, argv);
2005 // Everything was done, do an explicit exit here to avoid running Runtime destructors that take
2006 // time (bug 10645725) unless we're a debug build or running on valgrind. Note: The Dex2Oat class
2007 // should not destruct the runtime in this case.
2008 if (!art::kIsDebugBuild && (RUNNING_ON_VALGRIND == 0)) {
2009 exit(result);
2010 }
2011 return result;
Brian Carlstrom7940e442013-07-12 13:46:57 -07002012}