blob: 2d3ae445e367e6642c796ecdd2067912dc21317d [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"
35#include "object.h"
Ian Rogers6d4d9fc2011-11-30 16:24:48 -080036#include "object_utils.h"
Brian Carlstrom1f870082011-08-23 16:02:11 -070037#include "runtime.h"
Brian Carlstromdb4d5402011-08-09 12:18:28 -070038#include "space.h"
39#include "utils.h"
40
41namespace art {
42
Brian Carlstroma004aa92012-02-08 18:05:09 -080043bool ImageWriter::Write(const std::string& image_filename,
Ian Rogers30fab402012-01-23 15:43:46 -080044 uintptr_t image_begin,
Brian Carlstromae826982011-11-09 01:33:42 -080045 const std::string& oat_filename,
Brian Carlstromf5822582012-03-19 22:34:31 -070046 const std::string& oat_location,
47 const Compiler& compiler) {
Brian Carlstroma004aa92012-02-08 18:05:09 -080048 CHECK(!image_filename.empty());
Brian Carlstromaded5f72011-10-07 17:15:04 -070049
Ian Rogers30fab402012-01-23 15:43:46 -080050 CHECK_NE(image_begin, 0U);
51 image_begin_ = reinterpret_cast<byte*>(image_begin);
Brian Carlstrom69b15fb2011-09-03 12:25:21 -070052
Elliott Hughesb3bd5f02012-03-08 21:05:27 -080053 Heap* heap = Runtime::Current()->GetHeap();
Brian Carlstromfddf6f62012-03-15 16:56:45 -070054 source_space_ = heap->GetAllocSpace();
Brian Carlstrom69b15fb2011-09-03 12:25:21 -070055
Brian Carlstromae826982011-11-09 01:33:42 -080056 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
57 const std::vector<DexCache*>& all_dex_caches = class_linker->GetDexCaches();
58 for (size_t i = 0; i < all_dex_caches.size(); i++) {
59 DexCache* dex_cache = all_dex_caches[i];
60 if (InSourceSpace(dex_cache)) {
61 dex_caches_.insert(dex_cache);
62 }
63 }
64
Brian Carlstromf5822582012-03-19 22:34:31 -070065 oat_file_ = OatFile::Open(oat_filename, oat_location, NULL, true);
66 if (oat_file_ == NULL) {
Brian Carlstrome24fa612011-09-29 00:53:55 -070067 LOG(ERROR) << "Failed to open oat file " << oat_filename;
68 return false;
69 }
Brian Carlstromf5822582012-03-19 22:34:31 -070070 class_linker->RegisterOatFile(*oat_file_);
Brian Carlstrome24fa612011-09-29 00:53:55 -070071
Ian Rogersd857b632012-02-06 20:42:33 -080072 PruneNonImageClasses(); // Remove junk
73 ComputeLazyFieldsForImageClasses(); // Add useful information
Ian Rogersd1f1bf02012-02-26 16:59:20 -080074 ComputeEagerResolvedStrings();
Elliott Hughesb3bd5f02012-03-08 21:05:27 -080075 heap->CollectGarbage(false); // Remove garbage
76 heap->GetAllocSpace()->Trim(); // Trim size of source_space
Brian Carlstromae826982011-11-09 01:33:42 -080077 if (!AllocMemory()) {
Brian Carlstromdb4d5402011-08-09 12:18:28 -070078 return false;
79 }
Brian Carlstromae826982011-11-09 01:33:42 -080080#ifndef NDEBUG
81 CheckNonImageClassesRemoved();
82#endif
Elliott Hughesb3bd5f02012-03-08 21:05:27 -080083 heap->DisableCardMarking();
Brian Carlstromdb4d5402011-08-09 12:18:28 -070084 CalculateNewObjectOffsets();
85 CopyAndFixupObjects();
Brian Carlstromf5822582012-03-19 22:34:31 -070086 PatchOatCodeAndMethods(compiler);
Elliott Hughesd8ddfd52011-08-15 14:32:53 -070087
Brian Carlstroma004aa92012-02-08 18:05:09 -080088 UniquePtr<File> file(OS::OpenFile(image_filename.c_str(), true));
Elliott Hughes90a33692011-08-30 13:27:07 -070089 if (file.get() == NULL) {
Brian Carlstrome24fa612011-09-29 00:53:55 -070090 LOG(ERROR) << "Failed to open image file " << image_filename;
Brian Carlstromdb4d5402011-08-09 12:18:28 -070091 return false;
92 }
Ian Rogers30fab402012-01-23 15:43:46 -080093 bool success = file->WriteFully(image_->Begin(), image_end_);
Brian Carlstrome24fa612011-09-29 00:53:55 -070094 if (!success) {
95 PLOG(ERROR) << "Failed to write image file " << image_filename;
96 return false;
97 }
98 return true;
Brian Carlstromdb4d5402011-08-09 12:18:28 -070099}
100
Brian Carlstromae826982011-11-09 01:33:42 -0800101bool ImageWriter::AllocMemory() {
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700102 size_t size = source_space_->Size();
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700103 int prot = PROT_READ | PROT_WRITE;
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700104 size_t length = RoundUp(size, kPageSize);
Brian Carlstrom89521892011-12-07 22:05:07 -0800105 image_.reset(MemMap::MapAnonymous("image-writer-image", NULL, length, prot));
Elliott Hughes90a33692011-08-30 13:27:07 -0700106 if (image_.get() == NULL) {
Brian Carlstrome24fa612011-09-29 00:53:55 -0700107 LOG(ERROR) << "Failed to allocate memory for image file generation";
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700108 return false;
109 }
110 return true;
111}
112
Ian Rogersd418eda2012-01-30 12:14:28 -0800113void ImageWriter::ComputeLazyFieldsForImageClasses() {
114 Runtime* runtime = Runtime::Current();
115 ClassLinker* class_linker = runtime->GetClassLinker();
116 class_linker->VisitClasses(ComputeLazyFieldsForClassesVisitor, NULL);
Ian Rogers19846512012-02-24 11:42:47 -0800117
Ian Rogersd418eda2012-01-30 12:14:28 -0800118}
119
Elliott Hughes1bac54f2012-03-16 12:48:31 -0700120bool ImageWriter::ComputeLazyFieldsForClassesVisitor(Class* c, void* /*arg*/) {
121 c->ComputeName();
Ian Rogersd418eda2012-01-30 12:14:28 -0800122 return true;
123}
124
Ian Rogersd1f1bf02012-02-26 16:59:20 -0800125void ImageWriter::ComputeEagerResolvedStringsCallback(Object* obj, void* arg) {
126 if (!obj->GetClass()->IsStringClass()) {
127 return;
128 }
129 String* string = obj->AsString();
130 std::string utf8_string(string->ToModifiedUtf8());
131 ImageWriter* writer = reinterpret_cast<ImageWriter*>(arg);
132 ClassLinker* linker = Runtime::Current()->GetClassLinker();
133 typedef Set::const_iterator CacheIt; // TODO: C++0x auto
134 for (CacheIt it = writer->dex_caches_.begin(), end = writer->dex_caches_.end(); it != end; ++it) {
135 DexCache* dex_cache = *it;
136 const DexFile& dex_file = linker->FindDexFile(dex_cache);
137 const DexFile::StringId* string_id = dex_file.FindStringId(utf8_string);
138 if (string_id != NULL) {
139 // This string occurs in this dex file, assign the dex cache entry.
140 uint32_t string_idx = dex_file.GetIndexForStringId(*string_id);
141 if (dex_cache->GetResolvedString(string_idx) == NULL) {
142 dex_cache->SetResolvedString(string_idx, string);
143 }
144 }
145 }
146}
147
148void ImageWriter::ComputeEagerResolvedStrings() {
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800149 HeapBitmap* heap_bitmap = Runtime::Current()->GetHeap()->GetLiveBits();
Ian Rogersd1f1bf02012-02-26 16:59:20 -0800150 DCHECK(heap_bitmap != NULL);
151 heap_bitmap->Walk(ComputeEagerResolvedStringsCallback, this); // TODO: add Space-limited Walk
152}
153
Brian Carlstromae826982011-11-09 01:33:42 -0800154bool ImageWriter::IsImageClass(const Class* klass) {
155 if (image_classes_ == NULL) {
156 return true;
157 }
158 while (klass->IsArrayClass()) {
159 klass = klass->GetComponentType();
160 }
Elliott Hughesc3b77c72011-12-15 20:56:48 -0800161 if (klass->IsPrimitive()) {
Brian Carlstromae826982011-11-09 01:33:42 -0800162 return true;
163 }
Ian Rogers6d4d9fc2011-11-30 16:24:48 -0800164 const std::string descriptor(ClassHelper(klass).GetDescriptor());
Brian Carlstromae826982011-11-09 01:33:42 -0800165 return image_classes_->find(descriptor) != image_classes_->end();
166}
167
168
169struct NonImageClasses {
170 ImageWriter* image_writer;
171 std::set<std::string>* non_image_classes;
172};
173
174void ImageWriter::PruneNonImageClasses() {
175 if (image_classes_ == NULL) {
176 return;
177 }
178 Runtime* runtime = Runtime::Current();
179 ClassLinker* class_linker = runtime->GetClassLinker();
180
181 std::set<std::string> non_image_classes;
182 NonImageClasses context;
183 context.image_writer = this;
184 context.non_image_classes = &non_image_classes;
185 class_linker->VisitClasses(NonImageClassesVisitor, &context);
186
187 typedef std::set<std::string>::const_iterator ClassIt; // TODO: C++0x auto
188 for (ClassIt it = non_image_classes.begin(), end = non_image_classes.end(); it != end; ++it) {
Elliott Hughesc3b77c72011-12-15 20:56:48 -0800189 class_linker->RemoveClass((*it).c_str(), NULL);
Brian Carlstromae826982011-11-09 01:33:42 -0800190 }
191
Ian Rogers19846512012-02-24 11:42:47 -0800192 Method* resolution_method = runtime->GetResolutionMethod();
Brian Carlstromae826982011-11-09 01:33:42 -0800193 typedef Set::const_iterator CacheIt; // TODO: C++0x auto
194 for (CacheIt it = dex_caches_.begin(), end = dex_caches_.end(); it != end; ++it) {
195 DexCache* dex_cache = *it;
196 for (size_t i = 0; i < dex_cache->NumResolvedTypes(); i++) {
197 Class* klass = dex_cache->GetResolvedType(i);
198 if (klass != NULL && !IsImageClass(klass)) {
199 dex_cache->SetResolvedType(i, NULL);
200 dex_cache->GetInitializedStaticStorage()->Set(i, NULL);
201 }
202 }
203 for (size_t i = 0; i < dex_cache->NumResolvedMethods(); i++) {
204 Method* method = dex_cache->GetResolvedMethod(i);
205 if (method != NULL && !IsImageClass(method->GetDeclaringClass())) {
Ian Rogers19846512012-02-24 11:42:47 -0800206 dex_cache->SetResolvedMethod(i, resolution_method);
Brian Carlstromae826982011-11-09 01:33:42 -0800207 }
208 }
209 for (size_t i = 0; i < dex_cache->NumResolvedFields(); i++) {
210 Field* field = dex_cache->GetResolvedField(i);
211 if (field != NULL && !IsImageClass(field->GetDeclaringClass())) {
212 dex_cache->SetResolvedField(i, NULL);
213 }
214 }
215 }
216}
217
218bool ImageWriter::NonImageClassesVisitor(Class* klass, void* arg) {
219 NonImageClasses* context = reinterpret_cast<NonImageClasses*>(arg);
220 if (!context->image_writer->IsImageClass(klass)) {
Ian Rogers6d4d9fc2011-11-30 16:24:48 -0800221 context->non_image_classes->insert(ClassHelper(klass).GetDescriptor());
Brian Carlstromae826982011-11-09 01:33:42 -0800222 }
223 return true;
224}
225
226void ImageWriter::CheckNonImageClassesRemoved() {
227 if (image_classes_ == NULL) {
228 return;
229 }
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800230 Runtime::Current()->GetHeap()->GetLiveBits()->Walk(CheckNonImageClassesRemovedCallback, this);
Brian Carlstromae826982011-11-09 01:33:42 -0800231}
232
233void ImageWriter::CheckNonImageClassesRemovedCallback(Object* obj, void* arg) {
234 ImageWriter* image_writer = reinterpret_cast<ImageWriter*>(arg);
235 if (!obj->IsClass()) {
236 return;
237 }
238 Class* klass = obj->AsClass();
Elliott Hughesc3b77c72011-12-15 20:56:48 -0800239 if (!image_writer->IsImageClass(klass)) {
240 image_writer->DumpImageClasses();
241 CHECK(image_writer->IsImageClass(klass)) << ClassHelper(klass).GetDescriptor()
242 << " " << PrettyDescriptor(klass);
243 }
244}
245
246void ImageWriter::DumpImageClasses() {
247 typedef std::set<std::string>::const_iterator It; // TODO: C++0x auto
248 for (It it = image_classes_->begin(), end = image_classes_->end(); it != end; ++it) {
249 LOG(INFO) << " " << *it;
250 }
Brian Carlstromae826982011-11-09 01:33:42 -0800251}
252
Brian Carlstrom78128a62011-09-15 17:21:19 -0700253void ImageWriter::CalculateNewObjectOffsetsCallback(Object* obj, void* arg) {
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700254 DCHECK(obj != NULL);
255 DCHECK(arg != NULL);
256 ImageWriter* image_writer = reinterpret_cast<ImageWriter*>(arg);
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700257 if (!image_writer->InSourceSpace(obj)) {
258 return;
259 }
Brian Carlstromc74255f2011-09-11 22:47:39 -0700260
261 // if it is a string, we want to intern it if its not interned.
Elliott Hughesdbb40792011-11-18 17:05:22 -0800262 if (obj->GetClass()->IsStringClass()) {
Brian Carlstromc74255f2011-09-11 22:47:39 -0700263 // we must be an interned string that was forward referenced and already assigned
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800264 if (image_writer->IsImageOffsetAssigned(obj)) {
Brian Carlstromc74255f2011-09-11 22:47:39 -0700265 DCHECK_EQ(obj, obj->AsString()->Intern());
266 return;
267 }
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700268 SirtRef<String> interned(obj->AsString()->Intern());
269 if (obj != interned.get()) {
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800270 if (!image_writer->IsImageOffsetAssigned(interned.get())) {
Brian Carlstromc74255f2011-09-11 22:47:39 -0700271 // interned obj is after us, allocate its location early
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700272 image_writer->AssignImageOffset(interned.get());
Brian Carlstromc74255f2011-09-11 22:47:39 -0700273 }
274 // point those looking for this object to the interned version.
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800275 image_writer->SetImageOffset(obj, image_writer->GetImageOffset(interned.get()));
Brian Carlstromc74255f2011-09-11 22:47:39 -0700276 return;
277 }
278 // else (obj == interned), nothing to do but fall through to the normal case
279 }
280
281 image_writer->AssignImageOffset(obj);
Brian Carlstrom4e777d42011-08-15 13:53:52 -0700282}
283
Brian Carlstrome24fa612011-09-29 00:53:55 -0700284ObjectArray<Object>* ImageWriter::CreateImageRoots() const {
Brian Carlstrom16192862011-09-12 17:50:06 -0700285 Runtime* runtime = Runtime::Current();
286 ClassLinker* class_linker = runtime->GetClassLinker();
287 Class* object_array_class = class_linker->FindSystemClass("[Ljava/lang/Object;");
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700288
289 // build an Object[] of all the DexCaches used in the source_space_
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700290 ObjectArray<Object>* dex_caches = ObjectArray<Object>::Alloc(object_array_class,
Brian Carlstromae826982011-11-09 01:33:42 -0800291 dex_caches_.size());
292 int i = 0;
293 typedef Set::const_iterator It; // TODO: C++0x auto
294 for (It it = dex_caches_.begin(), end = dex_caches_.end(); it != end; ++it, ++i) {
295 dex_caches->Set(i, *it);
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700296 }
297
298 // build an Object[] of the roots needed to restore the runtime
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700299 SirtRef<ObjectArray<Object> > image_roots(
300 ObjectArray<Object>::Alloc(object_array_class, ImageHeader::kImageRootsMax));
Ian Rogers169c9a72011-11-13 20:13:17 -0800301 image_roots->Set(ImageHeader::kJniStubArray, runtime->GetJniDlsymLookupStub());
Brian Carlstrome24fa612011-09-29 00:53:55 -0700302 image_roots->Set(ImageHeader::kAbstractMethodErrorStubArray,
303 runtime->GetAbstractMethodErrorStubArray());
Ian Rogers1cb0a1d2011-10-06 15:24:35 -0700304 image_roots->Set(ImageHeader::kStaticResolutionStubArray,
305 runtime->GetResolutionStubArray(Runtime::kStaticMethod));
306 image_roots->Set(ImageHeader::kUnknownMethodResolutionStubArray,
307 runtime->GetResolutionStubArray(Runtime::kUnknownMethod));
Ian Rogers19846512012-02-24 11:42:47 -0800308 image_roots->Set(ImageHeader::kResolutionMethod, runtime->GetResolutionMethod());
Ian Rogers4f0d07c2011-10-06 23:38:47 -0700309 image_roots->Set(ImageHeader::kCalleeSaveMethod,
310 runtime->GetCalleeSaveMethod(Runtime::kSaveAll));
311 image_roots->Set(ImageHeader::kRefsOnlySaveMethod,
312 runtime->GetCalleeSaveMethod(Runtime::kRefsOnly));
313 image_roots->Set(ImageHeader::kRefsAndArgsSaveMethod,
314 runtime->GetCalleeSaveMethod(Runtime::kRefsAndArgs));
Brian Carlstrome24fa612011-09-29 00:53:55 -0700315 image_roots->Set(ImageHeader::kOatLocation,
316 String::AllocFromModifiedUtf8(oat_file_->GetLocation().c_str()));
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700317 image_roots->Set(ImageHeader::kDexCaches,
318 dex_caches);
Brian Carlstrom34f426c2011-10-04 12:58:02 -0700319 image_roots->Set(ImageHeader::kClassRoots,
320 class_linker->GetClassRoots());
Brian Carlstrome24fa612011-09-29 00:53:55 -0700321 for (int i = 0; i < ImageHeader::kImageRootsMax; i++) {
322 CHECK(image_roots->Get(i) != NULL);
323 }
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700324 return image_roots.get();
Brian Carlstrom16192862011-09-12 17:50:06 -0700325}
326
Brian Carlstrom4e777d42011-08-15 13:53:52 -0700327void ImageWriter::CalculateNewObjectOffsets() {
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700328 SirtRef<ObjectArray<Object> > image_roots(CreateImageRoots());
Brian Carlstrom16192862011-09-12 17:50:06 -0700329
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800330 HeapBitmap* heap_bitmap = Runtime::Current()->GetHeap()->GetLiveBits();
Brian Carlstrom4e777d42011-08-15 13:53:52 -0700331 DCHECK(heap_bitmap != NULL);
Ian Rogers30fab402012-01-23 15:43:46 -0800332 DCHECK_EQ(0U, image_end_);
Brian Carlstroma663ea52011-08-19 23:33:41 -0700333
Brian Carlstrom16192862011-09-12 17:50:06 -0700334 // leave space for the header, but do not write it yet, we need to
335 // know where image_roots is going to end up
Ian Rogers30fab402012-01-23 15:43:46 -0800336 image_end_ += RoundUp(sizeof(ImageHeader), 8); // 64-bit-alignment
Brian Carlstroma663ea52011-08-19 23:33:41 -0700337
Ian Rogers1351b672012-02-24 12:22:57 -0800338 heap_bitmap->InOrderWalk(CalculateNewObjectOffsetsCallback, this); // TODO: add Space-limited Walk
Ian Rogers30fab402012-01-23 15:43:46 -0800339 DCHECK_LT(image_end_, image_->Size());
Brian Carlstroma663ea52011-08-19 23:33:41 -0700340
Brian Carlstrome24fa612011-09-29 00:53:55 -0700341 // Note that image_top_ is left at end of used space
Ian Rogers30fab402012-01-23 15:43:46 -0800342 oat_begin_ = image_begin_ + RoundUp(image_end_, kPageSize);
343 const byte* oat_limit = oat_begin_ + oat_file_->Size();
Brian Carlstrome24fa612011-09-29 00:53:55 -0700344
Brian Carlstrom16192862011-09-12 17:50:06 -0700345 // return to write header at start of image with future location of image_roots
Ian Rogers30fab402012-01-23 15:43:46 -0800346 ImageHeader image_header(reinterpret_cast<uint32_t>(image_begin_),
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700347 reinterpret_cast<uint32_t>(GetImageAddress(image_roots.get())),
Brian Carlstrome24fa612011-09-29 00:53:55 -0700348 oat_file_->GetOatHeader().GetChecksum(),
Ian Rogers30fab402012-01-23 15:43:46 -0800349 reinterpret_cast<uint32_t>(oat_begin_),
Brian Carlstrome24fa612011-09-29 00:53:55 -0700350 reinterpret_cast<uint32_t>(oat_limit));
Ian Rogers30fab402012-01-23 15:43:46 -0800351 memcpy(image_->Begin(), &image_header, sizeof(image_header));
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700352}
353
354void ImageWriter::CopyAndFixupObjects() {
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800355 Heap* heap = Runtime::Current()->GetHeap();
356 HeapBitmap* heap_bitmap = heap->GetLiveBits();
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700357 DCHECK(heap_bitmap != NULL);
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700358 // TODO: heap validation can't handle this fix up pass
Elliott Hughesb3bd5f02012-03-08 21:05:27 -0800359 heap->DisableObjectValidation();
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700360 heap_bitmap->Walk(CopyAndFixupObjectsCallback, this); // TODO: add Space-limited Walk
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700361}
362
Brian Carlstrom78128a62011-09-15 17:21:19 -0700363void ImageWriter::CopyAndFixupObjectsCallback(Object* object, void* arg) {
Brian Carlstrom4873d462011-08-21 15:23:39 -0700364 DCHECK(object != NULL);
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700365 DCHECK(arg != NULL);
Brian Carlstrom4873d462011-08-21 15:23:39 -0700366 const Object* obj = object;
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700367 ImageWriter* image_writer = reinterpret_cast<ImageWriter*>(arg);
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700368 if (!image_writer->InSourceSpace(object)) {
369 return;
370 }
Elliott Hughesd8ddfd52011-08-15 14:32:53 -0700371
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700372 // see GetLocalAddress for similar computation
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700373 size_t offset = image_writer->GetImageOffset(obj);
Ian Rogers30fab402012-01-23 15:43:46 -0800374 byte* dst = image_writer->image_->Begin() + offset;
Brian Carlstrom4873d462011-08-21 15:23:39 -0700375 const byte* src = reinterpret_cast<const byte*>(obj);
Elliott Hughes04b63fd2011-08-16 09:40:10 -0700376 size_t n = obj->SizeOf();
Ian Rogers30fab402012-01-23 15:43:46 -0800377 DCHECK_LT(offset + n, image_writer->image_->Size());
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700378 memcpy(dst, src, n);
379 Object* copy = reinterpret_cast<Object*>(dst);
Elliott Hughesd9c67be2012-02-02 19:54:06 -0800380 copy->monitor_ = 0; // We may have inflated the lock during compilation.
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700381 image_writer->FixupObject(obj, copy);
382}
383
Brian Carlstrom4873d462011-08-21 15:23:39 -0700384void ImageWriter::FixupObject(const Object* orig, Object* copy) {
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700385 DCHECK(orig != NULL);
386 DCHECK(copy != NULL);
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700387 copy->SetClass(down_cast<Class*>(GetImageAddress(orig->GetClass())));
Brian Carlstrom9cff8e12011-08-18 16:47:29 -0700388 // TODO: special case init of pointers to malloc data (or removal of these pointers)
389 if (orig->IsClass()) {
390 FixupClass(orig->AsClass(), down_cast<Class*>(copy));
391 } else if (orig->IsObjectArray()) {
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700392 FixupObjectArray(orig->AsObjectArray<Object>(), down_cast<ObjectArray<Object>*>(copy));
Brian Carlstrom16192862011-09-12 17:50:06 -0700393 } else if (orig->IsMethod()) {
394 FixupMethod(orig->AsMethod(), down_cast<Method*>(copy));
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700395 } else {
396 FixupInstanceFields(orig, copy);
397 }
398}
399
Brian Carlstrom4873d462011-08-21 15:23:39 -0700400void ImageWriter::FixupClass(const Class* orig, Class* copy) {
Brian Carlstrom9cff8e12011-08-18 16:47:29 -0700401 FixupInstanceFields(orig, copy);
Brian Carlstrom4873d462011-08-21 15:23:39 -0700402 FixupStaticFields(orig, copy);
Brian Carlstrom9cff8e12011-08-18 16:47:29 -0700403}
404
Brian Carlstrom4873d462011-08-21 15:23:39 -0700405void ImageWriter::FixupMethod(const Method* orig, Method* copy) {
Brian Carlstroma663ea52011-08-19 23:33:41 -0700406 FixupInstanceFields(orig, copy);
Brian Carlstrome24fa612011-09-29 00:53:55 -0700407
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700408 // OatWriter replaces the code_ and invoke_stub_ with offset values.
Ian Rogers30fab402012-01-23 15:43:46 -0800409 // Here we readjust to a pointer relative to oat_begin_
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700410
411 // Every type of method can have an invoke stub
412 uint32_t invoke_stub_offset = orig->GetOatInvokeStubOffset();
Brian Carlstromae826982011-11-09 01:33:42 -0800413 const byte* invoke_stub = GetOatAddress(invoke_stub_offset);
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700414 copy->invoke_stub_ = reinterpret_cast<const Method::InvokeStub*>(invoke_stub);
415
416 if (orig->IsAbstract()) {
417 // Abstract methods are pointed to a stub that will throw AbstractMethodError if they are called
418 ByteArray* orig_ame_stub_array_ = Runtime::Current()->GetAbstractMethodErrorStubArray();
419 ByteArray* copy_ame_stub_array_ = down_cast<ByteArray*>(GetImageAddress(orig_ame_stub_array_));
420 copy->code_ = copy_ame_stub_array_->GetData();
421 return;
422 }
423
Ian Rogers19846512012-02-24 11:42:47 -0800424 if (orig == Runtime::Current()->GetResolutionMethod()) {
425 // The resolution stub's code points at the unknown resolution trampoline
426 ByteArray* orig_res_stub_array_ =
427 Runtime::Current()->GetResolutionStubArray(Runtime::kUnknownMethod);
428 CHECK(orig->GetCode() == orig_res_stub_array_->GetData());
429 ByteArray* copy_res_stub_array_ = down_cast<ByteArray*>(GetImageAddress(orig_res_stub_array_));
430 copy->code_ = copy_res_stub_array_->GetData();
431 return;
432 }
433
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700434 // Non-abstract methods typically have code
435 uint32_t code_offset = orig->GetOatCodeOffset();
Ian Rogers19846512012-02-24 11:42:47 -0800436 const byte* code = NULL;
437 if (orig->IsStatic()) {
438 // Static methods may point at the resolution trampoline stub
439 ByteArray* orig_res_stub_array_ =
440 Runtime::Current()->GetResolutionStubArray(Runtime::kStaticMethod);
441 if (reinterpret_cast<int8_t*>(code_offset) == orig_res_stub_array_->GetData()) {
442 ByteArray* copy_res_stub_array_ = down_cast<ByteArray*>(GetImageAddress(orig_res_stub_array_));
443 code = reinterpret_cast<const byte*>(copy_res_stub_array_->GetData());
444 }
445 }
446 if (code == NULL) {
447 code = GetOatAddress(code_offset);
448 }
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700449 copy->code_ = code;
450
Brian Carlstrom16192862011-09-12 17:50:06 -0700451 if (orig->IsNative()) {
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700452 // The native method's pointer is directed to a stub to lookup via dlsym.
453 // Note this is not the code_ pointer, that is handled above.
Ian Rogers169c9a72011-11-13 20:13:17 -0800454 ByteArray* orig_jni_stub_array_ = Runtime::Current()->GetJniDlsymLookupStub();
Brian Carlstrom16192862011-09-12 17:50:06 -0700455 ByteArray* copy_jni_stub_array_ = down_cast<ByteArray*>(GetImageAddress(orig_jni_stub_array_));
456 copy->native_method_ = copy_jni_stub_array_->GetData();
457 } else {
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700458 // normal (non-abstract non-native) methods have mapping tables to relocate
459 uint32_t mapping_table_off = orig->GetOatMappingTableOffset();
Brian Carlstromae826982011-11-09 01:33:42 -0800460 const byte* mapping_table = GetOatAddress(mapping_table_off);
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700461 copy->mapping_table_ = reinterpret_cast<const uint32_t*>(mapping_table);
462
463 uint32_t vmap_table_offset = orig->GetOatVmapTableOffset();
Brian Carlstromae826982011-11-09 01:33:42 -0800464 const byte* vmap_table = GetOatAddress(vmap_table_offset);
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700465 copy->vmap_table_ = reinterpret_cast<const uint16_t*>(vmap_table);
Brian Carlstrome7d856b2012-01-11 18:10:55 -0800466
467 uint32_t gc_map_offset = orig->GetOatGcMapOffset();
468 const byte* gc_map = GetOatAddress(gc_map_offset);
469 copy->gc_map_ = reinterpret_cast<const uint8_t*>(gc_map);
Brian Carlstrom16192862011-09-12 17:50:06 -0700470 }
Brian Carlstroma663ea52011-08-19 23:33:41 -0700471}
472
Brian Carlstrom4873d462011-08-21 15:23:39 -0700473void ImageWriter::FixupObjectArray(const ObjectArray<Object>* orig, ObjectArray<Object>* copy) {
Elliott Hughesd8ddfd52011-08-15 14:32:53 -0700474 for (int32_t i = 0; i < orig->GetLength(); ++i) {
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700475 const Object* element = orig->Get(i);
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700476 copy->SetWithoutChecks(i, GetImageAddress(element));
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700477 }
478}
479
Brian Carlstrom4873d462011-08-21 15:23:39 -0700480void ImageWriter::FixupInstanceFields(const Object* orig, Object* copy) {
481 DCHECK(orig != NULL);
482 DCHECK(copy != NULL);
483 Class* klass = orig->GetClass();
484 DCHECK(klass != NULL);
485 FixupFields(orig,
486 copy,
487 klass->GetReferenceInstanceOffsets(),
488 false);
489}
490
491void ImageWriter::FixupStaticFields(const Class* orig, Class* copy) {
492 DCHECK(orig != NULL);
493 DCHECK(copy != NULL);
494 FixupFields(orig,
495 copy,
496 orig->GetReferenceStaticOffsets(),
497 true);
498}
499
500void ImageWriter::FixupFields(const Object* orig,
501 Object* copy,
502 uint32_t ref_offsets,
503 bool is_static) {
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700504 if (ref_offsets != CLASS_WALK_SUPER) {
505 // Found a reference offset bitmap. Fixup the specified offsets.
506 while (ref_offsets != 0) {
507 size_t right_shift = CLZ(ref_offsets);
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700508 MemberOffset byte_offset = CLASS_OFFSET_FROM_CLZ(right_shift);
509 const Object* ref = orig->GetFieldObject<const Object*>(byte_offset, false);
510 copy->SetFieldObject(byte_offset, GetImageAddress(ref), false);
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700511 ref_offsets &= ~(CLASS_HIGH_BIT >> right_shift);
512 }
513 } else {
Brian Carlstrom4873d462011-08-21 15:23:39 -0700514 // There is no reference offset bitmap. In the non-static case,
515 // walk up the class inheritance hierarchy and find reference
516 // offsets the hard way. In the static case, just consider this
517 // class.
518 for (const Class *klass = is_static ? orig->AsClass() : orig->GetClass();
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700519 klass != NULL;
Brian Carlstrom4873d462011-08-21 15:23:39 -0700520 klass = is_static ? NULL : klass->GetSuperClass()) {
521 size_t num_reference_fields = (is_static
522 ? klass->NumReferenceStaticFields()
523 : klass->NumReferenceInstanceFields());
524 for (size_t i = 0; i < num_reference_fields; ++i) {
525 Field* field = (is_static
526 ? klass->GetStaticField(i)
527 : klass->GetInstanceField(i));
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700528 MemberOffset field_offset = field->GetOffset();
529 const Object* ref = orig->GetFieldObject<const Object*>(field_offset, false);
530 copy->SetFieldObject(field_offset, GetImageAddress(ref), false);
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700531 }
532 }
533 }
534}
535
Brian Carlstromf5822582012-03-19 22:34:31 -0700536static Method* GetReferrerMethod(const Compiler::PatchInformation* patch) {
537 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
538 Method* method = class_linker->ResolveMethod(patch->GetDexFile(),
539 patch->GetReferrerMethodIdx(),
540 patch->GetDexCache(),
541 NULL,
542 patch->GetReferrerIsDirect());
543 CHECK(method != NULL)
544 << patch->GetDexFile().GetLocation() << " " << patch->GetReferrerMethodIdx();
Brian Carlstrom0637e272012-03-20 01:07:52 -0700545 CHECK(!method->IsRuntimeMethod())
546 << patch->GetDexFile().GetLocation() << " " << patch->GetReferrerMethodIdx();
547 CHECK(patch->GetDexCache()->GetResolvedMethods()->Get(patch->GetReferrerMethodIdx()) == method)
548 << patch->GetDexFile().GetLocation() << " " << patch->GetReferrerMethodIdx() << " "
549 << PrettyMethod(patch->GetDexCache()->GetResolvedMethods()->Get(patch->GetReferrerMethodIdx())) << " "
550 << PrettyMethod(method);
Brian Carlstromf5822582012-03-19 22:34:31 -0700551 return method;
552}
553
554static Method* GetTargetMethod(const Compiler::PatchInformation* patch) {
555 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
556 Method* method = class_linker->ResolveMethod(patch->GetDexFile(),
557 patch->GetTargetMethodIdx(),
558 patch->GetDexCache(),
559 NULL,
560 patch->GetTargetIsDirect());
561 CHECK(method != NULL)
562 << patch->GetDexFile().GetLocation() << " " << patch->GetTargetMethodIdx();
Brian Carlstrom0637e272012-03-20 01:07:52 -0700563 CHECK(!method->IsRuntimeMethod())
564 << patch->GetDexFile().GetLocation() << " " << patch->GetTargetMethodIdx();
565 CHECK(patch->GetDexCache()->GetResolvedMethods()->Get(patch->GetTargetMethodIdx()) == method)
566 << patch->GetDexFile().GetLocation() << " " << patch->GetReferrerMethodIdx() << " "
567 << PrettyMethod(patch->GetDexCache()->GetResolvedMethods()->Get(patch->GetTargetMethodIdx())) << " "
568 << PrettyMethod(method);
Brian Carlstromf5822582012-03-19 22:34:31 -0700569 return method;
570}
571
572void ImageWriter::PatchOatCodeAndMethods(const Compiler& compiler) {
573 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
574
575 const std::vector<const Compiler::PatchInformation*>& code_to_patch = compiler.GetCodeToPatch();
576 for (size_t i = 0; i < code_to_patch.size(); i++) {
577 const Compiler::PatchInformation* patch = code_to_patch[i];
578 Method* target = GetTargetMethod(patch);
579 uint32_t code = reinterpret_cast<uint32_t>(class_linker->GetOatCodeFor(target));
580 uint32_t code_base = reinterpret_cast<uint32_t>(&oat_file_->GetOatHeader());
581 uint32_t code_offset = code - code_base;
582 SetPatchLocation(patch, reinterpret_cast<uint32_t>(GetOatAddress(code_offset)));
583 }
584
585 const std::vector<const Compiler::PatchInformation*>& methods_to_patch
586 = compiler.GetMethodsToPatch();
587 for (size_t i = 0; i < methods_to_patch.size(); i++) {
588 const Compiler::PatchInformation* patch = methods_to_patch[i];
589 Method* target = GetTargetMethod(patch);
590 SetPatchLocation(patch, reinterpret_cast<uint32_t>(GetImageAddress(target)));
591 }
592}
593
594void ImageWriter::SetPatchLocation(const Compiler::PatchInformation* patch, uint32_t value) {
595 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
596 Method* method = GetReferrerMethod(patch);
597 // Goodbye const, we are about to modify some code.
598 void* code = const_cast<void*>(class_linker->GetOatCodeFor(method));
599 // TODO: make this Thumb2 specific
600 uint8_t* base = reinterpret_cast<uint8_t*>(reinterpret_cast<uint32_t>(code) & ~0x1);
601 uint32_t* patch_location = reinterpret_cast<uint32_t*>(base + patch->GetLiteralOffset());
602#ifndef NDEBUG
603 const DexFile::MethodId& id = patch->GetDexFile().GetMethodId(patch->GetTargetMethodIdx());
604 uint32_t expected = reinterpret_cast<uint32_t>(&id);
605 uint32_t actual = *patch_location;
606 CHECK(actual == expected || actual == value) << std::hex
607 << "actual=" << actual
608 << "expected=" << expected
609 << "value=" << value;
610#endif
611 *patch_location = value;
612}
613
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700614} // namespace art