blob: a65d49b7e32feb5baf204ed1baa8c69430495e18 [file] [log] [blame]
Adam Lesinski7ad11102016-10-28 16:39:15 -07001/*
2 * Copyright (C) 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#define ATRACE_TAG ATRACE_TAG_RESOURCES
18
19#include "androidfw/LoadedArsc.h"
20
Adam Lesinski73f6f9d2017-11-14 10:18:05 -080021#include <algorithm>
Adam Lesinski7ad11102016-10-28 16:39:15 -070022#include <cstddef>
23#include <limits>
24
25#include "android-base/logging.h"
26#include "android-base/stringprintf.h"
27#include "utils/ByteOrder.h"
28#include "utils/Trace.h"
29
30#ifdef _WIN32
31#ifdef ERROR
32#undef ERROR
33#endif
34#endif
35
Adam Lesinski7ad11102016-10-28 16:39:15 -070036#include "androidfw/ByteBucketArray.h"
Adam Lesinskida431a22016-12-29 16:08:16 -050037#include "androidfw/Chunk.h"
Adam Lesinski929d6512017-01-16 19:11:19 -080038#include "androidfw/ResourceUtils.h"
Adam Lesinski7ad11102016-10-28 16:39:15 -070039#include "androidfw/Util.h"
40
Adam Lesinski970bd8d2017-09-25 13:21:55 -070041using ::android::base::StringPrintf;
Adam Lesinski7ad11102016-10-28 16:39:15 -070042
43namespace android {
44
Adam Lesinskida431a22016-12-29 16:08:16 -050045constexpr const static int kAppPackageId = 0x7f;
Adam Lesinski7ad11102016-10-28 16:39:15 -070046
Adam Lesinskida431a22016-12-29 16:08:16 -050047namespace {
48
Adam Lesinski7ad11102016-10-28 16:39:15 -070049// Builder that helps accumulate Type structs and then create a single
50// contiguous block of memory to store both the TypeSpec struct and
51// the Type structs.
52class TypeSpecPtrBuilder {
53 public:
Adam Lesinski970bd8d2017-09-25 13:21:55 -070054 explicit TypeSpecPtrBuilder(const ResTable_typeSpec* header,
55 const IdmapEntry_header* idmap_header)
56 : header_(header), idmap_header_(idmap_header) {
57 }
Adam Lesinski7ad11102016-10-28 16:39:15 -070058
59 void AddType(const ResTable_type* type) {
Adam Lesinski88c99592018-01-08 17:38:30 -080060 types_.push_back(type);
Adam Lesinski7ad11102016-10-28 16:39:15 -070061 }
62
63 TypeSpecPtr Build() {
64 // Check for overflow.
Adam Lesinski88c99592018-01-08 17:38:30 -080065 using ElementType = const ResTable_type*;
66 if ((std::numeric_limits<size_t>::max() - sizeof(TypeSpec)) / sizeof(ElementType) <
67 types_.size()) {
Adam Lesinski7ad11102016-10-28 16:39:15 -070068 return {};
69 }
Adam Lesinski88c99592018-01-08 17:38:30 -080070 TypeSpec* type_spec =
71 (TypeSpec*)::malloc(sizeof(TypeSpec) + (types_.size() * sizeof(ElementType)));
Adam Lesinski7ad11102016-10-28 16:39:15 -070072 type_spec->type_spec = header_;
Adam Lesinski970bd8d2017-09-25 13:21:55 -070073 type_spec->idmap_entries = idmap_header_;
Adam Lesinski7ad11102016-10-28 16:39:15 -070074 type_spec->type_count = types_.size();
Adam Lesinski88c99592018-01-08 17:38:30 -080075 memcpy(type_spec + 1, types_.data(), types_.size() * sizeof(ElementType));
Adam Lesinski7ad11102016-10-28 16:39:15 -070076 return TypeSpecPtr(type_spec);
77 }
78
79 private:
80 DISALLOW_COPY_AND_ASSIGN(TypeSpecPtrBuilder);
81
82 const ResTable_typeSpec* header_;
Adam Lesinski970bd8d2017-09-25 13:21:55 -070083 const IdmapEntry_header* idmap_header_;
Adam Lesinski88c99592018-01-08 17:38:30 -080084 std::vector<const ResTable_type*> types_;
Adam Lesinski7ad11102016-10-28 16:39:15 -070085};
86
87} // namespace
88
Adam Lesinski1a1e9c22017-10-13 15:45:34 -070089LoadedPackage::LoadedPackage() = default;
90LoadedPackage::~LoadedPackage() = default;
91
92// Precondition: The header passed in has already been verified, so reading any fields and trusting
93// the ResChunk_header is safe.
94static bool VerifyResTableType(const ResTable_type* header) {
Adam Lesinski498f6052017-11-29 13:24:29 -080095 if (header->id == 0) {
96 LOG(ERROR) << "RES_TABLE_TYPE_TYPE has invalid ID 0.";
97 return false;
98 }
99
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700100 const size_t entry_count = dtohl(header->entryCount);
101 if (entry_count > std::numeric_limits<uint16_t>::max()) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800102 LOG(ERROR) << "RES_TABLE_TYPE_TYPE has too many entries (" << entry_count << ").";
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700103 return false;
104 }
105
106 // Make sure that there is enough room for the entry offsets.
107 const size_t offsets_offset = dtohs(header->header.headerSize);
108 const size_t entries_offset = dtohl(header->entriesStart);
109 const size_t offsets_length = sizeof(uint32_t) * entry_count;
110
111 if (offsets_offset > entries_offset || entries_offset - offsets_offset < offsets_length) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800112 LOG(ERROR) << "RES_TABLE_TYPE_TYPE entry offsets overlap actual entry data.";
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700113 return false;
114 }
115
116 if (entries_offset > dtohl(header->header.size)) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800117 LOG(ERROR) << "RES_TABLE_TYPE_TYPE entry offsets extend beyond chunk.";
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700118 return false;
119 }
120
121 if (entries_offset & 0x03) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800122 LOG(ERROR) << "RES_TABLE_TYPE_TYPE entries start at unaligned address.";
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700123 return false;
124 }
125 return true;
126}
127
Adam Lesinski88c99592018-01-08 17:38:30 -0800128static bool VerifyResTableEntry(const ResTable_type* type, uint32_t entry_offset) {
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700129 // Check that the offset is aligned.
130 if (entry_offset & 0x03) {
Adam Lesinski88c99592018-01-08 17:38:30 -0800131 LOG(ERROR) << "Entry at offset " << entry_offset << " is not 4-byte aligned.";
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700132 return false;
133 }
134
135 // Check that the offset doesn't overflow.
136 if (entry_offset > std::numeric_limits<uint32_t>::max() - dtohl(type->entriesStart)) {
137 // Overflow in offset.
Adam Lesinski88c99592018-01-08 17:38:30 -0800138 LOG(ERROR) << "Entry at offset " << entry_offset << " is too large.";
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700139 return false;
140 }
141
142 const size_t chunk_size = dtohl(type->header.size);
143
144 entry_offset += dtohl(type->entriesStart);
145 if (entry_offset > chunk_size - sizeof(ResTable_entry)) {
Adam Lesinski88c99592018-01-08 17:38:30 -0800146 LOG(ERROR) << "Entry at offset " << entry_offset
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700147 << " is too large. No room for ResTable_entry.";
148 return false;
149 }
150
151 const ResTable_entry* entry = reinterpret_cast<const ResTable_entry*>(
152 reinterpret_cast<const uint8_t*>(type) + entry_offset);
153
154 const size_t entry_size = dtohs(entry->size);
155 if (entry_size < sizeof(*entry)) {
Adam Lesinski88c99592018-01-08 17:38:30 -0800156 LOG(ERROR) << "ResTable_entry size " << entry_size << " at offset " << entry_offset
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700157 << " is too small.";
158 return false;
159 }
160
161 if (entry_size > chunk_size || entry_offset > chunk_size - entry_size) {
Adam Lesinski88c99592018-01-08 17:38:30 -0800162 LOG(ERROR) << "ResTable_entry size " << entry_size << " at offset " << entry_offset
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700163 << " is too large.";
164 return false;
165 }
166
167 if (entry_size < sizeof(ResTable_map_entry)) {
168 // There needs to be room for one Res_value struct.
169 if (entry_offset + entry_size > chunk_size - sizeof(Res_value)) {
Adam Lesinski88c99592018-01-08 17:38:30 -0800170 LOG(ERROR) << "No room for Res_value after ResTable_entry at offset " << entry_offset
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700171 << " for type " << (int)type->id << ".";
172 return false;
173 }
174
175 const Res_value* value =
176 reinterpret_cast<const Res_value*>(reinterpret_cast<const uint8_t*>(entry) + entry_size);
177 const size_t value_size = dtohs(value->size);
178 if (value_size < sizeof(Res_value)) {
Adam Lesinski88c99592018-01-08 17:38:30 -0800179 LOG(ERROR) << "Res_value at offset " << entry_offset << " is too small.";
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700180 return false;
181 }
182
183 if (value_size > chunk_size || entry_offset + entry_size > chunk_size - value_size) {
Adam Lesinski88c99592018-01-08 17:38:30 -0800184 LOG(ERROR) << "Res_value size " << value_size << " at offset " << entry_offset
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700185 << " is too large.";
186 return false;
187 }
188 } else {
189 const ResTable_map_entry* map = reinterpret_cast<const ResTable_map_entry*>(entry);
190 const size_t map_entry_count = dtohl(map->count);
191 size_t map_entries_start = entry_offset + entry_size;
192 if (map_entries_start & 0x03) {
Adam Lesinski88c99592018-01-08 17:38:30 -0800193 LOG(ERROR) << "Map entries at offset " << entry_offset << " start at unaligned offset.";
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700194 return false;
195 }
196
197 // Each entry is sizeof(ResTable_map) big.
198 if (map_entry_count > ((chunk_size - map_entries_start) / sizeof(ResTable_map))) {
Adam Lesinski88c99592018-01-08 17:38:30 -0800199 LOG(ERROR) << "Too many map entries in ResTable_map_entry at offset " << entry_offset << ".";
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700200 return false;
201 }
202 }
203 return true;
204}
205
Adam Lesinski88c99592018-01-08 17:38:30 -0800206const ResTable_entry* LoadedPackage::GetEntry(const ResTable_type* type_chunk,
207 uint16_t entry_index) {
208 uint32_t entry_offset = GetEntryOffset(type_chunk, entry_index);
209 if (entry_offset == ResTable_type::NO_ENTRY) {
210 return nullptr;
211 }
212 return GetEntryFromOffset(type_chunk, entry_offset);
213}
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700214
Adam Lesinski88c99592018-01-08 17:38:30 -0800215uint32_t LoadedPackage::GetEntryOffset(const ResTable_type* type_chunk, uint16_t entry_index) {
216 // The configuration matches and is better than the previous selection.
217 // Find the entry value if it exists for this configuration.
218 const size_t entry_count = dtohl(type_chunk->entryCount);
219 const size_t offsets_offset = dtohs(type_chunk->header.headerSize);
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700220
Adam Lesinski88c99592018-01-08 17:38:30 -0800221 // Check if there is the desired entry in this type.
Adam Lesinski73f6f9d2017-11-14 10:18:05 -0800222
Adam Lesinski88c99592018-01-08 17:38:30 -0800223 if (type_chunk->flags & ResTable_type::FLAG_SPARSE) {
224 // This is encoded as a sparse map, so perform a binary search.
225 const ResTable_sparseTypeEntry* sparse_indices =
226 reinterpret_cast<const ResTable_sparseTypeEntry*>(
Adam Lesinski73f6f9d2017-11-14 10:18:05 -0800227 reinterpret_cast<const uint8_t*>(type_chunk) + offsets_offset);
Adam Lesinski88c99592018-01-08 17:38:30 -0800228 const ResTable_sparseTypeEntry* sparse_indices_end = sparse_indices + entry_count;
229 const ResTable_sparseTypeEntry* result =
230 std::lower_bound(sparse_indices, sparse_indices_end, entry_index,
231 [](const ResTable_sparseTypeEntry& entry, uint16_t entry_idx) {
232 return dtohs(entry.idx) < entry_idx;
233 });
Adam Lesinski73f6f9d2017-11-14 10:18:05 -0800234
Adam Lesinski88c99592018-01-08 17:38:30 -0800235 if (result == sparse_indices_end || dtohs(result->idx) != entry_index) {
236 // No entry found.
237 return ResTable_type::NO_ENTRY;
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700238 }
Adam Lesinski88c99592018-01-08 17:38:30 -0800239
240 // Extract the offset from the entry. Each offset must be a multiple of 4 so we store it as
241 // the real offset divided by 4.
242 return uint32_t{dtohs(result->offset)} * 4u;
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700243 }
244
Adam Lesinski88c99592018-01-08 17:38:30 -0800245 // This type is encoded as a dense array.
246 if (entry_index >= entry_count) {
247 // This entry cannot be here.
248 return ResTable_type::NO_ENTRY;
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700249 }
250
Adam Lesinski88c99592018-01-08 17:38:30 -0800251 const uint32_t* entry_offsets = reinterpret_cast<const uint32_t*>(
252 reinterpret_cast<const uint8_t*>(type_chunk) + offsets_offset);
253 return dtohl(entry_offsets[entry_index]);
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700254}
255
Adam Lesinski88c99592018-01-08 17:38:30 -0800256const ResTable_entry* LoadedPackage::GetEntryFromOffset(const ResTable_type* type_chunk,
257 uint32_t offset) {
258 if (UNLIKELY(!VerifyResTableEntry(type_chunk, offset))) {
259 return nullptr;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700260 }
Adam Lesinski88c99592018-01-08 17:38:30 -0800261 return reinterpret_cast<const ResTable_entry*>(reinterpret_cast<const uint8_t*>(type_chunk) +
262 offset + dtohl(type_chunk->entriesStart));
Adam Lesinski7ad11102016-10-28 16:39:15 -0700263}
264
Adam Lesinski0c405242017-01-13 20:47:26 -0800265void LoadedPackage::CollectConfigurations(bool exclude_mipmap,
266 std::set<ResTable_config>* out_configs) const {
267 const static std::u16string kMipMap = u"mipmap";
268 const size_t type_count = type_specs_.size();
269 for (size_t i = 0; i < type_count; i++) {
Adam Lesinski88c99592018-01-08 17:38:30 -0800270 const TypeSpecPtr& type_spec = type_specs_[i];
Adam Lesinski0c405242017-01-13 20:47:26 -0800271 if (type_spec != nullptr) {
272 if (exclude_mipmap) {
273 const int type_idx = type_spec->type_spec->id - 1;
274 size_t type_name_len;
275 const char16_t* type_name16 = type_string_pool_.stringAt(type_idx, &type_name_len);
276 if (type_name16 != nullptr) {
277 if (kMipMap.compare(0, std::u16string::npos, type_name16, type_name_len) == 0) {
278 // This is a mipmap type, skip collection.
279 continue;
280 }
281 }
282 const char* type_name = type_string_pool_.string8At(type_idx, &type_name_len);
283 if (type_name != nullptr) {
284 if (strncmp(type_name, "mipmap", type_name_len) == 0) {
285 // This is a mipmap type, skip collection.
286 continue;
287 }
288 }
289 }
290
Adam Lesinski88c99592018-01-08 17:38:30 -0800291 const auto iter_end = type_spec->types + type_spec->type_count;
292 for (auto iter = type_spec->types; iter != iter_end; ++iter) {
293 ResTable_config config;
294 config.copyFromDtoH((*iter)->config);
295 out_configs->insert(config);
Adam Lesinski0c405242017-01-13 20:47:26 -0800296 }
297 }
298 }
299}
300
301void LoadedPackage::CollectLocales(bool canonicalize, std::set<std::string>* out_locales) const {
302 char temp_locale[RESTABLE_MAX_LOCALE_LEN];
303 const size_t type_count = type_specs_.size();
304 for (size_t i = 0; i < type_count; i++) {
Adam Lesinski88c99592018-01-08 17:38:30 -0800305 const TypeSpecPtr& type_spec = type_specs_[i];
Adam Lesinski0c405242017-01-13 20:47:26 -0800306 if (type_spec != nullptr) {
Adam Lesinski88c99592018-01-08 17:38:30 -0800307 const auto iter_end = type_spec->types + type_spec->type_count;
308 for (auto iter = type_spec->types; iter != iter_end; ++iter) {
309 ResTable_config configuration;
310 configuration.copyFromDtoH((*iter)->config);
Adam Lesinski0c405242017-01-13 20:47:26 -0800311 if (configuration.locale != 0) {
312 configuration.getBcp47Locale(temp_locale, canonicalize);
313 std::string locale(temp_locale);
314 out_locales->insert(std::move(locale));
315 }
316 }
317 }
318 }
319}
320
Adam Lesinski929d6512017-01-16 19:11:19 -0800321uint32_t LoadedPackage::FindEntryByName(const std::u16string& type_name,
322 const std::u16string& entry_name) const {
323 ssize_t type_idx = type_string_pool_.indexOfString(type_name.data(), type_name.size());
324 if (type_idx < 0) {
325 return 0u;
326 }
327
328 ssize_t key_idx = key_string_pool_.indexOfString(entry_name.data(), entry_name.size());
329 if (key_idx < 0) {
330 return 0u;
331 }
332
333 const TypeSpec* type_spec = type_specs_[type_idx].get();
334 if (type_spec == nullptr) {
335 return 0u;
336 }
337
Adam Lesinski88c99592018-01-08 17:38:30 -0800338 const auto iter_end = type_spec->types + type_spec->type_count;
339 for (auto iter = type_spec->types; iter != iter_end; ++iter) {
340 const ResTable_type* type = *iter;
341 size_t entry_count = dtohl(type->entryCount);
Adam Lesinski929d6512017-01-16 19:11:19 -0800342 for (size_t entry_idx = 0; entry_idx < entry_count; entry_idx++) {
343 const uint32_t* entry_offsets = reinterpret_cast<const uint32_t*>(
Adam Lesinski88c99592018-01-08 17:38:30 -0800344 reinterpret_cast<const uint8_t*>(type) + dtohs(type->header.headerSize));
Adam Lesinski929d6512017-01-16 19:11:19 -0800345 const uint32_t offset = dtohl(entry_offsets[entry_idx]);
346 if (offset != ResTable_type::NO_ENTRY) {
Adam Lesinski88c99592018-01-08 17:38:30 -0800347 const ResTable_entry* entry = reinterpret_cast<const ResTable_entry*>(
348 reinterpret_cast<const uint8_t*>(type) + dtohl(type->entriesStart) + offset);
Adam Lesinski929d6512017-01-16 19:11:19 -0800349 if (dtohl(entry->key.index) == static_cast<uint32_t>(key_idx)) {
350 // The package ID will be overridden by the caller (due to runtime assignment of package
351 // IDs for shared libraries).
352 return make_resid(0x00, type_idx + type_id_offset_ + 1, entry_idx);
353 }
354 }
355 }
356 }
357 return 0u;
358}
359
Adam Lesinski88c99592018-01-08 17:38:30 -0800360const LoadedPackage* LoadedArsc::GetPackageById(uint8_t package_id) const {
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700361 for (const auto& loaded_package : packages_) {
362 if (loaded_package->GetPackageId() == package_id) {
363 return loaded_package.get();
364 }
365 }
366 return nullptr;
367}
368
369std::unique_ptr<const LoadedPackage> LoadedPackage::Load(const Chunk& chunk,
370 const LoadedIdmap* loaded_idmap,
371 bool system, bool load_as_shared_library) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700372 ATRACE_CALL();
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700373 std::unique_ptr<LoadedPackage> loaded_package(new LoadedPackage());
Adam Lesinskida431a22016-12-29 16:08:16 -0500374
Adam Lesinski970bd8d2017-09-25 13:21:55 -0700375 // typeIdOffset was added at some point, but we still must recognize apps built before this
376 // was added.
Adam Lesinski33af6c72017-03-29 13:00:35 -0700377 constexpr size_t kMinPackageSize =
378 sizeof(ResTable_package) - sizeof(ResTable_package::typeIdOffset);
379 const ResTable_package* header = chunk.header<ResTable_package, kMinPackageSize>();
Adam Lesinski7ad11102016-10-28 16:39:15 -0700380 if (header == nullptr) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800381 LOG(ERROR) << "RES_TABLE_PACKAGE_TYPE too small.";
Adam Lesinskida431a22016-12-29 16:08:16 -0500382 return {};
Adam Lesinski7ad11102016-10-28 16:39:15 -0700383 }
384
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700385 loaded_package->system_ = system;
386
Adam Lesinski7ad11102016-10-28 16:39:15 -0700387 loaded_package->package_id_ = dtohl(header->id);
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700388 if (loaded_package->package_id_ == 0 ||
389 (loaded_package->package_id_ == kAppPackageId && load_as_shared_library)) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500390 // Package ID of 0 means this is a shared library.
391 loaded_package->dynamic_ = true;
392 }
393
Adam Lesinski970bd8d2017-09-25 13:21:55 -0700394 if (loaded_idmap != nullptr) {
395 // This is an overlay and so it needs to pretend to be the target package.
396 loaded_package->package_id_ = loaded_idmap->TargetPackageId();
397 loaded_package->overlay_ = true;
398 }
399
Adam Lesinskic6aada92017-01-13 15:34:14 -0800400 if (header->header.headerSize >= sizeof(ResTable_package)) {
401 uint32_t type_id_offset = dtohl(header->typeIdOffset);
402 if (type_id_offset > std::numeric_limits<uint8_t>::max()) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800403 LOG(ERROR) << "RES_TABLE_PACKAGE_TYPE type ID offset too large.";
Adam Lesinskic6aada92017-01-13 15:34:14 -0800404 return {};
405 }
406 loaded_package->type_id_offset_ = static_cast<int>(type_id_offset);
407 }
408
Adam Lesinskida431a22016-12-29 16:08:16 -0500409 util::ReadUtf16StringFromDevice(header->name, arraysize(header->name),
410 &loaded_package->package_name_);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700411
Adam Lesinski78695c32018-02-08 14:50:38 -0800412 // A map of TypeSpec builders, each associated with an type index.
413 // We use these to accumulate the set of Types available for a TypeSpec, and later build a single,
414 // contiguous block of memory that holds all the Types together with the TypeSpec.
415 std::unordered_map<int, std::unique_ptr<TypeSpecPtrBuilder>> type_builder_map;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700416
417 ChunkIterator iter(chunk.data_ptr(), chunk.data_size());
418 while (iter.HasNext()) {
419 const Chunk child_chunk = iter.Next();
420 switch (child_chunk.type()) {
421 case RES_STRING_POOL_TYPE: {
422 const uintptr_t pool_address =
423 reinterpret_cast<uintptr_t>(child_chunk.header<ResChunk_header>());
424 const uintptr_t header_address = reinterpret_cast<uintptr_t>(header);
425 if (pool_address == header_address + dtohl(header->typeStrings)) {
426 // This string pool is the type string pool.
427 status_t err = loaded_package->type_string_pool_.setTo(
428 child_chunk.header<ResStringPool_header>(), child_chunk.size());
429 if (err != NO_ERROR) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800430 LOG(ERROR) << "RES_STRING_POOL_TYPE for types corrupt.";
Adam Lesinskida431a22016-12-29 16:08:16 -0500431 return {};
Adam Lesinski7ad11102016-10-28 16:39:15 -0700432 }
433 } else if (pool_address == header_address + dtohl(header->keyStrings)) {
434 // This string pool is the key string pool.
435 status_t err = loaded_package->key_string_pool_.setTo(
436 child_chunk.header<ResStringPool_header>(), child_chunk.size());
437 if (err != NO_ERROR) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800438 LOG(ERROR) << "RES_STRING_POOL_TYPE for keys corrupt.";
Adam Lesinskida431a22016-12-29 16:08:16 -0500439 return {};
Adam Lesinski7ad11102016-10-28 16:39:15 -0700440 }
441 } else {
Adam Lesinski498f6052017-11-29 13:24:29 -0800442 LOG(WARNING) << "Too many RES_STRING_POOL_TYPEs found in RES_TABLE_PACKAGE_TYPE.";
Adam Lesinski7ad11102016-10-28 16:39:15 -0700443 }
444 } break;
445
446 case RES_TABLE_TYPE_SPEC_TYPE: {
447 ATRACE_NAME("LoadTableTypeSpec");
448
Adam Lesinski7ad11102016-10-28 16:39:15 -0700449 const ResTable_typeSpec* type_spec = child_chunk.header<ResTable_typeSpec>();
450 if (type_spec == nullptr) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800451 LOG(ERROR) << "RES_TABLE_TYPE_SPEC_TYPE too small.";
Adam Lesinskida431a22016-12-29 16:08:16 -0500452 return {};
Adam Lesinski7ad11102016-10-28 16:39:15 -0700453 }
454
455 if (type_spec->id == 0) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800456 LOG(ERROR) << "RES_TABLE_TYPE_SPEC_TYPE has invalid ID 0.";
Adam Lesinskida431a22016-12-29 16:08:16 -0500457 return {};
Adam Lesinski7ad11102016-10-28 16:39:15 -0700458 }
459
Adam Lesinskic6aada92017-01-13 15:34:14 -0800460 if (loaded_package->type_id_offset_ + static_cast<int>(type_spec->id) >
461 std::numeric_limits<uint8_t>::max()) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800462 LOG(ERROR) << "RES_TABLE_TYPE_SPEC_TYPE has out of range ID.";
Adam Lesinskic6aada92017-01-13 15:34:14 -0800463 return {};
464 }
465
Adam Lesinski7ad11102016-10-28 16:39:15 -0700466 // The data portion of this chunk contains entry_count 32bit entries,
467 // each one representing a set of flags.
468 // Here we only validate that the chunk is well formed.
469 const size_t entry_count = dtohl(type_spec->entryCount);
470
471 // There can only be 2^16 entries in a type, because that is the ID
472 // space for entries (EEEE) in the resource ID 0xPPTTEEEE.
473 if (entry_count > std::numeric_limits<uint16_t>::max()) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800474 LOG(ERROR) << "RES_TABLE_TYPE_SPEC_TYPE has too many entries (" << entry_count << ").";
Adam Lesinskida431a22016-12-29 16:08:16 -0500475 return {};
Adam Lesinski7ad11102016-10-28 16:39:15 -0700476 }
477
478 if (entry_count * sizeof(uint32_t) > chunk.data_size()) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800479 LOG(ERROR) << "RES_TABLE_TYPE_SPEC_TYPE too small to hold entries.";
Adam Lesinskida431a22016-12-29 16:08:16 -0500480 return {};
Adam Lesinski7ad11102016-10-28 16:39:15 -0700481 }
482
Adam Lesinski970bd8d2017-09-25 13:21:55 -0700483 // If this is an overlay, associate the mapping of this type to the target type
484 // from the IDMAP.
485 const IdmapEntry_header* idmap_entry_header = nullptr;
486 if (loaded_idmap != nullptr) {
487 idmap_entry_header = loaded_idmap->GetEntryMapForType(type_spec->id);
488 }
489
Adam Lesinski78695c32018-02-08 14:50:38 -0800490 std::unique_ptr<TypeSpecPtrBuilder>& builder_ptr = type_builder_map[type_spec->id - 1];
491 if (builder_ptr == nullptr) {
492 builder_ptr = util::make_unique<TypeSpecPtrBuilder>(type_spec, idmap_entry_header);
493 } else {
494 LOG(WARNING) << StringPrintf("RES_TABLE_TYPE_SPEC_TYPE already defined for ID %02x",
495 type_spec->id);
496 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700497 } break;
498
499 case RES_TABLE_TYPE_TYPE: {
Adam Lesinski136fd072017-03-03 13:50:21 -0800500 const ResTable_type* type = child_chunk.header<ResTable_type, kResTableTypeMinSize>();
Adam Lesinski7ad11102016-10-28 16:39:15 -0700501 if (type == nullptr) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800502 LOG(ERROR) << "RES_TABLE_TYPE_TYPE too small.";
Adam Lesinskida431a22016-12-29 16:08:16 -0500503 return {};
Adam Lesinski7ad11102016-10-28 16:39:15 -0700504 }
505
Adam Lesinski498f6052017-11-29 13:24:29 -0800506 if (!VerifyResTableType(type)) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500507 return {};
Adam Lesinski7ad11102016-10-28 16:39:15 -0700508 }
509
510 // Type chunks must be preceded by their TypeSpec chunks.
Adam Lesinski78695c32018-02-08 14:50:38 -0800511 std::unique_ptr<TypeSpecPtrBuilder>& builder_ptr = type_builder_map[type->id - 1];
512 if (builder_ptr != nullptr) {
513 builder_ptr->AddType(type);
514 } else {
515 LOG(ERROR) << StringPrintf(
516 "RES_TABLE_TYPE_TYPE with ID %02x found without preceding RES_TABLE_TYPE_SPEC_TYPE.",
517 type->id);
Adam Lesinskida431a22016-12-29 16:08:16 -0500518 return {};
Adam Lesinski7ad11102016-10-28 16:39:15 -0700519 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700520 } break;
521
Adam Lesinskida431a22016-12-29 16:08:16 -0500522 case RES_TABLE_LIBRARY_TYPE: {
523 const ResTable_lib_header* lib = child_chunk.header<ResTable_lib_header>();
524 if (lib == nullptr) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800525 LOG(ERROR) << "RES_TABLE_LIBRARY_TYPE too small.";
Adam Lesinskida431a22016-12-29 16:08:16 -0500526 return {};
527 }
528
529 if (child_chunk.data_size() / sizeof(ResTable_lib_entry) < dtohl(lib->count)) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800530 LOG(ERROR) << "RES_TABLE_LIBRARY_TYPE too small to hold entries.";
Adam Lesinskida431a22016-12-29 16:08:16 -0500531 return {};
532 }
533
534 loaded_package->dynamic_package_map_.reserve(dtohl(lib->count));
535
536 const ResTable_lib_entry* const entry_begin =
537 reinterpret_cast<const ResTable_lib_entry*>(child_chunk.data_ptr());
538 const ResTable_lib_entry* const entry_end = entry_begin + dtohl(lib->count);
539 for (auto entry_iter = entry_begin; entry_iter != entry_end; ++entry_iter) {
540 std::string package_name;
541 util::ReadUtf16StringFromDevice(entry_iter->packageName,
542 arraysize(entry_iter->packageName), &package_name);
543
544 if (dtohl(entry_iter->packageId) >= std::numeric_limits<uint8_t>::max()) {
Adam Lesinski78695c32018-02-08 14:50:38 -0800545 LOG(ERROR) << StringPrintf(
Adam Lesinskida431a22016-12-29 16:08:16 -0500546 "Package ID %02x in RES_TABLE_LIBRARY_TYPE too large for package '%s'.",
547 dtohl(entry_iter->packageId), package_name.c_str());
548 return {};
549 }
550
551 loaded_package->dynamic_package_map_.emplace_back(std::move(package_name),
552 dtohl(entry_iter->packageId));
553 }
554
555 } break;
556
Adam Lesinski7ad11102016-10-28 16:39:15 -0700557 default:
Adam Lesinski78695c32018-02-08 14:50:38 -0800558 LOG(WARNING) << StringPrintf("Unknown chunk type '%02x'.", chunk.type());
Adam Lesinski7ad11102016-10-28 16:39:15 -0700559 break;
560 }
561 }
562
Adam Lesinski78695c32018-02-08 14:50:38 -0800563 if (iter.HadError()) {
564 LOG(ERROR) << iter.GetLastError();
565 return {};
566 }
567
568 // Flatten and construct the TypeSpecs.
569 for (auto& entry : type_builder_map) {
570 uint8_t type_idx = static_cast<uint8_t>(entry.first);
571 TypeSpecPtr type_spec_ptr = entry.second->Build();
Adam Lesinski7ad11102016-10-28 16:39:15 -0700572 if (type_spec_ptr == nullptr) {
573 LOG(ERROR) << "Too many type configurations, overflow detected.";
Adam Lesinskida431a22016-12-29 16:08:16 -0500574 return {};
Adam Lesinski7ad11102016-10-28 16:39:15 -0700575 }
Adam Lesinski970bd8d2017-09-25 13:21:55 -0700576
577 // We only add the type to the package if there is no IDMAP, or if the type is
578 // overlaying something.
579 if (loaded_idmap == nullptr || type_spec_ptr->idmap_entries != nullptr) {
580 // If this is an overlay, insert it at the target type ID.
581 if (type_spec_ptr->idmap_entries != nullptr) {
Adam Lesinski78695c32018-02-08 14:50:38 -0800582 type_idx = dtohs(type_spec_ptr->idmap_entries->target_type_id) - 1;
Adam Lesinski970bd8d2017-09-25 13:21:55 -0700583 }
Adam Lesinski78695c32018-02-08 14:50:38 -0800584 loaded_package->type_specs_.editItemAt(type_idx) = std::move(type_spec_ptr);
Adam Lesinski970bd8d2017-09-25 13:21:55 -0700585 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700586 }
587
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700588 return std::move(loaded_package);
589}
590
Adam Lesinski970bd8d2017-09-25 13:21:55 -0700591bool LoadedArsc::LoadTable(const Chunk& chunk, const LoadedIdmap* loaded_idmap,
592 bool load_as_shared_library) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700593 ATRACE_CALL();
594 const ResTable_header* header = chunk.header<ResTable_header>();
595 if (header == nullptr) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800596 LOG(ERROR) << "RES_TABLE_TYPE too small.";
Adam Lesinski7ad11102016-10-28 16:39:15 -0700597 return false;
598 }
599
600 const size_t package_count = dtohl(header->packageCount);
601 size_t packages_seen = 0;
602
603 packages_.reserve(package_count);
604
605 ChunkIterator iter(chunk.data_ptr(), chunk.data_size());
606 while (iter.HasNext()) {
607 const Chunk child_chunk = iter.Next();
608 switch (child_chunk.type()) {
609 case RES_STRING_POOL_TYPE:
610 // Only use the first string pool. Ignore others.
611 if (global_string_pool_.getError() == NO_INIT) {
612 status_t err = global_string_pool_.setTo(child_chunk.header<ResStringPool_header>(),
613 child_chunk.size());
614 if (err != NO_ERROR) {
Adam Lesinski498f6052017-11-29 13:24:29 -0800615 LOG(ERROR) << "RES_STRING_POOL_TYPE corrupt.";
Adam Lesinski7ad11102016-10-28 16:39:15 -0700616 return false;
617 }
618 } else {
Adam Lesinski498f6052017-11-29 13:24:29 -0800619 LOG(WARNING) << "Multiple RES_STRING_POOL_TYPEs found in RES_TABLE_TYPE.";
Adam Lesinski7ad11102016-10-28 16:39:15 -0700620 }
621 break;
622
623 case RES_TABLE_PACKAGE_TYPE: {
624 if (packages_seen + 1 > package_count) {
625 LOG(ERROR) << "More package chunks were found than the " << package_count
Adam Lesinski970bd8d2017-09-25 13:21:55 -0700626 << " declared in the header.";
Adam Lesinski7ad11102016-10-28 16:39:15 -0700627 return false;
628 }
629 packages_seen++;
630
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700631 std::unique_ptr<const LoadedPackage> loaded_package =
632 LoadedPackage::Load(child_chunk, loaded_idmap, system_, load_as_shared_library);
Adam Lesinskida431a22016-12-29 16:08:16 -0500633 if (!loaded_package) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700634 return false;
635 }
636 packages_.push_back(std::move(loaded_package));
637 } break;
638
639 default:
Adam Lesinski78695c32018-02-08 14:50:38 -0800640 LOG(WARNING) << StringPrintf("Unknown chunk type '%02x'.", chunk.type());
Adam Lesinski7ad11102016-10-28 16:39:15 -0700641 break;
642 }
643 }
644
645 if (iter.HadError()) {
646 LOG(ERROR) << iter.GetLastError();
647 return false;
648 }
649 return true;
650}
651
Adam Lesinski970bd8d2017-09-25 13:21:55 -0700652std::unique_ptr<const LoadedArsc> LoadedArsc::Load(const StringPiece& data,
653 const LoadedIdmap* loaded_idmap, bool system,
Adam Lesinski0c405242017-01-13 20:47:26 -0800654 bool load_as_shared_library) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700655 ATRACE_CALL();
656
657 // Not using make_unique because the constructor is private.
658 std::unique_ptr<LoadedArsc> loaded_arsc(new LoadedArsc());
Adam Lesinski0c405242017-01-13 20:47:26 -0800659 loaded_arsc->system_ = system;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700660
Adam Lesinski970bd8d2017-09-25 13:21:55 -0700661 ChunkIterator iter(data.data(), data.size());
Adam Lesinski7ad11102016-10-28 16:39:15 -0700662 while (iter.HasNext()) {
663 const Chunk chunk = iter.Next();
664 switch (chunk.type()) {
665 case RES_TABLE_TYPE:
Adam Lesinski970bd8d2017-09-25 13:21:55 -0700666 if (!loaded_arsc->LoadTable(chunk, loaded_idmap, load_as_shared_library)) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700667 return {};
668 }
669 break;
670
671 default:
Adam Lesinski78695c32018-02-08 14:50:38 -0800672 LOG(WARNING) << StringPrintf("Unknown chunk type '%02x'.", chunk.type());
Adam Lesinski7ad11102016-10-28 16:39:15 -0700673 break;
674 }
675 }
676
677 if (iter.HadError()) {
678 LOG(ERROR) << iter.GetLastError();
679 return {};
680 }
Adam Lesinski0c405242017-01-13 20:47:26 -0800681
682 // Need to force a move for mingw32.
683 return std::move(loaded_arsc);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700684}
685
Adam Lesinski970bd8d2017-09-25 13:21:55 -0700686std::unique_ptr<const LoadedArsc> LoadedArsc::CreateEmpty() {
687 return std::unique_ptr<LoadedArsc>(new LoadedArsc());
688}
689
Adam Lesinski7ad11102016-10-28 16:39:15 -0700690} // namespace android