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