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
33namespace WebKit {
34
35class RemoteLayerBackingStore;
36class RemoteLayerTreeContext;
37class RemoteLayerTreeTransaction;
38
39class RemoteLayerBackingStoreCollection {
40    WTF_MAKE_NONCOPYABLE(RemoteLayerBackingStoreCollection);
41    WTF_MAKE_FAST_ALLOCATED;
42public:
43    RemoteLayerBackingStoreCollection();
44
45    void backingStoreWasCreated(RemoteLayerBackingStore&);
46    void backingStoreWillBeDestroyed(RemoteLayerBackingStore&);
47
48    void backingStoreWillBeDisplayed(RemoteLayerBackingStore&);
49    void backingStoreBecameUnreachable(RemoteLayerBackingStore&);
50
51    void willFlushLayers();
52    void willCommitLayerTree(RemoteLayerTreeTransaction&);
53    void didFlushLayers();
54
55    void volatilityTimerFired(WebCore::Timer<RemoteLayerBackingStoreCollection>&);
56    bool markAllBackingStoreVolatileImmediatelyIfPossible();
57
58    void scheduleVolatilityTimer();
59
60private:
61    enum VolatilityMarkingFlag {
62        MarkBuffersIgnoringReachability = 1 << 0
63    };
64    typedef unsigned VolatilityMarkingFlags;
65    bool markBackingStoreVolatileImmediately(RemoteLayerBackingStore&, VolatilityMarkingFlags volatilityMarkingFlags = 0);
66    bool markBackingStoreVolatile(RemoteLayerBackingStore&, std::chrono::steady_clock::time_point now);
67
68    HashSet<RemoteLayerBackingStore*> m_liveBackingStore;
69    HashSet<RemoteLayerBackingStore*> m_unparentedBackingStore;
70    HashSet<RemoteLayerBackingStore*> m_reachableBackingStoreInLatestFlush;
71
72    WebCore::Timer<RemoteLayerBackingStoreCollection> m_volatilityTimer;
73
74    bool m_inLayerFlush;
75};
76
77} // namespace WebKit
78
79#endif // RemoteLayerBackingStoreCollection_h
80