cds/algo/flat_combining/kernel.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_ALGO_FLAT_COMBINING_KERNEL_H
  32 #define CDSLIB_ALGO_FLAT_COMBINING_KERNEL_H
  33
  34 #include <cds/algo/flat_combining/defs.h>
  35 #include <cds/algo/flat_combining/wait_strategy.h>
  36
  37 #include <cds/sync/spinlock.h>
  38 #include <cds/details/allocator.h>
  39 #include <cds/opt/options.h>
  40 #include <cds/algo/int_algo.h>
  41
  42 namespace cds { namespace algo {
  43
  44     /// @defgroup cds_flat_combining_intrusive Intrusive flat combining containers
  45     /// @defgroup cds_flat_combining_container Non-intrusive flat combining containers
  46
  47     /// Flat combining
  48     /**
  49         @anchor cds_flat_combining_description
  50         Flat combining (FC) technique is invented by Hendler, Incze, Shavit and Tzafrir in their paper
  51         [2010] <i>"Flat Combining and the Synchronization-Parallelism Tradeoff"</i>.
  52         The technique converts a sequential data structure to its concurrent implementation.
  53         A few structures are added to the sequential implementation: a <i>global lock</i>,
  54         a <i>count</i> of the number of combining passes, and a pointer to the <i>head</i>
  55         of a <i>publication list</i>. The publication list is a list of thread-local records
  56         of a size proportional to the number of threads that are concurrently accessing the shared object.
  57
  58         Each thread \p t accessing the structure to perform an invocation of some method \p m
  59         on the shared object executes the following sequence of steps:
  60         <ol>
  61         <li>Write the invocation opcode and parameters (if any) of the method \p m to be applied
  62         sequentially to the shared object in the <i>request</i> field of your thread local publication
  63         record (there is no need to use a load-store memory barrier). The <i>request</i> field will later
  64         be used to receive the response. If your thread local publication record is marked as active
  65         continue to step 2, otherwise continue to step 5.</li>
  66         <li>Check if the global lock is taken. If so (another thread is an active combiner), spin on the <i>request</i>
  67         field waiting for a response to the invocation (one can add a yield at this point to allow other threads
  68         on the same core to run). Once in a while while spinning check if the lock is still taken and that your
  69         record is active. If your record is inactive proceed to step 5. Once the response is available,
  70         reset the request field to null and return the response.</li>
  71         <li>If the lock is not taken, attempt to acquire it and become a combiner. If you fail,
  72         return to spinning in step 2.</li>
  73         <li>Otherwise, you hold the lock and are a combiner.
  74         <ul>
  75             <li>Increment the combining pass count by one.</li>
  76             <li>Execute a \p fc_apply() by traversing the publication list from the head,
  77             combining all nonnull method call invocations, setting the <i>age</i> of each of these records
  78             to the current <i>count</i>, applying the combined method calls to the structure D, and returning
  79             responses to all the invocations. This traversal is guaranteed to be wait-free.</li>
  80             <li>If the <i>count</i> is such that a cleanup needs to be performed, traverse the publication
  81             list from the <i>head</i>. Starting from the second item (we always leave the item pointed to
  82             by the head in the list), remove from the publication list all records whose <i>age</i> is
  83             much smaller than the current <i>count</i>. This is done by removing the node and marking it
  84             as inactive.</li>
  85             <li>Release the lock.</li>
  86         </ul>
  87         <li>If you have no thread local publication record allocate one, marked as active. If you already
  88         have one marked as inactive, mark it as active. Execute a store-load memory barrier. Proceed to insert
  89         the record into the list with a successful CAS to the <i>head</i>. Then proceed to step 1.</li>
  90         </ol>
  91
  92         As the test results show, the flat combining technique is suitable for non-intrusive containers
  93         like stack, queue, deque. For intrusive concurrent containers the flat combining demonstrates
  94         less impressive results.
  95
  96         \ref cds_flat_combining_container "List of FC-based containers" in libcds.
  97
  98         \ref cds_flat_combining_intrusive "List of intrusive FC-based containers" in libcds.
  99     */
 100     namespace flat_combining {
 101
 102         /// Flat combining internal statistics
 103         template <typename Counter = cds::atomicity::event_counter >
 104         struct stat
 105         {
 106             typedef Counter counter_type;   ///< Event counter type
 107
 108             counter_type    m_nOperationCount   ;   ///< How many operations have been performed
 109             counter_type    m_nCombiningCount   ;   ///< Combining call count
 110             counter_type    m_nCompactPublicationList; ///< Count of publication list compacting
 111             counter_type    m_nDeactivatePubRecord; ///< How many publication records were deactivated during compacting
 112             counter_type    m_nActivatePubRecord;   ///< Count of publication record activating
 113             counter_type    m_nPubRecordCreated ;   ///< Count of created publication records
 114             counter_type    m_nPubRecordDeleted ;   ///< Count of deleted publication records
 115             counter_type    m_nPassiveWaitCall;     ///< Count of passive waiting call (\p kernel::wait_for_combining())
 116             counter_type    m_nPassiveWaitIteration;///< Count of iteration inside passive waiting
 117             counter_type    m_nPassiveWaitWakeup;   ///< Count of forcing wake-up of passive wait cycle
 118             counter_type    m_nInvokeExclusive;     ///< Count of call \p kernel::invoke_exclusive()
 119             counter_type    m_nWakeupByNotifying;   ///< How many times the passive thread be waked up by a notification
 120             counter_type    m_nPassiveToCombiner;   ///< How many times the passive thread becomes the combiner
 121
 122             /// Returns current combining factor
 123             /**
 124                 Combining factor is how many operations perform in one combine pass:
 125                 <tt>combining_factor := m_nOperationCount / m_nCombiningCount</tt>
 126             */
 127             double combining_factor() const
 128             {
 129                 return m_nCombiningCount.get() ? double( m_nOperationCount.get()) / m_nCombiningCount.get() : 0.0;
 130             }
 131
 132             //@cond
 133             void    onOperation()               { ++m_nOperationCount;          }
 134             void    onCombining()               { ++m_nCombiningCount;          }
 135             void    onCompactPublicationList()  { ++m_nCompactPublicationList;  }
 136             void    onDeactivatePubRecord()     { ++m_nDeactivatePubRecord;     }
 137             void    onActivatePubRecord()       { ++m_nActivatePubRecord;       }
 138             void    onCreatePubRecord()         { ++m_nPubRecordCreated;        }
 139             void    onDeletePubRecord()         { ++m_nPubRecordDeleted;        }
 140             void    onPassiveWait()             { ++m_nPassiveWaitCall;         }
 141             void    onPassiveWaitIteration()    { ++m_nPassiveWaitIteration;    }
 142             void    onPassiveWaitWakeup()       { ++m_nPassiveWaitWakeup;       }
 143             void    onInvokeExclusive()         { ++m_nInvokeExclusive;         }
 144             void    onWakeupByNotifying()       { ++m_nWakeupByNotifying;       }
 145             void    onPassiveToCombiner()       { ++m_nPassiveToCombiner;       }
 146
 147             //@endcond
 148         };
 149
 150         /// Flat combining dummy internal statistics
 151         struct empty_stat
 152         {
 153             //@cond
 154             void    onOperation()               const {}
 155             void    onCombining()               const {}
 156             void    onCompactPublicationList()  const {}
 157             void    onDeactivatePubRecord()     const {}
 158             void    onActivatePubRecord()       const {}
 159             void    onCreatePubRecord()         const {}
 160             void    onDeletePubRecord()         const {}
 161             void    onPassiveWait()             const {}
 162             void    onPassiveWaitIteration()    const {}
 163             void    onPassiveWaitWakeup()       const {}
 164             void    onInvokeExclusive()         const {}
 165             void    onWakeupByNotifying()       const {}
 166             void    onPassiveToCombiner()       const {}
 167             //@endcond
 168         };
 169
 170         /// Type traits of \ref kernel class
 171         /**
 172             You can define different type traits for \ref kernel
 173             by specifying your struct based on \p %traits
 174             or by using \ref make_traits metafunction.
 175         */
 176         struct traits
 177         {
 178             typedef cds::sync::spin             lock_type;  ///< Lock type
 179             typedef cds::algo::flat_combining::wait_strategy::backoff< cds::backoff::delay_of<2>> wait_strategy; ///< Wait strategy
 180             typedef CDS_DEFAULT_ALLOCATOR       allocator;  ///< Allocator used for TLS data (allocating \p publication_record derivatives)
 181             typedef empty_stat                  stat;       ///< Internal statistics
 182             typedef opt::v::relaxed_ordering  memory_model; ///< /// C++ memory ordering model
 183         };
 184
 185         /// Metafunction converting option list to traits
 186         /**
 187             \p Options are:
 188             - \p opt::lock_type - mutex type, default is \p cds::sync::spin
 189             - \p opt::wait_strategy - wait strategy, see \p wait_strategy namespace, default is \p wait_strategy::backoff.
 190             - \p opt::allocator - allocator type, default is \ref CDS_DEFAULT_ALLOCATOR
 191             - \p opt::stat - internal statistics, possible type: \ref stat, \ref empty_stat (the default)
 192             - \p opt::memory_model - C++ memory ordering model.
 193                 List of all available memory ordering see \p opt::memory_model.
 194                 Default is \p cds::opt::v::relaxed_ordering
 195         */
 196         template <typename... Options>
 197         struct make_traits {
 198 #   ifdef CDS_DOXYGEN_INVOKED
 199             typedef implementation_defined type ;   ///< Metafunction result
 200 #   else
 201             typedef typename cds::opt::make_options<
 202                 typename cds::opt::find_type_traits< traits, Options... >::type
 203                 ,Options...
 204             >::type   type;
 205 #   endif
 206         };
 207
 208         /// The kernel of flat combining
 209         /**
 210             Template parameters:
 211             - \p PublicationRecord - a type derived from \ref publication_record
 212             - \p Traits - a type traits of flat combining, default is \p flat_combining::traits.
 213                 \ref make_traits metafunction can be used to create type traits
 214
 215             The kernel object should be a member of a container class. The container cooperates with flat combining
 216             kernel object. There are two ways to interact with the kernel:
 217             - One-by-one processing the active records of the publication list. This mode provides by \p combine() function:
 218               the container acquires its publication record by \p acquire_record(), fills its fields and calls
 219               \p combine() function of its kernel object. If the current thread becomes a combiner, the kernel
 220               calls \p fc_apply() function of the container for each active non-empty record. Then, the container
 221               should release its publication record by \p release_record(). Only one pass through the publication
 222               list is possible.
 223             - Batch processing - \p batch_combine() function. It this mode the container obtains access
 224               to entire publication list. This mode allows the container to perform an elimination, for example,
 225               the stack can collide \p push() and \p pop() requests. The sequence of invocations is the following:
 226               the container acquires its publication record by \p acquire_record(), fills its field and call
 227               \p batch_combine() function of its kernel object. If the current thread becomes a combiner,
 228               the kernel calls \p fc_process() function of the container passing two iterators pointing to
 229               the begin and the end of publication list (see \ref iterator class). The iterators allow
 230               multiple pass through active records of publication list. For each processed record the container
 231               should call \p operation_done() function. On the end, the container should release
 232               its record by \p release_record().
 233         */
 234         template <
 235             typename PublicationRecord
 236             ,typename Traits = traits
 237         >
 238         class kernel
 239         {
 240         public:
 241             typedef Traits   traits;                               ///< Type traits
 242             typedef typename traits::lock_type global_lock_type;   ///< Global lock type
 243             typedef typename traits::wait_strategy wait_strategy;  ///< Wait strategy type
 244             typedef typename traits::allocator allocator;          ///< Allocator type (used for allocating publication_record_type data)
 245             typedef typename traits::stat      stat;               ///< Internal statistics
 246             typedef typename traits::memory_model memory_model;    ///< C++ memory model
 247
 248             typedef typename wait_strategy::template make_publication_record<PublicationRecord>::type publication_record_type; ///< Publication record type
 249
 250         protected:
 251             //@cond
 252             typedef cds::details::Allocator< publication_record_type, allocator >   cxx11_allocator; ///< internal helper cds::details::Allocator
 253             typedef std::lock_guard<global_lock_type> lock_guard;
 254             //@endcond
 255
 256         protected:
 257             atomics::atomic<unsigned int>  m_nCount;   ///< Total count of combining passes. Used as an age.
 258             publication_record_type *   m_pHead;    ///< Head of publication list
 259             boost::thread_specific_ptr< publication_record_type > m_pThreadRec;   ///< Thread-local publication record
 260             mutable global_lock_type    m_Mutex;    ///< Global mutex
 261             mutable stat                m_Stat;     ///< Internal statistics
 262             unsigned int const          m_nCompactFactor;    ///< Publication list compacting factor (the list will be compacted through \p %m_nCompactFactor combining passes)
 263             unsigned int const          m_nCombinePassCount; ///< Number of combining passes
 264             wait_strategy               m_waitStrategy;      ///< Wait strategy
 265
 266         public:
 267             /// Initializes the object
 268             /**
 269                 Compact factor = 64
 270
 271                 Combiner pass count = 8
 272             */
 273             kernel()
 274                 : kernel( 64, 8 )
 275             {}
 276
 277             /// Initializes the object
 278             kernel(
 279                 unsigned int nCompactFactor  ///< Publication list compacting factor (the list will be compacted through \p nCompactFactor combining passes)
 280                 ,unsigned int nCombinePassCount ///< Number of combining passes for combiner thread
 281                 )
 282                 : m_nCount(0)
 283                 , m_pHead( nullptr )
 284                 , m_pThreadRec( tls_cleanup )
 285                 , m_nCompactFactor( (unsigned int)( cds::beans::ceil2( nCompactFactor ) - 1 ))   // binary mask
 286                 , m_nCombinePassCount( nCombinePassCount )
 287             {
 288                 init();
 289             }
 290
 291             /// Destroys the objects and mark all publication records as inactive
 292             ~kernel()
 293             {
 294                 // mark all publication record as detached
 295                 for ( publication_record* p = m_pHead; p; ) {
 296                     p->pOwner = nullptr;
 297
 298                     publication_record * pRec = p;
 299                     p = p->pNext.load( memory_model::memory_order_relaxed );
 300                     if ( pRec->nState.load( memory_model::memory_order_acquire ) == removed )
 301                         free_publication_record( static_cast<publication_record_type *>( pRec ));
 302                 }
 303             }
 304
 305             /// Gets publication list record for the current thread
 306             /**
 307                 If there is no publication record for the current thread
 308                 the function allocates it.
 309             */
 310             publication_record_type * acquire_record()
 311             {
 312                 publication_record_type * pRec = m_pThreadRec.get();
 313                 if ( !pRec ) {
 314                     // Allocate new publication record
 315                     pRec = cxx11_allocator().New();
 316                     pRec->pOwner = reinterpret_cast<void *>( this );
 317                     m_pThreadRec.reset( pRec );
 318                     m_Stat.onCreatePubRecord();
 319                 }
 320
 321                 if ( pRec->nState.load( memory_model::memory_order_acquire ) != active )
 322                     publish( pRec );
 323
 324                 assert( pRec->op() == req_EmptyRecord );
 325
 326                 return pRec;
 327             }
 328
 329             /// Marks publication record for the current thread as empty
 330             void release_record( publication_record_type * pRec )
 331             {
 332                 assert( pRec->is_done() );
 333                 pRec->nRequest.store( req_EmptyRecord, memory_model::memory_order_release );
 334             }
 335
 336             /// Trying to execute operation \p nOpId
 337             /**
 338                 \p pRec is the publication record acquiring by \ref acquire_record earlier.
 339                 \p owner is a container that is owner of flat combining kernel object.
 340                 As a result the current thread can become a combiner or can wait for
 341                 another combiner performs \p pRec operation.
 342
 343                 If the thread becomes a combiner, the kernel calls \p owner.fc_apply
 344                 for each active non-empty publication record.
 345             */
 346             template <class Container>
 347             void combine( unsigned int nOpId, publication_record_type * pRec, Container& owner )
 348             {
 349                 assert( nOpId >= req_Operation );
 350                 assert( pRec );
 351
 352                 pRec->nRequest.store( nOpId, memory_model::memory_order_release );
 353                 m_Stat.onOperation();
 354
 355                 try_combining( owner, pRec );
 356             }
 357
 358             /// Trying to execute operation \p nOpId in batch-combine mode
 359             /**
 360                 \p pRec is the publication record acquiring by \p acquire_record() earlier.
 361                 \p owner is a container that owns flat combining kernel object.
 362                 As a result the current thread can become a combiner or can wait for
 363                 another combiner performs \p pRec operation.
 364
 365                 If the thread becomes a combiner, the kernel calls \p owner.fc_process()
 366                 giving the container the full access over publication list. This function
 367                 is useful for an elimination technique if the container supports any kind of
 368                 that. The container can perform multiple pass through publication list.
 369
 370                 \p owner.fc_process() has two arguments - forward iterators on begin and end of
 371                 publication list, see \ref iterator class. For each processed record the container
 372                 should call \p operation_done() function to mark the record as processed.
 373
 374                 On the end of \p %batch_combine the \p combine() function is called
 375                 to process rest of publication records.
 376             */
 377             template <class Container>
 378             void batch_combine( unsigned int nOpId, publication_record_type* pRec, Container& owner )
 379             {
 380                 assert( nOpId >= req_Operation );
 381                 assert( pRec );
 382
 383                 pRec->nRequest.store( nOpId, memory_model::memory_order_release );
 384                 m_Stat.onOperation();
 385
 386                 try_batch_combining( owner, pRec );
 387             }
 388
 389             /// Invokes \p Func in exclusive mode
 390             /**
 391                 Some operation in flat combining containers should be called in exclusive mode
 392                 i.e the current thread should become the combiner to process the operation.
 393                 The typical example is \p empty() function.
 394
 395                 \p %invoke_exclusive() allows do that: the current thread becomes the combiner,
 396                 invokes \p f exclusively but unlike a typical usage the thread does not process any pending request.
 397                 Instead, after end of \p f call the current thread wakes up a pending thread if any.
 398             */
 399             template <typename Func>
 400             void invoke_exclusive( Func f )
 401             {
 402                 {
 403                     lock_guard l( m_Mutex );
 404                     f();
 405                 }
 406                 m_waitStrategy.wakeup( *this );
 407                 m_Stat.onInvokeExclusive();
 408             }
 409
 410             /// Marks \p rec as executed
 411             /**
 412                 This function should be called by container if \p batch_combine mode is used.
 413                 For usual combining (see \p combine() ) this function is excess.
 414             */
 415             void operation_done( publication_record& rec )
 416             {
 417                 rec.nRequest.store( req_Response, memory_model::memory_order_release );
 418                 m_waitStrategy.notify( *this, static_cast<publication_record_type&>( rec ));
 419             }
 420
 421             /// Internal statistics
 422             stat const& statistics() const
 423             {
 424                 return m_Stat;
 425             }
 426
 427             //@cond
 428             // For container classes based on flat combining
 429             stat& internal_statistics() const
 430             {
 431                 return m_Stat;
 432             }
 433             //@endcond
 434
 435             /// Returns the compact factor
 436             unsigned int compact_factor() const
 437             {
 438                 return m_nCompactFactor + 1;
 439             }
 440
 441             /// Returns number of combining passes for combiner thread
 442             unsigned int combine_pass_count() const
 443             {
 444                 return m_nCombinePassCount;
 445             }
 446
 447         public:
 448             /// Publication list iterator
 449             /**
 450                 Iterators are intended for batch processing by container's
 451                 \p fc_process function.
 452                 The iterator allows iterate through active publication list.
 453             */
 454             class iterator
 455             {
 456                 //@cond
 457                 friend class kernel;
 458                 publication_record_type * m_pRec;
 459                 //@endcond
 460
 461             protected:
 462                 //@cond
 463                 iterator( publication_record_type * pRec )
 464                     : m_pRec( pRec )
 465                 {
 466                     skip_inactive();
 467                 }
 468
 469                 void skip_inactive()
 470                 {
 471                     while ( m_pRec && (m_pRec->nState.load( memory_model::memory_order_acquire ) != active
 472                                     || m_pRec->op( memory_model::memory_order_relaxed) < req_Operation ))
 473                     {
 474                         m_pRec = static_cast<publication_record_type*>(m_pRec->pNext.load( memory_model::memory_order_acquire ));
 475                     }
 476                 }
 477                 //@endcond
 478
 479             public:
 480                 /// Initializes an empty iterator object
 481                 iterator()
 482                     : m_pRec( nullptr )
 483                 {}
 484
 485                 /// Copy ctor
 486                 iterator( iterator const& src )
 487                     : m_pRec( src.m_pRec )
 488                 {}
 489
 490                 /// Pre-increment
 491                 iterator& operator++()
 492                 {
 493                     assert( m_pRec );
 494                     m_pRec = static_cast<publication_record_type *>( m_pRec->pNext.load( memory_model::memory_order_acquire ));
 495                     skip_inactive();
 496                     return *this;
 497                 }
 498
 499                 /// Post-increment
 500                 iterator operator++(int)
 501                 {
 502                     assert( m_pRec );
 503                     iterator it(*this);
 504                     ++(*this);
 505                     return it;
 506                 }
 507
 508                 /// Dereference operator, can return \p nullptr
 509                 publication_record_type* operator ->()
 510                 {
 511                     return m_pRec;
 512                 }
 513
 514                 /// Dereference operator, the iterator should not be an end iterator
 515                 publication_record_type& operator*()
 516                 {
 517                     assert( m_pRec );
 518                     return *m_pRec;
 519                 }
 520
 521                 /// Iterator equality
 522                 friend bool operator==( iterator it1, iterator it2 )
 523                 {
 524                     return it1.m_pRec == it2.m_pRec;
 525                 }
 526
 527                 /// Iterator inequality
 528                 friend bool operator!=( iterator it1, iterator it2 )
 529                 {
 530                     return !( it1 == it2 );
 531                 }
 532             };
 533
 534             /// Returns an iterator to the first active publication record
 535             iterator begin()    { return iterator(m_pHead); }
 536
 537             /// Returns an iterator to the end of publication list. Should not be dereferenced.
 538             iterator end()      { return iterator(); }
 539
 540         public:
 541             /// Gets current value of \p rec.nRequest
 542             /**
 543                 This function is intended for invoking from a wait strategy
 544             */
 545             int get_operation( publication_record& rec )
 546             {
 547                 return rec.op( memory_model::memory_order_acquire );
 548             }
 549
 550             /// Wakes up any waiting thread
 551             /**
 552                 This function is intended for invoking from a wait strategy
 553             */
 554             void wakeup_any()
 555             {
 556                 publication_record* pRec = m_pHead;
 557                 while ( pRec ) {
 558                     if ( pRec->nState.load( memory_model::memory_order_acquire ) == active
 559                       && pRec->op( memory_model::memory_order_acquire ) >= req_Operation )
 560                     {
 561                         m_waitStrategy.notify( *this, static_cast<publication_record_type&>( *pRec ));
 562                         break;
 563                     }
 564                     pRec = pRec->pNext.load( memory_model::memory_order_acquire );
 565                 }
 566             }
 567
 568         private:
 569             //@cond
 570             static void tls_cleanup( publication_record_type* pRec )
 571             {
 572                 // Thread done
 573                 // pRec that is TLS data should be excluded from publication list
 574                 if ( pRec ) {
 575                     if ( pRec->pOwner ) {
 576                         // kernel is alive
 577                         pRec->nState.store( removed, memory_model::memory_order_release );
 578                     }
 579                     else {
 580                         // kernel already deleted
 581                         free_publication_record( pRec );
 582                     }
 583                 }
 584             }
 585
 586             static void free_publication_record( publication_record_type* pRec )
 587             {
 588                 cxx11_allocator().Delete( pRec );
 589             }
 590
 591             void init()
 592             {
 593                 assert( m_pThreadRec.get() == nullptr );
 594                 publication_record_type* pRec = cxx11_allocator().New();
 595                 m_pHead = pRec;
 596                 pRec->pOwner = this;
 597                 m_pThreadRec.reset( pRec );
 598                 m_Stat.onCreatePubRecord();
 599             }
 600
 601             void publish( publication_record_type* pRec )
 602             {
 603                 assert( pRec->nState.load( memory_model::memory_order_relaxed ) == inactive );
 604
 605                 pRec->nAge.store( m_nCount.load(memory_model::memory_order_relaxed), memory_model::memory_order_release );
 606                 pRec->nState.store( active, memory_model::memory_order_release );
 607
 608                 // Insert record to publication list
 609                 if ( m_pHead != static_cast<publication_record *>(pRec) ) {
 610                     publication_record * p = m_pHead->pNext.load(memory_model::memory_order_relaxed);
 611                     if ( p != static_cast<publication_record *>( pRec )) {
 612                         do {
 613                             pRec->pNext = p;
 614                             // Failed CAS changes p
 615                         } while ( !m_pHead->pNext.compare_exchange_weak( p, static_cast<publication_record *>(pRec),
 616                             memory_model::memory_order_release, atomics::memory_order_relaxed ));
 617                         m_Stat.onActivatePubRecord();
 618                     }
 619                 }
 620             }
 621
 622             void republish( publication_record_type* pRec )
 623             {
 624                 if ( pRec->nState.load( memory_model::memory_order_relaxed ) != active ) {
 625                     // The record has been excluded from publication list. Reinsert it
 626                     publish( pRec );
 627                 }
 628             }
 629
 630             template <class Container>
 631             void try_combining( Container& owner, publication_record_type* pRec )
 632             {
 633                 if ( m_Mutex.try_lock() ) {
 634                     // The thread becomes a combiner
 635                     lock_guard l( m_Mutex, std::adopt_lock_t() );
 636
 637                     // The record pRec can be excluded from publication list. Re-publish it
 638                     republish( pRec );
 639
 640                     combining( owner );
 641                     assert( pRec->op( memory_model::memory_order_relaxed ) == req_Response );
 642                 }
 643                 else {
 644                     // There is another combiner, wait while it executes our request
 645                     if ( !wait_for_combining( pRec ) ) {
 646                         // The thread becomes a combiner
 647                         lock_guard l( m_Mutex, std::adopt_lock_t() );
 648
 649                         // The record pRec can be excluded from publication list. Re-publish it
 650                         republish( pRec );
 651
 652                         combining( owner );
 653                         assert( pRec->op( memory_model::memory_order_relaxed ) == req_Response );
 654                     }
 655                 }
 656             }
 657
 658             template <class Container>
 659             void try_batch_combining( Container& owner, publication_record_type * pRec )
 660             {
 661                 if ( m_Mutex.try_lock() ) {
 662                     // The thread becomes a combiner
 663                     lock_guard l( m_Mutex, std::adopt_lock_t() );
 664
 665                     // The record pRec can be excluded from publication list. Re-publish it
 666                     republish( pRec );
 667
 668                     batch_combining( owner );
 669                     assert( pRec->op( memory_model::memory_order_relaxed ) == req_Response );
 670                 }
 671                 else {
 672                     // There is another combiner, wait while it executes our request
 673                     if ( !wait_for_combining( pRec ) ) {
 674                         // The thread becomes a combiner
 675                         lock_guard l( m_Mutex, std::adopt_lock_t() );
 676
 677                         // The record pRec can be excluded from publication list. Re-publish it
 678                         republish( pRec );
 679
 680                         batch_combining( owner );
 681                         assert( pRec->op( memory_model::memory_order_relaxed ) == req_Response );
 682                     }
 683                 }
 684             }
 685
 686             template <class Container>
 687             void combining( Container& owner )
 688             {
 689                 // The thread is a combiner
 690                 assert( !m_Mutex.try_lock() );
 691
 692                 unsigned int const nCurAge = m_nCount.fetch_add( 1, memory_model::memory_order_relaxed ) + 1;
 693
 694                 unsigned int nEmptyPass = 0;
 695                 for ( unsigned int nPass = 0; nPass < m_nCombinePassCount; ++nPass ) {
 696                     if ( !combining_pass( owner, nCurAge ))
 697                         if ( ++nEmptyPass > 2 )
 698                             break;
 699                 }
 700
 701                 m_Stat.onCombining();
 702                 if ( (nCurAge & m_nCompactFactor) == 0 )
 703                     compact_list( nCurAge );
 704             }
 705
 706             template <class Container>
 707             bool combining_pass( Container& owner, unsigned int nCurAge )
 708             {
 709                 publication_record* pPrev = nullptr;
 710                 publication_record* p = m_pHead;
 711                 bool bOpDone = false;
 712                 while ( p ) {
 713                     switch ( p->nState.load( memory_model::memory_order_acquire )) {
 714                         case active:
 715                             if ( p->op() >= req_Operation ) {
 716                                 p->nAge.store( nCurAge, memory_model::memory_order_release );
 717                                 owner.fc_apply( static_cast<publication_record_type*>(p) );
 718                                 operation_done( *p );
 719                                 bOpDone = true;
 720                             }
 721                             break;
 722                         case inactive:
 723                             // Only m_pHead can be inactive in the publication list
 724                             assert( p == m_pHead );
 725                             break;
 726                         case removed:
 727                             // The record should be removed
 728                             p = unlink_and_delete_record( pPrev, p );
 729                             continue;
 730                         default:
 731                             /// ??? That is impossible
 732                             assert(false);
 733                     }
 734                     pPrev = p;
 735                     p = p->pNext.load( memory_model::memory_order_acquire );
 736                 }
 737                 return bOpDone;
 738             }
 739
 740             template <class Container>
 741             void batch_combining( Container& owner )
 742             {
 743                 // The thread is a combiner
 744                 assert( !m_Mutex.try_lock() );
 745
 746                 unsigned int const nCurAge = m_nCount.fetch_add( 1, memory_model::memory_order_relaxed ) + 1;
 747
 748                 for ( unsigned int nPass = 0; nPass < m_nCombinePassCount; ++nPass )
 749                     owner.fc_process( begin(), end() );
 750
 751                 combining_pass( owner, nCurAge );
 752                 m_Stat.onCombining();
 753                 if ( (nCurAge & m_nCompactFactor) == 0 )
 754                     compact_list( nCurAge );
 755             }
 756
 757             bool wait_for_combining( publication_record_type * pRec )
 758             {
 759                 m_waitStrategy.prepare( *pRec );
 760                 m_Stat.onPassiveWait();
 761
 762                 while ( pRec->op( memory_model::memory_order_acquire ) != req_Response ) {
 763                     // The record can be excluded from publication list. Reinsert it
 764                     republish( pRec );
 765
 766                     m_Stat.onPassiveWaitIteration();
 767
 768                     // Wait while operation processing
 769                     if ( m_waitStrategy.wait( *this, *pRec ))
 770                         m_Stat.onWakeupByNotifying();
 771
 772                     if ( m_Mutex.try_lock() ) {
 773                         if ( pRec->op( memory_model::memory_order_acquire ) == req_Response ) {
 774                             // Operation is done
 775                             m_Mutex.unlock();
 776
 777                             // Wake up a pending threads
 778                             m_waitStrategy.wakeup( *this );
 779                             m_Stat.onPassiveWaitWakeup();
 780
 781                             break;
 782                         }
 783                         // The thread becomes a combiner
 784                         m_Stat.onPassiveToCombiner();
 785                         return false;
 786                     }
 787                 }
 788                 return true;
 789             }
 790
 791             void compact_list( unsigned int const nCurAge )
 792             {
 793                 // Thinning publication list
 794                 publication_record * pPrev = nullptr;
 795                 for ( publication_record * p = m_pHead; p; ) {
 796                     if ( p->nState.load( memory_model::memory_order_acquire ) == active
 797                       && p->nAge.load( memory_model::memory_order_acquire ) + m_nCompactFactor < nCurAge )
 798                     {
 799                         if ( pPrev ) {
 800                             publication_record * pNext = p->pNext.load( memory_model::memory_order_acquire );
 801                             if ( pPrev->pNext.compare_exchange_strong( p, pNext,
 802                                 memory_model::memory_order_release, atomics::memory_order_relaxed ))
 803                             {
 804                                 p->nState.store( inactive, memory_model::memory_order_release );
 805                                 p = pNext;
 806                                 m_Stat.onDeactivatePubRecord();
 807                                 continue;
 808                             }
 809                         }
 810                     }
 811                     pPrev = p;
 812                     p = p->pNext.load( memory_model::memory_order_acquire );
 813                 }
 814
 815                 m_Stat.onCompactPublicationList();
 816             }
 817
 818             publication_record * unlink_and_delete_record( publication_record * pPrev, publication_record * p )
 819             {
 820                 if ( pPrev ) {
 821                     publication_record * pNext = p->pNext.load( memory_model::memory_order_acquire );
 822                     if ( pPrev->pNext.compare_exchange_strong( p, pNext,
 823                         memory_model::memory_order_release, atomics::memory_order_relaxed ))
 824                     {
 825                         free_publication_record( static_cast<publication_record_type *>( p ));
 826                         m_Stat.onDeletePubRecord();
 827                     }
 828                     return pNext;
 829                 }
 830                 else {
 831                     m_pHead = static_cast<publication_record_type *>( p->pNext.load( memory_model::memory_order_acquire ));
 832                     free_publication_record( static_cast<publication_record_type *>( p ));
 833                     m_Stat.onDeletePubRecord();
 834                     return m_pHead;
 835                 }
 836             }
 837             //@endcond
 838         };
 839
 840         //@cond
 841         class container
 842         {
 843         public:
 844             template <typename PubRecord>
 845             void fc_apply( PubRecord * )
 846             {
 847                 assert( false );
 848             }
 849
 850             template <typename Iterator>
 851             void fc_process( Iterator, Iterator )
 852             {
 853                 assert( false );
 854             }
 855         };
 856         //@endcond
 857
 858     } // namespace flat_combining
 859 }} // namespace cds::algo
 860
 861 #endif // #ifndef CDSLIB_ALGO_FLAT_COMBINING_KERNEL_H