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
|
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CC_TREES_SWAP_PROMISE_H_
#define CC_TREES_SWAP_PROMISE_H_
#include <stdint.h>
#include "base/time/time.h"
#include "cc/cc_export.h"
#include "components/viz/common/quads/compositor_frame_metadata.h"
namespace cc {
// When a change to the compositor's state/invalidation/whatever happens, a
// Swap Promise can be inserted into LayerTreeHost/LayerTreeImpl, to track
// whether the compositor's reply to the new state/invalidation/whatever is
// completed in the compositor, i.e. the compositor knows it has been sent
// to its output or not.
//
// If the commit results in a successful activation of the pending layer tree,
// SwapPromise::DidActivate() will be called.
//
// If the new compositor state is going to be sent to the output,
// SwapPromise::WillSwap() will be called before the swap and
// SwapPromise::DidSwap() will be called once the swap is over.
//
// If the scheduler fails to activate the pending tree, or the compositor
// fails to send its new state to the output, SwapPromise::DidNotSwap() will
// be called. Note that it is possible to activate, and subsequently not swap.
//
// Promises complete after either DidSwap() or DidNotSwap() is called, thus
// there are three possible call sequences:
// DidNotSwap()
// DidActivate() ; WillSwap(); DidSwap()
// DidActivate() ; DidNotSwap()
//
// Clients that wish to use SwapPromise should have a subclass that defines
// the behavior of DidActivate(), WillSwap(), DidSwap() and DidNotSwap(). Notice
// that the promise can be broken at either main or impl thread, e.g. commit
// fails on main thread, new frame data has no actual damage so
// LayerTreeHostImpl::SwapBuffers() bails out early on impl thread, so don't
// assume that DidNotSwap() method is called at a particular thread. It is
// better to let the subclass carry thread-safe member data and operate on that
// member data in DidNotSwap().
class CC_EXPORT SwapPromise {
public:
enum DidNotSwapReason {
SWAP_FAILS,
COMMIT_FAILS,
COMMIT_NO_UPDATE,
ACTIVATION_FAILS,
};
enum class DidNotSwapAction {
BREAK_PROMISE,
KEEP_ACTIVE,
};
SwapPromise() {}
virtual ~SwapPromise() {}
virtual void DidActivate() = 0;
virtual void WillSwap(viz::CompositorFrameMetadata* metadata) = 0;
virtual void DidSwap() = 0;
// Return `DidNotSwapAction::KEEP_ACTIVE` if this promise should remain active
// (should not be broken by the owner).
virtual DidNotSwapAction DidNotSwap(DidNotSwapReason reason,
base::TimeTicks timestamp) = 0;
// This is called when the main thread starts a (blocking) commit
virtual void OnCommit() {}
// A non-zero trace id identifies a trace flow object that is embedded in the
// swap promise. This can be used for registering additional flow steps to
// visualize the object's path through the system.
virtual int64_t GetTraceId() const = 0;
};
} // namespace cc
#endif // CC_TREES_SWAP_PROMISE_H_
|
