[rtsan] Remove mkfifoat interceptor (#116997)
[llvm-project.git] / libcxx / include / __cxx03 / memory
blob5bbcd8513e73d53ef0c576b91eeb1d572e63a25c
1 // -*- C++ -*-
2 //===----------------------------------------------------------------------===//
3 //
4 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5 // See https://llvm.org/LICENSE.txt for license information.
6 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //
8 //===----------------------------------------------------------------------===//
10 #ifndef _LIBCPP_MEMORY
11 #define _LIBCPP_MEMORY
13 // clang-format off
16     memory synopsis
18 namespace std
21 struct allocator_arg_t { };
22 inline constexpr allocator_arg_t allocator_arg = allocator_arg_t();
24 template <class T, class Alloc> struct uses_allocator;
26 template <class Ptr>
27 struct pointer_traits
29     typedef Ptr pointer;
30     typedef <details> element_type;
31     typedef <details> difference_type;
33     template <class U> using rebind = <details>;
35     static pointer pointer_to(<details>);
38 template <class T>
39 struct pointer_traits<T*>
41     typedef T* pointer;
42     typedef T element_type;
43     typedef ptrdiff_t difference_type;
45     template <class U> using rebind = U*;
47     static pointer pointer_to(<details>) noexcept; // constexpr in C++20
50 template <class T> constexpr T* to_address(T* p) noexcept; // C++20
51 template <class Ptr> constexpr auto to_address(const Ptr& p) noexcept; // C++20
53 template <class Alloc>
54 struct allocator_traits
56     typedef Alloc                        allocator_type;
57     typedef typename allocator_type::value_type
58                                          value_type;
60     typedef Alloc::pointer | value_type* pointer;
61     typedef Alloc::const_pointer
62           | pointer_traits<pointer>::rebind<const value_type>
63                                          const_pointer;
64     typedef Alloc::void_pointer
65           | pointer_traits<pointer>::rebind<void>
66                                          void_pointer;
67     typedef Alloc::const_void_pointer
68           | pointer_traits<pointer>::rebind<const void>
69                                          const_void_pointer;
70     typedef Alloc::difference_type
71           | pointer_traits<pointer>::difference_type
72                                          difference_type;
73     typedef Alloc::size_type
74           | make_unsigned<difference_type>::type
75                                          size_type;
76     typedef Alloc::propagate_on_container_copy_assignment
77           | false_type                   propagate_on_container_copy_assignment;
78     typedef Alloc::propagate_on_container_move_assignment
79           | false_type                   propagate_on_container_move_assignment;
80     typedef Alloc::propagate_on_container_swap
81           | false_type                   propagate_on_container_swap;
82     typedef Alloc::is_always_equal
83           | is_empty                     is_always_equal;
85     template <class T> using rebind_alloc  = Alloc::rebind<T>::other | Alloc<T, Args...>;
86     template <class T> using rebind_traits = allocator_traits<rebind_alloc<T>>;
88     static pointer allocate(allocator_type& a, size_type n);                          // constexpr and [[nodiscard]] in C++20
89     static pointer allocate(allocator_type& a, size_type n, const_void_pointer hint); // constexpr and [[nodiscard]] in C++20
91     [[nodiscard]] static constexpr allocation_result<pointer, size_type>
92       allocate_at_least(Alloc& a, size_type n);                                 // Since C++23
94     static void deallocate(allocator_type& a, pointer p, size_type n) noexcept; // constexpr in C++20
96     template <class T, class... Args>
97     static void construct(allocator_type& a, T* p, Args&&... args); // constexpr in C++20
99     template <class T>
100     static void destroy(allocator_type& a, T* p); // constexpr in C++20
102     static size_type max_size(const allocator_type& a); // noexcept in C++14, constexpr in C++20
103     static allocator_type select_on_container_copy_construction(const allocator_type& a); // constexpr in C++20
106 template<class Pointer, class SizeType = size_t>
107 struct allocation_result {
108     Pointer ptr;
109     SizeType count;
110 }; // Since C++23
112 template <>
113 class allocator<void> // removed in C++20
115 public:
116     typedef void*                                 pointer;
117     typedef const void*                           const_pointer;
118     typedef void                                  value_type;
120     template <class _Up> struct rebind {typedef allocator<_Up> other;};
123 template <class T>
124 class allocator
126 public:
127     typedef size_t    size_type;
128     typedef ptrdiff_t difference_type;
129     typedef T*        pointer;                           // deprecated in C++17, removed in C++20
130     typedef const T*  const_pointer;                     // deprecated in C++17, removed in C++20
131     typedef typename add_lvalue_reference<T>::type
132                       reference;                         // deprecated in C++17, removed in C++20
133     typedef typename add_lvalue_reference<const T>::type
134                       const_reference;                   // deprecated in C++17, removed in C++20
136     typedef T         value_type;
138     template <class U> struct rebind {typedef allocator<U> other;}; // deprecated in C++17, removed in C++20
140     typedef true_type propagate_on_container_move_assignment;
141     typedef true_type is_always_equal;                   // Deprecated in C++23, removed in C++26
143     constexpr allocator() noexcept;                      // constexpr in C++20
144     constexpr allocator(const allocator&) noexcept;      // constexpr in C++20
145     template <class U>
146       constexpr allocator(const allocator<U>&) noexcept; // constexpr in C++20
147     ~allocator();                                        // constexpr in C++20
148     pointer address(reference x) const noexcept;             // deprecated in C++17, removed in C++20
149     const_pointer address(const_reference x) const noexcept; // deprecated in C++17, removed in C++20
150     T* allocate(size_t n, const void* hint);          // deprecated in C++17, removed in C++20
151     T* allocate(size_t n);                              // constexpr in C++20
152     void deallocate(T* p, size_t n) noexcept;           // constexpr in C++20
153     size_type max_size() const noexcept;              // deprecated in C++17, removed in C++20
154     template<class U, class... Args>
155         void construct(U* p, Args&&... args);         // deprecated in C++17, removed in C++20
156     template <class U>
157         void destroy(U* p);                           // deprecated in C++17, removed in C++20
160 template <class T, class U>
161 bool operator==(const allocator<T>&, const allocator<U>&) noexcept; // constexpr in C++20
163 template <class T, class U>
164 bool operator!=(const allocator<T>&, const allocator<U>&) noexcept; // removed in C++20
166 template <class OutputIterator, class T>
167 class raw_storage_iterator // deprecated in C++17, removed in C++20
168     : public iterator<output_iterator_tag, void, void, void, void> // until C++17
170 public:
171     typedef output_iterator_tag iterator_category;
172     typedef void                value_type;
173     typedef void                difference_type; // until C++20
174     typedef ptrdiff_t           difference_type; // since C++20
175     typedef void                pointer;
176     typedef void                reference;
178     explicit raw_storage_iterator(OutputIterator x);
179     raw_storage_iterator& operator*();
180     raw_storage_iterator& operator=(const T& element);
181     raw_storage_iterator& operator++();
182     raw_storage_iterator  operator++(int);
185 template <class T> pair<T*,ptrdiff_t> get_temporary_buffer(ptrdiff_t n) noexcept;
186 template <class T> void               return_temporary_buffer(T* p) noexcept;
188 template <class T> T* addressof(T& r) noexcept;
189 template <class T> T* addressof(const T&& r) noexcept = delete;
191 template <class InputIterator, class ForwardIterator>
192 ForwardIterator
193 uninitialized_copy(InputIterator first, InputIterator last, ForwardIterator result);
195 namespace ranges {
197 template<class InputIterator, class OutputIterator>
198 using uninitialized_copy_result = in_out_result<InputIterator, OutputIterator>; // since C++20
200 template<input_iterator InputIterator, sentinel-for<InputIterator> Sentinel1, nothrow-forward-iterator OutputIterator, nothrow-sentinel-for<OutputIterator> Sentinel2>
201   requires constructible_from<iter_value_t<OutputIterator>, iter_reference_t<InputIterator>>
202 uninitialized_copy_result<InputIterator, OutputIterator>
203 uninitialized_copy(InputIterator ifirst, Sentinel1 ilast, OutputIterator ofirst, Sentinel2 olast); // since C++20
205 template<input_range InputRange, nothrow-forward-range OutputRange>
206   requires constructible_from<range_value_t<OutputRange>, range_reference_t<InputRange>>
207 uninitialized_copy_result<borrowed_iterator_t<InputRange>, borrowed_iterator_t<OutputRange>>
208 uninitialized_copy(InputRange&& in_range, OutputRange&& out_range); // since C++20
212 template <class InputIterator, class Size, class ForwardIterator>
213 ForwardIterator
214 uninitialized_copy_n(InputIterator first, Size n, ForwardIterator result);
216 namespace ranges {
218 template<class InputIterator, class OutputIterator>
219 using uninitialized_copy_n_result = in_out_result<InputIterator, OutputIterator>; // since C++20
221 template<input_iterator InputIterator, nothrow-forward-iterator OutputIterator, nothrow-sentinel-for<OutputIterator> Sentinel>
222   requires constructible_from<iter_value_t<OutputIterator>, iter_reference_t<InputIterator>>
223 uninitialized_copy_n_result<InputIterator, OutputIterator>
224 uninitialized_copy_n(InputIterator ifirst, iter_difference_t<InputIterator> n, OutputIterator ofirst, Sentinel olast); // since C++20
228 template <class ForwardIterator, class T>
229 void uninitialized_fill(ForwardIterator first, ForwardIterator last, const T& x);
231 namespace ranges {
233 template <nothrow-forward-iterator ForwardIterator, nothrow-sentinel-for<ForwardIterator> Sentinel, class T>
234   requires constructible_from<iter_value_t<ForwardIterator>, const T&>
235 ForwardIterator uninitialized_fill(ForwardIterator first, Sentinel last, const T& x); // since C++20
237 template <nothrow-forward-range ForwardRange, class T>
238   requires constructible_from<range_value_t<ForwardRange>, const T&>
239 borrowed_iterator_t<ForwardRange> uninitialized_fill(ForwardRange&& range, const T& x); // since C++20
243 template <class ForwardIterator, class Size, class T>
244 ForwardIterator
245 uninitialized_fill_n(ForwardIterator first, Size n, const T& x);
247 namespace ranges {
249 template <nothrow-forward-iterator ForwardIterator, class T>
250   requires constructible_from<iter_value_t<ForwardIterator>, const T&>
251 ForwardIterator uninitialized_fill_n(ForwardIterator first, iter_difference_t<ForwardIterator> n); // since C++20
255 template <class T, class ...Args>
256 constexpr T* construct_at(T* location, Args&& ...args); // since C++20
258 namespace ranges {
259   template<class T, class... Args>
260     constexpr T* construct_at(T* location, Args&&... args); // since C++20
263 template <class T>
264 void destroy_at(T* location); // constexpr in C++20
266 namespace ranges {
267   template<destructible T>
268     constexpr void destroy_at(T* location) noexcept; // since C++20
271 template <class ForwardIterator>
272 void destroy(ForwardIterator first, ForwardIterator last); // constexpr in C++20
274 namespace ranges {
275   template<nothrow-input-iterator InputIterator, nothrow-sentinel-for<InputIterator> Sentinel>
276     requires destructible<iter_value_t<InputIterator>>
277     constexpr InputIterator destroy(InputIterator first, Sentinel last) noexcept; // since C++20
278   template<nothrow-input-range InputRange>
279     requires destructible<range_value_t<InputRange>>
280     constexpr borrowed_iterator_t<InputRange> destroy(InputRange&& range) noexcept; // since C++20
283 template <class ForwardIterator, class Size>
284 ForwardIterator destroy_n(ForwardIterator first, Size n); // constexpr in C++20
286 namespace ranges {
287   template<nothrow-input-iterator InputIterator>
288     requires destructible<iter_value_t<InputIterator>>
289     constexpr InputIterator destroy_n(InputIterator first, iter_difference_t<InputIterator> n) noexcept; // since C++20
292 template <class InputIterator, class ForwardIterator>
293  ForwardIterator uninitialized_move(InputIterator first, InputIterator last, ForwardIterator result);
295 namespace ranges {
297 template<class InputIterator, class OutputIterator>
298 using uninitialized_move_result = in_out_result<InputIterator, OutputIterator>; // since C++20
300 template <input_iterator InputIterator, sentinel_for<InputIterator> Sentinel1, nothrow-forward-iterator OutputIterator, nothrow-sentinel-for<O> Sentinel2>
301   requires constructible_from<iter_value_t<OutputIterator>, iter_rvalue_reference_t<InputIterator>>
302 uninitialized_move_result<InputIterator, OutputIterator>
303 uninitialized_move(InputIterator ifirst, Sentinel1 ilast, OutputIterator ofirst, Sentinel2 olast); // since C++20
305 template<input_range InputRange, nothrow-forward-range OutputRange>
306   requires constructible_from<range_value_t<OutputRange>, range_rvalue_reference_t<InputRange>>
307 uninitialized_move_result<borrowed_iterator_t<InputRange>, borrowed_iterator_t<OutputRange>>
308 uninitialized_move(InputRange&& in_range, OutputRange&& out_range); // since C++20
312 template <class InputIterator, class Size, class ForwardIterator>
313  pair<InputIterator,ForwardIterator> uninitialized_move_n(InputIterator first, Size n, ForwardIterator result);
315 namespace ranges {
317 template<class InputIterator, class OutputIterator>
318 using uninitialized_move_n_result = in_out_result<InputIterator, OutputIterator>; // since C++20
320 template<input_iterator InputIterator, nothrow-forward-iterator OutputIterator, nothrow-sentinel-for<OutputIterator> Sentinel>
321   requires constructible_from<iter_value_t<OutputIterator>, iter_rvalue_reference_t<InputIterator>>
322 uninitialized_move_n_result<InputIterator, OutputIterator>
323 uninitialized_move_n(InputIterator ifirst, iter_difference_t<InputIterator> n, OutputIterator ofirst, Sentinel olast); // since C++20
327 template <class ForwardIterator>
328  void uninitialized_value_construct(ForwardIterator first, ForwardIterator last);
330 namespace ranges {
332 template <nothrow-forward-iterator ForwardIterator, nothrow-sentinel-for<ForwardIterator> Sentinel>
333   requires default_initializable<iter_value_t<ForwardIterator>>
334  ForwardIterator uninitialized_value_construct(ForwardIterator first, Sentinel last); // since C++20
336 template <nothrow-forward-range ForwardRange>
337   requires default_initializable<range_value_t<ForwardRange>>
338  borrowed_iterator_t<ForwardRange> uninitialized_value_construct(ForwardRange&& r); // since C++20
342 template <class ForwardIterator, class Size>
343  ForwardIterator uninitialized_value_construct_n(ForwardIterator first, Size n);
345 namespace ranges {
347 template <nothrow-forward-iterator ForwardIterator>
348   requires default_initializable<iter_value_t<ForwardIterator>>
349  ForwardIterator uninitialized_value_construct_n(ForwardIterator first, iter_difference_t<ForwardIterator> n); // since C++20
353 template <class ForwardIterator>
354  void uninitialized_default_construct(ForwardIterator first, ForwardIterator last);
356 namespace ranges {
358 template <nothrow-forward-iterator ForwardIterator, nothrow-sentinel-for<ForwardIterator> Sentinel>
359   requires default_initializable<iter_value_t<ForwardIterator>>
360  ForwardIterator uninitialized_default_construct(ForwardIterator first, Sentinel last); // since C++20
362 template <nothrow-forward-range ForwardRange>
363   requires default_initializable<range_value_t<ForwardRange>>
364  borrowed_iterator_t<ForwardRange> uninitialized_default_construct(ForwardRange&& r); // since C++20
368 template <class ForwardIterator, class Size>
369  ForwardIterator uninitialized_default_construct_n(ForwardIterator first, Size n);
371 namespace ranges {
373 template <nothrow-forward-iterator ForwardIterator>
374   requires default_initializable<iter_value_t<ForwardIterator>>
375  ForwardIterator uninitialized_default_construct_n(ForwardIterator first, iter_difference_t<ForwardIterator> n); // since C++20
379 template <class Y> struct auto_ptr_ref {};      // deprecated in C++11, removed in C++17
381 template<class X>
382 class auto_ptr                                  // deprecated in C++11, removed in C++17
384 public:
385     typedef X element_type;
387     explicit auto_ptr(X* p =0) throw();
388     auto_ptr(auto_ptr&) throw();
389     template<class Y> auto_ptr(auto_ptr<Y>&) throw();
390     auto_ptr& operator=(auto_ptr&) throw();
391     template<class Y> auto_ptr& operator=(auto_ptr<Y>&) throw();
392     auto_ptr& operator=(auto_ptr_ref<X> r) throw();
393     ~auto_ptr() throw();
395     typename add_lvalue_reference<X>::type operator*() const throw();
396     X* operator->() const throw();
397     X* get() const throw();
398     X* release() throw();
399     void reset(X* p =0) throw();
401     auto_ptr(auto_ptr_ref<X>) throw();
402     template<class Y> operator auto_ptr_ref<Y>() throw();
403     template<class Y> operator auto_ptr<Y>() throw();
406 template <class T>
407 struct default_delete
409     constexpr default_delete() noexcept = default;
410     template <class U> constexpr default_delete(const default_delete<U>&) noexcept; // constexpr since C++23
412     constexpr void operator()(T*) const noexcept;                                   // constexpr since C++23
415 template <class T>
416 struct default_delete<T[]>
418     constexpr default_delete() noexcept = default;
419     template <class U> constexpr default_delete(const default_delete <U[]>&) noexcept; // constexpr since C++23
420     constexpr void operator()(T*) const noexcept;                                      // constexpr since C++23
421     template <class U> void operator()(U*) const = delete;
424 template <class T, class D = default_delete<T>>
425 class unique_ptr
427 public:
428     typedef see below pointer;
429     typedef T element_type;
430     typedef D deleter_type;
432     // constructors
433     constexpr unique_ptr() noexcept;
434     constexpr explicit unique_ptr(pointer p) noexcept;           // constexpr since C++23
435     constexpr unique_ptr(pointer p, see below d1) noexcept;      // constexpr since C++23
436     constexpr unique_ptr(pointer p, see below d2) noexcept;      // constexpr since C++23
437     constexpr unique_ptr(unique_ptr&& u) noexcept;               // constexpr since C++23
438     constexpr unique_ptr(nullptr_t) noexcept : unique_ptr() { }
439     template <class U, class E>
440         constexpr unique_ptr(unique_ptr<U, E>&& u) noexcept;     // constexpr since C++23
441     template <class U>
442         unique_ptr(auto_ptr<U>&& u) noexcept;                    // removed in C++17
444     // destructor
445     constexpr ~unique_ptr();                                     // constexpr since C++23
447     // assignment
448     constexpr unique_ptr& operator=(unique_ptr&& u) noexcept;                         // constexpr since C++23
449     template <class U, class E>
450     constexpr unique_ptr& operator=(unique_ptr<U, E>&& u) noexcept;                   // constexpr since C++23
451     constexpr unique_ptr& operator=(nullptr_t) noexcept;                              // constexpr since C++23
453     // observers
454     constexpr
455     add_lvalue_reference<T>::type operator*() const noexcept(see below);              // constexpr since C++23
456     constexpr pointer operator->() const noexcept;                                    // constexpr since C++23
457     constexpr pointer get() const noexcept;                                           // constexpr since C++23
458     constexpr deleter_type& get_deleter() noexcept;                                   // constexpr since C++23
459     constexpr const deleter_type& get_deleter() const noexcept;                       // constexpr since C++23
460     constexpr explicit operator bool() const noexcept;                                // constexpr since C++23
462     // modifiers
463     constexpr pointer release() noexcept;                                             // constexpr since C++23
464     constexpr void reset(pointer p = pointer()) noexcept;                             // constexpr since C++23
465     constexpr void swap(unique_ptr& u) noexcept;                                      // constexpr since C++23
468 template <class T, class D>
469 class unique_ptr<T[], D>
471 public:
472     typedef implementation-defined pointer;
473     typedef T element_type;
474     typedef D deleter_type;
476     // constructors
477     constexpr unique_ptr() noexcept;
478     constexpr explicit unique_ptr(pointer p) noexcept;          // constexpr since C++23
479     constexpr unique_ptr(pointer p, see below d) noexcept;      // constexpr since C++23
480     constexpr unique_ptr(pointer p, see below d) noexcept;      // constexpr since C++23
481     constexpr unique_ptr(unique_ptr&& u) noexcept;              // constexpr since C++23
482     template <class U, class E>
483     constexpr unique_ptr(unique_ptr <U, E>&& u) noexcept;       // constexpr since C++23
484     constexpr unique_ptr(nullptr_t) noexcept : unique_ptr() { }
486     // destructor
487     constexpr ~unique_ptr();                                    // constexpr since C++23
489     // assignment
490     constexpr unique_ptr& operator=(unique_ptr&& u) noexcept;        // constexpr since C++23
491     template <class U, class E>
492     constexpr unique_ptr& operator=(unique_ptr <U, E>&& u) noexcept; // constexpr since C++23
493     constexpr unique_ptr& operator=(nullptr_t) noexcept;             // constexpr since C++23
495     // observers
496     constexpr T& operator[](size_t i) const;                    // constexpr since C++23
497     constexpr pointer get() const noexcept;                     // constexpr since C++23
498     constexpr deleter_type& get_deleter() noexcept;             // constexpr since C++23
499     constexpr const deleter_type& get_deleter() const noexcept; // constexpr since C++23
500     constexpr explicit operator bool() const noexcept;          // constexpr since C++23
502     // modifiers
503     constexpr pointer release() noexcept;                       // constexpr since C++23
504     constexpr void reset(pointer p = pointer()) noexcept;       // constexpr since C++23
505     constexpr void reset(nullptr_t) noexcept;                   // constexpr since C++23
506   template <class U> void reset(U) = delete;
507     constexpr void swap(unique_ptr& u) noexcept;                // constexpr since C++23
510 template <class T, class D>
511     constexpr void swap(unique_ptr<T, D>& x, unique_ptr<T, D>& y) noexcept;                 // constexpr since C++23
513 template <class T1, class D1, class T2, class D2>
514     constexpr bool operator==(const unique_ptr<T1, D1>& x, const unique_ptr<T2, D2>& y);    // constexpr since C++23
515 template <class T1, class D1, class T2, class D2>
516     bool operator!=(const unique_ptr<T1, D1>& x, const unique_ptr<T2, D2>& y);              // removed in C++20
517 template <class T1, class D1, class T2, class D2>
518     bool operator<(const unique_ptr<T1, D1>& x, const unique_ptr<T2, D2>& y);
519 template <class T1, class D1, class T2, class D2>
520     bool operator<=(const unique_ptr<T1, D1>& x, const unique_ptr<T2, D2>& y);
521 template <class T1, class D1, class T2, class D2>
522     bool operator>(const unique_ptr<T1, D1>& x, const unique_ptr<T2, D2>& y);
523 template <class T1, class D1, class T2, class D2>
524     bool operator>=(const unique_ptr<T1, D1>& x, const unique_ptr<T2, D2>& y);
525 template<class T1, class D1, class T2, class D2>
526   requires three_way_comparable_with<typename unique_ptr<T1, D1>::pointer,
527                                      typename unique_ptr<T2, D2>::pointer>
528   compare_three_way_result_t<typename unique_ptr<T1, D1>::pointer,
529                              typename unique_ptr<T2, D2>::pointer>
530     operator<=>(const unique_ptr<T1, D1>& x, const unique_ptr<T2, D2>& y);      // C++20
532 template <class T, class D>
533     constexpr bool operator==(const unique_ptr<T, D>& x, nullptr_t) noexcept;   // constexpr since C++23
534 template <class T, class D>
535     bool operator==(nullptr_t, const unique_ptr<T, D>& y) noexcept;             // removed in C++20
536 template <class T, class D>
537     bool operator!=(const unique_ptr<T, D>& x, nullptr_t) noexcept;             // removed in C++20
538 template <class T, class D>
539     bool operator!=(nullptr_t, const unique_ptr<T, D>& y) noexcept;             // removed in C++20
541 template <class T, class D>
542     constexpr bool operator<(const unique_ptr<T, D>& x, nullptr_t);     // constexpr since C++23
543 template <class T, class D>
544     constexpr bool operator<(nullptr_t, const unique_ptr<T, D>& y);     // constexpr since C++23
545 template <class T, class D>
546     constexpr bool operator<=(const unique_ptr<T, D>& x, nullptr_t);    // constexpr since C++23
547 template <class T, class D>
548     constexpr bool operator<=(nullptr_t, const unique_ptr<T, D>& y);    // constexpr since C++23
549 template <class T, class D>
550     constexpr bool operator>(const unique_ptr<T, D>& x, nullptr_t);     // constexpr since C++23
551 template <class T, class D>
552     constexpr bool operator>(nullptr_t, const unique_ptr<T, D>& y);     // constexpr since C++23
553 template <class T, class D>
554     constexpr bool operator>=(const unique_ptr<T, D>& x, nullptr_t);    // constexpr since C++23
555 template <class T, class D>
556     constexpr bool operator>=(nullptr_t, const unique_ptr<T, D>& y);    // constexpr since C++23
557 template<class T, class D>
558   requires three_way_comparable<typename unique_ptr<T, D>::pointer>
559   compare_three_way_result_t<typename unique_ptr<T, D>::pointer>
560     constexpr operator<=>(const unique_ptr<T, D>& x, nullptr_t);        // C++20, constexpr since C++23
562 class bad_weak_ptr
563     : public std::exception
565     bad_weak_ptr() noexcept;
568 template<class T, class... Args>
569 constexpr unique_ptr<T> make_unique(Args&&... args);                            // C++14, constexpr since C++23
570 template<class T>
571 constexpr unique_ptr<T> make_unique(size_t n);                                  // C++14, constexpr since C++23
572 template<class T, class... Args> unspecified   make_unique(Args&&...) = delete; // C++14, T == U[N]
574 template<class T>
575   constexpr unique_ptr<T> make_unique_for_overwrite();                        // T is not array, C++20, constexpr since C++23
576 template<class T>
577   constexpr unique_ptr<T> make_unique_for_overwrite(size_t n);                // T is U[], C++20, constexpr since C++23
578 template<class T, class... Args>
579   unspecified make_unique_for_overwrite(Args&&...) = delete;                  // T is U[N], C++20
581 template<class E, class T, class Y, class D>
582     basic_ostream<E, T>& operator<< (basic_ostream<E, T>& os, unique_ptr<Y, D> const& p);
584 template<class T>
585 class shared_ptr
587 public:
588     typedef T element_type; // until C++17
589     typedef remove_extent_t<T> element_type; // since C++17
590     typedef weak_ptr<T> weak_type; // C++17
592     // constructors:
593     constexpr shared_ptr() noexcept;
594     template<class Y> explicit shared_ptr(Y* p);
595     template<class Y, class D> shared_ptr(Y* p, D d);
596     template<class Y, class D, class A> shared_ptr(Y* p, D d, A a);
597     template <class D> shared_ptr(nullptr_t p, D d);
598     template <class D, class A> shared_ptr(nullptr_t p, D d, A a);
599     template<class Y> shared_ptr(const shared_ptr<Y>& r, T *p) noexcept;
600     shared_ptr(const shared_ptr& r) noexcept;
601     template<class Y> shared_ptr(const shared_ptr<Y>& r) noexcept;
602     shared_ptr(shared_ptr&& r) noexcept;
603     template<class Y> shared_ptr(shared_ptr<Y>&& r) noexcept;
604     template<class Y> explicit shared_ptr(const weak_ptr<Y>& r);
605     template<class Y> shared_ptr(auto_ptr<Y>&& r);          // removed in C++17
606     template <class Y, class D> shared_ptr(unique_ptr<Y, D>&& r);
607     shared_ptr(nullptr_t) : shared_ptr() { }
609     // destructor:
610     ~shared_ptr();
612     // assignment:
613     shared_ptr& operator=(const shared_ptr& r) noexcept;
614     template<class Y> shared_ptr& operator=(const shared_ptr<Y>& r) noexcept;
615     shared_ptr& operator=(shared_ptr&& r) noexcept;
616     template<class Y> shared_ptr& operator=(shared_ptr<Y>&& r);
617     template<class Y> shared_ptr& operator=(auto_ptr<Y>&& r); // removed in C++17
618     template <class Y, class D> shared_ptr& operator=(unique_ptr<Y, D>&& r);
620     // modifiers:
621     void swap(shared_ptr& r) noexcept;
622     void reset() noexcept;
623     template<class Y> void reset(Y* p);
624     template<class Y, class D> void reset(Y* p, D d);
625     template<class Y, class D, class A> void reset(Y* p, D d, A a);
627     // observers:
628     T* get() const noexcept;
629     T& operator*() const noexcept;
630     T* operator->() const noexcept;
631     long use_count() const noexcept;
632     bool unique() const noexcept;  // deprected in C++17, removed in C++20
633     explicit operator bool() const noexcept;
634     template<class U> bool owner_before(shared_ptr<U> const& b) const noexcept;
635     template<class U> bool owner_before(weak_ptr<U> const& b) const noexcept;
638 template<class T>
639 shared_ptr(weak_ptr<T>) -> shared_ptr<T>;
640 template<class T, class D>
641 shared_ptr(unique_ptr<T, D>) -> shared_ptr<T>;
643 // shared_ptr comparisons:
644 template<class T, class U>
645     bool operator==(shared_ptr<T> const& a, shared_ptr<U> const& b) noexcept;
646 template<class T, class U>
647     bool operator!=(shared_ptr<T> const& a, shared_ptr<U> const& b) noexcept;               // removed in C++20
648 template<class T, class U>
649     bool operator<(shared_ptr<T> const& a, shared_ptr<U> const& b) noexcept;                // removed in C++20
650 template<class T, class U>
651     bool operator>(shared_ptr<T> const& a, shared_ptr<U> const& b) noexcept;                // removed in C++20
652 template<class T, class U>
653     bool operator<=(shared_ptr<T> const& a, shared_ptr<U> const& b) noexcept;               // removed in C++20
654 template<class T, class U>
655     bool operator>=(shared_ptr<T> const& a, shared_ptr<U> const& b) noexcept;               // removed in C++20
656 template<class T, class U>
657     strong_ordering operator<=>(shared_ptr<T> const& a, shared_ptr<U> const& b) noexcept;   // C++20
659 template <class T>
660     bool operator==(const shared_ptr<T>& x, nullptr_t) noexcept;
661 template <class T>
662     bool operator==(nullptr_t, const shared_ptr<T>& y) noexcept;               // removed in C++20
663 template <class T>
664     bool operator!=(const shared_ptr<T>& x, nullptr_t) noexcept;               // removed in C++20
665 template <class T>
666     bool operator!=(nullptr_t, const shared_ptr<T>& y) noexcept;               // removed in C++20
667 template <class T>
668     bool operator<(const shared_ptr<T>& x, nullptr_t) noexcept;                // removed in C++20
669 template <class T>
670     bool operator<(nullptr_t, const shared_ptr<T>& y) noexcept;                // removed in C++20
671 template <class T>
672     bool operator<=(const shared_ptr<T>& x, nullptr_t) noexcept;               // removed in C++20
673 template <class T>
674     bool operator<=(nullptr_t, const shared_ptr<T>& y) noexcept;               // removed in C++20
675 template <class T>
676     bool operator>(const shared_ptr<T>& x, nullptr_t) noexcept;                // removed in C++20
677 template <class T>
678     bool operator>(nullptr_t, const shared_ptr<T>& y) noexcept;                // removed in C++20
679 template <class T>
680     bool operator>=(const shared_ptr<T>& x, nullptr_t) noexcept;               // removed in C++20
681 template <class T>
682     bool operator>=(nullptr_t, const shared_ptr<T>& y) noexcept;               // removed in C++20
683 template<class T>
684     strong_ordering operator<=>(shared_ptr<T> const& x, nullptr_t) noexcept;   // C++20
686 // shared_ptr specialized algorithms:
687 template<class T> void swap(shared_ptr<T>& a, shared_ptr<T>& b) noexcept;
689 // shared_ptr casts:
690 template<class T, class U>
691     shared_ptr<T> static_pointer_cast(shared_ptr<U> const& r) noexcept;
692 template<class T, class U>
693     shared_ptr<T> dynamic_pointer_cast(shared_ptr<U> const& r) noexcept;
694 template<class T, class U>
695     shared_ptr<T> const_pointer_cast(shared_ptr<U> const& r) noexcept;
697 // shared_ptr I/O:
698 template<class E, class T, class Y>
699     basic_ostream<E, T>& operator<< (basic_ostream<E, T>& os, shared_ptr<Y> const& p);
701 // shared_ptr get_deleter:
702 template<class D, class T> D* get_deleter(shared_ptr<T> const& p) noexcept;
704 template<class T, class... Args>
705     shared_ptr<T> make_shared(Args&&... args); // T is not an array
706 template<class T, class A, class... Args>
707     shared_ptr<T> allocate_shared(const A& a, Args&&... args); // T is not an array
709 template<class T>
710     shared_ptr<T> make_shared(size_t N); // T is U[] (since C++20)
711 template<class T, class A>
712     shared_ptr<T> allocate_shared(const A& a, size_t N); // T is U[] (since C++20)
714 template<class T>
715     shared_ptr<T> make_shared(); // T is U[N] (since C++20)
716 template<class T, class A>
717     shared_ptr<T> allocate_shared(const A& a); // T is U[N] (since C++20)
719 template<class T>
720     shared_ptr<T> make_shared(size_t N, const remove_extent_t<T>& u); // T is U[] (since C++20)
721 template<class T, class A>
722     shared_ptr<T> allocate_shared(const A& a, size_t N, const remove_extent_t<T>& u); // T is U[] (since C++20)
724 template<class T> shared_ptr<T>
725     make_shared(const remove_extent_t<T>& u); // T is U[N] (since C++20)
726 template<class T, class A>
727     shared_ptr<T> allocate_shared(const A& a, const remove_extent_t<T>& u); // T is U[N] (since C++20)
729 template<class T>
730   shared_ptr<T> make_shared_for_overwrite();                                  // T is not U[], C++20
731 template<class T, class A>
732   shared_ptr<T> allocate_shared_for_overwrite(const A& a);                    // T is not U[], C++20
734 template<class T>
735   shared_ptr<T> make_shared_for_overwrite(size_t N);                          // T is U[], C++20
736 template<class T, class A>
737   shared_ptr<T> allocate_shared_for_overwrite(const A& a, size_t N);          // T is U[], C++20
739 template<class T>
740 class weak_ptr
742 public:
743     typedef T element_type; // until C++17
744     typedef remove_extent_t<T> element_type; // since C++17
746     // constructors
747     constexpr weak_ptr() noexcept;
748     template<class Y> weak_ptr(shared_ptr<Y> const& r) noexcept;
749     weak_ptr(weak_ptr const& r) noexcept;
750     template<class Y> weak_ptr(weak_ptr<Y> const& r) noexcept;
751     weak_ptr(weak_ptr&& r) noexcept;                      // C++14
752     template<class Y> weak_ptr(weak_ptr<Y>&& r) noexcept; // C++14
754     // destructor
755     ~weak_ptr();
757     // assignment
758     weak_ptr& operator=(weak_ptr const& r) noexcept;
759     template<class Y> weak_ptr& operator=(weak_ptr<Y> const& r) noexcept;
760     template<class Y> weak_ptr& operator=(shared_ptr<Y> const& r) noexcept;
761     weak_ptr& operator=(weak_ptr&& r) noexcept;                      // C++14
762     template<class Y> weak_ptr& operator=(weak_ptr<Y>&& r) noexcept; // C++14
764     // modifiers
765     void swap(weak_ptr& r) noexcept;
766     void reset() noexcept;
768     // observers
769     long use_count() const noexcept;
770     bool expired() const noexcept;
771     shared_ptr<T> lock() const noexcept;
772     template<class U> bool owner_before(shared_ptr<U> const& b) const noexcept;
773     template<class U> bool owner_before(weak_ptr<U> const& b) const noexcept;
776 template<class T>
777 weak_ptr(shared_ptr<T>) -> weak_ptr<T>;
779 // weak_ptr specialized algorithms:
780 template<class T> void swap(weak_ptr<T>& a, weak_ptr<T>& b) noexcept;
782 // class owner_less:
783 template<class T> struct owner_less;
785 template<class T>
786 struct owner_less<shared_ptr<T> >
787     : binary_function<shared_ptr<T>, shared_ptr<T>, bool>
789     typedef bool result_type;
790     bool operator()(shared_ptr<T> const&, shared_ptr<T> const&) const noexcept;
791     bool operator()(shared_ptr<T> const&, weak_ptr<T> const&) const noexcept;
792     bool operator()(weak_ptr<T> const&, shared_ptr<T> const&) const noexcept;
795 template<class T>
796 struct owner_less<weak_ptr<T> >
797     : binary_function<weak_ptr<T>, weak_ptr<T>, bool>
799     typedef bool result_type;
800     bool operator()(weak_ptr<T> const&, weak_ptr<T> const&) const noexcept;
801     bool operator()(shared_ptr<T> const&, weak_ptr<T> const&) const noexcept;
802     bool operator()(weak_ptr<T> const&, shared_ptr<T> const&) const noexcept;
805 template <>  // Added in C++14
806 struct owner_less<void>
808     template <class _Tp, class _Up>
809     bool operator()( shared_ptr<_Tp> const& __x, shared_ptr<_Up> const& __y) const noexcept;
810     template <class _Tp, class _Up>
811     bool operator()( shared_ptr<_Tp> const& __x,   weak_ptr<_Up> const& __y) const noexcept;
812     template <class _Tp, class _Up>
813     bool operator()(   weak_ptr<_Tp> const& __x, shared_ptr<_Up> const& __y) const noexcept;
814     template <class _Tp, class _Up>
815     bool operator()(   weak_ptr<_Tp> const& __x,   weak_ptr<_Up> const& __y) const noexcept;
817     typedef void is_transparent;
820 template<class T>
821 class enable_shared_from_this
823 protected:
824     constexpr enable_shared_from_this() noexcept;
825     enable_shared_from_this(enable_shared_from_this const&) noexcept;
826     enable_shared_from_this& operator=(enable_shared_from_this const&) noexcept;
827     ~enable_shared_from_this();
828 public:
829     shared_ptr<T> shared_from_this();
830     shared_ptr<T const> shared_from_this() const;
833 template<class T>
834     bool atomic_is_lock_free(const shared_ptr<T>* p);
835 template<class T>
836     shared_ptr<T> atomic_load(const shared_ptr<T>* p);
837 template<class T>
838     shared_ptr<T> atomic_load_explicit(const shared_ptr<T>* p, memory_order mo);
839 template<class T>
840     void atomic_store(shared_ptr<T>* p, shared_ptr<T> r);
841 template<class T>
842     void atomic_store_explicit(shared_ptr<T>* p, shared_ptr<T> r, memory_order mo);
843 template<class T>
844     shared_ptr<T> atomic_exchange(shared_ptr<T>* p, shared_ptr<T> r);
845 template<class T>
846     shared_ptr<T>
847     atomic_exchange_explicit(shared_ptr<T>* p, shared_ptr<T> r, memory_order mo);
848 template<class T>
849     bool
850     atomic_compare_exchange_weak(shared_ptr<T>* p, shared_ptr<T>* v, shared_ptr<T> w);
851 template<class T>
852     bool
853     atomic_compare_exchange_strong( shared_ptr<T>* p, shared_ptr<T>* v, shared_ptr<T> w);
854 template<class T>
855     bool
856     atomic_compare_exchange_weak_explicit(shared_ptr<T>* p, shared_ptr<T>* v,
857                                           shared_ptr<T> w, memory_order success,
858                                           memory_order failure);
859 template<class T>
860     bool
861     atomic_compare_exchange_strong_explicit(shared_ptr<T>* p, shared_ptr<T>* v,
862                                             shared_ptr<T> w, memory_order success,
863                                             memory_order failure);
864 // Hash support
865 template <class T> struct hash;
866 template <class T, class D> struct hash<unique_ptr<T, D> >;
867 template <class T> struct hash<shared_ptr<T> >;
869 template <class T, class Alloc>
870   inline constexpr bool uses_allocator_v = uses_allocator<T, Alloc>::value;
872 // [allocator.uses.construction], uses-allocator construction
873 template<class T, class Alloc, class... Args>
874   constexpr auto uses_allocator_construction_args(const Alloc& alloc,             // since C++20
875                                                   Args&&... args) noexcept;
876 template<class T, class Alloc, class Tuple1, class Tuple2>
877   constexpr auto uses_allocator_construction_args(const Alloc& alloc,             // since C++20
878                                                   piecewise_construct_t,
879                                                   Tuple1&& x, Tuple2&& y) noexcept;
880 template<class T, class Alloc>
881   constexpr auto uses_allocator_construction_args(const Alloc& alloc) noexcept;   // since C++20
882 template<class T, class Alloc, class U, class V>
883   constexpr auto uses_allocator_construction_args(const Alloc& alloc,             // since C++20
884                                                   U&& u, V&& v) noexcept;
885 template<class T, class Alloc, class U, class V>
886   constexpr auto uses_allocator_construction_args(const Alloc& alloc,             // since C++23
887                                                   pair<U, V>& pr) noexcept;
888 template<class T, class Alloc, class U, class V>
889   constexpr auto uses_allocator_construction_args(const Alloc& alloc,             // since C++20
890                                                   const pair<U, V>& pr) noexcept;
891 template<class T, class Alloc, class U, class V>
892   constexpr auto uses_allocator_construction_args(const Alloc& alloc,             // since C++20
893                                                   pair<U, V>&& pr) noexcept;
894 template<class T, class Alloc, class U, class V>
895   constexpr auto uses_allocator_construction_args(const Alloc& alloc,             // since C++23
896                                                   const pair<U, V>&& pr) noexcept;
897 template<class T, class Alloc, pair-like P>
898   constexpr auto uses_allocator_construction_args(const Alloc& alloc,             // since C++20
899                                                   P&& p) noexcept;
900 template<class T, class Alloc, class U>
901   constexpr auto uses_allocator_construction_args(const Alloc& alloc,             // since C++20
902                                                   U&& u) noexcept;
903 template<class T, class Alloc, class... Args>
904   constexpr T make_obj_using_allocator(const Alloc& alloc, Args&&... args);       // since C++20
905 template<class T, class Alloc, class... Args>
906   constexpr T* uninitialized_construct_using_allocator(T* p,                      // since C++20
907                                                          const Alloc& alloc, Args&&... args);
909 // [ptr.align]
910 void* align(size_t alignment, size_t size, void*& ptr, size_t& space);
912 template<size_t N, class T>
913 [[nodiscard]] constexpr T* assume_aligned(T* ptr); // since C++20
915 // [out.ptr.t], class template out_ptr_t
916 template<class Smart, class Pointer, class... Args>
917   class out_ptr_t;                                          // since c++23
919 // [out.ptr], function template out_ptr
920 template<class Pointer = void, class Smart, class... Args>
921   auto out_ptr(Smart& s, Args&&... args);                   // since c++23
923 // [inout.ptr.t], class template inout_ptr_t
924 template<class Smart, class Pointer, class... Args>
925   class inout_ptr_t;                                        // since c++23
927 // [inout.ptr], function template inout_ptr
928 template<class Pointer = void, class Smart, class... Args>
929   auto inout_ptr(Smart& s, Args&&... args);                 // since c++23
931 }  // std
935 // clang-format on
937 #include <__cxx03/__config>
938 #include <__cxx03/__memory/addressof.h>
939 #include <__cxx03/__memory/align.h>
940 #include <__cxx03/__memory/allocator.h>
941 #include <__cxx03/__memory/allocator_arg_t.h>
942 #include <__cxx03/__memory/allocator_traits.h>
943 #include <__cxx03/__memory/auto_ptr.h>
944 #include <__cxx03/__memory/inout_ptr.h>
945 #include <__cxx03/__memory/out_ptr.h>
946 #include <__cxx03/__memory/pointer_traits.h>
947 #include <__cxx03/__memory/raw_storage_iterator.h>
948 #include <__cxx03/__memory/shared_ptr.h>
949 #include <__cxx03/__memory/temporary_buffer.h>
950 #include <__cxx03/__memory/uninitialized_algorithms.h>
951 #include <__cxx03/__memory/unique_ptr.h>
952 #include <__cxx03/__memory/uses_allocator.h>
954 // standard-mandated includes
956 #if _LIBCPP_STD_VER >= 17
957 #  include <__cxx03/__memory/construct_at.h>
958 #endif
960 #if _LIBCPP_STD_VER >= 20
961 #  include <__cxx03/__memory/assume_aligned.h>
962 #  include <__cxx03/__memory/concepts.h>
963 #  include <__cxx03/__memory/ranges_construct_at.h>
964 #  include <__cxx03/__memory/ranges_uninitialized_algorithms.h>
965 #  include <__cxx03/__memory/uses_allocator_construction.h>
966 #endif
968 #if _LIBCPP_STD_VER >= 23
969 #  include <__cxx03/__memory/allocate_at_least.h>
970 #endif
972 #include <__cxx03/version>
974 // [memory.syn]
975 #include <__cxx03/compare>
977 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
978 #  pragma GCC system_header
979 #endif
981 #if !defined(_LIBCPP_REMOVE_TRANSITIVE_INCLUDES) && _LIBCPP_STD_VER <= 20
982 #  include <__cxx03/atomic>
983 #  include <__cxx03/concepts>
984 #  include <__cxx03/cstddef>
985 #  include <__cxx03/cstdint>
986 #  include <__cxx03/cstdlib>
987 #  include <__cxx03/cstring>
988 #  include <__cxx03/iosfwd>
989 #  include <__cxx03/iterator>
990 #  include <__cxx03/new>
991 #  include <__cxx03/stdexcept>
992 #  include <__cxx03/tuple>
993 #  include <__cxx03/type_traits>
994 #  include <__cxx03/typeinfo>
995 #  include <__cxx03/utility>
996 #endif
998 #endif // _LIBCPP_MEMORY