cds/sync/monitor.h

   1 //$$CDS-header$$
   2
   3 #ifndef CDSLIB_SYNC_MONITOR_H
   4 #define CDSLIB_SYNC_MONITOR_H
   5
   6 #include <cds/details/defs.h>
   7
   8 namespace cds { namespace sync {
   9
  10     /**
  11         @page cds_sync_monitor Synchronization monitor
  12
  13         A <a href="http://en.wikipedia.org/wiki/Monitor_%28synchronization%29">monitor</a> is synchronization construct
  14         that allows threads to have both mutual exclusion and the ability to wait (block) for a certain condition to become true.
  15
  16         Some blocking data structure algoritms like the trees require per-node locking.
  17         For huge trees containing millions of nodes it can be very inefficient to inject
  18         the lock object into each node. Moreover, some operating systems may not support
  19         the millions of system objects like mutexes per user process.
  20
  21         The monitor strategy is intended to solve that problem.
  22         When the node should be locked, the monitor is called to allocate appropriate
  23         lock object for the node if it's needed, and to lock the node.
  24         The monitor strategy can significantly reduce the number of system objects
  25         required for the data structure.
  26
  27         <b>Implemetatios</b>
  28
  29         \p libcds contains several monitor implementations:
  30         - \p sync::injecting_monitor injects the lock object into each node.
  31             That mock monitor is designed for user-space locking primitive like
  32             \ref sync::spin_lock "spin-lock".
  33
  34         <b>How to use</b>
  35
  36         If you use a container from \p libcds that requires a monitor, you should just
  37         specify required monitor type in container's traits. Usually, the monitor
  38         is specified by \p traits::sync_monitor typedef, or by \p cds::opt::sync_monitor
  39         option for container's \p make_traits metafunction.
  40
  41         If you're developing a new container algorithm, you should know internal monitor
  42         interface:
  43         \code
  44         class Monitor {
  45         public:
  46             // Monitor's injection into the Node class
  47             template <typename Node>
  48             struct node_wrapper;
  49
  50             // Locks the node
  51             template <typename Node>
  52             void lock( Node& node );
  53
  54             // Unlocks the node
  55             template <typename Node>
  56             void unlock( Node& node );
  57
  58             // Scoped lock applyes RAII to Monitor
  59             template <typename Node>
  60             class scoped_lock
  61             {
  62             public:
  63                 // Locks node by monitor mon
  64                 scoped_lock( Monitor& mon, Node& node );
  65
  66                 // Unlocks the node locked by ctor
  67                 ~scoped_lock();
  68             };
  69         };
  70         \endcode
  71         The monitor should be a member of your container:
  72         \code
  73         template <typename GC, typename T, typename Traits>
  74         class my_container {
  75             // ...
  76             typedef typename Traits::sync_monitor   sync_monitor;
  77             sync_monitor m_Monitor;
  78             //...
  79         };
  80         \endcode
  81     */
  82
  83 }} // namespace cds::sync
  84
  85 #endif // #ifndef CDSLIB_SYNC_MONITOR_H
  86