xref: /llvm-project-15.0.7/libcxx/src/memory.cpp (revision f08de52d)
1 //===------------------------ memory.cpp ----------------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is dual licensed under the MIT and the University of Illinois Open
6 // Source Licenses. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #define _LIBCPP_BUILDING_MEMORY
11 #include "memory"
12 #ifndef _LIBCPP_HAS_NO_THREADS
13 #include "mutex"
14 #include "thread"
15 #endif
16 #include "include/atomic_support.h"
17 
18 _LIBCPP_BEGIN_NAMESPACE_STD
19 
20 const allocator_arg_t allocator_arg = allocator_arg_t();
21 
22 bad_weak_ptr::~bad_weak_ptr() _NOEXCEPT {}
23 
24 const char*
25 bad_weak_ptr::what() const _NOEXCEPT
26 {
27     return "bad_weak_ptr";
28 }
29 
30 __shared_count::~__shared_count()
31 {
32 }
33 
34 __shared_weak_count::~__shared_weak_count()
35 {
36 }
37 
38 void
39 __shared_count::__add_shared() _NOEXCEPT
40 {
41     __libcpp_atomic_refcount_increment(__shared_owners_);
42 }
43 
44 bool
45 __shared_count::__release_shared() _NOEXCEPT
46 {
47     if (__libcpp_atomic_refcount_decrement(__shared_owners_) == -1)
48     {
49         __on_zero_shared();
50         return true;
51     }
52     return false;
53 }
54 
55 void
56 __shared_weak_count::__add_shared() _NOEXCEPT
57 {
58     __shared_count::__add_shared();
59 }
60 
61 void
62 __shared_weak_count::__add_weak() _NOEXCEPT
63 {
64     __libcpp_atomic_refcount_increment(__shared_weak_owners_);
65 }
66 
67 void
68 __shared_weak_count::__release_shared() _NOEXCEPT
69 {
70     if (__shared_count::__release_shared())
71         __release_weak();
72 }
73 
74 void
75 __shared_weak_count::__release_weak() _NOEXCEPT
76 {
77     // NOTE: The acquire load here is an optimization of the very
78     // common case where a shared pointer is being destructed while
79     // having no other contended references.
80     //
81     // BENEFIT: We avoid expensive atomic stores like XADD and STREX
82     // in a common case.  Those instructions are slow and do nasty
83     // things to caches.
84     //
85     // IS THIS SAFE?  Yes.  During weak destruction, if we see that we
86     // are the last reference, we know that no-one else is accessing
87     // us. If someone were accessing us, then they would be doing so
88     // while the last shared / weak_ptr was being destructed, and
89     // that's undefined anyway.
90     //
91     // If we see anything other than a 0, then we have possible
92     // contention, and need to use an atomicrmw primitive.
93     // The same arguments don't apply for increment, where it is legal
94     // (though inadvisable) to share shared_ptr references between
95     // threads, and have them all get copied at once.  The argument
96     // also doesn't apply for __release_shared, because an outstanding
97     // weak_ptr::lock() could read / modify the shared count.
98     if (__libcpp_atomic_load(&__shared_weak_owners_, _AO_Acquire) == 0)
99     {
100         // no need to do this store, because we are about
101         // to destroy everything.
102         //__libcpp_atomic_store(&__shared_weak_owners_, -1, _AO_Release);
103         __on_zero_shared_weak();
104     }
105     else if (__libcpp_atomic_refcount_decrement(__shared_weak_owners_) == -1)
106         __on_zero_shared_weak();
107 }
108 
109 __shared_weak_count*
110 __shared_weak_count::lock() _NOEXCEPT
111 {
112     long object_owners = __libcpp_atomic_load(&__shared_owners_);
113     while (object_owners != -1)
114     {
115         if (__libcpp_atomic_compare_exchange(&__shared_owners_,
116                                              &object_owners,
117                                              object_owners+1))
118             return this;
119     }
120     return 0;
121 }
122 
123 #if !defined(_LIBCPP_NO_RTTI) || !defined(_LIBCPP_BUILD_STATIC)
124 
125 const void*
126 __shared_weak_count::__get_deleter(const type_info&) const _NOEXCEPT
127 {
128     return 0;
129 }
130 
131 #endif  // _LIBCPP_NO_RTTI
132 
133 #if !defined(_LIBCPP_HAS_NO_ATOMIC_HEADER)
134 
135 _LIBCPP_SAFE_STATIC static const std::size_t __sp_mut_count = 16;
136 _LIBCPP_SAFE_STATIC static __libcpp_mutex_t mut_back[__sp_mut_count] =
137 {
138     _LIBCPP_MUTEX_INITIALIZER, _LIBCPP_MUTEX_INITIALIZER, _LIBCPP_MUTEX_INITIALIZER, _LIBCPP_MUTEX_INITIALIZER,
139     _LIBCPP_MUTEX_INITIALIZER, _LIBCPP_MUTEX_INITIALIZER, _LIBCPP_MUTEX_INITIALIZER, _LIBCPP_MUTEX_INITIALIZER,
140     _LIBCPP_MUTEX_INITIALIZER, _LIBCPP_MUTEX_INITIALIZER, _LIBCPP_MUTEX_INITIALIZER, _LIBCPP_MUTEX_INITIALIZER,
141     _LIBCPP_MUTEX_INITIALIZER, _LIBCPP_MUTEX_INITIALIZER, _LIBCPP_MUTEX_INITIALIZER, _LIBCPP_MUTEX_INITIALIZER
142 };
143 
144 _LIBCPP_CONSTEXPR __sp_mut::__sp_mut(void* p) _NOEXCEPT
145    : __lx(p)
146 {
147 }
148 
149 void
150 __sp_mut::lock() _NOEXCEPT
151 {
152     auto m = static_cast<__libcpp_mutex_t*>(__lx);
153     unsigned count = 0;
154     while (__libcpp_mutex_trylock(m) != 0)
155     {
156         if (++count > 16)
157         {
158             __libcpp_mutex_lock(m);
159             break;
160         }
161         this_thread::yield();
162     }
163 }
164 
165 void
166 __sp_mut::unlock() _NOEXCEPT
167 {
168     __libcpp_mutex_unlock(static_cast<__libcpp_mutex_t*>(__lx));
169 }
170 
171 __sp_mut&
172 __get_sp_mut(const void* p)
173 {
174     static __sp_mut muts[__sp_mut_count]
175     {
176         &mut_back[ 0], &mut_back[ 1], &mut_back[ 2], &mut_back[ 3],
177         &mut_back[ 4], &mut_back[ 5], &mut_back[ 6], &mut_back[ 7],
178         &mut_back[ 8], &mut_back[ 9], &mut_back[10], &mut_back[11],
179         &mut_back[12], &mut_back[13], &mut_back[14], &mut_back[15]
180     };
181     return muts[hash<const void*>()(p) & (__sp_mut_count-1)];
182 }
183 
184 #endif // !defined(_LIBCPP_HAS_NO_ATOMIC_HEADER)
185 
186 void
187 declare_reachable(void*)
188 {
189 }
190 
191 void
192 declare_no_pointers(char*, size_t)
193 {
194 }
195 
196 void
197 undeclare_no_pointers(char*, size_t)
198 {
199 }
200 
201 #if !defined(_LIBCPP_ABI_POINTER_SAFETY_ENUM_TYPE)
202 pointer_safety get_pointer_safety() _NOEXCEPT
203 {
204     return pointer_safety::relaxed;
205 }
206 #endif
207 
208 void*
209 __undeclare_reachable(void* p)
210 {
211     return p;
212 }
213 
214 void*
215 align(size_t alignment, size_t size, void*& ptr, size_t& space)
216 {
217     void* r = nullptr;
218     if (size <= space)
219     {
220         char* p1 = static_cast<char*>(ptr);
221         char* p2 = reinterpret_cast<char*>(reinterpret_cast<size_t>(p1 + (alignment - 1)) & -alignment);
222         size_t d = static_cast<size_t>(p2 - p1);
223         if (d <= space - size)
224         {
225             r = p2;
226             ptr = r;
227             space -= d;
228         }
229     }
230     return r;
231 }
232 
233 _LIBCPP_END_NAMESPACE_STD
234