Use NeverDestroyed instead of DEPRECATED_DEFINE_STATIC_LOCAL
[WebKit-https.git] / Source / WTF / wtf / RunLoop.cpp
1 /*
2  * Copyright (C) 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 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 #include "config.h"
27 #include "RunLoop.h"
28
29 #include <wtf/NeverDestroyed.h>
30 #include <wtf/StdLibExtras.h>
31 #include <wtf/ThreadSpecific.h>
32
33 namespace WTF {
34
35 static RunLoop* s_mainRunLoop;
36
37 // Helper class for ThreadSpecificData.
38 class RunLoop::Holder {
39 public:
40     Holder()
41         : m_runLoop(adoptRef(*new RunLoop))
42     {
43     }
44
45     RunLoop& runLoop() { return m_runLoop; }
46
47 private:
48     Ref<RunLoop> m_runLoop;
49 };
50
51 void RunLoop::initializeMainRunLoop()
52 {
53     if (s_mainRunLoop)
54         return;
55     s_mainRunLoop = &RunLoop::current();
56 }
57
58 RunLoop& RunLoop::current()
59 {
60     static NeverDestroyed<ThreadSpecific<Holder>> runLoopHolder;
61     return runLoopHolder.get()->runLoop();
62 }
63
64 RunLoop& RunLoop::main()
65 {
66     ASSERT(s_mainRunLoop);
67     return *s_mainRunLoop;
68 }
69
70 bool RunLoop::isMain()
71 {
72     ASSERT(s_mainRunLoop);
73     return s_mainRunLoop == &RunLoop::current();
74 }
75
76 void RunLoop::performWork()
77 {
78     // It is important to handle the functions in the queue one at a time because while inside one of these
79     // functions we might re-enter RunLoop::performWork() and we need to be able to pick up where we left off.
80     // See http://webkit.org/b/89590 for more discussion.
81
82     // One possible scenario when handling the function queue is as follows:
83     // - RunLoop::performWork() is invoked with 1 function on the queue
84     // - Handling that function results in 1 more function being enqueued
85     // - Handling that one results in yet another being enqueued
86     // - And so on
87     //
88     // In this situation one invocation of performWork() never returns so all other event sources are blocked.
89     // By only handling up to the number of functions that were in the queue when performWork() is called
90     // we guarantee to occasionally return from the run loop so other event sources will be allowed to spin.
91
92     size_t functionsToHandle = 0;
93     {
94         std::function<void()> function;
95         {
96             MutexLocker locker(m_functionQueueLock);
97             functionsToHandle = m_functionQueue.size();
98
99             if (m_functionQueue.isEmpty())
100                 return;
101
102             function = m_functionQueue.takeFirst();
103         }
104
105         function();
106     }
107
108     for (size_t functionsHandled = 1; functionsHandled < functionsToHandle; ++functionsHandled) {
109         std::function<void()> function;
110         {
111             MutexLocker locker(m_functionQueueLock);
112
113             // Even if we start off with N functions to handle and we've only handled less than N functions, the queue
114             // still might be empty because those functions might have been handled in an inner RunLoop::performWork().
115             // In that case we should bail here.
116             if (m_functionQueue.isEmpty())
117                 break;
118
119             function = m_functionQueue.takeFirst();
120         }
121         
122         function();
123     }
124 }
125
126 void RunLoop::dispatch(std::function<void ()> function)
127 {
128     {
129         MutexLocker locker(m_functionQueueLock);
130         m_functionQueue.append(WTFMove(function));
131     }
132
133     wakeUp();
134 }
135
136 } // namespace WTF