Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.Util.MonadSTM.NormalForm

Contents

Temporary

Synopsis

module Control.Concurrent.Class.MonadSTM.TQueue
module Control.Concurrent.Class.MonadSTM.TBQueue
data StrictSVar m a = StrictSVar {
- invariant ∷ !(a → Maybe String)
- tmvar ∷ !(TMVar m a)
- tvar ∷ !(TVar m a)
}
castStrictSVar ∷ (TMVar m ~ TMVar n, TVar m ~ TVar n) ⇒ StrictSVar m a → StrictSVar n a
isEmptySVar ∷ MonadSTM m ⇒ StrictSVar m a → m Bool
modifySVar ∷ (MonadSTM m, MonadCatch m, HasCallStack) ⇒ StrictSVar m a → (a → m (a, b)) → m b
modifySVar_ ∷ (MonadSTM m, MonadCatch m, HasCallStack) ⇒ StrictSVar m a → (a → m a) → m ()
putSVar ∷ (MonadSTM m, HasCallStack) ⇒ StrictSVar m a → a → m ()
readSVar ∷ MonadSTM m ⇒ StrictSVar m a → m a
readSVarSTM ∷ MonadSTM m ⇒ StrictSVar m a → STM m a
swapSVar ∷ (MonadSTM m, HasCallStack) ⇒ StrictSVar m a → a → m a
takeSVar ∷ MonadSTM m ⇒ StrictSVar m a → m a
tryPutSVar ∷ (MonadSTM m, HasCallStack) ⇒ StrictSVar m a → a → m Bool
tryReadSVar ∷ MonadSTM m ⇒ StrictSVar m a → m (Maybe a)
tryTakeSVar ∷ MonadSTM m ⇒ StrictSVar m a → m (Maybe a)
updateSVar ∷ (MonadSTM m, HasCallStack) ⇒ StrictSVar m a → (a → (a, b)) → m b
updateSVar_ ∷ (MonadSTM m, HasCallStack) ⇒ StrictSVar m a → (a → a) → m ()
class (Monad m, Monad (STM m)) ⇒ MonadSTM (m ∷ Type → Type) where
- type STM (m ∷ Type → Type) = (stm ∷ Type → Type) | stm → m
- atomically ∷ HasCallStack ⇒ STM m a → m a
- retry ∷ STM m a
- orElse ∷ STM m a → STM m a → STM m a
- check ∷ Bool → STM m ()
type family STM (m ∷ Type → Type) = (stm ∷ Type → Type) | stm → m
class MonadInspectSTM m ⇒ MonadTraceSTM (m ∷ Type → Type) where
- traceTMVar ∷ proxy m → TMVar m a → (Maybe (Maybe a) → Maybe a → InspectMonad m TraceValue) → STM m ()
- traceTQueue ∷ proxy m → TQueue m a → (Maybe [a] → [a] → InspectMonad m TraceValue) → STM m ()
- traceTBQueue ∷ proxy m → TBQueue m a → (Maybe [a] → [a] → InspectMonad m TraceValue) → STM m ()
- traceTSem ∷ proxy m → TSem m → (Maybe Integer → Integer → InspectMonad m TraceValue) → STM m ()
- traceTMVarIO ∷ TMVar m a → (Maybe (Maybe a) → Maybe a → InspectMonad m TraceValue) → m ()
- traceTQueueIO ∷ TQueue m a → (Maybe [a] → [a] → InspectMonad m TraceValue) → m ()
- traceTBQueueIO ∷ TBQueue m a → (Maybe [a] → [a] → InspectMonad m TraceValue) → m ()
- traceTSemIO ∷ TSem m → (Maybe Integer → Integer → InspectMonad m TraceValue) → m ()
data TraceValue where
- TraceValue ∷ ∀ tr. Typeable tr ⇒ {..} → TraceValue
- pattern DontTrace ∷ TraceValue
- pattern TraceString ∷ String → TraceValue
- pattern TraceDynamic ∷ () ⇒ Typeable tr ⇒ tr → TraceValue
class (MonadSTM m, Monad (InspectMonad m)) ⇒ MonadInspectSTM (m ∷ Type → Type) where
- type InspectMonad (m ∷ Type → Type) ∷ Type → Type
- inspectTVar ∷ proxy m → TVar m a → InspectMonad m a
- inspectTMVar ∷ proxy m → TMVar m a → InspectMonad m (Maybe a)
type family InspectMonad (m ∷ Type → Type) ∷ Type → Type
class MonadSTM m ⇒ MonadLabelledSTM (m ∷ Type → Type)
data StrictTMVar (m ∷ Type → Type) a
type LazyTMVar (m ∷ Type → Type) = TMVar m
throwSTM ∷ ∀ (m ∷ Type → Type) e a. (MonadSTM m, MonadThrow (STM m), Exception e) ⇒ e → STM m a
labelTMVar ∷ ∀ (m ∷ Type → Type) a. MonadLabelledSTM m ⇒ StrictTMVar m a → String → STM m ()
labelTMVarIO ∷ MonadLabelledSTM m ⇒ StrictTMVar m a → String → m ()
newEmptyTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ STM m (StrictTMVar m a)
takeTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → STM m a
tryTakeTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → STM m (Maybe a)
putTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → a → STM m ()
tryPutTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → a → STM m Bool
readTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → STM m a
tryReadTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → STM m (Maybe a)
swapTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → a → STM m a
writeTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → a → STM m ()
isEmptyTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → STM m Bool
newEmptyTMVarIO ∷ MonadSTM m ⇒ m (StrictTMVar m a)
fromLazyTMVar ∷ ∀ (m ∷ Type → Type) a. LazyTMVar m a → StrictTMVar m a
castStrictTMVar ∷ ∀ (m ∷ Type → Type) (n ∷ Type → Type) a. LazyTMVar m ~ LazyTMVar n ⇒ StrictTMVar m a → StrictTMVar n a
newEmptySVar ∷ (MonadSTM m, NoThunks a) ⇒ a → m (StrictSVar m a)
newSVar ∷ (MonadSTM m, HasCallStack, NoThunks a) ⇒ a → m (StrictSVar m a)
uncheckedNewEmptySVar ∷ MonadSTM m ⇒ a → m (StrictSVar m a)
uncheckedNewSVar ∷ MonadSTM m ⇒ a → m (StrictSVar m a)

Documentation

module Control.Concurrent.Class.MonadSTM.TQueue

module Control.Concurrent.Class.MonadSTM.TBQueue

data StrictSVar m a Source #

Strict SVar (modelled using a lazy TMVar under the hood)

The StrictSVar API is slightly stronger than the usual SVar one, as we offer a primitive to read the value of the SVar even if it is empty (in which case we will return the oldest known stale one). See readSVarSTM.

There is a weaker invariant for a StrictSVar than for a StrictTVar: although all functions that modify the StrictSVar check the invariant, we do not guarantee that the value inside the StrictSVar always satisfies the invariant. Instead, we do guarantee that if the StrictSVar is updated with a value that does not satisfy the invariant, an exception is thrown. The reason for this weaker guarantee is that leaving an SVar empty can lead to very hard to debug "blocked indefinitely" problems.

This is also the reason we do not offer support for an invariant in StrictTMVar: if we throw an exception from an STM transaction, the STM transaction is not executed, and so we would not even be able to provide the weaker guarantee that we provide for StrictSVar.

Constructors

StrictSVar

Fields

invariant ∷ !(a → Maybe String)
Invariant checked whenever updating the StrictSVar.
tmvar ∷ !(TMVar m a)
The main TMVar supporting this StrictSVar
tvar ∷ !(TVar m a)
TVar for supporting readSVarSTM
This TVar is always kept up to date with the TMVar, but holds on the old value of the TMVar when it is empty. This is very useful to support single writer/many reader scenarios.
NOTE: We should always update the tmvar before the tvar so that if the update to the tmvar fails, the 'tvar is left unchanged.

Instances

Instances details

NoThunks a ⇒ NoThunks (StrictSVar IO a) Source #
Instance details Defined in Ouroboros.Consensus.Util.MonadSTM.StrictSVar Methods noThunks ∷ Context → StrictSVar IO a → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → StrictSVar IO a → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (StrictSVar IO a) → String Source #
NoThunks (StrictSVar m a) ⇒ NoThunks (StrictSVar (WithEarlyExit m) a) Source #
Instance details Defined in Ouroboros.Consensus.Util.EarlyExit Methods noThunks ∷ Context → StrictSVar (WithEarlyExit m) a → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → StrictSVar (WithEarlyExit m) a → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (StrictSVar (WithEarlyExit m) a) → String Source #

castStrictSVar ∷ (TMVar m ~ TMVar n, TVar m ~ TVar n) ⇒ StrictSVar m a → StrictSVar n a Source #

isEmptySVar ∷ MonadSTM m ⇒ StrictSVar m a → m Bool Source #

modifySVar ∷ (MonadSTM m, MonadCatch m, HasCallStack) ⇒ StrictSVar m a → (a → m (a, b)) → m b Source #

modifySVar_ ∷ (MonadSTM m, MonadCatch m, HasCallStack) ⇒ StrictSVar m a → (a → m a) → m () Source #

putSVar ∷ (MonadSTM m, HasCallStack) ⇒ StrictSVar m a → a → m () Source #

readSVar ∷ MonadSTM m ⇒ StrictSVar m a → m a Source #

readSVarSTM ∷ MonadSTM m ⇒ StrictSVar m a → STM m a Source #

Read the possibly-stale value of the SVar

Will return the current value of the SVar if it non-empty, or the last known value otherwise.

swapSVar ∷ (MonadSTM m, HasCallStack) ⇒ StrictSVar m a → a → m a Source #

Swap value of a StrictSVar

NOTE: Since swapping the value can't leave the StrictSVar empty, we could check the invariant first and only then swap. We nonetheless swap first and check the invariant after to keep the semantics the same with putSVar, otherwise it will be difficult to understand when a StrictSVar is updated and when it is not.

takeSVar ∷ MonadSTM m ⇒ StrictSVar m a → m a Source #

tryPutSVar ∷ (MonadSTM m, HasCallStack) ⇒ StrictSVar m a → a → m Bool Source #

tryReadSVar ∷ MonadSTM m ⇒ StrictSVar m a → m (Maybe a) Source #

tryTakeSVar ∷ MonadSTM m ⇒ StrictSVar m a → m (Maybe a) Source #

updateSVar ∷ (MonadSTM m, HasCallStack) ⇒ StrictSVar m a → (a → (a, b)) → m b Source #

updateSVar_ ∷ (MonadSTM m, HasCallStack) ⇒ StrictSVar m a → (a → a) → m () Source #

class (Monad m, Monad (STM m)) ⇒ MonadSTM (m ∷ Type → Type) where Source #

The STM primitives parametrised by a monad m.

Associated Types

type STM (m ∷ Type → Type) = (stm ∷ Type → Type) | stm → m Source #

The STM monad.

Methods

atomically ∷ HasCallStack ⇒ STM m a → m a Source #

Atomically run an STM computation.

See atomically.

retry ∷ STM m a Source #

See retry.

orElse ∷ STM m a → STM m a → STM m a Source #

See orElse.

check ∷ Bool → STM m () Source #

See check.

Instances

Instances details

MonadSTM IO
Instance details Defined in Control.Monad.Class.MonadSTM.Internal Associated Types type STM IO = (stm ∷ Type → Type) Source # type TVar IO ∷ Type → Type Source # type TMVar IO ∷ Type → Type Source # type TQueue IO ∷ Type → Type Source # type TBQueue IO ∷ Type → Type Source # type TArray IO ∷ Type → Type → Type Source # type TSem IO Source # type TChan IO ∷ Type → Type Source # Methods atomically ∷ HasCallStack ⇒ STM IO a → IO a Source # newTVar ∷ a → STM IO (TVar IO a) Source # readTVar ∷ TVar IO a → STM IO a Source # writeTVar ∷ TVar IO a → a → STM IO () Source # retry ∷ STM IO a Source # orElse ∷ STM IO a → STM IO a → STM IO a Source # modifyTVar ∷ TVar IO a → (a → a) → STM IO () Source # modifyTVar' ∷ TVar IO a → (a → a) → STM IO () Source # stateTVar ∷ TVar IO s → (s → (a, s)) → STM IO a Source # swapTVar ∷ TVar IO a → a → STM IO a Source # check ∷ Bool → STM IO () Source # newTMVar ∷ a → STM IO (TMVar IO a) Source # newEmptyTMVar ∷ STM IO (TMVar IO a) Source # takeTMVar ∷ TMVar IO a → STM IO a Source # tryTakeTMVar ∷ TMVar IO a → STM IO (Maybe a) Source # putTMVar ∷ TMVar IO a → a → STM IO () Source # tryPutTMVar ∷ TMVar IO a → a → STM IO Bool Source # readTMVar ∷ TMVar IO a → STM IO a Source # tryReadTMVar ∷ TMVar IO a → STM IO (Maybe a) Source # swapTMVar ∷ TMVar IO a → a → STM IO a Source # writeTMVar ∷ TMVar IO a → a → STM IO () Source # isEmptyTMVar ∷ TMVar IO a → STM IO Bool Source # newTQueue ∷ STM IO (TQueue IO a) Source # readTQueue ∷ TQueue IO a → STM IO a Source # tryReadTQueue ∷ TQueue IO a → STM IO (Maybe a) Source # peekTQueue ∷ TQueue IO a → STM IO a Source # tryPeekTQueue ∷ TQueue IO a → STM IO (Maybe a) Source # flushTQueue ∷ TQueue IO a → STM IO [a] Source # writeTQueue ∷ TQueue IO a → a → STM IO () Source # isEmptyTQueue ∷ TQueue IO a → STM IO Bool Source # unGetTQueue ∷ TQueue IO a → a → STM IO () Source # newTBQueue ∷ Natural → STM IO (TBQueue IO a) Source # readTBQueue ∷ TBQueue IO a → STM IO a Source # tryReadTBQueue ∷ TBQueue IO a → STM IO (Maybe a) Source # peekTBQueue ∷ TBQueue IO a → STM IO a Source # tryPeekTBQueue ∷ TBQueue IO a → STM IO (Maybe a) Source # flushTBQueue ∷ TBQueue IO a → STM IO [a] Source # writeTBQueue ∷ TBQueue IO a → a → STM IO () Source # lengthTBQueue ∷ TBQueue IO a → STM IO Natural Source # isEmptyTBQueue ∷ TBQueue IO a → STM IO Bool Source # isFullTBQueue ∷ TBQueue IO a → STM IO Bool Source # unGetTBQueue ∷ TBQueue IO a → a → STM IO () Source # newTSem ∷ Integer → STM IO (TSem IO) Source # waitTSem ∷ TSem IO → STM IO () Source # signalTSem ∷ TSem IO → STM IO () Source # signalTSemN ∷ Natural → TSem IO → STM IO () Source # newTChan ∷ STM IO (TChan IO a) Source # newBroadcastTChan ∷ STM IO (TChan IO a) Source # dupTChan ∷ TChan IO a → STM IO (TChan IO a) Source # cloneTChan ∷ TChan IO a → STM IO (TChan IO a) Source # readTChan ∷ TChan IO a → STM IO a Source # tryReadTChan ∷ TChan IO a → STM IO (Maybe a) Source # peekTChan ∷ TChan IO a → STM IO a Source # tryPeekTChan ∷ TChan IO a → STM IO (Maybe a) Source # writeTChan ∷ TChan IO a → a → STM IO () Source # unGetTChan ∷ TChan IO a → a → STM IO () Source # isEmptyTChan ∷ TChan IO a → STM IO Bool Source # newTVarIO ∷ a → IO (TVar IO a) Source # readTVarIO ∷ TVar IO a → IO a Source # newTMVarIO ∷ a → IO (TMVar IO a) Source # newEmptyTMVarIO ∷ IO (TMVar IO a) Source # newTQueueIO ∷ IO (TQueue IO a) Source # newTBQueueIO ∷ Natural → IO (TBQueue IO a) Source # newTChanIO ∷ IO (TChan IO a) Source # newBroadcastTChanIO ∷ IO (TChan IO a) Source #
MonadSTM m ⇒ MonadSTM (WithEarlyExit m) Source #
Instance details Defined in Ouroboros.Consensus.Util.EarlyExit Associated Types type STM (WithEarlyExit m) = (stm ∷ Type → Type) Source # type TVar (WithEarlyExit m) ∷ Type → Type Source # type TMVar (WithEarlyExit m) ∷ Type → Type Source # type TQueue (WithEarlyExit m) ∷ Type → Type Source # type TBQueue (WithEarlyExit m) ∷ Type → Type Source # type TArray (WithEarlyExit m) ∷ Type → Type → Type Source # type TSem (WithEarlyExit m) Source # type TChan (WithEarlyExit m) ∷ Type → Type Source # Methods atomically ∷ HasCallStack ⇒ STM (WithEarlyExit m) a → WithEarlyExit m a Source # newTVar ∷ a → STM (WithEarlyExit m) (TVar (WithEarlyExit m) a) Source # readTVar ∷ TVar (WithEarlyExit m) a → STM (WithEarlyExit m) a Source # writeTVar ∷ TVar (WithEarlyExit m) a → a → STM (WithEarlyExit m) () Source # retry ∷ STM (WithEarlyExit m) a Source # orElse ∷ STM (WithEarlyExit m) a → STM (WithEarlyExit m) a → STM (WithEarlyExit m) a Source # modifyTVar ∷ TVar (WithEarlyExit m) a → (a → a) → STM (WithEarlyExit m) () Source # modifyTVar' ∷ TVar (WithEarlyExit m) a → (a → a) → STM (WithEarlyExit m) () Source # stateTVar ∷ TVar (WithEarlyExit m) s → (s → (a, s)) → STM (WithEarlyExit m) a Source # swapTVar ∷ TVar (WithEarlyExit m) a → a → STM (WithEarlyExit m) a Source # check ∷ Bool → STM (WithEarlyExit m) () Source # newTMVar ∷ a → STM (WithEarlyExit m) (TMVar (WithEarlyExit m) a) Source # newEmptyTMVar ∷ STM (WithEarlyExit m) (TMVar (WithEarlyExit m) a) Source # takeTMVar ∷ TMVar (WithEarlyExit m) a → STM (WithEarlyExit m) a Source # tryTakeTMVar ∷ TMVar (WithEarlyExit m) a → STM (WithEarlyExit m) (Maybe a) Source # putTMVar ∷ TMVar (WithEarlyExit m) a → a → STM (WithEarlyExit m) () Source # tryPutTMVar ∷ TMVar (WithEarlyExit m) a → a → STM (WithEarlyExit m) Bool Source # readTMVar ∷ TMVar (WithEarlyExit m) a → STM (WithEarlyExit m) a Source # tryReadTMVar ∷ TMVar (WithEarlyExit m) a → STM (WithEarlyExit m) (Maybe a) Source # swapTMVar ∷ TMVar (WithEarlyExit m) a → a → STM (WithEarlyExit m) a Source # writeTMVar ∷ TMVar (WithEarlyExit m) a → a → STM (WithEarlyExit m) () Source # isEmptyTMVar ∷ TMVar (WithEarlyExit m) a → STM (WithEarlyExit m) Bool Source # newTQueue ∷ STM (WithEarlyExit m) (TQueue (WithEarlyExit m) a) Source # readTQueue ∷ TQueue (WithEarlyExit m) a → STM (WithEarlyExit m) a Source # tryReadTQueue ∷ TQueue (WithEarlyExit m) a → STM (WithEarlyExit m) (Maybe a) Source # peekTQueue ∷ TQueue (WithEarlyExit m) a → STM (WithEarlyExit m) a Source # tryPeekTQueue ∷ TQueue (WithEarlyExit m) a → STM (WithEarlyExit m) (Maybe a) Source # flushTQueue ∷ TQueue (WithEarlyExit m) a → STM (WithEarlyExit m) [a] Source # writeTQueue ∷ TQueue (WithEarlyExit m) a → a → STM (WithEarlyExit m) () Source # isEmptyTQueue ∷ TQueue (WithEarlyExit m) a → STM (WithEarlyExit m) Bool Source # unGetTQueue ∷ TQueue (WithEarlyExit m) a → a → STM (WithEarlyExit m) () Source # newTBQueue ∷ Natural → STM (WithEarlyExit m) (TBQueue (WithEarlyExit m) a) Source # readTBQueue ∷ TBQueue (WithEarlyExit m) a → STM (WithEarlyExit m) a Source # tryReadTBQueue ∷ TBQueue (WithEarlyExit m) a → STM (WithEarlyExit m) (Maybe a) Source # peekTBQueue ∷ TBQueue (WithEarlyExit m) a → STM (WithEarlyExit m) a Source # tryPeekTBQueue ∷ TBQueue (WithEarlyExit m) a → STM (WithEarlyExit m) (Maybe a) Source # flushTBQueue ∷ TBQueue (WithEarlyExit m) a → STM (WithEarlyExit m) [a] Source # writeTBQueue ∷ TBQueue (WithEarlyExit m) a → a → STM (WithEarlyExit m) () Source # lengthTBQueue ∷ TBQueue (WithEarlyExit m) a → STM (WithEarlyExit m) Natural Source # isEmptyTBQueue ∷ TBQueue (WithEarlyExit m) a → STM (WithEarlyExit m) Bool Source # isFullTBQueue ∷ TBQueue (WithEarlyExit m) a → STM (WithEarlyExit m) Bool Source # unGetTBQueue ∷ TBQueue (WithEarlyExit m) a → a → STM (WithEarlyExit m) () Source # newTSem ∷ Integer → STM (WithEarlyExit m) (TSem (WithEarlyExit m)) Source # waitTSem ∷ TSem (WithEarlyExit m) → STM (WithEarlyExit m) () Source # signalTSem ∷ TSem (WithEarlyExit m) → STM (WithEarlyExit m) () Source # signalTSemN ∷ Natural → TSem (WithEarlyExit m) → STM (WithEarlyExit m) () Source # newTChan ∷ STM (WithEarlyExit m) (TChan (WithEarlyExit m) a) Source # newBroadcastTChan ∷ STM (WithEarlyExit m) (TChan (WithEarlyExit m) a) Source # dupTChan ∷ TChan (WithEarlyExit m) a → STM (WithEarlyExit m) (TChan (WithEarlyExit m) a) Source # cloneTChan ∷ TChan (WithEarlyExit m) a → STM (WithEarlyExit m) (TChan (WithEarlyExit m) a) Source # readTChan ∷ TChan (WithEarlyExit m) a → STM (WithEarlyExit m) a Source # tryReadTChan ∷ TChan (WithEarlyExit m) a → STM (WithEarlyExit m) (Maybe a) Source # peekTChan ∷ TChan (WithEarlyExit m) a → STM (WithEarlyExit m) a Source # tryPeekTChan ∷ TChan (WithEarlyExit m) a → STM (WithEarlyExit m) (Maybe a) Source # writeTChan ∷ TChan (WithEarlyExit m) a → a → STM (WithEarlyExit m) () Source # unGetTChan ∷ TChan (WithEarlyExit m) a → a → STM (WithEarlyExit m) () Source # isEmptyTChan ∷ TChan (WithEarlyExit m) a → STM (WithEarlyExit m) Bool Source # newTVarIO ∷ a → WithEarlyExit m (TVar (WithEarlyExit m) a) Source # readTVarIO ∷ TVar (WithEarlyExit m) a → WithEarlyExit m a Source # newTMVarIO ∷ a → WithEarlyExit m (TMVar (WithEarlyExit m) a) Source # newEmptyTMVarIO ∷ WithEarlyExit m (TMVar (WithEarlyExit m) a) Source # newTQueueIO ∷ WithEarlyExit m (TQueue (WithEarlyExit m) a) Source # newTBQueueIO ∷ Natural → WithEarlyExit m (TBQueue (WithEarlyExit m) a) Source # newTChanIO ∷ WithEarlyExit m (TChan (WithEarlyExit m) a) Source # newBroadcastTChanIO ∷ WithEarlyExit m (TChan (WithEarlyExit m) a) Source #
MonadSTM m ⇒ MonadSTM (ReaderT r m)	The underlying stm monad is also transformed.
Instance details Defined in Control.Monad.Class.MonadSTM.Internal Associated Types type STM (ReaderT r m) = (stm ∷ Type → Type) Source # type TVar (ReaderT r m) ∷ Type → Type Source # type TMVar (ReaderT r m) ∷ Type → Type Source # type TQueue (ReaderT r m) ∷ Type → Type Source # type TBQueue (ReaderT r m) ∷ Type → Type Source # type TArray (ReaderT r m) ∷ Type → Type → Type Source # type TSem (ReaderT r m) Source # type TChan (ReaderT r m) ∷ Type → Type Source # Methods atomically ∷ HasCallStack ⇒ STM (ReaderT r m) a → ReaderT r m a Source # newTVar ∷ a → STM (ReaderT r m) (TVar (ReaderT r m) a) Source # readTVar ∷ TVar (ReaderT r m) a → STM (ReaderT r m) a Source # writeTVar ∷ TVar (ReaderT r m) a → a → STM (ReaderT r m) () Source # retry ∷ STM (ReaderT r m) a Source # orElse ∷ STM (ReaderT r m) a → STM (ReaderT r m) a → STM (ReaderT r m) a Source # modifyTVar ∷ TVar (ReaderT r m) a → (a → a) → STM (ReaderT r m) () Source # modifyTVar' ∷ TVar (ReaderT r m) a → (a → a) → STM (ReaderT r m) () Source # stateTVar ∷ TVar (ReaderT r m) s → (s → (a, s)) → STM (ReaderT r m) a Source # swapTVar ∷ TVar (ReaderT r m) a → a → STM (ReaderT r m) a Source # check ∷ Bool → STM (ReaderT r m) () Source # newTMVar ∷ a → STM (ReaderT r m) (TMVar (ReaderT r m) a) Source # newEmptyTMVar ∷ STM (ReaderT r m) (TMVar (ReaderT r m) a) Source # takeTMVar ∷ TMVar (ReaderT r m) a → STM (ReaderT r m) a Source # tryTakeTMVar ∷ TMVar (ReaderT r m) a → STM (ReaderT r m) (Maybe a) Source # putTMVar ∷ TMVar (ReaderT r m) a → a → STM (ReaderT r m) () Source # tryPutTMVar ∷ TMVar (ReaderT r m) a → a → STM (ReaderT r m) Bool Source # readTMVar ∷ TMVar (ReaderT r m) a → STM (ReaderT r m) a Source # tryReadTMVar ∷ TMVar (ReaderT r m) a → STM (ReaderT r m) (Maybe a) Source # swapTMVar ∷ TMVar (ReaderT r m) a → a → STM (ReaderT r m) a Source # writeTMVar ∷ TMVar (ReaderT r m) a → a → STM (ReaderT r m) () Source # isEmptyTMVar ∷ TMVar (ReaderT r m) a → STM (ReaderT r m) Bool Source # newTQueue ∷ STM (ReaderT r m) (TQueue (ReaderT r m) a) Source # readTQueue ∷ TQueue (ReaderT r m) a → STM (ReaderT r m) a Source # tryReadTQueue ∷ TQueue (ReaderT r m) a → STM (ReaderT r m) (Maybe a) Source # peekTQueue ∷ TQueue (ReaderT r m) a → STM (ReaderT r m) a Source # tryPeekTQueue ∷ TQueue (ReaderT r m) a → STM (ReaderT r m) (Maybe a) Source # flushTQueue ∷ TQueue (ReaderT r m) a → STM (ReaderT r m) [a] Source # writeTQueue ∷ TQueue (ReaderT r m) a → a → STM (ReaderT r m) () Source # isEmptyTQueue ∷ TQueue (ReaderT r m) a → STM (ReaderT r m) Bool Source # unGetTQueue ∷ TQueue (ReaderT r m) a → a → STM (ReaderT r m) () Source # newTBQueue ∷ Natural → STM (ReaderT r m) (TBQueue (ReaderT r m) a) Source # readTBQueue ∷ TBQueue (ReaderT r m) a → STM (ReaderT r m) a Source # tryReadTBQueue ∷ TBQueue (ReaderT r m) a → STM (ReaderT r m) (Maybe a) Source # peekTBQueue ∷ TBQueue (ReaderT r m) a → STM (ReaderT r m) a Source # tryPeekTBQueue ∷ TBQueue (ReaderT r m) a → STM (ReaderT r m) (Maybe a) Source # flushTBQueue ∷ TBQueue (ReaderT r m) a → STM (ReaderT r m) [a] Source # writeTBQueue ∷ TBQueue (ReaderT r m) a → a → STM (ReaderT r m) () Source # lengthTBQueue ∷ TBQueue (ReaderT r m) a → STM (ReaderT r m) Natural Source # isEmptyTBQueue ∷ TBQueue (ReaderT r m) a → STM (ReaderT r m) Bool Source # isFullTBQueue ∷ TBQueue (ReaderT r m) a → STM (ReaderT r m) Bool Source # unGetTBQueue ∷ TBQueue (ReaderT r m) a → a → STM (ReaderT r m) () Source # newTSem ∷ Integer → STM (ReaderT r m) (TSem (ReaderT r m)) Source # waitTSem ∷ TSem (ReaderT r m) → STM (ReaderT r m) () Source # signalTSem ∷ TSem (ReaderT r m) → STM (ReaderT r m) () Source # signalTSemN ∷ Natural → TSem (ReaderT r m) → STM (ReaderT r m) () Source # newTChan ∷ STM (ReaderT r m) (TChan (ReaderT r m) a) Source # newBroadcastTChan ∷ STM (ReaderT r m) (TChan (ReaderT r m) a) Source # dupTChan ∷ TChan (ReaderT r m) a → STM (ReaderT r m) (TChan (ReaderT r m) a) Source # cloneTChan ∷ TChan (ReaderT r m) a → STM (ReaderT r m) (TChan (ReaderT r m) a) Source # readTChan ∷ TChan (ReaderT r m) a → STM (ReaderT r m) a Source # tryReadTChan ∷ TChan (ReaderT r m) a → STM (ReaderT r m) (Maybe a) Source # peekTChan ∷ TChan (ReaderT r m) a → STM (ReaderT r m) a Source # tryPeekTChan ∷ TChan (ReaderT r m) a → STM (ReaderT r m) (Maybe a) Source # writeTChan ∷ TChan (ReaderT r m) a → a → STM (ReaderT r m) () Source # unGetTChan ∷ TChan (ReaderT r m) a → a → STM (ReaderT r m) () Source # isEmptyTChan ∷ TChan (ReaderT r m) a → STM (ReaderT r m) Bool Source # newTVarIO ∷ a → ReaderT r m (TVar (ReaderT r m) a) Source # readTVarIO ∷ TVar (ReaderT r m) a → ReaderT r m a Source # newTMVarIO ∷ a → ReaderT r m (TMVar (ReaderT r m) a) Source # newEmptyTMVarIO ∷ ReaderT r m (TMVar (ReaderT r m) a) Source # newTQueueIO ∷ ReaderT r m (TQueue (ReaderT r m) a) Source # newTBQueueIO ∷ Natural → ReaderT r m (TBQueue (ReaderT r m) a) Source # newTChanIO ∷ ReaderT r m (TChan (ReaderT r m) a) Source # newBroadcastTChanIO ∷ ReaderT r m (TChan (ReaderT r m) a) Source #

type family STM (m ∷ Type → Type) = (stm ∷ Type → Type) | stm → m Source #

The STM monad.

Instances

Instances details

type STM IO
Instance details Defined in Control.Monad.Class.MonadSTM.Internal type STM IO = STM
type STM (WithEarlyExit m) Source #
Instance details Defined in Ouroboros.Consensus.Util.EarlyExit type STM (WithEarlyExit m) = WithEarlyExit (STM m)
type STM (ReaderT r m)
Instance details Defined in Control.Monad.Class.MonadSTM.Internal type STM (ReaderT r m) = ReaderT r (STM m)

class MonadInspectSTM m ⇒ MonadTraceSTM (m ∷ Type → Type) where Source #

MonadTraceSTM allows to trace values of stm variables when stm transaction is committed. This allows to verify invariants when a variable is committed.

Minimal complete definition

traceTVar, traceTQueue, traceTBQueue

Methods

traceTMVar ∷ proxy m → TMVar m a → (Maybe (Maybe a) → Maybe a → InspectMonad m TraceValue) → STM m () Source #

traceTQueue ∷ proxy m → TQueue m a → (Maybe [a] → [a] → InspectMonad m TraceValue) → STM m () Source #

traceTBQueue ∷ proxy m → TBQueue m a → (Maybe [a] → [a] → InspectMonad m TraceValue) → STM m () Source #

traceTSem ∷ proxy m → TSem m → (Maybe Integer → Integer → InspectMonad m TraceValue) → STM m () Source #

traceTMVarIO ∷ TMVar m a → (Maybe (Maybe a) → Maybe a → InspectMonad m TraceValue) → m () Source #

traceTQueueIO ∷ TQueue m a → (Maybe [a] → [a] → InspectMonad m TraceValue) → m () Source #

traceTBQueueIO ∷ TBQueue m a → (Maybe [a] → [a] → InspectMonad m TraceValue) → m () Source #

traceTSemIO ∷ TSem m → (Maybe Integer → Integer → InspectMonad m TraceValue) → m () Source #

Instances

Instances details

MonadTraceSTM IO	noop instance
Instance details Defined in Control.Monad.Class.MonadSTM.Internal Methods traceTVar ∷ proxy IO → TVar IO a → (Maybe a → a → InspectMonad IO TraceValue) → STM IO () Source # traceTMVar ∷ proxy IO → TMVar IO a → (Maybe (Maybe a) → Maybe a → InspectMonad IO TraceValue) → STM IO () Source # traceTQueue ∷ proxy IO → TQueue IO a → (Maybe [a] → [a] → InspectMonad IO TraceValue) → STM IO () Source # traceTBQueue ∷ proxy IO → TBQueue IO a → (Maybe [a] → [a] → InspectMonad IO TraceValue) → STM IO () Source # traceTSem ∷ proxy IO → TSem IO → (Maybe Integer → Integer → InspectMonad IO TraceValue) → STM IO () Source # traceTVarIO ∷ TVar IO a → (Maybe a → a → InspectMonad IO TraceValue) → IO () Source # traceTMVarIO ∷ TMVar IO a → (Maybe (Maybe a) → Maybe a → InspectMonad IO TraceValue) → IO () Source # traceTQueueIO ∷ TQueue IO a → (Maybe [a] → [a] → InspectMonad IO TraceValue) → IO () Source # traceTBQueueIO ∷ TBQueue IO a → (Maybe [a] → [a] → InspectMonad IO TraceValue) → IO () Source # traceTSemIO ∷ TSem IO → (Maybe Integer → Integer → InspectMonad IO TraceValue) → IO () Source #
MonadTraceSTM m ⇒ MonadTraceSTM (WithEarlyExit m) Source #
Instance details Defined in Ouroboros.Consensus.Util.EarlyExit Methods traceTVar ∷ proxy (WithEarlyExit m) → TVar (WithEarlyExit m) a → (Maybe a → a → InspectMonad (WithEarlyExit m) TraceValue) → STM (WithEarlyExit m) () Source # traceTMVar ∷ proxy (WithEarlyExit m) → TMVar (WithEarlyExit m) a → (Maybe (Maybe a) → Maybe a → InspectMonad (WithEarlyExit m) TraceValue) → STM (WithEarlyExit m) () Source # traceTQueue ∷ proxy (WithEarlyExit m) → TQueue (WithEarlyExit m) a → (Maybe [a] → [a] → InspectMonad (WithEarlyExit m) TraceValue) → STM (WithEarlyExit m) () Source # traceTBQueue ∷ proxy (WithEarlyExit m) → TBQueue (WithEarlyExit m) a → (Maybe [a] → [a] → InspectMonad (WithEarlyExit m) TraceValue) → STM (WithEarlyExit m) () Source # traceTSem ∷ proxy (WithEarlyExit m) → TSem (WithEarlyExit m) → (Maybe Integer → Integer → InspectMonad (WithEarlyExit m) TraceValue) → STM (WithEarlyExit m) () Source # traceTVarIO ∷ TVar (WithEarlyExit m) a → (Maybe a → a → InspectMonad (WithEarlyExit m) TraceValue) → WithEarlyExit m () Source # traceTMVarIO ∷ TMVar (WithEarlyExit m) a → (Maybe (Maybe a) → Maybe a → InspectMonad (WithEarlyExit m) TraceValue) → WithEarlyExit m () Source # traceTQueueIO ∷ TQueue (WithEarlyExit m) a → (Maybe [a] → [a] → InspectMonad (WithEarlyExit m) TraceValue) → WithEarlyExit m () Source # traceTBQueueIO ∷ TBQueue (WithEarlyExit m) a → (Maybe [a] → [a] → InspectMonad (WithEarlyExit m) TraceValue) → WithEarlyExit m () Source # traceTSemIO ∷ TSem (WithEarlyExit m) → (Maybe Integer → Integer → InspectMonad (WithEarlyExit m) TraceValue) → WithEarlyExit m () Source #

data TraceValue where Source #

A GADT which instructs how to trace the value. The traceDynamic will use dynamic tracing, e.g. "Control.Monad.IOSim.traceM"; while traceString will be traced with EventSay. The IOSims dynamic tracing allows to recover the value from the simulation trace (see "Control.Monad.IOSim.selectTraceEventsDynamic").

Constructors

TraceValue
Fields ∷ ∀ tr. Typeable tr ⇒ { traceDynamic ∷ Maybe tr , traceString ∷ Maybe String } → TraceValue

Bundled Patterns

pattern DontTrace ∷ TraceValue	Do not trace the value.
pattern TraceString ∷ String → TraceValue	Use only string tracing.
pattern TraceDynamic ∷ () ⇒ Typeable tr ⇒ tr → TraceValue	Use only a dynamic tracer.

class (MonadSTM m, Monad (InspectMonad m)) ⇒ MonadInspectSTM (m ∷ Type → Type) where Source #

This type class is indented for 'io-sim', where one might want to access a TVar in the underlying ST monad.

Associated Types

type InspectMonad (m ∷ Type → Type) ∷ Type → Type Source #

Methods

inspectTVar ∷ proxy m → TVar m a → InspectMonad m a Source #

Return the value of a TVar as an InspectMonad computation.

inspectTVar is useful if the value of a TVar observed by traceTVar contains other TVars.

inspectTMVar ∷ proxy m → TMVar m a → InspectMonad m (Maybe a) Source #

Return the value of a MonadSTM as an InspectMonad computation.

Instances

Instances details

MonadInspectSTM IO
Instance details Defined in Control.Monad.Class.MonadSTM.Internal Associated Types type InspectMonad IO ∷ Type → Type Source # Methods inspectTVar ∷ proxy IO → TVar IO a → InspectMonad IO a Source # inspectTMVar ∷ proxy IO → TMVar IO a → InspectMonad IO (Maybe a) Source #
(MonadInspectSTM m, Monad (InspectMonad m)) ⇒ MonadInspectSTM (WithEarlyExit m) Source #
Instance details Defined in Ouroboros.Consensus.Util.EarlyExit Associated Types type InspectMonad (WithEarlyExit m) ∷ Type → Type Source # Methods inspectTVar ∷ proxy (WithEarlyExit m) → TVar (WithEarlyExit m) a → InspectMonad (WithEarlyExit m) a Source # inspectTMVar ∷ proxy (WithEarlyExit m) → TMVar (WithEarlyExit m) a → InspectMonad (WithEarlyExit m) (Maybe a) Source #

type family InspectMonad (m ∷ Type → Type) ∷ Type → Type Source #

Instances

Instances details

type InspectMonad IO
Instance details Defined in Control.Monad.Class.MonadSTM.Internal type InspectMonad IO = IO
type InspectMonad (WithEarlyExit m) Source #
Instance details Defined in Ouroboros.Consensus.Util.EarlyExit type InspectMonad (WithEarlyExit m) = InspectMonad m

class MonadSTM m ⇒ MonadLabelledSTM (m ∷ Type → Type) Source #

Labelled TVars & friends.

The IO instances is no-op, the IOSim instance enhances simulation trace. This is very useful when analysing low lever concurrency issues (e.g. deadlocks, livelocks etc).

Minimal complete definition

labelTVar

Instances

Instances details

MonadLabelledSTM IO	noop instance
Instance details Defined in Control.Monad.Class.MonadSTM.Internal Methods labelTVar ∷ TVar IO a → String → STM IO () Source # labelTMVar ∷ TMVar IO a → String → STM IO () Source # labelTQueue ∷ TQueue IO a → String → STM IO () Source # labelTBQueue ∷ TBQueue IO a → String → STM IO () Source # labelTArray ∷ (Ix i, Show i) ⇒ TArray IO i e → String → STM IO () Source # labelTSem ∷ TSem IO → String → STM IO () Source # labelTChan ∷ TChan IO a → String → STM IO () Source # labelTVarIO ∷ TVar IO a → String → IO () Source # labelTMVarIO ∷ TMVar IO a → String → IO () Source # labelTQueueIO ∷ TQueue IO a → String → IO () Source # labelTBQueueIO ∷ TBQueue IO a → String → IO () Source # labelTArrayIO ∷ (Ix i, Show i) ⇒ TArray IO i e → String → IO () Source # labelTSemIO ∷ TSem IO → String → IO () Source # labelTChanIO ∷ TChan IO a → String → IO () Source #
MonadLabelledSTM m ⇒ MonadLabelledSTM (WithEarlyExit m) Source #
Instance details Defined in Ouroboros.Consensus.Util.EarlyExit Methods labelTVar ∷ TVar (WithEarlyExit m) a → String → STM (WithEarlyExit m) () Source # labelTMVar ∷ TMVar (WithEarlyExit m) a → String → STM (WithEarlyExit m) () Source # labelTQueue ∷ TQueue (WithEarlyExit m) a → String → STM (WithEarlyExit m) () Source # labelTBQueue ∷ TBQueue (WithEarlyExit m) a → String → STM (WithEarlyExit m) () Source # labelTArray ∷ (Ix i, Show i) ⇒ TArray (WithEarlyExit m) i e → String → STM (WithEarlyExit m) () Source # labelTSem ∷ TSem (WithEarlyExit m) → String → STM (WithEarlyExit m) () Source # labelTChan ∷ TChan (WithEarlyExit m) a → String → STM (WithEarlyExit m) () Source # labelTVarIO ∷ TVar (WithEarlyExit m) a → String → WithEarlyExit m () Source # labelTMVarIO ∷ TMVar (WithEarlyExit m) a → String → WithEarlyExit m () Source # labelTQueueIO ∷ TQueue (WithEarlyExit m) a → String → WithEarlyExit m () Source # labelTBQueueIO ∷ TBQueue (WithEarlyExit m) a → String → WithEarlyExit m () Source # labelTArrayIO ∷ (Ix i, Show i) ⇒ TArray (WithEarlyExit m) i e → String → WithEarlyExit m () Source # labelTSemIO ∷ TSem (WithEarlyExit m) → String → WithEarlyExit m () Source # labelTChanIO ∷ TChan (WithEarlyExit m) a → String → WithEarlyExit m () Source #

data StrictTMVar (m ∷ Type → Type) a Source #

TMVar that keeps its value in WHNF at all times

type LazyTMVar (m ∷ Type → Type) = TMVar m Source #

throwSTM ∷ ∀ (m ∷ Type → Type) e a. (MonadSTM m, MonadThrow (STM m), Exception e) ⇒ e → STM m a Source #

throwIO specialised to stm monad.

labelTMVar ∷ ∀ (m ∷ Type → Type) a. MonadLabelledSTM m ⇒ StrictTMVar m a → String → STM m () Source #

labelTMVarIO ∷ MonadLabelledSTM m ⇒ StrictTMVar m a → String → m () Source #

newEmptyTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ STM m (StrictTMVar m a) Source #

takeTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → STM m a Source #

tryTakeTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → STM m (Maybe a) Source #

putTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → a → STM m () Source #

tryPutTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → a → STM m Bool Source #

readTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → STM m a Source #

tryReadTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → STM m (Maybe a) Source #

swapTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → a → STM m a Source #

writeTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → a → STM m () Source #

isEmptyTMVar ∷ ∀ (m ∷ Type → Type) a. MonadSTM m ⇒ StrictTMVar m a → STM m Bool Source #

newEmptyTMVarIO ∷ MonadSTM m ⇒ m (StrictTMVar m a) Source #

fromLazyTMVar ∷ ∀ (m ∷ Type → Type) a. LazyTMVar m a → StrictTMVar m a Source #

castStrictTMVar ∷ ∀ (m ∷ Type → Type) (n ∷ Type → Type) a. LazyTMVar m ~ LazyTMVar n ⇒ StrictTMVar m a → StrictTMVar n a Source #

newEmptySVar ∷ (MonadSTM m, NoThunks a) ⇒ a → m (StrictSVar m a) Source #

newSVar ∷ (MonadSTM m, HasCallStack, NoThunks a) ⇒ a → m (StrictSVar m a) Source #

Temporary

uncheckedNewEmptySVar ∷ MonadSTM m ⇒ a → m (StrictSVar m a) Source #

uncheckedNewSVar ∷ MonadSTM m ⇒ a → m (StrictSVar m a) Source #