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
|
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_SERVICES_STORAGE_SHARED_STORAGE_SHARED_STORAGE_OPTIONS_H_
#define COMPONENTS_SERVICES_STORAGE_SHARED_STORAGE_SHARED_STORAGE_OPTIONS_H_
#include <memory>
#include "base/time/time.h"
namespace storage {
struct SharedStorageDatabaseOptions;
// Bundles Finch-configurable constants for the `SharedStorageManager`,
// `AsyncSharedStorageDatabase`, and `SharedStorageDatabase` classes.
struct SharedStorageOptions {
// Accesses field trial params to populate one or more attributes, and so must
// be called on the main thread.
static std::unique_ptr<SharedStorageOptions> Create();
SharedStorageOptions(int max_page_size,
int max_cache_size,
int max_bytes_per_origin,
int max_init_tries,
int max_iterator_batch_size,
int bit_budget,
base::TimeDelta budget_interval,
base::TimeDelta stale_purge_initial_interval,
base::TimeDelta stale_purge_recurring_interval,
base::TimeDelta staleness_threshold);
// Creates a pointer to a smaller bundle of just the constants that need to
// be forwarded to `AsyncSharedStorageDatabase` and `SharedStorageDatabase`.
std::unique_ptr<SharedStorageDatabaseOptions> GetDatabaseOptions();
// Maximum size of a database page, in bytes. Must be a power of 2 between
// 512 and 65536 inclusive.
const int max_page_size;
// Maximum size of the database cache, in pages.
const int max_cache_size;
// Maximum number of total bytes in database entries allowed per origin.
const int max_bytes_per_origin;
// Maximum number of times that `SharedStorageDatabase` will try to
// initialize the SQL database.
const int max_init_tries;
// Maximum number of keys or key-value pairs returned per batch by the
// async `Keys()` and `Entries()` iterators, respectively.
const int max_iterator_batch_size;
// Maximum number of bits of entropy allowed per origin to output via the
// Shared Storage API.
const int bit_budget;
// Interval over which `bit_budget` is defined.
const base::TimeDelta budget_interval;
// Initial interval at which stale origins are purged.
const base::TimeDelta stale_purge_initial_interval;
// Recurring interval at which stale origins are purged. May differ from
// the initial interval.
const base::TimeDelta stale_purge_recurring_interval;
// Length of time between origin creation and origin expiration. When an
// origin's data is older than this threshold, it will be auto-purged.
const base::TimeDelta staleness_threshold;
};
// Bundles Finch-configurable constants for the `AsyncSharedStorageDatabase`
// and `SharedStorageDatabase` classes. This smaller class is separate from the
// larger `SharedStorageOptions` (which has the ability to create an instance of
// `SharedStorageDatabaseOptions` from a subset of its members) so that the
// smaller `SharedStorageDatabaseOptions` bundle can be read on an alternate
// thread while the larger class's bundle can continue to be accessed on the
// main thread.
struct SharedStorageDatabaseOptions {
SharedStorageDatabaseOptions(int max_page_size,
int max_cache_size,
int max_bytes_per_origin,
int max_init_tries,
int max_iterator_batch_size,
int bit_budget,
base::TimeDelta budget_interval,
base::TimeDelta staleness_threshold);
// Maximum size of a database page, in bytes. Must be a power of 2 between
// 512 and 65536 inclusive.
const int max_page_size;
// Maximum size of the database cache, in pages.
const int max_cache_size;
// Maximum number of total bytes in database entries allowed per origin.
const int max_bytes_per_origin;
// Maximum number of times that `SharedStorageDatabase` will try to
// initialize the SQL database.
const int max_init_tries;
// Maximum number of keys or key-value pairs returned per batch by the
// async `Keys()` and `Entries()` iterators, respectively.
const int max_iterator_batch_size;
// Maximum number of bits of entropy allowed per origin to output via the
// Shared Storage API.
const int bit_budget;
// Interval over which `bit_budget` is defined.
const base::TimeDelta budget_interval;
// Length of time between origin creation and origin expiration. When an
// origin's data is older than this threshold, it will be auto-purged.
const base::TimeDelta staleness_threshold;
};
} // namespace storage
#endif // COMPONENTS_SERVICES_STORAGE_SHARED_STORAGE_SHARED_STORAGE_OPTIONS_H_
|
