Code quality cleanup in NeverDestroyed
[WebKit-https.git] / Source / WTF / wtf / NeverDestroyed.h
1 /*
2  * Copyright (C) 2013-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. 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 #pragma once
27
28 #include <type_traits>
29 #include <utility>
30 #include <wtf/ForbidHeapAllocation.h>
31 #include <wtf/RefCounted.h>
32
33 // NeverDestroyed is a smart-pointer-like class that ensures that the destructor
34 // for the given object is never called, but doesn't use the heap to allocate it.
35 // It's useful for static local variables, and can be used like so:
36 //
37 // MySharedGlobal& mySharedGlobal()
38 // {
39 //   static NeverDestroyed<MySharedGlobal> myGlobal("Hello", 42);
40 //   return myGlobal;
41 // }
42
43 namespace WTF {
44
45 template<typename T> class NeverDestroyed {
46     WTF_MAKE_NONCOPYABLE(NeverDestroyed);
47     WTF_FORBID_HEAP_ALLOCATION;
48 public:
49
50     template<typename... Args> NeverDestroyed(Args&&... args)
51     {
52         MaybeRelax<T>(new (storagePointer()) T(std::forward<Args>(args)...));
53     }
54
55     NeverDestroyed(NeverDestroyed&& other)
56     {
57         MaybeRelax<T>(new (storagePointer()) T(WTFMove(*other.storagePointer())));
58     }
59
60     operator T&() { return *storagePointer(); }
61     T& get() { return *storagePointer(); }
62
63     operator const T&() const { return *storagePointer(); }
64     const T& get() const { return *storagePointer(); }
65
66 private:
67     using PointerType = typename std::remove_const<T>::type*;
68
69     PointerType storagePointer() const { return const_cast<PointerType>(reinterpret_cast<const T*>(&m_storage)); }
70
71     template<typename PtrType, bool ShouldRelax = std::is_base_of<RefCountedBase, PtrType>::value> struct MaybeRelax {
72         explicit MaybeRelax(PtrType*) { }
73     };
74     template<typename PtrType> struct MaybeRelax<PtrType, true> {
75         explicit MaybeRelax(PtrType* ptr) { ptr->relaxAdoptionRequirement(); }
76     };
77
78     // FIXME: Investigate whether we should allocate a hunk of virtual memory
79     // and hand out chunks of it to NeverDestroyed instead, to reduce fragmentation.
80     typename std::aligned_storage<sizeof(T), std::alignment_of<T>::value>::type m_storage;
81 };
82
83 template<typename T> NeverDestroyed<T> makeNeverDestroyed(T&&);
84
85 // FIXME: It's messy to have to repeat the whole class just to make this "lazy" version.
86 // Should revisit clients to see if we really need this, and perhaps use templates to
87 // share more of the code with the main NeverDestroyed above.
88 template<typename T> class LazyNeverDestroyed {
89     WTF_MAKE_NONCOPYABLE(LazyNeverDestroyed);
90     WTF_FORBID_HEAP_ALLOCATION;
91 public:
92     LazyNeverDestroyed() = default;
93
94     template<typename... Args>
95     void construct(Args&&... args)
96     {
97         ASSERT(!m_isConstructed);
98
99 #if !ASSERT_DISABLED
100         m_isConstructed = true;
101 #endif
102
103         MaybeRelax<T>(new (storagePointer()) T(std::forward<Args>(args)...));
104     }
105
106     operator T&() { return *storagePointer(); }
107     T& get() { return *storagePointer(); }
108
109     T* operator->() { return storagePointer(); }
110
111     operator const T&() const { return *storagePointer(); }
112     const T& get() const { return *storagePointer(); }
113
114     const T* operator->() const { return storagePointer(); }
115
116 #if !ASSERT_DISABLED
117     bool isConstructed() const { return m_isConstructed; }
118 #endif
119
120 private:
121     using PointerType = typename std::remove_const<T>::type*;
122
123     PointerType storagePointer() const
124     {
125         ASSERT(m_isConstructed);
126         return const_cast<PointerType>(reinterpret_cast<const T*>(&m_storage));
127     }
128
129     template<typename PtrType, bool ShouldRelax = std::is_base_of<RefCountedBase, PtrType>::value> struct MaybeRelax {
130         explicit MaybeRelax(PtrType*) { }
131     };
132     template<typename PtrType> struct MaybeRelax<PtrType, true> {
133         explicit MaybeRelax(PtrType* ptr) { ptr->relaxAdoptionRequirement(); }
134     };
135
136 #if !ASSERT_DISABLED
137     // LazyNeverDestroyed objects are always static, so this variable is initialized to false.
138     // It must not be initialized dynamically; that would not be thread safe.
139     bool m_isConstructed;
140 #endif
141
142     // FIXME: Investigate whether we should allocate a hunk of virtual memory
143     // and hand out chunks of it to NeverDestroyed instead, to reduce fragmentation.
144     typename std::aligned_storage<sizeof(T), std::alignment_of<T>::value>::type m_storage;
145 };
146
147 template<typename T> inline NeverDestroyed<T> makeNeverDestroyed(T&& argument)
148 {
149     return WTFMove(argument);
150 }
151
152 } // namespace WTF;
153
154 using WTF::LazyNeverDestroyed;
155 using WTF::NeverDestroyed;
156 using WTF::makeNeverDestroyed;