blob: c47db69a48b61998efe88ebb5340aa31c5cb1328 [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/AssetManager2.h"
20
Adam Lesinski30080e22017-10-16 16:18:09 -070021#include <iterator>
Adam Lesinski0c405242017-01-13 20:47:26 -080022#include <set>
23
Adam Lesinski7ad11102016-10-28 16:39:15 -070024#include "android-base/logging.h"
25#include "android-base/stringprintf.h"
26#include "utils/ByteOrder.h"
27#include "utils/Trace.h"
28
29#ifdef _WIN32
30#ifdef ERROR
31#undef ERROR
32#endif
33#endif
34
Adam Lesinski929d6512017-01-16 19:11:19 -080035#include "androidfw/ResourceUtils.h"
36
Adam Lesinski7ad11102016-10-28 16:39:15 -070037namespace android {
38
Adam Lesinski970bd8d2017-09-25 13:21:55 -070039AssetManager2::AssetManager2() {
40 memset(&configuration_, 0, sizeof(configuration_));
41}
Adam Lesinski7ad11102016-10-28 16:39:15 -070042
43bool AssetManager2::SetApkAssets(const std::vector<const ApkAssets*>& apk_assets,
44 bool invalidate_caches) {
45 apk_assets_ = apk_assets;
Adam Lesinskida431a22016-12-29 16:08:16 -050046 BuildDynamicRefTable();
Adam Lesinski7ad11102016-10-28 16:39:15 -070047 if (invalidate_caches) {
48 InvalidateCaches(static_cast<uint32_t>(-1));
49 }
50 return true;
51}
52
Adam Lesinskida431a22016-12-29 16:08:16 -050053void AssetManager2::BuildDynamicRefTable() {
54 package_groups_.clear();
55 package_ids_.fill(0xff);
56
57 // 0x01 is reserved for the android package.
58 int next_package_id = 0x02;
59 const size_t apk_assets_count = apk_assets_.size();
60 for (size_t i = 0; i < apk_assets_count; i++) {
Adam Lesinski970bd8d2017-09-25 13:21:55 -070061 const LoadedArsc* loaded_arsc = apk_assets_[i]->GetLoadedArsc();
62
63 for (const std::unique_ptr<const LoadedPackage>& package : loaded_arsc->GetPackages()) {
Adam Lesinskida431a22016-12-29 16:08:16 -050064 // Get the package ID or assign one if a shared library.
65 int package_id;
66 if (package->IsDynamic()) {
67 package_id = next_package_id++;
68 } else {
69 package_id = package->GetPackageId();
70 }
71
72 // Add the mapping for package ID to index if not present.
73 uint8_t idx = package_ids_[package_id];
74 if (idx == 0xff) {
75 package_ids_[package_id] = idx = static_cast<uint8_t>(package_groups_.size());
76 package_groups_.push_back({});
77 package_groups_.back().dynamic_ref_table.mAssignedPackageId = package_id;
78 }
79 PackageGroup* package_group = &package_groups_[idx];
80
81 // Add the package and to the set of packages with the same ID.
82 package_group->packages_.push_back(package.get());
83 package_group->cookies_.push_back(static_cast<ApkAssetsCookie>(i));
84
85 // Add the package name -> build time ID mappings.
86 for (const DynamicPackageEntry& entry : package->GetDynamicPackageMap()) {
87 String16 package_name(entry.package_name.c_str(), entry.package_name.size());
88 package_group->dynamic_ref_table.mEntries.replaceValueFor(
89 package_name, static_cast<uint8_t>(entry.package_id));
90 }
91 }
92 }
93
94 // Now assign the runtime IDs so that we have a build-time to runtime ID map.
95 const auto package_groups_end = package_groups_.end();
96 for (auto iter = package_groups_.begin(); iter != package_groups_end; ++iter) {
97 const std::string& package_name = iter->packages_[0]->GetPackageName();
98 for (auto iter2 = package_groups_.begin(); iter2 != package_groups_end; ++iter2) {
99 iter2->dynamic_ref_table.addMapping(String16(package_name.c_str(), package_name.size()),
100 iter->dynamic_ref_table.mAssignedPackageId);
101 }
102 }
103}
104
105void AssetManager2::DumpToLog() const {
106 base::ScopedLogSeverity _log(base::INFO);
107
108 std::string list;
109 for (size_t i = 0; i < package_ids_.size(); i++) {
110 if (package_ids_[i] != 0xff) {
111 base::StringAppendF(&list, "%02x -> %d, ", (int) i, package_ids_[i]);
112 }
113 }
114 LOG(INFO) << "Package ID map: " << list;
115
116 for (const auto& package_group: package_groups_) {
117 list = "";
118 for (const auto& package : package_group.packages_) {
119 base::StringAppendF(&list, "%s(%02x), ", package->GetPackageName().c_str(), package->GetPackageId());
120 }
121 LOG(INFO) << base::StringPrintf("PG (%02x): ", package_group.dynamic_ref_table.mAssignedPackageId) << list;
122 }
123}
Adam Lesinski7ad11102016-10-28 16:39:15 -0700124
125const ResStringPool* AssetManager2::GetStringPoolForCookie(ApkAssetsCookie cookie) const {
126 if (cookie < 0 || static_cast<size_t>(cookie) >= apk_assets_.size()) {
127 return nullptr;
128 }
129 return apk_assets_[cookie]->GetLoadedArsc()->GetStringPool();
130}
131
Adam Lesinskida431a22016-12-29 16:08:16 -0500132const DynamicRefTable* AssetManager2::GetDynamicRefTableForPackage(uint32_t package_id) const {
133 if (package_id >= package_ids_.size()) {
134 return nullptr;
135 }
136
137 const size_t idx = package_ids_[package_id];
138 if (idx == 0xff) {
139 return nullptr;
140 }
141 return &package_groups_[idx].dynamic_ref_table;
142}
143
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800144const DynamicRefTable* AssetManager2::GetDynamicRefTableForCookie(ApkAssetsCookie cookie) const {
145 for (const PackageGroup& package_group : package_groups_) {
146 for (const ApkAssetsCookie& package_cookie : package_group.cookies_) {
147 if (package_cookie == cookie) {
148 return &package_group.dynamic_ref_table;
149 }
150 }
151 }
152 return nullptr;
153}
154
Adam Lesinski7ad11102016-10-28 16:39:15 -0700155void AssetManager2::SetConfiguration(const ResTable_config& configuration) {
156 const int diff = configuration_.diff(configuration);
157 configuration_ = configuration;
158
159 if (diff) {
160 InvalidateCaches(static_cast<uint32_t>(diff));
161 }
162}
163
Adam Lesinski0c405242017-01-13 20:47:26 -0800164std::set<ResTable_config> AssetManager2::GetResourceConfigurations(bool exclude_system,
165 bool exclude_mipmap) {
166 ATRACE_CALL();
167 std::set<ResTable_config> configurations;
168 for (const PackageGroup& package_group : package_groups_) {
169 for (const LoadedPackage* package : package_group.packages_) {
170 if (exclude_system && package->IsSystem()) {
171 continue;
172 }
173 package->CollectConfigurations(exclude_mipmap, &configurations);
174 }
175 }
176 return configurations;
177}
178
179std::set<std::string> AssetManager2::GetResourceLocales(bool exclude_system,
180 bool merge_equivalent_languages) {
181 ATRACE_CALL();
182 std::set<std::string> locales;
183 for (const PackageGroup& package_group : package_groups_) {
184 for (const LoadedPackage* package : package_group.packages_) {
185 if (exclude_system && package->IsSystem()) {
186 continue;
187 }
188 package->CollectLocales(merge_equivalent_languages, &locales);
189 }
190 }
191 return locales;
192}
193
Adam Lesinski7ad11102016-10-28 16:39:15 -0700194std::unique_ptr<Asset> AssetManager2::Open(const std::string& filename, Asset::AccessMode mode) {
195 const std::string new_path = "assets/" + filename;
196 return OpenNonAsset(new_path, mode);
197}
198
199std::unique_ptr<Asset> AssetManager2::Open(const std::string& filename, ApkAssetsCookie cookie,
200 Asset::AccessMode mode) {
201 const std::string new_path = "assets/" + filename;
202 return OpenNonAsset(new_path, cookie, mode);
203}
204
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800205std::unique_ptr<AssetDir> AssetManager2::OpenDir(const std::string& dirname) {
206 ATRACE_CALL();
207
208 std::string full_path = "assets/" + dirname;
209 std::unique_ptr<SortedVector<AssetDir::FileInfo>> files =
210 util::make_unique<SortedVector<AssetDir::FileInfo>>();
211
212 // Start from the back.
213 for (auto iter = apk_assets_.rbegin(); iter != apk_assets_.rend(); ++iter) {
214 const ApkAssets* apk_assets = *iter;
215
216 auto func = [&](const StringPiece& name, FileType type) {
217 AssetDir::FileInfo info;
218 info.setFileName(String8(name.data(), name.size()));
219 info.setFileType(type);
220 info.setSourceName(String8(apk_assets->GetPath().c_str()));
221 files->add(info);
222 };
223
224 if (!apk_assets->ForEachFile(full_path, func)) {
225 return {};
226 }
227 }
228
229 std::unique_ptr<AssetDir> asset_dir = util::make_unique<AssetDir>();
230 asset_dir->setFileList(files.release());
231 return asset_dir;
232}
233
Adam Lesinski7ad11102016-10-28 16:39:15 -0700234// Search in reverse because that's how we used to do it and we need to preserve behaviour.
235// This is unfortunate, because ClassLoaders delegate to the parent first, so the order
236// is inconsistent for split APKs.
237std::unique_ptr<Asset> AssetManager2::OpenNonAsset(const std::string& filename,
238 Asset::AccessMode mode,
239 ApkAssetsCookie* out_cookie) {
240 ATRACE_CALL();
241 for (int32_t i = apk_assets_.size() - 1; i >= 0; i--) {
242 std::unique_ptr<Asset> asset = apk_assets_[i]->Open(filename, mode);
243 if (asset) {
244 if (out_cookie != nullptr) {
245 *out_cookie = i;
246 }
247 return asset;
248 }
249 }
250
251 if (out_cookie != nullptr) {
252 *out_cookie = kInvalidCookie;
253 }
254 return {};
255}
256
257std::unique_ptr<Asset> AssetManager2::OpenNonAsset(const std::string& filename,
258 ApkAssetsCookie cookie, Asset::AccessMode mode) {
259 ATRACE_CALL();
260 if (cookie < 0 || static_cast<size_t>(cookie) >= apk_assets_.size()) {
261 return {};
262 }
263 return apk_assets_[cookie]->Open(filename, mode);
264}
265
266ApkAssetsCookie AssetManager2::FindEntry(uint32_t resid, uint16_t density_override,
Adam Lesinskida431a22016-12-29 16:08:16 -0500267 bool stop_at_first_match, LoadedArscEntry* out_entry,
Adam Lesinski7ad11102016-10-28 16:39:15 -0700268 ResTable_config* out_selected_config,
269 uint32_t* out_flags) {
270 ATRACE_CALL();
271
272 // Might use this if density_override != 0.
273 ResTable_config density_override_config;
274
275 // Select our configuration or generate a density override configuration.
276 ResTable_config* desired_config = &configuration_;
277 if (density_override != 0 && density_override != configuration_.density) {
278 density_override_config = configuration_;
279 density_override_config.density = density_override;
280 desired_config = &density_override_config;
281 }
282
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800283 if (!is_valid_resid(resid)) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500284 LOG(ERROR) << base::StringPrintf("Invalid ID 0x%08x.", resid);
285 return kInvalidCookie;
286 }
287
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800288 const uint32_t package_id = get_package_id(resid);
289 const uint8_t type_idx = get_type_id(resid) - 1;
290 const uint16_t entry_id = get_entry_id(resid);
291
Adam Lesinskida431a22016-12-29 16:08:16 -0500292 const uint8_t idx = package_ids_[package_id];
293 if (idx == 0xff) {
294 LOG(ERROR) << base::StringPrintf("No package ID %02x found for ID 0x%08x.", package_id, resid);
295 return kInvalidCookie;
296 }
297
298 LoadedArscEntry best_entry;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700299 ResTable_config best_config;
Adam Lesinskida431a22016-12-29 16:08:16 -0500300 ApkAssetsCookie best_cookie = kInvalidCookie;
301 uint32_t cumulated_flags = 0u;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700302
Adam Lesinskida431a22016-12-29 16:08:16 -0500303 const PackageGroup& package_group = package_groups_[idx];
304 const size_t package_count = package_group.packages_.size();
305 for (size_t i = 0; i < package_count; i++) {
306 LoadedArscEntry current_entry;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700307 ResTable_config current_config;
Adam Lesinskida431a22016-12-29 16:08:16 -0500308 uint32_t current_flags = 0;
309
310 const LoadedPackage* loaded_package = package_group.packages_[i];
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800311 if (!loaded_package->FindEntry(type_idx, entry_id, *desired_config, &current_entry,
Adam Lesinskida431a22016-12-29 16:08:16 -0500312 &current_config, &current_flags)) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700313 continue;
314 }
315
Adam Lesinskida431a22016-12-29 16:08:16 -0500316 cumulated_flags |= current_flags;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700317
Adam Lesinski970bd8d2017-09-25 13:21:55 -0700318 if (best_cookie == kInvalidCookie || current_config.isBetterThan(best_config, desired_config) ||
319 (loaded_package->IsOverlay() && current_config.compare(best_config) == 0)) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700320 best_entry = current_entry;
321 best_config = current_config;
Adam Lesinskida431a22016-12-29 16:08:16 -0500322 best_cookie = package_group.cookies_[i];
Adam Lesinski7ad11102016-10-28 16:39:15 -0700323 if (stop_at_first_match) {
324 break;
325 }
326 }
327 }
328
Adam Lesinskida431a22016-12-29 16:08:16 -0500329 if (best_cookie == kInvalidCookie) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700330 return kInvalidCookie;
331 }
332
333 *out_entry = best_entry;
Adam Lesinskida431a22016-12-29 16:08:16 -0500334 out_entry->dynamic_ref_table = &package_group.dynamic_ref_table;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700335 *out_selected_config = best_config;
336 *out_flags = cumulated_flags;
Adam Lesinskida431a22016-12-29 16:08:16 -0500337 return best_cookie;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700338}
339
340bool AssetManager2::GetResourceName(uint32_t resid, ResourceName* out_name) {
341 ATRACE_CALL();
342
Adam Lesinskida431a22016-12-29 16:08:16 -0500343 LoadedArscEntry entry;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700344 ResTable_config config;
345 uint32_t flags = 0u;
346 ApkAssetsCookie cookie = FindEntry(resid, 0u /* density_override */,
347 true /* stop_at_first_match */, &entry, &config, &flags);
348 if (cookie == kInvalidCookie) {
349 return false;
350 }
351
Adam Lesinskida431a22016-12-29 16:08:16 -0500352 const LoadedPackage* package = apk_assets_[cookie]->GetLoadedArsc()->GetPackageForId(resid);
353 if (package == nullptr) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700354 return false;
355 }
356
Adam Lesinskida431a22016-12-29 16:08:16 -0500357 out_name->package = package->GetPackageName().data();
358 out_name->package_len = package->GetPackageName().size();
Adam Lesinski7ad11102016-10-28 16:39:15 -0700359
360 out_name->type = entry.type_string_ref.string8(&out_name->type_len);
361 out_name->type16 = nullptr;
362 if (out_name->type == nullptr) {
363 out_name->type16 = entry.type_string_ref.string16(&out_name->type_len);
364 if (out_name->type16 == nullptr) {
365 return false;
366 }
367 }
368
369 out_name->entry = entry.entry_string_ref.string8(&out_name->entry_len);
370 out_name->entry16 = nullptr;
371 if (out_name->entry == nullptr) {
372 out_name->entry16 = entry.entry_string_ref.string16(&out_name->entry_len);
373 if (out_name->entry16 == nullptr) {
374 return false;
375 }
376 }
377 return true;
378}
379
380bool AssetManager2::GetResourceFlags(uint32_t resid, uint32_t* out_flags) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500381 LoadedArscEntry entry;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700382 ResTable_config config;
383 ApkAssetsCookie cookie = FindEntry(resid, 0u /* density_override */,
384 false /* stop_at_first_match */, &entry, &config, out_flags);
385 return cookie != kInvalidCookie;
386}
387
388ApkAssetsCookie AssetManager2::GetResource(uint32_t resid, bool may_be_bag,
389 uint16_t density_override, Res_value* out_value,
390 ResTable_config* out_selected_config,
391 uint32_t* out_flags) {
392 ATRACE_CALL();
393
Adam Lesinskida431a22016-12-29 16:08:16 -0500394 LoadedArscEntry entry;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700395 ResTable_config config;
396 uint32_t flags = 0u;
397 ApkAssetsCookie cookie =
398 FindEntry(resid, density_override, false /* stop_at_first_match */, &entry, &config, &flags);
399 if (cookie == kInvalidCookie) {
400 return kInvalidCookie;
401 }
402
403 if (dtohl(entry.entry->flags) & ResTable_entry::FLAG_COMPLEX) {
404 if (!may_be_bag) {
405 LOG(ERROR) << base::StringPrintf("Resource %08x is a complex map type.", resid);
Adam Lesinski0c405242017-01-13 20:47:26 -0800406 return kInvalidCookie;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700407 }
Adam Lesinski0c405242017-01-13 20:47:26 -0800408
409 // Create a reference since we can't represent this complex type as a Res_value.
410 out_value->dataType = Res_value::TYPE_REFERENCE;
411 out_value->data = resid;
412 *out_selected_config = config;
413 *out_flags = flags;
414 return cookie;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700415 }
416
417 const Res_value* device_value = reinterpret_cast<const Res_value*>(
418 reinterpret_cast<const uint8_t*>(entry.entry) + dtohs(entry.entry->size));
419 out_value->copyFrom_dtoh(*device_value);
Adam Lesinskida431a22016-12-29 16:08:16 -0500420
421 // Convert the package ID to the runtime assigned package ID.
422 entry.dynamic_ref_table->lookupResourceValue(out_value);
423
Adam Lesinski7ad11102016-10-28 16:39:15 -0700424 *out_selected_config = config;
425 *out_flags = flags;
426 return cookie;
427}
428
Adam Lesinski0c405242017-01-13 20:47:26 -0800429ApkAssetsCookie AssetManager2::ResolveReference(ApkAssetsCookie cookie, Res_value* in_out_value,
430 ResTable_config* in_out_selected_config,
431 uint32_t* in_out_flags,
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800432 uint32_t* out_last_reference) {
Adam Lesinski0c405242017-01-13 20:47:26 -0800433 ATRACE_CALL();
434 constexpr const int kMaxIterations = 20;
435
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800436 *out_last_reference = 0u;
Adam Lesinski0c405242017-01-13 20:47:26 -0800437 for (size_t iteration = 0u; in_out_value->dataType == Res_value::TYPE_REFERENCE &&
438 in_out_value->data != 0u && iteration < kMaxIterations;
439 iteration++) {
440 if (out_last_reference != nullptr) {
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800441 *out_last_reference = in_out_value->data;
Adam Lesinski0c405242017-01-13 20:47:26 -0800442 }
443 uint32_t new_flags = 0u;
444 cookie = GetResource(in_out_value->data, true /*may_be_bag*/, 0u /*density_override*/,
445 in_out_value, in_out_selected_config, &new_flags);
446 if (cookie == kInvalidCookie) {
447 return kInvalidCookie;
448 }
449 if (in_out_flags != nullptr) {
450 *in_out_flags |= new_flags;
451 }
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800452 if (*out_last_reference == in_out_value->data) {
Adam Lesinski0c405242017-01-13 20:47:26 -0800453 // This reference can't be resolved, so exit now and let the caller deal with it.
454 return cookie;
455 }
456 }
457 return cookie;
458}
459
Adam Lesinski7ad11102016-10-28 16:39:15 -0700460const ResolvedBag* AssetManager2::GetBag(uint32_t resid) {
461 ATRACE_CALL();
462
463 auto cached_iter = cached_bags_.find(resid);
464 if (cached_iter != cached_bags_.end()) {
465 return cached_iter->second.get();
466 }
467
Adam Lesinskida431a22016-12-29 16:08:16 -0500468 LoadedArscEntry entry;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700469 ResTable_config config;
470 uint32_t flags = 0u;
471 ApkAssetsCookie cookie = FindEntry(resid, 0u /* density_override */,
472 false /* stop_at_first_match */, &entry, &config, &flags);
473 if (cookie == kInvalidCookie) {
474 return nullptr;
475 }
476
477 // Check that the size of the entry header is at least as big as
478 // the desired ResTable_map_entry. Also verify that the entry
479 // was intended to be a map.
480 if (dtohs(entry.entry->size) < sizeof(ResTable_map_entry) ||
481 (dtohs(entry.entry->flags) & ResTable_entry::FLAG_COMPLEX) == 0) {
482 // Not a bag, nothing to do.
483 return nullptr;
484 }
485
486 const ResTable_map_entry* map = reinterpret_cast<const ResTable_map_entry*>(entry.entry);
487 const ResTable_map* map_entry =
488 reinterpret_cast<const ResTable_map*>(reinterpret_cast<const uint8_t*>(map) + map->size);
489 const ResTable_map* const map_entry_end = map_entry + dtohl(map->count);
490
Adam Lesinskida431a22016-12-29 16:08:16 -0500491 uint32_t parent_resid = dtohl(map->parent.ident);
492 if (parent_resid == 0) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700493 // There is no parent, meaning there is nothing to inherit and we can do a simple
494 // copy of the entries in the map.
495 const size_t entry_count = map_entry_end - map_entry;
496 util::unique_cptr<ResolvedBag> new_bag{reinterpret_cast<ResolvedBag*>(
497 malloc(sizeof(ResolvedBag) + (entry_count * sizeof(ResolvedBag::Entry))))};
498 ResolvedBag::Entry* new_entry = new_bag->entries;
499 for (; map_entry != map_entry_end; ++map_entry) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500500 uint32_t new_key = dtohl(map_entry->name.ident);
Adam Lesinski929d6512017-01-16 19:11:19 -0800501 if (!is_internal_resid(new_key)) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500502 // Attributes, arrays, etc don't have a resource id as the name. They specify
503 // other data, which would be wrong to change via a lookup.
504 if (entry.dynamic_ref_table->lookupResourceId(&new_key) != NO_ERROR) {
505 LOG(ERROR) << base::StringPrintf("Failed to resolve key 0x%08x in bag 0x%08x.", new_key, resid);
506 return nullptr;
507 }
508 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700509 new_entry->cookie = cookie;
Adam Lesinskida431a22016-12-29 16:08:16 -0500510 new_entry->key = new_key;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700511 new_entry->key_pool = nullptr;
512 new_entry->type_pool = nullptr;
Adam Lesinski30080e22017-10-16 16:18:09 -0700513 new_entry->value.copyFrom_dtoh(map_entry->value);
514 status_t err = entry.dynamic_ref_table->lookupResourceValue(&new_entry->value);
515 if (err != NO_ERROR) {
516 LOG(ERROR) << base::StringPrintf(
517 "Failed to resolve value t=0x%02x d=0x%08x for key 0x%08x.", new_entry->value.dataType,
518 new_entry->value.data, new_key);
519 return nullptr;
520 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700521 ++new_entry;
522 }
523 new_bag->type_spec_flags = flags;
524 new_bag->entry_count = static_cast<uint32_t>(entry_count);
525 ResolvedBag* result = new_bag.get();
526 cached_bags_[resid] = std::move(new_bag);
527 return result;
528 }
529
Adam Lesinskida431a22016-12-29 16:08:16 -0500530 // In case the parent is a dynamic reference, resolve it.
531 entry.dynamic_ref_table->lookupResourceId(&parent_resid);
532
Adam Lesinski7ad11102016-10-28 16:39:15 -0700533 // Get the parent and do a merge of the keys.
Adam Lesinskida431a22016-12-29 16:08:16 -0500534 const ResolvedBag* parent_bag = GetBag(parent_resid);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700535 if (parent_bag == nullptr) {
536 // Failed to get the parent that should exist.
Adam Lesinskida431a22016-12-29 16:08:16 -0500537 LOG(ERROR) << base::StringPrintf("Failed to find parent 0x%08x of bag 0x%08x.", parent_resid, resid);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700538 return nullptr;
539 }
540
541 // Combine flags from the parent and our own bag.
542 flags |= parent_bag->type_spec_flags;
543
544 // Create the max possible entries we can make. Once we construct the bag,
545 // we will realloc to fit to size.
546 const size_t max_count = parent_bag->entry_count + dtohl(map->count);
George Burgess IV09b119f2017-07-25 15:00:04 -0700547 util::unique_cptr<ResolvedBag> new_bag{reinterpret_cast<ResolvedBag*>(
548 malloc(sizeof(ResolvedBag) + (max_count * sizeof(ResolvedBag::Entry))))};
Adam Lesinski7ad11102016-10-28 16:39:15 -0700549 ResolvedBag::Entry* new_entry = new_bag->entries;
550
551 const ResolvedBag::Entry* parent_entry = parent_bag->entries;
552 const ResolvedBag::Entry* const parent_entry_end = parent_entry + parent_bag->entry_count;
553
554 // The keys are expected to be in sorted order. Merge the two bags.
555 while (map_entry != map_entry_end && parent_entry != parent_entry_end) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500556 uint32_t child_key = dtohl(map_entry->name.ident);
Adam Lesinski929d6512017-01-16 19:11:19 -0800557 if (!is_internal_resid(child_key)) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500558 if (entry.dynamic_ref_table->lookupResourceId(&child_key) != NO_ERROR) {
559 LOG(ERROR) << base::StringPrintf("Failed to resolve key 0x%08x in bag 0x%08x.", child_key, resid);
560 return nullptr;
561 }
562 }
563
Adam Lesinski7ad11102016-10-28 16:39:15 -0700564 if (child_key <= parent_entry->key) {
565 // Use the child key if it comes before the parent
566 // or is equal to the parent (overrides).
567 new_entry->cookie = cookie;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700568 new_entry->key = child_key;
569 new_entry->key_pool = nullptr;
570 new_entry->type_pool = nullptr;
Adam Lesinski30080e22017-10-16 16:18:09 -0700571 new_entry->value.copyFrom_dtoh(map_entry->value);
572 status_t err = entry.dynamic_ref_table->lookupResourceValue(&new_entry->value);
573 if (err != NO_ERROR) {
574 LOG(ERROR) << base::StringPrintf(
575 "Failed to resolve value t=0x%02x d=0x%08x for key 0x%08x.", new_entry->value.dataType,
576 new_entry->value.data, child_key);
577 return nullptr;
578 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700579 ++map_entry;
580 } else {
581 // Take the parent entry as-is.
582 memcpy(new_entry, parent_entry, sizeof(*new_entry));
583 }
584
585 if (child_key >= parent_entry->key) {
586 // Move to the next parent entry if we used it or it was overridden.
587 ++parent_entry;
588 }
589 // Increment to the next entry to fill.
590 ++new_entry;
591 }
592
593 // Finish the child entries if they exist.
594 while (map_entry != map_entry_end) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500595 uint32_t new_key = dtohl(map_entry->name.ident);
Adam Lesinski929d6512017-01-16 19:11:19 -0800596 if (!is_internal_resid(new_key)) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500597 if (entry.dynamic_ref_table->lookupResourceId(&new_key) != NO_ERROR) {
598 LOG(ERROR) << base::StringPrintf("Failed to resolve key 0x%08x in bag 0x%08x.", new_key, resid);
599 return nullptr;
600 }
601 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700602 new_entry->cookie = cookie;
Adam Lesinskida431a22016-12-29 16:08:16 -0500603 new_entry->key = new_key;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700604 new_entry->key_pool = nullptr;
605 new_entry->type_pool = nullptr;
Adam Lesinski30080e22017-10-16 16:18:09 -0700606 new_entry->value.copyFrom_dtoh(map_entry->value);
607 status_t err = entry.dynamic_ref_table->lookupResourceValue(&new_entry->value);
608 if (err != NO_ERROR) {
609 LOG(ERROR) << base::StringPrintf("Failed to resolve value t=0x%02x d=0x%08x for key 0x%08x.",
610 new_entry->value.dataType, new_entry->value.data, new_key);
611 return nullptr;
612 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700613 ++map_entry;
614 ++new_entry;
615 }
616
617 // Finish the parent entries if they exist.
618 if (parent_entry != parent_entry_end) {
619 // Take the rest of the parent entries as-is.
620 const size_t num_entries_to_copy = parent_entry_end - parent_entry;
621 memcpy(new_entry, parent_entry, num_entries_to_copy * sizeof(*new_entry));
622 new_entry += num_entries_to_copy;
623 }
624
625 // Resize the resulting array to fit.
626 const size_t actual_count = new_entry - new_bag->entries;
627 if (actual_count != max_count) {
George Burgess IV09b119f2017-07-25 15:00:04 -0700628 new_bag.reset(reinterpret_cast<ResolvedBag*>(realloc(
629 new_bag.release(), sizeof(ResolvedBag) + (actual_count * sizeof(ResolvedBag::Entry)))));
Adam Lesinski7ad11102016-10-28 16:39:15 -0700630 }
631
George Burgess IV09b119f2017-07-25 15:00:04 -0700632 new_bag->type_spec_flags = flags;
633 new_bag->entry_count = static_cast<uint32_t>(actual_count);
634 ResolvedBag* result = new_bag.get();
635 cached_bags_[resid] = std::move(new_bag);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700636 return result;
637}
638
Adam Lesinski929d6512017-01-16 19:11:19 -0800639static bool Utf8ToUtf16(const StringPiece& str, std::u16string* out) {
640 ssize_t len =
641 utf8_to_utf16_length(reinterpret_cast<const uint8_t*>(str.data()), str.size(), false);
642 if (len < 0) {
643 return false;
644 }
645 out->resize(static_cast<size_t>(len));
646 utf8_to_utf16(reinterpret_cast<const uint8_t*>(str.data()), str.size(), &*out->begin(),
647 static_cast<size_t>(len + 1));
648 return true;
649}
650
Adam Lesinski0c405242017-01-13 20:47:26 -0800651uint32_t AssetManager2::GetResourceId(const std::string& resource_name,
652 const std::string& fallback_type,
653 const std::string& fallback_package) {
Adam Lesinski929d6512017-01-16 19:11:19 -0800654 StringPiece package_name, type, entry;
655 if (!ExtractResourceName(resource_name, &package_name, &type, &entry)) {
656 return 0u;
657 }
658
659 if (entry.empty()) {
660 return 0u;
661 }
662
663 if (package_name.empty()) {
664 package_name = fallback_package;
665 }
666
667 if (type.empty()) {
668 type = fallback_type;
669 }
670
671 std::u16string type16;
672 if (!Utf8ToUtf16(type, &type16)) {
673 return 0u;
674 }
675
676 std::u16string entry16;
677 if (!Utf8ToUtf16(entry, &entry16)) {
678 return 0u;
679 }
680
681 const StringPiece16 kAttr16 = u"attr";
682 const static std::u16string kAttrPrivate16 = u"^attr-private";
683
684 for (const PackageGroup& package_group : package_groups_) {
685 for (const LoadedPackage* package : package_group.packages_) {
686 if (package_name != package->GetPackageName()) {
687 // All packages in the same group are expected to have the same package name.
688 break;
689 }
690
691 uint32_t resid = package->FindEntryByName(type16, entry16);
692 if (resid == 0u && kAttr16 == type16) {
693 // Private attributes in libraries (such as the framework) are sometimes encoded
694 // under the type '^attr-private' in order to leave the ID space of public 'attr'
695 // free for future additions. Check '^attr-private' for the same name.
696 resid = package->FindEntryByName(kAttrPrivate16, entry16);
697 }
698
699 if (resid != 0u) {
700 return fix_package_id(resid, package_group.dynamic_ref_table.mAssignedPackageId);
701 }
702 }
703 }
Adam Lesinski0c405242017-01-13 20:47:26 -0800704 return 0u;
705}
706
Adam Lesinski7ad11102016-10-28 16:39:15 -0700707void AssetManager2::InvalidateCaches(uint32_t diff) {
708 if (diff == 0xffffffffu) {
709 // Everything must go.
710 cached_bags_.clear();
711 return;
712 }
713
714 // Be more conservative with what gets purged. Only if the bag has other possible
715 // variations with respect to what changed (diff) should we remove it.
716 for (auto iter = cached_bags_.cbegin(); iter != cached_bags_.cend();) {
717 if (diff & iter->second->type_spec_flags) {
718 iter = cached_bags_.erase(iter);
719 } else {
720 ++iter;
721 }
722 }
723}
724
Adam Lesinski30080e22017-10-16 16:18:09 -0700725std::unique_ptr<Theme> AssetManager2::NewTheme() {
726 return std::unique_ptr<Theme>(new Theme(this));
727}
728
729Theme::Theme(AssetManager2* asset_manager) : asset_manager_(asset_manager) {
730}
731
732Theme::~Theme() = default;
733
734namespace {
735
736struct ThemeEntry {
737 ApkAssetsCookie cookie;
738 uint32_t type_spec_flags;
739 Res_value value;
740};
741
742struct ThemeType {
743 int entry_count;
744 ThemeEntry entries[0];
745};
746
747constexpr size_t kTypeCount = std::numeric_limits<uint8_t>::max() + 1;
748
749} // namespace
750
751struct Theme::Package {
752 // Each element of Type will be a dynamically sized object
753 // allocated to have the entries stored contiguously with the Type.
754 std::array<util::unique_cptr<ThemeType>, kTypeCount> types;
755};
Adam Lesinski7ad11102016-10-28 16:39:15 -0700756
757bool Theme::ApplyStyle(uint32_t resid, bool force) {
758 ATRACE_CALL();
759
760 const ResolvedBag* bag = asset_manager_->GetBag(resid);
761 if (bag == nullptr) {
762 return false;
763 }
764
765 // Merge the flags from this style.
766 type_spec_flags_ |= bag->type_spec_flags;
767
Adam Lesinski30080e22017-10-16 16:18:09 -0700768 int last_type_idx = -1;
769 int last_package_idx = -1;
770 Package* last_package = nullptr;
771 ThemeType* last_type = nullptr;
772
773 // Iterate backwards, because each bag is sorted in ascending key ID order, meaning we will only
774 // need to perform one resize per type.
775 using reverse_bag_iterator = std::reverse_iterator<const ResolvedBag::Entry*>;
776 const auto bag_iter_end = reverse_bag_iterator(begin(bag));
777 for (auto bag_iter = reverse_bag_iterator(end(bag)); bag_iter != bag_iter_end; ++bag_iter) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700778 const uint32_t attr_resid = bag_iter->key;
779
Adam Lesinski30080e22017-10-16 16:18:09 -0700780 // If the resource ID passed in is not a style, the key can be some other identifier that is not
781 // a resource ID. We should fail fast instead of operating with strange resource IDs.
Adam Lesinski929d6512017-01-16 19:11:19 -0800782 if (!is_valid_resid(attr_resid)) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700783 return false;
784 }
785
Adam Lesinski30080e22017-10-16 16:18:09 -0700786 // We don't use the 0-based index for the type so that we can avoid doing ID validation
787 // upon lookup. Instead, we keep space for the type ID 0 in our data structures. Since
788 // the construction of this type is guarded with a resource ID check, it will never be
789 // populated, and querying type ID 0 will always fail.
790 const int package_idx = get_package_id(attr_resid);
791 const int type_idx = get_type_id(attr_resid);
792 const int entry_idx = get_entry_id(attr_resid);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700793
Adam Lesinski30080e22017-10-16 16:18:09 -0700794 if (last_package_idx != package_idx) {
795 std::unique_ptr<Package>& package = packages_[package_idx];
796 if (package == nullptr) {
797 package.reset(new Package());
Adam Lesinski7ad11102016-10-28 16:39:15 -0700798 }
Adam Lesinski30080e22017-10-16 16:18:09 -0700799 last_package_idx = package_idx;
800 last_package = package.get();
801 last_type_idx = -1;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700802 }
Adam Lesinski30080e22017-10-16 16:18:09 -0700803
804 if (last_type_idx != type_idx) {
805 util::unique_cptr<ThemeType>& type = last_package->types[type_idx];
806 if (type == nullptr) {
807 // Allocate enough memory to contain this entry_idx. Since we're iterating in reverse over
808 // a sorted list of attributes, this shouldn't be resized again during this method call.
809 type.reset(reinterpret_cast<ThemeType*>(
810 calloc(sizeof(ThemeType) + (entry_idx + 1) * sizeof(ThemeEntry), 1)));
811 type->entry_count = entry_idx + 1;
812 } else if (entry_idx >= type->entry_count) {
813 // Reallocate the memory to contain this entry_idx. Since we're iterating in reverse over
814 // a sorted list of attributes, this shouldn't be resized again during this method call.
815 const int new_count = entry_idx + 1;
816 type.reset(reinterpret_cast<ThemeType*>(
817 realloc(type.release(), sizeof(ThemeType) + (new_count * sizeof(ThemeEntry)))));
818
819 // Clear out the newly allocated space (which isn't zeroed).
820 memset(type->entries + type->entry_count, 0,
821 (new_count - type->entry_count) * sizeof(ThemeEntry));
822 type->entry_count = new_count;
823 }
824 last_type_idx = type_idx;
825 last_type = type.get();
826 }
827
828 ThemeEntry& entry = last_type->entries[entry_idx];
829 if (force || (entry.value.dataType == Res_value::TYPE_NULL &&
830 entry.value.data != Res_value::DATA_NULL_EMPTY)) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700831 entry.cookie = bag_iter->cookie;
832 entry.type_spec_flags |= bag->type_spec_flags;
833 entry.value = bag_iter->value;
834 }
835 }
836 return true;
837}
838
839ApkAssetsCookie Theme::GetAttribute(uint32_t resid, Res_value* out_value,
840 uint32_t* out_flags) const {
Adam Lesinski30080e22017-10-16 16:18:09 -0700841 int cnt = 20;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700842
843 uint32_t type_spec_flags = 0u;
844
Adam Lesinski30080e22017-10-16 16:18:09 -0700845 do {
846 const int package_idx = get_package_id(resid);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700847 const Package* package = packages_[package_idx].get();
Adam Lesinski30080e22017-10-16 16:18:09 -0700848 if (package != nullptr) {
849 // The themes are constructed with a 1-based type ID, so no need to decrement here.
850 const int type_idx = get_type_id(resid);
851 const ThemeType* type = package->types[type_idx].get();
852 if (type != nullptr) {
853 const int entry_idx = get_entry_id(resid);
854 if (entry_idx < type->entry_count) {
855 const ThemeEntry& entry = type->entries[entry_idx];
856 type_spec_flags |= entry.type_spec_flags;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700857
Adam Lesinski30080e22017-10-16 16:18:09 -0700858 if (entry.value.dataType == Res_value::TYPE_ATTRIBUTE) {
859 if (cnt > 0) {
860 cnt--;
861 resid = entry.value.data;
862 continue;
863 }
864 return kInvalidCookie;
865 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700866
Adam Lesinski30080e22017-10-16 16:18:09 -0700867 // @null is different than @empty.
868 if (entry.value.dataType == Res_value::TYPE_NULL &&
869 entry.value.data != Res_value::DATA_NULL_EMPTY) {
870 return kInvalidCookie;
871 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700872
Adam Lesinski30080e22017-10-16 16:18:09 -0700873 *out_value = entry.value;
Adam Lesinskida431a22016-12-29 16:08:16 -0500874 *out_flags = type_spec_flags;
Adam Lesinski30080e22017-10-16 16:18:09 -0700875 return entry.cookie;
Adam Lesinskida431a22016-12-29 16:08:16 -0500876 }
Adam Lesinskida431a22016-12-29 16:08:16 -0500877 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700878 }
Adam Lesinski30080e22017-10-16 16:18:09 -0700879 break;
880 } while (true);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700881 return kInvalidCookie;
882}
883
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800884ApkAssetsCookie Theme::ResolveAttributeReference(ApkAssetsCookie cookie, Res_value* in_out_value,
885 ResTable_config* in_out_selected_config,
886 uint32_t* in_out_type_spec_flags,
887 uint32_t* out_last_ref) {
888 if (in_out_value->dataType == Res_value::TYPE_ATTRIBUTE) {
889 uint32_t new_flags;
890 cookie = GetAttribute(in_out_value->data, in_out_value, &new_flags);
891 if (cookie == kInvalidCookie) {
892 return kInvalidCookie;
893 }
894
895 if (in_out_type_spec_flags != nullptr) {
896 *in_out_type_spec_flags |= new_flags;
897 }
898 }
899 return asset_manager_->ResolveReference(cookie, in_out_value, in_out_selected_config,
900 in_out_type_spec_flags, out_last_ref);
901}
902
Adam Lesinski7ad11102016-10-28 16:39:15 -0700903void Theme::Clear() {
904 type_spec_flags_ = 0u;
905 for (std::unique_ptr<Package>& package : packages_) {
906 package.reset();
907 }
908}
909
910bool Theme::SetTo(const Theme& o) {
911 if (this == &o) {
912 return true;
913 }
914
Adam Lesinski7ad11102016-10-28 16:39:15 -0700915 type_spec_flags_ = o.type_spec_flags_;
916
Adam Lesinski03ebac82017-09-25 13:10:14 -0700917 const bool copy_only_system = asset_manager_ != o.asset_manager_;
918
Adam Lesinskida431a22016-12-29 16:08:16 -0500919 for (size_t p = 0; p < packages_.size(); p++) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700920 const Package* package = o.packages_[p].get();
Adam Lesinski03ebac82017-09-25 13:10:14 -0700921 if (package == nullptr || (copy_only_system && p != 0x01)) {
922 // The other theme doesn't have this package, clear ours.
Adam Lesinski7ad11102016-10-28 16:39:15 -0700923 packages_[p].reset();
924 continue;
925 }
926
Adam Lesinski03ebac82017-09-25 13:10:14 -0700927 if (packages_[p] == nullptr) {
928 // The other theme has this package, but we don't. Make one.
929 packages_[p].reset(new Package());
930 }
931
Adam Lesinskida431a22016-12-29 16:08:16 -0500932 for (size_t t = 0; t < package->types.size(); t++) {
Adam Lesinski30080e22017-10-16 16:18:09 -0700933 const ThemeType* type = package->types[t].get();
Adam Lesinski7ad11102016-10-28 16:39:15 -0700934 if (type == nullptr) {
Adam Lesinski03ebac82017-09-25 13:10:14 -0700935 // The other theme doesn't have this type, clear ours.
Adam Lesinski7ad11102016-10-28 16:39:15 -0700936 packages_[p]->types[t].reset();
937 continue;
938 }
939
Adam Lesinski03ebac82017-09-25 13:10:14 -0700940 // Create a new type and update it to theirs.
Adam Lesinski30080e22017-10-16 16:18:09 -0700941 const size_t type_alloc_size = sizeof(ThemeType) + (type->entry_count * sizeof(ThemeEntry));
Adam Lesinski7ad11102016-10-28 16:39:15 -0700942 void* copied_data = malloc(type_alloc_size);
943 memcpy(copied_data, type, type_alloc_size);
Adam Lesinski30080e22017-10-16 16:18:09 -0700944 packages_[p]->types[t].reset(reinterpret_cast<ThemeType*>(copied_data));
Adam Lesinski7ad11102016-10-28 16:39:15 -0700945 }
946 }
947 return true;
948}
949
950} // namespace android