blob: 27c248c83c9ecd3d925adc6cdd8b1bb189a30605 [file] [log] [blame]
Howard Hinnantbc8d3f92010-05-11 19:42:16 +00001// -*- C++ -*-
2//===----------------------------- new ------------------------------------===//
3//
Howard Hinnantf5256e12010-05-11 21:36:01 +00004// The LLVM Compiler Infrastructure
Howard Hinnantbc8d3f92010-05-11 19:42:16 +00005//
Howard Hinnantb64f8b02010-11-16 22:09:02 +00006// This file is dual licensed under the MIT and the University of Illinois Open
7// Source Licenses. See LICENSE.TXT for details.
Howard Hinnantbc8d3f92010-05-11 19:42:16 +00008//
9//===----------------------------------------------------------------------===//
10
11#ifndef _LIBCPP_NEW
12#define _LIBCPP_NEW
13
14/*
15 new synopsis
16
17namespace std
18{
19
20class bad_alloc
21 : public exception
22{
23public:
Howard Hinnanted569212011-05-26 18:23:59 +000024 bad_alloc() noexcept;
25 bad_alloc(const bad_alloc&) noexcept;
26 bad_alloc& operator=(const bad_alloc&) noexcept;
27 virtual const char* what() const noexcept;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000028};
29
Eric Fiselier9acbffa2016-10-14 06:46:30 +000030class bad_array_length : public bad_alloc // FIXME: Not part of C++
Marshall Clow7f9f52e2013-09-11 01:38:42 +000031{
32public:
33 bad_array_length() noexcept;
34};
35
Eric Fiselier9acbffa2016-10-14 06:46:30 +000036class bad_array_new_length : public bad_alloc // C++14
Marshall Clow7f9f52e2013-09-11 01:38:42 +000037{
38public:
39 bad_array_new_length() noexcept;
40};
41
Eric Fiselier9acbffa2016-10-14 06:46:30 +000042enum class align_val_t : size_t {}; // C++17
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000043struct nothrow_t {};
44extern const nothrow_t nothrow;
45typedef void (*new_handler)();
Howard Hinnanted569212011-05-26 18:23:59 +000046new_handler set_new_handler(new_handler new_p) noexcept;
47new_handler get_new_handler() noexcept;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000048
Marshall Clowaa0e2362017-11-22 19:49:03 +000049// 21.6.4, pointer optimization barrier
50template <class T> constexpr T* launder(T* p) noexcept; // C++17
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000051} // std
52
Marshall Clow8f6293b2017-12-04 23:03:42 +000053void* operator new(std::size_t size); // replaceable, nodiscard in C++2a
54void* operator new(std::size_t size, std::align_val_t alignment); // replaceable, C++17, nodiscard in C++2a
55void* operator new(std::size_t size, const std::nothrow_t&) noexcept; // replaceable, nodiscard in C++2a
Eric Fiselier9acbffa2016-10-14 06:46:30 +000056void* operator new(std::size_t size, std::align_val_t alignment,
Marshall Clow8f6293b2017-12-04 23:03:42 +000057 const std::nothrow_t&) noexcept; // replaceable, C++17, nodiscard in C++2a
Howard Hinnanted569212011-05-26 18:23:59 +000058void operator delete(void* ptr) noexcept; // replaceable
Larisse Voufo19efe012015-02-15 05:18:55 +000059void operator delete(void* ptr, std::size_t size) noexcept; // replaceable, C++14
Eric Fiselier9acbffa2016-10-14 06:46:30 +000060void operator delete(void* ptr, std::align_val_t alignment) noexcept; // replaceable, C++17
61void operator delete(void* ptr, std::size_t size,
62 std::align_val_t alignment) noexcept; // replaceable, C++17
Howard Hinnanted569212011-05-26 18:23:59 +000063void operator delete(void* ptr, const std::nothrow_t&) noexcept; // replaceable
Eric Fiselier9acbffa2016-10-14 06:46:30 +000064void operator delete(void* ptr, std:align_val_t alignment,
65 const std::nothrow_t&) noexcept; // replaceable, C++17
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000066
Marshall Clow8f6293b2017-12-04 23:03:42 +000067void* operator new[](std::size_t size); // replaceable, nodiscard in C++2a
Eric Fiselier9acbffa2016-10-14 06:46:30 +000068void* operator new[](std::size_t size,
Marshall Clow8f6293b2017-12-04 23:03:42 +000069 std::align_val_t alignment) noexcept; // replaceable, C++17, nodiscard in C++2a
70void* operator new[](std::size_t size, const std::nothrow_t&) noexcept; // replaceable, nodiscard in C++2a
Eric Fiselier9acbffa2016-10-14 06:46:30 +000071void* operator new[](std::size_t size, std::align_val_t alignment,
Marshall Clow8f6293b2017-12-04 23:03:42 +000072 const std::nothrow_t&) noexcept; // replaceable, C++17, nodiscard in C++2a
Howard Hinnanted569212011-05-26 18:23:59 +000073void operator delete[](void* ptr) noexcept; // replaceable
Larisse Voufo19efe012015-02-15 05:18:55 +000074void operator delete[](void* ptr, std::size_t size) noexcept; // replaceable, C++14
Eric Fiselier9acbffa2016-10-14 06:46:30 +000075void operator delete[](void* ptr,
76 std::align_val_t alignment) noexcept; // replaceable, C++17
77void operator delete[](void* ptr, std::size_t size,
78 std::align_val_t alignment) noexcept; // replaceable, C++17
Howard Hinnanted569212011-05-26 18:23:59 +000079void operator delete[](void* ptr, const std::nothrow_t&) noexcept; // replaceable
Eric Fiselier9acbffa2016-10-14 06:46:30 +000080void operator delete[](void* ptr, std::align_val_t alignment,
81 const std::nothrow_t&) noexcept; // replaceable, C++17
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000082
Marshall Clow8f6293b2017-12-04 23:03:42 +000083void* operator new (std::size_t size, void* ptr) noexcept; // nodiscard in C++2a
84void* operator new[](std::size_t size, void* ptr) noexcept; // nodiscard in C++2a
Howard Hinnanted569212011-05-26 18:23:59 +000085void operator delete (void* ptr, void*) noexcept;
86void operator delete[](void* ptr, void*) noexcept;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000087
88*/
89
90#include <__config>
91#include <exception>
92#include <cstddef>
Eric Fiselierdbf60fa2016-09-06 21:25:27 +000093#ifdef _LIBCPP_NO_EXCEPTIONS
94#include <cstdlib>
95#endif
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000096
Shoaib Meenai18dba062017-10-09 19:25:17 +000097#if defined(_LIBCPP_ABI_MICROSOFT) && !defined(_LIBCPP_NO_VCRUNTIME)
Eric Fiselier1edf3162017-02-10 08:57:35 +000098#include <new.h>
99#endif
100
Howard Hinnant08e17472011-10-17 20:05:10 +0000101#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000102#pragma GCC system_header
Howard Hinnant08e17472011-10-17 20:05:10 +0000103#endif
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000104
Eric Fiselier9acbffa2016-10-14 06:46:30 +0000105#if !(defined(_LIBCPP_BUILDING_NEW) || _LIBCPP_STD_VER >= 14 || \
106 (defined(__cpp_sized_deallocation) && __cpp_sized_deallocation >= 201309))
107# define _LIBCPP_HAS_NO_SIZED_DEALLOCATION
108#endif
109
Eric Fiselierd54d9742017-01-20 01:47:26 +0000110#if !defined(_LIBCPP_HAS_NO_ALIGNED_ALLOCATION) && \
111 (!(defined(_LIBCPP_BUILDING_NEW) || _LIBCPP_STD_VER > 14 || \
112 (defined(__cpp_aligned_new) && __cpp_aligned_new >= 201606)))
Eric Fiselier9acbffa2016-10-14 06:46:30 +0000113# define _LIBCPP_HAS_NO_ALIGNED_ALLOCATION
114#endif
115
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000116namespace std // purposefully not using versioning namespace
117{
118
Shoaib Meenai18dba062017-10-09 19:25:17 +0000119#if !defined(_LIBCPP_ABI_MICROSOFT) || defined(_LIBCPP_NO_VCRUNTIME)
Eric Fiselier1edf3162017-02-10 08:57:35 +0000120struct _LIBCPP_TYPE_VIS nothrow_t {};
121extern _LIBCPP_FUNC_VIS const nothrow_t nothrow;
122
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000123class _LIBCPP_EXCEPTION_ABI bad_alloc
124 : public exception
125{
126public:
Howard Hinnanted569212011-05-26 18:23:59 +0000127 bad_alloc() _NOEXCEPT;
128 virtual ~bad_alloc() _NOEXCEPT;
129 virtual const char* what() const _NOEXCEPT;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000130};
131
132class _LIBCPP_EXCEPTION_ABI bad_array_new_length
133 : public bad_alloc
134{
135public:
Howard Hinnanted569212011-05-26 18:23:59 +0000136 bad_array_new_length() _NOEXCEPT;
137 virtual ~bad_array_new_length() _NOEXCEPT;
138 virtual const char* what() const _NOEXCEPT;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000139};
140
Eric Fiselier1edf3162017-02-10 08:57:35 +0000141typedef void (*new_handler)();
142_LIBCPP_FUNC_VIS new_handler set_new_handler(new_handler) _NOEXCEPT;
143_LIBCPP_FUNC_VIS new_handler get_new_handler() _NOEXCEPT;
144
Shoaib Meenai18dba062017-10-09 19:25:17 +0000145#endif // !_LIBCPP_ABI_MICROSOFT || _LIBCPP_NO_VCRUNTIME
Eric Fiselier1edf3162017-02-10 08:57:35 +0000146
Marshall Clow14c09a22016-08-25 15:09:01 +0000147_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void __throw_bad_alloc(); // not in C++ spec
148
Eric Fiselier1edf3162017-02-10 08:57:35 +0000149#if defined(_LIBCPP_BUILDING_LIBRARY) || (_LIBCPP_STD_VER > 11)
Howard Hinnant29250b72013-11-07 17:15:51 +0000150
Mehdi Amini907c1192017-05-04 17:08:54 +0000151class _LIBCPP_EXCEPTION_ABI _LIBCPP_AVAILABILITY_BAD_ARRAY_LENGTH
152 bad_array_length : public bad_alloc {
Marshall Clow7f9f52e2013-09-11 01:38:42 +0000153public:
154 bad_array_length() _NOEXCEPT;
155 virtual ~bad_array_length() _NOEXCEPT;
156 virtual const char* what() const _NOEXCEPT;
157};
Howard Hinnant29250b72013-11-07 17:15:51 +0000158
159#define _LIBCPP_BAD_ARRAY_LENGTH_DEFINED
160
161#endif // defined(_LIBCPP_BUILDING_NEW) || (_LIBCPP_STD_VER > 11)
Marshall Clow7f9f52e2013-09-11 01:38:42 +0000162
Eric Fiselier22a291c2018-02-11 22:00:19 +0000163#if !defined(_LIBCPP_ABI_MICROSOFT) || defined(_LIBCPP_NO_VCRUNTIME)
Eric Fiselier85e34e42017-01-21 14:42:44 +0000164#if !defined(_LIBCPP_HAS_NO_ALIGNED_ALLOCATION) || _LIBCPP_STD_VER > 14
Eric Fiselier9acbffa2016-10-14 06:46:30 +0000165#ifndef _LIBCPP_CXX03_LANG
166enum class _LIBCPP_ENUM_VIS align_val_t : size_t { };
167#else
168enum align_val_t { __zero = 0, __max = (size_t)-1 };
169#endif
170#endif
Eric Fiselier22a291c2018-02-11 22:00:19 +0000171#endif
Eric Fiselier9acbffa2016-10-14 06:46:30 +0000172
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000173} // std
174
Eric Fiselierb45121d2017-01-02 23:27:42 +0000175#if defined(_LIBCPP_CXX03_LANG)
Eric Fiselier9acbffa2016-10-14 06:46:30 +0000176#define _THROW_BAD_ALLOC throw(std::bad_alloc)
177#else
178#define _THROW_BAD_ALLOC
Howard Hinnanted569212011-05-26 18:23:59 +0000179#endif
Eric Fiselier9acbffa2016-10-14 06:46:30 +0000180
Shoaib Meenai18dba062017-10-09 19:25:17 +0000181#if !defined(_LIBCPP_ABI_MICROSOFT) || defined(_LIBCPP_NO_VCRUNTIME)
Eric Fiselier1edf3162017-02-10 08:57:35 +0000182
Marshall Clow8f6293b2017-12-04 23:03:42 +0000183_LIBCPP_NODISCARD_AFTER_CXX17 _LIBCPP_OVERRIDABLE_FUNC_VIS void* operator new(std::size_t __sz) _THROW_BAD_ALLOC;
184_LIBCPP_NODISCARD_AFTER_CXX17 _LIBCPP_OVERRIDABLE_FUNC_VIS void* operator new(std::size_t __sz, const std::nothrow_t&) _NOEXCEPT _NOALIAS;
Shoaib Meenaie6479bc2016-11-16 22:18:10 +0000185_LIBCPP_OVERRIDABLE_FUNC_VIS void operator delete(void* __p) _NOEXCEPT;
186_LIBCPP_OVERRIDABLE_FUNC_VIS void operator delete(void* __p, const std::nothrow_t&) _NOEXCEPT;
Eric Fiselier9acbffa2016-10-14 06:46:30 +0000187#ifndef _LIBCPP_HAS_NO_SIZED_DEALLOCATION
Mehdi Amini907c1192017-05-04 17:08:54 +0000188_LIBCPP_OVERRIDABLE_FUNC_VIS _LIBCPP_AVAILABILITY_SIZED_NEW_DELETE void operator delete(void* __p, std::size_t __sz) _NOEXCEPT;
Larisse Voufo74f95a02015-02-20 06:13:05 +0000189#endif
Howard Hinnant0f678bd2013-08-12 18:38:34 +0000190
Marshall Clow8f6293b2017-12-04 23:03:42 +0000191_LIBCPP_NODISCARD_AFTER_CXX17 _LIBCPP_OVERRIDABLE_FUNC_VIS void* operator new[](std::size_t __sz) _THROW_BAD_ALLOC;
192_LIBCPP_NODISCARD_AFTER_CXX17 _LIBCPP_OVERRIDABLE_FUNC_VIS void* operator new[](std::size_t __sz, const std::nothrow_t&) _NOEXCEPT _NOALIAS;
Shoaib Meenaie6479bc2016-11-16 22:18:10 +0000193_LIBCPP_OVERRIDABLE_FUNC_VIS void operator delete[](void* __p) _NOEXCEPT;
194_LIBCPP_OVERRIDABLE_FUNC_VIS void operator delete[](void* __p, const std::nothrow_t&) _NOEXCEPT;
Shoaib Meenaif66194b2016-11-18 04:31:09 +0000195#ifndef _LIBCPP_HAS_NO_SIZED_DEALLOCATION
Mehdi Amini907c1192017-05-04 17:08:54 +0000196_LIBCPP_OVERRIDABLE_FUNC_VIS _LIBCPP_AVAILABILITY_SIZED_NEW_DELETE void operator delete[](void* __p, std::size_t __sz) _NOEXCEPT;
Larisse Voufo74f95a02015-02-20 06:13:05 +0000197#endif
Howard Hinnant0f678bd2013-08-12 18:38:34 +0000198
Eric Fiselier9acbffa2016-10-14 06:46:30 +0000199#ifndef _LIBCPP_HAS_NO_ALIGNED_ALLOCATION
Marshall Clow8f6293b2017-12-04 23:03:42 +0000200_LIBCPP_NODISCARD_AFTER_CXX17 _LIBCPP_OVERRIDABLE_FUNC_VIS void* operator new(std::size_t __sz, std::align_val_t) _THROW_BAD_ALLOC;
201_LIBCPP_NODISCARD_AFTER_CXX17 _LIBCPP_OVERRIDABLE_FUNC_VIS void* operator new(std::size_t __sz, std::align_val_t, const std::nothrow_t&) _NOEXCEPT _NOALIAS;
Akira Hatanakac5247b42017-06-30 18:50:23 +0000202_LIBCPP_OVERRIDABLE_FUNC_VIS void operator delete(void* __p, std::align_val_t) _NOEXCEPT;
203_LIBCPP_OVERRIDABLE_FUNC_VIS void operator delete(void* __p, std::align_val_t, const std::nothrow_t&) _NOEXCEPT;
Eric Fiselier9acbffa2016-10-14 06:46:30 +0000204#ifndef _LIBCPP_HAS_NO_SIZED_DEALLOCATION
Akira Hatanakac5247b42017-06-30 18:50:23 +0000205_LIBCPP_OVERRIDABLE_FUNC_VIS _LIBCPP_AVAILABILITY_SIZED_NEW_DELETE void operator delete(void* __p, std::size_t __sz, std::align_val_t) _NOEXCEPT;
Eric Fiselier9acbffa2016-10-14 06:46:30 +0000206#endif
207
Marshall Clow8f6293b2017-12-04 23:03:42 +0000208_LIBCPP_NODISCARD_AFTER_CXX17 _LIBCPP_OVERRIDABLE_FUNC_VIS void* operator new[](std::size_t __sz, std::align_val_t) _THROW_BAD_ALLOC;
209_LIBCPP_NODISCARD_AFTER_CXX17 _LIBCPP_OVERRIDABLE_FUNC_VIS void* operator new[](std::size_t __sz, std::align_val_t, const std::nothrow_t&) _NOEXCEPT _NOALIAS;
Akira Hatanakac5247b42017-06-30 18:50:23 +0000210_LIBCPP_OVERRIDABLE_FUNC_VIS void operator delete[](void* __p, std::align_val_t) _NOEXCEPT;
211_LIBCPP_OVERRIDABLE_FUNC_VIS void operator delete[](void* __p, std::align_val_t, const std::nothrow_t&) _NOEXCEPT;
Eric Fiselier9acbffa2016-10-14 06:46:30 +0000212#ifndef _LIBCPP_HAS_NO_SIZED_DEALLOCATION
Akira Hatanakac5247b42017-06-30 18:50:23 +0000213_LIBCPP_OVERRIDABLE_FUNC_VIS _LIBCPP_AVAILABILITY_SIZED_NEW_DELETE void operator delete[](void* __p, std::size_t __sz, std::align_val_t) _NOEXCEPT;
Eric Fiselier9acbffa2016-10-14 06:46:30 +0000214#endif
215#endif
216
Marshall Clow8f6293b2017-12-04 23:03:42 +0000217_LIBCPP_NODISCARD_AFTER_CXX17 inline _LIBCPP_INLINE_VISIBILITY void* operator new (std::size_t, void* __p) _NOEXCEPT {return __p;}
218_LIBCPP_NODISCARD_AFTER_CXX17 inline _LIBCPP_INLINE_VISIBILITY void* operator new[](std::size_t, void* __p) _NOEXCEPT {return __p;}
Howard Hinnant1e564242013-10-04 22:09:00 +0000219inline _LIBCPP_INLINE_VISIBILITY void operator delete (void*, void*) _NOEXCEPT {}
220inline _LIBCPP_INLINE_VISIBILITY void operator delete[](void*, void*) _NOEXCEPT {}
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000221
Shoaib Meenai18dba062017-10-09 19:25:17 +0000222#endif // !_LIBCPP_ABI_MICROSOFT || _LIBCPP_NO_VCRUNTIME
Eric Fiselier1edf3162017-02-10 08:57:35 +0000223
Richard Smith73c1fce2014-06-04 19:54:15 +0000224_LIBCPP_BEGIN_NAMESPACE_STD
225
226inline _LIBCPP_INLINE_VISIBILITY void *__allocate(size_t __size) {
227#ifdef _LIBCPP_HAS_NO_BUILTIN_OPERATOR_NEW_DELETE
228 return ::operator new(__size);
229#else
230 return __builtin_operator_new(__size);
231#endif
232}
233
Eric Fiselier32b19c32017-01-07 03:01:24 +0000234inline _LIBCPP_INLINE_VISIBILITY void __libcpp_deallocate(void *__ptr) {
Richard Smith73c1fce2014-06-04 19:54:15 +0000235#ifdef _LIBCPP_HAS_NO_BUILTIN_OPERATOR_NEW_DELETE
236 ::operator delete(__ptr);
237#else
238 __builtin_operator_delete(__ptr);
239#endif
240}
241
Marshall Clow14c09a22016-08-25 15:09:01 +0000242#ifdef _LIBCPP_BAD_ARRAY_LENGTH_DEFINED
243_LIBCPP_NORETURN inline _LIBCPP_ALWAYS_INLINE
Mehdi Amini907c1192017-05-04 17:08:54 +0000244#ifndef _LIBCPP_NO_EXCEPTIONS
245_LIBCPP_AVAILABILITY_BAD_ARRAY_LENGTH
246#endif
Marshall Clow14c09a22016-08-25 15:09:01 +0000247void __throw_bad_array_length()
248{
249#ifndef _LIBCPP_NO_EXCEPTIONS
250 throw bad_array_length();
251#else
252 _VSTD::abort();
253#endif
254}
255#endif
256
Marshall Clowaa0e2362017-11-22 19:49:03 +0000257template <class _Tp>
258_LIBCPP_NODISCARD_AFTER_CXX17 inline
259_LIBCPP_CONSTEXPR _Tp* __launder(_Tp* __p) _NOEXCEPT
260{
261 static_assert (!(is_function<_Tp>::value), "can't launder functions" );
262 static_assert (!(is_same<void, typename remove_cv<_Tp>::type>::value), "can't launder cv-void" );
263#ifdef _LIBCPP_COMPILER_HAS_BUILTIN_LAUNDER
264 return __builtin_launder(__p);
265#else
266 return __p;
267#endif
268}
269
270
271#if _LIBCPP_STD_VER > 14
272template <class _Tp>
273_LIBCPP_NODISCARD_AFTER_CXX17 inline _LIBCPP_INLINE_VISIBILITY
274constexpr _Tp* launder(_Tp* __p) noexcept
275{
Marshall Clow70c7bbd2017-11-23 01:25:03 +0000276 return _VSTD::__launder(__p);
Marshall Clowaa0e2362017-11-22 19:49:03 +0000277}
278#endif
279
Richard Smith73c1fce2014-06-04 19:54:15 +0000280_LIBCPP_END_NAMESPACE_STD
281
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000282#endif // _LIBCPP_NEW