Make it possible to detach GraphicsLayerCA backing store
[WebKit-https.git] / Source / WebKit2 / Shared / mac / RemoteLayerBackingStoreCollection.h
1 /*
2  * Copyright (C) 2014 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef RemoteLayerBackingStoreCollection_h
27 #define RemoteLayerBackingStoreCollection_h
28
29 #import <WebCore/Timer.h>
30 #import <wtf/HashSet.h>
31 #import <wtf/Noncopyable.h>
32
33 namespace WebKit {
34
35 class RemoteLayerBackingStore;
36 class RemoteLayerTreeContext;
37 class RemoteLayerTreeTransaction;
38
39 class RemoteLayerBackingStoreCollection {
40     WTF_MAKE_NONCOPYABLE(RemoteLayerBackingStoreCollection);
41     WTF_MAKE_FAST_ALLOCATED;
42 public:
43     RemoteLayerBackingStoreCollection();
44
45     void backingStoreWasCreated(RemoteLayerBackingStore&);
46     void backingStoreWillBeDestroyed(RemoteLayerBackingStore&);
47
48     // Return value indicates whether the backing store needs to be included in the transaction.
49     bool backingStoreWillBeDisplayed(RemoteLayerBackingStore&);
50     void backingStoreBecameUnreachable(RemoteLayerBackingStore&);
51
52     void willFlushLayers();
53     void willCommitLayerTree(RemoteLayerTreeTransaction&);
54     void didFlushLayers();
55
56     void volatilityTimerFired();
57     bool markAllBackingStoreVolatileImmediatelyIfPossible();
58
59     void scheduleVolatilityTimer();
60
61 private:
62     enum VolatilityMarkingFlag {
63         MarkBuffersIgnoringReachability = 1 << 0
64     };
65     typedef unsigned VolatilityMarkingFlags;
66     bool markBackingStoreVolatileImmediately(RemoteLayerBackingStore&, VolatilityMarkingFlags volatilityMarkingFlags = 0);
67     bool markBackingStoreVolatile(RemoteLayerBackingStore&, std::chrono::steady_clock::time_point now);
68
69     HashSet<RemoteLayerBackingStore*> m_liveBackingStore;
70     HashSet<RemoteLayerBackingStore*> m_unparentedBackingStore;
71
72     // Only used during a single flush.
73     HashSet<RemoteLayerBackingStore*> m_reachableBackingStoreInLatestFlush;
74
75     WebCore::Timer m_volatilityTimer;
76
77     bool m_inLayerFlush { false };
78 };
79
80 } // namespace WebKit
81
82 #endif // RemoteLayerBackingStoreCollection_h