dex2oat.cc revision f5997b4d3f889569d5a2b724d83d764bfbb8d106
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    TimingLogger::ScopedTiming t2("dex2oat OatWriter", &timings);
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::ScopedTiming t3("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, image_file_location_oat_checksum,
384                         image_file_location_oat_data_begin,
385                         image_file_location,
386                         driver.get(),
387                         &timings);
388
389    t2.NewTiming("Writing ELF");
390    if (!driver->WriteElf(android_root, is_host, dex_files, &oat_writer, oat_file)) {
391      LOG(ERROR) << "Failed to write ELF file " << oat_file->GetPath();
392      return nullptr;
393    }
394
395    return driver.release();
396  }
397
398  bool CreateImageFile(const std::string& image_filename,
399                       uintptr_t image_base,
400                       const std::string& oat_filename,
401                       const std::string& oat_location,
402                       const CompilerDriver& compiler)
403      LOCKS_EXCLUDED(Locks::mutator_lock_) {
404    uintptr_t oat_data_begin;
405    {
406      // ImageWriter is scoped so it can free memory before doing FixupElf
407      ImageWriter image_writer(compiler);
408      if (!image_writer.Write(image_filename, image_base, oat_filename, oat_location)) {
409        LOG(ERROR) << "Failed to create image file " << image_filename;
410        return false;
411      }
412      oat_data_begin = image_writer.GetOatDataBegin();
413    }
414
415    std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename.c_str()));
416    if (oat_file.get() == nullptr) {
417      PLOG(ERROR) << "Failed to open ELF file: " << oat_filename;
418      return false;
419    }
420    if (!ElfFixup::Fixup(oat_file.get(), oat_data_begin)) {
421      LOG(ERROR) << "Failed to fixup ELF file " << oat_file->GetPath();
422      return false;
423    }
424    return true;
425  }
426
427 private:
428  explicit Dex2Oat(const CompilerOptions* compiler_options,
429                   Compiler::Kind compiler_kind,
430                   InstructionSet instruction_set,
431                   InstructionSetFeatures instruction_set_features,
432                   VerificationResults* verification_results,
433                   DexFileToMethodInlinerMap* method_inliner_map,
434                   size_t thread_count)
435      : compiler_options_(compiler_options),
436        compiler_kind_(compiler_kind),
437        instruction_set_(instruction_set),
438        instruction_set_features_(instruction_set_features),
439        verification_results_(verification_results),
440        method_inliner_map_(method_inliner_map),
441        runtime_(nullptr),
442        thread_count_(thread_count),
443        start_ns_(NanoTime()) {
444    CHECK(compiler_options != nullptr);
445    CHECK(verification_results != nullptr);
446    CHECK(method_inliner_map != nullptr);
447  }
448
449  bool CreateRuntime(const Runtime::Options& runtime_options, InstructionSet instruction_set)
450      SHARED_TRYLOCK_FUNCTION(true, Locks::mutator_lock_) {
451    if (!Runtime::Create(runtime_options, false)) {
452      LOG(ERROR) << "Failed to create runtime";
453      return false;
454    }
455    Runtime* runtime = Runtime::Current();
456    runtime->SetInstructionSet(instruction_set);
457    for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) {
458      Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i);
459      if (!runtime->HasCalleeSaveMethod(type)) {
460        runtime->SetCalleeSaveMethod(runtime->CreateCalleeSaveMethod(type), type);
461      }
462    }
463    runtime->GetClassLinker()->FixupDexCaches(runtime->GetResolutionMethod());
464    runtime_ = runtime;
465    return true;
466  }
467
468  // Appends to dex_files any elements of class_path that it doesn't already
469  // contain. This will open those dex files as necessary.
470  static void OpenClassPathFiles(const std::string& class_path,
471                                 std::vector<const DexFile*>& dex_files) {
472    std::vector<std::string> parsed;
473    Split(class_path, ':', parsed);
474    // Take Locks::mutator_lock_ so that lock ordering on the ClassLinker::dex_lock_ is maintained.
475    ScopedObjectAccess soa(Thread::Current());
476    for (size_t i = 0; i < parsed.size(); ++i) {
477      if (DexFilesContains(dex_files, parsed[i])) {
478        continue;
479      }
480      std::string error_msg;
481      const DexFile* dex_file = DexFile::Open(parsed[i].c_str(), parsed[i].c_str(), &error_msg);
482      if (dex_file == nullptr) {
483        LOG(WARNING) << "Failed to open dex file '" << parsed[i] << "': " << error_msg;
484      } else {
485        dex_files.push_back(dex_file);
486      }
487    }
488  }
489
490  // Returns true if dex_files has a dex with the named location.
491  static bool DexFilesContains(const std::vector<const DexFile*>& dex_files,
492                               const std::string& location) {
493    for (size_t i = 0; i < dex_files.size(); ++i) {
494      if (dex_files[i]->GetLocation() == location) {
495        return true;
496      }
497    }
498    return false;
499  }
500
501  const CompilerOptions* const compiler_options_;
502  const Compiler::Kind compiler_kind_;
503
504  const InstructionSet instruction_set_;
505  const InstructionSetFeatures instruction_set_features_;
506
507  VerificationResults* const verification_results_;
508  DexFileToMethodInlinerMap* const method_inliner_map_;
509  Runtime* runtime_;
510  size_t thread_count_;
511  uint64_t start_ns_;
512
513  DISALLOW_IMPLICIT_CONSTRUCTORS(Dex2Oat);
514};
515
516static bool ParseInt(const char* in, int* out) {
517  char* end;
518  int result = strtol(in, &end, 10);
519  if (in == end || *end != '\0') {
520    return false;
521  }
522  *out = result;
523  return true;
524}
525
526static size_t OpenDexFiles(const std::vector<const char*>& dex_filenames,
527                           const std::vector<const char*>& dex_locations,
528                           std::vector<const DexFile*>& dex_files) {
529  size_t failure_count = 0;
530  for (size_t i = 0; i < dex_filenames.size(); i++) {
531    const char* dex_filename = dex_filenames[i];
532    const char* dex_location = dex_locations[i];
533    ATRACE_BEGIN(StringPrintf("Opening dex file '%s'", dex_filenames[i]).c_str());
534    std::string error_msg;
535    if (!OS::FileExists(dex_filename)) {
536      LOG(WARNING) << "Skipping non-existent dex file '" << dex_filename << "'";
537      continue;
538    }
539    const DexFile* dex_file = DexFile::Open(dex_filename, dex_location, &error_msg);
540    if (dex_file == nullptr) {
541      LOG(WARNING) << "Failed to open .dex from file '" << dex_filename << "': " << error_msg;
542      ++failure_count;
543    } else {
544      dex_files.push_back(dex_file);
545    }
546    ATRACE_END();
547  }
548  return failure_count;
549}
550
551// The primary goal of the watchdog is to prevent stuck build servers
552// during development when fatal aborts lead to a cascade of failures
553// that result in a deadlock.
554class WatchDog {
555// WatchDog defines its own CHECK_PTHREAD_CALL to avoid using Log which uses locks
556#undef CHECK_PTHREAD_CALL
557#define CHECK_WATCH_DOG_PTHREAD_CALL(call, args, what) \
558  do { \
559    int rc = call args; \
560    if (rc != 0) { \
561      errno = rc; \
562      std::string message(# call); \
563      message += " failed for "; \
564      message += reason; \
565      Fatal(message); \
566    } \
567  } while (false)
568
569 public:
570  explicit WatchDog(bool is_watch_dog_enabled) {
571    is_watch_dog_enabled_ = is_watch_dog_enabled;
572    if (!is_watch_dog_enabled_) {
573      return;
574    }
575    shutting_down_ = false;
576    const char* reason = "dex2oat watch dog thread startup";
577    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_init, (&mutex_, nullptr), reason);
578    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_init, (&cond_, nullptr), reason);
579    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_init, (&attr_), reason);
580    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_create, (&pthread_, &attr_, &CallBack, this), reason);
581    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_attr_destroy, (&attr_), reason);
582  }
583  ~WatchDog() {
584    if (!is_watch_dog_enabled_) {
585      return;
586    }
587    const char* reason = "dex2oat watch dog thread shutdown";
588    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
589    shutting_down_ = true;
590    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_signal, (&cond_), reason);
591    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
592
593    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_join, (pthread_, nullptr), reason);
594
595    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_cond_destroy, (&cond_), reason);
596    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_destroy, (&mutex_), reason);
597  }
598
599 private:
600  static void* CallBack(void* arg) {
601    WatchDog* self = reinterpret_cast<WatchDog*>(arg);
602    ::art::SetThreadName("dex2oat watch dog");
603    self->Wait();
604    return nullptr;
605  }
606
607  static void Message(char severity, const std::string& message) {
608    // TODO: Remove when we switch to LOG when we can guarantee it won't prevent shutdown in error
609    //       cases.
610    fprintf(stderr, "dex2oat%s %c %d %d %s\n",
611            kIsDebugBuild ? "d" : "",
612            severity,
613            getpid(),
614            GetTid(),
615            message.c_str());
616  }
617
618  static void Warn(const std::string& message) {
619    Message('W', message);
620  }
621
622  static void Fatal(const std::string& message) {
623    Message('F', message);
624    exit(1);
625  }
626
627  void Wait() {
628    bool warning = true;
629    CHECK_GT(kWatchDogTimeoutSeconds, kWatchDogWarningSeconds);
630    // TODO: tune the multiplier for GC verification, the following is just to make the timeout
631    //       large.
632    int64_t multiplier = kVerifyObjectSupport > kVerifyObjectModeFast ? 100 : 1;
633    timespec warning_ts;
634    InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogWarningSeconds * 1000, 0, &warning_ts);
635    timespec timeout_ts;
636    InitTimeSpec(true, CLOCK_REALTIME, multiplier * kWatchDogTimeoutSeconds * 1000, 0, &timeout_ts);
637    const char* reason = "dex2oat watch dog thread waiting";
638    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_lock, (&mutex_), reason);
639    while (!shutting_down_) {
640      int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &mutex_,
641                                                         warning ? &warning_ts
642                                                                 : &timeout_ts));
643      if (rc == ETIMEDOUT) {
644        std::string message(StringPrintf("dex2oat did not finish after %d seconds",
645                                         warning ? kWatchDogWarningSeconds
646                                                 : kWatchDogTimeoutSeconds));
647        if (warning) {
648          Warn(message.c_str());
649          warning = false;
650        } else {
651          Fatal(message.c_str());
652        }
653      } else if (rc != 0) {
654        std::string message(StringPrintf("pthread_cond_timedwait failed: %s",
655                                         strerror(errno)));
656        Fatal(message.c_str());
657      }
658    }
659    CHECK_WATCH_DOG_PTHREAD_CALL(pthread_mutex_unlock, (&mutex_), reason);
660  }
661
662  // When setting timeouts, keep in mind that the build server may not be as fast as your desktop.
663#if ART_USE_PORTABLE_COMPILER
664  static const unsigned int kWatchDogWarningSeconds =  2 * 60;  // 2 minutes.
665  static const unsigned int kWatchDogTimeoutSeconds = 30 * 60;  // 25 minutes + buffer.
666#else
667  static const unsigned int kWatchDogWarningSeconds =  1 * 60;  // 1 minute.
668  static const unsigned int kWatchDogTimeoutSeconds =  6 * 60;  // 5 minutes + buffer.
669#endif
670
671  bool is_watch_dog_enabled_;
672  bool shutting_down_;
673  // TODO: Switch to Mutex when we can guarantee it won't prevent shutdown in error cases.
674  pthread_mutex_t mutex_;
675  pthread_cond_t cond_;
676  pthread_attr_t attr_;
677  pthread_t pthread_;
678};
679const unsigned int WatchDog::kWatchDogWarningSeconds;
680const unsigned int WatchDog::kWatchDogTimeoutSeconds;
681
682// Given a set of instruction features from the build, parse it.  The
683// input 'str' is a comma separated list of feature names.  Parse it and
684// return the InstructionSetFeatures object.
685static InstructionSetFeatures ParseFeatureList(std::string str) {
686  InstructionSetFeatures result;
687  typedef std::vector<std::string> FeatureList;
688  FeatureList features;
689  Split(str, ',', features);
690  for (FeatureList::iterator i = features.begin(); i != features.end(); i++) {
691    std::string feature = Trim(*i);
692    if (feature == "default") {
693      // Nothing to do.
694    } else if (feature == "div") {
695      // Supports divide instruction.
696       result.SetHasDivideInstruction(true);
697    } else if (feature == "nodiv") {
698      // Turn off support for divide instruction.
699      result.SetHasDivideInstruction(false);
700    } else if (feature == "lpae") {
701      // Supports Large Physical Address Extension.
702      result.SetHasLpae(true);
703    } else if (feature == "nolpae") {
704      // Turn off support for Large Physical Address Extension.
705      result.SetHasLpae(false);
706    } else {
707      Usage("Unknown instruction set feature: '%s'", feature.c_str());
708    }
709  }
710  // others...
711  return result;
712}
713
714void ParseStringAfterChar(const std::string& s, char c, std::string* parsed_value) {
715  std::string::size_type colon = s.find(c);
716  if (colon == std::string::npos) {
717    Usage("Missing char %c in option %s\n", c, s.c_str());
718  }
719  // Add one to remove the char we were trimming until.
720  *parsed_value = s.substr(colon + 1);
721}
722
723void ParseDouble(const std::string& option, char after_char,
724                 double min, double max, double* parsed_value) {
725  std::string substring;
726  ParseStringAfterChar(option, after_char, &substring);
727  bool sane_val = true;
728  double value;
729  if (false) {
730    // TODO: this doesn't seem to work on the emulator.  b/15114595
731    std::stringstream iss(substring);
732    iss >> value;
733    // Ensure that we have a value, there was no cruft after it and it satisfies a sensible range.
734    sane_val = iss.eof() && (value >= min) && (value <= max);
735  } else {
736    char* end = nullptr;
737    value = strtod(substring.c_str(), &end);
738    sane_val = *end == '\0' && value >= min && value <= max;
739  }
740  if (!sane_val) {
741    Usage("Invalid double value %s for option %s\n", substring.c_str(), option.c_str());
742  }
743  *parsed_value = value;
744}
745
746void CheckExplicitCheckOptions(InstructionSet isa, bool* explicit_null_checks,
747                               bool* explicit_so_checks, bool* explicit_suspend_checks) {
748  switch (isa) {
749    case kArm:
750    case kThumb2:
751      break;  // All checks implemented, leave as is.
752
753    default:  // No checks implemented, reset all to explicit checks.
754      *explicit_null_checks = true;
755      *explicit_so_checks = true;
756      *explicit_suspend_checks = true;
757  }
758}
759
760static int dex2oat(int argc, char** argv) {
761#if defined(__linux__) && defined(__arm__)
762  int major, minor;
763  struct utsname uts;
764  if (uname(&uts) != -1 &&
765      sscanf(uts.release, "%d.%d", &major, &minor) == 2 &&
766      ((major < 3) || ((major == 3) && (minor < 4)))) {
767    // Kernels before 3.4 don't handle the ASLR well and we can run out of address
768    // space (http://b/13564922). Work around the issue by inhibiting further mmap() randomization.
769    int old_personality = personality(0xffffffff);
770    if ((old_personality & ADDR_NO_RANDOMIZE) == 0) {
771      int new_personality = personality(old_personality | ADDR_NO_RANDOMIZE);
772      if (new_personality == -1) {
773        LOG(WARNING) << "personality(. | ADDR_NO_RANDOMIZE) failed.";
774      }
775    }
776  }
777#endif
778
779  original_argc = argc;
780  original_argv = argv;
781
782  TimingLogger timings("compiler", false, false);
783  CumulativeLogger compiler_phases_timings("compilation times");
784
785  InitLogging(argv);
786
787  // Skip over argv[0].
788  argv++;
789  argc--;
790
791  if (argc == 0) {
792    Usage("No arguments specified");
793  }
794
795  std::vector<const char*> dex_filenames;
796  std::vector<const char*> dex_locations;
797  int zip_fd = -1;
798  std::string zip_location;
799  std::string oat_filename;
800  std::string oat_symbols;
801  std::string oat_location;
802  int oat_fd = -1;
803  std::string bitcode_filename;
804  const char* image_classes_zip_filename = nullptr;
805  const char* image_classes_filename = nullptr;
806  std::string image_filename;
807  std::string boot_image_filename;
808  uintptr_t image_base = 0;
809  std::string android_root;
810  std::vector<const char*> runtime_args;
811  int thread_count = sysconf(_SC_NPROCESSORS_CONF);
812  Compiler::Kind compiler_kind = kUsePortableCompiler
813      ? Compiler::kPortable
814      : Compiler::kQuick;
815  const char* compiler_filter_string = nullptr;
816  int huge_method_threshold = CompilerOptions::kDefaultHugeMethodThreshold;
817  int large_method_threshold = CompilerOptions::kDefaultLargeMethodThreshold;
818  int small_method_threshold = CompilerOptions::kDefaultSmallMethodThreshold;
819  int tiny_method_threshold = CompilerOptions::kDefaultTinyMethodThreshold;
820  int num_dex_methods_threshold = CompilerOptions::kDefaultNumDexMethodsThreshold;
821
822  // Take the default set of instruction features from the build.
823  InstructionSetFeatures instruction_set_features =
824      ParseFeatureList(Runtime::GetDefaultInstructionSetFeatures());
825
826  InstructionSet instruction_set = kRuntimeISA;
827
828  // Profile file to use
829  std::string profile_file;
830  double top_k_profile_threshold = CompilerOptions::kDefaultTopKProfileThreshold;
831
832  bool is_host = false;
833  bool dump_stats = false;
834  bool dump_timing = false;
835  bool dump_passes = false;
836  bool include_debug_symbols = kIsDebugBuild;
837  bool dump_slow_timing = kIsDebugBuild;
838  bool watch_dog_enabled = !kIsTargetBuild;
839  bool generate_gdb_information = kIsDebugBuild;
840
841  bool explicit_null_checks = true;
842  bool explicit_so_checks = true;
843  bool explicit_suspend_checks = true;
844  bool has_explicit_checks_options = false;
845
846  for (int i = 0; i < argc; i++) {
847    const StringPiece option(argv[i]);
848    const bool log_options = false;
849    if (log_options) {
850      LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
851    }
852    if (option.starts_with("--dex-file=")) {
853      dex_filenames.push_back(option.substr(strlen("--dex-file=")).data());
854    } else if (option.starts_with("--dex-location=")) {
855      dex_locations.push_back(option.substr(strlen("--dex-location=")).data());
856    } else if (option.starts_with("--zip-fd=")) {
857      const char* zip_fd_str = option.substr(strlen("--zip-fd=")).data();
858      if (!ParseInt(zip_fd_str, &zip_fd)) {
859        Usage("Failed to parse --zip-fd argument '%s' as an integer", zip_fd_str);
860      }
861      if (zip_fd < 0) {
862        Usage("--zip-fd passed a negative value %d", zip_fd);
863      }
864    } else if (option.starts_with("--zip-location=")) {
865      zip_location = option.substr(strlen("--zip-location=")).data();
866    } else if (option.starts_with("--oat-file=")) {
867      oat_filename = option.substr(strlen("--oat-file=")).data();
868    } else if (option.starts_with("--oat-symbols=")) {
869      oat_symbols = option.substr(strlen("--oat-symbols=")).data();
870    } else if (option.starts_with("--oat-fd=")) {
871      const char* oat_fd_str = option.substr(strlen("--oat-fd=")).data();
872      if (!ParseInt(oat_fd_str, &oat_fd)) {
873        Usage("Failed to parse --oat-fd argument '%s' as an integer", oat_fd_str);
874      }
875      if (oat_fd < 0) {
876        Usage("--oat-fd passed a negative value %d", oat_fd);
877      }
878    } else if (option == "--watch-dog") {
879      watch_dog_enabled = true;
880    } else if (option == "--no-watch-dog") {
881      watch_dog_enabled = false;
882    } else if (option == "--gen-gdb-info") {
883      generate_gdb_information = true;
884    } else if (option == "--no-gen-gdb-info") {
885      generate_gdb_information = false;
886    } else if (option.starts_with("-j")) {
887      const char* thread_count_str = option.substr(strlen("-j")).data();
888      if (!ParseInt(thread_count_str, &thread_count)) {
889        Usage("Failed to parse -j argument '%s' as an integer", thread_count_str);
890      }
891    } else if (option.starts_with("--oat-location=")) {
892      oat_location = option.substr(strlen("--oat-location=")).data();
893    } else if (option.starts_with("--bitcode=")) {
894      bitcode_filename = option.substr(strlen("--bitcode=")).data();
895    } else if (option.starts_with("--image=")) {
896      image_filename = option.substr(strlen("--image=")).data();
897    } else if (option.starts_with("--image-classes=")) {
898      image_classes_filename = option.substr(strlen("--image-classes=")).data();
899    } else if (option.starts_with("--image-classes-zip=")) {
900      image_classes_zip_filename = option.substr(strlen("--image-classes-zip=")).data();
901    } else if (option.starts_with("--base=")) {
902      const char* image_base_str = option.substr(strlen("--base=")).data();
903      char* end;
904      image_base = strtoul(image_base_str, &end, 16);
905      if (end == image_base_str || *end != '\0') {
906        Usage("Failed to parse hexadecimal value for option %s", option.data());
907      }
908    } else if (option.starts_with("--boot-image=")) {
909      boot_image_filename = option.substr(strlen("--boot-image=")).data();
910    } else if (option.starts_with("--android-root=")) {
911      android_root = option.substr(strlen("--android-root=")).data();
912    } else if (option.starts_with("--instruction-set=")) {
913      StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
914      if (instruction_set_str == "arm") {
915        instruction_set = kThumb2;
916      } else if (instruction_set_str == "arm64") {
917        instruction_set = kArm64;
918      } else if (instruction_set_str == "mips") {
919        instruction_set = kMips;
920      } else if (instruction_set_str == "x86") {
921        instruction_set = kX86;
922      } else if (instruction_set_str == "x86_64") {
923        instruction_set = kX86_64;
924      }
925    } else if (option.starts_with("--instruction-set-features=")) {
926      StringPiece str = option.substr(strlen("--instruction-set-features=")).data();
927      instruction_set_features = ParseFeatureList(str.as_string());
928    } else if (option.starts_with("--compiler-backend=")) {
929      StringPiece backend_str = option.substr(strlen("--compiler-backend=")).data();
930      if (backend_str == "Quick") {
931        compiler_kind = Compiler::kQuick;
932      } else if (backend_str == "Optimizing") {
933        compiler_kind = Compiler::kOptimizing;
934      } else if (backend_str == "Portable") {
935        compiler_kind = Compiler::kPortable;
936      }
937    } else if (option.starts_with("--compiler-filter=")) {
938      compiler_filter_string = option.substr(strlen("--compiler-filter=")).data();
939    } else if (option.starts_with("--huge-method-max=")) {
940      const char* threshold = option.substr(strlen("--huge-method-max=")).data();
941      if (!ParseInt(threshold, &huge_method_threshold)) {
942        Usage("Failed to parse --huge-method-max '%s' as an integer", threshold);
943      }
944      if (huge_method_threshold < 0) {
945        Usage("--huge-method-max passed a negative value %s", huge_method_threshold);
946      }
947    } else if (option.starts_with("--large-method-max=")) {
948      const char* threshold = option.substr(strlen("--large-method-max=")).data();
949      if (!ParseInt(threshold, &large_method_threshold)) {
950        Usage("Failed to parse --large-method-max '%s' as an integer", threshold);
951      }
952      if (large_method_threshold < 0) {
953        Usage("--large-method-max passed a negative value %s", large_method_threshold);
954      }
955    } else if (option.starts_with("--small-method-max=")) {
956      const char* threshold = option.substr(strlen("--small-method-max=")).data();
957      if (!ParseInt(threshold, &small_method_threshold)) {
958        Usage("Failed to parse --small-method-max '%s' as an integer", threshold);
959      }
960      if (small_method_threshold < 0) {
961        Usage("--small-method-max passed a negative value %s", small_method_threshold);
962      }
963    } else if (option.starts_with("--tiny-method-max=")) {
964      const char* threshold = option.substr(strlen("--tiny-method-max=")).data();
965      if (!ParseInt(threshold, &tiny_method_threshold)) {
966        Usage("Failed to parse --tiny-method-max '%s' as an integer", threshold);
967      }
968      if (tiny_method_threshold < 0) {
969        Usage("--tiny-method-max passed a negative value %s", tiny_method_threshold);
970      }
971    } else if (option.starts_with("--num-dex-methods=")) {
972      const char* threshold = option.substr(strlen("--num-dex-methods=")).data();
973      if (!ParseInt(threshold, &num_dex_methods_threshold)) {
974        Usage("Failed to parse --num-dex-methods '%s' as an integer", threshold);
975      }
976      if (num_dex_methods_threshold < 0) {
977        Usage("--num-dex-methods passed a negative value %s", num_dex_methods_threshold);
978      }
979    } else if (option == "--host") {
980      is_host = true;
981    } else if (option == "--runtime-arg") {
982      if (++i >= argc) {
983        Usage("Missing required argument for --runtime-arg");
984      }
985      if (log_options) {
986        LOG(INFO) << "dex2oat: option[" << i << "]=" << argv[i];
987      }
988      runtime_args.push_back(argv[i]);
989    } else if (option == "--dump-timing") {
990      dump_timing = true;
991    } else if (option == "--dump-passes") {
992      dump_passes = true;
993    } else if (option == "--dump-stats") {
994      dump_stats = true;
995    } else if (option == "--include-debug-symbols" || option == "--no-strip-symbols") {
996      include_debug_symbols = true;
997    } else if (option == "--no-include-debug-symbols" || option == "--strip-symbols") {
998      include_debug_symbols = false;
999    } else if (option.starts_with("--profile-file=")) {
1000      profile_file = option.substr(strlen("--profile-file=")).data();
1001      VLOG(compiler) << "dex2oat: profile file is " << profile_file;
1002    } else if (option == "--no-profile-file") {
1003      // No profile
1004    } else if (option.starts_with("--top-k-profile-threshold=")) {
1005      ParseDouble(option.data(), '=', 10.0, 90.0, &top_k_profile_threshold);
1006    } else if (option == "--print-pass-names") {
1007      PassDriverMEOpts::PrintPassNames();
1008    } else if (option.starts_with("--disable-passes=")) {
1009      std::string disable_passes = option.substr(strlen("--disable-passes=")).data();
1010      PassDriverMEOpts::CreateDefaultPassList(disable_passes);
1011    } else if (option.starts_with("--print-passes=")) {
1012      std::string print_passes = option.substr(strlen("--print-passes=")).data();
1013      PassDriverMEOpts::SetPrintPassList(print_passes);
1014    } else if (option == "--print-all-passes") {
1015      PassDriverMEOpts::SetPrintAllPasses();
1016    } else if (option.starts_with("--dump-cfg-passes=")) {
1017      std::string dump_passes = option.substr(strlen("--dump-cfg-passes=")).data();
1018      PassDriverMEOpts::SetDumpPassList(dump_passes);
1019    } else if (option.starts_with("--implicit-checks=")) {
1020      std::string checks = option.substr(strlen("--implicit-checks=")).data();
1021      std::vector<std::string> checkvec;
1022      Split(checks, ',', checkvec);
1023      for (auto& str : checkvec) {
1024        std::string val = Trim(str);
1025        if (val == "none") {
1026          explicit_null_checks = true;
1027          explicit_so_checks = true;
1028          explicit_suspend_checks = true;
1029        } else if (val == "null") {
1030          explicit_null_checks = false;
1031        } else if (val == "suspend") {
1032          explicit_suspend_checks = false;
1033        } else if (val == "stack") {
1034          explicit_so_checks = false;
1035        } else if (val == "all") {
1036          explicit_null_checks = false;
1037          explicit_so_checks = false;
1038          explicit_suspend_checks = false;
1039        } else {
1040          Usage("--implicit-checks passed non-recognized value %s", val.c_str());
1041        }
1042      }
1043      has_explicit_checks_options = true;
1044    } else {
1045      Usage("Unknown argument %s", option.data());
1046    }
1047  }
1048
1049  if (oat_filename.empty() && oat_fd == -1) {
1050    Usage("Output must be supplied with either --oat-file or --oat-fd");
1051  }
1052
1053  if (!oat_filename.empty() && oat_fd != -1) {
1054    Usage("--oat-file should not be used with --oat-fd");
1055  }
1056
1057  if (!oat_symbols.empty() && oat_fd != -1) {
1058    Usage("--oat-symbols should not be used with --oat-fd");
1059  }
1060
1061  if (!oat_symbols.empty() && is_host) {
1062    Usage("--oat-symbols should not be used with --host");
1063  }
1064
1065  if (oat_fd != -1 && !image_filename.empty()) {
1066    Usage("--oat-fd should not be used with --image");
1067  }
1068
1069  if (android_root.empty()) {
1070    const char* android_root_env_var = getenv("ANDROID_ROOT");
1071    if (android_root_env_var == nullptr) {
1072      Usage("--android-root unspecified and ANDROID_ROOT not set");
1073    }
1074    android_root += android_root_env_var;
1075  }
1076
1077  bool image = (!image_filename.empty());
1078  if (!image && boot_image_filename.empty()) {
1079    boot_image_filename += android_root;
1080    boot_image_filename += "/framework/boot.art";
1081  }
1082  std::string boot_image_option;
1083  if (!boot_image_filename.empty()) {
1084    boot_image_option += "-Ximage:";
1085    boot_image_option += boot_image_filename;
1086  }
1087
1088  if (image_classes_filename != nullptr && !image) {
1089    Usage("--image-classes should only be used with --image");
1090  }
1091
1092  if (image_classes_filename != nullptr && !boot_image_option.empty()) {
1093    Usage("--image-classes should not be used with --boot-image");
1094  }
1095
1096  if (image_classes_zip_filename != nullptr && image_classes_filename == nullptr) {
1097    Usage("--image-classes-zip should be used with --image-classes");
1098  }
1099
1100  if (dex_filenames.empty() && zip_fd == -1) {
1101    Usage("Input must be supplied with either --dex-file or --zip-fd");
1102  }
1103
1104  if (!dex_filenames.empty() && zip_fd != -1) {
1105    Usage("--dex-file should not be used with --zip-fd");
1106  }
1107
1108  if (!dex_filenames.empty() && !zip_location.empty()) {
1109    Usage("--dex-file should not be used with --zip-location");
1110  }
1111
1112  if (dex_locations.empty()) {
1113    for (size_t i = 0; i < dex_filenames.size(); i++) {
1114      dex_locations.push_back(dex_filenames[i]);
1115    }
1116  } else if (dex_locations.size() != dex_filenames.size()) {
1117    Usage("--dex-location arguments do not match --dex-file arguments");
1118  }
1119
1120  if (zip_fd != -1 && zip_location.empty()) {
1121    Usage("--zip-location should be supplied with --zip-fd");
1122  }
1123
1124  if (boot_image_option.empty()) {
1125    if (image_base == 0) {
1126      Usage("Non-zero --base not specified");
1127    }
1128  }
1129
1130  std::string oat_stripped(oat_filename);
1131  std::string oat_unstripped;
1132  if (!oat_symbols.empty()) {
1133    oat_unstripped += oat_symbols;
1134  } else {
1135    oat_unstripped += oat_filename;
1136  }
1137
1138  if (compiler_filter_string == nullptr) {
1139    if (instruction_set == kMips) {
1140      // TODO: fix compiler for Mips.
1141      compiler_filter_string = "interpret-only";
1142    } else if (image) {
1143      compiler_filter_string = "speed";
1144    } else {
1145#if ART_SMALL_MODE
1146      compiler_filter_string = "interpret-only";
1147#else
1148      compiler_filter_string = "speed";
1149#endif
1150    }
1151  }
1152  CHECK(compiler_filter_string != nullptr);
1153  CompilerOptions::CompilerFilter compiler_filter = CompilerOptions::kDefaultCompilerFilter;
1154  if (strcmp(compiler_filter_string, "verify-none") == 0) {
1155    compiler_filter = CompilerOptions::kVerifyNone;
1156  } else if (strcmp(compiler_filter_string, "interpret-only") == 0) {
1157    compiler_filter = CompilerOptions::kInterpretOnly;
1158  } else if (strcmp(compiler_filter_string, "space") == 0) {
1159    compiler_filter = CompilerOptions::kSpace;
1160  } else if (strcmp(compiler_filter_string, "balanced") == 0) {
1161    compiler_filter = CompilerOptions::kBalanced;
1162  } else if (strcmp(compiler_filter_string, "speed") == 0) {
1163    compiler_filter = CompilerOptions::kSpeed;
1164  } else if (strcmp(compiler_filter_string, "everything") == 0) {
1165    compiler_filter = CompilerOptions::kEverything;
1166  } else {
1167    Usage("Unknown --compiler-filter value %s", compiler_filter_string);
1168  }
1169
1170  CheckExplicitCheckOptions(instruction_set, &explicit_null_checks, &explicit_so_checks,
1171                            &explicit_suspend_checks);
1172
1173  LOG(INFO) << "init compiler options for explicit null: " << explicit_null_checks;
1174  CompilerOptions compiler_options(compiler_filter,
1175                                   huge_method_threshold,
1176                                   large_method_threshold,
1177                                   small_method_threshold,
1178                                   tiny_method_threshold,
1179                                   num_dex_methods_threshold,
1180                                   generate_gdb_information,
1181                                   top_k_profile_threshold,
1182                                   include_debug_symbols,
1183                                   explicit_null_checks,
1184                                   explicit_so_checks,
1185                                   explicit_suspend_checks
1186#ifdef ART_SEA_IR_MODE
1187                                   , compiler_options.sea_ir_ = true;
1188#endif
1189                                   );  // NOLINT(whitespace/parens)
1190
1191  // Done with usage checks, enable watchdog if requested
1192  WatchDog watch_dog(watch_dog_enabled);
1193
1194  // Check early that the result of compilation can be written
1195  std::unique_ptr<File> oat_file;
1196  bool create_file = !oat_unstripped.empty();  // as opposed to using open file descriptor
1197  if (create_file) {
1198    oat_file.reset(OS::CreateEmptyFile(oat_unstripped.c_str()));
1199    if (oat_location.empty()) {
1200      oat_location = oat_filename;
1201    }
1202  } else {
1203    oat_file.reset(new File(oat_fd, oat_location));
1204    oat_file->DisableAutoClose();
1205  }
1206  if (oat_file.get() == nullptr) {
1207    PLOG(ERROR) << "Failed to create oat file: " << oat_location;
1208    return EXIT_FAILURE;
1209  }
1210  if (create_file && fchmod(oat_file->Fd(), 0644) != 0) {
1211    PLOG(ERROR) << "Failed to make oat file world readable: " << oat_location;
1212    return EXIT_FAILURE;
1213  }
1214
1215  timings.StartTiming("dex2oat Setup");
1216  LOG(INFO) << CommandLine();
1217
1218  Runtime::Options runtime_options;
1219  std::vector<const DexFile*> boot_class_path;
1220  if (boot_image_option.empty()) {
1221    size_t failure_count = OpenDexFiles(dex_filenames, dex_locations, boot_class_path);
1222    if (failure_count > 0) {
1223      LOG(ERROR) << "Failed to open some dex files: " << failure_count;
1224      return EXIT_FAILURE;
1225    }
1226    runtime_options.push_back(std::make_pair("bootclasspath", &boot_class_path));
1227  } else {
1228    runtime_options.push_back(std::make_pair(boot_image_option.c_str(), nullptr));
1229  }
1230  for (size_t i = 0; i < runtime_args.size(); i++) {
1231    runtime_options.push_back(std::make_pair(runtime_args[i], nullptr));
1232  }
1233
1234  VerificationResults verification_results(&compiler_options);
1235  DexFileToMethodInlinerMap method_inliner_map;
1236  CompilerCallbacksImpl callbacks(&verification_results, &method_inliner_map);
1237  runtime_options.push_back(std::make_pair("compilercallbacks", &callbacks));
1238  runtime_options.push_back(
1239      std::make_pair("imageinstructionset",
1240                     reinterpret_cast<const void*>(GetInstructionSetString(instruction_set))));
1241
1242  Dex2Oat* p_dex2oat;
1243  if (!Dex2Oat::Create(&p_dex2oat,
1244                       runtime_options,
1245                       compiler_options,
1246                       compiler_kind,
1247                       instruction_set,
1248                       instruction_set_features,
1249                       &verification_results,
1250                       &method_inliner_map,
1251                       thread_count)) {
1252    LOG(ERROR) << "Failed to create dex2oat";
1253    return EXIT_FAILURE;
1254  }
1255  std::unique_ptr<Dex2Oat> dex2oat(p_dex2oat);
1256
1257  // TODO: Not sure whether it's a good idea to allow anything else but the runtime option in
1258  // this case at all, as we'll have to throw away produced code for a mismatch.
1259  if (!has_explicit_checks_options) {
1260    bool cross_compiling = true;
1261    switch (kRuntimeISA) {
1262      case kArm:
1263      case kThumb2:
1264        cross_compiling = instruction_set != kArm && instruction_set != kThumb2;
1265        break;
1266      default:
1267        cross_compiling = instruction_set != kRuntimeISA;
1268        break;
1269    }
1270    if (!cross_compiling) {
1271      Runtime* runtime = Runtime::Current();
1272      compiler_options.SetExplicitNullChecks(runtime->ExplicitNullChecks());
1273      compiler_options.SetExplicitStackOverflowChecks(runtime->ExplicitStackOverflowChecks());
1274      compiler_options.SetExplicitSuspendChecks(runtime->ExplicitSuspendChecks());
1275    }
1276  }
1277
1278  // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start,
1279  // give it away now so that we don't starve GC.
1280  Thread* self = Thread::Current();
1281  self->TransitionFromRunnableToSuspended(kNative);
1282  // If we're doing the image, override the compiler filter to force full compilation. Must be
1283  // done ahead of WellKnownClasses::Init that causes verification.  Note: doesn't force
1284  // compilation of class initializers.
1285  // Whilst we're in native take the opportunity to initialize well known classes.
1286  WellKnownClasses::Init(self->GetJniEnv());
1287
1288  // If --image-classes was specified, calculate the full list of classes to include in the image
1289  std::unique_ptr<CompilerDriver::DescriptorSet> image_classes(nullptr);
1290  if (image_classes_filename != nullptr) {
1291    std::string error_msg;
1292    if (image_classes_zip_filename != nullptr) {
1293      image_classes.reset(dex2oat->ReadImageClassesFromZip(image_classes_zip_filename,
1294                                                           image_classes_filename,
1295                                                           &error_msg));
1296    } else {
1297      image_classes.reset(dex2oat->ReadImageClassesFromFile(image_classes_filename));
1298    }
1299    if (image_classes.get() == nullptr) {
1300      LOG(ERROR) << "Failed to create list of image classes from '" << image_classes_filename <<
1301          "': " << error_msg;
1302      return EXIT_FAILURE;
1303    }
1304  } else if (image) {
1305    image_classes.reset(new CompilerDriver::DescriptorSet);
1306  }
1307
1308  std::vector<const DexFile*> dex_files;
1309  if (boot_image_option.empty()) {
1310    dex_files = Runtime::Current()->GetClassLinker()->GetBootClassPath();
1311  } else {
1312    if (dex_filenames.empty()) {
1313      ATRACE_BEGIN("Opening zip archive from file descriptor");
1314      std::string error_msg;
1315      std::unique_ptr<ZipArchive> zip_archive(ZipArchive::OpenFromFd(zip_fd, zip_location.c_str(),
1316                                                               &error_msg));
1317      if (zip_archive.get() == nullptr) {
1318        LOG(ERROR) << "Failed to open zip from file descriptor for '" << zip_location << "': "
1319            << error_msg;
1320        return EXIT_FAILURE;
1321      }
1322      const DexFile* dex_file = DexFile::Open(*zip_archive.get(), zip_location, &error_msg);
1323      if (dex_file == nullptr) {
1324        LOG(ERROR) << "Failed to open dex from file descriptor for zip file '" << zip_location
1325            << "': " << error_msg;
1326        return EXIT_FAILURE;
1327      }
1328      dex_files.push_back(dex_file);
1329      ATRACE_END();
1330    } else {
1331      size_t failure_count = OpenDexFiles(dex_filenames, dex_locations, dex_files);
1332      if (failure_count > 0) {
1333        LOG(ERROR) << "Failed to open some dex files: " << failure_count;
1334        return EXIT_FAILURE;
1335      }
1336    }
1337
1338    const bool kSaveDexInput = false;
1339    if (kSaveDexInput) {
1340      for (size_t i = 0; i < dex_files.size(); ++i) {
1341        const DexFile* dex_file = dex_files[i];
1342        std::string tmp_file_name(StringPrintf("/data/local/tmp/dex2oat.%d.%zd.dex", getpid(), i));
1343        std::unique_ptr<File> tmp_file(OS::CreateEmptyFile(tmp_file_name.c_str()));
1344        if (tmp_file.get() == nullptr) {
1345            PLOG(ERROR) << "Failed to open file " << tmp_file_name
1346                        << ". Try: adb shell chmod 777 /data/local/tmp";
1347            continue;
1348        }
1349        tmp_file->WriteFully(dex_file->Begin(), dex_file->Size());
1350        LOG(INFO) << "Wrote input to " << tmp_file_name;
1351      }
1352    }
1353  }
1354  // Ensure opened dex files are writable for dex-to-dex transformations.
1355  for (const auto& dex_file : dex_files) {
1356    if (!dex_file->EnableWrite()) {
1357      PLOG(ERROR) << "Failed to make .dex file writeable '" << dex_file->GetLocation() << "'\n";
1358    }
1359  }
1360
1361  /*
1362   * If we're not in interpret-only or verify-none mode, go ahead and compile small applications.
1363   * Don't bother to check if we're doing the image.
1364   */
1365  if (!image && compiler_options.IsCompilationEnabled()) {
1366    size_t num_methods = 0;
1367    for (size_t i = 0; i != dex_files.size(); ++i) {
1368      const DexFile* dex_file = dex_files[i];
1369      CHECK(dex_file != nullptr);
1370      num_methods += dex_file->NumMethodIds();
1371    }
1372    if (num_methods <= compiler_options.GetNumDexMethodsThreshold()) {
1373      compiler_options.SetCompilerFilter(CompilerOptions::kSpeed);
1374      VLOG(compiler) << "Below method threshold, compiling anyways";
1375    }
1376  }
1377
1378  std::unique_ptr<const CompilerDriver> compiler(dex2oat->CreateOatFile(boot_image_option,
1379                                                                  android_root,
1380                                                                  is_host,
1381                                                                  dex_files,
1382                                                                  oat_file.get(),
1383                                                                  bitcode_filename,
1384                                                                  image,
1385                                                                  image_classes,
1386                                                                  dump_stats,
1387                                                                  dump_passes,
1388                                                                  timings,
1389                                                                  compiler_phases_timings,
1390                                                                  profile_file));
1391
1392  if (compiler.get() == nullptr) {
1393    LOG(ERROR) << "Failed to create oat file: " << oat_location;
1394    return EXIT_FAILURE;
1395  }
1396
1397  VLOG(compiler) << "Oat file written successfully (unstripped): " << oat_location;
1398
1399  // Notes on the interleaving of creating the image and oat file to
1400  // ensure the references between the two are correct.
1401  //
1402  // Currently we have a memory layout that looks something like this:
1403  //
1404  // +--------------+
1405  // | image        |
1406  // +--------------+
1407  // | boot oat     |
1408  // +--------------+
1409  // | alloc spaces |
1410  // +--------------+
1411  //
1412  // There are several constraints on the loading of the image and boot.oat.
1413  //
1414  // 1. The image is expected to be loaded at an absolute address and
1415  // contains Objects with absolute pointers within the image.
1416  //
1417  // 2. There are absolute pointers from Methods in the image to their
1418  // code in the oat.
1419  //
1420  // 3. There are absolute pointers from the code in the oat to Methods
1421  // in the image.
1422  //
1423  // 4. There are absolute pointers from code in the oat to other code
1424  // in the oat.
1425  //
1426  // To get this all correct, we go through several steps.
1427  //
1428  // 1. We have already created that oat file above with
1429  // CreateOatFile. Originally this was just our own proprietary file
1430  // but now it is contained within an ELF dynamic object (aka an .so
1431  // file). The Compiler returned by CreateOatFile provides
1432  // PatchInformation for references to oat code and Methods that need
1433  // to be update once we know where the oat file will be located
1434  // after the image.
1435  //
1436  // 2. We create the image file. It needs to know where the oat file
1437  // will be loaded after itself. Originally when oat file was simply
1438  // memory mapped so we could predict where its contents were based
1439  // on the file size. Now that it is an ELF file, we need to inspect
1440  // the ELF file to understand the in memory segment layout including
1441  // where the oat header is located within. ImageWriter's
1442  // PatchOatCodeAndMethods uses the PatchInformation from the
1443  // Compiler to touch up absolute references in the oat file.
1444  //
1445  // 3. We fixup the ELF program headers so that dlopen will try to
1446  // load the .so at the desired location at runtime by offsetting the
1447  // Elf32_Phdr.p_vaddr values by the desired base address.
1448  //
1449  if (image) {
1450    TimingLogger::ScopedTiming t("dex2oat ImageWriter", &timings);
1451    bool image_creation_success = dex2oat->CreateImageFile(image_filename,
1452                                                           image_base,
1453                                                           oat_unstripped,
1454                                                           oat_location,
1455                                                           *compiler.get());
1456    if (!image_creation_success) {
1457      return EXIT_FAILURE;
1458    }
1459    VLOG(compiler) << "Image written successfully: " << image_filename;
1460  }
1461
1462  if (is_host) {
1463    timings.EndTiming();
1464    if (dump_timing || (dump_slow_timing && timings.GetTotalNs() > MsToNs(1000))) {
1465      LOG(INFO) << Dumpable<TimingLogger>(timings);
1466    }
1467    if (dump_passes) {
1468      LOG(INFO) << Dumpable<CumulativeLogger>(*compiler.get()->GetTimingsLogger());
1469    }
1470    return EXIT_SUCCESS;
1471  }
1472
1473  // If we don't want to strip in place, copy from unstripped location to stripped location.
1474  // We need to strip after image creation because FixupElf needs to use .strtab.
1475  if (oat_unstripped != oat_stripped) {
1476    TimingLogger::ScopedTiming t("dex2oat OatFile copy", &timings);
1477    oat_file.reset();
1478     std::unique_ptr<File> in(OS::OpenFileForReading(oat_unstripped.c_str()));
1479    std::unique_ptr<File> out(OS::CreateEmptyFile(oat_stripped.c_str()));
1480    size_t buffer_size = 8192;
1481    std::unique_ptr<uint8_t> buffer(new uint8_t[buffer_size]);
1482    while (true) {
1483      int bytes_read = TEMP_FAILURE_RETRY(read(in->Fd(), buffer.get(), buffer_size));
1484      if (bytes_read <= 0) {
1485        break;
1486      }
1487      bool write_ok = out->WriteFully(buffer.get(), bytes_read);
1488      CHECK(write_ok);
1489    }
1490    oat_file.reset(out.release());
1491    VLOG(compiler) << "Oat file copied successfully (stripped): " << oat_stripped;
1492  }
1493
1494#if ART_USE_PORTABLE_COMPILER  // We currently only generate symbols on Portable
1495  if (!compiler_options.GetIncludeDebugSymbols()) {
1496    timings.NewSplit("dex2oat ElfStripper");
1497    // Strip unneeded sections for target
1498    off_t seek_actual = lseek(oat_file->Fd(), 0, SEEK_SET);
1499    CHECK_EQ(0, seek_actual);
1500    std::string error_msg;
1501    CHECK(ElfStripper::Strip(oat_file.get(), &error_msg)) << error_msg;
1502
1503
1504    // We wrote the oat file successfully, and want to keep it.
1505    VLOG(compiler) << "Oat file written successfully (stripped): " << oat_location;
1506  } else {
1507    VLOG(compiler) << "Oat file written successfully without stripping: " << oat_location;
1508  }
1509#endif  // ART_USE_PORTABLE_COMPILER
1510
1511  timings.EndTiming();
1512
1513  if (dump_timing || (dump_slow_timing && timings.GetTotalNs() > MsToNs(1000))) {
1514    LOG(INFO) << Dumpable<TimingLogger>(timings);
1515  }
1516  if (dump_passes) {
1517    LOG(INFO) << Dumpable<CumulativeLogger>(compiler_phases_timings);
1518  }
1519
1520  // Everything was successfully written, do an explicit exit here to avoid running Runtime
1521  // destructors that take time (bug 10645725) unless we're a debug build or running on valgrind.
1522  if (!kIsDebugBuild && (RUNNING_ON_VALGRIND == 0)) {
1523    dex2oat->LogCompletionTime();
1524    exit(EXIT_SUCCESS);
1525  }
1526
1527  return EXIT_SUCCESS;
1528}  // NOLINT(readability/fn_size)
1529}  // namespace art
1530
1531int main(int argc, char** argv) {
1532  return art::dex2oat(argc, argv);
1533}
1534