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
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/optimization_guide/core/delivery/prediction_model_override.h"
#include <initializer_list>
#include <sstream>
#include "base/base64.h"
#include "base/command_line.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/functional/callback_helpers.h"
#include "base/strings/string_split.h"
#include "base/strings/string_util.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/thread_pool.h"
#include "components/optimization_guide/core/delivery/model_util.h"
#include "components/optimization_guide/core/delivery/prediction_model_download_manager.h"
#include "components/optimization_guide/core/optimization_guide_switches.h"
#include "components/optimization_guide/proto/models.pb.h"
#include "components/services/unzip/public/cpp/unzip.h"
#include "components/services/unzip/public/mojom/unzipper.mojom.h"
namespace optimization_guide {
namespace {
using BuiltCallback = PredictionModelOverrides::Entry::BuiltCallback;
// The ":" character is reserved in Windows as part of an absolute file path,
// e.g.: C:\model.tflite, so we use a different separator.
#if BUILDFLAG(IS_WIN)
const char kModelOverrideSeparator[] = "|";
#else
const char kModelOverrideSeparator[] = ":";
#endif
std::unique_ptr<proto::PredictionModel> ProcessModelOverrideOnBGThread(
proto::OptimizationTarget optimization_target,
const base::FilePath& unzipped_dir_path) {
// Unpack and verify model info file.
base::FilePath model_info_path =
unzipped_dir_path.Append(GetBaseFileNameForModelInfo());
std::string binary_model_info_pb;
if (!base::ReadFileToString(model_info_path, &binary_model_info_pb)) {
LOG(ERROR) << "Failed to read " << FilePathToString(model_info_path);
return nullptr;
}
proto::ModelInfo model_info;
if (!model_info.ParseFromString(binary_model_info_pb)) {
LOG(ERROR) << "Failed to parse " << FilePathToString(model_info_path);
return nullptr;
}
if (!model_info.has_version() || !model_info.has_optimization_target()) {
LOG(ERROR) << FilePathToString(model_info_path)
<< "is invalid because it does not contain a version and/or "
"optimization target";
return nullptr;
}
if (model_info.optimization_target() != optimization_target) {
LOG(ERROR) << FilePathToString(model_info_path)
<< "is invalid because it does not contain the correct "
"optimization target";
return nullptr;
}
for (int i = 0; i < model_info.additional_files_size(); i++) {
proto::AdditionalModelFile* additional_file =
model_info.mutable_additional_files(i);
base::FilePath additional_file_basename =
*StringToFilePath(additional_file->file_path());
base::FilePath additional_file_absolute =
unzipped_dir_path.Append(additional_file_basename);
additional_file->set_file_path(FilePathToString(additional_file_absolute));
}
std::unique_ptr<proto::PredictionModel> model =
std::make_unique<proto::PredictionModel>();
*model->mutable_model_info() = model_info;
model->mutable_model()->set_download_url(
FilePathToString(unzipped_dir_path.Append(GetBaseFileNameForModels())));
return model;
}
void OnModelOverrideUnzipped(proto::OptimizationTarget optimization_target,
const base::FilePath& base_model_dir,
BuiltCallback callback,
bool success) {
if (!success) {
LOG(ERROR) << FilePathToString(base_model_dir) << " failed to unzip";
std::move(callback).Run(nullptr);
return;
}
base::ThreadPool::PostTaskAndReplyWithResult(
FROM_HERE, {base::MayBlock(), base::TaskPriority::BEST_EFFORT},
base::BindOnce(&ProcessModelOverrideOnBGThread, optimization_target,
base_model_dir),
std::move(callback));
}
void OnModelOverrideVerified(proto::OptimizationTarget optimization_target,
const base::FilePath& passed_crx_file_path,
const base::FilePath& base_model_dir,
unzip::UnzipperFactory unzipper_factory,
BuiltCallback callback,
bool is_verify_success) {
if (!is_verify_success) {
LOG(ERROR) << passed_crx_file_path << " failed verification";
std::move(callback).Run(nullptr);
return;
}
unzip::Unzip(unzipper_factory.Run(), passed_crx_file_path, base_model_dir,
unzip::mojom::UnzipOptions::New(), unzip::AllContents(),
base::DoNothing(),
base::BindOnce(&OnModelOverrideUnzipped, optimization_target,
base_model_dir, std::move(callback)));
}
std::optional<PredictionModelOverrides::Entry> ParseEntry(
const std::string& model_override) {
std::vector<std::string> override_parts =
base::SplitString(model_override, kModelOverrideSeparator,
base::TRIM_WHITESPACE, base::SPLIT_WANT_NONEMPTY);
if (override_parts.size() != 2 && override_parts.size() != 3) {
// Input is malformed. Should be either
// <target>:<path>:<base64_metadata> or <target>:<path>
LOG(ERROR) << "Invalid string format provided to the Model Override";
return std::nullopt;
}
proto::OptimizationTarget target;
if (!proto::OptimizationTarget_Parse(override_parts[0], &target)) {
// Optimization target is invalid.
LOG(ERROR) << "Invalid optimization target provided to the Model Override";
return std::nullopt;
}
auto path = StringToFilePath(override_parts[1]);
if (!path || !path->IsAbsolute()) {
LOG(ERROR) << "Provided model file path must be absolute "
<< path.value_or(base::FilePath()).value();
return std::nullopt;
}
if (override_parts.size() == 2) {
return PredictionModelOverrides::Entry(target, *path, std::nullopt);
}
std::string binary_pb;
if (!base::Base64Decode(override_parts[2], &binary_pb)) {
LOG(ERROR) << "Invalid base64 encoding of the Model Override";
return std::nullopt;
}
proto::Any metadata;
if (!metadata.ParseFromString(binary_pb)) {
LOG(ERROR) << "Invalid model metadata provided to the Model Override";
return std::nullopt;
}
return PredictionModelOverrides::Entry(target, *path, std::move(metadata));
}
} // namespace
std::string ModelOverrideSeparator() {
return kModelOverrideSeparator;
}
PredictionModelOverrides::Entry::Entry(proto::OptimizationTarget target,
base::FilePath path,
std::optional<proto::Any> metadata)
: target_(target), path_(std::move(path)), metadata_(std::move(metadata)) {}
PredictionModelOverrides::Entry::~Entry() = default;
PredictionModelOverrides::Entry::Entry(Entry&&) = default;
void PredictionModelOverrides::Entry::BuildModel(
const base::FilePath& base_model_dir,
unzip::UnzipperFactory unzipper_factory,
PredictionModelOverrides::Entry::BuiltCallback callback) const {
if (path_.MatchesFinalExtension(FILE_PATH_LITERAL(".crx3"))) {
DVLOG(0) << "Attempting to parse the model override at " << path_.value()
<< " as a crx model package for "
<< GetStringNameForOptimizationTarget(target_);
if (metadata_) {
LOG(ERROR) << "Ignoring the metadata that was passed since a crx package "
"was given";
}
base::ThreadPool::PostTaskAndReplyWithResult(
FROM_HERE, {base::MayBlock(), base::TaskPriority::BEST_EFFORT},
base::BindOnce(PredictionModelDownloadManager::VerifyDownload, path_,
base_model_dir,
/*delete_file_on_error=*/false),
base::BindOnce(&OnModelOverrideVerified, target_, path_, base_model_dir,
std::move(unzipper_factory), std::move(callback)));
return;
}
auto prediction_model = std::make_unique<proto::PredictionModel>();
prediction_model->mutable_model_info()->set_optimization_target(target_);
prediction_model->mutable_model_info()->set_version(123);
if (metadata_) {
*prediction_model->mutable_model_info()->mutable_model_metadata() =
metadata_.value();
}
prediction_model->mutable_model()->set_download_url(path_.MaybeAsASCII());
std::move(callback).Run(std::move(prediction_model));
}
PredictionModelOverrides::PredictionModelOverrides(
std::vector<Entry> overrides) {
for (auto& entry : overrides) {
overrides_.emplace(entry.target(), std::move(entry));
}
}
PredictionModelOverrides::~PredictionModelOverrides() = default;
PredictionModelOverrides::PredictionModelOverrides(PredictionModelOverrides&&) =
default;
const PredictionModelOverrides::Entry* PredictionModelOverrides::Get(
proto::OptimizationTarget target) const {
auto it = overrides_.find(target);
if (it == overrides_.end()) {
return nullptr;
}
return &it->second;
}
// static
PredictionModelOverrides PredictionModelOverrides::ParseFromCommandLine(
base::CommandLine* command_line) {
std::string switch_value =
command_line->GetSwitchValueASCII(switches::kModelOverride);
if (switch_value.empty()) {
return PredictionModelOverrides({});
}
std::vector<Entry> parsed;
std::vector<std::string> model_overrides = base::SplitString(
switch_value, ",", base::TRIM_WHITESPACE, base::SPLIT_WANT_NONEMPTY);
for (const auto& model_override : model_overrides) {
if (auto entry = ParseEntry(model_override); entry) {
parsed.push_back(std::move(*entry));
}
}
return PredictionModelOverrides(std::move(parsed));
}
} // namespace optimization_guide
|