1// -*- C++ -*-
2//===--------------------------- __debug ----------------------------------===//
3//
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
7//
8//===----------------------------------------------------------------------===//
9
10#ifndef _LIBCPP_DEBUG_H
11#define _LIBCPP_DEBUG_H
12
13#include <__config>
14#include <iosfwd>
15
16#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
17#pragma GCC system_header
18#endif
19
20#if defined(_LIBCPP_HAS_NO_NULLPTR)
21# include <cstddef>
22#endif
23
24#if _LIBCPP_DEBUG_LEVEL >= 1 || defined(_LIBCPP_BUILDING_LIBRARY)
25#   include <cstdlib>
26#   include <cstdio>
27#   include <cstddef>
28#endif
29
30#if _LIBCPP_DEBUG_LEVEL == 0
31#   define _LIBCPP_DEBUG_ASSERT(x, m) ((void)0)
32#   define _LIBCPP_ASSERT_IMPL(x, m) ((void)0)
33#elif _LIBCPP_DEBUG_LEVEL == 1
34#   define _LIBCPP_DEBUG_ASSERT(x, m) ((void)0)
35#   define _LIBCPP_ASSERT_IMPL(x, m) ((x) ? (void)0 : _VSTD::__libcpp_debug_function(_VSTD::__libcpp_debug_info(__FILE__, __LINE__, #x, m)))
36#elif _LIBCPP_DEBUG_LEVEL == 2
37#   define _LIBCPP_DEBUG_ASSERT(x, m) _LIBCPP_ASSERT(x, m)
38#   define _LIBCPP_ASSERT_IMPL(x, m) ((x) ? (void)0 : _VSTD::__libcpp_debug_function(_VSTD::__libcpp_debug_info(__FILE__, __LINE__, #x, m)))
39#else
40#   error _LIBCPP_DEBUG_LEVEL must be one of 0, 1, 2
41#endif
42
43#if !defined(_LIBCPP_ASSERT)
44#   define _LIBCPP_ASSERT(x, m) _LIBCPP_ASSERT_IMPL(x, m)
45#endif
46
47_LIBCPP_BEGIN_NAMESPACE_STD
48
49struct _LIBCPP_TEMPLATE_VIS __libcpp_debug_info {
50  _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR
51  __libcpp_debug_info()
52      : __file_(nullptr), __line_(-1), __pred_(nullptr), __msg_(nullptr) {}
53  _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR
54  __libcpp_debug_info(const char* __f, int __l, const char* __p, const char* __m)
55    : __file_(__f), __line_(__l), __pred_(__p), __msg_(__m) {}
56
57  _LIBCPP_FUNC_VIS string what() const;
58
59  const char* __file_;
60  int __line_;
61  const char* __pred_;
62  const char* __msg_;
63};
64
65/// __libcpp_debug_function_type - The type of the assertion failure handler.
66typedef void(*__libcpp_debug_function_type)(__libcpp_debug_info const&);
67
68/// __libcpp_debug_function - The handler function called when a _LIBCPP_ASSERT
69///    fails.
70extern _LIBCPP_EXPORTED_FROM_ABI __libcpp_debug_function_type __libcpp_debug_function;
71
72/// __libcpp_abort_debug_function - A debug handler that aborts when called.
73_LIBCPP_NORETURN _LIBCPP_FUNC_VIS
74void __libcpp_abort_debug_function(__libcpp_debug_info const&);
75
76/// __libcpp_set_debug_function - Set the debug handler to the specified
77///    function.
78_LIBCPP_FUNC_VIS
79bool __libcpp_set_debug_function(__libcpp_debug_function_type __func);
80
81#if _LIBCPP_DEBUG_LEVEL == 2 || defined(_LIBCPP_BUILDING_LIBRARY)
82
83struct _LIBCPP_TYPE_VIS __c_node;
84
85struct _LIBCPP_TYPE_VIS __i_node
86{
87    void* __i_;
88    __i_node* __next_;
89    __c_node* __c_;
90
91#ifndef _LIBCPP_CXX03_LANG
92    __i_node(const __i_node&) = delete;
93    __i_node& operator=(const __i_node&) = delete;
94#else
95private:
96    __i_node(const __i_node&);
97    __i_node& operator=(const __i_node&);
98public:
99#endif
100    _LIBCPP_INLINE_VISIBILITY
101    __i_node(void* __i, __i_node* __next, __c_node* __c)
102        : __i_(__i), __next_(__next), __c_(__c) {}
103    ~__i_node();
104};
105
106struct _LIBCPP_TYPE_VIS __c_node
107{
108    void* __c_;
109    __c_node* __next_;
110    __i_node** beg_;
111    __i_node** end_;
112    __i_node** cap_;
113
114#ifndef _LIBCPP_CXX03_LANG
115    __c_node(const __c_node&) = delete;
116    __c_node& operator=(const __c_node&) = delete;
117#else
118private:
119    __c_node(const __c_node&);
120    __c_node& operator=(const __c_node&);
121public:
122#endif
123    _LIBCPP_INLINE_VISIBILITY
124    __c_node(void* __c, __c_node* __next)
125        : __c_(__c), __next_(__next), beg_(nullptr), end_(nullptr), cap_(nullptr) {}
126    virtual ~__c_node();
127
128    virtual bool __dereferenceable(const void*) const = 0;
129    virtual bool __decrementable(const void*) const = 0;
130    virtual bool __addable(const void*, ptrdiff_t) const = 0;
131    virtual bool __subscriptable(const void*, ptrdiff_t) const = 0;
132
133    void __add(__i_node* __i);
134    _LIBCPP_HIDDEN void __remove(__i_node* __i);
135};
136
137template <class _Cont>
138struct _C_node
139    : public __c_node
140{
141    _C_node(void* __c, __c_node* __n)
142        : __c_node(__c, __n) {}
143
144    virtual bool __dereferenceable(const void*) const;
145    virtual bool __decrementable(const void*) const;
146    virtual bool __addable(const void*, ptrdiff_t) const;
147    virtual bool __subscriptable(const void*, ptrdiff_t) const;
148};
149
150template <class _Cont>
151inline bool
152_C_node<_Cont>::__dereferenceable(const void* __i) const
153{
154    typedef typename _Cont::const_iterator iterator;
155    const iterator* __j = static_cast<const iterator*>(__i);
156    _Cont* _Cp = static_cast<_Cont*>(__c_);
157    return _Cp->__dereferenceable(__j);
158}
159
160template <class _Cont>
161inline bool
162_C_node<_Cont>::__decrementable(const void* __i) const
163{
164    typedef typename _Cont::const_iterator iterator;
165    const iterator* __j = static_cast<const iterator*>(__i);
166    _Cont* _Cp = static_cast<_Cont*>(__c_);
167    return _Cp->__decrementable(__j);
168}
169
170template <class _Cont>
171inline bool
172_C_node<_Cont>::__addable(const void* __i, ptrdiff_t __n) const
173{
174    typedef typename _Cont::const_iterator iterator;
175    const iterator* __j = static_cast<const iterator*>(__i);
176    _Cont* _Cp = static_cast<_Cont*>(__c_);
177    return _Cp->__addable(__j, __n);
178}
179
180template <class _Cont>
181inline bool
182_C_node<_Cont>::__subscriptable(const void* __i, ptrdiff_t __n) const
183{
184    typedef typename _Cont::const_iterator iterator;
185    const iterator* __j = static_cast<const iterator*>(__i);
186    _Cont* _Cp = static_cast<_Cont*>(__c_);
187    return _Cp->__subscriptable(__j, __n);
188}
189
190class _LIBCPP_TYPE_VIS __libcpp_db
191{
192    __c_node** __cbeg_;
193    __c_node** __cend_;
194    size_t   __csz_;
195    __i_node** __ibeg_;
196    __i_node** __iend_;
197    size_t   __isz_;
198
199    __libcpp_db();
200public:
201#ifndef _LIBCPP_CXX03_LANG
202    __libcpp_db(const __libcpp_db&) = delete;
203    __libcpp_db& operator=(const __libcpp_db&) = delete;
204#else
205private:
206    __libcpp_db(const __libcpp_db&);
207    __libcpp_db& operator=(const __libcpp_db&);
208public:
209#endif
210    ~__libcpp_db();
211
212    class __db_c_iterator;
213    class __db_c_const_iterator;
214    class __db_i_iterator;
215    class __db_i_const_iterator;
216
217    __db_c_const_iterator __c_end() const;
218    __db_i_const_iterator __i_end() const;
219
220    typedef __c_node*(_InsertConstruct)(void*, void*, __c_node*);
221
222    template <class _Cont>
223    _LIBCPP_INLINE_VISIBILITY static __c_node* __create_C_node(void *__mem, void *__c, __c_node *__next) {
224        return ::new(__mem) _C_node<_Cont>(__c, __next);
225    }
226
227    template <class _Cont>
228    _LIBCPP_INLINE_VISIBILITY
229    void __insert_c(_Cont* __c)
230    {
231        __insert_c(static_cast<void*>(__c), &__create_C_node<_Cont>);
232    }
233
234    void __insert_i(void* __i);
235    void __insert_c(void* __c, _InsertConstruct* __fn);
236    void __erase_c(void* __c);
237
238    void __insert_ic(void* __i, const void* __c);
239    void __iterator_copy(void* __i, const void* __i0);
240    void __erase_i(void* __i);
241
242    void* __find_c_from_i(void* __i) const;
243    void __invalidate_all(void* __c);
244    __c_node* __find_c_and_lock(void* __c) const;
245    __c_node* __find_c(void* __c) const;
246    void unlock() const;
247
248    void swap(void* __c1, void* __c2);
249
250
251    bool __dereferenceable(const void* __i) const;
252    bool __decrementable(const void* __i) const;
253    bool __addable(const void* __i, ptrdiff_t __n) const;
254    bool __subscriptable(const void* __i, ptrdiff_t __n) const;
255    bool __less_than_comparable(const void* __i, const void* __j) const;
256private:
257    _LIBCPP_HIDDEN
258    __i_node* __insert_iterator(void* __i);
259    _LIBCPP_HIDDEN
260    __i_node* __find_iterator(const void* __i) const;
261
262    friend _LIBCPP_FUNC_VIS __libcpp_db* __get_db();
263};
264
265_LIBCPP_FUNC_VIS __libcpp_db* __get_db();
266_LIBCPP_FUNC_VIS const __libcpp_db* __get_const_db();
267
268
269#endif // _LIBCPP_DEBUG_LEVEL == 2 || defined(_LIBCPP_BUILDING_LIBRARY)
270
271_LIBCPP_END_NAMESPACE_STD
272
273#endif  // _LIBCPP_DEBUG_H
274