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