1 // Allocators -*- C++ -*- 2 3 // Copyright (C) 2001-2022 Free Software Foundation, Inc. 4 // 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) 9 // any later version. 10 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. 15 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. 19 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/>. 24 25 /* 26 * Copyright (c) 1996-1997 27 * Silicon Graphics Computer Systems, Inc. 28 * 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. 36 */ 37 38 /** @file bits/allocator.h 39 * This is an internal header file, included by other library headers. 40 * Do not attempt to use it directly. @headername{memory} 41 */ 42 43 #ifndef _ALLOCATOR_H 44 #define _ALLOCATOR_H 1 45 46 #include <bits/c++allocator.h> // Define the base class to std::allocator. 47 #include <bits/memoryfwd.h> 48 #if __cplusplus >= 201103L 49 #include <type_traits> 50 #endif 51 52 #define __cpp_lib_incomplete_container_elements 201505L 53 54 namespace std _GLIBCXX_VISIBILITY(default) 55 { 56 _GLIBCXX_BEGIN_NAMESPACE_VERSION 57 58 /** 59 * @addtogroup allocators 60 * @{ 61 */ 62 63 // Since C++20 the primary template should be used for allocator<void>, 64 // but then it would have a non-trivial default ctor and dtor for C++20, 65 // but trivial for C++98-17, which would be an ABI incompatibiliy between 66 // different standard dialects. So C++20 still uses the allocator<void> 67 // explicit specialization, with the historical ABI properties, but with 68 // the same members that are present in the primary template. 69 70 /// allocator<void> specialization. 71 template<> 72 class allocator<void> 73 { 74 public: 75 typedef void value_type; 76 typedef size_t size_type; 77 typedef ptrdiff_t difference_type; 78 79 #if __cplusplus <= 201703L 80 // These were removed for C++20, allocator_traits does the right thing. 81 typedef void* pointer; 82 typedef const void* const_pointer; 83 84 template<typename _Tp1> 85 struct rebind 86 { typedef allocator<_Tp1> other; }; 87 #endif 88 89 #if __cplusplus >= 201103L 90 // _GLIBCXX_RESOLVE_LIB_DEFECTS 91 // 2103. std::allocator propagate_on_container_move_assignment 92 using propagate_on_container_move_assignment = true_type; 93 94 using is_always_equal 95 _GLIBCXX20_DEPRECATED_SUGGEST("std::allocator_traits::is_always_equal") 96 = true_type; 97 98 #if __cplusplus >= 202002L 99 // As noted above, these members are present for C++20 to provide the 100 // same API as the primary template, but still trivial as in pre-C++20. 101 allocator() = default; 102 ~allocator() = default; 103 104 template<typename _Up> 105 constexpr 106 allocator(const allocator<_Up>&) noexcept { } 107 108 // No allocate member because it's ill-formed by LWG 3307. 109 // No deallocate member because it would be undefined to call it 110 // with any pointer which wasn't obtained from allocate. 111 #endif // C++20 112 #endif // C++11 113 }; 114 115 /** 116 * @brief The @a standard allocator, as per C++03 [20.4.1]. 117 * 118 * See https://gcc.gnu.org/onlinedocs/libstdc++/manual/memory.html#std.util.memory.allocator 119 * for further details. 120 * 121 * @tparam _Tp Type of allocated object. 122 */ 123 template<typename _Tp> 124 class allocator : public __allocator_base<_Tp> 125 { 126 public: 127 typedef _Tp value_type; 128 typedef size_t size_type; 129 typedef ptrdiff_t difference_type; 130 131 #if __cplusplus <= 201703L 132 // These were removed for C++20. 133 typedef _Tp* pointer; 134 typedef const _Tp* const_pointer; 135 typedef _Tp& reference; 136 typedef const _Tp& const_reference; 137 138 template<typename _Tp1> 139 struct rebind 140 { typedef allocator<_Tp1> other; }; 141 #endif 142 143 #if __cplusplus >= 201103L 144 // _GLIBCXX_RESOLVE_LIB_DEFECTS 145 // 2103. std::allocator propagate_on_container_move_assignment 146 using propagate_on_container_move_assignment = true_type; 147 148 using is_always_equal 149 _GLIBCXX20_DEPRECATED_SUGGEST("std::allocator_traits::is_always_equal") 150 = true_type; 151 #endif 152 153 // _GLIBCXX_RESOLVE_LIB_DEFECTS 154 // 3035. std::allocator's constructors should be constexpr 155 _GLIBCXX20_CONSTEXPR 156 allocator() _GLIBCXX_NOTHROW { } 157 158 _GLIBCXX20_CONSTEXPR 159 allocator(const allocator& __a) _GLIBCXX_NOTHROW 160 : __allocator_base<_Tp>(__a) { } 161 162 #if __cplusplus >= 201103L 163 // Avoid implicit deprecation. 164 allocator& operator=(const allocator&) = default; 165 #endif 166 167 template<typename _Tp1> 168 _GLIBCXX20_CONSTEXPR 169 allocator(const allocator<_Tp1>&) _GLIBCXX_NOTHROW { } 170 171 #if __cpp_constexpr_dynamic_alloc 172 constexpr 173 #endif 174 ~allocator() _GLIBCXX_NOTHROW { } 175 176 #if __cplusplus > 201703L 177 [[nodiscard,__gnu__::__always_inline__]] 178 constexpr _Tp* 179 allocate(size_t __n) 180 { 181 if (std::__is_constant_evaluated()) 182 { 183 if (__builtin_mul_overflow(__n, sizeof(_Tp), &__n)) 184 std::__throw_bad_array_new_length(); 185 return static_cast<_Tp*>(::operator new(__n)); 186 } 187 188 return __allocator_base<_Tp>::allocate(__n, 0); 189 } 190 191 [[__gnu__::__always_inline__]] 192 constexpr void 193 deallocate(_Tp* __p, size_t __n) 194 { 195 if (std::__is_constant_evaluated()) 196 { 197 ::operator delete(__p); 198 return; 199 } 200 __allocator_base<_Tp>::deallocate(__p, __n); 201 } 202 #endif // C++20 203 204 friend _GLIBCXX20_CONSTEXPR bool 205 operator==(const allocator&, const allocator&) _GLIBCXX_NOTHROW 206 { return true; } 207 208 #if __cpp_impl_three_way_comparison < 201907L 209 friend _GLIBCXX20_CONSTEXPR bool 210 operator!=(const allocator&, const allocator&) _GLIBCXX_NOTHROW 211 { return false; } 212 #endif 213 214 // Inherit everything else. 215 }; 216 217 template<typename _T1, typename _T2> 218 inline _GLIBCXX20_CONSTEXPR bool 219 operator==(const allocator<_T1>&, const allocator<_T2>&) 220 _GLIBCXX_NOTHROW 221 { return true; } 222 223 #if __cpp_impl_three_way_comparison < 201907L 224 template<typename _T1, typename _T2> 225 inline _GLIBCXX20_CONSTEXPR bool 226 operator!=(const allocator<_T1>&, const allocator<_T2>&) 227 _GLIBCXX_NOTHROW 228 { return false; } 229 #endif 230 231 // Invalid allocator<cv T> partial specializations. 232 // allocator_traits::rebind_alloc can be used to form a valid allocator type. 233 template<typename _Tp> 234 class allocator<const _Tp> 235 { 236 public: 237 typedef _Tp value_type; 238 template<typename _Up> allocator(const allocator<_Up>&) { } 239 }; 240 241 template<typename _Tp> 242 class allocator<volatile _Tp> 243 { 244 public: 245 typedef _Tp value_type; 246 template<typename _Up> allocator(const allocator<_Up>&) { } 247 }; 248 249 template<typename _Tp> 250 class allocator<const volatile _Tp> 251 { 252 public: 253 typedef _Tp value_type; 254 template<typename _Up> allocator(const allocator<_Up>&) { } 255 }; 256 257 /// @} group allocator 258 259 // Inhibit implicit instantiations for required instantiations, 260 // which are defined via explicit instantiations elsewhere. 261 #if _GLIBCXX_EXTERN_TEMPLATE 262 extern template class allocator<char>; 263 extern template class allocator<wchar_t>; 264 #endif 265 266 // Undefine. 267 #undef __allocator_base 268 269 // To implement Option 3 of DR 431. 270 template<typename _Alloc, bool = __is_empty(_Alloc)> 271 struct __alloc_swap 272 { static void _S_do_it(_Alloc&, _Alloc&) _GLIBCXX_NOEXCEPT { } }; 273 274 template<typename _Alloc> 275 struct __alloc_swap<_Alloc, false> 276 { 277 static void 278 _S_do_it(_Alloc& __one, _Alloc& __two) _GLIBCXX_NOEXCEPT 279 { 280 // Precondition: swappable allocators. 281 if (__one != __two) 282 swap(__one, __two); 283 } 284 }; 285 286 // Optimize for stateless allocators. 287 template<typename _Alloc, bool = __is_empty(_Alloc)> 288 struct __alloc_neq 289 { 290 static bool 291 _S_do_it(const _Alloc&, const _Alloc&) 292 { return false; } 293 }; 294 295 template<typename _Alloc> 296 struct __alloc_neq<_Alloc, false> 297 { 298 static bool 299 _S_do_it(const _Alloc& __one, const _Alloc& __two) 300 { return __one != __two; } 301 }; 302 303 #if __cplusplus >= 201103L 304 template<typename _Tp, bool 305 = __or_<is_copy_constructible<typename _Tp::value_type>, 306 is_nothrow_move_constructible<typename _Tp::value_type>>::value> 307 struct __shrink_to_fit_aux 308 { static bool _S_do_it(_Tp&) noexcept { return false; } }; 309 310 template<typename _Tp> 311 struct __shrink_to_fit_aux<_Tp, true> 312 { 313 _GLIBCXX20_CONSTEXPR 314 static bool 315 _S_do_it(_Tp& __c) noexcept 316 { 317 #if __cpp_exceptions 318 try 319 { 320 _Tp(__make_move_if_noexcept_iterator(__c.begin()), 321 __make_move_if_noexcept_iterator(__c.end()), 322 __c.get_allocator()).swap(__c); 323 return true; 324 } 325 catch(...) 326 { return false; } 327 #else 328 return false; 329 #endif 330 } 331 }; 332 #endif 333 334 _GLIBCXX_END_NAMESPACE_VERSION 335 } // namespace std 336 337 #endif 338