xref: /aosp_15_r20/system/extras/simpleperf/read_apk.cpp (revision 288bf5226967eb3dac5cce6c939ccc2a7f2b4fe5)
1*288bf522SAndroid Build Coastguard Worker /*
2*288bf522SAndroid Build Coastguard Worker **
3*288bf522SAndroid Build Coastguard Worker ** Copyright 2016, The Android Open Source Project
4*288bf522SAndroid Build Coastguard Worker **
5*288bf522SAndroid Build Coastguard Worker ** Licensed under the Apache License, Version 2.0 (the "License");
6*288bf522SAndroid Build Coastguard Worker ** you may not use this file except in compliance with the License.
7*288bf522SAndroid Build Coastguard Worker ** You may obtain a copy of the License at
8*288bf522SAndroid Build Coastguard Worker **
9*288bf522SAndroid Build Coastguard Worker **     http://www.apache.org/licenses/LICENSE-2.0
10*288bf522SAndroid Build Coastguard Worker **
11*288bf522SAndroid Build Coastguard Worker ** Unless required by applicable law or agreed to in writing, software
12*288bf522SAndroid Build Coastguard Worker ** distributed under the License is distributed on an "AS IS" BASIS,
13*288bf522SAndroid Build Coastguard Worker ** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14*288bf522SAndroid Build Coastguard Worker ** See the License for the specific language governing permissions and
15*288bf522SAndroid Build Coastguard Worker ** limitations under the License.
16*288bf522SAndroid Build Coastguard Worker */
17*288bf522SAndroid Build Coastguard Worker 
18*288bf522SAndroid Build Coastguard Worker #include "read_apk.h"
19*288bf522SAndroid Build Coastguard Worker 
20*288bf522SAndroid Build Coastguard Worker #include <errno.h>
21*288bf522SAndroid Build Coastguard Worker #include <stdio.h>
22*288bf522SAndroid Build Coastguard Worker #include <string.h>
23*288bf522SAndroid Build Coastguard Worker #include <sys/stat.h>
24*288bf522SAndroid Build Coastguard Worker #include <sys/types.h>
25*288bf522SAndroid Build Coastguard Worker #include <unistd.h>
26*288bf522SAndroid Build Coastguard Worker 
27*288bf522SAndroid Build Coastguard Worker #include <memory>
28*288bf522SAndroid Build Coastguard Worker 
29*288bf522SAndroid Build Coastguard Worker #include <android-base/file.h>
30*288bf522SAndroid Build Coastguard Worker #include <android-base/logging.h>
31*288bf522SAndroid Build Coastguard Worker #include <android-base/strings.h>
32*288bf522SAndroid Build Coastguard Worker #include <ziparchive/zip_archive.h>
33*288bf522SAndroid Build Coastguard Worker #include "read_elf.h"
34*288bf522SAndroid Build Coastguard Worker #include "utils.h"
35*288bf522SAndroid Build Coastguard Worker 
36*288bf522SAndroid Build Coastguard Worker namespace simpleperf {
37*288bf522SAndroid Build Coastguard Worker 
38*288bf522SAndroid Build Coastguard Worker std::unordered_map<std::string, ApkInspector::ApkNode> ApkInspector::embedded_elf_cache_;
39*288bf522SAndroid Build Coastguard Worker 
FindElfInApkByOffset(const std::string & apk_path,uint64_t file_offset)40*288bf522SAndroid Build Coastguard Worker EmbeddedElf* ApkInspector::FindElfInApkByOffset(const std::string& apk_path, uint64_t file_offset) {
41*288bf522SAndroid Build Coastguard Worker   // Already in cache?
42*288bf522SAndroid Build Coastguard Worker   ApkNode& node = embedded_elf_cache_[apk_path];
43*288bf522SAndroid Build Coastguard Worker   auto it = node.offset_map.find(file_offset);
44*288bf522SAndroid Build Coastguard Worker   if (it != node.offset_map.end()) {
45*288bf522SAndroid Build Coastguard Worker     return it->second.get();
46*288bf522SAndroid Build Coastguard Worker   }
47*288bf522SAndroid Build Coastguard Worker   std::unique_ptr<EmbeddedElf> elf = FindElfInApkByOffsetWithoutCache(apk_path, file_offset);
48*288bf522SAndroid Build Coastguard Worker   EmbeddedElf* result = elf.get();
49*288bf522SAndroid Build Coastguard Worker   node.offset_map[file_offset] = std::move(elf);
50*288bf522SAndroid Build Coastguard Worker   if (result != nullptr) {
51*288bf522SAndroid Build Coastguard Worker     node.name_map[result->entry_name()] = result;
52*288bf522SAndroid Build Coastguard Worker   }
53*288bf522SAndroid Build Coastguard Worker   return result;
54*288bf522SAndroid Build Coastguard Worker }
55*288bf522SAndroid Build Coastguard Worker 
FindElfInApkByName(const std::string & apk_path,const std::string & entry_name)56*288bf522SAndroid Build Coastguard Worker EmbeddedElf* ApkInspector::FindElfInApkByName(const std::string& apk_path,
57*288bf522SAndroid Build Coastguard Worker                                               const std::string& entry_name) {
58*288bf522SAndroid Build Coastguard Worker   ApkNode& node = embedded_elf_cache_[apk_path];
59*288bf522SAndroid Build Coastguard Worker   auto it = node.name_map.find(entry_name);
60*288bf522SAndroid Build Coastguard Worker   if (it != node.name_map.end()) {
61*288bf522SAndroid Build Coastguard Worker     return it->second;
62*288bf522SAndroid Build Coastguard Worker   }
63*288bf522SAndroid Build Coastguard Worker   std::unique_ptr<EmbeddedElf> elf = FindElfInApkByNameWithoutCache(apk_path, entry_name);
64*288bf522SAndroid Build Coastguard Worker   EmbeddedElf* result = elf.get();
65*288bf522SAndroid Build Coastguard Worker   node.name_map[entry_name] = result;
66*288bf522SAndroid Build Coastguard Worker   if (result != nullptr) {
67*288bf522SAndroid Build Coastguard Worker     node.offset_map[result->entry_offset()] = std::move(elf);
68*288bf522SAndroid Build Coastguard Worker   }
69*288bf522SAndroid Build Coastguard Worker   return result;
70*288bf522SAndroid Build Coastguard Worker }
71*288bf522SAndroid Build Coastguard Worker 
FindElfInApkByOffsetWithoutCache(const std::string & apk_path,uint64_t file_offset)72*288bf522SAndroid Build Coastguard Worker std::unique_ptr<EmbeddedElf> ApkInspector::FindElfInApkByOffsetWithoutCache(
73*288bf522SAndroid Build Coastguard Worker     const std::string& apk_path, uint64_t file_offset) {
74*288bf522SAndroid Build Coastguard Worker   std::unique_ptr<ArchiveHelper> ahelper = ArchiveHelper::CreateInstance(apk_path);
75*288bf522SAndroid Build Coastguard Worker   if (!ahelper) {
76*288bf522SAndroid Build Coastguard Worker     return nullptr;
77*288bf522SAndroid Build Coastguard Worker   }
78*288bf522SAndroid Build Coastguard Worker 
79*288bf522SAndroid Build Coastguard Worker   // Iterate through the zip file. Look for a zip entry corresponding
80*288bf522SAndroid Build Coastguard Worker   // to an uncompressed blob whose range intersects with the mmap
81*288bf522SAndroid Build Coastguard Worker   // offset we're interested in.
82*288bf522SAndroid Build Coastguard Worker   bool found = false;
83*288bf522SAndroid Build Coastguard Worker   ZipEntry found_entry;
84*288bf522SAndroid Build Coastguard Worker   std::string found_entry_name;
85*288bf522SAndroid Build Coastguard Worker   bool result = ahelper->IterateEntries([&](ZipEntry& entry, const std::string& name) {
86*288bf522SAndroid Build Coastguard Worker     if (entry.method == kCompressStored && file_offset >= static_cast<uint64_t>(entry.offset) &&
87*288bf522SAndroid Build Coastguard Worker         file_offset < static_cast<uint64_t>(entry.offset) + entry.uncompressed_length) {
88*288bf522SAndroid Build Coastguard Worker       found = true;
89*288bf522SAndroid Build Coastguard Worker       found_entry = entry;
90*288bf522SAndroid Build Coastguard Worker       found_entry_name = name;
91*288bf522SAndroid Build Coastguard Worker       return false;
92*288bf522SAndroid Build Coastguard Worker     }
93*288bf522SAndroid Build Coastguard Worker     return true;
94*288bf522SAndroid Build Coastguard Worker   });
95*288bf522SAndroid Build Coastguard Worker   if (!result || !found) {
96*288bf522SAndroid Build Coastguard Worker     return nullptr;
97*288bf522SAndroid Build Coastguard Worker   }
98*288bf522SAndroid Build Coastguard Worker 
99*288bf522SAndroid Build Coastguard Worker   // We found something in the zip file at the right spot. Is it an ELF?
100*288bf522SAndroid Build Coastguard Worker   if (IsValidElfFile(ahelper->GetFd(), found_entry.offset) != ElfStatus::NO_ERROR) {
101*288bf522SAndroid Build Coastguard Worker     // Omit files that are not ELF files.
102*288bf522SAndroid Build Coastguard Worker     return nullptr;
103*288bf522SAndroid Build Coastguard Worker   }
104*288bf522SAndroid Build Coastguard Worker   return std::unique_ptr<EmbeddedElf>(new EmbeddedElf(
105*288bf522SAndroid Build Coastguard Worker       apk_path, found_entry_name, found_entry.offset, found_entry.uncompressed_length));
106*288bf522SAndroid Build Coastguard Worker }
107*288bf522SAndroid Build Coastguard Worker 
FindElfInApkByNameWithoutCache(const std::string & apk_path,const std::string & entry_name)108*288bf522SAndroid Build Coastguard Worker std::unique_ptr<EmbeddedElf> ApkInspector::FindElfInApkByNameWithoutCache(
109*288bf522SAndroid Build Coastguard Worker     const std::string& apk_path, const std::string& entry_name) {
110*288bf522SAndroid Build Coastguard Worker   std::unique_ptr<ArchiveHelper> ahelper = ArchiveHelper::CreateInstance(apk_path);
111*288bf522SAndroid Build Coastguard Worker   if (!ahelper) {
112*288bf522SAndroid Build Coastguard Worker     return nullptr;
113*288bf522SAndroid Build Coastguard Worker   }
114*288bf522SAndroid Build Coastguard Worker   ZipEntry zentry;
115*288bf522SAndroid Build Coastguard Worker   if (!ahelper->FindEntry(entry_name, &zentry)) {
116*288bf522SAndroid Build Coastguard Worker     return nullptr;
117*288bf522SAndroid Build Coastguard Worker   }
118*288bf522SAndroid Build Coastguard Worker   if (zentry.method != kCompressStored || zentry.compressed_length != zentry.uncompressed_length) {
119*288bf522SAndroid Build Coastguard Worker     return nullptr;
120*288bf522SAndroid Build Coastguard Worker   }
121*288bf522SAndroid Build Coastguard Worker   return std::unique_ptr<EmbeddedElf>(
122*288bf522SAndroid Build Coastguard Worker       new EmbeddedElf(apk_path, entry_name, zentry.offset, zentry.uncompressed_length));
123*288bf522SAndroid Build Coastguard Worker }
124*288bf522SAndroid Build Coastguard Worker 
125*288bf522SAndroid Build Coastguard Worker // Refer file in apk in compliance with
126*288bf522SAndroid Build Coastguard Worker // http://developer.android.com/reference/java/net/JarURLConnection.html.
GetUrlInApk(const std::string & apk_path,const std::string & elf_filename)127*288bf522SAndroid Build Coastguard Worker std::string GetUrlInApk(const std::string& apk_path, const std::string& elf_filename) {
128*288bf522SAndroid Build Coastguard Worker   return apk_path + "!/" + elf_filename;
129*288bf522SAndroid Build Coastguard Worker }
130*288bf522SAndroid Build Coastguard Worker 
SplitUrlInApk(const std::string & path)131*288bf522SAndroid Build Coastguard Worker std::tuple<bool, std::string, std::string> SplitUrlInApk(const std::string& path) {
132*288bf522SAndroid Build Coastguard Worker   size_t pos = path.find("!/");
133*288bf522SAndroid Build Coastguard Worker   if (pos == std::string::npos) {
134*288bf522SAndroid Build Coastguard Worker     return std::make_tuple(false, "", "");
135*288bf522SAndroid Build Coastguard Worker   }
136*288bf522SAndroid Build Coastguard Worker   return std::make_tuple(true, path.substr(0, pos), path.substr(pos + 2));
137*288bf522SAndroid Build Coastguard Worker }
138*288bf522SAndroid Build Coastguard Worker 
139*288bf522SAndroid Build Coastguard Worker // Parse path like "[anon:dalvik-classes.dex extracted in memory from /..base.apk] (deleted)",
140*288bf522SAndroid Build Coastguard Worker // or "/dev/ashmem/dalvik-classes.dex extracted in memory from /..base.apk (deleted)" on Android P.
ParseExtractedInMemoryPath(const std::string & path,std::string * zip_path,std::string * entry_name)141*288bf522SAndroid Build Coastguard Worker bool ParseExtractedInMemoryPath(const std::string& path, std::string* zip_path,
142*288bf522SAndroid Build Coastguard Worker                                 std::string* entry_name) {
143*288bf522SAndroid Build Coastguard Worker   const char* prefixes[2] = {"[anon:dalvik-", "/dev/ashmem/dalvik-"};
144*288bf522SAndroid Build Coastguard Worker   const char* key = " extracted in memory from ";
145*288bf522SAndroid Build Coastguard Worker   size_t pos = path.find(key);
146*288bf522SAndroid Build Coastguard Worker   if (pos != std::string::npos) {
147*288bf522SAndroid Build Coastguard Worker     for (const char* prefix : prefixes) {
148*288bf522SAndroid Build Coastguard Worker       if (android::base::StartsWith(path, prefix)) {
149*288bf522SAndroid Build Coastguard Worker         size_t entry_name_start = strlen(prefix);
150*288bf522SAndroid Build Coastguard Worker         size_t entry_name_end = pos;
151*288bf522SAndroid Build Coastguard Worker         size_t zip_path_start = pos + strlen(key);
152*288bf522SAndroid Build Coastguard Worker         size_t zip_path_end = path.find_first_of(" ]", zip_path_start);
153*288bf522SAndroid Build Coastguard Worker         if (zip_path_end == std::string::npos) {
154*288bf522SAndroid Build Coastguard Worker           zip_path_end = path.size();
155*288bf522SAndroid Build Coastguard Worker         }
156*288bf522SAndroid Build Coastguard Worker         if (entry_name_start < entry_name_end && zip_path_start < zip_path_end) {
157*288bf522SAndroid Build Coastguard Worker           *entry_name = path.substr(entry_name_start, entry_name_end - entry_name_start);
158*288bf522SAndroid Build Coastguard Worker           *zip_path = path.substr(zip_path_start, zip_path_end - zip_path_start);
159*288bf522SAndroid Build Coastguard Worker           size_t multidex_separator_pos = zip_path->find('!');
160*288bf522SAndroid Build Coastguard Worker           if (multidex_separator_pos != std::string::npos) {
161*288bf522SAndroid Build Coastguard Worker             zip_path->resize(multidex_separator_pos);
162*288bf522SAndroid Build Coastguard Worker           }
163*288bf522SAndroid Build Coastguard Worker           return true;
164*288bf522SAndroid Build Coastguard Worker         }
165*288bf522SAndroid Build Coastguard Worker       }
166*288bf522SAndroid Build Coastguard Worker     }
167*288bf522SAndroid Build Coastguard Worker   }
168*288bf522SAndroid Build Coastguard Worker   return false;
169*288bf522SAndroid Build Coastguard Worker }
170*288bf522SAndroid Build Coastguard Worker 
171*288bf522SAndroid Build Coastguard Worker }  // namespace simpleperf
172