1/*
2 * Copyright (C) 2014 Igalia S.L.
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. AND ITS CONTRIBUTORS ``AS IS''
14 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23 * THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#pragma once
27
28#if USE(COORDINATED_GRAPHICS)
29
30#include <wtf/Atomics.h>
31#include <wtf/Condition.h>
32#include <wtf/FastMalloc.h>
33#include <wtf/Function.h>
34#include <wtf/NeverDestroyed.h>
35#include <wtf/Noncopyable.h>
36#include <wtf/RunLoop.h>
37
38namespace WebKit {
39
40class CompositingRunLoop {
41 WTF_MAKE_NONCOPYABLE(CompositingRunLoop);
42 WTF_MAKE_FAST_ALLOCATED;
43public:
44 CompositingRunLoop(Function<void ()>&&);
45 ~CompositingRunLoop();
46
47 void performTask(Function<void ()>&&);
48 void performTaskSync(Function<void ()>&&);
49
50 void suspend();
51 void resume();
52
53 Lock& stateLock() { return m_state.lock; }
54
55 void scheduleUpdate();
56 void scheduleUpdate(LockHolder&);
57 void stopUpdates();
58
59 void updateCompleted(LockHolder&);
60
61private:
62 enum class UpdateState {
63 Idle,
64 Scheduled,
65 InProgress,
66 };
67
68 void updateTimerFired();
69
70 RunLoop* m_runLoop { nullptr };
71 RunLoop::Timer<CompositingRunLoop> m_updateTimer;
72 Function<void ()> m_updateFunction;
73 Lock m_dispatchSyncConditionMutex;
74 Condition m_dispatchSyncCondition;
75
76 struct {
77 Lock lock;
78 UpdateState update { UpdateState::Idle };
79 bool pendingUpdate { false };
80 bool isSuspended { false };
81 } m_state;
82};
83
84} // namespace WebKit
85
86#endif // USE(COORDINATED_GRAPHICS)
87