dex2oat.cc revision 26318f722958ac1cba6a812026a1377f37c54941
1/*
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>
20#include <valgrind.h>
21
22#include <fstream>
23#include <iostream>
24#include <sstream>
25#include <string>
26#include <vector>
27
28#if defined(__linux__) && defined(__arm__)
29#include <sys/personality.h>
30#include <sys/utsname.h>
31#endif
32
33#include "base/stl_util.h"
34#include "base/stringpiece.h"
35#include "base/timing_logger.h"
36#include "base/unix_file/fd_file.h"
37#include "class_linker.h"
38#include "compiler.h"
39#include "compiler_callbacks.h"
40#include "dex_file-inl.h"
41#include "dex/pass_driver_me_opts.h"
42#include "dex/verification_results.h"
43#include "dex/quick_compiler_callbacks.h"
44#include "dex/quick/dex_file_to_method_inliner_map.h"
45#include "driver/compiler_driver.h"
46#include "driver/compiler_options.h"
47#include "elf_fixup.h"
48#include "elf_patcher.h"
49#include "elf_stripper.h"
50#include "gc/space/image_space.h"
51#include "gc/space/space-inl.h"
52#include "image_writer.h"
53#include "leb128.h"
54#include "mirror/art_method-inl.h"
55#include "mirror/class-inl.h"
56#include "mirror/class_loader.h"
57#include "mirror/object-inl.h"
58#include "mirror/object_array-inl.h"
59#include "oat_writer.h"
60#include "os.h"
61#include "runtime.h"
62#include "ScopedLocalRef.h"
63#include "scoped_thread_state_change.h"
64#include "utils.h"
65#include "vector_output_stream.h"
66#include "well_known_classes.h"
67#include "zip_archive.h"
68
69namespace art {
70
71static int original_argc;
72static char** original_argv;
73
74static std::string CommandLine() {
75  std::vector<std::string> command;
76  for (int i = 0; i < original_argc; ++i) {
77    command.push_back(original_argv[i]);
78  }
79  return Join(command, ' ');
80}
81
82static void UsageErrorV(const char* fmt, va_list ap) {
83  std::string error;
84  StringAppendV(&error, fmt, ap);
85  LOG(ERROR) << error;
86}
87
88static void UsageError(const char* fmt, ...) {
89  va_list ap;
90  va_start(ap, fmt);
91  UsageErrorV(fmt, ap);
92  va_end(ap);
93}
94
95static void Usage(const char* fmt, ...) {
96  va_list ap;
97  va_start(ap, fmt);
98  UsageErrorV(fmt, ap);
99  va_end(ap);
100
101  UsageError("Command: %s", CommandLine().c_str());
102
103  UsageError("Usage: dex2oat [options]...");
104  UsageError("");
105  UsageError("  --dex-file=<dex-file>: specifies a .dex file to compile.");
106  UsageError("      Example: --dex-file=/system/framework/core.jar");
107  UsageError("");
108  UsageError("  --zip-fd=<file-descriptor>: specifies a file descriptor of a zip file");
109  UsageError("      containing a classes.dex file to compile.");
110  UsageError("      Example: --zip-fd=5");
111  UsageError("");
112  UsageError("  --zip-location=<zip-location>: specifies a symbolic name for the file");
113  UsageError("      corresponding to the file descriptor specified by --zip-fd.");
114  UsageError("      Example: --zip-location=/system/app/Calculator.apk");
115  UsageError("");
116  UsageError("  --oat-file=<file.oat>: specifies the oat output destination via a filename.");
117  UsageError("      Example: --oat-file=/system/framework/boot.oat");
118  UsageError("");
119  UsageError("  --oat-fd=<number>: specifies the oat output destination via a file descriptor.");
120  UsageError("      Example: --oat-fd=6");
121  UsageError("");
122  UsageError("  --oat-location=<oat-name>: specifies a symbolic name for the file corresponding");
123  UsageError("      to the file descriptor specified by --oat-fd.");
124  UsageError("      Example: --oat-location=/data/dalvik-cache/system@app@Calculator.apk.oat");
125  UsageError("");
126  UsageError("  --oat-symbols=<file.oat>: specifies the oat output destination with full symbols.");
127  UsageError("      Example: --oat-symbols=/symbols/system/framework/boot.oat");
128  UsageError("");
129  UsageError("  --bitcode=<file.bc>: specifies the optional bitcode filename.");
130  UsageError("      Example: --bitcode=/system/framework/boot.bc");
131  UsageError("");
132  UsageError("  --image=<file.art>: specifies the output image filename.");
133  UsageError("      Example: --image=/system/framework/boot.art");
134  UsageError("");
135  UsageError("  --image-classes=<classname-file>: specifies classes to include in an image.");
136  UsageError("      Example: --image=frameworks/base/preloaded-classes");
137  UsageError("");
138  UsageError("  --base=<hex-address>: specifies the base address when creating a boot image.");
139  UsageError("      Example: --base=0x50000000");
140  UsageError("");
141  UsageError("  --boot-image=<file.art>: provide the image file for the boot class path.");
142  UsageError("      Example: --boot-image=/system/framework/boot.art");
143  UsageError("      Default: $ANDROID_ROOT/system/framework/boot.art");
144  UsageError("");
145  UsageError("  --android-root=<path>: used to locate libraries for portable linking.");
146  UsageError("      Example: --android-root=out/host/linux-x86");
147  UsageError("      Default: $ANDROID_ROOT");
148  UsageError("");
149  UsageError("  --instruction-set=(arm|arm64|mips|x86|x86_64): compile for a particular");
150  UsageError("      instruction set.");
151  UsageError("      Example: --instruction-set=x86");
152  UsageError("      Default: arm");
153  UsageError("");
154  UsageError("  --instruction-set-features=...,: Specify instruction set features");
155  UsageError("      Example: --instruction-set-features=div");
156  UsageError("      Default: default");
157  UsageError("");
158  UsageError("  --compile-pic: Force indirect use of code, methods, and classes");
159  UsageError("      Default: disabled");
160  UsageError("");
161  UsageError("  --compiler-backend=(Quick|Optimizing|Portable): select compiler backend");
162  UsageError("      set.");
163  UsageError("      Example: --compiler-backend=Portable");
164  UsageError("      Default: Quick");
165  UsageError("");
166  UsageError("  --compiler-filter=(verify-none|interpret-only|space|balanced|speed|everything):");
167  UsageError("      select compiler filter.");
168  UsageError("      Example: --compiler-filter=everything");
169#if ART_SMALL_MODE
170  UsageError("      Default: interpret-only");
171#else
172  UsageError("      Default: speed");
173#endif
174  UsageError("");
175  UsageError("  --huge-method-max=<method-instruction-count>: the threshold size for a huge");
176  UsageError("      method for compiler filter tuning.");
177  UsageError("      Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
178  UsageError("      Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
179  UsageError("");
180  UsageError("  --huge-method-max=<method-instruction-count>: threshold size for a huge");
181  UsageError("      method for compiler filter tuning.");
182  UsageError("      Example: --huge-method-max=%d", CompilerOptions::kDefaultHugeMethodThreshold);
183  UsageError("      Default: %d", CompilerOptions::kDefaultHugeMethodThreshold);
184  UsageError("");
185  UsageError("  --large-method-max=<method-instruction-count>: threshold size for a large");
186  UsageError("      method for compiler filter tuning.");
187  UsageError("      Example: --large-method-max=%d", CompilerOptions::kDefaultLargeMethodThreshold);
188  UsageError("      Default: %d", CompilerOptions::kDefaultLargeMethodThreshold);
189  UsageError("");
190  UsageError("  --small-method-max=<method-instruction-count>: threshold size for a small");
191  UsageError("      method for compiler filter tuning.");
192  UsageError("      Example: --small-method-max=%d", CompilerOptions::kDefaultSmallMethodThreshold);
193  UsageError("      Default: %d", CompilerOptions::kDefaultSmallMethodThreshold);
194  UsageError("");
195  UsageError("  --tiny-method-max=<method-instruction-count>: threshold size for a tiny");
196  UsageError("      method for compiler filter tuning.");
197  UsageError("      Example: --tiny-method-max=%d", CompilerOptions::kDefaultTinyMethodThreshold);
198  UsageError("      Default: %d", CompilerOptions::kDefaultTinyMethodThreshold);
199  UsageError("");
200  UsageError("  --num-dex-methods=<method-count>: threshold size for a small dex file for");
201  UsageError("      compiler filter tuning. If the input has fewer than this many methods");
202  UsageError("      and the filter is not interpret-only or verify-none, overrides the");
203  UsageError("      filter to use speed");
204  UsageError("      Example: --num-dex-method=%d", CompilerOptions::kDefaultNumDexMethodsThreshold);
205  UsageError("      Default: %d", CompilerOptions::kDefaultNumDexMethodsThreshold);
206  UsageError("");
207  UsageError("  --host: used with Portable backend to link against host runtime libraries");
208  UsageError("");
209  UsageError("  --dump-timing: display a breakdown of where time was spent");
210  UsageError("");
211  UsageError("  --include-patch-information: Include patching information so the generated code");
212  UsageError("      can have its base address moved without full recompilation.");
213  UsageError("");
214  UsageError("  --no-include-patch-information: Do not include patching information.");
215  UsageError("");
216  UsageError("  --include-debug-symbols: Include ELF symbols in this oat file");
217  UsageError("");
218  UsageError("  --no-include-debug-symbols: Do not include ELF symbols in this oat file");
219  UsageError("");
220  UsageError("  --runtime-arg <argument>: used to specify various arguments for the runtime,");
221  UsageError("      such as initial heap size, maximum heap size, and verbose output.");
222  UsageError("      Use a separate --runtime-arg switch for each argument.");
223  UsageError("      Example: --runtime-arg -Xms256m");
224  UsageError("");
225  UsageError("  --profile-file=<filename>: specify profiler output file to use for compilation.");
226  UsageError("");
227  UsageError("  --print-pass-names: print a list of pass names");
228  UsageError("");
229  UsageError("  --disable-passes=<pass-names>:  disable one or more passes separated by comma.");
230  UsageError("      Example: --disable-passes=UseCount,BBOptimizations");
231  UsageError("");
232  std::cerr << "See log for usage error information\n";
233  exit(EXIT_FAILURE);
234}
235
236class Dex2Oat {
237 public:
238  static bool Create(Dex2Oat** p_dex2oat,
239                     const RuntimeOptions& runtime_options,
240                     const CompilerOptions& compiler_options,
241                     Compiler::Kind compiler_kind,
242                     InstructionSet instruction_set,
243                     InstructionSetFeatures instruction_set_features,
244                     VerificationResults* verification_results,
245                     DexFileToMethodInlinerMap* method_inliner_map,
246                     size_t thread_count)
247      SHARED_TRYLOCK_FUNCTION(true, Locks::mutator_lock_) {
248    CHECK(verification_results != nullptr);
249    CHECK(method_inliner_map != nullptr);
250    std::unique_ptr<Dex2Oat> dex2oat(new Dex2Oat(&compiler_options,
251                                           compiler_kind,
252                                           instruction_set,
253                                           instruction_set_features,
254                                           verification_results,
255                                           method_inliner_map,
256                                           thread_count));
257    if (!dex2oat->CreateRuntime(runtime_options, instruction_set)) {
258      *p_dex2oat = nullptr;
259      return false;
260    }
261    *p_dex2oat = dex2oat.release();
262    return true;
263  }
264
265  ~Dex2Oat() {
266    delete runtime_;
267    LogCompletionTime();
268  }
269
270  void LogCompletionTime() {
271    LOG(INFO) << "dex2oat took " << PrettyDuration(NanoTime() - start_ns_)
272              << " (threads: " << thread_count_ << ")";
273  }
274
275
276  // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
277  std::set<std::string>* ReadImageClassesFromFile(const char* image_classes_filename) {
278    std::unique_ptr<std::ifstream> image_classes_file(new std::ifstream(image_classes_filename,
279                                                                  std::ifstream::in));
280    if (image_classes_file.get() == nullptr) {
281      LOG(ERROR) << "Failed to open image classes file " << image_classes_filename;
282      return nullptr;
283    }
284    std::unique_ptr<std::set<std::string>> result(ReadImageClasses(*image_classes_file));
285    image_classes_file->close();
286    return result.release();
287  }
288
289  std::set<std::string>* ReadImageClasses(std::istream& image_classes_stream) {
290    std::unique_ptr<std::set<std::string>> image_classes(new std::set<std::string>);
291    while (image_classes_stream.good()) {
292      std::string dot;
293      std::getline(image_classes_stream, dot);
294      if (StartsWith(dot, "#") || dot.empty()) {
295        continue;
296      }
297      std::string descriptor(DotToDescriptor(dot.c_str()));
298      image_classes->insert(descriptor);
299    }
300    return image_classes.release();
301  }
302
303  // Reads the class names (java.lang.Object) and returns a set of descriptors (Ljava/lang/Object;)
304  std::set<std::string>* ReadImageClassesFromZip(const char* zip_filename,
305                                                         const char* image_classes_filename,
306                                                         std::string* error_msg) {
307    std::unique_ptr<ZipArchive> zip_archive(ZipArchive::Open(zip_filename, error_msg));
308    if (zip_archive.get() == nullptr) {
309      return nullptr;
310    }
311    std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(image_classes_filename, error_msg));
312    if (zip_entry.get() == nullptr) {
313      *error_msg = StringPrintf("Failed to find '%s' within '%s': %s", image_classes_filename,
314                                zip_filename, error_msg->c_str());
315      return nullptr;
316    }
317    std::unique_ptr<MemMap> image_classes_file(zip_entry->ExtractToMemMap(zip_filename,
318                                                                          image_classes_filename,
319                                                                          error_msg));
320    if (image_classes_file.get() == nullptr) {
321      *error_msg = StringPrintf("Failed to extract '%s' from '%s': %s", image_classes_filename,
322                                zip_filename, error_msg->c_str());
323      return nullptr;
324    }
325    const std::string image_classes_string(reinterpret_cast<char*>(image_classes_file->Begin()),
326                                           image_classes_file->Size());
327    std::istringstream image_classes_stream(image_classes_string);
328    return ReadImageClasses(image_classes_stream);
329  }
330
331  bool PatchOatCode(const CompilerDriver* compiler_driver, File* oat_file,
332                    const std::string& oat_location, std::string* error_msg) {
333    // We asked to include patch information but we are not making an image. We need to fix
334    // everything up manually.
335    std::unique_ptr<ElfFile> elf_file(ElfFile::Open(oat_file, PROT_READ|PROT_WRITE,
336                                                    MAP_SHARED, error_msg));
337    if (elf_file.get() == NULL) {
338      LOG(ERROR) << error_msg;
339      return false;
340    }
341    {
342      ReaderMutexLock mu(Thread::Current(), *Locks::mutator_lock_);
343      return ElfPatcher::Patch(compiler_driver, elf_file.get(), oat_location, error_msg);
344    }
345  }
346
347  const CompilerDriver* CreateOatFile(const std::string& boot_image_option,
348                                      const std::string& android_root,
349                                      bool is_host,
350                                      const std::vector<const DexFile*>& dex_files,
351                                      File* oat_file,
352                                      const std::string& oat_location,
353                                      const std::string& bitcode_filename,
354                                      bool image,
355                                      std::unique_ptr<std::set<std::string>>& image_classes,
356                                      std::unique_ptr<std::set<std::string>>& compiled_classes,
357                                      bool dump_stats,
358                                      bool dump_passes,
359                                      TimingLogger& timings,
360                                      CumulativeLogger& compiler_phases_timings,
361                                      std::string profile_file,
362                                      SafeMap<std::string, std::string>* key_value_store) {
363    CHECK(key_value_store != nullptr);
364
365    // Handle and ClassLoader creation needs to come after Runtime::Create
366    jobject class_loader = nullptr;
367    Thread* self = Thread::Current();
368    if (!boot_image_option.empty()) {
369      ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
370      std::vector<const DexFile*> class_path_files(dex_files);
371      OpenClassPathFiles(runtime_->GetClassPathString(), class_path_files);
372      ScopedObjectAccess soa(self);
373      for (size_t i = 0; i < class_path_files.size(); i++) {
374        class_linker->RegisterDexFile(*class_path_files[i]);
375      }
376      soa.Env()->AllocObject(WellKnownClasses::dalvik_system_PathClassLoader);
377      ScopedLocalRef<jobject> class_loader_local(soa.Env(),
378          soa.Env()->AllocObject(WellKnownClasses::dalvik_system_PathClassLoader));
379      class_loader = soa.Env()->NewGlobalRef(class_loader_local.get());
380      Runtime::Current()->SetCompileTimeClassPath(class_loader, class_path_files);
381    }
382
383    std::unique_ptr<CompilerDriver> driver(new CompilerDriver(compiler_options_,
384                                                              verification_results_,
385                                                              method_inliner_map_,
386                                                              compiler_kind_,
387                                                              instruction_set_,
388                                                              instruction_set_features_,
389                                                              image,
390                                                              image_classes.release(),
391                                                              compiled_classes.release(),
392                                                              thread_count_,
393                                                              dump_stats,
394                                                              dump_passes,
395                                                              &compiler_phases_timings,
396                                                              profile_file));
397
398    driver->GetCompiler()->SetBitcodeFileName(*driver.get(), bitcode_filename);
399
400    driver->CompileAll(class_loader, dex_files, &timings);
401
402    TimingLogger::ScopedTiming t2("dex2oat OatWriter", &timings);
403    std::string image_file_location;
404    uint32_t image_file_location_oat_checksum = 0;
405    uintptr_t image_file_location_oat_data_begin = 0;
406    int32_t image_patch_delta = 0;
407    if (!driver->IsImage()) {
408      TimingLogger::ScopedTiming t3("Loading image checksum", &timings);
409      gc::space::ImageSpace* image_space = Runtime::Current()->GetHeap()->GetImageSpace();
410      image_file_location_oat_checksum = image_space->GetImageHeader().GetOatChecksum();
411      image_file_location_oat_data_begin =
412          reinterpret_cast<uintptr_t>(image_space->GetImageHeader().GetOatDataBegin());
413      image_file_location = image_space->GetImageFilename();
414      image_patch_delta = image_space->GetImageHeader().GetPatchDelta();
415    }
416
417    if (!image_file_location.empty()) {
418      key_value_store->Put(OatHeader::kImageLocationKey, image_file_location);
419    }
420
421    OatWriter oat_writer(dex_files, image_file_location_oat_checksum,
422                         image_file_location_oat_data_begin,
423                         image_patch_delta,
424                         driver.get(),
425                         &timings,
426                         key_value_store);
427
428    t2.NewTiming("Writing ELF");
429    if (!driver->WriteElf(android_root, is_host, dex_files, &oat_writer, oat_file)) {
430      LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
431      return nullptr;
432    }
433
434    // Flush result to disk. Patching code will re-open the file (mmap), so ensure that our view
435    // of the file already made it there and won't be re-ordered with writes from PatchOat or
436    // image patching.
437    oat_file->Flush();
438
439    if (!driver->IsImage() && driver->GetCompilerOptions().GetIncludePatchInformation()) {
440      t2.NewTiming("Patching ELF");
441      std::string error_msg;
442      if (!PatchOatCode(driver.get(), oat_file, oat_location, &error_msg)) {
443        LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath() << ": " << error_msg;
444        return nullptr;
445      }
446    }
447
448    return driver.release();
449  }
450
451  bool CreateImageFile(const std::string& image_filename,
452                       uintptr_t image_base,
453                       const std::string& oat_filename,
454                       const std::string& oat_location,
455                       const CompilerDriver& compiler)
456      LOCKS_EXCLUDED(Locks::mutator_lock_) {
457    uintptr_t oat_data_begin;
458    {
459      // ImageWriter is scoped so it can free memory before doing FixupElf
460      ImageWriter image_writer(compiler);
461      if (!image_writer.Write(image_filename, image_base, oat_filename, oat_location,
462                              compiler_options_->GetCompilePic())) {
463        LOG(ERROR) << "Failed to create image file " << image_filename;
464        return false;
465      }
466      oat_data_begin = image_writer.GetOatDataBegin();
467    }
468
469    std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename.c_str()));
470    if (oat_file.get() == nullptr) {
471      PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
472      return false;
473    }
474    // Do not fix up the ELF file if we are --compile-pic
475    if (!compiler_options_->GetCompilePic()) {
476      if (!ElfFixup::Fixup(oat_file.get(), oat_data_begin)) {
477        LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
478        return false;
479      }
480    }
481
482    return true;
483  }
484
485 private:
486  explicit Dex2Oat(const CompilerOptions* compiler_options,
487                   Compiler::Kind compiler_kind,
488                   InstructionSet instruction_set,
489                   InstructionSetFeatures instruction_set_features,
490                   VerificationResults* verification_results,
491                   DexFileToMethodInlinerMap* method_inliner_map,
492                   size_t thread_count)
493      : compiler_options_(compiler_options),
494        compiler_kind_(compiler_kind),
495        instruction_set_(instruction_set),
496        instruction_set_features_(instruction_set_features),
497        verification_results_(verification_results),
498        method_inliner_map_(method_inliner_map),
499        runtime_(nullptr),
500        thread_count_(thread_count),
501        start_ns_(NanoTime()) {
502    CHECK(compiler_options != nullptr);
503    CHECK(verification_results != nullptr);
504    CHECK(method_inliner_map != nullptr);
505  }
506
507  bool CreateRuntime(const RuntimeOptions& runtime_options, InstructionSet instruction_set)
508      SHARED_TRYLOCK_FUNCTION(true, Locks::mutator_lock_) {
509    if (!Runtime::Create(runtime_options, false)) {
510      LOG(ERROR) << "Failed to create runtime";
511      return false;
512    }
513    Runtime* runtime = Runtime::Current();
514    runtime->SetInstructionSet(instruction_set);
515    for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) {
516      Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i);
517      if (!runtime->HasCalleeSaveMethod(type)) {
518        runtime->SetCalleeSaveMethod(runtime->CreateCalleeSaveMethod(type), type);
519      }
520    }
521    runtime->GetClassLinker()->FixupDexCaches(runtime->GetResolutionMethod());
522    runtime->GetClassLinker()->RunRootClinits();
523    runtime_ = runtime;
524    return true;
525  }
526
527  // Appends to dex_files any elements of class_path that it doesn't already
528  // contain. This will open those dex files as necessary.
529  static void OpenClassPathFiles(const std::string& class_path,
530                                 std::vector<const DexFile*>& dex_files) {
531    std::vector<std::string> parsed;
532    Split(class_path, ':', parsed);
533    // Take Locks::mutator_lock_ so that lock ordering on the ClassLinker::dex_lock_ is maintained.
534    ScopedObjectAccess soa(Thread::Current());
535    for (size_t i = 0; i < parsed.size(); ++i) {
536      if (DexFilesContains(dex_files, parsed[i])) {
537        continue;
538      }
539      std::string error_msg;
540      if (!DexFile::Open(parsed[i].c_str(), parsed[i].c_str(), &error_msg, &dex_files)) {
541        LOG(WARNING) << "Failed to open dex file '" << parsed[i] << "': " << error_msg;
542      }
543    }
544  }
545
546  // Returns true if dex_files has a dex with the named location.
547  static bool DexFilesContains(const std::vector<const DexFile*>& dex_files,
548                               const std::string& location) {
549    for (size_t i = 0; i < dex_files.size(); ++i) {
550      if (dex_files[i]->GetLocation() == location) {
551        return true;
552      }
553    }
554    return false;
555  }
556
557  const CompilerOptions* const compiler_options_;
558  const Compiler::Kind compiler_kind_;
559
560  const InstructionSet instruction_set_;
561  const InstructionSetFeatures instruction_set_features_;
562
563  VerificationResults* const verification_results_;
564  DexFileToMethodInlinerMap* const method_inliner_map_;
565  Runtime* runtime_;
566  size_t thread_count_;
567  uint64_t start_ns_;
568
569  DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
570};
571
572static size_t OpenDexFiles(const std::vector<const char*>& dex_filenames,
573                           const std::vector<const char*>& dex_locations,
574                           std::vector<const DexFile*>& dex_files) {
575  size_t failure_count = 0;
576  for (size_t i = 0; i < dex_filenames.size(); i++) {
577    const char* dex_filename = dex_filenames[i];
578    const char* dex_location = dex_locations[i];
579    ATRACE_BEGIN(StringPrintf("Opening dex file '%s'", dex_filenames[i]).c_str());
580    std::string error_msg;
581    if (!OS::FileExists(dex_filename)) {
582      LOG(WARNING) << "Skipping non-existent dex file '" << dex_filename << "'";
583      continue;
584    }
585    if (!DexFile::Open(dex_filename, dex_location, &error_msg, &dex_files)) {
586      LOG(WARNING) << "Failed to open .dex from file '" << dex_filename << "': " << error_msg;
587      ++failure_count;
588    }
589    ATRACE_END();
590  }
591  return failure_count;
592}
593
594// The primary goal of the watchdog is to prevent stuck build servers
595// during development when fatal aborts lead to a cascade of failures
596// that result in a deadlock.
597class WatchDog {
598// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using Log which uses locks
599#undef CHECK_PTHREAD_CALL
600#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
601  do { \
602    int rc = call args; \
603    if (rc != 0) { \
604      errno = rc; \
605      std::string message(# call); \
606      message += " failed for "; \
607      message += reason; \
608      Fatal(message); \
609    } \
610  } while (false)
611
612 public:
613  explicit WatchDog(bool is_watch_dog_enabled) {
614    is_watch_dog_enabled_ = is_watch_dog_enabled;
615    if (!is_watch_dog_enabled_) {
616      return;
617    }
618    shutting_down_ = false;
619    const char* reason = "dex2oat watch dog thread startup";
620    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
621    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, nullptr), reason);
622    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
623    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
624    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
625  }
626  ~WatchDog() {
627    if (!is_watch_dog_enabled_) {
628      return;
629    }
630    const char* reason = "dex2oat watch dog thread shutdown";
631    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
632    shutting_down_ = true;
633    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
634    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
635
636    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
637
638    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
639    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
640  }
641
642 private:
643  static void* CallBack(void* arg) {
644    WatchDog* self = reinterpret_cast<WatchDog*>(arg);
645    ::art::SetThreadName("dex2oat watch dog");
646    self->Wait();
647    return nullptr;
648  }
649
650  static void Message(char severity, const std::string& message) {
651    // TODO: Remove when we switch to LOG when we can guarantee it won't prevent shutdown in error
652    //       cases.
653    fprintf(stderr, "dex2oat%s %c %d %d %s\n",
654            kIsDebugBuild ? "d" : "",
655            severity,
656            getpid(),
657            GetTid(),
658            message.c_str());
659  }
660
661  static void Warn(const std::string& message) {
662    Message('W', message);
663  }
664
665  static void Fatal(const std::string& message) {
666    Message('F', message);
667    exit(1);
668  }
669
670  void Wait() {
671    bool warning = true;
672    CHECK_GT(kWatchDogTimeoutSeconds, kWatchDogWarningSeconds);
673    // TODO: tune the multiplier for GC verification, the following is just to make the timeout
674    //       large.
675    int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
676    timespec warning_ts;
677    InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogWarningSeconds * 1000, 0, &warning_ts);
678    timespec timeout_ts;
679    InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts);
680    const char* reason = "dex2oat watch dog thread waiting";
681    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
682    while (!shutting_down_) {
683      int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_,
684                                                         warning ? &warning_ts
685                                                                 : &timeout_ts));
686      if (rc == ETIMEDOUT) {
687        std::string message(StringPrintf("dex2oat did not finish after %d seconds",
688                                         warning ? kWatchDogWarningSeconds
689                                                 : kWatchDogTimeoutSeconds));
690        if (warning) {
691          Warn(message.c_str());
692          warning = false;
693        } else {
694          Fatal(message.c_str());
695        }
696      } else if (rc != 0) {
697        std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
698                                         strerror(errno)));
699        Fatal(message.c_str());
700      }
701    }
702    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
703  }
704
705  // When setting timeouts, keep in mind that the build server may not be as fast as your desktop.
706  // Debug builds are slower so they have larger timeouts.
707  static const unsigned int kSlowdownFactor = kIsDebugBuild ? 5U : 1U;
708#if ART_USE_PORTABLE_COMPILER
709  // 2 minutes scaled by kSlowdownFactor.
710  static const unsigned int kWatchDogWarningSeconds = kSlowdownFactor * 2 * 60;
711  // 30 minutes scaled by kSlowdownFactor.
712  static const unsigned int kWatchDogTimeoutSeconds = kSlowdownFactor * 30 * 60;
713#else
714  // 1 minutes scaled by kSlowdownFactor.
715  static const unsigned int kWatchDogWarningSeconds = kSlowdownFactor * 1 * 60;
716  // 6 minutes scaled by kSlowdownFactor.
717  static const unsigned int kWatchDogTimeoutSeconds = kSlowdownFactor * 6 * 60;
718#endif
719
720  bool is_watch_dog_enabled_;
721  bool shutting_down_;
722  // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
723  pthread_mutex_t mutex_;
724  pthread_cond_t cond_;
725  pthread_attr_t attr_;
726  pthread_t pthread_;
727};
728const unsigned int WatchDog::kWatchDogWarningSeconds;
729const unsigned int WatchDog::kWatchDogTimeoutSeconds;
730
731// Given a set of instruction features from the build, parse it.  The
732// input 'str' is a comma separated list of feature names.  Parse it and
733// return the InstructionSetFeatures object.
734static InstructionSetFeatures ParseFeatureList(std::string str) {
735  InstructionSetFeatures result;
736  typedef std::vector<std::string> FeatureList;
737  FeatureList features;
738  Split(str, ',', features);
739  for (FeatureList::iterator i = features.begin(); i != features.end(); i++) {
740    std::string feature = Trim(*i);
741    if (feature == "default") {
742      // Nothing to do.
743    } else if (feature == "div") {
744      // Supports divide instruction.
745       result.SetHasDivideInstruction(true);
746    } else if (feature == "nodiv") {
747      // Turn off support for divide instruction.
748      result.SetHasDivideInstruction(false);
749    } else if (feature == "lpae") {
750      // Supports Large Physical Address Extension.
751      result.SetHasLpae(true);
752    } else if (feature == "nolpae") {
753      // Turn off support for Large Physical Address Extension.
754      result.SetHasLpae(false);
755    } else {
756      Usage("Unknown instruction set feature: '%s'", feature.c_str());
757    }
758  }
759  // others...
760  return result;
761}
762
763void ParseStringAfterChar(const std::string& s, char c, std::string* parsed_value) {
764  std::string::size_type colon = s.find(c);
765  if (colon == std::string::npos) {
766    Usage("Missing char %c in option %s\n", c, s.c_str());
767  }
768  // Add one to remove the char we were trimming until.
769  *parsed_value = s.substr(colon + 1);
770}
771
772void ParseDouble(const std::string& option, char after_char,
773                 double min, double max, double* parsed_value) {
774  std::string substring;
775  ParseStringAfterChar(option, after_char, &substring);
776  bool sane_val = true;
777  double value;
778  if (false) {
779    // TODO: this doesn't seem to work on the emulator.  b/15114595
780    std::stringstream iss(substring);
781    iss >> value;
782    // Ensure that we have a value, there was no cruft after it and it satisfies a sensible range.
783    sane_val = iss.eof() && (value >= min) && (value <= max);
784  } else {
785    char* end = nullptr;
786    value = strtod(substring.c_str(), &end);
787    sane_val = *end == '\0' && value >= min && value <= max;
788  }
789  if (!sane_val) {
790    Usage("Invalid double value %s for option %s\n", substring.c_str(), option.c_str());
791  }
792  *parsed_value = value;
793}
794
795static void b13564922() {
796#if defined(__linux__) && defined(__arm__)
797  int major, minor;
798  struct utsname uts;
799  if (uname(&uts) != -1 &&
800      sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
801      ((major < 3) || ((major == 3) && (minor < 4)))) {
802    // Kernels before 3.4 don't handle the ASLR well and we can run out of address
803    // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
804    int old_personality = personality(0xffffffff);
805    if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
806      int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
807      if (new_personality == -1) {
808        LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
809      }
810    }
811  }
812#endif
813}
814
815static int dex2oat(int argc, char** argv) {
816  b13564922();
817
818  original_argc = argc;
819  original_argv = argv;
820
821  TimingLogger timings("compiler", false, false);
822  CumulativeLogger compiler_phases_timings("compilation times");
823
824  InitLogging(argv);
825
826  // Skip over argv[0].
827  argv++;
828  argc--;
829
830  if (argc == 0) {
831    Usage("No arguments specified");
832  }
833
834  std::vector<const char*> dex_filenames;
835  std::vector<const char*> dex_locations;
836  int zip_fd = -1;
837  std::string zip_location;
838  std::string oat_filename;
839  std::string oat_symbols;
840  std::string oat_location;
841  int oat_fd = -1;
842  std::string bitcode_filename;
843  const char* image_classes_zip_filename = nullptr;
844  const char* image_classes_filename = nullptr;
845  const char* compiled_classes_zip_filename = nullptr;
846  const char* compiled_classes_filename = nullptr;
847  std::string image_filename;
848  std::string boot_image_filename;
849  uintptr_t image_base = 0;
850  std::string android_root;
851  std::vector<const char*> runtime_args;
852  int thread_count = sysconf(_SC_NPROCESSORS_CONF);
853  Compiler::Kind compiler_kind = kUsePortableCompiler
854      ? Compiler::kPortable
855      : Compiler::kQuick;
856  const char* compiler_filter_string = nullptr;
857  bool compile_pic = false;
858  int huge_method_threshold = CompilerOptions::kDefaultHugeMethodThreshold;
859  int large_method_threshold = CompilerOptions::kDefaultLargeMethodThreshold;
860  int small_method_threshold = CompilerOptions::kDefaultSmallMethodThreshold;
861  int tiny_method_threshold = CompilerOptions::kDefaultTinyMethodThreshold;
862  int num_dex_methods_threshold = CompilerOptions::kDefaultNumDexMethodsThreshold;
863
864  // Take the default set of instruction features from the build.
865  InstructionSetFeatures instruction_set_features =
866      ParseFeatureList(Runtime::GetDefaultInstructionSetFeatures());
867
868  InstructionSet instruction_set = kRuntimeISA;
869
870  // Profile file to use
871  std::string profile_file;
872  double top_k_profile_threshold = CompilerOptions::kDefaultTopKProfileThreshold;
873
874  bool is_host = false;
875  bool dump_stats = false;
876  bool dump_timing = false;
877  bool dump_passes = false;
878  bool include_patch_information = CompilerOptions::kDefaultIncludePatchInformation;
879  bool include_debug_symbols = kIsDebugBuild;
880  bool dump_slow_timing = kIsDebugBuild;
881  bool watch_dog_enabled = true;
882  bool generate_gdb_information = kIsDebugBuild;
883
884  // Checks are all explicit until we know the architecture.
885  bool implicit_null_checks = false;
886  bool implicit_so_checks = false;
887  bool implicit_suspend_checks = false;
888
889  for (int i = 0; i < argc; i++) {
890    const StringPiece option(argv[i]);
891    const bool log_options = false;
892    if (log_options) {
893      LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
894    }
895    if (option.starts_with("--dex-file=")) {
896      dex_filenames.push_back(option.substr(strlen("--dex-file=")).data());
897    } else if (option.starts_with("--dex-location=")) {
898      dex_locations.push_back(option.substr(strlen("--dex-location=")).data());
899    } else if (option.starts_with("--zip-fd=")) {
900      const char* zip_fd_str = option.substr(strlen("--zip-fd=")).data();
901      if (!ParseInt(zip_fd_str, &zip_fd)) {
902        Usage("Failed to parse --zip-fd argument '%s' as an integer", zip_fd_str);
903      }
904      if (zip_fd < 0) {
905        Usage("--zip-fd passed a negative value %d", zip_fd);
906      }
907    } else if (option.starts_with("--zip-location=")) {
908      zip_location = option.substr(strlen("--zip-location=")).data();
909    } else if (option.starts_with("--oat-file=")) {
910      oat_filename = option.substr(strlen("--oat-file=")).data();
911    } else if (option.starts_with("--oat-symbols=")) {
912      oat_symbols = option.substr(strlen("--oat-symbols=")).data();
913    } else if (option.starts_with("--oat-fd=")) {
914      const char* oat_fd_str = option.substr(strlen("--oat-fd=")).data();
915      if (!ParseInt(oat_fd_str, &oat_fd)) {
916        Usage("Failed to parse --oat-fd argument '%s' as an integer", oat_fd_str);
917      }
918      if (oat_fd < 0) {
919        Usage("--oat-fd passed a negative value %d", oat_fd);
920      }
921    } else if (option == "--watch-dog") {
922      watch_dog_enabled = true;
923    } else if (option == "--no-watch-dog") {
924      watch_dog_enabled = false;
925    } else if (option == "--gen-gdb-info") {
926      generate_gdb_information = true;
927      // Debug symbols are needed for gdb information.
928      include_debug_symbols = true;
929    } else if (option == "--no-gen-gdb-info") {
930      generate_gdb_information = false;
931    } else if (option.starts_with("-j")) {
932      const char* thread_count_str = option.substr(strlen("-j")).data();
933      if (!ParseInt(thread_count_str, &thread_count)) {
934        Usage("Failed to parse -j argument '%s' as an integer", thread_count_str);
935      }
936    } else if (option.starts_with("--oat-location=")) {
937      oat_location = option.substr(strlen("--oat-location=")).data();
938    } else if (option.starts_with("--bitcode=")) {
939      bitcode_filename = option.substr(strlen("--bitcode=")).data();
940    } else if (option.starts_with("--image=")) {
941      image_filename = option.substr(strlen("--image=")).data();
942    } else if (option.starts_with("--image-classes=")) {
943      image_classes_filename = option.substr(strlen("--image-classes=")).data();
944    } else if (option.starts_with("--image-classes-zip=")) {
945      image_classes_zip_filename = option.substr(strlen("--image-classes-zip=")).data();
946    } else if (option.starts_with("--compiled-classes=")) {
947      compiled_classes_filename = option.substr(strlen("--compiled-classes=")).data();
948    } else if (option.starts_with("--compiled-classes-zip=")) {
949      compiled_classes_zip_filename = option.substr(strlen("--compiled-classes-zip=")).data();
950    } else if (option.starts_with("--base=")) {
951      const char* image_base_str = option.substr(strlen("--base=")).data();
952      char* end;
953      image_base = strtoul(image_base_str, &end, 16);
954      if (end == image_base_str || *end != '\0') {
955        Usage("Failed to parse hexadecimal value for option %s", option.data());
956      }
957    } else if (option.starts_with("--boot-image=")) {
958      boot_image_filename = option.substr(strlen("--boot-image=")).data();
959    } else if (option.starts_with("--android-root=")) {
960      android_root = option.substr(strlen("--android-root=")).data();
961    } else if (option.starts_with("--instruction-set=")) {
962      StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
963      if (instruction_set_str == "arm") {
964        instruction_set = kThumb2;
965      } else if (instruction_set_str == "arm64") {
966        instruction_set = kArm64;
967      } else if (instruction_set_str == "mips") {
968        instruction_set = kMips;
969      } else if (instruction_set_str == "x86") {
970        instruction_set = kX86;
971      } else if (instruction_set_str == "x86_64") {
972        instruction_set = kX86_64;
973      }
974    } else if (option.starts_with("--instruction-set-features=")) {
975      StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
976      instruction_set_features = ParseFeatureList(str.as_string());
977    } else if (option.starts_with("--compiler-backend=")) {
978      StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
979      if (backend_str == "Quick") {
980        compiler_kind = Compiler::kQuick;
981      } else if (backend_str == "Optimizing") {
982        compiler_kind = Compiler::kOptimizing;
983      } else if (backend_str == "Portable") {
984        compiler_kind = Compiler::kPortable;
985      }
986    } else if (option.starts_with("--compiler-filter=")) {
987      compiler_filter_string = option.substr(strlen("--compiler-filter=")).data();
988    } else if (option == "--compile-pic") {
989      compile_pic = true;
990    } else if (option.starts_with("--huge-method-max=")) {
991      const char* threshold = option.substr(strlen("--huge-method-max=")).data();
992      if (!ParseInt(threshold, &huge_method_threshold)) {
993        Usage("Failed to parse --huge-method-max '%s' as an integer", threshold);
994      }
995      if (huge_method_threshold < 0) {
996        Usage("--huge-method-max passed a negative value %s", huge_method_threshold);
997      }
998    } else if (option.starts_with("--large-method-max=")) {
999      const char* threshold = option.substr(strlen("--large-method-max=")).data();
1000      if (!ParseInt(threshold, &large_method_threshold)) {
1001        Usage("Failed to parse --large-method-max '%s' as an integer", threshold);
1002      }
1003      if (large_method_threshold < 0) {
1004        Usage("--large-method-max passed a negative value %s", large_method_threshold);
1005      }
1006    } else if (option.starts_with("--small-method-max=")) {
1007      const char* threshold = option.substr(strlen("--small-method-max=")).data();
1008      if (!ParseInt(threshold, &small_method_threshold)) {
1009        Usage("Failed to parse --small-method-max '%s' as an integer", threshold);
1010      }
1011      if (small_method_threshold < 0) {
1012        Usage("--small-method-max passed a negative value %s", small_method_threshold);
1013      }
1014    } else if (option.starts_with("--tiny-method-max=")) {
1015      const char* threshold = option.substr(strlen("--tiny-method-max=")).data();
1016      if (!ParseInt(threshold, &tiny_method_threshold)) {
1017        Usage("Failed to parse --tiny-method-max '%s' as an integer", threshold);
1018      }
1019      if (tiny_method_threshold < 0) {
1020        Usage("--tiny-method-max passed a negative value %s", tiny_method_threshold);
1021      }
1022    } else if (option.starts_with("--num-dex-methods=")) {
1023      const char* threshold = option.substr(strlen("--num-dex-methods=")).data();
1024      if (!ParseInt(threshold, &num_dex_methods_threshold)) {
1025        Usage("Failed to parse --num-dex-methods '%s' as an integer", threshold);
1026      }
1027      if (num_dex_methods_threshold < 0) {
1028        Usage("--num-dex-methods passed a negative value %s", num_dex_methods_threshold);
1029      }
1030    } else if (option == "--host") {
1031      is_host = true;
1032    } else if (option == "--runtime-arg") {
1033      if (++i >= argc) {
1034        Usage("Missing required argument for --runtime-arg");
1035      }
1036      if (log_options) {
1037        LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
1038      }
1039      runtime_args.push_back(argv[i]);
1040    } else if (option == "--dump-timing") {
1041      dump_timing = true;
1042    } else if (option == "--dump-passes") {
1043      dump_passes = true;
1044    } else if (option == "--dump-stats") {
1045      dump_stats = true;
1046    } else if (option == "--include-debug-symbols" || option == "--no-strip-symbols") {
1047      include_debug_symbols = true;
1048    } else if (option == "--no-include-debug-symbols" || option == "--strip-symbols") {
1049      include_debug_symbols = false;
1050      generate_gdb_information = false;  // Depends on debug symbols, see above.
1051    } else if (option.starts_with("--profile-file=")) {
1052      profile_file = option.substr(strlen("--profile-file=")).data();
1053      VLOG(compiler) << "dex2oat: profile file is " << profile_file;
1054    } else if (option == "--no-profile-file") {
1055      // No profile
1056    } else if (option.starts_with("--top-k-profile-threshold=")) {
1057      ParseDouble(option.data(), '=', 0.0, 100.0, &top_k_profile_threshold);
1058    } else if (option == "--print-pass-names") {
1059      PassDriverMEOpts::PrintPassNames();
1060    } else if (option.starts_with("--disable-passes=")) {
1061      std::string disable_passes = option.substr(strlen("--disable-passes=")).data();
1062      PassDriverMEOpts::CreateDefaultPassList(disable_passes);
1063    } else if (option.starts_with("--print-passes=")) {
1064      std::string print_passes = option.substr(strlen("--print-passes=")).data();
1065      PassDriverMEOpts::SetPrintPassList(print_passes);
1066    } else if (option == "--print-all-passes") {
1067      PassDriverMEOpts::SetPrintAllPasses();
1068    } else if (option.starts_with("--dump-cfg-passes=")) {
1069      std::string dump_passes = option.substr(strlen("--dump-cfg-passes=")).data();
1070      PassDriverMEOpts::SetDumpPassList(dump_passes);
1071    } else if (option == "--include-patch-information") {
1072      include_patch_information = true;
1073    } else if (option == "--no-include-patch-information") {
1074      include_patch_information = false;
1075    } else {
1076      Usage("Unknown argument %s", option.data());
1077    }
1078  }
1079
1080  if (oat_filename.empty() && oat_fd == -1) {
1081    Usage("Output must be supplied with either --oat-file or --oat-fd");
1082  }
1083
1084  if (!oat_filename.empty() && oat_fd != -1) {
1085    Usage("--oat-file should not be used with --oat-fd");
1086  }
1087
1088  if (!oat_symbols.empty() && oat_fd != -1) {
1089    Usage("--oat-symbols should not be used with --oat-fd");
1090  }
1091
1092  if (!oat_symbols.empty() && is_host) {
1093    Usage("--oat-symbols should not be used with --host");
1094  }
1095
1096  if (oat_fd != -1 && !image_filename.empty()) {
1097    Usage("--oat-fd should not be used with --image");
1098  }
1099
1100  if (android_root.empty()) {
1101    const char* android_root_env_var = getenv("ANDROID_ROOT");
1102    if (android_root_env_var == nullptr) {
1103      Usage("--android-root unspecified and ANDROID_ROOT not set");
1104    }
1105    android_root += android_root_env_var;
1106  }
1107
1108  bool image = (!image_filename.empty());
1109  if (!image && boot_image_filename.empty()) {
1110    boot_image_filename += android_root;
1111    boot_image_filename += "/framework/boot.art";
1112  }
1113  std::string boot_image_option;
1114  if (!boot_image_filename.empty()) {
1115    boot_image_option += "-Ximage:";
1116    boot_image_option += boot_image_filename;
1117  }
1118
1119  if (image_classes_filename != nullptr && !image) {
1120    Usage("--image-classes should only be used with --image");
1121  }
1122
1123  if (image_classes_filename != nullptr && !boot_image_option.empty()) {
1124    Usage("--image-classes should not be used with --boot-image");
1125  }
1126
1127  if (image_classes_zip_filename != nullptr && image_classes_filename == nullptr) {
1128    Usage("--image-classes-zip should be used with --image-classes");
1129  }
1130
1131  if (compiled_classes_filename != nullptr && !image) {
1132    Usage("--compiled-classes should only be used with --image");
1133  }
1134
1135  if (compiled_classes_filename != nullptr && !boot_image_option.empty()) {
1136    Usage("--compiled-classes should not be used with --boot-image");
1137  }
1138
1139  if (compiled_classes_zip_filename != nullptr && compiled_classes_filename == nullptr) {
1140    Usage("--compiled-classes-zip should be used with --compiled-classes");
1141  }
1142
1143  if (dex_filenames.empty() && zip_fd == -1) {
1144    Usage("Input must be supplied with either --dex-file or --zip-fd");
1145  }
1146
1147  if (!dex_filenames.empty() && zip_fd != -1) {
1148    Usage("--dex-file should not be used with --zip-fd");
1149  }
1150
1151  if (!dex_filenames.empty() && !zip_location.empty()) {
1152    Usage("--dex-file should not be used with --zip-location");
1153  }
1154
1155  if (dex_locations.empty()) {
1156    for (size_t i = 0; i < dex_filenames.size(); i++) {
1157      dex_locations.push_back(dex_filenames[i]);
1158    }
1159  } else if (dex_locations.size() != dex_filenames.size()) {
1160    Usage("--dex-location arguments do not match --dex-file arguments");
1161  }
1162
1163  if (zip_fd != -1 && zip_location.empty()) {
1164    Usage("--zip-location should be supplied with --zip-fd");
1165  }
1166
1167  if (boot_image_option.empty()) {
1168    if (image_base == 0) {
1169      Usage("Non-zero --base not specified");
1170    }
1171  }
1172
1173  std::string oat_stripped(oat_filename);
1174  std::string oat_unstripped;
1175  if (!oat_symbols.empty()) {
1176    oat_unstripped += oat_symbols;
1177  } else {
1178    oat_unstripped += oat_filename;
1179  }
1180
1181  if (compiler_filter_string == nullptr) {
1182    if (instruction_set == kMips64) {
1183      // TODO: fix compiler for Mips64.
1184      compiler_filter_string = "interpret-only";
1185    } else if (image) {
1186      compiler_filter_string = "speed";
1187    } else {
1188#if ART_SMALL_MODE
1189      compiler_filter_string = "interpret-only";
1190#else
1191      compiler_filter_string = "speed";
1192#endif
1193    }
1194  }
1195  CHECK(compiler_filter_string != nullptr);
1196  CompilerOptions::CompilerFilter compiler_filter = CompilerOptions::kDefaultCompilerFilter;
1197  if (strcmp(compiler_filter_string, "verify-none") == 0) {
1198    compiler_filter = CompilerOptions::kVerifyNone;
1199  } else if (strcmp(compiler_filter_string, "interpret-only") == 0) {
1200    compiler_filter = CompilerOptions::kInterpretOnly;
1201  } else if (strcmp(compiler_filter_string, "space") == 0) {
1202    compiler_filter = CompilerOptions::kSpace;
1203  } else if (strcmp(compiler_filter_string, "balanced") == 0) {
1204    compiler_filter = CompilerOptions::kBalanced;
1205  } else if (strcmp(compiler_filter_string, "speed") == 0) {
1206    compiler_filter = CompilerOptions::kSpeed;
1207  } else if (strcmp(compiler_filter_string, "everything") == 0) {
1208    compiler_filter = CompilerOptions::kEverything;
1209  } else {
1210    Usage("Unknown --compiler-filter value %s", compiler_filter_string);
1211  }
1212
1213  // Set the compilation target's implicit checks options.
1214  switch (instruction_set) {
1215    case kArm:
1216    case kThumb2:
1217    case kArm64:
1218    case kX86:
1219    case kX86_64:
1220      implicit_null_checks = true;
1221      implicit_so_checks = true;
1222      break;
1223
1224    default:
1225      // Defaults are correct.
1226      break;
1227  }
1228
1229  std::unique_ptr<CompilerOptions> compiler_options(new CompilerOptions(compiler_filter,
1230                                                                        huge_method_threshold,
1231                                                                        large_method_threshold,
1232                                                                        small_method_threshold,
1233                                                                        tiny_method_threshold,
1234                                                                        num_dex_methods_threshold,
1235                                                                        generate_gdb_information,
1236                                                                        include_patch_information,
1237                                                                        top_k_profile_threshold,
1238                                                                        include_debug_symbols,
1239                                                                        implicit_null_checks,
1240                                                                        implicit_so_checks,
1241                                                                        implicit_suspend_checks,
1242                                                                        compile_pic
1243#ifdef ART_SEA_IR_MODE
1244                                                                        , compiler_options.sea_ir_ =
1245                                                                              true;
1246#endif
1247  ));  // NOLINT(whitespace/parens)
1248
1249  // Done with usage checks, enable watchdog if requested
1250  WatchDog watch_dog(watch_dog_enabled);
1251
1252  // Check early that the result of compilation can be written
1253  std::unique_ptr<File> oat_file;
1254  bool create_file = !oat_unstripped.empty();  // as opposed to using open file descriptor
1255  if (create_file) {
1256    oat_file.reset(OS::CreateEmptyFile(oat_unstripped.c_str()));
1257    if (oat_location.empty()) {
1258      oat_location = oat_filename;
1259    }
1260  } else {
1261    oat_file.reset(new File(oat_fd, oat_location));
1262    oat_file->DisableAutoClose();
1263    oat_file->SetLength(0);
1264  }
1265  if (oat_file.get() == nullptr) {
1266    PLOG(ERROR) << "Failed to create oat file: " << oat_location;
1267    return EXIT_FAILURE;
1268  }
1269  if (create_file && fchmod(oat_file->Fd(), 0644) != 0) {
1270    PLOG(ERROR) << "Failed to make oat file world readable: " << oat_location;
1271    return EXIT_FAILURE;
1272  }
1273
1274  timings.StartTiming("dex2oat Setup");
1275  LOG(INFO) << CommandLine();
1276
1277  RuntimeOptions runtime_options;
1278  std::vector<const DexFile*> boot_class_path;
1279  art::MemMap::Init();  // For ZipEntry::ExtractToMemMap.
1280  if (boot_image_option.empty()) {
1281    size_t failure_count = OpenDexFiles(dex_filenames, dex_locations, boot_class_path);
1282    if (failure_count > 0) {
1283      LOG(ERROR) << "Failed to open some dex files: " << failure_count;
1284      return EXIT_FAILURE;
1285    }
1286    runtime_options.push_back(std::make_pair("bootclasspath", &boot_class_path));
1287  } else {
1288    runtime_options.push_back(std::make_pair(boot_image_option.c_str(), nullptr));
1289  }
1290  for (size_t i = 0; i < runtime_args.size(); i++) {
1291    runtime_options.push_back(std::make_pair(runtime_args[i], nullptr));
1292  }
1293
1294  std::unique_ptr<VerificationResults> verification_results(new VerificationResults(
1295                                                            compiler_options.get()));
1296  DexFileToMethodInlinerMap method_inliner_map;
1297  QuickCompilerCallbacks callbacks(verification_results.get(), &method_inliner_map);
1298  runtime_options.push_back(std::make_pair("compilercallbacks", &callbacks));
1299  runtime_options.push_back(
1300      std::make_pair("imageinstructionset",
1301                     reinterpret_cast<const void*>(GetInstructionSetString(instruction_set))));
1302
1303  Dex2Oat* p_dex2oat;
1304  if (!Dex2Oat::Create(&p_dex2oat,
1305                       runtime_options,
1306                       *compiler_options,
1307                       compiler_kind,
1308                       instruction_set,
1309                       instruction_set_features,
1310                       verification_results.get(),
1311                       &method_inliner_map,
1312                       thread_count)) {
1313    LOG(ERROR) << "Failed to create dex2oat";
1314    timings.EndTiming();
1315    return EXIT_FAILURE;
1316  }
1317  std::unique_ptr<Dex2Oat> dex2oat(p_dex2oat);
1318
1319  // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start,
1320  // give it away now so that we don't starve GC.
1321  Thread* self = Thread::Current();
1322  self->TransitionFromRunnableToSuspended(kNative);
1323  // If we're doing the image, override the compiler filter to force full compilation. Must be
1324  // done ahead of WellKnownClasses::Init that causes verification.  Note: doesn't force
1325  // compilation of class initializers.
1326  // Whilst we're in native take the opportunity to initialize well known classes.
1327  WellKnownClasses::Init(self->GetJniEnv());
1328
1329  // If --image-classes was specified, calculate the full list of classes to include in the image
1330  std::unique_ptr<std::set<std::string>> image_classes(nullptr);
1331  if (image_classes_filename != nullptr) {
1332    std::string error_msg;
1333    if (image_classes_zip_filename != nullptr) {
1334      image_classes.reset(dex2oat->ReadImageClassesFromZip(image_classes_zip_filename,
1335                                                           image_classes_filename,
1336                                                           &error_msg));
1337    } else {
1338      image_classes.reset(dex2oat->ReadImageClassesFromFile(image_classes_filename));
1339    }
1340    if (image_classes.get() == nullptr) {
1341      LOG(ERROR) << "Failed to create list of image classes from '" << image_classes_filename <<
1342          "': " << error_msg;
1343      timings.EndTiming();
1344      return EXIT_FAILURE;
1345    }
1346  } else if (image) {
1347    image_classes.reset(new std::set<std::string>);
1348  }
1349  // If --compiled-classes was specified, calculate the full list of classes to compile in the
1350  // image.
1351  std::unique_ptr<std::set<std::string>> compiled_classes(nullptr);
1352  if (compiled_classes_filename != nullptr) {
1353    std::string error_msg;
1354    if (compiled_classes_zip_filename != nullptr) {
1355      compiled_classes.reset(dex2oat->ReadImageClassesFromZip(compiled_classes_zip_filename,
1356                                                              compiled_classes_filename,
1357                                                              &error_msg));
1358    } else {
1359      compiled_classes.reset(dex2oat->ReadImageClassesFromFile(compiled_classes_filename));
1360    }
1361    if (compiled_classes.get() == nullptr) {
1362      LOG(ERROR) << "Failed to create list of compiled classes from '" << compiled_classes_filename
1363                 << "': " << error_msg;
1364      timings.EndTiming();
1365      return EXIT_FAILURE;
1366    }
1367  } else if (image) {
1368    compiled_classes.reset(nullptr);  // By default compile everything.
1369  }
1370
1371  std::vector<const DexFile*> dex_files;
1372  if (boot_image_option.empty()) {
1373    dex_files = Runtime::Current()->GetClassLinker()->GetBootClassPath();
1374  } else {
1375    if (dex_filenames.empty()) {
1376      ATRACE_BEGIN("Opening zip archive from file descriptor");
1377      std::string error_msg;
1378      std::unique_ptr<ZipArchive> zip_archive(ZipArchive::OpenFromFd(zip_fd, zip_location.c_str(),
1379                                                               &error_msg));
1380      if (zip_archive.get() == nullptr) {
1381        LOG(ERROR) << "Failed to open zip from file descriptor for '" << zip_location << "': "
1382            << error_msg;
1383        timings.EndTiming();
1384        return EXIT_FAILURE;
1385      }
1386      if (!DexFile::OpenFromZip(*zip_archive.get(), zip_location, &error_msg, &dex_files)) {
1387        LOG(ERROR) << "Failed to open dex from file descriptor for zip file '" << zip_location
1388            << "': " << error_msg;
1389        timings.EndTiming();
1390        return EXIT_FAILURE;
1391      }
1392      ATRACE_END();
1393    } else {
1394      size_t failure_count = OpenDexFiles(dex_filenames, dex_locations, dex_files);
1395      if (failure_count > 0) {
1396        LOG(ERROR) << "Failed to open some dex files: " << failure_count;
1397        timings.EndTiming();
1398        return EXIT_FAILURE;
1399      }
1400    }
1401
1402    const bool kSaveDexInput = false;
1403    if (kSaveDexInput) {
1404      for (size_t i = 0; i < dex_files.size(); ++i) {
1405        const DexFile* dex_file = dex_files[i];
1406        std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex", getpid(), i));
1407        std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
1408        if (tmp_file.get() == nullptr) {
1409            PLOG(ERROR) << "Failed to open file " << tmp_file_name
1410                        << ". Try: adb shell chmod 777 /data/local/tmp";
1411            continue;
1412        }
1413        tmp_file->WriteFully(dex_file->Begin(), dex_file->Size());
1414        LOG(INFO) << "Wrote input to " << tmp_file_name;
1415      }
1416    }
1417  }
1418  // Ensure opened dex files are writable for dex-to-dex transformations.
1419  for (const auto& dex_file : dex_files) {
1420    if (!dex_file->EnableWrite()) {
1421      PLOG(ERROR) << "Failed to make .dex file writeable '" << dex_file->GetLocation() << "'\n";
1422    }
1423  }
1424
1425  /*
1426   * If we're not in interpret-only or verify-none mode, go ahead and compile small applications.
1427   * Don't bother to check if we're doing the image.
1428   */
1429  if (!image && compiler_options->IsCompilationEnabled()) {
1430    size_t num_methods = 0;
1431    for (size_t i = 0; i != dex_files.size(); ++i) {
1432      const DexFile* dex_file = dex_files[i];
1433      CHECK(dex_file != nullptr);
1434      num_methods += dex_file->NumMethodIds();
1435    }
1436    if (num_methods <= compiler_options->GetNumDexMethodsThreshold()) {
1437      compiler_options->SetCompilerFilter(CompilerOptions::kSpeed);
1438      VLOG(compiler) << "Below method threshold, compiling anyways";
1439    }
1440  }
1441
1442  // Fill some values into the key-value store for the oat header.
1443  std::unique_ptr<SafeMap<std::string, std::string> > key_value_store(
1444      new SafeMap<std::string, std::string>());
1445
1446  // Insert some compiler things.
1447  {
1448    std::ostringstream oss;
1449    for (int i = 0; i < argc; ++i) {
1450      if (i > 0) {
1451        oss << ' ';
1452      }
1453      oss << argv[i];
1454    }
1455    key_value_store->Put(OatHeader::kDex2OatCmdLineKey, oss.str());
1456    oss.str("");  // Reset.
1457    oss << kRuntimeISA;
1458    key_value_store->Put(OatHeader::kDex2OatHostKey, oss.str());
1459    key_value_store->Put(OatHeader::kPicKey, compile_pic ? "true" : "false");
1460  }
1461
1462  std::unique_ptr<const CompilerDriver> compiler(dex2oat->CreateOatFile(boot_image_option,
1463                                                                        android_root,
1464                                                                        is_host,
1465                                                                        dex_files,
1466                                                                        oat_file.get(),
1467                                                                        oat_location,
1468                                                                        bitcode_filename,
1469                                                                        image,
1470                                                                        image_classes,
1471                                                                        compiled_classes,
1472                                                                        dump_stats,
1473                                                                        dump_passes,
1474                                                                        timings,
1475                                                                        compiler_phases_timings,
1476                                                                        profile_file,
1477                                                                        key_value_store.get()));
1478  if (compiler.get() == nullptr) {
1479    LOG(ERROR) << "Failed to create oat file: " << oat_location;
1480    timings.EndTiming();
1481    return EXIT_FAILURE;
1482  }
1483
1484  VLOG(compiler) << "Oat file written successfully (unstripped): " << oat_location;
1485
1486  // Notes on the interleaving of creating the image and oat file to
1487  // ensure the references between the two are correct.
1488  //
1489  // Currently we have a memory layout that looks something like this:
1490  //
1491  // +--------------+
1492  // | image        |
1493  // +--------------+
1494  // | boot oat     |
1495  // +--------------+
1496  // | alloc spaces |
1497  // +--------------+
1498  //
1499  // There are several constraints on the loading of the image and boot.oat.
1500  //
1501  // 1. The image is expected to be loaded at an absolute address and
1502  // contains Objects with absolute pointers within the image.
1503  //
1504  // 2. There are absolute pointers from Methods in the image to their
1505  // code in the oat.
1506  //
1507  // 3. There are absolute pointers from the code in the oat to Methods
1508  // in the image.
1509  //
1510  // 4. There are absolute pointers from code in the oat to other code
1511  // in the oat.
1512  //
1513  // To get this all correct, we go through several steps.
1514  //
1515  // 1. We have already created that oat file above with
1516  // CreateOatFile. Originally this was just our own proprietary file
1517  // but now it is contained within an ELF dynamic object (aka an .so
1518  // file). The Compiler returned by CreateOatFile provides
1519  // PatchInformation for references to oat code and Methods that need
1520  // to be update once we know where the oat file will be located
1521  // after the image.
1522  //
1523  // 2. We create the image file. It needs to know where the oat file
1524  // will be loaded after itself. Originally when oat file was simply
1525  // memory mapped so we could predict where its contents were based
1526  // on the file size. Now that it is an ELF file, we need to inspect
1527  // the ELF file to understand the in memory segment layout including
1528  // where the oat header is located within. ElfPatcher's Patch method
1529  // uses the PatchInformation from the Compiler to touch up absolute
1530  // references in the oat file.
1531  //
1532  // 3. We fixup the ELF program headers so that dlopen will try to
1533  // load the .so at the desired location at runtime by offsetting the
1534  // Elf32_Phdr.p_vaddr values by the desired base address.
1535  //
1536  if (image) {
1537    TimingLogger::ScopedTiming t("dex2oat ImageWriter", &timings);
1538    bool image_creation_success = dex2oat->CreateImageFile(image_filename,
1539                                                           image_base,
1540                                                           oat_unstripped,
1541                                                           oat_location,
1542                                                           *compiler.get());
1543    if (!image_creation_success) {
1544      timings.EndTiming();
1545      return EXIT_FAILURE;
1546    }
1547    VLOG(compiler) << "Image written successfully: " << image_filename;
1548  }
1549
1550  if (is_host) {
1551    timings.EndTiming();
1552    if (dump_timing || (dump_slow_timing && timings.GetTotalNs() > MsToNs(1000))) {
1553      LOG(INFO) << Dumpable<TimingLogger>(timings);
1554    }
1555    if (dump_passes) {
1556      LOG(INFO) << Dumpable<CumulativeLogger>(*compiler.get()->GetTimingsLogger());
1557    }
1558    return EXIT_SUCCESS;
1559  }
1560
1561  // If we don't want to strip in place, copy from unstripped location to stripped location.
1562  // We need to strip after image creation because FixupElf needs to use .strtab.
1563  if (oat_unstripped != oat_stripped) {
1564    TimingLogger::ScopedTiming t("dex2oat OatFile copy", &timings);
1565    oat_file.reset();
1566     std::unique_ptr<File> in(OS::OpenFileForReading(oat_unstripped.c_str()));
1567    std::unique_ptr<File> out(OS::CreateEmptyFile(oat_stripped.c_str()));
1568    size_t buffer_size = 8192;
1569    std::unique_ptr<uint8_t> buffer(new uint8_t[buffer_size]);
1570    while (true) {
1571      int bytes_read = TEMP_FAILURE_RETRY(read(in->Fd(), buffer.get(), buffer_size));
1572      if (bytes_read <= 0) {
1573        break;
1574      }
1575      bool write_ok = out->WriteFully(buffer.get(), bytes_read);
1576      CHECK(write_ok);
1577    }
1578    oat_file.reset(out.release());
1579    VLOG(compiler) << "Oat file copied successfully (stripped): " << oat_stripped;
1580  }
1581
1582#if ART_USE_PORTABLE_COMPILER  // We currently only generate symbols on Portable
1583  if (!compiler_options.GetIncludeDebugSymbols()) {
1584    timings.NewSplit("dex2oat ElfStripper");
1585    // Strip unneeded sections for target
1586    off_t seek_actual = lseek(oat_file->Fd(), 0, SEEK_SET);
1587    CHECK_EQ(0, seek_actual);
1588    std::string error_msg;
1589    CHECK(ElfStripper::Strip(oat_file.get(), &error_msg)) << error_msg;
1590
1591
1592    // We wrote the oat file successfully, and want to keep it.
1593    VLOG(compiler) << "Oat file written successfully (stripped): " << oat_location;
1594  } else {
1595    VLOG(compiler) << "Oat file written successfully without stripping: " << oat_location;
1596  }
1597#endif  // ART_USE_PORTABLE_COMPILER
1598
1599  timings.EndTiming();
1600
1601  if (dump_timing || (dump_slow_timing && timings.GetTotalNs() > MsToNs(1000))) {
1602    LOG(INFO) << Dumpable<TimingLogger>(timings);
1603  }
1604  if (dump_passes) {
1605    LOG(INFO) << Dumpable<CumulativeLogger>(compiler_phases_timings);
1606  }
1607
1608  // Everything was successfully written, do an explicit exit here to avoid running Runtime
1609  // destructors that take time (bug 10645725) unless we're a debug build or running on valgrind.
1610  if (!kIsDebugBuild && (RUNNING_ON_VALGRIND == 0)) {
1611    dex2oat->LogCompletionTime();
1612    exit(EXIT_SUCCESS);
1613  }
1614
1615  return EXIT_SUCCESS;
1616}  // NOLINT(readability/fn_size)
1617}  // namespace art
1618
1619int main(int argc, char** argv) {
1620  return art::dex2oat(argc, argv);
1621}
1622