Source/WebCore:
[WebKit-https.git] / Source / WTF / wtf / NeverDestroyed.h
1 /*
2  * Copyright (C) 2013 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 #ifndef NeverDestroyed_h
27 #define NeverDestroyed_h
28
29 #include <type_traits>
30 #include <utility>
31 #include <wtf/Noncopyable.h>
32 #include <wtf/RefCounted.h>
33
34 // NeverDestroyed is a smart pointer like class who ensures that the destructor
35 // for the given object is never called, but doesn't use the heap to allocate it.
36 // It's useful for static local variables, and can be used like so:
37 //
38 // MySharedGlobal& mySharedGlobal()
39 // {
40 //   static NeverDestroyed<MySharedGlobal> myGlobal("Hello", 42);
41 //   return myGlobal;
42 // }
43
44 namespace WTF {
45
46 template<typename T> class NeverDestroyed {
47     WTF_MAKE_NONCOPYABLE(NeverDestroyed);
48
49 public:
50     template<typename... Args>
51     NeverDestroyed(Args&&... args)
52     {
53         MaybeRelax<T>(new (asPtr()) T(std::forward<Args>(args)...));
54     }
55
56     operator T&() { return *asPtr(); }
57     T& get() { return *asPtr(); }
58
59 private:
60     typedef typename std::remove_const<T>::type* PointerType;
61
62     PointerType asPtr() { return reinterpret_cast<PointerType>(&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> class LazyNeverDestroyed {
77     WTF_MAKE_NONCOPYABLE(LazyNeverDestroyed);
78
79 public:
80     LazyNeverDestroyed() = default;
81
82     template<typename... Args>
83     void construct(Args&&... args)
84     {
85         ASSERT(!m_isConstructed);
86
87 #if !ASSERT_DISABLED
88         m_isConstructed = true;
89 #endif
90
91         MaybeRelax<T>(new (asPtr()) T(std::forward<Args>(args)...));
92     }
93
94     operator T&() { return *asPtr(); }
95     T& get() { return *asPtr(); }
96
97     T* operator->() { return asPtr(); }
98
99 private:
100     typedef typename std::remove_const<T>::type* PointerType;
101
102     PointerType asPtr()
103     {
104         ASSERT(m_isConstructed);
105
106         return reinterpret_cast<PointerType>(&m_storage);
107     }
108
109     // FIXME: Investigate whether we should allocate a hunk of virtual memory
110     // and hand out chunks of it to NeverDestroyed instead, to reduce fragmentation.
111     typename std::aligned_storage<sizeof(T), std::alignment_of<T>::value>::type m_storage;
112
113     template <typename PtrType, bool ShouldRelax = std::is_base_of<RefCountedBase, PtrType>::value> struct MaybeRelax {
114         explicit MaybeRelax(PtrType*) { }
115     };
116     template <typename PtrType> struct MaybeRelax<PtrType, true> {
117         explicit MaybeRelax(PtrType* ptr) { ptr->relaxAdoptionRequirement(); }
118     };
119
120 #if !ASSERT_DISABLED
121     // LazyNeverDestroyed objects are always static, so this variable is initialized to false.
122     // It must not be initialized dynamically, because that would not be thread safe.
123     bool m_isConstructed;
124 #endif
125 };
126
127 } // namespace WTF;
128
129 using WTF::LazyNeverDestroyed;
130 using WTF::NeverDestroyed;
131
132 #endif // NeverDestroyed_h