blob: 29c51b2f2f4b7e345dbfb53c1a3d305d9f7ad9ed [file] [log] [blame]
Howard Hinnant27e0e772011-09-14 18:33:51 +00001// -*- C++ -*-
Louis Dionne9bd93882021-11-17 16:25:01 -05002//===----------------------------------------------------------------------===//
Howard Hinnant27e0e772011-09-14 18:33:51 +00003//
Chandler Carruthd2012102019-01-19 10:56:40 +00004// 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
Howard Hinnant27e0e772011-09-14 18:33:51 +00007//
8//===----------------------------------------------------------------------===//
9
10#ifndef _LIBCPP_DEBUG_H
11#define _LIBCPP_DEBUG_H
12
Eric Fiselier14b6de92014-08-10 23:53:08 +000013#include <__config>
Eric Fiselier873b8d32019-03-18 21:50:12 +000014#include <iosfwd>
Nikolas Klauserf2807732022-01-11 00:33:35 +010015#include <type_traits>
Eric Fiselier14b6de92014-08-10 23:53:08 +000016
Howard Hinnant8ea98242013-08-23 17:37:05 +000017#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
18#pragma GCC system_header
19#endif
20
Eric Fiselier02e6fbc2016-12-28 06:15:01 +000021#if defined(_LIBCPP_HAS_NO_NULLPTR)
22# include <cstddef>
23#endif
24
Eric Fiselierfb825432016-12-28 04:58:52 +000025#if _LIBCPP_DEBUG_LEVEL >= 1 || defined(_LIBCPP_BUILDING_LIBRARY)
Howard Hinnant27e0e772011-09-14 18:33:51 +000026# include <cstddef>
Arthur O'Dwyerd180ef82022-01-07 09:45:05 -050027# include <cstdio>
28# include <cstdlib>
Eric Fiselierfb825432016-12-28 04:58:52 +000029#endif
30
Louis Dionneba400782020-10-02 15:02:52 -040031#if _LIBCPP_DEBUG_LEVEL == 0
Eric Fiselierd8f24a42016-07-23 20:36:55 +000032# define _LIBCPP_DEBUG_ASSERT(x, m) ((void)0)
Louis Dionneba400782020-10-02 15:02:52 -040033# define _LIBCPP_ASSERT_IMPL(x, m) ((void)0)
34#elif _LIBCPP_DEBUG_LEVEL == 1
35# define _LIBCPP_DEBUG_ASSERT(x, m) ((void)0)
Louis Dionneba400782020-10-02 15:02:52 -040036# define _LIBCPP_ASSERT_IMPL(x, m) ((x) ? (void)0 : _VSTD::__libcpp_debug_function(_VSTD::__libcpp_debug_info(__FILE__, __LINE__, #x, m)))
37#elif _LIBCPP_DEBUG_LEVEL == 2
Nikolas Klauser1a7d9f02021-12-16 14:55:03 +010038# define _LIBCPP_DEBUG_ASSERT(x, m) _LIBCPP_ASSERT(__libcpp_is_constant_evaluated() || (x), m)
Louis Dionneba400782020-10-02 15:02:52 -040039# define _LIBCPP_ASSERT_IMPL(x, m) ((x) ? (void)0 : _VSTD::__libcpp_debug_function(_VSTD::__libcpp_debug_info(__FILE__, __LINE__, #x, m)))
40#else
41# error _LIBCPP_DEBUG_LEVEL must be one of 0, 1, 2
Eric Fiselierd8f24a42016-07-23 20:36:55 +000042#endif
Louis Dionneba400782020-10-02 15:02:52 -040043
44#if !defined(_LIBCPP_ASSERT)
45# define _LIBCPP_ASSERT(x, m) _LIBCPP_ASSERT_IMPL(x, m)
Eric Fiselierd8f24a42016-07-23 20:36:55 +000046#endif
Howard Hinnanta47c6d52011-09-16 17:29:17 +000047
Howard Hinnant27e0e772011-09-14 18:33:51 +000048_LIBCPP_BEGIN_NAMESPACE_STD
49
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +000050struct _LIBCPP_TEMPLATE_VIS __libcpp_debug_info {
Eric Fiselier3253fff2016-12-28 05:26:56 +000051 _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR
Eric Fiselier30ee6932016-12-28 05:56:16 +000052 __libcpp_debug_info()
53 : __file_(nullptr), __line_(-1), __pred_(nullptr), __msg_(nullptr) {}
54 _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR
Eric Fiselier3253fff2016-12-28 05:26:56 +000055 __libcpp_debug_info(const char* __f, int __l, const char* __p, const char* __m)
56 : __file_(__f), __line_(__l), __pred_(__p), __msg_(__m) {}
Eric Fiselier873b8d32019-03-18 21:50:12 +000057
Arthur O'Dwyer07b22492020-11-27 11:02:06 -050058 _LIBCPP_FUNC_VIS string what() const;
Eric Fiselier873b8d32019-03-18 21:50:12 +000059
Eric Fiselierfb825432016-12-28 04:58:52 +000060 const char* __file_;
61 int __line_;
62 const char* __pred_;
63 const char* __msg_;
64};
65
66/// __libcpp_debug_function_type - The type of the assertion failure handler.
67typedef void(*__libcpp_debug_function_type)(__libcpp_debug_info const&);
68
69/// __libcpp_debug_function - The handler function called when a _LIBCPP_ASSERT
70/// fails.
Louis Dionne5254b372018-10-25 12:13:43 +000071extern _LIBCPP_EXPORTED_FROM_ABI __libcpp_debug_function_type __libcpp_debug_function;
Eric Fiselierfb825432016-12-28 04:58:52 +000072
73/// __libcpp_abort_debug_function - A debug handler that aborts when called.
74_LIBCPP_NORETURN _LIBCPP_FUNC_VIS
75void __libcpp_abort_debug_function(__libcpp_debug_info const&);
76
Eric Fiselierfb825432016-12-28 04:58:52 +000077/// __libcpp_set_debug_function - Set the debug handler to the specified
78/// function.
79_LIBCPP_FUNC_VIS
80bool __libcpp_set_debug_function(__libcpp_debug_function_type __func);
81
Louis Dionneba400782020-10-02 15:02:52 -040082#if _LIBCPP_DEBUG_LEVEL == 2 || defined(_LIBCPP_BUILDING_LIBRARY)
Eric Fiselierfb825432016-12-28 04:58:52 +000083
Howard Hinnant8331b762013-03-06 23:30:19 +000084struct _LIBCPP_TYPE_VIS __c_node;
Howard Hinnant27e0e772011-09-14 18:33:51 +000085
Howard Hinnant8331b762013-03-06 23:30:19 +000086struct _LIBCPP_TYPE_VIS __i_node
Howard Hinnant27e0e772011-09-14 18:33:51 +000087{
88 void* __i_;
89 __i_node* __next_;
90 __c_node* __c_;
91
Eric Fiselier2d8515f2017-01-06 20:58:25 +000092#ifndef _LIBCPP_CXX03_LANG
Howard Hinnant27e0e772011-09-14 18:33:51 +000093 __i_node(const __i_node&) = delete;
94 __i_node& operator=(const __i_node&) = delete;
Howard Hinnant8ea98242013-08-23 17:37:05 +000095#else
96private:
97 __i_node(const __i_node&);
98 __i_node& operator=(const __i_node&);
99public:
100#endif
Howard Hinnant27e0e772011-09-14 18:33:51 +0000101 _LIBCPP_INLINE_VISIBILITY
102 __i_node(void* __i, __i_node* __next, __c_node* __c)
103 : __i_(__i), __next_(__next), __c_(__c) {}
104 ~__i_node();
105};
106
Howard Hinnant8331b762013-03-06 23:30:19 +0000107struct _LIBCPP_TYPE_VIS __c_node
Howard Hinnant27e0e772011-09-14 18:33:51 +0000108{
109 void* __c_;
110 __c_node* __next_;
111 __i_node** beg_;
112 __i_node** end_;
113 __i_node** cap_;
114
Eric Fiselier2d8515f2017-01-06 20:58:25 +0000115#ifndef _LIBCPP_CXX03_LANG
Howard Hinnant27e0e772011-09-14 18:33:51 +0000116 __c_node(const __c_node&) = delete;
117 __c_node& operator=(const __c_node&) = delete;
Howard Hinnant8ea98242013-08-23 17:37:05 +0000118#else
119private:
120 __c_node(const __c_node&);
121 __c_node& operator=(const __c_node&);
122public:
123#endif
Howard Hinnant27e0e772011-09-14 18:33:51 +0000124 _LIBCPP_INLINE_VISIBILITY
125 __c_node(void* __c, __c_node* __next)
126 : __c_(__c), __next_(__next), beg_(nullptr), end_(nullptr), cap_(nullptr) {}
127 virtual ~__c_node();
128
129 virtual bool __dereferenceable(const void*) const = 0;
130 virtual bool __decrementable(const void*) const = 0;
131 virtual bool __addable(const void*, ptrdiff_t) const = 0;
132 virtual bool __subscriptable(const void*, ptrdiff_t) const = 0;
133
Howard Hinnantb399c602011-09-27 23:55:03 +0000134 void __add(__i_node* __i);
Howard Hinnant27e0e772011-09-14 18:33:51 +0000135 _LIBCPP_HIDDEN void __remove(__i_node* __i);
136};
137
138template <class _Cont>
139struct _C_node
140 : public __c_node
141{
142 _C_node(void* __c, __c_node* __n)
143 : __c_node(__c, __n) {}
144
145 virtual bool __dereferenceable(const void*) const;
146 virtual bool __decrementable(const void*) const;
147 virtual bool __addable(const void*, ptrdiff_t) const;
148 virtual bool __subscriptable(const void*, ptrdiff_t) const;
149};
150
151template <class _Cont>
Eric Fiselierfb825432016-12-28 04:58:52 +0000152inline bool
Howard Hinnant27e0e772011-09-14 18:33:51 +0000153_C_node<_Cont>::__dereferenceable(const void* __i) const
154{
155 typedef typename _Cont::const_iterator iterator;
156 const iterator* __j = static_cast<const iterator*>(__i);
Howard Hinnantc834c512011-11-29 18:15:50 +0000157 _Cont* _Cp = static_cast<_Cont*>(__c_);
158 return _Cp->__dereferenceable(__j);
Howard Hinnant27e0e772011-09-14 18:33:51 +0000159}
160
161template <class _Cont>
Eric Fiselierfb825432016-12-28 04:58:52 +0000162inline bool
Howard Hinnant27e0e772011-09-14 18:33:51 +0000163_C_node<_Cont>::__decrementable(const void* __i) const
164{
165 typedef typename _Cont::const_iterator iterator;
166 const iterator* __j = static_cast<const iterator*>(__i);
Howard Hinnantc834c512011-11-29 18:15:50 +0000167 _Cont* _Cp = static_cast<_Cont*>(__c_);
168 return _Cp->__decrementable(__j);
Howard Hinnant27e0e772011-09-14 18:33:51 +0000169}
170
171template <class _Cont>
Eric Fiselierfb825432016-12-28 04:58:52 +0000172inline bool
Howard Hinnant27e0e772011-09-14 18:33:51 +0000173_C_node<_Cont>::__addable(const void* __i, ptrdiff_t __n) const
174{
175 typedef typename _Cont::const_iterator iterator;
176 const iterator* __j = static_cast<const iterator*>(__i);
Howard Hinnantc834c512011-11-29 18:15:50 +0000177 _Cont* _Cp = static_cast<_Cont*>(__c_);
178 return _Cp->__addable(__j, __n);
Howard Hinnant27e0e772011-09-14 18:33:51 +0000179}
180
181template <class _Cont>
Eric Fiselierfb825432016-12-28 04:58:52 +0000182inline bool
Howard Hinnant27e0e772011-09-14 18:33:51 +0000183_C_node<_Cont>::__subscriptable(const void* __i, ptrdiff_t __n) const
184{
185 typedef typename _Cont::const_iterator iterator;
186 const iterator* __j = static_cast<const iterator*>(__i);
Howard Hinnantc834c512011-11-29 18:15:50 +0000187 _Cont* _Cp = static_cast<_Cont*>(__c_);
188 return _Cp->__subscriptable(__j, __n);
Howard Hinnant27e0e772011-09-14 18:33:51 +0000189}
190
Howard Hinnant8331b762013-03-06 23:30:19 +0000191class _LIBCPP_TYPE_VIS __libcpp_db
Howard Hinnant27e0e772011-09-14 18:33:51 +0000192{
193 __c_node** __cbeg_;
194 __c_node** __cend_;
195 size_t __csz_;
196 __i_node** __ibeg_;
197 __i_node** __iend_;
198 size_t __isz_;
199
200 __libcpp_db();
201public:
Eric Fiselier2d8515f2017-01-06 20:58:25 +0000202#ifndef _LIBCPP_CXX03_LANG
Howard Hinnant27e0e772011-09-14 18:33:51 +0000203 __libcpp_db(const __libcpp_db&) = delete;
204 __libcpp_db& operator=(const __libcpp_db&) = delete;
Howard Hinnant8ea98242013-08-23 17:37:05 +0000205#else
206private:
207 __libcpp_db(const __libcpp_db&);
208 __libcpp_db& operator=(const __libcpp_db&);
209public:
210#endif
Howard Hinnant27e0e772011-09-14 18:33:51 +0000211 ~__libcpp_db();
212
213 class __db_c_iterator;
214 class __db_c_const_iterator;
215 class __db_i_iterator;
216 class __db_i_const_iterator;
217
218 __db_c_const_iterator __c_end() const;
219 __db_i_const_iterator __i_end() const;
220
Eric Fiselieraed4eab2019-03-05 02:10:31 +0000221 typedef __c_node*(_InsertConstruct)(void*, void*, __c_node*);
222
223 template <class _Cont>
224 _LIBCPP_INLINE_VISIBILITY static __c_node* __create_C_node(void *__mem, void *__c, __c_node *__next) {
Arthur O'Dwyer0c4472a2020-12-11 20:30:28 -0500225 return ::new (__mem) _C_node<_Cont>(__c, __next);
Eric Fiselieraed4eab2019-03-05 02:10:31 +0000226 }
227
Howard Hinnant27e0e772011-09-14 18:33:51 +0000228 template <class _Cont>
229 _LIBCPP_INLINE_VISIBILITY
230 void __insert_c(_Cont* __c)
231 {
Eric Fiselieraed4eab2019-03-05 02:10:31 +0000232 __insert_c(static_cast<void*>(__c), &__create_C_node<_Cont>);
Howard Hinnant27e0e772011-09-14 18:33:51 +0000233 }
234
Howard Hinnantc90aa632011-09-16 19:52:23 +0000235 void __insert_i(void* __i);
Eric Fiselieraed4eab2019-03-05 02:10:31 +0000236 void __insert_c(void* __c, _InsertConstruct* __fn);
Howard Hinnant27e0e772011-09-14 18:33:51 +0000237 void __erase_c(void* __c);
238
239 void __insert_ic(void* __i, const void* __c);
240 void __iterator_copy(void* __i, const void* __i0);
241 void __erase_i(void* __i);
242
243 void* __find_c_from_i(void* __i) const;
244 void __invalidate_all(void* __c);
245 __c_node* __find_c_and_lock(void* __c) const;
Howard Hinnantb399c602011-09-27 23:55:03 +0000246 __c_node* __find_c(void* __c) const;
Howard Hinnant27e0e772011-09-14 18:33:51 +0000247 void unlock() const;
248
249 void swap(void* __c1, void* __c2);
250
251
252 bool __dereferenceable(const void* __i) const;
253 bool __decrementable(const void* __i) const;
254 bool __addable(const void* __i, ptrdiff_t __n) const;
255 bool __subscriptable(const void* __i, ptrdiff_t __n) const;
Howard Hinnante6ff0b62013-08-02 00:26:35 +0000256 bool __less_than_comparable(const void* __i, const void* __j) const;
Howard Hinnant27e0e772011-09-14 18:33:51 +0000257private:
258 _LIBCPP_HIDDEN
259 __i_node* __insert_iterator(void* __i);
260 _LIBCPP_HIDDEN
261 __i_node* __find_iterator(const void* __i) const;
262
Howard Hinnant8331b762013-03-06 23:30:19 +0000263 friend _LIBCPP_FUNC_VIS __libcpp_db* __get_db();
Howard Hinnant27e0e772011-09-14 18:33:51 +0000264};
265
Howard Hinnant8331b762013-03-06 23:30:19 +0000266_LIBCPP_FUNC_VIS __libcpp_db* __get_db();
267_LIBCPP_FUNC_VIS const __libcpp_db* __get_const_db();
Howard Hinnant27e0e772011-09-14 18:33:51 +0000268
269
Louis Dionneba400782020-10-02 15:02:52 -0400270#endif // _LIBCPP_DEBUG_LEVEL == 2 || defined(_LIBCPP_BUILDING_LIBRARY)
Howard Hinnant27e0e772011-09-14 18:33:51 +0000271
Nikolas Klauserf2807732022-01-11 00:33:35 +0100272template <class _Tp>
273_LIBCPP_HIDE_FROM_ABI _LIBCPP_CONSTEXPR_AFTER_CXX11 inline void __debug_db_insert_c(_Tp* __c) {
274#if _LIBCPP_DEBUG_LEVEL == 2
275 if (!__libcpp_is_constant_evaluated())
276 __get_db()->__insert_c(__c);
277#else
278 (void)(__c);
279#endif
280}
281
Eric Fiselierfb825432016-12-28 04:58:52 +0000282_LIBCPP_END_NAMESPACE_STD
Howard Hinnanta47c6d52011-09-16 17:29:17 +0000283
Louis Dionne2b1ceaa2021-04-20 12:03:32 -0400284#endif // _LIBCPP_DEBUG_H