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
|
// Copyright 2020 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_PERFORMANCE_MANAGER_PUBLIC_FREEZING_FREEZING_H_
#define COMPONENTS_PERFORMANCE_MANAGER_PUBLIC_FREEZING_FREEZING_H_
#include <string_view>
#include <vector>
#include "base/functional/callback.h"
#include "components/performance_manager/public/freezing/cannot_freeze_reason.h"
#include "components/performance_manager/public/graph/page_node.h"
class GURL;
namespace content {
class WebContents;
}
namespace performance_manager {
class Graph;
}
namespace performance_manager::freezing {
// While alive, this object votes to freeze a `WebContents`. All `WebContents`
// in a browsing instance are frozen if they all have at least one freeze vote
// and no `CannotFreezeReason` applies.
class FreezingVote {
public:
explicit FreezingVote(content::WebContents* web_contents);
~FreezingVote();
FreezingVote(const FreezingVote& other) = delete;
FreezingVote& operator=(const FreezingVote&) = delete;
private:
const base::WeakPtr<performance_manager::PageNode> page_node_;
};
// Used to discard frozen pages with growing private memory footprint.
class Discarder {
public:
Discarder();
virtual ~Discarder();
virtual void DiscardPages(Graph* graph,
std::vector<const PageNode*> page_nodes) = 0;
};
// Embedders can implement this to opt out a page from being frozen.
class OptOutChecker {
public:
// A callback that should be invoked with a browser context ID string
// whenever the opt-out policy for that browser context changes.
using OnPolicyChangedForBrowserContextCallback =
base::RepeatingCallback<void(std::string_view)>;
virtual ~OptOutChecker() = default;
// The freezing policy will call this to set a callback for the embedder to
// invoke whenever the opt-out policy for a browser context changes.
virtual void SetOptOutPolicyChangedCallback(
OnPolicyChangedForBrowserContextCallback callback) = 0;
// The freezing policy will call this to check if a page with the given
// `main_frame_url` should be opted out of freezing, according to the freezing
// policy for `browser_context_id`.
virtual bool IsPageOptedOutOfFreezing(std::string_view browser_context_id,
const GURL& main_frame_url) = 0;
};
// Whether a page can be frozen.
enum class CanFreeze {
// All types of freezing are possible for the page.
kYes,
// Only some types of freezing are possible for the page.
kVaries,
// No freezing is possible for the page.
kNo,
};
// Whether a page can be frozen, and reasons behind that decision.
struct CanFreezeDetails {
CanFreezeDetails();
~CanFreezeDetails();
// Move-only.
CanFreezeDetails(CanFreezeDetails&&);
CanFreezeDetails& operator=(CanFreezeDetails&&);
CanFreezeDetails(const CanFreezeDetails&) = delete;
CanFreezeDetails& operator=(const CanFreezeDetails&) = delete;
// Whether the page can be frozen.
CanFreeze can_freeze;
// `CannotFreezeReason`s for the page.
CannotFreezeReasonSet cannot_freeze_reasons;
// `CannotFreezeReason`s for connected pages.
CannotFreezeReasonSet cannot_freeze_reasons_connected_pages;
};
// Returns a `CanFreezeDetails` for `page_node`, indicating whether it can be
// frozen and why.
CanFreezeDetails GetCanFreezeDetailsForPageNode(const PageNode* page_node);
} // namespace performance_manager::freezing
#endif // COMPONENTS_PERFORMANCE_MANAGER_PUBLIC_FREEZING_FREEZING_H_
|
