File: session_impl.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (336 lines) | stat: -rw-r--r-- 13,030 bytes parent folder | download | duplicates (5)
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
// Copyright 2023 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/model_execution/session_impl.h"

#include <memory>
#include <optional>
#include <string>

#include "base/containers/contains.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/metrics/histogram_functions.h"
#include "base/strings/stringprintf.h"
#include "base/time/time.h"
#include "base/timer/elapsed_timer.h"
#include "base/token.h"
#include "base/uuid.h"
#include "components/optimization_guide/core/model_execution/feature_keys.h"
#include "components/optimization_guide/core/model_execution/model_execution_util.h"
#include "components/optimization_guide/core/model_execution/multimodal_message.h"
#include "components/optimization_guide/core/model_execution/on_device_execution.h"
#include "components/optimization_guide/core/model_execution/on_device_model_access_controller.h"
#include "components/optimization_guide/core/model_execution/on_device_model_feature_adapter.h"
#include "components/optimization_guide/core/model_execution/on_device_model_service_controller.h"
#include "components/optimization_guide/core/model_execution/redactor.h"
#include "components/optimization_guide/core/model_execution/repetition_checker.h"
#include "components/optimization_guide/core/model_execution/response_parser.h"
#include "components/optimization_guide/core/model_execution/safety_checker.h"
#include "components/optimization_guide/core/model_execution/substitution.h"
#include "components/optimization_guide/core/optimization_guide_features.h"
#include "components/optimization_guide/core/optimization_guide_logger.h"
#include "components/optimization_guide/core/optimization_guide_model_executor.h"
#include "components/optimization_guide/core/optimization_guide_util.h"
#include "components/optimization_guide/proto/model_quality_metadata.pb.h"
#include "components/optimization_guide/proto/model_quality_service.pb.h"
#include "components/optimization_guide/proto/string_value.pb.h"
#include "components/optimization_guide/proto/text_safety_model_metadata.pb.h"
#include "mojo/public/cpp/bindings/callback_helpers.h"
#include "services/on_device_model/public/mojom/on_device_model.mojom.h"

namespace optimization_guide {
namespace {

using google::protobuf::RepeatedPtrField;
using ModelExecutionError =
    OptimizationGuideModelExecutionError::ModelExecutionError;

void LogSessionCreation(OptimizationGuideLogger* logger,
                        ModelBasedCapabilityKey feature) {
  if (logger && logger->ShouldEnableDebugLogs()) {
    OPTIMIZATION_GUIDE_LOGGER(
        optimization_guide_common::mojom::LogSource::MODEL_EXECUTION, logger)
        << "Starting on-device session for "
        << std::string(GetStringNameForModelExecutionFeature(feature));
  }
}

SamplingParams ResolveSamplingParams(
    const std::optional<SessionConfigParams>& config_params,
    const std::optional<OnDeviceOptions>& on_device_opts) {
  if (config_params && config_params->sampling_params) {
    return config_params->sampling_params.value();
  }
  if (on_device_opts) {
    auto feature_params = on_device_opts->adapter->GetSamplingParamsConfig();
    return SamplingParams{.top_k = feature_params.default_top_k,
                          .temperature = feature_params.default_temperature};
  }
  return SamplingParams{
      .top_k = static_cast<uint32_t>(features::GetOnDeviceModelDefaultTopK()),
      .temperature =
          static_cast<float>(features::GetOnDeviceModelDefaultTemperature()),
  };
}

}  // namespace

SessionImpl::SessionImpl(
    ModelBasedCapabilityKey feature,
    std::optional<OnDeviceOptions> on_device_opts,
    ExecuteRemoteFn execute_remote_fn,
    const std::optional<SessionConfigParams>& config_params)
    : feature_(feature),
      execute_remote_fn_(std::move(execute_remote_fn)),
      sampling_params_(ResolveSamplingParams(config_params, on_device_opts)),
      capabilities_(config_params ? config_params->capabilities
                                  : on_device_model::Capabilities()) {
  if (on_device_opts && on_device_opts->ShouldUse()) {
    LogSessionCreation(on_device_opts->logger.get(), feature_);
    // TODO(crbug.com/403383823): Consider removing `sampling_params_` from
    // `SessionImpl` in favor of querying them from `on_device_context_`.
    on_device_opts->sampling_params = sampling_params_;
    on_device_context_ =
        std::make_unique<OnDeviceContext>(*std::move(on_device_opts), feature_);
    // Prewarm the initial session to make sure the service is started.
    on_device_context_->GetOrCreateSession();
  }
}

SessionImpl::SessionImpl(ModelBasedCapabilityKey feature,
                         ExecuteRemoteFn execute_remote_fn,
                         const SamplingParams& sampling_params)
    : feature_(feature),
      execute_remote_fn_(std::move(execute_remote_fn)),
      sampling_params_(sampling_params) {}

SessionImpl::~SessionImpl() {}

const TokenLimits& SessionImpl::GetTokenLimits() const {
  if (!on_device_context_) {
    static const TokenLimits null_limits{};
    return null_limits;
  }
  return on_device_context_->opts().token_limits;
}

void SessionImpl::SetInput(MultimodalMessage request,
                           SetInputCallback callback) {
  const auto result = AddContextImpl(std::move(request), std::move(callback));
  base::UmaHistogramEnumeration(
      base::StrCat(
          {"OptimizationGuide.ModelExecution.OnDeviceAddContextResult.",
           GetStringNameForModelExecutionFeature(feature_)}),
      result);
}

void SessionImpl::AddContext(
    const google::protobuf::MessageLite& request_metadata) {
  SetInput(MultimodalMessage(request_metadata), {});
}

SessionImpl::AddContextResult SessionImpl::AddContextImpl(
    MultimodalMessage request,
    SetInputCallback callback) {
  if (callback) {
    callback = mojo::WrapCallbackWithDefaultInvokeIfNotRun(
        std::move(callback),
        base::unexpected(
            OptimizationGuideModelExecutionError::FromModelExecutionError(
                OptimizationGuideModelExecutionError::ModelExecutionError::
                    kCancelled)));
  }
  context_ = std::move(request);
  context_start_time_ = base::TimeTicks::Now();

  // Cancel any pending response.
  if (on_device_execution_) {
    on_device_execution_->Cancel();
  }

  if (!ShouldUseOnDeviceModel()) {
    DestroyOnDeviceState();
    return AddContextResult::kUsingServer;
  }

  if (!on_device_context_->SetInput(context_.read(), std::move(callback))) {
    // Use server if can't construct input.
    DestroyOnDeviceState();
    return AddContextResult::kFailedConstructingInput;
  }

  return AddContextResult::kUsingOnDevice;
}

void SessionImpl::Score(const std::string& text,
                        OptimizationGuideModelScoreCallback callback) {
  // Fail if not using on device, or no session was started yet.
  if (!on_device_context_ || !on_device_context_->CanUse()) {
    std::move(callback).Run(std::nullopt);
    return;
  }
  on_device_context_->GetOrCreateSession()->Score(
      text,
      base::BindOnce([](float score) { return std::optional<float>(score); })
          .Then(mojo::WrapCallbackWithDefaultInvokeIfNotRun(std::move(callback),
                                                            std::nullopt)));
}

void SessionImpl::ExecuteModel(
    const google::protobuf::MessageLite& request_metadata,
    optimization_guide::OptimizationGuideModelExecutionResultStreamingCallback
        callback) {
  ExecuteModelWithResponseConstraint(request_metadata,
                                     /*constraint=*/nullptr,
                                     std::move(callback));
}

void SessionImpl::ExecuteModelWithResponseConstraint(
    const google::protobuf::MessageLite& request_metadata,
    on_device_model::mojom::ResponseConstraintPtr constraint,
    optimization_guide::OptimizationGuideModelExecutionResultStreamingCallback
        callback) {
  auto logger = std::make_unique<OnDeviceExecution::ResultLogger>(feature_);

  // Compute the amount of time context would have for processing assuming
  // on-device execution.
  base::TimeDelta context_start_to_execution = base::TimeDelta::Min();
  if (context_start_time_ != base::TimeTicks()) {
    context_start_to_execution = base::TimeTicks::Now() - context_start_time_;
    base::UmaHistogramLongTimes(
        base::StrCat(
            {"OptimizationGuide.ModelExecution.ContextStartToExecutionTime.",
             GetStringNameForModelExecutionFeature(feature_)}),
        context_start_to_execution);
    // Only interested in logging the first request after adding context.
    context_start_time_ = base::TimeTicks();
  }

  auto merged_request = context_.Merge(request_metadata);

  if (!ShouldUseOnDeviceModel()) {
    DestroyOnDeviceState();
    execute_remote_fn_.Run(
        feature_, merged_request.BuildProtoMessage(), std::nullopt,
        /*log_ai_data_request=*/nullptr,
        base::BindOnce(&InvokeStreamingCallbackWithRemoteResult,
                       std::move(callback)));
    return;
  }

  if (on_device_execution_) {
    on_device_execution_->Cancel();
  }
  on_device_execution_.reset();

  // Set new pending response.
  on_device_execution_.emplace(
      feature_, on_device_context_->opts(), execute_remote_fn_,
      std::move(merged_request), std::move(constraint), std::move(logger),
      std::move(callback),
      base::BindOnce(&SessionImpl::OnDeviceExecutionTerminated,
                     weak_ptr_factory_.GetWeakPtr()));

  on_device_execution_->BeginExecution(*on_device_context_);
}

void SessionImpl::OnDeviceExecutionTerminated(bool healthy) {
  on_device_execution_.reset();
  if (!healthy) {
    DestroyOnDeviceState();
  }
}

bool SessionImpl::ShouldUseOnDeviceModel() const {
  return on_device_context_ && on_device_context_->CanUse();
}

void SessionImpl::DestroyOnDeviceState() {
  on_device_context_.reset();
}

void SessionImpl::GetSizeInTokens(
    const std::string& text,
    OptimizationGuideModelSizeInTokenCallback callback) {
  if (!ShouldUseOnDeviceModel()) {
    std::move(callback).Run(std::nullopt);
    return;
  }
  auto input = on_device_model::mojom::Input::New();
  input->pieces.push_back(text);
  on_device_context_->GetOrCreateSession()->GetSizeInTokens(
      std::move(input), base::BindOnce([](uint32_t size) {
                          return std::optional<uint32_t>(size);
                        })
                            .Then(mojo::WrapCallbackWithDefaultInvokeIfNotRun(
                                std::move(callback), std::nullopt)));
}

void SessionImpl::GetExecutionInputSizeInTokens(
    MultimodalMessageReadView request_metadata,
    OptimizationGuideModelSizeInTokenCallback callback) {
  GetSizeInTokensInternal(request_metadata, std::move(callback),
                          /*want_input_context=*/false);
}

void SessionImpl::GetContextSizeInTokens(
    MultimodalMessageReadView request_metadata,
    OptimizationGuideModelSizeInTokenCallback callback) {
  GetSizeInTokensInternal(request_metadata, std::move(callback),
                          /*want_input_context=*/true);
}

const proto::Any& SessionImpl::GetOnDeviceFeatureMetadata() const {
  return on_device_context_->opts().adapter->GetFeatureMetadata();
}

const SamplingParams SessionImpl::GetSamplingParams() const {
  return sampling_params_;
}

on_device_model::Capabilities SessionImpl::GetCapabilities() const {
  return capabilities_;
}

std::unique_ptr<OptimizationGuideModelExecutor::Session> SessionImpl::Clone() {
  auto session = std::make_unique<SessionImpl>(feature_, execute_remote_fn_,
                                               sampling_params_);
  session->context_ = context_.Clone();
  session->context_start_time_ = context_start_time_;
  if (on_device_context_ && on_device_context_->CanUse()) {
    session->on_device_context_ = on_device_context_->Clone();
  }
  return session;
}

void SessionImpl::SetPriority(on_device_model::mojom::Priority priority) {
  if (on_device_context_) {
    on_device_context_->SetPriority(priority);
  }
}

void SessionImpl::GetSizeInTokensInternal(
    MultimodalMessageReadView request,
    OptimizationGuideModelSizeInTokenCallback callback,
    bool want_input_context) {
  if (!ShouldUseOnDeviceModel()) {
    std::move(callback).Run(std::nullopt);
    return;
  }
  auto input = on_device_context_->opts().adapter->ConstructInputString(
      request, want_input_context);
  if (!input) {
    std::move(callback).Run(std::nullopt);
    return;
  }
  on_device_context_->GetOrCreateSession()->GetSizeInTokens(
      std::move(input->input),
      base::BindOnce(
          [](uint32_t size) { return std::optional<uint32_t>(size); })
          .Then(mojo::WrapCallbackWithDefaultInvokeIfNotRun(std::move(callback),
                                                            std::nullopt)));
}

}  // namespace optimization_guide