Control.Concurrent.RCU.QSBR

Quiescent-State-Based Reclamation

Documentation

data SRef s a

Shared references

Instances

MonadRCU (SRef s) (RCU s)

MonadWriting (SRef s) (WritingRCU s)

MonadReading (SRef s) (WritingRCU s)

MonadReading (SRef s) (ReadingRCU s)

MonadNew (SRef s) (RCU s)

MonadNew (SRef s) (WritingRCU s)

MonadNew (SRef s) (ReadingRCU s)

Eq (SRef s a)

data RCU s a

This is an RCU computation. It can use forking and joining to form new threads, and then you can use reading and writing to run classic read-side and write-side RCU computations. Writers are serialized using an MVar, readers are able to proceed while writers are updating.

Instances

Monad (RCU s)

Functor (RCU s)

Applicative (RCU s)

MonadIO (RCU s)

MonadRCU (SRef s) (RCU s)

MonadNew (SRef s) (RCU s)

type Reading (RCU s) = ReadingRCU s

type Writing (RCU s) = WritingRCU s

type Thread (RCU s) = RCUThread s

runRCU :: (forall s. RCU s a) -> IO a

Run an RCU computation.

class Monad m => MonadNew s m | m -> s where

Minimal complete definition

Nothing

Methods

newSRef :: a -> m (s a)

Build a new shared reference

Instances

MonadNew s m => MonadNew s (IdentityT m)

MonadNew s m => MonadNew s (MaybeT m)

MonadNew s m => MonadNew s (ExceptT e m)

MonadNew s' m => MonadNew s' (StateT s m)

MonadNew s' m => MonadNew s' (StateT s m)

(MonadNew s m, Monoid w) => MonadNew s (WriterT w m)

(MonadNew s m, Monoid w) => MonadNew s (WriterT w m)

MonadNew s m => MonadNew s (ReaderT e m)

(MonadNew s' m, Monoid w) => MonadNew s' (RWST r w s m)

(MonadNew s' m, Monoid w) => MonadNew s' (RWST r w s m)

MonadNew (SRef s) (RCU s)

MonadNew (SRef s) (WritingRCU s)

MonadNew (SRef s) (ReadingRCU s)

class MonadNew s m => MonadReading s m | m -> s where

This is a read-side critical section

Minimal complete definition

Nothing

Methods

readSRef :: s a -> m a

Read a shared reference.

Instances

MonadReading s m => MonadReading s (IdentityT m)

MonadReading s m => MonadReading s (MaybeT m)

MonadReading s m => MonadReading s (ExceptT e m)

MonadReading s' m => MonadReading s' (StateT s m)

MonadReading s' m => MonadReading s' (StateT s m)

(MonadReading s m, Monoid w) => MonadReading s (WriterT w m)

(MonadReading s m, Monoid w) => MonadReading s (WriterT w m)

MonadReading s m => MonadReading s (ReaderT e m)

(MonadReading s' m, Monoid w) => MonadReading s' (RWST r w s m)

(MonadReading s' m, Monoid w) => MonadReading s' (RWST r w s m)

MonadReading (SRef s) (WritingRCU s)

MonadReading (SRef s) (ReadingRCU s)

class MonadReading s m => MonadWriting s m | m -> s where

This is a write-side critical section

Minimal complete definition

Nothing

Methods

writeSRef :: s a -> a -> m ()

Write to a shared reference.

synchronize :: m ()

Synchronize with other writers.

No other writer can straddle this time bound. It will either see writes from before, or writes after, but never some of both!

Instances

MonadWriting s m => MonadWriting s (MaybeT m)

MonadWriting s m => MonadWriting s (IdentityT m)

MonadWriting s m => MonadWriting s (ExceptT e m)

MonadWriting s' m => MonadWriting s' (StateT s m)

MonadWriting s' m => MonadWriting s' (StateT s m)

(MonadWriting s m, Monoid w) => MonadWriting s (WriterT w m)

(MonadWriting s m, Monoid w) => MonadWriting s (WriterT w m)

MonadWriting s m => MonadWriting s (ReaderT e m)

(MonadWriting s' m, Monoid w) => MonadWriting s' (RWST r w s m)

(MonadWriting s' m, Monoid w) => MonadWriting s' (RWST r w s m)

MonadWriting (SRef s) (WritingRCU s)

class (MonadReading s (Reading m), MonadWriting s (Writing m), MonadNew s m) => MonadRCU s m | m -> s where

This is the executor service that can fork, join and execute critical sections.

Associated Types

type Reading m :: * -> *

A read-side critical section

type Writing m :: * -> *

A write-side critical section

type Thread m :: * -> *

Threads we can fork and join

Methods

forking :: m a -> m (Thread m a)

Fork a thread

joining :: Thread m a -> m a

Join a thread

reading :: Reading m a -> m a

Run a read-side critical section

writing :: Writing m a -> m a

Run a write-side critical section

Instances

MonadRCU s m => MonadRCU s (MaybeT m)

MonadRCU s m => MonadRCU s (IdentityT m)

(MonadRCU s m, Monoid e) => MonadRCU s (WriterT e m)

(MonadRCU s m, Monoid e) => MonadRCU s (WriterT e m)

MonadRCU s m => MonadRCU s (ExceptT e m)

MonadRCU s m => MonadRCU s (ReaderT e m)

MonadRCU (SRef s) (RCU s)

Implementation Details

data ReadingRCU s a

This is the basic read-side critical section for an RCU computation

Instances

Monad (ReadingRCU s)

Functor (ReadingRCU s)

Applicative (ReadingRCU s)

Alternative (ReadingRCU s)

MonadPlus (ReadingRCU s)

MonadReading (SRef s) (ReadingRCU s)

MonadNew (SRef s) (ReadingRCU s)

data WritingRCU s a

This is the basic write-side critical section for an RCU computation

Instances

Monad (WritingRCU s)

Functor (WritingRCU s)

Applicative (WritingRCU s)

Alternative (WritingRCU s)

MonadPlus (WritingRCU s)

MonadWriting (SRef s) (WritingRCU s)

MonadReading (SRef s) (WritingRCU s)

MonadNew (SRef s) (WritingRCU s)

data RCUThread s a

This is a basic RCU thread. It may be embellished when running in a more exotic context.