3 // Copyright (C) 2005-2019 Free Software Foundation, Inc.
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the terms
7 // of the GNU General Public License as published by the Free Software
8 // Foundation; either version 3, or (at your option) any later
11 // This library is distributed in the hope that it will be useful, but
12 // WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // General Public License for more details.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
25 // Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
27 // Permission to use, copy, modify, sell, and distribute this software
28 // is hereby granted without fee, provided that the above copyright
29 // notice appears in all copies, and that both that copyright notice
30 // and this permission notice appear in supporting documentation. None
31 // of the above authors, nor IBM Haifa Research Laboratories, make any
32 // representation about the suitability of this software for any
33 // purpose. It is provided "as is" without express or implied
36 /** @file ext/throw_allocator.h
37 * This file is a GNU extension to the Standard C++ Library.
39 * Contains two exception-generating types (throw_value, throw_allocator)
40 * intended to be used as value and allocator types while testing
41 * exception safety in templatized containers and algorithms. The
42 * allocator has additional log and debug features. The exception
43 * generated is of type forced_exception_error.
46 #ifndef _THROW_ALLOCATOR_H
47 #define _THROW_ALLOCATOR_H 1
56 #include <bits/functexcept.h>
57 #include <bits/move.h>
58 #if __cplusplus >= 201103L
59 # include <functional>
62 # include <tr1/functional>
63 # include <tr1/random>
66 namespace __gnu_cxx
_GLIBCXX_VISIBILITY(default)
68 _GLIBCXX_BEGIN_NAMESPACE_VERSION
71 * @brief Thown by exception safety machinery.
74 struct forced_error
: public std::exception
77 // Substitute for forced_error object when -fno-exceptions.
79 __throw_forced_error()
80 { _GLIBCXX_THROW_OR_ABORT(forced_error()); }
83 * @brief Base class for checking address and label information
84 * about allocations. Create a std::map between the allocated
85 * address (void*) and a datum for annotations, which are a pair of
86 * numbers corresponding to label and allocated size.
91 typedef std::pair
<size_t, size_t> data_type
;
92 typedef std::map
<void*, data_type
> map_alloc_type
;
93 typedef map_alloc_type::value_type entry_type
;
94 typedef map_alloc_type::const_iterator const_iterator
;
95 typedef map_alloc_type::const_reference const_reference
;
96 #if __cplusplus >= 201103L
97 typedef std::map
<void*, size_t> map_construct_type
;
116 insert(void* p
, size_t size
)
118 entry_type entry
= make_entry(p
, size
);
121 std::string
error("annotate_base::insert null insert!\n");
122 log_to_string(error
, entry
);
123 std::__throw_logic_error(error
.c_str());
126 std::pair
<map_alloc_type::iterator
, bool> inserted
127 = map_alloc().insert(entry
);
128 if (!inserted
.second
)
130 std::string
error("annotate_base::insert double insert!\n");
131 log_to_string(error
, entry
);
132 log_to_string(error
, *inserted
.first
);
133 std::__throw_logic_error(error
.c_str());
138 erase(void* p
, size_t size
)
139 { map_alloc().erase(check_allocated(p
, size
)); }
141 #if __cplusplus >= 201103L
143 insert_construct(void* p
)
147 std::string
error("annotate_base::insert_construct null!\n");
148 std::__throw_logic_error(error
.c_str());
151 auto inserted
= map_construct().insert(std::make_pair(p
, get_label()));
152 if (!inserted
.second
)
154 std::string
error("annotate_base::insert_construct double insert!\n");
155 log_to_string(error
, std::make_pair(p
, get_label()));
156 log_to_string(error
, *inserted
.first
);
157 std::__throw_logic_error(error
.c_str());
162 erase_construct(void* p
)
163 { map_construct().erase(check_constructed(p
)); }
166 // See if a particular address and allocation size has been saved.
167 inline map_alloc_type::iterator
168 check_allocated(void* p
, size_t size
)
170 map_alloc_type::iterator found
= map_alloc().find(p
);
171 if (found
== map_alloc().end())
173 std::string
error("annotate_base::check_allocated by value "
175 log_to_string(error
, make_entry(p
, size
));
176 std::__throw_logic_error(error
.c_str());
179 if (found
->second
.second
!= size
)
181 std::string
error("annotate_base::check_allocated by value "
182 "wrong-size erase!\n");
183 log_to_string(error
, make_entry(p
, size
));
184 log_to_string(error
, *found
);
185 std::__throw_logic_error(error
.c_str());
191 // See if a given label has been allocated.
197 const_iterator beg
= map_alloc().begin();
198 const_iterator end
= map_alloc().end();
201 if (beg
->second
.first
== label
)
202 log_to_string(found
, *beg
);
207 #if __cplusplus >= 201103L
209 auto beg
= map_construct().begin();
210 auto end
= map_construct().end();
213 if (beg
->second
== label
)
214 log_to_string(found
, *beg
);
222 std::string
error("annotate_base::check by label\n");
224 std::__throw_logic_error(error
.c_str());
228 // See if there is anything left allocated or constructed.
234 const_iterator beg
= map_alloc().begin();
235 const_iterator end
= map_alloc().end();
238 log_to_string(found
, *beg
);
243 #if __cplusplus >= 201103L
245 auto beg
= map_construct().begin();
246 auto end
= map_construct().end();
249 log_to_string(found
, *beg
);
257 std::string
error("annotate_base::check \n");
259 std::__throw_logic_error(error
.c_str());
263 #if __cplusplus >= 201103L
264 inline map_construct_type::iterator
265 check_constructed(void* p
)
267 auto found
= map_construct().find(p
);
268 if (found
== map_construct().end())
270 std::string
error("annotate_base::check_constructed not "
272 log_to_string(error
, std::make_pair(p
, get_label()));
273 std::__throw_logic_error(error
.c_str());
280 check_constructed(size_t label
)
282 auto beg
= map_construct().begin();
283 auto end
= map_construct().end();
287 if (beg
->second
== label
)
288 log_to_string(found
, *beg
);
294 std::string
error("annotate_base::check_constructed by label\n");
296 std::__throw_logic_error(error
.c_str());
303 operator<<(std::ostream
&, const annotate_base
&);
306 make_entry(void* p
, size_t size
)
307 { return std::make_pair(p
, data_type(get_label(), size
)); }
310 log_to_string(std::string
& s
, const_reference ref
)
313 const char tab('\t');
315 unsigned long l
= static_cast<unsigned long>(ref
.second
.first
);
316 __builtin_sprintf(buf
, "%lu", l
);
320 l
= static_cast<unsigned long>(ref
.second
.second
);
321 __builtin_sprintf(buf
, "%lu", l
);
325 __builtin_sprintf(buf
, "%p", ref
.first
);
330 #if __cplusplus >= 201103L
332 log_to_string(std::string
& s
, const std::pair
<const void*, size_t>& ref
)
335 const char tab('\t');
337 unsigned long l
= static_cast<unsigned long>(ref
.second
);
338 __builtin_sprintf(buf
, "%lu", l
);
342 __builtin_sprintf(buf
, "%p", ref
.first
);
351 static size_t _S_label(std::numeric_limits
<size_t>::max());
355 static map_alloc_type
&
358 static map_alloc_type _S_map
;
362 #if __cplusplus >= 201103L
363 static map_construct_type
&
366 static map_construct_type _S_map
;
373 operator<<(std::ostream
& os
, const annotate_base
& __b
)
376 typedef annotate_base base_type
;
378 base_type::const_iterator beg
= __b
.map_alloc().begin();
379 base_type::const_iterator end
= __b
.map_alloc().end();
380 for (; beg
!= end
; ++beg
)
381 __b
.log_to_string(error
, *beg
);
383 #if __cplusplus >= 201103L
385 auto beg
= __b
.map_construct().begin();
386 auto end
= __b
.map_construct().end();
387 for (; beg
!= end
; ++beg
)
388 __b
.log_to_string(error
, *beg
);
396 * @brief Base struct for condition policy.
398 * Requires a public member function with the signature
399 * void throw_conditionally()
401 struct condition_base
403 #if __cplusplus >= 201103L
404 condition_base() = default;
405 condition_base(const condition_base
&) = default;
406 condition_base
& operator=(const condition_base
&) = default;
408 virtual ~condition_base() { };
413 * @brief Base class for incremental control and throw.
415 struct limit_condition
: public condition_base
417 // Scope-level adjustor objects: set limit for throw at the
418 // beginning of a scope block, and restores to previous limit when
419 // object is destroyed on exiting the block.
423 const size_t _M_orig
;
426 adjustor_base() : _M_orig(limit()) { }
429 ~adjustor_base() { set_limit(_M_orig
); }
432 /// Never enter the condition.
433 struct never_adjustor
: public adjustor_base
435 never_adjustor() { set_limit(std::numeric_limits
<size_t>::max()); }
438 /// Always enter the condition.
439 struct always_adjustor
: public adjustor_base
441 always_adjustor() { set_limit(count()); }
444 /// Enter the nth condition.
445 struct limit_adjustor
: public adjustor_base
447 limit_adjustor(const size_t __l
) { set_limit(__l
); }
450 // Increment _S_count every time called.
451 // If _S_count matches the limit count, throw.
453 throw_conditionally()
455 if (count() == limit())
456 __throw_forced_error();
463 static size_t _S_count(0);
470 static size_t _S_limit(std::numeric_limits
<size_t>::max());
474 // Zero the throw counter, set limit to argument.
476 set_limit(const size_t __l
)
483 #ifdef _GLIBCXX_USE_C99_STDINT_TR1
485 * @brief Base class for random probability control and throw.
487 struct random_condition
: public condition_base
489 // Scope-level adjustor objects: set probability for throw at the
490 // beginning of a scope block, and restores to previous
491 // probability when object is destroyed on exiting the block.
495 const double _M_orig
;
498 adjustor_base() : _M_orig(probability()) { }
500 virtual ~adjustor_base()
501 { set_probability(_M_orig
); }
505 struct group_adjustor
: public adjustor_base
507 group_adjustor(size_t size
)
508 { set_probability(1 - std::pow(double(1 - probability()),
509 double(0.5 / (size
+ 1))));
513 /// Never enter the condition.
514 struct never_adjustor
: public adjustor_base
516 never_adjustor() { set_probability(0); }
519 /// Always enter the condition.
520 struct always_adjustor
: public adjustor_base
522 always_adjustor() { set_probability(1); }
532 set_probability(double __p
)
533 { probability() = __p
; }
536 throw_conditionally()
538 if (generate() < probability())
539 __throw_forced_error();
543 seed(unsigned long __s
)
544 { engine().seed(__s
); }
547 #if __cplusplus >= 201103L
548 typedef std::uniform_real_distribution
<double> distribution_type
;
549 typedef std::mt19937 engine_type
;
551 typedef std::tr1::uniform_real
<double> distribution_type
;
552 typedef std::tr1::mt19937 engine_type
;
558 #if __cplusplus >= 201103L
559 const distribution_type
distribution(0, 1);
560 static auto generator
= std::bind(distribution
, engine());
562 // Use variate_generator to get normalized results.
563 typedef std::tr1::variate_generator
<engine_type
, distribution_type
> gen_t
;
564 distribution_type
distribution(0, 1);
565 static gen_t
generator(engine(), distribution
);
568 double random
= generator();
569 if (random
< distribution
.min() || random
> distribution
.max())
571 std::string
__s("random_condition::generate");
573 __s
+= "random number generated is: ";
575 __builtin_sprintf(buf
, "%f", random
);
577 std::__throw_out_of_range(__s
.c_str());
593 static engine_type _S_e
;
597 #endif // _GLIBCXX_USE_C99_STDINT_TR1
600 * @brief Class with exception generation control. Intended to be
601 * used as a value_type in templatized code.
603 * Note: Destructor not allowed to throw.
605 template<typename _Cond
>
606 struct throw_value_base
: public _Cond
608 typedef _Cond condition_type
;
610 using condition_type::throw_conditionally
;
614 #ifndef _GLIBCXX_IS_AGGREGATE
615 throw_value_base() : _M_i(0)
616 { throw_conditionally(); }
618 throw_value_base(const throw_value_base
& __v
) : _M_i(__v
._M_i
)
619 { throw_conditionally(); }
621 #if __cplusplus >= 201103L
623 throw_value_base(throw_value_base
&&) = default;
626 explicit throw_value_base(const std::size_t __i
) : _M_i(__i
)
627 { throw_conditionally(); }
631 operator=(const throw_value_base
& __v
)
633 throw_conditionally();
638 #if __cplusplus >= 201103L
641 operator=(throw_value_base
&&) = default;
647 throw_conditionally();
653 template<typename _Cond
>
655 swap(throw_value_base
<_Cond
>& __a
, throw_value_base
<_Cond
>& __b
)
657 typedef throw_value_base
<_Cond
> throw_value
;
658 throw_value::throw_conditionally();
659 throw_value
orig(__a
);
664 // General instantiable types requirements.
665 template<typename _Cond
>
667 operator==(const throw_value_base
<_Cond
>& __a
,
668 const throw_value_base
<_Cond
>& __b
)
670 typedef throw_value_base
<_Cond
> throw_value
;
671 throw_value::throw_conditionally();
672 bool __ret
= __a
._M_i
== __b
._M_i
;
676 template<typename _Cond
>
678 operator<(const throw_value_base
<_Cond
>& __a
,
679 const throw_value_base
<_Cond
>& __b
)
681 typedef throw_value_base
<_Cond
> throw_value
;
682 throw_value::throw_conditionally();
683 bool __ret
= __a
._M_i
< __b
._M_i
;
687 // Numeric algorithms instantiable types requirements.
688 template<typename _Cond
>
689 inline throw_value_base
<_Cond
>
690 operator+(const throw_value_base
<_Cond
>& __a
,
691 const throw_value_base
<_Cond
>& __b
)
693 typedef throw_value_base
<_Cond
> throw_value
;
694 throw_value::throw_conditionally();
695 throw_value
__ret(__a
._M_i
+ __b
._M_i
);
699 template<typename _Cond
>
700 inline throw_value_base
<_Cond
>
701 operator-(const throw_value_base
<_Cond
>& __a
,
702 const throw_value_base
<_Cond
>& __b
)
704 typedef throw_value_base
<_Cond
> throw_value
;
705 throw_value::throw_conditionally();
706 throw_value
__ret(__a
._M_i
- __b
._M_i
);
710 template<typename _Cond
>
711 inline throw_value_base
<_Cond
>
712 operator*(const throw_value_base
<_Cond
>& __a
,
713 const throw_value_base
<_Cond
>& __b
)
715 typedef throw_value_base
<_Cond
> throw_value
;
716 throw_value::throw_conditionally();
717 throw_value
__ret(__a
._M_i
* __b
._M_i
);
722 /// Type throwing via limit condition.
723 struct throw_value_limit
: public throw_value_base
<limit_condition
>
725 typedef throw_value_base
<limit_condition
> base_type
;
727 #ifndef _GLIBCXX_IS_AGGREGATE
728 throw_value_limit() { }
730 throw_value_limit(const throw_value_limit
& __other
)
731 : base_type(__other
._M_i
) { }
733 #if __cplusplus >= 201103L
734 throw_value_limit(throw_value_limit
&&) = default;
737 explicit throw_value_limit(const std::size_t __i
) : base_type(__i
) { }
741 operator=(const throw_value_limit
& __other
)
743 base_type::operator=(__other
);
747 #if __cplusplus >= 201103L
749 operator=(throw_value_limit
&&) = default;
753 #ifdef _GLIBCXX_USE_C99_STDINT_TR1
754 /// Type throwing via random condition.
755 struct throw_value_random
: public throw_value_base
<random_condition
>
757 typedef throw_value_base
<random_condition
> base_type
;
759 #ifndef _GLIBCXX_IS_AGGREGATE
760 throw_value_random() { }
762 throw_value_random(const throw_value_random
& __other
)
763 : base_type(__other
._M_i
) { }
765 #if __cplusplus >= 201103L
766 throw_value_random(throw_value_random
&&) = default;
769 explicit throw_value_random(const std::size_t __i
) : base_type(__i
) { }
773 operator=(const throw_value_random
& __other
)
775 base_type::operator=(__other
);
779 #if __cplusplus >= 201103L
781 operator=(throw_value_random
&&) = default;
784 #endif // _GLIBCXX_USE_C99_STDINT_TR1
787 * @brief Allocator class with logging and exception generation control.
788 * Intended to be used as an allocator_type in templatized code.
789 * @ingroup allocators
791 * Note: Deallocate not allowed to throw.
793 template<typename _Tp
, typename _Cond
>
794 class throw_allocator_base
795 : public annotate_base
, public _Cond
798 typedef size_t size_type
;
799 typedef ptrdiff_t difference_type
;
800 typedef _Tp value_type
;
801 typedef value_type
* pointer
;
802 typedef const value_type
* const_pointer
;
803 typedef value_type
& reference
;
804 typedef const value_type
& const_reference
;
806 #if __cplusplus >= 201103L
807 // _GLIBCXX_RESOLVE_LIB_DEFECTS
808 // 2103. std::allocator propagate_on_container_move_assignment
809 typedef std::true_type propagate_on_container_move_assignment
;
813 typedef _Cond condition_type
;
815 std::allocator
<value_type
> _M_allocator
;
817 using condition_type::throw_conditionally
;
821 max_size() const _GLIBCXX_USE_NOEXCEPT
822 { return _M_allocator
.max_size(); }
825 address(reference __x
) const _GLIBCXX_NOEXCEPT
826 { return std::__addressof(__x
); }
829 address(const_reference __x
) const _GLIBCXX_NOEXCEPT
830 { return std::__addressof(__x
); }
833 allocate(size_type __n
, std::allocator
<void>::const_pointer hint
= 0)
835 if (__n
> this->max_size())
836 std::__throw_bad_alloc();
838 throw_conditionally();
839 pointer
const a
= _M_allocator
.allocate(__n
, hint
);
840 insert(a
, sizeof(value_type
) * __n
);
844 #if __cplusplus >= 201103L
845 template<typename _Up
, typename
... _Args
>
847 construct(_Up
* __p
, _Args
&&... __args
)
849 _M_allocator
.construct(__p
, std::forward
<_Args
>(__args
)...);
850 insert_construct(__p
);
853 template<typename _Up
>
857 erase_construct(__p
);
858 _M_allocator
.destroy(__p
);
862 construct(pointer __p
, const value_type
& val
)
863 { return _M_allocator
.construct(__p
, val
); }
867 { _M_allocator
.destroy(__p
); }
871 deallocate(pointer __p
, size_type __n
)
873 erase(__p
, sizeof(value_type
) * __n
);
874 _M_allocator
.deallocate(__p
, __n
);
878 check_allocated(pointer __p
, size_type __n
)
880 size_type __t
= sizeof(value_type
) * __n
;
881 annotate_base::check_allocated(__p
, __t
);
886 { annotate_base::check(__n
); }
889 template<typename _Tp
, typename _Cond
>
891 operator==(const throw_allocator_base
<_Tp
, _Cond
>&,
892 const throw_allocator_base
<_Tp
, _Cond
>&)
895 template<typename _Tp
, typename _Cond
>
897 operator!=(const throw_allocator_base
<_Tp
, _Cond
>&,
898 const throw_allocator_base
<_Tp
, _Cond
>&)
901 /// Allocator throwing via limit condition.
902 template<typename _Tp
>
903 struct throw_allocator_limit
904 : public throw_allocator_base
<_Tp
, limit_condition
>
906 template<typename _Tp1
>
908 { typedef throw_allocator_limit
<_Tp1
> other
; };
910 throw_allocator_limit() _GLIBCXX_USE_NOEXCEPT
{ }
912 throw_allocator_limit(const throw_allocator_limit
&)
913 _GLIBCXX_USE_NOEXCEPT
{ }
915 template<typename _Tp1
>
916 throw_allocator_limit(const throw_allocator_limit
<_Tp1
>&)
917 _GLIBCXX_USE_NOEXCEPT
{ }
919 ~throw_allocator_limit() _GLIBCXX_USE_NOEXCEPT
{ }
922 #ifdef _GLIBCXX_USE_C99_STDINT_TR1
923 /// Allocator throwing via random condition.
924 template<typename _Tp
>
925 struct throw_allocator_random
926 : public throw_allocator_base
<_Tp
, random_condition
>
928 template<typename _Tp1
>
930 { typedef throw_allocator_random
<_Tp1
> other
; };
932 throw_allocator_random() _GLIBCXX_USE_NOEXCEPT
{ }
934 throw_allocator_random(const throw_allocator_random
&)
935 _GLIBCXX_USE_NOEXCEPT
{ }
937 template<typename _Tp1
>
938 throw_allocator_random(const throw_allocator_random
<_Tp1
>&)
939 _GLIBCXX_USE_NOEXCEPT
{ }
941 ~throw_allocator_random() _GLIBCXX_USE_NOEXCEPT
{ }
943 #endif // _GLIBCXX_USE_C99_STDINT_TR1
945 _GLIBCXX_END_NAMESPACE_VERSION
948 #if __cplusplus >= 201103L
950 # include <bits/functional_hash.h>
952 namespace std
_GLIBCXX_VISIBILITY(default)
954 /// Explicit specialization of std::hash for __gnu_cxx::throw_value_limit.
956 struct hash
<__gnu_cxx::throw_value_limit
>
957 : public std::unary_function
<__gnu_cxx::throw_value_limit
, size_t>
960 operator()(const __gnu_cxx::throw_value_limit
& __val
) const
962 __gnu_cxx::throw_value_limit::throw_conditionally();
963 std::hash
<std::size_t> __h
;
964 size_t __result
= __h(__val
._M_i
);
969 #ifdef _GLIBCXX_USE_C99_STDINT_TR1
970 /// Explicit specialization of std::hash for __gnu_cxx::throw_value_random.
972 struct hash
<__gnu_cxx::throw_value_random
>
973 : public std::unary_function
<__gnu_cxx::throw_value_random
, size_t>
976 operator()(const __gnu_cxx::throw_value_random
& __val
) const
978 __gnu_cxx::throw_value_random::throw_conditionally();
979 std::hash
<std::size_t> __h
;
980 size_t __result
= __h(__val
._M_i
);
985 } // end namespace std