cds/container/impl/bronson_avltree_map_rcu.h

   1 //$$CDS-header$$
   2
   3 #ifndef CDSLIB_CONTAINER_IMPL_BRONSON_AVLTREE_MAP_RCU_H
   4 #define CDSLIB_CONTAINER_IMPL_BRONSON_AVLTREE_MAP_RCU_H
   5
   6 #include <type_traits> // is_base_of
   7 #include <cds/container/details/bronson_avltree_base.h>
   8 #include <cds/urcu/details/check_deadlock.h>
   9 #include <cds/urcu/exempt_ptr.h>
  10
  11 namespace cds { namespace container {
  12
  13     /// Bronson et al AVL-tree (RCU specialization for storing pointer to values)
  14     /** @ingroup cds_nonintrusive_map
  15         @ingroup cds_nonintrusive_tree
  16         @headerfile cds/container/bronson_avltree_map_rcu.h
  17         @anchor cds_container_BronsonAVLTreeMap_rcu_ptr
  18
  19         This is the specialization of \ref cds_container_BronsonAVLTreeMap_rcu "RCU-based Bronson et al AVL-tree"
  20         for "key -> value pointer" map. This specialization stores the pointer to user-allocated values instead of the copy
  21         of the value. When a tree node is removed, the algorithm does not free the value pointer directly, instead, it call
  22         the disposer functor provided by \p Traits template parameter.
  23
  24         <b>Template arguments</b>:
  25         - \p RCU - one of \ref cds_urcu_gc "RCU type"
  26         - \p Key - key type
  27         - \p T - value type to be stored in tree's nodes. Note, the specialization stores the pointer to user-allocated
  28             value, not the copy.
  29         - \p Traits - tree traits, default is \p bronson_avltree::traits
  30             It is possible to declare option-based tree with \p bronson_avltree::make_traits metafunction
  31             instead of \p Traits template argument.
  32
  33         @note Before including <tt><cds/container/bronson_avltree_map_rcu.h></tt> you should include appropriate RCU header file,
  34         see \ref cds_urcu_gc "RCU type" for list of existing RCU class and corresponding header files.
  35     */
  36     template <
  37         typename RCU,
  38         typename Key,
  39         typename T,
  40 #   ifdef CDS_DOXYGEN_INVOKED
  41         typename Traits = bronson_avltree::traits
  42 #else
  43         typename Traits
  44 #endif
  45     >
  46     class BronsonAVLTreeMap< cds::urcu::gc<RCU>, Key, T*, Traits >
  47     {
  48     public:
  49         typedef cds::urcu::gc<RCU>  gc;   ///< RCU Garbage collector
  50         typedef Key     key_type;    ///< type of a key stored in the map
  51         typedef T *     mapped_type; ///< type of value stored in the map
  52         typedef Traits  traits;      ///< Traits template parameter
  53
  54 #   ifdef CDS_DOXYGEN_INVOKED
  55         typedef implementation_defined key_comparator;    ///< key compare functor based on \p Traits::compare and \p Traits::less
  56 #   else
  57         typedef typename opt::details::make_comparator< key_type, traits >::type key_comparator;
  58 #endif
  59         typedef typename traits::item_counter           item_counter;       ///< Item counting policy
  60         typedef typename traits::memory_model           memory_model;       ///< Memory ordering, see \p cds::opt::memory_model option
  61         typedef typename traits::node_allocator         node_allocator_type; ///< allocator for maintaining internal nodes
  62         typedef typename traits::stat                   stat;               ///< internal statistics
  63         typedef typename traits::rcu_check_deadlock     rcu_check_deadlock; ///< Deadlock checking policy
  64         typedef typename traits::back_off               back_off;           ///< Back-off strategy
  65         typedef typename traits::disposer               disposer;           ///< Value disposer
  66         typedef typename traits::sync_monitor           sync_monitor;       ///< @ref cds_sync_monitor "Synchronization monitor" type for node-level locking
  67
  68         /// Enabled or disabled @ref bronson_avltree::relaxed_insert "relaxed insertion"
  69         static CDS_CONSTEXPR bool const c_bRelaxedInsert = traits::relaxed_insert;
  70
  71         /// Group of \p extract_xxx functions does not require external locking
  72         static CDS_CONSTEXPR const bool c_bExtractLockExternal = false;
  73
  74 #   ifdef CDS_DOXYGEN_INVOKED
  75         /// Returned pointer to \p mapped_type of extracted node
  76         typedef cds::urcu::exempt_ptr< gc, T, T, disposer, void > exempt_ptr;
  77 #   else
  78         typedef cds::urcu::exempt_ptr< gc,
  79             typename std::remove_pointer<mapped_type>::type,
  80             typename std::remove_pointer<mapped_type>::type,
  81             disposer,
  82             void
  83         > exempt_ptr;
  84 #   endif
  85
  86         typedef typename gc::scoped_lock    rcu_lock;  ///< RCU scoped lock
  87
  88     protected:
  89         //@cond
  90         typedef bronson_avltree::node< key_type, mapped_type, sync_monitor > node_type;
  91         typedef typename node_type::version_type version_type;
  92
  93         typedef cds::details::Allocator< node_type, node_allocator_type > cxx_allocator;
  94         typedef cds::urcu::details::check_deadlock_policy< gc, rcu_check_deadlock >   check_deadlock_policy;
  95
  96         enum class find_result
  97         {
  98             not_found,
  99             found,
 100             retry
 101         };
 102
 103         struct update_flags
 104         {
 105             enum {
 106                 allow_insert = 1,
 107                 allow_update = 2,
 108                 //allow_remove = 4,
 109
 110                 retry = 1024,
 111
 112                 failed = 0,
 113                 result_inserted = allow_insert,
 114                 result_updated = allow_update,
 115                 result_removed = 4
 116             };
 117         };
 118
 119         enum node_condition
 120         {
 121             nothing_required = -3,
 122             rebalance_required = -2,
 123             unlink_required = -1
 124         };
 125
 126         enum direction {
 127             left_child = -1,
 128             right_child = 1
 129         };
 130
 131         typedef typename sync_monitor::template scoped_lock<node_type> node_scoped_lock;
 132         //@endcond
 133
 134     protected:
 135         //@cond
 136         template <typename K>
 137         static node_type * alloc_node( K&& key, int nHeight, version_type version, node_type * pParent, node_type * pLeft, node_type * pRight )
 138         {
 139             return cxx_allocator().New( std::forward<K>( key ), nHeight, version, pParent, pLeft, pRight );
 140         }
 141
 142         static void free_node( node_type * pNode )
 143         {
 144             // Free node without disposer
 145             assert( !pNode->is_valued( memory_model::memory_order_relaxed ));
 146             assert( pNode->m_SyncMonitorInjection.check_free());
 147             cxx_allocator().Delete( pNode );
 148         }
 149
 150         static void free_value( mapped_type pVal )
 151         {
 152             disposer()(pVal);
 153         }
 154
 155         static node_type * child( node_type * pNode, int nDir, atomics::memory_order order = memory_model::memory_order_relaxed )
 156         {
 157             return pNode->child( nDir ).load( order );
 158         }
 159
 160         static node_type * parent( node_type * pNode, atomics::memory_order order = memory_model::memory_order_relaxed )
 161         {
 162             return pNode->m_pParent.load( order );
 163         }
 164
 165         // RCU safe disposer
 166         class rcu_disposer
 167         {
 168             node_type *     m_pRetiredList;     ///< head of retired node list
 169             mapped_type     m_pRetiredValue;    ///< value retired
 170
 171         public:
 172             rcu_disposer()
 173                 : m_pRetiredList( nullptr )
 174                 , m_pRetiredValue( nullptr )
 175             {}
 176
 177             ~rcu_disposer()
 178             {
 179                 clean();
 180             }
 181
 182             void dispose( node_type * pNode )
 183             {
 184                 assert( !pNode->is_valued( memory_model::memory_order_relaxed ));
 185                 pNode->m_pNextRemoved = m_pRetiredList;
 186                 m_pRetiredList = pNode;
 187             }
 188
 189             void dispose_value( mapped_type pVal )
 190             {
 191                 assert( m_pRetiredValue == nullptr );
 192                 m_pRetiredValue = pVal;
 193             }
 194
 195         private:
 196             struct internal_disposer
 197             {
 198                 void operator()( node_type * p ) const
 199                 {
 200                     free_node( p );
 201                 }
 202             };
 203
 204             void clean()
 205             {
 206                 assert( !gc::is_locked() );
 207
 208                 // TODO: use RCU::batch_retire
 209
 210                 // Dispose nodes
 211                 for ( node_type * p = m_pRetiredList; p; ) {
 212                     node_type * pNext = static_cast<node_type *>( p->m_pNextRemoved );
 213                     // Value already disposed
 214                     gc::template retire_ptr<internal_disposer>( p );
 215                     p = pNext;
 216                 }
 217
 218                 // Dispose value
 219                 if ( m_pRetiredValue  )
 220                     gc::template retire_ptr<disposer>( m_pRetiredValue );
 221             }
 222         };
 223
 224         //@endcond
 225
 226     protected:
 227         //@cond
 228         typename node_type::base_class m_Root;
 229         node_type *             m_pRoot;
 230         item_counter            m_ItemCounter;
 231         mutable sync_monitor    m_Monitor;
 232         mutable stat            m_stat;
 233         //@endcond
 234
 235     public:
 236         /// Creates empty map
 237         BronsonAVLTreeMap()
 238             : m_pRoot( static_cast<node_type *>( &m_Root ))
 239         {}
 240
 241         /// Destroys the map
 242         ~BronsonAVLTreeMap()
 243         {
 244             unsafe_clear();
 245         }
 246
 247         /// Inserts new node
 248         /**
 249             The \p key_type should be constructible from a value of type \p K.
 250
 251             RCU \p synchronize() can be called. RCU should not be locked.
 252
 253             Returns \p true if inserting successful, \p false otherwise.
 254         */
 255         template <typename K>
 256         bool insert( K const& key, mapped_type pVal )
 257         {
 258             return do_update(key, key_comparator(),
 259                 [pVal]( node_type * pNode ) -> mapped_type
 260                 {
 261                     assert( pNode->m_pValue.load( memory_model::memory_order_relaxed ) == nullptr );
 262                     CDS_UNUSED( pNode );
 263                     return pVal;
 264                 },
 265                 update_flags::allow_insert
 266             ) == update_flags::result_inserted;
 267         }
 268
 269         /// Updates the value for \p key
 270         /**
 271             The operation performs inserting or updating the value for \p key with lock-free manner.
 272             If \p bInsert is \p false, only updating of existing node is possible.
 273
 274             If \p key is not found and inserting is allowed (i.e. \p bInsert is \p true),
 275             then the new node created from \p key will be inserted into the map; note that in this case the \ref key_type should be
 276             constructible from type \p K.
 277             Otherwise, the value for \p key will be changed to \p pVal.
 278
 279             RCU \p synchronize() method can be called. RCU should not be locked.
 280
 281             Returns <tt> std::pair<bool, bool> </tt> where \p first is \p true if operation is successfull,
 282             \p second is \p true if new node has been added or \p false if the node with \p key
 283             already exists.
 284         */
 285         template <typename K>
 286         std::pair<bool, bool> update( K const& key, mapped_type pVal, bool bInsert = true )
 287         {
 288             int result = do_update( key, key_comparator(),
 289                 [pVal]( node_type * ) -> mapped_type
 290                 {
 291                     return pVal;
 292                 },
 293                 update_flags::allow_update | (bInsert ? update_flags::allow_insert : 0)
 294             );
 295             return std::make_pair( result != 0, (result & update_flags::result_inserted) != 0 );
 296         }
 297
 298         //@cond
 299         template <typename K>
 300         std::pair<bool, bool> ensure( K const& key, mapped_type pVal )
 301         {
 302             return update( key, pVal, true );
 303         }
 304
 305         //@endcond
 306
 307         /// Delete \p key from the map
 308         /**
 309             RCU \p synchronize() method can be called. RCU should not be locked.
 310
 311             Return \p true if \p key is found and deleted, \p false otherwise
 312         */
 313         template <typename K>
 314         bool erase( K const& key )
 315         {
 316             return do_remove(
 317                 key,
 318                 key_comparator(),
 319                 []( key_type const&, mapped_type pVal, rcu_disposer& disp ) -> bool { disp.dispose_value( pVal ); return true; }
 320             );
 321         }
 322
 323         /// Deletes the item from the map using \p pred predicate for searching
 324         /**
 325             The function is an analog of \p erase(K const&)
 326             but \p pred is used for key comparing.
 327             \p Less functor has the interface like \p std::less.
 328             \p Less must imply the same element order as the comparator used for building the map.
 329         */
 330         template <typename K, typename Less>
 331         bool erase_with( K const& key, Less pred )
 332         {
 333             CDS_UNUSED( pred );
 334             return do_remove(
 335                 key,
 336                 cds::opt::details::make_comparator_from_less<Less>(),
 337                 []( key_type const&, mapped_type pVal, rcu_disposer& disp ) -> bool { disp.dispose_value( pVal ); return true;  }
 338             );
 339         }
 340
 341         /// Delete \p key from the map
 342         /**
 343             The function searches an item with key \p key, calls \p f functor
 344             and deletes the item. If \p key is not found, the functor is not called.
 345
 346             The functor \p Func interface:
 347             \code
 348             struct extractor {
 349                 void operator()( key_type const& key, std::remove_pointer<mapped_type>::type& val) { ... }
 350             };
 351             \endcode
 352
 353             RCU \p synchronize method can be called. RCU should not be locked.
 354
 355             Return \p true if key is found and deleted, \p false otherwise
 356         */
 357         template <typename K, typename Func>
 358         bool erase( K const& key, Func f )
 359         {
 360             return do_remove(
 361                 key,
 362                 key_comparator(),
 363                 [&f]( key_type const& key, mapped_type pVal, rcu_disposer& disp ) -> bool {
 364                     assert( pVal );
 365                     f( key, *pVal );
 366                     disp.dispose_value(pVal);
 367                     return true;
 368                 }
 369             );
 370         }
 371
 372         /// Deletes the item from the map using \p pred predicate for searching
 373         /**
 374             The function is an analog of \p erase(K const&, Func)
 375             but \p pred is used for key comparing.
 376             \p Less functor has the interface like \p std::less.
 377             \p Less must imply the same element order as the comparator used for building the map.
 378         */
 379         template <typename K, typename Less, typename Func>
 380         bool erase_with( K const& key, Less pred, Func f )
 381         {
 382             CDS_UNUSED( pred );
 383             return do_remove(
 384                 key,
 385                 cds::opt::details::make_comparator_from_less<Less>(),
 386                 [&f]( key_type const& key, mapped_type pVal, rcu_disposer& disp ) -> bool {
 387                     assert( pVal );
 388                     f( key, *pVal );
 389                     disp.dispose_value(pVal);
 390                     return true;
 391                 }
 392             );
 393         }
 394
 395         /// Extracts a value with minimal key from the map
 396         /**
 397             Returns \p exempt_ptr to the leftmost item.
 398             If the tree is empty, returns empty \p exempt_ptr.
 399
 400             Note that the function returns only the value for minimal key.
 401             To retrieve its key use \p extract_min( Func ) member function.
 402
 403             @note Due the concurrent nature of the map, the function extracts <i>nearly</i> minimum key.
 404             It means that the function gets leftmost leaf of the tree and tries to unlink it.
 405             During unlinking, a concurrent thread may insert an item with key less than leftmost item's key.
 406             So, the function returns the item with minimum key at the moment of tree traversing.
 407
 408             RCU \p synchronize method can be called. RCU should NOT be locked.
 409             The function does not free the item.
 410             The deallocator will be implicitly invoked when the returned object is destroyed or when
 411             its \p release() member function is called.
 412         */
 413         exempt_ptr extract_min()
 414         {
 415             return exempt_ptr(do_extract_min( []( key_type const& ) {}));
 416         }
 417
 418         /// Extracts minimal key key and corresponding value
 419         /**
 420             Returns \p exempt_ptr to the leftmost item.
 421             If the tree is empty, returns empty \p exempt_ptr.
 422
 423             \p Func functor is used to store minimal key.
 424             \p Func has the following signature:
 425             \code
 426             struct functor {
 427                 void operator()( key_type const& key );
 428             };
 429             \endcode
 430             If the tree is empty, \p f is not called.
 431             Otherwise, is it called with minimal key, the pointer to corresponding value is returned
 432             as \p exempt_ptr.
 433
 434             @note Due the concurrent nature of the map, the function extracts <i>nearly</i> minimum key.
 435             It means that the function gets leftmost leaf of the tree and tries to unlink it.
 436             During unlinking, a concurrent thread may insert an item with key less than leftmost item's key.
 437             So, the function returns the item with minimum key at the moment of tree traversing.
 438
 439             RCU \p synchronize method can be called. RCU should NOT be locked.
 440             The function does not free the item.
 441             The deallocator will be implicitly invoked when the returned object is destroyed or when
 442             its \p release() member function is called.
 443         */
 444         template <typename Func>
 445         exempt_ptr extract_min( Func f )
 446         {
 447             return exempt_ptr(do_extract_min( [&f]( key_type const& key ) { f(key); }));
 448         }
 449
 450         /// Extracts minimal key key and corresponding value
 451         /**
 452             This function is a shortcut for the following call:
 453             \code
 454             key_type key;
 455             exempt_ptr xp = theTree.extract_min( [&key]( key_type const& k ) { key = k; } );
 456             \endode
 457             \p key_type should be copy-assignable. The copy of minimal key
 458             is returned in \p min_key argument.
 459         */
 460         typename std::enable_if< std::is_copy_assignable<key_type>::value, exempt_ptr >::type
 461         extract_min_key( key_type& min_key )
 462         {
 463             return exempt_ptr(do_extract_min( [&min_key]( key_type const& key ) { min_key = key; }));
 464         }
 465
 466         /// Extracts a value with maximal key from the tree
 467         /**
 468             Returns \p exempt_ptr pointer to the rightmost item.
 469             If the set is empty, returns empty \p exempt_ptr.
 470
 471             Note that the function returns only the value for maximal key.
 472             To retrieve its key use \p extract_max( Func ) member function.
 473
 474             @note Due the concurrent nature of the map, the function extracts <i>nearly</i> maximal key.
 475             It means that the function gets rightmost leaf of the tree and tries to unlink it.
 476             During unlinking, a concurrent thread may insert an item with key great than leftmost item's key.
 477             So, the function returns the item with maximum key at the moment of tree traversing.
 478
 479             RCU \p synchronize method can be called. RCU should NOT be locked.
 480             The function does not free the item.
 481             The deallocator will be implicitly invoked when the returned object is destroyed or when
 482             its \p release() is called.
 483         */
 484         exempt_ptr extract_max()
 485         {
 486             return exempt_ptr(do_extract_max( []( key_type const& ) {}));
 487         }
 488
 489         /// Extracts the maximal key and corresponding value
 490         /**
 491             Returns \p exempt_ptr pointer to the rightmost item.
 492             If the set is empty, returns empty \p exempt_ptr.
 493
 494             \p Func functor is used to store maximal key.
 495             \p Func has the following signature:
 496             \code
 497                 struct functor {
 498                     void operator()( key_type const& key );
 499                 };
 500             \endcode
 501             If the tree is empty, \p f is not called.
 502             Otherwise, is it called with maximal key, the pointer to corresponding value is returned
 503             as \p exempt_ptr.
 504
 505             @note Due the concurrent nature of the map, the function extracts <i>nearly</i> maximal key.
 506             It means that the function gets rightmost leaf of the tree and tries to unlink it.
 507             During unlinking, a concurrent thread may insert an item with key great than leftmost item's key.
 508             So, the function returns the item with maximum key at the moment of tree traversing.
 509
 510             RCU \p synchronize method can be called. RCU should NOT be locked.
 511             The function does not free the item.
 512             The deallocator will be implicitly invoked when the returned object is destroyed or when
 513             its \p release() is called.
 514         */
 515         template <typename Func>
 516         exempt_ptr extract_max( Func f )
 517         {
 518             return exempt_ptr(do_extract_max( [&f]( key_type const& key ) { f(key); }));
 519         }
 520
 521         /// Extracts the maximal key and corresponding value
 522         /**
 523             This function is a shortcut for the following call:
 524             \code
 525                 key_type key;
 526                 exempt_ptr xp = theTree.extract_max( [&key]( key_type const& k ) { key = k; } );
 527             \endode
 528             \p key_type should be copy-assignable. The copy of maximal key
 529             is returned in \p max_key argument.
 530         */
 531         typename std::enable_if< std::is_copy_assignable<key_type>::value, exempt_ptr >::type
 532         extract_max_key( key_type& max_key )
 533         {
 534             return exempt_ptr(do_extract_max( [&max_key]( key_type const& key ) { max_key = key; }));
 535         }
 536
 537         /// Extracts an item from the map
 538         /**
 539             The function searches an item with key equal to \p key in the tree,
 540             unlinks it, and returns \p exempt_ptr pointer to a value found.
 541             If \p key is not found the function returns an empty \p exempt_ptr.
 542
 543             RCU \p synchronize method can be called. RCU should NOT be locked.
 544             The function does not destroy the value found.
 545             The disposer will be implicitly invoked when the returned object is destroyed or when
 546             its \p release() member function is called.
 547         */
 548         template <typename Q>
 549         exempt_ptr extract( Q const& key )
 550         {
 551             return exempt_ptr(do_extract( key ));
 552         }
 553
 554
 555         /// Extracts an item from the map using \p pred for searching
 556         /**
 557             The function is an analog of \p extract(Q const&)
 558             but \p pred is used for key compare.
 559             \p Less has the interface like \p std::less.
 560             \p pred must imply the same element order as the comparator used for building the tree.
 561         */
 562         template <typename Q, typename Less>
 563         exempt_ptr extract_with( Q const& key, Less pred )
 564         {
 565             return exempt_ptr(do_extract_with( key, pred ));
 566         }
 567
 568         /// Find the key \p key
 569         /**
 570             The function searches the item with key equal to \p key and calls the functor \p f for item found.
 571             The interface of \p Func functor is:
 572             \code
 573             struct functor {
 574                 void operator()( key_type const& key, mapped_type& item );
 575             };
 576             \endcode
 577             where \p item is the item found.
 578             The functor is called under node-level lock.
 579
 580             The function applies RCU lock internally.
 581
 582             The function returns \p true if \p key is found, \p false otherwise.
 583         */
 584         template <typename K, typename Func>
 585         bool find( K const& key, Func f )
 586         {
 587             return do_find( key, key_comparator(),
 588                 [&f]( node_type * pNode ) -> bool {
 589                     assert( pNode != nullptr );
 590                     mapped_type pVal = pNode->m_pValue.load( memory_model::memory_order_relaxed );
 591                     if ( pVal ) {
 592                         f( pNode->m_key, *pVal );
 593                         return true;
 594                     }
 595                     return false;
 596                 }
 597             );
 598         }
 599
 600         /// Finds the key \p val using \p pred predicate for searching
 601         /**
 602             The function is an analog of \p find(K const&, Func)
 603             but \p pred is used for key comparing.
 604             \p Less functor has the interface like \p std::less.
 605             \p Less must imply the same element order as the comparator used for building the map.
 606         */
 607         template <typename K, typename Less, typename Func>
 608         bool find_with( K const& key, Less pred, Func f )
 609         {
 610             CDS_UNUSED( pred );
 611             return do_find( key, cds::opt::details::make_comparator_from_less<Less>(),
 612                 [&f]( node_type * pNode ) -> bool {
 613                     assert( pNode != nullptr );
 614                     mapped_type pVal = pNode->m_pValue.load( memory_model::memory_order_relaxed );
 615                     if ( pVal ) {
 616                         f( pNode->m_key, *pVal );
 617                         return true;
 618                     }
 619                     return false;
 620                 }
 621             );
 622         }
 623
 624         /// Find the key \p key
 625         /**
 626             The function searches the item with key equal to \p key
 627             and returns \p true if it is found, and \p false otherwise.
 628
 629             The function applies RCU lock internally.
 630         */
 631         template <typename K>
 632         bool find( K const& key )
 633         {
 634             return do_find( key, key_comparator(), []( node_type * ) -> bool { return true; });
 635         }
 636
 637         /// Finds the key \p val using \p pred predicate for searching
 638         /**
 639             The function is an analog of \p find(K const&)
 640             but \p pred is used for key comparing.
 641             \p Less functor has the interface like \p std::less.
 642             \p Less must imply the same element order as the comparator used for building the map.
 643         */
 644         template <typename K, typename Less>
 645         bool find_with( K const& key, Less pred )
 646         {
 647             CDS_UNUSED( pred );
 648             return do_find( key, cds::opt::details::make_comparator_from_less<Less>(), []( node_type * ) -> bool { return true; } );
 649         }
 650
 651         /// Clears the tree (thread safe, not atomic)
 652         /**
 653             The function unlink all items from the tree.
 654             The function is thread safe but not atomic: in multi-threaded environment with parallel insertions
 655             this sequence
 656             \code
 657             set.clear();
 658             assert( set.empty() );
 659             \endcode
 660             the assertion could be raised.
 661
 662             For each node the \ref disposer will be called after unlinking.
 663
 664             RCU \p synchronize method can be called. RCU should not be locked.
 665         */
 666         void clear()
 667         {
 668             while ( extract_min() );
 669         }
 670
 671         /// Clears the tree (not thread safe)
 672         /**
 673             This function is not thread safe and may be called only when no other thread deals with the tree.
 674             The function is used in the tree destructor.
 675         */
 676         void unsafe_clear()
 677         {
 678             clear(); // temp solution
 679             //TODO
 680         }
 681
 682         /// Checks if the map is empty
 683         bool empty() const
 684         {
 685             return m_Root.m_pRight.load( memory_model::memory_order_relaxed ) == nullptr;
 686         }
 687
 688         /// Returns item count in the map
 689         /**
 690             Only leaf nodes containing user data are counted.
 691
 692             The value returned depends on item counter type provided by \p Traits template parameter.
 693             If it is \p atomicity::empty_item_counter this function always returns 0.
 694
 695             The function is not suitable for checking the tree emptiness, use \p empty()
 696             member function for this purpose.
 697         */
 698         size_t size() const
 699         {
 700             return m_ItemCounter;
 701         }
 702
 703         /// Returns const reference to internal statistics
 704         stat const& statistics() const
 705         {
 706             return m_stat;
 707         }
 708
 709         /// Returns reference to \p sync_monitor object
 710         sync_monitor& monitor()
 711         {
 712             return m_Monitor;
 713         }
 714         //@cond
 715         sync_monitor const& monitor() const
 716         {
 717             return m_Monitor;
 718         }
 719         //@endcond
 720
 721         /// Checks internal consistency (not atomic, not thread-safe)
 722         /**
 723             The debugging function to check internal consistency of the tree.
 724         */
 725         bool check_consistency() const
 726         {
 727             return check_consistency([]( size_t /*nLevel*/, size_t /*hLeft*/, size_t /*hRight*/ ){} );
 728         }
 729
 730         /// Checks internal consistency (not atomic, not thread-safe)
 731         /**
 732             The debugging function to check internal consistency of the tree.
 733             The functor \p Func is called if a violation of internal tree structure
 734             is found:
 735             \code
 736             struct functor {
 737                 void operator()( size_t nLevel, size_t hLeft, size_t hRight );
 738             };
 739             \endcode
 740             where
 741             - \p nLevel - the level where the violation is found
 742             - \p hLeft - the height of left subtree
 743             - \p hRight - the height of right subtree
 744
 745             The functor is called for each violation found.
 746         */
 747         template <typename Func>
 748         bool check_consistency( Func f ) const
 749         {
 750             node_type * pChild = child( m_pRoot, right_child );
 751             if ( pChild ) {
 752                 size_t nErrors = 0;
 753                 do_check_consistency( pChild, 1, f, nErrors );
 754                 return nErrors == 0;
 755             }
 756             return true;
 757         }
 758
 759     protected:
 760         //@cond
 761         template <typename Func>
 762         size_t do_check_consistency( node_type * pNode, size_t nLevel, Func f, size_t& nErrors ) const
 763         {
 764             if ( pNode ) {
 765                 key_comparator cmp;
 766                 node_type * pLeft = child( pNode, left_child );
 767                 node_type * pRight = child( pNode, right_child );
 768                 if ( pLeft && cmp( pLeft->m_key, pNode->m_key ) > 0 )
 769                     ++nErrors;
 770                 if (  pRight && cmp( pNode->m_key, pRight->m_key ) > 0 )
 771                     ++nErrors;
 772
 773                 size_t hLeft = do_check_consistency( pLeft, nLevel + 1, f, nErrors );
 774                 size_t hRight = do_check_consistency( pRight, nLevel + 1, f, nErrors );
 775
 776                 if ( hLeft >= hRight ) {
 777                     if ( hLeft - hRight > 1 ) {
 778                         f( nLevel, hLeft, hRight );
 779                         ++nErrors;
 780                     }
 781                     return hLeft;
 782                 }
 783                 else {
 784                     if ( hRight - hLeft > 1 ) {
 785                         f( nLevel, hLeft, hRight );
 786                         ++nErrors;
 787                     }
 788                     return hRight;
 789                 }
 790             }
 791             return 0;
 792         }
 793
 794         template <typename Q, typename Compare, typename Func>
 795         bool do_find( Q& key, Compare cmp, Func f ) const
 796         {
 797             find_result result;
 798             {
 799                 rcu_lock l;
 800                 result = try_find( key, cmp, f, m_pRoot, 1, 0 );
 801             }
 802             assert( result != find_result::retry );
 803             return result == find_result::found;
 804         }
 805
 806         template <typename K, typename Compare, typename Func>
 807         int do_update( K const& key, Compare cmp, Func funcUpdate, int nFlags )
 808         {
 809             check_deadlock_policy::check();
 810
 811             rcu_disposer removed_list;
 812             {
 813                 rcu_lock l;
 814                 return try_update_root( key, cmp, nFlags, funcUpdate, removed_list );
 815             }
 816         }
 817
 818         template <typename K, typename Compare, typename Func>
 819         bool do_remove( K const& key, Compare cmp, Func func )
 820         {
 821             // Func must return true if the value was disposed
 822             //              or false if the value was extracted
 823
 824             check_deadlock_policy::check();
 825
 826             rcu_disposer removed_list;
 827             {
 828                 rcu_lock l;
 829                 return try_remove_root( key, cmp, func, removed_list );
 830             }
 831         }
 832
 833         template <typename Func>
 834         mapped_type do_extract_min( Func f )
 835         {
 836             mapped_type pExtracted = nullptr;
 837             do_extract_minmax(
 838                 left_child,
 839                 [&pExtracted, &f]( key_type const& key, mapped_type pVal, rcu_disposer& ) -> bool { f( key ); pExtracted = pVal; return false; }
 840             );
 841             return pExtracted;
 842         }
 843
 844         template <typename Func>
 845         mapped_type do_extract_max( Func f )
 846         {
 847             mapped_type pExtracted = nullptr;
 848             do_extract_minmax(
 849                 right_child,
 850                 [&pExtracted, &f]( key_type const& key, mapped_type pVal, rcu_disposer& ) -> bool { f( key ); pExtracted = pVal; return false; }
 851             );
 852             return pExtracted;
 853         }
 854
 855         template <typename Func>
 856         void do_extract_minmax( int nDir, Func func )
 857         {
 858             check_deadlock_policy::check();
 859
 860             rcu_disposer removed_list;
 861             {
 862                 rcu_lock l;
 863
 864                 int result = update_flags::failed;
 865                 do {
 866                     // get right child of root
 867                     node_type * pChild = child( m_pRoot, right_child, memory_model::memory_order_acquire );
 868                     if ( pChild ) {
 869                         version_type nChildVersion = pChild->version( memory_model::memory_order_acquire );
 870                         if ( nChildVersion & node_type::shrinking ) {
 871                             m_stat.onRemoveRootWaitShrinking();
 872                             pChild->template wait_until_shrink_completed<back_off>( memory_model::memory_order_relaxed );
 873                             result = update_flags::retry;
 874                         }
 875                         else if ( pChild == child( m_pRoot, right_child, memory_model::memory_order_acquire )) {
 876                             result = try_extract_minmax( nDir, func, m_pRoot, pChild, nChildVersion, removed_list );
 877                         }
 878                     }
 879                 } while ( result == update_flags::retry );
 880             }
 881         }
 882
 883         template <typename Q>
 884         mapped_type do_extract( Q const& key )
 885         {
 886             mapped_type pExtracted = nullptr;
 887             do_remove(
 888                 key,
 889                 key_comparator(),
 890                 [&pExtracted]( key_type const&, mapped_type pVal, rcu_disposer& ) -> bool { pExtracted = pVal; return false; }
 891             );
 892             return pExtracted;
 893         }
 894
 895         template <typename Q, typename Less>
 896         mapped_type do_extract_with( Q const& key, Less pred )
 897         {
 898             CDS_UNUSED( pred );
 899             mapped_type pExtracted = nullptr;
 900             do_remove(
 901                 key,
 902                 cds::opt::details::make_comparator_from_less<Less>(),
 903                 [&pExtracted]( key_type const&, mapped_type pVal, rcu_disposer& ) -> bool { pExtracted = pVal; return false; }
 904             );
 905             return pExtracted;
 906         }
 907         //@endcond
 908
 909     private:
 910         //@cond
 911         static int height( node_type * pNode, atomics::memory_order order = memory_model::memory_order_relaxed )
 912         {
 913             assert( pNode );
 914             return pNode->m_nHeight.load( order );
 915         }
 916         static void set_height( node_type * pNode, int h, atomics::memory_order order = memory_model::memory_order_relaxed )
 917         {
 918             assert( pNode );
 919             pNode->m_nHeight.store( h, order );
 920         }
 921         static int height_null( node_type * pNode, atomics::memory_order order = memory_model::memory_order_relaxed )
 922         {
 923             return pNode ? height( pNode, order ) : 0;
 924         }
 925
 926         template <typename Q, typename Compare, typename Func>
 927         find_result try_find( Q const& key, Compare cmp, Func f, node_type * pNode, int nDir, version_type nVersion ) const
 928         {
 929             assert( gc::is_locked() );
 930             assert( pNode );
 931
 932             while ( true ) {
 933                 node_type * pChild = child( pNode, nDir );
 934                 if ( !pChild ) {
 935                     if ( pNode->version( memory_model::memory_order_acquire ) != nVersion ) {
 936                         m_stat.onFindRetry();
 937                         return find_result::retry;
 938                     }
 939
 940                     m_stat.onFindFailed();
 941                     return find_result::not_found;
 942                 }
 943
 944                 int nCmp = cmp( key, pChild->m_key );
 945                 if ( nCmp == 0 ) {
 946                     if ( pChild->is_valued( memory_model::memory_order_relaxed ) ) {
 947                         // key found
 948                         node_scoped_lock l( m_Monitor, *pChild );
 949                         if ( pChild->is_valued( memory_model::memory_order_relaxed )) {
 950                             if ( f( pChild ) ) {
 951                                 m_stat.onFindSuccess();
 952                                 return find_result::found;
 953                             }
 954                         }
 955                     }
 956
 957                     m_stat.onFindFailed();
 958                     return find_result::not_found;
 959                 }
 960
 961                 version_type nChildVersion = pChild->version( memory_model::memory_order_acquire );
 962                 if ( nChildVersion & node_type::shrinking ) {
 963                     m_stat.onFindWaitShrinking();
 964                     pChild->template wait_until_shrink_completed<back_off>( memory_model::memory_order_relaxed );
 965
 966                     if ( pNode->version( memory_model::memory_order_acquire ) != nVersion ) {
 967                         m_stat.onFindRetry();
 968                         return find_result::retry;
 969                     }
 970                 }
 971                 else if ( nChildVersion != node_type::unlinked ) {
 972                     if ( pNode->version( memory_model::memory_order_acquire ) != nVersion ) {
 973                         m_stat.onFindRetry();
 974                         return find_result::retry;
 975                     }
 976
 977                     find_result found = try_find( key, cmp, f, pChild, nCmp, nChildVersion );
 978                     if ( found != find_result::retry ) {
 979                         if ( found == find_result::not_found && child(pNode, nDir) != pChild ) {
 980                             // Oops! That is a bug!!!
 981                             m_stat.onFindNotFoundRetry();
 982                         }
 983                         else
 984                             return found;
 985                     }
 986                 }
 987
 988                 if ( pNode->version( memory_model::memory_order_acquire ) != nVersion ) {
 989                     m_stat.onFindRetry();
 990                     return find_result::retry;
 991                 }
 992             }
 993         }
 994
 995         template <typename K, typename Compare, typename Func>
 996         int try_update_root( K const& key, Compare cmp, int nFlags, Func funcUpdate, rcu_disposer& disp )
 997         {
 998             assert( gc::is_locked() );
 999
1000             int result;
1001             do {
1002                 // get right child of root
1003                 node_type * pChild = child( m_pRoot, right_child, memory_model::memory_order_acquire );
1004                 if ( pChild ) {
1005                     version_type nChildVersion = pChild->version( memory_model::memory_order_acquire );
1006                     if ( nChildVersion & node_type::shrinking ) {
1007                         m_stat.onUpdateRootWaitShrinking();
1008                         pChild->template wait_until_shrink_completed<back_off>( memory_model::memory_order_relaxed );
1009                         result = update_flags::retry;
1010                     }
1011                     else if ( pChild == child( m_pRoot, right_child, memory_model::memory_order_acquire )) {
1012                         result = try_update( key, cmp, nFlags, funcUpdate, m_pRoot, pChild, nChildVersion, disp );
1013                     }
1014                     else
1015                         result = update_flags::retry;
1016                 }
1017                 else {
1018                     // the tree is empty
1019                     if ( nFlags & update_flags::allow_insert ) {
1020                         // insert into tree as right child of the root
1021                         {
1022                             node_scoped_lock l( m_Monitor, *m_pRoot );
1023                             if ( child( m_pRoot, right_child, memory_model::memory_order_acquire ) != nullptr ) {
1024                                 result = update_flags::retry;
1025                                 continue;
1026                             }
1027
1028                             node_type * pNew = alloc_node( key, 1, 0, m_pRoot, nullptr, nullptr );
1029                             mapped_type pVal = funcUpdate( pNew );
1030                             assert( pVal != nullptr );
1031                             pNew->m_pValue.store( pVal, memory_model::memory_order_release );
1032
1033                             m_pRoot->child( pNew, right_child, memory_model::memory_order_relaxed );
1034                             set_height( m_pRoot, 2 );
1035                         }
1036
1037                         ++m_ItemCounter;
1038                         m_stat.onInsertSuccess();
1039                         return update_flags::result_inserted;
1040                     }
1041
1042                     return update_flags::failed;
1043                 }
1044             } while ( result == update_flags::retry );
1045             return result;
1046         }
1047
1048         template <typename K, typename Compare, typename Func>
1049         bool try_remove_root( K const& key, Compare cmp, Func func, rcu_disposer& disp )
1050         {
1051             assert( gc::is_locked() );
1052
1053             int result;
1054             do {
1055                 // get right child of root
1056                 node_type * pChild = child( m_pRoot, right_child, memory_model::memory_order_acquire );
1057                 if ( pChild ) {
1058                     version_type nChildVersion = pChild->version( memory_model::memory_order_acquire );
1059                     if ( nChildVersion & node_type::shrinking ) {
1060                         m_stat.onRemoveRootWaitShrinking();
1061                         pChild->template wait_until_shrink_completed<back_off>( memory_model::memory_order_relaxed );
1062                         result = update_flags::retry;
1063                     }
1064                     else if ( pChild == child( m_pRoot, right_child, memory_model::memory_order_acquire )) {
1065                         result = try_remove( key, cmp, func, m_pRoot, pChild, nChildVersion, disp );
1066                     }
1067                     else
1068                         result = update_flags::retry;
1069                 }
1070                 else
1071                     return false;
1072             } while ( result == update_flags::retry );
1073
1074             return result == update_flags::result_removed;
1075         }
1076
1077         template <typename K, typename Compare, typename Func>
1078         int try_update( K const& key, Compare cmp, int nFlags, Func funcUpdate, node_type * pParent, node_type * pNode, version_type nVersion, rcu_disposer& disp )
1079         {
1080             assert( gc::is_locked() );
1081             assert( nVersion != node_type::unlinked );
1082             CDS_UNUSED( pParent );
1083
1084             int nCmp = cmp( key, pNode->m_key );
1085             if ( nCmp == 0 ) {
1086                 if ( nFlags & update_flags::allow_update ) {
1087                     return try_update_node( funcUpdate, pNode, disp );
1088                 }
1089                 return update_flags::failed;
1090             }
1091
1092             int result;
1093             do {
1094                 node_type * pChild = child( pNode, nCmp );
1095                 if ( pNode->version(memory_model::memory_order_acquire) != nVersion ) {
1096                     m_stat.onUpdateRetry();
1097                     return update_flags::retry;
1098                 }
1099
1100                 if ( pChild == nullptr ) {
1101                     // insert new node
1102                     if ( nFlags & update_flags::allow_insert )
1103                         result = try_insert_node( key, funcUpdate, pNode, nCmp, nVersion, disp );
1104                     else
1105                         result = update_flags::failed;
1106                 }
1107                 else {
1108                     // update child
1109                     result = update_flags::retry;
1110                     version_type nChildVersion = pChild->version( memory_model::memory_order_acquire );
1111                     if ( nChildVersion & node_type::shrinking ) {
1112                         m_stat.onUpdateWaitShrinking();
1113                         pChild->template wait_until_shrink_completed<back_off>( memory_model::memory_order_relaxed );
1114                         // retry
1115                     }
1116                     else if ( pChild == child( pNode, nCmp )) {
1117                         // this second read is important, because it is protected by nChildVersion
1118
1119                         // validate the read that our caller took to get to node
1120                         if ( pNode->version( memory_model::memory_order_acquire ) != nVersion ) {
1121                             m_stat.onUpdateRetry();
1122                             return update_flags::retry;
1123                         }
1124
1125                         // At this point we know that the traversal our parent took to get to node is still valid.
1126                         // The recursive implementation will validate the traversal from node to
1127                         // child, so just prior to the node nVersion validation both traversals were definitely okay.
1128                         // This means that we are no longer vulnerable to node shrinks, and we don't need
1129                         // to validate node version any more.
1130                         result = try_update( key, cmp, nFlags, funcUpdate, pNode, pChild, nChildVersion, disp );
1131                     }
1132                 }
1133
1134                 if ( result == update_flags::retry && pNode->version( memory_model::memory_order_acquire ) != nVersion ) {
1135                     m_stat.onUpdateRetry();
1136                     return update_flags::retry;
1137                 }
1138             } while ( result == update_flags::retry );
1139             return result;
1140         }
1141
1142         template <typename K, typename Compare, typename Func>
1143         int try_remove( K const& key, Compare cmp, Func func, node_type * pParent, node_type * pNode, version_type nVersion, rcu_disposer& disp )
1144         {
1145             assert( gc::is_locked() );
1146             assert( nVersion != node_type::unlinked );
1147
1148             int nCmp = cmp( key, pNode->m_key );
1149             if ( nCmp == 0 )
1150                 return try_remove_node( pParent, pNode, nVersion, func, disp );
1151
1152             int result;
1153             do {
1154                 node_type * pChild = child( pNode, nCmp );
1155                 if ( pNode->version(memory_model::memory_order_acquire) != nVersion ) {
1156                     m_stat.onRemoveRetry();
1157                     return update_flags::retry;
1158                 }
1159
1160                 if ( pChild == nullptr ) {
1161                     return update_flags::failed;
1162                 }
1163                 else {
1164                     // update child
1165                     result = update_flags::retry;
1166                     version_type nChildVersion = pChild->version( memory_model::memory_order_acquire );
1167                     if ( nChildVersion & node_type::shrinking ) {
1168                         m_stat.onRemoveWaitShrinking();
1169                         pChild->template wait_until_shrink_completed<back_off>( memory_model::memory_order_relaxed );
1170                         // retry
1171                     }
1172                     else if ( pChild == child( pNode, nCmp )) {
1173                         // this second read is important, because it is protected by nChildVersion
1174
1175                         // validate the read that our caller took to get to node
1176                         if ( pNode->version( memory_model::memory_order_acquire ) != nVersion ) {
1177                             m_stat.onRemoveRetry();
1178                             return update_flags::retry;
1179                         }
1180
1181                         // At this point we know that the traversal our parent took to get to node is still valid.
1182                         // The recursive implementation will validate the traversal from node to
1183                         // child, so just prior to the node nVersion validation both traversals were definitely okay.
1184                         // This means that we are no longer vulnerable to node shrinks, and we don't need
1185                         // to validate node version any more.
1186                         result = try_remove( key, cmp, func, pNode, pChild, nChildVersion, disp );
1187                     }
1188                 }
1189
1190                 if ( result == update_flags::retry && pNode->version( memory_model::memory_order_acquire ) != nVersion ) {
1191                     m_stat.onRemoveRetry();
1192                     return update_flags::retry;
1193                 }
1194             } while ( result == update_flags::retry );
1195             return result;
1196         }
1197
1198         template <typename Func>
1199         int try_extract_minmax( int nDir, Func func, node_type * pParent, node_type * pNode, version_type nVersion, rcu_disposer& disp )
1200         {
1201             assert( gc::is_locked() );
1202             assert( nVersion != node_type::unlinked );
1203
1204             int result;
1205             do {
1206                 node_type * pChild = child( pNode, nDir );
1207                 if ( pNode->version(memory_model::memory_order_acquire) != nVersion ) {
1208                     m_stat.onRemoveRetry();
1209                     return update_flags::retry;
1210                 }
1211
1212                 if ( pChild == nullptr ) {
1213                     // Found min/max
1214                     return try_remove_node( pParent, pNode, nVersion, func, disp );
1215                 }
1216                 else {
1217                     result = update_flags::retry;
1218                     version_type nChildVersion = pChild->version( memory_model::memory_order_acquire );
1219                     if ( nChildVersion & node_type::shrinking ) {
1220                         m_stat.onRemoveWaitShrinking();
1221                         pChild->template wait_until_shrink_completed<back_off>( memory_model::memory_order_relaxed );
1222                         // retry
1223                     }
1224                     else if ( pChild == child( pNode, nDir )) {
1225                         // this second read is important, because it is protected by nChildVersion
1226
1227                         // validate the read that our caller took to get to node
1228                         if ( pNode->version( memory_model::memory_order_acquire ) != nVersion ) {
1229                             m_stat.onRemoveRetry();
1230                             return update_flags::retry;
1231                         }
1232
1233                         // At this point we know that the traversal our parent took to get to node is still valid.
1234                         // The recursive implementation will validate the traversal from node to
1235                         // child, so just prior to the node nVersion validation both traversals were definitely okay.
1236                         // This means that we are no longer vulnerable to node shrinks, and we don't need
1237                         // to validate node version any more.
1238                         result = try_extract_minmax( nDir, func, pNode, pChild, nChildVersion, disp );
1239                     }
1240                 }
1241
1242                 if ( result == update_flags::retry && pNode->version( memory_model::memory_order_acquire ) != nVersion ) {
1243                     m_stat.onRemoveRetry();
1244                     return update_flags::retry;
1245                 }
1246             } while ( result == update_flags::retry );
1247             return result;
1248         }
1249
1250         template <typename K, typename Func>
1251         int try_insert_node( K const& key, Func funcUpdate, node_type * pNode, int nDir, version_type nVersion, rcu_disposer& disp )
1252         {
1253             node_type * pNew;
1254
1255             auto fnCreateNode = [&funcUpdate]( node_type * pNew ) {
1256                 mapped_type pVal = funcUpdate( pNew );
1257                 assert( pVal != nullptr );
1258                 pNew->m_pValue.store( pVal, memory_model::memory_order_relaxed );
1259             };
1260
1261             if ( c_bRelaxedInsert ) {
1262                 if ( pNode->version( memory_model::memory_order_acquire ) != nVersion
1263                      || child( pNode, nDir ) != nullptr )
1264                 {
1265                     m_stat.onInsertRetry();
1266                     return update_flags::retry;
1267                 }
1268
1269                 fnCreateNode( pNew = alloc_node( key, 1, 0, pNode, nullptr, nullptr ));
1270             }
1271
1272             node_type * pDamaged;
1273             {
1274                 assert( pNode != nullptr );
1275                 node_scoped_lock l( m_Monitor, *pNode );
1276
1277                 if ( pNode->version( memory_model::memory_order_acquire ) != nVersion
1278                      || child( pNode, nDir ) != nullptr )
1279                 {
1280                     if ( c_bRelaxedInsert ) {
1281                         mapped_type pVal = pNew->m_pValue.load( memory_model::memory_order_relaxed );
1282                         pNew->m_pValue.store( nullptr, memory_model::memory_order_relaxed );
1283                         free_value( pVal );
1284                         free_node( pNew );
1285                         m_stat.onRelaxedInsertFailed();
1286                     }
1287
1288                     m_stat.onInsertRetry();
1289                     return update_flags::retry;
1290                 }
1291
1292                 if ( !c_bRelaxedInsert )
1293                     fnCreateNode( pNew = alloc_node( key, 1, 0, pNode, nullptr, nullptr ));
1294
1295                 pNode->child( pNew, nDir, memory_model::memory_order_relaxed );
1296                 pDamaged = fix_height_locked( pNode );
1297             }
1298
1299             ++m_ItemCounter;
1300             m_stat.onInsertSuccess();
1301
1302             if ( pDamaged ) {
1303                 fix_height_and_rebalance( pDamaged, disp );
1304                 m_stat.onInsertRebalanceRequired();
1305             }
1306
1307             return update_flags::result_inserted;
1308         }
1309
1310         template <typename Func>
1311         int try_update_node( Func funcUpdate, node_type * pNode, rcu_disposer& disp )
1312         {
1313             mapped_type pOld;
1314             assert( pNode != nullptr );
1315             {
1316                 node_scoped_lock l( m_Monitor, *pNode );
1317
1318                 if ( pNode->is_unlinked( memory_model::memory_order_relaxed )) {
1319                     m_stat.onUpdateUnlinked();
1320                     return update_flags::retry;
1321                 }
1322
1323                 pOld = pNode->value( memory_model::memory_order_relaxed );
1324                 mapped_type pVal = funcUpdate( pNode );
1325                 if ( pVal == pOld )
1326                     pOld = nullptr;
1327                 else {
1328                     assert( pVal != nullptr );
1329                     pNode->m_pValue.store( pVal, memory_model::memory_order_relaxed );
1330                 }
1331             }
1332
1333             if ( pOld ) {
1334                 disp.dispose_value(pOld);
1335                 m_stat.onDisposeValue();
1336             }
1337
1338             m_stat.onUpdateSuccess();
1339             return update_flags::result_updated;
1340         }
1341
1342         template <typename Func>
1343         int try_remove_node( node_type * pParent, node_type * pNode, version_type nVersion, Func func, rcu_disposer& disp )
1344         {
1345             assert( pParent != nullptr );
1346             assert( pNode != nullptr );
1347
1348             if ( !pNode->is_valued( atomics::memory_order_relaxed ) )
1349                 return update_flags::failed;
1350
1351             if ( child( pNode, left_child ) == nullptr || child( pNode, right_child ) == nullptr ) {
1352                 node_type * pDamaged;
1353                 mapped_type pOld;
1354                 {
1355                     node_scoped_lock lp( m_Monitor, *pParent );
1356                     if ( pParent->is_unlinked( atomics::memory_order_relaxed ) || parent( pNode ) != pParent )
1357                         return update_flags::retry;
1358
1359                     {
1360                         node_scoped_lock ln( m_Monitor, *pNode );
1361                         pOld = pNode->value( memory_model::memory_order_relaxed );
1362                         if ( !( pNode->version( memory_model::memory_order_acquire ) == nVersion
1363                           && pOld
1364                           && try_unlink_locked( pParent, pNode, disp )))
1365                         {
1366                             return update_flags::retry;
1367                         }
1368                     }
1369                     pDamaged = fix_height_locked( pParent );
1370                 }
1371
1372                 --m_ItemCounter;
1373                 if ( func( pNode->m_key, pOld, disp ))   // calls pOld disposer inside
1374                     m_stat.onDisposeValue();
1375                 else
1376                     m_stat.onExtractValue();
1377
1378                 if ( pDamaged ) {
1379                     fix_height_and_rebalance( pDamaged, disp );
1380                     m_stat.onRemoveRebalanceRequired();
1381                 }
1382                 return update_flags::result_removed;
1383             }
1384             else {
1385                 int result = update_flags::retry;
1386                 mapped_type pOld;
1387                 {
1388                     node_scoped_lock ln( m_Monitor, *pNode );
1389                     pOld = pNode->value( atomics::memory_order_relaxed );
1390                     if ( pNode->version( atomics::memory_order_acquire ) == nVersion && pOld ) {
1391                         pNode->m_pValue.store( nullptr, atomics::memory_order_relaxed );
1392                         result = update_flags::result_removed;
1393                     }
1394                 }
1395
1396                 if ( result == update_flags::result_removed ) {
1397                     --m_ItemCounter;
1398                     if ( func( pNode->m_key, pOld, disp ))  // calls pOld disposer inside
1399                         m_stat.onDisposeValue();
1400                     else
1401                         m_stat.onExtractValue();
1402                 }
1403
1404                 return result;
1405             }
1406         }
1407
1408         bool try_unlink_locked( node_type * pParent, node_type * pNode, rcu_disposer& disp )
1409         {
1410             // pParent and pNode must be locked
1411             assert( !pParent->is_unlinked(memory_model::memory_order_relaxed) );
1412
1413             node_type * pParentLeft = child( pParent, left_child );
1414             node_type * pParentRight = child( pParent, right_child );
1415             if ( pNode != pParentLeft && pNode != pParentRight ) {
1416                 // node is no longer a child of parent
1417                 return false;
1418             }
1419
1420             assert( !pNode->is_unlinked( memory_model::memory_order_relaxed ) );
1421             assert( pParent == parent( pNode ));
1422
1423             node_type * pLeft = child( pNode, left_child );
1424             node_type * pRight = child( pNode, right_child );
1425             if ( pLeft != nullptr && pRight != nullptr ) {
1426                 // splicing is no longer possible
1427                 return false;
1428             }
1429             node_type * pSplice = pLeft ? pLeft : pRight;
1430
1431             if ( pParentLeft == pNode )
1432                 pParent->m_pLeft.store( pSplice, memory_model::memory_order_relaxed );
1433             else
1434                 pParent->m_pRight.store( pSplice, memory_model::memory_order_relaxed );
1435
1436             if ( pSplice )
1437                 pSplice->m_pParent.store( pParent, memory_model::memory_order_release );
1438
1439             // Mark the node as unlinked
1440             pNode->version( node_type::unlinked, memory_model::memory_order_release );
1441
1442             // The value will be disposed by calling function
1443             pNode->m_pValue.store( nullptr, memory_model::memory_order_relaxed );
1444
1445             disp.dispose( pNode );
1446             m_stat.onDisposeNode();
1447
1448             return true;
1449         }
1450
1451         //@endcond
1452
1453     private: // rotations
1454         //@cond
1455         int estimate_node_condition( node_type * pNode )
1456         {
1457             node_type * pLeft = child( pNode, left_child );
1458             node_type * pRight = child( pNode, right_child );
1459
1460             if ( (pLeft == nullptr || pRight == nullptr) && !pNode->is_valued( memory_model::memory_order_relaxed ))
1461                 return unlink_required;
1462
1463             int h = height( pNode );
1464             int hL = height_null( pLeft );
1465             int hR = height_null( pRight );
1466
1467             int hNew = 1 + std::max( hL, hR );
1468             int nBalance = hL - hR;
1469
1470             if ( nBalance < -1 || nBalance > 1 )
1471                 return rebalance_required;
1472
1473             return h != hNew ? hNew : nothing_required;
1474         }
1475
1476         node_type * fix_height( node_type * pNode )
1477         {
1478             assert( pNode != nullptr );
1479             node_scoped_lock l( m_Monitor, *pNode );
1480             return fix_height_locked( pNode );
1481         }
1482
1483         node_type * fix_height_locked( node_type * pNode )
1484         {
1485             // pNode must be locked!!!
1486             int h = estimate_node_condition( pNode );
1487             switch ( h ) {
1488                 case rebalance_required:
1489                 case unlink_required:
1490                     return pNode;
1491                 case nothing_required:
1492                     return nullptr;
1493                 default:
1494                     set_height( pNode, h );
1495                     return parent( pNode );
1496             }
1497         }
1498
1499         void fix_height_and_rebalance( node_type * pNode, rcu_disposer& disp )
1500         {
1501             while ( pNode && parent( pNode )) {
1502                 int nCond = estimate_node_condition( pNode );
1503                 if ( nCond == nothing_required || pNode->is_unlinked( memory_model::memory_order_relaxed ) )
1504                     return;
1505
1506                 if ( nCond != unlink_required && nCond != rebalance_required )
1507                     pNode = fix_height( pNode );
1508                 else {
1509                     node_type * pParent = parent( pNode );
1510                     assert( pParent != nullptr );
1511                     {
1512                         node_scoped_lock lp( m_Monitor, *pParent );
1513                         if ( !pParent->is_unlinked( memory_model::memory_order_relaxed ) && parent( pNode ) == pParent ) {
1514                             node_scoped_lock ln( m_Monitor, *pNode );
1515                             pNode = rebalance_locked( pParent, pNode, disp );
1516                         }
1517                     }
1518                 }
1519             }
1520         }
1521
1522         node_type * rebalance_locked( node_type * pParent, node_type * pNode, rcu_disposer& disp )
1523         {
1524             // pParent and pNode should be locked.
1525             // Returns a damaged node, or nullptr if no more rebalancing is necessary
1526             assert( parent( pNode ) == pParent );
1527
1528             node_type * pLeft = child( pNode, left_child );
1529             node_type * pRight = child( pNode, right_child );
1530
1531             if ( (pLeft == nullptr || pRight == nullptr) && !pNode->is_valued( memory_model::memory_order_relaxed )) {
1532                 if ( try_unlink_locked( pParent, pNode, disp ))
1533                     return fix_height_locked( pParent );
1534                 else {
1535                     // retry needed for pNode
1536                     return pNode;
1537                 }
1538             }
1539
1540             assert( child( pParent, left_child ) == pNode || child( pParent, right_child ) == pNode );
1541
1542             int h = height( pNode );
1543             int hL = height_null( pLeft );
1544             int hR = height_null( pRight );
1545             int hNew = 1 + std::max( hL, hR );
1546             int balance = hL - hR;
1547
1548             if ( balance > 1 )
1549                 return rebalance_to_right_locked( pParent, pNode, pLeft, hR );
1550             else if ( balance < -1 )
1551                 return rebalance_to_left_locked( pParent, pNode, pRight, hL );
1552             else if ( hNew != h ) {
1553                 set_height( pNode, hNew );
1554
1555                 // pParent is already locked
1556                 return fix_height_locked( pParent );
1557             }
1558             else
1559                 return nullptr;
1560         }
1561
1562         node_type * rebalance_to_right_locked( node_type * pParent, node_type * pNode, node_type * pLeft, int hR )
1563         {
1564             assert( parent( pNode ) == pParent );
1565             assert( child( pParent, left_child ) == pNode || child( pParent, right_child ) == pNode );
1566
1567             // pParent and pNode is locked yet
1568             // pNode->pLeft is too large, we will rotate-right.
1569             // If pLeft->pRight is taller than pLeft->pLeft, then we will first rotate-left pLeft.
1570
1571             {
1572                 assert( pLeft != nullptr );
1573                 node_scoped_lock l( m_Monitor, *pLeft );
1574                 if ( pNode->m_pLeft.load( memory_model::memory_order_relaxed ) != pLeft )
1575                     return pNode; // retry for pNode
1576
1577                 int hL = height( pLeft );
1578                 if ( hL - hR <= 1 )
1579                     return pNode; // retry
1580
1581                 node_type * pLRight = child( pLeft, right_child );
1582                 int hLR = height_null( pLRight );
1583                 node_type * pLLeft = child( pLeft, left_child );
1584                 int hLL = height_null( pLLeft );
1585
1586                 if ( hLL > hLR ) {
1587                     // rotate right
1588                     return rotate_right_locked( pParent, pNode, pLeft, hR, hLL, pLRight, hLR );
1589                 }
1590                 else {
1591                     assert( pLRight != nullptr );
1592                     {
1593                         node_scoped_lock lr( m_Monitor, *pLRight );
1594                         if ( pLeft->m_pRight.load( memory_model::memory_order_relaxed ) != pLRight )
1595                             return pNode; // retry
1596
1597                         hLR = height( pLRight );
1598                         if ( hLL > hLR )
1599                             return rotate_right_locked( pParent, pNode, pLeft, hR, hLL, pLRight, hLR );
1600
1601                         int hLRL = height_null( child( pLRight, left_child ));
1602                         int balance = hLL - hLRL;
1603                         if ( balance >= -1 && balance <= 1 && !((hLL == 0 || hLRL == 0) && !pLeft->is_valued(memory_model::memory_order_relaxed))) {
1604                             // nParent.child.left won't be damaged after a double rotation
1605                             return rotate_right_over_left_locked( pParent, pNode, pLeft, hR, hLL, pLRight, hLRL );
1606                         }
1607                     }
1608
1609                     // focus on pLeft, if necessary pNode will be balanced later
1610                     return rebalance_to_left_locked( pNode, pLeft, pLRight, hLL );
1611                 }
1612             }
1613         }
1614
1615         node_type * rebalance_to_left_locked( node_type * pParent, node_type * pNode, node_type * pRight, int hL )
1616         {
1617             assert( parent( pNode ) == pParent );
1618             assert( child( pParent, left_child ) == pNode || child( pParent, right_child ) == pNode );
1619
1620             // pParent and pNode is locked yet
1621             {
1622                 assert( pRight != nullptr );
1623                 node_scoped_lock l( m_Monitor, *pRight );
1624                 if ( pNode->m_pRight.load( memory_model::memory_order_relaxed ) != pRight )
1625                     return pNode; // retry for pNode
1626
1627                 int hR = height( pRight );
1628                 if ( hL - hR >= -1 )
1629                     return pNode; // retry
1630
1631                 node_type * pRLeft = child( pRight, left_child );
1632                 int hRL = height_null( pRLeft );
1633                 node_type * pRRight = child( pRight, right_child );
1634                 int hRR = height_null( pRRight );
1635                 if ( hRR > hRL )
1636                     return rotate_left_locked( pParent, pNode, hL, pRight, pRLeft, hRL, hRR );
1637
1638                 {
1639                     assert( pRLeft != nullptr );
1640                     node_scoped_lock lrl( m_Monitor, *pRLeft );
1641                     if ( pRight->m_pLeft.load( memory_model::memory_order_relaxed ) != pRLeft )
1642                         return pNode; // retry
1643
1644                     hRL = height( pRLeft );
1645                     if ( hRR >= hRL )
1646                         return rotate_left_locked( pParent, pNode, hL, pRight, pRLeft, hRL, hRR );
1647
1648                     node_type * pRLRight = child( pRLeft, right_child );
1649                     int hRLR = height_null( pRLRight );
1650                     int balance = hRR - hRLR;
1651                     if ( balance >= -1 && balance <= 1 && !((hRR == 0 || hRLR == 0) && !pRight->is_valued( memory_model::memory_order_relaxed )))
1652                          return rotate_left_over_right_locked( pParent, pNode, hL, pRight, pRLeft, hRR, hRLR );
1653                 }
1654                 return rebalance_to_right_locked( pNode, pRight, pRLeft, hRR );
1655             }
1656         }
1657
1658         static void begin_change( node_type * pNode, version_type version )
1659         {
1660             pNode->version( version | node_type::shrinking, memory_model::memory_order_release );
1661         }
1662         static void end_change( node_type * pNode, version_type version )
1663         {
1664             // Clear shrinking and unlinked flags and increment version
1665             pNode->version( (version | node_type::version_flags) + 1, memory_model::memory_order_release );
1666         }
1667
1668         node_type * rotate_right_locked( node_type * pParent, node_type * pNode, node_type * pLeft, int hR, int hLL, node_type * pLRight, int hLR )
1669         {
1670             version_type nodeVersion = pNode->version( memory_model::memory_order_acquire );
1671             node_type * pParentLeft = child( pParent, left_child );
1672
1673             begin_change( pNode, nodeVersion );
1674
1675             pNode->m_pLeft.store( pLRight, memory_model::memory_order_relaxed );
1676             if ( pLRight != nullptr )
1677                 pLRight->m_pParent.store( pNode, memory_model::memory_order_relaxed  );
1678
1679             pLeft->m_pRight.store( pNode, memory_model::memory_order_relaxed );
1680             pNode->m_pParent.store( pLeft, memory_model::memory_order_relaxed );
1681
1682             if ( pParentLeft == pNode )
1683                 pParent->m_pLeft.store( pLeft, memory_model::memory_order_relaxed );
1684             else {
1685                 assert( pParent->m_pRight.load( memory_model::memory_order_relaxed ) == pNode );
1686                 pParent->m_pRight.store( pLeft, memory_model::memory_order_relaxed );
1687             }
1688             pLeft->m_pParent.store( pParent, memory_model::memory_order_relaxed );
1689
1690             // fix up heights links
1691             int hNode = 1 + std::max( hLR, hR );
1692             set_height( pNode, hNode );
1693             set_height( pLeft, 1 + std::max( hLL, hNode ));
1694
1695             end_change( pNode, nodeVersion );
1696             m_stat.onRotateRight();
1697
1698             // We have damaged pParent, pNode (now parent.child.right), and pLeft (now
1699             // parent.child).  pNode is the deepest.  Perform as many fixes as we can
1700             // with the locks we've got.
1701
1702             // We've already fixed the height for pNode, but it might still be outside
1703             // our allowable balance range.  In that case a simple fix_height_locked()
1704             // won't help.
1705             int nodeBalance = hLR - hR;
1706             if ( nodeBalance < -1 || nodeBalance > 1 ) {
1707                 // we need another rotation at pNode
1708                 return pNode;
1709             }
1710
1711             // we've fixed balance and height damage for pNode, now handle
1712             // extra-routing node damage
1713             if ( (pLRight == nullptr || hR == 0) && !pNode->is_valued(memory_model::memory_order_relaxed)) {
1714                 // we need to remove pNode and then repair
1715                 return pNode;
1716             }
1717
1718             // we've already fixed the height at pLeft, do we need a rotation here?
1719             int leftBalance = hLL - hNode;
1720             if ( leftBalance < -1 || leftBalance > 1 )
1721                 return pLeft;
1722
1723             // pLeft might also have routing node damage (if pLeft.left was null)
1724             if ( hLL == 0 && !pLeft->is_valued( memory_model::memory_order_relaxed ))
1725                 return pLeft;
1726
1727             // try to fix the parent height while we've still got the lock
1728             return fix_height_locked( pParent );
1729         }
1730
1731         node_type * rotate_left_locked( node_type * pParent, node_type * pNode, int hL, node_type * pRight, node_type * pRLeft, int hRL, int hRR )
1732         {
1733             version_type nodeVersion = pNode->version( memory_model::memory_order_acquire );
1734             node_type * pParentLeft = child( pParent, left_child );
1735
1736             begin_change( pNode, nodeVersion );
1737
1738             // fix up pNode links, careful to be compatible with concurrent traversal for all but pNode
1739             pNode->m_pRight.store( pRLeft, memory_model::memory_order_relaxed );
1740             if ( pRLeft != nullptr )
1741                 pRLeft->m_pParent.store( pNode, memory_model::memory_order_relaxed );
1742
1743             pRight->m_pLeft.store( pNode, memory_model::memory_order_relaxed );
1744             pNode->m_pParent.store( pRight, memory_model::memory_order_relaxed );
1745
1746             if ( pParentLeft == pNode )
1747                 pParent->m_pLeft.store( pRight, memory_model::memory_order_relaxed );
1748             else {
1749                 assert( pParent->m_pRight.load( memory_model::memory_order_relaxed ) == pNode );
1750                 pParent->m_pRight.store( pRight, memory_model::memory_order_relaxed );
1751             }
1752             pRight->m_pParent.store( pParent, memory_model::memory_order_relaxed );
1753
1754             // fix up heights
1755             int hNode = 1 + std::max( hL, hRL );
1756             set_height( pNode, hNode );
1757             set_height( pRight, 1 + std::max( hNode, hRR ));
1758
1759             end_change( pNode, nodeVersion );
1760             m_stat.onRotateLeft();
1761
1762             int nodeBalance = hRL - hL;
1763             if ( nodeBalance < -1 || nodeBalance > 1 )
1764                 return pNode;
1765
1766             if ( (pRLeft == nullptr || hL == 0) && !pNode->is_valued( memory_model::memory_order_relaxed ))
1767                 return pNode;
1768
1769             int rightBalance = hRR - hNode;
1770             if ( rightBalance < -1 || rightBalance > 1 )
1771                 return pRight;
1772
1773             if ( hRR == 0 && !pRight->is_valued( memory_model::memory_order_relaxed ))
1774                 return pRight;
1775
1776             return fix_height_locked( pParent );
1777         }
1778
1779         node_type * rotate_right_over_left_locked( node_type * pParent, node_type * pNode, node_type * pLeft, int hR, int hLL, node_type * pLRight, int hLRL )
1780         {
1781             version_type nodeVersion = pNode->version( memory_model::memory_order_acquire );
1782             version_type leftVersion = pLeft->version( memory_model::memory_order_acquire );
1783
1784             node_type * pPL = child( pParent, left_child );
1785             node_type * pLRL = child( pLRight, left_child );
1786             node_type * pLRR = child( pLRight, right_child );
1787             int hLRR = height_null( pLRR );
1788
1789             begin_change( pNode, nodeVersion );
1790             begin_change( pLeft, leftVersion );
1791
1792             // fix up pNode links, careful about the order!
1793             pNode->m_pLeft.store( pLRR, memory_model::memory_order_relaxed );
1794             if ( pLRR != nullptr )
1795                 pLRR->m_pParent.store( pNode, memory_model::memory_order_relaxed );
1796
1797             pLeft->m_pRight.store( pLRL, memory_model::memory_order_relaxed );
1798             if ( pLRL != nullptr )
1799                 pLRL->m_pParent.store( pLeft, memory_model::memory_order_relaxed );
1800
1801             pLRight->m_pLeft.store( pLeft, memory_model::memory_order_relaxed );
1802             pLeft->m_pParent.store( pLRight, memory_model::memory_order_relaxed );
1803             pLRight->m_pRight.store( pNode, memory_model::memory_order_relaxed );
1804             pNode->m_pParent.store( pLRight, memory_model::memory_order_relaxed );
1805
1806             if ( pPL == pNode )
1807                 pParent->m_pLeft.store( pLRight, memory_model::memory_order_relaxed );
1808             else {
1809                 assert( child( pParent, right_child ) == pNode );
1810                 pParent->m_pRight.store( pLRight, memory_model::memory_order_relaxed );
1811             }
1812             pLRight->m_pParent.store( pParent, memory_model::memory_order_relaxed );
1813
1814             // fix up heights
1815             int hNode = 1 + std::max( hLRR, hR );
1816             set_height( pNode, hNode );
1817             int hLeft = 1 + std::max( hLL, hLRL );
1818             set_height( pLeft, hLeft );
1819             set_height( pLRight, 1 + std::max( hLeft, hNode ));
1820
1821             end_change( pNode, nodeVersion );
1822             end_change( pLeft, leftVersion );
1823             m_stat.onRotateRightOverLeft();
1824
1825             // caller should have performed only a single rotation if pLeft was going
1826             // to end up damaged
1827             assert( hLL - hLRL <= 1 && hLRL - hLL <= 1 );
1828             assert( !((hLL == 0 || pLRL == nullptr) && !pLeft->is_valued( memory_model::memory_order_relaxed )));
1829
1830             // We have damaged pParent, pLR (now parent.child), and pNode (now
1831             // parent.child.right).  pNode is the deepest.  Perform as many fixes as we
1832             // can with the locks we've got.
1833
1834             // We've already fixed the height for pNode, but it might still be outside
1835             // our allowable balance range.  In that case a simple fix_height_locked()
1836             // won't help.
1837             int nodeBalance = hLRR - hR;
1838             if ( nodeBalance < -1 || nodeBalance > 1 ) {
1839                 // we need another rotation at pNode
1840                 return pNode;
1841             }
1842
1843             // pNode might also be damaged by being an unnecessary routing node
1844             if ( (pLRR == nullptr || hR == 0) && !pNode->is_valued( memory_model::memory_order_relaxed )) {
1845                 // repair involves splicing out pNode and maybe more rotations
1846                 return pNode;
1847             }
1848
1849             // we've already fixed the height at pLRight, do we need a rotation here?
1850             int balanceLR = hLeft - hNode;
1851             if ( balanceLR < -1 || balanceLR > 1 )
1852                 return pLRight;
1853
1854             // try to fix the parent height while we've still got the lock
1855             return fix_height_locked( pParent );
1856         }
1857
1858         node_type * rotate_left_over_right_locked( node_type * pParent, node_type * pNode, int hL, node_type * pRight, node_type * pRLeft, int hRR, int hRLR )
1859         {
1860             version_type nodeVersion = pNode->version( memory_model::memory_order_acquire );
1861             version_type rightVersion = pRight->version( memory_model::memory_order_acquire );
1862
1863             node_type * pPL = child( pParent, left_child );
1864             node_type * pRLL = child( pRLeft, left_child );
1865             node_type * pRLR = child( pRLeft, right_child );
1866             int hRLL = height_null( pRLL );
1867
1868             begin_change( pNode, nodeVersion );
1869             begin_change( pRight, rightVersion );
1870
1871             // fix up pNode links, careful about the order!
1872             pNode->m_pRight.store( pRLL, memory_model::memory_order_relaxed );
1873             if ( pRLL != nullptr )
1874                 pRLL->m_pParent.store( pNode, memory_model::memory_order_relaxed );
1875
1876             pRight->m_pLeft.store( pRLR, memory_model::memory_order_relaxed );
1877             if ( pRLR != nullptr )
1878                 pRLR->m_pParent.store( pRight, memory_model::memory_order_relaxed );
1879
1880             pRLeft->m_pRight.store( pRight, memory_model::memory_order_relaxed );
1881             pRight->m_pParent.store( pRLeft, memory_model::memory_order_relaxed );
1882             pRLeft->m_pLeft.store( pNode, memory_model::memory_order_relaxed );
1883             pNode->m_pParent.store( pRLeft, memory_model::memory_order_relaxed );
1884
1885             if ( pPL == pNode )
1886                 pParent->m_pLeft.store( pRLeft, memory_model::memory_order_relaxed );
1887             else {
1888                 assert( pParent->m_pRight.load( memory_model::memory_order_relaxed ) == pNode );
1889                 pParent->m_pRight.store( pRLeft, memory_model::memory_order_relaxed );
1890             }
1891             pRLeft->m_pParent.store( pParent, memory_model::memory_order_relaxed );
1892
1893             // fix up heights
1894             int hNode = 1 + std::max( hL, hRLL );
1895             set_height( pNode, hNode );
1896             int hRight = 1 + std::max( hRLR, hRR );
1897             set_height( pRight, hRight );
1898             set_height( pRLeft, 1 + std::max( hNode, hRight ));
1899
1900             end_change( pNode, nodeVersion );
1901             end_change( pRight, rightVersion );
1902             m_stat.onRotateLeftOverRight();
1903
1904             assert( hRR - hRLR <= 1 && hRLR - hRR <= 1 );
1905
1906             int nodeBalance = hRLL - hL;
1907             if ( nodeBalance < -1 || nodeBalance > 1 )
1908                 return pNode;
1909             if ( (pRLL == nullptr || hL == 0) && !pNode->is_valued( memory_model::memory_order_relaxed ))
1910                 return pNode;
1911
1912             int balRL = hRight - hNode;
1913             if ( balRL < -1 || balRL > 1 )
1914                 return pRLeft;
1915
1916             return fix_height_locked( pParent );
1917         }
1918
1919         //@endcond
1920     };
1921 }} // namespace cds::container
1922
1923 #endif // #ifndef CDSLIB_CONTAINER_IMPL_BRONSON_AVLTREE_MAP_RCU_H