blob: 7c5401858705bd22a7932c7c304011abcd2be44f [file] [log] [blame]
Carl Shapiro1fb86202011-06-27 17:43:13 -07001// Copyright 2011 Google Inc. All Rights Reserved.
2
Brian Carlstrom578bbdc2011-07-21 14:07:47 -07003#include "dex_file.h"
Brian Carlstrom7e49dca2011-07-22 18:07:34 -07004
5#include <fcntl.h>
Brian Carlstrom1f870082011-08-23 16:02:11 -07006#include <limits.h>
Brian Carlstromb0460ea2011-07-29 10:08:05 -07007#include <stdio.h>
Brian Carlstrom7e49dca2011-07-22 18:07:34 -07008#include <string.h>
Brian Carlstromb0460ea2011-07-29 10:08:05 -07009#include <sys/file.h>
Brian Carlstrom7e49dca2011-07-22 18:07:34 -070010#include <sys/mman.h>
11#include <sys/stat.h>
12#include <sys/types.h>
Brian Carlstrom7e49dca2011-07-22 18:07:34 -070013
Elliott Hughes90a33692011-08-30 13:27:07 -070014#include <map>
15
16#include "UniquePtr.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070017#include "globals.h"
18#include "logging.h"
19#include "object.h"
Brian Carlstromdb4d5402011-08-09 12:18:28 -070020#include "os.h"
Brian Carlstromb0460ea2011-07-29 10:08:05 -070021#include "stringprintf.h"
22#include "thread.h"
Brian Carlstrom7e49dca2011-07-22 18:07:34 -070023#include "utils.h"
Brian Carlstromb0460ea2011-07-29 10:08:05 -070024#include "zip_archive.h"
Carl Shapiro1fb86202011-06-27 17:43:13 -070025
26namespace art {
27
Brian Carlstromf615a612011-07-23 12:50:34 -070028const byte DexFile::kDexMagic[] = { 'd', 'e', 'x', '\n' };
29const byte DexFile::kDexMagicVersion[] = { '0', '3', '5', '\0' };
Brian Carlstrom7e49dca2011-07-22 18:07:34 -070030
Brian Carlstrom74eb46a2011-08-02 20:10:14 -070031DexFile::ClassPathEntry DexFile::FindInClassPath(const StringPiece& descriptor,
Brian Carlstrom9ea1cb12011-08-24 23:18:18 -070032 const ClassPath& class_path) {
Brian Carlstrom74eb46a2011-08-02 20:10:14 -070033 for (size_t i = 0; i != class_path.size(); ++i) {
34 const DexFile* dex_file = class_path[i];
35 const DexFile::ClassDef* dex_class_def = dex_file->FindClassDef(descriptor);
36 if (dex_class_def != NULL) {
37 return ClassPathEntry(dex_file, dex_class_def);
38 }
39 }
Brian Carlstrom4a289ed2011-08-16 17:17:49 -070040 // TODO: remove reinterpret_cast when issue with -std=gnu++0x host issue resolved
Brian Carlstrom7e93b502011-08-04 14:16:22 -070041 return ClassPathEntry(reinterpret_cast<const DexFile*>(NULL),
42 reinterpret_cast<const DexFile::ClassDef*>(NULL));
Brian Carlstrom74eb46a2011-08-02 20:10:14 -070043}
44
Brian Carlstrom78128a62011-09-15 17:21:19 -070045void DexFile::OpenDexFiles(std::vector<const char*>& dex_filenames,
46 std::vector<const DexFile*>& dex_files,
47 const std::string& strip_location_prefix) {
48 for (size_t i = 0; i < dex_filenames.size(); i++) {
49 const char* dex_filename = dex_filenames[i];
50 const DexFile* dex_file = Open(dex_filename, strip_location_prefix);
51 if (dex_file == NULL) {
52 fprintf(stderr, "could not open .dex from file %s\n", dex_filename);
53 exit(EXIT_FAILURE);
54 }
55 dex_files.push_back(dex_file);
56 }
57}
58
Brian Carlstrom16192862011-09-12 17:50:06 -070059const DexFile* DexFile::Open(const std::string& filename,
60 const std::string& strip_location_prefix) {
Brian Carlstrom69b15fb2011-09-03 12:25:21 -070061 if (filename.size() < 4) {
62 LOG(WARNING) << "Ignoring short classpath entry '" << filename << "'";
63 return NULL;
64 }
65 std::string suffix(filename.substr(filename.size() - 4));
66 if (suffix == ".zip" || suffix == ".jar" || suffix == ".apk") {
Brian Carlstrom16192862011-09-12 17:50:06 -070067 return DexFile::OpenZip(filename, strip_location_prefix);
Brian Carlstrom69b15fb2011-09-03 12:25:21 -070068 } else {
Brian Carlstrom16192862011-09-12 17:50:06 -070069 return DexFile::OpenFile(filename, filename, strip_location_prefix);
Brian Carlstrom69b15fb2011-09-03 12:25:21 -070070 }
71}
72
Brian Carlstromf615a612011-07-23 12:50:34 -070073DexFile::Closer::~Closer() {}
Brian Carlstrom7e49dca2011-07-22 18:07:34 -070074
Brian Carlstromf615a612011-07-23 12:50:34 -070075DexFile::MmapCloser::MmapCloser(void* addr, size_t length) : addr_(addr), length_(length) {
Brian Carlstrom7e49dca2011-07-22 18:07:34 -070076 CHECK(addr != NULL);
77}
Brian Carlstromf615a612011-07-23 12:50:34 -070078DexFile::MmapCloser::~MmapCloser() {
Brian Carlstrom7e49dca2011-07-22 18:07:34 -070079 if (munmap(addr_, length_) == -1) {
80 PLOG(INFO) << "munmap failed";
81 }
82}
83
Brian Carlstromf615a612011-07-23 12:50:34 -070084DexFile::PtrCloser::PtrCloser(byte* addr) : addr_(addr) {}
85DexFile::PtrCloser::~PtrCloser() { delete[] addr_; }
Brian Carlstrom7e49dca2011-07-22 18:07:34 -070086
Brian Carlstrom16192862011-09-12 17:50:06 -070087const DexFile* DexFile::OpenFile(const std::string& filename,
88 const std::string& original_location,
89 const std::string& strip_location_prefix) {
90 StringPiece location = original_location;
91 if (!location.starts_with(strip_location_prefix)) {
92 LOG(ERROR) << filename << " does not start with " << strip_location_prefix;
93 return NULL;
94 }
95 location.remove_prefix(strip_location_prefix.size());
Brian Carlstromb0460ea2011-07-29 10:08:05 -070096 int fd = open(filename.c_str(), O_RDONLY); // TODO: scoped_fd
Brian Carlstrom7e49dca2011-07-22 18:07:34 -070097 if (fd == -1) {
98 PLOG(ERROR) << "open(\"" << filename << "\", O_RDONLY) failed";
99 return NULL;
100 }
101 struct stat sbuf;
102 memset(&sbuf, 0, sizeof(sbuf));
103 if (fstat(fd, &sbuf) == -1) {
104 PLOG(ERROR) << "fstat \"" << filename << "\" failed";
105 close(fd);
106 return NULL;
107 }
108 size_t length = sbuf.st_size;
109 void* addr = mmap(NULL, length, PROT_READ, MAP_SHARED, fd, 0);
110 if (addr == MAP_FAILED) {
111 PLOG(ERROR) << "mmap \"" << filename << "\" failed";
112 close(fd);
113 return NULL;
114 }
115 close(fd);
116 byte* dex_file = reinterpret_cast<byte*>(addr);
117 Closer* closer = new MmapCloser(addr, length);
Brian Carlstrom16192862011-09-12 17:50:06 -0700118 return Open(dex_file, length, location.ToString(), closer);
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700119}
120
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700121static const char* kClassesDex = "classes.dex";
122
123class LockedFd {
124 public:
125 static LockedFd* CreateAndLock(std::string& name, mode_t mode) {
126 int fd = open(name.c_str(), O_CREAT | O_RDWR, mode);
127 if (fd == -1) {
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700128 PLOG(ERROR) << "Failed to open file '" << name << "'";
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700129 return NULL;
130 }
131 fchmod(fd, mode);
132
133 LOG(INFO) << "locking file " << name << " (fd=" << fd << ")";
134 int result = flock(fd, LOCK_EX | LOCK_NB);
135 if (result == -1) {
136 LOG(WARNING) << "sleeping while locking file " << name;
137 result = flock(fd, LOCK_EX);
138 }
139 if (result == -1 ) {
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700140 PLOG(ERROR) << "Failed to lock file '" << name << "'";
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700141 close(fd);
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700142 return NULL;
143 }
144 return new LockedFd(fd);
145 }
146
147 int GetFd() const {
148 return fd_;
149 }
150
151 ~LockedFd() {
152 if (fd_ != -1) {
153 int result = flock(fd_, LOCK_UN);
154 if (result == -1) {
155 PLOG(WARNING) << "flock(" << fd_ << ", LOCK_UN) failed";
156 }
157 close(fd_);
158 }
159 }
160
161 private:
162 LockedFd(int fd) : fd_(fd) {}
163
164 int fd_;
165};
166
167class TmpFile {
168 public:
169 TmpFile(const std::string name) : name_(name) {}
170 ~TmpFile() {
171 unlink(name_.c_str());
172 }
173 private:
174 const std::string name_;
175};
176
177// Open classes.dex from within a .zip, .jar, .apk, ...
Brian Carlstrom16192862011-09-12 17:50:06 -0700178const DexFile* DexFile::OpenZip(const std::string& filename,
179 const std::string& strip_location_prefix) {
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700180
181 // First, look for a ".dex" alongside the jar file. It will have
182 // the same name/path except for the extension.
183
184 // Example filename = dir/foo.jar
185 std::string adjacent_dex_filename(filename);
186 size_t found = adjacent_dex_filename.find_last_of(".");
187 if (found == std::string::npos) {
Brian Carlstrom16192862011-09-12 17:50:06 -0700188 LOG(ERROR) << "No . in filename" << filename;
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700189 return NULL;
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700190 }
191 adjacent_dex_filename.replace(adjacent_dex_filename.begin() + found,
192 adjacent_dex_filename.end(),
193 ".dex");
194 // Example adjacent_dex_filename = dir/foo.dex
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700195 if (OS::FileExists(adjacent_dex_filename.c_str())) {
Brian Carlstrom16192862011-09-12 17:50:06 -0700196 const DexFile* adjacent_dex_file = DexFile::OpenFile(adjacent_dex_filename,
197 filename,
198 strip_location_prefix);
Elliott Hughese0fc0ef2011-08-12 17:39:17 -0700199 if (adjacent_dex_file != NULL) {
Brian Carlstrom4e777d42011-08-15 13:53:52 -0700200 // We don't verify anything in this case, because we aren't in
201 // the cache and typically the file is in the readonly /system
202 // area, so if something is wrong, there is nothing we can do.
203 return adjacent_dex_file;
Elliott Hughese0fc0ef2011-08-12 17:39:17 -0700204 }
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700205 return NULL;
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700206 }
207
208 char resolved[PATH_MAX];
209 char* absolute_path = realpath(filename.c_str(), resolved);
210 if (absolute_path == NULL) {
Brian Carlstrom16192862011-09-12 17:50:06 -0700211 LOG(ERROR) << "Failed to create absolute path for " << filename
212 << " when looking for classes.dex";
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700213 return NULL;
214 }
215 std::string cache_file(absolute_path+1); // skip leading slash
216 std::replace(cache_file.begin(), cache_file.end(), '/', '@');
217 cache_file.push_back('@');
218 cache_file.append(kClassesDex);
219 // Example cache_file = parent@dir@foo.jar@classes.dex
220
221 const char* data_root = getenv("ANDROID_DATA");
222 if (data_root == NULL) {
Brian Carlstrom16192862011-09-12 17:50:06 -0700223 if (OS::DirectoryExists("/data")) {
224 data_root = "/data";
225 } else {
226 data_root = "/tmp";
227 }
228 }
229 if (!OS::DirectoryExists(data_root)) {
230 LOG(ERROR) << "Failed to find ANDROID_DATA directory " << data_root;
231 return NULL;
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700232 }
233
Brian Carlstrom16192862011-09-12 17:50:06 -0700234 std::string art_cache = StringPrintf("%s/art-cache", data_root);
235
236 if (!OS::DirectoryExists(art_cache.c_str())) {
237 if (StringPiece(art_cache).starts_with("/tmp/")) {
238 int result = mkdir(art_cache.c_str(), 0700);
239 if (result != 0) {
Elliott Hughes380fac02011-09-16 16:01:07 -0700240 LOG(FATAL) << "Failed to create art-cache directory " << art_cache;
Brian Carlstrom16192862011-09-12 17:50:06 -0700241 return NULL;
242 }
243 } else {
Elliott Hughes380fac02011-09-16 16:01:07 -0700244 LOG(FATAL) << "Failed to find art-cache directory " << art_cache;
Brian Carlstrom16192862011-09-12 17:50:06 -0700245 return NULL;
246 }
247 }
248
249 std::string cache_path_tmp = StringPrintf("%s/%s", art_cache.c_str(), cache_file.c_str());
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700250 // Example cache_path_tmp = /data/art-cache/parent@dir@foo.jar@classes.dex
251
Elliott Hughes90a33692011-08-30 13:27:07 -0700252 UniquePtr<ZipArchive> zip_archive(ZipArchive::Open(filename));
253 if (zip_archive.get() == NULL) {
Brian Carlstrom16192862011-09-12 17:50:06 -0700254 LOG(ERROR) << "Failed to open " << filename << " when looking for classes.dex";
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700255 return NULL;
256 }
Elliott Hughes90a33692011-08-30 13:27:07 -0700257 UniquePtr<ZipEntry> zip_entry(zip_archive->Find(kClassesDex));
258 if (zip_entry.get() == NULL) {
Brian Carlstrom16192862011-09-12 17:50:06 -0700259 LOG(ERROR) << "Failed to find classes.dex within " << filename;
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700260 return NULL;
261 }
262
263 std::string cache_path = StringPrintf("%s.%08x", cache_path_tmp.c_str(), zip_entry->GetCrc32());
264 // Example cache_path = /data/art-cache/parent@dir@foo.jar@classes.dex.1a2b3c4d
265
266 while (true) {
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700267 if (OS::FileExists(cache_path.c_str())) {
Brian Carlstrom16192862011-09-12 17:50:06 -0700268 const DexFile* cached_dex_file = DexFile::OpenFile(cache_path,
269 filename,
270 strip_location_prefix);
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700271 if (cached_dex_file != NULL) {
272 return cached_dex_file;
273 }
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700274 }
275
276 // Try to open the temporary cache file, grabbing an exclusive
277 // lock. If somebody else is working on it, we'll block here until
278 // they complete. Because we're waiting on an external resource,
279 // we go into native mode.
Elliott Hughes40ef99e2011-08-11 17:44:34 -0700280 // Note that current_thread can be NULL if we're parsing the bootclasspath
281 // during JNI_CreateJavaVM.
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700282 Thread* current_thread = Thread::Current();
Elliott Hughesd92bec42011-09-02 17:04:36 -0700283 Thread::State old(Thread::kUnknown);
Elliott Hughes40ef99e2011-08-11 17:44:34 -0700284 if (current_thread != NULL) {
Elliott Hughesad7c2a32011-08-31 11:58:10 -0700285 old = current_thread->SetState(Thread::kNative);
Elliott Hughes40ef99e2011-08-11 17:44:34 -0700286 }
Elliott Hughes90a33692011-08-30 13:27:07 -0700287 UniquePtr<LockedFd> fd(LockedFd::CreateAndLock(cache_path_tmp, 0644));
Elliott Hughes40ef99e2011-08-11 17:44:34 -0700288 if (current_thread != NULL) {
289 current_thread->SetState(old);
290 }
Elliott Hughes90a33692011-08-30 13:27:07 -0700291 if (fd.get() == NULL) {
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700292 return NULL;
293 }
294
295 // Check to see if the fd we opened and locked matches the file in
296 // the filesystem. If they don't, then somebody else unlinked
297 // ours and created a new file, and we need to use that one
298 // instead. (If we caught them between the unlink and the create,
299 // we'll get an ENOENT from the file stat.)
300 struct stat fd_stat;
301 int fd_stat_result = fstat(fd->GetFd(), &fd_stat);
302 if (fd_stat_result == -1) {
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700303 PLOG(ERROR) << "Failed to stat open file '" << cache_path_tmp << "'";
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700304 return NULL;
305 }
306 struct stat file_stat;
307 int file_stat_result = stat(cache_path_tmp.c_str(), &file_stat);
308 if (file_stat_result == -1 ||
309 fd_stat.st_dev != file_stat.st_dev || fd_stat.st_ino != file_stat.st_ino) {
310 LOG(WARNING) << "our open cache file is stale; sleeping and retrying";
311 usleep(250 * 1000); // if something is hosed, don't peg machine
312 continue;
313 }
314
315 // We have the correct file open and locked. Extract classes.dex
316 TmpFile tmp_file(cache_path_tmp);
Elliott Hughes90a33692011-08-30 13:27:07 -0700317 UniquePtr<File> file(OS::FileFromFd(cache_path_tmp.c_str(), fd->GetFd()));
318 if (file.get() == NULL) {
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700319 return NULL;
320 }
321 bool success = zip_entry->Extract(*file);
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700322 if (!success) {
323 return NULL;
324 }
325
Brian Carlstrom4a289ed2011-08-16 17:17:49 -0700326 // TODO: restat and check length against zip_entry->GetUncompressedLength()?
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700327
328 // Compute checksum and compare to zip. If things look okay, rename from tmp.
329 off_t lseek_result = lseek(fd->GetFd(), 0, SEEK_SET);
330 if (lseek_result == -1) {
331 return NULL;
332 }
333 const size_t kBufSize = 32768;
Elliott Hughes90a33692011-08-30 13:27:07 -0700334 UniquePtr<uint8_t[]> buf(new uint8_t[kBufSize]);
335 if (buf.get() == NULL) {
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700336 return NULL;
337 }
338 uint32_t computed_crc = crc32(0L, Z_NULL, 0);
339 while (true) {
340 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd->GetFd(), buf.get(), kBufSize));
Brian Carlstrom0024d6c2011-08-09 08:26:12 -0700341 if (bytes_read == -1) {
342 PLOG(ERROR) << "Problem computing CRC of '" << cache_path_tmp << "'";
343 return NULL;
344 }
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700345 if (bytes_read == 0) {
346 break;
347 }
348 computed_crc = crc32(computed_crc, buf.get(), bytes_read);
349 }
350 if (computed_crc != zip_entry->GetCrc32()) {
351 return NULL;
352 }
353 int rename_result = rename(cache_path_tmp.c_str(), cache_path.c_str());
354 if (rename_result == -1) {
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700355 PLOG(ERROR) << "Failed to install dex cache file '" << cache_path << "'"
Brian Carlstrom0024d6c2011-08-09 08:26:12 -0700356 << " from '" << cache_path_tmp << "'";
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700357 unlink(cache_path.c_str());
358 }
359 }
360 // NOTREACHED
361}
362
Brian Carlstrom9f30b382011-08-28 22:41:38 -0700363const DexFile* DexFile::OpenPtr(byte* ptr, size_t length, const std::string& location) {
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700364 CHECK(ptr != NULL);
Brian Carlstromf615a612011-07-23 12:50:34 -0700365 DexFile::Closer* closer = new PtrCloser(ptr);
Brian Carlstroma663ea52011-08-19 23:33:41 -0700366 return Open(ptr, length, location, closer);
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700367}
368
Brian Carlstrom9f30b382011-08-28 22:41:38 -0700369const DexFile* DexFile::Open(const byte* dex_bytes, size_t length,
370 const std::string& location, Closer* closer) {
Elliott Hughes90a33692011-08-30 13:27:07 -0700371 UniquePtr<DexFile> dex_file(new DexFile(dex_bytes, length, location, closer));
Brian Carlstromf615a612011-07-23 12:50:34 -0700372 if (!dex_file->Init()) {
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700373 return NULL;
374 } else {
Brian Carlstromf615a612011-07-23 12:50:34 -0700375 return dex_file.release();
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700376 }
377}
378
Brian Carlstromf615a612011-07-23 12:50:34 -0700379DexFile::~DexFile() {}
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700380
Brian Carlstromf615a612011-07-23 12:50:34 -0700381bool DexFile::Init() {
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700382 InitMembers();
383 if (!IsMagicValid()) {
384 return false;
385 }
386 InitIndex();
387 return true;
388}
389
Brian Carlstromf615a612011-07-23 12:50:34 -0700390void DexFile::InitMembers() {
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700391 const byte* b = base_;
392 header_ = reinterpret_cast<const Header*>(b);
393 const Header* h = header_;
394 string_ids_ = reinterpret_cast<const StringId*>(b + h->string_ids_off_);
395 type_ids_ = reinterpret_cast<const TypeId*>(b + h->type_ids_off_);
396 field_ids_ = reinterpret_cast<const FieldId*>(b + h->field_ids_off_);
397 method_ids_ = reinterpret_cast<const MethodId*>(b + h->method_ids_off_);
398 proto_ids_ = reinterpret_cast<const ProtoId*>(b + h->proto_ids_off_);
399 class_defs_ = reinterpret_cast<const ClassDef*>(b + h->class_defs_off_);
400}
401
Brian Carlstromf615a612011-07-23 12:50:34 -0700402bool DexFile::IsMagicValid() {
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700403 return CheckMagic(header_->magic_);
404}
405
Brian Carlstromf615a612011-07-23 12:50:34 -0700406bool DexFile::CheckMagic(const byte* magic) {
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700407 CHECK(magic != NULL);
408 if (memcmp(magic, kDexMagic, sizeof(kDexMagic)) != 0) {
Brian Carlstrom16192862011-09-12 17:50:06 -0700409 LOG(ERROR) << "Unrecognized magic number:"
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700410 << " " << magic[0]
411 << " " << magic[1]
412 << " " << magic[2]
413 << " " << magic[3];
414 return false;
415 }
416 const byte* version = &magic[sizeof(kDexMagic)];
417 if (memcmp(version, kDexMagicVersion, sizeof(kDexMagicVersion)) != 0) {
Brian Carlstrom16192862011-09-12 17:50:06 -0700418 LOG(ERROR) << "Unrecognized version number:"
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700419 << " " << version[0]
420 << " " << version[1]
421 << " " << version[2]
422 << " " << version[3];
423 return false;
424 }
425 return true;
426}
427
Brian Carlstromf615a612011-07-23 12:50:34 -0700428void DexFile::InitIndex() {
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700429 CHECK_EQ(index_.size(), 0U);
430 for (size_t i = 0; i < NumClassDefs(); ++i) {
431 const ClassDef& class_def = GetClassDef(i);
432 const char* descriptor = GetClassDescriptor(class_def);
433 index_[descriptor] = &class_def;
434 }
435}
436
Brian Carlstromf615a612011-07-23 12:50:34 -0700437const DexFile::ClassDef* DexFile::FindClassDef(const StringPiece& descriptor) const {
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700438 Index::const_iterator it = index_.find(descriptor);
439 if (it == index_.end()) {
440 return NULL;
441 } else {
442 return it->second;
443 }
444}
445
Carl Shapiro419ec7b2011-08-03 14:48:33 -0700446// Materializes the method descriptor for a method prototype. Method
447// descriptors are not stored directly in the dex file. Instead, one
448// must assemble the descriptor from references in the prototype.
Elliott Hughes0c424cb2011-08-26 10:16:25 -0700449std::string DexFile::CreateMethodDescriptor(uint32_t proto_idx,
450 int32_t* unicode_length) const {
Carl Shapiro419ec7b2011-08-03 14:48:33 -0700451 const ProtoId& proto_id = GetProtoId(proto_idx);
452 std::string descriptor;
453 descriptor.push_back('(');
454 const TypeList* type_list = GetProtoParameters(proto_id);
455 size_t parameter_length = 0;
456 if (type_list != NULL) {
457 // A non-zero number of arguments. Append the type names.
458 for (size_t i = 0; i < type_list->Size(); ++i) {
459 const TypeItem& type_item = type_list->GetTypeItem(i);
460 uint32_t type_idx = type_item.type_idx_;
461 int32_t type_length;
462 const char* name = dexStringByTypeIdx(type_idx, &type_length);
463 parameter_length += type_length;
464 descriptor.append(name);
465 }
466 }
467 descriptor.push_back(')');
468 uint32_t return_type_idx = proto_id.return_type_idx_;
469 int32_t return_type_length;
470 const char* name = dexStringByTypeIdx(return_type_idx, &return_type_length);
471 descriptor.append(name);
Brian Carlstrom20cfffa2011-08-26 02:31:27 -0700472 if (unicode_length != NULL) {
473 *unicode_length = parameter_length + return_type_length + 2; // 2 for ( and )
474 }
Elliott Hughes0c424cb2011-08-26 10:16:25 -0700475 return descriptor;
Carl Shapiro419ec7b2011-08-03 14:48:33 -0700476}
477
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700478// Read a signed integer. "zwidth" is the zero-based byte count.
479static int32_t ReadSignedInt(const byte* ptr, int zwidth)
480{
481 int32_t val = 0;
482 for (int i = zwidth; i >= 0; --i) {
483 val = ((uint32_t)val >> 8) | (((int32_t)*ptr++) << 24);
484 }
485 val >>= (3 - zwidth) * 8;
486 return val;
487}
488
489// Read an unsigned integer. "zwidth" is the zero-based byte count,
490// "fill_on_right" indicates which side we want to zero-fill from.
491static uint32_t ReadUnsignedInt(const byte* ptr, int zwidth,
492 bool fill_on_right) {
493 uint32_t val = 0;
494 if (!fill_on_right) {
495 for (int i = zwidth; i >= 0; --i) {
496 val = (val >> 8) | (((uint32_t)*ptr++) << 24);
497 }
498 val >>= (3 - zwidth) * 8;
499 } else {
500 for (int i = zwidth; i >= 0; --i) {
501 val = (val >> 8) | (((uint32_t)*ptr++) << 24);
502 }
503 }
504 return val;
505}
506
507// Read a signed long. "zwidth" is the zero-based byte count.
508static int64_t ReadSignedLong(const byte* ptr, int zwidth) {
509 int64_t val = 0;
510 for (int i = zwidth; i >= 0; --i) {
511 val = ((uint64_t)val >> 8) | (((int64_t)*ptr++) << 56);
512 }
513 val >>= (7 - zwidth) * 8;
514 return val;
515}
516
517// Read an unsigned long. "zwidth" is the zero-based byte count,
518// "fill_on_right" indicates which side we want to zero-fill from.
519static uint64_t ReadUnsignedLong(const byte* ptr, int zwidth,
520 bool fill_on_right) {
521 uint64_t val = 0;
522 if (!fill_on_right) {
523 for (int i = zwidth; i >= 0; --i) {
524 val = (val >> 8) | (((uint64_t)*ptr++) << 56);
525 }
526 val >>= (7 - zwidth) * 8;
527 } else {
528 for (int i = zwidth; i >= 0; --i) {
529 val = (val >> 8) | (((uint64_t)*ptr++) << 56);
530 }
531 }
532 return val;
533}
534
Brian Carlstromf615a612011-07-23 12:50:34 -0700535DexFile::ValueType DexFile::ReadEncodedValue(const byte** stream,
536 JValue* value) const {
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700537 const byte* ptr = *stream;
538 byte value_type = *ptr++;
539 byte value_arg = value_type >> kEncodedValueArgShift;
540 size_t width = value_arg + 1; // assume and correct later
541 int type = value_type & kEncodedValueTypeMask;
542 switch (type) {
Brian Carlstromf615a612011-07-23 12:50:34 -0700543 case DexFile::kByte: {
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700544 int32_t b = ReadSignedInt(ptr, value_arg);
545 CHECK(IsInt(8, b));
546 value->i = b;
547 break;
548 }
Brian Carlstromf615a612011-07-23 12:50:34 -0700549 case DexFile::kShort: {
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700550 int32_t s = ReadSignedInt(ptr, value_arg);
551 CHECK(IsInt(16, s));
552 value->i = s;
553 break;
554 }
Brian Carlstromf615a612011-07-23 12:50:34 -0700555 case DexFile::kChar: {
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700556 uint32_t c = ReadUnsignedInt(ptr, value_arg, false);
557 CHECK(IsUint(16, c));
558 value->i = c;
559 break;
560 }
Brian Carlstromf615a612011-07-23 12:50:34 -0700561 case DexFile::kInt:
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700562 value->i = ReadSignedInt(ptr, value_arg);
563 break;
Brian Carlstromf615a612011-07-23 12:50:34 -0700564 case DexFile::kLong:
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700565 value->j = ReadSignedLong(ptr, value_arg);
566 break;
Brian Carlstromf615a612011-07-23 12:50:34 -0700567 case DexFile::kFloat:
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700568 value->i = ReadUnsignedInt(ptr, value_arg, true);
569 break;
Brian Carlstromf615a612011-07-23 12:50:34 -0700570 case DexFile::kDouble:
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700571 value->j = ReadUnsignedLong(ptr, value_arg, true);
572 break;
Brian Carlstromf615a612011-07-23 12:50:34 -0700573 case DexFile::kBoolean:
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700574 value->i = (value_arg != 0);
575 width = 0;
576 break;
Brian Carlstromf615a612011-07-23 12:50:34 -0700577 case DexFile::kString:
578 case DexFile::kType:
579 case DexFile::kMethod:
580 case DexFile::kEnum:
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700581 value->i = ReadUnsignedInt(ptr, value_arg, false);
582 break;
Brian Carlstromf615a612011-07-23 12:50:34 -0700583 case DexFile::kField:
584 case DexFile::kArray:
585 case DexFile::kAnnotation:
Elliott Hughes53b61312011-08-12 18:28:20 -0700586 UNIMPLEMENTED(FATAL) << ": type " << type;
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700587 break;
Brian Carlstromf615a612011-07-23 12:50:34 -0700588 case DexFile::kNull:
Brian Carlstrom7e49dca2011-07-22 18:07:34 -0700589 value->i = 0;
590 width = 0;
591 break;
592 default:
593 LOG(FATAL) << "Unreached";
594 }
595 ptr += width;
596 *stream = ptr;
597 return static_cast<ValueType>(type);
Carl Shapiro1fb86202011-06-27 17:43:13 -0700598}
599
Shih-wei Liao55df06b2011-08-26 14:39:27 -0700600String* DexFile::dexArtStringById(int32_t idx) const {
601 if (idx == -1) {
602 return NULL;
603 }
Shih-wei Liao195487c2011-08-20 13:29:04 -0700604 return String::AllocFromModifiedUtf8(dexStringById(idx));
605}
606
607int32_t DexFile::GetLineNumFromPC(const art::Method* method, uint32_t rel_pc) const {
Shih-wei Liaoff0f9be2011-08-29 15:43:53 -0700608 // For native method, lineno should be -2 to indicate it is native. Note that
609 // "line number == -2" is how libcore tells from StackTraceElement.
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700610 if (method->GetCodeItemOffset() == 0) {
Shih-wei Liaoff0f9be2011-08-29 15:43:53 -0700611 return -2;
612 }
613
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700614 const CodeItem* code_item = GetCodeItem(method->GetCodeItemOffset());
Shih-wei Liao195487c2011-08-20 13:29:04 -0700615 DCHECK(code_item != NULL);
616
617 // A method with no line number info should return -1
618 LineNumFromPcContext context(rel_pc, -1);
619 dexDecodeDebugInfo(code_item, method, LineNumForPcCb, NULL, &context);
620 return context.line_num_;
621}
622
623void DexFile::dexDecodeDebugInfo0(const CodeItem* code_item, const art::Method* method,
624 DexDebugNewPositionCb posCb, DexDebugNewLocalCb local_cb,
625 void* cnxt, const byte* stream, LocalInfo* local_in_reg) const {
626 uint32_t line = DecodeUnsignedLeb128(&stream);
627 uint32_t parameters_size = DecodeUnsignedLeb128(&stream);
628 uint16_t arg_reg = code_item->registers_size_ - code_item->ins_size_;
629 uint32_t address = 0;
630
631 if (!method->IsStatic()) {
632 local_in_reg[arg_reg].name_ = String::AllocFromModifiedUtf8("this");
633 local_in_reg[arg_reg].descriptor_ = method->GetDeclaringClass()->GetDescriptor();
634 local_in_reg[arg_reg].signature_ = NULL;
635 local_in_reg[arg_reg].start_address_ = 0;
636 local_in_reg[arg_reg].is_live_ = true;
637 arg_reg++;
638 }
639
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700640 ParameterIterator *it = GetParameterIterator(GetProtoId(method->GetProtoIdx()));
Shih-wei Liao195487c2011-08-20 13:29:04 -0700641 for (uint32_t i = 0; i < parameters_size && it->HasNext(); ++i, it->Next()) {
642 if (arg_reg >= code_item->registers_size_) {
643 LOG(FATAL) << "invalid stream";
644 return;
645 }
646
647 String* descriptor = String::AllocFromModifiedUtf8(it->GetDescriptor());
648 String* name = dexArtStringById(DecodeUnsignedLeb128P1(&stream));
649
650 local_in_reg[arg_reg].name_ = name;
651 local_in_reg[arg_reg].descriptor_ = descriptor;
652 local_in_reg[arg_reg].signature_ = NULL;
653 local_in_reg[arg_reg].start_address_ = address;
654 local_in_reg[arg_reg].is_live_ = true;
655 switch (descriptor->CharAt(0)) {
656 case 'D':
657 case 'J':
658 arg_reg += 2;
659 break;
660 default:
661 arg_reg += 1;
662 break;
663 }
664 }
665
666 if (it->HasNext()) {
667 LOG(FATAL) << "invalid stream";
668 return;
669 }
670
671 for (;;) {
672 uint8_t opcode = *stream++;
673 uint8_t adjopcode = opcode - DBG_FIRST_SPECIAL;
674 uint16_t reg;
675
676
677 switch (opcode) {
678 case DBG_END_SEQUENCE:
679 return;
680
681 case DBG_ADVANCE_PC:
682 address += DecodeUnsignedLeb128(&stream);
683 break;
684
685 case DBG_ADVANCE_LINE:
686 line += DecodeUnsignedLeb128(&stream);
687 break;
688
689 case DBG_START_LOCAL:
690 case DBG_START_LOCAL_EXTENDED:
691 reg = DecodeUnsignedLeb128(&stream);
692 if (reg > code_item->registers_size_) {
693 LOG(FATAL) << "invalid stream";
694 return;
695 }
696
697 // Emit what was previously there, if anything
698 InvokeLocalCbIfLive(cnxt, reg, address, local_in_reg, local_cb);
699
700 local_in_reg[reg].name_ = dexArtStringById(DecodeUnsignedLeb128P1(&stream));
701 local_in_reg[reg].descriptor_ = dexArtStringByTypeIdx(DecodeUnsignedLeb128P1(&stream));
702 if (opcode == DBG_START_LOCAL_EXTENDED) {
703 local_in_reg[reg].signature_ = dexArtStringById(DecodeUnsignedLeb128P1(&stream));
704 } else {
705 local_in_reg[reg].signature_ = NULL;
706 }
707 local_in_reg[reg].start_address_ = address;
708 local_in_reg[reg].is_live_ = true;
709 break;
710
711 case DBG_END_LOCAL:
712 reg = DecodeUnsignedLeb128(&stream);
713 if (reg > code_item->registers_size_) {
714 LOG(FATAL) << "invalid stream";
715 return;
716 }
717
718 InvokeLocalCbIfLive(cnxt, reg, address, local_in_reg, local_cb);
719 local_in_reg[reg].is_live_ = false;
720 break;
721
722 case DBG_RESTART_LOCAL:
723 reg = DecodeUnsignedLeb128(&stream);
724 if (reg > code_item->registers_size_) {
725 LOG(FATAL) << "invalid stream";
726 return;
727 }
728
729 if (local_in_reg[reg].name_ == NULL
730 || local_in_reg[reg].descriptor_ == NULL) {
731 LOG(FATAL) << "invalid stream";
732 return;
733 }
734
735 // If the register is live, the "restart" is superfluous,
736 // and we don't want to mess with the existing start address.
737 if (!local_in_reg[reg].is_live_) {
738 local_in_reg[reg].start_address_ = address;
739 local_in_reg[reg].is_live_ = true;
740 }
741 break;
742
743 case DBG_SET_PROLOGUE_END:
744 case DBG_SET_EPILOGUE_BEGIN:
745 case DBG_SET_FILE:
746 break;
747
748 default:
749 address += adjopcode / DBG_LINE_RANGE;
750 line += DBG_LINE_BASE + (adjopcode % DBG_LINE_RANGE);
751
752 if (posCb != NULL) {
753 if (posCb(cnxt, address, line)) {
754 // early exit
755 return;
756 }
757 }
758 break;
759 }
760 }
761}
762
Carl Shapiro1fb86202011-06-27 17:43:13 -0700763} // namespace art