cds/container/skip_list_set_nogc.h

   1 //$$CDS-header$$
   2
   3 #ifndef CDSLIB_CONTAINER_SKIP_LIST_SET_NOGC_H
   4 #define CDSLIB_CONTAINER_SKIP_LIST_SET_NOGC_H
   5
   6 #include <cds/intrusive/skip_list_nogc.h>
   7 #include <cds/container/details/skip_list_base.h>
   8 #include <cds/details/binary_functor_wrapper.h>
   9 #include <cds/gc/nogc.h>
  10 #include <cds/details/allocator.h>
  11
  12 namespace cds { namespace container {
  13     //@cond
  14     namespace skip_list { namespace details {
  15         struct set_key_accessor
  16         {
  17             template <typename NodeType>
  18             typename NodeType::stored_value_type const& operator()( NodeType const& node ) const
  19             {
  20                 return node.m_Value;
  21             }
  22         };
  23     }} // namespace skip_list::details
  24
  25     namespace details {
  26         template <typename T, typename Traits >
  27         struct make_skip_list_set_nogc
  28         {
  29             typedef cds::gc::nogc   gc;
  30             typedef T               value_type;
  31             typedef Traits          traits;
  32
  33             typedef cds::intrusive::skip_list::node< gc >   intrusive_node_type;
  34             struct node_type: public intrusive_node_type
  35             {
  36                 typedef intrusive_node_type             base_class;
  37                 typedef typename base_class::atomic_ptr atomic_ptr;
  38                 typedef atomic_ptr                      tower_item_type;
  39                 typedef value_type                      stored_value_type;
  40
  41                 value_type m_Value;
  42                 //atomic_ptr m_arrTower[] ;  // allocated together with node_type in single memory block
  43
  44                 template <typename Q>
  45                 node_type( unsigned int nHeight, atomic_ptr * pTower, Q const& v )
  46                     : m_Value(v)
  47                 {
  48                     if ( nHeight > 1 ) {
  49                         new (pTower) atomic_ptr[ nHeight - 1 ];
  50                         base_class::make_tower( nHeight, pTower );
  51                     }
  52                 }
  53
  54                 template <typename Q, typename... Args>
  55                 node_type( unsigned int nHeight, atomic_ptr * pTower, Q&& q, Args&&... args )
  56                     : m_Value( std::forward<Q>(q), std::forward<Args>(args)... )
  57                 {
  58                     if ( nHeight > 1 ) {
  59                         new (pTower) atomic_ptr[ nHeight - 1 ];
  60                         base_class::make_tower( nHeight, pTower );
  61                     }
  62                 }
  63
  64                 node_type() = delete;   // no default ctor
  65             };
  66
  67             typedef skip_list::details::node_allocator< node_type, traits> node_allocator;
  68
  69             struct node_deallocator {
  70                 void operator ()( node_type * pNode )
  71                 {
  72                     node_allocator().Delete( pNode );
  73                 }
  74             };
  75
  76             typedef skip_list::details::dummy_node_builder<intrusive_node_type> dummy_node_builder;
  77
  78             typedef typename traits::key_accessor key_accessor;
  79             typedef typename opt::details::make_comparator< value_type, traits >::type key_comparator;
  80
  81             /*
  82             template <typename Less>
  83             struct less_wrapper {
  84                 typedef compare_wrapper< node_type, cds::opt::details::make_comparator_from_less<Less>, key_accessor >    type;
  85             };
  86             */
  87
  88             typedef typename cds::intrusive::skip_list::make_traits<
  89                 cds::opt::type_traits< traits >
  90                 ,cds::intrusive::opt::hook< intrusive::skip_list::base_hook< cds::opt::gc< gc > > >
  91                 ,cds::intrusive::opt::disposer< node_deallocator >
  92                 ,cds::intrusive::skip_list::internal_node_builder< dummy_node_builder >
  93                 ,cds::opt::compare< cds::details::compare_wrapper< node_type, key_comparator, key_accessor > >
  94             >::type intrusive_type_traits;
  95
  96             typedef cds::intrusive::SkipListSet< gc, node_type, intrusive_type_traits>   type;
  97         };
  98     } // namespace details
  99     //@endcond
 100
 101     /// Lock-free skip-list set (template specialization for gc::nogc)
 102     /** @ingroup cds_nonintrusive_set
 103         \anchor cds_nonintrusive_SkipListSet_nogc
 104
 105         This specialization is intended for so-called persistent usage when no item
 106         reclamation may be performed. The class does not support deleting of list item.
 107         See \ref cds_nonintrusive_SkipListSet_hp "SkipListSet" for detailed description.
 108
 109         Template arguments:
 110         - \p T - type to be stored in the list.
 111         - \p Traits - type traits. See skip_list::traits for explanation.
 112
 113         It is possible to declare option-based list with cds::container::skip_list::make_traits metafunction istead of \p Traits template
 114         argument. \p Options template arguments of cds::container::skip_list::make_traits metafunction are:
 115         - opt::compare - key comparison functor. No default functor is provided.
 116             If the option is not specified, the opt::less is used.
 117         - opt::less - specifies binary predicate used for key comparison. Default is \p std::less<T>.
 118         - opt::item_counter - the type of item counting feature. Default is \ref atomicity::empty_item_counter that is no item counting.
 119         - opt::memory_model - C++ memory ordering model. Can be opt::v::relaxed_ordering (relaxed memory model, the default)
 120             or opt::v::sequential_consistent (sequentially consisnent memory model).
 121         - skip_list::random_level_generator - random level generator. Can be skip_list::xorshift, skip_list::turbo_pascal or
 122             user-provided one. See skip_list::random_level_generator option description for explanation.
 123             Default is \p %skip_list::turbo_pascal.
 124         - opt::allocator - allocator for skip-list node. Default is \ref CDS_DEFAULT_ALLOCATOR.
 125         - opt::back_off - back-off strategy used. If the option is not specified, the cds::backoff::Default is used.
 126         - opt::stat - internal statistics. Available types: skip_list::stat, skip_list::empty_stat (the default)
 127     */
 128     template <
 129         typename T,
 130 #ifdef CDS_DOXYGEN_INVOKED
 131         class Traits = skip_list::traits
 132 #else
 133         class Traits
 134 #endif
 135     >
 136     class SkipListSet< gc::nogc, T, Traits >:
 137 #ifdef CDS_DOXYGEN_INVOKED
 138         protected intrusive::SkipListSet< cds::gc::nogc, T, Traits >
 139 #else
 140         protected details::make_skip_list_set_nogc< T, typename cds::opt::replace_key_accessor< Traits, skip_list::details::set_key_accessor >::type >::type
 141 #endif
 142     {
 143         //@cond
 144         typedef details::make_skip_list_set_nogc< T, typename cds::opt::replace_key_accessor< Traits, skip_list::details::set_key_accessor >::type >    maker;
 145         typedef typename maker::type base_class;
 146         //@endcond
 147     public:
 148         typedef typename base_class::gc gc  ; ///< Garbage collector used
 149         typedef T       value_type  ;   ///< Value type stored in the set
 150         typedef Traits  options     ;   ///< Options specified
 151
 152         typedef typename base_class::back_off       back_off        ;   ///< Back-off strategy used
 153         typedef typename options::allocator         allocator_type  ;   ///< Allocator type used for allocate/deallocate the skip-list nodes
 154         typedef typename base_class::item_counter   item_counter    ;   ///< Item counting policy used
 155         typedef typename maker::key_comparator      key_comparator  ;   ///< key compare functor
 156         typedef typename base_class::memory_model   memory_model    ;   ///< Memory ordering. See cds::opt::memory_model option
 157         typedef typename options::stat              stat            ;   ///< internal statistics type
 158         typedef typename base_class::random_level_generator random_level_generator  ;   ///< random level generator
 159
 160     protected:
 161         //@cond
 162         typedef typename maker::node_type           node_type;
 163         typedef typename maker::node_allocator      node_allocator;
 164         typedef typename std::conditional<
 165             std::is_same< typename options::key_accessor, opt::none >::value,
 166             skip_list::details::set_key_accessor,
 167             typename options::key_accessor
 168         >::type     key_accessor;
 169
 170         typedef std::unique_ptr< node_type, typename maker::node_deallocator >    scoped_node_ptr;
 171         //@endcond
 172
 173     public:
 174         /// Iterator type
 175         typedef skip_list::details::iterator< typename base_class::iterator >  iterator;
 176
 177         /// Const iterator type
 178         typedef skip_list::details::iterator< typename base_class::const_iterator >   const_iterator;
 179
 180         /// Returns a forward iterator addressing the first element in a set
 181         iterator begin()
 182         {
 183             return iterator( base_class::begin() );
 184         }
 185
 186         /// Returns a forward const iterator addressing the first element in a set
 187         //@{
 188         const_iterator begin() const
 189         {
 190             return const_iterator( base_class::begin() );
 191         }
 192         const_iterator cbegin() const
 193         {
 194             return const_iterator( base_class::cbegin() );
 195         }
 196         //@}
 197
 198         /// Returns a forward iterator that addresses the location succeeding the last element in a set.
 199         iterator end()
 200         {
 201             return iterator( base_class::end() );
 202         }
 203
 204         /// Returns a forward const iterator that addresses the location succeeding the last element in a set.
 205         //@{
 206         const_iterator end() const
 207         {
 208             return const_iterator( base_class::end() );
 209         }
 210         const_iterator cend() const
 211         {
 212             return const_iterator( base_class::cend() );
 213         }
 214         //@}
 215
 216     protected:
 217         //@cond
 218         static iterator node_to_iterator( node_type * pNode )
 219         {
 220             assert( pNode );
 221             return iterator( base_class::iterator::from_node( pNode ));
 222         }
 223         //@endcond
 224
 225     public:
 226         /// Default ctor
 227         SkipListSet()
 228             : base_class()
 229         {}
 230
 231         /// Destructor destroys the set object
 232         ~SkipListSet()
 233         {}
 234
 235         /// Inserts new node
 236         /**
 237             The function inserts \p val in the set if it does not contain
 238             an item with key equal to \p val.
 239
 240             Return an iterator pointing to inserted item if success, otherwise \ref end()
 241         */
 242         template <typename Q>
 243         iterator insert( const Q& val )
 244         {
 245             scoped_node_ptr sp( node_allocator().New( base_class::random_level(), val ));
 246             if ( base_class::insert( *sp.get() )) {
 247                 return node_to_iterator( sp.release() );
 248             }
 249             return end();
 250         }
 251
 252         /// Inserts data of type \ref value_type constructed with <tt>std::forward<Args>(args)...</tt>
 253         /**
 254             Return an iterator pointing to inserted item if success \ref end() otherwise
 255         */
 256         template <typename... Args>
 257         iterator emplace( Args&&... args )
 258         {
 259             scoped_node_ptr sp( node_allocator().New( base_class::random_level(), std::forward<Args>(args)... ));
 260             if ( base_class::insert( *sp.get() )) {
 261                 return node_to_iterator( sp.release() );
 262             }
 263             return end();
 264         }
 265
 266         /// Ensures that the item \p val exists in the set
 267         /**
 268             The operation inserts new item if the key \p val is not found in the set.
 269             Otherwise, the function returns an iterator that points to item found.
 270
 271             Returns <tt> std::pair<iterator, bool>  </tt> where \p first is an iterator pointing to
 272             item found or inserted, \p second is true if new item has been added or \p false if the item
 273             already is in the set.
 274         */
 275         template <typename Q>
 276         std::pair<iterator, bool> ensure( const Q& val )
 277         {
 278             scoped_node_ptr sp( node_allocator().New( base_class::random_level(), val ));
 279             node_type * pNode;
 280             std::pair<bool, bool> bRes = base_class::ensure( *sp, [&pNode](bool, node_type& item, node_type&) { pNode = &item; } );
 281             if ( bRes.first && bRes.second )
 282                 sp.release();
 283             assert( pNode );
 284             return std::make_pair( node_to_iterator( pNode ), bRes.second );
 285         }
 286
 287         /// Searches \p key
 288         /** \anchor cds_nonintrusive_SkipListSet_nogc_find_val
 289
 290             The function searches the item with key equal to \p key
 291             and returns an iterator pointed to item found if the key is found,
 292             and \ref end() otherwise
 293         */
 294         template <typename Q>
 295         iterator find( Q const& key ) const
 296         {
 297             node_type * pNode = base_class::find( key );
 298             if ( pNode )
 299                 return node_to_iterator( pNode );
 300             return base_class::nonconst_end();
 301         }
 302
 303         /// Finds the key \p val using \p pred predicate for searching
 304         /**
 305             The function is an analog of \ref cds_nonintrusive_SkipListSet_nogc_find_val "find(Q const&)"
 306             but \p pred is used for key comparing.
 307             \p Less functor has the interface like \p std::less.
 308             \p Less must imply the same element order as the comparator used for building the set.
 309         */
 310         template <typename Q, typename Less>
 311         iterator find_with( Q const& key, Less pred ) const
 312         {
 313             CDS_UNUSED( pred );
 314             node_type * pNode = base_class::find_with( key, cds::details::predicate_wrapper< node_type, Less, key_accessor>() );
 315             if ( pNode )
 316                 return node_to_iterator( pNode );
 317             return base_class::nonconst_end();
 318         }
 319
 320         /// Gets minimum key from the set
 321         /**
 322             If the set is empty the function returns \p nullptr
 323         */
 324         value_type * get_min() const
 325         {
 326             node_type * pNode = base_class::get_min();
 327             return pNode ? &pNode->m_Value : nullptr;
 328         }
 329
 330         /// Gets maximum key from the set
 331         /**
 332             The function returns \p nullptr if the set is empty
 333         */
 334         value_type * get_max() const
 335         {
 336             node_type * pNode = base_class::get_max();
 337             return pNode ? &pNode->m_Value : nullptr;
 338         }
 339
 340         /// Clears the set (non-atomic)
 341         /**
 342             The function is not atomic.
 343             Finding and/or inserting is prohibited while clearing.
 344             Otherwise an unpredictable result may be encountered.
 345             Thus, \p clear() may be used only for debugging purposes.
 346         */
 347         void clear()
 348         {
 349             base_class::clear();
 350         }
 351
 352         /// Checks if the set is empty
 353         bool empty() const
 354         {
 355             return base_class::empty();
 356         }
 357
 358         /// Returns item count in the set
 359         /**
 360             The value returned depends on item counter type provided by \p Traits template parameter.
 361             If it is atomicity::empty_item_counter this function always returns 0.
 362             The function is not suitable for checking the set emptiness, use \ref empty
 363             member function for this purpose.
 364         */
 365         size_t size() const
 366         {
 367             return base_class::size();
 368         }
 369
 370         /// Returns maximum height of skip-list. The max height is a constant for each object and does not exceed 32.
 371         static CDS_CONSTEXPR unsigned int max_height() CDS_NOEXCEPT
 372         {
 373             return base_class::max_height();
 374         }
 375
 376         /// Returns const reference to internal statistics
 377         stat const& statistics() const
 378         {
 379             return base_class::statistics();
 380         }
 381     };
 382
 383 }} // cds::container
 384
 385 #endif // ifndef CDSLIB_CONTAINER_SKIP_LIST_SET_NOGC_H