1 // <memory> -*- C++ -*-
3 // Copyright (C) 2001-2019 Free Software Foundation, Inc.
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 3, or (at your option)
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
26 * Copyright (c) 1997-1999
27 * Silicon Graphics Computer Systems, Inc.
29 * Permission to use, copy, modify, distribute and sell this software
30 * and its documentation for any purpose is hereby granted without fee,
31 * provided that the above copyright notice appear in all copies and
32 * that both that copyright notice and this permission notice appear
33 * in supporting documentation. Silicon Graphics makes no
34 * representations about the suitability of this software for any
35 * purpose. It is provided "as is" without express or implied warranty.
39 /** @file include/memory
40 * This is a Standard C++ Library header.
43 #ifndef _GLIBCXX_MEMORY
44 #define _GLIBCXX_MEMORY 1
46 #pragma GCC system_header
49 * @defgroup memory Memory
52 * Components for memory allocation, deallocation, and management.
56 * @defgroup pointer_abstractions Pointer Abstractions
59 * Smart pointers, etc.
62 #include <bits/stl_algobase.h>
63 #include <bits/allocator.h>
64 #include <bits/stl_construct.h>
65 #include <bits/stl_uninitialized.h>
66 #include <bits/stl_tempbuf.h>
67 #include <bits/stl_raw_storage_iter.h>
69 #if __cplusplus >= 201103L
70 # include <exception> // std::exception
71 # include <typeinfo> // std::type_info in get_deleter
72 # include <iosfwd> // std::basic_ostream
73 # include <ext/atomicity.h>
74 # include <ext/concurrence.h>
75 # include <bits/functexcept.h>
76 # include <bits/stl_function.h> // std::less
77 # include <bits/uses_allocator.h>
78 # include <type_traits>
79 # include <debug/debug.h>
80 # include <bits/unique_ptr.h>
81 # include <bits/shared_ptr.h>
82 # include <bits/shared_ptr_atomic.h>
83 # if _GLIBCXX_USE_DEPRECATED
84 # include <backward/auto_ptr.h>
87 # include <backward/auto_ptr.h>
90 #if __cplusplus >= 201103L
92 #if __cplusplus > 201703L
93 # include <bit> // for ispow2
94 # include <new> // for placement operator new
95 # include <tuple> // for tuple, make_tuple, make_from_tuple
97 namespace std _GLIBCXX_VISIBILITY(default)
99 _GLIBCXX_BEGIN_NAMESPACE_VERSION
102 * @brief Fit aligned storage in buffer.
106 * This function tries to fit @a __size bytes of storage with alignment
107 * @a __align into the buffer @a __ptr of size @a __space bytes. If such
108 * a buffer fits then @a __ptr is changed to point to the first byte of the
109 * aligned storage and @a __space is reduced by the bytes used for alignment.
111 * @param __align A fundamental or extended alignment value.
112 * @param __size Size of the aligned storage required.
113 * @param __ptr Pointer to a buffer of @a __space bytes.
114 * @param __space Size of the buffer pointed to by @a __ptr.
115 * @return the updated pointer if the aligned storage fits, otherwise nullptr.
118 align(size_t __align, size_t __size, void*& __ptr, size_t& __space) noexcept
120 #ifdef _GLIBCXX_USE_C99_STDINT_TR1
121 const auto __intptr = reinterpret_cast<uintptr_t>(__ptr);
123 // Cannot use std::uintptr_t so assume that std::size_t can be used instead.
124 static_assert(sizeof(size_t) >= sizeof(void*),
125 "std::size_t must be a suitable substitute for std::uintptr_t");
126 const auto __intptr = reinterpret_cast<unsigned long long>(__ptr);
128 const auto __aligned = (__intptr - 1u + __align) & -__align;
129 const auto __diff = __aligned - __intptr;
130 if ((__size + __diff) > __space)
135 return __ptr = reinterpret_cast<void*>(__aligned);
139 // 20.7.4 [util.dynamic.safety], pointer safety
141 enum class pointer_safety { relaxed, preferred, strict };
144 declare_reachable(void*) { }
146 template <typename _Tp>
148 undeclare_reachable(_Tp* __p) { return __p; }
151 declare_no_pointers(char*, size_t) { }
154 undeclare_no_pointers(char*, size_t) { }
156 inline pointer_safety
157 get_pointer_safety() noexcept { return pointer_safety::relaxed; }
159 #if __cplusplus > 201703L
160 /// Inform the compiler that a pointer is aligned.
161 template<size_t _Align, class _Tp>
162 [[nodiscard,__gnu__::__always_inline__]]
163 constexpr _Tp* assume_aligned(_Tp* __ptr)
165 static_assert(std::ispow2(_Align));
166 _GLIBCXX_DEBUG_ASSERT((std::uintptr_t)__ptr % _Align == 0);
167 return static_cast<_Tp*>(__builtin_assume_aligned(__ptr, _Align));
171 #if __cplusplus > 201703L
172 template<typename _Tp>
173 struct __is_pair : false_type { };
174 template<typename _Tp, typename _Up>
175 struct __is_pair<pair<_Tp, _Up>> : true_type { };
176 template<typename _Tp, typename _Up>
177 struct __is_pair<const pair<_Tp, _Up>> : true_type { };
179 template<typename _Tp, typename __ = _Require<__not_<__is_pair<_Tp>>>,
180 typename _Alloc, typename... _Args>
182 __uses_alloc_args(const _Alloc& __a, _Args&&... __args) noexcept
184 if constexpr (uses_allocator_v<remove_cv_t<_Tp>, _Alloc>)
186 if constexpr (is_constructible_v<_Tp, allocator_arg_t,
187 const _Alloc&, _Args...>)
189 return tuple<allocator_arg_t, const _Alloc&, _Args&&...>(
190 allocator_arg, __a, std::forward<_Args>(__args)...);
194 static_assert(is_constructible_v<_Tp, _Args..., const _Alloc&>);
196 return tuple<_Args&&..., const _Alloc&>(
197 std::forward<_Args>(__args)..., __a);
202 static_assert(is_constructible_v<_Tp, _Args...>);
204 return tuple<_Args&&...>(std::forward<_Args>(__args)...);
209 template<typename _Tp>
210 concept bool _Std_pair = __is_pair<_Tp>::value;
213 // This is a temporary workaround until -fconcepts is implied by -std=gnu++2a
215 # define _GLIBCXX_STD_PAIR_CONSTRAINT(T) _Std_pair T
216 # define _GLIBCXX_STD_PAIR_CONSTRAINT_(T) _Std_pair T
218 # define _GLIBCXX_STD_PAIR_CONSTRAINT(T) \
219 typename T, typename __ = _Require<__is_pair<T>>
220 # define _GLIBCXX_STD_PAIR_CONSTRAINT_(T) typename T, typename
223 template<typename _Tp,
225 typename __ = _Require<__not_<__is_pair<_Tp>>>,
227 typename _Alloc, typename... _Args>
229 uses_allocator_construction_args(const _Alloc& __a,
230 _Args&&... __args) noexcept
232 requires ! _Std_pair<_Tp>
235 return std::__uses_alloc_args<_Tp>(__a, std::forward<_Args>(__args)...);
238 template<_GLIBCXX_STD_PAIR_CONSTRAINT(_Tp), typename _Alloc,
239 typename _Tuple1, typename _Tuple2>
241 uses_allocator_construction_args(const _Alloc& __a, piecewise_construct_t,
242 _Tuple1&& __x, _Tuple2&& __y) noexcept;
244 template<_GLIBCXX_STD_PAIR_CONSTRAINT(_Tp), typename _Alloc>
246 uses_allocator_construction_args(const _Alloc&) noexcept;
248 template<_GLIBCXX_STD_PAIR_CONSTRAINT(_Tp), typename _Alloc,
249 typename _Up, typename _Vp>
251 uses_allocator_construction_args(const _Alloc&, _Up&&, _Vp&&) noexcept;
253 template<_GLIBCXX_STD_PAIR_CONSTRAINT(_Tp), typename _Alloc,
254 typename _Up, typename _Vp>
256 uses_allocator_construction_args(const _Alloc&,
257 const pair<_Up, _Vp>&) noexcept;
259 template<_GLIBCXX_STD_PAIR_CONSTRAINT(_Tp), typename _Alloc,
260 typename _Up, typename _Vp>
262 uses_allocator_construction_args(const _Alloc&, pair<_Up, _Vp>&&) noexcept;
264 template<_GLIBCXX_STD_PAIR_CONSTRAINT_(_Tp), typename _Alloc,
265 typename _Tuple1, typename _Tuple2>
267 uses_allocator_construction_args(const _Alloc& __a, piecewise_construct_t,
268 _Tuple1&& __x, _Tuple2&& __y) noexcept
270 using _Tp1 = typename _Tp::first_type;
271 using _Tp2 = typename _Tp::second_type;
273 return std::make_tuple(piecewise_construct,
274 std::apply([&__a](auto&&... __args1) {
275 return std::uses_allocator_construction_args<_Tp1>(
276 __a, std::forward<decltype(__args1)>(__args1)...);
277 }, std::forward<_Tuple1>(__x)),
278 std::apply([&__a](auto&&... __args2) {
279 return std::uses_allocator_construction_args<_Tp2>(
280 __a, std::forward<decltype(__args2)>(__args2)...);
281 }, std::forward<_Tuple2>(__y)));
284 template<_GLIBCXX_STD_PAIR_CONSTRAINT_(_Tp), typename _Alloc>
286 uses_allocator_construction_args(const _Alloc& __a) noexcept
288 using _Tp1 = typename _Tp::first_type;
289 using _Tp2 = typename _Tp::second_type;
291 return std::make_tuple(piecewise_construct,
292 std::uses_allocator_construction_args<_Tp1>(__a),
293 std::uses_allocator_construction_args<_Tp2>(__a));
296 template<_GLIBCXX_STD_PAIR_CONSTRAINT_(_Tp), typename _Alloc,
297 typename _Up, typename _Vp>
299 uses_allocator_construction_args(const _Alloc& __a, _Up&& __u, _Vp&& __v)
302 using _Tp1 = typename _Tp::first_type;
303 using _Tp2 = typename _Tp::second_type;
305 return std::make_tuple(piecewise_construct,
306 std::uses_allocator_construction_args<_Tp1>(__a,
307 std::forward<_Up>(__u)),
308 std::uses_allocator_construction_args<_Tp2>(__a,
309 std::forward<_Vp>(__v)));
312 template<_GLIBCXX_STD_PAIR_CONSTRAINT_(_Tp), typename _Alloc,
313 typename _Up, typename _Vp>
315 uses_allocator_construction_args(const _Alloc& __a,
316 const pair<_Up, _Vp>& __pr) noexcept
318 using _Tp1 = typename _Tp::first_type;
319 using _Tp2 = typename _Tp::second_type;
321 return std::make_tuple(piecewise_construct,
322 std::uses_allocator_construction_args<_Tp1>(__a, __pr.first),
323 std::uses_allocator_construction_args<_Tp2>(__a, __pr.second));
326 template<_GLIBCXX_STD_PAIR_CONSTRAINT_(_Tp), typename _Alloc,
327 typename _Up, typename _Vp>
329 uses_allocator_construction_args(const _Alloc& __a,
330 pair<_Up, _Vp>&& __pr) noexcept
332 using _Tp1 = typename _Tp::first_type;
333 using _Tp2 = typename _Tp::second_type;
335 return std::make_tuple(piecewise_construct,
336 std::uses_allocator_construction_args<_Tp1>(__a,
337 std::move(__pr).first),
338 std::uses_allocator_construction_args<_Tp2>(__a,
339 std::move(__pr).second));
342 template<typename _Tp, typename _Alloc, typename... _Args>
344 make_obj_using_allocator(const _Alloc& __a, _Args&&... __args)
346 return std::make_from_tuple<_Tp>(uses_allocator_construction_args<_Tp>(
347 __a, std::forward<_Args>(__args)...));
350 template<typename _Tp, typename _Alloc, typename... _Args>
352 uninitialized_construct_using_allocator(_Tp* __p, const _Alloc& __a,
355 void* __vp = const_cast<void*>(static_cast<const volatile void*>(__p));
356 return ::new(__vp) _Tp(std::make_obj_using_allocator<_Tp>(__a,
357 std::forward<_Args>(__args)...));
362 _GLIBCXX_END_NAMESPACE_VERSION
366 #if __cplusplus > 201402L
367 // Parallel STL algorithms
368 # if __PSTL_EXECUTION_POLICIES_DEFINED
369 // If <execution> has already been included, pull in implementations
370 # include <pstl/glue_memory_impl.h>
372 // Otherwise just pull in forward declarations
373 # include <pstl/glue_memory_defs.h>
376 // Feature test macro for parallel algorithms
377 # define __cpp_lib_parallel_algorithm 201703L
380 #endif /* _GLIBCXX_MEMORY */