blob: 83c82af4385ce1b5591463abd5646e7d51c2307c [file] [log] [blame]
Adam Lesinski7ad11102016-10-28 16:39:15 -07001/*
2 * Copyright (C) 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#define ATRACE_TAG ATRACE_TAG_RESOURCES
18
19#include "androidfw/AssetManager2.h"
20
Adam Lesinski30080e22017-10-16 16:18:09 -070021#include <iterator>
Adam Lesinski0c405242017-01-13 20:47:26 -080022#include <set>
23
Adam Lesinski7ad11102016-10-28 16:39:15 -070024#include "android-base/logging.h"
25#include "android-base/stringprintf.h"
26#include "utils/ByteOrder.h"
27#include "utils/Trace.h"
28
29#ifdef _WIN32
30#ifdef ERROR
31#undef ERROR
32#endif
33#endif
34
Adam Lesinski929d6512017-01-16 19:11:19 -080035#include "androidfw/ResourceUtils.h"
36
Adam Lesinski7ad11102016-10-28 16:39:15 -070037namespace android {
38
Adam Lesinski970bd8d2017-09-25 13:21:55 -070039AssetManager2::AssetManager2() {
40 memset(&configuration_, 0, sizeof(configuration_));
41}
Adam Lesinski7ad11102016-10-28 16:39:15 -070042
43bool AssetManager2::SetApkAssets(const std::vector<const ApkAssets*>& apk_assets,
44 bool invalidate_caches) {
45 apk_assets_ = apk_assets;
Adam Lesinskida431a22016-12-29 16:08:16 -050046 BuildDynamicRefTable();
Adam Lesinski7ad11102016-10-28 16:39:15 -070047 if (invalidate_caches) {
48 InvalidateCaches(static_cast<uint32_t>(-1));
49 }
50 return true;
51}
52
Adam Lesinskida431a22016-12-29 16:08:16 -050053void AssetManager2::BuildDynamicRefTable() {
54 package_groups_.clear();
55 package_ids_.fill(0xff);
56
57 // 0x01 is reserved for the android package.
58 int next_package_id = 0x02;
59 const size_t apk_assets_count = apk_assets_.size();
60 for (size_t i = 0; i < apk_assets_count; i++) {
Adam Lesinski970bd8d2017-09-25 13:21:55 -070061 const LoadedArsc* loaded_arsc = apk_assets_[i]->GetLoadedArsc();
62
63 for (const std::unique_ptr<const LoadedPackage>& package : loaded_arsc->GetPackages()) {
Adam Lesinskida431a22016-12-29 16:08:16 -050064 // Get the package ID or assign one if a shared library.
65 int package_id;
66 if (package->IsDynamic()) {
67 package_id = next_package_id++;
68 } else {
69 package_id = package->GetPackageId();
70 }
71
72 // Add the mapping for package ID to index if not present.
73 uint8_t idx = package_ids_[package_id];
74 if (idx == 0xff) {
75 package_ids_[package_id] = idx = static_cast<uint8_t>(package_groups_.size());
76 package_groups_.push_back({});
77 package_groups_.back().dynamic_ref_table.mAssignedPackageId = package_id;
78 }
79 PackageGroup* package_group = &package_groups_[idx];
80
81 // Add the package and to the set of packages with the same ID.
82 package_group->packages_.push_back(package.get());
83 package_group->cookies_.push_back(static_cast<ApkAssetsCookie>(i));
84
85 // Add the package name -> build time ID mappings.
86 for (const DynamicPackageEntry& entry : package->GetDynamicPackageMap()) {
87 String16 package_name(entry.package_name.c_str(), entry.package_name.size());
88 package_group->dynamic_ref_table.mEntries.replaceValueFor(
89 package_name, static_cast<uint8_t>(entry.package_id));
90 }
91 }
92 }
93
94 // Now assign the runtime IDs so that we have a build-time to runtime ID map.
95 const auto package_groups_end = package_groups_.end();
96 for (auto iter = package_groups_.begin(); iter != package_groups_end; ++iter) {
97 const std::string& package_name = iter->packages_[0]->GetPackageName();
98 for (auto iter2 = package_groups_.begin(); iter2 != package_groups_end; ++iter2) {
99 iter2->dynamic_ref_table.addMapping(String16(package_name.c_str(), package_name.size()),
100 iter->dynamic_ref_table.mAssignedPackageId);
101 }
102 }
103}
104
105void AssetManager2::DumpToLog() const {
106 base::ScopedLogSeverity _log(base::INFO);
107
108 std::string list;
109 for (size_t i = 0; i < package_ids_.size(); i++) {
110 if (package_ids_[i] != 0xff) {
111 base::StringAppendF(&list, "%02x -> %d, ", (int) i, package_ids_[i]);
112 }
113 }
114 LOG(INFO) << "Package ID map: " << list;
115
116 for (const auto& package_group: package_groups_) {
117 list = "";
118 for (const auto& package : package_group.packages_) {
119 base::StringAppendF(&list, "%s(%02x), ", package->GetPackageName().c_str(), package->GetPackageId());
120 }
121 LOG(INFO) << base::StringPrintf("PG (%02x): ", package_group.dynamic_ref_table.mAssignedPackageId) << list;
122 }
123}
Adam Lesinski7ad11102016-10-28 16:39:15 -0700124
125const ResStringPool* AssetManager2::GetStringPoolForCookie(ApkAssetsCookie cookie) const {
126 if (cookie < 0 || static_cast<size_t>(cookie) >= apk_assets_.size()) {
127 return nullptr;
128 }
129 return apk_assets_[cookie]->GetLoadedArsc()->GetStringPool();
130}
131
Adam Lesinskida431a22016-12-29 16:08:16 -0500132const DynamicRefTable* AssetManager2::GetDynamicRefTableForPackage(uint32_t package_id) const {
133 if (package_id >= package_ids_.size()) {
134 return nullptr;
135 }
136
137 const size_t idx = package_ids_[package_id];
138 if (idx == 0xff) {
139 return nullptr;
140 }
141 return &package_groups_[idx].dynamic_ref_table;
142}
143
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800144const DynamicRefTable* AssetManager2::GetDynamicRefTableForCookie(ApkAssetsCookie cookie) const {
145 for (const PackageGroup& package_group : package_groups_) {
146 for (const ApkAssetsCookie& package_cookie : package_group.cookies_) {
147 if (package_cookie == cookie) {
148 return &package_group.dynamic_ref_table;
149 }
150 }
151 }
152 return nullptr;
153}
154
Adam Lesinski7ad11102016-10-28 16:39:15 -0700155void AssetManager2::SetConfiguration(const ResTable_config& configuration) {
156 const int diff = configuration_.diff(configuration);
157 configuration_ = configuration;
158
159 if (diff) {
160 InvalidateCaches(static_cast<uint32_t>(diff));
161 }
162}
163
Adam Lesinski0c405242017-01-13 20:47:26 -0800164std::set<ResTable_config> AssetManager2::GetResourceConfigurations(bool exclude_system,
165 bool exclude_mipmap) {
166 ATRACE_CALL();
167 std::set<ResTable_config> configurations;
168 for (const PackageGroup& package_group : package_groups_) {
169 for (const LoadedPackage* package : package_group.packages_) {
170 if (exclude_system && package->IsSystem()) {
171 continue;
172 }
173 package->CollectConfigurations(exclude_mipmap, &configurations);
174 }
175 }
176 return configurations;
177}
178
179std::set<std::string> AssetManager2::GetResourceLocales(bool exclude_system,
180 bool merge_equivalent_languages) {
181 ATRACE_CALL();
182 std::set<std::string> locales;
183 for (const PackageGroup& package_group : package_groups_) {
184 for (const LoadedPackage* package : package_group.packages_) {
185 if (exclude_system && package->IsSystem()) {
186 continue;
187 }
188 package->CollectLocales(merge_equivalent_languages, &locales);
189 }
190 }
191 return locales;
192}
193
Adam Lesinski7ad11102016-10-28 16:39:15 -0700194std::unique_ptr<Asset> AssetManager2::Open(const std::string& filename, Asset::AccessMode mode) {
195 const std::string new_path = "assets/" + filename;
196 return OpenNonAsset(new_path, mode);
197}
198
199std::unique_ptr<Asset> AssetManager2::Open(const std::string& filename, ApkAssetsCookie cookie,
200 Asset::AccessMode mode) {
201 const std::string new_path = "assets/" + filename;
202 return OpenNonAsset(new_path, cookie, mode);
203}
204
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800205std::unique_ptr<AssetDir> AssetManager2::OpenDir(const std::string& dirname) {
206 ATRACE_CALL();
207
208 std::string full_path = "assets/" + dirname;
209 std::unique_ptr<SortedVector<AssetDir::FileInfo>> files =
210 util::make_unique<SortedVector<AssetDir::FileInfo>>();
211
212 // Start from the back.
213 for (auto iter = apk_assets_.rbegin(); iter != apk_assets_.rend(); ++iter) {
214 const ApkAssets* apk_assets = *iter;
215
216 auto func = [&](const StringPiece& name, FileType type) {
217 AssetDir::FileInfo info;
218 info.setFileName(String8(name.data(), name.size()));
219 info.setFileType(type);
220 info.setSourceName(String8(apk_assets->GetPath().c_str()));
221 files->add(info);
222 };
223
224 if (!apk_assets->ForEachFile(full_path, func)) {
225 return {};
226 }
227 }
228
229 std::unique_ptr<AssetDir> asset_dir = util::make_unique<AssetDir>();
230 asset_dir->setFileList(files.release());
231 return asset_dir;
232}
233
Adam Lesinski7ad11102016-10-28 16:39:15 -0700234// Search in reverse because that's how we used to do it and we need to preserve behaviour.
235// This is unfortunate, because ClassLoaders delegate to the parent first, so the order
236// is inconsistent for split APKs.
237std::unique_ptr<Asset> AssetManager2::OpenNonAsset(const std::string& filename,
238 Asset::AccessMode mode,
239 ApkAssetsCookie* out_cookie) {
240 ATRACE_CALL();
241 for (int32_t i = apk_assets_.size() - 1; i >= 0; i--) {
242 std::unique_ptr<Asset> asset = apk_assets_[i]->Open(filename, mode);
243 if (asset) {
244 if (out_cookie != nullptr) {
245 *out_cookie = i;
246 }
247 return asset;
248 }
249 }
250
251 if (out_cookie != nullptr) {
252 *out_cookie = kInvalidCookie;
253 }
254 return {};
255}
256
257std::unique_ptr<Asset> AssetManager2::OpenNonAsset(const std::string& filename,
258 ApkAssetsCookie cookie, Asset::AccessMode mode) {
259 ATRACE_CALL();
260 if (cookie < 0 || static_cast<size_t>(cookie) >= apk_assets_.size()) {
261 return {};
262 }
263 return apk_assets_[cookie]->Open(filename, mode);
264}
265
266ApkAssetsCookie AssetManager2::FindEntry(uint32_t resid, uint16_t density_override,
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700267 bool stop_at_first_match, FindEntryResult* out_entry) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700268 ATRACE_CALL();
269
270 // Might use this if density_override != 0.
271 ResTable_config density_override_config;
272
273 // Select our configuration or generate a density override configuration.
274 ResTable_config* desired_config = &configuration_;
275 if (density_override != 0 && density_override != configuration_.density) {
276 density_override_config = configuration_;
277 density_override_config.density = density_override;
278 desired_config = &density_override_config;
279 }
280
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800281 if (!is_valid_resid(resid)) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500282 LOG(ERROR) << base::StringPrintf("Invalid ID 0x%08x.", resid);
283 return kInvalidCookie;
284 }
285
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800286 const uint32_t package_id = get_package_id(resid);
287 const uint8_t type_idx = get_type_id(resid) - 1;
288 const uint16_t entry_id = get_entry_id(resid);
289
Adam Lesinskida431a22016-12-29 16:08:16 -0500290 const uint8_t idx = package_ids_[package_id];
291 if (idx == 0xff) {
292 LOG(ERROR) << base::StringPrintf("No package ID %02x found for ID 0x%08x.", package_id, resid);
293 return kInvalidCookie;
294 }
295
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700296 FindEntryResult best_entry;
Adam Lesinskida431a22016-12-29 16:08:16 -0500297 ApkAssetsCookie best_cookie = kInvalidCookie;
298 uint32_t cumulated_flags = 0u;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700299
Adam Lesinskida431a22016-12-29 16:08:16 -0500300 const PackageGroup& package_group = package_groups_[idx];
301 const size_t package_count = package_group.packages_.size();
302 for (size_t i = 0; i < package_count; i++) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500303 const LoadedPackage* loaded_package = package_group.packages_[i];
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700304
305 FindEntryResult current_entry;
306 if (!loaded_package->FindEntry(type_idx, entry_id, *desired_config, &current_entry)) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700307 continue;
308 }
309
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700310 cumulated_flags |= current_entry.type_flags;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700311
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700312 const ResTable_config* current_config = current_entry.config;
313 const ResTable_config* best_config = best_entry.config;
314 if (best_cookie == kInvalidCookie ||
315 current_config->isBetterThan(*best_config, desired_config) ||
316 (loaded_package->IsOverlay() && current_config->compare(*best_config) == 0)) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700317 best_entry = current_entry;
Adam Lesinskida431a22016-12-29 16:08:16 -0500318 best_cookie = package_group.cookies_[i];
Adam Lesinski7ad11102016-10-28 16:39:15 -0700319 if (stop_at_first_match) {
320 break;
321 }
322 }
323 }
324
Adam Lesinskida431a22016-12-29 16:08:16 -0500325 if (best_cookie == kInvalidCookie) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700326 return kInvalidCookie;
327 }
328
329 *out_entry = best_entry;
Adam Lesinskida431a22016-12-29 16:08:16 -0500330 out_entry->dynamic_ref_table = &package_group.dynamic_ref_table;
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700331 out_entry->type_flags = cumulated_flags;
Adam Lesinskida431a22016-12-29 16:08:16 -0500332 return best_cookie;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700333}
334
335bool AssetManager2::GetResourceName(uint32_t resid, ResourceName* out_name) {
336 ATRACE_CALL();
337
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700338 FindEntryResult entry;
339 ApkAssetsCookie cookie =
340 FindEntry(resid, 0u /* density_override */, true /* stop_at_first_match */, &entry);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700341 if (cookie == kInvalidCookie) {
342 return false;
343 }
344
Adam Lesinskida431a22016-12-29 16:08:16 -0500345 const LoadedPackage* package = apk_assets_[cookie]->GetLoadedArsc()->GetPackageForId(resid);
346 if (package == nullptr) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700347 return false;
348 }
349
Adam Lesinskida431a22016-12-29 16:08:16 -0500350 out_name->package = package->GetPackageName().data();
351 out_name->package_len = package->GetPackageName().size();
Adam Lesinski7ad11102016-10-28 16:39:15 -0700352
353 out_name->type = entry.type_string_ref.string8(&out_name->type_len);
354 out_name->type16 = nullptr;
355 if (out_name->type == nullptr) {
356 out_name->type16 = entry.type_string_ref.string16(&out_name->type_len);
357 if (out_name->type16 == nullptr) {
358 return false;
359 }
360 }
361
362 out_name->entry = entry.entry_string_ref.string8(&out_name->entry_len);
363 out_name->entry16 = nullptr;
364 if (out_name->entry == nullptr) {
365 out_name->entry16 = entry.entry_string_ref.string16(&out_name->entry_len);
366 if (out_name->entry16 == nullptr) {
367 return false;
368 }
369 }
370 return true;
371}
372
373bool AssetManager2::GetResourceFlags(uint32_t resid, uint32_t* out_flags) {
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700374 FindEntryResult entry;
375 ApkAssetsCookie cookie =
376 FindEntry(resid, 0u /* density_override */, false /* stop_at_first_match */, &entry);
377 if (cookie != kInvalidCookie) {
378 *out_flags = entry.type_flags;
379 return cookie;
380 }
381 return kInvalidCookie;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700382}
383
384ApkAssetsCookie AssetManager2::GetResource(uint32_t resid, bool may_be_bag,
385 uint16_t density_override, Res_value* out_value,
386 ResTable_config* out_selected_config,
387 uint32_t* out_flags) {
388 ATRACE_CALL();
389
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700390 FindEntryResult entry;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700391 ApkAssetsCookie cookie =
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700392 FindEntry(resid, density_override, false /* stop_at_first_match */, &entry);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700393 if (cookie == kInvalidCookie) {
394 return kInvalidCookie;
395 }
396
397 if (dtohl(entry.entry->flags) & ResTable_entry::FLAG_COMPLEX) {
398 if (!may_be_bag) {
399 LOG(ERROR) << base::StringPrintf("Resource %08x is a complex map type.", resid);
Adam Lesinski0c405242017-01-13 20:47:26 -0800400 return kInvalidCookie;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700401 }
Adam Lesinski0c405242017-01-13 20:47:26 -0800402
403 // Create a reference since we can't represent this complex type as a Res_value.
404 out_value->dataType = Res_value::TYPE_REFERENCE;
405 out_value->data = resid;
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700406 *out_selected_config = *entry.config;
407 *out_flags = entry.type_flags;
Adam Lesinski0c405242017-01-13 20:47:26 -0800408 return cookie;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700409 }
410
411 const Res_value* device_value = reinterpret_cast<const Res_value*>(
412 reinterpret_cast<const uint8_t*>(entry.entry) + dtohs(entry.entry->size));
413 out_value->copyFrom_dtoh(*device_value);
Adam Lesinskida431a22016-12-29 16:08:16 -0500414
415 // Convert the package ID to the runtime assigned package ID.
416 entry.dynamic_ref_table->lookupResourceValue(out_value);
417
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700418 *out_selected_config = *entry.config;
419 *out_flags = entry.type_flags;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700420 return cookie;
421}
422
Adam Lesinski0c405242017-01-13 20:47:26 -0800423ApkAssetsCookie AssetManager2::ResolveReference(ApkAssetsCookie cookie, Res_value* in_out_value,
424 ResTable_config* in_out_selected_config,
425 uint32_t* in_out_flags,
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800426 uint32_t* out_last_reference) {
Adam Lesinski0c405242017-01-13 20:47:26 -0800427 ATRACE_CALL();
428 constexpr const int kMaxIterations = 20;
429
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800430 *out_last_reference = 0u;
Adam Lesinski0c405242017-01-13 20:47:26 -0800431 for (size_t iteration = 0u; in_out_value->dataType == Res_value::TYPE_REFERENCE &&
432 in_out_value->data != 0u && iteration < kMaxIterations;
433 iteration++) {
434 if (out_last_reference != nullptr) {
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800435 *out_last_reference = in_out_value->data;
Adam Lesinski0c405242017-01-13 20:47:26 -0800436 }
437 uint32_t new_flags = 0u;
438 cookie = GetResource(in_out_value->data, true /*may_be_bag*/, 0u /*density_override*/,
439 in_out_value, in_out_selected_config, &new_flags);
440 if (cookie == kInvalidCookie) {
441 return kInvalidCookie;
442 }
443 if (in_out_flags != nullptr) {
444 *in_out_flags |= new_flags;
445 }
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800446 if (*out_last_reference == in_out_value->data) {
Adam Lesinski0c405242017-01-13 20:47:26 -0800447 // This reference can't be resolved, so exit now and let the caller deal with it.
448 return cookie;
449 }
450 }
451 return cookie;
452}
453
Adam Lesinski7ad11102016-10-28 16:39:15 -0700454const ResolvedBag* AssetManager2::GetBag(uint32_t resid) {
455 ATRACE_CALL();
456
457 auto cached_iter = cached_bags_.find(resid);
458 if (cached_iter != cached_bags_.end()) {
459 return cached_iter->second.get();
460 }
461
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700462 FindEntryResult entry;
463 ApkAssetsCookie cookie =
464 FindEntry(resid, 0u /* density_override */, false /* stop_at_first_match */, &entry);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700465 if (cookie == kInvalidCookie) {
466 return nullptr;
467 }
468
469 // Check that the size of the entry header is at least as big as
470 // the desired ResTable_map_entry. Also verify that the entry
471 // was intended to be a map.
472 if (dtohs(entry.entry->size) < sizeof(ResTable_map_entry) ||
473 (dtohs(entry.entry->flags) & ResTable_entry::FLAG_COMPLEX) == 0) {
474 // Not a bag, nothing to do.
475 return nullptr;
476 }
477
478 const ResTable_map_entry* map = reinterpret_cast<const ResTable_map_entry*>(entry.entry);
479 const ResTable_map* map_entry =
480 reinterpret_cast<const ResTable_map*>(reinterpret_cast<const uint8_t*>(map) + map->size);
481 const ResTable_map* const map_entry_end = map_entry + dtohl(map->count);
482
Adam Lesinskida431a22016-12-29 16:08:16 -0500483 uint32_t parent_resid = dtohl(map->parent.ident);
484 if (parent_resid == 0) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700485 // There is no parent, meaning there is nothing to inherit and we can do a simple
486 // copy of the entries in the map.
487 const size_t entry_count = map_entry_end - map_entry;
488 util::unique_cptr<ResolvedBag> new_bag{reinterpret_cast<ResolvedBag*>(
489 malloc(sizeof(ResolvedBag) + (entry_count * sizeof(ResolvedBag::Entry))))};
490 ResolvedBag::Entry* new_entry = new_bag->entries;
491 for (; map_entry != map_entry_end; ++map_entry) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500492 uint32_t new_key = dtohl(map_entry->name.ident);
Adam Lesinski929d6512017-01-16 19:11:19 -0800493 if (!is_internal_resid(new_key)) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500494 // Attributes, arrays, etc don't have a resource id as the name. They specify
495 // other data, which would be wrong to change via a lookup.
496 if (entry.dynamic_ref_table->lookupResourceId(&new_key) != NO_ERROR) {
497 LOG(ERROR) << base::StringPrintf("Failed to resolve key 0x%08x in bag 0x%08x.", new_key, resid);
498 return nullptr;
499 }
500 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700501 new_entry->cookie = cookie;
Adam Lesinskida431a22016-12-29 16:08:16 -0500502 new_entry->key = new_key;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700503 new_entry->key_pool = nullptr;
504 new_entry->type_pool = nullptr;
Adam Lesinski30080e22017-10-16 16:18:09 -0700505 new_entry->value.copyFrom_dtoh(map_entry->value);
506 status_t err = entry.dynamic_ref_table->lookupResourceValue(&new_entry->value);
507 if (err != NO_ERROR) {
508 LOG(ERROR) << base::StringPrintf(
509 "Failed to resolve value t=0x%02x d=0x%08x for key 0x%08x.", new_entry->value.dataType,
510 new_entry->value.data, new_key);
511 return nullptr;
512 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700513 ++new_entry;
514 }
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700515 new_bag->type_spec_flags = entry.type_flags;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700516 new_bag->entry_count = static_cast<uint32_t>(entry_count);
517 ResolvedBag* result = new_bag.get();
518 cached_bags_[resid] = std::move(new_bag);
519 return result;
520 }
521
Adam Lesinskida431a22016-12-29 16:08:16 -0500522 // In case the parent is a dynamic reference, resolve it.
523 entry.dynamic_ref_table->lookupResourceId(&parent_resid);
524
Adam Lesinski7ad11102016-10-28 16:39:15 -0700525 // Get the parent and do a merge of the keys.
Adam Lesinskida431a22016-12-29 16:08:16 -0500526 const ResolvedBag* parent_bag = GetBag(parent_resid);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700527 if (parent_bag == nullptr) {
528 // Failed to get the parent that should exist.
Adam Lesinskida431a22016-12-29 16:08:16 -0500529 LOG(ERROR) << base::StringPrintf("Failed to find parent 0x%08x of bag 0x%08x.", parent_resid, resid);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700530 return nullptr;
531 }
532
Adam Lesinski7ad11102016-10-28 16:39:15 -0700533 // Create the max possible entries we can make. Once we construct the bag,
534 // we will realloc to fit to size.
535 const size_t max_count = parent_bag->entry_count + dtohl(map->count);
George Burgess IV09b119f2017-07-25 15:00:04 -0700536 util::unique_cptr<ResolvedBag> new_bag{reinterpret_cast<ResolvedBag*>(
537 malloc(sizeof(ResolvedBag) + (max_count * sizeof(ResolvedBag::Entry))))};
Adam Lesinski7ad11102016-10-28 16:39:15 -0700538 ResolvedBag::Entry* new_entry = new_bag->entries;
539
540 const ResolvedBag::Entry* parent_entry = parent_bag->entries;
541 const ResolvedBag::Entry* const parent_entry_end = parent_entry + parent_bag->entry_count;
542
543 // The keys are expected to be in sorted order. Merge the two bags.
544 while (map_entry != map_entry_end && parent_entry != parent_entry_end) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500545 uint32_t child_key = dtohl(map_entry->name.ident);
Adam Lesinski929d6512017-01-16 19:11:19 -0800546 if (!is_internal_resid(child_key)) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500547 if (entry.dynamic_ref_table->lookupResourceId(&child_key) != NO_ERROR) {
548 LOG(ERROR) << base::StringPrintf("Failed to resolve key 0x%08x in bag 0x%08x.", child_key, resid);
549 return nullptr;
550 }
551 }
552
Adam Lesinski7ad11102016-10-28 16:39:15 -0700553 if (child_key <= parent_entry->key) {
554 // Use the child key if it comes before the parent
555 // or is equal to the parent (overrides).
556 new_entry->cookie = cookie;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700557 new_entry->key = child_key;
558 new_entry->key_pool = nullptr;
559 new_entry->type_pool = nullptr;
Adam Lesinski30080e22017-10-16 16:18:09 -0700560 new_entry->value.copyFrom_dtoh(map_entry->value);
561 status_t err = entry.dynamic_ref_table->lookupResourceValue(&new_entry->value);
562 if (err != NO_ERROR) {
563 LOG(ERROR) << base::StringPrintf(
564 "Failed to resolve value t=0x%02x d=0x%08x for key 0x%08x.", new_entry->value.dataType,
565 new_entry->value.data, child_key);
566 return nullptr;
567 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700568 ++map_entry;
569 } else {
570 // Take the parent entry as-is.
571 memcpy(new_entry, parent_entry, sizeof(*new_entry));
572 }
573
574 if (child_key >= parent_entry->key) {
575 // Move to the next parent entry if we used it or it was overridden.
576 ++parent_entry;
577 }
578 // Increment to the next entry to fill.
579 ++new_entry;
580 }
581
582 // Finish the child entries if they exist.
583 while (map_entry != map_entry_end) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500584 uint32_t new_key = dtohl(map_entry->name.ident);
Adam Lesinski929d6512017-01-16 19:11:19 -0800585 if (!is_internal_resid(new_key)) {
Adam Lesinskida431a22016-12-29 16:08:16 -0500586 if (entry.dynamic_ref_table->lookupResourceId(&new_key) != NO_ERROR) {
587 LOG(ERROR) << base::StringPrintf("Failed to resolve key 0x%08x in bag 0x%08x.", new_key, resid);
588 return nullptr;
589 }
590 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700591 new_entry->cookie = cookie;
Adam Lesinskida431a22016-12-29 16:08:16 -0500592 new_entry->key = new_key;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700593 new_entry->key_pool = nullptr;
594 new_entry->type_pool = nullptr;
Adam Lesinski30080e22017-10-16 16:18:09 -0700595 new_entry->value.copyFrom_dtoh(map_entry->value);
596 status_t err = entry.dynamic_ref_table->lookupResourceValue(&new_entry->value);
597 if (err != NO_ERROR) {
598 LOG(ERROR) << base::StringPrintf("Failed to resolve value t=0x%02x d=0x%08x for key 0x%08x.",
599 new_entry->value.dataType, new_entry->value.data, new_key);
600 return nullptr;
601 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700602 ++map_entry;
603 ++new_entry;
604 }
605
606 // Finish the parent entries if they exist.
607 if (parent_entry != parent_entry_end) {
608 // Take the rest of the parent entries as-is.
609 const size_t num_entries_to_copy = parent_entry_end - parent_entry;
610 memcpy(new_entry, parent_entry, num_entries_to_copy * sizeof(*new_entry));
611 new_entry += num_entries_to_copy;
612 }
613
614 // Resize the resulting array to fit.
615 const size_t actual_count = new_entry - new_bag->entries;
616 if (actual_count != max_count) {
George Burgess IV09b119f2017-07-25 15:00:04 -0700617 new_bag.reset(reinterpret_cast<ResolvedBag*>(realloc(
618 new_bag.release(), sizeof(ResolvedBag) + (actual_count * sizeof(ResolvedBag::Entry)))));
Adam Lesinski7ad11102016-10-28 16:39:15 -0700619 }
620
Adam Lesinski1a1e9c22017-10-13 15:45:34 -0700621 // Combine flags from the parent and our own bag.
622 new_bag->type_spec_flags = entry.type_flags | parent_bag->type_spec_flags;
George Burgess IV09b119f2017-07-25 15:00:04 -0700623 new_bag->entry_count = static_cast<uint32_t>(actual_count);
624 ResolvedBag* result = new_bag.get();
625 cached_bags_[resid] = std::move(new_bag);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700626 return result;
627}
628
Adam Lesinski929d6512017-01-16 19:11:19 -0800629static bool Utf8ToUtf16(const StringPiece& str, std::u16string* out) {
630 ssize_t len =
631 utf8_to_utf16_length(reinterpret_cast<const uint8_t*>(str.data()), str.size(), false);
632 if (len < 0) {
633 return false;
634 }
635 out->resize(static_cast<size_t>(len));
636 utf8_to_utf16(reinterpret_cast<const uint8_t*>(str.data()), str.size(), &*out->begin(),
637 static_cast<size_t>(len + 1));
638 return true;
639}
640
Adam Lesinski0c405242017-01-13 20:47:26 -0800641uint32_t AssetManager2::GetResourceId(const std::string& resource_name,
642 const std::string& fallback_type,
643 const std::string& fallback_package) {
Adam Lesinski929d6512017-01-16 19:11:19 -0800644 StringPiece package_name, type, entry;
645 if (!ExtractResourceName(resource_name, &package_name, &type, &entry)) {
646 return 0u;
647 }
648
649 if (entry.empty()) {
650 return 0u;
651 }
652
653 if (package_name.empty()) {
654 package_name = fallback_package;
655 }
656
657 if (type.empty()) {
658 type = fallback_type;
659 }
660
661 std::u16string type16;
662 if (!Utf8ToUtf16(type, &type16)) {
663 return 0u;
664 }
665
666 std::u16string entry16;
667 if (!Utf8ToUtf16(entry, &entry16)) {
668 return 0u;
669 }
670
671 const StringPiece16 kAttr16 = u"attr";
672 const static std::u16string kAttrPrivate16 = u"^attr-private";
673
674 for (const PackageGroup& package_group : package_groups_) {
675 for (const LoadedPackage* package : package_group.packages_) {
676 if (package_name != package->GetPackageName()) {
677 // All packages in the same group are expected to have the same package name.
678 break;
679 }
680
681 uint32_t resid = package->FindEntryByName(type16, entry16);
682 if (resid == 0u && kAttr16 == type16) {
683 // Private attributes in libraries (such as the framework) are sometimes encoded
684 // under the type '^attr-private' in order to leave the ID space of public 'attr'
685 // free for future additions. Check '^attr-private' for the same name.
686 resid = package->FindEntryByName(kAttrPrivate16, entry16);
687 }
688
689 if (resid != 0u) {
690 return fix_package_id(resid, package_group.dynamic_ref_table.mAssignedPackageId);
691 }
692 }
693 }
Adam Lesinski0c405242017-01-13 20:47:26 -0800694 return 0u;
695}
696
Adam Lesinski7ad11102016-10-28 16:39:15 -0700697void AssetManager2::InvalidateCaches(uint32_t diff) {
698 if (diff == 0xffffffffu) {
699 // Everything must go.
700 cached_bags_.clear();
701 return;
702 }
703
704 // Be more conservative with what gets purged. Only if the bag has other possible
705 // variations with respect to what changed (diff) should we remove it.
706 for (auto iter = cached_bags_.cbegin(); iter != cached_bags_.cend();) {
707 if (diff & iter->second->type_spec_flags) {
708 iter = cached_bags_.erase(iter);
709 } else {
710 ++iter;
711 }
712 }
713}
714
Adam Lesinski30080e22017-10-16 16:18:09 -0700715std::unique_ptr<Theme> AssetManager2::NewTheme() {
716 return std::unique_ptr<Theme>(new Theme(this));
717}
718
719Theme::Theme(AssetManager2* asset_manager) : asset_manager_(asset_manager) {
720}
721
722Theme::~Theme() = default;
723
724namespace {
725
726struct ThemeEntry {
727 ApkAssetsCookie cookie;
728 uint32_t type_spec_flags;
729 Res_value value;
730};
731
732struct ThemeType {
733 int entry_count;
734 ThemeEntry entries[0];
735};
736
737constexpr size_t kTypeCount = std::numeric_limits<uint8_t>::max() + 1;
738
739} // namespace
740
741struct Theme::Package {
742 // Each element of Type will be a dynamically sized object
743 // allocated to have the entries stored contiguously with the Type.
744 std::array<util::unique_cptr<ThemeType>, kTypeCount> types;
745};
Adam Lesinski7ad11102016-10-28 16:39:15 -0700746
747bool Theme::ApplyStyle(uint32_t resid, bool force) {
748 ATRACE_CALL();
749
750 const ResolvedBag* bag = asset_manager_->GetBag(resid);
751 if (bag == nullptr) {
752 return false;
753 }
754
755 // Merge the flags from this style.
756 type_spec_flags_ |= bag->type_spec_flags;
757
Adam Lesinski30080e22017-10-16 16:18:09 -0700758 int last_type_idx = -1;
759 int last_package_idx = -1;
760 Package* last_package = nullptr;
761 ThemeType* last_type = nullptr;
762
763 // Iterate backwards, because each bag is sorted in ascending key ID order, meaning we will only
764 // need to perform one resize per type.
765 using reverse_bag_iterator = std::reverse_iterator<const ResolvedBag::Entry*>;
766 const auto bag_iter_end = reverse_bag_iterator(begin(bag));
767 for (auto bag_iter = reverse_bag_iterator(end(bag)); bag_iter != bag_iter_end; ++bag_iter) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700768 const uint32_t attr_resid = bag_iter->key;
769
Adam Lesinski30080e22017-10-16 16:18:09 -0700770 // If the resource ID passed in is not a style, the key can be some other identifier that is not
771 // a resource ID. We should fail fast instead of operating with strange resource IDs.
Adam Lesinski929d6512017-01-16 19:11:19 -0800772 if (!is_valid_resid(attr_resid)) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700773 return false;
774 }
775
Adam Lesinski30080e22017-10-16 16:18:09 -0700776 // We don't use the 0-based index for the type so that we can avoid doing ID validation
777 // upon lookup. Instead, we keep space for the type ID 0 in our data structures. Since
778 // the construction of this type is guarded with a resource ID check, it will never be
779 // populated, and querying type ID 0 will always fail.
780 const int package_idx = get_package_id(attr_resid);
781 const int type_idx = get_type_id(attr_resid);
782 const int entry_idx = get_entry_id(attr_resid);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700783
Adam Lesinski30080e22017-10-16 16:18:09 -0700784 if (last_package_idx != package_idx) {
785 std::unique_ptr<Package>& package = packages_[package_idx];
786 if (package == nullptr) {
787 package.reset(new Package());
Adam Lesinski7ad11102016-10-28 16:39:15 -0700788 }
Adam Lesinski30080e22017-10-16 16:18:09 -0700789 last_package_idx = package_idx;
790 last_package = package.get();
791 last_type_idx = -1;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700792 }
Adam Lesinski30080e22017-10-16 16:18:09 -0700793
794 if (last_type_idx != type_idx) {
795 util::unique_cptr<ThemeType>& type = last_package->types[type_idx];
796 if (type == nullptr) {
797 // Allocate enough memory to contain this entry_idx. Since we're iterating in reverse over
798 // a sorted list of attributes, this shouldn't be resized again during this method call.
799 type.reset(reinterpret_cast<ThemeType*>(
800 calloc(sizeof(ThemeType) + (entry_idx + 1) * sizeof(ThemeEntry), 1)));
801 type->entry_count = entry_idx + 1;
802 } else if (entry_idx >= type->entry_count) {
803 // Reallocate the memory to contain this entry_idx. Since we're iterating in reverse over
804 // a sorted list of attributes, this shouldn't be resized again during this method call.
805 const int new_count = entry_idx + 1;
806 type.reset(reinterpret_cast<ThemeType*>(
807 realloc(type.release(), sizeof(ThemeType) + (new_count * sizeof(ThemeEntry)))));
808
809 // Clear out the newly allocated space (which isn't zeroed).
810 memset(type->entries + type->entry_count, 0,
811 (new_count - type->entry_count) * sizeof(ThemeEntry));
812 type->entry_count = new_count;
813 }
814 last_type_idx = type_idx;
815 last_type = type.get();
816 }
817
818 ThemeEntry& entry = last_type->entries[entry_idx];
819 if (force || (entry.value.dataType == Res_value::TYPE_NULL &&
820 entry.value.data != Res_value::DATA_NULL_EMPTY)) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700821 entry.cookie = bag_iter->cookie;
822 entry.type_spec_flags |= bag->type_spec_flags;
823 entry.value = bag_iter->value;
824 }
825 }
826 return true;
827}
828
829ApkAssetsCookie Theme::GetAttribute(uint32_t resid, Res_value* out_value,
830 uint32_t* out_flags) const {
Adam Lesinski30080e22017-10-16 16:18:09 -0700831 int cnt = 20;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700832
833 uint32_t type_spec_flags = 0u;
834
Adam Lesinski30080e22017-10-16 16:18:09 -0700835 do {
836 const int package_idx = get_package_id(resid);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700837 const Package* package = packages_[package_idx].get();
Adam Lesinski30080e22017-10-16 16:18:09 -0700838 if (package != nullptr) {
839 // The themes are constructed with a 1-based type ID, so no need to decrement here.
840 const int type_idx = get_type_id(resid);
841 const ThemeType* type = package->types[type_idx].get();
842 if (type != nullptr) {
843 const int entry_idx = get_entry_id(resid);
844 if (entry_idx < type->entry_count) {
845 const ThemeEntry& entry = type->entries[entry_idx];
846 type_spec_flags |= entry.type_spec_flags;
Adam Lesinski7ad11102016-10-28 16:39:15 -0700847
Adam Lesinski30080e22017-10-16 16:18:09 -0700848 if (entry.value.dataType == Res_value::TYPE_ATTRIBUTE) {
849 if (cnt > 0) {
850 cnt--;
851 resid = entry.value.data;
852 continue;
853 }
854 return kInvalidCookie;
855 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700856
Adam Lesinski30080e22017-10-16 16:18:09 -0700857 // @null is different than @empty.
858 if (entry.value.dataType == Res_value::TYPE_NULL &&
859 entry.value.data != Res_value::DATA_NULL_EMPTY) {
860 return kInvalidCookie;
861 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700862
Adam Lesinski30080e22017-10-16 16:18:09 -0700863 *out_value = entry.value;
Adam Lesinskida431a22016-12-29 16:08:16 -0500864 *out_flags = type_spec_flags;
Adam Lesinski30080e22017-10-16 16:18:09 -0700865 return entry.cookie;
Adam Lesinskida431a22016-12-29 16:08:16 -0500866 }
Adam Lesinskida431a22016-12-29 16:08:16 -0500867 }
Adam Lesinski7ad11102016-10-28 16:39:15 -0700868 }
Adam Lesinski30080e22017-10-16 16:18:09 -0700869 break;
870 } while (true);
Adam Lesinski7ad11102016-10-28 16:39:15 -0700871 return kInvalidCookie;
872}
873
Adam Lesinskid1ecd7a2017-01-23 12:58:11 -0800874ApkAssetsCookie Theme::ResolveAttributeReference(ApkAssetsCookie cookie, Res_value* in_out_value,
875 ResTable_config* in_out_selected_config,
876 uint32_t* in_out_type_spec_flags,
877 uint32_t* out_last_ref) {
878 if (in_out_value->dataType == Res_value::TYPE_ATTRIBUTE) {
879 uint32_t new_flags;
880 cookie = GetAttribute(in_out_value->data, in_out_value, &new_flags);
881 if (cookie == kInvalidCookie) {
882 return kInvalidCookie;
883 }
884
885 if (in_out_type_spec_flags != nullptr) {
886 *in_out_type_spec_flags |= new_flags;
887 }
888 }
889 return asset_manager_->ResolveReference(cookie, in_out_value, in_out_selected_config,
890 in_out_type_spec_flags, out_last_ref);
891}
892
Adam Lesinski7ad11102016-10-28 16:39:15 -0700893void Theme::Clear() {
894 type_spec_flags_ = 0u;
895 for (std::unique_ptr<Package>& package : packages_) {
896 package.reset();
897 }
898}
899
900bool Theme::SetTo(const Theme& o) {
901 if (this == &o) {
902 return true;
903 }
904
Adam Lesinski7ad11102016-10-28 16:39:15 -0700905 type_spec_flags_ = o.type_spec_flags_;
906
Adam Lesinski03ebac82017-09-25 13:10:14 -0700907 const bool copy_only_system = asset_manager_ != o.asset_manager_;
908
Adam Lesinskida431a22016-12-29 16:08:16 -0500909 for (size_t p = 0; p < packages_.size(); p++) {
Adam Lesinski7ad11102016-10-28 16:39:15 -0700910 const Package* package = o.packages_[p].get();
Adam Lesinski03ebac82017-09-25 13:10:14 -0700911 if (package == nullptr || (copy_only_system && p != 0x01)) {
912 // The other theme doesn't have this package, clear ours.
Adam Lesinski7ad11102016-10-28 16:39:15 -0700913 packages_[p].reset();
914 continue;
915 }
916
Adam Lesinski03ebac82017-09-25 13:10:14 -0700917 if (packages_[p] == nullptr) {
918 // The other theme has this package, but we don't. Make one.
919 packages_[p].reset(new Package());
920 }
921
Adam Lesinskida431a22016-12-29 16:08:16 -0500922 for (size_t t = 0; t < package->types.size(); t++) {
Adam Lesinski30080e22017-10-16 16:18:09 -0700923 const ThemeType* type = package->types[t].get();
Adam Lesinski7ad11102016-10-28 16:39:15 -0700924 if (type == nullptr) {
Adam Lesinski03ebac82017-09-25 13:10:14 -0700925 // The other theme doesn't have this type, clear ours.
Adam Lesinski7ad11102016-10-28 16:39:15 -0700926 packages_[p]->types[t].reset();
927 continue;
928 }
929
Adam Lesinski03ebac82017-09-25 13:10:14 -0700930 // Create a new type and update it to theirs.
Adam Lesinski30080e22017-10-16 16:18:09 -0700931 const size_t type_alloc_size = sizeof(ThemeType) + (type->entry_count * sizeof(ThemeEntry));
Adam Lesinski7ad11102016-10-28 16:39:15 -0700932 void* copied_data = malloc(type_alloc_size);
933 memcpy(copied_data, type, type_alloc_size);
Adam Lesinski30080e22017-10-16 16:18:09 -0700934 packages_[p]->types[t].reset(reinterpret_cast<ThemeType*>(copied_data));
Adam Lesinski7ad11102016-10-28 16:39:15 -0700935 }
936 }
937 return true;
938}
939
940} // namespace android