1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
|
/*
* Copyright (C) 2017 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include <memory>
#include <vector>
#include "android-base/stringprintf.h"
#include "androidfw/StringPiece.h"
#include "Diagnostics.h"
#include "Flags.h"
#include "LoadedApk.h"
#include "ResourceUtils.h"
#include "SdkConstants.h"
#include "ValueVisitor.h"
#include "cmd/Util.h"
#include "configuration/ConfigurationParser.h"
#include "filter/AbiFilter.h"
#include "flatten/TableFlattener.h"
#include "flatten/XmlFlattener.h"
#include "io/BigBufferInputStream.h"
#include "io/Util.h"
#include "optimize/ResourceDeduper.h"
#include "optimize/VersionCollapser.h"
#include "split/TableSplitter.h"
#include "util/Files.h"
using ::aapt::configuration::Abi;
using ::aapt::configuration::Artifact;
using ::aapt::configuration::PostProcessingConfiguration;
using ::android::StringPiece;
using ::android::base::StringPrintf;
namespace aapt {
struct OptimizeOptions {
// Path to the output APK.
Maybe<std::string> output_path;
// Path to the output APK directory for splits.
Maybe<std::string> output_dir;
// Details of the app extracted from the AndroidManifest.xml
AppInfo app_info;
// Split APK options.
TableSplitterOptions table_splitter_options;
// List of output split paths. These are in the same order as `split_constraints`.
std::vector<std::string> split_paths;
// List of SplitConstraints governing what resources go into each split. Ordered by `split_paths`.
std::vector<SplitConstraints> split_constraints;
TableFlattenerOptions table_flattener_options;
Maybe<PostProcessingConfiguration> configuration;
};
class OptimizeContext : public IAaptContext {
public:
OptimizeContext() = default;
PackageType GetPackageType() override {
// Not important here. Using anything other than kApp adds EXTRA validation, which we want to
// avoid.
return PackageType::kApp;
}
IDiagnostics* GetDiagnostics() override {
return &diagnostics_;
}
NameMangler* GetNameMangler() override {
UNIMPLEMENTED(FATAL);
return nullptr;
}
const std::string& GetCompilationPackage() override {
static std::string empty;
return empty;
}
uint8_t GetPackageId() override {
return 0;
}
SymbolTable* GetExternalSymbols() override {
UNIMPLEMENTED(FATAL);
return nullptr;
}
bool IsVerbose() override {
return verbose_;
}
void SetVerbose(bool val) {
verbose_ = val;
}
void SetMinSdkVersion(int sdk_version) {
sdk_version_ = sdk_version;
}
int GetMinSdkVersion() override {
return sdk_version_;
}
private:
DISALLOW_COPY_AND_ASSIGN(OptimizeContext);
StdErrDiagnostics diagnostics_;
bool verbose_ = false;
int sdk_version_ = 0;
};
class OptimizeCommand {
public:
OptimizeCommand(OptimizeContext* context, const OptimizeOptions& options)
: options_(options), context_(context) {
}
int Run(std::unique_ptr<LoadedApk> apk) {
if (context_->IsVerbose()) {
context_->GetDiagnostics()->Note(DiagMessage() << "Optimizing APK...");
}
VersionCollapser collapser;
if (!collapser.Consume(context_, apk->GetResourceTable())) {
return 1;
}
ResourceDeduper deduper;
if (!deduper.Consume(context_, apk->GetResourceTable())) {
context_->GetDiagnostics()->Error(DiagMessage() << "failed deduping resources");
return 1;
}
// Adjust the SplitConstraints so that their SDK version is stripped if it is less than or
// equal to the minSdk.
options_.split_constraints =
AdjustSplitConstraintsForMinSdk(context_->GetMinSdkVersion(), options_.split_constraints);
// Stripping the APK using the TableSplitter. The resource table is modified in place in the
// LoadedApk.
TableSplitter splitter(options_.split_constraints, options_.table_splitter_options);
if (!splitter.VerifySplitConstraints(context_)) {
return 1;
}
splitter.SplitTable(apk->GetResourceTable());
auto path_iter = options_.split_paths.begin();
auto split_constraints_iter = options_.split_constraints.begin();
for (std::unique_ptr<ResourceTable>& split_table : splitter.splits()) {
if (context_->IsVerbose()) {
context_->GetDiagnostics()->Note(
DiagMessage(*path_iter) << "generating split with configurations '"
<< util::Joiner(split_constraints_iter->configs, ", ") << "'");
}
// Generate an AndroidManifest.xml for each split.
std::unique_ptr<xml::XmlResource> split_manifest =
GenerateSplitManifest(options_.app_info, *split_constraints_iter);
std::unique_ptr<IArchiveWriter> split_writer =
CreateZipFileArchiveWriter(context_->GetDiagnostics(), *path_iter);
if (!split_writer) {
return 1;
}
if (!WriteSplitApk(split_table.get(), split_manifest.get(), split_writer.get())) {
return 1;
}
++path_iter;
++split_constraints_iter;
}
if (options_.configuration && options_.output_dir) {
PostProcessingConfiguration& config = options_.configuration.value();
// For now, just write out the stripped APK since ABI splitting doesn't modify anything else.
for (const Artifact& artifact : config.artifacts) {
if (artifact.abi_group) {
const std::string& group = artifact.abi_group.value();
auto abi_group = config.abi_groups.find(group);
// TODO: Remove validation when configuration parser ensures referential integrity.
if (abi_group == config.abi_groups.end()) {
context_->GetDiagnostics()->Note(
DiagMessage() << "could not find referenced ABI group '" << group << "'");
return 1;
}
FilterChain filters;
filters.AddFilter(AbiFilter::FromAbiList(abi_group->second));
const std::string& path = apk->GetSource().path;
const StringPiece ext = file::GetExtension(path);
const std::string name = path.substr(0, path.rfind(ext.to_string()));
// Name is hard coded for now since only one split dimension is supported.
// TODO: Incorporate name generation into the configuration objects.
const std::string file_name =
StringPrintf("%s.%s%s", name.c_str(), group.c_str(), ext.data());
std::string out = options_.output_dir.value();
file::AppendPath(&out, file_name);
std::unique_ptr<IArchiveWriter> writer =
CreateZipFileArchiveWriter(context_->GetDiagnostics(), out);
if (!apk->WriteToArchive(context_, options_.table_flattener_options, &filters,
writer.get())) {
return 1;
}
}
}
}
if (options_.output_path) {
std::unique_ptr<IArchiveWriter> writer =
CreateZipFileArchiveWriter(context_->GetDiagnostics(), options_.output_path.value());
if (!apk->WriteToArchive(context_, options_.table_flattener_options, writer.get())) {
return 1;
}
}
return 0;
}
private:
bool WriteSplitApk(ResourceTable* table, xml::XmlResource* manifest, IArchiveWriter* writer) {
BigBuffer manifest_buffer(4096);
XmlFlattener xml_flattener(&manifest_buffer, {});
if (!xml_flattener.Consume(context_, manifest)) {
return false;
}
io::BigBufferInputStream manifest_buffer_in(&manifest_buffer);
if (!io::CopyInputStreamToArchive(context_, &manifest_buffer_in, "AndroidManifest.xml",
ArchiveEntry::kCompress, writer)) {
return false;
}
std::map<std::pair<ConfigDescription, StringPiece>, FileReference*> config_sorted_files;
for (auto& pkg : table->packages) {
for (auto& type : pkg->types) {
// Sort by config and name, so that we get better locality in the zip file.
config_sorted_files.clear();
for (auto& entry : type->entries) {
for (auto& config_value : entry->values) {
FileReference* file_ref = ValueCast<FileReference>(config_value->value.get());
if (file_ref == nullptr) {
continue;
}
if (file_ref->file == nullptr) {
ResourceNameRef name(pkg->name, type->type, entry->name);
context_->GetDiagnostics()->Warn(DiagMessage(file_ref->GetSource())
<< "file for resource " << name << " with config '"
<< config_value->config << "' not found");
continue;
}
const StringPiece entry_name = entry->name;
config_sorted_files[std::make_pair(config_value->config, entry_name)] = file_ref;
}
}
for (auto& entry : config_sorted_files) {
FileReference* file_ref = entry.second;
uint32_t compression_flags =
file_ref->file->WasCompressed() ? ArchiveEntry::kCompress : 0u;
if (!io::CopyFileToArchive(context_, file_ref->file, *file_ref->path, compression_flags,
writer)) {
return false;
}
}
}
}
BigBuffer table_buffer(4096);
TableFlattener table_flattener(options_.table_flattener_options, &table_buffer);
if (!table_flattener.Consume(context_, table)) {
return false;
}
io::BigBufferInputStream table_buffer_in(&table_buffer);
if (!io::CopyInputStreamToArchive(context_, &table_buffer_in, "resources.arsc",
ArchiveEntry::kAlign, writer)) {
return false;
}
return true;
}
OptimizeOptions options_;
OptimizeContext* context_;
};
bool ExtractAppDataFromManifest(OptimizeContext* context, LoadedApk* apk,
OptimizeOptions* out_options) {
io::IFile* manifest_file = apk->GetFileCollection()->FindFile("AndroidManifest.xml");
if (manifest_file == nullptr) {
context->GetDiagnostics()->Error(DiagMessage(apk->GetSource())
<< "missing AndroidManifest.xml");
return false;
}
std::unique_ptr<io::IData> data = manifest_file->OpenAsData();
if (data == nullptr) {
context->GetDiagnostics()->Error(DiagMessage(manifest_file->GetSource())
<< "failed to open file");
return false;
}
std::unique_ptr<xml::XmlResource> manifest = xml::Inflate(
data->data(), data->size(), context->GetDiagnostics(), manifest_file->GetSource());
if (manifest == nullptr) {
context->GetDiagnostics()->Error(DiagMessage() << "failed to read binary AndroidManifest.xml");
return false;
}
Maybe<AppInfo> app_info =
ExtractAppInfoFromBinaryManifest(manifest.get(), context->GetDiagnostics());
if (!app_info) {
context->GetDiagnostics()->Error(DiagMessage()
<< "failed to extract data from AndroidManifest.xml");
return false;
}
out_options->app_info = std::move(app_info.value());
context->SetMinSdkVersion(out_options->app_info.min_sdk_version.value_or_default(0));
return true;
}
int Optimize(const std::vector<StringPiece>& args) {
OptimizeContext context;
OptimizeOptions options;
Maybe<std::string> config_path;
Maybe<std::string> target_densities;
std::vector<std::string> configs;
std::vector<std::string> split_args;
bool verbose = false;
Flags flags =
Flags()
.OptionalFlag("-o", "Path to the output APK.", &options.output_path)
.OptionalFlag("-d", "Path to the output directory (for splits).", &options.output_dir)
.OptionalFlag("-x", "Path to XML configuration file.", &config_path)
.OptionalFlag(
"--target-densities",
"Comma separated list of the screen densities that the APK will be optimized for.\n"
"All the resources that would be unused on devices of the given densities will be \n"
"removed from the APK.",
&target_densities)
.OptionalFlagList("-c",
"Comma separated list of configurations to include. The default\n"
"is all configurations.",
&configs)
.OptionalFlagList("--split",
"Split resources matching a set of configs out to a "
"Split APK.\nSyntax: path/to/output.apk;<config>[,<config>[...]].\n"
"On Windows, use a semicolon ';' separator instead.",
&split_args)
.OptionalSwitch("--enable-sparse-encoding",
"Enables encoding sparse entries using a binary search tree.\n"
"This decreases APK size at the cost of resource retrieval performance.",
&options.table_flattener_options.use_sparse_entries)
.OptionalSwitch("-v", "Enables verbose logging", &verbose);
if (!flags.Parse("aapt2 optimize", args, &std::cerr)) {
return 1;
}
if (flags.GetArgs().size() != 1u) {
std::cerr << "must have one APK as argument.\n\n";
flags.Usage("aapt2 optimize", &std::cerr);
return 1;
}
std::unique_ptr<LoadedApk> apk = LoadedApk::LoadApkFromPath(&context, flags.GetArgs()[0]);
if (!apk) {
return 1;
}
context.SetVerbose(verbose);
if (target_densities) {
// Parse the target screen densities.
for (const StringPiece& config_str : util::Tokenize(target_densities.value(), ',')) {
Maybe<uint16_t> target_density =
ParseTargetDensityParameter(config_str, context.GetDiagnostics());
if (!target_density) {
return 1;
}
options.table_splitter_options.preferred_densities.push_back(target_density.value());
}
}
std::unique_ptr<IConfigFilter> filter;
if (!configs.empty()) {
filter = ParseConfigFilterParameters(configs, context.GetDiagnostics());
if (filter == nullptr) {
return 1;
}
options.table_splitter_options.config_filter = filter.get();
}
// Parse the split parameters.
for (const std::string& split_arg : split_args) {
options.split_paths.push_back({});
options.split_constraints.push_back({});
if (!ParseSplitParameter(split_arg, context.GetDiagnostics(), &options.split_paths.back(),
&options.split_constraints.back())) {
return 1;
}
}
if (config_path) {
if (!options.output_dir) {
context.GetDiagnostics()->Error(
DiagMessage() << "Output directory is required when using a configuration file");
return 1;
}
std::string& path = config_path.value();
Maybe<ConfigurationParser> for_path = ConfigurationParser::ForPath(path);
if (for_path) {
options.configuration = for_path.value().WithDiagnostics(context.GetDiagnostics()).Parse();
} else {
context.GetDiagnostics()->Error(DiagMessage() << "Could not parse config file " << path);
return 1;
}
}
if (!ExtractAppDataFromManifest(&context, apk.get(), &options)) {
return 1;
}
OptimizeCommand cmd(&context, options);
return cmd.Run(std::move(apk));
}
} // namespace aapt
|