3 #ifndef CDSLIB_CONTAINER_DETAILS_MULTILEVEL_HASHSET_BASE_H
4 #define CDSLIB_CONTAINER_DETAILS_MULTILEVEL_HASHSET_BASE_H
6 #include <cds/intrusive/details/multilevel_hashset_base.h>
7 #include <cds/container/details/base.h>
9 namespace cds { namespace container {
10 /// \p MultiLevelHashSet related definitions
11 /** @ingroup cds_nonintrusive_helper
13 namespace multilevel_hashset {
15 /// Hash accessor option
17 @copydetails cds::intrusive::multilevel_hashset::traits::hash_accessor
19 template <typename Accessor>
20 using hash_accessor = cds::intrusive::multilevel_hashset::hash_accessor< Accessor >;
22 /// \p MultiLevelHashSet internal statistics, see cds::intrusive::multilevel_hashset::stat
23 template <typename EventCounter = cds::atomicity::event_counter>
24 using stat = cds::intrusive::multilevel_hashset::stat< EventCounter >;
26 /// \p MultiLevelHashSet empty internal statistics
27 typedef cds::intrusive::multilevel_hashset::empty_stat empty_stat;
29 /// Bit-wise memcmp-based comparator for hash value \p T
31 using bitwise_compare = cds::intrusive::multilevel_hashset::bitwise_compare< T >;
33 /// \p MultiLevelHashSet traits
36 /// Mandatory functor to get hash value from data node
38 @copydetails cds::intrusive::multilevel_hashset::traits::hash_accessor
40 typedef cds::opt::none hash_accessor;
42 /// Hash comparing functor
44 @copydetails cds::intrusive::multilevel_hashset::traits::compare
46 typedef cds::opt::none compare;
48 /// Specifies binary predicate used for hash compare.
50 @copydetails cds::intrusive::multilevel_hashset::traits::less
52 typedef cds::opt::none less;
56 @copydetails cds::intrusive::multilevel_hashset::traits::item_counter
58 typedef cds::atomicity::item_counter item_counter;
62 Default is \ref CDS_DEFAULT_ALLOCATOR
64 typedef CDS_DEFAULT_ALLOCATOR allocator;
66 /// Array node allocator
68 @copydetails cds::intrusive::multilevel_hashset::traits::node_allocator
70 typedef CDS_DEFAULT_ALLOCATOR node_allocator;
72 /// C++ memory ordering model
74 @copydetails cds::intrusive::multilevel_hashset::traits::memory_model
76 typedef cds::opt::v::relaxed_ordering memory_model;
79 typedef cds::backoff::Default back_off;
81 /// Internal statistics
83 @copydetails cds::intrusive::multilevel_hashset::traits::stat
85 typedef empty_stat stat;
87 /// RCU deadlock checking policy (only for \ref cds_container_MultilevelHashSet_rcu "RCU-based MultilevelHashSet")
89 @copydetails cds::intrusive::multilevel_hashset::traits::rcu_check_deadlock
91 typedef cds::opt::v::rcu_throw_deadlock rcu_check_deadlock;
94 /// Metafunction converting option list to \p multilevel_hashset::traits
96 Supported \p Options are:
97 - \p multilevel_hashset::hash_accessor - mandatory option, hash accessor functor.
98 @copydetails traits::hash_accessor
99 - \p opt::allocator - item allocator
100 @copydetails traits::allocator
101 - \p opt::node_allocator - array node allocator.
102 @copydetails traits::node_allocator
103 - \p opt::compare - hash comparison functor. No default functor is provided.
104 If the option is not specified, the \p opt::less is used.
105 - \p opt::less - specifies binary predicate used for hash comparison.
106 @copydetails cds::container::multilevel_hashset::traits::less
107 - \p opt::back_off - back-off strategy used. If the option is not specified, the \p cds::backoff::Default is used.
108 - \p opt::item_counter - the type of item counting feature.
109 @copydetails cds::intrusive::multilevel_hashset::traits::item_counter
110 - \p opt::memory_model - C++ memory ordering model. Can be \p opt::v::relaxed_ordering (relaxed memory model, the default)
111 or \p opt::v::sequential_consistent (sequentially consisnent memory model).
112 - \p opt::stat - internal statistics. By default, it is disabled (\p multilevel_hashset::empty_stat).
113 To enable it use \p multilevel_hashset::stat
114 - \p opt::rcu_check_deadlock - a deadlock checking policy for \ref cds_intrusive_MultilevelHashSet_rcu "RCU-based MultilevelHashSet"
115 Default is \p opt::v::rcu_throw_deadlock
117 template <typename... Options>
120 # ifdef CDS_DOXYGEN_INVOKED
121 typedef implementation_defined type ; ///< Metafunction result
123 typedef typename cds::opt::make_options<
124 typename cds::opt::find_type_traits< traits, Options... >::type
129 } // namespace multilevel_hashset
132 // Forward declaration
133 template < class GC, typename T, class Traits = cds::container::multilevel_hashset::traits >
134 class MultiLevelHashSet;
140 template <typename GC, typename T, typename Traits>
141 struct make_multilevel_hashset
144 typedef T value_type;
145 typedef Traits original_traits;
147 typedef cds::details::Allocator< value_type, typename original_traits::allocator > cxx_node_allocator;
151 void operator()( value_type * p ) const
153 cxx_node_allocator().Delete( p );
157 struct intrusive_traits: public original_traits
159 typedef node_disposer disposer;
162 // Metafunction result
163 typedef cds::intrusive::MultiLevelHashSet< GC, T, intrusive_traits > type;
165 } // namespace details
168 }} // namespace cds::container
170 #endif // #ifndef CDSLIB_CONTAINER_DETAILS_MULTILEVEL_HASHSET_BASE_H