df8b36e24315654815e3e30d02f1b514eca8164a
[WebKit-https.git] / Source / WebCore / platform / mac / SharedTimerMac.mm
1 /*
2  * Copyright (C) 2006, 2010 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 COMPUTER, 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 COMPUTER, 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 #import "config.h"
27 #import "SharedTimer.h"
28
29 #import <IOKit/IOMessage.h>
30 #import <IOKit/pwr_mgt/IOPMLib.h>
31 #import <wtf/Assertions.h>
32 #import <wtf/Noncopyable.h>
33 #import <wtf/PassOwnPtr.h>
34 #import <wtf/UnusedParam.h>
35
36 #include <stdio.h>
37
38 // On Snow Leopard and newer we'll ask IOKit to deliver notifications on a queue.
39 #if !PLATFORM(IOS) && __MAC_OS_X_VERSION_MIN_REQUIRED == 1050
40 #define IOKIT_WITHOUT_LIBDISPATCH 1
41 #endif
42
43 namespace WebCore {
44
45 static const CFTimeInterval distantFuture = 60 * 60 * 24 * 365 * 10; // Decade.
46
47 static void (*sharedTimerFiredFunction)();
48 static void timerFired(CFRunLoopTimerRef, void*);
49
50 #if !defined(IOKIT_WITHOUT_LIBDISPATCH) && !PLATFORM(IOS) && __MAC_OS_X_VERSION_MAX_ALLOWED == 1060
51 extern "C" void IONotificationPortSetDispatchQueue(IONotificationPortRef notify, dispatch_queue_t queue);
52 #endif
53
54 class PowerObserver {
55     WTF_MAKE_NONCOPYABLE(PowerObserver);
56     
57 public:
58     static PassOwnPtr<PowerObserver> create()
59     {
60         return adoptPtr(new PowerObserver);
61     }
62     ~PowerObserver();
63
64 private:
65     PowerObserver();
66
67     static void didReceiveSystemPowerNotification(void* context, io_service_t, uint32_t messageType, void* messageArgument);
68     void didReceiveSystemPowerNotification(io_service_t, uint32_t messageType, void* messageArgument);
69
70     void restartSharedTimer();
71
72     io_connect_t m_powerConnection;
73     IONotificationPortRef m_notificationPort;
74     io_object_t m_notifierReference;
75 #ifdef IOKIT_WITHOUT_LIBDISPATCH
76     CFRunLoopSourceRef m_runLoopSource;
77 #else
78     dispatch_queue_t m_dispatchQueue;
79 #endif
80 };
81
82 PowerObserver::PowerObserver()
83     : m_powerConnection(0)
84     , m_notificationPort(0)
85     , m_notifierReference(0)
86 #ifdef IOKIT_WITHOUT_LIBDISPATCH
87     , m_runLoopSource(0)    
88 #else
89     , m_dispatchQueue(dispatch_queue_create("com.apple.WebKit.PowerObserver", 0))
90 #endif
91 {
92     m_powerConnection = IORegisterForSystemPower(this, &m_notificationPort, didReceiveSystemPowerNotification, &m_notifierReference);
93     if (!m_powerConnection)
94         return;
95
96 #ifdef IOKIT_WITHOUT_LIBDISPATCH
97     m_runLoopSource = IONotificationPortGetRunLoopSource(m_notificationPort);
98     CFRunLoopAddSource(CFRunLoopGetMain(), m_runLoopSource, kCFRunLoopCommonModes);
99 #else
100     IONotificationPortSetDispatchQueue(m_notificationPort, m_dispatchQueue);
101 #endif
102 }
103
104 PowerObserver::~PowerObserver()
105 {
106     if (!m_powerConnection)
107         return;
108
109 #ifdef IOKIT_WITHOUT_LIBDISPATCH
110     CFRunLoopRemoveSource(CFRunLoopGetMain(), m_runLoopSource, kCFRunLoopCommonModes);
111 #else
112     dispatch_release(m_dispatchQueue);
113 #endif
114
115     IODeregisterForSystemPower(&m_notifierReference);
116     IOServiceClose(m_powerConnection);
117     IONotificationPortDestroy(m_notificationPort);
118 }
119
120 void PowerObserver::didReceiveSystemPowerNotification(void* context, io_service_t service, uint32_t messageType, void* messageArgument)
121 {
122     static_cast<PowerObserver*>(context)->didReceiveSystemPowerNotification(service, messageType, messageArgument);
123 }
124
125 void PowerObserver::didReceiveSystemPowerNotification(io_service_t, uint32_t messageType, void* messageArgument)
126 {
127     IOAllowPowerChange(m_powerConnection, reinterpret_cast<long>(messageArgument));
128
129     // We only care about the "wake from sleep" message.
130     if (messageType != kIOMessageSystemWillPowerOn)
131         return;
132
133 #ifdef IOKIT_WITHOUT_LIBDISPATCH
134     restartSharedTimer();
135 #else
136     // We need to restart the timer on the main thread.
137     CFRunLoopPerformBlock(CFRunLoopGetMain(), kCFRunLoopCommonModes, ^() {
138         restartSharedTimer();
139     });
140 #endif
141 }
142
143 void PowerObserver::restartSharedTimer()
144 {
145     ASSERT(CFRunLoopGetCurrent() == CFRunLoopGetMain());
146
147     stopSharedTimer();
148     timerFired(0, 0);
149 }
150
151 static CFRunLoopTimerRef sharedTimer()
152 {
153     static CFRunLoopTimerRef timer;
154     static dispatch_once_t onceToken;
155     dispatch_once(&onceToken, ^{
156         timer = CFRunLoopTimerCreate(0, CFAbsoluteTimeGetCurrent() + distantFuture, distantFuture, 0, 0, timerFired, 0);
157         CFRunLoopAddTimer(CFRunLoopGetCurrent(), timer, kCFRunLoopCommonModes);
158
159         static PowerObserver* powerObserver;
160         powerObserver = PowerObserver::create().leakPtr();
161     });
162     return timer;
163 };
164
165 void setSharedTimerFiredFunction(void (*f)())
166 {
167     ASSERT(!sharedTimerFiredFunction || sharedTimerFiredFunction == f);
168
169     sharedTimerFiredFunction = f;
170 }
171
172 static void timerFired(CFRunLoopTimerRef, void*)
173 {
174     // FIXME: We can remove this global catch-all if we fix <rdar://problem/5299018>.
175     NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
176     sharedTimerFiredFunction();
177     [pool drain];
178 }
179
180 void setSharedTimerFireInterval(double interval)
181 {
182     ASSERT(sharedTimerFiredFunction);
183     CFAbsoluteTime fireDate = CFAbsoluteTimeGetCurrent() + interval;
184     CFRunLoopTimerSetNextFireDate(sharedTimer(), fireDate);
185 }
186
187 void stopSharedTimer()
188 {
189     CFRunLoopTimerSetNextFireDate(sharedTimer(), CFAbsoluteTimeGetCurrent() + distantFuture);
190 }
191
192 } // namespace WebCore