cds/container/details/feldman_hashset_base.h

   1 /*
   2     This file is a part of libcds - Concurrent Data Structures library
   3
   4     (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
   5
   6     Source code repo: http://github.com/khizmax/libcds/
   7     Download: http://sourceforge.net/projects/libcds/files/
   8
   9     Redistribution and use in source and binary forms, with or without
  10     modification, are permitted provided that the following conditions are met:
  11
  12     * Redistributions of source code must retain the above copyright notice, this
  13       list of conditions and the following disclaimer.
  14
  15     * Redistributions in binary form must reproduce the above copyright notice,
  16       this list of conditions and the following disclaimer in the documentation
  17       and/or other materials provided with the distribution.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  23     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  25     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  26     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 */
  30
  31 #ifndef CDSLIB_CONTAINER_DETAILS_FELDMAN_HASHSET_BASE_H
  32 #define CDSLIB_CONTAINER_DETAILS_FELDMAN_HASHSET_BASE_H
  33
  34 #include <cds/intrusive/details/feldman_hashset_base.h>
  35 #include <cds/container/details/base.h>
  36
  37 namespace cds { namespace container {
  38     /// \p FeldmanHashSet related definitions
  39     /** @ingroup cds_nonintrusive_helper
  40     */
  41     namespace feldman_hashset {
  42         /// Hash accessor option
  43         /**
  44             @copydetails cds::intrusive::feldman_hashset::traits::hash_accessor
  45         */
  46         template <typename Accessor>
  47         using hash_accessor = cds::intrusive::feldman_hashset::hash_accessor< Accessor >;
  48
  49         /// Hash size option
  50         /**
  51             @copydetails cds::intrusive::feldman_hashset::traits::hash_size
  52         */
  53         template <size_t Size>
  54         using hash_size = cds::intrusive::feldman_hashset::hash_size< Size >;
  55
  56         /// \p FeldmanHashSet internal statistics, see cds::intrusive::feldman_hashset::stat
  57         template <typename EventCounter = cds::atomicity::event_counter>
  58         using stat = cds::intrusive::feldman_hashset::stat< EventCounter >;
  59
  60         /// \p FeldmanHashSet empty internal statistics
  61         typedef cds::intrusive::feldman_hashset::empty_stat empty_stat;
  62
  63         /// Bit-wise memcmp-based comparator for hash value \p T
  64         template <typename T>
  65         using bitwise_compare = cds::intrusive::feldman_hashset::bitwise_compare< T >;
  66
  67         /// \p FeldmanHashSet level statistics
  68         typedef cds::intrusive::feldman_hashset::level_statistics level_statistics;
  69
  70         /// \p FeldmanHashSet traits
  71         struct traits
  72         {
  73             /// Mandatory functor to get hash value from data node
  74             /**
  75                 @copydetails cds::intrusive::feldman_hashset::traits::hash_accessor
  76             */
  77             typedef cds::opt::none hash_accessor;
  78
  79             /// The size of hash value in bytes
  80             /**
  81                 @copydetails cds::intrusive::feldman_hashset::traits::hash_size
  82             */
  83             static CDS_CONSTEXPR size_t const hash_size = 0;
  84
  85             /// Hash comparing functor
  86             /**
  87                 @copydetails cds::intrusive::feldman_hashset::traits::compare
  88             */
  89             typedef cds::opt::none compare;
  90
  91             /// Specifies binary predicate used for hash compare.
  92             /**
  93                 @copydetails cds::intrusive::feldman_hashset::traits::less
  94             */
  95             typedef cds::opt::none less;
  96
  97             /// Item counter
  98             /**
  99                 @copydetails cds::intrusive::feldman_hashset::traits::item_counter
 100             */
 101             typedef cds::atomicity::item_counter item_counter;
 102
 103             /// Item allocator
 104             /**
 105                 Default is \ref CDS_DEFAULT_ALLOCATOR
 106             */
 107             typedef CDS_DEFAULT_ALLOCATOR allocator;
 108
 109             /// Array node allocator
 110             /**
 111                 @copydetails cds::intrusive::feldman_hashset::traits::node_allocator
 112             */
 113             typedef CDS_DEFAULT_ALLOCATOR node_allocator;
 114
 115             /// C++ memory ordering model
 116             /**
 117                 @copydetails cds::intrusive::feldman_hashset::traits::memory_model
 118             */
 119             typedef cds::opt::v::relaxed_ordering memory_model;
 120
 121             /// Back-off strategy
 122             typedef cds::backoff::Default back_off;
 123
 124             /// Internal statistics
 125             /**
 126                 @copydetails cds::intrusive::feldman_hashset::traits::stat
 127             */
 128             typedef empty_stat stat;
 129
 130             /// RCU deadlock checking policy (only for \ref cds_container_FeldmanHashSet_rcu "RCU-based FeldmanHashSet")
 131             /**
 132                 @copydetails cds::intrusive::feldman_hashset::traits::rcu_check_deadlock
 133             */
 134             typedef cds::opt::v::rcu_throw_deadlock rcu_check_deadlock;
 135         };
 136
 137         /// Metafunction converting option list to \p feldman_hashset::traits
 138         /**
 139             Supported \p Options are:
 140             - \p feldman_hashset::hash_accessor - mandatory option, hash accessor functor.
 141                 @copydetails traits::hash_accessor
 142             - \p feldman_hashset::hash_size - the size of hash value in bytes.
 143                 @copydetails traits::hash_size
 144             - \p opt::allocator - item allocator
 145                 @copydetails traits::allocator
 146             - \p opt::node_allocator - array node allocator.
 147                 @copydetails traits::node_allocator
 148             - \p opt::compare - hash comparison functor. No default functor is provided.
 149                 If the option is not specified, the \p opt::less is used.
 150             - \p opt::less - specifies binary predicate used for hash comparison.
 151                 @copydetails cds::container::feldman_hashset::traits::less
 152             - \p opt::back_off - back-off strategy used. If the option is not specified, the \p cds::backoff::Default is used.
 153             - \p opt::item_counter - the type of item counting feature.
 154                 @copydetails cds::intrusive::feldman_hashset::traits::item_counter
 155             - \p opt::memory_model - C++ memory ordering model. Can be \p opt::v::relaxed_ordering (relaxed memory model, the default)
 156                 or \p opt::v::sequential_consistent (sequentially consisnent memory model).
 157             - \p opt::stat - internal statistics. By default, it is disabled (\p feldman_hashset::empty_stat).
 158                 To enable it use \p feldman_hashset::stat
 159             - \p opt::rcu_check_deadlock - a deadlock checking policy for \ref cds_intrusive_FeldmanHashSet_rcu "RCU-based FeldmanHashSet"
 160                 Default is \p opt::v::rcu_throw_deadlock
 161         */
 162         template <typename... Options>
 163         struct make_traits
 164         {
 165 #   ifdef CDS_DOXYGEN_INVOKED
 166             typedef implementation_defined type ;   ///< Metafunction result
 167 #   else
 168             typedef typename cds::opt::make_options<
 169                 typename cds::opt::find_type_traits< traits, Options... >::type
 170                 ,Options...
 171             >::type   type;
 172 #   endif
 173         };
 174     } // namespace feldman_hashset
 175
 176     //@cond
 177     // Forward declaration
 178     template < class GC, typename T, class Traits = cds::container::feldman_hashset::traits >
 179     class FeldmanHashSet;
 180     //@endcond
 181
 182     //@cond
 183     namespace details {
 184
 185         template <typename GC, typename T, typename Traits>
 186         struct make_feldman_hashset
 187         {
 188             typedef GC      gc;
 189             typedef T       value_type;
 190             typedef Traits  original_traits;
 191
 192             typedef cds::details::Allocator< value_type, typename original_traits::allocator > cxx_node_allocator;
 193
 194             struct node_disposer
 195             {
 196                 void operator()( value_type * p ) const
 197                 {
 198                     cxx_node_allocator().Delete( p );
 199                 }
 200             };
 201
 202             struct intrusive_traits: public original_traits
 203             {
 204                 typedef node_disposer disposer;
 205             };
 206
 207             // Metafunction result
 208             typedef cds::intrusive::FeldmanHashSet< GC, T, intrusive_traits > type;
 209         };
 210     } // namespace details
 211     //@endcond
 212
 213 }} // namespace cds::container
 214
 215 #endif // #ifndef CDSLIB_CONTAINER_DETAILS_FELDMAN_HASHSET_BASE_H