cds/container/impl/ellen_bintree_set.h

   1 //$$CDS-header$$
   2
   3 #ifndef __CDS_CONTAINER_IMPL_ELLEN_BINTREE_SET_H
   4 #define __CDS_CONTAINER_IMPL_ELLEN_BINTREE_SET_H
   5
   6 #include <type_traits>
   7 #include <cds/container/details/ellen_bintree_base.h>
   8 #include <cds/intrusive/impl/ellen_bintree.h>
   9 #include <cds/container/details/guarded_ptr_cast.h>
  10
  11 namespace cds { namespace container {
  12
  13     /// Set based on Ellen's et al binary search tree
  14     /** @ingroup cds_nonintrusive_set
  15         @ingroup cds_nonintrusive_tree
  16         @anchor cds_container_EllenBinTreeSet
  17
  18         Source:
  19             - [2010] F.Ellen, P.Fatourou, E.Ruppert, F.van Breugel "Non-blocking Binary Search Tree"
  20
  21         %EllenBinTreeSet is an unbalanced leaf-oriented binary search tree that implements the <i>set</i>
  22         abstract data type. Nodes maintains child pointers but not parent pointers.
  23         Every internal node has exactly two children, and all data of type \p T currently in
  24         the tree are stored in the leaves. Internal nodes of the tree are used to direct \p find
  25         operation along the path to the correct leaf. The keys (of \p Key type) stored in internal nodes
  26         may or may not be in the set. \p Key type is a subset of \p T type.
  27         There should be exactly defined a key extracting functor for converting object of type \p T to
  28         object of type \p Key.
  29
  30         Due to \p extract_min and \p extract_max member functions the \p %EllenBinTreeSet can act as
  31         a <i>priority queue</i>. In this case you should provide unique compound key, for example,
  32         the priority value plus some uniformly distributed random value.
  33
  34         @warning Recall the tree is <b>unbalanced</b>. The complexity of operations is <tt>O(log N)</tt>
  35         for uniformly distributed random keys, but in worst case the complexity is <tt>O(N)</tt>.
  36
  37         @note In the current implementation we do not use helping technique described in the original paper.
  38         In Hazard Pointer schema helping is too complicated and does not give any observable benefits.
  39         Instead of helping, when a thread encounters a concurrent operation it just spins waiting for
  40         the operation done. Such solution allows greatly simplify the implementation of tree.
  41
  42         <b>Template arguments</b> :
  43         - \p GC - safe memory reclamation (i.e. light-weight garbage collector) type, like \p cds::gc::HP, cds::gc::DHP
  44         - \p Key - key type, a subset of \p T
  45         - \p T - type to be stored in tree's leaf nodes.
  46         - \p Traits - set traits, default is \p ellen_bintree::traits
  47             It is possible to declare option-based tree with \p ellen_bintree::make_set_traits metafunction
  48             instead of \p Traits template argument.
  49
  50         @note Do not include <tt><cds/container/impl/ellen_bintree_set.h></tt> header file directly.
  51         There are header file for each GC type:
  52         - <tt><cds/container/ellen_bintree_set_hp.h></tt> - for \p cds::gc::HP
  53         - <tt><cds/container/ellen_bintree_set_dhp.h></tt> - for \p cds::gc::DHP
  54         - <tt><cds/container/ellen_bintree_set_rcu.h></tt> - for RCU GC
  55             (see \ref cds_container_EllenBinTreeSet_rcu "RCU-based EllenBinTreeSet")
  56
  57         @anchor cds_container_EllenBinTreeSet_less
  58         <b>Predicate requirements</b>
  59
  60         \p Traits::less, \p Traits::compare and other predicates using with member fuctions should accept at least parameters
  61         of type \p T and \p Key in any combination.
  62         For example, for \p Foo struct with \p std::string key field the appropiate \p less functor is:
  63         \code
  64         struct Foo
  65         {
  66             std::string m_strKey;
  67             ...
  68         };
  69
  70         struct less {
  71             bool operator()( Foo const& v1, Foo const& v2 ) const
  72             { return v1.m_strKey < v2.m_strKey ; }
  73
  74             bool operator()( Foo const& v, std::string const& s ) const
  75             { return v.m_strKey < s ; }
  76
  77             bool operator()( std::string const& s, Foo const& v ) const
  78             { return s < v.m_strKey ; }
  79
  80             // Support comparing std::string and char const *
  81             bool operator()( std::string const& s, char const * p ) const
  82             { return s.compare(p) < 0 ; }
  83
  84             bool operator()( Foo const& v, char const * p ) const
  85             { return v.m_strKey.compare(p) < 0 ; }
  86
  87             bool operator()( char const * p, std::string const& s ) const
  88             { return s.compare(p) > 0; }
  89
  90             bool operator()( char const * p, Foo const& v ) const
  91             { return v.m_strKey.compare(p) > 0; }
  92         };
  93         \endcode
  94     */
  95     template <
  96         class GC,
  97         typename Key,
  98         typename T,
  99 #ifdef CDS_DOXYGEN_INVOKED
 100         class Traits = ellen_bintree::traits
 101 #else
 102         class Traits
 103 #endif
 104     >
 105     class EllenBinTreeSet
 106 #ifdef CDS_DOXYGEN_INVOKED
 107         : public cds::intrusive::EllenBinTree< GC, Key, T, Traits >
 108 #else
 109         : public ellen_bintree::details::make_ellen_bintree_set< GC, Key, T, Traits >::type
 110 #endif
 111     {
 112         //@cond
 113         typedef ellen_bintree::details::make_ellen_bintree_set< GC, Key, T, Traits > maker;
 114         typedef typename maker::type base_class;
 115         //@endcond
 116
 117     public:
 118         typedef GC      gc;         ///< Garbage collector
 119         typedef Key     key_type;   ///< type of a key to be stored in internal nodes; key is a part of \p value_type
 120         typedef T       value_type; ///< type of value to be stored in the binary tree
 121         typedef Traits  traits;    ///< Traits template parameter
 122
 123 #   ifdef CDS_DOXYGEN_INVOKED
 124         typedef implementation_defined key_comparator  ;    ///< key compare functor based on opt::compare and opt::less option setter.
 125 #   else
 126         typedef typename maker::intrusive_traits::compare   key_comparator;
 127 #   endif
 128         typedef typename base_class::item_counter           item_counter;  ///< Item counting policy used
 129         typedef typename base_class::memory_model           memory_model;  ///< Memory ordering. See cds::opt::memory_model option
 130         typedef typename base_class::stat                   stat;          ///< internal statistics type
 131         typedef typename traits::key_extractor              key_extractor; ///< key extracting functor
 132         typedef typename traits::back_off                   back_off;      ///< Back-off strategy
 133
 134         typedef typename traits::allocator                  allocator_type;   ///< Allocator for leaf nodes
 135         typedef typename base_class::node_allocator         node_allocator;   ///< Internal node allocator
 136         typedef typename base_class::update_desc_allocator  update_desc_allocator; ///< Update descriptor allocator
 137
 138     protected:
 139         //@cond
 140         typedef typename maker::cxx_leaf_node_allocator cxx_leaf_node_allocator;
 141         typedef typename base_class::value_type         leaf_node;
 142         typedef typename base_class::internal_node      internal_node;
 143
 144         typedef std::unique_ptr< leaf_node, typename maker::leaf_deallocator > scoped_node_ptr;
 145         //@endcond
 146
 147     public:
 148         /// Guarded pointer
 149         typedef cds::gc::guarded_ptr< gc, leaf_node, value_type, details::guarded_ptr_cast_set<leaf_node, value_type> > guarded_ptr;
 150
 151     public:
 152         /// Default constructor
 153         EllenBinTreeSet()
 154             : base_class()
 155         {}
 156
 157         /// Clears the set
 158         ~EllenBinTreeSet()
 159         {}
 160
 161         /// Inserts new node
 162         /**
 163             The function creates a node with copy of \p val value
 164             and then inserts the node created into the set.
 165
 166             The type \p Q should contain at least the complete key for the node.
 167             The object of \ref value_type should be constructible from a value of type \p Q.
 168             In trivial case, \p Q is equal to \ref value_type.
 169
 170             Returns \p true if \p val is inserted into the set, \p false otherwise.
 171         */
 172         template <typename Q>
 173         bool insert( Q const& val )
 174         {
 175             scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
 176             if ( base_class::insert( *sp.get() )) {
 177                 sp.release();
 178                 return true;
 179             }
 180             return false;
 181         }
 182
 183         /// Inserts new node
 184         /**
 185             The function allows to split creating of new item into two part:
 186             - create item with key only
 187             - insert new item into the set
 188             - if inserting is success, calls  \p f functor to initialize value-fields of \p val.
 189
 190             The functor signature is:
 191             \code
 192                 void func( value_type& val );
 193             \endcode
 194             where \p val is the item inserted. User-defined functor \p f should guarantee that during changing
 195             \p val no any other changes could be made on this set's item by concurrent threads.
 196             The user-defined functor is called only if the inserting is success.
 197         */
 198         template <typename Q, typename Func>
 199         bool insert( Q const& val, Func f )
 200         {
 201             scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
 202             if ( base_class::insert( *sp.get(), [&f]( leaf_node& val ) { f( val.m_Value ); } )) {
 203                 sp.release();
 204                 return true;
 205             }
 206             return false;
 207         }
 208
 209         /// Ensures that the item exists in the set
 210         /**
 211             The operation performs inserting or changing data with lock-free manner.
 212
 213             If the \p val key not found in the set, then the new item created from \p val
 214             is inserted into the set. Otherwise, the functor \p func is called with the item found.
 215             The functor \p Func should be a function with signature:
 216             \code
 217                 void func( bool bNew, value_type& item, const Q& val );
 218             \endcode
 219             or a functor:
 220             \code
 221                 struct my_functor {
 222                     void operator()( bool bNew, value_type& item, const Q& val );
 223                 };
 224             \endcode
 225
 226             with arguments:
 227             - \p bNew - \p true if the item has been inserted, \p false otherwise
 228             - \p item - item of the set
 229             - \p val - argument \p key passed into the \p ensure function
 230
 231             The functor may change non-key fields of the \p item; however, \p func must guarantee
 232             that during changing no any other modifications could be made on this item by concurrent threads.
 233
 234             Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successfull,
 235             \p second is true if new item has been added or \p false if the item with \p key
 236             already is in the set.
 237
 238             @warning See \ref cds_intrusive_item_creating "insert item troubleshooting"
 239         */
 240         template <typename Q, typename Func>
 241         std::pair<bool, bool> ensure( const Q& val, Func func )
 242         {
 243             scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
 244             std::pair<bool, bool> bRes = base_class::ensure( *sp,
 245                 [&func, &val](bool bNew, leaf_node& node, leaf_node&){ func( bNew, node.m_Value, val ); });
 246             if ( bRes.first && bRes.second )
 247                 sp.release();
 248             return bRes;
 249         }
 250
 251         /// Inserts data of type \p value_type created in-place from \p args
 252         /**
 253             Returns \p true if inserting successful, \p false otherwise.
 254         */
 255         template <typename... Args>
 256         bool emplace( Args&&... args )
 257         {
 258             scoped_node_ptr sp( cxx_leaf_node_allocator().New( std::forward<Args>(args)... ));
 259             if ( base_class::insert( *sp.get() )) {
 260                 sp.release();
 261                 return true;
 262             }
 263             return false;
 264         }
 265
 266         /// Delete \p key from the set
 267         /** \anchor cds_nonintrusive_EllenBinTreeSet_erase_val
 268
 269             The item comparator should be able to compare the type \p value_type
 270             and the type \p Q.
 271
 272             Return \p true if key is found and deleted, \p false otherwise
 273         */
 274         template <typename Q>
 275         bool erase( Q const& key )
 276         {
 277             return base_class::erase( key );
 278         }
 279
 280         /// Deletes the item from the set using \p pred predicate for searching
 281         /**
 282             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_erase_val "erase(Q const&)"
 283             but \p pred is used for key comparing.
 284             \p Less functor has the interface like \p std::less.
 285             \p Less must imply the same element order as the comparator used for building the set.
 286         */
 287         template <typename Q, typename Less>
 288         bool erase_with( Q const& key, Less pred )
 289         {
 290             CDS_UNUSED( pred );
 291             return base_class::erase_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
 292         }
 293
 294         /// Delete \p key from the set
 295         /** \anchor cds_nonintrusive_EllenBinTreeSet_erase_func
 296
 297             The function searches an item with key \p key, calls \p f functor
 298             and deletes the item. If \p key is not found, the functor is not called.
 299
 300             The functor \p Func interface:
 301             \code
 302             struct extractor {
 303                 void operator()(value_type const& val);
 304             };
 305             \endcode
 306
 307             Since the key of MichaelHashSet's \p value_type is not explicitly specified,
 308             template parameter \p Q defines the key type searching in the list.
 309             The list item comparator should be able to compare the type \p T of list item
 310             and the type \p Q.
 311
 312             Return \p true if key is found and deleted, \p false otherwise
 313         */
 314         template <typename Q, typename Func>
 315         bool erase( Q const& key, Func f )
 316         {
 317             return base_class::erase( key, [&f]( leaf_node const& node) { f( node.m_Value ); } );
 318         }
 319
 320         /// Deletes the item from the set using \p pred predicate for searching
 321         /**
 322             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_erase_func "erase(Q const&, Func)"
 323             but \p pred is used for key comparing.
 324             \p Less functor has the interface like \p std::less.
 325             \p Less must imply the same element order as the comparator used for building the set.
 326         */
 327         template <typename Q, typename Less, typename Func>
 328         bool erase_with( Q const& key, Less pred, Func f )
 329         {
 330             CDS_UNUSED( pred );
 331             return base_class::erase_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
 332                 [&f]( leaf_node const& node) { f( node.m_Value ); } );
 333         }
 334
 335         /// Extracts an item with minimal key from the set
 336         /**
 337             If the set is not empty, the function returns a guarded pointer to minimum value.
 338             If the set is empty, the function returns an empty \p guarded_ptr.
 339
 340             @note Due the concurrent nature of the set, the function extracts <i>nearly</i> minimum key.
 341             It means that the function gets leftmost leaf of the tree and tries to unlink it.
 342             During unlinking, a concurrent thread may insert an item with key less than leftmost item's key.
 343             So, the function returns the item with minimum key at the moment of tree traversing.
 344
 345             The guarded pointer prevents deallocation of returned item,
 346             see \p cds::gc::guarded_ptr for explanation.
 347             @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
 348         */
 349         guarded_ptr extract_min()
 350         {
 351             guarded_ptr gp;
 352             base_class::extract_min_( gp.guard() );
 353             return gp;
 354         }
 355
 356         /// Extracts an item with maximal key from the set
 357         /**
 358             If the set is not empty, the function returns a guarded pointer to maximal value.
 359             If the set is empty, the function returns an empty \p guarded_ptr.
 360
 361             @note Due the concurrent nature of the set, the function extracts <i>nearly</i> maximal key.
 362             It means that the function gets rightmost leaf of the tree and tries to unlink it.
 363             During unlinking, a concurrent thread may insert an item with key great than leftmost item's key.
 364             So, the function returns the item with maximum key at the moment of tree traversing.
 365
 366             The guarded pointer prevents deallocation of returned item,
 367             see \p cds::gc::guarded_ptr for explanation.
 368             @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
 369         */
 370         guarded_ptr extract_max()
 371         {
 372             guarded_ptr gp;
 373             base_class::extract_max_( gp.guard() );
 374             return gp;
 375         }
 376
 377         /// Extracts an item from the tree
 378         /** \anchor cds_nonintrusive_EllenBinTreeSet_extract
 379             The function searches an item with key equal to \p key in the tree,
 380             unlinks it, and returns an guarded pointer to it.
 381             If the item  is not found the function returns an empty \p guarded_ptr.
 382
 383             The guarded pointer prevents deallocation of returned item,
 384             see \p cds::gc::guarded_ptr for explanation.
 385             @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
 386         */
 387         template <typename Q>
 388         guarded_ptr extract( Q const& key )
 389         {
 390             guarded_ptr gp;
 391             base_class::extract_( gp.guard(), key );
 392             return gp;
 393         }
 394
 395         /// Extracts an item from the set using \p pred for searching
 396         /**
 397             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_extract "extract(Q const&)"
 398             but \p pred is used for key compare.
 399             \p Less has the interface like \p std::less.
 400             \p pred must imply the same element order as the comparator used for building the set.
 401         */
 402         template <typename Q, typename Less>
 403         guarded_ptr extract_with( Q const& key, Less pred )
 404         {
 405             CDS_UNUSED( pred );
 406             guarded_ptr gp;
 407             base_class::extract_with_( gp.guard(), key,
 408                 cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
 409             return gp;
 410         }
 411
 412         /// Find the key \p key
 413         /**
 414             @anchor cds_nonintrusive_EllenBinTreeSet_find_func
 415
 416             The function searches the item with key equal to \p key and calls the functor \p f for item found.
 417             The interface of \p Func functor is:
 418             \code
 419             struct functor {
 420                 void operator()( value_type& item, Q& key );
 421             };
 422             \endcode
 423             where \p item is the item found, \p key is the <tt>find</tt> function argument.
 424
 425             The functor may change non-key fields of \p item. Note that the functor is only guarantee
 426             that \p item cannot be disposed during functor is executing.
 427             The functor does not serialize simultaneous access to the set's \p item. If such access is
 428             possible you must provide your own synchronization schema on item level to exclude unsafe item modifications.
 429
 430             The \p key argument is non-const since it can be used as \p f functor destination i.e., the functor
 431             can modify both arguments.
 432
 433             Note the hash functor specified for class \p Traits template parameter
 434             should accept a parameter of type \p Q that may be not the same as \p value_type.
 435
 436             The function returns \p true if \p key is found, \p false otherwise.
 437         */
 438         template <typename Q, typename Func>
 439         bool find( Q& key, Func f )
 440         {
 441             return base_class::find( key, [&f]( leaf_node& node, Q& v ) { f( node.m_Value, v ); });
 442         }
 443         //@cond
 444         template <typename Q, typename Func>
 445         bool find( Q const& key, Func f )
 446         {
 447             return base_class::find( key, [&f]( leaf_node& node, Q const& v ) { f( node.m_Value, v ); } );
 448         }
 449         //@endcond
 450
 451         /// Finds the key \p key using \p pred predicate for searching
 452         /**
 453             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_find_func "find(Q&, Func)"
 454             but \p pred is used for key comparing.
 455             \p Less functor has the interface like \p std::less.
 456             \p Less must imply the same element order as the comparator used for building the set.
 457         */
 458         template <typename Q, typename Less, typename Func>
 459         bool find_with( Q& key, Less pred, Func f )
 460         {
 461             CDS_UNUSED( pred );
 462             return base_class::find_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
 463                 [&f]( leaf_node& node, Q& v ) { f( node.m_Value, v ); } );
 464         }
 465         //@cond
 466         template <typename Q, typename Less, typename Func>
 467         bool find_with( Q const& key, Less pred, Func f )
 468         {
 469             CDS_UNUSED( pred );
 470             return base_class::find_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
 471                                           [&f]( leaf_node& node, Q const& v ) { f( node.m_Value, v ); } );
 472         }
 473         //@endcond
 474
 475         /// Find the key \p key
 476         /** @anchor cds_nonintrusive_EllenBinTreeSet_find_val
 477
 478             The function searches the item with key equal to \p key
 479             and returns \p true if it is found, and \p false otherwise.
 480
 481             Note the hash functor specified for class \p Traits template parameter
 482             should accept a parameter of type \p Q that may be not the same as \ref value_type.
 483         */
 484         template <typename Q>
 485         bool find( Q const & key )
 486         {
 487             return base_class::find( key );
 488         }
 489
 490         /// Finds the key \p key using \p pred predicate for searching
 491         /**
 492             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_find_val "find(Q const&)"
 493             but \p pred is used for key comparing.
 494             \p Less functor has the interface like \p std::less.
 495             \p Less must imply the same element order as the comparator used for building the set.
 496         */
 497         template <typename Q, typename Less>
 498         bool find_with( Q const& key, Less pred )
 499         {
 500             CDS_UNUSED( pred );
 501             return base_class::find_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
 502         }
 503
 504         /// Finds \p key and returns the item found
 505         /** @anchor cds_nonintrusive_EllenBinTreeSet_get
 506             The function searches the item with key equal to \p key and returns the item found as an guarded pointer.
 507             The function returns \p true if \p key is found, \p false otherwise.
 508
 509             The guarded pointer prevents deallocation of returned item,
 510             see \p cds::gc::guarded_ptr for explanation.
 511             @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
 512         */
 513         template <typename Q>
 514         guarded_ptr get( Q const& key )
 515         {
 516             guarded_ptr gp;
 517             base_class::get_( gp.guard(), key );
 518             return gp;
 519         }
 520
 521         /// Finds \p key with predicate \p pred and returns the item found
 522         /**
 523             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_get "get(Q const&)"
 524             but \p pred is used for key comparing.
 525             \p Less functor has the interface like \p std::less.
 526             \p pred must imply the same element order as the comparator used for building the set.
 527         */
 528         template <typename Q, typename Less>
 529         guarded_ptr get_with( Q const& key, Less pred )
 530         {
 531             CDS_UNUSED(pred);
 532             guarded_ptr gp;
 533             base_class::get_with_( gp.guard(), key,
 534                 cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >() );
 535             return gp;
 536         }
 537
 538         /// Clears the set (not atomic)
 539         /**
 540             The function unlink all items from the tree.
 541             The function is not atomic, thus, in multi-threaded environment with parallel insertions
 542             this sequence
 543             \code
 544             set.clear();
 545             assert( set.empty() );
 546             \endcode
 547             the assertion could be raised.
 548
 549             For each leaf the \ref disposer will be called after unlinking.
 550         */
 551         void clear()
 552         {
 553             base_class::clear();
 554         }
 555
 556         /// Checks if the set is empty
 557         bool empty() const
 558         {
 559             return base_class::empty();
 560         }
 561
 562         /// Returns item count in the set
 563         /**
 564             Only leaf nodes containing user data are counted.
 565
 566             The value returned depends on item counter type provided by \p Traits template parameter.
 567             If it is \p atomicity::empty_item_counter this function always returns 0.
 568
 569             The function is not suitable for checking the tree emptiness, use \p empty()
 570             member function for this purpose.
 571         */
 572         size_t size() const
 573         {
 574             return base_class::size();
 575         }
 576
 577         /// Returns const reference to internal statistics
 578         stat const& statistics() const
 579         {
 580             return base_class::statistics();
 581         }
 582
 583         /// Checks internal consistency (not atomic, not thread-safe)
 584         /**
 585             The debugging function to check internal consistency of the tree.
 586         */
 587         bool check_consistency() const
 588         {
 589             return base_class::check_consistency();
 590         }
 591     };
 592
 593 }} // namespace cds::container
 594
 595 #endif // #ifndef __CDS_CONTAINER_IMPL_ELLEN_BINTREE_SET_H