Unreviewed, rolling out r234489.
[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     NeverDestroyed(NeverDestroyed&& other)
54     {
55         MaybeRelax<T>(new (storagePointer()) T(WTFMove(*other.storagePointer())));
56     }
57
58     operator T&() { return *storagePointer(); }
59     T& get() { return *storagePointer(); }
60
61     operator const T&() const { return *storagePointer(); }
62     const T& get() const { return *storagePointer(); }
63
64 private:
65     using PointerType = typename std::remove_const<T>::type*;
66
67     PointerType storagePointer() const { return const_cast<PointerType>(reinterpret_cast<const T*>(&m_storage)); }
68
69     // FIXME: Investigate whether we should allocate a hunk of virtual memory
70     // and hand out chunks of it to NeverDestroyed instead, to reduce fragmentation.
71     typename std::aligned_storage<sizeof(T), std::alignment_of<T>::value>::type m_storage;
72
73     template<typename PtrType, bool ShouldRelax = std::is_base_of<RefCountedBase, PtrType>::value> struct MaybeRelax {
74         explicit MaybeRelax(PtrType*) { }
75     };
76     template<typename PtrType> struct MaybeRelax<PtrType, true> {
77         explicit MaybeRelax(PtrType* ptr) { ptr->relaxAdoptionRequirement(); }
78     };
79 };
80
81 template<typename T> NeverDestroyed<T> makeNeverDestroyed(T&&);
82
83 // FIXME: It's messy to have to repeat the whole class just to make this "lazy" version.
84 // Should revisit clients to see if we really need this, and perhaps use templates to
85 // share more of the code with the main NeverDestroyed above.
86 template<typename T> class LazyNeverDestroyed {
87     WTF_MAKE_NONCOPYABLE(LazyNeverDestroyed);
88
89 public:
90     LazyNeverDestroyed() = default;
91
92     template<typename... Args>
93     void construct(Args&&... args)
94     {
95         ASSERT(!m_isConstructed);
96
97 #if !ASSERT_DISABLED
98         m_isConstructed = true;
99 #endif
100
101         MaybeRelax<T>(new (storagePointer()) T(std::forward<Args>(args)...));
102     }
103
104     operator T&() { return *storagePointer(); }
105     T& get() { return *storagePointer(); }
106
107     T* operator->() { return storagePointer(); }
108
109     operator const T&() const { return *storagePointer(); }
110     const T& get() const { return *storagePointer(); }
111
112     const T* operator->() const { return storagePointer(); }
113
114 #if !ASSERT_DISABLED
115     bool isConstructed() const { return m_isConstructed; }
116 #endif
117
118 private:
119     using PointerType = typename std::remove_const<T>::type*;
120
121     PointerType storagePointer() const
122     {
123         ASSERT(m_isConstructed);
124         return const_cast<PointerType>(reinterpret_cast<const T*>(&m_storage));
125     }
126
127     // FIXME: Investigate whether we should allocate a hunk of virtual memory
128     // and hand out chunks of it to NeverDestroyed instead, to reduce fragmentation.
129     typename std::aligned_storage<sizeof(T), std::alignment_of<T>::value>::type m_storage;
130
131     template<typename PtrType, bool ShouldRelax = std::is_base_of<RefCountedBase, PtrType>::value> struct MaybeRelax {
132         explicit MaybeRelax(PtrType*) { }
133     };
134     template<typename PtrType> struct MaybeRelax<PtrType, true> {
135         explicit MaybeRelax(PtrType* ptr) { ptr->relaxAdoptionRequirement(); }
136     };
137
138 #if !ASSERT_DISABLED
139     // LazyNeverDestroyed objects are always static, so this variable is initialized to false.
140     // It must not be initialized dynamically; that would not be thread safe.
141     bool m_isConstructed;
142 #endif
143 };
144
145 template<typename T> inline NeverDestroyed<T> makeNeverDestroyed(T&& argument)
146 {
147     return WTFMove(argument);
148 }
149
150 } // namespace WTF;
151
152 using WTF::LazyNeverDestroyed;
153 using WTF::NeverDestroyed;
154 using WTF::makeNeverDestroyed;