Reformatted SkipList, added memory barrier after tower initialization
[libcds.git] / cds / container / details / make_skip_list_set.h
1 /*
2     This file is a part of libcds - Concurrent Data Structures library
3
4     (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
5
6     Source code repo: http://github.com/khizmax/libcds/
7     Download: http://sourceforge.net/projects/libcds/files/
8
9     Redistribution and use in source and binary forms, with or without
10     modification, are permitted provided that the following conditions are met:
11
12     * Redistributions of source code must retain the above copyright notice, this
13       list of conditions and the following disclaimer.
14
15     * Redistributions in binary form must reproduce the above copyright notice,
16       this list of conditions and the following disclaimer in the documentation
17       and/or other materials provided with the distribution.
18
19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31 #ifndef CDSLIB_CONTAINER_DETAILS_MAKE_SKIP_LIST_SET_H
32 #define CDSLIB_CONTAINER_DETAILS_MAKE_SKIP_LIST_SET_H
33
34 #include <cds/container/details/skip_list_base.h>
35 #include <cds/details/binary_functor_wrapper.h>
36
37 //@cond
38 namespace cds { namespace container { namespace details {
39
40     template <typename GC, typename T, typename Traits>
41     struct make_skip_list_set
42     {
43         typedef GC      gc;
44         typedef T       value_type;
45         typedef Traits  traits;
46
47         typedef cds::intrusive::skip_list::node< gc >   intrusive_node_type;
48         struct node_type: public intrusive_node_type
49         {
50             typedef intrusive_node_type                     base_class;
51             typedef typename base_class::atomic_marked_ptr  atomic_marked_ptr;
52             typedef value_type                              stored_value_type;
53
54             value_type m_Value;
55             //atomic_marked_ptr m_arrTower[] ;  // allocated together with node_type in single memory block
56
57             template <typename Q>
58             node_type( unsigned int nHeight, atomic_marked_ptr * pTower, Q const& v )
59                 : m_Value(v)
60             {
61                 if ( nHeight > 1 ) {
62                     // TSan: make_tower() issues atomic_thread_fence( release )
63                     CDS_TSAN_ANNOTATE_IGNORE_WRITES_BEGIN;
64                     new (pTower) atomic_marked_ptr[ nHeight - 1 ];
65                     base_class::make_tower( nHeight, pTower );
66                     CDS_TSAN_ANNOTATE_IGNORE_WRITES_END;
67                 }
68             }
69
70             template <typename Q, typename... Args>
71             node_type( unsigned int nHeight, atomic_marked_ptr * pTower, Q&& q, Args&&... args )
72                 : m_Value( std::forward<Q>(q), std::forward<Args>(args)... )
73             {
74                 if ( nHeight > 1 ) {
75                     new (pTower) atomic_marked_ptr[ nHeight - 1 ];
76                     base_class::make_tower( nHeight, pTower );
77                 }
78             }
79
80         private:
81             node_type() ;   // no default ctor
82         };
83
84         typedef skip_list::details::node_allocator< node_type, traits> node_allocator;
85
86         struct node_deallocator {
87             void operator ()( node_type * pNode )
88             {
89                 node_allocator().Delete( pNode );
90             }
91         };
92
93         typedef skip_list::details::dummy_node_builder<intrusive_node_type> dummy_node_builder;
94
95         struct value_accessor
96         {
97             value_type const& operator()( node_type const& node ) const
98             {
99                 return node.m_Value;
100             }
101         };
102         typedef typename opt::details::make_comparator< value_type, traits >::type key_comparator;
103
104         template <typename Less>
105         struct less_wrapper {
106             typedef cds::details::compare_wrapper< node_type, cds::opt::details::make_comparator_from_less<Less>, value_accessor >    type;
107         };
108
109         class intrusive_traits: public cds::intrusive::skip_list::make_traits<
110             cds::opt::type_traits< traits >
111             ,cds::intrusive::opt::hook< intrusive::skip_list::base_hook< cds::opt::gc< gc > > >
112             ,cds::intrusive::opt::disposer< node_deallocator >
113             ,cds::intrusive::skip_list::internal_node_builder< dummy_node_builder >
114             ,cds::opt::compare< cds::details::compare_wrapper< node_type, key_comparator, value_accessor > >
115         >::type
116         {};
117
118         typedef cds::intrusive::SkipListSet< gc, node_type, intrusive_traits>   type;
119     };
120 }}} // namespace cds::container::details
121 //@endcond
122
123 #endif //#ifndef CDSLIB_CONTAINER_DETAILS_MAKE_SKIP_LIST_SET_H