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
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_PRERENDER_PRERENDER_TRACKER_H_
#define CHROME_BROWSER_PRERENDER_PRERENDER_TRACKER_H_
#include <map>
#include <set>
#include <utility>
#include <vector>
#include "base/gtest_prod_util.h"
#include "base/memory/weak_ptr.h"
#include "base/synchronization/lock.h"
#include "base/threading/non_thread_safe.h"
#include "chrome/browser/prerender/prerender_contents.h"
#include "chrome/browser/prerender/prerender_final_status.h"
#include "url/gurl.h"
namespace prerender {
class PrerenderManager;
class PrerenderPendingSwapThrottle;
class PrerenderResourceThrottle;
struct RenderViewInfo;
// PrerenderTracker is responsible for keeping track of all prerendering
// RenderViews and their statuses. Its list is guaranteed to be up to date
// and can be modified on any thread.
class PrerenderTracker : public base::NonThreadSafe,
public PrerenderContents::Observer {
public:
typedef std::pair<int, int> ChildRouteIdPair;
PrerenderTracker();
virtual ~PrerenderTracker();
// Attempts to set the status of the specified RenderViewHost to
// FINAL_STATUS_USED. Returns true on success. Returns false if it has
// already been cancelled for any reason or is no longer prerendering.
// Can only be called only on the UI thread. This method will not call
// PrerenderContents::SetFinalStatus() on the corresponding PrerenderContents.
//
// If it returns true, all subsequent calls to TryCancel and TryUse for the
// RenderView will return false.
bool TryUse(int child_id, int route_id);
// Attempts to cancel prerendering by the specified RenderView, setting the
// FinalStatus to |final_status|. Returns true if the specified prerender has
// been cancelled, either as a result of this call or for any other reason.
// If the call results in cancelling a PrerenderContents, a task to destroy
// it is also posted to the UI thread.
//
// When true is returned, it is guaranteed that the RenderView will never
// be displayed. When false is returned, the RenderView has either been
// swapped into a tab or has already been destroyed.
bool TryCancel(int child_id, int route_id, FinalStatus final_status);
// Same as above, but can only called on the IO Thread. Does not acquire a
// lock when the RenderView is not being prerendered.
bool TryCancelOnIOThread(int child_id, int route_id,
FinalStatus final_status);
// Gets the FinalStatus of the specified prerendered RenderView. Returns
// |true| and sets |final_status| to the status of the RenderView if it
// is found, returns false otherwise.
bool GetFinalStatus(int child_id, int route_id,
FinalStatus* final_status) const;
// Returns whether or not a RenderView is prerendering. Can only be called on
// the IO thread. Does not acquire a lock, so may claim a RenderView that has
// been displayed or destroyed is still prerendering.
bool IsPrerenderingOnIOThread(int child_id, int route_id) const;
// Returns whether or not a RenderView and URL are regarding a pending
// prerender swap. Can only be called on the IO thread. Does not acquire a
// lock.
bool IsPendingSwapRequestOnIOThread(int child_id, int route_id,
const GURL& url) const;
// Called when a PrerenderResourceThrottle defers a request. Cancel
// or Resume will be called on |throttle| when the prerender is
// canceled or used, respectively.
void AddResourceThrottleOnIOThread(
int child_id, int route_id,
const base::WeakPtr<PrerenderResourceThrottle>& throttle);
// Called when a PrerenderResourceThrottle defers a request. Cancel
// or Resume will be called on |throttle| when the prerender is
// canceled or used, respectively.
void AddPendingSwapThrottleOnIOThread(
int child_id, int route_id, const GURL& url,
const base::WeakPtr<PrerenderPendingSwapThrottle>& throttle);
// Called to add throttles for a pending prerender swap.
void AddPrerenderPendingSwap(const ChildRouteIdPair& child_route_id_pair,
const GURL& url);
// Called to remove the throttles for a pending prerender swap.
void RemovePrerenderPendingSwap(const ChildRouteIdPair& child_route_id_pair,
bool swap_successful);
private:
friend class PrerenderContents;
FRIEND_TEST_ALL_PREFIXES(PrerenderTrackerTest, PrerenderTrackerNull);
FRIEND_TEST_ALL_PREFIXES(PrerenderTrackerTest, PrerenderTrackerUsed);
FRIEND_TEST_ALL_PREFIXES(PrerenderTrackerTest, PrerenderTrackerCancelled);
FRIEND_TEST_ALL_PREFIXES(PrerenderTrackerTest, PrerenderTrackerCancelledOnIO);
FRIEND_TEST_ALL_PREFIXES(PrerenderTrackerTest, PrerenderTrackerCancelledFast);
FRIEND_TEST_ALL_PREFIXES(PrerenderTrackerTest, PrerenderTrackerMultiple);
// Map of child/route id pairs to final statuses.
typedef std::map<ChildRouteIdPair, RenderViewInfo> FinalStatusMap;
// List of throttled requests.
typedef std::vector<base::WeakPtr<PrerenderResourceThrottle> >
ResourceThrottleList;
// Set of throttled requests.
typedef std::map<ChildRouteIdPair, ResourceThrottleList> ResourceThrottleMap;
struct PendingSwapThrottleData {
explicit PendingSwapThrottleData(const GURL& swap_url);
~PendingSwapThrottleData();
GURL url;
std::vector<base::WeakPtr<PrerenderPendingSwapThrottle> > throttles;
};
// Set of throttles for pending swaps.
typedef std::map<ChildRouteIdPair, PendingSwapThrottleData>
PendingSwapThrottleMap;
// From PrerenderContents::Observer:
virtual void OnPrerenderStart(PrerenderContents* prerender_contents) OVERRIDE;
virtual void OnPrerenderStop(PrerenderContents* prerender_contents) OVERRIDE;
// Attempts to set the FinalStatus of the specified RenderView to
// |desired_final_status|. If non-NULL, |actual_final_status| is set to the
// FinalStatus of the RenderView.
//
// If the FinalStatus of the RenderView is successfully set, returns true and
// sets |actual_final_status| to |desired_final_status|.
//
// If the FinalStatus of the RenderView was already set, returns false and
// sets |actual_final_status| to the actual FinalStatus of the RenderView.
//
// If the RenderView is not a prerendering RenderView, returns false and sets
// |actual_final_status| to FINAL_STATUS_MAX.
bool SetFinalStatus(int child_id, int route_id,
FinalStatus desired_final_status,
FinalStatus* actual_final_status);
// Add/remove the specified pair to |possibly_prerendering_io_thread_set_| on
// the IO Thread.
void AddPrerenderOnIOThread(const ChildRouteIdPair& child_route_id_pair);
void RemovePrerenderOnIOThread(const ChildRouteIdPair& child_route_id_pair,
FinalStatus final_status);
// Add/remove prerenders pending swap on the IO Thread.
void AddPrerenderPendingSwapOnIOThread(
const ChildRouteIdPair& child_route_id_pair, const GURL& url);
void RemovePrerenderPendingSwapOnIOThread(
const ChildRouteIdPair& child_route_id_pair,
bool swap_successful);
// Tasks posted to the IO Thread to call the above functions.
static void AddPrerenderOnIOThreadTask(
const ChildRouteIdPair& child_route_id_pair);
static void RemovePrerenderOnIOThreadTask(
const ChildRouteIdPair& child_route_id_pair,
FinalStatus final_status);
static void AddPrerenderPendingSwapOnIOThreadTask(
const ChildRouteIdPair& child_route_id_pair, const GURL& url);
static void RemovePrerenderPendingSwapOnIOThreadTask(
const ChildRouteIdPair& child_route_id_pair,
bool swap_successful);
static PrerenderTracker* GetDefault();
// |final_status_map_lock_| protects access to |final_status_map_|.
mutable base::Lock final_status_map_lock_;
// Map containing child/route id pairs and their final statuses. Must only be
// accessed while the lock is held. Values are always accurate and up to
// date.
FinalStatusMap final_status_map_;
// Resources that are throttled, pending a prerender use. The keys are a
// superset of child/route id pairs that are prerendering. Can only access on
// the IO thread. May contain entries that have since been displayed. Used
// to prevent locking when not needed.
ResourceThrottleMap resource_throttle_io_thread_map_;
// Map of pending prerender swaps and their associated throttles,
// maintained on the IO thread.
PendingSwapThrottleMap pending_swap_throttle_map_;
DISALLOW_COPY_AND_ASSIGN(PrerenderTracker);
};
} // namespace prerender
#endif // CHROME_BROWSER_PRERENDER_PRERENDER_TRACKER_H_
|
