X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=cds%2Fcontainer%2Fmichael_map_nogc.h;h=049307ff0af57888e47f3b724c6aa1d188d9868f;hb=c14ae188467d82f4b9227dcfc1052fcd113ad459;hp=68d0c575a008337eb1a0f9f8b51dcd0a5264d98c;hpb=4b5852dc7e861bb26c6af06c2a1e058f87f703ae;p=libcds.git diff --git a/cds/container/michael_map_nogc.h b/cds/container/michael_map_nogc.h index 68d0c575..049307ff 100644 --- a/cds/container/michael_map_nogc.h +++ b/cds/container/michael_map_nogc.h @@ -1,4 +1,32 @@ -//$$CDS-header$$ +/* + This file is a part of libcds - Concurrent Data Structures library + + (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016 + + Source code repo: http://github.com/khizmax/libcds/ + Download: http://sourceforge.net/projects/libcds/files/ + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE + FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +*/ #ifndef CDSLIB_CONTAINER_MICHAEL_MAP_NOGC_H #define CDSLIB_CONTAINER_MICHAEL_MAP_NOGC_H @@ -30,79 +58,73 @@ namespace cds { namespace container { { public: typedef cds::gc::nogc gc; ///< No garbage collector - typedef OrderedList bucket_type; ///< type of ordered list used as a bucket implementation + typedef OrderedList ordered_list; ///< type of ordered list used as a bucket implementation typedef Traits traits; ///< Map traits - typedef typename bucket_type::key_type key_type; ///< key type - typedef typename bucket_type::mapped_type mapped_type; ///< type of value to be stored in the map - typedef typename bucket_type::value_type value_type; ///< Pair used as the some functor's argument + typedef typename ordered_list::key_type key_type; ///< key type + typedef typename ordered_list::mapped_type mapped_type; ///< type of value to be stored in the map + typedef typename ordered_list::value_type value_type; ///< Pair used as the some functor's argument - typedef typename bucket_type::key_comparator key_comparator; ///< key comparing functor + typedef typename ordered_list::key_comparator key_comparator; ///< key comparing functor /// Hash functor for \ref key_type and all its derivatives that you use typedef typename cds::opt::v::hash_selector< typename traits::hash >::type hash; - typedef typename traits::item_counter item_counter; ///< Item counter type + typedef typename traits::item_counter item_counter; ///< Item counter type + typedef typename traits::allocator allocator; ///< Bucket table allocator - /// Bucket table allocator - typedef cds::details::Allocator< bucket_type, typename traits::allocator > bucket_table_allocator; +#ifdef CDS_DOXYGEN_INVOKED + typedef typename ordered_list::stat stat; ///< Internal statistics +#endif + + // GC and OrderedList::gc must be the same + static_assert(std::is_same::value, "GC and OrderedList::gc must be the same"); + + // atomicity::empty_item_counter is not allowed as a item counter + static_assert(!std::is_same::value, + "cds::atomicity::empty_item_counter is not allowed as a item counter"); protected: //@cond - typedef typename bucket_type::iterator bucket_iterator; - typedef typename bucket_type::const_iterator bucket_const_iterator; - //@endcond + typedef typename ordered_list::template select_stat_wrapper< typename ordered_list::stat > bucket_stat; - protected: - item_counter m_ItemCounter; ///< Item counter - hash m_HashFunctor; ///< Hash functor - bucket_type * m_Buckets; ///< bucket table + typedef typename ordered_list::template rebind_traits< + cds::opt::item_counter< cds::atomicity::empty_item_counter > + , cds::opt::stat< typename bucket_stat::wrapped_stat > + >::type internal_bucket_type; - private: + /// Bucket table allocator + typedef typename allocator::template rebind< internal_bucket_type >::other bucket_table_allocator; + + typedef typename internal_bucket_type::iterator bucket_iterator; + typedef typename internal_bucket_type::const_iterator bucket_const_iterator; + //@endcond + + public: //@cond - const size_t m_nHashBitmask; + typedef typename bucket_stat::stat stat; //@endcond protected: //@cond - /// Calculates hash value of \p key - size_t hash_value( key_type const & key ) const - { - return m_HashFunctor( key ) & m_nHashBitmask; - } - - /// Returns the bucket (ordered list) for \p key - bucket_type& bucket( key_type const& key ) - { - return m_Buckets[ hash_value( key ) ]; - } + const size_t m_nHashBitmask; + item_counter m_ItemCounter; ///< Item counter + hash m_HashFunctor; ///< Hash functor + internal_bucket_type* m_Buckets; ///< bucket table + stat m_Stat; ///< Internal statistics //@endcond protected: - /// Forward iterator - /** - \p IsConst - constness boolean flag - - The forward iterator for Michael's map is based on \p OrderedList forward iterator and has some features: - - it has no post-increment operator, only pre-increment - - it iterates items in unordered fashion - */ + //@cond template - class iterator_type: private cds::intrusive::michael_set::details::iterator< bucket_type, IsConst > + class iterator_type: private cds::intrusive::michael_set::details::iterator< internal_bucket_type, IsConst > { - //@cond - typedef cds::intrusive::michael_set::details::iterator< bucket_type, IsConst > base_class; + typedef cds::intrusive::michael_set::details::iterator< internal_bucket_type, IsConst > base_class; friend class MichaelHashMap; - //@endcond protected: - //@cond - //typedef typename base_class::bucket_type bucket_type; typedef typename base_class::bucket_ptr bucket_ptr; typedef typename base_class::list_iterator list_iterator; - //typedef typename bucket_type::key_type key_type; - //@endcond - public: /// Value pointer type (const for const_iterator) typedef typename cds::details::make_const_type::pointer value_ptr; @@ -115,11 +137,9 @@ namespace cds { namespace container { typedef typename cds::details::make_const_type::reference pair_ref; protected: - //@cond iterator_type( list_iterator const& it, bucket_ptr pFirst, bucket_ptr pLast ) : base_class( it, pFirst, pLast ) {} - //@endcond public: /// Default ctor @@ -179,10 +199,45 @@ namespace cds { namespace container { return !( *this == i ); } }; - + //@endcond public: + ///@name Forward iterators + //@{ /// Forward iterator + /** + The forward iterator for Michael's map is based on \p OrderedList forward iterator and has some features: + - it has no post-increment operator + - it iterates items in unordered fashion + + The iterator interface: + \code + class iterator { + public: + // Default constructor + iterator(); + + // Copy construtor + iterator( iterator const& src ); + + // Dereference operator + value_type * operator ->() const; + + // Dereference operator + value_type& operator *() const; + + // Preincrement operator + iterator& operator ++(); + + // Assignment operator + iterator& operator = (iterator const& src); + + // Equality operators + bool operator ==(iterator const& i ) const; + bool operator !=(iterator const& i ) const; + }; + \endcode + */ typedef iterator_type< false > iterator; /// Const forward iterator @@ -209,40 +264,29 @@ namespace cds { namespace container { } /// Returns a forward const iterator addressing the first element in a set - //@{ const_iterator begin() const { return get_const_begin(); } + + /// Returns a forward const iterator addressing the first element in a set const_iterator cbegin() const { return get_const_begin(); } - //@} /// Returns an const iterator that addresses the location succeeding the last element in a set - //@{ const_iterator end() const { return get_const_end(); } + + /// Returns an const iterator that addresses the location succeeding the last element in a set const_iterator cend() const { return get_const_end(); } - //@} - - private: - //@cond - const_iterator get_const_begin() const - { - return const_iterator( const_cast(m_Buckets[0]).begin(), m_Buckets, m_Buckets + bucket_count() ); - } - const_iterator get_const_end() const - { - return const_iterator( const_cast(m_Buckets[bucket_count() - 1]).end(), m_Buckets + bucket_count() - 1, m_Buckets + bucket_count() ); - } - //@endcond + //@} public: /// Initialize the map @@ -259,22 +303,19 @@ namespace cds { namespace container { size_t nMaxItemCount, ///< estimation of max item count in the hash set size_t nLoadFactor ///< load factor: estimation of max number of items in the bucket ) : m_nHashBitmask( michael_map::details::init_hash_bitmask( nMaxItemCount, nLoadFactor )) + , m_Buckets( bucket_table_allocator().allocate( bucket_count())) { - // GC and OrderedList::gc must be the same - static_assert( std::is_same::value, "GC and OrderedList::gc must be the same"); - - // atomicity::empty_item_counter is not allowed as a item counter - static_assert( !std::is_same::value, - "cds::atomicity::empty_item_counter is not allowed as a item counter"); - - m_Buckets = bucket_table_allocator().NewArray( bucket_count() ); + for ( auto it = m_Buckets, itEnd = m_Buckets + bucket_count(); it != itEnd; ++it ) + construct_bucket( it ); } /// Clears hash set and destroys it ~MichaelHashMap() { clear(); - bucket_table_allocator().Delete( m_Buckets, bucket_count() ); + for ( auto it = m_Buckets, itEnd = m_Buckets + bucket_count(); it != itEnd; ++it ) + it->~internal_bucket_type(); + bucket_table_allocator().deallocate( m_Buckets, bucket_count() ); } /// Inserts new node with key and default value @@ -291,7 +332,7 @@ namespace cds { namespace container { template iterator insert( const K& key ) { - bucket_type& refBucket = bucket( key ); + internal_bucket_type& refBucket = bucket( key ); bucket_iterator it = refBucket.insert( key ); if ( it != refBucket.end() ) { @@ -316,7 +357,7 @@ namespace cds { namespace container { template iterator insert( K const& key, V const& val ) { - bucket_type& refBucket = bucket( key ); + internal_bucket_type& refBucket = bucket( key ); bucket_iterator it = refBucket.insert( key, val ); if ( it != refBucket.end() ) { @@ -360,7 +401,7 @@ namespace cds { namespace container { template iterator insert_with( const K& key, Func func ) { - bucket_type& refBucket = bucket( key ); + internal_bucket_type& refBucket = bucket( key ); bucket_iterator it = refBucket.insert_with( key, func ); if ( it != refBucket.end() ) { @@ -380,7 +421,7 @@ namespace cds { namespace container { template iterator emplace( K&& key, Args&&... args ) { - bucket_type& refBucket = bucket( key ); + internal_bucket_type& refBucket = bucket( key ); bucket_iterator it = refBucket.emplace( std::forward(key), std::forward(args)... ); if ( it != refBucket.end() ) { @@ -397,7 +438,8 @@ namespace cds { namespace container { Otherwise, the function returns an iterator pointing to the item found. Returns std::pair where \p first is an iterator pointing to - item found or inserted (if inserting is not allowed and \p key is not found, the iterator will be \p end()), + item found or inserted (if inserting is not allowed and \p key is not found, the iterator will be \p end()), + \p second is true if new item has been added or \p false if the item already is in the map. @@ -408,7 +450,7 @@ namespace cds { namespace container { template std::pair update( const K& key, bool bAllowInsert = true ) { - bucket_type& refBucket = bucket( key ); + internal_bucket_type& refBucket = bucket( key ); std::pair ret = refBucket.update( key, bAllowInsert ); if ( ret.second ) @@ -434,7 +476,7 @@ namespace cds { namespace container { template iterator contains( K const& key ) { - bucket_type& refBucket = bucket( key ); + internal_bucket_type& refBucket = bucket( key ); bucket_iterator it = refBucket.contains( key ); if ( it != refBucket.end() ) @@ -456,11 +498,12 @@ namespace cds { namespace container { The function is an analog of contains( key ) but \p pred is used for key comparing. \p Less functor has the interface like \p std::less. \p pred must imply the same element order as the comparator used for building the map. + Hash functor specified in \p Traits should accept parameters of type \p K. */ template iterator contains( K const& key, Less pred ) { - bucket_type& refBucket = bucket( key ); + internal_bucket_type& refBucket = bucket( key ); bucket_iterator it = refBucket.contains( key, pred ); if ( it != refBucket.end() ) @@ -501,6 +544,12 @@ namespace cds { namespace container { return m_ItemCounter; } + /// Returns const reference to internal statistics + stat const& statistics() const + { + return m_Stat; + } + /// Returns the size of hash table /** Since \p %MichaelHashMap cannot dynamically extend the hash table size, @@ -511,6 +560,47 @@ namespace cds { namespace container { { return m_nHashBitmask + 1; } + + protected: + //@cond + /// Calculates hash value of \p key + template + size_t hash_value( K const & key ) const + { + return m_HashFunctor( key ) & m_nHashBitmask; + } + + /// Returns the bucket (ordered list) for \p key + template + internal_bucket_type& bucket( K const& key ) + { + return m_Buckets[hash_value( key )]; + } + //@endcond + + private: + //@cond + const_iterator get_const_begin() const + { + return const_iterator( const_cast(m_Buckets[0]).begin(), m_Buckets, m_Buckets + bucket_count() ); + } + const_iterator get_const_end() const + { + return const_iterator( const_cast(m_Buckets[bucket_count() - 1]).end(), m_Buckets + bucket_count() - 1, m_Buckets + bucket_count() ); + } + + template + typename std::enable_if< Stat::empty >::type construct_bucket( internal_bucket_type* bucket ) + { + new (bucket) internal_bucket_type; + } + + template + typename std::enable_if< !Stat::empty >::type construct_bucket( internal_bucket_type* bucket ) + { + new (bucket) internal_bucket_type( m_Stat ); + } + //@endcond }; }} // namespace cds::container