blob: cc78816546f4433a56903b1ddbdba8b2bad93c8f [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
17#include <stdio.h>
18#include <stdlib.h>
19#include <sys/stat.h>
Ian Rogers2672a9f2013-09-05 17:24:22 -070020#include <valgrind.h>
Brian Carlstrom7940e442013-07-12 13:46:57 -070021
22#include <fstream>
23#include <iostream>
24#include <sstream>
25#include <string>
26#include <vector>
27
28#include "base/stl_util.h"
29#include "base/stringpiece.h"
30#include "base/timing_logger.h"
31#include "base/unix_file/fd_file.h"
32#include "class_linker.h"
Nicolas Geoffrayf5df8972014-02-14 18:37:08 +000033#include "compiler_backend.h"
Vladimir Marko2b5eaa22013-12-13 13:59:30 +000034#include "compiler_callbacks.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070035#include "dex_file-inl.h"
Vladimir Markoc7f83202014-01-24 17:55:18 +000036#include "dex/verification_results.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080037#include "driver/compiler_callbacks_impl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070038#include "driver/compiler_driver.h"
Brian Carlstrom6449c622014-02-10 23:48:36 -080039#include "driver/compiler_options.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070040#include "elf_fixup.h"
41#include "elf_stripper.h"
42#include "gc/space/image_space.h"
43#include "gc/space/space-inl.h"
44#include "image_writer.h"
45#include "leb128.h"
Brian Carlstromea46f952013-07-30 01:26:50 -070046#include "mirror/art_method-inl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070047#include "mirror/class-inl.h"
48#include "mirror/class_loader.h"
49#include "mirror/object-inl.h"
50#include "mirror/object_array-inl.h"
51#include "oat_writer.h"
52#include "object_utils.h"
53#include "os.h"
54#include "runtime.h"
55#include "ScopedLocalRef.h"
56#include "scoped_thread_state_change.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070057#include "vector_output_stream.h"
58#include "well_known_classes.h"
59#include "zip_archive.h"
60
61namespace art {
62
Brian Carlstrom6449c622014-02-10 23:48:36 -080063static int original_argc;
64static char** original_argv;
65
66static std::string CommandLine() {
67 std::vector<std::string> command;
68 for (int i = 0; i < original_argc; ++i) {
69 command.push_back(original_argv[i]);
70 }
71 return Join(command, ' ');
72}
73
Brian Carlstrom7940e442013-07-12 13:46:57 -070074static void UsageErrorV(const char* fmt, va_list ap) {
75 std::string error;
76 StringAppendV(&error, fmt, ap);
77 LOG(ERROR) << error;
78}
79
80static void UsageError(const char* fmt, ...) {
81 va_list ap;
82 va_start(ap, fmt);
83 UsageErrorV(fmt, ap);
84 va_end(ap);
85}
86
87static void Usage(const char* fmt, ...) {
88 va_list ap;
89 va_start(ap, fmt);
90 UsageErrorV(fmt, ap);
91 va_end(ap);
92
Brian Carlstrom6449c622014-02-10 23:48:36 -080093 UsageError("Command: %s", CommandLine().c_str());
94
Brian Carlstrom7940e442013-07-12 13:46:57 -070095 UsageError("Usage: dex2oat [options]...");
96 UsageError("");
97 UsageError(" --dex-file=<dex-file>: specifies a .dex file to compile.");
98 UsageError(" Example: --dex-file=/system/framework/core.jar");
99 UsageError("");
100 UsageError(" --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
101 UsageError(" containing a classes.dex file to compile.");
102 UsageError(" Example: --zip-fd=5");
103 UsageError("");
Brian Carlstrom45602482013-07-21 22:07:55 -0700104 UsageError(" --zip-location=<zip-location>: specifies a symbolic name for the file");
105 UsageError(" corresponding to the file descriptor specified by --zip-fd.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700106 UsageError(" Example: --zip-location=/system/app/Calculator.apk");
107 UsageError("");
108 UsageError(" --oat-file=<file.oat>: specifies the oat output destination via a filename.");
109 UsageError(" Example: --oat-file=/system/framework/boot.oat");
110 UsageError("");
111 UsageError(" --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
112 UsageError(" Example: --oat-file=/system/framework/boot.oat");
113 UsageError("");
114 UsageError(" --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
115 UsageError(" to the file descriptor specified by --oat-fd.");
116 UsageError(" Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
117 UsageError("");
118 UsageError(" --oat-symbols=<file.oat>: specifies the oat output destination with full symbols.");
119 UsageError(" Example: --oat-symbols=/symbols/system/framework/boot.oat");
120 UsageError("");
121 UsageError(" --bitcode=<file.bc>: specifies the optional bitcode filename.");
122 UsageError(" Example: --bitcode=/system/framework/boot.bc");
123 UsageError("");
124 UsageError(" --image=<file.art>: specifies the output image filename.");
125 UsageError(" Example: --image=/system/framework/boot.art");
126 UsageError("");
127 UsageError(" --image-classes=<classname-file>: specifies classes to include in an image.");
128 UsageError(" Example: --image=frameworks/base/preloaded-classes");
129 UsageError("");
130 UsageError(" --base=<hex-address>: specifies the base address when creating a boot image.");
131 UsageError(" Example: --base=0x50000000");
132 UsageError("");
133 UsageError(" --boot-image=<file.art>: provide the image file for the boot class path.");
134 UsageError(" Example: --boot-image=/system/framework/boot.art");
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000135 UsageError(" Default: $ANDROID_ROOT/system/framework/boot.art");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700136 UsageError("");
137 UsageError(" --android-root=<path>: used to locate libraries for portable linking.");
138 UsageError(" Example: --android-root=out/host/linux-x86");
139 UsageError(" Default: $ANDROID_ROOT");
140 UsageError("");
Ian Rogersbefbd572014-03-06 01:13:39 -0800141 UsageError(" --instruction-set=(arm|mips|x86|x86_64): compile for a particular instruction");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700142 UsageError(" set.");
143 UsageError(" Example: --instruction-set=x86");
144 UsageError(" Default: arm");
145 UsageError("");
Dave Allison70202782013-10-22 17:52:19 -0700146 UsageError(" --instruction-set-features=...,: Specify instruction set features");
147 UsageError(" Example: --instruction-set-features=div");
148 UsageError(" Default: default");
149 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700150 UsageError(" --compiler-backend=(Quick|QuickGBC|Portable): select compiler backend");
151 UsageError(" set.");
Brian Carlstrom635733d2013-10-30 23:19:31 -0700152 UsageError(" Example: --compiler-backend=Portable");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700153 UsageError(" Default: Quick");
154 UsageError("");
Brian Carlstrom6449c622014-02-10 23:48:36 -0800155 UsageError(" --compiler-filter=(interpret-only|space|balanced|speed|everything): select");
156 UsageError(" compiler filter.");
157 UsageError(" Example: --compiler-filter=everything");
158#if ART_SMALL_MODE
159 UsageError(" Default: interpret-only");
160#else
161 UsageError(" Default: speed");
162#endif
163 UsageError("");
164 UsageError(" --huge-method-max=<method-instruction-count>: the threshold size for a huge");
165 UsageError(" method for compiler filter tuning.");
166 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
167 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
168 UsageError("");
169 UsageError(" --huge-method-max=<method-instruction-count>: threshold size for a huge");
170 UsageError(" method for compiler filter tuning.");
171 UsageError(" Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
172 UsageError(" Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
173 UsageError("");
174 UsageError(" --large-method-max=<method-instruction-count>: threshold size for a large");
175 UsageError(" method for compiler filter tuning.");
176 UsageError(" Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
177 UsageError(" Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
178 UsageError("");
179 UsageError(" --small-method-max=<method-instruction-count>: threshold size for a small");
180 UsageError(" method for compiler filter tuning.");
181 UsageError(" Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
182 UsageError(" Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
183 UsageError("");
184 UsageError(" --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
185 UsageError(" method for compiler filter tuning.");
186 UsageError(" Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
187 UsageError(" Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
188 UsageError("");
189 UsageError(" --num-dex-methods=<method-count>: threshold size for a small dex file for");
190 UsageError(" compiler filter tuning. If the input has fewer than this many methods");
191 UsageError(" and the filter is not interpret-only, overrides the filter to use speed");
192 UsageError(" Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
193 UsageError(" Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
194 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700195 UsageError(" --host: used with Portable backend to link against host runtime libraries");
196 UsageError("");
Ian Rogers46398602013-08-20 07:50:36 -0700197 UsageError(" --dump-timing: display a breakdown of where time was spent");
198 UsageError("");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700199 UsageError(" --runtime-arg <argument>: used to specify various arguments for the runtime,");
200 UsageError(" such as initial heap size, maximum heap size, and verbose output.");
201 UsageError(" Use a separate --runtime-arg switch for each argument.");
202 UsageError(" Example: --runtime-arg -Xms256m");
Dave Allison39c3bfb2014-01-28 18:33:52 -0800203 UsageError("");
204 UsageError(" --profile-file=<filename>: specify profiler output file to use for compilation.");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700205 UsageError("");
206 std::cerr << "See log for usage error information\n";
207 exit(EXIT_FAILURE);
208}
209
210class Dex2Oat {
211 public:
Brian Carlstrom45602482013-07-21 22:07:55 -0700212 static bool Create(Dex2Oat** p_dex2oat,
Brian Carlstrom6449c622014-02-10 23:48:36 -0800213 const Runtime::Options& runtime_options,
214 const CompilerOptions& compiler_options,
Nicolas Geoffrayf5df8972014-02-14 18:37:08 +0000215 CompilerBackend::Kind compiler_backend,
Brian Carlstrom45602482013-07-21 22:07:55 -0700216 InstructionSet instruction_set,
Dave Allison70202782013-10-22 17:52:19 -0700217 InstructionSetFeatures instruction_set_features,
Brian Carlstrom6449c622014-02-10 23:48:36 -0800218 VerificationResults* verification_results,
219 DexFileToMethodInlinerMap* method_inliner_map,
Brian Carlstrom45602482013-07-21 22:07:55 -0700220 size_t thread_count)
Brian Carlstrom7940e442013-07-12 13:46:57 -0700221 SHARED_TRYLOCK_FUNCTION(true, Locks::mutator_lock_) {
Brian Carlstrom6449c622014-02-10 23:48:36 -0800222 CHECK(verification_results != nullptr);
223 CHECK(method_inliner_map != nullptr);
224 UniquePtr<Dex2Oat> dex2oat(new Dex2Oat(&compiler_options,
225 compiler_backend,
226 instruction_set,
227 instruction_set_features,
228 verification_results,
229 method_inliner_map,
230 thread_count));
231 if (!dex2oat->CreateRuntime(runtime_options, instruction_set)) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700232 *p_dex2oat = NULL;
233 return false;
234 }
Vladimir Marko2b5eaa22013-12-13 13:59:30 +0000235 *p_dex2oat = dex2oat.release();
Brian Carlstrom7940e442013-07-12 13:46:57 -0700236 return true;
237 }
238
239 ~Dex2Oat() {
240 delete runtime_;
Brian Carlstrom65c23bb2014-02-01 22:12:39 -0800241 LogCompletionTime();
242 }
243
244 void LogCompletionTime() {
245 LOG(INFO) << "dex2oat took " << PrettyDuration(NanoTime() - start_ns_)
Brian Carlstrom45602482013-07-21 22:07:55 -0700246 << " (threads: " << thread_count_ << ")";
Brian Carlstrom7940e442013-07-12 13:46:57 -0700247 }
248
249
Brian Carlstrom45602482013-07-21 22:07:55 -0700250 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Brian Carlstrom7940e442013-07-12 13:46:57 -0700251 CompilerDriver::DescriptorSet* ReadImageClassesFromFile(const char* image_classes_filename) {
Brian Carlstrom45602482013-07-21 22:07:55 -0700252 UniquePtr<std::ifstream> image_classes_file(new std::ifstream(image_classes_filename,
253 std::ifstream::in));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700254 if (image_classes_file.get() == NULL) {
255 LOG(ERROR) << "Failed to open image classes file " << image_classes_filename;
256 return NULL;
257 }
258 UniquePtr<CompilerDriver::DescriptorSet> result(ReadImageClasses(*image_classes_file.get()));
259 image_classes_file->close();
260 return result.release();
261 }
262
263 CompilerDriver::DescriptorSet* ReadImageClasses(std::istream& image_classes_stream) {
264 UniquePtr<CompilerDriver::DescriptorSet> image_classes(new CompilerDriver::DescriptorSet);
265 while (image_classes_stream.good()) {
266 std::string dot;
267 std::getline(image_classes_stream, dot);
268 if (StartsWith(dot, "#") || dot.empty()) {
269 continue;
270 }
271 std::string descriptor(DotToDescriptor(dot.c_str()));
272 image_classes->insert(descriptor);
273 }
274 return image_classes.release();
275 }
276
Brian Carlstrom45602482013-07-21 22:07:55 -0700277 // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700278 CompilerDriver::DescriptorSet* ReadImageClassesFromZip(const char* zip_filename,
279 const char* image_classes_filename,
280 std::string* error_msg) {
281 UniquePtr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700282 if (zip_archive.get() == NULL) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700283 return NULL;
284 }
Narayan Kamath92572be2013-11-28 14:06:24 +0000285 UniquePtr<ZipEntry> zip_entry(zip_archive->Find(image_classes_filename, error_msg));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700286 if (zip_entry.get() == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700287 *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", image_classes_filename,
288 zip_filename, error_msg->c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700289 return NULL;
290 }
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700291 UniquePtr<MemMap> image_classes_file(zip_entry->ExtractToMemMap(image_classes_filename,
292 error_msg));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700293 if (image_classes_file.get() == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700294 *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", image_classes_filename,
295 zip_filename, error_msg->c_str());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700296 return NULL;
297 }
298 const std::string image_classes_string(reinterpret_cast<char*>(image_classes_file->Begin()),
299 image_classes_file->Size());
300 std::istringstream image_classes_stream(image_classes_string);
301 return ReadImageClasses(image_classes_stream);
302 }
303
304 const CompilerDriver* CreateOatFile(const std::string& boot_image_option,
Brian Carlstrom7940e442013-07-12 13:46:57 -0700305 const std::string& android_root,
306 bool is_host,
307 const std::vector<const DexFile*>& dex_files,
308 File* oat_file,
309 const std::string& bitcode_filename,
310 bool image,
311 UniquePtr<CompilerDriver::DescriptorSet>& image_classes,
312 bool dump_stats,
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +0000313 bool dump_passes,
314 TimingLogger& timings,
Dave Allison39c3bfb2014-01-28 18:33:52 -0800315 CumulativeLogger& compiler_phases_timings,
316 std::string profile_file) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700317 // SirtRef and ClassLoader creation needs to come after Runtime::Create
318 jobject class_loader = NULL;
Ian Rogers3f3d22c2013-08-27 18:11:09 -0700319 Thread* self = Thread::Current();
Brian Carlstrom7940e442013-07-12 13:46:57 -0700320 if (!boot_image_option.empty()) {
321 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
322 std::vector<const DexFile*> class_path_files(dex_files);
323 OpenClassPathFiles(runtime_->GetClassPathString(), class_path_files);
Ian Rogers3f3d22c2013-08-27 18:11:09 -0700324 ScopedObjectAccess soa(self);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700325 for (size_t i = 0; i < class_path_files.size(); i++) {
326 class_linker->RegisterDexFile(*class_path_files[i]);
327 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700328 soa.Env()->AllocObject(WellKnownClasses::dalvik_system_PathClassLoader);
329 ScopedLocalRef<jobject> class_loader_local(soa.Env(),
330 soa.Env()->AllocObject(WellKnownClasses::dalvik_system_PathClassLoader));
331 class_loader = soa.Env()->NewGlobalRef(class_loader_local.get());
332 Runtime::Current()->SetCompileTimeClassPath(class_loader, class_path_files);
333 }
334
Brian Carlstrom6449c622014-02-10 23:48:36 -0800335 UniquePtr<CompilerDriver> driver(new CompilerDriver(compiler_options_,
336 verification_results_,
337 method_inliner_map_,
Vladimir Marko2b5eaa22013-12-13 13:59:30 +0000338 compiler_backend_,
Brian Carlstrom7940e442013-07-12 13:46:57 -0700339 instruction_set_,
Dave Allison70202782013-10-22 17:52:19 -0700340 instruction_set_features_,
Brian Carlstrom7940e442013-07-12 13:46:57 -0700341 image,
342 image_classes.release(),
343 thread_count_,
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +0000344 dump_stats,
345 dump_passes,
Dave Allison39c3bfb2014-01-28 18:33:52 -0800346 &compiler_phases_timings,
347 profile_file));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700348
Ian Rogers3d504072014-03-01 09:16:49 -0800349 driver->GetCompilerBackend()->SetBitcodeFileName(*driver.get(), bitcode_filename);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700350
Ian Rogers3d504072014-03-01 09:16:49 -0800351 driver->CompileAll(class_loader, dex_files, &timings);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700352
Anwar Ghuloum6f28d912013-07-24 15:02:53 -0700353 timings.NewSplit("dex2oat OatWriter");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700354 std::string image_file_location;
355 uint32_t image_file_location_oat_checksum = 0;
Ian Rogersef7d42f2014-01-06 12:55:46 -0800356 uintptr_t image_file_location_oat_data_begin = 0;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700357 if (!driver->IsImage()) {
Ian Rogersca368cb2013-11-15 15:52:08 -0800358 TimingLogger::ScopedSplit split("Loading image checksum", &timings);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700359 gc::space::ImageSpace* image_space = Runtime::Current()->GetHeap()->GetImageSpace();
360 image_file_location_oat_checksum = image_space->GetImageHeader().GetOatChecksum();
361 image_file_location_oat_data_begin =
Ian Rogersef7d42f2014-01-06 12:55:46 -0800362 reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatDataBegin());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700363 image_file_location = image_space->GetImageFilename();
Brian Carlstrom7940e442013-07-12 13:46:57 -0700364 }
365
Brian Carlstromc50d8e12013-07-23 22:35:16 -0700366 OatWriter oat_writer(dex_files,
367 image_file_location_oat_checksum,
368 image_file_location_oat_data_begin,
369 image_file_location,
Ian Rogersca368cb2013-11-15 15:52:08 -0800370 driver.get(),
371 &timings);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700372
Ian Rogersca368cb2013-11-15 15:52:08 -0800373 TimingLogger::ScopedSplit split("Writing ELF", &timings);
Ian Rogers3d504072014-03-01 09:16:49 -0800374 if (!driver->WriteElf(android_root, is_host, dex_files, &oat_writer, oat_file)) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700375 LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
376 return NULL;
377 }
378
379 return driver.release();
380 }
381
382 bool CreateImageFile(const std::string& image_filename,
383 uintptr_t image_base,
384 const std::string& oat_filename,
385 const std::string& oat_location,
386 const CompilerDriver& compiler)
387 LOCKS_EXCLUDED(Locks::mutator_lock_) {
388 uintptr_t oat_data_begin;
389 {
390 // ImageWriter is scoped so it can free memory before doing FixupElf
391 ImageWriter image_writer(compiler);
392 if (!image_writer.Write(image_filename, image_base, oat_filename, oat_location)) {
393 LOG(ERROR) << "Failed to create image file " << image_filename;
394 return false;
395 }
396 oat_data_begin = image_writer.GetOatDataBegin();
397 }
398
Brian Carlstrom7571e8b2013-08-12 17:04:14 -0700399 UniquePtr<File> oat_file(OS::OpenFileReadWrite(oat_filename.c_str()));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700400 if (oat_file.get() == NULL) {
401 PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
402 return false;
403 }
404 if (!ElfFixup::Fixup(oat_file.get(), oat_data_begin)) {
405 LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
406 return false;
407 }
408 return true;
409 }
410
411 private:
Brian Carlstrom6449c622014-02-10 23:48:36 -0800412 explicit Dex2Oat(const CompilerOptions* compiler_options,
413 CompilerBackend::Kind compiler_backend,
Brian Carlstrom45602482013-07-21 22:07:55 -0700414 InstructionSet instruction_set,
Dave Allison70202782013-10-22 17:52:19 -0700415 InstructionSetFeatures instruction_set_features,
Brian Carlstrom6449c622014-02-10 23:48:36 -0800416 VerificationResults* verification_results,
417 DexFileToMethodInlinerMap* method_inliner_map,
Brian Carlstrom0177fe22013-07-21 12:21:36 -0700418 size_t thread_count)
Brian Carlstrom6449c622014-02-10 23:48:36 -0800419 : compiler_options_(compiler_options),
420 compiler_backend_(compiler_backend),
Brian Carlstrom7940e442013-07-12 13:46:57 -0700421 instruction_set_(instruction_set),
Dave Allison70202782013-10-22 17:52:19 -0700422 instruction_set_features_(instruction_set_features),
Brian Carlstrom6449c622014-02-10 23:48:36 -0800423 verification_results_(verification_results),
424 method_inliner_map_(method_inliner_map),
Vladimir Marko2b5eaa22013-12-13 13:59:30 +0000425 runtime_(nullptr),
Brian Carlstrom7940e442013-07-12 13:46:57 -0700426 thread_count_(thread_count),
Brian Carlstrom7940e442013-07-12 13:46:57 -0700427 start_ns_(NanoTime()) {
Brian Carlstrom6449c622014-02-10 23:48:36 -0800428 CHECK(compiler_options != nullptr);
429 CHECK(verification_results != nullptr);
430 CHECK(method_inliner_map != nullptr);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700431 }
432
Brian Carlstrom6449c622014-02-10 23:48:36 -0800433 bool CreateRuntime(const Runtime::Options& runtime_options, InstructionSet instruction_set)
Brian Carlstrom7940e442013-07-12 13:46:57 -0700434 SHARED_TRYLOCK_FUNCTION(true, Locks::mutator_lock_) {
Brian Carlstrom6449c622014-02-10 23:48:36 -0800435 if (!Runtime::Create(runtime_options, false)) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700436 LOG(ERROR) << "Failed to create runtime";
437 return false;
438 }
439 Runtime* runtime = Runtime::Current();
Brian Carlstrom7940e442013-07-12 13:46:57 -0700440 for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) {
441 Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i);
442 if (!runtime->HasCalleeSaveMethod(type)) {
443 runtime->SetCalleeSaveMethod(runtime->CreateCalleeSaveMethod(instruction_set, type), type);
444 }
445 }
446 runtime->GetClassLinker()->FixupDexCaches(runtime->GetResolutionMethod());
Vladimir Marko2b5eaa22013-12-13 13:59:30 +0000447 runtime_ = runtime;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700448 return true;
449 }
450
451 // Appends to dex_files any elements of class_path that it doesn't already
452 // contain. This will open those dex files as necessary.
Brian Carlstrom45602482013-07-21 22:07:55 -0700453 static void OpenClassPathFiles(const std::string& class_path,
454 std::vector<const DexFile*>& dex_files) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700455 std::vector<std::string> parsed;
456 Split(class_path, ':', parsed);
457 // Take Locks::mutator_lock_ so that lock ordering on the ClassLinker::dex_lock_ is maintained.
458 ScopedObjectAccess soa(Thread::Current());
459 for (size_t i = 0; i < parsed.size(); ++i) {
460 if (DexFilesContains(dex_files, parsed[i])) {
461 continue;
462 }
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700463 std::string error_msg;
464 const DexFile* dex_file = DexFile::Open(parsed[i].c_str(), parsed[i].c_str(), &error_msg);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700465 if (dex_file == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700466 LOG(WARNING) << "Failed to open dex file '" << parsed[i] << "': " << error_msg;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700467 } else {
468 dex_files.push_back(dex_file);
469 }
470 }
471 }
472
473 // Returns true if dex_files has a dex with the named location.
Brian Carlstrom45602482013-07-21 22:07:55 -0700474 static bool DexFilesContains(const std::vector<const DexFile*>& dex_files,
475 const std::string& location) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700476 for (size_t i = 0; i < dex_files.size(); ++i) {
477 if (dex_files[i]->GetLocation() == location) {
478 return true;
479 }
480 }
481 return false;
482 }
483
Brian Carlstromae7083d2014-02-24 21:56:02 -0800484 const CompilerOptions* const compiler_options_;
Nicolas Geoffrayf5df8972014-02-14 18:37:08 +0000485 const CompilerBackend::Kind compiler_backend_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700486
487 const InstructionSet instruction_set_;
Dave Allison70202782013-10-22 17:52:19 -0700488 const InstructionSetFeatures instruction_set_features_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700489
Brian Carlstromae7083d2014-02-24 21:56:02 -0800490 VerificationResults* const verification_results_;
491 DexFileToMethodInlinerMap* const method_inliner_map_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700492 Runtime* runtime_;
493 size_t thread_count_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700494 uint64_t start_ns_;
495
496 DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
497};
498
499static bool ParseInt(const char* in, int* out) {
500 char* end;
501 int result = strtol(in, &end, 10);
502 if (in == end || *end != '\0') {
503 return false;
504 }
505 *out = result;
506 return true;
507}
508
Brian Carlstrom3cf59d52013-11-10 21:04:10 -0800509static size_t OpenDexFiles(const std::vector<const char*>& dex_filenames,
510 const std::vector<const char*>& dex_locations,
511 std::vector<const DexFile*>& dex_files) {
512 size_t failure_count = 0;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700513 for (size_t i = 0; i < dex_filenames.size(); i++) {
514 const char* dex_filename = dex_filenames[i];
515 const char* dex_location = dex_locations[i];
Ian Rogers740a11d2014-01-14 10:11:25 -0800516 ATRACE_BEGIN(StringPrintf("Opening dex file '%s'", dex_filenames[i]).c_str());
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700517 std::string error_msg;
Brian Carlstromd5aba592013-11-12 01:52:44 -0800518 if (!OS::FileExists(dex_filename)) {
519 LOG(WARNING) << "Skipping non-existent dex file '" << dex_filename << "'";
520 continue;
521 }
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700522 const DexFile* dex_file = DexFile::Open(dex_filename, dex_location, &error_msg);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700523 if (dex_file == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700524 LOG(WARNING) << "Failed to open .dex from file '" << dex_filename << "': " << error_msg;
Brian Carlstrom3cf59d52013-11-10 21:04:10 -0800525 ++failure_count;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700526 } else {
527 dex_files.push_back(dex_file);
528 }
Ian Rogers740a11d2014-01-14 10:11:25 -0800529 ATRACE_END();
Brian Carlstrom7940e442013-07-12 13:46:57 -0700530 }
Brian Carlstrom3cf59d52013-11-10 21:04:10 -0800531 return failure_count;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700532}
533
534// The primary goal of the watchdog is to prevent stuck build servers
535// during development when fatal aborts lead to a cascade of failures
536// that result in a deadlock.
537class WatchDog {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700538// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using Log which uses locks
539#undef CHECK_PTHREAD_CALL
540#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
541 do { \
542 int rc = call args; \
543 if (rc != 0) { \
544 errno = rc; \
545 std::string message(# call); \
546 message += " failed for "; \
547 message += reason; \
548 Fatal(message); \
549 } \
550 } while (false)
551
552 public:
Brian Carlstrom93ba8932013-07-17 21:31:49 -0700553 explicit WatchDog(bool is_watch_dog_enabled) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700554 is_watch_dog_enabled_ = is_watch_dog_enabled;
555 if (!is_watch_dog_enabled_) {
556 return;
557 }
558 shutting_down_ = false;
559 const char* reason = "dex2oat watch dog thread startup";
560 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, NULL), reason);
561 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, NULL), reason);
562 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
563 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
564 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
565 }
566 ~WatchDog() {
567 if (!is_watch_dog_enabled_) {
568 return;
569 }
570 const char* reason = "dex2oat watch dog thread shutdown";
571 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
572 shutting_down_ = true;
573 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
574 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
575
576 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, NULL), reason);
577
578 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
579 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
580 }
581
582 private:
583 static void* CallBack(void* arg) {
584 WatchDog* self = reinterpret_cast<WatchDog*>(arg);
585 ::art::SetThreadName("dex2oat watch dog");
586 self->Wait();
587 return NULL;
588 }
589
590 static void Message(char severity, const std::string& message) {
591 // TODO: Remove when we switch to LOG when we can guarantee it won't prevent shutdown in error
592 // cases.
593 fprintf(stderr, "dex2oat%s %c %d %d %s\n",
594 kIsDebugBuild ? "d" : "",
595 severity,
596 getpid(),
597 GetTid(),
598 message.c_str());
599 }
600
601 static void Warn(const std::string& message) {
602 Message('W', message);
603 }
604
605 static void Fatal(const std::string& message) {
606 Message('F', message);
607 exit(1);
608 }
609
610 void Wait() {
611 bool warning = true;
612 CHECK_GT(kWatchDogTimeoutSeconds, kWatchDogWarningSeconds);
613 // TODO: tune the multiplier for GC verification, the following is just to make the timeout
614 // large.
Mathieu Chartier4e305412014-02-19 10:54:44 -0800615 int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700616 timespec warning_ts;
617 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogWarningSeconds * 1000, 0, &warning_ts);
618 timespec timeout_ts;
619 InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts);
620 const char* reason = "dex2oat watch dog thread waiting";
621 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
622 while (!shutting_down_) {
623 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_,
624 warning ? &warning_ts
625 : &timeout_ts));
626 if (rc == ETIMEDOUT) {
627 std::string message(StringPrintf("dex2oat did not finish after %d seconds",
628 warning ? kWatchDogWarningSeconds
629 : kWatchDogTimeoutSeconds));
630 if (warning) {
631 Warn(message.c_str());
632 warning = false;
633 } else {
634 Fatal(message.c_str());
635 }
636 } else if (rc != 0) {
637 std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
638 strerror(errno)));
639 Fatal(message.c_str());
640 }
641 }
642 CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
643 }
644
645 // When setting timeouts, keep in mind that the build server may not be as fast as your desktop.
646#if ART_USE_PORTABLE_COMPILER
647 static const unsigned int kWatchDogWarningSeconds = 2 * 60; // 2 minutes.
648 static const unsigned int kWatchDogTimeoutSeconds = 30 * 60; // 25 minutes + buffer.
649#else
650 static const unsigned int kWatchDogWarningSeconds = 1 * 60; // 1 minute.
651 static const unsigned int kWatchDogTimeoutSeconds = 6 * 60; // 5 minutes + buffer.
652#endif
653
654 bool is_watch_dog_enabled_;
655 bool shutting_down_;
656 // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
657 pthread_mutex_t mutex_;
658 pthread_cond_t cond_;
659 pthread_attr_t attr_;
660 pthread_t pthread_;
661};
662const unsigned int WatchDog::kWatchDogWarningSeconds;
663const unsigned int WatchDog::kWatchDogTimeoutSeconds;
664
Dave Allison70202782013-10-22 17:52:19 -0700665// Given a set of instruction features from the build, parse it. The
666// input 'str' is a comma separated list of feature names. Parse it and
667// return the InstructionSetFeatures object.
668static InstructionSetFeatures ParseFeatureList(std::string str) {
669 InstructionSetFeatures result;
670 typedef std::vector<std::string> FeatureList;
671 FeatureList features;
672 Split(str, ',', features);
673 for (FeatureList::iterator i = features.begin(); i != features.end(); i++) {
674 std::string feature = Trim(*i);
675 if (feature == "default") {
676 // Nothing to do.
677 } else if (feature == "div") {
678 // Supports divide instruction.
679 result.SetHasDivideInstruction(true);
680 } else if (feature == "nodiv") {
681 // Turn off support for divide instruction.
682 result.SetHasDivideInstruction(false);
683 } else {
684 Usage("Unknown instruction set feature: '%s'", feature.c_str());
685 }
686 }
687 // others...
688 return result;
689}
690
Brian Carlstrom7940e442013-07-12 13:46:57 -0700691static int dex2oat(int argc, char** argv) {
Brian Carlstrom6449c622014-02-10 23:48:36 -0800692 original_argc = argc;
693 original_argv = argv;
694
Ian Rogers5fe9af72013-11-14 00:17:20 -0800695 TimingLogger timings("compiler", false, false);
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +0000696 CumulativeLogger compiler_phases_timings("compilation times");
Brian Carlstrom45602482013-07-21 22:07:55 -0700697
Brian Carlstrom7940e442013-07-12 13:46:57 -0700698 InitLogging(argv);
699
700 // Skip over argv[0].
701 argv++;
702 argc--;
703
704 if (argc == 0) {
Brian Carlstrome0948e12013-08-29 09:36:15 -0700705 Usage("No arguments specified");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700706 }
707
708 std::vector<const char*> dex_filenames;
709 std::vector<const char*> dex_locations;
710 int zip_fd = -1;
711 std::string zip_location;
712 std::string oat_filename;
713 std::string oat_symbols;
714 std::string oat_location;
715 int oat_fd = -1;
716 std::string bitcode_filename;
717 const char* image_classes_zip_filename = NULL;
718 const char* image_classes_filename = NULL;
719 std::string image_filename;
720 std::string boot_image_filename;
721 uintptr_t image_base = 0;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700722 std::string android_root;
723 std::vector<const char*> runtime_args;
724 int thread_count = sysconf(_SC_NPROCESSORS_CONF);
Nicolas Geoffrayf5df8972014-02-14 18:37:08 +0000725 CompilerBackend::Kind compiler_backend = kUsePortableCompiler
726 ? CompilerBackend::kPortable
727 : CompilerBackend::kQuick;
Brian Carlstrom6449c622014-02-10 23:48:36 -0800728 const char* compiler_filter_string = NULL;
729 int huge_method_threshold = CompilerOptions::kDefaultHugeMethodThreshold;
730 int large_method_threshold = CompilerOptions::kDefaultLargeMethodThreshold;
731 int small_method_threshold = CompilerOptions::kDefaultSmallMethodThreshold;
732 int tiny_method_threshold = CompilerOptions::kDefaultTinyMethodThreshold;
733 int num_dex_methods_threshold = CompilerOptions::kDefaultNumDexMethodsThreshold;
Dave Allison70202782013-10-22 17:52:19 -0700734
Brian Carlstrom1bd2ceb2013-11-06 00:29:48 -0800735 // Take the default set of instruction features from the build.
Dave Allison70202782013-10-22 17:52:19 -0700736 InstructionSetFeatures instruction_set_features =
Brian Carlstrom1bd2ceb2013-11-06 00:29:48 -0800737 ParseFeatureList(STRINGIFY(ART_DEFAULT_INSTRUCTION_SET_FEATURES));
Dave Allison70202782013-10-22 17:52:19 -0700738
Brian Carlstrom7940e442013-07-12 13:46:57 -0700739#if defined(__arm__)
740 InstructionSet instruction_set = kThumb2;
741#elif defined(__i386__)
742 InstructionSet instruction_set = kX86;
743#elif defined(__mips__)
744 InstructionSet instruction_set = kMips;
745#else
Ian Rogersef7d42f2014-01-06 12:55:46 -0800746 InstructionSet instruction_set = kNone;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700747#endif
Dave Allison70202782013-10-22 17:52:19 -0700748
Dave Allison39c3bfb2014-01-28 18:33:52 -0800749 // Profile file to use
750 std::string profile_file;
Dave Allison70202782013-10-22 17:52:19 -0700751
Brian Carlstrom7940e442013-07-12 13:46:57 -0700752 bool is_host = false;
Ian Rogerse732ef12013-10-09 15:22:24 -0700753 bool dump_stats = false;
Ian Rogers46398602013-08-20 07:50:36 -0700754 bool dump_timing = false;
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +0000755 bool dump_passes = false;
Ian Rogers46398602013-08-20 07:50:36 -0700756 bool dump_slow_timing = kIsDebugBuild;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700757 bool watch_dog_enabled = !kIsTargetBuild;
Mark Mendellae9fd932014-02-10 16:14:35 -0800758 bool generate_gdb_information = kIsDebugBuild;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700759
Brian Carlstrom7940e442013-07-12 13:46:57 -0700760 for (int i = 0; i < argc; i++) {
761 const StringPiece option(argv[i]);
762 bool log_options = false;
763 if (log_options) {
764 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
765 }
766 if (option.starts_with("--dex-file=")) {
767 dex_filenames.push_back(option.substr(strlen("--dex-file=")).data());
768 } else if (option.starts_with("--dex-location=")) {
769 dex_locations.push_back(option.substr(strlen("--dex-location=")).data());
770 } else if (option.starts_with("--zip-fd=")) {
771 const char* zip_fd_str = option.substr(strlen("--zip-fd=")).data();
772 if (!ParseInt(zip_fd_str, &zip_fd)) {
Brian Carlstrome0948e12013-08-29 09:36:15 -0700773 Usage("Failed to parse --zip-fd argument '%s' as an integer", zip_fd_str);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700774 }
Brian Carlstrom6449c622014-02-10 23:48:36 -0800775 if (zip_fd < 0) {
776 Usage("--zip-fd passed a negative value %d", zip_fd);
777 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700778 } else if (option.starts_with("--zip-location=")) {
779 zip_location = option.substr(strlen("--zip-location=")).data();
780 } else if (option.starts_with("--oat-file=")) {
781 oat_filename = option.substr(strlen("--oat-file=")).data();
782 } else if (option.starts_with("--oat-symbols=")) {
783 oat_symbols = option.substr(strlen("--oat-symbols=")).data();
784 } else if (option.starts_with("--oat-fd=")) {
785 const char* oat_fd_str = option.substr(strlen("--oat-fd=")).data();
786 if (!ParseInt(oat_fd_str, &oat_fd)) {
Brian Carlstrome0948e12013-08-29 09:36:15 -0700787 Usage("Failed to parse --oat-fd argument '%s' as an integer", oat_fd_str);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700788 }
Brian Carlstrom6449c622014-02-10 23:48:36 -0800789 if (oat_fd < 0) {
790 Usage("--oat-fd passed a negative value %d", oat_fd);
791 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700792 } else if (option == "--watch-dog") {
793 watch_dog_enabled = true;
794 } else if (option == "--no-watch-dog") {
795 watch_dog_enabled = false;
Mark Mendellae9fd932014-02-10 16:14:35 -0800796 } else if (option == "--gen-gdb-info") {
797 generate_gdb_information = true;
798 } else if (option == "--no-gen-gdb-info") {
799 generate_gdb_information = false;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700800 } else if (option.starts_with("-j")) {
801 const char* thread_count_str = option.substr(strlen("-j")).data();
802 if (!ParseInt(thread_count_str, &thread_count)) {
Brian Carlstrome0948e12013-08-29 09:36:15 -0700803 Usage("Failed to parse -j argument '%s' as an integer", thread_count_str);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700804 }
805 } else if (option.starts_with("--oat-location=")) {
806 oat_location = option.substr(strlen("--oat-location=")).data();
807 } else if (option.starts_with("--bitcode=")) {
808 bitcode_filename = option.substr(strlen("--bitcode=")).data();
809 } else if (option.starts_with("--image=")) {
810 image_filename = option.substr(strlen("--image=")).data();
811 } else if (option.starts_with("--image-classes=")) {
812 image_classes_filename = option.substr(strlen("--image-classes=")).data();
813 } else if (option.starts_with("--image-classes-zip=")) {
814 image_classes_zip_filename = option.substr(strlen("--image-classes-zip=")).data();
815 } else if (option.starts_with("--base=")) {
816 const char* image_base_str = option.substr(strlen("--base=")).data();
817 char* end;
818 image_base = strtoul(image_base_str, &end, 16);
819 if (end == image_base_str || *end != '\0') {
820 Usage("Failed to parse hexadecimal value for option %s", option.data());
821 }
822 } else if (option.starts_with("--boot-image=")) {
823 boot_image_filename = option.substr(strlen("--boot-image=")).data();
Brian Carlstrom7940e442013-07-12 13:46:57 -0700824 } else if (option.starts_with("--android-root=")) {
825 android_root = option.substr(strlen("--android-root=")).data();
826 } else if (option.starts_with("--instruction-set=")) {
827 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
828 if (instruction_set_str == "arm") {
829 instruction_set = kThumb2;
830 } else if (instruction_set_str == "mips") {
831 instruction_set = kMips;
832 } else if (instruction_set_str == "x86") {
833 instruction_set = kX86;
Ian Rogersef7d42f2014-01-06 12:55:46 -0800834 } else if (instruction_set_str == "x86_64") {
835 instruction_set = kX86_64;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700836 }
Dave Allison70202782013-10-22 17:52:19 -0700837 } else if (option.starts_with("--instruction-set-features=")) {
838 StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
839 instruction_set_features = ParseFeatureList(str.as_string());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700840 } else if (option.starts_with("--compiler-backend=")) {
841 StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
842 if (backend_str == "Quick") {
Nicolas Geoffrayf5df8972014-02-14 18:37:08 +0000843 compiler_backend = CompilerBackend::kQuick;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700844 } else if (backend_str == "Portable") {
Nicolas Geoffrayf5df8972014-02-14 18:37:08 +0000845 compiler_backend = CompilerBackend::kPortable;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700846 }
Brian Carlstrom6449c622014-02-10 23:48:36 -0800847 } else if (option.starts_with("--compiler-filter=")) {
848 compiler_filter_string = option.substr(strlen("--compiler-filter=")).data();
849 } else if (option.starts_with("--huge-method-max=")) {
850 const char* threshold = option.substr(strlen("--huge-method-max=")).data();
851 if (!ParseInt(threshold, &huge_method_threshold)) {
852 Usage("Failed to parse --huge-method-max '%s' as an integer", threshold);
853 }
854 if (huge_method_threshold < 0) {
855 Usage("--huge-method-max passed a negative value %s", huge_method_threshold);
856 }
857 } else if (option.starts_with("--large-method-max=")) {
858 const char* threshold = option.substr(strlen("--large-method-max=")).data();
859 if (!ParseInt(threshold, &large_method_threshold)) {
860 Usage("Failed to parse --large-method-max '%s' as an integer", threshold);
861 }
862 if (large_method_threshold < 0) {
863 Usage("--large-method-max passed a negative value %s", large_method_threshold);
864 }
865 } else if (option.starts_with("--small-method-max=")) {
866 const char* threshold = option.substr(strlen("--small-method-max=")).data();
867 if (!ParseInt(threshold, &small_method_threshold)) {
868 Usage("Failed to parse --small-method-max '%s' as an integer", threshold);
869 }
870 if (small_method_threshold < 0) {
871 Usage("--small-method-max passed a negative value %s", small_method_threshold);
872 }
873 } else if (option.starts_with("--tiny-method-max=")) {
874 const char* threshold = option.substr(strlen("--tiny-method-max=")).data();
875 if (!ParseInt(threshold, &tiny_method_threshold)) {
876 Usage("Failed to parse --tiny-method-max '%s' as an integer", threshold);
877 }
878 if (tiny_method_threshold < 0) {
879 Usage("--tiny-method-max passed a negative value %s", tiny_method_threshold);
880 }
881 } else if (option.starts_with("--num-dex-methods=")) {
882 const char* threshold = option.substr(strlen("--num-dex-methods=")).data();
883 if (!ParseInt(threshold, &num_dex_methods_threshold)) {
884 Usage("Failed to parse --num-dex-methods '%s' as an integer", threshold);
885 }
886 if (num_dex_methods_threshold < 0) {
887 Usage("--num-dex-methods passed a negative value %s", num_dex_methods_threshold);
888 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700889 } else if (option == "--host") {
890 is_host = true;
891 } else if (option == "--runtime-arg") {
892 if (++i >= argc) {
893 Usage("Missing required argument for --runtime-arg");
894 }
895 if (log_options) {
896 LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
897 }
898 runtime_args.push_back(argv[i]);
Ian Rogers46398602013-08-20 07:50:36 -0700899 } else if (option == "--dump-timing") {
900 dump_timing = true;
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +0000901 } else if (option == "--dump-passes") {
902 dump_passes = true;
Ian Rogerse732ef12013-10-09 15:22:24 -0700903 } else if (option == "--dump-stats") {
904 dump_stats = true;
Dave Allison39c3bfb2014-01-28 18:33:52 -0800905 } else if (option.starts_with("--profile-file=")) {
906 profile_file = option.substr(strlen("--profile-file=")).data();
907 VLOG(compiler) << "dex2oat: profile file is " << profile_file;
908 } else if (option == "--no-profile-file") {
909 LOG(INFO) << "dex2oat: no profile file supplied (explictly)";
910 // No profile
Brian Carlstrom7940e442013-07-12 13:46:57 -0700911 } else {
Brian Carlstrome0948e12013-08-29 09:36:15 -0700912 Usage("Unknown argument %s", option.data());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700913 }
914 }
915
916 if (oat_filename.empty() && oat_fd == -1) {
917 Usage("Output must be supplied with either --oat-file or --oat-fd");
918 }
919
920 if (!oat_filename.empty() && oat_fd != -1) {
921 Usage("--oat-file should not be used with --oat-fd");
922 }
923
924 if (!oat_symbols.empty() && oat_fd != -1) {
925 Usage("--oat-symbols should not be used with --oat-fd");
926 }
927
928 if (!oat_symbols.empty() && is_host) {
929 Usage("--oat-symbols should not be used with --host");
930 }
931
932 if (oat_fd != -1 && !image_filename.empty()) {
933 Usage("--oat-fd should not be used with --image");
934 }
935
Brian Carlstrom7940e442013-07-12 13:46:57 -0700936 if (android_root.empty()) {
937 const char* android_root_env_var = getenv("ANDROID_ROOT");
938 if (android_root_env_var == NULL) {
939 Usage("--android-root unspecified and ANDROID_ROOT not set");
940 }
941 android_root += android_root_env_var;
942 }
943
944 bool image = (!image_filename.empty());
945 if (!image && boot_image_filename.empty()) {
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000946 boot_image_filename += GetAndroidRoot();
Brian Carlstrom7940e442013-07-12 13:46:57 -0700947 boot_image_filename += "/framework/boot.art";
948 }
949 std::string boot_image_option;
950 if (!boot_image_filename.empty()) {
951 boot_image_option += "-Ximage:";
952 boot_image_option += boot_image_filename;
953 }
954
955 if (image_classes_filename != NULL && !image) {
956 Usage("--image-classes should only be used with --image");
957 }
958
959 if (image_classes_filename != NULL && !boot_image_option.empty()) {
960 Usage("--image-classes should not be used with --boot-image");
961 }
962
963 if (image_classes_zip_filename != NULL && image_classes_filename == NULL) {
964 Usage("--image-classes-zip should be used with --image-classes");
965 }
966
967 if (dex_filenames.empty() && zip_fd == -1) {
968 Usage("Input must be supplied with either --dex-file or --zip-fd");
969 }
970
971 if (!dex_filenames.empty() && zip_fd != -1) {
972 Usage("--dex-file should not be used with --zip-fd");
973 }
974
975 if (!dex_filenames.empty() && !zip_location.empty()) {
976 Usage("--dex-file should not be used with --zip-location");
977 }
978
979 if (dex_locations.empty()) {
980 for (size_t i = 0; i < dex_filenames.size(); i++) {
981 dex_locations.push_back(dex_filenames[i]);
982 }
983 } else if (dex_locations.size() != dex_filenames.size()) {
984 Usage("--dex-location arguments do not match --dex-file arguments");
985 }
986
987 if (zip_fd != -1 && zip_location.empty()) {
988 Usage("--zip-location should be supplied with --zip-fd");
989 }
990
991 if (boot_image_option.empty()) {
992 if (image_base == 0) {
Brian Carlstrome0948e12013-08-29 09:36:15 -0700993 Usage("Non-zero --base not specified");
Brian Carlstrom7940e442013-07-12 13:46:57 -0700994 }
995 }
996
997 std::string oat_stripped(oat_filename);
998 std::string oat_unstripped;
999 if (!oat_symbols.empty()) {
1000 oat_unstripped += oat_symbols;
1001 } else {
1002 oat_unstripped += oat_filename;
1003 }
1004
Brian Carlstrom6449c622014-02-10 23:48:36 -08001005 if (compiler_filter_string == NULL) {
Ian Rogersbefbd572014-03-06 01:13:39 -08001006 if (instruction_set == kX86_64) {
1007 // TODO: currently x86-64 is only interpreted.
1008 compiler_filter_string = "interpret-only";
1009 } else if (image) {
Brian Carlstrom5e754d82014-03-05 10:59:04 -08001010 compiler_filter_string = "speed";
Brian Carlstrom6449c622014-02-10 23:48:36 -08001011 } else {
1012#if ART_SMALL_MODE
1013 compiler_filter_string = "interpret-only";
1014#else
1015 compiler_filter_string = "speed";
1016#endif
1017 }
1018 }
1019 CHECK(compiler_filter_string != nullptr);
1020 CompilerOptions::CompilerFilter compiler_filter = CompilerOptions::kDefaultCompilerFilter;
1021 if (strcmp(compiler_filter_string, "interpret-only") == 0) {
1022 compiler_filter = CompilerOptions::kInterpretOnly;
1023 } else if (strcmp(compiler_filter_string, "space") == 0) {
1024 compiler_filter = CompilerOptions::kSpace;
1025 } else if (strcmp(compiler_filter_string, "balanced") == 0) {
1026 compiler_filter = CompilerOptions::kBalanced;
1027 } else if (strcmp(compiler_filter_string, "speed") == 0) {
1028 compiler_filter = CompilerOptions::kSpeed;
1029 } else if (strcmp(compiler_filter_string, "everything") == 0) {
1030 compiler_filter = CompilerOptions::kEverything;
1031 } else {
1032 Usage("Unknown --compiler-filter value %s", compiler_filter_string);
1033 }
1034
1035 CompilerOptions compiler_options(compiler_filter,
1036 huge_method_threshold,
1037 large_method_threshold,
1038 small_method_threshold,
1039 tiny_method_threshold,
Mark Mendellae9fd932014-02-10 16:14:35 -08001040 num_dex_methods_threshold,
1041 generate_gdb_information
Brian Carlstrom6449c622014-02-10 23:48:36 -08001042#ifdef ART_SEA_IR_MODE
1043 , compiler_options.sea_ir_ = true;
1044#endif
1045 ); // NOLINT(whitespace/parens)
1046
Brian Carlstrom7940e442013-07-12 13:46:57 -07001047 // Done with usage checks, enable watchdog if requested
1048 WatchDog watch_dog(watch_dog_enabled);
1049
1050 // Check early that the result of compilation can be written
1051 UniquePtr<File> oat_file;
1052 bool create_file = !oat_unstripped.empty(); // as opposed to using open file descriptor
1053 if (create_file) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07001054 oat_file.reset(OS::CreateEmptyFile(oat_unstripped.c_str()));
Brian Carlstrom7940e442013-07-12 13:46:57 -07001055 if (oat_location.empty()) {
1056 oat_location = oat_filename;
1057 }
1058 } else {
1059 oat_file.reset(new File(oat_fd, oat_location));
1060 oat_file->DisableAutoClose();
1061 }
1062 if (oat_file.get() == NULL) {
1063 PLOG(ERROR) << "Failed to create oat file: " << oat_location;
1064 return EXIT_FAILURE;
1065 }
1066 if (create_file && fchmod(oat_file->Fd(), 0644) != 0) {
1067 PLOG(ERROR) << "Failed to make oat file world readable: " << oat_location;
1068 return EXIT_FAILURE;
1069 }
1070
Ian Rogerse6bb3b22013-08-19 21:51:45 -07001071 timings.StartSplit("dex2oat Setup");
Brian Carlstrom6449c622014-02-10 23:48:36 -08001072 LOG(INFO) << "dex2oat: " << CommandLine();
Brian Carlstrom7940e442013-07-12 13:46:57 -07001073
Brian Carlstrom6449c622014-02-10 23:48:36 -08001074 Runtime::Options runtime_options;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001075 std::vector<const DexFile*> boot_class_path;
1076 if (boot_image_option.empty()) {
Brian Carlstrom3cf59d52013-11-10 21:04:10 -08001077 size_t failure_count = OpenDexFiles(dex_filenames, dex_locations, boot_class_path);
1078 if (failure_count > 0) {
1079 LOG(ERROR) << "Failed to open some dex files: " << failure_count;
1080 return EXIT_FAILURE;
1081 }
Brian Carlstrom6449c622014-02-10 23:48:36 -08001082 runtime_options.push_back(std::make_pair("bootclasspath", &boot_class_path));
Brian Carlstrom7940e442013-07-12 13:46:57 -07001083 } else {
Brian Carlstrom6449c622014-02-10 23:48:36 -08001084 runtime_options.push_back(std::make_pair(boot_image_option.c_str(),
1085 reinterpret_cast<void*>(NULL)));
Brian Carlstrom7940e442013-07-12 13:46:57 -07001086 }
Brian Carlstrom7940e442013-07-12 13:46:57 -07001087 for (size_t i = 0; i < runtime_args.size(); i++) {
Brian Carlstrom6449c622014-02-10 23:48:36 -08001088 runtime_options.push_back(std::make_pair(runtime_args[i], reinterpret_cast<void*>(NULL)));
Brian Carlstrom7940e442013-07-12 13:46:57 -07001089 }
1090
Brian Carlstrom6449c622014-02-10 23:48:36 -08001091 VerificationResults verification_results(&compiler_options);
1092 DexFileToMethodInlinerMap method_inliner_map;
1093 CompilerCallbacksImpl callbacks(&verification_results, &method_inliner_map);
1094 runtime_options.push_back(std::make_pair("compilercallbacks", &callbacks));
Brian Carlstrom7940e442013-07-12 13:46:57 -07001095
Brian Carlstrom7940e442013-07-12 13:46:57 -07001096 Dex2Oat* p_dex2oat;
Brian Carlstrom6449c622014-02-10 23:48:36 -08001097 if (!Dex2Oat::Create(&p_dex2oat,
1098 runtime_options,
1099 compiler_options,
1100 compiler_backend,
1101 instruction_set,
1102 instruction_set_features,
1103 &verification_results,
1104 &method_inliner_map,
1105 thread_count)) {
Brian Carlstrom7940e442013-07-12 13:46:57 -07001106 LOG(ERROR) << "Failed to create dex2oat";
1107 return EXIT_FAILURE;
1108 }
1109 UniquePtr<Dex2Oat> dex2oat(p_dex2oat);
1110 // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start,
Ian Rogers3f3d22c2013-08-27 18:11:09 -07001111 // give it away now so that we don't starve GC.
1112 Thread* self = Thread::Current();
1113 self->TransitionFromRunnableToSuspended(kNative);
Ian Rogers0f40ac32013-08-13 22:10:30 -07001114 // If we're doing the image, override the compiler filter to force full compilation. Must be
buzbeefe9ca402013-08-21 09:48:11 -07001115 // done ahead of WellKnownClasses::Init that causes verification. Note: doesn't force
1116 // compilation of class initializers.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001117 // Whilst we're in native take the opportunity to initialize well known classes.
Ian Rogers3f3d22c2013-08-27 18:11:09 -07001118 WellKnownClasses::Init(self->GetJniEnv());
Brian Carlstrom7940e442013-07-12 13:46:57 -07001119
1120 // If --image-classes was specified, calculate the full list of classes to include in the image
1121 UniquePtr<CompilerDriver::DescriptorSet> image_classes(NULL);
1122 if (image_classes_filename != NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -07001123 std::string error_msg;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001124 if (image_classes_zip_filename != NULL) {
1125 image_classes.reset(dex2oat->ReadImageClassesFromZip(image_classes_zip_filename,
Ian Rogers8d31bbd2013-10-13 10:44:14 -07001126 image_classes_filename,
1127 &error_msg));
Brian Carlstrom7940e442013-07-12 13:46:57 -07001128 } else {
1129 image_classes.reset(dex2oat->ReadImageClassesFromFile(image_classes_filename));
1130 }
1131 if (image_classes.get() == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -07001132 LOG(ERROR) << "Failed to create list of image classes from '" << image_classes_filename <<
1133 "': " << error_msg;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001134 return EXIT_FAILURE;
1135 }
1136 }
1137
1138 std::vector<const DexFile*> dex_files;
1139 if (boot_image_option.empty()) {
1140 dex_files = Runtime::Current()->GetClassLinker()->GetBootClassPath();
1141 } else {
1142 if (dex_filenames.empty()) {
Ian Rogers740a11d2014-01-14 10:11:25 -08001143 ATRACE_BEGIN("Opening zip archive from file descriptor");
Ian Rogers8d31bbd2013-10-13 10:44:14 -07001144 std::string error_msg;
1145 UniquePtr<ZipArchive> zip_archive(ZipArchive::OpenFromFd(zip_fd, zip_location.c_str(),
1146 &error_msg));
Brian Carlstrom7940e442013-07-12 13:46:57 -07001147 if (zip_archive.get() == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -07001148 LOG(ERROR) << "Failed to open zip from file descriptor for '" << zip_location << "': "
1149 << error_msg;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001150 return EXIT_FAILURE;
1151 }
Ian Rogers8d31bbd2013-10-13 10:44:14 -07001152 const DexFile* dex_file = DexFile::Open(*zip_archive.get(), zip_location, &error_msg);
Brian Carlstrom7940e442013-07-12 13:46:57 -07001153 if (dex_file == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -07001154 LOG(ERROR) << "Failed to open dex from file descriptor for zip file '" << zip_location
1155 << "': " << error_msg;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001156 return EXIT_FAILURE;
1157 }
1158 dex_files.push_back(dex_file);
Ian Rogers740a11d2014-01-14 10:11:25 -08001159 ATRACE_END();
Brian Carlstrom7940e442013-07-12 13:46:57 -07001160 } else {
Brian Carlstrom3cf59d52013-11-10 21:04:10 -08001161 size_t failure_count = OpenDexFiles(dex_filenames, dex_locations, dex_files);
1162 if (failure_count > 0) {
1163 LOG(ERROR) << "Failed to open some dex files: " << failure_count;
1164 return EXIT_FAILURE;
1165 }
Brian Carlstrom7940e442013-07-12 13:46:57 -07001166 }
Brian Carlstromd76e0832013-08-29 15:17:42 -07001167
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001168 const bool kSaveDexInput = false;
1169 if (kSaveDexInput) {
1170 for (size_t i = 0; i < dex_files.size(); ++i) {
1171 const DexFile* dex_file = dex_files[i];
Ian Rogers5180cc12014-02-21 13:34:16 -08001172 std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex", getpid(), i));
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001173 UniquePtr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
1174 if (tmp_file.get() == nullptr) {
Brian Carlstrom6449c622014-02-10 23:48:36 -08001175 PLOG(ERROR) << "Failed to open file " << tmp_file_name
1176 << ". Try: adb shell chmod 777 /data/local/tmp";
Brian Carlstromf79fccb2014-02-20 08:55:10 -08001177 continue;
1178 }
1179 tmp_file->WriteFully(dex_file->Begin(), dex_file->Size());
1180 LOG(INFO) << "Wrote input to " << tmp_file_name;
1181 }
1182 }
Brian Carlstrom2ec65202014-03-03 15:16:37 -08001183 }
1184 // Ensure opened dex files are writable for dex-to-dex transformations.
1185 for (const auto& dex_file : dex_files) {
1186 if (!dex_file->EnableWrite()) {
1187 PLOG(ERROR) << "Failed to make .dex file writeable '" << dex_file->GetLocation() << "'\n";
Brian Carlstromd76e0832013-08-29 15:17:42 -07001188 }
Brian Carlstrom7940e442013-07-12 13:46:57 -07001189 }
1190
buzbeea024a062013-07-31 10:47:37 -07001191 /*
1192 * If we're not in interpret-only mode, go ahead and compile small applications. Don't
1193 * bother to check if we're doing the image.
1194 */
Brian Carlstrom6449c622014-02-10 23:48:36 -08001195 if (!image && (compiler_options.GetCompilerFilter() != CompilerOptions::kInterpretOnly)) {
Brian Carlstrom7940e442013-07-12 13:46:57 -07001196 size_t num_methods = 0;
1197 for (size_t i = 0; i != dex_files.size(); ++i) {
1198 const DexFile* dex_file = dex_files[i];
1199 CHECK(dex_file != NULL);
1200 num_methods += dex_file->NumMethodIds();
1201 }
Brian Carlstrom6449c622014-02-10 23:48:36 -08001202 if (num_methods <= compiler_options.GetNumDexMethodsThreshold()) {
1203 compiler_options.SetCompilerFilter(CompilerOptions::kSpeed);
Anwar Ghuloum75a43f12013-08-13 17:22:14 -07001204 VLOG(compiler) << "Below method threshold, compiling anyways";
Brian Carlstrom7940e442013-07-12 13:46:57 -07001205 }
1206 }
1207
1208 UniquePtr<const CompilerDriver> compiler(dex2oat->CreateOatFile(boot_image_option,
Brian Carlstrom7940e442013-07-12 13:46:57 -07001209 android_root,
1210 is_host,
1211 dex_files,
1212 oat_file.get(),
1213 bitcode_filename,
1214 image,
1215 image_classes,
1216 dump_stats,
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00001217 dump_passes,
1218 timings,
Dave Allison39c3bfb2014-01-28 18:33:52 -08001219 compiler_phases_timings,
1220 profile_file));
Brian Carlstrom7940e442013-07-12 13:46:57 -07001221
1222 if (compiler.get() == NULL) {
1223 LOG(ERROR) << "Failed to create oat file: " << oat_location;
1224 return EXIT_FAILURE;
1225 }
1226
Anwar Ghuloum75a43f12013-08-13 17:22:14 -07001227 VLOG(compiler) << "Oat file written successfully (unstripped): " << oat_location;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001228
1229 // Notes on the interleaving of creating the image and oat file to
1230 // ensure the references between the two are correct.
1231 //
1232 // Currently we have a memory layout that looks something like this:
1233 //
1234 // +--------------+
1235 // | image |
1236 // +--------------+
1237 // | boot oat |
1238 // +--------------+
1239 // | alloc spaces |
1240 // +--------------+
1241 //
Brian Carlstrom45602482013-07-21 22:07:55 -07001242 // There are several constraints on the loading of the image and boot.oat.
Brian Carlstrom7940e442013-07-12 13:46:57 -07001243 //
1244 // 1. The image is expected to be loaded at an absolute address and
1245 // contains Objects with absolute pointers within the image.
1246 //
1247 // 2. There are absolute pointers from Methods in the image to their
1248 // code in the oat.
1249 //
1250 // 3. There are absolute pointers from the code in the oat to Methods
1251 // in the image.
1252 //
1253 // 4. There are absolute pointers from code in the oat to other code
1254 // in the oat.
1255 //
1256 // To get this all correct, we go through several steps.
1257 //
1258 // 1. We have already created that oat file above with
1259 // CreateOatFile. Originally this was just our own proprietary file
Brian Carlstrom45602482013-07-21 22:07:55 -07001260 // but now it is contained within an ELF dynamic object (aka an .so
Brian Carlstrom7940e442013-07-12 13:46:57 -07001261 // file). The Compiler returned by CreateOatFile provides
1262 // PatchInformation for references to oat code and Methods that need
1263 // to be update once we know where the oat file will be located
1264 // after the image.
1265 //
1266 // 2. We create the image file. It needs to know where the oat file
1267 // will be loaded after itself. Originally when oat file was simply
1268 // memory mapped so we could predict where its contents were based
1269 // on the file size. Now that it is an ELF file, we need to inspect
1270 // the ELF file to understand the in memory segment layout including
1271 // where the oat header is located within. ImageWriter's
1272 // PatchOatCodeAndMethods uses the PatchInformation from the
1273 // Compiler to touch up absolute references in the oat file.
1274 //
1275 // 3. We fixup the ELF program headers so that dlopen will try to
1276 // load the .so at the desired location at runtime by offsetting the
1277 // Elf32_Phdr.p_vaddr values by the desired base address.
1278 //
1279 if (image) {
Anwar Ghuloum6f28d912013-07-24 15:02:53 -07001280 timings.NewSplit("dex2oat ImageWriter");
Brian Carlstrom7940e442013-07-12 13:46:57 -07001281 bool image_creation_success = dex2oat->CreateImageFile(image_filename,
1282 image_base,
1283 oat_unstripped,
1284 oat_location,
1285 *compiler.get());
Brian Carlstrom7940e442013-07-12 13:46:57 -07001286 if (!image_creation_success) {
1287 return EXIT_FAILURE;
1288 }
Anwar Ghuloum75a43f12013-08-13 17:22:14 -07001289 VLOG(compiler) << "Image written successfully: " << image_filename;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001290 }
1291
1292 if (is_host) {
Ian Rogers46398602013-08-20 07:50:36 -07001293 if (dump_timing || (dump_slow_timing && timings.GetTotalNs() > MsToNs(1000))) {
Ian Rogers5fe9af72013-11-14 00:17:20 -08001294 LOG(INFO) << Dumpable<TimingLogger>(timings);
Brian Carlstrom45602482013-07-21 22:07:55 -07001295 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00001296 if (dump_passes) {
Ian Rogers3d504072014-03-01 09:16:49 -08001297 LOG(INFO) << Dumpable<CumulativeLogger>(*compiler.get()->GetTimingsLogger());
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00001298 }
Brian Carlstrom7940e442013-07-12 13:46:57 -07001299 return EXIT_SUCCESS;
1300 }
1301
1302 // If we don't want to strip in place, copy from unstripped location to stripped location.
1303 // We need to strip after image creation because FixupElf needs to use .strtab.
1304 if (oat_unstripped != oat_stripped) {
Anwar Ghuloum6f28d912013-07-24 15:02:53 -07001305 timings.NewSplit("dex2oat OatFile copy");
Brian Carlstrom7940e442013-07-12 13:46:57 -07001306 oat_file.reset();
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07001307 UniquePtr<File> in(OS::OpenFileForReading(oat_unstripped.c_str()));
1308 UniquePtr<File> out(OS::CreateEmptyFile(oat_stripped.c_str()));
Brian Carlstrom7940e442013-07-12 13:46:57 -07001309 size_t buffer_size = 8192;
1310 UniquePtr<uint8_t> buffer(new uint8_t[buffer_size]);
1311 while (true) {
1312 int bytes_read = TEMP_FAILURE_RETRY(read(in->Fd(), buffer.get(), buffer_size));
1313 if (bytes_read <= 0) {
1314 break;
1315 }
1316 bool write_ok = out->WriteFully(buffer.get(), bytes_read);
1317 CHECK(write_ok);
1318 }
1319 oat_file.reset(out.release());
Anwar Ghuloum75a43f12013-08-13 17:22:14 -07001320 VLOG(compiler) << "Oat file copied successfully (stripped): " << oat_stripped;
Brian Carlstrom7940e442013-07-12 13:46:57 -07001321 }
1322
Brian Carlstrom7fcba112013-07-22 10:28:48 -07001323#if ART_USE_PORTABLE_COMPILER // We currently only generate symbols on Portable
Anwar Ghuloum6f28d912013-07-24 15:02:53 -07001324 timings.NewSplit("dex2oat ElfStripper");
Brian Carlstrom7940e442013-07-12 13:46:57 -07001325 // Strip unneeded sections for target
1326 off_t seek_actual = lseek(oat_file->Fd(), 0, SEEK_SET);
1327 CHECK_EQ(0, seek_actual);
Ian Rogers8d31bbd2013-10-13 10:44:14 -07001328 std::string error_msg;
1329 CHECK(ElfStripper::Strip(oat_file.get(), &error_msg)) << error_msg;
Anwar Ghuloum6f28d912013-07-24 15:02:53 -07001330
Brian Carlstrom7940e442013-07-12 13:46:57 -07001331
1332 // We wrote the oat file successfully, and want to keep it.
Anwar Ghuloum75a43f12013-08-13 17:22:14 -07001333 VLOG(compiler) << "Oat file written successfully (stripped): " << oat_location;
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001334#endif // ART_USE_PORTABLE_COMPILER
Brian Carlstrom45602482013-07-21 22:07:55 -07001335
Anwar Ghuloum6f28d912013-07-24 15:02:53 -07001336 timings.EndSplit();
1337
Brian Carlstromc6dfdac2013-08-26 18:57:31 -07001338 if (dump_timing || (dump_slow_timing && timings.GetTotalNs() > MsToNs(1000))) {
Ian Rogers5fe9af72013-11-14 00:17:20 -08001339 LOG(INFO) << Dumpable<TimingLogger>(timings);
Brian Carlstrom45602482013-07-21 22:07:55 -07001340 }
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +00001341 if (dump_passes) {
1342 LOG(INFO) << Dumpable<CumulativeLogger>(compiler_phases_timings);
1343 }
Ian Rogers2672a9f2013-09-05 17:24:22 -07001344
1345 // Everything was successfully written, do an explicit exit here to avoid running Runtime
1346 // destructors that take time (bug 10645725) unless we're a debug build or running on valgrind.
Brian Carlstrom6449c622014-02-10 23:48:36 -08001347 if (!kIsDebugBuild && (RUNNING_ON_VALGRIND == 0)) {
Brian Carlstrom65c23bb2014-02-01 22:12:39 -08001348 dex2oat->LogCompletionTime();
Ian Rogers2672a9f2013-09-05 17:24:22 -07001349 exit(EXIT_SUCCESS);
1350 }
1351
Brian Carlstrom7940e442013-07-12 13:46:57 -07001352 return EXIT_SUCCESS;
Brian Carlstrom6449c622014-02-10 23:48:36 -08001353} // NOLINT(readability/fn_size)
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001354} // namespace art
Brian Carlstrom7940e442013-07-12 13:46:57 -07001355
1356int main(int argc, char** argv) {
1357 return art::dex2oat(argc, argv);
1358}