cds/gc/hp.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_GC_HP_H
  32 #define CDSLIB_GC_HP_H
  33
  34 #include <cds/gc/impl/hp_decl.h>
  35 #include <cds/gc/impl/hp_impl.h>
  36 #include <cds/details/lib.h>
  37
  38 /**
  39     @page cds_garbage_collectors_comparison GC comparison
  40     @ingroup cds_garbage_collector
  41
  42     <table>
  43         <tr>
  44             <th>Feature</th>
  45             <th>%cds::gc::HP</th>
  46             <th>%cds::gc::DHP</th>
  47         </tr>
  48         <tr>
  49             <td>Max number of guarded (hazard) pointers per thread</td>
  50             <td>limited (specifies in GC object ctor)</td>
  51             <td>unlimited (dynamically allocated when needed)</td>
  52         </tr>
  53         <tr>
  54             <td>Max number of retired pointers<sup>1</sup></td>
  55             <td>bounded</td>
  56             <td>bounded</td>
  57         </tr>
  58         <tr>
  59             <td>Array of retired pointers</td>
  60             <td>preallocated for each thread, size is limited</td>
  61             <td>global for the entire process, unlimited (dynamically allocated when needed)</td>
  62         </tr>
  63     </table>
  64
  65     <sup>1</sup>Unbounded count of retired pointer means a possibility of memory exhaustion.
  66 */
  67
  68 namespace cds {
  69
  70     /// Different safe memory reclamation schemas (garbage collectors)
  71     /** @ingroup cds_garbage_collector
  72
  73         This namespace specifies different safe memory reclamation (SMR) algorithms.
  74         See \ref cds_garbage_collector "Garbage collectors"
  75     */
  76     namespace gc {
  77     } // namespace gc
  78
  79 } // namespace cds
  80
  81
  82 #endif  // #ifndef CDSLIB_GC_HP_H