Elliott Hughes | 2faa5f1 | 2012-01-30 14:42:07 -0800 | [diff] [blame] | 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 | */ |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 16 | |
| 17 | #ifndef ART_SRC_OAT_WRITER_H_ |
| 18 | #define ART_SRC_OAT_WRITER_H_ |
| 19 | |
| 20 | #include <stdint.h> |
| 21 | |
| 22 | #include <cstddef> |
| 23 | |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 24 | #include "compiler.h" |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 25 | #include "dex_cache.h" |
| 26 | #include "mem_map.h" |
| 27 | #include "oat.h" |
| 28 | #include "object.h" |
| 29 | #include "os.h" |
Elliott Hughes | a0e1806 | 2012-04-13 15:59:59 -0700 | [diff] [blame] | 30 | #include "safe_map.h" |
| 31 | #include "UniquePtr.h" |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 32 | |
| 33 | namespace art { |
| 34 | |
Brian Carlstrom | 81f3ca1 | 2012-03-17 00:27:35 -0700 | [diff] [blame] | 35 | // OatHeader variable length with count of D OatDexFiles |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 36 | // |
Brian Carlstrom | 389efb0 | 2012-01-11 12:06:26 -0800 | [diff] [blame] | 37 | // OatDexFile[0] one variable sized OatDexFile with offsets to Dex and OatClasses |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 38 | // OatDexFile[1] |
| 39 | // ... |
| 40 | // OatDexFile[D] |
| 41 | // |
Brian Carlstrom | 8952189 | 2011-12-07 22:05:07 -0800 | [diff] [blame] | 42 | // Dex[0] one variable sized DexFile for each OatDexFile. |
| 43 | // Dex[1] these are literal copies of the input .dex files. |
| 44 | // ... |
| 45 | // Dex[D] |
| 46 | // |
Brian Carlstrom | 389efb0 | 2012-01-11 12:06:26 -0800 | [diff] [blame] | 47 | // OatClass[0] one variable sized OatClass for each of C DexFile::ClassDefs |
| 48 | // OatClass[1] contains OatClass entries with class status, offsets to code, etc. |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 49 | // ... |
Brian Carlstrom | 389efb0 | 2012-01-11 12:06:26 -0800 | [diff] [blame] | 50 | // OatClass[C] |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 51 | // |
Brian Carlstrom | f03c288 | 2012-03-05 20:29:06 -0800 | [diff] [blame] | 52 | // padding if necessary so that the following code will be page aligned |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 53 | // |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 54 | // CompiledMethod one variable sized blob with the contents of each CompiledMethod |
| 55 | // CompiledMethod |
| 56 | // CompiledMethod |
| 57 | // CompiledMethod |
| 58 | // CompiledMethod |
| 59 | // CompiledMethod |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 60 | // ... |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 61 | // CompiledMethod |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 62 | // |
| 63 | class OatWriter { |
| 64 | public: |
| 65 | // Write an oat file. Returns true on success, false on failure. |
Brian Carlstrom | 81f3ca1 | 2012-03-17 00:27:35 -0700 | [diff] [blame] | 66 | static bool Create(File* file, |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 67 | jobject class_loader, |
Brian Carlstrom | 81f3ca1 | 2012-03-17 00:27:35 -0700 | [diff] [blame] | 68 | const std::vector<const DexFile*>& dex_files, |
Brian Carlstrom | 28db012 | 2012-10-18 16:20:41 -0700 | [diff] [blame] | 69 | uint32_t image_file_location_oat_checksum, |
| 70 | uint32_t image_file_location_oat_begin, |
Brian Carlstrom | 81f3ca1 | 2012-03-17 00:27:35 -0700 | [diff] [blame] | 71 | const std::string& image_file_location, |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 72 | const Compiler& compiler) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 73 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 74 | |
| 75 | private: |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 76 | OatWriter(const std::vector<const DexFile*>& dex_files, |
Brian Carlstrom | 28db012 | 2012-10-18 16:20:41 -0700 | [diff] [blame] | 77 | uint32_t image_file_location_oat_checksum, |
| 78 | uint32_t image_file_location_oat_begin, |
Brian Carlstrom | 81f3ca1 | 2012-03-17 00:27:35 -0700 | [diff] [blame] | 79 | const std::string& image_file_location, |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 80 | jobject class_loader, |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 81 | const Compiler& compiler) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 82 | ~OatWriter(); |
| 83 | |
Brian Carlstrom | 81f3ca1 | 2012-03-17 00:27:35 -0700 | [diff] [blame] | 84 | size_t InitOatHeader(); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 85 | size_t InitOatDexFiles(size_t offset); |
Brian Carlstrom | 8952189 | 2011-12-07 22:05:07 -0800 | [diff] [blame] | 86 | size_t InitDexFiles(size_t offset); |
Brian Carlstrom | 389efb0 | 2012-01-11 12:06:26 -0800 | [diff] [blame] | 87 | size_t InitOatClasses(size_t offset); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 88 | size_t InitOatCode(size_t offset); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 89 | size_t InitOatCodeDexFiles(size_t offset) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 90 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 91 | size_t InitOatCodeDexFile(size_t offset, |
| 92 | size_t& oat_class_index, |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 93 | const DexFile& dex_file) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 94 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 95 | size_t InitOatCodeClassDef(size_t offset, |
Ian Rogers | c20a83e | 2012-01-18 18:15:32 -0800 | [diff] [blame] | 96 | size_t oat_class_index, size_t class_def_index, |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 97 | const DexFile& dex_file, |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 98 | const DexFile::ClassDef& class_def) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 99 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | c20a83e | 2012-01-18 18:15:32 -0800 | [diff] [blame] | 100 | size_t InitOatCodeMethod(size_t offset, size_t oat_class_index, size_t class_def_index, |
Ian Rogers | 08f753d | 2012-08-24 14:35:25 -0700 | [diff] [blame] | 101 | size_t class_def_method_index, bool is_native, InvokeType type, |
| 102 | uint32_t method_idx, const DexFile*) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 103 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 104 | |
Elliott Hughes | 234da57 | 2011-11-03 22:13:06 -0700 | [diff] [blame] | 105 | bool Write(File* file); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 106 | bool WriteTables(File* file); |
| 107 | size_t WriteCode(File* file); |
Ian Rogers | 0571d35 | 2011-11-03 19:51:38 -0700 | [diff] [blame] | 108 | size_t WriteCodeDexFiles(File* file, size_t offset); |
| 109 | size_t WriteCodeDexFile(File* file, size_t offset, size_t& oat_class_index, |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 110 | const DexFile& dex_file); |
Ian Rogers | 0571d35 | 2011-11-03 19:51:38 -0700 | [diff] [blame] | 111 | size_t WriteCodeClassDef(File* file, size_t offset, size_t oat_class_index, |
| 112 | const DexFile& dex_file, const DexFile::ClassDef& class_def); |
| 113 | size_t WriteCodeMethod(File* file, size_t offset, size_t oat_class_index, |
| 114 | size_t class_def_method_index, bool is_static, uint32_t method_idx, |
| 115 | const DexFile& dex_file); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 116 | |
Ian Rogers | 0571d35 | 2011-11-03 19:51:38 -0700 | [diff] [blame] | 117 | void ReportWriteFailure(const char* what, uint32_t method_idx, const DexFile& dex_file, |
| 118 | File* f) const; |
Elliott Hughes | 234da57 | 2011-11-03 22:13:06 -0700 | [diff] [blame] | 119 | |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 120 | class OatDexFile { |
| 121 | public: |
Elliott Hughes | a51a3dd | 2011-10-17 15:19:26 -0700 | [diff] [blame] | 122 | explicit OatDexFile(const DexFile& dex_file); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 123 | size_t SizeOf() const; |
| 124 | void UpdateChecksum(OatHeader& oat_header) const; |
| 125 | bool Write(File* file) const; |
| 126 | |
| 127 | // data to write |
| 128 | uint32_t dex_file_location_size_; |
| 129 | const uint8_t* dex_file_location_data_; |
Brian Carlstrom | 5b332c8 | 2012-02-01 15:02:31 -0800 | [diff] [blame] | 130 | uint32_t dex_file_location_checksum_; |
Brian Carlstrom | 8952189 | 2011-12-07 22:05:07 -0800 | [diff] [blame] | 131 | uint32_t dex_file_offset_; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 132 | std::vector<uint32_t> methods_offsets_; |
| 133 | |
| 134 | private: |
Brian Carlstrom | 6e3b1d9 | 2012-01-11 01:36:32 -0800 | [diff] [blame] | 135 | DISALLOW_COPY_AND_ASSIGN(OatDexFile); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 136 | }; |
| 137 | |
Brian Carlstrom | 389efb0 | 2012-01-11 12:06:26 -0800 | [diff] [blame] | 138 | class OatClass { |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 139 | public: |
Brian Carlstrom | 0755ec5 | 2012-01-11 15:19:46 -0800 | [diff] [blame] | 140 | explicit OatClass(Class::Status status, uint32_t methods_count); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 141 | size_t SizeOf() const; |
| 142 | void UpdateChecksum(OatHeader& oat_header) const; |
| 143 | bool Write(File* file) const; |
| 144 | |
| 145 | // data to write |
Brian Carlstrom | 0755ec5 | 2012-01-11 15:19:46 -0800 | [diff] [blame] | 146 | Class::Status status_; |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 147 | std::vector<OatMethodOffsets> method_offsets_; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 148 | |
| 149 | private: |
Brian Carlstrom | 389efb0 | 2012-01-11 12:06:26 -0800 | [diff] [blame] | 150 | DISALLOW_COPY_AND_ASSIGN(OatClass); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 151 | }; |
| 152 | |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 153 | const Compiler* compiler_; |
| 154 | |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 155 | // TODO: remove the ClassLoader when the code storage moves out of Method |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 156 | jobject class_loader_; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 157 | |
| 158 | // note OatFile does not take ownership of the DexFiles |
| 159 | const std::vector<const DexFile*>* dex_files_; |
| 160 | |
Brian Carlstrom | 28db012 | 2012-10-18 16:20:41 -0700 | [diff] [blame] | 161 | // dependencies on the image. |
| 162 | uint32_t image_file_location_oat_checksum_; |
| 163 | uint32_t image_file_location_oat_begin_; |
Brian Carlstrom | 81f3ca1 | 2012-03-17 00:27:35 -0700 | [diff] [blame] | 164 | std::string image_file_location_; |
| 165 | |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 166 | // data to write |
| 167 | OatHeader* oat_header_; |
| 168 | std::vector<OatDexFile*> oat_dex_files_; |
Brian Carlstrom | 389efb0 | 2012-01-11 12:06:26 -0800 | [diff] [blame] | 169 | std::vector<OatClass*> oat_classes_; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 170 | uint32_t executable_offset_padding_length_; |
| 171 | |
jeffhao | f479dcc | 2011-11-02 15:54:15 -0700 | [diff] [blame] | 172 | template <class T> struct MapCompare { |
| 173 | public: |
| 174 | bool operator() (const T* const &a, const T* const &b) const { |
| 175 | return *a < *b; |
| 176 | } |
| 177 | }; |
| 178 | |
jeffhao | 55d7821 | 2011-11-02 11:41:50 -0700 | [diff] [blame] | 179 | // code mappings for deduplication |
Elliott Hughes | a0e1806 | 2012-04-13 15:59:59 -0700 | [diff] [blame] | 180 | SafeMap<const std::vector<uint8_t>*, uint32_t, MapCompare<std::vector<uint8_t> > > code_offsets_; |
| 181 | SafeMap<const std::vector<uint16_t>*, uint32_t, MapCompare<std::vector<uint16_t> > > vmap_table_offsets_; |
| 182 | SafeMap<const std::vector<uint32_t>*, uint32_t, MapCompare<std::vector<uint32_t> > > mapping_table_offsets_; |
| 183 | SafeMap<const std::vector<uint8_t>*, uint32_t, MapCompare<std::vector<uint8_t> > > gc_map_offsets_; |
jeffhao | 55d7821 | 2011-11-02 11:41:50 -0700 | [diff] [blame] | 184 | |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 185 | DISALLOW_COPY_AND_ASSIGN(OatWriter); |
| 186 | }; |
| 187 | |
| 188 | } // namespace art |
| 189 | |
| 190 | #endif // ART_SRC_OAT_WRITER_H_ |