Move libcds 1.6.0 from SVN

[libcds.git] / cds / threading / model.h

diff --git a/cds/threading/model.h b/cds/threading/model.h
new file mode 100644 (file)
index 0000000..620654a
--- /dev/null
+++ b/cds/threading/model.h
@@ -0,0 +1,99 @@
+//$$CDS-header$$
+
+#ifndef __CDS_THREADING_MODEL_H
+#define __CDS_THREADING_MODEL_H
+
+#include <cds/threading/details/_common.h>
+#include <cds/user_setup/threading.h>
+#include <cds/threading/details/auto_detect.h>
+
+namespace cds { namespace threading {
+
+    /// Returns thread specific data of \p GC garbage collector
+    template <class GC> typename GC::thread_gc_impl&  getGC();
+
+    /// Returns RCU thread specific data (thread GC) for current thread
+    /**
+        Template argument \p RCUtag is one of \ref cds_urcu_tags "RCU tags"
+    */
+    template <typename RCUtag> cds::urcu::details::thread_data<RCUtag> * getRCU();
+
+    /// Get cds::gc::HP thread GC implementation for current thread
+    /**
+        The object returned may be uninitialized if you did not call attachThread in the beginning of thread execution
+        or if you did not use cds::gc::HP.
+        To initialize cds::gc::HP GC you must constuct cds::gc::HP object in the beginning of your application,
+        see \ref cds_how_to_use "How to use libcds"
+    */
+    template <>
+    inline cds::gc::HP::thread_gc_impl&   getGC<cds::gc::HP>()
+    {
+        return Manager::getHZPGC();
+    }
+
+    /// Get cds::gc::HRC thread GC implementation for current thread
+    /**
+        The object returned may be uninitialized if you did not call attachThread in the beginning of thread execution
+        or if you did not use cds::gc::HRC.
+        To initialize cds::gc::HRC GC you must constuct cds::gc::HRC object in the beginning of your application,
+        see \ref cds_how_to_use "How to use libcds"
+    */
+    template <>
+    inline cds::gc::HRC::thread_gc_impl&   getGC<cds::gc::HRC>()
+    {
+        return Manager::getHRCGC();
+    }
+
+    /// Get cds::gc::PTB thread GC implementation for current thread
+    /**
+        The object returned may be uninitialized if you did not call attachThread in the beginning of thread execution
+        or if you did not use cds::gc::PTB.
+        To initialize cds::gc::PTB GC you must constuct cds::gc::PTB object in the beginning of your application,
+        see \ref cds_how_to_use "How to use libcds"
+    */
+    template <>
+    inline cds::gc::PTB::thread_gc_impl&   getGC<cds::gc::PTB>()
+    {
+        return Manager::getPTBGC();
+    }
+
+    //@cond
+    template<>
+    inline cds::urcu::details::thread_data<cds::urcu::general_instant_tag> * getRCU<cds::urcu::general_instant_tag>()
+    {
+        return Manager::thread_data()->m_pGPIRCU;
+    }
+    template<>
+    inline cds::urcu::details::thread_data<cds::urcu::general_buffered_tag> * getRCU<cds::urcu::general_buffered_tag>()
+    {
+        return Manager::thread_data()->m_pGPBRCU;
+    }
+    template<>
+    inline cds::urcu::details::thread_data<cds::urcu::general_threaded_tag> * getRCU<cds::urcu::general_threaded_tag>()
+    {
+        return Manager::thread_data()->m_pGPTRCU;
+    }
+#ifdef CDS_URCU_SIGNAL_HANDLING_ENABLED
+    template<>
+    inline cds::urcu::details::thread_data<cds::urcu::signal_buffered_tag> * getRCU<cds::urcu::signal_buffered_tag>()
+    {
+        ThreadData * p = Manager::thread_data();
+        return p ? p->m_pSHBRCU : NULL;
+    }
+    template<>
+    inline cds::urcu::details::thread_data<cds::urcu::signal_threaded_tag> * getRCU<cds::urcu::signal_threaded_tag>()
+    {
+        ThreadData * p = Manager::thread_data();
+        return p ? p->m_pSHTRCU : NULL;
+    }
+#endif
+
+    static inline cds::algo::elimination::record& elimination_record()
+    {
+        return Manager::thread_data()->m_EliminationRec;
+    }
+    //@endcond
+
+}} // namespace cds::threading
+
+#endif // #ifndef __CDS_THREADING_MODEL_H