blob: edccb8a73fc8fcfcc6c72fd283595aa6bfeddf0e [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
y57cd1952018-04-12 14:26:23 -070021#include <algorithm>
Adam Lesinski30080e22017-10-16 16:18:09 -070022#include <iterator>
Ryan Mitchellb3ae42e2018-10-16 12:48:38 -070023#include <map>
Winson2f3669b2019-01-11 11:28:34 -080024#include <set>
Yurii Zubrytskyi59dab3b2022-11-03 00:08:49 -070025#include <span>
Adam Lesinski0c405242017-01-13 20:47:26 -080026
Adam Lesinski7ad11102016-10-28 16:39:15 -070027#include "android-base/logging.h"
28#include "android-base/stringprintf.h"
Jackal Guo552b45d2021-09-29 10:52:19 +080029#include "androidfw/ResourceTypes.h"
Ryan Mitchell8a891d82019-07-01 09:48:23 -070030#include "androidfw/ResourceUtils.h"
Ryan Mitchell31b11052019-06-13 13:47:26 -070031#include "androidfw/Util.h"
Adam Lesinski7ad11102016-10-28 16:39:15 -070032#include "utils/ByteOrder.h"
33#include "utils/Trace.h"
34
35#ifdef _WIN32
36#ifdef ERROR
37#undef ERROR
38#endif
39#endif
40
41namespace android {
42
Ryan Mitchell80094e32020-11-16 23:08:18 +000043namespace {
44
45using EntryValue = std::variant<Res_value, incfs::verified_map_ptr<ResTable_map_entry>>;
46
Eric Miao368cd192022-09-09 15:46:14 -070047/* NOTE: table_entry has been verified in LoadedPackage::GetEntryFromOffset(),
48 * and so access to ->value() and ->map_entry() are safe here
49 */
Ryan Mitchell80094e32020-11-16 23:08:18 +000050base::expected<EntryValue, IOError> GetEntryValue(
51 incfs::verified_map_ptr<ResTable_entry> table_entry) {
Eric Miao368cd192022-09-09 15:46:14 -070052 const uint16_t entry_size = table_entry->size();
Ryan Mitchell80094e32020-11-16 23:08:18 +000053
54 // Check if the entry represents a bag value.
Eric Miao368cd192022-09-09 15:46:14 -070055 if (entry_size >= sizeof(ResTable_map_entry) && table_entry->is_complex()) {
56 return table_entry.convert<ResTable_map_entry>().verified();
Ryan Mitchell80094e32020-11-16 23:08:18 +000057 }
58
Eric Miao368cd192022-09-09 15:46:14 -070059 return table_entry->value();
Ryan Mitchell80094e32020-11-16 23:08:18 +000060}
61
62} // namespace
63
Adam Lesinskibebfcc42018-02-12 14:27:46 -080064struct FindEntryResult {
Ryan Mitchell80094e32020-11-16 23:08:18 +000065 // The cookie representing the ApkAssets in which the value resides.
66 ApkAssetsCookie cookie;
67
68 // The value of the resource table entry. Either an android::Res_value for non-bag types or an
69 // incfs::verified_map_ptr<ResTable_map_entry> for bag types.
70 EntryValue entry;
Adam Lesinskibebfcc42018-02-12 14:27:46 -080071
72 // The configuration for which the resulting entry was defined. This is already swapped to host
73 // endianness.
74 ResTable_config config;
75
76 // The bitmask of configuration axis with which the resource value varies.
77 uint32_t type_flags;
78
79 // The dynamic package ID map for the package from which this resource came from.
80 const DynamicRefTable* dynamic_ref_table;
81
Ryan Mitchell8a891d82019-07-01 09:48:23 -070082 // The package name of the resource.
83 const std::string* package_name;
84
Adam Lesinskibebfcc42018-02-12 14:27:46 -080085 // The string pool reference to the type's name. This uses a different string pool than
86 // the global string pool, but this is hidden from the caller.
87 StringPoolRef type_string_ref;
88
89 // The string pool reference to the entry's name. This uses a different string pool than
90 // the global string pool, but this is hidden from the caller.
91 StringPoolRef entry_string_ref;
92};
93
Ryan Prichard41e15a02023-08-30 22:19:30 -070094struct Theme::Entry {
95 ApkAssetsCookie cookie;
96 uint32_t type_spec_flags;
97 Res_value value;
98};
99
Jeremy Meyerccf5cd72023-08-15 21:42:03 +0000100AssetManager2::AssetManager2(ApkAssetsList apk_assets, const ResTable_config& configuration) {
101 configurations_.push_back(configuration);
102
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700103 // Don't invalidate caches here as there's nothing cached yet.
104 SetApkAssets(apk_assets, false);
Adam Lesinski970bd8d2017-09-25 13:21:55 -0700105}
Adam Lesinski7ad11102016-10-28 16:39:15 -0700106
Jeremy Meyerccf5cd72023-08-15 21:42:03 +0000107AssetManager2::AssetManager2() {
108 configurations_.resize(1);
109}
110
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700111bool AssetManager2::SetApkAssets(ApkAssetsList apk_assets, bool invalidate_caches) {
112 BuildDynamicRefTable(apk_assets);
Ryan Mitchell14e8ade2021-01-11 16:01:35 -0800113 RebuildFilterList();
Adam Lesinski7ad11102016-10-28 16:39:15 -0700114 if (invalidate_caches) {
115 InvalidateCaches(static_cast<uint32_t>(-1));
116 }
117 return true;
118}
119
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700120bool AssetManager2::SetApkAssets(std::initializer_list<ApkAssetsPtr> apk_assets,
121 bool invalidate_caches) {
122 return SetApkAssets(ApkAssetsList(apk_assets.begin(), apk_assets.size()), invalidate_caches);
123}
124
125void AssetManager2::BuildDynamicRefTable(ApkAssetsList apk_assets) {
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700126 auto op = StartOperation();
127
128 apk_assets_.resize(apk_assets.size());
129 for (size_t i = 0; i != apk_assets.size(); ++i) {
130 apk_assets_[i].first = apk_assets[i];
131 // Let's populate the locked assets right away as we're going to need them here later.
132 apk_assets_[i].second = apk_assets[i];
133 }
134
Adam Lesinskida431a22016-12-29 16:08:16 -0500135 package_groups_.clear();
136 package_ids_.fill(0xff);
137
Ryan Mitchellef538432021-03-01 14:52:14 -0800138 // A mapping from path of apk assets that could be target packages of overlays to the runtime
139 // package id of its first loaded package. Overlays currently can only override resources in the
140 // first package in the target resource table.
Yurii Zubrytskyie3f9be62022-11-14 18:30:10 -0800141 std::unordered_map<std::string_view, uint8_t> target_assets_package_ids;
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700142
Ryan Mitchell824cc492020-02-12 10:48:14 -0800143 // Overlay resources are not directly referenced by an application so their resource ids
144 // can change throughout the application's lifetime. Assign overlay package ids last.
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700145 std::vector<const ApkAssets*> sorted_apk_assets;
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700146 sorted_apk_assets.reserve(apk_assets.size());
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700147 for (auto& asset : apk_assets) {
148 sorted_apk_assets.push_back(asset.get());
149 }
150 std::stable_partition(sorted_apk_assets.begin(), sorted_apk_assets.end(),
151 [](auto a) { return !a->IsOverlay(); });
Ryan Mitchell824cc492020-02-12 10:48:14 -0800152
153 // The assets cookie must map to the position of the apk assets in the unsorted apk assets list.
154 std::unordered_map<const ApkAssets*, ApkAssetsCookie> apk_assets_cookies;
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700155 apk_assets_cookies.reserve(apk_assets.size());
156 for (size_t i = 0, n = apk_assets.size(); i < n; i++) {
157 apk_assets_cookies[apk_assets[i].get()] = static_cast<ApkAssetsCookie>(i);
Ryan Mitchell824cc492020-02-12 10:48:14 -0800158 }
159
Ryan Mitchellb894c272020-02-12 10:31:44 -0800160 // 0x01 is reserved for the android package.
161 int next_package_id = 0x02;
Ryan Mitchell824cc492020-02-12 10:48:14 -0800162 for (const ApkAssets* apk_assets : sorted_apk_assets) {
Ryan Mitchell2ed8bfa2021-01-08 13:34:28 -0800163 std::shared_ptr<OverlayDynamicRefTable> overlay_ref_table;
164 if (auto loaded_idmap = apk_assets->GetLoadedIdmap(); loaded_idmap != nullptr) {
165 // The target package must precede the overlay package in the apk assets paths in order
166 // to take effect.
Yurii Zubrytskyie3f9be62022-11-14 18:30:10 -0800167 auto iter = target_assets_package_ids.find(loaded_idmap->TargetApkPath());
Ryan Mitchellef538432021-03-01 14:52:14 -0800168 if (iter == target_assets_package_ids.end()) {
Ryan Mitchell2ed8bfa2021-01-08 13:34:28 -0800169 LOG(INFO) << "failed to find target package for overlay "
170 << loaded_idmap->OverlayApkPath();
171 } else {
172 uint8_t target_package_id = iter->second;
173
174 // Create a special dynamic reference table for the overlay to rewrite references to
175 // overlay resources as references to the target resources they overlay.
176 overlay_ref_table = std::make_shared<OverlayDynamicRefTable>(
177 loaded_idmap->GetOverlayDynamicRefTable(target_package_id));
178
179 // Add the overlay resource map to the target package's set of overlays.
180 const uint8_t target_idx = package_ids_[target_package_id];
181 CHECK(target_idx != 0xff) << "overlay target '" << loaded_idmap->TargetApkPath()
182 << "'added to apk_assets_package_ids but does not have an"
183 << " assigned package group";
184
185 PackageGroup& target_package_group = package_groups_[target_idx];
186 target_package_group.overlays_.push_back(
187 ConfiguredOverlay{loaded_idmap->GetTargetResourcesMap(target_package_id,
188 overlay_ref_table.get()),
189 apk_assets_cookies[apk_assets]});
190 }
191 }
192
Ryan Mitchellb894c272020-02-12 10:31:44 -0800193 const LoadedArsc* loaded_arsc = apk_assets->GetLoadedArsc();
Ryan Mitchellb894c272020-02-12 10:31:44 -0800194 for (const std::unique_ptr<const LoadedPackage>& package : loaded_arsc->GetPackages()) {
195 // Get the package ID or assign one if a shared library.
196 int package_id;
197 if (package->IsDynamic()) {
198 package_id = next_package_id++;
199 } else {
200 package_id = package->GetPackageId();
Adam Lesinskida431a22016-12-29 16:08:16 -0500201 }
202
Adam Lesinskida431a22016-12-29 16:08:16 -0500203 uint8_t idx = package_ids_[package_id];
204 if (idx == 0xff) {
Ryan Mitchell2ed8bfa2021-01-08 13:34:28 -0800205 // Add the mapping for package ID to index if not present.
Adam Lesinskida431a22016-12-29 16:08:16 -0500206 package_ids_[package_id] = idx = static_cast<uint8_t>(package_groups_.size());
Ryan Mitchell2ed8bfa2021-01-08 13:34:28 -0800207 PackageGroup& new_group = package_groups_.emplace_back();
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700208
Ryan Mitchell2ed8bfa2021-01-08 13:34:28 -0800209 if (overlay_ref_table != nullptr) {
210 // If this package is from an overlay, use a dynamic reference table that can rewrite
211 // overlay resource ids to their corresponding target resource ids.
Yurii Zubrytskyie3f9be62022-11-14 18:30:10 -0800212 new_group.dynamic_ref_table = std::move(overlay_ref_table);
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700213 }
214
Ryan Mitchell2ed8bfa2021-01-08 13:34:28 -0800215 DynamicRefTable* ref_table = new_group.dynamic_ref_table.get();
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700216 ref_table->mAssignedPackageId = package_id;
217 ref_table->mAppAsLib = package->IsDynamic() && package->GetPackageId() == 0x7f;
Adam Lesinskida431a22016-12-29 16:08:16 -0500218 }
Adam Lesinskida431a22016-12-29 16:08:16 -0500219
Yurii Zubrytskyie3f9be62022-11-14 18:30:10 -0800220 // Add the package to the set of packages with the same ID.
Ryan Mitchell2ed8bfa2021-01-08 13:34:28 -0800221 PackageGroup* package_group = &package_groups_[idx];
Yurii Zubrytskyie3f9be62022-11-14 18:30:10 -0800222 package_group->packages_.emplace_back().loaded_package_ = package.get();
Ryan Mitchell824cc492020-02-12 10:48:14 -0800223 package_group->cookies_.push_back(apk_assets_cookies[apk_assets]);
Adam Lesinskida431a22016-12-29 16:08:16 -0500224
225 // Add the package name -> build time ID mappings.
226 for (const DynamicPackageEntry& entry : package->GetDynamicPackageMap()) {
227 String16 package_name(entry.package_name.c_str(), entry.package_name.size());
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700228 package_group->dynamic_ref_table->mEntries.replaceValueFor(
Adam Lesinskida431a22016-12-29 16:08:16 -0500229 package_name, static_cast<uint8_t>(entry.package_id));
230 }
Ryan Mitchellb894c272020-02-12 10:31:44 -0800231
Ryan Mitchellef538432021-03-01 14:52:14 -0800232 if (auto apk_assets_path = apk_assets->GetPath()) {
233 // Overlay target ApkAssets must have been created using path based load apis.
Yurii Zubrytskyie3f9be62022-11-14 18:30:10 -0800234 target_assets_package_ids.emplace(*apk_assets_path, package_id);
Ryan Mitchellef538432021-03-01 14:52:14 -0800235 }
Adam Lesinskida431a22016-12-29 16:08:16 -0500236 }
237 }
238
239 // Now assign the runtime IDs so that we have a build-time to runtime ID map.
Yurii Zubrytskyi59dab3b2022-11-03 00:08:49 -0700240 DynamicRefTable::AliasMap aliases;
241 for (const auto& group : package_groups_) {
242 const std::string& package_name = group.packages_[0].loaded_package_->GetPackageName();
243 const auto name_16 = String16(package_name.c_str(), package_name.size());
244 for (auto&& inner_group : package_groups_) {
245 inner_group.dynamic_ref_table->addMapping(name_16,
246 group.dynamic_ref_table->mAssignedPackageId);
Adam Lesinskida431a22016-12-29 16:08:16 -0500247 }
Yurii Zubrytskyi59dab3b2022-11-03 00:08:49 -0700248
249 for (const auto& package : group.packages_) {
250 const auto& package_aliases = package.loaded_package_->GetAliasResourceIdMap();
Yurii Zubrytskyie3f9be62022-11-14 18:30:10 -0800251 aliases.insert(aliases.end(), package_aliases.begin(), package_aliases.end());
Yurii Zubrytskyi59dab3b2022-11-03 00:08:49 -0700252 }
253 }
254
255 if (!aliases.empty()) {
Yurii Zubrytskyie3f9be62022-11-14 18:30:10 -0800256 std::sort(aliases.begin(), aliases.end(), [](auto&& l, auto&& r) { return l.first < r.first; });
257
Yurii Zubrytskyi59dab3b2022-11-03 00:08:49 -0700258 // Add the alias resources to the dynamic reference table of every package group. Since
259 // staging aliases can only be defined by the framework package (which is not a shared
260 // library), the compile-time package id of the framework is the same across all packages
261 // that compile against the framework.
262 for (auto& group : std::span(package_groups_.data(), package_groups_.size() - 1)) {
263 group.dynamic_ref_table->setAliases(aliases);
264 }
265 package_groups_.back().dynamic_ref_table->setAliases(std::move(aliases));
Adam Lesinskida431a22016-12-29 16:08:16 -0500266 }
267}
268
269void AssetManager2::DumpToLog() const {
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800270 LOG(INFO) << base::StringPrintf("AssetManager2(this=%p)", this);
271
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700272 auto op = StartOperation();
Adam Lesinskida431a22016-12-29 16:08:16 -0500273 std::string list;
Yurii Zubrytskyi7d70bc52023-05-12 13:27:54 -0700274 for (size_t i = 0, s = apk_assets_.size(); i < s; ++i) {
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700275 const auto& assets = GetApkAssets(i);
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700276 base::StringAppendF(&list, "%s,", assets ? assets->GetDebugName().c_str() : "nullptr");
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800277 }
278 LOG(INFO) << "ApkAssets: " << list;
279
280 list = "";
Adam Lesinskida431a22016-12-29 16:08:16 -0500281 for (size_t i = 0; i < package_ids_.size(); i++) {
282 if (package_ids_[i] != 0xff) {
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800283 base::StringAppendF(&list, "%02x -> %d, ", (int)i, package_ids_[i]);
Adam Lesinskida431a22016-12-29 16:08:16 -0500284 }
285 }
286 LOG(INFO) << "Package ID map: " << list;
287
Adam Lesinski0dd36992018-01-25 15:38:38 -0800288 for (const auto& package_group: package_groups_) {
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800289 list = "";
290 for (const auto& package : package_group.packages_) {
291 const LoadedPackage* loaded_package = package.loaded_package_;
292 base::StringAppendF(&list, "%s(%02x%s), ", loaded_package->GetPackageName().c_str(),
293 loaded_package->GetPackageId(),
294 (loaded_package->IsDynamic() ? " dynamic" : ""));
295 }
296 LOG(INFO) << base::StringPrintf("PG (%02x): ",
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700297 package_group.dynamic_ref_table->mAssignedPackageId)
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800298 << list;
Ryan Mitchell5db396d2018-11-05 15:56:15 -0800299
300 for (size_t i = 0; i < 256; i++) {
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700301 if (package_group.dynamic_ref_table->mLookupTable[i] != 0) {
Ryan Mitchell5db396d2018-11-05 15:56:15 -0800302 LOG(INFO) << base::StringPrintf(" e[0x%02x] -> 0x%02x", (uint8_t) i,
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700303 package_group.dynamic_ref_table->mLookupTable[i]);
Ryan Mitchell5db396d2018-11-05 15:56:15 -0800304 }
305 }
Adam Lesinskida431a22016-12-29 16:08:16 -0500306 }
307}
Adam Lesinski7ad11102016-10-28 16:39:15 -0700308
309const ResStringPool* AssetManager2::GetStringPoolForCookie(ApkAssetsCookie cookie) const {
310 if (cookie < 0 || static_cast<size_t>(cookie) >= apk_assets_.size()) {
311 return nullptr;
312 }
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700313 auto op = StartOperation();
314 const auto& assets = GetApkAssets(cookie);
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700315 return assets ? assets->GetLoadedArsc()->GetStringPool() : nullptr;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700316}
317
Adam Lesinskida431a22016-12-29 16:08:16 -0500318const DynamicRefTable* AssetManager2::GetDynamicRefTableForPackage(uint32_t package_id) const {
319 if (package_id >= package_ids_.size()) {
320 return nullptr;
321 }
322
323 const size_t idx = package_ids_[package_id];
324 if (idx == 0xff) {
325 return nullptr;
326 }
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700327 return package_groups_[idx].dynamic_ref_table.get();
Adam Lesinskida431a22016-12-29 16:08:16 -0500328}
329
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700330std::shared_ptr<const DynamicRefTable> AssetManager2::GetDynamicRefTableForCookie(
331 ApkAssetsCookie cookie) const {
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800332 for (const PackageGroup& package_group : package_groups_) {
333 for (const ApkAssetsCookie& package_cookie : package_group.cookies_) {
334 if (package_cookie == cookie) {
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700335 return package_group.dynamic_ref_table;
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800336 }
337 }
338 }
339 return nullptr;
340}
341
MÃ¥rten Kongstadc92c4dd2019-02-05 01:29:59 +0100342const std::unordered_map<std::string, std::string>*
343 AssetManager2::GetOverlayableMapForPackage(uint32_t package_id) const {
344
345 if (package_id >= package_ids_.size()) {
346 return nullptr;
347 }
348
349 const size_t idx = package_ids_[package_id];
350 if (idx == 0xff) {
351 return nullptr;
352 }
353
354 const PackageGroup& package_group = package_groups_[idx];
Ryan Mitchell80094e32020-11-16 23:08:18 +0000355 if (package_group.packages_.empty()) {
MÃ¥rten Kongstadc92c4dd2019-02-05 01:29:59 +0100356 return nullptr;
357 }
358
359 const auto loaded_package = package_group.packages_[0].loaded_package_;
360 return &loaded_package->GetOverlayableMap();
361}
362
Yurii Zubrytskyia5775142022-11-02 17:49:49 -0700363bool AssetManager2::GetOverlayablesToString(android::StringPiece package_name,
Ryan Mitchell2e394222019-08-28 12:10:51 -0700364 std::string* out) const {
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700365 auto op = StartOperation();
Ryan Mitchell2e394222019-08-28 12:10:51 -0700366 uint8_t package_id = 0U;
Yurii Zubrytskyi7d70bc52023-05-12 13:27:54 -0700367 for (size_t i = 0, s = apk_assets_.size(); i != s; ++i) {
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700368 const auto& assets = GetApkAssets(i);
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700369 if (!assets) {
370 continue;
371 }
372 const LoadedArsc* loaded_arsc = assets->GetLoadedArsc();
Ryan Mitchell2e394222019-08-28 12:10:51 -0700373 if (loaded_arsc == nullptr) {
374 continue;
375 }
376
377 const auto& loaded_packages = loaded_arsc->GetPackages();
378 if (loaded_packages.empty()) {
379 continue;
380 }
381
382 const auto& loaded_package = loaded_packages[0];
383 if (loaded_package->GetPackageName() == package_name) {
384 package_id = GetAssignedPackageId(loaded_package.get());
385 break;
386 }
387 }
388
389 if (package_id == 0U) {
390 ANDROID_LOG(ERROR) << base::StringPrintf("No package with name '%s", package_name.data());
391 return false;
392 }
393
394 const size_t idx = package_ids_[package_id];
395 if (idx == 0xff) {
396 return false;
397 }
398
399 std::string output;
400 for (const ConfiguredPackage& package : package_groups_[idx].packages_) {
401 const LoadedPackage* loaded_package = package.loaded_package_;
402 for (auto it = loaded_package->begin(); it != loaded_package->end(); it++) {
403 const OverlayableInfo* info = loaded_package->GetOverlayableInfo(*it);
404 if (info != nullptr) {
Ryan Mitchell80094e32020-11-16 23:08:18 +0000405 auto res_name = GetResourceName(*it);
406 if (!res_name.has_value()) {
Ryan Mitchell2e394222019-08-28 12:10:51 -0700407 ANDROID_LOG(ERROR) << base::StringPrintf(
408 "Unable to retrieve name of overlayable resource 0x%08x", *it);
409 return false;
410 }
411
Ryan Mitchell80094e32020-11-16 23:08:18 +0000412 const std::string name = ToFormattedResourceString(*res_name);
Ryan Mitchell2e394222019-08-28 12:10:51 -0700413 output.append(base::StringPrintf(
414 "resource='%s' overlayable='%s' actor='%s' policy='0x%08x'\n",
Yurii Zubrytskyi9d225372022-11-29 11:12:18 -0800415 name.c_str(), info->name.data(), info->actor.data(), info->policy_flags));
Ryan Mitchell2e394222019-08-28 12:10:51 -0700416 }
417 }
418 }
419
420 *out = std::move(output);
421 return true;
422}
423
Ryan Mitchell192400c2020-04-02 09:54:23 -0700424bool AssetManager2::ContainsAllocatedTable() const {
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700425 auto op = StartOperation();
Yurii Zubrytskyi7d70bc52023-05-12 13:27:54 -0700426 for (size_t i = 0, s = apk_assets_.size(); i != s; ++i) {
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700427 const auto& assets = GetApkAssets(i);
428 if (assets && assets->IsTableAllocated()) {
429 return true;
430 }
431 }
432 return false;
Ryan Mitchell192400c2020-04-02 09:54:23 -0700433}
434
Jeremy Meyerccf5cd72023-08-15 21:42:03 +0000435void AssetManager2::SetConfigurations(std::vector<ResTable_config> configurations) {
436 int diff = 0;
437 if (configurations_.size() != configurations.size()) {
438 diff = -1;
439 } else {
440 for (int i = 0; i < configurations_.size(); i++) {
441 diff |= configurations_[i].diff(configurations[i]);
442 }
443 }
444 configurations_ = std::move(configurations);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700445
446 if (diff) {
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800447 RebuildFilterList();
Adam Lesinski7ad11102016-10-28 16:39:15 -0700448 InvalidateCaches(static_cast<uint32_t>(diff));
449 }
450}
451
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700452std::set<AssetManager2::ApkAssetsPtr> AssetManager2::GetNonSystemOverlays() const {
453 std::set<ApkAssetsPtr> non_system_overlays;
Adam Lesinski0c405242017-01-13 20:47:26 -0800454 for (const PackageGroup& package_group : package_groups_) {
Ryan Mitchell449a54f2018-11-30 15:22:31 -0800455 bool found_system_package = false;
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800456 for (const ConfiguredPackage& package : package_group.packages_) {
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700457 if (package.loaded_package_->IsSystem()) {
Ryan Mitchell449a54f2018-11-30 15:22:31 -0800458 found_system_package = true;
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700459 break;
460 }
461 }
462
463 if (!found_system_package) {
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700464 auto op = StartOperation();
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700465 for (const ConfiguredOverlay& overlay : package_group.overlays_) {
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700466 if (const auto& asset = GetApkAssets(overlay.cookie)) {
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700467 non_system_overlays.insert(std::move(asset));
468 }
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700469 }
470 }
471 }
472
473 return non_system_overlays;
474}
475
Ryan Mitchell80094e32020-11-16 23:08:18 +0000476base::expected<std::set<ResTable_config>, IOError> AssetManager2::GetResourceConfigurations(
477 bool exclude_system, bool exclude_mipmap) const {
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700478 ATRACE_NAME("AssetManager::GetResourceConfigurations");
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700479 auto op = StartOperation();
480
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700481 const auto non_system_overlays =
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700482 exclude_system ? GetNonSystemOverlays() : std::set<ApkAssetsPtr>();
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700483
484 std::set<ResTable_config> configurations;
485 for (const PackageGroup& package_group : package_groups_) {
486 for (size_t i = 0; i < package_group.packages_.size(); i++) {
487 const ConfiguredPackage& package = package_group.packages_[i];
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700488 if (exclude_system) {
489 if (package.loaded_package_->IsSystem()) {
490 continue;
491 }
492 if (!non_system_overlays.empty()) {
493 // Exclude overlays that target only system resources.
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700494 const auto& apk_assets = GetApkAssets(package_group.cookies_[i]);
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700495 if (apk_assets && apk_assets->IsOverlay() &&
496 non_system_overlays.find(apk_assets) == non_system_overlays.end()) {
497 continue;
498 }
499 }
Ryan Mitchell449a54f2018-11-30 15:22:31 -0800500 }
501
Ryan Mitchell80094e32020-11-16 23:08:18 +0000502 auto result = package.loaded_package_->CollectConfigurations(exclude_mipmap, &configurations);
503 if (UNLIKELY(!result.has_value())) {
504 return base::unexpected(result.error());
505 }
Adam Lesinski0c405242017-01-13 20:47:26 -0800506 }
507 }
508 return configurations;
509}
510
511std::set<std::string> AssetManager2::GetResourceLocales(bool exclude_system,
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800512 bool merge_equivalent_languages) const {
513 ATRACE_NAME("AssetManager::GetResourceLocales");
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700514 auto op = StartOperation();
515
Adam Lesinski0c405242017-01-13 20:47:26 -0800516 std::set<std::string> locales;
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700517 const auto non_system_overlays =
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700518 exclude_system ? GetNonSystemOverlays() : std::set<ApkAssetsPtr>();
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700519
Adam Lesinski0c405242017-01-13 20:47:26 -0800520 for (const PackageGroup& package_group : package_groups_) {
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700521 for (size_t i = 0; i < package_group.packages_.size(); i++) {
522 const ConfiguredPackage& package = package_group.packages_[i];
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700523 if (exclude_system) {
524 if (package.loaded_package_->IsSystem()) {
525 continue;
526 }
527 if (!non_system_overlays.empty()) {
528 // Exclude overlays that target only system resources.
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700529 const auto& apk_assets = GetApkAssets(package_group.cookies_[i]);
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700530 if (apk_assets && apk_assets->IsOverlay() &&
531 non_system_overlays.find(apk_assets) == non_system_overlays.end()) {
532 continue;
533 }
534 }
Ryan Mitchell449a54f2018-11-30 15:22:31 -0800535 }
536
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800537 package.loaded_package_->CollectLocales(merge_equivalent_languages, &locales);
Adam Lesinski0c405242017-01-13 20:47:26 -0800538 }
539 }
540 return locales;
541}
542
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800543std::unique_ptr<Asset> AssetManager2::Open(const std::string& filename,
544 Asset::AccessMode mode) const {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700545 const std::string new_path = "assets/" + filename;
546 return OpenNonAsset(new_path, mode);
547}
548
549std::unique_ptr<Asset> AssetManager2::Open(const std::string& filename, ApkAssetsCookie cookie,
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800550 Asset::AccessMode mode) const {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700551 const std::string new_path = "assets/" + filename;
552 return OpenNonAsset(new_path, cookie, mode);
553}
554
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800555std::unique_ptr<AssetDir> AssetManager2::OpenDir(const std::string& dirname) const {
556 ATRACE_NAME("AssetManager::OpenDir");
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700557 auto op = StartOperation();
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800558
559 std::string full_path = "assets/" + dirname;
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700560 auto files = util::make_unique<SortedVector<AssetDir::FileInfo>>();
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800561
562 // Start from the back.
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700563 for (size_t i = apk_assets_.size(); i > 0; --i) {
564 const auto& apk_assets = GetApkAssets(i - 1);
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700565 if (!apk_assets || apk_assets->IsOverlay()) {
MÃ¥rten Kongstaddbf343b2019-02-21 07:54:18 +0100566 continue;
567 }
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800568
Yurii Zubrytskyia5775142022-11-02 17:49:49 -0700569 auto func = [&](StringPiece name, FileType type) {
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800570 AssetDir::FileInfo info;
571 info.setFileName(String8(name.data(), name.size()));
572 info.setFileType(type);
Ryan Mitchellef538432021-03-01 14:52:14 -0800573 info.setSourceName(String8(apk_assets->GetDebugName().c_str()));
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800574 files->add(info);
575 };
576
Ryan Mitchellc07aa702020-03-10 13:49:12 -0700577 if (!apk_assets->GetAssetsProvider()->ForEachFile(full_path, func)) {
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800578 return {};
579 }
580 }
581
582 std::unique_ptr<AssetDir> asset_dir = util::make_unique<AssetDir>();
583 asset_dir->setFileList(files.release());
584 return asset_dir;
585}
586
Adam Lesinski7ad11102016-10-28 16:39:15 -0700587// Search in reverse because that's how we used to do it and we need to preserve behaviour.
588// This is unfortunate, because ClassLoaders delegate to the parent first, so the order
589// is inconsistent for split APKs.
590std::unique_ptr<Asset> AssetManager2::OpenNonAsset(const std::string& filename,
591 Asset::AccessMode mode,
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800592 ApkAssetsCookie* out_cookie) const {
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700593 auto op = StartOperation();
594 for (size_t i = apk_assets_.size(); i > 0; i--) {
595 const auto& assets = GetApkAssets(i - 1);
MÃ¥rten Kongstaddbf343b2019-02-21 07:54:18 +0100596 // Prevent RRO from modifying assets and other entries accessed by file
597 // path. Explicitly asking for a path in a given package (denoted by a
598 // cookie) is still OK.
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700599 if (!assets || assets->IsOverlay()) {
MÃ¥rten Kongstaddbf343b2019-02-21 07:54:18 +0100600 continue;
601 }
602
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700603 std::unique_ptr<Asset> asset = assets->GetAssetsProvider()->Open(filename, mode);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700604 if (asset) {
605 if (out_cookie != nullptr) {
606 *out_cookie = i;
607 }
608 return asset;
609 }
610 }
611
612 if (out_cookie != nullptr) {
613 *out_cookie = kInvalidCookie;
614 }
615 return {};
616}
617
618std::unique_ptr<Asset> AssetManager2::OpenNonAsset(const std::string& filename,
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800619 ApkAssetsCookie cookie,
620 Asset::AccessMode mode) const {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700621 if (cookie < 0 || static_cast<size_t>(cookie) >= apk_assets_.size()) {
622 return {};
623 }
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700624 auto op = StartOperation();
625 const auto& assets = GetApkAssets(cookie);
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700626 return assets ? assets->GetAssetsProvider()->Open(filename, mode) : nullptr;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700627}
628
Ryan Mitchell80094e32020-11-16 23:08:18 +0000629base::expected<FindEntryResult, NullOrIOError> AssetManager2::FindEntry(
630 uint32_t resid, uint16_t density_override, bool stop_at_first_match,
631 bool ignore_configuration) const {
632 const bool logging_enabled = resource_resolution_logging_enabled_;
633 if (UNLIKELY(logging_enabled)) {
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700634 // Clear the last logged resource resolution.
635 ResetResourceResolution();
636 last_resolution_.resid = resid;
637 }
638
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700639 auto op = StartOperation();
640
Adam Lesinski7ad11102016-10-28 16:39:15 -0700641
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700642 // Retrieve the package group from the package id of the resource id.
Ryan Mitchell80094e32020-11-16 23:08:18 +0000643 if (UNLIKELY(!is_valid_resid(resid))) {
Mark Hansenb406b0e2022-10-14 02:18:37 +0000644 LOG(ERROR) << base::StringPrintf("Invalid resource ID 0x%08x.", resid);
Ryan Mitchell80094e32020-11-16 23:08:18 +0000645 return base::unexpected(std::nullopt);
Adam Lesinskida431a22016-12-29 16:08:16 -0500646 }
647
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800648 const uint32_t package_id = get_package_id(resid);
649 const uint8_t type_idx = get_type_id(resid) - 1;
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800650 const uint16_t entry_idx = get_entry_id(resid);
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700651 uint8_t package_idx = package_ids_[package_id];
Ryan Mitchell80094e32020-11-16 23:08:18 +0000652 if (UNLIKELY(package_idx == 0xff)) {
Mark Hansenb406b0e2022-10-14 02:18:37 +0000653 ANDROID_LOG(ERROR) << base::StringPrintf("No package ID %02x found for resource ID 0x%08x.",
Ryan Mitchell2fe23472019-02-27 09:43:01 -0800654 package_id, resid);
Ryan Mitchell80094e32020-11-16 23:08:18 +0000655 return base::unexpected(std::nullopt);
Adam Lesinskida431a22016-12-29 16:08:16 -0500656 }
657
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800658 const PackageGroup& package_group = package_groups_[package_idx];
Jeremy Meyerccf5cd72023-08-15 21:42:03 +0000659 std::optional<FindEntryResult> final_result;
660 bool final_has_locale = false;
661 bool final_overlaid = false;
662 for (auto & config : configurations_) {
663 // Might use this if density_override != 0.
664 ResTable_config density_override_config;
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800665
Jeremy Meyerccf5cd72023-08-15 21:42:03 +0000666 // Select our configuration or generate a density override configuration.
667 const ResTable_config* desired_config = &config;
668 if (density_override != 0 && density_override != config.density) {
669 density_override_config = config;
670 density_override_config.density = density_override;
671 desired_config = &density_override_config;
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700672 }
Jeremy Meyerccf5cd72023-08-15 21:42:03 +0000673
674 auto result = FindEntryInternal(package_group, type_idx, entry_idx, *desired_config,
675 stop_at_first_match, ignore_configuration);
676 if (UNLIKELY(!result.has_value())) {
677 return base::unexpected(result.error());
678 }
679 bool overlaid = false;
680 if (!stop_at_first_match && !ignore_configuration) {
681 const auto& assets = GetApkAssets(result->cookie);
682 if (!assets) {
683 ALOGE("Found expired ApkAssets #%d for resource ID 0x%08x.", result->cookie, resid);
684 return base::unexpected(std::nullopt);
685 }
686 if (!assets->IsLoader()) {
687 for (const auto& id_map : package_group.overlays_) {
688 auto overlay_entry = id_map.overlay_res_maps_.Lookup(resid);
689 if (!overlay_entry) {
690 // No id map entry exists for this target resource.
Jeremy Meyer04cf00d2023-07-20 22:17:27 +0000691 continue;
692 }
Jeremy Meyerccf5cd72023-08-15 21:42:03 +0000693 if (overlay_entry.IsInlineValue()) {
694 // The target resource is overlaid by an inline value not represented by a resource.
695 ConfigDescription best_frro_config;
696 Res_value best_frro_value;
697 bool frro_found = false;
698 for( const auto& [config, value] : overlay_entry.GetInlineValue()) {
699 if ((!frro_found || config.isBetterThan(best_frro_config, desired_config))
700 && config.match(*desired_config)) {
701 frro_found = true;
702 best_frro_config = config;
703 best_frro_value = value;
704 }
705 }
706 if (!frro_found) {
707 continue;
708 }
709 result->entry = best_frro_value;
710 result->dynamic_ref_table = id_map.overlay_res_maps_.GetOverlayDynamicRefTable();
711 result->cookie = id_map.cookie;
712
713 if (UNLIKELY(logging_enabled)) {
714 last_resolution_.steps.push_back(Resolution::Step{
715 Resolution::Step::Type::OVERLAID_INLINE, result->cookie, String8()});
716 if (auto path = assets->GetPath()) {
717 const std::string overlay_path = path->data();
718 if (IsFabricatedOverlay(overlay_path)) {
719 // FRRO don't have package name so we use the creating package here.
720 String8 frro_name = String8("FRRO");
721 // Get the first part of it since the expected one should be like
722 // {overlayPackageName}-{overlayName}-{4 alphanumeric chars}.frro
723 // under /data/resource-cache/.
724 const std::string name = overlay_path.substr(overlay_path.rfind('/') + 1);
725 const size_t end = name.find('-');
726 if (frro_name.size() != overlay_path.size() && end != std::string::npos) {
727 frro_name.append(base::StringPrintf(" created by %s",
728 name.substr(0 /* pos */,
729 end).c_str()).c_str());
730 }
731 last_resolution_.best_package_name = frro_name;
732 } else {
733 last_resolution_.best_package_name = result->package_name->c_str();
734 }
735 }
736 overlaid = true;
737 }
738 continue;
739 }
740
741 auto overlay_result = FindEntry(overlay_entry.GetResourceId(), density_override,
742 false /* stop_at_first_match */,
743 false /* ignore_configuration */);
744 if (UNLIKELY(IsIOError(overlay_result))) {
745 return base::unexpected(overlay_result.error());
746 }
747 if (!overlay_result.has_value()) {
748 continue;
749 }
750
751 if (!overlay_result->config.isBetterThan(result->config, desired_config)
752 && overlay_result->config.compare(result->config) != 0) {
753 // The configuration of the entry for the overlay must be equal to or better than the
754 // target configuration to be chosen as the better value.
755 continue;
756 }
757
758 result->cookie = overlay_result->cookie;
759 result->entry = overlay_result->entry;
760 result->config = overlay_result->config;
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700761 result->dynamic_ref_table = id_map.overlay_res_maps_.GetOverlayDynamicRefTable();
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700762
763 if (UNLIKELY(logging_enabled)) {
764 last_resolution_.steps.push_back(
Jeremy Meyerccf5cd72023-08-15 21:42:03 +0000765 Resolution::Step{Resolution::Step::Type::OVERLAID, overlay_result->cookie,
766 overlay_result->config.toString()});
767 last_resolution_.best_package_name =
768 overlay_result->package_name->c_str();
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700769 overlaid = true;
770 }
Ryan Mitchellbdc0ae12021-03-01 15:18:15 -0800771 }
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700772 }
773 }
Jeremy Meyerccf5cd72023-08-15 21:42:03 +0000774
775 bool has_locale = false;
776 if (result->config.locale == 0) {
777 if (default_locale_ != 0) {
778 ResTable_config conf;
779 conf.locale = default_locale_;
780 // Since we know conf has a locale and only a locale, match will tell us if that locale
781 // matches
782 has_locale = conf.match(config);
783 }
784 } else {
785 has_locale = true;
786 }
787
788 // if we don't have a result yet
789 if (!final_result ||
790 // or this config is better before the locale than the existing result
791 result->config.isBetterThanBeforeLocale(final_result->config, desired_config) ||
792 // or the existing config isn't better before locale and this one specifies a locale
793 // whereas the existing one doesn't
794 (!final_result->config.isBetterThanBeforeLocale(result->config, desired_config)
795 && has_locale && !final_has_locale)) {
796 final_result = result.value();
797 final_overlaid = overlaid;
798 final_has_locale = has_locale;
799 }
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700800 }
801
Ryan Mitchell80094e32020-11-16 23:08:18 +0000802 if (UNLIKELY(logging_enabled)) {
Jeremy Meyerccf5cd72023-08-15 21:42:03 +0000803 last_resolution_.cookie = final_result->cookie;
804 last_resolution_.type_string_ref = final_result->type_string_ref;
805 last_resolution_.entry_string_ref = final_result->entry_string_ref;
806 last_resolution_.best_config_name = final_result->config.toString();
807 if (!final_overlaid) {
808 last_resolution_.best_package_name = final_result->package_name->c_str();
Jackal Guo552b45d2021-09-29 10:52:19 +0800809 }
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700810 }
811
Jeremy Meyerccf5cd72023-08-15 21:42:03 +0000812 return *final_result;
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700813}
814
Ryan Mitchell80094e32020-11-16 23:08:18 +0000815base::expected<FindEntryResult, NullOrIOError> AssetManager2::FindEntryInternal(
816 const PackageGroup& package_group, uint8_t type_idx, uint16_t entry_idx,
817 const ResTable_config& desired_config, bool stop_at_first_match,
818 bool ignore_configuration) const {
819 const bool logging_enabled = resource_resolution_logging_enabled_;
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800820 ApkAssetsCookie best_cookie = kInvalidCookie;
821 const LoadedPackage* best_package = nullptr;
Ryan Mitchell80094e32020-11-16 23:08:18 +0000822 incfs::verified_map_ptr<ResTable_type> best_type;
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800823 const ResTable_config* best_config = nullptr;
Ryan Mitchell80094e32020-11-16 23:08:18 +0000824 uint32_t best_offset = 0U;
825 uint32_t type_flags = 0U;
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800826
Ryan Mitchell14e8ade2021-01-11 16:01:35 -0800827 // If `desired_config` is not the same as the set configuration or the caller will accept a value
828 // from any configuration, then we cannot use our filtered list of types since it only it contains
829 // types matched to the set configuration.
Jeremy Meyerccf5cd72023-08-15 21:42:03 +0000830 const bool use_filtered = !ignore_configuration && std::find_if(
831 configurations_.begin(), configurations_.end(),
832 [&desired_config](auto& value) { return &desired_config == &value; })
833 != configurations_.end();
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700834 const size_t package_count = package_group.packages_.size();
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800835 for (size_t pi = 0; pi < package_count; pi++) {
836 const ConfiguredPackage& loaded_package_impl = package_group.packages_[pi];
837 const LoadedPackage* loaded_package = loaded_package_impl.loaded_package_;
Ryan Mitchell14e8ade2021-01-11 16:01:35 -0800838 const ApkAssetsCookie cookie = package_group.cookies_[pi];
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800839
840 // If the type IDs are offset in this package, we need to take that into account when searching
841 // for a type.
842 const TypeSpec* type_spec = loaded_package->GetTypeSpecByTypeIndex(type_idx);
843 if (UNLIKELY(type_spec == nullptr)) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700844 continue;
845 }
846
Ryan Mitchell14e8ade2021-01-11 16:01:35 -0800847 // Allow custom loader packages to overlay resource values with configurations equivalent to the
848 // current best configuration.
849 const bool package_is_loader = loaded_package->IsCustomLoader();
850
Ryan Mitchell80094e32020-11-16 23:08:18 +0000851 auto entry_flags = type_spec->GetFlagsForEntryIndex(entry_idx);
Bernie Innocenti58cf8e32020-12-19 15:31:52 +0900852 if (UNLIKELY(!entry_flags.has_value())) {
Ryan Mitchell80094e32020-11-16 23:08:18 +0000853 return base::unexpected(entry_flags.error());
854 }
855 type_flags |= entry_flags.value();
856
Ryan Mitchell14e8ade2021-01-11 16:01:35 -0800857 const FilteredConfigGroup& filtered_group = loaded_package_impl.filtered_configs_[type_idx];
858 const size_t type_entry_count = (use_filtered) ? filtered_group.type_entries.size()
859 : type_spec->type_entries.size();
860 for (size_t i = 0; i < type_entry_count; i++) {
861 const TypeSpec::TypeEntry* type_entry = (use_filtered) ? filtered_group.type_entries[i]
862 : &type_spec->type_entries[i];
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800863
Ryan Mitchell14e8ade2021-01-11 16:01:35 -0800864 // We can skip calling ResTable_config::match() if the caller does not care for the
865 // configuration to match or if we're using the list of types that have already had their
866 // configuration matched.
867 const ResTable_config& this_config = type_entry->config;
868 if (!(use_filtered || ignore_configuration || this_config.match(desired_config))) {
869 continue;
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800870 }
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800871
Ryan Mitchell14e8ade2021-01-11 16:01:35 -0800872 Resolution::Step::Type resolution_type;
873 if (best_config == nullptr) {
874 resolution_type = Resolution::Step::Type::INITIAL;
875 } else if (this_config.isBetterThan(*best_config, &desired_config)) {
876 resolution_type = Resolution::Step::Type::BETTER_MATCH;
877 } else if (package_is_loader && this_config.compare(*best_config) == 0) {
878 resolution_type = Resolution::Step::Type::OVERLAID;
879 } else {
Ryan Mitchell80094e32020-11-16 23:08:18 +0000880 if (UNLIKELY(logging_enabled)) {
Jackal Guo552b45d2021-09-29 10:52:19 +0800881 last_resolution_.steps.push_back(Resolution::Step{Resolution::Step::Type::SKIPPED,
Yurii Zubrytskyiff9cba72023-03-29 12:53:51 -0700882 cookie, this_config.toString()});
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800883 }
Ryan Mitchell14e8ade2021-01-11 16:01:35 -0800884 continue;
885 }
886
887 // The configuration matches and is better than the previous selection.
888 // Find the entry value if it exists for this configuration.
889 const auto& type = type_entry->type;
890 const auto offset = LoadedPackage::GetEntryOffset(type, entry_idx);
891 if (UNLIKELY(IsIOError(offset))) {
892 return base::unexpected(offset.error());
893 }
894
895 if (!offset.has_value()) {
896 if (UNLIKELY(logging_enabled)) {
Jackal Guo552b45d2021-09-29 10:52:19 +0800897 last_resolution_.steps.push_back(Resolution::Step{Resolution::Step::Type::NO_ENTRY,
Yurii Zubrytskyiff9cba72023-03-29 12:53:51 -0700898 cookie, this_config.toString()});
Ryan Mitchell14e8ade2021-01-11 16:01:35 -0800899 }
900 continue;
901 }
902
903 best_cookie = cookie;
904 best_package = loaded_package;
905 best_type = type;
906 best_config = &this_config;
907 best_offset = offset.value();
908
909 if (UNLIKELY(logging_enabled)) {
910 last_resolution_.steps.push_back(Resolution::Step{resolution_type,
Yurii Zubrytskyiff9cba72023-03-29 12:53:51 -0700911 cookie, this_config.toString()});
Ryan Mitchell14e8ade2021-01-11 16:01:35 -0800912 }
913
914 // Any configuration will suffice, so break.
915 if (stop_at_first_match) {
916 break;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700917 }
918 }
919 }
920
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800921 if (UNLIKELY(best_cookie == kInvalidCookie)) {
Ryan Mitchell80094e32020-11-16 23:08:18 +0000922 return base::unexpected(std::nullopt);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700923 }
924
Eric Miao368cd192022-09-09 15:46:14 -0700925 auto best_entry_verified = LoadedPackage::GetEntryFromOffset(best_type, best_offset);
926 if (!best_entry_verified.has_value()) {
927 return base::unexpected(best_entry_verified.error());
Adam Lesinskibebfcc42018-02-12 14:27:46 -0800928 }
929
Eric Miao368cd192022-09-09 15:46:14 -0700930 const auto entry = GetEntryValue(*best_entry_verified);
Ryan Mitchell80094e32020-11-16 23:08:18 +0000931 if (!entry.has_value()) {
932 return base::unexpected(entry.error());
933 }
Winson2f3669b2019-01-11 11:28:34 -0800934
Ryan Mitchell80094e32020-11-16 23:08:18 +0000935 return FindEntryResult{
936 .cookie = best_cookie,
937 .entry = *entry,
938 .config = *best_config,
939 .type_flags = type_flags,
Tomasz Wasilczyk9e039b92023-06-29 12:08:24 -0700940 .dynamic_ref_table = package_group.dynamic_ref_table.get(),
Ryan Mitchell80094e32020-11-16 23:08:18 +0000941 .package_name = &best_package->GetPackageName(),
942 .type_string_ref = StringPoolRef(best_package->GetTypeStringPool(), best_type->id - 1),
943 .entry_string_ref = StringPoolRef(best_package->GetKeyStringPool(),
Eric Miao368cd192022-09-09 15:46:14 -0700944 (*best_entry_verified)->key()),
Ryan Mitchell80094e32020-11-16 23:08:18 +0000945 };
Adam Lesinski7ad11102016-10-28 16:39:15 -0700946}
947
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700948void AssetManager2::ResetResourceResolution() const {
Yurii Zubrytskyiff9cba72023-03-29 12:53:51 -0700949 last_resolution_ = Resolution{};
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700950}
951
Winson2f3669b2019-01-11 11:28:34 -0800952void AssetManager2::SetResourceResolutionLoggingEnabled(bool enabled) {
953 resource_resolution_logging_enabled_ = enabled;
Winson2f3669b2019-01-11 11:28:34 -0800954 if (!enabled) {
Ryan Mitchell8a891d82019-07-01 09:48:23 -0700955 ResetResourceResolution();
Winson2f3669b2019-01-11 11:28:34 -0800956 }
957}
958
959std::string AssetManager2::GetLastResourceResolution() const {
960 if (!resource_resolution_logging_enabled_) {
961 LOG(ERROR) << "Must enable resource resolution logging before getting path.";
Ryan Mitchell80094e32020-11-16 23:08:18 +0000962 return {};
Winson2f3669b2019-01-11 11:28:34 -0800963 }
964
Ryan Mitchell14e8ade2021-01-11 16:01:35 -0800965 const ApkAssetsCookie cookie = last_resolution_.cookie;
Winson2f3669b2019-01-11 11:28:34 -0800966 if (cookie == kInvalidCookie) {
967 LOG(ERROR) << "AssetManager hasn't resolved a resource to read resolution path.";
Ryan Mitchell80094e32020-11-16 23:08:18 +0000968 return {};
Winson2f3669b2019-01-11 11:28:34 -0800969 }
970
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700971 auto op = StartOperation();
972
Ryan Mitchell14e8ade2021-01-11 16:01:35 -0800973 const uint32_t resid = last_resolution_.resid;
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -0700974 const auto& assets = GetApkAssets(cookie);
Yurii Zubrytskyib3455192023-05-01 14:35:48 -0700975 const auto package =
976 assets ? assets->GetLoadedArsc()->GetPackageById(get_package_id(resid)) : nullptr;
Ryan Mitchell14e8ade2021-01-11 16:01:35 -0800977
Winson2f3669b2019-01-11 11:28:34 -0800978 std::string resource_name_string;
Winson2f3669b2019-01-11 11:28:34 -0800979 if (package != nullptr) {
Ryan Mitchell80094e32020-11-16 23:08:18 +0000980 auto resource_name = ToResourceName(last_resolution_.type_string_ref,
981 last_resolution_.entry_string_ref,
982 package->GetPackageName());
983 resource_name_string = resource_name.has_value() ?
984 ToFormattedResourceString(resource_name.value()) : "<unknown>";
Winson2f3669b2019-01-11 11:28:34 -0800985 }
986
987 std::stringstream log_stream;
Jeremy Meyerccf5cd72023-08-15 21:42:03 +0000988 if (configurations_.size() == 1) {
989 log_stream << base::StringPrintf("Resolution for 0x%08x %s\n"
990 "\tFor config - %s", resid, resource_name_string.c_str(),
991 configurations_[0].toString().c_str());
992 } else {
993 ResTable_config conf = configurations_[0];
994 conf.clearLocale();
995 log_stream << base::StringPrintf("Resolution for 0x%08x %s\n\tFor config - %s and locales",
996 resid, resource_name_string.c_str(), conf.toString().c_str());
997 char str[40];
998 str[0] = '\0';
999 for(auto iter = configurations_.begin(); iter < configurations_.end(); iter++) {
1000 iter->getBcp47Locale(str);
1001 log_stream << base::StringPrintf(" %s%s", str, iter < configurations_.end() ? "," : "");
1002 }
1003 }
Ryan Mitchell14e8ade2021-01-11 16:01:35 -08001004 for (const Resolution::Step& step : last_resolution_.steps) {
Yurii Zubrytskyiff9cba72023-03-29 12:53:51 -07001005 constexpr static std::array kStepStrings = {
1006 "Found initial",
1007 "Found better",
1008 "Overlaid",
1009 "Overlaid inline",
1010 "Skipped",
1011 "No entry"
Ryan Mitchell14e8ade2021-01-11 16:01:35 -08001012 };
1013
Yurii Zubrytskyiff9cba72023-03-29 12:53:51 -07001014 if (step.type < Resolution::Step::Type::INITIAL
1015 || step.type > Resolution::Step::Type::NO_ENTRY) {
Ryan Mitchell14e8ade2021-01-11 16:01:35 -08001016 continue;
Winson2f3669b2019-01-11 11:28:34 -08001017 }
Yurii Zubrytskyiff9cba72023-03-29 12:53:51 -07001018 const auto prefix = kStepStrings[int(step.type) - int(Resolution::Step::Type::INITIAL)];
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -07001019 const auto& assets = GetApkAssets(step.cookie);
Yurii Zubrytskyib3455192023-05-01 14:35:48 -07001020 log_stream << "\n\t" << prefix << ": " << (assets ? assets->GetDebugName() : "<null>")
1021 << " #" << step.cookie;
Tomasz Wasilczyk8f74b2a2023-08-24 19:02:33 +00001022 if (!step.config_name.empty()) {
Ryan Mitchellbdc0ae12021-03-01 15:18:15 -08001023 log_stream << " - " << step.config_name;
Winson2f3669b2019-01-11 11:28:34 -08001024 }
1025 }
1026
Jackal Guo552b45d2021-09-29 10:52:19 +08001027 log_stream << "\nBest matching is from "
Tomasz Wasilczyk8f74b2a2023-08-24 19:02:33 +00001028 << (last_resolution_.best_config_name.empty() ? "default"
Jackal Guo552b45d2021-09-29 10:52:19 +08001029 : last_resolution_.best_config_name)
1030 << " configuration of " << last_resolution_.best_package_name;
Winson2f3669b2019-01-11 11:28:34 -08001031 return log_stream.str();
1032}
1033
Felka Chang00964e92021-12-10 01:19:08 +08001034base::expected<uint32_t, NullOrIOError> AssetManager2::GetParentThemeResourceId(uint32_t resid)
1035const {
1036 auto entry = FindEntry(resid, 0u /* density_override */,
1037 false /* stop_at_first_match */,
1038 false /* ignore_configuration */);
1039 if (!entry.has_value()) {
1040 return base::unexpected(entry.error());
1041 }
1042
1043 auto entry_map = std::get_if<incfs::verified_map_ptr<ResTable_map_entry>>(&entry->entry);
1044 if (entry_map == nullptr) {
1045 // Not a bag, nothing to do.
1046 return base::unexpected(std::nullopt);
1047 }
1048
1049 auto map = *entry_map;
1050 const uint32_t parent_resid = dtohl(map->parent.ident);
1051
1052 return parent_resid;
1053}
1054
Ryan Mitchell80094e32020-11-16 23:08:18 +00001055base::expected<AssetManager2::ResourceName, NullOrIOError> AssetManager2::GetResourceName(
1056 uint32_t resid) const {
1057 auto result = FindEntry(resid, 0u /* density_override */, true /* stop_at_first_match */,
1058 true /* ignore_configuration */);
1059 if (!result.has_value()) {
1060 return base::unexpected(result.error());
Adam Lesinski7ad11102016-10-28 16:39:15 -07001061 }
1062
Ryan Mitchell80094e32020-11-16 23:08:18 +00001063 return ToResourceName(result->type_string_ref,
1064 result->entry_string_ref,
1065 *result->package_name);
Adam Lesinski7ad11102016-10-28 16:39:15 -07001066}
1067
Ryan Mitchell14e8ade2021-01-11 16:01:35 -08001068base::expected<uint32_t, NullOrIOError> AssetManager2::GetResourceTypeSpecFlags(
1069 uint32_t resid) const {
1070 auto result = FindEntry(resid, 0u /* density_override */, false /* stop_at_first_match */,
1071 true /* ignore_configuration */);
1072 if (!result.has_value()) {
1073 return base::unexpected(result.error());
1074 }
1075 return result->type_flags;
1076}
1077
Ryan Mitchell80094e32020-11-16 23:08:18 +00001078base::expected<AssetManager2::SelectedValue, NullOrIOError> AssetManager2::GetResource(
1079 uint32_t resid, bool may_be_bag, uint16_t density_override) const {
1080 auto result = FindEntry(resid, density_override, false /* stop_at_first_match */,
1081 false /* ignore_configuration */);
1082 if (!result.has_value()) {
1083 return base::unexpected(result.error());
Adam Lesinski7ad11102016-10-28 16:39:15 -07001084 }
1085
Ryan Mitchell80094e32020-11-16 23:08:18 +00001086 auto result_map_entry = std::get_if<incfs::verified_map_ptr<ResTable_map_entry>>(&result->entry);
Ryan Mitchellbf1f45b2020-09-29 17:22:52 -07001087 if (result_map_entry != nullptr) {
Adam Lesinski7ad11102016-10-28 16:39:15 -07001088 if (!may_be_bag) {
1089 LOG(ERROR) << base::StringPrintf("Resource %08x is a complex map type.", resid);
Ryan Mitchell80094e32020-11-16 23:08:18 +00001090 return base::unexpected(std::nullopt);
Adam Lesinski7ad11102016-10-28 16:39:15 -07001091 }
Adam Lesinski0c405242017-01-13 20:47:26 -08001092
1093 // Create a reference since we can't represent this complex type as a Res_value.
Ryan Mitchell80094e32020-11-16 23:08:18 +00001094 return SelectedValue(Res_value::TYPE_REFERENCE, resid, result->cookie, result->type_flags,
1095 resid, result->config);
Adam Lesinski7ad11102016-10-28 16:39:15 -07001096 }
1097
Adam Lesinskida431a22016-12-29 16:08:16 -05001098 // Convert the package ID to the runtime assigned package ID.
Ryan Mitchell80094e32020-11-16 23:08:18 +00001099 Res_value value = std::get<Res_value>(result->entry);
1100 result->dynamic_ref_table->lookupResourceValue(&value);
Adam Lesinskida431a22016-12-29 16:08:16 -05001101
Ryan Mitchell80094e32020-11-16 23:08:18 +00001102 return SelectedValue(value.dataType, value.data, result->cookie, result->type_flags,
1103 resid, result->config);
Adam Lesinski7ad11102016-10-28 16:39:15 -07001104}
1105
Ryan Mitchell80094e32020-11-16 23:08:18 +00001106base::expected<std::monostate, NullOrIOError> AssetManager2::ResolveReference(
Ryan Mitchella45506e2020-11-16 23:08:18 +00001107 AssetManager2::SelectedValue& value, bool cache_value) const {
Ryan Mitchell80094e32020-11-16 23:08:18 +00001108 if (value.type != Res_value::TYPE_REFERENCE || value.data == 0U) {
1109 // Not a reference. Nothing to do.
1110 return {};
Adam Lesinski0c405242017-01-13 20:47:26 -08001111 }
Ryan Mitchell80094e32020-11-16 23:08:18 +00001112
Ryan Mitchella45506e2020-11-16 23:08:18 +00001113 const uint32_t original_flags = value.flags;
1114 const uint32_t original_resid = value.data;
1115 if (cache_value) {
1116 auto cached_value = cached_resolved_values_.find(value.data);
1117 if (cached_value != cached_resolved_values_.end()) {
1118 value = cached_value->second;
1119 value.flags |= original_flags;
1120 return {};
1121 }
1122 }
1123
1124 uint32_t combined_flags = 0U;
1125 uint32_t resolve_resid = original_resid;
Ryan Mitchell80094e32020-11-16 23:08:18 +00001126 constexpr const uint32_t kMaxIterations = 20;
1127 for (uint32_t i = 0U;; i++) {
1128 auto result = GetResource(resolve_resid, true /*may_be_bag*/);
1129 if (!result.has_value()) {
Ryan Mitchelle7ab6272020-11-13 18:06:15 -08001130 value.resid = resolve_resid;
Ryan Mitchell80094e32020-11-16 23:08:18 +00001131 return base::unexpected(result.error());
1132 }
1133
Ryan Mitchelle7ab6272020-11-13 18:06:15 -08001134 // If resource resolution fails, the value should be set to the last reference that was able to
1135 // be resolved successfully.
1136 value = *result;
1137 value.flags |= combined_flags;
1138
Ryan Mitchell80094e32020-11-16 23:08:18 +00001139 if (result->type != Res_value::TYPE_REFERENCE ||
1140 result->data == Res_value::DATA_NULL_UNDEFINED ||
1141 result->data == resolve_resid || i == kMaxIterations) {
1142 // This reference can't be resolved, so exit now and let the caller deal with it.
Ryan Mitchella45506e2020-11-16 23:08:18 +00001143 if (cache_value) {
1144 cached_resolved_values_[original_resid] = value;
1145 }
1146
1147 // Above value is cached without original_flags to ensure they don't get included in future
1148 // queries that hit the cache
1149 value.flags |= original_flags;
Ryan Mitchell80094e32020-11-16 23:08:18 +00001150 return {};
1151 }
1152
Ryan Mitchelle7ab6272020-11-13 18:06:15 -08001153 combined_flags = result->flags;
Ryan Mitchell80094e32020-11-16 23:08:18 +00001154 resolve_resid = result->data;
1155 }
Adam Lesinski0c405242017-01-13 20:47:26 -08001156}
1157
Yurii Zubrytskyi02a555f2023-05-10 13:22:55 -07001158base::expected<const std::vector<uint32_t>*, NullOrIOError> AssetManager2::GetBagResIdStack(
1159 uint32_t resid) const {
Yurii Zubrytskyi09144882023-06-15 23:23:15 -07001160 auto it = cached_bag_resid_stacks_.find(resid);
1161 if (it != cached_bag_resid_stacks_.end()) {
1162 return &it->second;
Aurimas Liutikas8f004c82019-01-17 17:20:10 -08001163 }
Yurii Zubrytskyi09144882023-06-15 23:23:15 -07001164 std::vector<uint32_t> stacks;
1165 if (auto maybe_bag = GetBag(resid, stacks); UNLIKELY(IsIOError(maybe_bag))) {
1166 return base::unexpected(maybe_bag.error());
1167 }
1168
1169 it = cached_bag_resid_stacks_.emplace(resid, std::move(stacks)).first;
Yurii Zubrytskyi02a555f2023-05-10 13:22:55 -07001170 return &it->second;
Aurimas Liutikas8f004c82019-01-17 17:20:10 -08001171}
1172
Ryan Mitchell80094e32020-11-16 23:08:18 +00001173base::expected<const ResolvedBag*, NullOrIOError> AssetManager2::ResolveBag(
1174 AssetManager2::SelectedValue& value) const {
1175 if (UNLIKELY(value.type != Res_value::TYPE_REFERENCE)) {
1176 return base::unexpected(std::nullopt);
1177 }
Aurimas Liutikas8f004c82019-01-17 17:20:10 -08001178
Ryan Mitchell80094e32020-11-16 23:08:18 +00001179 auto bag = GetBag(value.data);
1180 if (bag.has_value()) {
1181 value.flags |= (*bag)->type_spec_flags;
Aurimas Liutikas8f004c82019-01-17 17:20:10 -08001182 }
1183 return bag;
y57cd1952018-04-12 14:26:23 -07001184}
1185
Ryan Mitchell80094e32020-11-16 23:08:18 +00001186base::expected<const ResolvedBag*, NullOrIOError> AssetManager2::GetBag(uint32_t resid) const {
Yurii Zubrytskyi09144882023-06-15 23:23:15 -07001187 auto resid_stacks_it = cached_bag_resid_stacks_.find(resid);
Yurii Zubrytskyi533e8cc2023-06-16 16:38:49 -07001188 if (resid_stacks_it == cached_bag_resid_stacks_.end()) {
Yurii Zubrytskyi09144882023-06-15 23:23:15 -07001189 resid_stacks_it = cached_bag_resid_stacks_.emplace(resid, std::vector<uint32_t>{}).first;
1190 }
Yurii Zubrytskyibd1db5d2023-05-23 18:32:47 -07001191 const auto bag = GetBag(resid, resid_stacks_it->second);
1192 if (UNLIKELY(IsIOError(bag))) {
1193 cached_bag_resid_stacks_.erase(resid_stacks_it);
1194 return base::unexpected(bag.error());
1195 }
Ryan Mitchell80094e32020-11-16 23:08:18 +00001196 return bag;
Ryan Mitchell155d5392020-02-10 13:35:24 -08001197}
1198
Ryan Mitchell80094e32020-11-16 23:08:18 +00001199base::expected<const ResolvedBag*, NullOrIOError> AssetManager2::GetBag(
1200 uint32_t resid, std::vector<uint32_t>& child_resids) const {
1201 if (auto cached_iter = cached_bags_.find(resid); cached_iter != cached_bags_.end()) {
Adam Lesinski7ad11102016-10-28 16:39:15 -07001202 return cached_iter->second.get();
1203 }
1204
Ryan Mitchell80094e32020-11-16 23:08:18 +00001205 auto entry = FindEntry(resid, 0u /* density_override */, false /* stop_at_first_match */,
1206 false /* ignore_configuration */);
1207 if (!entry.has_value()) {
1208 return base::unexpected(entry.error());
Adam Lesinski7ad11102016-10-28 16:39:15 -07001209 }
1210
Ryan Mitchell80094e32020-11-16 23:08:18 +00001211 auto entry_map = std::get_if<incfs::verified_map_ptr<ResTable_map_entry>>(&entry->entry);
1212 if (entry_map == nullptr) {
Adam Lesinski7ad11102016-10-28 16:39:15 -07001213 // Not a bag, nothing to do.
Ryan Mitchell80094e32020-11-16 23:08:18 +00001214 return base::unexpected(std::nullopt);
Adam Lesinski7ad11102016-10-28 16:39:15 -07001215 }
1216
Ryan Mitchell80094e32020-11-16 23:08:18 +00001217 auto map = *entry_map;
1218 auto map_entry = map.offset(dtohs(map->size)).convert<ResTable_map>();
1219 const auto map_entry_end = map_entry + dtohl(map->count);
Adam Lesinski7ad11102016-10-28 16:39:15 -07001220
y57cd1952018-04-12 14:26:23 -07001221 // Keep track of ids that have already been seen to prevent infinite loops caused by circular
Ryan Mitchell80094e32020-11-16 23:08:18 +00001222 // dependencies between bags.
y57cd1952018-04-12 14:26:23 -07001223 child_resids.push_back(resid);
1224
Adam Lesinskida431a22016-12-29 16:08:16 -05001225 uint32_t parent_resid = dtohl(map->parent.ident);
Ryan Mitchell80094e32020-11-16 23:08:18 +00001226 if (parent_resid == 0U ||
1227 std::find(child_resids.begin(), child_resids.end(), parent_resid) != child_resids.end()) {
1228 // There is no parent or a circular parental dependency exist, meaning there is nothing to
1229 // inherit and we can do a simple copy of the entries in the map.
Adam Lesinski7ad11102016-10-28 16:39:15 -07001230 const size_t entry_count = map_entry_end - map_entry;
1231 util::unique_cptr<ResolvedBag> new_bag{reinterpret_cast<ResolvedBag*>(
1232 malloc(sizeof(ResolvedBag) + (entry_count * sizeof(ResolvedBag::Entry))))};
Ryan Mitchell155d5392020-02-10 13:35:24 -08001233
1234 bool sort_entries = false;
Ryan Mitchell80094e32020-11-16 23:08:18 +00001235 for (auto new_entry = new_bag->entries; map_entry != map_entry_end; ++map_entry) {
1236 if (UNLIKELY(!map_entry)) {
1237 return base::unexpected(IOError::PAGES_MISSING);
1238 }
1239
Adam Lesinskida431a22016-12-29 16:08:16 -05001240 uint32_t new_key = dtohl(map_entry->name.ident);
Adam Lesinski929d6512017-01-16 19:11:19 -08001241 if (!is_internal_resid(new_key)) {
Adam Lesinskida431a22016-12-29 16:08:16 -05001242 // Attributes, arrays, etc don't have a resource id as the name. They specify
1243 // other data, which would be wrong to change via a lookup.
Ryan Mitchell80094e32020-11-16 23:08:18 +00001244 if (UNLIKELY(entry->dynamic_ref_table->lookupResourceId(&new_key) != NO_ERROR)) {
Adam Lesinskibebfcc42018-02-12 14:27:46 -08001245 LOG(ERROR) << base::StringPrintf("Failed to resolve key 0x%08x in bag 0x%08x.", new_key,
1246 resid);
Ryan Mitchell80094e32020-11-16 23:08:18 +00001247 return base::unexpected(std::nullopt);
Adam Lesinskida431a22016-12-29 16:08:16 -05001248 }
1249 }
Ryan Mitchell80094e32020-11-16 23:08:18 +00001250
1251 new_entry->cookie = entry->cookie;
Adam Lesinskida431a22016-12-29 16:08:16 -05001252 new_entry->key = new_key;
Adam Lesinski7ad11102016-10-28 16:39:15 -07001253 new_entry->key_pool = nullptr;
1254 new_entry->type_pool = nullptr;
Aurimas Liutikasd42a6702018-11-15 15:48:28 -08001255 new_entry->style = resid;
Adam Lesinski30080e22017-10-16 16:18:09 -07001256 new_entry->value.copyFrom_dtoh(map_entry->value);
Ryan Mitchell80094e32020-11-16 23:08:18 +00001257 status_t err = entry->dynamic_ref_table->lookupResourceValue(&new_entry->value);
1258 if (UNLIKELY(err != NO_ERROR)) {
Adam Lesinski30080e22017-10-16 16:18:09 -07001259 LOG(ERROR) << base::StringPrintf(
1260 "Failed to resolve value t=0x%02x d=0x%08x for key 0x%08x.", new_entry->value.dataType,
1261 new_entry->value.data, new_key);
Ryan Mitchell80094e32020-11-16 23:08:18 +00001262 return base::unexpected(std::nullopt);
Adam Lesinski30080e22017-10-16 16:18:09 -07001263 }
Ryan Mitchell80094e32020-11-16 23:08:18 +00001264
Ryan Mitchell155d5392020-02-10 13:35:24 -08001265 sort_entries = sort_entries ||
1266 (new_entry != new_bag->entries && (new_entry->key < (new_entry - 1U)->key));
Adam Lesinski7ad11102016-10-28 16:39:15 -07001267 ++new_entry;
1268 }
Ryan Mitchell155d5392020-02-10 13:35:24 -08001269
1270 if (sort_entries) {
Ryan Mitchell80094e32020-11-16 23:08:18 +00001271 std::sort(new_bag->entries, new_bag->entries + entry_count,
1272 [](auto&& lhs, auto&& rhs) { return lhs.key < rhs.key; });
Ryan Mitchell155d5392020-02-10 13:35:24 -08001273 }
1274
Ryan Mitchell80094e32020-11-16 23:08:18 +00001275 new_bag->type_spec_flags = entry->type_flags;
Adam Lesinski7ad11102016-10-28 16:39:15 -07001276 new_bag->entry_count = static_cast<uint32_t>(entry_count);
1277 ResolvedBag* result = new_bag.get();
1278 cached_bags_[resid] = std::move(new_bag);
1279 return result;
1280 }
1281
Adam Lesinskida431a22016-12-29 16:08:16 -05001282 // In case the parent is a dynamic reference, resolve it.
Ryan Mitchell80094e32020-11-16 23:08:18 +00001283 entry->dynamic_ref_table->lookupResourceId(&parent_resid);
Adam Lesinskida431a22016-12-29 16:08:16 -05001284
Adam Lesinski7ad11102016-10-28 16:39:15 -07001285 // Get the parent and do a merge of the keys.
Ryan Mitchell80094e32020-11-16 23:08:18 +00001286 const auto parent_bag = GetBag(parent_resid, child_resids);
1287 if (UNLIKELY(!parent_bag.has_value())) {
Adam Lesinski7ad11102016-10-28 16:39:15 -07001288 // Failed to get the parent that should exist.
Adam Lesinskibebfcc42018-02-12 14:27:46 -08001289 LOG(ERROR) << base::StringPrintf("Failed to find parent 0x%08x of bag 0x%08x.", parent_resid,
1290 resid);
Ryan Mitchell80094e32020-11-16 23:08:18 +00001291 return base::unexpected(parent_bag.error());
Adam Lesinski7ad11102016-10-28 16:39:15 -07001292 }
1293
Adam Lesinski7ad11102016-10-28 16:39:15 -07001294 // Create the max possible entries we can make. Once we construct the bag,
1295 // we will realloc to fit to size.
Ryan Mitchell80094e32020-11-16 23:08:18 +00001296 const size_t max_count = (*parent_bag)->entry_count + dtohl(map->count);
George Burgess IV09b119f2017-07-25 15:00:04 -07001297 util::unique_cptr<ResolvedBag> new_bag{reinterpret_cast<ResolvedBag*>(
1298 malloc(sizeof(ResolvedBag) + (max_count * sizeof(ResolvedBag::Entry))))};
Adam Lesinski7ad11102016-10-28 16:39:15 -07001299 ResolvedBag::Entry* new_entry = new_bag->entries;
1300
Ryan Mitchell80094e32020-11-16 23:08:18 +00001301 const ResolvedBag::Entry* parent_entry = (*parent_bag)->entries;
1302 const ResolvedBag::Entry* const parent_entry_end = parent_entry + (*parent_bag)->entry_count;
Adam Lesinski7ad11102016-10-28 16:39:15 -07001303
1304 // The keys are expected to be in sorted order. Merge the two bags.
Ryan Mitchell155d5392020-02-10 13:35:24 -08001305 bool sort_entries = false;
Adam Lesinski7ad11102016-10-28 16:39:15 -07001306 while (map_entry != map_entry_end && parent_entry != parent_entry_end) {
Ryan Mitchell80094e32020-11-16 23:08:18 +00001307 if (UNLIKELY(!map_entry)) {
1308 return base::unexpected(IOError::PAGES_MISSING);
1309 }
1310
Adam Lesinskida431a22016-12-29 16:08:16 -05001311 uint32_t child_key = dtohl(map_entry->name.ident);
Adam Lesinski929d6512017-01-16 19:11:19 -08001312 if (!is_internal_resid(child_key)) {
Ryan Mitchell80094e32020-11-16 23:08:18 +00001313 if (UNLIKELY(entry->dynamic_ref_table->lookupResourceId(&child_key) != NO_ERROR)) {
Adam Lesinskibebfcc42018-02-12 14:27:46 -08001314 LOG(ERROR) << base::StringPrintf("Failed to resolve key 0x%08x in bag 0x%08x.", child_key,
1315 resid);
Ryan Mitchell80094e32020-11-16 23:08:18 +00001316 return base::unexpected(std::nullopt);
Adam Lesinskida431a22016-12-29 16:08:16 -05001317 }
1318 }
1319
Adam Lesinski7ad11102016-10-28 16:39:15 -07001320 if (child_key <= parent_entry->key) {
1321 // Use the child key if it comes before the parent
1322 // or is equal to the parent (overrides).
Ryan Mitchell80094e32020-11-16 23:08:18 +00001323 new_entry->cookie = entry->cookie;
Adam Lesinski7ad11102016-10-28 16:39:15 -07001324 new_entry->key = child_key;
1325 new_entry->key_pool = nullptr;
1326 new_entry->type_pool = nullptr;
Adam Lesinski30080e22017-10-16 16:18:09 -07001327 new_entry->value.copyFrom_dtoh(map_entry->value);
Aurimas Liutikasd42a6702018-11-15 15:48:28 -08001328 new_entry->style = resid;
Ryan Mitchell80094e32020-11-16 23:08:18 +00001329 status_t err = entry->dynamic_ref_table->lookupResourceValue(&new_entry->value);
1330 if (UNLIKELY(err != NO_ERROR)) {
Adam Lesinski30080e22017-10-16 16:18:09 -07001331 LOG(ERROR) << base::StringPrintf(
1332 "Failed to resolve value t=0x%02x d=0x%08x for key 0x%08x.", new_entry->value.dataType,
1333 new_entry->value.data, child_key);
Ryan Mitchell80094e32020-11-16 23:08:18 +00001334 return base::unexpected(std::nullopt);
Adam Lesinski30080e22017-10-16 16:18:09 -07001335 }
Adam Lesinski7ad11102016-10-28 16:39:15 -07001336 ++map_entry;
1337 } else {
1338 // Take the parent entry as-is.
1339 memcpy(new_entry, parent_entry, sizeof(*new_entry));
1340 }
1341
Ryan Mitchell155d5392020-02-10 13:35:24 -08001342 sort_entries = sort_entries ||
1343 (new_entry != new_bag->entries && (new_entry->key < (new_entry - 1U)->key));
Adam Lesinski7ad11102016-10-28 16:39:15 -07001344 if (child_key >= parent_entry->key) {
1345 // Move to the next parent entry if we used it or it was overridden.
1346 ++parent_entry;
1347 }
1348 // Increment to the next entry to fill.
1349 ++new_entry;
1350 }
1351
1352 // Finish the child entries if they exist.
1353 while (map_entry != map_entry_end) {
Ryan Mitchell80094e32020-11-16 23:08:18 +00001354 if (UNLIKELY(!map_entry)) {
1355 return base::unexpected(IOError::PAGES_MISSING);
1356 }
1357
Adam Lesinskida431a22016-12-29 16:08:16 -05001358 uint32_t new_key = dtohl(map_entry->name.ident);
Adam Lesinski929d6512017-01-16 19:11:19 -08001359 if (!is_internal_resid(new_key)) {
Ryan Mitchell80094e32020-11-16 23:08:18 +00001360 if (UNLIKELY(entry->dynamic_ref_table->lookupResourceId(&new_key) != NO_ERROR)) {
Adam Lesinskibebfcc42018-02-12 14:27:46 -08001361 LOG(ERROR) << base::StringPrintf("Failed to resolve key 0x%08x in bag 0x%08x.", new_key,
1362 resid);
Ryan Mitchell80094e32020-11-16 23:08:18 +00001363 return base::unexpected(std::nullopt);
Adam Lesinskida431a22016-12-29 16:08:16 -05001364 }
1365 }
Ryan Mitchell80094e32020-11-16 23:08:18 +00001366 new_entry->cookie = entry->cookie;
Adam Lesinskida431a22016-12-29 16:08:16 -05001367 new_entry->key = new_key;
Adam Lesinski7ad11102016-10-28 16:39:15 -07001368 new_entry->key_pool = nullptr;
1369 new_entry->type_pool = nullptr;
Adam Lesinski30080e22017-10-16 16:18:09 -07001370 new_entry->value.copyFrom_dtoh(map_entry->value);
Aurimas Liutikasd42a6702018-11-15 15:48:28 -08001371 new_entry->style = resid;
Ryan Mitchell80094e32020-11-16 23:08:18 +00001372 status_t err = entry->dynamic_ref_table->lookupResourceValue(&new_entry->value);
1373 if (UNLIKELY(err != NO_ERROR)) {
Adam Lesinski30080e22017-10-16 16:18:09 -07001374 LOG(ERROR) << base::StringPrintf("Failed to resolve value t=0x%02x d=0x%08x for key 0x%08x.",
1375 new_entry->value.dataType, new_entry->value.data, new_key);
Ryan Mitchell80094e32020-11-16 23:08:18 +00001376 return base::unexpected(std::nullopt);
Adam Lesinski30080e22017-10-16 16:18:09 -07001377 }
Ryan Mitchell155d5392020-02-10 13:35:24 -08001378 sort_entries = sort_entries ||
1379 (new_entry != new_bag->entries && (new_entry->key < (new_entry - 1U)->key));
Adam Lesinski7ad11102016-10-28 16:39:15 -07001380 ++map_entry;
1381 ++new_entry;
1382 }
1383
1384 // Finish the parent entries if they exist.
1385 if (parent_entry != parent_entry_end) {
1386 // Take the rest of the parent entries as-is.
1387 const size_t num_entries_to_copy = parent_entry_end - parent_entry;
1388 memcpy(new_entry, parent_entry, num_entries_to_copy * sizeof(*new_entry));
1389 new_entry += num_entries_to_copy;
1390 }
1391
1392 // Resize the resulting array to fit.
1393 const size_t actual_count = new_entry - new_bag->entries;
1394 if (actual_count != max_count) {
George Burgess IV09b119f2017-07-25 15:00:04 -07001395 new_bag.reset(reinterpret_cast<ResolvedBag*>(realloc(
1396 new_bag.release(), sizeof(ResolvedBag) + (actual_count * sizeof(ResolvedBag::Entry)))));
Adam Lesinski7ad11102016-10-28 16:39:15 -07001397 }
1398
Ryan Mitchell155d5392020-02-10 13:35:24 -08001399 if (sort_entries) {
Ryan Mitchell80094e32020-11-16 23:08:18 +00001400 std::sort(new_bag->entries, new_bag->entries + actual_count,
1401 [](auto&& lhs, auto&& rhs) { return lhs.key < rhs.key; });
Ryan Mitchell155d5392020-02-10 13:35:24 -08001402 }
1403
Adam Lesinski1a1e9c22017-10-13 15:45:34 -07001404 // Combine flags from the parent and our own bag.
Ryan Mitchell80094e32020-11-16 23:08:18 +00001405 new_bag->type_spec_flags = entry->type_flags | (*parent_bag)->type_spec_flags;
George Burgess IV09b119f2017-07-25 15:00:04 -07001406 new_bag->entry_count = static_cast<uint32_t>(actual_count);
1407 ResolvedBag* result = new_bag.get();
1408 cached_bags_[resid] = std::move(new_bag);
Adam Lesinski7ad11102016-10-28 16:39:15 -07001409 return result;
1410}
1411
Yurii Zubrytskyia5775142022-11-02 17:49:49 -07001412static bool Utf8ToUtf16(StringPiece str, std::u16string* out) {
Adam Lesinski929d6512017-01-16 19:11:19 -08001413 ssize_t len =
1414 utf8_to_utf16_length(reinterpret_cast<const uint8_t*>(str.data()), str.size(), false);
1415 if (len < 0) {
1416 return false;
1417 }
1418 out->resize(static_cast<size_t>(len));
1419 utf8_to_utf16(reinterpret_cast<const uint8_t*>(str.data()), str.size(), &*out->begin(),
1420 static_cast<size_t>(len + 1));
1421 return true;
1422}
1423
Ryan Mitchell80094e32020-11-16 23:08:18 +00001424base::expected<uint32_t, NullOrIOError> AssetManager2::GetResourceId(
1425 const std::string& resource_name, const std::string& fallback_type,
1426 const std::string& fallback_package) const {
Adam Lesinski929d6512017-01-16 19:11:19 -08001427 StringPiece package_name, type, entry;
1428 if (!ExtractResourceName(resource_name, &package_name, &type, &entry)) {
Ryan Mitchell80094e32020-11-16 23:08:18 +00001429 return base::unexpected(std::nullopt);
Adam Lesinski929d6512017-01-16 19:11:19 -08001430 }
1431
1432 if (entry.empty()) {
Ryan Mitchell80094e32020-11-16 23:08:18 +00001433 return base::unexpected(std::nullopt);
Adam Lesinski929d6512017-01-16 19:11:19 -08001434 }
1435
1436 if (package_name.empty()) {
1437 package_name = fallback_package;
1438 }
1439
1440 if (type.empty()) {
1441 type = fallback_type;
1442 }
1443
1444 std::u16string type16;
1445 if (!Utf8ToUtf16(type, &type16)) {
Ryan Mitchell80094e32020-11-16 23:08:18 +00001446 return base::unexpected(std::nullopt);
Adam Lesinski929d6512017-01-16 19:11:19 -08001447 }
1448
1449 std::u16string entry16;
1450 if (!Utf8ToUtf16(entry, &entry16)) {
Ryan Mitchell80094e32020-11-16 23:08:18 +00001451 return base::unexpected(std::nullopt);
Adam Lesinski929d6512017-01-16 19:11:19 -08001452 }
1453
1454 const StringPiece16 kAttr16 = u"attr";
1455 const static std::u16string kAttrPrivate16 = u"^attr-private";
1456
1457 for (const PackageGroup& package_group : package_groups_) {
Adam Lesinskibebfcc42018-02-12 14:27:46 -08001458 for (const ConfiguredPackage& package_impl : package_group.packages_) {
1459 const LoadedPackage* package = package_impl.loaded_package_;
Adam Lesinski929d6512017-01-16 19:11:19 -08001460 if (package_name != package->GetPackageName()) {
1461 // All packages in the same group are expected to have the same package name.
1462 break;
1463 }
1464
Ryan Mitchell80094e32020-11-16 23:08:18 +00001465 base::expected<uint32_t, NullOrIOError> resid = package->FindEntryByName(type16, entry16);
1466 if (UNLIKELY(IsIOError(resid))) {
1467 return base::unexpected(resid.error());
1468 }
1469
1470 if (!resid.has_value() && kAttr16 == type16) {
Adam Lesinski929d6512017-01-16 19:11:19 -08001471 // Private attributes in libraries (such as the framework) are sometimes encoded
1472 // under the type '^attr-private' in order to leave the ID space of public 'attr'
1473 // free for future additions. Check '^attr-private' for the same name.
1474 resid = package->FindEntryByName(kAttrPrivate16, entry16);
1475 }
1476
Ryan Mitchell80094e32020-11-16 23:08:18 +00001477 if (resid.has_value()) {
1478 return fix_package_id(*resid, package_group.dynamic_ref_table->mAssignedPackageId);
Adam Lesinski929d6512017-01-16 19:11:19 -08001479 }
1480 }
1481 }
Ryan Mitchell80094e32020-11-16 23:08:18 +00001482 return base::unexpected(std::nullopt);
Adam Lesinski0c405242017-01-13 20:47:26 -08001483}
1484
Ryan Mitchell14e8ade2021-01-11 16:01:35 -08001485void AssetManager2::RebuildFilterList() {
Adam Lesinskibebfcc42018-02-12 14:27:46 -08001486 for (PackageGroup& group : package_groups_) {
Yurii Zubrytskyidbce3562022-11-14 22:26:10 -08001487 for (ConfiguredPackage& package : group.packages_) {
1488 package.filtered_configs_.forEachItem([](auto, auto& fcg) { fcg.type_entries.clear(); });
Adam Lesinskibebfcc42018-02-12 14:27:46 -08001489 // Create the filters here.
Yurii Zubrytskyidbce3562022-11-14 22:26:10 -08001490 package.loaded_package_->ForEachTypeSpec([&](const TypeSpec& type_spec, uint8_t type_id) {
Yurii Zubrytskyi59dab3b2022-11-03 00:08:49 -07001491 FilteredConfigGroup* group = nullptr;
Ryan Mitchell14e8ade2021-01-11 16:01:35 -08001492 for (const auto& type_entry : type_spec.type_entries) {
Jeremy Meyerccf5cd72023-08-15 21:42:03 +00001493 for (auto & config : configurations_) {
1494 if (type_entry.config.match(config)) {
1495 if (!group) {
1496 group = &package.filtered_configs_.editItemAt(type_id - 1);
1497 }
1498 group->type_entries.push_back(&type_entry);
1499 break;
Yurii Zubrytskyi59dab3b2022-11-03 00:08:49 -07001500 }
Adam Lesinskibebfcc42018-02-12 14:27:46 -08001501 }
1502 }
1503 });
Yurii Zubrytskyidbce3562022-11-14 22:26:10 -08001504 package.filtered_configs_.trimBuckets(
1505 [](const auto& fcg) { return fcg.type_entries.empty(); });
Adam Lesinskibebfcc42018-02-12 14:27:46 -08001506 }
1507 }
1508}
1509
Adam Lesinski7ad11102016-10-28 16:39:15 -07001510void AssetManager2::InvalidateCaches(uint32_t diff) {
Yurii Zubrytskyi09144882023-06-15 23:23:15 -07001511 cached_resolved_values_.clear();
Ryan Mitchell2c4d8742019-03-04 09:41:00 -08001512
Adam Lesinski7ad11102016-10-28 16:39:15 -07001513 if (diff == 0xffffffffu) {
1514 // Everything must go.
1515 cached_bags_.clear();
Yurii Zubrytskyi09144882023-06-15 23:23:15 -07001516 cached_bag_resid_stacks_.clear();
Adam Lesinski7ad11102016-10-28 16:39:15 -07001517 return;
1518 }
1519
1520 // Be more conservative with what gets purged. Only if the bag has other possible
1521 // variations with respect to what changed (diff) should we remove it.
Yurii Zubrytskyi09144882023-06-15 23:23:15 -07001522 for (auto stack_it = cached_bag_resid_stacks_.begin();
1523 stack_it != cached_bag_resid_stacks_.end();) {
1524 const auto it = cached_bags_.find(stack_it->first);
1525 if (it == cached_bags_.end()) {
1526 stack_it = cached_bag_resid_stacks_.erase(stack_it);
1527 } else if ((diff & it->second->type_spec_flags) != 0) {
1528 cached_bags_.erase(it);
1529 stack_it = cached_bag_resid_stacks_.erase(stack_it);
Adam Lesinski7ad11102016-10-28 16:39:15 -07001530 } else {
Yurii Zubrytskyi09144882023-06-15 23:23:15 -07001531 ++stack_it; // Keep the item in both caches.
Adam Lesinski7ad11102016-10-28 16:39:15 -07001532 }
1533 }
Ryan Mitchella45506e2020-11-16 23:08:18 +00001534
Yurii Zubrytskyi09144882023-06-15 23:23:15 -07001535 // Need to ensure that both bag caches are consistent, as we populate them in the same function.
1536 // Iterate over the cached bags to erase the items without the corresponding resid_stack cache
1537 // items.
1538 for (auto it = cached_bags_.begin(); it != cached_bags_.end();) {
1539 if ((diff & it->second->type_spec_flags) != 0) {
1540 it = cached_bags_.erase(it);
1541 } else {
1542 ++it;
1543 }
1544 }
Adam Lesinski7ad11102016-10-28 16:39:15 -07001545}
1546
Ryan Mitchell2e394222019-08-28 12:10:51 -07001547uint8_t AssetManager2::GetAssignedPackageId(const LoadedPackage* package) const {
Ryan Mitchellb3ae42e2018-10-16 12:48:38 -07001548 for (auto& package_group : package_groups_) {
1549 for (auto& package2 : package_group.packages_) {
1550 if (package2.loaded_package_ == package) {
Ryan Mitchell8a891d82019-07-01 09:48:23 -07001551 return package_group.dynamic_ref_table->mAssignedPackageId;
Ryan Mitchellb3ae42e2018-10-16 12:48:38 -07001552 }
1553 }
1554 }
1555 return 0;
1556}
1557
Adam Lesinski30080e22017-10-16 16:18:09 -07001558std::unique_ptr<Theme> AssetManager2::NewTheme() {
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001559 constexpr size_t kInitialReserveSize = 32;
1560 auto theme = std::unique_ptr<Theme>(new Theme(this));
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001561 theme->keys_.reserve(kInitialReserveSize);
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001562 theme->entries_.reserve(kInitialReserveSize);
1563 return theme;
Adam Lesinski30080e22017-10-16 16:18:09 -07001564}
1565
Yurii Zubrytskyi9eb44c92022-11-14 23:44:52 -08001566void AssetManager2::ForEachPackage(base::function_ref<bool(const std::string&, uint8_t)> func,
1567 package_property_t excluded_property_flags) const {
1568 for (const PackageGroup& package_group : package_groups_) {
1569 const auto loaded_package = package_group.packages_.front().loaded_package_;
1570 if ((loaded_package->GetPropertyFlags() & excluded_property_flags) == 0U
1571 && !func(loaded_package->GetPackageName(),
1572 package_group.dynamic_ref_table->mAssignedPackageId)) {
1573 return;
1574 }
1575 }
1576}
1577
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -07001578AssetManager2::ScopedOperation AssetManager2::StartOperation() const {
1579 ++number_of_running_scoped_operations_;
1580 return ScopedOperation(*this);
1581}
1582
1583void AssetManager2::FinishOperation() const {
1584 if (number_of_running_scoped_operations_ < 1) {
1585 ALOGW("Invalid FinishOperation() call when there's none happening");
1586 return;
1587 }
1588 if (--number_of_running_scoped_operations_ == 0) {
1589 for (auto&& [_, assets] : apk_assets_) {
1590 assets.clear();
1591 }
1592 }
1593}
1594
1595const AssetManager2::ApkAssetsPtr& AssetManager2::GetApkAssets(ApkAssetsCookie cookie) const {
1596 DCHECK(number_of_running_scoped_operations_ > 0) << "Must have an operation running";
1597
1598 if (cookie < 0 || cookie >= apk_assets_.size()) {
1599 static const ApkAssetsPtr empty{};
1600 return empty;
1601 }
1602 auto& [wptr, res] = apk_assets_[cookie];
1603 if (!res) {
1604 res = wptr.promote();
1605 }
1606 return res;
1607}
1608
Adam Lesinski30080e22017-10-16 16:18:09 -07001609Theme::Theme(AssetManager2* asset_manager) : asset_manager_(asset_manager) {
1610}
1611
1612Theme::~Theme() = default;
1613
Ryan Mitchell80094e32020-11-16 23:08:18 +00001614base::expected<std::monostate, NullOrIOError> Theme::ApplyStyle(uint32_t resid, bool force) {
Adam Lesinskibebfcc42018-02-12 14:27:46 -08001615 ATRACE_NAME("Theme::ApplyStyle");
Adam Lesinski7ad11102016-10-28 16:39:15 -07001616
Ryan Mitchell80094e32020-11-16 23:08:18 +00001617 auto bag = asset_manager_->GetBag(resid);
1618 if (!bag.has_value()) {
1619 return base::unexpected(bag.error());
Adam Lesinski7ad11102016-10-28 16:39:15 -07001620 }
1621
1622 // Merge the flags from this style.
Ryan Mitchell80094e32020-11-16 23:08:18 +00001623 type_spec_flags_ |= (*bag)->type_spec_flags;
Adam Lesinski7ad11102016-10-28 16:39:15 -07001624
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001625 for (auto it = begin(*bag); it != end(*bag); ++it) {
1626 const uint32_t attr_res_id = it->key;
Adam Lesinski7ad11102016-10-28 16:39:15 -07001627
Adam Lesinski30080e22017-10-16 16:18:09 -07001628 // If the resource ID passed in is not a style, the key can be some other identifier that is not
1629 // a resource ID. We should fail fast instead of operating with strange resource IDs.
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001630 if (!is_valid_resid(attr_res_id)) {
Ryan Mitchell80094e32020-11-16 23:08:18 +00001631 return base::unexpected(std::nullopt);
Adam Lesinski7ad11102016-10-28 16:39:15 -07001632 }
1633
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001634 // DATA_NULL_EMPTY (@empty) is a valid resource value and DATA_NULL_UNDEFINED represents
1635 // an absence of a valid value.
1636 bool is_undefined = it->value.dataType == Res_value::TYPE_NULL &&
1637 it->value.data != Res_value::DATA_NULL_EMPTY;
1638 if (!force && is_undefined) {
1639 continue;
Adam Lesinski7ad11102016-10-28 16:39:15 -07001640 }
Adam Lesinski30080e22017-10-16 16:18:09 -07001641
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001642 const auto key_it = std::lower_bound(keys_.begin(), keys_.end(), attr_res_id);
1643 const auto entry_it = entries_.begin() + (key_it - keys_.begin());
1644 if (key_it != keys_.end() && *key_it == attr_res_id) {
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001645 if (is_undefined) {
1646 // DATA_NULL_UNDEFINED clears the value of the attribute in the theme only when `force` is
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001647 // true.
1648 keys_.erase(key_it);
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001649 entries_.erase(entry_it);
1650 } else if (force) {
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001651 *entry_it = Entry{it->cookie, (*bag)->type_spec_flags, it->value};
Adam Lesinski30080e22017-10-16 16:18:09 -07001652 }
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001653 } else {
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001654 keys_.insert(key_it, attr_res_id);
1655 entries_.insert(entry_it, Entry{it->cookie, (*bag)->type_spec_flags, it->value});
Adam Lesinski7ad11102016-10-28 16:39:15 -07001656 }
1657 }
Ryan Mitchell80094e32020-11-16 23:08:18 +00001658 return {};
Adam Lesinski7ad11102016-10-28 16:39:15 -07001659}
1660
Ryan Mitchell767e34f2021-06-07 12:29:05 -07001661void Theme::Rebase(AssetManager2* am, const uint32_t* style_ids, const uint8_t* force,
1662 size_t style_count) {
1663 ATRACE_NAME("Theme::Rebase");
1664 // Reset the entries without changing the vector capacity to prevent reallocations during
1665 // ApplyStyle.
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001666 keys_.clear();
Ryan Mitchell767e34f2021-06-07 12:29:05 -07001667 entries_.clear();
1668 asset_manager_ = am;
1669 for (size_t i = 0; i < style_count; i++) {
1670 ApplyStyle(style_ids[i], force[i]);
1671 }
1672}
1673
Ryan Mitchell80094e32020-11-16 23:08:18 +00001674std::optional<AssetManager2::SelectedValue> Theme::GetAttribute(uint32_t resid) const {
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001675 constexpr const uint32_t kMaxIterations = 20;
Adam Lesinski7ad11102016-10-28 16:39:15 -07001676 uint32_t type_spec_flags = 0u;
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001677 for (uint32_t i = 0; i <= kMaxIterations; i++) {
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001678 const auto key_it = std::lower_bound(keys_.begin(), keys_.end(), resid);
1679 if (key_it == keys_.end() || *key_it != resid) {
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001680 return std::nullopt;
Adam Lesinski7ad11102016-10-28 16:39:15 -07001681 }
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001682 const auto entry_it = entries_.begin() + (key_it - keys_.begin());
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001683 type_spec_flags |= entry_it->type_spec_flags;
1684 if (entry_it->value.dataType == Res_value::TYPE_ATTRIBUTE) {
1685 resid = entry_it->value.data;
1686 continue;
1687 }
1688
1689 return AssetManager2::SelectedValue(entry_it->value.dataType, entry_it->value.data,
1690 entry_it->cookie, type_spec_flags, 0U /* resid */,
1691 {} /* config */);
1692 }
Ryan Mitchell80094e32020-11-16 23:08:18 +00001693 return std::nullopt;
Adam Lesinski7ad11102016-10-28 16:39:15 -07001694}
1695
Ryan Mitchell80094e32020-11-16 23:08:18 +00001696base::expected<std::monostate, NullOrIOError> Theme::ResolveAttributeReference(
1697 AssetManager2::SelectedValue& value) const {
1698 if (value.type != Res_value::TYPE_ATTRIBUTE) {
1699 return asset_manager_->ResolveReference(value);
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -08001700 }
Ryan Mitchell80094e32020-11-16 23:08:18 +00001701
1702 std::optional<AssetManager2::SelectedValue> result = GetAttribute(value.data);
1703 if (!result.has_value()) {
1704 return base::unexpected(std::nullopt);
1705 }
1706
Ryan Mitchella45506e2020-11-16 23:08:18 +00001707 auto resolve_result = asset_manager_->ResolveReference(*result, true /* cache_value */);
Ryan Mitchell80094e32020-11-16 23:08:18 +00001708 if (resolve_result.has_value()) {
1709 result->flags |= value.flags;
1710 value = *result;
1711 }
1712 return resolve_result;
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -08001713}
1714
Adam Lesinski7ad11102016-10-28 16:39:15 -07001715void Theme::Clear() {
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001716 keys_.clear();
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001717 entries_.clear();
Adam Lesinski7ad11102016-10-28 16:39:15 -07001718}
1719
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001720base::expected<std::monostate, IOError> Theme::SetTo(const Theme& source) {
1721 if (this == &source) {
Ryan Mitchell80094e32020-11-16 23:08:18 +00001722 return {};
Adam Lesinski7ad11102016-10-28 16:39:15 -07001723 }
1724
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001725 type_spec_flags_ = source.type_spec_flags_;
Adam Lesinski7ad11102016-10-28 16:39:15 -07001726
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001727 if (asset_manager_ == source.asset_manager_) {
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001728 keys_ = source.keys_;
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001729 entries_ = source.entries_;
Ryan Mitchellb3ae42e2018-10-16 12:48:38 -07001730 } else {
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001731 std::unordered_map<ApkAssetsCookie, ApkAssetsCookie> src_to_dest_asset_cookies;
1732 using SourceToDestinationRuntimePackageMap = std::unordered_map<int, int>;
1733 std::unordered_map<ApkAssetsCookie, SourceToDestinationRuntimePackageMap> src_asset_cookie_id_map;
Ryan Mitchellb3ae42e2018-10-16 12:48:38 -07001734
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -07001735 auto op_src = source.asset_manager_->StartOperation();
1736 auto op_dst = asset_manager_->StartOperation();
Ryan Mitchellb3ae42e2018-10-16 12:48:38 -07001737
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -07001738 for (size_t i = 0; i < source.asset_manager_->GetApkAssetsCount(); i++) {
1739 const auto& src_asset = source.asset_manager_->GetApkAssets(i);
1740 if (!src_asset) {
Yurii Zubrytskyib3455192023-05-01 14:35:48 -07001741 continue;
1742 }
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -07001743 for (int j = 0; j < asset_manager_->GetApkAssetsCount(); j++) {
1744 const auto& dest_asset = asset_manager_->GetApkAssets(j);
Ryan Mitchellef538432021-03-01 14:52:14 -08001745 if (src_asset != dest_asset) {
1746 // ResourcesManager caches and reuses ApkAssets when the same apk must be present in
1747 // multiple AssetManagers. Two ApkAssets point to the same version of the same resources
1748 // if they are the same instance.
1749 continue;
Ryan Mitchellb3ae42e2018-10-16 12:48:38 -07001750 }
Ryan Mitchellef538432021-03-01 14:52:14 -08001751
1752 // Map the package ids of the asset in the source AssetManager to the package ids of the
1753 // asset in th destination AssetManager.
1754 SourceToDestinationRuntimePackageMap package_map;
1755 for (const auto& loaded_package : src_asset->GetLoadedArsc()->GetPackages()) {
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001756 const int src_package_id = source.asset_manager_->GetAssignedPackageId(
1757 loaded_package.get());
Ryan Mitchellef538432021-03-01 14:52:14 -08001758 const int dest_package_id = asset_manager_->GetAssignedPackageId(loaded_package.get());
1759 package_map[src_package_id] = dest_package_id;
1760 }
1761
1762 src_to_dest_asset_cookies.insert(std::make_pair(i, j));
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001763 src_asset_cookie_id_map.insert(std::make_pair(i, std::move(package_map)));
Ryan Mitchellef538432021-03-01 14:52:14 -08001764 break;
Ryan Mitchellb3ae42e2018-10-16 12:48:38 -07001765 }
1766 }
1767
Ryan Mitchell93bca972019-03-08 17:26:28 -08001768 // Reset the data in the destination theme.
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001769 keys_.clear();
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001770 entries_.clear();
Ryan Mitchellb3ae42e2018-10-16 12:48:38 -07001771
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001772 for (size_t i = 0, size = source.entries_.size(); i != size; ++i) {
1773 const auto& entry = source.entries_[i];
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001774 bool is_reference = (entry.value.dataType == Res_value::TYPE_ATTRIBUTE
1775 || entry.value.dataType == Res_value::TYPE_REFERENCE
1776 || entry.value.dataType == Res_value::TYPE_DYNAMIC_ATTRIBUTE
1777 || entry.value.dataType == Res_value::TYPE_DYNAMIC_REFERENCE)
1778 && entry.value.data != 0x0;
Ryan Mitchellb3ae42e2018-10-16 12:48:38 -07001779
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001780 // If the attribute value represents an attribute or reference, the package id of the
1781 // value needs to be rewritten to the package id of the value in the destination.
1782 uint32_t attribute_data = entry.value.data;
1783 if (is_reference) {
1784 // Determine the package id of the reference in the destination AssetManager.
1785 auto value_package_map = src_asset_cookie_id_map.find(entry.cookie);
1786 if (value_package_map == src_asset_cookie_id_map.end()) {
Ryan Mitchellb3ae42e2018-10-16 12:48:38 -07001787 continue;
1788 }
1789
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001790 auto value_dest_package = value_package_map->second.find(
1791 get_package_id(entry.value.data));
1792 if (value_dest_package == value_package_map->second.end()) {
1793 continue;
1794 }
Ryan Mitchellb3ae42e2018-10-16 12:48:38 -07001795
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001796 attribute_data = fix_package_id(entry.value.data, value_dest_package->second);
1797 }
Ryan Mitchellb85d9b22018-11-19 12:11:38 -08001798
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001799 // Find the cookie of the value in the destination. If the source apk is not loaded in the
1800 // destination, only copy resources that do not reference resources in the source.
1801 ApkAssetsCookie data_dest_cookie;
1802 auto value_dest_cookie = src_to_dest_asset_cookies.find(entry.cookie);
1803 if (value_dest_cookie != src_to_dest_asset_cookies.end()) {
1804 data_dest_cookie = value_dest_cookie->second;
1805 } else {
1806 if (is_reference || entry.value.dataType == Res_value::TYPE_STRING) {
1807 continue;
1808 } else {
1809 data_dest_cookie = 0x0;
Ryan Mitchellb3ae42e2018-10-16 12:48:38 -07001810 }
1811 }
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001812
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001813 const auto source_res_id = source.keys_[i];
1814
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001815 // The package id of the attribute needs to be rewritten to the package id of the
1816 // attribute in the destination.
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001817 int attribute_dest_package_id = get_package_id(source_res_id);
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001818 if (attribute_dest_package_id != 0x01) {
1819 // Find the cookie of the attribute resource id in the source AssetManager
1820 base::expected<FindEntryResult, NullOrIOError> attribute_entry_result =
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001821 source.asset_manager_->FindEntry(source_res_id, 0 /* density_override */ ,
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001822 true /* stop_at_first_match */,
1823 true /* ignore_configuration */);
1824 if (UNLIKELY(IsIOError(attribute_entry_result))) {
1825 return base::unexpected(GetIOError(attribute_entry_result.error()));
1826 }
1827 if (!attribute_entry_result.has_value()) {
1828 continue;
1829 }
1830
1831 // Determine the package id of the attribute in the destination AssetManager.
1832 auto attribute_package_map = src_asset_cookie_id_map.find(
1833 attribute_entry_result->cookie);
1834 if (attribute_package_map == src_asset_cookie_id_map.end()) {
1835 continue;
1836 }
1837 auto attribute_dest_package = attribute_package_map->second.find(
1838 attribute_dest_package_id);
1839 if (attribute_dest_package == attribute_package_map->second.end()) {
1840 continue;
1841 }
1842 attribute_dest_package_id = attribute_dest_package->second;
1843 }
1844
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001845 auto dest_attr_id = make_resid(attribute_dest_package_id, get_type_id(source_res_id),
1846 get_entry_id(source_res_id));
1847 const auto key_it = std::lower_bound(keys_.begin(), keys_.end(), dest_attr_id);
1848 const auto entry_it = entries_.begin() + (key_it - keys_.begin());
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001849 // Since the entries were cleared, the attribute resource id has yet been mapped to any value.
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001850 keys_.insert(key_it, dest_attr_id);
1851 entries_.insert(entry_it, Entry{data_dest_cookie, entry.type_spec_flags,
1852 Res_value{.dataType = entry.value.dataType,
1853 .data = attribute_data}});
Adam Lesinski7ad11102016-10-28 16:39:15 -07001854 }
1855 }
Ryan Mitchell80094e32020-11-16 23:08:18 +00001856 return {};
Ryan Mitchellb3ae42e2018-10-16 12:48:38 -07001857}
1858
1859void Theme::Dump() const {
Ryan Mitchellb3ae42e2018-10-16 12:48:38 -07001860 LOG(INFO) << base::StringPrintf("Theme(this=%p, AssetManager2=%p)", this, asset_manager_);
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001861 for (size_t i = 0, size = keys_.size(); i != size; ++i) {
1862 auto res_id = keys_[i];
1863 const auto& entry = entries_[i];
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001864 LOG(INFO) << base::StringPrintf(" entry(0x%08x)=(0x%08x) type=(0x%02x), cookie(%d)",
Yurii Zubrytskyi591895b2022-11-14 22:06:30 -08001865 res_id, entry.value.data, entry.value.dataType,
Ryan Mitchell3c6480c2021-06-07 11:22:30 -07001866 entry.cookie);
Ryan Mitchellb3ae42e2018-10-16 12:48:38 -07001867 }
Adam Lesinski7ad11102016-10-28 16:39:15 -07001868}
1869
Yurii Zubrytskyibdcbf552023-05-10 13:16:23 -07001870AssetManager2::ScopedOperation::ScopedOperation(const AssetManager2& am) : am_(am) {
1871}
1872
1873AssetManager2::ScopedOperation::~ScopedOperation() {
1874 am_.FinishOperation();
1875}
1876
Adam Lesinski7ad11102016-10-28 16:39:15 -07001877} // namespace android