blob: 07bd0e35db3dfd1dc5ef94880e84b9b93dc14ecc [file] [log] [blame]
Brian Carlstrom7940e442013-07-12 13:46:57 -07001/*
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 "image_writer.h"
18
19#include <sys/stat.h>
Mathieu Chartierceb07b32015-12-10 09:33:21 -080020#include <lz4.h>
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -080021#include <lz4hc.h>
Brian Carlstrom7940e442013-07-12 13:46:57 -070022
Ian Rogers700a4022014-05-19 16:49:03 -070023#include <memory>
Vladimir Marko20f85592015-03-19 10:07:02 +000024#include <numeric>
Mathieu Chartierda5b28a2015-11-05 08:03:47 -080025#include <unordered_set>
Brian Carlstrom7940e442013-07-12 13:46:57 -070026#include <vector>
27
Mathieu Chartierc7853442015-03-27 14:35:38 -070028#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070029#include "art_method-inl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070030#include "base/logging.h"
31#include "base/unix_file/fd_file.h"
Vladimir Marko3481ba22015-04-13 12:22:36 +010032#include "class_linker-inl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070033#include "compiled_method.h"
34#include "dex_file-inl.h"
35#include "driver/compiler_driver.h"
Alex Light53cb16b2014-06-12 11:26:29 -070036#include "elf_file.h"
37#include "elf_utils.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070038#include "elf_writer.h"
39#include "gc/accounting/card_table-inl.h"
40#include "gc/accounting/heap_bitmap.h"
Mathieu Chartier31e89252013-08-28 11:29:12 -070041#include "gc/accounting/space_bitmap-inl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070042#include "gc/heap.h"
43#include "gc/space/large_object_space.h"
44#include "gc/space/space-inl.h"
45#include "globals.h"
46#include "image.h"
47#include "intern_table.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070048#include "linear_alloc.h"
Mathieu Chartierad2541a2013-10-25 10:05:23 -070049#include "lock_word.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070050#include "mirror/abstract_method.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070051#include "mirror/array-inl.h"
52#include "mirror/class-inl.h"
53#include "mirror/class_loader.h"
54#include "mirror/dex_cache-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070055#include "mirror/method.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070056#include "mirror/object-inl.h"
57#include "mirror/object_array-inl.h"
Ian Rogersb0fa5dc2014-04-28 16:47:08 -070058#include "mirror/string-inl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070059#include "oat.h"
60#include "oat_file.h"
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -070061#include "oat_file_manager.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070062#include "runtime.h"
63#include "scoped_thread_state_change.h"
Mathieu Chartiereb8167a2014-05-07 15:43:14 -070064#include "handle_scope-inl.h"
Vladimir Marko20f85592015-03-19 10:07:02 +000065#include "utils/dex_cache_arrays_layout-inl.h"
Brian Carlstrom7940e442013-07-12 13:46:57 -070066
Brian Carlstrom3e3d5912013-07-18 00:19:45 -070067using ::art::mirror::Class;
68using ::art::mirror::DexCache;
Brian Carlstrom3e3d5912013-07-18 00:19:45 -070069using ::art::mirror::Object;
70using ::art::mirror::ObjectArray;
71using ::art::mirror::String;
Brian Carlstrom7940e442013-07-12 13:46:57 -070072
73namespace art {
74
Igor Murashkinf5b4c502014-11-14 15:01:59 -080075// Separate objects into multiple bins to optimize dirty memory use.
76static constexpr bool kBinObjects = true;
77
Mathieu Chartierda5b28a2015-11-05 08:03:47 -080078// Return true if an object is already in an image space.
79bool ImageWriter::IsInBootImage(const void* obj) const {
Mathieu Chartiere467cea2016-01-07 18:36:19 -080080 gc::Heap* const heap = Runtime::Current()->GetHeap();
Mathieu Chartierda5b28a2015-11-05 08:03:47 -080081 if (!compile_app_image_) {
Mathieu Chartiere467cea2016-01-07 18:36:19 -080082 DCHECK(heap->GetBootImageSpaces().empty());
Mathieu Chartierda5b28a2015-11-05 08:03:47 -080083 return false;
84 }
Mathieu Chartiere467cea2016-01-07 18:36:19 -080085 for (gc::space::ImageSpace* boot_image_space : heap->GetBootImageSpaces()) {
86 const uint8_t* image_begin = boot_image_space->Begin();
87 // Real image end including ArtMethods and ArtField sections.
88 const uint8_t* image_end = image_begin + boot_image_space->GetImageHeader().GetImageSize();
89 if (image_begin <= obj && obj < image_end) {
90 return true;
91 }
92 }
93 return false;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -080094}
95
96bool ImageWriter::IsInBootOatFile(const void* ptr) const {
Mathieu Chartiere467cea2016-01-07 18:36:19 -080097 gc::Heap* const heap = Runtime::Current()->GetHeap();
Mathieu Chartierda5b28a2015-11-05 08:03:47 -080098 if (!compile_app_image_) {
Mathieu Chartiere467cea2016-01-07 18:36:19 -080099 DCHECK(heap->GetBootImageSpaces().empty());
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800100 return false;
101 }
Mathieu Chartiere467cea2016-01-07 18:36:19 -0800102 for (gc::space::ImageSpace* boot_image_space : heap->GetBootImageSpaces()) {
103 const ImageHeader& image_header = boot_image_space->GetImageHeader();
104 if (image_header.GetOatFileBegin() <= ptr && ptr < image_header.GetOatFileEnd()) {
105 return true;
106 }
107 }
108 return false;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800109}
110
Andreas Gampedd9d0552015-03-09 12:57:41 -0700111static void CheckNoDexObjectsCallback(Object* obj, void* arg ATTRIBUTE_UNUSED)
Mathieu Chartier90443472015-07-16 20:32:27 -0700112 SHARED_REQUIRES(Locks::mutator_lock_) {
Andreas Gampedd9d0552015-03-09 12:57:41 -0700113 Class* klass = obj->GetClass();
114 CHECK_NE(PrettyClass(klass), "com.android.dex.Dex");
115}
116
117static void CheckNoDexObjects() {
118 ScopedObjectAccess soa(Thread::Current());
119 Runtime::Current()->GetHeap()->VisitObjects(CheckNoDexObjectsCallback, nullptr);
120}
121
Vladimir Markof4da6752014-08-01 19:04:18 +0100122bool ImageWriter::PrepareImageAddressSpace() {
Mathieu Chartier2d721012014-11-10 11:08:06 -0800123 target_ptr_size_ = InstructionSetPointerSize(compiler_driver_.GetInstructionSet());
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800124 gc::Heap* const heap = Runtime::Current()->GetHeap();
Vladimir Markof4da6752014-08-01 19:04:18 +0100125 {
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700126 ScopedObjectAccess soa(Thread::Current());
Vladimir Markof4da6752014-08-01 19:04:18 +0100127 PruneNonImageClasses(); // Remove junk
Mathieu Chartier901e0702016-02-19 13:42:48 -0800128 if (!compile_app_image_) {
129 // Avoid for app image since this may increase RAM and image size.
130 ComputeLazyFieldsForImageClasses(); // Add useful information
131 }
Vladimir Markof4da6752014-08-01 19:04:18 +0100132 }
Vladimir Markof4da6752014-08-01 19:04:18 +0100133 heap->CollectGarbage(false); // Remove garbage.
134
Andreas Gampedd9d0552015-03-09 12:57:41 -0700135 // Dex caches must not have their dex fields set in the image. These are memory buffers of mapped
136 // dex files.
137 //
138 // We may open them in the unstarted-runtime code for class metadata. Their fields should all be
139 // reset in PruneNonImageClasses and the objects reclaimed in the GC. Make sure that's actually
140 // true.
141 if (kIsDebugBuild) {
142 CheckNoDexObjects();
143 }
144
Vladimir Markof4da6752014-08-01 19:04:18 +0100145 if (kIsDebugBuild) {
146 ScopedObjectAccess soa(Thread::Current());
147 CheckNonImageClassesRemoved();
148 }
149
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700150 {
151 ScopedObjectAccess soa(Thread::Current());
152 CalculateNewObjectOffsets();
153 }
Vladimir Markof4da6752014-08-01 19:04:18 +0100154
Mathieu Chartierd39645e2015-06-09 17:50:29 -0700155 // This needs to happen after CalculateNewObjectOffsets since it relies on intern_table_bytes_ and
156 // bin size sums being calculated.
157 if (!AllocMemory()) {
158 return false;
159 }
160
Vladimir Markof4da6752014-08-01 19:04:18 +0100161 return true;
162}
163
Mathieu Chartiera90c7722015-10-29 15:41:36 -0700164bool ImageWriter::Write(int image_fd,
Jeff Haodcdc85b2015-12-04 14:06:18 -0800165 const std::vector<const char*>& image_filenames,
Vladimir Marko944da602016-02-19 12:27:55 +0000166 const std::vector<const char*>& oat_filenames) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800167 // If image_fd or oat_fd are not kInvalidFd then we may have empty strings in image_filenames or
168 // oat_filenames.
Jeff Haodcdc85b2015-12-04 14:06:18 -0800169 CHECK(!image_filenames.empty());
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800170 if (image_fd != kInvalidFd) {
171 CHECK_EQ(image_filenames.size(), 1u);
172 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800173 CHECK(!oat_filenames.empty());
174 CHECK_EQ(image_filenames.size(), oat_filenames.size());
Brian Carlstrom7940e442013-07-12 13:46:57 -0700175
Vladimir Marko944da602016-02-19 12:27:55 +0000176 {
177 ScopedObjectAccess soa(Thread::Current());
178 for (size_t i = 0; i < oat_filenames.size(); ++i) {
179 CreateHeader(i);
180 CopyAndFixupNativeData(i);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800181 }
182 }
Alex Light53cb16b2014-06-12 11:26:29 -0700183
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700184 {
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700185 // TODO: heap validation can't handle these fix up passes.
Jeff Haodcdc85b2015-12-04 14:06:18 -0800186 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700187 Runtime::Current()->GetHeap()->DisableObjectValidation();
188 CopyAndFixupObjects();
189 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700190
Jeff Haodcdc85b2015-12-04 14:06:18 -0800191 for (size_t i = 0; i < image_filenames.size(); ++i) {
192 const char* image_filename = image_filenames[i];
Vladimir Marko944da602016-02-19 12:27:55 +0000193 ImageInfo& image_info = GetImageInfo(i);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800194 std::unique_ptr<File> image_file;
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800195 if (image_fd != kInvalidFd) {
196 if (strlen(image_filename) == 0u) {
197 image_file.reset(new File(image_fd, unix_file::kCheckSafeUsage));
Mathieu Chartier784bb092016-01-28 12:02:00 -0800198 // Empty the file in case it already exists.
199 if (image_file != nullptr) {
200 TEMP_FAILURE_RETRY(image_file->SetLength(0));
201 TEMP_FAILURE_RETRY(image_file->Flush());
202 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800203 } else {
204 LOG(ERROR) << "image fd " << image_fd << " name " << image_filename;
205 }
Jeff Haodcdc85b2015-12-04 14:06:18 -0800206 } else {
207 image_file.reset(OS::CreateEmptyFile(image_filename));
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800208 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800209
Jeff Haodcdc85b2015-12-04 14:06:18 -0800210 if (image_file == nullptr) {
211 LOG(ERROR) << "Failed to open image file " << image_filename;
212 return false;
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800213 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800214
215 if (!compile_app_image_ && fchmod(image_file->Fd(), 0644) != 0) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800216 PLOG(ERROR) << "Failed to make image file world readable: " << image_filename;
217 image_file->Erase();
218 return EXIT_FAILURE;
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800219 }
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800220
Jeff Haodcdc85b2015-12-04 14:06:18 -0800221 std::unique_ptr<char[]> compressed_data;
222 // Image data size excludes the bitmap and the header.
223 ImageHeader* const image_header = reinterpret_cast<ImageHeader*>(image_info.image_->Begin());
224 const size_t image_data_size = image_header->GetImageSize() - sizeof(ImageHeader);
225 char* image_data = reinterpret_cast<char*>(image_info.image_->Begin()) + sizeof(ImageHeader);
226 size_t data_size;
227 const char* image_data_to_write;
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800228 const uint64_t compress_start_time = NanoTime();
Nicolas Geoffray83d4d722015-12-10 08:26:32 +0000229
Jeff Haodcdc85b2015-12-04 14:06:18 -0800230 CHECK_EQ(image_header->storage_mode_, image_storage_mode_);
231 switch (image_storage_mode_) {
Mathieu Chartier9894fc82016-03-17 19:19:15 -0700232 case ImageHeader::kStorageModeLZ4HC: // Fall-through.
Jeff Haodcdc85b2015-12-04 14:06:18 -0800233 case ImageHeader::kStorageModeLZ4: {
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800234 const size_t compressed_max_size = LZ4_compressBound(image_data_size);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800235 compressed_data.reset(new char[compressed_max_size]);
236 data_size = LZ4_compress(
237 reinterpret_cast<char*>(image_info.image_->Begin()) + sizeof(ImageHeader),
238 &compressed_data[0],
239 image_data_size);
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800240
241 break;
242 }
Mathieu Chartier9894fc82016-03-17 19:19:15 -0700243 /*
244 * Disabled due to image_test64 flakyness. Both use same decompression. b/27560444
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800245 case ImageHeader::kStorageModeLZ4HC: {
246 // Bound is same as non HC.
247 const size_t compressed_max_size = LZ4_compressBound(image_data_size);
248 compressed_data.reset(new char[compressed_max_size]);
249 data_size = LZ4_compressHC(
250 reinterpret_cast<char*>(image_info.image_->Begin()) + sizeof(ImageHeader),
251 &compressed_data[0],
252 image_data_size);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800253 break;
254 }
Mathieu Chartier9894fc82016-03-17 19:19:15 -0700255 */
Jeff Haodcdc85b2015-12-04 14:06:18 -0800256 case ImageHeader::kStorageModeUncompressed: {
257 data_size = image_data_size;
258 image_data_to_write = image_data;
259 break;
260 }
261 default: {
262 LOG(FATAL) << "Unsupported";
263 UNREACHABLE();
264 }
265 }
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800266
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800267 if (compressed_data != nullptr) {
268 image_data_to_write = &compressed_data[0];
269 VLOG(compiler) << "Compressed from " << image_data_size << " to " << data_size << " in "
270 << PrettyDuration(NanoTime() - compress_start_time);
Mathieu Chartier9894fc82016-03-17 19:19:15 -0700271 if (kIsDebugBuild) {
272 std::unique_ptr<uint8_t[]> temp(new uint8_t[image_data_size]);
273 const size_t decompressed_size = LZ4_decompress_safe(
274 reinterpret_cast<char*>(&compressed_data[0]),
275 reinterpret_cast<char*>(&temp[0]),
276 data_size,
277 image_data_size);
278 CHECK_EQ(decompressed_size, image_data_size);
279 CHECK_EQ(memcmp(image_data, &temp[0], image_data_size), 0) << image_storage_mode_;
280 }
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800281 }
282
Jeff Haodcdc85b2015-12-04 14:06:18 -0800283 // Write out the image + fields + methods.
284 const bool is_compressed = compressed_data != nullptr;
Mathieu Chartier6f6b1342016-03-09 11:14:50 -0800285 if (!image_file->PwriteFully(image_data_to_write, data_size, sizeof(ImageHeader))) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800286 PLOG(ERROR) << "Failed to write image file data " << image_filename;
287 image_file->Erase();
288 return false;
289 }
290
291 // Write out the image bitmap at the page aligned start of the image end, also uncompressed for
292 // convenience.
293 const ImageSection& bitmap_section = image_header->GetImageSection(
294 ImageHeader::kSectionImageBitmap);
295 // Align up since data size may be unaligned if the image is compressed.
296 size_t bitmap_position_in_file = RoundUp(sizeof(ImageHeader) + data_size, kPageSize);
297 if (!is_compressed) {
298 CHECK_EQ(bitmap_position_in_file, bitmap_section.Offset());
299 }
Mathieu Chartier6f6b1342016-03-09 11:14:50 -0800300 if (!image_file->PwriteFully(reinterpret_cast<char*>(image_info.image_bitmap_->Begin()),
301 bitmap_section.Size(),
302 bitmap_position_in_file)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -0800303 PLOG(ERROR) << "Failed to write image file " << image_filename;
304 image_file->Erase();
305 return false;
306 }
Mathieu Chartier6f6b1342016-03-09 11:14:50 -0800307
308 int err = image_file->Flush();
309 if (err < 0) {
310 PLOG(ERROR) << "Failed to flush image file " << image_filename << " with result " << err;
311 image_file->Erase();
312 return false;
313 }
314
315 // Write header last in case the compiler gets killed in the middle of image writing.
316 // We do not want to have a corrupted image with a valid header.
317 // The header is uncompressed since it contains whether the image is compressed or not.
318 image_header->data_size_ = data_size;
319 if (!image_file->PwriteFully(reinterpret_cast<char*>(image_info.image_->Begin()),
320 sizeof(ImageHeader),
321 0)) {
322 PLOG(ERROR) << "Failed to write image file header " << image_filename;
323 image_file->Erase();
324 return false;
325 }
326
Jeff Haodcdc85b2015-12-04 14:06:18 -0800327 CHECK_EQ(bitmap_position_in_file + bitmap_section.Size(),
328 static_cast<size_t>(image_file->GetLength()));
329 if (image_file->FlushCloseOrErase() != 0) {
330 PLOG(ERROR) << "Failed to flush and close image file " << image_filename;
331 return false;
332 }
Andreas Gampe4303ba92014-11-06 01:00:46 -0800333 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700334 return true;
335}
336
Mathieu Chartierd39645e2015-06-09 17:50:29 -0700337void ImageWriter::SetImageOffset(mirror::Object* object, size_t offset) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700338 DCHECK(object != nullptr);
339 DCHECK_NE(offset, 0U);
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800340
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800341 // The object is already deflated from when we set the bin slot. Just overwrite the lock word.
Mathieu Chartier4d7f61d2014-04-17 14:43:39 -0700342 object->SetLockWord(LockWord::FromForwardingAddress(offset), false);
Mathieu Chartiere401d142015-04-22 13:56:20 -0700343 DCHECK_EQ(object->GetLockWord(false).ReadBarrierState(), 0u);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700344 DCHECK(IsImageOffsetAssigned(object));
345}
346
Mathieu Chartiere401d142015-04-22 13:56:20 -0700347void ImageWriter::UpdateImageOffset(mirror::Object* obj, uintptr_t offset) {
348 DCHECK(IsImageOffsetAssigned(obj)) << obj << " " << offset;
349 obj->SetLockWord(LockWord::FromForwardingAddress(offset), false);
350 DCHECK_EQ(obj->GetLockWord(false).ReadBarrierState(), 0u);
351}
352
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800353void ImageWriter::AssignImageOffset(mirror::Object* object, ImageWriter::BinSlot bin_slot) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700354 DCHECK(object != nullptr);
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800355 DCHECK_NE(image_objects_offset_begin_, 0u);
356
Vladimir Marko944da602016-02-19 12:27:55 +0000357 size_t oat_index = GetOatIndex(object);
358 ImageInfo& image_info = GetImageInfo(oat_index);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800359 size_t bin_slot_offset = image_info.bin_slot_offsets_[bin_slot.GetBin()];
Vladimir Markocf36d492015-08-12 19:27:26 +0100360 size_t new_offset = bin_slot_offset + bin_slot.GetIndex();
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800361 DCHECK_ALIGNED(new_offset, kObjectAlignment);
362
Mathieu Chartierd39645e2015-06-09 17:50:29 -0700363 SetImageOffset(object, new_offset);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800364 DCHECK_LT(new_offset, image_info.image_end_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700365}
366
Ian Rogersef7d42f2014-01-06 12:55:46 -0800367bool ImageWriter::IsImageOffsetAssigned(mirror::Object* object) const {
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800368 // Will also return true if the bin slot was assigned since we are reusing the lock word.
Mathieu Chartier590fee92013-09-13 13:46:47 -0700369 DCHECK(object != nullptr);
Mathieu Chartier4d7f61d2014-04-17 14:43:39 -0700370 return object->GetLockWord(false).GetState() == LockWord::kForwardingAddress;
Mathieu Chartier590fee92013-09-13 13:46:47 -0700371}
372
Ian Rogersef7d42f2014-01-06 12:55:46 -0800373size_t ImageWriter::GetImageOffset(mirror::Object* object) const {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700374 DCHECK(object != nullptr);
375 DCHECK(IsImageOffsetAssigned(object));
Mathieu Chartier4d7f61d2014-04-17 14:43:39 -0700376 LockWord lock_word = object->GetLockWord(false);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700377 size_t offset = lock_word.ForwardingAddress();
Vladimir Marko944da602016-02-19 12:27:55 +0000378 size_t oat_index = GetOatIndex(object);
379 const ImageInfo& image_info = GetImageInfo(oat_index);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800380 DCHECK_LT(offset, image_info.image_end_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700381 return offset;
Mathieu Chartier31e89252013-08-28 11:29:12 -0700382}
383
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800384void ImageWriter::SetImageBinSlot(mirror::Object* object, BinSlot bin_slot) {
385 DCHECK(object != nullptr);
386 DCHECK(!IsImageOffsetAssigned(object));
387 DCHECK(!IsImageBinSlotAssigned(object));
388
389 // Before we stomp over the lock word, save the hash code for later.
390 Monitor::Deflate(Thread::Current(), object);;
391 LockWord lw(object->GetLockWord(false));
392 switch (lw.GetState()) {
393 case LockWord::kFatLocked: {
394 LOG(FATAL) << "Fat locked object " << object << " found during object copy";
395 break;
396 }
397 case LockWord::kThinLocked: {
398 LOG(FATAL) << "Thin locked object " << object << " found during object copy";
399 break;
400 }
401 case LockWord::kUnlocked:
402 // No hash, don't need to save it.
403 break;
404 case LockWord::kHashCode:
Mathieu Chartierd39645e2015-06-09 17:50:29 -0700405 DCHECK(saved_hashcode_map_.find(object) == saved_hashcode_map_.end());
406 saved_hashcode_map_.emplace(object, lw.GetHashCode());
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800407 break;
408 default:
409 LOG(FATAL) << "Unreachable.";
410 UNREACHABLE();
411 }
Mathieu Chartierd39645e2015-06-09 17:50:29 -0700412 object->SetLockWord(LockWord::FromForwardingAddress(bin_slot.Uint32Value()), false);
Mathieu Chartiere401d142015-04-22 13:56:20 -0700413 DCHECK_EQ(object->GetLockWord(false).ReadBarrierState(), 0u);
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800414 DCHECK(IsImageBinSlotAssigned(object));
415}
416
Vladimir Marko20f85592015-03-19 10:07:02 +0000417void ImageWriter::PrepareDexCacheArraySlots() {
Vladimir Markof60c7e22015-11-23 18:05:08 +0000418 // Prepare dex cache array starts based on the ordering specified in the CompilerDriver.
Vladimir Markof60c7e22015-11-23 18:05:08 +0000419 // Set the slot size early to avoid DCHECK() failures in IsImageBinSlotAssigned()
420 // when AssignImageBinSlot() assigns their indexes out or order.
Jeff Haodcdc85b2015-12-04 14:06:18 -0800421 for (const DexFile* dex_file : compiler_driver_.GetDexFilesForOatFile()) {
Vladimir Marko944da602016-02-19 12:27:55 +0000422 auto it = dex_file_oat_index_map_.find(dex_file);
423 DCHECK(it != dex_file_oat_index_map_.end()) << dex_file->GetLocation();
Jeff Haodcdc85b2015-12-04 14:06:18 -0800424 ImageInfo& image_info = GetImageInfo(it->second);
425 image_info.dex_cache_array_starts_.Put(dex_file, image_info.bin_slot_sizes_[kBinDexCacheArray]);
426 DexCacheArraysLayout layout(target_ptr_size_, dex_file);
427 image_info.bin_slot_sizes_[kBinDexCacheArray] += layout.Size();
428 }
Vladimir Markof60c7e22015-11-23 18:05:08 +0000429
Vladimir Marko20f85592015-03-19 10:07:02 +0000430 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
Mathieu Chartier673ed3d2015-08-28 14:56:43 -0700431 Thread* const self = Thread::Current();
432 ReaderMutexLock mu(self, *class_linker->DexLock());
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -0800433 for (const ClassLinker::DexCacheData& data : class_linker->GetDexCachesData()) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -0700434 mirror::DexCache* dex_cache =
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -0800435 down_cast<mirror::DexCache*>(self->DecodeJObject(data.weak_root));
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800436 if (dex_cache == nullptr || IsInBootImage(dex_cache)) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -0700437 continue;
438 }
Vladimir Marko20f85592015-03-19 10:07:02 +0000439 const DexFile* dex_file = dex_cache->GetDexFile();
Mathieu Chartierc7853442015-03-27 14:35:38 -0700440 DexCacheArraysLayout layout(target_ptr_size_, dex_file);
Vladimir Marko20f85592015-03-19 10:07:02 +0000441 DCHECK(layout.Valid());
Vladimir Marko944da602016-02-19 12:27:55 +0000442 size_t oat_index = GetOatIndexForDexCache(dex_cache);
443 ImageInfo& image_info = GetImageInfo(oat_index);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800444 uint32_t start = image_info.dex_cache_array_starts_.Get(dex_file);
Vladimir Marko05792b92015-08-03 11:56:49 +0100445 DCHECK_EQ(dex_file->NumTypeIds() != 0u, dex_cache->GetResolvedTypes() != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800446 AddDexCacheArrayRelocation(dex_cache->GetResolvedTypes(),
447 start + layout.TypesOffset(),
448 dex_cache);
Vladimir Marko05792b92015-08-03 11:56:49 +0100449 DCHECK_EQ(dex_file->NumMethodIds() != 0u, dex_cache->GetResolvedMethods() != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800450 AddDexCacheArrayRelocation(dex_cache->GetResolvedMethods(),
451 start + layout.MethodsOffset(),
452 dex_cache);
Vladimir Marko05792b92015-08-03 11:56:49 +0100453 DCHECK_EQ(dex_file->NumFieldIds() != 0u, dex_cache->GetResolvedFields() != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800454 AddDexCacheArrayRelocation(dex_cache->GetResolvedFields(),
455 start + layout.FieldsOffset(),
456 dex_cache);
Vladimir Marko05792b92015-08-03 11:56:49 +0100457 DCHECK_EQ(dex_file->NumStringIds() != 0u, dex_cache->GetStrings() != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800458 AddDexCacheArrayRelocation(dex_cache->GetStrings(), start + layout.StringsOffset(), dex_cache);
Vladimir Marko20f85592015-03-19 10:07:02 +0000459 }
Vladimir Marko20f85592015-03-19 10:07:02 +0000460}
461
Jeff Haodcdc85b2015-12-04 14:06:18 -0800462void ImageWriter::AddDexCacheArrayRelocation(void* array, size_t offset, DexCache* dex_cache) {
Vladimir Marko05792b92015-08-03 11:56:49 +0100463 if (array != nullptr) {
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800464 DCHECK(!IsInBootImage(array));
Vladimir Marko944da602016-02-19 12:27:55 +0000465 size_t oat_index = GetOatIndexForDexCache(dex_cache);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800466 native_object_relocations_.emplace(array,
Vladimir Marko944da602016-02-19 12:27:55 +0000467 NativeObjectRelocation { oat_index, offset, kNativeObjectRelocationTypeDexCacheArray });
Vladimir Marko05792b92015-08-03 11:56:49 +0100468 }
469}
470
Mathieu Chartiere401d142015-04-22 13:56:20 -0700471void ImageWriter::AddMethodPointerArray(mirror::PointerArray* arr) {
472 DCHECK(arr != nullptr);
473 if (kIsDebugBuild) {
474 for (size_t i = 0, len = arr->GetLength(); i < len; i++) {
Mathieu Chartiera808bac2015-11-05 16:33:15 -0800475 ArtMethod* method = arr->GetElementPtrSize<ArtMethod*>(i, target_ptr_size_);
Mathieu Chartiere401d142015-04-22 13:56:20 -0700476 if (method != nullptr && !method->IsRuntimeMethod()) {
Mathieu Chartiera808bac2015-11-05 16:33:15 -0800477 mirror::Class* klass = method->GetDeclaringClass();
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800478 CHECK(klass == nullptr || KeepClass(klass))
479 << PrettyClass(klass) << " should be a kept class";
Mathieu Chartiere401d142015-04-22 13:56:20 -0700480 }
481 }
482 }
483 // kBinArtMethodClean picked arbitrarily, just required to differentiate between ArtFields and
484 // ArtMethods.
485 pointer_arrays_.emplace(arr, kBinArtMethodClean);
486}
487
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800488void ImageWriter::AssignImageBinSlot(mirror::Object* object) {
489 DCHECK(object != nullptr);
Jeff Haoc7d11882015-02-03 15:08:39 -0800490 size_t object_size = object->SizeOf();
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800491
492 // The magic happens here. We segregate objects into different bins based
493 // on how likely they are to get dirty at runtime.
494 //
495 // Likely-to-dirty objects get packed together into the same bin so that
496 // at runtime their page dirtiness ratio (how many dirty objects a page has) is
497 // maximized.
498 //
499 // This means more pages will stay either clean or shared dirty (with zygote) and
500 // the app will use less of its own (private) memory.
501 Bin bin = kBinRegular;
Vladimir Marko20f85592015-03-19 10:07:02 +0000502 size_t current_offset = 0u;
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800503
504 if (kBinObjects) {
505 //
506 // Changing the bin of an object is purely a memory-use tuning.
507 // It has no change on runtime correctness.
508 //
509 // Memory analysis has determined that the following types of objects get dirtied
510 // the most:
511 //
Vladimir Marko20f85592015-03-19 10:07:02 +0000512 // * Dex cache arrays are stored in a special bin. The arrays for each dex cache have
513 // a fixed layout which helps improve generated code (using PC-relative addressing),
514 // so we pre-calculate their offsets separately in PrepareDexCacheArraySlots().
515 // Since these arrays are huge, most pages do not overlap other objects and it's not
516 // really important where they are for the clean/dirty separation. Due to their
Vladimir Marko05792b92015-08-03 11:56:49 +0100517 // special PC-relative addressing, we arbitrarily keep them at the end.
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800518 // * Class'es which are verified [their clinit runs only at runtime]
519 // - classes in general [because their static fields get overwritten]
520 // - initialized classes with all-final statics are unlikely to be ever dirty,
521 // so bin them separately
522 // * Art Methods that are:
523 // - native [their native entry point is not looked up until runtime]
524 // - have declaring classes that aren't initialized
525 // [their interpreter/quick entry points are trampolines until the class
526 // becomes initialized]
527 //
528 // We also assume the following objects get dirtied either never or extremely rarely:
529 // * Strings (they are immutable)
530 // * Art methods that aren't native and have initialized declared classes
531 //
532 // We assume that "regular" bin objects are highly unlikely to become dirtied,
533 // so packing them together will not result in a noticeably tighter dirty-to-clean ratio.
534 //
535 if (object->IsClass()) {
536 bin = kBinClassVerified;
537 mirror::Class* klass = object->AsClass();
538
Mathieu Chartiere401d142015-04-22 13:56:20 -0700539 // Add non-embedded vtable to the pointer array table if there is one.
540 auto* vtable = klass->GetVTable();
541 if (vtable != nullptr) {
542 AddMethodPointerArray(vtable);
543 }
544 auto* iftable = klass->GetIfTable();
545 if (iftable != nullptr) {
546 for (int32_t i = 0; i < klass->GetIfTableCount(); ++i) {
547 if (iftable->GetMethodArrayCount(i) > 0) {
548 AddMethodPointerArray(iftable->GetMethodArray(i));
549 }
550 }
551 }
552
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800553 if (klass->GetStatus() == Class::kStatusInitialized) {
554 bin = kBinClassInitialized;
555
556 // If the class's static fields are all final, put it into a separate bin
557 // since it's very likely it will stay clean.
558 uint32_t num_static_fields = klass->NumStaticFields();
559 if (num_static_fields == 0) {
560 bin = kBinClassInitializedFinalStatics;
561 } else {
562 // Maybe all the statics are final?
563 bool all_final = true;
564 for (uint32_t i = 0; i < num_static_fields; ++i) {
565 ArtField* field = klass->GetStaticField(i);
566 if (!field->IsFinal()) {
567 all_final = false;
568 break;
569 }
570 }
571
572 if (all_final) {
573 bin = kBinClassInitializedFinalStatics;
574 }
575 }
576 }
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800577 } else if (object->GetClass<kVerifyNone>()->IsStringClass()) {
578 bin = kBinString; // Strings are almost always immutable (except for object header).
579 } // else bin = kBinRegular
580 }
581
Vladimir Marko944da602016-02-19 12:27:55 +0000582 size_t oat_index = GetOatIndex(object);
583 ImageInfo& image_info = GetImageInfo(oat_index);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800584
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800585 size_t offset_delta = RoundUp(object_size, kObjectAlignment); // 64-bit alignment
Jeff Haodcdc85b2015-12-04 14:06:18 -0800586 current_offset = image_info.bin_slot_sizes_[bin]; // How many bytes the current bin is at (aligned).
587 // Move the current bin size up to accommodate the object we just assigned a bin slot.
588 image_info.bin_slot_sizes_[bin] += offset_delta;
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800589
590 BinSlot new_bin_slot(bin, current_offset);
591 SetImageBinSlot(object, new_bin_slot);
592
Jeff Haodcdc85b2015-12-04 14:06:18 -0800593 ++image_info.bin_slot_count_[bin];
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800594
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800595 // Grow the image closer to the end by the object we just assigned.
Jeff Haodcdc85b2015-12-04 14:06:18 -0800596 image_info.image_end_ += offset_delta;
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800597}
598
Mathieu Chartiere401d142015-04-22 13:56:20 -0700599bool ImageWriter::WillMethodBeDirty(ArtMethod* m) const {
600 if (m->IsNative()) {
601 return true;
602 }
603 mirror::Class* declaring_class = m->GetDeclaringClass();
604 // Initialized is highly unlikely to dirty since there's no entry points to mutate.
605 return declaring_class == nullptr || declaring_class->GetStatus() != Class::kStatusInitialized;
606}
607
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800608bool ImageWriter::IsImageBinSlotAssigned(mirror::Object* object) const {
609 DCHECK(object != nullptr);
610
611 // We always stash the bin slot into a lockword, in the 'forwarding address' state.
612 // If it's in some other state, then we haven't yet assigned an image bin slot.
613 if (object->GetLockWord(false).GetState() != LockWord::kForwardingAddress) {
614 return false;
615 } else if (kIsDebugBuild) {
616 LockWord lock_word = object->GetLockWord(false);
617 size_t offset = lock_word.ForwardingAddress();
618 BinSlot bin_slot(offset);
Vladimir Marko944da602016-02-19 12:27:55 +0000619 size_t oat_index = GetOatIndex(object);
620 const ImageInfo& image_info = GetImageInfo(oat_index);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800621 DCHECK_LT(bin_slot.GetIndex(), image_info.bin_slot_sizes_[bin_slot.GetBin()])
Mathieu Chartiera808bac2015-11-05 16:33:15 -0800622 << "bin slot offset should not exceed the size of that bin";
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800623 }
624 return true;
625}
626
627ImageWriter::BinSlot ImageWriter::GetImageBinSlot(mirror::Object* object) const {
628 DCHECK(object != nullptr);
629 DCHECK(IsImageBinSlotAssigned(object));
630
631 LockWord lock_word = object->GetLockWord(false);
632 size_t offset = lock_word.ForwardingAddress(); // TODO: ForwardingAddress should be uint32_t
633 DCHECK_LE(offset, std::numeric_limits<uint32_t>::max());
634
635 BinSlot bin_slot(static_cast<uint32_t>(offset));
Vladimir Marko944da602016-02-19 12:27:55 +0000636 size_t oat_index = GetOatIndex(object);
637 const ImageInfo& image_info = GetImageInfo(oat_index);
Jeff Haodcdc85b2015-12-04 14:06:18 -0800638 DCHECK_LT(bin_slot.GetIndex(), image_info.bin_slot_sizes_[bin_slot.GetBin()]);
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800639
640 return bin_slot;
641}
642
Brian Carlstrom7940e442013-07-12 13:46:57 -0700643bool ImageWriter::AllocMemory() {
Vladimir Marko944da602016-02-19 12:27:55 +0000644 for (ImageInfo& image_info : image_infos_) {
Mathieu Chartiera06ba052016-01-06 13:51:52 -0800645 ImageSection unused_sections[ImageHeader::kSectionCount];
646 const size_t length = RoundUp(
647 image_info.CreateImageSections(target_ptr_size_, unused_sections),
648 kPageSize);
649
Jeff Haodcdc85b2015-12-04 14:06:18 -0800650 std::string error_msg;
651 image_info.image_.reset(MemMap::MapAnonymous("image writer image",
652 nullptr,
653 length,
654 PROT_READ | PROT_WRITE,
655 false,
656 false,
657 &error_msg));
658 if (UNLIKELY(image_info.image_.get() == nullptr)) {
659 LOG(ERROR) << "Failed to allocate memory for image file generation: " << error_msg;
660 return false;
661 }
Mathieu Chartier590fee92013-09-13 13:46:47 -0700662
Jeff Haodcdc85b2015-12-04 14:06:18 -0800663 // Create the image bitmap, only needs to cover mirror object section which is up to image_end_.
664 CHECK_LE(image_info.image_end_, length);
665 image_info.image_bitmap_.reset(gc::accounting::ContinuousSpaceBitmap::Create(
666 "image bitmap", image_info.image_->Begin(), RoundUp(image_info.image_end_, kPageSize)));
667 if (image_info.image_bitmap_.get() == nullptr) {
668 LOG(ERROR) << "Failed to allocate memory for image bitmap";
669 return false;
670 }
Mathieu Chartier590fee92013-09-13 13:46:47 -0700671 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700672 return true;
673}
674
Mathieu Chartiere0671ce2015-07-28 17:23:28 -0700675class ComputeLazyFieldsForClassesVisitor : public ClassVisitor {
676 public:
Mathieu Chartier1aa8ec22016-02-01 10:34:47 -0800677 bool operator()(Class* c) OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartiere0671ce2015-07-28 17:23:28 -0700678 StackHandleScope<1> hs(Thread::Current());
679 mirror::Class::ComputeName(hs.NewHandle(c));
680 return true;
681 }
682};
683
Brian Carlstrom7940e442013-07-12 13:46:57 -0700684void ImageWriter::ComputeLazyFieldsForImageClasses() {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700685 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
Mathieu Chartiere0671ce2015-07-28 17:23:28 -0700686 ComputeLazyFieldsForClassesVisitor visitor;
687 class_linker->VisitClassesWithoutClassesLock(&visitor);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700688}
689
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800690static bool IsBootClassLoaderClass(mirror::Class* klass) SHARED_REQUIRES(Locks::mutator_lock_) {
691 return klass->GetClassLoader() == nullptr;
692}
693
694bool ImageWriter::IsBootClassLoaderNonImageClass(mirror::Class* klass) {
695 return IsBootClassLoaderClass(klass) && !IsInBootImage(klass);
696}
697
Mathieu Chartier901e0702016-02-19 13:42:48 -0800698bool ImageWriter::PruneAppImageClass(mirror::Class* klass) {
Mathieu Chartier945c1c12015-11-24 15:37:12 -0800699 bool early_exit = false;
700 std::unordered_set<mirror::Class*> visited;
Mathieu Chartier901e0702016-02-19 13:42:48 -0800701 return PruneAppImageClassInternal(klass, &early_exit, &visited);
Mathieu Chartier945c1c12015-11-24 15:37:12 -0800702}
703
Mathieu Chartier901e0702016-02-19 13:42:48 -0800704bool ImageWriter::PruneAppImageClassInternal(
Mathieu Chartier945c1c12015-11-24 15:37:12 -0800705 mirror::Class* klass,
706 bool* early_exit,
707 std::unordered_set<mirror::Class*>* visited) {
708 DCHECK(early_exit != nullptr);
709 DCHECK(visited != nullptr);
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800710 DCHECK(compile_app_image_);
Mathieu Chartier901e0702016-02-19 13:42:48 -0800711 if (klass == nullptr || IsInBootImage(klass)) {
Mathieu Chartiere401d142015-04-22 13:56:20 -0700712 return false;
713 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800714 auto found = prune_class_memo_.find(klass);
715 if (found != prune_class_memo_.end()) {
716 // Already computed, return the found value.
717 return found->second;
718 }
Mathieu Chartier945c1c12015-11-24 15:37:12 -0800719 // Circular dependencies, return false but do not store the result in the memoization table.
720 if (visited->find(klass) != visited->end()) {
721 *early_exit = true;
722 return false;
723 }
724 visited->emplace(klass);
Mathieu Chartier901e0702016-02-19 13:42:48 -0800725 bool result = IsBootClassLoaderClass(klass);
726 std::string temp;
727 // Prune if not an image class, this handles any broken sets of image classes such as having a
728 // class in the set but not it's superclass.
729 result = result || !compiler_driver_.IsImageClass(klass->GetDescriptor(&temp));
Mathieu Chartier945c1c12015-11-24 15:37:12 -0800730 bool my_early_exit = false; // Only for ourselves, ignore caller.
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800731 // Remove classes that failed to verify since we don't want to have java.lang.VerifyError in the
732 // app image.
733 if (klass->GetStatus() == mirror::Class::kStatusError) {
734 result = true;
735 } else {
736 CHECK(klass->GetVerifyError() == nullptr) << PrettyClass(klass);
737 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800738 if (!result) {
739 // Check interfaces since these wont be visited through VisitReferences.)
740 mirror::IfTable* if_table = klass->GetIfTable();
741 for (size_t i = 0, num_interfaces = klass->GetIfTableCount(); i < num_interfaces; ++i) {
Mathieu Chartier901e0702016-02-19 13:42:48 -0800742 result = result || PruneAppImageClassInternal(if_table->GetInterface(i),
743 &my_early_exit,
744 visited);
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800745 }
746 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800747 if (klass->IsObjectArrayClass()) {
Mathieu Chartier901e0702016-02-19 13:42:48 -0800748 result = result || PruneAppImageClassInternal(klass->GetComponentType(),
749 &my_early_exit,
750 visited);
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800751 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800752 // Check static fields and their classes.
753 size_t num_static_fields = klass->NumReferenceStaticFields();
754 if (num_static_fields != 0 && klass->IsResolved()) {
755 // Presumably GC can happen when we are cross compiling, it should not cause performance
756 // problems to do pointer size logic.
757 MemberOffset field_offset = klass->GetFirstReferenceStaticFieldOffset(
758 Runtime::Current()->GetClassLinker()->GetImagePointerSize());
759 for (size_t i = 0u; i < num_static_fields; ++i) {
760 mirror::Object* ref = klass->GetFieldObject<mirror::Object>(field_offset);
761 if (ref != nullptr) {
762 if (ref->IsClass()) {
Mathieu Chartier901e0702016-02-19 13:42:48 -0800763 result = result || PruneAppImageClassInternal(ref->AsClass(),
764 &my_early_exit,
765 visited);
766 } else {
767 result = result || PruneAppImageClassInternal(ref->GetClass(),
768 &my_early_exit,
769 visited);
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800770 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800771 }
772 field_offset = MemberOffset(field_offset.Uint32Value() +
773 sizeof(mirror::HeapReference<mirror::Object>));
774 }
775 }
Mathieu Chartier901e0702016-02-19 13:42:48 -0800776 result = result || PruneAppImageClassInternal(klass->GetSuperClass(),
777 &my_early_exit,
778 visited);
Mathieu Chartier945c1c12015-11-24 15:37:12 -0800779 // Erase the element we stored earlier since we are exiting the function.
780 auto it = visited->find(klass);
781 DCHECK(it != visited->end());
782 visited->erase(it);
783 // Only store result if it is true or none of the calls early exited due to circular
784 // dependencies. If visited is empty then we are the root caller, in this case the cycle was in
785 // a child call and we can remember the result.
786 if (result == true || !my_early_exit || visited->empty()) {
787 prune_class_memo_[klass] = result;
788 }
789 *early_exit |= my_early_exit;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800790 return result;
791}
792
793bool ImageWriter::KeepClass(Class* klass) {
794 if (klass == nullptr) {
795 return false;
796 }
Mathieu Chartier901e0702016-02-19 13:42:48 -0800797 if (compile_app_image_ && Runtime::Current()->GetHeap()->ObjectIsInBootImageSpace(klass)) {
798 // Already in boot image, return true.
799 return true;
800 }
801 std::string temp;
802 if (!compiler_driver_.IsImageClass(klass->GetDescriptor(&temp))) {
803 return false;
804 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800805 if (compile_app_image_) {
806 // For app images, we need to prune boot loader classes that are not in the boot image since
807 // these may have already been loaded when the app image is loaded.
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800808 // Keep classes in the boot image space since we don't want to re-resolve these.
Mathieu Chartier901e0702016-02-19 13:42:48 -0800809 return !PruneAppImageClass(klass);
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800810 }
Mathieu Chartier901e0702016-02-19 13:42:48 -0800811 return true;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700812}
813
Mathieu Chartiere0671ce2015-07-28 17:23:28 -0700814class NonImageClassesVisitor : public ClassVisitor {
815 public:
816 explicit NonImageClassesVisitor(ImageWriter* image_writer) : image_writer_(image_writer) {}
817
Mathieu Chartier1aa8ec22016-02-01 10:34:47 -0800818 bool operator()(Class* klass) OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800819 if (!image_writer_->KeepClass(klass)) {
820 classes_to_prune_.insert(klass);
Mathieu Chartiere0671ce2015-07-28 17:23:28 -0700821 }
822 return true;
823 }
824
Mathieu Chartier9b1c9b72016-02-02 10:09:58 -0800825 std::unordered_set<mirror::Class*> classes_to_prune_;
Mathieu Chartiere0671ce2015-07-28 17:23:28 -0700826 ImageWriter* const image_writer_;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700827};
828
829void ImageWriter::PruneNonImageClasses() {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700830 Runtime* runtime = Runtime::Current();
831 ClassLinker* class_linker = runtime->GetClassLinker();
Mathieu Chartiere401d142015-04-22 13:56:20 -0700832 Thread* self = Thread::Current();
Brian Carlstrom7940e442013-07-12 13:46:57 -0700833
834 // Make a list of classes we would like to prune.
Mathieu Chartiere0671ce2015-07-28 17:23:28 -0700835 NonImageClassesVisitor visitor(this);
836 class_linker->VisitClasses(&visitor);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700837
838 // Remove the undesired classes from the class roots.
Mathieu Chartier901e0702016-02-19 13:42:48 -0800839 VLOG(compiler) << "Pruning " << visitor.classes_to_prune_.size() << " classes";
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800840 for (mirror::Class* klass : visitor.classes_to_prune_) {
841 std::string temp;
842 const char* name = klass->GetDescriptor(&temp);
843 VLOG(compiler) << "Pruning class " << name;
844 if (!compile_app_image_) {
845 DCHECK(IsBootClassLoaderClass(klass));
846 }
847 bool result = class_linker->RemoveClass(name, klass->GetClassLoader());
Mathieu Chartierc2e20622014-11-03 11:41:47 -0800848 DCHECK(result);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700849 }
850
851 // Clear references to removed classes from the DexCaches.
Vladimir Marko05792b92015-08-03 11:56:49 +0100852 ArtMethod* resolution_method = runtime->GetResolutionMethod();
Mathieu Chartier673ed3d2015-08-28 14:56:43 -0700853
854 ScopedAssertNoThreadSuspension sa(self, __FUNCTION__);
855 ReaderMutexLock mu(self, *Locks::classlinker_classes_lock_); // For ClassInClassTable
856 ReaderMutexLock mu2(self, *class_linker->DexLock());
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -0800857 for (const ClassLinker::DexCacheData& data : class_linker->GetDexCachesData()) {
Mathieu Chartier901e0702016-02-19 13:42:48 -0800858 if (self->IsJWeakCleared(data.weak_root)) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -0700859 continue;
Mathieu Chartiere401d142015-04-22 13:56:20 -0700860 }
Mathieu Chartier901e0702016-02-19 13:42:48 -0800861 mirror::DexCache* dex_cache = self->DecodeJObject(data.weak_root)->AsDexCache();
Brian Carlstrom7940e442013-07-12 13:46:57 -0700862 for (size_t i = 0; i < dex_cache->NumResolvedTypes(); i++) {
863 Class* klass = dex_cache->GetResolvedType(i);
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800864 if (klass != nullptr && !KeepClass(klass)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700865 dex_cache->SetResolvedType(i, nullptr);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700866 }
867 }
Vladimir Marko05792b92015-08-03 11:56:49 +0100868 ArtMethod** resolved_methods = dex_cache->GetResolvedMethods();
869 for (size_t i = 0, num = dex_cache->NumResolvedMethods(); i != num; ++i) {
870 ArtMethod* method =
871 mirror::DexCache::GetElementPtrSize(resolved_methods, i, target_ptr_size_);
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800872 DCHECK(method != nullptr) << "Expected resolution method instead of null method";
873 mirror::Class* declaring_class = method->GetDeclaringClass();
Alex Lightfcea56f2016-02-17 11:59:05 -0800874 // Copied methods may be held live by a class which was not an image class but have a
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800875 // declaring class which is an image class. Set it to the resolution method to be safe and
876 // prevent dangling pointers.
Alex Light36121492016-02-22 13:43:29 -0800877 if (method->IsCopied() || !KeepClass(declaring_class)) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800878 mirror::DexCache::SetElementPtrSize(resolved_methods,
879 i,
880 resolution_method,
881 target_ptr_size_);
882 } else {
883 // Check that the class is still in the classes table.
884 DCHECK(class_linker->ClassInClassTable(declaring_class)) << "Class "
885 << PrettyClass(declaring_class) << " not in class linker table";
Brian Carlstrom7940e442013-07-12 13:46:57 -0700886 }
887 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800888 ArtField** resolved_fields = dex_cache->GetResolvedFields();
Brian Carlstrom7940e442013-07-12 13:46:57 -0700889 for (size_t i = 0; i < dex_cache->NumResolvedFields(); i++) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800890 ArtField* field = mirror::DexCache::GetElementPtrSize(resolved_fields, i, target_ptr_size_);
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800891 if (field != nullptr && !KeepClass(field->GetDeclaringClass())) {
Mathieu Chartiere401d142015-04-22 13:56:20 -0700892 dex_cache->SetResolvedField(i, nullptr, target_ptr_size_);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700893 }
894 }
Andreas Gampedd9d0552015-03-09 12:57:41 -0700895 // Clean the dex field. It might have been populated during the initialization phase, but
896 // contains data only valid during a real run.
897 dex_cache->SetFieldObject<false>(mirror::DexCache::DexOffset(), nullptr);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700898 }
Andreas Gampe8ac75952015-06-02 21:01:45 -0700899
900 // Drop the array class cache in the ClassLinker, as these are roots holding those classes live.
901 class_linker->DropFindArrayClassCache();
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800902
903 // Clear to save RAM.
904 prune_class_memo_.clear();
Brian Carlstrom7940e442013-07-12 13:46:57 -0700905}
906
Mathieu Chartierfd04b6f2014-11-14 19:34:18 -0800907void ImageWriter::CheckNonImageClassesRemoved() {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700908 if (compiler_driver_.GetImageClasses() != nullptr) {
909 gc::Heap* heap = Runtime::Current()->GetHeap();
Mathieu Chartier590fee92013-09-13 13:46:47 -0700910 heap->VisitObjects(CheckNonImageClassesRemovedCallback, this);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700911 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700912}
913
914void ImageWriter::CheckNonImageClassesRemovedCallback(Object* obj, void* arg) {
915 ImageWriter* image_writer = reinterpret_cast<ImageWriter*>(arg);
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800916 if (obj->IsClass() && !image_writer->IsInBootImage(obj)) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700917 Class* klass = obj->AsClass();
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800918 if (!image_writer->KeepClass(klass)) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700919 image_writer->DumpImageClasses();
Ian Rogers1ff3c982014-08-12 02:30:58 -0700920 std::string temp;
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800921 CHECK(image_writer->KeepClass(klass)) << klass->GetDescriptor(&temp)
922 << " " << PrettyDescriptor(klass);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700923 }
Brian Carlstrom7940e442013-07-12 13:46:57 -0700924 }
925}
926
927void ImageWriter::DumpImageClasses() {
Andreas Gampeb1fcead2015-04-20 18:53:51 -0700928 auto image_classes = compiler_driver_.GetImageClasses();
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700929 CHECK(image_classes != nullptr);
Mathieu Chartier02e25112013-08-14 16:14:24 -0700930 for (const std::string& image_class : *image_classes) {
931 LOG(INFO) << " " << image_class;
Brian Carlstrom7940e442013-07-12 13:46:57 -0700932 }
933}
934
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800935mirror::String* ImageWriter::FindInternedString(mirror::String* string) {
936 Thread* const self = Thread::Current();
Vladimir Marko944da602016-02-19 12:27:55 +0000937 for (const ImageInfo& image_info : image_infos_) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800938 mirror::String* const found = image_info.intern_table_->LookupStrong(self, string);
939 DCHECK(image_info.intern_table_->LookupWeak(self, string) == nullptr)
940 << string->ToModifiedUtf8();
941 if (found != nullptr) {
942 return found;
943 }
944 }
945 if (compile_app_image_) {
946 Runtime* const runtime = Runtime::Current();
947 mirror::String* found = runtime->GetInternTable()->LookupStrong(self, string);
948 // If we found it in the runtime intern table it could either be in the boot image or interned
949 // during app image compilation. If it was in the boot image return that, otherwise return null
950 // since it belongs to another image space.
951 if (found != nullptr && runtime->GetHeap()->ObjectIsInBootImageSpace(found)) {
952 return found;
953 }
954 DCHECK(runtime->GetInternTable()->LookupWeak(self, string) == nullptr)
955 << string->ToModifiedUtf8();
956 }
957 return nullptr;
958}
959
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800960void ImageWriter::CalculateObjectBinSlots(Object* obj) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700961 DCHECK(obj != nullptr);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700962 // if it is a string, we want to intern it if its not interned.
963 if (obj->GetClass()->IsStringClass()) {
Vladimir Marko944da602016-02-19 12:27:55 +0000964 size_t oat_index = GetOatIndex(obj);
965 ImageInfo& image_info = GetImageInfo(oat_index);
Mathieu Chartierea0831f2015-12-29 13:17:37 -0800966
Brian Carlstrom7940e442013-07-12 13:46:57 -0700967 // we must be an interned string that was forward referenced and already assigned
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800968 if (IsImageBinSlotAssigned(obj)) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800969 DCHECK_EQ(obj, FindInternedString(obj->AsString()));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700970 return;
971 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800972 // Need to check if the string is already interned in another image info so that we don't have
973 // the intern tables of two different images contain the same string.
974 mirror::String* interned = FindInternedString(obj->AsString());
975 if (interned == nullptr) {
976 // Not in another image space, insert to our table.
977 interned = image_info.intern_table_->InternStrongImageString(obj->AsString());
978 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700979 if (obj != interned) {
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800980 if (!IsImageBinSlotAssigned(interned)) {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700981 // interned obj is after us, allocate its location early
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800982 AssignImageBinSlot(interned);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700983 }
984 // point those looking for this object to the interned version.
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800985 SetImageBinSlot(obj, GetImageBinSlot(interned));
Brian Carlstrom7940e442013-07-12 13:46:57 -0700986 return;
987 }
988 // else (obj == interned), nothing to do but fall through to the normal case
989 }
990
Igor Murashkinf5b4c502014-11-14 15:01:59 -0800991 AssignImageBinSlot(obj);
Brian Carlstrom7940e442013-07-12 13:46:57 -0700992}
993
Vladimir Marko944da602016-02-19 12:27:55 +0000994ObjectArray<Object>* ImageWriter::CreateImageRoots(size_t oat_index) const {
Brian Carlstrom7940e442013-07-12 13:46:57 -0700995 Runtime* runtime = Runtime::Current();
996 ClassLinker* class_linker = runtime->GetClassLinker();
Brian Carlstrom7940e442013-07-12 13:46:57 -0700997 Thread* self = Thread::Current();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700998 StackHandleScope<3> hs(self);
999 Handle<Class> object_array_class(hs.NewHandle(
1000 class_linker->FindSystemClass(self, "[Ljava/lang/Object;")));
Brian Carlstrom7940e442013-07-12 13:46:57 -07001001
Jeff Haodcdc85b2015-12-04 14:06:18 -08001002 std::unordered_set<const DexFile*> image_dex_files;
Vladimir Marko944da602016-02-19 12:27:55 +00001003 for (auto& pair : dex_file_oat_index_map_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001004 const DexFile* image_dex_file = pair.first;
Vladimir Marko944da602016-02-19 12:27:55 +00001005 size_t image_oat_index = pair.second;
1006 if (oat_index == image_oat_index) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001007 image_dex_files.insert(image_dex_file);
1008 }
1009 }
1010
Hiroshi Yamauchie9e3e692014-06-24 14:31:37 -07001011 // build an Object[] of all the DexCaches used in the source_space_.
1012 // Since we can't hold the dex lock when allocating the dex_caches
1013 // ObjectArray, we lock the dex lock twice, first to get the number
1014 // of dex caches first and then lock it again to copy the dex
1015 // caches. We check that the number of dex caches does not change.
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001016 size_t dex_cache_count = 0;
Hiroshi Yamauchie9e3e692014-06-24 14:31:37 -07001017 {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001018 ReaderMutexLock mu(self, *class_linker->DexLock());
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001019 // Count number of dex caches not in the boot image.
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08001020 for (const ClassLinker::DexCacheData& data : class_linker->GetDexCachesData()) {
1021 mirror::DexCache* dex_cache =
1022 down_cast<mirror::DexCache*>(self->DecodeJObject(data.weak_root));
Jeff Haodcdc85b2015-12-04 14:06:18 -08001023 const DexFile* dex_file = dex_cache->GetDexFile();
1024 if (!IsInBootImage(dex_cache)) {
1025 dex_cache_count += image_dex_files.find(dex_file) != image_dex_files.end() ? 1u : 0u;
1026 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001027 }
Hiroshi Yamauchie9e3e692014-06-24 14:31:37 -07001028 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001029 Handle<ObjectArray<Object>> dex_caches(
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001030 hs.NewHandle(ObjectArray<Object>::Alloc(self, object_array_class.Get(), dex_cache_count)));
Hiroshi Yamauchie9e3e692014-06-24 14:31:37 -07001031 CHECK(dex_caches.Get() != nullptr) << "Failed to allocate a dex cache array.";
1032 {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001033 ReaderMutexLock mu(self, *class_linker->DexLock());
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001034 size_t non_image_dex_caches = 0;
1035 // Re-count number of non image dex caches.
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08001036 for (const ClassLinker::DexCacheData& data : class_linker->GetDexCachesData()) {
1037 mirror::DexCache* dex_cache =
1038 down_cast<mirror::DexCache*>(self->DecodeJObject(data.weak_root));
Jeff Haodcdc85b2015-12-04 14:06:18 -08001039 const DexFile* dex_file = dex_cache->GetDexFile();
1040 if (!IsInBootImage(dex_cache)) {
1041 non_image_dex_caches += image_dex_files.find(dex_file) != image_dex_files.end() ? 1u : 0u;
1042 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001043 }
1044 CHECK_EQ(dex_cache_count, non_image_dex_caches)
1045 << "The number of non-image dex caches changed.";
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001046 size_t i = 0;
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08001047 for (const ClassLinker::DexCacheData& data : class_linker->GetDexCachesData()) {
1048 mirror::DexCache* dex_cache =
1049 down_cast<mirror::DexCache*>(self->DecodeJObject(data.weak_root));
Jeff Haodcdc85b2015-12-04 14:06:18 -08001050 const DexFile* dex_file = dex_cache->GetDexFile();
1051 if (!IsInBootImage(dex_cache) && image_dex_files.find(dex_file) != image_dex_files.end()) {
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001052 dex_caches->Set<false>(i, dex_cache);
1053 ++i;
1054 }
Hiroshi Yamauchie9e3e692014-06-24 14:31:37 -07001055 }
Brian Carlstrom7940e442013-07-12 13:46:57 -07001056 }
1057
1058 // build an Object[] of the roots needed to restore the runtime
Mathieu Chartiere401d142015-04-22 13:56:20 -07001059 auto image_roots(hs.NewHandle(
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001060 ObjectArray<Object>::Alloc(self, object_array_class.Get(), ImageHeader::kImageRootsMax)));
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001061 image_roots->Set<false>(ImageHeader::kDexCaches, dex_caches.Get());
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001062 image_roots->Set<false>(ImageHeader::kClassRoots, class_linker->GetClassRoots());
Brian Carlstrom7940e442013-07-12 13:46:57 -07001063 for (int i = 0; i < ImageHeader::kImageRootsMax; i++) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001064 CHECK(image_roots->Get(i) != nullptr);
Brian Carlstrom7940e442013-07-12 13:46:57 -07001065 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001066 return image_roots.Get();
Brian Carlstrom7940e442013-07-12 13:46:57 -07001067}
1068
Mathieu Chartier590fee92013-09-13 13:46:47 -07001069// Walk instance fields of the given Class. Separate function to allow recursion on the super
1070// class.
1071void ImageWriter::WalkInstanceFields(mirror::Object* obj, mirror::Class* klass) {
1072 // Visit fields of parent classes first.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001073 StackHandleScope<1> hs(Thread::Current());
1074 Handle<mirror::Class> h_class(hs.NewHandle(klass));
1075 mirror::Class* super = h_class->GetSuperClass();
Mathieu Chartier590fee92013-09-13 13:46:47 -07001076 if (super != nullptr) {
1077 WalkInstanceFields(obj, super);
1078 }
1079 //
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001080 size_t num_reference_fields = h_class->NumReferenceInstanceFields();
Vladimir Marko76649e82014-11-10 18:32:59 +00001081 MemberOffset field_offset = h_class->GetFirstReferenceInstanceFieldOffset();
Mathieu Chartier590fee92013-09-13 13:46:47 -07001082 for (size_t i = 0; i < num_reference_fields; ++i) {
Ian Rogersb0fa5dc2014-04-28 16:47:08 -07001083 mirror::Object* value = obj->GetFieldObject<mirror::Object>(field_offset);
Mathieu Chartier590fee92013-09-13 13:46:47 -07001084 if (value != nullptr) {
1085 WalkFieldsInOrder(value);
1086 }
Vladimir Marko76649e82014-11-10 18:32:59 +00001087 field_offset = MemberOffset(field_offset.Uint32Value() +
1088 sizeof(mirror::HeapReference<mirror::Object>));
Mathieu Chartier590fee92013-09-13 13:46:47 -07001089 }
1090}
1091
1092// For an unvisited object, visit it then all its children found via fields.
1093void ImageWriter::WalkFieldsInOrder(mirror::Object* obj) {
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001094 if (IsInBootImage(obj)) {
1095 // Object is in the image, don't need to fix it up.
1096 return;
1097 }
Igor Murashkinf5b4c502014-11-14 15:01:59 -08001098 // Use our own visitor routine (instead of GC visitor) to get better locality between
1099 // an object and its fields
1100 if (!IsImageBinSlotAssigned(obj)) {
Mathieu Chartier590fee92013-09-13 13:46:47 -07001101 // Walk instance fields of all objects
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001102 StackHandleScope<2> hs(Thread::Current());
1103 Handle<mirror::Object> h_obj(hs.NewHandle(obj));
1104 Handle<mirror::Class> klass(hs.NewHandle(obj->GetClass()));
Mathieu Chartier590fee92013-09-13 13:46:47 -07001105 // visit the object itself.
Igor Murashkinf5b4c502014-11-14 15:01:59 -08001106 CalculateObjectBinSlots(h_obj.Get());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001107 WalkInstanceFields(h_obj.Get(), klass.Get());
Mathieu Chartier590fee92013-09-13 13:46:47 -07001108 // Walk static fields of a Class.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001109 if (h_obj->IsClass()) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001110 size_t num_reference_static_fields = klass->NumReferenceStaticFields();
Mathieu Chartiere401d142015-04-22 13:56:20 -07001111 MemberOffset field_offset = klass->GetFirstReferenceStaticFieldOffset(target_ptr_size_);
Mathieu Chartierc7853442015-03-27 14:35:38 -07001112 for (size_t i = 0; i < num_reference_static_fields; ++i) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001113 mirror::Object* value = h_obj->GetFieldObject<mirror::Object>(field_offset);
Mathieu Chartier590fee92013-09-13 13:46:47 -07001114 if (value != nullptr) {
1115 WalkFieldsInOrder(value);
1116 }
Vladimir Marko76649e82014-11-10 18:32:59 +00001117 field_offset = MemberOffset(field_offset.Uint32Value() +
1118 sizeof(mirror::HeapReference<mirror::Object>));
Mathieu Chartier590fee92013-09-13 13:46:47 -07001119 }
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001120 // Visit and assign offsets for fields and field arrays.
Mathieu Chartiere401d142015-04-22 13:56:20 -07001121 auto* as_klass = h_obj->AsClass();
Jeff Haodcdc85b2015-12-04 14:06:18 -08001122 mirror::DexCache* dex_cache = as_klass->GetDexCache();
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001123 DCHECK_NE(klass->GetStatus(), mirror::Class::kStatusError);
1124 if (compile_app_image_) {
1125 // Extra sanity, no boot loader classes should be left!
1126 CHECK(!IsBootClassLoaderClass(as_klass)) << PrettyClass(as_klass);
1127 }
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001128 LengthPrefixedArray<ArtField>* fields[] = {
1129 as_klass->GetSFieldsPtr(), as_klass->GetIFieldsPtr(),
1130 };
Vladimir Marko944da602016-02-19 12:27:55 +00001131 size_t oat_index = GetOatIndexForDexCache(dex_cache);
1132 ImageInfo& image_info = GetImageInfo(oat_index);
Mathieu Chartier1f47b672016-01-07 16:29:01 -08001133 {
1134 // Note: This table is only accessed from the image writer, so the lock is technically
1135 // unnecessary.
1136 WriterMutexLock mu(Thread::Current(), *Locks::classlinker_classes_lock_);
1137 // Insert in the class table for this iamge.
1138 image_info.class_table_->Insert(as_klass);
1139 }
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001140 for (LengthPrefixedArray<ArtField>* cur_fields : fields) {
1141 // Total array length including header.
1142 if (cur_fields != nullptr) {
1143 const size_t header_size = LengthPrefixedArray<ArtField>::ComputeSize(0);
1144 // Forward the entire array at once.
1145 auto it = native_object_relocations_.find(cur_fields);
1146 CHECK(it == native_object_relocations_.end()) << "Field array " << cur_fields
1147 << " already forwarded";
Jeff Haodcdc85b2015-12-04 14:06:18 -08001148 size_t& offset = image_info.bin_slot_sizes_[kBinArtField];
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001149 DCHECK(!IsInBootImage(cur_fields));
Vladimir Marko944da602016-02-19 12:27:55 +00001150 native_object_relocations_.emplace(
1151 cur_fields,
1152 NativeObjectRelocation {
1153 oat_index, offset, kNativeObjectRelocationTypeArtFieldArray
1154 });
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001155 offset += header_size;
1156 // Forward individual fields so that we can quickly find where they belong.
Vladimir Marko35831e82015-09-11 11:59:18 +01001157 for (size_t i = 0, count = cur_fields->size(); i < count; ++i) {
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001158 // Need to forward arrays separate of fields.
1159 ArtField* field = &cur_fields->At(i);
1160 auto it2 = native_object_relocations_.find(field);
1161 CHECK(it2 == native_object_relocations_.end()) << "Field at index=" << i
1162 << " already assigned " << PrettyField(field) << " static=" << field->IsStatic();
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001163 DCHECK(!IsInBootImage(field));
Vladimir Marko944da602016-02-19 12:27:55 +00001164 native_object_relocations_.emplace(
1165 field,
1166 NativeObjectRelocation { oat_index, offset, kNativeObjectRelocationTypeArtField });
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001167 offset += sizeof(ArtField);
1168 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07001169 }
1170 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07001171 // Visit and assign offsets for methods.
Alex Lighte64300b2015-12-15 15:02:47 -08001172 size_t num_methods = as_klass->NumMethods();
1173 if (num_methods != 0) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001174 bool any_dirty = false;
Alex Lighte64300b2015-12-15 15:02:47 -08001175 for (auto& m : as_klass->GetMethods(target_ptr_size_)) {
1176 if (WillMethodBeDirty(&m)) {
1177 any_dirty = true;
1178 break;
1179 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07001180 }
Mathieu Chartiera808bac2015-11-05 16:33:15 -08001181 NativeObjectRelocationType type = any_dirty
1182 ? kNativeObjectRelocationTypeArtMethodDirty
1183 : kNativeObjectRelocationTypeArtMethodClean;
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001184 Bin bin_type = BinTypeForNativeRelocationType(type);
1185 // Forward the entire array at once, but header first.
Alex Lighte64300b2015-12-15 15:02:47 -08001186 const size_t method_alignment = ArtMethod::Alignment(target_ptr_size_);
1187 const size_t method_size = ArtMethod::Size(target_ptr_size_);
Vladimir Markocf36d492015-08-12 19:27:26 +01001188 const size_t header_size = LengthPrefixedArray<ArtMethod>::ComputeSize(0,
1189 method_size,
1190 method_alignment);
Alex Lighte64300b2015-12-15 15:02:47 -08001191 LengthPrefixedArray<ArtMethod>* array = as_klass->GetMethodsPtr();
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001192 auto it = native_object_relocations_.find(array);
Alex Lighte64300b2015-12-15 15:02:47 -08001193 CHECK(it == native_object_relocations_.end())
1194 << "Method array " << array << " already forwarded";
Jeff Haodcdc85b2015-12-04 14:06:18 -08001195 size_t& offset = image_info.bin_slot_sizes_[bin_type];
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001196 DCHECK(!IsInBootImage(array));
Jeff Haodcdc85b2015-12-04 14:06:18 -08001197 native_object_relocations_.emplace(array,
1198 NativeObjectRelocation {
Vladimir Marko944da602016-02-19 12:27:55 +00001199 oat_index,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001200 offset,
1201 any_dirty ? kNativeObjectRelocationTypeArtMethodArrayDirty
1202 : kNativeObjectRelocationTypeArtMethodArrayClean });
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001203 offset += header_size;
Alex Lighte64300b2015-12-15 15:02:47 -08001204 for (auto& m : as_klass->GetMethods(target_ptr_size_)) {
Vladimir Marko944da602016-02-19 12:27:55 +00001205 AssignMethodOffset(&m, type, oat_index);
Mathieu Chartiere401d142015-04-22 13:56:20 -07001206 }
Alex Lighte64300b2015-12-15 15:02:47 -08001207 (any_dirty ? dirty_methods_ : clean_methods_) += num_methods;
Mathieu Chartiere401d142015-04-22 13:56:20 -07001208 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001209 } else if (h_obj->IsObjectArray()) {
Mathieu Chartier590fee92013-09-13 13:46:47 -07001210 // Walk elements of an object array.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001211 int32_t length = h_obj->AsObjectArray<mirror::Object>()->GetLength();
Mathieu Chartier590fee92013-09-13 13:46:47 -07001212 for (int32_t i = 0; i < length; i++) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001213 mirror::ObjectArray<mirror::Object>* obj_array = h_obj->AsObjectArray<mirror::Object>();
Mathieu Chartier590fee92013-09-13 13:46:47 -07001214 mirror::Object* value = obj_array->Get(i);
1215 if (value != nullptr) {
1216 WalkFieldsInOrder(value);
1217 }
1218 }
Mathieu Chartier208a5cb2015-12-02 15:44:07 -08001219 } else if (h_obj->IsClassLoader()) {
1220 // Register the class loader if it has a class table.
1221 // The fake boot class loader should not get registered and we should end up with only one
1222 // class loader.
1223 mirror::ClassLoader* class_loader = h_obj->AsClassLoader();
1224 if (class_loader->GetClassTable() != nullptr) {
1225 class_loaders_.insert(class_loader);
1226 }
Mathieu Chartier590fee92013-09-13 13:46:47 -07001227 }
1228 }
1229}
1230
Jeff Haodcdc85b2015-12-04 14:06:18 -08001231void ImageWriter::AssignMethodOffset(ArtMethod* method,
1232 NativeObjectRelocationType type,
Vladimir Marko944da602016-02-19 12:27:55 +00001233 size_t oat_index) {
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001234 DCHECK(!IsInBootImage(method));
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001235 auto it = native_object_relocations_.find(method);
1236 CHECK(it == native_object_relocations_.end()) << "Method " << method << " already assigned "
Mathieu Chartiere401d142015-04-22 13:56:20 -07001237 << PrettyMethod(method);
Vladimir Marko944da602016-02-19 12:27:55 +00001238 ImageInfo& image_info = GetImageInfo(oat_index);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001239 size_t& offset = image_info.bin_slot_sizes_[BinTypeForNativeRelocationType(type)];
Vladimir Marko944da602016-02-19 12:27:55 +00001240 native_object_relocations_.emplace(method, NativeObjectRelocation { oat_index, offset, type });
Vladimir Marko14632852015-08-17 12:07:23 +01001241 offset += ArtMethod::Size(target_ptr_size_);
Mathieu Chartiere401d142015-04-22 13:56:20 -07001242}
1243
Mathieu Chartier590fee92013-09-13 13:46:47 -07001244void ImageWriter::WalkFieldsCallback(mirror::Object* obj, void* arg) {
1245 ImageWriter* writer = reinterpret_cast<ImageWriter*>(arg);
1246 DCHECK(writer != nullptr);
1247 writer->WalkFieldsInOrder(obj);
1248}
1249
Igor Murashkinf5b4c502014-11-14 15:01:59 -08001250void ImageWriter::UnbinObjectsIntoOffsetCallback(mirror::Object* obj, void* arg) {
1251 ImageWriter* writer = reinterpret_cast<ImageWriter*>(arg);
1252 DCHECK(writer != nullptr);
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001253 if (!writer->IsInBootImage(obj)) {
1254 writer->UnbinObjectsIntoOffset(obj);
1255 }
Igor Murashkinf5b4c502014-11-14 15:01:59 -08001256}
1257
1258void ImageWriter::UnbinObjectsIntoOffset(mirror::Object* obj) {
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001259 DCHECK(!IsInBootImage(obj));
Igor Murashkinf5b4c502014-11-14 15:01:59 -08001260 CHECK(obj != nullptr);
1261
1262 // We know the bin slot, and the total bin sizes for all objects by now,
1263 // so calculate the object's final image offset.
1264
1265 DCHECK(IsImageBinSlotAssigned(obj));
1266 BinSlot bin_slot = GetImageBinSlot(obj);
1267 // Change the lockword from a bin slot into an offset
1268 AssignImageOffset(obj, bin_slot);
1269}
1270
Vladimir Markof4da6752014-08-01 19:04:18 +01001271void ImageWriter::CalculateNewObjectOffsets() {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001272 Thread* const self = Thread::Current();
Jeff Haodcdc85b2015-12-04 14:06:18 -08001273 StackHandleScopeCollection handles(self);
1274 std::vector<Handle<ObjectArray<Object>>> image_roots;
Vladimir Marko944da602016-02-19 12:27:55 +00001275 for (size_t i = 0, size = oat_filenames_.size(); i != size; ++i) {
1276 image_roots.push_back(handles.NewHandle(CreateImageRoots(i)));
Jeff Haodcdc85b2015-12-04 14:06:18 -08001277 }
Brian Carlstrom7940e442013-07-12 13:46:57 -07001278
Mathieu Chartiere401d142015-04-22 13:56:20 -07001279 auto* runtime = Runtime::Current();
1280 auto* heap = runtime->GetHeap();
Brian Carlstrom7940e442013-07-12 13:46:57 -07001281
Mathieu Chartier31e89252013-08-28 11:29:12 -07001282 // Leave space for the header, but do not write it yet, we need to
Brian Carlstrom7940e442013-07-12 13:46:57 -07001283 // know where image_roots is going to end up
Jeff Haodcdc85b2015-12-04 14:06:18 -08001284 image_objects_offset_begin_ = RoundUp(sizeof(ImageHeader), kObjectAlignment); // 64-bit-alignment
Brian Carlstrom7940e442013-07-12 13:46:57 -07001285
Hiroshi Yamauchi0c8c3032015-01-16 16:54:35 -08001286 // Clear any pre-existing monitors which may have been in the monitor words, assign bin slots.
1287 heap->VisitObjects(WalkFieldsCallback, this);
Mathieu Chartiere401d142015-04-22 13:56:20 -07001288 // Write the image runtime methods.
1289 image_methods_[ImageHeader::kResolutionMethod] = runtime->GetResolutionMethod();
1290 image_methods_[ImageHeader::kImtConflictMethod] = runtime->GetImtConflictMethod();
1291 image_methods_[ImageHeader::kImtUnimplementedMethod] = runtime->GetImtUnimplementedMethod();
1292 image_methods_[ImageHeader::kCalleeSaveMethod] = runtime->GetCalleeSaveMethod(Runtime::kSaveAll);
1293 image_methods_[ImageHeader::kRefsOnlySaveMethod] =
1294 runtime->GetCalleeSaveMethod(Runtime::kRefsOnly);
1295 image_methods_[ImageHeader::kRefsAndArgsSaveMethod] =
1296 runtime->GetCalleeSaveMethod(Runtime::kRefsAndArgs);
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001297
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001298 // Add room for fake length prefixed array for holding the image methods.
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001299 const auto image_method_type = kNativeObjectRelocationTypeArtMethodArrayClean;
1300 auto it = native_object_relocations_.find(&image_method_array_);
1301 CHECK(it == native_object_relocations_.end());
Vladimir Marko944da602016-02-19 12:27:55 +00001302 ImageInfo& default_image_info = GetImageInfo(GetDefaultOatIndex());
Jeff Haodcdc85b2015-12-04 14:06:18 -08001303 size_t& offset =
1304 default_image_info.bin_slot_sizes_[BinTypeForNativeRelocationType(image_method_type)];
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001305 if (!compile_app_image_) {
1306 native_object_relocations_.emplace(&image_method_array_,
Vladimir Marko944da602016-02-19 12:27:55 +00001307 NativeObjectRelocation { GetDefaultOatIndex(), offset, image_method_type });
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001308 }
Vladimir Marko14632852015-08-17 12:07:23 +01001309 size_t method_alignment = ArtMethod::Alignment(target_ptr_size_);
Mathieu Chartierc0fe56a2015-08-11 13:01:23 -07001310 const size_t array_size = LengthPrefixedArray<ArtMethod>::ComputeSize(
Vladimir Marko14632852015-08-17 12:07:23 +01001311 0, ArtMethod::Size(target_ptr_size_), method_alignment);
Vladimir Markocf36d492015-08-12 19:27:26 +01001312 CHECK_ALIGNED_PARAM(array_size, method_alignment);
Mathieu Chartierc0fe56a2015-08-11 13:01:23 -07001313 offset += array_size;
Mathieu Chartiere401d142015-04-22 13:56:20 -07001314 for (auto* m : image_methods_) {
1315 CHECK(m != nullptr);
1316 CHECK(m->IsRuntimeMethod());
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001317 DCHECK_EQ(compile_app_image_, IsInBootImage(m)) << "Trampolines should be in boot image";
1318 if (!IsInBootImage(m)) {
Vladimir Marko944da602016-02-19 12:27:55 +00001319 AssignMethodOffset(m, kNativeObjectRelocationTypeArtMethodClean, GetDefaultOatIndex());
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001320 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07001321 }
Vladimir Marko05792b92015-08-03 11:56:49 +01001322 // Calculate size of the dex cache arrays slot and prepare offsets.
1323 PrepareDexCacheArraySlots();
Mathieu Chartiere401d142015-04-22 13:56:20 -07001324
Mathieu Chartier1f47b672016-01-07 16:29:01 -08001325 // Calculate the sizes of the intern tables and class tables.
Vladimir Marko944da602016-02-19 12:27:55 +00001326 for (ImageInfo& image_info : image_infos_) {
Mathieu Chartierea0831f2015-12-29 13:17:37 -08001327 // Calculate how big the intern table will be after being serialized.
1328 InternTable* const intern_table = image_info.intern_table_.get();
1329 CHECK_EQ(intern_table->WeakSize(), 0u) << " should have strong interned all the strings";
1330 image_info.intern_table_bytes_ = intern_table->WriteToMemory(nullptr);
Mathieu Chartier1f47b672016-01-07 16:29:01 -08001331 // Calculate the size of the class table.
1332 ReaderMutexLock mu(self, *Locks::classlinker_classes_lock_);
1333 image_info.class_table_bytes_ += image_info.class_table_->WriteToMemory(nullptr);
Mathieu Chartierea0831f2015-12-29 13:17:37 -08001334 }
1335
Vladimir Markocf36d492015-08-12 19:27:26 +01001336 // Calculate bin slot offsets.
Vladimir Marko944da602016-02-19 12:27:55 +00001337 for (ImageInfo& image_info : image_infos_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001338 size_t bin_offset = image_objects_offset_begin_;
1339 for (size_t i = 0; i != kBinSize; ++i) {
1340 image_info.bin_slot_offsets_[i] = bin_offset;
1341 bin_offset += image_info.bin_slot_sizes_[i];
1342 if (i == kBinArtField) {
1343 static_assert(kBinArtField + 1 == kBinArtMethodClean, "Methods follow fields.");
1344 static_assert(alignof(ArtField) == 4u, "ArtField alignment is 4.");
1345 DCHECK_ALIGNED(bin_offset, 4u);
1346 DCHECK(method_alignment == 4u || method_alignment == 8u);
1347 bin_offset = RoundUp(bin_offset, method_alignment);
1348 }
Vladimir Markocf36d492015-08-12 19:27:26 +01001349 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001350 // NOTE: There may be additional padding between the bin slots and the intern table.
1351 DCHECK_EQ(image_info.image_end_,
1352 GetBinSizeSum(image_info, kBinMirrorCount) + image_objects_offset_begin_);
Vladimir Marko20f85592015-03-19 10:07:02 +00001353 }
Vladimir Markocf36d492015-08-12 19:27:26 +01001354
Jeff Haodcdc85b2015-12-04 14:06:18 -08001355 // Calculate image offsets.
1356 size_t image_offset = 0;
Vladimir Marko944da602016-02-19 12:27:55 +00001357 for (ImageInfo& image_info : image_infos_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001358 image_info.image_begin_ = global_image_begin_ + image_offset;
1359 image_info.image_offset_ = image_offset;
Mathieu Chartiera06ba052016-01-06 13:51:52 -08001360 ImageSection unused_sections[ImageHeader::kSectionCount];
1361 image_info.image_size_ = RoundUp(
1362 image_info.CreateImageSections(target_ptr_size_, unused_sections),
1363 kPageSize);
1364 // There should be no gaps until the next image.
Jeff Haodcdc85b2015-12-04 14:06:18 -08001365 image_offset += image_info.image_size_;
1366 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07001367
Hiroshi Yamauchi0c8c3032015-01-16 16:54:35 -08001368 // Transform each object's bin slot into an offset which will be used to do the final copy.
1369 heap->VisitObjects(UnbinObjectsIntoOffsetCallback, this);
Brian Carlstrom7940e442013-07-12 13:46:57 -07001370
Jeff Haodcdc85b2015-12-04 14:06:18 -08001371 // DCHECK_EQ(image_end_, GetBinSizeSum(kBinMirrorCount) + image_objects_offset_begin_);
Igor Murashkinf5b4c502014-11-14 15:01:59 -08001372
Jeff Haodcdc85b2015-12-04 14:06:18 -08001373 size_t i = 0;
Vladimir Marko944da602016-02-19 12:27:55 +00001374 for (ImageInfo& image_info : image_infos_) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001375 image_info.image_roots_address_ = PointerToLowMemUInt32(GetImageAddress(image_roots[i].Get()));
1376 i++;
1377 }
Vladimir Markof4da6752014-08-01 19:04:18 +01001378
Mathieu Chartiere401d142015-04-22 13:56:20 -07001379 // Update the native relocations by adding their bin sums.
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001380 for (auto& pair : native_object_relocations_) {
1381 NativeObjectRelocation& relocation = pair.second;
1382 Bin bin_type = BinTypeForNativeRelocationType(relocation.type);
Vladimir Marko944da602016-02-19 12:27:55 +00001383 ImageInfo& image_info = GetImageInfo(relocation.oat_index);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001384 relocation.offset += image_info.bin_slot_offsets_[bin_type];
Mathieu Chartiere401d142015-04-22 13:56:20 -07001385 }
1386
Jeff Haodcdc85b2015-12-04 14:06:18 -08001387 // Note that image_info.image_end_ is left at end of used mirror object section.
Vladimir Markof4da6752014-08-01 19:04:18 +01001388}
1389
Mathieu Chartiera06ba052016-01-06 13:51:52 -08001390size_t ImageWriter::ImageInfo::CreateImageSections(size_t target_ptr_size,
1391 ImageSection* out_sections) const {
1392 DCHECK(out_sections != nullptr);
1393 // Objects section
1394 auto* objects_section = &out_sections[ImageHeader::kSectionObjects];
1395 *objects_section = ImageSection(0u, image_end_);
1396 size_t cur_pos = objects_section->End();
1397 // Add field section.
1398 auto* field_section = &out_sections[ImageHeader::kSectionArtFields];
1399 *field_section = ImageSection(cur_pos, bin_slot_sizes_[kBinArtField]);
1400 CHECK_EQ(bin_slot_offsets_[kBinArtField], field_section->Offset());
1401 cur_pos = field_section->End();
1402 // Round up to the alignment the required by the method section.
1403 cur_pos = RoundUp(cur_pos, ArtMethod::Alignment(target_ptr_size));
1404 // Add method section.
1405 auto* methods_section = &out_sections[ImageHeader::kSectionArtMethods];
1406 *methods_section = ImageSection(cur_pos,
1407 bin_slot_sizes_[kBinArtMethodClean] +
1408 bin_slot_sizes_[kBinArtMethodDirty]);
1409 CHECK_EQ(bin_slot_offsets_[kBinArtMethodClean], methods_section->Offset());
1410 cur_pos = methods_section->End();
1411 // Add dex cache arrays section.
1412 auto* dex_cache_arrays_section = &out_sections[ImageHeader::kSectionDexCacheArrays];
1413 *dex_cache_arrays_section = ImageSection(cur_pos, bin_slot_sizes_[kBinDexCacheArray]);
1414 CHECK_EQ(bin_slot_offsets_[kBinDexCacheArray], dex_cache_arrays_section->Offset());
1415 cur_pos = dex_cache_arrays_section->End();
1416 // Round up to the alignment the string table expects. See HashSet::WriteToMemory.
1417 cur_pos = RoundUp(cur_pos, sizeof(uint64_t));
1418 // Calculate the size of the interned strings.
1419 auto* interned_strings_section = &out_sections[ImageHeader::kSectionInternedStrings];
1420 *interned_strings_section = ImageSection(cur_pos, intern_table_bytes_);
1421 cur_pos = interned_strings_section->End();
1422 // Round up to the alignment the class table expects. See HashSet::WriteToMemory.
1423 cur_pos = RoundUp(cur_pos, sizeof(uint64_t));
1424 // Calculate the size of the class table section.
1425 auto* class_table_section = &out_sections[ImageHeader::kSectionClassTable];
Mathieu Chartier1f47b672016-01-07 16:29:01 -08001426 *class_table_section = ImageSection(cur_pos, class_table_bytes_);
Mathieu Chartiera06ba052016-01-06 13:51:52 -08001427 cur_pos = class_table_section->End();
1428 // Image end goes right before the start of the image bitmap.
1429 return cur_pos;
1430}
1431
Vladimir Marko944da602016-02-19 12:27:55 +00001432void ImageWriter::CreateHeader(size_t oat_index) {
1433 ImageInfo& image_info = GetImageInfo(oat_index);
1434 const uint8_t* oat_file_begin = image_info.oat_file_begin_;
1435 const uint8_t* oat_file_end = oat_file_begin + image_info.oat_loaded_size_;
1436 const uint8_t* oat_data_end = image_info.oat_data_begin_ + image_info.oat_size_;
Mathieu Chartiere401d142015-04-22 13:56:20 -07001437
1438 // Create the image sections.
1439 ImageSection sections[ImageHeader::kSectionCount];
Mathieu Chartiera06ba052016-01-06 13:51:52 -08001440 const size_t image_end = image_info.CreateImageSections(target_ptr_size_, sections);
1441
Mathieu Chartiere401d142015-04-22 13:56:20 -07001442 // Finally bitmap section.
Jeff Haodcdc85b2015-12-04 14:06:18 -08001443 const size_t bitmap_bytes = image_info.image_bitmap_->Size();
Mathieu Chartiere401d142015-04-22 13:56:20 -07001444 auto* bitmap_section = &sections[ImageHeader::kSectionImageBitmap];
Mathieu Chartiera06ba052016-01-06 13:51:52 -08001445 *bitmap_section = ImageSection(RoundUp(image_end, kPageSize), RoundUp(bitmap_bytes, kPageSize));
Jeff Haodcdc85b2015-12-04 14:06:18 -08001446 if (VLOG_IS_ON(compiler)) {
Vladimir Marko944da602016-02-19 12:27:55 +00001447 LOG(INFO) << "Creating header for " << oat_filenames_[oat_index];
Mathieu Chartiere401d142015-04-22 13:56:20 -07001448 size_t idx = 0;
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001449 for (const ImageSection& section : sections) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001450 LOG(INFO) << static_cast<ImageHeader::ImageSections>(idx) << " " << section;
1451 ++idx;
1452 }
1453 LOG(INFO) << "Methods: clean=" << clean_methods_ << " dirty=" << dirty_methods_;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001454 LOG(INFO) << "Image roots address=" << std::hex << image_info.image_roots_address_ << std::dec;
1455 LOG(INFO) << "Image begin=" << std::hex << reinterpret_cast<uintptr_t>(global_image_begin_)
1456 << " Image offset=" << image_info.image_offset_ << std::dec;
1457 LOG(INFO) << "Oat file begin=" << std::hex << reinterpret_cast<uintptr_t>(oat_file_begin)
1458 << " Oat data begin=" << reinterpret_cast<uintptr_t>(image_info.oat_data_begin_)
1459 << " Oat data end=" << reinterpret_cast<uintptr_t>(oat_data_end)
1460 << " Oat file end=" << reinterpret_cast<uintptr_t>(oat_file_end);
Mathieu Chartiere401d142015-04-22 13:56:20 -07001461 }
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001462 // Store boot image info for app image so that we can relocate.
1463 uint32_t boot_image_begin = 0;
1464 uint32_t boot_image_end = 0;
1465 uint32_t boot_oat_begin = 0;
1466 uint32_t boot_oat_end = 0;
1467 gc::Heap* const heap = Runtime::Current()->GetHeap();
1468 heap->GetBootImagesSize(&boot_image_begin, &boot_image_end, &boot_oat_begin, &boot_oat_end);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001469
Mathieu Chartierceb07b32015-12-10 09:33:21 -08001470 // Create the header, leave 0 for data size since we will fill this in as we are writing the
1471 // image.
Jeff Haodcdc85b2015-12-04 14:06:18 -08001472 new (image_info.image_->Begin()) ImageHeader(PointerToLowMemUInt32(image_info.image_begin_),
1473 image_end,
1474 sections,
1475 image_info.image_roots_address_,
Vladimir Marko944da602016-02-19 12:27:55 +00001476 image_info.oat_checksum_,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001477 PointerToLowMemUInt32(oat_file_begin),
1478 PointerToLowMemUInt32(image_info.oat_data_begin_),
1479 PointerToLowMemUInt32(oat_data_end),
1480 PointerToLowMemUInt32(oat_file_end),
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001481 boot_image_begin,
1482 boot_image_end - boot_image_begin,
1483 boot_oat_begin,
1484 boot_oat_end - boot_oat_begin,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001485 target_ptr_size_,
1486 compile_pic_,
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001487 /*is_pic*/compile_app_image_,
Jeff Haodcdc85b2015-12-04 14:06:18 -08001488 image_storage_mode_,
1489 /*data_size*/0u);
Mathieu Chartiere401d142015-04-22 13:56:20 -07001490}
1491
1492ArtMethod* ImageWriter::GetImageMethodAddress(ArtMethod* method) {
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001493 auto it = native_object_relocations_.find(method);
1494 CHECK(it != native_object_relocations_.end()) << PrettyMethod(method) << " @ " << method;
Vladimir Marko944da602016-02-19 12:27:55 +00001495 size_t oat_index = GetOatIndex(method->GetDexCache());
1496 ImageInfo& image_info = GetImageInfo(oat_index);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001497 CHECK_GE(it->second.offset, image_info.image_end_) << "ArtMethods should be after Objects";
1498 return reinterpret_cast<ArtMethod*>(image_info.image_begin_ + it->second.offset);
Brian Carlstrom7940e442013-07-12 13:46:57 -07001499}
1500
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001501class FixupRootVisitor : public RootVisitor {
1502 public:
1503 explicit FixupRootVisitor(ImageWriter* image_writer) : image_writer_(image_writer) {
1504 }
1505
1506 void VisitRoots(mirror::Object*** roots, size_t count, const RootInfo& info ATTRIBUTE_UNUSED)
Mathieu Chartier90443472015-07-16 20:32:27 -07001507 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001508 for (size_t i = 0; i < count; ++i) {
Mathieu Chartierea0831f2015-12-29 13:17:37 -08001509 *roots[i] = image_writer_->GetImageAddress(*roots[i]);
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001510 }
1511 }
1512
1513 void VisitRoots(mirror::CompressedReference<mirror::Object>** roots, size_t count,
1514 const RootInfo& info ATTRIBUTE_UNUSED)
Mathieu Chartier90443472015-07-16 20:32:27 -07001515 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001516 for (size_t i = 0; i < count; ++i) {
Mathieu Chartierea0831f2015-12-29 13:17:37 -08001517 roots[i]->Assign(image_writer_->GetImageAddress(roots[i]->AsMirrorPtr()));
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001518 }
1519 }
1520
1521 private:
1522 ImageWriter* const image_writer_;
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001523};
1524
Vladimir Marko944da602016-02-19 12:27:55 +00001525void ImageWriter::CopyAndFixupNativeData(size_t oat_index) {
1526 ImageInfo& image_info = GetImageInfo(oat_index);
Mathieu Chartiere401d142015-04-22 13:56:20 -07001527 // Copy ArtFields and methods to their locations and update the array for convenience.
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001528 for (auto& pair : native_object_relocations_) {
1529 NativeObjectRelocation& relocation = pair.second;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001530 // Only work with fields and methods that are in the current oat file.
Vladimir Marko944da602016-02-19 12:27:55 +00001531 if (relocation.oat_index != oat_index) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001532 continue;
1533 }
1534 auto* dest = image_info.image_->Begin() + relocation.offset;
1535 DCHECK_GE(dest, image_info.image_->Begin() + image_info.image_end_);
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001536 DCHECK(!IsInBootImage(pair.first));
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001537 switch (relocation.type) {
1538 case kNativeObjectRelocationTypeArtField: {
1539 memcpy(dest, pair.first, sizeof(ArtField));
1540 reinterpret_cast<ArtField*>(dest)->SetDeclaringClass(
1541 GetImageAddress(reinterpret_cast<ArtField*>(pair.first)->GetDeclaringClass()));
1542 break;
1543 }
1544 case kNativeObjectRelocationTypeArtMethodClean:
1545 case kNativeObjectRelocationTypeArtMethodDirty: {
1546 CopyAndFixupMethod(reinterpret_cast<ArtMethod*>(pair.first),
Jeff Haodcdc85b2015-12-04 14:06:18 -08001547 reinterpret_cast<ArtMethod*>(dest),
1548 image_info);
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001549 break;
1550 }
1551 // For arrays, copy just the header since the elements will get copied by their corresponding
1552 // relocations.
1553 case kNativeObjectRelocationTypeArtFieldArray: {
1554 memcpy(dest, pair.first, LengthPrefixedArray<ArtField>::ComputeSize(0));
1555 break;
1556 }
1557 case kNativeObjectRelocationTypeArtMethodArrayClean:
1558 case kNativeObjectRelocationTypeArtMethodArrayDirty: {
Vladimir Markod9813cb2016-03-15 12:41:27 +00001559 size_t size = ArtMethod::Size(target_ptr_size_);
1560 size_t alignment = ArtMethod::Alignment(target_ptr_size_);
1561 memcpy(dest, pair.first, LengthPrefixedArray<ArtMethod>::ComputeSize(0, size, alignment));
1562 // Clear padding to avoid non-deterministic data in the image (and placate valgrind).
1563 reinterpret_cast<LengthPrefixedArray<ArtMethod>*>(dest)->ClearPadding(size, alignment);
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001564 break;
Vladimir Markod9813cb2016-03-15 12:41:27 +00001565 }
Vladimir Marko05792b92015-08-03 11:56:49 +01001566 case kNativeObjectRelocationTypeDexCacheArray:
1567 // Nothing to copy here, everything is done in FixupDexCache().
1568 break;
Mathieu Chartiere401d142015-04-22 13:56:20 -07001569 }
1570 }
1571 // Fixup the image method roots.
Jeff Haodcdc85b2015-12-04 14:06:18 -08001572 auto* image_header = reinterpret_cast<ImageHeader*>(image_info.image_->Begin());
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001573 const ImageSection& methods_section = image_header->GetMethodsSection();
Mathieu Chartiere401d142015-04-22 13:56:20 -07001574 for (size_t i = 0; i < ImageHeader::kImageMethodsCount; ++i) {
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001575 ArtMethod* method = image_methods_[i];
1576 CHECK(method != nullptr);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001577 // Only place runtime methods in the image of the default oat file.
Vladimir Marko944da602016-02-19 12:27:55 +00001578 if (method->IsRuntimeMethod() && oat_index != GetDefaultOatIndex()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001579 continue;
1580 }
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001581 if (!IsInBootImage(method)) {
1582 auto it = native_object_relocations_.find(method);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001583 CHECK(it != native_object_relocations_.end()) << "No forwarding for " << PrettyMethod(method);
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001584 NativeObjectRelocation& relocation = it->second;
1585 CHECK(methods_section.Contains(relocation.offset)) << relocation.offset << " not in "
1586 << methods_section;
1587 CHECK(relocation.IsArtMethodRelocation()) << relocation.type;
Jeff Haodcdc85b2015-12-04 14:06:18 -08001588 method = reinterpret_cast<ArtMethod*>(global_image_begin_ + it->second.offset);
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001589 }
1590 image_header->SetImageMethod(static_cast<ImageHeader::ImageMethod>(i), method);
Mathieu Chartierc7853442015-03-27 14:35:38 -07001591 }
Mathieu Chartier208a5cb2015-12-02 15:44:07 -08001592 FixupRootVisitor root_visitor(this);
1593
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001594 // Write the intern table into the image.
Mathieu Chartierea0831f2015-12-29 13:17:37 -08001595 if (image_info.intern_table_bytes_ > 0) {
1596 const ImageSection& intern_table_section = image_header->GetImageSection(
1597 ImageHeader::kSectionInternedStrings);
1598 InternTable* const intern_table = image_info.intern_table_.get();
1599 uint8_t* const intern_table_memory_ptr =
1600 image_info.image_->Begin() + intern_table_section.Offset();
1601 const size_t intern_table_bytes = intern_table->WriteToMemory(intern_table_memory_ptr);
1602 CHECK_EQ(intern_table_bytes, image_info.intern_table_bytes_);
1603 // Fixup the pointers in the newly written intern table to contain image addresses.
1604 InternTable temp_intern_table;
1605 // Note that we require that ReadFromMemory does not make an internal copy of the elements so that
1606 // the VisitRoots() will update the memory directly rather than the copies.
1607 // This also relies on visit roots not doing any verification which could fail after we update
1608 // the roots to be the image addresses.
1609 temp_intern_table.AddTableFromMemory(intern_table_memory_ptr);
1610 CHECK_EQ(temp_intern_table.Size(), intern_table->Size());
1611 temp_intern_table.VisitRoots(&root_visitor, kVisitRootFlagAllRoots);
1612 }
Mathieu Chartier67ad20e2015-12-09 15:41:09 -08001613 // Write the class table(s) into the image. class_table_bytes_ may be 0 if there are multiple
1614 // class loaders. Writing multiple class tables into the image is currently unsupported.
Mathieu Chartier1f47b672016-01-07 16:29:01 -08001615 if (image_info.class_table_bytes_ > 0u) {
Mathieu Chartier67ad20e2015-12-09 15:41:09 -08001616 const ImageSection& class_table_section = image_header->GetImageSection(
1617 ImageHeader::kSectionClassTable);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001618 uint8_t* const class_table_memory_ptr =
1619 image_info.image_->Begin() + class_table_section.Offset();
Mathieu Chartier67ad20e2015-12-09 15:41:09 -08001620 ReaderMutexLock mu(Thread::Current(), *Locks::classlinker_classes_lock_);
Mathieu Chartier1f47b672016-01-07 16:29:01 -08001621
1622 ClassTable* table = image_info.class_table_.get();
1623 CHECK(table != nullptr);
1624 const size_t class_table_bytes = table->WriteToMemory(class_table_memory_ptr);
1625 CHECK_EQ(class_table_bytes, image_info.class_table_bytes_);
1626 // Fixup the pointers in the newly written class table to contain image addresses. See
1627 // above comment for intern tables.
1628 ClassTable temp_class_table;
1629 temp_class_table.ReadFromMemory(class_table_memory_ptr);
1630 CHECK_EQ(temp_class_table.NumZygoteClasses(), table->NumNonZygoteClasses() +
1631 table->NumZygoteClasses());
1632 BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(&root_visitor,
1633 RootInfo(kRootUnknown));
1634 temp_class_table.VisitRoots(buffered_visitor);
Mathieu Chartier208a5cb2015-12-02 15:44:07 -08001635 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07001636}
1637
Mathieu Chartierfd04b6f2014-11-14 19:34:18 -08001638void ImageWriter::CopyAndFixupObjects() {
Brian Carlstrom7940e442013-07-12 13:46:57 -07001639 gc::Heap* heap = Runtime::Current()->GetHeap();
Mathieu Chartier590fee92013-09-13 13:46:47 -07001640 heap->VisitObjects(CopyAndFixupObjectsCallback, this);
1641 // Fix up the object previously had hash codes.
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001642 for (const auto& hash_pair : saved_hashcode_map_) {
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -08001643 Object* obj = hash_pair.first;
Andreas Gampe3b45ef22015-05-26 21:34:09 -07001644 DCHECK_EQ(obj->GetLockWord<kVerifyNone>(false).ReadBarrierState(), 0U);
1645 obj->SetLockWord<kVerifyNone>(LockWord::FromHashCode(hash_pair.second, 0U), false);
Mathieu Chartier590fee92013-09-13 13:46:47 -07001646 }
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001647 saved_hashcode_map_.clear();
Brian Carlstrom7940e442013-07-12 13:46:57 -07001648}
1649
Mathieu Chartier590fee92013-09-13 13:46:47 -07001650void ImageWriter::CopyAndFixupObjectsCallback(Object* obj, void* arg) {
Mathieu Chartier4d7f61d2014-04-17 14:43:39 -07001651 DCHECK(obj != nullptr);
1652 DCHECK(arg != nullptr);
Mathieu Chartierc7853442015-03-27 14:35:38 -07001653 reinterpret_cast<ImageWriter*>(arg)->CopyAndFixupObject(obj);
1654}
1655
Mathieu Chartiere401d142015-04-22 13:56:20 -07001656void ImageWriter::FixupPointerArray(mirror::Object* dst, mirror::PointerArray* arr,
1657 mirror::Class* klass, Bin array_type) {
1658 CHECK(klass->IsArrayClass());
1659 CHECK(arr->IsIntArray() || arr->IsLongArray()) << PrettyClass(klass) << " " << arr;
1660 // Fixup int and long pointers for the ArtMethod or ArtField arrays.
Mathieu Chartierc7853442015-03-27 14:35:38 -07001661 const size_t num_elements = arr->GetLength();
Mathieu Chartiere401d142015-04-22 13:56:20 -07001662 dst->SetClass(GetImageAddress(arr->GetClass()));
1663 auto* dest_array = down_cast<mirror::PointerArray*>(dst);
Mathieu Chartierc7853442015-03-27 14:35:38 -07001664 for (size_t i = 0, count = num_elements; i < count; ++i) {
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001665 void* elem = arr->GetElementPtrSize<void*>(i, target_ptr_size_);
1666 if (elem != nullptr && !IsInBootImage(elem)) {
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001667 auto it = native_object_relocations_.find(elem);
Vladimir Marko05792b92015-08-03 11:56:49 +01001668 if (UNLIKELY(it == native_object_relocations_.end())) {
Mathieu Chartierc0fe56a2015-08-11 13:01:23 -07001669 if (it->second.IsArtMethodRelocation()) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001670 auto* method = reinterpret_cast<ArtMethod*>(elem);
1671 LOG(FATAL) << "No relocation entry for ArtMethod " << PrettyMethod(method) << " @ "
1672 << method << " idx=" << i << "/" << num_elements << " with declaring class "
1673 << PrettyClass(method->GetDeclaringClass());
1674 } else {
1675 CHECK_EQ(array_type, kBinArtField);
1676 auto* field = reinterpret_cast<ArtField*>(elem);
1677 LOG(FATAL) << "No relocation entry for ArtField " << PrettyField(field) << " @ "
1678 << field << " idx=" << i << "/" << num_elements << " with declaring class "
1679 << PrettyClass(field->GetDeclaringClass());
1680 }
Vladimir Marko05792b92015-08-03 11:56:49 +01001681 UNREACHABLE();
Mathieu Chartiere401d142015-04-22 13:56:20 -07001682 } else {
Vladimir Marko944da602016-02-19 12:27:55 +00001683 ImageInfo& image_info = GetImageInfo(it->second.oat_index);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001684 elem = image_info.image_begin_ + it->second.offset;
Mathieu Chartiere401d142015-04-22 13:56:20 -07001685 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07001686 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07001687 dest_array->SetElementPtrSize<false, true>(i, elem, target_ptr_size_);
Mathieu Chartierc7853442015-03-27 14:35:38 -07001688 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07001689}
1690
1691void ImageWriter::CopyAndFixupObject(Object* obj) {
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001692 if (IsInBootImage(obj)) {
1693 return;
1694 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07001695 size_t offset = GetImageOffset(obj);
Vladimir Marko944da602016-02-19 12:27:55 +00001696 size_t oat_index = GetOatIndex(obj);
1697 ImageInfo& image_info = GetImageInfo(oat_index);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001698 auto* dst = reinterpret_cast<Object*>(image_info.image_->Begin() + offset);
1699 DCHECK_LT(offset, image_info.image_end_);
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001700 const auto* src = reinterpret_cast<const uint8_t*>(obj);
Mathieu Chartierc7853442015-03-27 14:35:38 -07001701
Jeff Haodcdc85b2015-12-04 14:06:18 -08001702 image_info.image_bitmap_->Set(dst); // Mark the obj as live.
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001703
1704 const size_t n = obj->SizeOf();
Jeff Haodcdc85b2015-12-04 14:06:18 -08001705 DCHECK_LE(offset + n, image_info.image_->Size());
Brian Carlstrom7940e442013-07-12 13:46:57 -07001706 memcpy(dst, src, n);
Mathieu Chartierc7853442015-03-27 14:35:38 -07001707
Mathieu Chartierad2541a2013-10-25 10:05:23 -07001708 // Write in a hash code of objects which have inflated monitors or a hash code in their monitor
1709 // word.
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001710 const auto it = saved_hashcode_map_.find(obj);
1711 dst->SetLockWord(it != saved_hashcode_map_.end() ?
1712 LockWord::FromHashCode(it->second, 0u) : LockWord::Default(), false);
Mathieu Chartierc7853442015-03-27 14:35:38 -07001713 FixupObject(obj, dst);
Brian Carlstrom7940e442013-07-12 13:46:57 -07001714}
1715
Igor Murashkinf5b4c502014-11-14 15:01:59 -08001716// Rewrite all the references in the copied object to point to their image address equivalent
Mathieu Chartierb7ea3ac2014-03-24 16:54:46 -07001717class FixupVisitor {
1718 public:
1719 FixupVisitor(ImageWriter* image_writer, Object* copy) : image_writer_(image_writer), copy_(copy) {
1720 }
1721
Mathieu Chartierda7c6502015-07-23 16:01:26 -07001722 // Ignore class roots since we don't have a way to map them to the destination. These are handled
1723 // with other logic.
1724 void VisitRootIfNonNull(mirror::CompressedReference<mirror::Object>* root ATTRIBUTE_UNUSED)
1725 const {}
1726 void VisitRoot(mirror::CompressedReference<mirror::Object>* root ATTRIBUTE_UNUSED) const {}
1727
1728
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001729 void operator()(Object* obj, MemberOffset offset, bool is_static ATTRIBUTE_UNUSED) const
Mathieu Chartier90443472015-07-16 20:32:27 -07001730 REQUIRES(Locks::mutator_lock_, Locks::heap_bitmap_lock_) {
Hiroshi Yamauchi6e83c172014-05-01 21:25:41 -07001731 Object* ref = obj->GetFieldObject<Object, kVerifyNone>(offset);
Mathieu Chartierb7ea3ac2014-03-24 16:54:46 -07001732 // Use SetFieldObjectWithoutWriteBarrier to avoid card marking since we are writing to the
1733 // image.
1734 copy_->SetFieldObjectWithoutWriteBarrier<false, true, kVerifyNone>(
Mathieu Chartiera808bac2015-11-05 16:33:15 -08001735 offset,
1736 image_writer_->GetImageAddress(ref));
Mathieu Chartierb7ea3ac2014-03-24 16:54:46 -07001737 }
1738
1739 // java.lang.ref.Reference visitor.
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001740 void operator()(mirror::Class* klass ATTRIBUTE_UNUSED, mirror::Reference* ref) const
Mathieu Chartierda7c6502015-07-23 16:01:26 -07001741 SHARED_REQUIRES(Locks::mutator_lock_) REQUIRES(Locks::heap_bitmap_lock_) {
Mathieu Chartierb7ea3ac2014-03-24 16:54:46 -07001742 copy_->SetFieldObjectWithoutWriteBarrier<false, true, kVerifyNone>(
Mathieu Chartiera808bac2015-11-05 16:33:15 -08001743 mirror::Reference::ReferentOffset(),
1744 image_writer_->GetImageAddress(ref->GetReferent()));
Mathieu Chartierb7ea3ac2014-03-24 16:54:46 -07001745 }
1746
Mingyao Yang98d1cc82014-05-15 17:02:16 -07001747 protected:
Mathieu Chartierb7ea3ac2014-03-24 16:54:46 -07001748 ImageWriter* const image_writer_;
1749 mirror::Object* const copy_;
1750};
1751
Mingyao Yang98d1cc82014-05-15 17:02:16 -07001752class FixupClassVisitor FINAL : public FixupVisitor {
1753 public:
1754 FixupClassVisitor(ImageWriter* image_writer, Object* copy) : FixupVisitor(image_writer, copy) {
1755 }
1756
Mathieu Chartierc7853442015-03-27 14:35:38 -07001757 void operator()(Object* obj, MemberOffset offset, bool is_static ATTRIBUTE_UNUSED) const
Mathieu Chartier90443472015-07-16 20:32:27 -07001758 REQUIRES(Locks::mutator_lock_, Locks::heap_bitmap_lock_) {
Mingyao Yang98d1cc82014-05-15 17:02:16 -07001759 DCHECK(obj->IsClass());
Igor Murashkinf5b4c502014-11-14 15:01:59 -08001760 FixupVisitor::operator()(obj, offset, /*is_static*/false);
Mingyao Yang98d1cc82014-05-15 17:02:16 -07001761 }
1762
Ian Rogers6a3c1fc2014-10-31 00:33:20 -07001763 void operator()(mirror::Class* klass ATTRIBUTE_UNUSED,
1764 mirror::Reference* ref ATTRIBUTE_UNUSED) const
Mathieu Chartierda7c6502015-07-23 16:01:26 -07001765 SHARED_REQUIRES(Locks::mutator_lock_) REQUIRES(Locks::heap_bitmap_lock_) {
Mingyao Yang98d1cc82014-05-15 17:02:16 -07001766 LOG(FATAL) << "Reference not expected here.";
1767 }
1768};
1769
Vladimir Marko05792b92015-08-03 11:56:49 +01001770uintptr_t ImageWriter::NativeOffsetInImage(void* obj) {
1771 DCHECK(obj != nullptr);
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001772 DCHECK(!IsInBootImage(obj));
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001773 auto it = native_object_relocations_.find(obj);
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001774 CHECK(it != native_object_relocations_.end()) << obj << " spaces "
1775 << Runtime::Current()->GetHeap()->DumpSpaces();
Mathieu Chartierc0fe56a2015-08-11 13:01:23 -07001776 const NativeObjectRelocation& relocation = it->second;
Vladimir Marko05792b92015-08-03 11:56:49 +01001777 return relocation.offset;
1778}
1779
1780template <typename T>
Mathieu Chartiere8bf1342016-02-17 18:02:40 -08001781T* ImageWriter::NativeLocationInImage(T* obj) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08001782 if (obj == nullptr || IsInBootImage(obj)) {
1783 return obj;
1784 } else {
Mathieu Chartiere8bf1342016-02-17 18:02:40 -08001785 auto it = native_object_relocations_.find(obj);
1786 CHECK(it != native_object_relocations_.end()) << obj << " spaces "
1787 << Runtime::Current()->GetHeap()->DumpSpaces();
1788 const NativeObjectRelocation& relocation = it->second;
Vladimir Marko944da602016-02-19 12:27:55 +00001789 ImageInfo& image_info = GetImageInfo(relocation.oat_index);
Mathieu Chartiere8bf1342016-02-17 18:02:40 -08001790 return reinterpret_cast<T*>(image_info.image_begin_ + relocation.offset);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001791 }
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001792}
1793
Mathieu Chartier4b00d342015-11-13 10:42:08 -08001794template <typename T>
Jeff Haodcdc85b2015-12-04 14:06:18 -08001795T* ImageWriter::NativeCopyLocation(T* obj, mirror::DexCache* dex_cache) {
1796 if (obj == nullptr || IsInBootImage(obj)) {
1797 return obj;
1798 } else {
Vladimir Marko944da602016-02-19 12:27:55 +00001799 size_t oat_index = GetOatIndexForDexCache(dex_cache);
1800 ImageInfo& image_info = GetImageInfo(oat_index);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001801 return reinterpret_cast<T*>(image_info.image_->Begin() + NativeOffsetInImage(obj));
1802 }
Mathieu Chartier4b00d342015-11-13 10:42:08 -08001803}
1804
1805class NativeLocationVisitor {
1806 public:
Mathieu Chartiere8bf1342016-02-17 18:02:40 -08001807 explicit NativeLocationVisitor(ImageWriter* image_writer) : image_writer_(image_writer) {}
Mathieu Chartier4b00d342015-11-13 10:42:08 -08001808
1809 template <typename T>
Jeff Haodcdc85b2015-12-04 14:06:18 -08001810 T* operator()(T* ptr) const SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartiere8bf1342016-02-17 18:02:40 -08001811 return image_writer_->NativeLocationInImage(ptr);
Mathieu Chartierc7853442015-03-27 14:35:38 -07001812 }
Mathieu Chartier4b00d342015-11-13 10:42:08 -08001813
1814 private:
1815 ImageWriter* const image_writer_;
1816};
1817
1818void ImageWriter::FixupClass(mirror::Class* orig, mirror::Class* copy) {
Mathieu Chartiere8bf1342016-02-17 18:02:40 -08001819 orig->FixupNativePointers(copy, target_ptr_size_, NativeLocationVisitor(this));
Mathieu Chartierc7853442015-03-27 14:35:38 -07001820 FixupClassVisitor visitor(this, copy);
Mathieu Chartier059ef3d2015-08-18 13:54:21 -07001821 static_cast<mirror::Object*>(orig)->VisitReferences(visitor, visitor);
Andreas Gampeace0dc12016-01-20 13:33:13 -08001822
1823 // Remove the clinitThreadId. This is required for image determinism.
1824 copy->SetClinitThreadId(static_cast<pid_t>(0));
Mathieu Chartierc7853442015-03-27 14:35:38 -07001825}
1826
Ian Rogersef7d42f2014-01-06 12:55:46 -08001827void ImageWriter::FixupObject(Object* orig, Object* copy) {
Mathieu Chartierb7ea3ac2014-03-24 16:54:46 -07001828 DCHECK(orig != nullptr);
1829 DCHECK(copy != nullptr);
Hiroshi Yamauchi624468c2014-03-31 15:14:47 -07001830 if (kUseBakerOrBrooksReadBarrier) {
1831 orig->AssertReadBarrierPointer();
1832 if (kUseBrooksReadBarrier) {
1833 // Note the address 'copy' isn't the same as the image address of 'orig'.
1834 copy->SetReadBarrierPointer(GetImageAddress(orig));
1835 DCHECK_EQ(copy->GetReadBarrierPointer(), GetImageAddress(orig));
1836 }
Hiroshi Yamauchi9d04a202014-01-31 13:35:49 -08001837 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07001838 auto* klass = orig->GetClass();
1839 if (klass->IsIntArrayClass() || klass->IsLongArrayClass()) {
Vladimir Marko05792b92015-08-03 11:56:49 +01001840 // Is this a native pointer array?
Mathieu Chartiere401d142015-04-22 13:56:20 -07001841 auto it = pointer_arrays_.find(down_cast<mirror::PointerArray*>(orig));
1842 if (it != pointer_arrays_.end()) {
1843 // Should only need to fixup every pointer array exactly once.
1844 FixupPointerArray(copy, down_cast<mirror::PointerArray*>(orig), klass, it->second);
1845 pointer_arrays_.erase(it);
1846 return;
1847 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07001848 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07001849 if (orig->IsClass()) {
1850 FixupClass(orig->AsClass<kVerifyNone>(), down_cast<mirror::Class*>(copy));
Mingyao Yang98d1cc82014-05-15 17:02:16 -07001851 } else {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001852 if (klass == mirror::Method::StaticClass() || klass == mirror::Constructor::StaticClass()) {
1853 // Need to go update the ArtMethod.
1854 auto* dest = down_cast<mirror::AbstractMethod*>(copy);
1855 auto* src = down_cast<mirror::AbstractMethod*>(orig);
1856 ArtMethod* src_method = src->GetArtMethod();
Mathieu Chartier54d220e2015-07-30 16:20:06 -07001857 auto it = native_object_relocations_.find(src_method);
1858 CHECK(it != native_object_relocations_.end())
1859 << "Missing relocation for AbstractMethod.artMethod " << PrettyMethod(src_method);
Mathieu Chartiere401d142015-04-22 13:56:20 -07001860 dest->SetArtMethod(
Jeff Haodcdc85b2015-12-04 14:06:18 -08001861 reinterpret_cast<ArtMethod*>(global_image_begin_ + it->second.offset));
Vladimir Marko05792b92015-08-03 11:56:49 +01001862 } else if (!klass->IsArrayClass()) {
1863 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1864 if (klass == class_linker->GetClassRoot(ClassLinker::kJavaLangDexCache)) {
1865 FixupDexCache(down_cast<mirror::DexCache*>(orig), down_cast<mirror::DexCache*>(copy));
Mathieu Chartier208a5cb2015-12-02 15:44:07 -08001866 } else if (klass->IsClassLoaderClass()) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001867 mirror::ClassLoader* copy_loader = down_cast<mirror::ClassLoader*>(copy);
Vladimir Marko05792b92015-08-03 11:56:49 +01001868 // If src is a ClassLoader, set the class table to null so that it gets recreated by the
1869 // ClassLoader.
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001870 copy_loader->SetClassTable(nullptr);
Mathieu Chartier5550c562015-09-22 15:18:04 -07001871 // Also set allocator to null to be safe. The allocator is created when we create the class
1872 // table. We also never expect to unload things in the image since they are held live as
1873 // roots.
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001874 copy_loader->SetAllocator(nullptr);
Vladimir Marko05792b92015-08-03 11:56:49 +01001875 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07001876 }
Mingyao Yang98d1cc82014-05-15 17:02:16 -07001877 FixupVisitor visitor(this, copy);
Mathieu Chartier059ef3d2015-08-18 13:54:21 -07001878 orig->VisitReferences(visitor, visitor);
Mingyao Yang98d1cc82014-05-15 17:02:16 -07001879 }
Brian Carlstrom7940e442013-07-12 13:46:57 -07001880}
1881
Mathieu Chartier4b00d342015-11-13 10:42:08 -08001882
1883class ImageAddressVisitor {
1884 public:
1885 explicit ImageAddressVisitor(ImageWriter* image_writer) : image_writer_(image_writer) {}
1886
1887 template <typename T>
1888 T* operator()(T* ptr) const SHARED_REQUIRES(Locks::mutator_lock_) {
1889 return image_writer_->GetImageAddress(ptr);
1890 }
1891
1892 private:
1893 ImageWriter* const image_writer_;
1894};
1895
1896
Vladimir Marko05792b92015-08-03 11:56:49 +01001897void ImageWriter::FixupDexCache(mirror::DexCache* orig_dex_cache,
1898 mirror::DexCache* copy_dex_cache) {
1899 // Though the DexCache array fields are usually treated as native pointers, we set the full
1900 // 64-bit values here, clearing the top 32 bits for 32-bit targets. The zero-extension is
1901 // done by casting to the unsigned type uintptr_t before casting to int64_t, i.e.
1902 // static_cast<int64_t>(reinterpret_cast<uintptr_t>(image_begin_ + offset))).
1903 GcRoot<mirror::String>* orig_strings = orig_dex_cache->GetStrings();
1904 if (orig_strings != nullptr) {
Mathieu Chartier4b00d342015-11-13 10:42:08 -08001905 copy_dex_cache->SetFieldPtrWithSize<false>(mirror::DexCache::StringsOffset(),
Mathieu Chartiere8bf1342016-02-17 18:02:40 -08001906 NativeLocationInImage(orig_strings),
Mathieu Chartier4b00d342015-11-13 10:42:08 -08001907 /*pointer size*/8u);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001908 orig_dex_cache->FixupStrings(NativeCopyLocation(orig_strings, orig_dex_cache),
1909 ImageAddressVisitor(this));
Vladimir Marko05792b92015-08-03 11:56:49 +01001910 }
1911 GcRoot<mirror::Class>* orig_types = orig_dex_cache->GetResolvedTypes();
1912 if (orig_types != nullptr) {
Mathieu Chartier4b00d342015-11-13 10:42:08 -08001913 copy_dex_cache->SetFieldPtrWithSize<false>(mirror::DexCache::ResolvedTypesOffset(),
Mathieu Chartiere8bf1342016-02-17 18:02:40 -08001914 NativeLocationInImage(orig_types),
Mathieu Chartier4b00d342015-11-13 10:42:08 -08001915 /*pointer size*/8u);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001916 orig_dex_cache->FixupResolvedTypes(NativeCopyLocation(orig_types, orig_dex_cache),
1917 ImageAddressVisitor(this));
Vladimir Marko05792b92015-08-03 11:56:49 +01001918 }
1919 ArtMethod** orig_methods = orig_dex_cache->GetResolvedMethods();
1920 if (orig_methods != nullptr) {
Mathieu Chartier4b00d342015-11-13 10:42:08 -08001921 copy_dex_cache->SetFieldPtrWithSize<false>(mirror::DexCache::ResolvedMethodsOffset(),
Mathieu Chartiere8bf1342016-02-17 18:02:40 -08001922 NativeLocationInImage(orig_methods),
Mathieu Chartier4b00d342015-11-13 10:42:08 -08001923 /*pointer size*/8u);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001924 ArtMethod** copy_methods = NativeCopyLocation(orig_methods, orig_dex_cache);
Vladimir Marko05792b92015-08-03 11:56:49 +01001925 for (size_t i = 0, num = orig_dex_cache->NumResolvedMethods(); i != num; ++i) {
1926 ArtMethod* orig = mirror::DexCache::GetElementPtrSize(orig_methods, i, target_ptr_size_);
Mathieu Chartiere8bf1342016-02-17 18:02:40 -08001927 // NativeLocationInImage also handles runtime methods since these have relocation info.
1928 ArtMethod* copy = NativeLocationInImage(orig);
Vladimir Marko05792b92015-08-03 11:56:49 +01001929 mirror::DexCache::SetElementPtrSize(copy_methods, i, copy, target_ptr_size_);
1930 }
1931 }
1932 ArtField** orig_fields = orig_dex_cache->GetResolvedFields();
1933 if (orig_fields != nullptr) {
Mathieu Chartier4b00d342015-11-13 10:42:08 -08001934 copy_dex_cache->SetFieldPtrWithSize<false>(mirror::DexCache::ResolvedFieldsOffset(),
Mathieu Chartiere8bf1342016-02-17 18:02:40 -08001935 NativeLocationInImage(orig_fields),
Mathieu Chartier4b00d342015-11-13 10:42:08 -08001936 /*pointer size*/8u);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001937 ArtField** copy_fields = NativeCopyLocation(orig_fields, orig_dex_cache);
Vladimir Marko05792b92015-08-03 11:56:49 +01001938 for (size_t i = 0, num = orig_dex_cache->NumResolvedFields(); i != num; ++i) {
1939 ArtField* orig = mirror::DexCache::GetElementPtrSize(orig_fields, i, target_ptr_size_);
Mathieu Chartiere8bf1342016-02-17 18:02:40 -08001940 ArtField* copy = NativeLocationInImage(orig);
Vladimir Marko05792b92015-08-03 11:56:49 +01001941 mirror::DexCache::SetElementPtrSize(copy_fields, i, copy, target_ptr_size_);
1942 }
1943 }
Andreas Gampeace0dc12016-01-20 13:33:13 -08001944
1945 // Remove the DexFile pointers. They will be fixed up when the runtime loads the oat file. Leaving
1946 // compiler pointers in here will make the output non-deterministic.
1947 copy_dex_cache->SetDexFile(nullptr);
Vladimir Marko05792b92015-08-03 11:56:49 +01001948}
1949
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001950const uint8_t* ImageWriter::GetOatAddress(OatAddress type) const {
1951 DCHECK_LT(type, kOatAddressCount);
1952 // If we are compiling an app image, we need to use the stubs of the boot image.
1953 if (compile_app_image_) {
1954 // Use the current image pointers.
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001955 const std::vector<gc::space::ImageSpace*>& image_spaces =
Jeff Haodcdc85b2015-12-04 14:06:18 -08001956 Runtime::Current()->GetHeap()->GetBootImageSpaces();
1957 DCHECK(!image_spaces.empty());
1958 const OatFile* oat_file = image_spaces[0]->GetOatFile();
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001959 CHECK(oat_file != nullptr);
1960 const OatHeader& header = oat_file->GetOatHeader();
1961 switch (type) {
1962 // TODO: We could maybe clean this up if we stored them in an array in the oat header.
1963 case kOatAddressQuickGenericJNITrampoline:
1964 return static_cast<const uint8_t*>(header.GetQuickGenericJniTrampoline());
1965 case kOatAddressInterpreterToInterpreterBridge:
1966 return static_cast<const uint8_t*>(header.GetInterpreterToInterpreterBridge());
1967 case kOatAddressInterpreterToCompiledCodeBridge:
1968 return static_cast<const uint8_t*>(header.GetInterpreterToCompiledCodeBridge());
1969 case kOatAddressJNIDlsymLookup:
1970 return static_cast<const uint8_t*>(header.GetJniDlsymLookup());
1971 case kOatAddressQuickIMTConflictTrampoline:
1972 return static_cast<const uint8_t*>(header.GetQuickImtConflictTrampoline());
1973 case kOatAddressQuickResolutionTrampoline:
1974 return static_cast<const uint8_t*>(header.GetQuickResolutionTrampoline());
1975 case kOatAddressQuickToInterpreterBridge:
1976 return static_cast<const uint8_t*>(header.GetQuickToInterpreterBridge());
1977 default:
1978 UNREACHABLE();
1979 }
1980 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08001981 const ImageInfo& primary_image_info = GetImageInfo(0);
1982 return GetOatAddressForOffset(primary_image_info.oat_address_offsets_[type], primary_image_info);
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001983}
1984
Jeff Haodcdc85b2015-12-04 14:06:18 -08001985const uint8_t* ImageWriter::GetQuickCode(ArtMethod* method,
1986 const ImageInfo& image_info,
1987 bool* quick_is_interpreted) {
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001988 DCHECK(!method->IsResolutionMethod()) << PrettyMethod(method);
1989 DCHECK(!method->IsImtConflictMethod()) << PrettyMethod(method);
1990 DCHECK(!method->IsImtUnimplementedMethod()) << PrettyMethod(method);
Alex Light9139e002015-10-09 15:59:48 -07001991 DCHECK(method->IsInvokable()) << PrettyMethod(method);
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08001992 DCHECK(!IsInBootImage(method)) << PrettyMethod(method);
Mingyao Yang98d1cc82014-05-15 17:02:16 -07001993
1994 // Use original code if it exists. Otherwise, set the code pointer to the resolution
1995 // trampoline.
1996
1997 // Quick entrypoint:
Igor Murashkin0ccfe2c2016-02-19 16:41:44 -08001998 const void* quick_oat_entry_point =
1999 method->GetEntryPointFromQuickCompiledCodePtrSize(target_ptr_size_);
2000 const uint8_t* quick_code;
2001
2002 if (UNLIKELY(IsInBootImage(method->GetDeclaringClass()))) {
2003 DCHECK(method->IsCopied());
2004 // If the code is not in the oat file corresponding to this image (e.g. default methods)
2005 quick_code = reinterpret_cast<const uint8_t*>(quick_oat_entry_point);
2006 } else {
2007 uint32_t quick_oat_code_offset = PointerToLowMemUInt32(quick_oat_entry_point);
2008 quick_code = GetOatAddressForOffset(quick_oat_code_offset, image_info);
2009 }
2010
Mingyao Yang98d1cc82014-05-15 17:02:16 -07002011 *quick_is_interpreted = false;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002012 if (quick_code != nullptr && (!method->IsStatic() || method->IsConstructor() ||
2013 method->GetDeclaringClass()->IsInitialized())) {
Mingyao Yang98d1cc82014-05-15 17:02:16 -07002014 // We have code for a non-static or initialized method, just use the code.
2015 } else if (quick_code == nullptr && method->IsNative() &&
2016 (!method->IsStatic() || method->GetDeclaringClass()->IsInitialized())) {
2017 // Non-static or initialized native method missing compiled code, use generic JNI version.
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002018 quick_code = GetOatAddress(kOatAddressQuickGenericJNITrampoline);
Mingyao Yang98d1cc82014-05-15 17:02:16 -07002019 } else if (quick_code == nullptr && !method->IsNative()) {
2020 // We don't have code at all for a non-native method, use the interpreter.
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002021 quick_code = GetOatAddress(kOatAddressQuickToInterpreterBridge);
Mingyao Yang98d1cc82014-05-15 17:02:16 -07002022 *quick_is_interpreted = true;
2023 } else {
2024 CHECK(!method->GetDeclaringClass()->IsInitialized());
2025 // We have code for a static method, but need to go through the resolution stub for class
2026 // initialization.
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002027 quick_code = GetOatAddress(kOatAddressQuickResolutionTrampoline);
2028 }
2029 if (!IsInBootOatFile(quick_code)) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002030 // DCHECK_GE(quick_code, oat_data_begin_);
Mingyao Yang98d1cc82014-05-15 17:02:16 -07002031 }
2032 return quick_code;
2033}
2034
Jeff Haodcdc85b2015-12-04 14:06:18 -08002035void ImageWriter::CopyAndFixupMethod(ArtMethod* orig,
2036 ArtMethod* copy,
2037 const ImageInfo& image_info) {
Vladimir Marko14632852015-08-17 12:07:23 +01002038 memcpy(copy, orig, ArtMethod::Size(target_ptr_size_));
Mathieu Chartiere401d142015-04-22 13:56:20 -07002039
2040 copy->SetDeclaringClass(GetImageAddress(orig->GetDeclaringClassUnchecked()));
Vladimir Marko05792b92015-08-03 11:56:49 +01002041 ArtMethod** orig_resolved_methods = orig->GetDexCacheResolvedMethods(target_ptr_size_);
Mathieu Chartiere8bf1342016-02-17 18:02:40 -08002042 copy->SetDexCacheResolvedMethods(NativeLocationInImage(orig_resolved_methods), target_ptr_size_);
Vladimir Marko05792b92015-08-03 11:56:49 +01002043 GcRoot<mirror::Class>* orig_resolved_types = orig->GetDexCacheResolvedTypes(target_ptr_size_);
Mathieu Chartiere8bf1342016-02-17 18:02:40 -08002044 copy->SetDexCacheResolvedTypes(NativeLocationInImage(orig_resolved_types), target_ptr_size_);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002045
Ian Rogers848871b2013-08-05 10:56:33 -07002046 // OatWriter replaces the code_ with an offset value. Here we re-adjust to a pointer relative to
2047 // oat_begin_
Brian Carlstrom7940e442013-07-12 13:46:57 -07002048
Ian Rogers848871b2013-08-05 10:56:33 -07002049 // The resolution method has a special trampoline to call.
Mathieu Chartier2d2621a2014-10-23 16:48:06 -07002050 Runtime* runtime = Runtime::Current();
2051 if (UNLIKELY(orig == runtime->GetResolutionMethod())) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002052 copy->SetEntryPointFromQuickCompiledCodePtrSize(
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002053 GetOatAddress(kOatAddressQuickResolutionTrampoline), target_ptr_size_);
Mathieu Chartier2d2621a2014-10-23 16:48:06 -07002054 } else if (UNLIKELY(orig == runtime->GetImtConflictMethod() ||
2055 orig == runtime->GetImtUnimplementedMethod())) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002056 copy->SetEntryPointFromQuickCompiledCodePtrSize(
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002057 GetOatAddress(kOatAddressQuickIMTConflictTrampoline), target_ptr_size_);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002058 } else if (UNLIKELY(orig->IsRuntimeMethod())) {
2059 bool found_one = false;
2060 for (size_t i = 0; i < static_cast<size_t>(Runtime::kLastCalleeSaveType); ++i) {
2061 auto idx = static_cast<Runtime::CalleeSaveType>(i);
2062 if (runtime->HasCalleeSaveMethod(idx) && runtime->GetCalleeSaveMethod(idx) == orig) {
2063 found_one = true;
2064 break;
2065 }
2066 }
2067 CHECK(found_one) << "Expected to find callee save method but got " << PrettyMethod(orig);
2068 CHECK(copy->IsRuntimeMethod());
Brian Carlstrom7940e442013-07-12 13:46:57 -07002069 } else {
Ian Rogers848871b2013-08-05 10:56:33 -07002070 // We assume all methods have code. If they don't currently then we set them to the use the
2071 // resolution trampoline. Abstract methods never have code and so we need to make sure their
2072 // use results in an AbstractMethodError. We use the interpreter to achieve this.
Alex Light9139e002015-10-09 15:59:48 -07002073 if (UNLIKELY(!orig->IsInvokable())) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002074 copy->SetEntryPointFromQuickCompiledCodePtrSize(
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002075 GetOatAddress(kOatAddressQuickToInterpreterBridge), target_ptr_size_);
Ian Rogers848871b2013-08-05 10:56:33 -07002076 } else {
Mingyao Yang98d1cc82014-05-15 17:02:16 -07002077 bool quick_is_interpreted;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002078 const uint8_t* quick_code = GetQuickCode(orig, image_info, &quick_is_interpreted);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002079 copy->SetEntryPointFromQuickCompiledCodePtrSize(quick_code, target_ptr_size_);
Sebastien Hertze1d07812014-05-21 15:44:09 +02002080
Sebastien Hertze1d07812014-05-21 15:44:09 +02002081 // JNI entrypoint:
Ian Rogers848871b2013-08-05 10:56:33 -07002082 if (orig->IsNative()) {
2083 // The native method's pointer is set to a stub to lookup via dlsym.
2084 // Note this is not the code_ pointer, that is handled above.
Mathieu Chartiere401d142015-04-22 13:56:20 -07002085 copy->SetEntryPointFromJniPtrSize(
Mathieu Chartierda5b28a2015-11-05 08:03:47 -08002086 GetOatAddress(kOatAddressJNIDlsymLookup), target_ptr_size_);
Ian Rogers848871b2013-08-05 10:56:33 -07002087 }
2088 }
Brian Carlstrom7940e442013-07-12 13:46:57 -07002089 }
2090}
2091
Jeff Haodcdc85b2015-12-04 14:06:18 -08002092size_t ImageWriter::GetBinSizeSum(ImageWriter::ImageInfo& image_info, ImageWriter::Bin up_to) const {
Igor Murashkinf5b4c502014-11-14 15:01:59 -08002093 DCHECK_LE(up_to, kBinSize);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002094 return std::accumulate(&image_info.bin_slot_sizes_[0],
2095 &image_info.bin_slot_sizes_[up_to],
2096 /*init*/0);
Igor Murashkinf5b4c502014-11-14 15:01:59 -08002097}
2098
2099ImageWriter::BinSlot::BinSlot(uint32_t lockword) : lockword_(lockword) {
2100 // These values may need to get updated if more bins are added to the enum Bin
Mathieu Chartiere401d142015-04-22 13:56:20 -07002101 static_assert(kBinBits == 3, "wrong number of bin bits");
2102 static_assert(kBinShift == 27, "wrong number of shift");
Igor Murashkinf5b4c502014-11-14 15:01:59 -08002103 static_assert(sizeof(BinSlot) == sizeof(LockWord), "BinSlot/LockWord must have equal sizes");
2104
2105 DCHECK_LT(GetBin(), kBinSize);
2106 DCHECK_ALIGNED(GetIndex(), kObjectAlignment);
2107}
2108
2109ImageWriter::BinSlot::BinSlot(Bin bin, uint32_t index)
2110 : BinSlot(index | (static_cast<uint32_t>(bin) << kBinShift)) {
2111 DCHECK_EQ(index, GetIndex());
2112}
2113
2114ImageWriter::Bin ImageWriter::BinSlot::GetBin() const {
2115 return static_cast<Bin>((lockword_ & kBinMask) >> kBinShift);
2116}
2117
2118uint32_t ImageWriter::BinSlot::GetIndex() const {
2119 return lockword_ & ~kBinMask;
2120}
2121
Mathieu Chartier54d220e2015-07-30 16:20:06 -07002122ImageWriter::Bin ImageWriter::BinTypeForNativeRelocationType(NativeObjectRelocationType type) {
2123 switch (type) {
2124 case kNativeObjectRelocationTypeArtField:
2125 case kNativeObjectRelocationTypeArtFieldArray:
2126 return kBinArtField;
2127 case kNativeObjectRelocationTypeArtMethodClean:
2128 case kNativeObjectRelocationTypeArtMethodArrayClean:
2129 return kBinArtMethodClean;
2130 case kNativeObjectRelocationTypeArtMethodDirty:
2131 case kNativeObjectRelocationTypeArtMethodArrayDirty:
2132 return kBinArtMethodDirty;
Vladimir Marko05792b92015-08-03 11:56:49 +01002133 case kNativeObjectRelocationTypeDexCacheArray:
2134 return kBinDexCacheArray;
Mathieu Chartier54d220e2015-07-30 16:20:06 -07002135 }
2136 UNREACHABLE();
2137}
2138
Vladimir Marko944da602016-02-19 12:27:55 +00002139size_t ImageWriter::GetOatIndex(mirror::Object* obj) const {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002140 if (compile_app_image_) {
Vladimir Marko944da602016-02-19 12:27:55 +00002141 return GetDefaultOatIndex();
Jeff Haodcdc85b2015-12-04 14:06:18 -08002142 } else {
Vladimir Marko944da602016-02-19 12:27:55 +00002143 mirror::DexCache* dex_cache =
2144 obj->IsDexCache() ? obj->AsDexCache()
2145 : obj->IsClass() ? obj->AsClass()->GetDexCache()
2146 : obj->GetClass()->GetDexCache();
2147 return GetOatIndexForDexCache(dex_cache);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002148 }
2149}
2150
Vladimir Marko944da602016-02-19 12:27:55 +00002151size_t ImageWriter::GetOatIndexForDexFile(const DexFile* dex_file) const {
2152 if (compile_app_image_) {
2153 return GetDefaultOatIndex();
Jeff Haodcdc85b2015-12-04 14:06:18 -08002154 } else {
Vladimir Marko944da602016-02-19 12:27:55 +00002155 auto it = dex_file_oat_index_map_.find(dex_file);
2156 DCHECK(it != dex_file_oat_index_map_.end()) << dex_file->GetLocation();
Jeff Haodcdc85b2015-12-04 14:06:18 -08002157 return it->second;
2158 }
2159}
2160
Vladimir Marko944da602016-02-19 12:27:55 +00002161size_t ImageWriter::GetOatIndexForDexCache(mirror::DexCache* dex_cache) const {
2162 if (dex_cache == nullptr) {
2163 return GetDefaultOatIndex();
2164 } else {
2165 return GetOatIndexForDexFile(dex_cache->GetDexFile());
2166 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002167}
2168
Vladimir Marko944da602016-02-19 12:27:55 +00002169void ImageWriter::UpdateOatFileLayout(size_t oat_index,
2170 size_t oat_loaded_size,
2171 size_t oat_data_offset,
2172 size_t oat_data_size) {
2173 const uint8_t* images_end = image_infos_.back().image_begin_ + image_infos_.back().image_size_;
2174 for (const ImageInfo& info : image_infos_) {
2175 DCHECK_LE(info.image_begin_ + info.image_size_, images_end);
2176 }
2177 DCHECK(images_end != nullptr); // Image space must be ready.
Jeff Haodcdc85b2015-12-04 14:06:18 -08002178
Vladimir Marko944da602016-02-19 12:27:55 +00002179 ImageInfo& cur_image_info = GetImageInfo(oat_index);
2180 cur_image_info.oat_file_begin_ = images_end + cur_image_info.oat_offset_;
2181 cur_image_info.oat_loaded_size_ = oat_loaded_size;
2182 cur_image_info.oat_data_begin_ = cur_image_info.oat_file_begin_ + oat_data_offset;
2183 cur_image_info.oat_size_ = oat_data_size;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002184
Mathieu Chartier14567fd2016-01-28 20:33:36 -08002185 if (compile_app_image_) {
2186 CHECK_EQ(oat_filenames_.size(), 1u) << "App image should have no next image.";
2187 return;
2188 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002189
2190 // Update the oat_offset of the next image info.
Vladimir Marko944da602016-02-19 12:27:55 +00002191 if (oat_index + 1u != oat_filenames_.size()) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002192 // There is a following one.
Vladimir Marko944da602016-02-19 12:27:55 +00002193 ImageInfo& next_image_info = GetImageInfo(oat_index + 1u);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002194 next_image_info.oat_offset_ = cur_image_info.oat_offset_ + oat_loaded_size;
2195 }
2196}
2197
Vladimir Marko944da602016-02-19 12:27:55 +00002198void ImageWriter::UpdateOatFileHeader(size_t oat_index, const OatHeader& oat_header) {
2199 ImageInfo& cur_image_info = GetImageInfo(oat_index);
2200 cur_image_info.oat_checksum_ = oat_header.GetChecksum();
2201
2202 if (oat_index == GetDefaultOatIndex()) {
2203 // Primary oat file, read the trampolines.
2204 cur_image_info.oat_address_offsets_[kOatAddressInterpreterToInterpreterBridge] =
2205 oat_header.GetInterpreterToInterpreterBridgeOffset();
2206 cur_image_info.oat_address_offsets_[kOatAddressInterpreterToCompiledCodeBridge] =
2207 oat_header.GetInterpreterToCompiledCodeBridgeOffset();
2208 cur_image_info.oat_address_offsets_[kOatAddressJNIDlsymLookup] =
2209 oat_header.GetJniDlsymLookupOffset();
2210 cur_image_info.oat_address_offsets_[kOatAddressQuickGenericJNITrampoline] =
2211 oat_header.GetQuickGenericJniTrampolineOffset();
2212 cur_image_info.oat_address_offsets_[kOatAddressQuickIMTConflictTrampoline] =
2213 oat_header.GetQuickImtConflictTrampolineOffset();
2214 cur_image_info.oat_address_offsets_[kOatAddressQuickResolutionTrampoline] =
2215 oat_header.GetQuickResolutionTrampolineOffset();
2216 cur_image_info.oat_address_offsets_[kOatAddressQuickToInterpreterBridge] =
2217 oat_header.GetQuickToInterpreterBridgeOffset();
2218 }
2219}
2220
Mathieu Chartierea0831f2015-12-29 13:17:37 -08002221ImageWriter::ImageWriter(
2222 const CompilerDriver& compiler_driver,
2223 uintptr_t image_begin,
2224 bool compile_pic,
2225 bool compile_app_image,
2226 ImageHeader::StorageMode image_storage_mode,
Vladimir Marko944da602016-02-19 12:27:55 +00002227 const std::vector<const char*>& oat_filenames,
2228 const std::unordered_map<const DexFile*, size_t>& dex_file_oat_index_map)
Mathieu Chartierea0831f2015-12-29 13:17:37 -08002229 : compiler_driver_(compiler_driver),
2230 global_image_begin_(reinterpret_cast<uint8_t*>(image_begin)),
2231 image_objects_offset_begin_(0),
Mathieu Chartierea0831f2015-12-29 13:17:37 -08002232 compile_pic_(compile_pic),
2233 compile_app_image_(compile_app_image),
Mathieu Chartierea0831f2015-12-29 13:17:37 -08002234 target_ptr_size_(InstructionSetPointerSize(compiler_driver_.GetInstructionSet())),
Vladimir Marko944da602016-02-19 12:27:55 +00002235 image_infos_(oat_filenames.size()),
Mathieu Chartierea0831f2015-12-29 13:17:37 -08002236 image_method_array_(ImageHeader::kImageMethodsCount),
2237 dirty_methods_(0u),
2238 clean_methods_(0u),
Mathieu Chartierea0831f2015-12-29 13:17:37 -08002239 image_storage_mode_(image_storage_mode),
Mathieu Chartierea0831f2015-12-29 13:17:37 -08002240 oat_filenames_(oat_filenames),
Vladimir Marko944da602016-02-19 12:27:55 +00002241 dex_file_oat_index_map_(dex_file_oat_index_map) {
Mathieu Chartierea0831f2015-12-29 13:17:37 -08002242 CHECK_NE(image_begin, 0U);
Mathieu Chartierea0831f2015-12-29 13:17:37 -08002243 std::fill_n(image_methods_, arraysize(image_methods_), nullptr);
Mathieu Chartier901e0702016-02-19 13:42:48 -08002244 CHECK_EQ(compile_app_image, !Runtime::Current()->GetHeap()->GetBootImageSpaces().empty())
2245 << "Compiling a boot image should occur iff there are no boot image spaces loaded";
Mathieu Chartierea0831f2015-12-29 13:17:37 -08002246}
2247
Mathieu Chartier1f47b672016-01-07 16:29:01 -08002248ImageWriter::ImageInfo::ImageInfo()
2249 : intern_table_(new InternTable),
2250 class_table_(new ClassTable) {}
Mathieu Chartierea0831f2015-12-29 13:17:37 -08002251
Brian Carlstrom7940e442013-07-12 13:46:57 -07002252} // namespace art