git.iko.soy/distributed-process
on 7930062 help sign in
distributed-process-tests/src/Control/Distributed/Process/Tests/CH.hs+31−38
since splitsnapshots
unifiedsplit
@@ -46,11 +46,11 @@ import Control.Distributed.Process.Debug
46import Control.Distributed.Process.Management.Internal.Types
46import Control.Distributed.Process.Management.Internal.Types
47import Control.Distributed.Process.Tests.Internal.Utils (shouldBe, pause)
47import Control.Distributed.Process.Tests.Internal.Utils (shouldBe, pause)
48import Control.Distributed.Process.Serializable (Serializable)
48import Control.Distributed.Process.Serializable (Serializable)
49−import Data.Maybe (isNothing, isJust)
49+import Data.Maybe (isNothing)
50import Test.HUnit (Assertion, assertBool, assertFailure)
50import Test.HUnit (Assertion, assertBool, assertFailure)
51import Test.Framework (Test, testGroup)
51import Test.Framework (Test, testGroup)
52import Test.Framework.Providers.HUnit (testCase)
52import Test.Framework.Providers.HUnit (testCase)
53−import Control.Rematch hiding (match, isNothing, isJust)
53+import Control.Rematch hiding (match, isNothing)
54import Control.Rematch.Run (Match(..))
54import Control.Rematch.Run (Match(..))
55
55
56newtype Ping = Ping ProcessId
56newtype Ping = Ping ProcessId
@@ -87,9 +87,10 @@ verifyClient :: String -> MVar Bool -> IO ()
87verifyClient s b = takeMVar b >>= assertBool s
87verifyClient s b = takeMVar b >>= assertBool s
88
88
89expectPing :: MVar Bool -> Process ()
89expectPing :: MVar Bool -> Process ()
90−expectPing mv = expect >>= liftIO . putMVar mv . checkPing
90+expectPing mv = expect >>= liftIO . putMVar mv . checkPing
91 where
91 where
92 checkPing (Ping _) = True
92 checkPing (Ping _) = True
93+ checkPing _ = False
93
94
94-- | Quick and dirty synchronous version of whereisRemoteAsync
95-- | Quick and dirty synchronous version of whereisRemoteAsync
95whereisRemote :: NodeId -> String -> Process (Maybe ProcessId)
96whereisRemote :: NodeId -> String -> Process (Maybe ProcessId)
@@ -239,10 +240,10 @@ testPing TestTransport{..} = do
239 pid <- getSelfPid
240 pid <- getSelfPid
240 replicateM_ numPings $ do
241 replicateM_ numPings $ do
241 send pingServer (Pong pid)
242 send pingServer (Pong pid)
242− p <- expectTimeout 3000000
243+ p <- expect
243 case p of
244 case p of
244− Just (Ping _) -> return ()
245+ Ping _ -> return ()
245− Nothing -> die "Failed to receive Ping"
246+ _ -> die "Unexpected message"
246
247
247 putMVar clientDone ()
248 putMVar clientDone ()
248
249
@@ -559,7 +560,7 @@ testMergeChannels TestTransport{..} = do
559 ss <- liftIO $ mapM readMVar vs
560 ss <- liftIO $ mapM readMVar vs
560 case ss of
561 case ss of
561 [sa, sb, sc] ->
562 [sa, sb, sc] ->
562− mapM_ ((>> pause 10000) . uncurry sendChan)
563+ mapM_ ((>> liftIO (threadDelay 10000)) . uncurry sendChan)
563 [ -- a, b, c
564 [ -- a, b, c
564 (sa, 'a')
565 (sa, 'a')
565 , (sb, 'b')
566 , (sb, 'b')
@@ -735,6 +736,7 @@ testRemoteRegistry :: TestTransport -> Assertion
735testRemoteRegistry TestTransport{..} = do
736testRemoteRegistry TestTransport{..} = do
736 node1 <- newLocalNode testTransport initRemoteTable
737 node1 <- newLocalNode testTransport initRemoteTable
737 node2 <- newLocalNode testTransport initRemoteTable
738 node2 <- newLocalNode testTransport initRemoteTable
739+ done <- newEmptyMVar
738
740
739 pingServer <- forkProcess node1 ping
741 pingServer <- forkProcess node1 ping
740 deadProcess <- forkProcess node1 (return ())
742 deadProcess <- forkProcess node1 (return ())
@@ -749,7 +751,6 @@ testRemoteRegistry TestTransport{..} = do
749
751
750 pid <- verifyWhereIsRemote nid1 "ping"
752 pid <- verifyWhereIsRemote nid1 "ping"
751 liftIO $ assertBool "Expected pindServer to match pid" $ pingServer == pid
753 liftIO $ assertBool "Expected pindServer to match pid" $ pingServer == pid
752−
753 us <- getSelfPid
754 us <- getSelfPid
754 nsendRemote nid1 "ping" (Pong us)
755 nsendRemote nid1 "ping" (Pong us)
755 receiveWait [
756 receiveWait [
@@ -759,22 +760,22 @@ testRemoteRegistry TestTransport{..} = do
759 -- test that if process was not registered Nothing is returned
760 -- test that if process was not registered Nothing is returned
760 -- in owner field.
761 -- in owner field.
761 registerRemoteAsync nid1 "dead" deadProcess
762 registerRemoteAsync nid1 "dead" deadProcess
763+ receiveWait [
762− receiveWait [ matchIf (\(RegisterReply label' f mPid) -> "dead" == label')
764+ matchIf (\(RegisterReply label' False Nothing) -> "dead" == label')
763− (\(RegisterReply _ f mPid) -> return (not f && isNothing mPid))
765+ (\(RegisterReply _ _ _) -> return ()) ]
764− ] >>= liftIO . assertBool "Expected False Nothing in RegisterReply"
765−
766 registerRemoteAsync nid1 "ping" deadProcess
766 registerRemoteAsync nid1 "ping" deadProcess
767 receiveWait [
767 receiveWait [
768− matchIf (\(RegisterReply label' False mPid) ->
768+ matchIf (\(RegisterReply label' False (Just pid'')) ->
769− "ping" == label' && isJust mPid)
769+ "ping" == label' && pid'' == pingServer)
770− (\(RegisterReply _ f (Just pid'')) -> return (not f && pid'' == pingServer))
770+ (\(RegisterReply _ _ _) -> return ()) ]
771− ] >>= liftIO . assertBool "Expected False and (Just alreadyRegisteredPid) in RegisterReply"
772−
773 unregisterRemoteAsync nid1 "dead"
771 unregisterRemoteAsync nid1 "dead"
774 receiveWait [
772 receiveWait [
775− matchIf (\(RegisterReply label' _ _) -> "dead" == label')
773+ matchIf (\(RegisterReply label' False Nothing) ->
774+ "dead" == label' && pid == pingServer)
776− (\(RegisterReply _ f mPid) -> return (not f && isNothing mPid))
775+ (\(RegisterReply _ _ _) -> return ()) ]
777− ] >>= liftIO . assertBool "Expected False and Nothing in RegisterReply"
776+ liftIO $ putMVar done ()
777+
778+ takeMVar done
778
779
779testRemoteRegistryRemoteProcess :: TestTransport -> Assertion
780testRemoteRegistryRemoteProcess :: TestTransport -> Assertion
780testRemoteRegistryRemoteProcess TestTransport{..} = do
781testRemoteRegistryRemoteProcess TestTransport{..} = do
@@ -1556,24 +1557,20 @@ testRegistryMonitoring :: TestTransport -> Assertion
1556testRegistryMonitoring TestTransport{..} = do
1557testRegistryMonitoring TestTransport{..} = do
1557 node1 <- newLocalNode testTransport initRemoteTable
1558 node1 <- newLocalNode testTransport initRemoteTable
1558 node2 <- newLocalNode testTransport initRemoteTable
1559 node2 <- newLocalNode testTransport initRemoteTable
1560+ waitH <- newEmptyMVar
1559
1561
1560 let nid = localNodeId node2
1562 let nid = localNodeId node2
1561 pid <- forkProcess node1 $ do
1563 pid <- forkProcess node1 $ do
1562− self <- getSelfPid
1563− runUntilRegistered nid self
1564+ getSelfPid >>= runUntilRegistered nid
1564− say $ (show self) ++ " registered as " ++ regName
1565+ liftIO $ takeMVar waitH
1565− expect :: Process ()
1566− say $ (show self) ++ " exiting normally"
1567
1566
1568 runProcess node2 $ do
1567 runProcess node2 $ do
1569 register regName pid
1568 register regName pid
1570− say $ regName ++ " registered to " ++ show pid
1571 res <- whereis regName
1569 res <- whereis regName
1572− send pid ()
1573− say $ " sent finish signal to " ++ show pid
1574 us <- getSelfPid
1570 us <- getSelfPid
1571+ liftIO $ do
1572+ putMVar waitH ()
1575− liftIO $ assertBool "expected (Just pid)" $ res == (Just pid)
1573+ assertBool "expected (Just pid)" $ res == (Just pid)
1576−
1577
1574
1578 -- This delay isn't essential!
1575 -- This delay isn't essential!
1579 -- The test case passes perfectly fine without it (feel free to comment out
1576 -- The test case passes perfectly fine without it (feel free to comment out
@@ -1598,9 +1595,7 @@ testRegistryMonitoring TestTransport{..} = do
1598 regHere <- newEmptyMVar
1595 regHere <- newEmptyMVar
1599 runProcess node2 $ whereis regName >>= liftIO . putMVar regHere
1596 runProcess node2 $ whereis regName >>= liftIO . putMVar regHere
1600 res <- takeMVar regHere
1597 res <- takeMVar regHere
1601− case res of
1602− Nothing -> return ()
1603− Just pid -> assertBool ("expected Nothing, but got " ++ show pid) False
1598+ assertBool "expected Nothing, but process still registered" (res == Nothing)
1604
1599
1605 where
1600 where
1606 runUntilRegistered nid us = do
1601 runUntilRegistered nid us = do
@@ -1612,13 +1607,11 @@ testRegistryMonitoring TestTransport{..} = do
1612
1607
1613 delayUntilMaybeUnregistered nid p = do
1608 delayUntilMaybeUnregistered nid p = do
1614 whereisRemoteAsync nid regName
1609 whereisRemoteAsync nid regName
1615− res <- receiveTimeout 20000000 {- 20 sec delay -} [
1610+ receiveTimeout 20000000 {- 20 sec delay -} [
1616− matchIf (\(WhereIsReply n p) -> n == regName && isNothing p)
1611+ matchIf (\(WhereIsReply n p) -> n == regName && p == Nothing)
1617 (const $ return ())
1612 (const $ return ())
1618 ]
1613 ]
1619− case res of
1620− Just () -> return ()
1614+ return ()
1621− Nothing -> delayUntilMaybeUnregistered nid p
1622
1615
1623 regName = "testRegisterRemote"
1616 regName = "testRegisterRemote"
1624
1617
distributed-process-tests/src/Control/Distributed/Process/Tests/Internal/Utils.hs+2−5
@@ -74,13 +74,12 @@ import Control.Concurrent
74import Control.Concurrent.MVar
74import Control.Concurrent.MVar
75 ( putMVar
75 ( putMVar
76 )
76 )
77−import Control.Distributed.Process hiding (finally, catch)
77+import Control.Distributed.Process
78import Control.Distributed.Process.Node
78import Control.Distributed.Process.Node
79import Control.Distributed.Process.Serializable()
79import Control.Distributed.Process.Serializable()
80
80
81import Control.Exception (AsyncException(ThreadKilled), SomeException)
81import Control.Exception (AsyncException(ThreadKilled), SomeException)
82import Control.Monad (forever, void)
82import Control.Monad (forever, void)
83−import Control.Monad.Catch (finally, catch)
84import Control.Monad.STM (atomically)
83import Control.Monad.STM (atomically)
85import Control.Rematch hiding (match)
84import Control.Rematch hiding (match)
86import Control.Rematch.Run
85import Control.Rematch.Run
@@ -91,7 +90,6 @@ import Test.HUnit (Assertion, assertFailure)
91import Test.HUnit.Base (assertBool)
90import Test.HUnit.Base (assertBool)
92
91
93import GHC.Generics
92import GHC.Generics
94−import System.Timeout (timeout)
95
93
96-- | A mutable cell containing a test result.
94-- | A mutable cell containing a test result.
97type TestResult a = MVar a
95type TestResult a = MVar a
@@ -234,8 +232,7 @@ testProcessReport pid = do
234tryRunProcess :: LocalNode -> Process () -> IO ()
232tryRunProcess :: LocalNode -> Process () -> IO ()
235tryRunProcess node p = do
233tryRunProcess node p = do
236 tid <- liftIO myThreadId
234 tid <- liftIO myThreadId
237− void $ timeout (1000000 * 60 * 5 :: Int) $
238− runProcess node $ catch p (\e -> liftIO $ throwTo tid (e::SomeException))
235+ runProcess node $ catch p (\e -> liftIO $ throwTo tid (e::SomeException))
239
236
240tryForkProcess :: LocalNode -> Process () -> IO ProcessId
237tryForkProcess :: LocalNode -> Process () -> IO ProcessId
241tryForkProcess node p = do
238tryForkProcess node p = do
distributed-process-tests/src/Control/Distributed/Process/Tests/Mx.hs+40−227
@@ -1,23 +1,11 @@
1−{-# LANGUAGE DeriveGeneric #-}
1+{-# LANGUAGE DeriveGeneric #-}
2−{-# LANGUAGE ParallelListComp #-}
3−
4module Control.Distributed.Process.Tests.Mx (tests) where
2module Control.Distributed.Process.Tests.Mx (tests) where
5
3
6import Control.Distributed.Process.Tests.Internal.Utils
4import Control.Distributed.Process.Tests.Internal.Utils
7import Network.Transport.Test (TestTransport(..))
5import Network.Transport.Test (TestTransport(..))
8−import Control.Distributed.Process hiding (bracket, finally, try)
6+
9−import Control.Distributed.Process.Internal.Types
7+import Control.Distributed.Process
10− ( ProcessExitException(..)
11− , unsafeCreateUnencodedMessage
12− )
13import Control.Distributed.Process.Node
8import Control.Distributed.Process.Node
14−import qualified Control.Distributed.Process.UnsafePrimitives as Unsafe
15− ( send
16− , nsend
17− , nsendRemote
18− , usend
19− , sendChan
20− )
21import Control.Distributed.Process.Management
9import Control.Distributed.Process.Management
22 ( MxEvent(..)
10 ( MxEvent(..)
23 , MxAgentId(..)
11 , MxAgentId(..)
@@ -34,13 +22,12 @@ import Control.Distributed.Process.Management
34 , mxBroadcast
22 , mxBroadcast
35 )
23 )
36import Control.Monad (void, unless)
24import Control.Monad (void, unless)
37−import Control.Monad.Catch(finally, bracket, try)
38import Control.Rematch (equalTo)
25import Control.Rematch (equalTo)
39import Data.Binary
26import Data.Binary
40−import Data.List (find, sort, intercalate)
27+import Data.List (find, sort)
41−import Data.Maybe (isJust, fromJust, isNothing, fromMaybe, catMaybes)
28+import Data.Maybe (isJust, isNothing)
42import Data.Typeable
29import Data.Typeable
43−import GHC.Generics hiding (from)
30+import GHC.Generics
44#if ! MIN_VERSION_base(4,6,0)
31#if ! MIN_VERSION_base(4,6,0)
45import Prelude hiding (catch, log)
32import Prelude hiding (catch, log)
46#endif
33#endif
@@ -64,9 +51,9 @@ awaitExit pid =
64 (\_ -> return ())
51 (\_ -> return ())
65 ]
52 ]
66 where
53 where
67− withMonitorRef p = bracket (monitor p) unmonitor
54+ withMonitorRef pid = bracket (monitor pid) unmonitor
68
55
69−testAgentBroadcast :: TestResult (Maybe ()) -> Process ()
56+testAgentBroadcast :: TestResult () -> Process ()
70testAgentBroadcast result = do
57testAgentBroadcast result = do
71 (resultSP, resultRP) <- newChan :: Process (SendPort (), ReceivePort ())
58 (resultSP, resultRP) <- newChan :: Process (SendPort (), ReceivePort ())
72
59
@@ -81,10 +68,10 @@ testAgentBroadcast result = do
81 mxNotify ()
68 mxNotify ()
82 -- Once the publisher has seen our message, it will broadcast the Publish
69 -- Once the publisher has seen our message, it will broadcast the Publish
83 -- and the consumer will see that and send the result to our typed channel.
70 -- and the consumer will see that and send the result to our typed channel.
84− stash result =<< receiveChanTimeout 10000000 resultRP
71+ stash result =<< receiveChan resultRP
85
72
86− kill publisher "finished"
73+ kill publisher "finished" >> awaitExit publisher
87− kill consumer "finished"
74+ kill consumer "finished" >> awaitExit consumer
88
75
89testAgentDualInput :: TestResult (Maybe Int) -> Process ()
76testAgentDualInput :: TestResult (Maybe Int) -> Process ()
90testAgentDualInput result = do
77testAgentDualInput result = do
@@ -99,8 +86,6 @@ testAgentDualInput result = do
99 else mxReady)
86 else mxReady)
100 ]
87 ]
101
88
102− mRef <- monitor s
103−
104 mxNotify (1 :: Int)
89 mxNotify (1 :: Int)
105 nsend "sum-agent" (3 :: Int)
90 nsend "sum-agent" (3 :: Int)
106 mxNotify (2 :: Int)
91 mxNotify (2 :: Int)
@@ -108,10 +93,7 @@ testAgentDualInput result = do
108 mxNotify (5 :: Int)
93 mxNotify (5 :: Int)
109
94
110 stash result =<< receiveChanTimeout 10000000 rp
95 stash result =<< receiveChanTimeout 10000000 rp
111− died <- receiveTimeout 10000000 [
96+ awaitExit s
112− matchIf (\(ProcessMonitorNotification r _ _) -> r == mRef) (const $ return True)
113− ]
114− died `shouldBe` equalTo (Just True)
115
97
116testAgentPrioritisation :: TestResult [String] -> Process ()
98testAgentPrioritisation :: TestResult [String] -> Process ()
117testAgentPrioritisation result = do
99testAgentPrioritisation result = do
@@ -125,10 +107,10 @@ testAgentPrioritisation result = do
125 (sp, rp) <- newChan
107 (sp, rp) <- newChan
126 s <- mxAgent (MxAgentId name) ["first"] [
108 s <- mxAgent (MxAgentId name) ["first"] [
127 mxSink (\(s :: String) -> do
109 mxSink (\(s :: String) -> do
128− mxUpdateLocal (s:)
110+ mxUpdateLocal ((s:))
129 st <- mxGetLocal
111 st <- mxGetLocal
130 case length st of
112 case length st of
131− n | n == 5 -> do liftMX $ sendChan sp (sort st)
113+ n | n == 5 -> do liftMX $ sendChan sp st
132 mxDeactivate "finished"
114 mxDeactivate "finished"
133 _ -> mxReceive -- go to the mailbox
115 _ -> mxReceive -- go to the mailbox
134 )
116 )
@@ -139,7 +121,7 @@ testAgentPrioritisation result = do
139 mxNotify "fourth"
121 mxNotify "fourth"
140 nsend name "fifth"
122 nsend name "fifth"
141
123
142− stash result . fromMaybe [] =<< receiveChanTimeout 10000000 rp
124+ stash result . sort =<< receiveChan rp
143 awaitExit s
125 awaitExit s
144
126
145testAgentMailboxHandling :: TestResult (Maybe ()) -> Process ()
127testAgentMailboxHandling :: TestResult (Maybe ()) -> Process ()
@@ -152,19 +134,12 @@ testAgentMailboxHandling result = do
152 nsend "mailbox-agent" ()
134 nsend "mailbox-agent" ()
153
135
154 stash result =<< receiveChanTimeout 1000000 rp
136 stash result =<< receiveChanTimeout 1000000 rp
155− kill agent "finished"
137+ kill agent "finished" >> awaitExit agent
156
138
157testAgentEventHandling :: TestResult Bool -> Process ()
139testAgentEventHandling :: TestResult Bool -> Process ()
158testAgentEventHandling result = do
140testAgentEventHandling result = do
159− us <- getSelfPid
160− -- because this test is a bit racy, let's ensure it can't run indefinitely
161− timer <- spawnLocal $ do
162− pause (1000000 * 60 * 5)
163− -- okay we've waited 5 mins, let's kill the test off if it's stuck...
164− stash result False
165− kill us "Test Timed Out"
166−
167 let initState = [] :: [MxEvent]
141 let initState = [] :: [MxEvent]
142+
168 (rc, rs) <- newChan
143 (rc, rs) <- newChan
169 agentPid <- mxAgent (MxAgentId "lifecycle-listener-agent") initState [
144 agentPid <- mxAgent (MxAgentId "lifecycle-listener-agent") initState [
170 (mxSink $ \ev -> do
145 (mxSink $ \ev -> do
@@ -197,7 +172,8 @@ testAgentEventHandling result = do
197 -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
172 -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
198 faff 2000000 rs
173 faff 2000000 rs
199
174
175+ _ <- monitor agentPid
200− (sp, rp) <- newChan :: Process (SendPort (), ReceivePort ())
176+ (sp, rp) <- newChan
201
177
202 pid <- spawnLocal $ expect >>= sendChan sp
178 pid <- spawnLocal $ expect >>= sendChan sp
203
179
@@ -206,11 +182,9 @@ testAgentEventHandling result = do
206 monitor pid
182 monitor pid
207
183
208 send pid ()
184 send pid ()
209− rct <- receiveChanTimeout 10000000 rp
185+ () <- receiveChan rp
210− unless (isJust rct) $ die "No response on channel"
211
186
212− pmn <- receiveTimeout 2000000 [ match (\ProcessMonitorNotification{} -> return ()) ]
187+ receiveWait [ match (\(ProcessMonitorNotification _ _ _) -> return ()) ]
213− unless (isJust pmn) $ die "No monitor notification arrived"
214
188
215 -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
189 -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
216 faff 2000000 rs
190 faff 2000000 rs
@@ -219,16 +193,17 @@ testAgentEventHandling result = do
219 mxNotify (MxSpawned pid, replyTo)
193 mxNotify (MxSpawned pid, replyTo)
220 mxNotify (MxProcessDied pid DiedNormal, replyTo)
194 mxNotify (MxProcessDied pid DiedNormal, replyTo)
221
195
222− seenAlive <- receiveChanTimeout 10000000 reply
196+ seenAlive <- receiveChan reply
223− seenDead <- receiveChanTimeout 10000000 reply
197+ seenDead <- receiveChan reply
224
198
225− stash result $ foldr (&&) True $ catMaybes [seenAlive, seenDead]
199+ stash result $ seenAlive && seenDead
226− kill timer "test-complete"
200+ kill agentPid "test-complete" >> awaitExit agentPid
227− kill agentPid "test-complete"
228 where
201 where
229 faff delay port = do
202 faff delay port = do
230 res <- receiveChanTimeout delay port
203 res <- receiveChanTimeout delay port
231− unless (isNothing res) $ pause delay
204+ unless (isNothing res) $ do
205+ pause delay
206+ faff delay port
232
207
233testMxRegEvents :: TestResult () -> Process ()
208testMxRegEvents :: TestResult () -> Process ()
234testMxRegEvents result = do
209testMxRegEvents result = do
@@ -275,6 +250,7 @@ testMxRegEvents result = do
275 reg3 `shouldBe` equalTo (Just (label, p1))
250 reg3 `shouldBe` equalTo (Just (label, p1))
276
251
277 mapM_ (flip kill $ "test-complete") [agent, p1, p2]
252 mapM_ (flip kill $ "test-complete") [agent, p1, p2]
253+ awaitExit agent
278
254
279testMxRegMon :: LocalNode -> TestResult () -> Process ()
255testMxRegMon :: LocalNode -> TestResult () -> Process ()
280testMxRegMon remoteNode result = do
256testMxRegMon remoteNode result = do
@@ -332,211 +308,48 @@ testMxRegMon remoteNode result = do
332 evts `shouldContain` (Just (label1, p1))
308 evts `shouldContain` (Just (label1, p1))
333 evts `shouldContain` (Just (label2, p1))
309 evts `shouldContain` (Just (label2, p1))
334
310
335− kill agent "test-complete"
311+ kill agent "test-complete" >> awaitExit agent
336
312
337ensure :: Process () -> Process () -> Process ()
313ensure :: Process () -> Process () -> Process ()
338ensure = flip finally
314ensure = flip finally
339
315
340−testNSend :: (String -> () -> Process ())
341− -> Maybe LocalNode
342− -> Process ()
343−testNSend op n = do
344− us <- getSelfPid
345− let delay = 5000000
346− let label = "testMxSend" ++ (show us)
347− let isValid = isValidLabel n label
348−
349− testMxSend n label $ \p1 sink -> do
350− register label p1
351− reg1 <- receiveChanTimeout delay sink
352− case reg1 of
353− Just (MxRegistered pd lb)
354− | pd == p1 && isValid lb -> return ()
355− _ -> die $ "Reg-Failed: " ++ show reg1
356−
357− op label ()
358−
359− sent <- receiveChanTimeout delay sink
360− case sent of
361− Just (MxSentToName lb by _)
362− | by == us && isValid lb -> return True
363− _ -> die $ "Send-Failed: " ++ show sent
364−
365− where
366− isValidLabel nd l1 l2
367− | l2 == l2 = True
368− | isJust nd = l2 == l1 ++ "@" ++ show (localNodeId $ fromJust nd)
369− | otherwise = False
370−
371−testSend :: (ProcessId -> () -> Process ())
372− -> Maybe LocalNode
373− -> Process ()
374−testSend op n = do
375− us <- getSelfPid
376− let label = "testMxSend" ++ (show us)
377− testMxSend n label $ \p1 sink -> do
378− -- initiate a send
379− op p1 ()
380−
381− -- verify the management event
382− sent <- receiveChanTimeout 5000000 sink
383− case sent of
384− Just (MxSent pidTo pidFrom _)
385− | pidTo == p1 && pidFrom == us -> return True
386− _ -> return False
387−
388−testChan :: (SendPort () -> () -> Process ())
389− -> Maybe LocalNode
390− -> Process ()
391−testChan op n = testMxSend n "" $ \p1 sink -> do
392−
393− us <- getSelfPid
394− send p1 us
395−
396− cleared <- receiveChanTimeout 2000000 sink
397− case cleared of
398− Just (MxSent pidTo pidFrom _)
399− | pidTo == p1 && pidFrom == us -> return ()
400− _ -> die "Received uncleared Mx Event"
401−
402− chan <- receiveTimeout 5000000 [ match return ]
403− let ch' = fromMaybe (error "No reply chan received") chan
404−
405− -- initiate a send
406− op ch' ()
407−
408− -- verify the management event
409− sent <- receiveChanTimeout 5000000 sink
410− case sent of
411− Just (MxSentToPort sId spId _)
412− | sId == us && spId == sendPortId ch' -> return True
413− _ -> return False
414−
415−type SendTest = ProcessId -> ReceivePort MxEvent -> Process Bool
416−
417−testMxSend :: Maybe LocalNode -> String -> SendTest -> Process ()
418−testMxSend mNode label test = do
419− us <- getSelfPid
420− (sp, rp) <- newChan
421− (chan, sink) <- newChan
422− agent <- mxAgent (MxAgentId $ agentLabel us) () [
423− mxSink $ \ev -> do
424− case ev of
425− m@(MxSentToPort _ cid _)
426− | cid /= sendPortId chan
427− && cid /= sendPortId sp -> liftMX $ sendChan chan m
428− m@(MxSent _ fromPid _)
429− | fromPid == us -> liftMX $ sendChan chan m
430− m@(MxSentToName _ fromPid _)
431− | fromPid == us -> liftMX $ sendChan chan m
432− m@(MxRegistered _ name)
433− | name == label -> liftMX $ sendChan chan m
434− _ -> return ()
435− mxReady
436− ]
437−
438− case mNode of
439− Nothing -> void $ spawnLocal (proc sp)
440− Just remoteNode -> void $ liftIO $ forkProcess remoteNode $ proc sp
441−
442− p1 <- receiveChanTimeout 2000000 rp
443− unless (isJust p1) $ die "Timed out waiting for ProcessId"
444− res <- try $ test (fromJust p1) sink
445−
446− kill agent "bye"
447− kill (fromJust p1) "bye"
448−
449− case res of
450− Left (ProcessExitException _ m) -> (liftIO $ putStrLn $ "SomeException-" ++ show m) >> die m
451− Right tr -> tr `shouldBe` equalTo True
452−
453−
454− where
455− agentLabel s = "mx-unsafe-check-agent-" ++ show s
456− proc sp' = getSelfPid >>= sendChan sp' >> go Nothing
457−
458− go :: Maybe (ReceivePort ()) -> Process ()
459− go Nothing = receiveTimeout 5000000 [ match replyChannel ] >>= go
460− go c@(Just c') = receiveWait [ matchChan c' return ] >> go c
461−
462− replyChannel p' = do
463− (s, r) <- newChan
464− send p' s
465− return r
466−
467tests :: TestTransport -> IO [Test]
316tests :: TestTransport -> IO [Test]
468tests TestTransport{..} = do
317tests TestTransport{..} = do
469 node1 <- newLocalNode testTransport initRemoteTable
318 node1 <- newLocalNode testTransport initRemoteTable
470 node2 <- newLocalNode testTransport initRemoteTable
319 node2 <- newLocalNode testTransport initRemoteTable
471 return [
320 return [
472− testGroup "MxAgents" [
321+ testGroup "Mx Agents" [
473− testCase "EventHandling"
322+ testCase "Event Handling"
474 (delayedAssertion
323 (delayedAssertion
475 "expected True, but events where not as expected"
324 "expected True, but events where not as expected"
476 node1 True testAgentEventHandling)
325 node1 True testAgentEventHandling)
477− , testCase "InterAgentBroadcast"
326+ , testCase "Inter-Agent Broadcast"
478 (delayedAssertion
327 (delayedAssertion
479 "expected (), but no broadcast was received"
328 "expected (), but no broadcast was received"
480− node1 (Just ()) testAgentBroadcast)
329+ node1 () testAgentBroadcast)
481− , testCase "AgentMailboxHandling"
330+ , testCase "Agent Mailbox Handling"
482 (delayedAssertion
331 (delayedAssertion
483 "expected (Just ()), but no regular (mailbox) input was handled"
332 "expected (Just ()), but no regular (mailbox) input was handled"
484 node1 (Just ()) testAgentMailboxHandling)
333 node1 (Just ()) testAgentMailboxHandling)
485− , testCase "AgentDualInputHandling"
334+ , testCase "Agent Dual Input Handling"
486 (delayedAssertion
335 (delayedAssertion
487 "expected sum = 15, but the result was Nothing"
336 "expected sum = 15, but the result was Nothing"
488 node1 (Just 15 :: Maybe Int) testAgentDualInput)
337 node1 (Just 15 :: Maybe Int) testAgentDualInput)
489− , testCase "AgentInputPrioritisation"
338+ , testCase "Agent Input Prioritisation"
490 (delayedAssertion
339 (delayedAssertion
491 "expected [first, second, third, fourth, fifth], but result diverged"
340 "expected [first, second, third, fourth, fifth], but result diverged"
492 node1 (sort ["first", "second",
341 node1 (sort ["first", "second",
493 "third", "fourth",
342 "third", "fourth",
494 "fifth"]) testAgentPrioritisation)
343 "fifth"]) testAgentPrioritisation)
495 ]
344 ]
496− , testGroup "MxEvents" [
345+ , testGroup "Mx Events" [
497− testCase "NameRegistrationEvents"
346+ testCase "Name Registration Events"
498 (delayedAssertion
347 (delayedAssertion
499 "expected registration events to map to the correct ProcessId"
348 "expected registration events to map to the correct ProcessId"
500 node1 () testMxRegEvents)
349 node1 () testMxRegEvents)
501− , testCase "PostDeathNameUnRegistrationEvents"
350+ , testCase "Post Death Name UnRegistration Events"
502 (delayedAssertion
351 (delayedAssertion
503 "expected process deaths to result in unregistration events"
352 "expected process deaths to result in unregistration events"
504 node1 () (testMxRegMon node2))
353 node1 () (testMxRegMon node2))
505− , testGroup "SendEvents" $ buildTestCases node1 node2
506 ]
354 ]
507 ]
355 ]
508− where
509− buildTestCases n1 n2 = let nid = localNodeId n2 in build n1 n2 [
510− ("NSend", [
511− ("nsend", testNSend nsend)
512− , ("Unsafe.nsend", testNSend Unsafe.nsend)
513− , ("nsendRemote", testNSend (nsendRemote nid))
514− , ("Unsafe.nsendRemote", testNSend (Unsafe.nsendRemote nid))
515− ])
516− , ("Send", [
517− ("send", testSend send)
518− , ("Unsafe.send", testSend Unsafe.send)
519− , ("usend", testSend usend)
520− , ("Unsafe.usend", testSend Unsafe.usend)
521− , ("sendChan", testChan sendChan)
522− , ("Unsafe.sendChan", testChan Unsafe.sendChan)
523− ])
524− , ("Forward", [
525− ("forward", testSend (\p m -> forward (unsafeCreateUnencodedMessage m) p))
526− , ("uforward", testSend (\p m -> uforward (unsafeCreateUnencodedMessage m) p))
527− ])
528− ]
529−
530− build :: LocalNode
531− -> LocalNode
532− -> [(String, [(String, (Maybe LocalNode -> Process ()))])]
533− -> [Test]
534− build n ln specs =
535− [ testGroup (intercalate "-" [groupName, caseSuffix]) [
536− testCase (intercalate "-" [caseName, caseSuffix])
537− (runProcess n (caseImpl caseNode))
538− | (caseName, caseImpl) <- groupCases
539− ]
540− | (groupName, groupCases) <- specs
541− , (caseSuffix, caseNode) <- [("RemotePid", Just ln), ("LocalPid", Nothing)]
542− ]
src/Control/Distributed/Process/Internal/Primitives.hs+44−52
@@ -254,15 +254,17 @@ send them msg = do
254 node = processNode proc
254 node = processNode proc
255 nodeId = localNodeId node
255 nodeId = localNodeId node
256 destNode = (processNodeId them) in do
256 destNode = (processNodeId them) in do
257+ case destNode == nodeId of
258+ True -> sendLocal them msg
259+ False -> liftIO $ sendMessage (processNode proc)
260+ (ProcessIdentifier (processId proc))
261+ (ProcessIdentifier them)
262+ NoImplicitReconnect
263+ msg
264+ -- We do not fire the trace event until after the sending is complete;
265+ -- In the remote case, 'sendMessage' can block in the networking stack.
257 liftIO $ traceEvent (localEventBus node)
266 liftIO $ traceEvent (localEventBus node)
258 (MxSent them us (createUnencodedMessage msg))
267 (MxSent them us (createUnencodedMessage msg))
259− if destNode == nodeId
260− then sendLocal them msg
261− else liftIO $ sendMessage (processNode proc)
262− (ProcessIdentifier (processId proc))
263− (ProcessIdentifier them)
264− NoImplicitReconnect
265− msg
266
268
267-- | /Unsafe/ variant of 'send'. This function makes /no/ attempt to serialize
269-- | /Unsafe/ variant of 'send'. This function makes /no/ attempt to serialize
268-- and (in the case when the destination process resides on the same local
270-- and (in the case when the destination process resides on the same local
@@ -282,12 +284,9 @@ unsafeSend = Unsafe.send
282--
284--
283usend :: Serializable a => ProcessId -> a -> Process ()
285usend :: Serializable a => ProcessId -> a -> Process ()
284usend them msg = do
286usend them msg = do
285− proc <- ask
287+ here <- getSelfNode
286 let there = processNodeId them
288 let there = processNodeId them
287− let (us, node) = (processId proc, processNode proc)
289+ if here == there
288− let msg' = wrapMessage msg
289− liftIO $ traceEvent (localEventBus node) (MxSent them us msg')
290− if localNodeId (processNode proc) == there
291 then sendLocal them msg
290 then sendLocal them msg
292 else sendCtrlMsg (Just there) $ UnreliableSend (processLocalId them)
291 else sendCtrlMsg (Just there) $ UnreliableSend (processLocalId them)
293 (createMessage msg)
292 (createMessage msg)
@@ -307,12 +306,11 @@ expect = receiveWait [match return]
307-- Channels --
306-- Channels --
308--------------------------------------------------------------------------------
307--------------------------------------------------------------------------------
309
308
310−-- | Create a new typed channel, bound to the calling Process
309+-- | Create a new typed channel
311--
310--
312−-- Note that the channel is bound to the lifecycle of the process that evaluates
311+-- Note that the channel is bound to the lifecycle of the process that evaluated
313−-- this function, such that when it dies/exits, the channel will no longer
312+-- this function, such that if the calling process dies/exits, the channel will
314−-- function, but will remain accessible. Thus reading from the ReceivePort will
313+-- no longer be accessible, and reading from the ReceivePort will fail.
315−-- fail silently thereafter, blocking indefinitely (unless a timeout is used).
316--
314--
317newChan :: Serializable a => Process (SendPort a, ReceivePort a)
315newChan :: Serializable a => Process (SendPort a, ReceivePort a)
318newChan = do
316newChan = do
@@ -341,16 +339,13 @@ newChan = do
341sendChan :: Serializable a => SendPort a -> a -> Process ()
339sendChan :: Serializable a => SendPort a -> a -> Process ()
342sendChan (SendPort cid) msg = do
340sendChan (SendPort cid) msg = do
343 proc <- ask
341 proc <- ask
344− let node = processNode proc
345− pid = processId proc
346− us = localNodeId node
342+ let node = localNodeId (processNode proc)
347− them = processNodeId (sendPortProcessId cid) in do
343+ destNode = processNodeId (sendPortProcessId cid) in do
348− liftIO $ traceEvent (localEventBus node) (MxSentToPort pid cid $ wrapMessage msg)
349− case them == us of
344+ case destNode == node of
350 True -> sendChanLocal cid msg
345 True -> sendChanLocal cid msg
351 False -> do
346 False -> do
352− liftIO $ sendBinary node
347+ liftIO $ sendBinary (processNode proc)
353− (ProcessIdentifier pid)
348+ (ProcessIdentifier (processId proc))
354 (SendPortIdentifier cid)
349 (SendPortIdentifier cid)
355 NoImplicitReconnect
350 NoImplicitReconnect
356 msg
351 msg
@@ -494,14 +489,17 @@ forward msg them = do
494 us = processId proc
489 us = processId proc
495 nid = localNodeId node
490 nid = localNodeId node
496 destNode = (processNodeId them) in do
491 destNode = (processNodeId them) in do
497− liftIO $ traceEvent (localEventBus node) (MxSent them us msg)
498− if destNode == nid
492+ case destNode == nid of
499− then sendCtrlMsg Nothing (LocalSend them msg)
493+ True -> sendCtrlMsg Nothing (LocalSend them msg)
500− else liftIO $ sendPayload (processNode proc)
494+ False -> liftIO $ sendPayload (processNode proc)
501− (ProcessIdentifier (processId proc))
495+ (ProcessIdentifier (processId proc))
502− (ProcessIdentifier them)
496+ (ProcessIdentifier them)
503− NoImplicitReconnect
497+ NoImplicitReconnect
504− (messageToPayload msg)
498+ (messageToPayload msg)
499+ -- We do not fire the trace event until after the sending is complete;
500+ -- In the remote case, 'sendMessage' can block in the networking stack.
501+ liftIO $ traceEvent (localEventBus node)
502+ (MxSent them us msg)
505
503
506-- | Forward a raw 'Message' to the given 'ProcessId'.
504-- | Forward a raw 'Message' to the given 'ProcessId'.
507--
505--
@@ -515,10 +513,14 @@ uforward msg them = do
515 us = processId proc
513 us = processId proc
516 nid = localNodeId node
514 nid = localNodeId node
517 destNode = (processNodeId them) in do
515 destNode = (processNodeId them) in do
518− liftIO $ traceEvent (localEventBus node) (MxSent them us msg)
519− if destNode == nid
516+ case destNode == nid of
520− then sendCtrlMsg Nothing (LocalSend them msg)
517+ True -> sendCtrlMsg Nothing (LocalSend them msg)
521− else sendCtrlMsg (Just destNode) $ UnreliableSend (processLocalId them) msg
518+ False -> sendCtrlMsg (Just destNode) $ UnreliableSend (processLocalId them)
519+ msg
520+ -- We do not fire the trace event until after the sending is complete;
521+ -- In the remote case, 'sendCtrlMsg' can block in the networking stack.
522+ liftIO $ traceEvent (localEventBus node)
523+ (MxSent them us msg)
522
524
523-- | Wrap a 'Serializable' value in a 'Message'. Note that 'Message's are
525-- | Wrap a 'Serializable' value in a 'Message'. Note that 'Message's are
524-- 'Serializable' - like the datum they contain - but also note, deserialising
526-- 'Serializable' - like the datum they contain - but also note, deserialising
@@ -1227,12 +1229,8 @@ whereisRemoteAsync nid label = do
1227
1229
1228-- | Named send to a process in the local registry (asynchronous)
1230-- | Named send to a process in the local registry (asynchronous)
1229nsend :: Serializable a => String -> a -> Process ()
1231nsend :: Serializable a => String -> a -> Process ()
1230−nsend label msg = do
1232+nsend label msg =
1231− proc <- ask
1232− let msg' = createUnencodedMessage msg
1233− liftIO $ traceEvent (localEventBus (processNode proc))
1234− (MxSentToName label (processId proc) msg')
1235− sendCtrlMsg Nothing (NamedSend label msg')
1233+ sendCtrlMsg Nothing (NamedSend label (createUnencodedMessage msg))
1236
1234
1237-- | Named send to a process in the local registry (asynchronous).
1235-- | Named send to a process in the local registry (asynchronous).
1238-- This function makes /no/ attempt to serialize and (in the case when the
1236-- This function makes /no/ attempt to serialize and (in the case when the
@@ -1244,15 +1242,9 @@ unsafeNSend = Unsafe.nsend
1244-- | Named send to a process in a remote registry (asynchronous)
1242-- | Named send to a process in a remote registry (asynchronous)
1245nsendRemote :: Serializable a => NodeId -> String -> a -> Process ()
1243nsendRemote :: Serializable a => NodeId -> String -> a -> Process ()
1246nsendRemote nid label msg = do
1244nsendRemote nid label msg = do
1247− proc <- ask
1245+ here <- getSelfNode
1248− let us = processId proc
1249− let node = processNode proc
1250− if localNodeId node == nid
1251− then nsend label msg
1246+ if here == nid then nsend label msg
1252− else let lbl = label ++ "@" ++ show nid in do
1253− liftIO $ traceEvent (localEventBus node)
1254− (MxSentToName lbl us (wrapMessage msg))
1255− sendCtrlMsg (Just nid) (NamedSend label (createMessage msg))
1247+ else sendCtrlMsg (Just nid) (NamedSend label (createMessage msg))
1256
1248
1257-- | Named send to a process in a remote registry (asynchronous)
1249-- | Named send to a process in a remote registry (asynchronous)
1258-- This function makes /no/ attempt to serialize and (in the case when the
1250-- This function makes /no/ attempt to serialize and (in the case when the
src/Control/Distributed/Process/Management/Internal/Types.hs−7
@@ -21,7 +21,6 @@ import Control.Concurrent.STM
21import Control.Distributed.Process.Internal.Types
21import Control.Distributed.Process.Internal.Types
22 ( Process
22 ( Process
23 , ProcessId
23 , ProcessId
24− , SendPortId
25 , Message
24 , Message
26 , DiedReason
25 , DiedReason
27 , NodeId
26 , NodeId
@@ -58,14 +57,8 @@ data MxEvent =
58 -- ^ fired whenever a node /dies/ (i.e., the connection is broken/disconnected)
57 -- ^ fired whenever a node /dies/ (i.e., the connection is broken/disconnected)
59 | MxSent ProcessId ProcessId Message
58 | MxSent ProcessId ProcessId Message
60 -- ^ fired whenever a message is sent from a local process
59 -- ^ fired whenever a message is sent from a local process
61− | MxSentToName String ProcessId Message
62− -- ^ fired whenever a named send occurs
63− | MxSentToPort ProcessId SendPortId Message
64− -- ^ fired whenever a sendChan occurs
65 | MxReceived ProcessId Message
60 | MxReceived ProcessId Message
66 -- ^ fired whenever a message is received by a local process
61 -- ^ fired whenever a message is received by a local process
67− | MxReceivedPort SendPortId Message
68− -- ^ fired whenever a message is received via a typed channel
69 | MxConnected ConnectionId EndPointAddress
62 | MxConnected ConnectionId EndPointAddress
70 -- ^ fired when a network-transport connection is first established
63 -- ^ fired when a network-transport connection is first established
71 | MxDisconnected ConnectionId EndPointAddress
64 | MxDisconnected ConnectionId EndPointAddress
src/Control/Distributed/Process/Node.hs+10−15
@@ -492,7 +492,7 @@ type IncomingConnection = (NT.EndPointAddress, IncomingTarget)
492data IncomingTarget =
492data IncomingTarget =
493 Uninit
493 Uninit
494 | ToProc ProcessId (Weak (CQueue Message))
494 | ToProc ProcessId (Weak (CQueue Message))
495− | ToChan SendPortId TypedChannel
495+ | ToChan TypedChannel
496 | ToNode
496 | ToNode
497
497
498data ConnectionState = ConnectionState {
498data ConnectionState = ConnectionState {
@@ -547,17 +547,13 @@ handleIncomingMessages node = go initConnectionState
547 enqueue queue msg -- 'enqueue' is strict
547 enqueue queue msg -- 'enqueue' is strict
548 trace node (MxReceived pid msg)
548 trace node (MxReceived pid msg)
549 go st
549 go st
550− Just (_, ToChan chId (TypedChannel chan')) -> do
550+ Just (_, ToChan (TypedChannel chan')) -> do
551 mChan <- deRefWeak chan'
551 mChan <- deRefWeak chan'
552 -- 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
553 -- the channel and we simply ignore the incoming message
553 -- the channel and we simply ignore the incoming message
554− forM_ mChan $ \chan -> do
554+ forM_ mChan $ \chan -> atomically $
555− msg' <- atomically $ do
556− msg <- return $! decode (BSL.fromChunks payload)
557− -- We make sure the message is fully decoded when it is enqueued
555+ -- We make sure the message is fully decoded when it is enqueued
558− writeTQueue chan msg
556+ writeTQueue chan $! decode (BSL.fromChunks payload)
559− return msg
560− trace node $ MxReceivedPort chId $ unsafeCreateUnencodedMessage msg'
561 go st
557 go st
562 Just (_, ToNode) -> do
558 Just (_, ToNode) -> do
563 let ctrlMsg = decode . BSL.fromChunks $ payload
559 let ctrlMsg = decode . BSL.fromChunks $ payload
@@ -584,7 +580,7 @@ handleIncomingMessages node = go initConnectionState
584 mChannel <- withMVar (processState proc) $ return . (^. typedChannelWithId lcid)
580 mChannel <- withMVar (processState proc) $ return . (^. typedChannelWithId lcid)
585 case mChannel of
581 case mChannel of
586 Just channel ->
582 Just channel ->
587− go (incomingAt cid ^= Just (src, ToChan chId channel) $ st)
583+ go (incomingAt cid ^= Just (src, ToChan channel) $ st)
588 Nothing ->
584 Nothing ->
589 invalidRequest cid st $
585 invalidRequest cid st $
590 "incoming attempt to connect to unknown channel of"
586 "incoming attempt to connect to unknown channel of"
@@ -1054,12 +1050,11 @@ ncEffectLocalPortSend from msg = do
1054 -- If ch is Nothing, the process has given up the read end of
1050 -- If ch is Nothing, the process has given up the read end of
1055 -- the channel and we simply ignore the incoming message - this
1051 -- the channel and we simply ignore the incoming message - this
1056 ch <- deRefWeak chan'
1052 ch <- deRefWeak chan'
1057− forM_ ch $ \chan -> deliverChan node from msg chan
1053+ forM_ ch $ \chan -> deliverChan msg chan
1058− where deliverChan :: forall a . LocalNode -> SendPortId -> Message -> TQueue a -> IO ()
1054+ where deliverChan :: forall a . Message -> TQueue a -> IO ()
1059− deliverChan n p (UnencodedMessage _ raw) chan' = do
1055+ deliverChan (UnencodedMessage _ raw) chan' =
1060 atomically $ writeTQueue chan' ((unsafeCoerce raw) :: a)
1056 atomically $ writeTQueue chan' ((unsafeCoerce raw) :: a)
1061− trace n (MxReceivedPort p $ unsafeCreateUnencodedMessage raw)
1062− deliverChan _ _ (EncodedMessage _ _) _ =
1057+ deliverChan (EncodedMessage _ _) _ =
1063 -- this will not happen unless someone screws with Primitives.hs
1058 -- this will not happen unless someone screws with Primitives.hs
1064 error "invalid local channel delivery"
1059 error "invalid local channel delivery"
1065
1060
src/Control/Distributed/Process/UnsafePrimitives.hs+33−82
@@ -32,24 +32,7 @@
32-- the /normal/ strategy).
32-- the /normal/ strategy).
33--
33--
34-- Use of the functions in this module can potentially change the runtime
34-- Use of the functions in this module can potentially change the runtime
35−-- behaviour of your application. In addition, messages passed between Cloud
36−-- Haskell processes are written to a tracing infrastructure on the local node,
37−-- to provide improved introspection and debugging facilities for complex actor
38−-- based systems. This module makes no attempt to force evaluation in these
39−-- cases either, thus evaluation problems in passed data structures could not
40−-- only crash your processes, but could also bring down critical internal
41−-- services on which the node relies to function correctly.
42−--
43−-- If you wish to repudiate such issues, you are advised to consider the use
44−-- of NFSerialisable in the distributed-process-extras package, which type
45−-- class brings NFData into scope along with Serializable, such that we can
46−-- force evaluation. Intended for use with modules such as this one, this
47−-- approach guarantees correct evaluatedness in terms of @NFData@. Please note
48−-- however, that we /cannot/ guarantee that an @NFData@ instance will behave the
49−-- same way as a @Binary@ one with regards evaluation, so it is still possible
50−-- to introduce unexpected behaviour by using /unsafe/ primitives in this way.
51−--
52−-- You have been warned!
35+-- behaviour of your application. You have been warned!
53--
36--
54-- This module is exported so that you can replace the use of Cloud Haskell's
37-- This module is exported so that you can replace the use of Cloud Haskell's
55-- /safe/ messaging primitives. If you want to use both variants, then you can
38-- /safe/ messaging primitives. If you want to use both variants, then you can
@@ -72,12 +55,7 @@ import Control.Distributed.Process.Internal.Messaging
72 , sendBinary
55 , sendBinary
73 , sendCtrlMsg
56 , sendCtrlMsg
74 )
57 )
75−import Control.Distributed.Process.Management.Internal.Types
58+
76− ( MxEvent(..)
77− )
78−import Control.Distributed.Process.Management.Internal.Trace.Types
79− ( traceEvent
80− )
81import Control.Distributed.Process.Internal.Types
59import Control.Distributed.Process.Internal.Types
82 ( ProcessId(..)
60 ( ProcessId(..)
83 , NodeId(..)
61 , NodeId(..)
@@ -101,48 +79,34 @@ import Control.Monad.Reader (ask)
101
79
102-- | Named send to a process in the local registry (asynchronous)
80-- | Named send to a process in the local registry (asynchronous)
103nsend :: Serializable a => String -> a -> Process ()
81nsend :: Serializable a => String -> a -> Process ()
104−nsend label msg = do
82+nsend label msg =
105− proc <- ask
106− let us = processId proc
107− let msg' = wrapMessage msg
108− -- see [note: tracing]
109− liftIO $ traceEvent (localEventBus (processNode proc))
110− (MxSentToName label us msg')
111− sendCtrlMsg Nothing (NamedSend label msg')
83+ sendCtrlMsg Nothing (NamedSend label (unsafeCreateUnencodedMessage msg))
112
84
113-- | Named send to a process in a remote registry (asynchronous)
85-- | Named send to a process in a remote registry (asynchronous)
114nsendRemote :: Serializable a => NodeId -> String -> a -> Process ()
86nsendRemote :: Serializable a => NodeId -> String -> a -> Process ()
115nsendRemote nid label msg = do
87nsendRemote nid label msg = do
116 proc <- ask
88 proc <- ask
117− let us = processId proc
118− let node = processNode proc
119− if localNodeId node == nid
89+ if localNodeId (processNode proc) == nid
120 then nsend label msg
90 then nsend label msg
121− else
122− let lbl = label ++ "@" ++ show nid in do
123− -- see [note: tracing] NB: this is a remote call to another NC...
124− liftIO $ traceEvent (localEventBus node)
125− (MxSentToName lbl us (wrapMessage msg))
126− sendCtrlMsg (Just nid) (NamedSend label (createMessage msg))
91+ else sendCtrlMsg (Just nid) (NamedSend label (createMessage msg))
127
92
128-- | Send a message
93-- | Send a message
129send :: Serializable a => ProcessId -> a -> Process ()
94send :: Serializable a => ProcessId -> a -> Process ()
130send them msg = do
95send them msg = do
131 proc <- ask
96 proc <- ask
132 let node = localNodeId (processNode proc)
97 let node = localNodeId (processNode proc)
133− destNode = (processNodeId them)
98+ destNode = (processNodeId them) in do
134− us = (processId proc)
135− msg' = wrapMessage msg in do
136− -- see [note: tracing]
137− liftIO $ traceEvent (localEventBus (processNode proc))
138− (MxSent them us msg')
139− if destNode == node
99+ case destNode == node of
100+ True -> unsafeSendLocal them msg
101+ False -> liftIO $ sendMessage (processNode proc)
102+ (ProcessIdentifier (processId proc))
103+ (ProcessIdentifier them)
104+ NoImplicitReconnect
105+ msg
106+ where
107+ unsafeSendLocal :: (Serializable a) => ProcessId -> a -> Process ()
108+ unsafeSendLocal pid msg' =
140− then sendCtrlMsg Nothing $ LocalSend them msg'
109+ sendCtrlMsg Nothing $ LocalSend pid (unsafeCreateUnencodedMessage msg')
141− else liftIO $ sendMessage (processNode proc)
142− (ProcessIdentifier (processId proc))
143− (ProcessIdentifier them)
144− NoImplicitReconnect
145− msg
146
110
147-- | Send a message unreliably.
111-- | Send a message unreliably.
148--
112--
@@ -157,43 +121,30 @@ usend :: Serializable a => ProcessId -> a -> Process ()
157usend them msg = do
121usend them msg = do
158 proc <- ask
122 proc <- ask
159 let there = processNodeId them
123 let there = processNodeId them
160− let (us, node) = (processId proc, processNode proc)
161− let msg' = wrapMessage msg
162− -- see [note: tracing]
163− liftIO $ traceEvent (localEventBus node) (MxSent them us msg')
164 if localNodeId (processNode proc) == there
124 if localNodeId (processNode proc) == there
165− then sendCtrlMsg Nothing $ LocalSend them msg'
125+ then sendCtrlMsg Nothing $
126+ LocalSend them (unsafeCreateUnencodedMessage msg)
166 else sendCtrlMsg (Just there) $ UnreliableSend (processLocalId them)
127 else sendCtrlMsg (Just there) $ UnreliableSend (processLocalId them)
167 (createMessage msg)
128 (createMessage msg)
168
129
169−-- [note: tracing]
170−-- Note that tracing writes to the local node's control channel, and this
171−-- module explicitly specifies to its clients that it does unsafe message
172−-- encoding. The same is true for the messages it puts onto the Management
173−-- event bus, however we do *not* want unevaluated thunks hitting the event
174−-- bus control thread. Hence the word /Unsafe/ in this module's name!
175−--
176−
177-- | Send a message on a typed channel
130-- | Send a message on a typed channel
178sendChan :: Serializable a => SendPort a -> a -> Process ()
131sendChan :: Serializable a => SendPort a -> a -> Process ()
179sendChan (SendPort cid) msg = do
132sendChan (SendPort cid) msg = do
180 proc <- ask
133 proc <- ask
181− let node = processNode proc
182− pid = processId proc
183− us = localNodeId node
134+ let node = localNodeId (processNode proc)
184− them = processNodeId (sendPortProcessId cid)
135+ destNode = processNodeId (sendPortProcessId cid) in do
185− msg' = wrapMessage msg in do
136+ case destNode == node of
186− liftIO $ traceEvent (localEventBus node) (MxSentToPort pid cid msg')
187− if them == us
188− then unsafeSendChanLocal cid msg' -- NB: we wrap to P.Message !!!
137+ True -> unsafeSendChanLocal cid msg
138+ False -> do
189− else liftIO $ sendBinary node
139+ liftIO $ sendBinary (processNode proc)
190− (ProcessIdentifier pid)
140+ (ProcessIdentifier (processId proc))
191− (SendPortIdentifier cid)
141+ (SendPortIdentifier cid)
192− NoImplicitReconnect
142+ NoImplicitReconnect
193− msg
143+ msg
194 where
144 where
195− unsafeSendChanLocal :: SendPortId -> Message -> Process ()
145+ unsafeSendChanLocal :: (Serializable a) => SendPortId -> a -> Process ()
146+ unsafeSendChanLocal spId msg' =
196− unsafeSendChanLocal p m = sendCtrlMsg Nothing $ LocalPortSend p m
147+ sendCtrlMsg Nothing $ LocalPortSend spId (unsafeCreateUnencodedMessage msg')
197
148
198-- | Create an unencoded @Message@ for any @Serializable@ type.
149-- | Create an unencoded @Message@ for any @Serializable@ type.
199wrapMessage :: Serializable a => a -> Message
150wrapMessage :: Serializable a => a -> Message