2 //===--------------------------- __debug ----------------------------------===//
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
8 //===----------------------------------------------------------------------===//
10 #ifndef _LIBCPP_DEBUG_H
11 #define _LIBCPP_DEBUG_H
16 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
17 #pragma GCC system_header
20 #if defined(_LIBCPP_HAS_NO_NULLPTR)
24 #if _LIBCPP_DEBUG_LEVEL >= 1 || defined(_LIBCPP_BUILDING_LIBRARY)
30 #if _LIBCPP_DEBUG_LEVEL >= 1 && !defined(_LIBCPP_ASSERT)
31 # define _LIBCPP_ASSERT(x, m) ((x) ? (void)0 : \
32 _VSTD::__libcpp_debug_function(_VSTD::__libcpp_debug_info(__FILE__, __LINE__, #x, m)))
35 #if _LIBCPP_DEBUG_LEVEL >= 2
36 #ifndef _LIBCPP_DEBUG_ASSERT
37 #define _LIBCPP_DEBUG_ASSERT(x, m) _LIBCPP_ASSERT(x, m)
39 #define _LIBCPP_DEBUG_MODE(...) __VA_ARGS__
42 #ifndef _LIBCPP_ASSERT
43 # define _LIBCPP_ASSERT(x, m) ((void)0)
45 #ifndef _LIBCPP_DEBUG_ASSERT
46 # define _LIBCPP_DEBUG_ASSERT(x, m) ((void)0)
48 #ifndef _LIBCPP_DEBUG_MODE
49 #define _LIBCPP_DEBUG_MODE(...) ((void)0)
52 _LIBCPP_BEGIN_NAMESPACE_STD
54 struct _LIBCPP_TEMPLATE_VIS __libcpp_debug_info {
55 _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR
57 : __file_(nullptr), __line_(-1), __pred_(nullptr), __msg_(nullptr) {}
58 _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR
59 __libcpp_debug_info(const char* __f, int __l, const char* __p, const char* __m)
60 : __file_(__f), __line_(__l), __pred_(__p), __msg_(__m) {}
62 _LIBCPP_FUNC_VIS std::string what() const;
70 /// __libcpp_debug_function_type - The type of the assertion failure handler.
71 typedef void(*__libcpp_debug_function_type)(__libcpp_debug_info const&);
73 /// __libcpp_debug_function - The handler function called when a _LIBCPP_ASSERT
75 extern _LIBCPP_EXPORTED_FROM_ABI __libcpp_debug_function_type __libcpp_debug_function;
77 /// __libcpp_abort_debug_function - A debug handler that aborts when called.
78 _LIBCPP_NORETURN _LIBCPP_FUNC_VIS
79 void __libcpp_abort_debug_function(__libcpp_debug_info const&);
81 /// __libcpp_set_debug_function - Set the debug handler to the specified
84 bool __libcpp_set_debug_function(__libcpp_debug_function_type __func);
86 #if _LIBCPP_DEBUG_LEVEL >= 2 || defined(_LIBCPP_BUILDING_LIBRARY)
88 struct _LIBCPP_TYPE_VIS __c_node;
90 struct _LIBCPP_TYPE_VIS __i_node
96 #ifndef _LIBCPP_CXX03_LANG
97 __i_node(const __i_node&) = delete;
98 __i_node& operator=(const __i_node&) = delete;
101 __i_node(const __i_node&);
102 __i_node& operator=(const __i_node&);
105 _LIBCPP_INLINE_VISIBILITY
106 __i_node(void* __i, __i_node* __next, __c_node* __c)
107 : __i_(__i), __next_(__next), __c_(__c) {}
111 struct _LIBCPP_TYPE_VIS __c_node
119 #ifndef _LIBCPP_CXX03_LANG
120 __c_node(const __c_node&) = delete;
121 __c_node& operator=(const __c_node&) = delete;
124 __c_node(const __c_node&);
125 __c_node& operator=(const __c_node&);
128 _LIBCPP_INLINE_VISIBILITY
129 __c_node(void* __c, __c_node* __next)
130 : __c_(__c), __next_(__next), beg_(nullptr), end_(nullptr), cap_(nullptr) {}
133 virtual bool __dereferenceable(const void*) const = 0;
134 virtual bool __decrementable(const void*) const = 0;
135 virtual bool __addable(const void*, ptrdiff_t) const = 0;
136 virtual bool __subscriptable(const void*, ptrdiff_t) const = 0;
138 void __add(__i_node* __i);
139 _LIBCPP_HIDDEN void __remove(__i_node* __i);
142 template <class _Cont>
146 _C_node(void* __c, __c_node* __n)
147 : __c_node(__c, __n) {}
149 virtual bool __dereferenceable(const void*) const;
150 virtual bool __decrementable(const void*) const;
151 virtual bool __addable(const void*, ptrdiff_t) const;
152 virtual bool __subscriptable(const void*, ptrdiff_t) const;
155 template <class _Cont>
157 _C_node<_Cont>::__dereferenceable(const void* __i) const
159 typedef typename _Cont::const_iterator iterator;
160 const iterator* __j = static_cast<const iterator*>(__i);
161 _Cont* _Cp = static_cast<_Cont*>(__c_);
162 return _Cp->__dereferenceable(__j);
165 template <class _Cont>
167 _C_node<_Cont>::__decrementable(const void* __i) const
169 typedef typename _Cont::const_iterator iterator;
170 const iterator* __j = static_cast<const iterator*>(__i);
171 _Cont* _Cp = static_cast<_Cont*>(__c_);
172 return _Cp->__decrementable(__j);
175 template <class _Cont>
177 _C_node<_Cont>::__addable(const void* __i, ptrdiff_t __n) const
179 typedef typename _Cont::const_iterator iterator;
180 const iterator* __j = static_cast<const iterator*>(__i);
181 _Cont* _Cp = static_cast<_Cont*>(__c_);
182 return _Cp->__addable(__j, __n);
185 template <class _Cont>
187 _C_node<_Cont>::__subscriptable(const void* __i, ptrdiff_t __n) const
189 typedef typename _Cont::const_iterator iterator;
190 const iterator* __j = static_cast<const iterator*>(__i);
191 _Cont* _Cp = static_cast<_Cont*>(__c_);
192 return _Cp->__subscriptable(__j, __n);
195 class _LIBCPP_TYPE_VIS __libcpp_db
206 #ifndef _LIBCPP_CXX03_LANG
207 __libcpp_db(const __libcpp_db&) = delete;
208 __libcpp_db& operator=(const __libcpp_db&) = delete;
211 __libcpp_db(const __libcpp_db&);
212 __libcpp_db& operator=(const __libcpp_db&);
217 class __db_c_iterator;
218 class __db_c_const_iterator;
219 class __db_i_iterator;
220 class __db_i_const_iterator;
222 __db_c_const_iterator __c_end() const;
223 __db_i_const_iterator __i_end() const;
225 typedef __c_node*(_InsertConstruct)(void*, void*, __c_node*);
227 template <class _Cont>
228 _LIBCPP_INLINE_VISIBILITY static __c_node* __create_C_node(void *__mem, void *__c, __c_node *__next) {
229 return ::new(__mem) _C_node<_Cont>(__c, __next);
232 template <class _Cont>
233 _LIBCPP_INLINE_VISIBILITY
234 void __insert_c(_Cont* __c)
236 __insert_c(static_cast<void*>(__c), &__create_C_node<_Cont>);
239 void __insert_i(void* __i);
240 void __insert_c(void* __c, _InsertConstruct* __fn);
241 void __erase_c(void* __c);
243 void __insert_ic(void* __i, const void* __c);
244 void __iterator_copy(void* __i, const void* __i0);
245 void __erase_i(void* __i);
247 void* __find_c_from_i(void* __i) const;
248 void __invalidate_all(void* __c);
249 __c_node* __find_c_and_lock(void* __c) const;
250 __c_node* __find_c(void* __c) const;
253 void swap(void* __c1, void* __c2);
256 bool __dereferenceable(const void* __i) const;
257 bool __decrementable(const void* __i) const;
258 bool __addable(const void* __i, ptrdiff_t __n) const;
259 bool __subscriptable(const void* __i, ptrdiff_t __n) const;
260 bool __less_than_comparable(const void* __i, const void* __j) const;
263 __i_node* __insert_iterator(void* __i);
265 __i_node* __find_iterator(const void* __i) const;
267 friend _LIBCPP_FUNC_VIS __libcpp_db* __get_db();
270 _LIBCPP_FUNC_VIS __libcpp_db* __get_db();
271 _LIBCPP_FUNC_VIS const __libcpp_db* __get_const_db();
274 #endif // _LIBCPP_DEBUG_LEVEL >= 2 || defined(_LIBCPP_BUILDING_LIBRARY)
276 _LIBCPP_END_NAMESPACE_STD
278 #endif // _LIBCPP_DEBUG_H