blob: e0cef09ee0a7d50dbde41b928667f2b5a5572f32 [file] [log] [blame]
Howard Hinnant7a563db2011-09-14 18:33:51 +00001// -*- C++ -*-
2//===--------------------------- __debug ----------------------------------===//
3//
4// The LLVM Compiler Infrastructure
5//
6// This file is dual licensed under the MIT and the University of Illinois Open
7// Source Licenses. See LICENSE.TXT for details.
8//
9//===----------------------------------------------------------------------===//
10
11#ifndef _LIBCPP_DEBUG_H
12#define _LIBCPP_DEBUG_H
13
Eric Fiselierb9536102014-08-10 23:53:08 +000014#include <__config>
15
Howard Hinnant499cea12013-08-23 17:37:05 +000016#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
17#pragma GCC system_header
18#endif
19
Eric Fiselier01eb99a2016-12-28 04:58:52 +000020#if _LIBCPP_DEBUG_LEVEL >= 1 || defined(_LIBCPP_BUILDING_LIBRARY)
Howard Hinnant7a563db2011-09-14 18:33:51 +000021# include <cstdlib>
22# include <cstdio>
23# include <cstddef>
Eric Fiselier01eb99a2016-12-28 04:58:52 +000024# include <exception>
25#endif
26
27#if _LIBCPP_DEBUG_LEVEL >= 1 && !defined(_LIBCPP_ASSERT)
28# define _LIBCPP_ASSERT(x, m) ((x) ? (void)0 : \
29 _VSTD::__libcpp_debug_function(_VSTD::__libcpp_debug_info{__FILE__, __LINE__, #x, m}))
Eric Fiselierb9536102014-08-10 23:53:08 +000030#endif
Howard Hinnant7a563db2011-09-14 18:33:51 +000031
Eric Fiselierf6535882016-07-23 20:36:55 +000032#if _LIBCPP_DEBUG_LEVEL >= 2
33#ifndef _LIBCPP_DEBUG_ASSERT
34#define _LIBCPP_DEBUG_ASSERT(x, m) _LIBCPP_ASSERT(x, m)
35#endif
36#define _LIBCPP_DEBUG_MODE(...) __VA_ARGS__
37#endif
38
Eric Fiselierb9536102014-08-10 23:53:08 +000039#ifndef _LIBCPP_ASSERT
40# define _LIBCPP_ASSERT(x, m) ((void)0)
Howard Hinnantabe26282011-09-16 17:29:17 +000041#endif
Eric Fiselierf6535882016-07-23 20:36:55 +000042#ifndef _LIBCPP_DEBUG_ASSERT
43# define _LIBCPP_DEBUG_ASSERT(x, m) ((void)0)
44#endif
45#ifndef _LIBCPP_DEBUG_MODE
46#define _LIBCPP_DEBUG_MODE(...) ((void)0)
47#endif
Howard Hinnantabe26282011-09-16 17:29:17 +000048
Eric Fiselier01eb99a2016-12-28 04:58:52 +000049#if _LIBCPP_DEBUG_LEVEL < 1
50class _LIBCPP_EXCEPTION_ABI __libcpp_debug_exception;
51#endif
Howard Hinnantabe26282011-09-16 17:29:17 +000052
Howard Hinnant7a563db2011-09-14 18:33:51 +000053_LIBCPP_BEGIN_NAMESPACE_STD
54
Eric Fiselier01eb99a2016-12-28 04:58:52 +000055struct _LIBCPP_TYPE_VIS_ONLY __libcpp_debug_info {
56 const char* __file_;
57 int __line_;
58 const char* __pred_;
59 const char* __msg_;
60};
61
62/// __libcpp_debug_function_type - The type of the assertion failure handler.
63typedef void(*__libcpp_debug_function_type)(__libcpp_debug_info const&);
64
65/// __libcpp_debug_function - The handler function called when a _LIBCPP_ASSERT
66/// fails.
67extern __libcpp_debug_function_type __libcpp_debug_function;
68
69/// __libcpp_abort_debug_function - A debug handler that aborts when called.
70_LIBCPP_NORETURN _LIBCPP_FUNC_VIS
71void __libcpp_abort_debug_function(__libcpp_debug_info const&);
72
73/// __libcpp_throw_debug_function - A debug handler that throws
74/// an instance of __libcpp_debug_exception when called.
75 _LIBCPP_NORETURN _LIBCPP_FUNC_VIS
76void __libcpp_throw_debug_function(__libcpp_debug_info const&);
77
78/// __libcpp_set_debug_function - Set the debug handler to the specified
79/// function.
80_LIBCPP_FUNC_VIS
81bool __libcpp_set_debug_function(__libcpp_debug_function_type __func);
82
83// Setup the throwing debug handler during dynamic initialization.
84#if _LIBCPP_DEBUG_LEVEL >= 1 && defined(_LIBCPP_DEBUG_USE_EXCEPTIONS)
Eric Fiselier51d64bb2016-12-28 05:20:27 +000085# if defined(_LIBCPP_NO_EXCEPTIONS)
86# error _LIBCPP_DEBUG_USE_EXCEPTIONS cannot be used when exceptions are disabled.
87# endif
Eric Fiselier01eb99a2016-12-28 04:58:52 +000088static bool __init_dummy = __libcpp_set_debug_function(__libcpp_throw_debug_function);
89#endif
90
91#if _LIBCPP_DEBUG_LEVEL >= 1 || defined(_LIBCPP_BUILDING_LIBRARY)
92class _LIBCPP_EXCEPTION_ABI __libcpp_debug_exception : public exception {
93public:
94 __libcpp_debug_exception() _NOEXCEPT;
95 explicit __libcpp_debug_exception(__libcpp_debug_info const& __i);
96 __libcpp_debug_exception(__libcpp_debug_exception const&);
97 ~__libcpp_debug_exception() _NOEXCEPT;
98 const char* what() const _NOEXCEPT;
99private:
100 struct __libcpp_debug_exception_imp;
101 __libcpp_debug_exception_imp *__imp_;
102};
103#endif
104
105#if _LIBCPP_DEBUG_LEVEL >= 2 || defined(_LIBCPP_BUILDING_LIBRARY)
106
Howard Hinnant83eade62013-03-06 23:30:19 +0000107struct _LIBCPP_TYPE_VIS __c_node;
Howard Hinnant7a563db2011-09-14 18:33:51 +0000108
Howard Hinnant83eade62013-03-06 23:30:19 +0000109struct _LIBCPP_TYPE_VIS __i_node
Howard Hinnant7a563db2011-09-14 18:33:51 +0000110{
111 void* __i_;
112 __i_node* __next_;
113 __c_node* __c_;
114
Howard Hinnant499cea12013-08-23 17:37:05 +0000115#ifndef _LIBCPP_HAS_NO_DELETED_FUNCTIONS
Howard Hinnant7a563db2011-09-14 18:33:51 +0000116 __i_node(const __i_node&) = delete;
117 __i_node& operator=(const __i_node&) = delete;
Howard Hinnant499cea12013-08-23 17:37:05 +0000118#else
119private:
120 __i_node(const __i_node&);
121 __i_node& operator=(const __i_node&);
122public:
123#endif
Howard Hinnant7a563db2011-09-14 18:33:51 +0000124 _LIBCPP_INLINE_VISIBILITY
125 __i_node(void* __i, __i_node* __next, __c_node* __c)
126 : __i_(__i), __next_(__next), __c_(__c) {}
127 ~__i_node();
128};
129
Howard Hinnant83eade62013-03-06 23:30:19 +0000130struct _LIBCPP_TYPE_VIS __c_node
Howard Hinnant7a563db2011-09-14 18:33:51 +0000131{
132 void* __c_;
133 __c_node* __next_;
134 __i_node** beg_;
135 __i_node** end_;
136 __i_node** cap_;
137
Howard Hinnant499cea12013-08-23 17:37:05 +0000138#ifndef _LIBCPP_HAS_NO_DELETED_FUNCTIONS
Howard Hinnant7a563db2011-09-14 18:33:51 +0000139 __c_node(const __c_node&) = delete;
140 __c_node& operator=(const __c_node&) = delete;
Howard Hinnant499cea12013-08-23 17:37:05 +0000141#else
142private:
143 __c_node(const __c_node&);
144 __c_node& operator=(const __c_node&);
145public:
146#endif
Howard Hinnant7a563db2011-09-14 18:33:51 +0000147 _LIBCPP_INLINE_VISIBILITY
148 __c_node(void* __c, __c_node* __next)
149 : __c_(__c), __next_(__next), beg_(nullptr), end_(nullptr), cap_(nullptr) {}
150 virtual ~__c_node();
151
152 virtual bool __dereferenceable(const void*) const = 0;
153 virtual bool __decrementable(const void*) const = 0;
154 virtual bool __addable(const void*, ptrdiff_t) const = 0;
155 virtual bool __subscriptable(const void*, ptrdiff_t) const = 0;
156
Howard Hinnant1c3ec6d2011-09-27 23:55:03 +0000157 void __add(__i_node* __i);
Howard Hinnant7a563db2011-09-14 18:33:51 +0000158 _LIBCPP_HIDDEN void __remove(__i_node* __i);
159};
160
161template <class _Cont>
162struct _C_node
163 : public __c_node
164{
165 _C_node(void* __c, __c_node* __n)
166 : __c_node(__c, __n) {}
167
168 virtual bool __dereferenceable(const void*) const;
169 virtual bool __decrementable(const void*) const;
170 virtual bool __addable(const void*, ptrdiff_t) const;
171 virtual bool __subscriptable(const void*, ptrdiff_t) const;
172};
173
174template <class _Cont>
Eric Fiselier01eb99a2016-12-28 04:58:52 +0000175inline bool
Howard Hinnant7a563db2011-09-14 18:33:51 +0000176_C_node<_Cont>::__dereferenceable(const void* __i) const
177{
178 typedef typename _Cont::const_iterator iterator;
179 const iterator* __j = static_cast<const iterator*>(__i);
Howard Hinnant99968442011-11-29 18:15:50 +0000180 _Cont* _Cp = static_cast<_Cont*>(__c_);
181 return _Cp->__dereferenceable(__j);
Howard Hinnant7a563db2011-09-14 18:33:51 +0000182}
183
184template <class _Cont>
Eric Fiselier01eb99a2016-12-28 04:58:52 +0000185inline bool
Howard Hinnant7a563db2011-09-14 18:33:51 +0000186_C_node<_Cont>::__decrementable(const void* __i) const
187{
188 typedef typename _Cont::const_iterator iterator;
189 const iterator* __j = static_cast<const iterator*>(__i);
Howard Hinnant99968442011-11-29 18:15:50 +0000190 _Cont* _Cp = static_cast<_Cont*>(__c_);
191 return _Cp->__decrementable(__j);
Howard Hinnant7a563db2011-09-14 18:33:51 +0000192}
193
194template <class _Cont>
Eric Fiselier01eb99a2016-12-28 04:58:52 +0000195inline bool
Howard Hinnant7a563db2011-09-14 18:33:51 +0000196_C_node<_Cont>::__addable(const void* __i, ptrdiff_t __n) const
197{
198 typedef typename _Cont::const_iterator iterator;
199 const iterator* __j = static_cast<const iterator*>(__i);
Howard Hinnant99968442011-11-29 18:15:50 +0000200 _Cont* _Cp = static_cast<_Cont*>(__c_);
201 return _Cp->__addable(__j, __n);
Howard Hinnant7a563db2011-09-14 18:33:51 +0000202}
203
204template <class _Cont>
Eric Fiselier01eb99a2016-12-28 04:58:52 +0000205inline bool
Howard Hinnant7a563db2011-09-14 18:33:51 +0000206_C_node<_Cont>::__subscriptable(const void* __i, ptrdiff_t __n) const
207{
208 typedef typename _Cont::const_iterator iterator;
209 const iterator* __j = static_cast<const iterator*>(__i);
Howard Hinnant99968442011-11-29 18:15:50 +0000210 _Cont* _Cp = static_cast<_Cont*>(__c_);
211 return _Cp->__subscriptable(__j, __n);
Howard Hinnant7a563db2011-09-14 18:33:51 +0000212}
213
Howard Hinnant83eade62013-03-06 23:30:19 +0000214class _LIBCPP_TYPE_VIS __libcpp_db
Howard Hinnant7a563db2011-09-14 18:33:51 +0000215{
216 __c_node** __cbeg_;
217 __c_node** __cend_;
218 size_t __csz_;
219 __i_node** __ibeg_;
220 __i_node** __iend_;
221 size_t __isz_;
222
223 __libcpp_db();
224public:
Howard Hinnant499cea12013-08-23 17:37:05 +0000225#ifndef _LIBCPP_HAS_NO_DELETED_FUNCTIONS
Howard Hinnant7a563db2011-09-14 18:33:51 +0000226 __libcpp_db(const __libcpp_db&) = delete;
227 __libcpp_db& operator=(const __libcpp_db&) = delete;
Howard Hinnant499cea12013-08-23 17:37:05 +0000228#else
229private:
230 __libcpp_db(const __libcpp_db&);
231 __libcpp_db& operator=(const __libcpp_db&);
232public:
233#endif
Howard Hinnant7a563db2011-09-14 18:33:51 +0000234 ~__libcpp_db();
235
236 class __db_c_iterator;
237 class __db_c_const_iterator;
238 class __db_i_iterator;
239 class __db_i_const_iterator;
240
241 __db_c_const_iterator __c_end() const;
242 __db_i_const_iterator __i_end() const;
243
244 template <class _Cont>
245 _LIBCPP_INLINE_VISIBILITY
246 void __insert_c(_Cont* __c)
247 {
248 __c_node* __n = __insert_c(static_cast<void*>(__c));
249 ::new(__n) _C_node<_Cont>(__n->__c_, __n->__next_);
250 }
251
Howard Hinnant7608b4a2011-09-16 19:52:23 +0000252 void __insert_i(void* __i);
Howard Hinnant7a563db2011-09-14 18:33:51 +0000253 __c_node* __insert_c(void* __c);
254 void __erase_c(void* __c);
255
256 void __insert_ic(void* __i, const void* __c);
257 void __iterator_copy(void* __i, const void* __i0);
258 void __erase_i(void* __i);
259
260 void* __find_c_from_i(void* __i) const;
261 void __invalidate_all(void* __c);
262 __c_node* __find_c_and_lock(void* __c) const;
Howard Hinnant1c3ec6d2011-09-27 23:55:03 +0000263 __c_node* __find_c(void* __c) const;
Howard Hinnant7a563db2011-09-14 18:33:51 +0000264 void unlock() const;
265
266 void swap(void* __c1, void* __c2);
267
268
269 bool __dereferenceable(const void* __i) const;
270 bool __decrementable(const void* __i) const;
271 bool __addable(const void* __i, ptrdiff_t __n) const;
272 bool __subscriptable(const void* __i, ptrdiff_t __n) const;
Howard Hinnant8b00e6c2013-08-02 00:26:35 +0000273 bool __less_than_comparable(const void* __i, const void* __j) const;
Howard Hinnant7a563db2011-09-14 18:33:51 +0000274private:
275 _LIBCPP_HIDDEN
276 __i_node* __insert_iterator(void* __i);
277 _LIBCPP_HIDDEN
278 __i_node* __find_iterator(const void* __i) const;
279
Howard Hinnant83eade62013-03-06 23:30:19 +0000280 friend _LIBCPP_FUNC_VIS __libcpp_db* __get_db();
Howard Hinnant7a563db2011-09-14 18:33:51 +0000281};
282
Howard Hinnant83eade62013-03-06 23:30:19 +0000283_LIBCPP_FUNC_VIS __libcpp_db* __get_db();
284_LIBCPP_FUNC_VIS const __libcpp_db* __get_const_db();
Howard Hinnant7a563db2011-09-14 18:33:51 +0000285
286
Eric Fiselier01eb99a2016-12-28 04:58:52 +0000287#endif // _LIBCPP_DEBUG_LEVEL >= 2 || defined(_LIBCPP_BUILDING_LIBRARY)
Howard Hinnant7a563db2011-09-14 18:33:51 +0000288
Eric Fiselier01eb99a2016-12-28 04:58:52 +0000289_LIBCPP_END_NAMESPACE_STD
Howard Hinnantabe26282011-09-16 17:29:17 +0000290
Howard Hinnant7a563db2011-09-14 18:33:51 +0000291#endif // _LIBCPP_DEBUG_H
292