Permalink
Fetching contributors…
Cannot retrieve contributors at this time
1305 lines (1198 sloc) 51.1 KB
{-# LANGUAGE CPP #-}
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE RankNTypes #-}
{-# LANGUAGE BangPatterns #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE MagicHash #-}
-- | Local nodes
--
module Control.Distributed.Process.Node
( LocalNode
, newLocalNode
, closeLocalNode
, forkProcess
, runProcess
, initRemoteTable
, localNodeId
) where
-- TODO: Calls to 'sendBinary' and co (by the NC) may stall the node controller.
import System.IO (fixIO, hPutStrLn, stderr)
import System.Mem.Weak (Weak, deRefWeak)
import qualified Data.ByteString.Lazy as BSL (fromChunks)
import Data.Binary (decode)
import Data.Map (Map)
import qualified Data.Map as Map
( empty
, delete
, toList
, fromList
, insert
, lookup
, partition
, partitionWithKey
, elems
, size
, filterWithKey
, foldlWithKey
)
import Data.Time.Format (formatTime)
#if MIN_VERSION_time(1,5,0)
import Data.Time.Format (defaultTimeLocale)
#else
import System.Locale (defaultTimeLocale)
#endif
import Data.Set (Set)
import qualified Data.Set as Set
( empty
, insert
, delete
, map
, member
, toList
, union
)
import Data.Foldable (forM_)
import Data.Maybe (isJust, fromJust, isNothing, catMaybes)
import Data.Typeable (Typeable)
import Control.Category ((>>>))
import Control.Applicative
import Control.Monad (void, when, join)
import Control.Monad.IO.Class (MonadIO, liftIO)
import Control.Monad.State.Strict (MonadState, StateT, evalStateT, gets)
import qualified Control.Monad.State.Strict as StateT (get, put)
import Control.Monad.Reader (MonadReader, ReaderT, runReaderT, ask)
import Control.Exception
( throwIO
, SomeException
, Exception
, throwTo
, uninterruptibleMask_
, getMaskingState
, MaskingState(..)
)
import qualified Control.Exception as Exception
( Handler(..)
, catch
, catches
, finally
)
import Control.Concurrent (forkIO, killThread)
import Control.Distributed.Process.Internal.BiMultiMap (BiMultiMap)
import qualified Control.Distributed.Process.Internal.BiMultiMap as BiMultiMap
import Control.Distributed.Process.Internal.StrictMVar
( newMVar
, withMVar
, modifyMVarMasked
, modifyMVar
, newEmptyMVar
, putMVar
, takeMVar
)
import Control.Concurrent.Chan (newChan, writeChan, readChan)
import qualified Control.Concurrent.MVar as MVar (newEmptyMVar, takeMVar)
import Control.Concurrent.STM
( atomically
)
import Control.Distributed.Process.Internal.CQueue
( CQueue
, enqueue
, newCQueue
, mkWeakCQueue
, queueSize
)
import qualified Network.Transport as NT
( Transport
, EndPoint
, newEndPoint
, receive
, Event(..)
, EventErrorCode(..)
, TransportError(..)
, address
, closeEndPoint
, Connection
, ConnectionId
, close
, EndPointAddress
, Reliability(ReliableOrdered)
)
import Data.Accessor (Accessor, accessor, (^.), (^=), (^:))
import System.Random (randomIO)
import Control.Distributed.Static (RemoteTable, Closure)
import qualified Control.Distributed.Static as Static
( unclosure
, initRemoteTable
)
import Control.Distributed.Process.Internal.Types
( NodeId(..)
, LocalProcessId(..)
, ProcessId(..)
, LocalNode(..)
, MxEventBus(..)
, LocalNodeState(..)
, ValidLocalNodeState(..)
, withValidLocalState
, modifyValidLocalState
, LocalProcess(..)
, LocalProcessState(..)
, Process(..)
, DiedReason(..)
, NCMsg(..)
, ProcessSignal(..)
, localPidCounter
, localPidUnique
, localProcessWithId
, localProcesses
, localConnections
, forever'
, MonitorRef(..)
, NodeClosedException(..)
, ProcessMonitorNotification(..)
, NodeMonitorNotification(..)
, PortMonitorNotification(..)
, ProcessExitException(..)
, ProcessLinkException(..)
, NodeLinkException(..)
, PortLinkException(..)
, DidUnmonitor(..)
, DidUnlinkProcess(..)
, DidUnlinkNode(..)
, DidUnlinkPort(..)
, SpawnRef
, DidSpawn(..)
, Message(..)
, TypedChannel(..)
, Identifier(..)
, nodeOf
, ProcessInfo(..)
, ProcessInfoNone(..)
, NodeStats(..)
, SendPortId(..)
, typedChannelWithId
, RegisterReply(..)
, WhereIsReply(..)
, payloadToMessage
, createUnencodedMessage
, unsafeCreateUnencodedMessage
, runLocalProcess
, firstNonReservedProcessId
, ImplicitReconnect(WithImplicitReconnect)
)
import Control.Distributed.Process.Management.Internal.Agent
( mxAgentController
)
import Control.Distributed.Process.Management.Internal.Types
( MxEvent(..)
)
import qualified Control.Distributed.Process.Management.Internal.Trace.Remote as Trace
( remoteTable
)
import Control.Distributed.Process.Management.Internal.Trace.Tracer
( defaultTracer
)
import Control.Distributed.Process.Management.Internal.Trace.Types
( TraceArg(..)
, traceEvent
, traceLogFmt
, enableTrace
)
import Control.Distributed.Process.Serializable (Serializable)
import Control.Distributed.Process.Internal.Messaging
( sendBinary
, closeImplicitReconnections
, impliesDeathOf
)
import Control.Distributed.Process.Internal.Primitives
( register
, receiveWait
, match
, sendChan
, unwrapMessage
, monitor
, unmonitorAsync
, getSelfNode
, SayMessage(..)
)
import Control.Distributed.Process.Internal.Types (SendPort, Tracer(..))
import qualified Control.Distributed.Process.Internal.Closure.BuiltIn as BuiltIn (remoteTable)
import Control.Distributed.Process.Internal.WeakTQueue (TQueue, writeTQueue)
import qualified Control.Distributed.Process.Internal.StrictContainerAccessors as DAC
( mapMaybe
, mapDefault
)
import Control.Monad.Catch (try)
import GHC.IO (IO(..), unsafeUnmask)
import GHC.Base ( maskAsyncExceptions# )
import Unsafe.Coerce
import Prelude
-- Remove these definitions when the fix for
-- https://ghc.haskell.org/trac/ghc/ticket/10149
-- is included in all supported compilers:
block :: IO a -> IO a
block (IO io) = IO $ maskAsyncExceptions# io
unblock :: IO a -> IO a
unblock = unsafeUnmask
--------------------------------------------------------------------------------
-- Initialization --
--------------------------------------------------------------------------------
initRemoteTable :: RemoteTable
initRemoteTable = Trace.remoteTable $ BuiltIn.remoteTable Static.initRemoteTable
-- | Initialize a new local node.
newLocalNode :: NT.Transport -> RemoteTable -> IO LocalNode
newLocalNode transport rtable = do
mEndPoint <- NT.newEndPoint transport
case mEndPoint of
Left ex -> throwIO ex
Right endPoint -> do
localNode <- createBareLocalNode endPoint rtable
startServiceProcesses localNode
return localNode
-- | Create a new local node (without any service processes running)
createBareLocalNode :: NT.EndPoint -> RemoteTable -> IO LocalNode
createBareLocalNode endPoint rtable = do
unq <- randomIO
state <- newMVar $ LocalNodeValid $ ValidLocalNodeState
{ _localProcesses = Map.empty
, _localPidCounter = firstNonReservedProcessId
, _localPidUnique = unq
, _localConnections = Map.empty
}
ctrlChan <- newChan
let node = LocalNode { localNodeId = NodeId $ NT.address endPoint
, localEndPoint = endPoint
, localState = state
, localCtrlChan = ctrlChan
, localEventBus = MxEventBusInitialising
, remoteTable = rtable
}
tracedNode <- startMxAgent node
-- Once the NC terminates, the endpoint isn't much use,
void $ forkIO $ Exception.finally (runNodeController tracedNode)
(NT.closeEndPoint (localEndPoint node))
-- whilst a closed/failing endpoint will terminate the NC
void $ forkIO $ Exception.finally (handleIncomingMessages tracedNode)
(stopNC node)
return tracedNode
where
stopNC node =
writeChan (localCtrlChan node) NCMsg
{ ctrlMsgSender = NodeIdentifier (localNodeId node)
, ctrlMsgSignal = SigShutdown
}
startMxAgent :: LocalNode -> IO LocalNode
startMxAgent node = do
-- see note [tracer/forkProcess races]
let fork = forkProcess node
mv <- MVar.newEmptyMVar
pid <- fork $ mxAgentController fork mv
(tracer', wqRef, mxNew') <- MVar.takeMVar mv
return node { localEventBus = (MxEventBus pid tracer' wqRef mxNew') }
startDefaultTracer :: LocalNode -> IO ()
startDefaultTracer node' = do
let t = localEventBus node'
case t of
MxEventBus _ (Tracer pid _) _ _ -> do
runProcess node' $ register "trace.controller" pid
pid' <- forkProcess node' defaultTracer
enableTrace (localEventBus node') pid'
runProcess node' $ register "tracer.initial" pid'
_ -> return ()
-- TODO: we need a better mechanism for defining and registering services
-- | Start and register the service processes on a node
startServiceProcesses :: LocalNode -> IO ()
startServiceProcesses node = do
-- tracing /spawns/ relies on the tracer being enabled, but we start
-- the default tracer first, even though it might @nsend@ to the logger
-- before /that/ process has started - this is a totally harmless race
-- however, so we deliberably ignore it
startDefaultTracer node
logger <- forkProcess node loop
runProcess node $ do
register "logger" logger
-- The trace.logger is used for tracing to the console to avoid feedback
-- loops during tracing if the user reregisters the "logger" with a custom
-- process which uses 'send' or other primitives which are traced.
register "trace.logger" logger
where
loop = do
receiveWait
[ match $ \(SayMessage time pid string) -> do
let time' = formatTime defaultTimeLocale "%c" time
liftIO . hPutStrLn stderr $ time' ++ " " ++ show pid ++ ": " ++ string
loop
, match $ \((time, string) :: (String, String)) -> do
-- this is a 'trace' message from the local node tracer
liftIO . hPutStrLn stderr $ time ++ " [trace] " ++ string
loop
, match $ \(ch :: SendPort ()) -> -- a shutdown request
sendChan ch ()
]
-- | Force-close a local node, killing all processes on that node.
closeLocalNode :: LocalNode -> IO ()
closeLocalNode node = do
-- Kill processes after refilling the mvar. Otherwise, there is potential for
-- deadlock as a dying process tries to get the mvar while masking exceptions
-- uninterruptibly.
join $ modifyMVar (localState node) $ \st -> case st of
LocalNodeValid vst -> do
return ( LocalNodeClosed
, forM_ (vst ^. localProcesses) $ \lproc ->
-- Semantics of 'throwTo' guarantee that target thread will get
-- delivered an exception. Therefore, target thread will be
-- killed eventually and that's as good as we can do. No need
-- to wait for thread to actually finish dying.
killThread (processThread lproc)
)
LocalNodeClosed -> return (LocalNodeClosed, return ())
-- This call will have the effect of shutting down the NC as well (see
-- 'createBareLocalNode').
NT.closeEndPoint (localEndPoint node)
-- | Run a process on a local node and wait for it to finish
runProcess :: LocalNode -> Process () -> IO ()
runProcess node proc = do
done <- newEmptyMVar
-- TODO; When forkProcess inherits the masking state, protect the forked
-- thread against async exceptions that could occur before 'try' is evaluated.
void $ forkProcess node $ try proc >>= liftIO . putMVar done
takeMVar done >>= either (throwIO :: SomeException -> IO a) return
-- | Spawn a new process on a local node
forkProcess :: LocalNode -> Process () -> IO ProcessId
forkProcess node proc = do
ms <- getMaskingState
modifyMVarMasked (localState node) (startProcess ms)
where
startProcess :: MaskingState
-> LocalNodeState
-> IO (LocalNodeState, ProcessId)
startProcess ms (LocalNodeValid vst) = do
let lpid = LocalProcessId { lpidCounter = vst ^. localPidCounter
, lpidUnique = vst ^. localPidUnique
}
let pid = ProcessId { processNodeId = localNodeId node
, processLocalId = lpid
}
pst <- newMVar LocalProcessState { _monitorCounter = 0
, _spawnCounter = 0
, _channelCounter = 0
, _typedChannels = Map.empty
}
queue <- newCQueue
weakQueue <- mkWeakCQueue queue (return ())
(_, lproc) <- fixIO $ \ ~(tid, _) -> do
let lproc = LocalProcess { processQueue = queue
, processWeakQ = weakQueue
, processId = pid
, processState = pst
, processThread = tid
, processNode = node
}
-- Rewrite this code when this is fixed:
-- https://ghc.haskell.org/trac/ghc/ticket/10149
let unmask = case ms of
Unmasked -> unblock
MaskedInterruptible -> block
MaskedUninterruptible -> id
tid' <- uninterruptibleMask_ $ forkIO $ do
reason <- Exception.catches
(unmask $ runLocalProcess lproc proc >> return DiedNormal)
[ (Exception.Handler (\ex@(ProcessExitException from msg) -> do
mMsg <- unwrapMessage msg :: IO (Maybe String)
case mMsg of
Nothing -> return $ DiedException $ show ex
Just m -> return $ DiedException ("exit-from=" ++ (show from) ++ ",reason=" ++ m)))
, (Exception.Handler
(return . DiedException . (show :: SomeException -> String)))]
-- [Unified: Table 4, rules termination and exiting]
mconns <- modifyValidLocalState node (cleanupProcess pid)
-- XXX: Revisit after agreeing on the bigger picture for the semantics
-- of transport operations.
-- https://github.com/haskell-distributed/distributed-process/issues/204
forM_ mconns $ forkIO . mapM_ NT.close
writeChan (localCtrlChan node) NCMsg
{ ctrlMsgSender = ProcessIdentifier pid
, ctrlMsgSignal = Died (ProcessIdentifier pid) reason
}
return (tid', lproc)
-- see note [tracer/forkProcess races]
trace node (MxSpawned pid)
if lpidCounter lpid == maxBound
then do
-- TODO: this doesn't look right at all - how do we know
-- that newUnique represents a process id that is available!?
newUnique <- randomIO
return ( LocalNodeValid
$ (localProcessWithId lpid ^= Just lproc)
. (localPidCounter ^= firstNonReservedProcessId)
. (localPidUnique ^= newUnique)
$ vst
, pid
)
else
return ( LocalNodeValid
$ (localProcessWithId lpid ^= Just lproc)
. (localPidCounter ^: (+ 1))
$ vst
, pid
)
startProcess _ LocalNodeClosed =
throwIO $ NodeClosedException $ localNodeId node
cleanupProcess :: ProcessId
-> ValidLocalNodeState
-> IO (ValidLocalNodeState, [NT.Connection])
cleanupProcess pid vst = do
let pid' = ProcessIdentifier pid
let (affected, unaffected) = Map.partitionWithKey (\(fr, _to) !_v -> impliesDeathOf pid' fr) (vst ^. localConnections)
return ( (localProcessWithId (processLocalId pid) ^= Nothing)
. (localConnections ^= unaffected)
$ vst
, map fst $ Map.elems affected
)
-- note [tracer/forkProcess races]
--
-- Our startTracing function uses forkProcess to start the trace controller
-- process, and of course forkProcess attempts to call traceEvent once the
-- process has started. This is harmless, as the localEventBus is not updated
-- until /after/ the initial forkProcess completes, so the first call to
-- traceEvent behaves as if tracing were disabled (i.e., it is ignored).
--
--------------------------------------------------------------------------------
-- Handle incoming messages --
--------------------------------------------------------------------------------
type IncomingConnection = (NT.EndPointAddress, IncomingTarget)
data IncomingTarget =
Uninit
| ToProc ProcessId (Weak (CQueue Message))
| ToChan SendPortId TypedChannel
| ToNode
data ConnectionState = ConnectionState {
_incoming :: !(Map NT.ConnectionId IncomingConnection)
, _incomingFrom :: !(Map NT.EndPointAddress (Set NT.ConnectionId))
}
initConnectionState :: ConnectionState
initConnectionState = ConnectionState {
_incoming = Map.empty
, _incomingFrom = Map.empty
}
incoming :: Accessor ConnectionState (Map NT.ConnectionId IncomingConnection)
incoming = accessor _incoming (\conns st -> st { _incoming = conns })
incomingAt :: NT.ConnectionId -> Accessor ConnectionState (Maybe IncomingConnection)
incomingAt cid = incoming >>> DAC.mapMaybe cid
incomingFrom :: NT.EndPointAddress -> Accessor ConnectionState (Set NT.ConnectionId)
incomingFrom addr = aux >>> DAC.mapDefault Set.empty addr
where
aux = accessor _incomingFrom (\fr st -> st { _incomingFrom = fr })
handleIncomingMessages :: LocalNode -> IO ()
handleIncomingMessages node = go initConnectionState
`Exception.catch` \(NodeClosedException _) -> return ()
where
go :: ConnectionState -> IO ()
go !st = do
event <- NT.receive endpoint
case event of
NT.ConnectionOpened cid rel theirAddr ->
if rel == NT.ReliableOrdered
then
trace node (MxConnected cid theirAddr)
>> go (
(incomingAt cid ^= Just (theirAddr, Uninit))
. (incomingFrom theirAddr ^: Set.insert cid)
$ st
)
else invalidRequest cid st $
"attempt to connect with unsupported reliability " ++ show rel
NT.Received cid payload ->
case st ^. incomingAt cid of
Just (_, ToProc pid weakQueue) -> do
mQueue <- deRefWeak weakQueue
forM_ mQueue $ \queue -> do
-- TODO: if we find that the queue is Nothing, should we remove
-- it from the NC state? (and same for channels, below)
let msg = payloadToMessage payload
enqueue queue msg -- 'enqueue' is strict
trace node (MxReceived pid msg)
go st
Just (_, ToChan chId (TypedChannel chan')) -> do
mChan <- deRefWeak chan'
-- If mChan is Nothing, the process has given up the read end of
-- the channel and we simply ignore the incoming message
forM_ mChan $ \chan -> do
msg' <- atomically $ do
msg <- return $! decode (BSL.fromChunks payload)
-- We make sure the message is fully decoded when it is enqueued
writeTQueue chan msg
return msg
trace node $ MxReceivedPort chId $ unsafeCreateUnencodedMessage msg'
go st
Just (_, ToNode) -> do
let ctrlMsg = decode . BSL.fromChunks $ payload
writeChan ctrlChan $! ctrlMsg
go st
Just (src, Uninit) ->
case decode (BSL.fromChunks payload) of
ProcessIdentifier pid -> do
let lpid = processLocalId pid
mProc <- withValidLocalState node $ return . (^. localProcessWithId lpid)
case mProc of
Just proc ->
go (incomingAt cid ^= Just (src, ToProc pid (processWeakQ proc)) $ st)
Nothing ->
-- incoming attempt to connect to unknown process - might
-- be dead already
go (incomingAt cid ^= Nothing $ st)
SendPortIdentifier chId -> do
let lcid = sendPortLocalId chId
lpid = processLocalId (sendPortProcessId chId)
mProc <- withValidLocalState node $ return . (^. localProcessWithId lpid)
case mProc of
Just proc -> do
mChannel <- withMVar (processState proc) $ return . (^. typedChannelWithId lcid)
case mChannel of
Just channel ->
go (incomingAt cid ^= Just (src, ToChan chId channel) $ st)
Nothing ->
invalidRequest cid st $
"incoming attempt to connect to unknown channel of"
++ " process " ++ show (sendPortProcessId chId)
Nothing ->
-- incoming attempt to connect to channel of unknown
-- process - might be dead already
go (incomingAt cid ^= Nothing $ st)
NodeIdentifier nid ->
if nid == localNodeId node
then go (incomingAt cid ^= Just (src, ToNode) $ st)
else invalidRequest cid st $
"incoming attempt to connect to a different node -"
++ " I'm " ++ show (localNodeId node)
++ " but the remote peer wants to connect to "
++ show nid
Nothing ->
invalidRequest cid st
"message received from an unknown connection"
NT.ConnectionClosed cid ->
case st ^. incomingAt cid of
Nothing ->
invalidRequest cid st "closed unknown connection"
Just (src, _) -> do
trace node (MxDisconnected cid src)
go ( (incomingAt cid ^= Nothing)
. (incomingFrom src ^: Set.delete cid)
$ st
)
NT.ErrorEvent (NT.TransportError (NT.EventConnectionLost theirAddr) _) -> do
-- [Unified table 9, rule node_disconnect]
let nid = NodeIdentifier $ NodeId theirAddr
writeChan ctrlChan NCMsg
{ ctrlMsgSender = nid
, ctrlMsgSignal = Died nid DiedDisconnect
}
let notLost k = not (k `Set.member` (st ^. incomingFrom theirAddr))
closeImplicitReconnections node nid
go ( (incomingFrom theirAddr ^= Set.empty)
. (incoming ^: Map.filterWithKey (const . notLost))
$ st
)
NT.ErrorEvent (NT.TransportError NT.EventEndPointFailed str) ->
fail $ "Cloud Haskell fatal error: end point failed: " ++ str
NT.ErrorEvent (NT.TransportError NT.EventTransportFailed str) ->
fail $ "Cloud Haskell fatal error: transport failed: " ++ str
NT.EndPointClosed ->
return ()
NT.ReceivedMulticast _ _ ->
-- If we received a multicast message, something went horribly wrong
-- and we just give up
fail "Cloud Haskell fatal error: received unexpected multicast"
invalidRequest :: NT.ConnectionId -> ConnectionState -> String -> IO ()
invalidRequest cid st msg = do
-- TODO: We should treat this as a fatal error on the part of the remote
-- node. That is, we should report the remote node as having died, and we
-- should close incoming connections (this requires a Transport layer
-- extension).
traceEventFmtIO node "" [ TraceStr $ " [network] invalid request"
++ " (" ++ msg ++ "): "
, (Trace cid)
]
go ( incomingAt cid ^= Nothing
$ st
)
endpoint = localEndPoint node
ctrlChan = localCtrlChan node
--------------------------------------------------------------------------------
-- Top-level access to the node controller --
--------------------------------------------------------------------------------
runNodeController :: LocalNode -> IO ()
runNodeController node =
runReaderT (evalStateT (unNC nodeController) initNCState) node
`Exception.catch` \(NodeClosedException _) -> return ()
--------------------------------------------------------------------------------
-- Internal data types --
--------------------------------------------------------------------------------
data NCState = NCState
{ -- Mapping from remote processes to linked local processes
_links :: !(BiMultiMap Identifier ProcessId ())
-- Mapping from remote processes to monitoring local processes
, _monitors :: !(BiMultiMap Identifier ProcessId MonitorRef)
-- Process registry: names and where they live, mapped to the PIDs
, _registeredHere :: !(Map String ProcessId)
, _registeredOnNodes :: !(Map ProcessId [(NodeId,Int)])
}
newtype NC a = NC { unNC :: StateT NCState (ReaderT LocalNode IO) a }
deriving ( Applicative
, Functor
, Monad
, MonadIO
, MonadState NCState
, MonadReader LocalNode
)
initNCState :: NCState
initNCState = NCState { _links = BiMultiMap.empty
, _monitors = BiMultiMap.empty
, _registeredHere = Map.empty
, _registeredOnNodes = Map.empty
}
-- | Thrown in response to the user invoking 'kill' (see Primitives.hs). This
-- type is deliberately not exported so it cannot be caught explicitly.
data ProcessKillException =
ProcessKillException !ProcessId !String
deriving (Typeable)
instance Exception ProcessKillException
instance Show ProcessKillException where
show (ProcessKillException pid reason) =
"killed-by=" ++ show pid ++ ",reason=" ++ reason
ncSendToProcess :: ProcessId -> Message -> NC ()
ncSendToProcess = ncSendToProcessAndTrace True
ncSendToProcessAndTrace :: Bool -> ProcessId -> Message -> NC ()
ncSendToProcessAndTrace shouldTrace pid msg = do
node <- ask
if processNodeId pid == localNodeId node
then ncEffectLocalSendAndTrace shouldTrace node pid msg
else liftIO $ sendBinary node
(NodeIdentifier $ localNodeId node)
(NodeIdentifier $ processNodeId pid)
WithImplicitReconnect
NCMsg { ctrlMsgSender = NodeIdentifier $ localNodeId node
, ctrlMsgSignal = UnreliableSend (processLocalId pid) msg
}
ncSendToNode :: NodeId -> NCMsg -> NC ()
ncSendToNode to msg = do
node <- ask
liftIO $ if to == localNodeId node
then writeChan (localCtrlChan node) $! msg
else sendBinary node
(NodeIdentifier $ localNodeId node)
(NodeIdentifier to)
WithImplicitReconnect
msg
--------------------------------------------------------------------------------
-- Tracing/Debugging --
--------------------------------------------------------------------------------
-- [Issue #104 / DP-13]
traceNotifyDied :: LocalNode -> Identifier -> DiedReason -> NC ()
traceNotifyDied node ident reason =
-- TODO: sendPortDied notifications
liftIO $ withLocalTracer node $ \t ->
case ident of
(NodeIdentifier nid) -> traceEvent t (MxNodeDied nid reason)
(ProcessIdentifier pid) -> traceEvent t (MxProcessDied pid reason)
_ -> return ()
traceEventFmtIO :: LocalNode
-> String
-> [TraceArg]
-> IO ()
traceEventFmtIO node fmt args =
withLocalTracer node $ \t -> traceLogFmt t fmt args
trace :: LocalNode -> MxEvent -> IO ()
trace node ev = withLocalTracer node $ \t -> traceEvent t ev
withLocalTracer :: LocalNode -> (MxEventBus -> IO ()) -> IO ()
withLocalTracer node act = act (localEventBus node)
--------------------------------------------------------------------------------
-- Core functionality --
--------------------------------------------------------------------------------
-- [Unified: Table 7]
nodeController :: NC ()
nodeController = do
node <- ask
forever' $ do
msg <- liftIO $ readChan (localCtrlChan node)
-- [Unified: Table 7, rule nc_forward]
case destNid (ctrlMsgSignal msg) of
Just nid' | nid' /= localNodeId node ->
ncSendToNode nid' msg
_ ->
return ()
case msg of
NCMsg (ProcessIdentifier from) (Link them) ->
ncEffectMonitor from them Nothing
NCMsg (ProcessIdentifier from) (Monitor ref) ->
ncEffectMonitor from (monitorRefIdent ref) (Just ref)
NCMsg (ProcessIdentifier from) (Unlink them) ->
ncEffectUnlink from them
NCMsg (ProcessIdentifier from) (Unmonitor ref) ->
ncEffectUnmonitor from ref
NCMsg _from (Died ident reason) ->
ncEffectDied ident reason
NCMsg (ProcessIdentifier from) (Spawn proc ref) ->
ncEffectSpawn from proc ref
NCMsg (ProcessIdentifier from) (Register label atnode pid force) ->
ncEffectRegister from label atnode pid force
NCMsg (ProcessIdentifier from) (WhereIs label) ->
ncEffectWhereIs from label
NCMsg _ (NamedSend label msg') ->
ncEffectNamedSend label msg'
NCMsg _ (UnreliableSend lpid msg') ->
ncEffectLocalSend node (ProcessId (localNodeId node) lpid) msg'
NCMsg _ (LocalSend to msg') ->
ncEffectLocalSend node to msg'
NCMsg _ (LocalPortSend to msg') ->
ncEffectLocalPortSend to msg'
NCMsg (ProcessIdentifier from) (Kill to reason) ->
ncEffectKill from to reason
NCMsg (ProcessIdentifier from) (Exit to reason) ->
ncEffectExit from to reason
NCMsg (ProcessIdentifier from) (GetInfo pid) ->
ncEffectGetInfo from pid
NCMsg _ SigShutdown ->
liftIO $ do
NT.closeEndPoint (localEndPoint node)
`Exception.finally` throwIO (NodeClosedException $ localNodeId node)
NCMsg (ProcessIdentifier from) (GetNodeStats nid) ->
ncEffectGetNodeStats from nid
unexpected ->
error $ "nodeController: unexpected message " ++ show unexpected
-- [Unified: Table 10]
ncEffectMonitor :: ProcessId -- ^ Who's watching?
-> Identifier -- ^ Who's being watched?
-> Maybe MonitorRef -- ^ 'Nothing' to link
-> NC ()
ncEffectMonitor from them mRef = do
node <- ask
shouldLink <-
if not (isLocal node them)
then return True
else isValidLocalIdentifier them
case (shouldLink, isLocal node (ProcessIdentifier from)) of
(True, _) -> -- [Unified: first rule]
case mRef of
Just ref -> modify' $ monitors ^: BiMultiMap.insert them from ref
Nothing -> modify' $ links ^: BiMultiMap.insert them from ()
(False, True) -> -- [Unified: second rule]
notifyDied from them DiedUnknownId mRef
(False, False) -> -- [Unified: third rule]
-- TODO: this is the right sender according to the Unified semantics,
-- but perhaps having 'them' as the sender would make more sense
-- (see also: notifyDied)
ncSendToNode (processNodeId from) $ NCMsg
{ ctrlMsgSender = NodeIdentifier (localNodeId node)
, ctrlMsgSignal = Died them DiedUnknownId
}
-- [Unified: Table 11]
ncEffectUnlink :: ProcessId -> Identifier -> NC ()
ncEffectUnlink from them = do
node <- ask
when (isLocal node (ProcessIdentifier from)) $
case them of
ProcessIdentifier pid ->
postAsMessage from $ DidUnlinkProcess pid
NodeIdentifier nid ->
postAsMessage from $ DidUnlinkNode nid
SendPortIdentifier cid ->
postAsMessage from $ DidUnlinkPort cid
modify' $ links ^: BiMultiMap.delete them from ()
-- [Unified: Table 11]
ncEffectUnmonitor :: ProcessId -> MonitorRef -> NC ()
ncEffectUnmonitor from ref = do
node <- ask
when (isLocal node (ProcessIdentifier from)) $
postAsMessage from $ DidUnmonitor ref
modify' $ monitors ^: BiMultiMap.delete (monitorRefIdent ref) from ref
-- [Unified: Table 12]
ncEffectDied :: Identifier -> DiedReason -> NC ()
ncEffectDied ident reason = do
node <- ask
traceNotifyDied node ident reason
(affectedLinks, unaffectedLinks) <- gets (splitNotif ident . (^. links))
(affectedMons, unaffectedMons) <- gets (splitNotif ident . (^. monitors))
-- _registry :: !(Map (String,NodeId) ProcessId)
let localOnly = case ident of NodeIdentifier _ -> True ; _ -> False
forM_ (Map.toList affectedLinks) $ \(them, uss) ->
forM_ uss $ \(us, _) ->
when (localOnly <= isLocal node (ProcessIdentifier us)) $
notifyDied us them reason Nothing
forM_ (Map.toList affectedMons) $ \(them, refs) ->
forM_ refs $ \(us, ref) ->
when (localOnly <= isLocal node (ProcessIdentifier us)) $
notifyDied us them reason (Just ref)
-- Notify remote nodes that the process died so it can be removed from monitor
-- lists.
mapM_ (forwardDeath node) $
[ nid | ProcessIdentifier pid <- [ident]
, i <- Set.toList $ Set.union
(Set.map fst $ BiMultiMap.lookupBy2nd pid unaffectedLinks)
(Set.map fst $ BiMultiMap.lookupBy2nd pid unaffectedMons)
, let nid = nodeOf i
, nid /= localNodeId node
]
-- Delete monitors in the local node.
let deleteDeads :: (Ord a, Ord v)
=> BiMultiMap a ProcessId v -> BiMultiMap a ProcessId v
deleteDeads = case ident of
-- deleteAllBy2nd is faster than partitionWithKeyBy2nd
ProcessIdentifier pid -> BiMultiMap.deleteAllBy2nd pid
_ -> snd . BiMultiMap.partitionWithKeyBy2nd
(\pid _ -> ident `impliesDeathOf` ProcessIdentifier pid)
unaffectedLinks' = deleteDeads unaffectedLinks
unaffectedMons' = deleteDeads unaffectedMons
modify' $ (links ^= unaffectedLinks') . (monitors ^= unaffectedMons')
-- we now consider all labels for this identifier unregistered
let toDrop pid = not $ ident `impliesDeathOf` ProcessIdentifier pid
(keepNames, dropNames) <- Map.partition toDrop <$> gets (^. registeredHere)
mapM_ (\(p, l) -> liftIO $ trace node (MxUnRegistered l p)) (Map.toList dropNames)
modify' $ registeredHere ^= keepNames
remaining <- fmap Map.toList (gets (^. registeredOnNodes)) >>=
mapM (\(pid,nidlist) ->
case ident `impliesDeathOf` ProcessIdentifier pid of
True ->
do forM_ nidlist $ \(nid,_) ->
when (not $ isLocal node (NodeIdentifier nid))
(forwardDeath node nid)
return Nothing
False -> return $ Just (pid,nidlist) )
modify' $ registeredOnNodes ^= (Map.fromList (catMaybes remaining))
where
forwardDeath node nid = ncSendToNode nid
NCMsg { ctrlMsgSender = NodeIdentifier (localNodeId node)
, ctrlMsgSignal = Died ident reason
}
-- [Unified: Table 13]
ncEffectSpawn :: ProcessId -> Closure (Process ()) -> SpawnRef -> NC ()
ncEffectSpawn pid cProc ref = do
mProc <- unClosure cProc
-- If the closure does not exist, we spawn a process that throws an exception
-- This allows the remote node to find out what's happening
-- TODO:
let proc = case mProc of
Left err -> fail $ "Error: Could not resolve closure: " ++ err
Right p -> p
node <- ask
pid' <- liftIO $ forkProcess node proc
ncSendToProcess pid $ unsafeCreateUnencodedMessage $ DidSpawn ref pid'
-- Unified semantics does not explicitly describe how to implement 'register',
-- but mentions it's "very similar to nsend" (Table 14)
-- We send a response indicated if the operation is invalid
ncEffectRegister :: ProcessId -> String -> NodeId -> Maybe ProcessId -> Bool -> NC ()
ncEffectRegister from label atnode mPid reregistration = do
node <- ask
currentVal <- gets (^. registeredHereFor label)
isOk <-
case mPid of
Nothing -> -- unregister request
return $ isJust currentVal
Just thepid -> -- register request
do isvalidlocal <- isValidLocalIdentifier (ProcessIdentifier thepid)
return $ (isNothing currentVal /= reregistration) &&
(not (isLocal node (ProcessIdentifier thepid) ) || isvalidlocal )
if isLocal node (NodeIdentifier atnode)
then do when isOk $
do modify' $ registeredHereFor label ^= mPid
updateRemote node currentVal mPid
case mPid of
(Just p) -> do
if reregistration
then liftIO $ trace node (MxUnRegistered (fromJust currentVal) label)
else return ()
liftIO $ trace node (MxRegistered p label)
Nothing -> liftIO $ trace node (MxUnRegistered (fromJust currentVal) label)
newVal <- gets (^. registeredHereFor label)
ncSendToProcess from $ unsafeCreateUnencodedMessage $
RegisterReply label isOk newVal
else let operation =
case reregistration of
True -> flip decList
False -> flip incList
in case mPid of
Nothing -> return ()
Just pid -> modify' $ registeredOnNodesFor pid ^: (maybeify $ operation atnode)
where updateRemote node (Just oldval) (Just newval) | processNodeId oldval /= processNodeId newval =
do forward node (processNodeId oldval) (Register label atnode (Just oldval) True)
forward node (processNodeId newval) (Register label atnode (Just newval) False)
updateRemote node Nothing (Just newval) =
forward node (processNodeId newval) (Register label atnode (Just newval) False)
updateRemote node (Just oldval) Nothing =
forward node (processNodeId oldval) (Register label atnode (Just oldval) True)
updateRemote _ _ _ = return ()
maybeify f Nothing = unmaybeify $ f []
maybeify f (Just x) = unmaybeify $ f x
unmaybeify [] = Nothing
unmaybeify x = Just x
incList [] tag = [(tag,1)]
incList ((atag,acount):xs) tag | tag==atag = (atag,acount+1) : xs
incList (x:xs) tag = x : incList xs tag
decList [] _ = []
decList ((atag,1):xs) tag | atag == tag = xs
decList ((atag,n):xs) tag | atag == tag = (atag,n-1):xs
decList (x:xs) tag = x:decList xs tag
forward node to reg =
when (not $ isLocal node (NodeIdentifier to)) $
ncSendToNode to $ NCMsg { ctrlMsgSender = ProcessIdentifier from
, ctrlMsgSignal = reg
}
-- Unified semantics does not explicitly describe 'whereis'
ncEffectWhereIs :: ProcessId -> String -> NC ()
ncEffectWhereIs from label = do
mPid <- gets (^. registeredHereFor label)
ncSendToProcess from $ unsafeCreateUnencodedMessage $ WhereIsReply label mPid
-- [Unified: Table 14]
ncEffectNamedSend :: String -> Message -> NC ()
ncEffectNamedSend label msg = do
mPid <- gets (^. registeredHereFor label)
-- If mPid is Nothing, we just ignore the named send (as per Table 14)
forM_ mPid $ \to ->
-- If this is a trace message we don't trace it to avoid entering a loop
-- where trace messages produce more trace messages.
ncSendToProcessAndTrace (label /= "trace.logger") to msg
-- [Issue #DP-20]
ncEffectLocalSend :: LocalNode -> ProcessId -> Message -> NC ()
ncEffectLocalSend = ncEffectLocalSendAndTrace True
ncEffectLocalSendAndTrace :: Bool -> LocalNode -> ProcessId -> Message -> NC ()
ncEffectLocalSendAndTrace shouldTrace node to msg =
liftIO $ withLocalProc node to $ \p -> do
enqueue (processQueue p) msg
when shouldTrace $ trace node (MxReceived to msg)
-- [Issue #DP-20]
ncEffectLocalPortSend :: SendPortId -> Message -> NC ()
ncEffectLocalPortSend from msg = do
node <- ask
let pid = sendPortProcessId from
cid = sendPortLocalId from
liftIO $ withLocalProc node pid $ \proc -> do
mChan <- withMVar (processState proc) $ return . (^. typedChannelWithId cid)
case mChan of
-- in the unlikely event we know nothing about this channel id,
-- there's little to be done - perhaps some logging/tracing though...
Nothing -> return ()
Just (TypedChannel chan') -> do
-- If ch is Nothing, the process has given up the read end of
-- the channel and we simply ignore the incoming message - this
ch <- deRefWeak chan'
forM_ ch $ \chan -> deliverChan node from msg chan
where deliverChan :: forall a . LocalNode -> SendPortId -> Message -> TQueue a -> IO ()
deliverChan n p (UnencodedMessage _ raw) chan' = do
atomically $ writeTQueue chan' ((unsafeCoerce raw) :: a)
trace n (MxReceivedPort p $ unsafeCreateUnencodedMessage raw)
deliverChan _ _ (EncodedMessage _ _) _ =
-- this will not happen unless someone screws with Primitives.hs
error "invalid local channel delivery"
-- [Issue #69]
ncEffectKill :: ProcessId -> ProcessId -> String -> NC ()
ncEffectKill from to reason = do
node <- ask
when (isLocal node (ProcessIdentifier to)) $
throwException to $ ProcessKillException from reason
-- [Issue #69]
ncEffectExit :: ProcessId -> ProcessId -> Message -> NC ()
ncEffectExit from to reason = do
node <- ask
when (isLocal node (ProcessIdentifier to)) $
throwException to $ ProcessExitException from reason
-- [Issue #89]
ncEffectGetInfo :: ProcessId -> ProcessId -> NC ()
ncEffectGetInfo from pid =
let lpid = processLocalId pid
them = (ProcessIdentifier pid)
in do
node <- ask
mProc <- liftIO $ withValidLocalState node
$ return . (^. localProcessWithId lpid)
case mProc of
Nothing -> dispatch (isLocal node (ProcessIdentifier from))
from (ProcessInfoNone DiedUnknownId)
Just proc -> do
itsLinks <- Set.map fst . BiMultiMap.lookupBy1st them <$>
gets (^. links)
itsMons <- BiMultiMap.lookupBy1st them <$> gets (^. monitors)
registered <- gets (^. registeredHere)
size <- liftIO $ queueSize $ processQueue $ proc
let reg = registeredNames registered
dispatch (isLocal node (ProcessIdentifier from))
from
ProcessInfo {
infoNode = (processNodeId pid)
, infoRegisteredNames = reg
, infoMessageQueueLength = size
, infoMonitors = Set.toList itsMons
, infoLinks = Set.toList itsLinks
}
where dispatch :: (Serializable a)
=> Bool
-> ProcessId
-> a
-> NC ()
dispatch True dest pInfo = postAsMessage dest $ pInfo
dispatch False dest pInfo =
ncSendToProcess dest $ unsafeCreateUnencodedMessage pInfo
registeredNames = Map.foldlWithKey (\ks k v -> if v == pid
then (k:ks)
else ks) []
ncEffectGetNodeStats :: ProcessId -> NodeId -> NC ()
ncEffectGetNodeStats from _nid = do
node <- ask
ncState <- StateT.get
nodeState <- liftIO $ withValidLocalState node return
let stats =
NodeStats {
nodeStatsNode = localNodeId node
, nodeStatsRegisteredNames = Map.size $ ncState ^. registeredHere
, nodeStatsMonitors = BiMultiMap.size $ ncState ^. monitors
, nodeStatsLinks = BiMultiMap.size $ ncState ^. links
, nodeStatsProcesses = Map.size (nodeState ^. localProcesses)
}
postAsMessage from stats
--------------------------------------------------------------------------------
-- Auxiliary --
--------------------------------------------------------------------------------
notifyDied :: ProcessId -- ^ Who to notify?
-> Identifier -- ^ Who died?
-> DiedReason -- ^ How did they die?
-> Maybe MonitorRef -- ^ 'Nothing' for linking
-> NC ()
notifyDied dest src reason mRef = do
node <- ask
case (isLocal node (ProcessIdentifier dest), mRef, src) of
(True, Just ref, ProcessIdentifier pid) ->
postAsMessage dest $ ProcessMonitorNotification ref pid reason
(True, Just ref, NodeIdentifier nid) ->
postAsMessage dest $ NodeMonitorNotification ref nid reason
(True, Just ref, SendPortIdentifier cid) ->
postAsMessage dest $ PortMonitorNotification ref cid reason
(True, Nothing, ProcessIdentifier pid) ->
throwException dest $ ProcessLinkException pid reason
(True, Nothing, NodeIdentifier pid) ->
throwException dest $ NodeLinkException pid reason
(True, Nothing, SendPortIdentifier pid) ->
throwException dest $ PortLinkException pid reason
(False, _, _) ->
-- The change in sender comes from [Unified: Table 10]
ncSendToNode (processNodeId dest) $ NCMsg
{ ctrlMsgSender = NodeIdentifier (localNodeId node)
, ctrlMsgSignal = Died src reason
}
-- | [Unified: Table 8]
destNid :: ProcessSignal -> Maybe NodeId
destNid (Link ident) = Just $ nodeOf ident
destNid (Unlink ident) = Just $ nodeOf ident
destNid (Monitor ref) = Just $ nodeOf (monitorRefIdent ref)
destNid (Unmonitor ref) = Just $ nodeOf (monitorRefIdent ref)
destNid (Spawn _ _) = Nothing
destNid (Register _ _ _ _) = Nothing
destNid (WhereIs _) = Nothing
destNid (NamedSend _ _) = Nothing
destNid (UnreliableSend _ _) = Nothing
-- We don't need to forward 'Died' signals; if monitoring/linking is setup,
-- then when a local process dies the monitoring/linking machinery will take
-- care of notifying remote nodes
destNid (Died _ _) = Nothing
destNid (Kill pid _) = Just $ processNodeId pid
destNid (Exit pid _) = Just $ processNodeId pid
destNid (GetInfo pid) = Just $ processNodeId pid
destNid (GetNodeStats nid) = Just nid
destNid (LocalSend pid _) = Just $ processNodeId pid
destNid (LocalPortSend cid _) = Just $ processNodeId (sendPortProcessId cid)
destNid (SigShutdown) = Nothing
-- | Check if a process is local to our own node
isLocal :: LocalNode -> Identifier -> Bool
isLocal nid ident = nodeOf ident == localNodeId nid
-- | Lookup a local closure
unClosure :: Typeable a => Closure a -> NC (Either String a)
unClosure closure = do
rtable <- remoteTable <$> ask
return (Static.unclosure rtable closure)
-- | Check if an identifier refers to a valid local object
isValidLocalIdentifier :: Identifier -> NC Bool
isValidLocalIdentifier ident = do
node <- ask
liftIO . withValidLocalState node $ \nSt ->
case ident of
NodeIdentifier nid ->
return $ nid == localNodeId node
ProcessIdentifier pid -> do
let mProc = nSt ^. localProcessWithId (processLocalId pid)
return $ isJust mProc
SendPortIdentifier cid -> do
let pid = sendPortProcessId cid
mProc = nSt ^. localProcessWithId (processLocalId pid)
case mProc of
Nothing -> return False
Just proc -> withMVar (processState proc) $ \pSt -> do
let mCh = pSt ^. typedChannelWithId (sendPortLocalId cid)
return $ isJust mCh
--------------------------------------------------------------------------------
-- Messages to local processes --
--------------------------------------------------------------------------------
postAsMessage :: Serializable a => ProcessId -> a -> NC ()
postAsMessage pid = postMessage pid . createUnencodedMessage
postMessage :: ProcessId -> Message -> NC ()
postMessage pid msg = do
node <- ask
liftIO $ withLocalProc node pid $ \p -> enqueue (processQueue p) msg
throwException :: Exception e => ProcessId -> e -> NC ()
throwException pid e = do
node <- ask
-- throwTo blocks until the exception is received by the target thread.
-- We cannot easily make it happen asynchronpusly because then 'unlink'
-- semantics would break.
liftIO $ withLocalProc node pid $ \p -> throwTo (processThread p) e
withLocalProc :: LocalNode -> ProcessId -> (LocalProcess -> IO ()) -> IO ()
withLocalProc node pid p =
-- By [Unified: table 6, rule missing_process] messages to dead processes
-- can silently be dropped
let lpid = processLocalId pid in do
join $ withValidLocalState node $ \vst ->
return $ forM_ (vst ^. localProcessWithId lpid) p
--------------------------------------------------------------------------------
-- Accessors --
--------------------------------------------------------------------------------
links :: Accessor NCState (BiMultiMap Identifier ProcessId ())
links = accessor _links (\ls st -> st { _links = ls })
monitors :: Accessor NCState (BiMultiMap Identifier ProcessId MonitorRef)
monitors = accessor _monitors (\ms st -> st { _monitors = ms })
registeredHere :: Accessor NCState (Map String ProcessId)
registeredHere = accessor _registeredHere (\ry st -> st { _registeredHere = ry })
registeredOnNodes :: Accessor NCState (Map ProcessId [(NodeId, Int)])
registeredOnNodes = accessor _registeredOnNodes (\ry st -> st { _registeredOnNodes = ry })
registeredHereFor :: String -> Accessor NCState (Maybe ProcessId)
registeredHereFor ident = registeredHere >>> DAC.mapMaybe ident
registeredOnNodesFor :: ProcessId -> Accessor NCState (Maybe [(NodeId,Int)])
registeredOnNodesFor ident = registeredOnNodes >>> DAC.mapMaybe ident
-- | @splitNotif ident@ splits a notifications map into those
-- notifications that should trigger when 'ident' fails and those links that
-- should not.
--
-- There is a hierarchy between identifiers: failure of a node implies failure
-- of all processes on that node, and failure of a process implies failure of
-- all typed channels to that process. In other words, if 'ident' refers to a
-- node, then the /should trigger/ set will include
--
-- * the notifications for the node specifically
-- * the notifications for processes on that node, and
-- * the notifications for typed channels to processes on that node.
--
-- Similarly, if 'ident' refers to a process, the /should trigger/ set will
-- include
--
-- * the notifications for that process specifically and
-- * the notifications for typed channels to that process.
--
-- See https://github.com/haskell/containers/issues/14 for the bang on _v.
splitNotif :: (Ord a, Ord v)
=> Identifier
-> BiMultiMap Identifier a v
-> (Map Identifier (Set (a,v)), BiMultiMap Identifier a v)
splitNotif ident =
BiMultiMap.partitionWithKeyBy1st (\k !_v -> ident `impliesDeathOf` k)
--------------------------------------------------------------------------------
-- Auxiliary --
--------------------------------------------------------------------------------
-- | Modify and evaluate the state
modify' :: MonadState s m => (s -> s) -> m ()
modify' f = StateT.get >>= \s -> StateT.put $! f s