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