blob: 9e01d01cdb0b78b8a41856771d50e6ff2191d78c [file] [log] [blame]
Elliott Hughes2faa5f12012-01-30 14:42:07 -08001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Brian Carlstromdb4d5402011-08-09 12:18:28 -070016
17#include "image_writer.h"
18
19#include <sys/mman.h>
Elliott Hughes90a33692011-08-30 13:27:07 -070020
Brian Carlstromdb4d5402011-08-09 12:18:28 -070021#include <vector>
22
Elliott Hughes90a33692011-08-30 13:27:07 -070023#include "UniquePtr.h"
Brian Carlstroma663ea52011-08-19 23:33:41 -070024#include "class_linker.h"
Brian Carlstrom1f870082011-08-23 16:02:11 -070025#include "class_loader.h"
Brian Carlstromae826982011-11-09 01:33:42 -080026#include "compiled_method.h"
Brian Carlstromf5822582012-03-19 22:34:31 -070027#include "compiler.h"
Elliott Hughes90a33692011-08-30 13:27:07 -070028#include "dex_cache.h"
Brian Carlstromdb4d5402011-08-09 12:18:28 -070029#include "file.h"
30#include "globals.h"
31#include "heap.h"
Brian Carlstrom4a289ed2011-08-16 17:17:49 -070032#include "image.h"
Brian Carlstroma663ea52011-08-19 23:33:41 -070033#include "intern_table.h"
Brian Carlstromdb4d5402011-08-09 12:18:28 -070034#include "logging.h"
Logan Chien0c717dd2012-03-28 18:31:07 +080035#include "oat_file.h"
Brian Carlstromdb4d5402011-08-09 12:18:28 -070036#include "object.h"
Ian Rogers6d4d9fc2011-11-30 16:24:48 -080037#include "object_utils.h"
Brian Carlstrom1f870082011-08-23 16:02:11 -070038#include "runtime.h"
Brian Carlstromdb4d5402011-08-09 12:18:28 -070039#include "space.h"
40#include "utils.h"
41
42namespace art {
43
Brian Carlstroma004aa92012-02-08 18:05:09 -080044bool ImageWriter::Write(const std::string& image_filename,
Ian Rogers30fab402012-01-23 15:43:46 -080045 uintptr_t image_begin,
Brian Carlstromae826982011-11-09 01:33:42 -080046 const std::string& oat_filename,
Brian Carlstromf5822582012-03-19 22:34:31 -070047 const std::string& oat_location,
48 const Compiler& compiler) {
Brian Carlstroma004aa92012-02-08 18:05:09 -080049 CHECK(!image_filename.empty());
Brian Carlstromaded5f72011-10-07 17:15:04 -070050
Ian Rogers30fab402012-01-23 15:43:46 -080051 CHECK_NE(image_begin, 0U);
52 image_begin_ = reinterpret_cast<byte*>(image_begin);
Brian Carlstrom69b15fb2011-09-03 12:25:21 -070053
Elliott Hughesb3bd5f02012-03-08 21:05:27 -080054 Heap* heap = Runtime::Current()->GetHeap();
Brian Carlstromfddf6f62012-03-15 16:56:45 -070055 source_space_ = heap->GetAllocSpace();
Brian Carlstrom69b15fb2011-09-03 12:25:21 -070056
Brian Carlstromae826982011-11-09 01:33:42 -080057 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
58 const std::vector<DexCache*>& all_dex_caches = class_linker->GetDexCaches();
59 for (size_t i = 0; i < all_dex_caches.size(); i++) {
60 DexCache* dex_cache = all_dex_caches[i];
61 if (InSourceSpace(dex_cache)) {
62 dex_caches_.insert(dex_cache);
63 }
64 }
65
Logan Chien0c717dd2012-03-28 18:31:07 +080066 oat_file_ = OatFile::Open(oat_filename, oat_location, NULL,
67 OatFile::kRelocNone, true);
Brian Carlstromf5822582012-03-19 22:34:31 -070068 if (oat_file_ == NULL) {
Brian Carlstrome24fa612011-09-29 00:53:55 -070069 LOG(ERROR) << "Failed to open oat file " << oat_filename;
70 return false;
71 }
Elliott Hughesb25c3f62012-03-26 16:35:06 -070072 class_linker->RegisterOatFile(*oat_file_);
Brian Carlstrome24fa612011-09-29 00:53:55 -070073
Ian Rogersd857b632012-02-06 20:42:33 -080074 PruneNonImageClasses(); // Remove junk
75 ComputeLazyFieldsForImageClasses(); // Add useful information
Ian Rogersd1f1bf02012-02-26 16:59:20 -080076 ComputeEagerResolvedStrings();
Elliott Hughesb3bd5f02012-03-08 21:05:27 -080077 heap->CollectGarbage(false); // Remove garbage
78 heap->GetAllocSpace()->Trim(); // Trim size of source_space
Brian Carlstromae826982011-11-09 01:33:42 -080079 if (!AllocMemory()) {
Brian Carlstromdb4d5402011-08-09 12:18:28 -070080 return false;
81 }
Brian Carlstromae826982011-11-09 01:33:42 -080082#ifndef NDEBUG
83 CheckNonImageClassesRemoved();
84#endif
Elliott Hughesb3bd5f02012-03-08 21:05:27 -080085 heap->DisableCardMarking();
Brian Carlstromdb4d5402011-08-09 12:18:28 -070086 CalculateNewObjectOffsets();
87 CopyAndFixupObjects();
Brian Carlstromf5822582012-03-19 22:34:31 -070088 PatchOatCodeAndMethods(compiler);
Elliott Hughesd8ddfd52011-08-15 14:32:53 -070089
Brian Carlstroma004aa92012-02-08 18:05:09 -080090 UniquePtr<File> file(OS::OpenFile(image_filename.c_str(), true));
Elliott Hughes90a33692011-08-30 13:27:07 -070091 if (file.get() == NULL) {
Brian Carlstrome24fa612011-09-29 00:53:55 -070092 LOG(ERROR) << "Failed to open image file " << image_filename;
Brian Carlstromdb4d5402011-08-09 12:18:28 -070093 return false;
94 }
Ian Rogers30fab402012-01-23 15:43:46 -080095 bool success = file->WriteFully(image_->Begin(), image_end_);
Brian Carlstrome24fa612011-09-29 00:53:55 -070096 if (!success) {
97 PLOG(ERROR) << "Failed to write image file " << image_filename;
98 return false;
99 }
100 return true;
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700101}
102
Brian Carlstromae826982011-11-09 01:33:42 -0800103bool ImageWriter::AllocMemory() {
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700104 size_t size = source_space_->Size();
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700105 int prot = PROT_READ | PROT_WRITE;
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700106 size_t length = RoundUp(size, kPageSize);
Brian Carlstrom89521892011-12-07 22:05:07 -0800107 image_.reset(MemMap::MapAnonymous("image-writer-image", NULL, length, prot));
Elliott Hughes90a33692011-08-30 13:27:07 -0700108 if (image_.get() == NULL) {
Brian Carlstrome24fa612011-09-29 00:53:55 -0700109 LOG(ERROR) << "Failed to allocate memory for image file generation";
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700110 return false;
111 }
112 return true;
113}
114
Ian Rogersd418eda2012-01-30 12:14:28 -0800115void ImageWriter::ComputeLazyFieldsForImageClasses() {
116 Runtime* runtime = Runtime::Current();
117 ClassLinker* class_linker = runtime->GetClassLinker();
118 class_linker->VisitClasses(ComputeLazyFieldsForClassesVisitor, NULL);
119}
120
Elliott Hughes1bac54f2012-03-16 12:48:31 -0700121bool ImageWriter::ComputeLazyFieldsForClassesVisitor(Class* c, void* /*arg*/) {
122 c->ComputeName();
Ian Rogersd418eda2012-01-30 12:14:28 -0800123 return true;
124}
125
Ian Rogersd1f1bf02012-02-26 16:59:20 -0800126void ImageWriter::ComputeEagerResolvedStringsCallback(Object* obj, void* arg) {
127 if (!obj->GetClass()->IsStringClass()) {
128 return;
129 }
130 String* string = obj->AsString();
131 std::string utf8_string(string->ToModifiedUtf8());
132 ImageWriter* writer = reinterpret_cast<ImageWriter*>(arg);
133 ClassLinker* linker = Runtime::Current()->GetClassLinker();
134 typedef Set::const_iterator CacheIt; // TODO: C++0x auto
135 for (CacheIt it = writer->dex_caches_.begin(), end = writer->dex_caches_.end(); it != end; ++it) {
136 DexCache* dex_cache = *it;
137 const DexFile& dex_file = linker->FindDexFile(dex_cache);
138 const DexFile::StringId* string_id = dex_file.FindStringId(utf8_string);
139 if (string_id != NULL) {
140 // This string occurs in this dex file, assign the dex cache entry.
141 uint32_t string_idx = dex_file.GetIndexForStringId(*string_id);
142 if (dex_cache->GetResolvedString(string_idx) == NULL) {
143 dex_cache->SetResolvedString(string_idx, string);
144 }
145 }
146 }
147}
148
149void ImageWriter::ComputeEagerResolvedStrings() {
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800150 HeapBitmap* heap_bitmap = Runtime::Current()->GetHeap()->GetLiveBits();
Ian Rogersd1f1bf02012-02-26 16:59:20 -0800151 DCHECK(heap_bitmap != NULL);
152 heap_bitmap->Walk(ComputeEagerResolvedStringsCallback, this); // TODO: add Space-limited Walk
153}
154
Brian Carlstromae826982011-11-09 01:33:42 -0800155bool ImageWriter::IsImageClass(const Class* klass) {
156 if (image_classes_ == NULL) {
157 return true;
158 }
159 while (klass->IsArrayClass()) {
160 klass = klass->GetComponentType();
161 }
Elliott Hughesc3b77c72011-12-15 20:56:48 -0800162 if (klass->IsPrimitive()) {
Brian Carlstromae826982011-11-09 01:33:42 -0800163 return true;
164 }
Ian Rogers6d4d9fc2011-11-30 16:24:48 -0800165 const std::string descriptor(ClassHelper(klass).GetDescriptor());
Brian Carlstromae826982011-11-09 01:33:42 -0800166 return image_classes_->find(descriptor) != image_classes_->end();
167}
168
169
170struct NonImageClasses {
171 ImageWriter* image_writer;
172 std::set<std::string>* non_image_classes;
173};
174
175void ImageWriter::PruneNonImageClasses() {
176 if (image_classes_ == NULL) {
177 return;
178 }
179 Runtime* runtime = Runtime::Current();
180 ClassLinker* class_linker = runtime->GetClassLinker();
181
182 std::set<std::string> non_image_classes;
183 NonImageClasses context;
184 context.image_writer = this;
185 context.non_image_classes = &non_image_classes;
186 class_linker->VisitClasses(NonImageClassesVisitor, &context);
187
188 typedef std::set<std::string>::const_iterator ClassIt; // TODO: C++0x auto
189 for (ClassIt it = non_image_classes.begin(), end = non_image_classes.end(); it != end; ++it) {
Elliott Hughesc3b77c72011-12-15 20:56:48 -0800190 class_linker->RemoveClass((*it).c_str(), NULL);
Brian Carlstromae826982011-11-09 01:33:42 -0800191 }
192
Ian Rogers19846512012-02-24 11:42:47 -0800193 Method* resolution_method = runtime->GetResolutionMethod();
Brian Carlstromae826982011-11-09 01:33:42 -0800194 typedef Set::const_iterator CacheIt; // TODO: C++0x auto
195 for (CacheIt it = dex_caches_.begin(), end = dex_caches_.end(); it != end; ++it) {
196 DexCache* dex_cache = *it;
197 for (size_t i = 0; i < dex_cache->NumResolvedTypes(); i++) {
198 Class* klass = dex_cache->GetResolvedType(i);
199 if (klass != NULL && !IsImageClass(klass)) {
200 dex_cache->SetResolvedType(i, NULL);
201 dex_cache->GetInitializedStaticStorage()->Set(i, NULL);
202 }
203 }
204 for (size_t i = 0; i < dex_cache->NumResolvedMethods(); i++) {
205 Method* method = dex_cache->GetResolvedMethod(i);
206 if (method != NULL && !IsImageClass(method->GetDeclaringClass())) {
Ian Rogers19846512012-02-24 11:42:47 -0800207 dex_cache->SetResolvedMethod(i, resolution_method);
Brian Carlstromae826982011-11-09 01:33:42 -0800208 }
209 }
210 for (size_t i = 0; i < dex_cache->NumResolvedFields(); i++) {
211 Field* field = dex_cache->GetResolvedField(i);
212 if (field != NULL && !IsImageClass(field->GetDeclaringClass())) {
213 dex_cache->SetResolvedField(i, NULL);
214 }
215 }
216 }
217}
218
219bool ImageWriter::NonImageClassesVisitor(Class* klass, void* arg) {
220 NonImageClasses* context = reinterpret_cast<NonImageClasses*>(arg);
221 if (!context->image_writer->IsImageClass(klass)) {
Ian Rogers6d4d9fc2011-11-30 16:24:48 -0800222 context->non_image_classes->insert(ClassHelper(klass).GetDescriptor());
Brian Carlstromae826982011-11-09 01:33:42 -0800223 }
224 return true;
225}
226
227void ImageWriter::CheckNonImageClassesRemoved() {
228 if (image_classes_ == NULL) {
229 return;
230 }
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800231 Runtime::Current()->GetHeap()->GetLiveBits()->Walk(CheckNonImageClassesRemovedCallback, this);
Brian Carlstromae826982011-11-09 01:33:42 -0800232}
233
234void ImageWriter::CheckNonImageClassesRemovedCallback(Object* obj, void* arg) {
235 ImageWriter* image_writer = reinterpret_cast<ImageWriter*>(arg);
236 if (!obj->IsClass()) {
237 return;
238 }
239 Class* klass = obj->AsClass();
Elliott Hughesc3b77c72011-12-15 20:56:48 -0800240 if (!image_writer->IsImageClass(klass)) {
241 image_writer->DumpImageClasses();
242 CHECK(image_writer->IsImageClass(klass)) << ClassHelper(klass).GetDescriptor()
243 << " " << PrettyDescriptor(klass);
244 }
245}
246
247void ImageWriter::DumpImageClasses() {
248 typedef std::set<std::string>::const_iterator It; // TODO: C++0x auto
249 for (It it = image_classes_->begin(), end = image_classes_->end(); it != end; ++it) {
250 LOG(INFO) << " " << *it;
251 }
Brian Carlstromae826982011-11-09 01:33:42 -0800252}
253
Brian Carlstrom78128a62011-09-15 17:21:19 -0700254void ImageWriter::CalculateNewObjectOffsetsCallback(Object* obj, void* arg) {
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700255 DCHECK(obj != NULL);
256 DCHECK(arg != NULL);
257 ImageWriter* image_writer = reinterpret_cast<ImageWriter*>(arg);
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700258 if (!image_writer->InSourceSpace(obj)) {
259 return;
260 }
Brian Carlstromc74255f2011-09-11 22:47:39 -0700261
262 // if it is a string, we want to intern it if its not interned.
Elliott Hughesdbb40792011-11-18 17:05:22 -0800263 if (obj->GetClass()->IsStringClass()) {
Brian Carlstromc74255f2011-09-11 22:47:39 -0700264 // we must be an interned string that was forward referenced and already assigned
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800265 if (image_writer->IsImageOffsetAssigned(obj)) {
Brian Carlstromc74255f2011-09-11 22:47:39 -0700266 DCHECK_EQ(obj, obj->AsString()->Intern());
267 return;
268 }
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700269 SirtRef<String> interned(obj->AsString()->Intern());
270 if (obj != interned.get()) {
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800271 if (!image_writer->IsImageOffsetAssigned(interned.get())) {
Brian Carlstromc74255f2011-09-11 22:47:39 -0700272 // interned obj is after us, allocate its location early
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700273 image_writer->AssignImageOffset(interned.get());
Brian Carlstromc74255f2011-09-11 22:47:39 -0700274 }
275 // point those looking for this object to the interned version.
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800276 image_writer->SetImageOffset(obj, image_writer->GetImageOffset(interned.get()));
Brian Carlstromc74255f2011-09-11 22:47:39 -0700277 return;
278 }
279 // else (obj == interned), nothing to do but fall through to the normal case
280 }
281
282 image_writer->AssignImageOffset(obj);
Brian Carlstrom4e777d42011-08-15 13:53:52 -0700283}
284
Brian Carlstrome24fa612011-09-29 00:53:55 -0700285ObjectArray<Object>* ImageWriter::CreateImageRoots() const {
Brian Carlstrom16192862011-09-12 17:50:06 -0700286 Runtime* runtime = Runtime::Current();
287 ClassLinker* class_linker = runtime->GetClassLinker();
288 Class* object_array_class = class_linker->FindSystemClass("[Ljava/lang/Object;");
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700289
290 // build an Object[] of all the DexCaches used in the source_space_
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700291 ObjectArray<Object>* dex_caches = ObjectArray<Object>::Alloc(object_array_class,
Brian Carlstromae826982011-11-09 01:33:42 -0800292 dex_caches_.size());
293 int i = 0;
294 typedef Set::const_iterator It; // TODO: C++0x auto
295 for (It it = dex_caches_.begin(), end = dex_caches_.end(); it != end; ++it, ++i) {
296 dex_caches->Set(i, *it);
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700297 }
298
299 // build an Object[] of the roots needed to restore the runtime
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700300 SirtRef<ObjectArray<Object> > image_roots(
301 ObjectArray<Object>::Alloc(object_array_class, ImageHeader::kImageRootsMax));
Ian Rogers169c9a72011-11-13 20:13:17 -0800302 image_roots->Set(ImageHeader::kJniStubArray, runtime->GetJniDlsymLookupStub());
Brian Carlstrome24fa612011-09-29 00:53:55 -0700303 image_roots->Set(ImageHeader::kAbstractMethodErrorStubArray,
304 runtime->GetAbstractMethodErrorStubArray());
Ian Rogers1cb0a1d2011-10-06 15:24:35 -0700305 image_roots->Set(ImageHeader::kStaticResolutionStubArray,
306 runtime->GetResolutionStubArray(Runtime::kStaticMethod));
307 image_roots->Set(ImageHeader::kUnknownMethodResolutionStubArray,
308 runtime->GetResolutionStubArray(Runtime::kUnknownMethod));
Ian Rogers19846512012-02-24 11:42:47 -0800309 image_roots->Set(ImageHeader::kResolutionMethod, runtime->GetResolutionMethod());
Ian Rogers4f0d07c2011-10-06 23:38:47 -0700310 image_roots->Set(ImageHeader::kCalleeSaveMethod,
311 runtime->GetCalleeSaveMethod(Runtime::kSaveAll));
312 image_roots->Set(ImageHeader::kRefsOnlySaveMethod,
313 runtime->GetCalleeSaveMethod(Runtime::kRefsOnly));
314 image_roots->Set(ImageHeader::kRefsAndArgsSaveMethod,
315 runtime->GetCalleeSaveMethod(Runtime::kRefsAndArgs));
Brian Carlstrome24fa612011-09-29 00:53:55 -0700316 image_roots->Set(ImageHeader::kOatLocation,
317 String::AllocFromModifiedUtf8(oat_file_->GetLocation().c_str()));
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700318 image_roots->Set(ImageHeader::kDexCaches,
319 dex_caches);
Brian Carlstrom34f426c2011-10-04 12:58:02 -0700320 image_roots->Set(ImageHeader::kClassRoots,
321 class_linker->GetClassRoots());
Brian Carlstrome24fa612011-09-29 00:53:55 -0700322 for (int i = 0; i < ImageHeader::kImageRootsMax; i++) {
323 CHECK(image_roots->Get(i) != NULL);
324 }
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700325 return image_roots.get();
Brian Carlstrom16192862011-09-12 17:50:06 -0700326}
327
Brian Carlstrom4e777d42011-08-15 13:53:52 -0700328void ImageWriter::CalculateNewObjectOffsets() {
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700329 SirtRef<ObjectArray<Object> > image_roots(CreateImageRoots());
Brian Carlstrom16192862011-09-12 17:50:06 -0700330
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800331 HeapBitmap* heap_bitmap = Runtime::Current()->GetHeap()->GetLiveBits();
Brian Carlstrom4e777d42011-08-15 13:53:52 -0700332 DCHECK(heap_bitmap != NULL);
Ian Rogers30fab402012-01-23 15:43:46 -0800333 DCHECK_EQ(0U, image_end_);
Brian Carlstroma663ea52011-08-19 23:33:41 -0700334
Brian Carlstrom16192862011-09-12 17:50:06 -0700335 // leave space for the header, but do not write it yet, we need to
336 // know where image_roots is going to end up
Ian Rogers30fab402012-01-23 15:43:46 -0800337 image_end_ += RoundUp(sizeof(ImageHeader), 8); // 64-bit-alignment
Brian Carlstroma663ea52011-08-19 23:33:41 -0700338
Ian Rogers1351b672012-02-24 12:22:57 -0800339 heap_bitmap->InOrderWalk(CalculateNewObjectOffsetsCallback, this); // TODO: add Space-limited Walk
Ian Rogers30fab402012-01-23 15:43:46 -0800340 DCHECK_LT(image_end_, image_->Size());
Brian Carlstroma663ea52011-08-19 23:33:41 -0700341
Brian Carlstrome24fa612011-09-29 00:53:55 -0700342 // Note that image_top_ is left at end of used space
Ian Rogers30fab402012-01-23 15:43:46 -0800343 oat_begin_ = image_begin_ + RoundUp(image_end_, kPageSize);
344 const byte* oat_limit = oat_begin_ + oat_file_->Size();
Brian Carlstrome24fa612011-09-29 00:53:55 -0700345
Brian Carlstrom16192862011-09-12 17:50:06 -0700346 // return to write header at start of image with future location of image_roots
Ian Rogers30fab402012-01-23 15:43:46 -0800347 ImageHeader image_header(reinterpret_cast<uint32_t>(image_begin_),
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700348 reinterpret_cast<uint32_t>(GetImageAddress(image_roots.get())),
Brian Carlstrome24fa612011-09-29 00:53:55 -0700349 oat_file_->GetOatHeader().GetChecksum(),
Ian Rogers30fab402012-01-23 15:43:46 -0800350 reinterpret_cast<uint32_t>(oat_begin_),
Brian Carlstrome24fa612011-09-29 00:53:55 -0700351 reinterpret_cast<uint32_t>(oat_limit));
Ian Rogers30fab402012-01-23 15:43:46 -0800352 memcpy(image_->Begin(), &image_header, sizeof(image_header));
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700353}
354
355void ImageWriter::CopyAndFixupObjects() {
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800356 Heap* heap = Runtime::Current()->GetHeap();
357 HeapBitmap* heap_bitmap = heap->GetLiveBits();
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700358 DCHECK(heap_bitmap != NULL);
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700359 // TODO: heap validation can't handle this fix up pass
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800360 heap->DisableObjectValidation();
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700361 heap_bitmap->Walk(CopyAndFixupObjectsCallback, this); // TODO: add Space-limited Walk
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700362}
363
Brian Carlstrom78128a62011-09-15 17:21:19 -0700364void ImageWriter::CopyAndFixupObjectsCallback(Object* object, void* arg) {
Brian Carlstrom4873d462011-08-21 15:23:39 -0700365 DCHECK(object != NULL);
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700366 DCHECK(arg != NULL);
Brian Carlstrom4873d462011-08-21 15:23:39 -0700367 const Object* obj = object;
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700368 ImageWriter* image_writer = reinterpret_cast<ImageWriter*>(arg);
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700369 if (!image_writer->InSourceSpace(object)) {
370 return;
371 }
Elliott Hughesd8ddfd52011-08-15 14:32:53 -0700372
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700373 // see GetLocalAddress for similar computation
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700374 size_t offset = image_writer->GetImageOffset(obj);
Ian Rogers30fab402012-01-23 15:43:46 -0800375 byte* dst = image_writer->image_->Begin() + offset;
Brian Carlstrom4873d462011-08-21 15:23:39 -0700376 const byte* src = reinterpret_cast<const byte*>(obj);
Elliott Hughes04b63fd2011-08-16 09:40:10 -0700377 size_t n = obj->SizeOf();
Ian Rogers30fab402012-01-23 15:43:46 -0800378 DCHECK_LT(offset + n, image_writer->image_->Size());
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700379 memcpy(dst, src, n);
380 Object* copy = reinterpret_cast<Object*>(dst);
Elliott Hughesd9c67be2012-02-02 19:54:06 -0800381 copy->monitor_ = 0; // We may have inflated the lock during compilation.
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700382 image_writer->FixupObject(obj, copy);
383}
384
Brian Carlstrom4873d462011-08-21 15:23:39 -0700385void ImageWriter::FixupObject(const Object* orig, Object* copy) {
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700386 DCHECK(orig != NULL);
387 DCHECK(copy != NULL);
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700388 copy->SetClass(down_cast<Class*>(GetImageAddress(orig->GetClass())));
Brian Carlstrom9cff8e12011-08-18 16:47:29 -0700389 // TODO: special case init of pointers to malloc data (or removal of these pointers)
390 if (orig->IsClass()) {
391 FixupClass(orig->AsClass(), down_cast<Class*>(copy));
392 } else if (orig->IsObjectArray()) {
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700393 FixupObjectArray(orig->AsObjectArray<Object>(), down_cast<ObjectArray<Object>*>(copy));
Brian Carlstrom16192862011-09-12 17:50:06 -0700394 } else if (orig->IsMethod()) {
395 FixupMethod(orig->AsMethod(), down_cast<Method*>(copy));
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700396 } else {
397 FixupInstanceFields(orig, copy);
398 }
399}
400
Brian Carlstrom4873d462011-08-21 15:23:39 -0700401void ImageWriter::FixupClass(const Class* orig, Class* copy) {
Brian Carlstrom9cff8e12011-08-18 16:47:29 -0700402 FixupInstanceFields(orig, copy);
Brian Carlstrom4873d462011-08-21 15:23:39 -0700403 FixupStaticFields(orig, copy);
Brian Carlstrom9cff8e12011-08-18 16:47:29 -0700404}
405
Brian Carlstrom4873d462011-08-21 15:23:39 -0700406void ImageWriter::FixupMethod(const Method* orig, Method* copy) {
Brian Carlstroma663ea52011-08-19 23:33:41 -0700407 FixupInstanceFields(orig, copy);
Brian Carlstrome24fa612011-09-29 00:53:55 -0700408
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700409 // OatWriter replaces the code_ and invoke_stub_ with offset values.
Ian Rogers30fab402012-01-23 15:43:46 -0800410 // Here we readjust to a pointer relative to oat_begin_
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700411
412 // Every type of method can have an invoke stub
413 uint32_t invoke_stub_offset = orig->GetOatInvokeStubOffset();
Brian Carlstromae826982011-11-09 01:33:42 -0800414 const byte* invoke_stub = GetOatAddress(invoke_stub_offset);
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700415 copy->invoke_stub_ = reinterpret_cast<const Method::InvokeStub*>(invoke_stub);
416
417 if (orig->IsAbstract()) {
418 // Abstract methods are pointed to a stub that will throw AbstractMethodError if they are called
419 ByteArray* orig_ame_stub_array_ = Runtime::Current()->GetAbstractMethodErrorStubArray();
420 ByteArray* copy_ame_stub_array_ = down_cast<ByteArray*>(GetImageAddress(orig_ame_stub_array_));
421 copy->code_ = copy_ame_stub_array_->GetData();
422 return;
423 }
424
Ian Rogers19846512012-02-24 11:42:47 -0800425 if (orig == Runtime::Current()->GetResolutionMethod()) {
426 // The resolution stub's code points at the unknown resolution trampoline
427 ByteArray* orig_res_stub_array_ =
428 Runtime::Current()->GetResolutionStubArray(Runtime::kUnknownMethod);
429 CHECK(orig->GetCode() == orig_res_stub_array_->GetData());
430 ByteArray* copy_res_stub_array_ = down_cast<ByteArray*>(GetImageAddress(orig_res_stub_array_));
431 copy->code_ = copy_res_stub_array_->GetData();
432 return;
433 }
434
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700435 // Non-abstract methods typically have code
436 uint32_t code_offset = orig->GetOatCodeOffset();
Ian Rogers19846512012-02-24 11:42:47 -0800437 const byte* code = NULL;
438 if (orig->IsStatic()) {
439 // Static methods may point at the resolution trampoline stub
440 ByteArray* orig_res_stub_array_ =
441 Runtime::Current()->GetResolutionStubArray(Runtime::kStaticMethod);
442 if (reinterpret_cast<int8_t*>(code_offset) == orig_res_stub_array_->GetData()) {
443 ByteArray* copy_res_stub_array_ = down_cast<ByteArray*>(GetImageAddress(orig_res_stub_array_));
444 code = reinterpret_cast<const byte*>(copy_res_stub_array_->GetData());
445 }
446 }
447 if (code == NULL) {
448 code = GetOatAddress(code_offset);
449 }
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700450 copy->code_ = code;
451
Brian Carlstrom16192862011-09-12 17:50:06 -0700452 if (orig->IsNative()) {
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700453 // The native method's pointer is directed to a stub to lookup via dlsym.
454 // Note this is not the code_ pointer, that is handled above.
Ian Rogers169c9a72011-11-13 20:13:17 -0800455 ByteArray* orig_jni_stub_array_ = Runtime::Current()->GetJniDlsymLookupStub();
Brian Carlstrom16192862011-09-12 17:50:06 -0700456 ByteArray* copy_jni_stub_array_ = down_cast<ByteArray*>(GetImageAddress(orig_jni_stub_array_));
457 copy->native_method_ = copy_jni_stub_array_->GetData();
458 } else {
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700459 // normal (non-abstract non-native) methods have mapping tables to relocate
460 uint32_t mapping_table_off = orig->GetOatMappingTableOffset();
Brian Carlstromae826982011-11-09 01:33:42 -0800461 const byte* mapping_table = GetOatAddress(mapping_table_off);
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700462 copy->mapping_table_ = reinterpret_cast<const uint32_t*>(mapping_table);
463
464 uint32_t vmap_table_offset = orig->GetOatVmapTableOffset();
Brian Carlstromae826982011-11-09 01:33:42 -0800465 const byte* vmap_table = GetOatAddress(vmap_table_offset);
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700466 copy->vmap_table_ = reinterpret_cast<const uint16_t*>(vmap_table);
Brian Carlstrome7d856b2012-01-11 18:10:55 -0800467
468 uint32_t gc_map_offset = orig->GetOatGcMapOffset();
469 const byte* gc_map = GetOatAddress(gc_map_offset);
470 copy->gc_map_ = reinterpret_cast<const uint8_t*>(gc_map);
Brian Carlstrom16192862011-09-12 17:50:06 -0700471 }
Brian Carlstroma663ea52011-08-19 23:33:41 -0700472}
473
Brian Carlstrom4873d462011-08-21 15:23:39 -0700474void ImageWriter::FixupObjectArray(const ObjectArray<Object>* orig, ObjectArray<Object>* copy) {
Elliott Hughesd8ddfd52011-08-15 14:32:53 -0700475 for (int32_t i = 0; i < orig->GetLength(); ++i) {
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700476 const Object* element = orig->Get(i);
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700477 copy->SetWithoutChecks(i, GetImageAddress(element));
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700478 }
479}
480
Brian Carlstrom4873d462011-08-21 15:23:39 -0700481void ImageWriter::FixupInstanceFields(const Object* orig, Object* copy) {
482 DCHECK(orig != NULL);
483 DCHECK(copy != NULL);
484 Class* klass = orig->GetClass();
485 DCHECK(klass != NULL);
486 FixupFields(orig,
487 copy,
488 klass->GetReferenceInstanceOffsets(),
489 false);
490}
491
492void ImageWriter::FixupStaticFields(const Class* orig, Class* copy) {
493 DCHECK(orig != NULL);
494 DCHECK(copy != NULL);
495 FixupFields(orig,
496 copy,
497 orig->GetReferenceStaticOffsets(),
498 true);
499}
500
501void ImageWriter::FixupFields(const Object* orig,
502 Object* copy,
503 uint32_t ref_offsets,
504 bool is_static) {
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700505 if (ref_offsets != CLASS_WALK_SUPER) {
506 // Found a reference offset bitmap. Fixup the specified offsets.
507 while (ref_offsets != 0) {
508 size_t right_shift = CLZ(ref_offsets);
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700509 MemberOffset byte_offset = CLASS_OFFSET_FROM_CLZ(right_shift);
510 const Object* ref = orig->GetFieldObject<const Object*>(byte_offset, false);
511 copy->SetFieldObject(byte_offset, GetImageAddress(ref), false);
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700512 ref_offsets &= ~(CLASS_HIGH_BIT >> right_shift);
513 }
514 } else {
Brian Carlstrom4873d462011-08-21 15:23:39 -0700515 // There is no reference offset bitmap. In the non-static case,
516 // walk up the class inheritance hierarchy and find reference
517 // offsets the hard way. In the static case, just consider this
518 // class.
519 for (const Class *klass = is_static ? orig->AsClass() : orig->GetClass();
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700520 klass != NULL;
Brian Carlstrom4873d462011-08-21 15:23:39 -0700521 klass = is_static ? NULL : klass->GetSuperClass()) {
522 size_t num_reference_fields = (is_static
523 ? klass->NumReferenceStaticFields()
524 : klass->NumReferenceInstanceFields());
525 for (size_t i = 0; i < num_reference_fields; ++i) {
526 Field* field = (is_static
527 ? klass->GetStaticField(i)
528 : klass->GetInstanceField(i));
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700529 MemberOffset field_offset = field->GetOffset();
530 const Object* ref = orig->GetFieldObject<const Object*>(field_offset, false);
531 copy->SetFieldObject(field_offset, GetImageAddress(ref), false);
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700532 }
533 }
534 }
535}
536
Brian Carlstromf5822582012-03-19 22:34:31 -0700537static Method* GetReferrerMethod(const Compiler::PatchInformation* patch) {
538 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
539 Method* method = class_linker->ResolveMethod(patch->GetDexFile(),
540 patch->GetReferrerMethodIdx(),
541 patch->GetDexCache(),
542 NULL,
543 patch->GetReferrerIsDirect());
544 CHECK(method != NULL)
545 << patch->GetDexFile().GetLocation() << " " << patch->GetReferrerMethodIdx();
Brian Carlstrom0637e272012-03-20 01:07:52 -0700546 CHECK(!method->IsRuntimeMethod())
547 << patch->GetDexFile().GetLocation() << " " << patch->GetReferrerMethodIdx();
548 CHECK(patch->GetDexCache()->GetResolvedMethods()->Get(patch->GetReferrerMethodIdx()) == method)
549 << patch->GetDexFile().GetLocation() << " " << patch->GetReferrerMethodIdx() << " "
550 << PrettyMethod(patch->GetDexCache()->GetResolvedMethods()->Get(patch->GetReferrerMethodIdx())) << " "
551 << PrettyMethod(method);
Brian Carlstromf5822582012-03-19 22:34:31 -0700552 return method;
553}
554
555static Method* GetTargetMethod(const Compiler::PatchInformation* patch) {
556 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
557 Method* method = class_linker->ResolveMethod(patch->GetDexFile(),
558 patch->GetTargetMethodIdx(),
559 patch->GetDexCache(),
560 NULL,
561 patch->GetTargetIsDirect());
562 CHECK(method != NULL)
563 << patch->GetDexFile().GetLocation() << " " << patch->GetTargetMethodIdx();
Brian Carlstrom0637e272012-03-20 01:07:52 -0700564 CHECK(!method->IsRuntimeMethod())
565 << patch->GetDexFile().GetLocation() << " " << patch->GetTargetMethodIdx();
566 CHECK(patch->GetDexCache()->GetResolvedMethods()->Get(patch->GetTargetMethodIdx()) == method)
567 << patch->GetDexFile().GetLocation() << " " << patch->GetReferrerMethodIdx() << " "
568 << PrettyMethod(patch->GetDexCache()->GetResolvedMethods()->Get(patch->GetTargetMethodIdx())) << " "
569 << PrettyMethod(method);
Brian Carlstromf5822582012-03-19 22:34:31 -0700570 return method;
571}
572
573void ImageWriter::PatchOatCodeAndMethods(const Compiler& compiler) {
574 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
575
576 const std::vector<const Compiler::PatchInformation*>& code_to_patch = compiler.GetCodeToPatch();
577 for (size_t i = 0; i < code_to_patch.size(); i++) {
578 const Compiler::PatchInformation* patch = code_to_patch[i];
579 Method* target = GetTargetMethod(patch);
580 uint32_t code = reinterpret_cast<uint32_t>(class_linker->GetOatCodeFor(target));
581 uint32_t code_base = reinterpret_cast<uint32_t>(&oat_file_->GetOatHeader());
582 uint32_t code_offset = code - code_base;
583 SetPatchLocation(patch, reinterpret_cast<uint32_t>(GetOatAddress(code_offset)));
584 }
585
586 const std::vector<const Compiler::PatchInformation*>& methods_to_patch
587 = compiler.GetMethodsToPatch();
588 for (size_t i = 0; i < methods_to_patch.size(); i++) {
589 const Compiler::PatchInformation* patch = methods_to_patch[i];
590 Method* target = GetTargetMethod(patch);
591 SetPatchLocation(patch, reinterpret_cast<uint32_t>(GetImageAddress(target)));
592 }
593}
594
595void ImageWriter::SetPatchLocation(const Compiler::PatchInformation* patch, uint32_t value) {
596 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
597 Method* method = GetReferrerMethod(patch);
598 // Goodbye const, we are about to modify some code.
599 void* code = const_cast<void*>(class_linker->GetOatCodeFor(method));
600 // TODO: make this Thumb2 specific
601 uint8_t* base = reinterpret_cast<uint8_t*>(reinterpret_cast<uint32_t>(code) & ~0x1);
602 uint32_t* patch_location = reinterpret_cast<uint32_t*>(base + patch->GetLiteralOffset());
603#ifndef NDEBUG
604 const DexFile::MethodId& id = patch->GetDexFile().GetMethodId(patch->GetTargetMethodIdx());
605 uint32_t expected = reinterpret_cast<uint32_t>(&id);
606 uint32_t actual = *patch_location;
607 CHECK(actual == expected || actual == value) << std::hex
608 << "actual=" << actual
609 << "expected=" << expected
610 << "value=" << value;
611#endif
Elliott Hughesb25c3f62012-03-26 16:35:06 -0700612 *patch_location = value;
Brian Carlstromf5822582012-03-19 22:34:31 -0700613}
614
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700615} // namespace art