Use WordLock instead of std::mutex for Threading
[WebKit-https.git] / Source / WTF / wtf / ThreadGroup.h
1 /*
2  * Copyright (C) 2017 Yusuke Suzuki <utatane.tea@gmail.com>.
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 <memory>
29 #include <wtf/ListHashSet.h>
30 #include <wtf/Lock.h>
31 #include <wtf/Threading.h>
32
33 namespace WTF {
34
35 enum class ThreadGroupAddResult { NewlyAdded, AlreadyAdded, NotAdded };
36
37 class ThreadGroup : public std::enable_shared_from_this<ThreadGroup> {
38     WTF_MAKE_FAST_ALLOCATED;
39     WTF_MAKE_NONCOPYABLE(ThreadGroup);
40 public:
41     friend class Thread;
42
43     static std::shared_ptr<ThreadGroup> create()
44     {
45         return std::make_shared<ThreadGroup>();
46     }
47
48     WTF_EXPORT_PRIVATE ThreadGroupAddResult add(Thread&);
49     WTF_EXPORT_PRIVATE ThreadGroupAddResult add(const AbstractLocker&, Thread&);
50     WTF_EXPORT_PRIVATE ThreadGroupAddResult addCurrentThread();
51
52     const ListHashSet<Ref<Thread>>& threads(const AbstractLocker&) const { return m_threads; }
53
54     WordLock& getLock() { return m_lock; }
55
56     WTF_EXPORT_PRIVATE ~ThreadGroup();
57
58     ThreadGroup() = default;
59
60 private:
61     std::weak_ptr<ThreadGroup> weakFromThis()
62     {
63         return shared_from_this();
64     }
65
66     // We use WordLock since it can be used when deallocating TLS.
67     WordLock m_lock;
68     ListHashSet<Ref<Thread>> m_threads;
69 };
70
71 }
72
73 using WTF::ThreadGroup;
74 using WTF::ThreadGroupAddResult;