1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/*
* Copyright (C) 2010, 2015 Apple Inc. All rights reserved.
* Portions Copyright (c) 2010 Motorola Mobility, Inc. All rights reserved.
* Copyright (C) 2017 Sony Interactive Entertainment Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include <wtf/Forward.h>
#include <wtf/FunctionDispatcher.h>
#include <wtf/Seconds.h>
#include <wtf/ThreadSafetyAnalysis.h>
#include <wtf/Threading.h>
#if USE(COCOA_EVENT_LOOP)
#include <dispatch/dispatch.h>
#include <wtf/OSObjectPtr.h>
#else
#include <wtf/RunLoop.h>
#endif
namespace WTF {
class WorkQueueBase : public FunctionDispatcher, public ThreadSafeRefCounted<WorkQueueBase> {
public:
using QOS = Thread::QOS;
~WorkQueueBase() override;
WTF_EXPORT_PRIVATE void dispatch(Function<void()>&&) override;
WTF_EXPORT_PRIVATE void dispatchWithQOS(Function<void()>&&, QOS);
WTF_EXPORT_PRIVATE virtual void dispatchAfter(Seconds, Function<void()>&&);
WTF_EXPORT_PRIVATE virtual void dispatchSync(Function<void()>&&);
#if USE(COCOA_EVENT_LOOP)
dispatch_queue_t dispatchQueue() const { return m_dispatchQueue.get(); }
#endif
protected:
enum class Type : bool {
Serial,
Concurrent
};
WorkQueueBase(const char* name, Type, QOS);
#if USE(COCOA_EVENT_LOOP)
explicit WorkQueueBase(OSObjectPtr<dispatch_queue_t>&&);
#else
explicit WorkQueueBase(RunLoop&);
#endif
void platformInitialize(const char* name, Type, QOS);
void platformInvalidate();
#if USE(COCOA_EVENT_LOOP)
OSObjectPtr<dispatch_queue_t> m_dispatchQueue;
#else
RunLoop* m_runLoop;
#if ASSERT_ENABLED
uint32_t m_threadID { 0 };
#endif
#endif
};
/**
* A WorkQueue is a function dispatching interface like FunctionDispatcher.
* Runnables dispatched to a WorkQueue are required to execute serially.
* That is, two different runnables dispatched to the WorkQueue should never be allowed to execute simultaneously.
* They may be executed on different threads but can safely be used by objects that aren't already threadsafe.
* Use `assertIsCurrent(m_myQueue);` in a runnable to assert that the runnable runs in a specific queue.
*/
class WTF_CAPABILITY("is current") WorkQueue : public WorkQueueBase {
public:
WTF_EXPORT_PRIVATE static WorkQueue& main();
WTF_EXPORT_PRIVATE static Ref<WorkQueue> create(const char* name, QOS = QOS::Default);
#if !USE(COCOA_EVENT_LOOP)
RunLoop& runLoop() const { return *m_runLoop; }
#endif
protected:
WorkQueue(const char* name, QOS qos)
: WorkQueueBase(name, Type::Serial, qos)
{
}
private:
#if USE(COCOA_EVENT_LOOP)
explicit WorkQueue(OSObjectPtr<dispatch_queue_t>&&);
#else
explicit WorkQueue(RunLoop&);
#endif
static Ref<WorkQueue> constructMainWorkQueue();
#if ASSERT_ENABLED
WTF_EXPORT_PRIVATE void assertIsCurrent() const;
friend void assertIsCurrent(const WorkQueue&);
#endif
};
inline void assertIsCurrent(const WorkQueue& workQueue) WTF_ASSERTS_ACQUIRED_CAPABILITY(workQueue)
{
#if ASSERT_ENABLED
workQueue.assertIsCurrent();
#else
UNUSED_PARAM(workQueue);
#endif
}
/**
* A ConcurrentWorkQueue unlike a WorkQueue doesn't guarantee the order in which the dispatched runnable will run
* and each can run concurrently on different threads.
*/
class ConcurrentWorkQueue final : public WorkQueueBase {
public:
WTF_EXPORT_PRIVATE static Ref<ConcurrentWorkQueue> create(const char* name, QOS = QOS::Default);
WTF_EXPORT_PRIVATE static void apply(size_t iterations, WTF::Function<void(size_t index)>&&);
private:
ConcurrentWorkQueue(const char* name, QOS qos)
: WorkQueueBase(name, Type::Concurrent, qos)
{
}
};
}
using WTF::WorkQueue;
using WTF::ConcurrentWorkQueue;
using WTF::assertIsCurrent;
|
