cds/algo/flat_combining/defs.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-2017
   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_DEFS_H
  32 #define CDSLIB_ALGO_FLAT_COMBINING_DEFS_H
  33
  34 #include <cds/algo/atomic.h>
  35
  36
  37 namespace cds { namespace algo { namespace flat_combining {
  38
  39     /// Special values of \p publication_record::nRequest
  40     enum request_value
  41     {
  42         req_EmptyRecord,    ///< Publication record is empty
  43         req_Response,       ///< Operation is done
  44
  45         req_Operation       ///< First operation id for derived classes
  46     };
  47
  48     /// \p publication_record state
  49     enum record_state {
  50         inactive,       ///< Record is inactive
  51         active,         ///< Record is active
  52         removed         ///< Record should be removed
  53     };
  54
  55     /// Record of publication list
  56     /**
  57         Each data structure based on flat combining contains a class derived from \p %publication_record
  58     */
  59     struct publication_record {
  60         atomics::atomic<unsigned int>           nRequest;   ///< Request field (depends on data structure)
  61         atomics::atomic<unsigned int>           nState;     ///< Record state: inactive, active, removed
  62         atomics::atomic<unsigned int>           nAge;       ///< Age of the record
  63         atomics::atomic<publication_record *>   pNext;      ///< Next record in active publication list
  64         atomics::atomic<publication_record *>   pNextAllocated; ///< Next record in allocated publication list
  65
  66         /// Initializes publication record
  67         publication_record()
  68             : nRequest( req_EmptyRecord )
  69             , nState( inactive )
  70             , nAge( 0 )
  71             , pNext( nullptr )
  72             , pNextAllocated( nullptr )
  73         {}
  74
  75         /// Returns the value of \p nRequest field
  76         unsigned int op( atomics::memory_order mo = atomics::memory_order_relaxed ) const
  77         {
  78             return nRequest.load( mo );
  79         }
  80
  81         /// Checks if the operation is done
  82         bool is_done() const
  83         {
  84             return nRequest.load( atomics::memory_order_relaxed ) == req_Response;
  85         }
  86     };
  87
  88
  89 }}} // namespace cds::algo::flat_combining
  90
  91 #endif // CDSLIB_ALGO_FLAT_COMBINING_DEFS_H