6651672739eb9dca8f1ffcdbe735beda5af17240
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSRunLoopTimer.h
1 /*
2  * Copyright (C) 2012, 2015-2017 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 #pragma once
27
28 #include <wtf/HashSet.h>
29 #include <wtf/Lock.h>
30 #include <wtf/RefPtr.h>
31 #include <wtf/RetainPtr.h>
32 #include <wtf/RunLoop.h>
33 #include <wtf/SharedTask.h>
34 #include <wtf/ThreadSafeRefCounted.h>
35
36 #if USE(CF)
37 #include <CoreFoundation/CoreFoundation.h>
38 #endif
39
40 namespace JSC {
41
42 class JSLock;
43 class VM;
44
45 class JSRunLoopTimer : public ThreadSafeRefCounted<JSRunLoopTimer> {
46 public:
47     typedef void TimerNotificationType();
48     using TimerNotificationCallback = RefPtr<WTF::SharedTask<TimerNotificationType>>;
49
50     class Manager {
51 #if USE(CF)
52         static void timerDidFireCallback(CFRunLoopTimerRef, void*);
53 #else
54         void timerDidFireCallback();
55 #endif
56
57         void timerDidFire();
58
59     public:
60         using EpochTime = Seconds;
61
62         static Manager& shared();
63         void registerVM(VM&);
64         void unregisterVM(VM&);
65         void scheduleTimer(JSRunLoopTimer&, Seconds nextFireTime);
66         void cancelTimer(JSRunLoopTimer&);
67
68         std::optional<Seconds> timeUntilFire(JSRunLoopTimer&);
69
70 #if USE(CF)
71         void didChangeRunLoop(VM&, CFRunLoopRef newRunLoop);
72 #endif
73
74     private:
75         Lock m_lock;
76
77         struct PerVMData {
78             PerVMData() = default;
79 #if USE(CF)
80             PerVMData(Manager&) { }
81 #else
82             PerVMData(Manager&);
83 #endif
84             PerVMData(PerVMData&&) = default;
85             PerVMData& operator=(PerVMData&&) = default;
86
87             ~PerVMData();
88
89 #if USE(CF)
90             void setRunLoop(Manager*, CFRunLoopRef);
91             RetainPtr<CFRunLoopTimerRef> timer;
92             RetainPtr<CFRunLoopRef> runLoop;
93             CFRunLoopTimerContext context;
94 #else
95             RunLoop* runLoop;
96             std::unique_ptr<RunLoop::Timer<Manager>> timer;
97 #endif
98             Vector<std::pair<Ref<JSRunLoopTimer>, EpochTime>> timers;
99         };
100
101         HashMap<Ref<JSLock>, PerVMData> m_mapping;
102     };
103
104     JSRunLoopTimer(VM*);
105     JS_EXPORT_PRIVATE virtual ~JSRunLoopTimer();
106     virtual void doWork(VM&) = 0;
107
108     void setTimeUntilFire(Seconds intervalInSeconds);
109     void cancelTimer();
110     bool isScheduled() const { return m_isScheduled; }
111
112     // Note: The only thing the timer notification callback cannot do is
113     // call setTimeUntilFire(). This will cause a deadlock. It would not
114     // be hard to make this work, however, there are no clients that need
115     // this behavior. We should implement it only if we find that we need it.
116     JS_EXPORT_PRIVATE void addTimerSetNotification(TimerNotificationCallback);
117     JS_EXPORT_PRIVATE void removeTimerSetNotification(TimerNotificationCallback);
118
119     JS_EXPORT_PRIVATE std::optional<Seconds> timeUntilFire();
120
121 protected:
122     static const Seconds s_decade;
123     Ref<JSLock> m_apiLock;
124
125 private:
126     friend class Manager;
127
128     void timerDidFire();
129
130     HashSet<TimerNotificationCallback> m_timerSetCallbacks;
131     Lock m_timerCallbacksLock;
132
133     Lock m_lock;
134     bool m_isScheduled { false };
135 };
136     
137 } // namespace JSC