blob: dbf47f6f53073021afd2ea56cf76639ec8468224 [file] [log] [blame]
Howard Hinnant27e0e772011-09-14 18:33:51 +00001// -*- C++ -*-
2//===--------------------------- __debug ----------------------------------===//
3//
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>
Eric Fiselier14b6de92014-08-10 23:53:08 +000015
Howard Hinnant8ea98242013-08-23 17:37:05 +000016#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
17#pragma GCC system_header
18#endif
19
Eric Fiselier02e6fbc2016-12-28 06:15:01 +000020#if defined(_LIBCPP_HAS_NO_NULLPTR)
21# include <cstddef>
22#endif
23
Eric Fiselierfb825432016-12-28 04:58:52 +000024#if _LIBCPP_DEBUG_LEVEL >= 1 || defined(_LIBCPP_BUILDING_LIBRARY)
Howard Hinnant27e0e772011-09-14 18:33:51 +000025# include <cstdlib>
26# include <cstdio>
27# include <cstddef>
Eric Fiselierfb825432016-12-28 04:58:52 +000028#endif
29
Louis Dionneba400782020-10-02 15:02:52 -040030#if _LIBCPP_DEBUG_LEVEL == 0
Eric Fiselierd8f24a42016-07-23 20:36:55 +000031# define _LIBCPP_DEBUG_ASSERT(x, m) ((void)0)
Louis Dionneba400782020-10-02 15:02:52 -040032# define _LIBCPP_DEBUG_MODE(...) ((void)0)
33# define _LIBCPP_ASSERT_IMPL(x, m) ((void)0)
34#elif _LIBCPP_DEBUG_LEVEL == 1
35# define _LIBCPP_DEBUG_ASSERT(x, m) ((void)0)
36# define _LIBCPP_DEBUG_MODE(...) ((void)0)
37# define _LIBCPP_ASSERT_IMPL(x, m) ((x) ? (void)0 : _VSTD::__libcpp_debug_function(_VSTD::__libcpp_debug_info(__FILE__, __LINE__, #x, m)))
38#elif _LIBCPP_DEBUG_LEVEL == 2
39# define _LIBCPP_DEBUG_ASSERT(x, m) _LIBCPP_ASSERT(x, m)
40# define _LIBCPP_DEBUG_MODE(...) __VA_ARGS__
41# define _LIBCPP_ASSERT_IMPL(x, m) ((x) ? (void)0 : _VSTD::__libcpp_debug_function(_VSTD::__libcpp_debug_info(__FILE__, __LINE__, #x, m)))
42#else
43# error _LIBCPP_DEBUG_LEVEL must be one of 0, 1, 2
Eric Fiselierd8f24a42016-07-23 20:36:55 +000044#endif
Louis Dionneba400782020-10-02 15:02:52 -040045
46#if !defined(_LIBCPP_ASSERT)
47# define _LIBCPP_ASSERT(x, m) _LIBCPP_ASSERT_IMPL(x, m)
Eric Fiselierd8f24a42016-07-23 20:36:55 +000048#endif
Howard Hinnanta47c6d52011-09-16 17:29:17 +000049
Howard Hinnant27e0e772011-09-14 18:33:51 +000050_LIBCPP_BEGIN_NAMESPACE_STD
51
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +000052struct _LIBCPP_TEMPLATE_VIS __libcpp_debug_info {
Eric Fiselier3253fff2016-12-28 05:26:56 +000053 _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR
Eric Fiselier30ee6932016-12-28 05:56:16 +000054 __libcpp_debug_info()
55 : __file_(nullptr), __line_(-1), __pred_(nullptr), __msg_(nullptr) {}
56 _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR
Eric Fiselier3253fff2016-12-28 05:26:56 +000057 __libcpp_debug_info(const char* __f, int __l, const char* __p, const char* __m)
58 : __file_(__f), __line_(__l), __pred_(__p), __msg_(__m) {}
Eric Fiselier873b8d32019-03-18 21:50:12 +000059
60 _LIBCPP_FUNC_VIS std::string what() const;
61
Eric Fiselierfb825432016-12-28 04:58:52 +000062 const char* __file_;
63 int __line_;
64 const char* __pred_;
65 const char* __msg_;
66};
67
68/// __libcpp_debug_function_type - The type of the assertion failure handler.
69typedef void(*__libcpp_debug_function_type)(__libcpp_debug_info const&);
70
71/// __libcpp_debug_function - The handler function called when a _LIBCPP_ASSERT
72/// fails.
Louis Dionne5254b372018-10-25 12:13:43 +000073extern _LIBCPP_EXPORTED_FROM_ABI __libcpp_debug_function_type __libcpp_debug_function;
Eric Fiselierfb825432016-12-28 04:58:52 +000074
75/// __libcpp_abort_debug_function - A debug handler that aborts when called.
76_LIBCPP_NORETURN _LIBCPP_FUNC_VIS
77void __libcpp_abort_debug_function(__libcpp_debug_info const&);
78
Eric Fiselierfb825432016-12-28 04:58:52 +000079/// __libcpp_set_debug_function - Set the debug handler to the specified
80/// function.
81_LIBCPP_FUNC_VIS
82bool __libcpp_set_debug_function(__libcpp_debug_function_type __func);
83
Louis Dionneba400782020-10-02 15:02:52 -040084#if _LIBCPP_DEBUG_LEVEL == 2 || defined(_LIBCPP_BUILDING_LIBRARY)
Eric Fiselierfb825432016-12-28 04:58:52 +000085
Howard Hinnant8331b762013-03-06 23:30:19 +000086struct _LIBCPP_TYPE_VIS __c_node;
Howard Hinnant27e0e772011-09-14 18:33:51 +000087
Howard Hinnant8331b762013-03-06 23:30:19 +000088struct _LIBCPP_TYPE_VIS __i_node
Howard Hinnant27e0e772011-09-14 18:33:51 +000089{
90 void* __i_;
91 __i_node* __next_;
92 __c_node* __c_;
93
Eric Fiselier2d8515f2017-01-06 20:58:25 +000094#ifndef _LIBCPP_CXX03_LANG
Howard Hinnant27e0e772011-09-14 18:33:51 +000095 __i_node(const __i_node&) = delete;
96 __i_node& operator=(const __i_node&) = delete;
Howard Hinnant8ea98242013-08-23 17:37:05 +000097#else
98private:
99 __i_node(const __i_node&);
100 __i_node& operator=(const __i_node&);
101public:
102#endif
Howard Hinnant27e0e772011-09-14 18:33:51 +0000103 _LIBCPP_INLINE_VISIBILITY
104 __i_node(void* __i, __i_node* __next, __c_node* __c)
105 : __i_(__i), __next_(__next), __c_(__c) {}
106 ~__i_node();
107};
108
Howard Hinnant8331b762013-03-06 23:30:19 +0000109struct _LIBCPP_TYPE_VIS __c_node
Howard Hinnant27e0e772011-09-14 18:33:51 +0000110{
111 void* __c_;
112 __c_node* __next_;
113 __i_node** beg_;
114 __i_node** end_;
115 __i_node** cap_;
116
Eric Fiselier2d8515f2017-01-06 20:58:25 +0000117#ifndef _LIBCPP_CXX03_LANG
Howard Hinnant27e0e772011-09-14 18:33:51 +0000118 __c_node(const __c_node&) = delete;
119 __c_node& operator=(const __c_node&) = delete;
Howard Hinnant8ea98242013-08-23 17:37:05 +0000120#else
121private:
122 __c_node(const __c_node&);
123 __c_node& operator=(const __c_node&);
124public:
125#endif
Howard Hinnant27e0e772011-09-14 18:33:51 +0000126 _LIBCPP_INLINE_VISIBILITY
127 __c_node(void* __c, __c_node* __next)
128 : __c_(__c), __next_(__next), beg_(nullptr), end_(nullptr), cap_(nullptr) {}
129 virtual ~__c_node();
130
131 virtual bool __dereferenceable(const void*) const = 0;
132 virtual bool __decrementable(const void*) const = 0;
133 virtual bool __addable(const void*, ptrdiff_t) const = 0;
134 virtual bool __subscriptable(const void*, ptrdiff_t) const = 0;
135
Howard Hinnantb399c602011-09-27 23:55:03 +0000136 void __add(__i_node* __i);
Howard Hinnant27e0e772011-09-14 18:33:51 +0000137 _LIBCPP_HIDDEN void __remove(__i_node* __i);
138};
139
140template <class _Cont>
141struct _C_node
142 : public __c_node
143{
144 _C_node(void* __c, __c_node* __n)
145 : __c_node(__c, __n) {}
146
147 virtual bool __dereferenceable(const void*) const;
148 virtual bool __decrementable(const void*) const;
149 virtual bool __addable(const void*, ptrdiff_t) const;
150 virtual bool __subscriptable(const void*, ptrdiff_t) const;
151};
152
153template <class _Cont>
Eric Fiselierfb825432016-12-28 04:58:52 +0000154inline bool
Howard Hinnant27e0e772011-09-14 18:33:51 +0000155_C_node<_Cont>::__dereferenceable(const void* __i) const
156{
157 typedef typename _Cont::const_iterator iterator;
158 const iterator* __j = static_cast<const iterator*>(__i);
Howard Hinnantc834c512011-11-29 18:15:50 +0000159 _Cont* _Cp = static_cast<_Cont*>(__c_);
160 return _Cp->__dereferenceable(__j);
Howard Hinnant27e0e772011-09-14 18:33:51 +0000161}
162
163template <class _Cont>
Eric Fiselierfb825432016-12-28 04:58:52 +0000164inline bool
Howard Hinnant27e0e772011-09-14 18:33:51 +0000165_C_node<_Cont>::__decrementable(const void* __i) const
166{
167 typedef typename _Cont::const_iterator iterator;
168 const iterator* __j = static_cast<const iterator*>(__i);
Howard Hinnantc834c512011-11-29 18:15:50 +0000169 _Cont* _Cp = static_cast<_Cont*>(__c_);
170 return _Cp->__decrementable(__j);
Howard Hinnant27e0e772011-09-14 18:33:51 +0000171}
172
173template <class _Cont>
Eric Fiselierfb825432016-12-28 04:58:52 +0000174inline bool
Howard Hinnant27e0e772011-09-14 18:33:51 +0000175_C_node<_Cont>::__addable(const void* __i, ptrdiff_t __n) const
176{
177 typedef typename _Cont::const_iterator iterator;
178 const iterator* __j = static_cast<const iterator*>(__i);
Howard Hinnantc834c512011-11-29 18:15:50 +0000179 _Cont* _Cp = static_cast<_Cont*>(__c_);
180 return _Cp->__addable(__j, __n);
Howard Hinnant27e0e772011-09-14 18:33:51 +0000181}
182
183template <class _Cont>
Eric Fiselierfb825432016-12-28 04:58:52 +0000184inline bool
Howard Hinnant27e0e772011-09-14 18:33:51 +0000185_C_node<_Cont>::__subscriptable(const void* __i, ptrdiff_t __n) const
186{
187 typedef typename _Cont::const_iterator iterator;
188 const iterator* __j = static_cast<const iterator*>(__i);
Howard Hinnantc834c512011-11-29 18:15:50 +0000189 _Cont* _Cp = static_cast<_Cont*>(__c_);
190 return _Cp->__subscriptable(__j, __n);
Howard Hinnant27e0e772011-09-14 18:33:51 +0000191}
192
Howard Hinnant8331b762013-03-06 23:30:19 +0000193class _LIBCPP_TYPE_VIS __libcpp_db
Howard Hinnant27e0e772011-09-14 18:33:51 +0000194{
195 __c_node** __cbeg_;
196 __c_node** __cend_;
197 size_t __csz_;
198 __i_node** __ibeg_;
199 __i_node** __iend_;
200 size_t __isz_;
201
202 __libcpp_db();
203public:
Eric Fiselier2d8515f2017-01-06 20:58:25 +0000204#ifndef _LIBCPP_CXX03_LANG
Howard Hinnant27e0e772011-09-14 18:33:51 +0000205 __libcpp_db(const __libcpp_db&) = delete;
206 __libcpp_db& operator=(const __libcpp_db&) = delete;
Howard Hinnant8ea98242013-08-23 17:37:05 +0000207#else
208private:
209 __libcpp_db(const __libcpp_db&);
210 __libcpp_db& operator=(const __libcpp_db&);
211public:
212#endif
Howard Hinnant27e0e772011-09-14 18:33:51 +0000213 ~__libcpp_db();
214
215 class __db_c_iterator;
216 class __db_c_const_iterator;
217 class __db_i_iterator;
218 class __db_i_const_iterator;
219
220 __db_c_const_iterator __c_end() const;
221 __db_i_const_iterator __i_end() const;
222
Eric Fiselieraed4eab2019-03-05 02:10:31 +0000223 typedef __c_node*(_InsertConstruct)(void*, void*, __c_node*);
224
225 template <class _Cont>
226 _LIBCPP_INLINE_VISIBILITY static __c_node* __create_C_node(void *__mem, void *__c, __c_node *__next) {
227 return ::new(__mem) _C_node<_Cont>(__c, __next);
228 }
229
Howard Hinnant27e0e772011-09-14 18:33:51 +0000230 template <class _Cont>
231 _LIBCPP_INLINE_VISIBILITY
232 void __insert_c(_Cont* __c)
233 {
Eric Fiselieraed4eab2019-03-05 02:10:31 +0000234 __insert_c(static_cast<void*>(__c), &__create_C_node<_Cont>);
Howard Hinnant27e0e772011-09-14 18:33:51 +0000235 }
236
Howard Hinnantc90aa632011-09-16 19:52:23 +0000237 void __insert_i(void* __i);
Eric Fiselieraed4eab2019-03-05 02:10:31 +0000238 void __insert_c(void* __c, _InsertConstruct* __fn);
Howard Hinnant27e0e772011-09-14 18:33:51 +0000239 void __erase_c(void* __c);
240
241 void __insert_ic(void* __i, const void* __c);
242 void __iterator_copy(void* __i, const void* __i0);
243 void __erase_i(void* __i);
244
245 void* __find_c_from_i(void* __i) const;
246 void __invalidate_all(void* __c);
247 __c_node* __find_c_and_lock(void* __c) const;
Howard Hinnantb399c602011-09-27 23:55:03 +0000248 __c_node* __find_c(void* __c) const;
Howard Hinnant27e0e772011-09-14 18:33:51 +0000249 void unlock() const;
250
251 void swap(void* __c1, void* __c2);
252
253
254 bool __dereferenceable(const void* __i) const;
255 bool __decrementable(const void* __i) const;
256 bool __addable(const void* __i, ptrdiff_t __n) const;
257 bool __subscriptable(const void* __i, ptrdiff_t __n) const;
Howard Hinnante6ff0b62013-08-02 00:26:35 +0000258 bool __less_than_comparable(const void* __i, const void* __j) const;
Howard Hinnant27e0e772011-09-14 18:33:51 +0000259private:
260 _LIBCPP_HIDDEN
261 __i_node* __insert_iterator(void* __i);
262 _LIBCPP_HIDDEN
263 __i_node* __find_iterator(const void* __i) const;
264
Howard Hinnant8331b762013-03-06 23:30:19 +0000265 friend _LIBCPP_FUNC_VIS __libcpp_db* __get_db();
Howard Hinnant27e0e772011-09-14 18:33:51 +0000266};
267
Howard Hinnant8331b762013-03-06 23:30:19 +0000268_LIBCPP_FUNC_VIS __libcpp_db* __get_db();
269_LIBCPP_FUNC_VIS const __libcpp_db* __get_const_db();
Howard Hinnant27e0e772011-09-14 18:33:51 +0000270
271
Louis Dionneba400782020-10-02 15:02:52 -0400272#endif // _LIBCPP_DEBUG_LEVEL == 2 || defined(_LIBCPP_BUILDING_LIBRARY)
Howard Hinnant27e0e772011-09-14 18:33:51 +0000273
Eric Fiselierfb825432016-12-28 04:58:52 +0000274_LIBCPP_END_NAMESPACE_STD
Howard Hinnanta47c6d52011-09-16 17:29:17 +0000275
Howard Hinnant27e0e772011-09-14 18:33:51 +0000276#endif // _LIBCPP_DEBUG_H