@@ -1,3 +1,12 @@
2+{-# LANGUAGE DeriveDataTypeable #-}
3+{-# LANGUAGE ScopedTypeVariables #-}
4+{-# LANGUAGE RankNTypes #-}
5+{-# LANGUAGE BangPatterns #-}
6+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7+{-# LANGUAGE RecordWildCards #-}
8+{-# LANGUAGE MagicHash #-}
1-- | Local nodes
10-- | Local nodes
3module Control.Distributed.Process.Node
12module Control.Distributed.Process.Node
@@ -12,10 +21,6 @@ module Control.Distributed.Process.Node
13-- TODO: Calls to 'sendBinary' and co (by the NC) may stall the node controller.
22-- TODO: Calls to 'sendBinary' and co (by the NC) may stall the node controller.
15−#if ! MIN_VERSION_base(4,6,0)
16−import Prelude hiding (catch)
19import System.IO (fixIO, hPutStrLn, stderr)
24import System.IO (fixIO, hPutStrLn, stderr)
20import System.Mem.Weak (Weak, deRefWeak)
25import System.Mem.Weak (Weak, deRefWeak)
21import qualified Data.ByteString.Lazy as BSL (fromChunks)
26import qualified Data.ByteString.Lazy as BSL (fromChunks)
@@ -23,51 +28,73 @@ import Data.Binary (decode)
23import Data.Map (Map)
28import Data.Map (Map)
24import qualified Data.Map as Map
29import qualified Data.Map as Map
27 , fromList
33 , fromList
29 , partitionWithKey
37 , partitionWithKey
31 , filterWithKey
40 , filterWithKey
32 , foldlWithKey
41 , foldlWithKey
43+import Data.Time.Format (formatTime)
44+#if MIN_VERSION_time(1,5,0)
45+import Data.Time.Format (defaultTimeLocale)
47+import System.Locale (defaultTimeLocale)
34import Data.Set (Set)
49import Data.Set (Set)
35import qualified Data.Set as Set
50import qualified Data.Set as Set
42import Data.Foldable (forM_)
59import Data.Foldable (forM_)
43−import Data.Maybe (isJust, isNothing, catMaybes)
60+import Data.Maybe (isJust, fromJust, isNothing, catMaybes)
44import Data.Typeable (Typeable)
61import Data.Typeable (Typeable)
45import Control.Category ((>>>))
62import Control.Category ((>>>))
46−import Control.Applicative ((<$>))
63+import Control.Applicative
47−import Control.Monad (void, when)
64+import Control.Monad (void, when, join)
48import Control.Monad.IO.Class (MonadIO, liftIO)
65import Control.Monad.IO.Class (MonadIO, liftIO)
49import Control.Monad.State.Strict (MonadState, StateT, evalStateT, gets)
66import Control.Monad.State.Strict (MonadState, StateT, evalStateT, gets)
50import qualified Control.Monad.State.Strict as StateT (get, put)
67import qualified Control.Monad.State.Strict as StateT (get, put)
51import Control.Monad.Reader (MonadReader, ReaderT, runReaderT, ask)
68import Control.Monad.Reader (MonadReader, ReaderT, runReaderT, ask)
52import Control.Exception
69import Control.Exception
54− , AsyncException(ThreadKilled)
55 , SomeException
71 , SomeException
56 , Exception
72 , Exception
74+ , uninterruptibleMask_
59−import qualified Control.Exception as Exception (catch)
78+import qualified Control.Exception as Exception
60−import Control.Concurrent (forkIO)
84+import Control.Concurrent (forkIO, killThread)
85+import Control.Distributed.Process.Internal.BiMultiMap (BiMultiMap)
86+import qualified Control.Distributed.Process.Internal.BiMultiMap as BiMultiMap
61import Control.Distributed.Process.Internal.StrictMVar
87import Control.Distributed.Process.Internal.StrictMVar
63 , withMVar
89 , withMVar
64 , modifyMVar
91 , modifyMVar
66 , newEmptyMVar
92 , newEmptyMVar
68 , takeMVar
94 , takeMVar
70import Control.Concurrent.Chan (newChan, writeChan, readChan)
96import Control.Concurrent.Chan (newChan, writeChan, readChan)
97+import qualified Control.Concurrent.MVar as MVar (newEmptyMVar, takeMVar)
71import Control.Concurrent.STM
98import Control.Concurrent.STM
72 ( atomically
99 ( atomically
@@ -76,6 +103,7 @@ import Control.Distributed.Process.Internal.CQueue
76 , enqueue
103 , enqueue
77 , newCQueue
104 , newCQueue
78 , mkWeakCQueue
105 , mkWeakCQueue
80import qualified Network.Transport as NT
108import qualified Network.Transport as NT
81 ( Transport
109 ( Transport
@@ -87,8 +115,8 @@ import qualified Network.Transport as NT
87 , TransportError(..)
115 , TransportError(..)
88 , address
116 , address
89 , closeEndPoint
117 , closeEndPoint
91 , Connection
118 , Connection
93 , EndPointAddress
121 , EndPointAddress
94 , Reliability(ReliableOrdered)
122 , Reliability(ReliableOrdered)
@@ -105,8 +133,11 @@ import Control.Distributed.Process.Internal.Types
105 , LocalProcessId(..)
133 , LocalProcessId(..)
106 , ProcessId(..)
134 , ProcessId(..)
107 , LocalNode(..)
135 , LocalNode(..)
108− , Tracer(InactiveTracer)
136+ , MxEventBus(..)
109 , LocalNodeState(..)
137 , LocalNodeState(..)
138+ , ValidLocalNodeState(..)
139+ , withValidLocalState
140+ , modifyValidLocalState
110 , LocalProcess(..)
141 , LocalProcess(..)
111 , LocalProcessState(..)
142 , LocalProcessState(..)
112 , Process(..)
143 , Process(..)
@@ -116,9 +147,11 @@ import Control.Distributed.Process.Internal.Types
116 , localPidCounter
147 , localPidCounter
117 , localPidUnique
148 , localPidUnique
118 , localProcessWithId
149 , localProcessWithId
119 , localConnections
151 , localConnections
120 , forever'
152 , forever'
121 , MonitorRef(..)
153 , MonitorRef(..)
154+ , NodeClosedException(..)
122 , ProcessMonitorNotification(..)
155 , ProcessMonitorNotification(..)
123 , NodeMonitorNotification(..)
156 , NodeMonitorNotification(..)
124 , PortMonitorNotification(..)
157 , PortMonitorNotification(..)
@@ -132,58 +165,87 @@ import Control.Distributed.Process.Internal.Types
132 , DidUnlinkPort(..)
165 , DidUnlinkPort(..)
133 , SpawnRef
166 , SpawnRef
134 , DidSpawn(..)
167 , DidSpawn(..)
135− , Message
168+ , Message(..)
136 , TypedChannel(..)
169 , TypedChannel(..)
137 , Identifier(..)
170 , Identifier(..)
139 , ProcessInfo(..)
172 , ProcessInfo(..)
140 , ProcessInfoNone(..)
173 , ProcessInfoNone(..)
141 , SendPortId(..)
175 , SendPortId(..)
142 , typedChannelWithId
176 , typedChannelWithId
143 , RegisterReply(..)
177 , RegisterReply(..)
144 , WhereIsReply(..)
178 , WhereIsReply(..)
146 , payloadToMessage
179 , payloadToMessage
147− , createMessage
180+ , createUnencodedMessage
181+ , unsafeCreateUnencodedMessage
148 , runLocalProcess
182 , runLocalProcess
149 , firstNonReservedProcessId
183 , firstNonReservedProcessId
150− , ImplicitReconnect(WithImplicitReconnect, NoImplicitReconnect)
184+ , ImplicitReconnect(WithImplicitReconnect)
186+import Control.Distributed.Process.Management.Internal.Agent
189+import Control.Distributed.Process.Management.Internal.Types
192+import qualified Control.Distributed.Process.Management.Internal.Trace.Remote as Trace
152−import Control.Distributed.Process.Internal.Trace
195+import Control.Distributed.Process.Management.Internal.Trace.Tracer
198+import Control.Distributed.Process.Management.Internal.Trace.Types
153 ( TraceArg(..)
199 ( TraceArg(..)
154− , traceFormat
200+ , traceEvent
155− , startTracing
201+ , traceLogFmt
156− , stopTracer
202+ , enableTrace
158import Control.Distributed.Process.Serializable (Serializable)
204import Control.Distributed.Process.Serializable (Serializable)
159import Control.Distributed.Process.Internal.Messaging
205import Control.Distributed.Process.Internal.Messaging
160 ( sendBinary
206 ( sendBinary
163 , closeImplicitReconnections
207 , closeImplicitReconnections
164 , impliesDeathOf
208 , impliesDeathOf
166import Control.Distributed.Process.Internal.Primitives
210import Control.Distributed.Process.Internal.Primitives
167 ( register
211 ( register
169 , receiveWait
212 , receiveWait
171 , sendChan
214 , sendChan
173−import Control.Distributed.Process.Internal.Types (SendPort)
221+import Control.Distributed.Process.Internal.Types (SendPort, Tracer(..))
174import qualified Control.Distributed.Process.Internal.Closure.BuiltIn as BuiltIn (remoteTable)
222import qualified Control.Distributed.Process.Internal.Closure.BuiltIn as BuiltIn (remoteTable)
175−import Control.Distributed.Process.Internal.WeakTQueue (writeTQueue)
223+import Control.Distributed.Process.Internal.WeakTQueue (TQueue, writeTQueue)
176import qualified Control.Distributed.Process.Internal.StrictContainerAccessors as DAC
224import qualified Control.Distributed.Process.Internal.StrictContainerAccessors as DAC
177 ( mapMaybe
225 ( mapMaybe
178 , mapDefault
226 , mapDefault
228+import Control.Monad.Catch (try)
229+import GHC.IO (IO(..), unsafeUnmask)
230+import GHC.Base ( maskAsyncExceptions# )
235+-- Remove these definitions when the fix for
236+-- https://ghc.haskell.org/trac/ghc/ticket/10149
237+-- is included in all supported compilers:
238+block :: IO a -> IO a
239+block (IO io) = IO $ maskAsyncExceptions# io
240+unblock :: IO a -> IO a
241+unblock = unsafeUnmask
181--------------------------------------------------------------------------------
243--------------------------------------------------------------------------------
182-- Initialization --
244-- Initialization --
183--------------------------------------------------------------------------------
245--------------------------------------------------------------------------------
185initRemoteTable :: RemoteTable
247initRemoteTable :: RemoteTable
186−initRemoteTable = BuiltIn.remoteTable Static.initRemoteTable
248+initRemoteTable = Trace.remoteTable $ BuiltIn.remoteTable Static.initRemoteTable
188-- | Initialize a new local node.
250-- | Initialize a new local node.
189newLocalNode :: NT.Transport -> RemoteTable -> IO LocalNode
251newLocalNode :: NT.Transport -> RemoteTable -> IO LocalNode
@@ -200,7 +262,7 @@ newLocalNode transport rtable = do
200createBareLocalNode :: NT.EndPoint -> RemoteTable -> IO LocalNode
262createBareLocalNode :: NT.EndPoint -> RemoteTable -> IO LocalNode
201createBareLocalNode endPoint rtable = do
263createBareLocalNode endPoint rtable = do
202 unq <- randomIO
264 unq <- randomIO
203− state <- newMVar LocalNodeState
265+ state <- newMVar $ LocalNodeValid $ ValidLocalNodeState
204 { _localProcesses = Map.empty
266 { _localProcesses = Map.empty
205 , _localPidCounter = firstNonReservedProcessId
267 , _localPidCounter = firstNonReservedProcessId
206 , _localPidUnique = unq
268 , _localPidUnique = unq
@@ -211,22 +273,19 @@ createBareLocalNode endPoint rtable = do
211 , localEndPoint = endPoint
273 , localEndPoint = endPoint
212 , localState = state
274 , localState = state
213 , localCtrlChan = ctrlChan
275 , localCtrlChan = ctrlChan
214− , localTracer = InactiveTracer
276+ , localEventBus = MxEventBusInitialising
215 , remoteTable = rtable
277 , remoteTable = rtable
217− tracedNode <- startTracing node
279+ tracedNode <- startMxAgent node
219− ncGo <- newEmptyMVar
281+ -- Once the NC terminates, the endpoint isn't much use,
220− ncTid <- forkIO $ do
221− tid <- takeMVar ncGo
222− (runNodeController tracedNode
282+ void $ forkIO $ Exception.finally (runNodeController tracedNode)
223− `Exception.catch` \(e :: SomeException) -> throwTo tid e)
283+ (NT.closeEndPoint (localEndPoint node))
225− evTid <- forkIO $ do
285+ -- whilst a closed/failing endpoint will terminate the NC
226− (handleIncomingMessages tracedNode >> (stopNC node))
286+ void $ forkIO $ Exception.finally (handleIncomingMessages tracedNode)
227− `Exception.catch` \(e :: SomeException) -> throwTo ncTid e
287+ (stopNC node)
230 return tracedNode
289 return tracedNode
232 stopNC node =
291 stopNC node =
@@ -235,48 +294,100 @@ createBareLocalNode endPoint rtable = do
235 , ctrlMsgSignal = SigShutdown
294 , ctrlMsgSignal = SigShutdown
297+startMxAgent :: LocalNode -> IO LocalNode
298+startMxAgent node = do
299+ -- see note [tracer/forkProcess races]
300+ let fork = forkProcess node
301+ mv <- MVar.newEmptyMVar
302+ pid <- fork $ mxAgentController fork mv
303+ (tracer', wqRef, mxNew') <- MVar.takeMVar mv
304+ return node { localEventBus = (MxEventBus pid tracer' wqRef mxNew') }
306+startDefaultTracer :: LocalNode -> IO ()
307+startDefaultTracer node' = do
308+ let t = localEventBus node'
310+ MxEventBus _ (Tracer pid _) _ _ -> do
311+ runProcess node' $ register "trace.controller" pid
312+ pid' <- forkProcess node' defaultTracer
313+ enableTrace (localEventBus node') pid'
314+ runProcess node' $ register "tracer.initial" pid'
317+-- TODO: we need a better mechanism for defining and registering services
238-- | Start and register the service processes on a node
319-- | Start and register the service processes on a node
239−-- (for now, this is only the logger)
240startServiceProcesses :: LocalNode -> IO ()
320startServiceProcesses :: LocalNode -> IO ()
241startServiceProcesses node = do
321startServiceProcesses node = do
322+ -- tracing /spawns/ relies on the tracer being enabled, but we start
323+ -- the default tracer first, even though it might @nsend@ to the logger
324+ -- before /that/ process has started - this is a totally harmless race
325+ -- however, so we deliberably ignore it
326+ startDefaultTracer node
242 logger <- forkProcess node loop
327 logger <- forkProcess node loop
328+ runProcess node $ do
329+ register "logger" logger
330+ -- The trace.logger is used for tracing to the console to avoid feedback
331+ -- loops during tracing if the user reregisters the "logger" with a custom
332+ -- process which uses 'send' or other primitives which are traced.
243− runProcess node $ register "logger" logger
333+ register "trace.logger" logger
245− loop = do
335+ loop = do
246− receiveWait
336+ receiveWait
247− [ match $ \((time, pid, string) ::(String, ProcessId, String)) -> do
337+ [ match $ \(SayMessage time pid string) -> do
338+ let time' = formatTime defaultTimeLocale "%c" time
248− liftIO . hPutStrLn stderr $ time ++ " " ++ show pid ++ ": " ++ string
339+ liftIO . hPutStrLn stderr $ time' ++ " " ++ show pid ++ ": " ++ string
250− , match $ \((time, string) :: (String, String)) -> do
341+ , match $ \((time, string) :: (String, String)) -> do
251− -- this is a 'trace' message from the local node tracer
342+ -- this is a 'trace' message from the local node tracer
252− liftIO . hPutStrLn stderr $ time ++ " [trace] " ++ string
343+ liftIO . hPutStrLn stderr $ time ++ " [trace] " ++ string
254− , match $ \(ch :: SendPort ()) -> -- a shutdown request
345+ , match $ \(ch :: SendPort ()) -> -- a shutdown request
255− sendChan ch ()
346+ sendChan ch ()
258−-- | Force-close a local node
349+-- | Force-close a local node, killing all processes on that node.
260−-- TODO: for now we just close the associated endpoint
261closeLocalNode :: LocalNode -> IO ()
350closeLocalNode :: LocalNode -> IO ()
262−closeLocalNode node =
351+closeLocalNode node = do
352+ -- Kill processes after refilling the mvar. Otherwise, there is potential for
353+ -- deadlock as a dying process tries to get the mvar while masking exceptions
355+ join $ modifyMVar (localState node) $ \st -> case st of
356+ LocalNodeValid vst -> do
357+ return ( LocalNodeClosed
358+ , forM_ (vst ^. localProcesses) $ \lproc ->
359+ -- Semantics of 'throwTo' guarantee that target thread will get
360+ -- delivered an exception. Therefore, target thread will be
361+ -- killed eventually and that's as good as we can do. No need
362+ -- to wait for thread to actually finish dying.
363+ killThread (processThread lproc)
365+ LocalNodeClosed -> return (LocalNodeClosed, return ())
366+ -- This call will have the effect of shutting down the NC as well (see
367+ -- 'createBareLocalNode').
263 NT.closeEndPoint (localEndPoint node)
368 NT.closeEndPoint (localEndPoint node)
265-- | Run a process on a local node and wait for it to finish
370-- | Run a process on a local node and wait for it to finish
266runProcess :: LocalNode -> Process () -> IO ()
371runProcess :: LocalNode -> Process () -> IO ()
267runProcess node proc = do
372runProcess node proc = do
268 done <- newEmptyMVar
373 done <- newEmptyMVar
374+ -- TODO; When forkProcess inherits the masking state, protect the forked
375+ -- thread against async exceptions that could occur before 'try' is evaluated.
269− void $ forkProcess node (proc `finally` liftIO (putMVar done ()))
376+ void $ forkProcess node $ try proc >>= liftIO . putMVar done
270− takeMVar done
377+ takeMVar done >>= either (throwIO :: SomeException -> IO a) return
272-- | Spawn a new process on a local node
379-- | Spawn a new process on a local node
273forkProcess :: LocalNode -> Process () -> IO ProcessId
380forkProcess :: LocalNode -> Process () -> IO ProcessId
381+forkProcess node proc = do
382+ ms <- getMaskingState
274−forkProcess node proc = modifyMVar (localState node) startProcess
383+ modifyMVarMasked (localState node) (startProcess ms)
385+ startProcess :: MaskingState
276− startProcess :: LocalNodeState -> IO (LocalNodeState, ProcessId)
387+ -> IO (LocalNodeState, ProcessId)
277− startProcess st = do
388+ startProcess ms (LocalNodeValid vst) = do
278− let lpid = LocalProcessId { lpidCounter = st ^. localPidCounter
389+ let lpid = LocalProcessId { lpidCounter = vst ^. localPidCounter
279− , lpidUnique = st ^. localPidUnique
390+ , lpidUnique = vst ^. localPidUnique
281 let pid = ProcessId { processNodeId = localNodeId node
392 let pid = ProcessId { processNodeId = localNodeId node
282 , processLocalId = lpid
393 , processLocalId = lpid
@@ -296,43 +407,81 @@ forkProcess node proc = modifyMVar (localState node) startProcess
296 , processThread = tid
407 , processThread = tid
297 , processNode = node
408 , processNode = node
410+ -- Rewrite this code when this is fixed:
411+ -- https://ghc.haskell.org/trac/ghc/ticket/10149
412+ let unmask = case ms of
414+ MaskedInterruptible -> block
415+ MaskedUninterruptible -> id
299− tid' <- forkIO $ do
416+ tid' <- uninterruptibleMask_ $ forkIO $ do
300− reason <- Exception.catch
417+ reason <- Exception.catches
301− (runLocalProcess lproc proc >> return DiedNormal)
418+ (unmask $ runLocalProcess lproc proc >> return DiedNormal)
419+ [ (Exception.Handler (\ex@(ProcessExitException from msg) -> do
420+ mMsg <- unwrapMessage msg :: IO (Maybe String)
422+ Nothing -> return $ DiedException $ show ex
423+ Just m -> return $ DiedException ("exit-from=" ++ (show from) ++ ",reason=" ++ m)))
424+ , (Exception.Handler
302− (return . DiedException . (show :: SomeException -> String))
425+ (return . DiedException . (show :: SomeException -> String)))]
304 -- [Unified: Table 4, rules termination and exiting]
427 -- [Unified: Table 4, rules termination and exiting]
305− modifyMVar_ (localState node) (cleanupProcess pid)
428+ mconns <- modifyValidLocalState node (cleanupProcess pid)
429+ -- XXX: Revisit after agreeing on the bigger picture for the semantics
430+ -- of transport operations.
431+ -- https://github.com/haskell-distributed/distributed-process/issues/204
432+ forM_ mconns $ forkIO . mapM_ NT.close
306 writeChan (localCtrlChan node) NCMsg
434 writeChan (localCtrlChan node) NCMsg
307 { ctrlMsgSender = ProcessIdentifier pid
435 { ctrlMsgSender = ProcessIdentifier pid
308 , ctrlMsgSignal = Died (ProcessIdentifier pid) reason
436 , ctrlMsgSignal = Died (ProcessIdentifier pid) reason
310 return (tid', lproc)
438 return (tid', lproc)
440+ -- see note [tracer/forkProcess races]
441+ trace node (MxSpawned pid)
312 if lpidCounter lpid == maxBound
443 if lpidCounter lpid == maxBound
445+ -- TODO: this doesn't look right at all - how do we know
446+ -- that newUnique represents a process id that is available!?
314 newUnique <- randomIO
447 newUnique <- randomIO
448+ return ( LocalNodeValid
315− return ( (localProcessWithId lpid ^= Just lproc)
449+ $ (localProcessWithId lpid ^= Just lproc)
316 . (localPidCounter ^= firstNonReservedProcessId)
450 . (localPidCounter ^= firstNonReservedProcessId)
317 . (localPidUnique ^= newUnique)
451 . (localPidUnique ^= newUnique)
456+ return ( LocalNodeValid
322− return ( (localProcessWithId lpid ^= Just lproc)
457+ $ (localProcessWithId lpid ^= Just lproc)
323 . (localPidCounter ^: (+ 1))
458 . (localPidCounter ^: (+ 1))
462+ startProcess _ LocalNodeClosed =
463+ throwIO $ NodeClosedException $ localNodeId node
328− cleanupProcess :: ProcessId -> LocalNodeState -> IO LocalNodeState
465+ cleanupProcess :: ProcessId
466+ -> ValidLocalNodeState
467+ -> IO (ValidLocalNodeState, [NT.Connection])
329− cleanupProcess pid st = do
468+ cleanupProcess pid vst = do
330 let pid' = ProcessIdentifier pid
469 let pid' = ProcessIdentifier pid
331− let (affected, unaffected) = Map.partitionWithKey (\(fr, _to) !_v -> impliesDeathOf pid' fr) (st ^. localConnections)
470+ let (affected, unaffected) = Map.partitionWithKey (\(fr, _to) !_v -> impliesDeathOf pid' fr) (vst ^. localConnections)
332− mapM_ (NT.close . fst) (Map.elems affected)
333− return $ (localProcessWithId (processLocalId pid) ^= Nothing)
471+ return ( (localProcessWithId (processLocalId pid) ^= Nothing)
334− . (localConnections ^= unaffected)
472+ . (localConnections ^= unaffected)
474+ , map fst $ Map.elems affected
477+-- note [tracer/forkProcess races]
479+-- Our startTracing function uses forkProcess to start the trace controller
480+-- process, and of course forkProcess attempts to call traceEvent once the
481+-- process has started. This is harmless, as the localEventBus is not updated
482+-- until /after/ the initial forkProcess completes, so the first call to
483+-- traceEvent behaves as if tracing were disabled (i.e., it is ignored).
337--------------------------------------------------------------------------------
486--------------------------------------------------------------------------------
338-- Handle incoming messages --
487-- Handle incoming messages --
@@ -342,8 +491,8 @@ type IncomingConnection = (NT.EndPointAddress, IncomingTarget)
343data IncomingTarget =
492data IncomingTarget =
345− | ToProc (Weak (CQueue Message))
494+ | ToProc ProcessId (Weak (CQueue Message))
346− | ToChan TypedChannel
495+ | ToChan SendPortId TypedChannel
349data ConnectionState = ConnectionState {
498data ConnectionState = ConnectionState {
@@ -370,6 +519,7 @@ incomingFrom addr = aux >>> DAC.mapDefault Set.empty addr
371handleIncomingMessages :: LocalNode -> IO ()
520handleIncomingMessages :: LocalNode -> IO ()
372handleIncomingMessages node = go initConnectionState
521handleIncomingMessages node = go initConnectionState
522+ `Exception.catch` \(NodeClosedException _) -> return ()
374 go :: ConnectionState -> IO ()
524 go :: ConnectionState -> IO ()
375 go !st = do
525 go !st = do
@@ -377,28 +527,37 @@ handleIncomingMessages node = go initConnectionState
377 case event of
527 case event of
378 NT.ConnectionOpened cid rel theirAddr ->
528 NT.ConnectionOpened cid rel theirAddr ->
379 if rel == NT.ReliableOrdered
529 if rel == NT.ReliableOrdered
531+ trace node (MxConnected cid theirAddr)
380− then go ( (incomingAt cid ^= Just (theirAddr, Uninit))
533+ (incomingAt cid ^= Just (theirAddr, Uninit))
381 . (incomingFrom theirAddr ^: Set.insert cid)
534 . (incomingFrom theirAddr ^: Set.insert cid)
384− else invalidRequest cid st
537+ else invalidRequest cid st $
538+ "attempt to connect with unsupported reliability " ++ show rel
385 NT.Received cid payload ->
539 NT.Received cid payload ->
386 case st ^. incomingAt cid of
540 case st ^. incomingAt cid of
387− Just (_, ToProc weakQueue) -> do
541+ Just (_, ToProc pid weakQueue) -> do
388 mQueue <- deRefWeak weakQueue
542 mQueue <- deRefWeak weakQueue
389 forM_ mQueue $ \queue -> do
543 forM_ mQueue $ \queue -> do
390 -- TODO: if we find that the queue is Nothing, should we remove
544 -- TODO: if we find that the queue is Nothing, should we remove
391 -- it from the NC state? (and same for channels, below)
545 -- it from the NC state? (and same for channels, below)
392 let msg = payloadToMessage payload
546 let msg = payloadToMessage payload
393 enqueue queue msg -- 'enqueue' is strict
547 enqueue queue msg -- 'enqueue' is strict
548+ trace node (MxReceived pid msg)
395− Just (_, ToChan (TypedChannel chan')) -> do
550+ Just (_, ToChan chId (TypedChannel chan')) -> do
396 mChan <- deRefWeak chan'
551 mChan <- deRefWeak chan'
397 -- If mChan is Nothing, the process has given up the read end of
552 -- If mChan is Nothing, the process has given up the read end of
398 -- the channel and we simply ignore the incoming message
553 -- the channel and we simply ignore the incoming message
399− forM_ mChan $ \chan -> atomically $
554+ forM_ mChan $ \chan -> do
555+ msg' <- atomically $ do
556+ msg <- return $! decode (BSL.fromChunks payload)
400− -- We make sure the message is fully decoded when it is enqueued
557+ -- We make sure the message is fully decoded when it is enqueued
401− writeTQueue chan $! decode (BSL.fromChunks payload)
558+ writeTQueue chan msg
560+ trace node $ MxReceivedPort chId $ unsafeCreateUnencodedMessage msg'
403 Just (_, ToNode) -> do
562 Just (_, ToNode) -> do
404 let ctrlMsg = decode . BSL.fromChunks $ payload
563 let ctrlMsg = decode . BSL.fromChunks $ payload
@@ -408,37 +567,49 @@ handleIncomingMessages node = go initConnectionState
408 case decode (BSL.fromChunks payload) of
567 case decode (BSL.fromChunks payload) of
409 ProcessIdentifier pid -> do
568 ProcessIdentifier pid -> do
410 let lpid = processLocalId pid
569 let lpid = processLocalId pid
411− mProc <- withMVar state $ return . (^. localProcessWithId lpid)
570+ mProc <- withValidLocalState node $ return . (^. localProcessWithId lpid)
412 case mProc of
571 case mProc of
413 Just proc ->
572 Just proc ->
414− go (incomingAt cid ^= Just (src, ToProc (processWeakQ proc)) $ st)
573+ go (incomingAt cid ^= Just (src, ToProc pid (processWeakQ proc)) $ st)
415 Nothing ->
574 Nothing ->
416− invalidRequest cid st
575+ -- incoming attempt to connect to unknown process - might
577+ go (incomingAt cid ^= Nothing $ st)
417 SendPortIdentifier chId -> do
578 SendPortIdentifier chId -> do
418 let lcid = sendPortLocalId chId
579 let lcid = sendPortLocalId chId
419 lpid = processLocalId (sendPortProcessId chId)
580 lpid = processLocalId (sendPortProcessId chId)
420− mProc <- withMVar state $ return . (^. localProcessWithId lpid)
581+ mProc <- withValidLocalState node $ return . (^. localProcessWithId lpid)
421 case mProc of
582 case mProc of
422 Just proc -> do
583 Just proc -> do
423 mChannel <- withMVar (processState proc) $ return . (^. typedChannelWithId lcid)
584 mChannel <- withMVar (processState proc) $ return . (^. typedChannelWithId lcid)
424 case mChannel of
585 case mChannel of
425 Just channel ->
586 Just channel ->
426− go (incomingAt cid ^= Just (src, ToChan channel) $ st)
587+ go (incomingAt cid ^= Just (src, ToChan chId channel) $ st)
427 Nothing ->
588 Nothing ->
428− invalidRequest cid st
589+ invalidRequest cid st $
590+ "incoming attempt to connect to unknown channel of"
591+ ++ " process " ++ show (sendPortProcessId chId)
429 Nothing ->
592 Nothing ->
430− invalidRequest cid st
593+ -- incoming attempt to connect to channel of unknown
594+ -- process - might be dead already
595+ go (incomingAt cid ^= Nothing $ st)
431 NodeIdentifier nid ->
596 NodeIdentifier nid ->
432 if nid == localNodeId node
597 if nid == localNodeId node
433 then go (incomingAt cid ^= Just (src, ToNode) $ st)
598 then go (incomingAt cid ^= Just (src, ToNode) $ st)
434− else invalidRequest cid st
599+ else invalidRequest cid st $
600+ "incoming attempt to connect to a different node -"
601+ ++ " I'm " ++ show (localNodeId node)
602+ ++ " but the remote peer wants to connect to "
435 Nothing ->
604 Nothing ->
436 invalidRequest cid st
605 invalidRequest cid st
606+ "message received from an unknown connection"
437 NT.ConnectionClosed cid ->
607 NT.ConnectionClosed cid ->
438 case st ^. incomingAt cid of
608 case st ^. incomingAt cid of
439 Nothing ->
609 Nothing ->
440− invalidRequest cid st
610+ invalidRequest cid st "closed unknown connection"
441− Just (src, _) ->
611+ Just (src, _) -> do
612+ trace node (MxDisconnected cid src)
442 go ( (incomingAt cid ^= Nothing)
613 go ( (incomingAt cid ^= Nothing)
443 . (incomingFrom src ^: Set.delete cid)
614 . (incomingFrom src ^: Set.delete cid)
@@ -457,32 +628,30 @@ handleIncomingMessages node = go initConnectionState
459 NT.ErrorEvent (NT.TransportError NT.EventEndPointFailed str) ->
630 NT.ErrorEvent (NT.TransportError NT.EventEndPointFailed str) ->
460− fatal $ "Cloud Haskell fatal error: end point failed: " ++ str
631+ fail $ "Cloud Haskell fatal error: end point failed: " ++ str
461 NT.ErrorEvent (NT.TransportError NT.EventTransportFailed str) ->
632 NT.ErrorEvent (NT.TransportError NT.EventTransportFailed str) ->
462− fatal $ "Cloud Haskell fatal error: transport failed: " ++ str
633+ fail $ "Cloud Haskell fatal error: transport failed: " ++ str
463 NT.EndPointClosed ->
634 NT.EndPointClosed ->
464− stopTracer (localTracer node) >> return ()
635+ return ()
465 NT.ReceivedMulticast _ _ ->
636 NT.ReceivedMulticast _ _ ->
466 -- If we received a multicast message, something went horribly wrong
637 -- If we received a multicast message, something went horribly wrong
467 -- and we just give up
638 -- and we just give up
468− fatal "Cloud Haskell fatal error: received unexpected multicast"
639+ fail "Cloud Haskell fatal error: received unexpected multicast"
470− fatal :: String -> IO ()
471− fatal msg = stopTracer (localTracer node) >> fail msg
473− invalidRequest :: NT.ConnectionId -> ConnectionState -> IO ()
641+ invalidRequest :: NT.ConnectionId -> ConnectionState -> String -> IO ()
474− invalidRequest cid st = do
642+ invalidRequest cid st msg = do
475 -- TODO: We should treat this as a fatal error on the part of the remote
643 -- TODO: We should treat this as a fatal error on the part of the remote
476 -- node. That is, we should report the remote node as having died, and we
644 -- node. That is, we should report the remote node as having died, and we
477 -- should close incoming connections (this requires a Transport layer
645 -- should close incoming connections (this requires a Transport layer
478 -- extension).
646 -- extension).
479− traceEventFmtIO node "" [(TraceStr "[network] invalid request: "),
647+ traceEventFmtIO node "" [ TraceStr $ " [network] invalid request"
648+ ++ " (" ++ msg ++ "): "
480− (Trace cid)]
649+ , (Trace cid)
481 go ( incomingAt cid ^= Nothing
651 go ( incomingAt cid ^= Nothing
485− state = localState node
486 endpoint = localEndPoint node
655 endpoint = localEndPoint node
487 ctrlChan = localCtrlChan node
656 ctrlChan = localCtrlChan node
@@ -491,8 +660,9 @@ handleIncomingMessages node = go initConnectionState
491--------------------------------------------------------------------------------
660--------------------------------------------------------------------------------
493runNodeController :: LocalNode -> IO ()
662runNodeController :: LocalNode -> IO ()
494−runNodeController =
663+runNodeController node =
495− runReaderT (evalStateT (unNC nodeController) initNCState)
664+ runReaderT (evalStateT (unNC nodeController) initNCState) node
665+ `Exception.catch` \(NodeClosedException _) -> return ()
497--------------------------------------------------------------------------------
667--------------------------------------------------------------------------------
498-- Internal data types --
668-- Internal data types --
@@ -500,20 +670,26 @@ runNodeController =
501data NCState = NCState
671data NCState = NCState
502 { -- Mapping from remote processes to linked local processes
672 { -- Mapping from remote processes to linked local processes
503− _links :: !(Map Identifier (Set ProcessId))
673+ _links :: !(BiMultiMap Identifier ProcessId ())
504 -- Mapping from remote processes to monitoring local processes
674 -- Mapping from remote processes to monitoring local processes
505− , _monitors :: !(Map Identifier (Set (ProcessId, MonitorRef)))
675+ , _monitors :: !(BiMultiMap Identifier ProcessId MonitorRef)
506 -- Process registry: names and where they live, mapped to the PIDs
676 -- Process registry: names and where they live, mapped to the PIDs
507 , _registeredHere :: !(Map String ProcessId)
677 , _registeredHere :: !(Map String ProcessId)
508 , _registeredOnNodes :: !(Map ProcessId [(NodeId,Int)])
678 , _registeredOnNodes :: !(Map ProcessId [(NodeId,Int)])
511newtype NC a = NC { unNC :: StateT NCState (ReaderT LocalNode IO) a }
681newtype NC a = NC { unNC :: StateT NCState (ReaderT LocalNode IO) a }
682+ deriving ( Applicative
686+ , MonadState NCState
512− deriving (Functor, Monad, MonadIO, MonadState NCState, MonadReader LocalNode)
687+ , MonadReader LocalNode
514initNCState :: NCState
690initNCState :: NCState
515−initNCState = NCState { _links = Map.empty
691+initNCState = NCState { _links = BiMultiMap.empty
516− , _monitors = Map.empty
692+ , _monitors = BiMultiMap.empty
517 , _registeredHere = Map.empty
693 , _registeredHere = Map.empty
518 , _registeredOnNodes = Map.empty
694 , _registeredOnNodes = Map.empty
@@ -529,34 +705,60 @@ instance Show ProcessKillException where
529 show (ProcessKillException pid reason) =
705 show (ProcessKillException pid reason) =
530 "killed-by=" ++ show pid ++ ",reason=" ++ reason
706 "killed-by=" ++ show pid ++ ",reason=" ++ reason
708+ncSendToProcess :: ProcessId -> Message -> NC ()
709+ncSendToProcess = ncSendToProcessAndTrace True
711+ncSendToProcessAndTrace :: Bool -> ProcessId -> Message -> NC ()
712+ncSendToProcessAndTrace shouldTrace pid msg = do
714+ if processNodeId pid == localNodeId node
715+ then ncEffectLocalSendAndTrace shouldTrace node pid msg
716+ else liftIO $ sendBinary node
717+ (NodeIdentifier $ localNodeId node)
718+ (NodeIdentifier $ processNodeId pid)
719+ WithImplicitReconnect
720+ NCMsg { ctrlMsgSender = NodeIdentifier $ localNodeId node
721+ , ctrlMsgSignal = UnreliableSend (processLocalId pid) msg
724+ncSendToNode :: NodeId -> NCMsg -> NC ()
725+ncSendToNode to msg = do
727+ liftIO $ if to == localNodeId node
728+ then writeChan (localCtrlChan node) $! msg
729+ else sendBinary node
730+ (NodeIdentifier $ localNodeId node)
732+ WithImplicitReconnect
532--------------------------------------------------------------------------------
735--------------------------------------------------------------------------------
533-- Tracing/Debugging --
736-- Tracing/Debugging --
534--------------------------------------------------------------------------------
737--------------------------------------------------------------------------------
536−-- [Issue #104]
739+-- [Issue #104 / DP-13]
538traceNotifyDied :: LocalNode -> Identifier -> DiedReason -> NC ()
741traceNotifyDied :: LocalNode -> Identifier -> DiedReason -> NC ()
539traceNotifyDied node ident reason =
742traceNotifyDied node ident reason =
743+ -- TODO: sendPortDied notifications
744+ liftIO $ withLocalTracer node $ \t ->
540− case reason of
745+ case ident of
746+ (NodeIdentifier nid) -> traceEvent t (MxNodeDied nid reason)
747+ (ProcessIdentifier pid) -> traceEvent t (MxProcessDied pid reason)
541− DiedNormal -> return ()
748+ _ -> return ()
542− _ -> traceNcEventFmt node " "
543− [(TraceStr "[node-controller]"),
547−traceNcEventFmt :: LocalNode -> String -> [TraceArg] -> NC ()
548−traceNcEventFmt node fmt args =
549− liftIO $ traceEventFmtIO node fmt args
551traceEventFmtIO :: LocalNode
750traceEventFmtIO :: LocalNode
552 -> String
751 -> String
553 -> [TraceArg]
752 -> [TraceArg]
555traceEventFmtIO node fmt args =
754traceEventFmtIO node fmt args =
556− withLocalTracer node $ \t -> traceFormat t fmt args
755+ withLocalTracer node $ \t -> traceLogFmt t fmt args
757+trace :: LocalNode -> MxEvent -> IO ()
758+trace node ev = withLocalTracer node $ \t -> traceEvent t ev
558−withLocalTracer :: LocalNode -> (Tracer -> IO ()) -> IO ()
760+withLocalTracer :: LocalNode -> (MxEventBus -> IO ()) -> IO ()
559−withLocalTracer node act = act (localTracer node)
761+withLocalTracer node act = act (localEventBus node)
561--------------------------------------------------------------------------------
763--------------------------------------------------------------------------------
562-- Core functionality --
764-- Core functionality --
@@ -572,11 +774,7 @@ nodeController = do
572 -- [Unified: Table 7, rule nc_forward]
774 -- [Unified: Table 7, rule nc_forward]
573 case destNid (ctrlMsgSignal msg) of
775 case destNid (ctrlMsgSignal msg) of
574 Just nid' | nid' /= localNodeId node ->
776 Just nid' | nid' /= localNodeId node ->
575− liftIO $ sendBinary node
777+ ncSendToNode nid' msg
577− (NodeIdentifier nid')
578− WithImplicitReconnect
581 return ()
779 return ()
@@ -597,8 +795,14 @@ nodeController = do
597 ncEffectRegister from label atnode pid force
795 ncEffectRegister from label atnode pid force
598 NCMsg (ProcessIdentifier from) (WhereIs label) ->
796 NCMsg (ProcessIdentifier from) (WhereIs label) ->
599 ncEffectWhereIs from label
797 ncEffectWhereIs from label
600− NCMsg from (NamedSend label msg') ->
798+ NCMsg _ (NamedSend label msg') ->
601− ncEffectNamedSend from label msg'
799+ ncEffectNamedSend label msg'
800+ NCMsg _ (UnreliableSend lpid msg') ->
801+ ncEffectLocalSend node (ProcessId (localNodeId node) lpid) msg'
802+ NCMsg _ (LocalSend to msg') ->
803+ ncEffectLocalSend node to msg'
804+ NCMsg _ (LocalPortSend to msg') ->
805+ ncEffectLocalPortSend to msg'
602 NCMsg (ProcessIdentifier from) (Kill to reason) ->
806 NCMsg (ProcessIdentifier from) (Kill to reason) ->
603 ncEffectKill from to reason
807 ncEffectKill from to reason
604 NCMsg (ProcessIdentifier from) (Exit to reason) ->
808 NCMsg (ProcessIdentifier from) (Exit to reason) ->
@@ -606,7 +810,11 @@ nodeController = do
606 NCMsg (ProcessIdentifier from) (GetInfo pid) ->
810 NCMsg (ProcessIdentifier from) (GetInfo pid) ->
607 ncEffectGetInfo from pid
811 ncEffectGetInfo from pid
608 NCMsg _ SigShutdown ->
812 NCMsg _ SigShutdown ->
609− liftIO $ throwIO ThreadKilled -- seems to make more sense than fail/error
813+ liftIO $ do
814+ NT.closeEndPoint (localEndPoint node)
815+ `Exception.finally` throwIO (NodeClosedException $ localNodeId node)
816+ NCMsg (ProcessIdentifier from) (GetNodeStats nid) ->
817+ ncEffectGetNodeStats from nid
610 unexpected ->
818 unexpected ->
611 error $ "nodeController: unexpected message " ++ show unexpected
819 error $ "nodeController: unexpected message " ++ show unexpected
@@ -624,22 +832,18 @@ ncEffectMonitor from them mRef = do
624 case (shouldLink, isLocal node (ProcessIdentifier from)) of
832 case (shouldLink, isLocal node (ProcessIdentifier from)) of
625 (True, _) -> -- [Unified: first rule]
833 (True, _) -> -- [Unified: first rule]
626 case mRef of
834 case mRef of
627− Just ref -> modify' $ monitorsFor them ^: Set.insert (from, ref)
835+ Just ref -> modify' $ monitors ^: BiMultiMap.insert them from ref
628− Nothing -> modify' $ linksFor them ^: Set.insert from
836+ Nothing -> modify' $ links ^: BiMultiMap.insert them from ()
629 (False, True) -> -- [Unified: second rule]
837 (False, True) -> -- [Unified: second rule]
630 notifyDied from them DiedUnknownId mRef
838 notifyDied from them DiedUnknownId mRef
631 (False, False) -> -- [Unified: third rule]
839 (False, False) -> -- [Unified: third rule]
632 -- TODO: this is the right sender according to the Unified semantics,
840 -- TODO: this is the right sender according to the Unified semantics,
633 -- but perhaps having 'them' as the sender would make more sense
841 -- but perhaps having 'them' as the sender would make more sense
634 -- (see also: notifyDied)
842 -- (see also: notifyDied)
635− liftIO $ sendBinary node
636− (NodeIdentifier $ localNodeId node)
637− (NodeIdentifier $ processNodeId from)
843+ ncSendToNode (processNodeId from) $ NCMsg
638− WithImplicitReconnect
640− { ctrlMsgSender = NodeIdentifier (localNodeId node)
844+ { ctrlMsgSender = NodeIdentifier (localNodeId node)
641− , ctrlMsgSignal = Died them DiedUnknownId
845+ , ctrlMsgSignal = Died them DiedUnknownId
644-- [Unified: Table 11]
848-- [Unified: Table 11]
645ncEffectUnlink :: ProcessId -> Identifier -> NC ()
849ncEffectUnlink :: ProcessId -> Identifier -> NC ()
@@ -653,7 +857,7 @@ ncEffectUnlink from them = do
653 postAsMessage from $ DidUnlinkNode nid
857 postAsMessage from $ DidUnlinkNode nid
654 SendPortIdentifier cid ->
858 SendPortIdentifier cid ->
655 postAsMessage from $ DidUnlinkPort cid
859 postAsMessage from $ DidUnlinkPort cid
656− modify' $ linksFor them ^: Set.delete from
860+ modify' $ links ^: BiMultiMap.delete them from ()
658-- [Unified: Table 11]
862-- [Unified: Table 11]
659ncEffectUnmonitor :: ProcessId -> MonitorRef -> NC ()
863ncEffectUnmonitor :: ProcessId -> MonitorRef -> NC ()
@@ -661,7 +865,7 @@ ncEffectUnmonitor from ref = do
661 node <- ask
865 node <- ask
662 when (isLocal node (ProcessIdentifier from)) $
866 when (isLocal node (ProcessIdentifier from)) $
663 postAsMessage from $ DidUnmonitor ref
867 postAsMessage from $ DidUnmonitor ref
664− modify' $ monitorsFor (monitorRefIdent ref) ^: Set.delete (from, ref)
868+ modify' $ monitors ^: BiMultiMap.delete (monitorRefIdent ref) from ref
666-- [Unified: Table 12]
870-- [Unified: Table 12]
667ncEffectDied :: Identifier -> DiedReason -> NC ()
871ncEffectDied :: Identifier -> DiedReason -> NC ()
@@ -676,7 +880,7 @@ ncEffectDied ident reason = do
676 let localOnly = case ident of NodeIdentifier _ -> True ; _ -> False
880 let localOnly = case ident of NodeIdentifier _ -> True ; _ -> False
678 forM_ (Map.toList affectedLinks) $ \(them, uss) ->
882 forM_ (Map.toList affectedLinks) $ \(them, uss) ->
679− forM_ uss $ \us ->
883+ forM_ uss $ \(us, _) ->
680 when (localOnly <= isLocal node (ProcessIdentifier us)) $
884 when (localOnly <= isLocal node (ProcessIdentifier us)) $
681 notifyDied us them reason Nothing
885 notifyDied us them reason Nothing
@@ -685,9 +889,35 @@ ncEffectDied ident reason = do
685 when (localOnly <= isLocal node (ProcessIdentifier us)) $
889 when (localOnly <= isLocal node (ProcessIdentifier us)) $
686 notifyDied us them reason (Just ref)
890 notifyDied us them reason (Just ref)
892+ -- Notify remote nodes that the process died so it can be removed from monitor
894+ mapM_ (forwardDeath node) $
895+ [ nid | ProcessIdentifier pid <- [ident]
896+ , i <- Set.toList $ Set.union
897+ (Set.map fst $ BiMultiMap.lookupBy2nd pid unaffectedLinks)
898+ (Set.map fst $ BiMultiMap.lookupBy2nd pid unaffectedMons)
899+ , let nid = nodeOf i
900+ , nid /= localNodeId node
903+ -- Delete monitors in the local node.
904+ let deleteDeads :: (Ord a, Ord v)
905+ => BiMultiMap a ProcessId v -> BiMultiMap a ProcessId v
906+ deleteDeads = case ident of
907+ -- deleteAllBy2nd is faster than partitionWithKeyBy2nd
908+ ProcessIdentifier pid -> BiMultiMap.deleteAllBy2nd pid
909+ _ -> snd . BiMultiMap.partitionWithKeyBy2nd
910+ (\pid _ -> ident `impliesDeathOf` ProcessIdentifier pid)
911+ unaffectedLinks' = deleteDeads unaffectedLinks
912+ unaffectedMons' = deleteDeads unaffectedMons
688− modify' $ (links ^= unaffectedLinks) . (monitors ^= unaffectedMons)
914+ modify' $ (links ^= unaffectedLinks') . (monitors ^= unaffectedMons')
916+ -- we now consider all labels for this identifier unregistered
690− modify' $ registeredHere ^: Map.filter (\pid -> not $ ident `impliesDeathOf` ProcessIdentifier pid)
917+ let toDrop pid = not $ ident `impliesDeathOf` ProcessIdentifier pid
918+ (keepNames, dropNames) <- Map.partition toDrop <$> gets (^. registeredHere)
919+ mapM_ (\(p, l) -> liftIO $ trace node (MxUnRegistered l p)) (Map.toList dropNames)
920+ modify' $ registeredHere ^= keepNames
692 remaining <- fmap Map.toList (gets (^. registeredOnNodes)) >>=
922 remaining <- fmap Map.toList (gets (^. registeredOnNodes)) >>=
693 mapM (\(pid,nidlist) ->
923 mapM (\(pid,nidlist) ->
@@ -695,20 +925,15 @@ ncEffectDied ident reason = do
696 do forM_ nidlist $ \(nid,_) ->
926 do forM_ nidlist $ \(nid,_) ->
697 when (not $ isLocal node (NodeIdentifier nid))
927 when (not $ isLocal node (NodeIdentifier nid))
698− (forwardNameDeath node nid)
928+ (forwardDeath node nid)
699 return Nothing
929 return Nothing
700 False -> return $ Just (pid,nidlist) )
930 False -> return $ Just (pid,nidlist) )
701 modify' $ registeredOnNodes ^= (Map.fromList (catMaybes remaining))
931 modify' $ registeredOnNodes ^= (Map.fromList (catMaybes remaining))
703− forwardNameDeath node nid =
933+ forwardDeath node nid = ncSendToNode nid
704− liftIO $ sendBinary node
705− (NodeIdentifier $ localNodeId node)
706− (NodeIdentifier $ nid)
707− WithImplicitReconnect
709− { ctrlMsgSender = NodeIdentifier (localNodeId node)
934+ NCMsg { ctrlMsgSender = NodeIdentifier (localNodeId node)
710− , ctrlMsgSignal = Died ident reason
935+ , ctrlMsgSignal = Died ident reason
713-- [Unified: Table 13]
938-- [Unified: Table 13]
714ncEffectSpawn :: ProcessId -> Closure (Process ()) -> SpawnRef -> NC ()
939ncEffectSpawn :: ProcessId -> Closure (Process ()) -> SpawnRef -> NC ()
@@ -716,16 +941,13 @@ ncEffectSpawn pid cProc ref = do
716 mProc <- unClosure cProc
941 mProc <- unClosure cProc
717 -- If the closure does not exist, we spawn a process that throws an exception
942 -- If the closure does not exist, we spawn a process that throws an exception
718 -- This allows the remote node to find out what's happening
943 -- This allows the remote node to find out what's happening
719 let proc = case mProc of
945 let proc = case mProc of
720 Left err -> fail $ "Error: Could not resolve closure: " ++ err
946 Left err -> fail $ "Error: Could not resolve closure: " ++ err
721 Right p -> p
947 Right p -> p
722 node <- ask
948 node <- ask
723 pid' <- liftIO $ forkProcess node proc
949 pid' <- liftIO $ forkProcess node proc
724− liftIO $ sendMessage node
950+ ncSendToProcess pid $ unsafeCreateUnencodedMessage $ DidSpawn ref pid'
725− (NodeIdentifier (localNodeId node))
726− (ProcessIdentifier pid)
727− WithImplicitReconnect
730-- Unified semantics does not explicitly describe how to implement 'register',
952-- Unified semantics does not explicitly describe how to implement 'register',
731-- but mentions it's "very similar to nsend" (Table 14)
953-- but mentions it's "very similar to nsend" (Table 14)
@@ -743,14 +965,19 @@ ncEffectRegister from label atnode mPid reregistration = do
743 return $ (isNothing currentVal /= reregistration) &&
965 return $ (isNothing currentVal /= reregistration) &&
744 (not (isLocal node (ProcessIdentifier thepid) ) || isvalidlocal )
966 (not (isLocal node (ProcessIdentifier thepid) ) || isvalidlocal )
745 if isLocal node (NodeIdentifier atnode)
967 if isLocal node (NodeIdentifier atnode)
746− then do when (isOk) $
968+ then do when isOk $
747 do modify' $ registeredHereFor label ^= mPid
969 do modify' $ registeredHereFor label ^= mPid
748 updateRemote node currentVal mPid
970 updateRemote node currentVal mPid
749− liftIO $ sendMessage node
971+ case mPid of
750− (NodeIdentifier (localNodeId node))
972+ (Just p) -> do
751− (ProcessIdentifier from)
973+ if reregistration
752− WithImplicitReconnect
974+ then liftIO $ trace node (MxUnRegistered (fromJust currentVal) label)
976+ liftIO $ trace node (MxRegistered p label)
977+ Nothing -> liftIO $ trace node (MxUnRegistered (fromJust currentVal) label)
978+ newVal <- gets (^. registeredHereFor label)
979+ ncSendToProcess from $ unsafeCreateUnencodedMessage $
753− (RegisterReply label isOk)
980+ RegisterReply label isOk newVal
754 else let operation =
981 else let operation =
755 case reregistration of
982 case reregistration of
756 True -> flip decList
983 True -> flip decList
@@ -768,6 +995,7 @@ ncEffectRegister from label atnode mPid reregistration = do
768 updateRemote _ _ _ = return ()
995 updateRemote _ _ _ = return ()
769 maybeify f Nothing = unmaybeify $ f []
996 maybeify f Nothing = unmaybeify $ f []
770 maybeify f (Just x) = unmaybeify $ f x
997 maybeify f (Just x) = unmaybeify $ f x
771 unmaybeify [] = Nothing
999 unmaybeify [] = Nothing
772 unmaybeify x = Just x
1000 unmaybeify x = Just x
773 incList [] tag = [(tag,1)]
1001 incList [] tag = [(tag,1)]
@@ -779,39 +1007,61 @@ ncEffectRegister from label atnode mPid reregistration = do
779 decList (x:xs) tag = x:decList xs tag
1007 decList (x:xs) tag = x:decList xs tag
780 forward node to reg =
1008 forward node to reg =
781 when (not $ isLocal node (NodeIdentifier to)) $
1009 when (not $ isLocal node (NodeIdentifier to)) $
782− liftIO $ sendBinary node
783− (ProcessIdentifier from)
785− WithImplicitReconnect
787− { ctrlMsgSender = ProcessIdentifier from
1010+ ncSendToNode to $ NCMsg { ctrlMsgSender = ProcessIdentifier from
788− , ctrlMsgSignal = reg
1011+ , ctrlMsgSignal = reg
792-- Unified semantics does not explicitly describe 'whereis'
1015-- Unified semantics does not explicitly describe 'whereis'
793ncEffectWhereIs :: ProcessId -> String -> NC ()
1016ncEffectWhereIs :: ProcessId -> String -> NC ()
794ncEffectWhereIs from label = do
1017ncEffectWhereIs from label = do
796 mPid <- gets (^. registeredHereFor label)
1018 mPid <- gets (^. registeredHereFor label)
797− liftIO $ sendMessage node
798− (NodeIdentifier (localNodeId node))
799− (ProcessIdentifier from)
800− WithImplicitReconnect
801− (WhereIsReply label mPid)
1019+ ncSendToProcess from $ unsafeCreateUnencodedMessage $ WhereIsReply label mPid
803-- [Unified: Table 14]
1021-- [Unified: Table 14]
804−ncEffectNamedSend :: Identifier -> String -> Message -> NC ()
1022+ncEffectNamedSend :: String -> Message -> NC ()
805−ncEffectNamedSend from label msg = do
1023+ncEffectNamedSend label msg = do
807 mPid <- gets (^. registeredHereFor label)
1024 mPid <- gets (^. registeredHereFor label)
808 -- If mPid is Nothing, we just ignore the named send (as per Table 14)
1025 -- If mPid is Nothing, we just ignore the named send (as per Table 14)
809− forM_ mPid $ \pid ->
1026+ forM_ mPid $ \to ->
1027+ -- If this is a trace message we don't trace it to avoid entering a loop
1028+ -- where trace messages produce more trace messages.
1029+ ncSendToProcessAndTrace (label /= "trace.logger") to msg
1032+ncEffectLocalSend :: LocalNode -> ProcessId -> Message -> NC ()
1033+ncEffectLocalSend = ncEffectLocalSendAndTrace True
1035+ncEffectLocalSendAndTrace :: Bool -> LocalNode -> ProcessId -> Message -> NC ()
1036+ncEffectLocalSendAndTrace shouldTrace node to msg =
810− liftIO $ sendPayload node
1037+ liftIO $ withLocalProc node to $ \p -> do
811− from
1038+ enqueue (processQueue p) msg
812− (ProcessIdentifier pid)
1039+ when shouldTrace $ trace node (MxReceived to msg)
813− NoImplicitReconnect
1040+
814− (messageToPayload msg)
1041+-- [Issue #DP-20]
1042+ncEffectLocalPortSend :: SendPortId -> Message -> NC ()
1043+ncEffectLocalPortSend from msg = do
1045+ let pid = sendPortProcessId from
1046+ cid = sendPortLocalId from
1047+ liftIO $ withLocalProc node pid $ \proc -> do
1048+ mChan <- withMVar (processState proc) $ return . (^. typedChannelWithId cid)
1050+ -- in the unlikely event we know nothing about this channel id,
1051+ -- there's little to be done - perhaps some logging/tracing though...
1052+ Nothing -> return ()
1053+ Just (TypedChannel chan') -> do
1054+ -- If ch is Nothing, the process has given up the read end of
1055+ -- the channel and we simply ignore the incoming message - this
1056+ ch <- deRefWeak chan'
1057+ forM_ ch $ \chan -> deliverChan node from msg chan
1058+ where deliverChan :: forall a . LocalNode -> SendPortId -> Message -> TQueue a -> IO ()
1059+ deliverChan n p (UnencodedMessage _ raw) chan' = do
1060+ atomically $ writeTQueue chan' ((unsafeCoerce raw) :: a)
1061+ trace n (MxReceivedPort p $ unsafeCreateUnencodedMessage raw)
1062+ deliverChan _ _ (EncodedMessage _ _) _ =
1063+ -- this will not happen unless someone screws with Primitives.hs
1064+ error "invalid local channel delivery"
816-- [Issue #69]
1066-- [Issue #69]
817ncEffectKill :: ProcessId -> ProcessId -> String -> NC ()
1067ncEffectKill :: ProcessId -> ProcessId -> String -> NC ()
@@ -834,46 +1084,56 @@ ncEffectGetInfo from pid =
834 them = (ProcessIdentifier pid)
1084 them = (ProcessIdentifier pid)
836 node <- ask
1086 node <- ask
837− mProc <- liftIO $
1087+ mProc <- liftIO $ withValidLocalState node
838− withMVar (localState node) $ return . (^. localProcessWithId lpid)
1088+ $ return . (^. localProcessWithId lpid)
839 case mProc of
1089 case mProc of
840 Nothing -> dispatch (isLocal node (ProcessIdentifier from))
1090 Nothing -> dispatch (isLocal node (ProcessIdentifier from))
841− from node (ProcessInfoNone DiedUnknownId)
1091+ from (ProcessInfoNone DiedUnknownId)
842− Just _ -> do
1092+ Just proc -> do
843− itsLinks <- gets (^. linksFor them)
1093+ itsLinks <- Set.map fst . BiMultiMap.lookupBy1st them <$>
844− itsMons <- gets (^. monitorsFor them)
1094+ gets (^. links)
1095+ itsMons <- BiMultiMap.lookupBy1st them <$> gets (^. monitors)
845 registered <- gets (^. registeredHere)
1096 registered <- gets (^. registeredHere)
1097+ size <- liftIO $ queueSize $ processQueue $ proc
847 let reg = registeredNames registered
1099 let reg = registeredNames registered
848 dispatch (isLocal node (ProcessIdentifier from))
1100 dispatch (isLocal node (ProcessIdentifier from))
851 ProcessInfo {
1102 ProcessInfo {
852 infoNode = (processNodeId pid)
1103 infoNode = (processNodeId pid)
853 , infoRegisteredNames = reg
1104 , infoRegisteredNames = reg
854− -- we cannot populate this field
855− , infoMessageQueueLength = Nothing
1105+ , infoMessageQueueLength = size
856− , infoMonitors = Set.toList itsMons
1106+ , infoMonitors = Set.toList itsMons
857− , infoLinks = Set.toList itsLinks
1107+ , infoLinks = Set.toList itsLinks
859− where dispatch :: (Serializable a, Show a)
1109+ where dispatch :: (Serializable a)
861 -> ProcessId
1111 -> ProcessId
864 -> NC ()
1113 -> NC ()
865− dispatch True dest _ pInfo = postAsMessage dest $ pInfo
1114+ dispatch True dest pInfo = postAsMessage dest $ pInfo
866− dispatch False dest node pInfo = do
1115+ dispatch False dest pInfo =
867− liftIO $ sendMessage node
1116+ ncSendToProcess dest $ unsafeCreateUnencodedMessage pInfo
868− (NodeIdentifier (localNodeId node))
869− (ProcessIdentifier dest)
870− WithImplicitReconnect
873 registeredNames = Map.foldlWithKey (\ks k v -> if v == pid
1118 registeredNames = Map.foldlWithKey (\ks k v -> if v == pid
874 then (k:ks)
1119 then (k:ks)
875 else ks) []
1120 else ks) []
1122+ncEffectGetNodeStats :: ProcessId -> NodeId -> NC ()
1123+ncEffectGetNodeStats from _nid = do
1125+ ncState <- StateT.get
1126+ nodeState <- liftIO $ withValidLocalState node return
1129+ nodeStatsNode = localNodeId node
1130+ , nodeStatsRegisteredNames = Map.size $ ncState ^. registeredHere
1131+ , nodeStatsMonitors = BiMultiMap.size $ ncState ^. monitors
1132+ , nodeStatsLinks = BiMultiMap.size $ ncState ^. links
1133+ , nodeStatsProcesses = Map.size (nodeState ^. localProcesses)
1135+ postAsMessage from stats
877--------------------------------------------------------------------------------
1137--------------------------------------------------------------------------------
878-- Auxiliary --
1138-- Auxiliary --
879--------------------------------------------------------------------------------
1139--------------------------------------------------------------------------------
@@ -900,32 +1160,32 @@ notifyDied dest src reason mRef = do
900 throwException dest $ PortLinkException pid reason
1160 throwException dest $ PortLinkException pid reason
901 (False, _, _) ->
1161 (False, _, _) ->
902 -- The change in sender comes from [Unified: Table 10]
1162 -- The change in sender comes from [Unified: Table 10]
903− liftIO $ sendBinary node
904− (NodeIdentifier $ localNodeId node)
905− (NodeIdentifier $ processNodeId dest)
1163+ ncSendToNode (processNodeId dest) $ NCMsg
906− WithImplicitReconnect
908− { ctrlMsgSender = NodeIdentifier (localNodeId node)
1164+ { ctrlMsgSender = NodeIdentifier (localNodeId node)
909− , ctrlMsgSignal = Died src reason
1165+ , ctrlMsgSignal = Died src reason
912-- | [Unified: Table 8]
1168-- | [Unified: Table 8]
913destNid :: ProcessSignal -> Maybe NodeId
1169destNid :: ProcessSignal -> Maybe NodeId
914−destNid (Link ident) = Just $ nodeOf ident
1170+destNid (Link ident) = Just $ nodeOf ident
915−destNid (Unlink ident) = Just $ nodeOf ident
1171+destNid (Unlink ident) = Just $ nodeOf ident
916−destNid (Monitor ref) = Just $ nodeOf (monitorRefIdent ref)
1172+destNid (Monitor ref) = Just $ nodeOf (monitorRefIdent ref)
917−destNid (Unmonitor ref) = Just $ nodeOf (monitorRefIdent ref)
1173+destNid (Unmonitor ref) = Just $ nodeOf (monitorRefIdent ref)
918−destNid (Spawn _ _) = Nothing
1174+destNid (Spawn _ _) = Nothing
919−destNid (Register _ _ _ _) = Nothing
1175+destNid (Register _ _ _ _) = Nothing
920−destNid (WhereIs _) = Nothing
1176+destNid (WhereIs _) = Nothing
921−destNid (NamedSend _ _) = Nothing
1177+destNid (NamedSend _ _) = Nothing
1178+destNid (UnreliableSend _ _) = Nothing
922-- We don't need to forward 'Died' signals; if monitoring/linking is setup,
1179-- We don't need to forward 'Died' signals; if monitoring/linking is setup,
923-- then when a local process dies the monitoring/linking machinery will take
1180-- then when a local process dies the monitoring/linking machinery will take
924-- care of notifying remote nodes
1181-- care of notifying remote nodes
925−destNid (Died _ _) = Nothing
1182+destNid (Died _ _) = Nothing
926−destNid (Kill pid _) = Just $ processNodeId pid
1183+destNid (Kill pid _) = Just $ processNodeId pid
927−destNid (Exit pid _) = Just $ processNodeId pid
1184+destNid (Exit pid _) = Just $ processNodeId pid
1185+destNid (GetInfo pid) = Just $ processNodeId pid
1186+destNid (GetNodeStats nid) = Just nid
928−destNid (GetInfo pid) = Just $ processNodeId pid
1187+destNid (LocalSend pid _) = Just $ processNodeId pid
1188+destNid (LocalPortSend cid _) = Just $ processNodeId (sendPortProcessId cid)
929destNid (SigShutdown) = Nothing
1189destNid (SigShutdown) = Nothing
931-- | Check if a process is local to our own node
1191-- | Check if a process is local to our own node
@@ -942,7 +1202,7 @@ unClosure closure = do
942isValidLocalIdentifier :: Identifier -> NC Bool
1202isValidLocalIdentifier :: Identifier -> NC Bool
943isValidLocalIdentifier ident = do
1203isValidLocalIdentifier ident = do
944 node <- ask
1204 node <- ask
945− liftIO . withMVar (localState node) $ \nSt ->
1205+ liftIO . withValidLocalState node $ \nSt ->
946 case ident of
1206 case ident of
947 NodeIdentifier nid ->
1207 NodeIdentifier nid ->
948 return $ nid == localNodeId node
1208 return $ nid == localNodeId node
@@ -963,34 +1223,37 @@ isValidLocalIdentifier ident = do
963--------------------------------------------------------------------------------
1223--------------------------------------------------------------------------------
965postAsMessage :: Serializable a => ProcessId -> a -> NC ()
1225postAsMessage :: Serializable a => ProcessId -> a -> NC ()
966−postAsMessage pid = postMessage pid . createMessage
1226+postAsMessage pid = postMessage pid . createUnencodedMessage
968postMessage :: ProcessId -> Message -> NC ()
1228postMessage :: ProcessId -> Message -> NC ()
969postMessage pid msg = do
1229postMessage pid msg = do
970− withLocalProc pid $ \p -> enqueue (processQueue p) msg
1231+ liftIO $ withLocalProc node pid $ \p -> enqueue (processQueue p) msg
972throwException :: Exception e => ProcessId -> e -> NC ()
1233throwException :: Exception e => ProcessId -> e -> NC ()
973−throwException pid e = withLocalProc pid $ \p ->
1234+throwException pid e = do
974− throwTo (processThread p) e
976−withLocalProc :: ProcessId -> (LocalProcess -> IO ()) -> NC ()
977−withLocalProc pid p = do
978 node <- ask
1235 node <- ask
979− liftIO $ do
1236+ -- throwTo blocks until the exception is received by the target thread.
1237+ -- We cannot easily make it happen asynchronpusly because then 'unlink'
1238+ -- semantics would break.
1239+ liftIO $ withLocalProc node pid $ \p -> throwTo (processThread p) e
1241+withLocalProc :: LocalNode -> ProcessId -> (LocalProcess -> IO ()) -> IO ()
1242+withLocalProc node pid p =
980− -- By [Unified: table 6, rule missing_process] messages to dead processes
1243+ -- By [Unified: table 6, rule missing_process] messages to dead processes
981− -- can silently be dropped
1244+ -- can silently be dropped
982− let lpid = processLocalId pid
1245+ let lpid = processLocalId pid in do
1246+ join $ withValidLocalState node $ \vst ->
983− mProc <- withMVar (localState node) $ return . (^. localProcessWithId lpid)
1247+ return $ forM_ (vst ^. localProcessWithId lpid) p
986--------------------------------------------------------------------------------
1249--------------------------------------------------------------------------------
987-- Accessors --
1250-- Accessors --
988--------------------------------------------------------------------------------
1251--------------------------------------------------------------------------------
990−links :: Accessor NCState (Map Identifier (Set ProcessId))
1253+links :: Accessor NCState (BiMultiMap Identifier ProcessId ())
991links = accessor _links (\ls st -> st { _links = ls })
1254links = accessor _links (\ls st -> st { _links = ls })
993−monitors :: Accessor NCState (Map Identifier (Set (ProcessId, MonitorRef)))
1256+monitors :: Accessor NCState (BiMultiMap Identifier ProcessId MonitorRef)
994monitors = accessor _monitors (\ms st -> st { _monitors = ms })
1257monitors = accessor _monitors (\ms st -> st { _monitors = ms })
996registeredHere :: Accessor NCState (Map String ProcessId)
1259registeredHere :: Accessor NCState (Map String ProcessId)
@@ -999,12 +1262,6 @@ registeredHere = accessor _registeredHere (\ry st -> st { _registeredHere = ry }
999registeredOnNodes :: Accessor NCState (Map ProcessId [(NodeId, Int)])
1262registeredOnNodes :: Accessor NCState (Map ProcessId [(NodeId, Int)])
1000registeredOnNodes = accessor _registeredOnNodes (\ry st -> st { _registeredOnNodes = ry })
1263registeredOnNodes = accessor _registeredOnNodes (\ry st -> st { _registeredOnNodes = ry })
1002−linksFor :: Identifier -> Accessor NCState (Set ProcessId)
1003−linksFor ident = links >>> DAC.mapDefault Set.empty ident
1005−monitorsFor :: Identifier -> Accessor NCState (Set (ProcessId, MonitorRef))
1006−monitorsFor ident = monitors >>> DAC.mapDefault Set.empty ident
1008registeredHereFor :: String -> Accessor NCState (Maybe ProcessId)
1265registeredHereFor :: String -> Accessor NCState (Maybe ProcessId)
1009registeredHereFor ident = registeredHere >>> DAC.mapMaybe ident
1266registeredHereFor ident = registeredHere >>> DAC.mapMaybe ident
@@ -1031,10 +1288,12 @@ registeredOnNodesFor ident = registeredOnNodes >>> DAC.mapMaybe ident
1031-- * the notifications for typed channels to that process.
1288-- * the notifications for typed channels to that process.
1033-- See https://github.com/haskell/containers/issues/14 for the bang on _v.
1290-- See https://github.com/haskell/containers/issues/14 for the bang on _v.
1291+splitNotif :: (Ord a, Ord v)
1034−splitNotif :: Identifier
1292+ => Identifier
1035− -> Map Identifier a
1293+ -> BiMultiMap Identifier a v
1036− -> (Map Identifier a, Map Identifier a)
1294+ -> (Map Identifier (Set (a,v)), BiMultiMap Identifier a v)
1037−splitNotif ident = Map.partitionWithKey (\k !_v -> ident `impliesDeathOf` k)
1295+splitNotif ident =
1296+ BiMultiMap.partitionWithKeyBy1st (\k !_v -> ident `impliesDeathOf` k)
1039--------------------------------------------------------------------------------
1298--------------------------------------------------------------------------------
1040-- Auxiliary --
1299-- Auxiliary --