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