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