GCC-4.8 workaround for passing parameter pack to a lambda

[libcds.git] / cds / gc / hp.h

diff --git a/cds/gc/hp.h b/cds/gc/hp.h
index 54618eab81ff0528e817a7fbbdd2d28a8916ab76..005e0d6b218ed79f16bbfd7aad242ff763f80478 100644 (file)
--- a/cds/gc/hp.h
+++ b/cds/gc/hp.h
@@ -1,10 +1,54 @@
 //$$CDS-header$$
 
-#ifndef __CDS_GC_HP_H
-#define __CDS_GC_HP_H
+#ifndef CDSLIB_GC_HP_H
+#define CDSLIB_GC_HP_H
 
-#include <cds/gc/hp/hp_decl.h>
-#include <cds/gc/hp/hp_impl.h>
+#include <cds/gc/impl/hp_decl.h>
+#include <cds/gc/impl/hp_impl.h>
 #include <cds/details/lib.h>
 
-#endif  // #ifndef __CDS_GC_HP_H
+/**
+    @page cds_garbage_collectors_comparison GC comparison
+    @ingroup cds_garbage_collector
+
+    <table>
+        <tr>
+            <th>Feature</th>
+            <th>%cds::gc::HP</th>
+            <th>%cds::gc::DHP</th>
+        </tr>
+        <tr>
+            <td>Max number of guarded (hazard) pointers per thread</td>
+            <td>limited (specifies in GC object ctor)</td>
+            <td>unlimited (dynamically allocated when needed)</td>
+        </tr>
+        <tr>
+            <td>Max number of retired pointers<sup>1</sup></td>
+            <td>bounded</td>
+            <td>bounded</td>
+        </tr>
+        <tr>
+            <td>Array of retired pointers</td>
+            <td>preallocated for each thread, size is limited</td>
+            <td>global for the entire process, unlimited (dynamically allocated when needed)</td>
+        </tr>
+    </table>
+
+    <sup>1</sup>Unbounded count of retired pointer means a possibility of memory exhaustion.
+*/
+
+namespace cds {
+
+    /// Different safe memory reclamation schemas (garbage collectors)
+    /** @ingroup cds_garbage_collector
+
+        This namespace specifies different safe memory reclamation (SMR) algorithms.
+        See \ref cds_garbage_collector "Garbage collectors"
+    */
+    namespace gc {
+    } // namespace gc
+
+} // namespace cds
+
+
+#endif  // #ifndef CDSLIB_GC_HP_H