3 // Copyright (C) 2005-2018 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.
105 insert(void* p
, size_t size
)
109 std::string
error("annotate_base::insert null insert!\n");
110 log_to_string(error
, make_entry(p
, size
));
111 std::__throw_logic_error(error
.c_str());
114 const_iterator found
= map_alloc().find(p
);
115 if (found
!= map_alloc().end())
117 std::string
error("annotate_base::insert double insert!\n");
118 log_to_string(error
, make_entry(p
, size
));
119 log_to_string(error
, *found
);
120 std::__throw_logic_error(error
.c_str());
123 map_alloc().insert(make_entry(p
, size
));
127 erase(void* p
, size_t size
)
129 check_allocated(p
, size
);
130 map_alloc().erase(p
);
133 #if __cplusplus >= 201103L
135 insert_construct(void* p
)
139 std::string
error("annotate_base::insert_construct null!\n");
140 std::__throw_logic_error(error
.c_str());
143 auto found
= map_construct().find(p
);
144 if (found
!= map_construct().end())
146 std::string
error("annotate_base::insert_construct double insert!\n");
147 log_to_string(error
, std::make_pair(p
, get_label()));
148 log_to_string(error
, *found
);
149 std::__throw_logic_error(error
.c_str());
152 map_construct().insert(std::make_pair(p
, get_label()));
156 erase_construct(void* p
)
158 check_constructed(p
);
159 map_construct().erase(p
);
163 // See if a particular address and allocation size has been saved.
165 check_allocated(void* p
, size_t size
)
167 const_iterator found
= map_alloc().find(p
);
168 if (found
== map_alloc().end())
170 std::string
error("annotate_base::check_allocated by value "
172 log_to_string(error
, make_entry(p
, size
));
173 std::__throw_logic_error(error
.c_str());
176 if (found
->second
.second
!= size
)
178 std::string
error("annotate_base::check_allocated by value "
179 "wrong-size erase!\n");
180 log_to_string(error
, make_entry(p
, size
));
181 log_to_string(error
, *found
);
182 std::__throw_logic_error(error
.c_str());
186 // See if a given label has been allocated.
192 const_iterator beg
= map_alloc().begin();
193 const_iterator end
= map_alloc().end();
196 if (beg
->second
.first
== label
)
197 log_to_string(found
, *beg
);
202 #if __cplusplus >= 201103L
204 auto beg
= map_construct().begin();
205 auto end
= map_construct().end();
208 if (beg
->second
== label
)
209 log_to_string(found
, *beg
);
217 std::string
error("annotate_base::check by label\n");
219 std::__throw_logic_error(error
.c_str());
223 // See if there is anything left allocated or constructed.
229 const_iterator beg
= map_alloc().begin();
230 const_iterator end
= map_alloc().end();
233 log_to_string(found
, *beg
);
238 #if __cplusplus >= 201103L
240 auto beg
= map_construct().begin();
241 auto end
= map_construct().end();
244 log_to_string(found
, *beg
);
252 std::string
error("annotate_base::check \n");
254 std::__throw_logic_error(error
.c_str());
258 #if __cplusplus >= 201103L
260 check_constructed(void* p
)
262 auto found
= map_construct().find(p
);
263 if (found
== map_construct().end())
265 std::string
error("annotate_base::check_constructed not "
267 log_to_string(error
, std::make_pair(p
, get_label()));
268 std::__throw_logic_error(error
.c_str());
273 check_constructed(size_t label
)
275 auto beg
= map_construct().begin();
276 auto end
= map_construct().end();
280 if (beg
->second
== label
)
281 log_to_string(found
, *beg
);
287 std::string
error("annotate_base::check_constructed by label\n");
289 std::__throw_logic_error(error
.c_str());
295 typedef std::pair
<size_t, size_t> data_type
;
296 typedef std::map
<void*, data_type
> map_alloc_type
;
297 typedef map_alloc_type::value_type entry_type
;
298 typedef map_alloc_type::const_iterator const_iterator
;
299 typedef map_alloc_type::const_reference const_reference
;
300 #if __cplusplus >= 201103L
301 typedef std::map
<void*, size_t> map_construct_type
;
305 operator<<(std::ostream
&, const annotate_base
&);
308 make_entry(void* p
, size_t size
)
309 { return std::make_pair(p
, data_type(get_label(), size
)); }
312 log_to_string(std::string
& s
, const_reference ref
)
315 const char tab('\t');
317 unsigned long l
= static_cast<unsigned long>(ref
.second
.first
);
318 __builtin_sprintf(buf
, "%lu", l
);
322 l
= static_cast<unsigned long>(ref
.second
.second
);
323 __builtin_sprintf(buf
, "%lu", l
);
327 __builtin_sprintf(buf
, "%p", ref
.first
);
332 #if __cplusplus >= 201103L
334 log_to_string(std::string
& s
, const std::pair
<const void*, size_t>& ref
)
337 const char tab('\t');
339 unsigned long l
= static_cast<unsigned long>(ref
.second
);
340 __builtin_sprintf(buf
, "%lu", l
);
344 __builtin_sprintf(buf
, "%p", ref
.first
);
353 static size_t _S_label(std::numeric_limits
<size_t>::max());
357 static map_alloc_type
&
360 static map_alloc_type _S_map
;
364 #if __cplusplus >= 201103L
365 static map_construct_type
&
368 static map_construct_type _S_map
;
375 operator<<(std::ostream
& os
, const annotate_base
& __b
)
378 typedef annotate_base base_type
;
380 base_type::const_iterator beg
= __b
.map_alloc().begin();
381 base_type::const_iterator end
= __b
.map_alloc().end();
382 for (; beg
!= end
; ++beg
)
383 __b
.log_to_string(error
, *beg
);
385 #if __cplusplus >= 201103L
387 auto beg
= __b
.map_construct().begin();
388 auto end
= __b
.map_construct().end();
389 for (; beg
!= end
; ++beg
)
390 __b
.log_to_string(error
, *beg
);
398 * @brief Base struct for condition policy.
400 * Requires a public member function with the signature
401 * void throw_conditionally()
403 struct condition_base
405 #if __cplusplus >= 201103L
406 condition_base() = default;
407 condition_base(const condition_base
&) = default;
408 condition_base
& operator=(const condition_base
&) = default;
410 virtual ~condition_base() { };
415 * @brief Base class for incremental control and throw.
417 struct limit_condition
: public condition_base
419 // Scope-level adjustor objects: set limit for throw at the
420 // beginning of a scope block, and restores to previous limit when
421 // object is destroyed on exiting the block.
425 const size_t _M_orig
;
428 adjustor_base() : _M_orig(limit()) { }
431 ~adjustor_base() { set_limit(_M_orig
); }
434 /// Never enter the condition.
435 struct never_adjustor
: public adjustor_base
437 never_adjustor() { set_limit(std::numeric_limits
<size_t>::max()); }
440 /// Always enter the condition.
441 struct always_adjustor
: public adjustor_base
443 always_adjustor() { set_limit(count()); }
446 /// Enter the nth condition.
447 struct limit_adjustor
: public adjustor_base
449 limit_adjustor(const size_t __l
) { set_limit(__l
); }
452 // Increment _S_count every time called.
453 // If _S_count matches the limit count, throw.
455 throw_conditionally()
457 if (count() == limit())
458 __throw_forced_error();
465 static size_t _S_count(0);
472 static size_t _S_limit(std::numeric_limits
<size_t>::max());
476 // Zero the throw counter, set limit to argument.
478 set_limit(const size_t __l
)
487 * @brief Base class for random probability control and throw.
489 struct random_condition
: public condition_base
491 // Scope-level adjustor objects: set probability for throw at the
492 // beginning of a scope block, and restores to previous
493 // probability when object is destroyed on exiting the block.
497 const double _M_orig
;
500 adjustor_base() : _M_orig(probability()) { }
502 virtual ~adjustor_base()
503 { set_probability(_M_orig
); }
507 struct group_adjustor
: public adjustor_base
509 group_adjustor(size_t size
)
510 { set_probability(1 - std::pow(double(1 - probability()),
511 double(0.5 / (size
+ 1))));
515 /// Never enter the condition.
516 struct never_adjustor
: public adjustor_base
518 never_adjustor() { set_probability(0); }
521 /// Always enter the condition.
522 struct always_adjustor
: public adjustor_base
524 always_adjustor() { set_probability(1); }
534 set_probability(double __p
)
535 { probability() = __p
; }
538 throw_conditionally()
540 if (generate() < probability())
541 __throw_forced_error();
545 seed(unsigned long __s
)
546 { engine().seed(__s
); }
549 #if __cplusplus >= 201103L
550 typedef std::uniform_real_distribution
<double> distribution_type
;
551 typedef std::mt19937 engine_type
;
553 typedef std::tr1::uniform_real
<double> distribution_type
;
554 typedef std::tr1::mt19937 engine_type
;
560 #if __cplusplus >= 201103L
561 const distribution_type
distribution(0, 1);
562 static auto generator
= std::bind(distribution
, engine());
564 // Use variate_generator to get normalized results.
565 typedef std::tr1::variate_generator
<engine_type
, distribution_type
> gen_t
;
566 distribution_type
distribution(0, 1);
567 static gen_t
generator(engine(), distribution
);
570 double random
= generator();
571 if (random
< distribution
.min() || random
> distribution
.max())
573 std::string
__s("random_condition::generate");
575 __s
+= "random number generated is: ";
577 __builtin_sprintf(buf
, "%f", random
);
579 std::__throw_out_of_range(__s
.c_str());
595 static engine_type _S_e
;
602 * @brief Class with exception generation control. Intended to be
603 * used as a value_type in templatized code.
605 * Note: Destructor not allowed to throw.
607 template<typename _Cond
>
608 struct throw_value_base
: public _Cond
610 typedef _Cond condition_type
;
612 using condition_type::throw_conditionally
;
616 #ifndef _GLIBCXX_IS_AGGREGATE
617 throw_value_base() : _M_i(0)
618 { throw_conditionally(); }
620 throw_value_base(const throw_value_base
& __v
) : _M_i(__v
._M_i
)
621 { throw_conditionally(); }
623 #if __cplusplus >= 201103L
625 throw_value_base(throw_value_base
&&) = default;
628 explicit throw_value_base(const std::size_t __i
) : _M_i(__i
)
629 { throw_conditionally(); }
633 operator=(const throw_value_base
& __v
)
635 throw_conditionally();
640 #if __cplusplus >= 201103L
643 operator=(throw_value_base
&&) = default;
649 throw_conditionally();
655 template<typename _Cond
>
657 swap(throw_value_base
<_Cond
>& __a
, throw_value_base
<_Cond
>& __b
)
659 typedef throw_value_base
<_Cond
> throw_value
;
660 throw_value::throw_conditionally();
661 throw_value
orig(__a
);
666 // General instantiable types requirements.
667 template<typename _Cond
>
669 operator==(const throw_value_base
<_Cond
>& __a
,
670 const throw_value_base
<_Cond
>& __b
)
672 typedef throw_value_base
<_Cond
> throw_value
;
673 throw_value::throw_conditionally();
674 bool __ret
= __a
._M_i
== __b
._M_i
;
678 template<typename _Cond
>
680 operator<(const throw_value_base
<_Cond
>& __a
,
681 const throw_value_base
<_Cond
>& __b
)
683 typedef throw_value_base
<_Cond
> throw_value
;
684 throw_value::throw_conditionally();
685 bool __ret
= __a
._M_i
< __b
._M_i
;
689 // Numeric algorithms instantiable types requirements.
690 template<typename _Cond
>
691 inline throw_value_base
<_Cond
>
692 operator+(const throw_value_base
<_Cond
>& __a
,
693 const throw_value_base
<_Cond
>& __b
)
695 typedef throw_value_base
<_Cond
> throw_value
;
696 throw_value::throw_conditionally();
697 throw_value
__ret(__a
._M_i
+ __b
._M_i
);
701 template<typename _Cond
>
702 inline throw_value_base
<_Cond
>
703 operator-(const throw_value_base
<_Cond
>& __a
,
704 const throw_value_base
<_Cond
>& __b
)
706 typedef throw_value_base
<_Cond
> throw_value
;
707 throw_value::throw_conditionally();
708 throw_value
__ret(__a
._M_i
- __b
._M_i
);
712 template<typename _Cond
>
713 inline throw_value_base
<_Cond
>
714 operator*(const throw_value_base
<_Cond
>& __a
,
715 const throw_value_base
<_Cond
>& __b
)
717 typedef throw_value_base
<_Cond
> throw_value
;
718 throw_value::throw_conditionally();
719 throw_value
__ret(__a
._M_i
* __b
._M_i
);
724 /// Type throwing via limit condition.
725 struct throw_value_limit
: public throw_value_base
<limit_condition
>
727 typedef throw_value_base
<limit_condition
> base_type
;
729 #ifndef _GLIBCXX_IS_AGGREGATE
730 throw_value_limit() { }
732 throw_value_limit(const throw_value_limit
& __other
)
733 : base_type(__other
._M_i
) { }
735 #if __cplusplus >= 201103L
736 throw_value_limit(throw_value_limit
&&) = default;
739 explicit throw_value_limit(const std::size_t __i
) : base_type(__i
) { }
743 operator=(const throw_value_limit
& __other
)
745 base_type::operator=(__other
);
749 #if __cplusplus >= 201103L
751 operator=(throw_value_limit
&&) = default;
755 /// Type throwing via random condition.
756 struct throw_value_random
: public throw_value_base
<random_condition
>
758 typedef throw_value_base
<random_condition
> base_type
;
760 #ifndef _GLIBCXX_IS_AGGREGATE
761 throw_value_random() { }
763 throw_value_random(const throw_value_random
& __other
)
764 : base_type(__other
._M_i
) { }
766 #if __cplusplus >= 201103L
767 throw_value_random(throw_value_random
&&) = default;
770 explicit throw_value_random(const std::size_t __i
) : base_type(__i
) { }
774 operator=(const throw_value_random
& __other
)
776 base_type::operator=(__other
);
780 #if __cplusplus >= 201103L
782 operator=(throw_value_random
&&) = default;
788 * @brief Allocator class with logging and exception generation control.
789 * Intended to be used as an allocator_type in templatized code.
790 * @ingroup allocators
792 * Note: Deallocate not allowed to throw.
794 template<typename _Tp
, typename _Cond
>
795 class throw_allocator_base
796 : public annotate_base
, public _Cond
799 typedef size_t size_type
;
800 typedef ptrdiff_t difference_type
;
801 typedef _Tp value_type
;
802 typedef value_type
* pointer
;
803 typedef const value_type
* const_pointer
;
804 typedef value_type
& reference
;
805 typedef const value_type
& const_reference
;
807 #if __cplusplus >= 201103L
808 // _GLIBCXX_RESOLVE_LIB_DEFECTS
809 // 2103. std::allocator propagate_on_container_move_assignment
810 typedef std::true_type propagate_on_container_move_assignment
;
814 typedef _Cond condition_type
;
816 std::allocator
<value_type
> _M_allocator
;
818 using condition_type::throw_conditionally
;
822 max_size() const _GLIBCXX_USE_NOEXCEPT
823 { return _M_allocator
.max_size(); }
826 address(reference __x
) const _GLIBCXX_NOEXCEPT
827 { return std::__addressof(__x
); }
830 address(const_reference __x
) const _GLIBCXX_NOEXCEPT
831 { return std::__addressof(__x
); }
834 allocate(size_type __n
, std::allocator
<void>::const_pointer hint
= 0)
836 if (__n
> this->max_size())
837 std::__throw_bad_alloc();
839 throw_conditionally();
840 pointer
const a
= _M_allocator
.allocate(__n
, hint
);
841 insert(a
, sizeof(value_type
) * __n
);
845 #if __cplusplus >= 201103L
846 template<typename _Up
, typename
... _Args
>
848 construct(_Up
* __p
, _Args
&&... __args
)
850 _M_allocator
.construct(__p
, std::forward
<_Args
>(__args
)...);
851 insert_construct(__p
);
854 template<typename _Up
>
858 erase_construct(__p
);
859 _M_allocator
.destroy(__p
);
863 construct(pointer __p
, const value_type
& val
)
864 { return _M_allocator
.construct(__p
, val
); }
868 { _M_allocator
.destroy(__p
); }
872 deallocate(pointer __p
, size_type __n
)
874 erase(__p
, sizeof(value_type
) * __n
);
875 _M_allocator
.deallocate(__p
, __n
);
879 check_allocated(pointer __p
, size_type __n
)
881 size_type __t
= sizeof(value_type
) * __n
;
882 annotate_base::check_allocated(__p
, __t
);
887 { annotate_base::check(__n
); }
890 template<typename _Tp
, typename _Cond
>
892 operator==(const throw_allocator_base
<_Tp
, _Cond
>&,
893 const throw_allocator_base
<_Tp
, _Cond
>&)
896 template<typename _Tp
, typename _Cond
>
898 operator!=(const throw_allocator_base
<_Tp
, _Cond
>&,
899 const throw_allocator_base
<_Tp
, _Cond
>&)
902 /// Allocator throwing via limit condition.
903 template<typename _Tp
>
904 struct throw_allocator_limit
905 : public throw_allocator_base
<_Tp
, limit_condition
>
907 template<typename _Tp1
>
909 { typedef throw_allocator_limit
<_Tp1
> other
; };
911 throw_allocator_limit() _GLIBCXX_USE_NOEXCEPT
{ }
913 throw_allocator_limit(const throw_allocator_limit
&)
914 _GLIBCXX_USE_NOEXCEPT
{ }
916 template<typename _Tp1
>
917 throw_allocator_limit(const throw_allocator_limit
<_Tp1
>&)
918 _GLIBCXX_USE_NOEXCEPT
{ }
920 ~throw_allocator_limit() _GLIBCXX_USE_NOEXCEPT
{ }
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
{ }
944 _GLIBCXX_END_NAMESPACE_VERSION
947 #if __cplusplus >= 201103L
949 # include <bits/functional_hash.h>
951 namespace std
_GLIBCXX_VISIBILITY(default)
953 /// Explicit specialization of std::hash for __gnu_cxx::throw_value_limit.
955 struct hash
<__gnu_cxx::throw_value_limit
>
956 : public std::unary_function
<__gnu_cxx::throw_value_limit
, size_t>
959 operator()(const __gnu_cxx::throw_value_limit
& __val
) const
961 __gnu_cxx::throw_value_limit::throw_conditionally();
962 std::hash
<std::size_t> __h
;
963 size_t __result
= __h(__val
._M_i
);
968 /// Explicit specialization of std::hash for __gnu_cxx::throw_value_random.
970 struct hash
<__gnu_cxx::throw_value_random
>
971 : public std::unary_function
<__gnu_cxx::throw_value_random
, size_t>
974 operator()(const __gnu_cxx::throw_value_random
& __val
) const
976 __gnu_cxx::throw_value_random::throw_conditionally();
977 std::hash
<std::size_t> __h
;
978 size_t __result
= __h(__val
._M_i
);
982 } // end namespace std