File: hints_component_util.cc

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (185 lines) | stat: -rw-r--r-- 6,981 bytes parent folder | download | duplicates (6)
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
// Copyright 2018 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/hints_component_util.h"

#include <string>
#include <utility>

#include "base/files/file.h"
#include "base/files/file_util.h"
#include "base/logging.h"
#include "base/metrics/histogram_functions.h"
#include "base/metrics/histogram_macros.h"
#include "base/strings/stringprintf.h"
#include "components/optimization_guide/core/bloom_filter.h"
#include "components/optimization_guide/core/hints_component_info.h"
#include "components/optimization_guide/core/hints_processing_util.h"
#include "components/optimization_guide/core/optimization_filter.h"
#include "components/optimization_guide/core/optimization_guide_features.h"

namespace optimization_guide {

namespace {

const char kProcessHintsComponentResultHistogramString[] =
    "OptimizationGuide.ProcessHintsResult";

// Populates |out_result| with |result| if |out_result| is provided.
void PopulateProcessHintsComponentResultIfSet(
    ProcessHintsComponentResult result,
    ProcessHintsComponentResult* out_result) {
  if (out_result)
    *out_result = result;
}

// Populates |out_status| with |status| if |out_status| is provided.
void PopulateOptimizationFilterStatusIfSet(
    OptimizationFilterStatus status,
    OptimizationFilterStatus* out_status) {
  if (out_status)
    *out_status = status;
}

// Attempts to construct a valid bloom filter from the given
// |optimization_filter|. If given, |out_status| will be populated with the
// status of the operation. If a valid bloom filter cannot be constructed,
// nullptr is returned.
std::unique_ptr<BloomFilter> ProcessBloomFilter(
    const proto::OptimizationFilter& optimization_filter,
    OptimizationFilterStatus* out_status) {
  const auto& bloom_filter_proto = optimization_filter.bloom_filter();
  DCHECK_GT(bloom_filter_proto.num_hash_functions(), 0u);
  DCHECK_GT(bloom_filter_proto.num_bits(), 0u);
  DCHECK(bloom_filter_proto.has_data());

  if (!bloom_filter_proto.has_data() || bloom_filter_proto.num_bits() <= 0 ||
      bloom_filter_proto.num_bits() > bloom_filter_proto.data().size() * 8) {
    DLOG(ERROR) << "Bloom filter config issue";
    PopulateOptimizationFilterStatusIfSet(
        OptimizationFilterStatus::kFailedServerFilterBadConfig, out_status);
    return nullptr;
  }

  if (static_cast<int>(bloom_filter_proto.num_bits()) >
      features::MaxServerBloomFilterByteSize() * 8) {
    DLOG(ERROR) << "Bloom filter data exceeds maximum size of "
                << optimization_guide::features::MaxServerBloomFilterByteSize()
                << " bytes";
    PopulateOptimizationFilterStatusIfSet(
        OptimizationFilterStatus::kFailedServerFilterTooBig, out_status);
    return nullptr;
  }

  std::unique_ptr<BloomFilter> bloom_filter = std::make_unique<BloomFilter>(
      bloom_filter_proto.num_hash_functions(), bloom_filter_proto.num_bits(),
      bloom_filter_proto.data());
  PopulateOptimizationFilterStatusIfSet(
      OptimizationFilterStatus::kCreatedServerFilter, out_status);
  return bloom_filter;
}

// Attempts to construct a valid RegexpList from the given
// |regexps_list|. If given, |out_status| will be populated with the
// status of the operation. If a valid RegexpList cannot be constructed, nullptr
// is returned.
std::unique_ptr<RegexpList> ProcessRegexps(
    const google::protobuf::RepeatedPtrField<std::string>& regexps_list,
    OptimizationFilterStatus* out_status) {
  std::unique_ptr<RegexpList> regexps = std::make_unique<RegexpList>();
  for (int i = 0; i < regexps_list.size(); ++i) {
    regexps->emplace_back(std::make_unique<re2::RE2>(regexps_list.at(i)));
    if (!regexps->at(i)->ok()) {
      PopulateOptimizationFilterStatusIfSet(
          OptimizationFilterStatus::kInvalidRegexp, out_status);
      return nullptr;
    }
  }

  PopulateOptimizationFilterStatusIfSet(
      OptimizationFilterStatus::kCreatedServerFilter, out_status);
  return regexps;
}

}  // namespace

const char kComponentHintsUpdatedResultHistogramString[] =
    "OptimizationGuide.UpdateComponentHints.Result";

void RecordProcessHintsComponentResult(ProcessHintsComponentResult result) {
  UMA_HISTOGRAM_ENUMERATION(kProcessHintsComponentResultHistogramString,
                            result);
}

std::unique_ptr<proto::Configuration> ProcessHintsComponent(
    const HintsComponentInfo& component_info,
    ProcessHintsComponentResult* out_result) {
  if (!component_info.version.IsValid() || component_info.path.empty()) {
    PopulateProcessHintsComponentResultIfSet(
        ProcessHintsComponentResult::kFailedInvalidParameters, out_result);
    return nullptr;
  }

  std::string binary_pb;
  if (!base::ReadFileToString(component_info.path, &binary_pb)) {
    PopulateProcessHintsComponentResultIfSet(
        ProcessHintsComponentResult::kFailedReadingFile, out_result);
    return nullptr;
  }

  std::unique_ptr<proto::Configuration> proto_configuration =
      std::make_unique<proto::Configuration>();
  if (!proto_configuration->ParseFromString(binary_pb)) {
    PopulateProcessHintsComponentResultIfSet(
        ProcessHintsComponentResult::kFailedInvalidConfiguration, out_result);
    return nullptr;
  }

  PopulateProcessHintsComponentResultIfSet(
      ProcessHintsComponentResult::kSuccess, out_result);
  return proto_configuration;
}

void RecordOptimizationFilterStatus(proto::OptimizationType optimization_type,
                                    OptimizationFilterStatus status) {
  base::UmaHistogramExactLinear(
      base::StringPrintf(
          "OptimizationGuide.OptimizationFilterStatus.%s",
          GetStringNameForOptimizationType(optimization_type).c_str()),
      static_cast<int>(status),
      static_cast<int>(OptimizationFilterStatus::kMaxValue));
}

std::unique_ptr<OptimizationFilter> ProcessOptimizationFilter(
    const proto::OptimizationFilter& optimization_filter,
    OptimizationFilterStatus* out_status) {
  std::unique_ptr<BloomFilter> bloom_filter;
  if (optimization_filter.has_bloom_filter()) {
    bloom_filter = ProcessBloomFilter(optimization_filter, out_status);
    if (!bloom_filter)
      return nullptr;
  }

  std::unique_ptr<RegexpList> regexps;
  if (optimization_filter.regexps_size() > 0) {
    regexps = ProcessRegexps(optimization_filter.regexps(), out_status);
    if (!regexps)
      return nullptr;
  }

  std::unique_ptr<RegexpList> exclusion_regexps;
  if (optimization_filter.exclusion_regexps_size() > 0) {
    exclusion_regexps =
        ProcessRegexps(optimization_filter.exclusion_regexps(), out_status);
    if (!exclusion_regexps)
      return nullptr;
  }

  return std::make_unique<OptimizationFilter>(
      std::move(bloom_filter), std::move(regexps), std::move(exclusion_regexps),
      optimization_filter.skip_host_suffix_checking(),
      optimization_filter.bloom_filter_format());
}

}  // namespace optimization_guide