Control.Concurrent.RCU.QSBR

Quiescent-State-Based Reclamation

Documentation

data SRef s a

Shared references

Instances

MonadRCU (SRef s) (RCU s)

Associated Types

type Reading (RCU s :: * -> *) :: * -> *

type Writing (RCU s :: * -> *) :: * -> *

type Thread (RCU s :: * -> *) :: * -> *

Methods

forking :: RCU s a -> RCU s (Thread (RCU s) a)

joining :: Thread (RCU s) a -> RCU s a

reading :: Reading (RCU s) a -> RCU s a

writing :: Writing (RCU s) a -> RCU s a

MonadWriting (SRef s) (WritingRCU s)

Methods

writeSRef :: SRef s a -> a -> WritingRCU s ()

synchronize :: WritingRCU s ()

MonadReading (SRef s) (WritingRCU s)

Methods

readSRef :: SRef s a -> WritingRCU s a

MonadReading (SRef s) (ReadingRCU s)

Methods

readSRef :: SRef s a -> ReadingRCU s a

MonadNew (SRef s) (RCU s)

Methods

newSRef :: a -> RCU s (SRef s a)

MonadNew (SRef s) (WritingRCU s)

Methods

newSRef :: a -> WritingRCU s (SRef s a)

MonadNew (SRef s) (ReadingRCU s)

Methods

newSRef :: a -> ReadingRCU s (SRef s a)

Eq (SRef s a)

Methods

(==) :: SRef s a -> SRef s a -> Bool

(/=) :: SRef s a -> SRef s a -> Bool

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)

Methods

(>>=) :: RCU s a -> (a -> RCU s b) -> RCU s b

(>>) :: RCU s a -> RCU s b -> RCU s b

return :: a -> RCU s a

fail :: String -> RCU s a

Functor (RCU s)

Methods

fmap :: (a -> b) -> RCU s a -> RCU s b

(<$) :: a -> RCU s b -> RCU s a

Applicative (RCU s)

Methods

pure :: a -> RCU s a

(<*>) :: RCU s (a -> b) -> RCU s a -> RCU s b

(*>) :: RCU s a -> RCU s b -> RCU s b

(<*) :: RCU s a -> RCU s b -> RCU s a

MonadIO (RCU s)

Methods

liftIO :: IO a -> RCU s a

MonadRCU (SRef s) (RCU s)

Associated Types

type Reading (RCU s :: * -> *) :: * -> *

type Writing (RCU s :: * -> *) :: * -> *

type Thread (RCU s :: * -> *) :: * -> *

Methods

forking :: RCU s a -> RCU s (Thread (RCU s) a)

joining :: Thread (RCU s) a -> RCU s a

reading :: Reading (RCU s) a -> RCU s a

writing :: Writing (RCU s) a -> RCU s a

MonadNew (SRef s) (RCU s)

Methods

newSRef :: a -> RCU s (SRef s a)

type Reading (RCU s)

type Reading (RCU s) = ReadingRCU s

type Writing (RCU s)

type Writing (RCU s) = WritingRCU s

type Thread (RCU 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

Methods

newSRef :: a -> m (s a)

Build a new shared reference

newSRef :: (m ~ t n, MonadTrans t, MonadNew s n) => a -> m (s a)

Build a new shared reference

Instances

MonadNew s m => MonadNew s (MaybeT m)

Methods

newSRef :: a -> MaybeT m (s a)

MonadNew s m => MonadNew s (IdentityT * m)

Methods

newSRef :: a -> IdentityT * m (s a)

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

Methods

newSRef :: a -> ExceptT e m (s a)

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

Methods

newSRef :: a -> StateT s m (s' a)

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

Methods

newSRef :: a -> StateT s m (s' a)

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

Methods

newSRef :: a -> WriterT w m (s a)

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

Methods

newSRef :: a -> WriterT w m (s a)

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

Methods

newSRef :: a -> ReaderT * e m (s a)

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

Methods

newSRef :: a -> RWST r w s m (s' a)

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

Methods

newSRef :: a -> RWST r w s m (s' a)

MonadNew (SRef s) (RCU s)

Methods

newSRef :: a -> RCU s (SRef s a)

MonadNew (SRef s) (WritingRCU s)

Methods

newSRef :: a -> WritingRCU s (SRef s a)

MonadNew (SRef s) (ReadingRCU s)

Methods

newSRef :: a -> ReadingRCU s (SRef s a)

MonadNew (SRef s) (RCU s)

Methods

newSRef :: a -> RCU s (SRef s a)

MonadNew (SRef s) (WritingRCU s)

Methods

newSRef :: a -> WritingRCU s (SRef s a)

MonadNew (SRef s) (ReadingRCU s)

Methods

newSRef :: a -> ReadingRCU s (SRef s a)

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

This is a read-side critical section

Methods

readSRef :: s a -> m a

Read a shared reference.

readSRef :: (m ~ t n, MonadTrans t, MonadReading s n) => s a -> m a

Read a shared reference.

Instances

MonadReading s m => MonadReading s (MaybeT m)

Methods

readSRef :: s a -> MaybeT m a

MonadReading s m => MonadReading s (IdentityT * m)

Methods

readSRef :: s a -> IdentityT * m a

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

Methods

readSRef :: s a -> ExceptT e m a

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

Methods

readSRef :: s' a -> StateT s m a

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

Methods

readSRef :: s' a -> StateT s m a

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

Methods

readSRef :: s a -> WriterT w m a

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

Methods

readSRef :: s a -> WriterT w m a

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

Methods

readSRef :: s a -> ReaderT * e m a

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

Methods

readSRef :: s' a -> RWST r w s m a

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

Methods

readSRef :: s' a -> RWST r w s m a

MonadReading (SRef s) (WritingRCU s)

Methods

readSRef :: SRef s a -> WritingRCU s a

MonadReading (SRef s) (ReadingRCU s)

Methods

readSRef :: SRef s a -> ReadingRCU s a

MonadReading (SRef s) (WritingRCU s)

Methods

readSRef :: SRef s a -> WritingRCU s a

MonadReading (SRef s) (ReadingRCU s)

Methods

readSRef :: SRef s a -> ReadingRCU s a

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

This is a write-side critical section

Methods

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

Write to a shared reference.

writeSRef :: (m ~ t n, MonadTrans t, MonadWriting s n) => 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!

synchronize :: (m ~ t n, MonadTrans t, MonadWriting s n) => 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)

Methods

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

synchronize :: MaybeT m ()

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

Methods

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

synchronize :: ExceptT e m ()

MonadWriting s m => MonadWriting s (IdentityT * m)

Methods

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

synchronize :: IdentityT * m ()

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

Methods

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

synchronize :: StateT s m ()

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

Methods

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

synchronize :: StateT s m ()

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

Methods

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

synchronize :: WriterT w m ()

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

Methods

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

synchronize :: WriterT w m ()

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

Methods

writeSRef :: s a -> a -> ReaderT * e m ()

synchronize :: ReaderT * e m ()

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

Methods

writeSRef :: s' a -> a -> RWST r w s m ()

synchronize :: RWST r w s m ()

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

Methods

writeSRef :: s' a -> a -> RWST r w s m ()

synchronize :: RWST r w s m ()

MonadWriting (SRef s) (WritingRCU s)

Methods

writeSRef :: SRef s a -> a -> WritingRCU s ()

synchronize :: WritingRCU s ()

MonadWriting (SRef s) (WritingRCU s)

Methods

writeSRef :: SRef s a -> a -> WritingRCU s ()

synchronize :: 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.

Minimal complete definition

forking, joining, reading, writing

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)

Associated Types

type Reading (MaybeT m :: * -> *) :: * -> *

type Writing (MaybeT m :: * -> *) :: * -> *

type Thread (MaybeT m :: * -> *) :: * -> *

Methods

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

joining :: Thread (MaybeT m) a -> MaybeT m a

reading :: Reading (MaybeT m) a -> MaybeT m a

writing :: Writing (MaybeT m) a -> MaybeT m a

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

Associated Types

type Reading (WriterT e m :: * -> *) :: * -> *

type Writing (WriterT e m :: * -> *) :: * -> *

type Thread (WriterT e m :: * -> *) :: * -> *

Methods

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

joining :: Thread (WriterT e m) a -> WriterT e m a

reading :: Reading (WriterT e m) a -> WriterT e m a

writing :: Writing (WriterT e m) a -> WriterT e m a

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

Associated Types

type Reading (WriterT e m :: * -> *) :: * -> *

type Writing (WriterT e m :: * -> *) :: * -> *

type Thread (WriterT e m :: * -> *) :: * -> *

Methods

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

joining :: Thread (WriterT e m) a -> WriterT e m a

reading :: Reading (WriterT e m) a -> WriterT e m a

writing :: Writing (WriterT e m) a -> WriterT e m a

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

Associated Types

type Reading (ExceptT e m :: * -> *) :: * -> *

type Writing (ExceptT e m :: * -> *) :: * -> *

type Thread (ExceptT e m :: * -> *) :: * -> *

Methods

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

joining :: Thread (ExceptT e m) a -> ExceptT e m a

reading :: Reading (ExceptT e m) a -> ExceptT e m a

writing :: Writing (ExceptT e m) a -> ExceptT e m a

MonadRCU s m => MonadRCU s (IdentityT * m)

Associated Types

type Reading (IdentityT * m :: * -> *) :: * -> *

type Writing (IdentityT * m :: * -> *) :: * -> *

type Thread (IdentityT * m :: * -> *) :: * -> *

Methods

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

joining :: Thread (IdentityT * m) a -> IdentityT * m a

reading :: Reading (IdentityT * m) a -> IdentityT * m a

writing :: Writing (IdentityT * m) a -> IdentityT * m a

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

Associated Types

type Reading (ReaderT * e m :: * -> *) :: * -> *

type Writing (ReaderT * e m :: * -> *) :: * -> *

type Thread (ReaderT * e m :: * -> *) :: * -> *

Methods

forking :: ReaderT * e m a -> ReaderT * e m (Thread (ReaderT * e m) a)

joining :: Thread (ReaderT * e m) a -> ReaderT * e m a

reading :: Reading (ReaderT * e m) a -> ReaderT * e m a

writing :: Writing (ReaderT * e m) a -> ReaderT * e m a

MonadRCU (SRef s) (RCU s)

Associated Types

type Reading (RCU s :: * -> *) :: * -> *

type Writing (RCU s :: * -> *) :: * -> *

type Thread (RCU s :: * -> *) :: * -> *

Methods

forking :: RCU s a -> RCU s (Thread (RCU s) a)

joining :: Thread (RCU s) a -> RCU s a

reading :: Reading (RCU s) a -> RCU s a

writing :: Writing (RCU s) a -> RCU s a

MonadRCU (SRef s) (RCU s)

Associated Types

type Reading (RCU s :: * -> *) :: * -> *

type Writing (RCU s :: * -> *) :: * -> *

type Thread (RCU s :: * -> *) :: * -> *

Methods

forking :: RCU s a -> RCU s (Thread (RCU s) a)

joining :: Thread (RCU s) a -> RCU s a

reading :: Reading (RCU s) a -> RCU s a

writing :: Writing (RCU s) a -> RCU s a

Implementation Details

data ReadingRCU s a

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

Instances

Monad (ReadingRCU s)

Methods

(>>=) :: ReadingRCU s a -> (a -> ReadingRCU s b) -> ReadingRCU s b

(>>) :: ReadingRCU s a -> ReadingRCU s b -> ReadingRCU s b

return :: a -> ReadingRCU s a

fail :: String -> ReadingRCU s a

Functor (ReadingRCU s)

Methods

fmap :: (a -> b) -> ReadingRCU s a -> ReadingRCU s b

(<$) :: a -> ReadingRCU s b -> ReadingRCU s a

Applicative (ReadingRCU s)

Methods

pure :: a -> ReadingRCU s a

(<*>) :: ReadingRCU s (a -> b) -> ReadingRCU s a -> ReadingRCU s b

(*>) :: ReadingRCU s a -> ReadingRCU s b -> ReadingRCU s b

(<*) :: ReadingRCU s a -> ReadingRCU s b -> ReadingRCU s a

Alternative (ReadingRCU s)

Methods

empty :: ReadingRCU s a

(<|>) :: ReadingRCU s a -> ReadingRCU s a -> ReadingRCU s a

some :: ReadingRCU s a -> ReadingRCU s [a]

many :: ReadingRCU s a -> ReadingRCU s [a]

MonadPlus (ReadingRCU s)

Methods

mzero :: ReadingRCU s a

mplus :: ReadingRCU s a -> ReadingRCU s a -> ReadingRCU s a

MonadReading (SRef s) (ReadingRCU s)

Methods

readSRef :: SRef s a -> ReadingRCU s a

MonadNew (SRef s) (ReadingRCU s)

Methods

newSRef :: a -> ReadingRCU s (SRef s a)

data WritingRCU s a

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

Instances

Monad (WritingRCU s)

Methods

(>>=) :: WritingRCU s a -> (a -> WritingRCU s b) -> WritingRCU s b

(>>) :: WritingRCU s a -> WritingRCU s b -> WritingRCU s b

return :: a -> WritingRCU s a

fail :: String -> WritingRCU s a

Functor (WritingRCU s)

Methods

fmap :: (a -> b) -> WritingRCU s a -> WritingRCU s b

(<$) :: a -> WritingRCU s b -> WritingRCU s a

Applicative (WritingRCU s)

Methods

pure :: a -> WritingRCU s a

(<*>) :: WritingRCU s (a -> b) -> WritingRCU s a -> WritingRCU s b

(*>) :: WritingRCU s a -> WritingRCU s b -> WritingRCU s b

(<*) :: WritingRCU s a -> WritingRCU s b -> WritingRCU s a

Alternative (WritingRCU s)

Methods

empty :: WritingRCU s a

(<|>) :: WritingRCU s a -> WritingRCU s a -> WritingRCU s a

some :: WritingRCU s a -> WritingRCU s [a]

many :: WritingRCU s a -> WritingRCU s [a]

MonadPlus (WritingRCU s)

Methods

mzero :: WritingRCU s a

mplus :: WritingRCU s a -> WritingRCU s a -> WritingRCU s a

MonadWriting (SRef s) (WritingRCU s)

Methods

writeSRef :: SRef s a -> a -> WritingRCU s ()

synchronize :: WritingRCU s ()

MonadReading (SRef s) (WritingRCU s)

Methods

readSRef :: SRef s a -> WritingRCU s a

MonadNew (SRef s) (WritingRCU s)

Methods

newSRef :: a -> WritingRCU s (SRef s a)

data RCUThread s a

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