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
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/predictors/predictor_database.h"
#include <cstdint>
#include <memory>
#include "base/check.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/functional/bind.h"
#include "base/metrics/histogram_functions.h"
#include "base/numerics/safe_conversions.h"
#include "base/task/sequenced_task_runner.h"
#include "base/timer/timer.h"
#include "chrome/browser/predictors/autocomplete_action_predictor_table.h"
#include "chrome/browser/predictors/loading_predictor_config.h"
#include "chrome/browser/predictors/resource_prefetch_predictor.h"
#include "chrome/browser/predictors/resource_prefetch_predictor_tables.h"
#include "chrome/browser/profiles/profile.h"
#include "content/public/browser/browser_thread.h"
#include "sql/database.h"
using content::BrowserThread;
namespace {
// TODO(shishir): This should move to a more generic name.
const base::FilePath::CharType kPredictorDatabaseName[] =
FILE_PATH_LITERAL("Network Action Predictor");
void ReportUMA(const base::FilePath& file_path) {
std::optional<int64_t> db_file_size = base::GetFileSize(file_path);
if (!db_file_size.has_value()) {
return;
}
// "x>>10 == x/1024"
const int kb_size = base::saturated_cast<int>(db_file_size.value() >> 10);
base::UmaHistogramCounts1M("LoadingPredictor.PredictorDatabaseFileSize",
kb_size);
}
} // namespace
namespace predictors {
// Refcounted as it is created, initialized and destroyed on a different thread
// to the DB sequence provided to the constructor of this class that is required
// for all methods performing database access.
class PredictorDatabaseInternal
: public base::RefCountedThreadSafe<PredictorDatabaseInternal> {
public:
PredictorDatabaseInternal(const PredictorDatabaseInternal&) = delete;
PredictorDatabaseInternal& operator=(const PredictorDatabaseInternal&) =
delete;
private:
friend class base::RefCountedThreadSafe<PredictorDatabaseInternal>;
friend class PredictorDatabase;
explicit PredictorDatabaseInternal(
Profile* profile,
scoped_refptr<base::SequencedTaskRunner> db_task_runner);
virtual ~PredictorDatabaseInternal();
// Opens the database file from the profile path. Separated from the
// constructor to ease construction/destruction of this object on one thread
// but database access on the DB sequence of |db_task_runner_|.
void Initialize();
void LogDatabaseStats(); // DB sequence.
// Cancels pending DB transactions. Should only be called on the UI thread.
void SetCancelled();
bool is_loading_predictor_enabled_;
const base::FilePath db_path_;
std::unique_ptr<sql::Database> db_;
scoped_refptr<base::SequencedTaskRunner> db_task_runner_;
// TODO(shishir): These tables may not need to be refcounted. Maybe move them
// to using a WeakPtr instead.
scoped_refptr<AutocompleteActionPredictorTable> autocomplete_table_;
scoped_refptr<ResourcePrefetchPredictorTables> resource_prefetch_tables_;
std::unique_ptr<base::RepeatingTimer> uma_report_timer_;
};
PredictorDatabaseInternal::PredictorDatabaseInternal(
Profile* profile,
scoped_refptr<base::SequencedTaskRunner> db_task_runner)
: db_path_(profile->GetPath().Append(kPredictorDatabaseName)),
db_(std::make_unique<sql::Database>(
sql::DatabaseOptions()
.set_preload(true)
// TODO(pwnall): Add a meta table and remove this option.
.set_mmap_alt_status_discouraged(true)
.set_enable_views_discouraged(
true), // Required by mmap_alt_status.
sql::Database::Tag("Predictor"))),
db_task_runner_(db_task_runner),
autocomplete_table_(
new AutocompleteActionPredictorTable(db_task_runner_)),
resource_prefetch_tables_(
new ResourcePrefetchPredictorTables(db_task_runner_)) {
is_loading_predictor_enabled_ = IsLoadingPredictorEnabled(profile);
}
PredictorDatabaseInternal::~PredictorDatabaseInternal() {
if (uma_report_timer_) {
// Since `uma_report_timer_` run on `db_task_runner_`, we need to shut down
// it on DB sequence.
db_task_runner_->PostTask(FROM_HERE,
base::BindOnce(&base::RepeatingTimer::Stop,
std::move(uma_report_timer_)));
}
// The connection pointer needs to be deleted on the DB sequence since there
// might be a task in progress on the DB sequence which uses this connection.
db_task_runner_->PostTask(
FROM_HERE, base::BindOnce(&AutocompleteActionPredictorTable::ResetDB,
autocomplete_table_));
db_task_runner_->PostTask(
FROM_HERE, base::BindOnce(&ResourcePrefetchPredictorTables::ResetDB,
resource_prefetch_tables_));
db_task_runner_->DeleteSoon(FROM_HERE, std::move(db_));
}
void PredictorDatabaseInternal::Initialize() {
DCHECK(db_task_runner_->RunsTasksInCurrentSequence());
if (autocomplete_table_->IsCancelled() ||
resource_prefetch_tables_->IsCancelled()) {
return;
}
if (!db_->Open(db_path_)) {
return;
}
autocomplete_table_->Initialize(db_.get());
resource_prefetch_tables_->Initialize(db_.get());
LogDatabaseStats();
ReportUMA(db_path_);
uma_report_timer_ = std::make_unique<base::RepeatingTimer>();
// Report DB usage periodically to see its growth.
uma_report_timer_->Start(FROM_HERE, base::Days(1),
base::BindRepeating(&ReportUMA, db_path_));
}
void PredictorDatabaseInternal::SetCancelled() {
DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI) ||
!BrowserThread::IsThreadInitialized(BrowserThread::UI));
autocomplete_table_->SetCancelled();
resource_prefetch_tables_->SetCancelled();
}
void PredictorDatabaseInternal::LogDatabaseStats() {
DCHECK(db_task_runner_->RunsTasksInCurrentSequence());
autocomplete_table_->LogDatabaseStats();
if (is_loading_predictor_enabled_) {
resource_prefetch_tables_->LogDatabaseStats();
}
}
PredictorDatabase::PredictorDatabase(
Profile* profile,
scoped_refptr<base::SequencedTaskRunner> db_task_runner)
: db_(new PredictorDatabaseInternal(profile, db_task_runner)) {
db_task_runner->PostTask(
FROM_HERE, base::BindOnce(&PredictorDatabaseInternal::Initialize, db_));
}
PredictorDatabase::~PredictorDatabase() = default;
void PredictorDatabase::Shutdown() {
db_->SetCancelled();
}
scoped_refptr<AutocompleteActionPredictorTable>
PredictorDatabase::autocomplete_table() {
return db_->autocomplete_table_;
}
scoped_refptr<ResourcePrefetchPredictorTables>
PredictorDatabase::resource_prefetch_tables() {
return db_->resource_prefetch_tables_;
}
sql::Database* PredictorDatabase::GetDatabase() {
return db_->db_.get();
}
} // namespace predictors
|
