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